Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix undo remove last child #4619

Merged

Conversation

AlexVelezLl
Copy link
Member

@AlexVelezLl AlexVelezLl commented Jul 24, 2024

Summary

Description of the change(s) you made

When removing the last child of a folder, the folder was left without nodes, and within the undo transaction there was a resource.where() filter to find the siblings of the recovered node, but as it did not find siblings, it was making an API call, which caused the transaction to end before the api call returned, while there were still operations to be done within the transaction.

This PR just relocates the siblings query so that it is done before the transaction.

Manual verification steps performed

  1. verified that removing the last child and then redoing it now worked correctly.
  2. verified that the redo of the rest of the operations keep working correctly.

Screenshots (if applicable)

Compartir.pantalla.-.2024-07-24.09_11_14.mp4

Reviewer guidance

How can a reviewer test these changes?

  1. Remove the last node of a channel/folder
  2. Wait a couple of seconds for the change to be replicated in IndexedDB
  3. Redo de operation

References

Closes #4468


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@AlexVelezLl AlexVelezLl added this to the Studio: Q2-24 Release milestone Jul 24, 2024
@rtibbles rtibbles self-assigned this Jul 25, 2024
Copy link
Member

@akolson akolson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @AlexVelezLl!. Although the fix seems to work sometimes, the bug can still be reproduced.

Screen.Recording.2024-07-29.at.14.43.58.mov

@akolson
Copy link
Member

akolson commented Jul 29, 2024

@AlexVelezLl, if its useful, I picked up this in the terminal!

[2024-07-29 11:45:35,430: ERROR/ForkPoolWorker-1] A node may not be made a sibling of itself.
Traceback (most recent call last):
  File ".../studio/contentcuration/contentcuration/viewsets/sync/base.py", line 118, in apply_changes
    errors = event_handler([change.serialize_to_change_dict()])
  File ".../studio/contentcuration/contentcuration/viewsets/contentnode.py", line 880, in move_from_changes
    move_error = self.move(
  File ".../studio/contentcuration/contentcuration/viewsets/contentnode.py", line 898, in move
    contentnode.move_to(
  File ".../studio/contentcuration/contentcuration/models.py", line 1872, in move_to
    super(ContentNode, self).move_to(target, *args, **kwargs)
  File ".../.pyenv/versions/3.9.13/envs/studio-py3.9.13/lib/python3.9/site-packages/mptt/models.py", line 851, in move_to
    self._tree_manager.move_node(self, target, position)
  File ".../studio/contentcuration/contentcuration/db/models/manager.py", line 229, in move_node
    self._move_node(node, target, position=position)
  File ".../.pyenv/versions/3.9.13/envs/studio-py3.9.13/lib/python3.9/site-packages/mptt/managers.py", line 44, in wrapped
    return method(self, *args, **kwargs)
  File ".../.pyenv/versions/3.9.13/envs/studio-py3.9.13/lib/python3.9/site-packages/mptt/managers.py", line 577, in _move_node
    self._move_child_node(node, target, position)
  File ".../.pyenv/versions/3.9.13/envs/studio-py3.9.13/lib/python3.9/site-packages/mptt/managers.py", line 1067, in _move_child_node
    self._move_child_within_tree(node, target, position)
  File ".../.pyenv/versions/3.9.13/envs/studio-py3.9.13/lib/python3.9/site-packages/mptt/managers.py", line 1154, in _move_child_within_tree
    raise InvalidMove(_("A node may not be made a sibling of itself."))
mptt.exceptions.InvalidMove: A node may not be made a sibling of itself.

Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code changes here make sense to me, as they mostly amount to never including the node itself among its own siblings, which seems semantically correct!

If @akolson can confirm he is no long replicating the error he saw, then we should be good to merge.

Copy link
Member

@akolson akolson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can confirm that the issue has now been fully resolved. Manual QA checks out. Thanks @AlexVelezLl 🚀 . cc @rtibbles

@rtibbles rtibbles merged commit a4a3c8f into learningequality:unstable Aug 9, 2024
13 checks passed
@akolson akolson mentioned this pull request Aug 13, 2024
@akolson akolson mentioned this pull request Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to Undo a delete operation for the last remaining folder/resource in a channel
3 participants