@malloy-publisher/server 0.0.235 → 0.0.236

package/src/service/environment_admission.spec.ts

@@ -1,344 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it } from "bun:test";
-import * as fs from "fs";
-import * as os from "os";
-import * as path from "path";
-
-import { ServiceUnavailableError } from "../errors";
-import {
-   startMetricsHarness,
-   type MetricsHarness,
-} from "../test_helpers/metrics_harness";
-import { buildEnvironmentMalloyConfig } from "./connection";
-import { Environment, resetAdmissionTelemetryForTesting } from "./environment";
-import type { PackageMemoryGovernor } from "./package_memory_governor";
-
-/**
- * Minimal subset of {@link PackageMemoryGovernor} that
- * `Environment.assertCanAdmitNewPackage` actually consults. Allows us
- * to drive the gate from the tests without spinning the real OTel
- * instrumentation pipeline.
- */
-class StubGovernor {
-   public backpressured = false;
-   isBackpressured(): boolean {
-      return this.backpressured;
-   }
-}
-
-function makeEnvironment(envPath: string): Environment {
-   const malloyConfig = buildEnvironmentMalloyConfig([], envPath);
-   return new Environment("test-env", envPath, malloyConfig, []);
-}
-
-describe("Environment admission gate (memory governor choke point)", () => {
-   let envDir: string;
-
-   beforeEach(() => {
-      envDir = fs.mkdtempSync(
-         path.join(os.tmpdir(), "publisher-env-admission-"),
-      );
-   });
-
-   afterEach(() => {
-      fs.rmSync(envDir, { recursive: true, force: true });
-   });
-
-   it("admits new packages when no governor is attached (legacy behaviour)", async () => {
-      const env = makeEnvironment(envDir);
-      // No governor set; the gate must be a pure no-op. The package
-      // doesn't exist on disk, so addPackage rejects with
-      // PackageNotFoundError — that we get any error other than 503
-      // is the assertion.
-      let caught: unknown;
-      try {
-         await env.addPackage("does-not-exist");
-      } catch (err) {
-         caught = err;
-      }
-      expect(caught).toBeDefined();
-      expect(caught).not.toBeInstanceOf(ServiceUnavailableError);
-   });
-
-   it("rejects getPackage cache-miss with 503 when back-pressured", async () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      // No package by this name has ever been loaded, so this is the
-      // exact "lazy-load on cache miss" path Monty flagged. The gate
-      // must throw before Package.create touches the disk.
-      await expect(env.getPackage("ghost", false)).rejects.toBeInstanceOf(
-         ServiceUnavailableError,
-      );
-   });
-
-   it("rejects getPackage reload=true with 503 when back-pressured", async () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      await expect(env.getPackage("ghost", true)).rejects.toBeInstanceOf(
-         ServiceUnavailableError,
-      );
-   });
-
-   it("rejects addPackage with 503 when back-pressured (after the 404 check passes)", async () => {
-      // Create a real (empty) package directory so the existence
-      // check passes and the gate gets to run. Without this, the
-      // PackageNotFoundError would mask the 503 we want to assert.
-      const pkgName = "real-pkg";
-      fs.mkdirSync(path.join(envDir, pkgName));
-
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      await expect(env.addPackage(pkgName)).rejects.toBeInstanceOf(
-         ServiceUnavailableError,
-      );
-   });
-
-   it("returns 404 (not 503) when the package directory does not exist, even under pressure", async () => {
-      // 404 must take precedence over 503: a permanent "you forgot to
-      // upload the package" error should not be masked as a transient
-      // "retry later" — otherwise operators chase phantom memory
-      // problems while the real fix is a missing artifact.
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      let caught: unknown;
-      try {
-         await env.addPackage("never-existed");
-      } catch (err) {
-         caught = err;
-      }
-      expect(caught).toBeDefined();
-      expect(caught).not.toBeInstanceOf(ServiceUnavailableError);
-   });
-
-   it("allowAdmission=true bypasses the gate (for future warmup/probe callers)", async () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      // With the bypass, the gate must not fire — the call should
-      // proceed to the real loader and fail there with some other
-      // error (PackageNotFoundError-equivalent from Package.create on
-      // a non-existent directory). The assertion is "not 503".
-      let caught: unknown;
-      try {
-         await env.getPackage("ghost", false, { allowAdmission: true });
-      } catch (err) {
-         caught = err;
-      }
-      expect(caught).toBeDefined();
-      expect(caught).not.toBeInstanceOf(ServiceUnavailableError);
-   });
-
-   it("clearing back-pressure on the governor immediately re-admits new loads", async () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-
-      governor.backpressured = true;
-      await expect(env.getPackage("ghost", false)).rejects.toBeInstanceOf(
-         ServiceUnavailableError,
-      );
-
-      // Flip the flag (simulating the periodic poller crossing the
-      // low-water mark) and verify the next call no longer 503s.
-      governor.backpressured = false;
-      let caught: unknown;
-      try {
-         await env.getPackage("ghost", false);
-      } catch (err) {
-         caught = err;
-      }
-      expect(caught).toBeDefined();
-      expect(caught).not.toBeInstanceOf(ServiceUnavailableError);
-   });
-
-   it("detaching the governor (set null) reverts to legacy admit-everything", async () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      env.setMemoryGovernor(null);
-
-      let caught: unknown;
-      try {
-         await env.getPackage("ghost", false);
-      } catch (err) {
-         caught = err;
-      }
-      expect(caught).toBeDefined();
-      expect(caught).not.toBeInstanceOf(ServiceUnavailableError);
-   });
-});
-
-describe("Environment.assertCanAdmitQuery (query-path back-pressure)", () => {
-   let envDir: string;
-
-   beforeEach(() => {
-      envDir = fs.mkdtempSync(
-         path.join(os.tmpdir(), "publisher-env-query-admission-"),
-      );
-   });
-
-   afterEach(() => {
-      fs.rmSync(envDir, { recursive: true, force: true });
-   });
-
-   it("is a no-op when no governor is attached", () => {
-      const env = makeEnvironment(envDir);
-      // No governor — must not throw. Equivalent of an OSS / non-Docker
-      // deployment that never opted into PUBLISHER_MAX_MEMORY_BYTES.
-      expect(() => env.assertCanAdmitQuery()).not.toThrow();
-   });
-
-   it("is a no-op when the governor is happy (under high-water mark)", () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = false;
-
-      expect(() => env.assertCanAdmitQuery()).not.toThrow();
-   });
-
-   it("throws ServiceUnavailableError (→503) when back-pressured", () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      expect(() => env.assertCanAdmitQuery()).toThrow(ServiceUnavailableError);
-   });
-
-   it("error message names the environment so operators can pinpoint the hot pod's load", () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      let caught: unknown;
-      try {
-         env.assertCanAdmitQuery();
-      } catch (err) {
-         caught = err;
-      }
-      expect(caught).toBeInstanceOf(ServiceUnavailableError);
-      expect((caught as Error).message).toContain('environment "test-env"');
-      expect((caught as Error).message).toContain("memory pressure");
-   });
-
-   it("clearing back-pressure immediately re-admits queries (matches governor hysteresis)", () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-
-      governor.backpressured = true;
-      expect(() => env.assertCanAdmitQuery()).toThrow(ServiceUnavailableError);
-
-      governor.backpressured = false;
-      expect(() => env.assertCanAdmitQuery()).not.toThrow();
-   });
-
-   it("detaching the governor reverts to legacy admit-everything", () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      env.setMemoryGovernor(null);
-      // Even with the stub still claiming back-pressure, a detached
-      // governor leaves nothing to consult. Mirrors the package-admission
-      // detach behavior.
-      expect(() => env.assertCanAdmitQuery()).not.toThrow();
-   });
-});
-
-describe("Environment admission telemetry", () => {
-   let envDir: string;
-   let harness: MetricsHarness;
-
-   beforeEach(async () => {
-      envDir = fs.mkdtempSync(
-         path.join(os.tmpdir(), "publisher-env-admission-telemetry-"),
-      );
-      harness = await startMetricsHarness();
-      resetAdmissionTelemetryForTesting();
-   });
-
-   afterEach(async () => {
-      fs.rmSync(envDir, { recursive: true, force: true });
-      resetAdmissionTelemetryForTesting();
-      await harness.shutdown();
-   });
-
-   it("publisher_query_admission_rejections_total ticks per query rejection, labeled by environment", async () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      // Drive three rejections so the counter is unambiguous (a
-      // single-tick assertion can pass against a leaked counter
-      // from a different test; three is harder to fake).
-      for (let i = 0; i < 3; i++) {
-         expect(() => env.assertCanAdmitQuery()).toThrow(
-            ServiceUnavailableError,
-         );
-      }
-      expect(
-         await harness.collectCounter(
-            "publisher_query_admission_rejections_total",
-            { environment: "test-env" },
-         ),
-      ).toBe(3);
-   });
-
-   it("counter stays at zero when the governor is happy (no spurious ticks)", async () => {
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      // Not back-pressured.
-      env.assertCanAdmitQuery();
-      env.assertCanAdmitQuery();
-      // No rejection should have been recorded; verifies that the
-      // counter doesn't tick on the happy-path admission either.
-      expect(
-         await harness.collectCounter(
-            "publisher_query_admission_rejections_total",
-         ),
-      ).toBe(0);
-   });
-
-   it("publisher_package_admission_rejections_total ticks per package-load rejection", async () => {
-      // Ensure the package directory exists so the 404 doesn't
-      // short-circuit ahead of the back-pressure gate.
-      const pkgName = "real-pkg";
-      fs.mkdirSync(path.join(envDir, pkgName));
-
-      const env = makeEnvironment(envDir);
-      const governor = new StubGovernor();
-      env.setMemoryGovernor(governor as unknown as PackageMemoryGovernor);
-      governor.backpressured = true;
-
-      await expect(env.addPackage(pkgName)).rejects.toBeInstanceOf(
-         ServiceUnavailableError,
-      );
-      expect(
-         await harness.collectCounter(
-            "publisher_package_admission_rejections_total",
-            { environment: "test-env", reason: "add a new package" },
-         ),
-      ).toBe(1);
-   });
-});

package/src/service/environment_compile.spec.ts

@@ -1,197 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it } from "bun:test";
-import fs from "fs";
-import path from "path";
-import { extractPreamble, extractPreambleFromSource } from "./environment";
-
-describe("extractPreambleFromSource", () => {
-   it("should extract pragmas and imports before a source definition", () => {
-      const content = [
-         "##! experimental.parameters",
-         'import "utils.malloy"',
-         'import { revenue } from "metrics.malloy"',
-         "",
-         'source: my_source is duckdb.table("data.parquet")',
-         '  dimension: name is "test"',
-      ].join("\n");
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe(
-         [
-            "##! experimental.parameters",
-            'import "utils.malloy"',
-            'import { revenue } from "metrics.malloy"',
-         ].join("\n"),
-      );
-   });
-
-   it("should extract pragmas and imports before a run statement", () => {
-      const content = [
-         'import { my_source } from "model.malloy"',
-         "",
-         "run: my_source -> { aggregate: count() }",
-      ].join("\n");
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe('import { my_source } from "model.malloy"');
-   });
-
-   it("should extract pragmas and imports before a query definition", () => {
-      const content = [
-         'import { my_source } from "model.malloy"',
-         "",
-         "query: top_items is my_source -> { limit: 10 }",
-      ].join("\n");
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe('import { my_source } from "model.malloy"');
-   });
-
-   it("should return empty string when file starts with source:", () => {
-      const content = 'source: my_source is duckdb.table("data.parquet")';
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe("");
-   });
-
-   it("should return empty string when file starts with run:", () => {
-      const content = 'run: duckdb.sql("SELECT 1")';
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe("");
-   });
-
-   it("should return empty string when file starts with query:", () => {
-      const content = 'query: q is duckdb.sql("SELECT 1")';
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe("");
-   });
-
-   it("should preserve comments in the preamble", () => {
-      const content = [
-         "##! experimental.parameters",
-         "// This model defines revenue metrics",
-         'import { revenue } from "metrics.malloy"',
-         "// Main source below",
-         'source: my_source is duckdb.table("data.parquet")',
-      ].join("\n");
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe(
-         [
-            "##! experimental.parameters",
-            "// This model defines revenue metrics",
-            'import { revenue } from "metrics.malloy"',
-            "// Main source below",
-         ].join("\n"),
-      );
-   });
-
-   it("should handle multiple import blocks", () => {
-      const content = [
-         'import { a } from "file_a.malloy"',
-         'import { b } from "file_b.malloy"',
-         'import { c, d } from "file_c.malloy"',
-         "",
-         "source: combined is a {",
-         "  join_one: b on b.id = a.b_id",
-         "}",
-      ].join("\n");
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe(
-         [
-            'import { a } from "file_a.malloy"',
-            'import { b } from "file_b.malloy"',
-            'import { c, d } from "file_c.malloy"',
-         ].join("\n"),
-      );
-   });
-
-   it("should return all content when there are no source/query/run definitions", () => {
-      const content = [
-         "##! experimental.parameters",
-         'import { revenue } from "metrics.malloy"',
-         "",
-         "// no definitions yet",
-      ].join("\n");
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe(
-         [
-            "##! experimental.parameters",
-            'import { revenue } from "metrics.malloy"',
-            "",
-            "// no definitions yet",
-         ].join("\n"),
-      );
-   });
-
-   it("should return empty string for empty input", () => {
-      expect(extractPreambleFromSource("")).toBe("");
-   });
-
-   it("should handle indented source/query/run definitions", () => {
-      const content = [
-         'import "model.malloy"',
-         "",
-         '  source: indented is duckdb.table("data.parquet")',
-      ].join("\n");
-
-      // Indented definitions should still be detected (trimmed before check)
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe('import "model.malloy"');
-   });
-
-   it("should not stop on 'source' appearing in comments or strings", () => {
-      const content = [
-         "// This file defines the source of truth",
-         'import "model.malloy"',
-         'source: my_source is duckdb.table("data.parquet")',
-      ].join("\n");
-
-      const result = extractPreambleFromSource(content);
-      expect(result).toBe(
-         [
-            "// This file defines the source of truth",
-            'import "model.malloy"',
-         ].join("\n"),
-      );
-   });
-});
-
-describe("extractPreamble (file-based)", () => {
-   const testDir = path.join(process.cwd(), "test-temp-preamble");
-   const testModelPath = path.join(testDir, "test_model.malloy");
-
-   beforeEach(() => {
-      if (!fs.existsSync(testDir)) {
-         fs.mkdirSync(testDir, { recursive: true });
-      }
-   });
-
-   afterEach(() => {
-      if (fs.existsSync(testDir)) {
-         fs.rmSync(testDir, { recursive: true, force: true });
-      }
-   });
-
-   it("should read and extract preamble from a file", async () => {
-      const content = [
-         'import { revenue } from "metrics.malloy"',
-         "",
-         'source: my_source is duckdb.table("data.parquet")',
-      ].join("\n");
-      fs.writeFileSync(testModelPath, content);
-
-      const result = await extractPreamble(testModelPath);
-      expect(result).toBe('import { revenue } from "metrics.malloy"');
-   });
-
-   it("should return empty string when file does not exist", async () => {
-      const result = await extractPreamble(
-         path.join(testDir, "nonexistent.malloy"),
-      );
-      expect(result).toBe("");
-   });
-});