Ensure URLs are logged after validation

ChainSafe · Dec 11, 2023 · d64cdca · d64cdca
1 parent 71fef20
commit d64cdca
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 35 deletions.
diff --git a/packages/beacon-node/src/eth1/provider/eth1Provider.ts b/packages/beacon-node/src/eth1/provider/eth1Provider.ts
@@ -75,7 +75,6 @@ export class Eth1Provider implements IEth1Provider {
     this.depositContractAddress = toHexString(config.DEPOSIT_CONTRACT_ADDRESS);
 
     const providerUrls = opts.providerUrls ?? DEFAULT_PROVIDER_URLS;
-    this.logger?.info("Eth1 provider", {urls: providerUrls.map(toSafePrintableUrl).toString()});
     this.rpc = new JsonRpcHttpClient(providerUrls, {
       signal,
       // Don't fallback with is truncated error. Throw early and let the retry on this class handle it
@@ -85,6 +84,7 @@ export class Eth1Provider implements IEth1Provider {
       jwtVersion: opts.jwtVersion,
       metrics: metrics,
     });
+    this.logger?.info("Eth1 provider", {urls: providerUrls.map(toSafePrintableUrl).toString()});
 
     this.rpc.emitter.on(JsonRpcHttpClientEvent.RESPONSE, () => {
       const oldState = this.state;

diff --git a/packages/beacon-node/src/execution/builder/http.ts b/packages/beacon-node/src/execution/builder/http.ts
@@ -50,7 +50,6 @@ export class ExecutionBuilderHttp implements IExecutionBuilder {
   ) {
     const baseUrl = opts.urls[0];
     if (!baseUrl) throw Error("No Url provided for executionBuilder");
-    logger?.info("External builder", {url: toSafePrintableUrl(baseUrl)});
     this.api = getClient(
       {
         baseUrl,
@@ -59,6 +58,7 @@ export class ExecutionBuilderHttp implements IExecutionBuilder {
       },
       {config, metrics: metrics?.builderHttpClient}
     );
+    logger?.info("External builder", {url: toSafePrintableUrl(baseUrl)});
     this.config = config;
     this.issueLocalFcUWithFeeRecipient = opts.issueLocalFcUWithFeeRecipient;
 

diff --git a/packages/beacon-node/src/execution/engine/index.ts b/packages/beacon-node/src/execution/engine/index.ts
@@ -31,7 +31,6 @@ export function getExecutionEngineHttp(
   opts: ExecutionEngineHttpOpts,
   modules: ExecutionEngineModules
 ): IExecutionEngine {
-  modules.logger.info("Execution client", {urls: opts.urls.map(toSafePrintableUrl).toString()});
   const rpc = new JsonRpcHttpClient(opts.urls, {
     ...opts,
     signal: modules.signal,
@@ -40,6 +39,7 @@ export function getExecutionEngineHttp(
     jwtId: opts.jwtId,
     jwtVersion: opts.jwtVersion,
   });
+  modules.logger.info("Execution client", {urls: opts.urls.map(toSafePrintableUrl).toString()});
   return new ExecutionEngineHttp(rpc, modules);
 }
 

diff --git a/packages/utils/src/url.ts b/packages/utils/src/url.ts
@@ -21,12 +21,9 @@ export function isValidHttpUrl(urlStr: string): boolean {
 
 /**
  * Sanitize URL to prevent leaking user credentials in logs
+ *
+ * Note: `urlStr` must be a valid URL
  */
 export function toSafePrintableUrl(urlStr: string): string {
-  try {
-    return new URL(urlStr).origin;
-  } catch (_) {
-    // Best effort to sanitize value if an invalid URL is provided
-    return urlStr.replace(/(.*?:\/\/|.*?:\/)?(.*?:.*?@)/, "$1");
-  }
+  return new URL(urlStr).origin;
 }
diff --git a/packages/utils/test/unit/url.test.ts b/packages/utils/test/unit/url.test.ts
diff --git a/packages/validator/src/validator.ts b/packages/validator/src/validator.ts
@@ -268,10 +268,10 @@ export class Validator {
     let api: Api;
     if (typeof opts.api === "string" || Array.isArray(opts.api)) {
       const urls = typeof opts.api === "string" ? [opts.api] : opts.api;
-      logger.info("Beacon node", {urls: urls.map(toSafePrintableUrl).toString()});
       // This new api instance can make do with default timeout as a faster timeout is
       // not necessary since this instance won't be used for validator duties
       api = getClient({urls, getAbortSignal: () => opts.abortController.signal}, {config, logger});
+      logger.info("Beacon node", {urls: urls.map(toSafePrintableUrl).toString()});
     } else {
       api = opts.api;
     }