@serfab/cadre-host 0.9.0 → 0.11.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.
Files changed (213) hide show
  1. package/dist/auth/index.d.ts +2 -0
  2. package/dist/auth/index.js +1 -0
  3. package/dist/auth/index.js.map +1 -1
  4. package/dist/auth/self-label.d.ts +36 -0
  5. package/dist/auth/self-label.js +57 -0
  6. package/dist/auth/self-label.js.map +1 -0
  7. package/dist/auth/trust-circle.d.ts +32 -5
  8. package/dist/auth/trust-circle.js +31 -11
  9. package/dist/auth/trust-circle.js.map +1 -1
  10. package/dist/bin/host.js +41 -5
  11. package/dist/bin/host.js.map +1 -1
  12. package/dist/donation/__tests__/fake-orchestrator.d.ts +103 -0
  13. package/dist/donation/__tests__/fake-orchestrator.js +180 -0
  14. package/dist/donation/__tests__/fake-orchestrator.js.map +1 -0
  15. package/dist/donation/donation-service.d.ts +237 -12
  16. package/dist/donation/donation-service.js +491 -34
  17. package/dist/donation/donation-service.js.map +1 -1
  18. package/dist/donation/donation-store.d.ts +7 -0
  19. package/dist/donation/donation-store.js +7 -0
  20. package/dist/donation/donation-store.js.map +1 -1
  21. package/dist/donation/donation-supervisor.d.ts +167 -0
  22. package/dist/donation/donation-supervisor.js +341 -0
  23. package/dist/donation/donation-supervisor.js.map +1 -0
  24. package/dist/donation/index.d.ts +4 -2
  25. package/dist/donation/index.js +2 -1
  26. package/dist/donation/index.js.map +1 -1
  27. package/dist/donation/types.d.ts +26 -0
  28. package/dist/donation/types.js.map +1 -1
  29. package/dist/index.d.ts +3 -1
  30. package/dist/index.js +3 -1
  31. package/dist/index.js.map +1 -1
  32. package/dist/orchestrator/host-process-orchestrator.d.ts +109 -5
  33. package/dist/orchestrator/host-process-orchestrator.js +341 -98
  34. package/dist/orchestrator/host-process-orchestrator.js.map +1 -1
  35. package/dist/orchestrator/node-identity.d.ts +26 -0
  36. package/dist/orchestrator/node-identity.js +36 -0
  37. package/dist/orchestrator/node-identity.js.map +1 -0
  38. package/dist/orchestrator/port-allocator.d.ts +14 -0
  39. package/dist/orchestrator/port-allocator.js +45 -0
  40. package/dist/orchestrator/port-allocator.js.map +1 -1
  41. package/dist/owner/owner-node-client.d.ts +20 -5
  42. package/dist/owner/owner-node-client.js +21 -4
  43. package/dist/owner/owner-node-client.js.map +1 -1
  44. package/dist/server/error-handler.d.ts +7 -1
  45. package/dist/server/error-handler.js +23 -1
  46. package/dist/server/error-handler.js.map +1 -1
  47. package/dist/server/events/types.d.ts +3 -0
  48. package/dist/server/index.d.ts +7 -0
  49. package/dist/server/index.js +9 -3
  50. package/dist/server/index.js.map +1 -1
  51. package/dist/server/routes/grants.js +22 -3
  52. package/dist/server/routes/grants.js.map +1 -1
  53. package/dist/server/routes/strands.d.ts +20 -0
  54. package/dist/server/routes/strands.js +38 -0
  55. package/dist/server/routes/strands.js.map +1 -0
  56. package/dist/server/static.js +38 -38
  57. package/dist/strands/index.d.ts +7 -0
  58. package/dist/strands/index.js +6 -0
  59. package/dist/strands/index.js.map +1 -0
  60. package/dist/strands/strand-service.d.ts +50 -0
  61. package/dist/strands/strand-service.js +103 -0
  62. package/dist/strands/strand-service.js.map +1 -0
  63. package/dist/strands/types.d.ts +93 -0
  64. package/dist/strands/types.js +23 -0
  65. package/dist/strands/types.js.map +1 -0
  66. package/dist/ui/assets/index-BVoqLjyX.css +1 -0
  67. package/dist/ui/assets/index-C-iks41M.js +17 -0
  68. package/dist/ui/assets/index-C-iks41M.js.map +1 -0
  69. package/dist/ui/index.html +14 -14
  70. package/dist/update/release-key.d.ts +1 -1
  71. package/dist/update/release-key.js +1 -1
  72. package/package.json +5 -5
  73. package/service/cadre-host.service.tmpl +16 -16
  74. package/service/com.serfab.cadre-host.plist.tmpl +35 -35
  75. package/service/install-service.ps1 +98 -98
  76. package/service/uninstall-service.ps1 +19 -19
  77. package/src/__tests__/build-targets.test.ts +26 -0
  78. package/src/__tests__/cli-invite.smoke.test.ts +192 -192
  79. package/src/__tests__/cli-nat.smoke.test.ts +212 -212
  80. package/src/__tests__/cli.smoke.test.ts +46 -46
  81. package/src/__tests__/global-setup.ts +51 -0
  82. package/src/__tests__/host-owner.smoke.test.ts +123 -123
  83. package/src/__tests__/orchestrator-env-scrub.test.ts +140 -0
  84. package/src/__tests__/orchestrator-node-identity.test.ts +204 -0
  85. package/src/__tests__/orchestrator-owner.test.ts +198 -198
  86. package/src/__tests__/orchestrator-pin-keys.test.ts +153 -153
  87. package/src/__tests__/orchestrator-push.test.ts +145 -145
  88. package/src/__tests__/orchestrator.test.ts +951 -570
  89. package/src/auth/__tests__/duration.test.ts +28 -28
  90. package/src/auth/__tests__/self-label.test.ts +85 -0
  91. package/src/auth/__tests__/trust-circle-integration.test.ts +152 -147
  92. package/src/auth/__tests__/trust-circle-store.test.ts +115 -115
  93. package/src/auth/__tests__/trust-circle.test.ts +445 -401
  94. package/src/auth/duration.ts +33 -33
  95. package/src/auth/index.ts +21 -19
  96. package/src/auth/self-label.ts +74 -0
  97. package/src/auth/trust-circle-store.ts +155 -155
  98. package/src/auth/trust-circle.ts +45 -13
  99. package/src/auth/types.ts +99 -99
  100. package/src/bin/host.ts +1299 -1258
  101. package/src/donation/__tests__/donation-service.test.ts +1068 -290
  102. package/src/donation/__tests__/donation-supervisor.test.ts +510 -0
  103. package/src/donation/__tests__/fake-orchestrator.test.ts +168 -0
  104. package/src/donation/__tests__/fake-orchestrator.ts +225 -0
  105. package/src/donation/__tests__/grant-service.test.ts +213 -213
  106. package/src/donation/__tests__/grant-store.test.ts +113 -113
  107. package/src/donation/donation-service.ts +962 -392
  108. package/src/donation/donation-store.ts +171 -164
  109. package/src/donation/donation-supervisor.ts +388 -0
  110. package/src/donation/grant-service.ts +200 -200
  111. package/src/donation/grant-store.ts +152 -152
  112. package/src/donation/index.ts +64 -49
  113. package/src/donation/types.ts +243 -220
  114. package/src/index.ts +14 -0
  115. package/src/installer/__tests__/identity.test.ts +34 -34
  116. package/src/installer/__tests__/paths.test.ts +47 -47
  117. package/src/installer/__tests__/service-host.test.ts +62 -62
  118. package/src/installer/__tests__/wizard.test.ts +64 -64
  119. package/src/installer/identity.ts +49 -49
  120. package/src/installer/paths.ts +109 -109
  121. package/src/installer/platform.ts +27 -27
  122. package/src/installer/service-host/index.ts +21 -21
  123. package/src/installer/service-host/template.ts +21 -21
  124. package/src/installer/wizard.ts +103 -103
  125. package/src/nat/__tests__/address-resolver.test.ts +82 -82
  126. package/src/nat/__tests__/ddns-duckdns.test.ts +83 -83
  127. package/src/nat/__tests__/ddns-updater.test.ts +253 -253
  128. package/src/nat/__tests__/external-ip.test.ts +124 -124
  129. package/src/nat/__tests__/nat-service.test.ts +497 -497
  130. package/src/nat/__tests__/nat-store.test.ts +93 -93
  131. package/src/nat/__tests__/port-mapper.test.ts +191 -191
  132. package/src/nat/__tests__/reachability.test.ts +24 -24
  133. package/src/nat/__tests__/secrets.test.ts +178 -178
  134. package/src/nat/address-resolver.ts +51 -51
  135. package/src/nat/ddns/duckdns.ts +76 -76
  136. package/src/nat/ddns/index.ts +55 -55
  137. package/src/nat/ddns/updater.ts +243 -243
  138. package/src/nat/external-ip.ts +154 -154
  139. package/src/nat/index.ts +71 -71
  140. package/src/nat/nat-service.ts +501 -501
  141. package/src/nat/nat-store.ts +154 -154
  142. package/src/nat/port-mapper.ts +329 -329
  143. package/src/nat/reachability.ts +34 -34
  144. package/src/nat/secrets/file-store.ts +130 -130
  145. package/src/nat/secrets/index.ts +112 -112
  146. package/src/nat/secrets/keytar-store.ts +67 -67
  147. package/src/nat/types.ts +159 -159
  148. package/src/orchestrator/__tests__/node-identity.test.ts +62 -0
  149. package/src/orchestrator/host-process-orchestrator.ts +1133 -894
  150. package/src/orchestrator/index.ts +10 -10
  151. package/src/orchestrator/log-rotator.ts +53 -53
  152. package/src/orchestrator/node-identity.ts +40 -0
  153. package/src/orchestrator/pid-liveness.ts +24 -24
  154. package/src/orchestrator/port-allocator.ts +91 -43
  155. package/src/orchestrator/state-store.ts +90 -90
  156. package/src/orchestrator/types.ts +141 -141
  157. package/src/owner/__tests__/owner-node-client.test.ts +194 -194
  158. package/src/owner/index.ts +12 -12
  159. package/src/owner/owner-node-client.ts +259 -233
  160. package/src/push/__tests__/push.test.ts +90 -90
  161. package/src/push/index.ts +146 -146
  162. package/src/server/__tests__/bus.test.ts +38 -38
  163. package/src/server/__tests__/error-handler.test.ts +118 -118
  164. package/src/server/__tests__/grants-admin-route.test.ts +73 -73
  165. package/src/server/__tests__/grants-route.test.ts +263 -189
  166. package/src/server/__tests__/nodes-route.test.ts +259 -259
  167. package/src/server/__tests__/origin-guard.test.ts +72 -72
  168. package/src/server/__tests__/publishers.test.ts +216 -216
  169. package/src/server/__tests__/server.smoke.test.ts +253 -253
  170. package/src/server/__tests__/settings-route.test.ts +194 -194
  171. package/src/server/__tests__/sse-route.test.ts +119 -119
  172. package/src/server/__tests__/static.test.ts +145 -145
  173. package/src/server/__tests__/status-route.test.ts +134 -134
  174. package/src/server/__tests__/strands-route.test.ts +233 -0
  175. package/src/server/error-handler.ts +178 -155
  176. package/src/server/events/bus.ts +42 -42
  177. package/src/server/events/sse-route.ts +81 -81
  178. package/src/server/events/types.ts +23 -22
  179. package/src/server/index.ts +267 -254
  180. package/src/server/origin-guard.ts +84 -84
  181. package/src/server/routes/grants-admin.ts +41 -41
  182. package/src/server/routes/grants.ts +210 -186
  183. package/src/server/routes/nat.ts +63 -63
  184. package/src/server/routes/nodes.ts +170 -170
  185. package/src/server/routes/settings.ts +123 -123
  186. package/src/server/routes/status.ts +118 -118
  187. package/src/server/routes/strands.ts +54 -0
  188. package/src/server/routes/trust-circle.ts +49 -49
  189. package/src/server/routes/update.ts +43 -43
  190. package/src/server/server.ts +122 -122
  191. package/src/server/settings-store.ts +37 -37
  192. package/src/server/static.ts +207 -207
  193. package/src/strands/__tests__/strand-service.test.ts +165 -0
  194. package/src/strands/index.ts +14 -0
  195. package/src/strands/strand-service.ts +135 -0
  196. package/src/strands/types.ts +102 -0
  197. package/src/update/__tests__/apply.test.ts +158 -158
  198. package/src/update/__tests__/manifest.test.ts +128 -128
  199. package/src/update/__tests__/release-key.test.ts +42 -42
  200. package/src/update/__tests__/sign.test.ts +78 -78
  201. package/src/update/__tests__/store.test.ts +81 -81
  202. package/src/update/__tests__/update-service.integration.test.ts +256 -256
  203. package/src/update/__tests__/version.test.ts +31 -31
  204. package/src/update/apply.ts +190 -190
  205. package/src/update/index.ts +341 -341
  206. package/src/update/release-key.ts +71 -71
  207. package/src/update/sign.ts +74 -74
  208. package/src/update/store.ts +101 -101
  209. package/src/update/types.ts +109 -109
  210. package/src/update/version.ts +80 -80
  211. package/dist/ui/assets/index-BlMXQPSw.js +0 -14
  212. package/dist/ui/assets/index-BlMXQPSw.js.map +0 -1
  213. package/dist/ui/assets/index-BwU5mJGF.css +0 -1
@@ -1,341 +1,341 @@
1
- /**
2
- * UpdateService — the composition root for the cadre-host update flow.
3
- *
4
- * Background check cadence: once at construction time (`check()` called
5
- * explicitly by `cadre-host start` after the management API binds) and a
6
- * 24-hour interval timer thereafter. Failures are silent — UI consumers see
7
- * `lastChecked` only when a fetch succeeds.
8
- *
9
- * Apply flow: re-fetch + re-verify the manifest (never trust the cached
10
- * `available`), record `applyInProgress`, run `npm install -g`, restart the
11
- * service via the optional `ServiceRestarter`, and roll back on failure.
12
- */
13
-
14
- import debug from 'debug';
15
-
16
- import {
17
- applyUpdate,
18
- defaultNpmExecutor,
19
- type NpmExecutor,
20
- type ServiceRestarter,
21
- } from './apply.js';
22
- import {
23
- DEFAULT_MANIFEST_URL,
24
- fetchManifest,
25
- } from './manifest.js';
26
- import { isPlaceholderReleaseKey } from './release-key.js';
27
- import { UpdateStateStore } from './store.js';
28
- import {
29
- UpdateErrorException,
30
- type UpdateApplyResult,
31
- type UpdateManifest,
32
- type UpdateSettings,
33
- type UpdateState,
34
- } from './types.js';
35
- import { compareVersions } from './version.js';
36
-
37
- const log = debug('cadre:host:update-service');
38
-
39
- const DEFAULT_CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000;
40
- const DEFAULT_NPM_TIMEOUT_MS = 5 * 60 * 1000;
41
-
42
- export interface UpdateServiceOptions {
43
- /** cadre-host data directory; UpdateState file lives here. */
44
- dataDir: string;
45
- /** Currently-running package version (from package.json). */
46
- currentVersion: string;
47
- /** Manifest URL. Defaults: env CADRE_HOST_UPDATE_MANIFEST_URL → DEFAULT_MANIFEST_URL. */
48
- manifestUrl?: string;
49
- /** Fetcher (test injection). */
50
- fetcher?: typeof fetch;
51
- /** npm runner (test injection). */
52
- npmExecutor?: NpmExecutor;
53
- /** Service-host restart hook (test injection / wiring from cadre-host start). */
54
- restart?: ServiceRestarter;
55
- /** Initial settings (autoApply etc) — typically sourced from host.config.json. */
56
- settings?: UpdateSettings;
57
- /** Periodic-check interval; defaults to 24h. */
58
- checkIntervalMs?: number;
59
- /** npm install timeout; defaults to 5m. */
60
- npmTimeoutMs?: number;
61
- }
62
-
63
- /** Handlers for the management-API listener. */
64
- export interface UpdateHandlers {
65
- getState(): Promise<UpdateState>;
66
- postApply(): Promise<UpdateApplyResult>;
67
- getSettings(): Promise<UpdateSettings>;
68
- putSettings(body: { autoApply?: boolean; manifestUrl?: string }): Promise<UpdateSettings>;
69
- }
70
-
71
- export class UpdateService {
72
- private readonly store: UpdateStateStore;
73
- private readonly currentVersion: string;
74
- private readonly fetcher: typeof fetch;
75
- private readonly npmExecutor: NpmExecutor;
76
- private readonly restart: ServiceRestarter | undefined;
77
- private readonly checkIntervalMs: number;
78
- private readonly npmTimeoutMs: number;
79
-
80
- private manifestUrl: string;
81
- private settings: UpdateSettings;
82
- private timer: ReturnType<typeof setInterval> | null = null;
83
- private applying = false;
84
-
85
- /** Persisted settings changes are bubbled out via this callback (wired in cadre-host start). */
86
- private onSettingsChange?: (next: UpdateSettings) => void | Promise<void>;
87
-
88
- constructor(opts: UpdateServiceOptions) {
89
- this.store = new UpdateStateStore(opts.dataDir);
90
- this.currentVersion = opts.currentVersion;
91
- this.fetcher = opts.fetcher ?? fetch;
92
- this.npmTimeoutMs = opts.npmTimeoutMs ?? DEFAULT_NPM_TIMEOUT_MS;
93
- this.npmExecutor = opts.npmExecutor ?? defaultNpmExecutor(this.npmTimeoutMs);
94
- this.restart = opts.restart;
95
- this.checkIntervalMs = opts.checkIntervalMs ?? DEFAULT_CHECK_INTERVAL_MS;
96
- this.settings = opts.settings ?? { autoApply: false };
97
- this.manifestUrl = resolveManifestUrl(opts.manifestUrl, this.settings.manifestUrl);
98
- this.recoverInterruptedApply();
99
- }
100
-
101
- /**
102
- * If `update-state.json` still records an in-flight apply at construction
103
- * time, the previous cadre-host process died mid-apply (OOM, power loss,
104
- * sigkill). Without intervention, every subsequent `apply()` would short-
105
- * circuit on `apply_in_progress` forever. We clear the marker and surface a
106
- * `lastError` so the UI banner can flag that an apply was interrupted —
107
- * the npm install may or may not have completed, so the operator should
108
- * verify with `npm ls -g`.
109
- */
110
- private recoverInterruptedApply(): void {
111
- const state = this.store.load();
112
- if (!state.applyInProgress) return;
113
- const { fromVersion, toVersion } = state.applyInProgress;
114
- log('clearing stale applyInProgress (%s → %s); previous apply was interrupted', fromVersion, toVersion);
115
- this.store.update({
116
- applyInProgress: undefined,
117
- lastError: {
118
- code: 'apply_failed',
119
- message: `previous apply (${fromVersion} → ${toVersion}) was interrupted (cadre-host restarted before it completed); the install may or may not have succeeded — verify with 'npm ls -g'`,
120
- at: new Date().toISOString(),
121
- },
122
- });
123
- }
124
-
125
- /** Read the persisted state for UI consumption. */
126
- async getState(): Promise<UpdateState> {
127
- return this.store.load();
128
- }
129
-
130
- /** Current settings (in-memory). */
131
- getSettings(): UpdateSettings {
132
- return { ...this.settings };
133
- }
134
-
135
- /**
136
- * Update settings (autoApply / manifestUrl). The optional `onSettingsChange`
137
- * hook is invoked so the caller can persist to host.config.json.
138
- */
139
- async putSettings(patch: { autoApply?: boolean; manifestUrl?: string }): Promise<UpdateSettings> {
140
- if (patch.autoApply !== undefined) this.settings.autoApply = patch.autoApply;
141
- if (patch.manifestUrl !== undefined) this.settings.manifestUrl = patch.manifestUrl;
142
- this.manifestUrl = resolveManifestUrl(undefined, this.settings.manifestUrl);
143
- if (this.onSettingsChange) await this.onSettingsChange({ ...this.settings });
144
- return { ...this.settings };
145
- }
146
-
147
- /** Register the persistence hook called after every settings mutation. */
148
- onSettingsChanged(handler: (next: UpdateSettings) => void | Promise<void>): void {
149
- this.onSettingsChange = handler;
150
- }
151
-
152
- /**
153
- * Background manifest check. Never throws — fetch/parse failures log at
154
- * debug; signature failures are recorded as `lastError` so the UI can warn.
155
- */
156
- async check(): Promise<void> {
157
- if (isPlaceholderReleaseKey()) {
158
- // A build that shipped the all-zeros placeholder rejects every authentic
159
- // manifest as signature_invalid; surface that here so it's diagnosable
160
- // from logs rather than only as an opaque verification failure.
161
- log('release verification key is the all-zeros placeholder; production manifests will fail signature_invalid (set CADRE_HOST_UPDATE_DEV_KEY for dev/CI only)');
162
- }
163
- let manifest: UpdateManifest;
164
- try {
165
- manifest = await fetchManifest({
166
- url: this.manifestUrl,
167
- fetcher: this.fetcher,
168
- });
169
- } catch (err) {
170
- if (err instanceof UpdateErrorException && err.code === 'signature_invalid') {
171
- log('manifest signature invalid: %s', err.message);
172
- this.store.update({
173
- lastError: { code: err.code, message: err.message, at: new Date().toISOString() },
174
- });
175
- return;
176
- }
177
- // Network / parse / endpoint-down: silent.
178
- log('manifest fetch failed: %s', (err as Error).message);
179
- return;
180
- }
181
-
182
- const now = new Date().toISOString();
183
- const compared = compareVersions(this.currentVersion, manifest.version);
184
- if (compared >= 0) {
185
- // Already up-to-date — clear any stale `available` record.
186
- this.store.update({
187
- lastChecked: now,
188
- available: undefined,
189
- lastError: undefined,
190
- });
191
- log('check ok: current %s ≥ %s', this.currentVersion, manifest.version);
192
- return;
193
- }
194
-
195
- this.store.update({
196
- lastChecked: now,
197
- available: {
198
- version: manifest.version,
199
- publishedAt: manifest.publishedAt,
200
- ...(manifest.releaseNotesUrl ? { releaseNotesUrl: manifest.releaseNotesUrl } : {}),
201
- },
202
- lastError: undefined,
203
- });
204
- log('update available: %s → %s', this.currentVersion, manifest.version);
205
-
206
- if (this.settings.autoApply) {
207
- try {
208
- await this.apply();
209
- } catch (err) {
210
- // apply() already recorded the error; we just don't want to crash the timer.
211
- log('auto-apply failed: %s', (err as Error).message);
212
- }
213
- }
214
- }
215
-
216
- /**
217
- * Trigger an apply. Re-verifies the manifest, runs npm install -g, attempts
218
- * a service restart, and rolls back on failure. Throws UpdateErrorException
219
- * on any hard failure; success returns the new state.
220
- */
221
- async apply(): Promise<UpdateApplyResult> {
222
- if (this.applying) {
223
- throw new UpdateErrorException('apply_in_progress', 'another apply is already running');
224
- }
225
- const state = this.store.load();
226
- if (state.applyInProgress) {
227
- throw new UpdateErrorException('apply_in_progress', 'state already records an in-flight apply');
228
- }
229
- this.applying = true;
230
- try {
231
- const manifest = await fetchManifest({
232
- url: this.manifestUrl,
233
- fetcher: this.fetcher,
234
- });
235
- if (compareVersions(this.currentVersion, manifest.version) >= 0) {
236
- throw new UpdateErrorException(
237
- 'no_update_available',
238
- `current ${this.currentVersion} is already ≥ latest ${manifest.version}`,
239
- );
240
- }
241
- if (manifest.minPreviousVersion && compareVersions(this.currentVersion, manifest.minPreviousVersion) < 0) {
242
- throw new UpdateErrorException(
243
- 'min_previous_version',
244
- `current ${this.currentVersion} is below minPreviousVersion ${manifest.minPreviousVersion}; install an intermediate release first`,
245
- );
246
- }
247
-
248
- const startedAt = new Date().toISOString();
249
- this.store.update({
250
- applyInProgress: {
251
- fromVersion: this.currentVersion,
252
- toVersion: manifest.version,
253
- startedAt,
254
- },
255
- });
256
-
257
- try {
258
- const result = await applyUpdate({
259
- npmPackage: manifest.channels.npm.package,
260
- fromVersion: this.currentVersion,
261
- toVersion: manifest.version,
262
- npmExecutor: this.npmExecutor,
263
- ...(this.restart ? { restart: this.restart } : {}),
264
- timeoutMs: this.npmTimeoutMs,
265
- });
266
- // Success: clear progress + any prior error.
267
- this.store.update({
268
- applyInProgress: undefined,
269
- lastError: undefined,
270
- });
271
- return result;
272
- } catch (err) {
273
- const code = err instanceof UpdateErrorException ? err.code : 'apply_failed';
274
- const message = (err as Error).message;
275
- this.store.update({
276
- applyInProgress: undefined,
277
- lastError: { code, message, at: new Date().toISOString() },
278
- });
279
- throw err instanceof UpdateErrorException ? err : new UpdateErrorException('apply_failed', message);
280
- }
281
- } finally {
282
- this.applying = false;
283
- }
284
- }
285
-
286
- /** Start the daily-check timer. `start()` ensures we don't double-arm. */
287
- start(): void {
288
- if (this.timer) return;
289
- this.timer = setInterval(() => {
290
- void this.check().catch((err) => log('scheduled check threw (should not happen): %s', (err as Error).message));
291
- }, this.checkIntervalMs);
292
- // Don't keep the event loop alive just for this timer.
293
- if (typeof this.timer === 'object' && this.timer && 'unref' in this.timer) {
294
- (this.timer as { unref?: () => void }).unref?.();
295
- }
296
- }
297
-
298
- /** Stop the daily-check timer. */
299
- stop(): void {
300
- if (this.timer) {
301
- clearInterval(this.timer);
302
- this.timer = null;
303
- }
304
- }
305
- }
306
-
307
- /**
308
- * Typed handler facade — mirrors `createTrustCircleHandlers` /
309
- * `createNatHandlers`. The local-UI ticket consumes these.
310
- */
311
- export function createUpdateHandlers(service: UpdateService): UpdateHandlers {
312
- return {
313
- async getState() { return service.getState(); },
314
- async postApply() { return await service.apply(); },
315
- async getSettings() { return service.getSettings(); },
316
- async putSettings(body) { return await service.putSettings(body); },
317
- };
318
- }
319
-
320
- function resolveManifestUrl(explicit: string | undefined, fromSettings: string | undefined): string {
321
- // Env var wins — operators routinely point this at staging endpoints, and
322
- // both the README and host.ts documentation promise that behavior.
323
- // Then explicit constructor arg → persisted settings → compiled default.
324
- const envUrl = process.env.CADRE_HOST_UPDATE_MANIFEST_URL?.trim();
325
- if (envUrl) return envUrl;
326
- return explicit ?? fromSettings ?? DEFAULT_MANIFEST_URL;
327
- }
328
-
329
- export type { UpdateState, UpdateApplyResult, UpdateSettings, UpdateManifest, SignedManifest } from './types.js';
330
- export { UpdateErrorException, type UpdateErrorCode } from './types.js';
331
- export { compareVersions, parseVersion } from './version.js';
332
- export { fetchManifest, verifyManifest, canonicalJson, signManifest, validateManifestFields } from './manifest.js';
333
- export { UpdateStateStore } from './store.js';
334
- export { applyUpdate, defaultNpmExecutor, type NpmExecutor, type ServiceRestarter } from './apply.js';
335
- export {
336
- getReleasePublicKey,
337
- getReleasePublicKeyBase64,
338
- ed25519FromRaw,
339
- isPlaceholderReleaseKey,
340
- } from './release-key.js';
341
- export { buildManifest, derivePublicKeyBase64, signAndSelfVerify, type ManifestFields } from './sign.js';
1
+ /**
2
+ * UpdateService — the composition root for the cadre-host update flow.
3
+ *
4
+ * Background check cadence: once at construction time (`check()` called
5
+ * explicitly by `cadre-host start` after the management API binds) and a
6
+ * 24-hour interval timer thereafter. Failures are silent — UI consumers see
7
+ * `lastChecked` only when a fetch succeeds.
8
+ *
9
+ * Apply flow: re-fetch + re-verify the manifest (never trust the cached
10
+ * `available`), record `applyInProgress`, run `npm install -g`, restart the
11
+ * service via the optional `ServiceRestarter`, and roll back on failure.
12
+ */
13
+
14
+ import debug from 'debug';
15
+
16
+ import {
17
+ applyUpdate,
18
+ defaultNpmExecutor,
19
+ type NpmExecutor,
20
+ type ServiceRestarter,
21
+ } from './apply.js';
22
+ import {
23
+ DEFAULT_MANIFEST_URL,
24
+ fetchManifest,
25
+ } from './manifest.js';
26
+ import { isPlaceholderReleaseKey } from './release-key.js';
27
+ import { UpdateStateStore } from './store.js';
28
+ import {
29
+ UpdateErrorException,
30
+ type UpdateApplyResult,
31
+ type UpdateManifest,
32
+ type UpdateSettings,
33
+ type UpdateState,
34
+ } from './types.js';
35
+ import { compareVersions } from './version.js';
36
+
37
+ const log = debug('cadre:host:update-service');
38
+
39
+ const DEFAULT_CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000;
40
+ const DEFAULT_NPM_TIMEOUT_MS = 5 * 60 * 1000;
41
+
42
+ export interface UpdateServiceOptions {
43
+ /** cadre-host data directory; UpdateState file lives here. */
44
+ dataDir: string;
45
+ /** Currently-running package version (from package.json). */
46
+ currentVersion: string;
47
+ /** Manifest URL. Defaults: env CADRE_HOST_UPDATE_MANIFEST_URL → DEFAULT_MANIFEST_URL. */
48
+ manifestUrl?: string;
49
+ /** Fetcher (test injection). */
50
+ fetcher?: typeof fetch;
51
+ /** npm runner (test injection). */
52
+ npmExecutor?: NpmExecutor;
53
+ /** Service-host restart hook (test injection / wiring from cadre-host start). */
54
+ restart?: ServiceRestarter;
55
+ /** Initial settings (autoApply etc) — typically sourced from host.config.json. */
56
+ settings?: UpdateSettings;
57
+ /** Periodic-check interval; defaults to 24h. */
58
+ checkIntervalMs?: number;
59
+ /** npm install timeout; defaults to 5m. */
60
+ npmTimeoutMs?: number;
61
+ }
62
+
63
+ /** Handlers for the management-API listener. */
64
+ export interface UpdateHandlers {
65
+ getState(): Promise<UpdateState>;
66
+ postApply(): Promise<UpdateApplyResult>;
67
+ getSettings(): Promise<UpdateSettings>;
68
+ putSettings(body: { autoApply?: boolean; manifestUrl?: string }): Promise<UpdateSettings>;
69
+ }
70
+
71
+ export class UpdateService {
72
+ private readonly store: UpdateStateStore;
73
+ private readonly currentVersion: string;
74
+ private readonly fetcher: typeof fetch;
75
+ private readonly npmExecutor: NpmExecutor;
76
+ private readonly restart: ServiceRestarter | undefined;
77
+ private readonly checkIntervalMs: number;
78
+ private readonly npmTimeoutMs: number;
79
+
80
+ private manifestUrl: string;
81
+ private settings: UpdateSettings;
82
+ private timer: ReturnType<typeof setInterval> | null = null;
83
+ private applying = false;
84
+
85
+ /** Persisted settings changes are bubbled out via this callback (wired in cadre-host start). */
86
+ private onSettingsChange?: (next: UpdateSettings) => void | Promise<void>;
87
+
88
+ constructor(opts: UpdateServiceOptions) {
89
+ this.store = new UpdateStateStore(opts.dataDir);
90
+ this.currentVersion = opts.currentVersion;
91
+ this.fetcher = opts.fetcher ?? fetch;
92
+ this.npmTimeoutMs = opts.npmTimeoutMs ?? DEFAULT_NPM_TIMEOUT_MS;
93
+ this.npmExecutor = opts.npmExecutor ?? defaultNpmExecutor(this.npmTimeoutMs);
94
+ this.restart = opts.restart;
95
+ this.checkIntervalMs = opts.checkIntervalMs ?? DEFAULT_CHECK_INTERVAL_MS;
96
+ this.settings = opts.settings ?? { autoApply: false };
97
+ this.manifestUrl = resolveManifestUrl(opts.manifestUrl, this.settings.manifestUrl);
98
+ this.recoverInterruptedApply();
99
+ }
100
+
101
+ /**
102
+ * If `update-state.json` still records an in-flight apply at construction
103
+ * time, the previous cadre-host process died mid-apply (OOM, power loss,
104
+ * sigkill). Without intervention, every subsequent `apply()` would short-
105
+ * circuit on `apply_in_progress` forever. We clear the marker and surface a
106
+ * `lastError` so the UI banner can flag that an apply was interrupted —
107
+ * the npm install may or may not have completed, so the operator should
108
+ * verify with `npm ls -g`.
109
+ */
110
+ private recoverInterruptedApply(): void {
111
+ const state = this.store.load();
112
+ if (!state.applyInProgress) return;
113
+ const { fromVersion, toVersion } = state.applyInProgress;
114
+ log('clearing stale applyInProgress (%s → %s); previous apply was interrupted', fromVersion, toVersion);
115
+ this.store.update({
116
+ applyInProgress: undefined,
117
+ lastError: {
118
+ code: 'apply_failed',
119
+ message: `previous apply (${fromVersion} → ${toVersion}) was interrupted (cadre-host restarted before it completed); the install may or may not have succeeded — verify with 'npm ls -g'`,
120
+ at: new Date().toISOString(),
121
+ },
122
+ });
123
+ }
124
+
125
+ /** Read the persisted state for UI consumption. */
126
+ async getState(): Promise<UpdateState> {
127
+ return this.store.load();
128
+ }
129
+
130
+ /** Current settings (in-memory). */
131
+ getSettings(): UpdateSettings {
132
+ return { ...this.settings };
133
+ }
134
+
135
+ /**
136
+ * Update settings (autoApply / manifestUrl). The optional `onSettingsChange`
137
+ * hook is invoked so the caller can persist to host.config.json.
138
+ */
139
+ async putSettings(patch: { autoApply?: boolean; manifestUrl?: string }): Promise<UpdateSettings> {
140
+ if (patch.autoApply !== undefined) this.settings.autoApply = patch.autoApply;
141
+ if (patch.manifestUrl !== undefined) this.settings.manifestUrl = patch.manifestUrl;
142
+ this.manifestUrl = resolveManifestUrl(undefined, this.settings.manifestUrl);
143
+ if (this.onSettingsChange) await this.onSettingsChange({ ...this.settings });
144
+ return { ...this.settings };
145
+ }
146
+
147
+ /** Register the persistence hook called after every settings mutation. */
148
+ onSettingsChanged(handler: (next: UpdateSettings) => void | Promise<void>): void {
149
+ this.onSettingsChange = handler;
150
+ }
151
+
152
+ /**
153
+ * Background manifest check. Never throws — fetch/parse failures log at
154
+ * debug; signature failures are recorded as `lastError` so the UI can warn.
155
+ */
156
+ async check(): Promise<void> {
157
+ if (isPlaceholderReleaseKey()) {
158
+ // A build that shipped the all-zeros placeholder rejects every authentic
159
+ // manifest as signature_invalid; surface that here so it's diagnosable
160
+ // from logs rather than only as an opaque verification failure.
161
+ log('release verification key is the all-zeros placeholder; production manifests will fail signature_invalid (set CADRE_HOST_UPDATE_DEV_KEY for dev/CI only)');
162
+ }
163
+ let manifest: UpdateManifest;
164
+ try {
165
+ manifest = await fetchManifest({
166
+ url: this.manifestUrl,
167
+ fetcher: this.fetcher,
168
+ });
169
+ } catch (err) {
170
+ if (err instanceof UpdateErrorException && err.code === 'signature_invalid') {
171
+ log('manifest signature invalid: %s', err.message);
172
+ this.store.update({
173
+ lastError: { code: err.code, message: err.message, at: new Date().toISOString() },
174
+ });
175
+ return;
176
+ }
177
+ // Network / parse / endpoint-down: silent.
178
+ log('manifest fetch failed: %s', (err as Error).message);
179
+ return;
180
+ }
181
+
182
+ const now = new Date().toISOString();
183
+ const compared = compareVersions(this.currentVersion, manifest.version);
184
+ if (compared >= 0) {
185
+ // Already up-to-date — clear any stale `available` record.
186
+ this.store.update({
187
+ lastChecked: now,
188
+ available: undefined,
189
+ lastError: undefined,
190
+ });
191
+ log('check ok: current %s ≥ %s', this.currentVersion, manifest.version);
192
+ return;
193
+ }
194
+
195
+ this.store.update({
196
+ lastChecked: now,
197
+ available: {
198
+ version: manifest.version,
199
+ publishedAt: manifest.publishedAt,
200
+ ...(manifest.releaseNotesUrl ? { releaseNotesUrl: manifest.releaseNotesUrl } : {}),
201
+ },
202
+ lastError: undefined,
203
+ });
204
+ log('update available: %s → %s', this.currentVersion, manifest.version);
205
+
206
+ if (this.settings.autoApply) {
207
+ try {
208
+ await this.apply();
209
+ } catch (err) {
210
+ // apply() already recorded the error; we just don't want to crash the timer.
211
+ log('auto-apply failed: %s', (err as Error).message);
212
+ }
213
+ }
214
+ }
215
+
216
+ /**
217
+ * Trigger an apply. Re-verifies the manifest, runs npm install -g, attempts
218
+ * a service restart, and rolls back on failure. Throws UpdateErrorException
219
+ * on any hard failure; success returns the new state.
220
+ */
221
+ async apply(): Promise<UpdateApplyResult> {
222
+ if (this.applying) {
223
+ throw new UpdateErrorException('apply_in_progress', 'another apply is already running');
224
+ }
225
+ const state = this.store.load();
226
+ if (state.applyInProgress) {
227
+ throw new UpdateErrorException('apply_in_progress', 'state already records an in-flight apply');
228
+ }
229
+ this.applying = true;
230
+ try {
231
+ const manifest = await fetchManifest({
232
+ url: this.manifestUrl,
233
+ fetcher: this.fetcher,
234
+ });
235
+ if (compareVersions(this.currentVersion, manifest.version) >= 0) {
236
+ throw new UpdateErrorException(
237
+ 'no_update_available',
238
+ `current ${this.currentVersion} is already ≥ latest ${manifest.version}`,
239
+ );
240
+ }
241
+ if (manifest.minPreviousVersion && compareVersions(this.currentVersion, manifest.minPreviousVersion) < 0) {
242
+ throw new UpdateErrorException(
243
+ 'min_previous_version',
244
+ `current ${this.currentVersion} is below minPreviousVersion ${manifest.minPreviousVersion}; install an intermediate release first`,
245
+ );
246
+ }
247
+
248
+ const startedAt = new Date().toISOString();
249
+ this.store.update({
250
+ applyInProgress: {
251
+ fromVersion: this.currentVersion,
252
+ toVersion: manifest.version,
253
+ startedAt,
254
+ },
255
+ });
256
+
257
+ try {
258
+ const result = await applyUpdate({
259
+ npmPackage: manifest.channels.npm.package,
260
+ fromVersion: this.currentVersion,
261
+ toVersion: manifest.version,
262
+ npmExecutor: this.npmExecutor,
263
+ ...(this.restart ? { restart: this.restart } : {}),
264
+ timeoutMs: this.npmTimeoutMs,
265
+ });
266
+ // Success: clear progress + any prior error.
267
+ this.store.update({
268
+ applyInProgress: undefined,
269
+ lastError: undefined,
270
+ });
271
+ return result;
272
+ } catch (err) {
273
+ const code = err instanceof UpdateErrorException ? err.code : 'apply_failed';
274
+ const message = (err as Error).message;
275
+ this.store.update({
276
+ applyInProgress: undefined,
277
+ lastError: { code, message, at: new Date().toISOString() },
278
+ });
279
+ throw err instanceof UpdateErrorException ? err : new UpdateErrorException('apply_failed', message);
280
+ }
281
+ } finally {
282
+ this.applying = false;
283
+ }
284
+ }
285
+
286
+ /** Start the daily-check timer. `start()` ensures we don't double-arm. */
287
+ start(): void {
288
+ if (this.timer) return;
289
+ this.timer = setInterval(() => {
290
+ void this.check().catch((err) => log('scheduled check threw (should not happen): %s', (err as Error).message));
291
+ }, this.checkIntervalMs);
292
+ // Don't keep the event loop alive just for this timer.
293
+ if (typeof this.timer === 'object' && this.timer && 'unref' in this.timer) {
294
+ (this.timer as { unref?: () => void }).unref?.();
295
+ }
296
+ }
297
+
298
+ /** Stop the daily-check timer. */
299
+ stop(): void {
300
+ if (this.timer) {
301
+ clearInterval(this.timer);
302
+ this.timer = null;
303
+ }
304
+ }
305
+ }
306
+
307
+ /**
308
+ * Typed handler facade — mirrors `createTrustCircleHandlers` /
309
+ * `createNatHandlers`. The local-UI ticket consumes these.
310
+ */
311
+ export function createUpdateHandlers(service: UpdateService): UpdateHandlers {
312
+ return {
313
+ async getState() { return service.getState(); },
314
+ async postApply() { return await service.apply(); },
315
+ async getSettings() { return service.getSettings(); },
316
+ async putSettings(body) { return await service.putSettings(body); },
317
+ };
318
+ }
319
+
320
+ function resolveManifestUrl(explicit: string | undefined, fromSettings: string | undefined): string {
321
+ // Env var wins — operators routinely point this at staging endpoints, and
322
+ // both the README and host.ts documentation promise that behavior.
323
+ // Then explicit constructor arg → persisted settings → compiled default.
324
+ const envUrl = process.env.CADRE_HOST_UPDATE_MANIFEST_URL?.trim();
325
+ if (envUrl) return envUrl;
326
+ return explicit ?? fromSettings ?? DEFAULT_MANIFEST_URL;
327
+ }
328
+
329
+ export type { UpdateState, UpdateApplyResult, UpdateSettings, UpdateManifest, SignedManifest } from './types.js';
330
+ export { UpdateErrorException, type UpdateErrorCode } from './types.js';
331
+ export { compareVersions, parseVersion } from './version.js';
332
+ export { fetchManifest, verifyManifest, canonicalJson, signManifest, validateManifestFields } from './manifest.js';
333
+ export { UpdateStateStore } from './store.js';
334
+ export { applyUpdate, defaultNpmExecutor, type NpmExecutor, type ServiceRestarter } from './apply.js';
335
+ export {
336
+ getReleasePublicKey,
337
+ getReleasePublicKeyBase64,
338
+ ed25519FromRaw,
339
+ isPlaceholderReleaseKey,
340
+ } from './release-key.js';
341
+ export { buildManifest, derivePublicKeyBase64, signAndSelfVerify, type ManifestFields } from './sign.js';