Skip to content

Commit 8373c35

Browse files
westonruterwestonruter
committed
Internalize admin bar processing in tag processor
1 parent ed4f1e6 commit 8373c35

File tree

3 files changed

+24
-29
lines changed

3 files changed

+24
-29
lines changed

‎plugins/optimization-detective/class-od-html-tag-processor.php

+7-2
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,12 @@ public function next_tag( $query = null ): bool {
262262
if ( null !== $query ) {
263263
throw new InvalidArgumentException( esc_html__( 'Processor subclass does not support queries.', 'optimization-detective' ) );
264264
}
265-
return parent::next_tag( array( 'tag_closers' => 'visit' ) );
265+
266+
// Elements in the Admin Bar are not relevant for optimization, so this loop ensures that no tags in the Admin Bar are visited.
267+
do {
268+
$matched = parent::next_tag( array( 'tag_closers' => 'visit' ) );
269+
} while ( $matched && $this->is_admin_bar() );
270+
return $matched;
266271
}
267272

268273
/**
@@ -714,7 +719,7 @@ public function get_stored_xpath(): string {
714719
*
715720
* @return bool Whether at or inside the admin bar.
716721
*/
717-
public function is_admin_bar(): bool {
722+
private function is_admin_bar(): bool {
718723
return (
719724
isset( $this->open_stack_tags[2], $this->open_stack_attributes[2]['id'] )
720725
&&

‎plugins/optimization-detective/optimization.php

-5
Original file line numberDiff line numberDiff line change
@@ -233,11 +233,6 @@ function od_optimize_template_output_buffer( string $buffer ): string {
233233
continue;
234234
}
235235

236-
// Elements in the Admin Bar are not relevant for optimization, so skip passing them to tag visitors.
237-
if ( $processor->is_admin_bar() ) {
238-
continue;
239-
}
240-
241236
$tracked_in_url_metrics = false;
242237
$processor->set_bookmark( $current_tag_bookmark ); // TODO: Should we break if this returns false?
243238

‎plugins/optimization-detective/tests/test-class-od-html-tag-processor.php

+17-22
Original file line numberDiff line numberDiff line change
@@ -335,20 +335,18 @@ public function data_provider_sample_documents(): array {
335335
</body>
336336
</html>
337337
',
338-
'open_tags' => array( 'HTML', 'HEAD', 'BODY', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG' ),
338+
'open_tags' => array( 'HTML', 'HEAD', 'BODY', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG' ),
339339
'xpath_breadcrumbs' => array(
340-
'/HTML' => array( 'HTML' ),
341-
'/HTML/HEAD' => array( 'HTML', 'HEAD' ),
342-
'/HTML/BODY' => array( 'HTML', 'BODY' ),
343-
'/HTML/BODY/DIV[@id=\'wpadminbar\']' => array( 'HTML', 'BODY', 'DIV' ),
344-
'/HTML/BODY/DIV[@id=\'wpadminbar\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
345-
'/HTML/BODY/DIV[@id=\'header\']' => array( 'HTML', 'BODY', 'DIV' ),
340+
'/HTML' => array( 'HTML' ),
341+
'/HTML/HEAD' => array( 'HTML', 'HEAD' ),
342+
'/HTML/BODY' => array( 'HTML', 'BODY' ),
343+
'/HTML/BODY/DIV[@id=\'header\']' => array( 'HTML', 'BODY', 'DIV' ),
346344
'/HTML/BODY/DIV[@id=\'header\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
347-
'/HTML/BODY/DIV[@id=\'primary\']' => array( 'HTML', 'BODY', 'DIV' ),
345+
'/HTML/BODY/DIV[@id=\'primary\']' => array( 'HTML', 'BODY', 'DIV' ),
348346
'/HTML/BODY/DIV[@id=\'primary\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
349-
'/HTML/BODY/DIV[@id=\'secondary\']' => array( 'HTML', 'BODY', 'DIV' ),
347+
'/HTML/BODY/DIV[@id=\'secondary\']' => array( 'HTML', 'BODY', 'DIV' ),
350348
'/HTML/BODY/DIV[@id=\'secondary\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
351-
'/HTML/BODY/DIV[@id=\'colophon\']' => array( 'HTML', 'BODY', 'DIV' ),
349+
'/HTML/BODY/DIV[@id=\'colophon\']' => array( 'HTML', 'BODY', 'DIV' ),
352350
'/HTML/BODY/DIV[@id=\'colophon\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
353351
),
354352
),
@@ -388,27 +386,25 @@ public function data_provider_sample_documents(): array {
388386
</body>
389387
</html>
390388
',
391-
'open_tags' => array( 'HTML', 'HEAD', 'BODY', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG' ),
389+
'open_tags' => array( 'HTML', 'HEAD', 'BODY', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG', 'DIV', 'IMG' ),
392390
'xpath_breadcrumbs' => array(
393-
'/HTML' => array( 'HTML' ),
394-
'/HTML/HEAD' => array( 'HTML', 'HEAD' ),
395-
'/HTML/BODY' => array( 'HTML', 'BODY' ),
396-
'/HTML/BODY/DIV[@id=\'wpadminbar\']' => array( 'HTML', 'BODY', 'DIV' ),
397-
'/HTML/BODY/DIV[@id=\'wpadminbar\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
398-
'/HTML/BODY/DIV[@role=\'banner\']' => array( 'HTML', 'BODY', 'DIV' ),
391+
'/HTML' => array( 'HTML' ),
392+
'/HTML/HEAD' => array( 'HTML', 'HEAD' ),
393+
'/HTML/BODY' => array( 'HTML', 'BODY' ),
394+
'/HTML/BODY/DIV[@role=\'banner\']' => array( 'HTML', 'BODY', 'DIV' ),
399395
'/HTML/BODY/DIV[@role=\'banner\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
400396
'/HTML/BODY/DIV[@class=\'content-area main\']' => array( 'HTML', 'BODY', 'DIV' ),
401397
'/HTML/BODY/DIV[@class=\'content-area main\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
402398
'/HTML/BODY/DIV[@class=\'widget-area\']' => array( 'HTML', 'BODY', 'DIV' ),
403399
'/HTML/BODY/DIV[@class=\'widget-area\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
404400
'/HTML/BODY/DIV[@class=\'site-footer\']' => array( 'HTML', 'BODY', 'DIV' ),
405401
'/HTML/BODY/DIV[@class=\'site-footer\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
406-
'/HTML/BODY/DIV[@class=\'\']' => array( 'HTML', 'BODY', 'DIV' ),
402+
'/HTML/BODY/DIV[@class=\'\']' => array( 'HTML', 'BODY', 'DIV' ),
407403
'/HTML/BODY/DIV[@class=\'\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
408-
'/HTML/BODY/DIV[@role=\'\']' => array( 'HTML', 'BODY', 'DIV' ),
404+
'/HTML/BODY/DIV[@role=\'\']' => array( 'HTML', 'BODY', 'DIV' ),
409405
'/HTML/BODY/DIV[@role=\'\']/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
410-
'/HTML/BODY/DIV' => array( 'HTML', 'BODY', 'DIV' ),
411-
'/HTML/BODY/DIV/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
406+
'/HTML/BODY/DIV' => array( 'HTML', 'BODY', 'DIV' ),
407+
'/HTML/BODY/DIV/*[1][self::IMG]' => array( 'HTML', 'BODY', 'DIV', 'IMG' ),
412408
),
413409
),
414410
);
@@ -442,7 +438,6 @@ public function test_next_tag_and_get_xpath( string $document, array $open_tags,
442438

443439
$xpath = $p->get_stored_xpath();
444440
$this->assertArrayNotHasKey( $xpath, $actual_xpath_breadcrumbs_mapping, 'Each tag must have a unique XPath.' );
445-
$this->assertSame( str_starts_with( $xpath, '/HTML/BODY/DIV[@id=\'wpadminbar\']' ), $p->is_admin_bar(), "Unexpected is_admin_bar for $xpath" );
446441

447442
$actual_xpath_breadcrumbs_mapping[ $xpath ] = $p->get_breadcrumbs();
448443

0 commit comments

Comments
 (0)