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

Issue #6216 -- have .its() receive the number 0 as parameter #6234

Merged
merged 4 commits into from
Jan 27, 2020

Conversation

datner
Copy link
Contributor

@datner datner commented Jan 24, 2020

User facing changelog

its() now supports 0 as a value for indexes or object keys

Additional details

Many times a developer will intuitively reach for the first item in an array for tests or checks
(or for anything if I'm honest), and until now trying to reach that property using .its(0) threw an error.
Now developers world-wide would be able to check the first index of their array in a cypress environment. Well, I'm sure you could still have done it with .its("0") but just isn't as cool.

The tests check for edge cases, other than that I didn't do anything unexpected

How has the user experience changed?

this didn't work, now it does, it's the intuitive thing to do, so it's pretty chill

 cy.wrap(["cake","hamburger"]).its(0).should("eq","cake");

PR Tasks

Is there anything to add to cypress-documentation? This now works as planned, I didn't add any new features to the mental model of how .its() operates

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jan 24, 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.

@claassistantio
Copy link

claassistantio commented Jan 24, 2020

CLA assistant check
All committers have signed the CLA.

@datner datner changed the title Issue 6216 its 0 index Issue #6216 -- have .its() receive the number 0 as parameter Jan 24, 2020
@jennifer-shehane jennifer-shehane requested review from jennifer-shehane and flotwig and removed request for jennifer-shehane January 24, 2020 11:06
Copy link
Contributor

@flotwig flotwig left a comment

Choose a reason for hiding this comment

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

Thanks for opening this PR! The changes look good, but I noticed a few minor things that should be fixed before this is merged.

@bahmutov
Copy link
Contributor

bahmutov commented Jan 24, 2020 via email

@datner
Copy link
Contributor Author

datner commented Jan 26, 2020

@bahmutov
I am still waiting for a reply on what to do on that occasion, my guess would be to just ignore it? it'll return undefined every time and thats not an issue, it's reality. Also lets object with the key "-1" still work

@datner
Copy link
Contributor Author

datner commented Jan 26, 2020

image

Uhhh.. I am not really sure what to do about this.... I used the same computer and user and repo and set up, nothing changed between the commits..?

@flotwig
Copy link
Contributor

flotwig commented Jan 27, 2020

Uhhh.. I am not really sure what to do about this.... I used the same computer and user and repo and set up, nothing changed between the commits..?

It looks like you made the first commits with a gmail email address, then you made the last two commits with an email address (contact [at] datner [dot] me) which is not yet linked to your GitHub account.

Add this email to your GitHub account and confirm it, then ask the CLA assistant to retry, it should work once the 2nd email is associated with your GitHub: https://github.com/settings/emails

I am still waiting for a reply on what to do on that occasion, my guess would be to just ignore it? it'll return undefined every time and thats not an issue, it's reality. Also lets object with the key "-1" still work

Yup, negative indices are valid, this is good.

@flotwig
Copy link
Contributor

flotwig commented Jan 27, 2020

Thanks!

@flotwig flotwig merged commit c29f383 into cypress-io:develop Jan 27, 2020
@datner
Copy link
Contributor Author

datner commented Jan 28, 2020

It looks like you made the first commits with a gmail email address, then you made the last two commits with an email address (contact [at] datner [dot] me) which is not yet linked to your GitHub account.

Very odd.. I never used that email for git. But done

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.

An Its() function cannot access index of zero.
4 participants