learningequality / learningequality/studio
Remove Vuex content node module
Open
Nobody has claimed this yet.
DEV: frontend
TAG: performance
- Dominant language
- Python
- Stars
- 191
- Forks
- 307
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 10
Description
After we move away from using the Vuex channelEdit/contentNode module
let's check that there are no remaining dependencies on it and then remove the module completely.
Background
- We accumulate content nodes data in Vuex
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.
Acceptance criteria
- There are no more remaining references to the Vuex content node module (if there are some forgotten places that are still using it that require a larger amount of work, new issues are open and resolved before resolving this issue)
- Vuex content node module exists no more
Blocked by
- https://github.com/learningequality/studio/issues/3437
- https://github.com/learningequality/studio/issues/3446
- https://github.com/learningequality/studio/issues/3447
- https://github.com/learningequality/studio/issues/3451
- https://github.com/learningequality/studio/issues/3452
- https://github.com/learningequality/studio/issues/3453
- https://github.com/learningequality/studio/issues/3458
- https://github.com/learningequality/studio/issues/3459
- https://github.com/learningequality/studio/issues/3462
- https://github.com/learningequality/studio/issues/3463
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
Review contentcuration/contentcuration/frontend/channelEdit/vuex/contentNode/index.js and first check the listed blocking issues before changing this module. Search the channelEdit app for remaining references to the Vuex content node module; done means no references remain and the module no longer exists, with larger remaining work tracked separately.
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