fix(blog): normalize inline authors socials #10424
Merged
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
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: -58.3 kB (-0.5%) Total Size: 11.5 MB
ℹ️ View Unchanged
|
slorber
requested changes
Aug 20, 2024
slorber
requested changes
Aug 20, 2024
packages/docusaurus-plugin-content-blog/src/__tests__/authors.test.ts
Outdated
Show resolved
Hide resolved
slorber
requested changes
Aug 21, 2024
| return authorInput; | ||
| return { | ||
| ...authorInput, | ||
| socials: normalizeSocials(authorInput.socials ?? {}), |
There was a problem hiding this comment.
Here if author front matter has no social key, the result will be social: {}.
If the key was absent before normalization, we'd rather keep it absent after normalization (unless it's an explicit goal of the normalization to always have an object for empty (in which case the normalized type shouldn't allow null/undefined anymore)
There was a problem hiding this comment.
I'm +1 to make socials required—unless we plan to make socials: null and socials: {} render different things, for which I cannot conceive a reason.
There was a problem hiding this comment.
I don't think we plan render those differently.
I also like to normalize to {} for convenience of frontend code, although technically this slightly increases bundle size / memory by creating useless empty objects when we could use optional chaining. Maybe always normalizing to undefined would be better? That's really a detail so I'm fine with any of those.
There was a problem hiding this comment.
I don't think neither of those would be a concern when there aren't thousands of authors (by which time the blog posts' metadata is a far bigger concern).
slorber
changed the title
|
oups, updated the branch and now we have test failures 😄 |
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.
Motivation
Fix #10417
Test Plan
Local & CI
Test links
Deploy preview: https://deploy-preview-10424--docusaurus-2.netlify.app/