Switching "deep-equal" package for "fast-deep-equal" - based on #1665 #1719
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
…nificant performance boost for Total Blocking Time, especially for large layout service payloads.
illiakovalenko
requested changes
Jan 19, 2024
CHANGELOG.md
Outdated
| @@ -22,6 +22,7 @@ Our versioning strategy is as follows: | |||
| * `[templates/nextjs-sxa]` Fixed Image component when there is using Banner variant which set property background-image when image is empty. ([#1689](https://github.com/Sitecore/jss/pull/1689)) ([#1692](https://github.com/Sitecore/jss/pull/1692)) | |||
| * `[templates/nextjs-sxa]` Fix feature `show Grid column` in Experience Editor. ([#1704](https://github.com/Sitecore/jss/pull/1704)) | |||
| * `[sitecore-jss-nextjs] [templates/nextjs-xmcloud]` SDK initialization rejections are now correctly handled. Errors should no longer occur after getSDK() promises resolve when they shouldn't (for example, getting Events SDK in development environment) ([#1712](https://github.com/Sitecore/jss/pull/1712) [#1715](https://github.com/Sitecore/jss/pull/1715) [#1716](https://github.com/Sitecore/jss/pull/1716)) | |||
| * `[templates/react] [sitecore-jss-react] ` Replace package 'deep-equal' with 'fast-deep-equal'; no functionality change only performance improvement ([#1719](https://github.com/Sitecore/jss/pull/1719) [#1665](https://github.com/Sitecore/jss/pull/1665) | |||
There was a problem hiding this comment.
Should it be under "Features and improvements" section? I can't say that it's a bugfix, rather an improvement
| @@ -63,7 +63,7 @@ | |||
| }, | |||
| "dependencies": { | |||
| "@sitecore-jss/sitecore-jss": "21.7.0-canary.50", | |||
| "deep-equal": "^2.1.0", | |||
| "fast-deep-equal": "3.1.3", | |||
There was a problem hiding this comment.
Do we need to install types for fast-deep-equal or they are not needed?
deep-equal types needs to be removed: https://github.com/Sitecore/jss/pull/1719/files#diff-7b807de09392e3b43f675bec4802fa16d67f108b7624e883d8c699a8f8fbd14eL32
There was a problem hiding this comment.
Should we use the latest version instead of "fixed"?
| @@ -32,7 +32,7 @@ | |||
| "axios": "^1.2.0", | |||
| "bootstrap": "^5.2.3", | |||
| "cross-fetch": "^3.1.5", | |||
| "deep-equal": "^2.1.0", | |||
| "fast-deep-equal": "3.1.3", | |||
There was a problem hiding this comment.
Should we use the latest version instead of "fixed"?
illiakovalenko
approved these changes
Jan 22, 2024
illiakovalenko
added a commit
that referenced
this pull request
Jan 22, 2024
…ual" - based on #1665 (#1719) * Switching "deep-equal" package for "fast-deep-equal". This gave a significant performance boost for Total Blocking Time, especially for large layout service payloads. * update yarn.lock * update yarn.lock * update changelog * use latest version of fast-deep-equal; @remove types/deep-equal * fix changelog entry * Minor update to CHANGELOG.md * Update CHANGELOG.md --------- Co-authored-by: David <[email protected]> Co-authored-by: Illia Kovalenko <[email protected]>
7 tasks
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 PR is based on external contribution #1665 . Following is the original PR description:
Description / Motivation
We were noticing that
deepEqualincomponentDidUpdateofSitecoreContextwas taking up a significant chunk of time for large Layout Service payloads.The package "fast-deep-equal" shows 100x faster performance in benchmarks compared to "deep-equal".
This was the only usage of the "deep-equal" package, so we were able to replace the dependency entirely.
Testing Details
There is no functional change, only performance change, so no new unit tests. We have implemented this change on 2 different projects and have not seen any issues, just faster performance.
In our Lighthouse tests for one of our projects, we saw the Total Blocking Time reduced from 1090ms to 20ms in Desktop, and from 5170ms to 330ms in mobile. The results were reproducible, and we saw significant gains in a different project.
Types of changes
Not technically a bug, but it's not new functionality either.