944bcb7380
Update webhook events now carry a top-level "updatedFrom" field alongside "data", containing a full snapshot of the entity as it was before the update. This lets subscribers diff old vs new state (for example the prior membership role on user:updated) without tracking prior state themselves. It is a complete snapshot with the same shape as "data", not a partial diff, so consumers select whatever fields they need. The field is omitted for non-update events. The webhook_data table gains a nullable updated_from JSONB column, and webhook.InsertUpdateData enqueues both snapshots; InsertData delegates to it with a nil updatedFrom so non-update callers are unaffected. Each *:updated emission site snapshots the entity right after load, before mutation: obligation, third-party, user (org and SCIM flows), document, document-version, and document-version-approval-quorum. The document emit helpers gained an optional updatedFrom argument threaded through to the payload. For document-version-approval-quorum:updated the snapshot requires an extra query, so it is now gated behind the same subscription-existence check the emitter uses: when no subscriber is configured the load is skipped entirely rather than running (and potentially failing the approval) for an event nobody receives. Add integration tests (against a real Postgres, skipped when none is reachable) covering the updated_from round-trip, the SQL NULL behavior when no snapshot is provided, and the no-op when no subscription matches, plus a unit test asserting updatedFrom is omitted from the payload when absent. Document the new field in the probod and n8n changelogs and the n8n README. Signed-off-by: Sacha Al Himdani <sacha@probo.com>
107 lines
3.1 KiB
Go
107 lines
3.1 KiB
Go
// Copyright (c) 2026 Probo Inc <hello@probo.com>.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
// SOFTWARE.
|
|
|
|
package webhook
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"time"
|
|
|
|
"go.gearno.de/kit/pg"
|
|
"go.probo.inc/probo/pkg/coredata"
|
|
"go.probo.inc/probo/pkg/gid"
|
|
)
|
|
|
|
type Payload struct {
|
|
EventID string `json:"eventId"`
|
|
SubscriptionID string `json:"subscriptionId"`
|
|
OrganizationID string `json:"organizationId"`
|
|
EventType string `json:"eventType"`
|
|
CreatedAt time.Time `json:"createdAt"`
|
|
Data json.RawMessage `json:"data"`
|
|
UpdatedFrom json.RawMessage `json:"updatedFrom,omitempty"`
|
|
}
|
|
|
|
func InsertData(
|
|
ctx context.Context,
|
|
tx pg.Tx,
|
|
scope coredata.Scoper,
|
|
organizationID gid.GID,
|
|
eventType coredata.WebhookEventType,
|
|
data any,
|
|
) error {
|
|
if err := InsertUpdateData(ctx, tx, scope, organizationID, eventType, data, nil); err != nil {
|
|
return fmt.Errorf("cannot insert webhook data: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func InsertUpdateData(
|
|
ctx context.Context,
|
|
tx pg.Tx,
|
|
scope coredata.Scoper,
|
|
organizationID gid.GID,
|
|
eventType coredata.WebhookEventType,
|
|
data any,
|
|
updatedFrom any,
|
|
) error {
|
|
var configs coredata.WebhookSubscriptions
|
|
|
|
exists, err := configs.ExistsByOrganizationIDAndEventType(ctx, tx, scope, organizationID, eventType)
|
|
if err != nil {
|
|
return fmt.Errorf("cannot check webhook subscriptions: %w", err)
|
|
}
|
|
|
|
if !exists {
|
|
return nil
|
|
}
|
|
|
|
raw, err := json.Marshal(data)
|
|
if err != nil {
|
|
return fmt.Errorf("cannot marshal webhook event data: %w", err)
|
|
}
|
|
|
|
var updatedFromRaw json.RawMessage
|
|
if updatedFrom != nil {
|
|
updatedFromRaw, err = json.Marshal(updatedFrom)
|
|
if err != nil {
|
|
return fmt.Errorf("cannot marshal webhook event updated-from data: %w", err)
|
|
}
|
|
}
|
|
|
|
webhookData := &coredata.WebhookData{
|
|
ID: gid.New(scope.GetTenantID(), coredata.WebhookDataEntityType),
|
|
OrganizationID: organizationID,
|
|
EventType: eventType,
|
|
Data: raw,
|
|
UpdatedFrom: updatedFromRaw,
|
|
CreatedAt: time.Now(),
|
|
}
|
|
|
|
if err = webhookData.Insert(ctx, tx, scope); err != nil {
|
|
return fmt.Errorf("cannot insert webhook data: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|