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

feat: dynamic webhook URL #21064

Merged
merged 6 commits into from
Jun 2, 2023
Merged

feat: dynamic webhook URL #21064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
77e73cc
feat: support for dynamic URL in webhook
NagariaHussain May 21, 2023
8f8c6b5
test: tests for dynamic URL
NagariaHussain May 21, 2023
813e465
Merge branch 'develop' into feat-dynamic-webhook-url
NagariaHussain May 21, 2023
3f08e80
style: lint test file
NagariaHussain May 21, 2023
a45eb9c
Merge branch 'develop' into feat-dynamic-webhook-url
NagariaHussain May 22, 2023
9fa2655
fix: bring back modified field in json file
NagariaHussain May 22, 2023
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
56 changes: 56 additions & 0 deletions frappe/integrations/doctype/webhook/test_webhook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,3 +206,59 @@ def test_webhook_with_array_body(self):
enqueue_webhook(doc, wh)
log = frappe.get_last_doc("Webhook Request Log")
self.assertEqual(len(json.loads(log.response)["json"]), 3)

def test_webhook_with_dynamic_url_enabled(self):
wh_config = {
"doctype": "Webhook",
"webhook_doctype": "Note",
"webhook_docevent": "after_insert",
"enabled": 1,
"request_url": "https://httpbin.org/anything/{{ doc.doctype }}",
"is_dynamic_url": 1,
"request_method": "POST",
"request_structure": "JSON",
"webhook_json": "{}",
"meets_condition": "Yes",
"webhook_headers": [
{
"key": "Content-Type",
"value": "application/json",
}
],
}

with get_test_webhook(wh_config) as wh:
doc = frappe.new_doc("Note")
doc.title = "Test Webhook Note"
enqueue_webhook(doc, wh)
log = frappe.get_last_doc("Webhook Request Log")
self.assertEqual(json.loads(log.response)["url"], "https://httpbin.org/anything/Note")

def test_webhook_with_dynamic_url_disabled(self):
wh_config = {
"doctype": "Webhook",
"webhook_doctype": "Note",
"webhook_docevent": "after_insert",
"enabled": 1,
"request_url": "https://httpbin.org/anything/{{doc.doctype}}",
"is_dynamic_url": 0,
"request_method": "POST",
"request_structure": "JSON",
"webhook_json": "{}",
"meets_condition": "Yes",
"webhook_headers": [
{
"key": "Content-Type",
"value": "application/json",
}
],
}

with get_test_webhook(wh_config) as wh:
doc = frappe.new_doc("Note")
doc.title = "Test Webhook Note"
enqueue_webhook(doc, wh)
log = frappe.get_last_doc("Webhook Request Log")
self.assertEqual(
json.loads(log.response)["url"], "https://httpbin.org/anything/{{doc.doctype}}"
)
12 changes: 10 additions & 2 deletions frappe/integrations/doctype/webhook/webhook.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@
"html_condition",
"sb_webhook",
"request_url",
"request_method",
"is_dynamic_url",
"cb_webhook",
"request_method",
"request_structure",
"sb_security",
"enable_security",
Expand Down Expand Up @@ -202,6 +203,13 @@
{
"fieldname": "section_break_28",
"fieldtype": "Section Break"
},
{
"default": "0",
"description": "On checking this option, URL will be treated like a jinja template string",
"fieldname": "is_dynamic_url",
"fieldtype": "Check",
"label": "Is Dynamic URL?"
}
],
"links": [
Expand All @@ -210,7 +218,7 @@
"link_fieldname": "webhook"
}
],
"modified": "2023-05-21 15:42:58.844826",
NagariaHussain marked this conversation as resolved.
Show resolved Hide resolved
"modified": "2023-05-22 16:30:10.740512",
"modified_by": "Administrator",
"module": "Integrations",
"name": "Webhook",
Expand Down
15 changes: 10 additions & 5 deletions frappe/integrations/doctype/webhook/webhook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,29 +115,34 @@ def enqueue_webhook(doc, webhook) -> None:
webhook: Webhook = frappe.get_doc("Webhook", webhook.get("name"))
headers = get_webhook_headers(doc, webhook)
data = get_webhook_data(doc, webhook)
r = None

if webhook.is_dynamic_url:
request_url = frappe.render_template(webhook.request_url, get_context(doc))
else:
request_url = webhook.request_url

r = None
for i in range(3):
try:
r = requests.request(
method=webhook.request_method,
url=webhook.request_url,
url=request_url,
data=json.dumps(data, default=str),
headers=headers,
timeout=5,
)
r.raise_for_status()
frappe.logger().debug({"webhook_success": r.text})
log_request(webhook.name, doc.name, webhook.request_url, headers, data, r)
log_request(webhook.name, doc.name, request_url, headers, data, r)
break

except requests.exceptions.ReadTimeout as e:
frappe.logger().debug({"webhook_error": e, "try": i + 1})
log_request(webhook.name, doc.name, webhook.request_url, headers, data)
log_request(webhook.name, doc.name, request_url, headers, data)

except Exception as e:
frappe.logger().debug({"webhook_error": e, "try": i + 1})
log_request(webhook.name, doc.name, webhook.request_url, headers, data, r)
log_request(webhook.name, doc.name, request_url, headers, data, r)
sleep(3 * i + 1)
if i != 2:
continue
Expand Down