Skip to content

Commit abc5cd8

Browse files
seebeenseebeen
committed
feat: Complete rework for v2
1 parent 604e925 commit abc5cd8

24 files changed

+1462
-634
lines changed

‎composer.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@
2222
},
2323
"require": {
2424
"php": ">=8.0",
25-
"automattic/jetpack-constants": "^2 | ^3",
25+
"automattic/jetpack-constants": "^2 || ^3",
2626
"php-di/php-di": "^7",
27+
"psr/log": "^2.0 || ^3.0",
2728
"symfony/polyfill-php81": "^1.31",
2829
"x-wp/helper-classes": "^1.13",
2930
"x-wp/helper-functions": "^1.13"
@@ -45,7 +46,7 @@
4546
"oblak/wp-hook-di": "*"
4647
},
4748
"provide": {
48-
"psr/container-implementation": "1.1|2.0",
49+
"psr/container-implementation": "1.1 || 2.0",
4950
"x-wp/di-implementation": "self.version"
5051
},
5152
"suggest": {

‎composer.lock

+51-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/App_Builder.php

+41-7
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111
use DI\CompiledContainer as Compiled;
1212
use DI\ContainerBuilder;
1313
use DI\Definition\Source\DefinitionSource;
14+
use Psr\Log\NullLogger;
1415
use XWP\DI\Hook\Compiler;
16+
use XWP\DI\Hook\Factory;
1517
use XWP\DI\Hook\Parser;
1618

1719
/**
@@ -49,6 +51,7 @@ public static function configure( array $config = array() ): App_Builder {
4951
->enableHookCache( enableCache: $config['cache_hooks'], cacheDirectory: $config['cache_dir'] )
5052
->writeProxiesToFile( writeToFile: $config['use_proxies'], proxyDirectory: $config['cache_dir'] )
5153
->addBaseDefinition( $config )
54+
->addLogDefinition( $config )
5255
->addModuleDefinition( $config );
5356
}
5457

@@ -116,7 +119,7 @@ public function enableHookCache( bool $enableCache, string $cacheDirectory ): st
116119
*/
117120
public function addBaseDefinition( array $config ): App_Builder {
118121
$definition = array(
119-
'app' => \DI\get( 'Module-' . $config['app_module'] ),
122+
'app' => \DI\get( 'Hook-' . $config['app_module'] ),
120123
'app.cache' => \DI\value(
121124
array(
122125
'app' => $config['cache_app'],
@@ -150,6 +153,42 @@ public function addBaseDefinition( array $config ): App_Builder {
150153
return parent::addDefinitions( $definition );
151154
}
152155

156+
/**
157+
* Add a log definition to the container.
158+
*
159+
* @param array<string,mixed> $config Configuration options.
160+
* @return App_Builder
161+
*/
162+
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+
),
171+
);
172+
173+
if ( ! $config['enabled'] ) {
174+
$config['handler'] = NullLogger::class;
175+
$params = array();
176+
}
177+
178+
$definition = array(
179+
'xwp.logger' => \DI\autowire( $config['handler'] )->constructor( ...$params ),
180+
'app.logger' => \DI\factory(
181+
static fn( $logger, string $ctx ) => \method_exists( $logger, 'with_context' )
182+
? $logger->with_context( $ctx )
183+
: $logger,
184+
)
185+
->parameter( 'logger', \DI\get( 'xwp.logger' ) ),
186+
187+
);
188+
189+
return $this->addDefinitions( $definition );
190+
}
191+
153192
/**
154193
* Add a module definition to the container.
155194
*
@@ -162,12 +201,7 @@ public function addModuleDefinition( array $config ): App_Builder {
162201

163202
$defns = $this->isHookCacheEnabled()
164203
? ( new Compiler( $parser ) )->compile( $config['cache_dir'] )
165-
: $parser->make()->get_parsed();
166-
167-
// if ( 'woosync' === $config['app_id'] ) {
168-
// \dump( $defns );
169-
// die;
170-
// }
204+
: $parser->make( $config['app_preload'] )->get_parsed();
171205

172206
return $this->addDefinitions( $defns );
173207
}

‎src/App_Factory.php

+55-9
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
namespace XWP\DI;
1010

1111
use DI\Definition\Source\SourceCache;
12+
use Psr\Log\LogLevel;
1213
use XWP\DI\Interfaces\Extension_Module;
1314
use XWP\Helper\Traits\Singleton;
1415

@@ -271,28 +272,54 @@ private function parse_ext_config( array $config ): array {
271272
* @return array<string,mixed>
272273
*/
273274
private function parse_app_config( array $config ): array {
274-
$is_prod = 'production' === \wp_get_environment_type();
275-
$apcu_on = SourceCache::isSupported();
276-
$config = $this->parse_legacy_config( $config );
277-
278-
return \xwp_parse_args(
275+
$config = $this->parse_legacy_config( $config );
276+
$config = \xwp_parse_args(
279277
$config,
280278
array(
281279
'app_class' => 'CompiledContainer' . \strtoupper( $config['app_id'] ),
282280
'app_file' => false,
281+
'app_preload' => false,
283282
'app_type' => $this->parse_type( (string) ( $config['app_file'] ?? null ) ),
284283
'app_version' => '0.0.0-dev',
285-
'cache_app' => $is_prod,
286-
'cache_defs' => $is_prod && $apcu_on,
284+
'cache_app' => $this->is_prod(),
285+
'cache_defs' => $this->is_prod() && SourceCache::isSupported(),
287286
'cache_dir' => \WP_CONTENT_DIR . '/cache/xwp-di/' . $config['app_id'],
288-
'cache_hooks' => $is_prod,
287+
'cache_hooks' => $this->is_prod(),
289288
'extendable' => true,
289+
'logger' => false,
290290
'public' => true,
291291
'use_attributes' => true,
292292
'use_autowiring' => true,
293293
'use_proxies' => false,
294294
),
295295
);
296+
297+
return $this->parse_log_config( $config );
298+
}
299+
300+
/**
301+
* Parses the log config
302+
*
303+
* @param array<string,mixed> $config Configuration options.
304+
* @return array<string,mixed>
305+
*/
306+
private function parse_log_config( array $config ): array {
307+
$logger = \is_array( $config['logger'] )
308+
? $config['logger']
309+
: array( 'enabled' => (bool) $config['logger'] );
310+
311+
$config['logger'] = \xwp_parse_args(
312+
$logger,
313+
array(
314+
'basedir' => \WP_CONTENT_DIR . '/logs/xwp-di',
315+
'enabled' => true,
316+
'handler' => Logger::class,
317+
'level' => $this->is_prod() ? LogLevel::ERROR : LogLevel::DEBUG,
318+
'prefix' => $config['app_id'],
319+
),
320+
);
321+
322+
return $config;
296323
}
297324

298325
/**
@@ -330,7 +357,7 @@ private function parse_legacy_config( $config ): array {
330357
throw new \InvalidArgumentException( 'Missing app_module' );
331358
}
332359

333-
if ( 'production' !== \wp_get_environment_type() && ! \defined( 'XWP_DI_HIDE_ERRORS' ) ) {
360+
if ( $this->can_debug( $config['app_id'] ) ) {
334361
\_doing_it_wrong(
335362
'xwp_create_app',
336363
\sprintf(
@@ -367,4 +394,23 @@ protected function parse_type( string $file ): string {
367394
protected function is_uninstalling( string|bool $file ): bool {
368395
return \defined( 'WP_UNINSTALL_PLUGIN' ) && WP_UNINSTALL_PLUGIN === $file;
369396
}
397+
398+
/**
399+
* Can we debug this container?
400+
*
401+
* @param string|null $app_id Application ID.
402+
* @return bool
403+
*/
404+
protected function can_debug( ?string $app_id = null ): bool {
405+
return ! \defined( 'XWP_DI_DEBUG_APP' ) || \str_contains( XWP_DI_DEBUG_APP, $app_id );
406+
}
407+
408+
/**
409+
* Is this a production environment?
410+
*
411+
* @return bool
412+
*/
413+
protected function is_prod(): bool {
414+
return 'production' === \wp_get_environment_type();
415+
}
370416
}

‎src/Container.php

+61-10
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,26 @@
1212
use DI\Definition\Source\MutableDefinitionSource;
1313
use DI\Proxy\ProxyFactory;
1414
use Psr\Container\ContainerInterface;
15+
use XWP\DI\Hook\Factory;
16+
use XWP\DI\Interfaces\Can_Handle;
17+
use XWP\DI\Interfaces\Can_Invoke;
1518

1619
/**
1720
* Custom WordPress container.
21+
*
22+
* @mixin Invoker
1823
*/
1924
class Container extends DI_Container {
25+
/**
26+
* Invoker methods.
27+
*/
28+
private const INV_METHODS = array(
29+
'create_handler',
30+
'register_handler',
31+
'load_handler',
32+
'load_callbacks',
33+
);
34+
2035
/**
2136
* Did we start the container.
2237
*
@@ -43,9 +58,27 @@ public function __construct(
4358
) {
4459
parent::__construct( $definitions, $proxyFactory, $wrapperContainer );
4560

46-
$this->resolvedEntries[ self::class ] = $this;
47-
$this->resolvedEntries[ static::class ] = $this;
48-
$this->resolvedEntries['xwp.invoker'] = $this->get( Invoker::class );
61+
$this->resolvedEntries[ self::class ] = $this;
62+
$this->resolvedEntries[ static::class ] = $this;
63+
$this->resolvedEntries['xwp.invoker'] = $this->has( 'xwp.invoker' )
64+
? $this->get( 'xwp.invoker' )
65+
: $this->get( Invoker::class );
66+
$this->resolvedEntries[ Invoker::class ] = $this->resolvedEntries['xwp.invoker'];
67+
}
68+
69+
/**
70+
* Magic method to call invoker methods.
71+
*
72+
* @param string $name Method name.
73+
* @param array<mixed,mixed> $args Method arguments.
74+
* @return mixed
75+
*/
76+
public function __call( string $name, array $args ): mixed {
77+
if ( \in_array( $name, self::INV_METHODS, true ) ) {
78+
return $this->resolvedEntries['xwp.invoker']->$name( ...$args );
79+
}
80+
81+
return null;
4982
}
5083

5184
/**
@@ -60,14 +93,11 @@ public function run(): static {
6093
throw new \RuntimeException( 'Container already started.' );
6194
}
6295

63-
$this->call(
64-
array( 'xwp.invoker', 'load_module' ),
65-
array( 'module' => $this->get( 'app' ) ),
66-
);
96+
$this->started = true;
6797

68-
\do_action( "xwp_{$this->get('app.uuid')}_app_start" );
98+
$this->get( Invoker::class )->register_handler( $this->get( 'app.module' ) );
6999

70-
$this->started = true;
100+
\do_action( "xwp_{$this->get('app.uuid')}_app_start" );
71101

72102
return $this;
73103
}
@@ -78,7 +108,28 @@ public function run(): static {
78108
* @template T of object
79109
* @param T $handler Class instance to register as a handler.
80110
*/
81-
public function register( object $handler ): void {
111+
public function hookOn( object $handler ): void {
82112
$this->get( 'xwp.invoker' )->register_handler( $handler );
83113
}
114+
115+
/**
116+
* Register a handler or a module.
117+
*
118+
* @template T of object
119+
*
120+
* @param T $instance Class instance to register as a handler.
121+
* @return Can_Handle<T>
122+
*/
123+
public function register( object $instance ): Can_Handle {
124+
return $this->load_handler( $instance );
125+
}
126+
127+
/**
128+
* Is the container started.
129+
*
130+
* @return bool
131+
*/
132+
public function started(): bool {
133+
return $this->started;
134+
}
84135
}

0 commit comments

Comments
 (0)