Add EventBatcher transport#191
Draft
Reversean wants to merge 4 commits into
Draft
Conversation
…batching Introduces EventBatcher — a Transport decorator that accumulates identical events within a configurable time window and forwards one representative message per unique signature with CatcherMessage.count set to the total number of occurrences. Signature is computed from title, type, and per-frame coordinates (file, line, column, function) using null-byte delimiters. Lookup is O(1) via Map keyed on the signature string. Flush is triggered by whichever condition is met first: - time window expires (default 5 s from first event in window) - buffer reaches maxBufferSize distinct signatures (default 100) - flush() is called explicitly (e.g. on pagehide) BrowserCatcher wraps its transport in EventBatcher and registers a capture-phase pagehide listener to drain the buffer before the socket closes. Protocol: CatcherMessage.count is declared via module augmentation on @hawk.so/types. Server must increment totalCount by count (defaulting to 1) and create a single Repetition record per batch.
neSpecc
reviewed
Jun 1, 2026
| * | ||
| * @param message - message to compute signature for | ||
| */ | ||
| function computeSignature<T extends CatcherMessageType>(message: CatcherMessage<T>): string { |
Member
There was a problem hiding this comment.
lets make it work like in Grouper (without backtrace)
Member
Author
There was a problem hiding this comment.
Removed backtrace from key.
I think it's ok, if we still represent it as string concat, not hash as grouper does.
|
|
||
| if (existing !== undefined) { | ||
| existing.count++; | ||
| } else { |
Member
There was a problem hiding this comment.
if event is not batched, send it immediately (or with small delay to wait for duplicates)
Member
Author
There was a problem hiding this comment.
Now sending events with 5sec delay to wait duplicates.
| * First occurrence is used as representative event for each batch. | ||
| * Context, user, and breadcrumbs of subsequent identical occurrences are not preserved. | ||
| */ | ||
| export class EventBatcher<T extends CatcherMessageType> implements Transport<T> { |
Member
There was a problem hiding this comment.
lets call it "dedupe" instead of "batching" (because we will add batching later)
So lets the class EventDedupeTransport
| import type { BacktraceFrame, CatcherMessage, CatcherMessageType } from '@hawk.so/types'; | ||
| import type { Transport } from './transport'; | ||
|
|
||
| declare module '@hawk.so/types' { |
Member
There was a problem hiding this comment.
should be added to the types package
- Renamed EventBatcher to EventDedupeTransport - removed backtrace from event key for debounce
Reversean
force-pushed
the
feat/event-batcher
branch
from
d0c37a1 to
07cc623
Compare
neSpecc
reviewed
Jun 1, 2026
| */ | ||
| constructor(transport: Transport<T>, options: EventDedupeTransportOptions = {}) { | ||
| this.transport = transport; | ||
| this.windowMs = options.windowMs ?? 5_000; |
Member
There was a problem hiding this comment.
I think five 5 sec is too large delay. We can loose a lots of errors.
Suggested change
| this.windowMs = options.windowMs ?? 5_000; | |
| this.windowMs = options.windowMs ?? 2_500; |
| if (existing !== undefined) { | ||
| existing.count++; | ||
|
|
||
| return; |
Member
There was a problem hiding this comment.
should we reschedule timer here?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Introduces EventBatcher — a Transport decorator that accumulates identical events within a configurable time window and forwards one representative message per unique signature with CatcherMessage.count set to the total number of occurrences.
Signature is computed from title, type, and per-frame coordinates (file, line, column, function) using null-byte delimiters. Lookup is O(1) via Map keyed on the signature string.
Flush is triggered by whichever condition is met first:
BrowserCatcher wraps its transport in EventBatcher and registers a capture-phase pagehide listener to drain the buffer before the socket closes.
Protocol: CatcherMessage.count is declared via module augmentation on @hawk.so/types. Server must increment totalCount by count (defaulting to 1) and create a single Repetition record per batch.