feat: setup attest for type benchmarking (#142)

This PR is setting `@ark/attest` up for us to improve our typechecking performance.

Author: luxass

.github/workflows/ci.yaml

@@ -39,10 +39,12 @@ jobs:
       - name: typecheck
         run: pnpm typecheck
 
+      - name: run benchmarks
+        run: pnpm bench:types -- --benchErrorOnThresholdExceeded --benchPercentThreshold 10
+
       - name: test
         run: pnpm test --coverage
 
-
       - name: upload coverage reports to codecov
         uses: codecov/codecov-action@0565863a31f2c772f9f0395002a31e3f06189574 # v5.4.0
         with:

package.json

@@ -19,6 +19,7 @@
     "test": "vitest run",
     "test:watch": "vitest",
     "test:ui": "vitest --ui",
+    "bench:types": "turbo run bench:types",
     "typecheck": "turbo run typecheck"
   },
   "devDependencies": {
@@ -29,8 +30,10 @@
     "@vitest/ui": "catalog:monorepo",
     "eslint": "catalog:dev",
     "msw": "catalog:monorepo",
+    "@ark/attest": "catalog:monorepo",
     "turbo": "catalog:monorepo",
     "typescript": "catalog:dev",
-    "vitest": "catalog:dev"
+    "vitest": "catalog:dev",
+    "tsx": "catalog:monorepo"
   }
 }

packages/adapters/.ts-benchmarks/builders/source-builder.ts-bench.ts

@@ -0,0 +1,114 @@
+import { bench } from "@ark/attest";
+import { type } from "arktype";
+import { createSourceAdapter } from "../../src/builders/source-builder/builder";
+
+bench("source adapter builder", () => {
+  createSourceAdapter({
+    type: "metadata",
+    transformerOutputSchema: type({
+      hello: "string",
+      world: "string",
+    }),
+    fallback: {
+      hello: "hello",
+      world: "world",
+    },
+    persistence: {
+      schemas: {},
+    },
+  });
+}).types([19921, "instantiations"]);
+
+bench("source adapter with transforms", () => {
+  createSourceAdapter({
+    type: "metadata",
+    transformerOutputSchema: type({
+      hello: "string",
+      world: "string",
+    }),
+    fallback: {
+      hello: "hello",
+      world: "world",
+    },
+    persistence: {
+      schemas: {},
+    },
+  }).withTransform(
+    () => true,
+    (builder) => {
+      return builder
+        .urls(() => "v14")
+        .parser("generic")
+        .transform((_, data) => data)
+        .output((_, data) => {
+          return {
+            hello: data.lines.join(","),
+            world: `${data.totalLines}`,
+          };
+        });
+    },
+  ).build();
+}).types([21691, "instantiations"]);
+
+bench("source adapter with multiple transforms", () => {
+  createSourceAdapter({
+    type: "metadata",
+    transformerOutputSchema: type({
+      hello: "string",
+      world: "string",
+    }),
+    fallback: {
+      hello: "hello",
+      world: "world",
+    },
+    persistence: {
+      schemas: {},
+    },
+  })
+    .withTransform(
+      () => true,
+      (builder) => {
+        return builder
+          .urls(() => "v14")
+          .parser("generic")
+          .transform((_, data) => data)
+          .output((_, data) => {
+            return {
+              hello: data.lines.join(","),
+              world: `${data.totalLines}`,
+            };
+          });
+      },
+    )
+    .withTransform(
+      () => true,
+      (builder) => {
+        return builder
+          .urls(() => "v14")
+          .parser("generic")
+          .transform((_, data) => data)
+          .output((_, data) => {
+            return {
+              hello: data.lines.join(","),
+              world: `${data.totalLines}`,
+            };
+          });
+      },
+    )
+    .withTransform(
+      () => true,
+      (builder) => {
+        return builder
+          .urls(() => "v14")
+          .parser("generic")
+          .transform((_, data) => data)
+          .output((_, data) => {
+            return {
+              hello: data.lines.join(","),
+              world: `${data.totalLines}`,
+            };
+          });
+      },
+    )
+    .build();
+}).types([25705, "instantiations"]);

packages/adapters/.ts-benchmarks/index.ts

@@ -0,0 +1 @@
+import "./builders/source-builder.ts-bench.ts";

packages/adapters/package.json

@@ -33,7 +33,8 @@
     "dev": "tsdown --watch",
     "clean": "git clean -xdf dist node_modules",
     "lint": "eslint .",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "bench:types": "tsx ./.ts-benchmarks/index.ts"
   },
   "dependencies": {
     "@mojis/internal-utils": "workspace:*",

packages/adapters/tsconfig.json

@@ -1,4 +1,9 @@
 {
   "extends": "../../tsconfig.base.json",
-  "include": ["src/**/*", "*.ts", "test"]
+  "include": [
+    "src/**/*",
+    "*.ts",
+    "test",
+    ".ts-benchmarks/**/*"
+  ]
 }