Merge branch 'feat/graphqlClientIntegration' of https://github.com/Zen-cronic/sentry-javascript into feat/graphqlClientIntegration

Zen-cronic · Zen-cronic · commit 1d5fd3db14a1 · 2025-01-22T20:50:24.000-05:00
diff --git a/dev-packages/browser-integration-tests/suites/integrations/graphqlClient/fetch/test.ts b/dev-packages/browser-integration-tests/suites/integrations/graphqlClient/fetch/test.ts
@@ -13,8 +13,8 @@ const query = `query Test{
 }`;
 const queryPayload = JSON.stringify({ query });
 
-sentryTest('should update spans for GraphQL Fetch requests', async ({ getLocalTestPath, page }) => {
-  const url = await getLocalTestPath({ testDir: __dirname });
+sentryTest('should update spans for GraphQL Fetch requests', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
 
   await page.route('**/foo', route => {
     return route.fulfill({
@@ -57,8 +57,8 @@ sentryTest('should update spans for GraphQL Fetch requests', async ({ getLocalTe
   });
 });
 
-sentryTest('should update breadcrumbs for GraphQL Fetch requests', async ({ getLocalTestPath, page }) => {
-  const url = await getLocalTestPath({ testDir: __dirname });
+sentryTest('should update breadcrumbs for GraphQL Fetch requests', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
 
   await page.route('**/foo', route => {
     return route.fulfill({
diff --git a/dev-packages/browser-integration-tests/suites/integrations/graphqlClient/xhr/test.ts b/dev-packages/browser-integration-tests/suites/integrations/graphqlClient/xhr/test.ts
@@ -13,8 +13,8 @@ const query = `query Test{
 }`;
 const queryPayload = JSON.stringify({ query });
 
-sentryTest('should update spans for GraphQL XHR requests', async ({ getLocalTestPath, page }) => {
-  const url = await getLocalTestPath({ testDir: __dirname });
+sentryTest('should update spans for GraphQL XHR requests', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
 
   await page.route('**/foo', route => {
     return route.fulfill({
@@ -57,8 +57,8 @@ sentryTest('should update spans for GraphQL XHR requests', async ({ getLocalTest
   });
 });
 
-sentryTest('should update breadcrumbs for GraphQL XHR requests', async ({ getLocalTestPath, page }) => {
-  const url = await getLocalTestPath({ testDir: __dirname });
+sentryTest('should update breadcrumbs for GraphQL XHR requests', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
 
   await page.route('**/foo', route => {
     return route.fulfill({
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -12,10 +12,7 @@ export {
   captureFeedback,
 } from '@sentry/core';
 
-export {
-  replayIntegration,
-  getReplay,
-} from '@sentry-internal/replay';
+export { replayIntegration, getReplay } from '@sentry-internal/replay';
 export type {
   ReplayEventType,
   ReplayEventWithTime,
@@ -35,8 +32,6 @@ import { feedbackSyncIntegration } from './feedbackSync';
 export { feedbackAsyncIntegration, feedbackSyncIntegration, feedbackSyncIntegration as feedbackIntegration };
 export { getFeedback, sendFeedback } from '@sentry-internal/feedback';
 
-export * from './metrics';
-
 export { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from './tracing/request';
 export {
   browserTracingIntegration,
@@ -62,7 +57,7 @@ export {
   zodErrorsIntegration,
   thirdPartyErrorFilterIntegration,
 } from '@sentry/core';
-export type { Span } from '@sentry/types';
+export type { Span } from '@sentry/core';
 export { makeBrowserOfflineTransport } from './transports/offline';
 export { browserProfilingIntegration } from './profiling/integration';
 export { spotlightBrowserIntegration } from './integrations/spotlight';
@@ -73,4 +68,4 @@ export {
 } from './integrations/featureFlags';
 export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
 export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
-export { unleashIntegration } from './integrations/featureFlags/unleash';
+export { unleashIntegration } from './integrations/featureFlags/unleash';
diff --git a/packages/browser/src/integrations/breadcrumbs.ts b/packages/browser/src/integrations/breadcrumbs.ts
@@ -292,6 +292,7 @@ function _getFetchBreadcrumbHandler(client: Client): (handlerData: HandlerDataFe
     };
 
     if (handlerData.error) {
+      const data: FetchBreadcrumbData = handlerData.fetchData;
       const hint: FetchBreadcrumbHint = {
         data: handlerData.error,
         input: handlerData.args,
@@ -311,7 +312,11 @@ function _getFetchBreadcrumbHandler(client: Client): (handlerData: HandlerDataFe
       addBreadcrumb(breadcrumb, hint);
     } else {
       const response = handlerData.response as Response | undefined;
-
+      const data: FetchBreadcrumbData = {
+        ...handlerData.fetchData,
+        status_code: response && response.status,
+      };
+      
       breadcrumbData.request_body_size = handlerData.fetchData.request_body_size;
       breadcrumbData.response_body_size = handlerData.fetchData.response_body_size;
       breadcrumbData.status_code = response?.status;
diff --git a/packages/browser/src/integrations/graphqlClient.ts b/packages/browser/src/integrations/graphqlClient.ts
@@ -8,8 +8,8 @@ import {
   defineIntegration,
   spanToJSON,
 } from '@sentry/core';
-import type { Client, IntegrationFn } from '@sentry/types';
-import { isString, stringMatchesSomePattern } from '@sentry/utils';
+import type { Client, IntegrationFn } from '@sentry/core';
+import { isString, stringMatchesSomePattern } from '@sentry/core';
 
 interface GraphQLClientOptions {
   endpoints: Array<string | RegExp>;
diff --git a/packages/browser/src/tracing/request.ts b/packages/browser/src/tracing/request.ts
@@ -4,7 +4,6 @@ import {
   addXhrInstrumentationHandler,
 } from '@sentry-internal/browser-utils';
 import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/core';
-import type { XhrHint } from '@sentry-internal/replay';
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
@@ -13,6 +12,7 @@ import {
   addFetchInstrumentationHandler,
   browserPerformanceTimeOrigin,
   getActiveSpan,
+  getClient,
   getLocationHref,
   getTraceData,
   hasTracingEnabled,
@@ -21,19 +21,10 @@ import {
   setHttpStatus,
   spanToJSON,
   startInactiveSpan,
-} from '@sentry/core';
-import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/types';
-import {
-  BAGGAGE_HEADER_NAME,
-  addFetchEndInstrumentationHandler,
-  addFetchInstrumentationHandler,
-  browserPerformanceTimeOrigin,
-  dynamicSamplingContextToSentryBaggageHeader,
-  generateSentryTraceHeader,
-  parseUrl,
   stringMatchesSomePattern,
 } from '@sentry/core';
 import { WINDOW } from '../helpers';
+import { XhrHint } from '@sentry-internal/replay';
 
 /** Options for Request Instrumentation */
 export interface RequestInstrumentationOptions {
@@ -415,6 +406,7 @@ export function xhrCallback(
     );
   }
 
+  const client = getClient();
   if (client) {
     client.emit('beforeOutgoingRequestSpan', span, handlerData as XhrHint);
   }
diff --git a/packages/browser/test/integrations/graphqlClient.test.ts b/packages/browser/test/integrations/graphqlClient.test.ts
@@ -79,7 +79,7 @@ describe('GraphqlClient', () => {
         queryThree,
         { operationName: 'OnTestItemAdded', operationType: 'subscription' },
       ],
-      // ['should handle query without name', queryFour, { operationName: undefined, operationType: 'query' }],
+      // TODO: ['should handle query without name', queryFour, { operationName: undefined, operationType: 'query' }],
     ])('%s', (_, input, output) => {
       expect(parseGraphQLQuery(input)).toEqual(output);
     });
diff --git a/packages/core/src/client.ts b/packages/core/src/client.ts
@@ -594,10 +594,16 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
    */
   public on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;
 
-  /** @inheritdoc */
+  /**
+   * A hook for GraphQL client integration to enhance a span with request data.
+   * @returns A function that, when executed, removes the registered callback.
+   */
   public on(hook: 'beforeOutgoingRequestSpan', callback: (span: Span, hint: XhrHint | FetchHint) => void): () => void;
 
-  /** @inheritdoc */
+  /**
+   * A hook for GraphQL client integration to enhance a breadcrumb with request data.
+   * @returns A function that, when executed, removes the registered callback.
+   */
   public on(
     hook: 'beforeOutgoingRequestBreadcrumb',
     callback: (breadcrumb: Breadcrumb, hint: XhrHint | FetchHint) => void,
@@ -729,13 +735,19 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
    */
   public emit(hook: 'startNavigationSpan', options: StartSpanOptions): void;
 
-  /** @inheritdoc */
+  /**
+   * Emit a hook event for GraphQL client integration to enhance a span with request data.
+   */
   public emit(hook: 'beforeOutgoingRequestSpan', span: Span, hint: XhrHint | FetchHint): void;
 
-  /** @inheritdoc */
+  /**
+  * Emit a hook event for GraphQL client integration to enhance a breadcrumb with request data.
+  */
   public emit(hook: 'beforeOutgoingRequestBreadcrumb', breadcrumb: Breadcrumb, hint: XhrHint | FetchHint): void;
 
-  /** @inheritdoc */
+  /**
+   * Emit a hook event for client flush
+   */
   public emit(hook: 'flush'): void;
 
   /**
diff --git a/packages/core/src/fetch.ts b/packages/core/src/fetch.ts
@@ -1,13 +1,5 @@
-import type { Client, HandlerDataFetch, Scope, Span, SpanOrigin } from '@sentry/types';
-import {
-  BAGGAGE_HEADER_NAME,
-  dynamicSamplingContextToSentryBaggageHeader,
-  generateSentryTraceHeader,
-  isInstanceOf,
-  parseUrl,
-} from '@sentry/utils';
-import type { FetchHint } from './baseclient';
-import { getClient, getCurrentScope, getIsolationScope } from './currentScopes';
+import { FetchHint } from './client';
+import { getClient } from './currentScopes';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from './semanticAttributes';
 import { SPAN_STATUS_ERROR, setHttpStatus, startInactiveSpan } from './tracing';
 import { SentryNonRecordingSpan } from './tracing/sentryNonRecordingSpan';
@@ -60,9 +52,6 @@ export function instrumentFetchRequest(
     return undefined;
   }
 
-  const scope = getCurrentScope();
-  const client = getClient();
-
   const { method, url } = handlerData.fetchData;
 
   const fullUrl = getFullURL(url);
@@ -109,6 +98,7 @@ export function instrumentFetchRequest(
     }
   }
 
+  const client = getClient();
   if (client) {
     // There's no 'input' key in HandlerDataFetch
     const fetchHint = {
diff --git a/packages/core/test/utils-hoist/graphql.test.ts b/packages/core/test/utils-hoist/graphql.test.ts
diff --git a/packages/types/src/client.ts b/packages/types/src/client.ts
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
diff --git a/packages/utils/test/instrument/fetch.test.ts b/packages/utils/test/instrument/fetch.test.ts
