Move HTTPClient integration to @sentry/integrations.

Author: onurtemizkan

packages/browser/src/exports.ts

@@ -58,4 +58,4 @@ export {
   winjsStackLineParser,
 } from './stack-parsers';
 export { defaultIntegrations, forceLoad, init, lastEventId, onLoad, showReportDialog, flush, close, wrap } from './sdk';
-export { GlobalHandlers, TryCatch, Breadcrumbs, LinkedErrors, HttpContext, HttpClient, Dedupe } from './integrations';
+export { GlobalHandlers, TryCatch, Breadcrumbs, LinkedErrors, HttpContext, Dedupe } from './integrations';

packages/browser/src/integrations/index.ts

@@ -4,4 +4,3 @@ export { Breadcrumbs } from './breadcrumbs';
 export { LinkedErrors } from './linkederrors';
 export { HttpContext } from './httpcontext';
 export { Dedupe } from './dedupe';
-export { HttpClient } from './httpclient';

packages/integration-tests/suites/integrations/httpclient/init.js

@@ -1,10 +1,11 @@
 import * as Sentry from '@sentry/browser';
+import { HttpClient } from '@sentry/integrations';
 
 window.Sentry = Sentry;
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
-  integrations: [new Sentry.Integrations.HttpClient()],
+  integrations: [new HttpClient()],
   tracesSampleRate: 1,
   sendDefaultPii: true,
 });

packages/browser/src/integrations/httpclient.ts renamed to packages/integrations/src/httpclient.ts

@@ -1,9 +1,6 @@
-import { captureEvent, getCurrentHub } from '@sentry/core';
-import { Event as SentryEvent, Integration } from '@sentry/types';
+import { Event as SentryEvent, EventProcessor, Hub, Integration } from '@sentry/types';
 import { addExceptionMechanism, fill, GLOBAL_OBJ, logger, supportsNativeFetch } from '@sentry/utils';
 
-import { eventFromUnknownInput } from '../eventbuilder';
-
 export type HttpStatusCodeRange = [number, number] | number;
 export type HttpRequestTarget = string | RegExp;
 interface HttpClientOptions {
@@ -41,6 +38,11 @@ export class HttpClient implements Integration {
 
   private readonly _options: HttpClientOptions;
 
+  /**
+   * Returns current hub.
+   */
+  private _getCurrentHub?: () => Hub;
+
   /**
    * @inheritDoc
    *
@@ -59,7 +61,8 @@ export class HttpClient implements Integration {
    *
    * @param options
    */
-  public setupOnce(): void {
+  public setupOnce(_: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
+    this._getCurrentHub = getCurrentHub;
     this._wrapFetch();
     this._wrapXHR();
   }
@@ -72,12 +75,12 @@ export class HttpClient implements Integration {
    * @param requestInit The request init object
    */
   private _fetchResponseHandler(requestInfo: RequestInfo, response: Response, requestInit?: RequestInit): void {
-    if (this._shouldCaptureResponse(response.status, response.url)) {
+    if (this._getCurrentHub && this._shouldCaptureResponse(response.status, response.url)) {
       const request = new Request(requestInfo, requestInit);
 
       let requestHeaders, responseHeaders, requestCookies, responseCookies;
 
-      if (getCurrentHub().shouldSendDefaultPii()) {
+      if (this._getCurrentHub().shouldSendDefaultPii()) {
         [{ headers: requestHeaders, cookies: requestCookies }, { headers: responseHeaders, cookies: responseCookies }] =
           [
             { cookieHeader: 'Cookie', obj: request },
@@ -113,7 +116,7 @@ export class HttpClient implements Integration {
         responseCookies,
       });
 
-      captureEvent(event);
+      this._getCurrentHub().captureEvent(event);
     }
   }
 
@@ -125,10 +128,10 @@ export class HttpClient implements Integration {
    * @param headers The HTTP headers
    */
   private _xhrResponseHandler(xhr: XMLHttpRequest, method: string, headers: Record<string, string>): void {
-    if (this._shouldCaptureResponse(xhr.status, xhr.responseURL)) {
+    if (this._getCurrentHub && this._shouldCaptureResponse(xhr.status, xhr.responseURL)) {
       let requestHeaders, responseCookies, responseHeaders;
 
-      if (getCurrentHub().shouldSendDefaultPii()) {
+      if (this._getCurrentHub().shouldSendDefaultPii()) {
         try {
           const cookieString = xhr.getResponseHeader('Set-Cookie') || xhr.getResponseHeader('set-cookie') || undefined;
 
@@ -158,7 +161,7 @@ export class HttpClient implements Integration {
         responseCookies,
       });
 
-      captureEvent(event);
+      this._getCurrentHub().captureEvent(event);
     }
   }
 
@@ -362,7 +365,7 @@ export class HttpClient implements Integration {
    * @param url url to verify
    */
   private _isSentryRequest(url: string): boolean {
-    const client = getCurrentHub().getClient();
+    const client = this._getCurrentHub && this._getCurrentHub().getClient();
 
     if (!client) {
       return false;
@@ -397,22 +400,31 @@ export class HttpClient implements Integration {
     requestHeaders?: Record<string, string>;
     requestCookies?: Record<string, string>;
   }): SentryEvent {
-    const event = eventFromUnknownInput(() => [], `HTTP Client Error with status code: ${data.status}`);
-
-    event.request = {
-      url: data.url,
-      method: data.method,
-      headers: data.requestHeaders,
-      cookies: data.requestCookies,
-    };
-
-    event.contexts = {
-      ...event.contexts,
-      response: {
-        status_code: data.status,
-        headers: data.responseHeaders,
-        cookies: data.responseCookies,
-        body_size: this._getResponseSizeFromHeaders(data.responseHeaders),
+    const message = `HTTP Client Error with status code: ${data.status}`;
+
+    const event: SentryEvent = {
+      message,
+      exception: {
+        values: [
+          {
+            type: 'Error',
+            value: message,
+          },
+        ],
+      },
+      request: {
+        url: data.url,
+        method: data.method,
+        headers: data.requestHeaders,
+        cookies: data.requestCookies,
+      },
+      contexts: {
+        response: {
+          status_code: data.status,
+          headers: data.responseHeaders,
+          cookies: data.responseCookies,
+          body_size: this._getResponseSizeFromHeaders(data.responseHeaders),
+        },
       },
     };
 

packages/integrations/src/index.ts

@@ -7,3 +7,4 @@ export { ReportingObserver } from './reportingobserver';
 export { RewriteFrames } from './rewriteframes';
 export { SessionTiming } from './sessiontiming';
 export { Transaction } from './transaction';
+export { HttpClient } from './httpclient';

packages/types/src/hub.ts

@@ -227,4 +227,10 @@ export interface Hub {
    * @param endSession If set the session will be marked as exited and removed from the scope
    */
   captureSession(endSession?: boolean): void;
+
+  /**
+   * Returns if default PII should be sent to Sentry and propagated in ourgoing requests
+   * when Tracing is used.
+   */
+  shouldSendDefaultPii(): boolean;
 }