wrangler 0.0.0-e9307365 → 0.0.0-e94b46ff7

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 (199) hide show
  1. package/README.md +35 -49
  2. package/bin/wrangler.js +25 -100
  3. package/config-schema.json +2277 -0
  4. package/package.json +182 -172
  5. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  6. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  7. package/templates/__tests__/tsconfig.json +8 -0
  8. package/templates/checked-fetch.js +19 -6
  9. package/templates/facade.d.ts +19 -0
  10. package/templates/gitignore +2 -3
  11. package/templates/init-tests/test-jest-new-worker.js +23 -0
  12. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +67 -0
  15. package/templates/middleware/loader-modules.ts +134 -0
  16. package/templates/middleware/loader-sw.ts +229 -0
  17. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  18. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  19. package/templates/middleware/middleware-mock-analytics-engine.d.ts +3 -0
  20. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  21. package/templates/middleware/middleware-patch-console-prefix.d.ts +3 -0
  22. package/templates/middleware/middleware-patch-console-prefix.ts +21 -0
  23. package/templates/middleware/middleware-pretty-error.ts +40 -0
  24. package/templates/middleware/middleware-scheduled.ts +29 -0
  25. package/templates/modules-watch-stub.js +4 -0
  26. package/templates/new-worker-scheduled.ts +1 -1
  27. package/templates/new-worker.js +1 -1
  28. package/templates/new-worker.ts +4 -1
  29. package/templates/pages-dev-pipeline.ts +33 -0
  30. package/templates/pages-dev-util.ts +55 -0
  31. package/templates/pages-shim.ts +1 -1
  32. package/templates/pages-template-plugin.ts +53 -18
  33. package/templates/pages-template-worker.ts +49 -12
  34. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  35. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  36. package/templates/tsconfig-sanity.ts +11 -0
  37. package/templates/tsconfig.init.json +22 -0
  38. package/templates/tsconfig.json +12 -102
  39. package/templates/tsconfig.tsbuildinfo +1 -0
  40. package/wrangler-dist/InspectorProxyWorker.js +460 -0
  41. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  42. package/wrangler-dist/ProxyWorker.js +238 -0
  43. package/wrangler-dist/ProxyWorker.js.map +6 -0
  44. package/wrangler-dist/cli.d.ts +26533 -167
  45. package/wrangler-dist/cli.js +146609 -141820
  46. package/Cloudflare_CA.pem +0 -18
  47. package/import_meta_url.js +0 -3
  48. package/miniflare-config-stubs/.env.empty +0 -0
  49. package/miniflare-config-stubs/package.empty.json +0 -1
  50. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  51. package/miniflare-dist/index.mjs +0 -5416
  52. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  53. package/src/__tests__/config-cache.test.ts +0 -42
  54. package/src/__tests__/configuration.test.ts +0 -4022
  55. package/src/__tests__/dev.test.tsx +0 -1294
  56. package/src/__tests__/generate.test.ts +0 -93
  57. package/src/__tests__/guess-worker-format.test.ts +0 -85
  58. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  59. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  60. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  61. package/src/__tests__/helpers/mock-bin.ts +0 -36
  62. package/src/__tests__/helpers/mock-cfetch.ts +0 -263
  63. package/src/__tests__/helpers/mock-console.ts +0 -97
  64. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  65. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  66. package/src/__tests__/helpers/mock-istty.ts +0 -74
  67. package/src/__tests__/helpers/mock-kv.ts +0 -33
  68. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -250
  69. package/src/__tests__/helpers/mock-process.ts +0 -39
  70. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  71. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  72. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  73. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  74. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  75. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  76. package/src/__tests__/https-options.test.ts +0 -163
  77. package/src/__tests__/index.test.ts +0 -245
  78. package/src/__tests__/init.test.ts +0 -1992
  79. package/src/__tests__/jest.setup.ts +0 -150
  80. package/src/__tests__/kv.test.ts +0 -1671
  81. package/src/__tests__/logger.test.ts +0 -141
  82. package/src/__tests__/metrics.test.ts +0 -450
  83. package/src/__tests__/package-manager.test.ts +0 -353
  84. package/src/__tests__/pages.test.ts +0 -1261
  85. package/src/__tests__/parse.test.ts +0 -330
  86. package/src/__tests__/publish.test.ts +0 -6914
  87. package/src/__tests__/pubsub.test.ts +0 -367
  88. package/src/__tests__/r2.test.ts +0 -317
  89. package/src/__tests__/route.test.ts +0 -45
  90. package/src/__tests__/secret.test.ts +0 -492
  91. package/src/__tests__/tail.test.ts +0 -698
  92. package/src/__tests__/test-old-node-version.js +0 -31
  93. package/src/__tests__/user.test.ts +0 -144
  94. package/src/__tests__/validate-dev-props.test.ts +0 -56
  95. package/src/__tests__/version.test.ts +0 -35
  96. package/src/__tests__/whoami.test.tsx +0 -289
  97. package/src/__tests__/worker-namespace.test.ts +0 -327
  98. package/src/abort.d.ts +0 -3
  99. package/src/api/dev.ts +0 -86
  100. package/src/api/index.ts +0 -1
  101. package/src/bundle-reporter.tsx +0 -29
  102. package/src/bundle.ts +0 -472
  103. package/src/cfetch/index.ts +0 -121
  104. package/src/cfetch/internal.ts +0 -181
  105. package/src/cli.ts +0 -27
  106. package/src/config/README.md +0 -107
  107. package/src/config/config.ts +0 -263
  108. package/src/config/diagnostics.ts +0 -80
  109. package/src/config/environment.ts +0 -485
  110. package/src/config/index.ts +0 -251
  111. package/src/config/validation-helpers.ts +0 -584
  112. package/src/config/validation.ts +0 -1856
  113. package/src/config-cache.ts +0 -84
  114. package/src/create-worker-preview.ts +0 -257
  115. package/src/create-worker-upload-form.ts +0 -288
  116. package/src/dev/dev-vars.ts +0 -36
  117. package/src/dev/dev.tsx +0 -531
  118. package/src/dev/local.tsx +0 -385
  119. package/src/dev/remote.tsx +0 -413
  120. package/src/dev/use-esbuild.ts +0 -175
  121. package/src/dev/validate-dev-props.ts +0 -31
  122. package/src/dev-registry.tsx +0 -157
  123. package/src/dev.tsx +0 -616
  124. package/src/dialogs.tsx +0 -135
  125. package/src/durable.ts +0 -102
  126. package/src/entry.ts +0 -328
  127. package/src/environment-variables.ts +0 -35
  128. package/src/errors.ts +0 -11
  129. package/src/faye-websocket.d.ts +0 -6
  130. package/src/generate.ts +0 -131
  131. package/src/git-client.ts +0 -42
  132. package/src/global-wrangler-config-path.ts +0 -26
  133. package/src/https-options.ts +0 -127
  134. package/src/index.tsx +0 -2184
  135. package/src/init.ts +0 -549
  136. package/src/inspect.ts +0 -750
  137. package/src/intl-polyfill.d.ts +0 -139
  138. package/src/is-interactive.ts +0 -12
  139. package/src/kv.ts +0 -430
  140. package/src/logger.ts +0 -73
  141. package/src/metrics/index.ts +0 -5
  142. package/src/metrics/is-ci.ts +0 -14
  143. package/src/metrics/metrics-config.ts +0 -239
  144. package/src/metrics/metrics-dispatcher.ts +0 -96
  145. package/src/metrics/metrics-usage-headers.ts +0 -24
  146. package/src/metrics/send-event.ts +0 -92
  147. package/src/miniflare-cli/README.md +0 -30
  148. package/src/miniflare-cli/assets.ts +0 -543
  149. package/src/miniflare-cli/enum-keys.ts +0 -17
  150. package/src/miniflare-cli/index.ts +0 -85
  151. package/src/miniflare-cli/request-context.ts +0 -40
  152. package/src/module-collection.ts +0 -258
  153. package/src/open-in-browser.ts +0 -17
  154. package/src/package-manager.ts +0 -219
  155. package/src/pages/build.tsx +0 -204
  156. package/src/pages/constants.ts +0 -8
  157. package/src/pages/deployments.tsx +0 -106
  158. package/src/pages/dev.tsx +0 -414
  159. package/src/pages/functions/buildPlugin.ts +0 -105
  160. package/src/pages/functions/buildWorker.ts +0 -151
  161. package/src/pages/functions/filepath-routing.test.ts +0 -234
  162. package/src/pages/functions/filepath-routing.ts +0 -189
  163. package/src/pages/functions/identifiers.ts +0 -78
  164. package/src/pages/functions/routes.ts +0 -151
  165. package/src/pages/index.tsx +0 -84
  166. package/src/pages/projects.tsx +0 -163
  167. package/src/pages/publish.tsx +0 -338
  168. package/src/pages/types.ts +0 -40
  169. package/src/pages/upload.tsx +0 -415
  170. package/src/pages/utils.ts +0 -12
  171. package/src/parse.ts +0 -286
  172. package/src/paths.ts +0 -26
  173. package/src/preview.ts +0 -31
  174. package/src/proxy.ts +0 -476
  175. package/src/publish.ts +0 -807
  176. package/src/pubsub/index.ts +0 -286
  177. package/src/pubsub/pubsub-commands.tsx +0 -623
  178. package/src/r2.ts +0 -118
  179. package/src/selfsigned.d.ts +0 -29
  180. package/src/sites.tsx +0 -372
  181. package/src/tail/filters.ts +0 -279
  182. package/src/tail/index.ts +0 -299
  183. package/src/tail/printing.ts +0 -67
  184. package/src/update-check.ts +0 -19
  185. package/src/user/choose-account.tsx +0 -69
  186. package/src/user/env-vars.ts +0 -46
  187. package/src/user/generate-auth-url.ts +0 -33
  188. package/src/user/generate-random-state.ts +0 -16
  189. package/src/user/index.ts +0 -3
  190. package/src/user/user.tsx +0 -1189
  191. package/src/whoami.tsx +0 -169
  192. package/src/worker-namespace.ts +0 -206
  193. package/src/worker.ts +0 -203
  194. package/src/zones.ts +0 -76
  195. package/templates/first-party-worker-module-facade.ts +0 -18
  196. package/templates/format-dev-errors.ts +0 -32
  197. package/templates/serve-static-assets.ts +0 -63
  198. package/templates/service-bindings-module-facade.js +0 -51
  199. package/templates/service-bindings-sw-facade.js +0 -39
package/src/dialogs.tsx DELETED
@@ -1,135 +0,0 @@
1
- import chalk from "chalk";
2
- import { Box, Text, useInput, render } from "ink";
3
- import SelectInput from "ink-select-input";
4
- import TextInput from "ink-text-input";
5
- import * as React from "react";
6
- import { useState } from "react";
7
- import { logger } from "./logger";
8
- type ConfirmProps = {
9
- text: string;
10
- onConfirm: (answer: boolean) => void;
11
- };
12
- function Confirm(props: ConfirmProps) {
13
- useInput((input: string, key) => {
14
- if (input === "y" || key.return === true) {
15
- props.onConfirm(true);
16
- } else if (input === "n") {
17
- props.onConfirm(false);
18
- } else {
19
- logger.warn("Unrecognised input:", input);
20
- }
21
- });
22
- return (
23
- <Box>
24
- <Text>
25
- {props.text} ({chalk.bold("y")}/n)
26
- </Text>
27
- </Box>
28
- );
29
- }
30
-
31
- export function confirm(text: string): Promise<boolean> {
32
- return new Promise((resolve) => {
33
- const { unmount } = render(
34
- <Confirm
35
- text={text}
36
- onConfirm={(answer: boolean) => {
37
- unmount();
38
- resolve(answer);
39
- }}
40
- />
41
- );
42
- });
43
- }
44
-
45
- type PromptProps = {
46
- text: string;
47
- defaultValue?: string;
48
- type?: "text" | "password";
49
- onSubmit: (text: string) => void;
50
- };
51
-
52
- function Prompt(props: PromptProps) {
53
- const [value, setValue] = useState(props.defaultValue || "");
54
-
55
- return (
56
- <Box>
57
- <Text>{props.text} </Text>
58
- <Box>
59
- <TextInput
60
- mask={props.type === "password" ? "*" : undefined}
61
- value={value}
62
- onChange={setValue}
63
- onSubmit={props.onSubmit}
64
- />
65
- </Box>
66
- </Box>
67
- );
68
- }
69
-
70
- export async function prompt(
71
- text: string,
72
- type: "text" | "password" = "text",
73
- defaultValue?: string
74
- ): Promise<string> {
75
- return new Promise((resolve) => {
76
- const { unmount } = render(
77
- <Prompt
78
- text={text}
79
- defaultValue={defaultValue}
80
- type={type}
81
- onSubmit={(inputText) => {
82
- unmount();
83
- resolve(inputText);
84
- }}
85
- />
86
- );
87
- });
88
- }
89
-
90
- type SelectOption = {
91
- value: string;
92
- label: string;
93
- };
94
-
95
- type SelectProps = {
96
- text: string;
97
- options: SelectOption[];
98
- initialIndex: number;
99
- onSelect: (value: string) => void;
100
- };
101
-
102
- function Select(props: SelectProps) {
103
- return (
104
- <Box flexDirection="column">
105
- <Text>{props.text}</Text>
106
- <SelectInput
107
- initialIndex={props.initialIndex}
108
- items={props.options}
109
- onSelect={async (selected) => {
110
- props.onSelect(selected.value);
111
- }}
112
- />
113
- </Box>
114
- );
115
- }
116
-
117
- export function select(
118
- text: string,
119
- options: SelectOption[],
120
- initialIndex: number
121
- ): Promise<string> {
122
- return new Promise((resolve) => {
123
- const { unmount } = render(
124
- <Select
125
- text={text}
126
- options={options}
127
- initialIndex={initialIndex}
128
- onSelect={(option: string) => {
129
- unmount();
130
- resolve(option);
131
- }}
132
- />
133
- );
134
- });
135
- }
package/src/durable.ts DELETED
@@ -1,102 +0,0 @@
1
- import assert from "node:assert";
2
- import { fetchResult } from "./cfetch";
3
- import { logger } from "./logger";
4
- import type { Config } from "./config";
5
- import type { CfWorkerInit } from "./worker";
6
-
7
- /**
8
- * For a given Worker + migrations config, figure out which migrations
9
- * to upload based on the current migration tag of the deployed Worker.
10
- */
11
- export async function getMigrationsToUpload(
12
- scriptName: string,
13
- props: {
14
- accountId: string | undefined;
15
- config: Config;
16
- legacyEnv: boolean | undefined;
17
- env: string | undefined;
18
- }
19
- ): Promise<CfWorkerInit["migrations"]> {
20
- const { config, accountId } = props;
21
-
22
- assert(accountId, "Missing accountId");
23
- // if config.migrations
24
- let migrations;
25
- if (config.migrations.length > 0) {
26
- // get current migration tag
27
- type ScriptData = { id: string; migration_tag?: string };
28
- let script: ScriptData | undefined;
29
- if (!props.legacyEnv) {
30
- try {
31
- if (props.env) {
32
- const scriptData = await fetchResult<{
33
- script: ScriptData;
34
- }>(
35
- `/accounts/${accountId}/workers/services/${scriptName}/environments/${props.env}`
36
- );
37
- script = scriptData.script;
38
- } else {
39
- const scriptData = await fetchResult<{
40
- default_environment: {
41
- script: ScriptData;
42
- };
43
- }>(`/accounts/${accountId}/workers/services/${scriptName}`);
44
- script = scriptData.default_environment.script;
45
- }
46
- } catch (err) {
47
- if (
48
- ![
49
- 10090, // corresponds to workers.api.error.service_not_found, so the script wasn't previously published at all
50
- 10092, // workers.api.error.environment_not_found, so the script wasn't published to this environment yet
51
- ].includes((err as { code: number }).code)
52
- ) {
53
- throw err;
54
- }
55
- // else it's a 404, no script found, and we can proceed
56
- }
57
- } else {
58
- const scripts = await fetchResult<ScriptData[]>(
59
- `/accounts/${accountId}/workers/scripts`
60
- );
61
- script = scripts.find(({ id }) => id === scriptName);
62
- }
63
-
64
- if (script?.migration_tag) {
65
- // was already published once
66
- const scriptMigrationTag = script.migration_tag;
67
- const foundIndex = config.migrations.findIndex(
68
- (migration) => migration.tag === scriptMigrationTag
69
- );
70
- if (foundIndex === -1) {
71
- logger.warn(
72
- `The published script ${scriptName} has a migration tag "${script.migration_tag}, which was not found in wrangler.toml. You may have already deleted it. Applying all available migrations to the script...`
73
- );
74
- migrations = {
75
- old_tag: script.migration_tag,
76
- new_tag: config.migrations[config.migrations.length - 1].tag,
77
- steps: config.migrations.map(({ tag: _tag, ...rest }) => rest),
78
- };
79
- } else {
80
- if (foundIndex !== config.migrations.length - 1) {
81
- // there are new migrations to send up
82
- migrations = {
83
- old_tag: script.migration_tag,
84
- new_tag: config.migrations[config.migrations.length - 1].tag,
85
- steps: config.migrations
86
- .slice(foundIndex + 1)
87
- .map(({ tag: _tag, ...rest }) => rest),
88
- };
89
- }
90
- // else, we're up to date, no migrations to send
91
- }
92
- } else {
93
- // first time publishing durable objects to this script,
94
- // so we send all the migrations
95
- migrations = {
96
- new_tag: config.migrations[config.migrations.length - 1].tag,
97
- steps: config.migrations.map(({ tag: _tag, ...rest }) => rest),
98
- };
99
- }
100
- }
101
- return migrations;
102
- }
package/src/entry.ts DELETED
@@ -1,328 +0,0 @@
1
- import assert from "node:assert";
2
- import { existsSync, statSync } from "node:fs";
3
- import path from "node:path";
4
- import * as esbuild from "esbuild";
5
- import { execaCommand } from "execa";
6
- import { logger } from "./logger";
7
- import type { Config } from "./config";
8
- import type { CfScriptFormat } from "./worker";
9
- import type { Metafile } from "esbuild";
10
-
11
- /**
12
- * An entry point for the Worker.
13
- *
14
- * It consists not just of a `file`, but also of a `directory` that is used to resolve relative paths.
15
- */
16
- export type Entry = { file: string; directory: string; format: CfScriptFormat };
17
-
18
- /**
19
- * Compute the entry-point for the Worker.
20
- */
21
- export async function getEntry(
22
- args: {
23
- script?: string;
24
- format?: CfScriptFormat | undefined;
25
- assets?: string | undefined;
26
- },
27
- config: Config,
28
- command: "dev" | "publish"
29
- ): Promise<Entry> {
30
- let file: string;
31
- let directory = process.cwd();
32
- if (args.script) {
33
- // If the script name comes from the command line it is relative to the current working directory.
34
- file = path.resolve(args.script);
35
- } else if (config.main === undefined) {
36
- if (config.site?.["entry-point"]) {
37
- directory = path.resolve(path.dirname(config.configPath ?? "."));
38
- file = path.extname(config.site?.["entry-point"])
39
- ? path.resolve(config.site?.["entry-point"])
40
- : // site.entry-point could be a directory
41
- path.resolve(config.site?.["entry-point"], "index.js");
42
- } else if (args.assets || config.assets) {
43
- file = path.resolve(__dirname, "../templates/no-op-worker.js");
44
- } else {
45
- throw new Error(
46
- `Missing entry-point: The entry-point should be specified via the command line (e.g. \`wrangler ${command} path/to/script\`) or the \`main\` config field.`
47
- );
48
- }
49
- } else {
50
- directory = path.resolve(path.dirname(config.configPath ?? "."));
51
- file = path.resolve(directory, config.main);
52
- }
53
-
54
- const relativeFile = path.relative(directory, file) || ".";
55
- await runCustomBuild(file, relativeFile, config.build);
56
-
57
- if (fileExists(file) === false) {
58
- throw new Error(
59
- getMissingEntryPointMessage(
60
- `The entry-point file at "${relativeFile}" was not found.`,
61
- file,
62
- relativeFile
63
- )
64
- );
65
- }
66
- const format = await guessWorkerFormat(
67
- file,
68
- directory,
69
- args.format ?? config.build?.upload?.format,
70
- config.tsconfig
71
- );
72
-
73
- const { localBindings, remoteBindings } =
74
- partitionDurableObjectBindings(config);
75
-
76
- if (command === "dev" && remoteBindings.length > 0) {
77
- logger.warn(
78
- "WARNING: You have Durable Object bindings that are not defined locally in the worker being developed.\n" +
79
- "Be aware that changes to the data stored in these Durable Objects will be permanent and affect the live instances.\n" +
80
- "Remote Durable Objects that are affected:\n" +
81
- remoteBindings.map((b) => `- ${JSON.stringify(b)}`).join("\n")
82
- );
83
- }
84
-
85
- if (format === "service-worker" && localBindings.length > 0) {
86
- const errorMessage =
87
- "You seem to be trying to use Durable Objects in a Worker written as a service-worker.";
88
- const addScriptName =
89
- "You can use Durable Objects defined in other Workers by specifying a `script_name` in your wrangler.toml, where `script_name` is the name of the Worker that implements that Durable Object. For example:";
90
- const addScriptNameExamples = generateAddScriptNameExamples(localBindings);
91
- const migrateText =
92
- "Alternatively, migrate your worker to ES Module syntax to implement a Durable Object in this Worker:";
93
- const migrateUrl =
94
- "https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/";
95
- throw new Error(
96
- `${errorMessage}\n${addScriptName}\n${addScriptNameExamples}\n${migrateText}\n${migrateUrl}`
97
- );
98
- }
99
-
100
- return { file, directory, format };
101
- }
102
-
103
- export async function runCustomBuild(
104
- expectedEntryAbsolute: string,
105
- expectedEntryRelative: string,
106
- build: Config["build"]
107
- ) {
108
- if (build?.command) {
109
- // TODO: add a deprecation message here?
110
- logger.log("Running custom build:", build.command);
111
- await execaCommand(build.command, {
112
- shell: true,
113
- // we keep these two as "inherit" so that
114
- // logs are still visible.
115
- stdout: "inherit",
116
- stderr: "inherit",
117
- ...(build.cwd && { cwd: build.cwd }),
118
- });
119
-
120
- if (fileExists(expectedEntryAbsolute) === false) {
121
- throw new Error(
122
- getMissingEntryPointMessage(
123
- `The expected output file at "${expectedEntryRelative}" was not found after running custom build: ${build.command}.\n` +
124
- "The `main` property in wrangler.toml should point to the file generated by the custom build.",
125
- expectedEntryAbsolute,
126
- expectedEntryRelative
127
- )
128
- );
129
- }
130
- }
131
- }
132
-
133
- /**
134
- * A function to "guess" the type of worker.
135
- * We do this by running a lightweight build of the actual script,
136
- * and looking at the metafile generated by esbuild. If it has a default
137
- * export (or really, any exports), that means it's a "modules" worker.
138
- * Else, it's a "service-worker" worker. This seems hacky, but works remarkably
139
- * well in practice.
140
- */
141
- export default async function guessWorkerFormat(
142
- entryFile: string,
143
- entryWorkingDirectory: string,
144
- hint: CfScriptFormat | undefined,
145
- tsconfig?: string | undefined
146
- ): Promise<CfScriptFormat> {
147
- const result = await esbuild.build({
148
- entryPoints: [entryFile],
149
- absWorkingDir: entryWorkingDirectory,
150
- metafile: true,
151
- bundle: false,
152
- format: "esm",
153
- target: "es2020",
154
- write: false,
155
- loader: {
156
- ".js": "jsx",
157
- ".mjs": "jsx",
158
- ".cjs": "jsx",
159
- },
160
- ...(tsconfig && { tsconfig }),
161
- });
162
- // result.metafile is defined because of the `metafile: true` option above.
163
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
164
- const metafile = result.metafile!;
165
- const entryPoints = Object.entries(metafile.outputs).filter(
166
- ([_path, output]) => output.entryPoint !== undefined
167
- );
168
- assert(
169
- entryPoints.length > 0,
170
- `Cannot find entry-point "${entryFile}" in generated bundle.` +
171
- listEntryPoints(entryPoints)
172
- );
173
- assert(
174
- entryPoints.length < 2,
175
- "More than one entry-point found for generated bundle." +
176
- listEntryPoints(entryPoints)
177
- );
178
-
179
- let guessedWorkerFormat: CfScriptFormat;
180
- const scriptExports = entryPoints[0][1].exports;
181
- if (scriptExports.length > 0) {
182
- if (scriptExports.includes("default")) {
183
- guessedWorkerFormat = "modules";
184
- } else {
185
- logger.warn(
186
- `The entrypoint ${path.relative(
187
- process.cwd(),
188
- entryFile
189
- )} has exports like an ES Module, but hasn't defined a default export like a module worker normally would. Building the worker using "service-worker" format...`
190
- );
191
- guessedWorkerFormat = "service-worker";
192
- }
193
- } else {
194
- guessedWorkerFormat = "service-worker";
195
- }
196
-
197
- if (hint) {
198
- if (hint !== guessedWorkerFormat) {
199
- if (hint === "service-worker") {
200
- throw new Error(
201
- "You configured this worker to be a 'service-worker', but the file you are trying to build appears to have a `default` export like a module worker. Please pass `--format modules`, or simply remove the configuration."
202
- );
203
- } else {
204
- throw new Error(
205
- "You configured this worker to be 'modules', but the file you are trying to build doesn't export a handler. Please pass `--format service-worker`, or simply remove the configuration."
206
- );
207
- }
208
- }
209
- }
210
- return guessedWorkerFormat;
211
- }
212
-
213
- function listEntryPoints(
214
- outputs: [string, ValueOf<Metafile["outputs"]>][]
215
- ): string {
216
- return outputs.map(([_input, output]) => output.entryPoint).join("\n");
217
- }
218
-
219
- type ValueOf<T> = T[keyof T];
220
-
221
- /**
222
- * Returns true if the given `filePath` exists as-is,
223
- * or if some version of it (by appending a common extension) exists.
224
- */
225
- export function fileExists(filePath: string): boolean {
226
- if (path.extname(filePath) !== "") {
227
- return existsSync(filePath);
228
- }
229
- const base = path.join(path.dirname(filePath), path.basename(filePath));
230
- for (const ext of [".ts", ".tsx", ".js", ".jsx"]) {
231
- if (existsSync(base + ext)) {
232
- return true;
233
- }
234
- }
235
- return false;
236
- }
237
-
238
- type DurableObjectBindings = Config["durable_objects"]["bindings"];
239
-
240
- /**
241
- * Groups the durable object bindings into two lists:
242
- * those that are defined locally and those that refer to a durable object defined in another script.
243
- */
244
- function partitionDurableObjectBindings(config: Config): {
245
- localBindings: DurableObjectBindings;
246
- remoteBindings: DurableObjectBindings;
247
- } {
248
- const localBindings: DurableObjectBindings = [];
249
- const remoteBindings: DurableObjectBindings = [];
250
- for (const binding of config.durable_objects.bindings) {
251
- if (binding.script_name === undefined) {
252
- localBindings.push(binding);
253
- } else {
254
- remoteBindings.push(binding);
255
- }
256
- }
257
- return { localBindings, remoteBindings };
258
- }
259
-
260
- /**
261
- * Generates some help text based on the Durable Object bindings in a given
262
- * config indicating how the user can add a `script_name` field to bind an
263
- * externally defined Durable Object.
264
- */
265
- function generateAddScriptNameExamples(
266
- localBindings: DurableObjectBindings
267
- ): string {
268
- function exampleScriptName(binding_name: string): string {
269
- return `${binding_name.toLowerCase().replaceAll("_", "-")}-worker`;
270
- }
271
-
272
- return localBindings
273
- .map(({ name, class_name }) => {
274
- const script_name = exampleScriptName(name);
275
- const currentBinding = `{ name = ${name}, class_name = ${class_name} }`;
276
- const fixedBinding = `{ name = ${name}, class_name = ${class_name}, script_name = ${script_name} }`;
277
-
278
- return `${currentBinding} ==> ${fixedBinding}`;
279
- })
280
- .join("\n");
281
- }
282
-
283
- /**
284
- * Generate an appropriate message for when the entry-point is missing.
285
- *
286
- * To be more helpful to developers, we check whether there is a suitable file
287
- * nearby to the expected file path.
288
- */
289
- function getMissingEntryPointMessage(
290
- message: string,
291
- absoluteEntryPointPath: string,
292
- relativeEntryPointPath: string
293
- ): string {
294
- if (
295
- existsSync(absoluteEntryPointPath) &&
296
- statSync(absoluteEntryPointPath).isDirectory()
297
- ) {
298
- // The expected entry-point is a directory, so offer further guidance.
299
- message += `\nThe provided entry-point path, "${relativeEntryPointPath}", points to a directory, rather than a file.\n`;
300
-
301
- // Perhaps we can even guess what the correct path should be...
302
- const possiblePaths: string[] = [];
303
- for (const basenamePath of [
304
- "worker",
305
- "dist/worker",
306
- "index",
307
- "dist/index",
308
- ]) {
309
- for (const extension of [".ts", ".tsx", ".js", ".jsx"]) {
310
- const filePath = basenamePath + extension;
311
- if (fileExists(path.resolve(absoluteEntryPointPath, filePath))) {
312
- possiblePaths.push(path.join(relativeEntryPointPath, filePath));
313
- }
314
- }
315
- }
316
-
317
- if (possiblePaths.length > 0) {
318
- message +=
319
- `\nDid you mean to set the main field to${
320
- possiblePaths.length > 1 ? " one of" : ""
321
- }:\n` +
322
- "```\n" +
323
- possiblePaths.map((filePath) => `main = "./${filePath}"\n`).join("") +
324
- "```";
325
- }
326
- }
327
- return message;
328
- }
@@ -1,35 +0,0 @@
1
- import { logger } from "./logger";
2
-
3
- /**
4
- * Create a function used to access an environment variable.
5
- *
6
- * This is not memoized to allow us to change the value at runtime, such as in testing.
7
- * A warning is shown if the client is using a deprecated version - but only once.
8
- */
9
- export function getEnvironmentVariableFactory({
10
- variableName,
11
- deprecatedName,
12
- defaultValue,
13
- }: {
14
- variableName: string;
15
- deprecatedName?: string;
16
- defaultValue?: string;
17
- }) {
18
- let hasWarned = false;
19
- return () => {
20
- if (process.env[variableName]) {
21
- return process.env[variableName];
22
- } else if (deprecatedName && process.env[deprecatedName]) {
23
- if (!hasWarned) {
24
- // Only show the warning once.
25
- hasWarned = true;
26
- logger.warn(
27
- `Using "${deprecatedName}" environment variable. This is deprecated. Please use "${variableName}", instead.`
28
- );
29
- }
30
- return process.env[deprecatedName];
31
- } else {
32
- return defaultValue;
33
- }
34
- };
35
- }
package/src/errors.ts DELETED
@@ -1,11 +0,0 @@
1
- export class DeprecationError extends Error {
2
- constructor(message: string) {
3
- super(`Deprecation:\n${message}`);
4
- }
5
- }
6
-
7
- export class FatalError extends Error {
8
- constructor(message?: string, readonly code?: number) {
9
- super(message);
10
- }
11
- }
@@ -1,6 +0,0 @@
1
- module "faye-websocket" {
2
- /**
3
- * Standards-compliant WebSocket client and server.
4
- */
5
- export default WebSocket;
6
- }