feat: integrate Laravel Nightwatch support

config/nativephp-internal.php

@@ -89,6 +89,7 @@
         'storage/hot',
 
         // Only needed for local testing
+        'vendor/nativephp/desktop/.git',
         'vendor/nativephp/desktop/resources',
         'vendor/nativephp/desktop/vendor',
         'vendor/nativephp/php-bin',

resources/electron/electron-plugin/dist/server/php.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { mkdirSync, statSync, writeFileSync, existsSync } from 'fs';
+import { mkdirSync, statSync, writeFileSync, existsSync, readFileSync } from 'fs';
 import fs_extra from 'fs-extra';
 const { copySync, mkdirpSync } = fs_extra;
 import Store from 'electron-store';
@@ -40,6 +40,53 @@ function shouldMigrateDatabase(store) {
 function shouldOptimize(store) {
     return process.env.NODE_ENV !== 'development';
 }
+function hasNightwatchInstalled(appPath) {
+    const candidateRoots = [
+        appPath,
+        join(appPath, "build", "__nativephp_app_bundle")
+    ];
+    for (const root of candidateRoots) {
+        if (existsSync(join(root, "vendor", "laravel", "nightwatch"))) {
+            return true;
+        }
+        const composerLock = join(root, "composer.lock");
+        if (!existsSync(composerLock)) {
+            continue;
+        }
+        try {
+            if (readFileSync(composerLock, "utf8").includes("\"name\": \"laravel/nightwatch\"")) {
+                return true;
+            }
+        }
+        catch (_a) {
+        }
+    }
+    return false;
+}
+function getNightwatchToken(appPath) {
+    if (process.env.NIGHTWATCH_TOKEN) {
+        return process.env.NIGHTWATCH_TOKEN;
+    }
+    const candidateRoots = [
+        appPath,
+        join(appPath, "build", "__nativephp_app_bundle")
+    ];
+    for (const root of candidateRoots) {
+        const envPath = join(root, ".env");
+        if (!existsSync(envPath)) {
+            continue;
+        }
+        try {
+            const content = readFileSync(envPath, "utf8");
+            const match = content.match(/^NIGHTWATCH_TOKEN=(.+)$/m);
+            if (match && match[1]) {
+                return match[1].replace(/^['"]|['"]$/g, "");
+            }
+        }
+        catch (_a) {
+        }
+    }
+}
 function getPhpPort() {
     return __awaiter(this, void 0, void 0, function* () {
         const suggestedPort = yield getPort({
@@ -229,13 +276,28 @@ function serveApp(secret, apiPort, phpIniSettings) {
         ensureAppFoldersAreAvailable();
         console.log('Making sure app folders are available');
         const env = getDefaultEnvironmentVariables(secret, apiPort);
+        const nightwatchToken = getNightwatchToken(appPath);
+        let phpNightWatchPort;
+        if (nightwatchToken && hasNightwatchInstalled(appPath)) {
+            phpNightWatchPort = yield getPhpPort();
+            env.NIGHTWATCH_TOKEN = nightwatchToken;
+            env.NIGHTWATCH_INGEST_URI = `127.0.0.1:${phpNightWatchPort}`;
+        }
+        else if (nightwatchToken) {
+            console.log("Skipping Nightwatch: package not installed.");
+        }
         const phpOptions = {
             cwd: appPath,
             env
         };
         const store = new Store({
             name: 'nativephp',
         });
+        if (env.NIGHTWATCH_INGEST_URI && phpNightWatchPort) {
+            console.log('Starting Nightwatch server...');
+            callPhp(['artisan', 'nightwatch:agent', `--listen-on=${env.NIGHTWATCH_INGEST_URI}`], phpOptions, phpIniSettings);
+            console.log('Nightwatch server started on port:', phpNightWatchPort);
+        }
         if (shouldOptimize(store)) {
             console.log('Caching view and routes...');
             let result = callPhpSync(['artisan', 'optimize'], phpOptions, phpIniSettings);

resources/electron/electron-plugin/src/server/php.ts

@@ -1,4 +1,4 @@
-import {mkdirSync, statSync, writeFileSync, existsSync} from 'fs'
+import { mkdirSync, statSync, writeFileSync, existsSync, readFileSync } from 'fs';
 import fs_extra from 'fs-extra';
 
 const {copySync, mkdirpSync} = fs_extra;
@@ -49,6 +49,65 @@ function shouldOptimize(store) {
     // return runningSecureBuild() && store.get('optimized_version') !== app.getVersion();
 }
 
+function hasNightwatchInstalled(appPath: string) {
+    const candidateRoots = [
+        appPath,
+        join(appPath, "build", "__nativephp_app_bundle")
+    ];
+
+    for (const root of candidateRoots) {
+        if (existsSync(join(root, "vendor", "laravel", "nightwatch"))) {
+            return true;
+        }
+
+        const composerLock = join(root, "composer.lock");
+
+        if (!existsSync(composerLock)) {
+            continue;
+        }
+
+        try {
+            if (readFileSync(composerLock, "utf8").includes("\"name\": \"laravel/nightwatch\"")) {
+                return true;
+            }
+        } catch {
+            // ignore and keep looking
+        }
+    }
+
+    return false;
+}
+
+function getNightwatchToken(appPath: string) {
+    if (process.env.NIGHTWATCH_TOKEN) {
+        return process.env.NIGHTWATCH_TOKEN;
+    }
+
+    const candidateRoots = [
+        appPath,
+        join(appPath, "build", "__nativephp_app_bundle")
+    ];
+
+    for (const root of candidateRoots) {
+        const envPath = join(root, ".env");
+
+        if (!existsSync(envPath)) {
+            continue;
+        }
+
+        try {
+            const content = readFileSync(envPath, "utf8");
+            const match = content.match(/^NIGHTWATCH_TOKEN=(.+)$/m);
+
+            if (match && match[1]) {
+                return match[1].replace(/^['"]|['"]$/g, "");
+            }
+        } catch {
+            // ignore and keep looking
+        }
+    }
+}
+
 async function getPhpPort() {
     // Try get-port first (fast path)
     const suggestedPort = await getPort({
@@ -277,6 +336,9 @@ interface EnvironmentVariables {
     APP_ROUTES_CACHE?: string;
     APP_EVENTS_CACHE?: string;
     VIEW_COMPILED_PATH?: string;
+
+    NIGHTWATCH_TOKEN?: string;
+    NIGHTWATCH_INGEST_URI?: string;
 }
 
 function getDefaultEnvironmentVariables(secret?: string, apiPort?: number): EnvironmentVariables {
@@ -342,6 +404,17 @@ function serveApp(secret, apiPort, phpIniSettings): Promise<ProcessResult> {
 
         const env = getDefaultEnvironmentVariables(secret, apiPort);
 
+
+        const nightwatchToken = getNightwatchToken(appPath);
+        let phpNightWatchPort: number | undefined;
+        if (nightwatchToken && hasNightwatchInstalled(appPath)) {
+            phpNightWatchPort = await getPhpPort();
+            env.NIGHTWATCH_TOKEN = nightwatchToken;
+            env.NIGHTWATCH_INGEST_URI = `127.0.0.1:${phpNightWatchPort}`;
+        } else if (nightwatchToken) {
+            console.log("Skipping Nightwatch: package not installed.");
+        }
+
         const phpOptions = {
             cwd: appPath,
             env
@@ -351,6 +424,12 @@ function serveApp(secret, apiPort, phpIniSettings): Promise<ProcessResult> {
             name: 'nativephp', // So it doesn't conflict with settings of the app
         });
 
+        if(env.NIGHTWATCH_INGEST_URI && phpNightWatchPort) {
+            console.log('Starting Nightwatch server...');
+            callPhp(['artisan', 'nightwatch:agent', `--listen-on=${env.NIGHTWATCH_INGEST_URI}`], phpOptions, phpIniSettings)
+            console.log('Nightwatch server started on port:', phpNightWatchPort);
+        }
+
         // Cache the project
         if (shouldOptimize(store)) {
             console.log('Caching view and routes...');

routes/api.php

@@ -5,11 +5,12 @@
 use Native\Desktop\Http\Controllers\CreateSecurityCookieController;
 use Native\Desktop\Http\Controllers\DispatchEventFromAppController;
 use Native\Desktop\Http\Controllers\NativeAppBootedController;
+use Native\Desktop\Http\Middleware\OptionalNightwatchNever;
 use Native\Desktop\Http\Middleware\PreventRegularBrowserAccess;
 
-Route::group(['middleware' => PreventRegularBrowserAccess::class], function () {
+Route::group(['middleware' => [OptionalNightwatchNever::class, PreventRegularBrowserAccess::class]], function () {
     Route::post('_native/api/booted', NativeAppBootedController::class);
     Route::post('_native/api/events', DispatchEventFromAppController::class);
 })->withoutMiddleware(VerifyCsrfToken::class);
 
-Route::get('_native/api/cookie', CreateSecurityCookieController::class);
+Route::get('_native/api/cookie', CreateSecurityCookieController::class)->middleware(OptionalNightwatchNever::class);

src/Http/Middleware/OptionalNightwatchNever.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Native\Desktop\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+
+class OptionalNightwatchNever
+{
+    public function handle(Request $request, Closure $next): mixed
+    {
+        if (class_exists(\Laravel\Nightwatch\Http\Middleware\Sample::class)) {
+            $middleware = app(\Laravel\Nightwatch\Http\Middleware\Sample::class);
+
+            return $middleware->handle($request, $next, 0.0);
+        }
+
+        return $next($request);
+    }
+}