@malloy-publisher/server 0.0.382-dev → 0.2.0

package/tests/harness/mcp_test_setup.ts

@@ -1,344 +0,0 @@
-import { Client } from "@modelcontextprotocol/sdk/client/index.js";
-import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
-import {
-   Notification,
-   Request,
-   Result,
-} from "@modelcontextprotocol/sdk/types.js";
-import http from "http";
-import { AddressInfo } from "net";
-import path from "path";
-import { fileURLToPath } from "url";
-import { URL } from "url";
-
-// --- Real Server Import ---
-// Import the actual configured Express app instance
-
-// --- E2E Test Environment Setup ---
-
-export interface McpE2ETestEnvironment {
-   httpServer: http.Server;
-   serverUrl: string;
-   mcpClient: Client<Request, Notification, Result>;
-   originalServerRoot: string | undefined;
-   originalInitializeStorage: string | undefined;
-}
-
-// Counter for unique port assignment per test suite
-let portCounter = 0;
-
-// Mutex to prevent concurrent initialization (since all tests share the same database)
-let initializationLock: Promise<void> | null = null;
-
-/**
- * Starts the real application server and connects a real MCP client.
- */
-export async function setupE2ETestEnvironment(): Promise<McpE2ETestEnvironment> {
-   // Wait for any ongoing initialization to complete (prevents concurrent DB initialization)
-   if (initializationLock) {
-      console.log(
-         "[E2E Test Setup] Waiting for previous initialization to complete...",
-      );
-      await initializationLock;
-   }
-
-   // Create a new lock for this initialization
-   let resolveLock: () => void;
-   initializationLock = new Promise((resolve) => {
-      resolveLock = resolve;
-   });
-
-   try {
-      return await setupE2ETestEnvironmentInternal();
-   } finally {
-      // Release the lock
-      resolveLock!();
-      initializationLock = null;
-   }
-}
-
-async function setupE2ETestEnvironmentInternal(): Promise<McpE2ETestEnvironment> {
-   // --- Store and Set SERVER_ROOT Env Var ---
-   // The ProjectStore relies on SERVER_ROOT to find publisher.config.json.
-   const originalServerRoot = process.env.SERVER_ROOT; // Store original value
-   // Resolve the path to 'packages/server' based on the location of this file
-   // Use import.meta.url for cross-platform compatibility (works on Windows)
-   const __filename = fileURLToPath(import.meta.url);
-   const __dirname = path.dirname(__filename);
-   const serverPackageDir = path.resolve(__dirname, "../../"); // Go up two levels from .../packages/server/tests/harness
-   process.env.SERVER_ROOT = serverPackageDir;
-   console.log(
-      `[E2E Test Setup] Temporarily set SERVER_ROOT=${process.env.SERVER_ROOT}`,
-   );
-
-   // --- Set INITIALIZE_STORAGE to ensure packages are downloaded ---
-   // This ensures packages from GitHub are cloned/downloaded during initialization
-   const originalInitializeStorage = process.env.INITIALIZE_STORAGE; // Store original value
-   process.env.INITIALIZE_STORAGE = "true";
-   console.log(
-      `[E2E Test Setup] Temporarily set INITIALIZE_STORAGE=${process.env.INITIALIZE_STORAGE}`,
-   );
-
-   // --- IMPORTANT: Import server *after* setting env var ---
-   // Dynamically import the actual app instance
-   const { mcpApp } = await import("../../src/server");
-
-   let serverInstance: http.Server;
-   let serverUrl: string;
-
-   // Use unique port per test suite to avoid conflicts when running in parallel
-   // Increment port counter and use it to create unique ports: 4042, 4043, 4044, etc.
-   const portOffset = portCounter++;
-   const TEST_MCP_PORT = Number(process.env.MCP_PORT || 4040) + 2 + portOffset;
-
-   await new Promise<void>((resolve, reject) => {
-      const server = http
-         .createServer(mcpApp)
-         .listen(TEST_MCP_PORT, "127.0.0.1", () => {
-            // Use explicit TEST_MCP_PORT
-            try {
-               const address = server.address() as AddressInfo;
-               if (!address)
-                  throw new Error("Server address is null after listen");
-               serverInstance = server;
-               serverUrl = `http://127.0.0.1:${TEST_MCP_PORT}`;
-               console.log(
-                  `[E2E Test Setup] Real server (using mcpApp) listening on ${serverUrl} (Port: ${TEST_MCP_PORT})`,
-               );
-               resolve();
-            } catch (err) {
-               reject(err);
-            }
-         });
-      server.on("error", (err: NodeJS.ErrnoException) => {
-         // Provide more specific error info if available (like EADDRINUSE)
-         console.error(
-            `[E2E Test Setup] Server failed to start on port ${TEST_MCP_PORT}: ${err.code} - ${err.message}`,
-         );
-         reject(err);
-      });
-   });
-
-   // Ensure serverInstance and serverUrl are assigned
-   const listeningServerInstance = serverInstance!;
-   const listeningServerUrl = serverUrl!;
-
-   // --- Wait a moment for server to start accepting connections ---
-   console.log("[E2E Test Setup] Waiting for server to accept connections...");
-   await new Promise((resolve) => setTimeout(resolve, 1000));
-
-   // --- Wait for server to be ready (packages downloaded) ---
-   // Poll the readiness endpoint to ensure initialization completes before tests run
-   // Note: Reduced timeout to 90s to be under the 100s test timeout
-   console.log("[E2E Test Setup] Waiting for server to be ready...");
-   const maxWaitTime = 90000; // 90 seconds max wait (under 100s test timeout)
-   const pollInterval = 1000; // Check every second
-   const startTime = Date.now();
-   let isReady = false;
-
-   while (!isReady && Date.now() - startTime < maxWaitTime) {
-      try {
-         // Use Promise.race to add timeout to fetch
-         const fetchPromise = fetch(`${listeningServerUrl}/health/readiness`);
-         const timeoutPromise = new Promise<never>((_, reject) =>
-            setTimeout(() => reject(new Error("Fetch timeout")), 5000),
-         );
-         const response = await Promise.race([fetchPromise, timeoutPromise]);
-
-         if (response.ok) {
-            const data = await response.json();
-            if (data.status === "UP") {
-               isReady = true;
-               console.log("[E2E Test Setup] Server is ready.");
-               break;
-            } else {
-               console.log(
-                  `[E2E Test Setup] Server not ready yet (status: ${data.status}), waiting... (${Math.round((Date.now() - startTime) / 1000)}s)`,
-               );
-            }
-         } else {
-            console.log(
-               `[E2E Test Setup] Readiness check returned ${response.status}, waiting... (${Math.round((Date.now() - startTime) / 1000)}s)`,
-            );
-         }
-      } catch (error) {
-         // Server might not be ready yet, continue polling
-         const errorMsg =
-            error instanceof Error ? error.message : String(error);
-         // Only log every 5 seconds to reduce noise
-         const elapsed = Math.round((Date.now() - startTime) / 1000);
-         if (elapsed % 5 === 0) {
-            console.log(
-               `[E2E Test Setup] Readiness check failed (${errorMsg}), waiting... (${elapsed}s)`,
-            );
-         }
-      }
-      await new Promise((resolve) => setTimeout(resolve, pollInterval));
-   }
-
-   if (!isReady) {
-      // Cleanup before throwing
-      if (listeningServerInstance?.listening) {
-         listeningServerInstance.closeAllConnections?.();
-         await new Promise<void>((res) =>
-            listeningServerInstance.close(() => res()),
-         );
-      }
-      throw new Error(
-         `Server did not become ready within ${maxWaitTime / 1000} seconds. Package downloads may have failed.`,
-      );
-   }
-
-   // --- Client Setup ---
-   const mcpClient = new Client<Request, Notification, Result>({
-      name: "mcp-e2e-test-client",
-      version: "1.0",
-   });
-
-   // Use StreamableHTTPClientTransport, connecting to the base URL + /mcp endpoint
-   const mcpEndpointPath = "/mcp"; // Matches the endpoint used in server.ts
-   const clientTransport = new StreamableHTTPClientTransport(
-      new URL(`${listeningServerUrl}${mcpEndpointPath}`),
-   );
-
-   // Connect client (with timeout)
-   console.log(
-      `[E2E Test Setup] Connecting MCP client to ${listeningServerUrl}${mcpEndpointPath} ...`,
-   );
-   let connectTimeout: NodeJS.Timeout | null = null;
-   try {
-      const connectPromise = mcpClient.connect(clientTransport);
-      const timeoutPromise = new Promise((_, reject) => {
-         connectTimeout = setTimeout(() => {
-            reject(
-               new Error("[E2E Test Setup] Client connection timeout (5s)"),
-            );
-         }, 5000);
-      });
-      await Promise.race([connectPromise, timeoutPromise]);
-      console.log("[E2E Test Setup] MCP client connected.");
-   } catch (error) {
-      console.error("[E2E Test Setup] MCP Client connection failed:", error);
-      // Attempt cleanup even if connection failed
-      await mcpClient
-         ?.close()
-         .catch(() =>
-            console.error("[E2E Test Setup] Error closing failed client:"),
-         );
-      if (listeningServerInstance?.listening) {
-         listeningServerInstance.closeAllConnections?.(); // Force close connections
-         await new Promise<void>((res) =>
-            listeningServerInstance.close(() => res()),
-         );
-      }
-      throw error;
-   } finally {
-      if (connectTimeout) clearTimeout(connectTimeout);
-   }
-
-   // --- Return Environment ---
-   return {
-      httpServer: listeningServerInstance,
-      serverUrl: listeningServerUrl,
-      mcpClient,
-      originalServerRoot,
-      originalInitializeStorage,
-   };
-}
-
-/**
- * Cleans up the E2E test environment by closing the client and server.
- */
-export async function cleanupE2ETestEnvironment(
-   env: McpE2ETestEnvironment | null,
-): Promise<void> {
-   if (!env) {
-      // Attempt cleanup even if env is null (e.g., setup failed after config creation)
-      return;
-   }
-
-   // --- Restore Original SERVER_ROOT and INITIALIZE_STORAGE ---
-   // Restore the original SERVER_ROOT value after tests are complete.
-   const { originalServerRoot, originalInitializeStorage } = env;
-   if (originalServerRoot === undefined) {
-      delete process.env.SERVER_ROOT;
-      console.log("[E2E Test Cleanup] Restored SERVER_ROOT (deleted)");
-   } else {
-      process.env.SERVER_ROOT = originalServerRoot;
-      console.log(
-         `[E2E Test Cleanup] Restored SERVER_ROOT=${process.env.SERVER_ROOT}`,
-      );
-   }
-
-   // Restore the original INITIALIZE_STORAGE value after tests are complete.
-   if (originalInitializeStorage === undefined) {
-      delete process.env.INITIALIZE_STORAGE;
-      console.log("[E2E Test Cleanup] Restored INITIALIZE_STORAGE (deleted)");
-   } else {
-      process.env.INITIALIZE_STORAGE = originalInitializeStorage;
-      console.log(
-         `[E2E Test Cleanup] Restored INITIALIZE_STORAGE=${process.env.INITIALIZE_STORAGE}`,
-      );
-   }
-
-   const { mcpClient, httpServer } = env;
-
-   // 1. Close client first (with timeout)
-   if (mcpClient) {
-      try {
-         const closePromise = mcpClient.close();
-         const timeoutPromise = new Promise<void>((_, reject) => {
-            setTimeout(() => reject(new Error("Client close timeout")), 5000);
-         });
-         await Promise.race([closePromise, timeoutPromise]);
-      } catch (error) {
-         // Ignore client close errors during cleanup potentially
-         console.warn(
-            "[E2E Test Cleanup] Error closing MCP client (ignoring):",
-            error instanceof Error ? error.message : String(error),
-         );
-      }
-   }
-
-   // 2. Close HTTP server connections and then the server itself (with timeout)
-   if (httpServer) {
-      // Force close any remaining connections immediately
-      httpServer.closeAllConnections?.();
-
-      if (httpServer.listening) {
-         try {
-            const closePromise = new Promise<void>((resolve, reject) => {
-               const timeout = setTimeout(() => {
-                  reject(new Error("Server close timeout"));
-               }, 5000);
-               httpServer.close((err: NodeJS.ErrnoException | undefined) => {
-                  clearTimeout(timeout);
-                  if (err && err.code !== "ERR_SERVER_NOT_RUNNING") {
-                     console.error(
-                        "[E2E Test Cleanup] Error closing HTTP server (after closing connections):",
-                        err,
-                     );
-                  } else if (!err) {
-                     console.log("[E2E Test Cleanup] HTTP server closed.");
-                  }
-                  resolve();
-               });
-            });
-            await closePromise;
-         } catch (error) {
-            console.warn(
-               "[E2E Test Cleanup] Server close timeout or error (forcing close):",
-               error instanceof Error ? error.message : String(error),
-            );
-            // Force destroy if close times out
-            if (httpServer.listening) {
-               httpServer.closeAllConnections?.();
-            }
-         }
-      } else {
-         console.log(
-            "[E2E Test Cleanup] HTTP server was not listening or already closed.",
-         );
-      }
-   }
-}

package/tests/harness/mocks.ts

@@ -1,37 +0,0 @@
-import sinon from "sinon";
-import { ProjectStore } from "../../src/service/project_store";
-
-/** Return a stubbed ProjectStore where every lookup throws or returns minimal objects. */
-export function fakeProjectStore(): sinon.SinonStubbedInstance<ProjectStore> {
-   const ps = sinon.createStubInstance(ProjectStore);
-   // For now just have getProject reject; suites can stub more.
-   ps.getProject.rejects(new Error("fakeProjectStore: getProject not stubbed"));
-   return ps;
-}
-
-// The runtime implementation of `McpServer` lives in the MCP SDK package, which
-// is **not** required for unit/integration tests that only need a stubbed
-// instance. Importing it at runtime would fail when the dependency is not
-// present in the local workspace. Instead we define a minimal dummy class that
-// satisfies Sinon while keeping the public type surface the same for tests.
-//
-// NOTE: If we later add the real SDK as a dependency we can simply replace this
-// dummy class with:
-//   import { McpServer } from "@modelcontextprotocol/sdk";
-class DummyMcpServer {}
-
-// Re-export the symbol so downstream test files can continue to refer to the
-// name `McpServer` without changes.
-export type McpServer = DummyMcpServer;
-
-/** Convenience helper mimicking the old mocks used in integration specs. */
-export function createMalloyServiceMocks() {
-   return {
-      projectStore: fakeProjectStore(),
-   } as const;
-}
-
-/** Create a Sinon spy wrapper around a new DummyMcpServer instance. */
-export function spyMcpServer(): sinon.SinonStubbedInstance<DummyMcpServer> {
-   return sinon.createStubInstance(DummyMcpServer);
-}

package/tests/harness/rest_e2e.ts

@@ -1,68 +0,0 @@
-import http from "http";
-
-export interface RestE2EEnv {
-   httpServer: http.Server;
-   baseUrl: string;
-}
-
-/**
- * Spin up an HTTP server wrapping the real Express REST app.
- *
- * Works regardless of which test file first imported server.ts —
- * reuses the cached Express app and binds on an OS-assigned port
- * to avoid collisions.
- *
- * Callers are responsible for creating any test-specific projects
- * via the REST API (POST /api/v0/projects) and cleaning them up.
- */
-export async function startRestE2E(): Promise<
-   RestE2EEnv & { stop(): Promise<void> }
-> {
-   const { app } = await import("../../src/server");
-
-   const httpServer: http.Server = await new Promise<http.Server>(
-      (resolve, reject) => {
-         const srv = http
-            .createServer(app)
-            .listen(0, "127.0.0.1", () => resolve(srv));
-         srv.on("error", (err: NodeJS.ErrnoException) => {
-            console.error("[REST E2E] server listen error", err);
-            reject(err);
-         });
-      },
-   );
-
-   const addr = httpServer.address() as { port: number };
-   const baseUrl = `http://127.0.0.1:${addr.port}`;
-
-   const maxWait = 180_000;
-   const start = Date.now();
-   let ready = false;
-   while (!ready && Date.now() - start < maxWait) {
-      try {
-         const res = await fetch(`${baseUrl}/health/readiness`);
-         if (res.ok) {
-            const data = (await res.json()) as { status: string };
-            if (data.status === "UP") {
-               ready = true;
-               break;
-            }
-         }
-      } catch {
-         // server not ready yet
-      }
-      await new Promise((r) => setTimeout(r, 500));
-   }
-   if (!ready) {
-      httpServer.closeAllConnections?.();
-      await new Promise<void>((r) => httpServer.close(() => r()));
-      throw new Error("REST E2E server did not become ready in time");
-   }
-
-   const stop = async (): Promise<void> => {
-      httpServer.closeAllConnections?.();
-      await new Promise<void>((r) => httpServer.close(() => r()));
-   };
-
-   return { httpServer, baseUrl, stop };
-}

package/tests/harness/uris.ts

@@ -1,31 +0,0 @@
-export interface FixtureUris {
-   project: string;
-   package: string;
-   flightsModel: string;
-   source: string;
-   view: string;
-   query: string;
-   notebook: string;
-}
-
-/**
- * Return canonical URIs used across integration tests, parametrised by project
- * and package. Most suites will call this with defaults.
- */
-export function malloyUris(
-   project = "malloy-samples",
-   pkg = "faa",
-): FixtureUris {
-   const base = `malloy://project/${project}`;
-   const pkgUri = `${base}/package/${pkg}`;
-   const model = `${pkgUri}/models/flights.malloy`;
-   return {
-      project: base,
-      package: pkgUri,
-      flightsModel: model,
-      source: `${model}/sources/flights`,
-      view: `${model}/sources/flights/views/flights_by_month`,
-      query: `${model}/queries/flights_by_carrier`,
-      notebook: `${pkgUri}/notebooks/overview.malloynb`,
-   };
-}