Adding type benchmarking - finds time and number of instantiations fo…

…r the type

.gitignore

@@ -300,6 +300,8 @@ sandworm
 
 /tests/**/private.*
 
+benchmarks.json
+
 # typescript-coverage-report
 /coverage-ts
 

apps/ove-core-ui/src/pages/dashboard/page.tsx

@@ -0,0 +1,3 @@
+const Dashboard = () => <></>;
+
+export default Dashboard;

babel.config.json

@@ -1,3 +1,8 @@
 {
-  "babelrcRoots": ["*"]
+  "babelrcRoots": ["*"],
+  "env": {
+    "test": {
+      "plugins": ["@babel/plugin-transform-modules-commonjs"]
+    }
+  }
 }

jest.config.js

@@ -1,5 +1,5 @@
 const { getJestProjects } = require('@nrwl/jest');
 
 module.exports = {
-  projects: getJestProjects(),
+  projects: getJestProjects()
 };

jest.config.ts

@@ -1,5 +1,5 @@
 import { getJestProjects } from '@nrwl/jest';
 
 export default {
-  projects: getJestProjects(),
+  projects: getJestProjects()
 };

jest.integration.config.ts

@@ -9,6 +9,12 @@ export default {
       {
         useESM: true
       }
+    ],
+    "node_modules/@arktype": [
+      "babel-jest"
     ]
-  }
+  },
+  transformIgnorePatterns: [
+    "node_modules/(?!@arktype)"
+  ]
 };

jest.preset.js

@@ -1,5 +1,5 @@
 const nxPreset = require('@nrwl/jest/preset').default;
 
 module.exports = {
-  ...nxPreset,
+  ...nxPreset
 };

libs/ove-types/jest.config.ts

@@ -10,7 +10,13 @@ export default {
         tsconfig: '<rootDir>/tsconfig.spec.json',
       },
     ],
+    "@arktype": [
+      "babel-jest"
+    ]
   },
+  transformIgnorePatterns: [
+    "<rootDir>/node_modules/(?!@arktype)"
+  ],
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
   coverageDirectory: '../../coverage/libs/ove-types',
 };

libs/ove-types/src/lib/hardware/service.spec.ts

@@ -0,0 +1,66 @@
+import { bench } from "@arktype/attest";
+import { writeFileSync, readFileSync, statSync } from "fs";
+import { type RouteMethod, type TServiceRoutesSchema } from "./service";
+
+const formatOutput = () => {
+  const results = (console.log as ReturnType<typeof jest.fn>).mock.calls.map(x => x[0] as string).filter(o => o.includes("Result: ")).map(o => o.match(/Result: ([\d|.]+)/)![1]);
+  return {
+    time: parseFloat(results[0]),
+    instantiations: parseInt(results[1])
+  };
+};
+
+const init = () => {
+  console.log = jest.fn();
+  console.group = jest.fn();
+  console.error = jest.fn();
+};
+
+describe("service types", () => {
+  let benchmarks: Record<string, { time: number, instantiations: number }> = {};
+
+  it("RouteMethod", async () => {
+    init();
+    bench("RouteMethod", () => "" as RouteMethod).mean([0, "ns"]).types([0, "instantiations"]);
+    const {
+      time,
+      instantiations
+    } = formatOutput();
+
+    benchmarks["RouteMethod"] = { time, instantiations };
+
+    expect(time).toBeLessThan(50);
+    expect(instantiations).toBe(0);
+  });
+
+  it("getStatus", async () => {
+    init();
+    bench("getStatus", () => ({}) as TServiceRoutesSchema["getStatus"]).mean([0, "ns"]).types([0, "instantiations"]);
+    const {
+      time,
+      instantiations
+    } = formatOutput();
+
+    benchmarks["getStatus"] = { time, instantiations };
+
+    expect(time).toBeLessThan(50);
+    expect(instantiations).toBeLessThan(33000);
+  });
+
+  afterAll(() => {
+    let existing: Record<string, any>
+    try {
+      statSync("./benchmarks.json");
+      existing = JSON.parse(readFileSync("./benchmarks.json").toString());
+    } catch (e) {
+      console.error(e);
+      existing = {};
+    }
+
+    if (!("ove-types" in existing)) {
+      existing["ove-types"] = {};
+    }
+    existing["ove-types"]["service"] = benchmarks;
+    writeFileSync("./benchmarks.json", JSON.stringify(existing, undefined, 2));
+  });
+});

libs/ove-types/tsconfig.spec.json

@@ -1,9 +1,11 @@
 {
+  "exclude": ["../../node_modules"],
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
+    "noEmit": true,
     "module": "commonjs",
-    "types": ["jest", "node"]
+    "types": ["jest", "node"],
+    "allowJs": true
   },
   "include": [
     "jest.config.ts",

package.json

@@ -28,6 +28,7 @@
   "devDependencies": {
     "@arktype/attest": "^0.5.0",
     "@babel/preset-react": "^7.14.5",
+    "@babel/plugin-transform-modules-commonjs": "^7.23.3",
     "@lhci/cli": "^0.13.0",
     "@lhci/server": "^0.13.0",
     "@mands/nx-playwright": "^0.1.19",