extract parser exception parser to exernal library on npm, code cleanup and improvements

Author: piotrek98

package.json

@@ -1,6 +1,6 @@
 {
   "name": "traceo-sdk",
-  "version": "0.0.82-alpha",
+  "version": "0.0.84",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,8 +23,8 @@
     "@rollup/plugin-typescript": "^8.3.0",
     "eslint": "^8.8.0",
     "jest": "^26.5.5",
-    "os": "^0.1.2",
     "npm-run-all": "^4.1.2",
+    "os": "^0.1.2",
     "prettier": "^2.5.1",
     "prettier-check": "^2.0.0",
     "rimraf": "^3.0.2",
@@ -48,5 +48,8 @@
     "testMatch": [
       "**/*.test.ts"
     ]
+  },
+  "dependencies": {
+    "stacktrace-parser-node": "^1.0.4"
   }
 }

src/core/http.ts

@@ -1,12 +1,16 @@
 import * as http from "http";
 import { sanitizeDsn } from "../node/helpers";
-import { RequestStatus } from "../transport/enums";
 import { EventResponse, TraceoEvent } from "../transport/events";
 import { TraceoIncomingMessage, RequestOptions } from "../transport/http";
 import { getGlobalClientData } from "./global";
 import { isClientConnected } from "./is";
 import { TRACEO_SDK_VERSION } from "./version";
 
+enum RequestStatus {
+  SUCCESS = "success",
+  ERROR = "error",
+}
+
 const createHttpOptions = ({
   event,
 }: {

src/core/version.ts

@@ -1 +1 @@
-export const TRACEO_SDK_VERSION = "0.0.82-alpha";
+export const TRACEO_SDK_VERSION = "0.0.84";

src/node/helpers.ts

@@ -1,47 +1,7 @@
-import { BaseObject } from "../transport/base";
 import { Platform } from "../transport/events";
-import { TraceoIncomingMessage, TraceoRequest } from "../transport/http";
+import { TraceoIncomingMessage } from "../transport/http";
 import * as os from "os";
 
-export const mapRequestData = (req: BaseObject): TraceoRequest => {
-  const headersData = req.headers || req.header || {};
-
-  const method = req.method;
-  const host = headersData["host"] || "<no host>";
-
-  const protocol = getProtocol(req.protocol);
-
-  const originalUrl = (req.originalUrl || req.url) as string;
-  const absoluteUrl = `${protocol}://${host}${originalUrl}`;
-  const origin = headersData["origin"];
-  const query = req.query;
-  const payload = req.body || {};
-  const ip = getIp(req as TraceoIncomingMessage);
-
-  const connections = {
-    absoluteUrl,
-    origin,
-    protocol,
-  };
-
-  const headers = {
-    host,
-    connection: headersData["connection"],
-    origin: headersData["origin"],
-  };
-
-  const request = {
-    payload,
-    headers,
-    method,
-    query,
-    ip,
-    url: connections,
-  };
-
-  return request;
-};
-
 export const getIp = (
   req: TraceoIncomingMessage
 ): string | string[] | undefined => {
@@ -62,8 +22,10 @@ export const getOsPlatform = (): Platform => {
 };
 
 export const sanitizeDsn = (dsn: string) => {
-  //TODO: check for https
-  const [secretKey, rest] = dsn.replace("http://", "").split(":");
+  const [secretKey, rest] = dsn
+    .replace("http://", "")
+    .replace("https://", "")
+    .split(":");
   const [host, appId] = rest.split("/");
 
   return {

src/node/middlewares.ts

@@ -1,11 +1,11 @@
+import { stacktrace } from "stacktrace-parser-node";
 import { sendEvent } from "../core/http";
 import { isClientConnected, isLocalhost } from "../core/is";
 import { TraceoError } from "../transport/base";
 import { TraceoEvent } from "../transport/events";
 import { TraceoIncomingMessage, TraceoServerResponse } from "../transport/http";
 import { ErrorMiddlewareOptions } from "../transport/options";
-import { getIp, getProtocol } from "./helpers";
-import { prepareException } from "./parse";
+import { getIp, getOsPlatform, getProtocol } from "./helpers";
 
 /**
  * Base middleware to catch and intercept error across the express app.
@@ -43,7 +43,7 @@ const errorMiddleware = (options: ErrorMiddlewareOptions = {}) => {
     }
 
     if (isToCatch(req, options)) {
-      await handleException(error, req);
+      await handleException(error);
     }
 
     next(error);
@@ -86,7 +86,7 @@ interface Catch {
  * }
  * ```
  *
- * Usage with optional parameter `shouldBeCatched` as a callback function:
+ * Usage with `shouldBeCatched`:
  * @example
  *
  * ```
@@ -106,24 +106,40 @@ export const catchException = async (error: any, catchOptions?: Catch) => {
   }
 
   if (isClientConnected()) {
-    await handleException(error, undefined);
+    await handleException(error);
   }
 
   return;
 };
 
-const handleException = async (
-  error: TraceoError,
-  req?: TraceoIncomingMessage
-) => {
+const handleException = async (error: TraceoError) => {
   try {
-    const event: TraceoEvent = await prepareException(error, req);
+    const event: TraceoEvent = await prepareException(error);
     await sendEvent(event);
   } catch (err) {
     //
   }
 };
 
+
+const prepareException = async (
+  error: TraceoError
+): Promise<TraceoEvent> => {
+  const { stack } = error;
+  const platform = getOsPlatform();
+
+  const { message, name, traces } = await stacktrace.parse(error);
+  const event: TraceoEvent = {
+    type: name,
+    message,
+    traces,
+    stack: String(stack),
+    platform,
+  };
+
+  return event;
+};
+
 export const Middleware = {
   errorMiddleware,
 };

src/node/parse.ts

@@ -4,7 +4,7 @@ import { TraceoOptions } from "../transport/options";
 
 /**
  *
- * Function to connect client with Traceo Instance.
+ * Function to connect client with Traceo.
  *
  * @param options
  *
@@ -17,7 +17,7 @@ export const init = (options: TraceoOptions): void => {
 
   if (!options.environment) {
     console.warn(
-      "Traceo SDK: Empty environment property. Please set current env or use use offline mode."
+      "Traceo SDK: Empty environment property. Please set current env or use offline mode."
     );
     return;
   }

src/node/sdk.ts

@@ -1,9 +1,5 @@
 import { Environment } from "./types";
 
-export interface BaseObject {
-  [key: string]: any;
-}
-
 export interface TraceoGlobal {
   dsn: string;
   appId?: string;