feat: add userAgent property to Navigator's prototype (#14415)

cli/dts/lib.deno.window.d.ts

@@ -71,6 +71,7 @@ declare class Navigator {
   constructor();
   readonly gpu: GPU;
   readonly hardwareConcurrency: number;
+  readonly userAgent: string;
 }
 
 declare var navigator: Navigator;

cli/dts/lib.deno.worker.d.ts

@@ -51,6 +51,7 @@ declare class WorkerNavigator {
   constructor();
   readonly gpu: GPU;
   readonly hardwareConcurrency: number;
+  readonly userAgent: string;
 }
 
 declare var navigator: WorkerNavigator;

cli/main.rs

@@ -158,6 +158,7 @@ fn create_web_worker_callback(
         runtime_version: version::deno(),
         ts_version: version::TYPESCRIPT.to_string(),
         unstable: ps.flags.unstable,
+        user_agent: version::get_user_agent(),
       },
       extensions,
       unsafely_ignore_certificate_errors: ps
@@ -165,7 +166,6 @@ fn create_web_worker_callback(
         .unsafely_ignore_certificate_errors
         .clone(),
       root_cert_store: ps.root_cert_store.clone(),
-      user_agent: version::get_user_agent(),
       seed: ps.flags.seed,
       module_loader,
       create_web_worker_cb,
@@ -254,6 +254,7 @@ pub fn create_main_worker(
       runtime_version: version::deno(),
       ts_version: version::TYPESCRIPT.to_string(),
       unstable: ps.flags.unstable,
+      user_agent: version::get_user_agent(),
     },
     extensions,
     unsafely_ignore_certificate_errors: ps
@@ -261,7 +262,6 @@ pub fn create_main_worker(
       .unsafely_ignore_certificate_errors
       .clone(),
     root_cert_store: ps.root_cert_store.clone(),
-    user_agent: version::get_user_agent(),
     seed: ps.flags.seed,
     source_map_getter: Some(Box::new(ps.clone())),
     format_js_error_fn: Some(Arc::new(format_js_error)),

cli/standalone.rs

@@ -286,9 +286,9 @@ pub async fn run(
       runtime_version: version::deno(),
       ts_version: version::TYPESCRIPT.to_string(),
       unstable: metadata.unstable,
+      user_agent: version::get_user_agent(),
     },
     extensions: ops::cli_exts(ps.clone(), true),
-    user_agent: version::get_user_agent(),
     unsafely_ignore_certificate_errors: metadata
       .unsafely_ignore_certificate_errors,
     root_cert_store: Some(root_cert_store),

cli/tests/unit/navigator_test.ts

@@ -4,3 +4,8 @@ import { assert } from "./test_util.ts";
 Deno.test(function navigatorNumCpus() {
   assert(navigator.hardwareConcurrency > 0);
 });
+
+Deno.test(function navigatorUserAgent() {
+  const pattern = /Deno\/\d+\.\d+\.\d+/;
+  assert(pattern.test(navigator.userAgent));
+});

runtime/examples/hello_runtime.rs

@@ -38,11 +38,11 @@ async fn main() -> Result<(), AnyError> {
       runtime_version: "x".to_string(),
       ts_version: "x".to_string(),
       unstable: false,
+      user_agent: "hello_runtime".to_string(),
     },
     extensions: vec![],
     unsafely_ignore_certificate_errors: None,
     root_cert_store: None,
-    user_agent: "hello_runtime".to_string(),
     seed: None,
     source_map_getter: None,
     format_js_error_fn: None,

runtime/js/99_main.js

@@ -301,7 +301,7 @@ delete Object.prototype.__proto__;
 
   const navigator = webidl.createBranded(Navigator);
 
-  let numCpus;
+  let numCpus, userAgent;
 
   ObjectDefineProperties(Navigator.prototype, {
     gpu: {
@@ -320,6 +320,14 @@ delete Object.prototype.__proto__;
         return numCpus;
       },
     },
+    userAgent: {
+      configurable: true,
+      enumerable: true,
+      get() {
+        webidl.assertBranded(this, NavigatorPrototype);
+        return userAgent;
+      },
+    },
   });
   const NavigatorPrototype = Navigator.prototype;
 
@@ -575,6 +583,7 @@ delete Object.prototype.__proto__;
       ppid,
       unstableFlag,
       cpuCount,
+      userAgent: userAgentInfo,
     } = runtimeOptions;
 
     colors.setNoColor(noColor || !isTty);
@@ -582,6 +591,7 @@ delete Object.prototype.__proto__;
       location.setLocationHref(locationHref);
     }
     numCpus = cpuCount;
+    userAgent = userAgentInfo;
     registerErrors();
 
     const internalSymbol = Symbol("Deno.internal");

runtime/web_worker.rs

@@ -323,7 +323,6 @@ pub struct WebWorkerOptions {
   pub extensions: Vec<Extension>,
   pub unsafely_ignore_certificate_errors: Option<Vec<String>>,
   pub root_cert_store: Option<RootCertStore>,
-  pub user_agent: String,
   pub seed: Option<u64>,
   pub module_loader: Rc<dyn ModuleLoader>,
   pub create_web_worker_cb: Arc<ops::worker_host::CreateWebWorkerCb>,
@@ -386,7 +385,7 @@ impl WebWorker {
         Some(main_module.clone()),
       ),
       deno_fetch::init::<Permissions>(deno_fetch::Options {
-        user_agent: options.user_agent.clone(),
+        user_agent: options.bootstrap.user_agent.clone(),
         root_cert_store: options.root_cert_store.clone(),
         unsafely_ignore_certificate_errors: options
           .unsafely_ignore_certificate_errors
@@ -395,7 +394,7 @@ impl WebWorker {
         ..Default::default()
       }),
       deno_websocket::init::<Permissions>(
-        options.user_agent.clone(),
+        options.bootstrap.user_agent.clone(),
         options.root_cert_store.clone(),
         options.unsafely_ignore_certificate_errors.clone(),
       ),

runtime/worker.rs

@@ -52,7 +52,6 @@ pub struct WorkerOptions {
   pub extensions: Vec<Extension>,
   pub unsafely_ignore_certificate_errors: Option<Vec<String>>,
   pub root_cert_store: Option<RootCertStore>,
-  pub user_agent: String,
   pub seed: Option<u64>,
   pub module_loader: Rc<dyn ModuleLoader>,
   // Callbacks invoked when creating new instance of WebWorker
@@ -111,7 +110,7 @@ impl MainWorker {
         options.bootstrap.location.clone(),
       ),
       deno_fetch::init::<Permissions>(deno_fetch::Options {
-        user_agent: options.user_agent.clone(),
+        user_agent: options.bootstrap.user_agent.clone(),
         root_cert_store: options.root_cert_store.clone(),
         unsafely_ignore_certificate_errors: options
           .unsafely_ignore_certificate_errors
@@ -120,7 +119,7 @@ impl MainWorker {
         ..Default::default()
       }),
       deno_websocket::init::<Permissions>(
-        options.user_agent.clone(),
+        options.bootstrap.user_agent.clone(),
         options.root_cert_store.clone(),
         options.unsafely_ignore_certificate_errors.clone(),
       ),
@@ -376,9 +375,9 @@ mod tests {
         runtime_version: "x".to_string(),
         ts_version: "x".to_string(),
         unstable: false,
+        user_agent: "x".to_string(),
       },
       extensions: vec![],
-      user_agent: "x".to_string(),
       unsafely_ignore_certificate_errors: None,
       root_cert_store: None,
       seed: None,

runtime/worker_bootstrap.rs

@@ -20,6 +20,7 @@ pub struct BootstrapOptions {
   /// Sets `Deno.version.typescript` in JS runtime.
   pub ts_version: String,
   pub unstable: bool,
+  pub user_agent: String,
 }
 
 impl BootstrapOptions {
@@ -42,6 +43,7 @@ impl BootstrapOptions {
       "ppid": ppid(),
       "target": env!("TARGET"),
       "v8Version": deno_core::v8_version(),
+      "userAgent": self.user_agent,
     });
     serde_json::to_string_pretty(&payload).unwrap()
   }