refactor(preview): clean up preview with fallback logic #8904
+45
−24
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
bjoerge
force-pushed
the
preview-use-current-perspective
branch
from
ee7beb1 to
e2564a1
Compare
|
No changes to documentation |
⚡️ Editor Performance ReportUpdated Wed, 12 Mar 2025 17:49:19 GMT
Detailed information🏠 Reference resultThe performance result of
🧪 Experiment resultThe performance result of this branch
📚 Glossary
|
bjoerge
commented
Mar 12, 2025
| @@ -14,25 +13,31 @@ export function getMissingDocumentFallback(document: Partial<SanityDocument> | P | |||
| } | |||
| } | |||
|
|
|||
| export type Values = { | |||
There was a problem hiding this comment.
Not very satisfied with the name of this type 🙄 suggestions appreciated
There was a problem hiding this comment.
I like that! Aligns with the source parameter(s) of Object.assign
There was a problem hiding this comment.
Fixed in 4653034, thank you!
bjoerge
commented
Mar 12, 2025
| @@ -84,7 +84,7 @@ export function PaneItemPreview(props: PaneItemPreviewProps) { | |||
|
|
|||
| return ( | |||
| <SanityDefaultPreview | |||
| {...getPreviewValueWithFallback({document, snapshot, original})} | |||
| {...getPreviewValueWithFallback({snapshot, original, fallback: value})} | |||
There was a problem hiding this comment.
previously document would refer to the global document here 🙈
bjoerge
commented
Mar 12, 2025
| * last resort fallback in case we don't have anything to preview | ||
| * this can be a hard-coded preview value, or a document stub | ||
| */ | ||
| fallback?: Partial<SanityDocument> | PreviewValue |
There was a problem hiding this comment.
hoping this makes it slightly more clear that you can pass the document and/or a hard coded preview stub as fallback
There was a problem hiding this comment.
Seems like a nice improvement. I wondered whether it might be even better to use a union to ensure at least one value is passed, but upon further consideration, I'm not sure that's possible or desired.
There was a problem hiding this comment.
Thought about it briefly, but that would be a union of three objects, each with one of these keys required and the other two optional, right? I concluded the added complexity wasn't justified, but happy to reconsider (but I'd prefer a follow-up PR for that).
juice49
previously approved these changes
Mar 12, 2025
juice49
approved these changes
Mar 13, 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.
Description
Fixes a couple of issues:
1. Search previews didn't reflect current perspective
Before
After
2. Document list previews didn't reflect current perspective
Before
After
What to review
Took the opportunity to clean up and document the logic related to getting preview values and fallback
Also fixed a bug that leaked document.title in previews for cases where the document was missing.
Testing
Switching between release/draft/published should use the correct preview for search results (global search, reference search), document lists etc.
Notes for release