Merge branch 'master' of github.com:getsentry/sentry-javascript

Author: HazAT

CHANGELOG.md

@@ -5,6 +5,7 @@
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 
 - [apm] fix: Use proper type name for op #2584
+- [apm] fix: Improve bundle size by moving span status to @sentry/apm #2589
 
 ## 5.16.0
 

packages/apm/src/hubextensions.ts

@@ -20,11 +20,11 @@ function traceHeaders(): { [key: string]: string } {
 }
 
 /**
- * This functions starts a span. If argument passed is of type `Span`, it'll run sampling on it if configured
- * and attach a `SpanRecorder`. If it's of type `SpanContext` and there is already a `Span` on the Scope,
- * the created Span will have a reference to it and become it's child. Otherwise it'll crete a new `Span`.
+ * This functions starts a span. If there is already a `Span` on the Scope,
+ * the created Span with the SpanContext will have a reference to it and become it's child.
+ * Otherwise it'll crete a new `Span`.
  *
- * @param spanContext Already constructed span or properties with which the span should be created
+ * @param spanContext Properties with which the span should be created
  */
 function startSpan(spanContext?: SpanContext): Span {
   // @ts-ignore

packages/apm/src/index.ts

@@ -4,5 +4,7 @@ import * as ApmIntegrations from './integrations';
 export { ApmIntegrations as Integrations };
 export { Span, TRACEPARENT_REGEXP } from './span';
 
+export { SpanStatus } from './spanstatus';
+
 // We are patching the global object with our hub extension methods
 addExtensionMethods();

packages/apm/src/integrations/tracing.ts

@@ -1,5 +1,5 @@
 import { Hub, Scope } from '@sentry/hub';
-import { Event, EventProcessor, Integration, Span, SpanContext, SpanStatus } from '@sentry/types';
+import { Event, EventProcessor, Integration, Span, SpanContext } from '@sentry/types';
 import {
   addInstrumentationHandler,
   getGlobalObject,
@@ -9,6 +9,7 @@ import {
 } from '@sentry/utils';
 
 import { Span as SpanClass } from '../span';
+import { SpanStatus } from '../spanstatus';
 
 /**
  * Options for Tracing integration

packages/apm/src/span.ts

@@ -1,9 +1,11 @@
 // tslint:disable:max-classes-per-file
 
 import { getCurrentHub, Hub } from '@sentry/hub';
-import { Span as SpanInterface, SpanContext, SpanStatus } from '@sentry/types';
+import { Span as SpanInterface, SpanContext } from '@sentry/types';
 import { dropUndefinedKeys, isInstanceOf, logger, timestampWithMs, uuid4 } from '@sentry/utils';
 
+import { SpanStatus } from './spanstatus';
+
 // TODO: Should this be exported?
 export const TRACEPARENT_REGEXP = new RegExp(
   '^[ \\t]*' + // whitespace
@@ -66,7 +68,7 @@ export class Span implements SpanInterface, SpanContext {
   /**
    * Internal keeper of the status
    */
-  private _status?: SpanStatus;
+  private _status?: SpanStatus | string;
 
   /**
    * @inheritDoc

packages/apm/src/spanstatus.ts

@@ -0,0 +1,87 @@
+/** The status of an Span. */
+export enum SpanStatus {
+  /** The operation completed successfully. */
+  Ok = 'ok',
+  /** Deadline expired before operation could complete. */
+  DeadlineExceeded = 'deadline_exceeded',
+  /** 401 Unauthorized (actually does mean unauthenticated according to RFC 7235) */
+  Unauthenticated = 'unauthenticated',
+  /** 403 Forbidden */
+  PermissionDenied = 'permission_denied',
+  /** 404 Not Found. Some requested entity (file or directory) was not found. */
+  NotFound = 'not_found',
+  /** 429 Too Many Requests */
+  ResourceExhausted = 'resource_exhausted',
+  /** Client specified an invalid argument. 4xx. */
+  InvalidArgument = 'invalid_argument',
+  /** 501 Not Implemented */
+  Unimplemented = 'unimplemented',
+  /** 503 Service Unavailable */
+  Unavailable = 'unavailable',
+  /** Other/generic 5xx. */
+  InternalError = 'internal_error',
+  /** Unknown. Any non-standard HTTP status code. */
+  UnknownError = 'unknown_error',
+  /** The operation was cancelled (typically by the user). */
+  Cancelled = 'cancelled',
+  /** Already exists (409) */
+  AlreadyExists = 'already_exists',
+  /** Operation was rejected because the system is not in a state required for the operation's */
+  FailedPrecondition = 'failed_precondition',
+  /** The operation was aborted, typically due to a concurrency issue. */
+  Aborted = 'aborted',
+  /** Operation was attempted past the valid range. */
+  OutOfRange = 'out_of_range',
+  /** Unrecoverable data loss or corruption */
+  DataLoss = 'data_loss',
+}
+
+// tslint:disable:no-unnecessary-qualifier no-namespace
+export namespace SpanStatus {
+  /**
+   * Converts a HTTP status code into a {@link SpanStatus}.
+   *
+   * @param httpStatus The HTTP response status code.
+   * @returns The span status or {@link SpanStatus.UnknownError}.
+   */
+  // tslint:disable-next-line:completed-docs
+  export function fromHttpCode(httpStatus: number): SpanStatus {
+    if (httpStatus < 400) {
+      return SpanStatus.Ok;
+    }
+
+    if (httpStatus >= 400 && httpStatus < 500) {
+      switch (httpStatus) {
+        case 401:
+          return SpanStatus.Unauthenticated;
+        case 403:
+          return SpanStatus.PermissionDenied;
+        case 404:
+          return SpanStatus.NotFound;
+        case 409:
+          return SpanStatus.AlreadyExists;
+        case 413:
+          return SpanStatus.FailedPrecondition;
+        case 429:
+          return SpanStatus.ResourceExhausted;
+        default:
+          return SpanStatus.InvalidArgument;
+      }
+    }
+
+    if (httpStatus >= 500 && httpStatus < 600) {
+      switch (httpStatus) {
+        case 501:
+          return SpanStatus.Unimplemented;
+        case 503:
+          return SpanStatus.Unavailable;
+        case 504:
+          return SpanStatus.DeadlineExceeded;
+        default:
+          return SpanStatus.InternalError;
+      }
+    }
+
+    return SpanStatus.UnknownError;
+  }
+}

packages/apm/test/span.test.ts

@@ -1,8 +1,7 @@
 import { BrowserClient } from '@sentry/browser';
 import { Hub, Scope } from '@sentry/hub';
-import { SpanStatus } from '@sentry/types';
 
-import { Span, TRACEPARENT_REGEXP } from '../src';
+import { Span, SpanStatus, TRACEPARENT_REGEXP } from '../src';
 
 describe('Span', () => {
   let hub: Hub;

packages/types/src/hub.ts

@@ -173,11 +173,11 @@ export interface Hub {
   traceHeaders(): { [key: string]: string };
 
   /**
-   * This functions starts a span. If argument passed is of type `Span`, it'll run sampling on it if configured
-   * and attach a `SpanRecorder`. If it's of type `SpanContext` and there is already a `Span` on the Scope,
-   * the created Span will have a reference to it and become it's child. Otherwise it'll crete a new `Span`.
+   * This functions starts a span. If there is already a `Span` on the Scope,
+   * the created Span with the SpanContext will have a reference to it and become it's child.
+   * Otherwise it'll crete a new `Span`.
    *
-   * @param span Already constructed span which should be started or properties with which the span should be created
+   * @param spanContext Properties with which the span should be created
    */
-  startSpan(span?: Span | SpanContext, forceNoChild?: boolean): Span;
+  startSpan(spanContext?: SpanContext): Span;
 }

packages/types/src/index.ts

@@ -17,7 +17,7 @@ export { Runtime } from './runtime';
 export { Scope } from './scope';
 export { SdkInfo } from './sdkinfo';
 export { Severity } from './severity';
-export { Span, SpanContext, SpanStatus } from './span';
+export { Span, SpanContext } from './span';
 export { StackFrame } from './stackframe';
 export { Stacktrace } from './stacktrace';
 export { Status } from './status';

packages/types/src/span.ts

@@ -46,9 +46,10 @@ export interface Span {
 
   /**
    * Sets the status attribute on the current span
+   * See: {@sentry/apm SpanStatus} for possible values
    * @param status http code used to set the status
    */
-  setStatus(status: SpanStatus): this;
+  setStatus(status: string): this;
 
   /**
    * Sets the status attribute on the current span based on the http code
@@ -87,8 +88,9 @@ export interface SpanContext {
   op?: string;
   /**
    * Completion status of the Span.
+   * See: {@sentry/apm SpanStatus} for possible values
    */
-  status?: SpanStatus;
+  status?: string;
   /**
    * Parent Span ID
    */
@@ -119,91 +121,3 @@ export interface SpanContext {
    */
   data?: { [key: string]: any };
 }
-
-/** The status of an Span. */
-export enum SpanStatus {
-  /** The operation completed successfully. */
-  Ok = 'ok',
-  /** Deadline expired before operation could complete. */
-  DeadlineExceeded = 'deadline_exceeded',
-  /** 401 Unauthorized (actually does mean unauthenticated according to RFC 7235) */
-  Unauthenticated = 'unauthenticated',
-  /** 403 Forbidden */
-  PermissionDenied = 'permission_denied',
-  /** 404 Not Found. Some requested entity (file or directory) was not found. */
-  NotFound = 'not_found',
-  /** 429 Too Many Requests */
-  ResourceExhausted = 'resource_exhausted',
-  /** Client specified an invalid argument. 4xx. */
-  InvalidArgument = 'invalid_argument',
-  /** 501 Not Implemented */
-  Unimplemented = 'unimplemented',
-  /** 503 Service Unavailable */
-  Unavailable = 'unavailable',
-  /** Other/generic 5xx. */
-  InternalError = 'internal_error',
-  /** Unknown. Any non-standard HTTP status code. */
-  UnknownError = 'unknown_error',
-  /** The operation was cancelled (typically by the user). */
-  Cancelled = 'cancelled',
-  /** Already exists (409) */
-  AlreadyExists = 'already_exists',
-  /** Operation was rejected because the system is not in a state required for the operation's */
-  FailedPrecondition = 'failed_precondition',
-  /** The operation was aborted, typically due to a concurrency issue. */
-  Aborted = 'aborted',
-  /** Operation was attempted past the valid range. */
-  OutOfRange = 'out_of_range',
-  /** Unrecoverable data loss or corruption */
-  DataLoss = 'data_loss',
-}
-
-// tslint:disable:no-unnecessary-qualifier no-namespace
-export namespace SpanStatus {
-  /**
-   * Converts a HTTP status code into a {@link SpanStatus}.
-   *
-   * @param httpStatus The HTTP response status code.
-   * @returns The span status or {@link SpanStatus.UnknownError}.
-   */
-  // tslint:disable-next-line:completed-docs
-  export function fromHttpCode(httpStatus: number): SpanStatus {
-    if (httpStatus < 400) {
-      return SpanStatus.Ok;
-    }
-
-    if (httpStatus >= 400 && httpStatus < 500) {
-      switch (httpStatus) {
-        case 401:
-          return SpanStatus.Unauthenticated;
-        case 403:
-          return SpanStatus.PermissionDenied;
-        case 404:
-          return SpanStatus.NotFound;
-        case 409:
-          return SpanStatus.AlreadyExists;
-        case 413:
-          return SpanStatus.FailedPrecondition;
-        case 429:
-          return SpanStatus.ResourceExhausted;
-        default:
-          return SpanStatus.InvalidArgument;
-      }
-    }
-
-    if (httpStatus >= 500 && httpStatus < 600) {
-      switch (httpStatus) {
-        case 501:
-          return SpanStatus.Unimplemented;
-        case 503:
-          return SpanStatus.Unavailable;
-        case 504:
-          return SpanStatus.DeadlineExceeded;
-        default:
-          return SpanStatus.InternalError;
-      }
-    }
-
-    return SpanStatus.UnknownError;
-  }
-}