neon 3.0.0 → 3.1.0

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 (198) hide show
  1. package/README.md +54 -0
  2. package/dist/_shared/auth_selection.js +76 -79
  3. package/dist/_shared/credentials.js +166 -187
  4. package/dist/_shared/env-core/env.js +354 -517
  5. package/dist/_shared/env-core/reuse-secrets.js +159 -203
  6. package/dist/_shared/paths.js +129 -126
  7. package/dist/_shared/profiles.js +192 -242
  8. package/dist/_shared/secure_file.js +36 -38
  9. package/dist/_virtual/_rolldown/runtime.js +13 -0
  10. package/dist/analytics.js +163 -207
  11. package/dist/api.js +815 -758
  12. package/dist/auth.js +121 -141
  13. package/dist/auth_context.js +39 -53
  14. package/dist/cli.js +4 -7
  15. package/dist/commands/api.js +220 -250
  16. package/dist/commands/api_keys.js +251 -314
  17. package/dist/commands/auth.js +283 -328
  18. package/dist/commands/bootstrap.js +372 -437
  19. package/dist/commands/branches.js +304 -455
  20. package/dist/commands/bucket.js +374 -514
  21. package/dist/commands/checkout.js +213 -298
  22. package/dist/commands/config.js +573 -690
  23. package/dist/commands/connection_string.js +137 -165
  24. package/dist/commands/data_api.js +238 -260
  25. package/dist/commands/databases.js +67 -76
  26. package/dist/commands/deploy.js +31 -25
  27. package/dist/commands/dev.js +639 -719
  28. package/dist/commands/diff.js +156 -200
  29. package/dist/commands/env.js +243 -303
  30. package/dist/commands/functions.js +275 -355
  31. package/dist/commands/index.js +70 -65
  32. package/dist/commands/init.js +84 -119
  33. package/dist/commands/inspect.js +55 -55
  34. package/dist/commands/ip_allow.js +88 -120
  35. package/dist/commands/link.js +874 -1019
  36. package/dist/commands/logs.js +291 -0
  37. package/dist/commands/neon_auth.js +725 -933
  38. package/dist/commands/operations.js +34 -25
  39. package/dist/commands/orgs.js +28 -18
  40. package/dist/commands/profile.js +614 -845
  41. package/dist/commands/projects.js +313 -373
  42. package/dist/commands/psql.js +60 -58
  43. package/dist/commands/roles.js +55 -58
  44. package/dist/commands/schema_diff.js +87 -131
  45. package/dist/commands/set_context.js +34 -26
  46. package/dist/commands/snapshots.js +288 -413
  47. package/dist/commands/status.js +41 -37
  48. package/dist/commands/user.js +21 -10
  49. package/dist/commands/vpc_endpoints.js +85 -113
  50. package/dist/config.js +7 -6
  51. package/dist/config_format.js +50 -66
  52. package/dist/config_template.js +128 -157
  53. package/dist/context.js +183 -235
  54. package/dist/current_branch_fast_path.js +40 -49
  55. package/dist/dev/env.js +313 -394
  56. package/dist/dev/functions.js +54 -68
  57. package/dist/dev/inputs.js +46 -58
  58. package/dist/dev/runtime.js +135 -164
  59. package/dist/dev/websocket.js +766 -959
  60. package/dist/env.js +27 -33
  61. package/dist/env_file.js +118 -132
  62. package/dist/env_services.js +36 -38
  63. package/dist/errors.js +57 -68
  64. package/dist/functions_api.js +45 -43
  65. package/dist/help.js +189 -140
  66. package/dist/index.js +182 -257
  67. package/dist/init/agents.js +137 -118
  68. package/dist/init/auth.js +58 -68
  69. package/dist/init/bootstrap.js +325 -396
  70. package/dist/init/build_config.js +4 -2
  71. package/dist/init/detect_agent.js +56 -101
  72. package/dist/init/editors.js +35 -52
  73. package/dist/init/enrich_output.js +51 -66
  74. package/dist/init/extension.js +134 -171
  75. package/dist/init/inspect.js +179 -266
  76. package/dist/init/interactive.js +510 -622
  77. package/dist/init/neonctl.js +117 -168
  78. package/dist/init/orchestrate.js +157 -173
  79. package/dist/init/phases/auth.js +188 -202
  80. package/dist/init/phases/cleanup.js +23 -23
  81. package/dist/init/phases/db.js +251 -277
  82. package/dist/init/phases/getting_started.js +213 -223
  83. package/dist/init/phases/mcp.js +174 -224
  84. package/dist/init/phases/migrations.js +247 -248
  85. package/dist/init/phases/neon_auth.js +114 -133
  86. package/dist/init/phases/setup.js +546 -703
  87. package/dist/init/phases/skills.js +75 -86
  88. package/dist/init/phases/status.js +72 -67
  89. package/dist/init/resolve_context.js +102 -99
  90. package/dist/init/route_command.js +91 -98
  91. package/dist/init/skills.js +174 -218
  92. package/dist/init/vsix.js +77 -99
  93. package/dist/log.js +17 -16
  94. package/dist/neon_services.js +104 -129
  95. package/dist/parameters.gen.js +481 -471
  96. package/dist/pkg.js +17 -19
  97. package/dist/profile_keys.js +44 -47
  98. package/dist/psql/cli.js +44 -47
  99. package/dist/psql/command/cmd_cond.js +231 -406
  100. package/dist/psql/command/cmd_connect.js +557 -764
  101. package/dist/psql/command/cmd_copy.js +727 -983
  102. package/dist/psql/command/cmd_describe.js +1499 -1688
  103. package/dist/psql/command/cmd_format.js +733 -905
  104. package/dist/psql/command/cmd_io.js +1293 -2082
  105. package/dist/psql/command/cmd_lo.js +297 -359
  106. package/dist/psql/command/cmd_meta.js +727 -878
  107. package/dist/psql/command/cmd_misc.js +138 -172
  108. package/dist/psql/command/cmd_pipeline.js +547 -1099
  109. package/dist/psql/command/cmd_restrict.js +119 -155
  110. package/dist/psql/command/cmd_show.js +529 -688
  111. package/dist/psql/command/dispatch.js +261 -325
  112. package/dist/psql/command/inputQueue.js +35 -33
  113. package/dist/psql/command/shared.js +49 -63
  114. package/dist/psql/complete/filenames.js +90 -133
  115. package/dist/psql/complete/index.js +59 -97
  116. package/dist/psql/complete/matcher.js +236 -300
  117. package/dist/psql/complete/psqlVars.js +218 -223
  118. package/dist/psql/complete/queries.js +159 -177
  119. package/dist/psql/complete/rules.js +1493 -2299
  120. package/dist/psql/core/common.js +762 -1180
  121. package/dist/psql/core/help.js +456 -546
  122. package/dist/psql/core/mainloop.js +692 -1302
  123. package/dist/psql/core/prompt.js +391 -408
  124. package/dist/psql/core/settings.js +429 -644
  125. package/dist/psql/core/sqlHelp.js +480 -554
  126. package/dist/psql/core/startup.js +626 -815
  127. package/dist/psql/core/syncVars.js +67 -110
  128. package/dist/psql/core/variables.js +156 -278
  129. package/dist/psql/describe/formatters.js +884 -1285
  130. package/dist/psql/describe/processNamePattern.js +173 -260
  131. package/dist/psql/describe/queries.js +1368 -2403
  132. package/dist/psql/describe/versionGate.js +32 -41
  133. package/dist/psql/index.js +1414 -1927
  134. package/dist/psql/io/history.js +232 -271
  135. package/dist/psql/io/input.js +103 -108
  136. package/dist/psql/io/lineEditor/buffer.js +238 -319
  137. package/dist/psql/io/lineEditor/complete.js +135 -213
  138. package/dist/psql/io/lineEditor/filename.js +139 -148
  139. package/dist/psql/io/lineEditor/index.js +653 -870
  140. package/dist/psql/io/lineEditor/keymap.js +544 -702
  141. package/dist/psql/io/lineEditor/vt100.js +294 -341
  142. package/dist/psql/io/pgpass.js +158 -187
  143. package/dist/psql/io/pgservice.js +146 -183
  144. package/dist/psql/io/psqlrc.js +328 -403
  145. package/dist/psql/print/aligned.js +1020 -1683
  146. package/dist/psql/print/asciidoc.js +180 -214
  147. package/dist/psql/print/crosstab.js +281 -442
  148. package/dist/psql/print/csv.js +48 -70
  149. package/dist/psql/print/html.js +195 -226
  150. package/dist/psql/print/json.js +75 -88
  151. package/dist/psql/print/latex.js +291 -364
  152. package/dist/psql/print/pager.js +171 -242
  153. package/dist/psql/print/troff.js +194 -226
  154. package/dist/psql/print/unaligned.js +69 -95
  155. package/dist/psql/print/units.js +167 -169
  156. package/dist/psql/scanner/slash.js +428 -483
  157. package/dist/psql/scanner/sql.js +445 -889
  158. package/dist/psql/scanner/stringutils.js +309 -379
  159. package/dist/psql/types/index.js +2 -7
  160. package/dist/psql/types/scanner.js +25 -22
  161. package/dist/psql/wire/connection.js +2042 -2803
  162. package/dist/psql/wire/copy.js +84 -100
  163. package/dist/psql/wire/notify.js +39 -59
  164. package/dist/psql/wire/pipeline.js +305 -518
  165. package/dist/psql/wire/protocol.js +349 -417
  166. package/dist/psql/wire/sasl.js +180 -265
  167. package/dist/psql/wire/tls.js +400 -561
  168. package/dist/storage_api.js +115 -129
  169. package/dist/test_utils/fixtures.js +94 -113
  170. package/dist/test_utils/oauth_server.js +10 -7
  171. package/dist/test_utils/project_dir.js +33 -0
  172. package/dist/utils/ai_gateway_notice.js +131 -162
  173. package/dist/utils/api_enums.js +21 -28
  174. package/dist/utils/auth.js +10 -4
  175. package/dist/utils/branch_notice.js +20 -19
  176. package/dist/utils/branch_picker.js +83 -89
  177. package/dist/utils/cli_name.js +15 -12
  178. package/dist/utils/compute_units.js +20 -27
  179. package/dist/utils/config_diff.js +127 -158
  180. package/dist/utils/enrichers.js +95 -148
  181. package/dist/utils/esbuild.js +130 -189
  182. package/dist/utils/flags.js +35 -47
  183. package/dist/utils/formats.js +8 -15
  184. package/dist/utils/git_diff.js +69 -80
  185. package/dist/utils/inspect_db.js +101 -143
  186. package/dist/utils/inspect_queries.js +179 -142
  187. package/dist/utils/middlewares.js +37 -44
  188. package/dist/utils/openapi.js +87 -99
  189. package/dist/utils/package_manager.js +312 -110
  190. package/dist/utils/point_in_time.js +49 -53
  191. package/dist/utils/psql.js +89 -106
  192. package/dist/utils/service_picker.js +55 -58
  193. package/dist/utils/string.js +5 -5
  194. package/dist/utils/ui.js +38 -55
  195. package/dist/utils/write_sync.js +26 -35
  196. package/dist/utils/zip.js +4 -3
  197. package/dist/writer.js +67 -87
  198. package/package.json +7 -5
@@ -1,77 +1,63 @@
1
1
  import { existsSync } from "node:fs";
2
2
  import { dirname, isAbsolute, resolve } from "node:path";
3
- import { loadConfigFromFile, resolveConfig, } from "@neon/config";
3
+ import { loadConfigFromFile, resolveConfig } from "@neon/config";
4
+ //#region src/dev/functions.ts
4
5
  /**
5
- * Load `neon.ts` (if any) and resolve the list of functions it declares into
6
- * {@link PlannedFunction}s for `neon dev` to serve. Returns `null` when there is no
7
- * `neon.ts` on the path from `cwd` up to the repo root — the caller turns that into a
8
- * "no --source and no neon.ts" error.
9
- *
10
- * `branchName` is used only to evaluate a policy that switches on `branch.name`; the
11
- * function list is otherwise branch-independent, so a placeholder is fine when unknown.
12
- */
13
- export const resolveFunctionsFromConfig = async (cwd, branchName) => {
14
- const loaded = await loadNeonConfig(cwd);
15
- if (!loaded)
16
- return null;
17
- const { config, configDir, configPath } = loaded;
18
- const resolved = resolveConfig(config, {
19
- name: branchName ?? "local",
20
- exists: branchName !== undefined,
21
- });
22
- const functions = resolved.preview?.functions ?? [];
23
- const planned = functions.map((fn) => {
24
- const source = isAbsolute(fn.source)
25
- ? fn.source
26
- : resolve(configDir, fn.source);
27
- if (!existsSync(source)) {
28
- throw new Error(`Function "${fn.slug}" points at a source that does not exist: ${source} ` +
29
- `(from neon.ts "${fn.source}"). Fix the source path and re-run.`);
30
- }
31
- return {
32
- slug: fn.slug,
33
- name: fn.name,
34
- source,
35
- ...(devPort(fn.dev) !== undefined
36
- ? { port: devPort(fn.dev) }
37
- : {}),
38
- env: { ...fn.env },
39
- // Names only: locally every entry is simply left unbundled, and `includeFiles`
40
- // governs the deployed archive, which `neon dev` does not build.
41
- ...(fn.externalPackages
42
- ? {
43
- externalPackages: fn.externalPackages.map((pkg) => pkg.name),
44
- }
45
- : {}),
46
- };
47
- });
48
- return { configPath, functions: planned };
6
+ * Load `neon.ts` (if any) and resolve the list of functions it declares into
7
+ * {@link PlannedFunction}s for `neon dev` to serve. Returns `null` when there is no
8
+ * `neon.ts` on the path from `cwd` up to the repo root — the caller turns that into a
9
+ * "no --source and no neon.ts" error.
10
+ *
11
+ * `branchName` is used only to evaluate a policy that switches on `branch.name`; the
12
+ * function list is otherwise branch-independent, so a placeholder is fine when unknown.
13
+ */
14
+ const resolveFunctionsFromConfig = async (cwd, branchName) => {
15
+ const loaded = await loadNeonConfig(cwd);
16
+ if (!loaded) return null;
17
+ const { config, configDir, configPath } = loaded;
18
+ return {
19
+ configPath,
20
+ functions: (resolveConfig(config, {
21
+ name: branchName ?? "local",
22
+ exists: branchName !== void 0
23
+ }).preview?.functions ?? []).map((fn) => {
24
+ const source = isAbsolute(fn.source) ? fn.source : resolve(configDir, fn.source);
25
+ if (!existsSync(source)) throw new Error(`Function "${fn.slug}" points at a source that does not exist: ${source} (from neon.ts "${fn.source}"). Fix the source path and re-run.`);
26
+ return {
27
+ slug: fn.slug,
28
+ name: fn.name,
29
+ source,
30
+ ...devPort(fn.dev) !== void 0 ? { port: devPort(fn.dev) } : {},
31
+ env: { ...fn.env },
32
+ ...fn.externalPackages ? { externalPackages: fn.externalPackages.map((pkg) => pkg.name) } : {}
33
+ };
34
+ })
35
+ };
49
36
  };
50
37
  /**
51
- * Read the `port` off a {@link FunctionDevConfig}. `undefined` when no `dev.port` is set
52
- * (the supervisor then searches for a free port).
53
- */
38
+ * Read the `port` off a {@link FunctionDevConfig}. `undefined` when no `dev.port` is set
39
+ * (the supervisor then searches for a free port).
40
+ */
54
41
  const devPort = (dev) => dev?.port;
55
42
  /**
56
- * Load a `neon.ts` policy if one exists, returning the loaded config, the resolved path to
57
- * the config file (used by the dev server to watch it), and the directory it lives in (used
58
- * to resolve each function's relative `source`). Returns `null` when no config file is
59
- * found; surfaces real load errors (e.g. a syntax error).
60
- */
43
+ * Load a `neon.ts` policy if one exists, returning the loaded config, the resolved path to
44
+ * the config file (used by the dev server to watch it), and the directory it lives in (used
45
+ * to resolve each function's relative `source`). Returns `null` when no config file is
46
+ * found; surfaces real load errors (e.g. a syntax error).
47
+ */
61
48
  const loadNeonConfig = async (cwd) => {
62
- try {
63
- const { config, resolvedPath } = await loadConfigFromFile({ cwd });
64
- return {
65
- config,
66
- configDir: dirname(resolvedPath),
67
- configPath: resolvedPath,
68
- };
69
- }
70
- catch (err) {
71
- const message = err instanceof Error ? err.message : String(err);
72
- if (/Could not find a Neon config file/i.test(message)) {
73
- return null;
74
- }
75
- throw err;
76
- }
49
+ try {
50
+ const { config, resolvedPath } = await loadConfigFromFile({ cwd });
51
+ return {
52
+ config,
53
+ configDir: dirname(resolvedPath),
54
+ configPath: resolvedPath
55
+ };
56
+ } catch (err) {
57
+ const message = err instanceof Error ? err.message : String(err);
58
+ if (/Could not find a Neon config file/i.test(message)) return null;
59
+ throw err;
60
+ }
77
61
  };
62
+ //#endregion
63
+ export { resolveFunctionsFromConfig };
@@ -1,63 +1,51 @@
1
1
  import { resolve } from "node:path";
2
+ //#region src/dev/inputs.ts
2
3
  const defaultDeps = {
3
- isPackaged: () => process.pkg !== undefined,
4
- loadEsbuild: (name) => import(name),
4
+ isPackaged: () => process.pkg !== void 0,
5
+ loadEsbuild: (name) => import(name)
5
6
  };
6
7
  /**
7
- * Resolve the exact set of files esbuild reads to produce the bundle for
8
- * `source` — the entry plus every local module it imports (npm deps are left
9
- * external, so they never appear). These are the files the dev watcher should
10
- * watch, so a single edit triggers exactly one rebuild.
11
- *
12
- * Returns absolute paths, or `null` when the precise set cannot be computed —
13
- * either inside the packaged binary (which cannot import esbuild as a module;
14
- * it shells out to a binary that has no JSON-metafile equivalent here) or on a
15
- * platform where the esbuild module won't load. Callers fall back to a coarser
16
- * watch in that case.
17
- *
18
- * This performs a metafile-only pass (`write:false`, `metafile:true`) so it
19
- * never emits output; the actual bundle bytes still come from `bundleEntry`.
20
- */
21
- export const resolveWatchInputs = async (source, deps = defaultDeps) => {
22
- if (deps.isPackaged())
23
- return null;
24
- // esbuild is resolved by a COMPUTED specifier, never the literal string
25
- // 'esbuild', for the same reason as src/utils/esbuild.ts: rollup and
26
- // @yao-pkg/pkg statically scan for literal import()/require() and would pull
27
- // esbuild's native Go binary into the bundle/snapshot. Keep it invisible.
28
- const name = ["es", "build"].join("");
29
- let esbuild;
30
- try {
31
- esbuild = await deps.loadEsbuild(name);
32
- }
33
- catch {
34
- return null;
35
- }
36
- let metafile;
37
- try {
38
- // Mirrors bundleEntry's flags so the resolved input graph matches the real
39
- // bundle. metafile:true + write:false makes this a pure analysis pass.
40
- const result = await esbuild.build({
41
- entryPoints: [source],
42
- bundle: true,
43
- write: false,
44
- metafile: true,
45
- format: "esm",
46
- platform: "node",
47
- packages: "external",
48
- logLevel: "silent",
49
- });
50
- metafile = result.metafile;
51
- }
52
- catch {
53
- // A bundle error here is non-fatal for watching: bundleEntry surfaces the
54
- // real diagnostic. Fall back to the coarser watch so edits still rebuild.
55
- return null;
56
- }
57
- const inputs = metafile?.inputs;
58
- if (!inputs)
59
- return null;
60
- // metafile input keys are paths relative to esbuild's cwd; resolve to absolute
61
- // so they compare cleanly against chokidar's watched paths.
62
- return Object.keys(inputs).map((p) => resolve(process.cwd(), p));
8
+ * Resolve the exact set of files esbuild reads to produce the bundle for
9
+ * `source` — the entry plus every local module it imports (npm deps are left
10
+ * external, so they never appear). These are the files the dev watcher should
11
+ * watch, so a single edit triggers exactly one rebuild.
12
+ *
13
+ * Returns absolute paths, or `null` when the precise set cannot be computed —
14
+ * either inside the packaged binary (which cannot import esbuild as a module;
15
+ * it shells out to a binary that has no JSON-metafile equivalent here) or on a
16
+ * platform where the esbuild module won't load. Callers fall back to a coarser
17
+ * watch in that case.
18
+ *
19
+ * This performs a metafile-only pass (`write:false`, `metafile:true`) so it
20
+ * never emits output; the actual bundle bytes still come from `bundleEntry`.
21
+ */
22
+ const resolveWatchInputs = async (source, deps = defaultDeps) => {
23
+ if (deps.isPackaged()) return null;
24
+ const name = ["es", "build"].join("");
25
+ let esbuild;
26
+ try {
27
+ esbuild = await deps.loadEsbuild(name);
28
+ } catch {
29
+ return null;
30
+ }
31
+ let metafile;
32
+ try {
33
+ metafile = (await esbuild.build({
34
+ entryPoints: [source],
35
+ bundle: true,
36
+ write: false,
37
+ metafile: true,
38
+ format: "esm",
39
+ platform: "node",
40
+ packages: "external",
41
+ logLevel: "silent"
42
+ })).metafile;
43
+ } catch {
44
+ return null;
45
+ }
46
+ const inputs = metafile?.inputs;
47
+ if (!inputs) return null;
48
+ return Object.keys(inputs).map((p) => resolve(process.cwd(), p));
63
49
  };
50
+ //#endregion
51
+ export { resolveWatchInputs };
@@ -1,190 +1,161 @@
1
- import { createServer } from "node:http";
1
+ import { createUpgradeListener, installWebSocketBridge } from "./websocket.js";
2
2
  import { resolve } from "node:path";
3
3
  import { pathToFileURL } from "node:url";
4
+ import { createServer } from "node:http";
4
5
  import { getRequestListener } from "@hono/node-server";
5
- import { createUpgradeListener, installWebSocketBridge, } from "./websocket.js";
6
+ //#region src/dev/runtime.ts
6
7
  const isFunction = (value) => typeof value === "function";
7
- const hasFetchMethod = (value) => typeof value === "object" &&
8
- value !== null &&
9
- "fetch" in value &&
10
- typeof value.fetch === "function";
8
+ const hasFetchMethod = (value) => typeof value === "object" && value !== null && "fetch" in value && typeof value.fetch === "function";
11
9
  /**
12
- * Resolve the user's exported handler to a single fetch callback.
13
- *
14
- * Resolution order (first match wins):
15
- * 1. `export default { fetch }` — Workers / Neon Functions style
16
- * 2. `export default function (req)` — bare (async) default function
17
- */
18
- export const resolveFetchHandler = (mod) => {
19
- const defaultExport = mod.default;
20
- if (hasFetchMethod(defaultExport)) {
21
- const target = defaultExport;
22
- return (req) => target.fetch(req);
23
- }
24
- if (isFunction(defaultExport)) {
25
- return defaultExport;
26
- }
27
- throw new Error("No request handler found in the source module. Export one of:\n" +
28
- " export default { fetch(req) { /* ... */ } }\n" +
29
- " export default function (req) { /* ... */ }");
10
+ * Resolve the user's exported handler to a single fetch callback.
11
+ *
12
+ * Resolution order (first match wins):
13
+ * 1. `export default { fetch }` — Workers / Neon Functions style
14
+ * 2. `export default function (req)` — bare (async) default function
15
+ */
16
+ const resolveFetchHandler = (mod) => {
17
+ const defaultExport = mod.default;
18
+ if (hasFetchMethod(defaultExport)) {
19
+ const target = defaultExport;
20
+ return (req) => target.fetch(req);
21
+ }
22
+ if (isFunction(defaultExport)) return defaultExport;
23
+ throw new Error("No request handler found in the source module. Export one of:\n export default { fetch(req) { /* ... */ } }\n export default function (req) { /* ... */ }");
30
24
  };
31
- const hasUpgradeMethod = (value) => typeof value === "object" &&
32
- value !== null &&
33
- "upgrade" in value &&
34
- typeof value.upgrade === "function";
25
+ const hasUpgradeMethod = (value) => typeof value === "object" && value !== null && "upgrade" in value && typeof value.upgrade === "function";
35
26
  /**
36
- * Resolve the user's optional WebSocket entrypoint: a named `export function upgrade`,
37
- * or an `upgrade` method on the default export. `undefined` when the module has
38
- * neither, which is the common case — a function without one either uses
39
- * `upgradeWebSocket()` inside `fetch` or serves no WebSockets at all.
40
- *
41
- * Resolution order matches the deployed runtime exactly (named export first, then the
42
- * default-export method), so a module that resolves one way locally cannot resolve the
43
- * other way once deployed.
44
- */
45
- export const resolveUpgradeHandler = (mod) => {
46
- if (typeof mod.upgrade === "function")
47
- return mod.upgrade;
48
- const defaultExport = mod.default;
49
- if (hasUpgradeMethod(defaultExport)) {
50
- const target = defaultExport;
51
- return (req, socket, head) => target.upgrade(req, socket, head);
52
- }
53
- return undefined;
27
+ * Resolve the user's optional WebSocket entrypoint: a named `export function upgrade`,
28
+ * or an `upgrade` method on the default export. `undefined` when the module has
29
+ * neither, which is the common case — a function without one either uses
30
+ * `upgradeWebSocket()` inside `fetch` or serves no WebSockets at all.
31
+ *
32
+ * Resolution order matches the deployed runtime exactly (named export first, then the
33
+ * default-export method), so a module that resolves one way locally cannot resolve the
34
+ * other way once deployed.
35
+ */
36
+ const resolveUpgradeHandler = (mod) => {
37
+ if (typeof mod.upgrade === "function") return mod.upgrade;
38
+ const defaultExport = mod.default;
39
+ if (hasUpgradeMethod(defaultExport)) {
40
+ const target = defaultExport;
41
+ return (req, socket, head) => target.upgrade(req, socket, head);
42
+ }
54
43
  };
55
44
  /**
56
- * Wrap a fetch handler so user errors become a 500 response (with the message
57
- * in the body during dev) instead of crashing the child process.
58
- */
59
- export const withErrorBoundary = (handler) => {
60
- return async (req) => {
61
- try {
62
- return await handler(req);
63
- }
64
- catch (err) {
65
- const message = err instanceof Error ? (err.stack ?? err.message) : String(err);
66
- process.stderr.write(`Request handler threw an error:\n${message}\n`);
67
- return new Response(`Internal Server Error\n\n${message}`, {
68
- status: 500,
69
- headers: { "content-type": "text/plain; charset=utf-8" },
70
- });
71
- }
72
- };
45
+ * Wrap a fetch handler so user errors become a 500 response (with the message
46
+ * in the body during dev) instead of crashing the child process.
47
+ */
48
+ const withErrorBoundary = (handler) => {
49
+ return async (req) => {
50
+ try {
51
+ return await handler(req);
52
+ } catch (err) {
53
+ const message = err instanceof Error ? err.stack ?? err.message : String(err);
54
+ process.stderr.write(`Request handler threw an error:\n${message}\n`);
55
+ return new Response(`Internal Server Error\n\n${message}`, {
56
+ status: 500,
57
+ headers: { "content-type": "text/plain; charset=utf-8" }
58
+ });
59
+ }
60
+ };
73
61
  };
74
- const isAddressInUse = (err) => typeof err === "object" &&
75
- err !== null &&
76
- err.code === "EADDRINUSE";
62
+ const isAddressInUse = (err) => typeof err === "object" && err !== null && err.code === "EADDRINUSE";
77
63
  const DEFAULT_SEARCH_BASE = 8787;
78
64
  const MAX_SEARCH_STEPS = 100;
79
65
  const bindPort = async (server, selection, hostname) => {
80
- if (selection.mode === "explicit") {
81
- return listen(server, selection.port, hostname);
82
- }
83
- for (let step = 0; step < MAX_SEARCH_STEPS; step++) {
84
- try {
85
- return await listen(server, selection.from + step, hostname);
86
- }
87
- catch (err) {
88
- if (!isAddressInUse(err))
89
- throw err;
90
- }
91
- }
92
- throw new Error(`Could not find a free port in ${selection.from}-${selection.from + MAX_SEARCH_STEPS - 1}`);
66
+ if (selection.mode === "explicit") return listen(server, selection.port, hostname);
67
+ for (let step = 0; step < MAX_SEARCH_STEPS; step++) try {
68
+ return await listen(server, selection.from + step, hostname);
69
+ } catch (err) {
70
+ if (!isAddressInUse(err)) throw err;
71
+ }
72
+ throw new Error(`Could not find a free port in ${selection.from}-${selection.from + MAX_SEARCH_STEPS - 1}`);
93
73
  };
94
74
  const listen = (server, port, hostname) => new Promise((resolveListen, rejectListen) => {
95
- const onError = (err) => {
96
- server.off("listening", onListening);
97
- rejectListen(err);
98
- };
99
- const onListening = () => {
100
- server.off("error", onError);
101
- resolveListen(server.address().port);
102
- };
103
- server.once("error", onError);
104
- server.once("listening", onListening);
105
- server.listen(port, hostname);
75
+ const onError = (err) => {
76
+ server.off("listening", onListening);
77
+ rejectListen(err);
78
+ };
79
+ const onListening = () => {
80
+ server.off("error", onError);
81
+ resolveListen(server.address().port);
82
+ };
83
+ server.once("error", onError);
84
+ server.once("listening", onListening);
85
+ server.listen(port, hostname);
106
86
  });
107
87
  /**
108
- * Load the (already-bundled) user module, build the listener, and start an HTTP
109
- * server. Announces the bound port on stdout as `neon-dev:ready <port>` so the
110
- * parent can render the URL. Resolves with the bound port.
111
- */
112
- export const startRuntime = async ({ source, port, hostname, }) => {
113
- const absoluteSource = resolve(process.cwd(), source);
114
- const mod = (await import(pathToFileURL(absoluteSource).href));
115
- const fetchHandler = resolveFetchHandler(mod);
116
- const handler = withErrorBoundary(fetchHandler);
117
- // Publish the bridge `upgradeWebSocket()` reads before the user module can serve a
118
- // request, so the helper resolves locally exactly as it does when deployed.
119
- installWebSocketBridge();
120
- const listener = getRequestListener(handler, { hostname });
121
- const server = createServer((incoming, outgoing) => {
122
- void listener(incoming, outgoing);
123
- });
124
- // Node emits 'upgrade' rather than 'request' for a WebSocket handshake. Without
125
- // this listener Node hands the handshake to the ordinary request handler, which
126
- // answers 200 on a connection the client expects to be a 101 — so a function's
127
- // WebSocket code silently never ran under `neon dev`.
128
- //
129
- // The upgrade path takes the RAW handler, not the error-boundary-wrapped one. The
130
- // boundary turns a throw into a 500 Response, which on this path is
131
- // indistinguishable from a handler that deliberately declined the upgrade — so a
132
- // crashing handler would answer 501 ("no WebSocket support") instead of surfacing
133
- // the error. The upgrade listener has its own equivalent boundary, and reports a
134
- // throw as the 502 the deployed runtime returns.
135
- server.on("upgrade", createUpgradeListener({
136
- fetch: fetchHandler,
137
- upgrade: resolveUpgradeHandler(mod),
138
- }));
139
- const boundPort = await bindPort(server, port, hostname);
140
- process.stdout.write(`neon-dev:ready ${boundPort}\n`);
141
- return boundPort;
88
+ * Load the (already-bundled) user module, build the listener, and start an HTTP
89
+ * server. Announces the bound port on stdout as `neon-dev:ready <port>` so the
90
+ * parent can render the URL. Resolves with the bound port.
91
+ */
92
+ const startRuntime = async ({ source, port, hostname }) => {
93
+ const absoluteSource = resolve(process.cwd(), source);
94
+ const mod = await import(pathToFileURL(absoluteSource).href);
95
+ const fetchHandler = resolveFetchHandler(mod);
96
+ const handler = withErrorBoundary(fetchHandler);
97
+ installWebSocketBridge();
98
+ const listener = getRequestListener(handler, { hostname });
99
+ const server = createServer((incoming, outgoing) => {
100
+ listener(incoming, outgoing);
101
+ });
102
+ server.on("upgrade", createUpgradeListener({
103
+ fetch: fetchHandler,
104
+ upgrade: resolveUpgradeHandler(mod)
105
+ }));
106
+ const boundPort = await bindPort(server, port, hostname);
107
+ process.stdout.write(`neon-dev:ready ${boundPort}\n`);
108
+ return boundPort;
142
109
  };
143
110
  /**
144
- * Build a {@link PortSelection} from the environment. Precedence:
145
- * 1. `NEON_DEV_PORT` -> explicit bind (crash if taken). Set by `neon dev` from an
146
- * explicit `--port` / `dev.port`.
147
- * 2. `PORT` -> explicit bind. A bare `PORT=3000 neon dev` sets this, so the
148
- * runtime binds the port chosen for it.
149
- * 3. otherwise -> search upward from `NEON_DEV_PORT_BASE` (or the default base).
150
- */
151
- export const portSelectionFromEnv = (env) => {
152
- const explicit = env.NEON_DEV_PORT;
153
- if (explicit !== undefined && explicit !== "") {
154
- return { mode: "explicit", port: parsePort(explicit, "NEON_DEV_PORT") };
155
- }
156
- const injected = env.PORT;
157
- if (injected !== undefined && injected !== "") {
158
- return { mode: "explicit", port: parsePort(injected, "PORT") };
159
- }
160
- const base = Number(env.NEON_DEV_PORT_BASE ?? DEFAULT_SEARCH_BASE);
161
- return {
162
- mode: "search",
163
- from: Number.isInteger(base) ? base : DEFAULT_SEARCH_BASE,
164
- };
111
+ * Build a {@link PortSelection} from the environment. Precedence:
112
+ * 1. `NEON_DEV_PORT` -> explicit bind (crash if taken). Set by `neon dev` from an
113
+ * explicit `--port` / `dev.port`.
114
+ * 2. `PORT` -> explicit bind. A bare `PORT=3000 neon dev` sets this, so the
115
+ * runtime binds the port chosen for it.
116
+ * 3. otherwise -> search upward from `NEON_DEV_PORT_BASE` (or the default base).
117
+ */
118
+ const portSelectionFromEnv = (env) => {
119
+ const explicit = env.NEON_DEV_PORT;
120
+ if (explicit !== void 0 && explicit !== "") return {
121
+ mode: "explicit",
122
+ port: parsePort(explicit, "NEON_DEV_PORT")
123
+ };
124
+ const injected = env.PORT;
125
+ if (injected !== void 0 && injected !== "") return {
126
+ mode: "explicit",
127
+ port: parsePort(injected, "PORT")
128
+ };
129
+ const base = Number(env.NEON_DEV_PORT_BASE ?? DEFAULT_SEARCH_BASE);
130
+ return {
131
+ mode: "search",
132
+ from: Number.isInteger(base) ? base : DEFAULT_SEARCH_BASE
133
+ };
165
134
  };
166
135
  const parsePort = (value, varName) => {
167
- const port = Number(value);
168
- if (!Number.isInteger(port) || port < 0 || port > 65535) {
169
- throw new Error(`Invalid ${varName}: "${value}"`);
170
- }
171
- return port;
136
+ const port = Number(value);
137
+ if (!Number.isInteger(port) || port < 0 || port > 65535) throw new Error(`Invalid ${varName}: "${value}"`);
138
+ return port;
172
139
  };
173
140
  const isDirectExecution = () => {
174
- const entry = process.argv[1];
175
- if (!entry)
176
- return false;
177
- return import.meta.url === pathToFileURL(entry).href;
141
+ const entry = process.argv[1];
142
+ if (!entry) return false;
143
+ return import.meta.url === pathToFileURL(entry).href;
178
144
  };
179
145
  if (isDirectExecution()) {
180
- const source = process.env.NEON_DEV_SOURCE ?? process.argv[2];
181
- if (!source) {
182
- process.stderr.write("neon-dev runtime: missing source path\n");
183
- process.exit(1);
184
- }
185
- startRuntime({ source, port: portSelectionFromEnv(process.env) }).catch((err) => {
186
- const msg = err instanceof Error ? err.message : String(err);
187
- process.stderr.write(`neon-dev runtime failed to start: ${msg}\n`);
188
- process.exit(1);
189
- });
146
+ const source = process.env.NEON_DEV_SOURCE ?? process.argv[2];
147
+ if (!source) {
148
+ process.stderr.write("neon-dev runtime: missing source path\n");
149
+ process.exit(1);
150
+ }
151
+ startRuntime({
152
+ source,
153
+ port: portSelectionFromEnv(process.env)
154
+ }).catch((err) => {
155
+ const msg = err instanceof Error ? err.message : String(err);
156
+ process.stderr.write(`neon-dev runtime failed to start: ${msg}\n`);
157
+ process.exit(1);
158
+ });
190
159
  }
160
+ //#endregion
161
+ export { portSelectionFromEnv, resolveFetchHandler, resolveUpgradeHandler, startRuntime, withErrorBoundary };