chore: update to tauri alpha.16, api alpha.9 (#673)

Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>

plugins/websocket/Cargo.toml

@@ -20,7 +20,7 @@ thiserror = { workspace = true }
 rand = "0.8"
 futures-util = "0.3"
 tokio = { version = "1", features = [ "net", "sync" ] }
-tokio-tungstenite = { version = "0.19" }
+tokio-tungstenite = { version = "0.20" }
 
 [features]
 native-tls = [ "tokio-tungstenite/native-tls" ]

plugins/websocket/README.md

@@ -4,7 +4,7 @@ Expose a WebSocket server to your Tauri frontend.
 
 ## Install
 
-_This plugin requires a Rust version of at least **1.65**_
+_This plugin requires a Rust version of at least **1.70**_
 
 There are three general methods of installation that we can recommend.
 

plugins/websocket/examples/svelte-app/package.json

@@ -11,14 +11,14 @@
     "tauri": "tauri"
   },
   "devDependencies": {
-    "@sveltejs/adapter-static": "1.0.0-next.50",
-    "@sveltejs/kit": "1.22.3",
-    "@tauri-apps/cli": "2.0.0-alpha.15",
-    "svelte": "4.0.5",
-    "svelte-check": "3.4.6",
-    "tslib": "2.6.0",
-    "typescript": "5.1.6",
-    "vite": "4.4.4"
+    "@sveltejs/adapter-static": "2.0.3",
+    "@sveltejs/kit": "1.26.0",
+    "@tauri-apps/cli": "2.0.0-alpha.16",
+    "svelte": "4.2.2",
+    "svelte-check": "3.5.2",
+    "tslib": "2.6.2",
+    "typescript": "5.2.2",
+    "vite": "4.5.0"
   },
   "dependencies": {
     "@tauri-apps/plugin-websocket": "link:../../"

plugins/websocket/examples/svelte-app/src-tauri/Cargo.toml

@@ -11,7 +11,7 @@ tauri = { workspace = true }
 tokio = { version = "1", features = ["net"] }
 futures-util = "0.3"
 tauri-plugin-websocket = { path = "../../../" }
-tokio-tungstenite = "0.19"
+tokio-tungstenite = "0.20"
 
 [build-dependencies]
 tauri-build = { workspace = true }

plugins/websocket/guest-js/index.ts

@@ -2,7 +2,16 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-import { invoke, Channel } from "@tauri-apps/api/tauri";
+import { invoke, Channel } from "@tauri-apps/api/primitives";
+
+export interface ConnectionConfig {
+  writeBufferSize?: number;
+  maxWriteBufferSize?: number;
+  maxMessageSize?: number;
+  maxFrameSize?: number;
+  acceptUnmaskedFrames?: boolean;
+  headers?: HeadersInit;
+}
 
 export interface MessageKind<T, D> {
   type: T;
@@ -30,7 +39,10 @@ export default class WebSocket {
     this.listeners = listeners;
   }
 
-  static async connect(url: string, options?: unknown): Promise<WebSocket> {
+  static async connect(
+    url: string,
+    config?: ConnectionConfig,
+  ): Promise<WebSocket> {
     const listeners: Array<(arg: Message) => void> = [];
 
     const onMessage = new Channel<Message>();
@@ -41,7 +53,7 @@ export default class WebSocket {
     return await invoke<number>("plugin:websocket|connect", {
       url,
       onMessage,
-      options,
+      config,
     }).then((id) => new WebSocket(id, listeners));
   }
 

plugins/websocket/package.json

@@ -27,6 +27,6 @@
     "tslib": "2.6.0"
   },
   "dependencies": {
-    "@tauri-apps/api": "2.0.0-alpha.8"
+    "@tauri-apps/api": "2.0.0-alpha.9"
   }
 }

plugins/websocket/src/api-iife.js

@@ -1 +1 @@
-if("__TAURI__"in window){var __TAURI_WEBSOCKET__=function(){"use strict";var e=Object.defineProperty,t=(e,t,n)=>{if(!t.has(e))throw TypeError("Cannot "+n)},n=(e,n,r)=>(t(e,n,"read from private field"),r?r.call(e):n.get(e)),r=(e,n,r,i)=>(t(e,n,"write to private field"),i?i.call(e,r):n.set(e,r),r);function i(e,t=!1){let n=window.crypto.getRandomValues(new Uint32Array(1))[0],r=`_${n}`;return Object.defineProperty(window,r,{value:n=>(t&&Reflect.deleteProperty(window,r),e?.(n)),writable:!1,configurable:!0}),n}((t,n)=>{for(var r in n)e(t,r,{get:n[r],enumerable:!0})})({},{Channel:()=>a,PluginListener:()=>o,addPluginListener:()=>c,convertFileSrc:()=>d,invoke:()=>l,transformCallback:()=>i});var s,a=class{constructor(){this.__TAURI_CHANNEL_MARKER__=!0,((e,t,n)=>{if(t.has(e))throw TypeError("Cannot add the same private member more than once");t instanceof WeakSet?t.add(e):t.set(e,n)})(this,s,(()=>{})),this.id=i((e=>{n(this,s).call(this,e)}))}set onmessage(e){r(this,s,e)}get onmessage(){return n(this,s)}toJSON(){return`__CHANNEL__:${this.id}`}};s=new WeakMap;var o=class{constructor(e,t,n){this.plugin=e,this.event=t,this.channelId=n}async unregister(){return l(`plugin:${this.plugin}|remove_listener`,{event:this.event,channelId:this.channelId})}};async function c(e,t,n){let r=new a;return r.onmessage=n,l(`plugin:${e}|register_listener`,{event:t,handler:r}).then((()=>new o(e,t,r.id)))}async function l(e,t={},n){return new Promise(((r,s)=>{let a=i((e=>{r(e),Reflect.deleteProperty(window,`_${o}`)}),!0),o=i((e=>{s(e),Reflect.deleteProperty(window,`_${a}`)}),!0);window.__TAURI_IPC__({cmd:e,callback:a,error:o,payload:t,options:n})}))}function d(e,t="asset"){return window.__TAURI__.convertFileSrc(e,t)}class _{constructor(e,t){this.id=e,this.listeners=t}static async connect(e,t){const n=[],r=new a;return r.onmessage=e=>{n.forEach((t=>t(e)))},await l("plugin:websocket|connect",{url:e,onMessage:r,options:t}).then((e=>new _(e,n)))}addListener(e){this.listeners.push(e)}async send(e){let t;if("string"==typeof e)t={type:"Text",data:e};else if("object"==typeof e&&"type"in e)t=e;else{if(!Array.isArray(e))throw new Error("invalid `message` type, expected a `{ type: string, data: any }` object, a string or a numeric array");t={type:"Binary",data:e}}return await l("plugin:websocket|send",{id:this.id,message:t})}async disconnect(){return await this.send({type:"Close",data:{code:1e3,reason:"Disconnected by client"}})}}return _}();Object.defineProperty(window.__TAURI__,"websocket",{value:__TAURI_WEBSOCKET__})}
+if("__TAURI__"in window){var __TAURI_WEBSOCKET__=function(){"use strict";var e=Object.defineProperty,t=(e,t,n)=>{if(!t.has(e))throw TypeError("Cannot "+n)},n=(e,n,r)=>(t(e,n,"read from private field"),r?r.call(e):n.get(e));function r(e,t=!1){return window.__TAURI_INTERNALS__.transformCallback(e,t)}((t,n)=>{for(var r in n)e(t,r,{get:n[r],enumerable:!0})})({},{Channel:()=>s,PluginListener:()=>a,addPluginListener:()=>o,convertFileSrc:()=>_,invoke:()=>c,transformCallback:()=>r});var i,s=class{constructor(){this.__TAURI_CHANNEL_MARKER__=!0,((e,t,n)=>{if(t.has(e))throw TypeError("Cannot add the same private member more than once");t instanceof WeakSet?t.add(e):t.set(e,n)})(this,i,(()=>{})),this.id=r((e=>{n(this,i).call(this,e)}))}set onmessage(e){var n,r,s,a;s=e,t(n=this,r=i,"write to private field"),a?a.call(n,s):r.set(n,s)}get onmessage(){return n(this,i)}toJSON(){return`__CHANNEL__:${this.id}`}};i=new WeakMap;var a=class{constructor(e,t,n){this.plugin=e,this.event=t,this.channelId=n}async unregister(){return c(`plugin:${this.plugin}|remove_listener`,{event:this.event,channelId:this.channelId})}};async function o(e,t,n){let r=new s;return r.onmessage=n,c(`plugin:${e}|register_listener`,{event:t,handler:r}).then((()=>new a(e,t,r.id)))}async function c(e,t={},n){return window.__TAURI_INTERNALS__.invoke(e,t,n)}function _(e,t="asset"){return window.__TAURI_INTERNALS__.convertFileSrc(e,t)}class l{constructor(e,t){this.id=e,this.listeners=t}static async connect(e,t){const n=[],r=new s;return r.onmessage=e=>{n.forEach((t=>t(e)))},await c("plugin:websocket|connect",{url:e,onMessage:r,config:t}).then((e=>new l(e,n)))}addListener(e){this.listeners.push(e)}async send(e){let t;if("string"==typeof e)t={type:"Text",data:e};else if("object"==typeof e&&"type"in e)t=e;else{if(!Array.isArray(e))throw new Error("invalid `message` type, expected a `{ type: string, data: any }` object, a string or a numeric array");t={type:"Binary",data:e}}return await c("plugin:websocket|send",{id:this.id,message:t})}async disconnect(){return await this.send({type:"Close",data:{code:1e3,reason:"Disconnected by client"}})}}return l}();Object.defineProperty(window.__TAURI__,"websocket",{value:__TAURI_WEBSOCKET__})}

plugins/websocket/src/lib.rs

@@ -55,20 +55,29 @@ impl Serialize for Error {
 #[derive(Default)]
 struct ConnectionManager(Mutex<HashMap<Id, WebSocketWriter>>);
 
-#[derive(Default, Deserialize)]
+#[derive(Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct ConnectionConfig {
-    pub max_send_queue: Option<usize>,
+    pub write_buffer_size: Option<usize>,
+    pub max_write_buffer_size: Option<usize>,
     pub max_message_size: Option<usize>,
     pub max_frame_size: Option<usize>,
+    #[serde(default)]
     pub accept_unmasked_frames: bool,
+    pub headers: Option<Vec<(String, String)>>,
 }
 
 impl From<ConnectionConfig> for WebSocketConfig {
     fn from(config: ConnectionConfig) -> Self {
+        // Disabling the warning on max_send_queue which we don't use anymore since it was deprecated.
+        #[allow(deprecated)]
         Self {
-            max_send_queue: config.max_send_queue,
+            max_send_queue: None,
+            write_buffer_size: config.write_buffer_size.unwrap_or(128 * 1024),
+            max_write_buffer_size: config.max_write_buffer_size.unwrap_or(usize::MAX),
+            // This may be harmful since if it's not provided from js we're overwriting the default value with None, meaning no size limit.
             max_message_size: config.max_message_size,
+            // This may be harmful since if it's not provided from js we're overwriting the default value with None, meaning no size limit.
             max_frame_size: config.max_frame_size,
             accept_unmasked_frames: config.accept_unmasked_frames,
         }
@@ -96,10 +105,10 @@ async fn connect<R: Runtime>(
     window: Window<R>,
     url: String,
     on_message: Channel,
-    options: Option<ConnectionConfig>,
+    config: Option<ConnectionConfig>,
 ) -> Result<Id> {
     let id = rand::random();
-    let (ws_stream, _) = connect_async_with_config(url, options.map(Into::into), false).await?;
+    let (ws_stream, _) = connect_async_with_config(url, config.map(Into::into), false).await?;
 
     tauri::async_runtime::spawn(async move {
         let (write, read) = ws_stream.split();