-
Notifications
You must be signed in to change notification settings - Fork 7.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(core): Reorganize error hierarchy in core
and workflow
packages (no-changelog)
#7820
Merged
ivov
merged 7 commits into
master
from
reorganize-error-hierarchy-in-core-and-workflow-packages
Nov 27, 2023
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
7749b85
refactor(core): Reorganize error hierarchy in `core` and `workflow` p…
ivov cb1e9f7
Merge master
ivov 9bd387d
Fix import in test
ivov 4901026
Fix more imports in tests
ivov 6d968af
Rename `WebhookTakenError` to `WebhookPathTakenError`
ivov af5cf48
Rename `InvalidExecutionMetadata` to `InvalidExecutionMetadataError`
ivov ff574e1
Add tech debt comment to `ExecutionBaseError.cause`
ivov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
This file was deleted.
Oops, something went wrong.
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
import { ApplicationError } from 'n8n-workflow'; | ||
|
||
export abstract class BinaryDataError extends ApplicationError {} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import { ApplicationError } from 'n8n-workflow'; | ||
|
||
export abstract class FileSystemError extends ApplicationError { | ||
constructor(message: string, filePath: string) { | ||
super(message, { extra: { filePath } }); | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import { FileSystemError } from './abstract/filesystem.error'; | ||
|
||
export class DisallowedFilepathError extends FileSystemError { | ||
constructor(filePath: string) { | ||
super('Disallowed path detected', filePath); | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import { FileSystemError } from './abstract/filesystem.error'; | ||
|
||
export class FileNotFoundError extends FileSystemError { | ||
constructor(filePath: string) { | ||
super('File not found', filePath); | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,5 @@ | ||
export { BinaryFileNotFoundError, FileNotFoundError, InvalidPathError } from './filesystem.errors'; | ||
export { FileNotFoundError } from './file-not-found.error'; | ||
export { DisallowedFilepathError } from './disallowed-filepath.error'; | ||
export { InvalidModeError } from './invalid-mode.error'; | ||
export { InvalidManagerError } from './invalid-manager.error'; | ||
export { InvalidExecutionMetadataError } from './invalid-execution-metadata.error'; |
13 changes: 13 additions & 0 deletions
13
packages/core/src/errors/invalid-execution-metadata.error.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
import { ApplicationError } from 'n8n-workflow'; | ||
|
||
export class InvalidExecutionMetadataError extends ApplicationError { | ||
constructor( | ||
public type: 'key' | 'value', | ||
key: unknown, | ||
message?: string, | ||
options?: ErrorOptions, | ||
) { | ||
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions | ||
super(message ?? `Custom data ${type}s must be a string (key "${key}")`, options); | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import { BinaryDataError } from './abstract/binary-data.error'; | ||
|
||
export class InvalidManagerError extends BinaryDataError { | ||
constructor(mode: string) { | ||
super(`No binary data manager found for: ${mode}`); | ||
} | ||
} |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since
ExecutionBaseError
now extendsApplicationError
, these checks could be unified, and we can most likely remove theExecutionBaseError
import all together here.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean unifying like
if (level === 'warning' || severity === 'warning') return null;
?If so,
severity
is present inExecutionBaseError
but absent inApplicationError
, so we'd still need to check fororiginalException instanceof ExecutionBaseError
, meaning the check is moved but not unified. Might be best to clean this up once we do away withseverity
altogether?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can do this in another PR.