chore: add browser state action for debug (#26763)

cypress-io · May 30, 2023 · b5c8b15 · b5c8b15
1 parent acc4d5f
commit b5c8b15
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 0 deletions.
diff --git a/packages/data-context/src/actions/ProjectActions.ts b/packages/data-context/src/actions/ProjectActions.ts
@@ -55,6 +55,7 @@ export interface ProjectApiShape {
   resetBrowserTabsForNextTest(shouldKeepTabOpen: boolean): Promise<void>
   resetServer(): void
   runSpec(spec: Cypress.Spec): Promise<void>
+  routeToDebug(): Promise<void>
 }
 
 export interface FindSpecs<T> {
@@ -637,4 +638,9 @@ export class ProjectActions {
       }
     }
   }
+
+  async debugCloudRun ({ runNumber }: { runNumber: number }) {
+    await this.ctx.relevantRuns.moveToRun(runNumber, this.ctx.git?.currentHashes || [])
+    await this.api.routeToDebug()
+  }
 }
diff --git a/packages/data-context/test/unit/actions/ProjectActions.spec.ts b/packages/data-context/test/unit/actions/ProjectActions.spec.ts
@@ -264,4 +264,19 @@ describe('ProjectActions', () => {
       })
     })
   })
+
+  describe('debugCloudRun', () => {
+    context('default', () => {
+      beforeEach(() => {
+        sinon.stub(ctx.relevantRuns, 'moveToRun')
+      })
+
+      it('should succeed', async () => {
+        await ctx.actions.project.debugCloudRun({ runNumber: 123 })
+
+        expect(ctx.relevantRuns.moveToRun).to.have.been.calledWith(123)
+        expect(ctx._apis.projectApi.routeToDebug).to.have.been.called
+      })
+    })
+  })
 })
diff --git a/packages/data-context/test/unit/helper.ts b/packages/data-context/test/unit/helper.ts
@@ -57,6 +57,7 @@ export function createTestDataContext (mode: DataContextConfig['mode'] = 'run',
       insertProjectToCache: sinon.stub().resolves(),
       getProjectRootsFromCache: sinon.stub().resolves([]),
       runSpec: sinon.stub(),
+      routeToDebug: sinon.stub(),
     } as unknown as ProjectApiShape,
     electronApi: {
       isMainWindowFocused: sinon.stub().returns(false),

diff --git a/packages/graphql/schemas/schema.graphql b/packages/graphql/schemas/schema.graphql
@@ -1786,6 +1786,9 @@ type Mutation {
   """Set failed tests for the current run to be used by the runner"""
   setTestsForRun(testsBySpec: [TestsBySpecInput!]!): Boolean
 
+  """Set the route to debug and show the specified the CloudRun"""
+  showDebugForCloudRun(runNumber: Int!): Query
+
   """Show system notification via Electron"""
   showSystemNotification(body: String!, title: String!): Boolean
 

diff --git a/packages/graphql/src/schemaTypes/objectTypes/gql-Mutation.ts b/packages/graphql/src/schemaTypes/objectTypes/gql-Mutation.ts
@@ -847,5 +847,18 @@ export const mutation = mutationType({
         return true
       },
     })
+
+    t.field('showDebugForCloudRun', {
+      type: Query,
+      description: 'Set the route to debug and show the specified the CloudRun',
+      args: {
+        runNumber: nonNull(intArg()),
+      },
+      resolve: async (_, args, ctx) => {
+        await ctx.actions.project.debugCloudRun({ runNumber: args.runNumber })
+
+        return {}
+      },
+    })
   },
 })
diff --git a/packages/server/lib/makeDataContext.ts b/packages/server/lib/makeDataContext.ts
@@ -164,6 +164,9 @@ export function makeDataContext (options: MakeDataContextOptions): DataContext {
       async runSpec (spec: Cypress.Spec): Promise<void> {
         openProject.changeUrlToSpec(spec)
       },
+      async routeToDebug (): Promise<void> {
+        openProject.changeUrlToDebug()
+      },
     },
     electronApi: {
       openExternal (url: string) {

diff --git a/packages/server/lib/open_project.ts b/packages/server/lib/open_project.ts
@@ -238,6 +238,20 @@ export class OpenProject {
     this.projectBase.server._socket.changeToUrl(newSpecUrl)
   }
 
+  changeUrlToDebug () {
+    if (!this.projectBase) {
+      debug('No projectBase, cannot change url')
+
+      return
+    }
+
+    const newUrl = `#/debug/`
+
+    debug(`New url is ${newUrl}`)
+
+    this.projectBase.server._socket.changeToUrl(newUrl)
+  }
+
   /**
    * Sends the new telemetry context to the browser
    * @param context - telemetry context string