d998e3b92c
Closes [89](https://github.com/twentyhq/core-team-issues/issues/89) ## Problem When users attempt to create or update a record with a duplicate value for a unique field (e.g., duplicate email or domain name), they receive a generic error message: "This record already exists. Please check your data and try again." This provides no actionable way to locate and view the existing conflicting record, forcing users to manually search for it. ## Solution This PR enhances duplicate key constraint error handling to automatically detect the conflicting record and display a "View existing record" link in the error notification. When clicked, users are navigated directly to the existing record's detail page. ## Backend Changes ### 1. PostgreSQL Error Parsing (`parse-postgres-constraint-error.util.ts`) - Extracts structured information from PostgreSQL `QueryFailedError` messages. ### 2. Conflicting Record Lookup (`find-conflicting-record.util.ts`) - Queries the database to find the existing record with the conflicting value ### 3. Error Handling Orchestration (`handle-duplicate-key-error.util.ts`) - Parses PostgreSQL error to extract column name and conflicting value - Attempts to find the conflicting record - Enriches `TwentyORMException` with `conflictingRecordId` and `conflictingObjectNameSingular` if found ### 4. Exception Computation Updates (`compute-twenty-orm-exception.ts`) - Made function `async` and added optional `entityManager` and `internalContext` parameters - Needed to support async database queries for conflicting record lookup ### 5. GraphQL Error Handler (`twenty-orm-graphql-api-exception-handler.util.ts`) - **Changes**: Enhanced `DUPLICATE_ENTRY_DETECTED` case to include `conflictingRecordId` and `conflictingObjectNameSingular` in GraphQL error extensions ## Frontend Changes ### 1. Error Extraction Utility (`get-conflicting-record-from-apollo-error.util.ts`) - Accesses GraphQL error extensions - Validates that both `conflictingRecordId` and `conflictingObjectNameSingular` exist and are strings - Returns `null` if validation fails ### 2. SnackBar Enhancement (`useSnackBar.ts`) - Extracts conflicting record info from Apollo error - Constructs URL using `getAppPath` utility - Adds link object to snackbar options with text "View existing record" <img width="931" height="858" alt="image" src="https://github.com/user-attachments/assets/28137dc7-18ab-4ffe-b669-1f2d4ec264d1" />
49 lines
1.6 KiB
TypeScript
49 lines
1.6 KiB
TypeScript
import { isDefined } from 'twenty-shared/utils';
|
|
|
|
import { UserInputError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
|
|
import {
|
|
type TwentyORMException,
|
|
TwentyORMExceptionCode,
|
|
} from 'src/engine/twenty-orm/exceptions/twenty-orm.exception';
|
|
|
|
interface DuplicateKeyErrorWithMetadata extends TwentyORMException {
|
|
conflictingRecordId?: string;
|
|
conflictingObjectNameSingular?: string;
|
|
}
|
|
|
|
export const twentyORMGraphqlApiExceptionHandler = (
|
|
error: TwentyORMException,
|
|
) => {
|
|
switch (error.code) {
|
|
case TwentyORMExceptionCode.DUPLICATE_ENTRY_DETECTED: {
|
|
const duplicateKeyError: DuplicateKeyErrorWithMetadata = error;
|
|
|
|
const extensions: Record<string, unknown> = {
|
|
userFriendlyMessage: error.userFriendlyMessage,
|
|
...(isDefined(duplicateKeyError.conflictingRecordId) &&
|
|
isDefined(duplicateKeyError.conflictingObjectNameSingular)
|
|
? {
|
|
conflictingRecordId: duplicateKeyError.conflictingRecordId,
|
|
conflictingObjectNameSingular:
|
|
duplicateKeyError.conflictingObjectNameSingular,
|
|
}
|
|
: {}),
|
|
};
|
|
|
|
throw new UserInputError(error.message, extensions);
|
|
}
|
|
|
|
case TwentyORMExceptionCode.INVALID_INPUT:
|
|
case TwentyORMExceptionCode.CONNECT_RECORD_NOT_FOUND:
|
|
case TwentyORMExceptionCode.CONNECT_NOT_ALLOWED:
|
|
case TwentyORMExceptionCode.CONNECT_UNIQUE_CONSTRAINT_ERROR:
|
|
case TwentyORMExceptionCode.TOO_MANY_RECORDS_TO_UPDATE:
|
|
throw new UserInputError(error.message, {
|
|
userFriendlyMessage: error.userFriendlyMessage,
|
|
});
|
|
default: {
|
|
throw error;
|
|
}
|
|
}
|
|
};
|