This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
Replace lodash.clonedeep with rfdc #1321
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
openverse-bot
added
✨ goal: improvement
obulat
reviewed
Apr 25, 2022
| @@ -134,7 +134,7 @@ export const initFilters = () => | |||
| checked: false, | |||
| })), | |||
| }), | |||
| {} as Record<FilterCategory, FilterItem> | |||
| {} as Filters | |||
obulat
reviewed
Apr 25, 2022
src/stores/search.ts
Outdated
| @@ -4,7 +4,9 @@ import { defineStore } from 'pinia' | |||
| // https://github.com/WordPress/openverse-frontend/issues/1103 | |||
| // eslint-disable-next-line @typescript-eslint/ban-ts-comment | |||
| // @ts-ignore | |||
| import clonedeep from 'lodash.clonedeep' | |||
| import { deepclone } from '~/utils/clone' | |||
There was a problem hiding this comment.
We can remove the ts-ignore and the comments on lines 4-6! 🙂
There was a problem hiding this comment.
Oops, I removed them from the other one 🤦 Thanks for catching this one!
obulat
reviewed
Apr 25, 2022
| @@ -0,0 +1,3 @@ | |||
| import rfdc from 'rfdc' | |||
There was a problem hiding this comment.
Why do this instead of simply using rfdc? To be able to add types?
There was a problem hiding this comment.
The rfdc module exports a function by default that you can pass configuration details to. So instead of having to re-create the default clone function each time, we can just export it from this module. And if we end up needing to change the configuration of how the clone function works, we'll be able to do it in just one place.
obulat
reviewed
Apr 25, 2022
| @@ -0,0 +1 @@ | |||
| export type DeepWriteable<T> = { -readonly [P in keyof T]: DeepWriteable<T[P]> } | |||
There was a problem hiding this comment.
Where can I read on the meaning of - here? -readonly?
There was a problem hiding this comment.
It's a "mapping modifier": https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#mapping-modifiers
|
@WordPress/openverse-developers this would be an easy to review PR for anyone on the team, including non-frontend folks, and is an easy win for our bundle size. |
AetherUnbound
approved these changes
May 2, 2022
src/utils/clone.ts
Outdated
| @@ -0,0 +1,3 @@ | |||
| import rfdc from 'rfdc' | |||
|
|
|||
| export const deepclone = rfdc() | |||
There was a problem hiding this comment.
Forgive me, I'm not super clear on naming conventions or whether this qualifies 😅 - should this be deepClone?
There was a problem hiding this comment.
I guess! The lodash one was clonedeep so thats why I kept the flattened casing.
sarayourfriend
force-pushed
the
update/remove-lodash.deepclone
branch
from
aebcf10 to
651a1e7
Compare
|
Storybook and Tailwind configuration previews: Updating |
|
Size Change: +8.39 kB (+1%) Total Size: 1.4 MB
ℹ️ View Unchanged
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes
Fixes #1103 by @sarayourfriend
Description
Compare the bundle sizes:
https://bundlephobia.com/package/lodash.clonedeep@4.5.0
and
https://bundlephobia.com/package/rfdc@1.3.0
Also compare execution speed (from rfdc README):
Literally a 4x improvement on speed and downloaded size over the lodash implementation 🎉
Testing Instructions
Run the app and check that filters in particular are still working as expected.
Checklist
Update index.md).main) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin