Changed on_process_request for on_turn in middleware (#298)

Author: axelsrz

libraries/botbuilder-core/botbuilder/core/auto_save_state_middleware.py

@@ -22,7 +22,7 @@ def add(self, bot_state: BotState) -> "AutoSaveStateMiddleware":
         self.bot_state_set.add(bot_state)
         return self
 
-    async def on_process_request(
+    async def on_turn(
         self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
     ):
         await logic()

libraries/botbuilder-core/botbuilder/core/middleware_set.py

@@ -10,7 +10,7 @@
 
 class Middleware(ABC):
     @abstractmethod
-    async def on_process_request(
+    async def on_turn(
         self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
     ):
         pass
@@ -24,9 +24,7 @@ def __init__(self, anonymous_handler):
             )
         self._to_call = anonymous_handler
 
-    def on_process_request(
-        self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
-    ):
+    def on_turn(self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]):
         return self._to_call(context, logic)
 
 
@@ -48,7 +46,7 @@ def use(self, *middleware: Middleware):
         :return:
         """
         for (idx, mid) in enumerate(middleware):
-            if hasattr(mid, "on_process_request") and callable(mid.on_process_request):
+            if hasattr(mid, "on_turn") and callable(mid.on_turn):
                 self._middleware.append(mid)
                 return self
             raise TypeError(
@@ -59,7 +57,7 @@ def use(self, *middleware: Middleware):
     async def receive_activity(self, context: TurnContext):
         await self.receive_activity_internal(context, None)
 
-    async def on_process_request(
+    async def on_turn(
         self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
     ):
         await self.receive_activity_internal(context, None)
@@ -88,8 +86,6 @@ async def call_next_middleware():
             )
 
         try:
-            return await next_middleware.on_process_request(
-                context, call_next_middleware
-            )
+            return await next_middleware.on_turn(context, call_next_middleware)
         except Exception as error:
             raise error

libraries/botbuilder-core/botbuilder/core/show_typing_middleware.py

@@ -49,7 +49,7 @@ def __init__(self, delay: float = 0.5, period: float = 2.0):
         self._delay = delay
         self._period = period
 
-    async def on_process_request(
+    async def on_turn(
         self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
     ):
         finished = False

libraries/botbuilder-core/botbuilder/core/telemetry_logger_middleware.py

@@ -36,7 +36,7 @@ def log_personal_information(self) -> bool:
         return self._log_personal_information
 
     # pylint: disable=arguments-differ
-    async def on_process_request(
+    async def on_turn(
         self, context: TurnContext, logic_fn: Callable[[TurnContext], Awaitable]
     ) -> None:
         """Logs events based on incoming and outgoing activities using

libraries/botbuilder-core/botbuilder/core/transcript_logger.py

@@ -33,7 +33,7 @@ def __init__(self, logger: TranscriptLogger):
             )
         self.logger = logger
 
-    async def on_process_request(
+    async def on_turn(
         self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
     ):
         """Initialization for middleware.

libraries/botbuilder-core/tests/call_counting_middleware.py

@@ -9,7 +9,7 @@ class CallCountingMiddleware(Middleware):
     def __init__(self):
         self.counter = 0
 
-    def on_process_request(  # pylint: disable=unused-argument
+    def on_turn(  # pylint: disable=unused-argument
         self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
     ):
         self.counter += 1

libraries/botbuilder-core/tests/test_auto_save_middleware.py

@@ -95,15 +95,15 @@ async def test_should_work_as_a_middleware_plugin(self):
         context = TurnContext(adapter, Activity())
         foo_state = BotStateMock({"foo": "bar"})
         autosave_middleware = AutoSaveStateMiddleware().add(foo_state)
-        await autosave_middleware.on_process_request(context, aux_func)
+        await autosave_middleware.on_turn(context, aux_func)
         assert foo_state.write_called, "save_all_changes() not called."
 
     async def test_should_support_plugins_passed_to_constructor(self):
         adapter = TestAdapter()
         context = TurnContext(adapter, Activity())
         foo_state = BotStateMock({"foo": "bar"})
         autosave_middleware = AutoSaveStateMiddleware().add(foo_state)
-        await autosave_middleware.on_process_request(context, aux_func)
+        await autosave_middleware.on_turn(context, aux_func)
         assert foo_state.write_called, "save_all_changes() not called."
 
     async def test_should_not_add_any_bot_state_on_construction_if_none_are_passed_in(

libraries/botbuilder-core/tests/test_middleware_set.py

@@ -34,12 +34,12 @@ async def runs_after_pipeline(context):
 
     async def test_middleware_set_receive_activity_internal(self):
         class PrintMiddleware:
-            async def on_process_request(self, context_or_string, next_middleware):
+            async def on_turn(self, context_or_string, next_middleware):
                 print("PrintMiddleware says: %s." % context_or_string)
                 return next_middleware
 
         class ModifyInputMiddleware(Middleware):
-            async def on_process_request(
+            async def on_turn(
                 self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
             ):
                 context = "Hello"
@@ -61,14 +61,14 @@ async def test_middleware_run_in_order(self):
         called_second = False
 
         class FirstMiddleware(Middleware):
-            async def on_process_request(self, context, logic):
+            async def on_turn(self, context, logic):
                 nonlocal called_first, called_second
                 assert called_second is False
                 called_first = True
                 return await logic()
 
         class SecondMiddleware(Middleware):
-            async def on_process_request(self, context, logic):
+            async def on_turn(self, context, logic):
                 nonlocal called_first, called_second
                 assert called_first
                 called_second = True
@@ -85,7 +85,7 @@ async def test_run_one_middleware(self):
         finished_pipeline = False
 
         class FirstMiddleware(Middleware):
-            async def on_process_request(self, context, logic):
+            async def on_turn(self, context, logic):
                 nonlocal called_first
                 called_first = True
                 return await logic()
@@ -120,14 +120,14 @@ async def test_two_middleware_one_does_not_call_next(self):
         class FirstMiddleware(Middleware):
             """First Middleware, does not call next."""
 
-            async def on_process_request(self, context, logic):
+            async def on_turn(self, context, logic):
                 nonlocal called_first, called_second
                 assert called_second is False
                 called_first = True
                 return
 
         class SecondMiddleware(Middleware):
-            async def on_process_request(self, context, logic):
+            async def on_turn(self, context, logic):
                 nonlocal called_all_middleware
                 called_all_middleware = True
                 return await logic()
@@ -144,7 +144,7 @@ async def test_one_middleware_does_not_call_next(self):
         finished_pipeline = False
 
         class FirstMiddleware(Middleware):
-            async def on_process_request(self, context, logic):
+            async def on_turn(self, context, logic):
                 nonlocal called_first
                 called_first = True
                 return
@@ -207,7 +207,7 @@ async def test_mixed_middleware_anonymous_first(self):
         middleware_set = MiddlewareSet()
 
         class MyFirstMiddleware(Middleware):
-            async def on_process_request(self, context, logic):
+            async def on_turn(self, context, logic):
                 nonlocal called_regular_middleware, called_anonymous_middleware
                 assert called_anonymous_middleware
                 called_regular_middleware = True
@@ -233,7 +233,7 @@ async def test_mixed_middleware_anonymous_last(self):
         middleware_set = MiddlewareSet()
 
         class MyFirstMiddleware(Middleware):
-            async def on_process_request(self, context, logic):
+            async def on_turn(self, context, logic):
                 nonlocal called_regular_middleware, called_anonymous_middleware
                 assert not called_anonymous_middleware
                 called_regular_middleware = True