Fix to issue nativephp/laravel #318 + General cleanup and DRYied Publish command (#97)

Rudeisnice · Nicolas Utzinger · web-flow · commit ab99e94ed49b · 2024-07-18T12:16:36.000+01:00
* Fix mac -&gt; win crossbuild + DRY cleanup

* php.js and electron-builder.js cleanup

* updated build commands with arch and uncommented npm update in native:build command

* added comments

* Unbroken previous change for removing publish command

* revert to original package.json name property

* wip

* updated php.js to allow target architecture

* PR clean up

* changes for --no-interaction option

* remove dd and var name change

---------

Co-authored-by: Nicolas Utzinger &lt;nico@nutzinger.ch&gt;
diff --git a/resources/js/electron-builder.js b/resources/js/electron-builder.js
@@ -32,6 +32,7 @@ if (isDarwin) {
 
 let updaterConfig = {};
 
+// We wouldn't need these since its not representing the target platform
 console.log("Arch: ", process.arch)
 console.log("Platform: ", process.platform)
 try {
@@ -107,10 +108,9 @@ if (isBuilding) {
         console.log(join(process.env.APP_PATH, 'dist'));
         console.log('=====================');
 
-        // We'll use the default PHP binary here, as we can cross-compile for all platforms
-        const phpBinary = join(process.env.APP_PATH, 'vendor', 'nativephp', 'electron', 'resources', 'js', 'resources', 'php', 'php');
         const artisanPath = join(appPath, 'artisan');
-        execSync(`${phpBinary} ${artisanPath} native:minify ${appPath}`);
+        // We'll use the default PATH PHP binary here, as we can cross-compile for all platforms. This shouldn't be changed.
+        execSync(`php ${artisanPath} native:minify ${appPath}`);
     } catch (e) {
         console.error('=====================');
         console.error('Error copying app to resources');
diff --git a/resources/js/package.json b/resources/js/package.json
@@ -1,53 +1,55 @@
 {
-  "name": "NativePHP",
-  "version": "1.0.0",
-  "description": "A NativePHP Electron application",
-  "main": "./out/main/index.js",
-  "author": "NativePHP",
-  "homepage": "https://nativephp.com",
-  "scripts": {
-    "format": "prettier --write .",
-    "lint": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix",
-    "start": "electron-vite preview",
-    "dev": "cross-env node php.js && electron-vite dev --watch",
-    "build": "electron-vite build",
-    "postinstall": "node ./node_modules/electron-builder/cli.js install-app-deps",
-    "publish:win": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --win --config",
-    "publish:mac": "cross-env npm run publish:mac-arm && cross-env npm run publish:mac-x86",
-    "publish:mac-arm": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --mac --config --arm64 -p always",
-    "publish:mac-x86": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --mac --config --x64 -p always",
-    "publish:linux": "cross-env npm run publish:linux-x64",
-    "publish:linux-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js --linux --config --x64 -p always",
-    "build:all": "cross-env npm run build:mac && cross-env npm run build:win && cross-env npm run build:linux",
-    "build:win": "cross-env node php.js --win && cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --win --config",
-    "build:mac": "cross-env npm run build:mac-arm && cross-env npm run build:mac-x86",
-    "build:mac-arm": "cross-env node php.js --arm64 --mac && cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --mac --config --arm64",
-    "build:mac-x86": "cross-env node php.js --mac && cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --mac --config --x64",
-    "build:linux": "cross-env npm run build:linux-x64",
-    "build:linux-x64": "cross-env node php.js --linux && cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --linux --config --x64"
-  },
-  "dependencies": {
-    "@electron-toolkit/preload": "^1.0.3",
-    "@electron-toolkit/utils": "^1.0.2",
-    "@electron/remote": "^2.0.9",
-    "@nativephp/electron-plugin": "^0.3.1",
-    "yauzl": "^3.1.3"
-  },
-  "devDependencies": {
-    "@electron/notarize": "^1.2.3",
-    "@rushstack/eslint-patch": "^1.2.0",
-    "@vitejs/plugin-vue": "^4.1.0",
-    "@vue/eslint-config-prettier": "^7.1.0",
-    "cross-env": "^7.0.3",
-    "electron": "^25.0",
-    "electron-builder": "^24.5.1",
-    "electron-chromedriver": "^25.0",
-    "electron-vite": "^1.0.24",
-    "eslint": "^8.36.0",
-    "eslint-plugin-vue": "^9.10.0",
-    "less": "^4.1.3",
-    "prettier": "^2.8.7",
-    "vite": "^4.2.1",
-    "vue": "^3.2.47"
-  }
+    "name": "NativePHP",
+    "version": "1.0.0",
+    "description": "A NativePHP Electron application",
+    "main": "./out/main/index.js",
+    "author": "NativePHP",
+    "homepage": "https://nativephp.com",
+    "scripts": {
+        "format": "prettier --write .",
+        "lint": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix",
+        "start": "electron-vite preview",
+        "dev": "cross-env node php.js && electron-vite dev --watch",
+        "build": "electron-vite build",
+        "postinstall": "node ./node_modules/electron-builder/cli.js install-app-deps",
+        "publish:win": "cross-env npm run publish:win-x64",
+        "publish:win-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --win --config --x64",
+        "publish:mac": "cross-env npm run publish:mac-arm && cross-env npm run publish:mac-x86",
+        "publish:mac-arm": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --mac --config --arm64 -p always",
+        "publish:mac-x86": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --mac --config --x64 -p always",
+        "publish:linux": "cross-env npm run publish:linux-x64",
+        "publish:linux-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js --linux --config --x64 -p always",
+        "build:all": "cross-env npm run build:mac && cross-env npm run build:win && cross-env npm run build:linux",
+        "build:win": "cross-env npm run build:win-x64",
+        "build:win-x64": "cross-env node php.js --win --x64 && cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --win --config --x64",
+        "build:mac": "cross-env npm run build:mac-arm64 && cross-env npm run build:mac-x86",
+        "build:mac-arm64": "cross-env node php.js --mac --arm64 && cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --mac --config --arm64",
+        "build:mac-x86": "cross-env node php.js --mac --x86 && cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --mac --config --x64",
+        "build:linux": "cross-env npm run build:linux-x64",
+        "build:linux-x64": "cross-env node php.js --linux --x64 && cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --linux --config --x64"
+    },
+    "dependencies": {
+        "@electron-toolkit/preload": "^1.0.3",
+        "@electron-toolkit/utils": "^1.0.2",
+        "@electron/remote": "^2.0.9",
+        "@nativephp/electron-plugin": "^0.3.1",
+        "yauzl": "^3.1.3"
+    },
+    "devDependencies": {
+        "@electron/notarize": "^1.2.3",
+        "@rushstack/eslint-patch": "^1.2.0",
+        "@vitejs/plugin-vue": "^4.1.0",
+        "@vue/eslint-config-prettier": "^7.1.0",
+        "cross-env": "^7.0.3",
+        "electron": "^25.0",
+        "electron-builder": "^24.5.1",
+        "electron-chromedriver": "^25.0",
+        "electron-vite": "^1.0.24",
+        "eslint": "^8.36.0",
+        "eslint-plugin-vue": "^9.10.0",
+        "less": "^4.1.3",
+        "prettier": "^2.8.7",
+        "vite": "^4.2.1",
+        "vue": "^3.2.47"
+    }
 }
diff --git a/resources/js/php.js b/resources/js/php.js
@@ -1,48 +1,63 @@
+const { log } = require("console");
 const fs = require("fs");
 const {copySync, removeSync, existsSync, ensureDirSync} = require("fs-extra");
 const {join} = require("path");
+const { exit } = require("process");
 const unzip = require("yauzl");
 
-const isBuilding = process.env.NATIVEPHP_BUILDING;
+const isBuilding = Boolean(process.env.NATIVEPHP_BUILDING);
 const phpBinaryPath = process.env.NATIVEPHP_PHP_BINARY_PATH;
 const phpVersion = process.env.NATIVEPHP_PHP_BINARY_VERSION;
 const certificatePath = process.env.NATIVEPHP_CERTIFICATE_FILE_PATH;
 
 // Differentiates for Serving and Building
-const isArm64 = isBuilding ? process.argv.includes('--arm64') : process.platform.includes('arm64') ;
+const isArm64 = isBuilding ? process.argv.includes('--arm64') : process.arch.includes('arm64');
 const isWindows = isBuilding ?  process.argv.includes('--win') : process.platform.includes('win32');
 const isLinux = isBuilding ?  process.argv.includes('--linux') : process.platform.includes('linux');
 const isDarwin = isBuilding ?  process.argv.includes('--mac') : process.platform.includes('darwin');
 
-let targetOs;
-let binaryArch = 'x64';
-let phpBinaryFilename = 'php';
+// false because string mapping is done in is{OS} checks
+const platform = {
+    os: false,
+    arch: false,
+    phpBinary: 'php'
+};
 
 if (isWindows) {
-    targetOs = 'win';
-    phpBinaryFilename += '.exe';
+    platform.os = 'win';
+    platform.phpBinary += '.exe';
 }
+
 if (isLinux) {
-    targetOs = 'linux';
+    platform.os = 'linux';
 }
-// Use of isDarwin
+
 if (isDarwin) {
-    targetOs = 'mac';
-    binaryArch = 'x86';
+    platform.os = 'mac';
+    platform.arch = 'x86';
 }
+
 if (isArm64) {
-    binaryArch = 'arm64';
+    platform.arch = 'arm64';
+}
+
+// isBuilding overwrites platform to the desired architecture
+if (isBuilding) {
+    // Only one will be used by the configured build commands in package.json
+    platform.arch = process.argv.includes('--x64') ? 'x64' : platform.arch;
+    platform.arch = process.argv.includes('--x86') ? 'x86' : platform.arch;
+    platform.arch = process.argv.includes('--arm64') ? 'arm64' : platform.arch;
 }
 
 const phpVersionZip = 'php-' + phpVersion + '.zip';
-const binarySrcDir = join(phpBinaryPath, targetOs, binaryArch, phpVersionZip);
+const binarySrcDir = join(phpBinaryPath, platform.os, platform.arch, phpVersionZip);
 const binaryDestDir = join(__dirname, 'resources/php');
 
 console.log('Binary Source: ', binarySrcDir);
-console.log('Binary Filename: ', phpBinaryFilename);
+console.log('Binary Filename: ', platform.phpBinary);
 console.log('PHP version: ' + phpVersion);
 
-if (phpBinaryPath) {
+if (platform.phpBinary) {
     try {
         console.log('Unzipping PHP binary from ' + binarySrcDir + ' to ' + binaryDestDir);
         removeSync(binaryDestDir);
@@ -57,7 +72,7 @@ if (phpBinaryPath) {
                 zipfile.openReadStream(entry, function (err, readStream) {
                     if (err) throw err;
 
-                    const binaryPath = join(binaryDestDir, phpBinaryFilename);
+                    const binaryPath = join(binaryDestDir, platform.phpBinary);
                     const writeStream = fs.createWriteStream(binaryPath);
 
                     readStream.pipe(writeStream);
diff --git a/src/Commands/BuildCommand.php b/src/Commands/BuildCommand.php
@@ -7,37 +7,58 @@
 use Illuminate\Support\Str;
 use Native\Electron\Concerns\LocatesPhpBinary;
 use Native\Electron\Facades\Updater;
-
-use function Laravel\Prompts\select;
+use Native\Electron\Traits\OsAndArch;
 
 class BuildCommand extends Command
 {
     use LocatesPhpBinary;
+    use OsAndArch;
+
+    protected $signature = 'native:build
+        {os? : The operating system to build for (all, linux, mac, win)}
+        {arch? : The Processor Architecture to build for (x64, x86, arm64)}
+        {--publish : to publish the app}';
 
-    protected $signature = 'native:build {os? : The operating system to build for (all, linux, mac, win)}';
+    protected $availableOs = ['win', 'linux', 'mac', 'all'];
 
     public function handle(): void
     {
         $this->info('Build NativePHP app…');
 
+        Process::path(__DIR__.'/../../resources/js/')
+            ->env($this->getEnvironmentVariables())
+            ->forever()
+            ->run('npm update', function (string $type, string $output) {
+                echo $output;
+            });
+
         Process::path(base_path())
             ->run('composer install --no-dev', function (string $type, string $output) {
                 echo $output;
             });
 
-        if (! $os = $this->argument('os')) {
-            $os = select(
-                label: 'Please select the operating system to build for',
-                options: ['win', 'linux', 'mac', 'all'],
-                default: $this->getDefaultOs(),
-            );
+        // Added checks for correct input for os and arch
+        $os = $this->selectOs($this->argument('os'));
+
+        $buildCommand = 'build';
+        if ($os != 'all') {
+            $arch = $this->selectArchitectureForOs($os, $this->argument('arch'));
+
+            $os .= $arch != 'all' ? "-{$arch}": '';
+
+            // Wether to publish the app or not
+            if ($publish = ($this->option('publish'))){
+                $buildCommand = 'publish';
+            }
         }
+        $this->info((($publish ?? false) ? "Publishing" : 'Building') . " for {$os}");
+
 
         Process::path(__DIR__.'/../../resources/js/')
             ->env($this->getEnvironmentVariables())
             ->forever()
             ->tty(PHP_OS_FAMILY != 'Windows' && ! $this->option('no-interaction'))
-            ->run("npm run build:{$os}", function (string $type, string $output) {
+            ->run("npm run {$buildCommand}:{$os}", function (string $type, string $output) {
                 echo $output;
             });
     }
@@ -63,13 +84,4 @@ protected function getEnvironmentVariables(): array
         );
     }
 
-    protected function getDefaultOs(): string
-    {
-        return match (PHP_OS_FAMILY) {
-            'Windows' => 'win',
-            'Darwin' => 'mac',
-            'Linux' => 'linux',
-            default => 'all',
-        };
-    }
 }
diff --git a/src/Commands/PublishCommand.php b/src/Commands/PublishCommand.php
@@ -3,78 +3,32 @@
 namespace Native\Electron\Commands;
 
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\Process;
-use Illuminate\Support\Str;
+use Illuminate\Support\Facades\Artisan;
 use Native\Electron\Concerns\LocatesPhpBinary;
-use Native\Electron\Facades\Updater;
+use Native\Electron\Traits\OsAndArch;
 
 use function Laravel\Prompts\select;
 
 class PublishCommand extends Command
 {
     use LocatesPhpBinary;
+    use OsAndArch;
 
-    protected $signature = 'native:publish {os? : The operating system to build for (linux, mac, win)}';
+    protected $signature = 'native:publish
+        {os? : The operating system to build for (linux, mac, win)}
+        {arch? : The Processor Architecture to build for (x64, x86, arm64)}';
+
+
+    protected array $availableOs = ['win', 'linux', 'mac'];
 
     public function handle(): void
     {
         $this->info('Building and publishing NativePHP app…');
 
-        Process::path(__DIR__.'/../../resources/js/')
-            ->env($this->getEnvironmentVariables())
-            ->forever()
-            ->run('npm update', function (string $type, string $output) {
-                echo $output;
-            });
-
-        Process::path(base_path())
-            ->run('composer install --no-dev', function (string $type, string $output) {
-                echo $output;
-            });
+        $os = $this->selectOs($this->argument('os'));
 
-        if (! $os = $this->argument('os')) {
-            $os = select(
-                label: 'Please select the operating system to build for',
-                options: ['win', 'linux', 'mac', 'all'],
-                default: $this->getDefaultOs(),
-            );
-        }
-
-        Process::path(__DIR__.'/../../resources/js/')
-            ->env($this->getEnvironmentVariables())
-            ->forever()
-            ->tty(PHP_OS_FAMILY != 'Windows' && ! $this->option('no-interaction'))
-            ->run("npm run publish:{$os}", function (string $type, string $output) {
-                echo $output;
-            });
-    }
+        $arch = $this->selectArchitectureForOs($os, $this->argument('arch'));
 
-    protected function getEnvironmentVariables(): array
-    {
-        return array_merge(
-            [
-                'APP_PATH' => base_path(),
-                'NATIVEPHP_BUILDING' => true,
-                'NATIVEPHP_PHP_BINARY_VERSION' => PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION,
-                'NATIVEPHP_PHP_BINARY_PATH' => base_path($this->phpBinaryPath()),
-                'NATIVEPHP_CERTIFICATE_FILE_PATH' => base_path($this->binaryPackageDirectory().'cacert.pem'),
-                'NATIVEPHP_APP_NAME' => config('app.name'),
-                'NATIVEPHP_APP_ID' => config('nativephp.app_id'),
-                'NATIVEPHP_APP_VERSION' => config('nativephp.version'),
-                'NATIVEPHP_APP_FILENAME' => Str::slug(config('app.name')),
-                'NATIVEPHP_UPDATER_CONFIG' => json_encode(Updater::builderOptions()),
-            ],
-            Updater::environmentVariables(),
-        );
-    }
-
-    protected function getDefaultOs(): string
-    {
-        return match (PHP_OS_FAMILY) {
-            'Windows' => 'win',
-            'Darwin' => 'mac',
-            'Linux' => 'linux',
-            default => 'all',
-        };
+        Artisan::call("native:build", ['os'=>$os, 'arch' => $arch, '--publish' => true], $this->output);
     }
 }
diff --git a/src/Traits/OsAndArch.php b/src/Traits/OsAndArch.php
