Merge pull request #226 from atomic-ehr/perf/test-suite-package-cache

API/Build: speed up test run

Author: ryukzak

Makefile

@@ -1,5 +1,15 @@
 AIDBOX_LICENSE_ID ?=
 
+# Unit test files run in separate bun processes. Keep this at 1 unless the
+# package cache is already warm: on a cold cache several processes install the
+# same FHIR package set into the same directory at once and corrupt it. The
+# speedup is within noise anyway — the heavy tests are IO-bound and throttle
+# each other, so concurrent jobs do not shorten the critical path.
+TEST_JOBS ?= 1
+# bun ignores the `timeout` key in bunfig.toml, so pass it on the command line:
+# generation-heavy tests exceed the 5s default once jobs compete for CPU.
+TEST_TIMEOUT ?= 30000
+
 TYPECHECK = bunx tsc --noEmit
 
 VERSION = $(shell cat package.json | grep version | sed -E 's/ *"version": "//' | sed -E 's/",.*//')
@@ -34,7 +44,7 @@ typecheck:
 
 test: typecheck
 	@find test -name "*.test.ts" -not -path "*/multi-package/*" | sort | \
-		xargs -P 1 -I{} sh -c 'echo "==> {}" && bun test {} || exit 255'
+		xargs -P $(TEST_JOBS) -I{} sh -c 'out=$$(bun test --timeout $(TEST_TIMEOUT) "$$1" 2>&1); st=$$?; printf "==> %s\n%s\n" "$$1" "$$out"; [ $$st -eq 0 ] || exit 255' _ {}
 
 test-multi-package: typecheck
 	bun test test/api/write-generator/multi-package/cda.test.ts

src/api/builder.ts

@@ -48,8 +48,13 @@ export type CanonicalManagerOptions = {
     /** How a package's shipped `.index.json` is treated: trust it (`"use"`, default), heal a
      *  broken one with a directory scan (`"recover"`), or rebuild it unconditionally (`"regenerate"`). */
     packageIndex?: PackageIndexMode;
-    /** Drop the CanonicalManager cache before loading packages. */
+    /** Drop the CanonicalManager cache before loading packages. Note that this wipes the whole
+     *  working directory, every cached package set included — pair it with a dedicated
+     *  `workingDir` so unrelated callers keep their downloads. */
     dropCache?: boolean;
+    /** Directory holding the downloaded packages and their processed cache
+     *  (default: `.codegen-cache/canonical-manager-cache`). */
+    workingDir?: string;
     /** Per-phase patch handlers (package-defect fixes; helpers on the `@atomic-ehr/fhir-canonical-manager/patch` subpath). */
     patches?: Partial<Patches>;
 };
@@ -306,7 +311,7 @@ export class APIBuilder {
             injectedManager ??
             CanonicalManager({
                 packages: [],
-                workingDir: ".codegen-cache/canonical-manager-cache",
+                workingDir: cm.workingDir ?? ".codegen-cache/canonical-manager-cache",
                 registry: cm.registry,
                 dropCache: cm.dropCache,
                 patches: {
@@ -556,7 +561,10 @@ export class APIBuilder {
 
         this.logger.debug(`Starting generation with ${this.generators.length} generators`);
         try {
-            if (this.options.cleanOutput) await cleanup(this.options, this.logger);
+            // An all-in-memory run writes nothing, so wiping the output directory would only
+            // destroy a previous run's files (and, for concurrent runs, each other's).
+            const writesToDisk = this.generators.some((gen) => !gen.writer.opts.inMemoryOnly);
+            if (this.options.cleanOutput && writesToDisk) await cleanup(this.options, this.logger);
 
             let register: Register;
             if (this.prebuiltRegister) {

src/api/writer-generator/mustache.ts

@@ -165,15 +165,22 @@ export class MustacheGenerator extends FileSystemWriter<MustacheGeneratorOptions
             .forEach(this._renderResource.bind(this));
 
         this._renderUtility(modelFactory.createUtility());
-        this.copyStaticFiles();
 
         if (this.opts.shouldRunHooks) {
             await this._runHooks(this.opts.hooks.afterGenerate);
         }
         return;
     }
 
+    /** Static files bypass the write buffer, so they are copied once generation is done and
+     *  `opts.inMemoryOnly` reflects the caller again rather than `generateAsync`'s buffering. */
+    override async generateAsync(tsIndex: TypeSchemaIndex): Promise<void> {
+        await super.generateAsync(tsIndex);
+        this.copyStaticFiles();
+    }
+
     copyStaticFiles() {
+        if (this.opts.inMemoryOnly) return;
         const staticDir = Path.resolve(this.opts.sources.staticSource);
         if (!staticDir) {
             throw new Error("staticDir must be set in subclass.");

src/api/writer-generator/writer.ts

@@ -121,7 +121,7 @@ export abstract class FileSystemWriter<T extends FileSystemWriterOptions = FileS
             absPath: Path.resolve(destination),
             tokens: [content],
         };
-        fs.cpSync(source, destination);
+        if (!this.opts.inMemoryOnly) fs.cpSync(source, destination);
     }
 
     cp(source: string, destination: string) {
@@ -134,7 +134,7 @@ export abstract class FileSystemWriter<T extends FileSystemWriterOptions = FileS
             absPath: Path.resolve(destination),
             tokens: [content],
         };
-        fs.cpSync(source, destination);
+        if (!this.opts.inMemoryOnly) fs.cpSync(source, destination);
     }
 
     abstract generate(_tsIndex: TypeSchemaIndex): Promise<void>;
@@ -148,6 +148,7 @@ export abstract class FileSystemWriter<T extends FileSystemWriterOptions = FileS
     }
 
     async flushAsync(): Promise<void> {
+        if (this.opts.inMemoryOnly) return;
         const files = this.writtenFiles();
         const dirs = new Set<string>();
 

test/api/mustache.test.ts

@@ -3,7 +3,7 @@ import { APIBuilder } from "@root/api/builder";
 import { mkErrorLogger, r4Manager } from "@typeschema-test/utils";
 
 describe("Mustache Template Based Generation", async () => {
-    const report = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+    const report = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
         .mustache("./examples/mustache/java", {
             debug: "COMPACT",
             inMemoryOnly: true,

test/api/write-generator/csharp.test.ts

@@ -3,7 +3,7 @@ import { APIBuilder } from "@root/api/builder";
 import { mkErrorLogger, r4Manager } from "@typeschema-test/utils";
 
 describe("C# Writer Generator", async () => {
-    const result = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+    const result = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
         .csharp({
             inMemoryOnly: true,
         })

test/api/write-generator/introspection.test.ts

@@ -3,7 +3,7 @@ import { APIBuilder } from "@root/api/builder";
 import { mkErrorLogger, r4Manager } from "@typeschema-test/utils";
 
 describe("IntrospectionWriter - Fhir Schema Output", async () => {
-    const result = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+    const result = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
         .introspection({ fhirSchemas: "introspection" })
         .introspection({ fhirSchemas: "introspection.ndjson" })
         .generate();
@@ -30,7 +30,7 @@ describe("IntrospectionWriter - Fhir Schema Output", async () => {
 });
 
 describe("IntrospectionWriter - TypeSchema output", async () => {
-    const result = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+    const result = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
         .typeSchema({
             treeShake: {
                 "hl7.fhir.r4.core": {
@@ -91,7 +91,7 @@ describe("IntrospectionWriter - TypeSchema output", async () => {
 });
 
 describe("IntrospectionWriter - flat profile output", async () => {
-    const result = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+    const result = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
         .typeSchema({
             treeShake: {
                 "hl7.fhir.r4.core": {
@@ -135,7 +135,7 @@ describe("IntrospectionWriter - flat profile output", async () => {
 });
 
 describe("IntrospectionWriter - typeTree", async () => {
-    const result = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+    const result = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
         .typeSchema({
             treeShake: {
                 "hl7.fhir.r4.core": {
@@ -164,7 +164,7 @@ describe("IntrospectionWriter - typeTree", async () => {
 });
 
 describe("IntrospectionWriter - StructureDefinition output", async () => {
-    const result = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+    const result = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
         .typeSchema({
             treeShake: {
                 "hl7.fhir.r4.core": {

test/api/write-generator/python.test.ts

@@ -3,7 +3,7 @@ import { APIBuilder } from "@root/api/builder";
 import { mkErrorLogger, r4Manager } from "@typeschema-test/utils";
 
 describe("Python Writer Generator", async () => {
-    const result = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+    const result = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
         .python({
             inMemoryOnly: true,
             client: "none",
@@ -112,7 +112,7 @@ describe("Python Writer Generator", async () => {
 
 describe("Python R4 Example (with generateProfile)", async () => {
     const logger = mkErrorLogger();
-    const result = await new APIBuilder({ register: r4Manager, logger })
+    const result = await new APIBuilder({ register: await r4Manager(), logger })
         .python({
             inMemoryOnly: true,
             generateProfile: true,
@@ -191,7 +191,7 @@ describe("Python US Core Example", async () => {
 
 describe("Python client option", async () => {
     const gen = async (opts: { client?: "fhirpy" | "none"; fhirpyClient?: boolean }) => {
-        const result = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+        const result = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
             .python({ inMemoryOnly: true, ...opts })
             .generate();
         return result.filesGenerated.python!;

test/api/write-generator/typescript.test.ts

@@ -20,7 +20,7 @@ const appendValueSet = (register: Register, pkg: PackageMeta, valueSet: PVS) =>
 };
 
 describe("TypeScript Writer Generator", async () => {
-    const result = await new APIBuilder({ register: r4Manager, logger: mkErrorLogger() })
+    const result = await new APIBuilder({ register: await r4Manager(), logger: mkErrorLogger() })
         .typescript({
             inMemoryOnly: true,
         })
@@ -181,7 +181,7 @@ describe("TypeScript profile fixed CodeableConcept semantics", async () => {
 });
 
 describe("TypeScript CDA with Logical Model Promotion to Resource", async () => {
-    const result = await new APIBuilder({ register: ccdaManager, logger: mkErrorLogger() })
+    const result = await new APIBuilder({ register: await ccdaManager(), logger: mkErrorLogger() })
         .typeSchema({
             promoteLogical: {
                 "hl7.cda.uv.core": ["http://hl7.org/cda/stds/core/StructureDefinition/Material" as CanonicalUrl],
@@ -209,7 +209,7 @@ describe("TypeScript CDA with Logical Model Promotion to Resource", async () =>
 
 describe("TypeScript R4 Example (with generateProfile)", async () => {
     const logger = mkErrorLogger();
-    const result = await new APIBuilder({ register: r4Manager, logger })
+    const result = await new APIBuilder({ register: await r4Manager(), logger })
         .typescript({
             inMemoryOnly: true,
             withDebugComment: false,

test/unit/api/builtin-patches.test.ts

@@ -5,9 +5,15 @@ import { mkErrorLogger } from "@typeschema-test/utils";
 // Real-closure test (downloads hl7.fhir.r5.core once, then served from the CM tarball cache):
 // the shipped builtin patches drop R5's known-broken CodeSystem profiles at the package index,
 // and builtinPatches: false is the explicit opt-out. Index patches apply at scan time, so each
-// run drops the processed cache to make the configuration observable.
+// run drops the processed cache to make the configuration observable. That drop wipes the
+// whole working directory, so this test keeps its own — otherwise it would evict every other
+// test's and example's downloaded packages on each run.
 const generate = async (opts: object) => {
-    const result = await new APIBuilder({ ...opts, logger: mkErrorLogger(), canonicalManager: { dropCache: true } })
+    const result = await new APIBuilder({
+        ...opts,
+        logger: mkErrorLogger(),
+        canonicalManager: { dropCache: true, workingDir: ".codegen-cache/builtin-patches-cache" },
+    })
         .fromPackage("hl7.fhir.r5.core", "5.0.0")
         .introspection({ typeSchemas: "type-schemas", inMemoryOnly: true })
         .generate();