Queryable version (#48)

* Add getVersion method

* Bump to 0.0.9 (binary 0.1.8)

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.0.9 (binary 0.1.8) -- 2024-09-23
+
+- Adds a `getVersion` method to `Webview` that returns the binary version.
+- Adds a check on startup that compares the expected version to the current version.
+- Adds slightly more graceful error handling to deserialization errors in the deno code.
+
 ## 0.0.8 (binary 0.1.7) -- 2024-09-23
 
 NOTE: The binary version was bumped this release, but it doesn't actually have changes.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "deno-webview"
-version = "0.1.7"
+version = "0.1.8"
 edition = "2021"
 
 [profile.release]

deno.json

@@ -1,7 +1,7 @@
 {
   "name": "@justbe/webview",
   "exports": "./src/lib.ts",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "tasks": {
     "dev": "deno run --watch main.ts",
     "gen": "deno task gen:rust && deno task gen:deno",

src/lib.ts

@@ -38,7 +38,7 @@ export type { WebViewOptions } from "./schemas.ts";
 
 // Should match the cargo package version
 /** The version of the webview binary that's expected */
-export const BIN_VERSION = "0.1.7";
+export const BIN_VERSION = "0.1.8";
 
 type JSON =
   | string
@@ -234,7 +234,12 @@ export class WebView implements Disposable {
     return new Promise((resolve) => {
       // Setup listener before sending the message to avoid race conditions
       this.#internalEvent.once(id, (event) => {
-        resolve(WebViewResponse.parse(event));
+        const result = WebViewResponse.safeParse(event);
+        if (result.success) {
+          resolve(result.data);
+        } else {
+          resolve({ $type: "err", id, message: result.error.message });
+        }
       });
       this.#stdin.write(
         new TextEncoder().encode(
@@ -256,23 +261,51 @@ export class WebView implements Disposable {
       if (NulCharIndex === -1) {
         continue;
       }
-      const result = WebViewMessage.parse(
+      const result = WebViewMessage.safeParse(
         JSON.parse(this.#buffer.slice(0, NulCharIndex)),
       );
       this.#buffer = this.#buffer.slice(NulCharIndex + 1);
-      return result;
+      if (result.success) {
+        return result.data;
+      } else {
+        console.error("Error parsing message", result.error);
+        return result;
+      }
     }
   }
 
   async #processMessageLoop() {
     while (true) {
       const result = await this.#recv();
       if (!result) return;
+      if ("error" in result) {
+        // TODO: This should be handled more gracefully
+        for (const issue of result.error.issues) {
+          switch (issue.code) {
+            case "invalid_type":
+              console.error(
+                `Invalid type: expected ${issue.expected} but got ${issue.received}`,
+              );
+              break;
+            default:
+              console.error(`Unknown error: ${issue.message}`);
+          }
+        }
+        continue;
+      }
       const { $type, data } = result;
 
       if ($type === "notification") {
         const notification = data;
         this.#externalEvent.emit(notification.$type);
+        if (notification.$type === "started") {
+          const version = notification.version;
+          if (version !== BIN_VERSION) {
+            console.warn(
+              `Expected webview to be version ${BIN_VERSION} but got ${version}. Some features may not work as expected.`,
+            );
+          }
+        }
         if (notification.$type === "closed") {
           return;
         }
@@ -312,6 +345,14 @@ export class WebView implements Disposable {
     this.#externalEvent.once(event, callback);
   }
 
+  /**
+   * Gets the version of the webview binary.
+   */
+  async getVersion(): Promise<string> {
+    const result = await this.#send({ $type: "getVersion" });
+    return returnResult(result, "string");
+  }
+
   /**
    * Sets the title of the webview window.
    */

src/main.rs

@@ -7,6 +7,8 @@ use serde::{Deserialize, Serialize};
 use serde_json;
 use tao::window::Fullscreen;
 
+const VERSION: &str = env!("CARGO_PKG_VERSION");
+
 #[derive(JsonSchema, Deserialize, Debug)]
 struct WebViewOptions {
     /// Sets the title of the window.
@@ -75,7 +77,7 @@ enum Message {
 #[serde(rename_all = "camelCase")]
 #[serde(tag = "$type")]
 enum Notification {
-    Started,
+    Started { version: String },
     Closed,
 }
 
@@ -84,6 +86,7 @@ enum Notification {
 #[serde(rename_all = "camelCase")]
 #[serde(tag = "$type")]
 enum Request {
+    GetVersion { id: String },
     Eval { id: String, js: String },
     SetTitle { id: String, title: String },
     GetTitle { id: String },
@@ -217,7 +220,9 @@ fn main() -> wry::Result<()> {
         *control_flow = ControlFlow::Wait;
 
         match event {
-            Event::NewEvents(StartCause::Init) => notify(Notification::Started),
+            Event::NewEvents(StartCause::Init) => notify(Notification::Started {
+                version: VERSION.into(),
+            }),
             Event::UserEvent(event) => {
                 eprintln!("User event: {:?}", event);
             }
@@ -271,6 +276,12 @@ fn main() -> wry::Result<()> {
                             id,
                             result: window.is_visible().into(),
                         }),
+                        Request::GetVersion { id } => {
+                            res(Response::Result {
+                                id,
+                                result: VERSION.to_string().into(),
+                            });
+                        }
                     }
                 }
             }

src/schemas.ts

@@ -39,6 +39,10 @@ export const WebViewOptions: z.ZodType<WebViewOptions> = z.intersection(
 );
 
 export type WebViewRequest =
+  | {
+    $type: "getVersion";
+    id: string;
+  }
   | {
     $type: "eval";
     id: string;
@@ -69,6 +73,7 @@ export type WebViewRequest =
 export const WebViewRequest: z.ZodType<WebViewRequest> = z.discriminatedUnion(
   "$type",
   [
+    z.object({ $type: z.literal("getVersion"), id: z.string() }),
     z.object({ $type: z.literal("eval"), id: z.string(), js: z.string() }),
     z.object({
       $type: z.literal("setTitle"),
@@ -136,6 +141,7 @@ export type WebViewMessage =
     data:
       | {
         $type: "started";
+        version: string;
       }
       | {
         $type: "closed";
@@ -177,7 +183,7 @@ export const WebViewMessage: z.ZodType<WebViewMessage> = z.discriminatedUnion(
     z.object({
       $type: z.literal("notification"),
       data: z.discriminatedUnion("$type", [
-        z.object({ $type: z.literal("started") }),
+        z.object({ $type: z.literal("started"), version: z.string() }),
         z.object({ $type: z.literal("closed") }),
       ]),
     }),