Document @alias.all and @alias.2

[jennifer-shehane]

I'm submitting a...

[ ] Bug report 
[x] Content update
[ ] Process update (build, deployment, ... )

Type of bug / changes

We should document the use of @alias.all and @alias.2 within a couple of documents:

• https://docs.cypress.io/guides/core-concepts/variables-and-aliases.html
• https://docs.cypress.io/api/commands/get.html#Alias

When referencing aliases, you can reference @alias.all or @alias.2 and it will return respectively all of the aliases of that name or the 2nd request matching the name.

Examples:

it("does not poll for list again", function() {
  cy.wait("@getList");
  cy.tick(10000);
  // does not poll for another request
  cy.get("@getList.all").should("have.length", 1);
});

it("first request has correct data", function() {
  cy.route({
    url: 'users',
    response: 'fx:users'
  }).as("getUsers");
  cy.visit("/users");
  cy.get("@getUsers.1").then((xhr) => {
    expect(xhr.url).to.include("page=1"))
  })
});

[clarmso]

There needs to be a discussion whether the use of alias.all and alias.[1-9][0-9]? should be documented or not. It sounds like this feature is unadvertised on purpose.
cypress-io/cypress#3929 (comment)

[lpanger]

I have an issue using the .all option. It doesn't seem to retry when it's used with .should.

Modified from your example above cy.get("@getList.all").should("have.length", 2); I expect it to retry until 2 requests were made. It fails immediately for me. I've also tried using a timeout option with the get call but it still fails immediately no matter how long I set the timeout.

It's not clear to me if this feature is production ready or experimental so I won't log a bug.

[jennifer-shehane]

@lpanger Using the cy.get("@getList.all") has no retrying mechanism. It simply gets the requests that have currently been resolved immediately when it is called. This is not a way to 'wait for all requests', as we have no idea what 'all' means for your application. It is only a way to get all currently matching requests for that alias.

[lpanger]

I assumed by chaining with .should() it would retry until the condition is met. It's unfortunate it doesn't work that way.