Added AutoSaveStateMiddlewareTests

2019-09-12 16:49:26 -05:00 · 2019-09-12 16:49:26 -05:00 · ced566f672
--- a/libraries/bot-builder/src/main/java/com/microsoft/bot/builder/BotFrameworkAdapter.java
+++ b/libraries/bot-builder/src/main/java/com/microsoft/bot/builder/BotFrameworkAdapter.java
@ -208,7 +208,7 @@ public class BotFrameworkAdapter extends BotAdapter {

            // Handle Invoke scenarios, which deviate from the request/response model in that
            // the Bot will return a specific body and return code.
-            if (activity.getType() == ActivityTypes.INVOKE) {
+            if (StringUtils.equals(activity.getType(), ActivityTypes.INVOKE)) {
                Activity invokeResponse = context.getTurnState().get(InvokeReponseKey);
                if (invokeResponse == null) {
                    // ToDo: Trace Here
@ -273,7 +273,7 @@ public class BotFrameworkAdapter extends BotAdapter {
            {
                context.getTurnState().add(InvokeReponseKey, activity);
                // No need to create a response. One will be created below.
-            } else if (activity.getType() == ActivityTypes.TRACE && !activity.getChannelId().equals("emulator")) {
+            } else if (StringUtils.equals(activity.getType(), ActivityTypes.TRACE) && !activity.getChannelId().equals("emulator")) {
                // if it is a Trace activity we only send to the channel if it's the emulator.
            } else if (!StringUtils.isEmpty(activity.getReplyToId())) {
                ConnectorClient connectorClient = context.getTurnState().get("ConnectorClient");
--- a/libraries/bot-builder/src/main/java/com/microsoft/bot/builder/SkypeMentionNormalizeMiddleware.java
+++ b/libraries/bot-builder/src/main/java/com/microsoft/bot/builder/SkypeMentionNormalizeMiddleware.java
@ -26,7 +26,7 @@ import java.util.concurrent.CompletableFuture;
 public class SkypeMentionNormalizeMiddleware implements Middleware {
    public static void normalizeSkypMentionText(Activity activity) {
        if (StringUtils.equals(activity.getChannelId(), Channels.SKYPE)
-            && activity.getType() == ActivityTypes.MESSAGE) {
+            && StringUtils.equals(activity.getType(), ActivityTypes.MESSAGE)) {

            for (Entity entity : activity.getEntities()) {
                if (StringUtils.equals(entity.getType(), "mention")) {
--- a/libraries/bot-builder/src/main/java/com/microsoft/bot/builder/inspection/InspectionMiddleware.java
+++ b/libraries/bot-builder/src/main/java/com/microsoft/bot/builder/inspection/InspectionMiddleware.java
@ -49,7 +49,7 @@ public class InspectionMiddleware extends InterceptionMiddleware {
    }

    public CompletableFuture<Boolean> processCommand(TurnContext turnContext) {
-        if (turnContext.getActivity().getType() != ActivityTypes.MESSAGE
+        if (!StringUtils.equals(turnContext.getActivity().getType(), ActivityTypes.MESSAGE)
            || StringUtils.isEmpty(turnContext.getActivity().getText())) {

            return CompletableFuture.completedFuture(false);
--- a/libraries/bot-builder/src/test/java/com/microsoft/bot/builder/AutoSaveStateMiddlewareTests.java
+++ b/libraries/bot-builder/src/test/java/com/microsoft/bot/builder/AutoSaveStateMiddlewareTests.java
@ -0,0 +1,163 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.bot.builder;
+
+import com.microsoft.bot.builder.adapters.TestAdapter;
+import com.microsoft.bot.builder.adapters.TestFlow;
+import com.microsoft.bot.schema.ActivityTypes;
+import com.microsoft.bot.schema.ChannelAccount;
+import com.microsoft.bot.schema.ConversationAccount;
+import com.microsoft.bot.schema.ConversationReference;
+import org.apache.commons.lang3.StringUtils;
+import org.junit.Test;
+
+import java.util.concurrent.CompletableFuture;
+
+public class AutoSaveStateMiddlewareTests {
+    @Test
+    public void AutoSaveStateMiddleware_DualReadWrite() {
+        Storage storage = new MemoryStorage();
+
+        // setup userstate
+        UserState userState = new UserState(storage);
+        StatePropertyAccessor<Integer> userProperty = userState.createProperty("userCount");
+
+        // setup convState
+        ConversationState convState = new ConversationState(storage);
+        StatePropertyAccessor<Integer> convProperty = userState.createProperty("convCount");
+
+        TestAdapter adapter = new TestAdapter().use(new AutoSaveStateMiddleware(userState, convState));
+
+        final int USER_INITIAL_COUNT = 100;
+        final int CONVERSATION_INITIAL_COUNT = 10;
+
+        BotCallbackHandler botLogic = (turnContext -> {
+            Integer userCount = userProperty.get(turnContext, () -> USER_INITIAL_COUNT).join();
+            Integer convCount = convProperty.get(turnContext, () -> CONVERSATION_INITIAL_COUNT).join();
+
+            if(turnContext.getActivity().isType(ActivityTypes.MESSAGE)) {
+                if (StringUtils.equals(turnContext.getActivity().getText(), "get userCount")) {
+                    turnContext.sendActivity(turnContext.getActivity().createReply(userCount.toString()));
+                }
+                else if (StringUtils.equals(turnContext.getActivity().getText(), "get convCount")) {
+                    turnContext.sendActivity(turnContext.getActivity().createReply(convCount.toString()));
+                }
+            }
+
+            // increment userCount and set property using accessor.  To be saved later by AutoSaveStateMiddleware
+            userCount++;
+            userProperty.set(turnContext, userCount);
+
+            // increment convCount and set property using accessor.  To be saved later by AutoSaveStateMiddleware
+            convCount++;
+            convProperty.set(turnContext, convCount);
+
+            return CompletableFuture.completedFuture(null);
+        });
+
+        new TestFlow(adapter, botLogic)
+            .send("test1")
+            .send("get userCount")
+            .assertReply(String.format("%d", USER_INITIAL_COUNT + 1))
+            .send("get userCount")
+            .assertReply(String.format("%d", USER_INITIAL_COUNT + 2))
+            .send("get convCount")
+            .assertReply(String.format("%d", CONVERSATION_INITIAL_COUNT + 1))
+            .startTest();
+
+        adapter = new TestAdapter(new ConversationReference(){{
+            setChannelId("test");
+            setServiceUrl("https://test.com");
+            setUser(new ChannelAccount("user1", "User1"));
+            setBot(new ChannelAccount("bot", "Bot"));
+            setConversation(new ConversationAccount(false, "convo2", "Conversation2"));
+        }}).use(new AutoSaveStateMiddleware(userState, convState));
+
+        new TestFlow(adapter, botLogic)
+            .send("get userCount")
+            .assertReply(String.format("%d", USER_INITIAL_COUNT + 4))
+            .send("get convCount")
+            .assertReply(String.format("%d", CONVERSATION_INITIAL_COUNT + 1))
+            .startTest();
+    }
+
+    @Test
+    public void AutoSaveStateMiddleware_Chain() {
+        Storage storage = new MemoryStorage();
+
+        // setup userstate
+        UserState userState = new UserState(storage);
+        StatePropertyAccessor<Integer> userProperty = userState.createProperty("userCount");
+
+        // setup convState
+        ConversationState convState = new ConversationState(storage);
+        StatePropertyAccessor<Integer> convProperty = userState.createProperty("convCount");
+
+        AutoSaveStateMiddleware bss = new AutoSaveStateMiddleware(){{
+           add(userState);
+           add(convState);
+        }};
+
+        TestAdapter adapter = new TestAdapter().use(bss);
+
+        final int USER_INITIAL_COUNT = 100;
+        final int CONVERSATION_INITIAL_COUNT = 10;
+
+        BotCallbackHandler botLogic = (turnContext -> {
+            Integer userCount = userProperty.get(turnContext, () -> USER_INITIAL_COUNT).join();
+            Integer convCount = convProperty.get(turnContext, () -> CONVERSATION_INITIAL_COUNT).join();
+
+            if(turnContext.getActivity().isType(ActivityTypes.MESSAGE)) {
+                if (StringUtils.equals(turnContext.getActivity().getText(), "get userCount")) {
+                    turnContext.sendActivity(turnContext.getActivity().createReply(userCount.toString()));
+                }
+                else if (StringUtils.equals(turnContext.getActivity().getText(), "get convCount")) {
+                    turnContext.sendActivity(turnContext.getActivity().createReply(convCount.toString()));
+                }
+            }
+
+            // increment userCount and set property using accessor.  To be saved later by AutoSaveStateMiddleware
+            userCount++;
+            userProperty.set(turnContext, userCount);
+
+            // increment convCount and set property using accessor.  To be saved later by AutoSaveStateMiddleware
+            convCount++;
+            convProperty.set(turnContext, convCount);
+
+            return CompletableFuture.completedFuture(null);
+        });
+
+        new TestFlow(adapter, botLogic)
+            .send("test1")
+            .send("get userCount")
+            .assertReply(String.format("%d", USER_INITIAL_COUNT + 1))
+            .send("get userCount")
+            .assertReply(String.format("%d", USER_INITIAL_COUNT + 2))
+            .send("get convCount")
+            .assertReply(String.format("%d", CONVERSATION_INITIAL_COUNT + 3))
+            .startTest();
+
+        // new adapter on new conversation
+        AutoSaveStateMiddleware bss2 = new AutoSaveStateMiddleware(){{
+            add(userState);
+            add(convState);
+        }};
+
+        adapter = new TestAdapter(new ConversationReference(){{
+            setChannelId("test");
+            setServiceUrl("https://test.com");
+            setUser(new ChannelAccount("user1", "User1"));
+            setBot(new ChannelAccount("bot", "Bot"));
+            setConversation(new ConversationAccount(false, "convo2", "Conversation2"));
+        }}).use(bss2);
+
+        new TestFlow(adapter, botLogic)
+            .send("get userCount")
+            .assertReply(String.format("%d", USER_INITIAL_COUNT + 4))
+            .send("get convCount")
+            .assertReply(String.format("%d", CONVERSATION_INITIAL_COUNT + 1))
+            .startTest();
+    }
+
+}
--- a/libraries/bot-schema/src/main/java/com/microsoft/bot/schema/Activity.java
+++ b/libraries/bot-schema/src/main/java/com/microsoft/bot/schema/Activity.java
@ -469,6 +469,10 @@ public class Activity {
        this.type = withType;
    }

+    public boolean isType(String compareTo) {
+        return StringUtils.equals(type, compareTo);
+    }
+
    /**
     * @see #id
     */