Merge pull request #6055 from IzidoroBaltazar/conversation-id-viber

[FEATURE] modify conversation id of server to accomodate viber id

changelog/6055.improvement.rst

@@ -0,0 +1 @@
+Support for rasa conversation id with special characters on the server side - necessary for some channels (e.g. Viber)

rasa/server.py

@@ -460,7 +460,7 @@ async def status(request: Request):
             }
         )
 
-    @app.get("/conversations/<conversation_id>/tracker")
+    @app.get("/conversations/<conversation_id:path>/tracker")
     @requires_auth(app, auth_token)
     @ensure_loaded_agent(app)
     async def retrieve_tracker(request: Request, conversation_id: Text):
@@ -483,7 +483,7 @@ async def retrieve_tracker(request: Request, conversation_id: Text):
                 500, "ConversationError", f"An unexpected error occurred. Error: {e}"
             )
 
-    @app.post("/conversations/<conversation_id>/tracker/events")
+    @app.post("/conversations/<conversation_id:path>/tracker/events")
     @requires_auth(app, auth_token)
     @ensure_loaded_agent(app)
     async def append_events(request: Request, conversation_id: Text):
@@ -538,7 +538,7 @@ def _get_events_from_request_body(request: Request) -> List[Event]:
 
         return events
 
-    @app.put("/conversations/<conversation_id>/tracker/events")
+    @app.put("/conversations/<conversation_id:path>/tracker/events")
     @requires_auth(app, auth_token)
     @ensure_loaded_agent(app)
     async def replace_events(request: Request, conversation_id: Text):
@@ -567,7 +567,7 @@ async def replace_events(request: Request, conversation_id: Text):
                 500, "ConversationError", f"An unexpected error occurred. Error: {e}"
             )
 
-    @app.get("/conversations/<conversation_id>/story")
+    @app.get("/conversations/<conversation_id:path>/story")
     @requires_auth(app, auth_token)
     @ensure_loaded_agent(app)
     async def retrieve_story(request: Request, conversation_id: Text):
@@ -591,7 +591,7 @@ async def retrieve_story(request: Request, conversation_id: Text):
                 500, "ConversationError", f"An unexpected error occurred. Error: {e}"
             )
 
-    @app.post("/conversations/<conversation_id>/execute")
+    @app.post("/conversations/<conversation_id:path>/execute")
     @requires_auth(app, auth_token)
     @ensure_loaded_agent(app)
     async def execute_action(request: Request, conversation_id: Text):
@@ -641,7 +641,7 @@ async def execute_action(request: Request, conversation_id: Text):
 
         return response.json(response_body)
 
-    @app.post("/conversations/<conversation_id>/trigger_intent")
+    @app.post("/conversations/<conversation_id:path>/trigger_intent")
     @requires_auth(app, auth_token)
     @ensure_loaded_agent(app)
     async def trigger_intent(request: Request, conversation_id: Text) -> HTTPResponse:
@@ -695,7 +695,7 @@ async def trigger_intent(request: Request, conversation_id: Text) -> HTTPRespons
 
         return response.json(response_body)
 
-    @app.post("/conversations/<conversation_id>/predict")
+    @app.post("/conversations/<conversation_id:path>/predict")
     @requires_auth(app, auth_token)
     @ensure_loaded_agent(app)
     async def predict(request: Request, conversation_id: Text) -> HTTPResponse:
@@ -712,7 +712,7 @@ async def predict(request: Request, conversation_id: Text) -> HTTPResponse:
                 500, "ConversationError", f"An unexpected error occurred. Error: {e}"
             )
 
-    @app.post("/conversations/<conversation_id>/messages")
+    @app.post("/conversations/<conversation_id:path>/messages")
     @requires_auth(app, auth_token)
     @ensure_loaded_agent(app)
     async def add_message(request: Request, conversation_id: Text):

tests/test_server.py

@@ -889,6 +889,29 @@ def test_push_multiple_events(rasa_app: SanicTestClient):
     assert tracker.get("events") == events
 
 
+def test_post_conversation_id_with_slash(rasa_app: SanicTestClient):
+    conversation_id = str(uuid.uuid1())
+    id_len = len(conversation_id) // 2
+    conversation_id = conversation_id[:id_len] + "/+-_\\=" + conversation_id[id_len:]
+    conversation = f"/conversations/{conversation_id}"
+
+    events = [e.as_dict() for e in test_events]
+    _, response = rasa_app.post(
+        f"{conversation}/tracker/events",
+        json=events,
+        headers={"Content-Type": "application/json"},
+    )
+    assert response.json is not None
+    assert response.status == 200
+
+    _, tracker_response = rasa_app.get(f"/conversations/{conversation_id}/tracker")
+    tracker = tracker_response.json
+    assert tracker is not None
+
+    # there is also an `ACTION_LISTEN` event at the start
+    assert tracker.get("events") == events
+
+
 def test_put_tracker(rasa_app: SanicTestClient):
     data = [event.as_dict() for event in test_events]
     _, response = rasa_app.put(