Skip to content

cli: detect installing from postinstall hook #5407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 22, 2019

Conversation

bahmutov
Copy link
Contributor

@bahmutov bahmutov commented Oct 21, 2019

User facing changelog

"Normalizes" installation when running with custom relative Cypress cache folder. For example if you want to install Cypress and cache it in the current folder, rather than in ~/.cache

export CYPRESS_CACHE_FOLDER=cache/Cypress
npm i cypress
npx cypress run

Additional details

Before this change, during npm i cypress, the installation was executed in ./node_modules/cypress folder, which is a normal NPM behavior in postinstall hook. But this of course is very surprising to the user who expected the relative path CYPRESS_CACHE_FOLDER=cache/Cypress to resolve in the current folder, and not with respect to node_modules/cypress.

How has the user experience changed?

PR Tasks

  • Have tests been added/updated?

Sorry, something went wrong.

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Oct 21, 2019

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

  • Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
  • Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

  • The feature/bugfix is self-documenting from within the product.
  • The change provides the end user with a way to fix their problem (no dead ends).

Functionality

  • The code works and performs its intended function with the correct logic.
  • Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
  • The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

  • The code is readable (too many nested 'if's are a bad sign).
  • Names used for variables, methods, etc, clearly describe their function.
  • The code is easy to understood and there are relevant comments explaining.
  • New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
  • There are comments containing link(s) to the addressed issue (in tests and code).

Quality

  • The change does not reimplement code.
  • There's not a module from the ecosystem that should be used instead.
  • There is no redundant or duplicate code.
  • There are no irrelevant comments left in the code.
  • Tests are testing the code’s intended functionality in the best way possible.

Internal

  • The original issue has been tagged with a release in ZenHub.

@bahmutov bahmutov requested a review from kuceb October 21, 2019 20:11
@bahmutov bahmutov changed the title WIP: cli: detect installing from postinstall hook cli: detect installing from postinstall hook Oct 22, 2019
@andrew-codes andrew-codes self-requested a review October 22, 2019 15:34
Copy link
Contributor

@andrew-codes andrew-codes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and there appears to be test coverage for both the absolute path and a relative path test case for CYPRESS_CACHE_FOLDER.

@jennifer-shehane
Copy link
Member

Is this a breaking change? Will this break peoples current installs that have already accommodated to the current behavior?

@kuceb
Copy link
Contributor

kuceb commented Oct 22, 2019

@jennifer-shehane I would say its a patch fix. If the breaking change was clearly a bug it's fair for the version not to be breaking

@bahmutov
Copy link
Contributor Author

yeah @jennifer-shehane people who did CYPRESS_CACHE_FOLDER=../../cache/Cypress (which I honestly think is very rare) would need to remove dots and "simply" use CYPRESS_CACHE_FOLDER=cache/Cypress for all actions

@jennifer-shehane jennifer-shehane merged commit dd70563 into develop Oct 22, 2019
@emilyrohrbough emilyrohrbough deleted the install-folder-2634 branch August 1, 2024 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make caching Cypress binary in node_modules easier
4 participants