🔊 improve logging

Author: LemonaOna

src/models/adapter.model.ts

@@ -8,6 +8,7 @@ import {
   Contact,
   ContactTemplate,
   ContactUpdate,
+  UpdateCallEventBody,
 } from ".";
 
 export interface Adapter {
@@ -39,7 +40,7 @@ export interface Adapter {
   updateCallEvent?: (
     config: Config,
     id: string,
-    event: CallEvent
+    event: UpdateCallEventBody
   ) => Promise<void>;
   deleteCalendarEvent?: (config: Config, id: string) => Promise<void>;
   handleCallEvent?: (config: Config, event: CallEvent) => Promise<string>;

src/models/bridge-request.model.ts

@@ -1,6 +1,11 @@
 import { Request } from "express";
 import { Config } from "./config.model";
+import { UpdateCallEventBody } from "./call-event.model";
 
 export interface BridgeRequest extends Request {
   providerConfig?: Config;
 }
+
+export interface UpdateCallEventBridgeRequest extends BridgeRequest {
+  body: UpdateCallEventBody;
+}

src/models/call-event.model.ts

@@ -26,3 +26,7 @@ export interface CallEvent {
   note: string;
   state: CallState;
 }
+
+export interface UpdateCallEventBody {
+  note: string;
+}

src/models/controller.model.ts

@@ -12,6 +12,7 @@ import {
   ContactTemplate,
   ContactUpdate,
   ServerError,
+  UpdateCallEventBridgeRequest,
 } from ".";
 import { calendarEventsSchema, contactsSchema } from "../schemas";
 import { anonymizeKey } from "../util/anonymize-key";
@@ -21,6 +22,7 @@ import { validate } from "../util/validate";
 import { APIContact } from "./api-contact.model";
 import { CacheItemStateType } from "./cache-item-state.model";
 import { CalendarFilterOptions } from "./calendar-filter-options.model";
+import { errorLogger, infoLogger } from "../util/logger.util";
 
 const CONTACT_FETCH_TIMEOUT: number = 3000;
 
@@ -50,35 +52,35 @@ export class Controller {
     res: Response,
     next: NextFunction
   ): Promise<void> {
-    const { providerConfig: { apiKey = "", locale = "" } = {} } = req;
-    const anonKey = anonymizeKey(apiKey);
+    const { providerConfig } = req;
+
     try {
+      if (!providerConfig) {
+        throw new ServerError(400, "Missing parameters");
+      }
+
       const fetchContacts = async (): Promise<Contact[]> => {
         if (!this.adapter.getContacts) {
           throw new ServerError(501, "Fetching contacts is not implemented");
         }
 
-        if (!req.providerConfig) {
-          throw new ServerError(400, "Missing parameters");
-        }
-
-        console.log(`[${anonKey}] Fetching contacts`);
+        infoLogger(providerConfig, `Fetching contacts…`);
 
         const fetchedContacts: Contact[] = await this.adapter.getContacts(
-          req.providerConfig
+          providerConfig
         );
 
         if (!validate(this.ajv, contactsSchema, fetchedContacts)) {
           throw new ServerError(500, "Invalid contacts received");
         }
 
         return fetchedContacts.map((contact) =>
-          sanitizeContact(contact, locale)
+          sanitizeContact(contact, providerConfig.locale)
         );
       };
 
       const fetcherPromise = this.contactCache
-        ? this.contactCache.get(apiKey, fetchContacts)
+        ? this.contactCache.get(providerConfig.apiKey, fetchContacts)
         : fetchContacts();
 
       const timeoutPromise: Promise<"TIMEOUT"> = new Promise((resolve) =>
@@ -87,7 +89,7 @@ export class Controller {
 
       const raceResult = await Promise.race([fetcherPromise, timeoutPromise]);
       if (raceResult === "TIMEOUT") {
-        console.log(`[${anonKey}] fetching too slow, returning empty array`);
+        infoLogger(providerConfig, `Fetching too slow, returning empty array.`);
       }
 
       const responseContacts: Contact[] = Array.isArray(raceResult)
@@ -96,7 +98,7 @@ export class Controller {
 
       const contactsCount = responseContacts.length;
 
-      console.log(`[${anonKey}] Found ${contactsCount} cached contacts`);
+      infoLogger(providerConfig, `Found ${contactsCount} cached contacts.`);
 
       if (
         !Array.isArray(raceResult) &&
@@ -113,7 +115,11 @@ export class Controller {
 
       res.status(200).send(responseContacts);
     } catch (error) {
-      console.error("Could not get contacts:", error || "Unknown");
+      errorLogger(
+        providerConfig,
+        "Could not get contacts:",
+        error || "Unknown"
+      );
       next(error);
     }
   }
@@ -450,36 +456,40 @@ export class Controller {
     res: Response,
     next: NextFunction
   ): Promise<void> {
-    const { providerConfig: { apiKey = "" } = {} } = req;
+    const { providerConfig } = req;
+
     try {
-      if (!this.adapter.handleCallEvent) {
-        throw new ServerError(501, "Handling call event is not implemented");
+      if (!providerConfig) {
+        throw new ServerError(400, "Missing config parameters");
       }
 
-      if (!req.providerConfig) {
-        throw new ServerError(400, "Missing config parameters");
+      if (!this.adapter.handleCallEvent) {
+        throw new ServerError(501, "Handling call event is not implemented");
       }
 
       if (shouldSkipCallEvent(req.body as CallEvent)) {
-        console.log(
-          `[${anonymizeKey(apiKey)}] skipping call event for call id ${
-            req.body.id
-          }`
+        infoLogger(
+          providerConfig,
+          `Skipping call event for call id ${req.body.id}`
         );
         res.status(200).send("Skipping call event");
         return;
       }
 
-      console.log(`[${anonymizeKey(apiKey)}] Handling call event for key`);
+      infoLogger(providerConfig, `Handling call event`);
 
       const integrationCallEventRef = await this.adapter.handleCallEvent(
-        req.providerConfig,
+        providerConfig,
         req.body as CallEvent
       );
 
       res.status(200).send(integrationCallEventRef);
     } catch (error) {
-      console.error("Could not handle call event:", error || "Unknown");
+      errorLogger(
+        providerConfig,
+        "Could not handle call event:",
+        error || "Unknown"
+      );
       next(error);
     }
   }
@@ -514,11 +524,11 @@ export class Controller {
   }
 
   public async updateCallEvent(
-    req: BridgeRequest,
+    req: UpdateCallEventBridgeRequest,
     res: Response,
     next: NextFunction
   ): Promise<void> {
-    const { providerConfig: { apiKey = "" } = {} } = req;
+    const { providerConfig: { apiKey = "" } = {}, body, params } = req;
 
     try {
       if (!this.adapter.updateCallEvent) {
@@ -531,12 +541,7 @@ export class Controller {
 
       console.log(`[${anonymizeKey(apiKey)}] Updating call event`);
 
-      //maybe return updated state obj
-      await this.adapter.updateCallEvent(
-        req.providerConfig,
-        req.params.id,
-        req.body as CallEvent
-      );
+      await this.adapter.updateCallEvent(req.providerConfig, params.id, body);
       res.status(200).send();
     } catch (error) {
       console.error("Could not update call event:", error || "Unknown");

src/util/index.ts

@@ -1,2 +1,3 @@
 export * from "./phone-number-utils";
 export * from "./anonymize-key";
+export * from "./logger.util";

src/util/logger.util.ts

@@ -0,0 +1,38 @@
+import { anonymizeKey } from "./anonymize-key";
+import { Config } from "../models";
+
+export const infoLogger = (
+  { apiKey }: Config,
+  message: string,
+  ...args: unknown[]
+): void => {
+  // eslint-disable-next-line no-console
+  console.log(
+    `${anonymizeKey(apiKey)}: ${message}`,
+    args && args.length ? args : ""
+  );
+};
+
+export const errorLogger = (
+  config: Config | undefined,
+  message: string,
+  ...args: unknown[]
+): void => {
+  // eslint-disable-next-line no-console
+  console.error(
+    `${config?.apiKey ? anonymizeKey(config.apiKey) : ""}: ${message}`,
+    args && args.length ? args : ""
+  );
+};
+
+export const warnLogger = (
+  { apiKey }: Config,
+  message: string,
+  ...args: unknown[]
+): void => {
+  // eslint-disable-next-line no-console
+  console.warn(
+    `${anonymizeKey(apiKey)}: ${message}`,
+    args && args.length ? args : ""
+  );
+};