FIX : Resolve reverse tunnel and WiFi proxy leaks on session end or crash#96
Draft
vdanti wants to merge 1 commit into
Draft
FIX : Resolve reverse tunnel and WiFi proxy leaks on session end or crash#96vdanti wants to merge 1 commit into
vdanti wants to merge 1 commit into
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context
When an Android test session ended, crashed, or the Appium server was abruptly terminated, the device was frequently left with its global WiFi proxy config pointed to a dead port and the active ADB reverse tunnel still open. This led to lost internet connectivity on the device and subsequent test run failures due to port collisions.
Implementation
ProxyOptionsto store the activeadbinstance and theisRealDeviceflag inproxyCache. This ensures that even if Appium destroys the session mappings before our cleanup hooks run, the plugin has a valid fallback ADB instance to revert settings.clearProxyto check the cachedisRealDeviceflag, and if true, explicitly executeremoveReverseTunnelon the current proxy port.processexit listeners forSIGINT(Ctrl+C) andSIGTERMin the plugin constructor to asynchronously sweep and restore settings for all active proxies in our cache on server stops.onUnexpectedShutdownalso sweeps any lingering sessions in our internalproxyCacheas a safety fallback.Requirements
Manual tests
deleteSession) successfully restores WiFi proxy settings to default and closes the ADB reverse tunnel (adb reverse --listis empty).onUnexpectedShutdown) successfully falls back to cached ADB and restores proxy/closes tunnel.SIGINT(Ctrl+C) orSIGTERMto the server process successfully triggers the exit handlers to restore WiFi proxy and tear down the ADB reverse tunnel.