Support deferStream when loading queries

[sairion]

fixes #44

[changeset-bot]

⚠️ No Changeset found

Latest commit: 2853583

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.

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

[gemini-code-assist]

Summary of Changes

Hello @sairion, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the data fetching capabilities by integrating support for GraphQL's defer and stream directives. This allows applications to progressively render UI components and efficiently handle large lists, improving perceived performance and user experience by loading critical data first and then streaming in the rest.

Highlights

• Defer/Stream Support: Introduced an optional deferStream parameter to createFragment, createLazyLoadQuery, and createRefetchableFragment functions, enabling support for GraphQL's @defer and @stream directives.
• API Extension: Extended the public API of key data fetching primitives to allow consumers to explicitly control deferred and streamed data loading behavior.
• Internal Integration: Propagated the deferStream option through internal function calls (createFragmentInternal, createLazyLoadQueryInternal) to ensure it is applied during resource creation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[codecov]

Codecov Report

❌ Patch coverage is 18.18182% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 27.72%. Comparing base (6c4274b) to head (2853583).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/primitives/createRefetchableFragment.ts	0.00%	5 Missing ⚠️
src/primitives/createFragment.ts	0.00%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #45      +/-   ##
==========================================
- Coverage   27.77%   27.72%   -0.06%     
==========================================
  Files          21       21              
  Lines        1422     1432      +10     
  Branches       73       73              
==========================================
+ Hits          395      397       +2     
- Misses       1027     1035       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/XiNiHa/solid-relay@45

commit: 2853583

[gemini-code-assist]

Code Review

This pull request adds support for deferStream when loading queries by passing a new options object through createFragment, createLazyLoadQuery, and createRefetchableFragment. The changes are logical and correctly plumb the deferStream option down to createResource. My feedback focuses on improving maintainability by reducing code duplication for the newly introduced options type across function overloads.