add tests

Author: lobsterkatie

packages/node/package.json

@@ -35,6 +35,7 @@
     "eslint": "7.6.0",
     "express": "^4.17.1",
     "jest": "^24.7.1",
+    "nock": "^13.0.5",
     "npm-run-all": "^4.1.2",
     "prettier": "1.19.0",
     "rimraf": "^2.6.3",

packages/node/test/integrations/http.test.ts

@@ -1,22 +1,91 @@
-import { RequestOptions } from 'http';
-
-import { extractUrl } from './../../src/integrations/http';
-
-describe('extractUrl()', () => {
-  const urlString = 'http://dogs.are.great:1231/yay/';
-  const urlParts: RequestOptions = {
-    protocol: 'http:',
-    host: 'dogs.are.great',
-    method: 'GET',
-    path: '/yay/',
-    port: 1231,
-  };
-
-  it('accepts a url string', () => {
-    expect(extractUrl(urlString)).toBe(urlString);
+import * as sentryCore from '@sentry/core';
+import { Hub } from '@sentry/hub';
+import * as hubModule from '@sentry/hub';
+import { addExtensionMethods, Span, TRACEPARENT_REGEXP, Transaction } from '@sentry/tracing';
+import * as http from 'http';
+import * as nock from 'nock';
+
+import { NodeClient } from '../../src/client';
+import { Http as HttpIntegration } from '../../src/integrations/http';
+
+describe('tracing', () => {
+  function createTransactionOnScope() {
+    const hub = new Hub(
+      new NodeClient({
+        dsn: 'https://[email protected]/12312012',
+        tracesSampleRate: 1.0,
+        integrations: [new HttpIntegration({ tracing: true })],
+      }),
+    );
+    addExtensionMethods();
+
+    // we need to mock both of these because the tracing handler relies on `@sentry/core` while the sampler relies on
+    // `@sentry/hub`, and mocking breaks the link between the two
+    jest.spyOn(sentryCore, 'getCurrentHub').mockReturnValue(hub);
+    jest.spyOn(hubModule, 'getCurrentHub').mockReturnValue(hub);
+
+    const transaction = hub.startTransaction({ name: 'dogpark' });
+    hub.getScope()?.setSpan(transaction);
+
+    return transaction;
+  }
+
+  it("creates a span for each outgoing non-sentry request when there's a transaction on the scope", () => {
+    nock('http://dogs.are.great')
+      .get('/')
+      .reply(200);
+
+    const transaction = createTransactionOnScope();
+    const spans = (transaction as Span).spanRecorder?.spans as Span[];
+
+    http.get('http://dogs.are.great/');
+
+    // TODO: For some reason in node 6 two request spans are appearing. Once we stop testing against it, this can go
+    // back to being `toEqual()`.
+    expect(spans.length).toBeGreaterThanOrEqual(2);
+    expect(spans[1].description).toEqual('GET http://dogs.are.great/');
+    expect(spans[1].op).toEqual('request');
+  });
+
+  it("doesn't create a span for outgoing sentry requests", () => {
+    nock('http://squirrelchasers.ingest.sentry.io')
+      .get('/api/12312012/store/')
+      .reply(200);
+
+    const transaction = createTransactionOnScope();
+    const spans = (transaction as Span).spanRecorder?.spans as Span[];
+
+    http.get('http://squirrelchasers.ingest.sentry.io/api/12312012/store/');
+
+    // only the transaction itself should be there
+    expect(spans.length).toEqual(1);
+    expect((spans[0] as Transaction).name).toEqual('dogpark');
   });
 
-  it('accepts a http.RequestOptions object and returns a string with everything in the right place', () => {
-    expect(extractUrl(urlParts)).toBe(urlString);
+  it('attaches the sentry-trace header to outgoing non-sentry requests', async () => {
+    nock('http://dogs.are.great')
+      .get('/')
+      .reply(200);
+
+    createTransactionOnScope();
+
+    const request = http.get('http://dogs.are.great/');
+    const sentryTraceHeader = request.getHeader('sentry-trace') as string;
+
+    expect(sentryTraceHeader).toBeDefined();
+    expect(TRACEPARENT_REGEXP.test(sentryTraceHeader)).toBe(true);
+  });
+
+  it("doesn't attach the sentry-trace header to outgoing sentry requests", () => {
+    nock('http://squirrelchasers.ingest.sentry.io')
+      .get('/api/12312012/store/')
+      .reply(200);
+
+    createTransactionOnScope();
+
+    const request = http.get('http://squirrelchasers.ingest.sentry.io/api/12312012/store/');
+    const sentryTraceHeader = request.getHeader('sentry-trace');
+
+    expect(sentryTraceHeader).not.toBeDefined();
   });
 });

packages/tracing/src/index.ts

@@ -15,4 +15,10 @@ addExtensionMethods();
 
 export { addExtensionMethods };
 
-export { extractTraceparentData, getActiveTransaction, hasTracingEnabled, stripUrlQueryAndFragment } from './utils';
+export {
+  extractTraceparentData,
+  getActiveTransaction,
+  hasTracingEnabled,
+  stripUrlQueryAndFragment,
+  TRACEPARENT_REGEXP,
+} from './utils';

scripts/test.sh

@@ -6,6 +6,11 @@ source ~/.nvm/nvm.sh
 if [[ "$(cut -d. -f1 <<< "$TRAVIS_NODE_VERSION")" -le 6 ]]; then
   nvm use 8
   yarn install --ignore-engines --ignore-scripts
+  # current versions of nock don't support node 6
+  cd packages/node
+  yarn add --dev --ignore-engines [email protected]
+  yarn list --pattern nock
+  cd ../..
   # ember requires Node >= 10 to build
   yarn build --ignore="@sentry/ember" --ignore="@sentry/serverless" --ignore="@sentry/gatsby" --ignore="@sentry/react"
   nvm use 6

yarn.lock

@@ -14159,6 +14159,16 @@ nock@^13.0.4:
     lodash.set "^4.3.2"
     propagate "^2.0.0"
 
+nock@^13.0.5:
+  version "13.0.5"
+  resolved "https://registry.yarnpkg.com/nock/-/nock-13.0.5.tgz#a618c6f86372cb79fac04ca9a2d1e4baccdb2414"
+  integrity sha512-1ILZl0zfFm2G4TIeJFW0iHknxr2NyA+aGCMTjDVUsBY4CkMRispF1pfIYkTRdAR/3Bg+UzdEuK0B6HczMQZcCg==
+  dependencies:
+    debug "^4.1.0"
+    json-stringify-safe "^5.0.1"
+    lodash.set "^4.3.2"
+    propagate "^2.0.0"
+
 [email protected]:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/node-environment-flags/-/node-environment-flags-1.0.5.tgz#fa930275f5bf5dae188d6192b24b4c8bbac3d76a"