wrangler 0.0.0-e978986 → 0.0.0-e98269a59

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 (188) hide show
  1. package/README.md +42 -36
  2. package/bin/wrangler.js +86 -67
  3. package/config-schema.json +3370 -0
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +132 -101
  6. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  7. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  8. package/templates/__tests__/tsconfig.json +8 -0
  9. package/templates/checked-fetch.js +30 -0
  10. package/templates/facade.d.ts +19 -0
  11. package/templates/gitignore +2 -3
  12. package/templates/init-tests/test-jest-new-worker.js +23 -0
  13. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  14. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  15. package/templates/middleware/common.ts +67 -0
  16. package/templates/middleware/loader-modules.ts +134 -0
  17. package/templates/middleware/loader-sw.ts +229 -0
  18. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  19. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  20. package/templates/middleware/middleware-mock-analytics-engine.d.ts +3 -0
  21. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  22. package/templates/middleware/middleware-patch-console-prefix.d.ts +3 -0
  23. package/templates/middleware/middleware-patch-console-prefix.ts +21 -0
  24. package/templates/middleware/middleware-pretty-error.ts +40 -0
  25. package/templates/middleware/middleware-scheduled.ts +29 -0
  26. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  27. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  28. package/templates/modules-watch-stub.js +4 -0
  29. package/templates/new-worker-scheduled.js +4 -4
  30. package/templates/new-worker-scheduled.ts +17 -17
  31. package/templates/new-worker.js +3 -3
  32. package/templates/new-worker.ts +19 -16
  33. package/templates/no-op-worker.js +10 -0
  34. package/templates/pages-dev-pipeline.ts +32 -0
  35. package/templates/pages-dev-util.ts +55 -0
  36. package/templates/pages-shim.ts +9 -0
  37. package/templates/pages-template-plugin.ts +190 -0
  38. package/templates/pages-template-worker.ts +198 -0
  39. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  40. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  41. package/templates/tsconfig-sanity.ts +11 -0
  42. package/templates/tsconfig.init.json +22 -0
  43. package/templates/tsconfig.json +6 -103
  44. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  45. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  46. package/wrangler-dist/ProxyWorker.js +241 -0
  47. package/wrangler-dist/ProxyWorker.js.map +6 -0
  48. package/wrangler-dist/cli.d.ts +26730 -0
  49. package/wrangler-dist/cli.js +166492 -119745
  50. package/Cloudflare_CA.pem +0 -18
  51. package/import_meta_url.js +0 -3
  52. package/miniflare-config-stubs/.env.empty +0 -0
  53. package/miniflare-config-stubs/package.empty.json +0 -1
  54. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  55. package/miniflare-dist/index.mjs +0 -4886
  56. package/pages/functions/buildPlugin.ts +0 -105
  57. package/pages/functions/buildWorker.ts +0 -151
  58. package/pages/functions/filepath-routing.test.ts +0 -234
  59. package/pages/functions/filepath-routing.ts +0 -189
  60. package/pages/functions/identifiers.ts +0 -78
  61. package/pages/functions/routes.ts +0 -156
  62. package/pages/functions/template-plugin.ts +0 -147
  63. package/pages/functions/template-worker.ts +0 -143
  64. package/src/__tests__/config-cache.test.ts +0 -36
  65. package/src/__tests__/configuration.test.ts +0 -3374
  66. package/src/__tests__/dev.test.tsx +0 -980
  67. package/src/__tests__/guess-worker-format.test.ts +0 -85
  68. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  69. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  70. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  71. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  72. package/src/__tests__/helpers/mock-bin.ts +0 -36
  73. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  74. package/src/__tests__/helpers/mock-console.ts +0 -87
  75. package/src/__tests__/helpers/mock-dialogs.ts +0 -130
  76. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  77. package/src/__tests__/helpers/mock-istty.ts +0 -27
  78. package/src/__tests__/helpers/mock-kv.ts +0 -33
  79. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -255
  80. package/src/__tests__/helpers/mock-stdin.ts +0 -103
  81. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  82. package/src/__tests__/helpers/run-in-tmp.ts +0 -39
  83. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  84. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  85. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  86. package/src/__tests__/https-options.test.ts +0 -130
  87. package/src/__tests__/index.test.ts +0 -256
  88. package/src/__tests__/init.test.ts +0 -1567
  89. package/src/__tests__/jest.setup.ts +0 -77
  90. package/src/__tests__/kv.test.ts +0 -1481
  91. package/src/__tests__/logger.test.ts +0 -115
  92. package/src/__tests__/package-manager.test.ts +0 -353
  93. package/src/__tests__/pages.test.ts +0 -657
  94. package/src/__tests__/parse.test.ts +0 -330
  95. package/src/__tests__/publish.test.ts +0 -5468
  96. package/src/__tests__/r2.test.ts +0 -233
  97. package/src/__tests__/route.test.ts +0 -45
  98. package/src/__tests__/secret.test.ts +0 -481
  99. package/src/__tests__/tail.test.ts +0 -690
  100. package/src/__tests__/user.test.ts +0 -131
  101. package/src/__tests__/whoami.test.tsx +0 -105
  102. package/src/abort.d.ts +0 -3
  103. package/src/bundle.ts +0 -200
  104. package/src/cfetch/index.ts +0 -121
  105. package/src/cfetch/internal.ts +0 -145
  106. package/src/cli.ts +0 -13
  107. package/src/config/README.md +0 -107
  108. package/src/config/config.ts +0 -234
  109. package/src/config/diagnostics.ts +0 -80
  110. package/src/config/environment.ts +0 -420
  111. package/src/config/index.ts +0 -225
  112. package/src/config/validation-helpers.ts +0 -575
  113. package/src/config/validation.ts +0 -1539
  114. package/src/config-cache.ts +0 -45
  115. package/src/create-worker-preview.ts +0 -185
  116. package/src/create-worker-upload-form.ts +0 -254
  117. package/src/dev/dev-vars.ts +0 -36
  118. package/src/dev/dev.tsx +0 -419
  119. package/src/dev/local.tsx +0 -318
  120. package/src/dev/remote.tsx +0 -227
  121. package/src/dev/use-esbuild.ts +0 -118
  122. package/src/dialogs.tsx +0 -135
  123. package/src/durable.ts +0 -102
  124. package/src/entry.ts +0 -322
  125. package/src/environment-variables.ts +0 -35
  126. package/src/errors.ts +0 -11
  127. package/src/https-options.ts +0 -123
  128. package/src/index.tsx +0 -2848
  129. package/src/inspect.ts +0 -662
  130. package/src/intl-polyfill.d.ts +0 -139
  131. package/src/kv.ts +0 -408
  132. package/src/logger.ts +0 -66
  133. package/src/miniflare-cli/README.md +0 -30
  134. package/src/miniflare-cli/enum-keys.ts +0 -17
  135. package/src/miniflare-cli/index.ts +0 -41
  136. package/src/miniflare-cli/request-context.ts +0 -40
  137. package/src/module-collection.ts +0 -258
  138. package/src/open-in-browser.ts +0 -19
  139. package/src/package-manager.ts +0 -174
  140. package/src/pages.tsx +0 -2027
  141. package/src/parse.ts +0 -202
  142. package/src/paths.ts +0 -26
  143. package/src/proxy.ts +0 -465
  144. package/src/publish.ts +0 -583
  145. package/src/r2.ts +0 -50
  146. package/src/selfsigned.d.ts +0 -29
  147. package/src/sites.tsx +0 -295
  148. package/src/tail/filters.ts +0 -279
  149. package/src/tail/index.ts +0 -299
  150. package/src/tail/printing.ts +0 -67
  151. package/src/update-check.ts +0 -19
  152. package/src/user.tsx +0 -1203
  153. package/src/whoami.tsx +0 -70
  154. package/src/worker.ts +0 -180
  155. package/templates/static-asset-facade.js +0 -47
  156. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  157. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  158. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  159. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  160. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  161. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  162. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  163. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  164. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  165. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  166. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  167. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  168. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  169. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  170. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  171. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  172. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  173. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  174. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  175. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  176. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  177. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  178. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  179. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  180. package/vendor/wrangler-mime/LICENSE +0 -21
  181. package/vendor/wrangler-mime/Mime.js +0 -97
  182. package/vendor/wrangler-mime/README.md +0 -187
  183. package/vendor/wrangler-mime/cli.js +0 -46
  184. package/vendor/wrangler-mime/index.js +0 -4
  185. package/vendor/wrangler-mime/lite.js +0 -4
  186. package/vendor/wrangler-mime/package.json +0 -52
  187. package/vendor/wrangler-mime/types/other.js +0 -1
  188. package/vendor/wrangler-mime/types/standard.js +0 -1
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,322 +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: { script?: string; format?: CfScriptFormat | undefined },
23
- config: Config,
24
- command: "dev" | "publish"
25
- ): Promise<Entry> {
26
- let file: string;
27
- let directory = process.cwd();
28
- if (args.script) {
29
- // If the script name comes from the command line it is relative to the current working directory.
30
- file = path.resolve(args.script);
31
- } else if (config.main === undefined) {
32
- if (config.site?.["entry-point"]) {
33
- directory = path.resolve(path.dirname(config.configPath ?? "."));
34
- file = path.extname(config.site?.["entry-point"])
35
- ? path.resolve(config.site?.["entry-point"])
36
- : // site.entry-point could be a directory
37
- path.resolve(config.site?.["entry-point"], "index.js");
38
- } else {
39
- throw new Error(
40
- `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.`
41
- );
42
- }
43
- } else {
44
- directory = path.resolve(path.dirname(config.configPath ?? "."));
45
- file = path.resolve(directory, config.main);
46
- }
47
-
48
- const relativeFile = path.relative(directory, file) || ".";
49
- await runCustomBuild(file, relativeFile, config.build);
50
-
51
- if (fileExists(file) === false) {
52
- throw new Error(
53
- getMissingEntryPointMessage(
54
- `The entry-point file at "${relativeFile}" was not found.`,
55
- file,
56
- relativeFile
57
- )
58
- );
59
- }
60
- const format = await guessWorkerFormat(
61
- file,
62
- directory,
63
- args.format ?? config.build?.upload?.format,
64
- config.tsconfig
65
- );
66
-
67
- const { localBindings, remoteBindings } =
68
- partitionDurableObjectBindings(config);
69
-
70
- if (command === "dev" && remoteBindings.length > 0) {
71
- logger.warn(
72
- "WARNING: You have Durable Object bindings that are not defined locally in the worker being developed.\n" +
73
- "Be aware that changes to the data stored in these Durable Objects will be permanent and affect the live instances.\n" +
74
- "Remote Durable Objects that are affected:\n" +
75
- remoteBindings.map((b) => `- ${JSON.stringify(b)}`).join("\n")
76
- );
77
- }
78
-
79
- if (format === "service-worker" && localBindings.length > 0) {
80
- const errorMessage =
81
- "You seem to be trying to use Durable Objects in a Worker written as a service-worker.";
82
- const addScriptName =
83
- "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:";
84
- const addScriptNameExamples = generateAddScriptNameExamples(localBindings);
85
- const migrateText =
86
- "Alternatively, migrate your worker to ES Module syntax to implement a Durable Object in this Worker:";
87
- const migrateUrl =
88
- "https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/";
89
- throw new Error(
90
- `${errorMessage}\n${addScriptName}\n${addScriptNameExamples}\n${migrateText}\n${migrateUrl}`
91
- );
92
- }
93
-
94
- return { file, directory, format };
95
- }
96
-
97
- export async function runCustomBuild(
98
- expectedEntryAbsolute: string,
99
- expectedEntryRelative: string,
100
- build: Config["build"]
101
- ) {
102
- if (build?.command) {
103
- // TODO: add a deprecation message here?
104
- logger.log("Running custom build:", build.command);
105
- await execaCommand(build.command, {
106
- shell: true,
107
- // we keep these two as "inherit" so that
108
- // logs are still visible.
109
- stdout: "inherit",
110
- stderr: "inherit",
111
- ...(build.cwd && { cwd: build.cwd }),
112
- });
113
-
114
- if (fileExists(expectedEntryAbsolute) === false) {
115
- throw new Error(
116
- getMissingEntryPointMessage(
117
- `The expected output file at "${expectedEntryRelative}" was not found after running custom build: ${build.command}.\n` +
118
- "The `main` property in wrangler.toml should point to the file generated by the custom build.",
119
- expectedEntryAbsolute,
120
- expectedEntryRelative
121
- )
122
- );
123
- }
124
- }
125
- }
126
-
127
- /**
128
- * A function to "guess" the type of worker.
129
- * We do this by running a lightweight build of the actual script,
130
- * and looking at the metafile generated by esbuild. If it has a default
131
- * export (or really, any exports), that means it's a "modules" worker.
132
- * Else, it's a "service-worker" worker. This seems hacky, but works remarkably
133
- * well in practice.
134
- */
135
- export default async function guessWorkerFormat(
136
- entryFile: string,
137
- entryWorkingDirectory: string,
138
- hint: CfScriptFormat | undefined,
139
- tsconfig?: string | undefined
140
- ): Promise<CfScriptFormat> {
141
- const result = await esbuild.build({
142
- entryPoints: [entryFile],
143
- absWorkingDir: entryWorkingDirectory,
144
- metafile: true,
145
- bundle: false,
146
- format: "esm",
147
- target: "es2020",
148
- write: false,
149
- loader: {
150
- ".js": "jsx",
151
- ".mjs": "jsx",
152
- ".cjs": "jsx",
153
- },
154
- ...(tsconfig && { tsconfig }),
155
- });
156
- // result.metafile is defined because of the `metafile: true` option above.
157
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
158
- const metafile = result.metafile!;
159
- const entryPoints = Object.entries(metafile.outputs).filter(
160
- ([_path, output]) => output.entryPoint !== undefined
161
- );
162
- assert(
163
- entryPoints.length > 0,
164
- `Cannot find entry-point "${entryFile}" in generated bundle.` +
165
- listEntryPoints(entryPoints)
166
- );
167
- assert(
168
- entryPoints.length < 2,
169
- "More than one entry-point found for generated bundle." +
170
- listEntryPoints(entryPoints)
171
- );
172
-
173
- let guessedWorkerFormat: CfScriptFormat;
174
- const scriptExports = entryPoints[0][1].exports;
175
- if (scriptExports.length > 0) {
176
- if (scriptExports.includes("default")) {
177
- guessedWorkerFormat = "modules";
178
- } else {
179
- logger.warn(
180
- `The entrypoint ${path.relative(
181
- process.cwd(),
182
- entryFile
183
- )} 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...`
184
- );
185
- guessedWorkerFormat = "service-worker";
186
- }
187
- } else {
188
- guessedWorkerFormat = "service-worker";
189
- }
190
-
191
- if (hint) {
192
- if (hint !== guessedWorkerFormat) {
193
- if (hint === "service-worker") {
194
- throw new Error(
195
- "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."
196
- );
197
- } else {
198
- throw new Error(
199
- "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."
200
- );
201
- }
202
- }
203
- }
204
- return guessedWorkerFormat;
205
- }
206
-
207
- function listEntryPoints(
208
- outputs: [string, ValueOf<Metafile["outputs"]>][]
209
- ): string {
210
- return outputs.map(([_input, output]) => output.entryPoint).join("\n");
211
- }
212
-
213
- type ValueOf<T> = T[keyof T];
214
-
215
- /**
216
- * Returns true if the given `filePath` exists as-is,
217
- * or if some version of it (by appending a common extension) exists.
218
- */
219
- export function fileExists(filePath: string): boolean {
220
- if (path.extname(filePath) !== "") {
221
- return existsSync(filePath);
222
- }
223
- const base = path.join(path.dirname(filePath), path.basename(filePath));
224
- for (const ext of [".ts", ".tsx", ".js", ".jsx"]) {
225
- if (existsSync(base + ext)) {
226
- return true;
227
- }
228
- }
229
- return false;
230
- }
231
-
232
- type DurableObjectBindings = Config["durable_objects"]["bindings"];
233
-
234
- /**
235
- * Groups the durable object bindings into two lists:
236
- * those that are defined locally and those that refer to a durable object defined in another script.
237
- */
238
- function partitionDurableObjectBindings(config: Config): {
239
- localBindings: DurableObjectBindings;
240
- remoteBindings: DurableObjectBindings;
241
- } {
242
- const localBindings: DurableObjectBindings = [];
243
- const remoteBindings: DurableObjectBindings = [];
244
- for (const binding of config.durable_objects.bindings) {
245
- if (binding.script_name === undefined) {
246
- localBindings.push(binding);
247
- } else {
248
- remoteBindings.push(binding);
249
- }
250
- }
251
- return { localBindings, remoteBindings };
252
- }
253
-
254
- /**
255
- * Generates some help text based on the Durable Object bindings in a given
256
- * config indicating how the user can add a `script_name` field to bind an
257
- * externally defined Durable Object.
258
- */
259
- function generateAddScriptNameExamples(
260
- localBindings: DurableObjectBindings
261
- ): string {
262
- function exampleScriptName(binding_name: string): string {
263
- return `${binding_name.toLowerCase().replaceAll("_", "-")}-worker`;
264
- }
265
-
266
- return localBindings
267
- .map(({ name, class_name }) => {
268
- const script_name = exampleScriptName(name);
269
- const currentBinding = `{ name = ${name}, class_name = ${class_name} }`;
270
- const fixedBinding = `{ name = ${name}, class_name = ${class_name}, script_name = ${script_name} }`;
271
-
272
- return `${currentBinding} ==> ${fixedBinding}`;
273
- })
274
- .join("\n");
275
- }
276
-
277
- /**
278
- * Generate an appropriate message for when the entry-point is missing.
279
- *
280
- * To be more helpful to developers, we check whether there is a suitable file
281
- * nearby to the expected file path.
282
- */
283
- function getMissingEntryPointMessage(
284
- message: string,
285
- absoluteEntryPointPath: string,
286
- relativeEntryPointPath: string
287
- ): string {
288
- if (
289
- existsSync(absoluteEntryPointPath) &&
290
- statSync(absoluteEntryPointPath).isDirectory()
291
- ) {
292
- // The expected entry-point is a directory, so offer further guidance.
293
- message += `\nThe provided entry-point path, "${relativeEntryPointPath}", points to a directory, rather than a file.\n`;
294
-
295
- // Perhaps we can even guess what the correct path should be...
296
- const possiblePaths: string[] = [];
297
- for (const basenamePath of [
298
- "worker",
299
- "dist/worker",
300
- "index",
301
- "dist/index",
302
- ]) {
303
- for (const extension of [".ts", ".tsx", ".js", ".jsx"]) {
304
- const filePath = basenamePath + extension;
305
- if (fileExists(path.resolve(absoluteEntryPointPath, filePath))) {
306
- possiblePaths.push(path.join(relativeEntryPointPath, filePath));
307
- }
308
- }
309
- }
310
-
311
- if (possiblePaths.length > 0) {
312
- message +=
313
- `\nDid you mean to set the main field to${
314
- possiblePaths.length > 1 ? " one of" : ""
315
- }:\n` +
316
- "```\n" +
317
- possiblePaths.map((filePath) => `main = "./${filePath}"\n`).join("") +
318
- "```";
319
- }
320
- }
321
- return message;
322
- }
@@ -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
- }