initial commit

Author: gilbok

.gitignore

@@ -0,0 +1,7 @@
+*.lock
+package.xml
+/vendor
+.idea
+.php_cs.cache
+docs/_build
+.phpunit.result.cache

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "mamikos/tikus",
+    "description": "An abstract layer for remote error reporting",
+    "keywords": ["mamikos", "tikus"],
+    "license": "MIT",
+    "type": "project",
+    "require": {
+        "php": "^7.4",
+        "bugsnag/bugsnag-laravel": "^2.0",
+        "sentry/sentry-laravel": "^2.12"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.5",
+        "mockery/mockery": "^1.5"
+    },
+    "autoload": {
+        "psr-4": {
+            "Mamikos\\Tikus\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
+    "config": {
+        "optimize-autoloader": true,
+        "sort-packages": true
+    }
+}

phpunit.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="true"
+         stopOnError="false"
+         stopOnFailure="false"
+         verbose="true"         
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Facades/TikusFacade.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Mamikos\Tikus\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+class TikusFacade extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return 'tikus';
+    }
+}

src/Providers/TikusServiceProvider.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Mamikos\Tikus\Providers;
+
+use Mamikos\Tikus\Tikus;
+use Illuminate\Support\ServiceProvider;
+
+class TikusServiceProvider extends ServiceProvider
+{
+    public function register()
+    {
+        $this->app->singleton('tikus', function () {
+            return app()->make(Tikus::class);
+        });        
+    }
+}

src/Tikus.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Mamikos\Tikus;
+
+use Throwable;
+use Exception;
+use Bugsnag\BugsnagLaravel\Facades\Bugsnag;
+use Sentry\Laravel\Facade as Sentry;
+
+class Tikus
+{
+    public function reportException(Throwable $throwable, Array $metadata = [])
+    {
+        try {
+            if (empty($metadata) === false)
+            {
+                Sentry::configureScope(function ($scope) use ($metadata) {
+                    try {
+                        $scope->setContext('metadata', $metadata);
+                    }
+                    catch (Exception $e)
+                    {
+                        $scope->setContext('metadata', [
+                            'error in set metadata' => $e->getMessage()
+                        ]);
+                    }
+                });                   
+            }
+
+            Sentry::captureException($throwable);
+        }
+        catch (Exception $e) {}
+
+        try {
+            // Bugsnag
+            if (empty($metadata) === true)
+            {
+                Bugsnag::notifyException($throwable);
+            }
+            else
+            {
+                Bugsnag::notifyException($throwable, function ($report) use ($metadata) {
+                    try {
+                        $report->setMetaData($metadata);
+                    }
+                    catch (Exception $e)
+                    {
+                        $report->setMetaData([
+                            'error in set metadata' => $e->getMessage()
+                        ]);
+                    }
+                });
+            }
+        }
+        catch (Exception $e) {}
+    }
+
+    public function reportError($name, $message, Array $metadata = [])
+    {
+        try {
+            // Sentry
+            if (empty($metadata) === false)
+            {
+                Sentry::configureScope(function ($scope) use ($metadata) {
+                    try {
+                        $scope->setContext('metadata', $metadata);
+                    }
+                    catch (Exception $e)
+                    {
+                        $scope->setContext('metadata', [
+                            'error in set metadata' => $e->getMessage()
+                        ]);
+                    }
+                });                   
+            }
+            Sentry::captureMessage("[{$name}] {$message}");
+        }
+        catch (Exception $e) {}
+
+        try {
+            // Bugsnag
+            if (empty($metadata) === true)
+            {
+                Bugsnag::notifyError($name, $message);
+            }
+            else
+            {
+                Bugsnag::notifyError($name, $message, function ($report) use ($metadata) {
+                    try {
+                        $report->setMetaData($metadata);
+                    }
+                    catch (Exception $e)
+                    {
+                        $report->setMetaData([
+                            'error in set metadata' => $e->getMessage()
+                        ]);
+                    }
+                });
+            }
+        }
+        catch (Exception $e) {}
+    }
+}

tests/TestCase.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Tests;
+
+class TestCase extends \PHPUnit\Framework\TestCase
+{
+    public function getNonPublicMethodFromClass($className, $classMethod)
+    {
+        $reflector = new \ReflectionClass($className);
+
+        $dummyMethod = $reflector->getMethod($classMethod);
+        $dummyMethod->setAccessible(true);
+
+        return $dummyMethod;
+    }
+
+    /**
+     *  Call a non public method $classMethod from $className with $args and return the result.
+     *
+     *  @param object $class/Name of class which owned the method
+     *  @param string $classMethod Name of the method in the class
+     *  @param array $args Arguments to pass to method
+     *
+     *  @return mixed
+     */
+    public function callNonPublicMethod($class, string $classMethod, array $args)
+    {
+        $method = $this->getNonPublicMethodFromClass($class, $classMethod);
+
+        $object = !is_object($class) ? $this->app->make($class) : $class;
+
+        return $method->invokeArgs($object, $args);
+    }
+
+    /**
+     *  Call a static non public method $classMethod from $className with $args and return the result.
+     *
+     *  @param string $className Name of the class the method belongs to
+     *  @param string $classMethod Name of the method in the class
+     *  @param array $args Arguments to pass to method
+     *
+     *  @return mixed
+     */
+    public function callStaticNonPublicMethod(string $className, string $classMethod, array $args)
+    {
+        $method = $this->getNonPublicMethodFromClass($className, $classMethod);
+
+        return $method->invokeArgs(null, $args);
+    }
+
+    public function getNonPublicAttributeFromClass($attributeName, $classObject)
+    {
+        $reflector = new \ReflectionObject($classObject);
+
+        $attribute = $reflector->getProperty($attributeName);
+        $attribute->setAccessible(true);
+
+        return $attribute->getValue($classObject);
+    }
+}

tests/TikusTest.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Tests;
+
+use Tests\TestCase;
+use Mamikos\Tikus\Tikus;
+use Bugsnag\BugsnagLaravel\Facades\Bugsnag;
+use Sentry\Laravel\Facade as Sentry;
+use Exception;
+
+class TikusTest extends TestCase
+{
+    public function testReportException()
+    {
+        $tikus = new Tikus();
+
+        Bugsnag::spy();
+        Sentry::spy();
+
+        $tikus->reportException(new Exception());
+
+        Bugsnag::shouldHaveReceived('notifyException')->once();
+        Sentry::shouldHaveReceived('captureException')->once();
+
+        $this->assertTrue(true);
+    }
+
+    public function testReportExceptionWithMetadata()
+    {
+        $tikus = new Tikus();
+
+        Bugsnag::spy();
+        Sentry::spy();
+
+        $metadata = [ 'data' => 1 ];
+        $tikus->reportException(new Exception(), $metadata);
+
+        Bugsnag::shouldHaveReceived('notifyException')->once();
+
+        Sentry::shouldHaveReceived('captureException')->once();
+        Sentry::shouldHaveReceived('configureScope')->once();
+
+        $this->assertTrue(true);
+    }
+
+    public function testReportExceptionWithEmptyMetadata()
+    {
+        $tikus = new Tikus();
+
+        Bugsnag::spy();
+        Sentry::spy();
+
+        $metadata = [];
+        $tikus->reportException(new Exception(), $metadata);
+
+        Bugsnag::shouldHaveReceived('notifyException')->once();
+
+        Sentry::shouldHaveReceived('captureException')->once();
+        Sentry::shouldNotHaveReceived('configureScope');
+
+        $this->assertTrue(true);
+    }
+
+    public function testReportError()
+    {
+        $tikus = new Tikus();
+
+        Bugsnag::spy();
+        Sentry::spy();
+
+        $tikus->reportError('name', 'message');
+        
+        Bugsnag::shouldHaveReceived('notifyError')->once();
+        Sentry::shouldHaveReceived('captureMessage')->once();
+
+        $this->assertTrue(true);
+    }
+}