Merge pull request #61115 from nextcloud/feat/extend-frankenphp-support

feat: Add frankenphp worker support for more endpoints

Author: come-nc

Caddyfile

@@ -3,12 +3,35 @@
 #
 # THIS IS AN EXPERIMENTAL FEATURE
 # DO NOT USE THIS IN PRODUCTION, YOU HAVE BEEN WARNED.
+{
+	metrics
+	frankenphp {
+		num_threads 192
+		max_threads 256
+		# max_requests 500
+	}
+}
 
 localhost {
 	php_server {
-        worker {
+		worker {
 			file index.php
+			num 32
 			watch
+			match /index.php/*
+		}
+		worker {
+			file remote.php
+			num 32
+			watch
+			match /remote.php/*
+		}
+		worker {
+			file ocs/v1.php
+			num 32
+			watch
+			match /ocs/v1.php/*
+			match /ocs/v2.php/*
 		}
 	}
 
@@ -17,42 +40,42 @@ localhost {
 		output stderr
 	}
 
-    encode gzip
+	encode gzip
 
-    redir /.well-known/carddav /remote.php/dav 301
-    redir /.well-known/caldav /remote.php/dav 301
+	redir /.well-known/carddav /remote.php/dav 301
+	redir /.well-known/caldav /remote.php/dav 301
 
-    # Rule: Maps most RFC 8615 compliant well-known URIs to our main frontend controller (/index.php) by default
-    @wellKnown {
-        path "/.well-known/"
-        not {
-            path /.well-known/acme-challenge
-            path /.well-known/pki-validation
-        }
-    }
-    rewrite @wellKnown /index.php
+	# Rule: Maps most RFC 8615 compliant well-known URIs to our main frontend controller (/index.php) by default
+	@wellKnown {
+		path "/.well-known/"
+		not {
+			path /.well-known/acme-challenge
+			path /.well-known/pki-validation
+		}
+	}
+	rewrite @wellKnown /index.php
 
-    rewrite /ocm-provider/ /index.php
+	rewrite /ocm-provider/ /index.php
 
-    @forbidden {
-        path /.htaccess
-        path /data/*
-        path /config/*
-        path /db_structure
-        path /.xml
-        path /README
-        path /3rdparty/*
-        path /lib/*
-        path /templates/*
-        path /occ
-        path /build
-        path /tests
-        path /console.php
-        path /autotest
-        path /issue
-        path /indi
-        path /db_
-        path /console
-    }
-    respond @forbidden 404
+	@forbidden {
+		path /.htaccess
+		path /data/*
+		path /config/*
+		path /db_structure
+		path /.xml
+		path /README
+		path /3rdparty/*
+		path /lib/*
+		path /templates/*
+		path /occ
+		path /build
+		path /tests
+		path /console.php
+		path /autotest
+		path /issue
+		path /indi
+		path /db_
+		path /console
+	}
+	respond @forbidden 404
 }

index.php

@@ -8,9 +8,6 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-require_once __DIR__ . '/lib/versioncheck.php';
-
-use OC\Files\Filesystem;
 use OC\ServiceUnavailableException;
 use OC\User\LoginException;
 use OCP\HintException;
@@ -20,27 +17,15 @@
 use OCP\Template\ITemplateManager;
 use Psr\Log\LoggerInterface;
 
+require_once __DIR__ . '/lib/versioncheck.php';
 require_once __DIR__ . '/lib/OC.php';
 
 \OC::boot();
 
-function resetStaticProperties(): void {
-	// FIXME needed because these use a static var
-	\OC_Hook::clear();
-	\OC_Util::$styles = [];
-	\OC_Util::$headers = [];
-	\OC_User::setIncognitoMode(false);
-	\OC_User::$_setupedBackends = [];
-	\OC_App::reset();
-	\OC_Helper::reset();
-	Filesystem::reset();
-}
-
-$handler = static function (): void {
+\OC::handleRequests(static function (): void {
 	try {
-		resetStaticProperties();
-		OC::init();
-		OC::handleRequest();
+		\OC::initForRequest();
+		\OC::handleRequest();
 	} catch (ServiceUnavailableException $ex) {
 		Server::get(LoggerInterface::class)->error($ex->getMessage(), [
 			'app' => 'index',
@@ -124,20 +109,4 @@ function resetStaticProperties(): void {
 		}
 		Server::get(ITemplateManager::class)->printExceptionErrorPage($ex, 500);
 	}
-};
-
-if (function_exists('frankenphp_handle_request') && isset($_SERVER['FRANKENPHP_WORKER']) && $_SERVER['FRANKENPHP_WORKER'] === '1') {
-	$maxRequests = (int)($_SERVER['MAX_REQUESTS'] ?? 0);
-	for ($nbRequests = 0; !$maxRequests || $nbRequests < $maxRequests; ++$nbRequests) {
-		$keepRunning = \frankenphp_handle_request($handler);
-
-		// Call the garbage collector to reduce the chances of it being triggered in the middle of a page generation
-		gc_collect_cycles();
-
-		if (!$keepRunning) {
-			break;
-		}
-	}
-} else {
-	$handler();
-}
+});

lib/OC.php

@@ -7,6 +7,7 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
+use OC\Files\Filesystem;
 use OC\NavigationManager;
 use OC\Profiler\BuiltInProfiler;
 use OC\Security\CSP\ContentSecurityPolicyNonceManager;
@@ -102,6 +103,11 @@ class OC {
 	private static float $loaderStart;
 	private static float $loaderEnd;
 
+	/**
+	 * @psalm-suppress ImpureStaticProperty
+	 */
+	private static bool $oneTimeChecksDone = false;
+
 	/**
 	 * @throws \RuntimeException when the 3rdparty directory is missing or
 	 *                           the app path list is empty or contains an invalid path
@@ -656,6 +662,9 @@ private static function addSecurityHeaders(): void {
 		}
 	}
 
+	/*
+	 * Called only once at the beginning to setup things
+	 */
 	public static function boot(): void {
 		// prevent any XML processing from loading external entities
 		libxml_set_external_entity_loader(static function () {
@@ -714,24 +723,67 @@ public static function boot(): void {
 			print($e->getMessage());
 			exit();
 		}
+		self::setRequiredIniValues();
+
+		// initialize intl fallback if necessary
+		OC_Util::isSetLocaleWorking();
+	}
+
+	/**
+	 * Run one time checks if not already run. This allows checking after server boot, to have access to translations and pretty error rendering while still checking only once in worker mode.
+	 */
+	private static function oneTimeChecks(): void {
+		if (self::$oneTimeChecksDone) {
+			return;
+		}
+
+		// Check for PHP SimpleXML extension earlier since we need it before our other checks and want to provide a useful hint for web users
+		// see https://github.com/nextcloud/server/pull/2619
+		if (!function_exists('simplexml_load_file')) {
+			throw new \OCP\HintException('The PHP SimpleXML/PHP-XML extension is not installed. Install the extension or make sure it is enabled.');
+		}
+
+		// Check whether the sample configuration has been copied
+		if (self::$config->getValue('copied_sample_config', false)) {
+			$l = Server::get(\OCP\L10N\IFactory::class)->get('lib');
+			Server::get(ITemplateManager::class)->printErrorPage(
+				$l->t('Sample configuration detected'),
+				$l->t('It has been detected that the sample configuration has been copied. This can break your installation and is unsupported. Please read the documentation before performing changes on config.php'),
+				503
+			);
+			return;
+		}
+
+		self::checkConfig();
+
+		self::$oneTimeChecksDone = true;
 	}
 
-	public static function init(): void {
+	/*
+	 * Called before each request served if the same worker serves several request
+	 */
+	public static function initForRequest(): void {
+		self::resetStaticProperties();
+
 		// First handle PHP configuration and copy auth headers to the expected
 		// $_SERVER variable before doing anything Server object related
-		self::setRequiredIniValues();
 		self::handleAuthHeaders();
 
 		// setup the basic server
 		self::$server = new \OC\Server(\OC::$WEBROOT, self::$config);
 		self::$server->boot();
 
+		self::oneTimeChecks();
+
 		$loaderStart = microtime(true);
 
+		$config = Server::get(IConfig::class);
+		$request = Server::get(IRequest::class);
+
 		try {
 			$profiler = new BuiltInProfiler(
-				Server::get(IConfig::class),
-				Server::get(IRequest::class),
+				$config,
+				$request,
 			);
 			$profiler->start();
 		} catch (\Throwable $e) {
@@ -751,10 +803,6 @@ public static function init(): void {
 			error_reporting(E_ALL);
 		}
 
-		// initialize intl fallback if necessary
-		OC_Util::isSetLocaleWorking();
-
-		$config = Server::get(IConfig::class);
 		if (!defined('PHPUNIT_RUN')) {
 			$errorHandler = new OC\Log\ErrorHandler(
 				Server::get(\Psr\Log\LoggerInterface::class),
@@ -778,12 +826,6 @@ public static function init(): void {
 
 		$eventLogger->start('init_session', 'Initialize session');
 
-		// Check for PHP SimpleXML extension earlier since we need it before our other checks and want to provide a useful hint for web users
-		// see https://github.com/nextcloud/server/pull/2619
-		if (!function_exists('simplexml_load_file')) {
-			throw new \OCP\HintException('The PHP SimpleXML/PHP-XML extension is not installed.', 'Install the extension or make sure it is enabled.');
-		}
-
 		$systemConfig = Server::get(\OC\SystemConfig::class);
 		$appManager = Server::get(\OCP\App\IAppManager::class);
 		if ($systemConfig->getValue('installed', false)) {
@@ -793,7 +835,6 @@ public static function init(): void {
 			self::initSession();
 		}
 		$eventLogger->end('init_session');
-		self::checkConfig();
 		self::checkInstalled($systemConfig);
 
 		if (!self::$CLI) {
@@ -887,26 +928,14 @@ public static function init(): void {
 		$lockProvider = Server::get(\OCP\Lock\ILockingProvider::class);
 		register_shutdown_function([$lockProvider, 'releaseAll']);
 
-		// Check whether the sample configuration has been copied
-		if ($systemConfig->getValue('copied_sample_config', false)) {
-			$l = Server::get(\OCP\L10N\IFactory::class)->get('lib');
-			Server::get(ITemplateManager::class)->printErrorPage(
-				$l->t('Sample configuration detected'),
-				$l->t('It has been detected that the sample configuration has been copied. This can break your installation and is unsupported. Please read the documentation before performing changes on config.php'),
-				503
-			);
-			return;
-		}
-
-		$request = Server::get(IRequest::class);
 		$host = $request->getInsecureServerHost();
 		/**
 		 * if the host passed in headers isn't trusted
 		 * FIXME: Should not be in here at all :see_no_evil:
 		 */
 		if (!OC::$CLI
 			&& !Server::get(\OC\Security\TrustedDomainHelper::class)->isTrustedDomain($host)
-			&& $config->getSystemValueBool('installed', false)
+			&& $config->getSystemValueBool('installed')
 		) {
 			// Allow access to CSS resources
 			$isScssRequest = false;
@@ -1332,4 +1361,40 @@ protected static function tryAppAPILogin(OCP\IRequest $request): bool {
 			return false;
 		}
 	}
+
+	/**
+	 * @internal
+	 */
+	private static function resetStaticProperties(): void {
+		// FIXME needed because these use a static var
+		\OC_Hook::clear();
+		\OC_Util::$styles = [];
+		\OC_Util::$headers = [];
+		\OC_User::setIncognitoMode(false);
+		\OC_User::$_setupedBackends = [];
+		\OC_App::reset();
+		\OC_Helper::reset();
+		Filesystem::reset();
+	}
+
+	/**
+	 * @internal
+	 */
+	public static function handleRequests(callable $handler): void {
+		if (function_exists('frankenphp_handle_request') && isset($_SERVER['FRANKENPHP_WORKER']) && $_SERVER['FRANKENPHP_WORKER'] === '1') {
+			$maxRequests = (int)($_SERVER['MAX_REQUESTS'] ?? 0);
+			for ($nbRequests = 0; !$maxRequests || $nbRequests < $maxRequests; ++$nbRequests) {
+				$keepRunning = \frankenphp_handle_request($handler);
+
+				// Call the garbage collector to reduce the chances of it being triggered in the middle of a page generation
+				gc_collect_cycles();
+
+				if (!$keepRunning) {
+					break;
+				}
+			}
+		} else {
+			$handler();
+		}
+	}
 }

lib/base.php

@@ -9,4 +9,4 @@
 require_once __DIR__ . '/OC.php';
 
 \OC::boot();
-\OC::init();
+\OC::initForRequest();