wrangler 0.0.0-e9307365 → 0.0.0-e94b46ff7

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 (199) hide show
  1. package/README.md +35 -49
  2. package/bin/wrangler.js +25 -100
  3. package/config-schema.json +2277 -0
  4. package/package.json +182 -172
  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 +23 -0
  12. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +67 -0
  15. package/templates/middleware/loader-modules.ts +134 -0
  16. package/templates/middleware/loader-sw.ts +229 -0
  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-patch-console-prefix.d.ts +3 -0
  22. package/templates/middleware/middleware-patch-console-prefix.ts +21 -0
  23. package/templates/middleware/middleware-pretty-error.ts +40 -0
  24. package/templates/middleware/middleware-scheduled.ts +29 -0
  25. package/templates/modules-watch-stub.js +4 -0
  26. package/templates/new-worker-scheduled.ts +1 -1
  27. package/templates/new-worker.js +1 -1
  28. package/templates/new-worker.ts +4 -1
  29. package/templates/pages-dev-pipeline.ts +33 -0
  30. package/templates/pages-dev-util.ts +55 -0
  31. package/templates/pages-shim.ts +1 -1
  32. package/templates/pages-template-plugin.ts +53 -18
  33. package/templates/pages-template-worker.ts +49 -12
  34. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  35. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  36. package/templates/tsconfig-sanity.ts +11 -0
  37. package/templates/tsconfig.init.json +22 -0
  38. package/templates/tsconfig.json +12 -102
  39. package/templates/tsconfig.tsbuildinfo +1 -0
  40. package/wrangler-dist/InspectorProxyWorker.js +460 -0
  41. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  42. package/wrangler-dist/ProxyWorker.js +238 -0
  43. package/wrangler-dist/ProxyWorker.js.map +6 -0
  44. package/wrangler-dist/cli.d.ts +26533 -167
  45. package/wrangler-dist/cli.js +146609 -141820
  46. package/Cloudflare_CA.pem +0 -18
  47. package/import_meta_url.js +0 -3
  48. package/miniflare-config-stubs/.env.empty +0 -0
  49. package/miniflare-config-stubs/package.empty.json +0 -1
  50. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  51. package/miniflare-dist/index.mjs +0 -5416
  52. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  53. package/src/__tests__/config-cache.test.ts +0 -42
  54. package/src/__tests__/configuration.test.ts +0 -4022
  55. package/src/__tests__/dev.test.tsx +0 -1294
  56. package/src/__tests__/generate.test.ts +0 -93
  57. package/src/__tests__/guess-worker-format.test.ts +0 -85
  58. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  59. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  60. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  61. package/src/__tests__/helpers/mock-bin.ts +0 -36
  62. package/src/__tests__/helpers/mock-cfetch.ts +0 -263
  63. package/src/__tests__/helpers/mock-console.ts +0 -97
  64. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  65. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  66. package/src/__tests__/helpers/mock-istty.ts +0 -74
  67. package/src/__tests__/helpers/mock-kv.ts +0 -33
  68. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -250
  69. package/src/__tests__/helpers/mock-process.ts +0 -39
  70. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  71. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  72. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  73. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  74. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  75. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  76. package/src/__tests__/https-options.test.ts +0 -163
  77. package/src/__tests__/index.test.ts +0 -245
  78. package/src/__tests__/init.test.ts +0 -1992
  79. package/src/__tests__/jest.setup.ts +0 -150
  80. package/src/__tests__/kv.test.ts +0 -1671
  81. package/src/__tests__/logger.test.ts +0 -141
  82. package/src/__tests__/metrics.test.ts +0 -450
  83. package/src/__tests__/package-manager.test.ts +0 -353
  84. package/src/__tests__/pages.test.ts +0 -1261
  85. package/src/__tests__/parse.test.ts +0 -330
  86. package/src/__tests__/publish.test.ts +0 -6914
  87. package/src/__tests__/pubsub.test.ts +0 -367
  88. package/src/__tests__/r2.test.ts +0 -317
  89. package/src/__tests__/route.test.ts +0 -45
  90. package/src/__tests__/secret.test.ts +0 -492
  91. package/src/__tests__/tail.test.ts +0 -698
  92. package/src/__tests__/test-old-node-version.js +0 -31
  93. package/src/__tests__/user.test.ts +0 -144
  94. package/src/__tests__/validate-dev-props.test.ts +0 -56
  95. package/src/__tests__/version.test.ts +0 -35
  96. package/src/__tests__/whoami.test.tsx +0 -289
  97. package/src/__tests__/worker-namespace.test.ts +0 -327
  98. package/src/abort.d.ts +0 -3
  99. package/src/api/dev.ts +0 -86
  100. package/src/api/index.ts +0 -1
  101. package/src/bundle-reporter.tsx +0 -29
  102. package/src/bundle.ts +0 -472
  103. package/src/cfetch/index.ts +0 -121
  104. package/src/cfetch/internal.ts +0 -181
  105. package/src/cli.ts +0 -27
  106. package/src/config/README.md +0 -107
  107. package/src/config/config.ts +0 -263
  108. package/src/config/diagnostics.ts +0 -80
  109. package/src/config/environment.ts +0 -485
  110. package/src/config/index.ts +0 -251
  111. package/src/config/validation-helpers.ts +0 -584
  112. package/src/config/validation.ts +0 -1856
  113. package/src/config-cache.ts +0 -84
  114. package/src/create-worker-preview.ts +0 -257
  115. package/src/create-worker-upload-form.ts +0 -288
  116. package/src/dev/dev-vars.ts +0 -36
  117. package/src/dev/dev.tsx +0 -531
  118. package/src/dev/local.tsx +0 -385
  119. package/src/dev/remote.tsx +0 -413
  120. package/src/dev/use-esbuild.ts +0 -175
  121. package/src/dev/validate-dev-props.ts +0 -31
  122. package/src/dev-registry.tsx +0 -157
  123. package/src/dev.tsx +0 -616
  124. package/src/dialogs.tsx +0 -135
  125. package/src/durable.ts +0 -102
  126. package/src/entry.ts +0 -328
  127. package/src/environment-variables.ts +0 -35
  128. package/src/errors.ts +0 -11
  129. package/src/faye-websocket.d.ts +0 -6
  130. package/src/generate.ts +0 -131
  131. package/src/git-client.ts +0 -42
  132. package/src/global-wrangler-config-path.ts +0 -26
  133. package/src/https-options.ts +0 -127
  134. package/src/index.tsx +0 -2184
  135. package/src/init.ts +0 -549
  136. package/src/inspect.ts +0 -750
  137. package/src/intl-polyfill.d.ts +0 -139
  138. package/src/is-interactive.ts +0 -12
  139. package/src/kv.ts +0 -430
  140. package/src/logger.ts +0 -73
  141. package/src/metrics/index.ts +0 -5
  142. package/src/metrics/is-ci.ts +0 -14
  143. package/src/metrics/metrics-config.ts +0 -239
  144. package/src/metrics/metrics-dispatcher.ts +0 -96
  145. package/src/metrics/metrics-usage-headers.ts +0 -24
  146. package/src/metrics/send-event.ts +0 -92
  147. package/src/miniflare-cli/README.md +0 -30
  148. package/src/miniflare-cli/assets.ts +0 -543
  149. package/src/miniflare-cli/enum-keys.ts +0 -17
  150. package/src/miniflare-cli/index.ts +0 -85
  151. package/src/miniflare-cli/request-context.ts +0 -40
  152. package/src/module-collection.ts +0 -258
  153. package/src/open-in-browser.ts +0 -17
  154. package/src/package-manager.ts +0 -219
  155. package/src/pages/build.tsx +0 -204
  156. package/src/pages/constants.ts +0 -8
  157. package/src/pages/deployments.tsx +0 -106
  158. package/src/pages/dev.tsx +0 -414
  159. package/src/pages/functions/buildPlugin.ts +0 -105
  160. package/src/pages/functions/buildWorker.ts +0 -151
  161. package/src/pages/functions/filepath-routing.test.ts +0 -234
  162. package/src/pages/functions/filepath-routing.ts +0 -189
  163. package/src/pages/functions/identifiers.ts +0 -78
  164. package/src/pages/functions/routes.ts +0 -151
  165. package/src/pages/index.tsx +0 -84
  166. package/src/pages/projects.tsx +0 -163
  167. package/src/pages/publish.tsx +0 -338
  168. package/src/pages/types.ts +0 -40
  169. package/src/pages/upload.tsx +0 -415
  170. package/src/pages/utils.ts +0 -12
  171. package/src/parse.ts +0 -286
  172. package/src/paths.ts +0 -26
  173. package/src/preview.ts +0 -31
  174. package/src/proxy.ts +0 -476
  175. package/src/publish.ts +0 -807
  176. package/src/pubsub/index.ts +0 -286
  177. package/src/pubsub/pubsub-commands.tsx +0 -623
  178. package/src/r2.ts +0 -118
  179. package/src/selfsigned.d.ts +0 -29
  180. package/src/sites.tsx +0 -372
  181. package/src/tail/filters.ts +0 -279
  182. package/src/tail/index.ts +0 -299
  183. package/src/tail/printing.ts +0 -67
  184. package/src/update-check.ts +0 -19
  185. package/src/user/choose-account.tsx +0 -69
  186. package/src/user/env-vars.ts +0 -46
  187. package/src/user/generate-auth-url.ts +0 -33
  188. package/src/user/generate-random-state.ts +0 -16
  189. package/src/user/index.ts +0 -3
  190. package/src/user/user.tsx +0 -1189
  191. package/src/whoami.tsx +0 -169
  192. package/src/worker-namespace.ts +0 -206
  193. package/src/worker.ts +0 -203
  194. package/src/zones.ts +0 -76
  195. package/templates/first-party-worker-module-facade.ts +0 -18
  196. package/templates/format-dev-errors.ts +0 -32
  197. package/templates/serve-static-assets.ts +0 -63
  198. package/templates/service-bindings-module-facade.js +0 -51
  199. package/templates/service-bindings-sw-facade.js +0 -39
@@ -1,239 +0,0 @@
1
- import { randomUUID } from "node:crypto";
2
- import { readFileSync, mkdirSync, writeFileSync } from "node:fs";
3
- import os from "node:os";
4
- import path from "node:path";
5
- import { fetchResult } from "../cfetch";
6
- import { getConfigCache, saveToConfigCache } from "../config-cache";
7
- import { confirm } from "../dialogs";
8
- import { getEnvironmentVariableFactory } from "../environment-variables";
9
- import isInteractive from "../is-interactive";
10
- import { logger } from "../logger";
11
- import { getAPIToken } from "../user";
12
- import { CI } from "./is-ci";
13
-
14
- /**
15
- * The date that the metrics being gathered was last updated in a way that would require
16
- * the user to give their permission again.
17
- *
18
- * When reading from a config file, we check the recorded date in the config file against
19
- * this one here. We ignore the permissions set in the the file if the recorded date is older.
20
- * This allows us to prompt the user to re-opt-in when we make substantive changes to our metrics
21
- * gathering.
22
- */
23
- export const CURRENT_METRICS_DATE = new Date(2022, 6, 4);
24
- export const USER_ID_CACHE_PATH = "user-id.json";
25
-
26
- export const getWranglerSendMetricsFromEnv = getEnvironmentVariableFactory({
27
- variableName: "WRANGLER_SEND_METRICS",
28
- });
29
-
30
- export interface MetricsConfigOptions {
31
- /**
32
- * Defines whether to send metrics to Cloudflare:
33
- * If defined, then use this value for whether the dispatch is enabled.
34
- * Otherwise, infer the enabled value from the user configuration.
35
- */
36
- sendMetrics?: boolean;
37
- /**
38
- * When true, do not make any CF API requests.
39
- */
40
- offline?: boolean;
41
- }
42
-
43
- /**
44
- * The information needed to set up the MetricsDispatcher.
45
- */
46
- export interface MetricsConfig {
47
- /** True if usage tracking is enabled. */
48
- enabled: boolean;
49
- /** A UID that identifies this user and machine pair for Wrangler. */
50
- deviceId: string;
51
- /** The currently logged in user - undefined if not logged in. */
52
- userId: string | undefined;
53
- }
54
-
55
- /**
56
- * Get hold of the permissions and device-id for metrics dispatch.
57
- *
58
- * The device-id is just a unique identifier sent along with events to help
59
- * to collate metrics. Once generated, this id is cached in the metrics config file.
60
- *
61
- * The permissions define whether we can send metrics or not. They can come from a variety of places:
62
- * - the `send_metrics` setting in `wrangler.toml`
63
- * - a cached response from the current user
64
- * - prompting the user to opt-in to metrics
65
- *
66
- * If the user was prompted to opt-in, then their response is cached in the metrics config file.
67
- *
68
- * If the current process is not interactive then we will cannot prompt the user and just assume
69
- * we cannot send metrics if there is no cached or project-level preference available.
70
- */
71
- export async function getMetricsConfig({
72
- sendMetrics,
73
- offline = false,
74
- }: MetricsConfigOptions): Promise<MetricsConfig> {
75
- const config = readMetricsConfig();
76
- const deviceId = getDeviceId(config);
77
- const userId = await getUserId(offline);
78
-
79
- // If the WRANGLER_SEND_METRICS environment variable has been set use that
80
- // and ignore everything else.
81
- const sendMetricsEnv = getWranglerSendMetricsFromEnv();
82
- if (sendMetricsEnv !== undefined) {
83
- return {
84
- enabled: sendMetricsEnv.toLowerCase() === "true",
85
- deviceId,
86
- userId,
87
- };
88
- }
89
-
90
- // If the project is explicitly set the `send_metrics` options in `wrangler.toml`
91
- // then use that and ignore any user preference.
92
- if (sendMetrics !== undefined) {
93
- return { enabled: sendMetrics, deviceId, userId };
94
- }
95
-
96
- // Get the user preference from the metrics config.
97
- const permission = config.permission;
98
- if (permission !== undefined) {
99
- if (new Date(permission.date) >= CURRENT_METRICS_DATE) {
100
- return { enabled: permission.enabled, deviceId, userId };
101
- } else if (permission.enabled) {
102
- logger.log(
103
- "Usage metrics tracking has changed since you last granted permission."
104
- );
105
- }
106
- }
107
-
108
- // We couldn't get the metrics permission from the project-level nor the user-level config.
109
- // If we are not interactive or in a CI build then just bail out.
110
- if (!isInteractive() || CI.isCI()) {
111
- return { enabled: false, deviceId, userId };
112
- }
113
-
114
- // Otherwise, let's ask the user and store the result in the metrics config.
115
- const enabled = await confirm(
116
- "Would you like to help improve Wrangler by sending usage metrics to Cloudflare?"
117
- );
118
- logger.log(
119
- `Your choice has been saved in the following file: ${path.relative(
120
- process.cwd(),
121
- getMetricsConfigPath()
122
- )}.\n\n` +
123
- " You can override the user level setting for a project in `wrangler.toml`:\n\n" +
124
- " - to disable sending metrics for a project: `send_metrics = false`\n" +
125
- " - to enable sending metrics for a project: `send_metrics = true`"
126
- );
127
- writeMetricsConfig({
128
- permission: {
129
- enabled,
130
- date: CURRENT_METRICS_DATE,
131
- },
132
- deviceId,
133
- });
134
- return { enabled, deviceId, userId };
135
- }
136
-
137
- /**
138
- * Stringify and write the given info to the metrics config file.
139
- */
140
- export function writeMetricsConfig(config: MetricsConfigFile) {
141
- mkdirSync(path.dirname(getMetricsConfigPath()), { recursive: true });
142
- writeFileSync(
143
- getMetricsConfigPath(),
144
- JSON.stringify(
145
- config,
146
- (_key, value) => (value instanceof Date ? value.toISOString() : value),
147
- "\t"
148
- )
149
- );
150
- }
151
-
152
- /**
153
- * Read and parse the metrics config file.
154
- */
155
- export function readMetricsConfig(): MetricsConfigFile {
156
- try {
157
- const config = readFileSync(getMetricsConfigPath(), "utf8");
158
- return JSON.parse(config, (key, value) =>
159
- key === "date" ? new Date(value) : value
160
- );
161
- } catch {
162
- return {};
163
- }
164
- }
165
-
166
- /**
167
- * Get the path to the metrics config file.
168
- */
169
- function getMetricsConfigPath(): string {
170
- return path.resolve(os.homedir(), ".wrangler/config/metrics.json");
171
- }
172
-
173
- /**
174
- * The format of the metrics config file.
175
- */
176
- export interface MetricsConfigFile {
177
- permission?: {
178
- /** True if Wrangler should send metrics to Cloudflare. */
179
- enabled: boolean;
180
- /** The date that this permission was set. */
181
- date: Date;
182
- };
183
- /** A unique UUID that identifies this device for metrics purposes. */
184
- deviceId?: string;
185
- }
186
-
187
- /**
188
- * Returns an ID that uniquely identifies Wrangler on this device to help collate events.
189
- *
190
- * Once created this ID is stored in the metrics config file.
191
- */
192
- function getDeviceId(config: MetricsConfigFile) {
193
- // Get or create the deviceId.
194
- const deviceId = config.deviceId ?? randomUUID();
195
- if (config.deviceId === undefined) {
196
- // We had to create a new deviceID so store it now.
197
- writeMetricsConfig({ ...config, deviceId });
198
- }
199
- return deviceId;
200
- }
201
-
202
- /**
203
- * Returns the ID of the current user, which will be sent with each event.
204
- *
205
- * The ID is retrieved from the CF API `/user` endpoint if the user is authenticated and then
206
- * stored in the `node_modules/.cache`.
207
- *
208
- * If it is not possible to retrieve the ID (perhaps the user is not logged in) then we just use
209
- * `undefined`.
210
- */
211
- async function getUserId(offline: boolean) {
212
- // Get the userId from the cache.
213
- // If it has not been found in the cache and we are not offline then make an API call to get it.
214
- // If we can't work in out then just use `anonymous`.
215
- let userId = getConfigCache<{ userId: string }>(USER_ID_CACHE_PATH).userId;
216
- if (userId === undefined && !offline) {
217
- userId = await fetchUserId();
218
- if (userId !== undefined) {
219
- saveToConfigCache(USER_ID_CACHE_PATH, { userId });
220
- }
221
- }
222
- return userId;
223
- }
224
-
225
- /**
226
- * Ask the Cloudflare API for the User ID of the current user.
227
- *
228
- * We will only do this if we are not "offline", e.g. not running `wrangler dev --local`.
229
- * Quietly return undefined if anything goes wrong.
230
- */
231
- async function fetchUserId(): Promise<string | undefined> {
232
- try {
233
- return getAPIToken()
234
- ? (await fetchResult<{ id: string }>("/user")).id
235
- : undefined;
236
- } catch (e) {
237
- return undefined;
238
- }
239
- }
@@ -1,96 +0,0 @@
1
- import { fetch } from "undici";
2
- import { version as wranglerVersion } from "../../package.json";
3
- import { logger } from "../logger";
4
- import { getMetricsConfig } from "./metrics-config";
5
- import type { MetricsConfigOptions } from "./metrics-config";
6
-
7
- // The SPARROW_SOURCE_KEY is provided at esbuild time as a `define` for production and beta
8
- // releases. Otherwise it is left undefined, which automatically disables metrics requests.
9
- declare const SPARROW_SOURCE_KEY: string;
10
- const SPARROW_URL = "https://sparrow.cloudflare.com";
11
-
12
- export async function getMetricsDispatcher(options: MetricsConfigOptions) {
13
- return {
14
- /**
15
- * Dispatch a event to the analytics target.
16
- *
17
- * The event should follow these conventions
18
- * - name is of the form `[action] [object]` (lower case)
19
- * - additional properties are camelCased
20
- */
21
- async sendEvent(name: string, properties: Properties = {}): Promise<void> {
22
- await dispatch({ type: "event", name, properties });
23
- },
24
-
25
- /**
26
- * Dispatch a user profile information to the analytics target.
27
- *
28
- * This call can be used to inform the analytics target of relevant properties associated
29
- * with the current user.
30
- */
31
- async identify(properties: Properties): Promise<void> {
32
- await dispatch({ type: "identify", name: "identify", properties });
33
- },
34
- };
35
-
36
- async function dispatch(event: {
37
- type: "identify" | "event";
38
- name: string;
39
- properties: Properties;
40
- }): Promise<void> {
41
- if (!SPARROW_SOURCE_KEY) {
42
- logger.debug(
43
- "Metrics dispatcher: Source Key not provided. Be sure to initialize before sending events.",
44
- event
45
- );
46
- return;
47
- }
48
-
49
- // Lazily get the config for this dispatcher only when an event is being dispatched.
50
- // We must await this since it might trigger user interaction that would break other UI
51
- // in Wrangler if it was allowed to run in parallel.
52
- const metricsConfig = await getMetricsConfig(options);
53
- if (!metricsConfig.enabled) {
54
- logger.debug(
55
- `Metrics dispatcher: Dispatching disabled - would have sent ${JSON.stringify(
56
- event
57
- )}.`
58
- );
59
- return;
60
- }
61
-
62
- logger.debug(`Metrics dispatcher: Posting data ${JSON.stringify(event)}`);
63
- const body = JSON.stringify({
64
- deviceId: metricsConfig.deviceId,
65
- userId: metricsConfig.userId,
66
- event: event.name,
67
- properties: {
68
- category: "Workers",
69
- wranglerVersion,
70
- os: process.platform + ":" + process.arch,
71
- ...event.properties,
72
- },
73
- });
74
-
75
- // Do not await this fetch call.
76
- // Just fire-and-forget, otherwise we might slow down the rest of Wrangler.
77
- fetch(`${SPARROW_URL}/api/v1/${event.type}`, {
78
- method: "POST",
79
- headers: {
80
- Accept: "*/*",
81
- "Content-Type": "application/json",
82
- "Sparrow-Source-Key": SPARROW_SOURCE_KEY,
83
- },
84
- mode: "cors",
85
- keepalive: true,
86
- body,
87
- }).catch((e) => {
88
- logger.debug(
89
- "Metrics dispatcher: Failed to send request:",
90
- (e as Error).message
91
- );
92
- });
93
- }
94
- }
95
-
96
- export type Properties = Record<string, unknown>;
@@ -1,24 +0,0 @@
1
- import { getMetricsConfig } from "./metrics-config";
2
-
3
- /**
4
- * Add an additional header to publish requests if the user has opted into sending usage metrics.
5
- *
6
- * This allows us to estimate the number of instances of Wrangler that have opted-in
7
- * without breaking our agreement not to send stuff if you have not opted-in.
8
- */
9
- export async function getMetricsUsageHeaders(
10
- sendMetrics: boolean | undefined
11
- ): Promise<Record<string, string> | undefined> {
12
- const metricsEnabled = (
13
- await getMetricsConfig({
14
- sendMetrics,
15
- })
16
- ).enabled;
17
- if (metricsEnabled) {
18
- return {
19
- metricsEnabled: "true",
20
- };
21
- } else {
22
- return undefined;
23
- }
24
- }
@@ -1,92 +0,0 @@
1
- import { logger } from "../logger";
2
- import { getMetricsDispatcher } from "./metrics-dispatcher";
3
- import type { MetricsConfigOptions } from "./metrics-config";
4
- import type { Properties } from "./metrics-dispatcher";
5
-
6
- /** These are event names used by this wrangler client. */
7
- export type EventNames =
8
- | "view accounts"
9
- | "deploy worker script"
10
- | "begin log stream"
11
- | "end log stream"
12
- | "create encrypted variable"
13
- | "delete encrypted variable"
14
- | "list encrypted variables"
15
- | "create kv namespace"
16
- | "list kv namespaces"
17
- | "delete kv namespace"
18
- | "write kv key-value"
19
- | "list kv keys"
20
- | "read kv value"
21
- | "delete kv key-value"
22
- | "write kv key-values (bulk)"
23
- | "delete kv key-values (bulk)"
24
- | "create r2 bucket"
25
- | "list r2 buckets"
26
- | "delete r2 bucket"
27
- | "login user"
28
- | "logout user"
29
- | "create pubsub namespace"
30
- | "list pubsub namespaces"
31
- | "delete pubsub namespace"
32
- | "view pubsub namespace"
33
- | "create pubsub broker"
34
- | "update pubsub broker"
35
- | "list pubsub brokers"
36
- | "delete pubsub broker"
37
- | "view pubsub broker"
38
- | "issue pubsub broker credentials"
39
- | "revoke pubsub broker credentials"
40
- | "unrevoke pubsub broker credentials"
41
- | "list pubsub broker revoked credentials"
42
- | "list pubsub broker public-keys"
43
- | "list worker namespaces"
44
- | "view worker namespace"
45
- | "create worker namespace"
46
- | "delete worker namespace"
47
- | "rename worker namespace"
48
- | "create pages project"
49
- | "list pages projects"
50
- | "create pages deployment"
51
- | "list pages deployments"
52
- | "build pages functions"
53
- | "run dev"
54
- | "run pages dev";
55
-
56
- /**
57
- * Send a metrics event, with no extra properties, to Cloudflare, if usage tracking is enabled.
58
- *
59
- * This overload assumes that you do not want to configure analytics with options.
60
- */
61
- export function sendMetricsEvent(event: EventNames): Promise<void>;
62
- /**
63
- * Send a metrics event, with no extra properties, to Cloudflare, if usage tracking is enabled.
64
- */
65
- export function sendMetricsEvent(
66
- event: EventNames,
67
- options: MetricsConfigOptions
68
- ): Promise<void>;
69
- /**
70
- * Send a metrics event to Cloudflare, if usage tracking is enabled.
71
- *
72
- * Generally you should pass the `send_metrics` property from the wrangler.toml config here,
73
- * which would override any user permissions.
74
- */
75
- export function sendMetricsEvent(
76
- event: EventNames,
77
- properties: Properties,
78
- options: MetricsConfigOptions
79
- ): Promise<void>;
80
- export async function sendMetricsEvent(
81
- event: EventNames,
82
- ...args: [] | [MetricsConfigOptions] | [Properties, MetricsConfigOptions]
83
- ): Promise<void> {
84
- try {
85
- const options = args.pop() ?? {};
86
- const properties = (args.pop() ?? {}) as Properties;
87
- const metricsDispatcher = await getMetricsDispatcher(options);
88
- await metricsDispatcher.sendEvent(event, properties);
89
- } catch (err) {
90
- logger.debug("Error sending metrics event", err);
91
- }
92
- }
@@ -1,30 +0,0 @@
1
- # Custom Miniflare CLI
2
-
3
- This directory contains a simple wrapper around the programmatic Miniflare API,
4
- which Wrangler spawns when running `wrangler dev` in local mode.
5
-
6
- ## Building
7
-
8
- This CLI is built at the same time as Wrangler by running
9
-
10
- ```
11
- npm run -w wrangler build
12
- ```
13
-
14
- The output of the build is `miniflare-dist/index.mjs`.
15
-
16
- ## Running
17
-
18
- The CLI expects a single command line argument which is the Miniflare options formatted as a string of JSON.
19
-
20
- ```bash
21
- node --no-warnings ./packages/wrangler/miniflare-dist/index.mjs '{"watch": true, "script": ""}' --log VERBOSE
22
- ```
23
-
24
- The `--log` argument is optional and takes one of Miniflare's LogLevels: "NONE", "ERROR", "WARN", "INFO", "DEBUG", "VERBOSE".
25
- It defaults to `INFO`.
26
-
27
- ## Debugging
28
-
29
- Simply place a breakpoint in the code and run the above command in the VS Code "JavaScript Debug Terminal".
30
- The code will stop at the breakpoint as expected.