Skip to content

Commit

Permalink
Implement long running message (#227)
Browse files Browse the repository at this point in the history 
For #219
Bot Builder .NET SDK supports passing `Activity` to
`ContinueConversationAsync`, so no need to explicitly copy original
activity.
  • Loading branch information
@swatDong
swatDong authored Jul 7, 2023
1 parent 401d9fb commit cd540a5
Show file tree
Hide file tree
Showing 4 changed files with 208 additions and 81 deletions.
2 changes: 1 addition & 1 deletion dotnet/packages/.editorconfig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,10 @@ dotnet_diagnostic.CS1591.severity = warning # Missing XML comment for publicly v

dotnet_diagnostic.IDE0001.severity = warning # Simplify name
dotnet_diagnostic.IDE0002.severity = warning # Simplify member access
dotnet_diagnostic.IDE0003.severity = warning # Remove this or Me qualification
dotnet_diagnostic.IDE0004.severity = warning # Remove unnecessary cast
dotnet_diagnostic.IDE0005.severity = warning # Remove unnecessary using directives
dotnet_diagnostic.IDE0008.severity = warning # Use explicit type instead of var
dotnet_diagnostic.IDE0009.severity = warning # Add this or Me qualification
dotnet_diagnostic.IDE0011.severity = warning # Add braces
dotnet_diagnostic.IDE0018.severity = warning # Inline variable declaration
dotnet_diagnostic.IDE0032.severity = warning # Use auto-implemented property
Expand Down
106 changes: 97 additions & 9 deletions ...uilder.M365/Microsoft.Bot.Builder.M365.Tests/ActivityHandlerTests/ActivityHandlerTests.cs
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using Microsoft.Bot.Builder.Integration.AspNet.Core;
using Microsoft.Bot.Connector;
using Microsoft.Bot.Connector.Authentication;
using Microsoft.Bot.Schema;
using Microsoft.Bot.Schema.Teams;
using Moq;
using Newtonsoft.Json.Linq;
using Microsoft.Bot.Builder.M365.Tests.TestUtils;
using Microsoft.Bot.Schema.Teams;
using Microsoft.Rest.Serialization;
using Newtonsoft.Json.Serialization;
using Newtonsoft.Json;

namespace Microsoft.Bot.Builder.M365.Tests.ActivityHandlerTests
{
Expand Down Expand Up @@ -493,7 +490,7 @@ public async Task Test_EventActivity_MeetingStartEvent()
Value = JObject.Parse(@"{""StartTime"":""2021-06-05T00:01:02.0Z""}"),
};

Activity[] activitiesToSend = null;
Activity[]? activitiesToSend = null;
void CaptureSend(Activity[] arg)
{
activitiesToSend = arg;
Expand Down Expand Up @@ -527,7 +524,7 @@ public async Task Test_EventActivity_MeetingEndEvent()
Value = JObject.Parse(@"{""EndTime"":""2021-06-05T01:02:03.0Z""}"),
};

Activity[] activitiesToSend = null;
Activity[]? activitiesToSend = null;
void CaptureSend(Activity[] arg)
{
activitiesToSend = arg;
Expand Down Expand Up @@ -562,7 +559,7 @@ public async Task Test_EventActivity_ReadReceiptEvent()
Value = JObject.Parse(@"{""lastReadMessageId"":""10101010""}"),
};

Activity[] activitiesToSend = null;
Activity[]? activitiesToSend = null;
void CaptureSend(Activity[] arg)
{
activitiesToSend = arg;
Expand Down Expand Up @@ -681,7 +678,7 @@ public async Task TestDelegatingTurnContext()
// Arrange
var turnContextMock = new Mock<ITurnContext>();
turnContextMock.Setup(tc => tc.Activity).Returns(new Activity { Type = ActivityTypes.Message });
turnContextMock.Setup(tc => tc.Adapter).Returns(new BotFrameworkAdapter(new SimpleCredentialProvider()));
turnContextMock.Setup(tc => tc.Adapter).Returns(new CloudAdapter());
turnContextMock.Setup(tc => tc.TurnState).Returns(new TurnContextStateCollection());
turnContextMock.Setup(tc => tc.Responded).Returns(false);
turnContextMock.Setup(tc => tc.OnDeleteActivity(It.IsAny<DeleteActivityHandler>()));
Expand Down Expand Up @@ -710,5 +707,96 @@ public async Task TestDelegatingTurnContext()
turnContextMock.Verify(tc => tc.DeleteActivityAsync(It.IsAny<ConversationReference>(), It.IsAny<CancellationToken>()), Times.Once);
turnContextMock.Verify(tc => tc.UpdateActivityAsync(It.IsAny<IActivity>(), It.IsAny<CancellationToken>()), Times.Once);
}

[Fact]
public async Task Test_OnTurnAsync_Disable_LongRunningMessages()
{
// Arrange
var activity = MessageFactory.Text("hello");
var turnContext = new TurnContext(new NotImplementedAdapter(), activity);

// Act
var bot = new TestActivityHandler(new ApplicationOptions<TurnState>
{
LongRunningMessages = false,
StartTypingTimer = false,
RemoveRecipientMention = false
});
await bot.OnTurnAsync(turnContext, default);

// Assert
Assert.Single(bot.Record);
Assert.Equal("OnMessageActivityAsync", bot.Record[0]);
}

[Fact]
public void Test_OnTurnAsync_Enable_LongRunningMessages_Without_Adapter_ShouldThrow()
{
// Arrange
var activity = MessageFactory.Text("hello");
var turnContext = new TurnContext(new NotImplementedAdapter(), activity);

// Act
var exception = Assert.Throws<Exception>(() => new TestActivityHandler(new ApplicationOptions<TurnState>
{
LongRunningMessages = true,
StartTypingTimer = false,
RemoveRecipientMention = false
}));

// Assert
Assert.NotNull(exception);
Assert.Equal("The ApplicationOptions.LongRunningMessages property is unavailable because no adapter or botAppId was configured.", exception.Message);
}

[Fact]
public async Task Test_OnTurnAsync_Enable_LongRunningMessages_Message_Activity()
{
// Arrange
var activity = MessageFactory.Text("hello");
var turnContext = new TurnContext(new NotImplementedAdapter(), activity);
var adapterMock = new Mock<BotAdapter>();
adapterMock.Setup(adapter => adapter.ContinueConversationAsync(It.IsAny<string>(), It.IsAny<Activity>(), It.IsAny<BotCallbackHandler>(), It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);

// Act
var bot = new TestActivityHandler(new ApplicationOptions<TurnState>
{
Adapter = adapterMock.Object,
BotAppId = "test-bot-app-id",
LongRunningMessages = true,
StartTypingTimer = false,
RemoveRecipientMention = false,
});
await bot.OnTurnAsync(turnContext, default);

// Assert
adapterMock.Verify(adapter => adapter.ContinueConversationAsync(It.IsAny<string>(), It.IsAny<Activity>(), It.IsAny<BotCallbackHandler>(), It.IsAny<CancellationToken>()), Times.Once);
}

[Fact]
public async Task Test_OnTurnAsync_Enable_LongRunningMessages_NonMessage_Activity()
{
// Arrange
var activity = new Activity { Type = ActivityTypes.MessageUpdate };
var turnContext = new TurnContext(new NotImplementedAdapter(), activity);
var adapterMock = new Mock<BotAdapter>();
adapterMock.Setup(adapter => adapter.ContinueConversationAsync(It.IsAny<string>(), It.IsAny<Activity>(), It.IsAny<BotCallbackHandler>(), It.IsAny<CancellationToken>())).Returns(Task.CompletedTask);

// Act
var bot = new TestActivityHandler(new ApplicationOptions<TurnState>
{
Adapter = adapterMock.Object,
BotAppId = "test-bot-app-id",
LongRunningMessages = true,
StartTypingTimer = false,
RemoveRecipientMention = false,
});
await bot.OnTurnAsync(turnContext, default);

// Assert
adapterMock.Verify(adapter => adapter.ContinueConversationAsync(It.IsAny<string>(), It.IsAny<Activity>(), It.IsAny<BotCallbackHandler>(), It.IsAny<CancellationToken>()), Times.Never);
Assert.Single(bot.Record);
Assert.Equal("OnMessageUpdateActivityAsync", bot.Record[0]);
}
}
}
Loading

0 comments on commit cd540a5

Please sign in to comment.