@sanqianx/project-knowledge 4.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/plugins/marketplace.json +20 -0
- package/.claude-plugin/marketplace.json +17 -0
- package/CHANGELOG.md +780 -0
- package/LICENSE +201 -0
- package/NOTICE +5 -0
- package/README.md +266 -0
- package/_site/README.md +30 -0
- package/_site/_test/ai-profile-resolver-test.js +137 -0
- package/_site/_test/ai-profile-test.js +75 -0
- package/_site/_test/ai-vendor-presets-test.js +91 -0
- package/_site/_test/automation-queue-test.js +14 -0
- package/_site/_test/automation-ui-test.js +40 -0
- package/_site/_test/background-task-registry-test.js +43 -0
- package/_site/_test/baseline-schema-test.js +91 -0
- package/_site/_test/bin-cli-test.js +218 -0
- package/_site/_test/bridge-adapter-test.js +95 -0
- package/_site/_test/bridge-consumer-service-test.js +310 -0
- package/_site/_test/cdp-browser-failure-test.js +100 -0
- package/_site/_test/chat-claudecodeui-match-test.js +92 -0
- package/_site/_test/claude-executable-discovery-test.js +90 -0
- package/_site/_test/claude-session-lifecycle-sweep-test.js +252 -0
- package/_site/_test/claude-workbench-test.js +170 -0
- package/_site/_test/client-capture-restart-e2e-test.js +189 -0
- package/_site/_test/codex-conversation-projection-test.js +59 -0
- package/_site/_test/codex-notify-fanout-test.js +45 -0
- package/_site/_test/commit-boundary-freeze-test.js +147 -0
- package/_site/_test/commit-conversation-binding-test.js +99 -0
- package/_site/_test/commit-evidence-test.js +110 -0
- package/_site/_test/context-pack-test.js +198 -0
- package/_site/_test/conversation-api-test.js +119 -0
- package/_site/_test/conversation-store-test.js +136 -0
- package/_site/_test/cross-repo-isolation-e2e-test.js +187 -0
- package/_site/_test/data-dir-migration-test.js +77 -0
- package/_site/_test/desktop-browser-compat-test.js +28 -0
- package/_site/_test/desktop-hook-runtime-regression-test.js +204 -0
- package/_site/_test/embedding-config-test.js +32 -0
- package/_site/_test/explicit-commit-processor-test.js +37 -0
- package/_site/_test/fixtures/fake-browser-exit.js +10 -0
- package/_site/_test/fixtures/fake-browser-hang.js +10 -0
- package/_site/_test/fixtures/make-git-repos.js +89 -0
- package/_site/_test/folder-picker-output-test.js +19 -0
- package/_site/_test/full-integration-e2e-test.js +165 -0
- package/_site/_test/git-validation-test.js +81 -0
- package/_site/_test/hook-runtime-endpoint-test.js +88 -0
- package/_site/_test/hook-status-repair-api-test.js +152 -0
- package/_site/_test/hook-trigger-test.js +85 -0
- package/_site/_test/hook-worktree-test.js +42 -0
- package/_site/_test/import-preflight-api-test.js +233 -0
- package/_site/_test/import-ui-flow-test.js +171 -0
- package/_site/_test/index-builder-test.js +41 -0
- package/_site/_test/index-writer-concurrency-test.js +135 -0
- package/_site/_test/integration-adapters-test.js +243 -0
- package/_site/_test/integration-capture-setup-test.js +108 -0
- package/_site/_test/integration-surface-coverage-test.js +165 -0
- package/_site/_test/kb-framework-test.js +57 -0
- package/_site/_test/kbpath-follow-test.js +63 -0
- package/_site/_test/knowledge-db-test.js +144 -0
- package/_site/_test/knowledge-language-control-test.js +170 -0
- package/_site/_test/knowledge-maintenance-test.js +40 -0
- package/_site/_test/knowledge-migration-test.js +75 -0
- package/_site/_test/knowledge-promotion-recovery-test.js +260 -0
- package/_site/_test/knowledge-query-test.js +54 -0
- package/_site/_test/knowledge-retrieval-service-test.js +77 -0
- package/_site/_test/knowledge-scopes-test.js +37 -0
- package/_site/_test/knowledge-storage-location-test.js +28 -0
- package/_site/_test/knowledge-storage-startup-test.js +52 -0
- package/_site/_test/knowledge-store-logs-supervision-test.js +89 -0
- package/_site/_test/legacy-claude-session-alias-test.js +106 -0
- package/_site/_test/legacy-forward-compat-test.js +257 -0
- package/_site/_test/legacy-project-upgrade-e2e-test.js +363 -0
- package/_site/_test/legacy-routes-removed-test.js +47 -0
- package/_site/_test/legacy-workbench-exclusion-test.js +92 -0
- package/_site/_test/log-redaction-test.js +58 -0
- package/_site/_test/logging-api-test.js +89 -0
- package/_site/_test/logging-sse-no-gap-test.js +88 -0
- package/_site/_test/logging-ui-test.js +104 -0
- package/_site/_test/markdown-delta-overlay-test.js +85 -0
- package/_site/_test/markdown-maintenance-api-test.js +75 -0
- package/_site/_test/markdown-maintenance-test.js +11 -0
- package/_site/_test/mcp-server-test.js +149 -0
- package/_site/_test/model-context-windows-test.js +89 -0
- package/_site/_test/module-bridge-eventbridge-test.js +193 -0
- package/_site/_test/non-release-ci-test.js +34 -0
- package/_site/_test/offline-boundary-isolation-test.js +32 -0
- package/_site/_test/orphaned-claim-recovery-test.js +80 -0
- package/_site/_test/p0-data-migration-characterization-test.js +37 -0
- package/_site/_test/p0-e2e-gate-test.js +347 -0
- package/_site/_test/package-boundary-test.js +42 -0
- package/_site/_test/package-startup-test.js +56 -0
- package/_site/_test/packaged-ui-smoke-test.js +79 -0
- package/_site/_test/path-consistency-test.js +151 -0
- package/_site/_test/pending-sweep-test.js +9 -0
- package/_site/_test/post-commit-automation-test.js +87 -0
- package/_site/_test/pr-consumer-contract-test.js +55 -0
- package/_site/_test/project-control-panel-task14-test.js +63 -0
- package/_site/_test/project-delete-recovery-test.js +64 -0
- package/_site/_test/project-goal-editor-test.js +145 -0
- package/_site/_test/project-layout-v2-migration-test.js +127 -0
- package/_site/_test/project-lifecycle-transaction-test.js +106 -0
- package/_site/_test/project-remove-running-guard-test.js +79 -0
- package/_site/_test/project-store-test.js +90 -0
- package/_site/_test/prompt-settings-test.js +115 -0
- package/_site/_test/protected-architecture-gate-test.js +123 -0
- package/_site/_test/refactor-characterization-test.js +36 -0
- package/_site/_test/release-version-sync-test.js +98 -0
- package/_site/_test/requirement-binding-test.js +113 -0
- package/_site/_test/requirement-recorder-test.js +173 -0
- package/_site/_test/run-all-tests.js +156 -0
- package/_site/_test/runtime-endpoint-test.js +64 -0
- package/_site/_test/scanner-test.js +83 -0
- package/_site/_test/server-runtime-migration-safety-test.js +27 -0
- package/_site/_test/server-security-test.js +96 -0
- package/_site/_test/sessions-stream-test.js +92 -0
- package/_site/_test/shared-contracts-test.js +58 -0
- package/_site/_test/simple-import-test.js +97 -0
- package/_site/_test/startup-analysis-disabled-test.js +16 -0
- package/_site/_test/storage-foundation-test.js +78 -0
- package/_site/_test/structured-logger-test.js +101 -0
- package/_site/_test/task15-20-ui-flow-test.js +148 -0
- package/_site/_test/team-knowledge-store-sparse-checkout-test.js +196 -0
- package/_site/_test/team-knowledge-store-test.js +131 -0
- package/_site/_test/tracking-start-test.js +143 -0
- package/_site/_test/ui-i18n-toggle-test.js +114 -0
- package/_site/_test/ui-smoke-test.js +73 -0
- package/_site/_test/v4122-upgrade-data-contract-test.js +56 -0
- package/_site/_test/workbench-permission-test.js +118 -0
- package/_site/_test/workspace-ui-contract-test.js +43 -0
- package/_site/lib/ai-profile-resolver.js +78 -0
- package/_site/lib/ai-vendor-presets.js +83 -0
- package/_site/lib/ai-workspace.js +104 -0
- package/_site/lib/atomic-file.js +204 -0
- package/_site/lib/automation-config.js +140 -0
- package/_site/lib/bridge-adapter.js +256 -0
- package/_site/lib/bridge-consumer-service.js +402 -0
- package/_site/lib/claude-cli-runner.js +1599 -0
- package/_site/lib/commit-conversation-binder.js +246 -0
- package/_site/lib/commit-processing-ledger.js +27 -0
- package/_site/lib/commit-prompt.js +202 -0
- package/_site/lib/commit-reconciler.js +444 -0
- package/_site/lib/context-pack-builder.js +299 -0
- package/_site/lib/contracts.js +279 -0
- package/_site/lib/conversation-exclusions.js +204 -0
- package/_site/lib/conversation-query-service.js +161 -0
- package/_site/lib/conversation-store.js +385 -0
- package/_site/lib/data-dir.js +81 -0
- package/_site/lib/data-state-classifier.js +40 -0
- package/_site/lib/embedding-service.js +85 -0
- package/_site/lib/evidence-bundle.js +228 -0
- package/_site/lib/folder-picker-output.js +24 -0
- package/_site/lib/git-runner.js +62 -0
- package/_site/lib/github-team-store.js +1175 -0
- package/_site/lib/hook-manager.js +202 -0
- package/_site/lib/index-builder.js +157 -0
- package/_site/lib/index-service.js +173 -0
- package/_site/lib/integration-installer.js +907 -0
- package/_site/lib/kb-framework.js +191 -0
- package/_site/lib/kb-validator.js +124 -0
- package/_site/lib/knowledge-db.js +363 -0
- package/_site/lib/knowledge-promotion.js +435 -0
- package/_site/lib/knowledge-retrieval-service.js +401 -0
- package/_site/lib/knowledge-schema.js +121 -0
- package/_site/lib/knowledge-tool-runtime.js +359 -0
- package/_site/lib/legacy-data-manifest.js +26 -0
- package/_site/lib/llm-client.js +173 -0
- package/_site/lib/markdown-knowledge-indexer.js +230 -0
- package/_site/lib/migration-service.js +442 -0
- package/_site/lib/model-context-windows.js +82 -0
- package/_site/lib/module-bridge.js +496 -0
- package/_site/lib/post-commit-automation.js +141 -0
- package/_site/lib/project-lifecycle-service.js +511 -0
- package/_site/lib/project-registry-store.js +129 -0
- package/_site/lib/project-store.js +262 -0
- package/_site/lib/prompt-registry.js +148 -0
- package/_site/lib/requirement-adapters.js +10 -0
- package/_site/lib/requirement-binder.js +112 -0
- package/_site/lib/requirement-recorder.js +278 -0
- package/_site/lib/runtime-endpoint.js +160 -0
- package/_site/lib/scanner.js +298 -0
- package/_site/lib/server-app.js +1520 -0
- package/_site/lib/settings-store.js +113 -0
- package/_site/lib/storage-layout.js +162 -0
- package/_site/lib/structured-logger.js +574 -0
- package/_site/scripts/codex-notify-fanout.cjs +51 -0
- package/_site/scripts/folder-picker.ps1 +156 -0
- package/_site/scripts/hook-trigger.js +156 -0
- package/_site/scripts/sync-release-version.js +158 -0
- package/_site/server.js +12 -0
- package/_site/start.bat +26 -0
- package/_site/stop.bat +11 -0
- package/bin/project-knowledge-integrations.js +241 -0
- package/bin/project-knowledge-kb.js +65 -0
- package/bin/project-knowledge-mcp.js +195 -0
- package/bin/project-knowledge.js +439 -0
- package/claude-prompts.json +21 -0
- package/docs/README.zh-CN.md +175 -0
- package/docs/assets/architecture.svg +182 -0
- package/docs/assets/dashboard.png +0 -0
- package/docs/assets/draft-review.png +0 -0
- package/docs/assets/logo.svg +50 -0
- package/docs/assets/runs-drafts.png +0 -0
- package/docs/assets/settings.png +0 -0
- package/docs/project-registry-schema.md +33 -0
- package/docs/team-knowledge-mode-a-plan.md +73 -0
- package/docs/testing-strategy.md +33 -0
- package/package.json +100 -0
- package/plugins/project-knowledge/.claude-plugin/plugin.json +19 -0
- package/plugins/project-knowledge/.codex-plugin/plugin.json +38 -0
- package/plugins/project-knowledge/.mcp.json +14 -0
- package/plugins/project-knowledge/opencode/project-knowledge.md +3 -0
- package/plugins/project-knowledge/skills/project-knowledge/SKILL.md +28 -0
- package/plugins/project-knowledge/skills/project-knowledge/agents/openai.yaml +11 -0
- package/templates/change.md +30 -0
- package/templates/project-readme.md +52 -0
- package/ui/app.css +58 -0
- package/ui/app.js +607 -0
- package/ui/favicon.svg +38 -0
- package/ui/i18n.js +146 -0
- package/ui/index.html +162 -0
|
@@ -0,0 +1,385 @@
|
|
|
1
|
+
const fs = require('fs');
|
|
2
|
+
const crypto = require('crypto');
|
|
3
|
+
const { SCHEMAS, DomainError, validateProjectId } = require('./contracts');
|
|
4
|
+
const AtomicFile = require('./atomic-file');
|
|
5
|
+
const { StorageLayout } = require('./storage-layout');
|
|
6
|
+
|
|
7
|
+
const SOURCES = new Set(['claude-code', 'codex', 'opencode']);
|
|
8
|
+
const ROLES = new Set(['user', 'assistant', null]);
|
|
9
|
+
const SNAPSHOT_STATUSES = new Set(['available', 'no-new-user-prompt', 'unavailable', 'ambiguous']);
|
|
10
|
+
const BINDING_KINDS = new Set(['direct', 'shared-spanning', 'explicit']);
|
|
11
|
+
|
|
12
|
+
function sha256(value) {
|
|
13
|
+
return `sha256:${crypto.createHash('sha256').update(String(value == null ? '' : value), 'utf8').digest('hex')}`;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
function optionalString(value) {
|
|
17
|
+
if (value == null || value === '') return null;
|
|
18
|
+
return String(value);
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
function validateConversationEvent(event, expectedProjectId = '') {
|
|
22
|
+
if (!event || typeof event !== 'object' || Array.isArray(event)) throw new DomainError('INVALID_ARGUMENT', 'Conversation event is invalid.');
|
|
23
|
+
if (event.schema !== SCHEMAS.aiCodingEvent) throw new DomainError('SCHEMA_UNSUPPORTED', 'Conversation event must use ai-coding-event/v1.', { status: 409 });
|
|
24
|
+
const projectId = validateProjectId(event.projectId);
|
|
25
|
+
if (expectedProjectId && projectId !== expectedProjectId) throw new DomainError('INVALID_ARGUMENT', 'Conversation event projectId does not match the store.');
|
|
26
|
+
if (!event.eventId || typeof event.eventId !== 'string') throw new DomainError('INVALID_ARGUMENT', 'Conversation eventId is required.');
|
|
27
|
+
if (event.sequence != null && (!Number.isInteger(event.sequence) || event.sequence < 0)) throw new DomainError('INVALID_ARGUMENT', 'Conversation sequence must be a non-negative integer or null.');
|
|
28
|
+
if (!SOURCES.has(event.source)) throw new DomainError('INVALID_ARGUMENT', 'Conversation source is invalid.');
|
|
29
|
+
if (!event.eventType || typeof event.eventType !== 'string') throw new DomainError('INVALID_ARGUMENT', 'Conversation eventType is required.');
|
|
30
|
+
if (!ROLES.has(event.role)) throw new DomainError('INVALID_ARGUMENT', 'Conversation role is invalid.');
|
|
31
|
+
if (event.role && typeof event.content !== 'string') throw new DomainError('INVALID_ARGUMENT', 'User and assistant events require text content.');
|
|
32
|
+
if (!event.capturedAt || Number.isNaN(Date.parse(event.capturedAt))) throw new DomainError('INVALID_ARGUMENT', 'Conversation capturedAt must be an ISO timestamp.');
|
|
33
|
+
if (event.contentHash !== sha256(event.content || '')) throw new DomainError('DATA_CORRUPT', 'Conversation content hash does not match.', { status: 409 });
|
|
34
|
+
return event;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
function normalizeConversationEvent(projectId, input = {}) {
|
|
38
|
+
validateProjectId(projectId);
|
|
39
|
+
const role = input.role == null ? null : String(input.role);
|
|
40
|
+
const content = role ? String(input.content == null ? '' : input.content) : '';
|
|
41
|
+
const normalized = {
|
|
42
|
+
schema: SCHEMAS.aiCodingEvent,
|
|
43
|
+
projectId,
|
|
44
|
+
eventId: String(input.eventId || '').trim(),
|
|
45
|
+
sequence: input.sequence == null ? null : Number(input.sequence),
|
|
46
|
+
source: String(input.source || ''),
|
|
47
|
+
eventType: String(input.eventType || ''),
|
|
48
|
+
role,
|
|
49
|
+
content,
|
|
50
|
+
contentHash: sha256(content),
|
|
51
|
+
sessionId: optionalString(input.sessionId),
|
|
52
|
+
turnId: optionalString(input.turnId),
|
|
53
|
+
projectPath: optionalString(input.projectPath),
|
|
54
|
+
repoIdentity: input.repoIdentity && typeof input.repoIdentity === 'object' ? { ...input.repoIdentity } : null,
|
|
55
|
+
branch: optionalString(input.branch),
|
|
56
|
+
headAtCapture: optionalString(input.headAtCapture),
|
|
57
|
+
capturedAt: input.capturedAt || new Date().toISOString(),
|
|
58
|
+
rawEventType: optionalString(input.rawEventType),
|
|
59
|
+
identityConfidence: optionalString(input.identityConfidence) || 'unknown',
|
|
60
|
+
captureStatus: optionalString(input.captureStatus) || 'captured',
|
|
61
|
+
explicitCommitSha: optionalString(input.explicitCommitSha),
|
|
62
|
+
legacyRequirementId: optionalString(input.legacyRequirementId),
|
|
63
|
+
};
|
|
64
|
+
return validateConversationEvent(normalized, projectId);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
function readJsonlStrict(filePath, validator, category) {
|
|
68
|
+
if (!fs.existsSync(filePath)) return [];
|
|
69
|
+
const records = [];
|
|
70
|
+
const lines = fs.readFileSync(filePath, 'utf8').split(/\r?\n/);
|
|
71
|
+
for (let index = 0; index < lines.length; index += 1) {
|
|
72
|
+
if (!lines[index].trim()) continue;
|
|
73
|
+
try {
|
|
74
|
+
records.push(validator(JSON.parse(lines[index])));
|
|
75
|
+
} catch (error) {
|
|
76
|
+
if (error instanceof DomainError) throw error;
|
|
77
|
+
throw new DomainError('DATA_CORRUPT', `${category} JSONL is corrupt.`, { status: 500, cause: error, details: { line: index + 1 } });
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
return records;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
function appendJsonlDurable(filePath, value) {
|
|
84
|
+
fs.mkdirSync(require('path').dirname(filePath), { recursive: true });
|
|
85
|
+
const line = Buffer.from(`${JSON.stringify(value)}\n`, 'utf8');
|
|
86
|
+
const fd = fs.openSync(filePath, 'a', 0o600);
|
|
87
|
+
try {
|
|
88
|
+
fs.writeSync(fd, line, 0, line.length, null);
|
|
89
|
+
fs.fsyncSync(fd);
|
|
90
|
+
} finally {
|
|
91
|
+
fs.closeSync(fd);
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
function validateBoundary(boundary, expectedProjectId = '', expectedCommitSha = '') {
|
|
96
|
+
if (!boundary || typeof boundary !== 'object' || boundary.schema !== SCHEMAS.gitCommitBoundary) {
|
|
97
|
+
throw new DomainError('SCHEMA_UNSUPPORTED', 'Commit boundary must use git-commit-boundary/v1.', { status: 409 });
|
|
98
|
+
}
|
|
99
|
+
validateProjectId(boundary.projectId);
|
|
100
|
+
if (expectedProjectId && boundary.projectId !== expectedProjectId) throw new DomainError('DATA_CORRUPT', 'Commit boundary projectId mismatch.', { status: 500 });
|
|
101
|
+
if (!boundary.commitSha || (expectedCommitSha && boundary.commitSha !== expectedCommitSha)) throw new DomainError('DATA_CORRUPT', 'Commit boundary SHA mismatch.', { status: 500 });
|
|
102
|
+
if (!Number.isInteger(boundary.bridgeCursorAtCommit) || boundary.bridgeCursorAtCommit < 0) throw new DomainError('INVALID_ARGUMENT', 'Commit boundary cursor is invalid.');
|
|
103
|
+
if (boundary.journalSequence != null && (!Number.isInteger(boundary.journalSequence) || boundary.journalSequence < 0)) throw new DomainError('INVALID_ARGUMENT', 'Commit boundary journal sequence is invalid.');
|
|
104
|
+
if (!Array.isArray(boundary.parentShas) || !Array.isArray(boundary.openTurnIdsAtCommit)) throw new DomainError('INVALID_ARGUMENT', 'Commit boundary collections are invalid.');
|
|
105
|
+
if (!boundary.operationId || !boundary.committedAt) throw new DomainError('INVALID_ARGUMENT', 'Commit boundary operation metadata is required.');
|
|
106
|
+
return boundary;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
function snapshotPayload(snapshot) {
|
|
110
|
+
const { snapshotHash, ...payload } = snapshot;
|
|
111
|
+
return payload;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
function validateSnapshot(snapshot, expectedProjectId = '', expectedCommitSha = '') {
|
|
115
|
+
if (!snapshot || typeof snapshot !== 'object' || snapshot.schema !== SCHEMAS.commitConversationSnapshot) {
|
|
116
|
+
throw new DomainError('SCHEMA_UNSUPPORTED', 'Commit conversation snapshot must use commit-conversation-snapshot/v1.', { status: 409 });
|
|
117
|
+
}
|
|
118
|
+
validateProjectId(snapshot.projectId);
|
|
119
|
+
if (expectedProjectId && snapshot.projectId !== expectedProjectId) throw new DomainError('DATA_CORRUPT', 'Conversation snapshot projectId mismatch.', { status: 500 });
|
|
120
|
+
if (!snapshot.commitSha || (expectedCommitSha && snapshot.commitSha !== expectedCommitSha)) throw new DomainError('DATA_CORRUPT', 'Conversation snapshot SHA mismatch.', { status: 500 });
|
|
121
|
+
if (!SNAPSHOT_STATUSES.has(snapshot.status) || !Array.isArray(snapshot.turns)) throw new DomainError('INVALID_ARGUMENT', 'Conversation snapshot status or turns are invalid.');
|
|
122
|
+
for (const turn of snapshot.turns) {
|
|
123
|
+
if (!turn.turnId || !BINDING_KINDS.has(turn.bindingKind) || !Array.isArray(turn.userEvents) || !Array.isArray(turn.assistantEvents)) {
|
|
124
|
+
throw new DomainError('INVALID_ARGUMENT', 'Conversation snapshot turn is invalid.');
|
|
125
|
+
}
|
|
126
|
+
for (const event of [...turn.userEvents, ...turn.assistantEvents]) {
|
|
127
|
+
if (!event.eventId || event.contentHash !== sha256(event.content || '')) throw new DomainError('DATA_CORRUPT', 'Snapshot event hash does not match.', { status: 409 });
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
if (snapshot.snapshotHash !== sha256(JSON.stringify(snapshotPayload(snapshot)))) throw new DomainError('DATA_CORRUPT', 'Conversation snapshot hash does not match.', { status: 409 });
|
|
131
|
+
return snapshot;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
class ConversationStore {
|
|
135
|
+
constructor(options = {}) {
|
|
136
|
+
this.layout = options.layout || new StorageLayout(options);
|
|
137
|
+
this.atomic = options.atomic || AtomicFile;
|
|
138
|
+
this.projectStore = options.projectStore || null;
|
|
139
|
+
this.logger = options.logger || null;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
async log(level, event, message, context) {
|
|
143
|
+
try {
|
|
144
|
+
if (this.logger && typeof this.logger[level] === 'function') await this.logger[level](event, message, context);
|
|
145
|
+
} catch {
|
|
146
|
+
// Conversation durability is independent from observer failures.
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
readEvents(projectId) {
|
|
151
|
+
validateProjectId(projectId);
|
|
152
|
+
return readJsonlStrict(
|
|
153
|
+
this.layout.getProjectConversationEventsPath(projectId),
|
|
154
|
+
event => validateConversationEvent(event, projectId),
|
|
155
|
+
'Conversation events',
|
|
156
|
+
);
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
async appendEvent(projectId, input) {
|
|
160
|
+
const event = normalizeConversationEvent(projectId, input);
|
|
161
|
+
const filePath = this.layout.getProjectConversationEventsPath(projectId);
|
|
162
|
+
const result = await this.atomic.withFileLock(`${filePath}.append.lock`, async () => {
|
|
163
|
+
const existing = this.readEvents(projectId).find(candidate => candidate.eventId === event.eventId);
|
|
164
|
+
if (existing) {
|
|
165
|
+
if (sha256(JSON.stringify(existing)) !== sha256(JSON.stringify(event))) {
|
|
166
|
+
throw new DomainError('DATA_CORRUPT', 'Duplicate conversation eventId has different content.', { status: 409 });
|
|
167
|
+
}
|
|
168
|
+
return { event: existing, appended: false };
|
|
169
|
+
}
|
|
170
|
+
appendJsonlDurable(filePath, event);
|
|
171
|
+
return { event, appended: true };
|
|
172
|
+
});
|
|
173
|
+
await this.log('info', result.appended ? 'conversation.event_appended' : 'conversation.event_deduplicated', 'Conversation event persisted.', {
|
|
174
|
+
projectId,
|
|
175
|
+
component: 'conversation-store',
|
|
176
|
+
context: {
|
|
177
|
+
eventId: event.eventId,
|
|
178
|
+
sequence: event.sequence,
|
|
179
|
+
source: event.source,
|
|
180
|
+
eventType: event.eventType,
|
|
181
|
+
role: event.role,
|
|
182
|
+
contentHash: event.contentHash,
|
|
183
|
+
contentLength: event.content.length,
|
|
184
|
+
},
|
|
185
|
+
});
|
|
186
|
+
return result;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
_projectWorkspaceId(projectId) {
|
|
190
|
+
try {
|
|
191
|
+
const config = this.projectStore && typeof this.projectStore.readConfig === 'function'
|
|
192
|
+
? this.projectStore.readConfig(projectId)
|
|
193
|
+
: null;
|
|
194
|
+
const identity = config && config.repoIdentity;
|
|
195
|
+
return identity && typeof identity === 'object' && typeof identity.workspaceId === 'string'
|
|
196
|
+
? identity.workspaceId
|
|
197
|
+
: null;
|
|
198
|
+
} catch (_) {
|
|
199
|
+
return null;
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* Project-scoped projection of a canonical Bridge journal event. The global
|
|
205
|
+
* eventId / sequence / turnId / repoIdentity are preserved verbatim; a new
|
|
206
|
+
* local sequence is never assigned; dedup is by eventId with DATA_CORRUPT on
|
|
207
|
+
* content drift; an exact event whose workspaceId differs from the project's
|
|
208
|
+
* canonical workspace is rejected instead of contaminating the store.
|
|
209
|
+
*/
|
|
210
|
+
async appendBridgeEvent(projectId, bridgeEvent) {
|
|
211
|
+
if (!bridgeEvent || typeof bridgeEvent !== 'object' || bridgeEvent.schema !== SCHEMAS.aiCodingEvent) {
|
|
212
|
+
throw new DomainError('SCHEMA_UNSUPPORTED', 'Bridge conversation event must use ai-coding-event/v1.', { status: 409 });
|
|
213
|
+
}
|
|
214
|
+
if (bridgeEvent.eventType !== 'user_prompt' && bridgeEvent.eventType !== 'assistant_response') {
|
|
215
|
+
throw new DomainError('INVALID_ARGUMENT', 'Bridge conversation event must be a user_prompt or assistant_response.');
|
|
216
|
+
}
|
|
217
|
+
if (!bridgeEvent.eventId || typeof bridgeEvent.eventId !== 'string') {
|
|
218
|
+
throw new DomainError('INVALID_ARGUMENT', 'Bridge eventId is required.');
|
|
219
|
+
}
|
|
220
|
+
if (!Number.isInteger(bridgeEvent.sequence) || bridgeEvent.sequence < 0) {
|
|
221
|
+
throw new DomainError('INVALID_ARGUMENT', 'Bridge sequence is required for projected events.');
|
|
222
|
+
}
|
|
223
|
+
const configWorkspaceId = this._projectWorkspaceId(projectId);
|
|
224
|
+
const eventIdentity = bridgeEvent.repoIdentity;
|
|
225
|
+
const eventWorkspaceId = eventIdentity && typeof eventIdentity === 'object' && typeof eventIdentity.workspaceId === 'string'
|
|
226
|
+
? eventIdentity.workspaceId
|
|
227
|
+
: null;
|
|
228
|
+
if (configWorkspaceId && eventWorkspaceId && configWorkspaceId !== eventWorkspaceId) {
|
|
229
|
+
throw new DomainError('DATA_CORRUPT', 'Bridge event workspaceId does not match the project workspace.', { status: 409 });
|
|
230
|
+
}
|
|
231
|
+
return this.appendEvent(projectId, {
|
|
232
|
+
eventId: bridgeEvent.eventId,
|
|
233
|
+
sequence: bridgeEvent.sequence,
|
|
234
|
+
source: bridgeEvent.source,
|
|
235
|
+
eventType: bridgeEvent.eventType,
|
|
236
|
+
role: bridgeEvent.role,
|
|
237
|
+
content: bridgeEvent.content == null ? '' : bridgeEvent.content,
|
|
238
|
+
sessionId: bridgeEvent.sessionId,
|
|
239
|
+
turnId: bridgeEvent.turnId,
|
|
240
|
+
projectPath: bridgeEvent.projectPath,
|
|
241
|
+
repoIdentity: eventIdentity,
|
|
242
|
+
branch: bridgeEvent.branch,
|
|
243
|
+
headAtCapture: bridgeEvent.headAtCapture,
|
|
244
|
+
capturedAt: bridgeEvent.capturedAt,
|
|
245
|
+
rawEventType: bridgeEvent.rawEventType,
|
|
246
|
+
identityConfidence: bridgeEvent.identityConfidence,
|
|
247
|
+
captureStatus: bridgeEvent.captureStatus,
|
|
248
|
+
});
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
legacyRequirementToEvent(projectId, requirement) {
|
|
252
|
+
if (!requirement || requirement.schema !== SCHEMAS.requirement || requirement.projectId !== projectId || !requirement.id) {
|
|
253
|
+
throw new DomainError('INVALID_ARGUMENT', 'Legacy requirement record is invalid.');
|
|
254
|
+
}
|
|
255
|
+
const source = requirement.client === 'claude' ? 'claude-code' : requirement.client;
|
|
256
|
+
return normalizeConversationEvent(projectId, {
|
|
257
|
+
eventId: `legacy-${requirement.id}`,
|
|
258
|
+
sequence: null,
|
|
259
|
+
source: SOURCES.has(source) ? source : 'codex',
|
|
260
|
+
eventType: 'user_prompt',
|
|
261
|
+
role: 'user',
|
|
262
|
+
content: requirement.requirement,
|
|
263
|
+
sessionId: requirement.sessionId,
|
|
264
|
+
turnId: `legacy-${requirement.id}`,
|
|
265
|
+
projectPath: requirement.repoPath,
|
|
266
|
+
repoIdentity: requirement.repoIdentity || null,
|
|
267
|
+
branch: requirement.branch,
|
|
268
|
+
headAtCapture: requirement.headAtRecord,
|
|
269
|
+
capturedAt: requirement.ts,
|
|
270
|
+
rawEventType: 'legacy-requirement',
|
|
271
|
+
identityConfidence: requirement.explicitCommit ? 'explicit' : 'legacy',
|
|
272
|
+
captureStatus: 'legacy-explicit-adapter',
|
|
273
|
+
explicitCommitSha: requirement.explicitCommit,
|
|
274
|
+
legacyRequirementId: requirement.id,
|
|
275
|
+
});
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
async importLegacyRequirements(projectId, records = null) {
|
|
279
|
+
const requirements = records || (this.projectStore ? this.projectStore.readRequirements(projectId) : []);
|
|
280
|
+
const results = [];
|
|
281
|
+
for (const requirement of requirements) results.push(await this.appendEvent(projectId, this.legacyRequirementToEvent(projectId, requirement)));
|
|
282
|
+
return results;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
writeBoundary(projectId, boundaryInput) {
|
|
286
|
+
const commitSha = this.layout.validateCommitSha(boundaryInput.commitSha);
|
|
287
|
+
const boundary = validateBoundary({
|
|
288
|
+
schema: SCHEMAS.gitCommitBoundary,
|
|
289
|
+
projectId,
|
|
290
|
+
repoIdentity: boundaryInput.repoIdentity || null,
|
|
291
|
+
commitSha,
|
|
292
|
+
parentShas: Array.isArray(boundaryInput.parentShas) ? boundaryInput.parentShas.map(value => String(value).toLowerCase()) : [],
|
|
293
|
+
branch: optionalString(boundaryInput.branch),
|
|
294
|
+
committedAt: boundaryInput.committedAt || new Date().toISOString(),
|
|
295
|
+
bridgeCursorAtCommit: Number(boundaryInput.bridgeCursorAtCommit),
|
|
296
|
+
openTurnIdsAtCommit: Array.isArray(boundaryInput.openTurnIdsAtCommit) ? [...new Set(boundaryInput.openTurnIdsAtCommit.map(String))] : [],
|
|
297
|
+
operationId: String(boundaryInput.operationId || ''),
|
|
298
|
+
journalSequence: Number.isInteger(boundaryInput.journalSequence) ? boundaryInput.journalSequence : Number(boundaryInput.bridgeCursorAtCommit),
|
|
299
|
+
boundaryHash: '',
|
|
300
|
+
}, projectId, commitSha);
|
|
301
|
+
boundary.boundaryHash = sha256(JSON.stringify({ ...boundary, boundaryHash: undefined }));
|
|
302
|
+
const filePath = this.layout.getProjectCommitBoundaryPath(projectId, commitSha);
|
|
303
|
+
if (fs.existsSync(filePath)) {
|
|
304
|
+
const existing = this.readBoundary(projectId, commitSha);
|
|
305
|
+
if (existing.boundaryHash !== boundary.boundaryHash) throw new DomainError('DATA_CORRUPT', 'Conflicting evidence was supplied for an existing commit boundary.', { status: 409 });
|
|
306
|
+
return existing;
|
|
307
|
+
}
|
|
308
|
+
this.atomic.writeJsonAtomic(filePath, boundary);
|
|
309
|
+
return boundary;
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
readBoundary(projectId, commitSha) {
|
|
313
|
+
const normalizedSha = this.layout.validateCommitSha(commitSha);
|
|
314
|
+
return this.atomic.readJsonStrict(this.layout.getProjectCommitBoundaryPath(projectId, normalizedSha), {
|
|
315
|
+
category: 'git-commit-boundary',
|
|
316
|
+
validate: value => validateBoundary(value, projectId, normalizedSha),
|
|
317
|
+
});
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
listBoundaries(projectId) {
|
|
321
|
+
validateProjectId(projectId);
|
|
322
|
+
const directory = this.layout.getProjectCommitBoundariesDir(projectId);
|
|
323
|
+
if (!fs.existsSync(directory)) return [];
|
|
324
|
+
return fs.readdirSync(directory, { withFileTypes: true })
|
|
325
|
+
.filter(entry => entry.isFile() && /^[a-f0-9]{7,64}\.json$/i.test(entry.name))
|
|
326
|
+
.map(entry => this.readBoundary(projectId, entry.name.slice(0, -5)));
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
writeSnapshot(projectId, input) {
|
|
330
|
+
const commitSha = this.layout.validateCommitSha(input.commitSha);
|
|
331
|
+
const snapshot = {
|
|
332
|
+
schema: SCHEMAS.commitConversationSnapshot,
|
|
333
|
+
projectId,
|
|
334
|
+
repoIdentity: input.repoIdentity || null,
|
|
335
|
+
commitSha,
|
|
336
|
+
parentSha: input.parentSha || null,
|
|
337
|
+
boundaryStartCursor: input.boundaryStartCursor == null ? null : Number(input.boundaryStartCursor),
|
|
338
|
+
boundaryEndCursor: input.boundaryEndCursor == null ? null : Number(input.boundaryEndCursor),
|
|
339
|
+
status: input.status,
|
|
340
|
+
turns: input.turns || [],
|
|
341
|
+
excludedFuturePromptCount: Number(input.excludedFuturePromptCount || 0),
|
|
342
|
+
finalizedAt: input.finalizedAt || new Date().toISOString(),
|
|
343
|
+
snapshotHash: '',
|
|
344
|
+
};
|
|
345
|
+
snapshot.snapshotHash = sha256(JSON.stringify(snapshotPayload(snapshot)));
|
|
346
|
+
validateSnapshot(snapshot, projectId, commitSha);
|
|
347
|
+
const filePath = this.layout.getProjectCommitConversationPath(projectId, commitSha);
|
|
348
|
+
if (fs.existsSync(filePath)) {
|
|
349
|
+
const existing = this.readSnapshot(projectId, commitSha);
|
|
350
|
+
if (existing.snapshotHash !== snapshot.snapshotHash) throw new DomainError('IMMUTABLE_FIELD', 'Commit conversation snapshot is already frozen.', { status: 409 });
|
|
351
|
+
return existing;
|
|
352
|
+
}
|
|
353
|
+
this.atomic.writeJsonAtomic(filePath, snapshot);
|
|
354
|
+
return snapshot;
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
readSnapshot(projectId, commitSha) {
|
|
358
|
+
const normalizedSha = this.layout.validateCommitSha(commitSha);
|
|
359
|
+
return this.atomic.readJsonStrict(this.layout.getProjectCommitConversationPath(projectId, normalizedSha), {
|
|
360
|
+
category: 'commit-conversation-snapshot',
|
|
361
|
+
validate: value => validateSnapshot(value, projectId, normalizedSha),
|
|
362
|
+
});
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
listSnapshots(projectId) {
|
|
366
|
+
validateProjectId(projectId);
|
|
367
|
+
const directory = this.layout.getProjectCommitConversationsDir(projectId);
|
|
368
|
+
if (!fs.existsSync(directory)) return [];
|
|
369
|
+
return fs.readdirSync(directory, { withFileTypes: true })
|
|
370
|
+
.filter(entry => entry.isFile() && /^[a-f0-9]{7,64}\.json$/i.test(entry.name))
|
|
371
|
+
.map(entry => this.readSnapshot(projectId, entry.name.slice(0, -5)));
|
|
372
|
+
}
|
|
373
|
+
}
|
|
374
|
+
|
|
375
|
+
module.exports = {
|
|
376
|
+
ConversationStore,
|
|
377
|
+
SOURCES,
|
|
378
|
+
SNAPSHOT_STATUSES,
|
|
379
|
+
BINDING_KINDS,
|
|
380
|
+
sha256,
|
|
381
|
+
normalizeConversationEvent,
|
|
382
|
+
validateConversationEvent,
|
|
383
|
+
validateBoundary,
|
|
384
|
+
validateSnapshot,
|
|
385
|
+
};
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
const fs = require('fs');
|
|
2
|
+
const path = require('path');
|
|
3
|
+
const os = require('os');
|
|
4
|
+
const crypto = require('crypto');
|
|
5
|
+
const { LEGACY_ASSETS, assetPath } = require('./legacy-data-manifest');
|
|
6
|
+
const { isEmptyJson } = require('./data-state-classifier');
|
|
7
|
+
|
|
8
|
+
let _resolved = null;
|
|
9
|
+
|
|
10
|
+
function resolveDataDirPath(options = {}) {
|
|
11
|
+
const fromEnv = options.dataDir === undefined ? process.env.KB_DATA_DIR : options.dataDir;
|
|
12
|
+
const homeDir = options.homeDir || os.homedir();
|
|
13
|
+
return path.resolve(fromEnv || path.join(homeDir, '.project-knowledge'));
|
|
14
|
+
}
|
|
15
|
+
function ensureDataDir(dataDir = resolveDataDirPath()) { fs.mkdirSync(dataDir, { recursive: true }); return path.resolve(dataDir); }
|
|
16
|
+
function getDataDir() { if (!_resolved) _resolved = resolveDataDirPath(); return _resolved; }
|
|
17
|
+
function _resetCache() { _resolved = null; }
|
|
18
|
+
function fileDigest(filePath) { return crypto.createHash('sha256').update(fs.readFileSync(filePath)).digest('hex'); }
|
|
19
|
+
function directoryDigest(root) {
|
|
20
|
+
const hash = crypto.createHash('sha256');
|
|
21
|
+
const walk = current => {
|
|
22
|
+
for (const entry of fs.readdirSync(current, { withFileTypes: true }).sort((a, b) => a.name.localeCompare(b.name))) {
|
|
23
|
+
const filePath = path.join(current, entry.name);
|
|
24
|
+
const relative = path.relative(root, filePath).replace(/\\/g, '/');
|
|
25
|
+
hash.update(`${entry.isDirectory() ? 'd' : 'f'}:${relative}\0`);
|
|
26
|
+
if (entry.isDirectory()) walk(filePath); else if (entry.isFile()) hash.update(fs.readFileSync(filePath));
|
|
27
|
+
}
|
|
28
|
+
};
|
|
29
|
+
walk(root); return hash.digest('hex');
|
|
30
|
+
}
|
|
31
|
+
function isEmptyAsset(filePath, asset) {
|
|
32
|
+
if (!fs.existsSync(filePath)) return true;
|
|
33
|
+
if (asset.kind === 'dir') return fs.readdirSync(filePath).length === 0;
|
|
34
|
+
if (fs.statSync(filePath).size === 0) return true;
|
|
35
|
+
if (!filePath.endsWith('.json')) return false;
|
|
36
|
+
try { const raw = fs.readFileSync(filePath, 'utf8'); return isEmptyJson(JSON.parse(raw.charCodeAt(0) === 0xfeff ? raw.slice(1) : raw)); } catch { return false; }
|
|
37
|
+
}
|
|
38
|
+
function assetsEqual(source, target, asset) { return asset.kind === 'dir' ? directoryDigest(source) === directoryDigest(target) : fileDigest(source) === fileDigest(target); }
|
|
39
|
+
function copyDir(source, target) {
|
|
40
|
+
fs.mkdirSync(target, { recursive: true });
|
|
41
|
+
for (const entry of fs.readdirSync(source, { withFileTypes: true })) {
|
|
42
|
+
const from = path.join(source, entry.name); const to = path.join(target, entry.name);
|
|
43
|
+
if (entry.isDirectory()) copyDir(from, to); else if (entry.isFile()) fs.copyFileSync(from, to);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
function migrateFromLegacy({ legacyRoot, logger } = {}) {
|
|
48
|
+
if (process.env.KB_SKIP_MIGRATION === '1') return { ok: true, migrated: false, reason: 'skipped via KB_SKIP_MIGRATION=1' };
|
|
49
|
+
if (!legacyRoot || !fs.existsSync(legacyRoot)) return { ok: true, migrated: false, reason: legacyRoot ? 'legacy root does not exist' : 'no legacy root provided' };
|
|
50
|
+
const dataDir = getDataDir();
|
|
51
|
+
if (path.resolve(legacyRoot) === dataDir) return { ok: true, migrated: false, reason: 'legacy root equals data dir' };
|
|
52
|
+
// Packaged application roots may include empty scaffolding such as
|
|
53
|
+
// `projects/`. It is not user data and must never conflict with populated
|
|
54
|
+
// runtime data during startup relocation.
|
|
55
|
+
const sources = LEGACY_ASSETS.filter(asset => {
|
|
56
|
+
const source = assetPath(legacyRoot, asset);
|
|
57
|
+
return fs.existsSync(source) && !isEmptyAsset(source, asset);
|
|
58
|
+
});
|
|
59
|
+
if (!sources.length) return { ok: true, migrated: false, reason: 'no legacy assets found' };
|
|
60
|
+
const conflicts = [];
|
|
61
|
+
for (const asset of sources) {
|
|
62
|
+
const source = assetPath(legacyRoot, asset); const target = assetPath(dataDir, asset, 'target');
|
|
63
|
+
if (fs.existsSync(target) && !isEmptyAsset(target, asset) && !assetsEqual(source, target, asset)) conflicts.push(asset.target);
|
|
64
|
+
}
|
|
65
|
+
if (conflicts.length) return { ok: false, migrated: false, requiresManualRecovery: true, reason: 'legacy-data-conflict', conflicts, source: legacyRoot, target: dataDir };
|
|
66
|
+
ensureDataDir(dataDir);
|
|
67
|
+
const result = { ok: true, migrated: false, files: 0, dirs: 0, source: legacyRoot, target: dataDir };
|
|
68
|
+
try {
|
|
69
|
+
for (const asset of sources) {
|
|
70
|
+
const source = assetPath(legacyRoot, asset); const target = assetPath(dataDir, asset, 'target');
|
|
71
|
+
if (fs.existsSync(target) && assetsEqual(source, target, asset)) continue;
|
|
72
|
+
if (asset.kind === 'dir') { if (fs.existsSync(target)) fs.rmSync(target, { recursive: true, force: true }); copyDir(source, target); result.dirs++; }
|
|
73
|
+
else { fs.mkdirSync(path.dirname(target), { recursive: true }); fs.copyFileSync(source, target); result.files++; }
|
|
74
|
+
}
|
|
75
|
+
result.migrated = result.files > 0 || result.dirs > 0;
|
|
76
|
+
if (result.migrated && logger) logger(`migrated runtime data to ${dataDir} (${result.files} files, ${result.dirs} dirs from ${legacyRoot})`);
|
|
77
|
+
return result;
|
|
78
|
+
} catch (error) { return { ...result, ok: false, error: `failed to relocate legacy runtime data: ${error.message}` }; }
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
module.exports = { resolveDataDirPath, ensureDataDir, getDataDir, migrateFromLegacy, LEGACY_ASSETS, _resetCache };
|
|
@@ -0,0 +1,40 @@
|
|
|
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 };
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
const path = require('path');
|
|
2
|
+
const { EMBEDDING_DIMENSIONS } = require('./knowledge-schema');
|
|
3
|
+
|
|
4
|
+
const DEFAULT_MODEL_ID = 'Xenova/bge-small-zh-v1.5';
|
|
5
|
+
const QUERY_PREFIX = '为这个句子生成表示以用于检索相关文章:';
|
|
6
|
+
|
|
7
|
+
class LocalEmbeddingService {
|
|
8
|
+
constructor(options = {}) {
|
|
9
|
+
this.modelId = options.modelId || DEFAULT_MODEL_ID;
|
|
10
|
+
this.cacheDir = options.cacheDir ? path.resolve(options.cacheDir) : null;
|
|
11
|
+
this.remoteHost = String(options.remoteHost || process.env.KB_EMBEDDING_REMOTE_HOST || process.env.HF_ENDPOINT || 'https://huggingface.co/').trim();
|
|
12
|
+
this.localModelPath = options.localModelPath || process.env.KB_EMBEDDING_LOCAL_PATH || '';
|
|
13
|
+
this.localFilesOnly = options.localFilesOnly === true;
|
|
14
|
+
this.pipelineFactory = options.pipelineFactory || null;
|
|
15
|
+
this.extractor = null;
|
|
16
|
+
this.loading = null;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
async load() {
|
|
20
|
+
if (this.extractor) return this.extractor;
|
|
21
|
+
if (this.loading) return this.loading;
|
|
22
|
+
this.loading = (async () => {
|
|
23
|
+
let pipelineFactory = this.pipelineFactory;
|
|
24
|
+
if (!pipelineFactory) {
|
|
25
|
+
const transformers = await import('@huggingface/transformers');
|
|
26
|
+
if (this.cacheDir) transformers.env.cacheDir = this.cacheDir;
|
|
27
|
+
if (this.remoteHost) transformers.env.remoteHost = `${this.remoteHost.replace(/\/+$/, '')}/`;
|
|
28
|
+
if (this.localModelPath) transformers.env.localModelPath = path.resolve(this.localModelPath);
|
|
29
|
+
transformers.env.allowRemoteModels = !this.localFilesOnly;
|
|
30
|
+
pipelineFactory = transformers.pipeline;
|
|
31
|
+
}
|
|
32
|
+
const extractor = await pipelineFactory('feature-extraction', this.modelId, {
|
|
33
|
+
dtype: 'fp32',
|
|
34
|
+
local_files_only: this.localFilesOnly,
|
|
35
|
+
});
|
|
36
|
+
this.extractor = extractor;
|
|
37
|
+
return extractor;
|
|
38
|
+
})();
|
|
39
|
+
try {
|
|
40
|
+
return await this.loading;
|
|
41
|
+
} catch (error) {
|
|
42
|
+
const hint = this.localFilesOnly
|
|
43
|
+
? `Local model files were not found. Set KB_EMBEDDING_LOCAL_PATH to a directory containing ${this.modelId}.`
|
|
44
|
+
: `Could not load ${this.modelId} from ${this.remoteHost}. Check the network, or set KB_EMBEDDING_REMOTE_HOST / KB_EMBEDDING_LOCAL_PATH.`;
|
|
45
|
+
throw new Error(`${hint} ${error.message}`, { cause: error });
|
|
46
|
+
} finally {
|
|
47
|
+
this.loading = null;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
async embed(text, options = {}) {
|
|
52
|
+
const normalized = String(text || '').trim();
|
|
53
|
+
if (!normalized) throw new Error('text is required for embedding');
|
|
54
|
+
const extractor = await this.load();
|
|
55
|
+
const input = options.kind === 'query' ? `${QUERY_PREFIX}${normalized}` : normalized;
|
|
56
|
+
const output = await extractor(input, { pooling: 'cls', normalize: true });
|
|
57
|
+
const vector = Array.from(output.data || output.tolist?.()[0] || [], Number);
|
|
58
|
+
if (vector.length !== EMBEDDING_DIMENSIONS) {
|
|
59
|
+
throw new Error(`embedding model returned ${vector.length} dimensions; expected ${EMBEDDING_DIMENSIONS}`);
|
|
60
|
+
}
|
|
61
|
+
return vector;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
embedQuery(text) {
|
|
65
|
+
return this.embed(text, { kind: 'query' });
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
embedPassage(text) {
|
|
69
|
+
return this.embed(text, { kind: 'passage' });
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
status() {
|
|
73
|
+
return {
|
|
74
|
+
modelId: this.modelId,
|
|
75
|
+
dimensions: EMBEDDING_DIMENSIONS,
|
|
76
|
+
cacheDir: this.cacheDir,
|
|
77
|
+
remoteHost: this.remoteHost,
|
|
78
|
+
localModelPath: this.localModelPath || null,
|
|
79
|
+
loaded: !!this.extractor,
|
|
80
|
+
localFilesOnly: this.localFilesOnly,
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
module.exports = { LocalEmbeddingService, DEFAULT_MODEL_ID, QUERY_PREFIX };
|