-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Android: Split (google) emulators across different adb servers #4900
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
d4vidi
wants to merge
9
commits into
master
Choose a base branch
from
feat/multi-adb-server
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+607
−154
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
389c479
feat(Android): Split emulators across different adb servers
d4vidi 08acca0
fix: Allocation for worker respawn
d4vidi 626a501
fix: Allocation for emulator reuse
d4vidi 3090565
clean up, fix unit tests, coverage
d4vidi 932a5f1
Add protecting opt-in toggle
d4vidi d9af687
Fix: opt-in toggle bug
d4vidi 9d6aa72
Merge remote-tracking branch 'origin/master' into feat/multi-adb-server
d4vidi f24489d
Fix: emulator log (long overdue tech debt)
d4vidi dfbafda
Merge remote-tracking branch 'origin/master' into feat/multi-adb-server
d4vidi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 18 additions & 6 deletions
24
detox/src/devices/allocation/drivers/android/FreeDeviceFinder.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,14 @@ | ||
| /** | ||
| * @typedef {import('../../../../common/drivers/android/cookies').AndroidDeviceCookie} AndroidDeviceCookie | ||
| * @typedef {import('../../../../common/drivers/android/cookies').EmulatorDeviceCookie} EmulatorDeviceCookie | ||
| * @typedef {import('../../../../common/drivers/android/tools/DeviceHandle')} DeviceHandle | ||
| */ | ||
|
|
||
| const _ = require('lodash'); | ||
|
|
||
| const log = require('../../../../../utils/logger').child({ cat: 'device,device-allocation' }); | ||
| const { isPortTaken } = require('../../../../../utils/netUtils'); | ||
| const adbPortRegistry = require('../../../../common/drivers/android/AdbPortRegistry'); | ||
| const AndroidAllocDriver = require('../AndroidAllocDriver'); | ||
|
|
||
| const { patchAvdSkinConfig } = require('./patchAvdSkinConfig'); | ||
|
|
@@ -48,29 +52,47 @@ class EmulatorAllocDriver extends AndroidAllocDriver { | |
|
|
||
| /** | ||
| * @param deviceConfig | ||
| * @returns {Promise<AndroidDeviceCookie>} | ||
| * @returns {Promise<EmulatorDeviceCookie>} | ||
| */ | ||
| async allocate(deviceConfig) { | ||
| const avdName = deviceConfig.device.avdName; | ||
| const useSeparateAdbServers = deviceConfig.useSeparateAdbServers === true; | ||
|
|
||
| await this._avdValidator.validate(avdName, deviceConfig.headless); | ||
| await this._fixAvdConfigIniSkinNameIfNeeded(avdName, deviceConfig.headless); | ||
|
|
||
| const adbName = await this._deviceRegistry.registerDevice(async () => { | ||
| let adbName = await this._freeDeviceFinder.findFreeDevice(avdName); | ||
| if (!adbName) { | ||
| let adbServerPort; | ||
| let adbName; | ||
|
|
||
| await this._deviceRegistry.registerDevice(async () => { | ||
| const candidates = await this._getAllDevices(useSeparateAdbServers); | ||
| const device = await this._freeDeviceFinder.findFreeDevice(candidates, avdName); | ||
|
|
||
| if (device) { | ||
| adbName = device.adbName; | ||
| adbServerPort = device.adbServerPort; | ||
| adbPortRegistry.register(adbName, adbServerPort); | ||
| } else { | ||
| const port = await this._freePortFinder.findFreePort(); | ||
| adbName = `emulator-${port}`; | ||
|
|
||
| await this._emulatorLauncher.launch({ | ||
| bootArgs: deviceConfig.bootArgs, | ||
| gpuMode: deviceConfig.gpuMode, | ||
| headless: deviceConfig.headless, | ||
| readonly: deviceConfig.readonly, | ||
| avdName, | ||
| adbName, | ||
| port, | ||
| }); | ||
| adbName = `emulator-${port}`; | ||
| adbServerPort = this._getFreeAdbServerPort(candidates, useSeparateAdbServers); | ||
| adbPortRegistry.register(adbName, adbServerPort); | ||
|
|
||
| try { | ||
| await this._emulatorLauncher.launch({ | ||
| bootArgs: deviceConfig.bootArgs, | ||
| gpuMode: deviceConfig.gpuMode, | ||
| headless: deviceConfig.headless, | ||
| readonly: deviceConfig.readonly, | ||
| avdName, | ||
| adbName, | ||
| port, | ||
| adbServerPort, | ||
| }); | ||
| } catch (e) { | ||
| adbPortRegistry.unregister(adbName); | ||
| } | ||
| } | ||
|
|
||
| return adbName; | ||
|
|
@@ -80,6 +102,7 @@ class EmulatorAllocDriver extends AndroidAllocDriver { | |
| id: adbName, | ||
| adbName, | ||
| name: `${adbName} (${avdName})`, | ||
| adbServerPort, | ||
| }; | ||
| } | ||
|
|
||
|
|
@@ -111,14 +134,16 @@ class EmulatorAllocDriver extends AndroidAllocDriver { | |
| if (options.shutdown) { | ||
| await this._doShutdown(adbName); | ||
| await this._deviceRegistry.unregisterDevice(adbName); | ||
|
|
||
| adbPortRegistry.unregister(adbName); | ||
| } else { | ||
| await this._deviceRegistry.releaseDevice(adbName); | ||
| } | ||
| } | ||
|
|
||
| async cleanup() { | ||
| if (this._shouldShutdown) { | ||
| const { devices } = await this._adb.devices(); | ||
| const devices = await this._getAllDevices(true); | ||
| const actualEmulators = devices.map((device) => device.adbName); | ||
| const sessionDevices = await this._deviceRegistry.readSessionDevices(); | ||
| const emulatorsToShutdown = _.intersection(sessionDevices.getIds(), actualEmulators); | ||
|
|
@@ -146,6 +171,41 @@ class EmulatorAllocDriver extends AndroidAllocDriver { | |
| const binaryVersion = _.get(rawBinaryVersion, 'major'); | ||
| return await patchAvdSkinConfig(avdName, binaryVersion); | ||
| } | ||
|
|
||
| /** | ||
| * @param {boolean} useSeparateAdbServers | ||
| * @returns {Promise<DeviceHandle[]>} | ||
| * @private | ||
| */ | ||
| async _getAllDevices(useSeparateAdbServers) { | ||
| const adbServers = await this._getRunningAdbServers(useSeparateAdbServers); | ||
| return (await this._adb.devices({}, adbServers)).devices; | ||
| } | ||
|
|
||
| /** | ||
| * @param {boolean} useSeparateAdbServers | ||
| * @returns {Promise<number[]>} | ||
| * @private | ||
| */ | ||
| async _getRunningAdbServers(useSeparateAdbServers = true) { | ||
| const ports = [this._adb.defaultServerPort]; | ||
|
|
||
| if (useSeparateAdbServers) { | ||
| for (let port = this._adb.defaultServerPort + 1; await isPortTaken(port); port++) { | ||
| ports.push(port); | ||
| } | ||
| } | ||
| return ports; | ||
| } | ||
|
|
||
| _getFreeAdbServerPort(currentDevices, useSeparateAdbServers) { | ||
| if (!useSeparateAdbServers) { | ||
| return this._adb.defaultServerPort; | ||
| } | ||
|
|
||
| const maxPortDevice = _.maxBy(currentDevices, 'adbServerPort'); | ||
| return _.get(maxPortDevice, 'adbServerPort', this._adb.defaultServerPort) + 1; | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you check that it is actually free? |
||
| } | ||
| } | ||
|
|
||
| module.exports = EmulatorAllocDriver; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
detox/src/devices/allocation/drivers/android/emulator/FreeEmulatorFinder.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the guarantee that the port is taken by an ADB server actually?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't we just enumerate ports from
adbPortRegistry?