@sanqianx/project-knowledge 4.8.0 → 5.0.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 (45) hide show
  1. package/.claude-plugin/marketplace.json +1 -1
  2. package/CHANGELOG.md +19 -0
  3. package/README.md +11 -6
  4. package/_modules/knowledge-engine/README.md +9 -6
  5. package/_modules/knowledge-engine/package.json +1 -1
  6. package/_modules/knowledge-engine/src/coordinator.js +11 -3
  7. package/_modules/knowledge-engine/src/server.js +9 -10
  8. package/_modules/knowledge-engine/src/store.js +9 -12
  9. package/_modules/knowledge-engine/ui/app.js +1 -1
  10. package/_site/_test/fresh-hook-reimport-test.js +53 -0
  11. package/_site/_test/fresh-product-data-test.js +42 -0
  12. package/_site/_test/module-model-configuration-test.js +2 -1
  13. package/_site/_test/tracking-start-test.js +1 -0
  14. package/_site/lib/data-dir.js +13 -81
  15. package/_site/lib/engine-connection.js +67 -0
  16. package/_site/lib/hook-manager.js +1 -1
  17. package/_site/lib/integration-installer.js +2 -1
  18. package/_site/lib/module-bridge.js +6 -16
  19. package/_site/lib/product-data.js +24 -0
  20. package/_site/lib/project-lifecycle-service.js +18 -2
  21. package/_site/lib/server-app.js +11 -22
  22. package/docs/README.zh-CN.md +8 -4
  23. package/docs/fresh-v5-start.md +28 -0
  24. package/module-runtime-manifest.json +2 -2
  25. package/package.json +2 -1
  26. package/plugins/project-knowledge/.claude-plugin/plugin.json +1 -1
  27. package/plugins/project-knowledge/.codex-plugin/plugin.json +1 -1
  28. package/plugins/project-knowledge/.mcp.json +1 -1
  29. package/ui/index.html +2 -1
  30. package/ui/product.js +41 -15
  31. package/vendor-manifest.json +7 -8
  32. package/_modules/knowledge-engine/src/migration.js +0 -88
  33. package/_site/_test/data-dir-migration-test.js +0 -77
  34. package/_site/_test/knowledge-migration-test.js +0 -75
  35. package/_site/_test/legacy-forward-compat-test.js +0 -257
  36. package/_site/_test/legacy-project-upgrade-e2e-test.js +0 -363
  37. package/_site/_test/p0-data-migration-characterization-test.js +0 -37
  38. package/_site/_test/p0-e2e-gate-test.js +0 -347
  39. package/_site/_test/project-layout-v2-migration-test.js +0 -127
  40. package/_site/_test/server-runtime-migration-safety-test.js +0 -27
  41. package/_site/_test/v4122-upgrade-data-contract-test.js +0 -56
  42. package/_site/lib/data-state-classifier.js +0 -40
  43. package/_site/lib/engine-cutover.js +0 -97
  44. package/_site/lib/legacy-data-manifest.js +0 -26
  45. package/_site/lib/migration-service.js +0 -442
@@ -1,347 +0,0 @@
1
- // _site/_test/p0-e2e-gate-test.js
2
- //
3
- // T09: P0 E2E gate. Four scenarios in one sequential run:
4
- //
5
- // A. Fresh project: import -> hook -> commit -> reconciler -> Markdown
6
- // -> analyzed pointer advances.
7
- // B. v4.1.22 legacy project: migrate (no re-import) -> hook -> commit
8
- // -> reconciler -> Markdown -> advances.
9
- // C. Backend offline: stop -> commit -> restart -> startup recon
10
- // catches up.
11
- // D. No conversation captured: commit with no Bridge cursor advance
12
- // still analyzes from Git evidence.
13
-
14
- const assert = require('assert');
15
- const fs = require('fs');
16
- const os = require('os');
17
- const path = require('path');
18
- const { spawnSync } = require('child_process');
19
- const { spawnServer } = require('./helpers/spawn-server');
20
- const { StorageLayout } = require('../lib/storage-layout');
21
- const { MigrationService } = require('../lib/migration-service');
22
- const { LEGACY_HOOK_MARKER } = require('../lib/hook-manager');
23
-
24
- const ROOT = path.resolve(__dirname, '..', '..');
25
- const BASE_PORT = 7970 + (process.pid % 200);
26
-
27
- function git(repo, args) {
28
- const result = spawnSync('git', ['-C', repo, ...args], {
29
- encoding: 'utf8', windowsHide: true,
30
- env: { ...process.env, GIT_TERMINAL_PROMPT: '0' },
31
- });
32
- if (result.status !== 0) throw new Error(result.stderr || `git ${args.join(' ')} failed: ${result.status}`);
33
- return String(result.stdout || '').trim();
34
- }
35
-
36
- function makeRepo() {
37
- const repo = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-p0e2e-repo-' + process.pid + '-'));
38
- git(repo, ['init', '-q', '-b', 'main']);
39
- git(repo, ['config', 'user.email', 'p0e2e@example.local']);
40
- git(repo, ['config', 'user.name', 'P0 E2E']);
41
- fs.writeFileSync(path.join(repo, 'README.md'), '# p0\n');
42
- git(repo, ['add', 'README.md']);
43
- git(repo, ['commit', '-q', '-m', 'baseline']);
44
- return repo;
45
- }
46
-
47
- async function serverFetch(server, url, init, timeoutMs = 15000) {
48
- const controller = new AbortController();
49
- const timer = setTimeout(() => controller.abort(), timeoutMs);
50
- try {
51
- const response = await fetch(url, { ...init, signal: controller.signal });
52
- const text = await response.text();
53
- return { status: response.status, body: text ? JSON.parse(text) : {} };
54
- } finally {
55
- clearTimeout(timer);
56
- }
57
- }
58
-
59
- async function waitForState(server, projectId, predicate, label, timeoutMs = 60000) {
60
- const deadline = Date.now() + timeoutMs;
61
- let last;
62
- while (Date.now() < deadline) {
63
- try {
64
- const r = await serverFetch(server, `${server.base}/api/projects/${projectId}`, undefined);
65
- if (r.status === 200) {
66
- last = r.body.project.state;
67
- if (predicate(last)) return last;
68
- }
69
- } catch {}
70
- await new Promise(resolve => setTimeout(resolve, 200));
71
- }
72
- throw new Error(`${label} timed out; last=${JSON.stringify(last)}`);
73
- }
74
-
75
- async function waitForHealth(server) {
76
- for (let attempt = 0; attempt < 100; attempt += 1) {
77
- try { const r = await serverFetch(server, `${server.base}/api/health`, undefined); if (r.body.ok) return; } catch {}
78
- await new Promise(resolve => setTimeout(resolve, 100));
79
- }
80
- throw new Error('server did not start');
81
- }
82
-
83
- async function configureServer(server, dataDir) {
84
- await serverFetch(server, `${server.base}/api/settings`, {
85
- method: 'PATCH', headers: { 'content-type': 'application/json' },
86
- body: JSON.stringify({ knowledge: { rootPath: path.join(dataDir, 'knowledge') } }),
87
- });
88
- await serverFetch(server, `${server.base}/api/ai-profiles`, {
89
- method: 'PUT', headers: { 'content-type': 'application/json' },
90
- body: JSON.stringify({
91
- schema: 'ai-profiles/v1', defaultProfileId: 'fake',
92
- profiles: [{ id: 'fake', name: 'Fake', enabled: true, vendor: 'anthropic', model: 'fake', apiKeyUpdate: { mode: 'replace', value: 'k' } }],
93
- }),
94
- });
95
- }
96
-
97
- async function killServer(server) {
98
- if (!server || !server.child) return;
99
- server.child.kill();
100
- await new Promise(resolve => server.child.once('exit', resolve));
101
- }
102
-
103
- (async () => {
104
- const dataDir = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-p0e2e-data-' + process.pid + '-'));
105
- const freshRepo = makeRepo();
106
- const legacyRepo = makeRepo();
107
- // Add a legacy v1 hook to legacyRepo so the migration path includes T03 case 2.
108
- {
109
- const gitDir = git(legacyRepo, ['rev-parse', '--path-format=absolute', '--git-dir']);
110
- const hooksDir = path.join(path.resolve(gitDir), 'hooks');
111
- fs.mkdirSync(hooksDir, { recursive: true });
112
- fs.writeFileSync(path.join(hooksDir, 'post-commit'), (
113
- `#!/bin/sh\n${LEGACY_HOOK_MARKER} — legacy\n` +
114
- `node 'C:/legacy/_site/scripts/hook-trigger.js' >/dev/null 2>&1 || true\n` +
115
- `exit 0\n`
116
- ), { mode: 0o755 });
117
- }
118
- const legacyKbPath = path.join(dataDir, 'knowledge', 'legacy');
119
- fs.mkdirSync(legacyKbPath, { recursive: true });
120
- fs.writeFileSync(path.join(dataDir, 'projects.json'), JSON.stringify({
121
- 'legacy': {
122
- schema: 'kb-project/v1',
123
- displayName: 'Legacy',
124
- localPath: legacyRepo,
125
- gitPath: legacyRepo,
126
- kbPath: legacyKbPath,
127
- trackingStartCommit: git(legacyRepo, ['rev-parse', 'HEAD']),
128
- lastAnalyzedCommit: git(legacyRepo, ['rev-parse', 'HEAD']),
129
- enabled: true,
130
- aiProfileId: 'primary',
131
- knowledgeLanguage: 'zh-CN',
132
- },
133
- }, null, 2));
134
- fs.writeFileSync(path.join(dataDir, 'knowledge-store.json'), JSON.stringify({
135
- schema: 'knowledge-store/v1',
136
- rootPath: path.join(dataDir, 'knowledge'), configured: true,
137
- }));
138
- fs.writeFileSync(path.join(dataDir, 'ai-profiles.json'), JSON.stringify({
139
- schema: 'ai-profiles/v1',
140
- profiles: [{ id: 'primary', name: 'Primary', enabled: true, vendor: 'anthropic', model: 'claude-sonnet' }],
141
- defaultProfileId: 'primary',
142
- }));
143
-
144
- // Scenario A — fresh project
145
- const serverA = spawnServer({
146
- root: ROOT, port: BASE_PORT, dataDir, tag: 'p0e2e-a',
147
- extraEnv: { KB_AUTOMATION_FAKE_CLAUDE: '1', KB_EMBEDDING_FAKE: '1' },
148
- });
149
- serverA.base = `http://127.0.0.1:${BASE_PORT}`;
150
- try {
151
- await waitForHealth(serverA);
152
- await configureServer(serverA, dataDir);
153
- const importR = await serverFetch(serverA, `${serverA.base}/api/projects/import`, {
154
- method: 'POST', headers: { 'content-type': 'application/json' },
155
- body: JSON.stringify({ localPath: freshRepo, aiProfileId: 'fake', knowledgeLanguage: 'zh-CN' }),
156
- });
157
- assert.strictEqual(importR.status, 201, JSON.stringify(importR.body));
158
- const projectA = importR.body.projectId;
159
- const configA = importR.body.config;
160
- // Verify hook installed
161
- const hookPath = path.join(freshRepo, '.git', 'hooks', 'post-commit');
162
- assert(fs.existsSync(hookPath), 'post-commit hook must be installed after import');
163
- const hookBody = fs.readFileSync(hookPath, 'utf8');
164
- assert(hookBody.includes('PROJECT-KNOWLEDGE-HOOK'), 'hook body must carry the v2 marker');
165
- assert(hookBody.includes(projectA), 'hook body must reference the projectId');
166
- assert(hookBody.includes('ELECTRON_RUN_AS_NODE=1'), 'T02 contract: hook body must prefix ELECTRON_RUN_AS_NODE=1');
167
- // Commit a change
168
- fs.writeFileSync(path.join(freshRepo, 'feature-a.txt'), 'feature a\n');
169
- git(freshRepo, ['add', 'feature-a.txt']);
170
- git(freshRepo, ['commit', '-q', '-m', 'scenario-a: feature a']);
171
- const headA = git(freshRepo, ['rev-parse', 'HEAD']);
172
- // Wait for reconciliation. If the live hook didn't fire (common in
173
- // headless test environments), retry by POSTing the hook event
174
- // ourselves — this is the same code path the hook runs.
175
- let stateA = null;
176
- for (let attempt = 0; attempt < 30; attempt += 1) {
177
- try {
178
- const r = await serverFetch(serverA, `${serverA.base}/api/projects/${projectA}`, undefined);
179
- if (r.status === 200 && r.body.project.state.lastAnalyzedCommit === headA) {
180
- stateA = r.body.project.state;
181
- break;
182
- }
183
- } catch {}
184
- await new Promise(resolve => setTimeout(resolve, 200));
185
- }
186
- if (!stateA) {
187
- // Retry path: explicitly invoke /api/hooks/post-commit. The reconciler
188
- // will run and advance lastAnalyzedCommit.
189
- await serverFetch(serverA, `${serverA.base}/api/hooks/post-commit`, {
190
- method: 'POST', headers: { 'content-type': 'application/json' },
191
- body: JSON.stringify({
192
- schema: 'hook-event/v2', projectId: projectA, repoRoot: freshRepo,
193
- head: headA, branch: 'main', operationId: `op-scenario-a-${Date.now()}`,
194
- }),
195
- });
196
- stateA = await waitForState(serverA, projectA, s => s.lastAnalyzedCommit === headA, 'scenario A reconciliation');
197
- }
198
- // Give the trailing reconcile work a chance to settle so the post-
199
- // fix runSweep does not overwrite analysis.status with 'idle' between
200
- // waitForState returning and the assertion reading the state.
201
- await new Promise(resolve => setTimeout(resolve, 500));
202
- const finalStateA = await (await serverFetch(serverA, `${serverA.base}/api/projects/${projectA}`, undefined)).body;
203
- stateA = finalStateA.project.state;
204
- assert.strictEqual(stateA.analysis.activeClaim, null, 'analysis.activeClaim must be null after promotion');
205
- assert.strictEqual(stateA.analysis.status, 'state.advanced', 'analysis.status must be state.advanced');
206
- assert.strictEqual(stateA.trackingStartCommit, stateA.lastAnalyzedCommit === headA ? stateA.trackingStartCommit : null);
207
- // Verify Markdown knowledge
208
- const mdPath = path.join(configA.knowledgePath, 'changes', `${headA.slice(0, 12)}.md`);
209
- assert(fs.existsSync(mdPath), `knowledge Markdown must exist at ${mdPath}`);
210
- } finally {
211
- await killServer(serverA);
212
- }
213
-
214
- // Scenario B — v4.1.22 legacy project (migrate, no re-import)
215
- // We restart with the SAME dataDir so the migration service picks up the
216
- // legacy projects.json. The server's startup will run MigrationService +
217
- // migrateManagedHooks.
218
- const serverB = spawnServer({
219
- root: ROOT, port: BASE_PORT, dataDir, tag: 'p0e2e-b',
220
- extraEnv: { KB_AUTOMATION_FAKE_CLAUDE: '1', KB_EMBEDDING_FAKE: '1' },
221
- });
222
- serverB.base = `http://127.0.0.1:${BASE_PORT}`;
223
- try {
224
- await waitForHealth(serverB);
225
- await configureServer(serverB, dataDir);
226
- const stateList = await serverFetch(serverB, `${serverB.base}/api/state`, undefined);
227
- assert.strictEqual(stateList.status, 200);
228
- const legacyProject = stateList.body.projects.find(p => p.config.displayName === 'Legacy');
229
- assert(legacyProject, 'migrated Legacy project must appear in /api/state without a re-import call');
230
- const projectB = legacyProject.projectId;
231
- // Verify hook was migrated from v1 to v2
232
- const hookPath = path.join(legacyRepo, '.git', 'hooks', 'post-commit');
233
- const hookBody = fs.readFileSync(hookPath, 'utf8');
234
- assert(hookBody.includes('PROJECT-KNOWLEDGE-HOOK'), 'migrated hook must carry v2 marker');
235
- assert(!hookBody.includes(LEGACY_HOOK_MARKER), 'migrated hook must NOT carry the legacy v1 marker');
236
- assert(hookBody.includes('ELECTRON_RUN_AS_NODE=1'), 'T02 contract applies to migrated hooks too');
237
- // Commit a change
238
- fs.writeFileSync(path.join(legacyRepo, 'feature-b.txt'), 'feature b\n');
239
- git(legacyRepo, ['add', 'feature-b.txt']);
240
- git(legacyRepo, ['commit', '-q', '-m', 'scenario-b: feature b']);
241
- const headB = git(legacyRepo, ['rev-parse', 'HEAD']);
242
- let stateB = null;
243
- for (let attempt = 0; attempt < 30; attempt += 1) {
244
- try {
245
- const r = await serverFetch(serverB, `${serverB.base}/api/projects/${projectB}`, undefined);
246
- if (r.status === 200 && r.body.project.state.lastAnalyzedCommit === headB) {
247
- stateB = r.body.project.state;
248
- break;
249
- }
250
- } catch {}
251
- await new Promise(resolve => setTimeout(resolve, 200));
252
- }
253
- if (!stateB) {
254
- await serverFetch(serverB, `${serverB.base}/api/hooks/post-commit`, {
255
- method: 'POST', headers: { 'content-type': 'application/json' },
256
- body: JSON.stringify({
257
- schema: 'hook-event/v2', projectId: projectB, repoRoot: legacyRepo,
258
- head: headB, branch: 'main', operationId: `op-scenario-b-${Date.now()}`,
259
- }),
260
- });
261
- stateB = await waitForState(serverB, projectB, s => s.lastAnalyzedCommit === headB, 'scenario B reconciliation');
262
- }
263
- assert.strictEqual(stateB.analysis.activeClaim, null);
264
- const mdPath = path.join(legacyProject.config.knowledgePath, 'changes', `${headB.slice(0, 12)}.md`);
265
- assert(fs.existsSync(mdPath), `knowledge Markdown must exist at ${mdPath}`);
266
- } finally {
267
- await killServer(serverB);
268
- }
269
-
270
- // Scenario C — backend offline, then restart. Restart must preserve facts
271
- // but must not infer this missed commit for knowledge analysis.
272
- fs.writeFileSync(path.join(legacyRepo, 'feature-c.txt'), 'feature c (offline)\n');
273
- git(legacyRepo, ['add', 'feature-c.txt']);
274
- git(legacyRepo, ['commit', '-q', '-m', 'scenario-c: offline commit']);
275
- const headC = git(legacyRepo, ['rev-parse', 'HEAD']);
276
- const serverC = spawnServer({
277
- root: ROOT, port: BASE_PORT, dataDir, tag: 'p0e2e-c',
278
- extraEnv: { KB_AUTOMATION_FAKE_CLAUDE: '1', KB_EMBEDDING_FAKE: '1' },
279
- });
280
- serverC.base = `http://127.0.0.1:${BASE_PORT}`;
281
- try {
282
- await waitForHealth(serverC);
283
- const projectIdC = (await serverFetch(serverC, `${serverC.base}/api/state`, undefined))
284
- .body.projects.find(p => p.config.displayName === 'Legacy').projectId;
285
- await new Promise(resolve => setTimeout(resolve, 500));
286
- const stateC = (await serverFetch(serverC, `${serverC.base}/api/projects/${projectIdC}`, undefined)).body.project.state;
287
- assert.notStrictEqual(stateC.lastAnalyzedCommit, headC, 'startup must not analyze an offline commit');
288
- const legacyKbC = (await serverFetch(serverC, `${serverC.base}/api/state`, undefined))
289
- .body.projects.find(p => p.config.displayName === 'Legacy').config.knowledgePath;
290
- assert.strictEqual(fs.existsSync(path.join(legacyKbC, 'changes', `${headC.slice(0, 12)}.md`)), false);
291
- } finally {
292
- await killServer(serverC);
293
- }
294
-
295
- // Scenario D — no conversation captured. With KB_AUTOMATION_FAKE_CLAUDE
296
- // the analyzer uses the fake result path that does not depend on the
297
- // Bridge cursor advancing; we verify the same flow still produces a
298
- // Markdown file from Git evidence alone.
299
- fs.writeFileSync(path.join(legacyRepo, 'feature-d.txt'), 'feature d (no conversation)\n');
300
- git(legacyRepo, ['add', 'feature-d.txt']);
301
- git(legacyRepo, ['commit', '-q', '-m', 'scenario-d: no conversation']);
302
- const headD = git(legacyRepo, ['rev-parse', 'HEAD']);
303
- const serverD = spawnServer({
304
- root: ROOT, port: BASE_PORT, dataDir, tag: 'p0e2e-d',
305
- extraEnv: { KB_AUTOMATION_FAKE_CLAUDE: '1', KB_EMBEDDING_FAKE: '1' },
306
- });
307
- serverD.base = `http://127.0.0.1:${BASE_PORT}`;
308
- try {
309
- await waitForHealth(serverD);
310
- const projectId = (await serverFetch(serverD, `${serverD.base}/api/state`, undefined))
311
- .body.projects.find(p => p.config.displayName === 'Legacy').projectId;
312
- let stateD = null;
313
- for (let attempt = 0; attempt < 30; attempt += 1) {
314
- try {
315
- const r = await serverFetch(serverD, `${serverD.base}/api/projects/${projectId}`, undefined);
316
- if (r.status === 200 && r.body.project.state.lastAnalyzedCommit === headD) {
317
- stateD = r.body.project.state;
318
- break;
319
- }
320
- } catch {}
321
- await new Promise(resolve => setTimeout(resolve, 200));
322
- }
323
- if (!stateD) {
324
- await serverFetch(serverD, `${serverD.base}/api/hooks/post-commit`, {
325
- method: 'POST', headers: { 'content-type': 'application/json' },
326
- body: JSON.stringify({
327
- schema: 'hook-event/v2', projectId, repoRoot: legacyRepo,
328
- head: headD, branch: 'main', operationId: `op-scenario-d-${Date.now()}`,
329
- }),
330
- });
331
- stateD = await waitForState(serverD, projectId, s => s.lastAnalyzedCommit === headD, 'scenario D reconciliation without conversation');
332
- }
333
- const legacyKb = (await serverFetch(serverD, `${serverD.base}/api/state`, undefined))
334
- .body.projects.find(p => p.config.displayName === 'Legacy').config.knowledgePath;
335
- const mdPath = path.join(legacyKb, 'changes', `${headD.slice(0, 12)}.md`);
336
- assert(fs.existsSync(mdPath), `scenario D must still produce Markdown at ${mdPath}`);
337
- } finally {
338
- await killServer(serverD);
339
- fs.rmSync(dataDir, { recursive: true, force: true });
340
- fs.rmSync(freshRepo, { recursive: true, force: true });
341
- fs.rmSync(legacyRepo, { recursive: true, force: true });
342
- }
343
- console.log('p0-e2e-gate-test PASS');
344
- })().catch(error => {
345
- console.error(error.stack || error.message);
346
- process.exit(1);
347
- });
@@ -1,127 +0,0 @@
1
- const assert = require('assert');
2
- const fs = require('fs');
3
- const os = require('os');
4
- const path = require('path');
5
- const { StorageLayout } = require('../lib/storage-layout');
6
- const { MigrationService } = require('../lib/migration-service');
7
-
8
- function fixture() {
9
- const dataDir = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-layout-v2-migration-'));
10
- const oldRoot = path.join(dataDir, 'old-knowledge');
11
- const differentRoot = path.join(dataDir, 'different-current-root');
12
- fs.mkdirSync(oldRoot, { recursive: true });
13
- const exactKbPath = path.join(oldRoot, 'legacy-a-fixed');
14
- fs.mkdirSync(exactKbPath, { recursive: true });
15
- fs.writeFileSync(path.join(exactKbPath, 'README.md'), '# existing knowledge\n', 'utf8');
16
- fs.writeFileSync(path.join(dataDir, 'projects.json'), JSON.stringify({
17
- legacyA: {
18
- displayName: 'Legacy A',
19
- localPath: path.join(dataDir, 'repo-a'),
20
- gitPath: path.join(dataDir, 'repo-a'),
21
- kbPath: exactKbPath,
22
- trackingStartCommit: 'track-a',
23
- lastAnalyzedCommit: 'last-a',
24
- enabled: true,
25
- aiProfileId: 'primary',
26
- },
27
- legacyB: {
28
- displayName: 'Legacy B',
29
- localPath: path.join(dataDir, 'repo-b'),
30
- trackingStartCommit: 'track-b',
31
- enabled: true,
32
- },
33
- }, null, 2));
34
- fs.writeFileSync(path.join(dataDir, 'knowledge-store.json'), JSON.stringify({ rootPath: differentRoot, configured: true }));
35
- fs.writeFileSync(path.join(dataDir, 'ai-profiles.json'), JSON.stringify({ schema: 'ai-profiles/v1', profiles: [{ id: 'primary', apiKey: 'exact-secret-value' }] }));
36
- fs.writeFileSync(path.join(dataDir, 'embedding-config.json'), JSON.stringify({ modelId: 'model-a' }));
37
- fs.writeFileSync(path.join(dataDir, 'logging.json'), JSON.stringify({ levels: ['debug', 'info', 'error'], retentionDays: 0, maxTotalSizeMB: 512 }));
38
- fs.writeFileSync(path.join(dataDir, 'claude-prompts.json'), JSON.stringify({ hookPromptTemplate: 'legacy override' }));
39
- fs.writeFileSync(path.join(dataDir, '.hook-trigger-errors.log'), '2026-01-01 old hook error\n');
40
- return { dataDir, exactKbPath, differentRoot };
41
- }
42
-
43
- (async () => {
44
- {
45
- const { dataDir, exactKbPath, differentRoot } = fixture();
46
- const layout = new StorageLayout({ dataDir });
47
- const migration = new MigrationService({ layout, legacyDataDir: dataDir });
48
- const result = await migration.migrateIfNeeded({ migrationRunId: 'layout-v2-success' });
49
- assert.strictEqual(result.ok, true);
50
- assert.strictEqual(result.completed, true);
51
- assert(fs.existsSync(layout.getMigrationCompletionPath()));
52
- const registry = JSON.parse(fs.readFileSync(layout.getProjectRegistryPath(), 'utf8'));
53
- assert.strictEqual(registry.schema, 'project-registry/v2');
54
- assert.strictEqual(registry.projectOrder.length, 2);
55
- const idA = result.projectMap.legacyA;
56
- const idB = result.projectMap.legacyB;
57
- const configA = JSON.parse(fs.readFileSync(layout.getProjectConfigPath(idA), 'utf8'));
58
- const configB = JSON.parse(fs.readFileSync(layout.getProjectConfigPath(idB), 'utf8'));
59
- const stateA = JSON.parse(fs.readFileSync(layout.getProjectStatePath(idA), 'utf8'));
60
- assert.strictEqual(configA.knowledgePath, exactKbPath, 'old kbPath must remain exact');
61
- assert.strictEqual(configB.knowledgePath, path.join(differentRoot, 'legacyB'));
62
- assert.strictEqual(stateA.trackingStartCommit, 'track-a');
63
- assert.strictEqual(stateA.lastAnalyzedCommit, 'last-a');
64
- const settings = JSON.parse(fs.readFileSync(layout.getSettingsPath(), 'utf8'));
65
- assert.strictEqual(settings.ai.profiles[0].apiKey, 'exact-secret-value');
66
- assert.strictEqual(Object.prototype.hasOwnProperty.call(settings.logging, 'retentionDays'), false);
67
- assert.strictEqual(settings.legacyExtensions.logging.retentionDays, 0, 'legacy logging settings remain preserved as read-only migration evidence');
68
- assert(fs.existsSync(path.join(result.recoveryDir, 'backup', 'projects.json')));
69
- assert(fs.existsSync(path.join(dataDir, '.hook-trigger-errors.log')), 'legacy hook log must remain');
70
- const second = await migration.migrateIfNeeded();
71
- assert.strictEqual(second.completed, true);
72
- assert.strictEqual(second.migrated, false);
73
- }
74
-
75
- for (const stage of ['backup', 'staging', 'validation', 'activation', 'open-verification']) {
76
- const { dataDir } = fixture();
77
- const originalProjects = fs.readFileSync(path.join(dataDir, 'projects.json'), 'utf8');
78
- const layout = new StorageLayout({ dataDir });
79
- const migration = new MigrationService({ layout, legacyDataDir: dataDir });
80
- const result = await migration.migrateIfNeeded({ migrationRunId: `fault-${stage}`, faultAt: stage });
81
- assert.strictEqual(result.ok, false, `${stage} should fail`);
82
- assert.strictEqual(result.useLegacy, true);
83
- assert.strictEqual(fs.existsSync(layout.getMigrationCompletionPath()), false, `${stage} must not write completion`);
84
- assert.strictEqual(fs.readFileSync(path.join(dataDir, 'projects.json'), 'utf8'), originalProjects, `${stage} must preserve/restore legacy registry`);
85
- const journal = JSON.parse(fs.readFileSync(path.join(result.recoveryDir, 'journal.json'), 'utf8'));
86
- assert.strictEqual(journal.phase, 'failed');
87
- assert.strictEqual(journal.rollback.ok, true, `${stage} rollback must complete`);
88
- assert.strictEqual(fs.existsSync(layout.getSettingsPath()), false, `${stage} must remove newly activated settings`);
89
- assert.strictEqual(fs.existsSync(path.join(dataDir, 'projects')), false, `${stage} must remove newly activated project metadata`);
90
- if (['activation', 'open-verification'].includes(stage)) {
91
- const retry = await migration.migrateIfNeeded({ migrationRunId: `retry-${stage}` });
92
- assert.strictEqual(retry.ok, true, `${stage} must be safely retryable after rollback`);
93
- assert.strictEqual(retry.completed, true);
94
- }
95
- }
96
-
97
- {
98
- const dataDir = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-layout-v2-fresh-'));
99
- const layout = new StorageLayout({ dataDir });
100
- const result = await new MigrationService({ layout }).migrateIfNeeded();
101
- assert.strictEqual(result.reason, 'fresh-install');
102
- assert.strictEqual(fs.existsSync(layout.getRecoveryPath()), false, 'fresh install must not create optional recovery dir');
103
- }
104
-
105
- {
106
- // Regression: legacy files carrying a UTF-8 BOM (common from PowerShell
107
- // tooling) must migrate cleanly instead of failing as corrupt sources.
108
- const dataDir = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-layout-v2-bom-'));
109
- const layout = new StorageLayout({ dataDir });
110
- const bom = Buffer.concat([Buffer.from([0xef, 0xbb, 0xbf]), Buffer.from(JSON.stringify({
111
- legacyA: { displayName: 'BOM A', localPath: path.join(dataDir, 'repo-a'), trackingStartCommit: 'track-a', enabled: true }
112
- }), 'utf8')]);
113
- fs.writeFileSync(path.join(dataDir, 'projects.json'), bom);
114
- fs.writeFileSync(path.join(dataDir, 'team-git-providers.json'), Buffer.concat([Buffer.from([0xef, 0xbb, 0xbf]), Buffer.from('{}', 'utf8')]));
115
- const result = await new MigrationService({ layout, legacyDataDir: dataDir }).migrateIfNeeded();
116
- assert.strictEqual(result.ok, true, 'BOM-prefixed legacy sources must migrate');
117
- assert.strictEqual(result.migrated, true);
118
- const registry = JSON.parse(fs.readFileSync(layout.getProjectRegistryPath(), 'utf8'));
119
- assert.strictEqual(registry.schema, 'project-registry/v2');
120
- assert.strictEqual(Object.keys(registry.projects).length, 1);
121
- }
122
-
123
- console.log('project-layout-v2-migration-test PASS');
124
- })().catch(error => {
125
- console.error(error.stack || error.message);
126
- process.exitCode = 1;
127
- });
@@ -1,27 +0,0 @@
1
- const assert = require('assert');
2
- const fs = require('fs');
3
- const os = require('os');
4
- const path = require('path');
5
- const { initializeRuntime } = require('../lib/server-app');
6
-
7
- const root = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-runtime-migration-safety-'));
8
- let settingsInitialized = false;
9
- let registryInitialized = false;
10
- const runtime = {
11
- rootDir: path.join(root, 'missing-legacy-root'),
12
- dataPath: path.join(root, 'data'),
13
- logger: { info: async () => {} },
14
- migrationService: { migrateIfNeeded: async () => ({ ok: false, requiresManualRecovery: true, reason: 'fault-injected' }) },
15
- settingsStore: { initialize: async () => { settingsInitialized = true; } },
16
- registryStore: { initialize: async () => { registryInitialized = true; } },
17
- };
18
-
19
- initializeRuntime(runtime).then(() => {
20
- throw new Error('initializeRuntime must reject an unsuccessful migration');
21
- }).catch(error => {
22
- assert.equal(error.code, 'MIGRATION_FAILED');
23
- assert.equal(settingsInitialized, false, 'settings defaults must not be initialized after migration failure');
24
- assert.equal(registryInitialized, false, 'empty project registry must not be initialized after migration failure');
25
- fs.rmSync(root, { recursive: true, force: true });
26
- console.log('server-runtime-migration-safety-test PASS');
27
- });
@@ -1,56 +0,0 @@
1
- const assert = require('assert');
2
- const fs = require('fs');
3
- const os = require('os');
4
- const path = require('path');
5
- const { StorageLayout } = require('../lib/storage-layout');
6
- const { MigrationService } = require('../lib/migration-service');
7
- const { publicAiProfilesConfig } = require('../lib/contracts');
8
-
9
- function fixture() {
10
- const dataDir = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-v4122-upgrade-'));
11
- const knowledgeRoot = path.join(dataDir, 'knowledge-root');
12
- const projects = {};
13
- for (const slug of ['alpha', 'beta', 'gamma']) {
14
- const repoPath = path.join(dataDir, 'repos', slug);
15
- const knowledgePath = path.join(knowledgeRoot, `preserved-${slug}`);
16
- fs.mkdirSync(knowledgePath, { recursive: true });
17
- fs.writeFileSync(path.join(knowledgePath, 'README.md'), `# ${slug}\n`);
18
- projects[slug] = { repoPath, kbPath: knowledgePath, aiProfileId: slug === 'alpha' ? 'primary' : 'secondary' };
19
- }
20
- fs.writeFileSync(path.join(dataDir, 'projects.json'), JSON.stringify(projects));
21
- fs.writeFileSync(path.join(dataDir, 'knowledge-store.json'), JSON.stringify({ rootPath: knowledgeRoot }));
22
- fs.writeFileSync(path.join(dataDir, 'ai-profiles.json'), JSON.stringify({ profiles: [
23
- { id: 'primary', apiKey: 'fixture-secret-one', model: 'model-a' },
24
- { id: 'secondary', apiKey: 'fixture-secret-two', model: 'model-b' },
25
- ] }));
26
- fs.writeFileSync(path.join(dataDir, 'embedding-config.json'), JSON.stringify({ modelId: 'embedding-v4122', localFilesOnly: true, localModelPath: path.join(dataDir, 'models') }));
27
- fs.mkdirSync(path.join(dataDir, 'models', 'A', 'B'), { recursive: true });
28
- fs.writeFileSync(path.join(dataDir, 'models', 'A', 'B', 'model.onnx'), 'exact-model-content');
29
- return { dataDir, knowledgeRoot, projects };
30
- }
31
-
32
- (async () => {
33
- const { dataDir, knowledgeRoot, projects } = fixture();
34
- try {
35
- const layout = new StorageLayout({ dataDir });
36
- const result = await new MigrationService({ layout, legacyDataDir: dataDir }).migrateIfNeeded({ migrationRunId: 'v4122-contract' });
37
- assert.equal(result.ok, true);
38
- const registry = JSON.parse(fs.readFileSync(layout.getProjectRegistryPath(), 'utf8'));
39
- assert.equal(registry.projectOrder.length, 3);
40
- const settings = JSON.parse(fs.readFileSync(layout.getSettingsPath(), 'utf8'));
41
- assert.equal(settings.knowledge.rootPath, knowledgeRoot);
42
- assert.deepEqual(settings.embedding, { modelId: 'embedding-v4122', localFilesOnly: true, localModelPath: path.join(dataDir, 'models') });
43
- assert.equal(settings.ai.profiles.length, 2);
44
- assert.equal(publicAiProfilesConfig(settings.ai).profiles.every(profile => profile.hasApiKey && !Object.hasOwn(profile, 'apiKey')), true);
45
- for (const projectId of registry.projectOrder) {
46
- const config = JSON.parse(fs.readFileSync(layout.getProjectConfigPath(projectId), 'utf8'));
47
- const legacy = projects[config.legacyExtensions.slug];
48
- assert.equal(config.repoPath, legacy.repoPath);
49
- assert.equal(config.knowledgePath, legacy.kbPath);
50
- }
51
- assert.equal(fs.readFileSync(path.join(dataDir, 'cache', 'models', 'A', 'B', 'model.onnx'), 'utf8'), 'exact-model-content');
52
- assert.equal(result.marker.projectCount, 3);
53
- assert.equal(result.marker.aiProfileCount, 2);
54
- } finally { fs.rmSync(dataDir, { recursive: true, force: true }); }
55
- console.log('v4122-upgrade-data-contract-test PASS');
56
- })().catch(error => { console.error(error.stack || error.message); process.exit(1); });
@@ -1,40 +0,0 @@
1
- const fs = require('fs');
2
- const path = require('path');
3
- const { SCHEMAS } = require('./contracts');
4
- const { LEGACY_ASSETS, assetPath } = require('./legacy-data-manifest');
5
-
6
- const STATES = Object.freeze({ FRESH: 'FRESH', LEGACY: 'LEGACY', V2_VALID: 'V2_VALID', MIGRATION_INCOMPLETE: 'MIGRATION_INCOMPLETE', CONFLICT: 'CONFLICT', CORRUPT: 'CORRUPT' });
7
-
8
- function readJson(filePath) {
9
- if (!fs.existsSync(filePath)) return { exists: false, value: null };
10
- try { const raw = fs.readFileSync(filePath, 'utf8'); return { exists: true, value: JSON.parse(raw.charCodeAt(0) === 0xfeff ? raw.slice(1) : raw) }; }
11
- catch (error) { return { exists: true, error }; }
12
- }
13
- function isEmptyJson(value) {
14
- if (value == null || typeof value !== 'object') return false;
15
- if (Array.isArray(value)) return value.length === 0;
16
- if (value.schema === SCHEMAS.projectRegistry) return Array.isArray(value.projectOrder) && value.projectOrder.length === 0;
17
- return Object.keys(value).length === 0;
18
- }
19
- function hasRecovery(root) { const recovery = path.join(root, 'recovery'); return fs.existsSync(recovery) && fs.statSync(recovery).isDirectory() && fs.readdirSync(recovery).length > 0; }
20
- function classifyDataState(root) {
21
- const projects = readJson(path.join(root, 'projects.json'));
22
- const settings = readJson(path.join(root, 'settings.json'));
23
- if (projects.error || settings.error) return { state: STATES.CORRUPT, projects, settings };
24
- // Logs and hook diagnostics can be created before startup classification;
25
- // alone they are not user configuration evidence and must not turn a clean
26
- // install into an impossible legacy migration.
27
- const hasLegacyAssets = LEGACY_ASSETS.some(asset => asset.authority !== 'history' && fs.existsSync(assetPath(root, asset)));
28
- const isV2 = projects.value && projects.value.schema === SCHEMAS.projectRegistry && projects.value.schemaVersion === 2;
29
- const settingsV2 = settings.value && settings.value.schema === SCHEMAS.settings && settings.value.schemaVersion === 2;
30
- if (isV2 && settingsV2) return { state: STATES.V2_VALID, projects, settings, hasLegacyAssets };
31
- // A failed migration may have written default v2 settings before activation.
32
- // A non-v2 projects registry remains authoritative legacy evidence and is
33
- // eligible for a controlled retry; it must never be classified as Fresh.
34
- if (projects.exists && !isV2 && hasLegacyAssets) return { state: STATES.LEGACY, projects, settings, hasLegacyAssets };
35
- if (isV2 || settingsV2 || hasRecovery(root)) return { state: STATES.MIGRATION_INCOMPLETE, projects, settings, hasLegacyAssets };
36
- if (hasLegacyAssets) return { state: STATES.LEGACY, projects, settings, hasLegacyAssets };
37
- return { state: STATES.FRESH, projects, settings, hasLegacyAssets };
38
- }
39
-
40
- module.exports = { STATES, readJson, isEmptyJson, classifyDataState };