-
Notifications
You must be signed in to change notification settings - Fork 4
refactor(javascript): MessageProcessor abstraction added #176
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
Open
Reversean
wants to merge
1
commit into
refactor/breadcrumb-store
Choose a base branch
from
refactor/message-processor
base: refactor/breadcrumb-store
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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 hidden or 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
24 changes: 24 additions & 0 deletions
24
packages/core/src/messages/breadcrumbs-message-processor.ts
This file contains hidden or 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,24 @@ | ||
| import type { MessageHint, MessageProcessor, ProcessingPayload } from './message-processor'; | ||
|
|
||
| /** | ||
| * Attaches breadcrumbs snapshot from {@link hint} to payload. | ||
| */ | ||
| export class BreadcrumbsMessageProcessor implements MessageProcessor<'errors/javascript'> { | ||
| /** | ||
| * Sets `payload.breadcrumbs` from hint snapshot if non-empty; skips otherwise. | ||
| * | ||
| * @param payload - event message payload to enrich | ||
| * @param hint - hint carrying breadcrumbs snapshot captured at error time | ||
| * @returns modified payload with breadcrumbs set, or original payload unchanged | ||
|
Check warning on line 12 in packages/core/src/messages/breadcrumbs-message-processor.ts
|
||
| */ | ||
| public apply( | ||
| payload: ProcessingPayload<'errors/javascript'>, | ||
| hint?: MessageHint | ||
| ): ProcessingPayload<'errors/javascript'> | null { | ||
| if (hint?.breadcrumbs && hint.breadcrumbs.length > 0) { | ||
| payload.breadcrumbs = hint.breadcrumbs; | ||
| } | ||
|
|
||
| return payload; | ||
| } | ||
| } | ||
This file contains hidden or 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,57 @@ | ||
| import type { Breadcrumb, CatcherMessagePayload, CatcherMessageType } from '@hawk.so/types'; | ||
|
|
||
| /** | ||
| * Extracted addons type from catcher message payload. | ||
| * | ||
| * @typeParam T - catcher message type | ||
| */ | ||
| type ExtractAddons<T extends CatcherMessageType> = | ||
| CatcherMessagePayload<T> extends { addons?: infer A } ? A : never; | ||
|
|
||
| /** | ||
| * Payload type used during message processing pipeline. | ||
| * | ||
| * Same as {@link CatcherMessagePayload} but with `addons` always defined and partially filled — | ||
| * processors may contribute individual addon fields independently of each other. | ||
| * | ||
| * @typeParam T - catcher message type this payload belongs to | ||
| */ | ||
| export type ProcessingPayload<T extends CatcherMessageType> = | ||
| Omit<CatcherMessagePayload<T>, 'addons'> & { | ||
| addons: Partial<ExtractAddons<T>>; | ||
| }; | ||
|
|
||
| /** | ||
| * Snapshot of event context captured synchronously at error time, | ||
| * before any processing. | ||
| */ | ||
| export interface MessageHint { | ||
| /** | ||
| * Original caught error. | ||
| */ | ||
| error?: Error | string; | ||
|
|
||
| /** | ||
| * Breadcrumbs captured at error time. | ||
| */ | ||
| breadcrumbs?: Breadcrumb[]; | ||
| } | ||
|
|
||
| /** | ||
| * Single step in message processing pipeline before message is sent. | ||
| * | ||
| * @typeParam T - catcher message type this processor handles | ||
| */ | ||
| export interface MessageProcessor<T extends CatcherMessageType = CatcherMessageType> { | ||
| /** | ||
| * Handles input message. May mutate or replace it. | ||
| * | ||
| * @param payload - processed event message payload with partially-built addons | ||
| * @param hint - additional context about original error | ||
| * @returns modified payload, or `null` to drop event | ||
| */ | ||
| apply( | ||
| payload: ProcessingPayload<T>, | ||
| hint?: MessageHint, | ||
| ): ProcessingPayload<T> | null | ||
| } | ||
This file contains hidden or 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.
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.
Term "hint" is not clear, let's find a better alternative