Skip to content

fix(core): Make FunctionToString integration use SETUP_CLIENTS weakmap #10358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 25 additions & 2 deletions packages/core/src/integrations/functiontostring.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
import type { Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import type { Client, Integration, IntegrationClass, IntegrationFn, WrappedFunction } from '@sentry/types';
import { getOriginalFunction } from '@sentry/utils';
import { getClient } from '../exports';
import { convertIntegrationFnToClass, defineIntegration } from '../integration';

let originalFunctionToString: () => void;

const INTEGRATION_NAME = 'FunctionToString';

const SETUP_CLIENTS = new WeakMap<Client, boolean>();

const _functionToStringIntegration = (() => {
return {
name: INTEGRATION_NAME,
Expand All @@ -18,24 +21,44 @@ const _functionToStringIntegration = (() => {
try {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Function.prototype.toString = function (this: WrappedFunction, ...args: any[]): string {
const context = getOriginalFunction(this) || this;
const originalFunction = getOriginalFunction(this);
const context =
SETUP_CLIENTS.has(getClient() as Client) && originalFunction !== undefined ? originalFunction : this;
return originalFunctionToString.apply(context, args);
};
} catch {
// ignore errors here, just don't patch this
}
},
setup(client) {
SETUP_CLIENTS.set(client, true);
},
};
}) satisfies IntegrationFn;

/**
* Patch toString calls to return proper name for wrapped functions.
*
* ```js
* Sentry.init({
* integrations: [
* functionToStringIntegration(),
* ],
* });
* ```
*/
export const functionToStringIntegration = defineIntegration(_functionToStringIntegration);

/**
* Patch toString calls to return proper name for wrapped functions.
*
* @deprecated Use `functionToStringIntegration()` instead.
*/
// eslint-disable-next-line deprecation/deprecation
export const FunctionToString = convertIntegrationFnToClass(
INTEGRATION_NAME,
functionToStringIntegration,
) as IntegrationClass<Integration & { setupOnce: () => void }>;

// eslint-disable-next-line deprecation/deprecation
export type FunctionToString = typeof FunctionToString;
42 changes: 37 additions & 5 deletions packages/core/test/lib/integrations/functiontostring.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
import { fill } from '../../../../utils/src/object';
import { FunctionToString } from '../../../src/integrations/functiontostring';
import { fill } from '@sentry/utils';
import { getClient, getCurrentScope, setCurrentClient } from '../../../src';
import { functionToStringIntegration } from '../../../src/integrations/functiontostring';
import { TestClient, getDefaultTestClientOptions } from '../../mocks/client';

describe('FunctionToString', () => {
beforeEach(() => {
const testClient = new TestClient(getDefaultTestClientOptions({}));
setCurrentClient(testClient);
});

afterAll(() => {
getCurrentScope().setClient(undefined);
});

it('it works as expected', () => {
const foo = {
bar(wat: boolean): boolean {
Expand All @@ -17,10 +28,31 @@ describe('FunctionToString', () => {

expect(foo.bar.toString()).not.toBe(originalFunction);

// eslint-disable-next-line deprecation/deprecation
const fts = new FunctionToString();
fts.setupOnce();
const fts = functionToStringIntegration();
getClient()?.addIntegration?.(fts);

expect(foo.bar.toString()).toBe(originalFunction);
});

it('does not activate when client is not active', () => {
const foo = {
bar(wat: boolean): boolean {
return wat;
},
};
const originalFunction = foo.bar.toString();
fill(foo, 'bar', function wat(whatever: boolean): () => void {
return function watwat(): boolean {
return whatever;
};
});

expect(foo.bar.toString()).not.toBe(originalFunction);

const testClient = new TestClient(getDefaultTestClientOptions({}));
const fts = functionToStringIntegration();
testClient.addIntegration(fts);

expect(foo.bar.toString()).not.toBe(originalFunction);
});
});