From b2cdb8a402df86d3a9163afdb78713550cb75934 Mon Sep 17 00:00:00 2001 From: ZeR020 <88128532+ZeR020@users.noreply.github.com> Date: Tue, 8 Sep 2026 14:59:06 +0000 Subject: [PATCH 1/4] refactor(config): derive OpenCodeMemConfig from the zod schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The hand-written interface duplicated ~70 keys already enumerated by OpenCodeMemConfigSchema — one type source, no drift. --- docs/CHANGELOG.md | 1 + src/config.ts | 109 +--------------------------------------------- 2 files changed, 3 insertions(+), 107 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 3426c42..dd9f666 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- **Config types are now derived from the zod schema (z.infer) instead of a hand-maintained duplicate interface.** - **Startup no longer blocks on embedding warmup or score recalculation** — the plugin loads immediately and warms up in the background. ### Fixed diff --git a/src/config.ts b/src/config.ts index 91f23e2..69f9203 100644 --- a/src/config.ts +++ b/src/config.ts @@ -17,113 +17,6 @@ export const CONFIG_FILES = [ export type VectorBackendConfig = "usearch-first" | "usearch" | "exact-scan"; -interface OpenCodeMemConfig { - storagePath?: string; - userEmailOverride?: string; - userNameOverride?: string; - memory?: { - defaultScope?: "project" | "all-projects"; - }; - embeddingModel?: string; - embeddingDimensions?: number; - embeddingApiUrl?: string; - embeddingApiKey?: string; - similarityThreshold?: number; - maxMemories?: number; - injectProfile?: boolean; - containerTagPrefix?: string; - autoCaptureEnabled?: boolean; - promptTrackingEnabled?: boolean; - profileLearningEnabled?: boolean; - autoCaptureMaxIterations?: number; - autoCaptureMaxRetries?: number; - autoCaptureIterationTimeout?: number; - autoCaptureLanguage?: string; - memoryProvider?: AIProviderType; - memoryModel?: string; - memoryApiUrl?: string; - memoryApiKey?: string; - memoryTemperature?: number | false; - memoryExtraParams?: Record; - opencodeProvider?: string; - opencodeModel?: string; - vectorBackend?: VectorBackendConfig; - aiSessionRetentionDays?: number; - webServerEnabled?: boolean; - webServerPort?: number; - webServerHost?: string; - webServerApiKey?: string; - maxVectorsPerShard?: number; - autoCleanupEnabled?: boolean; - autoCleanupRetentionDays?: number; - deduplicationEnabled?: boolean; - deduplicationSimilarityThreshold?: number; - deduplicationIngestEnabled?: boolean; - userProfileAnalysisInterval?: number; - userProfileMaxBatchesPerIdle?: number; - userProfileMaxPreferences?: number; - userProfileMaxPatterns?: number; - userProfileMaxWorkflows?: number; - userProfileChangelogRetentionCount?: number; - promptRetentionDays?: number | false; - showAutoCaptureToasts?: boolean; - showUserProfileToasts?: boolean; - showErrorToasts?: boolean; - transcriptStorage?: { - enabled?: boolean; - maxAgeDays?: number; - }; - memoryScoring?: { - enabled?: boolean; - recalculationIntervalMinutes?: number; - recalculationBatchSize?: number; - recencyHalfLifeDays?: number; - utilityHalfLifeDays?: number; - }; - memoryLifecycle?: { - stmDecayDays?: number; - ltmDecayDays?: number; - promotionThreshold?: number; - archiveThreshold?: number; - archiveAfterDays?: number; - checkIntervalMinutes?: number; - decayBatchSize?: number; - }; - compaction?: { - enabled?: boolean; - memoryLimit?: number; - }; - chatMessage?: { - enabled?: boolean; - maxMemories?: number; - excludeCurrentSession?: boolean; - maxAgeDays?: number; - injectOn?: "first" | "always"; - mode?: "relevant" | "fast"; - }; - retrieval?: { - maxResults?: number; - diversityThreshold?: number; - contextBoost?: number; - }; - injection?: { - tokenBudget?: number; - format?: "plain" | "xml" | "yaml"; - relevanceThreshold?: number; - }; - contextualDecay?: { - enabled?: boolean; - baseDecayRate?: number; - strengthBoostFactor?: number; - accessBoostFactor?: number; - minDecayRate?: number; - maxDecayRate?: number; - }; - logLevel?: "debug" | "info" | "warn" | "error"; - warmupTimeoutMs?: number; - rateLimitEnabled?: boolean; -} - export const OpenCodeMemConfigSchema = z.object({ storagePath: z.string().optional(), userEmailOverride: z.string().optional(), @@ -251,6 +144,8 @@ export const OpenCodeMemConfigSchema = z.object({ rateLimitEnabled: z.boolean().optional(), }); +export type OpenCodeMemConfig = z.infer; + const DEFAULTS: Partial = { storagePath: join(DATA_DIR, "data"), embeddingModel: "Xenova/nomic-embed-text-v1", From be332255f99d86748e3c003eccd64dea22141fa6 Mon Sep 17 00:00:00 2001 From: ZeR020 <88128532+ZeR020@users.noreply.github.com> Date: Tue, 8 Sep 2026 15:03:17 +0000 Subject: [PATCH 2/4] refactor(server): import route handlers directly, drop the api-handlers barrel Dashboard routes already lived in handlers/; the barrel only re-exported them plus two leftover admin handlers. Import origin modules instead. --- docs/ARCHITECTURE.md | 4 +- docs/CHANGELOG.md | 1 + src/services/api-handlers.ts | 124 ------------------------------ src/services/handlers/admin.ts | 41 ++++++++++ src/services/web-server.ts | 22 +++--- tests/api-handlers.test.ts | 19 ++--- tests/embedding-cache-api.test.ts | 2 +- tests/web-server-routes.test.ts | 49 ++++++++---- tests/web-server.test.ts | 36 ++++++--- 9 files changed, 126 insertions(+), 172 deletions(-) delete mode 100644 src/services/api-handlers.ts diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index de04943..fa35345 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -37,7 +37,7 @@ graph TD EM -->|local| HF[HuggingFace Transformers
Xenova/nomic-embed-text-v1] EM -->|remote| API[OpenAI-compatible API] - WS --> AH[API Handlers
src/services/api-handlers.ts] + WS --> AH[API Handlers
src/services/handlers/] AH --> MC ``` @@ -135,7 +135,7 @@ src/ │ ├── cleanup-service.ts # Old memory and transcript cleanup │ ├── migration-service.ts # V1→V2 data migration │ ├── web-server.ts # HTTP server for web UI + REST API -│ ├── api-handlers.ts # REST API endpoint handlers +│ ├── handlers/ # REST API endpoint handlers │ ├── platform-server.ts # Platform-agnostic HTTP server abstraction │ ├── logger.ts # Structured logging with level control │ ├── privacy.ts # Private content stripping (API keys, tokens) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index dd9f666..520fff7 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- **Dashboard route handlers are imported directly — the api-handlers.ts re-export layer is gone.** - **Config types are now derived from the zod schema (z.infer) instead of a hand-maintained duplicate interface.** - **Startup no longer blocks on embedding warmup or score recalculation** — the plugin loads immediately and warms up in the background. diff --git a/src/services/api-handlers.ts b/src/services/api-handlers.ts deleted file mode 100644 index 4779150..0000000 --- a/src/services/api-handlers.ts +++ /dev/null @@ -1,124 +0,0 @@ -import { join } from "node:path"; -import { embeddingService } from "./embedding.js"; -import { connectionManager } from "./sqlite/connection-manager.js"; -import { log } from "./logger.js"; -import { CONFIG } from "../config.js"; - -// ── Re-export all domain handlers ─────────────────────────────────────────── - -// Memory CRUD handlers -export { - handleListTags, - handleListMemories, - handleAddMemory, - handleGetMemory, - handleDeleteMemory, - handleBulkDelete, - handleUpdateMemory, - handlePinMemory, - handleUnpinMemory, -} from "./handlers/memory.js"; - -// Search handler -export { handleSearch } from "./handlers/search.js"; - -// Config handler -export { handleGetConfig, handleUpdateConfig } from "./handlers/config.js"; - -// Profile handlers -export { - handleGetUserProfile, - handleUpdateUserProfile, - handleGetProfileChangelog, - handleGetProfileSnapshot, - handleRefreshProfile, -} from "./handlers/profile.js"; - -// Conflict handlers -export { - handleListConflicts, - handleGetConflict, - handleResolveConflict, - handleConflictStats, -} from "./handlers/conflicts.js"; - -// Transcript handlers -export { handleSearchTranscripts, handleListTranscripts } from "./handlers/transcripts.js"; - -// Admin / migration / cleanup handlers -export { - handleRunCleanup, - handleRunDeduplication, - handleDetectMigration, - handleRunMigration, - handleRunTagMigrationBatch, - handleGetTagMigrationProgress, - handleStats, - handleDeletePrompt, - handleBulkDeletePrompts, - handleDetectTagMigration, - MigrationProgressTracker, - migrationProgress, -} from "./handlers/admin.js"; - -// ── Shared types (re-exported for consumers) ──────────────────────────────── - -export type { - ApiResponse, - PaginatedResponse, - TagInfo, - FormattedConflict, - RawMemoryRow, -} from "./handlers/shared-types.js"; - -export type { ShardInfo } from "./sqlite/types.js"; - -// ── Remaining inline handlers (don't cleanly fit a domain module) ─────────── - -export function handleEmbeddingCacheStats(): ApiResponse<{ - size: number; - maxSize: number; - hits: number; - misses: number; - rate: number; -}> { - try { - const stats = embeddingService.getCacheStats(); - return { success: true, data: stats }; - } catch (error) { - log("handleEmbeddingCacheStats: error", { error: String(error) }); - return { success: false, error: "Internal error in handleEmbeddingCacheStats" }; - } -} - -export function handleApiStatus(): ApiResponse<{ - mode: "full" | "text-only"; - warmedUp: boolean; - ready: boolean; -}> { - try { - const mode = embeddingService.embeddingAvailable ? "full" : "text-only"; - const warmedUp = embeddingService.isWarmedUp; - let ready = false; - try { - const metadataPath = join(CONFIG.storagePath, "metadata.db"); - const db = connectionManager.getConnection(metadataPath); - const row = db.prepare("SELECT COUNT(*) as count FROM shards").get() as { count: number }; - ready = row.count > 0; - } catch { - ready = false; - } - return { success: true, data: { mode, warmedUp, ready } }; - } catch (error) { - log("handleApiStatus: error", { error: String(error) }); - return { success: false, error: "Internal error in handleApiStatus" }; - } -} - -// ── Local type (not re-exported from shared-types, kept for barrel self-containment) ── -interface ApiResponse { - success: boolean; - data?: T; - error?: string; - message?: string; -} diff --git a/src/services/handlers/admin.ts b/src/services/handlers/admin.ts index 462bc23..74576b3 100644 --- a/src/services/handlers/admin.ts +++ b/src/services/handlers/admin.ts @@ -1,3 +1,4 @@ +import { join } from "node:path"; import { embeddingService } from "../embedding.js"; import { shardManager, getAllShards } from "../sqlite/shard-manager.js"; import { vectorSearch } from "../sqlite/vector-search.js"; @@ -367,3 +368,43 @@ export async function handleRunTagMigrationBatch( return { success: false, error: "Internal error in handleRunTagMigrationBatch" }; } } + +export function handleEmbeddingCacheStats(): ApiResponse<{ + size: number; + maxSize: number; + hits: number; + misses: number; + rate: number; +}> { + try { + const stats = embeddingService.getCacheStats(); + return { success: true, data: stats }; + } catch (error) { + log("handleEmbeddingCacheStats: error", { error: String(error) }); + return { success: false, error: "Internal error in handleEmbeddingCacheStats" }; + } +} + +export function handleApiStatus(): ApiResponse<{ + mode: "full" | "text-only"; + warmedUp: boolean; + ready: boolean; +}> { + try { + const mode = embeddingService.embeddingAvailable ? "full" : "text-only"; + const warmedUp = embeddingService.isWarmedUp; + let ready = false; + try { + const metadataPath = join(CONFIG.storagePath, "metadata.db"); + const db = connectionManager.getConnection(metadataPath); + const row = db.prepare("SELECT COUNT(*) as count FROM shards").get() as { count: number }; + ready = row.count > 0; + } catch { + ready = false; + } + return { success: true, data: { mode, warmedUp, ready } }; + } catch (error) { + log("handleApiStatus: error", { error: String(error) }); + return { success: false, error: "Internal error in handleApiStatus" }; + } +} diff --git a/src/services/web-server.ts b/src/services/web-server.ts index 151ebe0..ef9d0a9 100644 --- a/src/services/web-server.ts +++ b/src/services/web-server.ts @@ -14,12 +14,13 @@ import { handleDeleteMemory, handleBulkDelete, handleUpdateMemory, - handleSearch, - handleSearchTranscripts, - handleListTranscripts, - handleStats, handlePinMemory, handleUnpinMemory, +} from "./handlers/memory.js"; +import { handleSearch } from "./handlers/search.js"; +import { handleSearchTranscripts, handleListTranscripts } from "./handlers/transcripts.js"; +import { + handleStats, handleRunCleanup, handleRunDeduplication, handleDetectMigration, @@ -29,20 +30,23 @@ import { handleGetTagMigrationProgress, handleDeletePrompt, handleBulkDeletePrompts, + handleEmbeddingCacheStats, + handleApiStatus, +} from "./handlers/admin.js"; +import { handleGetUserProfile, handleUpdateUserProfile, handleGetProfileChangelog, handleGetProfileSnapshot, handleRefreshProfile, +} from "./handlers/profile.js"; +import { handleListConflicts, handleGetConflict, handleResolveConflict, handleConflictStats, - handleEmbeddingCacheStats, - handleApiStatus, - handleGetConfig, - handleUpdateConfig, -} from "./api-handlers.js"; +} from "./handlers/conflicts.js"; +import { handleGetConfig, handleUpdateConfig } from "./handlers/config.js"; const __filename = fileURLToPath(import.meta.url); const __dirname = dirname(__filename); diff --git a/tests/api-handlers.test.ts b/tests/api-handlers.test.ts index 7df2122..aeb6030 100644 --- a/tests/api-handlers.test.ts +++ b/tests/api-handlers.test.ts @@ -345,22 +345,23 @@ const { handleAddMemory, handleDeleteMemory, handleUpdateMemory, - handleSearch, + handlePinMemory, + handleUnpinMemory, + handleBulkDelete, +} = await import("../src/services/handlers/memory.js"); +const { handleSearch } = await import("../src/services/handlers/search.js"); +const { handleEmbeddingCacheStats, handleApiStatus, handleStats, - handlePinMemory, - handleUnpinMemory, handleDeletePrompt, - handleBulkDelete, - handleGetUserProfile, - handleListConflicts, - handleResolveConflict, - handleConflictStats, handleDetectTagMigration, handleGetTagMigrationProgress, handleRunTagMigrationBatch, -} = await import("../src/services/api-handlers.js"); +} = await import("../src/services/handlers/admin.js"); +const { handleGetUserProfile } = await import("../src/services/handlers/profile.js"); +const { handleListConflicts, handleResolveConflict, handleConflictStats } = + await import("../src/services/handlers/conflicts.js"); // vitest: await import after vi.mock ensures the mocked detectConflicts is resolved. const { detectConflicts } = await import("../src/services/memory-conflicts.js"); diff --git a/tests/embedding-cache-api.test.ts b/tests/embedding-cache-api.test.ts index 1ddc454..db3f6e5 100644 --- a/tests/embedding-cache-api.test.ts +++ b/tests/embedding-cache-api.test.ts @@ -1,5 +1,5 @@ import { describe, it, expect, beforeEach, vi } from "vitest"; -import { handleEmbeddingCacheStats } from "../src/services/api-handlers.js"; +import { handleEmbeddingCacheStats } from "../src/services/handlers/admin.js"; import { embeddingService } from "../src/services/embedding.js"; describe("handleEmbeddingCacheStats", () => { diff --git a/tests/web-server-routes.test.ts b/tests/web-server-routes.test.ts index bd11fad..7a0ebc5 100644 --- a/tests/web-server-routes.test.ts +++ b/tests/web-server-routes.test.ts @@ -17,7 +17,7 @@ vi.mock("../src/services/platform-server.js", () => ({ serve: vi.fn(), })); -vi.mock("../src/services/api-handlers.js", () => ({ +vi.mock("../src/services/handlers/memory.js", () => ({ handleListTags: vi.fn(), handleListMemories: vi.fn(), handleGetMemory: vi.fn(), @@ -25,12 +25,18 @@ vi.mock("../src/services/api-handlers.js", () => ({ handleDeleteMemory: vi.fn(), handleBulkDelete: vi.fn(), handleUpdateMemory: vi.fn(), + handlePinMemory: vi.fn(), + handleUnpinMemory: vi.fn(), +})); +vi.mock("../src/services/handlers/search.js", () => ({ handleSearch: vi.fn(), +})); +vi.mock("../src/services/handlers/transcripts.js", () => ({ handleSearchTranscripts: vi.fn(), handleListTranscripts: vi.fn(), +})); +vi.mock("../src/services/handlers/admin.js", () => ({ handleStats: vi.fn(), - handlePinMemory: vi.fn(), - handleUnpinMemory: vi.fn(), handleRunCleanup: vi.fn(), handleRunDeduplication: vi.fn(), handleDetectMigration: vi.fn(), @@ -40,16 +46,22 @@ vi.mock("../src/services/api-handlers.js", () => ({ handleGetTagMigrationProgress: vi.fn(), handleDeletePrompt: vi.fn(), handleBulkDeletePrompts: vi.fn(), + handleEmbeddingCacheStats: vi.fn(), + handleApiStatus: vi.fn(), +})); +vi.mock("../src/services/handlers/profile.js", () => ({ handleGetUserProfile: vi.fn(), handleUpdateUserProfile: vi.fn(), handleGetProfileChangelog: vi.fn(), handleGetProfileSnapshot: vi.fn(), handleRefreshProfile: vi.fn(), +})); +vi.mock("../src/services/handlers/conflicts.js", () => ({ handleListConflicts: vi.fn(), handleResolveConflict: vi.fn(), handleConflictStats: vi.fn(), - handleEmbeddingCacheStats: vi.fn(), - handleApiStatus: vi.fn(), +})); +vi.mock("../src/services/handlers/config.js", () => ({ handleGetConfig: vi.fn(), handleUpdateConfig: vi.fn(), })); @@ -63,15 +75,16 @@ import { handleDeleteMemory, handleBulkDelete, handleUpdateMemory, - handleSearch, + handlePinMemory, + handleUnpinMemory, +} from "../src/services/handlers/memory.js"; +import { handleSearch } from "../src/services/handlers/search.js"; +import { handleSearchTranscripts, handleListTranscripts, +} from "../src/services/handlers/transcripts.js"; +import { handleStats, - handlePinMemory, - handleUnpinMemory, - handleResolveConflict, - handleListConflicts, - handleConflictStats, handleRunCleanup, handleRunDeduplication, handleDetectMigration, @@ -81,14 +94,20 @@ import { handleGetTagMigrationProgress, handleDeletePrompt, handleBulkDeletePrompts, + handleEmbeddingCacheStats, +} from "../src/services/handlers/admin.js"; +import { handleGetUserProfile, handleGetProfileChangelog, handleGetProfileSnapshot, handleRefreshProfile, - handleEmbeddingCacheStats, - handleGetConfig, - handleUpdateConfig, -} from "../src/services/api-handlers.js"; +} from "../src/services/handlers/profile.js"; +import { + handleResolveConflict, + handleListConflicts, + handleConflictStats, +} from "../src/services/handlers/conflicts.js"; +import { handleGetConfig, handleUpdateConfig } from "../src/services/handlers/config.js"; describe("WebServer Routes", () => { let server: WebServer; diff --git a/tests/web-server.test.ts b/tests/web-server.test.ts index caad219..73d61e1 100644 --- a/tests/web-server.test.ts +++ b/tests/web-server.test.ts @@ -5,7 +5,7 @@ vi.mock("../src/services/logger.js", () => ({ setLogLevel: () => {}, })); -vi.mock("../src/services/api-handlers.js", () => ({ +vi.mock("../src/services/handlers/memory.js", () => ({ handleListTags: () => ({ success: true, data: { project: [] } }), handleListMemories: () => ({ success: true, @@ -16,16 +16,20 @@ vi.mock("../src/services/api-handlers.js", () => ({ handleDeleteMemory: () => ({ success: true, data: { deletedPrompt: false } }), handleBulkDelete: () => ({ success: true, data: { deleted: 1 } }), handleUpdateMemory: () => ({ success: true }), + handlePinMemory: () => ({ success: true }), + handleUnpinMemory: () => ({ success: true }), +})); +vi.mock("../src/services/handlers/search.js", () => ({ handleSearch: () => ({ success: true, data: { items: [], total: 0, page: 1, pageSize: 20, totalPages: 0 }, }), +})); +vi.mock("../src/services/handlers/admin.js", () => ({ handleStats: () => ({ success: true, data: { total: 0, byScope: { user: 0, project: 0 }, byType: {} }, }), - handlePinMemory: () => ({ success: true }), - handleUnpinMemory: () => ({ success: true }), handleRunCleanup: () => ({ success: true, data: { deletedCount: 0, userCount: 0, projectCount: 0 }, @@ -68,18 +72,28 @@ vi.mock("../src/services/api-handlers.js", () => ({ }), handleDeletePrompt: () => ({ success: true, data: { deletedMemory: false } }), handleBulkDeletePrompts: () => ({ success: true, data: { deleted: 1 } }), + handleEmbeddingCacheStats: () => ({ + success: true, + data: { size: 0, maxSize: 1000, hits: 0, misses: 0, rate: 0 }, + }), + handleApiStatus: () => ({ + success: true, + data: { status: "ok", version: "1.0.0" }, + }), +})); +vi.mock("../src/services/handlers/profile.js", () => ({ handleGetUserProfile: () => ({ success: true, data: { exists: false } }), handleGetProfileChangelog: () => ({ success: true, data: [] }), handleGetProfileSnapshot: () => ({ success: true, data: { version: 1, profileData: {} } }), handleRefreshProfile: () => ({ success: true, data: { message: "ok" } }), + handleUpdateUserProfile: () => ({ success: true, data: { message: "ok" } }), +})); +vi.mock("../src/services/handlers/conflicts.js", () => ({ handleListConflicts: () => ({ success: true, data: [] }), handleResolveConflict: () => ({ success: true, data: { mergedMemoryId: "mem-1" } }), handleConflictStats: () => ({ success: true, data: { unresolved: 0, resolved: 0 } }), - handleEmbeddingCacheStats: () => ({ - success: true, - data: { size: 0, maxSize: 1000, hits: 0, misses: 0, rate: 0 }, - }), - handleUpdateUserProfile: () => ({ success: true, data: { message: "ok" } }), +})); +vi.mock("../src/services/handlers/transcripts.js", () => ({ handleSearchTranscripts: () => ({ success: true, data: { items: [], total: 0 }, @@ -88,15 +102,13 @@ vi.mock("../src/services/api-handlers.js", () => ({ success: true, data: { items: [], total: 0 }, }), +})); +vi.mock("../src/services/handlers/config.js", () => ({ handleGetConfig: () => ({ success: true, data: { memoryProvider: "openai-chat", memoryApiKeyMasked: "" }, }), handleUpdateConfig: () => ({ success: true, data: {} }), - handleApiStatus: () => ({ - success: true, - data: { status: "ok", version: "1.0.0" }, - }), })); const { WebServer } = await import("../src/services/web-server.js"); From 0819d04971fc0cab4321409922d81a4692793a50 Mon Sep 17 00:00:00 2001 From: ZeR020 <88128532+ZeR020@users.noreply.github.com> Date: Tue, 8 Sep 2026 15:04:13 +0000 Subject: [PATCH 3/4] chore(deps): move better-sqlite3 to optionalDependencies Native builds fail on exotic platforms and used to fail the whole install. bun:sqlite / node:sqlite users never needed it as a hard dep. --- bun.lock | 4 +++- docs/CHANGELOG.md | 1 + docs/GETTING-STARTED.md | 6 +++--- package.json | 4 +++- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/bun.lock b/bun.lock index 48a933e..7758d20 100644 --- a/bun.lock +++ b/bun.lock @@ -11,7 +11,6 @@ "@opencode-ai/plugin": "^1.14.31", "@opencode-ai/sdk": "^1.14.31", "ai": "^7.0.4", - "better-sqlite3": "^13.0.2", "franc-min": "^6.2.0", "jsonc-parser": "^3.3.1", "usearch": "^2.25.1", @@ -27,6 +26,9 @@ "typescript": "^7.0.2", "vitest": "^4.1.9", }, + "optionalDependencies": { + "better-sqlite3": "^13.0.2", + }, }, }, "overrides": { diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 520fff7..7247574 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- **better-sqlite3 is an optional dependency — installs no longer hard-fail on platforms where its native build breaks (bun:sqlite / node:sqlite users unaffected).** - **Dashboard route handlers are imported directly — the api-handlers.ts re-export layer is gone.** - **Config types are now derived from the zod schema (z.infer) instead of a hand-maintained duplicate interface.** - **Startup no longer blocks on embedding warmup or score recalculation** — the plugin loads immediately and warms up in the background. diff --git a/docs/GETTING-STARTED.md b/docs/GETTING-STARTED.md index 938c0ca..7ce73ce 100644 --- a/docs/GETTING-STARTED.md +++ b/docs/GETTING-STARTED.md @@ -143,11 +143,11 @@ After the initial download, subsequent runs are near-instant. Alternatively, use | `%USERPROFILE%\.config\opencode\opencode-mem0.jsonc` | Global config | | `%USERPROFILE%\.opencode-mem0\data` | SQLite databases, embedding model cache | -### better-sqlite3 install fails (node-gyp / MSBuild error) +### better-sqlite3 native build fails (node-gyp / MSBuild warning) -**Symptom:** `npm install opencode-mem0` fails with `node-gyp` or `MSBuild` errors (Windows ARM64 or a very new Node version without prebuilt binaries). +**Symptom:** `npm install` warns that optional `better-sqlite3` failed to build (`node-gyp` / `MSBuild`). The install itself succeeds. -**Solution:** Install [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) with the **"Desktop development with C++"** workload + [Python 3](https://www.python.org/downloads/), then retry. One-time setup. +**Solution:** Ignore it on Bun or Node >= 22.5 — `bun:sqlite` / `node:sqlite` cover those runtimes. On Node < 22.5, install [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) with the **"Desktop development with C++"** workload + [Python 3](https://www.python.org/downloads/) and retry so the native fallback can load. ### Auto-capture skips with "LLM provider not configured" diff --git a/package.json b/package.json index 6e19d69..ac560e8 100644 --- a/package.json +++ b/package.json @@ -66,12 +66,14 @@ "@opencode-ai/plugin": "^1.14.31", "@opencode-ai/sdk": "^1.14.31", "ai": "^7.0.4", - "better-sqlite3": "^13.0.2", "franc-min": "^6.2.0", "jsonc-parser": "^3.3.1", "usearch": "^2.25.1", "zod": "^4.4.1" }, + "optionalDependencies": { + "better-sqlite3": "^13.0.2" + }, "devDependencies": { "@types/better-sqlite3": "^7.6.13", "@types/bun": "^1.3.13", From 4f5f744ced49c0c58369ce403f90876096fc6d58 Mon Sep 17 00:00:00 2001 From: ZeR020 <88128532+ZeR020@users.noreply.github.com> Date: Tue, 8 Sep 2026 15:07:11 +0000 Subject: [PATCH 4/4] refactor: shared statement cache, plugin.ts re-exports directly ConnectionManager and VectorSearch each rolled their own prepared-statement WeakMap. plugin.ts only logged-and-rethrew around a static import. --- docs/CHANGELOG.md | 1 + src/plugin.ts | 9 +-------- src/services/sqlite/connection-manager.ts | 20 +++----------------- src/services/sqlite/sqlite-bootstrap.ts | 17 +++++++++++++++++ src/services/sqlite/vector-search.ts | 18 ++++-------------- 5 files changed, 26 insertions(+), 39 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 7247574..71a7bea 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- **Prepared-statement caching is shared, and plugin.ts re-exports OpenCodeMemPlugin directly.** - **better-sqlite3 is an optional dependency — installs no longer hard-fail on platforms where its native build breaks (bun:sqlite / node:sqlite users unaffected).** - **Dashboard route handlers are imported directly — the api-handlers.ts re-export layer is gone.** - **Config types are now derived from the zod schema (z.infer) instead of a hand-maintained duplicate interface.** diff --git a/src/plugin.ts b/src/plugin.ts index 76501a5..d174fea 100644 --- a/src/plugin.ts +++ b/src/plugin.ts @@ -1,13 +1,6 @@ import type { PluginModule } from "@opencode-ai/plugin"; import pkg from "../package.json" with { type: "json" }; - -let OpenCodeMemPlugin: (typeof import("./index.js"))["OpenCodeMemPlugin"]; // skipcq JS-E1009 -try { - ({ OpenCodeMemPlugin } = await import("./index.js")); -} catch (e) { - console.error("Failed to load OpenCodeMemPlugin:", e); // skipcq JS-0002 - throw e; -} +import { OpenCodeMemPlugin } from "./index.js"; export const id = pkg.name; export { OpenCodeMemPlugin }; diff --git a/src/services/sqlite/connection-manager.ts b/src/services/sqlite/connection-manager.ts index b0b32e7..17d901c 100644 --- a/src/services/sqlite/connection-manager.ts +++ b/src/services/sqlite/connection-manager.ts @@ -1,4 +1,4 @@ -import { getDatabase, type Database } from "./sqlite-bootstrap.js"; +import { getDatabase, StmtCache, type Database } from "./sqlite-bootstrap.js"; import { existsSync, mkdirSync } from "node:fs"; import { dirname } from "node:path"; import { log } from "../logger.js"; @@ -15,7 +15,7 @@ class ConnectionManager { private readonly creating: Set = new Set(); private isClosing = false; private readonly batches: Map> = new Map(); - private readonly stmtCache = new WeakMap>(); + private readonly stmts = new StmtCache(); private readonly inTxn = new Set(); private trackTransactions(dbPath: string, db: Database): void { @@ -34,20 +34,6 @@ class ConnectionManager { this.accessOrder.push(dbPath); } - private getStmt(db: Database, sql: string): any { - let dbCache = this.stmtCache.get(db); - if (!dbCache) { - dbCache = new Map(); - this.stmtCache.set(db, dbCache); - } - let stmt = dbCache.get(sql); - if (!stmt) { - stmt = db.prepare(sql); - dbCache.set(sql, stmt); - } - return stmt; - } - batchWrite(dbPath: string, sql: string, params: any[]): void { let batch = this.batches.get(dbPath); if (!batch) { @@ -69,7 +55,7 @@ class ConnectionManager { db.run("BEGIN IMMEDIATE"); try { for (const item of batch) { - const stmt = this.getStmt(db, item.sql); + const stmt = this.stmts.get(db, item.sql); stmt.run(...item.params); } db.run("COMMIT"); diff --git a/src/services/sqlite/sqlite-bootstrap.ts b/src/services/sqlite/sqlite-bootstrap.ts index 50afeeb..08961e5 100644 --- a/src/services/sqlite/sqlite-bootstrap.ts +++ b/src/services/sqlite/sqlite-bootstrap.ts @@ -18,6 +18,23 @@ export interface Database { close(): void; } +export class StmtCache { + private readonly cache = new WeakMap>(); + get(db: Database, sql: string): Statement { + let dbCache = this.cache.get(db); + if (!dbCache) { + dbCache = new Map(); + this.cache.set(db, dbCache); + } + let stmt = dbCache.get(sql); + if (!stmt) { + stmt = db.prepare(sql); + dbCache.set(sql, stmt); + } + return stmt; + } +} + /** * Minimal shape of the raw underlying driver. Each backend (bun:sqlite, * node:sqlite, better-sqlite3) structurally satisfies this; we cast the diff --git a/src/services/sqlite/vector-search.ts b/src/services/sqlite/vector-search.ts index 5ceae60..348d1e8 100644 --- a/src/services/sqlite/vector-search.ts +++ b/src/services/sqlite/vector-search.ts @@ -1,4 +1,4 @@ -import type { Database } from "./sqlite-bootstrap.js"; +import { StmtCache, type Database } from "./sqlite-bootstrap.js"; import { connectionManager } from "./connection-manager.js"; import { log } from "../logger.js"; import { CONFIG } from "../../config.js"; @@ -95,7 +95,7 @@ const MEMORIES_INSERT_SQL = ` export class VectorSearch { private readonly backendPromise: Promise; private readonly fallbackBackend: VectorBackend; - private readonly stmtCache = new WeakMap>(); + private readonly stmts = new StmtCache(); private readonly wordSetCache = new Map>(); private readonly MAX_WORDSET_CACHE = 1000; private readonly rebuildDirty = new Map(); @@ -117,18 +117,8 @@ export class VectorSearch { } } - private getStmt(db: Database, sql: string): any { - let dbCache = this.stmtCache.get(db); - if (!dbCache) { - dbCache = new Map(); - this.stmtCache.set(db, dbCache); - } - let stmt = dbCache.get(sql); - if (!stmt) { - stmt = db.prepare(sql); - dbCache.set(sql, stmt); - } - return stmt; + private getStmt(db: Database, sql: string) { + return this.stmts.get(db, sql); } private getBackend(): Promise {