add finally

Author: cesargb

src/ErrorHandler.php

@@ -9,6 +9,8 @@ trait ErrorHandler
 {
     private $catchCallable = null;
 
+    protected $finallyCallback = null;
+
     private ?string $_filename = null;
 
     /**
@@ -28,6 +30,8 @@ protected function setFilename(string $filename): void
 
     protected function exception(Throwable $exception): self
     {
+        $this->finished($this->_filename, $exception->getMessage());
+
         if ($this->catchCallable) {
             call_user_func($this->catchCallable, $this->convertException($exception));
         } else {
@@ -37,6 +41,15 @@ protected function exception(Throwable $exception): self
         return $this;
     }
 
+    protected function finished(string $filenameSource, string $message): void
+    {
+        if (is_null($this->finallyCallback)) {
+            return;
+        }
+
+        call_user_func($this->finallyCallback, $message, $filenameSource);
+    }
+
     private function convertException(Throwable $exception): RotationFailed
     {
         return new RotationFailed(

src/Rotation.php

@@ -32,6 +32,7 @@ public function __construct(array $options = [])
             'files',
             'then',
             'catch',
+            'finally',
         ]);
 
         $this->options($options);
@@ -99,6 +100,16 @@ public function then(callable $callable): self
         return $this;
     }
 
+    /**
+     * Function that will be executed when the process was finished.
+     */
+    public function finally(callable $callable): self
+    {
+        $this->finallyCallback = $callable;
+
+        return $this;
+    }
+
     /**
      * Rotate file.
      *
@@ -174,6 +185,8 @@ private function sucessfull(string $filenameSource, ?string $filenameRotated): v
         }
 
         call_user_func($this->thenCallback, $filenameRotated, $filenameSource);
+
+        $this->finished($filenameRotated, 'sucessfull');
     }
 
     /**
@@ -182,6 +195,7 @@ private function sucessfull(string $filenameSource, ?string $filenameRotated): v
     private function canRotate(string $filename): bool
     {
         if (!file_exists($filename)) {
+            $this->finished($filename, sprintf('the file %s not exists.', $filename));
             return false;
         }
 

tests/OptionTest.php

@@ -15,6 +15,7 @@ public function testPassOptions()
             'truncate' => false,
             'then' => function ($filename) {},
             'catch' => function ($error) {},
+            'finally' => function ($message) {},
         ]);
 
         $this->assertNotNull($rotation);

tests/test_load/run.php

@@ -0,0 +1,63 @@
+<?php
+
+use Cesargb\Log\Rotation;
+
+function app_path(string $path = '/'): string
+{
+    return dirname(__FILE__).$path;
+}
+
+function clean()
+{
+    $files = glob(app_path('/file.log*'));
+
+    foreach ($files as $file) {
+        if (is_file($file)) {
+            unlink($file);
+        }
+    }
+}
+
+function writeLogInBackground(): string
+{
+    $pid = exec('php '.app_path('/writelog.php').' > /dev/null 2>&1 & echo $!');
+
+    sleep(1);
+
+    return $pid;
+}
+
+include app_path('/../../vendor/autoload.php');
+
+clean();
+
+$pid = writeLogInBackground();
+posix_kill($pid, SIGKILL);
+
+$pid = writeLogInBackground();
+
+$rotation = new Rotation();
+
+if (!$rotation->compress()->rotate(app_path('/file.log'))) {
+    echo "Failed rotation\n";
+}
+
+sleep(1);
+
+posix_kill($pid, SIGKILL);
+
+$lastSave = exec('tail -n 1 '.app_path('/file.log.1'));
+$firstNew = exec('head -n 1 '.app_path('/file.log'));
+
+clean();
+
+$dataLost = $firstNew - ($lastSave + 1);
+
+if ($dataLost === 0) {
+    echo "OK, no data lossed\n";
+
+    exit(0);
+} else {
+    echo "Warning, $dataLost data lossed\n";
+    exit($dataLost);
+}

tests/test_load/writelog.php

@@ -0,0 +1,13 @@
+<?php
+
+function app_path(string $path = '/'): string
+{
+    return dirname(__FILE__).$path;
+}
+
+$n = 0;
+
+while (true) {
+    ++$n;
+    file_put_contents(app_path('/file.log'), $n."\n", FILE_APPEND);
+}