spike: attempt to use url() and hash() in the automation client and unbind it from the window

Author: AtofStryker

packages/driver/src/cy/commands/location.ts

@@ -3,29 +3,16 @@ import _ from 'lodash'
 import $errUtils from '../../cypress/error_utils'
 
 export default (Commands, Cypress, cy) => {
-  Commands.addQuery('url', function url (options: Partial<Cypress.UrlOptions> = {}) {
-    // Make sure the url command can communicate with the AUT.
-    // otherwise, it yields an empty string
-    Cypress.ensure.commandCanCommunicateWithAUT(cy)
-    this.set('timeout', options.timeout)
-
+  Commands.add('url', function url (options: Partial<Cypress.UrlOptions> = {}) {
     Cypress.log({ message: '', hidden: options.log === false, timeout: options.timeout })
 
-    return () => {
-      const href = cy.getRemoteLocation('href')
-
-      return options.decode ? decodeURI(href) : href
-    }
+    return Cypress.automation('get:aut:url', {})
   })
 
-  Commands.addQuery('hash', function url (options: Partial<Cypress.Loggable & Cypress.Timeoutable> = {}) {
-    // Make sure the hash command can communicate with the AUT.
-    Cypress.ensure.commandCanCommunicateWithAUT(cy)
-    this.set('timeout', options.timeout)
-
+  Commands.add('hash', function url (options: Partial<Cypress.Loggable & Cypress.Timeoutable> = {}) {
     Cypress.log({ message: '', hidden: options.log === false, timeout: options.timeout })
 
-    return () => cy.getRemoteLocation('hash')
+    return Cypress.automation('get:aut:url:hash', {})
   })
 
   Commands.addQuery('location', function location (key, options: Partial<Cypress.Loggable & Cypress.Timeoutable> = {}) {
@@ -34,7 +21,7 @@ export default (Commands, Cypress, cy) => {
 
     // Make sure the location command can communicate with the AUT.
     // otherwise the command just yields 'null' and the reason may be unclear to the user.
-    Cypress.ensure.commandCanCommunicateWithAUT(cy)
+    // Cypress.ensure.commandCanCommunicateWithAUT(cy)
     if (_.isObject(key)) {
       options = key
     }

packages/driver/src/cy/commands/window.ts

@@ -100,7 +100,7 @@ export default (Commands, Cypress, cy, state) => {
 
   Commands.addQuery('window', function windowFn (options: Partial<Cypress.Loggable & Cypress.Timeoutable> = {}) {
     // Make sure the window command can communicate with the AUT.
-    Cypress.ensure.commandCanCommunicateWithAUT(cy)
+    // Cypress.ensure.commandCanCommunicateWithAUT(cy)
     this.set('timeout', options.timeout)
     Cypress.log({
       hidden: options.log === false,

packages/server/lib/browsers/bidi_automation.ts

@@ -659,6 +659,22 @@ export class BidiAutomation {
           }
 
           return
+        case 'get:aut:url':
+        {
+          const { contexts: autContext } = await this.webDriverClient.browsingContextGetTree({
+            root: this.autContextId,
+          })
+
+          return autContext ? autContext[0].url : ''
+        }
+        case 'get:aut:url:hash':
+        {
+          const { contexts: autContext } = await this.webDriverClient.browsingContextGetTree({
+            root: this.autContextId,
+          })
+
+          return autContext ? new URL(autContext[0].url).hash : ''
+        }
         default:
           debug('BiDi automation not implemented for message: %s', message)
           throw new AutomationNotImplemented(message, 'BiDiAutomation')

packages/server/lib/browsers/cdp_automation.ts

@@ -464,6 +464,33 @@ export class CdpAutomation implements CDPClient, AutomationMiddleware {
     return false
   }
 
+  private _getAutFrame = async () => {
+    try {
+      const frameTree = (await this.sendDebuggerCommandFn('Page.getFrameTree')).frameTree
+      const frame = _.find(frameTree?.childFrames || [], ({ frame }) => {
+        return frame?.name?.startsWith('Your project:')
+      }) as HasFrame | undefined
+
+      return frame?.frame
+    } catch (err) {
+      debugVerbose('failed to get aut frame:', err.stack)
+
+      return undefined
+    }
+  }
+
+  private _getAutUrl = async () => {
+    const frame = await this._getAutFrame()
+
+    return frame?.url || ''
+  }
+
+  private _getAutUrlHash = async () => {
+    const frame = await this._getAutFrame()
+
+    return frame?.urlFragment || ''
+  }
+
   _handlePausedRequests = async (client: CriClient) => {
     // NOTE: only supported in chromium based browsers
     await client.send('Fetch.enable', {
@@ -611,6 +638,10 @@ export class CdpAutomation implements CDPClient, AutomationMiddleware {
         }
 
         return cdpKeyPress(data, this.sendDebuggerCommandFn, this.executionContexts, (await this.send('Page.getFrameTree')).frameTree)
+      case 'get:aut:url':
+        return this._getAutUrl()
+      case 'get:aut:url:hash':
+        return this._getAutUrlHash()
       default:
         throw new Error(`No automation handler registered for: '${message}'`)
     }

packages/types/src/server.ts

@@ -91,6 +91,8 @@ export interface AutomationCommands {
   'remote:debugger:protocol': CommandSignature
   'response:received': CommandSignature
   'key:press': CommandSignature<KeyPressParams, void>
+  'get:aut:url': CommandSignature<{ url: string }, string>
+  'get:aut:url:hash': CommandSignature<{ hash: string }, string>
 }
 
 export type OnRequestEvent = <T extends keyof AutomationCommands>(message: T, data: AutomationCommands[T]['dataType']) => Promise<AutomationCommands[T]['returnType']>