added Universal Unique Identifier For errors.

arabcoders · arabcoders · commit f77461f03272 · 2017-04-15T16:22:37.000+03:00
diff --git a/src/Error.php b/src/Error.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors;
 
 use arabcoders\errors\Interfaces\ErrorInterface;
@@ -262,6 +263,7 @@ public function handleError( ErrorMapInterface $error ) : ErrorInterface
              ->setTrace( $this->tracer->setIgnore( [ __FILE__ ] )->process()->getTrace() )
              ->setMessage( $this->formatter->formatError( $error ) )
              ->setError( $error )
+             ->setId( $this->createUUID() )
              ->getInstance();
 
         if ( array_key_exists( $error->getNumber(), $this->listener ) )
@@ -292,6 +294,7 @@ public function handleException( \Throwable $exception ) : ErrorInterface
              ->setStructured( $this->getStructured()->setException( $exception )->process()->getStructured() )
              ->setTrace( $this->tracer->setContext( $exception->getTrace() )->setIgnore( [ __FILE__ ] )->process()->getTrace() )
              ->setMessage( $this->formatter->formatException( $exception ) )
+             ->setId( $this->createUUID() )
              ->getInstance();
 
         $name = get_class( $exception );
@@ -551,4 +554,34 @@ protected function setupDefault() : ErrorInterface
         return $this;
     }
 
+    /**
+     * Creates Universal Unique Identifier For Error.
+     *
+     * Implements UUIDv4.
+     *
+     * @return string
+     */
+    protected function createUUID() : string
+    {
+        $version = 4;
+
+        $hash = bin2hex( random_bytes( 16 ) );
+
+        return sprintf(
+            '%08s-%04s-%04x-%04x-%12s',
+            // 32 bits for "time_low"
+            substr( $hash, 0, 8 ),
+            // 16 bits for "time_mid"
+            substr( $hash, 8, 4 ),
+            // 16 bits for "time_hi_and_version",
+            // four most significant bits holds version number
+            ( hexdec( substr( $hash, 12, 4 ) ) & 0x0fff ) | $version << 12,
+            // 16 bits, 8 bits for "clk_seq_hi_res",
+            // 8 bits for "clk_seq_low",
+            // two most significant bits holds zero and one for variant DCE1.1
+            ( hexdec( substr( $hash, 16, 4 ) ) & 0x3fff ) | 0x8000,
+            // 48 bits for "node"
+            substr( $hash, 20, 12 )
+        );
+    }
 }
diff --git a/src/Interfaces/MapInterface.php b/src/Interfaces/MapInterface.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors\Interfaces;
 
 /**
@@ -62,6 +63,22 @@ public function setTrace( array $trace ) : MapInterface;
      */
     public function getTrace() : array;
 
+    /**
+     * Set Unique Id for error.
+     *
+     * @param string $id
+     *
+     * @return MapInterface
+     */
+    public function setId( string $id ) : MapInterface;
+
+    /**
+     * Get Unique Error Id.
+     *
+     * @return string
+     */
+    public function getId() : string;
+
     /**
      * Set message.
      *
diff --git a/src/Logging/File.php b/src/Logging/File.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors\Logging;
 
 use arabcoders\errors\Interfaces\MapInterface;
@@ -48,7 +49,7 @@ public function __construct( $file, string $mode = 'ab' )
      */
     public function process() : LoggingInterface
     {
-        $message = trim( '[' . gmdate( \DateTime::W3C ) . '] ' . $this->getMap()->getMessage() );
+        $message = trim( '[' . gmdate( \DateTime::W3C ) . '][' . $this->getMap()->getId() . '] ' . $this->getMap()->getMessage() );
         $trace   = $this->getMap()->getTrace();
 
         if ( $trace )
diff --git a/src/Logging/Remote.php b/src/Logging/Remote.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors\Logging;
 
 use arabcoders\errors\Interfaces\MapInterface;
@@ -60,6 +61,7 @@ public function process() : LoggingInterface
     {
         $this->async[] = $this->request->requestAsync( 'post', $this->server, [
             'form_params' => [
+                'id'         => $this->getMap()->getId(),
                 'message'    => $this->getMap()->getMessage(),
                 'trace'      => json_encode( $this->getMap()->getTrace() ),
                 'structured' => json_encode( $this->getMap()->getStructured() ),
diff --git a/src/Logging/Syslog.php b/src/Logging/Syslog.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors\Logging;
 
 use arabcoders\errors\Interfaces\ErrorInterface;
@@ -81,6 +82,11 @@ public function process() : LoggingInterface
 
         $message = $this->getMap()->getMessage();
 
+        if ( $this->getMap()->getId() )
+        {
+            $message .= ' REF [ ' . $this->getMap()->getId() . ' ]';
+        }
+
         if ( $this->getMap()->getStructured() )
         {
             $message .= PHP_EOL . print_r( $this->getMap()->getStructured(), true );
diff --git a/src/Map.php b/src/Map.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors;
 
 use arabcoders\errors\Interfaces\ErrorInterface;
@@ -35,6 +36,11 @@ class Map implements MapInterface
      */
     protected $message = '';
 
+    /**
+     * @var string Unique Error id.
+     */
+    protected $id = '';
+
     /**
      * @var int Error type {@see ErrorInterface::TYPE_ERROR} or {@see ErrorInterface::TYPE_EXCEPTION}
      */
@@ -118,6 +124,30 @@ public function getTrace() : array
         return $this->trace;
     }
 
+    /**
+     * Set Unique Id for error.
+     *
+     * @param string $id
+     *
+     * @return MapInterface
+     */
+    public function setId( string $id ) : MapInterface
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    /**
+     * Get Unique Error Id.
+     *
+     * @return string
+     */
+    public function getId() : string
+    {
+        return $this->id;
+    }
+
     /**
      * Set message.
      *
@@ -264,6 +294,7 @@ public function clear() : MapInterface
         $this->trace        = [];
         $this->structured   = [];
         $this->message      = '';
+        $this->id           = '';
         $this->type         = 0;
         $this->errorMap     = null;
         $this->exceptionMap = null;
diff --git a/src/Output/Basic.php b/src/Output/Basic.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors\Output;
 
 use arabcoders\errors\Interfaces\MapInterface;
@@ -43,6 +44,11 @@ public function display() : OutputInterface
 
         print self::MSG;
 
+        if ( $this->getMap()->getId() )
+        {
+            echo PHP_EOL . sprintf( 'Unique Error Id: %s', $this->getMap()->getId() );
+        }
+
         return $this;
     }
 
diff --git a/src/Output/CLI.php b/src/Output/CLI.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors\Output;
 
 use arabcoders\errors\Interfaces\MapInterface;
@@ -36,7 +37,16 @@ public function display() : OutputInterface
             define( 'STDERR', fopen( 'php://stderr', 'w' ) );
         }
 
-        fwrite( STDERR, $this->getMap()->getMessage() . PHP_EOL );
+        $message = $this->getMap()->getMessage();
+
+        if ( $this->getMap()->getId() )
+        {
+            $message .= sprintf( ' - REF [ %s ]', $this->getMap()->getId() );
+        }
+
+        $message .= PHP_EOL;
+
+        fwrite( STDERR, $message );
 
         return $this;
     }
diff --git a/src/Output/HTML.php b/src/Output/HTML.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors\Output;
 
 use arabcoders\errors\Interfaces\ErrorInterface;
@@ -42,6 +43,7 @@ public function display() : OutputInterface
         $string .= '<title>Error Page</title>';
         $string .= '<meta name="viewport" content="width=device-width, initial-scale=1.0"></head><body>';
         $string .= '<h1>An %s has Occurred</h1><blockquote>%s</blockquote>%s%s';
+        $string .= '<h2>Unique Error ID</h2><blockquote>%s</blockquote>';
         $string .= '</body></html>';
 
         if ( $this->getMap()->getTrace() )
@@ -72,7 +74,7 @@ public function display() : OutputInterface
 
         $type = ( ErrorInterface::TYPE_ERROR === $this->getMap()->getType() ) ? 'Error' : 'Exception';
 
-        print sprintf( $string, $type, $this->escapeString( $this->getMap()->getMessage() ), $structured, $trace );
+        print sprintf( $string, $type, $this->escapeString( $this->getMap()->getMessage() ), $structured, $trace, $this->getMap()->getId() );
 
         return $this;
     }
diff --git a/src/Output/Twig.php b/src/Output/Twig.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace arabcoders\errors\Output;
 
 use arabcoders\errors\Interfaces\ErrorInterface;
@@ -80,6 +81,7 @@ public function display() : OutputInterface
             'className'  => $type ?? null,
             'type'       => $this->getMap()->getType(),
             'message'    => $this->getMap()->getMessage(),
+            'UNIQUE_ID'  => $this->getMap()->getId(),
             'trace'      => ( !empty( $trace ) ) ? json_encode( $trace, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT ) : null,
             'structured' => ( !empty( $structured ) ) ? json_encode( $structured, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT ) : null,
         ] );
diff --git a/tests/MapTest.php b/tests/MapTest.php
@@ -189,4 +189,25 @@ public function testGetException()
         $this->assertInstanceOf( \Throwable::class, $map->getException() );
     }
 
+    public function testSetId()
+    {
+        $map = new Map();
+
+        $this->assertEquals( $map, $map->setId( sha1( random_bytes( 16 ) ) ) );
+
+        $this->expectException( \TypeError::class );
+
+        $map->setMessage( [] );
+    }
+
+    public function testGetId()
+    {
+        $map = new Map();
+
+        $id = sha1( random_bytes( 16 ) );
+
+        $this->assertEquals( '', $map->getId() );
+        $this->assertEquals( $id, $map->setId( $id )->getId() );
+    }
+
 }
diff --git a/tests/StructuredTest.php b/tests/StructuredTest.php
@@ -86,7 +86,7 @@ public function testGetStructuredReturn()
                 'message' => $e->getMessage(),
             ],
             'request'   => [
-                'domain' => strtolower( $_SERVER['HTTP_HOST'] ?? 'localhost' ),
+                'domain' => strtolower( $_SERVER['HTTP_SERVER'] ?? $_SERVER['HTTP_HOST'] ?? null ),
                 'method' => $_SERVER['REQUEST_METHOD'] ?? null,
                 'uri'    => $_SERVER['REQUEST_URI'] ?? $_SERVER['PHP_SELF'] ?? null,
                 'refer'  => $_SERVER['HTTP_REFERER'] ?? null,
