wrangler 0.0.0-e3e3243 → 0.0.0-e4047cab

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 (310) hide show
  1. package/Cloudflare_CA.pem +18 -0
  2. package/README.md +47 -14
  3. package/bin/wrangler.js +166 -31
  4. package/kv-asset-handler.js +1 -0
  5. package/miniflare-dist/index.mjs +6263 -21
  6. package/package.json +191 -141
  7. package/src/__tests__/access.test.ts +25 -0
  8. package/src/__tests__/api-dev.test.ts +209 -0
  9. package/src/__tests__/api-devregistry.test.js +56 -0
  10. package/src/__tests__/api.test.ts +80 -0
  11. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  12. package/src/__tests__/config-cache.test.ts +42 -0
  13. package/src/__tests__/configuration.test.ts +3971 -2810
  14. package/src/__tests__/d1.test.ts +80 -0
  15. package/src/__tests__/delete.test.ts +263 -0
  16. package/src/__tests__/deployments.test.ts +91 -0
  17. package/src/__tests__/dev.test.tsx +1521 -526
  18. package/src/__tests__/dialogs.test.tsx +40 -0
  19. package/src/__tests__/generate.test.ts +235 -0
  20. package/src/__tests__/get-host-from-url.test.ts +16 -0
  21. package/src/__tests__/guess-worker-format.test.ts +74 -57
  22. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  23. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  24. package/src/__tests__/helpers/mock-bin.ts +20 -20
  25. package/src/__tests__/helpers/mock-cfetch.ts +219 -93
  26. package/src/__tests__/helpers/mock-console.ts +68 -32
  27. package/src/__tests__/helpers/mock-dialogs.ts +121 -33
  28. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  29. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  30. package/src/__tests__/helpers/mock-istty.ts +74 -0
  31. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  32. package/src/__tests__/helpers/mock-kv.ts +27 -27
  33. package/src/__tests__/helpers/mock-oauth-flow.ts +256 -0
  34. package/src/__tests__/helpers/mock-process.ts +39 -0
  35. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  36. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  37. package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
  38. package/src/__tests__/helpers/msw/handlers/deployments.ts +59 -0
  39. package/src/__tests__/helpers/msw/handlers/namespaces.ts +104 -0
  40. package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
  41. package/src/__tests__/helpers/msw/handlers/r2.ts +80 -0
  42. package/src/__tests__/helpers/msw/handlers/script.ts +75 -0
  43. package/src/__tests__/helpers/msw/handlers/user.ts +63 -0
  44. package/src/__tests__/helpers/msw/handlers/zones.ts +22 -0
  45. package/src/__tests__/helpers/msw/index.ts +21 -0
  46. package/src/__tests__/helpers/run-in-tmp.ts +28 -22
  47. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  48. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
  49. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
  50. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
  51. package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
  52. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
  53. package/src/__tests__/helpers/write-worker-source.ts +31 -0
  54. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  55. package/src/__tests__/https-options.test.ts +144 -108
  56. package/src/__tests__/index.test.ts +248 -967
  57. package/src/__tests__/init.test.ts +2900 -0
  58. package/src/__tests__/jest.setup.ts +167 -34
  59. package/src/__tests__/kv.test.ts +1661 -1366
  60. package/src/__tests__/logger.test.ts +141 -0
  61. package/src/__tests__/logout.test.ts +36 -41
  62. package/src/__tests__/metrics.test.ts +450 -0
  63. package/src/__tests__/middleware.scheduled.test.ts +135 -0
  64. package/src/__tests__/middleware.test.ts +726 -0
  65. package/src/__tests__/package-manager.test.ts +312 -165
  66. package/src/__tests__/pages-deployment-tail.test.ts +820 -0
  67. package/src/__tests__/pages.test.ts +2437 -77
  68. package/src/__tests__/parse.test.ts +253 -245
  69. package/src/__tests__/paths.test.ts +39 -0
  70. package/src/__tests__/publish.test.ts +7569 -3445
  71. package/src/__tests__/pubsub.test.ts +370 -0
  72. package/src/__tests__/queues.test.ts +522 -0
  73. package/src/__tests__/r2.test.ts +388 -193
  74. package/src/__tests__/route.test.ts +22 -22
  75. package/src/__tests__/secret.test.ts +626 -407
  76. package/src/__tests__/tail.test.ts +779 -442
  77. package/src/__tests__/test-old-node-version.js +31 -0
  78. package/src/__tests__/type-generation.test.ts +226 -0
  79. package/src/__tests__/user.test.ts +129 -0
  80. package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
  81. package/src/__tests__/validate-dev-props.test.ts +56 -0
  82. package/src/__tests__/version.test.ts +35 -0
  83. package/src/__tests__/whoami.test.tsx +266 -88
  84. package/src/__tests__/worker-namespace.test.ts +326 -0
  85. package/src/abort.d.ts +3 -0
  86. package/src/api/dev.ts +210 -0
  87. package/src/api/index.ts +2 -0
  88. package/src/bundle-reporter.tsx +68 -0
  89. package/src/bundle.ts +791 -123
  90. package/src/cfetch/index.ts +123 -67
  91. package/src/cfetch/internal.ts +216 -92
  92. package/src/cli.ts +23 -14
  93. package/src/config/README.md +1 -1
  94. package/src/config/config.ts +236 -179
  95. package/src/config/diagnostics.ts +61 -61
  96. package/src/config/environment.ts +506 -316
  97. package/src/config/index.ts +310 -38
  98. package/src/config/validation-helpers.ts +385 -342
  99. package/src/config/validation.ts +1970 -1099
  100. package/src/config-cache.ts +85 -0
  101. package/src/create-worker-preview.ts +240 -124
  102. package/src/create-worker-upload-form.ts +300 -201
  103. package/src/d1/backups.tsx +223 -0
  104. package/src/d1/constants.ts +2 -0
  105. package/src/d1/create.tsx +63 -0
  106. package/src/d1/delete.tsx +56 -0
  107. package/src/d1/execute.tsx +352 -0
  108. package/src/d1/formatTimeAgo.ts +14 -0
  109. package/src/d1/index.ts +101 -0
  110. package/src/d1/list.tsx +48 -0
  111. package/src/d1/migrations/apply.tsx +184 -0
  112. package/src/d1/migrations/create.tsx +77 -0
  113. package/src/d1/migrations/helpers.ts +147 -0
  114. package/src/d1/migrations/index.tsx +3 -0
  115. package/src/d1/migrations/list.tsx +79 -0
  116. package/src/d1/migrations/options.ts +18 -0
  117. package/src/d1/options.ts +22 -0
  118. package/src/d1/types.tsx +24 -0
  119. package/src/d1/utils.ts +48 -0
  120. package/src/delete.ts +108 -0
  121. package/src/deployments.ts +77 -0
  122. package/src/deprecated/index.ts +438 -0
  123. package/src/dev/dev-vars.ts +39 -0
  124. package/src/dev/dev.tsx +550 -328
  125. package/src/dev/get-local-persistence-path.tsx +31 -0
  126. package/src/dev/local.tsx +871 -213
  127. package/src/dev/remote.tsx +592 -192
  128. package/src/dev/start-server.ts +539 -0
  129. package/src/dev/use-esbuild.ts +184 -84
  130. package/src/dev/validate-dev-props.ts +31 -0
  131. package/src/dev-registry.tsx +201 -0
  132. package/src/dev.tsx +904 -0
  133. package/src/dialogs.tsx +150 -59
  134. package/src/dispatch-namespace.ts +207 -0
  135. package/src/durable.ts +102 -0
  136. package/src/entry.ts +260 -171
  137. package/src/environment-variables.ts +40 -23
  138. package/src/errors.ts +11 -0
  139. package/src/git-client.ts +124 -0
  140. package/src/global-wrangler-config-path.ts +26 -0
  141. package/src/https-options.ts +85 -80
  142. package/src/index.tsx +639 -2341
  143. package/src/init.ts +970 -0
  144. package/src/inspect.ts +707 -557
  145. package/src/intl-polyfill.d.ts +123 -123
  146. package/src/is-ci.ts +14 -0
  147. package/src/is-interactive.ts +16 -0
  148. package/src/kv/helpers.ts +430 -0
  149. package/src/kv/index.ts +596 -0
  150. package/src/logger.ts +92 -0
  151. package/src/metrics/index.ts +5 -0
  152. package/src/metrics/metrics-config.ts +239 -0
  153. package/src/metrics/metrics-dispatcher.ts +96 -0
  154. package/src/metrics/metrics-usage-headers.ts +24 -0
  155. package/src/metrics/send-event.ts +96 -0
  156. package/src/miniflare-cli/assets.ts +220 -0
  157. package/src/miniflare-cli/index.ts +206 -30
  158. package/src/miniflare-cli/request-context.ts +40 -0
  159. package/src/module-collection.ts +222 -213
  160. package/src/open-in-browser.ts +8 -16
  161. package/src/package-manager.ts +183 -90
  162. package/src/pages/build.tsx +270 -0
  163. package/src/pages/constants.ts +18 -0
  164. package/src/pages/deployment-tails.tsx +284 -0
  165. package/src/pages/deployments.tsx +84 -0
  166. package/src/pages/dev.tsx +706 -0
  167. package/src/pages/errors.ts +66 -0
  168. package/src/pages/functions/buildPlugin.ts +107 -0
  169. package/src/pages/functions/buildWorker.ts +166 -0
  170. package/src/pages/functions/filepath-routing.test.ts +234 -0
  171. package/src/pages/functions/filepath-routing.ts +189 -0
  172. package/src/pages/functions/identifiers.ts +78 -0
  173. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  174. package/src/pages/functions/routes-consolidation.ts +73 -0
  175. package/src/pages/functions/routes-transformation.test.ts +282 -0
  176. package/src/pages/functions/routes-transformation.ts +115 -0
  177. package/src/pages/functions/routes-validation.test.ts +403 -0
  178. package/src/pages/functions/routes-validation.ts +202 -0
  179. package/src/pages/functions/routes.ts +151 -0
  180. package/src/pages/functions.tsx +82 -0
  181. package/src/pages/hash.tsx +13 -0
  182. package/src/pages/index.tsx +102 -0
  183. package/src/pages/projects.tsx +169 -0
  184. package/src/pages/prompt-select-project.tsx +31 -0
  185. package/src/pages/publish.tsx +451 -0
  186. package/src/pages/types.ts +41 -0
  187. package/src/pages/upload.tsx +426 -0
  188. package/src/pages/utils.ts +23 -0
  189. package/src/parse.ts +224 -121
  190. package/src/paths.ts +53 -8
  191. package/src/proxy.ts +629 -375
  192. package/src/publish/index.ts +270 -0
  193. package/src/publish/publish.ts +1035 -0
  194. package/src/pubsub/index.ts +286 -0
  195. package/src/pubsub/pubsub-commands.tsx +624 -0
  196. package/src/queues/cli/commands/consumer/add.ts +71 -0
  197. package/src/queues/cli/commands/consumer/index.ts +22 -0
  198. package/src/queues/cli/commands/consumer/remove.ts +38 -0
  199. package/src/queues/cli/commands/create.ts +25 -0
  200. package/src/queues/cli/commands/delete.ts +26 -0
  201. package/src/queues/cli/commands/index.ts +36 -0
  202. package/src/queues/cli/commands/list.ts +25 -0
  203. package/src/queues/client.ts +135 -0
  204. package/src/queues/utils.ts +18 -0
  205. package/src/r2/constants.ts +4 -0
  206. package/src/r2/helpers.ts +131 -0
  207. package/src/r2/index.ts +289 -0
  208. package/src/routes.ts +140 -0
  209. package/src/secret/index.ts +378 -0
  210. package/src/selfsigned.d.ts +23 -23
  211. package/src/sites.tsx +283 -191
  212. package/src/tail/createTail.ts +379 -0
  213. package/src/tail/filters.ts +108 -110
  214. package/src/tail/index.ts +211 -296
  215. package/src/tail/printing.ts +92 -47
  216. package/src/type-generation.ts +173 -0
  217. package/src/update-check.ts +19 -0
  218. package/src/user/access.ts +69 -0
  219. package/src/user/choose-account.tsx +69 -0
  220. package/src/user/env-vars.ts +46 -0
  221. package/src/user/generate-auth-url.ts +33 -0
  222. package/src/user/generate-random-state.ts +16 -0
  223. package/src/user/index.ts +3 -0
  224. package/src/user/user.tsx +1198 -0
  225. package/src/utils/collectKeyValues.ts +14 -0
  226. package/src/whoami.tsx +142 -42
  227. package/src/worker.ts +182 -100
  228. package/src/yargs-types.ts +24 -0
  229. package/src/zones.ts +191 -0
  230. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  231. package/templates/checked-fetch.js +17 -0
  232. package/templates/d1-beta-facade.js +205 -0
  233. package/templates/first-party-worker-module-facade.ts +18 -0
  234. package/templates/format-dev-errors.ts +32 -0
  235. package/templates/gitignore +171 -0
  236. package/templates/init-tests/test-jest-new-worker.js +25 -0
  237. package/templates/init-tests/test-vitest-new-worker.js +26 -0
  238. package/templates/middleware/common.ts +62 -0
  239. package/templates/middleware/loader-modules.ts +84 -0
  240. package/templates/middleware/loader-sw.ts +227 -0
  241. package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
  242. package/templates/middleware/middleware-pretty-error.ts +40 -0
  243. package/templates/middleware/middleware-scheduled.ts +15 -0
  244. package/templates/new-worker-scheduled.js +17 -0
  245. package/templates/new-worker-scheduled.ts +32 -0
  246. package/templates/new-worker.js +3 -3
  247. package/templates/new-worker.ts +18 -3
  248. package/templates/no-op-worker.js +10 -0
  249. package/templates/pages-dev-pipeline.ts +28 -0
  250. package/templates/pages-dev-util.ts +52 -0
  251. package/templates/pages-shim.ts +9 -0
  252. package/templates/pages-template-plugin.ts +171 -0
  253. package/templates/pages-template-worker.ts +189 -0
  254. package/templates/serve-static-assets.ts +63 -0
  255. package/templates/service-bindings-module-facade.js +54 -0
  256. package/templates/service-bindings-sw-facade.js +42 -0
  257. package/templates/tsconfig.json +96 -95
  258. package/wrangler-dist/cli.d.ts +893 -0
  259. package/wrangler-dist/cli.js +116816 -94969
  260. package/miniflare-dist/index.mjs.map +0 -7
  261. package/pages/functions/buildWorker.ts +0 -62
  262. package/pages/functions/filepath-routing.test.ts +0 -223
  263. package/pages/functions/filepath-routing.ts +0 -181
  264. package/pages/functions/identifiers.ts +0 -78
  265. package/pages/functions/routes.ts +0 -151
  266. package/pages/functions/template-worker.ts +0 -130
  267. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  268. package/src/__tests__/sentry.test.ts +0 -146
  269. package/src/kv.ts +0 -319
  270. package/src/miniflare-cli/enum-keys.ts +0 -17
  271. package/src/pages.tsx +0 -1061
  272. package/src/publish.ts +0 -350
  273. package/src/r2.ts +0 -50
  274. package/src/reporting.ts +0 -131
  275. package/src/user.tsx +0 -1127
  276. package/templates/static-asset-facade.js +0 -47
  277. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  278. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  279. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  280. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  281. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  282. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  283. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  284. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  285. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  286. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  287. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  288. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  289. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  290. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  291. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  292. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  293. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  294. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  295. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  296. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  297. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  298. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  299. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  300. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  301. package/vendor/wrangler-mime/LICENSE +0 -21
  302. package/vendor/wrangler-mime/Mime.js +0 -97
  303. package/vendor/wrangler-mime/README.md +0 -187
  304. package/vendor/wrangler-mime/cli.js +0 -46
  305. package/vendor/wrangler-mime/index.js +0 -4
  306. package/vendor/wrangler-mime/lite.js +0 -4
  307. package/vendor/wrangler-mime/package.json +0 -52
  308. package/vendor/wrangler-mime/types/other.js +0 -1
  309. package/vendor/wrangler-mime/types/standard.js +0 -1
  310. package/wrangler-dist/cli.js.map +0 -7
@@ -0,0 +1,141 @@
1
+ import { logger } from "../logger";
2
+ import { mockConsoleMethods } from "./helpers/mock-console";
3
+
4
+ describe("logger", () => {
5
+ const std = mockConsoleMethods();
6
+
7
+ it("should add colored markers to error and warning messages", () => {
8
+ logger.loggerLevel = "debug";
9
+ logger.debug("This is a debug message");
10
+ logger.log("This is a log message");
11
+ logger.warn("This is a warn message");
12
+ logger.error("This is a error message");
13
+
14
+ expect(std.debug).toMatchInlineSnapshot(`"This is a debug message"`);
15
+ expect(std.out).toMatchInlineSnapshot(`"This is a log message"`);
16
+ expect(std.warn).toMatchInlineSnapshot(`
17
+ "▲ [WARNING] This is a warn message
18
+
19
+ "
20
+ `);
21
+ expect(std.err).toMatchInlineSnapshot(`
22
+ "X [ERROR] This is a error message
23
+
24
+ "
25
+ `);
26
+ });
27
+
28
+ describe("loggerLevel=debug", () => {
29
+ it("should render messages that are at or above the log level set in the logger", () => {
30
+ logger.loggerLevel = "debug";
31
+ logger.debug("This is a debug message");
32
+ logger.log("This is a log message");
33
+ logger.warn("This is a warn message");
34
+ logger.error("This is a error message");
35
+
36
+ expect(std.debug).toMatchInlineSnapshot(`"This is a debug message"`);
37
+ expect(std.out).toMatchInlineSnapshot(`"This is a log message"`);
38
+ expect(std.warn).toMatchInlineSnapshot(`
39
+ "▲ [WARNING] This is a warn message
40
+
41
+ "
42
+ `);
43
+ expect(std.err).toMatchInlineSnapshot(`
44
+ "X [ERROR] This is a error message
45
+
46
+ "
47
+ `);
48
+ });
49
+ });
50
+
51
+ describe("loggerLevel=log", () => {
52
+ it("should render messages that are at or above the log level set in the logger", () => {
53
+ logger.loggerLevel = "log";
54
+ logger.debug("This is a debug message");
55
+ logger.log("This is a log message");
56
+ logger.warn("This is a warn message");
57
+ logger.error("This is a error message");
58
+
59
+ expect(std.debug).toMatchInlineSnapshot(`""`);
60
+ expect(std.out).toMatchInlineSnapshot(`"This is a log message"`);
61
+ expect(std.warn).toMatchInlineSnapshot(`
62
+ "▲ [WARNING] This is a warn message
63
+
64
+ "
65
+ `);
66
+ expect(std.err).toMatchInlineSnapshot(`
67
+ "X [ERROR] This is a error message
68
+
69
+ "
70
+ `);
71
+ });
72
+ });
73
+
74
+ describe("loggerLevel=warn", () => {
75
+ it("should render messages that are at or above the log level set in the logger", () => {
76
+ logger.loggerLevel = "warn";
77
+ logger.debug("This is a debug message");
78
+ logger.log("This is a log message");
79
+ logger.warn("This is a warn message");
80
+ logger.error("This is a error message");
81
+
82
+ expect(std.debug).toMatchInlineSnapshot(`""`);
83
+ expect(std.out).toMatchInlineSnapshot(`""`);
84
+ expect(std.warn).toMatchInlineSnapshot(`
85
+ "▲ [WARNING] This is a warn message
86
+
87
+ "
88
+ `);
89
+ expect(std.err).toMatchInlineSnapshot(`
90
+ "X [ERROR] This is a error message
91
+
92
+ "
93
+ `);
94
+ });
95
+ });
96
+
97
+ describe("loggerLevel=error", () => {
98
+ it("should render messages that are at or above the log level set in the logger", () => {
99
+ logger.loggerLevel = "error";
100
+ logger.debug("This is a debug message");
101
+ logger.log("This is a log message");
102
+ logger.warn("This is a warn message");
103
+ logger.error("This is a error message");
104
+
105
+ expect(std.debug).toMatchInlineSnapshot(`""`);
106
+ expect(std.out).toMatchInlineSnapshot(`""`);
107
+ expect(std.warn).toMatchInlineSnapshot(`""`);
108
+ expect(std.err).toMatchInlineSnapshot(`
109
+ "X [ERROR] This is a error message
110
+
111
+ "
112
+ `);
113
+ });
114
+ });
115
+
116
+ describe("loggerLevelFromEnvVar=error", () => {
117
+ beforeEach(() => {
118
+ process.env.WRANGLER_LOG = "error";
119
+ });
120
+ afterEach(() => {
121
+ process.env.WRANGLER_LOG = undefined;
122
+ });
123
+
124
+ it("should render messages that are at or above the log level set in the env var", () => {
125
+ logger.loggerLevel = "error";
126
+ logger.debug("This is a debug message");
127
+ logger.log("This is a log message");
128
+ logger.warn("This is a warn message");
129
+ logger.error("This is a error message");
130
+
131
+ expect(std.debug).toMatchInlineSnapshot(`""`);
132
+ expect(std.out).toMatchInlineSnapshot(`""`);
133
+ expect(std.warn).toMatchInlineSnapshot(`""`);
134
+ expect(std.err).toMatchInlineSnapshot(`
135
+ "X [ERROR] This is a error message
136
+
137
+ "
138
+ `);
139
+ });
140
+ });
141
+ });
@@ -1,52 +1,47 @@
1
- import { existsSync } from "node:fs";
2
- import os from "node:os";
1
+ import fs from "node:fs";
3
2
  import path from "node:path";
4
- import fetchMock from "jest-fetch-mock";
5
- import {
6
- reinitialiseAuthTokens,
7
- USER_AUTH_CONFIG_FILE,
8
- writeAuthConfigFile,
9
- } from "../user";
3
+ import { rest } from "msw";
4
+ import { getGlobalWranglerConfigPath } from "../global-wrangler-config-path";
5
+ import { USER_AUTH_CONFIG_FILE, writeAuthConfigFile } from "../user";
10
6
  import { mockConsoleMethods } from "./helpers/mock-console";
7
+ import { msw } from "./helpers/msw";
11
8
  import { runInTempDir } from "./helpers/run-in-tmp";
12
9
  import { runWrangler } from "./helpers/run-wrangler";
13
10
 
14
- describe("wrangler", () => {
15
- runInTempDir({ homedir: "./home" });
16
- const std = mockConsoleMethods();
11
+ describe("logout", () => {
12
+ runInTempDir();
13
+ const std = mockConsoleMethods();
17
14
 
18
- describe("logout", () => {
19
- it("should exit with a message stating the user is not logged in", async () => {
20
- await runWrangler("logout");
21
- expect(std.out).toMatchInlineSnapshot(`"Not logged in, exiting..."`);
22
- });
15
+ it("should exit with a message stating the user is not logged in", async () => {
16
+ await runWrangler("logout");
17
+ expect(std.out).toMatchInlineSnapshot(`"Not logged in, exiting..."`);
18
+ });
23
19
 
24
- it("should logout user that has been properly logged in", async () => {
25
- writeAuthConfigFile({
26
- oauth_token: "some-oauth-tok",
27
- refresh_token: "some-refresh-tok",
28
- });
29
- // Mock out the response for a request to revoke the auth tokens,
30
- // checking the form of the request is as expected.
31
- fetchMock.mockResponseOnce(async (req) => {
32
- expect(req.url).toEqual("https://dash.cloudflare.com/oauth2/revoke");
33
- expect(req.method).toEqual("POST");
34
- return "";
35
- });
20
+ it("should logout user that has been properly logged in", async () => {
21
+ writeAuthConfigFile({
22
+ oauth_token: "some-oauth-tok",
23
+ refresh_token: "some-refresh-tok",
24
+ });
25
+ // Make sure that logout removed the config file containing the auth tokens.
26
+ const config = path.join(
27
+ getGlobalWranglerConfigPath(),
28
+ USER_AUTH_CONFIG_FILE
29
+ );
30
+ let counter = 0;
31
+ msw.use(
32
+ rest.post("*/oauth2/revoke", (_, response, context) => {
33
+ // Make sure that we made the request to logout.
34
+ counter += 1;
35
+ response.once(context.status(200), context.text(""));
36
+ })
37
+ );
36
38
 
37
- // Now that we have changed the auth tokens in the wrangler.toml we must reinitialize the user auth state.
38
- reinitialiseAuthTokens();
39
- await runWrangler("logout");
39
+ expect(fs.existsSync(config)).toBeTruthy();
40
40
 
41
- expect(std.out).toMatchInlineSnapshot(`"Successfully logged out."`);
41
+ await runWrangler("logout");
42
42
 
43
- // Make sure that we made the request to logout.
44
- expect(fetchMock).toHaveBeenCalledTimes(1);
45
-
46
- // Make sure that logout removed the config file containing the auth tokens.
47
- expect(existsSync(path.join(os.homedir(), USER_AUTH_CONFIG_FILE))).toBe(
48
- false
49
- );
50
- });
51
- });
43
+ expect(std.out).toMatchInlineSnapshot(`"Successfully logged out."`);
44
+ expect(fs.existsSync(config)).toBeFalsy();
45
+ expect(counter).toBe(1);
46
+ });
52
47
  });
@@ -0,0 +1,450 @@
1
+ import { mkdirSync } from "node:fs";
2
+ import fetchMock from "jest-fetch-mock";
3
+ import { version as wranglerVersion } from "../../package.json";
4
+ import { purgeConfigCaches, saveToConfigCache } from "../config-cache";
5
+ import { CI } from "../is-ci";
6
+ import { logger } from "../logger";
7
+ import { getMetricsDispatcher, getMetricsConfig } from "../metrics";
8
+ import {
9
+ CURRENT_METRICS_DATE,
10
+ readMetricsConfig,
11
+ USER_ID_CACHE_PATH,
12
+ writeMetricsConfig,
13
+ } from "../metrics/metrics-config";
14
+ import { writeAuthConfigFile } from "../user";
15
+ import { setMockResponse, unsetAllMocks } from "./helpers/mock-cfetch";
16
+ import { mockConsoleMethods } from "./helpers/mock-console";
17
+ import { mockConfirm } from "./helpers/mock-dialogs";
18
+ import { useMockIsTTY } from "./helpers/mock-istty";
19
+ import { runInTempDir } from "./helpers/run-in-tmp";
20
+
21
+ declare const global: { SPARROW_SOURCE_KEY: string | undefined };
22
+
23
+ describe("metrics", () => {
24
+ const ORIGINAL_SPARROW_SOURCE_KEY = global.SPARROW_SOURCE_KEY;
25
+ const std = mockConsoleMethods();
26
+ runInTempDir();
27
+
28
+ beforeEach(() => {
29
+ // Tell jest to use the original version of the `getMetricsConfig()` function in these tests.
30
+ const mockMetricsConfig = jest.requireMock("../metrics/metrics-config");
31
+ mockMetricsConfig.useOriginal = true;
32
+ global.SPARROW_SOURCE_KEY = "MOCK_KEY";
33
+ logger.loggerLevel = "debug";
34
+ // Create a node_modules directory to store config-cache files
35
+ mkdirSync("node_modules");
36
+ });
37
+ afterEach(() => {
38
+ global.SPARROW_SOURCE_KEY = ORIGINAL_SPARROW_SOURCE_KEY;
39
+ fetchMock.resetMocks();
40
+ unsetAllMocks();
41
+ purgeConfigCaches();
42
+ });
43
+
44
+ describe("getMetricsDispatcher()", () => {
45
+ const MOCK_DISPATCHER_OPTIONS = {
46
+ // By setting this to true we avoid the `getMetricsConfig()` logic in these tests.
47
+ sendMetrics: true,
48
+ offline: false,
49
+ };
50
+
51
+ // These tests should never hit the `/user` API endpoint.
52
+ const userRequests = mockUserRequest();
53
+ afterEach(() => {
54
+ expect(userRequests.count).toBe(0);
55
+ });
56
+
57
+ describe("identify()", () => {
58
+ it("should send a request to the default URL", async () => {
59
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
60
+ fetchMock.mockResponse("");
61
+ await dispatcher.identify({ a: 1, b: 2 });
62
+ expect(fetchMock).toHaveBeenCalledTimes(1);
63
+ const [url, { body, headers }] = fetchMock.mock.calls[0];
64
+ expect(url).toEqual("https://sparrow.cloudflare.com/api/v1/identify");
65
+ expect(JSON.parse(body)).toEqual(
66
+ expect.objectContaining({
67
+ event: "identify",
68
+ properties: {
69
+ category: "Workers",
70
+ wranglerVersion,
71
+ os: process.platform + ":" + process.arch,
72
+ a: 1,
73
+ b: 2,
74
+ },
75
+ })
76
+ );
77
+ expect(headers).toEqual(
78
+ expect.objectContaining({
79
+ "Sparrow-Source-Key": "MOCK_KEY",
80
+ })
81
+ );
82
+ expect(std.debug).toMatchInlineSnapshot(
83
+ `"Metrics dispatcher: Posting data {\\"type\\":\\"identify\\",\\"name\\":\\"identify\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}"`
84
+ );
85
+ expect(std.out).toMatchInlineSnapshot(`""`);
86
+ expect(std.warn).toMatchInlineSnapshot(`""`);
87
+ expect(std.err).toMatchInlineSnapshot(`""`);
88
+ });
89
+
90
+ it("should write a debug log if the dispatcher is disabled", async () => {
91
+ const dispatcher = await getMetricsDispatcher({
92
+ ...MOCK_DISPATCHER_OPTIONS,
93
+ sendMetrics: false,
94
+ });
95
+ await dispatcher.identify({ a: 1, b: 2 });
96
+ expect(fetchMock).toHaveBeenCalledTimes(0);
97
+ expect(std.debug).toMatchInlineSnapshot(
98
+ `"Metrics dispatcher: Dispatching disabled - would have sent {\\"type\\":\\"identify\\",\\"name\\":\\"identify\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}."`
99
+ );
100
+ expect(std.out).toMatchInlineSnapshot(`""`);
101
+ expect(std.warn).toMatchInlineSnapshot(`""`);
102
+ expect(std.err).toMatchInlineSnapshot(`""`);
103
+ });
104
+
105
+ it("should write a debug log if the request fails", async () => {
106
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
107
+ fetchMock.mockReject(new Error("BAD REQUEST"));
108
+ await dispatcher.identify({ a: 1, b: 2 });
109
+ expect(std.debug).toMatchInlineSnapshot(`
110
+ "Metrics dispatcher: Posting data {\\"type\\":\\"identify\\",\\"name\\":\\"identify\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}
111
+ Metrics dispatcher: Failed to send request: BAD REQUEST"
112
+ `);
113
+ expect(std.out).toMatchInlineSnapshot(`""`);
114
+ expect(std.warn).toMatchInlineSnapshot(`""`);
115
+ expect(std.err).toMatchInlineSnapshot(`""`);
116
+ });
117
+
118
+ it("should write a warning log if no source key has been provided", async () => {
119
+ global.SPARROW_SOURCE_KEY = undefined;
120
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
121
+ await dispatcher.identify({ a: 1, b: 2 });
122
+ expect(fetchMock).toHaveBeenCalledTimes(0);
123
+ expect(std.debug).toMatchInlineSnapshot(
124
+ `"Metrics dispatcher: Source Key not provided. Be sure to initialize before sending events. { type: 'identify', name: 'identify', properties: { a: 1, b: 2 } }"`
125
+ );
126
+ expect(std.out).toMatchInlineSnapshot(`""`);
127
+ expect(std.warn).toMatchInlineSnapshot(`""`);
128
+ expect(std.err).toMatchInlineSnapshot(`""`);
129
+ });
130
+ });
131
+
132
+ describe("sendEvent()", () => {
133
+ it("should send a request to the default URL", async () => {
134
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
135
+ fetchMock.mockResponse("");
136
+ await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
137
+ expect(fetchMock).toHaveBeenCalledTimes(1);
138
+ const [url, { body, headers }] = fetchMock.mock.calls[0];
139
+ expect(url).toEqual("https://sparrow.cloudflare.com/api/v1/event");
140
+ expect(JSON.parse(body)).toEqual(
141
+ expect.objectContaining({
142
+ event: "some-event",
143
+ properties: {
144
+ category: "Workers",
145
+ wranglerVersion,
146
+ os: process.platform + ":" + process.arch,
147
+ a: 1,
148
+ b: 2,
149
+ },
150
+ })
151
+ );
152
+ expect(headers).toEqual(
153
+ expect.objectContaining({
154
+ "Sparrow-Source-Key": "MOCK_KEY",
155
+ })
156
+ );
157
+ expect(std.debug).toMatchInlineSnapshot(
158
+ `"Metrics dispatcher: Posting data {\\"type\\":\\"event\\",\\"name\\":\\"some-event\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}"`
159
+ );
160
+ expect(std.out).toMatchInlineSnapshot(`""`);
161
+ expect(std.warn).toMatchInlineSnapshot(`""`);
162
+ expect(std.err).toMatchInlineSnapshot(`""`);
163
+ });
164
+
165
+ it("should write a debug log if the dispatcher is disabled", async () => {
166
+ const dispatcher = await getMetricsDispatcher({
167
+ ...MOCK_DISPATCHER_OPTIONS,
168
+ sendMetrics: false,
169
+ });
170
+ await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
171
+ expect(fetchMock).toHaveBeenCalledTimes(0);
172
+ expect(std.debug).toMatchInlineSnapshot(
173
+ `"Metrics dispatcher: Dispatching disabled - would have sent {\\"type\\":\\"event\\",\\"name\\":\\"some-event\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}."`
174
+ );
175
+ expect(std.out).toMatchInlineSnapshot(`""`);
176
+ expect(std.warn).toMatchInlineSnapshot(`""`);
177
+ expect(std.err).toMatchInlineSnapshot(`""`);
178
+ });
179
+
180
+ it("should write a debug log if the request fails", async () => {
181
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
182
+ fetchMock.mockReject(new Error("BAD REQUEST"));
183
+ await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
184
+ expect(std.debug).toMatchInlineSnapshot(`
185
+ "Metrics dispatcher: Posting data {\\"type\\":\\"event\\",\\"name\\":\\"some-event\\",\\"properties\\":{\\"a\\":1,\\"b\\":2}}
186
+ Metrics dispatcher: Failed to send request: BAD REQUEST"
187
+ `);
188
+ expect(std.out).toMatchInlineSnapshot(`""`);
189
+ expect(std.warn).toMatchInlineSnapshot(`""`);
190
+ expect(std.err).toMatchInlineSnapshot(`""`);
191
+ });
192
+
193
+ it("should write a warning log if no source key has been provided", async () => {
194
+ global.SPARROW_SOURCE_KEY = undefined;
195
+ const dispatcher = await getMetricsDispatcher(MOCK_DISPATCHER_OPTIONS);
196
+ await dispatcher.sendEvent("some-event", { a: 1, b: 2 });
197
+ expect(fetchMock).toHaveBeenCalledTimes(0);
198
+ expect(std.debug).toMatchInlineSnapshot(
199
+ `"Metrics dispatcher: Source Key not provided. Be sure to initialize before sending events. { type: 'event', name: 'some-event', properties: { a: 1, b: 2 } }"`
200
+ );
201
+ expect(std.out).toMatchInlineSnapshot(`""`);
202
+ expect(std.warn).toMatchInlineSnapshot(`""`);
203
+ expect(std.err).toMatchInlineSnapshot(`""`);
204
+ });
205
+ });
206
+ });
207
+
208
+ describe("getMetricsConfig()", () => {
209
+ let isCISpy: jest.SpyInstance;
210
+
211
+ const { setIsTTY } = useMockIsTTY();
212
+ beforeEach(() => {
213
+ // Default the mock TTY to interactive for all these tests.
214
+ setIsTTY(true);
215
+ isCISpy = jest.spyOn(CI, "isCI").mockReturnValue(false);
216
+ });
217
+
218
+ describe("enabled", () => {
219
+ const ORIGINAL_ENV = process.env;
220
+ beforeEach(() => {
221
+ process.env = { ...ORIGINAL_ENV };
222
+ });
223
+ afterEach(() => {
224
+ process.env = ORIGINAL_ENV;
225
+ });
226
+
227
+ it("should return the WRANGLER_SEND_METRICS environment variable for enabled if it is defined", async () => {
228
+ process.env.WRANGLER_SEND_METRICS = "false";
229
+ expect(await getMetricsConfig({})).toMatchObject({
230
+ enabled: false,
231
+ });
232
+ process.env.WRANGLER_SEND_METRICS = "true";
233
+ expect(await getMetricsConfig({})).toMatchObject({
234
+ enabled: true,
235
+ });
236
+ });
237
+
238
+ it("should return false if running in a CI environment", async () => {
239
+ isCISpy.mockReturnValue(true);
240
+ expect(await getMetricsConfig({})).toMatchObject({
241
+ enabled: false,
242
+ });
243
+ });
244
+
245
+ it("should return the sendMetrics argument for enabled if it is defined", async () => {
246
+ expect(
247
+ await getMetricsConfig({ sendMetrics: false, offline: false })
248
+ ).toMatchObject({
249
+ enabled: false,
250
+ });
251
+ expect(
252
+ await getMetricsConfig({ sendMetrics: true, offline: false })
253
+ ).toMatchObject({
254
+ enabled: true,
255
+ });
256
+ });
257
+
258
+ it("should return enabled false if the process is not interactive", async () => {
259
+ setIsTTY(false);
260
+ expect(
261
+ await getMetricsConfig({
262
+ sendMetrics: undefined,
263
+ offline: false,
264
+ })
265
+ ).toMatchObject({
266
+ enabled: false,
267
+ });
268
+ });
269
+
270
+ it("should return enabled true if the user on this device previously agreed to send metrics", async () => {
271
+ await writeMetricsConfig({
272
+ permission: {
273
+ enabled: true,
274
+ date: new Date(2022, 6, 4),
275
+ },
276
+ });
277
+ expect(
278
+ await getMetricsConfig({
279
+ sendMetrics: undefined,
280
+ offline: false,
281
+ })
282
+ ).toMatchObject({
283
+ enabled: true,
284
+ });
285
+ });
286
+
287
+ it("should return enabled false if the user on this device previously refused to send metrics", async () => {
288
+ await writeMetricsConfig({
289
+ permission: {
290
+ enabled: false,
291
+ date: new Date(2022, 6, 4),
292
+ },
293
+ });
294
+ expect(
295
+ await getMetricsConfig({
296
+ sendMetrics: undefined,
297
+ offline: false,
298
+ })
299
+ ).toMatchObject({
300
+ enabled: false,
301
+ });
302
+ });
303
+
304
+ it("should accept and store permission granting to send metrics if the user agrees", async () => {
305
+ const checkConfirmations = mockConfirm({
306
+ text: "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?",
307
+ result: true,
308
+ });
309
+ expect(
310
+ await getMetricsConfig({
311
+ sendMetrics: undefined,
312
+ offline: false,
313
+ })
314
+ ).toMatchObject({
315
+ enabled: true,
316
+ });
317
+ checkConfirmations();
318
+ expect((await readMetricsConfig()).permission).toMatchObject({
319
+ enabled: true,
320
+ });
321
+ });
322
+
323
+ it("should accept and store permission declining to send metrics if the user declines", async () => {
324
+ const checkConfirmations = mockConfirm({
325
+ text: "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?",
326
+ result: false,
327
+ });
328
+ expect(
329
+ await getMetricsConfig({
330
+ sendMetrics: undefined,
331
+ offline: false,
332
+ })
333
+ ).toMatchObject({
334
+ enabled: false,
335
+ });
336
+ checkConfirmations();
337
+ expect((await readMetricsConfig()).permission).toMatchObject({
338
+ enabled: false,
339
+ });
340
+ });
341
+
342
+ it("should ignore the config if the permission date is older than the current metrics date", async () => {
343
+ const checkConfirmations = mockConfirm({
344
+ text: "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?",
345
+ result: false,
346
+ });
347
+ const OLD_DATE = new Date(2000);
348
+ await writeMetricsConfig({
349
+ permission: { enabled: true, date: OLD_DATE },
350
+ });
351
+ expect(
352
+ await getMetricsConfig({
353
+ sendMetrics: undefined,
354
+ offline: false,
355
+ })
356
+ ).toMatchObject({
357
+ enabled: false,
358
+ });
359
+ checkConfirmations();
360
+ const { permission } = await readMetricsConfig();
361
+ expect(permission?.enabled).toBe(false);
362
+ // The date should be updated to today's date
363
+ expect(permission?.date).toEqual(CURRENT_METRICS_DATE);
364
+
365
+ expect(std.out).toMatchInlineSnapshot(`
366
+ "Usage metrics tracking has changed since you last granted permission.
367
+ Your choice has been saved in the following file: test-xdg-config/metrics.json.
368
+
369
+ You can override the user level setting for a project in \`wrangler.toml\`:
370
+
371
+ - to disable sending metrics for a project: \`send_metrics = false\`
372
+ - to enable sending metrics for a project: \`send_metrics = true\`"
373
+ `);
374
+ });
375
+ });
376
+
377
+ describe("deviceId", () => {
378
+ it("should return a deviceId found in the config file", async () => {
379
+ await writeMetricsConfig({ deviceId: "XXXX-YYYY-ZZZZ" });
380
+ const { deviceId } = await getMetricsConfig({
381
+ sendMetrics: true,
382
+ offline: false,
383
+ });
384
+ expect(deviceId).toEqual("XXXX-YYYY-ZZZZ");
385
+ expect((await readMetricsConfig()).deviceId).toEqual(deviceId);
386
+ });
387
+
388
+ it("should create and store a new deviceId if none is found in the config file", async () => {
389
+ await writeMetricsConfig({});
390
+ const { deviceId } = await getMetricsConfig({
391
+ sendMetrics: true,
392
+ offline: false,
393
+ });
394
+ expect(deviceId).toMatch(
395
+ /[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}/
396
+ );
397
+ expect((await readMetricsConfig()).deviceId).toEqual(deviceId);
398
+ });
399
+ });
400
+
401
+ describe("userId", () => {
402
+ const userRequests = mockUserRequest();
403
+ it("should return a userId found in a cache file", async () => {
404
+ await saveToConfigCache(USER_ID_CACHE_PATH, {
405
+ userId: "CACHED_USER_ID",
406
+ });
407
+ const { userId } = await getMetricsConfig({
408
+ sendMetrics: true,
409
+ offline: false,
410
+ });
411
+ expect(userId).toEqual("CACHED_USER_ID");
412
+ expect(userRequests.count).toBe(0);
413
+ });
414
+
415
+ it("should fetch the userId from Cloudflare and store it in a cache file", async () => {
416
+ writeAuthConfigFile({ oauth_token: "DUMMY_TOKEN" });
417
+ const { userId } = await getMetricsConfig({
418
+ sendMetrics: true,
419
+ offline: false,
420
+ });
421
+ expect(userId).toEqual("MOCK_USER_ID");
422
+ expect(userRequests.count).toBe(1);
423
+ });
424
+
425
+ it("should not fetch the userId from Cloudflare if running in `offline` mode", async () => {
426
+ writeAuthConfigFile({ oauth_token: "DUMMY_TOKEN" });
427
+ const { userId } = await getMetricsConfig({
428
+ sendMetrics: true,
429
+ offline: true,
430
+ });
431
+ expect(userId).toBe(undefined);
432
+ expect(userRequests.count).toBe(0);
433
+ });
434
+ });
435
+ });
436
+ });
437
+
438
+ function mockUserRequest() {
439
+ const requests = { count: 0 };
440
+ beforeEach(() => {
441
+ setMockResponse("/user", () => {
442
+ requests.count++;
443
+ return { id: "MOCK_USER_ID" };
444
+ });
445
+ });
446
+ afterEach(() => {
447
+ requests.count = 0;
448
+ });
449
+ return requests;
450
+ }