Merge pull request galaxyproject#17093 from davelopez/23.1_backport_#…

…17042

[23.1] Allow relative URLs in broadcasts action links

client/src/schema/schema.ts

@@ -1640,7 +1640,6 @@ export interface components {
             action_name: string;
             /**
              * Link
-             * Format: uri
              * @description The link to be opened when the button is clicked.
              */
             link: string;

lib/galaxy/schema/notifications.py

@@ -8,7 +8,6 @@
 )
 
 from pydantic import (
-    AnyUrl,
     Field,
     Required,
 )
@@ -22,7 +21,10 @@
     EncodedDatabaseIdField,
 )
 from galaxy.schema.schema import Model
-from galaxy.schema.types import OffsetNaiveDatetime
+from galaxy.schema.types import (
+    AbsoluteOrRelativeUrl,
+    OffsetNaiveDatetime,
+)
 
 
 class NotificationVariant(str, Enum):
@@ -73,7 +75,9 @@ class ActionLink(Model):
     action_name: str = Field(
         Required, title="Action name", description="The name of the action, will be the button title."
     )
-    link: AnyUrl = Field(Required, title="Link", description="The link to be opened when the button is clicked.")
+    link: AbsoluteOrRelativeUrl = Field(
+        Required, title="Link", description="The link to be opened when the button is clicked."
+    )
 
 
 # Create the corresponding model for the registered category below and

lib/galaxy/schema/types.py

@@ -7,6 +7,9 @@
 # Making them an alias of `str` for now
 RelativeUrl = str
 
+# TODO: we may want to add a custom validator for this and for RelativeUrl
+AbsoluteOrRelativeUrl = RelativeUrl
+
 LatestLiteral = Literal["latest"]
 
 

test/integration/test_notifications.py

@@ -7,6 +7,7 @@
     Dict,
     List,
     Optional,
+    Tuple,
 )
 from uuid import uuid4
 
@@ -278,6 +279,25 @@ def test_notification_input_dates_consider_timezone(self):
         assert notification["publication_time"] == "2021-01-01T10:00:00"
         assert notification["expiration_time"] == "2021-01-01T12:00:00"
 
+    def test_broadcast_notification_action_links(self):
+        # Broadcast notifications can have relative and absolute links
+        response = self._send_broadcast_notification(
+            action_links=[("View Workflows", "/workflows/list"), ("Go to GTN", "https://training.galaxyproject.org")]
+        )
+        notification_id = response["notification"]["id"]
+        response = self._get(f"notifications/broadcast/{notification_id}")
+        self._assert_status_code_is_ok(response)
+        notification = response.json()
+        assert "content" in notification
+        assert "action_links" in notification["content"]
+        assert len(notification["content"]["action_links"]) == 2
+        action_link = notification["content"]["action_links"][0]
+        assert action_link["action_name"] == "View Workflows"
+        assert action_link["link"] == "/workflows/list"
+        action_link = notification["content"]["action_links"][1]
+        assert action_link["action_name"] == "Go to GTN"
+        assert action_link["link"] == "https://training.galaxyproject.org"
+
     def test_sharing_items_creates_notifications_when_expected(self):
         user1 = self._create_test_user()
         user2 = self._create_test_user()
@@ -359,12 +379,17 @@ def _send_broadcast_notification(
         message: Optional[str] = None,
         publication_time: Optional[datetime] = None,
         expiration_time: Optional[datetime] = None,
+        action_links: Optional[List[Tuple[str, str]]] = None,
     ):
         payload = notification_broadcast_test_data()
         if subject is not None:
             payload["content"]["subject"] = subject
         if message is not None:
             payload["content"]["message"] = message
+        if action_links is not None:
+            payload["content"]["action_links"] = [
+                {"action_name": action_name, "link": link} for action_name, link in action_links
+            ]
         if publication_time is not None:
             payload["publication_time"] = publication_time.isoformat()
         if expiration_time is not None: