fix: use unique install cache folders for betas #20296

flotwig · 2022-02-21T19:26:56Z

For When using CDN download links in commit messages, support relative build numbers #20160

User facing changelog

Note: this commit is not attached to a specific release, but it is user-facing, so I guess it can go in the next release's changelog?

Updated pre-release builds to use a specific cache folder per pre-release build. Users no longer need to clear cache to install pre-releases.

Additional details

Update the build process to store some more info about the build in the CLI's package.json
- buildInfo will be used to implement When using CDN download links in commit messages, support relative build numbers #20160 UI
Update the download code to use this metadata instead of the versionSpecifier to construct the cdn download URL.
Update the cache code to use a different cache in the case that buildInfo.stable !== true
Update release process + scripts to set stable: true before publishing this
- This makes our prod tarballs distinct from dev tarballs, which wasn't the case before

How has the user experience changed?

A unique warning has been added to cypress install that clearly explains we're installing a pre-release.
cypress info has been updated to show if we are installing a pre-release.
cypress version displays 'pre-release' for the package version if applicable.
See the diffs in cli/__snapshots__ for the CLI changes.

PR Tasks

Have tests been added/updated?
Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
Has a PR for user-facing changes been opened in cypress-documentation? docs: remove note about clearing cache when installing pre-releases cypress-documentation#4376
[na] Have API changes been updated in the type definitions?
[na] Have new configuration options been added to the cypress.schema.json?

This reverts commit a7c137b.

cypress-bot · 2022-02-21T19:26:58Z

Thanks for taking the time to open a PR!

Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

cypress · 2022-02-23T16:49:39Z

Test summary

19278 • 0 • 218 • 0 • 0

Run details


Project	cypress
Status	Passed
Commit	`f67af55`
Started	Mar 4, 2022 7:04 PM
Ended	Mar 4, 2022 7:15 PM
Duration	11:45 💡
OS	Linux Debian - 10.10
Browser	Multiple

View run in Cypress Dashboard ➡️

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

…beta build dir)

…hing

emilyrohrbough · 2022-02-24T17:05:18Z

guides/release-process.md

            ![commit-bot-comment](../assets/cypress-bot-pre-release-comment.png)
-    - Make sure the `linux-x64` binary and npm package are present at the commented locations. See [Before Publishing a New Version](#before-publishing-a-new-version).
-    - Publish the `linux-x64` distribution to the npm registry straight from the URL:
+    - Use the `create-stable-npm-package` script to create a stable NPM package from the pre-prod `cypress.tgz` URL:


Would it be possible to update move-binaries to handle this for us so there is one less manual step & potential release error?

I think so. I was trying to be as deliberate as possible with making this its own step, so whoever is releasing is aware of what they're doing, but I guess it could be a source for errors. I'll look at this.

emilyrohrbough · 2022-02-24T17:12:55Z

cli/scripts/build.js

@@ -29,6 +34,12 @@ function preparePackageForNpmRelease (json) {

  _.extend(json, {
    version,
+    buildInfo: {


late to the game, but feels like publishing the beta version to npm would remove the need for a lot of this logic

I don't think publishing to NPM would really help avoid this complexity, unless we want to shove this complexity off to download.cypress.io like we do for stable releases, something like this is necessary.

I would be down to publish to NPM regularly, like maybe a Nightly build as long as there have been new commits. We already release so frequently that anything less frequent than Nightly wouldn't be super useful.

…hing

emilyrohrbough · 2022-03-01T20:16:27Z

cli/lib/tasks/install.js

@@ -278,45 +202,32 @@ const start = (options = {}) => {
    logger.log()
  }

+  const pkgVersion = util.pkgVersion()
+  const versionToInstall = getVersionOverride({ envVarVersion }) || pkgVersion


total nit, but for the sense of flow while reading, could we move this check above for readability?

const pkgVersion = util.pkgVersion() const versionToInstall = getVersionOverride({ envVarVersion }) || pkgVersion if (versionToInstall === '0') {

emilyrohrbough · 2022-03-01T20:17:54Z

cli/lib/tasks/install.js

-      logger.log(
-        chalk.yellow(stripIndent`
-          ${logSymbols.warning} Warning: Forcing a binary version different than the default.
+  if (versionToInstall !== pkgVersion) {


Will this alway log for binary version installs?

Yup. The log message here isn't great, I was kinda just following what was here already, but I can improve it so that it indicates we're installing a pre-release and there's not a "different binary version"

Log message updated, see snapshots. Also updated output for cypress info.

emilyrohrbough · 2022-03-01T20:27:20Z

guides/release-process.md


    ```shell
-    yarn move-binaries --sha <commit sha> --version <new target version>
+    yarn prepare-release-artifacts --sha <commit sha> --version <new target version>


Since this run's on the releaser's local machine, should there be a requirements that this must run on a Mac or Linux machine to ensure line-endings are not corrupted?

The script will always download the linux-x64 .tgz, but you raise a good point, possibly the stable: true write will mess with the line endings. I'll test this out and see.

In the process of testing this, I discovered that this script relies on behavior of tar that is not present on Windows, so it fails anyways. Since only internal contributors use this script and we're all on MacOS and Linux, I went ahead and added a guard like you suggested bd305d1

guides/release-process.md

…hing

flotwig · 2022-03-04T22:22:33Z

Manually confirmed script works as expected on darwin.

cypress-bot · 2022-03-14T21:27:17Z

Released in 9.5.2.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v9.5.2, please open a new issue.

flotwig added 5 commits February 21, 2022 13:37

use CIRCLE_BUILD_NUM for artifact slug

a7c137b

Revert "use CIRCLE_BUILD_NUM for artifact slug"

1908046

This reverts commit a7c137b.

Add buildInfo to built package.json

c7c64e1

update cache dir for installed betas

d7bf48b

fix: use unique build cache folders for betas

619a560

flotwig added 5 commits February 21, 2022 15:06

join path components

038f00a

move node_modules_installed out of /tmp

cb8ea83

add create-stable-npm-package

59abf3b

CIRCLE_BRANCH

4c00369

add stable: false to cli package.json

babf220

flotwig added 8 commits February 23, 2022 12:36

exclude app-module-path/test from build (too long a path for windows …

a587c9c

…beta build dir)

update dependency-tree

426b062

Merge branch 'develop' into fix-beta-build-caching

63b3d6e

fix outputs expected properties

abef43b

omit buildInfo from unbuilt cli package.json

75c904a

update install#start to use async/await

896f19e

update unit tests

30faaa8

Merge remote-tracking branch 'origin/develop' into fix-beta-build-cac…

08558e0

…hing

BlueWinds requested review from emilyrohrbough and davidmunechika February 24, 2022 16:40

emilyrohrbough reviewed Feb 24, 2022

View reviewed changes

flotwig added 2 commits February 28, 2022 09:52

Merge remote-tracking branch 'origin/develop' into fix-beta-build-cac…

57d0a85

…hing

combine move-binaries into prepare-release-artifacts

ff54121

flotwig marked this pull request as ready for review February 28, 2022 16:07

flotwig requested a review from a team as a code owner February 28, 2022 16:07

flotwig requested a review from emilyrohrbough February 28, 2022 16:29

flotwig changed the title ~~fix: use unique build cache folders for betas~~ fix: use unique install cache folders for betas Mar 1, 2022

davidmunechika previously approved these changes Mar 1, 2022

View reviewed changes

emilyrohrbough reviewed Mar 1, 2022

View reviewed changes

flotwig added 3 commits March 3, 2022 12:39

create unique warning for pre-releases

52aa89b

use async/await in cli.info

c8775aa

add to cypress info

579e937

flotwig dismissed davidmunechika’s stale review via 579e937 March 3, 2022 17:49

flotwig added 3 commits March 3, 2022 13:10

guard against dev

888f665

only support create-stable-npm-package on posix

bd305d1

also add output to cypress version

6e2745d

flotwig requested review from emilyrohrbough and davidmunechika March 3, 2022 21:03

emilyrohrbough reviewed Mar 4, 2022

View reviewed changes

guides/release-process.md Outdated Show resolved Hide resolved

emilyrohrbough approved these changes Mar 4, 2022

View reviewed changes

emilyrohrbough previously approved these changes Mar 4, 2022

View reviewed changes

Merge remote-tracking branch 'origin/develop' into fix-beta-build-cac…

050c616

…hing

flotwig dismissed emilyrohrbough’s stale review via 050c616 March 4, 2022 18:52

add platform note

f67af55

flotwig requested a review from emilyrohrbough March 4, 2022 18:53

emilyrohrbough approved these changes Mar 4, 2022

View reviewed changes

flotwig mentioned this pull request Mar 4, 2022

docs: remove note about clearing cache when installing pre-releases cypress-io/cypress-documentation#4376

Merged

davidmunechika approved these changes Mar 4, 2022

View reviewed changes

flotwig merged commit 3c28617 into develop Mar 4, 2022

flotwig deleted the fix-beta-build-caching branch March 4, 2022 22:22

cypress-bot bot locked as resolved and limited conversation to collaborators Mar 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: use unique install cache folders for betas #20296

fix: use unique install cache folders for betas #20296

flotwig commented Feb 21, 2022 •

edited

Loading

cypress-bot bot commented Feb 21, 2022

cypress bot commented Feb 23, 2022 •

edited

Loading

emilyrohrbough Feb 24, 2022

flotwig Feb 25, 2022

flotwig Feb 28, 2022

emilyrohrbough Feb 24, 2022

flotwig Feb 25, 2022

emilyrohrbough Mar 1, 2022

emilyrohrbough Mar 1, 2022

flotwig Mar 2, 2022

flotwig Mar 3, 2022

emilyrohrbough Mar 1, 2022

flotwig Mar 2, 2022

flotwig Mar 3, 2022

flotwig commented Mar 4, 2022

cypress-bot bot commented Mar 14, 2022

fix: use unique install cache folders for betas #20296

fix: use unique install cache folders for betas #20296

Conversation

flotwig commented Feb 21, 2022 • edited Loading

User facing changelog

Additional details

How has the user experience changed?

PR Tasks

cypress-bot bot commented Feb 21, 2022

cypress bot commented Feb 23, 2022 • edited Loading

Test summary

Run details

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

flotwig commented Mar 4, 2022

cypress-bot bot commented Mar 14, 2022

flotwig commented Feb 21, 2022 •

edited

Loading

cypress bot commented Feb 23, 2022 •

edited

Loading