Added unit test for result generation recovery

Author: rpanic

packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts

@@ -231,7 +231,7 @@ export class BlockProducerModule extends SequencerModule<BlockConfig> {
     return block;
   }
 
-  public async start() {
+  public async blockResultCompleteCheck() {
     // Check if metadata height is behind block production.
     // This can happen when the sequencer crashes after a block has been produced
     // but before the metadata generation has finished
@@ -245,4 +245,8 @@ export class BlockProducerModule extends SequencerModule<BlockConfig> {
     }
     // If we reach here, its a genesis startup, no blocks exist yet
   }
+
+  public async start() {
+    await this.blockResultCompleteCheck();
+  }
 }

packages/sequencer/test/protocol/production/sequencing/atomic-block-production.test.ts

@@ -0,0 +1,129 @@
+import "reflect-metadata";
+import { Runtime } from "@proto-kit/module";
+import { Protocol } from "@proto-kit/protocol";
+import { VanillaProtocolModules } from "@proto-kit/library";
+import { AppChain } from "@proto-kit/sdk";
+import { container } from "tsyringe";
+import { jest } from "@jest/globals";
+import { expectDefined } from "@proto-kit/common";
+
+import {
+  BlockQueue,
+  ManualBlockTrigger,
+  TransactionExecutionService,
+} from "../../../../src";
+import { ProtocolStateTestHook } from "../../../integration/mocks/ProtocolStateTestHook";
+import {
+  DefaultTestingSequencerModules,
+  testingSequencerFromModules,
+} from "../../../TestingSequencer";
+import { Balance } from "../../../integration/mocks/Balance";
+
+describe("atomic block production", () => {
+  let appchain: AppChain<any, any, DefaultTestingSequencerModules, any>;
+
+  let trigger: ManualBlockTrigger;
+
+  beforeEach(async () => {
+    const runtimeClass = Runtime.from({
+      modules: {
+        Balance,
+      },
+
+      config: {
+        Balance: {},
+      },
+    });
+
+    const sequencerClass = testingSequencerFromModules({});
+
+    const protocolClass = Protocol.from({
+      modules: VanillaProtocolModules.mandatoryModules({
+        ProtocolStateTestHook,
+      }),
+    });
+
+    const app = AppChain.from({
+      Runtime: runtimeClass,
+      Sequencer: sequencerClass,
+      Protocol: protocolClass,
+      modules: {},
+    });
+
+    app.configure({
+      Sequencer: {
+        Database: {},
+        BlockTrigger: {},
+        Mempool: {},
+        BatchProducerModule: {},
+        BlockProducerModule: {},
+        LocalTaskWorkerModule: {},
+        BaseLayer: {},
+        TaskQueue: {},
+        FeeStrategy: {},
+        ProtocolStartupModule: {},
+      },
+      Runtime: {
+        Balance: {},
+      },
+      Protocol: {
+        AccountState: {},
+        BlockProver: {},
+        StateTransitionProver: {},
+        BlockHeight: {},
+        LastStateRoot: {},
+        ProtocolStateTestHook: {},
+      },
+    });
+
+    appchain = app;
+
+    // Start AppChain
+    await app.start(container.createChildContainer());
+
+    trigger = app.sequencer.resolve("BlockTrigger");
+  });
+
+  /**
+   * This test does two passes on block generation.
+   * In the first, the metadata generation function is mocked to throw an error
+   * This leads to the block being produced, but the result generation to fail.
+   * Then, the mock is released. After that, the blockResultCompleteCheck()
+   * should correctly detect the missing results and re-generate it, so that
+   * the second block production can succeed
+   */
+  it("should recover from non-generated metadata", async () => {
+    expect.assertions(6);
+
+    const module = appchain.sequencer.dependencyContainer.resolve(
+      TransactionExecutionService
+    );
+
+    module.generateMetadataForNextBlock = jest
+      .fn(module.generateMetadataForNextBlock)
+      .mockImplementationOnce(() => {
+        throw new Error("Test error");
+      });
+
+    await expect(() => trigger.produceBlock()).rejects.toThrow();
+
+    // This checks that it correctly throws when producing a block with no previous result existing
+    await expect(() => trigger.produceBlock()).rejects.toThrow();
+
+    await appchain.sequencer
+      .resolve("BlockProducerModule")
+      .blockResultCompleteCheck();
+
+    const blockQueue =
+      appchain.sequencer.dependencyContainer.resolve<BlockQueue>("BlockQueue");
+    const queueData = await blockQueue.getLatestBlockAndResult();
+
+    expectDefined(queueData);
+    expectDefined(queueData.result);
+
+    const block = await trigger.produceBlock();
+
+    expectDefined(block);
+    expect(block.height.toString()).toBe("1");
+  });
+});