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.

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

Feature/yoast payload optimize #727

Draft
wants to merge 10 commits into
base: develop
Choose a base branch
from

Conversation

lucymtc
Copy link
Contributor

@lucymtc lucymtc commented Mar 21, 2024

Description of the Change

Optimize Yoast payload response ensuring only necessary Yoast data is added to the elements in _embedded that are needed.

Closes #563

How to test the Change

Changelog Entry

Added - New feature
Changed - Existing functionality
Deprecated - Soon-to-be removed feature
Removed - Feature
Fixed - Bug fix
Security - Vulnerability

Credits

Props @username, @username2, ...

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

Copy link

changeset-bot bot commented Mar 21, 2024

⚠️ No Changeset found

Latest commit: e087077

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link

vercel bot commented Mar 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
headstartwp-app-router ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 8:47am
headstarwp ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 8:47am

@lucymtc lucymtc requested a review from nicholasio March 21, 2024 16:32
$this->assert_yoast_head_in_response( $result );

// Perform a REST API request for the posts by author.
// $result = $this->get_posts_by_with_optimised_response( 'author', $this->author_id );
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nicholasio Not sure why this request returns empty data although posts are created with the correct author id

Copy link
Contributor

📦 Next.js Bundle Analysis for @10up/headless_framework

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

This PR introduced no changes to the JavaScript bundle! 🙌

Copy link
Contributor

📦 Next.js Bundle Analysis for @10up/headstartwp

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

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 124.29 KB (🟡 +10 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!

Seven 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 (145 KB)
/ 10.44 KB 134.72 KB 92.91% (🟡 +0.10%)
/[...path] 7.25 KB 131.54 KB 90.72% (🟡 +0.05%)
/author/[...path] 5.96 KB 130.24 KB 89.82% (🟡 +0.09%)
/blog/[[...path]] 10.9 KB 135.19 KB 93.23% (🟡 +0.12%)
/category/[...path] 5.66 KB 129.94 KB 89.62% (🟡 +0.04%)
/search/[[...path]] 3.66 KB 127.95 KB 88.24% (🟡 +0.03%)
/tag/[...path] 5.66 KB 129.95 KB 89.62% (🟡 +0.04%)
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.

Copy link
Contributor

📦 Next.js Bundle Analysis for @10up/headstartwp

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

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 124.29 KB (🟡 +10 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!

Seven 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 (145 KB)
/ 10.44 KB 134.72 KB 92.91% (🟡 +0.10%)
/[...path] 7.25 KB 131.54 KB 90.72% (🟡 +0.05%)
/author/[...path] 5.96 KB 130.24 KB 89.82% (🟡 +0.09%)
/blog/[[...path]] 10.9 KB 135.19 KB 93.23% (🟡 +0.12%)
/category/[...path] 5.66 KB 129.94 KB 89.62% (🟡 +0.04%)
/search/[[...path]] 3.66 KB 127.95 KB 88.24% (🟡 +0.03%)
/tag/[...path] 5.66 KB 129.95 KB 89.62% (🟡 +0.04%)
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reduce Yoast overhead by removing and preventing additional queries for Yoast metadata
1 participant