memorylake-openclaw 1.1.1 → 1.1.2

package/lib/cli/register-cli.ts

@@ -1,10 +1,10 @@
-import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
 import type { PluginContext } from "../plugin-context";
 import type { MemoryLakeConfig, UploadFn } from "../types";
 import { getProvider } from "../provider";
 import { buildSearchOptions } from "../utils/builders";
+import { readJson5ConfigFile } from "../utils/config-parser";
 
 export function registerCli(pctx: PluginContext, cfg: MemoryLakeConfig): void {
   const { api, resolveConfig } = pctx;
@@ -58,7 +58,7 @@ export function registerCli(pctx: PluginContext, cfg: MemoryLakeConfig): void {
           if (opts.agent) {
             try {
               const openclawPath = path.join(os.homedir(), ".openclaw", "openclaw.json");
-              const openclaw = JSON.parse(fs.readFileSync(openclawPath, "utf-8"));
+              const openclaw = readJson5ConfigFile(openclawPath) as any;
               const agents = openclaw?.agents;
               const agentEntry = agents?.list?.find((a: any) => a.id === opts.agent);
               const workspace = agentEntry?.workspace || agents?.defaults?.workspace;

package/lib/plugin-context.ts

@@ -4,6 +4,7 @@ import os from "node:os";
 import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
 import type { MemoryLakeConfig } from "./types";
 import { ALLOWED_KEYS, memoryLakeConfigSchema } from "./config";
+import { readJson5ConfigFile } from "./utils/config-parser";
 
 const PLUGIN_ID = "memorylake-openclaw";
 const GLOBAL_CONFIG_PATH = path.join(os.homedir(), ".openclaw", "openclaw.json");
@@ -15,7 +16,7 @@ const GLOBAL_CONFIG_PATH = path.join(os.homedir(), ".openclaw", "openclaw.json")
  */
 function readGlobalConfig(logger: OpenClawPluginApi["logger"]): MemoryLakeConfig | null {
   try {
-    const raw = JSON.parse(fs.readFileSync(GLOBAL_CONFIG_PATH, "utf-8"));
+    const raw = readJson5ConfigFile(GLOBAL_CONFIG_PATH) as any;
     const pluginCfg = raw?.plugins?.entries?.[PLUGIN_ID]?.config;
     if (!pluginCfg) {
       logger.info(`memorylake-openclaw: no plugin config found in global config (path: ${GLOBAL_CONFIG_PATH}, pluginId: ${PLUGIN_ID})`);

package/lib/utils/config-parser.ts

@@ -0,0 +1,14 @@
+import fs from "node:fs";
+import JSON5 from "json5";
+
+/**
+ * Read and parse a JSON5-compatible config file.
+ */
+export function readJson5ConfigFile(filePath: string): unknown {
+  const source = fs.readFileSync(filePath, "utf-8");
+  try {
+    return JSON5.parse(source);
+  } catch (err) {
+    throw new Error(`Failed to parse JSON5 config file "${filePath}": ${String(err)}`);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "memorylake-openclaw",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "type": "module",
   "description": "MemoryLake memory backend for OpenClaw",
   "license": "MIT",
@@ -20,6 +20,7 @@
     "7zip-min": "^3.0.1",
     "adm-zip": "^0.5.17",
     "got": "^14.0.0",
+    "json5": "^2.2.3",
     "node-unrar-js": "^2.0.2",
     "tar": "^7.5.13",
     "xz-decompress": "^0.2.3"

package/skills/common/get-config.mjs

@@ -3,6 +3,7 @@
 import { readFileSync, existsSync } from "node:fs";
 import { join } from "node:path";
 import { homedir } from "node:os";
+import JSON5 from "json5";
 
 // Parse --agent
 const args = process.argv.slice(2);
@@ -15,7 +16,13 @@ const agentId = args[agentIdx + 1];
 
 // Read global config
 const openclawPath = join(homedir(), ".openclaw", "openclaw.json");
-const openclaw = JSON.parse(readFileSync(openclawPath, "utf-8"));
+let openclaw;
+try {
+  openclaw = JSON5.parse(readFileSync(openclawPath, "utf-8"));
+} catch (err) {
+  console.error(`Error: failed to parse JSON5 config file "${openclawPath}": ${String(err)}`);
+  process.exit(1);
+}
 const globalCfg = openclaw?.plugins?.entries?.["memorylake-openclaw"]?.config;
 if (!globalCfg) {
   console.error("Error: memorylake-openclaw plugin config not found");
@@ -35,9 +42,14 @@ if (!workspace) {
 const merged = { ...globalCfg };
 const localPath = join(workspace, ".memorylake", "config.json");
 if (existsSync(localPath)) {
-  const raw = JSON.parse(readFileSync(localPath, "utf-8"));
-  if (raw && typeof raw === "object" && !Array.isArray(raw)) {
-    Object.assign(merged, raw);
+  try {
+    const raw = JSON.parse(readFileSync(localPath, "utf-8"));
+    if (raw && typeof raw === "object" && !Array.isArray(raw)) {
+      Object.assign(merged, raw);
+    }
+  } catch (err) {
+    console.error(`Error: failed to parse workspace config at ${localPath}: ${String(err)}`);
+    process.exit(1);
   }
 }
 merged.host = merged.host || "https://app.memorylake.ai";

package/test/json5_config_smoke.test.mjs

@@ -0,0 +1,104 @@
+import { describe, it } from "node:test";
+import assert from "node:assert/strict";
+import { mkdtempSync, mkdirSync, writeFileSync, readFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join, resolve } from "node:path";
+import { spawnSync } from "node:child_process";
+
+const repoRoot = resolve(process.cwd());
+const getConfigScript = join(repoRoot, "skills/common/get-config.mjs");
+const pluginContextSource = join(repoRoot, "lib/plugin-context.ts");
+const registerCliSource = join(repoRoot, "lib/cli/register-cli.ts");
+
+function runGetConfig(homeDir, agentId = "a1") {
+  return spawnSync("node", [getConfigScript, "--agent", agentId], {
+    env: { ...process.env, HOME: homeDir },
+    encoding: "utf8",
+  });
+}
+
+describe("json5 config smoke", () => {
+  it("accepts JSON5 openclaw.json in get-config.mjs", () => {
+    const root = mkdtempSync(join(tmpdir(), "ml-json5-ok-"));
+    const home = root;
+    const workspace = join(root, "workspace");
+    mkdirSync(join(home, ".openclaw"), { recursive: true });
+    mkdirSync(join(workspace, ".memorylake"), { recursive: true });
+
+    writeFileSync(
+      join(home, ".openclaw", "openclaw.json"),
+      `{
+  // allow comments
+  plugins: {
+    entries: {
+      "memorylake-openclaw": {
+        config: {
+          apiKey: "k",
+          projectId: "p",
+          host: "https://app.memorylake.ai",
+        },
+      },
+    },
+  },
+  agents: {
+    list: [{ id: "a1", workspace: "${workspace.replaceAll("\\", "\\\\")}" }],
+  },
+}
+`,
+    );
+    writeFileSync(join(workspace, ".memorylake", "config.json"), JSON.stringify({ topK: 5 }));
+
+    const result = runGetConfig(home);
+    assert.equal(result.status, 0, result.stderr);
+    const parsed = JSON.parse(result.stdout);
+    assert.equal(parsed.projectId, "p");
+    assert.equal(parsed.workspace, workspace);
+    assert.equal(parsed.topK, 5);
+  });
+
+  it("returns clear non-zero error for malformed JSON5 global config", () => {
+    const root = mkdtempSync(join(tmpdir(), "ml-json5-bad-global-"));
+    const home = root;
+    mkdirSync(join(home, ".openclaw"), { recursive: true });
+    writeFileSync(join(home, ".openclaw", "openclaw.json"), "{ invalid json5 }");
+
+    const result = runGetConfig(home);
+    assert.notEqual(result.status, 0);
+    assert.match(result.stderr, /failed to parse JSON5 config file/);
+  });
+
+  it("keeps workspace override as strict JSON", () => {
+    const root = mkdtempSync(join(tmpdir(), "ml-json5-bad-local-"));
+    const home = root;
+    const workspace = join(root, "workspace");
+    mkdirSync(join(home, ".openclaw"), { recursive: true });
+    mkdirSync(join(workspace, ".memorylake"), { recursive: true });
+
+    writeFileSync(
+      join(home, ".openclaw", "openclaw.json"),
+      JSON.stringify({
+        plugins: {
+          entries: {
+            "memorylake-openclaw": {
+              config: { apiKey: "k", projectId: "p", host: "https://app.memorylake.ai" },
+            },
+          },
+        },
+        agents: { list: [{ id: "a1", workspace }] },
+      }),
+    );
+    writeFileSync(join(workspace, ".memorylake", "config.json"), "{ trailing: 1, }");
+
+    const result = runGetConfig(home);
+    assert.notEqual(result.status, 0);
+    assert.match(result.stderr, /failed to parse workspace config/);
+  });
+
+  it("ensures plugin and CLI global config paths use shared JSON5 parser", () => {
+    const pluginContext = readFileSync(pluginContextSource, "utf8");
+    const registerCli = readFileSync(registerCliSource, "utf8");
+
+    assert.match(pluginContext, /readJson5ConfigFile\(GLOBAL_CONFIG_PATH\)/);
+    assert.match(registerCli, /readJson5ConfigFile\(openclawPath\)/);
+  });
+});