Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enable Event Rules to process and send data to Scripts using Event Data #15063

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Enable Event Rules to process and send data to Scripts using Event Data #15063

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4de5046
Render Action Data as Jinja2
renatoalmeidaoliveira Feb 6, 2024
1ed0980
Fix json string sent by render_script_data, and setups run_script to …
renatoalmeidaoliveira Feb 6, 2024
17ad376
Lint PEP8
renatoalmeidaoliveira Feb 6, 2024
ae828ad
Join changes in process_event_rule and limit to process and send acti…
renatoalmeidaoliveira Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 18 additions & 1 deletion netbox/extras/events.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import logging
import json

from django.conf import settings
from django.contrib.auth import get_user_model
Expand All @@ -14,7 +15,7 @@
from netbox.registry import registry
from utilities.api import get_serializer_for_model
from utilities.rqworker import get_rq_retry
from utilities.utils import serialize_object
from utilities.utils import serialize_object, render_jinja2
from .choices import *
from .models import EventRule, ScriptModule

Expand Down Expand Up @@ -119,6 +120,22 @@ def process_event_rules(event_rules, model_name, event, data, username=None, sna
script_name = event_rule.action_parameters['script_name']
script = script_module.scripts[script_name]()

# Process Action Data

if event_rule.action_data:
context = {
'event': event,
'timestamp': timezone.now().isoformat(),
'model': model_name,
'username': username,
'request_id': request_id,
'model': data,
}
rendered_data = render_jinja2(json.dumps(event_rule.action_data), context)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I don't see why the render_jinja2 is needed here - event_rule.action_data should just be the json (dictionary) which should be able to get directly passed to the script. I'm thinking you could just change the Job.enqueue to pass event_rule.action_data as the data param.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arthanson If we don't render the jinja2 how the user gonna pass variables to the script, for example:
1 - For example the Script form expects an Interface ID, or some model attribute.
If It didn't run the jinja2 how the user gonna be able to pass models variables to be processed by the script form?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user doens't have the model params when he defines the event rule, so I think there must be some way for him to reference the models and the changelogs, to build the data that gonna be passed to the Script form

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The action_data field on EventRule holds a dictionary of arbitrary additional data. This doesn't require any mutation; it just needs to be passed to the script, and the script needs to accommodate whatever data is being passed as variables.

I think you're trying to accomplish something different than what I agreed to here. There's no reason to manipulate the data before sending it to the script; the script just needs to be written to accept the data as passed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jeremystretch even if I pass the event_data as is to the script how the Script developer gonna be able to reference the event object like the changed object, since it doesn't have that data inside the Script? another thing is that way breaks the common script logic where the developer expects the data dict to return a parsed form

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going further if the action_data is a static value what's the meaning of having it at all, the Script dev could just create the script with that data hard coded

form = script.as_form(json.loads(rendered_data))
if form.is_valid():
data = form.cleaned_data

# Enqueue a Job to record the script's execution
Job.enqueue(
"extras.scripts.run_script",
Expand Down