fix: remove module level loggers that were not updated if sdk logger is updated after import

FedericoAmura · FedericoAmura · commit 2016736236dc · 2025-03-13T20:59:56.000+01:00
diff --git a/packages/access-control-conditions/src/lib/hashing.ts b/packages/access-control-conditions/src/lib/hashing.ts
@@ -1,5 +1,5 @@
 import { InvalidAccessControlConditions } from '@lit-protocol/constants';
-import { getChildLogger } from '@lit-protocol/logger';
+import { logger } from '@lit-protocol/logger';
 import {
   AccessControlConditions,
   EvmContractConditions,
@@ -19,8 +19,6 @@ import {
   canonicalUnifiedAccessControlConditionFormatter,
 } from './canonicalFormatter';
 
-const logger = getChildLogger({ module: 'hashing' });
-
 // Same as:
 // const unifiedAccs = [
 //   {
diff --git a/packages/access-control-conditions/src/lib/humanizer.ts b/packages/access-control-conditions/src/lib/humanizer.ts
@@ -7,7 +7,7 @@ import {
   LitEVMChainKeys,
   InvalidUnifiedConditionType,
 } from '@lit-protocol/constants';
-import { getChildLogger } from '@lit-protocol/logger';
+import { logger } from '@lit-protocol/logger';
 import {
   AccessControlConditions,
   AccsCOSMOSParams,
@@ -17,8 +17,6 @@ import {
   UnifiedAccessControlConditions,
 } from '@lit-protocol/types';
 
-const logger = getChildLogger({ module: 'humanizer' });
-
 export const ERC20ABI = [
   {
     constant: true,
diff --git a/packages/auth/src/lib/authenticators/metamask/eth.ts b/packages/auth/src/lib/authenticators/metamask/eth.ts
@@ -27,7 +27,7 @@ import {
   LIT_CHAINS_KEYS,
 } from '@lit-protocol/constants';
 import { validateSessionSig } from '@lit-protocol/lit-node-client';
-import { getChildLogger } from '@lit-protocol/logger';
+import { getChildLogger, logger } from '@lit-protocol/logger';
 import {
   getStorageItem,
   setStorageItem,
@@ -38,7 +38,6 @@ import { AuthCallbackParams, AuthSig } from '@lit-protocol/types';
 import LitConnectModal from './connect-modal/modal';
 
 const deprecated = depd('lit-js-sdk:auth:metamask-authenticator:index');
-const logger = getChildLogger({ module: 'eth' });
 
 if (globalThis && typeof globalThis.Buffer === 'undefined') {
   globalThis.Buffer = BufferPolyfill;
@@ -237,10 +236,11 @@ export const getMustResign = (
       );
       mustResign = true;
     }
-  } catch (e) {
+  } catch (error) {
     logger.error({
+      function: 'getMustResign',
       msg: 'error parsing siwe sig. Making the user sign again',
-      e,
+      error,
     });
     mustResign = true;
   }
@@ -335,11 +335,11 @@ export const connectWeb3 = async ({
     );
     // @ts-expect-error provider is not typed
     await provider.enable();
-  } catch (e) {
-    logger.info(
-      "error enabling provider but swallowed it because it's not important.  most wallets use a different function now to enable the wallet so you can ignore this error, because those other methods will be tried.",
-      e
-    );
+  } catch (error) {
+    logger.info({
+      msg: "error enabling provider but swallowed it because it's not important. Most wallets use a different function now to enable the wallet so you can ignore this error, those other methods will be tried.",
+      error,
+    });
   }
 
   logger.info('listing accounts');
@@ -398,10 +398,11 @@ export const checkAndSignEVMAuthMessage = async ({
   walletConnectProjectId,
   nonce,
 }: AuthCallbackParams): Promise<AuthSig> => {
+  const logger = getChildLogger({ function: 'checkAndSignEVMAuthMessage' });
   // -- check if it's Node.js
   if (Environment.isNode) {
     logger.info(
-      'checkAndSignEVMAuthMessage is not supported in nodejs.  You can create a SIWE on your own using the SIWE package.'
+      'checkAndSignEVMAuthMessage is not supported in nodejs. You can create a SIWE on your own using the SIWE package.'
     );
     return {
       sig: '',
@@ -509,10 +510,10 @@ export const checkAndSignEVMAuthMessage = async ({
     logger.info('checking if sig is in local storage');
     const authSigString = getStorageItem(LOCAL_STORAGE_KEYS.AUTH_SIGNATURE);
     authSig = JSON.parse(authSigString);
-  } catch (e) {
+  } catch (error) {
     logger.warn({
       msg: 'Could not get sig from local storage',
-      error: e,
+      error,
     });
   }
 
@@ -789,7 +790,7 @@ export const signMessageAsync = async (
 ): Promise<any | JsonRpcSigner> => {
   // check if it's nodejs
   if (Environment.isNode) {
-    logger.info('signMessageAsync is not supported in nodejs.');
+    logger.warn('signMessageAsync is not supported in nodejs.');
     return null;
   }
 
@@ -803,14 +804,16 @@ export const signMessageAsync = async (
         address.toLowerCase(),
       ]);
       return signature;
-    } catch (e: any) {
-      logger.info(
-        'Signing with personal_sign failed, trying signMessage as a fallback'
-      );
-      if (e.message.includes('personal_sign')) {
+    } catch (error: any) {
+      logger.warn({
+        function: 'signMessageAsync',
+        msg: 'Signing with personal_sign failed, trying signMessage as a fallback',
+        error,
+      });
+      if (error.message.includes('personal_sign')) {
         return await signer.signMessage(messageBytes);
       }
-      throw e;
+      throw error;
     }
   } else {
     logger.info('signing with signMessage');
diff --git a/packages/auth/src/lib/authenticators/validators.ts b/packages/auth/src/lib/authenticators/validators.ts
@@ -1,11 +1,10 @@
 import { getChildLogger } from '@lit-protocol/logger';
 import { MintRequestBody } from '@lit-protocol/types';
 
-const logger = getChildLogger({ module: 'validators' });
-
 export const validateMintRequestBody = (
   customArgs: Partial<MintRequestBody>
 ): boolean => {
+  const logger = getChildLogger({ function: 'validateMintRequestBody' });
   let isValid = true;
   const validKeys = [
     'keyType',
@@ -83,7 +82,7 @@ export const validateMintRequestBody = (
       ))
   ) {
     logger.error(
-      'Invalid type for permittedAuthMethodScopes: expected an array of arrays of numberr.'
+      'Invalid type for permittedAuthMethodScopes: expected an array of arrays of number.'
     );
     isValid = false;
   }
diff --git a/packages/contracts-sdk/src/lib/helpers/addresses.ts b/packages/contracts-sdk/src/lib/helpers/addresses.ts
@@ -12,12 +12,10 @@ import {
   ParamsMissingError,
 } from '@lit-protocol/constants';
 import { publicKeyCompress } from '@lit-protocol/crypto';
-import { getChildLogger } from '@lit-protocol/logger';
+import { logger } from '@lit-protocol/logger';
 import { getStorageItem, setStorageItem } from '@lit-protocol/misc-browser';
 import { DerivedAddresses } from '@lit-protocol/types';
 
-const logger = getChildLogger({ module: 'addresses' });
-
 /**
  * Derives a Bitcoin address (P2PKH) from a public key.
  *
@@ -188,6 +186,7 @@ export const derivedAddresses = async (
       }
     } catch (e) {
       logger.error({
+        function: 'derivedAddresses',
         msg: `Could not get ${CACHE_KEY} from storage. Continuing...`,
         error: e,
       });
@@ -235,6 +234,7 @@ export const derivedAddresses = async (
         setStorageItem(CACHE_KEY, JSON.stringify(cachedPkpJSON));
       } catch (e) {
         logger.error({
+          function: 'derivedAddresses',
           msg: `Could not get ${CACHE_KEY} from storage. Continuing...`,
           error: e,
         });
diff --git a/packages/crypto/src/lib/crypto.ts b/packages/crypto/src/lib/crypto.ts
@@ -11,7 +11,7 @@ import {
   UnknownError,
   UnknownSignatureError,
 } from '@lit-protocol/constants';
-import { getChildLogger } from '@lit-protocol/logger';
+import { logger } from '@lit-protocol/logger';
 import { getStorageItem, setStorageItem } from '@lit-protocol/misc-browser';
 import { NodeAttestation, SessionKeyPair, SigShare } from '@lit-protocol/types';
 import {
@@ -28,8 +28,6 @@ import {
   sevSnpVerify,
 } from '@lit-protocol/wasm';
 
-const logger = getChildLogger({ module: 'crypto' });
-
 /** ---------- Exports ---------- */
 const LIT_CORS_PROXY = `https://cors.litgateway.com`;
 
@@ -409,21 +407,26 @@ async function getAmdCert(url: string): Promise<Uint8Array> {
 
   try {
     return await fetchAsUint8Array(proxyUrl);
-  } catch (e) {
-    logger.info({
-      msg: `[getAmdCert] Failed to fetch AMD cert from proxy:`,
-      e,
+  } catch (error) {
+    logger.error({
+      function: 'getAmdCert',
+      msg: `Failed to fetch AMD cert from proxy`,
+      error,
     });
   }
 
   // Try direct fetch only if proxy fails
-  logger.info('[getAmdCert] Attempting to fetch directly without proxy.');
+  logger.info('Attempting to fetch directly without proxy.');
 
   try {
     return await fetchAsUint8Array(url);
-  } catch (e) {
-    logger.error({ msg: '[getAmdCert] Direct fetch also failed', e });
-    throw e; // Re-throw to signal that both methods failed
+  } catch (error) {
+    logger.error({
+      function: 'getAmdCert',
+      msg: 'Direct fetch also failed',
+      error,
+    });
+    throw error; // Re-throw to signal that both methods failed
   }
 }
 
diff --git a/packages/lit-node-client/src/lib/helpers/get-signatures.ts b/packages/lit-node-client/src/lib/helpers/get-signatures.ts
@@ -9,14 +9,12 @@ import {
 } from '@lit-protocol/constants';
 import { mostCommonValue } from '@lit-protocol/core';
 import { combineEcdsaShares } from '@lit-protocol/crypto';
-import { getChildLogger } from '@lit-protocol/logger';
+import { logger } from '@lit-protocol/logger';
 import {
   EcdsaSignedMessageShareParsed,
   SigResponse,
 } from '@lit-protocol/types';
 
-const logger = getChildLogger({ module: 'get-signatures' });
-
 /**
  * Retrieves and combines signature shares from multiple nodes to generate the final signatures.
  *
@@ -54,6 +52,7 @@ export const getSignatures = async (params: {
 
   if (signedMessageShares.length < threshold) {
     logger.error({
+      function: 'getSignatures',
       requestId,
       msg: `not enough nodes to get the signatures. Expected ${threshold}, got ${signedMessageShares.length}`,
     });
diff --git a/packages/lit-node-client/src/lib/helpers/parse-as-json-or-string.ts b/packages/lit-node-client/src/lib/helpers/parse-as-json-or-string.ts
@@ -1,6 +1,4 @@
-import { getChildLogger } from '@lit-protocol/logger';
-
-const logger = getChildLogger({ module: 'parseAsJsonOrString' });
+import { logger } from '@lit-protocol/logger';
 
 /**
  * Parses a response string into a JS object.
@@ -14,10 +12,11 @@ export const parseAsJsonOrString = (
   try {
     return JSON.parse(responseString);
   } catch (e) {
-    logger.info(
-      '[parseResponses] Error parsing response as json.  Swallowing and returning as string.',
-      responseString
-    );
+    logger.warn({
+      function: 'parseAsJsonOrString',
+      msg: 'Error parsing response as json. Swallowing and returning as string.',
+      responseString,
+    });
     return responseString;
   }
 };
diff --git a/packages/lit-node-client/src/lib/helpers/process-lit-action-response-strategy.ts b/packages/lit-node-client/src/lib/helpers/process-lit-action-response-strategy.ts
@@ -1,10 +1,6 @@
-import { getChildLogger } from '@lit-protocol/logger';
+import { logger } from '@lit-protocol/logger';
 import { LitActionResponseStrategy, NodeShare } from '@lit-protocol/types';
 
-const logger = getChildLogger({
-  module: 'process-lit-action-response-strategy',
-});
-
 /**
  * Finds the most and least common object within an of objects array
  * @param responses T[]
@@ -44,6 +40,7 @@ export const processLitActionResponseStrategy = (
       }
     } catch (e) {
       logger.error({
+        function: 'processLitActionResponseStrategy',
         msg: 'Error while executing custom response filter, defaulting to most common',
         error: (e as Error).toString(),
       });
diff --git a/packages/lit-node-client/src/lib/helpers/session-sigs-reader.ts b/packages/lit-node-client/src/lib/helpers/session-sigs-reader.ts
@@ -1,10 +1,8 @@
 import { InvalidArgumentException } from '@lit-protocol/constants';
-import { getChildLogger } from '@lit-protocol/logger';
+import { logger } from '@lit-protocol/logger';
 
 import { parseSignedMessage } from './session-sigs-validator';
 
-const logger = getChildLogger({ module: 'serssion-sigs-reader' });
-
 function formatDuration(start: Date, end: Date): string {
   const diff = end.getTime() - start.getTime();
   const days = Math.floor(diff / (1000 * 60 * 60 * 24));
@@ -132,6 +130,7 @@ export function formatSessionSigs(
     } catch (e) {
       // swallow error
       logger.info({
+        function: 'formatSessionSigs',
         msg: 'Error parsing attenuation',
         error: e,
       });
diff --git a/packages/logger/src/lib/logger.spec.ts b/packages/logger/src/lib/logger.spec.ts
@@ -47,17 +47,22 @@ describe('logger', () => {
     }, 50);
   });
 
-  it('should log messages correctly on a child logger', (done) => {
+  it('should log messages on a child logger using the parent transport but adding its bindings', (done) => {
     // Override the global logger for consistency in our test:
     const testStream = new TestStream();
     setLoggerOptions({ level: 'info', name: 'ParentTestLogger' }, testStream);
     const childLogger = getChildLogger({ module: 'ChildModule' });
     childLogger.info('Child message');
 
     setTimeout(() => {
-      expect(testStream.data).toMatch(/Child message/);
-      expect(testStream.data).toMatch(/ChildModule/);
-      done();
+      try {
+        expect(testStream.data).toMatch('"name":"ParentTestLogger"');
+        expect(testStream.data).toMatch('"msg":"Child message"');
+        expect(testStream.data).toMatch('"module":"ChildModule"');
+        done();
+      } catch (error) {
+        done(error);
+      }
     }, 50);
   });
 });
diff --git a/packages/wrapped-keys/src/lib/api/utils.ts b/packages/wrapped-keys/src/lib/api/utils.ts
@@ -1,6 +1,6 @@
 import { ethers } from 'ethers';
 
-import { getChildLogger } from '@lit-protocol/logger';
+import { logger } from '@lit-protocol/logger';
 import {
   AccsDefaultParams,
   AuthSig,
@@ -11,8 +11,6 @@ import {
 import { CHAIN_ETHEREUM, NETWORK_EVM, NETWORK_SOLANA } from '../constants';
 import { KeyType, Network } from '../types';
 
-const logger = getChildLogger({ module: 'wrapped-keys/api/utils' });
-
 export function getKeyTypeFromNetwork(network: Network): KeyType {
   if (network === NETWORK_EVM) {
     return 'K256';
