@camstack/server 1.0.0 → 1.0.1

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 (234) hide show
  1. package/{src/agent-status-page.ts → dist/agent-status-page.js} +30 -45
  2. package/dist/api/addon-upload.js +441 -0
  3. package/dist/api/addons-custom.router.js +91 -0
  4. package/dist/api/auth-whoami.js +55 -0
  5. package/dist/api/bridge-addons.router.js +109 -0
  6. package/dist/api/capabilities.router.js +229 -0
  7. package/dist/api/core/addon-settings.router.js +117 -0
  8. package/dist/api/core/agents.router.js +73 -0
  9. package/dist/api/core/auth.router.js +286 -0
  10. package/dist/api/core/bulk-update-coordinator.js +229 -0
  11. package/dist/api/core/cap-providers.js +1124 -0
  12. package/dist/api/core/capabilities.router.js +138 -0
  13. package/dist/api/core/collection-preference.js +17 -0
  14. package/dist/api/core/event-bus-proxy.router.js +45 -0
  15. package/dist/api/core/hwaccel.router.js +91 -0
  16. package/dist/api/core/live-events.router.js +61 -0
  17. package/dist/api/core/logs.router.js +172 -0
  18. package/dist/api/core/notifications.router.js +67 -0
  19. package/dist/api/core/repl.router.js +35 -0
  20. package/dist/api/core/settings-backend.router.js +121 -0
  21. package/dist/api/core/stream-probe.router.js +58 -0
  22. package/dist/api/core/system-events.router.js +100 -0
  23. package/dist/api/health/health.routes.js +68 -0
  24. package/{src/api/oauth2/consent-page.ts → dist/api/oauth2/consent-page.js} +11 -20
  25. package/dist/api/oauth2/oauth2-routes.js +219 -0
  26. package/dist/api/trpc/cap-mount-helpers.js +194 -0
  27. package/dist/api/trpc/cap-route-error-formatter.js +133 -0
  28. package/dist/api/trpc/client-ip.js +147 -0
  29. package/dist/api/trpc/core-cap-bridge.js +115 -0
  30. package/dist/api/trpc/generated-cap-mounts.js +388 -0
  31. package/dist/api/trpc/generated-cap-routers.js +7635 -0
  32. package/dist/api/trpc/scope-access.js +93 -0
  33. package/dist/api/trpc/trpc.context.js +184 -0
  34. package/dist/api/trpc/trpc.middleware.js +139 -0
  35. package/dist/api/trpc/trpc.router.js +188 -0
  36. package/dist/auth/session-cookie.js +47 -0
  37. package/dist/boot/boot-config.js +241 -0
  38. package/dist/boot/integration-id-backfill.js +76 -0
  39. package/dist/boot/post-boot.service.js +85 -0
  40. package/dist/core/addon/addon-call-gateway.js +99 -0
  41. package/dist/core/addon/addon-package.service.js +1560 -0
  42. package/dist/core/addon/addon-registry.service.js +2739 -0
  43. package/{src/core/addon/addon-row-manifest.ts → dist/core/addon/addon-row-manifest.js} +5 -5
  44. package/dist/core/addon/addon-search.service.js +62 -0
  45. package/dist/core/addon/addon-settings-provider.js +102 -0
  46. package/dist/core/addon/addon.tokens.js +5 -0
  47. package/dist/core/addon-bridge/addon-bridge.service.js +145 -0
  48. package/dist/core/addon-pages/addon-pages.service.js +107 -0
  49. package/dist/core/addon-widgets/addon-widgets.service.js +120 -0
  50. package/dist/core/agent/agent-registry.service.js +477 -0
  51. package/dist/core/auth/auth.service.js +10 -0
  52. package/dist/core/capability/capability.service.js +58 -0
  53. package/dist/core/config/config.schema.js +7 -0
  54. package/dist/core/config/config.service.js +10 -0
  55. package/dist/core/events/event-bus.service.js +83 -0
  56. package/dist/core/feature/feature.service.js +10 -0
  57. package/dist/core/lifecycle/lifecycle-state-machine.js +6 -0
  58. package/dist/core/logging/log-ring-buffer.js +6 -0
  59. package/dist/core/logging/logging.service.js +130 -0
  60. package/dist/core/logging/scoped-logger.js +6 -0
  61. package/dist/core/moleculer/cap-call-fn.js +50 -0
  62. package/dist/core/moleculer/cap-route-authority.js +122 -0
  63. package/dist/core/moleculer/moleculer.service.js +898 -0
  64. package/dist/core/network/network-quality.service.js +7 -0
  65. package/dist/core/notification/notification-wrapper.service.js +33 -0
  66. package/dist/core/notification/toast-wrapper.service.js +25 -0
  67. package/dist/core/provider/provider.tokens.js +4 -0
  68. package/dist/core/repl/repl-engine.service.js +140 -0
  69. package/dist/core/storage/fs-storage-backend.js +6 -0
  70. package/dist/core/storage/storage-location-manager.js +6 -0
  71. package/dist/core/storage/storage.service.js +7 -0
  72. package/dist/core/streaming/stream-probe.service.js +209 -0
  73. package/dist/core/topology/topology-emitter.service.js +106 -0
  74. package/dist/launcher.js +325 -0
  75. package/dist/main.js +1098 -0
  76. package/dist/manual-boot.js +227 -0
  77. package/package.json +5 -1
  78. package/src/__tests__/addon-install-e2e.test.ts +0 -74
  79. package/src/__tests__/addon-pages-e2e.test.ts +0 -200
  80. package/src/__tests__/addon-route-session.test.ts +0 -17
  81. package/src/__tests__/addon-settings-router.spec.ts +0 -67
  82. package/src/__tests__/addon-upload.spec.ts +0 -475
  83. package/src/__tests__/agent-registry.spec.ts +0 -179
  84. package/src/__tests__/agent-status-page.spec.ts +0 -82
  85. package/src/__tests__/auth-session-cookie.test.ts +0 -48
  86. package/src/__tests__/bulk-update-coordinator.spec.ts +0 -303
  87. package/src/__tests__/cap-ownership-authority.spec.ts +0 -431
  88. package/src/__tests__/cap-providers/cap-providers-location-import.spec.ts +0 -206
  89. package/src/__tests__/cap-providers/cap-usage-graph.spec.ts +0 -37
  90. package/src/__tests__/cap-providers/compute-topology-categories.spec.ts +0 -110
  91. package/src/__tests__/cap-providers/integrations-delete-cascade.spec.ts +0 -292
  92. package/src/__tests__/cap-providers-bulk-update.spec.ts +0 -408
  93. package/src/__tests__/cap-route-adapter.spec.ts +0 -302
  94. package/src/__tests__/cap-routers/_meta.spec.ts +0 -199
  95. package/src/__tests__/cap-routers/addon-settings.router.spec.ts +0 -115
  96. package/src/__tests__/cap-routers/broker-routing.router.spec.ts +0 -177
  97. package/src/__tests__/cap-routers/cap-route-error-formatter.spec.ts +0 -125
  98. package/src/__tests__/cap-routers/capabilities-node.spec.ts +0 -68
  99. package/src/__tests__/cap-routers/device-link-overlay.spec.ts +0 -137
  100. package/src/__tests__/cap-routers/device-manager-aggregate.router.spec.ts +0 -194
  101. package/src/__tests__/cap-routers/harness.ts +0 -163
  102. package/src/__tests__/cap-routers/metrics-provider.router.spec.ts +0 -133
  103. package/src/__tests__/cap-routers/null-provider-guard.spec.ts +0 -64
  104. package/src/__tests__/cap-routers/pipeline-executor.router.spec.ts +0 -159
  105. package/src/__tests__/cap-routers/settings-store.router.spec.ts +0 -291
  106. package/src/__tests__/capability-e2e.test.ts +0 -384
  107. package/src/__tests__/cli-e2e.test.ts +0 -150
  108. package/src/__tests__/core-cap-bridge.spec.ts +0 -91
  109. package/src/__tests__/dev-bootstrap-shm-ring.spec.ts +0 -40
  110. package/src/__tests__/device-settings-contribution-dispatch.spec.ts +0 -280
  111. package/src/__tests__/embedded-deps-e2e.test.ts +0 -125
  112. package/src/__tests__/event-bus-proxy-router.spec.ts +0 -75
  113. package/src/__tests__/fixtures/mock-analysis-addon-a.ts +0 -37
  114. package/src/__tests__/fixtures/mock-analysis-addon-b.ts +0 -37
  115. package/src/__tests__/fixtures/mock-log-addon.ts +0 -37
  116. package/src/__tests__/fixtures/mock-storage-addon.ts +0 -40
  117. package/src/__tests__/framework-allowlist.spec.ts +0 -96
  118. package/src/__tests__/framework-installer-defer-restart.spec.ts +0 -165
  119. package/src/__tests__/https-e2e.test.ts +0 -124
  120. package/src/__tests__/lifecycle-e2e.test.ts +0 -189
  121. package/src/__tests__/live-events-subscription.spec.ts +0 -149
  122. package/src/__tests__/moleculer/uds-readiness.spec.ts +0 -150
  123. package/src/__tests__/moleculer/uds-topology.spec.ts +0 -418
  124. package/src/__tests__/moleculer/uds-unowned-call.spec.ts +0 -383
  125. package/src/__tests__/moleculer-register-node-idempotency.spec.ts +0 -273
  126. package/src/__tests__/native-cap-route.spec.ts +0 -427
  127. package/src/__tests__/oauth2-account-linking.spec.ts +0 -867
  128. package/src/__tests__/post-boot-restart.spec.ts +0 -161
  129. package/src/__tests__/singleton-contention.test.ts +0 -499
  130. package/src/__tests__/streaming-diagnostic.test.ts +0 -615
  131. package/src/__tests__/streaming-scale.test.ts +0 -314
  132. package/src/__tests__/uds-addon-call-wiring.spec.ts +0 -242
  133. package/src/__tests__/uds-log-ingest.spec.ts +0 -183
  134. package/src/api/__tests__/addons-custom.spec.ts +0 -148
  135. package/src/api/__tests__/capabilities.router.test.ts +0 -56
  136. package/src/api/addon-upload.ts +0 -529
  137. package/src/api/addons-custom.router.ts +0 -101
  138. package/src/api/auth-whoami.ts +0 -101
  139. package/src/api/bridge-addons.router.ts +0 -122
  140. package/src/api/capabilities.router.ts +0 -265
  141. package/src/api/core/__tests__/auth-router-totp.spec.ts +0 -297
  142. package/src/api/core/__tests__/integration-markers.spec.ts +0 -10
  143. package/src/api/core/addon-settings.router.ts +0 -127
  144. package/src/api/core/agents.router.ts +0 -86
  145. package/src/api/core/auth.router.ts +0 -322
  146. package/src/api/core/bulk-update-coordinator.ts +0 -305
  147. package/src/api/core/cap-providers.ts +0 -1339
  148. package/src/api/core/capabilities.router.ts +0 -149
  149. package/src/api/core/collection-preference.ts +0 -40
  150. package/src/api/core/event-bus-proxy.router.ts +0 -45
  151. package/src/api/core/hwaccel.router.ts +0 -108
  152. package/src/api/core/live-events.router.ts +0 -67
  153. package/src/api/core/logs.router.ts +0 -195
  154. package/src/api/core/notifications.router.ts +0 -66
  155. package/src/api/core/repl.router.ts +0 -39
  156. package/src/api/core/settings-backend.router.ts +0 -140
  157. package/src/api/core/stream-probe.router.ts +0 -57
  158. package/src/api/core/system-events.router.ts +0 -125
  159. package/src/api/health/health.routes.ts +0 -117
  160. package/src/api/oauth2/__tests__/oauth2-routes.spec.ts +0 -62
  161. package/src/api/oauth2/oauth2-routes.ts +0 -281
  162. package/src/api/trpc/__tests__/client-ip.spec.ts +0 -146
  163. package/src/api/trpc/__tests__/scope-access-device.spec.ts +0 -268
  164. package/src/api/trpc/__tests__/scope-access.spec.ts +0 -102
  165. package/src/api/trpc/__tests__/webrtc-session-ua-enrich.spec.ts +0 -136
  166. package/src/api/trpc/cap-mount-helpers.ts +0 -245
  167. package/src/api/trpc/cap-route-error-formatter.ts +0 -171
  168. package/src/api/trpc/client-ip.ts +0 -147
  169. package/src/api/trpc/core-cap-bridge.ts +0 -154
  170. package/src/api/trpc/generated-cap-mounts.ts +0 -1240
  171. package/src/api/trpc/generated-cap-routers.ts +0 -11523
  172. package/src/api/trpc/scope-access.ts +0 -110
  173. package/src/api/trpc/trpc.context.ts +0 -258
  174. package/src/api/trpc/trpc.middleware.ts +0 -146
  175. package/src/api/trpc/trpc.router.ts +0 -389
  176. package/src/auth/session-cookie.ts +0 -54
  177. package/src/boot/__tests__/integration-id-backfill.spec.ts +0 -131
  178. package/src/boot/boot-config.ts +0 -259
  179. package/src/boot/integration-id-backfill.ts +0 -109
  180. package/src/boot/post-boot.service.ts +0 -105
  181. package/src/core/addon/__tests__/addon-registry-capability.test.ts +0 -62
  182. package/src/core/addon/__tests__/addon-row-manifest.spec.ts +0 -62
  183. package/src/core/addon/addon-call-gateway.ts +0 -171
  184. package/src/core/addon/addon-package.service.ts +0 -1787
  185. package/src/core/addon/addon-registry.service.ts +0 -3130
  186. package/src/core/addon/addon-search.service.ts +0 -91
  187. package/src/core/addon/addon-settings-provider.ts +0 -220
  188. package/src/core/addon/addon.tokens.ts +0 -2
  189. package/src/core/addon-bridge/addon-bridge.service.ts +0 -130
  190. package/src/core/addon-pages/addon-pages.service.spec.ts +0 -117
  191. package/src/core/addon-pages/addon-pages.service.ts +0 -82
  192. package/src/core/addon-widgets/addon-widgets.service.ts +0 -95
  193. package/src/core/agent/agent-registry.service.ts +0 -529
  194. package/src/core/auth/auth.service.spec.ts +0 -86
  195. package/src/core/auth/auth.service.ts +0 -8
  196. package/src/core/capability/capability.service.ts +0 -66
  197. package/src/core/config/config.schema.ts +0 -3
  198. package/src/core/config/config.service.spec.ts +0 -175
  199. package/src/core/config/config.service.ts +0 -7
  200. package/src/core/events/event-bus.service.spec.ts +0 -235
  201. package/src/core/events/event-bus.service.ts +0 -89
  202. package/src/core/feature/feature.service.spec.ts +0 -99
  203. package/src/core/feature/feature.service.ts +0 -8
  204. package/src/core/lifecycle/lifecycle-state-machine.spec.ts +0 -166
  205. package/src/core/lifecycle/lifecycle-state-machine.ts +0 -3
  206. package/src/core/logging/log-ring-buffer.ts +0 -3
  207. package/src/core/logging/logging.service.spec.ts +0 -287
  208. package/src/core/logging/logging.service.ts +0 -143
  209. package/src/core/logging/scoped-logger.ts +0 -3
  210. package/src/core/moleculer/cap-call-fn.spec.ts +0 -173
  211. package/src/core/moleculer/cap-call-fn.ts +0 -107
  212. package/src/core/moleculer/cap-route-authority.ts +0 -194
  213. package/src/core/moleculer/moleculer.service.ts +0 -1072
  214. package/src/core/network/network-quality.service.spec.ts +0 -53
  215. package/src/core/network/network-quality.service.ts +0 -5
  216. package/src/core/notification/notification-wrapper.service.ts +0 -34
  217. package/src/core/notification/toast-wrapper.service.ts +0 -27
  218. package/src/core/provider/provider.tokens.ts +0 -1
  219. package/src/core/repl/repl-engine.service.spec.ts +0 -444
  220. package/src/core/repl/repl-engine.service.ts +0 -155
  221. package/src/core/storage/fs-storage-backend.spec.ts +0 -70
  222. package/src/core/storage/fs-storage-backend.ts +0 -3
  223. package/src/core/storage/storage-location-manager.spec.ts +0 -130
  224. package/src/core/storage/storage-location-manager.ts +0 -3
  225. package/src/core/storage/storage.service.spec.ts +0 -73
  226. package/src/core/storage/storage.service.ts +0 -3
  227. package/src/core/streaming/stream-probe.service.ts +0 -221
  228. package/src/core/topology/topology-emitter.service.ts +0 -105
  229. package/src/launcher.ts +0 -314
  230. package/src/main.ts +0 -1245
  231. package/src/manual-boot.ts +0 -301
  232. package/tsconfig.build.json +0 -8
  233. package/tsconfig.json +0 -33
  234. package/vitest.config.ts +0 -26
@@ -1,161 +0,0 @@
1
- /**
2
- * PostBootService restart-completed emission — boot-side handoff of the
3
- * `.restart-pending` marker into a `system.restart-completed` event.
4
- *
5
- * Spec: docs/superpowers/specs/2026-05-14-framework-live-update-design.md (P2)
6
- *
7
- * Invariants:
8
- * - Marker present at boot → event emitted with the marker's payload
9
- * AND the marker is gone after boot.
10
- * - No marker → no event of category `system.restart-completed`,
11
- * `system.boot` still fires.
12
- * - Boot is robust to a malformed marker (does not throw; just clears).
13
- */
14
- import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
15
- import * as fs from 'node:fs'
16
- import * as os from 'node:os'
17
- import * as path from 'node:path'
18
- import { writePendingRestart, getRestartMarkerPath } from '@camstack/kernel'
19
- import type { IEventBus, IScopedLogger, SystemEvent } from '@camstack/types'
20
- import { PostBootService } from '../boot/post-boot.service.js'
21
- import { AddonRegistryService } from '../core/addon/addon-registry.service.js'
22
- import { EventBusService } from '../core/events/event-bus.service.js'
23
- import { LoggingService } from '../core/logging/logging.service.js'
24
-
25
- interface CapturedEvent {
26
- readonly category: string
27
- readonly data: Record<string, unknown>
28
- }
29
-
30
- function createEnv(dataDir: string): {
31
- service: PostBootService
32
- captured: CapturedEvent[]
33
- } {
34
- const captured: CapturedEvent[] = []
35
- const bus: Pick<IEventBus, 'emit'> = {
36
- emit: (event: SystemEvent) => {
37
- captured.push({ category: event.category, data: event.data as Record<string, unknown> })
38
- },
39
- }
40
- const logger: IScopedLogger = {
41
- info: () => undefined,
42
- warn: () => undefined,
43
- error: () => undefined,
44
- debug: () => undefined,
45
- trace: () => undefined,
46
- fatal: () => undefined,
47
- child: (() => logger) as IScopedLogger['child'],
48
- } as unknown as IScopedLogger
49
-
50
- const loggingService = {
51
- createLogger: () => logger,
52
- } as unknown as LoggingService
53
-
54
- const service = new PostBootService(
55
- {} as unknown as AddonRegistryService,
56
- bus as unknown as EventBusService,
57
- loggingService,
58
- )
59
- return { service, captured }
60
- }
61
-
62
- let tmpDir: string
63
-
64
- beforeEach(() => {
65
- tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'post-boot-'))
66
- })
67
-
68
- afterEach(() => {
69
- fs.rmSync(tmpDir, { recursive: true, force: true })
70
- vi.restoreAllMocks()
71
- })
72
-
73
- describe('PostBootService restart-completed handoff', () => {
74
- it('emits system.restart-completed with the marker payload when a marker is present', async () => {
75
- writePendingRestart(tmpDir, {
76
- kind: 'framework-update',
77
- packageName: '@camstack/core',
78
- fromVersion: '0.1.36',
79
- toVersion: '0.1.37',
80
- requestedBy: 'admin',
81
- requestedAt: 1715717834567,
82
- })
83
-
84
- const { service, captured } = createEnv(tmpDir)
85
- await service.run({ port: 0, host: 'localhost', dataPath: tmpDir, trpcRegistered: false })
86
-
87
- const completed = captured.find((e) => e.category === 'system.restart-completed')
88
- expect(completed).toBeDefined()
89
- expect(completed?.data).toMatchObject({
90
- kind: 'framework-update',
91
- packageName: '@camstack/core',
92
- fromVersion: '0.1.36',
93
- toVersion: '0.1.37',
94
- requestedBy: 'admin',
95
- requestedAt: 1715717834567,
96
- })
97
-
98
- expect(fs.existsSync(getRestartMarkerPath(tmpDir))).toBe(false)
99
- })
100
-
101
- it('still emits system.boot when no marker is present and does not emit system.restart-completed', async () => {
102
- const { service, captured } = createEnv(tmpDir)
103
- await service.run({ port: 0, host: 'localhost', dataPath: tmpDir, trpcRegistered: false })
104
-
105
- expect(captured.some((e) => e.category === 'system.boot')).toBe(true)
106
- expect(captured.some((e) => e.category === 'system.restart-completed')).toBe(false)
107
- })
108
-
109
- it('does not throw and clears the marker when the marker is malformed', async () => {
110
- fs.writeFileSync(getRestartMarkerPath(tmpDir), '{ broken', 'utf-8')
111
-
112
- const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => undefined)
113
- const { service, captured } = createEnv(tmpDir)
114
- await service.run({ port: 0, host: 'localhost', dataPath: tmpDir, trpcRegistered: false })
115
-
116
- expect(captured.some((e) => e.category === 'system.boot')).toBe(true)
117
- expect(captured.some((e) => e.category === 'system.restart-completed')).toBe(false)
118
- expect(fs.existsSync(getRestartMarkerPath(tmpDir))).toBe(false)
119
- expect(errorSpy).toHaveBeenCalled()
120
- })
121
- })
122
-
123
- describe('PostBootService.getLastRestart retention window', () => {
124
- it('returns the marker emitted this boot, then null after the retention window', async () => {
125
- writePendingRestart(tmpDir, {
126
- kind: 'framework-update',
127
- packageName: '@camstack/core',
128
- fromVersion: '0.1.36',
129
- toVersion: '0.1.37',
130
- requestedBy: 'admin',
131
- requestedAt: 1715717834567,
132
- })
133
-
134
- const { service } = createEnv(tmpDir)
135
- await service.run({ port: 0, host: 'localhost', dataPath: tmpDir, trpcRegistered: false })
136
-
137
- // Immediately after boot the marker is queryable.
138
- const fresh = PostBootService.getLastRestart()
139
- expect(fresh).not.toBeNull()
140
- expect(fresh?.packageName).toBe('@camstack/core')
141
-
142
- // Past the retention window it auto-expires.
143
- vi.useFakeTimers()
144
- vi.setSystemTime(Date.now() + PostBootService.LAST_RESTART_RETENTION_MS + 1)
145
- expect(PostBootService.getLastRestart()).toBeNull()
146
- vi.useRealTimers()
147
- })
148
-
149
- it('returns null when boot was not triggered by a restart marker', async () => {
150
- // Reset the static cache from any earlier test.
151
- const dummyDir = fs.mkdtempSync(path.join(os.tmpdir(), 'post-boot-empty-'))
152
- const { service } = createEnv(dummyDir)
153
- await service.run({ port: 0, host: 'localhost', dataPath: dummyDir, trpcRegistered: false })
154
-
155
- // Note: this test passes whether or not a previous test populated
156
- // lastRestart since `lastRestart` is per-test-process state. The
157
- // assertion checks the public guarantee: no marker => no cached
158
- // payload from THIS boot. We don't depend on cross-test isolation.
159
- fs.rmSync(dummyDir, { recursive: true, force: true })
160
- })
161
- })
@@ -1,499 +0,0 @@
1
- /* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access -- test file, mock typing */
2
- // server/backend/src/__tests__/singleton-contention.test.ts
3
- //
4
- // Server-level E2E tests for SINGLETON CAPABILITY CONTENTION: the scenario
5
- // where two addons both register a provider for the same `mode: 'singleton'`
6
- // capability. Regression coverage for the production collision where
7
- // `decoder-nodeav` and `decoder-ffmpeg` both registered the singleton
8
- // `decoder` cap.
9
- //
10
- // NOTE: file is intentionally NOT named `*-e2e.test.ts` — `vitest.config.ts`
11
- // excludes the `**/*e2e*.test.ts` glob (those are full-server-boot suites).
12
- // This suite uses the lightweight `TestAddonHarness` and runs in the default
13
- // `npm run test` pass.
14
- //
15
- // Mirrors the `TestAddonHarness` style of `capability-e2e.test.ts` and reuses
16
- // the `mock-analysis-addon-a` / `mock-analysis-addon-b` fixtures — both of
17
- // which register the singleton `object-detector` cap, i.e. they ARE the
18
- // contention scenario.
19
- //
20
- import { describe, it, expect, vi, beforeEach } from 'vitest'
21
- import { CapabilityRegistry } from '@camstack/kernel'
22
- import type { IScopedLogger, CapabilityDeclaration } from '@camstack/types'
23
- import { MockAnalysisAddonA } from './fixtures/mock-analysis-addon-a'
24
- import { MockAnalysisAddonB } from './fixtures/mock-analysis-addon-b'
25
- import { MockStorageAddon } from './fixtures/mock-storage-addon'
26
- import type { ICamstackAddon } from '@camstack/types'
27
-
28
- // --- Helpers ----------------------------------------------------------------
29
-
30
- function createMockLogger(): IScopedLogger {
31
- return {
32
- error: vi.fn(),
33
- warn: vi.fn(),
34
- info: vi.fn(),
35
- debug: vi.fn(),
36
- child: vi.fn().mockReturnThis(),
37
- }
38
- }
39
-
40
- interface AddonEntry {
41
- readonly addon: ICamstackAddon
42
- initialized: boolean
43
- }
44
-
45
- /**
46
- * Lightweight harness that mirrors AddonRegistryService boot sequence
47
- * without requiring NestJS DI. Same shape as `capability-e2e.test.ts`'s
48
- * harness, trimmed to the methods the contention scenarios exercise.
49
- */
50
- class TestAddonHarness {
51
- readonly registry: CapabilityRegistry
52
- private readonly addonEntries = new Map<string, AddonEntry>()
53
-
54
- constructor(configPrefs: Record<string, string> = {}) {
55
- this.registry = new CapabilityRegistry(createMockLogger())
56
- this.registry.setConfigReader((cap) => configPrefs[cap])
57
- this.registry.ready()
58
- }
59
-
60
- /** Register an addon (mimics AddonRegistryService.registerAddon) */
61
- registerAddon(addon: ICamstackAddon): void {
62
- this.addonEntries.set(addon.manifest.id, { addon, initialized: false })
63
- }
64
-
65
- /** Declare capabilities from an addon manifest. Mode inferred per-name. */
66
- declareCapabilities(addon: ICamstackAddon): void {
67
- const caps = this.getAddonCapabilities(addon)
68
- for (const cap of caps) {
69
- const mode = cap.name === 'log-destination' ? ('collection' as const) : ('singleton' as const)
70
- this.registry.declareCapability({ name: cap.name, scope: 'system', mode, methods: {} })
71
- this.registry.declareFromManifest(cap)
72
- }
73
- }
74
-
75
- /** Initialize an addon and wire its capabilities into the registry. */
76
- async initializeAddon(id: string): Promise<void> {
77
- const entry = this.addonEntries.get(id)
78
- if (!entry) throw new Error(`Addon "${id}" not registered`)
79
- if (entry.initialized) return
80
-
81
- const self = this
82
- const context = {
83
- registerProvider(capName: string, provider: unknown) {
84
- self.registry.registerProvider(capName, id, provider)
85
- },
86
- } as any
87
- const result = await entry.addon.initialize(context)
88
- if (result) {
89
- const regs = Array.isArray(result) ? result : ((result as any).providers ?? [])
90
- for (const reg of regs) {
91
- const capName: string =
92
- typeof reg.capability === 'string'
93
- ? reg.capability
94
- : ((reg.capability as any)?.name ?? String(reg.capability))
95
- self.registry.registerProvider(capName, id, reg.provider)
96
- }
97
- }
98
- entry.initialized = true
99
- }
100
-
101
- /** Shutdown an addon and unregister its capabilities. */
102
- async shutdownAddon(id: string): Promise<void> {
103
- const entry = this.addonEntries.get(id)
104
- if (!entry) throw new Error(`Addon "${id}" not registered`)
105
-
106
- const caps = this.getAddonCapabilities(entry.addon)
107
- for (const cap of caps) {
108
- this.registry.unregisterProvider(cap.name, id)
109
- }
110
- await entry.addon.shutdown()
111
- entry.initialized = false
112
- }
113
-
114
- private getAddonCapabilities(addon: ICamstackAddon): CapabilityDeclaration[] {
115
- const manifest = addon.manifest as any
116
- if (!manifest.capabilities) return []
117
- return manifest.capabilities.map((cap: string | CapabilityDeclaration) => {
118
- if (typeof cap === 'string') {
119
- const decl: CapabilityDeclaration = { name: cap }
120
- return decl
121
- }
122
- return cap
123
- })
124
- }
125
- }
126
-
127
- // ---------------------------------------------------------------------------
128
- // 1. Two addons register the same singleton cap
129
- // ---------------------------------------------------------------------------
130
- describe('Singleton contention E2E: two addons on the same singleton cap', () => {
131
- it('first-registered addon wins as active; registry tracks BOTH providers', async () => {
132
- const harness = new TestAddonHarness()
133
- const analysisA = new MockAnalysisAddonA()
134
- const analysisB = new MockAnalysisAddonB()
135
-
136
- harness.registerAddon(analysisA)
137
- harness.registerAddon(analysisB)
138
- harness.declareCapabilities(analysisA)
139
- harness.declareCapabilities(analysisB)
140
-
141
- // A initializes first → it becomes the default active singleton.
142
- await harness.initializeAddon('mock-analysis-a')
143
- await harness.initializeAddon('mock-analysis-b')
144
-
145
- // Active resolution: first-registered wins (no configReader preference).
146
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisA.provider)
147
- expect(harness.registry.getSingletonAddonId('object-detector')).toBe('mock-analysis-a')
148
-
149
- // ...but the registry is aware of BOTH — B did not get rejected, it is a
150
- // legitimate alternative provider the operator can switch to.
151
- const info = harness.registry.listCapabilities().find((c) => c.name === 'object-detector')!
152
- expect(info.providers).toEqual(expect.arrayContaining(['mock-analysis-a', 'mock-analysis-b']))
153
- expect(info.providers).toHaveLength(2)
154
- expect(info.activeProvider).toBe('mock-analysis-a')
155
-
156
- // Both providers individually addressable.
157
- expect(harness.registry.getProviderByAddon('object-detector', 'mock-analysis-a')).toBe(
158
- analysisA.provider,
159
- )
160
- expect(harness.registry.getProviderByAddon('object-detector', 'mock-analysis-b')).toBe(
161
- analysisB.provider,
162
- )
163
- })
164
-
165
- it('honours a configReader preference for the SECOND addon over first-registered', async () => {
166
- // Operator persisted a preference for B (the decoder-ffmpeg-style case
167
- // where the non-default addon is the desired one).
168
- const harness = new TestAddonHarness({ 'object-detector': 'mock-analysis-b' })
169
- const analysisA = new MockAnalysisAddonA()
170
- const analysisB = new MockAnalysisAddonB()
171
-
172
- harness.registerAddon(analysisA)
173
- harness.registerAddon(analysisB)
174
- harness.declareCapabilities(analysisA)
175
- harness.declareCapabilities(analysisB)
176
-
177
- // A registers first, but configReader prefers B.
178
- await harness.initializeAddon('mock-analysis-a')
179
- await harness.initializeAddon('mock-analysis-b')
180
-
181
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisB.provider)
182
- expect(harness.registry.getSingletonAddonId('object-detector')).toBe('mock-analysis-b')
183
- })
184
- })
185
-
186
- // ---------------------------------------------------------------------------
187
- // 2. Consumer waits for the cap before any provider exists
188
- // ---------------------------------------------------------------------------
189
- describe('Singleton contention E2E: waitForProvider before registration', () => {
190
- it('a wait started before any provider resolves once the provider registers', async () => {
191
- const harness = new TestAddonHarness()
192
- const analysisA = new MockAnalysisAddonA()
193
-
194
- harness.registerAddon(analysisA)
195
- harness.declareCapabilities(analysisA)
196
-
197
- // Consumer begins waiting BEFORE the addon initializes — no provider yet.
198
- const waitPromise = harness.registry.waitForProvider(
199
- 'object-detector',
200
- 'mock-analysis-a',
201
- 5_000,
202
- )
203
-
204
- // Addon initializes shortly after → registerProvider fulfils the waiter.
205
- setTimeout(() => {
206
- void harness.initializeAddon('mock-analysis-a')
207
- }, 10)
208
-
209
- const resolved = await waitPromise
210
- expect(resolved).toBe(analysisA.provider)
211
- })
212
-
213
- it('a wait for addon B is NOT fulfilled when only addon A registers for the same singleton cap', async () => {
214
- const harness = new TestAddonHarness()
215
- const analysisA = new MockAnalysisAddonA()
216
- const analysisB = new MockAnalysisAddonB()
217
-
218
- harness.registerAddon(analysisA)
219
- harness.registerAddon(analysisB)
220
- harness.declareCapabilities(analysisA)
221
- harness.declareCapabilities(analysisB)
222
-
223
- // Consumer waits specifically for B's provider.
224
- let resolved = false
225
- const waitPromise = harness.registry
226
- .waitForProvider('object-detector', 'mock-analysis-b', 200)
227
- .then((p) => {
228
- resolved = true
229
- return p
230
- })
231
-
232
- // Only A registers — same cap, different addon. Must NOT unblock the wait.
233
- await harness.initializeAddon('mock-analysis-a')
234
-
235
- const result = await waitPromise
236
- expect(resolved).toBe(true)
237
- expect(result).toBeNull() // timed out — the wait keyed on (cap, addonId)
238
- })
239
- })
240
-
241
- // ---------------------------------------------------------------------------
242
- // 3. The active provider is removed/unregistered
243
- // ---------------------------------------------------------------------------
244
- describe('Singleton contention E2E: active provider removed', () => {
245
- it('removing the ACTIVE provider promotes the still-registered B', async () => {
246
- const harness = new TestAddonHarness()
247
- const analysisA = new MockAnalysisAddonA()
248
- const analysisB = new MockAnalysisAddonB()
249
-
250
- harness.registerAddon(analysisA)
251
- harness.registerAddon(analysisB)
252
- harness.declareCapabilities(analysisA)
253
- harness.declareCapabilities(analysisB)
254
-
255
- await harness.initializeAddon('mock-analysis-a') // A → active
256
- await harness.initializeAddon('mock-analysis-b') // B → registered, inactive
257
-
258
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisA.provider)
259
-
260
- // Remove the active provider A.
261
- await harness.shutdownAddon('mock-analysis-a')
262
-
263
- // `unregisterProvider` promotes the still-registered B instead of
264
- // leaving the singleton cap dead. With no `configReader` preference it
265
- // falls back to the first remaining provider — here `mock-analysis-b`.
266
- // (Regression anchor for the decoder-ffmpeg/decoder-nodeav incident:
267
- // uninstalling one decoder addon must not take the cap offline.)
268
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisB.provider)
269
- expect(harness.registry.getSingletonAddonId('object-detector')).toBe('mock-analysis-b')
270
-
271
- const info = harness.registry.listCapabilities().find((c) => c.name === 'object-detector')!
272
- expect(info.providers).toEqual(['mock-analysis-b'])
273
- expect(info.activeProvider).toBe('mock-analysis-b')
274
- expect(harness.registry.getProviderByAddon('object-detector', 'mock-analysis-b')).toBe(
275
- analysisB.provider,
276
- )
277
- })
278
-
279
- it('removing a NON-active provider keeps the active one untouched', async () => {
280
- const harness = new TestAddonHarness()
281
- const analysisA = new MockAnalysisAddonA()
282
- const analysisB = new MockAnalysisAddonB()
283
-
284
- harness.registerAddon(analysisA)
285
- harness.registerAddon(analysisB)
286
- harness.declareCapabilities(analysisA)
287
- harness.declareCapabilities(analysisB)
288
-
289
- await harness.initializeAddon('mock-analysis-a') // A → active
290
- await harness.initializeAddon('mock-analysis-b') // B → inactive
291
-
292
- // Remove the INACTIVE provider B.
293
- await harness.shutdownAddon('mock-analysis-b')
294
-
295
- // A stays active and resolvable — no disturbance.
296
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisA.provider)
297
- expect(harness.registry.getSingletonAddonId('object-detector')).toBe('mock-analysis-a')
298
- const info = harness.registry.listCapabilities().find((c) => c.name === 'object-detector')!
299
- expect(info.providers).toEqual(['mock-analysis-a'])
300
- })
301
- })
302
-
303
- // ---------------------------------------------------------------------------
304
- // 4. Re-registration after removal
305
- // ---------------------------------------------------------------------------
306
- describe('Singleton contention E2E: re-registration after removal', () => {
307
- it('re-registering A after removal does not displace the promoted B', async () => {
308
- const harness = new TestAddonHarness()
309
- const analysisA = new MockAnalysisAddonA()
310
- const analysisB = new MockAnalysisAddonB()
311
-
312
- harness.registerAddon(analysisA)
313
- harness.registerAddon(analysisB)
314
- harness.declareCapabilities(analysisA)
315
- harness.declareCapabilities(analysisB)
316
-
317
- await harness.initializeAddon('mock-analysis-a') // A → active
318
- await harness.initializeAddon('mock-analysis-b') // B → inactive
319
-
320
- // Remove A → B is promoted to active (see scenario 3).
321
- await harness.shutdownAddon('mock-analysis-a')
322
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisB.provider)
323
-
324
- // Re-register A. `registerProvider`'s singleton branch only auto-promotes
325
- // a fresh provider when `activeAddonId === null` — but B already holds it,
326
- // so A re-registers without displacing B. (An operator who wants A back
327
- // active switches it explicitly via setActiveSingleton.)
328
- await harness.initializeAddon('mock-analysis-a')
329
-
330
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisB.provider)
331
- expect(harness.registry.getSingletonAddonId('object-detector')).toBe('mock-analysis-b')
332
- const info = harness.registry.listCapabilities().find((c) => c.name === 'object-detector')!
333
- expect(info.providers).toEqual(expect.arrayContaining(['mock-analysis-a', 'mock-analysis-b']))
334
- expect(info.providers).toHaveLength(2)
335
- })
336
-
337
- it('re-registering the SAME (cap, addonId) pair without unregistering first throws', async () => {
338
- const harness = new TestAddonHarness()
339
- const analysisA = new MockAnalysisAddonA()
340
-
341
- harness.registerAddon(analysisA)
342
- harness.declareCapabilities(analysisA)
343
- await harness.initializeAddon('mock-analysis-a')
344
-
345
- // Double-register of the same pair is a programmer error — the registry
346
- // throws rather than silently replacing the provider.
347
- expect(() =>
348
- harness.registry.registerProvider('object-detector', 'mock-analysis-a', { id: 'dup' }),
349
- ).toThrow(/already registered/)
350
- // Original provider preserved.
351
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisA.provider)
352
- })
353
- })
354
-
355
- // ---------------------------------------------------------------------------
356
- // 5. setActiveSingleton switching
357
- // ---------------------------------------------------------------------------
358
- describe('Singleton contention E2E: setActiveSingleton switching', () => {
359
- let harness: TestAddonHarness
360
- let analysisA: MockAnalysisAddonA
361
- let analysisB: MockAnalysisAddonB
362
-
363
- beforeEach(async () => {
364
- harness = new TestAddonHarness()
365
- analysisA = new MockAnalysisAddonA()
366
- analysisB = new MockAnalysisAddonB()
367
-
368
- harness.registerAddon(analysisA)
369
- harness.registerAddon(analysisB)
370
- harness.declareCapabilities(analysisA)
371
- harness.declareCapabilities(analysisB)
372
-
373
- await harness.initializeAddon('mock-analysis-a')
374
- await harness.initializeAddon('mock-analysis-b')
375
- })
376
-
377
- it('explicitly switching the active singleton flips resolution A → B → A', async () => {
378
- // Default: A (first registered).
379
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisA.provider)
380
-
381
- // Switch to B.
382
- await harness.registry.setActiveSingleton('object-detector', 'mock-analysis-b')
383
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisB.provider)
384
- expect(harness.registry.getSingletonAddonId('object-detector')).toBe('mock-analysis-b')
385
-
386
- // Switch back to A.
387
- await harness.registry.setActiveSingleton('object-detector', 'mock-analysis-a')
388
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisA.provider)
389
- expect(harness.registry.getSingletonAddonId('object-detector')).toBe('mock-analysis-a')
390
- })
391
-
392
- it('setActiveSingleton throws when switching to an addon that never registered', async () => {
393
- await expect(
394
- harness.registry.setActiveSingleton('object-detector', 'mock-analysis-c'),
395
- ).rejects.toThrow(/[Nn]o provider/)
396
- // Active pointer unchanged after the failed switch.
397
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisA.provider)
398
- })
399
-
400
- it('unregistering the explicitly-selected active provider promotes the remaining one', async () => {
401
- // Operator explicitly selected B.
402
- await harness.registry.setActiveSingleton('object-detector', 'mock-analysis-b')
403
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisB.provider)
404
-
405
- // B is removed. `unregisterProvider` promotes the remaining A rather
406
- // than leaving the cap dead — `setActiveSingleton` set only the
407
- // in-memory pointer, not a persisted `configReader` preference, so the
408
- // fallback picks the first remaining provider.
409
- await harness.shutdownAddon('mock-analysis-b')
410
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisA.provider)
411
- expect(harness.registry.getSingletonAddonId('object-detector')).toBe('mock-analysis-a')
412
- expect(harness.registry.getProviderByAddon('object-detector', 'mock-analysis-a')).toBe(
413
- analysisA.provider,
414
- )
415
- })
416
- })
417
-
418
- // ---------------------------------------------------------------------------
419
- // 6. Teardown / race edges
420
- // ---------------------------------------------------------------------------
421
- describe('Singleton contention E2E: teardown and race edges', () => {
422
- it('a pending wait stays pending (then times out) when the would-have-matched provider is removed before it registers again', async () => {
423
- const harness = new TestAddonHarness()
424
- const analysisA = new MockAnalysisAddonA()
425
-
426
- harness.registerAddon(analysisA)
427
- harness.declareCapabilities(analysisA)
428
-
429
- // A registers, then is torn down — cap currently has no provider.
430
- await harness.initializeAddon('mock-analysis-a')
431
- await harness.shutdownAddon('mock-analysis-a')
432
-
433
- // Consumer starts waiting for A AFTER it was torn down.
434
- let resolved = false
435
- const waitPromise = harness.registry
436
- .waitForProvider('object-detector', 'mock-analysis-a', 150)
437
- .then((p) => {
438
- resolved = true
439
- return p
440
- })
441
-
442
- // `unregisterProvider` does NOT touch `pendingWaiters`, and nothing
443
- // re-registers A — so the waiter simply times out to null. This pins the
444
- // teardown contract: removing a provider never spuriously resolves or
445
- // rejects an outstanding wait for that (cap, addonId).
446
- const result = await waitPromise
447
- expect(resolved).toBe(true)
448
- expect(result).toBeNull()
449
- })
450
-
451
- it('a wait pending across a contention swap resolves only for its OWN addonId', async () => {
452
- const harness = new TestAddonHarness()
453
- const analysisA = new MockAnalysisAddonA()
454
- const analysisB = new MockAnalysisAddonB()
455
-
456
- harness.registerAddon(analysisA)
457
- harness.registerAddon(analysisB)
458
- harness.declareCapabilities(analysisA)
459
- harness.declareCapabilities(analysisB)
460
-
461
- // Two consumers wait concurrently — one for A, one for B.
462
- const waitForA = harness.registry.waitForProvider('object-detector', 'mock-analysis-a', 5_000)
463
- const waitForB = harness.registry.waitForProvider('object-detector', 'mock-analysis-b', 5_000)
464
-
465
- // B registers first this time, then A.
466
- await harness.initializeAddon('mock-analysis-b')
467
- await harness.initializeAddon('mock-analysis-a')
468
-
469
- const [resolvedA, resolvedB] = await Promise.all([waitForA, waitForB])
470
- expect(resolvedA).toBe(analysisA.provider)
471
- expect(resolvedB).toBe(analysisB.provider)
472
-
473
- // B registered first → B is the active singleton despite both being present.
474
- expect(harness.registry.getSingleton('object-detector')).toBe(analysisB.provider)
475
- })
476
-
477
- it('full teardown of both contending addons leaves the cap declared but empty', async () => {
478
- const harness = new TestAddonHarness()
479
- const analysisA = new MockAnalysisAddonA()
480
- const analysisB = new MockAnalysisAddonB()
481
-
482
- harness.registerAddon(analysisA)
483
- harness.registerAddon(analysisB)
484
- harness.declareCapabilities(analysisA)
485
- harness.declareCapabilities(analysisB)
486
-
487
- await harness.initializeAddon('mock-analysis-a')
488
- await harness.initializeAddon('mock-analysis-b')
489
- await harness.shutdownAddon('mock-analysis-a')
490
- await harness.shutdownAddon('mock-analysis-b')
491
-
492
- expect(harness.registry.getSingleton('object-detector')).toBeNull()
493
- expect(harness.registry.has('object-detector')).toBe(true) // still declared
494
- expect(harness.registry.isAvailable('object-detector')).toBe(false) // no providers
495
- const info = harness.registry.listCapabilities().find((c) => c.name === 'object-detector')!
496
- expect(info.providers).toHaveLength(0)
497
- expect(info.activeProvider).toBeNull()
498
- })
499
- })