fix(driver): dynamic intercept aliases shown with name instead of no alias

[S-Tornqvist]

• Closes Individual requests aliases not working #24653

Additional details

Previously, dynamic aliases added using cy.intercept (documentation) would not show up in the app. cy.wait would still work for them, but the aliases incorrectly renamed to "no alias" in the output confused users. See #24653.

Sample spec for reproduction:

const URL = "https://example.cypress.io"

describe('sample spec', () => {

  // Works before and after.
  it('static alias works', () => {
    cy.intercept('GET', URL).as("sampleRequest");

    cy.visit(URL)
    cy.wait('@sampleRequest')
  })

  // Did not work before. Works after.
  it('dynamic alias works', () => {
    cy.intercept('GET', URL, (req) => {
      req.alias = 'sampleRequest';
    });

    cy.visit(URL)
    cy.wait('@sampleRequest')
  })
})

Steps to test

@jordanpowell88 provided testing through a fixture in dynamic-route-aliases.runner.cy.js that uses a dynamic alias and verifying the behavior in the test aliases.cy.ts. Thanks!

How has the user experience changed?

Sample spec output before and after changes:

PR Tasks

• Have tests been added/updated?
• [na] Has a PR for user-facing changes been opened in cypress-documentation?
• [na] Have API changes been updated in the type definitions?

[cypress-app-bot]

• 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.

[S-Tornqvist]

How to test cy.intercept request alias matcher gui label? (solved)

I'm unsure how to test this part of the driver:

The intercept matcher previously worked functionally, it was only the visual part that was previously incorrect.

Fixed by @jordanpowell88 in c4e82bb

[emilyrohrbough]

This test is pretty heavy when we could be validating log attributes within a driver test

[emilyrohrbough]

Similar to this test: https://github.com/cypress-io/cypress/blob/develop/packages/driver/cypress/e2e/commands/net_stubbing.cy.ts#L3531-L3532

[jordanpowell88]

I am not super familiar with the driver but the way I understand it, the run time aliases that are set in the callback of intercept can't be triggered via a command? Am I missing something @emilyrohrbough ?

[emilyrohrbough]

You can pull it from the log list and execute the renderProps function to pull the value. Intercepts is a tricker command, I was playing with it and noticed we already have a test for dynamic aliases here, and we can add this to verify the alias renders correctly:

https://github.com/cypress-io/cypress/blob/develop/packages/driver/cypress/e2e/commands/net_stubbing.cy.ts#L3802

      it('can dynamically alias the request', function () {
        const url = uniqueRoute('/foo')

        cy.intercept(`${url}*`, (req) => {
          req.alias = 'fromInterceptor'
        })
        .then(() => {
          $.get(url)
        })
        .wait('@fromInterceptor')
+       .then(() => {
+         const log = cy.queue.logs({
+            displayName: 'xhr',
+         })[0]

+         const renderProps = log.get('renderProps')()

+         expect(renderProps.interceptions).to.have.length(1)
+         expect(renderProps.interceptions[0]).to.have.property('alias')
+         expect(renderProps.interceptions[0].alias).to.eq('fromInterceptor')
+        })
      })

[jordanpowell88]

Thank you! Just pushed a change

[emilyrohrbough]

This test should be in the driver package

[cypress-bot]

Released in 13.6.0.

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