feat: rewrite notification using requests lib (#2098)

* feat: add make_api_call function for making authenticated API requests

* refactor(notification): replace FrappeClient with make_api_call for API requests in notification handling

* fix(notification): correct token sync error handling in raven_cloud_notifications.py

* chore: bump version to 2.8.10

Author: prathameshkurunkar7

frontend/package.json

@@ -2,7 +2,7 @@
   "name": "raven-web",
   "private": true,
   "license": "AGPL-3.0-only",
-  "version": "2.8.9",
+  "version": "2.8.10",
   "type": "module",
   "scripts": {
     "dev": "vite",

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "raven",
-  "version": "2.8.9",
+  "version": "2.8.10",
   "description": "Messaging Application",
   "workspaces": [
     "frontend",

raven/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.8.9"
+__version__ = "2.8.10"
 
 from raven.raven_integrations.doctype.raven_incoming_webhook.raven_incoming_webhook import (  # noqa
 	handle_incoming_webhook as webhook,

raven/api/notification.py

@@ -29,24 +29,26 @@ def register_site_on_raven_cloud() -> None:
 	"""
 	Register the site on Raven Cloud
 	"""
+	from raven.utils import make_api_call
+
 	frappe.only_for("System Manager")
 	raven_settings = frappe.get_single("Raven Settings")
 
 	if raven_settings.push_notification_service == "Raven":
 
-		client = FrappeClient(
-			url=raven_settings.push_notification_server_url,
+		url = f"{raven_settings.push_notification_server_url}/api/method/raven_cloud.api.notification.register_site"
+
+		response = make_api_call(
+			url=url,
 			api_key=raven_settings.push_notification_api_key,
 			api_secret=raven_settings.get_password("push_notification_api_secret"),
-		)
-
-		response = client.post_api(
-			"raven_cloud.api.notification.register_site",
+			method="POST",
 			params={"site_name": urlparse(frappe.utils.get_url()).hostname},
 		)
+		message = response.get("message")
 
-		raven_settings.config = response.get("config")
-		raven_settings.vapid_public_key = response.get("vapid_public_key")
+		raven_settings.config = message.get("config")
+		raven_settings.vapid_public_key = message.get("vapid_public_key")
 		raven_settings.save()
 	else:
 		frappe.throw(_("Push notification service is not set to Raven Cloud."))

raven/notification.py

@@ -6,7 +6,8 @@
 from frappe.utils import get_datetime, get_system_timezone
 from pytz import timezone, utc
 
-from raven.utils import get_channel_members
+from raven.raven_cloud_notifications import get_site_name
+from raven.utils import get_channel_members, make_api_call
 
 MAX_NOTIFICATION_CONTENT_LENGTH = 1000
 
@@ -208,27 +209,21 @@ def make_post_call_for_notification(messages, raven_settings):
 	"""
 	Make a post call to the push notification server to send the notification
 	"""
-	from base64 import b64encode
-
-	import requests
-
 	# instead of using the frappe client, we will use the requests library to make the post call
 	# reason: FrappeClient's post_api method sends data in params which is not ideal for large payloads(Proxy returns JSON Decode errors as the URL is too long)
 	# and post_request method uses "cmd" based key in it's payload which is weird semantically
 
 	api_key = raven_settings.push_notification_api_key
 	api_secret = raven_settings.get_password("push_notification_api_secret")
 
-	token = b64encode(f"{api_key}:{api_secret}".encode()).decode()
-	auth_header = {"Authorization": f"Basic {token}"}
+	url = f"{raven_settings.push_notification_server_url}/api/method/raven_cloud.api.notification.send_to_users"
 
-	requests.post(
-		f"{raven_settings.push_notification_server_url}/api/method/raven_cloud.api.notification.send_to_users",
-		json={
-			"messages": json.dumps(messages),
-			"site_name": urlparse(frappe.utils.get_url()).hostname,
-		},
-		headers=auth_header,
+	make_api_call(
+		url=url,
+		api_key=api_key,
+		api_secret=api_secret,
+		method="POST",
+		params={"messages": json.dumps(messages), "site_name": get_site_name()},
 	)
 
 

raven/package.json

@@ -1,6 +1,6 @@
 {
   "name": "raven-app",
-  "version": "2.8.9",
+  "version": "2.8.10",
   "description": "",
   "main": "index.js",
   "scripts": {

raven/raven_cloud_notifications.py

@@ -2,7 +2,8 @@
 from urllib.parse import urlparse
 
 import frappe
-from frappe.frappeclient import FrappeClient
+
+from raven.utils import make_api_call
 
 # ----- Utility Functions -----
 
@@ -20,14 +21,13 @@ def add_token_to_raven_cloud(user_id, token):
 	"""
 	raven_settings = frappe.get_single("Raven Settings")
 
-	client = FrappeClient(
-		url=raven_settings.push_notification_server_url,
+	url = f"{raven_settings.push_notification_server_url}/api/method/raven_cloud.api.notification.create_user_token"
+
+	make_api_call(
+		url=url,
 		api_key=raven_settings.push_notification_api_key,
 		api_secret=raven_settings.get_password("push_notification_api_secret"),
-	)
-
-	client.post_api(
-		"raven_cloud.api.notification.create_user_token",
+		method="POST",
 		params={
 			"user_id": user_id,
 			"token": token,
@@ -42,14 +42,13 @@ def delete_token_from_raven_cloud(user_id, token):
 	"""
 	raven_settings = frappe.get_single("Raven Settings")
 
-	client = FrappeClient(
-		url=raven_settings.push_notification_server_url,
+	url = f"{raven_settings.push_notification_server_url}/api/method/raven_cloud.api.notification.delete_user_token"
+
+	make_api_call(
+		url=url,
 		api_key=raven_settings.push_notification_api_key,
 		api_secret=raven_settings.get_password("push_notification_api_secret"),
-	)
-
-	client.post_api(
-		"raven_cloud.api.notification.delete_user_token",
+		method="POST",
 		params={
 			"user_id": user_id,
 			"token": token,
@@ -65,33 +64,22 @@ def sync_users_tokens_to_raven_cloud():
 	raven_settings = frappe.get_single("Raven Settings")
 	tokens = frappe.db.get_all("Raven Push Token", fields=["user", "fcm_token"], order_by="user")
 
-	# Group tokens by user to ensure all tokens for a user are in the same chunk
-	user_tokens = {}
-	for token in tokens:
-		user_tokens.setdefault(token["user"], []).append(token)
-
-		# Build chunks where all tokens for a user stay together
-	chunks = []
-	current_chunk = []
-	for user, user_token_list in user_tokens.items():
-		if len(current_chunk) + len(user_token_list) > 10 and current_chunk:
-			chunks.append(current_chunk)
-			current_chunk = []
-		current_chunk.extend(user_token_list)
-	if current_chunk:
-		chunks.append(current_chunk)
-
-	for chunk in chunks:
-		client = FrappeClient(
-			url=raven_settings.push_notification_server_url,
-			api_key=raven_settings.push_notification_api_key,
-			api_secret=raven_settings.get_password("push_notification_api_secret"),
-		)
+	url = f"{raven_settings.push_notification_server_url}/api/method/raven_cloud.api.notification.import_user_tokens"
 
-		client.post_api(
-			"raven_cloud.api.notification.import_user_tokens",
-			params={
-				"site_name": get_site_name(),
-				"tokens": json.dumps(chunk),
-			},
+	response = make_api_call(
+		url=url,
+		api_key=raven_settings.push_notification_api_key,
+		api_secret=raven_settings.get_password("push_notification_api_secret"),
+		method="POST",
+		params={"site_name": get_site_name(), "tokens": json.dumps(tokens)},
+	)
+	message = response.get("message")
+
+	if message.get("status") == "success":
+		return "Tokens synced successfully"
+	else:
+		frappe.log_error(
+			title="Raven Cloud Sync Tokens Error",
+			message=f"Failed to sync tokens: {message.get('message')}",
 		)
+		return "Failed to sync tokens"

raven/scheduler/daily.py

@@ -8,33 +8,35 @@
 def sync_invalid_tokens():
 	"""
 	This function is used to fetch the invalid tokens from Raven Cloud and sync them to the database.
-	It runs a loop to fetch the Invalid tokens in batches of 10 from Raven Cloud and deletes them from the database.
+	It runs a loop to fetch the Invalid tokens in batches of 100 from Raven Cloud and deletes them from the database.
 	If has_more is true, it will continue to fetch the next batch of tokens.
 	If has_more is false, it will break the loop. If there are no invalid tokens or error in fetching the invalid tokens, it will break the loop.
 	"""
+	from raven.utils import make_api_call
+
 	raven_settings = frappe.get_single("Raven Settings")
 
-	client = FrappeClient(
-		url=raven_settings.push_notification_server_url,
-		api_key=raven_settings.push_notification_api_key,
-		api_secret=raven_settings.get_password("push_notification_api_secret"),
-	)
+	url = f"{raven_settings.push_notification_server_url}/api/method/raven_cloud.api.notification.sync_invalid_tokens"
 
-	batch_size = 10
+	batch_size = 100
 
 	site_name = get_site_name()
 
 	while True:
 		try:
-			response = client.post_api(
-				"raven_cloud.api.notification.sync_invalid_tokens",
+			response = make_api_call(
+				url=url,
+				api_key=raven_settings.push_notification_api_key,
+				api_secret=raven_settings.get_password("push_notification_api_secret"),
+				method="POST",
 				params={
 					"site_name": site_name,
 					"batch_size": batch_size,
 				},
 			)
+			message = response.get("message")
 
-			invalid_tokens = response.get("invalid_tokens", [])
+			invalid_tokens = message.get("invalid_tokens", [])
 
 			if not invalid_tokens:
 				break
@@ -48,7 +50,7 @@ def sync_invalid_tokens():
 					)
 
 			# Check if more tokens exist
-			has_more = response.get("has_more", False)
+			has_more = message.get("has_more", False)
 			if not has_more:
 				break
 

raven/utils.py

@@ -224,3 +224,31 @@ def clear_thread_reply_count_cache(thread_id: str):
 	Clear the thread reply count cache
 	"""
 	frappe.cache().hdel("raven:thread_reply_count", thread_id)
+
+
+def make_api_call(url: str, api_key: str, api_secret: str, method: str, params: dict = None):
+	"""
+	Make an API call to the given URL
+	"""
+	from base64 import b64encode
+
+	import requests
+
+	token = b64encode(f"{api_key}:{api_secret}".encode()).decode()
+	auth_header = {"Authorization": f"Basic {token}"}
+
+	if method == "GET":
+		response = requests.get(url, headers=auth_header, params=params)
+	elif method == "POST":
+		response = requests.post(url, headers=auth_header, json=params)
+
+	# return response.json only if the response is successful
+	if not response.ok:
+		frappe.log_error(
+			title="Raven Cloud API Error",
+			message=f"Failed to make API call to {url}: {response.status_code} {response.text}",
+		)
+		raise Exception(f"Failed to make API call to {url}: {response.status_code} {response.text}")
+
+	# Return the JSON response
+	return response.json()