Module Template do not sync if main branch has interface template changes

[XBravRevolutionz]

Plugin Version

0.7.1

NetBox Version

4.4.3

Python Version

3.12.3

Steps to Reproduce

1. Create a module template with interfaces in Main branch.
2. Create a new branch.
3. On main branch, delete interfaces and create new interfaces.
4. On new branch, sync with main branch (Without Commit. See Comment Below) . The changes from the main branch will not be present.
5. Attempt to modify or delete one of the interfaces on the branch.

Expected Behavior

The branch sync feature should be able to synchronize the newer data from the main branch, even if the interface template IDs change. The synchronization should align the branch with the main branch, and ideally identify if any of the branch changes would be erased by the main branch sync.

Observed Behavior

Server Error

There was a problem with your request. Please contact an administrator.

The complete exception is provided below:

<class 'dcim.models.device_component_templates.InterfaceTemplate.DoesNotExist'>

InterfaceTemplate matching query does not exist.

Python version: 3.12.3
NetBox version: 4.4.3
Plugins:
netbox_branching: 0.7.1

If further assistance is required, please post to the NetBox discussion forum on GitHub.

I have not tested if this issue will further cascade when trying to merge the branch into the main trunk.

[XBravRevolutionz]

Additional information:

If the main branch deletes an interface, the associated ID is removed from the main branch but remains in the new branch. Yet, when we go to save a change in the branch, the save action appears to be interfacing with the main branch.

Interface Template on test branch:

HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 1,
    "url": "https://x/api/dcim/interface-templates/1/",
    "display": "{module}-ethernet-1",
    "device_type": null,
    "module_type": {
        "id": 148,
        "url": "https://x/api/dcim/module-types/148/",
        "display": "1756-EN2T",
        "profile": null,
        "manufacturer": {
            "id": 1,
            "url": "https://x/api/dcim/manufacturers/1/",
            "display": "x",
            "name": "x",
            "slug": "x",
            "description": "x"
        },
        "model": "x",
        "description": "x"
    },
    "name": "{module}-ethernet-1",
    "label": "",
    "type": {
        "value": "100base-tx",
        "label": "100BASE-TX (10/100ME)"
    },
    "enabled": true,
    "mgmt_only": false,
    "description": "",
    "bridge": null,
    "poe_mode": null,
    "poe_type": null,
    "rf_role": null,
    "created": "2024-05-21T18:47:24.896889Z",
    "last_updated": "2024-05-21T18:56:00.605790Z"
}

Interface template on main branch:

HTTP 404 Not Found
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "detail": "No InterfaceTemplate matches the given query."
}

[XBravRevolutionz]

Further context:

This can be resolved by synchronizing and committing the changes. I did discover an error during sync if the exact interface definitions were recreated as new IDs in the branch. This will cause the sync to fail with a conflict error. Deleting the conflicting interface names or renaming them will allow the sync to complete.

It would be ideal if these deletion differences were identified in the branching preview, or if there is a better error indication if a branch is making a change to a deleted ID from the main branch.

[tgrusendorf]

I was able to reproduce this on my sandbox system with the following steps (no sync required):

1. Create a module type with one or more interfaces
2. Create a new branch
3. Delete one of the module type interfaces in the main branch
4. Activate the new branch
5. Observe that the deleted interface is present in the branch (as expected)
6. Attempt to edit or delete the interface in the branch

Result:

<class 'dcim.models.device_component_templates.InterfaceTemplate.DoesNotExist'>

InterfaceTemplate matching query does not exist.

Python version: 3.11.2
NetBox version: 4.4.3
Plugins:
netbox_branching: 0.7.1
netbox_topology_views: 4.4.0

I confirmed the same behaviour also occurs with device type interfaces and device interfaces.