Add isWebdriver to metrics. (#11162)

## Describe your changes

Check whether Streamlit is running inside an end-to-end test by adding
`isWebdriver` to the metrics (reading from `navigator.webdriver`).

## GitHub Issue Link (if applicable)

n/a

## Testing Plan

- ~~Explanation of why no additional tests are needed~~
- Unit Tests (JS and/or Python) ✅ 
- E2E Tests: **TODO**
- ~~Any manual testing needed?~~

---

**Contribution License Agreement**

By submitting this pull request you agree that all contributions to this
project are made under the Apache 2.0 license.

---------

Co-authored-by: Ken McGrady <[email protected]>

Author: sfc-gh-tteixeira

e2e_playwright/basic_app_test.py

@@ -21,6 +21,18 @@
 from e2e_playwright.conftest import wait_for_app_loaded
 
 
+def test_is_webdriver_set(app: Page):
+    """Test that verifies that the window.navigator.webdriver is set to True
+    when running inside an end-to-end test.
+
+    This isn't great but it's the best way we came up with to double-check that
+    MetricsManager.isWebdriver() does what we want it to. We basically just
+    copy the contents of that function here for testing :( .
+    """
+    content = app.evaluate("window.navigator.webdriver")
+    assert content, "window.navigator.webdriver is set to False"
+
+
 def test_total_loaded_assets_size_under_threshold(page: Page, app_port: int):
     """Test that verifies the total size of loaded web assets is under a
     configured threshold.

frontend/app/src/MetricsManager.test.ts

@@ -45,6 +45,8 @@ const getMetricsManager = (
   return mm
 }
 
+const originalWebdriver = window.navigator.webdriver
+
 // Mock fetch for our metrics config request
 global.fetch = vi.fn(() =>
   Promise.resolve({
@@ -120,6 +122,7 @@ const checkDefaultEventData = (
 
 afterEach(() => {
   window.analytics = undefined
+  window.navigator.webdriver = originalWebdriver
   window.localStorage.clear()
   setCookie("ajs_anonymous_id")
 })
@@ -412,3 +415,32 @@ test("tracks installation data", () => {
   expect(trackCall.machineIdV3).toEqual(sessionInfo.current.installationIdV3)
   expect(trackCall.machineIdV4).toEqual(sessionInfo.current.installationIdV4)
 })
+
+test("tracks server/local debug data", () => {
+  const sessionInfo = mockSessionInfo()
+  const mm = getMetricsManager(sessionInfo)
+  mm.initialize({ gatherUsageStats: true })
+  mm.enqueue("ev1", { data1: 11 })
+
+  const trackCall = mm.track.mock.calls[0][0]
+  expect(trackCall.serverOs).toEqual(sessionInfo.current.serverOS)
+  expect(trackCall.hasDisplay).toEqual(sessionInfo.current.hasDisplay)
+
+  // This test runs outside a browser so isWebdriver should be false.
+  expect(trackCall.isWebdriver).toEqual(false)
+})
+
+test("tracks server/local debug data with mocked webdriver", () => {
+  window.navigator.webdriver = true
+  const sessionInfo = mockSessionInfo()
+  const mm = getMetricsManager(sessionInfo)
+  mm.initialize({ gatherUsageStats: true })
+  mm.enqueue("ev1", { data1: 11 })
+
+  const trackCall = mm.track.mock.calls[0][0]
+  expect(trackCall.serverOs).toEqual(sessionInfo.current.serverOS)
+  expect(trackCall.hasDisplay).toEqual(sessionInfo.current.hasDisplay)
+
+  // This test runs outside a browser so isWebdriver should be false.
+  expect(trackCall.isWebdriver).toEqual(true)
+})

frontend/app/src/MetricsManager.ts

@@ -247,6 +247,7 @@ export class MetricsManager {
       pythonVersion: this.sessionInfo.current.pythonVersion,
       serverOs: this.sessionInfo.current.serverOS,
       hasDisplay: this.sessionInfo.current.hasDisplay,
+      isWebdriver: isWebdriver(),
       ...this.getContextData(),
     })
 
@@ -341,3 +342,7 @@ export class MetricsManager {
     }
   }
 }
+
+function isWebdriver(): boolean {
+  return window.navigator?.webdriver ?? false
+}

proto/streamlit/proto/MetricsEvent.proto

@@ -39,6 +39,7 @@ message MetricsEvent {
   string python_version = 36;
   string server_os = 42;
   bool has_display = 43;
+  bool is_webdriver = 44;
 
   // Host tracking fields:
   string hosted_at = 9;
@@ -82,7 +83,7 @@ message MetricsEvent {
   int64 total_load_time = 39;
   BrowserInfo browser_info = 40;
 
-  // Next ID: 44
+  // Next ID: 45
 }
 
 message BrowserInfo {