Merge 8dfad5d into 09a4e53

ChainSafe · Nov 15, 2021 · 18759b4 · 18759b4
2 parents 09a4e53 + 8dfad5d
commit 18759b4
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 2 deletions.
diff --git a/packages/cli/src/options/beaconNodeOptions/network.ts b/packages/cli/src/options/beaconNodeOptions/network.ts
@@ -11,6 +11,7 @@ export interface INetworkArgs {
   "network.localMultiaddrs": string[];
   "network.subscribeAllSubnets": boolean;
   "network.connectToDiscv5Bootnodes": boolean;
+  "network.discv5FirstQueryDelayMs": number;
 }
 
 export function parseArgs(args: INetworkArgs): IBeaconNodeOptions["network"] {
@@ -28,6 +29,7 @@ export function parseArgs(args: INetworkArgs): IBeaconNodeOptions["network"] {
     localMultiaddrs: args["network.localMultiaddrs"],
     subscribeAllSubnets: args["network.subscribeAllSubnets"],
     connectToDiscv5Bootnodes: args["network.connectToDiscv5Bootnodes"],
+    discv5FirstQueryDelayMs: args["network.discv5FirstQueryDelayMs"],
   };
 }
 
@@ -95,4 +97,11 @@ export const options: ICliCommandOptions<INetworkArgs> = {
     defaultDescription: String(defaultOptions.network.connectToDiscv5Bootnodes === true),
     group: "network",
   },
+
+  "network.discv5FirstQueryDelayMs": {
+    type: "number",
+    description: "Delay the 1st heart beat of Peer Manager after starting Discv5",
+    defaultDescription: String(defaultOptions.network.discv5FirstQueryDelayMs),
+    group: "network",
+  },
 };
diff --git a/packages/cli/test/unit/options/beaconNodeOptions.test.ts b/packages/cli/test/unit/options/beaconNodeOptions.test.ts
@@ -45,6 +45,7 @@ describe("options / beaconNodeOptions", () => {
       "network.localMultiaddrs": [],
       "network.subscribeAllSubnets": true,
       "network.connectToDiscv5Bootnodes": true,
+      "network.discv5FirstQueryDelayMs": 1000,
 
       "sync.isSingleNode": true,
       "sync.disableProcessAsChainSegment": true,
@@ -100,6 +101,7 @@ describe("options / beaconNodeOptions", () => {
         localMultiaddrs: [],
         subscribeAllSubnets: true,
         connectToDiscv5Bootnodes: true,
+        discv5FirstQueryDelayMs: 1000,
       },
       sync: {
         isSingleNode: true,

diff --git a/packages/lodestar/src/network/options.ts b/packages/lodestar/src/network/options.ts
@@ -19,6 +19,7 @@ export const defaultDiscv5Options: IDiscv5DiscoveryInputOptions = {
 export const defaultNetworkOptions: INetworkOptions = {
   maxPeers: 30, // Allow some room above targetPeers for new inbound peers
   targetPeers: 25,
+  discv5FirstQueryDelayMs: 1000,
   localMultiaddrs: ["/ip4/0.0.0.0/tcp/9000"],
   bootMultiaddrs: [],
   discv5: defaultDiscv5Options,

diff --git a/packages/lodestar/src/network/peers/discover.ts b/packages/lodestar/src/network/peers/discover.ts
@@ -19,6 +19,7 @@ const MAX_CACHED_ENR_AGE_MS = 5 * 60 * 1000;
 
 export type PeerDiscoveryOpts = {
   maxPeers: number;
+  discv5FirstQueryDelayMs: number;
   discv5: Omit<IDiscv5DiscoveryInputOptions, "metrics" | "searchInterval" | "enabled">;
 };
 
@@ -86,6 +87,8 @@ export class PeerDiscovery {
 
   /** The maximum number of peers we allow (exceptions for subnet peers) */
   private maxPeers: number;
+  private discv5StartMs: number;
+  private discv5FirstQueryDelayMs: number;
 
   constructor(modules: PeerDiscoveryModules, opts: PeerDiscoveryOpts) {
     const {libp2p, peerRpcScores, metrics, logger, config} = modules;
@@ -95,6 +98,8 @@ export class PeerDiscovery {
     this.logger = logger;
     this.config = config;
     this.maxPeers = opts.maxPeers;
+    this.discv5StartMs = 0;
+    this.discv5FirstQueryDelayMs = opts.discv5FirstQueryDelayMs;
 
     this.discv5 = Discv5.create({
       enr: opts.discv5.enr,
@@ -119,6 +124,7 @@ export class PeerDiscovery {
 
   async start(): Promise<void> {
     await this.discv5.start();
+    this.discv5StartMs = Date.now();
     this.discv5.on("discovered", this.onDiscovered);
   }
 
@@ -196,6 +202,12 @@ export class PeerDiscovery {
    * Request to find peers. First, looked at cached peers in peerStore
    */
   private async runFindRandomNodeQuery(): Promise<void> {
+    // Delay the 1st query after starting discv5
+    // See https://github.com/ChainSafe/lodestar/issues/3423
+    if (Date.now() - this.discv5StartMs <= this.discv5FirstQueryDelayMs) {
+      return;
+    }
+
     // Run a general discv5 query if one is not already in progress
     if (this.randomNodeQuery.code === QueryStatusCode.Active) {
       this.metrics?.discovery.findNodeQueryRequests.inc({action: "ignore"});

diff --git a/packages/lodestar/src/network/peers/peerManager.ts b/packages/lodestar/src/network/peers/peerManager.ts
@@ -45,6 +45,11 @@ export type PeerManagerOpts = {
   targetPeers: number;
   /** The maximum number of peers we allow (exceptions for subnet peers) */
   maxPeers: number;
+  /**
+   * Delay the 1st query after starting discv5
+   * See https://github.com/ChainSafe/lodestar/issues/3423
+   */
+  discv5FirstQueryDelayMs: number;
   /**
    * If null, Don't run discv5 queries, nor connect to cached peers in the peerStore
    */
@@ -128,7 +133,13 @@ export class PeerManager {
     this.opts = opts;
 
     // opts.discv5 === null, discovery is disabled
-    this.discovery = opts.discv5 && new PeerDiscovery(modules, {maxPeers: opts.maxPeers, discv5: opts.discv5});
+    this.discovery =
+      opts.discv5 &&
+      new PeerDiscovery(modules, {
+        maxPeers: opts.maxPeers,
+        discv5FirstQueryDelayMs: opts.discv5FirstQueryDelayMs,
+        discv5: opts.discv5,
+      });
 
     const {metrics} = modules;
     if (metrics) {

diff --git a/packages/lodestar/test/e2e/network/gossipsub.test.ts b/packages/lodestar/test/e2e/network/gossipsub.test.ts
@@ -25,6 +25,7 @@ const opts: INetworkOptions = {
   targetPeers: 1,
   bootMultiaddrs: [],
   localMultiaddrs: [],
+  discv5FirstQueryDelayMs: 0,
   discv5: null,
 };
 

diff --git a/packages/lodestar/test/e2e/network/network.test.ts b/packages/lodestar/test/e2e/network/network.test.ts
@@ -55,6 +55,7 @@ describe("network", function () {
       targetPeers: 1,
       bootMultiaddrs: [],
       localMultiaddrs: [],
+      discv5FirstQueryDelayMs: 0,
       discv5: {
         enr,
         bindAddr: bindAddrUdp,

diff --git a/packages/lodestar/test/e2e/network/peers/peerManager.test.ts b/packages/lodestar/test/e2e/network/peers/peerManager.test.ts
@@ -85,7 +85,12 @@ describe("network / peers / PeerManager", function () {
         attnetsService: mockSubnetsService,
         syncnetsService: mockSubnetsService,
       },
-      {targetPeers: 30, maxPeers: 50, discv5: null}
+      {
+        targetPeers: 30,
+        maxPeers: 50,
+        discv5: null,
+        discv5FirstQueryDelayMs: 0,
+      }
     );
     await peerManager.start();
 

diff --git a/packages/lodestar/test/e2e/network/reqresp.test.ts b/packages/lodestar/test/e2e/network/reqresp.test.ts
@@ -38,6 +38,7 @@ describe("network / ReqResp", function () {
     targetPeers: 1,
     bootMultiaddrs: [],
     localMultiaddrs: [],
+    discv5FirstQueryDelayMs: 0,
     discv5: null,
   };
   const state = generateState();