fix: increase dial timeout (#16040)

Increase default dial timeout for 500ms to 1s and also make it
configurable through an env var and the update-checker

Author: alexghr

yarn-project/foundation/src/config/env_var.ts

@@ -123,6 +123,7 @@ export type EnvVar =
   | 'P2P_PEER_PENALTY_VALUES'
   | 'P2P_QUERY_FOR_IP'
   | 'P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS'
+  | 'P2P_REQRESP_DIAL_TIMEOUT_MS'
   | 'P2P_REQRESP_OVERALL_REQUEST_TIMEOUT_MS'
   | 'P2P_DISABLE_STATUS_HANDSHAKE'
   | 'P2P_ALLOW_ONLY_VALIDATORS'

yarn-project/p2p/src/client/p2p_client.ts

@@ -154,6 +154,7 @@ export class P2PClient<T extends P2PClientType = P2PClientType.Full>
 
   public updateP2PConfig(config: Partial<P2PConfig>): Promise<void> {
     this.txPool.updateConfig(config);
+    this.p2pService.updateConfig(config);
     return Promise.resolve();
   }
 

yarn-project/p2p/src/services/dummy_service.ts

@@ -7,6 +7,7 @@ import type { PeerId } from '@libp2p/interface';
 import EventEmitter from 'events';
 
 import type { PeerManagerInterface } from './peer-manager/interface.js';
+import type { P2PReqRespConfig } from './reqresp/config.js';
 import { type AuthRequest, StatusMessage } from './reqresp/index.js';
 import type {
   ReqRespInterface,
@@ -30,6 +31,8 @@ import {
  * A dummy implementation of the P2P Service.
  */
 export class DummyP2PService implements P2PService {
+  updateConfig(_config: Partial<P2PReqRespConfig>): void {}
+
   /** Returns an empty array for peers. */
   getPeers(): PeerInfo[] {
     return [];
@@ -217,6 +220,7 @@ export class DummyPeerManager implements PeerManagerInterface {
 }
 
 export class DummyReqResp implements ReqRespInterface {
+  updateConfig(_config: Partial<P2PReqRespConfig>): void {}
   start(
     _subProtocolHandlers: ReqRespSubProtocolHandlers,
     _subProtocolValidators: ReqRespSubProtocolValidators,

yarn-project/p2p/src/services/libp2p/libp2p_service.ts

@@ -65,6 +65,7 @@ import { gossipScoreThresholds } from '../gossipsub/scoring.js';
 import type { PeerManagerInterface } from '../peer-manager/interface.js';
 import { PeerManager } from '../peer-manager/peer_manager.js';
 import { PeerScoring } from '../peer-manager/peer_scoring.js';
+import type { P2PReqRespConfig } from '../reqresp/config.js';
 import {
   DEFAULT_SUB_PROTOCOL_VALIDATORS,
   type ReqRespInterface,
@@ -173,6 +174,10 @@ export class LibP2PService<T extends P2PClientType = P2PClientType.Full> extends
     };
   }
 
+  public updateConfig(config: Partial<P2PReqRespConfig>) {
+    this.reqresp.updateConfig(config);
+  }
+
   /**
    * Creates an instance of the LibP2P service.
    * @param config - The configuration to use when creating the service.

yarn-project/p2p/src/services/reqresp/config.ts

@@ -2,12 +2,14 @@ import { type ConfigMapping, booleanConfigHelper, numberConfigHelper } from '@az
 
 export const DEFAULT_INDIVIDUAL_REQUEST_TIMEOUT_MS = 2000;
 export const DEFAULT_OVERALL_REQUEST_TIMEOUT_MS = 4000;
+export const DEFAULT_REQRESP_DIAL_TIMEOUT_MS = 1000;
 export const DEFAULT_OPTIMISTIC_NEGOTIATION = false;
 
 // For use in tests.
 export const DEFAULT_P2P_REQRESP_CONFIG: P2PReqRespConfig = {
   overallRequestTimeoutMs: DEFAULT_OVERALL_REQUEST_TIMEOUT_MS,
   individualRequestTimeoutMs: DEFAULT_INDIVIDUAL_REQUEST_TIMEOUT_MS,
+  dialTimeoutMs: DEFAULT_REQRESP_DIAL_TIMEOUT_MS,
   p2pOptimisticNegotiation: DEFAULT_OPTIMISTIC_NEGOTIATION,
 };
 
@@ -20,6 +22,9 @@ export interface P2PReqRespConfig {
 
   /** Whether to use optimistic protocol negotiation when dialing to another peer (opposite of `negotiateFully`). */
   p2pOptimisticNegotiation: boolean;
+
+  /** How long to wait for the dial protocol to establish a connection */
+  dialTimeoutMs: number;
 }
 
 export const p2pReqRespConfigMappings: Record<keyof P2PReqRespConfig, ConfigMapping> = {
@@ -33,6 +38,11 @@ export const p2pReqRespConfigMappings: Record<keyof P2PReqRespConfig, ConfigMapp
     description: 'The timeout for an individual request response peer interaction.',
     ...numberConfigHelper(DEFAULT_INDIVIDUAL_REQUEST_TIMEOUT_MS),
   },
+  dialTimeoutMs: {
+    env: 'P2P_REQRESP_DIAL_TIMEOUT_MS',
+    description: 'How long to wait for the dial protocol to establish a connection',
+    ...numberConfigHelper(DEFAULT_REQRESP_DIAL_TIMEOUT_MS),
+  },
   p2pOptimisticNegotiation: {
     env: 'P2P_REQRESP_OPTIMISTIC_NEGOTIATION',
     description:

yarn-project/p2p/src/services/reqresp/interface.ts

@@ -4,6 +4,7 @@ import { TxArray, TxHashArray } from '@aztec/stdlib/tx';
 
 import type { PeerId } from '@libp2p/interface';
 
+import type { P2PReqRespConfig } from './config.js';
 import { AuthRequest, AuthResponse } from './protocols/auth.js';
 import { BlockTxsRequest, BlockTxsResponse } from './protocols/block_txs/block_txs_reqresp.js';
 import { StatusMessage } from './protocols/status.js';
@@ -255,4 +256,6 @@ export interface ReqRespInterface {
     payload: Buffer,
     dialTimeout?: number,
   ): Promise<ReqRespResponse>;
+
+  updateConfig(config: Partial<P2PReqRespConfig>): void;
 }

yarn-project/p2p/src/services/reqresp/reqresp.ts

@@ -18,7 +18,12 @@ import {
 } from '../../errors/reqresp.error.js';
 import { SnappyTransform } from '../encoding.js';
 import type { PeerScoring } from '../peer-manager/peer_scoring.js';
-import type { P2PReqRespConfig } from './config.js';
+import {
+  DEFAULT_INDIVIDUAL_REQUEST_TIMEOUT_MS,
+  DEFAULT_OVERALL_REQUEST_TIMEOUT_MS,
+  DEFAULT_REQRESP_DIAL_TIMEOUT_MS,
+  type P2PReqRespConfig,
+} from './config.js';
 import { BatchConnectionSampler } from './connection-sampler/batch_connection_sampler.js';
 import { ConnectionSampler, RandomSampler } from './connection-sampler/connection_sampler.js';
 import {
@@ -57,8 +62,9 @@ import { ReqRespStatus, ReqRespStatusError, parseStatusChunk, prettyPrintReqResp
  * see: https://github.com/ethereum/consensus-specs/blob/dev/specs/phase0/p2p-interface.md#the-reqresp-domain
  */
 export class ReqResp implements ReqRespInterface {
-  private overallRequestTimeoutMs: number;
-  private individualRequestTimeoutMs: number;
+  private overallRequestTimeoutMs: number = DEFAULT_OVERALL_REQUEST_TIMEOUT_MS;
+  private individualRequestTimeoutMs: number = DEFAULT_INDIVIDUAL_REQUEST_TIMEOUT_MS;
+  private dialTimeoutMs: number = DEFAULT_REQRESP_DIAL_TIMEOUT_MS;
 
   // Warning, if the `start` function is not called as the parent class constructor, then the default sub protocol handlers will be used ( not good )
   private subProtocolHandlers: ReqRespSubProtocolHandlers = DEFAULT_SUB_PROTOCOL_HANDLERS;
@@ -79,8 +85,7 @@ export class ReqResp implements ReqRespInterface {
     rateLimits: Partial<ReqRespSubProtocolRateLimits> = {},
     telemetryClient: TelemetryClient = getTelemetryClient(),
   ) {
-    this.overallRequestTimeoutMs = config.overallRequestTimeoutMs;
-    this.individualRequestTimeoutMs = config.individualRequestTimeoutMs;
+    this.updateConfig(config);
 
     this.rateLimiter = new RequestResponseRateLimiter(peerScoring, rateLimits);
 
@@ -96,6 +101,20 @@ export class ReqResp implements ReqRespInterface {
     this.metrics = new ReqRespMetrics(telemetryClient);
   }
 
+  public updateConfig(config: Partial<P2PReqRespConfig>): void {
+    if (typeof config.overallRequestTimeoutMs === 'number') {
+      this.overallRequestTimeoutMs = config.overallRequestTimeoutMs;
+    }
+
+    if (typeof config.individualRequestTimeoutMs === 'number') {
+      this.individualRequestTimeoutMs = config.individualRequestTimeoutMs;
+    }
+
+    if (typeof config.dialTimeoutMs === 'number') {
+      this.dialTimeoutMs = config.dialTimeoutMs;
+    }
+  }
+
   get tracer() {
     return this.metrics.tracer;
   }
@@ -372,7 +391,7 @@ export class ReqResp implements ReqRespInterface {
     peerId: PeerId,
     subProtocol: ReqRespSubProtocol,
     payload: Buffer,
-    dialTimeout: number = 500,
+    dialTimeout: number = this.dialTimeoutMs,
   ): Promise<ReqRespResponse> {
     let stream: Stream | undefined;
     try {

yarn-project/p2p/src/services/service.ts

@@ -6,6 +6,7 @@ import type { ENR } from '@chainsafe/enr';
 import type { PeerId } from '@libp2p/interface';
 import type EventEmitter from 'events';
 
+import type { P2PReqRespConfig } from './reqresp/config.js';
 import type { StatusMessage } from './reqresp/index.js';
 import type {
   ReqRespSubProtocol,
@@ -81,6 +82,8 @@ export interface P2PService {
   ): Promise<void>;
 
   handleAuthRequestFromPeer(authRequest: AuthRequest, peerId: PeerId): Promise<StatusMessage>;
+
+  updateConfig(config: Partial<P2PReqRespConfig>): void;
 }
 
 /**

yarn-project/p2p/src/test-helpers/reqresp-nodes.ts

@@ -242,6 +242,7 @@ export const createReqResp = async (
   const config: P2PReqRespConfig = {
     overallRequestTimeoutMs: 4000,
     individualRequestTimeoutMs: 2000,
+    dialTimeoutMs: 1000,
     p2pOptimisticNegotiation: false,
   };
   const req = new ReqResp(config, p2p, peerScoring, undefined, rateLimits);