Merge pull request #18 from tablelandnetwork/joe/apikey

Enable specifying api key in config

packages/local/package.json

@@ -45,7 +45,7 @@
   "scripts": {
     "postinstall": "cd registry && npm install",
     "test": "mocha",
-    "test:ci": "npm run build && mocha --exit",
+    "test:ci": "mocha --exit",
     "lint": "eslint '**/*.{js,ts}'",
     "lint:fix": "npm run lint -- --fix",
     "prepublishOnly": "npm run build",

packages/sdk/package.json

@@ -59,7 +59,8 @@
   },
   "scripts": {
     "prepublishOnly": "npm run build",
-    "test": "npm run test:browser && mocha --exit",
+    "test": "npm run test:browser && npm run test:mocha",
+    "test:mocha": "mocha --exit",
     "test:browser": "npx playwright install --with-deps && PW_TS_ESM_ON=true playwright test",
     "test:browser-show-report": "npx playwright show-report",
     "test:ci": "npm run coverage",

packages/sdk/src/helpers/config.ts

@@ -1,11 +1,13 @@
 import fs from "node:fs";
 import { type WaitableTransactionReceipt } from "../registry/utils.js";
+import { type FetchConfig } from "../validator/client/index.js";
 import { type ChainName, getBaseUrl } from "./chains.js";
 import { type Signer, type ExternalProvider, getSigner } from "./ethers.js";
 
 export interface ReadConfig {
   baseUrl: string;
   aliases?: AliasesNameMap;
+  apiKey?: string;
 }
 
 export interface SignerConfig {
@@ -98,3 +100,16 @@ export function jsonFileAliases(filepath: string): AliasesNameMap {
     },
   };
 }
+
+export function prepReadConfig(config: Partial<ReadConfig>): FetchConfig {
+  const conf: FetchConfig = {};
+  if (config.apiKey) {
+    conf.init = {
+      headers: {
+        "Api-Key": config.apiKey,
+      },
+    };
+  }
+
+  return { ...config, ...conf };
+}

packages/sdk/src/helpers/index.ts

@@ -27,6 +27,7 @@ export {
   extractChainId,
   extractSigner,
   jsonFileAliases,
+  prepReadConfig,
 } from "./config.js";
 export {
   type Signer,

packages/sdk/src/registry/utils.ts

@@ -148,7 +148,7 @@ export async function extractReadonly(
 ): Promise<ReadConfig> {
   const [{ chainId }] = await validateTables({ tables, type });
   const baseUrl = await extractBaseUrl(conn, chainId);
-  return { baseUrl };
+  return { baseUrl, apiKey: conn.apiKey };
 }
 
 /**

packages/sdk/src/validator/client/index.ts

@@ -1,6 +1,7 @@
 import { Fetcher } from "./fetcher.js";
 import { ApiResponse, ApiError, FetchConfig } from "./types.js";
 import type { paths as Paths, components as Components } from "./validator.js";
+import { prepReadConfig } from "../../helpers/index.js";
 
 export { ApiResponse, Fetcher, ApiError, FetchConfig };
 export type { Paths, Components };
@@ -9,6 +10,6 @@ export function getFetcher(
   config: FetchConfig
 ): ReturnType<typeof Fetcher.for<Paths>> {
   const fetcher = Fetcher.for<Paths>();
-  fetcher.configure(config);
+  fetcher.configure(prepReadConfig(config));
   return fetcher;
 }

packages/sdk/src/validator/query.ts

@@ -1,4 +1,4 @@
-import { type Signal } from "../helpers/await.js";
+import { type Signal } from "../helpers/index.js";
 import { type FetchConfig, type Paths, getFetcher } from "./client/index.js";
 import { hoistApiError } from "./errors.js";
 

packages/sdk/test/database.test.ts

@@ -1,11 +1,18 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-import assert, { deepStrictEqual, strictEqual, rejects, match } from "assert";
+import assert, {
+  deepStrictEqual,
+  equal,
+  strictEqual,
+  rejects,
+  match,
+} from "assert";
 import { describe, test } from "mocha";
 import { getAccounts } from "@tableland/local";
 import { getDefaultProvider } from "ethers";
 import { Database } from "../src/database.js";
 import { Statement } from "../src/statement.js";
 import { getAbortSignal } from "../src/helpers/await.js";
+import { getDelay, getRange } from "../src/helpers/utils.js";
 import {
   TEST_TIMEOUT_FACTOR,
   TEST_PROVIDER_URL,
@@ -680,4 +687,45 @@ describe("database", function () {
       });
     });
   });
+
+  describe("rate limit", function () {
+    test("when too many read calls are sent", async function () {
+      await rejects(
+        Promise.all(
+          getRange(15).map(async () => {
+            return await db.prepare("select * from healthbot_31337_1;").all();
+          })
+        ),
+        (err: any) => {
+          strictEqual(err.message, "ALL_ERROR: Too Many Requests");
+          return true;
+        }
+      );
+
+      // need to ensure the following tests aren't affected by validator throttling
+      await getDelay(2000);
+    });
+
+    test("when valid api key is used there is no limit on read queries", async function () {
+      const apiKey = "foo";
+      const db = new Database({
+        signer,
+        autoWait: true,
+        apiKey,
+      });
+      const responses = await Promise.all(
+        getRange(15).map(async () => {
+          return await db.prepare("select * from healthbot_31337_1;").all();
+        })
+      );
+
+      // need to ensure the following tests aren't affected by validator throttling
+      await getDelay(2000);
+
+      equal(responses.length, 15);
+      for (const res of responses) {
+        deepStrictEqual(res.results, [{ counter: 1 }]);
+      }
+    });
+  });
 });

packages/sdk/test/validator.test.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import assert, {
   strictEqual,
+  equal,
   rejects,
   match,
   notStrictEqual,
@@ -450,5 +451,45 @@ describe("validator", function () {
       );
       await getDelay(5000);
     });
+
+    test("when valid api key is used there is no limit on calls to `health()`", async function () {
+      const apiKey = "foo";
+      const api = new Validator({
+        baseUrl,
+        apiKey,
+      });
+      const responses = await Promise.all(
+        getRange(15).map(async () => await api.health())
+      );
+
+      equal(responses.length, 15);
+      equal(
+        responses.every((r: unknown) => r === true),
+        true
+      );
+    });
+
+    test("when valid api key is used there is no limit on calls to `version()`", async function () {
+      const apiKey = "foo";
+      const api = new Validator({
+        baseUrl,
+        apiKey,
+      });
+      const responses = await Promise.all(
+        getRange(15).map(async () => await api.version())
+      );
+
+      equal(responses.length, 15);
+      for (const res of responses) {
+        deepStrictEqual(res, {
+          binaryVersion: "n/a",
+          buildDate: "n/a",
+          gitBranch: "n/a",
+          gitCommit: "n/a",
+          gitState: "n/a",
+          gitSummary: "n/a",
+        });
+      }
+    });
   });
 });

packages/sdk/test/validator/config.json

@@ -3,7 +3,8 @@
   "HTTP": {
     "Port": "8081",
     "RateLimInterval": "1s",
-    "MaxRequestPerInterval": 10
+    "MaxRequestPerInterval": 10,
+    "APIKey": "foo"
   },
   "Gateway": {
     "ExternalURIPrefix": "http://localhost:8081",