@malloy-publisher/server 0.0.198 → 0.0.199

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/build.ts +30 -1
  2. package/dist/app/api-doc.yaml +51 -0
  3. package/dist/app/assets/{EnvironmentPage-C7rtH4mC.js → EnvironmentPage-Dpee_Kn6.js} +1 -1
  4. package/dist/app/assets/{HomePage-DwkH7OrS.js → HomePage-DLRWTNoL.js} +1 -1
  5. package/dist/app/assets/{MainPage-D38LtZDV.js → MainPage-DsVt5QGM.js} +1 -1
  6. package/dist/app/assets/{ModelPage-DOol8Mz7.js → ModelPage-AwAugZ37.js} +1 -1
  7. package/dist/app/assets/{PackagePage-0tgzA_kO.js → PackagePage-XQ-EWGTC.js} +1 -1
  8. package/dist/app/assets/{RouteError-BaMsOSly.js → RouteError-3Mv8JQw7.js} +1 -1
  9. package/dist/app/assets/{WorkbookPage-Cx4SePkx.js → WorkbookPage-DHYYpcYc.js} +1 -1
  10. package/dist/app/assets/{core-CbsC6R_Y.es-Cwf6asf3.js → core-DfcpQGVP.es-DQggNOdX.js} +1 -1
  11. package/dist/app/assets/{index-DNofXMxi.js → index-BUp81Qdm.js} +1 -1
  12. package/dist/app/assets/{index-DL6BZTuw.js → index-D1pdwrUW.js} +1 -1
  13. package/dist/app/assets/{index-U38AyjJL.js → index-Dv5bF4Ii.js} +4 -4
  14. package/dist/app/assets/{index.umd-B68wGGkM.js → index.umd-CQH4LZU8.js} +1 -1
  15. package/dist/app/index.html +1 -1
  16. package/dist/instrumentation.mjs +57 -36
  17. package/dist/package_load_worker.mjs +12213 -0
  18. package/dist/server.mjs +2807 -2729
  19. package/package.json +2 -3
  20. package/src/controller/compile.controller.ts +3 -1
  21. package/src/controller/model.controller.ts +8 -1
  22. package/src/controller/query.controller.ts +3 -0
  23. package/src/health.spec.ts +90 -0
  24. package/src/health.ts +88 -45
  25. package/src/instrumentation.ts +50 -0
  26. package/src/mcp/tools/execute_query_tool.ts +12 -0
  27. package/src/package_load/package_load_pool.spec.ts +252 -0
  28. package/src/package_load/package_load_pool.ts +920 -0
  29. package/src/package_load/package_load_worker.ts +980 -0
  30. package/src/package_load/protocol.ts +336 -0
  31. package/src/query_param_utils.ts +18 -0
  32. package/src/server-old.ts +1 -1
  33. package/src/server.ts +36 -10
  34. package/src/service/db_utils.spec.ts +1 -1
  35. package/src/service/environment.ts +3 -2
  36. package/src/service/environment_store.ts +24 -3
  37. package/src/service/filter_integration.spec.ts +110 -0
  38. package/src/service/given.ts +80 -0
  39. package/src/service/givens_integration.spec.ts +192 -0
  40. package/src/service/model.spec.ts +105 -0
  41. package/src/service/model.ts +287 -16
  42. package/src/service/package.spec.ts +10 -0
  43. package/src/service/package.ts +257 -145
  44. package/src/service/package_worker_path.spec.ts +196 -0
  45. package/tests/integration/concurrent_package/concurrent_package.integration.spec.ts +280 -0
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@malloy-publisher/server",
3
3
  "description": "Malloy Publisher Server",
4
- "version": "0.0.198",
4
+ "version": "0.0.199",
5
5
  "main": "dist/server.mjs",
6
6
  "bin": {
7
7
  "malloy-publisher": "dist/server.mjs"
@@ -51,7 +51,6 @@
51
51
  "@opentelemetry/sdk-metrics": "^2.0.0",
52
52
  "@opentelemetry/sdk-node": "^0.200.0",
53
53
  "@opentelemetry/sdk-trace-node": "^2.0.0",
54
- "adm-zip": "^0.5.16",
55
54
  "async-mutex": "^0.5.0",
56
55
  "aws-sdk": "^2.1692.0",
57
56
  "body-parser": "^1.20.2",
@@ -61,6 +60,7 @@
61
60
  "cors": "^2.8.5",
62
61
  "duckdb": "1.4.4",
63
62
  "express": "^4.21.0",
63
+ "extract-zip": "^2.0.1",
64
64
  "globals": "^15.9.0",
65
65
  "handlebars": "^4.7.8",
66
66
  "http-proxy-middleware": "^3.0.5",
@@ -76,7 +76,6 @@
76
76
  "@eslint/eslintrc": "^3.3.1",
77
77
  "@eslint/js": "^9.23.0",
78
78
  "@faker-js/faker": "^9.4.0",
79
- "@types/adm-zip": "^0.5.7",
80
79
  "@types/bun": "^1.2.20",
81
80
  "@types/cors": "^2.8.12",
82
81
  "@types/express": "^4.17.14",
@@ -1,4 +1,4 @@
1
- import type { LogMessage } from "@malloydata/malloy";
1
+ import type { GivenValue, LogMessage } from "@malloydata/malloy";
2
2
  import { EnvironmentStore } from "../service/environment_store";
3
3
 
4
4
  export class CompileController {
@@ -14,6 +14,7 @@ export class CompileController {
14
14
  modelName: string,
15
15
  source: string,
16
16
  includeSql: boolean = false,
17
+ givens?: Record<string, GivenValue>,
17
18
  ): Promise<{ status: string; problems: LogMessage[]; sql?: string }> {
18
19
  const environment = await this.environmentStore.getEnvironment(
19
20
  environmentName,
@@ -24,6 +25,7 @@ export class CompileController {
24
25
  modelName,
25
26
  source,
26
27
  includeSql,
28
+ givens,
27
29
  );
28
30
 
29
31
  // Determine overall status based on presence of errors
@@ -2,6 +2,7 @@ import { components } from "../api";
2
2
  import { ModelNotFoundError } from "../errors";
3
3
  import { EnvironmentStore } from "../service/environment_store";
4
4
  import type { FilterParams } from "../service/filter";
5
+ import type { GivenValue } from "@malloydata/malloy";
5
6
 
6
7
  type ApiNotebook = components["schemas"]["Notebook"];
7
8
  type ApiModel = components["schemas"]["Model"];
@@ -97,6 +98,7 @@ export class ModelController {
97
98
  cellIndex: number,
98
99
  filterParams?: FilterParams,
99
100
  bypassFilters?: boolean,
101
+ givens?: Record<string, GivenValue>,
100
102
  ): Promise<{
101
103
  type: "code" | "markdown";
102
104
  text: string;
@@ -117,6 +119,11 @@ export class ModelController {
117
119
  throw new ModelNotFoundError(`${notebookPath} is a model`);
118
120
  }
119
121
 
120
- return model.executeNotebookCell(cellIndex, filterParams, bypassFilters);
122
+ return model.executeNotebookCell(
123
+ cellIndex,
124
+ filterParams,
125
+ bypassFilters,
126
+ givens,
127
+ );
121
128
  }
122
129
  }
@@ -4,6 +4,7 @@ import { API_PREFIX } from "../constants";
4
4
  import { ModelNotFoundError } from "../errors";
5
5
  import { EnvironmentStore } from "../service/environment_store";
6
6
  import type { FilterParams } from "../service/filter";
7
+ import type { GivenValue } from "@malloydata/malloy";
7
8
 
8
9
  type ApiQuery = components["schemas"]["QueryResult"];
9
10
 
@@ -32,6 +33,7 @@ export class QueryController {
32
33
  compactJson: boolean = false,
33
34
  filterParams?: FilterParams,
34
35
  bypassFilters?: boolean,
36
+ givens?: Record<string, GivenValue>,
35
37
  ): Promise<ApiQuery> {
36
38
  const environment = await this.environmentStore.getEnvironment(
37
39
  environmentName,
@@ -49,6 +51,7 @@ export class QueryController {
49
51
  query,
50
52
  filterParams,
51
53
  bypassFilters,
54
+ givens,
52
55
  );
53
56
  const renderLogs = validateRenderTags(result);
54
57
  return {
@@ -0,0 +1,90 @@
1
+ import { afterEach, beforeEach, describe, expect, it, spyOn } from "bun:test";
2
+ import { Server } from "http";
3
+ import { performGracefulShutdownAfterDrain } from "./health";
4
+ import { logger } from "./logger";
5
+
6
+ // Regression test for the graceful-shutdown ordering bug that caused
7
+ // [winston] Attempt to write logs with no transports: {"message":"Waiting 50 seconds..."}
8
+ // to appear in production logs. logger.close() must run after every
9
+ // logger.* call, including the "Waiting ... seconds after server close
10
+ // before exit..." message.
11
+ //
12
+ // Tests call performGracefulShutdownAfterDrain directly rather than
13
+ // emitting SIGTERM, so module-level operationalState is not mutated
14
+ // and the spec stays isolated from sibling tests in the same process.
15
+ describe("performGracefulShutdownAfterDrain: shutdown ordering", () => {
16
+ const originalExit = process.exit;
17
+ let callOrder: string[];
18
+
19
+ beforeEach(() => {
20
+ callOrder = [];
21
+
22
+ spyOn(logger, "info").mockImplementation(((msg: string) => {
23
+ callOrder.push(`info:${msg}`);
24
+ return logger;
25
+ }) as never);
26
+ spyOn(logger, "close").mockImplementation((() => {
27
+ callOrder.push("close");
28
+ return logger;
29
+ }) as never);
30
+ // Silence warn/error calls so spec output stays clean. They are
31
+ // not load-bearing for these assertions.
32
+ spyOn(logger, "warn").mockImplementation((() => logger) as never);
33
+ spyOn(logger, "error").mockImplementation((() => logger) as never);
34
+
35
+ process.exit = ((_code?: number) => {
36
+ callOrder.push("exit");
37
+ }) as never;
38
+ });
39
+
40
+ afterEach(() => {
41
+ process.exit = originalExit;
42
+ });
43
+
44
+ const fakeServer = (): Server => ({ listening: false }) as unknown as Server;
45
+
46
+ it("logs the 'Waiting ...' message before closing the logger", async () => {
47
+ await performGracefulShutdownAfterDrain(fakeServer(), fakeServer(), 0.05);
48
+
49
+ const waitingIdx = callOrder.findIndex((entry) =>
50
+ entry.startsWith("info:Waiting"),
51
+ );
52
+ const closeIdx = callOrder.indexOf("close");
53
+ const exitIdx = callOrder.indexOf("exit");
54
+
55
+ expect(waitingIdx).toBeGreaterThanOrEqual(0);
56
+ expect(closeIdx).toBeGreaterThanOrEqual(0);
57
+ expect(exitIdx).toBeGreaterThanOrEqual(0);
58
+ expect(waitingIdx).toBeLessThan(closeIdx);
59
+ expect(closeIdx).toBeLessThan(exitIdx);
60
+ });
61
+
62
+ it("emits no logger.info calls after logger.close", async () => {
63
+ await performGracefulShutdownAfterDrain(fakeServer(), fakeServer(), 0.05);
64
+
65
+ const closeIdx = callOrder.indexOf("close");
66
+ const lateInfoIdx = callOrder.findIndex(
67
+ (entry, idx) => idx > closeIdx && entry.startsWith("info:"),
68
+ );
69
+ expect(closeIdx).toBeGreaterThanOrEqual(0);
70
+ expect(lateInfoIdx).toBe(-1);
71
+ });
72
+
73
+ it("closes the logger exactly once", async () => {
74
+ await performGracefulShutdownAfterDrain(fakeServer(), fakeServer(), 0.05);
75
+
76
+ const closes = callOrder.filter((entry) => entry === "close").length;
77
+ expect(closes).toBe(1);
78
+ });
79
+
80
+ it("skips the 'Waiting ...' message when gracefulCloseTimeoutSeconds is 0", async () => {
81
+ await performGracefulShutdownAfterDrain(fakeServer(), fakeServer(), 0);
82
+
83
+ const waitingCalls = callOrder.filter((entry) =>
84
+ entry.startsWith("info:Waiting"),
85
+ );
86
+ expect(waitingCalls.length).toBe(0);
87
+ expect(callOrder.indexOf("close")).toBeGreaterThanOrEqual(0);
88
+ expect(callOrder.indexOf("exit")).toBeGreaterThanOrEqual(0);
89
+ });
90
+ });
package/src/health.ts CHANGED
@@ -57,8 +57,8 @@ export function markNotReady(): void {
57
57
  * 2. Waits shutdownDrainDurationSeconds to allow in-flight requests to complete
58
58
  * 3. Sets preGracefulShutdownCompleted flag (enables drainingGuard middleware to reject new requests)
59
59
  * 4. Closes main server and MCP server (stops accepting new connections)
60
- * 5. Closes logger
61
- * 6. Waits shutdownGracefulCloseTimeoutSeconds (if > 0) for final cleanup
60
+ * 5. Waits shutdownGracefulCloseTimeoutSeconds (if > 0) for final cleanup
61
+ * 6. Closes logger (last, so any logs emitted during cleanup are flushed)
62
62
  * 7. Exits process
63
63
  *
64
64
  * Note: drainingGuard only rejects requests after step 3 completes. During step 2,
@@ -92,51 +92,94 @@ export function registerSignalHandlers(
92
92
  }, shutdownDrainDurationSeconds * 1000),
93
93
  );
94
94
 
95
- const closeServer = (server: Server, name: string) =>
96
- new Promise<void>((resolve) => {
97
- if (server && server.listening) {
98
- server.close((err) => {
99
- if (err) {
100
- logger.error(`${name} close error:`, err);
101
- } else {
102
- logger.info(`${name} closed`);
103
- }
104
- resolve();
105
- });
106
- } else {
107
- resolve();
108
- }
109
- });
110
-
111
- await Promise.all([
112
- closeServer(server, "Main server"),
113
- closeServer(mcpServer, "MCP server"),
114
- ]);
115
-
116
- try {
117
- await shutdownSDK();
118
- logger.info("OpenTelemetry SDK shut down");
119
- } catch (_error) {
120
- /* do nothing */
121
- }
122
-
123
- try {
124
- logger.close();
125
- } catch (_error) {
126
- /* do nothing */
127
- }
128
-
129
- if (shutdownGracefulCloseTimeoutSeconds > 0) {
130
- logger.info(
131
- `Waiting ${shutdownGracefulCloseTimeoutSeconds} seconds after server close before exit...`,
132
- );
133
- await new Promise((resolve) =>
134
- setTimeout(resolve, shutdownGracefulCloseTimeoutSeconds * 1000),
135
- );
136
- }
137
- process.exit(0);
95
+ await performGracefulShutdownAfterDrain(
96
+ server,
97
+ mcpServer,
98
+ shutdownGracefulCloseTimeoutSeconds,
99
+ );
138
100
  });
139
101
  }
102
+
103
+ /**
104
+ * Performs the post-drain shutdown work: closes both HTTP servers,
105
+ * shuts down the OpenTelemetry SDK, waits the optional graceful-close
106
+ * window so any in-flight cleanup can finish logging, closes the
107
+ * winston logger, and exits the process.
108
+ *
109
+ * Exported so unit tests can exercise the close + log + exit ordering
110
+ * without emitting SIGTERM (which would leave module-level
111
+ * operationalState stuck in "draining" and leak into sibling specs).
112
+ */
113
+ export async function performGracefulShutdownAfterDrain(
114
+ server: Server,
115
+ mcpServer: Server,
116
+ shutdownGracefulCloseTimeoutSeconds: number,
117
+ ): Promise<void> {
118
+ const closeServer = (server: Server, name: string) =>
119
+ new Promise<void>((resolve) => {
120
+ if (server && server.listening) {
121
+ server.close((err) => {
122
+ if (err) {
123
+ logger.error(`${name} close error:`, err);
124
+ } else {
125
+ logger.info(`${name} closed`);
126
+ }
127
+ resolve();
128
+ });
129
+ } else {
130
+ resolve();
131
+ }
132
+ });
133
+
134
+ await Promise.all([
135
+ closeServer(server, "Main server"),
136
+ closeServer(mcpServer, "MCP server"),
137
+ ]);
138
+
139
+ try {
140
+ await shutdownSDK();
141
+ logger.info("OpenTelemetry SDK shut down");
142
+ } catch (_error) {
143
+ /* do nothing */
144
+ }
145
+
146
+ try {
147
+ // Drain in-flight compiles and terminate worker_threads before
148
+ // we exit so a slow compile doesn't leave orphan worker
149
+ // processes. Lazy-imported to avoid pulling the pool module
150
+ // into the health.ts dep graph for tests that don't exercise
151
+ // the compile path.
152
+ const { getPackageLoadPool } = await import(
153
+ "./package_load/package_load_pool"
154
+ );
155
+ await getPackageLoadPool().shutdown();
156
+ logger.info("Package-load worker pool shut down");
157
+ } catch (_error) {
158
+ /* do nothing */
159
+ }
160
+
161
+ if (shutdownGracefulCloseTimeoutSeconds > 0) {
162
+ logger.info(
163
+ `Waiting ${shutdownGracefulCloseTimeoutSeconds} seconds after server close before exit...`,
164
+ );
165
+ await new Promise((resolve) =>
166
+ setTimeout(resolve, shutdownGracefulCloseTimeoutSeconds * 1000),
167
+ );
168
+ }
169
+
170
+ // Close the logger last so anything emitted during the wait window
171
+ // above (or by other shutdown paths still running) reaches its
172
+ // transports. Closing earlier triggers winston's
173
+ // "Attempt to write logs with no transports" warning on any
174
+ // subsequent logger call.
175
+ try {
176
+ logger.close();
177
+ } catch (_error) {
178
+ /* do nothing */
179
+ }
180
+
181
+ process.exit(0);
182
+ }
140
183
  /**
141
184
  * Middleware that returns 503 for non-health and metrics requests when service is draining.
142
185
  * Must be registered before application routes.
@@ -1,3 +1,4 @@
1
+ import { monitorEventLoopDelay } from "node:perf_hooks";
1
2
  import { metrics } from "@opentelemetry/api";
2
3
  import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
3
4
  import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-proto";
@@ -116,6 +117,55 @@ const httpRequestCount = meter.createCounter("http_server_requests_total", {
116
117
  description: "Total number of HTTP requests",
117
118
  });
118
119
 
120
+ // Event-loop-delay metrics. A blocked event loop is the only way the
121
+ // /health/liveness probe (a pure synchronous 200 handler) can fail under K8s,
122
+ // so we surface p50/p99/max so an operator can correlate liveness restarts
123
+ // with sustained event-loop pressure (large Malloy compiles, GC, etc.).
124
+ const eventLoopHistogram = monitorEventLoopDelay({ resolution: 20 });
125
+ eventLoopHistogram.enable();
126
+
127
+ const eventLoopLagP50 = meter.createObservableGauge(
128
+ "publisher_event_loop_lag_p50_ms",
129
+ {
130
+ description:
131
+ "Event loop delay p50 since the last scrape, in milliseconds",
132
+ unit: "ms",
133
+ },
134
+ );
135
+ const eventLoopLagP99 = meter.createObservableGauge(
136
+ "publisher_event_loop_lag_p99_ms",
137
+ {
138
+ description:
139
+ "Event loop delay p99 since the last scrape, in milliseconds",
140
+ unit: "ms",
141
+ },
142
+ );
143
+ const eventLoopLagMax = meter.createObservableGauge(
144
+ "publisher_event_loop_lag_max_ms",
145
+ {
146
+ description:
147
+ "Event loop delay max since the last scrape, in milliseconds",
148
+ unit: "ms",
149
+ },
150
+ );
151
+
152
+ // Sample all three in one batch so the histogram reset can't race the reads.
153
+ meter.addBatchObservableCallback(
154
+ (observableResult) => {
155
+ observableResult.observe(
156
+ eventLoopLagP50,
157
+ eventLoopHistogram.percentile(50) / 1e6,
158
+ );
159
+ observableResult.observe(
160
+ eventLoopLagP99,
161
+ eventLoopHistogram.percentile(99) / 1e6,
162
+ );
163
+ observableResult.observe(eventLoopLagMax, eventLoopHistogram.max / 1e6);
164
+ eventLoopHistogram.reset();
165
+ },
166
+ [eventLoopLagP50, eventLoopLagP99, eventLoopLagMax],
167
+ );
168
+
119
169
  const IGNORED_PATHS = new Set([
120
170
  "/health",
121
171
  "/health/liveness",
@@ -1,6 +1,7 @@
1
1
  import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
2
2
  import { ErrorCode, McpError } from "@modelcontextprotocol/sdk/types.js";
3
3
  import { z } from "zod";
4
+ import type { GivenValue } from "@malloydata/malloy";
4
5
  import { logger } from "../../logger";
5
6
  import { EnvironmentStore } from "../../service/environment_store";
6
7
  import { getMalloyErrorDetails, type ErrorDetails } from "../error_messages";
@@ -30,6 +31,12 @@ const executeQueryShape = {
30
31
  .describe(
31
32
  "Filter parameter values keyed by filter name. Used with sources that declare #(filter) annotations.",
32
33
  ),
34
+ givens: z
35
+ .record(z.unknown())
36
+ .optional()
37
+ .describe(
38
+ "Per-query given values that override model defaults. Keys are given names declared in the model's given: block.",
39
+ ),
33
40
  };
34
41
 
35
42
  // Type inference is handled automatically by the MCP server based on the executeQueryShape
@@ -56,6 +63,7 @@ export function registerExecuteQueryTool(
56
63
  sourceName,
57
64
  queryName,
58
65
  filterParams,
66
+ givens,
59
67
  } = params;
60
68
 
61
69
  logger.info("[MCP Tool executeQuery] Received params:", { params });
@@ -128,6 +136,8 @@ export function registerExecuteQueryTool(
128
136
  undefined,
129
137
  query,
130
138
  filterParams,
139
+ undefined,
140
+ givens as Record<string, GivenValue> | undefined,
131
141
  );
132
142
  const { validateRenderTags } = await import(
133
143
  "@malloydata/render-validator"
@@ -174,6 +184,8 @@ export function registerExecuteQueryTool(
174
184
  queryName,
175
185
  undefined,
176
186
  filterParams,
187
+ undefined,
188
+ givens as Record<string, GivenValue> | undefined,
177
189
  );
178
190
  const { validateRenderTags } = await import(
179
191
  "@malloydata/render-validator"