Skip to content

Commit 56cbe8e

Browse files
ShyamGaddeShyamGadde
committed
Use dependency injection instead of relying on globals
Signed-off-by: Shyamsundar Gadde <[email protected]>
1 parent f66012e commit 56cbe8e

File tree

5 files changed

+36
-41
lines changed

5 files changed

+36
-41
lines changed

‎plugins/optimization-detective/optimization.php

+13-1
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,10 @@ function od_is_response_html_content_type(): bool {
170170
* @since 0.1.0
171171
* @access private
172172
*
173+
* @global WP_Query $wp_the_query WP_Query object.
174+
* @global string $_wp_current_template_id Current template ID.
175+
* @global string $template Template file path.
176+
*
173177
* @param string $buffer Template output buffer.
174178
* @return string Filtered template output buffer.
175179
*/
@@ -206,7 +210,15 @@ function od_optimize_template_output_buffer( string $buffer ): string {
206210
*/
207211
do_action( 'od_register_tag_visitors', $tag_visitor_registry );
208212

209-
$current_etag = od_get_current_url_metrics_etag( $tag_visitor_registry );
213+
if ( wp_is_block_theme() ) {
214+
// Extract the template slug from $_wp_current_template_id, which has the format 'theme_slug//template_slug'.
215+
$parts = explode( '//', $GLOBALS['_wp_current_template_id'] );
216+
$current_template = ( 2 === count( $parts ) ) ? $parts[1] : '';
217+
} else {
218+
$current_template = basename( $GLOBALS['template'] );
219+
}
220+
221+
$current_etag = od_get_current_url_metrics_etag( $tag_visitor_registry, $GLOBALS['wp_the_query'], $current_template );
210222
$group_collection = new OD_URL_Metric_Group_Collection(
211223
$post instanceof WP_Post ? OD_URL_Metrics_Post_Type::get_url_metrics_from_post( $post ) : array(),
212224
$current_etag,

‎plugins/optimization-detective/storage/data.php

+8-30
Original file line numberDiff line numberDiff line change
@@ -150,47 +150,25 @@ function od_get_url_metrics_slug( array $query_vars ): string {
150150
* @since n.e.x.t
151151
* @access private
152152
*
153-
* @global WP_Query $wp_the_query Global WP_Query instance.
154-
* @global string $_wp_current_template_id Current template ID.
155-
* @global string $template Template file path.
156-
*
157153
* @param OD_Tag_Visitor_Registry $tag_visitor_registry Tag visitor registry.
154+
* @param WP_Query $wp_query The WP_Query instance.
155+
* @param string $current_template The current template being used.
158156
* @return non-empty-string Current ETag.
159157
*/
160-
function od_get_current_url_metrics_etag( OD_Tag_Visitor_Registry $tag_visitor_registry ): string {
161-
if ( isset( $GLOBALS['wp_the_query']->posts ) && is_array( $GLOBALS['wp_the_query']->posts ) ) {
162-
$queried_posts = array_map(
163-
static function ( WP_Post $post ): array {
164-
return array(
165-
'ID' => $post->ID,
166-
'last_modified' => $post->post_modified_gmt,
167-
);
168-
},
169-
$GLOBALS['wp_the_query']->posts
170-
);
171-
} else {
172-
$queried_posts = array();
173-
}
174-
158+
function od_get_current_url_metrics_etag( OD_Tag_Visitor_Registry $tag_visitor_registry, WP_Query $wp_query, string $current_template ): string {
175159
$data = array(
176-
'tag_visitors' => array_keys( iterator_to_array( $tag_visitor_registry ) ),
177-
'queried_object' => get_queried_object(),
178-
'queried_posts' => $queried_posts,
179-
'active_theme' => array(
160+
'tag_visitors' => array_keys( iterator_to_array( $tag_visitor_registry ) ),
161+
'queried_object' => $wp_query->get_queried_object(),
162+
'queried_posts' => wp_list_pluck( $wp_query->posts, 'post_modified_gmt', 'ID' ),
163+
'active_theme' => array(
180164
'template' => get_template(),
181165
'template_version' => wp_get_theme( get_template() )->get( 'Version' ),
182166
'stylesheet' => get_stylesheet(),
183167
'stylesheet_version' => wp_get_theme()->get( 'Version' ),
184168
),
169+
'current_template' => $current_template,
185170
);
186171

187-
if ( wp_is_block_theme() ) {
188-
// Extract the template slug from $_wp_current_template_id, which has the format 'theme_slug//template_slug'.
189-
$data['current_template'] = explode( '//', $GLOBALS['_wp_current_template_id'] ?? '' )[1] ?? '';
190-
} else {
191-
$data['current_template'] = basename( $GLOBALS['template'] ?? '' );
192-
}
193-
194172
/**
195173
* Filters the data that goes into computing the current ETag for URL Metrics.
196174
*

‎plugins/optimization-detective/tests/storage/test-data.php

+10-8
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,9 @@ public function test_od_get_url_metrics_slug(): void {
293293
*/
294294
public function test_od_get_current_url_metrics_etag(): void {
295295
remove_all_filters( 'od_current_url_metrics_etag_data' );
296-
$registry = new OD_Tag_Visitor_Registry();
296+
$registry = new OD_Tag_Visitor_Registry();
297+
$wp_the_query = new WP_Query();
298+
$current_template = 'index.php';
297299

298300
$captured_etag_data = array();
299301
add_filter(
@@ -304,9 +306,9 @@ static function ( array $data ) use ( &$captured_etag_data ) {
304306
},
305307
PHP_INT_MAX
306308
);
307-
$etag1 = od_get_current_url_metrics_etag( $registry );
309+
$etag1 = od_get_current_url_metrics_etag( $registry, $wp_the_query, $current_template );
308310
$this->assertMatchesRegularExpression( '/^[a-z0-9]{32}\z/', $etag1 );
309-
$etag2 = od_get_current_url_metrics_etag( $registry );
311+
$etag2 = od_get_current_url_metrics_etag( $registry, $wp_the_query, $current_template );
310312
$this->assertSame( $etag1, $etag2 );
311313
$this->assertCount( 2, $captured_etag_data );
312314
$this->assertSame(
@@ -320,7 +322,7 @@ static function ( array $data ) use ( &$captured_etag_data ) {
320322
'stylesheet' => 'default',
321323
'stylesheet_version' => '1.6',
322324
),
323-
'current_template' => '',
325+
'current_template' => 'index.php',
324326
),
325327
$captured_etag_data[0]
326328
);
@@ -329,7 +331,7 @@ static function ( array $data ) use ( &$captured_etag_data ) {
329331
$registry->register( 'foo', static function (): void {} );
330332
$registry->register( 'bar', static function (): void {} );
331333
$registry->register( 'baz', static function (): void {} );
332-
$etag3 = od_get_current_url_metrics_etag( $registry );
334+
$etag3 = od_get_current_url_metrics_etag( $registry, $wp_the_query, $current_template );
333335
$this->assertNotEquals( $etag2, $etag3 );
334336
$this->assertNotEquals( $captured_etag_data[ count( $captured_etag_data ) - 2 ], $captured_etag_data[ count( $captured_etag_data ) - 1 ] );
335337
$this->assertSame(
@@ -343,7 +345,7 @@ static function ( array $data ) use ( &$captured_etag_data ) {
343345
'stylesheet' => 'default',
344346
'stylesheet_version' => '1.6',
345347
),
346-
'current_template' => '',
348+
'current_template' => 'index.php',
347349
),
348350
$captured_etag_data[ count( $captured_etag_data ) - 1 ]
349351
);
@@ -359,7 +361,7 @@ static function ( $data ): array {
359361
return $data;
360362
}
361363
);
362-
$etag4 = od_get_current_url_metrics_etag( $registry );
364+
$etag4 = od_get_current_url_metrics_etag( $registry, $wp_the_query, $current_template );
363365
$this->assertNotEquals( $etag3, $etag4 );
364366
$this->assertNotEquals( $captured_etag_data[ count( $captured_etag_data ) - 2 ], $captured_etag_data[ count( $captured_etag_data ) - 1 ] );
365367
$this->assertSame(
@@ -378,7 +380,7 @@ static function ( $data ): array {
378380
'stylesheet' => 'default',
379381
'stylesheet_version' => '1.6',
380382
),
381-
'current_template' => '',
383+
'current_template' => 'index.php',
382384
),
383385
$captured_etag_data[ count( $captured_etag_data ) - 1 ]
384386
);

‎plugins/optimization-detective/tests/test-optimization.php

+3
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,7 @@ public function data_provider_test_od_optimize_template_output_buffer(): array {
291291
* @dataProvider data_provider_test_od_optimize_template_output_buffer
292292
*/
293293
public function test_od_optimize_template_output_buffer( Closure $set_up, string $buffer, string $expected ): void {
294+
$GLOBALS['template'] = '/path/to/theme/index.php';
294295
$set_up( $this );
295296

296297
add_action(
@@ -336,5 +337,7 @@ function ( OD_Tag_Visitor_Context $context ): bool {
336337
$this->remove_initial_tabs( $buffer ),
337338
"Buffer snapshot:\n$buffer"
338339
);
340+
341+
unset( $GLOBALS['template'] );
339342
}
340343
}

‎tests/class-optimization-detective-test-helpers.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ trait Optimization_Detective_Test_Helpers {
2727
*/
2828
public function populate_url_metrics( array $elements, bool $complete = true ): void {
2929
$slug = od_get_url_metrics_slug( od_get_normalized_query_vars() );
30-
$etag = od_get_current_url_metrics_etag( new OD_Tag_Visitor_Registry() ); // Note: Tests rely on the od_current_url_metrics_etag_data filter to set the desired value.
30+
$etag = od_get_current_url_metrics_etag( new OD_Tag_Visitor_Registry(), new WP_Query(), 'index.php' ); // Note: Tests rely on the od_current_url_metrics_etag_data filter to set the desired value.
3131
$sample_size = $complete ? od_get_url_metrics_breakpoint_sample_size() : 1;
3232
foreach ( array_merge( od_get_breakpoint_max_widths(), array( 1000 ) ) as $viewport_width ) {
3333
for ( $i = 0; $i < $sample_size; $i++ ) {
@@ -81,7 +81,7 @@ public function get_sample_dom_rect(): array {
8181
public function get_sample_url_metric( array $params ): OD_URL_Metric {
8282
$params = array_merge(
8383
array(
84-
'etag' => od_get_current_url_metrics_etag( new OD_Tag_Visitor_Registry() ), // Note: Tests rely on the od_current_url_metrics_etag_data filter to set the desired value.
84+
'etag' => od_get_current_url_metrics_etag( new OD_Tag_Visitor_Registry(), new WP_Query(), 'index.php' ), // Note: Tests rely on the od_current_url_metrics_etag_data filter to set the desired value.
8585
'url' => home_url( '/' ),
8686
'viewport_width' => 480,
8787
'elements' => array(),

0 commit comments

Comments
 (0)