The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
import { type CombinedGraphQLErrors } from '@apollo/client/errors';
import { getToastOptionsFromError } from '@/error-handler/utils/getToastOptionsFromError';
import { classifyMetadataError } from '@/metadata-error-handler/utils/classifyMetadataError';
import {
type AllMetadataName,
WorkspaceMigrationV2ExceptionCode,
} from 'twenty-shared/metadata';
import { CrudOperationType } from 'twenty-shared/types';
import { useToast } from 'twenty-ui/components/feedback';
import { useLingui } from '@lingui/react/macro';
export const useMetadataErrorHandler = () => {
const { t } = useLingui();
const { enqueueToast } = useToast();
const TRANSLATED_OPERATION_TYPE = {
[CrudOperationType.CREATE]: t`create`,
[CrudOperationType.UPDATE]: t`update`,
[CrudOperationType.DELETE]: t`delete`,
[CrudOperationType.RESTORE]: t`restore`,
[CrudOperationType.DESTROY]: t`destroy`,
} as const satisfies Record<CrudOperationType, string>;
const TRANSLATED_METADATA_NAME = {
objectMetadata: t`object`,
fieldMetadata: t`field`,
view: t`view`,
viewField: t`view field`,
viewFieldGroup: t`view field group`,
viewGroup: t`view group`,
viewFilter: t`view filter`,
index: t`index`,
logicFunction: t`logic function`,
rolePermissionFlag: t`role permission flag`,
permissionFlag: t`permission flag`,
objectPermission: t`object permission`,
fieldPermission: t`field permission`,
role: t`role`,
roleTarget: t`role target`,
agent: t`agent`,
skill: t`skill`,
pageLayout: t`page layout`,
pageLayoutTab: t`page layout tab`,
pageLayoutWidget: t`page layout widget`,
rowLevelPermissionPredicate: t`row level permission predicate`,
rowLevelPermissionPredicateGroup: t`row level permission predicate group`,
viewFilterGroup: t`view filter group`,
commandMenuItem: t`command menu item`,
frontComponent: t`front component`,
navigationMenuItem: t`navigation menu item`,
webhook: t`webhook`,
mcpServer: t`MCP server`,
viewSort: t`view sort`,
applicationVariable: t`application variable`,
connectionProvider: t`connection provider`,
messagingProvider: t`messaging provider`,
searchFieldMetadata: t`search field metadata`,
timelineActivityType: t`timeline activity type`,
settingsMenuItem: t`settings menu item`,
relatedRecordPath: t`related record path`,
validationRule: t`validation rule`,
workflow: t`workflow`,
workflowVersion: t`workflow version`,
agentChatChannel: t`channel`,
agentChatChannelRole: t`channel role`,
} as const satisfies Record<AllMetadataName, string>;
const handleMetadataError = (
error: CombinedGraphQLErrors,
options: {
primaryMetadataName: AllMetadataName;
operationType: CrudOperationType;
},
) => {
const classification = classifyMetadataError({
error,
primaryMetadataName: options.primaryMetadataName,
});
const translatedMetadataName =
TRANSLATED_METADATA_NAME[options.primaryMetadataName];
switch (classification.type) {
case 'v1':
enqueueToast(getToastOptionsFromError({ error: classification.error }));
break;
case 'v2-validation': {
const { extensions, primaryMetadataName, relatedFailingMetadataNames } =
classification;
const targetErrors = extensions.errors[primaryMetadataName] ?? [];
if (targetErrors.length > 0) {
targetErrors.forEach((entityError) => {
entityError.errors.forEach((validationError) =>
enqueueToast({
status: 'error',
children:
validationError.userFriendlyMessage ??
validationError.message,
}),
);
});
}
const translatedOperationType =
TRANSLATED_OPERATION_TYPE[options.operationType];
if (
targetErrors.length === 0 &&
relatedFailingMetadataNames.length > 0
) {
const relatedEntityNames = relatedFailingMetadataNames
.map((metadataName) => TRANSLATED_METADATA_NAME[metadataName])
.join(', ');
enqueueToast({
status: 'error',
children: t`Failed to ${translatedOperationType} ${translatedMetadataName}. Related ${relatedEntityNames} validation failed. Please check your configuration and try again.`,
});
}
if (
targetErrors.length === 0 &&
relatedFailingMetadataNames.length === 0
) {
enqueueToast({
status: 'error',
children: t`Failed to ${translatedOperationType} ${translatedMetadataName}. Please try again.`,
});
}
break;
}
case 'v2-internal': {
const { code } = classification;
const errorMessage =
code ===
WorkspaceMigrationV2ExceptionCode.BUILDER_INTERNAL_SERVER_ERROR
? t`An internal error occurred while validating your changes. Please contact support.`
: t`An internal error occurred while applying your changes. Please contact support and try again later.`;
enqueueToast({ status: 'error', children: errorMessage });
break;
}
}
};
return {
handleMetadataError,
};
};