Support atomic deployment using symlink #81

Author: harai

.github/workflows/build.yml

@@ -15,7 +15,6 @@ jobs:
     strategy:
       matrix:
         php-version:
-        - '8.0'
         - '8.1'
         - '8.2'
         - '8.3'

bin/cavalcade-runner

@@ -8,12 +8,13 @@ use Throwable;
 
 include dirname(__DIR__) . '/autoload.php';
 
-$options = getopt('l:p:b:w:c:i:d:e:k:z:s:q:');
+$options = getopt('l:p:b:w:c:f:i:d:e:k:z:s:q:');
 $log_path = $options['l'] ?? '/var/log/wp/cron.log';
 $pid_file = $options['p'] ?? '/run/cavalcade-runner/cavalcade-runner.pid';
 $wp_base_path = $options['b'] ?? '/var/web/wp';
 $max_workers_count = intval($options['w'] ?? 2);
 $wpcli_path = $options['c'] ?? '/usr/local/bin/wp';
+$wpconfig_path = $options['f'];
 $cleanup_interval = intval($options['i'] ?? 60);
 $cleanup_delay = intval($options['d'] ?? 24 * 60 * 60);
 $healthcheck_option = $options['e'];
@@ -64,6 +65,7 @@ try {
         $pdoclass,
         $max_workers_count,
         $wpcli_path,
+        $wpconfig_path,
         $cleanup_interval,
         $cleanup_delay,
         $wp_base_path,

bin/create-table

@@ -9,8 +9,6 @@ include dirname(__DIR__) . '/autoload.php';
 
 date_default_timezone_set('UTC');
 $log = Logger::create('work/log/create-table.log');
-$wpcli_path = '/usr/local/bin/wp';
-$wp_path = '/var/web/wp';
 
 set_error_handler(function ($errno, $errstr, $errfile, $errline) use ($log) {
   // error was suppressed with the @-operator

build/cavalcade-runner/restarter

@@ -5,7 +5,7 @@ set -eu
 ctrl_fifo=work/runner_ctrl.fifo
 ctrl_done_fifo=work/runner_ctrl_done.fifo
 
-runner_command='bin/cavalcade-runner-test -l work/log/cavalcade-runner.log -p work/cavalcade-runner.pid -b /www -w 10 -i 2 -d 6 -e 192.0.2.255,5,/www/.maintenance -k work/runner.lock -s work/log/runner-state.json -z 2000 -q inc/healthcheck-test.php'
+runner_command='bin/cavalcade-runner-test -l work/log/cavalcade-runner.log -p work/cavalcade-runner.pid -b /www -f /www/wp-config.php -w 10 -i 2 -d 6 -e 192.0.2.255,5,/www/.maintenance -k work/runner.lock -s work/log/runner-state.json -z 2000 -q inc/healthcheck-test.php'
 
 mkdir -p work
 mkfifo "$ctrl_fifo" "$ctrl_done_fifo"

inc/class-runner.php

@@ -27,7 +27,8 @@ class Runner
     protected $pdoclass;
     protected $db;
     protected $workers = [];
-    protected $wp_path;
+    protected $wp_base_path;
+    protected $wpconfig_path;
     protected $table_prefix;
     protected $table;
     protected $state;
@@ -40,6 +41,7 @@ public function __construct(
         $pdoclass,
         $max_workers,
         $wpcli_path,
+        $wpconfig_path,
         $cleanup_interval,
         $cleanup_delay,
         $wp_base_path,
@@ -49,9 +51,10 @@ public function __construct(
         $this->pdoclass = $pdoclass;
         $this->max_workers = $max_workers;
         $this->wpcli_path = $wpcli_path;
+        $this->wpconfig_path = $wpconfig_path;
         $this->cleanup_interval = $cleanup_interval;
         $this->cleanup_delay = $cleanup_delay;
-        $this->wp_path = realpath($wp_base_path);
+        $this->wp_base_path = $wp_base_path;
         $this->max_log_size = $max_log_size;
         $this->state_path = $state_path;
         $this->hooks = new Hooks();
@@ -68,6 +71,7 @@ public static function instance(
         $pdoclass,
         $max_workers,
         $wpcli_path,
+        $wpconfig_path,
         $cleanup_interval,
         $cleanup_delay,
         $wp_base_path,
@@ -80,6 +84,7 @@ public static function instance(
                 $pdoclass,
                 $max_workers,
                 $wpcli_path,
+                $wpconfig_path,
                 $cleanup_interval,
                 $cleanup_delay,
                 $wp_base_path,
@@ -126,15 +131,8 @@ public function bootstrap()
     {
         $this->load_state();
 
-        $config_path = $this->wp_path . '/wp-config.php';
-        if (!file_exists($config_path)) {
-            $config_path = realpath($this->wp_path . '/../wp-config.php');
-            if (!file_exists($config_path)) {
-                throw new Exception(sprintf(
-                    'Could not find config file at %s',
-                    $this->wp_path . '/wp-config.php or next level up.'
-                ));
-            }
+        if (!file_exists($this->wpconfig_path)) {
+            throw new Exception('Could not find config file at ' . $this->wpconfig_path);
         }
 
         // Load configuration ONLY
@@ -143,7 +141,7 @@ public function bootstrap()
             $_SERVER['HTTP_HOST'] = 'cavalcade.example';
         }
 
-        include $config_path;
+        include $this->wpconfig_path;
         $this->table_prefix = isset($table_prefix) ? $table_prefix : 'wp_';
         $this->table = $this->table_prefix . 'cavalcade_jobs';
         $charset = defined('DB_CHARSET') ? DB_CHARSET : 'utf8mb4';
@@ -528,11 +526,6 @@ protected function terminate($type)
         unset($this->db);
     }
 
-    public function get_wp_path()
-    {
-        return $this->wp_path;
-    }
-
     protected function get_next_job()
     {
         // $this->log->debug('trying to get next job');
@@ -592,7 +585,15 @@ protected function run_job($job)
                 1 => ['pipe', 'w'], // stdout
                 2 => ['pipe', 'w'], // stderr
             ];
-            $process = proc_open($command, $spec, $pipes, $this->wp_path);
+
+            // Resolve path every time to support atomic deployment.
+            $wp_path = realpath($this->wp_base_path);
+            if ($wp_path === false) {
+                $this->log->error('failed to resolve path: ' . $this->wp_base_path);
+                throw new Exception('failed to resolve path');
+            }
+
+            $process = proc_open($command, $spec, $pipes, $wp_path);
 
             if ($process === false) {
                 throw new Exception('unable to proc_open()');