when deleteing an object in webui. list the related objects that would also be deleted

[ITJamie]

NetBox version

v3.6.0

Feature type

Change to existing functionality

Proposed functionality

when choosing delete on an object (eg device for this example). the popup that "asks are you sure you want to delete device xxx" should be extended to show the list of related objects that will also be deleted (interfaces, cables, etc)

Use case

some users are not aware that deleting an object will remove some other related objects.
showing the user what additional objects will deleted would be a fantastic safety feature.

Database changes

n/a

External dependencies

n/a

[ITJamie]

related slack convo: https://netdev-community.slack.com/archives/C01P0FRSXRV/p1693924009439029

[ITJamie]

another option to consider - the delete modal popup could require typing the “name” of the object to enable the delete button on the modal. (I’m personally not a fan of that method, but it is a fairly standard way of helping to stop erroneous deletions in webapps)

[sleepinggenius2]

It looks like something similar was proposed in #8551, but never got an owner. I see this as also related to #6015, which is still a problem in our organization, as the current behavior is unexpected for our engineers.

[pv2b]

another option to consider - the delete modal popup could require typing the “name” of the object to enable the delete button on the modal. (I’m personally not a fan of that method, but it is a fairly standard way of helping to stop erroneous deletions in webapps)

I don't like it because it doesn't address the core problem, which is making sure a user understands that deleting a device will also potentially delete all related interfaces and cables.

However, one thing that occurrs to me, instead of implementing this in core NetBox, could a similar effect be acheived with a custom validator? The custom validator could for example reject any deletions of any devices that have cables connected to them, requiring the user to disconnect all cables in NetBox before deleting the object. This is similar to how some network vendors set up their equipment, making it impossible to delete configuration object that have other dependent objects.

[pv2b]

instead of implementing this in core NetBox, could a similar effect be acheived with a custom validator?

I just checked and no, unfortunately the custom validator only triggers when editing an object, it doesn't trigger on object deletion.

Maybe an alternative way to implement this could be to extend the concept of custom validators to also call a method on them prior to deletion?

[ITJamie]

If this was to be accepted I have put together a quick example of how this could be achieved here

obviously it could use some work styling wise, maybe some links to the objects..., but for a POC it seems to be working

[pv2b]

If this was to be accepted I have put together a quick example of how this could be achieved here

obviously it could use some work styling wise, maybe some links to the objects..., but for a POC it seems to be working

I think we'd need to talk a little about what's a useful scope. In your example you're listing all related objects. The problem with that is that it's not really a surprise to anyone that if they delete a switch, they'll also be deleting its interfaces, front ports, as well records of related IP addresses etc. With the UI implemented the way you're showing, you'll end up with a long list of related objects for every single device deletion. This will likely cause Alert Fatigue, and you'll end up with users ignoring those warning lists because they're normal and expected.

I think a much more useful scope is limiting yourself to the case where a device is cabled to many other devices or circuits. Something like:

Confirm deletion

Are you sure you want to delete device Super-Important-Distribution-Switch-42? This will remove 27 cables.

[ ] Yes, please delete 27 cables along with the device.

[Cancel] [Submit]

[pv2b]

I would also like that after sleeping on it, I think personally I prefer an approach where the users have to manually disconnect all cables from a device before it can be deleted, because that automatically makes their deletion intentional. However, I really doubt that's a UX change that NetBox would want to make for everyone. That said I think there's room for a pre-delete hook in the custom validators feature, but that's a seperate FR. That I'm actually going to ahead and write up as a seperate feature to this.

[ITJamie]

If this was to be accepted I have put together a quick example of how this could be achieved here

obviously it could use some work styling wise, maybe some links to the objects..., but for a POC it seems to be working

I think we'd need to talk a little about what's a useful scope. In your example you're listing all related objects. The problem with that is that it's not really a surprise to anyone that if they delete a switch, they'll also be deleting its interfaces, front ports, as well records of related IP addresses etc. With the UI implemented the way you're showing, you'll end up with a long list of related objects for every single device deletion. This will likely cause Alert Fatigue, and you'll end up with users ignoring those warning lists because they're normal and expected.

I think a much more useful scope is limiting yourself to the case where a device is cabled to many other devices or circuits. Something like:

Confirm deletion

Are you sure you want to delete device Super-Important-Distribution-Switch-42? This will remove 27 cables.

[ ] Yes, please delete 27 cables along with the device.

[Cancel] [Submit]

My view is that this is generic across all models and plugins. Validators would need to be written per model and new additions could be missed.

Showing everything thats going to be deleted is also better for new users to understand the relationships that exist.

[pv2b]

My view is that this is generic across all models and plugins. Validators would need to be written per model and new additions could be missed.

This is true, but having some more thought put into validation as opposed to warning about everything isn't a bad thing, if your goal is to get your users to actually care about the warnings.

Showing everything thats going to be deleted is also better for new users to understand the relationships that exist.

That is a good point!

I would also like to clarify that I still like the feature being proposed here, it provides useful feedback and information for the user, but I don't think that it'll be effective at one of the stated goals, which is providing safety against accidental deletions, and nothing's stopping both these features from being implemented. (Except possibly limited dev time.) They complement each other.

[ITJamie]

I agree that we shouldn't allow devices to be deleted with cables connected. So im 100% for that change! Doing this also made me notice that we delete primary and oob ips when deleting a debice which is a bit odd...

I still hope we add this visual to the delete dialog though.

[pv2b]

I agree that we shouldn't allow devices to be deleted with cables connected. So im 100% for that change! Doing this also made me notice that we delete primary and oob ips which is a bit odd...

I still hope we add this visual to the delete dialog though.

Getting a little off topic in this particular thread here, but my other FR isn't proposing that exactly, it's proposing a mechanism to allow an administrator to extend NetBox to prevent object deletion under specific criteria. It could be used, for example, to enforce that all cables must be deleted before object deletion, but it won't do that unless the user customizes NetBox to do so.

If there were a hypothetical FR to change NetBox to require deleting cables before deleting an object, I'd support it as the right choice, but I can see that being controversial.

[jeremystretch]

Tagging this for v3.7 as it looks doable. @ITJamie would you like to own this one?

[ITJamie]

Im happy to take it on