Merge pull request galaxyproject#20957 from mvdbeek/landing_request_tracking

Allow sending and tracking landing request origin

Author: mvdbeek

client/src/api/schema/schema.ts

@@ -7913,6 +7913,8 @@ export interface components {
         CreateDataLandingPayload: {
             /** Client Secret */
             client_secret?: string | null;
+            /** Origin */
+            origin?: string | null;
             /**
              * Public
              * @default false
@@ -8362,6 +8364,11 @@ export interface components {
         CreateToolLandingRequestPayload: {
             /** Client Secret */
             client_secret?: string | null;
+            /**
+             * Origin
+             * @description The origin of the landing request.
+             */
+            origin?: string | null;
             /**
              * Public
              * @default false
@@ -8429,6 +8436,11 @@ export interface components {
         CreateWorkflowLandingRequestPayload: {
             /** Client Secret */
             client_secret?: string | null;
+            /**
+             * Origin
+             * @description The origin of the landing request.
+             */
+            origin?: string | null;
             /**
              * Public
              * @description If workflow landing request is public anyone with the uuid can use the landing request. If not public the request must be claimed before use and additional verification might occur.
@@ -20937,6 +20949,8 @@ export interface components {
         };
         /** ToolLandingRequest */
         ToolLandingRequest: {
+            /** Origin */
+            origin?: string | null;
             /** Request State */
             request_state?: {
                 [key: string]: unknown;
@@ -23085,6 +23099,8 @@ export interface components {
         };
         /** WorkflowLandingRequest */
         WorkflowLandingRequest: {
+            /** Origin */
+            origin?: string | null;
             /** Request State */
             request_state: {
                 [key: string]: unknown;

lib/galaxy/managers/landing.py

@@ -89,6 +89,7 @@ def create_tool_landing_request(self, payload: CreateToolLandingRequestPayload,
         model.uuid = uuid4()
         model.client_secret = payload.client_secret
         model.public = payload.public
+        model.origin = str(payload.origin) if payload.origin else None
         if user_id:
             model.user_id = user_id
         self._save(model)
@@ -194,6 +195,7 @@ def _tool_response(self, model: ToolLandingRequestModel) -> ToolLandingRequest:
             request_state=model.request_state,
             uuid=model.uuid,
             state=self._state(model),
+            origin=model.origin,
         )
         return response_model
 
@@ -216,6 +218,7 @@ def _workflow_response(self, model: WorkflowLandingRequestModel) -> WorkflowLand
             request_state=model.request_state,
             uuid=model.uuid,
             state=self._state(model),
+            origin=model.origin,
         )
         return response_model
 

lib/galaxy/model/__init__.py

@@ -11900,6 +11900,7 @@ class ToolLandingRequest(Base):
     request_state: Mapped[Optional[dict]] = mapped_column(JSONType)
     client_secret: Mapped[Optional[str]] = mapped_column(String(255), default=None)
     public: Mapped[bool] = mapped_column(Boolean)
+    origin: Mapped[Optional[str]] = mapped_column(String(255), default=None)
 
     user: Mapped[Optional["User"]] = relationship()
 
@@ -11925,6 +11926,7 @@ class WorkflowLandingRequest(Base):
     user: Mapped[Optional["User"]] = relationship()
     stored_workflow: Mapped[Optional["StoredWorkflow"]] = relationship()
     workflow: Mapped[Optional["Workflow"]] = relationship()
+    origin: Mapped[Optional[str]] = mapped_column(String(255), default=None)
 
 
 class UserAction(Base, RepresentById):

lib/galaxy/model/migrations/alembic/versions_gxy/81362686fd64_add_origin_column_to_landing_requests.py

@@ -0,0 +1,51 @@
+"""Add origin column to landing request tables
+
+Revision ID: 81362686fd64
+Revises: c0959ad462b2
+Create Date: 2025-09-26 12:39:25.000000
+
+"""
+
+import sqlalchemy as sa
+
+from galaxy.model.migrations.util import (
+    add_column,
+    drop_column,
+)
+
+# revision identifiers, used by Alembic.
+revision = "81362686fd64"
+down_revision = "c0959ad462b2"
+branch_labels = None
+depends_on = None
+
+# database object names used in this revision
+tool_table_name = "tool_landing_request"
+workflow_table_name = "workflow_landing_request"
+column_name = "origin"
+
+
+def upgrade():
+    # Add origin column to tool_landing_request table
+    column = sa.Column(
+        column_name,
+        sa.String(255),
+        nullable=True,
+        default=None,
+    )
+    add_column(tool_table_name, column)
+
+    # Add origin column to workflow_landing_request table
+    column = sa.Column(
+        column_name,
+        sa.String(255),
+        nullable=True,
+        default=None,
+    )
+    add_column(workflow_table_name, column)
+
+
+def downgrade():
+    # Drop origin column from both tables
+    drop_column(tool_table_name, column_name)
+    drop_column(workflow_table_name, column_name)

lib/galaxy/schema/fetch_data.py

@@ -12,6 +12,7 @@
     ConfigDict,
     Field,
     field_validator,
+    HttpUrl,
     Json,
     TypeAdapter,
 )
@@ -310,5 +311,6 @@ class CreateDataLandingPayload(Model):
     request_state: DataLandingRequestState
     client_secret: Optional[str] = None
     public: bool = False
+    origin: Optional[HttpUrl] = None
 
     model_config = ConfigDict(extra="forbid")

lib/galaxy/schema/schema.py

@@ -21,6 +21,7 @@
     BeforeValidator,
     ConfigDict,
     Field,
+    HttpUrl,
     Json,
     model_validator,
     RootModel,
@@ -4102,6 +4103,7 @@ class CreateToolLandingRequestPayload(Model):
     request_state: Optional[dict[str, Any]] = None
     client_secret: Optional[str] = None
     public: bool = False
+    origin: Optional[HttpUrl] = Field(None, description="The origin of the landing request.")
 
 
 class CreateWorkflowLandingRequestPayload(Model):
@@ -4113,6 +4115,7 @@ class CreateWorkflowLandingRequestPayload(Model):
         False,
         description="If workflow landing request is public anyone with the uuid can use the landing request. If not public the request must be claimed before use and additional verification might occur.",
     )
+    origin: Optional[HttpUrl] = Field(None, description="The origin of the landing request.")
 
 
 class ClaimLandingPayload(Model):
@@ -4125,6 +4128,7 @@ class ToolLandingRequest(Model):
     tool_version: Optional[str] = None
     request_state: Optional[dict[str, Any]] = None
     state: LandingRequestState
+    origin: Optional[HttpUrl] = None
 
 
 class WorkflowLandingRequest(Model):
@@ -4133,6 +4137,7 @@ class WorkflowLandingRequest(Model):
     workflow_target_type: Literal["stored_workflow", "workflow", "trs_url"]
     request_state: dict[str, Any]
     state: LandingRequestState
+    origin: Optional[HttpUrl] = None
 
 
 class MessageExceptionModel(BaseModel):

lib/galaxy_test/api/test_landing.py

@@ -3,6 +3,8 @@
     Any,
 )
 
+from pydantic import HttpUrl
+
 from galaxy.schema.fetch_data import (
     CreateDataLandingPayload,
     DataLandingRequestState,
@@ -39,13 +41,16 @@ def test_tool_landing(self):
             tool_id="create_2",
             tool_version=None,
             request_state={"sleep_time": 0},
+            origin=HttpUrl("http://example.localhost/"),
         )
         response = self.dataset_populator.create_tool_landing(request)
         assert response.tool_id == "create_2"
         assert response.state == "unclaimed"
+        assert str(response.origin) == "http://example.localhost/"
         response = self.dataset_populator.claim_tool_landing(response.uuid)
         assert response.tool_id == "create_2"
         assert response.state == "claimed"
+        assert str(response.origin) == "http://example.localhost/"
 
     @skip_without_tool("gx_int")
     def test_tool_landing_invalid(self):