refactor(core&api)!: hide internal functions and reuse them in api.js…

… & rename `tauri` module to `primitives` (#7942) Co-authored-by: Lucas Nogueira <[email protected]>
tauri-apps · Oct 17, 2023 · a63e71f · a63e71f
1 parent b89d747
commit a63e71f
Show file tree

Hide file tree

Showing 40 changed files with 638 additions and 522 deletions.
diff --git a/.changes/api-primitives.md b/.changes/api-primitives.md
@@ -0,0 +1,5 @@
+---
+'@tauri-apps/api': 'major:breaking'
+---
+
+Changed `tauri` module to `primitives` and removed the undocumented `invoke` export from the root module.
diff --git a/.changes/invoke-system-refactor.md b/.changes/invoke-system-refactor.md
@@ -0,0 +1,5 @@
+---
+"tauri": patch:breaking
+---
+
+The initialization script for `Builder::invoke_system` now must initialize the `window.__TAURI_INTERNALS__.postMessage` function instead of `window.__TAURI_POST_MESSAGE__`.
diff --git a/.prettierignore b/.prettierignore
@@ -5,7 +5,7 @@
 node_modules
 target
 dist
-/core/tauri/scripts
+/core/tauri/scripts/bundle.global.js
 /tooling/cli/templates
 /tooling/cli/node
 /tooling/cli/schema.json

diff --git a/core/tauri-utils/src/pattern/isolation.js b/core/tauri-utils/src/pattern/isolation.js
@@ -8,8 +8,7 @@
  * isolation frame -> main frame = isolation message
  */
 
-;
-(async function () {
+;(async function () {
   /**
    * Sends the message to the isolation frame.
    * @param {any} message

diff --git a/core/tauri/scripts/bundle.global.js b/core/tauri/scripts/bundle.global.js
diff --git a/core/tauri/scripts/core.js b/core/tauri/scripts/core.js
@@ -2,53 +2,48 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-; (function () {
+;(function () {
   function uid() {
     return window.crypto.getRandomValues(new Uint32Array(1))[0]
   }
 
-  if (!window.__TAURI__) {
-    Object.defineProperty(window, '__TAURI__', {
-      value: {}
-    })
-  }
-
   const osName = __TEMPLATE_os_name__
 
-  window.__TAURI__.convertFileSrc = function convertFileSrc(filePath, protocol = 'asset') {
-    const path = encodeURIComponent(filePath)
-    return osName === 'windows' || osName === 'android'
-      ? `http://${protocol}.localhost/${path}`
-      : `${protocol}://localhost/${path}`
-  }
+  Object.defineProperty(window.__TAURI_INTERNALS__, 'convertFileSrc', {
+    value: function (filePath, protocol = 'asset') {
+      const path = encodeURIComponent(filePath)
+      return osName === 'windows' || osName === 'android'
+        ? `http://${protocol}.localhost/${path}`
+        : `${protocol}://localhost/${path}`
+    }
+  })
 
-  window.__TAURI__.transformCallback = function transformCallback(
-    callback,
-    once
-  ) {
-    var identifier = uid()
-    var prop = `_${identifier}`
+  Object.defineProperty(window.__TAURI_INTERNALS__, 'transformCallback', {
+    value: function transformCallback(callback, once) {
+      var identifier = uid()
+      var prop = `_${identifier}`
 
-    Object.defineProperty(window, prop, {
-      value: (result) => {
-        if (once) {
-          Reflect.deleteProperty(window, prop)
-        }
+      Object.defineProperty(window, prop, {
+        value: (result) => {
+          if (once) {
+            Reflect.deleteProperty(window, prop)
+          }
 
-        return callback && callback(result)
-      },
-      writable: false,
-      configurable: true
-    })
+          return callback && callback(result)
+        },
+        writable: false,
+        configurable: true
+      })
 
-    return identifier
-  }
+      return identifier
+    }
+  })
 
   const ipcQueue = []
   let isWaitingForIpc = false
 
   function waitForIpc() {
-    if ('__TAURI_IPC__' in window) {
+    if ('ipc' in window.__TAURI_INTERNALS__) {
       for (const action of ipcQueue) {
         action()
       }
@@ -57,35 +52,43 @@
     }
   }
 
-  window.__TAURI_INVOKE__ = function invoke(cmd, payload = {}, options) {
-    return new Promise(function (resolve, reject) {
-      const callback = window.__TAURI__.transformCallback(function (r) {
-        resolve(r)
-        delete window[`_${error}`]
-      }, true)
-      const error = window.__TAURI__.transformCallback(function (e) {
-        reject(e)
-        delete window[`_${callback}`]
-      }, true)
+  Object.defineProperty(window.__TAURI_INTERNALS__, 'invoke', {
+    value: function (cmd, payload = {}, options) {
+      return new Promise(function (resolve, reject) {
+        const callback = window.__TAURI_INTERNALS__.transformCallback(function (
+          r
+        ) {
+          resolve(r)
+          delete window[`_${error}`]
+        },
+        true)
+        const error = window.__TAURI_INTERNALS__.transformCallback(function (
+          e
+        ) {
+          reject(e)
+          delete window[`_${callback}`]
+        },
+        true)
 
-      const action = () => {
-        window.__TAURI_IPC__({
-          cmd,
-          callback,
-          error,
-          payload,
-          options
-        })
-      }
-      if (window.__TAURI_IPC__) {
-        action()
-      } else {
-        ipcQueue.push(action)
-        if (!isWaitingForIpc) {
-          waitForIpc()
-          isWaitingForIpc = true
+        const action = () => {
+          window.window.__TAURI_INTERNALS__.ipc({
+            cmd,
+            callback,
+            error,
+            payload,
+            options
+          })
         }
-      }
-    })
-  }
+        if ('ipc' in window.__TAURI_INTERNALS__) {
+          action()
+        } else {
+          ipcQueue.push(action)
+          if (!isWaitingForIpc) {
+            waitForIpc()
+            isWaitingForIpc = true
+          }
+        }
+      })
+    }
+  })
 })()
diff --git a/core/tauri/scripts/init.js b/core/tauri/scripts/init.js
@@ -2,25 +2,29 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-; (function () {
+;(function () {
   __RAW_freeze_prototype__
 
   __RAW_pattern_script__
 
   __RAW_ipc_script__
-    ; (function () {
-      __RAW_bundle_script__
-    })()
 
   __RAW_core_script__
 
   __RAW_event_initialization_script__
+  ;(function () {
+    __RAW_bundle_script__
+  })()
 
   if (window.ipc) {
-    window.__TAURI_INVOKE__('__initialized', { url: window.location.href })
+    window.__TAURI_INTERNALS__.invoke('__initialized', {
+      url: window.location.href
+    })
   } else {
     window.addEventListener('DOMContentLoaded', function () {
-      window.__TAURI_INVOKE__('__initialized', { url: window.location.href })
+      window.__TAURI_INTERNALS__.invoke('__initialized', {
+        url: window.location.href
+      })
     })
   }
 

diff --git a/core/tauri/scripts/ipc-protocol.js b/core/tauri/scripts/ipc-protocol.js
@@ -8,15 +8,9 @@
   const fetchChannelDataCommand = __TEMPLATE_fetch_channel_data_command__
   const useCustomProtocol = __TEMPLATE_use_custom_protocol__
 
-  Object.defineProperty(window, '__TAURI_POST_MESSAGE__', {
+  Object.defineProperty(window.__TAURI_INTERNALS__, 'postMessage', {
     value: (message) => {
-      const {
-        cmd,
-        callback,
-        error,
-        payload,
-        options
-      } = message
+      const { cmd, callback, error, payload, options } = message
 
       // use custom protocol for IPC if:
       // - the flag is set to true or
@@ -25,18 +19,16 @@
       // AND
       // - when not on macOS with an https URL
       if (
-        (
-          useCustomProtocol ||
+        (useCustomProtocol ||
           cmd === fetchChannelDataCommand ||
-          !(osName === 'linux' || osName === 'android')
-        ) &&
-        !((osName === 'macos' || osName === 'ios') && location.protocol === 'https:')
+          !(osName === 'linux' || osName === 'android')) &&
+        !(
+          (osName === 'macos' || osName === 'ios') &&
+          location.protocol === 'https:'
+        )
       ) {
-        const {
-          contentType,
-          data
-        } = processIpcMessage(payload)
-        fetch(window.__TAURI__.convertFileSrc(cmd, 'ipc'), {
+        const { contentType, data } = processIpcMessage(payload)
+        fetch(window.__TAURI_INTERNALS__.convertFileSrc(cmd, 'ipc'), {
           method: 'POST',
           body: data,
           headers: {
@@ -45,29 +37,33 @@
             'Tauri-Error': error,
             ...options?.headers
           }
-        }).then((response) => {
-          const cb = response.ok ? callback : error
-          // we need to split here because on Android the content-type gets duplicated
-          switch ((response.headers.get('content-type') || '').split(',')[0]) {
-            case 'application/json':
-              return response.json().then((r) => [cb, r])
-            case 'text/plain':
-              return response.text().then((r) => [cb, r])
-            default:
-              return response.arrayBuffer().then((r) => [cb, r])
-          }
-        }).then(([cb, data]) => {
-          if (window[`_${cb}`]) {
-            window[`_${cb}`](data)
-          } else {
-            console.warn(`[TAURI] Couldn't find callback id {cb} in window. This might happen when the app is reloaded while Rust is running an asynchronous operation.`)
-          }
         })
+          .then((response) => {
+            const cb = response.ok ? callback : error
+            // we need to split here because on Android the content-type gets duplicated
+            switch (
+              (response.headers.get('content-type') || '').split(',')[0]
+            ) {
+              case 'application/json':
+                return response.json().then((r) => [cb, r])
+              case 'text/plain':
+                return response.text().then((r) => [cb, r])
+              default:
+                return response.arrayBuffer().then((r) => [cb, r])
+            }
+          })
+          .then(([cb, data]) => {
+            if (window[`_${cb}`]) {
+              window[`_${cb}`](data)
+            } else {
+              console.warn(
+                `[TAURI] Couldn't find callback id {cb} in window. This might happen when the app is reloaded while Rust is running an asynchronous operation.`
+              )
+            }
+          })
       } else {
         // otherwise use the postMessage interface
-        const {
-          data
-        } = processIpcMessage({
+        const { data } = processIpcMessage({
           cmd,
           callback,
           error,

diff --git a/core/tauri/scripts/ipc.js b/core/tauri/scripts/ipc.js
@@ -6,12 +6,11 @@
  * @typedef {{callback: string, error: string, data: *}} IsolationPayload - a valid isolation payload
  */
 
-;
-(function () {
+;(function () {
   /**
    * @type {string}
    */
-  const pattern = window.__TAURI_PATTERN__.pattern
+  const pattern = window.__TAURI_INTERNALS__.__TAURI_PATTERN__.pattern
 
   /**
    * @type {string}
@@ -33,7 +32,10 @@
    * @return {boolean} - if the event was a valid isolation message
    */
   function isIsolationMessage(event) {
-    if (typeof event.data === 'object' && typeof event.data.payload === 'object') {
+    if (
+      typeof event.data === 'object' &&
+      typeof event.data.payload === 'object'
+    ) {
       const keys = Object.keys(event.data.payload || {})
       return (
         keys.length > 0 &&
@@ -90,12 +92,12 @@
     )
   }
 
-  Object.defineProperty(window, '__TAURI_IPC__', {
+  Object.defineProperty(window.__TAURI_INTERNALS__, 'ipc', {
     // todo: JSDoc this function
     value: Object.freeze((message) => {
       switch (pattern) {
         case 'brownfield':
-          window.__TAURI_POST_MESSAGE__(message)
+          window.__TAURI_INTERNALS__.postMessage(message)
           break
 
         case 'isolation':
@@ -152,7 +154,7 @@
         }
 
         if (isIsolationMessage(event)) {
-          window.__TAURI_POST_MESSAGE__(event.data)
+          window.__TAURI_INTERNALS__.postMessage(event.data)
         }
       },
       false

diff --git a/core/tauri/scripts/pattern.js b/core/tauri/scripts/pattern.js
@@ -15,7 +15,7 @@
     return Object.freeze(object)
   }
 
-  Object.defineProperty(window, '__TAURI_PATTERN__', {
+  Object.defineProperty(window.__TAURI_INTERNALS__, '__TAURI_PATTERN__', {
     value: __tauriDeepFreeze(__TEMPLATE_pattern__)
   })
 })()