@malloy-publisher/server 0.0.235 → 0.0.236

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 (301) hide show
  1. package/dist/app/api-doc.yaml +47 -17
  2. package/dist/package_load_worker.mjs +8 -1
  3. package/dist/server.mjs +471 -54
  4. package/package.json +5 -2
  5. package/.eslintrc.json +0 -44
  6. package/.prettierignore +0 -1
  7. package/.prettierrc +0 -4
  8. package/build.ts +0 -97
  9. package/eslint.config.mjs +0 -76
  10. package/k6-tests/README.md +0 -144
  11. package/k6-tests/bun.lock +0 -797
  12. package/k6-tests/load-test/load-test-crud-connections.ts +0 -263
  13. package/k6-tests/load-test/load-test-crud-packages.ts +0 -461
  14. package/k6-tests/load-test/load-test-crud-projects.ts +0 -160
  15. package/k6-tests/load-test/load-test-crud.ts +0 -142
  16. package/k6-tests/load-test/load-test.ts +0 -784
  17. package/k6-tests/package.json +0 -27
  18. package/k6-tests/scripts/run-with-otel.sh +0 -50
  19. package/k6-tests/smoke-test/smoke-test.ts +0 -158
  20. package/k6-tests/tsconfig.json +0 -29
  21. package/k6-tests/utils/client_factory.ts +0 -128
  22. package/k6-tests/utils/common.ts +0 -489
  23. package/k6-tests/utils/logger.ts +0 -62
  24. package/k6-tests/utils/types.d.ts +0 -35
  25. package/malloy_mcp.dxt +0 -0
  26. package/publisher.config.example.bigquery.json +0 -33
  27. package/publisher.config.example.duckdb.json +0 -23
  28. package/publisher.config.json +0 -23
  29. package/scripts/bake-duckdb-extensions.js +0 -110
  30. package/src/config.spec.ts +0 -1535
  31. package/src/config.theme.spec.ts +0 -178
  32. package/src/config.ts +0 -1142
  33. package/src/constants.ts +0 -105
  34. package/src/controller/compile.controller.ts +0 -40
  35. package/src/controller/connection.controller.spec.ts +0 -849
  36. package/src/controller/connection.controller.ts +0 -901
  37. package/src/controller/database.controller.ts +0 -24
  38. package/src/controller/materialization.controller.spec.ts +0 -293
  39. package/src/controller/materialization.controller.ts +0 -319
  40. package/src/controller/model.controller.ts +0 -164
  41. package/src/controller/package.controller.spec.ts +0 -273
  42. package/src/controller/package.controller.ts +0 -306
  43. package/src/controller/query.controller.ts +0 -152
  44. package/src/controller/theme.controller.ts +0 -83
  45. package/src/controller/watch-mode.controller.ts +0 -243
  46. package/src/data_styles.ts +0 -71
  47. package/src/default-publisher.config.json +0 -23
  48. package/src/ducklake_version.spec.ts +0 -163
  49. package/src/ducklake_version.ts +0 -153
  50. package/src/errors.spec.ts +0 -119
  51. package/src/errors.ts +0 -237
  52. package/src/filter_deprecation.spec.ts +0 -64
  53. package/src/filter_deprecation.ts +0 -42
  54. package/src/health.spec.ts +0 -123
  55. package/src/health.ts +0 -233
  56. package/src/heap_check.spec.ts +0 -144
  57. package/src/heap_check.ts +0 -144
  58. package/src/instrumentation.ts +0 -214
  59. package/src/json_utils.spec.ts +0 -51
  60. package/src/json_utils.ts +0 -33
  61. package/src/logger.spec.ts +0 -210
  62. package/src/logger.ts +0 -251
  63. package/src/malloy_pin_prereqs.spec.ts +0 -25
  64. package/src/materialization_metrics.spec.ts +0 -169
  65. package/src/materialization_metrics.ts +0 -346
  66. package/src/mcp/error_messages.spec.ts +0 -35
  67. package/src/mcp/error_messages.ts +0 -183
  68. package/src/mcp/handler_utils.spec.ts +0 -108
  69. package/src/mcp/handler_utils.ts +0 -251
  70. package/src/mcp/mcp_constants.ts +0 -6
  71. package/src/mcp/query_envelope.spec.ts +0 -229
  72. package/src/mcp/query_envelope.ts +0 -240
  73. package/src/mcp/server.protocol.spec.ts +0 -250
  74. package/src/mcp/server.ts +0 -87
  75. package/src/mcp/skills/build_skills_bundle.spec.ts +0 -51
  76. package/src/mcp/skills/build_skills_bundle.ts +0 -176
  77. package/src/mcp/skills/skills_bundle.json +0 -1
  78. package/src/mcp/skills/skills_bundle.spec.ts +0 -171
  79. package/src/mcp/tool_response.spec.ts +0 -108
  80. package/src/mcp/tool_response.ts +0 -138
  81. package/src/mcp/tools/compile_tool.spec.ts +0 -315
  82. package/src/mcp/tools/compile_tool.ts +0 -208
  83. package/src/mcp/tools/docs_search/build_docs_index.ts +0 -132
  84. package/src/mcp/tools/docs_search/malloy_docs_index.json +0 -1
  85. package/src/mcp/tools/docs_search_tool.spec.ts +0 -32
  86. package/src/mcp/tools/docs_search_tool.ts +0 -128
  87. package/src/mcp/tools/embedding_index.spec.ts +0 -1236
  88. package/src/mcp/tools/embedding_index.ts +0 -808
  89. package/src/mcp/tools/execute_query_tool.spec.ts +0 -294
  90. package/src/mcp/tools/execute_query_tool.ts +0 -316
  91. package/src/mcp/tools/get_context_eval.ts +0 -275
  92. package/src/mcp/tools/get_context_tool.spec.ts +0 -592
  93. package/src/mcp/tools/get_context_tool.ts +0 -585
  94. package/src/mcp/tools/reload_package_tool.spec.ts +0 -232
  95. package/src/mcp/tools/reload_package_tool.ts +0 -132
  96. package/src/mcp_config.spec.ts +0 -919
  97. package/src/mcp_config.ts +0 -425
  98. package/src/oom_guards.integration.spec.ts +0 -269
  99. package/src/package_load/package_load_pool.spec.ts +0 -252
  100. package/src/package_load/package_load_pool.ts +0 -931
  101. package/src/package_load/package_load_worker.ts +0 -1034
  102. package/src/package_load/protocol.ts +0 -364
  103. package/src/package_load/rpc_wait_accountant.spec.ts +0 -109
  104. package/src/package_load/rpc_wait_accountant.ts +0 -76
  105. package/src/package_load_metrics.spec.ts +0 -114
  106. package/src/package_load_metrics.ts +0 -127
  107. package/src/path_safety.spec.ts +0 -158
  108. package/src/path_safety.ts +0 -146
  109. package/src/pg_helpers.spec.ts +0 -223
  110. package/src/pg_helpers.ts +0 -52
  111. package/src/query_cap_metrics.spec.ts +0 -89
  112. package/src/query_cap_metrics.ts +0 -116
  113. package/src/query_concurrency.spec.ts +0 -247
  114. package/src/query_concurrency.ts +0 -237
  115. package/src/query_metadata_metrics.ts +0 -49
  116. package/src/query_param_utils.ts +0 -29
  117. package/src/query_timeout.spec.ts +0 -224
  118. package/src/query_timeout.ts +0 -179
  119. package/src/runtime/publisher.js +0 -328
  120. package/src/server-old.ts +0 -988
  121. package/src/server.ts +0 -2059
  122. package/src/service/annotations.spec.ts +0 -118
  123. package/src/service/annotations.ts +0 -91
  124. package/src/service/authorize.spec.ts +0 -154
  125. package/src/service/authorize.ts +0 -498
  126. package/src/service/authorize_integration.spec.ts +0 -2041
  127. package/src/service/build_plan.spec.ts +0 -685
  128. package/src/service/build_plan.ts +0 -797
  129. package/src/service/compile_authorize.spec.ts +0 -85
  130. package/src/service/compile_fragment_techniques.spec.ts +0 -156
  131. package/src/service/connection.spec.ts +0 -2360
  132. package/src/service/connection.ts +0 -2187
  133. package/src/service/connection_config.spec.ts +0 -734
  134. package/src/service/connection_config.ts +0 -899
  135. package/src/service/connection_federation.spec.ts +0 -184
  136. package/src/service/connection_fingerprint.spec.ts +0 -102
  137. package/src/service/connection_service.spec.ts +0 -711
  138. package/src/service/connection_service.ts +0 -291
  139. package/src/service/cron_evaluator.spec.ts +0 -79
  140. package/src/service/cron_evaluator.ts +0 -105
  141. package/src/service/db_utils.spec.ts +0 -1085
  142. package/src/service/db_utils.ts +0 -1502
  143. package/src/service/duckdb_instance_isolation.spec.ts +0 -137
  144. package/src/service/ducklake_lazy_attach.spec.ts +0 -110
  145. package/src/service/embedding_provider.spec.ts +0 -329
  146. package/src/service/embedding_provider.ts +0 -236
  147. package/src/service/environment.ts +0 -2191
  148. package/src/service/environment_admission.spec.ts +0 -344
  149. package/src/service/environment_compile.spec.ts +0 -197
  150. package/src/service/environment_store.spec.ts +0 -2274
  151. package/src/service/environment_store.ts +0 -2434
  152. package/src/service/environment_store_anchoring.spec.ts +0 -107
  153. package/src/service/environment_store_clone.spec.ts +0 -350
  154. package/src/service/explore_visibility.spec.ts +0 -434
  155. package/src/service/exports_probe.spec.ts +0 -107
  156. package/src/service/extension_fetch_policy.spec.ts +0 -256
  157. package/src/service/filter.spec.ts +0 -458
  158. package/src/service/filter.ts +0 -341
  159. package/src/service/filter_bypass.spec.ts +0 -418
  160. package/src/service/filter_integration.spec.ts +0 -1004
  161. package/src/service/freshness.spec.ts +0 -183
  162. package/src/service/freshness.ts +0 -112
  163. package/src/service/gcs_s3_utils.ts +0 -427
  164. package/src/service/given.ts +0 -105
  165. package/src/service/givens_integration.spec.ts +0 -219
  166. package/src/service/manifest_loader.spec.ts +0 -189
  167. package/src/service/manifest_loader.ts +0 -156
  168. package/src/service/materialization_build_session.spec.ts +0 -435
  169. package/src/service/materialization_build_session.ts +0 -681
  170. package/src/service/materialization_config_validation.spec.ts +0 -99
  171. package/src/service/materialization_config_validation.ts +0 -120
  172. package/src/service/materialization_eligibility.spec.ts +0 -158
  173. package/src/service/materialization_eligibility.ts +0 -305
  174. package/src/service/materialization_schedule_surface.spec.ts +0 -256
  175. package/src/service/materialization_scheduler.spec.ts +0 -289
  176. package/src/service/materialization_scheduler.ts +0 -304
  177. package/src/service/materialization_serve_transform.spec.ts +0 -1003
  178. package/src/service/materialization_serve_transform.ts +0 -779
  179. package/src/service/materialization_service.spec.ts +0 -2373
  180. package/src/service/materialization_service.ts +0 -2342
  181. package/src/service/materialization_test_fixtures.ts +0 -249
  182. package/src/service/model.spec.ts +0 -1157
  183. package/src/service/model.ts +0 -3370
  184. package/src/service/model_limits.spec.ts +0 -209
  185. package/src/service/model_limits.ts +0 -131
  186. package/src/service/model_storage_serve.spec.ts +0 -193
  187. package/src/service/model_storage_serve_joins.spec.ts +0 -193
  188. package/src/service/package.spec.ts +0 -612
  189. package/src/service/package.ts +0 -1799
  190. package/src/service/package_manifest.spec.ts +0 -230
  191. package/src/service/package_manifest.ts +0 -241
  192. package/src/service/package_memory_governor.spec.ts +0 -173
  193. package/src/service/package_memory_governor.ts +0 -233
  194. package/src/service/package_quote_bound_tables.spec.ts +0 -171
  195. package/src/service/package_race.spec.ts +0 -208
  196. package/src/service/package_reload_safety.spec.ts +0 -193
  197. package/src/service/package_rollback.spec.ts +0 -190
  198. package/src/service/package_worker_path.spec.ts +0 -645
  199. package/src/service/path_injection.spec.ts +0 -39
  200. package/src/service/persist_annotation_validation.spec.ts +0 -89
  201. package/src/service/persist_annotation_validation.ts +0 -59
  202. package/src/service/persistence_policy.spec.ts +0 -374
  203. package/src/service/proxy.spec.ts +0 -414
  204. package/src/service/proxy.ts +0 -248
  205. package/src/service/query_boundary.spec.ts +0 -470
  206. package/src/service/query_metadata.spec.ts +0 -408
  207. package/src/service/query_metadata.ts +0 -492
  208. package/src/service/query_metadata_identity.spec.ts +0 -149
  209. package/src/service/query_text.spec.ts +0 -79
  210. package/src/service/query_text.ts +0 -43
  211. package/src/service/quoting.spec.ts +0 -135
  212. package/src/service/quoting.ts +0 -78
  213. package/src/service/resolve_environment.ts +0 -15
  214. package/src/service/restricted_mode.spec.ts +0 -299
  215. package/src/service/source_extraction.ts +0 -225
  216. package/src/service/theme_store.ts +0 -199
  217. package/src/storage/DatabaseInterface.ts +0 -198
  218. package/src/storage/StorageManager.ts +0 -113
  219. package/src/storage/duckdb/ConnectionRepository.ts +0 -143
  220. package/src/storage/duckdb/DuckDBConnection.ts +0 -123
  221. package/src/storage/duckdb/DuckDBRepository.ts +0 -208
  222. package/src/storage/duckdb/EnvironmentRepository.ts +0 -148
  223. package/src/storage/duckdb/MaterializationRepository.spec.ts +0 -191
  224. package/src/storage/duckdb/MaterializationRepository.ts +0 -336
  225. package/src/storage/duckdb/PackageRepository.ts +0 -135
  226. package/src/storage/duckdb/schema.ts +0 -229
  227. package/src/stream_helpers.spec.ts +0 -280
  228. package/src/stream_helpers.ts +0 -162
  229. package/src/telemetry.ts +0 -20
  230. package/src/test_helpers/metrics_harness.ts +0 -166
  231. package/src/theme_key_parity.spec.ts +0 -57
  232. package/src/utils.ts +0 -29
  233. package/tests/fixtures/authorize-compile/model.malloy +0 -9
  234. package/tests/fixtures/authorize-compile/publisher.json +0 -4
  235. package/tests/fixtures/html-pages-nopublic/model.malloy +0 -1
  236. package/tests/fixtures/html-pages-nopublic/publisher.json +0 -5
  237. package/tests/fixtures/html-pages-test/data.csv +0 -3
  238. package/tests/fixtures/html-pages-test/public/assets/app.css +0 -3
  239. package/tests/fixtures/html-pages-test/public/barehtml.html +0 -4
  240. package/tests/fixtures/html-pages-test/public/bodymeta.html +0 -8
  241. package/tests/fixtures/html-pages-test/public/data.json +0 -1
  242. package/tests/fixtures/html-pages-test/public/fitcomment.html +0 -11
  243. package/tests/fixtures/html-pages-test/public/index.html +0 -9
  244. package/tests/fixtures/html-pages-test/public/nohead.html +0 -8
  245. package/tests/fixtures/html-pages-test/public/notfit.html +0 -13
  246. package/tests/fixtures/html-pages-test/public/slides.html +0 -12
  247. package/tests/fixtures/html-pages-test/public/sub/page2.html +0 -9
  248. package/tests/fixtures/html-pages-test/public/unterminated.html +0 -10
  249. package/tests/fixtures/html-pages-test/publisher.json +0 -5
  250. package/tests/fixtures/html-pages-test/report.malloy +0 -1
  251. package/tests/fixtures/persist-multi-level/data/orders.csv +0 -5
  252. package/tests/fixtures/persist-multi-level/multi_level.malloy +0 -18
  253. package/tests/fixtures/persist-multi-level/publisher.json +0 -5
  254. package/tests/fixtures/persist-schedule-test/data/orders.csv +0 -5
  255. package/tests/fixtures/persist-schedule-test/persist_schedule_test.malloy +0 -11
  256. package/tests/fixtures/persist-schedule-test/publisher.json +0 -7
  257. package/tests/fixtures/persist-schedule-warn-test/data/orders.csv +0 -5
  258. package/tests/fixtures/persist-schedule-warn-test/persist_warn_test.malloy +0 -11
  259. package/tests/fixtures/persist-schedule-warn-test/publisher.json +0 -6
  260. package/tests/fixtures/persist-test/data/orders.csv +0 -5
  261. package/tests/fixtures/persist-test/persist_test.malloy +0 -11
  262. package/tests/fixtures/persist-test/publisher.json +0 -5
  263. package/tests/fixtures/publisher.config.json +0 -15
  264. package/tests/fixtures/query-givens/data/orders.csv +0 -7
  265. package/tests/fixtures/query-givens/model.malloy +0 -34
  266. package/tests/fixtures/query-givens/publisher.json +0 -5
  267. package/tests/fixtures/xlsx/database.xlsx +0 -0
  268. package/tests/harness/mcp_test_setup.ts +0 -332
  269. package/tests/harness/rest_e2e.ts +0 -68
  270. package/tests/integration/authorize/compile_authorize_http.integration.spec.ts +0 -92
  271. package/tests/integration/concurrent_package/concurrent_package.integration.spec.ts +0 -280
  272. package/tests/integration/duckdb_storage/duckdb_storage.integration.spec.ts +0 -138
  273. package/tests/integration/first_boot/readiness_line.integration.spec.ts +0 -177
  274. package/tests/integration/html_pages/html_pages.integration.spec.ts +0 -440
  275. package/tests/integration/legacy_routes/legacy_routes.integration.spec.ts +0 -259
  276. package/tests/integration/materialization/environment_list.integration.spec.ts +0 -133
  277. package/tests/integration/materialization/freshness_gate.integration.spec.ts +0 -292
  278. package/tests/integration/materialization/manifest_binding.integration.spec.ts +0 -430
  279. package/tests/integration/materialization/materialization_lifecycle.integration.spec.ts +0 -441
  280. package/tests/integration/materialization/orchestrated_rebind.integration.spec.ts +0 -150
  281. package/tests/integration/materialization/reference_manifest.integration.spec.ts +0 -251
  282. package/tests/integration/materialization/schedule_edit.integration.spec.ts +0 -126
  283. package/tests/integration/materialization/scheduler.integration.spec.ts +0 -200
  284. package/tests/integration/materialization/scheduler_recovery.integration.spec.ts +0 -172
  285. package/tests/integration/materialization/scheduler_transitions.integration.spec.ts +0 -256
  286. package/tests/integration/materialization/scheduler_wiring.integration.spec.ts +0 -143
  287. package/tests/integration/mcp/mcp_execute_query_tool.integration.spec.ts +0 -438
  288. package/tests/integration/mcp/mcp_get_context_semantic.integration.spec.ts +0 -235
  289. package/tests/integration/mcp/mcp_transport.integration.spec.ts +0 -98
  290. package/tests/integration/query_givens/query_givens.integration.spec.ts +0 -146
  291. package/tests/integration/query_givens/query_givens_authorize.integration.spec.ts +0 -121
  292. package/tests/integration/sdk_givens/sdk_givens.integration.spec.ts +0 -110
  293. package/tests/integration/watch-mode/watch_mode.integration.spec.ts +0 -421
  294. package/tests/unit/controller/theme.controller.spec.ts +0 -141
  295. package/tests/unit/duckdb/attached_databases.test.ts +0 -1243
  296. package/tests/unit/duckdb/duckdb_connection.test.ts +0 -181
  297. package/tests/unit/duckdb/legacy_schema_migration.test.ts +0 -197
  298. package/tests/unit/duckdb/repositories.test.ts +0 -208
  299. package/tests/unit/ducklake/ducklake.test.ts +0 -952
  300. package/tests/unit/service/theme_store.spec.ts +0 -139
  301. package/tsconfig.json +0 -32
@@ -1,107 +0,0 @@
1
- import { afterEach, beforeEach, describe, expect, it, mock } from "bun:test";
2
- import { existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "fs";
3
- import * as path from "path";
4
- import { PUBLISHER_CONFIG_NAME, TEMP_DIR_PATH } from "../constants";
5
-
6
- /**
7
- * A relative package `location` must anchor at the directory holding the config
8
- * that declared it, not at the server root. Those are the same path in the
9
- * common case (`<serverRoot>/publisher.config.json`), so a spec that lets them
10
- * coincide cannot tell the two rules apart.
11
- *
12
- * Here they are deliberately different directories, driven through the real
13
- * `PUBLISHER_CONFIG_PATH` that `--config` sets, so this exercises the actual
14
- * resolution rather than a stub of it.
15
- */
16
- const serverRootPath = path.join(TEMP_DIR_PATH, "anchoring-server-root");
17
- const configDirPath = path.join(TEMP_DIR_PATH, "anchoring-config-dir");
18
-
19
- mock.module("../storage/StorageManager", () => ({
20
- StorageManager: class MockStorageManager {
21
- async initialize(): Promise<void> {}
22
- getRepository() {
23
- return {
24
- listEnvironments: async () => [],
25
- getEnvironmentByName: async () => null,
26
- createEnvironment: async (data: Record<string, unknown>) => ({
27
- id: "env-id",
28
- name: data.name,
29
- path: data.path,
30
- }),
31
- listPackages: async () => [],
32
- getPackageByName: async () => null,
33
- createPackage: async (data: Record<string, unknown>) => ({
34
- id: "pkg-id",
35
- name: data.name,
36
- }),
37
- listConnections: async () => [],
38
- };
39
- }
40
- },
41
- StorageConfig: {} as Record<string, unknown>,
42
- }));
43
-
44
- const { EnvironmentStore } = await import("./environment_store");
45
-
46
- describe("relative package locations anchor at the config directory", () => {
47
- const savedConfigPath = process.env.PUBLISHER_CONFIG_PATH;
48
-
49
- beforeEach(() => {
50
- for (const dir of [serverRootPath, configDirPath]) {
51
- rmSync(dir, { recursive: true, force: true });
52
- mkdirSync(dir, { recursive: true });
53
- }
54
- const configPath = path.join(configDirPath, PUBLISHER_CONFIG_NAME);
55
- writeFileSync(configPath, JSON.stringify({ environments: [] }));
56
- process.env.PUBLISHER_CONFIG_PATH = configPath;
57
- });
58
-
59
- afterEach(() => {
60
- if (savedConfigPath === undefined) {
61
- delete process.env.PUBLISHER_CONFIG_PATH;
62
- } else {
63
- process.env.PUBLISHER_CONFIG_PATH = savedConfigPath;
64
- }
65
- for (const dir of [serverRootPath, configDirPath]) {
66
- rmSync(dir, { recursive: true, force: true });
67
- }
68
- });
69
-
70
- it("mounts a package that sits next to the config, not next to the server root", async () => {
71
- // A `sales` directory exists in BOTH candidate anchors, with different
72
- // contents. If resolution silently reverted to server-root anchoring it
73
- // would still mount successfully — off the decoy — so the existence
74
- // check alone could not catch the regression; the content check does.
75
- const packageSource = path.join(configDirPath, "sales");
76
- mkdirSync(packageSource, { recursive: true });
77
- writeFileSync(
78
- path.join(packageSource, "publisher.json"),
79
- JSON.stringify({ name: "sales" }),
80
- );
81
- const decoySource = path.join(serverRootPath, "sales");
82
- mkdirSync(decoySource, { recursive: true });
83
- writeFileSync(
84
- path.join(decoySource, "publisher.json"),
85
- JSON.stringify({ name: "decoy-from-server-root" }),
86
- );
87
-
88
- const store = new EnvironmentStore(serverRootPath);
89
- await store.addEnvironment({
90
- name: "probe",
91
- packages: [{ name: "sales", location: "./sales" }],
92
- connections: [],
93
- } as never);
94
-
95
- const mountedManifest = path.join(
96
- serverRootPath,
97
- "publisher_data",
98
- "probe",
99
- "sales",
100
- "publisher.json",
101
- );
102
- expect(existsSync(mountedManifest)).toBe(true);
103
- expect(JSON.parse(readFileSync(mountedManifest, "utf-8")).name).toBe(
104
- "sales",
105
- );
106
- });
107
- });
@@ -1,350 +0,0 @@
1
- import {
2
- afterEach,
3
- beforeEach,
4
- describe,
5
- expect,
6
- it,
7
- mock,
8
- spyOn,
9
- } from "bun:test";
10
- import { existsSync, mkdirSync, rmSync, writeFileSync } from "fs";
11
- import * as path from "path";
12
- import { TEMP_DIR_PATH } from "../constants";
13
- import { logger } from "../logger";
14
-
15
- /**
16
- * Wiring coverage for the package git clone: the shallow-clone options must
17
- * actually reach `simple-git`'s clone call, the factory must carry a progress
18
- * handler whose output lands on stderr with the right label, and the readiness
19
- * line must not print when boot fails. The pure helpers (options content,
20
- * throttling, label text) are covered in environment_store.spec.ts; this file
21
- * proves the plumbing.
22
- *
23
- * simple-git is module-mocked BEFORE the store is imported (the anchoring
24
- * spec's ordering idiom). The mock leaks forward in bun's shared module cache,
25
- * which is safe here: environment_store.ts is the only importer, and the only
26
- * spec that performs a real clone (connection.spec.ts) is credential-gated and
27
- * runs in its own workflow process.
28
- */
29
-
30
- const serverRootPath = path.join(TEMP_DIR_PATH, "clone-spec-server-root");
31
-
32
- const ENV_NAME = "clone-env";
33
- const PKG_NAME = "pkg-a";
34
-
35
- interface RecordedClone {
36
- repoUrl: string;
37
- dir: string;
38
- opts: Record<string, unknown>;
39
- }
40
-
41
- let recordedClones: RecordedClone[] = [];
42
- let lastFactoryOpts: {
43
- progress?: (event: {
44
- method: string;
45
- stage: string;
46
- progress: number;
47
- processed: number;
48
- total: number;
49
- }) => void;
50
- } | null = null;
51
- let storageInitFails = false;
52
- let storageInitMessage = "storage init failed (test)";
53
- let cloneFailure: Error | null = null;
54
-
55
- mock.module("simple-git", () => ({
56
- default: (factoryOpts?: typeof lastFactoryOpts) => {
57
- lastFactoryOpts = factoryOpts ?? null;
58
- return {
59
- clone: (
60
- repoUrl: string,
61
- dir: string,
62
- opts: Record<string, unknown>,
63
- cb: (err: Error | null) => void,
64
- ) => {
65
- recordedClones.push({ repoUrl, dir, opts });
66
- if (cloneFailure) {
67
- cb(cloneFailure);
68
- return;
69
- }
70
- // Materialize the fixture the extraction step expects: the repo
71
- // contains a subdirectory per package (pkg-a plus a sibling used
72
- // by the shared-clone counter test). Extraction only copies the
73
- // named subdir, so an unused one is harmless to single-package
74
- // tests.
75
- for (const name of [PKG_NAME, "pkg-b"]) {
76
- const pkgDir = path.join(dir, name);
77
- mkdirSync(pkgDir, { recursive: true });
78
- writeFileSync(
79
- path.join(pkgDir, "publisher.json"),
80
- JSON.stringify({ name }),
81
- );
82
- }
83
- // Drive the progress handler the way the real plugin would.
84
- lastFactoryOpts?.progress?.({
85
- method: "clone",
86
- stage: "receiving",
87
- progress: 50,
88
- processed: 1,
89
- total: 2,
90
- });
91
- cb(null);
92
- },
93
- };
94
- },
95
- }));
96
-
97
- mock.module("../storage/StorageManager", () => ({
98
- StorageManager: class MockStorageManager {
99
- async initialize(): Promise<void> {
100
- if (storageInitFails) {
101
- throw new Error(storageInitMessage);
102
- }
103
- }
104
- getRepository() {
105
- return {
106
- listEnvironments: async () => [],
107
- getEnvironmentByName: async () => null,
108
- createEnvironment: async (data: Record<string, unknown>) => ({
109
- id: "env-id",
110
- name: data.name,
111
- path: data.path,
112
- }),
113
- listPackages: async () => [],
114
- getPackageByName: async () => null,
115
- createPackage: async (data: Record<string, unknown>) => ({
116
- id: "pkg-id",
117
- name: data.name,
118
- }),
119
- listConnections: async () => [],
120
- };
121
- }
122
- },
123
- StorageConfig: {} as Record<string, unknown>,
124
- }));
125
-
126
- const { EnvironmentStore, GIT_CLONE_OPTIONS } = await import(
127
- "./environment_store"
128
- );
129
-
130
- describe("git clone wiring", () => {
131
- let stderrWrites: string[];
132
- let stderrSpy: ReturnType<typeof spyOn>;
133
-
134
- beforeEach(() => {
135
- rmSync(serverRootPath, { recursive: true, force: true });
136
- mkdirSync(serverRootPath, { recursive: true });
137
- recordedClones = [];
138
- lastFactoryOpts = null;
139
- storageInitFails = false;
140
- storageInitMessage = "storage init failed (test)";
141
- cloneFailure = null;
142
- stderrWrites = [];
143
- stderrSpy = spyOn(process.stderr, "write").mockImplementation(
144
- (chunk: string | Uint8Array) => {
145
- stderrWrites.push(String(chunk));
146
- return true;
147
- },
148
- );
149
- });
150
-
151
- afterEach(() => {
152
- stderrSpy.mockRestore();
153
- rmSync(serverRootPath, { recursive: true, force: true });
154
- });
155
-
156
- it("boot clones shallow, streams labeled progress, and mounts the package", async () => {
157
- writeFileSync(
158
- path.join(serverRootPath, "publisher.config.json"),
159
- JSON.stringify({
160
- frozenConfig: false,
161
- environments: [
162
- {
163
- name: ENV_NAME,
164
- packages: [
165
- {
166
- name: PKG_NAME,
167
- location: `https://github.com/example/repo/tree/main/${PKG_NAME}`,
168
- },
169
- ],
170
- connections: [],
171
- },
172
- ],
173
- }),
174
- );
175
-
176
- const infoSpy = spyOn(logger, "info");
177
- const store = new EnvironmentStore(serverRootPath);
178
- await store.finishedInitialization;
179
-
180
- // The options object reaches .clone verbatim.
181
- expect(recordedClones).toHaveLength(1);
182
- expect(recordedClones[0].repoUrl).toBe("https://github.com/example/repo");
183
- expect(recordedClones[0].opts).toEqual(GIT_CLONE_OPTIONS);
184
-
185
- // The extraction log carries the mounted-of-total counter.
186
- const infoMessages = infoSpy.mock.calls.map((c) => String(c[0]));
187
- infoSpy.mockRestore();
188
- expect(
189
- infoMessages.some(
190
- (m) =>
191
- m.includes('Extracted package "pkg-a"') && m.includes("(1/1)"),
192
- ),
193
- ).toBe(true);
194
-
195
- // The progress event surfaced on stderr, labeled with env and package.
196
- const output = stderrWrites.join("");
197
- expect(output).toContain(
198
- `[${ENV_NAME}] cloning example/repo (${PKG_NAME}): receiving 50% (1/2)`,
199
- );
200
-
201
- // The package extracted from the (fake) clone and mounted.
202
- expect(
203
- existsSync(
204
- path.join(
205
- serverRootPath,
206
- "publisher_data",
207
- ENV_NAME,
208
- PKG_NAME,
209
- "publisher.json",
210
- ),
211
- ),
212
- ).toBe(true);
213
-
214
- // And the boot announced itself exactly once.
215
- const readyLines = output
216
- .split("\n")
217
- .filter((line) => line.startsWith("PUBLISHER_READY"));
218
- expect(readyLines).toHaveLength(1);
219
- expect(readyLines[0]).toContain("environments=1");
220
- expect(readyLines[0]).toContain("packages=1");
221
- expect(readyLines[0]).toContain("load_errors=0");
222
- });
223
-
224
- it("the mounted-of-total counter accumulates across packages in a shared clone", async () => {
225
- // Two packages share one repo clone; the counter is one variable across
226
- // every mount branch, so a single (1/2)->(2/2) run pins that it advances
227
- // rather than reporting a constant.
228
- writeFileSync(
229
- path.join(serverRootPath, "publisher.config.json"),
230
- JSON.stringify({
231
- frozenConfig: false,
232
- environments: [
233
- {
234
- name: ENV_NAME,
235
- packages: [
236
- {
237
- name: PKG_NAME,
238
- location: `https://github.com/example/repo/tree/main/${PKG_NAME}`,
239
- },
240
- {
241
- name: "pkg-b",
242
- location: `https://github.com/example/repo/tree/main/pkg-b`,
243
- },
244
- ],
245
- connections: [],
246
- },
247
- ],
248
- }),
249
- );
250
-
251
- const infoSpy = spyOn(logger, "info");
252
- const store = new EnvironmentStore(serverRootPath);
253
- await store.finishedInitialization;
254
- const infoMessages = infoSpy.mock.calls.map((c) => String(c[0]));
255
- infoSpy.mockRestore();
256
-
257
- // One clone serves both, and the counter runs 1/2 then 2/2.
258
- expect(recordedClones).toHaveLength(1);
259
- const counters = infoMessages
260
- .filter((m) => m.startsWith("Extracted package"))
261
- .map((m) => m.slice(m.lastIndexOf("(")));
262
- expect(counters).toEqual(["(1/2)", "(2/2)"]);
263
- expect(stderrWrites.join("")).toContain("packages=2");
264
- });
265
-
266
- it("direct download extracts the subdirectory and labels by repo alone", async () => {
267
- // The controller add-package path: downloadGitHubDirectory is called
268
- // with the raw /tree/... location and no progress context.
269
- const store = new EnvironmentStore(serverRootPath);
270
- await store.finishedInitialization;
271
-
272
- const target = path.join(serverRootPath, "publisher_data", "direct");
273
- await store.downloadGitHubDirectory(
274
- `https://github.com/example/repo/tree/main/${PKG_NAME}`,
275
- target,
276
- );
277
-
278
- expect(recordedClones).toHaveLength(1);
279
- expect(recordedClones[0].opts).toEqual(GIT_CLONE_OPTIONS);
280
- // Subdirectory contents were hoisted to the target root.
281
- expect(existsSync(path.join(target, "publisher.json"))).toBe(true);
282
- expect(existsSync(path.join(target, PKG_NAME))).toBe(false);
283
- // No environment context on this path, so the label is the repo alone.
284
- expect(stderrWrites.join("")).toContain(
285
- "cloning example/repo: receiving 50% (1/2)",
286
- );
287
- });
288
-
289
- it("a failed clone rejects with the progress noise stripped", async () => {
290
- const store = new EnvironmentStore(serverRootPath);
291
- await store.finishedInitialization;
292
- cloneFailure = new Error(
293
- "Cloning into '/x'...\nReceiving objects: 50% (5/10)\nfatal: early EOF",
294
- );
295
-
296
- const target = path.join(serverRootPath, "publisher_data", "direct");
297
- let caught: Error | undefined;
298
- try {
299
- await store.downloadGitHubDirectory(
300
- "https://github.com/example/repo",
301
- target,
302
- );
303
- } catch (e) {
304
- caught = e as Error;
305
- }
306
- expect(caught).toBeDefined();
307
- // The message keeps what went wrong and drops the --progress spew;
308
- // the stack (which V8 seeds with the message, prefixed "Error: ") is
309
- // stripped too, including the prefixed "Cloning into" first line.
310
- expect(caught!.message).toBe("fatal: early EOF");
311
- expect(caught!.stack ?? "").not.toContain("Receiving objects");
312
- expect(caught!.stack ?? "").not.toContain("Cloning into");
313
- });
314
-
315
- it("prints the failure token instead of the readiness line when boot fails", async () => {
316
- storageInitFails = true;
317
- const store = new EnvironmentStore(serverRootPath);
318
- // initialize() swallows the failure by design; the promise resolves.
319
- await store.finishedInitialization;
320
- const output = stderrWrites.join("");
321
- expect(output.includes("PUBLISHER_READY")).toBe(false);
322
- // A script waiting on the ready token fails fast instead of hanging.
323
- const failLines = output
324
- .split("\n")
325
- .filter((line) => line.startsWith("PUBLISHER_INIT_FAILED"));
326
- expect(failLines).toHaveLength(1);
327
- expect(failLines[0]).toContain("storage init failed (test)");
328
- });
329
-
330
- it("redacts a pg password in the failure token", async () => {
331
- // The init error can carry a connection string; the INIT_FAILED token
332
- // must redact the keyword-form password before it reaches stderr.
333
- // (The adjacent winston init-error log shares the raw-message gap with
334
- // every other extractErrorDataFromError site; redacting those centrally
335
- // is a separate security follow-up, tracked in npx-fast-first-boot.md.)
336
- storageInitFails = true;
337
- storageInitMessage =
338
- "attach failed: host=db port=5432 password=supersecret dbname=x";
339
- const store = new EnvironmentStore(serverRootPath);
340
- await store.finishedInitialization;
341
-
342
- const failLine = stderrWrites
343
- .join("")
344
- .split("\n")
345
- .find((line) => line.startsWith("PUBLISHER_INIT_FAILED"));
346
- expect(failLine).toBeDefined();
347
- expect(failLine).toContain("password=***");
348
- expect(failLine).not.toContain("supersecret");
349
- });
350
- });