Include optional TError on DataTag so that getQueryState can infer the error type correctly #8361
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 10420a4. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
Nick-Lucas
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8361 +/- ##
===========================================
+ Coverage 46.12% 62.90% +16.78%
===========================================
Files 200 136 -64
Lines 7504 4799 -2705
Branches 1712 1345 -367
===========================================
- Hits 3461 3019 -442
+ Misses 3668 1540 -2128
+ Partials 375 240 -135 |
|
The tRPC PR now has this implemented and looks good, though you'd need to locally link to this PR to make it work: trpc/trpc#6265
|
TkDodo
reviewed
Nov 28, 2024
TkDodo
reviewed
Nov 28, 2024
TkDodo
approved these changes
Nov 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current
getQueryStatecan infer the data type correctly via the DataTag type.DataTag does not include any type information for the Error type however.
At tRPC we are working on a package to generate query keys, query filters, and query options automatically based on your tRPC type. This will provide the ability to call
getQueryStatebut currently no ability to create inference for the error because of the current limitations of DataTag. trpc/trpc#6265 - similar to #8332 it seems right to improve this upstream so everybody can benefit, though this time it also can't be easily improved downstreamThis PR updates DataTag with a 3rd optional type parameter for TError, defaulting to
unknownto avoid breaking changes for RQ users. getQueryState now infers the error type from this information or automatically falls back on its own TError value if the DataTag is unsetAlternative implementation could be to do an
ErrorTagalongsideDataTagbut this one seems more in-line with how type params are set up elsewhere in RQ