Fixing bug if channel sends empty string for a null object (microsoft#1889)

axelsrz · tracyboehrer · web-flow · commit b11e029cb6b0 · 2022-01-31T08:20:55.000-06:00
Co-authored-by: tracyboehrer &lt;tracyboehrer@users.noreply.github.com&gt;
diff --git a/libraries/botbuilder-core/botbuilder/core/serializer_helper.py b/libraries/botbuilder-core/botbuilder/core/serializer_helper.py
@@ -1,6 +1,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
-
+from copy import copy
 from inspect import getmembers
 from typing import Type
 from enum import Enum
@@ -25,6 +25,9 @@
 
 def deserializer_helper(msrest_cls: Type[Model], dict_to_deserialize: dict) -> Model:
     deserializer = Deserializer(DEPENDICIES_DICT)
+    _clean_data_for_serialization(
+        deserializer.dependencies[msrest_cls.__name__], dict_to_deserialize
+    )
     return deserializer(msrest_cls.__name__, dict_to_deserialize)
 
 
@@ -35,3 +38,21 @@ def serializer_helper(object_to_serialize: Model) -> dict:
     serializer = Serializer(DEPENDICIES_DICT)
     # pylint: disable=protected-access
     return serializer._serialize(object_to_serialize)
+
+
+def _clean_data_for_serialization(msrest_cls: Type[Model], dict_to_deserialize: dict):
+    # pylint: disable=protected-access
+    # Clean channel response of empty strings for expected objects.
+    if not isinstance(dict_to_deserialize, dict):
+        return
+    serialization_model = copy(msrest_cls._attribute_map)
+    for key, value in msrest_cls._attribute_map.items():
+        if key != value["key"]:
+            serialization_model[value["key"]] = value
+    for prop, prop_value in dict_to_deserialize.items():
+        if (
+            prop in serialization_model
+            and serialization_model[prop]["type"] in DEPENDICIES_DICT
+            and not prop_value
+        ):
+            dict_to_deserialize[prop] = None
diff --git a/libraries/botbuilder-core/tests/teams/test_teams_activity_handler.py b/libraries/botbuilder-core/tests/teams/test_teams_activity_handler.py
@@ -1003,6 +1003,25 @@ async def test_on_teams_task_module_fetch(self):
         assert bot.record[0] == "on_invoke_activity"
         assert bot.record[1] == "on_teams_task_module_fetch"
 
+    async def test_on_teams_task_module_fetch_none_as_empty(self):
+        # Arrange
+        activity = Activity(
+            type=ActivityTypes.invoke,
+            name="task/fetch",
+            value={"data": {"key": "value"}, "context": "",},
+        )
+
+        turn_context = TurnContext(SimpleAdapter(), activity)
+
+        # Act
+        bot = TestingTeamsActivityHandler()
+        await bot.on_turn(turn_context)
+
+        # Assert
+        assert len(bot.record) == 2
+        assert bot.record[0] == "on_invoke_activity"
+        assert bot.record[1] == "on_teams_task_module_fetch"
+
     async def test_on_teams_task_module_submit(self):
         # Arrange
         activity = Activity(
