When updating data via Script, Changes Ahead doesn't behave correctly

[mrhyks]

Plugin Version

0.7.1

NetBox Version

4.4.8

Python Version

3.10.2

Steps to Reproduce

1. Create custom script.
2. Run it
3. Commit changes
4. Got to branch and Changes Ahead tab

Expected Behavior

Let's say script made update to interface description from nothing to "Test", then in changes tab I should see only description update only to said interface.

Observed Behavior

But instead it sais that every field was None and then change to something.

[mrhyks]

This script should update description on ports in which is cable connected. If so description should be in format "-Device-;-Port-;-custom field TETH-;-custom field device class-"

class UpdatePortDescriptionsFromCable(Script):
    class Meta:  # type: ignore
        name = "Update Port Descriptions from Cable"
        description = (
            "Update port descriptions based on connected device and interface"
        )

    device = ObjectVar(
        model=Device, required=False, label="Select device to update"
    )

    def run(self, data, commit):
        if data["device"]:
            devices = [data["device"]]
        else:
            devices = Device.objects.all()  # type: ignore

        for device in devices:
            for interface in device.interfaces.all():
                if interface.cable:
                    side = interface.cable_end
                    if (
                        not interface.cable.a_terminations
                        or not interface.cable.b_terminations
                    ):
                        self.log_warning(
                            f"Cable {interface.cable} is not fully terminated",
                            obj=device,
                        )
                        continue
                    if side == "A":
                        other_interface = interface.cable.b_terminations[0]
                    else:
                        other_interface = interface.cable.a_terminations[0]

                    if other_interface and other_interface.device:
                        try:
                            teth = str(
                                interface.cable.custom_field_data["teth"]
                            )
                        except KeyError:
                            teth = "XXXX"
                        if teth == "None":
                            teth = "XXXX"

                        try:
                            device_classification = (
                                other_interface.device.custom_field_data[
                                    "device_classification"
                                ]
                            )
                        except KeyError:
                            device_classification = ""
                        if str(device_classification) == "None":
                            device_classification = ""

                        new_description = (
                            f"{other_interface.device.name.replace('.node0','').replace('.node1','').replace('.node2','')};{other_interface.name}"
                            f";TETH{teth};{device_classification}"
                        )
                        old_description = interface.description
                        interface.description = new_description

                        if old_description != new_description:
                            try:
                                if commit:
                                    interface.save()
                            except AttributeError:
                                pass
                            finally:
                                self.log_success(
                                    (
                                        f"Updated description on {interface.name} from"
                                        f"'{old_description}' ----> '{new_description}'",
                                    ),
                                    obj=device,
                                )

[cruse1977]

possible duplicate of 339 - which is resolved in netbox 20879

[mrhyks]

I thought netbox-community/netbox#20879 would fix it, so I upgraded to netbox v4.4.8, which includes this fix, but the problem persists.

[arthanson]

@mrhyks this script file isn't working, can you please upload a working / simplified version of it. If all you are doing is updating the description can the script just be narrowed down to something like:

    for interface in device.interfaces.all()[:5]:
        interface.description = "test"

Please narrow it down to the simplest script that replicates the issue if possible.

[Christophoclese]

Been doing some testing with Diode, Orb, and Branching in the past couple of days. The branch diffs for the items that Diode ingested also show the Before state as mostly null values. Not convinced this behavior is limited to just custom scripts.