Rename page_tree_tutorial_seen field to has_seen_page_tree_tutorial #4071
Conversation
…nd update help text for better clarity.
MizukiTemma
left a comment
MizukiTemma
left a comment
There was a problem hiding this comment.
Thank you so much for the PR 😸
We are on a good way, but there are three points to improve.
-
Our
integreat_cms/cms/fixtures/test_data.jsonhas still the old field name. The fixture must be in the form of models after migration. In this case we have to changepage_tree_tutorial_seentohas_seen_page_tree_tutorialin this file too. Otherwise it cannot be loaded and causes an error (both in the CI and when./tools/run.sh) -
There is an old field name left in
integreat_cms/cms/views/pages/page_tree_view.py(L.156). We you open the page tree, you'll face this error.
I think it was just slipped off from your eyes while replacing the name.
- We do not want to lose the current information whether user has seen the tutorial during the migration. Find detailed suggestion in the comment.
| migrations.RemoveField( | ||
| model_name="user", | ||
| name="page_tree_tutorial_seen", | ||
| ), | ||
| migrations.AddField( | ||
| model_name="user", | ||
| name="has_seen_page_tree_tutorial", | ||
| field=models.BooleanField( | ||
| default=False, | ||
| help_text="Has seen tutorial for page tree", | ||
| verbose_name="Page tree tutorial seen", | ||
| ), | ||
| ), |
There was a problem hiding this comment.
It's nice that the old field is abolished and the new field is added, but there is a thing to pay attention to: the values currently stored in the database will go lost, as the new field does not inherit the current value from the old field.
To avoid this, we have to first create a new field, then transfer the stored value from the old field to the new one, then remove the old field.
An example is 0138_configurable_mt_budget.
Short description
page_tree_tutorial_seenfield tohas_seen_page_tree_tutorialand update help text for better clarity.Proposed changes
page_tree_tutorial_seen→has_seen_page_tree_tutorialinuser.pydismiss_tutorial_view.py0144_alter_user_page_tree_tutorial_seen.py"Has seen tutorial for page tree"Side effects
Faithfulness to issue description and design
Resolved issues
Fixes: #3271