fix(driver): add support for alias.all when using dynamic alias (#28352)

* add tests for failing instance * fix: support for dynamic alias.all * update changelog * Update cli/CHANGELOG.md Co-authored-by: Matt Schile <[email protected]> * move test * Update cli/CHANGELOG.md Co-authored-by: Emily Rohrbough <[email protected]> --------- Co-authored-by: Matt Schile <[email protected]> Co-authored-by: Emily Rohrbough <[email protected]>
cypress-io · Nov 16, 2023 · 02d0493 · 02d0493 · cypress-bot · Nov 16, 2023
1 parent d6e2a0d
commit 02d0493
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 5 deletions.
diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -9,12 +9,13 @@ _Released 11/21/2023 (PENDING)_
 
 **Bugfixes:**
 
+- Fixed an issue where [aliasing individual requests](https://docs.cypress.io/api/commands/intercept#Aliasing-individual-requests) with `cy.intercept()` led to an error when retrieving all of the aliases with `cy.get(@alias.all)` . Addresses [#25448](https://github.com/cypress-io/cypress/issues/25448)
 - The URL of the application under test and command error "Learn more" links now open externally instead of in the Cypress-launched browser. Fixes [#24572](https://github.com/cypress-io/cypress/issues/24572).
 
 **Misc:**
 
 - Browser tabs and windows other than the Cypress tab are now closed between tests in Chromium-based browsers. Addressed in [#28204](https://github.com/cypress-io/cypress/pull/28204).
-- Cypress now ensures the main browser tab is active before running eaech command in Chromium-based browsers. Addressed in [#28334](https://github.com/cypress-io/cypress/pull/28334).
+- Cypress now ensures the main browser tab is active before running each command in Chromium-based browsers. Addressed in [#28334](https://github.com/cypress-io/cypress/pull/28334).
 
 ## 13.5.1
 

diff --git a/packages/driver/cypress/e2e/commands/net_stubbing.cy.ts b/packages/driver/cypress/e2e/commands/net_stubbing.cy.ts
@@ -3732,6 +3732,25 @@ describe('network stubbing', { retries: 15 }, function () {
         })
       })
 
+      // @see https://github.com/cypress-io/cypress/issues/25448
+      it('gets all aliased Interceptions by alias.all when assigning an alias using req.alias', function () {
+        const url = uniqueRoute('/foo')
+
+        cy.intercept(`${url}*`, (req) => {
+          req.alias = 'alias'
+          req.reply({ bar: 'baz' })
+        })
+        .then(() => {
+          $.get(url)
+          $.get(url)
+        })
+        .wait('@alias').wait('@alias')
+
+        cy.get('@alias.all').then((interceptions) => {
+          expect(interceptions).to.have.length(2)
+        })
+      })
+
       // TODO: fix+document this behavior
       // @see https://github.com/cypress-io/cypress/issues/7663
       it.skip('gets indexed Interception by alias.number', function () {

diff --git a/packages/driver/src/cy/aliases.ts b/packages/driver/src/cy/aliases.ts
@@ -12,7 +12,7 @@ const requestXhrRe = /\.request$/
 
 const reserved = ['test', 'runnable', 'timeout', 'slow', 'skip', 'inspect']
 
-const aliasDisplayName = (name) => {
+export const aliasDisplayName = (name) => {
   return name.replace(aliasDisplayRe, '')
 }
 

diff --git a/packages/driver/src/cy/commands/querying/querying.ts b/packages/driver/src/cy/commands/querying/querying.ts
@@ -7,7 +7,7 @@ import $utils from '../../../cypress/utils'
 import type { Log } from '../../../cypress/log'
 import { resolveShadowDomInclusion } from '../../../cypress/shadow_dom_utils'
 import { getAliasedRequests, isDynamicAliasingPossible } from '../../net-stubbing/aliasing'
-import { aliasRe, aliasIndexRe } from '../../aliases'
+import { aliasRe, aliasIndexRe, aliasDisplayName } from '../../aliases'
 
 type GetOptions = Partial<Cypress.Loggable & Cypress.Timeoutable & Cypress.Withinable & Cypress.Shadow & {
   _log?: Log
@@ -38,15 +38,17 @@ function getAlias (selector, log, cy) {
       aliasObj = cy.getAlias(toSelect)
     } catch (err) {
       // possibly this is a dynamic alias, check to see if there is a request
-      const requests = getAliasedRequests(alias, cy.state)
+      // We need to use the stripped alias
+      const strippedAlias = aliasDisplayName(toSelect)
+      const requests = getAliasedRequests(strippedAlias, cy.state)
 
       if (!isDynamicAliasingPossible(cy.state) || !requests.length) {
         err.retry = false
         throw err
       }
 
       aliasObj = {
-        alias,
+        alias: strippedAlias,
         command: cy.state('routes')[requests[0].routeId].command,
       }
     }