Add NetBox's changelog model to OnboardingTask

networktocode / ntc-netbox-plugin-onboarding

A plugin for NetBox to easily onboard new devices.

Other

246 stars 46 forks source link

Add NetBox's changelog model to OnboardingTask #92

Closed mzbroch closed 3 years ago

mzbroch commented 3 years ago

The goal of this PR is as follows:

integrate Change Log (NetBox's) to Onboarding Task model,
replace legacy created_on attribute of OnboardingTask with created from ChangeLoggedModel model,
display template content's elements using ChangeLoggedModel
add new view for ChangeLoggedModel of OnboardingTask
reiterate and fix properties' behaviour in models.py for OnboardedDevice (previous version was likely to fail in multiple scenarios)

With NetBox's ChangeLoggedModel, we can access the onboarding task's creation/modification history including information about the user requesting change

mzbroch commented 3 years ago

I'm not entirely clear on the benefit of making OnboardingTask into a ChangeLoggedModel. Don't we create a new OnboardingTask instance every time we run onboarding - so an OnboardingTask is really a "one-and-done" object that doesn't get revisited after a given onboarding session completes? Or am I misunderstanding when we would actually have a meaningful change history for an OnboardingTask?

Indeed, it is intended to behave as you described.

Our production use cases required us to add "owner" and "created/updated" fields to the OnboardingTask and this integration actually fits this requirement without duplicating NetBox's features

glennmatthews commented 3 years ago

Per our discussion on Slack, by using ChangeLoggedModel we also automatically get ObjectChange records created when an OnboardingTask is created or updated, and ObjectChange includes a user field identifying which user was responsible for the creation/update of the OnboardingTask. That's really the primary driver for this PR as I understand it now - that was the context I was previously missing, thanks for the clarification.