feat: Implemented basic logger

Author: seebeen

src/App_Builder.php

@@ -11,6 +11,7 @@
 use DI\CompiledContainer as Compiled;
 use DI\ContainerBuilder;
 use DI\Definition\Source\DefinitionSource;
+use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use XWP\DI\Hook\Compiler;
 use XWP\DI\Hook\Factory;
@@ -129,7 +130,7 @@ public function addBaseDefinition( array $config ): App_Builder {
                     'ns'    => $config['app_id'],
                 ),
             ),
-            'app.debug'  => \DI\value( \defined( 'WP_DEBUG' ) && WP_DEBUG ),
+            'app.debug'  => \DI\value( $config['app_debug'] ),
             'app.env'    => \DI\factory( 'wp_get_environment_type' ),
             'app.extend' => \DI\value( $config['extendable'] ),
             'app.id'     => \DI\value( $config['app_id'] ),
@@ -160,23 +161,20 @@ public function addBaseDefinition( array $config ): App_Builder {
      * @return App_Builder
      */
     public function addLogDefinition( array $config ): App_Builder {
-        $config = $config['logger'];
-        $params = array(
-            'basedir' => $config['basedir'],
-            'level'   => $config['level'],
-            'options' => array(
-                'extension' => 'log',
-                'prefix'    => $config['prefix'] . '-',
-            ),
+        $log_cfg = $config['logger'];
+        $params  = array(
+            'app_id'  => $log_cfg['app_id'],
+            'basedir' => $log_cfg['basedir'],
+            'level'   => $log_cfg['level'],
         );
 
-        if ( ! $config['enabled'] ) {
-            $config['handler'] = NullLogger::class;
-            $params            = array();
+        if ( ! $log_cfg['enabled'] ) {
+            $log_cfg['handler'] = NullLogger::class;
+            $params             = array();
         }
 
         $definition = array(
-            'xwp.logger' => \DI\autowire( $config['handler'] )->constructor( ...$params ),
+            'xwp.logger' => \DI\autowire( $log_cfg['handler'] )->constructor( ...$params ),
             'app.logger' => \DI\factory(
                 static fn( $logger, string $ctx ) => \method_exists( $logger, 'with_context' )
                     ? $logger->with_context( $ctx )

src/App_Factory.php

@@ -51,6 +51,13 @@ final class App_Factory {
      */
     private array $files = array();
 
+    /**
+     * Array of application IDs which should be debugged.
+     *
+     * @var array<string>
+     */
+    private array $app_debug;
+
     /**
      * Add a container to the decompile list.
      *
@@ -95,6 +102,9 @@ public static function __callStatic( string $name, array $args = array() ): mixe
      * Constructor.
      */
     protected function __construct() {
+        $this->app_debug = \defined( 'XWP_DI_DEBUG_APP' )
+            ? \xwp_str_to_arr( XWP_DI_DEBUG_APP )
+            : array();
         /**
          * Fired when the app factory is initialized.
          *
@@ -277,6 +287,7 @@ private function parse_app_config( array $config ): array {
             $config,
             array(
                 'app_class'      => 'CompiledContainer' . \strtoupper( $config['app_id'] ),
+                'app_debug'      => $this->can_debug( $config['app_id'] ),
                 'app_file'       => false,
                 'app_preload'    => false,
                 'app_type'       => $this->parse_type( (string) ( $config['app_file'] ?? null ) ),
@@ -311,11 +322,11 @@ private function parse_log_config( array $config ): array {
         $config['logger'] = \xwp_parse_args(
             $logger,
             array(
+                'app_id'  => $config['app_id'],
                 'basedir' => \WP_CONTENT_DIR . '/logs/xwp-di',
                 'enabled' => true,
                 'handler' => Logger::class,
                 'level'   => $this->is_prod() ? LogLevel::ERROR : LogLevel::DEBUG,
-                'prefix'  => $config['app_id'],
             ),
         );
 
@@ -402,7 +413,7 @@ protected function is_uninstalling( string|bool $file ): bool {
      * @return bool
      */
     protected function can_debug( ?string $app_id = null ): bool {
-        return ! \defined( 'XWP_DI_DEBUG_APP' ) || \str_contains( XWP_DI_DEBUG_APP, $app_id );
+        return ! $this->app_debug || \in_array( $app_id, $this->app_debug, true );
     }
 
     /**

src/Container.php

@@ -12,6 +12,7 @@
 use DI\Definition\Source\MutableDefinitionSource;
 use DI\Proxy\ProxyFactory;
 use Psr\Container\ContainerInterface;
+use Psr\Log\LoggerInterface;
 use XWP\DI\Hook\Factory;
 use XWP\DI\Interfaces\Can_Handle;
 use XWP\DI\Interfaces\Can_Invoke;
@@ -132,4 +133,14 @@ public function register( object $instance ): Can_Handle {
     public function started(): bool {
         return $this->started;
     }
+
+    /**
+     * Get a logger instance.
+     *
+     * @param  string $context Logger context.
+     * @return LoggerInterface
+     */
+    public function logger( string $context ): LoggerInterface {
+        return $this->make( 'app.logger', array( 'ctx' => $context ) );
+    }
 }

src/Functions/xwp-di-container-fns.php

@@ -35,6 +35,7 @@ function xwp_app( string $container_id ): Container {
  * @template TCtr of Container
  * @param  array{
  *   app_class?: class-string<TCtr>,
+ *   app_debug?: bool,
  *   app_id?: string|false,
  *   app_module?: class-string,
  *   app_file?: string,
@@ -45,7 +46,12 @@ function xwp_app( string $container_id ): Container {
  *   cache_defs?: bool,
  *   cache_app?: bool,
  *   cache_dir?: string,
- *   logger?: bool,
+ *   logger?: bool|array{
+ *     basedir?: string,
+ *     enabled?: bool,
+ *     handler?: class-string,
+ *     level?: string,
+ *   },
  *   public?: bool,
  *   use_autowiring?: bool,
  *   use_attributes?: bool,
@@ -78,6 +84,7 @@ static function () use ( $app ): void {
  *
  * @param  array{
  *   app_class?: class-string<TCtr>,
+ *   app_debug?: bool,
  *   app_id?: string|false,
  *   app_module?: class-string,
  *   app_file?: string,
@@ -87,7 +94,12 @@ static function () use ( $app ): void {
  *   cache_defs?: bool,
  *   cache_dir?: string,
  *   cache_hooks?: bool,
- *   logger?: bool,
+ *    logger?: bool|array{
+ *     basedir?: string,
+ *     enabled?: bool,
+ *     handler?: class-string,
+ *     level?: string,
+ *   },
  *   public?: bool,
  *   use_autowiring?: bool,
  *   use_attributes?: bool,

src/Invoker.php

@@ -32,7 +32,7 @@ class Invoker {
      *
      * @var array<class-string,array<string,string>>>
      */
-    private array $hooks = array();
+    private array $callbacks = array();
 
     /**
      * Uncached handlers.
@@ -99,7 +99,7 @@ public function __construct( protected Factory $factory, Container $container )
         $this->cache  = $container->get( 'app.cache' );
         $this->env    = $container->get( 'app.env' );
         $this->app_id = $container->get( 'app.id' );
-        $this->logger = $container->make( 'app.logger', array( 'ctx' => 'Invoker' ) );
+        $this->logger = $container->logger( self::class );
 
         if ( ! $this->can_debug() ) {
             return;
@@ -141,7 +141,7 @@ public function debug_output(): void {
         }
 
         $this->logger->debug( 'Handlers', $this->handlers );
-        $this->logger->debug( 'Hooks', $this->hooks );
+        $this->logger->debug( 'Hooks', $this->callbacks );
 
         $this->logger->debug( 'Application shutdown complete' );
     }
@@ -162,7 +162,7 @@ public function get_handlers(): array {
      * @return ($handler is null ? array<class-string,array<string,string>> : array<string,string>)
      */
     public function get_actions( ?string $handler = null ): array {
-        return $handler ? $this->hooks[ $handler ] ?? array() : $this->hooks;
+        return $handler ? $this->callbacks[ $handler ] ?? array() : $this->callbacks;
     }
 
     /**
@@ -221,7 +221,7 @@ public function add_handler( Can_Handle $handler, bool $clear = true ): static {
         }
 
         if ( $clear ) {
-            $this->hooks[ $cname ] = array();
+            $this->callbacks[ $cname ] = array();
         }
 
         $this->handlers[ $cname ] = $handler->is_loaded() ? $handler->get_init_hook() : false;
@@ -413,7 +413,7 @@ private function add_callback( Can_Invoke $cb ): void {
         $id = "{$cb->get_method()}:{$cb->get_tag()}";
         $cn = $cb->get_classname();
 
-        $this->hooks[ $cn ][ $id ] = $cb->is_loaded() ? $cb->get_init_hook() : false;
+        $this->callbacks[ $cn ][ $id ] = $cb->is_loaded() ? $cb->get_init_hook() : false;
     }
 
     /**