Refactor error classes. #46
Conversation
Introduced a new base class `AppError` to standardize error handling. Updated `FileUtilsError` and `TargetUnitRepositoryError` to derive from `AppError`, simplifying their structure and removing redundant code. Removed tests for deprecated error properties (`cause`), aligning with the new error design.
📝 WalkthroughWalkthroughA new Changes
Sequence Diagram(s)sequenceDiagram
participant Caller
participant AppError
participant FileUtilsError
participant TargetUnitRepositoryError
Caller->>FileUtilsError: new FileUtilsError(message)
FileUtilsError->>AppError: super(message, 'FileUtilsError')
AppError-->>FileUtilsError: instance created
Caller->>TargetUnitRepositoryError: new TargetUnitRepositoryError(message)
TargetUnitRepositoryError->>AppError: super(message, 'TargetUnitRepositoryError')
AppError-->>TargetUnitRepositoryError: instance created
Possibly related PRs
Suggested reviewers
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
workers/main/src/common/errors/AppError.ts (1)
1-9: Well-implemented base error class with minor documentation suggestion.The
AppErrorimplementation follows TypeScript/Node.js best practices for custom error classes. The conditional stack trace capture is appropriate for V8 environments.Consider adding JSDoc documentation to improve developer experience:
+/** + * Base error class for application-specific errors. + * Provides consistent error naming and stack trace handling. + */ export class AppError extends Error { + /** + * @param message Error message + * @param name Error name/type + */ constructor(message: string, name: string) { super(message); this.name = name; if (Error.captureStackTrace) { Error.captureStackTrace(this, this.constructor); } } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
workers/main/src/common/errors/AppError.ts(1 hunks)workers/main/src/common/errors/FileUtilsError.test.ts(0 hunks)workers/main/src/common/errors/FileUtilsError.ts(1 hunks)workers/main/src/common/errors/TargetUnitRepositoryError.test.ts(0 hunks)workers/main/src/common/errors/TargetUnitRepositoryError.ts(1 hunks)workers/main/src/common/errors/index.ts(1 hunks)
💤 Files with no reviewable changes (2)
- workers/main/src/common/errors/FileUtilsError.test.ts
- workers/main/src/common/errors/TargetUnitRepositoryError.test.ts
🧰 Additional context used
🧬 Code Graph Analysis (2)
workers/main/src/common/errors/TargetUnitRepositoryError.ts (1)
workers/main/src/common/errors/AppError.ts (1)
AppError(1-9)
workers/main/src/common/errors/FileUtilsError.ts (1)
workers/main/src/common/errors/AppError.ts (1)
AppError(1-9)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: Docker Security Scanning (n8n, Dockerfile.n8n, n8n-test:latest)
- GitHub Check: Docker Security Scanning (temporal, Dockerfile.temporal, temporal-test:latest)
- GitHub Check: Service Availability Check
- GitHub Check: SonarQube
- GitHub Check: Analyze (actions)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
workers/main/src/common/errors/index.ts (1)
1-1: LGTM! Clean barrel export addition.The addition of
AppErrorexport follows the established pattern and maintains good organization with the base class exported first.workers/main/src/common/errors/TargetUnitRepositoryError.ts (1)
1-7: Excellent refactoring that achieves the PR objectives.The refactoring successfully:
- Extends
AppErrorinstead ofErrordirectly- Simplifies the constructor by removing the
causeparameter- Delegates error name setting and stack trace handling to the base class
- Maintains clear, readable code structure
The hardcoded error name
'TargetUnitRepositoryError'correctly matches the class name for consistency.workers/main/src/common/errors/FileUtilsError.ts (1)
1-7: Consistent and well-executed refactoring.The refactoring mirrors the pattern used in
TargetUnitRepositoryError.ts, demonstrating excellent consistency across the codebase. The simplified constructor and delegation toAppErrorachieves the standardization goals outlined in the PR objectives.
🔍 Vulnerabilities of
|
| digest | sha256:da30eca7154c7c4cb2616e31f7411021ea9146d5b15c68adf2a57df4c52b164c |
| vulnerabilities |     |
| platform | linux/amd64 |
| size | 218 MB |
| packages | 358 |
📦 Base Image alpine:3
| also known as |
|
| digest | sha256:1c4eef651f65e2f7daee7ee785882ac164b02b78fb74503052a26dc061c90474 |
| vulnerabilities |   |
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description |
Introduced a new base class
AppErrorto standardize error handling. UpdatedFileUtilsErrorandTargetUnitRepositoryErrorto derive fromAppError, simplifying their structure and removing redundant code. Removed tests for deprecated error properties (cause), aligning with the new error design.