Fix: Ensure Accurate Detection of WordPress Previews via URL Query Parameters

[theodesp]

Tasks

• I have signed a Contributor License Agreement (CLA) with WP Engine.
• If a code change, I have written testing instructions that the whole team & outside contributors can understand.
• I have written and included a comprehensive changeset to properly document the changes I've made.

Description

This PR addresses a bug in the WordPressTemplate component where the detection of WordPress preview URLs was overly broad, potentially catching non-WordPress preview URLs. The fix introduces a more precise method for determining if the URL is a WordPress preview.

Related Issue(s):

#1903

Problem

The previous implementation checked if the URL query string contained preview=true using a simple string includes method. This approach could incorrectly identify non-WordPress previews as WordPress previews if they happened to have a similar query parameter structure.

Solution

• Introduced a utility function isWordPressPreview to accurately check for the presence of preview=true in the URL query parameters.
• Updated the WordPressTemplate component to use this utility function for determining if the URL is a WordPress preview.
• Refactored the related unit tests to reflect these changes and ensure comprehensive test coverage.

Testing

Faust should not be redirecting logged out users (visitors) to the WP admin if the page contains a search query that contains the string preview=.

For example:

http://localhost:3000/posts/add-table?otpreview=true

Screenshots

Documentation Changes

Dependant PRs

[changeset-bot]

🦋 Changeset detected

Latest commit: 77e2983

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@faustwp/core	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[theodesp]

Problematic unit test with lots of testing anti-patterns. I removed this since we already test the logic of isWordPressPreview

[github-actions]

📦 Next.js Bundle Analysis for @faustwp/getting-started-example

This analysis was generated by the Next.js Bundle Analysis action. 🤖

⚠️ Global Bundle Size Increased

Page	Size (compressed)
global	250.48 KB (🟡 +36 B)

Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

Three Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page	Size (compressed)	First Load	% of Budget (350 KB)
/	290 B	250.76 KB	71.65% (+/- <0.01%)
/[...wordpressNode]	301 B	250.77 KB	71.65% (+/- <0.01%)
/preview	281 B	250.75 KB	71.64% (+/- <0.01%)

Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.