Metada on session start action

changelog/5574.bugfix.rst

@@ -0,0 +1 @@
+Fixed issue where metadata was not being sent with the tracker from session_start event when calling action server.

rasa/core/processor.py

@@ -36,6 +36,7 @@
     ReminderScheduled,
     SlotSet,
     UserUttered,
+    SessionStarted,
 )
 from rasa.core.interpreter import (
     INTENT_MESSAGE_PREFIX,
@@ -149,7 +150,10 @@ async def predict_next(self, sender_id: Text) -> Optional[Dict[Text, Any]]:
         }
 
     async def _update_tracker_session(
-        self, tracker: DialogueStateTracker, output_channel: OutputChannel
+        self,
+        tracker: DialogueStateTracker,
+        output_channel: OutputChannel,
+        metadata: Optional[Dict] = None,
     ) -> None:
         """Check the current session in `tracker` and update it if expired.
 
@@ -158,6 +162,7 @@ async def _update_tracker_session(
         restart are considered).
 
         Args:
+            metadata: Data sent from client associated with the incoming user message.
             tracker: Tracker to inspect.
             output_channel: Output channel for potential utterances in a custom
                 `ActionSessionStart`.
@@ -167,6 +172,9 @@ async def _update_tracker_session(
                 f"Starting a new session for conversation ID '{tracker.sender_id}'."
             )
 
+            if metadata:
+                tracker.events.append(SessionStarted(metadata=metadata))
+
             await self._run_action(
                 action=self._get_action(ACTION_SESSION_START_NAME),
                 tracker=tracker,
@@ -175,13 +183,17 @@ async def _update_tracker_session(
             )
 
     async def get_tracker_with_session_start(
-        self, sender_id: Text, output_channel: Optional[OutputChannel] = None
+        self,
+        sender_id: Text,
+        output_channel: Optional[OutputChannel] = None,
+        metadata: Optional[Dict] = None,
     ) -> Optional[DialogueStateTracker]:
         """Get tracker for `sender_id` or create a new tracker for `sender_id`.
 
         If a new tracker is created, `action_session_start` is run.
 
         Args:
+            metadata: Data sent from client associated with the incoming user message.
             output_channel: Output channel associated with the incoming user message.
             sender_id: Conversation ID for which to fetch the tracker.
 
@@ -193,7 +205,7 @@ async def get_tracker_with_session_start(
         if not tracker:
             return None
 
-        await self._update_tracker_session(tracker, output_channel)
+        await self._update_tracker_session(tracker, output_channel, metadata)
 
         return tracker
 
@@ -233,7 +245,7 @@ async def log_message(
         # we have a Tracker instance for each user
         # which maintains conversation state
         tracker = await self.get_tracker_with_session_start(
-            message.sender_id, message.output_channel
+            message.sender_id, message.output_channel, message.metadata
         )
 
         if tracker:
@@ -291,10 +303,12 @@ def predict_next_action(
         action = self.domain.action_for_index(
             max_confidence_index, self.action_endpoint
         )
+
         logger.debug(
             f"Predicted next action '{action.name()}' with confidence "
             f"{action_confidences[max_confidence_index]:.2f}."
         )
+
         return action, policy, action_confidences[max_confidence_index]
 
     @staticmethod

tests/core/test_actions.py

@@ -510,6 +510,21 @@ async def test_action_session_start_without_slots(
     assert events == [SessionStarted(), ActionExecuted(ACTION_LISTEN_NAME)]
 
 
+async def test_action_session_start_with_metadata(
+    default_channel: CollectingOutputChannel,
+    template_nlg: TemplatedNaturalLanguageGenerator,
+    template_sender_tracker: DialogueStateTracker,
+    default_domain: Domain,
+):
+    template_sender_tracker.events.append(
+        SessionStarted(metadata={"metadataTestKey": "metadataTestValue"})
+    )
+
+    await test_action_session_start_without_slots(
+        default_channel, template_nlg, template_sender_tracker, default_domain
+    )
+
+
 @pytest.mark.parametrize(
     "session_config, expected_events",
     [

tests/core/test_processor.py

@@ -485,6 +485,34 @@ async def test_update_tracker_session(
     ]
 
 
+# noinspection PyProtectedMember
+async def test_update_tracker_session_with_metadata(
+    default_channel: CollectingOutputChannel,
+    default_processor: MessageProcessor,
+    monkeypatch: MonkeyPatch,
+):
+    sender_id = uuid.uuid4().hex
+    tracker = default_processor.tracker_store.get_or_create_tracker(sender_id)
+
+    # patch `_has_session_expired()` so the `_update_tracker_session()` call actually
+    # does something
+    monkeypatch.setattr(default_processor, "_has_session_expired", lambda _: True)
+
+    metadata = {"metadataTestKey": "metadataTestValue"}
+
+    await default_processor._update_tracker_session(tracker, default_channel, metadata)
+
+    # the save is not called in _update_tracker_session()
+    default_processor._save_tracker(tracker)
+
+    # inspect tracker events and make sure SessionStarted event is present and has metadata.
+    tracker = default_processor.tracker_store.retrieve(sender_id)
+    session_event_idx = tracker.events.index(SessionStarted())
+    session_event_metadata = tracker.events[session_event_idx].metadata
+
+    assert metadata == session_event_metadata
+
+
 # noinspection PyProtectedMember
 async def test_update_tracker_session_with_slots(
     default_channel: CollectingOutputChannel,