Merge pull request #11 from BinarCode/2.x

2.x

Author: binaryk

.github/workflows/php-cs-fixer.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Run PHP CS Fixer
         uses: docker://oskarstark/php-cs-fixer-ga
         with:
-          args: --config=.php_cs.dist --allow-risky=yes
+          args: --config=.php_cs.dist.php --allow-risky=yes
 
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v4

.github/workflows/psalm.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.0'
           extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
           coverage: none
 

.github/workflows/run-tests.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest]
-        php: [8.0, 7.4]
+        php: [8.0]
         laravel: [8.*]
         stability: [prefer-stable]
         include:

.php-cs-fixer.cache

@@ -0,0 +1 @@
+{"php":"8.0.11","version":"3.2.1","indent":"    ","lineEnding":"\n","rules":{"blank_line_after_opening_tag":true,"braces":{"allow_single_line_anonymous_class_with_empty_body":true},"class_definition":{"space_before_parenthesis":true},"compact_nullable_typehint":true,"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"sort_algorithm":"alpha"},"return_type_declaration":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline","keep_multiple_spaces_after_comma":true},"no_break_comment":true,"no_closing_tag":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true,"array_syntax":{"syntax":"short"},"no_unused_imports":true,"not_operator_with_successor_space":true,"trailing_comma_in_multiline":true,"phpdoc_scalar":true,"unary_operator_spaces":true,"binary_operator_spaces":true,"blank_line_before_statement":{"statements":["break","continue","declare","return","throw","try"]},"phpdoc_single_line_var_spacing":true,"phpdoc_var_without_name":true,"class_attributes_separation":{"elements":{"method":"one"}}},"hashes":{"src\/Commands\/PruneCommand.php":1473367127,"src\/Telescope\/TelescopeException.php":1871046959,"src\/Telescope\/TelescopeDev.php":2309110818,"src\/LaravelDeveloper.php":1129170780,"src\/Dtos\/DevLogDto.php":1643551788,"src\/Dtos\/DevNotificationDto.php":412948095,"src\/Notifications\/DevNotification.php":2947327537,"src\/Notifications\/Slack.php":3934215647,"src\/Middleware\/DevSanctumAuthMiddleware.php":964085018,"src\/Middleware\/DevAuthMiddleware.php":1511410281,"src\/Models\/DeveloperLog.php":4104297917,"src\/Models\/Concerns\/WithUuid.php":1102884493,"src\/Models\/Concerns\/WithCreator.php":2183877251,"src\/Models\/Concerns\/InteractsWithDeveloper.php":1790705050,"src\/LaravelDeveloperServiceProvider.php":1956646152,"src\/Profiling\/ServerMemory.php":1460695193,"src\/Profiling\/ServerTiming.php":4274056244,"src\/helpers.php":715232250,"src\/Concerns\/Proxies.php":524787727,"src\/Concerns\/ClassResolver.php":1880027722,"src\/LaravelDeveloperFacade.php":3477645298,"src\/Nova\/DeveloperLogResource.php":9639465,"src\/Nova\/Fields\/Line.php":2270391664,"src\/Nova\/Fields\/CreatedAt.php":2148384209,"src\/Nova\/Fields\/Badge.php":1570922008,"src\/Nova\/Fields\/ExpirationDateBadge.php":4282897254,"src\/Nova\/Fields\/BelongsTo.php":1822753998,"src\/Nova\/Fields\/BadgeList.php":3076744754,"src\/Nova\/Fields\/DangerBadge.php":3216791755,"src\/Nova\/Filters\/EndingAtFilter.php":2850496008,"src\/Nova\/Filters\/HasResultsFilter.php":4116547610,"src\/Nova\/Filters\/FromDateFilter.php":1053058278,"src\/Nova\/Filters\/ToDateFilter.php":581993863,"src\/Nova\/Filters\/CreatedAtFilter.php":778019993,"src\/Nova\/Filters\/TagFilter.php":1978666758,"tests\/TestCase.php":3638931094,"tests\/Fixtures\/DummyNotification.php":3913031193,"tests\/Fixtures\/User.php":353028011,"tests\/Notifications\/DevNotificationTest.php":3587569263,"tests\/Middleware\/DevAuthMiddlewareTest.php":1606798965,"tests\/Middleware\/DevSanctumAuthMiddlewareTest.php":3421724279,"tests\/ExampleTest.php":1575370042,"tests\/Helpers\/SlackHelperTest.php":1334877550,"tests\/Helpers\/DevLogHelperTest.php":585022422,"tests\/Models\/ExceptionLogTest.php":2235509697,"tests\/Models\/LaravelDeveloperTest.php":1546634681,"tests\/Console\/PruneCommandTest.php":4199024702,"tests\/Mock\/CustomNotificationMock.php":2052176798,"tests\/Mock\/PayloadMock.php":1887690153,"tests\/Profiling\/ServerTimingTest.php":1295567184,"tests\/Profiling\/ServerMemoryTest.php":4137425435,"tests\/Mock.php":3663171411}}

.php_cs.dist renamed to .php_cs.dist.php

@@ -1,9 +1,6 @@
 <?php
 
 $finder = Symfony\Component\Finder\Finder::create()
-    ->notPath('bootstrap/*')
-    ->notPath('storage/*')
-    ->notPath('resources/view/mail/*')
     ->in([
         __DIR__ . '/src',
         __DIR__ . '/tests',
@@ -13,14 +10,14 @@
     ->ignoreDotFiles(true)
     ->ignoreVCS(true);
 
-return PhpCsFixer\Config::create()
+return (new PhpCsFixer\Config())
     ->setRules([
-        '@PSR2' => true,
+        '@PSR12' => true,
         'array_syntax' => ['syntax' => 'short'],
-        'ordered_imports' => ['sortAlgorithm' => 'alpha'],
+        'ordered_imports' => ['sort_algorithm' => 'alpha'],
         'no_unused_imports' => true,
         'not_operator_with_successor_space' => true,
-        'trailing_comma_in_multiline_array' => true,
+        'trailing_comma_in_multiline' => true,
         'phpdoc_scalar' => true,
         'unary_operator_spaces' => true,
         'binary_operator_spaces' => true,
@@ -31,7 +28,7 @@
         'phpdoc_var_without_name' => true,
         'class_attributes_separation' => [
             'elements' => [
-                'method',
+                'method' => 'one',
             ],
         ],
         'method_argument_space' => [

README.md

@@ -50,7 +50,7 @@ return [
      *
      * We will replace the uuid with the exception log uuid.
      */
-    'exception_log_base_url' => env('DEV_EXCEPTION_LOG_BASE_URL'),
+    'developer_log_base_url' => env('DEV_developer_log_base_url'),
 
     /**
      * The default notification class used to send notifications.
@@ -110,15 +110,15 @@ LaravelDeveloper::toDevSlack(
 
 ### Persist exception
 
-If you want to persist the exception into the database, in any place you want to catch and log an exception, you can do something like this: 
+If you want to persist the exception into the database, in any place you want to catch and log an exception, you can do something like this:
 
 ```php
-use Binarcode\LaravelDeveloper\Models\ExceptionLog;
+use Binarcode\LaravelDeveloper\Models\DeveloperLog;
 
 try {
     // Your custom code
 } catch (\Throwable $e) {
-    ExceptionLog::makeFromException($e)->save();
+    DeveloperLog::makeFromException($e)->save();
 }
 ```
 
@@ -143,12 +143,12 @@ You can specify payload to your exception, so it will be stored along with the e
 
 ```php
 use Laravel\Cashier\Exceptions\PaymentFailure;
-use Binarcode\LaravelDeveloper\Models\ExceptionLog;
+use Binarcode\LaravelDeveloper\Models\DeveloperLog;
 
 try {
     // Your custom code
 } catch (PaymentFailure $e) {
-ExceptionLog::makeFromException($e, $e->payment->asStripePaymentIntent())->notifyDevs();
+DeveloperLog::makeFromException($e, $e->payment->asStripePaymentIntent())->notifyDevs();
 }
 ```
 
@@ -369,6 +369,32 @@ devLog('Called Fedex API with:', $payload)
 
 Now you will have an entry in your database table with the payload and the associated name.
 
+### Attach target
+
+You can attach a target to your log, so it will relate to a model like this: 
+
+```php
+devLog('Model updated')->target($user);
+```
+
+Or if you need to attach many models, use: 
+
+```php
+devLog('Targetable')
+    ->addRelatedModel($user)
+    ->addRelatedModel($post)
+    ->save();
+```
+
+### Attach meta
+
+You also can attach meta data to your logs: 
+
+```php
+devLog('Targetable')
+    ->addMeta(['browser' => 'safari',])
+    ->save();
+```
 
 ## Telescope support
 

composer.json

@@ -16,13 +16,14 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0",
+        "php": "^8.0",
         "illuminate/contracts": "^8.0",
         "illuminate/support": "^7.0|^8.0",
         "laravel/slack-notification-channel": "^2.3",
         "ext-json": "*"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.2",
         "laravel/sanctum": "^2.8",
         "orchestra/testbench": "^6.0",
         "phpunit/phpunit": "^9.3",

config/developer.php

@@ -1,6 +1,16 @@
 <?php
 
 return [
+    /**
+     * The database table name.
+     */
+    'table' => 'developer_logs',
+
+    /**
+     * The model used to manage logs.
+     */
+    'model' => \Binarcode\LaravelDeveloper\Models\DeveloperLog::class,
+
     /**
      * The slack incoming webhook to send notifications.
      */
@@ -13,7 +23,7 @@
      *
      * We will replace the uuid with the exception log uuid.
      */
-    'exception_log_base_url' => env('DEV_EXCEPTION_LOG_BASE_URL'),
+    'developer_log_base_url' => env('DEVELOPER_LOG_BASE_URL'),
 
     /**
      * The default notification class used to send notifications.

database/factories/ExceptionLogFactory.php renamed to database/factories/DeveloperLogFactory.php

@@ -2,14 +2,14 @@
 
 namespace Binarcode\LaravelDeveloper\Database\Factories;
 
-use Binarcode\LaravelDeveloper\Models\ExceptionLog;
+use Binarcode\LaravelDeveloper\Models\DeveloperLog;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
-class ExceptionLogFactory extends Factory
+class DeveloperLogFactory extends Factory
 {
-    protected $model = ExceptionLog::class;
+    protected $model = DeveloperLog::class;
 
-    public function definition()
+    public function definition(): array
     {
         return [
             'name' => $this->faker->text(10),

database/migrations/create_laravel_developer_table.php.stub

@@ -8,18 +8,24 @@ class CreateLaravelDeveloperTable extends Migration
 {
     public function up()
     {
-        Schema::create('exception_logs', function (Blueprint $table) {
+        $table = config('developer.table') ?? 'developer_logs';
+
+        Schema::create($table, function (Blueprint $table) {
            $table->id();
            $table->uuid('uuid');
 
            $table->string('name')->nullable();
            $table->string('tags')->nullable();
-           $table->text('payload')->nullable();
+           $table->json('payload')->nullable();
            $table->text('exception')->nullable();
            $table->text('previous')->nullable();
            $table->string('file')->nullable();
            $table->string('line')->nullable();
            $table->string('code')->nullable();
+           $table->string('target_type')->nullable();
+           $table->unsignedBigInteger('target_id')->nullable();
+           $table->json('related_models')->nullable();
+           $table->json('meta')->nullable();
 
            $table->bigInteger('created_by')->nullable();
            $table->timestamps();
@@ -28,6 +34,8 @@ class CreateLaravelDeveloperTable extends Migration
 
     public function down()
     {
-        Schema::dropIfExists('exception_logs');
+        $table = config('developer.table') ?? 'developer_logs';
+
+        Schema::dropIfExists($table);
     }
 }

psalm.xml.dist

@@ -11,6 +11,8 @@
         <directory name="src"/>
         <ignoreFiles>
             <directory name="vendor"/>
+            <directory name="src/Nova"/>
+            <directory name="src/Telescope"/>
         </ignoreFiles>
     </projectFiles>
 </psalm>

src/Commands/PruneCommand.php

@@ -2,7 +2,7 @@
 
 namespace Binarcode\LaravelDeveloper\Commands;
 
-use Binarcode\LaravelDeveloper\Models\ExceptionLog;
+use Binarcode\LaravelDeveloper\Models\DeveloperLog;
 use Illuminate\Console\Command;
 
 class PruneCommand extends Command
@@ -13,6 +13,6 @@ class PruneCommand extends Command
 
     public function handle()
     {
-        $this->info(ExceptionLog::prune(now()->subHours((int) $this->option('hours'))) . ' entries pruned.');
+        $this->info(DeveloperLog::prune(now()->subHours((int) $this->option('hours'))) . ' entries pruned.');
     }
 }

src/Concerns/ClassResolver.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Binarcode\LaravelDeveloper\Concerns;
+
+use Binarcode\LaravelDeveloper\Models\DeveloperLog;
+
+trait ClassResolver
+{
+    public static function model(): string
+    {
+        return config('developer.model') ?? DeveloperLog::class;
+    }
+}

src/Dtos/DevLogDto.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace Binarcode\LaravelDeveloper\Dtos;
+
+use Binarcode\LaravelDeveloper\Models\DeveloperLog;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection;
+
+class DevLogDto
+{
+    public string $name;
+
+    public array $payload = [];
+
+    public ?string $tags;
+
+    public ?Model $target = null;
+
+    public ?Collection $relatedModels;
+
+    public ?Collection $meta;
+
+    public function __construct(string $name = 'Dev Log', ?array $payload = [], ?string $tags = null)
+    {
+        $this->payload = $payload ?? [];
+        $this->name = $name;
+        $this->tags = $tags;
+        $this->relatedModels = collect();
+        $this->meta = collect();
+    }
+
+    public function setPayload(array $payload): self
+    {
+        $this->payload = $payload;
+
+        return $this;
+    }
+
+    public function setName(string $name): self
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+
+    public function setTags(string $tags): self
+    {
+        $this->tags = $tags;
+
+        return $this;
+    }
+
+    public static function make(...$args): self
+    {
+        return new static(...$args);
+    }
+
+    public function getPayload(): array
+    {
+        return $this->payload;
+    }
+
+    public function target(Model $model): self
+    {
+        $this->target = $model;
+
+        return $this;
+    }
+
+    public function addRelatedModel(Model $model): self
+    {
+        $this->relatedModels->push([
+            'target_id' => $model->getKey(),
+            'target_type' => $model->getMorphClass(),
+        ]);
+
+        return $this;
+    }
+
+    public function addMeta(array $meta): self
+    {
+        $this->meta->push($meta);
+
+        return $this;
+    }
+
+    public function save(): void
+    {
+        DeveloperLog::makeFromDevLog($this)->save();
+    }
+
+    public function __destruct()
+    {
+        $this->save();
+    }
+}