chore: improve types for server automation cookie client (#25836)

* chore: improve types for automation cookies

* [run ci]

packages/driver/src/cross-origin/events/cookies.ts

@@ -1,4 +1,4 @@
-import type { AutomationCookie } from '@packages/server/lib/automation/cookies'
+import type { SerializableAutomationCookie } from '@packages/server/lib/util/cookies'
 import type { ICypress } from '../../cypress'
 
 // cross-origin cookies collected by the the proxy are sent down to the driver
@@ -10,10 +10,10 @@ export const handleCrossOriginCookies = (Cypress: ICypress) => {
   // multiple requests could set cookies while the page is loading, so we
   // collect all cookies and only send set them via automation once after
   // the page has loaded
-  let cookiesToSend: AutomationCookie[] = []
+  let cookiesToSend: SerializableAutomationCookie[] = []
   let waitingToSend = false
 
-  Cypress.on('cross:origin:cookies', (cookies: AutomationCookie[]) => {
+  Cypress.on('cross:origin:cookies', (cookies: SerializableAutomationCookie[]) => {
     cookiesToSend = cookiesToSend.concat(cookies)
 
     Cypress.backend('cross:origin:cookies:received')

packages/driver/types/internal-types.d.ts

@@ -53,10 +53,10 @@ declare namespace Cypress {
   }
 
   interface Actions {
-    (action: 'set:cookie', fn: (cookie: AutomationCookie) => void)
+    (action: 'set:cookie', fn: (cookie: SerializableAutomationCookie) => void)
     (action: 'clear:cookie', fn: (name: string) => void)
     (action: 'clear:cookies', fn: () => void)
-    (action: 'cross:origin:cookies', fn: (cookies: AutomationCookie[]) => void)
+    (action: 'cross:origin:cookies', fn: (cookies: SerializableAutomationCookie[]) => void)
     (action: 'before:stability:release', fn: () => void)
     (action: 'paused', fn: (nextCommandName: string) => void)
   }

packages/proxy/lib/http/index.ts

@@ -20,9 +20,8 @@ import RequestMiddleware from './request-middleware'
 import ResponseMiddleware from './response-middleware'
 import { DeferredSourceMapCache } from '@packages/rewriter'
 import type { RemoteStates } from '@packages/server/lib/remote_states'
-import type { CookieJar } from '@packages/server/lib/util/cookies'
+import type { CookieJar, SerializableAutomationCookie } from '@packages/server/lib/util/cookies'
 import type { RequestedWithAndCredentialManager } from '@packages/server/lib/util/requestedWithAndCredentialManager'
-import type { AutomationCookie } from '@packages/server/lib/automation/cookies'
 import { errorUtils } from '@packages/errors'
 
 function getRandomColorFn () {
@@ -59,7 +58,7 @@ type HttpMiddlewareCtx<T> = {
   getPreRequest: (cb: GetPreRequestCb) => void
   getAUTUrl: Http['getAUTUrl']
   setAUTUrl: Http['setAUTUrl']
-  simulatedCookies: AutomationCookie[]
+  simulatedCookies: SerializableAutomationCookie[]
 } & T
 
 export const defaultMiddleware = {

packages/proxy/lib/http/util/cookies.ts

@@ -3,7 +3,7 @@ import type Debug from 'debug'
 import { URL } from 'url'
 import { cors } from '@packages/network'
 import { urlOriginsMatch, urlSameSiteMatch } from '@packages/network/lib/cors'
-import { AutomationCookie, Cookie, CookieJar, toughCookieToAutomationCookie } from '@packages/server/lib/util/cookies'
+import { SerializableAutomationCookie, Cookie, CookieJar, toughCookieToAutomationCookie } from '@packages/server/lib/util/cookies'
 import type { RequestCredentialLevel, RequestedWithHeader } from '../../types'
 
 type SiteContext = 'same-origin' | 'same-site' | 'cross-site'
@@ -197,7 +197,7 @@ export class CookiesHelper {
 
     const afterCookies = this.cookieJar.getAllCookies()
 
-    return afterCookies.reduce<AutomationCookie[]>((memo, afterCookie) => {
+    return afterCookies.reduce<SerializableAutomationCookie[]>((memo, afterCookie) => {
       if (matchesPreviousCookie(this.previousCookies, afterCookie)) return memo
 
       return memo.concat(toughCookieToAutomationCookie(afterCookie, this.defaultDomain))

packages/proxy/lib/http/util/inject.ts

@@ -1,14 +1,14 @@
 import { oneLine } from 'common-tags'
 import { getRunnerInjectionContents, getRunnerCrossOriginInjectionContents } from '@packages/resolve-dist'
-import type { AutomationCookie } from '@packages/server/lib/automation/cookies'
+import type { SerializableAutomationCookie } from '@packages/server/lib/util/cookies'
 
 interface InjectionOpts {
   shouldInjectDocumentDomain: boolean
 }
 interface FullCrossOriginOpts {
   modifyObstructiveThirdPartyCode: boolean
   modifyObstructiveCode: boolean
-  simulatedCookies: AutomationCookie[]
+  simulatedCookies: SerializableAutomationCookie[]
 }
 
 export function partial (domain, options: InjectionOpts) {

packages/proxy/lib/http/util/rewriter.ts

@@ -2,7 +2,7 @@ import * as inject from './inject'
 import * as astRewriter from './ast-rewriter'
 import * as regexRewriter from './regex-rewriter'
 import type { CypressWantsInjection } from '../../types'
-import type { AutomationCookie } from '@packages/server/lib/automation/cookies'
+import type { SerializableAutomationCookie } from '@packages/server/lib/util/cookies'
 
 export type SecurityOpts = {
   isNotJavascript?: boolean
@@ -17,7 +17,7 @@ export type InjectionOpts = {
   domainName: string
   wantsInjection: CypressWantsInjection
   wantsSecurityRemoved: any
-  simulatedCookies: AutomationCookie[]
+  simulatedCookies: SerializableAutomationCookie[]
   shouldInjectDocumentDomain: boolean
 }
 

packages/runner/injection/patches/cookies.ts

@@ -2,15 +2,15 @@ import {
   CookieJar,
   toughCookieToAutomationCookie,
   automationCookieToToughCookie,
+  SerializableAutomationCookie,
 } from '@packages/server/lib/util/cookies'
 import { Cookie as ToughCookie } from 'tough-cookie'
-import type { AutomationCookie } from '@packages/server/lib/automation/cookies'
 
 function isHostOnlyCookie (domain) {
   return domain[0] !== '.'
 }
 
-const parseDocumentCookieString = (documentCookieString: string): AutomationCookie[] => {
+const parseDocumentCookieString = (documentCookieString: string): SerializableAutomationCookie[] => {
   if (!documentCookieString || !documentCookieString.trim().length) return []
 
   return documentCookieString.split(';').map((cookieString) => {
@@ -33,7 +33,7 @@ const parseDocumentCookieString = (documentCookieString: string): AutomationCook
   })
 }
 
-const sendCookieToServer = (cookie: AutomationCookie) => {
+const sendCookieToServer = (cookie: SerializableAutomationCookie) => {
   window.top!.postMessage({
     event: 'cross:origin:aut:set:cookie',
     data: {
@@ -52,7 +52,7 @@ const sendCookieToServer = (cookie: AutomationCookie) => {
 // document.cookie runs into cross-origin restrictions when the AUT is on
 // a different origin than top. The goal is to make it act like it would
 // if the user's app was run in top.
-export const patchDocumentCookie = (requestCookies: AutomationCookie[]) => {
+export const patchDocumentCookie = (requestCookies: SerializableAutomationCookie[]) => {
   const url = location.href
   const domain = location.hostname
   const cookieJar = new CookieJar()
@@ -64,7 +64,7 @@ export const patchDocumentCookie = (requestCookies: AutomationCookie[]) => {
     }).join('; ')
   }
 
-  const addCookies = (cookies: AutomationCookie[]) => {
+  const addCookies = (cookies: SerializableAutomationCookie[]) => {
     cookies.forEach((cookie) => {
       cookieJar.setCookie(automationCookieToToughCookie(cookie, domain), url, undefined)
     })
@@ -154,7 +154,7 @@ export const patchDocumentCookie = (requestCookies: AutomationCookie[]) => {
 
     // the following listeners are called from Cypress cookie commands, so that
     // the document.cookie value is updated optimistically
-    Cypress.on('set:cookie', (cookie: AutomationCookie) => {
+    Cypress.on('set:cookie', (cookie: SerializableAutomationCookie) => {
       setCookie(automationCookieToToughCookie(cookie, domain))
     })
 

packages/server/lib/automation/automation.ts

@@ -38,8 +38,8 @@ export class Automation {
     this.middleware = this.initializeMiddleware()
   }
 
-  automationValve (message, fn) {
-    return (msg, data) => {
+  automationValve (message: string, fn: (...args: any) => any) {
+    return (msg: string, data: any) => {
       // enable us to omit message
       // argument
       if (!data) {
@@ -60,7 +60,7 @@ export class Automation {
     }
   }
 
-  requestAutomationResponse (message, data, fn) {
+  requestAutomationResponse (message: string, data: any, fn: (...args: any) => any) {
     return new Bluebird((resolve, reject) => {
       const id = uuidv4()
 
@@ -97,7 +97,7 @@ export class Automation {
     })
   }
 
-  normalize (message, data, automate?) {
+  normalize (message: string, data: any, automate?) {
     return Bluebird.try(() => {
       switch (message) {
         case 'take:screenshot':