starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

AutoSyncRecord inconsistent after file change #9162

New Issue
Closed
opened 2025-12-29 20:46:23 +01:00 by adam · 4 comments
adam commented 2025-12-29 20:46:23 +01:00
Owner
Copy Link

Originally created by @alehaa on GitHub (Jan 26, 2024).

Originally assigned to: @jeremystretch on GitHub.

Deployment Type

Self-hosted

NetBox Version

v3.7.1

Python Version

3.11

Steps to Reproduce

  1. Create data source TestData:

    Field Value
    Name TestData
    Type git
    URL https://github.com/netbox-community/netbox-plugin-tutorial.git
    enabled yes

  2. Sync data source TestData.

  3. Create export template TestExport:

    Field Value
    Name TestExport
    Content Types Circuits > Circuit (but any will do)
    Data Source TestData
    Data File README.md
    Auto Sync Enabled yes

  4. Edit export template TestExport.

  5. Select Data file tutorial/step01-initial-setup.md and save. (will fail).

  6. Go back to edit form for export template TestExport.

  7. Set Data source, Data file and Auto Sync enabled to null and save.

Expected Behavior

Step 5: Edit succeeds.
Step 7: AutoSyncRecord is removed from database.

Observed Behavior

Step 5: An IntegrityError error is raised, as SyncedDataMixin's save() method won't change existing AutoSyncRecord objects.

Step 7: Edit succeeds, but the related AutoSyncRecord stays in the database. This is due SyncedDataMixin's save() method will remove related AutoSyncRecord objects, but the QuerySet filter uses fields of the object previously set to None in the edit form.

Originally created by @alehaa on GitHub (Jan 26, 2024). Originally assigned to: @jeremystretch on GitHub. ### Deployment Type Self-hosted ### NetBox Version v3.7.1 ### Python Version 3.11 ### Steps to Reproduce 1. Create data source `TestData`: | Field | Value | |--------|--------| | **Name** | TestData | | **Type** | git | | **URL** | https://github.com/netbox-community/netbox-plugin-tutorial.git | | **enabled** | `yes` | 1. Sync data source `TestData`. 1. Create export template `TestExport`: | Field | Value | |--------|--------| | **Name** | TestExport | | **Content Types** | `Circuits > Circuit` (but any will do) | | **Data Source** | TestData | | **Data File** | README.md | | **Auto Sync Enabled** | `yes` | 1. Edit export template `TestExport`. 1. Select **Data file** `tutorial/step01-initial-setup.md` and save. (**will fail**). 1. Go back to edit form for export template `TestExport`. 1. Set **Data source**, **Data file** and **Auto Sync enabled** to null and save. ### Expected Behavior Step 5: Edit succeeds. Step 7: `AutoSyncRecord` is removed from database. ### Observed Behavior Step 5: An `IntegrityError` error is raised, as `SyncedDataMixin`'s [`save()` method](https://github.com/netbox-community/netbox/blob/b9cac97b73c1c08213db6272de11c03711491486/netbox/netbox/models/features.py#L424) won't change existing `AutoSyncRecord` objects. Step 7: Edit succeeds, but the related `AutoSyncRecord` stays in the database. This is due `SyncedDataMixin`'s [`save()` method](https://github.com/netbox-community/netbox/blob/b9cac97b73c1c08213db6272de11c03711491486/netbox/netbox/models/features.py#L497) will remove related `AutoSyncRecord` objects, but the `QuerySet` filter uses fields of the object previously set to `None` in the edit form.
adam added the type: bugstatus: acceptedseverity: medium labels 2025-12-29 20:46:23 +01:00
adam closed this issue 2025-12-29 20:46:23 +01:00
adam commented 2025-12-29 20:46:24 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 29, 2024):

Please revise your post above to include explicit instructions. It's not clear exactly which actions are needed to reproduce the bug. Providing a concrete example would be very helpful.

@jeremystretch commented on GitHub (Jan 29, 2024): Please revise your post above to include explicit instructions. It's not clear exactly which actions are needed to reproduce the bug. Providing a concrete example would be very helpful.
adam commented 2025-12-29 20:46:24 +01:00
Author
Owner
Copy Link

@alehaa commented on GitHub (Feb 1, 2024):

@jeremystretch I've updated the instructions to reproduce the issue.

@alehaa commented on GitHub (Feb 1, 2024): @jeremystretch I've updated the instructions to reproduce the issue.
adam commented 2025-12-29 20:46:24 +01:00
Author
Owner
Copy Link

@alehaa commented on GitHub (Feb 9, 2024):

I believe this could be solved easily by altering the delete mechanism in SyncDataMixin to delete all records that should not be present in the database at the end of save() and delete(). I could check this locally and provide a PR if wanted …

@alehaa commented on GitHub (Feb 9, 2024): I believe this could be solved easily by altering the delete mechanism in `SyncDataMixin` to delete all records that should not be present in the database at the end of `save()` and `delete()`. I could check this locally and provide a PR if wanted …
adam commented 2025-12-29 20:46:25 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 16, 2024):

I believe this could be solved easily by altering the delete mechanism in SyncDataMixin to delete all records that should not be present in the database at the end of save() and delete(). I could check this locally and provide a PR if wanted …

Thanks @alehaa. I think you're on the right track here. We can probably just change get_or_create() to update_or_create() to handle both conditions. I'll submit the change for review in a minute.

@jeremystretch commented on GitHub (Feb 16, 2024): > I believe this could be solved easily by altering the delete mechanism in SyncDataMixin to delete all records that should not be present in the database at the end of save() and delete(). I could check this locally and provide a PR if wanted … Thanks @alehaa. I think you're on the right track here. We can probably just change `get_or_create()` to `update_or_create()` to handle both conditions. I'll submit the change for review in a minute.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label severity: medium status: accepted type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9162
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?