Skip to content

fix(node): Ensure graphql options are correct when preloading #13769

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 3 commits into from
Oct 8, 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
21 changes: 14 additions & 7 deletions packages/node/src/integrations/tracing/graphql.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,7 @@ const INTEGRATION_NAME = 'Graphql';
export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
INTEGRATION_NAME,
(_options: GraphqlOptions = {}) => {
const options = {
ignoreResolveSpans: true,
ignoreTrivialResolveSpans: true,
useOperationNameForRootSpan: true,
..._options,
};
const options = getOptionsWithDefaults(_options);

return new GraphQLInstrumentation({
...options,
Expand Down Expand Up @@ -89,7 +84,10 @@ const _graphqlIntegration = ((options: GraphqlOptions = {}) => {
return {
name: INTEGRATION_NAME,
setupOnce() {
instrumentGraphql(options);
// We set defaults here, too, because otherwise we'd update the instrumentation config
// to the config without defaults, as `generateInstrumentOnce` automatically calls `setConfig(options)`
// when being called the second time
instrumentGraphql(getOptionsWithDefaults(options));
},
};
}) satisfies IntegrationFn;
Expand All @@ -100,3 +98,12 @@ const _graphqlIntegration = ((options: GraphqlOptions = {}) => {
* Capture tracing data for GraphQL.
*/
export const graphqlIntegration = defineIntegration(_graphqlIntegration);

function getOptionsWithDefaults(options?: GraphqlOptions): GraphqlOptions {
return {
ignoreResolveSpans: true,
ignoreTrivialResolveSpans: true,
useOperationNameForRootSpan: true,
...options,
};
}
3 changes: 2 additions & 1 deletion packages/node/src/otel/instrument.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import type { Instrumentation } from '@opentelemetry/instrumentation';
import { addOpenTelemetryInstrumentation } from '@sentry/opentelemetry';

const INSTRUMENTED: Record<string, Instrumentation> = {};
/** Exported only for tests. */
export const INSTRUMENTED: Record<string, Instrumentation> = {};

/**
* Instrument an OpenTelemetry instrumentation once.
Expand Down
46 changes: 46 additions & 0 deletions packages/node/test/integrations/tracing/graphql.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { GraphQLInstrumentation } from '@opentelemetry/instrumentation-graphql';
import { graphqlIntegration, instrumentGraphql } from '../../../src/integrations/tracing/graphql';
import { INSTRUMENTED } from '../../../src/otel/instrument';

jest.mock('@opentelemetry/instrumentation-graphql');

describe('GraphQL', () => {
beforeEach(() => {
jest.clearAllMocks();
delete INSTRUMENTED.Graphql;

(GraphQLInstrumentation as unknown as jest.SpyInstance).mockImplementation(() => {
return {
setTracerProvider: () => undefined,
setMeterProvider: () => undefined,
getConfig: () => ({}),
setConfig: () => ({}),
enable: () => undefined,
};
});
});

it('defaults are correct for instrumentGraphql', () => {
instrumentGraphql({ ignoreTrivialResolveSpans: false });

expect(GraphQLInstrumentation).toHaveBeenCalledTimes(1);
expect(GraphQLInstrumentation).toHaveBeenCalledWith({
ignoreResolveSpans: true,
ignoreTrivialResolveSpans: false,
useOperationNameForRootSpan: true,
responseHook: expect.any(Function),
});
});

it('defaults are correct for _graphqlIntegration', () => {
graphqlIntegration({ ignoreTrivialResolveSpans: false }).setupOnce!();

expect(GraphQLInstrumentation).toHaveBeenCalledTimes(1);
expect(GraphQLInstrumentation).toHaveBeenCalledWith({
ignoreResolveSpans: true,
ignoreTrivialResolveSpans: false,
useOperationNameForRootSpan: true,
responseHook: expect.any(Function),
});
});
});
Loading