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

feat: implement WordPress native search endpoint #671

Merged
merged 19 commits into from
Feb 20, 2024

Conversation

lucymtc
Copy link
Contributor

@lucymtc lucymtc commented Jan 19, 2024

Description of the Change

Closes #546

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 Jan 19, 2024

🦋 Changeset detected

Latest commit: bebb952

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

This PR includes changesets to release 3 packages
Name Type
@headstartwp/headstartwp Minor
@headstartwp/core Minor
@headstartwp/next Minor

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

Copy link

vercel bot commented Jan 19, 2024

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

Name Status Preview Comments Updated (UTC)
headstarwp ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 20, 2024 8:05pm

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! 🙌

@lucymtc lucymtc changed the title feat: prepare embedable post links in search results feat: implement WordPress native search endpoint Jan 26, 2024
@lucymtc lucymtc requested a review from nicholasio January 26, 2024 22:57
@lucymtc lucymtc marked this pull request as ready for review January 26, 2024 22:58

This comment was marked as outdated.

Copy link
Member

@nicholasio nicholasio left a comment

Choose a reason for hiding this comment

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

Nice Job! This is looks really good. Just a few more things and it should be good to go.

Copy link
Contributor

github-actions bot commented Feb 2, 2024

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

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

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 122.93 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.13 KB 133.06 KB 91.76% (🟡 +0.08%)
/[...path] 7.12 KB 130.05 KB 89.69% (🟡 +0.01%)
/author/[...path] 5.72 KB 128.65 KB 88.72% (🟢 -0.17%)
/blog/[[...path]] 10.48 KB 133.41 KB 92.01% (🟡 +0.07%)
/category/[...path] 5.48 KB 128.41 KB 88.56% (🟢 -0.15%)
/search/[[...path]] 3.44 KB 126.38 KB 87.16% (🟢 -1.29%)
/tag/[...path] 5.51 KB 128.44 KB 88.58% (🟢 -0.16%)
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.

@lucymtc
Copy link
Contributor Author

lucymtc commented Feb 2, 2024

@nicholasio I've addressed your comments, I still need to do couple of things.

  1. Lang in search is not working properly. Not even when fetching with the current useSearch strategy, I need to look into it.
  2. The Page number in title still needs some fixing

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

packages/core/src/data/types/entities.ts Outdated Show resolved Hide resolved
packages/core/src/data/types/entities.ts Outdated Show resolved Hide resolved

This comment was marked as outdated.

@nicholasio
Copy link
Member

FYI: Somehow I managed to messed up the previous commit that adds some basic tests.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Copy link
Contributor

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

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

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 122.93 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.13 KB 133.06 KB 91.76% (🟡 +0.08%)
/[...path] 7.12 KB 130.05 KB 89.69% (🟡 +0.01%)
/author/[...path] 5.72 KB 128.65 KB 88.72% (🟢 -0.17%)
/blog/[[...path]] 10.48 KB 133.41 KB 92.01% (🟡 +0.07%)
/category/[...path] 5.48 KB 128.41 KB 88.56% (🟢 -0.15%)
/search/[[...path]] 3.52 KB 126.45 KB 87.20% (🟢 -1.23%)
/tag/[...path] 5.51 KB 128.44 KB 88.58% (🟢 -0.16%)
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/headless_framework

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

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 122.93 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.13 KB 133.06 KB 91.76% (🟡 +0.08%)
/[...path] 7.12 KB 130.05 KB 89.69% (🟡 +0.01%)
/author/[...path] 5.72 KB 128.65 KB 88.72% (🟢 -0.17%)
/blog/[[...path]] 10.48 KB 133.41 KB 92.01% (🟡 +0.07%)
/category/[...path] 5.48 KB 128.41 KB 88.56% (🟢 -0.15%)
/search/[[...path]] 3.52 KB 126.45 KB 87.20% (🟢 -1.23%)
/tag/[...path] 5.51 KB 128.44 KB 88.58% (🟢 -0.16%)
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
Member

@nicholasio nicholasio left a comment

Choose a reason for hiding this comment

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

Excellent work here @lucymtc. I've added some tests and docs and this is now ready to be merged & released.

@nicholasio nicholasio merged commit 8452279 into develop Feb 20, 2024
11 checks passed
@nicholasio nicholasio deleted the feature/wp-search-endpoint branch February 20, 2024 20:30
@10up 10up deleted a comment from github-actions bot Feb 20, 2024
@10up 10up deleted a comment from github-actions bot Feb 20, 2024
@10up 10up deleted a comment from github-actions bot Feb 20, 2024
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.

Update Search Strategy to use the native REST API search endpoint
2 participants