fix: Resolve promise types for props passed to store.createRecord()#9396
Merged
runspired merged 2 commits intowarp-drive-data:mainfrom May 11, 2024
Merged
Conversation
runspired
approved these changes
May 10, 2024
runspired
reviewed
May 11, 2024
Contributor
runspired
left a comment
There was a problem hiding this comment.
needs a lint fix but otherwise 👍🏻
This file contains hidden or 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
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.
Description
Fix incorrect types being expected by the store service’s
createRecord()method. This could happen when the record being created had, for example, abelongsTorelationship, in which case the type for the property with the relationship wasPromiseBelongsTo<SomeModel>rather thanSomeModel.Cause
When determining the TS type for properties that can be passed to
createRecord()aCreateRecordPropertiesutility type is used. It in turn uses aFilteredKeystype to narrow the properties to only the model attributes. Promise types were not being handled here and only filtered, leading to the issue.Fix
To resolve any promise types like
PromiseBelongsTo, a newAwaitedKeys<Type>utiltity type was added that wrapsFilteredKeys. It’s a mapped type that appliesAwaitedto all keys, resolving promise types.Notes for the release
N/A