electrobun 0.0.13 → 0.0.14

package/dist/api/bun/core/Tray.ts

@@ -0,0 +1,105 @@
+import { zigRPC, type MenuItemConfig } from "../proc/zig";
+import electrobunEventEmitter from "../events/eventEmitter";
+import { VIEWS_FOLDER } from "./Paths";
+import { join } from "path";
+
+let nextTrayId = 1;
+const TrayMap = {};
+
+type ConstructorOptions = {
+  title?: string;
+  image?: string;
+  template?: boolean;
+  width?: number;
+  height?: number;
+};
+
+export class Tray {
+  id: number = nextTrayId++;
+
+  constructor({
+    title = "",
+    image = "",
+    template = true,
+    width = 16,
+    height = 16,
+  }: ConstructorOptions = {}) {
+    console.log("img", image);
+    console.log("img", this.resolveImagePath(image));
+    zigRPC.request.createTray({
+      id: this.id,
+      title,
+      image: this.resolveImagePath(image),
+      template,
+      width,
+      height,
+    });
+
+    TrayMap[this.id] = this;
+  }
+
+  resolveImagePath(imgPath: string) {
+    if (imgPath.startsWith("views://")) {
+      return join(VIEWS_FOLDER, imgPath.replace("views://", ""));
+    } else {
+      // can specify any file path here
+      return imgPath;
+    }
+  }
+
+  setTitle(title: string) {
+    zigRPC.request.setTrayTitle({ id: this.id, title });
+  }
+
+  setImage(imgPath: string) {
+    zigRPC.request.setTrayImage({
+      id: this.id,
+      image: this.resolveImagePath(imgPath),
+    });
+  }
+
+  setMenu(menu: Array<MenuItemConfig>) {
+    const menuWithDefaults = menuConfigWithDefaults(menu);
+    zigRPC.request.setTrayMenu({
+      id: this.id,
+      menuConfig: JSON.stringify(menuWithDefaults),
+    });
+  }
+
+  on(name: "tray-clicked", handler) {
+    const specificName = `${name}-${this.id}`;
+    electrobunEventEmitter.on(specificName, handler);
+  }
+
+  static getById(id: number) {
+    return TrayMap[id];
+  }
+
+  static getAll() {
+    return Object.values(TrayMap);
+  }
+}
+
+const menuConfigWithDefaults = (
+  menu: Array<MenuItemConfig>
+): Array<MenuItemConfig> => {
+  return menu.map((item) => {
+    if (item.type === "divider" || item.type === "separator") {
+      return { type: "divider" };
+    } else {
+      return {
+        label: item.label || "",
+        type: item.type || "normal",
+        action: item.action || "",
+        // default enabled to true unless explicitly set to false
+        enabled: item.enabled === false ? false : true,
+        checked: Boolean(item.checked),
+        hidden: Boolean(item.hidden),
+        tooltip: item.tooltip || undefined,
+        ...(item.submenu
+          ? { submenu: menuConfigWithDefaults(item.submenu) }
+          : {}),
+      };
+    }
+  });
+};

package/dist/api/bun/core/Updater.ts

@@ -0,0 +1,387 @@
+import { join, dirname, resolve } from "path";
+import { homedir } from "os";
+import { renameSync, unlinkSync, mkdirSync, rmdirSync, statSync } from "fs";
+import tar from "tar";
+import { ZstdInit } from "@oneidentity/zstd-js/wasm";
+
+const appSupportDir = join(homedir(), "Library", "Application Support");
+
+// todo (yoav): share type with cli
+let localInfo: {
+  version: string;
+  hash: string;
+  bucketUrl: string;
+  channel: string;
+  name: string;
+  identifier: string;
+};
+
+let updateInfo: {
+  version: string;
+  hash: string;
+  updateAvailable: boolean;
+  updateReady: boolean;
+  error: string;
+};
+
+const Updater = {
+  // workaround for some weird state stuff in this old version of bun
+  // todo: revisit after updating to the latest bun
+  updateInfo: () => {
+    return updateInfo;
+  },
+  // todo: allow switching channels, by default will check the current channel
+  checkForUpdate: async () => {
+    const localInfo = await Updater.getLocallocalInfo();
+
+    if (localInfo.channel === "dev") {
+      return {
+        version: localInfo.version,
+        hash: localInfo.hash,
+        updateAvailable: false,
+        updateReady: false,
+        error: "",
+      };
+    }
+
+    const channelBucketUrl = await Updater.channelBucketUrl();
+    const cacheBuster = Math.random().toString(36).substring(7);
+    const updateInfoUrl = join(channelBucketUrl, `update.json?${cacheBuster}`);
+
+    try {
+      const updateInfoResponse = await fetch(updateInfoUrl);
+
+      if (updateInfoResponse.ok) {
+        // todo: this seems brittle
+        updateInfo = await updateInfoResponse.json();
+
+        if (updateInfo.hash !== localInfo.hash) {
+          updateInfo.updateAvailable = true;
+        }
+      } else {
+        return {
+          version: "",
+          hash: "",
+          updateAvailable: false,
+          updateReady: false,
+          error: `Failed to fetch update info from ${updateInfoUrl}`,
+        };
+      }
+    } catch (error) {
+      return {
+        version: "",
+        hash: "",
+        updateAvailable: false,
+        updateReady: false,
+        error: `Failed to fetch update info from ${updateInfoUrl}`,
+      };
+    }
+
+    return updateInfo;
+  },
+
+  downloadUpdate: async () => {
+    const appDataFolder = await Updater.appDataFolder();
+    const channelBucketUrl = await Updater.channelBucketUrl();
+    const appFileName = localInfo.name;
+
+    let currentHash = (await Updater.getLocallocalInfo()).hash;
+    let latestHash = (await Updater.checkForUpdate()).hash;
+
+    let currentTarPath = join(
+      appDataFolder,
+      "self-extraction",
+      `${currentHash}.tar`
+    );
+    const latestTarPath = join(
+      appDataFolder,
+      "self-extraction",
+      `${latestHash}.tar`
+    );
+
+    const seenHashes = [];
+
+    // todo (yoav): add a check to the while loop that checks for a hash we've seen before
+    // so that update loops that are cyclical can be broken
+    if (!(await Bun.file(latestTarPath).exists())) {
+      while (currentHash !== latestHash) {
+        seenHashes.push(currentHash);
+        const currentTar = Bun.file(currentTarPath);
+
+        if (!(await currentTar.exists())) {
+          // tar file of the current version not found
+          // so we can't patch it. We need the byte-for-byte tar file
+          // so break out and download the full version
+          break;
+        }
+
+        // check if there's a patch file for it
+        const patchResponse = await fetch(
+          join(channelBucketUrl, `${currentHash}.patch`)
+        );
+
+        if (!patchResponse.ok) {
+          // patch not found
+          break;
+        }
+
+        // The patch file's name is the hash of the "from" version
+        const patchFilePath = join(
+          appDataFolder,
+          "self-extraction",
+          `${currentHash}.patch`
+        );
+        await Bun.write(patchFilePath, await patchResponse.arrayBuffer());
+        // patch it to a tmp name
+        const tmpPatchedTarFilePath = join(
+          appDataFolder,
+          "self-extraction",
+          `from-${currentHash}.tar`
+        );
+
+        // Note: cwd should be Contents/MacOS/ where the binaries are in the amc app bundle
+        try {
+          Bun.spawnSync([
+            "bspatch",
+            currentTarPath,
+            tmpPatchedTarFilePath,
+            patchFilePath,
+          ]);
+        } catch (error) {
+          break;
+        }
+
+        let versionSubpath = "";
+        const untarDir = join(appDataFolder, "self-extraction", "tmpuntar");
+        mkdirSync(untarDir, { recursive: true });
+
+        // extract just the version.json from the patched tar file so we can see what hash it is now
+        await tar.x({
+          // gzip: false,
+          file: tmpPatchedTarFilePath,
+          cwd: untarDir,
+          filter: (path, stat) => {
+            if (path.endsWith("Resources/version.json")) {
+              versionSubpath = path;
+              return true;
+            } else {
+              return false;
+            }
+          },
+        });
+
+        const currentVersionJson = await Bun.file(
+          join(untarDir, versionSubpath)
+        ).json();
+        const nextHash = currentVersionJson.hash;
+
+        if (seenHashes.includes(nextHash)) {
+          console.log("Warning: cyclical update detected");
+          break;
+        }
+
+        seenHashes.push(nextHash);
+
+        if (!nextHash) {
+          break;
+        }
+        // Sync the patched tar file to the new hash
+        const updatedTarPath = join(
+          appDataFolder,
+          "self-extraction",
+          `${nextHash}.tar`
+        );
+        renameSync(tmpPatchedTarFilePath, updatedTarPath);
+
+        // delete the old tar file
+        unlinkSync(currentTarPath);
+        unlinkSync(patchFilePath);
+        rmdirSync(untarDir, { recursive: true });
+
+        currentHash = nextHash;
+        currentTarPath = join(
+          appDataFolder,
+          "self-extraction",
+          `${currentHash}.tar`
+        );
+        // loop through applying patches until we reach the latest version
+        // if we get stuck then exit and just download the full latest version
+      }
+
+      // If we weren't able to apply patches to the current version,
+      // then just download it and unpack it
+      if (currentHash !== latestHash) {
+        const cacheBuster = Math.random().toString(36).substring(7);
+        const urlToLatestTarball = join(
+          channelBucketUrl,
+          `${appFileName}.app.tar.zst`
+        );
+        const prevVersionCompressedTarballPath = join(
+          appDataFolder,
+          "self-extraction",
+          "latest.tar.zst"
+        );
+        const response = await fetch(urlToLatestTarball + `?${cacheBuster}`);
+
+        if (response.ok && response.body) {
+          const reader = response.body.getReader();
+
+          const writer = Bun.file(prevVersionCompressedTarballPath).writer();
+
+          while (true) {
+            const { done, value } = await reader.read();
+            if (done) break;
+            await writer.write(value);
+          }
+          await writer.flush();
+          writer.end();
+        } else {
+          console.log("latest version not found at: ", urlToLatestTarball);
+        }
+
+        await ZstdInit().then(async ({ ZstdSimple }) => {
+          const data = new Uint8Array(
+            await Bun.file(prevVersionCompressedTarballPath).arrayBuffer()
+          );
+          const uncompressedData = ZstdSimple.decompress(data);
+
+          await Bun.write(latestTarPath, uncompressedData);
+        });
+
+        unlinkSync(prevVersionCompressedTarballPath);
+        try {
+          unlinkSync(currentTarPath);
+        } catch (error) {
+          // Note: ignore the error. it may have already been deleted by the patching process
+          // if the patching process only got halfway
+        }
+      }
+    }
+
+    // Note: Bun.file().exists() caches the result, so we nee d an new instance of Bun.file() here
+    // to check again
+    if (await Bun.file(latestTarPath).exists()) {
+      // download patch for this version, apply it.
+      // check for patch from that tar and apply it, until it matches the latest version
+      // as a fallback it should just download and unpack the latest version
+      updateInfo.updateReady = true;
+    } else {
+      updateInfo.error = "Failed to download latest version";
+    }
+  },
+
+  // todo (yoav): this should emit an event so app can cleanup or block the restart
+  // todo (yoav): rename this to quitAndApplyUpdate or something
+  applyUpdate: async () => {
+    if (updateInfo?.updateReady) {
+      const appDataFolder = await Updater.appDataFolder();
+      const extractionFolder = join(appDataFolder, "self-extraction");
+      let latestHash = (await Updater.checkForUpdate()).hash;
+      const latestTarPath = join(extractionFolder, `${latestHash}.tar`);
+
+      let appBundleSubpath: string = "";
+
+      if (await Bun.file(latestTarPath).exists()) {
+        await tar.x({
+          // gzip: false,
+          file: latestTarPath,
+          cwd: extractionFolder,
+          onentry: (entry) => {
+            // find the first .app bundle in the tarball
+            // Some apps may have nested .app bundles
+            if (!appBundleSubpath && entry.path.endsWith(".app/")) {
+              appBundleSubpath = entry.path;
+            }
+          },
+        });
+
+        if (!appBundleSubpath) {
+          console.error("Failed to find app bundle in tarball");
+          return;
+        }
+
+        // Note: resolve here removes the extra trailing / that the tar file adds
+        const newAppBundlePath = resolve(
+          join(extractionFolder, appBundleSubpath)
+        );
+        // Note: dirname(process.execPath) is the path to the running app bundle's
+        // Contents/MacOS directory
+        const runningAppBundlePath = resolve(
+          dirname(process.execPath),
+          "..",
+          ".."
+        );
+        const backupAppBundlePath = join(extractionFolder, "backup.app");
+
+        try {
+          // const backupState = statSync(backupAppBundlePath);
+          if (statSync(backupAppBundlePath, { throwIfNoEntry: false })) {
+            rmdirSync(backupAppBundlePath, { recursive: true });
+          } else {
+            console.log("backupAppBundlePath does not exist");
+          }
+          renameSync(runningAppBundlePath, backupAppBundlePath);
+          renameSync(newAppBundlePath, runningAppBundlePath);
+        } catch (error) {
+          console.error("Failed to replace app with new version", error);
+          return;
+        }
+
+        await Bun.spawn(["open", runningAppBundlePath]);
+        process.exit(0);
+      }
+    }
+  },
+
+  channelBucketUrl: async () => {
+    await Updater.getLocallocalInfo();
+    // todo: tmp hardcode canary
+    return join(localInfo.bucketUrl, localInfo.channel);
+  },
+
+  appDataFolder: async () => {
+    await Updater.getLocallocalInfo();
+    const appDataFolder = join(
+      appSupportDir,
+      localInfo.identifier,
+      localInfo.name
+    );
+
+    return appDataFolder;
+  },
+
+  // TODO: consider moving this from "Updater.localInfo" to "BuildVars"
+  localInfo: {
+    version: async () => {
+      return (await Updater.getLocallocalInfo()).version;
+    },
+    hash: async () => {
+      return (await Updater.getLocallocalInfo()).hash;
+    },
+    channel: async () => {
+      return (await Updater.getLocallocalInfo()).channel;
+    },
+    bucketUrl: async () => {
+      return (await Updater.getLocallocalInfo()).bucketUrl;
+    },
+  },
+
+  getLocallocalInfo: async () => {
+    if (localInfo) {
+      return localInfo;
+    }
+
+    try {
+      localInfo = await Bun.file("../Resources/version.json").json();
+      return localInfo;
+    } catch (error) {
+      // Handle the error
+      console.error("Failed to read version.json", error);
+
+      // Then rethrow so the app crashes
+      throw error;
+    }
+  },
+};
+
+export { Updater };

package/dist/api/bun/core/Utils.ts

@@ -0,0 +1,48 @@
+import { zigRPC } from "../proc/zig";
+
+// TODO: move this to a more appropriate namespace
+export const moveToTrash = (path: string) => {
+  return zigRPC.request.moveToTrash({ path });
+};
+
+export const showItemInFolder = (path: string) => {
+  return zigRPC.request.showItemInFolder({ path });
+};
+
+export const openFileDialog = async (
+  opts: {
+    startingFolder?: string;
+    allowedFileTypes?: string;
+    canChooseFiles?: boolean;
+    canChooseDirectory?: boolean;
+    allowsMultipleSelection?: boolean;
+  } = {}
+): Promise<string[]> => {
+  const optsWithDefault = {
+    ...{
+      startingFolder: "~/",
+      allowedFileTypes: "*",
+      canChooseFiles: true,
+      canChooseDirectory: true,
+      allowsMultipleSelection: true,
+    },
+    ...opts,
+  };
+
+  // todo: extend the timeout for this one (this version of rpc-anywhere doesn't seem to be able to set custom timeouts per request)
+  // we really want it to be infinity since the open file dialog blocks everything anyway.
+  // todo: there's the timeout between bun and zig, and the timeout between browser and bun since user likely requests
+  // from a browser context
+  const result = await zigRPC.request.openFileDialog({
+    startingFolder: optsWithDefault.startingFolder,
+    allowedFileTypes: optsWithDefault.allowedFileTypes,
+    canChooseFiles: optsWithDefault.canChooseFiles,
+    canChooseDirectory: optsWithDefault.canChooseDirectory,
+    allowsMultipleSelection: optsWithDefault.allowsMultipleSelection,
+  });
+
+  const filePaths = result.openFileDialogResponse.split(",");
+
+  // todo: it's nested like this due to zig union types. needs a zig refactor and revisit
+  return filePaths;
+};

package/dist/api/bun/events/ApplicationEvents.ts

@@ -0,0 +1,14 @@
+import ElectrobunEvent from "./event";
+
+export default {
+  applicationMenuClicked: (data) =>
+    new ElectrobunEvent<{ id: number; action: string }, { allow: boolean }>(
+      "application-menu-clicked",
+      data
+    ),
+  contextMenuClicked: (data) =>
+    new ElectrobunEvent<{ id: number; action: string }, { allow: boolean }>(
+      "context-menu-clicked",
+      data
+    ),
+};

package/dist/api/bun/events/event.ts

@@ -0,0 +1,29 @@
+export default class ElectrobunEvent<DataType, ResponseType> {
+    // todo (yoav): make most of these readonly except for response
+    name: string;
+    data: DataType;
+    // todo (yoav): define getters and setters for response
+    _response: ResponseType | undefined;
+    responseWasSet: boolean = false;
+
+    constructor(name: string, data: DataType) {
+        this.name = name;
+        this.data = data;
+    }
+
+      // Getter for response
+      get response(): ResponseType | undefined {
+        return this._response;
+    }
+
+    // Setter for response
+    set response(value: ResponseType) {
+        this._response = value;
+        this.responseWasSet = true; // Update flag when response is set
+    }
+
+    clearResponse() {
+        this._response = undefined;
+        this.responseWasSet = false;
+    }
+}

package/dist/api/bun/events/eventEmitter.ts

@@ -0,0 +1,45 @@
+import EventEmitter from "events";
+import windowEvents from "./windowEvents";
+import webviewEvents from "./webviewEvents";
+import trayEvents from "./trayEvents";
+import applicationEvents from "./applicationEvents";
+import ElectrobunEvent from "./event";
+
+class ElectrobunEventEmitter extends EventEmitter {
+  constructor() {
+    super();
+  }
+
+  // optionally pass in a specifier to make the event name specific.
+  // eg: will-navigate is listened to globally for all webviews, but
+  // will-navigate-1 is listened to for a specific webview with id 1
+  emitEvent(
+    ElectrobunEvent: ElectrobunEvent<any, any>,
+    specifier?: number | string
+  ) {
+    if (specifier) {
+      this.emit(`${ElectrobunEvent.name}-${specifier}`, ElectrobunEvent);
+    } else {
+      this.emit(ElectrobunEvent.name, ElectrobunEvent);
+    }
+  }
+
+  events = {
+    window: {
+      ...windowEvents,
+    },
+    webview: {
+      ...webviewEvents,
+    },
+    tray: {
+      ...trayEvents,
+    },
+    app: {
+      ...applicationEvents,
+    },
+  };
+}
+
+export const electrobunEventEmitter = new ElectrobunEventEmitter();
+
+export default electrobunEventEmitter;

package/dist/api/bun/events/trayEvents.ts

@@ -0,0 +1,9 @@
+import ElectrobunEvent from "./event";
+
+export default {
+  trayClicked: (data) =>
+    new ElectrobunEvent<{ id: number; action: string }, { allow: boolean }>(
+      "tray-clicked",
+      data
+    ),
+};

package/dist/api/bun/events/webviewEvents.ts

@@ -0,0 +1,19 @@
+import ElectrobunEvent from "./event";
+
+export default {
+  willNavigate: (data) =>
+    new ElectrobunEvent<{ url: string; windowId: number }, { allow: boolean }>(
+      "will-navigate",
+      data
+    ),
+  didNavigate: (data) =>
+    new ElectrobunEvent<{ detail: string }, {}>("did-navigate", data),
+  didNavigateInPage: (data) =>
+    new ElectrobunEvent<{ detail: string }, {}>("did-navigate-in-page", data),
+  didCommitNavigation: (data) =>
+    new ElectrobunEvent<{ detail: string }, {}>("did-commit-navigation", data),
+  domReady: (data) =>
+    new ElectrobunEvent<{ detail: string }, {}>("dom-ready", data),
+  newWindowOpen: (data) =>
+    new ElectrobunEvent<{ detail: string }, {}>("new-window-open", data),
+};

package/dist/api/bun/events/windowEvents.ts

@@ -0,0 +1,12 @@
+import ElectrobunEvent from "./event";
+
+export default {
+  close: (data) => new ElectrobunEvent<{ id: number }, {}>("close", data),
+  resize: (data) =>
+    new ElectrobunEvent<
+      { id: number; x: number; y: number; width: number; height: number },
+      {}
+    >("resize", data),
+  move: (data) =>
+    new ElectrobunEvent<{ id: number; x: number; y: number }, {}>("move", data),
+};