The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Preserve validation codes and friendly messages in CLI failures (#28816)
Paul Rastoine3cb93ccd0b0
diff --git a/packages/twenty-cli/src/commands/app/__tests__/app-plan.spec.ts b/packages/twenty-cli/src/commands/app/__tests__/app-plan.spec.tsindex 6bae8ededdb..00da59fb77e 100644--- a/packages/twenty-cli/src/commands/app/__tests__/app-plan.spec.ts+++ b/packages/twenty-cli/src/commands/app/__tests__/app-plan.spec.ts@@ -459,6 +459,83 @@ describe('app plan', () => {expect(stdout + stderr).not.toContain('SECRET_PARTIAL');});+ it('lists each metadata validation error', async () => {+ const backslashError = {+ code: 'INVALID_LOGIC_FUNCTION_INPUT',+ message: 'Resource path must not contain backslashes',+ userFriendlyMessage: 'Source path is invalid',+ };++ state.response = {+ data: null,+ errors: [+ {+ message:+ 'Validation errors occurred while syncing application manifest metadata',+ extensions: {+ code: 'METADATA_VALIDATION_FAILED',+ errors: {+ logicFunction: [+ {+ status: 'fail',+ type: 'create',+ metadataName: 'logicFunction',+ flatEntityMinimalInformation: {+ universalIdentifier: 'logic-function-id',+ },+ errors: [backslashError],+ },+ ],+ frontComponent: [+ {+ status: 'fail',+ type: 'create',+ metadataName: 'frontComponent',+ flatEntityMinimalInformation: {+ universalIdentifier: 'front-component-id',+ name: 'Camperstop',+ },+ errors: [backslashError],+ },+ ],+ },+ },+ },+ ],+ };++ const { stderr, exitCode } = await run();++ expect(exitCode).toBe(1);+ expect(stderr).toContain(+ '• logicFunction logic-function-id: Source path is invalid (Resource path must not contain backslashes)',+ );+ expect(stderr).toContain(+ '• frontComponent Camperstop: Source path is invalid (Resource path must not contain backslashes)',+ );++ expect(stderr.match(/Source path is invalid/g)).toHaveLength(2);++ const { envelope } = await runJson();++ expect(envelope.error.details.validationErrors).toEqual([+ {+ metadataName: 'logicFunction',+ entityLabel: 'logic-function-id',+ code: 'INVALID_LOGIC_FUNCTION_INPUT',+ userFriendlyMessage: 'Source path is invalid',+ message: 'Resource path must not contain backslashes',+ },+ {+ metadataName: 'frontComponent',+ entityLabel: 'Camperstop',+ code: 'INVALID_LOGIC_FUNCTION_INPUT',+ userFriendlyMessage: 'Source path is invalid',+ message: 'Resource path must not contain backslashes',+ },+ ]);+ });+it('does not interpret an endpoint 404 as a missing app registration', async () => {state.status = 404;state.response = { message: 'Endpoint missing' };diff --git a/packages/twenty-cli/src/output/__tests__/create-output.spec.ts b/packages/twenty-cli/src/output/__tests__/create-output.spec.tsindex a1e48e5bcbd..d83db890834 100644--- a/packages/twenty-cli/src/output/__tests__/create-output.spec.ts+++ b/packages/twenty-cli/src/output/__tests__/create-output.spec.ts@@ -254,6 +254,32 @@ describe('terminal progress', () => {);});+ it.each(['Same message', '', null, 42])(+ 'does not repeat or format an unusable friendly message %j',+ (userFriendlyMessage) => {+ const output = createOutput({ mode: 'human', command: 'app apply' });++ output.fail(+ new CliError({+ code: 'GRAPHQL_ERROR',+ message: 'Validation failed',+ details: {+ validationErrors: [+ {+ metadataName: 'fieldMetadata',+ message: 'Same message',+ userFriendlyMessage,+ },+ ],+ },+ }),+ );++ expect(stderr).toContain('• fieldMetadata: Same message\n');+ expect(stderr.match(/Same message/g)).toHaveLength(1);+ },+ );+it('includes the validation details in the JSON error envelope', () => {const output = createOutput({ mode: 'json', command: 'app apply' });diff --git a/packages/twenty-cli/src/output/format-validation-error-lines.ts b/packages/twenty-cli/src/output/format-validation-error-lines.tsindex f07d437d43b..bcdb96fe3f7 100644--- a/packages/twenty-cli/src/output/format-validation-error-lines.ts+++ b/packages/twenty-cli/src/output/format-validation-error-lines.ts@@ -1,3 +1,4 @@+import { isNonEmptyString } from '@sniptt/guards';import { isDefined } from 'twenty-shared/utils';import { type ValidationErrorDetail } from '@/output/types/validation-error-detail.type';@@ -6,8 +7,12 @@ export const formatValidationErrorLines = (details: ValidationErrorDetail[],): string =>details- .map(- ({ metadataName, entityLabel, message }) =>- `• ${metadataName}${isDefined(entityLabel) ? ` ${entityLabel}` : ''}: ${message}`,- )+ .map(({ metadataName, entityLabel, message, userFriendlyMessage }) => {+ const description =+ isNonEmptyString(userFriendlyMessage) && userFriendlyMessage !== message+ ? `${userFriendlyMessage} (${message})`+ : message;++ return `• ${metadataName}${isDefined(entityLabel) ? ` ${entityLabel}` : ''}: ${description}`;+ }).join('\n');diff --git a/packages/twenty-cli/src/output/types/validation-error-detail.type.ts b/packages/twenty-cli/src/output/types/validation-error-detail.type.tsindex 0cb51addf23..6f50de611b7 100644--- a/packages/twenty-cli/src/output/types/validation-error-detail.type.ts+++ b/packages/twenty-cli/src/output/types/validation-error-detail.type.ts@@ -1,5 +1,10 @@-export type ValidationErrorDetail = {+import { type FailedMetadataValidationError } from 'twenty-shared/metadata';++export type ValidationErrorDetail = Pick<+ FailedMetadataValidationError,+ 'message' | 'userFriendlyMessage'+> & {metadataName: string;entityLabel?: string;- message: string;+ code?: FailedMetadataValidationError['code'];};diff --git a/packages/twenty-cli/src/transport/graphql/__tests__/create-graphql-error.spec.ts b/packages/twenty-cli/src/transport/graphql/__tests__/create-graphql-error.spec.tsindex c8d12184916..dd7f96e5100 100644--- a/packages/twenty-cli/src/transport/graphql/__tests__/create-graphql-error.spec.ts+++ b/packages/twenty-cli/src/transport/graphql/__tests__/create-graphql-error.spec.ts@@ -51,6 +51,7 @@ describe('createGraphqlError', () => {{metadataName: 'fieldMetadata',entityLabel: 'invalidField',+ code: 'INVALID_NAME',message: 'Field name "123" is invalid',},]);diff --git a/packages/twenty-cli/src/transport/graphql/__tests__/extract-metadata-validation.spec.ts b/packages/twenty-cli/src/transport/graphql/__tests__/extract-metadata-validation.spec.tsindex f74bac741b6..bc8f51a8240 100644--- a/packages/twenty-cli/src/transport/graphql/__tests__/extract-metadata-validation.spec.ts+++ b/packages/twenty-cli/src/transport/graphql/__tests__/extract-metadata-validation.spec.ts@@ -45,11 +45,13 @@ describe('extractMetadataValidation', () => {{metadataName: 'fieldMetadata',entityLabel: 'invalidField',+ code: 'INVALID_NAME',message: 'Field name "123" is invalid',},{metadataName: 'fieldMetadata',entityLabel: 'status',+ code: 'DUPLICATE',message: 'A field with this name already exists',},],@@ -92,6 +94,59 @@ describe('extractMetadataValidation', () => {).toEqual({ errors: [] });});+ it('keeps valid messages when optional diagnostics are malformed', () => {+ const { errors } = extractMetadataValidation([+ {+ extensions: {+ code: 'METADATA_VALIDATION_FAILED',+ errors: {+ fieldMetadata: [+ {+ errors: [+ null,+ { code: 'INVALID', message: 42 },+ { message: 'Missing code' },+ {+ code: 42,+ message: 'Invalid code',+ userFriendlyMessage: {},+ },+ {+ code: 'INVALID_NAME',+ message: 'Invalid characters',+ userFriendlyMessage: 'Name is invalid',+ value: 'private-value',+ },+ ],+ flatEntityMinimalInformation: { name: 'status' },+ },+ ],+ },+ },+ },+ ]);++ expect(errors).toEqual([+ {+ metadataName: 'fieldMetadata',+ entityLabel: 'status',+ message: 'Missing code',+ },+ {+ metadataName: 'fieldMetadata',+ entityLabel: 'status',+ message: 'Invalid code',+ },+ {+ metadataName: 'fieldMetadata',+ entityLabel: 'status',+ code: 'INVALID_NAME',+ message: 'Invalid characters',+ userFriendlyMessage: 'Name is invalid',+ },+ ]);+ });+it('ignores a breakdown without the validation-failed code', () => {expect(extractMetadataValidation([diff --git a/packages/twenty-cli/src/transport/graphql/extract-metadata-validation.ts b/packages/twenty-cli/src/transport/graphql/extract-metadata-validation.tsindex 97398d7667e..39a83ada957 100644--- a/packages/twenty-cli/src/transport/graphql/extract-metadata-validation.ts+++ b/packages/twenty-cli/src/transport/graphql/extract-metadata-validation.ts@@ -66,6 +66,10 @@ const collectDetails = ({details.push({metadataName,...(isDefined(entityLabel) ? { entityLabel } : {}),+ ...(isString(error.code) ? { code: error.code } : {}),+ ...(isString(error.userFriendlyMessage)+ ? { userFriendlyMessage: error.userFriendlyMessage }+ : {}),message: error.message,});