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

Support for multiple queries in a Faust template #1626

Closed
wants to merge 5 commits into from

Conversation

blakewilson
Copy link
Contributor

@blakewilson blakewilson commented Oct 27, 2023

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

Provide a way to use multiple queries in a Faust template.

Introduces the new Component.queries property to execute multiple queries, and the useFaustQuery hook to retrieve the data.

Related Issue(s):

Testing

  1. Checkout this repo
  2. Install dependencies npm install
  3. Build the packages npm run build
  4. Start the example project npm run dev -w @faustwp/getting-started-example
  5. Navigate to a single post, and notice it renders as expected with the two queries provided in wp-templates/single.js

Screenshots

Documentation Changes

Dependant PRs

@changeset-bot
Copy link

changeset-bot bot commented Oct 27, 2023

⚠️ No Changeset found

Latest commit: 3bd56f6

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 27, 2023

📦 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 245.53 KB (🟡 +202 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!

Two 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)
/ 289 B 245.81 KB 70.23% (+/- <0.01%)
/[...wordpressNode] 301 B 245.82 KB 70.23% (+/- <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.

const queryCalls = template.queries.map((query) => {
return client.query({
query,
variables: templateVariables,
Copy link
Member

Choose a reason for hiding this comment

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

This is the tricky part. Each query may need different variables and not we are bundling all the potential variables on each requests. This could get out of hand soon.

variables: templateVariables,
});
});
const queriesRes = await Promise.all(queryCalls);
Copy link
Member

@theodesp theodesp Nov 1, 2023

Choose a reason for hiding this comment

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

Promise.all will fire up all promises at once. However this would probably fail if one request is dependent on another for specific variables. Also if one of them fails then all of them will fail.

Not sure how reasonable is this to do....

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.

2 participants