@beechcms/api 0.5.0 → 0.6.0-preview.2
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/assets/dashboard/BeechLogo.svg +18 -18
- package/assets/dashboard/BeechLogoLIght.svg +48 -48
- package/assets/dashboard/Searching.svg +1 -0
- package/assets/dashboard/assets/chart-BrJFdsGZ.js +39 -0
- package/assets/dashboard/assets/index-CIaoMxuB.css +1 -0
- package/assets/dashboard/assets/index-wTKgygsg.js +636 -0
- package/assets/dashboard/assets/pie-chart-recharts-BEaE1FOE.js +1 -0
- package/assets/dashboard/assets/timeseries-chart-recharts-DmWM6imF.js +1 -0
- package/assets/dashboard/beechLogoDark.svg +48 -48
- package/assets/dashboard/index.html +18 -18
- package/assets/dashboard/noResult.svg +43 -0
- package/assets/dashboard/sol.svg +3 -3
- package/assets/dashboard/undraw_enter_nwx3.svg +36 -36
- package/assets/dashboard/working.svg +1 -0
- package/migrations/0000_v040_base.sql +265 -238
- package/migrations/0029_automations.sql +14 -14
- package/migrations/0030_test_seeds.sql +125 -125
- package/package.json +13 -9
- package/src/auth/{in-memory-hash-provider.ts → __fixtures__/in-memory-hash-provider.ts} +17 -13
- package/src/auth/{static-token-service.ts → __fixtures__/static-token-service.ts} +22 -18
- package/src/auth/bcrypt-hash-provider.ts +24 -20
- package/src/auth/constants.ts +14 -10
- package/src/auth/generate-refresh-token.test.ts +23 -19
- package/src/auth/hash-provider.test.ts +55 -46
- package/src/auth/jose-token-service.ts +62 -55
- package/src/auth/jwt-claims-passthrough.test.ts +87 -0
- package/src/auth/login.test.ts +100 -92
- package/src/auth/login.ts +78 -74
- package/src/auth/refresh.ts +11 -5
- package/src/auth/token-service.test.ts +90 -82
- package/src/factory.ts +370 -347
- package/src/features/automations/__tests__/action-executors.test.ts +255 -268
- package/src/features/automations/__tests__/automation-runner.test.ts +196 -192
- package/src/features/automations/__tests__/automation-runner.utils.test.ts +60 -56
- package/src/features/automations/__tests__/automations.handler.test.ts +264 -260
- package/src/features/automations/__tests__/automations.repository.test.ts +163 -159
- package/src/features/automations/__tests__/automations.schema.test.ts +224 -134
- package/src/features/automations/__tests__/context-resolver.test.ts +126 -122
- package/src/features/automations/__tests__/cron-runner.test.ts +267 -263
- package/src/features/automations/__tests__/cron-runner.utils.test.ts +144 -140
- package/src/features/automations/__tests__/set-variable.executor.test.ts +383 -306
- package/src/features/automations/__tests__/template-grammar.test.ts +308 -304
- package/src/features/automations/__tests__/webhook.executor.test.ts +142 -0
- package/src/features/automations/__tests__/when-evaluator.test.ts +274 -270
- package/src/features/automations/__tests__/when-pushdown.test.ts +281 -277
- package/src/features/automations/action-executors/create-entry.executor.ts +27 -23
- package/src/features/automations/action-executors/edit-field.executor.ts +26 -22
- package/src/features/automations/action-executors/index.ts +37 -33
- package/src/features/automations/action-executors/send-mail.executor.ts +53 -42
- package/src/features/automations/action-executors/set-variable.executor.ts +159 -146
- package/src/features/automations/action-executors/webhook.executor.ts +67 -25
- package/src/features/automations/automation-runner.ts +85 -81
- package/src/features/automations/automation-runner.utils.ts +47 -43
- package/src/features/automations/automations.handler.ts +197 -193
- package/src/features/automations/automations.schema.ts +177 -160
- package/src/features/automations/context-resolver.ts +152 -148
- package/src/features/automations/cron-runner.ts +140 -136
- package/src/features/automations/cron-runner.utils.ts +44 -40
- package/src/features/automations/filter-translation.ts +46 -42
- package/src/features/automations/index.ts +16 -12
- package/src/features/automations/template-grammar.ts +245 -241
- package/src/features/automations/var-access-resolver.ts +140 -136
- package/src/features/automations/when-evaluator.ts +87 -83
- package/src/features/automations/when-pushdown.ts +57 -53
- package/src/features/backrefs/__tests__/backrefs.handler.test.ts +359 -0
- package/src/features/backrefs/backrefs.handler.ts +168 -0
- package/src/features/backrefs/d1-backref.repository.ts +84 -0
- package/src/features/backrefs/index.ts +5 -0
- package/src/features/content/constants.ts +16 -10
- package/src/features/content/handlers/bulk.handler.ts +185 -0
- package/src/features/content/handlers/create.ts +129 -165
- package/src/features/content/handlers/delete.ts +62 -87
- package/src/features/content/handlers/facets.ts +49 -45
- package/src/features/content/handlers/get.ts +120 -116
- package/src/features/content/handlers/helpers.test.ts +180 -0
- package/src/features/content/handlers/helpers.ts +93 -0
- package/src/features/content/handlers/list.ts +174 -88
- package/src/features/content/handlers/update.ts +174 -219
- package/src/features/content/index.ts +26 -20
- package/src/features/dashboard-layout/__tests__/dashboard-layout.handler.test.ts +388 -0
- package/src/features/dashboard-layout/dashboard-layout.handler.ts +206 -0
- package/src/features/dashboard-layout/index.ts +5 -0
- package/src/features/draft/draft.handler.ts +195 -170
- package/src/features/draft/draft.middleware.ts +66 -62
- package/src/features/draft/index.ts +5 -1
- package/src/features/email/email.provider.ts +42 -38
- package/src/features/email/email.service.ts +98 -93
- package/src/features/email/email.types.ts +119 -108
- package/src/features/email/index.ts +33 -29
- package/src/features/email/providers/resend.ts +67 -63
- package/src/features/email/providers/smtp.ts +55 -0
- package/src/features/email/templates/automation-mail.ts +19 -15
- package/src/features/email/templates/password-changed.ts +63 -59
- package/src/features/email/templates/password-reset.ts +68 -64
- package/src/features/email/templates/shell.ts +96 -92
- package/src/features/notifications/index.ts +5 -1
- package/src/features/notifications/notifications.handler.ts +105 -101
- package/src/features/password-reset/index.ts +19 -15
- package/src/features/password-reset/request.ts +92 -82
- package/src/features/password-reset/reset.ts +102 -92
- package/src/features/rotate-field/index.ts +5 -1
- package/src/features/rotate-field/rotate-field.handler.ts +132 -128
- package/src/features/rotate-field/rotate-field.schema.ts +17 -13
- package/src/features/schema/schema.handler.ts +131 -16
- package/src/features/seeds/index.ts +5 -0
- package/src/features/seeds/seeds.handler.test.ts +1199 -0
- package/src/features/seeds/seeds.handler.ts +558 -0
- package/src/features/settings/__tests__/settings.handler.test.ts +555 -0
- package/src/features/settings/settings.handler.ts +392 -302
- package/src/features/setup/index.ts +288 -91
- package/src/features/stats/index.ts +5 -1
- package/src/features/stats/stats.handler.ts +420 -430
- package/src/features/webhooks/index.ts +63 -0
- package/src/index.ts +65 -56
- package/src/media-utils.ts +82 -78
- package/src/middleware/auth-providers.middleware.test.ts +85 -0
- package/src/middleware/auth-providers.middleware.ts +45 -32
- package/src/middleware/observability.middleware.test.ts +93 -0
- package/src/middleware/observability.middleware.ts +70 -52
- package/src/middleware/rate-limit.middleware.ts +45 -41
- package/src/middleware/repository.middleware.ts +117 -91
- package/src/middleware/seed-registry.middleware.test.ts +97 -0
- package/src/middleware/seed-registry.middleware.ts +21 -0
- package/src/middleware/storage.middleware.ts +25 -21
- package/src/middleware.ts +45 -47
- package/src/public/access-policy.ts +27 -23
- package/src/public/api-key-middleware.ts +57 -53
- package/src/public/cache-utils.ts +38 -34
- package/src/public/entry-projection.ts +46 -42
- package/src/public/idempotency.ts +23 -19
- package/src/public/index.ts +16 -12
- package/src/public/problem-details.ts +124 -53
- package/src/public/public-add.ts +114 -110
- package/src/public/public-edit.ts +163 -159
- package/src/public/public-errors.ts +19 -15
- package/src/public/public-read.ts +63 -59
- package/src/public/public-routes.ts +88 -84
- package/src/public/query-builder.test.ts +224 -220
- package/src/public/query-builder.ts +156 -152
- package/src/public/rate-limit-middleware.ts +34 -30
- package/src/public/read-list.ts +54 -50
- package/src/public/read-single.ts +48 -44
- package/src/public/response-builder.ts +30 -26
- package/src/public/sanitize.ts +69 -65
- package/src/public/slug-utils.ts +18 -14
- package/src/rate-limit/cloudflare-rate-limiter.test.ts +30 -26
- package/src/rate-limit/cloudflare-rate-limiter.ts +15 -11
- package/src/rate-limit/in-memory-rate-limiter.test.ts +37 -33
- package/src/rate-limit/in-memory-rate-limiter.ts +17 -13
- package/src/rate-limit/no-op-rate-limiter.test.ts +22 -18
- package/src/rate-limit/no-op-rate-limiter.ts +11 -7
- package/src/search-utils.test.ts +211 -207
- package/src/search-utils.ts +213 -209
- package/src/search.ts +65 -61
- package/src/shared/apply-policies.test.ts +81 -77
- package/src/shared/apply-policies.ts +67 -63
- package/src/shared/automations.repository.d1.ts +150 -146
- package/src/shared/background-notification-service.test.ts +62 -58
- package/src/shared/background-notification-service.ts +52 -48
- package/src/shared/base.repository.d1.ts +32 -28
- package/src/shared/content-utils.test.ts +165 -161
- package/src/shared/content-utils.ts +86 -82
- package/src/shared/content.repository.d1.test.ts +507 -312
- package/src/shared/content.repository.d1.ts +851 -382
- package/src/shared/d1-activity-log.repository.test.ts +140 -136
- package/src/shared/d1-activity-log.repository.ts +105 -101
- package/src/shared/d1-activity-logger.test.ts +86 -82
- package/src/shared/d1-activity-logger.ts +67 -63
- package/src/shared/d1-analytics.repository.test.ts +78 -74
- package/src/shared/d1-analytics.repository.ts +85 -81
- package/src/shared/d1-content-scan.repository.test.ts +80 -76
- package/src/shared/d1-content-scan.repository.ts +37 -29
- package/src/shared/d1-notification.repository.test.ts +128 -124
- package/src/shared/d1-notification.repository.ts +118 -114
- package/src/shared/d1-password-reset-token.repository.test.ts +81 -77
- package/src/shared/d1-password-reset-token.repository.ts +56 -52
- package/src/shared/d1-search.repository.test.ts +87 -83
- package/src/shared/d1-search.repository.ts +88 -84
- package/src/shared/d1-session.repository.test.ts +125 -121
- package/src/shared/d1-session.repository.ts +102 -98
- package/src/shared/d1-setup-checklist.repository.ts +36 -0
- package/src/shared/d1-user.repository.test.ts +151 -147
- package/src/shared/d1-user.repository.ts +119 -109
- package/src/shared/d1-widget.repository.test.ts +267 -217
- package/src/shared/d1-widget.repository.ts +385 -337
- package/src/shared/dashboard-layout.repository.d1.test.ts +135 -0
- package/src/shared/dashboard-layout.repository.d1.ts +58 -0
- package/src/shared/demo-data-sql.ts +216 -0
- package/src/shared/demo-data.repository.d1.ts +20 -0
- package/src/shared/execution-context-scheduler.ts +13 -9
- package/src/shared/fixed-clock.ts +25 -21
- package/src/shared/fts-sync.ts +8 -4
- package/src/shared/idempotency.repository.d1.test.ts +83 -79
- package/src/shared/idempotency.repository.d1.ts +60 -56
- package/src/shared/in-memory-activity-logger.ts +19 -15
- package/src/shared/in-memory-notification-service.ts +19 -15
- package/src/shared/in-memory-seed.repository.ts +58 -0
- package/src/shared/media.repository.d1.test.ts +107 -103
- package/src/shared/media.repository.d1.ts +68 -64
- package/src/shared/qstash-notification-service.test.ts +67 -0
- package/src/shared/qstash-notification-service.ts +55 -0
- package/src/shared/query-utils.ts +141 -137
- package/src/shared/request-utils.ts +26 -22
- package/src/shared/schema-mutator.d1.test.ts +142 -0
- package/src/shared/schema-mutator.d1.ts +64 -0
- package/src/shared/seed-layout.repository.d1.test.ts +114 -0
- package/src/shared/seed-layout.repository.d1.ts +62 -0
- package/src/shared/seed-registry-cache.test.ts +68 -0
- package/src/shared/seed-registry-cache.ts +49 -0
- package/src/shared/seed.repository.d1.test.ts +143 -0
- package/src/shared/seed.repository.d1.ts +98 -0
- package/src/shared/sequential-id-generator.ts +33 -22
- package/src/shared/site-settings.repository.d1.ts +53 -0
- package/src/shared/storage/factory.ts +41 -40
- package/src/shared/storage/s3-bucket.ts +195 -163
- package/src/shared/storage-utils.ts +40 -36
- package/src/shared/system-stats.repository.d1.test.ts +58 -54
- package/src/shared/system-stats.repository.d1.ts +48 -44
- package/src/types.ts +90 -67
- package/src/upload.ts +198 -187
- package/src/widget.test.ts +85 -0
- package/src/widget.ts +251 -208
- package/assets/dashboard/assets/index-B1mUfgiK.css +0 -1
- package/assets/dashboard/assets/index-CHxxc_id.js +0 -629
- package/src/shared/storage/r2-binding-bucket.ts +0 -81
|
@@ -1,82 +1,86 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
import {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
const
|
|
16
|
-
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
expect(
|
|
40
|
-
|
|
41
|
-
expect(boundArguments[
|
|
42
|
-
expect(boundArguments[
|
|
43
|
-
expect(boundArguments[
|
|
44
|
-
expect(boundArguments[
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
})
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
1
|
+
// SPDX-License-Identifier: BUSL-1.1
|
|
2
|
+
// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
|
|
3
|
+
// See LICENSE in the repository root for license terms.
|
|
4
|
+
|
|
5
|
+
import { describe, it, expect, vi } from 'vitest'
|
|
6
|
+
import { D1ActivityLogger } from './d1-activity-logger'
|
|
7
|
+
import type { ActivityLogEntry } from '@beechcms/core'
|
|
8
|
+
import { FixedClock } from './fixed-clock'
|
|
9
|
+
import { SequentialIdGenerator } from './sequential-id-generator'
|
|
10
|
+
|
|
11
|
+
const clock = new FixedClock(1700000000_000)
|
|
12
|
+
const makeIdGen = () => new SequentialIdGenerator()
|
|
13
|
+
|
|
14
|
+
function makeMockDb(opts: { runShouldThrow?: boolean } = {}) {
|
|
15
|
+
const runMock = opts.runShouldThrow
|
|
16
|
+
? vi.fn().mockRejectedValue(new Error('db down'))
|
|
17
|
+
: vi.fn().mockResolvedValue({ success: true })
|
|
18
|
+
const bindMock = vi.fn(() => ({ run: runMock }))
|
|
19
|
+
const prepareMock = vi.fn(() => ({ bind: bindMock }))
|
|
20
|
+
return { db: { prepare: prepareMock } as any, prepareMock, bindMock, runMock }
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
const SAMPLE_ENTRY: ActivityLogEntry = {
|
|
24
|
+
action: 'create',
|
|
25
|
+
entityType: 'content',
|
|
26
|
+
entityId: 'entry-1',
|
|
27
|
+
entitySlug: 'posts',
|
|
28
|
+
details: { title: 'Hello' },
|
|
29
|
+
actor: { id: 'user-1', email: 'admin@example.com', name: 'Admin' },
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
describe('D1ActivityLogger', () => {
|
|
33
|
+
it('inserts into activity_logs with the actor and entry payload bound in order', async () => {
|
|
34
|
+
const { db, prepareMock, bindMock } = makeMockDb()
|
|
35
|
+
const logger = new D1ActivityLogger(db, clock, makeIdGen())
|
|
36
|
+
|
|
37
|
+
await logger.log(SAMPLE_ENTRY)
|
|
38
|
+
|
|
39
|
+
expect(prepareMock).toHaveBeenCalledWith(expect.stringContaining('INSERT INTO activity_logs'))
|
|
40
|
+
const boundArguments = bindMock.mock.calls[0]
|
|
41
|
+
expect(boundArguments[1]).toBe('user-1')
|
|
42
|
+
expect(boundArguments[2]).toBe('admin@example.com')
|
|
43
|
+
expect(boundArguments[3]).toBe('Admin')
|
|
44
|
+
expect(boundArguments[4]).toBe('create')
|
|
45
|
+
expect(boundArguments[5]).toBe('content')
|
|
46
|
+
expect(boundArguments[6]).toBe('entry-1')
|
|
47
|
+
expect(boundArguments[7]).toBe('posts')
|
|
48
|
+
expect(boundArguments[8]).toBe('{"title":"Hello"}')
|
|
49
|
+
})
|
|
50
|
+
|
|
51
|
+
it('serialises details as null when absent', async () => {
|
|
52
|
+
const { db, bindMock } = makeMockDb()
|
|
53
|
+
await new D1ActivityLogger(db, clock, makeIdGen()).log({ ...SAMPLE_ENTRY, details: undefined })
|
|
54
|
+
expect(bindMock.mock.calls[0][8]).toBeNull()
|
|
55
|
+
})
|
|
56
|
+
|
|
57
|
+
it('falls back to "unknown" when actor email is empty', async () => {
|
|
58
|
+
const { db, bindMock } = makeMockDb()
|
|
59
|
+
await new D1ActivityLogger(db, clock, makeIdGen()).log({
|
|
60
|
+
...SAMPLE_ENTRY,
|
|
61
|
+
actor: { id: 'u', email: '', name: null },
|
|
62
|
+
})
|
|
63
|
+
expect(bindMock.mock.calls[0][2]).toBe('unknown')
|
|
64
|
+
})
|
|
65
|
+
|
|
66
|
+
it('schedules the insert via the background hook when provided', async () => {
|
|
67
|
+
const { db } = makeMockDb()
|
|
68
|
+
const scheduleBackgroundTask = vi.fn()
|
|
69
|
+
const logger = new D1ActivityLogger(db, clock, makeIdGen(), scheduleBackgroundTask)
|
|
70
|
+
|
|
71
|
+
logger.log(SAMPLE_ENTRY)
|
|
72
|
+
|
|
73
|
+
expect(scheduleBackgroundTask).toHaveBeenCalledTimes(1)
|
|
74
|
+
expect(scheduleBackgroundTask.mock.calls[0][0]).toBeInstanceOf(Promise)
|
|
75
|
+
})
|
|
76
|
+
|
|
77
|
+
it('never throws to the caller when the underlying INSERT fails', async () => {
|
|
78
|
+
const { db } = makeMockDb({ runShouldThrow: true })
|
|
79
|
+
const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
|
|
80
|
+
const logger = new D1ActivityLogger(db, clock, makeIdGen())
|
|
81
|
+
|
|
82
|
+
await expect(logger.log(SAMPLE_ENTRY)).resolves.toBeUndefined()
|
|
83
|
+
expect(consoleSpy).toHaveBeenCalled()
|
|
84
|
+
consoleSpy.mockRestore()
|
|
85
|
+
})
|
|
86
|
+
})
|
|
@@ -1,63 +1,67 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
entry.
|
|
54
|
-
entry.
|
|
55
|
-
entry.
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
}
|
|
1
|
+
// SPDX-License-Identifier: BUSL-1.1
|
|
2
|
+
// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
|
|
3
|
+
// See LICENSE in the repository root for license terms.
|
|
4
|
+
|
|
5
|
+
/// <reference types="@cloudflare/workers-types" />
|
|
6
|
+
import type { IActivityLogger, ActivityLogEntry, IClock, IIdGenerator } from '@beechcms/core'
|
|
7
|
+
|
|
8
|
+
const ACTIVITY_LOG_INSERT_SQL =
|
|
9
|
+
`INSERT INTO activity_logs
|
|
10
|
+
(id, user_id, user_email, user_name, action, entity_type, entity_id, entity_slug, details)
|
|
11
|
+
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`
|
|
12
|
+
|
|
13
|
+
const FALLBACK_USER_EMAIL = 'unknown'
|
|
14
|
+
|
|
15
|
+
type ScheduleBackgroundTask = (task: Promise<unknown>) => void
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* D1-backed implementation of {@link IActivityLogger}.
|
|
19
|
+
*
|
|
20
|
+
* When `scheduleBackgroundTask` is provided (production path, wired to
|
|
21
|
+
* `c.executionCtx.waitUntil`), the INSERT runs after the response is sent so
|
|
22
|
+
* audit logging never adds latency to the user-facing request. When absent
|
|
23
|
+
* (tests, scripts), the INSERT runs inline and any errors are logged.
|
|
24
|
+
*/
|
|
25
|
+
export class D1ActivityLogger implements IActivityLogger {
|
|
26
|
+
constructor(
|
|
27
|
+
private readonly database: D1Database,
|
|
28
|
+
private readonly clock: IClock,
|
|
29
|
+
private readonly idGenerator: IIdGenerator,
|
|
30
|
+
private readonly scheduleBackgroundTask?: ScheduleBackgroundTask
|
|
31
|
+
) {}
|
|
32
|
+
|
|
33
|
+
log(entry: ActivityLogEntry): Promise<void> | void {
|
|
34
|
+
const insertPromise = this.runInsert(entry)
|
|
35
|
+
|
|
36
|
+
if (this.scheduleBackgroundTask) {
|
|
37
|
+
this.scheduleBackgroundTask(insertPromise)
|
|
38
|
+
return
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
return insertPromise
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
private async runInsert(entry: ActivityLogEntry): Promise<void> {
|
|
45
|
+
try {
|
|
46
|
+
const recordId = this.idGenerator.uuid()
|
|
47
|
+
const serializedDetails = entry.details ? JSON.stringify(entry.details) : null
|
|
48
|
+
|
|
49
|
+
await this.database
|
|
50
|
+
.prepare(ACTIVITY_LOG_INSERT_SQL)
|
|
51
|
+
.bind(
|
|
52
|
+
recordId,
|
|
53
|
+
entry.actor.id,
|
|
54
|
+
entry.actor.email || FALLBACK_USER_EMAIL,
|
|
55
|
+
entry.actor.name ?? null,
|
|
56
|
+
entry.action,
|
|
57
|
+
entry.entityType,
|
|
58
|
+
entry.entityId,
|
|
59
|
+
entry.entitySlug ?? null,
|
|
60
|
+
serializedDetails
|
|
61
|
+
)
|
|
62
|
+
.run()
|
|
63
|
+
} catch (error) {
|
|
64
|
+
console.error('D1ActivityLogger: failed to persist activity entry', error)
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
@@ -1,74 +1,78 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
const
|
|
14
|
-
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
expect(
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
const
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
expect(
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
1
|
+
// SPDX-License-Identifier: BUSL-1.1
|
|
2
|
+
// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
|
|
3
|
+
// See LICENSE in the repository root for license terms.
|
|
4
|
+
|
|
5
|
+
import { describe, it, expect, vi } from 'vitest'
|
|
6
|
+
import { D1AnalyticsRepository } from './d1-analytics.repository'
|
|
7
|
+
import { FixedClock } from './fixed-clock'
|
|
8
|
+
|
|
9
|
+
const FIXED_NOW_MS = 1700000000_000
|
|
10
|
+
const EXPECTED_DAY_BUCKET = Math.floor(FIXED_NOW_MS / 1000 / 86400) * 86400
|
|
11
|
+
|
|
12
|
+
function makeMockDb(allResults: unknown[] = [], firstResult: unknown = null) {
|
|
13
|
+
const allMock = vi.fn().mockResolvedValue({ results: allResults })
|
|
14
|
+
const firstMock = vi.fn().mockResolvedValue(firstResult)
|
|
15
|
+
const runMock = vi.fn().mockResolvedValue({ success: true })
|
|
16
|
+
const bindMock = vi.fn(() => ({ all: allMock, first: firstMock, run: runMock }))
|
|
17
|
+
const prepareMock = vi.fn(() => ({ bind: bindMock }))
|
|
18
|
+
return { db: { prepare: prepareMock } as any, prepareMock, bindMock, allMock, firstMock, runMock }
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
describe('D1AnalyticsRepository', () => {
|
|
22
|
+
describe('recordRequest', () => {
|
|
23
|
+
it('issues an INSERT ... ON CONFLICT upsert with seed and computed day bucket', async () => {
|
|
24
|
+
const { db, prepareMock, bindMock, runMock } = makeMockDb()
|
|
25
|
+
await new D1AnalyticsRepository(db, new FixedClock(FIXED_NOW_MS)).recordRequest('posts')
|
|
26
|
+
const sql = prepareMock.mock.calls[0]![0] as string
|
|
27
|
+
expect(sql).toMatch(/INSERT INTO analytics/)
|
|
28
|
+
expect(sql).toMatch(/ON CONFLICT\(day_ts, metric, seed\) DO UPDATE SET value = value \+ 1/)
|
|
29
|
+
expect(bindMock).toHaveBeenCalledWith(EXPECTED_DAY_BUCKET, 'posts')
|
|
30
|
+
expect(runMock).toHaveBeenCalled()
|
|
31
|
+
})
|
|
32
|
+
})
|
|
33
|
+
|
|
34
|
+
describe('sumByMetric', () => {
|
|
35
|
+
it('binds requests metric, seed and since', async () => {
|
|
36
|
+
const { db, prepareMock, bindMock } = makeMockDb([], { total: 99 })
|
|
37
|
+
const total = await new D1AnalyticsRepository(db, new FixedClock(FIXED_NOW_MS)).sumByMetric('requests', 'posts', 1)
|
|
38
|
+
expect(total).toBe(99)
|
|
39
|
+
const sql = prepareMock.mock.calls[0]![0] as string
|
|
40
|
+
expect(sql).toMatch(/SELECT SUM\(value\) as total/)
|
|
41
|
+
expect(sql).toMatch(/WHERE metric = \? AND seed = \? AND day_ts >= \?/)
|
|
42
|
+
expect(bindMock).toHaveBeenCalledWith('requests', 'posts', 1)
|
|
43
|
+
})
|
|
44
|
+
|
|
45
|
+
it('returns 0 when SUM is null', async () => {
|
|
46
|
+
const { db } = makeMockDb([], { total: null })
|
|
47
|
+
const total = await new D1AnalyticsRepository(db, new FixedClock(FIXED_NOW_MS)).sumByMetric('visitors', '', 0)
|
|
48
|
+
expect(total).toBe(0)
|
|
49
|
+
})
|
|
50
|
+
|
|
51
|
+
it('returns 0 when no row matches', async () => {
|
|
52
|
+
const { db } = makeMockDb([], null)
|
|
53
|
+
const total = await new D1AnalyticsRepository(db, new FixedClock(FIXED_NOW_MS)).sumByMetric('requests', '', 0)
|
|
54
|
+
expect(total).toBe(0)
|
|
55
|
+
})
|
|
56
|
+
})
|
|
57
|
+
|
|
58
|
+
describe('groupByMetric', () => {
|
|
59
|
+
it('returns a date_label → count map filtered to metric=requests', async () => {
|
|
60
|
+
const { db, prepareMock, bindMock } = makeMockDb([
|
|
61
|
+
{ date_label: '2026-01-01', daily_count: 10 },
|
|
62
|
+
{ date_label: '2026-01-02', daily_count: 20 },
|
|
63
|
+
])
|
|
64
|
+
const result = await new D1AnalyticsRepository(db, new FixedClock(FIXED_NOW_MS)).groupByMetric('posts', 1)
|
|
65
|
+
expect(result).toEqual({ '2026-01-01': 10, '2026-01-02': 20 })
|
|
66
|
+
const sql = prepareMock.mock.calls[0]![0] as string
|
|
67
|
+
expect(sql).toMatch(/strftime\('%Y-%m-%d', day_ts, 'unixepoch'\)/)
|
|
68
|
+
expect(sql).toMatch(/metric = 'requests'/)
|
|
69
|
+
expect(bindMock).toHaveBeenCalledWith('posts', 1)
|
|
70
|
+
})
|
|
71
|
+
|
|
72
|
+
it('skips rows with null date_label', async () => {
|
|
73
|
+
const { db } = makeMockDb([{ date_label: null, daily_count: 5 }])
|
|
74
|
+
const result = await new D1AnalyticsRepository(db, new FixedClock(FIXED_NOW_MS)).groupByMetric('', 0)
|
|
75
|
+
expect(result).toEqual({})
|
|
76
|
+
})
|
|
77
|
+
})
|
|
78
|
+
})
|
|
@@ -1,81 +1,85 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
1
|
+
// SPDX-License-Identifier: BUSL-1.1
|
|
2
|
+
// Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
|
|
3
|
+
// See LICENSE in the repository root for license terms.
|
|
4
|
+
|
|
5
|
+
/// <reference types="@cloudflare/workers-types" />
|
|
6
|
+
import type { IAnalyticsRepository, AnalyticsMetric, IClock } from '@beechcms/core'
|
|
7
|
+
|
|
8
|
+
const SECONDS_PER_DAY = 86400
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* D1-backed implementation of {@link IAnalyticsRepository}.
|
|
12
|
+
*
|
|
13
|
+
* The underlying schema is long-format:
|
|
14
|
+
* `analytics(day_ts, metric, seed, value)` with UNIQUE(day_ts, metric, seed).
|
|
15
|
+
* Each row stores the counter for one (day, metric, seed) tuple. The
|
|
16
|
+
* IAnalyticsRepository contract is metric-aware (the metric is selected via
|
|
17
|
+
* a switch on the validated enum), and never interpolates user values into
|
|
18
|
+
* SQL — the actual metric name is bound through a parameter.
|
|
19
|
+
*/
|
|
20
|
+
export class D1AnalyticsRepository implements IAnalyticsRepository {
|
|
21
|
+
constructor(
|
|
22
|
+
private readonly database: D1Database,
|
|
23
|
+
private readonly clock: IClock,
|
|
24
|
+
) {}
|
|
25
|
+
|
|
26
|
+
async recordRequest(seedSlug: string): Promise<void> {
|
|
27
|
+
const dayTimestamp = Math.floor(this.clock.nowSeconds() / SECONDS_PER_DAY) * SECONDS_PER_DAY
|
|
28
|
+
await this.database
|
|
29
|
+
.prepare(
|
|
30
|
+
`INSERT INTO analytics (day_ts, metric, seed, value)
|
|
31
|
+
VALUES (?, 'requests', ?, 1)
|
|
32
|
+
ON CONFLICT(day_ts, metric, seed) DO UPDATE SET value = value + 1`,
|
|
33
|
+
)
|
|
34
|
+
.bind(dayTimestamp, seedSlug)
|
|
35
|
+
.run()
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
async sumByMetric(
|
|
39
|
+
metric: AnalyticsMetric,
|
|
40
|
+
seedSlug: string,
|
|
41
|
+
sinceTimestamp: number,
|
|
42
|
+
): Promise<number> {
|
|
43
|
+
const metricName = this.resolveMetricName(metric)
|
|
44
|
+
const row = await this.database
|
|
45
|
+
.prepare(
|
|
46
|
+
`SELECT SUM(value) as total
|
|
47
|
+
FROM analytics
|
|
48
|
+
WHERE metric = ? AND seed = ? AND day_ts >= ?`,
|
|
49
|
+
)
|
|
50
|
+
.bind(metricName, seedSlug, sinceTimestamp)
|
|
51
|
+
.first<{ total: number | null }>()
|
|
52
|
+
return row?.total ?? 0
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
async groupByMetric(
|
|
56
|
+
seedSlug: string,
|
|
57
|
+
sinceTimestamp: number,
|
|
58
|
+
): Promise<Record<string, number>> {
|
|
59
|
+
const result = await this.database
|
|
60
|
+
.prepare(
|
|
61
|
+
`SELECT strftime('%Y-%m-%d', day_ts, 'unixepoch') as date_label,
|
|
62
|
+
SUM(value) as daily_count
|
|
63
|
+
FROM analytics
|
|
64
|
+
WHERE metric = 'requests' AND seed = ? AND day_ts >= ?
|
|
65
|
+
GROUP BY date_label
|
|
66
|
+
ORDER BY date_label ASC`,
|
|
67
|
+
)
|
|
68
|
+
.bind(seedSlug, sinceTimestamp)
|
|
69
|
+
.all<{ date_label: string | null; daily_count: number | null }>()
|
|
70
|
+
|
|
71
|
+
const grouped: Record<string, number> = {}
|
|
72
|
+
for (const row of result.results ?? []) {
|
|
73
|
+
if (row.date_label === null) continue
|
|
74
|
+
grouped[row.date_label] = row.daily_count ?? 0
|
|
75
|
+
}
|
|
76
|
+
return grouped
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
private resolveMetricName(metric: AnalyticsMetric): string {
|
|
80
|
+
switch (metric) {
|
|
81
|
+
case 'requests': return 'requests'
|
|
82
|
+
case 'visitors': return 'visitors'
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|