refactor(os)!: make platform, arch, type, family, version and exe_extension functions sync (#1353)

closes #1351

Author: amrbashir

.changes/os-sync-functions.md

@@ -0,0 +1,6 @@
+---
+"os": "patch"
+"os-js": "patch"
+---
+
+**Breaking** Changed `platform`, `arch`, `type`, `family`, `version` and `exe_extension` functions to be sync.

plugins/os/api-iife.js

@@ -15,6 +15,12 @@ declare global {
   interface Window {
     __TAURI_OS_PLUGIN_INTERNALS__: {
       eol: string;
+      os_type: OsType;
+      platform: Platform;
+      family: Family;
+      version: string;
+      arch: Arch;
+      exe_extension: string;
     };
   }
 }
@@ -70,8 +76,8 @@ function eol(): string {
  * @since 2.0.0
  *
  */
-async function platform(): Promise<Platform> {
-  return await invoke("plugin:os|platform");
+function platform(): Platform {
+  return window.__TAURI_OS_PLUGIN_INTERNALS__.platform;
 }
 
 /**
@@ -84,8 +90,8 @@ async function platform(): Promise<Platform> {
  *
  * @since 2.0.0
  */
-async function version(): Promise<string> {
-  return await invoke("plugin:os|version");
+function version(): string {
+  return window.__TAURI_OS_PLUGIN_INTERNALS__.version;
 }
 
 type Family = "unix" | "windows";
@@ -100,8 +106,8 @@ type Family = "unix" | "windows";
  *
  * @since 2.0.0
  */
-async function family(): Promise<Family> {
-  return await invoke("plugin:os|family");
+function family(): Family {
+  return window.__TAURI_OS_PLUGIN_INTERNALS__.family;
 }
 
 /**
@@ -114,8 +120,8 @@ async function family(): Promise<Family> {
  *
  * @since 2.0.0
  */
-async function type(): Promise<OsType> {
-  return await invoke("plugin:os|os_type");
+function type(): OsType {
+  return window.__TAURI_OS_PLUGIN_INTERNALS__.os_type;
 }
 
 /**
@@ -129,39 +135,39 @@ async function type(): Promise<OsType> {
  *
  * @since 2.0.0
  */
-async function arch(): Promise<Arch> {
-  return await invoke("plugin:os|arch");
+function arch(): Arch {
+  return window.__TAURI_OS_PLUGIN_INTERNALS__.arch;
 }
 
 /**
- * Returns a String with a `BCP-47` language tag inside. If the locale couldn’t be obtained, `null` is returned instead.
+ * Returns the file extension, if any, used for executable binaries on this platform. Possible values are `'exe'` and `''` (empty string).
  * @example
  * ```typescript
- * import { locale } from '@tauri-apps/plugin-os';
- * const locale = await locale();
- * if (locale) {
- *    // use the locale string here
- * }
+ * import { exeExtension } from '@tauri-apps/plugin-os';
+ * const exeExt = await exeExtension();
  * ```
  *
  * @since 2.0.0
  */
-async function locale(): Promise<string | null> {
-  return await invoke("plugin:os|locale");
+function exeExtension(): string {
+  return window.__TAURI_OS_PLUGIN_INTERNALS__.exe_extension;
 }
 
 /**
- * Returns the file extension, if any, used for executable binaries on this platform. Possible values are `'exe'` and `''` (empty string).
+ * Returns a String with a `BCP-47` language tag inside. If the locale couldn’t be obtained, `null` is returned instead.
  * @example
  * ```typescript
- * import { exeExtension } from '@tauri-apps/plugin-os';
- * const exeExt = await exeExtension();
+ * import { locale } from '@tauri-apps/plugin-os';
+ * const locale = await locale();
+ * if (locale) {
+ *    // use the locale string here
+ * }
  * ```
  *
  * @since 2.0.0
  */
-async function exeExtension(): Promise<string | null> {
-  return await invoke("plugin:os|exe_extension");
+async function locale(): Promise<string | null> {
+  return await invoke("plugin:os|locale");
 }
 
 /**

plugins/os/guest-js/index.ts

@@ -2,36 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-#[tauri::command]
-pub fn platform() -> &'static str {
-    crate::platform()
-}
-
-#[tauri::command]
-pub fn version() -> String {
-    crate::version().to_string()
-}
-
-#[tauri::command]
-pub fn os_type() -> String {
-    crate::type_().to_string()
-}
-
-#[tauri::command]
-pub fn family() -> &'static str {
-    crate::family()
-}
-
-#[tauri::command]
-pub fn arch() -> &'static str {
-    crate::arch()
-}
-
-#[tauri::command]
-pub fn exe_extension() -> &'static str {
-    crate::exe_extension()
-}
-
 #[tauri::command]
 pub fn locale() -> Option<String> {
     crate::locale()

plugins/os/src/commands.rs

@@ -6,5 +6,11 @@
 Object.defineProperty(window, "__TAURI_OS_PLUGIN_INTERNALS__", {
   value: {
     eol: __TEMPLATE_eol__,
+    os_type: __TEMPLATE_os_type__,
+    platform: __TEMPLATE_platform__,
+    family: __TEMPLATE_family__,
+    version: __TEMPLATE_version__,
+    arch: __TEMPLATE_arch__,
+    exe_extension: __TEMPLATE_exe_extension__,
   },
 });

plugins/os/src/init.js

@@ -102,30 +102,42 @@ pub fn hostname() -> String {
 
 #[derive(Template)]
 #[default_template("./init.js")]
-struct InitJavascript {
+struct InitJavascript<'a> {
     eol: &'static str,
+    os_type: String,
+    platform: &'a str,
+    family: &'a str,
+    version: String,
+    arch: &'a str,
+    exe_extension: &'a str,
 }
 
-pub fn init<R: Runtime>() -> TauriPlugin<R> {
-    let init_js = InitJavascript {
-        #[cfg(windows)]
-        eol: "\r\n",
-        #[cfg(not(windows))]
-        eol: "\n",
+impl<'a> InitJavascript<'a> {
+    fn new() -> Self {
+        Self {
+            #[cfg(windows)]
+            eol: "\r\n",
+            #[cfg(not(windows))]
+            eol: "\n",
+            os_type: crate::type_().to_string(),
+            platform: crate::platform(),
+            family: crate::family(),
+            version: crate::version().to_string(),
+            arch: crate::arch(),
+            exe_extension: crate::exe_extension(),
+        }
     }
-    .render_default(&Default::default())
-    // this will never fail with the above global_os_api eol values
-    .unwrap();
+}
+
+pub fn init<R: Runtime>() -> TauriPlugin<R> {
+    let init_js = InitJavascript::new()
+        .render_default(&Default::default())
+        // this will never fail with the above global_os_api values
+        .unwrap();
 
     Builder::new("os")
         .js_init_script(init_js.to_string())
         .invoke_handler(tauri::generate_handler![
-            commands::platform,
-            commands::version,
-            commands::os_type,
-            commands::family,
-            commands::arch,
-            commands::exe_extension,
             commands::locale,
             commands::hostname
         ])