feat: deepPartial #329
Merged
feat: deepPartial #329
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
WalkthroughThe recent updates across various GraphQL files primarily focus on enhancing type specificity and flexibility. By transitioning from Changes
Poem
🌟🐰🎉 Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (30)
- src/gql/heart-monitor/heart-monitor.ts (4 hunks)
- src/gql/mutation/marketing.ts (2 hunks)
- src/gql/query/communityPool.ts (2 hunks)
- src/gql/query/delegations.ts (3 hunks)
- src/gql/query/distributionCommissions.ts (3 hunks)
- src/gql/query/featureFlags.ts (3 hunks)
- src/gql/query/governance.ts (2 hunks)
- src/gql/query/ibc.ts (2 hunks)
- src/gql/query/inflation.ts (2 hunks)
- src/gql/query/markPriceCandles.ts (3 hunks)
- src/gql/query/marketing.ts (2 hunks)
- src/gql/query/oracle.ts (2 hunks)
- src/gql/query/perp.ts (2 hunks)
- src/gql/query/redelegations.ts (3 hunks)
- src/gql/query/spotLpPositions.ts (3 hunks)
- src/gql/query/spotPoolCreated.ts (3 hunks)
- src/gql/query/spotPoolExited.ts (3 hunks)
- src/gql/query/spotPoolJoined.ts (3 hunks)
- src/gql/query/spotPoolSwap.ts (3 hunks)
- src/gql/query/spotPools.ts (3 hunks)
- src/gql/query/stats.ts (2 hunks)
- src/gql/query/unbondings.ts (3 hunks)
- src/gql/query/users.ts (3 hunks)
- src/gql/query/validators.ts (3 hunks)
- src/gql/query/wasm.ts (2 hunks)
- src/gql/subscription/markPriceCandlesSubscription.ts (2 hunks)
- src/gql/subscription/oraclePricesSubscription.ts (3 hunks)
- src/gql/subscription/perpMarketSubscription.ts (2 hunks)
- src/gql/subscription/perpPositionsSubscription.ts (2 hunks)
- src/gql/utils/consts.ts (1 hunks)
Additional comments: 26
src/gql/query/featureFlags.ts (3)
- 8-8: The import of
DeepPartialis correctly added to support the enhanced type specificity for nested object structures. This aligns with the PR's objective to transition fromPartialtoDeepPartialfor improved type safety.- 17-17: The update of the
fieldsparameter type toDeepPartial<GQLFeatureFlags>in thefeatureFlagsQueryStringfunction is appropriate. It allows for more detailed type checking of nested structures, which is beneficial for the robustness of the application's type system.- 30-30: Similarly, the update of the
fieldsparameter type toDeepPartial<GQLFeatureFlags>in thefeatureFlagsfunction is consistent with the PR's objectives and enhances type safety for nested object structures.src/gql/query/distributionCommissions.ts (3)
- 10-10: The import of
DeepPartialis correctly added to support the enhanced typing system for nested object structures. This aligns with the PR's objective to replacePartialwithDeepPartial.- 20-20: The change from
Partial<GQLDistributionCommission>toDeepPartial<GQLDistributionCommission>for thefieldsparameter indistributionCommissionsQueryStringfunction is correctly implemented. This allows for more detailed and flexible type definitions, especially for nested object structures.- 40-40: Similarly, the update to
DeepPartial<GQLDistributionCommission>for thefieldsparameter in thedistributionCommissionsasync function is correctly applied. This modification enhances the typing system's robustness and specificity, aligning with the PR's objectives.src/gql/query/wasm.ts (2)
- 9-9: The import of
DeepPartialis correctly added, supporting the transition to a more detailed and flexible typing system for nested object structures within thewasm.tsfile.- 20-21: The update to use
DeepPartialforGqlWasmFieldsand within it foruserContractsis correctly implemented. This change enhances the type specificity and flexibility for handling nested object structures, aligning with the PR's objectives.src/gql/query/oracle.ts (2)
- 12-12: The import of
DeepPartialis correctly added, supporting the transition to a more detailed and flexible typing system for nested object structures within theoracle.tsfile.- 24-26: The update to use
DeepPartialforOracleFieldsand within it fororaclePricesandoraclesis correctly implemented. This change enhances the type specificity and flexibility for handling nested object structures, aligning with the PR's objectives.src/gql/query/inflation.ts (2)
- 12-12: The import of
DeepPartialis correctly added, supporting the transition to a more detailed and flexible typing system for nested object structures within theinflation.tsfile.- 24-26: The update to use
DeepPartialforInflationFieldsand within it fordistributionsandinflationsis correctly implemented. This change enhances the type specificity and flexibility for handling nested object structures, aligning with the PR's objectives.src/gql/query/ibc.ts (2)
- 11-11: The import of
DeepPartialis correctly added, supporting the transition to a more detailed and flexible typing system for nested object structures within theibc.tsfile.- 23-25: The update to use
DeepPartialforIbcFieldsand within it foribcChannelsandibcTransfersis correctly implemented. This change enhances the type specificity and flexibility for handling nested object structures, aligning with the PR's objectives.src/gql/query/governance.ts (2)
- 13-13: The import of
DeepPartialis correctly added, supporting the transition to a more detailed and flexible typing system for nested object structures within thegovernance.tsfile.- 26-29: The update to use
DeepPartialforGovernanceFieldsand within it forgovDeposits,govProposals, andgovVotesis correctly implemented. This change enhances the type specificity and flexibility for handling nested object structures, aligning with the PR's objectives.src/gql/query/marketing.ts (3)
- 3-3: The import of
DeepPartialis correctly added, supporting the transition to a more detailed and flexible typing system for nested object structures within themarketing.tsfile.- 22-25: The update in
QueryMarketingArgsto use non-partial types fortwitterUser,tweets,likes, andtasksfields is noted. This change is not directly related to the use ofDeepPartialbut is part of enhancing the type system's specificity and flexibility.- 32-36: The update to use
DeepPartialforMarketingFieldsand within it fortwitterUser,tweets,likes, andtasksis correctly implemented. This change enhances the type specificity and flexibility for handling nested object structures, aligning with the PR's objectives.src/gql/query/perp.ts (2)
- 20-20: The import of
DeepPartialis correctly added, supporting the transition to a more detailed and flexible typing system for nested object structures within theperp.tsfile.- 36-42: The update to use
DeepPartialforGQLPerpFieldsand its properties is correctly implemented. This change enhances the type specificity and flexibility for handling nested object structures, aligning with the PR's objectives.src/gql/query/stats.ts (2)
- 27-27: The import of
DeepPartialis correctly added, supporting the transition to a more detailed and flexible typing system for nested object structures within thestats.tsfile.- 44-51: The update to use
DeepPartialforGQLStatsFieldsand its properties is correctly implemented. This change enhances the type specificity and flexibility for handling nested object structures, aligning with the PR's objectives.src/gql/utils/consts.ts (1)
- 20-40: The
DeepPartial<T>type is a powerful utility for creating deep partial objects, allowing for more flexible and detailed type definitions, especially for nested structures. This change aligns well with the PR's objective of enhancing type safety and flexibility.Ensure that the implementation of
DeepPartial<T>is thoroughly tested, particularly for deeply nested structures, to confirm its behavior aligns with expectations.src/gql/heart-monitor/heart-monitor.ts (2)
- 120-208: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [123-266]
The update to use
DeepPartialfor fields in methods of theIHeartMonitorinterface is a significant improvement in type specificity, especially for nested object structures. This change enhances the flexibility and robustness of the type system within the application.Ensure that all consuming code that interacts with these methods is updated accordingly to handle the
DeepPartialtype correctly.
- 305-432: Similar to the
IHeartMonitorinterface, theHeartMonitorclass methods have been updated to useDeepPartialfor fields. This consistency between the interface and the class implementation is crucial for maintaining type safety and flexibility across the application.It's important to verify that the actual implementations of these methods correctly handle the
DeepPartialtype, especially when dealing with nested structures. Consider adding or updating unit tests to cover these scenarios.
|
CalicoNino
approved these changes
Mar 2, 2024
cgilbe27
added a commit
that referenced
this pull request
Mar 5, 2024
* feat: deepPartial (#329) * feat: deepPartial * fix: rem gate * fix: fix barrel * docs(gql): add JSDoc comment for DeepPartial --------- Co-authored-by: Calico Nino <[email protected]> Co-authored-by: Unique Divine <[email protected]>
nibibot
pushed a commit
that referenced
this pull request
Mar 6, 2024
## [3.3.0](v3.2.0...v3.3.0) (2024-03-06) ### Features * deepPartial ([#329](#329)) ([89f2504](89f2504)) * marketing mutation + query ([#331](#331)) ([61c7fe8](61c7fe8)) ### Bug Fixes * fix barrel ([599041f](599041f)) * merge ([4e1144d](4e1144d)) ### Documentation * **gql:** add JSDoc comment for DeepPartial ([26176e3](26176e3)) [skip ci]
|
🎉 This PR is included in version 3.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Following was not possible
Summary by CodeRabbit