Add option enable afterburner

inc/composer/class-command.php

@@ -49,13 +49,14 @@
 Run the local development server.
 
 Default command - start the local development server:
-	start [--xdebug=<mode>] [--mutagen] [--tmp]
+	start [--xdebug=<mode>] [--mutagen] [--tmp] [--afterburner]
 	                              --xdebug starts the server with xdebug enabled
 	                              optionally set the xdebug mode by assigning a value.
 	                              --mutagen will start the server using Mutagen
 	                              for file sharing.
 	                              --tmp will mount the PHP container's /tmp directory to
 	                              .tmp in your project directory. Useful with --xdebug=profile
+								  --afterburner starts the server with the Afterburner extension enabled
 Stop the local development server or specific service:
 	stop [<service>] [--clean]                passing --clean will also stop the proxy container
 Restart the local development server:
@@ -89,7 +90,8 @@
 			->addOption( 'xdebug', null, InputOption::VALUE_OPTIONAL, 'Start the server with Xdebug', 'debug' )
 			->addOption( 'mutagen', null, InputOption::VALUE_NONE, 'Start the server with Mutagen file sharing' )
 			->addOption( 'clean', null, InputOption::VALUE_NONE, 'Remove or stop the proxy container when destroying or stopping the server' )
-			->addOption( 'tmp', null, InputOption::VALUE_NONE, 'Mount the PHP container\'s /tmp directory to `.tmp` for debugging purposes' );
+			->addOption('tmp', null, InputOption::VALUE_NONE, 'Mount the PHP container\'s /tmp directory to `.tmp` for debugging purposes')
+			->addOption('afterburner', null, InputOption::VALUE_NONE, 'Start the server with the Afterburner extension enabled');
 	}
 
 	/**
@@ -131,6 +133,7 @@
 			'mutagen' => 'off',
 			'tmp' => false,
 			'secure' => static::get_composer_config()['secure'] ?? true,
+			'afterburner' => 'off',
 		];
 
 		// If Xdebug switch is passed add to docker compose args.
@@ -154,6 +157,11 @@
 			}
 		}
 
+		// If Afterburner switch is passed add to the docker composer args.
+		if ( $input->hasParameterOption( '--afterburner' ) ) {
+			$settings['afterburner'] = true;
+		}
+
 		// Refresh the docker-compose.yml file.
 		if ( in_array( $subcommand, [ null, 'start', 'restart' ], true ) ) {
 			$this->generate_docker_compose( $settings );

inc/composer/class-docker-compose-generator.php

@@ -1,17 +1,17 @@
 <?php
 /**
  * Local Server Docker Compose file generator.
  */
 
 namespace Altis\Local_Server\Composer;
 
 use Altis;
 use Symfony\Component\Yaml\Yaml;
 
 /**
  * Generates a docker compose file for Altis Local Server.
  */
 class Docker_Compose_Generator {
 
 	/**
 	 * The Docker Compose project name.
@@ -80,23 +80,23 @@
 	 * @param string $url The client facing URL.
 	 * @param array $args An optional array of arguments to modify the behaviour of the generator.
 	 */
 	public function __construct( string $root_dir, string $project_name, string $tld, string $url, array $args = [] ) {
 		$this->project_name = $project_name;
 		$this->bucket_name = "s3-{$this->project_name}";
 		$this->config_dir = dirname( __DIR__, 2 ) . '/docker';
 		$this->root_dir = $root_dir;
 		$this->tld = $tld;
 		$this->hostname = $this->tld ? $this->project_name . '.' . $this->tld : $this->project_name;
 		$this->url = $url;
 		$this->args = $args;
 	}
 
 	/**
 	 * Get the PHP server configuration.
 	 *
 	 * @return array
 	 */
 	protected function get_php_reusable() : array {
 		$version_map = [
 			'8.2' => 'humanmade/altis-local-server-php:8.2.5',
 			'8.1' => 'humanmade/altis-local-server-php:6.0.7',
@@ -105,9 +105,9 @@
 		];
 
 		$versions = array_keys( $version_map );
 		$version = (string) $this->get_config()['php'];
 
 		if ( ! in_array( $version, $versions, true ) ) {
 			echo sprintf(
 				"The configured PHP version \"%s\" is not supported.\nTry one of the following:\n  - %s\n",
 				// phpcs:ignore HM.Security.EscapeOutput.OutputNotEscaped
@@ -116,21 +116,25 @@
 				implode( "\n  - ", $versions )
 			);
 			exit( 1 );
 		}
 
 		$image = $version_map[ $version ];
 
 		$volumes = [
 			$this->get_app_volume(),
 			"{$this->config_dir}/php.ini:/usr/local/etc/php/conf.d/altis.ini",
 			'socket:/var/run/php-fpm',
 			'tmp:/tmp',
 		];
 
 		if ( $this->args['xdebug'] !== 'off' ) {
 			$volumes[] = "{$this->config_dir}/xdebug.ini:/usr/local/etc/php/conf.d/xdebug.ini";
 		}
 
+		if ($this->args['afterburner'] == true) {
+			$volumes[] = "{$this->config_dir}/afterburner.ini:/usr/local/etc/php/conf.d/afterburner.ini";
+		}
+
 		$services = [
 			'init' => true,
 			'depends_on' => [
@@ -165,8 +169,8 @@
 				'default',
 			],
 			'environment' => [
 				'HOST_PATH' => $this->root_dir,
 				'COMPOSE_PROJECT_NAME' => $this->hostname,
 				'DB_HOST' => 'db',
 				'DB_READ_REPLICA_HOST' => 'db-read-replica',
 				'DB_PASSWORD' => 'wordpress',
@@ -199,48 +203,48 @@
 					Command::is_linux() && ! Command::is_wsl() ? '172.17.0.1' : 'host.docker.internal'
 				),
 				'PHP_IDE_CONFIG' => "serverName={$this->hostname}",
 				'XDEBUG_SESSION' => $this->hostname,
 				// Set XDebug mode, fall back to "off" to avoid any performance hits.
 				'XDEBUG_MODE' => $this->args['xdebug'] ?? 'off',
 			],
 		];
 
 		if ( $this->get_config()['elasticsearch'] ) {
 			$services['depends_on']['elasticsearch'] = [
 				'condition' => 'service_healthy',
 			];
 		}
 
 		// Forward CI env var - set by Travis, Circle CI, GH Actions and more...
 		if ( getenv( 'CI' ) ) {
 			$services['environment']['CI'] = getenv( 'CI' );
 		}
 
 		return $services;
 	}
 
 	/**
 	 * Get the PHP container service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_php() : array {
 		return [
 			'php' => array_merge(
 				[
 					'container_name' => "{$this->project_name}-php",
 				],
 				$this->get_php_reusable()
 			),
 		];
 	}
 
 	/**
 	 * Webgrind service container for viewing Xdebug profiles.
 	 *
 	 * @return array
 	 */
 	protected function get_service_webgrind() : array {
 		return [
 			'webgrind' => [
 				'container_name' => "{$this->project_name}-webgrind",
@@ -269,14 +273,14 @@
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the Cavalcade service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_cavalcade() : array {
 		return [
 			'cavalcade' => array_merge(
 				[
@@ -287,18 +291,18 @@
 					'user' => 'nobody:nobody',
 					'restart' => 'unless-stopped',
 				],
 				$this->get_php_reusable()
 			),
 		];
 	}
 
 	/**
 	 * Get the nginx service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_nginx() : array {
 		$config = $this->get_config();
 		$domains = $config['domains'] ?? [];
 		$domains = $domains ? ',' . implode( ',', $domains ) : '';
 
@@ -314,7 +318,7 @@
 					'php',
 				],
 				'volumes' => [
 					$this->get_app_volume(),
 					'socket:/var/run/php-fpm',
 				],
 				'ports' => [
@@ -332,18 +336,18 @@
 					// Gzip compression now defaults to off to support Brotli compression via CloudFront.
 					'GZIP_STATUS' => 'on',
 					// Increase read response timeout when debugging.
 					'READ_TIMEOUT' => ( $this->args['xdebug'] ?? 'off' ) !== 'off' ? '9000s' : '60s',
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the Redis service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_redis() : array {
 		return [
 			'redis' => [
 				'image' => 'redis:7.0-alpine',
@@ -353,14 +357,14 @@
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the DB service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_db() : array {
 		return [
 			'db' => [
 				'image' => 'biarms/mysql:5.7',
@@ -394,14 +398,14 @@
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the Elasticsearch service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_elasticsearch() : array {
 		$mem_limit = getenv( 'ES_MEM_LIMIT' ) ?: '1g';
 
 		$version_map = [
@@ -412,9 +416,9 @@
 			'6.3' => 'humanmade/altis-local-server-elasticsearch:3.0.0',
 		];
 
 		$this->check_elasticsearch_version( array_keys( $version_map ) );
 
 		$image = $version_map[ $this->get_elasticsearch_version() ];
 
 		return [
 			'elasticsearch' => [
@@ -465,14 +469,14 @@
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the Kibana service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_kibana() : array {
 
 		$version_map = [
 			'7.10' => 'humanmade/altis-local-server-kibana:1.1.1',
@@ -482,14 +486,14 @@
 			'6.3' => 'blacktop/kibana:6.3',
 		];
 
 		$this->check_elasticsearch_version( array_keys( $version_map ) );
 
 		$image = $version_map[ $this->get_elasticsearch_version() ];
 
 		$yml_file = 'kibana.yml';
 		if ( version_compare( $this->get_elasticsearch_version(), '7', '>=' ) ) {
 			$yml_file = 'kibana-7.yml';
 		}
 
 		return [
 			'kibana' => [
@@ -518,14 +522,14 @@
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the S3 service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_s3() : array {
 		return [
 			's3' => [
 				'image' => 'minio/minio:RELEASE.2021-09-18T18-09-59Z',
@@ -593,14 +597,14 @@
 				'entrypoint' => "/bin/sh -c \"mc mb -p local/{$this->bucket_name} && mc policy set public local/{$this->bucket_name} && mc mirror --watch --overwrite -a local/{$this->bucket_name} /content\"",
 			],
 		];
 	}
 
 	/**
 	 * Get the Tachyon service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_tachyon() : array {
 		return [
 			'tachyon' => [
 				'image' => 'humanmade/tachyon:v2.6.0',
@@ -629,14 +633,14 @@
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the Mailhog service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_mailhog() : array {
 		return [
 			'mailhog' => [
 				'image' => 'cd2team/mailhog:latest',
@@ -660,14 +664,14 @@
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the Analytics services.
 	 *
 	 * @return array
 	 */
 	protected function get_service_analytics() : array {
 		return [
 			'cognito' => [
 				'container_name' => "{$this->project_name}-cognito",
@@ -711,14 +715,14 @@
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the XRay service.
 	 *
 	 * @return array
 	 */
 	protected function get_service_xray() : array {
 		return [
 			'xray' => [
 				'image' => 'amazon/aws-xray-daemon:3.3.3',
@@ -733,14 +737,14 @@
 				],
 			],
 		];
 	}
 
 	/**
 	 * Get the full docker compose configuration.
 	 *
 	 * @return array
 	 */
 	public function get_array() : array {
 		$services = array_merge(
 			$this->get_service_db(),
 			$this->get_service_redis(),
@@ -818,122 +822,136 @@
 			];
 		}
 
+		// Enable afterburner if requested.
+		if ($this->args['afterburner'] ?? false) {
+			$afterburner_config = <<<EOL
+				[Afterburner]
+				extension = afterburner.so
+				afterburner.redis_server_info = "redis://redis:6379"
+				afterburner.lru_cache_max_items = 1000
+				afterburner.redis_skip_server_check = yes
+
+				EOL;
+
+			file_put_contents("{$this->config_dir}/afterburner.ini", $afterburner_config);
+		}
+
 		// Handle mutagen volume according to args.
 		if ( ! empty( $this->args['mutagen'] ) && $this->args['mutagen'] === 'on' ) {
 			$config['volumes']['app'] = null;
 			$config['x-mutagen'] = [
 				'sync' => [
 					'app' => [
 						'alpha' => $this->root_dir,
 						'beta' => 'volume://app',
 						'configurationBeta' => [
 							'permissions' => [
 								'defaultOwner' => 'id:82',
 								'defaultGroup' => 'id:82',
 								'defaultFileMode' => '0664',
 								'defaultDirectoryMode' => '0775',
 							],
 						],
 						'mode' => 'two-way-resolved',
 					],
 				],
 			];
 			// Add ignored paths.
 			if ( ! empty( $this->get_config()['ignore-paths'] ) ) {
 				$config['x-mutagen']['sync']['app']['ignore'] = [
 					'paths' => array_values( (array) $this->get_config()['ignore-paths'] ),
 				];
 			}
 		}
 
 		return $config;
 	}
 
 	/**
 	 * Get Yaml output for config.
 	 *
 	 * @return string
 	 */
 	public function get_yaml() : string {
 		return Yaml::dump( $this->get_array(), 10, 2 );
 	}
 
 	/**
 	 * Get the Local Server config from composer.json.
 	 *
 	 * @return array
 	 */
 	protected function get_config() : array {
 		// Set the root directory required by Altis\get_config() if not available.
 		if ( ! defined( 'Altis\\ROOT_DIR' ) ) {
 			define( 'Altis\\ROOT_DIR', $this->root_dir );
 		}
 
 		$modules = Altis\get_config()['modules'] ?? [];
 
 		$analytics_enabled = $modules['analytics']['enabled'] ?? true;
 		$search_enabled = $modules['search']['enabled'] ?? true;
 
 		$defaults = [
 			's3' => $modules['cloud']['s3-uploads'] ?? true,
 			'tachyon' => $modules['media']['tachyon'] ?? true,
 			'analytics' => $analytics_enabled,
 			'cavalcade' => $modules['cloud']['cavalcade'] ?? true,
 			'elasticsearch' => ( $analytics_enabled || $search_enabled ) ? '7' : false,
 			'kibana' => ( $analytics_enabled || $search_enabled ),
 			'xray' => $modules['cloud']['xray'] ?? true,
 			'ignore-paths' => [],
 			'php' => '8.0',
 		];
 
 		return array_merge( $defaults, $modules['local-server'] ?? [] );
 	}
 
 	/**
 	 * Get the configured Elasticsearch version.
 	 *
 	 * @return int
 	 */
 	protected function get_elasticsearch_version() : string {
 		if ( ! empty( $this->get_config()['elasticsearch'] ) ) {
 			return (string) $this->get_config()['elasticsearch'];
 		}
 
 		return '7';
 	}
 
 	/**
 	 * Check the configured Elasticsearch version in config.
 	 *
 	 * @param array $versions List of available version numbers.
 	 * @return void
 	 */
 	protected function check_elasticsearch_version( array $versions ) {
 		$versions = array_map( 'strval', $versions );
 		rsort( $versions );
 		if ( in_array( $this->get_elasticsearch_version(), $versions, true ) ) {
 			return;
 		}
 
 		echo sprintf(
 			"The configured elasticsearch version \"%s\" is not supported.\nTry one of the following:\n  - %s\n",
 			// phpcs:ignore HM.Security.EscapeOutput.OutputNotEscaped
 			$this->get_elasticsearch_version(),
 			// phpcs:ignore HM.Security.EscapeOutput.OutputNotEscaped
 			implode( "\n  - ", $versions )
 		);
 		exit( 1 );
 	}
 
 	/**
 	 * Get the main application volume adjusted for sharing config options.
 	 *
 	 * @return string
 	 */
 	protected function get_app_volume() : string {
 		if ( ! empty( $this->args['mutagen'] ) && $this->args['mutagen'] === 'on' ) {
 			return 'app:/usr/src/app:delegated';
 		}
 		return "{$this->root_dir}:/usr/src/app:delegated";
 	}
 }