wrangler 0.0.0-e88a54e → 0.0.0-e8a2a1d9

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 (173) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +47 -16
  3. package/bin/wrangler.js +123 -32
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +155 -86
  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 +17 -0
  11. package/templates/gitignore +172 -0
  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 +137 -0
  17. package/templates/middleware/loader-sw.ts +228 -0
  18. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  19. package/templates/middleware/middleware-miniflare3-json-error.ts +33 -0
  20. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  21. package/templates/middleware/middleware-multiworker-dev.ts +68 -0
  22. package/templates/middleware/middleware-pretty-error.ts +40 -0
  23. package/templates/middleware/middleware-scheduled.ts +15 -0
  24. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  25. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  26. package/templates/modules-watch-stub.js +4 -0
  27. package/templates/new-worker-scheduled.js +17 -0
  28. package/templates/new-worker-scheduled.ts +32 -0
  29. package/templates/new-worker.js +3 -3
  30. package/templates/new-worker.ts +22 -4
  31. package/templates/no-op-worker.js +10 -0
  32. package/templates/pages-dev-pipeline.ts +31 -0
  33. package/templates/pages-dev-util.ts +55 -0
  34. package/templates/pages-shim.ts +9 -0
  35. package/templates/pages-template-plugin.ts +190 -0
  36. package/templates/pages-template-worker.ts +198 -0
  37. package/templates/startDevWorker/InspectorProxyWorker.ts +652 -0
  38. package/templates/startDevWorker/ProxyWorker.ts +252 -0
  39. package/templates/tsconfig-sanity.ts +11 -0
  40. package/templates/tsconfig.init.json +105 -0
  41. package/templates/tsconfig.json +6 -103
  42. package/wrangler-dist/InspectorProxyWorker.js +460 -0
  43. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  44. package/wrangler-dist/ProxyWorker.js +186 -0
  45. package/wrangler-dist/ProxyWorker.js.map +6 -0
  46. package/wrangler-dist/cli.d.ts +23507 -0
  47. package/wrangler-dist/cli.js +152534 -132977
  48. package/wrangler-dist/wasm-sync.wasm +0 -0
  49. package/import_meta_url.js +0 -3
  50. package/miniflare-config-stubs/.env.empty +0 -0
  51. package/miniflare-config-stubs/package.empty.json +0 -1
  52. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  53. package/miniflare-dist/index.mjs +0 -79
  54. package/miniflare-dist/index.mjs.map +0 -7
  55. package/pages/functions/buildWorker.ts +0 -62
  56. package/pages/functions/filepath-routing.test.ts +0 -223
  57. package/pages/functions/filepath-routing.ts +0 -181
  58. package/pages/functions/identifiers.ts +0 -78
  59. package/pages/functions/routes.ts +0 -151
  60. package/pages/functions/template-worker.ts +0 -130
  61. package/src/__tests__/configuration.test.ts +0 -2796
  62. package/src/__tests__/dev.test.tsx +0 -496
  63. package/src/__tests__/dev2.test.tsx +0 -154
  64. package/src/__tests__/guess-worker-format.test.ts +0 -58
  65. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  66. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  67. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  68. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  69. package/src/__tests__/helpers/mock-bin.ts +0 -36
  70. package/src/__tests__/helpers/mock-cfetch.ts +0 -207
  71. package/src/__tests__/helpers/mock-console.ts +0 -70
  72. package/src/__tests__/helpers/mock-dialogs.ts +0 -65
  73. package/src/__tests__/helpers/mock-kv.ts +0 -33
  74. package/src/__tests__/helpers/mock-stdin.ts +0 -103
  75. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  76. package/src/__tests__/helpers/run-in-tmp.ts +0 -32
  77. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  78. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  79. package/src/__tests__/https-options.test.ts +0 -127
  80. package/src/__tests__/index.test.ts +0 -991
  81. package/src/__tests__/jest.setup.ts +0 -69
  82. package/src/__tests__/kv.test.ts +0 -1382
  83. package/src/__tests__/logout.test.ts +0 -52
  84. package/src/__tests__/package-manager.test.ts +0 -206
  85. package/src/__tests__/pages.test.ts +0 -44
  86. package/src/__tests__/parse.test.ts +0 -322
  87. package/src/__tests__/publish.test.ts +0 -2704
  88. package/src/__tests__/r2.test.ts +0 -198
  89. package/src/__tests__/route.test.ts +0 -45
  90. package/src/__tests__/secret.test.ts +0 -425
  91. package/src/__tests__/sentry.test.ts +0 -146
  92. package/src/__tests__/tail.test.ts +0 -564
  93. package/src/__tests__/whoami.test.tsx +0 -100
  94. package/src/bundle.ts +0 -142
  95. package/src/cfetch/index.ts +0 -104
  96. package/src/cfetch/internal.ts +0 -139
  97. package/src/cli.ts +0 -19
  98. package/src/config/README.md +0 -107
  99. package/src/config/config.ts +0 -218
  100. package/src/config/diagnostics.ts +0 -80
  101. package/src/config/environment.ts +0 -366
  102. package/src/config/index.ts +0 -62
  103. package/src/config/validation-helpers.ts +0 -486
  104. package/src/config/validation.ts +0 -1090
  105. package/src/create-worker-preview.ts +0 -166
  106. package/src/create-worker-upload-form.ts +0 -217
  107. package/src/dev/dev.tsx +0 -364
  108. package/src/dev/local.tsx +0 -232
  109. package/src/dev/remote.tsx +0 -203
  110. package/src/dev/use-esbuild.ts +0 -100
  111. package/src/dialogs.tsx +0 -77
  112. package/src/entry.ts +0 -208
  113. package/src/environment-variables.ts +0 -33
  114. package/src/https-options.ts +0 -122
  115. package/src/index.tsx +0 -2373
  116. package/src/inspect.ts +0 -617
  117. package/src/kv.ts +0 -319
  118. package/src/miniflare-cli/README.md +0 -30
  119. package/src/miniflare-cli/enum-keys.ts +0 -17
  120. package/src/miniflare-cli/index.ts +0 -37
  121. package/src/module-collection.ts +0 -258
  122. package/src/open-in-browser.ts +0 -25
  123. package/src/package-manager.ts +0 -126
  124. package/src/pages.tsx +0 -1047
  125. package/src/parse.ts +0 -183
  126. package/src/paths.ts +0 -26
  127. package/src/proxy.ts +0 -440
  128. package/src/publish.ts +0 -347
  129. package/src/r2.ts +0 -50
  130. package/src/reporting.ts +0 -131
  131. package/src/selfsigned.d.ts +0 -29
  132. package/src/sites.tsx +0 -280
  133. package/src/tail/filters.ts +0 -279
  134. package/src/tail/index.ts +0 -299
  135. package/src/tail/printing.ts +0 -62
  136. package/src/user.tsx +0 -1118
  137. package/src/whoami.tsx +0 -69
  138. package/src/worker.ts +0 -163
  139. package/templates/static-asset-facade.js +0 -47
  140. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  141. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  142. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  143. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  144. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  145. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  146. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  147. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  148. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  149. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  150. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  151. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  152. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  153. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  154. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  155. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  156. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  157. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  158. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  159. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  160. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  161. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  162. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  163. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  164. package/vendor/wrangler-mime/LICENSE +0 -21
  165. package/vendor/wrangler-mime/Mime.js +0 -97
  166. package/vendor/wrangler-mime/README.md +0 -187
  167. package/vendor/wrangler-mime/cli.js +0 -46
  168. package/vendor/wrangler-mime/index.js +0 -4
  169. package/vendor/wrangler-mime/lite.js +0 -4
  170. package/vendor/wrangler-mime/package.json +0 -52
  171. package/vendor/wrangler-mime/types/other.js +0 -1
  172. package/vendor/wrangler-mime/types/standard.js +0 -1
  173. package/wrangler-dist/cli.js.map +0 -7
@@ -1,203 +0,0 @@
1
- import assert from "node:assert";
2
- import { readFile } from "node:fs/promises";
3
- import path from "node:path";
4
- import { useState, useEffect, useRef } from "react";
5
- import { createWorkerPreview } from "../create-worker-preview";
6
- import useInspector from "../inspect";
7
- import { usePreviewServer } from "../proxy";
8
- import { syncAssets } from "../sites";
9
- import type { CfPreviewToken } from "../create-worker-preview";
10
- import type { AssetPaths } from "../sites";
11
- import type { CfModule, CfWorkerInit, CfScriptFormat } from "../worker";
12
- import type { EsbuildBundle } from "./use-esbuild";
13
-
14
- export function Remote(props: {
15
- name: string | undefined;
16
- bundle: EsbuildBundle | undefined;
17
- format: CfScriptFormat | undefined;
18
- public: undefined | string;
19
- assetPaths: undefined | AssetPaths;
20
- port: number;
21
- ip: string;
22
- localProtocol: "https" | "http";
23
- inspectorPort: number;
24
- accountId: undefined | string;
25
- apiToken: undefined | string;
26
- bindings: CfWorkerInit["bindings"];
27
- compatibilityDate: string | undefined;
28
- compatibilityFlags: undefined | string[];
29
- usageModel: undefined | "bundled" | "unbound";
30
- env: string | undefined;
31
- legacyEnv: boolean | undefined;
32
- zone: { id: string; host: string } | undefined;
33
- }) {
34
- assert(props.accountId, "accountId is required");
35
- assert(props.apiToken, "apiToken is required");
36
- const previewToken = useWorker({
37
- name: props.name,
38
- bundle: props.bundle,
39
- format: props.format,
40
- modules: props.bundle ? props.bundle.modules : [],
41
- accountId: props.accountId,
42
- apiToken: props.apiToken,
43
- bindings: props.bindings,
44
- assetPaths: props.assetPaths,
45
- port: props.port,
46
- compatibilityDate: props.compatibilityDate,
47
- compatibilityFlags: props.compatibilityFlags,
48
- usageModel: props.usageModel,
49
- env: props.env,
50
- legacyEnv: props.legacyEnv,
51
- zone: props.zone,
52
- });
53
-
54
- usePreviewServer({
55
- previewToken,
56
- publicRoot: props.public,
57
- localProtocol: props.localProtocol,
58
- localPort: props.port,
59
- ip: props.ip,
60
- });
61
-
62
- useInspector({
63
- inspectorUrl: previewToken ? previewToken.inspectorUrl.href : undefined,
64
- port: props.inspectorPort,
65
- logToTerminal: true,
66
- });
67
- return null;
68
- }
69
-
70
- export function useWorker(props: {
71
- name: string | undefined;
72
- bundle: EsbuildBundle | undefined;
73
- format: CfScriptFormat | undefined;
74
- modules: CfModule[];
75
- accountId: string;
76
- apiToken: string;
77
- bindings: CfWorkerInit["bindings"];
78
- assetPaths: undefined | AssetPaths;
79
- port: number;
80
- compatibilityDate: string | undefined;
81
- compatibilityFlags: string[] | undefined;
82
- usageModel: undefined | "bundled" | "unbound";
83
- env: string | undefined;
84
- legacyEnv: boolean | undefined;
85
- zone: { id: string; host: string } | undefined;
86
- }): CfPreviewToken | undefined {
87
- const {
88
- name,
89
- bundle,
90
- format,
91
- modules,
92
- accountId,
93
- apiToken,
94
- bindings,
95
- assetPaths,
96
- compatibilityDate,
97
- compatibilityFlags,
98
- usageModel,
99
- port,
100
- } = props;
101
- const [token, setToken] = useState<CfPreviewToken | undefined>();
102
-
103
- // This is the most reliable way to detect whether
104
- // something's "happened" in our system; We make a ref and
105
- // mark it once we log our initial message. Refs are vars!
106
- const startedRef = useRef(false);
107
-
108
- useEffect(() => {
109
- async function start() {
110
- setToken(undefined); // reset token in case we're re-running
111
-
112
- if (!bundle || !format) return;
113
-
114
- if (!startedRef.current) {
115
- startedRef.current = true;
116
- } else {
117
- console.log("⎔ Detected changes, restarted server.");
118
- }
119
-
120
- const assets = await syncAssets(
121
- accountId,
122
- // When we're using the newer service environments, we wouldn't
123
- // have added the env name on to the script name. However, we must
124
- // include it in the kv namespace name regardless (since there's no
125
- // concept of service environments for kv namespaces yet).
126
- name + (!props.legacyEnv && props.env ? `-${props.env}` : ""),
127
- assetPaths,
128
- true
129
- ); // TODO: cancellable?
130
-
131
- const content = await readFile(bundle.path, "utf-8");
132
-
133
- const init: CfWorkerInit = {
134
- name,
135
- main: {
136
- name: path.basename(bundle.path),
137
- type: format === "modules" ? "esm" : "commonjs",
138
- content,
139
- },
140
- modules: modules.concat(
141
- assets.manifest
142
- ? {
143
- name: "__STATIC_CONTENT_MANIFEST",
144
- content: JSON.stringify(assets.manifest),
145
- type: "text",
146
- }
147
- : []
148
- ),
149
- bindings: {
150
- ...bindings,
151
- kv_namespaces: (bindings.kv_namespaces || []).concat(
152
- assets.namespace
153
- ? { binding: "__STATIC_CONTENT", id: assets.namespace }
154
- : []
155
- ),
156
- text_blobs: {
157
- ...bindings.text_blobs,
158
- ...(assets.manifest &&
159
- format === "service-worker" && {
160
- __STATIC_CONTENT_MANIFEST: "__STATIC_CONTENT_MANIFEST",
161
- }),
162
- },
163
- },
164
- migrations: undefined, // no migrations in dev
165
- compatibility_date: compatibilityDate,
166
- compatibility_flags: compatibilityFlags,
167
- usage_model: usageModel,
168
- };
169
- setToken(
170
- await createWorkerPreview(
171
- init,
172
- {
173
- accountId,
174
- apiToken,
175
- },
176
- { env: props.env, legacyEnv: props.legacyEnv, zone: props.zone }
177
- )
178
- );
179
- }
180
- start().catch((err) => {
181
- // we want to log the error, but not end the process
182
- // since it could recover after the developer fixes whatever's wrong
183
- console.error("remote worker:", err);
184
- });
185
- }, [
186
- name,
187
- bundle,
188
- format,
189
- accountId,
190
- apiToken,
191
- port,
192
- assetPaths,
193
- compatibilityDate,
194
- compatibilityFlags,
195
- usageModel,
196
- bindings,
197
- modules,
198
- props.env,
199
- props.legacyEnv,
200
- props.zone,
201
- ]);
202
- return token;
203
- }
@@ -1,100 +0,0 @@
1
- import assert from "node:assert";
2
- import { useState, useEffect } from "react";
3
- import { bundleWorker } from "../bundle";
4
- import type { Config } from "../config";
5
- import type { Entry } from "../entry";
6
- import type { CfModule } from "../worker";
7
- import type { WatchMode } from "esbuild";
8
-
9
- export type EsbuildBundle = {
10
- id: number;
11
- path: string;
12
- entry: Entry;
13
- type: "esm" | "commonjs";
14
- modules: CfModule[];
15
- serveAssetsFromWorker: boolean;
16
- };
17
-
18
- export function useEsbuild({
19
- entry,
20
- destination,
21
- staticRoot,
22
- jsxFactory,
23
- jsxFragment,
24
- rules,
25
- serveAssetsFromWorker,
26
- }: {
27
- entry: Entry;
28
- destination: string | undefined;
29
- staticRoot: undefined | string;
30
- jsxFactory: string | undefined;
31
- jsxFragment: string | undefined;
32
- rules: Config["rules"];
33
- serveAssetsFromWorker: boolean;
34
- }): EsbuildBundle | undefined {
35
- const [bundle, setBundle] = useState<EsbuildBundle>();
36
- useEffect(() => {
37
- let stopWatching: (() => void) | undefined = undefined;
38
-
39
- const watchMode: WatchMode = {
40
- async onRebuild(error) {
41
- if (error) console.error("watch build failed:", error);
42
- else {
43
- // nothing really changes here, so let's increment the id
44
- // to change the return object's identity
45
- setBundle((previousBundle) => {
46
- assert(
47
- previousBundle,
48
- "Rebuild triggered with no previous build available"
49
- );
50
- return { ...previousBundle, id: previousBundle.id + 1 };
51
- });
52
- }
53
- },
54
- };
55
-
56
- async function build() {
57
- if (!destination) return;
58
-
59
- const { resolvedEntryPointPath, bundleType, modules, stop } =
60
- await bundleWorker(entry, destination, {
61
- // In dev, we serve assets from the local proxy before we send the request to the worker.
62
- serveAssetsFromWorker: false,
63
- jsxFactory,
64
- jsxFragment,
65
- rules,
66
- watch: watchMode,
67
- });
68
-
69
- // Capture the `stop()` method to use as the `useEffect()` destructor.
70
- stopWatching = stop;
71
-
72
- setBundle({
73
- id: 0,
74
- entry,
75
- path: resolvedEntryPointPath,
76
- type: bundleType,
77
- modules,
78
- serveAssetsFromWorker,
79
- });
80
- }
81
-
82
- build().catch(() => {
83
- // esbuild already logs errors to stderr and we don't want to end the process
84
- // on build errors anyway so this is a no-op error handler
85
- });
86
-
87
- return () => {
88
- stopWatching?.();
89
- };
90
- }, [
91
- entry,
92
- destination,
93
- staticRoot,
94
- jsxFactory,
95
- jsxFragment,
96
- serveAssetsFromWorker,
97
- rules,
98
- ]);
99
- return bundle;
100
- }
package/src/dialogs.tsx DELETED
@@ -1,77 +0,0 @@
1
- import { Box, Text, useInput, render } from "ink";
2
- import TextInput from "ink-text-input";
3
- import * as React from "react";
4
- import { useState } from "react";
5
- type ConfirmProps = {
6
- text: string;
7
- onConfirm: (answer: boolean) => void;
8
- };
9
- function Confirm(props: ConfirmProps) {
10
- useInput((input: string) => {
11
- if (input === "y") {
12
- props.onConfirm(true);
13
- } else if (input === "n") {
14
- props.onConfirm(false);
15
- } else {
16
- console.log("Unrecognised input");
17
- }
18
- });
19
- return (
20
- <Box>
21
- <Text>{props.text} (y/n) </Text>
22
- </Box>
23
- );
24
- }
25
-
26
- export function confirm(text: string): Promise<boolean> {
27
- return new Promise((resolve) => {
28
- const { unmount } = render(
29
- <Confirm
30
- text={text}
31
- onConfirm={(answer: boolean) => {
32
- unmount();
33
- resolve(answer);
34
- }}
35
- />
36
- );
37
- });
38
- }
39
-
40
- type PromptProps = {
41
- text: string;
42
- type?: "text" | "password";
43
- onSubmit: (text: string) => void;
44
- };
45
-
46
- function Prompt(props: PromptProps) {
47
- const [value, setValue] = useState("");
48
-
49
- return (
50
- <Box>
51
- <Text>{props.text} </Text>
52
- <Box>
53
- <TextInput
54
- mask={props.type === "password" ? "*" : undefined}
55
- value={value}
56
- onChange={setValue}
57
- onSubmit={props.onSubmit}
58
- />
59
- </Box>
60
- </Box>
61
- );
62
- }
63
-
64
- export async function prompt(text: string, type: "text" | "password" = "text") {
65
- return new Promise((resolve) => {
66
- const { unmount } = render(
67
- <Prompt
68
- text={text}
69
- type={type}
70
- onSubmit={(inputText) => {
71
- unmount();
72
- resolve(inputText);
73
- }}
74
- />
75
- );
76
- });
77
- }
package/src/entry.ts DELETED
@@ -1,208 +0,0 @@
1
- import assert from "node:assert";
2
- import { existsSync } from "node:fs";
3
- import path from "node:path";
4
- import * as esbuild from "esbuild";
5
- import { execaCommand } from "execa";
6
- import type { Config } from "./config";
7
- import type { CfScriptFormat } from "./worker";
8
- import type { Metafile } from "esbuild";
9
-
10
- /**
11
- * An entry point for the Worker.
12
- *
13
- * It consists not just of a `file`, but also of a `directory` that is used to resolve relative paths.
14
- */
15
- export type Entry = { file: string; directory: string; format: CfScriptFormat };
16
-
17
- /**
18
- * Compute the entry-point for the Worker.
19
- */
20
- export async function getEntry(
21
- args: { script?: string; format?: CfScriptFormat | undefined },
22
- config: Config,
23
- command: string
24
- ): Promise<Entry> {
25
- let file: string;
26
- let directory = process.cwd();
27
- if (args.script) {
28
- // If the script name comes from the command line it is relative to the current working directory.
29
- file = path.resolve(args.script);
30
- } else if (config.main === undefined) {
31
- throw new Error(
32
- `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.`
33
- );
34
- } else {
35
- directory = path.resolve(path.dirname(config.configPath ?? "."));
36
- file = path.resolve(directory, config.main);
37
- }
38
-
39
- await runCustomBuild(file, config.build);
40
-
41
- if (fileExists(file) === false) {
42
- throw new Error(
43
- `Could not resolve "${path.relative(process.cwd(), file)}".`
44
- );
45
- }
46
- const format = await guessWorkerFormat(
47
- file,
48
- directory,
49
- args.format ?? config.build?.upload?.format
50
- );
51
-
52
- if (format === "service-worker" && hasDurableObjectImplementations(config)) {
53
- const errorMessage =
54
- "You seem to be trying to use Durable Objects in a Worker written with Service Worker syntax.";
55
- const addScriptName =
56
- "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:";
57
- const addScriptNameExamples = generateAddScriptNameExamples(config);
58
- const migrateText =
59
- "Alternatively, migrate your worker to ES Module syntax to implement a Durable Object in this Worker:";
60
- const migrateUrl =
61
- "https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/";
62
- throw new Error(
63
- `${errorMessage}\n${addScriptName}\n${addScriptNameExamples}\n${migrateText}\n${migrateUrl}`
64
- );
65
- }
66
-
67
- return { file, directory, format };
68
- }
69
-
70
- export async function runCustomBuild(
71
- expectedEntry: string,
72
- build: Config["build"]
73
- ) {
74
- if (build?.command) {
75
- // TODO: add a deprecation message here?
76
- console.log("running:", build.command);
77
- await execaCommand(build.command, {
78
- shell: true,
79
- stdout: "inherit",
80
- stderr: "inherit",
81
- timeout: 1000 * 30,
82
- ...(build.cwd && { cwd: build.cwd }),
83
- });
84
-
85
- if (fileExists(expectedEntry) === false) {
86
- throw new Error(
87
- `Could not resolve "${path.relative(
88
- process.cwd(),
89
- expectedEntry
90
- )}" after running custom build: ${build.command}`
91
- );
92
- }
93
- }
94
- }
95
-
96
- /**
97
- * A function to "guess" the type of worker.
98
- * We do this by running a lightweight build of the actual script,
99
- * and looking at the metafile generated by esbuild. If it has a default
100
- * export (or really, any exports), that means it's a "modules" worker.
101
- * Else, it's a "service-worker" worker. This seems hacky, but works remarkably
102
- * well in practice.
103
- */
104
- export default async function guessWorkerFormat(
105
- entryFile: string,
106
- entryWorkingDirectory: string,
107
- hint: CfScriptFormat | undefined
108
- ): Promise<CfScriptFormat> {
109
- const result = await esbuild.build({
110
- entryPoints: [entryFile],
111
- absWorkingDir: entryWorkingDirectory,
112
- metafile: true,
113
- bundle: false,
114
- format: "esm",
115
- write: false,
116
- });
117
- // result.metafile is defined because of the `metafile: true` option above.
118
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
119
- const metafile = result.metafile!;
120
- const entryPoints = Object.entries(metafile.outputs).filter(
121
- ([_path, output]) => output.entryPoint !== undefined
122
- );
123
- assert(
124
- entryPoints.length > 0,
125
- `Cannot find entry-point "${entryFile}" in generated bundle.` +
126
- listEntryPoints(entryPoints)
127
- );
128
- assert(
129
- entryPoints.length < 2,
130
- "More than one entry-point found for generated bundle." +
131
- listEntryPoints(entryPoints)
132
- );
133
- const guessedWorkerFormat =
134
- entryPoints[0][1].exports.length > 0 ? "modules" : "service-worker";
135
-
136
- if (hint) {
137
- if (hint !== guessedWorkerFormat) {
138
- if (hint === "service-worker") {
139
- throw new Error(
140
- "You configured this worker to be a 'service-worker', but the file you are trying to build appears to have ES module exports. Please pass `--format modules`, or simply remove the configuration."
141
- );
142
- } else {
143
- throw new Error(
144
- "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."
145
- );
146
- }
147
- }
148
- }
149
- return guessedWorkerFormat;
150
- }
151
-
152
- function listEntryPoints(
153
- outputs: [string, ValueOf<Metafile["outputs"]>][]
154
- ): string {
155
- return outputs.map(([_input, output]) => output.entryPoint).join("\n");
156
- }
157
-
158
- type ValueOf<T> = T[keyof T];
159
-
160
- /**
161
- * Returns true if the given `filePath` exists as-is,
162
- * or if some version of it (by appending a common extension) exists.
163
- */
164
- export function fileExists(filePath: string): boolean {
165
- if (path.extname(filePath) !== "") {
166
- return existsSync(filePath);
167
- }
168
- const base = path.join(path.dirname(filePath), path.basename(filePath));
169
- for (const ext of [".ts", ".tsx", ".js", ".jsx"]) {
170
- if (existsSync(base + ext)) {
171
- return true;
172
- }
173
- }
174
- return false;
175
- }
176
-
177
- /**
178
- * Returns true if the given config contains Durable Object bindings that are implemented
179
- * in this worker instead of being implemented elsewhere, and bound via a `script_name`
180
- * property in wrangler.toml
181
- */
182
- function hasDurableObjectImplementations(config: Config): boolean {
183
- return config.durable_objects.bindings.some(
184
- (binding) => binding.script_name === undefined
185
- );
186
- }
187
-
188
- /**
189
- * Generates some help text based on the Durable Object bindings in a given
190
- * config indicating how the user can add a `script_name` field to bind an
191
- * externally defined Durable Object.
192
- */
193
- function generateAddScriptNameExamples(config: Config): string {
194
- function exampleScriptName(binding_name: string): string {
195
- return `${binding_name.toLowerCase().replaceAll("_", "-")}-worker`;
196
- }
197
-
198
- return config.durable_objects.bindings
199
- .filter((binding) => binding.script_name === undefined)
200
- .map(({ name, class_name }) => {
201
- const script_name = exampleScriptName(name);
202
- const currentBinding = `{ name = ${name}, class_name = ${class_name} }`;
203
- const fixedBinding = `{ name = ${name}, class_name = ${class_name}, script_name = ${script_name} }`;
204
-
205
- return `${currentBinding} ==> ${fixedBinding}`;
206
- })
207
- .join("\n");
208
- }
@@ -1,33 +0,0 @@
1
- /**
2
- * Create a function used to access an environment variable.
3
- *
4
- * This is not memoized to allow us to change the value at runtime, such as in testing.
5
- * A warning is shown if the client is using a deprecated version - but only once.
6
- */
7
- export function getEnvironmentVariableFactory({
8
- variableName,
9
- deprecatedName,
10
- defaultValue,
11
- }: {
12
- variableName: string;
13
- deprecatedName?: string;
14
- defaultValue?: string;
15
- }) {
16
- let hasWarned = false;
17
- return () => {
18
- if (process.env[variableName]) {
19
- return process.env[variableName];
20
- } else if (deprecatedName && process.env[deprecatedName]) {
21
- if (!hasWarned) {
22
- // Only show the warning once.
23
- hasWarned = true;
24
- console.warn(
25
- `Using "${deprecatedName}" environment variable. This is deprecated. Please use "${variableName}", instead.`
26
- );
27
- }
28
- return process.env[deprecatedName];
29
- } else {
30
- return defaultValue;
31
- }
32
- };
33
- }