dev: add logs to client;api-call-builder

Author: radekBednarik

deno.lock

@@ -1,18 +1,21 @@
 import { getApi, type GetApiError } from "../common/api.ts";
 import { createQueryParams, type QueryParams } from "../common/api.ts";
+import { getLogger, type Logger } from "@logtape/logtape";
 
 export default class ApiCallBuilder<T> {
   private readonly token: string;
   private readonly getApi: typeof getApi;
   private endpoint?: string;
   private queryParams?: QueryParams;
   private id?: string;
+  private logger: Logger;
 
   constructor({
     token,
   }: {
     token: string;
   }) {
+    this.logger = getLogger(["czech-covid-data-api-lib", "api-call-builder"]);
     this.token = token;
     this.getApi = getApi;
     this.endpoint = undefined;
@@ -22,23 +25,39 @@ export default class ApiCallBuilder<T> {
 
   public provideQueryParams(queryParams: QueryParams) {
     this.queryParams = queryParams;
+    this.logger.debug("Provided query parameters.", {
+      method: "provideQueryParams",
+      data: queryParams,
+    });
     return this;
   }
 
   public provideEndpoint(endpoint: string) {
     this.endpoint = endpoint;
+    this.logger.debug("Provided endpoint.", {
+      method: "provideEndpoint",
+      data: endpoint,
+    });
     return this;
   }
 
   public provideId(id: string) {
     this.id = id;
+    this.logger.debug("Provided endpoint subpath id.", {
+      method: "provideId",
+      data: id,
+    });
     return this;
   }
 
   public async build(): Promise<[T, null] | [null, GetApiError]> {
     let queryParams: URLSearchParams | undefined;
 
     if (typeof this.endpoint === "undefined") {
+      this.logger.error("Endpoint argument is of type undefined.", {
+        method: "build",
+        data: this.endpoint,
+      });
       throw new Error("Property endpoint has to have a defined value!");
     }
 
@@ -50,6 +69,10 @@ export default class ApiCallBuilder<T> {
       this.endpoint = `${this.endpoint}/${this.id}`;
     }
 
+    this.logger.debug("Attempting to call the api.", {
+      method: "build",
+      data: { endpoint: this.endpoint, token: "***", queryParams },
+    });
     return await this.getApi<T>(
       this.endpoint,
       this.token,

src/builders/api-call-builder.ts

@@ -5,6 +5,8 @@ import Deaths from "../deaths/deaths.ts";
 import VaccinationAggregated from "../vaccination/vaccination-aggregated.ts";
 import VaccinationPlaces from "../vaccination/vaccination-places.ts";
 
+import { getLogger, type Logger } from "@logtape/logtape";
+
 /**
  * Represents single entrypoint for calling supported
  * COVID REST APIs.
@@ -28,6 +30,8 @@ export default class Client {
   public readonly vaccinationPlaces: VaccinationPlaces;
   /** @property instance - holds the singleton instance of the class */
   private static instance: Client;
+  /** @property logger - holds instance of the logger */
+  private logger: Logger;
 
   /**
    * Represents single entrypoint for calling the supported
@@ -41,6 +45,7 @@ export default class Client {
    * @param param0.token - your personal token
    */
   private constructor({ token }: { token?: string }) {
+    this.logger = getLogger(["czech-covid-data-api-lib", "client"]);
     this.token = this.addToken(token);
 
     this.hospitalization = new Hospitalizations(this.token);
@@ -59,9 +64,15 @@ export default class Client {
    */
   private addToken(token?: string) {
     if (typeof token === "string") {
+      Client.instance.logger.debug(
+        "Token of valid type string was provided and will be returned.",
+      );
       return token;
     }
-
+    Client.instance.logger.fatal(
+      "Provided token was not of type string. Method will throw.",
+      { method: "addToken" },
+    );
     throw new Error("Provided token must be of the type string.");
   }
 
@@ -71,7 +82,16 @@ export default class Client {
     }
     if (!Client.instance) {
       Client.instance = new Client({ token });
+      Client.instance.logger.debug(
+        "Client instance was not found. New instance was created.",
+        { method: "getInstance" },
+      );
     }
+
+    Client.instance.logger.debug(
+      "Client instance exists and will be returned.",
+      { method: "getInstance" },
+    );
     return Client.instance;
   }
 }