fix: Electron example build (#228)

* fix: Electron example build
* refactor: rename `llamaBins` to `bins`

Author: giladgd

.github/workflows/build.yml

@@ -193,7 +193,7 @@ jobs:
             throw new Error("Could not find node versions");
           }
           
-          await $`mkdir -p llamaBins`;
+          await $`mkdir -p bins`;
           
           async function buildBinary(arch, flags = [], nodeTarget = nodeVersion) {
             console.log(`Building ${arch} for node ${nodeTarget} with flags`, flags);
@@ -218,9 +218,9 @@ jobs:
             await buildBinary("x64", ["--gpu", "false"]);
           }
           
-          // move binaries to llamaBins
+          // move binaries to bins
           const localBuildsDirectoryPath = path.join(process.cwd(), "llama", "localBuilds");
-          const llamaBinsDirectoryPath = path.join(process.cwd(), "llamaBins");
+          const llamaBinsDirectoryPath = path.join(process.cwd(), "bins");
           for (const folderName of await fs.readdir(localBuildsDirectoryPath)) {
             await fs.move(
               path.join(localBuildsDirectoryPath, folderName, "Release"),
@@ -229,15 +229,15 @@ jobs:
           }
           
           await $`echo "Built binaries:"`;
-          await $`ls llamaBins`;
+          await $`ls bins`;
           
           EOF
 
       - name: Publish artifact
         uses: actions/upload-artifact@v4
         with:
           name: "bins-${{ matrix.config.artifact }}"
-          path: "llamaBins/*"
+          path: "bins/*"
 
   standalone-tests:
     name: Standalone tests
@@ -359,8 +359,8 @@ jobs:
           path: artifacts
       - name: Move artifacts
         run: |
-          mkdir -p llamaBins
-          mv artifacts/bins-*/* llamaBins/
+          mkdir -p bins
+          mv artifacts/bins-*/* bins/
           mv artifacts/build dist/
           
           cp -r artifacts/llama.cpp/llama.cpp/grammars llama/grammars
@@ -379,7 +379,7 @@ jobs:
           rm -f ./templates/package-lock.json
           
           echo "Built binaries:"
-          ls llamaBins
+          ls bins
       - name: Add "postinstall" script to package.json
         run: npm run addPostinstallScript
       - name: Release
@@ -475,8 +475,10 @@ jobs:
         run: npm ci
 
       - name: Create Electron app project
+        shell: bash
         env:
           DEPLOYED_PACKAGE_VERSION: ${{ needs.release.outputs.package-version }}
+          NODE_LLAMA_CPP_SKIP_DOWNLOAD: true
         run: |
           npx --no vite-node ./scripts/scaffoldElectronExampleForCiBuild.ts --packageVersion "$DEPLOYED_PACKAGE_VERSION" --packageFolderPath ./electron-app-example
           cd electron-app-example
@@ -491,10 +493,15 @@ jobs:
           npm run build
           ls ./release
 
-      - name: Add builds to current release
-        uses: svenstaro/upload-release-action@v2
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
         with:
-          file: "electron-app-example/release/*.{dmg,zip,exe,appx,AppImage,snap,deb,tar.gz}"
-          file_glob: true
-          tag: ${{ needs.release.outputs.package-version }}
-          make_latest: false
+          name: "electron-app-example-${{ matrix.config.name }}"
+          path: "./electron-app-example/release"
+
+      - name: Add builds to current release
+        shell: bash
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload "${{ needs.release.outputs.package-version }}" ./electron-app-example/release/*.{dmg,zip,exe,appx,AppImage,snap,deb,tar.gz}

.gitignore

@@ -31,4 +31,4 @@ node_modules
 /llama/xpack/store
 /llama/xpack/xpacks
 /llama/xpack/cmakeInstall.lock
-/llamaBins
+/bins

package.json

@@ -12,7 +12,7 @@
     "dist/",
     "templates/packed/",
     "llama/",
-    "llamaBins/",
+    "bins/",
     "package.json",
     "README.md",
     "LICENSE"

scripts/scaffoldElectronExampleForCiBuild.ts

@@ -25,6 +25,8 @@ const {packageVersion, packageFolderPath} = argv;
 if (packageVersion === "")
     throw new Error("packageVersion is empty");
 
+console.info("node-llama-cpp version:", packageVersion);
+
 const resolvedPackageFolderPath = path.resolve(process.cwd(), packageFolderPath);
 
 const templateFilePath = path.join(packedProjectTemplatesDirectory, `${electronTemplateName}.json`);

src/config.ts

@@ -16,7 +16,7 @@ const env = envVar.from(process.env);
 
 export const llamaDirectory = path.join(__dirname, "..", "llama");
 export const llamaToolchainsDirectory = path.join(llamaDirectory, "toolchains");
-export const llamaPrebuiltBinsDirectory = path.join(__dirname, "..", "llamaBins");
+export const llamaPrebuiltBinsDirectory = path.join(__dirname, "..", "bins");
 export const llamaLocalBuildBinsDirectory = path.join(llamaDirectory, "localBuilds");
 export const llamaBinsGrammarsDirectory = path.join(__dirname, "..", "llama", "grammars");
 export const projectTemplatesDirectory = path.join(__dirname, "..", "templates");

templates/electron-typescript-react/electron-builder.json5

@@ -0,0 +1,115 @@
+import path from "node:path";
+import {$} from "zx";
+import type {Configuration} from "electron-builder";
+
+/**
+ * @see - https://www.electron.build/configuration/configuration
+ */
+export default {
+    appId: "node-llama-cpp.electron.example",
+    asar: true,
+    productName: "node-llama-cpp Electron example",
+    executableName: "node-llama-cpp-electron-example",
+    directories: {
+        output: "release"
+    },
+
+    // remove this once you set up your own code signing for macOS
+    async afterSign(context) {
+        if (context.electronPlatformName === "darwin") {
+            // check whether the app was already signed
+            const appPath = path.join(context.appOutDir, `${context.packager.appInfo.productFilename}.app`);
+
+            // this is needed for the app to not appear as "damaged" on Apple Silicon Macs
+            // https://github.com/electron-userland/electron-builder/issues/5850#issuecomment-1821648559
+            await $`codesign --force --deep --sign - ${appPath}`;
+        }
+    },
+    files: [
+        "dist",
+        "dist-electron",
+        "!node_modules/node-llama-cpp/bins/*",
+        "node_modules/node-llama-cpp/bins/${os}-${arch}*/**/*",
+        "!node_modules/node-llama-cpp/llama/localBuilds/*",
+        "node_modules/node-llama-cpp/llama/localBuilds/${os}-${arch}*/**/*"
+    ],
+    asarUnpack: [
+        "node_modules/node-llama-cpp/bins",
+        "node_modules/node-llama-cpp/llama/localBuilds"
+    ],
+    mac: {
+        target: [{
+            target: "dmg",
+            arch: [
+                "arm64",
+                "x64"
+            ]
+        }, {
+            target: "zip",
+            arch: [
+                "arm64",
+                "x64"
+            ]
+        }],
+
+        artifactName: "${name}.macOS.${version}.${arch}.${ext}"
+    },
+    win: {
+        target: [
+            {
+                target: "nsis",
+                arch: [
+                    "x64",
+                    "arm64"
+                ]
+            },
+            {
+                target: "appx",
+                arch: [
+                    "x64",
+                    "arm64"
+                ]
+            }
+        ],
+
+        artifactName: "${name}.Windows.${version}.${arch}.${ext}"
+    },
+    appx: {
+        artifactName: "${name}.Windows.${version}.${arch}.${ext}"
+    },
+    nsis: {
+        oneClick: true,
+        perMachine: false,
+        allowToChangeInstallationDirectory: false,
+        deleteAppDataOnUninstall: true
+    },
+    linux: {
+        target: [{
+            target: "AppImage",
+            arch: [
+                "x64",
+                "arm64"
+            ]
+        }, {
+            target: "snap",
+            arch: [
+                "x64",
+                "arm64"
+            ]
+        }, {
+            target: "deb",
+            arch: [
+                "x64",
+                "arm64"
+            ]
+        }, {
+            target: "tar.gz",
+            arch: [
+                "x64",
+                "arm64"
+            ]
+        }],
+
+        artifactName: "${name}.Linux.${version}.${arch}.${ext}"
+    }
+} as Configuration;

templates/electron-typescript-react/electron-builder.ts

@@ -10,7 +10,7 @@
     "start": "vite dev",
     "start:build": "electron ./dist-electron",
     "prebuild": "rimraf ./dist ./dist-electron ./release",
-    "build": "tsc && vite build && electron-builder",
+    "build": "tsc && vite build && electron-builder --config ./electron-builder.ts",
     "lint": "npm run lint:eslint",
     "lint:eslint": "eslint --ext .js --ext .ts --report-unused-disable-directives .",
     "format": "npm run lint:eslint -- --fix",
@@ -41,6 +41,7 @@
     "typescript": "^5.4.5",
     "vite": "^5.2.13",
     "vite-plugin-electron": "^0.28.7",
-    "vite-plugin-electron-renderer": "^0.14.5"
+    "vite-plugin-electron-renderer": "^0.14.5",
+    "zx": "^8.1.2"
   }
 }