perf: add variables caching to v0 #12073
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
layershifter
requested review from
dzearing,
ecraig12345,
JasonGore,
jdhuntington,
kenotron,
levithomason,
miroslavstastny and
mnajdova
as code owners
mnajdova
reviewed
Feb 26, 2020
| ); | ||
| }); | ||
|
|
||
| if (!hasOnlyBooleanVariables) { |
There was a problem hiding this comment.
We should not throw here, we should just not cache for this instance. We are not throwing in the other cases of caching, so we shouldn't here too. We cannot guarantee that all usages of variables are booleans in a project.
There was a problem hiding this comment.
During offline conversation we discovered issues and I changed the implementation to avoid throwing errors.
mnajdova
reviewed
Feb 26, 2020
| @@ -36,7 +36,8 @@ const defaultContext: StylesContextValue<{ renderRule: RendererRenderRule }> = { | |||
| performance: { | |||
| enableSanitizeCssPlugin: process.env.NODE_ENV !== 'production', | |||
| enableStylesCaching: true, | |||
| enableVariablesCaching: true | |||
| enableVariablesCaching: true, | |||
| enableHardVariablesCaching: false | |||
There was a problem hiding this comment.
Why not enableBooleanVariablesCaching?
There was a problem hiding this comment.
Renamed, it's definitely sounds better
Asset size changesSize Auditor did not detect a change in bundle size for any component! Baseline commit: fafbe44a2bb89af8aa06496b6f0f9c5d15a2500c (build) |
Perf AnalysisNo significant results to display. All results
Perf Analysis (Fluent)Perf comparison
All perf tests
|
mnajdova
reviewed
Feb 26, 2020
| ? `${displayName}:${JSON.stringify(stylesProps)}${styleParam.rtl}${styleParam.disableAnimations}` | ||
| : ''; | ||
| const propsCacheKey = cacheEnabled ? JSON.stringify(stylesProps) : ''; | ||
| const variablesCacheKey = cacheEnabled && performance.enableBooleanVariablesCaching ? JSON.stringify(variables) : ''; |
There was a problem hiding this comment.
For the props it was not problematic that the props order would change, because we are always mapping them in the same order. On the other hand for the variables we cannot guarantee that, as those are purely users input. I propose to always order them alphabetically and than we can safely use JSON.stringify, or clearly state somewhere that those should always be in the same order...
There was a problem hiding this comment.
Added this to Limitations section in PR description
mnajdova
reviewed
Feb 26, 2020
| expect(() => resolveStyles(options, resolvedVariables)).toThrowError(/Please check your "performance" settings on "Provider"/); | ||
| }); | ||
|
|
||
| test('when enabled only plain objects can be passed as "variables"', () => { |
There was a problem hiding this comment.
Are these last two tests still valid?
There was a problem hiding this comment.
Yep, I changed their contents and updated titles
ecraig12345
added
the
Fluent UI react-northstar (v0)
…ithub.com/OfficeDev/office-ui-fabric-react into feat/styles-hard-variables
mnajdova
approved these changes
Feb 27, 2020
miroslavstastny
approved these changes
Feb 27, 2020
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.
Pull request checklist
$ yarn changeDescription of changes
WAT? 😱
This PR adds
enableBooleanVariablesCachingwhich is disabled by default. It allows to handle styles caching for cases when boolean variables are used:Limitations 💔
We use
JSON.stringify()for the implementation and it means that boolean variables should go in the same order, i.e.Buttons below will create different cache entries:To avoid this the order should be always the same, proposed solution for customers: enforce the alphabetic order via ESLint rules.
Microsoft Reviewers: Open in CodeFlow