Throw specific exceptions for already invoked or invalid runtime (#1)

Co-authored-by: Daniel Smallwood <daniel.smallwood@ea.com>

Author: daniel-glu

src/BackgroundProcessing.php

@@ -20,6 +20,8 @@
 namespace CrowdStar\BackgroundProcessing;
 
 use Closure;
+use CrowdStar\BackgroundProcessing\Exception\AlreadyInvokedException;
+use CrowdStar\BackgroundProcessing\Exception\InvalidEnvironmentException;
 use CrowdStar\BackgroundProcessing\Timer\AbstractTimer;
 
 /**
@@ -47,17 +49,17 @@ class BackgroundProcessing
     /**
      * @param bool $stopTiming Stop timing the current transaction or not before starting processing tasks in background
      * @return void
-     * @throws Exception
+     * @throws AlreadyInvokedException|InvalidEnvironmentException
      */
     public static function run(bool $stopTiming = false)
     {
         if (self::isInvoked()) {
-            throw new Exception('background process invoked already');
+            throw new AlreadyInvokedException('background process invoked already');
         }
         self::setInvoked(true);
 
         if (!is_callable('fastcgi_finish_request')) {
-            throw new Exception('background process invokable under PHP-FPM only');
+            throw new InvalidEnvironmentException('background process invokable under PHP-FPM only');
         }
         session_write_close();
         fastcgi_finish_request();

src/Exception.php src/Exception/AlreadyInvokedException.phpsrc/Exception.php renamed to src/Exception/AlreadyInvokedException.php

@@ -17,13 +17,13 @@
 
 declare(strict_types=1);
 
-namespace CrowdStar\BackgroundProcessing;
+namespace CrowdStar\BackgroundProcessing\Exception;
 
 /**
  * Class Exception
  *
  * @package CrowdStar\BackgroundProcessing
  */
-class Exception extends \Exception
+class AlreadyInvokedException extends \Exception
 {
 }

src/Exception/InvalidEnvironmentException.php

@@ -0,0 +1,29 @@
+<?php
+/**************************************************************************
+ * Copyright 2018 Glu Mobile Inc.
+ *
+ * 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.
+ *************************************************************************/
+
+declare(strict_types=1);
+
+namespace CrowdStar\BackgroundProcessing\Exception;
+
+/**
+ * Class Exception
+ *
+ * @package CrowdStar\BackgroundProcessing
+ */
+class InvalidEnvironmentException extends \Exception
+{
+}

tests/unit/BasicTest.php

@@ -19,6 +19,8 @@
 
 namespace CrowdStar\BackgroundProcessing;
 
+use CrowdStar\BackgroundProcessing\Exception\AlreadyInvokedException;
+use CrowdStar\BackgroundProcessing\Exception\InvalidEnvironmentException;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -97,7 +99,7 @@ public static function dataRun(): array
     /**
      * @dataProvider dataRun
      * @covers BackgroundProcessing::run()
-     * @throws \CrowdStar\BackgroundProcessing\Exception
+     * @throws AlreadyInvokedException|InvalidEnvironmentException
      */
     public function testRun(int $expected, array $closures, string $message): void
     {
@@ -113,7 +115,7 @@ public function testRun(int $expected, array $closures, string $message): void
      */
     public function testRunWhenInvokedAlready(): void
     {
-        $this->expectException(Exception::class);
+        $this->expectException(AlreadyInvokedException::class);
         $this->expectExceptionMessage('background process invoked already');
 
         BackgroundProcessing::run();