Implement `versions deploy` command #5115

RamIdeas · 2024-02-28T20:02:06Z

What this PR solves / how to test:

This PR implements the versions deploy command as a sibling command to the, already merged, versions upload command. Both are still behind the --experimental-gradual-rollouts flag.

Note: in the commands below, it is assumed you have followed the install instructions of the prerelease build (from the bot comment in this PR). You can, instead, replace "wrangler" with the prerelease URL from the bot comment.

The most common usage will be without args where the prompts will walk you through selecting Versions and percentages for each and adding a deployment message. A sane default is provided for each percentage, evenly distributing the remaining percentage across the remaining versions.

$ npx wrangler versions deploy    --experimental-gradual-rollouts

You can also specify positional args in the form of <version-id> or <version-id>@<percentage> which will set the default selected Versions and the default associated percentage for each. The prompts are still presented but with prefilled defaults that the user can press ENTER to confirm.

# 1 version preselected by default
$ npx wrangler versions deploy 095f00a7-23a7-43b7-a227-e4c97cab5f22    --experimental-gradual-rollouts

# 2 versions preselected by default (the default percentage for each will be 50%)
$ npx wrangler versions deploy 095f00a7-23a7-43b7-a227-e4c97cab5f22  1a88955c-2fbd-4a72-9d9b-3ba1e59842f2    -experimental-gradual-rollouts

# 2 versions preselected by default – one with explicit 10% traffic, the other with implicit 90%
$ npx wrangler versions deploy 095f00a7-23a7-43b7-a227-e4c97cab5f22@10%   1a88955c-2fbd-4a72-9d9b-3ba1e59842f2    --experimental-gradual-rollouts
# ^ the 2nd version will have 90% by default (evenly distributed after the first version was assigned 10%)

# 2 versions preselected by default – both with explicit traffic 10% and 90%
$ npx wrangler versions deploy 095f00a7-23a7-43b7-a227-e4c97cab5f22@10%   1a88955c-2fbd-4a72-9d9b-3ba1e59842f2@90%    --experimental-gradual-rollouts

You can also specify named args --version-id and --percentage repeatedly. All --version-id args are read in order into an array. All --percentage args are read in order into an array. The indexes of each array are then used to correlate. By specifying less --percentage args than --version-id args, the percentages for the excess versions are deemed unspecified, like with positional args without @<percentage>, and will have the remaining percentage distributed evenly as with positional/prompted percentages.

$ npx wrangler versions deploy    --experimental-gradual-rollouts \
    --version-id 095f00a7-23a7-43b7-a227-e4c97cab5f22 \
    --percentage 10% \
    --version-id 1a88955c-2fbd-4a72-9d9b-3ba1e59842f2 \
    --percentage 90% 
# is equivalent to
$ npx wrangler versions deploy    --experimental-gradual-rollouts \
    --version-id 095f00a7-23a7-43b7-a227-e4c97cab5f22 \
    --version-id 1a88955c-2fbd-4a72-9d9b-3ba1e59842f2 \
    --percentage 10% \
    --percentage 90%

A mixture of positional and named args will work and should be relatively predictable, with positional args taking precedence.

By using the --yes flag, the prompt defaults will be automatically accepted. This will allow the following:

# deploy 2 versions with (implicit) 50% split – with positional args
$ npx wrangler versions deploy 095f00a7-23a7-43b7-a227-e4c97cab5f22  1a88955c-2fbd-4a72-9d9b-3ba1e59842f2  --yes    --experimental-gradual-rollouts

# deploy 2 versions with (explicit) 10% and (implicit) 90% split – with positional args
$ npx wrangler versions deploy 095f00a7-23a7-43b7-a227-e4c97cab5f22@10%   1a88955c-2fbd-4a72-9d9b-3ba1e59842f2  --yes    --experimental-gradual-rollouts

# deploy 2 versions with (explicit) 10% and (explicit) 90% split – with positional args
$ npx wrangler versions deploy 095f00a7-23a7-43b7-a227-e4c97cab5f22@10%   1a88955c-2fbd-4a72-9d9b-3ba1e59842f2@90%  --yes    --experimental-gradual-rollouts

# deploy 2 versions with (explicit) 10% and (implicit) 90% split – with named args
$ npx wrangler versions deploy  --yes    --experimental-gradual-rollouts \
    --version-id 095f00a7-23a7-43b7-a227-e4c97cab5f22 \
    --percentage 10% \
    --version-id 1a88955c-2fbd-4a72-9d9b-3ba1e59842f2

# deploy 2 versions with (explicit) 10% and (explicit) 90% split – with named args
$ npx wrangler versions deploy  --yes    --experimental-gradual-rollouts \
    --version-id 095f00a7-23a7-43b7-a227-e4c97cab5f22 \
    --percentage 10% \
    --version-id 1a88955c-2fbd-4a72-9d9b-3ba1e59842f2 \
    --percentage 90%

Author has addressed the following:

Tests
- Included
- Not necessary because:
- TODO before merging
Changeset (Changeset guidelines)
- Included
- Not necessary because:
- TODO before merging
Associated docs
- Issue(s)/PR(s):
- Not necessary because: internal command for now, documentation coming before open beta.

Note for PR author:

We want to celebrate and highlight awesome PR review! If you think this PR received a particularly high-caliber review, please assign it the label highlight pr review so future reviewers can take inspiration and learn from it.

changeset-bot · 2024-02-28T20:03:28Z

🦋 Changeset detected

Latest commit: bab3451

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
wrangler	Minor
@cloudflare/vitest-pool-workers	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2024-02-28T21:17:58Z

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8256774955/npm-package-wrangler-5115

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/5115/npm-package-wrangler-5115

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8256774955/npm-package-wrangler-5115 dev path/to/script.js

Additional artifacts:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8256774955/npm-package-create-cloudflare-5115 --no-auto-update

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8256774955/npm-package-cloudflare-kv-asset-handler-5115

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8256774955/npm-package-miniflare-5115

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8256774955/npm-package-cloudflare-pages-shared-5115

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8256774955/npm-package-cloudflare-vitest-pool-workers-5115

Note that these links will no longer work once the GitHub Actions artifact expires.

wrangler@3.33.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20240304.1
`workerd`	1.20240304.0	1.20240304.0
`workerd --version`	1.20240304.0	2024-03-04

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

petebacondarwin

There's a lot of new code in here with no tests...

mrbbot

Halfway through my review, but left comments so far.

packages/wrangler/src/index.ts

packages/wrangler/src/versions/deploy.ts

irvinebroque · 2024-03-08T00:27:27Z

If I create a new Worker, publish a new version, and then run this, in interactive mode I'm shown:

➜  gradual-test git:(main) ✗ npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/8195782752/npm-package-wrangler-5115 versions deploy --experimental-gradual-rollouts
 ⛅️ wrangler 0.0.0-fb147c36
---------------------------
╭ Deploy Worker Versions by splitting traffic between multiple versions
│ 
├ Your current deployment has 1 version(s):
│ 
│ (100%) 19c005af-5788-4991-a2a0-00a080f2b650
│       Created:  3/7/2024, 4:20:39 PM
│           Tag:  -
│       Message:  -
│ 
╰ Which version(s) do you want to deploy? Use SPACE to select/unselect version(s) and ENTER to submit.
  ○ 7d80087b-422a-41f5-b4bc-c6bc38deeeb9
       Created:  3/7/2024, 4:24:35 PM
           Tag:  -
       Message:  -

...and then no matter which version I select, I get the following error:

├ Which version(s) do you want to deploy?
├ 0 Worker Version(s) selected
│

✘ [ERROR] You must select at least 1 version to deploy.

(If I add specific version IDs as positional args then things work as expected, and this is looking really cool!)

cc @tanushreesharma-cf

RamIdeas · 2024-03-08T10:50:51Z

@irvinebroque that's odd – have you had similar problems with C3's interactive prompts?

I don't have any issues inside VSCode's terminal or in iTerm2:

Screen.Recording.2024-03-08.at.10.32.11.mov

codecov · 2024-03-08T19:39:53Z

Codecov Report

Attention: Patch coverage is 94.26230% with 14 lines in your changes are missing coverage. Please review.

Project coverage is 70.98%. Comparing base (772d42e) to head (bab3451).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5115      +/-   ##
==========================================
+ Coverage   70.47%   70.98%   +0.50%     
==========================================
  Files         298      301       +3     
  Lines       15539    15828     +289     
  Branches     3999     4053      +54     
==========================================
+ Hits        10951    11235     +284     
- Misses       4588     4593       +5

Files	Coverage Δ
packages/wrangler/e2e/helpers/normalize.ts	`93.75% <100.00%> (ø)`
...ler/src/__tests__/helpers/msw/handlers/versions.ts	`100.00% <100.00%> (ø)`
...ckages/wrangler/src/__tests__/helpers/msw/index.ts	`100.00% <100.00%> (ø)`
packages/wrangler/src/index.ts	`90.44% <100.00%> (+0.66%)`	⬆️
packages/wrangler/src/metrics/send-event.ts	`100.00% <ø> (ø)`
packages/wrangler/src/versions/deploy.ts	`93.60% <93.60%> (ø)`

... and 7 files with indirect coverage changes

mrbbot · 2024-03-12T14:32:02Z

packages/cli/interactive.ts

@@ -86,8 +92,29 @@ type RenderProps =
 	| Omit<ConfirmPrompt, "prompt">
 	| Omit<SelectRefreshablePrompt, "prompt">;

-export const inputPrompt = async <T = string>(promptConfig: PromptConfig) => {
-	const renderers = getRenderers(promptConfig);
+function acceptDefault<T>(


Should T extends Arg to avoid as Arg casting below?

Doesn't quite work for reasons I can't remember now but I think the better solution is to dissect inputPrompt by type instead of passing in type as an option as if the other options are the same across all types

I think the reason was not all possible values of T are Arg...

mrbbot · 2024-03-12T14:32:34Z

packages/cli/interactive.ts

+	const lines = renderers.submit({ value: initialValue as Arg });
+	logRaw(lines.join("\n"));
+
+	return initialValue as T;


initialValue is already typed T so I assume this case isn't necessary?

Yep can fix. Copied it straight outta C3

mrbbot · 2024-03-12T14:33:11Z

packages/cli/interactive.ts

+	return initialValue as T;
+}
+
+export const inputPrompt = async <T = string>(


Should this T extends string too? It looks like later you cast a string to T.

Unfortunately T can be anything – for example, select prompts can be anything and will be whatever the type of "value" is (it's an underlying key so doesn't need to be stringifiable) and multiselect will be an array of anything

mrbbot · 2024-03-12T14:38:40Z

packages/wrangler/e2e/helpers/normalize.ts

@@ -167,3 +168,7 @@ function removeStandardPricingWarning(stdout: string): string {
 		""
 	);
 }
+
+function removeZeroWidthSpaces(stdout: string) {
+	return stdout.replaceAll(/\u200a|\u200b/g, " ");


Would it be worth replacing these with a more recognisable sequence to distinguish these in tests? Maybe <ZWSP>?

It feels like an implementation detail. The zero-width space is for clack to not remove the indentation spacing. Doesn't need to be in the snapshots – since the absence of the zwsp will mean no indentation in the snapshot which will be caught and fail the test

mrbbot · 2024-03-12T14:42:02Z

packages/wrangler/src/__tests__/versions/versions.deploy.test.ts

+			);
+
+			await expect(result).rejects.toMatchInlineSnapshot(
+				`[Error: You must select at least 1 version to deploy.]`


Presumably this is only failing because the --yes flag is set? Without that, you'd get an interactive prompt?

Yes and if you didn't select anything from the interactive prompt – same flow.

mrbbot · 2024-03-12T14:42:38Z

packages/wrangler/src/__tests__/versions/versions.deploy.test.ts

+			│
+			├ What percentage of traffic should Worker Version 1 receive?
+			├ 100% of traffic
+			├


Should this be a │ not a ├?

I didn't want to mess too much with the CLI package because of existing usage – I'm not doing anything special with it here so it can and should be fixed there but can be done as a follow-up when thought through properly.

For now, this is a minor design glitch I think we're fine with going ahead with

RamIdeas · 2024-03-12T20:39:36Z

Had to rebase because of conflict in main

not supported by api right now, can revisit later. excluded right now to avoid scope creep

for versions deploy command

to ensure spinner is cleaned up upon errors

+ implement inputPrompt acceptDefault option

will redo in a different PR to avoid the hude snapshot diff

jculvey · 2024-03-16T15:35:31Z

packages/cli/interactive.ts

@@ -261,15 +313,16 @@ const getSelectRenderers = (
 			const active = i === cursor;
 			const isInListOfValues =
 				Array.isArray(value) && value.includes(optionValue);
-			const color = isInListOfValues || active ? blue : dim;


@RamIdeas was this change intentional? This is causing select values to render differently than they have in previous versions:

new:

old:

Can we change this back or make it overridable somehow?

Ah yeah my bad I made it match the design doc but I think this is where single select vs multi select may differ. We should double check with Meaghan. If we want different styles for single vs multi select we can make it overridable in a base implementation and have higher level getSelectRenderers and getMultiSelectRenderers

I also wanted to cc you on the acceptDefault option I added to inputPrompt

RamIdeas requested a review from a team as a code owner February 28, 2024 20:02

petebacondarwin reviewed Mar 1, 2024

View reviewed changes

mrbbot reviewed Mar 4, 2024

View reviewed changes

RamIdeas force-pushed the versions-deploy-command branch from 2362963 to e28abf3 Compare March 5, 2024 16:09

RamIdeas commented Mar 5, 2024

View reviewed changes

packages/wrangler/src/versions/deploy.ts Outdated Show resolved Hide resolved

RamIdeas force-pushed the versions-deploy-command branch from 0df6b1f to 2736606 Compare March 5, 2024 17:24

mrbbot reviewed Mar 6, 2024

View reviewed changes

RamIdeas force-pushed the versions-deploy-command branch from df12e02 to 2722fb7 Compare March 7, 2024 22:14

RamIdeas force-pushed the versions-deploy-command branch from 28c06f0 to 724d2d4 Compare March 8, 2024 19:21

mrbbot approved these changes Mar 12, 2024

View reviewed changes

RamIdeas force-pushed the versions-deploy-command branch from 19dbe5a to 96b38f7 Compare March 12, 2024 20:38

RamIdeas force-pushed the versions-deploy-command branch 2 times, most recently from 45473f1 to 32b6d43 Compare March 12, 2024 22:30

RamIdeas added 11 commits March 12, 2024 22:36

implement versions deploy command

0bf7f64

minor refactor

c423c56

use escape character instead of literal for zero-width space

8843d0b

remove versioned deployment "tag" feature

0d76755

not supported by api right now, can revisit later. excluded right now to avoid scope creep

send metrics

6f635f8

for versions deploy command

use Intl.ListFormat

65b5469

use spinnerWhile

3ba237f

to ensure spinner is cleaned up upon errors

test parseVersionSpecs

ff4be56

test assignAndDistributePercentages

4cd444c

test validateTrafficSubtotal

ba5daab

fix version-specs positional arg declaration

9270773

RamIdeas added 8 commits March 12, 2024 22:36

implement yes flag

fe99838

+ implement inputPrompt acceptDefault option

squash: fix version-specs positional arg declaration

522aed1

implement module boundary to mock stdout/stderr in tests

182f399

implement command tests

88711bb

undo Version description change

cb6f4a9

will redo in a different PR to avoid the hude snapshot diff

add comments

c2b2ab8

fix: latestDeployment is first not last

c83c00e

chore: remove brackets from event name

b681d4e

RamIdeas force-pushed the versions-deploy-command branch from 32b6d43 to b681d4e Compare March 12, 2024 22:37

add changeset

bab3451

RamIdeas merged commit 29e8151 into main Mar 13, 2024
15 checks passed

RamIdeas deleted the versions-deploy-command branch March 13, 2024 09:24

workers-devprod mentioned this pull request Mar 13, 2024

Version Packages #5236

Merged

jculvey reviewed Mar 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement `versions deploy` command #5115

Implement `versions deploy` command #5115

RamIdeas commented Feb 28, 2024 •

edited

changeset-bot bot commented Feb 28, 2024 •

edited

github-actions bot commented Feb 28, 2024 •

edited

petebacondarwin left a comment

mrbbot left a comment

irvinebroque commented Mar 8, 2024 •

edited

RamIdeas commented Mar 8, 2024

codecov bot commented Mar 8, 2024 •

edited

mrbbot Mar 12, 2024

RamIdeas Mar 12, 2024

RamIdeas Mar 12, 2024

mrbbot Mar 12, 2024

RamIdeas Mar 12, 2024

mrbbot Mar 12, 2024

RamIdeas Mar 12, 2024

mrbbot Mar 12, 2024

RamIdeas Mar 12, 2024

mrbbot Mar 12, 2024

RamIdeas Mar 12, 2024

mrbbot Mar 12, 2024

RamIdeas Mar 12, 2024

RamIdeas commented Mar 12, 2024

jculvey Mar 16, 2024 •

edited

RamIdeas Mar 16, 2024 •

edited

RamIdeas Mar 16, 2024

Implement versions deploy command #5115

Implement versions deploy command #5115

Conversation

RamIdeas commented Feb 28, 2024 • edited

changeset-bot bot commented Feb 28, 2024 • edited

🦋 Changeset detected

github-actions bot commented Feb 28, 2024 • edited

petebacondarwin left a comment

Choose a reason for hiding this comment

mrbbot left a comment

Choose a reason for hiding this comment

irvinebroque commented Mar 8, 2024 • edited

RamIdeas commented Mar 8, 2024

codecov bot commented Mar 8, 2024 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RamIdeas commented Mar 12, 2024

jculvey Mar 16, 2024 • edited

Choose a reason for hiding this comment

RamIdeas Mar 16, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Implement `versions deploy` command #5115

Implement `versions deploy` command #5115

RamIdeas commented Feb 28, 2024 •

edited

changeset-bot bot commented Feb 28, 2024 •

edited

github-actions bot commented Feb 28, 2024 •

edited

irvinebroque commented Mar 8, 2024 •

edited

codecov bot commented Mar 8, 2024 •

edited

jculvey Mar 16, 2024 •

edited

RamIdeas Mar 16, 2024 •

edited