Skip to content

Commit 3e01bc6

Browse files
seebeenseebeen
committed
feat: Implemented basic logger
1 parent abc5cd8 commit 3e01bc6

6 files changed

+267
-99
lines changed

‎src/App_Builder.php

+11-13
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
use DI\CompiledContainer as Compiled;
1212
use DI\ContainerBuilder;
1313
use DI\Definition\Source\DefinitionSource;
14+
use Psr\Log\LoggerInterface;
1415
use Psr\Log\NullLogger;
1516
use XWP\DI\Hook\Compiler;
1617
use XWP\DI\Hook\Factory;
@@ -129,7 +130,7 @@ public function addBaseDefinition( array $config ): App_Builder {
129130
'ns' => $config['app_id'],
130131
),
131132
),
132-
'app.debug' => \DI\value( \defined( 'WP_DEBUG' ) && WP_DEBUG ),
133+
'app.debug' => \DI\value( $config['app_debug'] ),
133134
'app.env' => \DI\factory( 'wp_get_environment_type' ),
134135
'app.extend' => \DI\value( $config['extendable'] ),
135136
'app.id' => \DI\value( $config['app_id'] ),
@@ -160,23 +161,20 @@ public function addBaseDefinition( array $config ): App_Builder {
160161
* @return App_Builder
161162
*/
162163
public function addLogDefinition( array $config ): App_Builder {
163-
$config = $config['logger'];
164-
$params = array(
165-
'basedir' => $config['basedir'],
166-
'level' => $config['level'],
167-
'options' => array(
168-
'extension' => 'log',
169-
'prefix' => $config['prefix'] . '-',
170-
),
164+
$log_cfg = $config['logger'];
165+
$params = array(
166+
'app_id' => $log_cfg['app_id'],
167+
'basedir' => $log_cfg['basedir'],
168+
'level' => $log_cfg['level'],
171169
);
172170

173-
if ( ! $config['enabled'] ) {
174-
$config['handler'] = NullLogger::class;
175-
$params = array();
171+
if ( ! $log_cfg['enabled'] ) {
172+
$log_cfg['handler'] = NullLogger::class;
173+
$params = array();
176174
}
177175

178176
$definition = array(
179-
'xwp.logger' => \DI\autowire( $config['handler'] )->constructor( ...$params ),
177+
'xwp.logger' => \DI\autowire( $log_cfg['handler'] )->constructor( ...$params ),
180178
'app.logger' => \DI\factory(
181179
static fn( $logger, string $ctx ) => \method_exists( $logger, 'with_context' )
182180
? $logger->with_context( $ctx )

‎src/App_Factory.php

+13-2
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,13 @@ final class App_Factory {
5151
*/
5252
private array $files = array();
5353

54+
/**
55+
* Array of application IDs which should be debugged.
56+
*
57+
* @var array<string>
58+
*/
59+
private array $app_debug;
60+
5461
/**
5562
* Add a container to the decompile list.
5663
*
@@ -95,6 +102,9 @@ public static function __callStatic( string $name, array $args = array() ): mixe
95102
* Constructor.
96103
*/
97104
protected function __construct() {
105+
$this->app_debug = \defined( 'XWP_DI_DEBUG_APP' )
106+
? \xwp_str_to_arr( XWP_DI_DEBUG_APP )
107+
: array();
98108
/**
99109
* Fired when the app factory is initialized.
100110
*
@@ -277,6 +287,7 @@ private function parse_app_config( array $config ): array {
277287
$config,
278288
array(
279289
'app_class' => 'CompiledContainer' . \strtoupper( $config['app_id'] ),
290+
'app_debug' => $this->can_debug( $config['app_id'] ),
280291
'app_file' => false,
281292
'app_preload' => false,
282293
'app_type' => $this->parse_type( (string) ( $config['app_file'] ?? null ) ),
@@ -311,11 +322,11 @@ private function parse_log_config( array $config ): array {
311322
$config['logger'] = \xwp_parse_args(
312323
$logger,
313324
array(
325+
'app_id' => $config['app_id'],
314326
'basedir' => \WP_CONTENT_DIR . '/logs/xwp-di',
315327
'enabled' => true,
316328
'handler' => Logger::class,
317329
'level' => $this->is_prod() ? LogLevel::ERROR : LogLevel::DEBUG,
318-
'prefix' => $config['app_id'],
319330
),
320331
);
321332

@@ -402,7 +413,7 @@ protected function is_uninstalling( string|bool $file ): bool {
402413
* @return bool
403414
*/
404415
protected function can_debug( ?string $app_id = null ): bool {
405-
return ! \defined( 'XWP_DI_DEBUG_APP' ) || \str_contains( XWP_DI_DEBUG_APP, $app_id );
416+
return ! $this->app_debug || \in_array( $app_id, $this->app_debug, true );
406417
}
407418

408419
/**

‎src/Container.php

+11
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
use DI\Definition\Source\MutableDefinitionSource;
1313
use DI\Proxy\ProxyFactory;
1414
use Psr\Container\ContainerInterface;
15+
use Psr\Log\LoggerInterface;
1516
use XWP\DI\Hook\Factory;
1617
use XWP\DI\Interfaces\Can_Handle;
1718
use XWP\DI\Interfaces\Can_Invoke;
@@ -132,4 +133,14 @@ public function register( object $instance ): Can_Handle {
132133
public function started(): bool {
133134
return $this->started;
134135
}
136+
137+
/**
138+
* Get a logger instance.
139+
*
140+
* @param string $context Logger context.
141+
* @return LoggerInterface
142+
*/
143+
public function logger( string $context ): LoggerInterface {
144+
return $this->make( 'app.logger', array( 'ctx' => $context ) );
145+
}
135146
}

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

+14-2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ function xwp_app( string $container_id ): Container {
3535
* @template TCtr of Container
3636
* @param array{
3737
* app_class?: class-string<TCtr>,
38+
* app_debug?: bool,
3839
* app_id?: string|false,
3940
* app_module?: class-string,
4041
* app_file?: string,
@@ -45,7 +46,12 @@ function xwp_app( string $container_id ): Container {
4546
* cache_defs?: bool,
4647
* cache_app?: bool,
4748
* cache_dir?: string,
48-
* logger?: bool,
49+
* logger?: bool|array{
50+
* basedir?: string,
51+
* enabled?: bool,
52+
* handler?: class-string,
53+
* level?: string,
54+
* },
4955
* public?: bool,
5056
* use_autowiring?: bool,
5157
* use_attributes?: bool,
@@ -78,6 +84,7 @@ static function () use ( $app ): void {
7884
*
7985
* @param array{
8086
* app_class?: class-string<TCtr>,
87+
* app_debug?: bool,
8188
* app_id?: string|false,
8289
* app_module?: class-string,
8390
* app_file?: string,
@@ -87,7 +94,12 @@ static function () use ( $app ): void {
8794
* cache_defs?: bool,
8895
* cache_dir?: string,
8996
* cache_hooks?: bool,
90-
* logger?: bool,
97+
* logger?: bool|array{
98+
* basedir?: string,
99+
* enabled?: bool,
100+
* handler?: class-string,
101+
* level?: string,
102+
* },
91103
* public?: bool,
92104
* use_autowiring?: bool,
93105
* use_attributes?: bool,

‎src/Invoker.php

+6-6
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class Invoker {
3232
*
3333
* @var array<class-string,array<string,string>>>
3434
*/
35-
private array $hooks = array();
35+
private array $callbacks = array();
3636

3737
/**
3838
* Uncached handlers.
@@ -99,7 +99,7 @@ public function __construct( protected Factory $factory, Container $container )
9999
$this->cache = $container->get( 'app.cache' );
100100
$this->env = $container->get( 'app.env' );
101101
$this->app_id = $container->get( 'app.id' );
102-
$this->logger = $container->make( 'app.logger', array( 'ctx' => 'Invoker' ) );
102+
$this->logger = $container->logger( self::class );
103103

104104
if ( ! $this->can_debug() ) {
105105
return;
@@ -141,7 +141,7 @@ public function debug_output(): void {
141141
}
142142

143143
$this->logger->debug( 'Handlers', $this->handlers );
144-
$this->logger->debug( 'Hooks', $this->hooks );
144+
$this->logger->debug( 'Hooks', $this->callbacks );
145145

146146
$this->logger->debug( 'Application shutdown complete' );
147147
}
@@ -162,7 +162,7 @@ public function get_handlers(): array {
162162
* @return ($handler is null ? array<class-string,array<string,string>> : array<string,string>)
163163
*/
164164
public function get_actions( ?string $handler = null ): array {
165-
return $handler ? $this->hooks[ $handler ] ?? array() : $this->hooks;
165+
return $handler ? $this->callbacks[ $handler ] ?? array() : $this->callbacks;
166166
}
167167

168168
/**
@@ -221,7 +221,7 @@ public function add_handler( Can_Handle $handler, bool $clear = true ): static {
221221
}
222222

223223
if ( $clear ) {
224-
$this->hooks[ $cname ] = array();
224+
$this->callbacks[ $cname ] = array();
225225
}
226226

227227
$this->handlers[ $cname ] = $handler->is_loaded() ? $handler->get_init_hook() : false;
@@ -413,7 +413,7 @@ private function add_callback( Can_Invoke $cb ): void {
413413
$id = "{$cb->get_method()}:{$cb->get_tag()}";
414414
$cn = $cb->get_classname();
415415

416-
$this->hooks[ $cn ][ $id ] = $cb->is_loaded() ? $cb->get_init_hook() : false;
416+
$this->callbacks[ $cn ][ $id ] = $cb->is_loaded() ? $cb->get_init_hook() : false;
417417
}
418418

419419
/**

0 commit comments

Comments
 (0)