Skip to content

Self-hosted, Self-Improving, Federated Everything App — dev management, agent orchestration, persistent mind, digital twin, second brain, and creative pipeline from a single dashboard over Tailscale to port the user into the OS

fix: keep checkout recovery directories private after Spotlight setup (#13333)

Adam Eivy2e31539136a0
diff --git a/scripts/lib/spotlightExclude.js b/scripts/lib/spotlightExclude.js
index 3df1cc9072..9ae27f1037 100644
--- a/scripts/lib/spotlightExclude.js
+++ b/scripts/lib/spotlightExclude.js
@@ -31,7 +31,7 @@ export function excludeFromSpotlight(dataDir, { platform = process.platform, dir
const dir = join(dataDir, rel);
const marker = join(dir, SPOTLIGHT_MARKER);
if (existsSync(marker)) continue;
- mkdirSync(dir, { recursive: true });
+ mkdirSync(dir, { recursive: true, mode: 0o700 });
writeFileSync(marker, '');
created = true;
}
diff --git a/scripts/migrations/439-private-spotlight-directories.js b/scripts/migrations/439-private-spotlight-directories.js
new file mode 100644
index 0000000000..263ce01556
--- /dev/null
+++ b/scripts/migrations/439-private-spotlight-directories.js
@@ -0,0 +1,19 @@
+/** Repair directories pre-created by Spotlight setup without weakening private stores. */
+import { chmod, lstat } from 'node:fs/promises';
+import { join } from 'node:path';
+import { SPOTLIGHT_EXCLUDED_DIRS } from '../lib/spotlightExclude.js';
+
+export default {
+ async up({ rootDir, platform = process.platform, uid = process.getuid?.() }) {
+ if (platform !== 'darwin' || uid === undefined) return;
+ for (const rel of SPOTLIGHT_EXCLUDED_DIRS) {
+ const directory = join(rootDir, 'data', rel);
+ const info = await lstat(directory).catch(error => {
+ if (error.code === 'ENOENT') return null;
+ throw error;
+ });
+ if (!info?.isDirectory() || info.isSymbolicLink() || info.uid !== uid || (info.mode & 0o077) === 0) continue;
+ await chmod(directory, 0o700);
+ }
+ },
+};
diff --git a/scripts/migrations/439-private-spotlight-directories.test.js b/scripts/migrations/439-private-spotlight-directories.test.js
new file mode 100644
index 0000000000..510cf9e2c9
--- /dev/null
+++ b/scripts/migrations/439-private-spotlight-directories.test.js
@@ -0,0 +1,63 @@
+import { chmod, lstat, mkdir, mkdtemp, readFile, rm, stat, symlink, writeFile } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+import { _createInitializedCheckoutRecovery } from '../../server/services/initializedCheckoutRecovery.js';
+import { excludeFromSpotlight, SPOTLIGHT_EXCLUDED_DIRS } from '../lib/spotlightExclude.js';
+import migration from './439-private-spotlight-directories.js';
+
+let rootDir;
+const directory = rel => join(rootDir, 'data', rel);
+const mode = async path => (await stat(path)).mode & 0o777;
+beforeEach(async () => { rootDir = await mkdtemp(join(tmpdir(), 'private-spotlight-')); });
+afterEach(() => rm(rootDir, { recursive: true, force: true }));
+
+describe.skipIf(process.platform === 'win32')('macOS Spotlight directory repair', () => {
+ it('repairs an existing Spotlight-marked install so initialized recovery can discover journals', async () => {
+ excludeFromSpotlight(join(rootDir, 'data'), { platform: 'darwin' });
+ for (const rel of SPOTLIGHT_EXCLUDED_DIRS) await chmod(directory(rel), 0o755);
+ const recovery = _createInitializedCheckoutRecovery({ root: () => directory('cos/initialized-checkout-retirements') });
+ await expect(recovery.discover()).rejects.toThrow('retirement-journal-directory-unsafe');
+
+ await migration.up({ rootDir, platform: 'darwin' });
+
+ for (const rel of SPOTLIGHT_EXCLUDED_DIRS) expect(await mode(directory(rel)), rel).toBe(0o700);
+ expect(await recovery.discover()).toEqual({ ok: true, transactions: [] });
+ await migration.up({ rootDir, platform: 'darwin' });
+ expect(await recovery.discover()).toEqual({ ok: true, transactions: [] });
+ });
+
+ it('leaves symlinks, non-directories, absent paths and more restrictive modes untouched', async () => {
+ await mkdir(directory('cos'), { recursive: true });
+ const target = join(rootDir, 'symlink-target');
+ await mkdir(target, { mode: 0o755 });
+ await chmod(target, 0o755);
+ await symlink(target, directory('browser-profile'));
+ await writeFile(directory('python'), 'retained');
+ await mkdir(directory('repos'), { mode: 0o500 });
+ await chmod(directory('repos'), 0o500);
+ try {
+ await migration.up({ rootDir, platform: 'darwin' });
+ expect((await lstat(directory('browser-profile'))).isSymbolicLink()).toBe(true);
+ expect(await mode(target)).toBe(0o755);
+ expect(await readFile(directory('python'), 'utf8')).toBe('retained');
+ expect(await mode(directory('repos'))).toBe(0o500);
+ await expect(lstat(directory('training-runs'))).rejects.toMatchObject({ code: 'ENOENT' });
+ } finally { await chmod(directory('repos'), 0o700); }
+ });
+
+ it('does not chmod a directory owned by a different user', async () => {
+ await mkdir(directory('browser-profile'), { recursive: true });
+ await chmod(directory('browser-profile'), 0o755);
+ await migration.up({ rootDir, platform: 'darwin', uid: process.getuid() + 1 });
+ expect(await mode(directory('browser-profile'))).toBe(0o755);
+ });
+});
+
+it('does not create directories or change permissions on other platforms', async () => {
+ await mkdir(directory('browser-profile'), { recursive: true });
+ const before = await mode(directory('browser-profile'));
+ await migration.up({ rootDir, platform: 'linux' });
+ expect(await mode(directory('browser-profile'))).toBe(before);
+ await expect(lstat(directory('cos'))).rejects.toMatchObject({ code: 'ENOENT' });
+});
diff --git a/scripts/setup-spotlight.test.js b/scripts/setup-spotlight.test.js
index 94b913bad9..5c41e29c53 100644
--- a/scripts/setup-spotlight.test.js
+++ b/scripts/setup-spotlight.test.js
@@ -1,8 +1,8 @@
-import { existsSync, mkdtempSync, rmSync } from 'node:fs';
+import { existsSync, mkdtempSync, rmSync, statSync } from 'node:fs';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { afterEach, describe, expect, it } from 'vitest';
-import { excludeFromSpotlight, SPOTLIGHT_MARKER } from './lib/spotlightExclude.js';
+import { excludeFromSpotlight, SPOTLIGHT_EXCLUDED_DIRS, SPOTLIGHT_MARKER } from './lib/spotlightExclude.js';
import { setupSpotlight } from './setup-spotlight.js';
describe('Spotlight exclusion of data/', () => {
@@ -26,4 +26,12 @@ describe('Spotlight exclusion of data/', () => {
expect(setupSpotlight(dir, { log: () => {}, env: { PORTOS_SKIP_SPOTLIGHT_EXCLUDE: '1' } })).toBe('skipped');
expect(existsSync(dir)).toBe(false);
});
+
+ it.skipIf(process.platform === 'win32')('creates private machinery directories on macOS', () => {
+ const dir = tmp();
+ excludeFromSpotlight(dir, { platform: 'darwin' });
+ for (const rel of SPOTLIGHT_EXCLUDED_DIRS) {
+ expect(statSync(join(dir, rel)).mode & 0o777, rel).toBe(0o700);
+ }
+ });
});
diff --git a/server/services/initializedCheckoutRecovery.js b/server/services/initializedCheckoutRecovery.js
index 4c5191e872..ad3883152b 100644
--- a/server/services/initializedCheckoutRecovery.js
+++ b/server/services/initializedCheckoutRecovery.js
@@ -13,6 +13,7 @@ import { PATHS } from '../lib/paths.js';
import { execGit } from '../lib/execGit.js';
import { assertNotRealDataWrite } from '../lib/testDataIsolation.js';
import { withClaimOwnershipLock } from './cosClaimOwnershipState.js';
+import { SPOTLIGHT_MARKER } from '../../scripts/lib/spotlightExclude.js';
const helper = fileURLToPath(new URL('../../scripts/lib/initialized_checkout_archive.py', import.meta.url));
const hash = value => createHash('sha256').update(JSON.stringify(value)).digest('hex');
@@ -923,6 +924,7 @@ export function _createInitializedCheckoutRecovery(deps = {}) {
let count = 0;
for await (const entry of entries) {
if (++count > 1000) return { ok: false, reason: 'retirement-discovery-budget-exceeded', transactions: [] };
+ if (entry.name === SPOTLIGHT_MARKER && entry.isFile()) continue;
if (!/^[a-f0-9-]{36}$/.test(entry.name)) {
rows.push({ transactionId: null, reason: 'retirement-journal-name-invalid' });
continue;