full information in CHANGELOG.md - 0.0.3-alpha

Author: piotrek98

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.0.3-alpha - 2022-03-23
+- Split transport file into few small files
+- removing try/catch from various functions
+- added options in parameters to `catchException` function
+- fixes for middleware and process of handling exceptions
+- fix for build script
 ## 0.0.2-alpha - 2022-03-23
 - Migration from monorepo in lerna to single monolith
 - Bugfixes

package.json

@@ -1,14 +1,14 @@
 {
   "name": "klepper",
-  "version": "0.0.25-alpha",
+  "version": "0.0.41-alpha",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "yarn prebuild && tsc -p ./tsconfig.json --outDir dist",
+    "build": "tsc -p ./tsconfig.json --outDir dist",
     "prebuild": "rimraf ./dist",
     "lint": "run-s lint:prettier",
     "lint:prettier": "prettier */**/*.{js,ts} --write",

src/core/global.ts

@@ -1,10 +1,5 @@
-import { KlepperGlobal } from "../transport";
+import { KlepperGlobal } from "../transport/base";
 
-/**
- * Using internal NodeJS global object to persist information
- *
- * @returns {KlepperGlobal}
- */
 export const getGlobalClientData = (): KlepperGlobal =>
   global.__KLEPPER__ || {};
 
@@ -14,7 +9,6 @@ export const setGlobalClientData = (data: KlepperGlobal): void => {
 
 export const clearGlobalClientData = (): void => {
   setGlobalClientData({
-    environment: undefined,
     privateKey: undefined,
   });
 };

src/core/http.ts

@@ -1,29 +1,25 @@
-import {
-  RequestPayload,
-  RequestOptions,
-  KlepperResponse,
-  KlepperIncomingMessage,
-  RequestStatus,
-} from "../transport";
 import * as http from "http";
+import { RequestStatus } from "../transport/enums";
+import { EventResponse, KlepperEvent } from "../transport/events";
+import { KlepperIncomingMessage, RequestOptions } from "../transport/http";
 import { getGlobalClientData } from "./global";
+import { isClientConnected } from "./is";
 
 const KLEPPER_HOST = process.env.KLEPPER_HOST || "localhost";
 const KLEPPER_API = process.env.KLEPPER_API || "/test";
 const KLEPPER_PORT = process.env.KLEPPER_PORT || 3000;
 
-const createHttpOptions = (payload: RequestPayload): http.RequestOptions => {
+const createHttpOptions = (event: KlepperEvent): http.RequestOptions => {
   const client = getGlobalClientData();
 
   const { privateKey } = client;
-  const { data } = payload;
   const baseOptions: RequestOptions = {
     hostname: KLEPPER_HOST,
     port: +KLEPPER_PORT,
     method: "POST",
     headers: {
       "Content-Type": "application/json",
-      "Content-Length": `${Buffer.byteLength(JSON.stringify(data))}`,
+      "Content-Length": `${Buffer.byteLength(JSON.stringify(event))}`,
       "Klepper-Project-Key": privateKey as string,
     },
   };
@@ -37,60 +33,60 @@ const createHttpOptions = (payload: RequestPayload): http.RequestOptions => {
 const statusFromCode = (code: number) =>
   code >= 200 && code <= 299 ? RequestStatus.SUCCESS : RequestStatus.ERROR;
 
-/**
- * Send data to Klepper server
- *
- * @param payload
- */
 export const sendEvent = async (
-  payload: RequestPayload
-): Promise<KlepperResponse> => {
-  const { data } = payload;
-
-  try {
-    return new Promise<KlepperResponse>((resolve, reject) => {
-      const httpOptions = createHttpOptions(payload);
-      const client = getGlobalClientData();
-
-      if (!httpOptions) {
-        reject(new Error("NO HTTP OPTIONS"));
-      }
+  event: KlepperEvent
+): Promise<EventResponse> => {
+  return new Promise<EventResponse>((resolve, reject) => {
+    const httpOptions = createHttpOptions(event);
+    if (!httpOptions) {
+      reject({
+        statusCode: 400,
+        statusMessage:
+          "[Klepper] Error during sending event to Klepper. No HTTP options.",
+      });
+    }
 
-      if (!client) {
-        reject(new Error("NO CLIENT DATA IN GLOBAL OBJECT"));
-      }
+    if (!isClientConnected()) {
+      reject({
+        statusCode: 400,
+        statusMessage:
+          "[Klepper] Error during sending event to Klepper. No client global data in NodeJS scope.",
+      });
+    }
 
-      const request = http.request(
-        httpOptions,
-        (res: KlepperIncomingMessage) => {
-          res.setEncoding("utf8");
+    const request = http.request(httpOptions, (res: KlepperIncomingMessage) => {
+      res.setEncoding("utf8");
 
-          const status = statusFromCode(res?.statusCode as number);
-          const isSuccess = status === RequestStatus.SUCCESS;
+      const status = statusFromCode(res?.statusCode as number);
+      const isSuccess = status === RequestStatus.SUCCESS;
 
-          if (!isSuccess) {
-            reject(new Error("HTTP ERROR: ${res.statusCode}"));
-          } else {
-            resolve({
-              statusCode: res?.statusCode as number,
-              statusMessage: "Event successfully sended to Klepper",
-            });
-          }
+      if (!isSuccess) {
+        reject({
+          statusCode: res?.statusCode as number,
+          statusMessage: "[KLEPPER] Error during sending event to Klepper.",
+        });
+      } else {
+        resolve({
+          statusCode: res?.statusCode as number,
+          statusMessage: "[KLEPPER] Event successfully sended to Klepper.",
+        });
+      }
 
-          res.on("error", reject);
-        }
-      );
-      request.on("error", reject);
+      res.on("error", reject);
+    });
+    
+    request.on("error", reject);
 
-      request.on("timeout", () => {
-        request.destroy();
-        reject(new Error("TIMEOUT"));
+    request.on("timeout", () => {
+      request.destroy();
+      reject({
+        statusCode: 400,
+        statusMessage:
+          "[Klepper] Error during sending event to Klepper. Connection timeout.",
       });
-
-      request.write(JSON.stringify(data));
-      request.end();
     });
-  } catch (error) {
-    throw new Error(""); //to properly handling
-  }
+
+    request.write(JSON.stringify(event));
+    request.end();
+  });
 };

src/core/index.ts

@@ -1,4 +1,3 @@
-import * as http from "./http";
 import * as global from "./global";
 
-export { http, global };
+export { global };

src/core/is.ts

@@ -0,0 +1,16 @@
+import { getGlobalClientData } from "./global";
+
+export const isInternal = (fileName: string): boolean =>
+  !!fileName &&
+  !fileName.includes("node_modules") &&
+  !fileName.startsWith("/") &&
+  !fileName.startsWith("node:") &&
+  fileName.includes(":\\");
+
+export const isEmpty = (obj?: any): boolean => Object.keys(obj).length === 0;
+
+export const isLocalhost = (ip: string): boolean => {
+  return ip === "::1" || ip === "127.0.0.1" ? true : false;
+};
+
+export const isClientConnected = (): boolean => !isEmpty(getGlobalClientData());

src/core/types/global.d.ts

@@ -1,4 +1,4 @@
-import { KlepperGlobal } from "../../transport";
+import { KlepperGlobal } from "../../transport/base";
 
 declare global {
   var __KLEPPER__: KlepperGlobal;

src/index.ts

@@ -1,5 +1,12 @@
-import * as Middleware from "./node/middlewares";
+import { Middleware, catchException } from "./node/middlewares";
 import * as Klepper from "./node/sdk";
-import { catchException } from "./node/middlewares/error";
+import { ExceptionPriority } from "./transport/enums";
+import { CatchExceptionsOptions } from "./transport/options";
 
-export { Middleware, Klepper, catchException };
+export {
+  Middleware,
+  Klepper,
+  catchException,
+  CatchExceptionsOptions,
+  ExceptionPriority,
+};

src/node/helpers.ts

@@ -1,34 +1,7 @@
-import {
-  BaseObject,
-  KlepperIncomingMessage,
-  KlepperRequest,
-} from "../transport";
-// import { StackFrame } from "stack-trace";
+import { BaseObject } from "../transport/base";
+import { KlepperIncomingMessage, KlepperRequest } from "../transport/http";
 
-// const prepareStackTraces = (stackFrames: StackFrame[]): Trace[] => {
-//     const parseTraces = (frame: StackFrame): Trace => {
-//         return {
-//             functionName: frame.getFunctionName(),
-//             rowNo: frame.getLineNumber(),
-//             colNo: frame.getColumnNumber(),
-//             fileName: frame.getFileName(),
-//             absolutePath: frame.getFunctionName(),
-//             isInternal: isInternal(frame.getFileName()),
-//         }
-//     }
-
-//     const traces = stackFrames.map((frame) => parseTraces(frame)) || [];
-//     return traces;
-// }
-
-const isInternal = (fileName: string): boolean =>
-  !!fileName &&
-  !fileName.includes("node_modules") &&
-  !fileName.startsWith("/") &&
-  !fileName.startsWith("node:") &&
-  fileName.includes(":\\");
-
-const mapRequestData = (req: BaseObject): KlepperRequest => {
+export const mapRequestData = (req: BaseObject): KlepperRequest => {
   const headersData = req.headers || req.header || {};
 
   const method = req.method;
@@ -67,26 +40,12 @@ const mapRequestData = (req: BaseObject): KlepperRequest => {
   return request;
 };
 
-const getIp = (req: KlepperIncomingMessage): string | string[] | undefined => {
+export const getIp = (
+  req: KlepperIncomingMessage
+): string | string[] | undefined => {
   return req.headers["x-forwarded-for"] || req.socket.remoteAddress;
 };
 
-const isLocalhost = (req: KlepperIncomingMessage): boolean => {
-  const ip = getIp(req);
-  return ip === "::1" || ip === "127.0.0.1" ? true : false;
-};
-
-const getProtocol = (req: KlepperIncomingMessage): string => {
+export const getProtocol = (req: KlepperIncomingMessage): string => {
   return req.protocol === "https" || req.secure ? "https" : "http";
 };
-
-const isEmpty = (obj: any) => Object.keys(obj).length === 0;
-
-export const helpers = {
-  getIp,
-  mapRequestData,
-  isEmpty,
-  // prepareStackTraces,
-  getProtocol,
-  isLocalhost,
-};

src/node/index.ts

@@ -1,4 +1,4 @@
-import * as Middleware from "./middlewares/index";
+import { Middleware } from "..";
 import * as Klepper from "./sdk";
 
 export { Middleware, Klepper };