@terreno/api 57.3.0 → 57.4.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/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
- package/README.md +6 -0
- package/dist/adminTypes.d.ts +7 -0
- package/dist/adminTypes.js +6 -1
- package/dist/api.d.ts +10 -0
- package/dist/api.js +99 -36
- package/dist/audit/auditApp.d.ts +30 -0
- package/dist/audit/auditApp.js +155 -0
- package/dist/audit/auditEventModel.d.ts +29 -0
- package/dist/audit/auditEventModel.js +102 -0
- package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
- package/dist/audit/cloudTasksEnqueue.js +162 -0
- package/dist/audit/diff.d.ts +10 -0
- package/dist/audit/diff.js +230 -0
- package/dist/audit/processQueue.d.ts +6 -0
- package/dist/audit/processQueue.js +101 -0
- package/dist/audit/rbacSink.d.ts +2 -0
- package/dist/audit/rbacSink.js +82 -0
- package/dist/audit/record.d.ts +56 -0
- package/dist/audit/record.js +373 -0
- package/dist/betterAuth.d.ts +6 -0
- package/dist/betterAuthSetup.js +1 -1
- package/dist/collectionRegistry.d.ts +3 -1
- package/dist/collectionRegistry.js +25 -0
- package/dist/index.d.ts +26 -1
- package/dist/index.js +48 -2
- package/dist/mcp/query.d.ts +0 -13
- package/dist/mcp/query.js +8 -8
- package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
- package/dist/migrations/generate.d.ts +17 -0
- package/dist/migrations/generate.js +277 -0
- package/dist/migrations/load.d.ts +20 -0
- package/dist/migrations/load.js +236 -0
- package/dist/migrations/lock.d.ts +13 -0
- package/dist/migrations/lock.js +145 -0
- package/dist/migrations/runner.d.ts +42 -0
- package/dist/migrations/runner.js +503 -0
- package/dist/migrations/schemaCatalog.d.ts +44 -0
- package/dist/migrations/schemaCatalog.js +326 -0
- package/dist/migrations/types.d.ts +87 -0
- package/dist/migrations/types.js +7 -0
- package/dist/models/notification.d.ts +2 -0
- package/dist/models/notification.js +62 -0
- package/dist/models/notificationPreference.d.ts +2 -0
- package/dist/models/notificationPreference.js +49 -0
- package/dist/notifications/notificationService.d.ts +40 -0
- package/dist/notifications/notificationService.js +323 -0
- package/dist/notifications/notificationsApp.d.ts +18 -0
- package/dist/notifications/notificationsApp.js +250 -0
- package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
- package/dist/notifications/notificationsBeforeSend.js +77 -0
- package/dist/openApi.d.ts +1 -7
- package/dist/openApi.js +7 -6
- package/dist/openApiBuilder.d.ts +14 -3
- package/dist/openApiValidator.d.ts +13 -1
- package/dist/openApiValidator.js +200 -36
- package/dist/orgs/orgContext.d.ts +23 -0
- package/dist/orgs/orgContext.js +198 -0
- package/dist/orgs/orgPermissions.d.ts +4 -0
- package/dist/orgs/orgPermissions.js +77 -0
- package/dist/orgs/orgPlugin.d.ts +13 -0
- package/dist/orgs/orgPlugin.js +84 -0
- package/dist/orgs/organizationModel.d.ts +13 -0
- package/dist/orgs/organizationModel.js +301 -0
- package/dist/orgs/organizationSettings.d.ts +19 -0
- package/dist/orgs/organizationSettings.js +120 -0
- package/dist/orgs/orgsApp.d.ts +28 -0
- package/dist/orgs/orgsApp.js +678 -0
- package/dist/permissions.d.ts +7 -13
- package/dist/permissions.js +8 -31
- package/dist/rateLimit/middleware.d.ts +0 -8
- package/dist/rateLimit/middleware.js +2 -3
- package/dist/rateLimit/mongoStore.d.ts +1 -0
- package/dist/rateLimit/mongoStore.js +1 -0
- package/dist/rateLimit/policies.d.ts +0 -4
- package/dist/rateLimit/policies.js +5 -7
- package/dist/rateLimit/redisStore.d.ts +1 -0
- package/dist/rateLimit/redisStore.js +1 -0
- package/dist/rbac/access.js +30 -13
- package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
- package/dist/rbac/membershipOrgAdminSource.js +122 -0
- package/dist/rbac/modelRouterAccess.d.ts +3 -0
- package/dist/rbac/modelRouterAccess.js +3 -0
- package/dist/rbac/resolve.js +60 -31
- package/dist/rbac/roleModel.d.ts +2 -5
- package/dist/rbac/roleModel.js +18 -4
- package/dist/rbac/statements.d.ts +10 -1
- package/dist/rbac/statements.js +19 -2
- package/dist/rbac/types.d.ts +5 -0
- package/dist/realtime/changeStreamWatcher.d.ts +10 -4
- package/dist/realtime/changeStreamWatcher.js +110 -64
- package/dist/realtime/deprecation.d.ts +1 -0
- package/dist/realtime/deprecation.js +1 -0
- package/dist/realtime/realtimeApp.d.ts +1 -0
- package/dist/realtime/realtimeApp.js +1 -0
- package/dist/schemaMetadata.js +16 -5
- package/dist/sync/adminBroadcastScope.d.ts +40 -0
- package/dist/sync/adminBroadcastScope.js +194 -0
- package/dist/sync/adminWindowAccess.d.ts +13 -0
- package/dist/sync/adminWindowAccess.js +96 -0
- package/dist/sync/adminWindowMutation.d.ts +88 -0
- package/dist/sync/adminWindowMutation.js +247 -0
- package/dist/sync/executors.d.ts +9 -3
- package/dist/sync/executors.js +190 -159
- package/dist/sync/mutationHandler.d.ts +5 -2
- package/dist/sync/mutationHandler.js +191 -71
- package/dist/sync/registry.js +4 -0
- package/dist/sync/routes.d.ts +13 -0
- package/dist/sync/routes.js +113 -56
- package/dist/sync/socketHandlers.d.ts +8 -2
- package/dist/sync/socketHandlers.js +144 -50
- package/dist/sync/streams.d.ts +2 -0
- package/dist/sync/streams.js +7 -1
- package/dist/sync/syncApp.d.ts +2 -1
- package/dist/sync/syncApp.js +2 -1
- package/dist/sync/syncBatch.d.ts +5 -2
- package/dist/sync/syncBatch.js +4 -4
- package/dist/sync/types.d.ts +18 -0
- package/dist/terrenoApp.d.ts +29 -0
- package/dist/terrenoApp.js +91 -54
- package/dist/tests/createTestData.d.ts +1 -3
- package/dist/tests/createTestData.js +3 -5
- package/dist/tests/models.d.ts +1 -0
- package/dist/tests/models.js +9 -2
- package/dist/tests/testHelper.d.ts +0 -5
- package/dist/tests/testHelper.js +2 -9
- package/dist/types/authToken.d.ts +3 -3
- package/dist/types/mcpServiceToken.d.ts +2 -2
- package/dist/types/membership.d.ts +23 -0
- package/dist/types/membership.js +2 -0
- package/dist/types/notification.d.ts +28 -0
- package/dist/types/notification.js +2 -0
- package/dist/types/notificationPreference.d.ts +20 -0
- package/dist/types/notificationPreference.js +2 -0
- package/dist/types/organization.d.ts +36 -0
- package/dist/types/organization.js +2 -0
- package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
- package/dist/webhooks/idempotency/webhookReceipt.js +7 -7
- package/dist/webhooks/rawBody.d.ts +1 -0
- package/dist/webhooks/rawBody.js +1 -0
- package/package.json +31 -25
- package/src/__snapshots__/openApi.test.ts.snap +192 -54
- package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
- package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
- package/src/adminTypes.ts +8 -0
- package/src/api.test.ts +39 -2
- package/src/api.ts +68 -0
- package/src/audit/auditApp.test.ts +243 -0
- package/src/audit/auditApp.ts +139 -0
- package/src/audit/auditEventModel.ts +156 -0
- package/src/audit/auditRouter.test.ts +456 -0
- package/src/audit/cloudTasksEnqueue.test.ts +124 -0
- package/src/audit/cloudTasksEnqueue.ts +104 -0
- package/src/audit/diff.ts +163 -0
- package/src/audit/processQueue.ts +69 -0
- package/src/audit/rbacSink.test.ts +86 -0
- package/src/audit/rbacSink.ts +42 -0
- package/src/audit/record.test.ts +402 -0
- package/src/audit/record.ts +328 -0
- package/src/auth.test.ts +1 -1
- package/src/betterAuth.ts +7 -0
- package/src/betterAuthSetup.test.ts +27 -0
- package/src/betterAuthSetup.ts +1 -0
- package/src/collectionRegistry.test.ts +8 -9
- package/src/collectionRegistry.ts +21 -1
- package/src/express.d.ts +2 -0
- package/src/expressServer.test.ts +50 -2
- package/src/index.ts +69 -0
- package/src/mcp/handlers.test.ts +275 -0
- package/src/mcp/query.ts +3 -3
- package/src/mcp/toolGenerator.test.ts +81 -0
- package/src/migrations/cli.test.ts +376 -0
- package/src/migrations/cli.ts +283 -0
- package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
- package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
- package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
- package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
- package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
- package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
- package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
- package/src/migrations/generate.test.ts +333 -0
- package/src/migrations/generate.ts +216 -0
- package/src/migrations/load.test.ts +103 -0
- package/src/migrations/load.ts +124 -0
- package/src/migrations/lock.test.ts +133 -0
- package/src/migrations/lock.ts +118 -0
- package/src/migrations/runner.test.ts +504 -0
- package/src/migrations/runner.ts +358 -0
- package/src/migrations/schemaCatalog.test.ts +159 -0
- package/src/migrations/schemaCatalog.ts +262 -0
- package/src/migrations/types.ts +94 -0
- package/src/models/notification.ts +68 -0
- package/src/models/notificationPreference.ts +62 -0
- package/src/notifications/notificationService.ts +254 -0
- package/src/notifications/notificationsApp.test.ts +505 -0
- package/src/notifications/notificationsApp.ts +200 -0
- package/src/notifications/notificationsBeforeSend.ts +51 -0
- package/src/openApi.test.ts +0 -1
- package/src/openApi.ts +2 -1
- package/src/openApiBuilder.ts +14 -3
- package/src/openApiValidator.test.ts +221 -2
- package/src/openApiValidator.ts +218 -33
- package/src/orgs/orgAccessOptIn.test.ts +87 -0
- package/src/orgs/orgContext.test.ts +259 -0
- package/src/orgs/orgContext.ts +151 -0
- package/src/orgs/orgPermissions.test.ts +105 -0
- package/src/orgs/orgPermissions.ts +40 -0
- package/src/orgs/orgPlugin.test.ts +130 -0
- package/src/orgs/orgPlugin.ts +70 -0
- package/src/orgs/orgRbac.test.ts +267 -0
- package/src/orgs/orgSecurityDefects.test.ts +415 -0
- package/src/orgs/organizationModel.test.ts +205 -0
- package/src/orgs/organizationModel.ts +257 -0
- package/src/orgs/organizationSettings.test.ts +113 -0
- package/src/orgs/organizationSettings.ts +126 -0
- package/src/orgs/orgsApp.test.ts +382 -0
- package/src/orgs/orgsApp.ts +563 -0
- package/src/permissions.test.ts +62 -36
- package/src/permissions.ts +8 -30
- package/src/rateLimit/middleware.ts +1 -1
- package/src/rateLimit/mongoStore.ts +1 -0
- package/src/rateLimit/policies.ts +2 -2
- package/src/rateLimit/redisStore.ts +1 -0
- package/src/rbac/access.ts +11 -3
- package/src/rbac/membershipOrgAdminSource.ts +59 -0
- package/src/rbac/modelRouterAccess.ts +3 -0
- package/src/rbac/permissionUtils.test.ts +26 -5
- package/src/rbac/resolve.test.ts +34 -2
- package/src/rbac/resolve.ts +26 -7
- package/src/rbac/roleModel.test.ts +34 -1
- package/src/rbac/roleModel.ts +17 -1
- package/src/rbac/statements.test.ts +19 -0
- package/src/rbac/statements.ts +19 -1
- package/src/rbac/types.ts +5 -0
- package/src/realtime/changeStreamWatcher.ts +73 -33
- package/src/realtime/deprecation.ts +1 -0
- package/src/realtime/realtime.test.ts +357 -185
- package/src/realtime/realtimeApp.ts +1 -0
- package/src/schemaMetadata.test.ts +14 -0
- package/src/schemaMetadata.ts +5 -5
- package/src/sync/adminBroadcastConfig.test.ts +96 -0
- package/src/sync/adminBroadcastScope.test.ts +155 -0
- package/src/sync/adminBroadcastScope.ts +123 -0
- package/src/sync/adminWindowAccess.test.ts +57 -0
- package/src/sync/adminWindowAccess.ts +32 -0
- package/src/sync/adminWindowMutation.test.ts +450 -0
- package/src/sync/adminWindowMutation.ts +283 -0
- package/src/sync/executors.ts +33 -6
- package/src/sync/mutationHandler.test.ts +277 -1
- package/src/sync/mutationHandler.ts +171 -29
- package/src/sync/registry.ts +4 -0
- package/src/sync/routes.ts +52 -8
- package/src/sync/socketHandlers.ts +154 -58
- package/src/sync/streams.ts +6 -0
- package/src/sync/sync.test.ts +3 -2
- package/src/sync/syncApp.ts +2 -1
- package/src/sync/syncBatch.ts +7 -2
- package/src/sync/syncRoutes.test.ts +297 -3
- package/src/sync/syncSocket.test.ts +229 -0
- package/src/sync/types.ts +20 -0
- package/src/terrenoApp.migrations.test.ts +114 -0
- package/src/terrenoApp.test.ts +41 -0
- package/src/terrenoApp.ts +94 -31
- package/src/tests/createTestData.ts +2 -2
- package/src/tests/models.ts +10 -2
- package/src/tests/testHelper.ts +1 -7
- package/src/types/authToken.ts +2 -4
- package/src/types/mcpServiceToken.ts +1 -7
- package/src/types/membership.ts +48 -0
- package/src/types/notification.ts +34 -0
- package/src/types/notificationPreference.ts +28 -0
- package/src/types/organization.ts +49 -0
- package/src/webhooks/idempotency/webhookReceipt.ts +4 -7
- package/src/webhooks/rawBody.test.ts +33 -0
- package/src/webhooks/rawBody.ts +1 -0
- package/tsconfig.json +1 -1
- package/tsconfig.typedoc.json +2 -1
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
- package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
|
@@ -0,0 +1,456 @@
|
|
|
1
|
+
import {afterEach, beforeEach, describe, it, spyOn} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
import type express from "express";
|
|
4
|
+
import mongoose from "mongoose";
|
|
5
|
+
|
|
6
|
+
import {modelRouter} from "../api";
|
|
7
|
+
import type {UserModel as AuthUserModel} from "../auth";
|
|
8
|
+
import {logger} from "../logger";
|
|
9
|
+
import {Permissions} from "../permissions";
|
|
10
|
+
import {createdUpdatedPlugin, findExactlyOne, findOneOrNone} from "../plugins";
|
|
11
|
+
import {TerrenoApp} from "../terrenoApp";
|
|
12
|
+
import {authAsUser, setupDb, UserModel} from "../tests";
|
|
13
|
+
import {AuditApp} from "./auditApp";
|
|
14
|
+
import {createAuditEventModel} from "./auditEventModel";
|
|
15
|
+
import {changedFieldDiff} from "./diff";
|
|
16
|
+
import {
|
|
17
|
+
flushAuditRecorderForTests,
|
|
18
|
+
maybeRecordAdminAudit,
|
|
19
|
+
maybeRecordModelRouterAudit,
|
|
20
|
+
resetAuditRecorderForTests,
|
|
21
|
+
} from "./record";
|
|
22
|
+
|
|
23
|
+
const typedUserModel = UserModel as unknown as AuthUserModel;
|
|
24
|
+
|
|
25
|
+
interface Note {
|
|
26
|
+
calories?: number;
|
|
27
|
+
organizationId?: string;
|
|
28
|
+
password?: string;
|
|
29
|
+
ssn?: string;
|
|
30
|
+
tags?: string[];
|
|
31
|
+
title: string;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
const noteSchema = new mongoose.Schema<Note>(
|
|
35
|
+
{
|
|
36
|
+
calories: {description: "Calories", type: Number},
|
|
37
|
+
organizationId: {description: "Tenant organization id", type: String},
|
|
38
|
+
password: {description: "Secret password", type: String},
|
|
39
|
+
ssn: {description: "Social security number", type: String},
|
|
40
|
+
tags: {description: "Tags", type: [String]},
|
|
41
|
+
title: {description: "Note title", required: true, type: String},
|
|
42
|
+
},
|
|
43
|
+
{strict: "throw"}
|
|
44
|
+
);
|
|
45
|
+
noteSchema.plugin(createdUpdatedPlugin);
|
|
46
|
+
noteSchema.plugin(findOneOrNone);
|
|
47
|
+
noteSchema.plugin(findExactlyOne);
|
|
48
|
+
|
|
49
|
+
const deleteNamedModel = (name: string): void => {
|
|
50
|
+
if (mongoose.connection.models[name]) {
|
|
51
|
+
mongoose.connection.deleteModel(name);
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
const notePermissions = {
|
|
56
|
+
create: [Permissions.IsAuthenticated],
|
|
57
|
+
delete: [Permissions.IsAuthenticated],
|
|
58
|
+
list: [Permissions.IsAuthenticated],
|
|
59
|
+
read: [Permissions.IsAuthenticated],
|
|
60
|
+
update: [Permissions.IsAuthenticated],
|
|
61
|
+
};
|
|
62
|
+
|
|
63
|
+
const buildApp = (audit: true | {redact: string[]} = true): express.Application => {
|
|
64
|
+
const NoteModel = mongoose.model<Note>("Note", noteSchema);
|
|
65
|
+
const app = new TerrenoApp({
|
|
66
|
+
skipListen: true,
|
|
67
|
+
userModel: typedUserModel,
|
|
68
|
+
})
|
|
69
|
+
.register(new AuditApp())
|
|
70
|
+
.build();
|
|
71
|
+
app.use("/notes", modelRouter(NoteModel, {audit, permissions: notePermissions}));
|
|
72
|
+
return app;
|
|
73
|
+
};
|
|
74
|
+
|
|
75
|
+
describe("changedFieldDiff", () => {
|
|
76
|
+
it("redacts default secret segments case-insensitively", () => {
|
|
77
|
+
const diff = changedFieldDiff({
|
|
78
|
+
after: {password: "secret", title: "Hi", token: "abc"},
|
|
79
|
+
before: {password: "old", title: "Lo", token: "xyz"},
|
|
80
|
+
});
|
|
81
|
+
assert.deepEqual(diff, {after: {title: "Hi"}, before: {title: "Lo"}});
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
it("omits extra redact fields", () => {
|
|
85
|
+
const diff = changedFieldDiff({
|
|
86
|
+
after: {ssn: "999", title: "B"},
|
|
87
|
+
before: {ssn: "111", title: "A"},
|
|
88
|
+
extraRedact: ["ssn"],
|
|
89
|
+
});
|
|
90
|
+
assert.deepEqual(diff, {after: {title: "B"}, before: {title: "A"}});
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
it("redacts secret keys nested in objects and arrays", () => {
|
|
94
|
+
const diff = changedFieldDiff({
|
|
95
|
+
after: {
|
|
96
|
+
items: [{password: "x", title: "ok"}],
|
|
97
|
+
settings: {auth: {mode: "a", token: "t"}},
|
|
98
|
+
},
|
|
99
|
+
before: {
|
|
100
|
+
items: [{password: "y", title: "old"}],
|
|
101
|
+
settings: {auth: {mode: "b", token: "u"}},
|
|
102
|
+
},
|
|
103
|
+
});
|
|
104
|
+
assert.deepEqual(diff.after, {
|
|
105
|
+
items: [{title: "ok"}],
|
|
106
|
+
settings: {auth: {mode: "a"}},
|
|
107
|
+
});
|
|
108
|
+
assert.deepEqual(diff.before, {
|
|
109
|
+
items: [{title: "old"}],
|
|
110
|
+
settings: {auth: {mode: "b"}},
|
|
111
|
+
});
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
it("redacts compound secret keys such as tokenHash", () => {
|
|
115
|
+
const diff = changedFieldDiff({
|
|
116
|
+
after: {title: "New", tokenHash: "abc"},
|
|
117
|
+
before: {title: "Old", tokenHash: "xyz"},
|
|
118
|
+
});
|
|
119
|
+
assert.deepEqual(diff, {after: {title: "New"}, before: {title: "Old"}});
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
it("does not treat extra redact names as substrings", () => {
|
|
123
|
+
const diff = changedFieldDiff({
|
|
124
|
+
after: {lesson: "keep", ssn: "999"},
|
|
125
|
+
extraRedact: ["ssn"],
|
|
126
|
+
});
|
|
127
|
+
assert.equal(diff.after?.lesson, "keep");
|
|
128
|
+
assert.isUndefined(diff.after?.ssn);
|
|
129
|
+
});
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
describe("modelRouter audit", () => {
|
|
133
|
+
beforeEach(async () => {
|
|
134
|
+
resetAuditRecorderForTests();
|
|
135
|
+
deleteNamedModel("Note");
|
|
136
|
+
deleteNamedModel("AuditEvent");
|
|
137
|
+
await setupDb();
|
|
138
|
+
await mongoose.connection.collection("auditevents").deleteMany({});
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
afterEach(() => {
|
|
142
|
+
resetAuditRecorderForTests();
|
|
143
|
+
deleteNamedModel("Note");
|
|
144
|
+
deleteNamedModel("AuditEvent");
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
it("writes a create event with after only and strips secrets", async () => {
|
|
148
|
+
const app = buildApp();
|
|
149
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
150
|
+
const created = await agent
|
|
151
|
+
.post("/notes")
|
|
152
|
+
.send({password: "hunter2", title: "Hello"})
|
|
153
|
+
.expect(201);
|
|
154
|
+
await flushAuditRecorderForTests();
|
|
155
|
+
const admin = await authAsUser(app, "admin");
|
|
156
|
+
const list = await admin.get("/audit-events").expect(200);
|
|
157
|
+
assert.equal(list.body.data.length, 1);
|
|
158
|
+
const event = list.body.data[0];
|
|
159
|
+
assert.equal(event.verb, "created");
|
|
160
|
+
assert.equal(event.operation, "create");
|
|
161
|
+
assert.equal(event.source, "modelRouter");
|
|
162
|
+
assert.equal(event.modelName, "Note");
|
|
163
|
+
assert.equal(event.recordId, created.body.data._id);
|
|
164
|
+
assert.equal(event.recordLabel, "Hello");
|
|
165
|
+
assert.equal(event.after.title, "Hello");
|
|
166
|
+
assert.isUndefined(event.before);
|
|
167
|
+
assert.isUndefined(event.after.password);
|
|
168
|
+
assert.isUndefined(event.organizationId);
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
it("PATCH title yields one event with before.title and after.title", async () => {
|
|
172
|
+
const app = buildApp();
|
|
173
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
174
|
+
const created = await agent.post("/notes").send({calories: 1, title: "One"}).expect(201);
|
|
175
|
+
await agent.patch(`/notes/${created.body.data._id}`).send({title: "Two"}).expect(200);
|
|
176
|
+
await flushAuditRecorderForTests();
|
|
177
|
+
const admin = await authAsUser(app, "admin");
|
|
178
|
+
const list = await admin.get("/audit-events?verb=updated").expect(200);
|
|
179
|
+
assert.equal(list.body.data.length, 1);
|
|
180
|
+
const event = list.body.data[0];
|
|
181
|
+
assert.equal(event.before.title, "One");
|
|
182
|
+
assert.equal(event.after.title, "Two");
|
|
183
|
+
assert.isUndefined(event.before.calories);
|
|
184
|
+
assert.isUndefined(event.after.calories);
|
|
185
|
+
});
|
|
186
|
+
|
|
187
|
+
it("strips ssn when redact includes ssn", async () => {
|
|
188
|
+
const app = buildApp({redact: ["ssn"]});
|
|
189
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
190
|
+
await agent.post("/notes").send({ssn: "123-45-6789", title: "Pii"}).expect(201);
|
|
191
|
+
await flushAuditRecorderForTests();
|
|
192
|
+
const admin = await authAsUser(app, "admin");
|
|
193
|
+
const list = await admin.get("/audit-events").expect(200);
|
|
194
|
+
assert.isUndefined(list.body.data[0].after.ssn);
|
|
195
|
+
assert.equal(list.body.data[0].after.title, "Pii");
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
it("delete has before only", async () => {
|
|
199
|
+
const app = buildApp();
|
|
200
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
201
|
+
const created = await agent.post("/notes").send({title: "Gone"}).expect(201);
|
|
202
|
+
await agent.delete(`/notes/${created.body.data._id}`).expect(204);
|
|
203
|
+
await flushAuditRecorderForTests();
|
|
204
|
+
const admin = await authAsUser(app, "admin");
|
|
205
|
+
const list = await admin.get("/audit-events?verb=deleted").expect(200);
|
|
206
|
+
assert.equal(list.body.data.length, 1);
|
|
207
|
+
assert.equal(list.body.data[0].before.title, "Gone");
|
|
208
|
+
assert.isUndefined(list.body.data[0].after);
|
|
209
|
+
});
|
|
210
|
+
|
|
211
|
+
it("still returns 201 when the recorder throws", async () => {
|
|
212
|
+
const app = buildApp();
|
|
213
|
+
const model = createAuditEventModel(mongoose.connection);
|
|
214
|
+
const createSpy = spyOn(model, "create").mockImplementation(() => {
|
|
215
|
+
throw new Error("disk full");
|
|
216
|
+
});
|
|
217
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
218
|
+
await agent.post("/notes").send({title: "Keep"}).expect(201);
|
|
219
|
+
await flushAuditRecorderForTests();
|
|
220
|
+
createSpy.mockRestore();
|
|
221
|
+
});
|
|
222
|
+
|
|
223
|
+
it("skips writes and logs once when AuditApp is omitted", async () => {
|
|
224
|
+
const errorSpy = spyOn(logger, "error").mockImplementation(() => logger);
|
|
225
|
+
const NoteModel = mongoose.model<Note>("Note", noteSchema);
|
|
226
|
+
const app = new TerrenoApp({
|
|
227
|
+
skipListen: true,
|
|
228
|
+
userModel: typedUserModel,
|
|
229
|
+
}).build();
|
|
230
|
+
app.use("/notes", modelRouter(NoteModel, {audit: true, permissions: notePermissions}));
|
|
231
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
232
|
+
await agent.post("/notes").send({title: "A"}).expect(201);
|
|
233
|
+
await agent.post("/notes").send({title: "B"}).expect(201);
|
|
234
|
+
await flushAuditRecorderForTests();
|
|
235
|
+
assert.isUndefined(mongoose.connection.models.AuditEvent);
|
|
236
|
+
const auditLogs = errorSpy.mock.calls.filter((call) =>
|
|
237
|
+
String(call[0]).includes("requires AuditApp")
|
|
238
|
+
);
|
|
239
|
+
assert.equal(auditLogs.length, 1);
|
|
240
|
+
errorSpy.mockRestore();
|
|
241
|
+
});
|
|
242
|
+
|
|
243
|
+
it("never writes an event for AuditEvent itself", async () => {
|
|
244
|
+
const app = new TerrenoApp({skipListen: true, userModel: typedUserModel})
|
|
245
|
+
.register(new AuditApp())
|
|
246
|
+
.build();
|
|
247
|
+
const model = createAuditEventModel(mongoose.connection);
|
|
248
|
+
const beforeCount = await model.countDocuments();
|
|
249
|
+
await maybeRecordModelRouterAudit({
|
|
250
|
+
after: {modelName: "Todo"},
|
|
251
|
+
audit: true,
|
|
252
|
+
modelName: "AuditEvent",
|
|
253
|
+
operation: "create",
|
|
254
|
+
recordId: "1",
|
|
255
|
+
req: {user: {id: new mongoose.Types.ObjectId().toString()}} as never,
|
|
256
|
+
verb: "created",
|
|
257
|
+
});
|
|
258
|
+
assert.equal(await model.countDocuments(), beforeCount);
|
|
259
|
+
const admin = await authAsUser(app, "admin");
|
|
260
|
+
const list = await admin.get("/audit-events").expect(200);
|
|
261
|
+
assert.equal(list.body.data.length, 0);
|
|
262
|
+
});
|
|
263
|
+
|
|
264
|
+
it("array push/update/remove each write one updated event with recordId", async () => {
|
|
265
|
+
const app = buildApp();
|
|
266
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
267
|
+
const created = await agent
|
|
268
|
+
.post("/notes")
|
|
269
|
+
.send({tags: ["a"], title: "Tagged"})
|
|
270
|
+
.expect(201);
|
|
271
|
+
const id = created.body.data._id;
|
|
272
|
+
|
|
273
|
+
await agent.post(`/notes/${id}/tags`).send({tags: "b"}).expect(200);
|
|
274
|
+
await agent.patch(`/notes/${id}/tags/a`).send({tags: "alpha"}).expect(200);
|
|
275
|
+
await agent.delete(`/notes/${id}/tags/b`).expect(200);
|
|
276
|
+
await flushAuditRecorderForTests();
|
|
277
|
+
|
|
278
|
+
const admin = await authAsUser(app, "admin");
|
|
279
|
+
const list = await admin.get("/audit-events").expect(200);
|
|
280
|
+
const events = list.body.data.filter((row: {verb: string}) => row.verb === "updated");
|
|
281
|
+
assert.equal(events.length, 3);
|
|
282
|
+
const operations = events.map((row: {operation: string}) => row.operation).sort();
|
|
283
|
+
assert.deepEqual(operations, ["arrayPush", "arrayRemove", "arrayUpdate"].sort());
|
|
284
|
+
for (const event of events) {
|
|
285
|
+
assert.equal(event.recordId, id);
|
|
286
|
+
assert.equal(event.source, "modelRouter");
|
|
287
|
+
}
|
|
288
|
+
});
|
|
289
|
+
|
|
290
|
+
it("copies organizationId from the document", async () => {
|
|
291
|
+
const app = buildApp();
|
|
292
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
293
|
+
await agent.post("/notes").send({organizationId: "org-doc", title: "Tenant"}).expect(201);
|
|
294
|
+
await flushAuditRecorderForTests();
|
|
295
|
+
const admin = await authAsUser(app, "admin");
|
|
296
|
+
const list = await admin.get("/audit-events").expect(200);
|
|
297
|
+
assert.equal(list.body.data[0].organizationId, "org-doc");
|
|
298
|
+
});
|
|
299
|
+
|
|
300
|
+
it("prefers req.organization over the document field", async () => {
|
|
301
|
+
const NoteModel = mongoose.model<Note>("Note", noteSchema);
|
|
302
|
+
const app = new TerrenoApp({
|
|
303
|
+
skipListen: true,
|
|
304
|
+
userModel: typedUserModel,
|
|
305
|
+
})
|
|
306
|
+
.register(new AuditApp())
|
|
307
|
+
.build();
|
|
308
|
+
app.use((req, _res, next) => {
|
|
309
|
+
(req as express.Request & {organization?: {id: string}}).organization = {id: "org-req"};
|
|
310
|
+
next();
|
|
311
|
+
});
|
|
312
|
+
app.use("/notes", modelRouter(NoteModel, {audit: true, permissions: notePermissions}));
|
|
313
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
314
|
+
await agent.post("/notes").send({organizationId: "org-doc", title: "Both"}).expect(201);
|
|
315
|
+
await flushAuditRecorderForTests();
|
|
316
|
+
const admin = await authAsUser(app, "admin");
|
|
317
|
+
const list = await admin.get("/audit-events").expect(200);
|
|
318
|
+
assert.equal(list.body.data[0].organizationId, "org-req");
|
|
319
|
+
});
|
|
320
|
+
|
|
321
|
+
it("still updates when toJSON throws before the audit snapshot", async () => {
|
|
322
|
+
const throwSchema = new mongoose.Schema<{title: string}>(
|
|
323
|
+
{title: {description: "Title", required: true, type: String}},
|
|
324
|
+
{strict: "throw"}
|
|
325
|
+
);
|
|
326
|
+
throwSchema.plugin(createdUpdatedPlugin);
|
|
327
|
+
throwSchema.plugin(findOneOrNone);
|
|
328
|
+
throwSchema.plugin(findExactlyOne);
|
|
329
|
+
let shouldThrow = false;
|
|
330
|
+
throwSchema.set("toJSON", {
|
|
331
|
+
transform: (_doc, ret) => {
|
|
332
|
+
if (shouldThrow) {
|
|
333
|
+
throw new Error("circular");
|
|
334
|
+
}
|
|
335
|
+
return ret;
|
|
336
|
+
},
|
|
337
|
+
virtuals: true,
|
|
338
|
+
});
|
|
339
|
+
deleteNamedModel("ThrowNote");
|
|
340
|
+
const ThrowNote = mongoose.model<{title: string}>("ThrowNote", throwSchema);
|
|
341
|
+
const app = new TerrenoApp({
|
|
342
|
+
skipListen: true,
|
|
343
|
+
userModel: typedUserModel,
|
|
344
|
+
})
|
|
345
|
+
.register(new AuditApp())
|
|
346
|
+
.build();
|
|
347
|
+
app.use("/throw-notes", modelRouter(ThrowNote, {audit: true, permissions: notePermissions}));
|
|
348
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
349
|
+
const created = await agent.post("/throw-notes").send({title: "Before"}).expect(201);
|
|
350
|
+
shouldThrow = true;
|
|
351
|
+
await agent.patch(`/throw-notes/${created.body.data._id}`).send({title: "After"});
|
|
352
|
+
const stored = await ThrowNote.findById(created.body.data._id).lean();
|
|
353
|
+
assert.equal(stored?.title, "After");
|
|
354
|
+
deleteNamedModel("ThrowNote");
|
|
355
|
+
});
|
|
356
|
+
|
|
357
|
+
it("returns 201 without waiting for enqueue to finish", async () => {
|
|
358
|
+
let release!: () => void;
|
|
359
|
+
const held = new Promise<void>((resolve) => {
|
|
360
|
+
release = resolve;
|
|
361
|
+
});
|
|
362
|
+
const queued: {modelName: string}[] = [];
|
|
363
|
+
const NoteModel = mongoose.model<Note>("Note", noteSchema);
|
|
364
|
+
const app = new TerrenoApp({
|
|
365
|
+
skipListen: true,
|
|
366
|
+
userModel: typedUserModel,
|
|
367
|
+
})
|
|
368
|
+
.register(
|
|
369
|
+
new AuditApp({
|
|
370
|
+
enqueue: async (write): Promise<void> => {
|
|
371
|
+
queued.push({modelName: write.modelName});
|
|
372
|
+
await held;
|
|
373
|
+
},
|
|
374
|
+
})
|
|
375
|
+
)
|
|
376
|
+
.build();
|
|
377
|
+
app.use("/notes", modelRouter(NoteModel, {audit: true, permissions: notePermissions}));
|
|
378
|
+
const agent = await authAsUser(app, "notAdmin");
|
|
379
|
+
await agent.post("/notes").send({title: "Async"}).expect(201);
|
|
380
|
+
assert.equal(queued.length, 1);
|
|
381
|
+
assert.equal(await mongoose.connection.collection("auditevents").countDocuments(), 0);
|
|
382
|
+
release();
|
|
383
|
+
await flushAuditRecorderForTests();
|
|
384
|
+
});
|
|
385
|
+
});
|
|
386
|
+
|
|
387
|
+
describe("maybeRecordAdminAudit", () => {
|
|
388
|
+
beforeEach(async () => {
|
|
389
|
+
deleteNamedModel("Note");
|
|
390
|
+
deleteNamedModel("AuditEvent");
|
|
391
|
+
resetAuditRecorderForTests();
|
|
392
|
+
await setupDb();
|
|
393
|
+
await mongoose.connection.collection("auditevents").deleteMany({});
|
|
394
|
+
});
|
|
395
|
+
|
|
396
|
+
afterEach(() => {
|
|
397
|
+
resetAuditRecorderForTests();
|
|
398
|
+
deleteNamedModel("Note");
|
|
399
|
+
deleteNamedModel("AuditEvent");
|
|
400
|
+
});
|
|
401
|
+
|
|
402
|
+
it("does not write when AuditApp is not registered", async () => {
|
|
403
|
+
await maybeRecordAdminAudit({
|
|
404
|
+
after: {_id: "1", name: "Nope"},
|
|
405
|
+
modelName: "Food",
|
|
406
|
+
req: {user: {_id: new mongoose.Types.ObjectId()}} as express.Request,
|
|
407
|
+
verb: "created",
|
|
408
|
+
});
|
|
409
|
+
const count = await mongoose.connection.collection("auditevents").countDocuments();
|
|
410
|
+
assert.equal(count, 0);
|
|
411
|
+
});
|
|
412
|
+
|
|
413
|
+
it("skips writing an event for the AuditEvent model", async () => {
|
|
414
|
+
const app = new TerrenoApp({
|
|
415
|
+
skipListen: true,
|
|
416
|
+
userModel: typedUserModel,
|
|
417
|
+
})
|
|
418
|
+
.register(new AuditApp())
|
|
419
|
+
.build();
|
|
420
|
+
assert.ok(app);
|
|
421
|
+
await maybeRecordAdminAudit({
|
|
422
|
+
after: {_id: "1", modelName: "Food"},
|
|
423
|
+
modelName: "AuditEvent",
|
|
424
|
+
req: {user: {_id: new mongoose.Types.ObjectId()}} as express.Request,
|
|
425
|
+
verb: "created",
|
|
426
|
+
});
|
|
427
|
+
const count = await mongoose.connection.collection("auditevents").countDocuments();
|
|
428
|
+
assert.equal(count, 0);
|
|
429
|
+
});
|
|
430
|
+
|
|
431
|
+
it("does not throw when toJSON fails after a mutation", async () => {
|
|
432
|
+
const app = new TerrenoApp({
|
|
433
|
+
skipListen: true,
|
|
434
|
+
userModel: typedUserModel,
|
|
435
|
+
})
|
|
436
|
+
.register(new AuditApp())
|
|
437
|
+
.build();
|
|
438
|
+
assert.ok(app);
|
|
439
|
+
const after = {
|
|
440
|
+
toJSON: (): never => {
|
|
441
|
+
throw new Error("circular");
|
|
442
|
+
},
|
|
443
|
+
};
|
|
444
|
+
await maybeRecordModelRouterAudit({
|
|
445
|
+
after,
|
|
446
|
+
audit: true,
|
|
447
|
+
modelName: "Note",
|
|
448
|
+
operation: "create",
|
|
449
|
+
recordId: "1",
|
|
450
|
+
req: {user: {_id: new mongoose.Types.ObjectId()}} as express.Request,
|
|
451
|
+
verb: "created",
|
|
452
|
+
});
|
|
453
|
+
const count = await mongoose.connection.collection("auditevents").countDocuments();
|
|
454
|
+
assert.equal(count, 0);
|
|
455
|
+
});
|
|
456
|
+
});
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
|
|
4
|
+
import {APIError} from "../errors";
|
|
5
|
+
import {auditEnqueueFromEnv, createCloudTasksAuditEnqueue} from "./cloudTasksEnqueue";
|
|
6
|
+
import type {AuditEventWrite} from "./record";
|
|
7
|
+
|
|
8
|
+
const sampleWrite: AuditEventWrite = {
|
|
9
|
+
modelName: "Note",
|
|
10
|
+
operation: "create",
|
|
11
|
+
source: "modelRouter",
|
|
12
|
+
verb: "created",
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
describe("createCloudTasksAuditEnqueue", () => {
|
|
16
|
+
it("POSTs the write to the queue URL with the shared secret", async () => {
|
|
17
|
+
const created: unknown[] = [];
|
|
18
|
+
const enqueue = createCloudTasksAuditEnqueue({
|
|
19
|
+
loadModule: async () => ({
|
|
20
|
+
CloudTasksClient: class {
|
|
21
|
+
createTask = async (request: unknown): Promise<void> => {
|
|
22
|
+
created.push(request);
|
|
23
|
+
};
|
|
24
|
+
},
|
|
25
|
+
}),
|
|
26
|
+
location: "us-central1",
|
|
27
|
+
project: "proj",
|
|
28
|
+
queue: "audit-queue",
|
|
29
|
+
secret: "s3cret",
|
|
30
|
+
url: "https://api.example.com/internal/audit-events",
|
|
31
|
+
});
|
|
32
|
+
await enqueue(sampleWrite);
|
|
33
|
+
await enqueue(sampleWrite);
|
|
34
|
+
assert.equal(created.length, 2);
|
|
35
|
+
const request = created[0] as {
|
|
36
|
+
parent: string;
|
|
37
|
+
task: {httpRequest: {body: string; headers: Record<string, string>; url: string}};
|
|
38
|
+
};
|
|
39
|
+
assert.equal(request.parent, "projects/proj/locations/us-central1/queues/audit-queue");
|
|
40
|
+
assert.equal(request.task.httpRequest.url, "https://api.example.com/internal/audit-events");
|
|
41
|
+
assert.equal(request.task.httpRequest.headers["X-Terreno-Audit-Secret"], "s3cret");
|
|
42
|
+
const payload = JSON.parse(
|
|
43
|
+
Buffer.from(request.task.httpRequest.body, "base64").toString("utf8")
|
|
44
|
+
) as AuditEventWrite;
|
|
45
|
+
assert.equal(payload.modelName, "Note");
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
it("throws when @google-cloud/tasks cannot be loaded", async () => {
|
|
49
|
+
const enqueue = createCloudTasksAuditEnqueue({
|
|
50
|
+
loadModule: async () => {
|
|
51
|
+
throw new Error("not installed");
|
|
52
|
+
},
|
|
53
|
+
location: "us-central1",
|
|
54
|
+
project: "proj",
|
|
55
|
+
queue: "audit-queue",
|
|
56
|
+
secret: "s3cret",
|
|
57
|
+
url: "https://api.example.com/internal/audit-events",
|
|
58
|
+
});
|
|
59
|
+
try {
|
|
60
|
+
await enqueue(sampleWrite);
|
|
61
|
+
assert.fail("expected enqueue to throw");
|
|
62
|
+
} catch (error: unknown) {
|
|
63
|
+
assert.instanceOf(error, APIError);
|
|
64
|
+
assert.include((error as APIError).title, "@google-cloud/tasks");
|
|
65
|
+
}
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
it("throws when CloudTasksClient is missing from the module", async () => {
|
|
69
|
+
const enqueue = createCloudTasksAuditEnqueue({
|
|
70
|
+
loadModule: async () => ({}),
|
|
71
|
+
location: "us-central1",
|
|
72
|
+
project: "proj",
|
|
73
|
+
queue: "audit-queue",
|
|
74
|
+
secret: "s3cret",
|
|
75
|
+
url: "https://api.example.com/internal/audit-events",
|
|
76
|
+
});
|
|
77
|
+
try {
|
|
78
|
+
await enqueue(sampleWrite);
|
|
79
|
+
assert.fail("expected enqueue to throw");
|
|
80
|
+
} catch (error: unknown) {
|
|
81
|
+
assert.instanceOf(error, APIError);
|
|
82
|
+
assert.include((error as APIError).title, "CloudTasksClient not found");
|
|
83
|
+
}
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it("wraps a missing default @google-cloud/tasks install", async () => {
|
|
87
|
+
const enqueue = createCloudTasksAuditEnqueue({
|
|
88
|
+
location: "us-central1",
|
|
89
|
+
project: "proj",
|
|
90
|
+
queue: "audit-queue",
|
|
91
|
+
secret: "s3cret",
|
|
92
|
+
url: "https://api.example.com/internal/audit-events",
|
|
93
|
+
});
|
|
94
|
+
try {
|
|
95
|
+
await enqueue(sampleWrite);
|
|
96
|
+
assert.fail("expected enqueue to throw");
|
|
97
|
+
} catch (error: unknown) {
|
|
98
|
+
assert.instanceOf(error, APIError);
|
|
99
|
+
}
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
describe("auditEnqueueFromEnv", () => {
|
|
104
|
+
it("returns undefined until project, location, queue, url, and secret are set", () => {
|
|
105
|
+
assert.isUndefined(auditEnqueueFromEnv({}));
|
|
106
|
+
assert.isUndefined(
|
|
107
|
+
auditEnqueueFromEnv({
|
|
108
|
+
AUDIT_TASKS_SECRET: "s",
|
|
109
|
+
AUDIT_TASKS_URL: "https://example.com/internal/audit-events",
|
|
110
|
+
GCP_LOCATION: "us-central1",
|
|
111
|
+
GCP_PROJECT: "proj",
|
|
112
|
+
})
|
|
113
|
+
);
|
|
114
|
+
assert.isDefined(
|
|
115
|
+
auditEnqueueFromEnv({
|
|
116
|
+
AUDIT_TASKS_SECRET: "s",
|
|
117
|
+
AUDIT_TASKS_URL: "https://example.com/internal/audit-events",
|
|
118
|
+
GCP_LOCATION: "us-central1",
|
|
119
|
+
GCP_PROJECT: "proj",
|
|
120
|
+
GCP_TASKS_AUDIT_QUEUE: "audit-q",
|
|
121
|
+
})
|
|
122
|
+
);
|
|
123
|
+
});
|
|
124
|
+
});
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import {APIError} from "../errors";
|
|
2
|
+
import type {AuditEnqueue, AuditEventWrite} from "./record";
|
|
3
|
+
|
|
4
|
+
interface CloudTasksClient {
|
|
5
|
+
createTask: (request: {
|
|
6
|
+
parent: string;
|
|
7
|
+
task: {
|
|
8
|
+
httpRequest: {
|
|
9
|
+
body: string;
|
|
10
|
+
headers: Record<string, string>;
|
|
11
|
+
httpMethod: "POST";
|
|
12
|
+
url: string;
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
|
+
}) => Promise<unknown>;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
interface CloudTasksModule {
|
|
19
|
+
CloudTasksClient?: new () => CloudTasksClient;
|
|
20
|
+
default?: {CloudTasksClient?: new () => CloudTasksClient};
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export interface CloudTasksAuditEnqueueOptions {
|
|
24
|
+
location: string;
|
|
25
|
+
project: string;
|
|
26
|
+
queue: string;
|
|
27
|
+
secret: string;
|
|
28
|
+
url: string;
|
|
29
|
+
loadModule?: () => Promise<CloudTasksModule>;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
const AUDIT_SECRET_HEADER = "X-Terreno-Audit-Secret";
|
|
33
|
+
|
|
34
|
+
export const createCloudTasksAuditEnqueue = (
|
|
35
|
+
options: CloudTasksAuditEnqueueOptions
|
|
36
|
+
): AuditEnqueue => {
|
|
37
|
+
let client: CloudTasksClient | undefined;
|
|
38
|
+
const loadModule =
|
|
39
|
+
options.loadModule ??
|
|
40
|
+
(() => {
|
|
41
|
+
const moduleName = "@google-cloud/tasks";
|
|
42
|
+
return import(/* webpackIgnore: true */ moduleName);
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
const getClient = async (): Promise<CloudTasksClient> => {
|
|
46
|
+
if (client) {
|
|
47
|
+
return client;
|
|
48
|
+
}
|
|
49
|
+
let mod: CloudTasksModule;
|
|
50
|
+
try {
|
|
51
|
+
mod = await loadModule();
|
|
52
|
+
} catch {
|
|
53
|
+
throw new APIError({
|
|
54
|
+
status: 500,
|
|
55
|
+
title:
|
|
56
|
+
"Cloud Tasks audit enqueue requires @google-cloud/tasks. Install it with: bun add @google-cloud/tasks",
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
const Client = mod.CloudTasksClient ?? mod.default?.CloudTasksClient;
|
|
60
|
+
if (!Client) {
|
|
61
|
+
throw new APIError({
|
|
62
|
+
status: 500,
|
|
63
|
+
title: "CloudTasksClient not found in @google-cloud/tasks module",
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
client = new Client();
|
|
67
|
+
return client;
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
return async (write: AuditEventWrite): Promise<void> => {
|
|
71
|
+
const tasks = await getClient();
|
|
72
|
+
const parent = `projects/${options.project}/locations/${options.location}/queues/${options.queue}`;
|
|
73
|
+
await tasks.createTask({
|
|
74
|
+
parent,
|
|
75
|
+
task: {
|
|
76
|
+
httpRequest: {
|
|
77
|
+
body: Buffer.from(JSON.stringify(write), "utf8").toString("base64"),
|
|
78
|
+
headers: {
|
|
79
|
+
"Content-Type": "application/json",
|
|
80
|
+
[AUDIT_SECRET_HEADER]: options.secret,
|
|
81
|
+
},
|
|
82
|
+
httpMethod: "POST",
|
|
83
|
+
url: options.url,
|
|
84
|
+
},
|
|
85
|
+
},
|
|
86
|
+
});
|
|
87
|
+
};
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
export const auditEnqueueFromEnv = (
|
|
91
|
+
env: NodeJS.ProcessEnv = process.env
|
|
92
|
+
): AuditEnqueue | undefined => {
|
|
93
|
+
const queue = env.GCP_TASKS_AUDIT_QUEUE;
|
|
94
|
+
const url = env.AUDIT_TASKS_URL;
|
|
95
|
+
const project = env.GCP_PROJECT;
|
|
96
|
+
const location = env.GCP_LOCATION;
|
|
97
|
+
const secret = env.AUDIT_TASKS_SECRET;
|
|
98
|
+
if (!queue || !url || !project || !location || !secret) {
|
|
99
|
+
return undefined;
|
|
100
|
+
}
|
|
101
|
+
return createCloudTasksAuditEnqueue({location, project, queue, secret, url});
|
|
102
|
+
};
|
|
103
|
+
|
|
104
|
+
export {AUDIT_SECRET_HEADER};
|