Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

Move sqlite db files under <app-home>/db/ (#175)

Chirag Jain3d02a1687677
diff --git a/package.json b/package.json
index 09a8c7f23..6ec21db5c 100644
--- a/package.json
+++ b/package.json
@@ -29,6 +29,8 @@
"sdk:generate": "bash scripts/generate-sdk.sh",
"smoke:down": "docker compose down",
"smoke": "docker compose up --build --wait && node -e \"Promise.all([fetch('http://127.0.0.1:8791/healthz'), fetch('http://127.0.0.1:8791/')]).then(async ([health, ui]) => { if (!health.ok) throw new Error('healthz returned ' + health.status); const html = await ui.text(); if (!ui.ok || !html.includes('id=\\\"root\\\"')) throw new Error('UI did not return its app shell'); console.log('healthz and UI OK'); })\"",
+ "prestandalone:dev:no-watch": "pnpm --filter @truefoundry/utils migrate:legacy-sqlite-path",
+ "prestandalone:dev": "pnpm --filter @truefoundry/utils migrate:legacy-sqlite-path",
"standalone:dev:no-watch": "STANDALONE=true NODE_ENV=development pnpm --parallel --filter @truefoundry/utils --filter frontend dev:no-watch",
"standalone:dev": "STANDALONE=true NODE_ENV=development pnpm --parallel --filter @truefoundry/utils-core --filter @truefoundry/utils --filter frontend dev",
"standalone:start": "STANDALONE=true NODE_ENV=production pnpm --filter @truefoundry/utils start",
diff --git a/packages/server/.env.example b/packages/server/.env.example
index ac4d7110c..ee9ee389a 100644
--- a/packages/server/.env.example
+++ b/packages/server/.env.example
@@ -42,9 +42,9 @@ PORT=8790
## Absolute path to the SQLite database file. Used when STANDALONE=true;
## defaults to the OS data dir from env-paths (app name "truefoundry-utils"):
-## macOS: ~/Library/Application Support/truefoundry-utils/db.sqlite
-## Linux: ~/.local/share/truefoundry-utils/db.sqlite
-## Windows: %LOCALAPPDATA%\truefoundry-utils\Data\db.sqlite
+## macOS: ~/Library/Application Support/truefoundry-utils/db/db.sqlite
+## Linux: ~/.local/share/truefoundry-utils/db/db.sqlite
+## Windows: %LOCALAPPDATA%\truefoundry-utils\Data\db\db.sqlite
# SQLITE_PATH=
## Used when STANDALONE=false (ignored in standalone). Redis connection URL for
diff --git a/packages/server/package.json b/packages/server/package.json
index 21d9e8f35..ccae42d81 100644
--- a/packages/server/package.json
+++ b/packages/server/package.json
@@ -24,6 +24,7 @@
"migrate": "NODE_OPTIONS='--conditions=development' STANDALONE=false tsx --env-file=.env src/db/postgres/migrate-cli.ts",
"openapi:write": "pnpm run build:gen && NODE_OPTIONS='--conditions=development' tsx --env-file=.env.test scripts/write-openapi.ts",
"pack:dry": "pnpm pack --dry-run",
+ "migrate:legacy-sqlite-path": "node scripts/migrate-legacy-sqlite-path.mjs",
"predev:no-watch": "pnpm --filter @truefoundry/utils-core build:gen && pnpm run build:gen",
"predev": "pnpm --filter @truefoundry/utils-core build:gen && pnpm run build:gen",
"test:eventsub": "jest --config jest.eventsub.config.cjs",
diff --git a/packages/server/scripts/migrate-legacy-sqlite-path.mjs b/packages/server/scripts/migrate-legacy-sqlite-path.mjs
new file mode 100644
index 000000000..995d2da13
--- /dev/null
+++ b/packages/server/scripts/migrate-legacy-sqlite-path.mjs
@@ -0,0 +1,61 @@
+/**
+ * Temporary layout migrate for the default standalone SQLite path:
+ * `{env-paths data}/db.sqlite*` → `{env-paths data}/db/db.sqlite*`
+ *
+ * - No legacy files → noop.
+ * - `db/` already has db.sqlite + db.sqlite-shm + db.sqlite-wal → noop.
+ * - Otherwise replace `db/` by copying legacy files, then best-effort delete
+ * the legacy copies (warn only if delete fails).
+ *
+ * Used by root `prestandalone:dev` / `:no-watch`. Remove once the package
+ * rename lands and this path layout is no longer transitional.
+ */
+import { copyFileSync, existsSync, mkdirSync, readdirSync, rmSync, unlinkSync } from 'node:fs';
+import path from 'node:path';
+
+import envPaths from 'env-paths';
+
+const ENV_PATHS_APP_NAME = 'truefoundry-utils';
+const SQLITE_BASENAME = 'db.sqlite';
+const COMPLETE_DEST_FILES = ['db.sqlite', 'db.sqlite-shm', 'db.sqlite-wal'];
+
+function isLegacySqliteFileName(name) {
+ return name === SQLITE_BASENAME || name.startsWith(`${SQLITE_BASENAME}-`);
+}
+
+const dataDir = envPaths(ENV_PATHS_APP_NAME, { suffix: '' }).data;
+if (!existsSync(dataDir)) {
+ process.exit(0);
+}
+
+const legacyNames = readdirSync(dataDir).filter(isLegacySqliteFileName);
+if (legacyNames.length === 0) {
+ process.exit(0);
+}
+
+const newDir = path.join(dataDir, 'db');
+if (COMPLETE_DEST_FILES.every(name => existsSync(path.join(newDir, name)))) {
+ process.exit(0);
+}
+
+rmSync(newDir, { recursive: true, force: true });
+mkdirSync(newDir, { recursive: true });
+
+for (const name of legacyNames) {
+ const source = path.join(dataDir, name);
+ const destination = path.join(newDir, name);
+ console.log(`Moving ${source} → ${destination}`);
+ copyFileSync(source, destination);
+}
+
+for (const name of legacyNames) {
+ const source = path.join(dataDir, name);
+ try {
+ unlinkSync(source);
+ } catch (error) {
+ console.warn(
+ `Could not remove legacy ${source}:`,
+ error instanceof Error ? error.message : error,
+ );
+ }
+}
diff --git a/packages/server/src/config.ts b/packages/server/src/config.ts
index 82c1d7615..2e98600e8 100644
--- a/packages/server/src/config.ts
+++ b/packages/server/src/config.ts
@@ -27,8 +27,6 @@ const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)),
const LOCAL_EXECUTOR_ID = 'local';
/** OS-standard data dir for SQLite in standalone mode. */
const ENV_PATHS_APP_NAME = 'truefoundry-utils';
-const DEFAULT_SQLITE_FILENAME = 'db.sqlite';
-
const DEFAULT_POSTGRES_USER = 'harness';
const DEFAULT_POSTGRES_PASSWORD = 'harness';
const DEFAULT_POSTGRES_DB = 'harness';
@@ -150,7 +148,7 @@ function resolveOptionalPathEnv(envKey: string): string | undefined {
/**
* Absolute SQLite file path for standalone mode.
- * Env: `SQLITE_PATH` (optional). Default: `{env-paths data}/db.sqlite`.
+ * Env: `SQLITE_PATH` (optional). Default: `{env-paths data}/db/db.sqlite`.
*/
function resolveSqlitePath(): string {
const override = getEnv('SQLITE_PATH');
@@ -158,7 +156,7 @@ function resolveSqlitePath(): string {
return path.resolve(override);
}
const paths = envPaths(ENV_PATHS_APP_NAME, { suffix: '' });
- return path.join(paths.data, DEFAULT_SQLITE_FILENAME);
+ return path.join(paths.data, 'db', 'db.sqlite');
}
/** Redis peering URL for distributed mode. Env: `REDIS_URL`. */
@@ -384,7 +382,7 @@ export type StandaloneServerConfiguration = SharedServerConfiguration & {
STANDALONE: true;
/**
* Absolute SQLite database file path.
- * Env: `SQLITE_PATH` (optional). Default: env-paths data dir + `db.sqlite`.
+ * Env: `SQLITE_PATH` (optional). Default: env-paths data dir + `db/db.sqlite`.
*/
SQLITE_PATH: string;
};