learningequality / learningequality/studio
Stop using Vuex global content nodes state - "ResourcePanel"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 191
- Forks
- 307
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 10
Description
Summary
When using the resource panel (note that this component is used at more places like clipboard, import from channels, move modal etc.):
content nodes are added to contentNodesMap Vuex state:
and content nodes ids to previousStepsMap/nextStepsMap:
Example:
The goal of this issue is to refactor the panel to not add/retrieve data to/from contentNodesMap as well as to/from previousStepsMap/nextStepsMap but rather move towards using a more local state that will be cleared after a user stops using it.
Background
- We accumulate content nodes data in
contentNode/statefrom various Studio features of thechannelEditapp and there is no mechanism for clearing them which causes memory leaks. This issue is part of a larger group of issues (see https://github.com/learningequality/studio/issues/3363) that aim to refactor problematic features away from using Vuex global state towards private in-components state or state that’s shared between more components but is cleared at some point and optimized performance-wise in general. - Ultimately, we want to get rid of globally stored content nodes data completely, however, this will be implemented incrementally, and therefore it’s fine to use mixed sources of data in the transition stage as long as all features continue working well from the user-point of view. Using composables is not required in all cases but is recommended as it has proven to be useful for state management across our products and it is flexible enough to allow us to keep using Vuex partially during the transition stage.
Acceptance criteria
- No content nodes are added/retrieved to/from
contentNodesMapandpreviousStepsMap/nextStepsMapwhen using the panel (applies to all sub-components if there are any) - The new implementation avoids the pitfalls of our current implementation that are described in the “Background” section and is optimized performance-wise overall
Blocked by
Blocking
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with ResourcePanel.vue and the contentNode Vuex module in frontend/channelEdit/vuex/contentNode/index.js, including the linked contentNodesMap, previousStepsMap, and nextStepsMap usage. Check the related blocked issue 3468 first, then trace the panel and its sub-components. Done means the panel no longer reads or writes those global maps and its local data is cleared appropriately without breaking its uses.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100