@contember/engine-actions 1.4.0-rc.2 → 1.4.0-rc.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contember/engine-actions",
-  "version": "1.4.0-rc.2",
+  "version": "1.4.0-rc.3",
   "license": "proprietary",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.ts",
@@ -13,25 +13,25 @@
     "test": "vitest --no-threads"
   },
   "dependencies": {
-    "@contember/authorization": "1.4.0-rc.2",
-    "@contember/database": "1.4.0-rc.2",
-    "@contember/database-migrations": "1.4.0-rc.2",
-    "@contember/engine-common": "1.4.0-rc.2",
-    "@contember/engine-content-api": "1.4.0-rc.2",
-    "@contember/engine-http": "1.4.0-rc.2",
-    "@contember/engine-plugins": "1.4.0-rc.2",
-    "@contember/engine-system-api": "1.4.0-rc.2",
-    "@contember/engine-tenant-api": "1.4.0-rc.2",
-    "@contember/graphql-utils": "1.4.0-rc.2",
-    "@contember/logger": "1.4.0-rc.2",
-    "@contember/schema": "1.4.0-rc.2",
-    "@contember/schema-utils": "1.4.0-rc.2",
-    "@contember/typesafe": "1.4.0-rc.2",
+    "@contember/authorization": "1.4.0-rc.3",
+    "@contember/database": "1.4.0-rc.3",
+    "@contember/database-migrations": "1.4.0-rc.3",
+    "@contember/engine-common": "1.4.0-rc.3",
+    "@contember/engine-content-api": "1.4.0-rc.3",
+    "@contember/engine-http": "1.4.0-rc.3",
+    "@contember/engine-plugins": "1.4.0-rc.3",
+    "@contember/engine-system-api": "1.4.0-rc.3",
+    "@contember/engine-tenant-api": "1.4.0-rc.3",
+    "@contember/graphql-utils": "1.4.0-rc.3",
+    "@contember/logger": "1.4.0-rc.3",
+    "@contember/schema": "1.4.0-rc.3",
+    "@contember/schema-utils": "1.4.0-rc.3",
+    "@contember/typesafe": "1.4.0-rc.3",
     "@graphql-tools/schema": "^10.0.0",
     "graphql-tag": "^2.12.6"
   },
   "devDependencies": {
-    "@contember/engine-api-tester": "1.4.0-rc.2",
+    "@contember/engine-api-tester": "1.4.0-rc.3",
     "@graphql-codegen/cli": "^5.0.0",
     "@graphql-codegen/typescript": "^4.0.1",
     "@graphql-codegen/typescript-operations": "^4.0.1",

package/src/dispatch/WebhookTargetHandler.ts

@@ -1,5 +1,5 @@
-import { Actions } from '@contember/schema'
-import { EventRow, HandledEvent, InvokeHandler, InvokeHandlerArgs, WebhookEvent, WebhookRequestPayload } from './types'
+import { Actions, ActionsPayload } from '@contember/schema'
+import { EventRow, HandledEvent, InvokeHandler, InvokeHandlerArgs  } from './types'
 import { VariablesMap } from '../model/VariablesManager'
 import * as Typesafe from '@contember/typesafe'
 import { FetcherResponse, WebhookFetcher } from './WebhookFetcher'
@@ -145,10 +145,6 @@ export class WebhookTargetHandler implements InvokeHandler<Actions.WebhookTarget
 		const resolvedHeaders = Object.fromEntries(Object.entries(target.headers ?? {})
 			.map(([key, value]) => [key, this.resolveVariables(value, variables)]))
 
-		const payload: WebhookRequestPayload = {
-			events: events.map(this.formatEventPayload),
-		}
-
 		return await this.fetcher.fetch(resolvedUrl, {
 			method: 'POST',
 			headers: {
@@ -157,11 +153,23 @@ export class WebhookTargetHandler implements InvokeHandler<Actions.WebhookTarget
 				['Content-type']: 'application/json',
 			},
 			signal: abortController.signal,
-			body: JSON.stringify(payload),
+			body: this.formatBody(events, target),
 		})
 	}
 
-	private formatEventPayload(it: EventRow): WebhookEvent {
+	private formatBody(events: EventRow[], target: Actions.WebhookTarget): string {
+		const body = target.body ?? {}
+		const path = target.payloadPath ?? []
+		let current: any = body
+		for (let i = 0; i < path.length; i++) {
+			current[path[i]] ??= {}
+			current = current[path[i]]
+		}
+		current['events'] = events.map(this.formatEventPayload)
+		return JSON.stringify(body)
+	}
+
+	private formatEventPayload(it: EventRow): ActionsPayload.WebhookEvent {
 		return {
 			meta: {
 				eventId: it.id,

package/src/dispatch/types.ts

@@ -2,7 +2,6 @@ import { Logger } from '@contember/logger'
 import { Actions } from '@contember/schema'
 import { EventRow } from '../model/types'
 import { VariablesMap } from '../model/VariablesManager'
-import { AnyEventPayload } from '../triggers/Payload'
 
 export { EventRow }
 
@@ -31,28 +30,3 @@ export type InvocationResult = {
 	response?: string
 }
 
-
-export type WebhookEvent =
-	& AnyEventPayload
-	& {
-		meta: {
-			eventId: string
-			transactionId: string
-			createdAt: string
-			lastStateChange: string
-			numRetries: number
-			trigger: string
-			target: string
-		}
-	}
-
-export type WebhookRequestPayload = {
-	events: WebhookEvent[]
-}
-
-export type WebhookResponsePayload = {
-	failures: {
-		eventId: string
-		error?: string
-	}
-}

package/src/model/types.ts

@@ -1,4 +1,4 @@
-import { AnyEventPayload } from '../triggers/Payload'
+import { ActionsPayload } from '@contember/schema'
 
 export type EventRow = {
 	id: string
@@ -14,6 +14,6 @@ export type EventRow = {
 	target: string
 	priority: number
 	trigger: string
-	payload: AnyEventPayload
+	payload: ActionsPayload.AnyEventPayload
 	log: any[]
 }

package/src/triggers/TriggerPayloadBuilder.ts

@@ -1,8 +1,7 @@
-import { AnyEventPayload, BaseEventPayload, WatchEventPayload } from './Payload'
 import { ImplementationException } from '../ImplementationException'
 import { assertNever } from '../utils/assertNever'
 import { FiredEvent } from './TriggerPayloadManager'
-import { Actions, Input } from '@contember/schema'
+import { Actions, ActionsPayload, Input } from '@contember/schema'
 import { FieldNode, Mapper, ObjectNode } from '@contember/engine-content-api'
 
 type Selections = Record<Input.PrimaryValue, any>
@@ -13,7 +12,7 @@ export class TriggerPayloadBuilder {
 	) {
 	}
 
-	public async build(events: FiredEvent[]): Promise<AnyEventPayload[]> {
+	public async build(events: FiredEvent[]): Promise<ActionsPayload.AnyEventPayload[]> {
 		const filteredEvents = events.filter(it => {
 			return it.cause.type !== 'BeforeUpdateEvent'
 				|| it.cause.afterEvent?.hasChanges === true
@@ -44,13 +43,13 @@ export class TriggerPayloadBuilder {
 		return event
 	}
 
-	private buildWatchEventPayloads(events: FiredEvent[], selections: Selections): WatchEventPayload[] {
+	private buildWatchEventPayloads(events: FiredEvent[], selections: Selections): ActionsPayload.WatchEventPayload[] {
 		const byPrimary: Record<Input.PrimaryValue, { primary: Input.PrimaryValue; events: FiredEvent[] }> = {}
 		for (const event of events) {
 			byPrimary[event.primary] ??= { primary: event.primary, events: [] }
 			byPrimary[event.primary].events.push(event)
 		}
-		const payloads: WatchEventPayload[] = []
+		const payloads: ActionsPayload.WatchEventPayload[] = []
 		for (const eventsByPrimary of Object.values(byPrimary)) {
 			payloads.push({
 				operation: 'watch',
@@ -64,7 +63,7 @@ export class TriggerPayloadBuilder {
 		return payloads
 	}
 
-	private buildBaseEventPayloads(event: FiredEvent, selection?: any): BaseEventPayload {
+	private buildBaseEventPayloads(event: FiredEvent, selection?: any): ActionsPayload.BaseEventPayload {
 		switch (event.cause.type) {
 			case 'AfterInsertEvent':
 				return {

package/src/triggers/TriggerPayloadManager.ts

@@ -1,5 +1,4 @@
 import { Actions, Input, Model } from '@contember/schema'
-import { AnyEventPayload } from './Payload'
 import { AnyListener } from './TriggerListenersStore'
 import { EventCause } from './TriggerHandler'
 import { TriggerPayloadBuilder } from './TriggerPayloadBuilder'
@@ -14,12 +13,6 @@ export interface FiredEvent {
 	selection?: any
 }
 
-export type GroupedPayloads = {
-	trigger: Actions.AnyTrigger
-	entity: Model.Entity
-	payloads: AnyEventPayload[]
-}
-
 export class TriggerPayloadManager {
 	private eventsByTrigger: Record<string, FiredEvent[]> = {}
 

package/src/triggers/TriggerPayloadPersister.ts

@@ -1,7 +1,6 @@
 import { Client, InsertBuilder } from '@contember/database'
-import { AnyEventPayload } from './Payload'
 import { Mapper } from '@contember/engine-content-api'
-import { Actions } from '@contember/schema'
+import { Actions, ActionsPayload } from '@contember/schema'
 import { EventRow } from '../model/types'
 
 export const NOTIFY_CHANNEL_NAME = 'actions_event'
@@ -22,7 +21,7 @@ export class TriggerPayloadPersister {
 	) {
 	}
 
-	public async persist(trigger: Actions.AnyTrigger, payloads: AnyEventPayload[]): Promise<void> {
+	public async persist(trigger: Actions.AnyTrigger, payloads: ActionsPayload.AnyEventPayload[]): Promise<void> {
 		const chunkSize = 100
 		for (let i = 0; i < payloads.length; i += chunkSize) {
 			const chunk = payloads.slice(i, i + chunkSize)

package/tests/cases/unit/webhookHandler.test.ts

@@ -1,15 +1,14 @@
 import { assert, describe, expect, test } from 'vitest'
 import { WebhookTargetHandler } from '../../../src/dispatch/WebhookTargetHandler'
 import { FetcherResponse } from '../../../src/dispatch/WebhookFetcher'
-import { createLogger, TestLoggerHandler } from '@contember/logger'
+import { createLogger, Logger, TestLoggerHandler } from '@contember/logger'
 import { testUuid } from '@contember/engine-api-tester'
-import { AnyEventPayload } from '../../../src/triggers/Payload'
 import { EventRow } from '../../../src/model/types'
-import { Actions } from '@contember/schema'
+import { Actions, ActionsPayload } from '@contember/schema'
 import { HandledEvent } from '../../../src/dispatch/types'
 
 
-const now = new Date()
+const now = new Date('2024-06-20T12:00:00Z')
 const createTestEvent = (i = 0, row: Partial<EventRow> = {}): EventRow => ({
 	created_at: now,
 	id: testUuid(i * 10 + 1),
@@ -22,7 +21,7 @@ const createTestEvent = (i = 0, row: Partial<EventRow> = {}): EventRow => ({
 	transaction_id: testUuid(i * 10 + 2),
 	stage_id: testUuid(i * 10 + 3),
 	visible_at: now,
-	payload: { foo: 'bar' } as unknown as AnyEventPayload,
+	payload: { foo: 'bar' } as unknown as ActionsPayload.AnyEventPayload,
 	priority: 1,
 	schema_id: 1,
 	state: 'created',
@@ -33,7 +32,115 @@ const dropDuration = (events: HandledEvent[]): HandledEvent[] => {
 	return events.map(it => ({ ...it, result: { ...it.result, durationMs: -1 } }))
 }
 
-describe('webhook handler', () => {
+const okResponse = Promise.resolve({
+	ok: true,
+	headers: new Headers(),
+	responseText: '',
+	status: 200,
+	statusText: 'OK',
+})
+
+describe('webhook request', () => {
+	test('default request', async () => {
+		let fetchCalled = false
+		const webhookHandler = new WebhookTargetHandler({
+			fetch(url: string, init: RequestInit): Promise<FetcherResponse> {
+				fetchCalled = true
+				assert.equal(url, 'http://localhost')
+				assert.equal(init.body, JSON.stringify({
+					events: [{
+						meta: {
+							eventId: testUuid(1),
+							transactionId: testUuid(2),
+							createdAt: now.toISOString(),
+							lastStateChange: now.toISOString(),
+							numRetries: 0,
+							trigger: 'test',
+							target: 'test_target',
+						},
+						foo: 'bar',
+					}],
+				}))
+
+				return okResponse
+			},
+		})
+
+		const target: Actions.AnyTarget = {
+			name: 'test_target',
+			type: 'webhook',
+			url: 'http://localhost',
+		}
+
+		const event1 = createTestEvent(0)
+		await webhookHandler.handle({
+			logger: {
+				warn: (e: any) => {
+					throw e
+				},
+			} as unknown as Logger,
+			target: target,
+			events: [event1],
+			variables: {},
+		})
+		assert.equal(fetchCalled, true)
+	})
+
+	test('custom body', async () => {
+		let fetchCalled = false
+		const webhookHandler = new WebhookTargetHandler({
+			fetch(url: string, init: RequestInit): Promise<FetcherResponse> {
+				fetchCalled = true
+				assert.equal(url, 'http://localhost')
+				assert.equal(init.body, JSON.stringify({
+					options: 'value',
+					payload: {
+						json: {
+							events: [{
+								meta: {
+									eventId: testUuid(1),
+									transactionId: testUuid(2),
+									createdAt: now.toISOString(),
+									lastStateChange: now.toISOString(),
+									numRetries: 0,
+									trigger: 'test',
+									target: 'test_target',
+								},
+								foo: 'bar',
+							}],
+						},
+					},
+				}))
+
+				return okResponse
+			},
+		})
+
+		const target: Actions.AnyTarget = {
+			name: 'test_target',
+			type: 'webhook',
+			url: 'http://localhost',
+			body: {
+				options: 'value',
+			},
+			payloadPath: ['payload', 'json'],
+		}
+
+		const event1 = createTestEvent(0)
+		await webhookHandler.handle({
+			logger: {
+				warn: (e: any) => {
+					throw e
+				},
+			} as unknown as Logger,
+			target: target,
+			events: [event1],
+			variables: {},
+		})
+		assert.equal(fetchCalled, true)
+	})
+})
+describe('webhook response', () => {
 	test('successful response', async () => {
 		const testLoggerHandler = new TestLoggerHandler()
 		const logger = createLogger(testLoggerHandler)
@@ -44,13 +151,7 @@ describe('webhook handler', () => {
 				fetchCalled = true
 				assert.equal(url, 'http://localhost')
 
-				return Promise.resolve({
-					ok: true,
-					headers: new Headers(),
-					responseText: '',
-					status: 200,
-					statusText: 'OK',
-				})
+				return okResponse
 			},
 		})
 

package/dist/src/triggers/Payload.d.ts

@@ -1,57 +0,0 @@
-import { Input, JSONObject } from '@contember/schema';
-export type UpdateEvent = {
-    operation: 'update';
-    entity: string;
-    id: Input.PrimaryValue;
-    values: JSONObject;
-    old?: JSONObject;
-    selection?: any;
-    path?: string[];
-};
-export type CreateEvent = {
-    operation: 'create';
-    entity: string;
-    id: Input.PrimaryValue;
-    values: JSONObject;
-    selection?: any;
-    path?: string[];
-};
-export type DeleteEvent = {
-    operation: 'delete';
-    entity: string;
-    id: Input.PrimaryValue;
-    selection?: any;
-    path?: string[];
-};
-export type JunctionConnectEvent = {
-    operation: 'junction_connect';
-    entity: string;
-    id: Input.PrimaryValue;
-    relation: string;
-    inverseId: Input.PrimaryValue;
-    selection?: any;
-    path?: string[];
-};
-export type JunctionDisconnectEvent = {
-    operation: 'junction_disconnect';
-    entity: string;
-    id: Input.PrimaryValue;
-    relation: string;
-    inverseId: Input.PrimaryValue;
-    selection?: any;
-    path?: string[];
-};
-export type WatchEventPayload = {
-    operation: 'watch';
-    trigger: string;
-    entity: string;
-    id: Input.PrimaryValue;
-    events: BaseEventPayload[];
-    selection?: any;
-};
-export type BaseEventPayload = CreateEvent | UpdateEvent | DeleteEvent | JunctionConnectEvent | JunctionDisconnectEvent;
-export type BasicEventPayload = BaseEventPayload & {
-    trigger: string;
-};
-export type AnyEventPayload = BasicEventPayload | WatchEventPayload;
-//# sourceMappingURL=Payload.d.ts.map

package/dist/src/triggers/Payload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/triggers/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,UAAU,EAAa,MAAM,mBAAmB,CAAA;AAEhE,MAAM,MAAM,WAAW,GAAG;IACzB,SAAS,EAAE,QAAQ,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,KAAK,CAAC,YAAY,CAAA;IACtB,MAAM,EAAE,UAAU,CAAA;IAClB,GAAG,CAAC,EAAE,UAAU,CAAA;IAChB,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACzB,SAAS,EAAE,QAAQ,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,KAAK,CAAC,YAAY,CAAA;IACtB,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACzB,SAAS,EAAE,QAAQ,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,KAAK,CAAC,YAAY,CAAA;IACtB,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IAClC,SAAS,EAAE,kBAAkB,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,KAAK,CAAC,YAAY,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,KAAK,CAAC,YAAY,CAAA;IAC7B,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,qBAAqB,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,KAAK,CAAC,YAAY,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,KAAK,CAAC,YAAY,CAAA;IAC7B,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC/B,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,KAAK,CAAC,YAAY,CAAA;IACtB,MAAM,EAAE,gBAAgB,EAAE,CAAA;IAC1B,SAAS,CAAC,EAAE,GAAG,CAAA;CACf,CAAA;AAED,MAAM,MAAM,gBAAgB,GACzB,WAAW,GACX,WAAW,GACX,WAAW,GACX,oBAAoB,GACpB,uBAAuB,CAAA;AAE1B,MAAM,MAAM,iBAAiB,GAC1B,gBAAgB,GAChB;IACD,OAAO,EAAE,MAAM,CAAA;CACf,CAAA;AAEF,MAAM,MAAM,eAAe,GACxB,iBAAiB,GACjB,iBAAiB,CAAA"}

package/dist/src/triggers/Payload.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Payload.js.map

package/dist/src/triggers/Payload.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Payload.js","sourceRoot":"","sources":["../../../src/triggers/Payload.ts"],"names":[],"mappings":""}

package/src/triggers/Payload.ts

@@ -1,74 +0,0 @@
-import { Input, JSONObject, JSONValue } from '@contember/schema'
-
-export type UpdateEvent = {
-	operation: 'update'
-	entity: string
-	id: Input.PrimaryValue
-	values: JSONObject
-	old?: JSONObject
-	selection?: any
-	path?: string[]
-}
-
-export type CreateEvent = {
-	operation: 'create'
-	entity: string
-	id: Input.PrimaryValue
-	values: JSONObject
-	selection?: any
-	path?: string[]
-}
-
-export type DeleteEvent = {
-	operation: 'delete'
-	entity: string
-	id: Input.PrimaryValue
-	selection?: any
-	path?: string[]
-}
-
-export type JunctionConnectEvent = {
-	operation: 'junction_connect'
-	entity: string
-	id: Input.PrimaryValue
-	relation: string
-	inverseId: Input.PrimaryValue
-	selection?: any
-	path?: string[]
-}
-
-export type JunctionDisconnectEvent = {
-	operation: 'junction_disconnect'
-	entity: string
-	id: Input.PrimaryValue
-	relation: string
-	inverseId: Input.PrimaryValue
-	selection?: any
-	path?: string[]
-}
-
-export type WatchEventPayload = {
-	operation: 'watch'
-	trigger: string
-	entity: string
-	id: Input.PrimaryValue
-	events: BaseEventPayload[]
-	selection?: any
-}
-
-export type BaseEventPayload =
-	| CreateEvent
-	| UpdateEvent
-	| DeleteEvent
-	| JunctionConnectEvent
-	| JunctionDisconnectEvent
-
-export type BasicEventPayload =
-	& BaseEventPayload
-	& {
-		trigger: string
-	}
-
-export type AnyEventPayload =
-	| BasicEventPayload
-	| WatchEventPayload