MI-168: Use more specific type than autogenerated NormalPage in getTransformedPageData parameters #78
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
…ansformedPageData parameters
jackmacaa
reviewed
Jan 31, 2025
| path: string; | ||
| htmlBody: string; | ||
| name: string; | ||
| seo: SeoDetailsFragment; |
There was a problem hiding this comment.
Should we have the SeoDetailsFragments as a manual type too?
There was a problem hiding this comment.
@jackmacaa the fragment type is generated from our actual request to bigcommerce, so it won't break things when unrelated types change on the schema.
Ideally we would use fragments for the page types as well but that's not how the GraphQL requests were architected and I wanted to avoid runtime changes (which modifications to the GraphQL requests would be!)
TheOrangePuff
approved these changes
Jan 31, 2025
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.
This is a compile-time-only fix. Using the full
NormalPagetype risks breaking the build process if BigCommerce updates the graphql schema for that entity, even though the data we actually request and require has not changed shape.This change narrows the expected type to what the getTransformedPageData function actually uses. It also removes the type declarations on test data in
normal-page-data.tsas they aren't required. It's better to let Typescript infer whether the test data matches that required by the function being tested.