Implement as Laravel Logging channel (#7)

* Play nice with Laravel Logging channels/drivers

Author: VeryStrongFingers

.github/workflows/laravel-test.yaml

@@ -12,12 +12,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ 7.2, 7.3, 7.4 ]
-        #laravel: [~5.6.0, ~5.7.0, ~5.8.0, ~5.9.0, ^6.0, ^7.0, ^8.0]
+        php: [ 7.2, 7.3, 7.4, 8.0 ]
         laravel: [ ^6.0, ^7.0, ^8.0 ]
         exclude:
           - php: 7.2
             laravel: ^8.0
+          - php: 8.0
+            laravel: ^6.0
+          - php: 8.0
+            laravel: ^7.0
 
     name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
 
@@ -48,11 +51,15 @@ jobs:
       - name: Add local path composer dependency
         run: |
           cd laravel-app
-          jq '.repositories[0].type="path"' composer.json > composer.temp.json
-          jq '.repositories[0].url="../console-logg-package"' composer.json > composer.temp.json
-          jq '.require."devthis/console-logg"="*"' composer.json > composer.temp.json
-          mv composer.temp.json composer.json
-          composer update --no-interaction --no-progress --ignore-platform-reqs
+          export PHPV=$(php -r "echo implode('.', [PHP_MAJOR_VERSION, PHP_MINOR_VERSION, PHP_RELEASE_VERSION]);")
+          cat <<< $(jq '.repositories[0].type="path"' composer.json) > composer.json
+          cat <<< $(jq '.repositories[0].url="../console-logg-package"' composer.json) > composer.json
+          cat <<< $(jq '.require."devthis/console-logg"="*"' composer.json) > composer.json
+          cat <<< $(jq '.require."psr/log"="1.1.4"' composer.json) > composer.json
+          cat <<< $(jq --arg phpv "$PHPV" '.config.platform.php=$phpv' composer.json) > composer.json
+          cat <<< $(jq '.extra.symfony.require="5.4"' composer.json) > composer.json
+          cat <<< $(jq '.require.php="^${{ matrix.php }}"' composer.json) > composer.json
+
 
       - name: Copy fixtures into Laravel app
         run: |
@@ -63,10 +70,20 @@ jobs:
       - name: Run Laravel package discovery
         run: |
           cd laravel-app
+          ls -lha
+          cat composer.json
+          composer update --no-interaction --no-progress
           php artisan package:discover --ansi
           php artisan clear-compiled
 
       - name: Run PHPT
+        if: matrix.php != '8.0'
+        run: |
+          cd console-logg-package
+          vendor/bin/phpunit tests/PhpTestCase/artisan-command-output.phpt --testdox
+
+      - name: Run PHPT
+        if: matrix.php == '8.0'
         run: |
           cd console-logg-package
-          vendor/bin/phpunit tests/PhpTestCase/ --testdox
+          vendor/bin/phpunit tests/PhpTestCase/artisan-command-output-php8.phpt --testdox

.github/workflows/phpunit-tests.yaml

@@ -24,12 +24,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ 7.2, 7.3, 7.4 ]
+        php: [ 7.2, 7.3, 7.4, 8.0 ]
         #laravel: [~5.6.0, ~5.7.0, ~5.8.0, ~5.9.0, ^6.0, ^7.0, ^8.0]
         laravel: [ ^6.0, ^7.0, ^8.0 ]
         exclude:
           - php: 7.2
             laravel: ^8.0
+          - php: 8.0
+            laravel: ^6.0
+          - php: 8.0
+            laravel: ^7.0
 
     name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
 

README.md

@@ -27,16 +27,16 @@ Powered by [Symfony's Console Logger](https://symfony.com/doc/current/components
 
 # What does it do?
 
-**ConsoleLogg provides output messages for your artisan commands, between your shared code which is using the built-in
-Laravel logger**
+**Logger channel for sharing messages between application and console commands**
 
 Typically, this requires a hacky solution, such as coupling your shared services with a console logger, or configuring
 multiple driver channels.
 
 With ConsoleLogg you can have logs for your artisan commands, and behave as usual with http/controllers.
 
-**Use your Laravel logger throughout your application shared services as usual**
+**No code changes are required with logger usage**
 
+Supported:
 - _Dependency Injection/autowiring_ `LoggerInterface $logger` & `$logger->debug("yeet")`
 - `logger()->critical("Send help")`
 - `Log::alert("She find pictures in my email")`
@@ -57,42 +57,33 @@ php artisan my:command -vvv
 
     ```shell script
    composer require devthis/console-logg
-   
-   # to optionally copy config
-   php artisan vendor:publish --provider="DevThis\ConsoleLogg\Providers\ConsoleLoggServiceProvider"
-    ```
+   ```
+
+2. Enable logging channel `console-logg`
+
+`config/logging.php`
+```diff
+    'channels' => [
+        'stack' => [
+            'driver' => 'stack',
+-            'channels' => ['single'],
++            'channels' => ['console-logg', 'single'],
+            'ignore_exceptions' => false,
+        ],
+```
+
+[Laravel - Logging Docs](https://laravel.com/docs/8.x/logging#building-log-stacks)
 
 ### Compatibility
 
 | Compatible         | Laravel   | PHP       |
 |--------------------|-----------|-----------|
-| :heavy_check_mark: | 8.*       | PHP >=7.1 |
+| :heavy_check_mark: | 8.*       | PHP >=7.1 + 8.* |
 | :heavy_check_mark: | 7.*       | PHP >=7.1 |
 | :heavy_check_mark: | 6.*       | PHP >=7.1 |
-| :heavy_exclamation_mark: :soon: | > 5.6     | PHP >=7.1 |
-
-**PHP 8 compatibility is currently being tested**
-
-#### Compatibility assurance
-
-<details>
-  <summary>Click to find out how we ensure compatibility</summary>
-
-Compatibility is thoroughly tested using a combination of real world tests (functional), and unit tests
-
-[ConsoleLogg test suite](/test) is run in isolation
-
-- Using PHP 7.1, 7.2, 7.3,
-  7.4, [each major version of Laravel is independently tested against](actions?query=workflow%3A"PHPUnit+suite")
-- _Laravel 5.6, 5.7 & 5.8 are tested individually on top of this_
-
-Unit tests ensure type-compatibility, expected behaviour is met & compatibility with each version of Laravel contracts
-
-[TODO] Functional tests ensure real world expectations are through a real Laravel application
-
-</details>
 
 ---
+
 # Features
 
 ## Artisan serve supported
@@ -106,33 +97,14 @@ There are no traits, classes, interfaces that you need to use. ConsoleLogg does
 
 The ConsoleLog Service Provider should be automatically added to your app, but if it hasn't, you can add it yourself to `config/app.php`
 ```php
-// generally only required when you have composer intalled with --no-scripts
+// generally only required when you have composer installed with --no-scripts
 
 'providers' => [
     //...
     \DevThis\ConsoleLogg\Providers\ConsoleLoggServiceProvider::class,
 ];
 ```
 
-## Settings
-
-See [config/console-logg.php](config/console-logg.php) for the raw configuration file
-
-### Filtering
-
-> default = `false`
-
-If you choose to enable filtering, logs will only be output to artisan console commands if they have the context property `logg` set to `true`
-
-eg.
-
-```php
-logger()->info("Informative message #1", ['logg' => true]);
-logger()->alert("Nice one");
-```
-
-With these logs being invoked by your artisan command, only `[info] Informative message #1` will be output
-
 ## Command-in-command
 
 ConsoleLogg has (not yet) been tested for compatibility using artisan commands in a command
@@ -150,7 +122,7 @@ class MyConsoleApp extends Command
 
     public function handle(): int
     {
-        //other:command may invoke servies that use the Laravel Logger
+        //other:command may invoke services that use the Laravel Logger
         //these logs will still output to this current console
         $this->call('other:command');
         //...

composer.json

@@ -20,10 +20,11 @@
   ],
   "license": "MIT",
   "require": {
-    "php": "7.1.3 - 8.0",
+    "php": "7.*|8.*",
     "illuminate/log": ">=6.0",
     "illuminate/console": ">=6.0",
-    "illuminate/support": ">=6.0"
+    "illuminate/support": ">=6.0",
+    "psr/log": ">=1.1.4"
   },
   "extra": {
     "laravel": {
@@ -43,6 +44,6 @@
     }
   },
   "require-dev": {
-    "phpunit/phpunit": "^7.0"
+    "phpunit/phpunit": "^8.0"
   }
 }

config/console-logg.php

@@ -15,7 +15,9 @@
             <directory suffix=".phpt">test</directory>
         </testsuite>
     </testsuites>
-
+    <php>
+        <env name="LOG_CHANNEL" value="console-logg" force="true" />
+    </php>
     <filter>
         <whitelist processUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">./src</directory>

phpunit.xml

@@ -4,8 +4,8 @@
 
 namespace DevThis\ConsoleLogg\Binder;
 
+use DevThis\ConsoleLogg\Console\ConsoleLogg;
 use DevThis\ConsoleLogg\Interfaces\Binder\LogOutputBindedInterface;
-use DevThis\ConsoleLogg\Interfaces\Factories\FilterableConsoleLoggerFactoryInterface;
 use Illuminate\Contracts\Config\Repository;
 use Illuminate\Log\LogManager;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -17,33 +17,9 @@
  */
 class LogOutputBinder implements LogOutputBindedInterface
 {
-    /**
-     * @var FilterableConsoleLoggerFactoryInterface
-     */
-    private $consoleLoggerFactory;
-
-    /**
-     * @var string|null
-     */
-    private $defaultDriver = null;
-
-    /**
-     * @var bool
-     */
-    private $isFiltered;
-
-    public function __construct(FilterableConsoleLoggerFactoryInterface $consoleLoggerFactory, Repository $config)
-    {
-        $this->isFiltered = $config->get('console-logg.filtered') === true;
-        $this->consoleLoggerFactory = $consoleLoggerFactory;
-    }
-
     public function attach(OutputInterface $output, LogManager $logManager): void
     {
-        $this->defaultDriver = $logManager->getDefaultDriver();
-        $logManager->setDefaultDriver('console-logg');
-
-        $consoleLogger = $this->consoleLoggerFactory->create($output, $this->isFiltered);
+        $consoleLogger = new ConsoleLogg($output);
 
         $logManager->extend(
             'console-logg',
@@ -56,6 +32,5 @@ function () use ($consoleLogger) {
     public function detach(LogManager $logManager): void
     {
         $logManager->forgetChannel('console-logg');
-        $logManager->setDefaultDriver($this->defaultDriver);
     }
 }

src/Binder/LogOutputBinder.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevThis\ConsoleLogg\Console;
+
+use Monolog\Handler\HandlerInterface;
+use Symfony\Component\Console\Logger\ConsoleLogger;
+
+class ConsoleLogg extends ConsoleLogger implements HandlerInterface
+{
+    public function getHandlers(): array
+    {
+        return [$this];
+    }
+
+    public function getProcessors(): array
+    {
+        return [];
+    }
+
+    public function isHandling(array $record): bool
+    {
+        return true;
+    }
+
+    public function handle(array $record): bool
+    {
+        $this->log(strtolower($record['level_name'] ?? ''), $record['message'] ?? '', $record['context'] ?? []);
+
+        return true;
+    }
+
+    public function handleBatch(array $records): void
+    {
+        foreach ($records as $record) {
+            $this->handle($record);
+        }
+    }
+
+    public function close(): void
+    {
+    }
+}