@dxos/functions 0.5.3-main.59db342 → 0.5.3-main.61bbff4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/dist/lib/browser/index.mjs +829 -265
  2. package/dist/lib/browser/index.mjs.map +4 -4
  3. package/dist/lib/browser/meta.json +1 -1
  4. package/dist/lib/node/index.cjs +817 -266
  5. package/dist/lib/node/index.cjs.map +4 -4
  6. package/dist/lib/node/meta.json +1 -1
  7. package/dist/types/src/handler.d.ts +33 -12
  8. package/dist/types/src/handler.d.ts.map +1 -1
  9. package/dist/types/src/index.d.ts +3 -1
  10. package/dist/types/src/index.d.ts.map +1 -1
  11. package/dist/types/src/registry/function-registry.d.ts +24 -0
  12. package/dist/types/src/registry/function-registry.d.ts.map +1 -0
  13. package/dist/types/src/registry/function-registry.test.d.ts +2 -0
  14. package/dist/types/src/registry/function-registry.test.d.ts.map +1 -0
  15. package/dist/types/src/registry/index.d.ts +2 -0
  16. package/dist/types/src/registry/index.d.ts.map +1 -0
  17. package/dist/types/src/runtime/dev-server.d.ts +15 -7
  18. package/dist/types/src/runtime/dev-server.d.ts.map +1 -1
  19. package/dist/types/src/runtime/dev-server.test.d.ts +2 -0
  20. package/dist/types/src/runtime/dev-server.test.d.ts.map +1 -0
  21. package/dist/types/src/runtime/scheduler.d.ts +14 -15
  22. package/dist/types/src/runtime/scheduler.d.ts.map +1 -1
  23. package/dist/types/src/testing/functions-integration.test.d.ts +2 -0
  24. package/dist/types/src/testing/functions-integration.test.d.ts.map +1 -0
  25. package/dist/types/src/testing/index.d.ts +4 -0
  26. package/dist/types/src/testing/index.d.ts.map +1 -0
  27. package/dist/types/src/testing/setup.d.ts +5 -0
  28. package/dist/types/src/testing/setup.d.ts.map +1 -0
  29. package/dist/types/src/testing/test/handler.d.ts +4 -0
  30. package/dist/types/src/testing/test/handler.d.ts.map +1 -0
  31. package/dist/types/src/testing/test/index.d.ts +3 -0
  32. package/dist/types/src/testing/test/index.d.ts.map +1 -0
  33. package/dist/types/src/testing/types.d.ts +9 -0
  34. package/dist/types/src/testing/types.d.ts.map +1 -0
  35. package/dist/types/src/testing/util.d.ts +3 -0
  36. package/dist/types/src/testing/util.d.ts.map +1 -0
  37. package/dist/types/src/trigger/index.d.ts +2 -0
  38. package/dist/types/src/trigger/index.d.ts.map +1 -0
  39. package/dist/types/src/trigger/trigger-registry.d.ts +40 -0
  40. package/dist/types/src/trigger/trigger-registry.d.ts.map +1 -0
  41. package/dist/types/src/trigger/trigger-registry.test.d.ts +2 -0
  42. package/dist/types/src/trigger/trigger-registry.test.d.ts.map +1 -0
  43. package/dist/types/src/trigger/type/index.d.ts +5 -0
  44. package/dist/types/src/trigger/type/index.d.ts.map +1 -0
  45. package/dist/types/src/trigger/type/subscription-trigger.d.ts +4 -0
  46. package/dist/types/src/trigger/type/subscription-trigger.d.ts.map +1 -0
  47. package/dist/types/src/trigger/type/timer-trigger.d.ts +4 -0
  48. package/dist/types/src/trigger/type/timer-trigger.d.ts.map +1 -0
  49. package/dist/types/src/trigger/type/webhook-trigger.d.ts +4 -0
  50. package/dist/types/src/trigger/type/webhook-trigger.d.ts.map +1 -0
  51. package/dist/types/src/trigger/type/websocket-trigger.d.ts +13 -0
  52. package/dist/types/src/trigger/type/websocket-trigger.d.ts.map +1 -0
  53. package/dist/types/src/types.d.ts +188 -0
  54. package/dist/types/src/types.d.ts.map +1 -0
  55. package/dist/types/tools/schema.d.ts +2 -0
  56. package/dist/types/tools/schema.d.ts.map +1 -0
  57. package/package.json +23 -11
  58. package/schema/functions.json +197 -0
  59. package/src/handler.ts +56 -26
  60. package/src/index.ts +3 -1
  61. package/src/registry/function-registry.test.ts +105 -0
  62. package/src/registry/function-registry.ts +84 -0
  63. package/src/registry/index.ts +5 -0
  64. package/src/runtime/dev-server.test.ts +60 -0
  65. package/src/runtime/dev-server.ts +104 -52
  66. package/src/runtime/scheduler.test.ts +154 -21
  67. package/src/runtime/scheduler.ts +76 -152
  68. package/src/testing/functions-integration.test.ts +99 -0
  69. package/src/testing/index.ts +7 -0
  70. package/src/testing/setup.ts +45 -0
  71. package/src/testing/test/handler.ts +15 -0
  72. package/src/testing/test/index.ts +7 -0
  73. package/src/testing/types.ts +9 -0
  74. package/src/testing/util.ts +16 -0
  75. package/src/trigger/index.ts +5 -0
  76. package/src/trigger/trigger-registry.test.ts +229 -0
  77. package/src/trigger/trigger-registry.ts +176 -0
  78. package/src/trigger/type/index.ts +8 -0
  79. package/src/trigger/type/subscription-trigger.ts +73 -0
  80. package/src/trigger/type/timer-trigger.ts +44 -0
  81. package/src/trigger/type/webhook-trigger.ts +47 -0
  82. package/src/trigger/type/websocket-trigger.ts +91 -0
  83. package/src/types.ts +101 -0
  84. package/dist/types/src/manifest.d.ts +0 -26
  85. package/dist/types/src/manifest.d.ts.map +0 -1
  86. package/src/manifest.ts +0 -42
@@ -0,0 +1,16 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import { Filter, type Space } from '@dxos/client/echo';
6
+ import { invariant } from '@dxos/invariant';
7
+
8
+ import { FunctionTrigger } from '../types';
9
+
10
+ export const triggerWebhook = async (space: Space, uri: string) => {
11
+ const trigger = (
12
+ await space.db.query(Filter.schema(FunctionTrigger, (t: FunctionTrigger) => t.function === uri)).run()
13
+ ).objects[0];
14
+ invariant(trigger.spec.type === 'webhook');
15
+ void fetch(`http://localhost:${trigger.spec.port}`);
16
+ };
@@ -0,0 +1,5 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ export * from './trigger-registry';
@@ -0,0 +1,229 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import chai, { expect } from 'chai';
6
+ import chaiAsPromised from 'chai-as-promised';
7
+
8
+ import { sleep, Trigger, waitForCondition } from '@dxos/async';
9
+ import { type Client } from '@dxos/client';
10
+ import { type Space } from '@dxos/client/echo';
11
+ import { TestBuilder } from '@dxos/client/testing';
12
+ import { Context } from '@dxos/context';
13
+ import { Filter } from '@dxos/echo-db';
14
+ import { create } from '@dxos/echo-schema';
15
+ import { describe, test } from '@dxos/test';
16
+ import { range } from '@dxos/util';
17
+
18
+ import { TriggerRegistry } from './trigger-registry';
19
+ import { createInitializedClients, TestType, triggerWebhook } from '../testing';
20
+ import { type FunctionManifest, FunctionTrigger } from '../types';
21
+
22
+ const testManifest: FunctionManifest = {
23
+ triggers: [
24
+ {
25
+ function: 'example.com/function/webhook-test',
26
+ spec: {
27
+ type: 'webhook',
28
+ method: 'GET',
29
+ },
30
+ },
31
+ {
32
+ function: 'example.com/function/subscription-test',
33
+ spec: {
34
+ type: 'subscription',
35
+ filter: [{ type: TestType.typename }],
36
+ },
37
+ },
38
+ ],
39
+ };
40
+
41
+ chai.use(chaiAsPromised);
42
+
43
+ describe('trigger registry', () => {
44
+ let ctx: Context;
45
+ let testBuilder: TestBuilder;
46
+ beforeEach(async () => {
47
+ ctx = new Context();
48
+ testBuilder = new TestBuilder();
49
+ });
50
+ afterEach(async () => {
51
+ await ctx.dispose();
52
+ await testBuilder.destroy();
53
+ });
54
+
55
+ describe('register', () => {
56
+ test('creates new triggers', async () => {
57
+ const client = (await createInitializedClients(testBuilder))[0];
58
+ const registry = createRegistry(client);
59
+ const space = await client.spaces.create();
60
+ await registry.register(space, testManifest);
61
+ const { objects } = await space.db.query(Filter.schema(FunctionTrigger)).run();
62
+ expect(objects.length).to.eq(testManifest.triggers?.length);
63
+ const expected = testManifest.triggers?.map((t) => t.function).sort();
64
+ expect(objects.map((o: FunctionTrigger) => o.function).sort()).to.deep.eq(expected);
65
+ });
66
+ });
67
+
68
+ describe('activate', () => {
69
+ test('invokes the provided callback', async () => {
70
+ const client = (await createInitializedClients(testBuilder))[0];
71
+ const space = await client.spaces.create();
72
+ const registry = createRegistry(client);
73
+ await registry.register(space, testManifest);
74
+ await registry.open(ctx);
75
+ await waitHasInactiveTriggers(registry, space);
76
+
77
+ const callbackInvoked = new Trigger();
78
+ const { objects: allTriggers } = await space.db.query(Filter.schema(FunctionTrigger)).run();
79
+ const webhookTrigger = allTriggers.find((t: FunctionTrigger) => t.spec.type === 'webhook')!;
80
+ await registry.activate({ space }, webhookTrigger, async () => {
81
+ callbackInvoked.wake();
82
+ return 200;
83
+ });
84
+
85
+ setTimeout(() => triggerWebhook(space, webhookTrigger.function));
86
+ await callbackInvoked.wait();
87
+ });
88
+
89
+ test('removes from inactive list', async () => {
90
+ const client = (await createInitializedClients(testBuilder))[0];
91
+ const space = await client.spaces.create();
92
+ const registry = createRegistry(client);
93
+ await registry.register(space, testManifest);
94
+ await registry.open(ctx);
95
+ await waitHasInactiveTriggers(registry, space);
96
+
97
+ const inactiveTrigger = registry.getInactiveTriggers(space)[0];
98
+ await registry.activate({ space }, inactiveTrigger, async () => 200);
99
+
100
+ const updatedInactiveList = registry.getInactiveTriggers(space);
101
+ expect(updatedInactiveList.find((t: FunctionTrigger) => t.function === inactiveTrigger.function)).to.be.undefined;
102
+ });
103
+ });
104
+
105
+ describe('deactivate', () => {
106
+ test('trigger object deletion deactivates a trigger', async () => {
107
+ const client = (await createInitializedClients(testBuilder))[0];
108
+ const space = await client.spaces.create();
109
+ const registry = createRegistry(client);
110
+ await registry.register(space, testManifest);
111
+ await registry.open(ctx);
112
+ await waitHasInactiveTriggers(registry, space);
113
+
114
+ const { objects: allTriggers } = await space.db.query(Filter.schema(FunctionTrigger)).run();
115
+ const echoTrigger = allTriggers.find((t: FunctionTrigger) => t.spec.type === 'subscription')!;
116
+ let count = 0;
117
+ await registry.activate({ space }, echoTrigger, async () => {
118
+ count++;
119
+ return 200;
120
+ });
121
+
122
+ space.db.add(create(TestType, { title: '1' }));
123
+ await sleep(20);
124
+ expect(count).to.eq(1);
125
+
126
+ space.db.remove(echoTrigger);
127
+
128
+ space.db.add(create(TestType, { title: '2' }));
129
+ await sleep(20);
130
+ expect(count).to.eq(1);
131
+ });
132
+
133
+ test('registry closing deactivates a trigger', async () => {
134
+ const client = (await createInitializedClients(testBuilder))[0];
135
+ const space = await client.spaces.create();
136
+ const registry = createRegistry(client);
137
+ await registry.register(space, testManifest);
138
+ await registry.open(ctx);
139
+ await waitHasInactiveTriggers(registry, space);
140
+
141
+ const { objects: allTriggers } = await space.db.query(Filter.schema(FunctionTrigger)).run();
142
+ const echoTrigger = allTriggers.find((t: FunctionTrigger) => t.spec.type === 'subscription')!;
143
+ let count = 0;
144
+ await registry.activate({ space }, echoTrigger, async () => {
145
+ count++;
146
+ return 200;
147
+ });
148
+
149
+ await registry.close();
150
+
151
+ space.db.add(create(TestType, { title: '1' }));
152
+ await sleep(20);
153
+ expect(count).to.eq(0);
154
+ });
155
+ });
156
+
157
+ describe('trigger events', () => {
158
+ test('event fired when all registered when opened', async () => {
159
+ const client = (await createInitializedClients(testBuilder))[0];
160
+ const registry = createRegistry(client);
161
+ const triggers = createTriggersInSpace(client.spaces.default, 3);
162
+
163
+ const triggersRegistered = new Trigger<FunctionTrigger[]>();
164
+ registry.registered.on((fn) => {
165
+ expect(fn.space.key.toHex()).to.eq(client.spaces.default.key.toHex());
166
+ triggersRegistered.wake(fn.triggers);
167
+ });
168
+ void registry.open(ctx);
169
+ const functions = await triggersRegistered.wait();
170
+ const expected = triggers.map((obj) => obj.id).sort();
171
+ expect(functions.map((fn) => fn.id).sort()).to.deep.eq(expected);
172
+ });
173
+
174
+ test('event fired when a new trigger is added', async () => {
175
+ const client = (await createInitializedClients(testBuilder))[0];
176
+ const registry = createRegistry(client);
177
+ const space = await client.spaces.create();
178
+
179
+ const triggerRegistered = new Trigger<FunctionTrigger>();
180
+ registry.registered.on((fn) => {
181
+ expect(fn.triggers.length).to.eq(1);
182
+ triggerRegistered.wake(fn.triggers[0]);
183
+ });
184
+ await registry.open(ctx);
185
+ await registry.register(space, { triggers: testManifest?.triggers?.slice(0, 1) });
186
+ const registered = await triggerRegistered.wait();
187
+ expect(registered.function).to.eq(testManifest.triggers![0].function);
188
+ });
189
+
190
+ test('event fired when a new trigger is removed', async () => {
191
+ const client = (await createInitializedClients(testBuilder))[0];
192
+ const registry = createRegistry(client);
193
+ const space = await client.spaces.create();
194
+ const triggers = createTriggersInSpace(space, 3);
195
+
196
+ const triggerLoaded = new Trigger();
197
+ registry.registered.on((fn) => triggerLoaded.wake());
198
+
199
+ const triggerRemoved = new Trigger<FunctionTrigger>();
200
+ registry.removed.on((fn) => {
201
+ expect(fn.triggers.length).to.eq(1);
202
+ triggerRemoved.wake(fn.triggers[0]);
203
+ });
204
+ await registry.register(space, testManifest);
205
+ await registry.open(ctx);
206
+ await triggerLoaded.wait();
207
+
208
+ space.db.remove(triggers[0]);
209
+ const removedTrigger = await triggerRemoved.wait();
210
+ expect(removedTrigger.id).to.eq(triggers[0].id);
211
+ });
212
+ });
213
+
214
+ const waitHasInactiveTriggers = async (registry: TriggerRegistry, space: Space) => {
215
+ await waitForCondition({ condition: () => registry.getInactiveTriggers(space).length > 0 });
216
+ };
217
+
218
+ const createRegistry = (client: Client) => {
219
+ const registry = new TriggerRegistry(client);
220
+ ctx.onDispose(() => registry.close());
221
+ return registry;
222
+ };
223
+
224
+ const createTriggersInSpace = (space: Space, count: number) => {
225
+ const triggers = range(count, () => create(FunctionTrigger, { ...testManifest.triggers![0] }));
226
+ triggers.forEach((def) => space.db.add(def));
227
+ return triggers;
228
+ };
229
+ });
@@ -0,0 +1,176 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import { Event } from '@dxos/async';
6
+ import { type Client } from '@dxos/client';
7
+ import { create, Filter, type Space } from '@dxos/client/echo';
8
+ import { Context, Resource } from '@dxos/context';
9
+ import { invariant } from '@dxos/invariant';
10
+ import { PublicKey } from '@dxos/keys';
11
+ import { log } from '@dxos/log';
12
+ import { ComplexMap } from '@dxos/util';
13
+
14
+ import { createSubscriptionTrigger, createTimerTrigger, createWebhookTrigger, createWebsocketTrigger } from './type';
15
+ import { type FunctionManifest, FunctionTrigger, type FunctionTriggerType, type TriggerSpec } from '../types';
16
+
17
+ type ResponseCode = number;
18
+
19
+ export type TriggerCallback = (args: object) => Promise<ResponseCode>;
20
+
21
+ export type TriggerContext = { space: Space };
22
+
23
+ // TODO(burdon): Make object?
24
+ export type TriggerFactory<Spec extends TriggerSpec, Options = any> = (
25
+ ctx: Context,
26
+ context: TriggerContext,
27
+ spec: Spec,
28
+ callback: TriggerCallback,
29
+ options?: Options,
30
+ ) => Promise<void>;
31
+
32
+ export type TriggerHandlerMap = { [type in FunctionTriggerType]: TriggerFactory<any> };
33
+
34
+ const triggerHandlers: TriggerHandlerMap = {
35
+ subscription: createSubscriptionTrigger,
36
+ timer: createTimerTrigger,
37
+ webhook: createWebhookTrigger,
38
+ websocket: createWebsocketTrigger,
39
+ };
40
+
41
+ export type TriggerEvent = {
42
+ space: Space;
43
+ triggers: FunctionTrigger[];
44
+ };
45
+
46
+ type RegisteredTrigger = {
47
+ activationCtx?: Context;
48
+ trigger: FunctionTrigger;
49
+ };
50
+
51
+ export class TriggerRegistry extends Resource {
52
+ private readonly _triggersBySpaceKey = new ComplexMap<PublicKey, RegisteredTrigger[]>(PublicKey.hash);
53
+
54
+ public readonly registered = new Event<TriggerEvent>();
55
+ public readonly removed = new Event<TriggerEvent>();
56
+
57
+ constructor(
58
+ private readonly _client: Client,
59
+ private readonly _options?: TriggerHandlerMap,
60
+ ) {
61
+ super();
62
+ }
63
+
64
+ public getActiveTriggers(space: Space): FunctionTrigger[] {
65
+ return this._getTriggers(space, (t) => t.activationCtx != null);
66
+ }
67
+
68
+ public getInactiveTriggers(space: Space): FunctionTrigger[] {
69
+ return this._getTriggers(space, (t) => t.activationCtx == null);
70
+ }
71
+
72
+ async activate(triggerCtx: TriggerContext, trigger: FunctionTrigger, callback: TriggerCallback): Promise<void> {
73
+ log('activate', { space: triggerCtx.space.key, trigger });
74
+ const activationCtx = new Context({ name: `trigger_${trigger.function}` });
75
+ this._ctx.onDispose(() => activationCtx.dispose());
76
+ const registeredTrigger = this._triggersBySpaceKey
77
+ .get(triggerCtx.space.key)
78
+ ?.find((reg) => reg.trigger.id === trigger.id);
79
+ invariant(registeredTrigger, `Trigger is not registered: ${trigger.function}`);
80
+ registeredTrigger.activationCtx = activationCtx;
81
+
82
+ try {
83
+ const options = this._options?.[trigger.spec.type];
84
+ await triggerHandlers[trigger.spec.type](activationCtx, triggerCtx, trigger.spec, callback, options);
85
+ } catch (err) {
86
+ delete registeredTrigger.activationCtx;
87
+ throw err;
88
+ }
89
+ }
90
+
91
+ /**
92
+ * Loads triggers from the manifest into the space.
93
+ */
94
+ public async register(space: Space, manifest: FunctionManifest): Promise<void> {
95
+ log('register', { space: space.key });
96
+ if (!manifest.triggers?.length) {
97
+ return;
98
+ }
99
+ if (!space.db.graph.runtimeSchemaRegistry.hasSchema(FunctionTrigger)) {
100
+ space.db.graph.runtimeSchemaRegistry.registerSchema(FunctionTrigger);
101
+ }
102
+
103
+ const reactiveObjects = manifest.triggers.map((template: Omit<FunctionTrigger, 'id'>) =>
104
+ create(FunctionTrigger, { ...template }),
105
+ );
106
+ reactiveObjects.forEach((obj) => space.db.add(obj));
107
+ }
108
+
109
+ protected override async _open(): Promise<void> {
110
+ const spaceListSubscription = this._client.spaces.subscribe(async (spaces) => {
111
+ for (const space of spaces) {
112
+ if (this._triggersBySpaceKey.has(space.key)) {
113
+ continue;
114
+ }
115
+
116
+ const registered: RegisteredTrigger[] = [];
117
+ this._triggersBySpaceKey.set(space.key, registered);
118
+ await space.waitUntilReady();
119
+ if (this._ctx.disposed) {
120
+ break;
121
+ }
122
+ const functionsSubscription = space.db.query(Filter.schema(FunctionTrigger)).subscribe(async (triggers) => {
123
+ await this._handleRemovedTriggers(space, triggers.objects, registered);
124
+ this._handleNewTriggers(space, triggers.objects, registered);
125
+ });
126
+
127
+ this._ctx.onDispose(functionsSubscription);
128
+ }
129
+ });
130
+
131
+ this._ctx.onDispose(() => spaceListSubscription.unsubscribe());
132
+ }
133
+
134
+ protected override async _close(_: Context): Promise<void> {
135
+ this._triggersBySpaceKey.clear();
136
+ }
137
+
138
+ private _handleNewTriggers(space: Space, allTriggers: FunctionTrigger[], registered: RegisteredTrigger[]) {
139
+ const newTriggers = allTriggers.filter((candidate) => {
140
+ return registered.find((reg) => reg.trigger.id === candidate.id) == null;
141
+ });
142
+
143
+ if (newTriggers.length > 0) {
144
+ const newRegisteredTriggers: RegisteredTrigger[] = newTriggers.map((trigger) => ({ trigger }));
145
+ registered.push(...newRegisteredTriggers);
146
+ log('registered new triggers', () => ({ spaceKey: space.key, functions: newTriggers.map((t) => t.function) }));
147
+ this.registered.emit({ space, triggers: newTriggers });
148
+ }
149
+ }
150
+
151
+ private async _handleRemovedTriggers(
152
+ space: Space,
153
+ allTriggers: FunctionTrigger[],
154
+ registered: RegisteredTrigger[],
155
+ ): Promise<void> {
156
+ const removed: FunctionTrigger[] = [];
157
+ for (let i = registered.length - 1; i >= 0; i--) {
158
+ const wasRemoved =
159
+ allTriggers.find((trigger: FunctionTrigger) => trigger.id === registered[i].trigger.id) == null;
160
+ if (wasRemoved) {
161
+ const unregistered = registered.splice(i, 1)[0];
162
+ await unregistered.activationCtx?.dispose();
163
+ removed.push(unregistered.trigger);
164
+ }
165
+ }
166
+
167
+ if (removed.length > 0) {
168
+ this.removed.emit({ space, triggers: removed });
169
+ }
170
+ }
171
+
172
+ private _getTriggers(space: Space, predicate: (trigger: RegisteredTrigger) => boolean): FunctionTrigger[] {
173
+ const allSpaceTriggers = this._triggersBySpaceKey.get(space.key) ?? [];
174
+ return allSpaceTriggers.filter(predicate).map((trigger) => trigger.trigger);
175
+ }
176
+ }
@@ -0,0 +1,8 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ export * from './subscription-trigger';
6
+ export * from './timer-trigger';
7
+ export * from './webhook-trigger';
8
+ export * from './websocket-trigger';
@@ -0,0 +1,73 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import { TextV0Type } from '@braneframe/types';
6
+ import { debounce, DeferredTask } from '@dxos/async';
7
+ import { type Context } from '@dxos/context';
8
+ import { createSubscription, Filter, getAutomergeObjectCore, type Query } from '@dxos/echo-db';
9
+ import { log } from '@dxos/log';
10
+
11
+ import type { SubscriptionTrigger } from '../../types';
12
+ import { type TriggerCallback, type TriggerContext, type TriggerFactory } from '../trigger-registry';
13
+
14
+ export const createSubscriptionTrigger: TriggerFactory<SubscriptionTrigger> = async (
15
+ ctx: Context,
16
+ triggerCtx: TriggerContext,
17
+ spec: SubscriptionTrigger,
18
+ callback: TriggerCallback,
19
+ ) => {
20
+ const objectIds = new Set<string>();
21
+ const task = new DeferredTask(ctx, async () => {
22
+ if (objectIds.size > 0) {
23
+ await callback({ objects: Array.from(objectIds) });
24
+ objectIds.clear();
25
+ }
26
+ });
27
+
28
+ // TODO(burdon): Don't fire initially?
29
+ // TODO(burdon): Create queue. Only allow one invocation per trigger at a time?
30
+ const subscriptions: (() => void)[] = [];
31
+ const subscription = createSubscription(({ added, updated }) => {
32
+ log.info('updated', { added: added.length, updated: updated.length });
33
+ for (const object of added) {
34
+ objectIds.add(object.id);
35
+ }
36
+ for (const object of updated) {
37
+ objectIds.add(object.id);
38
+ }
39
+
40
+ task.schedule();
41
+ });
42
+
43
+ subscriptions.push(() => subscription.unsubscribe());
44
+
45
+ // TODO(burdon): Disable trigger if keeps failing.
46
+ const { filter, options: { deep, delay } = {} } = spec;
47
+ const update = ({ objects }: Query) => {
48
+ subscription.update(objects);
49
+
50
+ // TODO(burdon): Hack to monitor changes to Document's text object.
51
+ if (deep) {
52
+ log.info('update', { objects: objects.length });
53
+ for (const object of objects) {
54
+ const content = object.content;
55
+ if (content instanceof TextV0Type) {
56
+ subscriptions.push(
57
+ getAutomergeObjectCore(content).updates.on(debounce(() => subscription.update([object]), 1_000)),
58
+ );
59
+ }
60
+ }
61
+ }
62
+ };
63
+
64
+ // TODO(burdon): Is Filter.or implemented?
65
+ // TODO(burdon): [Bug]: all callbacks are fired on the first mutation.
66
+ // TODO(burdon): [Bug]: not updated when document is deleted (either top or hierarchically).
67
+ const query = triggerCtx.space.db.query(Filter.or(filter.map(({ type, props }) => Filter.typename(type, props))));
68
+ subscriptions.push(query.subscribe(delay ? debounce(update, delay) : update));
69
+
70
+ ctx.onDispose(() => {
71
+ subscriptions.forEach((unsubscribe) => unsubscribe());
72
+ });
73
+ };
@@ -0,0 +1,44 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import { CronJob } from 'cron';
6
+
7
+ import { DeferredTask } from '@dxos/async';
8
+ import { type Context } from '@dxos/context';
9
+ import { log } from '@dxos/log';
10
+
11
+ import type { TimerTrigger } from '../../types';
12
+ import { type TriggerCallback, type TriggerContext, type TriggerFactory } from '../trigger-registry';
13
+
14
+ export const createTimerTrigger: TriggerFactory<TimerTrigger> = async (
15
+ ctx: Context,
16
+ triggerContext: TriggerContext,
17
+ spec: TimerTrigger,
18
+ callback: TriggerCallback,
19
+ ) => {
20
+ const task = new DeferredTask(ctx, async () => {
21
+ await callback({});
22
+ });
23
+
24
+ let last = 0;
25
+ let run = 0;
26
+ // https://www.npmjs.com/package/cron#constructor
27
+ const job = CronJob.from({
28
+ cronTime: spec.cron,
29
+ runOnInit: false,
30
+ onTick: () => {
31
+ // TODO(burdon): Check greater than 30s (use cron-parser).
32
+ const now = Date.now();
33
+ const delta = last ? now - last : 0;
34
+ last = now;
35
+
36
+ run++;
37
+ log.info('tick', { space: triggerContext.space.key.truncate(), count: run, delta });
38
+ task.schedule();
39
+ },
40
+ });
41
+
42
+ job.start();
43
+ ctx.onDispose(() => job.stop());
44
+ };
@@ -0,0 +1,47 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import { getPort } from 'get-port-please';
6
+ import http from 'node:http';
7
+
8
+ import { type Context } from '@dxos/context';
9
+ import { log } from '@dxos/log';
10
+
11
+ import type { WebhookTrigger } from '../../types';
12
+ import { type TriggerCallback, type TriggerContext, type TriggerFactory } from '../trigger-registry';
13
+
14
+ export const createWebhookTrigger: TriggerFactory<WebhookTrigger> = async (
15
+ ctx: Context,
16
+ _: TriggerContext,
17
+ spec: WebhookTrigger,
18
+ callback: TriggerCallback,
19
+ ) => {
20
+ // TODO(burdon): Enable POST hook with payload.
21
+ const server = http.createServer(async (req, res) => {
22
+ if (req.method !== spec.method) {
23
+ res.statusCode = 405;
24
+ return res.end();
25
+ }
26
+ res.statusCode = await callback({});
27
+ res.end();
28
+ });
29
+
30
+ // TODO(burdon): Not used.
31
+ // const DEF_PORT_RANGE = { min: 7500, max: 7599 };
32
+ // const portRange = Object.assign({}, trigger.port, DEF_PORT_RANGE) as WebhookTrigger['port'];
33
+ const port = await getPort({
34
+ random: true,
35
+ // portRange: [portRange!.min, portRange!.max],
36
+ });
37
+
38
+ // TODO(burdon): Update trigger object with actual port.
39
+ server.listen(port, () => {
40
+ log.info('started webhook', { port });
41
+ spec.port = port;
42
+ });
43
+
44
+ ctx.onDispose(() => {
45
+ server.close();
46
+ });
47
+ };
@@ -0,0 +1,91 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import WebSocket from 'ws';
6
+
7
+ import { sleep, Trigger } from '@dxos/async';
8
+ import { type Context } from '@dxos/context';
9
+ import { log } from '@dxos/log';
10
+
11
+ import { type WebsocketTrigger } from '../../types';
12
+ import { type TriggerCallback, type TriggerContext, type TriggerFactory } from '../trigger-registry';
13
+
14
+ interface WebsocketTriggerOptions {
15
+ retryDelay: number;
16
+ maxAttempts: number;
17
+ }
18
+
19
+ /**
20
+ * Websocket.
21
+ * NOTE: The port must be unique, so the same hook cannot be used for multiple spaces.
22
+ */
23
+ export const createWebsocketTrigger: TriggerFactory<WebsocketTrigger, WebsocketTriggerOptions> = async (
24
+ ctx: Context,
25
+ triggerCtx: TriggerContext,
26
+ spec: WebsocketTrigger,
27
+ callback: TriggerCallback,
28
+ options: WebsocketTriggerOptions = { retryDelay: 2, maxAttempts: 5 },
29
+ ) => {
30
+ const { url, init } = spec;
31
+
32
+ let ws: WebSocket;
33
+ for (let attempt = 1; attempt <= options.maxAttempts; attempt++) {
34
+ const open = new Trigger<boolean>();
35
+
36
+ ws = new WebSocket(url);
37
+ Object.assign(ws, {
38
+ onopen: () => {
39
+ log.info('opened', { url });
40
+ if (spec.init) {
41
+ ws.send(new TextEncoder().encode(JSON.stringify(init)));
42
+ }
43
+
44
+ open.wake(true);
45
+ },
46
+
47
+ onclose: (event) => {
48
+ log.info('closed', { url, code: event.code });
49
+ // Reconnect if server closes (e.g., CF restart).
50
+ // https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
51
+ if (event.code === 1006) {
52
+ setTimeout(async () => {
53
+ log.info(`reconnecting in ${options.retryDelay}s...`, { url });
54
+ await createWebsocketTrigger(ctx, triggerCtx, spec, callback, options);
55
+ }, options.retryDelay * 1_000);
56
+ }
57
+
58
+ open.wake(false);
59
+ },
60
+
61
+ onerror: (event) => {
62
+ log.catch(event.error, { url });
63
+ },
64
+
65
+ onmessage: async (event) => {
66
+ try {
67
+ log.info('message');
68
+ const data = JSON.parse(new TextDecoder().decode(event.data as Uint8Array));
69
+ await callback({ data });
70
+ } catch (err) {
71
+ log.catch(err, { url });
72
+ }
73
+ },
74
+ } satisfies Partial<WebSocket>);
75
+
76
+ const isOpen = await open.wait();
77
+ if (isOpen) {
78
+ break;
79
+ } else {
80
+ const wait = Math.pow(attempt, 2) * options.retryDelay;
81
+ if (attempt < options.maxAttempts) {
82
+ log.warn(`failed to connect; trying again in ${wait}s`, { attempt });
83
+ await sleep(wait * 1_000);
84
+ }
85
+ }
86
+ }
87
+
88
+ ctx.onDispose(() => {
89
+ ws?.close();
90
+ });
91
+ };