fix: only pass X-Scope-OrgID header if multi tenant is enabled (#708)

* make jest reuse alias from tsconfig.json

* only set X-Scope-OrgID header if multi_tenant

Author: eh-am

jest.config.js

@@ -1,9 +1,10 @@
 const path = require('path');
+const { pathsToModuleNameMapper } = require('ts-jest');
+const { compilerOptions } = require('./tsconfig');
 
 module.exports = {
   // TypeScript files (.ts, .tsx) will be transformed by ts-jest to CommonJS syntax, and JavaScript files (.js, jsx) will be transformed by babel-jest.
   testEnvironment: 'jsdom',
-  //  setupFilesAfterEnv: [path.join(__dirname, 'setupAfterEnv.ts')],
   testMatch: ['**/?(*.)+(spec|test).+(ts|tsx|js)'],
   transform: {
     '^.+\\.(t|j)sx?$': ['@swc/jest'],
@@ -12,9 +13,11 @@ module.exports = {
   transformIgnorePatterns: [
     // force us to transpile these dependencies
     // https://stackoverflow.com/a/69150188
-    'node_modules/(?!(true-myth|d3|d3-array|internmap|d3-scale|react-notifications-component|graphviz-react))',
+    'node_modules/(?!(true-myth|d3|d3-array|internmap|d3-scale|react-notifications-component|graphviz-react|pyroscope-oss))',
   ],
-  moduleNameMapper: {
-    '@webapp/util/baseurl': ['<rootDir>/public/app/overrides/util/baseurl'],
-  },
+
+  // Reuse the same modules from typescript
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, {
+    prefix: '<rootDir>',
+  }),
 };

package.json

@@ -33,12 +33,12 @@
     "@types/lodash.groupby": "^4.6.7",
     "@types/lodash.map": "^4.6.13",
     "@types/prismjs": "^1.26.0",
+    "@types/react": "^18.0.0",
     "@types/react-datepicker": "^4.3.4",
     "@types/react-dom": "^18.0.11",
     "@types/react-helmet": "^6.1.5",
     "@types/react-outside-click-handler": "^1.3.1",
     "@types/react-router-dom": "5.3.0",
-    "@types/react": "^18.0.0",
     "@typescript-eslint/eslint-plugin": "^5.59.5",
     "@typescript-eslint/parser": "^5.59.5",
     "copy-webpack-plugin": "^11.0.0",
@@ -59,6 +59,7 @@
     "prettier": "2.8.8",
     "react-svg-loader": "^3.0.3",
     "sass": "^1.60.0",
+    "ts-jest": "^29.1.0",
     "tsconfig-paths-webpack-plugin": "^4.0.1",
     "webpack": "^5.77.0",
     "webpack-cli": "^5.0.1",

public/app/overrides/services/base.spec.ts

@@ -0,0 +1,68 @@
+import * as ogBase from '@pyroscope/webapp/javascript/services/base';
+import { requestWithOrgID } from '@webapp/services/base';
+import * as tenantSvc from '@phlare/services/tenant';
+
+jest.mock('@pyroscope/webapp/javascript/services/base', () => {
+  return {
+    __esModule: true,
+    ...jest.requireActual('@pyroscope/webapp/javascript/services/base'),
+  };
+});
+
+jest.mock('@phlare/services/tenant', () => {
+  return {
+    __esModule: true,
+    tenantIDFromStorage: jest.fn(),
+  };
+});
+
+describe('base', () => {
+  afterEach(() => {
+    // restore the spy created with spyOn
+    jest.restoreAllMocks();
+  });
+
+  it('uses X-Scope-OrgID if set manually', () => {
+    const spy = jest.spyOn(ogBase, 'request');
+
+    requestWithOrgID('/', {
+      headers: {
+        'X-Scope-OrgID': 'myID',
+      },
+    });
+
+    expect(spy).toHaveBeenCalledWith('/', {
+      headers: {
+        'X-Scope-OrgID': 'myID',
+      },
+    });
+  });
+
+  it('does not set X-Scope-OrgID if tenantID is not available', () => {
+    const spy = jest.spyOn(ogBase, 'request');
+    const tenantIdSpy = jest.spyOn(tenantSvc, 'tenantIDFromStorage');
+
+    tenantIdSpy.mockReturnValueOnce('');
+
+    requestWithOrgID('/');
+
+    expect(spy).toHaveBeenCalledWith('/', {
+      headers: {},
+    });
+  });
+
+  it('sets X-Scope-OrgID if tenantID is available', () => {
+    const spy = jest.spyOn(ogBase, 'request');
+    const tenantIdSpy = jest.spyOn(tenantSvc, 'tenantIDFromStorage');
+
+    tenantIdSpy.mockReturnValueOnce('myid');
+
+    requestWithOrgID('/');
+
+    expect(spy).toHaveBeenCalledWith('/', {
+      headers: {
+        'X-Scope-OrgID': 'myid',
+      },
+    });
+  });
+});

public/app/overrides/services/base.ts

@@ -19,9 +19,10 @@ export async function requestWithOrgID(
 
   // Reuse headers if they were passed
   if (!config?.headers?.hasOwnProperty('X-Scope-OrgID')) {
+    const tenantID = tenantIDFromStorage();
     headers = {
       ...config?.headers,
-      'X-Scope-OrgID': tenantIDFromStorage(),
+      ...(tenantID && { 'X-Scope-OrgID': tenantID }),
     };
   }
 

public/app/redux/reducers/tenant.ts

@@ -51,7 +51,7 @@ export const checkTenancyIsRequired = createAsyncThunk<
       return Promise.resolve({ tenancy: 'multi_tenant', tenantID });
     }
 
-    return Promise.resolve({ tenancy: 'single_tenant', tenantID });
+    return Promise.resolve({ tenancy: 'single_tenant', tenantID: undefined });
   },
   {
     // This check is only valid if we don't know what's the tenancy status yet
@@ -78,9 +78,6 @@ const tenantSlice = createSlice({
     setWantsToChange(state) {
       state.tenancy = 'wants_to_change';
     },
-    setTenancy(state, action: PayloadAction<TenantState['tenancy']>) {
-      state.tenancy = action.payload;
-    },
   },
   extraReducers: (builder) => {
     // This thunk will never reject

tsconfig.json

@@ -2,7 +2,6 @@
   "baseUrl": ".",
   "compilerOptions": {
     "plugins": [{ "name": "typescript-plugin-css-modules" }],
-    // TODO: unify with webpack.common.js
     "paths": {
       "@phlare/*": ["./public/app/*"],
 
@@ -37,7 +36,6 @@
       "@webapp/services/tags": ["./public/app/overrides/services/tags"],
       "@webapp/services/base": ["./public/app/overrides/services/base"],
       "@webapp/*": ["./node_modules/pyroscope-oss/webapp/javascript/*"],
-      // Without this files under pyroscope-oss would resolve to ./node_modules/pyroscope-oss/@mui/base
       "@mui/base/*": ["./node_modules/@mui/base/*"]
     },
     "target": "es5",

yarn.lock

@@ -5145,6 +5145,13 @@ browserslist@^4.12.0, browserslist@^4.14.5, browserslist@^4.18.1, browserslist@^
     node-releases "^2.0.8"
     update-browserslist-db "^1.0.10"
 
+bs-logger@0.x:
+  version "0.2.6"
+  resolved "https://registry.yarnpkg.com/bs-logger/-/bs-logger-0.2.6.tgz#eb7d365307a72cf974cc6cda76b68354ad336bd8"
+  integrity sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog==
+  dependencies:
+    fast-json-stable-stringify "2.x"
+
 bser@2.1.1:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/bser/-/bser-2.1.1.tgz#e6787da20ece9d07998533cfd9de6f5c38f4bc05"
@@ -7704,7 +7711,7 @@ fast-glob@^3.2.11, fast-glob@^3.2.12, fast-glob@^3.2.4, fast-glob@^3.2.9:
     merge2 "^1.3.0"
     micromatch "^4.0.4"
 
-fast-json-stable-stringify@^2.0.0, fast-json-stable-stringify@^2.1.0:
+fast-json-stable-stringify@2.x, fast-json-stable-stringify@^2.0.0, fast-json-stable-stringify@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633"
   integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==
@@ -9623,7 +9630,7 @@ jest-snapshot@^29.5.0:
     pretty-format "^29.5.0"
     semver "^7.3.5"
 
-jest-util@^29.5.0:
+jest-util@^29.0.0, jest-util@^29.5.0:
   version "29.5.0"
   resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-29.5.0.tgz#24a4d3d92fc39ce90425311b23c27a6e0ef16b8f"
   integrity sha512-RYMgG/MTadOr5t8KdhejfvUU82MxsCu5MF6KuDUHl+NuwzUt+Sm6jJWxTJVrDR1j5M/gJVCPKQEpWXY+yIQ6lQ==
@@ -9844,7 +9851,7 @@ json5@^1.0.1, json5@^1.0.2:
   dependencies:
     minimist "^1.2.0"
 
-json5@^2.1.2, json5@^2.2.0, json5@^2.2.2:
+json5@^2.1.2, json5@^2.2.0, json5@^2.2.2, json5@^2.2.3:
   version "2.2.3"
   resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283"
   integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==
@@ -10132,6 +10139,11 @@ lodash.map@^4.6.0:
   resolved "https://registry.yarnpkg.com/lodash.map/-/lodash.map-4.6.0.tgz#771ec7839e3473d9c4cde28b19394c3562f4f6d3"
   integrity sha512-worNHGKLDetmcEYDvh2stPCrrQRkP20E4l0iIS7F8EvzMqBBi7ltvFN5m1HvTf1P7Jk1txKhvFcmYsCr8O2F1Q==
 
+lodash.memoize@4.x:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe"
+  integrity sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==
+
 lodash.merge@^4.6.2:
   version "4.6.2"
   resolved "https://registry.yarnpkg.com/lodash.merge/-/lodash.merge-4.6.2.tgz#558aa53b43b661e1925a0afdfa36a9a1085fe57a"
@@ -10240,7 +10252,7 @@ make-dir@^3.0.0, make-dir@^3.0.2, make-dir@^3.1.0:
   dependencies:
     semver "^6.0.0"
 
-make-error@^1.1.1:
+make-error@1.x, make-error@^1.1.1:
   version "1.3.6"
   resolved "https://registry.yarnpkg.com/make-error/-/make-error-1.3.6.tgz#2eb2e37ea9b67c4891f684a1394799af484cf7a2"
   integrity sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==
@@ -13153,6 +13165,13 @@ selfsigned@^2.1.1:
   resolved "https://registry.yarnpkg.com/semver/-/semver-5.7.1.tgz#a954f931aeba508d307bbf069eff0c01c96116f7"
   integrity sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==
 
+semver@7.x:
+  version "7.5.1"
+  resolved "https://registry.yarnpkg.com/semver/-/semver-7.5.1.tgz#c90c4d631cf74720e46b21c1d37ea07edfab91ec"
+  integrity sha512-Wvss5ivl8TMRZXXESstBA4uR5iXgEN/VC5/sOcuXdVLzcdkz4HWetIoRfG5gb5X+ij/G9rw9YoGn3QoQ8OCSpw==
+  dependencies:
+    lru-cache "^6.0.0"
+
 semver@^6.0.0, semver@^6.1.1, semver@^6.1.2, semver@^6.3.0:
   version "6.3.0"
   resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
@@ -14071,6 +14090,20 @@ ts-essentials@^9.0.0:
   resolved "https://registry.yarnpkg.com/ts-essentials/-/ts-essentials-9.3.1.tgz#f2d1e1584ef53c0251012258338421d7cf78a4d0"
   integrity sha512-9CChSvQMyVRo29Vb1A2jbs+LKo3d/bAf+ndSaX0T8cEiy/HChVaRN/HY5DqUryZ8hZ6uol9bEgCnGmnDbwBR9Q==
 
+ts-jest@^29.1.0:
+  version "29.1.0"
+  resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-29.1.0.tgz#4a9db4104a49b76d2b368ea775b6c9535c603891"
+  integrity sha512-ZhNr7Z4PcYa+JjMl62ir+zPiNJfXJN6E8hSLnaUKhOgqcn8vb3e537cpkd0FuAfRK3sR1LSqM1MOhliXNgOFPA==
+  dependencies:
+    bs-logger "0.x"
+    fast-json-stable-stringify "2.x"
+    jest-util "^29.0.0"
+    json5 "^2.2.3"
+    lodash.memoize "4.x"
+    make-error "1.x"
+    semver "7.x"
+    yargs-parser "^21.0.1"
+
 ts-node@^10.4.0:
   version "10.9.1"
   resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.1.tgz#e73de9102958af9e1f0b168a6ff320e25adcff4b"
@@ -14932,7 +14965,7 @@ yargs-parser@^20.2.2, yargs-parser@^20.2.3:
   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.9.tgz#2eb7dc3b0289718fc295f362753845c41a0c94ee"
   integrity sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==
 
-yargs-parser@^21.1.1:
+yargs-parser@^21.0.1, yargs-parser@^21.1.1:
   version "21.1.1"
   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.1.1.tgz#9096bceebf990d21bb31fa9516e0ede294a77d35"
   integrity sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==