Opened 7 months ago

Last modified 4 months ago

#27852 assigned Cleanup/optimization

Admin Delete Object Block Page Doesn't Show All Related Objects Blocking Deletion

Reported by: Kenny Loveall Owned by: Anton Samarchyan
Component: Database layer (models, ORM) Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description

STR:

  1. Create three models, two of which reference the third and the references PROTECT on delete, like such:
class ModelA(models.Model):
    pass

class ModelB(models.Model):
    fk = models.ForeignKey(ModelA, on_delete=models.PROTECT)

class ModelC(models.Model):
    fk = models.ForeignKey(ModelA, on_delete=models.PROTECT)
  1. Register these models with the admin site
  1. Create a ModelA, ModelB, & ModelC object. Make ModelB & ModelC reference ModelA, like such:
    a = ModelA()
    b = ModelB(fk=a)
    c = ModelC(fk=a)
    
  1. Go to the admin site and try to delete the ModelA object.

Expected Result: Page listing both b & c as blocking objects
Actual Result: Page listing only b or c, but not both.

After investigation, I've figured out it's because the field.rel.on_delete call in db.models.deletion.py (excerpted below) throws a models.ProtectedError exception and therefore exits the loop early and does not check the rest of the related fields.

    def collect(self, objs, source=None, nullable=False, collect_related=True,
            source_attr=None, reverse_dependency=False):

       [... omitted for brevity ...]

        if collect_related:
            for related in get_candidate_relations_to_delete(model._meta):
                field = related.field
                if field.rel.on_delete == DO_NOTHING:
                    continue
                batches = self.get_del_batches(new_objs, field)
                for batch in batches:
                    sub_objs = self.related_objects(related, batch)
                    if self.can_fast_delete(sub_objs, from_field=field):
                        self.fast_deletes.append(sub_objs)
                    elif sub_objs:
                        field.rel.on_delete(self, field, sub_objs, self.using)
            for field in model._meta.virtual_fields:
                if hasattr(field, 'bulk_related_objects'):
                    # Its something like generic foreign key.
                    sub_objs = field.bulk_related_objects(new_objs, self.using)
                    self.collect(sub_objs,
                                 source=model,
                                 source_attr=field.rel.related_name,
                                 nullable=True)

This was discovered because we're implementing a soft-delete override in the Model layer (so anytime you try to delete things it just sets a timestamp instead of actually removing the data). This became an issue because we take the output of this and filtered it to only objects that we had that were deleted by our standards and found that under certain circumstances we were allowed to delete things when we shouldn't have been. Given this scenario being such an edge case, my hopes for getting this fixed aren't high; although I would argue that it's still a poor user experience for people that aren't trying to do what we're doing where it shows them only *some* of the things blocking the deletion instead of all of them. I'm hoping, however, that hopefully someone can at the very least show us if we can get a list of all the delete-blocking objects from somewhere else?

Given where this is, the bug really seems to be coming from db.models.deletion.Collector so I'm not sure if the component field should be admin or models but I chose admin because that's where it's easily visible (and would impact general Django users).

Attachments (1)

djtest.zip (14.3 KB) - added by Anton Samarchyan 7 months ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 7 months ago by Tim Graham

Triage Stage: UnreviewedAccepted
Type: BugCleanup/optimization

I haven't confirmed the issue or looked into if it's feasible to fix, but if you provide a patch, it seems okay to change.

Changed 7 months ago by Anton Samarchyan

Attachment: djtest.zip added

comment:2 Changed 7 months ago by Anton Samarchyan

I've attached an example project with the data to reproduce the issue. Credentials: admin/Oowae5me

comment:3 Changed 7 months ago by Anton Samarchyan

Version: 1.8master

comment:4 Changed 7 months ago by Anton Samarchyan

Owner: changed from nobody to Anton Samarchyan
Status: newassigned

comment:5 Changed 7 months ago by Anton Samarchyan

Component: contrib.adminDatabase layer (models, ORM)
Has patch: set

Added PR

comment:6 Changed 4 months ago by Tim Graham

Patch needs improvement: set
Note: See TracTickets for help on using tickets.
Back to Top