fix: Send headers for node (#2637)

* fix: Send headers for node

* fix: Don't send qs for node

* fix: Node tests

Co-authored-by: Rodolfo Carvalho <rodolfo.carvalho@sentry.io>

Author: HazAT

CHANGELOG.md

@@ -5,6 +5,10 @@
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 - [react] feat: Add @sentry/react package (#2631)
 
+## 5.16.1
+
+- [node] fix: Requests to old `/store` endpoint need the `x-sentry-auth` header in node (#2637)
+
 ## 5.16.0
 
 *If you are a `@sentry/apm` and did manual instrumentation using `hub.startSpan` please be aware of the changes we did

packages/core/src/api.ts

@@ -80,8 +80,7 @@ export class API {
 
   /**
    * Returns an object that can be used in request headers.
-   *
-   * @deprecated in favor of `getStoreEndpointWithUrlEncodedAuth` and `getEnvelopeEndpointWithUrlEncodedAuth`.
+   * This is needed for node and the old /store endpoint in sentry
    */
   public getRequestHeaders(clientName: string, clientVersion: string): { [key: string]: string } {
     const dsn = this._dsnObject;

packages/node/src/transports/base.ts

@@ -6,7 +6,7 @@ import * as http from 'http';
 import * as https from 'https';
 import * as url from 'url';
 
-// import { SDK_NAME, SDK_VERSION } from '../version';
+import { SDK_NAME, SDK_VERSION } from '../version';
 
 /**
  * Internal used interface for typescript.
@@ -59,14 +59,13 @@ export abstract class BaseTransport implements Transport {
   /** Returns a build request option object used by request */
   protected _getRequestOptions(uri: url.URL): http.RequestOptions | https.RequestOptions {
     const headers = {
-      // The auth headers are not included because auth is done via query string to match @sentry/browser.
-      //
-      // ...this._api.getRequestHeaders(SDK_NAME, SDK_VERSION)
+      ...this._api.getRequestHeaders(SDK_NAME, SDK_VERSION),
       ...this.options.headers,
     };
-    const { hostname, pathname, port, protocol, search } = uri;
+    const { hostname, pathname, port, protocol } = uri;
     // See https://github.com/nodejs/node/blob/38146e717fed2fabe3aacb6540d839475e0ce1c6/lib/internal/url.js#L1268-L1290
-    const path = `${pathname}${search}`;
+    // We ignore the query string on purpose
+    const path = `${pathname}`;
 
     return {
       agent: this.client,

packages/node/test/transports/http.test.ts

@@ -6,7 +6,7 @@ import { HTTPTransport } from '../../src/transports/http';
 
 const mockSetEncoding = jest.fn();
 const dsn = 'http://9e9fd4523d784609a5fc0ebb1080592f@sentry.io:8989/mysubpath/50622';
-const transportPath = '/mysubpath/api/50622/store/?sentry_key=9e9fd4523d784609a5fc0ebb1080592f&sentry_version=7';
+const transportPath = '/mysubpath/api/50622/store/';
 let mockReturnCode = 200;
 let mockHeaders = {};
 
@@ -28,7 +28,7 @@ function createTransport(options: TransportOptions): HTTPTransport {
 }
 
 function assertBasicOptions(options: any): void {
-  expect(options.headers).not.toContain('X-Sentry-Auth'); // auth is part of the query string
+  expect(options.headers['X-Sentry-Auth']).toBeTruthy();
   expect(options.port).toEqual('8989');
   expect(options.path).toEqual(transportPath);
   expect(options.hostname).toEqual('sentry.io');

packages/node/test/transports/https.test.ts

@@ -6,7 +6,7 @@ import { HTTPSTransport } from '../../src/transports/https';
 
 const mockSetEncoding = jest.fn();
 const dsn = 'https://9e9fd4523d784609a5fc0ebb1080592f@sentry.io:8989/mysubpath/50622';
-const transportPath = '/mysubpath/api/50622/store/?sentry_key=9e9fd4523d784609a5fc0ebb1080592f&sentry_version=7';
+const transportPath = '/mysubpath/api/50622/store/';
 let mockReturnCode = 200;
 let mockHeaders = {};
 
@@ -34,7 +34,7 @@ function createTransport(options: TransportOptions): HTTPSTransport {
 }
 
 function assertBasicOptions(options: any): void {
-  expect(options.headers).not.toContain('X-Sentry-Auth'); // auth is part of the query string
+  expect(options.headers['X-Sentry-Auth']).toBeTruthy();
   expect(options.port).toEqual('8989');
   expect(options.path).toEqual(transportPath);
   expect(options.hostname).toEqual('sentry.io');