fix: single executable binary across platforms

Author: louis-jan

.github/workflows/cortex-cpp-build.yml

@@ -205,7 +205,7 @@ jobs:
           p12-file-base64: ${{ secrets.CODE_SIGN_P12_BASE64 }}
           p12-password: ${{ secrets.CODE_SIGN_P12_PASSWORD }}
 
-      - name: Build Cortex CPP
+      - name: Build
         run: |
           cd cortex-cpp
           make build CMAKE_EXTRA_FLAGS="${{ matrix.cmake-flags }}"
@@ -221,36 +221,6 @@ jobs:
           cd cortex-cpp
           make codesign CODE_SIGN=true DEVELOPER_ID="${{ secrets.DEVELOPER_ID }}"
 
-      # Cortex-JS Build
-      - name: "Update version by tag"
-        run: |
-          cd cortex-js
-          # Remove the v prefix
-          tag_version=${GITHUB_REF#refs/tags/v}
-          # Remove the -cortex-js suffix
-          new_version=${tag_version%-cortex-js}
-
-          # Replace the old version with the new version in package.json
-          jq --arg version "$new_version" '.version = $version' ./package.json > /tmp/package.json && mv /tmp/package.json ./package.json
-
-          # Print the new version
-          echo "Updated package.json version to: $new_version"
-
-      # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "20.x"
-          registry-url: "https://registry.npmjs.org"
-
-      - run: yarn install && yarn build:binary
-        working-directory: ./cortex-js
-
-      - name: Code Signing macOS
-        if: runner.os == 'macOS'
-        run: |
-          cd cortex-js/dist
-          make codesign CODE_SIGN=true DEVELOPER_ID="${{ secrets.DEVELOPER_ID }}"
-
       - uses: nick-fields/retry@v3
         with:
           continue_on_error: true
@@ -276,18 +246,12 @@ jobs:
           cd cortex-cpp
           make run-e2e-test RUN_TESTS=true LLM_MODEL_URL=${{ env.LLM_MODEL_URL }} EMBEDDING_MODEL_URL=${{ env.EMBEDDING_MODEL_URL }}
 
-      - name: Upload CPP Artifact
+      - name: Upload Artifact
         uses: actions/upload-artifact@v2
         with:
           name: cortex-cpp-${{ matrix.os }}-${{ matrix.name }}
           path: ./cortex-cpp/cortex-cpp
 
-      - name: Upload JS Artifact
-        uses: actions/upload-artifact@v2
-        with:
-          name: cortex-${{ matrix.os }}-${{ matrix.name }}
-          path: ./cortex-js/dist/cortex
-
       - uses: actions/upload-release-asset@v1.0.1
         if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
         env:

.github/workflows/cortex-js-artifact.yml

@@ -0,0 +1,90 @@
+name: CI Cortex JS
+
+on:
+  push:
+    branches:
+      - chore/update-ci-for-cortex-artifact
+  workflow_dispatch:
+
+jobs:
+  build-cortex-single-binary:
+    runs-on: ${{ matrix.runs-on }}
+    needs: []
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: "linux"
+            name: "amd64"
+            runs-on: "ubuntu-20-04"
+
+          - os: "windows"
+            name: "amd64"
+            runs-on: "windows-cuda-12-0"
+
+          - os: "mac"
+            name: "amd64"
+            runs-on: "macos-13"
+
+          - os: "mac"
+            name: "arm64"
+            runs-on: "macos-latest"
+    steps:
+      - name: Clone
+        id: checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-dotnet@v3
+        if: runner.os == 'Windows'
+        with:
+          dotnet-version: "8.0.x"
+
+      - name: Install choco on Windows
+        if: runner.os == 'Windows'
+        run: |
+          choco install make -y
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org"
+      
+      - run: npm install -g yarn
+        
+      - run: yarn install && yarn build && yarn build:binary
+        working-directory: ./cortex-js
+
+      - name: Get Cer for code signing
+        if: runner.os == 'macOS'
+        run: base64 -d <<< "$CODE_SIGN_P12_BASE64" > /tmp/codesign.p12
+        shell: bash
+        env:
+          CODE_SIGN_P12_BASE64: ${{ secrets.CODE_SIGN_P12_BASE64 }}
+
+      - uses: apple-actions/import-codesign-certs@v2
+        if: runner.os == 'macOS'
+        with:
+          p12-file-base64: ${{ secrets.CODE_SIGN_P12_BASE64 }}
+          p12-password: ${{ secrets.CODE_SIGN_P12_PASSWORD }}
+
+      - name: Code Signing macOS
+        if: runner.os == 'macOS'
+        run: |
+          cd cortex-js
+          make codesign CODE_SIGN=true DEVELOPER_ID="${{ secrets.DEVELOPER_ID }}"
+
+      - name: Post-Bundle
+        run: |
+          cd cortex-js
+          make postbundle
+          
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: cortex-${{ matrix.os }}-${{ matrix.name }}
+          path: |
+            ./cortex-js/cortex
+            ./cortex-js/cortex.exe

cortex-js/Makefile

@@ -0,0 +1,35 @@
+CODE_SIGN ?= false
+AZURE_KEY_VAULT_URI ?= xxxx
+AZURE_CLIENT_ID ?= xxxx
+AZURE_TENANT_ID ?= xxxx
+AZURE_CLIENT_SECRET ?= xxxx
+AZURE_CERT_NAME ?= xxxx
+DEVELOPER_ID ?= xxxx
+
+postbundle:
+ifeq ($(RUN_TESTS),false)
+	@echo "Skipping tests"
+	@exit 0
+endif
+ifeq ($(OS),Windows_NT)
+else ifeq ($(shell uname -s),Linux)
+	@chmod +x cortex;
+else
+	@chmod +x cortex;
+endif
+
+codesign:
+ifeq ($(CODE_SIGN),false)
+	@echo "Skipping Code Sign"
+	@exit 0
+endif
+
+ifeq ($(OS),Windows_NT)
+	@powershell -Command "dotnet tool install --global AzureSignTool;"
+	@powershell -Command 'azuresigntool.exe sign -kvu "$(AZURE_KEY_VAULT_URI)" -kvi "$(AZURE_CLIENT_ID)" -kvt "$(AZURE_TENANT_ID)" -kvs "$(AZURE_CLIENT_SECRET)" -kvc "$(AZURE_CERT_NAME)" -tr http://timestamp.globalsign.com/tsa/r6advanced1 -v ".\cortex-js\cortex.exe";'
+else ifeq ($(shell uname -s),Linux)
+	@echo "Skipping Code Sign for linux"
+	@exit 0
+else
+	find "cortex" -type f -exec codesign --force -s "$(DEVELOPER_ID)" --options=runtime {} \;
+endif

cortex-js/cortex.ico

@@ -18,7 +18,6 @@ Name: "english"; MessagesFile: "compiler:Default.isl"
 ; Define the files to be installed
 [Files]
 Source: "cortex.exe"; DestDir: "{app}"; Flags: ignoreversion
-Source: "node_modules\sqlite3\*"; DestDir: "{app}\node_modules\sqlite3"; Flags: ignoreversion recursesubdirs createallsubdirs
 
 ; Define the icons to be created
 [Icons]

cortex-js/installer.iss

@@ -11,7 +11,10 @@
   "scripts": {
     "dev": "nest dev",
     "build": "yarn build:extensions && nest build && cpx \"cpuinfo/bin/**\" dist/bin",
-    "build:binary": "yarn build && nexe dist/src/command.js --build -r './node_modules/**/*' -o dist/cortex",
+    "build:binary": "run-script-os",
+    "build:binary:windows": "bun build --compile --target=bun-windows-x64 ./dist/src/command.js --outfile cortex.exe --external @nestjs/microservices --external @nestjs/websockets/socket-module --external class-transformer/storage",
+    "build:binary:linux": "bun build --compile --target=bun-linux-x64 ./dist/src/command.js --outfile cortex --external @nestjs/microservices --external @nestjs/websockets/socket-module --external class-transformer/storage",
+    "build:binary:macos": "bun build --compile --target=bun-darwin-arm64 ./dist/src/command.js --outfile cortex --external @nestjs/microservices --external @nestjs/websockets/socket-module --external class-transformer/storage",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "build:extensions": "run-script-os",
     "build:extensions:windows": "powershell -command \"$jobs = Get-ChildItem -Path './src/extensions' -Directory | ForEach-Object { Start-Job -Name ($_.Name) -ScriptBlock { param($_dir); try { Set-Location $_dir; yarn; yarn build; Write-Output 'Build successful in ' + $_dir } catch { Write-Error 'Error in ' + $_dir; throw } } -ArgumentList $_.FullName }; $jobs | Wait-Job; $jobs | ForEach-Object { Receive-Job -Job $_ -Keep } | ForEach-Object { Write-Host $_ }; $failed = $jobs | Where-Object { $_.State -ne 'Completed' -or $_.ChildJobs[0].JobStateInfo.State -ne 'Completed' }; if ($failed) { Exit 1 }\"",
@@ -29,7 +32,7 @@
     "test:e2e": "jest --config ./test/jest-e2e.json",
     "typeorm": "typeorm-ts-node-esm",
     "build:dev": "npx nest build && chmod +x ./dist/src/command.js && npm link",
-    "postinstall": "cortex init -s || true"
+    "postinstall": "patch-package"
   },
   "dependencies": {
     "@huggingface/gguf": "^0.1.5",
@@ -55,7 +58,6 @@
     "readline": "^1.3.0",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1",
-    "sqlite": "^5.1.1",
     "sqlite3": "^5.1.7",
     "systeminformation": "^5.22.11",
     "typeorm": "^0.3.20",
@@ -80,6 +82,7 @@
     "@types/uuid": "^9.0.8",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
+    "bun": "^1.1.15",
     "cpx": "^1.5.0",
     "eslint": "^8.42.0",
     "eslint-config-prettier": "^9.0.0",
@@ -88,7 +91,7 @@
     "is-primitive": "^3.0.1",
     "jest": "^29.5.0",
     "nest-commander-testing": "^3.3.0",
-    "nexe": "^4.0.0-rc.6",
+    "patch-package": "^8.0.0",
     "prettier": "^3.0.0",
     "run-script-os": "^1.1.6",
     "source-map-support": "^0.5.21",

cortex-js/package.json

@@ -0,0 +1,15 @@
+diff --git a/node_modules/sqlite3/.DS_Store b/node_modules/sqlite3/.DS_Store
+new file mode 100644
+index 0000000..10f4d43
+Binary files /dev/null and b/node_modules/sqlite3/.DS_Store differ
+diff --git a/node_modules/sqlite3/lib/sqlite3.js b/node_modules/sqlite3/lib/sqlite3.js
+index 430a2b8..9df0857 100644
+--- a/node_modules/sqlite3/lib/sqlite3.js
++++ b/node_modules/sqlite3/lib/sqlite3.js
+@@ -1,5 +1,5 @@
+ const path = require('path');
+-const sqlite3 = require('./sqlite3-binding.js');
++const sqlite3 = require('./../build/Release/node_sqlite3.node');
+ const EventEmitter = require('events').EventEmitter;
+ module.exports = exports = sqlite3;
+