simplify event messaging and error handling

Author: modethirteen

src/CacheBuilder.php

@@ -17,6 +17,8 @@
 namespace modethirteen\FluentCache;
 
 use Closure;
+use Exception;
+use modethirteen\FluentCache\Exception\BuildException;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\SimpleCache\CacheException;
 use Psr\SimpleCache\CacheInterface;
@@ -102,34 +104,30 @@ public function get() {
             try {
                 $result = $key !== null ? $this->cache->get($key) : null;
             } catch(CacheException $e) {
-                $this->dispatch(
-                    (new Event(Event::CACHE_GET_ERROR))
-                        ->withException($e)
-                );
+                $this->dispatch((new Event(Event::CACHE_GET_ERROR))->withCacheException($e));
                 $result = null;
             }
-            if($result === null) {
-                $this->dispatch(new Event(Event::CACHE_GET_MISS));
-            } else {
+            $cacheValidator = $this->cacheValidator;
+            if($cacheValidator($result) === true) {
                 $this->dispatch(new Event(Event::CACHE_GET_HIT));
-                $cacheValidator = $this->cacheValidator;
-                if($cacheValidator($result) === true) {
-                    $this->dispatch(new Event(Event::CACHE_VALIDATION_SUCCESS));
-                    return $result;
-                }
-                $this->dispatch(new Event(Event::CACHE_VALIDATION_FAIL));
+                return $result;
             }
+            $this->dispatch(new Event(Event::CACHE_GET_MISS));
         }
         if($this->builder === null) {
             return null;
         }
         $this->dispatch(new Event(Event::BUILD_START));
         $builder = $this->builder;
-        $result = $builder();
-        $this->dispatch(new Event(Event::BUILD_STOP));
+        try {
+            $result = $builder();
+        } catch(Exception $e) {
+            $this->dispatch((new Event(Event::BUILD_ERROR))->withBuildException($e));
+            $result = null;
+        }
         $buildValidator = $this->buildValidator;
         if($buildValidator($result) === true) {
-            $this->dispatch(new Event(Event::BUILD_VALIDATION_SUCCESS));
+            $this->dispatch(new Event(Event::BUILD_SUCCESS));
 
             // the cache key used for setting a value may be different than the key used to get a value if upstream
             // ...dependencies and state have changed - to be safe, we regenerate the key
@@ -145,14 +143,11 @@ public function get() {
                         $this->dispatch(new Event(Event::CACHE_SET_FAIL));
                     }
                 } catch(CacheException $e) {
-                    $this->dispatch(
-                        (new Event(Event::CACHE_SET_ERROR))
-                            ->withException($e)
-                    );
+                    $this->dispatch((new Event(Event::CACHE_SET_ERROR))->withCacheException($e));
                 }
             }
         } else {
-            $this->dispatch(new Event(Event::BUILD_VALIDATION_FAIL));
+            $this->dispatch(new Event(Event::BUILD_FAIL));
         }
         return $result;
     }

src/Event.php

@@ -16,6 +16,7 @@
  */
 namespace modethirteen\FluentCache;
 
+use Exception;
 use Psr\EventDispatcher\StoppableEventInterface;
 use Psr\SimpleCache\CacheException;
 use Psr\SimpleCache\CacheInterface;
@@ -25,12 +26,10 @@ class Event extends \Symfony\Contracts\EventDispatcher\Event implements Stoppabl
     const CACHE_GET_ERROR = 'cache:get.error';
     const CACHE_GET_HIT = 'cache:get.hit';
     const CACHE_GET_MISS = 'cache:get.miss';
-    const CACHE_VALIDATION_SUCCESS = 'cache:validation.success';
-    const CACHE_VALIDATION_FAIL = 'cache:validation.fail';
     const BUILD_START = 'build:start';
-    const BUILD_STOP = 'build:stop';
-    const BUILD_VALIDATION_SUCCESS = 'build:validation.success';
-    const BUILD_VALIDATION_FAIL = 'build:validation.fail';
+    const BUILD_ERROR = 'build:error';
+    const BUILD_SUCCESS = 'build:success';
+    const BUILD_FAIL = 'build:fail';
     const CACHE_SET_START = 'cache:set.start';
     const CACHE_SET_ERROR = 'cache:set.error';
     const CACHE_SET_SUCCESS = 'cache:set.success';
@@ -46,10 +45,15 @@ class Event extends \Symfony\Contracts\EventDispatcher\Event implements Stoppabl
      */
     private $cacheType = null;
 
+    /**
+     * @var Exception|null
+     */
+    private $buildException = null;
+
     /**
      * @var CacheException|null
      */
-    private $exception = null;
+    private $cacheException = null;
 
     /**
      * @var string
@@ -63,6 +67,13 @@ public function __construct(string $message) {
         $this->message = $message;
     }
 
+    /**
+     * @return Exception|null
+     */
+    public function getBuildException() : ?Exception {
+        return $this->buildException;
+    }
+
     /**
      * @return string|null
      */
@@ -80,8 +91,8 @@ public function getCacheType() : ?string {
     /**
      * @return CacheException|null
      */
-    public function getException() : ?CacheException {
-        return $this->exception;
+    public function getCacheException() : ?CacheException {
+        return $this->cacheException;
     }
 
     /**
@@ -91,6 +102,16 @@ public function getMessage() : string {
         return $this->message;
     }
 
+    /**
+     * @param Exception $e
+     * @return static
+     */
+    public function withBuildException(Exception $e) : object {
+        $event = clone $this;
+        $event->buildException = $e;
+        return $event;
+    }
+
     /**
      * @param CacheInterface $cache
      * @param string|null $key
@@ -107,9 +128,9 @@ public function withCache(CacheInterface $cache, ?string $key = null) : object {
      * @param CacheException $e
      * @return static
      */
-    public function withException(CacheException $e) : object {
+    public function withCacheException(CacheException $e) : object {
         $event = clone $this;
-        $event->exception = $e;
+        $event->cacheException = $e;
         return $event;
     }
 }