Skip to content

The open alternative to Salesforce, designed for AI.

Stop pull overwriting a source file that defines no entity (#25739)

Weiko2b545a7cbdb4
diff --git a/packages/twenty-sdk/src/cli/operations/pull.ts b/packages/twenty-sdk/src/cli/operations/pull.ts
index 0d6b2b37da3..4f1980f7479 100644
--- a/packages/twenty-sdk/src/cli/operations/pull.ts
+++ b/packages/twenty-sdk/src/cli/operations/pull.ts
@@ -21,7 +21,7 @@ import {
readPullBaseManifest,
writePullBaseManifest,
} from '@/cli/utilities/pull/pull-base-file';
-import { scanProjectDefineFiles } from '@/cli/utilities/pull/scan-project-define-files';
+import { scanProjectSourceFiles } from '@/cli/utilities/pull/scan-project-source-files';
import { runSafe } from '@/cli/utilities/run-safe';
import { join } from 'node:path';
import { isDefined } from 'twenty-shared/utils';
@@ -109,7 +109,7 @@ const innerAppPull = async (
onProgress?.('Reading local source files...');
- const scannedFiles = await scanProjectDefineFiles(appPath);
+ const scannedFiles = await scanProjectSourceFiles(appPath);
const localApplicationUniversalIdentifier = scannedFiles.find(
(scannedFile) => scannedFile.entityKey === ManifestEntityKey.Application,
)?.universalIdentifier;
diff --git a/packages/twenty-sdk/src/cli/utilities/pull/__tests__/plan-pull-writes.spec.ts b/packages/twenty-sdk/src/cli/utilities/pull/__tests__/plan-pull-writes.spec.ts
index f3eb7d70a85..98e35159b3f 100644
--- a/packages/twenty-sdk/src/cli/utilities/pull/__tests__/plan-pull-writes.spec.ts
+++ b/packages/twenty-sdk/src/cli/utilities/pull/__tests__/plan-pull-writes.spec.ts
@@ -1,6 +1,6 @@
import { ManifestEntityKey } from '@/cli/utilities/build/manifest/manifest-extract-config';
import { planPullWrites } from '@/cli/utilities/pull/plan-pull-writes';
-import { type ScannedDefineFile } from '@/cli/utilities/pull/scan-project-define-files';
+import { type ScannedSourceFile } from '@/cli/utilities/pull/scan-project-source-files';
import {
type Manifest,
type NavigationMenuItemManifest,
@@ -244,7 +244,7 @@ describe('planPullWrites', () => {
});
it('should regenerate the application config in the file that already declares one', () => {
- const scannedFiles: ScannedDefineFile[] = [
+ const scannedFiles: ScannedSourceFile[] = [
{
relativePath: 'src/application-config.ts',
entityKey: ManifestEntityKey.Application,
@@ -267,7 +267,7 @@ describe('planPullWrites', () => {
});
it('should leave a file untouched when its entity has not changed since the base', () => {
- const scannedFiles: ScannedDefineFile[] = [
+ const scannedFiles: ScannedSourceFile[] = [
{
relativePath: 'src/application.config.ts',
entityKey: ManifestEntityKey.Application,
@@ -293,7 +293,7 @@ describe('planPullWrites', () => {
});
it('should rewrite only the entity that changed on the server', () => {
- const scannedFiles: ScannedDefineFile[] = [
+ const scannedFiles: ScannedSourceFile[] = [
{
relativePath: 'src/application.config.ts',
entityKey: ManifestEntityKey.Application,
@@ -329,7 +329,7 @@ describe('planPullWrites', () => {
});
it('should delete the file of an entity the base knew and the workspace no longer has', () => {
- const scannedFiles: ScannedDefineFile[] = [
+ const scannedFiles: ScannedSourceFile[] = [
{
relativePath: 'src/objects/rocket.object.ts',
entityKey: ManifestEntityKey.Objects,
@@ -365,7 +365,7 @@ describe('planPullWrites', () => {
});
it('should report a local entity that neither the workspace nor the base knows', () => {
- const scannedFiles: ScannedDefineFile[] = [
+ const scannedFiles: ScannedSourceFile[] = [
{
relativePath: 'src/objects/unpushed.object.ts',
entityKey: ManifestEntityKey.Objects,
@@ -387,7 +387,7 @@ describe('planPullWrites', () => {
});
it('should place a new entity beside existing files of its kind', () => {
- const scannedFiles: ScannedDefineFile[] = [
+ const scannedFiles: ScannedSourceFile[] = [
{
relativePath: 'app/data-model/rocket.object.ts',
entityKey: ManifestEntityKey.Objects,
@@ -747,7 +747,7 @@ describe('planPullWrites', () => {
});
it('should leave an unchanged view untouched and regenerate the view whose filter changed on the server', () => {
- const scannedFiles: ScannedDefineFile[] = [
+ const scannedFiles: ScannedSourceFile[] = [
{
relativePath: 'src/application.config.ts',
entityKey: ManifestEntityKey.Application,
@@ -951,7 +951,7 @@ describe('planPullWrites', () => {
});
it('should leave an unchanged page layout untouched and regenerate the page layout whose widget changed on the server', () => {
- const scannedFiles: ScannedDefineFile[] = [
+ const scannedFiles: ScannedSourceFile[] = [
{
relativePath: 'src/application.config.ts',
entityKey: ManifestEntityKey.Application,
@@ -1134,7 +1134,7 @@ describe('planPullWrites', () => {
});
it('should leave an unchanged navigation menu item untouched and regenerate the item whose link changed on the server', () => {
- const scannedFiles: ScannedDefineFile[] = [
+ const scannedFiles: ScannedSourceFile[] = [
{
relativePath: 'src/application.config.ts',
entityKey: ManifestEntityKey.Application,
diff --git a/packages/twenty-sdk/src/cli/utilities/pull/__tests__/scan-project-source-files.spec.ts b/packages/twenty-sdk/src/cli/utilities/pull/__tests__/scan-project-source-files.spec.ts
new file mode 100644
index 00000000000..52ff91b9247
--- /dev/null
+++ b/packages/twenty-sdk/src/cli/utilities/pull/__tests__/scan-project-source-files.spec.ts
@@ -0,0 +1,36 @@
+import { mkdtemp, mkdir, writeFile, rm } from 'node:fs/promises';
+import { join } from 'node:path';
+import { tmpdir } from 'node:os';
+
+import { scanProjectSourceFiles } from '@/cli/utilities/pull/scan-project-source-files';
+
+describe('scanProjectSourceFiles', () => {
+ let appPath: string;
+
+ beforeEach(async () => {
+ appPath = await mkdtemp(join(tmpdir(), 'scan-project-source-files-'));
+ await mkdir(join(appPath, 'src', 'objects'), { recursive: true });
+ });
+
+ afterEach(async () => {
+ await rm(appPath, { recursive: true, force: true });
+ });
+
+ it('should return a source file that defines no entity so its path stays reserved', async () => {
+ await writeFile(
+ join(appPath, 'src', 'objects', 'helpers.ts'),
+ "export const PET_LABEL = 'Pet';\n",
+ );
+
+ const scannedFiles = await scanProjectSourceFiles(appPath);
+
+ expect(scannedFiles).toEqual([
+ {
+ relativePath: join('src', 'objects', 'helpers.ts'),
+ entityKey: null,
+ universalIdentifier: null,
+ isReadable: true,
+ },
+ ]);
+ });
+});
diff --git a/packages/twenty-sdk/src/cli/utilities/pull/plan-pull-writes.ts b/packages/twenty-sdk/src/cli/utilities/pull/plan-pull-writes.ts
index 25981d2917f..f592d7cb785 100644
--- a/packages/twenty-sdk/src/cli/utilities/pull/plan-pull-writes.ts
+++ b/packages/twenty-sdk/src/cli/utilities/pull/plan-pull-writes.ts
@@ -5,7 +5,7 @@ import {
type PullEntityKind,
} from '@/cli/utilities/pull/build-pull-entities';
import { capFileBaseName } from '@/cli/utilities/pull/pull-file-base-name';
-import { type ScannedDefineFile } from '@/cli/utilities/pull/scan-project-define-files';
+import { type ScannedSourceFile } from '@/cli/utilities/pull/scan-project-source-files';
import { writeDefineFile } from '@/cli/utilities/pull/write-define-file';
import { kebabCase } from '@/cli/utilities/string/kebab-case';
import { dirname, posix } from 'node:path';
@@ -55,7 +55,7 @@ const findExistingFolderForKind = ({
scannedFiles,
entityKey,
}: {
- scannedFiles: ScannedDefineFile[];
+ scannedFiles: ScannedSourceFile[];
entityKey: ManifestEntityKey;
}): string | null => {
const folderCounts = new Map<string, number>();
@@ -169,7 +169,7 @@ const findExistingPath = ({
pathByUniversalIdentifier,
}: {
entity: PullEntity;
- applicationFile: ScannedDefineFile | undefined;
+ applicationFile: ScannedSourceFile | undefined;
pathByUniversalIdentifier: Map<string, string>;
}): string | undefined => {
if (entity.kind !== 'application') {
@@ -203,7 +203,7 @@ export const planPullWrites = ({
}: {
manifest: Manifest;
baseManifest: Manifest | null;
- scannedFiles: ScannedDefineFile[];
+ scannedFiles: ScannedSourceFile[];
}): PullWritePlan & {
skipped: ReturnType<typeof buildPullEntities>['skipped'];
} => {
diff --git a/packages/twenty-sdk/src/cli/utilities/pull/scan-project-define-files.ts b/packages/twenty-sdk/src/cli/utilities/pull/scan-project-source-files.ts
similarity index 86%
rename from packages/twenty-sdk/src/cli/utilities/pull/scan-project-define-files.ts
rename to packages/twenty-sdk/src/cli/utilities/pull/scan-project-source-files.ts
index de681947922..1facacf7fba 100644
--- a/packages/twenty-sdk/src/cli/utilities/pull/scan-project-define-files.ts
+++ b/packages/twenty-sdk/src/cli/utilities/pull/scan-project-source-files.ts
@@ -9,7 +9,7 @@ import { readFile } from 'node:fs/promises';
import { relative } from 'node:path';
import { isDefined } from 'twenty-shared/utils';
-export type ScannedDefineFile = {
+export type ScannedSourceFile = {
relativePath: string;
entityKey: ManifestEntityKey | null;
universalIdentifier: string | null;
@@ -20,9 +20,9 @@ type ExtractedConfig = {
universalIdentifier?: unknown;
};
-export const scanProjectDefineFiles = async (
+export const scanProjectSourceFiles = async (
appPath: string,
-): Promise<ScannedDefineFile[]> => {
+): Promise<ScannedSourceFile[]> => {
const filePaths = await glob(['**/*.ts', '**/*.tsx'], {
cwd: appPath,
absolute: true,
@@ -30,7 +30,7 @@ export const scanProjectDefineFiles = async (
onlyFiles: true,
});
- const scannedFiles: ScannedDefineFile[] = [];
+ const scannedFiles: ScannedSourceFile[] = [];
for (const filePath of filePaths) {
const relativePath = relative(appPath, filePath);
@@ -52,6 +52,12 @@ export const scanProjectDefineFiles = async (
const targetFunctionName = extractDefineEntity(fileContent);
if (!isDefined(targetFunctionName)) {
+ scannedFiles.push({
+ relativePath,
+ entityKey: null,
+ universalIdentifier: null,
+ isReadable: true,
+ });
continue;
}