Repository navigation
fix(cli): fall back to default data dir when DATA_DIR is not writable #4767
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
diegosouzapw
merged 1 commit into
release/v3.8.37
from
fix/port-commit-a48fa4eb-data-dir-permission-fallback
Jun 26, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| import test from "node:test"; | ||
| import assert from "node:assert/strict"; | ||
| import fs from "node:fs"; | ||
| import os from "node:os"; | ||
| import path from "node:path"; | ||
|
|
||
| import { | ||
| resolveWritableDataDir, | ||
| getDefaultDataDir, | ||
| resolveDataDir, | ||
| } from "../../src/lib/dataPaths.ts"; | ||
|
|
||
| // Running as root bypasses POSIX permission bits, so a chmod-based "unwritable" | ||
| // directory would still be writable and the EACCES/EPERM branch never triggers. | ||
| const IS_ROOT = typeof process.getuid === "function" && process.getuid() === 0; | ||
| const IS_WINDOWS = process.platform === "win32"; | ||
|
|
||
| async function withTempEnv( | ||
| fn: (paths: { root: string; home: string }) => void | Promise<void> | ||
| ) { | ||
| const originalEnv = { ...process.env }; | ||
| const root = fs.mkdtempSync(path.join(os.tmpdir(), "omni-datadir-")); | ||
| const home = path.join(root, "home"); | ||
| fs.mkdirSync(home, { recursive: true }); | ||
|
|
||
| delete process.env.DATA_DIR; | ||
| delete process.env.XDG_CONFIG_HOME; | ||
| delete process.env.APPDATA; | ||
| process.env.HOME = home; | ||
| process.env.USERPROFILE = home; | ||
|
|
||
| try { | ||
| await fn({ root, home }); | ||
| } finally { | ||
| for (const key of Object.keys(process.env)) { | ||
| if (!(key in originalEnv)) delete process.env[key]; | ||
| } | ||
| for (const [key, value] of Object.entries(originalEnv)) { | ||
| process.env[key] = value; | ||
| } | ||
| // Restore perms before cleanup so rmSync can delete read-only parents. | ||
| try { | ||
| fs.chmodSync(root, 0o755); | ||
| } catch { | ||
| // ignore | ||
| } | ||
| fs.rmSync(root, { recursive: true, force: true }); | ||
| } | ||
| } | ||
|
|
||
| test("resolveWritableDataDir returns the configured DATA_DIR when it is writable", async () => { | ||
| await withTempEnv(({ root }) => { | ||
| const configured = path.join(root, "writable-data"); | ||
| process.env.DATA_DIR = configured; | ||
|
|
||
| const resolved = resolveWritableDataDir(); | ||
| assert.equal(resolved, path.resolve(configured)); | ||
| // The probe creates the directory as a side effect. | ||
| assert.ok(fs.existsSync(configured)); | ||
| }); | ||
| }); | ||
|
|
||
| test("resolveWritableDataDir falls back to the default dir when DATA_DIR is not writable (EACCES/EPERM)", { skip: IS_ROOT || IS_WINDOWS }, async () => { | ||
| await withTempEnv(({ root, home }) => { | ||
| // A read-only parent makes mkdir of the child fail with EACCES/EPERM. | ||
| const lockedParent = path.join(root, "locked"); | ||
| fs.mkdirSync(lockedParent, { recursive: true }); | ||
| fs.chmodSync(lockedParent, 0o555); | ||
|
|
||
| const configured = path.join(lockedParent, "data"); | ||
| process.env.DATA_DIR = configured; | ||
|
|
||
| const resolved = resolveWritableDataDir(); | ||
| const expectedFallback = getDefaultDataDir(); | ||
|
|
||
| // It must NOT return the unwritable configured dir... | ||
| assert.notEqual(resolved, path.resolve(configured)); | ||
| // ...and instead fall back to the default user dir (~/.omniroute under HOME). | ||
| assert.equal(resolved, expectedFallback); | ||
| assert.ok(resolved.startsWith(path.resolve(home))); | ||
| }); | ||
| }); | ||
|
|
||
| test("resolveWritableDataDir returns the default dir (no probe) when DATA_DIR is unset", async () => { | ||
| await withTempEnv(() => { | ||
| delete process.env.DATA_DIR; | ||
| const resolved = resolveWritableDataDir(); | ||
| assert.equal(resolved, getDefaultDataDir()); | ||
| // Matches the pure resolver when no override is present. | ||
| assert.equal(resolved, resolveDataDir()); | ||
| }); | ||
| }); | ||
|
|
||
| test("resolveWritableDataDir rethrows non-permission errors", { skip: IS_WINDOWS }, async () => { | ||
| await withTempEnv(({ root }) => { | ||
| // Point DATA_DIR at a path whose parent is a regular file → ENOTDIR, not EACCES. | ||
| const fileParent = path.join(root, "iam-a-file"); | ||
| fs.writeFileSync(fileParent, "x"); | ||
|
|
||
| const configured = path.join(fileParent, "data"); | ||
| process.env.DATA_DIR = configured; | ||
|
|
||
| assert.throws(() => resolveWritableDataDir(), (err: NodeJS.ErrnoException) => { | ||
| return err.code !== "EACCES" && err.code !== "EPERM"; | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| test("resolveWritableDataDir leaves the cloud sentinel untouched", async () => { | ||
| await withTempEnv(() => { | ||
| process.env.DATA_DIR = "/some/configured/path"; | ||
| const resolved = resolveWritableDataDir({ isCloud: true }); | ||
| assert.equal(resolved, "/tmp"); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a permission error occurs and the application falls back to the default user directory,
process.env.DATA_DIRis left pointing to the original, unwritable path.Because other parts of the application call the pure
resolveDataDir()resolver directly, they will still resolve to the unwritableprocess.env.DATA_DIRpath. This creates a split-brain scenario where the database is initialized in the fallback directory, but other components attempt to read/write from the unwritable configured directory, leading to runtime crashes or silent failures.Updating
process.env.DATA_DIRto the fallback path ensures consistency across all path resolvers and any spawned subprocesses.