Introduced new error and success handlers

Author: bastianschwarz

packages/async/src/AsyncCheckCollection.php

@@ -19,10 +19,9 @@
 namespace de\codenamephp\deploymentchecks\async;
 
 use de\codenamephp\deploymentchecks\base\Check\CheckInterface;
-use de\codenamephp\deploymentchecks\base\Result\ResultCollection;
+use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollection;
 use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
 use Spatie\Async\Pool;
-use Spatie\Fork\Fork;
 use Throwable;
 
 final readonly class AsyncCheckCollection implements CheckInterface {
@@ -40,10 +39,10 @@ public function run() : ResultInterface {
     $result = new ResultCollection();
     foreach($this->checks as $check) {
       $parallelCheck = new ParallelCheck($check);
-      $this->pool
+      $runnable = $this->pool
         ->add($parallelCheck)
-        ->then(static fn($output) => $parallelCheck->success($result, $output))
-        ->catch(fn(Throwable $exception) => $parallelCheck->error($result, $exception));
+        ->then(static fn(ResultInterface $output) => $parallelCheck->successHandler()->handle($result, $output));
+      if($parallelCheck instanceof WithErrorHandlerInterface) $runnable->catch(static fn(Throwable $exception) => $parallelCheck->errorHandler()->handle($result, $exception));
     }
     $this->pool->wait();
     return $result;

packages/async/src/ErrorHandler/ErrorHandlerInterface.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\async\ErrorHandler;
+
+use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollectionInterface;
+use Throwable;
+
+/**
+ * Interface for a simple error handler. It expects the result collection build in the async collection and the exception that was thrown.
+ */
+interface ErrorHandlerInterface {
+
+  public function handle(ResultCollectionInterface $resultCollection, Throwable $exception) : mixed;
+}

packages/async/src/ErrorHandler/RethrowException.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\async\ErrorHandler;
+
+use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollectionInterface;
+use Throwable;
+
+/**
+ * Just rethrows the exception
+ */
+final class RethrowException implements ErrorHandlerInterface {
+
+  public function handle(ResultCollectionInterface $resultCollection, Throwable $exception) : mixed {
+    throw $exception;
+  }
+
+}

packages/async/src/ParallelCheck.php

@@ -17,37 +17,30 @@
 
 namespace de\codenamephp\deploymentchecks\async;
 
-use Closure;
+use de\codenamephp\deploymentchecks\async\ErrorHandler\ErrorHandlerInterface;
+use de\codenamephp\deploymentchecks\async\ErrorHandler\RethrowException;
+use de\codenamephp\deploymentchecks\async\SuccessHandler\AddToResultCollection;
+use de\codenamephp\deploymentchecks\async\SuccessHandler\SuccessHandlerInterface;
 use de\codenamephp\deploymentchecks\base\Check\CheckInterface;
-use de\codenamephp\deploymentchecks\base\Result\ResultCollection;
 use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
-use Laravel\SerializableClosure\SerializableClosure;
-use Throwable;
 
-final class ParallelCheck {
-
-  public readonly SerializableClosure $successCallback;
-
-  public readonly SerializableClosure $errorCallback;
+final readonly class ParallelCheck implements ParallelCheckInterface, WithErrorHandlerInterface {
 
   public function __construct(
-    public readonly CheckInterface $check,
-    Closure|callable $successCallback = null,
-    Closure|callable $errorCallback = null
-  ) {
-    $this->successCallback = new SerializableClosure($successCallback ?? static fn(ResultCollection $resultCollection, ResultInterface $result) => $resultCollection->add($result));
-    $this->errorCallback = new SerializableClosure($errorCallback ?? static fn(ResultCollection $resultCollection, Throwable $exception) => throw $exception);
-  }
+    public CheckInterface $check,
+    public ?SuccessHandlerInterface $successHandler = new AddToResultCollection(),
+    public ?ErrorHandlerInterface $errorHandler = new RethrowException(),
+  ) {}
 
   public function __invoke() : ResultInterface {
     return $this->check->run();
   }
 
-  public function success(ResultCollection $resultCollection, ResultInterface $result) : mixed {
-    return ($this->successCallback)($resultCollection, $result);
+  public function successHandler() : SuccessHandlerInterface {
+    return $this->successHandler;
   }
 
-  public function error(ResultCollection $resultCollection, Throwable $exception) : mixed {
-    return ($this->errorCallback)($resultCollection, $exception);
+  public function errorHandler() : ErrorHandlerInterface {
+    return $this->errorHandler;
   }
 }

packages/async/src/ParallelCheckInterface.php

@@ -0,0 +1,41 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\async;
+
+use de\codenamephp\deploymentchecks\async\SuccessHandler\SuccessHandlerInterface;
+use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+
+/**
+ * Interface for checks that can be used in parallel using the async pool
+ */
+interface ParallelCheckInterface {
+
+  /**
+   * Since the async pool only accepts callables, this method is used to invoke the check and return the result
+   *
+   * @return ResultInterface
+   */
+  public function __invoke() : ResultInterface;
+
+  /**
+   * Gets the success handler that is used to handle the result if the check was successful
+   *
+   * @return SuccessHandlerInterface
+   */
+  public function successHandler() : SuccessHandlerInterface;
+}

packages/async/src/SuccessHandler/AddToResultCollection.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\async\SuccessHandler;
+
+use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollectionInterface;
+use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+
+/**
+ * Just adds the result to the collection
+ */
+final class AddToResultCollection implements SuccessHandlerInterface {
+
+  public function handle(ResultCollectionInterface $resultCollection, ResultInterface $result) : ResultInterface {
+    $resultCollection->add($result);
+    return $result;
+  }
+}

packages/async/src/SuccessHandler/SuccessHandlerInterface.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\async\SuccessHandler;
+
+use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollectionInterface;
+use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+
+/**
+ * Interface for parallel checks that want to define a custom success handler
+ */
+interface SuccessHandlerInterface {
+
+  public function handle(ResultCollectionInterface $resultCollection, ResultInterface $result) : ResultInterface;
+}

packages/async/src/WithErrorHandlerInterface.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\async;
+
+use de\codenamephp\deploymentchecks\async\ErrorHandler\ErrorHandlerInterface;
+
+/**
+ * Interface for parallel checks that want to define a custom error handler
+ */
+interface WithErrorHandlerInterface {
+
+  public function errorHandler() : ErrorHandlerInterface;
+}