Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | 1x 1x 1x 14x 14x 14x 3x 2x 1x 4x 1x 3x 3x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 6x 2x 2x 2x 1x 1x 2x 2x 2x 5x 3x 2x 2x 2x 7x 3x 4x 1x 1x 4x 4x 4x 1x 1x 1x 1x 5x 1x 4x 1x 3x 3x 3x 3x 1x 1x 1x 1x 1x | import logger from '@wdio/logger'
import CommandHandler from './commands'
import DevToolsDriver from './driver'
import Auditor from './auditor'
import TraceGatherer from './gatherer/trace'
import DevtoolsGatherer from './gatherer/devtools'
import { findCDPInterface, getCDPClient } from './utils'
import { NETWORK_STATES, DEFAULT_NETWORK_THROTTLING_STATE } from './constants'
const log = logger('@wdio/devtools-service')
const UNSUPPORTED_ERROR_MESSAGE = 'The @wdio/devtools-service currently only supports Chrome version 63 and up'
const TRACE_COMMANDS = ['click', 'navigateTo']
export default class DevToolsService {
constructor (options = {}) {
this.options = options
this.isSupported = false
this.shouldRunPerformanceAudits = false
}
beforeSession (_, caps) {
if (caps.browserName !== 'chrome' || (caps.version && caps.version < 63)) {
return log.error(UNSUPPORTED_ERROR_MESSAGE)
}
this.isSupported = true
}
async before () {
if (!this.isSupported) {
return global.browser.addCommand('cdp', /* istanbul ignore next */ () => {
throw new Error(UNSUPPORTED_ERROR_MESSAGE)
})
}
try {
let debuggerAddress
if (this.options.debuggerAddress) {
const [host, port] = this.options.debuggerAddress.split(':')
debuggerAddress = { host, port: parseInt(port, 10) }
} else {
debuggerAddress = await findCDPInterface()
}
this.client = await getCDPClient(debuggerAddress)
this.commandHandler = new CommandHandler(this.client, global.browser)
this.devtoolsDriver = await DevToolsDriver.attach(`http://${debuggerAddress.host}:${debuggerAddress.port}`)
this.traceGatherer = new TraceGatherer(this.devtoolsDriver)
const session = await this.devtoolsDriver.getCDPSession()
session.on('Page.loadEventFired', ::this.traceGatherer.onLoadEventFired)
session.on('Page.frameNavigated', ::this.traceGatherer.onFrameNavigated)
const page = await this.devtoolsDriver.getActivePage()
page.on('requestfailed', ::this.traceGatherer.onFrameLoadFail)
/**
* enable domains for client
*/
await Promise.all(['Page', 'Network', 'Console'].map(
(domain) => Promise.all([
session.send(`${domain}.enable`),
this.client[domain]['enable']()
])
))
this.devtoolsGatherer = new DevtoolsGatherer()
this.client.on('event', ::this.devtoolsGatherer.onMessage)
log.info(`Connected to Chrome on ${debuggerAddress.host}:${debuggerAddress.port}`)
} catch (err) {
log.error(`Couldn't connect to chrome: ${err.stack}`)
return
}
global.browser.addCommand('enablePerformanceAudits', ::this._enablePerformanceAudits)
global.browser.addCommand('disablePerformanceAudits', ::this._disablePerformanceAudits)
/**
* allow user to work with Puppeteer directly
*/
global.browser.addCommand('getPuppeteer',
() => this.devtoolsDriver)
}
async beforeCommand (commandName, params) {
if (!this.shouldRunPerformanceAudits || !this.traceGatherer || this.traceGatherer.isTracing || !TRACE_COMMANDS.includes(commandName)) {
return
}
/**
* set browser profile
*/
this._setThrottlingProfile(this.networkThrottling, this.cpuThrottling, this.cacheEnabled)
const url = commandName === 'navigateTo' ? params[0] : 'click transition'
return this.traceGatherer.startTracing(url)
}
async afterCommand (commandName) {
if (!this.traceGatherer || !this.traceGatherer.isTracing || !TRACE_COMMANDS.includes(commandName)) {
return
}
/**
* update custom commands once tracing finishes
*/
this.traceGatherer.once('tracingComplete', (traceEvents) => {
const auditor = new Auditor(traceEvents, this.devtoolsGatherer.getLogs())
auditor.updateCommands(global.browser)
})
return new Promise((resolve) => {
log.info(`Wait until tracing for command ${commandName} finishes`)
/**
* wait until tracing stops
*/
this.traceGatherer.once('tracingFinished', async () => {
log.info('Disable throttling')
await this._setThrottlingProfile('online', 0, true)
log.info('continuing with next WebDriver command')
resolve()
})
})
}
/**
* set flag to run performance audits for page transitions
*/
_enablePerformanceAudits ({ networkThrottling = DEFAULT_NETWORK_THROTTLING_STATE, cpuThrottling = 4, cacheEnabled = false } = {}) {
if (!Object.prototype.hasOwnProperty.call(NETWORK_STATES, networkThrottling)) {
throw new Error(`Network throttling profile "${networkThrottling}" is unknown, choose between ${Object.keys(NETWORK_STATES).join(', ')}`)
}
if (typeof cpuThrottling !== 'number') {
throw new Error(`CPU throttling rate needs to be typeof number but was "${typeof cpuThrottling}"`)
}
this.networkThrottling = networkThrottling
this.cpuThrottling = cpuThrottling
this.cacheEnabled = Boolean(cacheEnabled)
this.shouldRunPerformanceAudits = true
}
/**
* custom command to disable performance audits
*/
_disablePerformanceAudits () {
this.shouldRunPerformanceAudits = false
}
/**
* helper method to set throttling profile
*/
async _setThrottlingProfile (networkThrottling, cpuThrottling, cacheEnabled) {
const page = await this.devtoolsDriver.getActivePage()
await page.setCacheEnabled(Boolean(cacheEnabled))
await this.devtoolsDriver.send('Emulation.setCPUThrottlingRate', { rate: cpuThrottling })
await this.devtoolsDriver.send('Network.emulateNetworkConditions', NETWORK_STATES[networkThrottling])
}
}
|