openedx / openedx/XBlock

Provide support for migrations

Open
#50 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
470
Forks
231
Avg merge
1d 1h
Merged PRs (30d)
6

Description

As an xblock changes what fields it understands, previous versions of the data written by that block will have to be migrated. Currently, the only way to support that is to keep all old versions of the fields around, and to perform checks in __init__.

It would be nice instead to have a standard way to convert from one version of the xblock's fields to another.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how XBlocks currently retain old field versions and perform migration checks in init. Define the standard version-to-version migration behavior and its scope before identifying implementation and test locations; done means XBlocks have a consistent way to convert previously written field data.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.