feat/new constructor for sdk clients

Author: piotr-szewczyk

packages/browser/src/client.ts

@@ -87,7 +87,7 @@ export abstract class BrowserClient implements IBrowserClient {
       message,
       stack,
       traces,
-      browser: this.browser
+      details: this.browser
     };
 
     return err;
@@ -155,7 +155,7 @@ export abstract class BrowserClient implements IBrowserClient {
         message,
         stack,
         traces,
-        browser: this.browser
+        details: this.browser
       };
 
       this.sendError(err);
@@ -167,6 +167,6 @@ export abstract class BrowserClient implements IBrowserClient {
   }
 
   private get incidentsUrl() {
-    return `${CAPTURE_ENDPOINT.INCIDENT}/${this.configs.options.projectId}`;
+    return CAPTURE_ENDPOINT.INCIDENT;
   }
 }

packages/browser/src/index.ts

@@ -2,7 +2,7 @@ export { BrowserClient } from "./client";
 export type {
   Dictionary,
   IBrowserClient,
-  TraceoOptions,
+  ClientOptions,
   TraceoBrowserError as TraceoError
 } from "./types/client";
 export { VERSION } from "./version";

packages/browser/src/performance/index.ts

@@ -10,7 +10,7 @@ export class Performance {
     constructor(configs: BrowserClientConfigType) {
         this.batch = new Batch(configs, {
             headers: configs?.headers,
-            url: `${CAPTURE_ENDPOINT.BROWSER_PERFS}/${configs?.options?.projectId}`
+            url: CAPTURE_ENDPOINT.BROWSER_PERFS
         });
     }
 
@@ -25,9 +25,17 @@ export class Performance {
     // overrride to this.batch.add which inlcude some necessary data for each perfs
     public addToBatch(payload: BatchPayload): void {
         const pathname = utils.pathname();
+        const { browser, platform } = utils.browserDetails();
 
         const batchPayload: BatchPayload = {
             view: pathname,
+            browser: {
+                name: browser.name,
+                version: browser.version
+            },
+            platform: {
+                type: platform?.type
+            },
             ...payload
         };
 

packages/browser/src/transport/index.ts

@@ -46,6 +46,6 @@ export class Transport {
   }
 
   private get clientURL(): URL {
-    return new URL(this._options.options.url);
+    return new URL(this._options.options.host);
   }
 }

packages/browser/src/types/client.ts

@@ -5,13 +5,14 @@ export type BrowserClientConfigType = {
 
 export interface TraceoOptions {
   apiKey: string;
-  projectId: string;
-  url: string;
+  host: string;
   offline?: boolean;
   performance?: boolean;
 }
 
-export interface TraceoBrowserError extends Error {}
+export interface ClientOptions extends Omit<TraceoOptions, "apiKey"> { };
+
+export interface TraceoBrowserError extends Error { }
 
 export interface IBrowserClient {
   handleError(error: TraceoBrowserError): void;

packages/browser/src/types/transport.ts

@@ -25,7 +25,7 @@ export type BrowserIncidentType = {
   type?: string;
   message?: string;
   stack?: string;
-  browser: BrowserInfoType;
+  details: object;
   traces?: Trace[];
 };
 

packages/node/src/client.ts

@@ -1,7 +1,7 @@
 import { Logger } from "./logger";
 import { Metrics } from "./metrics";
 import { Scrapper } from "./scrapper";
-import { TraceoOptions } from "./types";
+import { ClientOptions, TraceoOptions } from "./types";
 import { TRACEO_SDK_VERSION } from "./version";
 
 export class Client {
@@ -13,14 +13,18 @@ export class Client {
   public readonly logger: Logger;
   public options: TraceoOptions;
 
-  constructor(options: TraceoOptions) {
+  constructor(apiKey: string, options: ClientOptions) {
     this.configGlobalClient();
 
-    this.options = options;
+    this.options = {
+      ...options,
+      apiKey
+    };
+
     this.headers = {
       "x-sdk-name": "node",
       "x-sdk-version": TRACEO_SDK_VERSION,
-      "x-sdk-key": this.options.apiKey
+      "x-sdk-key": apiKey
     };
 
     this.logger = new Logger();
@@ -57,10 +61,6 @@ export class Client {
     }
   }
 
-  // private metrics(): IClientMetrics {
-  //   return this._metrics;
-  // }
-
   private configGlobalClient(): void {
     global["__TRACEO__"] = this;
   }

packages/node/src/core/http.ts

@@ -15,7 +15,7 @@ export class HttpModule {
   private host: string;
 
   constructor() {
-    this.host = Client.config.url;
+    this.host = Client.config.host;
   }
 
   public static getInstance() {
@@ -64,7 +64,7 @@ export class HttpModule {
       port: reqUrl.port,
       host: reqUrl.hostname,
       method,
-      path: `${path.pathname}/${Client.config.projectId}`
+      path: path.pathname
     };
   }
 

packages/node/src/types/base.ts

@@ -1,5 +1,4 @@
 export interface TraceoGlobal {
-  projectId?: number;
   offline?: boolean;
   connection?: {
     host: string;

packages/node/src/types/options.ts

@@ -1,8 +1,7 @@
 export interface TraceoOptions {
   apiKey: string;
-  projectId: string;
   offline?: boolean;
-  url: string;
+  host: string;
   /* 
     Determining if Traceo should collect metrics from the application.
   */
@@ -20,6 +19,8 @@ export interface TraceoOptions {
   scrapLogsInterval?: number;
 }
 
+export interface ClientOptions extends Omit<TraceoOptions, "apiKey"> { }
+
 export interface ErrorMiddlewareOptions {
   allowLocalhost?: boolean;
   allowHttp?: boolean;