wrangler 0.0.0-ecc8b172 → 0.0.0-ecded1af1

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 (250) hide show
  1. package/README.md +17 -19
  2. package/bin/wrangler.js +24 -93
  3. package/config-schema.json +3115 -0
  4. package/package.json +197 -190
  5. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  6. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  7. package/templates/__tests__/tsconfig.json +8 -0
  8. package/templates/checked-fetch.js +19 -6
  9. package/templates/facade.d.ts +19 -0
  10. package/templates/gitignore +2 -3
  11. package/templates/init-tests/test-jest-new-worker.js +3 -5
  12. package/templates/init-tests/test-vitest-new-worker.js +4 -6
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +9 -4
  15. package/templates/middleware/loader-modules.ts +94 -44
  16. package/templates/middleware/loader-sw.ts +48 -32
  17. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  18. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  19. package/templates/middleware/middleware-mock-analytics-engine.d.ts +3 -0
  20. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  21. package/templates/middleware/middleware-scheduled.ts +15 -1
  22. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  23. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  24. package/templates/modules-watch-stub.js +4 -0
  25. package/templates/new-worker-scheduled.ts +1 -1
  26. package/templates/new-worker.ts +4 -1
  27. package/templates/pages-dev-pipeline.ts +10 -13
  28. package/templates/pages-dev-util.ts +55 -0
  29. package/templates/pages-shim.ts +1 -1
  30. package/templates/pages-template-plugin.ts +37 -14
  31. package/templates/pages-template-worker.ts +33 -7
  32. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  33. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  34. package/templates/tsconfig-sanity.ts +11 -0
  35. package/templates/tsconfig.init.json +22 -0
  36. package/templates/tsconfig.json +5 -102
  37. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  38. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  39. package/wrangler-dist/ProxyWorker.js +241 -0
  40. package/wrangler-dist/ProxyWorker.js.map +6 -0
  41. package/wrangler-dist/cli.d.ts +26095 -471
  42. package/wrangler-dist/cli.js +178062 -122008
  43. package/wrangler-dist/wasm-sync.wasm +0 -0
  44. package/Cloudflare_CA.pem +0 -18
  45. package/import_meta_url.js +0 -3
  46. package/miniflare-config-stubs/.env.empty +0 -0
  47. package/miniflare-config-stubs/package.empty.json +0 -1
  48. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  49. package/miniflare-dist/index.mjs +0 -6310
  50. package/src/__tests__/api-dev.test.ts +0 -209
  51. package/src/__tests__/api-devregistry.test.js +0 -56
  52. package/src/__tests__/api.test.ts +0 -80
  53. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  54. package/src/__tests__/config-cache.test.ts +0 -42
  55. package/src/__tests__/configuration.test.ts +0 -3864
  56. package/src/__tests__/d1.test.ts +0 -70
  57. package/src/__tests__/delete.test.ts +0 -116
  58. package/src/__tests__/dev.test.tsx +0 -1357
  59. package/src/__tests__/dialogs.test.tsx +0 -40
  60. package/src/__tests__/generate.test.ts +0 -235
  61. package/src/__tests__/get-host-from-url.test.ts +0 -16
  62. package/src/__tests__/guess-worker-format.test.ts +0 -85
  63. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  64. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  65. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  66. package/src/__tests__/helpers/mock-bin.ts +0 -36
  67. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  68. package/src/__tests__/helpers/mock-console.ts +0 -106
  69. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  70. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  71. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  72. package/src/__tests__/helpers/mock-istty.ts +0 -74
  73. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  74. package/src/__tests__/helpers/mock-kv.ts +0 -33
  75. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -252
  76. package/src/__tests__/helpers/mock-process.ts +0 -39
  77. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  78. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  79. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  80. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -36
  81. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  82. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  83. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  84. package/src/__tests__/helpers/msw/index.ts +0 -15
  85. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  86. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  87. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  88. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  89. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  90. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  91. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  92. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  93. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  94. package/src/__tests__/https-options.test.ts +0 -163
  95. package/src/__tests__/index.test.ts +0 -251
  96. package/src/__tests__/init.test.ts +0 -2816
  97. package/src/__tests__/jest.setup.ts +0 -191
  98. package/src/__tests__/kv.test.ts +0 -1675
  99. package/src/__tests__/logger.test.ts +0 -141
  100. package/src/__tests__/metrics.test.ts +0 -450
  101. package/src/__tests__/middleware.scheduled.test.ts +0 -135
  102. package/src/__tests__/middleware.test.ts +0 -726
  103. package/src/__tests__/package-manager.test.ts +0 -353
  104. package/src/__tests__/pages.test.ts +0 -2111
  105. package/src/__tests__/parse.test.ts +0 -330
  106. package/src/__tests__/paths.test.ts +0 -39
  107. package/src/__tests__/publish.test.ts +0 -7119
  108. package/src/__tests__/pubsub.test.ts +0 -367
  109. package/src/__tests__/r2.test.ts +0 -371
  110. package/src/__tests__/route.test.ts +0 -45
  111. package/src/__tests__/secret.test.ts +0 -644
  112. package/src/__tests__/tail.test.ts +0 -800
  113. package/src/__tests__/test-old-node-version.js +0 -31
  114. package/src/__tests__/user.test.ts +0 -155
  115. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  116. package/src/__tests__/validate-dev-props.test.ts +0 -56
  117. package/src/__tests__/version.test.ts +0 -35
  118. package/src/__tests__/whoami.test.tsx +0 -278
  119. package/src/__tests__/worker-namespace.test.ts +0 -321
  120. package/src/abort.d.ts +0 -3
  121. package/src/api/dev.ts +0 -208
  122. package/src/api/index.ts +0 -2
  123. package/src/bundle-reporter.tsx +0 -29
  124. package/src/bundle.ts +0 -756
  125. package/src/cfetch/index.ts +0 -160
  126. package/src/cfetch/internal.ts +0 -263
  127. package/src/cli.ts +0 -29
  128. package/src/config/README.md +0 -107
  129. package/src/config/config.ts +0 -275
  130. package/src/config/diagnostics.ts +0 -80
  131. package/src/config/environment.ts +0 -505
  132. package/src/config/index.ts +0 -293
  133. package/src/config/validation-helpers.ts +0 -597
  134. package/src/config/validation.ts +0 -1930
  135. package/src/config-cache.ts +0 -85
  136. package/src/create-worker-preview.ts +0 -275
  137. package/src/create-worker-upload-form.ts +0 -301
  138. package/src/d1/backups.tsx +0 -212
  139. package/src/d1/create.tsx +0 -54
  140. package/src/d1/delete.tsx +0 -56
  141. package/src/d1/execute.tsx +0 -294
  142. package/src/d1/formatTimeAgo.ts +0 -14
  143. package/src/d1/index.ts +0 -75
  144. package/src/d1/list.tsx +0 -48
  145. package/src/d1/options.ts +0 -12
  146. package/src/d1/types.tsx +0 -14
  147. package/src/d1/utils.ts +0 -39
  148. package/src/delete.ts +0 -86
  149. package/src/deprecated/index.ts +0 -453
  150. package/src/dev/dev-vars.ts +0 -36
  151. package/src/dev/dev.tsx +0 -575
  152. package/src/dev/get-local-persistence-path.tsx +0 -31
  153. package/src/dev/local.tsx +0 -686
  154. package/src/dev/remote.tsx +0 -601
  155. package/src/dev/start-server.ts +0 -506
  156. package/src/dev/use-esbuild.ts +0 -197
  157. package/src/dev/validate-dev-props.ts +0 -31
  158. package/src/dev-registry.tsx +0 -201
  159. package/src/dev.tsx +0 -865
  160. package/src/dialogs.tsx +0 -163
  161. package/src/dispatch-namespace.ts +0 -206
  162. package/src/durable.ts +0 -102
  163. package/src/entry.ts +0 -329
  164. package/src/environment-variables.ts +0 -50
  165. package/src/errors.ts +0 -11
  166. package/src/git-client.ts +0 -124
  167. package/src/global-wrangler-config-path.ts +0 -26
  168. package/src/https-options.ts +0 -127
  169. package/src/index.tsx +0 -582
  170. package/src/init.ts +0 -970
  171. package/src/inspect.ts +0 -747
  172. package/src/intl-polyfill.d.ts +0 -139
  173. package/src/is-ci.ts +0 -14
  174. package/src/is-interactive.ts +0 -12
  175. package/src/kv/helpers.ts +0 -430
  176. package/src/kv/index.ts +0 -645
  177. package/src/logger.ts +0 -80
  178. package/src/metrics/index.ts +0 -5
  179. package/src/metrics/metrics-config.ts +0 -239
  180. package/src/metrics/metrics-dispatcher.ts +0 -96
  181. package/src/metrics/metrics-usage-headers.ts +0 -24
  182. package/src/metrics/send-event.ts +0 -94
  183. package/src/miniflare-cli/README.md +0 -30
  184. package/src/miniflare-cli/assets.ts +0 -215
  185. package/src/miniflare-cli/index.ts +0 -208
  186. package/src/miniflare-cli/request-context.ts +0 -40
  187. package/src/module-collection.ts +0 -267
  188. package/src/open-in-browser.ts +0 -17
  189. package/src/package-manager.ts +0 -219
  190. package/src/pages/build.tsx +0 -238
  191. package/src/pages/constants.ts +0 -16
  192. package/src/pages/deployments.tsx +0 -106
  193. package/src/pages/dev.tsx +0 -689
  194. package/src/pages/errors.ts +0 -66
  195. package/src/pages/functions/buildPlugin.ts +0 -110
  196. package/src/pages/functions/buildWorker.ts +0 -156
  197. package/src/pages/functions/filepath-routing.test.ts +0 -234
  198. package/src/pages/functions/filepath-routing.ts +0 -189
  199. package/src/pages/functions/identifiers.ts +0 -78
  200. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  201. package/src/pages/functions/routes-consolidation.ts +0 -73
  202. package/src/pages/functions/routes-transformation.test.ts +0 -282
  203. package/src/pages/functions/routes-transformation.ts +0 -115
  204. package/src/pages/functions/routes-validation.test.ts +0 -403
  205. package/src/pages/functions/routes-validation.ts +0 -202
  206. package/src/pages/functions/routes.ts +0 -151
  207. package/src/pages/functions.tsx +0 -82
  208. package/src/pages/hash.tsx +0 -13
  209. package/src/pages/index.tsx +0 -94
  210. package/src/pages/projects.tsx +0 -169
  211. package/src/pages/publish.tsx +0 -436
  212. package/src/pages/types.ts +0 -49
  213. package/src/pages/upload.tsx +0 -398
  214. package/src/pages/utils.ts +0 -12
  215. package/src/parse.ts +0 -286
  216. package/src/paths.ts +0 -71
  217. package/src/proxy.ts +0 -657
  218. package/src/publish/index.ts +0 -267
  219. package/src/publish/publish.ts +0 -913
  220. package/src/pubsub/index.ts +0 -286
  221. package/src/pubsub/pubsub-commands.tsx +0 -623
  222. package/src/r2/helpers.ts +0 -131
  223. package/src/r2/index.ts +0 -277
  224. package/src/routes.ts +0 -140
  225. package/src/secret/index.ts +0 -403
  226. package/src/selfsigned.d.ts +0 -29
  227. package/src/sites.tsx +0 -372
  228. package/src/tail/createTail.ts +0 -315
  229. package/src/tail/filters.ts +0 -277
  230. package/src/tail/index.ts +0 -217
  231. package/src/tail/printing.ts +0 -107
  232. package/src/update-check.ts +0 -19
  233. package/src/user/choose-account.tsx +0 -69
  234. package/src/user/env-vars.ts +0 -46
  235. package/src/user/generate-auth-url.ts +0 -33
  236. package/src/user/generate-random-state.ts +0 -16
  237. package/src/user/index.ts +0 -3
  238. package/src/user/user.tsx +0 -1192
  239. package/src/utils/collectKeyValues.ts +0 -14
  240. package/src/whoami.tsx +0 -169
  241. package/src/worker.ts +0 -234
  242. package/src/yargs-types.ts +0 -7
  243. package/src/zones.ts +0 -165
  244. package/templates/d1-beta-facade.js +0 -174
  245. package/templates/experimental-local-cache-stubs.js +0 -27
  246. package/templates/first-party-worker-module-facade.ts +0 -18
  247. package/templates/format-dev-errors.ts +0 -32
  248. package/templates/serve-static-assets.ts +0 -63
  249. package/templates/service-bindings-module-facade.js +0 -54
  250. package/templates/service-bindings-sw-facade.js +0 -42
@@ -1,141 +0,0 @@
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,450 +0,0 @@
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
- }