fix: relax selenium exact pin to allow Appium 3 compatibility (#1312) (#1319)

* fix: relax selenium exact pin to allow Appium 3 compatibility (#1312)

Author: mikahanninen

.github/workflows/main.yaml

@@ -119,6 +119,67 @@ jobs:
           name: ${{ matrix.os }}-py${{ matrix.python }}-test-reports
           path: packages/main/tests/results
 
+  build-wheel:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install uv
+        run: pip install uv
+        working-directory: "."
+      - name: Build wheel
+        run: uv build --wheel
+        working-directory: packages/main
+      - name: Upload wheel artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: rpaframework-wheel
+          path: packages/main/dist/*.whl
+          retention-days: 14
+      - name: Comment on PR with artifact link
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const runUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
+            const sha = context.payload.pull_request.head.sha.slice(0, 7);
+            const marker = '<!-- rpaframework-wheel-artifact -->';
+            const body = [
+              marker,
+              '## Wheel artifact',
+              '',
+              `Built from commit \`${sha}\` — download from the [workflow run](${runUrl}) (Artifacts section at the bottom of the page).`,
+              '',
+              'Artifact name: `rpaframework-wheel` (retained 14 days)',
+            ].join('\n');
+
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+            });
+            const existing = comments.find(c => c.body.includes(marker));
+            if (existing) {
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: existing.id,
+                body,
+              });
+            } else {
+              await github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body,
+              });
+            }
+
   # publish:
   #   # Only publish on master workflow runs
   #   if: github.ref == 'refs/heads/master'

packages/core/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "rpaframework-core"
-version = "12.1.0"
+version = "12.1.1"
 description = "Core utilities used by RPA Framework"
 authors = [{name = "RPA Framework", email = "rpafw@robocorp.com"}]
 license = {text = "Apache-2.0"}

packages/core/src/RPA/core/webdriver.py

@@ -33,10 +33,11 @@
     windows_browser_apps_to_cmd,
 )
 from webdriver_manager.drivers.chrome import ChromeDriver as _ChromeDriver
+from webdriver_manager.drivers.edge import EdgeChromiumDriver as _EdgeChromiumDriver
 from webdriver_manager.drivers.ie import IEDriver as _IEDriver
 from webdriver_manager.firefox import GeckoDriverManager
 from webdriver_manager.microsoft import (
-    EdgeChromiumDriverManager,
+    EdgeChromiumDriverManager as _EdgeChromiumDriverManager,
     IEDriverManager as _IEDriverManager,
 )
 from webdriver_manager.opera import OperaDriverManager
@@ -302,6 +303,46 @@ def _get_driver_binary_path(self, driver: ChromeDriver) -> str:
             return binary_path
 
 
+class EdgeChromiumDriver(_EdgeChromiumDriver):
+    """Strips the UTF-16 BOM that Microsoft's LATEST_RELEASE endpoint prepends.
+
+    webdriver-manager 4.0.2 calls ``resp.text.rstrip()`` on the response from
+    ``https://msedgedriver.microsoft.com/LATEST_RELEASE_<major>_WINDOWS``.
+    That endpoint returns a UTF-16 LE response (BOM ``\\xff\\xfe``), which
+    ``requests`` decodes to a string starting with ``\\ufeff`` (the BOM
+    codepoint). ``.rstrip()`` only strips trailing whitespace, leaving the
+    leading ``\\ufeff`` intact.  When that BOM-prefixed version is interpolated
+    into the download URL it becomes ``%EF%BB%BF145.0.3800.97/...`` which
+    returns 404.
+    """
+
+    @staticmethod
+    def _strip_bom(text: str) -> str:
+        return text.strip().lstrip("\ufeff")
+
+    def get_stable_release_version(self) -> str:
+        return self._strip_bom(super().get_stable_release_version())
+
+    def get_latest_release_version(self) -> str:
+        return self._strip_bom(super().get_latest_release_version())
+
+
+class EdgeChromiumDriverManager(_EdgeChromiumDriverManager):
+    """Custom Edge driver manager that uses :class:`EdgeChromiumDriver`."""
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        original = self.driver
+        self.driver = EdgeChromiumDriver(
+            name=getattr(original, "_name", "msedgedriver"),
+            driver_version=getattr(original, "_driver_version_to_download", None),
+            url=getattr(original, "_url", None),
+            latest_release_url=getattr(original, "_latest_release_url", None),
+            http_client=self.http_client,
+            os_system_manager=getattr(original, "_os_system_manager", None),
+        )
+
+
 class IEDriver(_IEDriver):
     """Custom IE driver class that handles discontinued IE driver gracefully."""
 
@@ -663,7 +704,7 @@ def _get_driver_binary_path(self, driver: IEDriver) -> str:
     "opera": OperaDriverManager,
     # NOTE: In Selenium 4 `Edge` is the same with `ChromiumEdge`.
     "edge": EdgeChromiumDriverManager,
-    "chromiumedge": EdgeChromiumDriverManager,
+    "chromiumedge": EdgeChromiumDriverManager,  # uses BOM-stripping subclass
     # NOTE: IE is discontinued and not supported/encouraged anymore.
     "ie": IEDriverManager,
 }

packages/core/tests/python/test_edge_driver.py

@@ -0,0 +1,114 @@
+#!/usr/bin/env python3
+"""Standalone EdgeDriver integration test for issues #1312 and BOM bug.
+
+Verifies that:
+  1. Microsoft's LATEST_RELEASE endpoint BOM is stripped before building the
+     download URL — without the fix, the URL contains %EF%BB%BF and returns 404
+  2. EdgeDriver binary can be downloaded (tests azureedge.net -> microsoft.com
+     redirect fix from PR #1227) — this is the primary test
+  3. A headless Edge session can be started (end-to-end, requires Edge browser installed)
+
+Expected to FAIL without the BOM-strip fix (webdriver-manager 4.0.2 bug).
+Expected to PASS after fix: EdgeChromiumDriver.get_latest_release_version() strips \\ufeff.
+
+Exit codes:
+    0 — download succeeded (session also started if Edge browser is installed)
+    1 — download or session failed unexpectedly
+
+Usage:
+    python test_edge_driver.py
+    # or from packages/core directory:
+    uv run python tests/python/test_edge_driver.py
+"""
+import shutil
+import sys
+from pathlib import Path
+
+
+def main() -> int:
+    import importlib.metadata
+
+    selenium_ver = importlib.metadata.version("selenium")
+    print(f"Selenium version: {selenium_ver}")
+
+    # Step 0: verify BOM-strip fix in EdgeChromiumDriver
+    print("Checking BOM strip in EdgeChromiumDriver...")
+    try:
+        from RPA.core.webdriver import EdgeChromiumDriver
+        bom_version = "\ufeff145.0.3800.97"
+        stripped = EdgeChromiumDriver._strip_bom(bom_version)
+        assert stripped == "145.0.3800.97", f"BOM not stripped: {stripped!r}"
+        print(f"  BOM strip OK: {bom_version!r} -> {stripped!r}")
+    except Exception as exc:
+        print(f"\nFAIL (BOM strip check): {type(exc).__name__}: {exc}")
+        return 1
+
+    # Step 1: download EdgeDriver — exercises the azureedge.net redirect patch
+    try:
+        from RPA.core import webdriver
+
+        results_dir = Path(__file__).parent / "results"
+        results_dir.mkdir(exist_ok=True)
+        print("Downloading EdgeDriver...")
+        driver_path = webdriver.download("Edge", root=results_dir)
+        print(f"  Driver downloaded: {driver_path}")
+    except Exception as exc:
+        print(f"\nFAIL (download): {type(exc).__name__}: {exc}")
+        return 1
+
+    # Step 2: start a headless Edge session — requires Edge browser to be installed
+    edge_binary = shutil.which("msedge") or shutil.which("microsoft-edge")
+    if not edge_binary:
+        # Check standard macOS application path
+        macos_edge = Path("/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge")
+        if macos_edge.exists():
+            edge_binary = str(macos_edge)
+    if not edge_binary:
+        # Check standard Windows installation paths (msedge.exe is not on PATH by default)
+        import os
+        windows_paths = [
+            Path(os.environ.get("PROGRAMFILES(X86)", "")) / "Microsoft/Edge/Application/msedge.exe",
+            Path(os.environ.get("PROGRAMFILES", "")) / "Microsoft/Edge/Application/msedge.exe",
+            Path(os.environ.get("LOCALAPPDATA", "")) / "Microsoft/Edge/Application/msedge.exe",
+        ]
+        for p in windows_paths:
+            if p.exists():
+                edge_binary = str(p)
+                break
+
+    if not edge_binary:
+        print(
+            "\nPASS (download only): EdgeDriver downloaded successfully. "
+            "Edge browser not installed — skipping session test."
+        )
+        return 0
+
+    try:
+        from selenium import webdriver as selenium_webdriver
+        from selenium.webdriver import EdgeOptions
+        from selenium.webdriver.edge.service import Service
+
+        options = EdgeOptions()
+        options.add_argument("--headless=new")
+        options.add_argument("--no-sandbox")
+        options.add_argument("--disable-dev-shm-usage")
+        options.binary_location = edge_binary
+        service = Service(driver_path)
+        print(f"Starting headless Edge session (binary: {edge_binary})...")
+        driver = selenium_webdriver.Edge(service=service, options=options)
+        try:
+            driver.get("about:blank")
+            title = driver.title
+        finally:
+            driver.quit()
+        print(f"  Session OK, page title: '{title}'")
+    except Exception as exc:
+        print(f"\nFAIL (session): {type(exc).__name__}: {exc}")
+        return 1
+
+    print("\nPASS: EdgeDriver download and session both work correctly.")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

packages/main/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "rpaframework"
-version = "31.1.2"
+version = "31.2.0"
 description = "A collection of tools and libraries for RPA"
 authors = [{name = "RPA Framework", email = "rpafw@robocorp.com"}]
 license = {text = "Apache-2.0"}
@@ -60,7 +60,7 @@ dependencies = [
 	"mss>=6.0.0",
 	"chardet>=3.0.0",
 	"PySocks>=1.5.6,!=1.5.7,<2.0.0",
-	"selenium==4.15.2",
+	"selenium>=4.16.0,<5.0.0",
 	"click>=8.1.2",
 	"PyYAML>=5.4.1,<7.0.0",
 	"tenacity>=8.0.1",

packages/main/scripts/ai-review.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+# AI code review — runs Claude against the current branch diff (vs master).
+#
+# Usage:
+#   ./packages/main/scripts/ai-review.sh          # review all changes vs master
+#   ./packages/main/scripts/ai-review.sh --staged  # review only staged changes
+#
+# Called automatically by pre-push.sh; can also be run standalone.
+# Requires `claude` (Claude Code CLI) to be on PATH.
+
+set -euo pipefail
+
+REPO_ROOT="$(git rev-parse --show-toplevel)"
+BASE_BRANCH="${AI_REVIEW_BASE:-master}"
+if ! [[ "$BASE_BRANCH" =~ ^[A-Za-z0-9/_.-]+$ ]]; then
+    echo ">>> ai-review: invalid AI_REVIEW_BASE value '$BASE_BRANCH' — aborting." >&2
+    exit 1
+fi
+STAGED_ONLY="${1:-}"
+
+if ! command -v claude &>/dev/null; then
+    echo ">>> ai-review: 'claude' not found on PATH — skipping AI review."
+    exit 0
+fi
+
+# Build the diff
+if [[ "$STAGED_ONLY" == "--staged" ]]; then
+    DIFF="$(git -C "$REPO_ROOT" diff --cached)"
+    DIFF_LABEL="staged changes"
+else
+    DIFF="$(git -C "$REPO_ROOT" diff "$BASE_BRANCH"...HEAD)"
+    DIFF_LABEL="changes vs $BASE_BRANCH"
+fi
+
+if [[ -z "$DIFF" ]]; then
+    echo ">>> ai-review: no diff found ($DIFF_LABEL) — skipping."
+    exit 0
+fi
+
+DIFF_LINES="$(echo "$DIFF" | wc -l | tr -d ' ')"
+echo ">>> Running AI review on $DIFF_LABEL ($DIFF_LINES lines of diff)..."
+
+PROMPT="You are a senior Python code reviewer. Review the following git diff carefully.
+
+Focus ONLY on real problems (not style nits). Flag:
+- Wrong exception types raised (e.g. built-in TimeoutError instead of selenium TimeoutException)
+- Missing guards for platform/driver-specific APIs (e.g. Chromium-only features called on Firefox)
+- Misleading or incorrect error messages
+- Import errors or removed APIs used
+- Security issues (command injection, SQL injection, XSS, path traversal, etc.)
+- Logic bugs that would cause test failures or silent misbehaviour
+- CI/CD configuration mistakes (wrong working-directory, missing permissions, etc.)
+
+Format your response as a concise bulleted list. If there are no issues, say 'No issues found.'
+Group by severity: [HIGH], [MEDIUM], [LOW].
+
+GIT DIFF:
+$DIFF"
+
+# Unset CLAUDECODE so this can run inside a Claude Code session (e.g. during /review)
+echo "$PROMPT" | env -u CLAUDECODE claude --print --output-format text
+EXIT_CODE=$?
+
+echo ""
+if [[ $EXIT_CODE -ne 0 ]]; then
+    echo ">>> ai-review: claude exited with code $EXIT_CODE."
+fi
+exit 0  # AI review is advisory — never block the push

packages/main/scripts/pre-push.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+# Pre-push hook for packages/main — runs lint, fast tests, and AI review locally.
+# Install: cp packages/main/scripts/pre-push.sh .git/hooks/pre-push && chmod +x .git/hooks/pre-push
+# Skip AI review: AI_REVIEW=0 git push
+
+set -euo pipefail
+REPO_ROOT="$(git rev-parse --show-toplevel)"
+cd "$REPO_ROOT/packages/main"
+
+echo ">>> Running pylint..."
+uv run pylint --rcfile ../../config/pylint src
+
+echo ">>> Running fast tests (no browser required)..."
+uv run pytest tests/python/test_browser.py \
+    -k "not (TestSelenium or TestRelativeLocators or TestBrowserLogs or TestNetworkInterception or TestVirtualAuthenticator)" \
+    -v
+
+# AI review (advisory — never blocks the push; set AI_REVIEW=0 to skip)
+if [[ "${AI_REVIEW:-1}" != "0" ]]; then
+    bash "$REPO_ROOT/packages/main/scripts/ai-review.sh"
+fi
+
+echo ">>> OK — pushing."