Félix MalfaitandGitHub
04c596817a
## Summary
This PR enforces that all custom exceptions must provide a
`userFriendlyMessage`, ensuring end users always see readable error
messages.
## Changes
### Core Changes
- **`CustomException` simplified**: Removed the `ForceFriendlyMessage`
generic parameter - `userFriendlyMessage` is now always required
- **Type safety**: The constructor now requires `{ userFriendlyMessage:
MessageDescriptor }` (no longer optional)
### Updated Files
- **74+ exception classes** updated to provide default user-friendly
messages using Lingui `msg` macro
- Each exception class has a sensible fallback message (e.g., `msg\`An
authentication error occurred.\``)
- Exception classes that had code-specific message maps retain their
behavior
## Benefits
- **Compile-time enforcement**: Forgetting to add a user-friendly
message now causes a TypeScript error
- **Better UX**: End users always see a localized, human-readable error
message
- **Simpler API**: No more boolean generic parameter to think about
## Testing
- `npx nx run twenty-server:typecheck` passes
- `npx nx run twenty-server:lint` passes
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Enforces `userFriendlyMessage` on `CustomException` and updates all
exception classes to supply localized default messages, with
filters/tests adjusted accordingly.
>
> - **Core**:
> - Enforce required `userFriendlyMessage` in `CustomException` (remove
optional generic; constructor now requires `{ userFriendlyMessage:
MessageDescriptor }`).
> - **Exceptions**:
> - Update ~70+ exception classes to set default localized messages via
Lingui `msg` maps and pass them in constructors (e.g., `AuthException`,
`ObjectMetadataException`, `FieldMetadataException`, etc.).
> - Add fallback messages where needed (e.g., `INTERNAL_SERVER_ERROR` or
domain-specific defaults).
> - **HTTP/GraphQL Filters**:
> - Ensure fallbacks create `UnknownException` with `msg` for
user-friendly text in REST/GraphQL exception filters.
> - **Tests**:
> - Adjust unit tests to pass `userFriendlyMessage` to exceptions.
> - Update Jest snapshots to include `extensions.userFriendlyMessage` or
message objects where applicable.
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
221004fdfc. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
42 lines
1.1 KiB
TypeScript
42 lines
1.1 KiB
TypeScript
import { type MessageDescriptor } from '@lingui/core';
|
|
import { CustomError } from 'twenty-shared/utils';
|
|
|
|
const CommonExceptionCode = {
|
|
INTERNAL_SERVER_ERROR: 'INTERNAL_SERVER_ERROR',
|
|
} as const;
|
|
|
|
export const appendCommonExceptionCode = <
|
|
SpecificExceptionCode = Record<string, string>,
|
|
>(
|
|
specificExceptionCode: SpecificExceptionCode,
|
|
) => {
|
|
return {
|
|
...CommonExceptionCode,
|
|
...specificExceptionCode,
|
|
} as const;
|
|
};
|
|
|
|
export abstract class CustomException<
|
|
ExceptionCode extends string = string,
|
|
ExceptionMessage extends string = string,
|
|
> extends CustomError {
|
|
code: ExceptionCode;
|
|
userFriendlyMessage: MessageDescriptor;
|
|
|
|
constructor(
|
|
message: ExceptionMessage,
|
|
code: ExceptionCode,
|
|
{ userFriendlyMessage }: { userFriendlyMessage: MessageDescriptor },
|
|
) {
|
|
super(message);
|
|
this.code = code;
|
|
this.userFriendlyMessage = userFriendlyMessage;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Exception class for test scenarios and edge cases.
|
|
* Prefer domain-specific exceptions in production code.
|
|
*/
|
|
export class UnknownException extends CustomException {}
|