Repository navigation
feat: add the Wincore driver and options - #2475
Open
mykola-mokhnach wants to merge 7 commits into
Open
mykola-mokhnach wants to merge 7 commits into
mykola-mokhnach wants to merge 7 commits into
Conversation
The Windows driver is deprecated and not supported since Appium 4. Add WincoreDriver, WincoreOptions and Wincore screen recording options for its successor, appium-wincore-driver, and document the Windows driver deprecation. The Wincore recording options send videoFps, whereas the Windows ones send fps. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
mykola-mokhnach
requested review from
SrinivasanTarget,
saikrishna321 and
valfirst
as code owners
October 12, 2026 06:04
valfirst
requested changes
Oct 12, 2026
| String MAC2 = "Mac2"; | ||
| /** The automation name of the <a href="https://github.com/appium/appium-windows-driver">Windows driver</a>. */ | ||
| /** The automation name of the <a href="https://github.com/appium/appium-windows-driver">Windows driver</a>, deprecated and not supported since Appium 4. */ | ||
| String WINDOWS = "Windows"; |
Collaborator
There was a problem hiding this comment.
Suggested change
| String WINDOWS = "Windows"; | |
| @Deprecated | |
| String WINDOWS = "Windows"; |
Contributor
Author
There was a problem hiding this comment.
I deliberately was avoiding marking this driver as deprecated before we release Appium4 from beta. However, the wincore driver already works just fine for v3.
@valfirst would you prefer to mark that stuff as deprecated now in the same PR?
Collaborator
There was a problem hiding this comment.
Deprecation doesn't block anything, it's just a notification. I would mark the old stuff as deprecated.
Contributor
Author
| * <p>Note: appium-windows-driver is deprecated and not supported since Appium 4, use appium-wincore-driver instead, | ||
| * see {@link io.appium.java_client.wincore.options.WincoreOptions}.</p> | ||
| */ | ||
| public class WindowsOptions extends BaseOptions<WindowsOptions> implements |
Collaborator
There was a problem hiding this comment.
Suggested change
| public class WindowsOptions extends BaseOptions<WindowsOptions> implements | |
| @Deprecated | |
| public class WindowsOptions extends BaseOptions<WindowsOptions> implements |
Contributor
Author
| * <p>Note: the Windows driver is deprecated and not supported since Appium 4, | ||
| * use {@link io.appium.java_client.wincore.WincoreDriver} instead.</p> | ||
| */ | ||
| public class WindowsDriver extends AppiumDriver implements |
Collaborator
There was a problem hiding this comment.
Suggested change
| public class WindowsDriver extends AppiumDriver implements | |
| @Deprecated | |
| public class WindowsDriver extends AppiumDriver implements |
Contributor
Author
KazuCocoa
reviewed
Oct 12, 2026
KazuCocoa
left a comment
KazuCocoa
left a comment
Member
There was a problem hiding this comment.
Compared this change with appium-wincore-driver 3.1.2 (main at a5bac78). The 15 existing options/HTTP command tests pass locally; the inline comments cover three additional compatibility cases. Recording was checked with a mock HTTP response, and launch-wait conversion was checked against the server implementation; no real-app E2E was run.
- Override the no-arg startRecordingScreen to avoid an NPE on the empty response. - Implement SupportsContextSwitching so WebView contexts and browser detection work. - Serialize ms:waitForAppLaunch in the unit the driver expects: values up to 120 are seconds, greater values are milliseconds. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
KazuCocoa
reviewed
Oct 12, 2026
KazuCocoa
left a comment
KazuCocoa
left a comment
Member
There was a problem hiding this comment.
Two non-blocking documentation suggestions for Wincore setup.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…oreOptions Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Mark WindowsDriver, WindowsOptions and AutomationName.WINDOWS as deprecated in favor of their Wincore counterparts. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
The remaining windows.options classes (PowerShellData and the app arguments, top-level window and working dir options) stay as they are shared with WincoreOptions. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This branch has not been deployed
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
3 participants
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.
The Windows driver is deprecated and not supported since Appium 4. This adds a separate driver, options and screen recording options for its successor, appium-wincore-driver, and deprecates the Windows driver classes.
What's added (
io.appium.java_client.wincore)AutomationName.WINCORE(Wincore).WincoreDriver: same constructors,launchApp/closeAppandpullFile/pushFileasWindowsDriver.SupportsContextSwitchingfor WebView contexts.pullFolderthrowsUnsupportedOperationException, as the driver has no such command.startRecordingScreen()delegates to the options overload, since the driver returns no value.pullFile/pushFilerequire thewincore:modify_fsinsecure feature on the server.WincoreOptions(platformWindows, automation nameWincore). It reuses the existingwindows.optionsinterfaces forappArguments,appTopLevelWindow,appWorkingDirand prerun/postrun, and adds Wincore-specific interfaces for the other capabilities the driver reads:ms:waitForAppLaunch, serialized the way the driver detects units: whole seconds up to 120 are sent as seconds, anything else as milliseconds;shouldCloseApp,ms:forcequit,isolatedScriptExecution;smoothPointerMove,delayBeforeClick,delayAfterClick;webviewEnabled,webviewDevtoolsPort;ffmpegExecutablePath;logFile,perfMetrics.WincoreStart/StopScreenRecordingOptions. The start options sendvideoFps, whereas the Windows ones sendfps.Deliberately left out
systemPortandms:experimental-webdriver: the driver ignores them (stdin/stdout IPC, no experimental switch).appEnvironment: listed in the driver README, but nothing in the driver reads it.Deprecated
WindowsDriver,WindowsOptions,AutomationName.WINDOWS, the Windows screen recording options and the Windows-only capability interfaces (createSessionTimeout,ms:experimental-webdriver,ms:waitForAppLaunch,systemPort) are marked@Deprecatedand point to their Wincore counterparts.PowerShellDataand the app arguments, top-level window and working dir interfaces inwindows.optionsare shared withWincoreOptions, so they are not deprecated.Tests
Options building, the wait-for-launch unit boundaries, and HTTP-level tests for file transfer,
launchApp/closeApp, contexts and screen recording. No real-app E2E was run.cc @y-schwab
🤖 Generated with Claude Code