Félix Malfait
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
221004fdfc0d97b7d152a258b347bf571e70f10e. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
71 lines
2.6 KiB
TypeScript
71 lines
2.6 KiB
TypeScript
import { type MessageDescriptor } from '@lingui/core';
|
|
import { msg } from '@lingui/core/macro';
|
|
import { assertUnreachable } from 'twenty-shared/utils';
|
|
|
|
import { CustomException } from 'src/utils/custom-exception';
|
|
|
|
export class ViewException extends CustomException<ViewExceptionCode> {
|
|
constructor(
|
|
message: string,
|
|
code: ViewExceptionCode,
|
|
{ userFriendlyMessage }: { userFriendlyMessage?: MessageDescriptor } = {},
|
|
) {
|
|
super(message, code, {
|
|
userFriendlyMessage: userFriendlyMessage ?? msg`A view error occurred.`,
|
|
});
|
|
}
|
|
}
|
|
|
|
export enum ViewExceptionCode {
|
|
VIEW_NOT_FOUND = 'VIEW_NOT_FOUND',
|
|
INVALID_VIEW_DATA = 'INVALID_VIEW_DATA',
|
|
VIEW_CREATE_PERMISSION_DENIED = 'VIEW_CREATE_PERMISSION_DENIED',
|
|
VIEW_MODIFY_PERMISSION_DENIED = 'VIEW_MODIFY_PERMISSION_DENIED',
|
|
}
|
|
|
|
export enum ViewExceptionMessageKey {
|
|
WORKSPACE_ID_REQUIRED = 'WORKSPACE_ID_REQUIRED',
|
|
OBJECT_METADATA_ID_REQUIRED = 'OBJECT_METADATA_ID_REQUIRED',
|
|
VIEW_NOT_FOUND = 'VIEW_NOT_FOUND',
|
|
INVALID_VIEW_DATA = 'INVALID_VIEW_DATA',
|
|
VIEW_CREATE_PERMISSION_DENIED = 'VIEW_CREATE_PERMISSION_DENIED',
|
|
VIEW_MODIFY_PERMISSION_DENIED = 'VIEW_MODIFY_PERMISSION_DENIED',
|
|
}
|
|
|
|
export const generateViewExceptionMessage = (
|
|
key: ViewExceptionMessageKey,
|
|
id?: string,
|
|
) => {
|
|
switch (key) {
|
|
case ViewExceptionMessageKey.WORKSPACE_ID_REQUIRED:
|
|
return 'WorkspaceId is required';
|
|
case ViewExceptionMessageKey.OBJECT_METADATA_ID_REQUIRED:
|
|
return 'ObjectMetadataId is required';
|
|
case ViewExceptionMessageKey.VIEW_NOT_FOUND:
|
|
return `View${id ? ` (id: ${id})` : ''} not found`;
|
|
case ViewExceptionMessageKey.INVALID_VIEW_DATA:
|
|
return `Invalid view data${id ? ` for view id: ${id}` : ''}`;
|
|
case ViewExceptionMessageKey.VIEW_CREATE_PERMISSION_DENIED:
|
|
return 'You do not have permission to create workspace-level views';
|
|
case ViewExceptionMessageKey.VIEW_MODIFY_PERMISSION_DENIED:
|
|
return 'You do not have permission to modify this view';
|
|
default:
|
|
assertUnreachable(key);
|
|
}
|
|
};
|
|
|
|
export const generateViewUserFriendlyExceptionMessage = (
|
|
key: ViewExceptionMessageKey,
|
|
): MessageDescriptor | undefined => {
|
|
switch (key) {
|
|
case ViewExceptionMessageKey.WORKSPACE_ID_REQUIRED:
|
|
return msg`WorkspaceId is required to create a view.`;
|
|
case ViewExceptionMessageKey.OBJECT_METADATA_ID_REQUIRED:
|
|
return msg`ObjectMetadataId is required to create a view.`;
|
|
case ViewExceptionMessageKey.VIEW_CREATE_PERMISSION_DENIED:
|
|
return msg`You don't have permission to create workspace-level views.`;
|
|
case ViewExceptionMessageKey.VIEW_MODIFY_PERMISSION_DENIED:
|
|
return msg`You don't have permission to modify this view.`;
|
|
}
|
|
};
|