Make zip builds more portable (python & ffmpeg) (#1484)

* Add portable file to zips * Use portable file to determine if chaiNNer should save to local dir or not * Fix mistake * Move code * remove log
chaiNNer-org · Jan 14, 2023 · 5db44cc · 5db44cc
1 parent 20485fc
commit 5db44cc
Show file tree

Hide file tree

Showing 6 changed files with 162 additions and 104 deletions.
diff --git a/forge.config.js b/forge.config.js
@@ -0,0 +1,102 @@
+const AdmZip = require('adm-zip');
+
+module.exports = {
+    packagerConfig: {
+        executableName: 'chainner',
+        extraResource: './backend/src/',
+        icon: './src/public/icons/cross_platform/icon',
+    },
+    publishers: [
+        {
+            name: '@electron-forge/publisher-github',
+            config: {
+                repository: {
+                    owner: 'chaiNNer-org',
+                    name: 'chaiNNer',
+                },
+            },
+            draft: true,
+            prerelease: true,
+        },
+    ],
+    makers: [
+        {
+            name: '@electron-forge/maker-squirrel',
+            config: {
+                name: 'chainner',
+                iconUrl:
+                    'https://github.com/chaiNNer-org/chaiNNer/blob/main/src/public/icons/win/icon.ico',
+                setupIcon: './src/public/icons/win/icon.ico',
+                loadingGif: './src/public/icons/win/installing_loop.gif',
+            },
+        },
+        {
+            name: '@electron-forge/maker-zip',
+            platforms: ['darwin', 'linux', 'win32'],
+        },
+        {
+            name: '@electron-forge/maker-dmg',
+            config: {
+                format: 'ULFO',
+                name: 'chaiNNer',
+                icon: './src/public/icons/mac/icon.icns',
+            },
+        },
+        {
+            name: '@electron-forge/maker-deb',
+            config: {
+                name: 'chainner',
+                options: {
+                    icon: './src/public/icons/cross_platform/icon.png',
+                },
+            },
+        },
+        {
+            name: '@electron-forge/maker-rpm',
+            config: {
+                name: 'chainner',
+                options: {
+                    icon: './src/public/icons/cross_platform/icon.png',
+                },
+            },
+        },
+    ],
+    plugins: [
+        {
+            name: '@electron-forge/plugin-webpack',
+            config: {
+                mainConfig: './webpack.main.config.js',
+                renderer: {
+                    config: './webpack.renderer.config.js',
+                    nodeIntegration: true,
+                    contextIsolation: false,
+                    entryPoints: [
+                        {
+                            html: './src/renderer/index.html',
+                            js: './src/renderer/renderer.js',
+                            name: 'main_window',
+                        },
+                        {
+                            html: './src/renderer/splash.html',
+                            js: './src/renderer/splash_renderer.js',
+                            name: 'splash_screen',
+                        },
+                    ],
+                },
+                devContentSecurityPolicy: '',
+            },
+        },
+    ],
+    hooks: {
+        postMake: async (forgeConfig, makeResults) => {
+            const justArtifacts = makeResults.map((m) => m.artifacts).reduce((a, b) => a.concat(b));
+            const zipArtifact = justArtifacts.find((a) => a.endsWith('.zip'));
+            if (zipArtifact) {
+                // Add an empty `portable` file to the zip
+                const zip = new AdmZip(zipArtifact);
+                zip.addFile('portable', Buffer.alloc(0));
+                zip.writeZip(zipArtifact);
+            }
+        },
+    },
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -33,99 +33,6 @@
     "npm": ">=7.0.0"
   },
   "license": "GPLv3",
-  "config": {
-    "forge": {
-      "packagerConfig": {
-        "executableName": "chainner",
-        "extraResource": "./backend/src/",
-        "icon": "./src/public/icons/cross_platform/icon"
-      },
-      "publishers": [
-        {
-          "name": "@electron-forge/publisher-github",
-          "config": {
-            "repository": {
-              "owner": "joeyballentine",
-              "name": "chaiNNer"
-            }
-          },
-          "draft": true,
-          "prerelease": true
-        }
-      ],
-      "makers": [
-        {
-          "name": "@electron-forge/maker-squirrel",
-          "config": {
-            "name": "chainner",
-            "iconUrl": "https://github.com/chaiNNer-org/chaiNNer/blob/main/src/public/icons/win/icon.ico",
-            "setupIcon": "./src/public/icons/win/icon.ico",
-            "loadingGif": "./src/public/icons/win/installing_loop.gif"
-          }
-        },
-        {
-          "name": "@electron-forge/maker-zip",
-          "platforms": [
-            "darwin",
-            "linux",
-            "win32"
-          ]
-        },
-        {
-          "name": "@electron-forge/maker-dmg",
-          "config": {
-            "format": "ULFO",
-            "name": "chaiNNer",
-            "icon": "./src/public/icons/mac/icon.icns"
-          }
-        },
-        {
-          "name": "@electron-forge/maker-deb",
-          "config": {
-            "name": "chainner",
-            "options": {
-              "icon": "./src/public/icons/cross_platform/icon.png"
-            }
-          }
-        },
-        {
-          "name": "@electron-forge/maker-rpm",
-          "config": {
-            "name": "chainner",
-            "options": {
-              "icon": "./src/public/icons/cross_platform/icon.png"
-            }
-          }
-        }
-      ],
-      "plugins": [
-        {
-          "name": "@electron-forge/plugin-webpack",
-          "config": {
-            "mainConfig": "./webpack.main.config.js",
-            "renderer": {
-              "config": "./webpack.renderer.config.js",
-              "nodeIntegration": true,
-              "contextIsolation": false,
-              "entryPoints": [
-                {
-                  "html": "./src/renderer/index.html",
-                  "js": "./src/renderer/renderer.js",
-                  "name": "main_window"
-                },
-                {
-                  "html": "./src/renderer/splash.html",
-                  "js": "./src/renderer/splash_renderer.js",
-                  "name": "splash_screen"
-                }
-              ]
-            },
-            "devContentSecurityPolicy": ""
-          }
-        }
-      ]
-    }
-  },
   "devDependencies": {
     "@babel/core": "^7.18.2",
     "@babel/preset-react": "^7.17.12",
@@ -200,6 +107,7 @@
     "@emotion/styled": "^11.8.1",
     "@fontsource/open-sans": "^4.5.10",
     "@react-nano/use-event-source": "^0.12.0",
+    "adm-zip": "^0.5.10",
     "bezier-js": "^6.1.0",
     "cross-fetch": "^3.1.5",
     "decompress": "^4.2.1",

diff --git a/src/main/backend/setup.ts b/src/main/backend/setup.ts
@@ -1,4 +1,3 @@
-import { app } from 'electron';
 import log from 'electron-log';
 import { t } from 'i18next';
 import path from 'path';
@@ -39,13 +38,14 @@ const getValidPort = async () => {
 const getPythonInfo = async (
     token: ProgressToken,
     useSystemPython: boolean,
-    systemPythonLocation: string | undefined | null
+    systemPythonLocation: string | undefined | null,
+    rootDir: string
 ) => {
     log.info('Attempting to check Python env...');
 
     let pythonInfo: PythonInfo;
 
-    let integratedPythonFolderPath = path.join(app.getPath('userData'), '/python');
+    let integratedPythonFolderPath = path.join(rootDir, '/python');
 
     if (systemPythonLocation) {
         // eslint-disable-next-line no-param-reassign
@@ -131,12 +131,12 @@ const getPythonInfo = async (
     return pythonInfo;
 };
 
-const getFfmpegInfo = async (token: ProgressToken) => {
+const getFfmpegInfo = async (token: ProgressToken, rootDir: string) => {
     log.info('Attempting to check Ffmpeg env...');
 
     let ffmpegInfo: FfmpegInfo;
 
-    const integratedFfmpegFolderPath = path.join(app.getPath('userData'), '/ffmpeg');
+    const integratedFfmpegFolderPath = path.join(rootDir, '/ffmpeg');
 
     try {
         ffmpegInfo = await getIntegratedFfmpeg(integratedFfmpegFolderPath, (percentage, stage) => {
@@ -259,25 +259,28 @@ const setupOwnedBackend = async (
     token: ProgressToken,
     useSystemPython: boolean,
     systemPythonLocation: string | undefined | null,
-    hasNvidia: () => Promise<boolean>
+    hasNvidia: () => Promise<boolean>,
+    getRootDir: () => Promise<string>
 ): Promise<OwnedBackendProcess> => {
     token.submitProgress({
         status: t('splash.checkingPort', 'Checking for available port...'),
         totalProgress: 0.1,
     });
     const port = await getValidPort();
 
+    const rootDir = await getRootDir();
+
     token.submitProgress({
         status: t('splash.checkingPython', 'Checking system environment for valid Python...'),
         totalProgress: 0.2,
     });
-    const pythonInfo = await getPythonInfo(token, useSystemPython, systemPythonLocation);
+    const pythonInfo = await getPythonInfo(token, useSystemPython, systemPythonLocation, rootDir);
 
     token.submitProgress({
         status: t('splash.checkingFfmpeg', 'Checking system environment for Ffmpeg...'),
         totalProgress: 0.5,
     });
-    const ffmpegInfo = await getFfmpegInfo(token);
+    const ffmpegInfo = await getFfmpegInfo(token, rootDir);
 
     token.submitProgress({
         status: t('splash.checkingDeps', 'Checking dependencies...'),
@@ -309,13 +312,20 @@ export const setupBackend = async (
     token: ProgressToken,
     useSystemPython: boolean,
     systemPythonLocation: string | undefined | null,
-    hasNvidia: () => Promise<boolean>
+    hasNvidia: () => Promise<boolean>,
+    getRootDir: () => Promise<string>
 ): Promise<BackendProcess> => {
     token.submitProgress({ totalProgress: 0 });
 
     const backend = getArguments().noBackend
         ? await setupBorrowedBackend(token, 8000)
-        : await setupOwnedBackend(token, useSystemPython, systemPythonLocation, hasNvidia);
+        : await setupOwnedBackend(
+              token,
+              useSystemPython,
+              systemPythonLocation,
+              hasNvidia,
+              getRootDir
+          );
 
     token.submitProgress({ totalProgress: 1 });
     return backend;

diff --git a/src/main/main.ts b/src/main/main.ts
@@ -20,6 +20,7 @@ import { BackendProcess } from './backend/process';
 import { setupBackend } from './backend/setup';
 import { MenuData, setMainMenu } from './menu';
 import { createNvidiaSmiVRamChecker, getNvidiaGpuNames, getNvidiaSmi } from './nvidiaSmi';
+import { getRootDir } from './platform';
 import { addSplashScreen } from './splash';
 import { getGpuInfo } from './systemInfo';
 import { hasUpdate } from './update';
@@ -273,12 +274,19 @@ const checkNvidiaSmi = async () => {
 };
 
 const nvidiaSmiPromise = checkNvidiaSmi();
+const getRootDirPromise = getRootDir();
 
 const createBackend = async (token: ProgressToken) => {
     const useSystemPython = localStorage.getItem('use-system-python') === 'true';
     const systemPythonLocation = localStorage.getItem('system-python-location');
 
-    return setupBackend(token, useSystemPython, systemPythonLocation, () => nvidiaSmiPromise);
+    return setupBackend(
+        token,
+        useSystemPython,
+        systemPythonLocation,
+        () => nvidiaSmiPromise,
+        () => getRootDirPromise
+    );
 };
 
 const createWindow = lazy(async () => {

diff --git a/src/main/platform.ts b/src/main/platform.ts
@@ -1,4 +1,7 @@
+import { app } from 'electron';
 import os from 'os';
+import path from 'path';
+import { checkFileExists } from '../common/util';
 
 export type SupportedPlatform = 'linux' | 'darwin' | 'win32';
 
@@ -15,3 +18,16 @@ export const getPlatform = (): SupportedPlatform => {
             );
     }
 };
+
+export const currentExecutableDir = path.dirname(app.getPath('exe'));
+
+export const getIsPortable = async (): Promise<boolean> => {
+    const isPortable = await checkFileExists(path.join(currentExecutableDir, 'portable'));
+    return isPortable;
+};
+
+export const getRootDir = async (): Promise<string> => {
+    const isPortable = await getIsPortable();
+    const rootDir = isPortable ? currentExecutableDir : app.getPath('userData');
+    return rootDir;
+};