NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-12-11 10:59:36 -06:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

Fixes #20878: Use database routing when running script (#20879)

Browse Source
This commit is contained in:
Arthur Hanson 2025-12-03 15:47:31 -08:00 committed by GitHub
parent 922b08c0ff
commit 7f39f75d3d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
netbox/extras/jobs.py
View File

@ -2,11 +2,14 @@ import logging
import traceback import traceback
from contextlib import ExitStack from contextlib import ExitStack
from django.db import transaction from django.db import router, transaction
from django.db import DEFAULT_DB_ALIAS
from django.utils.translation import gettext as _ from django.utils.translation import gettext as _
from core.signals import clear_events from core.signals import clear_events
from dcim.models import Device
from extras.models import Script as ScriptModel from extras.models import Script as ScriptModel
from netbox.context_managers import event_tracking
from netbox.jobs import JobRunner from netbox.jobs import JobRunner
from netbox.registry import registry from netbox.registry import registry
from utilities.exceptions import AbortScript, AbortTransaction from utilities.exceptions import AbortScript, AbortTransaction
@ -42,10 +45,21 @@ class ScriptJob(JobRunner):
# A script can modify multiple models so need to do an atomic lock on # A script can modify multiple models so need to do an atomic lock on
# both the default database (for non ChangeLogged models) and potentially # both the default database (for non ChangeLogged models) and potentially
# any other database (for ChangeLogged models) # any other database (for ChangeLogged models)
with transaction.atomic(): changeloged_db = router.db_for_write(Device)
script.output = script.run(data, commit) with transaction.atomic(using=DEFAULT_DB_ALIAS):
if not commit: # If branch database is different from default, wrap in a second atomic transaction
raise AbortTransaction() # Note: Don't add any extra code between the two atomic transactions,
# otherwise the changes might get committed to the default database
# if there are any raised exceptions.
if changeloged_db != DEFAULT_DB_ALIAS:
with transaction.atomic(using=changeloged_db):
script.output = script.run(data, commit)
if not commit:
raise AbortTransaction()
else:
script.output = script.run(data, commit)
if not commit:
raise AbortTransaction()
except AbortTransaction: except AbortTransaction:
script.log_info(message=_("Database changes have been reverted automatically.")) script.log_info(message=_("Database changes have been reverted automatically."))
if script.failed: if script.failed:
@ -108,14 +122,14 @@ class ScriptJob(JobRunner):
script.request = request script.request = request
self.logger.debug(f"Request ID: {request.id if request else None}") self.logger.debug(f"Request ID: {request.id if request else None}")
# Execute the script. If commit is True, wrap it with the event_tracking context manager to ensure we process
# change logging, event rules, etc.
if commit: if commit:
self.logger.info("Executing script (commit enabled)") self.logger.info("Executing script (commit enabled)")
with ExitStack() as stack:
for request_processor in registry['request_processors']:
stack.enter_context(request_processor(request))
self.run_script(script, request, data, commit)
else: else:
self.logger.warning("Executing script (commit disabled)") self.logger.warning("Executing script (commit disabled)")
with ExitStack() as stack:
for request_processor in registry['request_processors']:
if not commit and request_processor is event_tracking:
continue
stack.enter_context(request_processor(request))
self.run_script(script, request, data, commit) self.run_script(script, request, data, commit)