@sanqianx/project-knowledge 4.6.1 → 4.8.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 (198) hide show
  1. package/.agents/plugins/marketplace.json +17 -17
  2. package/.claude-plugin/marketplace.json +1 -1
  3. package/CHANGELOG.md +817 -780
  4. package/README.md +48 -36
  5. package/_modules/knowledge-engine/README.md +88 -0
  6. package/_modules/knowledge-engine/package.json +38 -0
  7. package/_modules/knowledge-engine/src/analysis-contract.js +25 -0
  8. package/_modules/knowledge-engine/src/analysis-worker.js +54 -0
  9. package/_modules/knowledge-engine/src/bin.js +52 -0
  10. package/_modules/knowledge-engine/src/bridge-client.js +24 -0
  11. package/_modules/knowledge-engine/src/coordinator.js +255 -0
  12. package/_modules/knowledge-engine/src/headless-analyzer.js +75 -0
  13. package/_modules/knowledge-engine/src/memories.js +85 -0
  14. package/_modules/knowledge-engine/src/migration.js +88 -0
  15. package/_modules/knowledge-engine/src/retrieval.js +116 -0
  16. package/_modules/knowledge-engine/src/runtime/README.md +7 -0
  17. package/_modules/knowledge-engine/src/runtime/atomic-file.js +204 -0
  18. package/_modules/knowledge-engine/src/runtime/automation-config.js +140 -0
  19. package/_modules/knowledge-engine/src/runtime/commit-conversation-binder.js +249 -0
  20. package/_modules/knowledge-engine/src/runtime/commit-processing-ledger.js +26 -0
  21. package/_modules/knowledge-engine/src/runtime/commit-prompt.js +202 -0
  22. package/_modules/knowledge-engine/src/runtime/commit-reconciler.js +432 -0
  23. package/_modules/knowledge-engine/src/runtime/content-hash.js +4 -0
  24. package/_modules/knowledge-engine/src/runtime/contracts.js +279 -0
  25. package/_modules/knowledge-engine/src/runtime/conversation-exclusions.js +204 -0
  26. package/_modules/knowledge-engine/src/runtime/conversation-store.js +387 -0
  27. package/_modules/knowledge-engine/src/runtime/evidence-bundle.js +228 -0
  28. package/_modules/knowledge-engine/src/runtime/git-runner.js +62 -0
  29. package/_modules/knowledge-engine/src/runtime/knowledge-promotion.js +444 -0
  30. package/_modules/knowledge-engine/src/runtime/knowledge-retrieval-service.js +402 -0
  31. package/_modules/knowledge-engine/src/runtime/layout.js +44 -0
  32. package/_modules/knowledge-engine/src/runtime/markdown-knowledge-indexer.js +230 -0
  33. package/_modules/knowledge-engine/src/runtime/scanner.js +298 -0
  34. package/_modules/knowledge-engine/src/server.js +155 -0
  35. package/_modules/knowledge-engine/src/store.js +239 -0
  36. package/_modules/knowledge-engine/ui/app.css +172 -0
  37. package/_modules/knowledge-engine/ui/app.js +297 -0
  38. package/_modules/knowledge-engine/ui/index.html +95 -0
  39. package/_site/README.md +30 -30
  40. package/_site/_test/ai-profile-resolver-test.js +137 -137
  41. package/_site/_test/automation-queue-test.js +14 -14
  42. package/_site/_test/automation-ui-test.js +40 -40
  43. package/_site/_test/background-task-registry-test.js +43 -43
  44. package/_site/_test/baseline-schema-test.js +91 -91
  45. package/_site/_test/bridge-adapter-test.js +1 -1
  46. package/_site/_test/bridge-consumer-service-test.js +1 -1
  47. package/_site/_test/chat-claudecodeui-match-test.js +92 -92
  48. package/_site/_test/claude-executable-discovery-test.js +62 -62
  49. package/_site/_test/claude-workbench-test.js +170 -170
  50. package/_site/_test/client-capture-restart-e2e-test.js +4 -4
  51. package/_site/_test/codex-conversation-projection-test.js +2 -1
  52. package/_site/_test/commit-boundary-freeze-test.js +1 -1
  53. package/_site/_test/commit-conversation-binding-test.js +95 -95
  54. package/_site/_test/commit-evidence-test.js +110 -110
  55. package/_site/_test/conversation-api-test.js +109 -109
  56. package/_site/_test/conversation-store-test.js +136 -136
  57. package/_site/_test/cross-repo-isolation-e2e-test.js +2 -2
  58. package/_site/_test/data-dir-migration-test.js +57 -57
  59. package/_site/_test/desktop-browser-compat-test.js +28 -28
  60. package/_site/_test/desktop-hook-runtime-regression-test.js +204 -204
  61. package/_site/_test/explicit-commit-processor-test.js +37 -37
  62. package/_site/_test/fixtures/make-git-repos.js +12 -1
  63. package/_site/_test/folder-picker-output-test.js +19 -19
  64. package/_site/_test/full-integration-e2e-test.js +165 -165
  65. package/_site/_test/git-validation-test.js +2 -2
  66. package/_site/_test/hook-runtime-endpoint-test.js +88 -88
  67. package/_site/_test/hook-status-repair-api-test.js +152 -152
  68. package/_site/_test/hook-trigger-test.js +85 -85
  69. package/_site/_test/import-preflight-api-test.js +234 -233
  70. package/_site/_test/index-writer-concurrency-test.js +135 -135
  71. package/_site/_test/integration-adapters-test.js +171 -171
  72. package/_site/_test/integration-capture-setup-test.js +1 -1
  73. package/_site/_test/integration-surface-coverage-test.js +164 -164
  74. package/_site/_test/knowledge-language-control-test.js +170 -170
  75. package/_site/_test/knowledge-promotion-recovery-test.js +260 -260
  76. package/_site/_test/knowledge-query-test.js +54 -54
  77. package/_site/_test/knowledge-retrieval-service-test.js +77 -77
  78. package/_site/_test/knowledge-storage-startup-test.js +52 -52
  79. package/_site/_test/knowledge-store-logs-supervision-test.js +89 -89
  80. package/_site/_test/legacy-forward-compat-test.js +257 -257
  81. package/_site/_test/legacy-project-upgrade-e2e-test.js +363 -363
  82. package/_site/_test/logging-api-test.js +89 -89
  83. package/_site/_test/logging-sse-no-gap-test.js +88 -88
  84. package/_site/_test/logging-ui-test.js +106 -104
  85. package/_site/_test/markdown-delta-overlay-test.js +85 -85
  86. package/_site/_test/markdown-maintenance-api-test.js +75 -75
  87. package/_site/_test/mcp-server-test.js +149 -149
  88. package/_site/_test/module-artifact-integrity-test.js +27 -0
  89. package/_site/_test/module-boundary-test.js +30 -0
  90. package/_site/_test/module-bridge-eventbridge-test.js +7 -0
  91. package/_site/_test/module-model-configuration-test.js +43 -0
  92. package/_site/_test/module-process-lifecycle-test.js +24 -0
  93. package/_site/_test/module-stream-proxy-test.js +34 -0
  94. package/_site/_test/non-release-ci-test.js +34 -34
  95. package/_site/_test/offline-boundary-isolation-test.js +32 -32
  96. package/_site/_test/p0-data-migration-characterization-test.js +37 -37
  97. package/_site/_test/p0-e2e-gate-test.js +347 -347
  98. package/_site/_test/packaged-ui-smoke-test.js +19 -10
  99. package/_site/_test/path-consistency-test.js +151 -151
  100. package/_site/_test/pending-sweep-test.js +9 -9
  101. package/_site/_test/post-commit-automation-test.js +87 -87
  102. package/_site/_test/product-diagnostics-ui-test.js +75 -0
  103. package/_site/_test/product-import-ui-test.js +92 -0
  104. package/_site/_test/project-delete-recovery-test.js +64 -64
  105. package/_site/_test/project-goal-editor-test.js +144 -144
  106. package/_site/_test/project-layout-v2-migration-test.js +127 -127
  107. package/_site/_test/project-lifecycle-transaction-test.js +106 -106
  108. package/_site/_test/prompt-settings-test.js +115 -115
  109. package/_site/_test/protected-architecture-gate-test.js +122 -122
  110. package/_site/_test/refactor-characterization-test.js +36 -36
  111. package/_site/_test/release-version-sync-test.js +1 -1
  112. package/_site/_test/requirement-recorder-test.js +173 -173
  113. package/_site/_test/run-all-tests.js +159 -156
  114. package/_site/_test/server-runtime-migration-safety-test.js +27 -27
  115. package/_site/_test/shared-contracts-test.js +58 -58
  116. package/_site/_test/startup-analysis-disabled-test.js +10 -10
  117. package/_site/_test/storage-foundation-test.js +78 -78
  118. package/_site/_test/structured-logger-test.js +101 -101
  119. package/_site/_test/tracking-start-test.js +108 -108
  120. package/_site/_test/v4122-upgrade-data-contract-test.js +56 -56
  121. package/_site/_test/workbench-permission-test.js +117 -117
  122. package/_site/_test/workspace-ui-contract-test.js +28 -43
  123. package/_site/lib/ai-profile-resolver.js +78 -78
  124. package/_site/lib/ai-workspace.js +101 -101
  125. package/_site/lib/automation-config.js +140 -140
  126. package/_site/lib/bridge-adapter.js +5 -1
  127. package/_site/lib/bridge-consumer-service.js +402 -402
  128. package/_site/lib/claude-cli-runner.js +1510 -1510
  129. package/_site/lib/commit-conversation-binder.js +234 -234
  130. package/_site/lib/commit-processing-ledger.js +27 -27
  131. package/_site/lib/commit-prompt.js +202 -202
  132. package/_site/lib/commit-reconciler.js +406 -406
  133. package/_site/lib/contracts.js +284 -279
  134. package/_site/lib/conversation-query-service.js +144 -144
  135. package/_site/lib/conversation-store.js +385 -385
  136. package/_site/lib/data-dir.js +74 -74
  137. package/_site/lib/data-state-classifier.js +40 -40
  138. package/_site/lib/engine-cutover.js +97 -0
  139. package/_site/lib/evidence-bundle.js +228 -228
  140. package/_site/lib/folder-picker-output.js +21 -21
  141. package/_site/lib/git-runner.js +62 -62
  142. package/_site/lib/github-team-store.js +1172 -1172
  143. package/_site/lib/hook-manager.js +203 -202
  144. package/_site/lib/index-service.js +173 -173
  145. package/_site/lib/integration-installer.js +907 -907
  146. package/_site/lib/kb-framework.js +176 -176
  147. package/_site/lib/kb-validator.js +124 -124
  148. package/_site/lib/knowledge-promotion.js +435 -435
  149. package/_site/lib/knowledge-retrieval-service.js +401 -401
  150. package/_site/lib/knowledge-tool-runtime.js +359 -359
  151. package/_site/lib/legacy-data-manifest.js +26 -26
  152. package/_site/lib/llm-client.js +161 -161
  153. package/_site/lib/markdown-knowledge-indexer.js +230 -230
  154. package/_site/lib/migration-service.js +442 -442
  155. package/_site/lib/module-bridge.js +198 -33
  156. package/_site/lib/post-commit-automation.js +87 -87
  157. package/_site/lib/project-lifecycle-service.js +519 -497
  158. package/_site/lib/project-store.js +268 -262
  159. package/_site/lib/requirement-recorder.js +278 -278
  160. package/_site/lib/runtime-endpoint.js +155 -155
  161. package/_site/lib/scanner.js +298 -298
  162. package/_site/lib/server-app.js +1590 -1520
  163. package/_site/lib/settings-store.js +133 -113
  164. package/_site/lib/storage-layout.js +162 -162
  165. package/_site/lib/structured-logger.js +574 -574
  166. package/_site/scripts/folder-picker.ps1 +156 -156
  167. package/_site/scripts/hook-trigger.js +157 -156
  168. package/_site/scripts/install-module-candidates.js +69 -0
  169. package/_site/scripts/pack-module-candidates.js +72 -0
  170. package/_site/scripts/sync-release-version.js +2 -2
  171. package/_site/scripts/vendor-modules.js +47 -0
  172. package/_site/scripts/verify-module-runtime.js +45 -0
  173. package/_site/scripts/verify-product-runtime.js +34 -0
  174. package/bin/project-knowledge-mcp.js +194 -194
  175. package/docs/README.zh-CN.md +34 -25
  176. package/docs/project-registry-schema.md +22 -22
  177. package/docs/testing-strategy.md +33 -33
  178. package/module-runtime-manifest.json +220 -0
  179. package/package.json +13 -10
  180. package/plugins/project-knowledge/.claude-plugin/plugin.json +1 -1
  181. package/plugins/project-knowledge/.codex-plugin/plugin.json +1 -1
  182. package/plugins/project-knowledge/.mcp.json +1 -1
  183. package/plugins/project-knowledge/opencode/project-knowledge.md +3 -3
  184. package/plugins/project-knowledge/skills/project-knowledge/SKILL.md +28 -28
  185. package/templates/project-readme.md +34 -34
  186. package/ui/favicon.svg +38 -38
  187. package/ui/index.html +51 -149
  188. package/ui/product.css +9 -0
  189. package/ui/product.js +386 -0
  190. package/vendor-manifest.json +46 -0
  191. package/_site/_test/import-ui-flow-test.js +0 -171
  192. package/_site/_test/project-control-panel-task14-test.js +0 -63
  193. package/_site/_test/task15-20-ui-flow-test.js +0 -148
  194. package/_site/_test/ui-i18n-toggle-test.js +0 -114
  195. package/_site/_test/ui-smoke-test.js +0 -73
  196. package/ui/app.css +0 -58
  197. package/ui/app.js +0 -607
  198. package/ui/i18n.js +0 -146
@@ -1,204 +1,204 @@
1
- // _site/_test/desktop-hook-runtime-regression-test.js
2
- //
3
- // Characterization harness for the post-commit hook runtime contract.
4
- // The current regression (RC-01) is that buildHookBody defaults
5
- // nodeExecutable to process.execPath, which in Desktop mode points at the
6
- // Electron executable rather than a real Node binary. When Git invokes the
7
- // hook from a normal shell, the script therefore launches Electron instead
8
- // of executing hook-trigger.js.
9
- //
10
- // These tests must:
11
- // - PASS for healthy CLI installs with an explicit Node executable;
12
- // - EXPOSE the regression when the default is left to process.execPath in a
13
- // simulated Desktop environment.
14
-
15
- const assert = require('assert');
16
- const fs = require('fs');
17
- const os = require('os');
18
- const path = require('path');
19
- const { spawnSync } = require('child_process');
20
-
21
- const {
22
- buildHookBody,
23
- installHook,
24
- readHookStatus,
25
- parseManagedMarker,
26
- HOOK_MARKER,
27
- } = require('../lib/hook-manager');
28
-
29
- const ROOT = path.resolve(__dirname, '..', '..');
30
- const TRIGGER = path.join(ROOT, '_site', 'scripts', 'hook-trigger.js');
31
-
32
- function git(repo, args) {
33
- const result = spawnSync('git', ['-C', repo, ...args], {
34
- encoding: 'utf8',
35
- windowsHide: true,
36
- env: { ...process.env, GIT_TERMINAL_PROMPT: '0' },
37
- });
38
- if (result.status !== 0) throw new Error(result.stderr || `git ${args.join(' ')} failed: ${result.status}`);
39
- return String(result.stdout || '').trim();
40
- }
41
-
42
- function makeRepo() {
43
- const repo = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-desktop-hook-'));
44
- git(repo, ['init', '-q', '-b', 'main']);
45
- git(repo, ['config', 'user.email', 'desktop-hook@example.local']);
46
- git(repo, ['config', 'user.name', 'Desktop Hook Test']);
47
- fs.writeFileSync(path.join(repo, 'README.md'), '# desktop hook\n');
48
- git(repo, ['add', 'README.md']);
49
- git(repo, ['commit', '-q', '-m', 'initial']);
50
- return repo;
51
- }
52
-
53
- (async () => {
54
- // ---- Case 1: explicit real Node executable must be persisted verbatim ----
55
- {
56
- const repo = makeRepo();
57
- const projectId = 'project-desktop-hook';
58
- const fakeNode = path.join(ROOT, '_site', '_test', 'fixtures', 'fake-browser-exit.js');
59
- const body = buildHookBody({
60
- projectId,
61
- triggerScriptPath: TRIGGER,
62
- nodeExecutable: fakeNode,
63
- });
64
- assert(body.includes(fakeNode.replace(/\\/g, '/')), 'explicit Node executable must be embedded in hook body');
65
- assert(body.includes('ELECTRON_RUN_AS_NODE=1'), 'T02 contract: hook body must prefix ELECTRON_RUN_AS_NODE=1 so Desktop packaging runs as Node');
66
- fs.rmSync(repo, { recursive: true, force: true });
67
- }
68
-
69
- // ---- Case 2: installHook must accept an explicit nodeExecutable ----
70
- {
71
- const repo = makeRepo();
72
- const projectId = 'project-desktop-hook-install';
73
- const fakeNode = path.join(ROOT, '_site', '_test', 'fixtures', 'fake-browser-exit.js');
74
- const installed = installHook({
75
- repoPath: repo,
76
- projectId,
77
- triggerScriptPath: TRIGGER,
78
- nodeExecutable: fakeNode,
79
- });
80
- assert.strictEqual(installed.ok, true);
81
- const hookBody = fs.readFileSync(installed.hookPath, 'utf8');
82
- assert(hookBody.includes(fakeNode.replace(/\\/g, '/')), 'installed hook body must embed the explicit Node executable');
83
- assert.strictEqual(parseManagedMarker(hookBody).projectId, projectId);
84
- fs.rmSync(repo, { recursive: true, force: true });
85
- }
86
-
87
- // ---- Case 3: CHARACTERIZATION — Desktop executable prefix ----
88
- // The Desktop backend launches the core CLI through the Electron executable
89
- // with ELECTRON_RUN_AS_NODE=1 in the backend child environment. A Git
90
- // post-commit hook does NOT inherit that env var, so the hook body must
91
- // explicitly set ELECTRON_RUN_AS_NODE=1 before invoking the executable,
92
- // even when the executable is Electron (Desktop packaging).
93
- {
94
- const fakeElectron = path.join(os.tmpdir(), `fake-electron-${process.pid}.exe`);
95
- const body = buildHookBody({
96
- projectId: 'project-desktop-hook-default',
97
- triggerScriptPath: TRIGGER,
98
- nodeExecutable: fakeElectron,
99
- });
100
- assert(body.includes('ELECTRON_RUN_AS_NODE=1'),
101
- 'T02 contract: hook body must prefix ELECTRON_RUN_AS_NODE=1 so a Desktop Electron binary executes as Node');
102
- assert(body.includes(fakeElectron.replace(/\\/g, '/')),
103
- 'hook body must embed the resolved executable verbatim');
104
- assert(typeof body === 'string' && body.length > 0, 'hook body must be non-empty');
105
- }
106
-
107
- // ---- Case 4: hook runtime contract — trigger must run even with weird paths ----
108
- // The hook body must work when the project path contains spaces. We install
109
- // into a path that includes a literal space and confirm installHook + readback
110
- // round-trip without escaping failures.
111
- {
112
- const base = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-desktop-hook-spaces-'));
113
- const repo = path.join(base, 'project with spaces');
114
- fs.mkdirSync(repo, { recursive: true });
115
- git(repo, ['init', '-q', '-b', 'main']);
116
- git(repo, ['config', 'user.email', 'spaces@example.local']);
117
- git(repo, ['config', 'user.name', 'Spaces Test']);
118
- fs.writeFileSync(path.join(repo, 'README.md'), '# spaces\n');
119
- git(repo, ['add', 'README.md']);
120
- git(repo, ['commit', '-q', '-m', 'initial']);
121
- const fakeNode = path.join(ROOT, '_site', '_test', 'fixtures', 'fake-browser-exit.js');
122
- const installed = installHook({
123
- repoPath: repo,
124
- projectId: 'project-spaces',
125
- triggerScriptPath: TRIGGER,
126
- nodeExecutable: fakeNode,
127
- });
128
- assert.strictEqual(installed.ok, true);
129
- const status = readHookStatus({ repoPath: repo, projectId: 'project-spaces' });
130
- assert.strictEqual(status.kbManaged, true);
131
- fs.rmSync(base, { recursive: true, force: true });
132
- }
133
-
134
- // ---- Case 5: missing required args must still produce a valid hook body ----
135
- // This guards the "fail-open" property required by I-12 (Git commit must
136
- // never fail because Project-Knowledge is unavailable).
137
- {
138
- let threw = false;
139
- try {
140
- buildHookBody({ projectId: '', triggerScriptPath: TRIGGER, nodeExecutable: process.execPath });
141
- } catch (error) { threw = true; }
142
- assert.strictEqual(threw, true, 'empty projectId must be rejected by buildHookBody');
143
- }
144
-
145
- // ---- Case 6: end-to-end execution — hook body actually runs the trigger ----
146
- // Build a tiny "trigger" that records its argv + ELECTRON_RUN_AS_NODE env
147
- // to a journal, install the hook pointing at it, then exec the installed
148
- // hook via sh and assert the journal was written. This proves the hook
149
- // body resolves the executable correctly and that ELECTRON_RUN_AS_NODE=1
150
- // is set before the trigger runs (so a Desktop Electron binary would
151
- // execute as Node instead of launching as a GUI).
152
- {
153
- const repo = makeRepo();
154
- const journal = path.join(os.tmpdir(), `pk-desktop-hook-journal-${process.pid}.json`);
155
- const triggerBody = `#!/usr/bin/env node
156
- const fs = require('fs');
157
- fs.writeFileSync(${JSON.stringify(journal)}, JSON.stringify({
158
- argv: process.argv.slice(2),
159
- electronRunAsNode: process.env.ELECTRON_RUN_AS_NODE || null,
160
- execPath: process.execPath,
161
- }, null, 2));
162
- process.exit(0);
163
- `;
164
- const fakeTrigger = path.join(os.tmpdir(), `pk-fake-trigger-${process.pid}.js`);
165
- fs.writeFileSync(fakeTrigger, triggerBody);
166
- const projectId = 'project-hook-exec';
167
- const fakeNode = process.execPath; // real Node in the test env
168
- const installed = installHook({
169
- repoPath: repo,
170
- projectId,
171
- triggerScriptPath: fakeTrigger,
172
- nodeExecutable: fakeNode,
173
- });
174
- assert.strictEqual(installed.ok, true);
175
- // Execute with Git for Windows' own POSIX shell. A bare `bash` can resolve
176
- // to WSL, which cannot consume a Windows hook path.
177
- let sh = 'sh';
178
- if (process.platform === 'win32') {
179
- const where = spawnSync('where.exe', ['git'], { encoding: 'utf8', windowsHide: true });
180
- const gitPath = String(where.stdout || '').split(/\r?\n/).find(Boolean);
181
- const candidate = gitPath && path.join(path.dirname(path.dirname(gitPath)), 'bin', 'sh.exe');
182
- sh = candidate && fs.existsSync(candidate) ? candidate : 'bash';
183
- }
184
- const result = spawnSync(sh, [installed.hookPath], {
185
- encoding: 'utf8',
186
- windowsHide: true,
187
- env: { ...process.env, GIT_TERMINAL_PROMPT: '0' },
188
- });
189
- assert.strictEqual(result.status, 0, `hook must exit 0 even when Project-Knowledge is unavailable; got ${result.status}\n${result.stderr || ''}`);
190
- assert(fs.existsSync(journal), 'fake trigger must be executed by the hook body');
191
- const recorded = JSON.parse(fs.readFileSync(journal, 'utf8'));
192
- assert.strictEqual(recorded.electronRunAsNode, '1', 'ELECTRON_RUN_AS_NODE=1 must be set before the trigger runs');
193
- assert(recorded.argv.includes('--project-id'), 'trigger argv must include --project-id');
194
- assert(recorded.argv.includes(projectId), 'trigger argv must include the project id');
195
- fs.rmSync(repo, { recursive: true, force: true });
196
- fs.rmSync(fakeTrigger, { force: true });
197
- fs.rmSync(journal, { force: true });
198
- }
199
-
200
- console.log('desktop-hook-runtime-regression-test PASS');
201
- })().catch(error => {
202
- console.error(error.stack || error.message);
203
- process.exit(1);
204
- });
1
+ // _site/_test/desktop-hook-runtime-regression-test.js
2
+ //
3
+ // Characterization harness for the post-commit hook runtime contract.
4
+ // The current regression (RC-01) is that buildHookBody defaults
5
+ // nodeExecutable to process.execPath, which in Desktop mode points at the
6
+ // Electron executable rather than a real Node binary. When Git invokes the
7
+ // hook from a normal shell, the script therefore launches Electron instead
8
+ // of executing hook-trigger.js.
9
+ //
10
+ // These tests must:
11
+ // - PASS for healthy CLI installs with an explicit Node executable;
12
+ // - EXPOSE the regression when the default is left to process.execPath in a
13
+ // simulated Desktop environment.
14
+
15
+ const assert = require('assert');
16
+ const fs = require('fs');
17
+ const os = require('os');
18
+ const path = require('path');
19
+ const { spawnSync } = require('child_process');
20
+
21
+ const {
22
+ buildHookBody,
23
+ installHook,
24
+ readHookStatus,
25
+ parseManagedMarker,
26
+ HOOK_MARKER,
27
+ } = require('../lib/hook-manager');
28
+
29
+ const ROOT = path.resolve(__dirname, '..', '..');
30
+ const TRIGGER = path.join(ROOT, '_site', 'scripts', 'hook-trigger.js');
31
+
32
+ function git(repo, args) {
33
+ const result = spawnSync('git', ['-C', repo, ...args], {
34
+ encoding: 'utf8',
35
+ windowsHide: true,
36
+ env: { ...process.env, GIT_TERMINAL_PROMPT: '0' },
37
+ });
38
+ if (result.status !== 0) throw new Error(result.stderr || `git ${args.join(' ')} failed: ${result.status}`);
39
+ return String(result.stdout || '').trim();
40
+ }
41
+
42
+ function makeRepo() {
43
+ const repo = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-desktop-hook-'));
44
+ git(repo, ['init', '-q', '-b', 'main']);
45
+ git(repo, ['config', 'user.email', 'desktop-hook@example.local']);
46
+ git(repo, ['config', 'user.name', 'Desktop Hook Test']);
47
+ fs.writeFileSync(path.join(repo, 'README.md'), '# desktop hook\n');
48
+ git(repo, ['add', 'README.md']);
49
+ git(repo, ['commit', '-q', '-m', 'initial']);
50
+ return repo;
51
+ }
52
+
53
+ (async () => {
54
+ // ---- Case 1: explicit real Node executable must be persisted verbatim ----
55
+ {
56
+ const repo = makeRepo();
57
+ const projectId = 'project-desktop-hook';
58
+ const fakeNode = path.join(ROOT, '_site', '_test', 'fixtures', 'fake-browser-exit.js');
59
+ const body = buildHookBody({
60
+ projectId,
61
+ triggerScriptPath: TRIGGER,
62
+ nodeExecutable: fakeNode,
63
+ });
64
+ assert(body.includes(fakeNode.replace(/\\/g, '/')), 'explicit Node executable must be embedded in hook body');
65
+ assert(body.includes('ELECTRON_RUN_AS_NODE=1'), 'T02 contract: hook body must prefix ELECTRON_RUN_AS_NODE=1 so Desktop packaging runs as Node');
66
+ fs.rmSync(repo, { recursive: true, force: true });
67
+ }
68
+
69
+ // ---- Case 2: installHook must accept an explicit nodeExecutable ----
70
+ {
71
+ const repo = makeRepo();
72
+ const projectId = 'project-desktop-hook-install';
73
+ const fakeNode = path.join(ROOT, '_site', '_test', 'fixtures', 'fake-browser-exit.js');
74
+ const installed = installHook({
75
+ repoPath: repo,
76
+ projectId,
77
+ triggerScriptPath: TRIGGER,
78
+ nodeExecutable: fakeNode,
79
+ });
80
+ assert.strictEqual(installed.ok, true);
81
+ const hookBody = fs.readFileSync(installed.hookPath, 'utf8');
82
+ assert(hookBody.includes(fakeNode.replace(/\\/g, '/')), 'installed hook body must embed the explicit Node executable');
83
+ assert.strictEqual(parseManagedMarker(hookBody).projectId, projectId);
84
+ fs.rmSync(repo, { recursive: true, force: true });
85
+ }
86
+
87
+ // ---- Case 3: CHARACTERIZATION — Desktop executable prefix ----
88
+ // The Desktop backend launches the core CLI through the Electron executable
89
+ // with ELECTRON_RUN_AS_NODE=1 in the backend child environment. A Git
90
+ // post-commit hook does NOT inherit that env var, so the hook body must
91
+ // explicitly set ELECTRON_RUN_AS_NODE=1 before invoking the executable,
92
+ // even when the executable is Electron (Desktop packaging).
93
+ {
94
+ const fakeElectron = path.join(os.tmpdir(), `fake-electron-${process.pid}.exe`);
95
+ const body = buildHookBody({
96
+ projectId: 'project-desktop-hook-default',
97
+ triggerScriptPath: TRIGGER,
98
+ nodeExecutable: fakeElectron,
99
+ });
100
+ assert(body.includes('ELECTRON_RUN_AS_NODE=1'),
101
+ 'T02 contract: hook body must prefix ELECTRON_RUN_AS_NODE=1 so a Desktop Electron binary executes as Node');
102
+ assert(body.includes(fakeElectron.replace(/\\/g, '/')),
103
+ 'hook body must embed the resolved executable verbatim');
104
+ assert(typeof body === 'string' && body.length > 0, 'hook body must be non-empty');
105
+ }
106
+
107
+ // ---- Case 4: hook runtime contract — trigger must run even with weird paths ----
108
+ // The hook body must work when the project path contains spaces. We install
109
+ // into a path that includes a literal space and confirm installHook + readback
110
+ // round-trip without escaping failures.
111
+ {
112
+ const base = fs.mkdtempSync(path.join(os.tmpdir(), 'pk-desktop-hook-spaces-'));
113
+ const repo = path.join(base, 'project with spaces');
114
+ fs.mkdirSync(repo, { recursive: true });
115
+ git(repo, ['init', '-q', '-b', 'main']);
116
+ git(repo, ['config', 'user.email', 'spaces@example.local']);
117
+ git(repo, ['config', 'user.name', 'Spaces Test']);
118
+ fs.writeFileSync(path.join(repo, 'README.md'), '# spaces\n');
119
+ git(repo, ['add', 'README.md']);
120
+ git(repo, ['commit', '-q', '-m', 'initial']);
121
+ const fakeNode = path.join(ROOT, '_site', '_test', 'fixtures', 'fake-browser-exit.js');
122
+ const installed = installHook({
123
+ repoPath: repo,
124
+ projectId: 'project-spaces',
125
+ triggerScriptPath: TRIGGER,
126
+ nodeExecutable: fakeNode,
127
+ });
128
+ assert.strictEqual(installed.ok, true);
129
+ const status = readHookStatus({ repoPath: repo, projectId: 'project-spaces' });
130
+ assert.strictEqual(status.kbManaged, true);
131
+ fs.rmSync(base, { recursive: true, force: true });
132
+ }
133
+
134
+ // ---- Case 5: missing required args must still produce a valid hook body ----
135
+ // This guards the "fail-open" property required by I-12 (Git commit must
136
+ // never fail because Project-Knowledge is unavailable).
137
+ {
138
+ let threw = false;
139
+ try {
140
+ buildHookBody({ projectId: '', triggerScriptPath: TRIGGER, nodeExecutable: process.execPath });
141
+ } catch (error) { threw = true; }
142
+ assert.strictEqual(threw, true, 'empty projectId must be rejected by buildHookBody');
143
+ }
144
+
145
+ // ---- Case 6: end-to-end execution — hook body actually runs the trigger ----
146
+ // Build a tiny "trigger" that records its argv + ELECTRON_RUN_AS_NODE env
147
+ // to a journal, install the hook pointing at it, then exec the installed
148
+ // hook via sh and assert the journal was written. This proves the hook
149
+ // body resolves the executable correctly and that ELECTRON_RUN_AS_NODE=1
150
+ // is set before the trigger runs (so a Desktop Electron binary would
151
+ // execute as Node instead of launching as a GUI).
152
+ {
153
+ const repo = makeRepo();
154
+ const journal = path.join(os.tmpdir(), `pk-desktop-hook-journal-${process.pid}.json`);
155
+ const triggerBody = `#!/usr/bin/env node
156
+ const fs = require('fs');
157
+ fs.writeFileSync(${JSON.stringify(journal)}, JSON.stringify({
158
+ argv: process.argv.slice(2),
159
+ electronRunAsNode: process.env.ELECTRON_RUN_AS_NODE || null,
160
+ execPath: process.execPath,
161
+ }, null, 2));
162
+ process.exit(0);
163
+ `;
164
+ const fakeTrigger = path.join(os.tmpdir(), `pk-fake-trigger-${process.pid}.js`);
165
+ fs.writeFileSync(fakeTrigger, triggerBody);
166
+ const projectId = 'project-hook-exec';
167
+ const fakeNode = process.execPath; // real Node in the test env
168
+ const installed = installHook({
169
+ repoPath: repo,
170
+ projectId,
171
+ triggerScriptPath: fakeTrigger,
172
+ nodeExecutable: fakeNode,
173
+ });
174
+ assert.strictEqual(installed.ok, true);
175
+ // Execute with Git for Windows' own POSIX shell. A bare `bash` can resolve
176
+ // to WSL, which cannot consume a Windows hook path.
177
+ let sh = 'sh';
178
+ if (process.platform === 'win32') {
179
+ const where = spawnSync('where.exe', ['git'], { encoding: 'utf8', windowsHide: true });
180
+ const gitPath = String(where.stdout || '').split(/\r?\n/).find(Boolean);
181
+ const candidate = gitPath && path.join(path.dirname(path.dirname(gitPath)), 'bin', 'sh.exe');
182
+ sh = candidate && fs.existsSync(candidate) ? candidate : 'bash';
183
+ }
184
+ const result = spawnSync(sh, [installed.hookPath], {
185
+ encoding: 'utf8',
186
+ windowsHide: true,
187
+ env: { ...process.env, GIT_TERMINAL_PROMPT: '0' },
188
+ });
189
+ assert.strictEqual(result.status, 0, `hook must exit 0 even when Project-Knowledge is unavailable; got ${result.status}\n${result.stderr || ''}`);
190
+ assert(fs.existsSync(journal), 'fake trigger must be executed by the hook body');
191
+ const recorded = JSON.parse(fs.readFileSync(journal, 'utf8'));
192
+ assert.strictEqual(recorded.electronRunAsNode, '1', 'ELECTRON_RUN_AS_NODE=1 must be set before the trigger runs');
193
+ assert(recorded.argv.includes('--project-id'), 'trigger argv must include --project-id');
194
+ assert(recorded.argv.includes(projectId), 'trigger argv must include the project id');
195
+ fs.rmSync(repo, { recursive: true, force: true });
196
+ fs.rmSync(fakeTrigger, { force: true });
197
+ fs.rmSync(journal, { force: true });
198
+ }
199
+
200
+ console.log('desktop-hook-runtime-regression-test PASS');
201
+ })().catch(error => {
202
+ console.error(error.stack || error.message);
203
+ process.exit(1);
204
+ });
@@ -1,37 +1,37 @@
1
- const assert = require('assert');
2
- const { CommitReconciler } = require('../lib/commit-reconciler');
3
-
4
- const sha = suffix => `${'a'.repeat(39)}${suffix}`;
5
- const calls = [];
6
- let active = 0;
7
- let maxActive = 0;
8
- const completed = new Set();
9
- const projectStore = { readConfig: id => ({ projectId: id, enabled: true, repoPath: 'C:/fixture', knowledgePath: 'C:/knowledge' }) };
10
- const reconciler = new CommitReconciler({ projectStore, registryStore: {}, requireAiProfile: false });
11
- reconciler.processingLedger = {
12
- read: (projectId, commitSha) => completed.has(`${projectId}:${commitSha}`) ? { status: 'completed' } : null,
13
- complete: (projectId, commitSha) => { completed.add(`${projectId}:${commitSha}`); return { status: 'completed' }; },
14
- };
15
- reconciler.processCommit = async (projectId, _trigger, _operationId, _config, _branch, commitSha) => {
16
- active += 1; maxActive = Math.max(maxActive, active); calls.push(`${projectId}:${commitSha}`);
17
- await new Promise(resolve => setTimeout(resolve, 20));
18
- active -= 1;
19
- return { ok: true, commitSha, runId: `run-${commitSha.slice(-1)}`, claimFingerprint: `fp-${commitSha.slice(-1)}` };
20
- };
21
-
22
- (async () => {
23
- const d = sha('d'); const e = sha('e'); const f = sha('f');
24
- const duplicateA = reconciler.processCommitEvent({ projectId: 'project-a', commitSha: d, branch: 'main' });
25
- const duplicateB = reconciler.processCommitEvent({ projectId: 'project-a', commitSha: d, branch: 'main' });
26
- const next = reconciler.processCommitEvent({ projectId: 'project-a', commitSha: e, branch: 'main' });
27
- const other = reconciler.processCommitEvent({ projectId: 'project-b', commitSha: f, branch: 'main' });
28
- const [first, second, third, fourth] = await Promise.all([duplicateA, duplicateB, next, other]);
29
- assert.equal(first.status, 'completed'); assert.equal(second.status, 'completed');
30
- assert.equal(third.status, 'completed'); assert.equal(fourth.status, 'completed');
31
- assert.deepEqual(calls.filter(value => value.startsWith('project-a:')), [`project-a:${d}`, `project-a:${e}`]);
32
- assert.equal(calls.filter(value => value === `project-a:${d}`).length, 1, 'duplicate explicit Hook event must join');
33
- assert(maxActive >= 2, 'different projects may process in parallel');
34
- const repeated = await reconciler.processCommitEvent({ projectId: 'project-a', commitSha: d, branch: 'main' });
35
- assert.equal(repeated.status, 'already-completed');
36
- console.log('explicit-commit-processor-test PASS');
37
- })().catch(error => { console.error(error.stack || error.message); process.exit(1); });
1
+ const assert = require('assert');
2
+ const { CommitReconciler } = require('../lib/commit-reconciler');
3
+
4
+ const sha = suffix => `${'a'.repeat(39)}${suffix}`;
5
+ const calls = [];
6
+ let active = 0;
7
+ let maxActive = 0;
8
+ const completed = new Set();
9
+ const projectStore = { readConfig: id => ({ projectId: id, enabled: true, repoPath: 'C:/fixture', knowledgePath: 'C:/knowledge' }) };
10
+ const reconciler = new CommitReconciler({ projectStore, registryStore: {}, requireAiProfile: false });
11
+ reconciler.processingLedger = {
12
+ read: (projectId, commitSha) => completed.has(`${projectId}:${commitSha}`) ? { status: 'completed' } : null,
13
+ complete: (projectId, commitSha) => { completed.add(`${projectId}:${commitSha}`); return { status: 'completed' }; },
14
+ };
15
+ reconciler.processCommit = async (projectId, _trigger, _operationId, _config, _branch, commitSha) => {
16
+ active += 1; maxActive = Math.max(maxActive, active); calls.push(`${projectId}:${commitSha}`);
17
+ await new Promise(resolve => setTimeout(resolve, 20));
18
+ active -= 1;
19
+ return { ok: true, commitSha, runId: `run-${commitSha.slice(-1)}`, claimFingerprint: `fp-${commitSha.slice(-1)}` };
20
+ };
21
+
22
+ (async () => {
23
+ const d = sha('d'); const e = sha('e'); const f = sha('f');
24
+ const duplicateA = reconciler.processCommitEvent({ projectId: 'project-a', commitSha: d, branch: 'main' });
25
+ const duplicateB = reconciler.processCommitEvent({ projectId: 'project-a', commitSha: d, branch: 'main' });
26
+ const next = reconciler.processCommitEvent({ projectId: 'project-a', commitSha: e, branch: 'main' });
27
+ const other = reconciler.processCommitEvent({ projectId: 'project-b', commitSha: f, branch: 'main' });
28
+ const [first, second, third, fourth] = await Promise.all([duplicateA, duplicateB, next, other]);
29
+ assert.equal(first.status, 'completed'); assert.equal(second.status, 'completed');
30
+ assert.equal(third.status, 'completed'); assert.equal(fourth.status, 'completed');
31
+ assert.deepEqual(calls.filter(value => value.startsWith('project-a:')), [`project-a:${d}`, `project-a:${e}`]);
32
+ assert.equal(calls.filter(value => value === `project-a:${d}`).length, 1, 'duplicate explicit Hook event must join');
33
+ assert(maxActive >= 2, 'different projects may process in parallel');
34
+ const repeated = await reconciler.processCommitEvent({ projectId: 'project-a', commitSha: d, branch: 'main' });
35
+ assert.equal(repeated.status, 'already-completed');
36
+ console.log('explicit-commit-processor-test PASS');
37
+ })().catch(error => { console.error(error.stack || error.message); process.exit(1); });
@@ -47,7 +47,18 @@ function initRepo(repoPath) {
47
47
  function makeRepo({ kind = 'one-commit' } = {}) {
48
48
  const repoPath = fs.mkdtempSync(path.join(os.tmpdir(), `kb-fixture-${kind}-${process.pid}-`));
49
49
  const commits = [];
50
- const cleanup = () => fs.rmSync(repoPath, { recursive: true, force: true });
50
+ const cleanup = () => {
51
+ if (path.dirname(repoPath) !== path.resolve(os.tmpdir()) || !path.basename(repoPath).startsWith(`kb-fixture-${kind}-${process.pid}-`)) throw new Error('Unsafe fixture cleanup');
52
+ function remove(directory) {
53
+ for (const entry of fs.readdirSync(directory, { withFileTypes: true })) {
54
+ const file = path.join(directory, entry.name);
55
+ if (entry.isDirectory() && !entry.isSymbolicLink()) remove(file);
56
+ else { try { fs.unlinkSync(file); } catch (error) { if (error.code !== 'EPERM') throw error; fs.chmodSync(file, 0o600); fs.unlinkSync(file); } }
57
+ }
58
+ fs.rmdirSync(directory);
59
+ }
60
+ if (fs.existsSync(repoPath)) remove(repoPath);
61
+ };
51
62
 
52
63
  if (kind === 'not-git') {
53
64
  write(path.join(repoPath, 'README.md'), '# not git\n');
@@ -1,19 +1,19 @@
1
- const assert = require('assert');
2
- const { selectedDirectoryFromOutput } = require('../lib/folder-picker-output');
3
-
4
- const banner = '������µĿ�ƽ̨ PowerShell https://aka.ms/pscore6';
5
- assert.equal(selectedDirectoryFromOutput(banner, { exists: () => false }), '',
6
- 'PowerShell banner text must never be accepted as a selected folder');
7
-
8
- const folder = 'D:\\work\\project';
9
- assert.equal(selectedDirectoryFromOutput(`${banner}\r\n${folder}\r\n`, {
10
- exists: candidate => candidate === folder,
11
- stat: () => ({ isDirectory: () => true }),
12
- }), folder, 'the existing absolute directory should be selected from mixed output');
13
-
14
- assert.equal(selectedDirectoryFromOutput('relative-folder', {
15
- exists: () => true,
16
- stat: () => ({ isDirectory: () => true }),
17
- }), '', 'relative output must not be accepted');
18
-
19
- console.log('folder-picker-output-test PASS');
1
+ const assert = require('assert');
2
+ const { selectedDirectoryFromOutput } = require('../lib/folder-picker-output');
3
+
4
+ const banner = '������µĿ�ƽ̨ PowerShell https://aka.ms/pscore6';
5
+ assert.equal(selectedDirectoryFromOutput(banner, { exists: () => false }), '',
6
+ 'PowerShell banner text must never be accepted as a selected folder');
7
+
8
+ const folder = 'D:\\work\\project';
9
+ assert.equal(selectedDirectoryFromOutput(`${banner}\r\n${folder}\r\n`, {
10
+ exists: candidate => candidate === folder,
11
+ stat: () => ({ isDirectory: () => true }),
12
+ }), folder, 'the existing absolute directory should be selected from mixed output');
13
+
14
+ assert.equal(selectedDirectoryFromOutput('relative-folder', {
15
+ exists: () => true,
16
+ stat: () => ({ isDirectory: () => true }),
17
+ }), '', 'relative output must not be accepted');
18
+
19
+ console.log('folder-picker-output-test PASS');