Better errors handling #8835
Merged
Better errors handling #8835
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
guillim
added
-PR: wip
scope: backend
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR improves error handling across the server, particularly focusing on environment variable configuration issues and error tracking.
- Introduced new
EnvironmentExceptionto properly handle missing environment variables instead of generic auth errors - Added workspace context (id, displayName, activationStatus) to error tracking for better debugging in Sentry
- Simplified exception handler interface by removing
captureMessagemethod to focus on exception capture - Updated cron jobs to use workspace-based error reporting instead of user-based format
- Improved schema version validation to prevent client-server mismatches in GraphQL requests
26 file(s) reviewed, 6 comment(s)
Edit PR Review Bot Settings | Greptile
Comment on lines
16
to
22
| canActivate(): boolean | Promise<boolean> | Observable<boolean> { | ||
| if (!this.environmentService.get('AUTH_GOOGLE_ENABLED')) { | ||
| throw new AuthException( | ||
| throw new EnvironmentException( | ||
| 'Google auth is not enabled', | ||
| AuthExceptionCode.FORBIDDEN_EXCEPTION, | ||
| EnvironmentExceptionCode.ENVIRONMENT_VARIABLES_NOT_FOUND, | ||
| ); | ||
| } |
There was a problem hiding this comment.
style: consider adding workspace info to error context for better debugging, as mentioned in PR requirements
Comment on lines
17
to
23
| canActivate(): boolean | Promise<boolean> | Observable<boolean> { | ||
| if (!this.environmentService.get('ENTERPRISE_KEY')) { | ||
| throw new AuthException( | ||
| throw new EnvironmentException( | ||
| 'Enterprise key must be defined to use SSO', | ||
| AuthExceptionCode.FORBIDDEN_EXCEPTION, | ||
| EnvironmentExceptionCode.ENVIRONMENT_VARIABLES_NOT_FOUND, | ||
| ); | ||
| } |
There was a problem hiding this comment.
style: Consider adding a check for AUTH_SSO_ENABLED in addition to ENTERPRISE_KEY to maintain consistency with other provider guards
| import { CustomException } from 'src/utils/custom-exception'; | ||
|
|
||
| export class EnvironmentException extends CustomException { | ||
| code: EnvironmentExceptionCode; |
There was a problem hiding this comment.
style: code property should be readonly since it's only set in constructor
Weiko
reviewed
Dec 2, 2024
...es/twenty-server/src/engine/core-modules/auth/guards/google-apis-oauth-request-code.guard.ts
Outdated
Show resolved
Hide resolved
...r/src/engine/core-modules/exception-handler/interfaces/exception-handler-driver.interface.ts
Show resolved
Hide resolved
Weiko
approved these changes
Dec 2, 2024
Weiko
reviewed
Dec 2, 2024
...erver/src/engine/core-modules/auth/guards/google-apis-oauth-exchange-code-for-token.guard.ts
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/auth/token/services/access-token.service.ts
Show resolved
Hide resolved
|
Thanks @guillim for your contribution! |
|
follow up on #8845 |
mdrazak2001
pushed a commit
to mdrazak2001/twenty
that referenced
this pull request
Dec 4, 2024
- [ ] Catch this specific `500` error - [ ] Make sure catched `500` errors are sent to sentry for the Cloud version - [ ] Hide the option to sync email with google in this situation where the according env var is missing - [x] Add Worskpace information to all catched errors for better debugging fix twentyhq#8607
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
500error500errors are sent to sentry for the Cloud versionfix #8607