Merge pull request #975 from catalyst/973-bump-symphony-version

Issue #973: Update vendor files to latest available for PHP8.1

Author: dmitriim

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
       codechecker_max_warnings: 0 # CI should now fail on phpcs / code checker warnings.
       disable_behat: true
       disable_grunt: true
-      min_php: 7.4
+      min_php: 8.1
       extra_plugin_runners: |
           sudo sed -i 's/azure\.//' /etc/apt/sources.list
           sudo apt-get update

Dockerfile

@@ -0,0 +1,5 @@
+FROM moodlehq/moodle-php-apache:8.1
+COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
+
+WORKDIR /code
+CMD ["composer", "update", "--no-dev"]

UPGRADING.md

@@ -0,0 +1,5 @@
+# Upgrading
+There has been a `Dockerfile` and `docker-compose.yaml` added to allow running composer update consistently without relying on local configuration of php.
+
+To run an upgrade running `docker compose up` will start the container and run `composer update --no-dev`. You can then commit the result with the updated `vendor` folder and updated `composer.lock` file.
+

classes/local/execution/engine.php

@@ -20,8 +20,10 @@
 use Monolog\Handler\BrowserConsoleHandler;
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Handler\StreamHandler;
+use Monolog\LogRecord;
+use Monolog\Logger;
+use Monolog\Level;
 use Monolog\Processor\PsrLogMessageProcessor;
-use Symfony\Bridge\Monolog\Logger;
 use tool_dataflows\dataflow;
 use tool_dataflows\exportable;
 use tool_dataflows\helper;
@@ -353,7 +355,7 @@ public function initialise() {
         // Register signal handler - if a signal caused the dataflow to stop.
         \core_shutdown_manager::register_signal_handler(function ($signo){
             $error = error_get_last();
-            $this->logger->log(Logger::NOTICE, 'Engine: shutdown signal ({signo}) received', [
+            $this->logger->log(Level::Notice, 'Engine: shutdown signal ({signo}) received', [
                 'signo' => $signo,
                 'lasterror' => $error,
             ]);
@@ -362,12 +364,12 @@ public function initialise() {
 
         // Register shutdown handler - if request is ended by client, abort and finalise flow.
         \core_shutdown_manager::register_function(function (){
-            $this->logger->log(Logger::DEBUG, 'Engine: shutdown handler was called');
+            $this->logger->log(Level::Debug, 'Engine: shutdown handler was called');
 
             // If the script has stopped and flow is not finalised then abort.
             if (!in_array($this->status, [self::STATUS_FINALISED, self::STATUS_ABORTED])) {
                 $error = error_get_last();
-                $this->logger->log(Logger::ERROR, 'Engine: shutdown happened abruptly', ['lasterror' => $error]);
+                $this->logger->log(Level::Error, 'Engine: shutdown happened abruptly', ['lasterror' => $error]);
                 $this->set_status(self::STATUS_ABORTED);
 
                 $notifyreason = new \Exception('Shutdown handler triggered abort. Last error: ' . $error);
@@ -568,7 +570,7 @@ public function abort(?\Throwable $reason = null) {
                 $context = [];
             }
         }
-        $this->log('Engine: aborting steps', $message ? array_merge(['reason' => $message], $context) : [], Logger::NOTICE);
+        $this->log('Engine: aborting steps', $message ? array_merge(['reason' => $message], $context) : [], Level::Notice);
         $this->exception = $reason;
         foreach ($this->enginesteps as $enginestep) {
             $status = $enginestep->status;
@@ -611,7 +613,7 @@ public function abort(?\Throwable $reason = null) {
      * @param mixed $context
      * @param mixed $level
      */
-    public function log(string $message, $context = [], $level = Logger::INFO) {
+    public function log(string $message, $context = [], $level = Level::Info) {
         $this->logger->log($level, $message, $context);
     }
 
@@ -683,9 +685,9 @@ public function set_status(int $status) {
             'status' => get_string('engine_status:'.self::STATUS_LABELS[$this->status], 'tool_dataflows'),
         ];
 
-        $level = Logger::INFO;
+        $level = Level::Info;
         if (in_array($status, self::STATUS_TERMINATORS, true)) {
-            $level = Logger::NOTICE;
+            $level = Level::Notice;
             $context['export'] = $this->get_export_data();
         }
         $this->logger->log($level, "Engine: dataflow '{status}'", $context);
@@ -774,6 +776,7 @@ public function set_current_step(?engine_step $step) {
      */
     private function setup_logging() {
         global $CFG;
+
         // Initalise a new run (only for non-dry runs). This should only be
         // created when the engine is executed.
         $channel = 'dataflow/' . $this->dataflow->id;
@@ -794,15 +797,17 @@ private function setup_logging() {
         $log->pushProcessor(new PsrLogMessageProcessor(null, true));
 
         // Ensure step names are used if supplied.
-        $log->pushProcessor(function ($record) {
+        $log->pushProcessor(function (LogRecord $record): LogRecord {
+            $context = $record->context;
+            $message = $record->message;
             if (isset($this->currentstep)) {
-                $record['context']['step'] = $this->currentstep->name;
+                $context['step'] = $this->currentstep->name;
             }
 
-            if (isset($record['context']['step'])) {
-                $record['message'] = '{step}: ' . $record['message'];
+            if (isset($context['step'])) {
+                $message = '{step}: ' . $message;
             }
-            return $record;
+            return $record->with(message: $message, context: $context);
         });
 
         // Tweak the default datetime output to include microseconds.
@@ -835,7 +840,7 @@ private function setup_logging() {
             $dataflowrunlogpath = $CFG->dataroot . DIRECTORY_SEPARATOR .
                 'tool_dataflows' . DIRECTORY_SEPARATOR .
                 $this->dataflow->id . DIRECTORY_SEPARATOR .
-                $rundateformat . '_' . $this->run->name . '.log';
+                $rundateformat . '_' . ($this->run->name ?? 'dry') . '.log';
 
             $streamhandler = new StreamHandler($dataflowrunlogpath, $minloglevel);
             $streamhandler->setFormatter($lineformatter);
@@ -878,7 +883,7 @@ public function notify_on_abort(?\Throwable $reason) {
                 continue;
             }
 
-            $this->log('Sending abort notification email.', [], Logger::NOTICE);
+            $this->log('Sending abort notification email.', [], Level::Notice);
             $context = [
                 'flowname' => $this->dataflow->get('name'),
                 'run' => $this->run->get('id'),

classes/local/execution/logging/mtrace_handler.php

@@ -17,6 +17,7 @@
 namespace tool_dataflows\local\execution\logging;
 
 use Monolog\Handler\AbstractProcessingHandler;
+use Monolog\LogRecord;
 
 /**
  * An environment for logging information about dataflow execution.
@@ -31,24 +32,24 @@ class mtrace_handler extends AbstractProcessingHandler {
     /**
      * Default handler for Moodle.
      *
-     * @param array $record the log record
+     * @param LogRecord $record the log record
      * @return bool
      **/
-    public function handle(array $record): bool {
+    public function handle(LogRecord $record): bool {
         if ($this->isHandling($record)) {
             $record['formatted'] = trim($this->getFormatter()->format($record));
             $this->write($record);
             return true;
         }
-        return $this->handler->handle($record);
+        return $this->handle($record);
     }
 
     /**
      * Writes the record down to the log of the implementing handler
      *
-     * @param  array $record
+     * @param  LogRecord $record
      */
-    protected function write(array $record): void {
+    protected function write(LogRecord $record): void {
         mtrace($record['formatted']);
     }
 }

composer.json

@@ -1,13 +1,13 @@
 {
     "config": {
         "platform": {
-            "php": "7.4"
+            "php": "8.1"
         }
     },
     "require": {
-        "php": ">=7.4",
-        "symfony/yaml": "^4.0",
-        "symfony/expression-language": "^3.4",
+        "php": ">=8.1",
+        "symfony/yaml": "^6.0",
+        "symfony/expression-language": "^6.0",
         "phpseclib/phpseclib": "~3.0",
         "symfony/monolog-bundle": "^3.6"
     }