wrangler 0.0.0-eb22835 → 0.0.0-eb75413e

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 (180) hide show
  1. package/README.md +27 -3
  2. package/bin/wrangler.js +150 -62
  3. package/miniflare-dist/index.mjs +663 -7
  4. package/package.json +171 -154
  5. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  6. package/src/__tests__/config-cache.test.ts +30 -24
  7. package/src/__tests__/configuration.test.ts +4015 -3476
  8. package/src/__tests__/dev.test.tsx +1288 -982
  9. package/src/__tests__/generate.test.ts +91 -0
  10. package/src/__tests__/guess-worker-format.test.ts +68 -68
  11. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  12. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  13. package/src/__tests__/helpers/mock-bin.ts +20 -20
  14. package/src/__tests__/helpers/mock-cfetch.ts +179 -94
  15. package/src/__tests__/helpers/mock-console.ts +49 -39
  16. package/src/__tests__/helpers/mock-dialogs.ts +94 -71
  17. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  18. package/src/__tests__/helpers/mock-istty.ts +65 -18
  19. package/src/__tests__/helpers/mock-kv.ts +26 -26
  20. package/src/__tests__/helpers/mock-oauth-flow.ts +223 -228
  21. package/src/__tests__/helpers/mock-process.ts +39 -0
  22. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  23. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  24. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  25. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  26. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  27. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  28. package/src/__tests__/https-options.test.ts +142 -109
  29. package/src/__tests__/index.test.ts +222 -234
  30. package/src/__tests__/init.test.ts +2139 -1606
  31. package/src/__tests__/jest.setup.ts +109 -59
  32. package/src/__tests__/kv.test.ts +1222 -1032
  33. package/src/__tests__/logger.test.ts +100 -74
  34. package/src/__tests__/metrics.test.ts +450 -0
  35. package/src/__tests__/package-manager.test.ts +303 -303
  36. package/src/__tests__/pages.test.ts +1173 -652
  37. package/src/__tests__/parse.test.ts +252 -252
  38. package/src/__tests__/publish.test.ts +6720 -5627
  39. package/src/__tests__/pubsub.test.ts +367 -0
  40. package/src/__tests__/r2.test.ts +328 -225
  41. package/src/__tests__/route.test.ts +18 -18
  42. package/src/__tests__/secret.test.ts +470 -459
  43. package/src/__tests__/tail.test.ts +678 -564
  44. package/src/__tests__/test-old-node-version.js +31 -0
  45. package/src/__tests__/user.test.ts +135 -112
  46. package/src/__tests__/validate-dev-props.test.ts +56 -0
  47. package/src/__tests__/version.test.ts +35 -0
  48. package/src/__tests__/whoami.test.tsx +267 -117
  49. package/src/__tests__/worker-namespace.test.ts +329 -0
  50. package/src/abort.d.ts +1 -1
  51. package/src/api/dev.ts +93 -0
  52. package/src/api/index.ts +1 -0
  53. package/src/bundle-reporter.tsx +29 -0
  54. package/src/bundle.ts +430 -161
  55. package/src/cfetch/index.ts +80 -80
  56. package/src/cfetch/internal.ts +180 -85
  57. package/src/cli.ts +21 -7
  58. package/src/config/config.ts +224 -195
  59. package/src/config/diagnostics.ts +61 -61
  60. package/src/config/environment.ts +422 -357
  61. package/src/config/index.ts +219 -193
  62. package/src/config/validation-helpers.ts +379 -366
  63. package/src/config/validation.ts +1690 -1376
  64. package/src/config-cache.ts +81 -41
  65. package/src/create-worker-preview.ts +208 -136
  66. package/src/create-worker-upload-form.ts +272 -238
  67. package/src/dev/dev-vars.ts +13 -13
  68. package/src/dev/dev.tsx +474 -324
  69. package/src/dev/local.tsx +426 -298
  70. package/src/dev/remote.tsx +405 -224
  71. package/src/dev/use-esbuild.ts +154 -91
  72. package/src/dev/validate-dev-props.ts +31 -0
  73. package/src/dev-registry.tsx +160 -0
  74. package/src/dev.tsx +624 -0
  75. package/src/dialogs.tsx +97 -97
  76. package/src/dispatch-namespace.ts +206 -0
  77. package/src/durable.ts +87 -87
  78. package/src/entry.ts +234 -228
  79. package/src/environment-variables.ts +23 -23
  80. package/src/errors.ts +6 -6
  81. package/src/faye-websocket.d.ts +6 -0
  82. package/src/generate.ts +131 -0
  83. package/src/git-client.ts +42 -0
  84. package/src/global-wrangler-config-path.ts +26 -0
  85. package/src/https-options.ts +84 -80
  86. package/src/index.tsx +2134 -2762
  87. package/src/init.ts +622 -0
  88. package/src/inspect.ts +678 -593
  89. package/src/intl-polyfill.d.ts +123 -123
  90. package/src/is-ci.ts +14 -0
  91. package/src/is-interactive.ts +12 -0
  92. package/src/kv.ts +299 -277
  93. package/src/logger.ts +46 -39
  94. package/src/metrics/index.ts +5 -0
  95. package/src/metrics/metrics-config.ts +239 -0
  96. package/src/metrics/metrics-dispatcher.ts +96 -0
  97. package/src/metrics/metrics-usage-headers.ts +24 -0
  98. package/src/metrics/send-event.ts +92 -0
  99. package/src/miniflare-cli/assets.ts +554 -0
  100. package/src/miniflare-cli/enum-keys.ts +8 -8
  101. package/src/miniflare-cli/index.ts +198 -32
  102. package/src/miniflare-cli/request-context.ts +18 -18
  103. package/src/module-collection.ts +212 -212
  104. package/src/open-in-browser.ts +4 -4
  105. package/src/package-manager.ts +173 -128
  106. package/src/pages/build.tsx +238 -0
  107. package/src/pages/constants.ts +12 -0
  108. package/src/pages/deployments.tsx +106 -0
  109. package/src/pages/dev.tsx +528 -0
  110. package/src/pages/errors.ts +22 -0
  111. package/src/pages/functions/buildPlugin.ts +109 -0
  112. package/src/pages/functions/buildWorker.ts +155 -0
  113. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  114. package/src/pages/functions/filepath-routing.ts +189 -0
  115. package/src/pages/functions/identifiers.ts +78 -0
  116. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  117. package/src/pages/functions/routes-consolidation.ts +73 -0
  118. package/src/pages/functions/routes-transformation.test.ts +271 -0
  119. package/src/pages/functions/routes-transformation.ts +122 -0
  120. package/src/pages/functions/routes.ts +151 -0
  121. package/src/pages/functions.tsx +96 -0
  122. package/src/pages/index.tsx +94 -0
  123. package/src/pages/projects.tsx +169 -0
  124. package/src/pages/publish.tsx +391 -0
  125. package/src/pages/types.ts +49 -0
  126. package/src/pages/upload.tsx +413 -0
  127. package/src/pages/utils.ts +12 -0
  128. package/src/parse.ts +208 -125
  129. package/src/paths.ts +6 -6
  130. package/src/preview.ts +31 -0
  131. package/src/proxy.ts +410 -402
  132. package/src/publish.ts +736 -650
  133. package/src/pubsub/index.ts +286 -0
  134. package/src/pubsub/pubsub-commands.tsx +623 -0
  135. package/src/r2.ts +100 -19
  136. package/src/selfsigned.d.ts +23 -23
  137. package/src/sites.tsx +271 -225
  138. package/src/tail/filters.ts +111 -109
  139. package/src/tail/index.ts +230 -217
  140. package/src/tail/printing.ts +86 -46
  141. package/src/update-check.ts +11 -11
  142. package/src/user/choose-account.tsx +69 -0
  143. package/src/user/env-vars.ts +46 -0
  144. package/src/user/generate-auth-url.ts +33 -0
  145. package/src/user/generate-random-state.ts +16 -0
  146. package/src/user/index.ts +3 -0
  147. package/src/user/user.tsx +1191 -0
  148. package/src/whoami.tsx +141 -43
  149. package/src/worker.ts +122 -100
  150. package/src/zones.ts +132 -38
  151. package/templates/checked-fetch.js +17 -0
  152. package/templates/first-party-worker-module-facade.ts +18 -0
  153. package/templates/format-dev-errors.ts +32 -0
  154. package/templates/new-worker-scheduled.js +3 -3
  155. package/templates/new-worker-scheduled.ts +15 -15
  156. package/templates/new-worker.js +3 -3
  157. package/templates/new-worker.ts +15 -15
  158. package/templates/no-op-worker.js +10 -0
  159. package/templates/pages-shim.ts +9 -0
  160. package/templates/pages-template-plugin.ts +167 -0
  161. package/templates/pages-template-worker.ts +172 -0
  162. package/templates/serve-static-assets.ts +63 -0
  163. package/templates/service-bindings-module-facade.js +54 -0
  164. package/templates/service-bindings-sw-facade.js +42 -0
  165. package/templates/tsconfig.json +95 -95
  166. package/wrangler-dist/cli.d.ts +338 -0
  167. package/wrangler-dist/cli.js +89430 -65646
  168. package/pages/functions/buildPlugin.ts +0 -105
  169. package/pages/functions/buildWorker.ts +0 -151
  170. package/pages/functions/filepath-routing.ts +0 -189
  171. package/pages/functions/identifiers.ts +0 -78
  172. package/pages/functions/routes.ts +0 -156
  173. package/pages/functions/template-plugin.ts +0 -147
  174. package/pages/functions/template-worker.ts +0 -143
  175. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  176. package/src/generate-auth-url.ts +0 -33
  177. package/src/generate-random-state.ts +0 -16
  178. package/src/pages.tsx +0 -2093
  179. package/src/user.tsx +0 -1202
  180. package/templates/static-asset-facade.js +0 -43
package/README.md CHANGED
@@ -1,4 +1,10 @@
1
- ## ⛅️ wrangler
1
+ <h1 align="center"> ⛅️ wrangler </h1>
2
+ <section align="center" id="shieldio-badges">
3
+ <a href="https://www.npmjs.com/package/wrangler"><img alt="npm" src="https://img.shields.io/npm/dw/wrangler?style=flat-square"></a>
4
+ <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/cloudflare/wrangler2?style=flat-square">
5
+ <img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/w/cloudflare/wrangler2/main?style=flat-square">
6
+ <a href="https://discord.gg/CloudflareDev"><img alt="Discord" src="https://img.shields.io/discord/595317990191398933?color=%23F48120&style=flat-square"></a>
7
+ </section>
2
8
 
3
9
  > This package is for wrangler v2.x, released first in May 2022. If you're looking for v1.x of the `@cloudflare/wrangler` package, visit https://www.npmjs.com/package/@cloudflare/wrangler / https://github.com/cloudflare/wrangler.
4
10
 
@@ -33,11 +39,25 @@ npm run deploy
33
39
  $ npm install wrangler --save-dev
34
40
  ```
35
41
 
42
+ ## Configuration:
43
+
44
+ Wrangler is configured via a `wrangler.toml` file in the project root. When utilizing the `wrangler init` command, a `wrangler.toml` file will be created for you.
45
+
46
+ example:
47
+
48
+ ```toml
49
+ main = "./src/index.ts" # init w/ TypeScript
50
+ name = "my-worker"
51
+ compatibility_date = "YYY-MM-DD"
52
+ ```
53
+
54
+ for more detailed information about configuration, see the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration)
55
+
36
56
  ## Commands
37
57
 
38
58
  ### `wrangler init [name]`
39
59
 
40
- Creates a Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration).
60
+ Creates a Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/#init).
41
61
 
42
62
  ### `wrangler dev`
43
63
 
@@ -61,4 +81,8 @@ For more commands and options, refer to the [documentation](https://developers.c
61
81
 
62
82
  ## Documentation
63
83
 
64
- For the latest Wrangler documentation, [click here](https://6b05b6e1.cloudflare-docs-7ou.pages.dev/workers/wrangler/).
84
+ For the latest Wrangler documentation, [click here](https://developers.cloudflare.com/workers/wrangler/).
85
+
86
+ ```
87
+
88
+ ```
package/bin/wrangler.js CHANGED
@@ -3,78 +3,166 @@ const { spawn } = require("child_process");
3
3
  const path = require("path");
4
4
  const fs = require("fs");
5
5
  const os = require("os");
6
- const semiver = require("semiver");
7
6
 
8
- const MIN_NODE_VERSION = "16.7.0";
7
+ const MIN_NODE_VERSION = "16.13.0";
8
+ const debug =
9
+ process.env["WRANGLER_LOG"] === "debug"
10
+ ? (...args) => console.log(...args)
11
+ : () => {};
9
12
 
10
13
  let wranglerProcess;
11
14
 
12
- async function main() {
13
- if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
14
- // Note Volta and nvm are also recommended in the official docs:
15
- // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
16
- console.error(
17
- `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
18
- You should use the latest Node.js version if possible, as Cloudflare Workers use a very up-to-date version of V8.
15
+ /**
16
+ * Executes ../wrangler-dist/cli.js
17
+ */
18
+ function runWrangler() {
19
+ if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
20
+ // Note Volta and nvm are also recommended in the official docs:
21
+ // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
22
+ console.error(
23
+ `Wrangler requires at least node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}. Please update your version of node.js.
24
+
19
25
  Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
20
- );
21
- process.exitCode = 1;
22
- return;
23
- }
24
-
25
- let pathToCACerts = process.env.NODE_EXTRA_CA_CERTS;
26
- if (pathToCACerts) {
27
- // TODO:
28
- // - should we log a warning here?
29
- // - maybe we can generate a certificate that concatenates with ours?
30
- //
31
- // I do think it'll be rare that someone wants to add a cert AND
32
- // use cloudflare WARP, but let's wait till the situation actually
33
- // arises before we do anything about it
34
- } else {
35
- const osTempDir = os.tmpdir();
36
- const certDir = path.join(osTempDir, "wrangler-cert");
37
- const certPath = path.join(certDir, "Cloudflare_CA.pem");
38
- // copy cert to the system temp dir if needed
39
- if (!fs.existsSync(certPath)) {
40
- fs.mkdirSync(certDir, { recursive: true });
41
- fs.writeFileSync(
42
- certPath,
43
- fs.readFileSync(path.join(__dirname, "../Cloudflare_CA.pem"), "utf-8")
44
- );
45
- }
46
- pathToCACerts = certPath;
47
- }
48
-
49
- wranglerProcess = spawn(
50
- process.execPath,
51
- [
52
- ...(semiver(process.versions.node, "18.0.0") >= 0
53
- ? ["--no-experimental-fetch"] // TODO: remove this when https://github.com/cloudflare/wrangler2/issues/834 is properly fixed
54
- : []),
55
- "--no-warnings",
56
- "--experimental-vm-modules",
57
- ...process.execArgv,
58
- path.join(__dirname, "../wrangler-dist/cli.js"),
59
- ...process.argv.slice(2),
60
- ],
61
- {
62
- stdio: "inherit",
63
- env: {
64
- ...process.env,
65
- NODE_EXTRA_CA_CERTS: pathToCACerts,
66
- },
67
- }
68
- ).on("exit", (code) =>
69
- process.exit(code === undefined || code === null ? 0 : code)
70
- );
26
+ );
27
+ process.exitCode = 1;
28
+ return;
29
+ }
30
+
31
+ let pathToCACerts = process.env.NODE_EXTRA_CA_CERTS;
32
+ if (pathToCACerts) {
33
+ // TODO:
34
+ // - should we log a warning here?
35
+ // - maybe we can generate a certificate that concatenates with ours?
36
+ //
37
+ // I do think it'll be rare that someone wants to add a cert AND
38
+ // use Cloudflare WARP, but let's wait till the situation actually
39
+ // arises before we do anything about it
40
+ } else {
41
+ const osTempDir = os.tmpdir();
42
+ const certDir = path.join(osTempDir, "wrangler-cert");
43
+ const certPath = path.join(certDir, "Cloudflare_CA.pem");
44
+ // copy cert to the system temp dir if needed
45
+ if (!fs.existsSync(certPath)) {
46
+ fs.mkdirSync(certDir, { recursive: true });
47
+ fs.writeFileSync(
48
+ certPath,
49
+ fs.readFileSync(path.join(__dirname, "../Cloudflare_CA.pem"), "utf-8")
50
+ );
51
+ }
52
+ pathToCACerts = certPath;
53
+ }
54
+
55
+ return spawn(
56
+ process.execPath,
57
+ [
58
+ "--no-warnings",
59
+ "--experimental-vm-modules",
60
+ ...process.execArgv,
61
+ path.join(__dirname, "../wrangler-dist/cli.js"),
62
+ ...process.argv.slice(2),
63
+ ],
64
+ {
65
+ stdio: "inherit",
66
+ env: {
67
+ ...process.env,
68
+ NODE_EXTRA_CA_CERTS: pathToCACerts,
69
+ },
70
+ }
71
+ ).on("exit", (code) =>
72
+ process.exit(code === undefined || code === null ? 0 : code)
73
+ );
74
+ }
75
+
76
+ /**
77
+ * Runs a locally-installed version of wrangler, delegating from this version.
78
+ * @throws {MODULE_NOT_FOUND} if there isn't a locally installed version of wrangler.
79
+ */
80
+ function runDelegatedWrangler() {
81
+ const packageJsonPath = require.resolve("wrangler/package.json", {
82
+ paths: [process.cwd()],
83
+ });
84
+ const {
85
+ bin: { wrangler: binaryPath },
86
+ version,
87
+ } = JSON.parse(fs.readFileSync(packageJsonPath));
88
+ const resolvedBinaryPath = path.resolve(packageJsonPath, "..", binaryPath);
89
+
90
+ debug(`Delegating to locally-installed version of wrangler @ v${version}`);
91
+
92
+ // this call to `spawn` is simpler because the delegated version will do all
93
+ // of the other work.
94
+ return spawn(
95
+ process.execPath,
96
+ [resolvedBinaryPath, ...process.argv.slice(2)],
97
+ {
98
+ stdio: "inherit",
99
+ }
100
+ ).on("exit", (code) =>
101
+ process.exit(code === undefined || code === null ? 0 : code)
102
+ );
103
+ }
104
+
105
+ /**
106
+ * Indicates if this invocation of `wrangler` should delegate
107
+ * to a locally-installed version.
108
+ */
109
+ function shouldDelegate() {
110
+ try {
111
+ // `require.resolve` will throw if it can't find
112
+ // a locally-installed version of `wrangler`
113
+ const delegatedPackageJson = require.resolve("wrangler/package.json", {
114
+ paths: [process.cwd()],
115
+ });
116
+ const thisPackageJson = path.resolve(__dirname, "..", "package.json");
117
+ // if it's the same path, then we're already a local install -- no need to delegate
118
+ return thisPackageJson !== delegatedPackageJson;
119
+ } catch (e) {
120
+ // there's no local version to delegate to -- `require.resolve` threw
121
+ return false;
122
+ }
123
+ }
124
+
125
+ async function main() {
126
+ wranglerProcess = shouldDelegate() ? runDelegatedWrangler() : runWrangler();
71
127
  }
72
128
 
73
129
  process.on("SIGINT", () => {
74
- wranglerProcess.kill();
130
+ wranglerProcess && wranglerProcess.kill();
75
131
  });
76
132
  process.on("SIGTERM", () => {
77
- wranglerProcess.kill();
133
+ wranglerProcess && wranglerProcess.kill();
78
134
  });
79
135
 
136
+ // semiver implementation via https://github.com/lukeed/semiver/blob/ae7eebe6053c96be63032b14fb0b68e2553fcac4/src/index.js
137
+
138
+ /**
139
+ MIT License
140
+
141
+ Copyright (c) Luke Edwards <luke.edwards05@gmail.com> (lukeed.com)
142
+
143
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
144
+
145
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
146
+
147
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
148
+
149
+ */
150
+
151
+ var fn = new Intl.Collator(0, { numeric: 1 }).compare;
152
+
153
+ function semiver(a, b, bool) {
154
+ a = a.split(".");
155
+ b = b.split(".");
156
+
157
+ return (
158
+ fn(a[0], b[0]) ||
159
+ fn(a[1], b[1]) ||
160
+ ((b[2] = b.slice(2).join(".")),
161
+ (bool = /[.-]/.test((a[2] = a.slice(2).join(".")))),
162
+ bool == /[.-]/.test(b[2]) ? fn(a[2], b[2]) : bool ? -1 : 1)
163
+ );
164
+ }
165
+
166
+ // end semiver implementation
167
+
80
168
  void main();