fix(typegen): dont treat all document type refs as references #7366
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
It's possible to reference a document the same way as an object is referenced. However, they will not get the builtin attributes that are available on a document stored in Content Lake. The Studio treats it as a "normal" object. Since we are making some assumption around document we are inlining the whole object whenever this happens, it's an edge case and not a recommended pattern as it is mixing concerns.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
No changes to documentation |
|
Component Testing Report Updated Aug 13, 2024 5:43 PM (UTC)
|
cngonzalez
pushed a commit
that referenced
this pull request
Aug 20, 2024
It's possible to reference a document the same way as an object is referenced. However, they will not get the builtin attributes that are available on a document stored in Content Lake. The Studio treats it as a "normal" object. Since we are making some assumption around document we are inlining the whole object whenever this happens, it's an edge case and not a recommended pattern as it is mixing concerns.
This was referenced Sep 20, 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.
Description
It's possible to reference a document the same way as an object is referenced. However, they will not get the builtin attributes that are available on a document stored in Content Lake. The Studio treats it as a "normal" object. Since we are making some assumption around document we are inlining the whole object whenever this happens, it's an edge case and not a recommended pattern as it is mixing concerns.
What to review
Correctness. This change also changed a snapshot in the existing test. This is because the referenced block type from the fixture is using "author" as a inline type reference, but also using author as a reference.
Testing
Updated the current snapshots and added a specific test for inlined documents
Notes for release
TypeGen: Fixes an edge case where referencing documents with a normal "type"-reference, and not a "reference-type" reference extracted an incorrect representation of the schema.
Fixes #6913