Repository navigation
fix: update executor and driver server URL state on directConnect - #2500
hoanle0126 wants to merge 4 commits into
Conversation
mykola-mokhnach
left a comment
There was a problem hiding this comment.
- [minor]
ListensToSyslogMessages.java:69andListensToLogcatMessages.java:68aren't in the diff, but this change affects them. They choosewsorwssfromgetAddressOfRemoteServer(), which now switches tohttpsafter directConnect. Thehostandportarguments still come from the caller, usually the original hub.startSyslogBroadcast(hubHost, 4723)now openswss://hubHost:4723/...against a plain-WS port, where before this PR it usedws. Should these helpers also take the host and port from the updated URL, or should the scheme stay tied to the caller's endpoint?
|
Updated ListensToLogcatMessages and ListensToSyslogMessages so the no-arg startBroadcast() methods resolve host and port from getAddressOfRemoteServer() (falling back to 127.0.0.1:4723 / localhost:4723), while startBroadcast(host, port) only uses wss when (host, port) matches an https serverUrl (keeping explicit hub host/port calls on plain ws). Added unit tests covering both Android and iOS broadcast URIs. |
mykola-mokhnach
left a comment
There was a problem hiding this comment.
- [minor] The no-arg
startLogcatBroadcast()andstartSyslogBroadcast()now use the server's host and port instead of127.0.0.1:4723/localhost:4723. The one-arg overloads (startLogcatBroadcast(String host)and the syslog equivalent) still hard-code 4723. Againsthttp://hub:4444,startLogcatBroadcast()connects tohub:4444, butstartLogcatBroadcast("hub")connects tohub:4723. Should the one-arg overloads also default to the server port? The PR is marked non-breaking bugfix, but this is a behavior change for callers of the no-arg methods. If it's intended, please mention it in the description. - [minor]
SessionHelpersis about session-address parsing. It now also holds log-broadcast URI logic:resolveBroadcastHost,resolveBroadcastPort,buildBroadcastUriandmatchesEndpoint. The no-arg start logic is also copy-pasted betweenListensToLogcatMessages.java:47andListensToSyslogMessages, down to the cast chain. Consider a small dedicated helper inio.appium.java_client.internal(for example aLogBroadcastEndpointsclass) that resolves host and port from the executor and builds the URI. A fix like the wildcard-host one would then land in one place.
|
Addressed all review feedback in commit 8ee115c:
|
mykola-mokhnach
left a comment
There was a problem hiding this comment.
- [critical] Undeclared breaking change (also anchored inline, comment 1). The PR is marked "Bugfix (non-breaking)" with no
!in the title and noBREAKING CHANGE:entry. The default host and port of the log-broadcast overloads change (details in the inline comment).
| * is assigned to the default port (4723). | ||
| * This method uses the current remote server host (mapping wildcard addresses to {@code 127.0.0.1}) | ||
| * and port when available, falling back to {@code 127.0.0.1:4723}. | ||
| */ |
There was a problem hiding this comment.
[critical] This is an undeclared breaking change. The Javadoc for the no-arg and host-only startLogcatBroadcast / startSyslogBroadcast overloads documented a fixed default of 127.0.0.1 or localhost with port 4723. They now take host and port from the live server URL.
- A user whose driver talks to
https://hub.example.com/(no explicit port) and who callsstartLogcatBroadcast("127.0.0.1")now gets port 443 instead of 4723. - The no-arg form now connects to the hub host instead of loopback.
The overloads that behaved one way before now behave differently, and callers can't tell from the signature. Please mark the PR title with ! (e.g. fix!:). Add a BREAKING CHANGE: entry naming these four overloads and the migration path: pass host and port explicitly to keep the old endpoint. Or keep the old defaults and add the new behavior as opt-in.
| return (AppiumCommandExecutor) remoteWebDriver.getCommandExecutor(); | ||
| } | ||
|
|
||
| private static String chooseScheme( |
There was a problem hiding this comment.
[minor] chooseScheme and matchesEndpoint guess ws or wss by comparing host:port against a history of replaced http URLs. The guess includes loopback-equivalence and wildcard normalization. It is hard to reason about and needs the executor to track replaced URLs (see the next comment). Could the scheme come from the active server URL alone (https gives wss), or from an explicit parameter? If a heuristic is really needed, I'd split it into three steps: "is this endpoint the active server?", "was it a replaced plain-http one?", and "pick the scheme".
| * | ||
| * @return unmodifiable list of replaced {@code http} server URLs | ||
| */ | ||
| public List<URL> getReplacedHttpServerUrls() { |
There was a problem hiding this comment.
[minor] getReplacedHttpServerUrls() is a new public method on a public class. It exists only so LogBroadcastEndpoints can pick a WebSocket scheme. That leaks a log-broadcast concern into the low-level executor and adds API that is hard to retract. Could it be package-private, or could the scheme decision move out of the executor (see the previous comment)?
| * @param host the host name or IP literal | ||
| * @return the URL-safe host representation | ||
| */ | ||
| public static String formatHost(String host) { |
There was a problem hiding this comment.
[nit] DirectConnect.formatHost is public static, but only the internal LogBroadcastEndpoints uses it besides this class. That adds a new internal → remote dependency, and remote already depends on internal. Consider moving it to internal.Strings (or another internal helper) and calling it from both places, so it isn't public API.
|
Thanks @mykola-mokhnach! Updated PR #2500 to address all four review points:
Updated the unit tests in |
Change list
AppiumCommandExecutor, synchronizeoverrideServerUrl, and readgetAddressOfRemoteServer()directly from that configuration (populating the base URL from AppiumDriverLocalService when omitted).AppiumDriver.getRemoteAddressdirectly to the command executor so callers (including SeleniumBridge and log broadcast listeners) see the updated server URL afterdirectConnector subsequent URL overrides.LogBroadcastEndpointsunder io.appium.java_client.internal shared byListensToLogcatMessagesandListensToSyslogMessages(keeping SessionHelpers focused on session-address parsing), deriving ws/wss directly from the active server URL while preserving the existing 0-arg and 1-arg default host and port (127.0.0.1:4723/localhost:4723).formatHostinto io.appium.java_client.internal.Strings for shared IPv6 bracket normalization in both DirectConnect and LogBroadcastEndpoints.Types of changes
Details
After the command executor became standalone in v11, overriding the server URL created a new HTTP client with the overridden base URL without updating the stored client configuration. That left the executor, driver remote address, and Selenium bridge configuration pointing to the initial hub URL after direct connect.
Added unit tests covering atomic executor state updates, Selenium bridge client configuration propagation, local service base URL fallback, nullable service constructor compatibility, HTTPS log broadcast wss derivation from the updated server URL while keeping legacy 0-arg/1-arg defaults, IPv6 / path normalization, and loud failure on blank direct-connect fields.