feat(core): allow unregistering callback through on#11710

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.

Sign up for GitHub

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

Merged
mydea merged 3 commits into from
Jul 4, 2024
Merged

feat(core): allow unregistering callback through on#11710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c38627
feat(core): allow unregistering callback through `on`
arturovt Apr 22, 2024
cf9e279
Apply suggestions from code review
mydea Jul 3, 2024
d7c2fd4
fix it, oops...
mydea Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 36 additions & 15 deletions packages/core/src/baseclient.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -390,37 +390,40 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
/* eslint-disable @typescript-eslint/unified-signatures */

/** @inheritdoc */
public on(hook: 'spanStart', callback: (span: Span) => void): void;
public on(hook: 'spanStart', callback: (span: Span) => void): () => void;

/** @inheritdoc */
public on(hook: 'spanEnd', callback: (span: Span) => void): void;
public on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

/** @inheritdoc */
public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

/** @inheritdoc */
public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

/** @inheritdoc */
public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): void;
public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

/** @inheritdoc */
public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): void;
public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

/** @inheritdoc */
public on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
public on(
hook: 'afterSendEvent',
callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void,
): () => void;

/** @inheritdoc */
public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

/** @inheritdoc */
public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

/** @inheritdoc */
public on(
hook: 'beforeSendFeedback',
callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void,
): void;
): () => void;

/** @inheritdoc */
public on(
Expand All@@ -443,23 +446,41 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
options: StartSpanOptions,
traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
) => void,
): void;
): () => void;

/** @inheritdoc */
public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

public on(hook: 'flush', callback: () => void): void;
public on(hook: 'flush', callback: () => void): () => void;

public on(hook: 'close', callback: () => void): void;
public on(hook: 'close', callback: () => void): () => void;

/** @inheritdoc */
public on(hook: string, callback: unknown): void {
public on(hook: string, callback: unknown): () => void {
// Note that the code below, with nullish coalescing assignment,
// may reduce the code, so it may be switched to when Node 14 support
// is dropped (the `??=` operator is supported since Node 15).
// (this._hooks[hook] ??= []).push(callback);
if (!this._hooks[hook]) {
this._hooks[hook] = [];
}

// @ts-expect-error We assue the types are correct
this._hooks[hook].push(callback);

// This function returns a callback execution handler that, when invoked,
// deregisters a callback. This is crucial for managing instances where callbacks
// need to be unregistered to prevent self-referencing in callback closures,
// ensuring proper garbage collection.
return () => {
const hooks = this._hooks[hook];

if (hooks) {
// @ts-expect-error We assue the types are correct
const cbIndex = hooks.indexOf(callback);
hooks.splice(cbIndex, 1);
}
};
}

/** @inheritdoc */
Expand Down
52 changes: 52 additions & 0 deletions packages/core/test/lib/base.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2014,4 +2014,56 @@ describe('BaseClient', () => {
});
});
});

describe('hook removal with `on`', () => {
it('should return a cleanup function that, when executed, unregisters a hook', async () => {
expect.assertions(8);

const client = new TestClient(
getDefaultTestClientOptions({
dsn: PUBLIC_DSN,
enableSend: true,
}),
);

const mockSend = jest.spyOn(client.getTransport()!, 'send').mockImplementation(() => {
return Promise.resolve({ statusCode: 200 });
});

const errorEvent: Event = { message: 'error' };

const callback = jest.fn();
const removeAfterSendEventListenerFn = client.on('afterSendEvent', callback);

expect(client['_hooks']['afterSendEvent']).toEqual([callback]);

client.sendEvent(errorEvent);
jest.runAllTimers();
// Wait for two ticks
// note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
await undefined;
await undefined;

expect(mockSend).toBeCalledTimes(1);
expect(callback).toBeCalledTimes(1);
expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });

// Should unregister `afterSendEvent` callback.
removeAfterSendEventListenerFn();
expect(client['_hooks']['afterSendEvent']).toEqual([]);

client.sendEvent(errorEvent);
jest.runAllTimers();
// Wait for two ticks
// note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
await undefined;
await undefined;

expect(mockSend).toBeCalledTimes(2);
// Note that the `callback` has still been called only once and not twice,
// because we unregistered it.
expect(callback).toBeCalledTimes(1);
expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });
});
});
});
43 changes: 29 additions & 14 deletions packages/types/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -181,12 +181,14 @@ export interface Client<O extends ClientOptions = ClientOptions> {
/**
* Register a callback for whenever a span is started.
* Receives the span as argument.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'spanStart', callback: (span: Span) => void): void;
on(hook: 'spanStart', callback: (span: Span) => void): () => void;

@Lms24Lms24Apr 25, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a comment to the JSDocs about what's returned from the methods

@arturovtarturovtMay 3, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I addressed your comments, I see there're some random failures happening between commits, not sure if they're related...


/**
* Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
* property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
* @returns A function that, when executed, removes the registered callback.
*/
on(
hook: 'beforeSampling',
Expand All@@ -204,83 +206,96 @@ export interface Client<O extends ClientOptions = ClientOptions> {
/**
* Register a callback for whenever a span is ended.
* Receives the span as argument.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'spanEnd', callback: (span: Span) => void): void;
on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

/**
* Register a callback for when an idle span is allowed to auto-finish.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

/**
* Register a callback for transaction start and finish.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

/**
* Register a callback for before sending an event.
* This is called right before an event is sent and should not be used to mutate the event.
* Receives an Event & EventHint as arguments.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

/**
* Register a callback for preprocessing an event,
* before it is passed to (global) event processors.
* Receives an Event & EventHint as arguments.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

/**
* Register a callback for when an event has been sent.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;

/**
* Register a callback before a breadcrumb is added.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

/**
* Register a callback when a DSC (Dynamic Sampling Context) is created.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

/**
* Register a callback when a Feedback event has been prepared.
* This should be used to mutate the event. The options argument can hint
* about what kind of mutation it expects.
* @returns A function that, when executed, removes the registered callback.
*/
on(
hook: 'beforeSendFeedback',
callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
): void;
): () => void;

/**
* A hook for the browser tracing integrations to trigger a span start for a page load.
* @returns A function that, when executed, removes the registered callback.
*/
on(
hook: 'startPageLoadSpan',
callback: (
options: StartSpanOptions,
traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
) => void,
): void;
): () => void;

/**
* A hook for browser tracing integrations to trigger a span for a navigation.
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

/**
* A hook that is called when the client is flushing
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'flush', callback: () => void): void;
on(hook: 'flush', callback: () => void): () => void;

/**
* A hook that is called when the client is closing
* @returns A function that, when executed, removes the registered callback.
*/
on(hook: 'close', callback: () => void): void;
on(hook: 'close', callback: () => void): () => void;

/** Fire a hook whener a span starts. */
emit(hook: 'spanStart', span: Span): void;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(core): allow unregistering callback through on#11710

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.

 Sign up for GitHub

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

 Merged

mydea
merged 3 commits into

from

Jul 4, 2024
 Merged


feat(core): allow unregistering callback through on#11710
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
2c38627

feat(core): allow unregistering callback through `on`


arturovt Apr 22, 2024
cf9e279

Apply suggestions from code review


mydea Jul 3, 2024
d7c2fd4

fix it, oops...


mydea Jul 3, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


51 changes: 36 additions & 15 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,37 +390,40 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /* eslint-disable @typescript-eslint/unified-signatures */

 /** @inheritdoc */
 public on(hook: 'spanStart', callback: (span: Span) => void): void;
 public on(hook: 'spanStart', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'spanEnd', callback: (span: Span) => void): void;
 public on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 public on(
 hook: 'afterSendEvent',
 callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void,
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /** @inheritdoc */
 public on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(
Expand All@@ -443,23 +446,41 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 public on(hook: 'flush', callback: () => void): void;
 public on(hook: 'flush', callback: () => void): () => void;

 public on(hook: 'close', callback: () => void): void;
 public on(hook: 'close', callback: () => void): () => void;

 /** @inheritdoc */
 public on(hook: string, callback: unknown): void {
 public on(hook: string, callback: unknown): () => void {
 // Note that the code below, with nullish coalescing assignment,
 // may reduce the code, so it may be switched to when Node 14 support
 // is dropped (the `??=` operator is supported since Node 15).
 // (this._hooks[hook] ??= []).push(callback);
 if (!this._hooks[hook]) {
 this._hooks[hook] = [];
 }

 // @ts-expect-error We assue the types are correct
 this._hooks[hook].push(callback);

 // This function returns a callback execution handler that, when invoked,
 // deregisters a callback. This is crucial for managing instances where callbacks
 // need to be unregistered to prevent self-referencing in callback closures,
 // ensuring proper garbage collection.
 return () => {
 const hooks = this._hooks[hook];

 if (hooks) {
 // @ts-expect-error We assue the types are correct
 const cbIndex = hooks.indexOf(callback);
 hooks.splice(cbIndex, 1);
 }
 };
 }

 /** @inheritdoc */
Expand Down

52 changes: 52 additions & 0 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2014,4 +2014,56 @@ describe('BaseClient', () => {
 });
 });
 });

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 expect.assertions(8);

 const client = new TestClient(
 getDefaultTestClientOptions({
 dsn: PUBLIC_DSN,
 enableSend: true,
 }),
 );

 const mockSend = jest.spyOn(client.getTransport()!, 'send').mockImplementation(() => {
 return Promise.resolve({ statusCode: 200 });
 });

 const errorEvent: Event = { message: 'error' };

 const callback = jest.fn();
 const removeAfterSendEventListenerFn = client.on('afterSendEvent', callback);

 expect(client['_hooks']['afterSendEvent']).toEqual([callback]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(1);
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });

 // Should unregister `afterSendEvent` callback.
 removeAfterSendEventListenerFn();
 expect(client['_hooks']['afterSendEvent']).toEqual([]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(2);
 // Note that the `callback` has still been called only once and not twice,
 // because we unregistered it.
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });
 });
 });
});

43 changes: 29 additions & 14 deletions
packages/types/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,12 +181,14 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is started.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanStart', callback: (span: Span) => void): void;
 on(hook: 'spanStart', callback: (span: Span) => void): () => void;
@Lms24Lms24Apr 25, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a comment to the JSDocs about what's returned from the methods
@arturovtarturovtMay 3, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I addressed your comments, I see there're some random failures happening between commits, not sure if they're related...

 /**
 * Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
 * property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSampling',
Expand All@@ -204,83 +206,96 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is ended.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanEnd', callback: (span: Span) => void): void;
 on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for when an idle span is allowed to auto-finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for transaction start and finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /**
 * Register a callback for before sending an event.
 * This is called right before an event is sent and should not be used to mutate the event.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for preprocessing an event,
 * before it is passed to (global) event processors.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for when an event has been sent.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;

 /**
 * Register a callback before a breadcrumb is added.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /**
 * Register a callback when a DSC (Dynamic Sampling Context) is created.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /**
 * Register a callback when a Feedback event has been prepared.
 * This should be used to mutate the event. The options argument can hint
 * about what kind of mutation it expects.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): void;
 ): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'startPageLoadSpan',
 callback: (
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /**
 * A hook for browser tracing integrations to trigger a span for a navigation.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 /**
 * A hook that is called when the client is flushing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'flush', callback: () => void): void;
 on(hook: 'flush', callback: () => void): () => void;

 /**
 * A hook that is called when the client is closing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'close', callback: () => void): void;
 on(hook: 'close', callback: () => void): () => void;

 /** Fire a hook whener a span starts. */
 emit(hook: 'spanStart', span: Span): void;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): allow unregistering callback through on#11710

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.

 Sign up for GitHub

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

 Merged

mydea
merged 3 commits into

from

Jul 4, 2024
 Merged


feat(core): allow unregistering callback through on#11710
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
2c38627

feat(core): allow unregistering callback through `on`


arturovt Apr 22, 2024
cf9e279

Apply suggestions from code review


mydea Jul 3, 2024
d7c2fd4

fix it, oops...


mydea Jul 3, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


51 changes: 36 additions & 15 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,37 +390,40 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /* eslint-disable @typescript-eslint/unified-signatures */

 /** @inheritdoc */
 public on(hook: 'spanStart', callback: (span: Span) => void): void;
 public on(hook: 'spanStart', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'spanEnd', callback: (span: Span) => void): void;
 public on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 public on(
 hook: 'afterSendEvent',
 callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void,
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /** @inheritdoc */
 public on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(
Expand All@@ -443,23 +446,41 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 public on(hook: 'flush', callback: () => void): void;
 public on(hook: 'flush', callback: () => void): () => void;

 public on(hook: 'close', callback: () => void): void;
 public on(hook: 'close', callback: () => void): () => void;

 /** @inheritdoc */
 public on(hook: string, callback: unknown): void {
 public on(hook: string, callback: unknown): () => void {
 // Note that the code below, with nullish coalescing assignment,
 // may reduce the code, so it may be switched to when Node 14 support
 // is dropped (the `??=` operator is supported since Node 15).
 // (this._hooks[hook] ??= []).push(callback);
 if (!this._hooks[hook]) {
 this._hooks[hook] = [];
 }

 // @ts-expect-error We assue the types are correct
 this._hooks[hook].push(callback);

 // This function returns a callback execution handler that, when invoked,
 // deregisters a callback. This is crucial for managing instances where callbacks
 // need to be unregistered to prevent self-referencing in callback closures,
 // ensuring proper garbage collection.
 return () => {
 const hooks = this._hooks[hook];

 if (hooks) {
 // @ts-expect-error We assue the types are correct
 const cbIndex = hooks.indexOf(callback);
 hooks.splice(cbIndex, 1);
 }
 };
 }

 /** @inheritdoc */
Expand Down

52 changes: 52 additions & 0 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2014,4 +2014,56 @@ describe('BaseClient', () => {
 });
 });
 });

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 expect.assertions(8);

 const client = new TestClient(
 getDefaultTestClientOptions({
 dsn: PUBLIC_DSN,
 enableSend: true,
 }),
 );

 const mockSend = jest.spyOn(client.getTransport()!, 'send').mockImplementation(() => {
 return Promise.resolve({ statusCode: 200 });
 });

 const errorEvent: Event = { message: 'error' };

 const callback = jest.fn();
 const removeAfterSendEventListenerFn = client.on('afterSendEvent', callback);

 expect(client['_hooks']['afterSendEvent']).toEqual([callback]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(1);
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });

 // Should unregister `afterSendEvent` callback.
 removeAfterSendEventListenerFn();
 expect(client['_hooks']['afterSendEvent']).toEqual([]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(2);
 // Note that the `callback` has still been called only once and not twice,
 // because we unregistered it.
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });
 });
 });
});

43 changes: 29 additions & 14 deletions
packages/types/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,12 +181,14 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is started.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanStart', callback: (span: Span) => void): void;
 on(hook: 'spanStart', callback: (span: Span) => void): () => void;
@Lms24Lms24Apr 25, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a comment to the JSDocs about what's returned from the methods
@arturovtarturovtMay 3, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I addressed your comments, I see there're some random failures happening between commits, not sure if they're related...

 /**
 * Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
 * property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSampling',
Expand All@@ -204,83 +206,96 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is ended.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanEnd', callback: (span: Span) => void): void;
 on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for when an idle span is allowed to auto-finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for transaction start and finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /**
 * Register a callback for before sending an event.
 * This is called right before an event is sent and should not be used to mutate the event.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for preprocessing an event,
 * before it is passed to (global) event processors.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for when an event has been sent.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;

 /**
 * Register a callback before a breadcrumb is added.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /**
 * Register a callback when a DSC (Dynamic Sampling Context) is created.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /**
 * Register a callback when a Feedback event has been prepared.
 * This should be used to mutate the event. The options argument can hint
 * about what kind of mutation it expects.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): void;
 ): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'startPageLoadSpan',
 callback: (
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /**
 * A hook for browser tracing integrations to trigger a span for a navigation.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 /**
 * A hook that is called when the client is flushing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'flush', callback: () => void): void;
 on(hook: 'flush', callback: () => void): () => void;

 /**
 * A hook that is called when the client is closing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'close', callback: () => void): void;
 on(hook: 'close', callback: () => void): () => void;

 /** Fire a hook whener a span starts. */
 emit(hook: 'spanStart', span: Span): void;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): allow unregistering callback through on#11710

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.

 Sign up for GitHub

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

 Merged

mydea
merged 3 commits into

from

Jul 4, 2024
 Merged


feat(core): allow unregistering callback through on#11710
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
2c38627

feat(core): allow unregistering callback through `on`


arturovt Apr 22, 2024
cf9e279

Apply suggestions from code review


mydea Jul 3, 2024
d7c2fd4

fix it, oops...


mydea Jul 3, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


51 changes: 36 additions & 15 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,37 +390,40 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /* eslint-disable @typescript-eslint/unified-signatures */

 /** @inheritdoc */
 public on(hook: 'spanStart', callback: (span: Span) => void): void;
 public on(hook: 'spanStart', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'spanEnd', callback: (span: Span) => void): void;
 public on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 public on(
 hook: 'afterSendEvent',
 callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void,
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /** @inheritdoc */
 public on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(
Expand All@@ -443,23 +446,41 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 public on(hook: 'flush', callback: () => void): void;
 public on(hook: 'flush', callback: () => void): () => void;

 public on(hook: 'close', callback: () => void): void;
 public on(hook: 'close', callback: () => void): () => void;

 /** @inheritdoc */
 public on(hook: string, callback: unknown): void {
 public on(hook: string, callback: unknown): () => void {
 // Note that the code below, with nullish coalescing assignment,
 // may reduce the code, so it may be switched to when Node 14 support
 // is dropped (the `??=` operator is supported since Node 15).
 // (this._hooks[hook] ??= []).push(callback);
 if (!this._hooks[hook]) {
 this._hooks[hook] = [];
 }

 // @ts-expect-error We assue the types are correct
 this._hooks[hook].push(callback);

 // This function returns a callback execution handler that, when invoked,
 // deregisters a callback. This is crucial for managing instances where callbacks
 // need to be unregistered to prevent self-referencing in callback closures,
 // ensuring proper garbage collection.
 return () => {
 const hooks = this._hooks[hook];

 if (hooks) {
 // @ts-expect-error We assue the types are correct
 const cbIndex = hooks.indexOf(callback);
 hooks.splice(cbIndex, 1);
 }
 };
 }

 /** @inheritdoc */
Expand Down

52 changes: 52 additions & 0 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2014,4 +2014,56 @@ describe('BaseClient', () => {
 });
 });
 });

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 expect.assertions(8);

 const client = new TestClient(
 getDefaultTestClientOptions({
 dsn: PUBLIC_DSN,
 enableSend: true,
 }),
 );

 const mockSend = jest.spyOn(client.getTransport()!, 'send').mockImplementation(() => {
 return Promise.resolve({ statusCode: 200 });
 });

 const errorEvent: Event = { message: 'error' };

 const callback = jest.fn();
 const removeAfterSendEventListenerFn = client.on('afterSendEvent', callback);

 expect(client['_hooks']['afterSendEvent']).toEqual([callback]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(1);
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });

 // Should unregister `afterSendEvent` callback.
 removeAfterSendEventListenerFn();
 expect(client['_hooks']['afterSendEvent']).toEqual([]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(2);
 // Note that the `callback` has still been called only once and not twice,
 // because we unregistered it.
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });
 });
 });
});

43 changes: 29 additions & 14 deletions
packages/types/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,12 +181,14 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is started.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanStart', callback: (span: Span) => void): void;
 on(hook: 'spanStart', callback: (span: Span) => void): () => void;
@Lms24Lms24Apr 25, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a comment to the JSDocs about what's returned from the methods
@arturovtarturovtMay 3, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I addressed your comments, I see there're some random failures happening between commits, not sure if they're related...

 /**
 * Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
 * property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSampling',
Expand All@@ -204,83 +206,96 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is ended.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanEnd', callback: (span: Span) => void): void;
 on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for when an idle span is allowed to auto-finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for transaction start and finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /**
 * Register a callback for before sending an event.
 * This is called right before an event is sent and should not be used to mutate the event.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for preprocessing an event,
 * before it is passed to (global) event processors.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for when an event has been sent.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;

 /**
 * Register a callback before a breadcrumb is added.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /**
 * Register a callback when a DSC (Dynamic Sampling Context) is created.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /**
 * Register a callback when a Feedback event has been prepared.
 * This should be used to mutate the event. The options argument can hint
 * about what kind of mutation it expects.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): void;
 ): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'startPageLoadSpan',
 callback: (
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /**
 * A hook for browser tracing integrations to trigger a span for a navigation.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 /**
 * A hook that is called when the client is flushing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'flush', callback: () => void): void;
 on(hook: 'flush', callback: () => void): () => void;

 /**
 * A hook that is called when the client is closing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'close', callback: () => void): void;
 on(hook: 'close', callback: () => void): () => void;

 /** Fire a hook whener a span starts. */
 emit(hook: 'spanStart', span: Span): void;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(core): allow unregistering callback through on#11710

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.

 Sign up for GitHub

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

 Merged

mydea
merged 3 commits into

from

Jul 4, 2024
 Merged


feat(core): allow unregistering callback through on#11710
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
2c38627

feat(core): allow unregistering callback through `on`


arturovt Apr 22, 2024
cf9e279

Apply suggestions from code review


mydea Jul 3, 2024
d7c2fd4

fix it, oops...


mydea Jul 3, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


51 changes: 36 additions & 15 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,37 +390,40 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /* eslint-disable @typescript-eslint/unified-signatures */

 /** @inheritdoc */
 public on(hook: 'spanStart', callback: (span: Span) => void): void;
 public on(hook: 'spanStart', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'spanEnd', callback: (span: Span) => void): void;
 public on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 public on(
 hook: 'afterSendEvent',
 callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void,
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /** @inheritdoc */
 public on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(
Expand All@@ -443,23 +446,41 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 public on(hook: 'flush', callback: () => void): void;
 public on(hook: 'flush', callback: () => void): () => void;

 public on(hook: 'close', callback: () => void): void;
 public on(hook: 'close', callback: () => void): () => void;

 /** @inheritdoc */
 public on(hook: string, callback: unknown): void {
 public on(hook: string, callback: unknown): () => void {
 // Note that the code below, with nullish coalescing assignment,
 // may reduce the code, so it may be switched to when Node 14 support
 // is dropped (the `??=` operator is supported since Node 15).
 // (this._hooks[hook] ??= []).push(callback);
 if (!this._hooks[hook]) {
 this._hooks[hook] = [];
 }

 // @ts-expect-error We assue the types are correct
 this._hooks[hook].push(callback);

 // This function returns a callback execution handler that, when invoked,
 // deregisters a callback. This is crucial for managing instances where callbacks
 // need to be unregistered to prevent self-referencing in callback closures,
 // ensuring proper garbage collection.
 return () => {
 const hooks = this._hooks[hook];

 if (hooks) {
 // @ts-expect-error We assue the types are correct
 const cbIndex = hooks.indexOf(callback);
 hooks.splice(cbIndex, 1);
 }
 };
 }

 /** @inheritdoc */
Expand Down

52 changes: 52 additions & 0 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2014,4 +2014,56 @@ describe('BaseClient', () => {
 });
 });
 });

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 expect.assertions(8);

 const client = new TestClient(
 getDefaultTestClientOptions({
 dsn: PUBLIC_DSN,
 enableSend: true,
 }),
 );

 const mockSend = jest.spyOn(client.getTransport()!, 'send').mockImplementation(() => {
 return Promise.resolve({ statusCode: 200 });
 });

 const errorEvent: Event = { message: 'error' };

 const callback = jest.fn();
 const removeAfterSendEventListenerFn = client.on('afterSendEvent', callback);

 expect(client['_hooks']['afterSendEvent']).toEqual([callback]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(1);
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });

 // Should unregister `afterSendEvent` callback.
 removeAfterSendEventListenerFn();
 expect(client['_hooks']['afterSendEvent']).toEqual([]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(2);
 // Note that the `callback` has still been called only once and not twice,
 // because we unregistered it.
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });
 });
 });
});

43 changes: 29 additions & 14 deletions
packages/types/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,12 +181,14 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is started.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanStart', callback: (span: Span) => void): void;
 on(hook: 'spanStart', callback: (span: Span) => void): () => void;
@Lms24Lms24Apr 25, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a comment to the JSDocs about what's returned from the methods
@arturovtarturovtMay 3, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I addressed your comments, I see there're some random failures happening between commits, not sure if they're related...

 /**
 * Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
 * property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSampling',
Expand All@@ -204,83 +206,96 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is ended.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanEnd', callback: (span: Span) => void): void;
 on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for when an idle span is allowed to auto-finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for transaction start and finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /**
 * Register a callback for before sending an event.
 * This is called right before an event is sent and should not be used to mutate the event.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for preprocessing an event,
 * before it is passed to (global) event processors.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for when an event has been sent.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;

 /**
 * Register a callback before a breadcrumb is added.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /**
 * Register a callback when a DSC (Dynamic Sampling Context) is created.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /**
 * Register a callback when a Feedback event has been prepared.
 * This should be used to mutate the event. The options argument can hint
 * about what kind of mutation it expects.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): void;
 ): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'startPageLoadSpan',
 callback: (
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /**
 * A hook for browser tracing integrations to trigger a span for a navigation.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 /**
 * A hook that is called when the client is flushing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'flush', callback: () => void): void;
 on(hook: 'flush', callback: () => void): () => void;

 /**
 * A hook that is called when the client is closing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'close', callback: () => void): void;
 on(hook: 'close', callback: () => void): () => void;

 /** Fire a hook whener a span starts. */
 emit(hook: 'spanStart', span: Span): void;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): allow unregistering callback through on#11710

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.

 Sign up for GitHub

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

 Merged

mydea
merged 3 commits into

from

Jul 4, 2024
 Merged


feat(core): allow unregistering callback through on#11710
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
2c38627

feat(core): allow unregistering callback through `on`


arturovt Apr 22, 2024
cf9e279

Apply suggestions from code review


mydea Jul 3, 2024
d7c2fd4

fix it, oops...


mydea Jul 3, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


51 changes: 36 additions & 15 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,37 +390,40 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /* eslint-disable @typescript-eslint/unified-signatures */

 /** @inheritdoc */
 public on(hook: 'spanStart', callback: (span: Span) => void): void;
 public on(hook: 'spanStart', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'spanEnd', callback: (span: Span) => void): void;
 public on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 public on(
 hook: 'afterSendEvent',
 callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void,
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /** @inheritdoc */
 public on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(
Expand All@@ -443,23 +446,41 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 public on(hook: 'flush', callback: () => void): void;
 public on(hook: 'flush', callback: () => void): () => void;

 public on(hook: 'close', callback: () => void): void;
 public on(hook: 'close', callback: () => void): () => void;

 /** @inheritdoc */
 public on(hook: string, callback: unknown): void {
 public on(hook: string, callback: unknown): () => void {
 // Note that the code below, with nullish coalescing assignment,
 // may reduce the code, so it may be switched to when Node 14 support
 // is dropped (the `??=` operator is supported since Node 15).
 // (this._hooks[hook] ??= []).push(callback);
 if (!this._hooks[hook]) {
 this._hooks[hook] = [];
 }

 // @ts-expect-error We assue the types are correct
 this._hooks[hook].push(callback);

 // This function returns a callback execution handler that, when invoked,
 // deregisters a callback. This is crucial for managing instances where callbacks
 // need to be unregistered to prevent self-referencing in callback closures,
 // ensuring proper garbage collection.
 return () => {
 const hooks = this._hooks[hook];

 if (hooks) {
 // @ts-expect-error We assue the types are correct
 const cbIndex = hooks.indexOf(callback);
 hooks.splice(cbIndex, 1);
 }
 };
 }

 /** @inheritdoc */
Expand Down

52 changes: 52 additions & 0 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2014,4 +2014,56 @@ describe('BaseClient', () => {
 });
 });
 });

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 expect.assertions(8);

 const client = new TestClient(
 getDefaultTestClientOptions({
 dsn: PUBLIC_DSN,
 enableSend: true,
 }),
 );

 const mockSend = jest.spyOn(client.getTransport()!, 'send').mockImplementation(() => {
 return Promise.resolve({ statusCode: 200 });
 });

 const errorEvent: Event = { message: 'error' };

 const callback = jest.fn();
 const removeAfterSendEventListenerFn = client.on('afterSendEvent', callback);

 expect(client['_hooks']['afterSendEvent']).toEqual([callback]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(1);
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });

 // Should unregister `afterSendEvent` callback.
 removeAfterSendEventListenerFn();
 expect(client['_hooks']['afterSendEvent']).toEqual([]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(2);
 // Note that the `callback` has still been called only once and not twice,
 // because we unregistered it.
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });
 });
 });
});

43 changes: 29 additions & 14 deletions
packages/types/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,12 +181,14 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is started.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanStart', callback: (span: Span) => void): void;
 on(hook: 'spanStart', callback: (span: Span) => void): () => void;
@Lms24Lms24Apr 25, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a comment to the JSDocs about what's returned from the methods
@arturovtarturovtMay 3, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I addressed your comments, I see there're some random failures happening between commits, not sure if they're related...

 /**
 * Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
 * property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSampling',
Expand All@@ -204,83 +206,96 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is ended.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanEnd', callback: (span: Span) => void): void;
 on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for when an idle span is allowed to auto-finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for transaction start and finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /**
 * Register a callback for before sending an event.
 * This is called right before an event is sent and should not be used to mutate the event.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for preprocessing an event,
 * before it is passed to (global) event processors.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for when an event has been sent.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;

 /**
 * Register a callback before a breadcrumb is added.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /**
 * Register a callback when a DSC (Dynamic Sampling Context) is created.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /**
 * Register a callback when a Feedback event has been prepared.
 * This should be used to mutate the event. The options argument can hint
 * about what kind of mutation it expects.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): void;
 ): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'startPageLoadSpan',
 callback: (
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /**
 * A hook for browser tracing integrations to trigger a span for a navigation.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 /**
 * A hook that is called when the client is flushing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'flush', callback: () => void): void;
 on(hook: 'flush', callback: () => void): () => void;

 /**
 * A hook that is called when the client is closing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'close', callback: () => void): void;
 on(hook: 'close', callback: () => void): () => void;

 /** Fire a hook whener a span starts. */
 emit(hook: 'spanStart', span: Span): void;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): allow unregistering callback through on#11710

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.

 Sign up for GitHub

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

 Merged

mydea
merged 3 commits into

from

Jul 4, 2024
 Merged


feat(core): allow unregistering callback through on#11710
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
2c38627

feat(core): allow unregistering callback through `on`


arturovt Apr 22, 2024
cf9e279

Apply suggestions from code review


mydea Jul 3, 2024
d7c2fd4

fix it, oops...


mydea Jul 3, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


51 changes: 36 additions & 15 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,37 +390,40 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /* eslint-disable @typescript-eslint/unified-signatures */

 /** @inheritdoc */
 public on(hook: 'spanStart', callback: (span: Span) => void): void;
 public on(hook: 'spanStart', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'spanEnd', callback: (span: Span) => void): void;
 public on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 public on(
 hook: 'afterSendEvent',
 callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void,
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /** @inheritdoc */
 public on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(
Expand All@@ -443,23 +446,41 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 public on(hook: 'flush', callback: () => void): void;
 public on(hook: 'flush', callback: () => void): () => void;

 public on(hook: 'close', callback: () => void): void;
 public on(hook: 'close', callback: () => void): () => void;

 /** @inheritdoc */
 public on(hook: string, callback: unknown): void {
 public on(hook: string, callback: unknown): () => void {
 // Note that the code below, with nullish coalescing assignment,
 // may reduce the code, so it may be switched to when Node 14 support
 // is dropped (the `??=` operator is supported since Node 15).
 // (this._hooks[hook] ??= []).push(callback);
 if (!this._hooks[hook]) {
 this._hooks[hook] = [];
 }

 // @ts-expect-error We assue the types are correct
 this._hooks[hook].push(callback);

 // This function returns a callback execution handler that, when invoked,
 // deregisters a callback. This is crucial for managing instances where callbacks
 // need to be unregistered to prevent self-referencing in callback closures,
 // ensuring proper garbage collection.
 return () => {
 const hooks = this._hooks[hook];

 if (hooks) {
 // @ts-expect-error We assue the types are correct
 const cbIndex = hooks.indexOf(callback);
 hooks.splice(cbIndex, 1);
 }
 };
 }

 /** @inheritdoc */
Expand Down

52 changes: 52 additions & 0 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2014,4 +2014,56 @@ describe('BaseClient', () => {
 });
 });
 });

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 expect.assertions(8);

 const client = new TestClient(
 getDefaultTestClientOptions({
 dsn: PUBLIC_DSN,
 enableSend: true,
 }),
 );

 const mockSend = jest.spyOn(client.getTransport()!, 'send').mockImplementation(() => {
 return Promise.resolve({ statusCode: 200 });
 });

 const errorEvent: Event = { message: 'error' };

 const callback = jest.fn();
 const removeAfterSendEventListenerFn = client.on('afterSendEvent', callback);

 expect(client['_hooks']['afterSendEvent']).toEqual([callback]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(1);
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });

 // Should unregister `afterSendEvent` callback.
 removeAfterSendEventListenerFn();
 expect(client['_hooks']['afterSendEvent']).toEqual([]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(2);
 // Note that the `callback` has still been called only once and not twice,
 // because we unregistered it.
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });
 });
 });
});

43 changes: 29 additions & 14 deletions
packages/types/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,12 +181,14 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is started.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanStart', callback: (span: Span) => void): void;
 on(hook: 'spanStart', callback: (span: Span) => void): () => void;
@Lms24Lms24Apr 25, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a comment to the JSDocs about what's returned from the methods
@arturovtarturovtMay 3, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I addressed your comments, I see there're some random failures happening between commits, not sure if they're related...

 /**
 * Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
 * property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSampling',
Expand All@@ -204,83 +206,96 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is ended.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanEnd', callback: (span: Span) => void): void;
 on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for when an idle span is allowed to auto-finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for transaction start and finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /**
 * Register a callback for before sending an event.
 * This is called right before an event is sent and should not be used to mutate the event.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for preprocessing an event,
 * before it is passed to (global) event processors.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for when an event has been sent.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;

 /**
 * Register a callback before a breadcrumb is added.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /**
 * Register a callback when a DSC (Dynamic Sampling Context) is created.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /**
 * Register a callback when a Feedback event has been prepared.
 * This should be used to mutate the event. The options argument can hint
 * about what kind of mutation it expects.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): void;
 ): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'startPageLoadSpan',
 callback: (
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /**
 * A hook for browser tracing integrations to trigger a span for a navigation.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 /**
 * A hook that is called when the client is flushing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'flush', callback: () => void): void;
 on(hook: 'flush', callback: () => void): () => void;

 /**
 * A hook that is called when the client is closing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'close', callback: () => void): void;
 on(hook: 'close', callback: () => void): () => void;

 /** Fire a hook whener a span starts. */
 emit(hook: 'spanStart', span: Span): void;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(core): allow unregistering callback through on#11710

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.

 Sign up for GitHub

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

 Merged

mydea
merged 3 commits into

from

Jul 4, 2024
 Merged


feat(core): allow unregistering callback through on#11710
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
2c38627

feat(core): allow unregistering callback through `on`


arturovt Apr 22, 2024
cf9e279

Apply suggestions from code review


mydea Jul 3, 2024
d7c2fd4

fix it, oops...


mydea Jul 3, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


51 changes: 36 additions & 15 deletions
packages/core/src/baseclient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,37 +390,40 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 /* eslint-disable @typescript-eslint/unified-signatures */

 /** @inheritdoc */
 public on(hook: 'spanStart', callback: (span: Span) => void): void;
 public on(hook: 'spanStart', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'spanEnd', callback: (span: Span) => void): void;
 public on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 public on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 public on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): void;
 public on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 public on(
 hook: 'afterSendEvent',
 callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void,
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 public on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /** @inheritdoc */
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 public on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /** @inheritdoc */
 public on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay: boolean }) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(
Expand All@@ -443,23 +446,41 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /** @inheritdoc */
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 public on(hook: 'flush', callback: () => void): void;
 public on(hook: 'flush', callback: () => void): () => void;

 public on(hook: 'close', callback: () => void): void;
 public on(hook: 'close', callback: () => void): () => void;

 /** @inheritdoc */
 public on(hook: string, callback: unknown): void {
 public on(hook: string, callback: unknown): () => void {
 // Note that the code below, with nullish coalescing assignment,
 // may reduce the code, so it may be switched to when Node 14 support
 // is dropped (the `??=` operator is supported since Node 15).
 // (this._hooks[hook] ??= []).push(callback);
 if (!this._hooks[hook]) {
 this._hooks[hook] = [];
 }

 // @ts-expect-error We assue the types are correct
 this._hooks[hook].push(callback);

 // This function returns a callback execution handler that, when invoked,
 // deregisters a callback. This is crucial for managing instances where callbacks
 // need to be unregistered to prevent self-referencing in callback closures,
 // ensuring proper garbage collection.
 return () => {
 const hooks = this._hooks[hook];

 if (hooks) {
 // @ts-expect-error We assue the types are correct
 const cbIndex = hooks.indexOf(callback);
 hooks.splice(cbIndex, 1);
 }
 };
 }

 /** @inheritdoc */
Expand Down

52 changes: 52 additions & 0 deletions
packages/core/test/lib/base.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2014,4 +2014,56 @@ describe('BaseClient', () => {
 });
 });
 });

 describe('hook removal with `on`', () => {
 it('should return a cleanup function that, when executed, unregisters a hook', async () => {
 expect.assertions(8);

 const client = new TestClient(
 getDefaultTestClientOptions({
 dsn: PUBLIC_DSN,
 enableSend: true,
 }),
 );

 const mockSend = jest.spyOn(client.getTransport()!, 'send').mockImplementation(() => {
 return Promise.resolve({ statusCode: 200 });
 });

 const errorEvent: Event = { message: 'error' };

 const callback = jest.fn();
 const removeAfterSendEventListenerFn = client.on('afterSendEvent', callback);

 expect(client['_hooks']['afterSendEvent']).toEqual([callback]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(1);
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });

 // Should unregister `afterSendEvent` callback.
 removeAfterSendEventListenerFn();
 expect(client['_hooks']['afterSendEvent']).toEqual([]);

 client.sendEvent(errorEvent);
 jest.runAllTimers();
 // Wait for two ticks
 // note that for whatever reason, await new Promise(resolve => setTimeout(resolve, 0)) causes the test to hang
 await undefined;
 await undefined;

 expect(mockSend).toBeCalledTimes(2);
 // Note that the `callback` has still been called only once and not twice,
 // because we unregistered it.
 expect(callback).toBeCalledTimes(1);
 expect(callback).toBeCalledWith(errorEvent, { statusCode: 200 });
 });
 });
});

43 changes: 29 additions & 14 deletions
packages/types/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -181,12 +181,14 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is started.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanStart', callback: (span: Span) => void): void;
 on(hook: 'spanStart', callback: (span: Span) => void): () => void;
@Lms24Lms24Apr 25, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a comment to the JSDocs about what's returned from the methods
@arturovtarturovtMay 3, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I addressed your comments, I see there're some random failures happening between commits, not sure if they're related...

 /**
 * Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
 * property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSampling',
Expand All@@ -204,83 +206,96 @@ export interface Client<O extends ClientOptions = ClientOptions> {
 /**
 * Register a callback for whenever a span is ended.
 * Receives the span as argument.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'spanEnd', callback: (span: Span) => void): void;
 on(hook: 'spanEnd', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for when an idle span is allowed to auto-finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
 on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;

 /**
 * Register a callback for transaction start and finish.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
 on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;

 /**
 * Register a callback for before sending an event.
 * This is called right before an event is sent and should not be used to mutate the event.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for preprocessing an event,
 * before it is passed to (global) event processors.
 * Receives an Event & EventHint as arguments.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
 on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;

 /**
 * Register a callback for when an event has been sent.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
 on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;

 /**
 * Register a callback before a breadcrumb is added.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
 on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;

 /**
 * Register a callback when a DSC (Dynamic Sampling Context) is created.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
 on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;

 /**
 * Register a callback when a Feedback event has been prepared.
 * This should be used to mutate the event. The options argument can hint
 * about what kind of mutation it expects.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'beforeSendFeedback',
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): void;
 ): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(
 hook: 'startPageLoadSpan',
 callback: (
 options: StartSpanOptions,
 traceOptions?: { sentryTrace?: string | undefined; baggage?: string | undefined },
 ) => void,
 ): void;
 ): () => void;

 /**
 * A hook for browser tracing integrations to trigger a span for a navigation.
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
 on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;

 /**
 * A hook that is called when the client is flushing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'flush', callback: () => void): void;
 on(hook: 'flush', callback: () => void): () => void;

 /**
 * A hook that is called when the client is closing
 * @returns A function that, when executed, removes the registered callback.
 */
 on(hook: 'close', callback: () => void): void;
 on(hook: 'close', callback: () => void): () => void;

 /** Fire a hook whener a span starts. */
 emit(hook: 'spanStart', span: Span): void;
Expand Down