fix(server): correctly include projectRoot when adding a CI project f…

…rom GUI (#17514) Co-authored-by: Barthélémy Ledoux <[email protected]> Co-authored-by: semantic-release-bot <[email protected]> Co-authored-by: Jennifer Shehane <[email protected]> Co-authored-by: Chris Breiding <[email protected]>
cypress-io · Jul 29, 2021 · e49b3a4 · e49b3a4 · cypress-bot · Jul 29, 2021
1 parent a5305de
commit e49b3a4
Show file tree

Hide file tree

Showing 14 changed files with 68 additions and 21 deletions.
diff --git a/npm/vite-dev-server/CHANGELOG.md b/npm/vite-dev-server/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [@cypress/vite-dev-server-v2.0.3](https://github.com/cypress-io/cypress/compare/@cypress/vite-dev-server-v2.0.2...@cypress/vite-dev-server-v2.0.3) (2021-07-27)
+
+
+### Bug Fixes
+
+* make vite re-run on supportFile change ([#17485](https://github.com/cypress-io/cypress/issues/17485)) ([6cbf4c3](https://github.com/cypress-io/cypress/commit/6cbf4c38296d6287fbcbb0ef5ecd21cf63606153))
+
 # [@cypress/vite-dev-server-v2.0.2](https://github.com/cypress-io/cypress/compare/@cypress/vite-dev-server-v2.0.1...@cypress/vite-dev-server-v2.0.2) (2021-07-15)
 
 

diff --git a/npm/vite-dev-server/cypress/styles.css b/npm/vite-dev-server/cypress/styles.css
@@ -0,0 +1,3 @@
+body {
+	color: indigo;
+}
diff --git a/npm/vite-dev-server/cypress/support.js b/npm/vite-dev-server/cypress/support.js
@@ -1,4 +1,5 @@
 import '@testing-library/cypress/add-commands'
+import './styles.css'
 
 before(() => {
   window.supportFileWasLoaded = true

diff --git a/npm/vite-dev-server/src/index.ts b/npm/vite-dev-server/src/index.ts
@@ -1,8 +1,8 @@
 import { debug as debugFn } from 'debug'
-import { start as createDevServer, StartDevServer } from './startServer'
+import { start as createDevServer, StartDevServerOptions } from './startServer'
 const debug = debugFn('cypress:vite-dev-server:vite')
 
-export { StartDevServer }
+export { StartDevServerOptions }
 
 type DoneCallback = () => unknown
 
@@ -11,7 +11,7 @@ export interface ResolvedDevServerConfig {
   close: (done?: DoneCallback) => void
 }
 
-export async function startDevServer (startDevServerArgs: StartDevServer): Promise<ResolvedDevServerConfig> {
+export async function startDevServer (startDevServerArgs: StartDevServerOptions): Promise<ResolvedDevServerConfig> {
   const viteDevServer = await createDevServer(startDevServerArgs)
 
   const app = await viteDevServer.listen()

diff --git a/npm/vite-dev-server/src/makeCypressPlugin.ts b/npm/vite-dev-server/src/makeCypressPlugin.ts
@@ -21,8 +21,12 @@ const INIT_FILEPATH = resolve(__dirname, '../client/initCypressTests.js')
 
 const HMR_DEPENDENCY_LOOKUP_MAX_ITERATION = 50
 
-function getSpecsSet (specs: Spec[]) {
-  return new Set<string>(specs.map((spec) => spec.absolute))
+function getSpecsPathsSet (specs: Spec[], supportFile?: string | null) {
+  return new Set<string>(
+    supportFile
+      ? [...specs.map((spec) => spec.absolute), supportFile]
+      : specs.map((spec) => spec.absolute),
+  )
 }
 
 interface Spec{
@@ -38,10 +42,10 @@ export const makeCypressPlugin = (
 ): Plugin => {
   let base = '/'
 
-  let specsPathsSet = getSpecsSet(specs)
+  let specsPathsSet = getSpecsPathsSet(specs, supportFilePath)
 
   devServerEvents.on('dev-server:specs:changed', (specs: Spec[]) => {
-    specsPathsSet = getSpecsSet(specs)
+    specsPathsSet = getSpecsPathsSet(specs, supportFilePath)
   })
 
   const posixSupportFilePath = supportFilePath ? convertPathToPosix(resolve(projectRoot, supportFilePath)) : undefined
@@ -101,6 +105,7 @@ export const makeCypressPlugin = (
 
         // as soon as we find one of the specs, we trigger the re-run of tests
         for (const mod of moduleImporters.values()) {
+          debug('handleHotUpdate - mod.file', mod.file)
           if (specsPathsSet.has(mod.file)) {
             debug('handleHotUpdate - compile success')
             devServerEvents.emit('dev-server:compile:success', { specFile: mod.file })

diff --git a/npm/vite-dev-server/src/startServer.ts b/npm/vite-dev-server/src/startServer.ts
@@ -13,7 +13,7 @@ interface Options {
   [key: string]: unknown
 }
 
-export interface StartDevServer {
+export interface StartDevServerOptions {
   /**
    * the Cypress options object
    */
@@ -27,7 +27,7 @@ export interface StartDevServer {
   viteConfig?: UserConfig
 }
 
-const resolveServerConfig = async ({ viteConfig, options }: StartDevServer): Promise<InlineConfig> => {
+const resolveServerConfig = async ({ viteConfig, options }: StartDevServerOptions): Promise<InlineConfig> => {
   const { projectRoot, supportFile } = options.config
 
   const requiredOptions: InlineConfig = {
@@ -66,7 +66,7 @@ const resolveServerConfig = async ({ viteConfig, options }: StartDevServer): Pro
   return finalConfig
 }
 
-export async function start (devServerOptions: StartDevServer): Promise<ViteDevServer> {
+export async function start (devServerOptions: StartDevServerOptions): Promise<ViteDevServer> {
   if (!devServerOptions.viteConfig) {
     debug('User did not pass in any Vite dev server configuration')
     devServerOptions.viteConfig = {}

diff --git a/npm/vue/CHANGELOG.md b/npm/vue/CHANGELOG.md
@@ -1,3 +1,10 @@
+# [@cypress/vue-v3.0.0-beta.4](https://github.com/cypress-io/cypress/compare/@cypress/vue-v3.0.0-beta.3...@cypress/vue-v3.0.0-beta.4) (2021-07-27)
+
+
+### Bug Fixes
+
+* do not register CT specific event in e2e mode ([5836203](https://github.com/cypress-io/cypress/commit/58362037fd231c6fdc587e422fc139bf7546ac2d))
+
 # [@cypress/vue-v3.0.0-beta.3](https://github.com/cypress-io/cypress/compare/@cypress/vue-v3.0.0-beta.2...@cypress/vue-v3.0.0-beta.3) (2021-06-24)
 
 

diff --git a/packages/desktop-gui/cypress/integration/setup_project_spec.js b/packages/desktop-gui/cypress/integration/setup_project_spec.js
@@ -4,6 +4,7 @@ const onSubmitNewProject = function (orgId) {
     .contains('.btn', 'Set up project').click()
     .then(() => {
       expect(this.ipc.setupDashboardProject).to.be.calledWith({
+        projectRoot: '/foo/bar',
         projectName: this.config.projectName,
         orgId,
         public: false,
@@ -21,6 +22,7 @@ const onSubmitNewProject = function (orgId) {
     .then(() => {
       expect(this.ipc.setupDashboardProject).to.be.calledWith({
         projectName: 'New Project',
+        projectRoot: '/foo/bar',
         orgId,
         public: true,
       })
@@ -114,7 +116,7 @@ describe('Connect to Dashboard', function () {
       cy.stub(this.ipc, 'getRecordKeys').resolves(this.keys)
       cy.stub(this.ipc, 'pingApiServer').resolves()
       cy.stub(this.ipc, 'externalOpen')
-      cy.stub(this.ipc, 'setProjectId').resolvesArg(0)
+      cy.stub(this.ipc, 'setProjectId').callsFake((arg) => Promise.resolve(arg.id))
       cy.stub(this.ipc, 'beginAuth').resolves()
 
       this.getCurrentUser = this.util.deferred()
@@ -485,7 +487,7 @@ describe('Connect to Dashboard', function () {
             cy.get('.setup-project')
             .contains('.btn', 'Set up project').click()
             .then(() => {
-              expect(this.ipc.setProjectId).to.be.calledWith(this.dashboardProjects[1].id)
+              expect(this.ipc.setProjectId).to.be.calledWith({ id: this.dashboardProjects[1].id, projectRoot: '/foo/bar' })
             })
           })
 

diff --git a/packages/desktop-gui/src/dashboard-projects/dashboard-projects-api.js b/packages/desktop-gui/src/dashboard-projects/dashboard-projects-api.js
@@ -45,8 +45,8 @@ const setupDashboardProject = (projectDetails) => {
   .catch(ipc.isUnauthed, ipc.handleUnauthed)
 }
 
-const setProjectId = (id) => {
-  return ipc.setProjectId(id)
+const setProjectId = (id, projectRoot) => {
+  return ipc.setProjectId({ id, projectRoot })
 }
 
 export default {

diff --git a/packages/desktop-gui/src/runs/runs-list.jsx b/packages/desktop-gui/src/runs/runs-list.jsx
@@ -108,8 +108,8 @@ class RunsList extends Component {
 
   _getRecordKeys () {
     if (this._needsKey()) {
-      projectsApi.getRecordKeys().then((keys = []) => {
-        if (keys.length) {
+      projectsApi.getRecordKeys().then((keys) => {
+        if (keys && keys.length) {
           this.setState({ recordKey: keys[0].id })
         }
       })

diff --git a/packages/desktop-gui/src/runs/setup-project.jsx b/packages/desktop-gui/src/runs/setup-project.jsx
@@ -375,12 +375,13 @@ class SetupProject extends Component {
     if (this.state.newProject) {
       return dashboardProjectsApi.setupDashboardProject({
         projectName: this.state.projectName,
+        projectRoot: this.props.project.path,
         orgId: this.state.selectedOrgId,
         public: this.state.public,
       })
     }
 
-    return dashboardProjectsApi.setProjectId(this.state.selectedProjectId)
+    return dashboardProjectsApi.setProjectId(this.state.selectedProjectId, this.props.project.path)
     .then((id) => {
       const project = dashboardProjectsStore.getProjectById(id)
 

diff --git a/packages/server/lib/gui/events.js b/packages/server/lib/gui/events.js
@@ -332,12 +332,12 @@ const handleEvent = function (options, bus, event, id, type, arg) {
       .catch(sendErr)
 
     case 'setup:dashboard:project':
-      return ProjectStatic.createCiProject(arg, options.projectRoot)
+      return ProjectStatic.createCiProject(arg, arg.projectRoot)
       .then(send)
       .catch(sendErr)
 
     case 'set:project:id':
-      return ProjectStatic.writeProjectId(arg, options.projectRoot)
+      return ProjectStatic.writeProjectId(arg.id, arg.projectRoot)
       .then(send)
       .catch(sendErr)
 

diff --git a/packages/server/lib/project_static.ts b/packages/server/lib/project_static.ts
@@ -177,6 +177,7 @@ export async function writeProjectId (id: string, projectRoot: string) {
 
 interface ProjectDetails {
   projectName: string
+  projectRoot: string
   orgId: string | null
   public: boolean
 }

diff --git a/packages/server/test/unit/gui/events_spec.js b/packages/server/test/unit/gui/events_spec.js
@@ -923,9 +923,28 @@ describe('lib/gui/events', () => {
       })
     })
 
+    describe('set:project:id', () => {
+      it('calls writeProjectId with projectRoot', function () {
+        const arg = { id: '1', projectRoot: '/project/root/' }
+        const stub = sinon.stub(ProjectStatic, 'writeProjectId').resolves()
+
+        return this.handleEvent('set:project:id', arg)
+        .then(() => {
+          expect(stub).to.be.calledWith(arg.id, arg.projectRoot)
+          expect(this.send.firstCall.args[0]).to.eq('response')
+          expect(this.send.firstCall.args[1].id).to.match(/set:project:id-/)
+        })
+      })
+    })
+
     describe('setup:dashboard:project', () => {
       it('returns result of ProjectStatic.createCiProject', function () {
-        return this.handleEvent('setup:dashboard:project').then((assert) => {
+        const arg = { projectRoot: '/project/root/' }
+        const stub = sinon.stub(ProjectStatic, 'createCiProject').resolves()
+
+        return this.handleEvent('setup:dashboard:project', arg)
+        .then(() => {
+          expect(stub).to.be.calledWith(arg, arg.projectRoot)
           expect(this.send.firstCall.args[0]).to.eq('response')
           expect(this.send.firstCall.args[1].id).to.match(/setup:dashboard:project-/)
         })
@@ -936,7 +955,8 @@ describe('lib/gui/events', () => {
 
         sinon.stub(ProjectStatic, 'createCiProject').rejects(err)
 
-        return this.handleEvent('setup:dashboard:project').then((assert) => {
+        return this.handleEvent('setup:dashboard:project', { projectRoot: '/foo/bar' })
+        .then((assert) => {
           return assert.sendErrCalledWith(err)
         })
       })