Skip to content
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

chore: remove non-test-related coffeescript references #7605

Merged
merged 5 commits into from
Jun 10, 2020

Conversation

flotwig
Copy link
Contributor

@flotwig flotwig commented Jun 5, 2020

User facing changelog

n/a

Additional details

  • Removes every usage of coffeescript internally (except for tests that use .coffee files as fixtures)
  • Leaves coffeescript support for cy.fixture, which is the last usage of @packages/coffee
  • Decaffeinated .coffee plugin files in internal projects repos - previously, they were only able to be .coffee because we required @packages/coffee/register within the child bootstrap code, which only works when CYPRESS_INTERNAL_ENV !== production. so not user facing

How has the user experience changed?

PR Tasks

  • Have tests been added/updated?
  • [na] Has the original issue been tagged with a release in ZenHub?
  • [na] Has a PR for user-facing changes been opened in cypress-documentation?
  • [na] Have API changes been updated in the type definitions?
  • [na] Have new configuration options been added to the cypress.schema.json?

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jun 5, 2020

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.

@cypress
Copy link

cypress bot commented Jun 5, 2020



Test summary

3484 0 56 0


Run details

Project cypress
Status Passed
Commit e0b31cb
Started Jun 10, 2020 1:51 PM
Ended Jun 10, 2020 1:58 PM
Duration 06:15 💡
OS Linux Debian - 10.1
Browser Firefox 74

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

@flotwig flotwig force-pushed the remove-coffeescript-internal branch from 25d99b3 to 13c71a9 Compare June 5, 2020 19:19
@flotwig flotwig changed the base branch from decaf-server-tests-and-more to develop June 5, 2020 19:19
@flotwig flotwig force-pushed the remove-coffeescript-internal branch 5 times, most recently from 2a9c385 to 5f93a64 Compare June 5, 2020 20:14
@flotwig flotwig marked this pull request as ready for review June 5, 2020 20:28
@flotwig flotwig requested review from a team, brian-mann, JessicaSachs and kuceb and removed request for a team June 5, 2020 20:28
@flotwig flotwig force-pushed the remove-coffeescript-internal branch from 5f93a64 to 9ba2ad1 Compare June 5, 2020 20:55
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

  1. I think it would have been nice to maintain the history of the coffee files that were deleted/replaced with js files like we do other decaffeinations, but...I can see that not being as important for these fixture/plugin files. I dunno, what do you think?

  2. Whats the fate of all these coffee files? I guess they don't technically have to be moved over, but probably should be unless they're specific to coffeescript test files. https://github.com/cypress-io/cypress/tree/develop/packages/server/test/support/fixtures/projects/e2e/cypress/integration

  3. Also, what's the point of the coffee package, it's literally just exporting the coffeescript package. I think we can just require coffeescript 1.12.7 package in server now directly since it isn't reused.

@flotwig
Copy link
Contributor Author

flotwig commented Jun 10, 2020

  1. Gonna merge this PR, so all the commits will go in
  2. I left these because they effectively serve as integration tests for Cypress's coffeescript support, but with time, the majority can be ported over since you're right, only a few of them are actually needed to test the CS functionality.
  3. Yep that's all it does now... I'd be ok with this change

@flotwig flotwig force-pushed the remove-coffeescript-internal branch from 6aecc49 to e0b31cb Compare June 10, 2020 13:29
@flotwig
Copy link
Contributor Author

flotwig commented Jun 10, 2020

@jennifer-shehane updated it to remove @packages/coffee and moved the coffeescript dep directly to @packages/server

@flotwig flotwig merged commit 0e63263 into develop Jun 10, 2020
@flotwig flotwig deleted the remove-coffeescript-internal branch January 24, 2022 18:15
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.

None yet

2 participants