Fix timeout update example plugin

.gitignore

@@ -1,4 +1,4 @@
 bin
-.ergomatic.toml
+ergomatic.yaml
 cov
 .vscode

deno.jsonc

@@ -1,9 +1,10 @@
 {
   "imports": {
     "std/": "https://deno.land/std@0.196.0/",
-    "zod": "https://deno.land/x/zod@v3.21.4/mod.ts",
+    "zod/": "https://deno.land/x/zod@v3.21.4/",
     "lodash.merge": "npm:lodash.merge@4.6.2",
     "yargs": "https://deno.land/x/yargs@v17.7.2-deno/deno.ts",
+    "dirs/": "https://deno.land/x/dir@1.5.1/",
     "@fleet-sdk/common": "npm:@fleet-sdk/common@0.1.3",
     "axios": "npm:axios@1.4.0"
   },

ergomatic.example.yaml

@@ -0,0 +1,7 @@
+logLevel: DEBUG
+plugins:
+  - id: example_plugin
+    enabled: true # defaults to true, can be set to false to disable plugin.
+    config:
+      tokenId: c7e22029868ecba3d43c385bb42b8a1c96d0114ad5261ec7e0d27a6f24254f92
+      exitAtPage: 3

plugins/example_plugin/mod.ts

@@ -3,7 +3,8 @@ import { Plugin, PluginDescriptor } from "../../src/plugins/mod.ts";
 export const EXAMPLE_PLUGIN_ID = "example_plugin";
 
 interface ExamplePluginConfig {
-  someValue: number;
+  tokenId: string;
+  exitAtPage: number;
 }
 
 export class ExamplePlugin extends Plugin<ExamplePluginConfig> {
@@ -16,11 +17,30 @@ export class ExamplePlugin extends Plugin<ExamplePluginConfig> {
     };
   }
 
-  onStart(): Promise<void> {
+  async onStart(): Promise<void> {
     this.logger.info(
       `Example plugin started with config: ${JSON.stringify(this.config)}`,
     );
 
-    return Promise.resolve();
+    const { tokenId, exitAtPage } = this.config;
+    let currentPage = 0;
+
+    for await (const page of this.blockchainClient.getBoxesByTokenId(tokenId)) {
+      currentPage++;
+
+      this.logger.info(
+        `Got page ${currentPage} of boxes for token ${tokenId}`,
+      );
+
+      this.logger.info(`there was ${page.length} boxes in this page`);
+
+      if (currentPage === exitAtPage) {
+        this.logger.info(
+          `Exiting at page ${currentPage} of boxes for token ${tokenId}`,
+        );
+
+        break;
+      }
+    }
   }
 }

src/_testing.ts

@@ -0,0 +1,7 @@
+import { mergeUserConfigAndValidate } from "./config.ts";
+
+export function testConfig() {
+  return mergeUserConfigAndValidate({
+    plugins: [{ enabled: true, id: "test-plugin" }],
+  });
+}

src/_utils.ts

@@ -1,3 +1,7 @@
 export function isTesting() {
   return Deno.env.get("ERGOMATIC_TEST") === "true";
 }
+
+export function mbToBytes(mb: number) {
+  return mb * 1000000;
+}

src/blockchain/clients/explorer.ts

@@ -12,19 +12,25 @@ import { ErgomaticConfig } from "../../config.ts";
 export class ExplorerClient implements BlockchainClient {
   readonly #http: AxiosInstance;
   #pageSize = 100;
+  #timeoutMs: number;
 
-  constructor(config: ErgomaticConfig) {
+  constructor(config: ErgomaticConfig, httpTimeoutMs: number = 10000) {
+    // axios timeout is incompatible with deno due to a missing nodejs API
+    // use signals for timeouts instead.
+    this.#timeoutMs = httpTimeoutMs;
     this.#http = axios.create({
       // let URL handle any possible trailing slash,etc in the configured endpoint.
       baseURL: new URL("/api/v1", config.explorer.endpoint).href,
-      timeout: 10000, // explorer API can be slow
     });
   }
 
   async submitTx(signedTx: SignedTransaction): Promise<TransactionId> {
     const response = await this.#http.post(
       "/mempool/transactions/submit",
       signedTx,
+      {
+        signal: AbortSignal.timeout(this.#timeoutMs),
+      },
     );
 
     return response.data;
@@ -41,6 +47,7 @@ export class ExplorerClient implements BlockchainClient {
     while (true) {
       const { data } = await this.#http.get(`/boxes/byTokenId/${tokenId}`, {
         params: { offset, limit: this.#pageSize },
+        signal: AbortSignal.timeout(this.#timeoutMs),
       });
       const { total, items } = data;
 

src/config.ts

@@ -1,9 +1,9 @@
-import { z } from "zod";
+import { z } from "zod/mod.ts";
 import merge from "lodash.merge";
 
 const pluginConfigEntrySchema = z.object({
   id: z.string(),
-  enabled: z.boolean(),
+  enabled: z.boolean().default(true),
   config: z.object({}).optional(),
 });
 

src/ergomatic_test.ts

@@ -1,23 +1,19 @@
 import { beforeEach, describe, it } from "std/testing/bdd.ts";
 import { Ergomatic } from "./ergomatic.ts";
 import { PluginManager } from "./plugins/mod.ts";
-import { ErgomaticConfig, mergeUserConfigAndValidate } from "./config.ts";
+import { ErgomaticConfig } from "./config.ts";
 import { assertSpyCalls, spy, stub } from "std/testing/mock.ts";
 import { assertEquals } from "std/testing/asserts.ts";
-
-function mkConfig() {
-  return mergeUserConfigAndValidate({
-    plugins: [{ enabled: true, id: "example_plugin" }],
-  });
-}
+import { testConfig } from "./_testing.ts";
+import { mkTestPluginManager } from "./plugins/_testing.ts";
 
 describe("Ergomatic", () => {
   let config: ErgomaticConfig;
   let pluginManager: PluginManager;
 
   beforeEach(() => {
-    config = mkConfig();
-    pluginManager = new PluginManager(config);
+    config = testConfig();
+    pluginManager = mkTestPluginManager({ config }).pluginManager;
   });
 
   describe("start()", () => {