feat(logger): update log statements

Author: larisa17

embed/src/main.ts

@@ -2,14 +2,14 @@ import "dotenv/config";
 
 // ---- Main App from index
 import { app } from "./server.js";
-
+import { logger } from "./utils/logger.js";
 // default port to listen on
 const port = process.env.EMBED_PORT || 80;
 
 const startServer = (): void => {
   const server = app.listen(port, () => {
     // eslint-disable-next-line no-console
-    console.log(`server started at http://localhost:${port}`);
+    logger.info(`server started at http://localhost:${port}`);
   });
 
   // This should be > the ELB idle timeout, which is 60 seconds
@@ -21,5 +21,5 @@ try {
   startServer();
 } catch (error) {
   // eslint-disable-next-line no-console
-  console.error(error);
+  logger.error(error);
 }

embed/src/redis.ts

@@ -1,12 +1,12 @@
 import { Redis } from "ioredis";
-
+import { logger } from "./utils/logger.js";
 export const redis = new Redis(process.env.REDIS_URL as string);
 
 // Log errors and connection success
 redis.on("connect", () => {
-  console.log("Connected to Redis");
+  logger.info("Connected to Redis");
 });
 
 redis.on("error", (err) => {
-  console.error("Redis connection error:", err);
+  logger.error("Redis connection error:", err);
 });

embed/src/server.ts

@@ -14,7 +14,7 @@ import { keyGenerator } from "./rateLimiterKeyGenerator.js";
 import { autoVerificationHandler, verificationHandler, getChallengeHandler } from "./handlers.js";
 import { metadataHandler } from "./metadata.js";
 import { serverUtils } from "./utils/identityHelper.js";
-
+import { logger } from "./utils/logger.js";
 // ---- Config - check for all required env variables
 // We want to prevent the app from starting with default values or if it is misconfigured
 const configErrors = [];
@@ -41,7 +41,7 @@ if (!process.env.REDIS_URL) {
 }
 
 if (configErrors.length > 0) {
-  configErrors.forEach((error) => console.error(error)); // eslint-disable-line no-console
+  configErrors.forEach((error) => logger.error(error));
   throw new Error("Missing required configuration: " + configErrors.join(",\n"));
 }
 

embed/src/utils/logger.ts

@@ -0,0 +1,7 @@
+import pinoImport from "pino";
+const pino = pinoImport.default;
+// https://github.com/pinojs/pino
+
+export const logger = pino();
+
+logger.info("Logger initialized");

iam/src/index.ts

@@ -10,13 +10,6 @@ import { challengeHandler, checkHandler, easScoreV2Handler, verifyHandler } from
 import { serverUtils } from "./utils/identityHelper.js";
 import { logger } from "./utils/logger.js";
 
-logger.info("Hello initial log ");
-logger.info("Hello multi line log");
-logger.info(`This is a multi-line log message:
-Line 1: Application is starting.
-Line 2: Environment variables are being checked.
-Line 3: Initialization is in progress.`);
-
 // ---- Config - check for all required env variables
 // We want to prevent the app from starting with default values or if it is misconfigured
 const configErrors = [
@@ -40,7 +33,7 @@ const configErrors = [
   .filter(Boolean);
 
 if (configErrors.length > 0) {
-  configErrors.forEach((error) => console.error(error)); // eslint-disable-line no-console
+  configErrors.forEach((error) => logger.error(error));
   throw new Error("Missing required configuration");
 }
 

iam/src/main.ts

@@ -1,4 +1,5 @@
 import "dotenv/config";
+import { logger } from "./utils/logger.js";
 
 // ---- Main App from index
 import { app } from "./index.js";
@@ -13,15 +14,13 @@ const startServer = async (): Promise<void> => {
   });
 
   const server = app.listen(port, () => {
-    // eslint-disable-next-line no-console
-    console.log(`server started at http://localhost:${port}`);
+    logger.info(`server started at http://localhost:${port}`);
   });
 
   // This should be > the ELB idle timeout, which is 60 seconds
   server.keepAliveTimeout = 61 * 1000;
 };
 
 startServer().catch((error) => {
-  // eslint-disable-next-line no-console
-  console.error(error);
+  logger.error(error);
 });

iam/src/utils/easFees.ts

@@ -1,6 +1,7 @@
 import { parseEther } from "ethers";
 import Moralis from "moralis";
 import { PassportCache } from "@gitcoin/passport-platforms";
+import { logger } from "./logger.js";
 
 const FIVE_MINUTES = 1000 * 60 * 5;
 const WETH_CONTRACT = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2";
@@ -43,12 +44,12 @@ class EthPriceLoader {
       } catch (e) {
         let message = "Failed to cache ETH price";
         if (e instanceof Error) message += `, ${e.name}: ${e.message}`;
-        console.error(`REDIS CONNECTION ERROR: ${message}`);
+        logger.error(`REDIS CONNECTION ERROR: ${message}`);
       }
     } catch (e) {
       let message = "Failed to get ETH price";
       if (e instanceof Error) message += `, ${e.name}: ${e.message}`;
-      console.error(`MORALIS ERROR: ${message}`);
+      logger.error(`MORALIS ERROR: ${message}`);
     }
   }
 }

iam/src/utils/revocations.ts

@@ -2,7 +2,7 @@ import { handleAxiosError } from "@gitcoin/passport-platforms";
 import axios from "axios";
 import { VerifiableCredential, VerifiableEip712Credential } from "@gitcoin/passport-types";
 import { serverUtils } from "../utils/identityHelper.js";
-
+import { logger } from "./logger.js";
 const { InternalApiError } = serverUtils;
 
 const SCORER_ENDPOINT = process.env.SCORER_ENDPOINT;
@@ -48,7 +48,7 @@ export const filterRevokedCredentials = async (
 const fetchRevocations = async (proofValues: string[]): Promise<Revocation[]> => {
   const payload = { proof_values: proofValues };
 
-  console.log("Checking revocations", payload);
+  logger.info("Checking revocations", payload);
 
   try {
     const revocationResponse: {

identity/src/credentials.ts

@@ -19,6 +19,7 @@ import {
 } from "./signingDocuments.js";
 import { IgnorableNullifierGeneratorError, NullifierGenerator } from "./nullifierGenerators.js";
 import { checkRotatingKeysEnabled } from "./helpers.js";
+import { logger } from "./logger.js";
 
 // Control expiry times of issued credentials
 export const CHALLENGE_EXPIRES_AFTER_SECONDS = 60; // 1min
@@ -137,7 +138,7 @@ const getNullifiers = async ({
     .filter((result) => !(result.reason instanceof IgnorableNullifierGeneratorError));
 
   if (unexpectedErrors.length > 0) {
-    console.error("Unexpected errors generating nullifiers", unexpectedErrors); // eslint-disable-line no-console
+    logger.error("Unexpected errors generating nullifiers", unexpectedErrors); // eslint-disable-line no-console
     throw new Error("Unable to generate nullifiers");
   }
 

identity/src/humanNetworkOprf.ts

@@ -2,10 +2,11 @@ import { readFileSync } from "fs";
 import { join, dirname } from "path";
 
 import { initSync as humanNetworkInitSync, generate_oprf, enable_errors } from "@holonym-foundation/mishtiwasm";
+import { logger } from "./logger.js";
 
 // TODO: ideally this would be handled in the wasm module
 process.on("uncaughtException", (err): void => {
-  console.error("Uncaught exception:", err); // eslint-disable-line no-console
+  logger.error("Uncaught exception:", err); // eslint-disable-line no-console
   if (!err.toString().includes("RuntimeError: unreachable")) {
     throw err;
   }
@@ -26,7 +27,7 @@ const initializeHumanNetwork = () => {
   // TODO leaving in in case there are any weird
   // issues in other environments, but can be removed
   // next time we're in this file
-  console.log("Loading wasm module", wasmPath);
+  logger.info("Loading wasm module", wasmPath);
 
   const wasmModuleBuffer = readFileSync(wasmPath);
 

identity/src/keyManager.ts

@@ -20,7 +20,7 @@
 // key in the list, with version "0.0.0"
 
 import { checkRotatingKeysEnabled } from "./helpers.js";
-
+import { logger } from "./logger.js";
 const MAX_CONCURRENT_KEYS = 2;
 
 const LEGACY_KEY_ENV_NAME = "IAM_JWK_EIP712";
@@ -80,7 +80,7 @@ const getLegacyKeyVersion = (): KeyVersion | undefined => {
   const key = process.env[LEGACY_KEY_ENV_NAME];
 
   if (!key) {
-    console.warn(`Warning: No legacy key (${LEGACY_KEY_ENV_NAME}) found in ENV`);
+    logger.warn(`Warning: No legacy key (${LEGACY_KEY_ENV_NAME}) found in ENV`);
   }
 
   return (
@@ -109,7 +109,7 @@ const loadInitiatedRotatingKeyVersions = (): KeyVersion[] => {
   }
 
   if (initiatedKeyVersions.length === 0) {
-    console.warn("Warning: No valid IAM_JWK_EIP712_V* keys configured");
+    logger.warn("Warning: No valid IAM_JWK_EIP712_V* keys configured");
   }
 
   return initiatedKeyVersions;

identity/src/logger.ts

@@ -0,0 +1,7 @@
+import pinoImport from "pino";
+const pino = pinoImport.default;
+// https://github.com/pinojs/pino
+
+export const logger = pino();
+
+logger.info("Logger initialized");

identity/src/nullifierGenerators.ts

@@ -8,6 +8,7 @@ import * as base64 from "@ethersproject/base64";
 import { createHash } from "crypto";
 import { objToSortedArray } from "./helpers.js";
 import { humanNetworkOprf } from "./humanNetworkOprf.js";
+import { logger } from "./logger.js";
 
 export type NullifierGenerator = ({ record }: { record: ProofRecord }) => Promise<string>;
 
@@ -124,7 +125,7 @@ export const HumanNetworkNullifierGenerator =
     } catch (e) {
       // For now, ignore errors with humanNetwork
       // TODO remove this once beta testing is complete
-      console.error("Error generating humanNetwork nullifier (ignoring): ", e);
+      logger.error("Error generating humanNetwork nullifier (ignoring): ", e);
       throw new IgnorableNullifierGeneratorError("Error generating humanNetwork nullifier");
     }
   };

identity/src/serverUtils/errorHandlerMiddleware.ts

@@ -1,6 +1,6 @@
 import { Request, Response } from "express";
 import { ApiError } from "./apiError.js";
-
+import { logger } from "./logger.js";
 // Middleware to handle errors
 // Must define 4 params for express to recognize this as an error handler
 export const errorHandlerMiddleware = (err: Error, _req: Request, res: Response, _next: unknown) => {
@@ -19,7 +19,7 @@ export const errorHandlerMiddleware = (err: Error, _req: Request, res: Response,
   //   user reaches out with issues
   const randomID = Math.random().toString(36).substring(2, 8);
 
-  console.log("Unexpected error:", formatSystemMessage(err, randomID)); // eslint-disable-line no-console
+  logger.debug("Unexpected error:", formatSystemMessage(err, randomID));
 
   return res.status(500).json(formatUserResponse(err, randomID));
 };

identity/src/verification.ts

@@ -6,6 +6,7 @@ import { platforms, providers } from "@gitcoin/passport-platforms";
 import { issueNullifiableCredential } from "./credentials.js";
 import { checkCredentialBans } from "./bans.js";
 import { getIssuerInfo } from "./issuers.js";
+import { logger } from "./logger.js";
 
 import * as DIDKit from "@spruceid/didkit-wasm-node";
 
@@ -114,7 +115,7 @@ export async function verifyTypes(
             const resultErrors = verifyResult.errors;
             error = resultErrors?.join(", ")?.substring(0, 1000) || "Unable to verify provider";
             if (error.includes(`Request timeout while verifying ${type}.`)) {
-              console.log(`Request timeout while verifying ${type}`);
+              logger.debug(`Request timeout while verifying ${type}`);
               // If a request times out exit loop and return results so additional requests are not made
               break;
             }

identity/src/verifyDidChallenge.ts

@@ -7,6 +7,7 @@ import { encode } from "multiformats/block";
 import { sha256 } from "multiformats/hashes/sha2";
 import { Cacao } from "@didtools/cacao";
 import { ApiError } from "./serverUtils/apiError.js";
+import { logger } from "./logger.js";
 
 class ChallengeMismatchError extends ApiError {
   constructor() {
@@ -79,7 +80,7 @@ const verifyAgeAndGetCacao = async (signedChallenge: SignedDidChallenge): Promis
     return cacao;
     // }
   } catch (e) {
-    console.error(e);
+    logger.error(e);
   }
   throw new CredentialTooOldError();
 };

package.json

@@ -93,5 +93,8 @@
       "prettier --write"
     ]
   },
-  "packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+  "packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e",
+  "dependencies": {
+    "pino": "^9.6.0"
+  }
 }