renaming connect function to init, added env and version property, added sendConnection function to send initial connection to klepper

Author: piotrek98

package.json

@@ -1,6 +1,6 @@
 {
   "name": "klepper",
-  "version": "0.0.45-alpha",
+  "version": "0.0.47-alpha",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/core/global.ts

@@ -6,9 +6,3 @@ export const getGlobalClientData = (): KlepperGlobal =>
 export const setGlobalClientData = (data: KlepperGlobal): void => {
   global.__KLEPPER__ = { ...data };
 };
-
-export const clearGlobalClientData = (): void => {
-  setGlobalClientData({
-    privateKey: undefined,
-  });
-};

src/core/http.ts

@@ -1,6 +1,10 @@
 import * as http from "http";
 import { RequestStatus } from "../transport/enums";
-import { EventResponse, KlepperEvent } from "../transport/events";
+import {
+  EventResponse,
+  KlepperConnectionEvent,
+  KlepperEvent,
+} from "../transport/events";
 import { KlepperIncomingMessage, RequestOptions } from "../transport/http";
 import { getGlobalClientData } from "./global";
 import { isClientConnected } from "./is";
@@ -9,7 +13,13 @@ const KLEPPER_HOST = process.env.KLEPPER_HOST || "localhost";
 const KLEPPER_API = process.env.KLEPPER_API || "/sdk/incident";
 const KLEPPER_PORT = process.env.KLEPPER_PORT || 8080;
 
-const createHttpOptions = (event: KlepperEvent): http.RequestOptions => {
+const createHttpOptions = ({
+  event,
+  api = KLEPPER_API,
+}: {
+  event?: KlepperEvent | KlepperConnectionEvent | KlepperConnectionEvent;
+  api?: string;
+}): http.RequestOptions => {
   const client = getGlobalClientData();
 
   const { privateKey, appId } = client;
@@ -26,19 +36,43 @@ const createHttpOptions = (event: KlepperEvent): http.RequestOptions => {
   };
 
   return {
-    path: KLEPPER_API,
+    path: api,
     ...baseOptions,
   };
 };
 
 const statusFromCode = (code: number) =>
   code >= 200 && code <= 299 ? RequestStatus.SUCCESS : RequestStatus.ERROR;
 
+export const sendConnection = (
+  connectionData: KlepperConnectionEvent
+): void => {
+  const httpOptions = createHttpOptions({
+    event: connectionData,
+    api: "/sdk/release",
+  });
+
+  const request = http.request(httpOptions, (res: KlepperIncomingMessage) => {
+    res.setEncoding("utf8");
+  });
+  request.write(JSON.stringify(connectionData));
+  request.end();
+};
+
 export const sendEvent = async (
   event: KlepperEvent
 ): Promise<EventResponse> => {
+  const client = getGlobalClientData();
+
+  const baseData = {
+    env: client?.environment,
+    version: client?.version,
+  };
+
+  const payload = Object.assign(event, baseData);
+
   return new Promise<EventResponse>((resolve, reject) => {
-    const httpOptions = createHttpOptions(event);
+    const httpOptions = createHttpOptions({ event });
     if (!httpOptions) {
       reject({
         statusCode: 400,
@@ -87,7 +121,9 @@ export const sendEvent = async (
       });
     });
 
-    request.write(JSON.stringify(event));
+    request.write(JSON.stringify(payload));
     request.end();
   });
 };
+
+const send = () => {};

src/node/middlewares.ts

@@ -134,7 +134,6 @@ const handleException = async (
     stack: error.stack as string,
     catchType: req ? CatchType.MIDDLEWARE : CatchType.INTERNAL,
     options,
-    sdk: "NodeJS"
   };
 
   if (req !== undefined) {

src/node/sdk.ts

@@ -1,5 +1,7 @@
 import { setGlobalClientData } from "../core/global";
+import { sendConnection } from "../core/http";
 import { isClientConnected } from "../core/is";
+import { KlepperConnectionEvent } from "../transport/events";
 import { KlepperOptions } from "../transport/options";
 
 const defaultBooleanCallback = () => true;
@@ -14,15 +16,15 @@ const defaultBooleanCallback = () => true;
  * @example
  *
  * ```
- * Klepper.connect({ credentials: { privateKey: "" } }, () => {
+ * Klepper.connect({ /credentials/, () => {
  *   if (process.env.ENV === "prod") {
  *      return true;
  *  }
  *   return false;
  * })
  * ```
  */
-export const connect = (
+export const init = (
   options: KlepperOptions,
   callback = defaultBooleanCallback
 ): void => {
@@ -42,6 +44,15 @@ export const connect = (
     setGlobalClientData({
       privateKey: options?.privateKey,
       appId: options?.appId,
+      environment: options?.environment,
+      version: options?.version,
     });
   }
+
+  const conn: KlepperConnectionEvent = {
+    env: options?.environment,
+    version: options?.version,
+  };
+
+  sendConnection(conn);
 };

src/transport/base.ts

@@ -8,6 +8,7 @@ export interface KlepperGlobal {
   environment?: Environment;
   privateKey?: string;
   appId?: string;
+  version?: string;
 }
 
 export interface KlepperError extends Error {}

src/transport/events.ts

@@ -1,5 +1,6 @@
 import { CatchType, ExceptionPriority } from "./enums";
 import { KlepperRequest } from "./http";
+import { Environment } from "./types";
 
 export interface EventResponse {
   statusCode: number;
@@ -32,5 +33,12 @@ export interface KlepperEvent {
     priority?: ExceptionPriority;
     tag?: string;
   };
-  sdk: string;
+  sdk?: string;
+  env?: Environment;
+  version?: string;
+}
+
+export interface KlepperConnectionEvent {
+  version?: string;
+  env: Environment;
 }

src/transport/options.ts

@@ -2,7 +2,8 @@ import { ExceptionPriority } from "./enums";
 import { Environment } from "./types";
 
 export interface KlepperOptions {
-  environment?: Environment;
+  version?: string;
+  environment: Environment;
   privateKey: string;
   appId: string;
 }

src/transport/types.ts

@@ -1,3 +1,3 @@
 export type RequestMethodType = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
 
-export type Environment = undefined | "prod" | "dev" | "test";
+export type Environment = "prod" | "dev";