fix: set projectId in a custom config file (#18240)

Author: Barthélémy Ledoux

packages/desktop-gui/cypress/fixtures/config.json

@@ -147,6 +147,7 @@
   "requestTimeout": 5000,
   "resolvedNodePath": null,
   "resolvedNodeVersion": "1.2.3",
+  "configFile": "cypress.json",
   "hosts": {
     "*.foobar.com": "127.0.0.1"
   },

packages/desktop-gui/cypress/integration/settings_spec.js

@@ -326,9 +326,9 @@ describe('Settings', () => {
 
     context('when configFile is false', () => {
       beforeEach(function () {
-        this.openProject.resolve(Cypress._.assign({
+        this.openProject.resolve(Cypress._.assign(this.config, {
           configFile: false,
-        }, this.config))
+        }))
 
         this.goToSettings()
 
@@ -342,9 +342,9 @@ describe('Settings', () => {
 
     context('when configFile is set', function () {
       beforeEach(function () {
-        this.openProject.resolve(Cypress._.assign({
+        this.openProject.resolve(Cypress._.assign(this.config, {
           configFile: 'special-cypress.json',
-        }, this.config))
+        }))
 
         this.goToSettings()
 

packages/desktop-gui/cypress/integration/setup_project_spec.js

@@ -8,6 +8,7 @@ const onSubmitNewProject = function (orgId) {
         projectName: this.config.projectName,
         orgId,
         public: false,
+        configFile: 'cypress.json',
       })
     })
   })
@@ -25,6 +26,7 @@ const onSubmitNewProject = function (orgId) {
         projectRoot: '/foo/bar',
         orgId,
         public: true,
+        configFile: 'cypress.json',
       })
     })
   })
@@ -487,7 +489,10 @@ describe('Connect to Dashboard', function () {
             cy.get('.setup-project')
             .contains('.btn', 'Set up project').click()
             .then(() => {
-              expect(this.ipc.setProjectId).to.be.calledWith({ id: this.dashboardProjects[1].id, projectRoot: '/foo/bar' })
+              expect(this.ipc.setProjectId).to.be.calledWith({
+                id: this.dashboardProjects[1].id,
+                projectRoot: '/foo/bar',
+                configFile: 'cypress.json' })
             })
           })
 

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, projectRoot) => {
-  return ipc.setProjectId({ id, projectRoot })
+const setProjectId = (id, projectRoot, configFile) => {
+  return ipc.setProjectId({ id, projectRoot, configFile })
 }
 
 export default {

packages/desktop-gui/src/runs/setup-project.jsx

@@ -378,10 +378,13 @@ class SetupProject extends Component {
         projectRoot: this.props.project.path,
         orgId: this.state.selectedOrgId,
         public: this.state.public,
+        configFile: this.props.project.configFile,
       })
     }
 
-    return dashboardProjectsApi.setProjectId(this.state.selectedProjectId, this.props.project.path)
+    return dashboardProjectsApi.setProjectId(this.state.selectedProjectId,
+      this.props.project.path,
+      this.props.project.configFile)
     .then((id) => {
       const project = dashboardProjectsStore.getProjectById(id)
 

packages/server/lib/gui/events.js

@@ -337,7 +337,7 @@ const handleEvent = function (options, bus, event, id, type, arg) {
       .catch(sendErr)
 
     case 'set:project:id':
-      return ProjectStatic.writeProjectId(arg.id, arg.projectRoot)
+      return ProjectStatic.writeProjectId(arg)
       .then(send)
       .catch(sendErr)
 

packages/server/lib/project_static.ts

@@ -162,15 +162,21 @@ export function ensureExists (path, options) {
   return settings.exists(path, options)
 }
 
-export async function writeProjectId (id: string, projectRoot: string) {
+interface ProjectIdOptions{
+  id: string
+  projectRoot: string
+  configFile: string
+}
+
+export async function writeProjectId ({ id, projectRoot, configFile }: ProjectIdOptions) {
   const attrs = { projectId: id }
 
   logger.info('Writing Project ID', _.clone(attrs))
 
   // TODO: We need to set this
   // this.generatedProjectIdTimestamp = new Date()
 
-  await settings.write(projectRoot, attrs)
+  await settings.write(projectRoot, attrs, { configFile })
 
   return id
 }
@@ -180,10 +186,11 @@ interface ProjectDetails {
   projectRoot: string
   orgId: string | null
   public: boolean
+  configFile: string
 }
 
-export async function createCiProject (projectDetails: ProjectDetails, projectRoot: string) {
-  debug('create CI project with projectDetails %o projectRoot %s', projectDetails, projectRoot)
+export async function createCiProject ({ projectRoot, configFile, ...projectDetails }: ProjectDetails) {
+  debug('create CI project with projectDetails %o projectRoot %s', projectDetails)
 
   const authToken = await user.ensureAuthToken()
   const remoteOrigin = await commitInfo.getRemoteOrigin(projectRoot)
@@ -195,7 +202,11 @@ export async function createCiProject (projectDetails: ProjectDetails, projectRo
 
   const newProject = await api.createProject(projectDetails, remoteOrigin, authToken)
 
-  await writeProjectId(newProject.id, projectRoot)
+  await writeProjectId({
+    configFile,
+    projectRoot,
+    id: newProject.id,
+  })
 
   return newProject
 }

packages/server/test/unit/gui/events_spec.js

@@ -926,12 +926,12 @@ 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()
+        const arg = { id: '1', projectRoot: '/project/root/', configFile: 'cypress.json' }
+        const stubWriteProjectId = sinon.stub(ProjectStatic, 'writeProjectId').resolves()
 
         return this.handleEvent('set:project:id', arg)
         .then(() => {
-          expect(stub).to.be.calledWith(arg.id, arg.projectRoot)
+          expect(stubWriteProjectId).to.be.calledWith(arg)
           expect(this.send.firstCall.args[0]).to.eq('response')
           expect(this.send.firstCall.args[1].id).to.match(/set:project:id-/)
         })
@@ -940,12 +940,12 @@ describe('lib/gui/events', () => {
 
     describe('setup:dashboard:project', () => {
       it('returns result of ProjectStatic.createCiProject', function () {
-        const arg = { projectRoot: '/project/root/' }
-        const stub = sinon.stub(ProjectStatic, 'createCiProject').resolves()
+        const arg = { projectRoot: '/project/root/', configFile: 'cypress.json' }
+        const stubCreateCiProject = sinon.stub(ProjectStatic, 'createCiProject').resolves()
 
         return this.handleEvent('setup:dashboard:project', arg)
         .then(() => {
-          expect(stub).to.be.calledWith(arg, arg.projectRoot)
+          expect(stubCreateCiProject).to.be.calledWith(arg)
           expect(this.send.firstCall.args[0]).to.eq('response')
           expect(this.send.firstCall.args[1].id).to.match(/setup:dashboard:project-/)
         })

packages/server/test/unit/project_spec.js

@@ -948,14 +948,14 @@ This option will not have an effect in Some-other-name. Tests that rely on web s
     })
 
     it('calls Settings.write with projectRoot and attrs', function () {
-      return writeProjectId('id-123').then((id) => {
+      return writeProjectId({ id: 'id-123' }).then((id) => {
         expect(id).to.eq('id-123')
       })
     })
 
     // TODO: This
     xit('sets generatedProjectIdTimestamp', function () {
-      return writeProjectId('id-123').then(() => {
+      return writeProjectId({ id: 'id-123' }).then(() => {
         expect(this.project.generatedProjectIdTimestamp).to.be.a('date')
       })
     })
@@ -1016,33 +1016,34 @@ This option will not have an effect in Some-other-name. Tests that rely on web s
 
   context('#createCiProject', () => {
     const projectRoot = '/_test-output/path/to/project-e2e'
+    const configFile = 'cypress.config.js'
 
     beforeEach(function () {
       this.project = new ProjectBase({ projectRoot, testingType: 'e2e' })
       this.newProject = { id: 'project-id-123' }
 
       sinon.stub(user, 'ensureAuthToken').resolves('auth-token-123')
-      sinon.stub(settings, 'write').resolves('project-id-123')
+      sinon.stub(settings, 'write').resolves()
       sinon.stub(commitInfo, 'getRemoteOrigin').resolves('remoteOrigin')
       sinon.stub(api, 'createProject')
       .withArgs({ foo: 'bar' }, 'remoteOrigin', 'auth-token-123')
       .resolves(this.newProject)
     })
 
     it('calls api.createProject with user session', function () {
-      return createCiProject({ foo: 'bar' }, projectRoot).then(() => {
+      return createCiProject({ foo: 'bar', projectRoot }).then(() => {
         expect(api.createProject).to.be.calledWith({ foo: 'bar' }, 'remoteOrigin', 'auth-token-123')
       })
     })
 
     it('calls writeProjectId with id', function () {
-      return createCiProject({ foo: 'bar' }, projectRoot).then(() => {
-        expect(settings.write).to.be.calledWith(projectRoot, { projectId: 'project-id-123' })
+      return createCiProject({ foo: 'bar', projectRoot, configFile }).then(() => {
+        expect(settings.write).to.be.calledWith(projectRoot, { projectId: 'project-id-123' }, { configFile })
       })
     })
 
     it('returns project id', function () {
-      return createCiProject({ foo: 'bar' }, projectRoot).then((projectId) => {
+      return createCiProject({ foo: 'bar', projectRoot }).then((projectId) => {
         expect(projectId).to.eql(this.newProject)
       })
     })