The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix(sdk): write the CLI config file with owner-only permissions (#26548)
Weiko9fcdec92ffc5
diff --git a/packages/twenty-sdk/src/cli/__tests__/constants/setupTest.ts b/packages/twenty-sdk/src/cli/__tests__/constants/setupTest.tsindex 105e4d75945..2e3baf60c97 100644--- a/packages/twenty-sdk/src/cli/__tests__/constants/setupTest.ts+++ b/packages/twenty-sdk/src/cli/__tests__/constants/setupTest.ts@@ -1,8 +1,6 @@-import { writeFile } from 'node:fs/promises';-import * as path from 'path';import { beforeAll } from 'vitest';-import { ensureDir } from '@/cli/utilities/file/fs-utils';+import { writePrivateFile } from '@/cli/utilities/file/fs-utils';import { getConfigPath } from '@/cli/utilities/config/get-config-path';const testConfigPath = getConfigPath(true);@@ -28,9 +26,7 @@ beforeAll(async () => {);}- await ensureDir(path.dirname(testConfigPath));-- await writeFile(+ await writePrivateFile(testConfigPath,JSON.stringify({diff --git a/packages/twenty-sdk/src/cli/utilities/config/config-service.ts b/packages/twenty-sdk/src/cli/utilities/config/config-service.tsindex ffab59207ce..c493333f551 100644--- a/packages/twenty-sdk/src/cli/utilities/config/config-service.ts+++ b/packages/twenty-sdk/src/cli/utilities/config/config-service.ts@@ -1,7 +1,9 @@-import { readFile, writeFile } from 'node:fs/promises';-import * as path from 'path';+import { readFile } from 'node:fs/promises';-import { ensureDir, ensureFile } from '@/cli/utilities/file/fs-utils';+import {+ ensurePrivateFile,+ writePrivateFile,+} from '@/cli/utilities/file/fs-utils';import { getConfigPath } from '@/cli/utilities/config/get-config-path';@@ -49,7 +51,7 @@ export class ConfigService {}private async readRawConfig(): Promise<PersistedConfig> {- await ensureFile(this.configPath);+ await ensurePrivateFile(this.configPath);const content = await readFile(this.configPath, 'utf8');const raw = JSON.parse(content || '{}');@@ -132,8 +134,7 @@ export class ConfigService {legacyDefault === 'default' ? DEFAULT_REMOTE_NAME : legacyDefault;}- await ensureDir(path.dirname(this.configPath));- await writeFile(this.configPath, JSON.stringify(migrated, null, 2));+ await writePrivateFile(this.configPath, JSON.stringify(migrated, null, 2));return migrated;}@@ -183,8 +184,7 @@ export class ConfigService {raw.remotes[remote] = { ...currentRemote, ...config };- await ensureDir(path.dirname(this.configPath));- await writeFile(this.configPath, JSON.stringify(raw, null, 2));+ await writePrivateFile(this.configPath, JSON.stringify(raw, null, 2));}async clearConfig(): Promise<void> {@@ -199,8 +199,7 @@ export class ConfigService {delete raw.remotes[remote];}- await ensureDir(path.dirname(this.configPath));- await writeFile(this.configPath, JSON.stringify(raw, null, 2));+ await writePrivateFile(this.configPath, JSON.stringify(raw, null, 2));}private getDefaultConfig(): RemoteConfig {@@ -241,7 +240,6 @@ export class ConfigService {raw.defaultRemote = name;- await ensureDir(path.dirname(this.configPath));- await writeFile(this.configPath, JSON.stringify(raw, null, 2));+ await writePrivateFile(this.configPath, JSON.stringify(raw, null, 2));}}diff --git a/packages/twenty-sdk/src/cli/utilities/file/__tests__/fs-utils.test.ts b/packages/twenty-sdk/src/cli/utilities/file/__tests__/fs-utils.test.tsindex 4ed4fd9fb30..a09534a3aed 100644--- a/packages/twenty-sdk/src/cli/utilities/file/__tests__/fs-utils.test.ts+++ b/packages/twenty-sdk/src/cli/utilities/file/__tests__/fs-utils.test.ts@@ -1,4 +1,11 @@-import { mkdtemp, readFile, writeFile, readdir, stat } from 'node:fs/promises';+import {+ chmod,+ mkdtemp,+ readFile,+ writeFile,+ readdir,+ stat,+} from 'node:fs/promises';import { existsSync } from 'node:fs';import { join } from 'node:path';import os from 'node:os';@@ -7,17 +14,22 @@ import {copy,emptyDir,ensureDir,- ensureFile,+ ensurePrivateDir,+ ensurePrivateFile,move,pathExists,pathExistsSync,readJson,remove,writeJson,+ writePrivateFile,} from '@/cli/utilities/file/fs-utils';let tmpDir: string;+const getPermissionMode = async (targetPath: string) =>+ (await stat(targetPath)).mode & 0o777;+beforeEach(async () => {tmpDir = await mkdtemp(join(os.tmpdir(), 'fs-utils-test-'));});@@ -65,25 +77,72 @@ describe('ensureDir', () => {});});-describe('ensureFile', () => {- it('should create the file and parent directories when missing', async () => {- const filePath = join(tmpDir, 'deep', 'nested', 'file.txt');+describe('ensurePrivateDir', () => {+ it('should create the directory accessible only by the owner', async () => {+ const directoryPath = join(tmpDir, 'private');- await ensureFile(filePath);+ await ensurePrivateDir(directoryPath);- expect(existsSync(filePath)).toBe(true);- const content = await readFile(filePath, 'utf-8');- expect(content).toBe('');+ expect(await getPermissionMode(directoryPath)).toBe(0o700);+ });+});++describe('ensurePrivateFile', () => {+ it('should create an empty file accessible only by the owner when missing', async () => {+ const directoryPath = join(tmpDir, 'private');+ const filePath = join(directoryPath, 'config.json');++ await ensurePrivateFile(filePath);++ expect(await readFile(filePath, 'utf-8')).toBe('');+ expect(await getPermissionMode(filePath)).toBe(0o600);+ expect(await getPermissionMode(directoryPath)).toBe(0o700);});it('should not overwrite an existing file', async () => {const filePath = join(tmpDir, 'existing.txt');await writeFile(filePath, 'keep me');- await ensureFile(filePath);+ await ensurePrivateFile(filePath);++ expect(await readFile(filePath, 'utf-8')).toBe('keep me');+ });+});++describe('writePrivateFile', () => {+ it('should create the file accessible only by the owner', async () => {+ const directoryPath = join(tmpDir, 'private');+ const filePath = join(directoryPath, 'config.json');++ await writePrivateFile(filePath, 'secret');++ expect(await readFile(filePath, 'utf-8')).toBe('secret');+ expect(await getPermissionMode(filePath)).toBe(0o600);+ expect(await getPermissionMode(directoryPath)).toBe(0o700);+ });++ it('should tighten an existing world-readable file', async () => {+ const filePath = join(tmpDir, 'config.json');+ await writeFile(filePath, 'old secret');+ await chmod(filePath, 0o644);++ await writePrivateFile(filePath, 'new');++ expect(await readFile(filePath, 'utf-8')).toBe('new');+ expect(await getPermissionMode(filePath)).toBe(0o600);+ });++ it('should fail on a read-only file without changing it', async () => {+ const filePath = join(tmpDir, 'config.json');+ await writeFile(filePath, 'old secret');+ await chmod(filePath, 0o444);++ await expect(writePrivateFile(filePath, 'new')).rejects.toMatchObject({+ code: 'EACCES',+ });- const content = await readFile(filePath, 'utf-8');- expect(content).toBe('keep me');+ expect(await readFile(filePath, 'utf-8')).toBe('old secret');+ expect(await getPermissionMode(filePath)).toBe(0o444);});});diff --git a/packages/twenty-sdk/src/cli/utilities/file/fs-utils.ts b/packages/twenty-sdk/src/cli/utilities/file/fs-utils.tsindex 9e8f99d4208..9814ab1cd3c 100644--- a/packages/twenty-sdk/src/cli/utilities/file/fs-utils.ts+++ b/packages/twenty-sdk/src/cli/utilities/file/fs-utils.ts@@ -5,6 +5,7 @@ import {access,cp,mkdir,+ open,readFile,readdir,rename as fsRename,@@ -14,6 +15,10 @@ import {import { existsSync } from 'node:fs';import { dirname, join } from 'node:path';+const PRIVATE_DIRECTORY_MODE = 0o700;++const PRIVATE_FILE_MODE = 0o600;+export const pathExists = async (filePath: string): Promise<boolean> => {try {await access(filePath);@@ -29,13 +34,32 @@ export const pathExistsSync = (filePath: string): boolean =>export const ensureDir = (dirPath: string) =>mkdir(dirPath, { recursive: true });-export const ensureFile = async (filePath: string): Promise<void> => {- await mkdir(dirname(filePath), { recursive: true });+export const ensurePrivateDir = (dirPath: string) =>+ mkdir(dirPath, { recursive: true, mode: PRIVATE_DIRECTORY_MODE });++export const ensurePrivateFile = async (filePath: string): Promise<void> => {+ await ensurePrivateDir(dirname(filePath));try {await access(filePath);} catch {- await writeFile(filePath, '');+ await writeFile(filePath, '', { mode: PRIVATE_FILE_MODE });+ }+};++export const writePrivateFile = async (+ filePath: string,+ content: string,+): Promise<void> => {+ await ensurePrivateDir(dirname(filePath));++ const fileHandle = await open(filePath, 'w', PRIVATE_FILE_MODE);++ try {+ await fileHandle.chmod(PRIVATE_FILE_MODE).catch(() => undefined);+ await fileHandle.writeFile(content);+ } finally {+ await fileHandle.close();}};diff --git a/packages/twenty-sdk/src/cli/utilities/version/get-published-server-versions.ts b/packages/twenty-sdk/src/cli/utilities/version/get-published-server-versions.tsindex 1e574c0adf5..5fd61ce0884 100644--- a/packages/twenty-sdk/src/cli/utilities/version/get-published-server-versions.ts+++ b/packages/twenty-sdk/src/cli/utilities/version/get-published-server-versions.ts@@ -2,7 +2,7 @@ import { readFile, writeFile } from 'node:fs/promises';import * as os from 'os';import * as path from 'path';-import { ensureDir } from '@/cli/utilities/file/fs-utils';+import { ensurePrivateDir } from '@/cli/utilities/file/fs-utils';import { compareSemver } from '@/cli/utilities/version/compare-semver';import { parseSemver } from '@/cli/utilities/version/parse-semver';import { type PublishedServerVersion } from '@/cli/utilities/version/published-server-version';@@ -51,7 +51,7 @@ const writeCache = async (versions: PublishedServerVersion[],): Promise<void> => {try {- await ensureDir(path.dirname(CACHE_FILE));+ await ensurePrivateDir(path.dirname(CACHE_FILE));await writeFile(CACHE_FILE,JSON.stringify({