feat: extract query_string from window.location to SentryRequestBody

* chore: extend SentryRequestBody.request with query_string field This change can be useful when we divide url for two parts - url and query params (or search params) * feat: extract query_string from window.location to SentryRequestBody --------- Co-authored-by: Edem <[email protected]>
taiga-family · May 5, 2024 · 721312b · 721312b
1 parent 2d3a9fc
commit 721312b
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 1 deletion.
diff --git a/libs/browser/src/lib/services/browser-micro-sentry-client.spec.ts b/libs/browser/src/lib/services/browser-micro-sentry-client.spec.ts
@@ -335,6 +335,13 @@ describe('BrowserMicroSentryClient', () => {
     });
 
     it('Set data is in data to send', () => {
+      Object.defineProperty(window, 'location', {
+        value: new URL(
+          'https://example.com?env=development&auth=123&code=3212'
+        ),
+        configurable: true,
+      });
+
       client.report({ message: 'Error', name: 'Error', stack: '' });
 
       expect(sendSpy).toHaveBeenCalledWith({
@@ -356,6 +363,7 @@ describe('BrowserMicroSentryClient', () => {
             'User-Agent': expect.any(String),
           },
           url: expect.any(String),
+          query_string: 'env=development&auth=123&code=3212',
         },
         sdk: { name: 'micro-sentry.javascript.browser', version: '0.0.0' },
         extra: {
@@ -368,6 +376,10 @@ describe('BrowserMicroSentryClient', () => {
     });
 
     it('Message has correct fields and log level', () => {
+      Object.defineProperty(window, 'location', {
+        value: '/some/path?env=development&auth=123&code=3212',
+        configurable: true,
+      });
       client.captureMessage('Message', Severity.debug);
 
       expect(sendSpy).toHaveBeenCalledWith({
@@ -380,6 +392,7 @@ describe('BrowserMicroSentryClient', () => {
             'User-Agent': expect.any(String),
           },
           url: expect.any(String),
+          query_string: 'env=development&auth=123&code=3212',
         },
         sdk: { name: 'micro-sentry.javascript.browser', version: '0.0.0' },
         extra: {

diff --git a/libs/browser/src/lib/services/browser-micro-sentry-client.ts b/libs/browser/src/lib/services/browser-micro-sentry-client.ts
@@ -6,6 +6,7 @@ import {
   SentryRequestBody,
   Severity,
   Tags,
+  QueryString,
 } from '@micro-sentry/core';
 import { State } from '../models/state';
 import { MicroSentryPlugin } from '../models/plugin';
@@ -166,10 +167,33 @@ export class BrowserMicroSentryClient extends MicroSentryClient {
     );
   }
 
+  extractQueryString(originalUrl: string): QueryString | undefined {
+    let url = originalUrl;
+
+    if (!url) {
+      return undefined;
+    }
+
+    if (url.startsWith('/')) {
+      url = `http://prefix${url}`;
+    }
+
+    try {
+      const queryString = new URL(url).search.slice(1);
+
+      return queryString.length ? queryString : undefined;
+    } catch (e) {
+      return undefined;
+    }
+  }
+
   protected override getRequestBlank(): SentryRequestBody {
+    const url = this.window.location.toString();
+
     return {
       request: {
-        url: this.window.location.toString(),
+        url,
+        query_string: this.extractQueryString(url),
         headers: {
           'User-Agent': this.window.navigator.userAgent,
         },

diff --git a/libs/core/src/lib/models/models.ts b/libs/core/src/lib/models/models.ts
@@ -21,6 +21,11 @@ export type Tags = Partial<{ [key: string]: string }>;
 
 export type Extras = Partial<{ [key: string]: unknown }>;
 
+export type QueryString =
+  | string
+  | { [key: string]: string }
+  | Array<[string, string]>;
+
 export interface User {
   id?: string;
   ip_address?: string;
@@ -39,6 +44,7 @@ export interface SentryRequestBody {
   timestamp: number;
   event_id: string;
   request?: {
+    query_string?: QueryString;
     url?: string;
     headers?: {
       'User-Agent': string;