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,
@@ -175,13 +176,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,6 +198,9 @@ async def get_tracker_with_session_start(
         if not tracker:
             return None
 
+        if metadata:
+            tracker.events.append(SessionStarted(metadata=metadata))
+
         await self._update_tracker_session(tracker, output_channel)
 
         return tracker
@@ -233,7 +241,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:

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_metada(
+    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",
     [