wrangler 0.0.0-e64812e → 0.0.0-e8e684c7

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 (214) hide show
  1. package/README.md +27 -3
  2. package/bin/wrangler.js +150 -62
  3. package/kv-asset-handler.js +1 -0
  4. package/miniflare-dist/index.mjs +663 -7
  5. package/package.json +173 -152
  6. package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
  7. package/src/__tests__/config-cache.test.ts +30 -24
  8. package/src/__tests__/configuration.test.ts +4015 -3363
  9. package/src/__tests__/dev.test.tsx +1290 -952
  10. package/src/__tests__/generate.test.ts +91 -0
  11. package/src/__tests__/guess-worker-format.test.ts +68 -68
  12. package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
  13. package/src/__tests__/helpers/mock-account-id.ts +24 -24
  14. package/src/__tests__/helpers/mock-bin.ts +20 -20
  15. package/src/__tests__/helpers/mock-cfetch.ts +179 -94
  16. package/src/__tests__/helpers/mock-console.ts +49 -39
  17. package/src/__tests__/helpers/mock-dialogs.ts +94 -71
  18. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -0
  19. package/src/__tests__/helpers/mock-http-server.ts +30 -30
  20. package/src/__tests__/helpers/mock-istty.ts +65 -18
  21. package/src/__tests__/helpers/mock-known-routes.ts +7 -0
  22. package/src/__tests__/helpers/mock-kv.ts +26 -26
  23. package/src/__tests__/helpers/mock-oauth-flow.ts +223 -228
  24. package/src/__tests__/helpers/mock-process.ts +39 -0
  25. package/src/__tests__/helpers/mock-stdin.ts +82 -77
  26. package/src/__tests__/helpers/mock-web-socket.ts +21 -21
  27. package/src/__tests__/helpers/run-in-tmp.ts +27 -28
  28. package/src/__tests__/helpers/run-wrangler.ts +8 -8
  29. package/src/__tests__/helpers/write-worker-source.ts +16 -16
  30. package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
  31. package/src/__tests__/https-options.test.ts +142 -109
  32. package/src/__tests__/index.test.ts +222 -233
  33. package/src/__tests__/init.test.ts +2139 -1603
  34. package/src/__tests__/jest.setup.ts +114 -34
  35. package/src/__tests__/kv.test.ts +1222 -1032
  36. package/src/__tests__/logger.test.ts +100 -74
  37. package/src/__tests__/metrics.test.ts +450 -0
  38. package/src/__tests__/package-manager.test.ts +303 -303
  39. package/src/__tests__/pages.test.ts +1173 -652
  40. package/src/__tests__/parse.test.ts +252 -252
  41. package/src/__tests__/publish.test.ts +6788 -5301
  42. package/src/__tests__/pubsub.test.ts +367 -0
  43. package/src/__tests__/r2.test.ts +328 -225
  44. package/src/__tests__/route.test.ts +18 -18
  45. package/src/__tests__/secret.test.ts +470 -459
  46. package/src/__tests__/tail.test.ts +676 -564
  47. package/src/__tests__/test-old-node-version.js +31 -0
  48. package/src/__tests__/user.test.ts +136 -112
  49. package/src/__tests__/validate-dev-props.test.ts +56 -0
  50. package/src/__tests__/version.test.ts +35 -0
  51. package/src/__tests__/whoami.test.tsx +267 -83
  52. package/src/__tests__/worker-namespace.test.ts +329 -0
  53. package/src/abort.d.ts +1 -1
  54. package/src/api/dev.ts +93 -0
  55. package/src/api/index.ts +1 -0
  56. package/src/bundle-reporter.tsx +29 -0
  57. package/src/bundle.ts +430 -157
  58. package/src/cfetch/index.ts +80 -80
  59. package/src/cfetch/internal.ts +244 -91
  60. package/src/cli.ts +21 -7
  61. package/src/config/config.ts +224 -195
  62. package/src/config/diagnostics.ts +61 -61
  63. package/src/config/environment.ts +422 -357
  64. package/src/config/index.ts +219 -193
  65. package/src/config/validation-helpers.ts +379 -357
  66. package/src/config/validation.ts +1690 -1367
  67. package/src/config-cache.ts +81 -41
  68. package/src/create-worker-preview.ts +208 -136
  69. package/src/create-worker-upload-form.ts +275 -238
  70. package/src/dev/dev-vars.ts +13 -13
  71. package/src/dev/dev.tsx +477 -351
  72. package/src/dev/local.tsx +426 -295
  73. package/src/dev/remote.tsx +406 -211
  74. package/src/dev/use-esbuild.ts +154 -94
  75. package/src/dev/validate-dev-props.ts +31 -0
  76. package/src/dev-registry.tsx +160 -0
  77. package/src/dev.tsx +696 -0
  78. package/src/dialogs.tsx +97 -97
  79. package/src/dispatch-namespace.ts +206 -0
  80. package/src/durable.ts +87 -87
  81. package/src/entry.ts +234 -228
  82. package/src/environment-variables.ts +23 -23
  83. package/src/errors.ts +6 -6
  84. package/src/faye-websocket.d.ts +6 -0
  85. package/src/generate.ts +131 -0
  86. package/src/git-client.ts +42 -0
  87. package/src/global-wrangler-config-path.ts +26 -0
  88. package/src/https-options.ts +84 -80
  89. package/src/index.tsx +2164 -2768
  90. package/src/init.ts +622 -0
  91. package/src/inspect.ts +678 -593
  92. package/src/intl-polyfill.d.ts +123 -123
  93. package/src/is-ci.ts +14 -0
  94. package/src/is-interactive.ts +12 -0
  95. package/src/kv.ts +299 -277
  96. package/src/logger.ts +46 -39
  97. package/src/metrics/index.ts +5 -0
  98. package/src/metrics/metrics-config.ts +239 -0
  99. package/src/metrics/metrics-dispatcher.ts +96 -0
  100. package/src/metrics/metrics-usage-headers.ts +24 -0
  101. package/src/metrics/send-event.ts +92 -0
  102. package/src/miniflare-cli/assets.ts +554 -0
  103. package/src/miniflare-cli/enum-keys.ts +8 -8
  104. package/src/miniflare-cli/index.ts +198 -32
  105. package/src/miniflare-cli/request-context.ts +18 -18
  106. package/src/module-collection.ts +212 -212
  107. package/src/open-in-browser.ts +4 -6
  108. package/src/package-manager.ts +173 -128
  109. package/src/pages/build.tsx +238 -0
  110. package/src/pages/constants.ts +12 -0
  111. package/src/pages/deployments.tsx +106 -0
  112. package/src/pages/dev.tsx +528 -0
  113. package/src/pages/errors.ts +22 -0
  114. package/src/pages/functions/buildPlugin.ts +109 -0
  115. package/src/pages/functions/buildWorker.ts +155 -0
  116. package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
  117. package/src/pages/functions/filepath-routing.ts +189 -0
  118. package/src/pages/functions/identifiers.ts +78 -0
  119. package/src/pages/functions/routes-consolidation.test.ts +250 -0
  120. package/src/pages/functions/routes-consolidation.ts +73 -0
  121. package/src/pages/functions/routes-transformation.test.ts +271 -0
  122. package/src/pages/functions/routes-transformation.ts +122 -0
  123. package/src/pages/functions/routes.ts +151 -0
  124. package/src/pages/functions.tsx +96 -0
  125. package/src/pages/index.tsx +94 -0
  126. package/src/pages/projects.tsx +169 -0
  127. package/src/pages/publish.tsx +391 -0
  128. package/src/pages/types.ts +49 -0
  129. package/src/pages/upload.tsx +413 -0
  130. package/src/pages/utils.ts +12 -0
  131. package/src/parse.ts +209 -125
  132. package/src/paths.ts +6 -6
  133. package/src/preview.ts +31 -0
  134. package/src/proxy.ts +410 -389
  135. package/src/publish.ts +773 -534
  136. package/src/pubsub/index.ts +286 -0
  137. package/src/pubsub/pubsub-commands.tsx +623 -0
  138. package/src/r2.ts +100 -19
  139. package/src/selfsigned.d.ts +23 -23
  140. package/src/sites.tsx +278 -201
  141. package/src/tail/filters.ts +111 -109
  142. package/src/tail/index.ts +230 -217
  143. package/src/tail/printing.ts +86 -46
  144. package/src/update-check.ts +11 -11
  145. package/src/user/choose-account.tsx +69 -0
  146. package/src/user/env-vars.ts +46 -0
  147. package/src/user/generate-auth-url.ts +33 -0
  148. package/src/user/generate-random-state.ts +16 -0
  149. package/src/user/index.ts +3 -0
  150. package/src/user/user.tsx +1191 -0
  151. package/src/whoami.tsx +141 -42
  152. package/src/worker.ts +123 -99
  153. package/src/zones.ts +167 -0
  154. package/templates/checked-fetch.js +17 -0
  155. package/templates/first-party-worker-module-facade.ts +18 -0
  156. package/templates/format-dev-errors.ts +32 -0
  157. package/templates/new-worker-scheduled.js +3 -3
  158. package/templates/new-worker-scheduled.ts +15 -15
  159. package/templates/new-worker.js +3 -3
  160. package/templates/new-worker.ts +15 -15
  161. package/templates/no-op-worker.js +10 -0
  162. package/templates/pages-shim.ts +9 -0
  163. package/templates/pages-template-plugin.ts +167 -0
  164. package/templates/pages-template-worker.ts +172 -0
  165. package/templates/serve-static-assets.ts +63 -0
  166. package/templates/service-bindings-module-facade.js +54 -0
  167. package/templates/service-bindings-sw-facade.js +42 -0
  168. package/templates/tsconfig.json +95 -95
  169. package/wrangler-dist/cli.d.ts +338 -0
  170. package/wrangler-dist/cli.js +95449 -67524
  171. package/pages/functions/buildPlugin.ts +0 -105
  172. package/pages/functions/buildWorker.ts +0 -151
  173. package/pages/functions/filepath-routing.ts +0 -189
  174. package/pages/functions/identifiers.ts +0 -78
  175. package/pages/functions/routes.ts +0 -156
  176. package/pages/functions/template-plugin.ts +0 -147
  177. package/pages/functions/template-worker.ts +0 -143
  178. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  179. package/src/pages.tsx +0 -2038
  180. package/src/user.tsx +0 -1203
  181. package/templates/static-asset-facade.js +0 -47
  182. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  183. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  184. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  185. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  186. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  187. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  188. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  189. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  190. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  191. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  192. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  193. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  194. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  195. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  196. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  197. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  198. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  199. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  200. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  201. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  202. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  203. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  204. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  205. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  206. package/vendor/wrangler-mime/LICENSE +0 -21
  207. package/vendor/wrangler-mime/Mime.js +0 -97
  208. package/vendor/wrangler-mime/README.md +0 -187
  209. package/vendor/wrangler-mime/cli.js +0 -46
  210. package/vendor/wrangler-mime/index.js +0 -4
  211. package/vendor/wrangler-mime/lite.js +0 -4
  212. package/vendor/wrangler-mime/package.json +0 -52
  213. package/vendor/wrangler-mime/types/other.js +0 -1
  214. package/vendor/wrangler-mime/types/standard.js +0 -1
@@ -2,114 +2,140 @@ import { logger } from "../logger";
2
2
  import { mockConsoleMethods } from "./helpers/mock-console";
3
3
 
4
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(`
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
17
  "▲ [WARNING] This is a warn message
18
18
 
19
19
  "
20
20
  `);
21
- expect(std.err).toMatchInlineSnapshot(`
21
+ expect(std.err).toMatchInlineSnapshot(`
22
22
  "X [ERROR] This is a error message
23
23
 
24
24
  "
25
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(`
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
39
  "▲ [WARNING] This is a warn message
40
40
 
41
41
  "
42
42
  `);
43
- expect(std.err).toMatchInlineSnapshot(`
43
+ expect(std.err).toMatchInlineSnapshot(`
44
44
  "X [ERROR] This is a error message
45
45
 
46
46
  "
47
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(`
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
62
  "▲ [WARNING] This is a warn message
63
63
 
64
64
  "
65
65
  `);
66
- expect(std.err).toMatchInlineSnapshot(`
66
+ expect(std.err).toMatchInlineSnapshot(`
67
67
  "X [ERROR] This is a error message
68
68
 
69
69
  "
70
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(`
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
85
  "▲ [WARNING] This is a warn message
86
86
 
87
87
  "
88
88
  `);
89
- expect(std.err).toMatchInlineSnapshot(`
89
+ expect(std.err).toMatchInlineSnapshot(`
90
90
  "X [ERROR] This is a error message
91
91
 
92
92
  "
93
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(`
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
109
  "X [ERROR] This is a error message
110
110
 
111
111
  "
112
112
  `);
113
- });
114
- });
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
+ });
115
141
  });
@@ -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: home/.wrangler/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
+ }