mirror/cypress
1
0
Fork 0
mirror of https://github.com/cypress-io/cypress.git synced 2026-05-12 18:29:53 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore(unify): always allow devtools in launchpad (#20298)

Browse Source 
* no longer check if dev to show devtools

* match tests to new behavior

* remove 'withDevTools` option

* Revert "remove 'withDevTools` option"

This reverts commit ff4a8b96e4.

* rename withDevTools to withInteralDevTools

* coniditionally show internal dev tools in menu

* test nesting
This commit is contained in:
Mark Noonan
2022-02-23 11:23:11 -05:00
committed by GitHub
parent 6b95fd6f1c
commit 49d699336b
7 changed files with 100 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/server/lib/browsers/electron.js
+2 -2
View File
@@ -146,7 +146,7 @@ module.exports = {
},
onFocus () {
if (options.show) {
return menu.set({ withDevTools: true })
return menu.set({ withInternalDevTools: true })
}
},
onNewWindow (e, url) {
@@ -222,7 +222,7 @@ module.exports = {
_launch (win, url, automation, options) {
if (options.show) {
menu.set({ withDevTools: true })
menu.set({ withInternalDevTools: true })
}
ELECTRON_DEBUG_EVENTS.forEach((e) => {
packages/server/lib/gui/menu.js
+60 -55
View File
@@ -167,64 +167,69 @@ module.exports = {
})
}
if (options.withDevTools) {
template.push(
{
label: 'Developer Tools',
submenu: [
{
label: 'Reload',
accelerator: 'CmdOrCtrl+R',
click: (item, focusedWindow) => {
if (focusedWindow) {
return focusedWindow.reload()
}
},
},
{
label: 'Toggle Developer Tools',
accelerator: (() => {
if (os.platform() === 'darwin') {
return 'Alt+Command+I'
}
return 'Ctrl+Shift+I'
})(),
click: (item, focusedWindow) => {
if (focusedWindow) {
return focusedWindow.toggleDevTools()
}
},
},
{
label: `GraphQL requests over Fetch (${process.env.CYPRESS_INTERNAL_GQL_NO_SOCKET ? 'on' : 'off'})`,
click: (item, focusedWindow) => {
if (process.env.CYPRESS_INTERNAL_GQL_NO_SOCKET) {
delete process.env.CYPRESS_INTERNAL_GQL_NO_SOCKET
} else {
process.env.CYPRESS_INTERNAL_GQL_NO_SOCKET = '1'
}
this.set(opts)
},
},
{
label: 'GraphiQL',
click () {
return shell.openExternal(`http://localhost:${options.getGraphQLPort()}/__launchpad/graphql`)
},
},
{
label: 'View App Data',
click () {
return open.opn(appData.path())
},
},
],
let devToolsSubmenu = [
{
label: 'Reload',
accelerator: 'CmdOrCtrl+R',
click: (item, focusedWindow) => {
if (focusedWindow) {
return focusedWindow.reload()
}
},
)
},
{
label: 'Toggle Developer Tools',
accelerator: (() => {
if (os.platform() === 'darwin') {
return 'Alt+Command+I'
}
return 'Ctrl+Shift+I'
})(),
click: (item, focusedWindow) => {
if (focusedWindow) {
return focusedWindow.toggleDevTools()
}
},
},
{
label: 'View App Data',
click () {
return open.opn(appData.path())
},
},
]
if (options.withInternalDevTools) {
devToolsSubmenu = devToolsSubmenu.concat([
{
label: `GraphQL requests over Fetch (${process.env.CYPRESS_INTERNAL_GQL_NO_SOCKET ? 'on' : 'off'})`,
click: (item, focusedWindow) => {
if (process.env.CYPRESS_INTERNAL_GQL_NO_SOCKET) {
delete process.env.CYPRESS_INTERNAL_GQL_NO_SOCKET
} else {
process.env.CYPRESS_INTERNAL_GQL_NO_SOCKET = '1'
}
this.set(opts)
},
},
{
label: 'GraphiQL',
click () {
return shell.openExternal(`http://localhost:${options.getGraphQLPort()}/__launchpad/graphql`)
},
},
])
}
template.push(
{
label: 'Developer Tools',
submenu: devToolsSubmenu,
},
)
const menu = Menu.buildFromTemplate(template)
return Menu.setApplicationMenu(menu)
packages/server/lib/modes/interactive-e2e.ts
+3 -3
View File
@@ -92,9 +92,9 @@ export = {
return Windows.hideAllUnlessAnotherWindowIsFocused()
},
onFocus () {
// hide dev tools if in production and previously focused
// hide internal dev tools if in production and previously focused
// window was the electron browser
menu.set({ withDevTools: isDev() })
menu.set({ withInternalDevTools: isDev() })
return Windows.showAll()
},
@@ -136,7 +136,7 @@ export = {
// TODO: potentially just pass an event emitter
// instance here instead of callback functions
menu.set({
withDevTools: isDev(),
withInternalDevTools: isDev(),
onLogOutClicked () {
return globalPubSub.emit('menu:item:clicked', 'log:out')
},
packages/server/test/unit/browsers/electron_spec.js
+4 -4
View File
@@ -190,7 +190,7 @@ describe('lib/browsers/electron', () => {
it('sets menu.set whether or not its in headless mode', function () {
return electron._launch(this.win, this.url, this.automation, { show: true })
.then(() => {
expect(menu.set).to.be.calledWith({ withDevTools: true })
expect(menu.set).to.be.calledWith({ withInternalDevTools: true })
}).then(() => {
menu.set.reset()
@@ -439,7 +439,7 @@ describe('lib/browsers/electron', () => {
let opts = electron._defaultOptions('/foo', this.state, { show: true, browser: {} })
opts.onFocus()
expect(menu.set).to.be.calledWith({ withDevTools: true })
expect(menu.set).to.be.calledWith({ withInternalDevTools: true })
menu.set.reset()
@@ -581,7 +581,7 @@ describe('lib/browsers/electron', () => {
// once for main window, once for child
expect(menu.set).to.be.calledTwice
expect(menu.set).to.be.calledWith({ withDevTools: true })
expect(menu.set).to.be.calledWith({ withInternalDevTools: true })
})
})
@@ -591,7 +591,7 @@ describe('lib/browsers/electron', () => {
// once for main window, once for child, once for focus
expect(menu.set).to.be.calledThrice
expect(menu.set).to.be.calledWith({ withDevTools: true })
expect(menu.set).to.be.calledWith({ withInternalDevTools: true })
})
})
packages/server/test/unit/gui/menu_spec.js
+20 -9
View File
@@ -252,19 +252,30 @@ describe('gui/menu', function () {
})
context('Developer Tools', () => {
it('does not exist by default', () => {
it('exists by default', () => {
menu.set()
expect(getMenuItem('Developer Tools')).to.be.undefined
expect(getMenuItem('Developer Tools')).to.be.defined
})
it('does not exist by when withDevTools is false', () => {
menu.set({ withDevTools: false })
expect(getMenuItem('Developer Tools')).to.be.undefined
it('exists when withInternalDevTools is false', () => {
menu.set({ withInternalDevTools: false })
expect(getMenuItem('Developer Tools')).to.be.defined
})
describe('when withDevTools is true', () => {
it('contains only Reload and Toggle Developer Tools items in expected order', () => {
menu.set()
const labels = getLabels(getMenuItem('Developer Tools').submenu)
expect(labels).to.eql([
'Reload',
'Toggle Developer Tools',
'View App Data',
])
})
describe('when withInternalDevTools is true', () => {
beforeEach(function () {
menu.set({ withDevTools: true })
menu.set({ withInternalDevTools: true })
this.devSubmenu = getMenuItem('Developer Tools').submenu
})
@@ -274,9 +285,9 @@ describe('gui/menu', function () {
expect(labels).to.eql([
'Reload',
'Toggle Developer Tools',
'View App Data',
'GraphQL requests over Fetch (off)',
'GraphiQL',
'View App Data',
])
})
@@ -301,7 +312,7 @@ describe('gui/menu', function () {
it('sets shortcut for Toggle Developer Tools when not macOS', () => {
os.platform.returns('linux')
menu.set({ withDevTools: true })
menu.set({ withInternalDevTools: true })
expect(getMenuItem('Developer Tools').submenu[1].accelerator).to.equal('Ctrl+Shift+I')
})
packages/server/test/unit/gui/windows_spec.ts
+3 -3
View File
@@ -90,7 +90,7 @@ describe('lib/gui/windows', () => {
height: 'someHeight',
x: 'anX',
y: 'aY',
devTools: 'whatsUpWithDevTools',
devTools: 'whatsUpwithInternalDevTools',
}
})
})
@@ -167,7 +167,7 @@ describe('lib/gui/windows', () => {
return Promise
.delay(100)
.then(() => {
expect(this.state.set).to.be.calledWith({ whatsUpWithDevTools: true })
expect(this.state.set).to.be.calledWith({ whatsUpwithInternalDevTools: true })
})
})
@@ -178,7 +178,7 @@ describe('lib/gui/windows', () => {
return Promise
.delay(100)
.then(() => {
expect(this.state.set).to.be.calledWith({ whatsUpWithDevTools: false })
expect(this.state.set).to.be.calledWith({ whatsUpwithInternalDevTools: false })
})
})
})
packages/server/test/unit/modes/interactive_spec.js
+8 -8
View File
@@ -101,21 +101,21 @@ describe('gui/interactive', () => {
sinon.stub(menu, 'set')
})
it('calls menu.set withDevTools: true when in dev env', () => {
it('calls menu.set withInternalDevTools: true when in dev env', () => {
const env = process.env['CYPRESS_INTERNAL_ENV']
process.env['CYPRESS_INTERNAL_ENV'] = 'development'
interactiveMode.getWindowArgs({}).onFocus()
expect(menu.set.lastCall.args[0].withDevTools).to.be.true
expect(menu.set.lastCall.args[0].withInternalDevTools).to.be.true
process.env['CYPRESS_INTERNAL_ENV'] = env
})
it('calls menu.set withDevTools: false when not in dev env', () => {
it('calls menu.set withInternalDevTools: false when not in dev env', () => {
const env = process.env['CYPRESS_INTERNAL_ENV']
process.env['CYPRESS_INTERNAL_ENV'] = 'production'
interactiveMode.getWindowArgs({}).onFocus()
expect(menu.set.lastCall.args[0].withDevTools).to.be.false
expect(menu.set.lastCall.args[0].withInternalDevTools).to.be.false
process.env['CYPRESS_INTERNAL_ENV'] = env
})
})
@@ -155,24 +155,24 @@ describe('gui/interactive', () => {
})
})
it('calls menu.set withDevTools: true when in dev env', () => {
it('calls menu.set withInternalDevTools: true when in dev env', () => {
const env = process.env['CYPRESS_INTERNAL_ENV']
process.env['CYPRESS_INTERNAL_ENV'] = 'development'
return interactiveMode.ready({}).then(() => {
expect(menu.set.lastCall.args[0].withDevTools).to.be.true
expect(menu.set.lastCall.args[0].withInternalDevTools).to.be.true
process.env['CYPRESS_INTERNAL_ENV'] = env
})
})
it('calls menu.set withDevTools: false when not in dev env', () => {
it('calls menu.set withInternalDevTools: false when not in dev env', () => {
const env = process.env['CYPRESS_INTERNAL_ENV']
process.env['CYPRESS_INTERNAL_ENV'] = 'production'
return interactiveMode.ready({}).then(() => {
expect(menu.set.lastCall.args[0].withDevTools).to.be.false
expect(menu.set.lastCall.args[0].withInternalDevTools).to.be.false
process.env['CYPRESS_INTERNAL_ENV'] = env
})
})