Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix logic for seeking during optimization loop to prevent emitting seek() notices #1376

Merged
merged 8 commits into from
Jul 19, 2024
Merged

Fix logic for seeking during optimization loop to prevent emitting seek() notices #1376

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c7798ba
Only seek back to the current tag if a tag visitor seeked
westonruter Jul 18, 2024
4a2466b
Add missing bookmark name to warning message
westonruter Jul 18, 2024
a60c5d0
Fix attribute order in tests now that seeking is not happening
westonruter Jul 18, 2024
442d252
Add test to ensure tag visitation does not exceed seek limit
westonruter Jul 18, 2024
89d5bcc
Update attribute order in embed-optimizer test due to not seeking
westonruter Jul 18, 2024
d406219
Account for visitors calling next_token() not just seek()
westonruter Jul 18, 2024
ca2a99b
Update attribute order in Image Prioritizer test after eliminating ex…
westonruter Jul 18, 2024
1bb8bbc
Prepare 0.4.1 release of Optimization Detective
westonruter Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions plugins/optimization-detective/class-od-html-tag-processor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,17 @@ public function seek( $bookmark_name ): bool {
return $result;
}

/**
* Gets the seek count.
*
* @since n.e.x.t
*
* @return int Seek count.
*/
public function get_seek_count(): int {
return $this->seek_count;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

}

/**
* Sets a bookmark in the HTML document.
*
Expand Down Expand Up @@ -539,8 +550,11 @@ public function get_updated_html(): string {
}
if ( ! $this->has_bookmark( $bookmark ) ) {
$this->warn(
/* translators: %s is the bookmark name */
__( 'Unable to append markup to %s since the bookmark no longer exists.', 'optimization-detective' )
sprintf(
/* translators: %s is the bookmark name */
__( 'Unable to append markup to %s since the bookmark no longer exists.', 'optimization-detective' ),
$bookmark
)
);
} else {
$start = $this->bookmarks[ $bookmark ]->start;
Expand Down
15 changes: 9 additions & 6 deletions plugins/optimization-detective/optimization.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,13 +177,16 @@ function od_optimize_template_output_buffer( string $buffer ): string {
while ( $processor->next_open_tag() ) {
$did_visit = false;
$processor->set_bookmark( $current_tag_bookmark );
foreach ( $visitors as $visitor ) {
$did_visit = $visitor( $tag_visitor_context ) || $did_visit;

// Since the visitor may have traversed HTML tags, we need to make sure we go back to this tag so that
// in the next iteration any relevant tag visitors may apply, in addition to properly setting the data-od-xpath
// on this tag below.
$processor->seek( $current_tag_bookmark );
foreach ( $visitors as $visitor ) {
$seek_count = $processor->get_seek_count();
$did_visit = $visitor( $tag_visitor_context ) || $did_visit;

// If the visitor traversed HTML tags, we need to go back to this tag so that in the next iteration any
// relevant tag visitors may apply, in addition to properly setting the data-od-xpath on this tag below.
if ( $seek_count !== $processor->get_seek_count() ) {
$processor->seek( $current_tag_bookmark );
}
}
$processor->release_bookmark( $current_tag_bookmark );

Expand Down
3 changes: 3 additions & 0 deletions plugins/optimization-detective/tests/test-class-od-html-tag-processor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,7 @@ public function test_html_tag_processor_wrapper_methods(): void {
/**
* Test bookmarking and seeking.
*
* @covers ::get_seek_count
* @covers ::set_bookmark
* @covers ::seek
* @covers ::release_bookmark
Expand All @@ -519,6 +520,7 @@ public function test_bookmarking_and_seeking(): void {
);

$actual_figure_contents = array();
$this->assertSame( 0, $processor->get_seek_count() );

$bookmarks = array();
while ( $processor->next_open_tag() ) {
Expand Down Expand Up @@ -580,6 +582,7 @@ public function test_bookmarking_and_seeking(): void {
'depth' => $processor->get_current_depth(),
);
}
$this->assertSame( count( $bookmarks ), $processor->get_seek_count() );

$this->assertSame( $expected_figure_contents, $sought_actual_contents );

Expand Down
Loading