learningequality / learningequality/kolibri
Upgrade xstate to version 5.x
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 972
- Avg merge
- 7d 16h
- Merged PRs (30d)
- 33
Description
Overview
The xstate library kolibri uses for some of the kolibri processes has released a new version v5.x that adds some features but introduces some breaking changes with version 4.x .
We should apply those changes to kolibri code before upgrading to v5.
Also some of the new features (use of can in guards or the fromPromise helper can improve current machines code)
Description and outcomes
To be done in a future 0.16 patch release
Resources
- Webinar of using version 5 of xState
- Xstate migration guide
### Tasks
- [ ] Follow migration guide from https://stately.ai/docs/migration
- [ ] Upgrade xstate in KDS
- [ ] https://github.com/learningequality/kolibri/issues/12646
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 the linked XState migration guide and the current XState usage in KDS; identify the breaking changes that affect Kolibri's machines before attempting the dependency upgrade. Done means the migration tasks are addressed, XState is upgraded in KDS, and issue #12646 is handled or explicitly accounted for.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100