Merge pull request #138 from TeskaLabs/feature/slack-refactoring-at2606

Refactoring a Slack provider.

Author: ateska

asabiris/app.py

@@ -123,14 +123,7 @@ def __init__(self, args=None):
 			else:
 				# Initialize the SlackOutputService
 				self.SlackOutputService = SlackOutputService(self)
-
-				# Only initialize SendSlackOrchestrator if the SlackOutputService client is valid
-				if self.SlackOutputService.Client is None:
-					# If client is None, disable Slack orchestrator as well
-					self.SendSlackOrchestrator = None
-				else:
-					# If the client is valid, initialize the orchestrator
-					self.SendSlackOrchestrator = SendSlackOrchestrator(self)
+				self.SendSlackOrchestrator = SendSlackOrchestrator(self)
 
 		else:
 			# If the slack section is not present in the config, set both services to None

asabiris/orchestration/sendslack.py

@@ -38,6 +38,13 @@ async def send_to_slack(self, msg):
 
 		body = msg['body']
 		template = body["template"]
+		channel = body.get("channel", None)
+
+		# This allows to speficy channel id or member id directly, skipping the lookup by channel name.
+		channel_id = body.get("channel_id", None)
+		if channel_id is not None:
+			channel = "id " + channel_id
+
 		attachments = msg.get("attachments", None)
 		# if params no provided pass empty params
 		# - primarily use absolute path - starts with "/"
@@ -81,14 +88,14 @@ async def send_to_slack(self, msg):
 				fallback_message = output
 				blocks = None
 
-			await self.SlackOutputService.send_message(blocks, fallback_message)
+			await self.SlackOutputService.send_message(blocks, fallback_message, channel)
 			return
 
 		# Sending attachments
 
 		output = self.MarkdownFormatterService.unformat(output)
 		atts_gen = self.AttachmentRenderingService.render_attachment(attachments)
-		await self.SlackOutputService.send_files(output, atts_gen)
+		await self.SlackOutputService.send_files(output, atts_gen, channel)
 
 
 	async def render_attachment(self, template, params):

asabiris/output/slack/service.py

@@ -1,21 +1,23 @@
+import time
 import logging
 import configparser
+
+import asab
+
 try:
-	import slack_sdk.errors as slack_errors
-	from slack_sdk import WebClient
-	SlackApiError = slack_errors.SlackApiError
+	import slack_sdk
+	import slack_sdk.errors
 except ModuleNotFoundError:
-	slack_errors = None
-	WebClient = None
+	slack_sdk = None
 
-	class SlackApiError(Exception):
-		pass
 from ...errors import ASABIrisError, ErrorCode
-
-import asab
-
 from ...output_abc import OutputABC
 
+if slack_sdk is not None:
+	SlackApiError = slack_sdk.errors.SlackApiError
+else:
+	SlackApiError = Exception
+
 
 L = logging.getLogger(__name__)
 
@@ -30,62 +32,87 @@ def check_config(config, section, parameter):
 
 
 class SlackOutputService(asab.Service, OutputABC):
+
 	def __init__(self, app, service_name="SlackOutputService"):
 		super().__init__(app, service_name)
+		self.ConfigService = app.get_service("TenantConfigExtractionService")
 
 		# Load global configuration as defaults
-		self.SlackWebhookUrl = check_config(asab.Config, "slack", "token")
-		self.Channel = check_config(asab.Config, "slack", "channel")
-		# Keep tenant-config service always available
-		self.ConfigService = app.get_service("TenantConfigExtractionService")
+		self.ConfigToken = check_config(asab.Config, "slack", "token")
+		self.ConfigChannel = check_config(asab.Config, "slack", "channel")
 
-		# If required Slack configuration is missing, disable Slack service
-		if not self.SlackWebhookUrl or not self.Channel:
-			L.warning("Slack output service is not properly configured. Disabling Slack service.")
-			self.Client = None
-			return
+		self.Cache = {}
 
-		if WebClient is None:
-			L.warning("slack_sdk is not installed. Slack service is disabled.")
-			self.Client = None
+		if slack_sdk is None:
+			L.warning("slack_sdk library is not installed. Slack service is disabled.")
 			return
 
-		self.Client = WebClient(token=self.SlackWebhookUrl)
+		app.PubSub.subscribe("Application.tick/1800!", self._on_tick)
 
 
-	async def send_message(self, blocks, fallback_message) -> None:
-		"""
-		Sends a message to a Slack channel.
-		"""
-		if self.Client is None:
-			L.warning("SlackOutputService is not initialized properly. Message will not be sent.")
-			return
+	def _on_tick(self, event):
+		# clear cache every 1800 seconds
+		to_delete = []
+		for key, value in self.Cache.items():
+			if time.time() - value[2] > 3600:
+				to_delete.append(key)
+		for key in to_delete:
+			self.Cache.pop(key, None)
 
+
+	def _resolve(self, channel=None):
 		try:
 			effective_tenant = asab.contextvars.Tenant.get()
 		except LookupError:
 			effective_tenant = None
 
 		# determine which token/channel to use
-		token, channel = (self.SlackWebhookUrl, self.Channel)
 		if effective_tenant and self.ConfigService is not None:
 			try:
-				token, channel = self.ConfigService.get_slack_config(effective_tenant)
+				token, default_channel = self.ConfigService.get_slack_config(effective_tenant)
 			except KeyError:
 				L.warning(
 					"Tenant-specific Slack configuration not found for '%s'. Using global config.",
 					effective_tenant
 				)
+				token, default_channel = self.ConfigToken, self.ConfigChannel
+		else:
+			token, default_channel = self.ConfigToken, self.ConfigChannel
+
+		if channel is None:
+			channel = default_channel
+
+		cache_hit = self.Cache.get((token, channel), None)
+		if cache_hit is not None:
+			return cache_hit[0], cache_hit[1]
+
+		client = slack_sdk.WebClient(token=token)
+		channel_id = self.get_channel_id(client, channel)
+
+		self.Cache[(token, channel)] = (client, channel_id, time.time())
+
+		return client, channel_id
+
+
+	async def send_message(self, blocks, fallback_message, channel=None) -> None:
+		"""
+		Sends a message to a Slack channel.
+		"""
+		if slack_sdk is None:
+			L.warning("slack_sdk library is not installed. Slack service is disabled.")
+			return
+
+		client, channel_id = self._resolve(channel)
 
 		if channel is None:
 			raise ValueError("Cannot send message to Slack. Reason: Missing Slack channel")
-		if token is None:
-			raise ValueError("Cannot send message to Slack. Reason: Missing Webhook URL or token")
+		if client is None:
+			raise ValueError("Cannot send message to Slack.")
 
 		# Audit log of outgoing payload at NOTICE level
 		L.log(
 			asab.LOG_NOTICE,
-			"SlackOutputService.send_message → channel=%s, text=%r, blocks=%r",
+			"SlackOutputService.send_message",
 			struct_data={
 				"channel": channel,
 				"text": fallback_message,
@@ -94,8 +121,6 @@ async def send_message(self, blocks, fallback_message) -> None:
 		)
 
 		try:
-			client = WebClient(token=token)
-			channel_id = self.get_channel_id(client, channel)
 			client.chat_postMessage(
 				channel=channel_id,
 				text=fallback_message,
@@ -117,33 +142,15 @@ async def send_message(self, blocks, fallback_message) -> None:
 		)
 
 
-	async def send_files(self, body: str, atts_gen,):
+	async def send_files(self, body: str, atts_gen, channel=None):
 		"""
 		Sends a message to a Slack channel with attachments.
 		"""
-		if self.Client is None:
-			L.warning("SlackOutputService is not initialized properly. File will not be sent.")
+		if slack_sdk is None:
+			L.warning("slack_sdk library is not installed. Slack service is disabled.")
 			return
 
-		try:
-			effective_tenant = asab.contextvars.Tenant.get()
-		except LookupError:
-			effective_tenant = None
-
-		token, channel = (self.SlackWebhookUrl, self.Channel)
-		if effective_tenant and self.ConfigService is not None:
-			try:
-				token, channel = self.ConfigService.get_slack_config(effective_tenant)
-			except KeyError:
-				L.warning("Tenant-specific Slack configuration not found for '{}'. Using global config.".format(effective_tenant))
-
-		if channel is None:
-			raise ValueError("Cannot send message to Slack. Reason: Missing Slack channel")
-		if token is None:
-			raise ValueError("Cannot send message to Slack. Reason: Missing Webhook URL or token")
-
-		client = WebClient(token=token)
-		channel_id = self.get_channel_id(client, channel)
+		client, channel_id = self._resolve(channel)
 
 		try:
 			async for attachment in atts_gen:
@@ -185,13 +192,19 @@ async def send_files(self, body: str, atts_gen,):
 		)
 
 
-	def get_channel_id(self, client, channel_name, types="public_channel"):
+	def get_channel_id(self, client, channel_name, types=None):
 		"""
 		Fetches Slack channel ID from Slack API.
 		"""
+		if types is None:
+			types = ["public_channel", "private_channel"]
+
+		if channel_name.startswith("id "):
+			return channel_name.split("id ")[1]
+
 		for response in client.conversations_list(types=types):
 			for channel in response['channels']:
-				if channel['name'] == channel_name:
+				if channel.get('name') == channel_name:
 					return channel['id']
 
 		# Business-level error: channel not found

docs/bruno/Send Slack.bru

@@ -0,0 +1,30 @@
+meta {
+  name: Send Slack
+  type: http
+  seq: 4
+}
+
+put {
+  url: {{BASE_URL}}/send_slack
+  body: json
+  auth: inherit
+}
+
+headers {
+  Content-Type: application/json
+}
+
+body:json {
+  {
+    "type": "slack",
+      "body": {
+        "template": "/Templates/Slack/message.md",
+        "channel_id": "U0124ABCD",
+        "params": {
+          "content": "This is a Slack message ;-)"
+        }
+      }
+  }
+    
+    
+}

library/Templates/Slack/example.md

@@ -0,0 +1,6 @@
+*📧 Slack message from asab-iris 📧*
+
+This is the example of the Slack message sent by `asab-iris`.
+{% if name %}*Sent by:* {{ name }}{% endif %}
+
+More at <https://github.com/TeskaLabs/asab-iris|github.com/TeskaLabs/asab-iris>

library/Templates/Slack/message.md

@@ -1,35 +1 @@
-*🚨 Alert Management Notification 🚨*
-
-*<{{ public_url }}/?tenant={{ tenant }}#|TeskaLabs LogMan.io>* has identified a noteworthy event in your IT infrastructure that might require your immediate attention. 🕵️‍♂️ Please review the following summary of the event:
-
-{% if ticketid %}
-🔖 *Ticket ID:* {{ ticketid }} - This ticket has been updated.
-{% endif %}
-
-{% if type %}
-📑 *Type of Ticket:* {{ type }}
-{% endif %}
-
-{% if status %}
-📊 *Status Update:* The status was changed to: *{{ status }}*
-{% endif %}
-
-{% if credid %}
-🔑 *Changed by Credential ID:* {{ credid }}
-{% endif %}
-
-{% if username %}
-👤 *Changed by User:* {{ username }}
-{% endif %}
-
-We encourage you to *review this incident promptly* to determine the next appropriate course of action.
-
-🔍 To examine the incident in greater detail, please log in to your *<{{ public_url }}/?tenant={{ tenant }}#|TeskaLabs LogMan.io>*.
-
-💡 *Remember,* the effectiveness of any security program lies in a swift response. Thank you for your attention to this matter.
-
-Stay safe,
-
-*<{{ public_url }}/?tenant={{ tenant }}#|TeskaLabs LogMan.io>*
-
-Made with ❤️ by *<https://teskalabs.com|TeskaLabs>*
+{% if content %}{{ content }}{% endif %}