From 1918560609cdb484513b0a9fe1232fdf7a0cb5bc Mon Sep 17 00:00:00 2001 From: J M Rossy Date: Tue, 19 Dec 2023 14:59:27 -0500 Subject: [PATCH] Reduce verbosity of smartprovider logging (#3084) --- .../HyperlaneEtherscanProvider.ts | 15 ++++++----- .../SmartProvider/HyperlaneJsonRpcProvider.ts | 8 +++--- .../providers/SmartProvider/SmartProvider.ts | 25 ++++++++++--------- .../sdk/src/providers/SmartProvider/types.ts | 1 + 4 files changed, 28 insertions(+), 21 deletions(-) diff --git a/typescript/sdk/src/providers/SmartProvider/HyperlaneEtherscanProvider.ts b/typescript/sdk/src/providers/SmartProvider/HyperlaneEtherscanProvider.ts index 7177cf229..25acd5344 100644 --- a/typescript/sdk/src/providers/SmartProvider/HyperlaneEtherscanProvider.ts +++ b/typescript/sdk/src/providers/SmartProvider/HyperlaneEtherscanProvider.ts @@ -30,6 +30,7 @@ export class HyperlaneEtherscanProvider constructor( public readonly explorerConfig: BlockExplorer, network: providers.Networkish, + public readonly options?: { debug?: boolean }, ) { super(network, explorerConfig.apiKey); if (!explorerConfig.apiKey) { @@ -80,9 +81,10 @@ export class HyperlaneEtherscanProvider const hostname = this.getHostname(); let waitTime = this.getQueryWaitTime(); while (waitTime > 0) { - this.logger( - `HyperlaneEtherscanProvider waiting ${waitTime}ms to avoid rate limit`, - ); + if (this.options?.debug) + this.logger( + `HyperlaneEtherscanProvider waiting ${waitTime}ms to avoid rate limit`, + ); await sleep(waitTime); waitTime = this.getQueryWaitTime(); } @@ -92,9 +94,10 @@ export class HyperlaneEtherscanProvider } async perform(method: string, params: any, reqId?: number): Promise { - this.logger( - `HyperlaneEtherscanProvider performing method ${method} for reqId ${reqId}`, - ); + if (this.options?.debug) + this.logger( + `HyperlaneEtherscanProvider performing method ${method} for reqId ${reqId}`, + ); if (!this.supportedMethods.includes(method as ProviderMethod)) throw new Error(`Unsupported method ${method}`); diff --git a/typescript/sdk/src/providers/SmartProvider/HyperlaneJsonRpcProvider.ts b/typescript/sdk/src/providers/SmartProvider/HyperlaneJsonRpcProvider.ts index 15220ef3a..1a3ffbe6b 100644 --- a/typescript/sdk/src/providers/SmartProvider/HyperlaneJsonRpcProvider.ts +++ b/typescript/sdk/src/providers/SmartProvider/HyperlaneJsonRpcProvider.ts @@ -23,14 +23,16 @@ export class HyperlaneJsonRpcProvider constructor( public readonly rpcConfig: RpcConfigWithConnectionInfo, network: providers.Networkish, + public readonly options?: { debug?: boolean }, ) { super(rpcConfig.connection ?? rpcConfig.http, network); } async perform(method: string, params: any, reqId?: number): Promise { - this.logger( - `HyperlaneJsonRpcProvider performing method ${method} for reqId ${reqId}`, - ); + if (this.options?.debug) + this.logger( + `HyperlaneJsonRpcProvider performing method ${method} for reqId ${reqId}`, + ); if (method === ProviderMethod.GetLogs) { return this.performGetLogs(params); } diff --git a/typescript/sdk/src/providers/SmartProvider/SmartProvider.ts b/typescript/sdk/src/providers/SmartProvider/SmartProvider.ts index 49dbda1c5..227dc3827 100644 --- a/typescript/sdk/src/providers/SmartProvider/SmartProvider.ts +++ b/typescript/sdk/src/providers/SmartProvider/SmartProvider.ts @@ -195,7 +195,6 @@ export class HyperlaneSmartProvider // Trigger the next provider in line if (pIndex < providers.length) { const provider = providers[pIndex]; - const providerUrl = provider.getBaseUrl(); const isLastProvider = pIndex === providers.length - 1; // Skip the explorer provider if it's currently in a cooldown period @@ -211,7 +210,7 @@ export class HyperlaneSmartProvider const resultPromise = this.wrapProviderPerform( provider, - providerUrl, + pIndex, method, params, reqId, @@ -225,7 +224,7 @@ export class HyperlaneSmartProvider return result.value; } else if (result.status === ProviderStatus.Timeout) { this.logger( - `Slow response from provider using ${providerUrl}.${ + `Slow response from provider #${pIndex}.${ !isLastProvider ? ' Triggering next provider.' : '' }`, ); @@ -233,7 +232,7 @@ export class HyperlaneSmartProvider pIndex += 1; } else if (result.status === ProviderStatus.Error) { this.logger( - `Error from provider using ${providerUrl}.${ + `Error from provider #${pIndex}.${ !isLastProvider ? ' Triggering next provider.' : '' }`, ); @@ -283,22 +282,24 @@ export class HyperlaneSmartProvider // Warp for additional logging and error handling protected async wrapProviderPerform( provider: HyperlaneProvider, - providerUrl: string, + pIndex: number, method: string, params: any, reqId: number, ): Promise { try { - this.logger( - `Provider using ${providerUrl} performing method ${method} for reqId ${reqId}`, - ); + if (this.options?.debug) + this.logger( + `Provider #${pIndex} performing method ${method} for reqId ${reqId}`, + ); const result = await provider.perform(method, params, reqId); return { status: ProviderStatus.Success, value: result }; } catch (error) { - this.logger( - `Error performing ${method} on provider ${providerUrl} for reqId ${reqId}`, - error, - ); + if (this.options?.debug) + this.logger( + `Error performing ${method} on provider #${pIndex} for reqId ${reqId}`, + error, + ); return { status: ProviderStatus.Error, error }; } } diff --git a/typescript/sdk/src/providers/SmartProvider/types.ts b/typescript/sdk/src/providers/SmartProvider/types.ts index 99ab30623..487d37893 100644 --- a/typescript/sdk/src/providers/SmartProvider/types.ts +++ b/typescript/sdk/src/providers/SmartProvider/types.ts @@ -50,4 +50,5 @@ export interface ProviderRetryOptions { export interface SmartProviderOptions extends ProviderRetryOptions { // The time to wait before attempting the next provider fallbackStaggerMs?: number; + debug?: boolean; }