wrangler 0.0.0-e98613f8 → 0.0.0-e9a45766c

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 (244) hide show
  1. package/README.md +10 -4
  2. package/bin/wrangler.js +10 -2
  3. package/miniflare-dist/index.mjs +257 -132
  4. package/package.json +26 -19
  5. package/src/__tests__/api-dev.test.ts +65 -36
  6. package/src/__tests__/api-devregistry.test.ts +121 -0
  7. package/src/__tests__/api.test.ts +27 -5
  8. package/src/__tests__/configuration.test.ts +575 -39
  9. package/src/__tests__/constellation.test.ts +371 -0
  10. package/src/__tests__/d1/d1.test.ts +82 -0
  11. package/src/__tests__/d1/execute.test.ts +66 -0
  12. package/src/__tests__/d1/migrate.test.ts +257 -0
  13. package/src/__tests__/d1/splitter.test.ts +255 -0
  14. package/src/__tests__/delete.test.ts +11 -2
  15. package/src/__tests__/deployments.test.ts +330 -52
  16. package/src/__tests__/dev.test.tsx +146 -82
  17. package/src/__tests__/generate.test.ts +10 -8
  18. package/src/__tests__/guess-worker-format.test.ts +35 -0
  19. package/src/__tests__/helpers/end-event-loop.ts +6 -0
  20. package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
  21. package/src/__tests__/helpers/mock-console.ts +6 -0
  22. package/src/__tests__/helpers/mock-dialogs.ts +71 -85
  23. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +25 -0
  24. package/src/__tests__/helpers/mock-get-zone-from-host.ts +8 -5
  25. package/src/__tests__/helpers/mock-known-routes.ts +7 -2
  26. package/src/__tests__/helpers/mock-kv.ts +29 -16
  27. package/src/__tests__/helpers/mock-oauth-flow.ts +99 -92
  28. package/src/__tests__/helpers/mock-process.ts +8 -13
  29. package/src/__tests__/helpers/mock-set-timeout.ts +16 -0
  30. package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
  31. package/src/__tests__/helpers/msw/handlers/deployments.ts +127 -26
  32. package/src/__tests__/helpers/msw/handlers/namespaces.ts +18 -41
  33. package/src/__tests__/helpers/msw/handlers/r2.ts +14 -34
  34. package/src/__tests__/helpers/msw/handlers/script.ts +9 -28
  35. package/src/__tests__/helpers/msw/handlers/user.ts +13 -24
  36. package/src/__tests__/helpers/msw/handlers/zones.ts +6 -8
  37. package/src/__tests__/helpers/msw/index.ts +32 -1
  38. package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
  39. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +28 -0
  40. package/src/__tests__/helpers/worker-scripts/parent-worker.js +4 -1
  41. package/src/__tests__/index.test.ts +92 -74
  42. package/src/__tests__/init.test.ts +909 -628
  43. package/src/__tests__/jest.setup.ts +19 -42
  44. package/src/__tests__/kv.test.ts +355 -231
  45. package/src/__tests__/logger.test.ts +68 -2
  46. package/src/__tests__/logout.test.ts +1 -1
  47. package/src/__tests__/metrics.test.ts +93 -50
  48. package/src/__tests__/middleware.scheduled.test.ts +42 -32
  49. package/src/__tests__/middleware.test.ts +212 -122
  50. package/src/__tests__/mtls-certificates.test.ts +589 -0
  51. package/src/__tests__/pages/deployment-list.test.ts +80 -0
  52. package/src/__tests__/pages/functions-build.test.ts +528 -0
  53. package/src/__tests__/pages/pages.test.ts +81 -0
  54. package/src/__tests__/pages/project-create.test.ts +63 -0
  55. package/src/__tests__/pages/project-list.test.ts +110 -0
  56. package/src/__tests__/pages/project-upload.test.ts +500 -0
  57. package/src/__tests__/pages/publish.test.ts +2864 -0
  58. package/src/__tests__/pages-deployment-tail.test.ts +239 -102
  59. package/src/__tests__/parse.test.ts +106 -0
  60. package/src/__tests__/publish.test.ts +2218 -1002
  61. package/src/__tests__/pubsub.test.ts +226 -100
  62. package/src/__tests__/queues.test.ts +42 -32
  63. package/src/__tests__/r2.test.ts +37 -56
  64. package/src/__tests__/secret.test.ts +179 -130
  65. package/src/__tests__/tail.test.ts +113 -23
  66. package/src/__tests__/test-old-node-version.js +3 -3
  67. package/src/__tests__/traverse-module-graph.test.ts +220 -0
  68. package/src/__tests__/tsconfig-sanity.ts +12 -0
  69. package/src/__tests__/tsconfig.json +8 -0
  70. package/src/__tests__/tsconfig.tsbuildinfo +1 -0
  71. package/src/__tests__/type-generation.test.ts +8 -0
  72. package/src/__tests__/user.test.ts +7 -18
  73. package/src/__tests__/whoami.test.tsx +8 -114
  74. package/src/__tests__/worker-namespace.test.ts +83 -69
  75. package/src/api/dev.ts +172 -61
  76. package/src/api/index.ts +10 -1
  77. package/src/api/mtls-certificate.ts +148 -0
  78. package/src/api/pages/create-worker-bundle-contents.ts +77 -0
  79. package/src/api/pages/index.ts +5 -0
  80. package/src/api/pages/publish.tsx +371 -0
  81. package/src/bundle.ts +139 -33
  82. package/src/cfetch/index.ts +0 -2
  83. package/src/cfetch/internal.ts +16 -21
  84. package/src/cli.ts +4 -4
  85. package/src/config/config.ts +14 -7
  86. package/src/config/environment.ts +80 -16
  87. package/src/config/index.ts +99 -30
  88. package/src/config/validation-helpers.ts +1 -1
  89. package/src/config/validation.ts +275 -9
  90. package/src/constellation/createProject.tsx +51 -0
  91. package/src/constellation/deleteProject.ts +51 -0
  92. package/src/constellation/deleteProjectModel.ts +68 -0
  93. package/src/constellation/index.ts +75 -0
  94. package/src/constellation/listCatalog.tsx +35 -0
  95. package/src/constellation/listModel.tsx +41 -0
  96. package/src/constellation/listProject.tsx +28 -0
  97. package/src/constellation/listRuntime.tsx +28 -0
  98. package/src/constellation/options.ts +17 -0
  99. package/src/constellation/types.ts +17 -0
  100. package/src/constellation/uploadModel.tsx +64 -0
  101. package/src/constellation/utils.ts +90 -0
  102. package/src/create-worker-preview.ts +19 -8
  103. package/src/create-worker-upload-form.ts +52 -5
  104. package/src/d1/backups.tsx +40 -44
  105. package/src/d1/create.tsx +50 -43
  106. package/src/d1/{delete.tsx → delete.ts} +8 -11
  107. package/src/d1/execute.tsx +171 -166
  108. package/src/d1/index.ts +5 -6
  109. package/src/d1/list.tsx +27 -13
  110. package/src/d1/migrations/apply.tsx +92 -64
  111. package/src/d1/migrations/create.tsx +31 -29
  112. package/src/d1/migrations/helpers.ts +66 -44
  113. package/src/d1/migrations/list.tsx +47 -31
  114. package/src/d1/migrations/options.ts +7 -2
  115. package/src/d1/options.ts +3 -3
  116. package/src/d1/splitter.ts +161 -0
  117. package/src/d1/{types.tsx → types.ts} +1 -0
  118. package/src/d1/utils.ts +2 -1
  119. package/src/delete.ts +8 -16
  120. package/src/deployments.ts +333 -42
  121. package/src/deprecated/index.ts +8 -302
  122. package/src/dev/dev.tsx +13 -22
  123. package/src/dev/local.tsx +131 -69
  124. package/src/dev/remote.tsx +35 -3
  125. package/src/dev/start-server.ts +83 -77
  126. package/src/dev/use-esbuild.ts +63 -52
  127. package/src/dev/validate-dev-props.ts +9 -0
  128. package/src/{dev-registry.tsx → dev-registry.ts} +9 -8
  129. package/src/dev.tsx +131 -110
  130. package/src/dialogs.ts +136 -0
  131. package/src/dispatch-namespace.ts +21 -17
  132. package/src/docs/helpers.ts +50 -0
  133. package/src/docs/index.ts +54 -0
  134. package/src/entry.ts +26 -11
  135. package/src/environment-variables/factory.ts +89 -0
  136. package/src/environment-variables/misc-variables.ts +30 -0
  137. package/src/generate/index.ts +298 -0
  138. package/src/{index.tsx → index.ts} +137 -56
  139. package/src/init.ts +254 -187
  140. package/src/inspect.ts +170 -9
  141. package/src/jest.d.ts +4 -0
  142. package/src/kv/helpers.ts +7 -4
  143. package/src/kv/index.ts +15 -17
  144. package/src/logger.ts +36 -5
  145. package/src/metrics/metrics-config.ts +1 -1
  146. package/src/metrics/send-event.ts +4 -1
  147. package/src/miniflare-cli/assets.ts +66 -31
  148. package/src/miniflare-cli/index.ts +5 -8
  149. package/src/miniflare-cli/tsconfig.json +9 -0
  150. package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
  151. package/src/miniflare-cli/types.ts +11 -0
  152. package/src/module-collection.ts +92 -26
  153. package/src/mtls-certificate/cli.ts +155 -0
  154. package/src/pages/build.ts +423 -0
  155. package/src/pages/buildFunctions.ts +140 -0
  156. package/src/pages/{deployment-tails.tsx → deployment-tails.ts} +7 -10
  157. package/src/pages/deployments.tsx +9 -9
  158. package/src/pages/{dev.tsx → dev.ts} +167 -139
  159. package/src/pages/errors.ts +1 -0
  160. package/src/pages/functions/buildPlugin.ts +61 -54
  161. package/src/pages/functions/buildWorker.ts +217 -33
  162. package/src/pages/functions/tsconfig.json +8 -0
  163. package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
  164. package/src/pages/{functions.tsx → functions.ts} +8 -4
  165. package/src/pages/{index.tsx → index.ts} +3 -3
  166. package/src/pages/projects.tsx +12 -22
  167. package/src/pages/publish.tsx +43 -227
  168. package/src/pages/types.ts +5 -0
  169. package/src/pages/upload.tsx +57 -14
  170. package/src/pages/utils.ts +1 -1
  171. package/src/parse.ts +23 -1
  172. package/src/paths.ts +1 -1
  173. package/src/publish/index.ts +20 -16
  174. package/src/publish/publish.ts +76 -46
  175. package/src/pubsub/{pubsub-commands.tsx → pubsub-commands.ts} +19 -20
  176. package/src/queues/cli/commands/consumer/add.ts +24 -24
  177. package/src/queues/cli/commands/consumer/index.ts +3 -6
  178. package/src/queues/cli/commands/consumer/remove.ts +11 -18
  179. package/src/queues/cli/commands/create.ts +8 -8
  180. package/src/queues/cli/commands/delete.ts +8 -8
  181. package/src/queues/cli/commands/index.ts +3 -4
  182. package/src/queues/cli/commands/list.ts +8 -8
  183. package/src/queues/client.ts +1 -0
  184. package/src/r2/helpers.ts +1 -0
  185. package/src/r2/index.ts +28 -28
  186. package/src/secret/index.ts +15 -16
  187. package/src/{sites.tsx → sites.ts} +165 -53
  188. package/src/tail/createTail.ts +37 -1
  189. package/src/tail/filters.ts +1 -1
  190. package/src/tail/index.ts +8 -11
  191. package/src/tail/printing.ts +25 -0
  192. package/src/traverse-module-graph.ts +54 -0
  193. package/src/tsconfig-sanity.ts +16 -0
  194. package/src/type-generation.ts +11 -3
  195. package/src/user/access.ts +0 -1
  196. package/src/user/auth-variables.ts +113 -0
  197. package/src/user/choose-account.tsx +1 -31
  198. package/src/user/index.ts +0 -1
  199. package/src/user/{user.tsx → user.ts} +114 -77
  200. package/src/utils/render.ts +93 -0
  201. package/src/{whoami.tsx → whoami.ts} +37 -71
  202. package/src/worker.ts +35 -1
  203. package/src/yargs-types.ts +18 -5
  204. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  205. package/templates/__tests__/tsconfig.json +8 -0
  206. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  207. package/templates/checked-fetch.js +9 -3
  208. package/templates/d1-beta-facade.js +42 -3
  209. package/templates/facade.d.ts +14 -0
  210. package/templates/first-party-worker-module-facade.ts +4 -3
  211. package/templates/format-dev-errors.ts +8 -6
  212. package/templates/gitignore +1 -0
  213. package/templates/init-tests/test-jest-new-worker.js +3 -5
  214. package/templates/init-tests/test-vitest-new-worker.js +3 -5
  215. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  216. package/templates/middleware/loader-modules.ts +2 -2
  217. package/templates/middleware/loader-sw.ts +6 -0
  218. package/templates/middleware/middleware-miniflare3-json-error.ts +17 -5
  219. package/templates/new-worker.ts +3 -0
  220. package/templates/pages-dev-pipeline.ts +4 -1
  221. package/templates/pages-shim.ts +4 -1
  222. package/templates/pages-template-plugin.ts +19 -10
  223. package/templates/serve-static-assets.ts +17 -14
  224. package/templates/service-bindings-module-facade.js +1 -0
  225. package/templates/tsconfig-sanity.ts +11 -0
  226. package/templates/tsconfig.init.json +105 -0
  227. package/templates/tsconfig.json +5 -103
  228. package/templates/tsconfig.tsbuildinfo +1 -0
  229. package/wrangler-dist/cli.d.ts +871 -73
  230. package/wrangler-dist/cli.js +80512 -90686
  231. package/wrangler-dist/wasm-sync.wasm +0 -0
  232. package/src/__tests__/api-devregistry.test.js +0 -56
  233. package/src/__tests__/d1.test.ts +0 -80
  234. package/src/__tests__/dialogs.test.tsx +0 -40
  235. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  236. package/src/__tests__/pages.test.ts +0 -2442
  237. package/src/dialogs.tsx +0 -168
  238. package/src/environment-variables.ts +0 -50
  239. package/src/pages/build.tsx +0 -270
  240. package/src/user/env-vars.ts +0 -46
  241. /package/src/{bundle-reporter.tsx → bundle-reporter.ts} +0 -0
  242. /package/src/d1/migrations/{index.tsx → index.ts} +0 -0
  243. /package/src/dev/{get-local-persistence-path.tsx → get-local-persistence-path.ts} +0 -0
  244. /package/src/pages/{hash.tsx → hash.ts} +0 -0
@@ -1,6 +1,7 @@
1
+ import assert from "node:assert";
1
2
  import fs from "node:fs";
2
3
  import path from "path";
3
- import { Box, render, Text } from "ink";
4
+ import { Box, Text } from "ink";
4
5
  import Table from "ink-table";
5
6
  import React from "react";
6
7
  import { withConfig } from "../../config";
@@ -9,7 +10,9 @@ import { CI } from "../../is-ci";
9
10
  import isInteractive from "../../is-interactive";
10
11
  import { logger } from "../../logger";
11
12
  import { requireAuth } from "../../user";
13
+ import { renderToString } from "../../utils/render";
12
14
  import { createBackup } from "../backups";
15
+ import { DEFAULT_MIGRATION_PATH, DEFAULT_MIGRATION_TABLE } from "../constants";
13
16
  import { executeSql } from "../execute";
14
17
  import { d1BetaWarning, getDatabaseInfoFromConfig } from "../utils";
15
18
  import {
@@ -17,22 +20,25 @@ import {
17
20
  getUnappliedMigrations,
18
21
  initMigrationsTable,
19
22
  } from "./helpers";
20
- import { DatabaseWithLocal } from "./options";
23
+ import { MigrationOptions } from "./options";
21
24
  import type { ParseError } from "../../parse";
22
- import type { BaseSqlExecuteArgs } from "../execute";
23
- import type { Argv } from "yargs";
25
+ import type {
26
+ CommonYargsArgv,
27
+ StrictYargsOptionsToInterface,
28
+ } from "../../yargs-types";
24
29
 
25
- export function ApplyOptions(yargs: Argv): Argv<BaseSqlExecuteArgs> {
26
- return DatabaseWithLocal(yargs);
30
+ export function ApplyOptions(yargs: CommonYargsArgv) {
31
+ return MigrationOptions(yargs);
27
32
  }
28
33
 
29
- export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
30
- async ({ config, database, local, persistTo }): Promise<void> => {
31
- const accountId = await requireAuth({});
34
+ type ApplyHandlerOptions = StrictYargsOptionsToInterface<typeof ApplyOptions>;
35
+
36
+ export const ApplyHandler = withConfig<ApplyHandlerOptions>(
37
+ async ({ config, database, local, persistTo, preview }): Promise<void> => {
32
38
  logger.log(d1BetaWarning);
33
39
 
34
- const databaseInfo = await getDatabaseInfoFromConfig(config, database);
35
- if (!databaseInfo) {
40
+ const databaseInfo = getDatabaseInfoFromConfig(config, database);
41
+ if (!databaseInfo && !local) {
36
42
  throw new Error(
37
43
  `Can't find a DB with name/binding '${database}' in local config. Check info in wrangler.toml...`
38
44
  );
@@ -42,28 +48,34 @@ export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
42
48
  return;
43
49
  }
44
50
 
45
- const migrationsPath = await getMigrationsPath(
46
- path.dirname(config.configPath),
47
- databaseInfo.migrationsFolderPath,
48
- false
49
- );
50
- await initMigrationsTable(
51
- databaseInfo.migrationsTableName,
51
+ const migrationsPath = await getMigrationsPath({
52
+ projectPath: path.dirname(config.configPath),
53
+ migrationsFolderPath:
54
+ databaseInfo?.migrationsFolderPath ?? DEFAULT_MIGRATION_PATH,
55
+ createIfMissing: false,
56
+ });
57
+
58
+ const migrationsTableName =
59
+ databaseInfo?.migrationsTableName ?? DEFAULT_MIGRATION_TABLE;
60
+ await initMigrationsTable({
61
+ migrationsTableName,
52
62
  local,
53
63
  config,
54
- database,
55
- persistTo
56
- );
64
+ name: database,
65
+ persistTo,
66
+ preview,
67
+ });
57
68
 
58
69
  const unappliedMigrations = (
59
- await getUnappliedMigrations(
60
- databaseInfo.migrationsTableName,
70
+ await getUnappliedMigrations({
71
+ migrationsTableName,
61
72
  migrationsPath,
62
73
  local,
63
74
  config,
64
- database,
65
- persistTo
66
- )
75
+ name: database,
76
+ persistTo,
77
+ preview,
78
+ })
67
79
  )
68
80
  .map((migration) => {
69
81
  return {
@@ -86,47 +98,58 @@ export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
86
98
  });
87
99
 
88
100
  if (unappliedMigrations.length === 0) {
89
- render(<Text>✅ No migrations to apply!</Text>);
101
+ logger.log(renderToString(<Text>✅ No migrations to apply!</Text>));
90
102
  return;
91
103
  }
92
-
93
- if (isInteractive() && !CI.isCI()) {
94
- const ok = await confirm(
95
- `About to apply ${unappliedMigrations.length} migration(s)\n` +
96
- "Your database may not be available to serve requests during the migration, continue?",
104
+ logger.log(
105
+ renderToString(
97
106
  <Box flexDirection="column">
98
107
  <Text>Migrations to be applied:</Text>
99
108
  <Table data={unappliedMigrations} columns={["Name"]}></Table>
100
109
  </Box>
110
+ )
111
+ );
112
+ const ok = await confirm(
113
+ `About to apply ${unappliedMigrations.length} migration(s)
114
+ Your database may not be available to serve requests during the migration, continue?`
115
+ );
116
+ if (!ok) return;
117
+
118
+ // don't backup prod db when applying migrations locally or in preview
119
+ if (!local && !preview) {
120
+ assert(
121
+ databaseInfo,
122
+ "In non-local mode `databaseInfo` should be defined."
101
123
  );
102
- if (!ok) return;
124
+ logger.log(renderToString(<Text>🕒 Creating backup...</Text>));
125
+ const accountId = await requireAuth(config);
126
+ await createBackup(accountId, databaseInfo.uuid);
103
127
  }
104
128
 
105
- render(<Text>🕒 Creating backup...</Text>);
106
- await createBackup(accountId, databaseInfo.uuid);
107
-
108
129
  for (const migration of unappliedMigrations) {
109
130
  let query = fs.readFileSync(
110
131
  `${migrationsPath}/${migration.Name}`,
111
132
  "utf8"
112
133
  );
113
134
  query += `
114
- INSERT INTO ${databaseInfo.migrationsTableName} (name)
135
+ INSERT INTO ${migrationsTableName} (name)
115
136
  values ('${migration.Name}');
116
137
  `;
117
138
 
118
139
  let success = true;
119
140
  let errorNotes: Array<string> = [];
120
141
  try {
121
- const response = await executeSql(
142
+ const response = await executeSql({
122
143
  local,
123
144
  config,
124
- database,
125
- isInteractive() && !CI.isCI(),
145
+ name: database,
146
+ shouldPrompt: isInteractive() && !CI.isCI(),
126
147
  persistTo,
127
- undefined,
128
- query
129
- );
148
+ command: query,
149
+ file: undefined,
150
+ json: undefined,
151
+ preview,
152
+ });
130
153
 
131
154
  if (response === null) {
132
155
  // TODO: return error
@@ -149,33 +172,38 @@ export const ApplyHandler = withConfig<BaseSqlExecuteArgs>(
149
172
  }
150
173
  } catch (e) {
151
174
  const err = e as ParseError;
175
+ const maybeCause = (err.cause ?? err) as Error;
152
176
 
153
177
  success = false;
154
- errorNotes = err.notes.map((msg) => msg.text);
178
+ errorNotes = err.notes?.map((msg) => msg.text) ?? [
179
+ maybeCause?.message ?? maybeCause.toString(),
180
+ ];
155
181
  }
156
182
 
157
183
  migration.Status = success ? "✅" : "❌";
158
184
 
159
- render(
160
- <Box flexDirection="column">
161
- <Table
162
- data={unappliedMigrations}
163
- columns={["Name", "Status"]}
164
- ></Table>
165
- {errorNotes.length > 0 && (
166
- <Box flexDirection="column">
167
- <Text>&nbsp;</Text>
168
- <Text>
169
- ❌ Migration {migration.Name} failed with following Errors
170
- </Text>
171
- <Table
172
- data={errorNotes.map((err) => {
173
- return { Error: err };
174
- })}
175
- ></Table>
176
- </Box>
177
- )}
178
- </Box>
185
+ logger.log(
186
+ renderToString(
187
+ <Box flexDirection="column">
188
+ <Table
189
+ data={unappliedMigrations}
190
+ columns={["Name", "Status"]}
191
+ ></Table>
192
+ {errorNotes.length > 0 && (
193
+ <Box flexDirection="column">
194
+ <Text>&nbsp;</Text>
195
+ <Text>
196
+ ❌ Migration {migration.Name} failed with following Errors
197
+ </Text>
198
+ <Table
199
+ data={errorNotes.map((err) => {
200
+ return { Error: err };
201
+ })}
202
+ ></Table>
203
+ </Box>
204
+ )}
205
+ </Box>
206
+ )
179
207
  );
180
208
 
181
209
  if (errorNotes.length > 0) return;
@@ -1,22 +1,20 @@
1
1
  import fs from "node:fs";
2
2
  import path from "path";
3
- import { Box, render, Text } from "ink";
3
+ import { Box, Text } from "ink";
4
4
  import React from "react";
5
5
  import { withConfig } from "../../config";
6
6
  import { logger } from "../../logger";
7
- import { requireAuth } from "../../user";
7
+ import { renderToString } from "../../utils/render";
8
+ import { DEFAULT_MIGRATION_PATH } from "../constants";
8
9
  import { Database } from "../options";
9
10
  import { d1BetaWarning, getDatabaseInfoFromConfig } from "../utils";
10
11
  import { getMigrationsPath, getNextMigrationNumber } from "./helpers";
11
- import type { Argv } from "yargs";
12
+ import type {
13
+ CommonYargsArgv,
14
+ StrictYargsOptionsToInterface,
15
+ } from "../../yargs-types";
12
16
 
13
- type MigrationsCreateArgs = {
14
- config?: string;
15
- database: string;
16
- message: string;
17
- };
18
-
19
- export function CreateOptions(yargs: Argv): Argv<MigrationsCreateArgs> {
17
+ export function CreateOptions(yargs: CommonYargsArgv) {
20
18
  return Database(yargs).positional("message", {
21
19
  describe: "The Migration message",
22
20
  type: "string",
@@ -24,12 +22,13 @@ export function CreateOptions(yargs: Argv): Argv<MigrationsCreateArgs> {
24
22
  });
25
23
  }
26
24
 
27
- export const CreateHandler = withConfig<MigrationsCreateArgs>(
25
+ type CreateHandlerOptions = StrictYargsOptionsToInterface<typeof CreateOptions>;
26
+
27
+ export const CreateHandler = withConfig<CreateHandlerOptions>(
28
28
  async ({ config, database, message }): Promise<void> => {
29
- await requireAuth({});
30
29
  logger.log(d1BetaWarning);
31
30
 
32
- const databaseInfo = await getDatabaseInfoFromConfig(config, database);
31
+ const databaseInfo = getDatabaseInfoFromConfig(config, database);
33
32
  if (!databaseInfo) {
34
33
  throw new Error(
35
34
  `Can't find a DB with name/binding '${database}' in local config. Check info in wrangler.toml...`
@@ -40,11 +39,12 @@ export const CreateHandler = withConfig<MigrationsCreateArgs>(
40
39
  return;
41
40
  }
42
41
 
43
- const migrationsPath = await getMigrationsPath(
44
- path.dirname(config.configPath),
45
- databaseInfo.migrationsFolderPath,
46
- true
47
- );
42
+ const migrationsPath = await getMigrationsPath({
43
+ projectPath: path.dirname(config.configPath),
44
+ migrationsFolderPath:
45
+ databaseInfo.migrationsFolderPath ?? DEFAULT_MIGRATION_PATH,
46
+ createIfMissing: true,
47
+ });
48
48
  const nextMigrationNumber = pad(getNextMigrationNumber(migrationsPath), 4);
49
49
  const migrationName = message.replaceAll(" ", "_");
50
50
 
@@ -55,17 +55,19 @@ export const CreateHandler = withConfig<MigrationsCreateArgs>(
55
55
  `-- Migration number: ${nextMigrationNumber} \t ${new Date().toISOString()}\n`
56
56
  );
57
57
 
58
- render(
59
- <Box flexDirection="column">
60
- <Text>
61
- ✅ Successfully created Migration &apos;{newMigrationName}&apos;!
62
- </Text>
63
- <Text>&nbsp;</Text>
64
- <Text>The migration is available for editing here</Text>
65
- <Text>
66
- {migrationsPath}/{newMigrationName}
67
- </Text>
68
- </Box>
58
+ logger.log(
59
+ renderToString(
60
+ <Box flexDirection="column">
61
+ <Text>
62
+ ✅ Successfully created Migration &apos;{newMigrationName}&apos;!
63
+ </Text>
64
+ <Text>&nbsp;</Text>
65
+ <Text>The migration is available for editing here</Text>
66
+ <Text>
67
+ {migrationsPath}/{newMigrationName}
68
+ </Text>
69
+ </Box>
70
+ )
69
71
  );
70
72
  }
71
73
  );
@@ -10,11 +10,15 @@ import type { ConfigFields, DevConfig, Environment } from "../../config";
10
10
  import type { QueryResult } from "../execute";
11
11
  import type { Migration } from "../types";
12
12
 
13
- export async function getMigrationsPath(
14
- projectPath: string,
15
- migrationsFolderPath: string,
16
- createIfMissing: boolean
17
- ): Promise<string> {
13
+ export async function getMigrationsPath({
14
+ projectPath,
15
+ migrationsFolderPath,
16
+ createIfMissing,
17
+ }: {
18
+ projectPath: string;
19
+ migrationsFolderPath: string;
20
+ createIfMissing: boolean;
21
+ }): Promise<string> {
18
22
  const dir = path.resolve(projectPath, migrationsFolderPath);
19
23
  if (fs.existsSync(dir)) return dir;
20
24
 
@@ -34,21 +38,31 @@ export async function getMigrationsPath(
34
38
  throw new Error(`No migrations present at ${dir}.`);
35
39
  }
36
40
 
37
- export async function getUnappliedMigrations(
38
- migrationsTableName: string,
39
- migrationsPath: string,
40
- local: undefined | boolean,
41
- config: ConfigFields<DevConfig> & Environment,
42
- name: string,
43
- persistTo: undefined | string
44
- ): Promise<Array<string>> {
41
+ export async function getUnappliedMigrations({
42
+ migrationsTableName,
43
+ migrationsPath,
44
+ local,
45
+ config,
46
+ name,
47
+ persistTo,
48
+ preview,
49
+ }: {
50
+ migrationsTableName: string;
51
+ migrationsPath: string;
52
+ local: boolean | undefined;
53
+ config: ConfigFields<DevConfig> & Environment;
54
+ name: string;
55
+ persistTo: string | undefined;
56
+ preview: boolean | undefined;
57
+ }): Promise<Array<string>> {
45
58
  const appliedMigrations = (
46
59
  await listAppliedMigrations(
47
60
  migrationsTableName,
48
61
  local,
49
62
  config,
50
63
  name,
51
- persistTo
64
+ persistTo,
65
+ preview
52
66
  )
53
67
  ).map((migration) => {
54
68
  return migration.name;
@@ -68,24 +82,25 @@ export async function getUnappliedMigrations(
68
82
 
69
83
  const listAppliedMigrations = async (
70
84
  migrationsTableName: string,
71
- local: undefined | boolean,
85
+ local: boolean | undefined,
72
86
  config: ConfigFields<DevConfig> & Environment,
73
87
  name: string,
74
- persistTo: undefined | string
88
+ persistTo: string | undefined,
89
+ preview: boolean | undefined
75
90
  ): Promise<Migration[]> => {
76
- const Query = `SELECT *
77
- FROM ${migrationsTableName}
78
- ORDER BY id`;
79
-
80
- const response: QueryResult[] | null = await executeSql(
91
+ const response: QueryResult[] | null = await executeSql({
81
92
  local,
82
93
  config,
83
94
  name,
84
- isInteractive() && !CI.isCI(),
95
+ shouldPrompt: isInteractive() && !CI.isCI(),
85
96
  persistTo,
86
- undefined,
87
- Query
88
- );
97
+ command: `SELECT *
98
+ FROM ${migrationsTableName}
99
+ ORDER BY id`,
100
+ file: undefined,
101
+ json: undefined,
102
+ preview,
103
+ });
89
104
 
90
105
  if (!response || response[0].results.length === 0) return [];
91
106
 
@@ -121,27 +136,34 @@ export function getNextMigrationNumber(migrationsPath: string): number {
121
136
  return highestMigrationNumber + 1;
122
137
  }
123
138
 
124
- export const initMigrationsTable = async (
125
- migrationsTableName: string,
126
- local: undefined | boolean,
127
- config: ConfigFields<DevConfig> & Environment,
128
- name: string,
129
- persistTo: undefined | string
130
- ) => {
131
- return executeSql(
139
+ export const initMigrationsTable = async ({
140
+ migrationsTableName,
141
+ local,
142
+ config,
143
+ name,
144
+ persistTo,
145
+ preview,
146
+ }: {
147
+ migrationsTableName: string;
148
+ local: boolean | undefined;
149
+ config: ConfigFields<DevConfig> & Environment;
150
+ name: string;
151
+ persistTo: string | undefined;
152
+ preview: boolean | undefined;
153
+ }) => {
154
+ return executeSql({
132
155
  local,
133
156
  config,
134
157
  name,
135
- isInteractive() && !CI.isCI(),
158
+ shouldPrompt: isInteractive() && !CI.isCI(),
136
159
  persistTo,
137
- undefined,
138
- `
139
- CREATE TABLE IF NOT EXISTS ${migrationsTableName}
140
- (
141
- id INTEGER PRIMARY KEY AUTOINCREMENT,
142
- name TEXT UNIQUE,
143
- applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL
144
- );
145
- `
146
- );
160
+ command: `CREATE TABLE IF NOT EXISTS ${migrationsTableName}(
161
+ id INTEGER PRIMARY KEY AUTOINCREMENT,
162
+ name TEXT UNIQUE,
163
+ applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL
164
+ );`,
165
+ file: undefined,
166
+ json: undefined,
167
+ preview,
168
+ });
147
169
  };
@@ -1,31 +1,39 @@
1
1
  import path from "path";
2
- import { Box, render, Text } from "ink";
2
+ import { Box, Text } from "ink";
3
3
  import Table from "ink-table";
4
4
  import React from "react";
5
5
  import { withConfig } from "../../config";
6
6
  import { logger } from "../../logger";
7
7
  import { requireAuth } from "../../user";
8
+ import { renderToString } from "../../utils/render";
9
+ import { DEFAULT_MIGRATION_PATH, DEFAULT_MIGRATION_TABLE } from "../constants";
8
10
  import { d1BetaWarning, getDatabaseInfoFromConfig } from "../utils";
9
11
  import {
10
12
  getMigrationsPath,
11
13
  getUnappliedMigrations,
12
14
  initMigrationsTable,
13
15
  } from "./helpers";
14
- import { DatabaseWithLocal } from "./options";
15
- import type { BaseSqlExecuteArgs } from "../execute";
16
- import type { Argv } from "yargs";
16
+ import { MigrationOptions } from "./options";
17
+ import type {
18
+ CommonYargsArgv,
19
+ StrictYargsOptionsToInterface,
20
+ } from "../../yargs-types";
17
21
 
18
- export function ListOptions(yargs: Argv): Argv<BaseSqlExecuteArgs> {
19
- return DatabaseWithLocal(yargs);
22
+ export function ListOptions(yargs: CommonYargsArgv) {
23
+ return MigrationOptions(yargs);
20
24
  }
21
25
 
22
- export const ListHandler = withConfig<BaseSqlExecuteArgs>(
23
- async ({ config, database, local, persistTo }): Promise<void> => {
24
- await requireAuth({});
26
+ type ListHandlerOptions = StrictYargsOptionsToInterface<typeof ListOptions>;
27
+
28
+ export const ListHandler = withConfig<ListHandlerOptions>(
29
+ async ({ config, database, local, persistTo, preview }): Promise<void> => {
30
+ if (!local) {
31
+ await requireAuth({});
32
+ }
25
33
  logger.log(d1BetaWarning);
26
34
 
27
- const databaseInfo = await getDatabaseInfoFromConfig(config, database);
28
- if (!databaseInfo) {
35
+ const databaseInfo = getDatabaseInfoFromConfig(config, database);
36
+ if (!databaseInfo && !local) {
29
37
  throw new Error(
30
38
  `Can't find a DB with name/binding '${database}' in local config. Check info in wrangler.toml...`
31
39
  );
@@ -34,30 +42,36 @@ export const ListHandler = withConfig<BaseSqlExecuteArgs>(
34
42
  if (!config.configPath) {
35
43
  return;
36
44
  }
37
- const { migrationsTableName, migrationsFolderPath } = databaseInfo;
38
45
 
39
- const migrationsPath = await getMigrationsPath(
40
- path.dirname(config.configPath),
41
- migrationsFolderPath,
42
- false
43
- );
44
- await initMigrationsTable(
46
+ const migrationsPath = await getMigrationsPath({
47
+ projectPath: path.dirname(config.configPath),
48
+ migrationsFolderPath:
49
+ databaseInfo?.migrationsFolderPath ?? DEFAULT_MIGRATION_PATH,
50
+ createIfMissing: false,
51
+ });
52
+
53
+ const migrationsTableName =
54
+ databaseInfo?.migrationsTableName ?? DEFAULT_MIGRATION_TABLE;
55
+
56
+ await initMigrationsTable({
45
57
  migrationsTableName,
46
58
  local,
47
59
  config,
48
- database,
49
- persistTo
50
- );
60
+ name: database,
61
+ persistTo,
62
+ preview,
63
+ });
51
64
 
52
65
  const unappliedMigrations = (
53
- await getUnappliedMigrations(
66
+ await getUnappliedMigrations({
54
67
  migrationsTableName,
55
68
  migrationsPath,
56
69
  local,
57
70
  config,
58
- database,
59
- persistTo
60
- )
71
+ name: database,
72
+ persistTo,
73
+ preview,
74
+ })
61
75
  ).map((migration) => {
62
76
  return {
63
77
  Name: migration,
@@ -65,15 +79,17 @@ export const ListHandler = withConfig<BaseSqlExecuteArgs>(
65
79
  });
66
80
 
67
81
  if (unappliedMigrations.length === 0) {
68
- render(<Text>✅ No migrations to apply!</Text>);
82
+ logger.log(renderToString(<Text>✅ No migrations to apply!</Text>));
69
83
  return;
70
84
  }
71
85
 
72
- render(
73
- <Box flexDirection="column">
74
- <Text>Migrations to be applied:</Text>
75
- <Table data={unappliedMigrations} columns={["Name"]}></Table>
76
- </Box>
86
+ logger.log(
87
+ renderToString(
88
+ <Box flexDirection="column">
89
+ <Text>Migrations to be applied:</Text>
90
+ <Table data={unappliedMigrations} columns={["Name"]}></Table>
91
+ </Box>
92
+ )
77
93
  );
78
94
  }
79
95
  );
@@ -1,13 +1,18 @@
1
1
  import { Database } from "../options";
2
- import type { Argv } from "yargs";
2
+ import type { CommonYargsArgv } from "../../yargs-types";
3
3
 
4
- export function DatabaseWithLocal(yargs: Argv) {
4
+ export function MigrationOptions(yargs: CommonYargsArgv) {
5
5
  return Database(yargs)
6
6
  .option("local", {
7
7
  describe:
8
8
  "Execute commands/files against a local DB for use with wrangler dev --local",
9
9
  type: "boolean",
10
10
  })
11
+ .option("preview", {
12
+ describe: "Execute commands/files against a preview D1 DB",
13
+ type: "boolean",
14
+ default: false,
15
+ })
11
16
  .option("persist-to", {
12
17
  describe:
13
18
  "Specify directory to use for local persistence (you must use --local with this flag)",
package/src/d1/options.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { d1BetaWarning } from "./utils";
2
- import type { Argv } from "yargs";
2
+ import type { CommonYargsArgv } from "../yargs-types";
3
3
 
4
- export function Name(yargs: Argv) {
4
+ export function Name(yargs: CommonYargsArgv) {
5
5
  return yargs
6
6
  .positional("name", {
7
7
  describe: "The name or binding of the DB",
@@ -11,7 +11,7 @@ export function Name(yargs: Argv) {
11
11
  .epilogue(d1BetaWarning);
12
12
  }
13
13
 
14
- export function Database(yargs: Argv) {
14
+ export function Database(yargs: CommonYargsArgv) {
15
15
  return yargs
16
16
  .positional("database", {
17
17
  describe: "The name or binding of the DB",