Skip to content
This repository was archived by the owner on May 27, 2026. It is now read-only.

feat(plugin): allow non-Laravel guest frameworks via three opt-in env vars #265

Closed
alexstandiford wants to merge 1 commit into from
Closed

feat(plugin): allow non-Laravel guest frameworks via three opt-in env vars #265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions resources/js/electron-plugin/dist/server/php.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ const databaseFile = join(databasePath, 'database.sqlite');
const bootstrapCache = join(app.getPath('userData'), 'bootstrap', 'cache');
const argumentEnv = getArgumentEnv();
const appPath = getAppPath();
const BOOT_BIN = process.env.NATIVEPHP_PHP_BOOT_BIN || 'artisan';
const SERVER_SCRIPT = process.env.NATIVEPHP_SERVER_SCRIPT || '';
const SKIP_LARAVEL_SETUP = process.env.NATIVEPHP_SKIP_LARAVEL_SETUP === '1';
mkdirpSync(bootstrapCache);
mkdirpSync(join(storagePath, 'logs'));
mkdirpSync(join(storagePath, 'framework', 'cache'));
Expand Down Expand Up @@ -77,7 +80,7 @@ function retrievePhpIniSettings() {
cwd: appPath,
env
};
let command = ['artisan', 'native:php-ini'];
let command = [BOOT_BIN, 'native:php-ini'];
if (runningSecureBuild()) {
command.unshift(join(appPath, 'build', '__nativephp_app_bundle'));
}
Expand All @@ -91,15 +94,15 @@ function retrieveNativePHPConfig() {
cwd: appPath,
env
};
let command = ['artisan', 'native:config'];
let command = [BOOT_BIN, 'native:config'];
if (runningSecureBuild()) {
command.unshift(join(appPath, 'build', '__nativephp_app_bundle'));
}
return yield promisify(execFile)(state.php, command, phpOptions);
});
}
function callPhp(args, options, phpIniSettings = {}) {
if (args[0] === 'artisan' && runningSecureBuild()) {
if (args[0] === BOOT_BIN && runningSecureBuild()) {
args.unshift(join(appPath, 'build', '__nativephp_app_bundle'));
}
let iniSettings = Object.assign(getDefaultPhpIniSettings(), phpIniSettings);
Expand All @@ -115,7 +118,7 @@ function callPhp(args, options, phpIniSettings = {}) {
});
}
function callPhpSync(args, options, phpIniSettings = {}) {
if (args[0] === 'artisan' && runningSecureBuild()) {
if (args[0] === BOOT_BIN && runningSecureBuild()) {
args.unshift(join(appPath, 'build', '__nativephp_app_bundle'));
}
let iniSettings = Object.assign(getDefaultPhpIniSettings(), phpIniSettings);
Expand Down Expand Up @@ -233,7 +236,7 @@ function serveApp(secret, apiPort, phpIniSettings) {
const store = new Store({
name: 'nativephp',
});
if (shouldOptimize(store)) {
if (!SKIP_LARAVEL_SETUP && shouldOptimize(store)) {
console.log('Caching view and routes...');
let result = callPhpSync(['artisan', 'optimize'], phpOptions, phpIniSettings);
if (result.status !== 0) {
Expand All @@ -243,7 +246,7 @@ function serveApp(secret, apiPort, phpIniSettings) {
store.set('optimized_version', app.getVersion());
}
}
if (shouldMigrateDatabase(store)) {
if (!SKIP_LARAVEL_SETUP && shouldMigrateDatabase(store)) {
console.log('Migrating database...');
if (parseInt(process.env.SHELL_VERBOSITY) > 0) {
console.log('Database path:', databaseFile);
Expand All @@ -265,6 +268,11 @@ function serveApp(secret, apiPort, phpIniSettings) {
if (runningSecureBuild()) {
serverPath = join(appPath, 'build', '__nativephp_app_bundle');
}
else if (SERVER_SCRIPT !== '') {
console.log('* * * Running from source (custom server script) * * *');
serverPath = SERVER_SCRIPT;
cwd = process.env.NATIVEPHP_SERVER_CWD || join(appPath, 'public');
}
else {
console.log('* * * Running from source * * *');
serverPath = join(appPath, 'vendor', 'laravel', 'framework', 'src', 'Illuminate', 'Foundation', 'resources', 'server.php');
Expand Down
31 changes: 23 additions & 8 deletions resources/js/electron-plugin/src/server/php.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ const bootstrapCache = join(app.getPath('userData'), 'bootstrap', 'cache')
const argumentEnv = getArgumentEnv();
const appPath = getAppPath();

// Optional overrides for non-Laravel guest frameworks. Defaults preserve
// the existing Laravel-targeted behavior in every code path; any framework
// that ships its own CLI + dev-server router can opt in by setting these.
const BOOT_BIN = process.env.NATIVEPHP_PHP_BOOT_BIN || 'artisan';
const SERVER_SCRIPT = process.env.NATIVEPHP_SERVER_SCRIPT || '';
const SKIP_LARAVEL_SETUP = process.env.NATIVEPHP_SKIP_LARAVEL_SETUP === '1';

mkdirpSync(bootstrapCache);
mkdirpSync(join(storagePath, 'logs'));
mkdirpSync(join(storagePath, 'framework', 'cache'));
Expand Down Expand Up @@ -96,7 +103,7 @@ async function retrievePhpIniSettings() {
env
};

let command = ['artisan', 'native:php-ini'];
let command = [BOOT_BIN, 'native:php-ini'];

if (runningSecureBuild()) {
command.unshift(join(appPath, 'build', '__nativephp_app_bundle'));
Expand All @@ -113,7 +120,7 @@ async function retrieveNativePHPConfig() {
env
};

let command = ['artisan', 'native:config'];
let command = [BOOT_BIN, 'native:config'];

if (runningSecureBuild()) {
command.unshift(join(appPath, 'build', '__nativephp_app_bundle'));
Expand All @@ -124,7 +131,7 @@ async function retrieveNativePHPConfig() {

function callPhp(args, options, phpIniSettings = {}) {

if (args[0] === 'artisan' && runningSecureBuild()) {
if (args[0] === BOOT_BIN && runningSecureBuild()) {
args.unshift(join(appPath, 'build', '__nativephp_app_bundle'));
}

Expand Down Expand Up @@ -153,7 +160,7 @@ function callPhp(args, options, phpIniSettings = {}) {

function callPhpSync(args, options, phpIniSettings = {}) {

if (args[0] === 'artisan' && runningSecureBuild()) {
if (args[0] === BOOT_BIN && runningSecureBuild()) {
args.unshift(join(appPath, 'build', '__nativephp_app_bundle'));
}

Expand Down Expand Up @@ -347,8 +354,9 @@ function serveApp(secret, apiPort, phpIniSettings): Promise<ProcessResult> {
name: 'nativephp', // So it doesn't conflict with settings of the app
});

// Cache the project
if (shouldOptimize(store)) {
// Cache the project — Laravel-specific (artisan optimize). Skip
// when the guest framework manages its own caching/optimization.
if (!SKIP_LARAVEL_SETUP && shouldOptimize(store)) {
console.log('Caching view and routes...');

let result = callPhpSync(['artisan', 'optimize'], phpOptions, phpIniSettings);
Expand All @@ -360,8 +368,10 @@ function serveApp(secret, apiPort, phpIniSettings): Promise<ProcessResult> {
}
}

// Migrate the database
if (shouldMigrateDatabase(store)) {
// Migrate the database — Laravel-specific (artisan migrate). Skip
// when the guest framework owns its own migration story (e.g. a
// non-Laravel app handling SQLite schema on its own).
if (!SKIP_LARAVEL_SETUP && shouldMigrateDatabase(store)) {
console.log('Migrating database...');

if(parseInt(process.env.SHELL_VERBOSITY) > 0) {
Expand All @@ -387,6 +397,11 @@ function serveApp(secret, apiPort, phpIniSettings): Promise<ProcessResult> {

if (runningSecureBuild()) {
serverPath = join(appPath, 'build', '__nativephp_app_bundle');
} else if (SERVER_SCRIPT !== '') {
// Guest framework supplies its own front-controller / router.
console.log('* * * Running from source (custom server script) * * *');
serverPath = SERVER_SCRIPT;
cwd = process.env.NATIVEPHP_SERVER_CWD || join(appPath, 'public');
} else {
console.log('* * * Running from source * * *');
serverPath = join(appPath, 'vendor', 'laravel', 'framework', 'src', 'Illuminate', 'Foundation', 'resources', 'server.php');
Expand Down