@terreno/api 0.31.0 → 56.0.0-beta.0
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.
- package/CHANGELOG.md +122 -2
- package/LICENSE +202 -21
- package/dist/api.d.ts +12 -3
- package/dist/api.js +110 -361
- package/dist/auth.d.ts +26 -0
- package/dist/auth.js +100 -1
- package/dist/betterAuth.d.ts +5 -0
- package/dist/betterAuthSetup.d.ts +1 -15
- package/dist/betterAuthSetup.js +29 -8
- package/dist/configurationPlugin.js +2 -2
- package/dist/docLoader.js +12 -9
- package/dist/errors.d.ts +13 -0
- package/dist/errors.js +29 -1
- package/dist/expressServer.js +5 -11
- package/dist/githubAuth.js +4 -1
- package/dist/index.d.ts +17 -1
- package/dist/index.js +29 -1
- package/dist/middleware.d.ts +7 -0
- package/dist/middleware.js +16 -1
- package/dist/openApiCompat.d.ts +10 -1
- package/dist/openApiCompat.js +115 -47
- package/dist/permissions.d.ts +27 -0
- package/dist/permissions.js +42 -1
- package/dist/plugins.d.ts +15 -3
- package/dist/plugins.js +36 -6
- package/dist/realtime/changeStreamWatcher.d.ts +100 -3
- package/dist/realtime/changeStreamWatcher.js +542 -137
- package/dist/realtime/realtimeApp.d.ts +3 -1
- package/dist/realtime/realtimeApp.js +75 -27
- package/dist/realtime/sessionRevalidation.d.ts +90 -0
- package/dist/realtime/sessionRevalidation.js +438 -0
- package/dist/realtime/socketAuth.d.ts +97 -0
- package/dist/realtime/socketAuth.js +272 -0
- package/dist/realtime/socketUser.d.ts +54 -0
- package/dist/realtime/socketUser.js +75 -5
- package/dist/realtime/types.d.ts +40 -0
- package/dist/secretProviders.d.ts +23 -0
- package/dist/secretProviders.js +9 -3
- package/dist/sync/executors.d.ts +198 -0
- package/dist/sync/executors.js +670 -0
- package/dist/sync/loadHarness.js +807 -0
- package/dist/sync/models.d.ts +216 -0
- package/dist/sync/models.js +644 -0
- package/dist/sync/mutationHandler.d.ts +97 -0
- package/dist/sync/mutationHandler.js +886 -0
- package/dist/sync/registry.d.ts +73 -0
- package/dist/sync/registry.js +223 -0
- package/dist/sync/routes.d.ts +62 -0
- package/dist/sync/routes.js +936 -0
- package/dist/sync/scripts/compactTombstones.d.ts +47 -0
- package/dist/sync/scripts/compactTombstones.js +270 -0
- package/dist/sync/serialize.d.ts +20 -0
- package/dist/{tests/bunSetup.js → sync/serialize.js} +35 -68
- package/dist/sync/socketHandlers.d.ts +54 -0
- package/dist/sync/socketHandlers.js +470 -0
- package/dist/sync/streams.d.ts +85 -0
- package/dist/sync/streams.js +221 -0
- package/dist/sync/syncApp.d.ts +29 -0
- package/dist/sync/syncApp.js +44 -0
- package/dist/sync/syncBatch.d.ts +71 -0
- package/dist/sync/syncBatch.js +252 -0
- package/dist/sync/syncSeqPlugin.d.ts +8 -0
- package/dist/sync/syncSeqPlugin.js +903 -0
- package/dist/sync/types.d.ts +254 -0
- package/dist/sync/types.js +9 -0
- package/dist/terrenoApp.js +90 -27
- package/dist/tests/models.d.ts +11 -27
- package/dist/tests/models.js +3 -5
- package/dist/tests/testHelper.d.ts +3 -9
- package/dist/vendor/wesleytodd-openapi/index.d.ts +1 -1
- package/dist/vendor/wesleytodd-openapi/lib/ui.d.ts +2 -1
- package/package.json +10 -8
- package/src/__tests__/openApiCompat.test.ts +20 -0
- package/src/actions.test.ts +12 -19
- package/src/actions.ts +2 -2
- package/src/api.coverage.test.ts +9 -7
- package/src/api.errorPaths.test.ts +1 -47
- package/src/api.test.ts +12 -0
- package/src/api.ts +98 -317
- package/src/auth.test.ts +128 -176
- package/src/auth.ts +109 -0
- package/src/betterAuth.ts +6 -0
- package/src/betterAuthSetup.test.ts +34 -0
- package/src/betterAuthSetup.ts +27 -8
- package/src/configurationPlugin.ts +2 -2
- package/src/consentApp.test.ts +12 -12
- package/src/docLoader.ts +3 -1
- package/src/errors.ts +33 -0
- package/src/expressServer.test.ts +7 -1
- package/src/expressServer.ts +5 -11
- package/src/githubAuth.ts +3 -1
- package/src/index.ts +42 -0
- package/src/middleware.test.ts +40 -1
- package/src/middleware.ts +15 -0
- package/src/models/versionConfig.ts +1 -1
- package/src/openApiBuilder.test.ts +9 -24
- package/src/openApiCompat.ts +99 -45
- package/src/openApiValidator.test.ts +0 -41
- package/src/permissions.test.ts +75 -1
- package/src/permissions.ts +49 -0
- package/src/plugins.test.ts +54 -14
- package/src/plugins.ts +47 -9
- package/src/populate.test.ts +16 -25
- package/src/realtime/changeStreamWatcher.ts +552 -114
- package/src/realtime/realtime.test.ts +157 -239
- package/src/realtime/realtimeApp.ts +80 -19
- package/src/realtime/sessionRevalidation.test.ts +423 -0
- package/src/realtime/sessionRevalidation.ts +273 -0
- package/src/realtime/socketAuth.test.ts +355 -0
- package/src/realtime/socketAuth.ts +228 -0
- package/src/realtime/socketUser.ts +69 -0
- package/src/realtime/types.ts +40 -0
- package/src/secretProviders.test.ts +7 -1
- package/src/secretProviders.ts +15 -3
- package/src/sync/ensureSyncIndexes.test.ts +144 -0
- package/src/sync/executors.test.ts +882 -0
- package/src/sync/executors.ts +703 -0
- package/src/sync/integration.test.ts +1160 -0
- package/src/sync/loadHarness.ts +618 -0
- package/src/sync/models.ts +640 -0
- package/src/sync/mutationHandler.test.ts +1252 -0
- package/src/sync/mutationHandler.ts +850 -0
- package/src/sync/registry.ts +232 -0
- package/src/sync/routes.ts +812 -0
- package/src/sync/scripts/compactTombstones.test.ts +249 -0
- package/src/sync/scripts/compactTombstones.ts +145 -0
- package/src/sync/serialize.ts +48 -0
- package/src/sync/sessionRevalidationIntegration.test.ts +281 -0
- package/src/sync/socketHandlers.ts +320 -0
- package/src/sync/streams.ts +188 -0
- package/src/sync/sync.test.ts +582 -0
- package/src/sync/syncApp.ts +44 -0
- package/src/sync/syncBatch.ts +219 -0
- package/src/sync/syncFrontier.test.ts +494 -0
- package/src/sync/syncPhaseC.test.ts +718 -0
- package/src/sync/syncRoutes.test.ts +865 -0
- package/src/sync/syncSeqPlugin.ts +738 -0
- package/src/sync/syncSocket.test.ts +1440 -0
- package/src/sync/types.ts +270 -0
- package/src/terrenoApp.ts +37 -17
- package/src/tests/bunSetup.ts +8 -0
- package/src/tests/models.ts +6 -8
- package/tsconfig.json +4 -4
- package/tsconfig.typedoc.json +7 -1
- package/dist/__tests__/openApiCompat.test.js +0 -317
- package/dist/__tests__/versionCheckPlugin.test.d.ts +0 -1
- package/dist/__tests__/versionCheckPlugin.test.js +0 -597
- package/dist/actions.openApi.test.d.ts +0 -1
- package/dist/actions.openApi.test.js +0 -253
- package/dist/actions.test.d.ts +0 -1
- package/dist/actions.test.js +0 -1087
- package/dist/api.arrayOperations.test.d.ts +0 -1
- package/dist/api.arrayOperations.test.js +0 -878
- package/dist/api.asyncHandler.test.d.ts +0 -1
- package/dist/api.asyncHandler.test.js +0 -236
- package/dist/api.coverage.test.d.ts +0 -1
- package/dist/api.coverage.test.js +0 -192
- package/dist/api.errorPaths.test.d.ts +0 -1
- package/dist/api.errorPaths.test.js +0 -887
- package/dist/api.errors.test.d.ts +0 -1
- package/dist/api.errors.test.js +0 -185
- package/dist/api.hooks.test.d.ts +0 -1
- package/dist/api.hooks.test.js +0 -950
- package/dist/api.query.test.d.ts +0 -1
- package/dist/api.query.test.js +0 -948
- package/dist/api.test.d.ts +0 -1
- package/dist/api.test.js +0 -2820
- package/dist/auth.compile.test.d.ts +0 -1
- package/dist/auth.compile.test.js +0 -201
- package/dist/auth.coverage.test.d.ts +0 -1
- package/dist/auth.coverage.test.js +0 -202
- package/dist/auth.test.d.ts +0 -1
- package/dist/auth.test.js +0 -2286
- package/dist/betterAuth.test.d.ts +0 -1
- package/dist/betterAuth.test.js +0 -181
- package/dist/betterAuthApp.test.d.ts +0 -1
- package/dist/betterAuthApp.test.js +0 -242
- package/dist/betterAuthSetup.test.d.ts +0 -1
- package/dist/betterAuthSetup.test.js +0 -762
- package/dist/config.test.d.ts +0 -1
- package/dist/config.test.js +0 -353
- package/dist/configuration.test.d.ts +0 -1
- package/dist/configuration.test.js +0 -980
- package/dist/configurationPlugin.test.d.ts +0 -1
- package/dist/configurationPlugin.test.js +0 -827
- package/dist/consentApp.test.d.ts +0 -1
- package/dist/consentApp.test.js +0 -1411
- package/dist/docLoader.test.d.ts +0 -1
- package/dist/docLoader.test.js +0 -137
- package/dist/envConfigurationPlugin.test.d.ts +0 -1
- package/dist/envConfigurationPlugin.test.js +0 -369
- package/dist/errors.test.d.ts +0 -1
- package/dist/errors.test.js +0 -607
- package/dist/expressServer.test.d.ts +0 -1
- package/dist/expressServer.test.js +0 -1249
- package/dist/githubAuth.test.d.ts +0 -1
- package/dist/githubAuth.test.js +0 -1142
- package/dist/httpClient.test.d.ts +0 -1
- package/dist/httpClient.test.js +0 -1471
- package/dist/logger.test.d.ts +0 -1
- package/dist/logger.test.js +0 -685
- package/dist/middleware.test.d.ts +0 -1
- package/dist/middleware.test.js +0 -241
- package/dist/notifiers/googleChatNotifier.test.d.ts +0 -1
- package/dist/notifiers/googleChatNotifier.test.js +0 -298
- package/dist/notifiers/slackNotifier.test.d.ts +0 -1
- package/dist/notifiers/slackNotifier.test.js +0 -297
- package/dist/notifiers/zoomNotifier.test.d.ts +0 -1
- package/dist/notifiers/zoomNotifier.test.js +0 -373
- package/dist/openApi.test.d.ts +0 -1
- package/dist/openApi.test.js +0 -620
- package/dist/openApiBuilder.test.d.ts +0 -1
- package/dist/openApiBuilder.test.js +0 -599
- package/dist/openApiEtag.test.d.ts +0 -1
- package/dist/openApiEtag.test.js +0 -86
- package/dist/openApiValidator.test.d.ts +0 -1
- package/dist/openApiValidator.test.js +0 -795
- package/dist/permissions.middleware.test.d.ts +0 -1
- package/dist/permissions.middleware.test.js +0 -308
- package/dist/permissions.test.d.ts +0 -1
- package/dist/permissions.test.js +0 -439
- package/dist/plugins.test.d.ts +0 -1
- package/dist/plugins.test.js +0 -902
- package/dist/populate.test.d.ts +0 -1
- package/dist/populate.test.js +0 -370
- package/dist/realtime/realtime.test.d.ts +0 -10
- package/dist/realtime/realtime.test.js +0 -4213
- package/dist/realtime/realtimeAppSetup.test.d.ts +0 -1
- package/dist/realtime/realtimeAppSetup.test.js +0 -213
- package/dist/requestContext.test.d.ts +0 -1
- package/dist/requestContext.test.js +0 -412
- package/dist/scriptRunner.test.d.ts +0 -1
- package/dist/scriptRunner.test.js +0 -386
- package/dist/secretProviders.test.d.ts +0 -1
- package/dist/secretProviders.test.js +0 -726
- package/dist/syncConsents.test.d.ts +0 -1
- package/dist/syncConsents.test.js +0 -522
- package/dist/terrenoApp.test.d.ts +0 -1
- package/dist/terrenoApp.test.js +0 -489
- package/dist/tests/bunSetup.d.ts +0 -1
- package/dist/tests/fixtures/compileAuthEntry.d.ts +0 -1
- package/dist/tests/fixtures/compileAuthEntry.js +0 -37
- package/dist/tests/testEnv.d.ts +0 -0
- package/dist/tests/testEnv.js +0 -6
- package/dist/transformers.test.d.ts +0 -1
- package/dist/transformers.test.js +0 -423
- package/dist/utils.test.d.ts +0 -1
- package/dist/utils.test.js +0 -242
- package/src/realtime/realtimeAppSetup.test.ts +0 -161
- /package/dist/{__tests__/openApiCompat.test.d.ts → sync/loadHarness.d.ts} +0 -0
|
@@ -1,161 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Tests for RealtimeApp.onServerCreated — the Socket.io server wiring that a
|
|
3
|
-
* live server would exercise. socket.io, the JWT authorize middleware, and the
|
|
4
|
-
* change-stream watcher are mocked so the connection / connect_error handlers
|
|
5
|
-
* can be captured and invoked without standing up a real server.
|
|
6
|
-
*/
|
|
7
|
-
import {afterEach, beforeAll, beforeEach, describe, expect, it, mock} from "bun:test";
|
|
8
|
-
|
|
9
|
-
import type http from "node:http";
|
|
10
|
-
|
|
11
|
-
type Handler = (...args: unknown[]) => void;
|
|
12
|
-
|
|
13
|
-
interface FakeIo {
|
|
14
|
-
handlers: Map<string, Handler>;
|
|
15
|
-
middleware: unknown[];
|
|
16
|
-
closed: boolean;
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
let ios: FakeIo[] = [];
|
|
20
|
-
let watcherStarts = 0;
|
|
21
|
-
|
|
22
|
-
class FakeServer {
|
|
23
|
-
handlers = new Map<string, Handler>();
|
|
24
|
-
middleware: unknown[] = [];
|
|
25
|
-
closed = false;
|
|
26
|
-
engine = {clientsCount: 0};
|
|
27
|
-
|
|
28
|
-
constructor(..._args: unknown[]) {
|
|
29
|
-
ios.push(this as unknown as FakeIo);
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
use(mw: unknown): void {
|
|
33
|
-
this.middleware.push(mw);
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
on(event: string, handler: Handler): void {
|
|
37
|
-
this.handlers.set(event, handler);
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
close(cb?: () => void): void {
|
|
41
|
-
this.closed = true;
|
|
42
|
-
cb?.();
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
mock.module("socket.io", () => ({Server: FakeServer}));
|
|
47
|
-
mock.module("@thream/socketio-jwt", () => ({
|
|
48
|
-
authorize: (_opts: unknown) => (_socket: unknown, next: () => void) => next(),
|
|
49
|
-
}));
|
|
50
|
-
mock.module("./changeStreamWatcher", () => ({
|
|
51
|
-
startChangeStreamWatcher: () => {
|
|
52
|
-
watcherStarts += 1;
|
|
53
|
-
},
|
|
54
|
-
stopChangeStreamWatcher: () => {},
|
|
55
|
-
}));
|
|
56
|
-
|
|
57
|
-
let RealtimeApp: typeof import("./realtimeApp").RealtimeApp;
|
|
58
|
-
|
|
59
|
-
beforeAll(async () => {
|
|
60
|
-
({RealtimeApp} = await import("./realtimeApp"));
|
|
61
|
-
});
|
|
62
|
-
|
|
63
|
-
const lastIo = (): FakeIo => {
|
|
64
|
-
const io = ios[ios.length - 1];
|
|
65
|
-
if (!io) {
|
|
66
|
-
throw new Error("No Socket.io server was created");
|
|
67
|
-
}
|
|
68
|
-
return io;
|
|
69
|
-
};
|
|
70
|
-
|
|
71
|
-
const getHandler = (event: string): Handler => {
|
|
72
|
-
const handler = lastIo().handlers.get(event);
|
|
73
|
-
if (!handler) {
|
|
74
|
-
throw new Error(`No handler registered for ${event}`);
|
|
75
|
-
}
|
|
76
|
-
return handler;
|
|
77
|
-
};
|
|
78
|
-
|
|
79
|
-
const fakeServer = {} as http.Server;
|
|
80
|
-
|
|
81
|
-
const createConnectionSocket = (throwOnOn = false): Record<string, unknown> => {
|
|
82
|
-
const listeners = new Map<string, Handler>();
|
|
83
|
-
return {
|
|
84
|
-
decodedToken: {admin: false, id: "user-42"},
|
|
85
|
-
emit: (): void => {},
|
|
86
|
-
id: "socket-1",
|
|
87
|
-
join: async (): Promise<void> => {},
|
|
88
|
-
leave: async (): Promise<void> => {},
|
|
89
|
-
on: (event: string, handler: Handler): void => {
|
|
90
|
-
if (throwOnOn) {
|
|
91
|
-
throw new Error("boom");
|
|
92
|
-
}
|
|
93
|
-
listeners.set(event, handler);
|
|
94
|
-
},
|
|
95
|
-
};
|
|
96
|
-
};
|
|
97
|
-
|
|
98
|
-
describe("RealtimeApp.onServerCreated", () => {
|
|
99
|
-
beforeEach(() => {
|
|
100
|
-
ios = [];
|
|
101
|
-
watcherStarts = 0;
|
|
102
|
-
});
|
|
103
|
-
|
|
104
|
-
afterEach(() => {
|
|
105
|
-
delete process.env.TOKEN_SECRET;
|
|
106
|
-
});
|
|
107
|
-
|
|
108
|
-
it("wires up auth middleware, connection handlers, and the change-stream watcher", () => {
|
|
109
|
-
const app = new RealtimeApp({debug: true, tokenSecret: "test-secret"});
|
|
110
|
-
app.onServerCreated(fakeServer);
|
|
111
|
-
|
|
112
|
-
const io = lastIo();
|
|
113
|
-
expect(io.middleware.length).toBe(1);
|
|
114
|
-
expect(io.handlers.has("connection")).toBe(true);
|
|
115
|
-
expect(io.handlers.has("connect_error")).toBe(true);
|
|
116
|
-
expect(watcherStarts).toBe(1);
|
|
117
|
-
expect(app.getIo()).not.toBeNull();
|
|
118
|
-
});
|
|
119
|
-
|
|
120
|
-
it("installs socket handlers for each new connection", () => {
|
|
121
|
-
const app = new RealtimeApp({tokenSecret: "test-secret"});
|
|
122
|
-
app.onServerCreated(fakeServer);
|
|
123
|
-
|
|
124
|
-
const connectionHandler = getHandler("connection");
|
|
125
|
-
const socket = createConnectionSocket();
|
|
126
|
-
// Should run installRealtimeSocketHandlers without throwing.
|
|
127
|
-
expect(() => connectionHandler(socket)).not.toThrow();
|
|
128
|
-
});
|
|
129
|
-
|
|
130
|
-
it("captures errors thrown while handling a connection", () => {
|
|
131
|
-
const app = new RealtimeApp({tokenSecret: "test-secret"});
|
|
132
|
-
app.onServerCreated(fakeServer);
|
|
133
|
-
|
|
134
|
-
const connectionHandler = getHandler("connection");
|
|
135
|
-
const brokenSocket = createConnectionSocket(true);
|
|
136
|
-
// The handler swallows the error rather than crashing the server.
|
|
137
|
-
expect(() => connectionHandler(brokenSocket)).not.toThrow();
|
|
138
|
-
});
|
|
139
|
-
|
|
140
|
-
it("logs connect_error events without throwing", () => {
|
|
141
|
-
const app = new RealtimeApp({tokenSecret: "test-secret"});
|
|
142
|
-
app.onServerCreated(fakeServer);
|
|
143
|
-
|
|
144
|
-
const errorHandler = getHandler("connect_error");
|
|
145
|
-
expect(() => errorHandler(new Error("handshake failed"))).not.toThrow();
|
|
146
|
-
});
|
|
147
|
-
|
|
148
|
-
it("reads the token secret from the environment when not provided in config", () => {
|
|
149
|
-
process.env.TOKEN_SECRET = "env-secret";
|
|
150
|
-
const app = new RealtimeApp();
|
|
151
|
-
app.onServerCreated(fakeServer);
|
|
152
|
-
|
|
153
|
-
expect(lastIo().handlers.has("connection")).toBe(true);
|
|
154
|
-
});
|
|
155
|
-
|
|
156
|
-
it("throws when no token secret is available", () => {
|
|
157
|
-
delete process.env.TOKEN_SECRET;
|
|
158
|
-
const app = new RealtimeApp();
|
|
159
|
-
expect(() => app.onServerCreated(fakeServer)).toThrow(/TOKEN_SECRET is required/);
|
|
160
|
-
});
|
|
161
|
-
});
|
|
File without changes
|