chore: adding metrics, storage assetsURL, zoom window with electron support

Author: abose

src/extensionsIntegrated/appUpdater/main.js

@@ -517,10 +517,11 @@ define(function (require, exports, module) {
 
     let updateInstalledDialogShown = false, updateFailedDialogShown = false;
     AppInit.appReady(function () {
-        if(!Phoenix.isNativeApp || Phoenix.isTestWindow) {
+        if(!window.__TAURI__ || Phoenix.isTestWindow) {
             // app updates are only for desktop builds
             return;
         }
+        // todo electron edge for app updater
         if (brackets.platform === "mac") {
             // in mac, the `update.app.tar.gz` is downloaded, and only extracted on app quit.
             // we do this only in mac as the `.app` file is extracted only at app quit and deleted

src/phoenix/init_vfs.js

@@ -48,7 +48,13 @@ function _getNativeAssetUrl(fullFilePath) {
         }
         return null;
     }
-    // todo electron
+    if(window.__ELECTRON__) {
+        if(fullFilePath.startsWith(tauriAssetServeDir)){
+            const platformPath = fs.getTauriPlatformPath(fullFilePath);
+            return window.electronAPI.convertToAssetURL(platformPath);
+        }
+        return null;
+    }
     return null;
 }
 

src/phoenix/shell.js

@@ -537,7 +537,12 @@ Phoenix.app = {
         if(scaleFactor < .1 || scaleFactor > 2) {
             throw new Error("zoomWebView scale factor should be between .1 and 2");
         }
-        return window.__TAURI__.tauri.invoke("zoom_window", {scaleFactor: scaleFactor});
+        if(window.__TAURI__) {
+            return window.__TAURI__.tauri.invoke("zoom_window", {scaleFactor: scaleFactor});
+        }
+        if(window.__ELECTRON__) {
+            return window.electronAPI.zoomWindow(scaleFactor);
+        }
     },
     _openUrlInBrowserWin: function (url, browser) {
         // private API for internal use only. May be removed at any time.

src/storage.js

@@ -206,10 +206,14 @@ import {set, entries, createStore} from './thirdparty/idb-keyval.js';
                 storageNodeConnector
                     .execPeer("putItem", {key, value: valueToStore})
                     .catch(_reportPutItemError);
-                // this is an in-memory tauri store that takes care of multi window case, since we have a single
-                // instance, all windows share this and can reconstruct the full view from the dumb file + this map
-                // when the editor boots up instead of having to write the dump file frequently.
-                window.__TAURI__.invoke('put_item', { key, value: JSON.stringify(valueToStore) });
+                // this is an in-memory tauri/electron store that takes care of multi window case, since we have a
+                // single instance, all windows share this and can reconstruct the full view from the dump file + this
+                // map when the editor boots up instead of having to write the dump file frequently.
+                if(window.__TAURI__) {
+                    window.__TAURI__.invoke('put_item', { key, value: JSON.stringify(valueToStore) });
+                } else if(window.__ELECTRON__) {
+                    window.electronAPI.putItem(key, JSON.stringify(valueToStore));
+                }
             }
             if(window.debugMode || isBrowser) {
                 // in debug mode, we write to browser storage in tauri and browser builds for eazy debug of storage.
@@ -291,13 +295,18 @@ import {set, entries, createStore} from './thirdparty/idb-keyval.js';
             return;
         }
         if(isDesktop){
-            async function mergeTauriInMemoryStorage() {
-                // The tauri storeage is mainly used in multi window case, where if there are 2+ windows, each window
-                // is till live and has not commited the dump file to disc(they only do that on exit or 30 every secs).
+            async function mergeNativeInMemoryStorage() {
+                // The native storage is mainly used in multi window case, where if there are 2+ windows, each window
+                // is still live and has not committed the dump file to disc (they only do that on exit or every 30 secs).
                 // so the dump file may be stale after window._tauriStorageRestorePromise in the case.
-                // we merge the local memory cache maintained at tauri rust side to address this.
+                // we merge the local memory cache maintained at tauri/electron side to address this.
                 try {
-                    const map = await window.__TAURI__.invoke('get_all_items') || {};
+                    let map = {};
+                    if(window.__TAURI__) {
+                        map = await window.__TAURI__.invoke('get_all_items') || {};
+                    } else if(window.__ELECTRON__) {
+                        map = await window.electronAPI.getAllItems() || {};
+                    }
                     for(const key of Object.keys(map)){
                         cache[key] = JSON.parse(map[key]);
                     }
@@ -317,7 +326,7 @@ import {set, entries, createStore} from './thirdparty/idb-keyval.js';
                     }
                 })
                 .catch(console.error)
-                .finally(mergeTauriInMemoryStorage);
+                .finally(mergeNativeInMemoryStorage);
             return;
         }
         // Use browser default storage- IndexedDB
@@ -342,8 +351,10 @@ import {set, entries, createStore} from './thirdparty/idb-keyval.js';
             // do things to do that are critical to user experience here
             // We try to set window zoom as early as possible to prevent zoom flicker
             const zoomFactor = PhStore.getItem(_PHSTORE_BOOT_DESKTOP_ZOOM_SCALE_KEY) || 1;
-            if(Phoenix.isNativeApp){
+            if(window.__TAURI__){
                 window.__TAURI__.tauri.invoke("zoom_window", {scaleFactor: zoomFactor});
+            } else if(window.__ELECTRON__) {
+                window.electronAPI.zoomWindow(zoomFactor);
             }
         });
     /**

src/utils/Metrics.js

@@ -194,6 +194,17 @@ define(function (require, exports, module) {
         });
     }
 
+    function _sendNativeGAEvent(analyticsID, customUserID, events=[]) {
+        if(window.__TAURI__){
+            return _sendTauriGAEvent(analyticsID, customUserID, events=[]);
+        }
+        if(window.__ELECTRON__){
+            // todo electron send event to metrics window with electron
+            return;
+        }
+        console.error("Metrics send event failed. Unknown native platform");
+    }
+
     let tauriGAEvents = new Map();
 
     function _sendGaEvent(eventAct, category, label, count) {
@@ -216,7 +227,7 @@ define(function (require, exports, module) {
 
     const TAURI_GA_EVENT_QUEUE_INTERVAL = 3000;
     function _sendQueuedTauriGAEvents() {
-        _sendTauriGAEvent(brackets.config.googleAnalyticsIDDesktop, userID, Array.from(tauriGAEvents.values()));
+        _sendNativeGAEvent(brackets.config.googleAnalyticsIDDesktop, userID, Array.from(tauriGAEvents.values()));
         tauriGAEvents.clear();
     }
 
@@ -227,7 +238,7 @@ define(function (require, exports, module) {
             // https urls and not the tauri custom protocol urls. So we have a hidden window that loads ga from a
             // http(s) page which is usually `https://phcode.dev/desktop-metrics.html` or
             // "http://localhost:8000/src/metrics.html" for live dev builds in tauri.
-            _sendTauriGAEvent(brackets.config.googleAnalyticsIDDesktop, userID);
+            _sendNativeGAEvent(brackets.config.googleAnalyticsIDDesktop, userID);
             setInterval(_sendQueuedTauriGAEvents, TAURI_GA_EVENT_QUEUE_INTERVAL);
             return;
         }