From 9461a082c55a672ee05fe0a9346634d84ad10df3 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Tue, 9 Dec 2025 16:35:16 -0800 Subject: [PATCH 01/69] Initial core bot activity library, CI, and extensibility Add .NET solution for extensible bot activity schemas with modern serialization, extension data, and reply support. Includes CI workflow, semantic versioning, and comprehensive unit tests for schema evolution and custom fields. --- .github/workflows/core-ci.yaml | 33 ++ core/core.slnx | 10 + core/src/Directory.Build.props | 30 ++ core/src/Directory.Build.targets | 10 + .../Hosting/AddBotApplication.cs | 5 + .../Microsoft.Bot.Core.csproj | 25 ++ .../Schema/ActivityTypes.cs | 14 + .../Microsoft.Bot.Core/Schema/ChannelData.cs | 18 ++ .../Microsoft.Bot.Core/Schema/Conversation.cs | 19 ++ .../Schema/ConversationAccount.cs | 29 ++ .../Microsoft.Bot.Core/Schema/CoreActivity.cs | 167 ++++++++++ .../Microsoft.Bot.Core.UnitTests.csproj | 24 ++ .../Schema/ActivityExtensibilityTests.cs | 74 +++++ .../Schema/CoreActivityTests.cs | 290 ++++++++++++++++++ core/version.json | 13 + 15 files changed, 761 insertions(+) create mode 100644 .github/workflows/core-ci.yaml create mode 100644 core/core.slnx create mode 100644 core/src/Directory.Build.props create mode 100644 core/src/Directory.Build.targets create mode 100644 core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs create mode 100644 core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj create mode 100644 core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs create mode 100644 core/src/Microsoft.Bot.Core/Schema/ChannelData.cs create mode 100644 core/src/Microsoft.Bot.Core/Schema/Conversation.cs create mode 100644 core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs create mode 100644 core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs create mode 100644 core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj create mode 100644 core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs create mode 100644 core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs create mode 100644 core/version.json diff --git a/.github/workflows/core-ci.yaml b/.github/workflows/core-ci.yaml new file mode 100644 index 00000000..7a5c5025 --- /dev/null +++ b/.github/workflows/core-ci.yaml @@ -0,0 +1,33 @@ +name: Core-CI + +on: + push: + branches: [ next/core ] + pull_request: + branches: [ next/core ] + +jobs: + build-and-test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup .NET + uses: actions/setup-dotnet@v4 + with: + dotnet-version: '10.0.x' + + - name: Restore dependencies + run: dotnet restore + working-directory: core + + - name: Build + run: dotnet build --no-restore + working-directory: core + + - name: Test + run: dotnet test --no-build --verbosity normal + working-directory: core \ No newline at end of file diff --git a/core/core.slnx b/core/core.slnx new file mode 100644 index 00000000..ab3916dd --- /dev/null +++ b/core/core.slnx @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/core/src/Directory.Build.props b/core/src/Directory.Build.props new file mode 100644 index 00000000..a96902ed --- /dev/null +++ b/core/src/Directory.Build.props @@ -0,0 +1,30 @@ + + + Microsoft Teams SDK + Microsoft + Microsoft + © Microsoft Corporation. All rights reserved. + https://github.com/microsoft/teams.net + git + false + icon.png + README.md + MIT + true + true + true + snupkg + false + + + latest-all + true + true + + + + all + 3.9.50 + + + diff --git a/core/src/Directory.Build.targets b/core/src/Directory.Build.targets new file mode 100644 index 00000000..7d5f7f8e --- /dev/null +++ b/core/src/Directory.Build.targets @@ -0,0 +1,10 @@ + + + + + + + + \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs new file mode 100644 index 00000000..4c2f25e1 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs @@ -0,0 +1,5 @@ +namespace Microsoft.Bot.Core.Hosting; + +//internal class AddBotApplication +//{ +//} diff --git a/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj b/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj new file mode 100644 index 00000000..15d8df74 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj @@ -0,0 +1,25 @@ + + + + net8.0;net10.0 + enable + enable + True + + + + + + + + + + + + + + + + + + diff --git a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs new file mode 100644 index 00000000..93c81eb0 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs @@ -0,0 +1,14 @@ +namespace Microsoft.Bot.Core.Schema; + +/// +/// Provides constant values that represent activity types used in messaging workflows. +/// +/// Use the fields of this class to specify or compare activity types in message-based systems. This +/// class is typically used to avoid hardcoding string literals for activity type identifiers. +public static class ActivityTypes +{ + /// + /// Represents the default message string used for communication or display purposes. + /// + public const string Message = "message"; +} diff --git a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs new file mode 100644 index 00000000..36f79a70 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs @@ -0,0 +1,18 @@ +namespace Microsoft.Bot.Core.Schema; + +/// +/// Represents channel-specific data associated with an activity. +/// +/// +/// This class serves as a container for custom properties that are specific to a particular +/// messaging channel. The properties dictionary allows channels to include additional metadata +/// that is not part of the standard activity schema. +/// +public class ChannelData() +{ + /// + /// Gets the extension data dictionary for storing channel-specific properties. + /// + [JsonExtensionData] + public ExtendedPropertiesDictionary Properties { get; init; } = []; +} diff --git a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs new file mode 100644 index 00000000..7953ce9b --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs @@ -0,0 +1,19 @@ +namespace Microsoft.Bot.Core.Schema; + +/// +/// Represents a conversation, including its unique identifier and associated extended properties. +/// +public class Conversation() +{ + /// + /// Gets or sets the unique identifier for the object. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Gets the extension data dictionary for storing additional properties not defined in the schema. + /// + [JsonExtensionData] + public ExtendedPropertiesDictionary Properties { get; init; } = []; +} diff --git a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs new file mode 100644 index 00000000..f565978f --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs @@ -0,0 +1,29 @@ +namespace Microsoft.Bot.Core.Schema; + +/// +/// Represents a conversation account, including its unique identifier, display name, and any additional properties +/// associated with the conversation. +/// +/// This class is typically used to model the account information for a conversation in messaging or chat +/// applications. The additional properties dictionary allows for extensibility to support custom metadata or +/// protocol-specific fields. +public class ConversationAccount() +{ + /// + /// Gets or sets the unique identifier for the object. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Gets or sets the display name of the conversation account. + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// + /// Gets the extension data dictionary for storing additional properties not defined in the schema. + /// + [JsonExtensionData] + public ExtendedPropertiesDictionary Properties { get; init; } = []; +} diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs new file mode 100644 index 00000000..1b891d1a --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs @@ -0,0 +1,167 @@ +using System.Text.Json; +using System.Text.Json.Nodes; + +namespace Microsoft.Bot.Core.Schema; + +/// +/// Represents a dictionary for storing extended properties as key-value pairs. +/// +public class ExtendedPropertiesDictionary : Dictionary { } + +/// +/// Represents a core activity object that encapsulates the data and metadata for a bot interaction. +/// +/// +/// This class provides the foundational structure for bot activities including message exchanges, +/// conversation updates, and other bot-related events. It supports serialization to and from JSON +/// and includes extension properties for channel-specific data. +/// +public class CoreActivity(string type = ActivityTypes.Message) +{ + /// + /// Gets or sets the type of the activity. See for common values. + /// + /// + /// Common activity types include "message", "conversationUpdate", "contactRelationUpdate", etc. + /// + [JsonPropertyName("type")] public string Type { get; set; } = type; + /// + /// Gets or sets the unique identifier for the channel on which this activity is occurring. + /// + [JsonPropertyName("channelId")] public string? ChannelId { get; set; } + /// + /// Gets or sets the text content of the message. + /// + [JsonPropertyName("text")] public string? Text { get; set; } + /// + /// Gets or sets the unique identifier for the activity. + /// + [JsonPropertyName("id")] public string Id { get; set; } = string.Empty; + /// + /// Gets or sets the URL of the service endpoint for this activity. + /// + /// + /// This URL is used to send responses back to the channel. + /// + [JsonPropertyName("serviceUrl")] public Uri? ServiceUrl { get; set; } + /// + /// Gets or sets channel-specific data associated with this activity. + /// + [JsonPropertyName("channelData")] public ChannelData? ChannelData { get; set; } + /// + /// Gets or sets the account that sent this activity. + /// + [JsonPropertyName("from")] public ConversationAccount From { get; set; } = new(); + /// + /// Gets or sets the account that should receive this activity. + /// + [JsonPropertyName("recipient")] public ConversationAccount Recipient { get; set; } = new(); + /// + /// Gets or sets the conversation in which this activity is taking place. + /// + [JsonPropertyName("conversation")] public Conversation Conversation { get; set; } = new(); + /// + /// Gets the collection of entities contained in this activity. + /// + /// + /// Entities are structured objects that represent mentions, places, or other data. + /// + [JsonPropertyName("entities")] public JsonArray? Entities { get; } + /// + /// Gets the extension data dictionary for storing additional properties not defined in the schema. + /// + [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; init; } = []; + + /// + /// Gets the default JSON serializer options used for serializing and deserializing activities. + /// + public static readonly JsonSerializerOptions DefaultJsonOptions = new() + { + WriteIndented = true, + DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, + PropertyNamingPolicy = JsonNamingPolicy.CamelCase + }; + + /// + /// Serializes the current activity to a JSON string. + /// + /// A JSON string representation of the activity. + public string ToJson() => JsonSerializer.Serialize(this, DefaultJsonOptions); + + /// + /// Serializes the specified activity instance to a JSON string using the default serialization options. + /// + /// The serialization uses the default JSON options defined by DefaultJsonOptions. The resulting + /// JSON reflects the public properties of the activity instance. + /// The type of the activity to serialize. Must inherit from CoreActivity. + /// The activity instance to serialize. Cannot be null. + /// A JSON string representation of the specified activity instance. + public static string ToJson(T instance) where T: CoreActivity + => JsonSerializer.Serialize(instance, DefaultJsonOptions); + + /// + /// Deserializes a JSON string into a object. + /// + /// The JSON string to deserialize. + /// A instance. + public static CoreActivity FromJsonString(string json) + => JsonSerializer.Deserialize(json, DefaultJsonOptions)!; + + /// + /// Deserializes the specified JSON string to an object of type T. + /// + /// The deserialization uses default JSON options defined by the application. If the JSON is + /// invalid or does not match the target type, a JsonException may be thrown. + /// The type of the object to deserialize to. Must be compatible with the JSON structure. + /// The JSON string to deserialize. Cannot be null or empty. + /// An instance of type T that represents the deserialized JSON data. + public static T FromJsonString(string json) where T : CoreActivity + => JsonSerializer.Deserialize(json, DefaultJsonOptions)!; + + /// + /// Asynchronously deserializes a JSON stream into a object. + /// + /// The stream containing JSON data to deserialize. + /// A cancellation token to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the deserialized instance, or null if deserialization fails. + public static ValueTask FromJsonStreamAsync(Stream stream, CancellationToken cancellationToken = default) + => JsonSerializer.DeserializeAsync(stream, DefaultJsonOptions, cancellationToken); + + /// + /// Asynchronously deserializes a JSON value from the specified stream into an instance of type T. + /// + /// The caller is responsible for managing the lifetime of the provided stream. The method uses + /// default JSON serialization options. + /// The type of the object to deserialize. Must derive from CoreActivity. + /// The stream containing the JSON data to deserialize. The stream must be readable and positioned at the start of + /// the JSON content. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// A ValueTask that represents the asynchronous operation. The result contains an instance of type T if + /// deserialization is successful; otherwise, null. + public static ValueTask FromJsonStreamAsync(Stream stream, CancellationToken cancellationToken = default) where T : CoreActivity + => JsonSerializer.DeserializeAsync(stream, DefaultJsonOptions, cancellationToken); + + /// + /// Creates a reply activity based on the current activity. + /// + /// The text content for the reply. Defaults to an empty string. + /// A new configured as a reply to the current activity. + /// + /// The reply activity automatically swaps the From and Recipient accounts and preserves + /// the conversation context, channel ID, and service URL from the original activity. + /// + public CoreActivity CreateReplyActivity(string text = "") + { + CoreActivity result = new() + { + Type = "message", + ChannelId = ChannelId, + ServiceUrl = ServiceUrl, + Conversation = Conversation, + From = Recipient, + Recipient = From, + Text = text + }; + return result!; + } +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj b/core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj new file mode 100644 index 00000000..9f253890 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj @@ -0,0 +1,24 @@ + + + net10.0 + enable + enable + false + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs new file mode 100644 index 00000000..7b3cb706 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs @@ -0,0 +1,74 @@ +using System.Text; +using System.Text.Json.Serialization; + +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core.UnitTests.Schema; + +public class ActivityExtensibilityTests +{ + [Fact] + public void CustomActivity_ExtendedProperties_SerializedAndDeserialized() + { + var customActivity = new MyCustomActivity + { + CustomField = "CustomValue" + }; + string json = MyCustomActivity.ToJson(customActivity); + var deserializedActivity = CoreActivity.FromJsonString(json); + Assert.NotNull(deserializedActivity); + Assert.Equal("CustomValue", deserializedActivity!.CustomField); + } + + [Fact] + public async Task CustomActivity_ExtendedProperties_SerializedAndDeserialized_Async() + { + string json = """ + { + "type": "message", + "customField": "CustomValue" + } + """; + using var stream = new MemoryStream(Encoding.UTF8.GetBytes(json)); + var deserializedActivity = await CoreActivity.FromJsonStreamAsync(stream); + Assert.NotNull(deserializedActivity); + Assert.Equal("CustomValue", deserializedActivity!.CustomField); + } + + + [Fact] + public void CustomChannelDataActivity_ExtendedProperties_SerializedAndDeserialized() + { + var customChannelDataActivity = new MyCustomChannelDataActivity + { + ChannelData = new MyChannelData + { + CustomField = "ChannelDataValue" + } + }; + var json = MyCustomChannelDataActivity.ToJson(customChannelDataActivity); + var deserializedActivity = CoreActivity.FromJsonString(json); + Assert.NotNull(deserializedActivity); + Assert.NotNull(deserializedActivity!.ChannelData); + Assert.Equal("ChannelDataValue", deserializedActivity.ChannelData!.CustomField); + } +} + +public class MyCustomActivity : CoreActivity +{ + [JsonPropertyName("customField")] + public string? CustomField { get; set; } +} + + +public class MyChannelData : ChannelData +{ + [JsonPropertyName("customField")] + public string? CustomField { get; set; } +} + +public class MyCustomChannelDataActivity : CoreActivity +{ + [JsonPropertyName("customField")] + public new MyChannelData? ChannelData { get; set; } +} \ No newline at end of file diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs new file mode 100644 index 00000000..19f4ddc0 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -0,0 +1,290 @@ +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core.UnitTests.Schema; + +public class CoreCoreActivityTests +{ + [Fact] + public void Ctor_And_Nulls() + { + CoreActivity a1 = new(); + Assert.NotNull(a1); + Assert.Equal(ActivityTypes.Message, a1.Type); + Assert.Null(a1.Text); + + CoreActivity a2 = new() + { + Type = "mytype" + }; + Assert.NotNull(a2); + Assert.Equal("mytype", a2.Type); + Assert.Null(a2.Text); + } + + [Fact] + public void Json_Nulls_Not_Deserialized() + { + string json = """ + { + "type": "message", + "text": null + } + """; + CoreActivity act = CoreActivity.FromJsonString(json); + Assert.NotNull(act); + Assert.Equal("message", act.Type); + Assert.Null(act.Text); + + string json2 = """ + { + "type": "message" + } + """; + CoreActivity act2 = CoreActivity.FromJsonString(json2); + Assert.NotNull(act2); + Assert.Equal("message", act2.Type); + Assert.Null(act2.Text); + + } + + [Fact] + public void Accept_Unkown_Primitive_Fields() + { + string json = """ + { + "type": "message", + "text": "hello", + "unknownString": "some string", + "unknownInt": 123, + "unknownBool": true, + "unknownNull": null + } + """; + CoreActivity act = CoreActivity.FromJsonString(json); + Assert.NotNull(act); + Assert.Equal("message", act.Type); + Assert.Equal("hello", act.Text); + Assert.True(act.Properties.ContainsKey("unknownString")); + Assert.True(act.Properties.ContainsKey("unknownInt")); + Assert.True(act.Properties.ContainsKey("unknownBool")); + Assert.True(act.Properties.ContainsKey("unknownNull")); + Assert.Equal("some string", act.Properties["unknownString"]?.ToString()); + Assert.Equal(123, ((JsonElement)act.Properties["unknownInt"]!).GetInt32()); + Assert.True(((JsonElement)act.Properties["unknownBool"]!).GetBoolean()); + Assert.Null(act.Properties["unknownNull"]); + } + + [Fact] + public void Serialize_Unkown_Primitive_Fields() + { + CoreActivity act = new() + { + Type = "message", + Text = "hello", + }; + act.Properties["unknownString"] = "some string"; + act.Properties["unknownInt"] = 123; + act.Properties["unknownBool"] = true; + act.Properties["unknownNull"] = null; + + string json = act.ToJson(); + Assert.Contains("\"type\": \"message\"", json); + Assert.Contains("\"text\": \"hello\"", json); + Assert.Contains("\"unknownString\": \"some string\"", json); + Assert.Contains("\"unknownInt\": 123", json); + Assert.Contains("\"unknownBool\": true", json); + Assert.Contains("\"unknownNull\": null", json); + } + + [Fact] + public void Deserialize_Unkown__Fields_In_KnownObjects() + { + string json = """ + { + "type": "message", + "text": "hello", + "from": { + "id": "1", + "name": "tester", + "aadObjectId": "123" + } + } + """; + CoreActivity act = CoreActivity.FromJsonString(json); + Assert.NotNull(act); + Assert.Equal("message", act.Type); + Assert.Equal("hello", act.Text); + Assert.NotNull(act.From); + Assert.IsType(act.From); + Assert.Equal("1", act.From!.Id); + Assert.Equal("tester", act.From.Name); + Assert.True(act.From.Properties.ContainsKey("aadObjectId")); + Assert.Equal("123", act.From.Properties["aadObjectId"]?.ToString()); + } + + [Fact] + public void Deserialize_Serialize_Unkown__Fields_In_KnownObjects() + { + string json = """ + { + "type": "message", + "text": "hello", + "from": { + "id": "1", + "name": "tester", + "aadObjectId": "123" + } + } + """; + CoreActivity act = CoreActivity.FromJsonString(json); + act.Text = "updated"; + string json2 = act.ToJson(); + Assert.Contains("\"type\": \"message\"", json2); + Assert.Contains("\"text\": \"updated\"", json2); + Assert.Contains("\"from\": {", json2); + Assert.Contains("\"id\": \"1\"", json2); + Assert.Contains("\"name\": \"tester\"", json2); + Assert.Contains("\"aadObjectId\": \"123\"", json2); + } + + [Fact] + public void Handling_Nulls_from_default_serializer() + { + string json = """ + { + "type": "message", + "text": null, + "unknownString": null + } + """; + CoreActivity? act = JsonSerializer.Deserialize(json); //without default options + Assert.NotNull(act); + Assert.Equal("message", act.Type); + Assert.Null(act.Text); + Assert.Null(act.Properties["unknownString"]!); + + string json2 = JsonSerializer.Serialize(act); //without default options + Assert.Contains("\"type\":\"message\"", json2); + Assert.Contains("\"text\":null", json2); + Assert.Contains("\"unknownString\":null", json2); + } + + [Fact] + public void Serialize_With_Properties_Initialized() + { + CoreActivity act = new() + { + Type = "message", + Text = "hello", + Properties = + { + { "customField", "customValue" } + }, + ChannelData = new() + { + Properties = + { + { "channelCustomField", "channelCustomValue" } + } + }, + Conversation = new() + { + Properties = + { + { "conversationCustomField", "conversationCustomValue" } + } + }, + From = new () + { + Id = "user1", + Properties = + { + { "fromCustomField", "fromCustomValue" } + } + }, + Recipient = new () + { + Id = "bot1", + Properties = + { + { "recipientCustomField", "recipientCustomValue" } + } + + } + }; + string json = act.ToJson(); + Assert.Contains("\"type\": \"message\"", json); + Assert.Contains("\"text\": \"hello\"", json); + Assert.Contains("\"customField\": \"customValue\"", json); + Assert.Contains("\"channelCustomField\": \"channelCustomValue\"", json); + Assert.Contains("\"conversationCustomField\": \"conversationCustomValue\"", json); + Assert.Contains("\"fromCustomField\": \"fromCustomValue\"", json); + Assert.Contains("\"recipientCustomField\": \"recipientCustomValue\"", json); + } + + + [Fact] + public void CreateReply() + { + CoreActivity act = new() + { + Text = "hello", + Id = "CoreActivity1", + ChannelId = "channel1", + ServiceUrl = new Uri("http://service.url"), + From = new ConversationAccount() + { + Id = "user1", + Name = "User One" + }, + Recipient = new ConversationAccount() + { + Id = "bot1", + Name = "Bot One" + }, + Conversation = new Conversation() + { + Id = "conversation1" + } + }; + CoreActivity reply = act.CreateReplyActivity("reply"); + Assert.NotNull(reply); + Assert.Equal("message", reply.Type); + Assert.Equal("reply", reply.Text); + Assert.Equal("channel1", reply.ChannelId); + Assert.NotNull(reply.ServiceUrl); + Assert.Equal("http://service.url/", reply.ServiceUrl.ToString()); + Assert.Equal("conversation1", reply.Conversation?.Id); + Assert.Equal("bot1", reply.From?.Id); + Assert.Equal("Bot One", reply.From?.Name); + Assert.Equal("user1", reply.Recipient?.Id); + Assert.Equal("User One", reply.Recipient?.Name); + } + + [Fact] + public async Task DeserializeAsync() + { + string json = """ + { + "type": "message", + "text": "hello", + "from": { + "id": "1", + "name": "tester", + "aadObjectId": "123" + } + } + """; + using var ms = new MemoryStream(System.Text.Encoding.UTF8.GetBytes(json)); + CoreActivity? act = await CoreActivity.FromJsonStreamAsync(ms); + Assert.NotNull(act); + Assert.Equal("message", act.Type); + Assert.Equal("hello", act.Text); + Assert.NotNull(act.From); + Assert.IsType(act.From); + Assert.Equal("1", act.From!.Id); + Assert.Equal("tester", act.From.Name); + Assert.True(act.From.Properties.ContainsKey("aadObjectId")); + Assert.Equal("123", act.From.Properties["aadObjectId"]?.ToString()); + } +} diff --git a/core/version.json b/core/version.json new file mode 100644 index 00000000..25d21e3a --- /dev/null +++ b/core/version.json @@ -0,0 +1,13 @@ +{ + "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", + "version": "0.0.1-alpha.{height}", + "publicReleaseRefSpec": [ + "^refs/heads/main$", + "^refs/heads/v\\d+(?:\\.\\d+)?$" + ], + "cloudBuild": { + "buildNumber": { + "enabled": true + } + } +} \ No newline at end of file From 34c8eaf2c949042e1fc008416ec2c8986a08eeba Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Tue, 9 Dec 2025 16:37:54 -0800 Subject: [PATCH 02/69] lint --- core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs | 2 +- core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs | 2 +- core/src/Microsoft.Bot.Core/Schema/ChannelData.cs | 2 +- core/src/Microsoft.Bot.Core/Schema/Conversation.cs | 2 +- core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs | 2 +- core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs | 6 +++--- .../Schema/CoreActivityTests.cs | 6 +++--- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs index 4c2f25e1..f03200ee 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs @@ -2,4 +2,4 @@ //internal class AddBotApplication //{ -//} +//} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs index 93c81eb0..2741c1b8 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs @@ -11,4 +11,4 @@ public static class ActivityTypes /// Represents the default message string used for communication or display purposes. /// public const string Message = "message"; -} +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs index 36f79a70..fdea51ca 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs @@ -15,4 +15,4 @@ public class ChannelData() /// [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; init; } = []; -} +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs index 7953ce9b..c06c608a 100644 --- a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs +++ b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs @@ -16,4 +16,4 @@ public class Conversation() /// [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; init; } = []; -} +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs index f565978f..b67e591e 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs @@ -26,4 +26,4 @@ public class ConversationAccount() /// [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; init; } = []; -} +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs index 1b891d1a..7c996ae4 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs @@ -66,7 +66,7 @@ public class CoreActivity(string type = ActivityTypes.Message) /// /// Entities are structured objects that represent mentions, places, or other data. /// - [JsonPropertyName("entities")] public JsonArray? Entities { get; } + [JsonPropertyName("entities")] public JsonArray? Entities { get; } /// /// Gets the extension data dictionary for storing additional properties not defined in the schema. /// @@ -96,7 +96,7 @@ public class CoreActivity(string type = ActivityTypes.Message) /// The type of the activity to serialize. Must inherit from CoreActivity. /// The activity instance to serialize. Cannot be null. /// A JSON string representation of the specified activity instance. - public static string ToJson(T instance) where T: CoreActivity + public static string ToJson(T instance) where T : CoreActivity => JsonSerializer.Serialize(instance, DefaultJsonOptions); /// @@ -164,4 +164,4 @@ public CoreActivity CreateReplyActivity(string text = "") }; return result!; } -} +} \ No newline at end of file diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs index 19f4ddc0..6fb1e8ef 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -194,7 +194,7 @@ public void Serialize_With_Properties_Initialized() { "conversationCustomField", "conversationCustomValue" } } }, - From = new () + From = new() { Id = "user1", Properties = @@ -202,7 +202,7 @@ public void Serialize_With_Properties_Initialized() { "fromCustomField", "fromCustomValue" } } }, - Recipient = new () + Recipient = new() { Id = "bot1", Properties = @@ -287,4 +287,4 @@ public async Task DeserializeAsync() Assert.True(act.From.Properties.ContainsKey("aadObjectId")); Assert.Equal("123", act.From.Properties["aadObjectId"]?.ToString()); } -} +} \ No newline at end of file From 86b3ae2da99b92c63bccc28f2c455e2687dbb9cd Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Tue, 9 Dec 2025 16:45:41 -0800 Subject: [PATCH 03/69] Add permissions to Core-CI workflow for contents and PRs Added a permissions section to the Core-CI workflow, granting read access to repository contents and write access to pull-requests. This explicitly defines the workflow's required permissions. --- .github/workflows/core-ci.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/core-ci.yaml b/.github/workflows/core-ci.yaml index 7a5c5025..62b9c8e8 100644 --- a/.github/workflows/core-ci.yaml +++ b/.github/workflows/core-ci.yaml @@ -1,4 +1,7 @@ name: Core-CI +permissions: + contents: read + pull-requests: write on: push: From e645b70b8ca7cbdac6628aa62dba147ebc8909bb Mon Sep 17 00:00:00 2001 From: Rido Date: Wed, 10 Dec 2025 17:01:58 -0800 Subject: [PATCH 04/69] Add Proactive and SourceCodeGenerators (#237) This pull request introduces several new sample bots and supporting infrastructure to the `core` directory, demonstrating different usage scenarios for the Microsoft.Bot.Core SDK. It also adds compatibility support for legacy Bot Framework bots, improves development environment configuration, and updates documentation and gitignore settings. **New sample bots and scenarios:** - Added three new sample projects: - [`CompatBot`](diffhunk://#diff-22411d9bef78e3d139f1e4b1a4d5e047bb26428a97bf59df7f5b983e584babd8R1-R13): Demonstrates running a legacy Bot Framework bot using the new compatibility layer, including `EchoBot` implementation and required configuration files. [[1]](diffhunk://#diff-22411d9bef78e3d139f1e4b1a4d5e047bb26428a97bf59df7f5b983e584babd8R1-R13) [[2]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aR1-R35) [[3]](diffhunk://#diff-62be1f70aaabb519334fe39cd50c0e25a98717ebb9fab85b688832917c9c75bbR1-R29) [[4]](diffhunk://#diff-834a6cbae004839d32944b2f2a3cf8edc3a32f558597d464401178fa95781edcR1-R9) - [`CoreBot`](diffhunk://#diff-1087baf076a83b00d0c97ef01c02174668cb26c9fad5d2c33284e0889150ed65R1-R13): Shows a simple bot using the new SDK, with configuration and logging settings. [[1]](diffhunk://#diff-1087baf076a83b00d0c97ef01c02174668cb26c9fad5d2c33284e0889150ed65R1-R13) [[2]](diffhunk://#diff-b94b53965e9052345453f2ab6bec21420a36c4b67c9a6c568b9c80edcd0882d1R1-R22) [[3]](diffhunk://#diff-84b21a8c78e12fee4df3b2d67483407632a1fe5d25691ed7cfefde85adc92a25R1-R11) - [`Proactive`](diffhunk://#diff-ffe34fac742569e7a6cfb5589871a8b9571c7692f6af33e167f39cc2b8be3ed3R1-R17): Demonstrates sending proactive messages using a background worker. [[1]](diffhunk://#diff-ffe34fac742569e7a6cfb5589871a8b9571c7692f6af33e167f39cc2b8be3ed3R1-R17) [[2]](diffhunk://#diff-f32e1fd30a40c5aa42855895485dbb9c8b79d4029cd3db1a1446f48846f8604dR1-R10) [[3]](diffhunk://#diff-61d7e83f772e536a1729f5c12b1b028a2a396a28e2175541489e85d89d2758ecR1-R31) [[4]](diffhunk://#diff-1342c159b3ce809afd5880d58bd2f17e3eeade347f10d5b8d6d550cb3a0ab8f9R1-R8) - Added scenario scripts for middleware and proactive messaging, runnable via dotnet script. [[1]](diffhunk://#diff-aee4a2e56fbce4adfe46afec84a447a9aab7752f7c24982b51b8475af942124fR1-R34) [[2]](diffhunk://#diff-8287e53b5a4e259703b929262b11fdb5f783564de364cc184d27a5b7486de729R1-R43) - Provided an example `launchSettings.json` for local development of scenarios. **Compatibility support:** - Introduced `CompatAdapter` and related classes to bridge new bot application models with legacy Bot Framework interfaces, enabling easier migration and integration of existing bots. [[1]](diffhunk://#diff-ee802b583e856949e14f231284969979f8827efaa484f0b431badb7936809855R1-R116) [[2]](diffhunk://#diff-e70e201729b0f386ddb70a5d3f83751f2bd0a08e527b0a5265fbb8094a9abe19R1-R27) **Development environment and documentation improvements:** - Updated `.devcontainer/devcontainer.json` to add Docker-in-Docker, .NET 10, and ensure latest feature versions for improved local development experience. - Added a `README.md` with instructions for testing and running scenarios. - Added common development files to `.gitignore` and included it in the solution. [[1]](diffhunk://#diff-af85f59c6492668dca14d5f06b54cc2c3173708c83073e1d947b4c007dc851d6R1-R2) [[2]](diffhunk://#diff-19ad97af5c1b7109a9c62f830310091f393489def210b9ec1ffce152b8bf958cR4-R12) **Solution structure updates:** - Updated `core.slnx` to include new sample projects and `.gitignore` as solution items. --- **New sample bots and scenarios:** - Added `CompatBot`, `CoreBot`, and `Proactive` sample projects with implementations and configuration files to demonstrate different SDK usage scenarios. [[1]](diffhunk://#diff-22411d9bef78e3d139f1e4b1a4d5e047bb26428a97bf59df7f5b983e584babd8R1-R13) [[2]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aR1-R35) [[3]](diffhunk://#diff-62be1f70aaabb519334fe39cd50c0e25a98717ebb9fab85b688832917c9c75bbR1-R29) [[4]](diffhunk://#diff-834a6cbae004839d32944b2f2a3cf8edc3a32f558597d464401178fa95781edcR1-R9) [[5]](diffhunk://#diff-1087baf076a83b00d0c97ef01c02174668cb26c9fad5d2c33284e0889150ed65R1-R13) [[6]](diffhunk://#diff-b94b53965e9052345453f2ab6bec21420a36c4b67c9a6c568b9c80edcd0882d1R1-R22) [[7]](diffhunk://#diff-84b21a8c78e12fee4df3b2d67483407632a1fe5d25691ed7cfefde85adc92a25R1-R11) [[8]](diffhunk://#diff-ffe34fac742569e7a6cfb5589871a8b9571c7692f6af33e167f39cc2b8be3ed3R1-R17) [[9]](diffhunk://#diff-f32e1fd30a40c5aa42855895485dbb9c8b79d4029cd3db1a1446f48846f8604dR1-R10) [[10]](diffhunk://#diff-61d7e83f772e536a1729f5c12b1b028a2a396a28e2175541489e85d89d2758ecR1-R31) [[11]](diffhunk://#diff-1342c159b3ce809afd5880d58bd2f17e3eeade347f10d5b8d6d550cb3a0ab8f9R1-R8) - Added scenario scripts for middleware and proactive messaging, plus an example launch settings file for local testing. [[1]](diffhunk://#diff-aee4a2e56fbce4adfe46afec84a447a9aab7752f7c24982b51b8475af942124fR1-R34) [[2]](diffhunk://#diff-8287e53b5a4e259703b929262b11fdb5f783564de364cc184d27a5b7486de729R1-R43) [[3]](diffhunk://#diff-19cd1809f42bd0d871748a1e3bf7c705961f9abd0a4da67acc547f42c1ebfcd6R1-R20) **Compatibility support:** - Introduced `CompatAdapter` and `CompatActivity` to support running legacy Bot Framework bots with the new SDK. [[1]](diffhunk://#diff-ee802b583e856949e14f231284969979f8827efaa484f0b431badb7936809855R1-R116) [[2]](diffhunk://#diff-e70e201729b0f386ddb70a5d3f83751f2bd0a08e527b0a5265fbb8094a9abe19R1-R27) **Development environment and documentation:** - Enhanced `.devcontainer` with Docker-in-Docker, .NET 10, and latest feature versions for improved local development. - Added a `README.md` with setup and testing instructions. - Updated `.gitignore` and included it in the solution for better source control hygiene. [[1]](diffhunk://#diff-af85f59c6492668dca14d5f06b54cc2c3173708c83073e1d947b4c007dc851d6R1-R2) [[2]](diffhunk://#diff-19ad97af5c1b7109a9c62f830310091f393489def210b9ec1ffce152b8bf958cR4-R12) **Solution structure:** - Updated `core.slnx` to include new projects and configuration files. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: rido-min <14916339+rido-min@users.noreply.github.com> --- .devcontainer/devcontainer.json | 13 +- core/.gitignore | 2 + core/README.md | 132 +++++++++++ core/core.slnx | 5 + core/samples/CompatBot/CompatBot.csproj | 13 + core/samples/CompatBot/EchoBot.cs | 35 +++ core/samples/CompatBot/Program.cs | 29 +++ core/samples/CompatBot/appsettings.json | 9 + core/samples/CoreBot/CoreBot.csproj | 13 + core/samples/CoreBot/Program.cs | 22 ++ core/samples/CoreBot/appsettings.json | 11 + core/samples/Proactive/Proactive.csproj | 17 ++ core/samples/Proactive/Program.cs | 10 + core/samples/Proactive/Worker.cs | 31 +++ core/samples/Proactive/appsettings.json | 8 + .../Properties/launchSettings.example.json | 20 ++ core/samples/scenarios/middleware.cs | 34 +++ core/samples/scenarios/proactive.cs | 43 ++++ .../CompatActivity.cs | 27 +++ .../CompatAdapter.cs | 116 +++++++++ .../CompatBotAdapter.cs | 67 ++++++ .../CompatHostingExtensions.cs | 47 ++++ .../CompatMiddlewareAdapter.cs | 14 ++ .../Microsoft.Bot.Core.Compat.csproj | 14 ++ core/src/Microsoft.Bot.Core/BotApplication.cs | 132 +++++++++++ .../Microsoft.Bot.Core/BotHandlerException.cs | 53 +++++ .../Microsoft.Bot.Core/ConversationClient.cs | 51 ++++ .../Hosting/AddBotApplication.cs | 5 - .../Hosting/AddBotApplicationExtensions.cs | 116 +++++++++ .../Hosting/BotAuthenticationHandler.cs | 126 ++++++++++ .../src/Microsoft.Bot.Core/ITurnMiddleWare.cs | 31 +++ .../Microsoft.Bot.Core/Schema/ChannelData.cs | 6 +- .../Microsoft.Bot.Core/Schema/Conversation.cs | 6 +- .../Schema/ConversationAccount.cs | 4 +- .../Microsoft.Bot.Core/Schema/CoreActivity.cs | 38 ++- .../Schema/CoreActivityJsonContext.cs | 21 ++ core/src/Microsoft.Bot.Core/TurnMiddleware.cs | 49 ++++ .../BotApplicationTests.cs | 222 ++++++++++++++++++ .../ConversationClientTests.cs | 174 ++++++++++++++ .../Microsoft.Bot.Core.UnitTests.csproj | 3 +- .../MiddlewareTests.cs | 222 ++++++++++++++++++ .../Schema/ActivityExtensibilityTests.cs | 33 ++- .../Schema/CoreActivityTests.cs | 7 +- core/test/aot-checks/Program.cs | 5 + core/test/aot-checks/SampleActivities.cs | 68 ++++++ core/test/aot-checks/aot-checks.csproj | 17 ++ 46 files changed, 2091 insertions(+), 30 deletions(-) create mode 100644 core/.gitignore create mode 100644 core/README.md create mode 100644 core/samples/CompatBot/CompatBot.csproj create mode 100644 core/samples/CompatBot/EchoBot.cs create mode 100644 core/samples/CompatBot/Program.cs create mode 100644 core/samples/CompatBot/appsettings.json create mode 100644 core/samples/CoreBot/CoreBot.csproj create mode 100644 core/samples/CoreBot/Program.cs create mode 100644 core/samples/CoreBot/appsettings.json create mode 100644 core/samples/Proactive/Proactive.csproj create mode 100644 core/samples/Proactive/Program.cs create mode 100644 core/samples/Proactive/Worker.cs create mode 100644 core/samples/Proactive/appsettings.json create mode 100644 core/samples/scenarios/Properties/launchSettings.example.json create mode 100755 core/samples/scenarios/middleware.cs create mode 100644 core/samples/scenarios/proactive.cs create mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs create mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs create mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs create mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs create mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs create mode 100644 core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj create mode 100644 core/src/Microsoft.Bot.Core/BotApplication.cs create mode 100644 core/src/Microsoft.Bot.Core/BotHandlerException.cs create mode 100644 core/src/Microsoft.Bot.Core/ConversationClient.cs delete mode 100644 core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs create mode 100644 core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs create mode 100644 core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs create mode 100644 core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs create mode 100644 core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs create mode 100644 core/src/Microsoft.Bot.Core/TurnMiddleware.cs create mode 100644 core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs create mode 100644 core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs create mode 100644 core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs create mode 100644 core/test/aot-checks/Program.cs create mode 100644 core/test/aot-checks/SampleActivities.cs create mode 100644 core/test/aot-checks/aot-checks.csproj diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 4e99def3..9cc0b875 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -12,7 +12,18 @@ "bicepVersion": "latest" }, "ghcr.io/dotnet/aspire-devcontainer-feature/dotnetaspire:1": { - "version": "9.0" + "version": "latest" + }, + "ghcr.io/devcontainers/features/dotnet:2": { + "version": "10.0" + }, + "ghcr.io/devcontainers/features/docker-in-docker:2": { + "moby": true, + "azureDnsAutoDetection": true, + "installDockerBuildx": true, + "installDockerComposeSwitch": true, + "version": "latest", + "dockerDashComposeVersion": "v2" } } diff --git a/core/.gitignore b/core/.gitignore new file mode 100644 index 00000000..4055b442 --- /dev/null +++ b/core/.gitignore @@ -0,0 +1,2 @@ +launchSettings.json +appsettings.Development.json \ No newline at end of file diff --git a/core/README.md b/core/README.md new file mode 100644 index 00000000..f401ffc8 --- /dev/null +++ b/core/README.md @@ -0,0 +1,132 @@ +# Microsoft.Bot.Core + +Bot Core implements the Activity Protocol, including schema, conversation client, user token client, and support for Bot and Agentic Identities. + +## Design Principles + +- Loose schema. `CoreActivity` contains only the strictly required fields for Conversation Client, additional fields are captured as a Dictitionary with JsonExtensionData attributes. +- Simple Serialization. `CoreActivity` can be serialized/deserialized without any custom logic, and trying to avoid custom converters as much as possible. +- Extensible schema. Fields subject to extension, such as `ChannelData` must define their own `Properties` to allow serialization of unknown fields. Use of generics to allow additional types that are not defined in the Core Library. +- Auth based on MSAL. Token acquisition done on top of MSAL +- Respect ASP.NET DI. `BotApplication` dependencies are configured based on .NET ServiceCollection extensions, reusing the existing `HttpClient` +- Respect ILogger and IConfiguration. + +## Samples + +### Extensible Activity + +```cs +public class MyChannelData : ChannelData +{ + [JsonPropertyName("customField")] + public string? CustomField { get; set; } + + [JsonPropertyName("myChannelId")] + public string? MyChannelId { get; set; } +} + +public class MyCustomChannelDataActivity : CoreActivity +{ + [JsonPropertyName("channelData")] + public new MyChannelData? ChannelData { get; set; } +} + +[Fact] +public void Deserialize_CustomChannelDataActivity() +{ + string json = """ + { + "type": "message", + "channelData": { + "customField": "customFieldValue", + "myChannelId": "12345" + } + } + """; + var deserializedActivity = CoreActivity.FromJsonString(json); + Assert.NotNull(deserializedActivity); + Assert.NotNull(deserializedActivity.ChannelData); + Assert.Equal("customFieldValue", deserializedActivity.ChannelData.CustomField); + Assert.Equal("12345", deserializedActivity.ChannelData.MyChannelId); +} +``` + +> Note `FromJsonString` lives in `CoreActivity`, and there is no need to override. + + +### Basic Bot Application Usage + +```cs +var webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddBotApplication(); +var webApp = webAppBuilder.Build(); +var botApp = webApp.UseBotApplication(); + +botApp.OnActivity = async (activity, cancellationToken) => +{ + var replyText = $"CoreBot running on SDK {BotApplication.Version}."; + replyText += $"\r\nYou sent: `{activity.Text}` in activity of type `{activity.Type}`."; + replyText += $"\r\n to Conversation ID: `{activity.Conversation.Id}` type: `{activity.Conversation.Properties["conversationType"]}`"; + var replyActivity = activity.CreateReplyActivity(ActivityTypes.Message, replyText); + await botApp.SendActivityAsync(replyActivity, cancellationToken); +}; + +webApp.Run(); +``` + +## Testing in Teams + +Need to create a Teams Application, configure it in ABS and capture `TenantId`, `ClientId` and `ClientSecret`. Provide those values as + +```json +{ + "AzureAd" : { + "Instance" : "https://login.microsoftonline.com/", + "TenantId" : "", + "ClientId" : "", + "Scope" : "https://api.botframework.com/.default", + "ClientCredentials" : [ + { + "SourceType" : "ClientSecret", + "ClientSecret" : "" + } + ] + } +} +``` + +or as env vars, using the IConfiguration Environment Configuration Provider: + +```env + AzureAd__Instance=https://login.microsoftonline.com/ + AzureAd__TenantId= + AzureAd__ClientId= + AzureAd__Scope=https://api.botframework.com/.default + AzureAd__ClientCredentials__0__SourceType=ClientSecret + AzureAd__ClientCredentials__0__ClientSecret= +``` + + + +## Testing in localhost (anonymous) + +When not providing MSAL configuration all the communication will happen as anonymous REST calls, suitable for localhost testing. + +### Install Playground + +Linux +``` +curl -s https://raw.githubusercontent.com/OfficeDev/microsoft-365-agents-toolkit/dev/.github/scripts/install-agentsplayground-linux.sh | bash +``` + +Windows +``` +winget install m365agentsplayground +``` + + +### Run Scenarios + +``` +dotnet samples/scenarios/middleware.cs -- --urls "http://localhost:3978" +``` diff --git a/core/core.slnx b/core/core.slnx index ab3916dd..bfe29680 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -1,10 +1,15 @@ + + + + + diff --git a/core/samples/CompatBot/CompatBot.csproj b/core/samples/CompatBot/CompatBot.csproj new file mode 100644 index 00000000..500ef454 --- /dev/null +++ b/core/samples/CompatBot/CompatBot.csproj @@ -0,0 +1,13 @@ + + + + net8.0 + enable + enable + + + + + + + diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs new file mode 100644 index 00000000..925c0c04 --- /dev/null +++ b/core/samples/CompatBot/EchoBot.cs @@ -0,0 +1,35 @@ +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Teams; +using Microsoft.Bot.Schema; + +namespace CompatBot; + +public class ConversationData +{ + public int MessageCount { get; set; } = 0; + +} + +class EchoBot(ConversationState conversationState) : TeamsActivityHandler +{ + public override async Task OnTurnAsync(ITurnContext turnContext, CancellationToken cancellationToken = default) + { + await base.OnTurnAsync(turnContext, cancellationToken); + + await conversationState.SaveChangesAsync(turnContext, false, cancellationToken); + } + + protected override async Task OnMessageActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) + { + var conversationStateAccessors = conversationState.CreateProperty(nameof(ConversationData)); + var conversationData = await conversationStateAccessors.GetAsync(turnContext, () => new ConversationData(), cancellationToken); + + var replyText = $"Echo [{conversationData.MessageCount++}]: {turnContext.Activity.Text}"; + await turnContext.SendActivityAsync(MessageFactory.Text(replyText, replyText), cancellationToken); + } + + protected override async Task OnMessageReactionActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) + { + await turnContext.SendActivityAsync(MessageFactory.Text("Message reaction received."), cancellationToken); + } +} \ No newline at end of file diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs new file mode 100644 index 00000000..1f0abaf9 --- /dev/null +++ b/core/samples/CompatBot/Program.cs @@ -0,0 +1,29 @@ +using CompatBot; + +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Integration.AspNet.Core; +// using Microsoft.Bot.Connector.Authentication; +using Microsoft.Bot.Core.Compat; + +var builder = WebApplication.CreateBuilder(args); + +builder.AddCompatAdapter(); + +//builder.Services.AddSingleton(); +//builder.Services.AddSingleton(provider => +// new CloudAdapter( +// provider.GetRequiredService(), +// provider.GetRequiredService>())); + + +var storage = new MemoryStorage(); +var conversationState = new ConversationState(storage); +builder.Services.AddSingleton(conversationState); +builder.Services.AddTransient(); + +var app = builder.Build(); + +app.MapPost("/api/messages", async (IBotFrameworkHttpAdapter adapter, IBot bot, HttpRequest request, HttpResponse response) => + await adapter.ProcessAsync(request, response, bot)); + +app.Run(); \ No newline at end of file diff --git a/core/samples/CompatBot/appsettings.json b/core/samples/CompatBot/appsettings.json new file mode 100644 index 00000000..10f68b8c --- /dev/null +++ b/core/samples/CompatBot/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*" +} diff --git a/core/samples/CoreBot/CoreBot.csproj b/core/samples/CoreBot/CoreBot.csproj new file mode 100644 index 00000000..1a260796 --- /dev/null +++ b/core/samples/CoreBot/CoreBot.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs new file mode 100644 index 00000000..d41ed9d3 --- /dev/null +++ b/core/samples/CoreBot/Program.cs @@ -0,0 +1,22 @@ + + +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; + +WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddBotApplication(); +WebApplication webApp = webAppBuilder.Build(); +var botApp = webApp.UseBotApplication(); + + +botApp.OnActivity = async (activity, cancellationToken) => +{ + string replyText = $"CoreBot running on SDK {BotApplication.Version}."; + replyText += $"\r\nYou sent: `{activity.Text}` in activity of type `{activity.Type}`."; + replyText += $"\r\n to Conversation ID: `{activity.Conversation.Id}` type: `{activity.Conversation.Properties["conversationType"]}`"; + var replyActivity = activity.CreateReplyActivity(ActivityTypes.Message, replyText); + await botApp.SendActivityAsync(replyActivity, cancellationToken); +}; + +webApp.Run(); \ No newline at end of file diff --git a/core/samples/CoreBot/appsettings.json b/core/samples/CoreBot/appsettings.json new file mode 100644 index 00000000..169ecf5b --- /dev/null +++ b/core/samples/CoreBot/appsettings.json @@ -0,0 +1,11 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning", + "Microsoft.Bot.Core": "Trace" + } + }, + "AllowedHosts": "*", + "Urls": "http://localhost:3978" +} diff --git a/core/samples/Proactive/Proactive.csproj b/core/samples/Proactive/Proactive.csproj new file mode 100644 index 00000000..4a3268bc --- /dev/null +++ b/core/samples/Proactive/Proactive.csproj @@ -0,0 +1,17 @@ + + + + net8.0 + enable + enable + dotnet-Proactive-c4e4dec1-3f04-4738-9acf-33e72d1a339f + + + + + + + + + + diff --git a/core/samples/Proactive/Program.cs b/core/samples/Proactive/Program.cs new file mode 100644 index 00000000..5f16887d --- /dev/null +++ b/core/samples/Proactive/Program.cs @@ -0,0 +1,10 @@ +using Microsoft.Bot.Core.Hosting; + +using Proactive; + +var builder = Host.CreateApplicationBuilder(args); +builder.Services.AddBotApplicationClients(); +builder.Services.AddHostedService(); + +var host = builder.Build(); +host.Run(); diff --git a/core/samples/Proactive/Worker.cs b/core/samples/Proactive/Worker.cs new file mode 100644 index 00000000..8a4251ce --- /dev/null +++ b/core/samples/Proactive/Worker.cs @@ -0,0 +1,31 @@ +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Schema; + +namespace Proactive; + +public class Worker(ConversationClient conversationClient, ILogger logger) : BackgroundService +{ + const string ConversationId = "a:17vxw6pGQOb3Zfh8acXT8m_PqHycYpaFgzu2mFMUfkT-h0UskMctq5ZPPc7FIQxn2bx7rBSm5yE_HeUXsCcKZBrv77RgorB3_1_pAdvMhi39ClxQgawzyQ9GBFkdiwOxT"; + + protected override async Task ExecuteAsync(CancellationToken stoppingToken) + { + while (!stoppingToken.IsCancellationRequested) + { + if (logger.IsEnabled(LogLevel.Information)) + { + CoreActivity proactiveMessage = new() + { + Text = $"Proactive hello at {DateTimeOffset.Now}", + ServiceUrl = new Uri("https://smba.trafficmanager.net/amer/56653e9d-2158-46ee-90d7-675c39642038/"), + Conversation = new() + { + Id = ConversationId + } + }; + var aid = await conversationClient.SendActivityAsync(proactiveMessage, stoppingToken); + logger.LogInformation("Activity {Aid} sent", aid); + } + await Task.Delay(1000, stoppingToken); + } + } +} diff --git a/core/samples/Proactive/appsettings.json b/core/samples/Proactive/appsettings.json new file mode 100644 index 00000000..e258d268 --- /dev/null +++ b/core/samples/Proactive/appsettings.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Warning", + "Microsoft.Bot.Core": "Information" + } + } +} diff --git a/core/samples/scenarios/Properties/launchSettings.example.json b/core/samples/scenarios/Properties/launchSettings.example.json new file mode 100644 index 00000000..5ef4cff2 --- /dev/null +++ b/core/samples/scenarios/Properties/launchSettings.example.json @@ -0,0 +1,20 @@ +{ + "$schema": "http://json.schemastore.org/launchsettings.json", + "profiles": { + "ridobotlocal": { + "commandName": "Project", + "dotnetRunMessages": true, + "applicationUrl": "http://localhost:3978", + "environmentVariables": { + "DOTNET_ENVIRONMENT": "Development", + "AzureAd__Instance": "https://login.microsoftonline.com/", + "AzureAd__ClientId": "", + "AzureAd__TenantId": "", + "AzureAd__ClientCredentials__0__SourceType": "ClientSecret", + "AzureAd__ClientCredentials__0__ClientSecret": "", + "Logging__LogLevel__Default": "Warning", + "Logging__LogLevel__Microsoft.Bot": "Information", + } + } + } +} diff --git a/core/samples/scenarios/middleware.cs b/core/samples/scenarios/middleware.cs new file mode 100755 index 00000000..71b65d52 --- /dev/null +++ b/core/samples/scenarios/middleware.cs @@ -0,0 +1,34 @@ +#!/usr/bin/dotnet run + +#:sdk Microsoft.NET.Sdk.Web + +#:project ../../src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj + +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Schema; +using Microsoft.Bot.Core.Hosting; + + +WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddBotApplication(); +WebApplication webApp = webAppBuilder.Build(); +var botApp = webApp.UseBotApplication(); + +botApp.Use(new MyTurnMiddleWare()); + +botApp.OnActivity = async (activity, cancellationToken) => +{ + var replyActivity = activity.CreateReplyActivity("You said " + activity.Text); + await botApp.SendActivityAsync(replyActivity, cancellationToken); +}; + +webApp.Run(); + +public class MyTurnMiddleWare : ITurnMiddleWare +{ + public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn next, CancellationToken cancellationToken = default) + { + Console.WriteLine($"MIDDLEWARE: Processing activity {activity.Type} {activity.Id}"); + return next(cancellationToken); + } +} \ No newline at end of file diff --git a/core/samples/scenarios/proactive.cs b/core/samples/scenarios/proactive.cs new file mode 100644 index 00000000..f489928a --- /dev/null +++ b/core/samples/scenarios/proactive.cs @@ -0,0 +1,43 @@ +#!/usr/bin/dotnet run + +#:sdk Microsoft.NET.Sdk.Worker + +#:project ../../src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj + +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Schema; + +var builder = Host.CreateApplicationBuilder(args); +builder.Services.AddBotApplicationClients(); +builder.Services.AddHostedService(); + +var host = builder.Build(); +host.Run(); + +public class Worker(ConversationClient conversationClient, ILogger logger) : BackgroundService +{ + const string conversationId = "a:17vxw6pGQOb3Zfh8acXT8m_PqHycYpaFgzu2mFMUfkT-h0UskMctq5ZPPc7FIQxn2bx7rBSm5yE_HeUXsCcKZBrv77RgorB3_1_pAdvMhi39ClxQgawzyQ9GBFkdiwOxT"; + + protected override async Task ExecuteAsync(CancellationToken stoppingToken) + { + while (!stoppingToken.IsCancellationRequested) + { + if (logger.IsEnabled(LogLevel.Information)) + { + CoreActivity proactiveMessage = new() + { + Text = $"Proactive hello at {DateTimeOffset.Now}", + ServiceUrl = new Uri("https://smba.trafficmanager.net/amer/56653e9d-2158-46ee-90d7-675c39642038/"), + Conversation = new() + { + Id = conversationId + } + }; + var aid = await conversationClient.SendActivityAsync(proactiveMessage, stoppingToken); + logger.LogInformation($"Activity {aid} sent"); + } + await Task.Delay(1000, stoppingToken); + } + } +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs new file mode 100644 index 00000000..49de652b --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs @@ -0,0 +1,27 @@ +using System.Text; + +using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; +using Microsoft.Bot.Core.Schema; +using Microsoft.Bot.Schema; + +using Newtonsoft.Json; + +namespace Microsoft.Bot.Core.Compat; + +internal static class CompatActivity +{ + public static Activity ToCompatActivity(this CoreActivity activity) + { + using JsonTextReader reader = new(new StringReader(activity.ToJson())); + return BotMessageHandlerBase.BotMessageSerializer.Deserialize(reader)!; + } + + public static CoreActivity FromCompatActivity(this Activity activity) + { + StringBuilder sb = new(); + using StringWriter stringWriter = new(sb); + using JsonTextWriter json = new(stringWriter); + BotMessageHandlerBase.BotMessageSerializer.Serialize(json, activity); + return CoreActivity.FromJsonString(sb.ToString()); + } +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs new file mode 100644 index 00000000..fdab68e2 --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs @@ -0,0 +1,116 @@ +using Microsoft.AspNetCore.Http; +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Core.Schema; +using Microsoft.Bot.Schema; + + +namespace Microsoft.Bot.Core.Compat; + +/// +/// Provides a compatibility adapter for processing bot activities and HTTP requests using legacy middleware and bot +/// framework interfaces. +/// +/// Use this adapter to bridge between legacy bot framework middleware and newer bot application models. +/// The adapter allows registration of middleware and error handling delegates, and supports processing HTTP requests +/// and continuing conversations. Thread safety is not guaranteed; instances should not be shared across concurrent +/// requests. +/// The bot application instance that handles activity processing and manages user token operations. +/// The underlying bot adapter used to interact with the bot framework and create turn contexts. +public class CompatAdapter(BotApplication botApplication, CompatBotAdapter compatBotAdapter) : IBotFrameworkHttpAdapter +{ + /// + /// Gets the collection of middleware components configured for the application. + /// + /// Use this property to access or inspect the set of middleware that will be invoked during + /// request processing. The returned collection is read-only and reflects the current middleware pipeline. + public MiddlewareSet MiddlewareSet { get; } = new MiddlewareSet(); + + /// + /// Gets or sets the error handling callback to be invoked when an exception occurs during a turn. + /// + /// Assign a delegate to customize how errors are handled within the bot's turn processing. The + /// callback receives the current turn context and the exception that was thrown. If not set, unhandled exceptions + /// may propagate and result in default error behavior. This property is typically used to log errors, send + /// user-friendly messages, or perform cleanup actions. + public Func? OnTurnError { get; set; } + + /// + /// Adds the specified middleware to the adapter's processing pipeline. + /// + /// The middleware component to be invoked during request processing. Cannot be null. + /// The current instance, enabling method chaining. + public CompatAdapter Use(Builder.IMiddleware middleware) + { + MiddlewareSet.Use(middleware); + return this; + } + + /// + /// Processes an incoming HTTP request and generates an appropriate HTTP response using the provided bot instance. + /// + /// + /// + /// + /// + /// + public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpResponse, IBot bot, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(httpRequest); + ArgumentNullException.ThrowIfNull(bot); + + CoreActivity? activity = null; + botApplication.OnActivity = (activity, cancellationToken1) => + { + using TurnContext turnContext = new(compatBotAdapter, activity.ToCompatActivity()); + //turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); + return bot.OnTurnAsync(turnContext, cancellationToken1); + }; + try + { + foreach (Builder.IMiddleware? middleware in MiddlewareSet) + { + botApplication.Use(new CompatMiddlewareAdapter(middleware)); + } + + activity = await botApplication.ProcessAsync(httpRequest.HttpContext, cancellationToken).ConfigureAwait(false); + } + catch (Exception ex) + { + if (OnTurnError != null) + { + if (ex is BotHandlerException aex) + { + activity = aex.Activity; + using TurnContext turnContext = new(compatBotAdapter, activity!.ToCompatActivity()); + await OnTurnError(turnContext, ex).ConfigureAwait(false); + } + else + { + throw; + } + } + } + } + + /// + /// Continues an existing bot conversation by invoking the specified callback with the provided conversation + /// reference. + /// + /// Use this method to resume a conversation at a specific point, such as in response to an event + /// or proactive message. The callback is executed within the context of the continued conversation. + /// The unique identifier of the bot participating in the conversation. + /// A reference to the conversation to continue. Must not be null. + /// A delegate that handles the bot logic for the continued conversation. The callback receives a turn context and + /// cancellation token. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. + public async Task ContinueConversationAsync(string botId, ConversationReference reference, BotCallbackHandler callback, CancellationToken cancellationToken) + { + ArgumentNullException.ThrowIfNull(reference); + ArgumentNullException.ThrowIfNull(callback); + + using TurnContext turnContext = new(compatBotAdapter, reference.GetContinuationActivity()); + await callback(turnContext, cancellationToken).ConfigureAwait(false); + } +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs new file mode 100644 index 00000000..b2348a89 --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs @@ -0,0 +1,67 @@ +using Microsoft.Bot.Builder; +using Microsoft.Bot.Core.Schema; +using Microsoft.Bot.Schema; + + +namespace Microsoft.Bot.Core.Compat; + +/// +/// Provides a Bot Framework adapter that enables compatibility between the Bot Framework SDK and a custom bot +/// application implementation. +/// +/// Use this adapter to bridge Bot Framework turn contexts and activities with a custom bot application. +/// This class is intended for scenarios where integration with non-standard bot runtimes or legacy systems is +/// required. +/// The bot application instance used to process and send activities within the adapter. +public class CompatBotAdapter(BotApplication botApplication) : BotAdapter +{ + /// + /// Deletes an activity from the conversation. + /// + /// + /// + /// + /// + /// + public override Task DeleteActivityAsync(ITurnContext turnContext, ConversationReference reference, CancellationToken cancellationToken) + { + throw new NotImplementedException(); + } + + /// + /// Sends a set of activities to the conversation. + /// + /// + /// + /// + /// + public override async Task SendActivitiesAsync(ITurnContext turnContext, Activity[] activities, CancellationToken cancellationToken) + { + ArgumentNullException.ThrowIfNull(activities); + + ResourceResponse[] responses = new ResourceResponse[1]; + for (int i = 0; i < activities.Length; i++) + { + CoreActivity a = activities[i].FromCompatActivity(); + + string resp = await botApplication.SendActivityAsync(a, cancellationToken).ConfigureAwait(false); + responses[i] = new ResourceResponse(id: resp); + } + return responses; + } + + /// + /// Updates an existing activity in the conversation. + /// + /// + /// + /// + /// + /// + public override Task UpdateActivityAsync(ITurnContext turnContext, Activity activity, CancellationToken cancellationToken) + { + throw new NotImplementedException(); + } + + +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs b/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs new file mode 100644 index 00000000..f0432ad9 --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs @@ -0,0 +1,47 @@ +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; + +namespace Microsoft.Bot.Core.Compat; + +/// +/// Provides extension methods for registering compatibility adapters and related services to support legacy bot hosting +/// scenarios. +/// +/// These extension methods simplify the integration of compatibility adapters into modern hosting +/// environments by adding required services to the dependency injection container. Use these methods to enable legacy +/// bot functionality within applications built on the current hosting model. +public static class CompatHostingExtensions +{ + /// + /// Adds compatibility adapter services to the application's dependency injection container. + /// + /// This method registers services required for compatibility scenarios. It can be called + /// multiple times without adverse effects. + /// The host application builder to which the compatibility adapter services will be added. Cannot be null. + /// The same instance, enabling method chaining. + public static IHostApplicationBuilder AddCompatAdapter(this IHostApplicationBuilder builder) + { + ArgumentNullException.ThrowIfNull(builder); + builder.Services.AddCompatAdapter(); + return builder; + } + + /// + /// Registers the compatibility bot adapter and related services required for Bot Framework HTTP integration with + /// the application's dependency injection container. + /// + /// Call this method during application startup to enable Bot Framework HTTP endpoint support + /// using the compatibility adapter. This method should be invoked before building the service provider. + /// The service collection to which the compatibility adapter and related services will be added. Must not be null. + /// The same instance provided in , with the + /// compatibility adapter and related services registered. + public static IServiceCollection AddCompatAdapter(this IServiceCollection services) + { + services.AddBotApplication(); + services.AddSingleton(); + services.AddSingleton(); + return services; + } +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs new file mode 100644 index 00000000..298d295b --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs @@ -0,0 +1,14 @@ +using Microsoft.Bot.Builder; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core.Compat; + +internal sealed class CompatMiddlewareAdapter(IMiddleware bfMiddleWare) : ITurnMiddleWare +{ + public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) + { + using TurnContext turnContext = new(new CompatBotAdapter(botApplication), activity.ToCompatActivity()); + return bfMiddleWare.OnTurnAsync(turnContext, (activity) + => nextTurn(cancellationToken), cancellationToken); + } +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj b/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj new file mode 100644 index 00000000..51a12ef7 --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj @@ -0,0 +1,14 @@ + + + + net8.0;net10.0 + enable + enable + + + + + + + + diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs new file mode 100644 index 00000000..66c43b07 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -0,0 +1,132 @@ + + +using Microsoft.AspNetCore.Http; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.Logging; + +namespace Microsoft.Bot.Core; + +/// +/// Represents a bot application. +/// +public class BotApplication +{ + private readonly ILogger _logger; + private readonly ConversationClient? _conversationClient; + private readonly string _serviceKey; + internal TurnMiddleware MiddleWare { get; } + + /// + /// Initializes a new instance of the BotApplication class with the specified conversation client, configuration, + /// logger, and optional service key. + /// + /// This constructor sets up the bot application and starts the bot listener using the provided + /// configuration and service key. The service key is used to locate authentication credentials in the + /// configuration. + /// The client used to manage and interact with conversations for the bot. + /// The application configuration settings used to retrieve environment variables and service credentials. + /// The logger used to record operational and diagnostic information for the bot application. + /// The configuration key identifying the authentication service. Defaults to "AzureAd" if not specified. + [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] + public BotApplication(ConversationClient conversationClient, IConfiguration config, ILogger logger, string serviceKey = "AzureAd") + { + _logger = logger; + _serviceKey = serviceKey; + MiddleWare = new TurnMiddleware(); + _conversationClient = conversationClient; + logger.LogInformation("Started bot listener on {Port} for AppID:{AppId} with SDK version {SdkVersion}", config?["ASPNETCORE_URLS"], config?[$"{_serviceKey}:ClientId"], Version); + } + + + /// + /// Gets the client used to manage and interact with conversations. + /// + /// Accessing this property before the client is initialized will result in an exception. Ensure + /// that the client is properly configured before use. + public ConversationClient ConversationClient => _conversationClient ?? throw new InvalidOperationException("ConversationClient not initialized"); + + /// + /// Gets or sets the delegate that is invoked to handle an incoming activity asynchronously. + /// + /// Assign a delegate to process activities as they are received. The delegate should accept an + /// and a , and return a representing the + /// asynchronous operation. If , incoming activities will not be handled. + public Func? OnActivity { get; set; } + + /// + /// Processes an incoming HTTP request containing a bot activity. + /// + /// + /// + /// + /// + /// + [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] + public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(httpContext); + ArgumentNullException.ThrowIfNull(_conversationClient); + + + CoreActivity activity = await CoreActivity.FromJsonStreamAsync(httpContext.Request.Body, cancellationToken).ConfigureAwait(false) ?? throw new InvalidOperationException("Invalid Activity"); + + if (_logger.IsEnabled(LogLevel.Trace)) + { + _logger.LogTrace("Received activity: {Activity}", activity.ToJson()); + } + + AgenticIdentity? agenticIdentity = AgenticIdentity.FromProperties(activity.Recipient.Properties); + _conversationClient.AgenticIdentity = agenticIdentity; + + using (_logger.BeginScope("Processing activity {Type} {Id}", activity.Type, activity.Id)) + { + try + { + await MiddleWare.RunPipelineAsync(this, activity, this.OnActivity, 0, cancellationToken).ConfigureAwait(false); + } + catch (Exception ex) + { + _logger.LogError(ex, "Error processing activity {Type} {Id}", activity.Type, activity.Id); + throw new BotHandlerException("Error processing activity", ex, activity); + } + finally + { + _logger.LogInformation("Finished processing activity {Type} {Id}", activity.Type, activity.Id); + } + return activity; + } + } + + /// + /// Adds the specified turn middleware to the middleware pipeline. + /// + /// The middleware component to add to the pipeline. Cannot be null. + /// An ITurnMiddleWare instance representing the updated middleware pipeline. + public ITurnMiddleWare Use(ITurnMiddleWare middleware) + { + MiddleWare.Use(middleware); + return MiddleWare; + } + + /// + /// Sends the specified activity to the conversation asynchronously. + /// + /// The activity to send to the conversation. Cannot be null. + /// A cancellation token that can be used to cancel the send operation. + /// A task that represents the asynchronous operation. The task result contains the identifier of the sent activity. + /// Thrown if the conversation client has not been initialized. + public async Task SendActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentNullException.ThrowIfNull(_conversationClient, "ConversationClient not initialized"); + + return await _conversationClient.SendActivityAsync(activity, cancellationToken).ConfigureAwait(false); + } + + /// + /// Gets the version of the SDK. + /// + public static string Version => ThisAssembly.NuGetPackageVersion; +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/BotHandlerException.cs b/core/src/Microsoft.Bot.Core/BotHandlerException.cs new file mode 100644 index 00000000..5d5b5ce6 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/BotHandlerException.cs @@ -0,0 +1,53 @@ + +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core; + +/// +/// Represents errors that occur during bot activity processing and provides context about the associated activity. +/// +/// Use this exception to capture and propagate errors that occur during bot activity handling, along +/// with contextual information about the activity involved. This can aid in debugging and error reporting +/// scenarios. +public class BotHandlerException : Exception +{ + /// + /// Initializes a new instance of the class. + /// + public BotHandlerException() + { + } + + /// + /// Initializes a new instance of the class with a specified error message. + /// + /// The error message that describes the reason for the exception. + public BotHandlerException(string message) : base(message) + { + } + + /// + /// Initializes a new instance of the class with a specified error message and inner exception. + /// + /// The error message that describes the reason for the exception. + /// The underlying exception that caused this exception, or null if no inner exception is specified. + public BotHandlerException(string message, Exception innerException) : base(message, innerException) + { + } + + /// + /// Initializes a new instance of the class with a specified error message, inner exception, and activity. + /// + /// The error message that describes the reason for the exception. + /// The underlying exception that caused this exception, or null if no inner exception is specified. + /// The bot activity associated with the error. Cannot be null. + public BotHandlerException(string message, Exception innerException, CoreActivity activity) : base(message, innerException) + { + Activity = activity; + } + + /// + /// Accesses the bot activity associated with the exception. + /// + public CoreActivity? Activity { get; } +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs new file mode 100644 index 00000000..4ea434f7 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -0,0 +1,51 @@ +using System.Net.Http.Json; + +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core; + +/// +/// Provides methods for sending activities to a conversation endpoint using HTTP requests. +/// +/// The HTTP client instance used to send requests to the conversation service. Must not be null. +public class ConversationClient(HttpClient httpClient) +{ + internal const string ConversationHttpClientName = "BotConversationClient"; + + internal AgenticIdentity? AgenticIdentity { get; set; } + + /// + /// Sends the specified activity to the conversation endpoint asynchronously. + /// + /// The activity to send. Cannot be null. The activity must contain valid conversation and service URL information. + /// A cancellation token that can be used to cancel the send operation. + /// A task that represents the asynchronous operation. The task result contains the response content as a string if + /// the activity is sent successfully. + /// Thrown if the activity could not be sent successfully. The exception message includes the HTTP status code and + /// response content. + public async Task SendActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentNullException.ThrowIfNull(activity.Conversation); + ArgumentNullException.ThrowIfNullOrWhiteSpace(activity.Conversation.Id); + ArgumentNullException.ThrowIfNull(activity.ServiceUrl); + + using HttpRequestMessage request = new( + HttpMethod.Post, + $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{activity.Conversation.Id}/activities/") + { + Content = JsonContent.Create(activity, options: CoreActivity.DefaultJsonOptions), + }; + + request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity); + + using HttpResponseMessage resp = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); + + string respContent = await resp.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); + + return resp.IsSuccessStatusCode ? + respContent : + throw new HttpRequestException($"Error sending activity: {resp.StatusCode} - {respContent}"); + } +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs deleted file mode 100644 index f03200ee..00000000 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplication.cs +++ /dev/null @@ -1,5 +0,0 @@ -namespace Microsoft.Bot.Core.Hosting; - -//internal class AddBotApplication -//{ -//} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs new file mode 100644 index 00000000..725eea84 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -0,0 +1,116 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Http; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Identity.Abstractions; +using Microsoft.Identity.Web; +using Microsoft.Identity.Web.TokenCacheProviders.InMemory; + +namespace Microsoft.Bot.Core.Hosting; + +/// +/// Provides extension methods for registering bot application clients and related authentication services with the +/// dependency injection container. +/// +/// This class is intended to be used during application startup to configure HTTP clients, token +/// acquisition, and agent identity services required for bot-to-bot communication. The configuration section specified +/// by the Azure Active Directory (AAD) configuration name is used to bind authentication options. Typically, these +/// methods are called in the application's service configuration pipeline. +public static class AddBotApplicationExtensions +{ + + /// + /// Configures the application to handle bot messages at the specified route and returns the registered bot + /// application instance. + /// + /// This method adds authentication and authorization middleware to the request pipeline and maps + /// a POST endpoint for bot messages. The endpoint requires authorization. Ensure that the bot application is + /// registered in the service container before calling this method. + /// The type of the bot application to use. Must inherit from BotApplication. + /// The application builder used to configure the request pipeline. + /// The route path at which to listen for incoming bot messages. Defaults to "api/messages". + /// The registered bot application instance of type TApp. + /// Thrown if the bot application of type TApp is not registered in the application's service container. + public static TApp UseBotApplication( + this IApplicationBuilder builder, + string routePath = "api/messages") + where TApp : BotApplication + { + ArgumentNullException.ThrowIfNull(builder); + WebApplication? webApp = builder as WebApplication; + TApp app = builder.ApplicationServices.GetService() ?? throw new InvalidOperationException("Application not registered"); + + webApp?.MapPost(routePath, async (HttpContext httpContext, CancellationToken cancellationToken) => + { + CoreActivity resp = await app.ProcessAsync(httpContext, cancellationToken).ConfigureAwait(false); + return resp.Id; + }); + + return app; + } + + /// + /// Adds a bot application to the service collection. + /// + /// + /// + /// + public static IServiceCollection AddBotApplication(this IServiceCollection services) where TApp : BotApplication + { + services.AddBotApplicationClients(); + services.AddSingleton(); + return services; + } + + /// + /// Adds and configures Bot Framework application clients and related authentication services to the specified + /// service collection. + /// + /// This method registers HTTP clients, token acquisition, in-memory token caching, and agent + /// identity services required for Bot Framework integration. It also configures authentication options using the + /// specified Azure AD configuration section. The method should be called during application startup as part of + /// service configuration. + /// The service collection to which the Bot Framework clients and authentication services will be added. Must not be + /// null. + /// The name of the configuration section containing Azure Active Directory settings. Defaults to "AzureAd" if not + /// specified. + /// The same service collection instance, enabling method chaining. + public static IServiceCollection AddBotApplicationClients(this IServiceCollection services, string aadConfigSectionName = "AzureAd") + { + IConfiguration configuration = services.BuildServiceProvider().GetRequiredService(); + services + .AddHttpClient() + .AddTokenAcquisition(true) + .AddInMemoryTokenCaches() + .AddAgentIdentities(); + + services.Configure(aadConfigSectionName, configuration.GetSection(aadConfigSectionName)); + + string agentScope = configuration[$"{aadConfigSectionName}:Scope"] ?? "https://api.botframework.com/.default"; + + if (configuration.GetSection(aadConfigSectionName).Get() is null) + { +#pragma warning disable CA1848 // Use the LoggerMessage delegates + services.BuildServiceProvider().GetRequiredService() + .CreateLogger("AddBotApplicationExtensions") + .LogWarning("No configuration found for section {AadConfigSectionName}. BotAuthenticationHandler will not be configured.", aadConfigSectionName); +#pragma warning restore CA1848 // Use the LoggerMessage delegates + + services.AddHttpClient(ConversationClient.ConversationHttpClientName); + + } + else + { + services.AddHttpClient(ConversationClient.ConversationHttpClientName) + .AddHttpMessageHandler(sp => new BotAuthenticationHandler( + sp.GetRequiredService(), + sp.GetRequiredService>(), + agentScope, + aadConfigSectionName)); + } + + return services; + } +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs new file mode 100644 index 00000000..412ea6f0 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -0,0 +1,126 @@ +using System.Net.Http.Headers; + +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Logging; +using Microsoft.Identity.Abstractions; +using Microsoft.Identity.Web; + +namespace Microsoft.Bot.Core.Hosting; + + +/// +/// Represents an agentic identity for user-delegated token acquisition. +/// +internal sealed class AgenticIdentity +{ + public string? AgenticAppId { get; set; } + public string? AgenticUserId { get; set; } + public string? AgenticAppBlueprintId { get; set; } + + public static AgenticIdentity? FromProperties(ExtendedPropertiesDictionary? properties) + { + if (properties is null) + { + return null; + } + + properties.TryGetValue("agenticAppId", out object? appIdObj); + properties.TryGetValue("agenticUserId", out object? userIdObj); + properties.TryGetValue("agenticAppBlueprintId", out object? bluePrintObj); + return new AgenticIdentity + { + AgenticAppId = appIdObj?.ToString(), + AgenticUserId = userIdObj?.ToString(), + AgenticAppBlueprintId = bluePrintObj?.ToString() + }; + } +} + +/// +/// HTTP message handler that automatically acquires and attaches authentication tokens +/// for Bot Framework API calls. Supports both app-only and agentic (user-delegated) token acquisition. +/// +/// +/// Initializes a new instance of the class. +/// +/// The authorization header provider for acquiring tokens. +/// The logger instance. +/// The scope for the token request. +/// The configuration section name for Azure AD settings. +internal sealed class BotAuthenticationHandler( + IAuthorizationHeaderProvider authorizationHeaderProvider, + ILogger logger, + string scope, + string aadConfigSectionName = "AzureAd") : DelegatingHandler +{ + private readonly IAuthorizationHeaderProvider _authorizationHeaderProvider = authorizationHeaderProvider ?? throw new ArgumentNullException(nameof(authorizationHeaderProvider)); + private readonly ILogger _logger = logger ?? throw new ArgumentNullException(nameof(logger)); + private readonly string _scope = scope ?? throw new ArgumentNullException(nameof(scope)); + private readonly string _aadConfigSectionName = aadConfigSectionName ?? throw new ArgumentNullException(nameof(aadConfigSectionName)); + + private static readonly Action LogAcquiringAgenticToken = + LoggerMessage.Define( + LogLevel.Debug, + new EventId(1, nameof(LogAcquiringAgenticToken)), + "Acquiring agentic token for appId: {AgenticAppId}, userId: {AgenticUserId}"); + + private static readonly Action LogAcquiringAppOnlyToken = + LoggerMessage.Define( + LogLevel.Debug, + new EventId(2, nameof(LogAcquiringAppOnlyToken)), + "Acquiring app-only token for scope: {Scope}"); + + /// + /// Key used to store the agentic identity in HttpRequestMessage options. + /// + public static readonly HttpRequestOptionsKey AgenticIdentityKey = new("AgenticIdentity"); + + /// + protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) + { + request.Options.TryGetValue(AgenticIdentityKey, out AgenticIdentity? agenticIdentity); + + string token = await GetAuthorizationHeaderAsync(agenticIdentity, cancellationToken).ConfigureAwait(false); + + string tokenValue = token.StartsWith("Bearer ", StringComparison.OrdinalIgnoreCase) + ? token["Bearer ".Length..] + : token; + + request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", tokenValue); + + return await base.SendAsync(request, cancellationToken).ConfigureAwait(false); + } + + /// + /// Gets an authorization header for Bot Framework API calls. + /// Supports both app-only and agentic (user-delegated) token acquisition. + /// + /// Optional agentic identity for user-delegated token acquisition. If not provided, acquires an app-only token. + /// Cancellation token. + /// The authorization header value. + private async Task GetAuthorizationHeaderAsync(AgenticIdentity? agenticIdentity, CancellationToken cancellationToken) + { + AuthorizationHeaderProviderOptions options = new() + { + AcquireTokenOptions = new AcquireTokenOptions() + { + AuthenticationOptionsName = _aadConfigSectionName, + } + }; + + if (agenticIdentity is not null && + !string.IsNullOrEmpty(agenticIdentity.AgenticAppId) && + !string.IsNullOrEmpty(agenticIdentity.AgenticUserId)) + { + LogAcquiringAgenticToken(_logger, agenticIdentity.AgenticAppId, agenticIdentity.AgenticUserId, null); + + options.WithAgentUserIdentity(agenticIdentity.AgenticAppId, Guid.Parse(agenticIdentity.AgenticUserId)); + string token = await _authorizationHeaderProvider.CreateAuthorizationHeaderAsync([_scope], options, null, cancellationToken).ConfigureAwait(false); + return token; + } + + LogAcquiringAppOnlyToken(_logger, _scope, null); + string appToken = await _authorizationHeaderProvider.CreateAuthorizationHeaderForAppAsync(_scope, options, cancellationToken).ConfigureAwait(false); + return appToken; + } +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs new file mode 100644 index 00000000..cdea8ff2 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs @@ -0,0 +1,31 @@ +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core; + +/// +/// Represents a delegate that invokes the next middleware component in the pipeline asynchronously. +/// +/// This delegate is typically used in middleware scenarios to advance the request processing pipeline. +/// The cancellation token should be observed to support cooperative cancellation. +/// A cancellation token that can be used to cancel the asynchronous operation. +/// A task that represents the completion of the middleware invocation. +public delegate Task NextTurn(CancellationToken cancellationToken); + +/// +/// Defines a middleware component that can process or modify activities during a bot turn. +/// +/// Implement this interface to add custom logic before or after the bot processes an activity. +/// Middleware can perform tasks such as logging, authentication, or altering activities. Multiple middleware components +/// can be chained together; each should call the nextTurn delegate to continue the pipeline. +public interface ITurnMiddleWare +{ + /// + /// Triggers the middleware to process an activity during a bot turn. + /// + /// + /// + /// + /// + /// + Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default); +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs index fdea51ca..9f4a0ee8 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs @@ -8,11 +8,13 @@ /// messaging channel. The properties dictionary allows channels to include additional metadata /// that is not part of the standard activity schema. /// -public class ChannelData() +public class ChannelData { /// /// Gets the extension data dictionary for storing channel-specific properties. /// [JsonExtensionData] - public ExtendedPropertiesDictionary Properties { get; init; } = []; +#pragma warning disable CA2227 // Collection properties should be read only + public ExtendedPropertiesDictionary Properties { get; set; } = []; +#pragma warning restore CA2227 // Collection properties should be read only } \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs index c06c608a..2c4ae050 100644 --- a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs +++ b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs @@ -9,11 +9,13 @@ public class Conversation() /// Gets or sets the unique identifier for the object. /// [JsonPropertyName("id")] - public string? Id { get; set; } + public string Id { get; set; } = string.Empty; /// /// Gets the extension data dictionary for storing additional properties not defined in the schema. /// [JsonExtensionData] - public ExtendedPropertiesDictionary Properties { get; init; } = []; +#pragma warning disable CA2227 // Collection properties should be read only + public ExtendedPropertiesDictionary Properties { get; set; } = []; +#pragma warning restore CA2227 // Collection properties should be read only } \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs index b67e591e..212a6e2b 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs @@ -25,5 +25,7 @@ public class ConversationAccount() /// Gets the extension data dictionary for storing additional properties not defined in the schema. /// [JsonExtensionData] - public ExtendedPropertiesDictionary Properties { get; init; } = []; +#pragma warning disable CA2227 // Collection properties should be read only + public ExtendedPropertiesDictionary Properties { get; set; } = []; +#pragma warning restore CA2227 // Collection properties should be read only } \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs index 7c996ae4..ecc17331 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs @@ -15,6 +15,7 @@ public class ExtendedPropertiesDictionary : Dictionary { } /// This class provides the foundational structure for bot activities including message exchanges, /// conversation updates, and other bot-related events. It supports serialization to and from JSON /// and includes extension properties for channel-specific data. +/// Follows the Activity Protocol Specification: https://github.com/microsoft/Agents/blob/main/specs/activity/protocol-activity.md /// public class CoreActivity(string type = ActivityTypes.Message) { @@ -36,7 +37,7 @@ public class CoreActivity(string type = ActivityTypes.Message) /// /// Gets or sets the unique identifier for the activity. /// - [JsonPropertyName("id")] public string Id { get; set; } = string.Empty; + [JsonPropertyName("id")] public string? Id { get; set; } /// /// Gets or sets the URL of the service endpoint for this activity. /// @@ -70,12 +71,26 @@ public class CoreActivity(string type = ActivityTypes.Message) /// /// Gets the extension data dictionary for storing additional properties not defined in the schema. /// - [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; init; } = []; +#pragma warning disable CA2227 // Collection properties should be read only + [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; +#pragma warning restore CA2227 // Collection properties should be read only /// /// Gets the default JSON serializer options used for serializing and deserializing activities. /// - public static readonly JsonSerializerOptions DefaultJsonOptions = new() + /// + /// Uses the source-generated JSON context for AOT-compatible serialization. + /// + public static readonly JsonSerializerOptions DefaultJsonOptions = CoreActivityJsonContext.Default.Options; + + /// + /// Gets the JSON serializer options used for reflection-based serialization of extended activity types. + /// + /// + /// Uses reflection-based serialization to support custom activity types that extend CoreActivity. + /// This is used when serializing/deserializing types not registered in the source-generated context. + /// + private static readonly JsonSerializerOptions ReflectionJsonOptions = new() { WriteIndented = true, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, @@ -86,7 +101,7 @@ public class CoreActivity(string type = ActivityTypes.Message) /// Serializes the current activity to a JSON string. /// /// A JSON string representation of the activity. - public string ToJson() => JsonSerializer.Serialize(this, DefaultJsonOptions); + public string ToJson() => JsonSerializer.Serialize(this, CoreActivityJsonContext.Default.CoreActivity); /// /// Serializes the specified activity instance to a JSON string using the default serialization options. @@ -97,7 +112,7 @@ public class CoreActivity(string type = ActivityTypes.Message) /// The activity instance to serialize. Cannot be null. /// A JSON string representation of the specified activity instance. public static string ToJson(T instance) where T : CoreActivity - => JsonSerializer.Serialize(instance, DefaultJsonOptions); + => JsonSerializer.Serialize(instance, ReflectionJsonOptions); /// /// Deserializes a JSON string into a object. @@ -105,7 +120,7 @@ public static string ToJson(T instance) where T : CoreActivity /// The JSON string to deserialize. /// A instance. public static CoreActivity FromJsonString(string json) - => JsonSerializer.Deserialize(json, DefaultJsonOptions)!; + => JsonSerializer.Deserialize(json, CoreActivityJsonContext.Default.CoreActivity)!; /// /// Deserializes the specified JSON string to an object of type T. @@ -116,7 +131,7 @@ public static CoreActivity FromJsonString(string json) /// The JSON string to deserialize. Cannot be null or empty. /// An instance of type T that represents the deserialized JSON data. public static T FromJsonString(string json) where T : CoreActivity - => JsonSerializer.Deserialize(json, DefaultJsonOptions)!; + => JsonSerializer.Deserialize(json, ReflectionJsonOptions)!; /// /// Asynchronously deserializes a JSON stream into a object. @@ -125,7 +140,7 @@ public static T FromJsonString(string json) where T : CoreActivity /// A cancellation token to cancel the operation. /// A task that represents the asynchronous operation. The task result contains the deserialized instance, or null if deserialization fails. public static ValueTask FromJsonStreamAsync(Stream stream, CancellationToken cancellationToken = default) - => JsonSerializer.DeserializeAsync(stream, DefaultJsonOptions, cancellationToken); + => JsonSerializer.DeserializeAsync(stream, CoreActivityJsonContext.Default.CoreActivity, cancellationToken); /// /// Asynchronously deserializes a JSON value from the specified stream into an instance of type T. @@ -139,22 +154,23 @@ public static T FromJsonString(string json) where T : CoreActivity /// A ValueTask that represents the asynchronous operation. The result contains an instance of type T if /// deserialization is successful; otherwise, null. public static ValueTask FromJsonStreamAsync(Stream stream, CancellationToken cancellationToken = default) where T : CoreActivity - => JsonSerializer.DeserializeAsync(stream, DefaultJsonOptions, cancellationToken); + => JsonSerializer.DeserializeAsync(stream, ReflectionJsonOptions, cancellationToken); /// /// Creates a reply activity based on the current activity. /// + /// The type of the reply activity. Defaults to . /// The text content for the reply. Defaults to an empty string. /// A new configured as a reply to the current activity. /// /// The reply activity automatically swaps the From and Recipient accounts and preserves /// the conversation context, channel ID, and service URL from the original activity. /// - public CoreActivity CreateReplyActivity(string text = "") + public CoreActivity CreateReplyActivity(string type, string text = "") { CoreActivity result = new() { - Type = "message", + Type = type, ChannelId = ChannelId, ServiceUrl = ServiceUrl, Conversation = Conversation, diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs new file mode 100644 index 00000000..5ca92f3c --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs @@ -0,0 +1,21 @@ +namespace Microsoft.Bot.Core.Schema; + +/// +/// JSON source generator context for Core activity types. +/// This enables AOT-compatible and reflection-free JSON serialization. +/// +[JsonSourceGenerationOptions( + WriteIndented = true, + DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, + PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)] +[JsonSerializable(typeof(CoreActivity))] +[JsonSerializable(typeof(ChannelData))] +[JsonSerializable(typeof(Conversation))] +[JsonSerializable(typeof(ConversationAccount))] +[JsonSerializable(typeof(ExtendedPropertiesDictionary))] +[JsonSerializable(typeof(System.Text.Json.JsonElement))] +[JsonSerializable(typeof(System.Int32))] +[JsonSerializable(typeof(System.Boolean))] +public partial class CoreActivityJsonContext : JsonSerializerContext +{ +} \ No newline at end of file diff --git a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs new file mode 100644 index 00000000..4a07a144 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs @@ -0,0 +1,49 @@ + +using System.Collections; + +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core; + +internal sealed class TurnMiddleware : ITurnMiddleWare, IEnumerable +{ + + private readonly IList _middlewares = []; + internal TurnMiddleware Use(ITurnMiddleWare middleware) + { + _middlewares.Add(middleware); + return this; + } + + + public async Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn next, CancellationToken cancellationToken = default) + { + await RunPipelineAsync(botApplication, activity, null!, 0, cancellationToken).ConfigureAwait(false); + await next(cancellationToken).ConfigureAwait(false); + } + + public Task RunPipelineAsync(BotApplication botApplication, CoreActivity activity, Func? callback, int nextMiddlewareIndex, CancellationToken cancellationToken) + { + if (nextMiddlewareIndex == _middlewares.Count) + { + return callback is not null ? callback!(activity, cancellationToken) ?? Task.CompletedTask : Task.CompletedTask; + } + ITurnMiddleWare nextMiddleware = _middlewares[nextMiddlewareIndex]; + return nextMiddleware.OnTurnAsync( + botApplication, + activity, + (ct) => RunPipelineAsync(botApplication, activity, callback, nextMiddlewareIndex + 1, ct), + cancellationToken); + + } + + public IEnumerator GetEnumerator() + { + return _middlewares.GetEnumerator(); + } + + IEnumerator IEnumerable.GetEnumerator() + { + return GetEnumerator(); + } +} \ No newline at end of file diff --git a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs new file mode 100644 index 00000000..4fa06033 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs @@ -0,0 +1,222 @@ +using System.Net; +using System.Text; +using Microsoft.AspNetCore.Http; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.Logging.Abstractions; +using Moq; +using Moq.Protected; + +namespace Microsoft.Bot.Core.UnitTests; + +public class BotApplicationTests +{ + [Fact] + public void Constructor_InitializesProperties() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + Assert.NotNull(botApp); + Assert.NotNull(botApp.ConversationClient); + } + + + + [Fact] + public async Task ProcessAsync_WithNullHttpContext_ThrowsArgumentNullException() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + await Assert.ThrowsAsync(() => + botApp.ProcessAsync(null!)); + } + + [Fact] + public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Id = "act123" + }; + activity.Recipient.Properties["appId"] = "test-app-id"; + + var httpContext = CreateHttpContextWithActivity(activity); + + bool onActivityCalled = false; + botApp.OnActivity = (act, ct) => + { + onActivityCalled = true; + return Task.CompletedTask; + }; + + var result = await botApp.ProcessAsync(httpContext); + + Assert.NotNull(result); + Assert.True(onActivityCalled); + Assert.Equal(activity.Type, result.Type); + } + + [Fact] + public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Id = "act123" + }; + activity.Recipient.Properties["appId"] = "test-app-id"; + + var httpContext = CreateHttpContextWithActivity(activity); + + bool middlewareCalled = false; + var mockMiddleware = new Mock(); + mockMiddleware + .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) + .Callback(async (app, act, next, ct) => + { + middlewareCalled = true; + await next(ct); + }) + .Returns(Task.CompletedTask); + + botApp.Use(mockMiddleware.Object); + + bool onActivityCalled = false; + botApp.OnActivity = (act, ct) => + { + onActivityCalled = true; + return Task.CompletedTask; + }; + + await botApp.ProcessAsync(httpContext); + + Assert.True(middlewareCalled); + Assert.True(onActivityCalled); + } + + [Fact] + public async Task ProcessAsync_WithException_ThrowsBotHandlerException() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Id = "act123" + }; + activity.Recipient.Properties["appId"] = "test-app-id"; + + var httpContext = CreateHttpContextWithActivity(activity); + + botApp.OnActivity = (act, ct) => throw new InvalidOperationException("Test exception"); + + var exception = await Assert.ThrowsAsync(() => + botApp.ProcessAsync(httpContext)); + + Assert.Equal("Error processing activity", exception.Message); + Assert.IsType(exception.InnerException); + } + + [Fact] + public void Use_AddsMiddlewareToChain() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + var mockMiddleware = new Mock(); + + var result = botApp.Use(mockMiddleware.Object); + + Assert.NotNull(result); + } + + [Fact] + public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() + { + var mockHttpMessageHandler = new Mock(); + mockHttpMessageHandler + .Protected() + .Setup>( + "SendAsync", + ItExpr.IsAny(), + ItExpr.IsAny()) + .ReturnsAsync(new HttpResponseMessage + { + StatusCode = HttpStatusCode.OK, + Content = new StringContent("{\"id\":\"activity123\"}") + }); + + var httpClient = new HttpClient(mockHttpMessageHandler.Object); + var conversationClient = new ConversationClient(httpClient); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Conversation = new Conversation { Id = "conv123" }, + ServiceUrl = new Uri("https://test.service.url/") + }; + + var result = await botApp.SendActivityAsync(activity); + + Assert.NotNull(result); + Assert.Contains("activity123", result); + } + + [Fact] + public async Task SendActivityAsync_WithNullActivity_ThrowsArgumentNullException() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + await Assert.ThrowsAsync(() => + botApp.SendActivityAsync(null!)); + } + + private static ConversationClient CreateMockConversationClient() + { + var mockHttpClient = new Mock(); + return new ConversationClient(mockHttpClient.Object); + } + + private static DefaultHttpContext CreateHttpContextWithActivity(CoreActivity activity) + { + var httpContext = new DefaultHttpContext(); + var activityJson = activity.ToJson(); + var bodyBytes = Encoding.UTF8.GetBytes(activityJson); + httpContext.Request.Body = new MemoryStream(bodyBytes); + httpContext.Request.ContentType = "application/json"; + return httpContext; + } +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs new file mode 100644 index 00000000..fc6ec82c --- /dev/null +++ b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs @@ -0,0 +1,174 @@ +using System.Net; +using Microsoft.Bot.Core.Schema; +using Moq; +using Moq.Protected; + +namespace Microsoft.Bot.Core.UnitTests; + +public class ConversationClientTests +{ + [Fact] + public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() + { + var mockHttpMessageHandler = new Mock(); + mockHttpMessageHandler + .Protected() + .Setup>( + "SendAsync", + ItExpr.IsAny(), + ItExpr.IsAny()) + .ReturnsAsync(new HttpResponseMessage + { + StatusCode = HttpStatusCode.OK, + Content = new StringContent("{\"id\":\"activity123\"}") + }); + + var httpClient = new HttpClient(mockHttpMessageHandler.Object); + var conversationClient = new ConversationClient(httpClient); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Conversation = new Conversation { Id = "conv123" }, + ServiceUrl = new Uri("https://test.service.url/") + }; + + var result = await conversationClient.SendActivityAsync(activity); + + Assert.NotNull(result); + Assert.Contains("activity123", result); + } + + [Fact] + public async Task SendActivityAsync_WithNullActivity_ThrowsArgumentNullException() + { + var httpClient = new HttpClient(); + var conversationClient = new ConversationClient(httpClient); + + await Assert.ThrowsAsync(() => + conversationClient.SendActivityAsync(null!)); + } + + [Fact] + public async Task SendActivityAsync_WithNullConversation_ThrowsArgumentNullException() + { + var httpClient = new HttpClient(); + var conversationClient = new ConversationClient(httpClient); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + ServiceUrl = new Uri("https://test.service.url/") + }; + + await Assert.ThrowsAsync(() => + conversationClient.SendActivityAsync(activity)); + } + + [Fact] + public async Task SendActivityAsync_WithNullConversationId_ThrowsArgumentNullException() + { + var httpClient = new HttpClient(); + var conversationClient = new ConversationClient(httpClient); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Conversation = new Conversation() { Id = null! }, + ServiceUrl = new Uri("https://test.service.url/") + }; ; + + await Assert.ThrowsAsync(() => + conversationClient.SendActivityAsync(activity)); + } + + [Fact] + public async Task SendActivityAsync_WithNullServiceUrl_ThrowsArgumentNullException() + { + var httpClient = new HttpClient(); + var conversationClient = new ConversationClient(httpClient); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Conversation = new Conversation { Id = "conv123" } + }; + + await Assert.ThrowsAsync(() => + conversationClient.SendActivityAsync(activity)); + } + + [Fact] + public async Task SendActivityAsync_WithHttpError_ThrowsHttpRequestException() + { + var mockHttpMessageHandler = new Mock(); + mockHttpMessageHandler + .Protected() + .Setup>( + "SendAsync", + ItExpr.IsAny(), + ItExpr.IsAny()) + .ReturnsAsync(new HttpResponseMessage + { + StatusCode = HttpStatusCode.BadRequest, + Content = new StringContent("Bad request error") + }); + + var httpClient = new HttpClient(mockHttpMessageHandler.Object); + var conversationClient = new ConversationClient(httpClient); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Conversation = new Conversation { Id = "conv123" }, + ServiceUrl = new Uri("https://test.service.url/") + }; + + var exception = await Assert.ThrowsAsync(() => + conversationClient.SendActivityAsync(activity)); + + Assert.Contains("Error sending activity", exception.Message); + Assert.Contains("BadRequest", exception.Message); + } + + [Fact] + public async Task SendActivityAsync_ConstructsCorrectUrl() + { + HttpRequestMessage? capturedRequest = null; + var mockHttpMessageHandler = new Mock(); + mockHttpMessageHandler + .Protected() + .Setup>( + "SendAsync", + ItExpr.IsAny(), + ItExpr.IsAny()) + .Callback((req, ct) => capturedRequest = req) + .ReturnsAsync(new HttpResponseMessage + { + StatusCode = HttpStatusCode.OK, + Content = new StringContent("{\"id\":\"activity123\"}") + }); + + var httpClient = new HttpClient(mockHttpMessageHandler.Object); + var conversationClient = new ConversationClient(httpClient); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Conversation = new Conversation { Id = "conv123" }, + ServiceUrl = new Uri("https://test.service.url/") + }; + + await conversationClient.SendActivityAsync(activity); + + Assert.NotNull(capturedRequest); + Assert.Equal("https://test.service.url/v3/conversations/conv123/activities/", capturedRequest.RequestUri?.ToString()); + Assert.Equal(HttpMethod.Post, capturedRequest.Method); + } +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj b/core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj index 9f253890..09875d75 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj +++ b/core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj @@ -1,6 +1,6 @@  - net10.0 + net8.0;net10.0 enable enable false @@ -9,6 +9,7 @@ + diff --git a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs new file mode 100644 index 00000000..b3a11e31 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs @@ -0,0 +1,222 @@ +using System.Text; +using Microsoft.AspNetCore.Http; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.Logging.Abstractions; +using Moq; + +namespace Microsoft.Bot.Core.UnitTests; + +public class MiddlewareTests +{ + [Fact] + public async Task BotApplication_Use_AddsMiddlewareToChain() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + var mockMiddleware = new Mock(); + + var result = botApp.Use(mockMiddleware.Object); + + Assert.NotNull(result); + } + + + [Fact] + public async Task Middleware_ExecutesInOrder() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + var executionOrder = new List(); + + var mockMiddleware1 = new Mock(); + mockMiddleware1 + .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) + .Callback(async (app, act, next, ct) => + { + executionOrder.Add(1); + await next(ct); + }) + .Returns(Task.CompletedTask); + + var mockMiddleware2 = new Mock(); + mockMiddleware2 + .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) + .Callback(async (app, act, next, ct) => + { + executionOrder.Add(2); + await next(ct); + }) + .Returns(Task.CompletedTask); + + botApp.Use(mockMiddleware1.Object); + botApp.Use(mockMiddleware2.Object); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Id = "act123" + }; + activity.Recipient.Properties["appId"] = "test-app-id"; + + var httpContext = CreateHttpContextWithActivity(activity); + + botApp.OnActivity = (act, ct) => + { + executionOrder.Add(3); + return Task.CompletedTask; + }; + + await botApp.ProcessAsync(httpContext); + int[] expected = [1, 2, 3]; + Assert.Equal(expected, executionOrder); + } + + [Fact] + public async Task Middleware_CanShortCircuit() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + bool secondMiddlewareCalled = false; + bool onActivityCalled = false; + + var mockMiddleware1 = new Mock(); + mockMiddleware1 + .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) + .Returns(Task.CompletedTask); // Don't call next + + var mockMiddleware2 = new Mock(); + mockMiddleware2 + .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) + .Callback(() => secondMiddlewareCalled = true) + .Returns(Task.CompletedTask); + + botApp.Use(mockMiddleware1.Object); + botApp.Use(mockMiddleware2.Object); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Id = "act123" + }; + activity.Recipient.Properties["appId"] = "test-app-id"; + + var httpContext = CreateHttpContextWithActivity(activity); + + botApp.OnActivity = (act, ct) => + { + onActivityCalled = true; + return Task.CompletedTask; + }; + + await botApp.ProcessAsync(httpContext); + + Assert.False(secondMiddlewareCalled); + Assert.False(onActivityCalled); + } + + [Fact] + public async Task Middleware_ReceivesCancellationToken() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + CancellationToken receivedToken = default; + + var mockMiddleware = new Mock(); + mockMiddleware + .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) + .Callback(async (app, act, next, ct) => + { + receivedToken = ct; + await next(ct); + }) + .Returns(Task.CompletedTask); + + botApp.Use(mockMiddleware.Object); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Id = "act123" + }; + activity.Recipient.Properties["appId"] = "test-app-id"; + + var httpContext = CreateHttpContextWithActivity(activity); + + var cts = new CancellationTokenSource(); + + await botApp.ProcessAsync(httpContext, cts.Token); + + Assert.Equal(cts.Token, receivedToken); + } + + [Fact] + public async Task Middleware_ReceivesActivity() + { + var conversationClient = CreateMockConversationClient(); + var mockConfig = new Mock(); + var logger = NullLogger.Instance; + var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + + CoreActivity? receivedActivity = null; + + var mockMiddleware = new Mock(); + mockMiddleware + .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) + .Callback(async (app, act, next, ct) => + { + receivedActivity = act; + await next(ct); + }) + .Returns(Task.CompletedTask); + + botApp.Use(mockMiddleware.Object); + + var activity = new CoreActivity + { + Type = ActivityTypes.Message, + Text = "Test message", + Id = "act123" + }; + activity.Recipient.Properties["appId"] = "test-app-id"; + + var httpContext = CreateHttpContextWithActivity(activity); + + await botApp.ProcessAsync(httpContext); + + Assert.NotNull(receivedActivity); + Assert.Equal(ActivityTypes.Message, receivedActivity.Type); + Assert.Equal("Test message", receivedActivity.Text); + } + + private static ConversationClient CreateMockConversationClient() + { + var mockHttpClient = new Mock(); + return new ConversationClient(mockHttpClient.Object); + } + + private static DefaultHttpContext CreateHttpContextWithActivity(CoreActivity activity) + { + var httpContext = new DefaultHttpContext(); + var activityJson = activity.ToJson(); + var bodyBytes = Encoding.UTF8.GetBytes(activityJson); + httpContext.Request.Body = new MemoryStream(bodyBytes); + httpContext.Request.ContentType = "application/json"; + return httpContext; + } +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs index 7b3cb706..5dfa6786 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs @@ -17,7 +17,7 @@ public void CustomActivity_ExtendedProperties_SerializedAndDeserialized() string json = MyCustomActivity.ToJson(customActivity); var deserializedActivity = CoreActivity.FromJsonString(json); Assert.NotNull(deserializedActivity); - Assert.Equal("CustomValue", deserializedActivity!.CustomField); + Assert.Equal("CustomValue", deserializedActivity.CustomField); } [Fact] @@ -43,14 +43,36 @@ public void CustomChannelDataActivity_ExtendedProperties_SerializedAndDeserializ { ChannelData = new MyChannelData { - CustomField = "ChannelDataValue" + CustomField = "customFieldValue", + MyChannelId = "12345" } }; var json = MyCustomChannelDataActivity.ToJson(customChannelDataActivity); var deserializedActivity = CoreActivity.FromJsonString(json); Assert.NotNull(deserializedActivity); Assert.NotNull(deserializedActivity!.ChannelData); - Assert.Equal("ChannelDataValue", deserializedActivity.ChannelData!.CustomField); + Assert.Equal("customFieldValue", deserializedActivity.ChannelData!.CustomField); + Assert.Equal("12345", deserializedActivity.ChannelData.MyChannelId); + } + + + [Fact] + public void Deserialize_CustomChannelDataActivity() + { + string json = """ + { + "type": "message", + "channelData": { + "customField": "customFieldValue", + "myChannelId": "12345" + } + } + """; + var deserializedActivity = CoreActivity.FromJsonString(json); + Assert.NotNull(deserializedActivity); + Assert.NotNull(deserializedActivity!.ChannelData); + Assert.Equal("customFieldValue", deserializedActivity.ChannelData.CustomField); + Assert.Equal("12345", deserializedActivity.ChannelData.MyChannelId); } } @@ -65,10 +87,13 @@ public class MyChannelData : ChannelData { [JsonPropertyName("customField")] public string? CustomField { get; set; } + + [JsonPropertyName("myChannelId")] + public string? MyChannelId { get; set; } } public class MyCustomChannelDataActivity : CoreActivity { - [JsonPropertyName("customField")] + [JsonPropertyName("channelData")] public new MyChannelData? ChannelData { get; set; } } \ No newline at end of file diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs index 6fb1e8ef..6a2f4aa2 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -79,7 +79,7 @@ public void Serialize_Unkown_Primitive_Fields() { CoreActivity act = new() { - Type = "message", + Type = ActivityTypes.Message, Text = "hello", }; act.Properties["unknownString"] = "some string"; @@ -174,7 +174,7 @@ public void Serialize_With_Properties_Initialized() { CoreActivity act = new() { - Type = "message", + Type = ActivityTypes.Message, Text = "hello", Properties = { @@ -228,6 +228,7 @@ public void CreateReply() { CoreActivity act = new() { + Type = "myActivityType", Text = "hello", Id = "CoreActivity1", ChannelId = "channel1", @@ -247,7 +248,7 @@ public void CreateReply() Id = "conversation1" } }; - CoreActivity reply = act.CreateReplyActivity("reply"); + CoreActivity reply = act.CreateReplyActivity(ActivityTypes.Message, "reply"); Assert.NotNull(reply); Assert.Equal("message", reply.Type); Assert.Equal("reply", reply.Text); diff --git a/core/test/aot-checks/Program.cs b/core/test/aot-checks/Program.cs new file mode 100644 index 00000000..31b88d79 --- /dev/null +++ b/core/test/aot-checks/Program.cs @@ -0,0 +1,5 @@ +using Microsoft.Bot.Core.Schema; + +CoreActivity coreActivity = CoreActivity.FromJsonString(SampleActivities.TeamsMessage); + +System.Console.WriteLine(coreActivity.ToJson()); \ No newline at end of file diff --git a/core/test/aot-checks/SampleActivities.cs b/core/test/aot-checks/SampleActivities.cs new file mode 100644 index 00000000..757e29e2 --- /dev/null +++ b/core/test/aot-checks/SampleActivities.cs @@ -0,0 +1,68 @@ +internal static class SampleActivities +{ + public const string TeamsMessage = """ + { + "type": "message", + "channelId": "msteams", + "text": "\u003Cat\u003Eridotest\u003C/at\u003E reply to thread", + "id": "1759944781430", + "serviceUrl": "https://smba.trafficmanager.net/amer/50612dbb-0237-4969-b378-8d42590f9c00/", + "channelData": { + "teamsChannelId": "19:6848757105754c8981c67612732d9aa7@thread.tacv2", + "teamsTeamId": "19:66P469zibfbsGI-_a0aN_toLTZpyzS6u7CT3TsXdgPw1@thread.tacv2", + "channel": { + "id": "19:6848757105754c8981c67612732d9aa7@thread.tacv2" + }, + "team": { + "id": "19:66P469zibfbsGI-_a0aN_toLTZpyzS6u7CT3TsXdgPw1@thread.tacv2" + }, + "tenant": { + "id": "50612dbb-0237-4969-b378-8d42590f9c00" + } + }, + "from": { + "id": "29:17bUvCasIPKfQIXHvNzcPjD86fwm6GkWc1PvCGP2-NSkNb7AyGYpjQ7Xw-XgTwaHW5JxZ4KMNDxn1kcL8fwX1Nw", + "name": "rido", + "aadObjectId": "b15a9416-0ad3-4172-9210-7beb711d3f70" + }, + "recipient": { + "id": "28:0b6fe6d1-fece-44f7-9a48-56465e2d5ab8", + "name": "ridotest" + }, + "conversation": { + "id": "19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", + "isGroup": true, + "conversationType": "channel", + "tenantId": "50612dbb-0237-4969-b378-8d42590f9c00" + }, + "entities": [ + { + "mentioned": { + "id": "28:0b6fe6d1-fece-44f7-9a48-56465e2d5ab8", + "name": "ridotest" + }, + "text": "\u003Cat\u003Eridotest\u003C/at\u003E", + "type": "mention" + }, + { + "locale": "en-US", + "country": "US", + "platform": "Web", + "timezone": "America/Los_Angeles", + "type": "clientInfo" + } + ], + "textFormat": "plain", + "attachments": [ + { + "contentType": "text/html", + "content": "\u003Cp\u003E\u003Cspan itemtype=\u0022http://schema.skype.com/Mention\u0022 itemscope=\u0022\u0022 itemid=\u00220\u0022\u003Eridotest\u003C/span\u003E\u0026nbsp;reply to thread\u003C/p\u003E" + } + ], + "timestamp": "2025-10-08T17:33:01.4953744Z", + "localTimestamp": "2025-10-08T10:33:01.4953744-07:00", + "locale": "en-US", + "localTimezone": "America/Los_Angeles" + } + """; +} \ No newline at end of file diff --git a/core/test/aot-checks/aot-checks.csproj b/core/test/aot-checks/aot-checks.csproj new file mode 100644 index 00000000..ead30dbb --- /dev/null +++ b/core/test/aot-checks/aot-checks.csproj @@ -0,0 +1,17 @@ + + + + + + + + Exe + net10.0 + aot_checks + enable + enable + true + true + + + From 6c9d9539d9674c0717b5d71de51c55329d2b9d7a Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Wed, 10 Dec 2025 17:48:44 -0800 Subject: [PATCH 05/69] Update pipeline config, solution items, and null handling Updated Azure DevOps pipeline to trigger only on next/* branches and use ubuntu-22.04. Added cd-core.yaml to solution items in core.slnx. Removed null-forgiving operator from CoreActivity.cs return statement for safer null handling. --- .azdo/cd-core.yaml | 7 +++++-- core/core.slnx | 1 + core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.azdo/cd-core.yaml b/.azdo/cd-core.yaml index ffc05e25..2ab4b62f 100644 --- a/.azdo/cd-core.yaml +++ b/.azdo/cd-core.yaml @@ -1,8 +1,11 @@ -trigger: pr: -- main - next/* +trigger: + branches: + include: + - next/* + pool: vmImage: 'ubuntu-22.04' diff --git a/core/core.slnx b/core/core.slnx index bfe29680..8cd7a525 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -1,5 +1,6 @@ + diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs index ecc17331..1018e18d 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs @@ -178,6 +178,6 @@ public CoreActivity CreateReplyActivity(string type, string text = "") Recipient = From, Text = text }; - return result!; + return result; } } \ No newline at end of file From 1e75444b979de487c7646049154535264d40a479 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Wed, 10 Dec 2025 17:53:40 -0800 Subject: [PATCH 06/69] Add .NET 8 SDK install step to BuildTestPack job Added a UseDotNet@2 task to install .NET 8 SDK (8.0.x) before the .NET 10 SDK in the BuildTestPack job. This ensures both SDK versions are available for build and test processes. --- .azdo/cd-core.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.azdo/cd-core.yaml b/.azdo/cd-core.yaml index 2ab4b62f..6b71d0ab 100644 --- a/.azdo/cd-core.yaml +++ b/.azdo/cd-core.yaml @@ -16,6 +16,12 @@ stages: displayName: 'Build, Test, and Pack' steps: + - task: UseDotNet@2 + displayName: 'Use .NET 8 SDK' + inputs: + packageType: 'sdk' + version: '8.0.x' + - task: UseDotNet@2 displayName: 'Use .NET 10 SDK' inputs: From 56f691ded6e61834f23dc2e5c1e693e76869cce3 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Wed, 10 Dec 2025 18:04:44 -0800 Subject: [PATCH 07/69] Update package icon and include assets in NuGet package Changed package icon to bot_icon.png in project properties. Added ItemGroup to explicitly include bot_icon.png and README.md at the root of the NuGet package during packing. --- core/src/Directory.Build.props | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/core/src/Directory.Build.props b/core/src/Directory.Build.props index a96902ed..36f9ef7a 100644 --- a/core/src/Directory.Build.props +++ b/core/src/Directory.Build.props @@ -7,7 +7,7 @@ https://github.com/microsoft/teams.net git false - icon.png + bot_icon.png README.md MIT true @@ -21,6 +21,10 @@ true true + + + + all From 836843dd128c88c2eb7658d3de8517c42e3a376a Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Wed, 10 Dec 2025 18:05:00 -0800 Subject: [PATCH 08/69] Add bot_icon.png image asset Added a new bot_icon.png file to the project, providing a graphical asset that can be used as an icon or visual element within the application. --- core/bot_icon.png | Bin 0 -> 1899 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 core/bot_icon.png diff --git a/core/bot_icon.png b/core/bot_icon.png new file mode 100644 index 0000000000000000000000000000000000000000..37c81be7d6b7ee7f51bdcd5770d6992b104e3b9e GIT binary patch literal 1899 zcmV-x2bB1UP)002t}1^@s6I8J)%00006VoOIv0RI60 z0RN!9r;`8x010qNS#tmY3ljhU3ljkVnw%H_000McNliru;S3rQE*E_6!-xO?2KY%t zK~#9!?b~^9Q$-vH@NZs2Dbf}SX=&OtDWx1O3Iz&+#d1RtsRfa%$Wf46#*1TAJW-mq zfCwJoeLI38qa!jXqXUBnIyn9z0!?~wPNf%ZlaS4O>mQ+I%5L>FeJ>2m{$~2m?ly1V zC;Q&+Z@V>M-Ej&LszMS30!v^CEP*Ak1ePEWSOQC62`qsnumpj?5?BIDUr^vV4vT_0(g^43 zq*jCVGKJ#Aqe%dOZx&dP)w^R*!GeQDD7H+A#i~1^nu-!Sw}W$a5+d5G>q442tO=?y z_AN-j_+G&SlY#-YDW@AA%ILyW)p-?oh`Kwi^~mtbY}@^L2^iZmIAD_AP=(pu@W^l$ z>hFKN=)1WDL{WE_CDjDo3mhOEumcMdFedpH-N7V1q3n}m@K`1bb>gBIDVv-?E8p?w zF8PpD=zxy{{M{leM)lAaOwtQ#GomX~b@HMYeTrHS)fi`LeMl;BLgs)Se87qk zN&10lkL9D-FewJ>MzT<+D!u5vDR8L9I9*GSRLBSWVX+mNI)O=ALp?V!8c&R3p&XT7 z^eS>{cB%3jf*yrV@LqX8F1BKL_YRtaNm@cZlNF8iqfJbevx=anhER=BRzuLE(7^>e zw8VytL~X$&t)QNo5RIqDn7Ff8a-l=F_ikx5L2{7;lyiZ@OKlit(+*710_w@}COkXV z#J>?8p_;ysDuSLx4sP9%Wj5Sy)doyzE7ap-O?ZA>bPMkk{v)DCII8?3j2AyIw_%7i ztj%CjTcFmCG2w*?EY#^5f~11rL0z3hNQ;xmFUu1#I3eshVEHK4jP8p3tZ2?U=*qNy zosP&gEl)V{>xx7SiVq7SmQ3;JsIIV2jA5$I))I6taB^4JJaAC|Zp8mS9y0a+_$bs2 z*OM2$NZHH>`)y?+2F8U20ZXQMctjTz-4(-4Mbtuth8S>oMIvZ^AJC#y{{q(6!tW^* zd*)j}3sOJ}Q?NZJw&k|h{j;-pBm~f*`SU%cp zKdLdR-7+j2i@Dn;Eq%^p4ops8&dw)MFgb;7o1Gc~wJ*iLD!fQ-;gQTs@1zr!dwOel-97HQ&vsboKZ6P%Xw|p?y?e!O_O3;m_5CEVHvP=&jnP}%gg}S zmfa1@GrFh)3zaZ`*ZF2e74<$89;#y78Vy+b<%MQNUYTO;w-xG=aYFI+q6Ghb{WY=g zL_KyLyVNQyLu=2$hZzkhUz-e5cnH(qWnW&v>qn}A|NH9=1bk4%C5D4H&<(95A-Ne*rB@-9Cy$doe0q>?65jN-P!)?TqWT zDkT(q^7v5S7Y7d2rgXY$?mV|N4&)#gOn zMHE==#i(|(U~k=P#{40j5wrx6Q0$s#!PHwLn5rL~E{u7-ZBUwQ(KLAdBdmr4_Rcgj z<_-!17*X)qJPW4X#zOsA;=-uc%GwO2+2&upSAos$KrILCz3FDm8PrKXFrwg-xfa~V zfjU&`#>iK-fzk{M0O~F)u-YBCkSHLc_V4uv4!;CZy zz=(qPbK{Yl#^!cEm%EX%U3(~9u&#nRxL}{oio<>VBLfE`6z|TC$Nd9Xs9#RIF-#{Y z-LNQtTDJ_Fy%_ag7VNXx@wm5NB%rh&>g`!^m^YAxI(o)~q1#Gz%^Y+)>p%h2xD{CQ z9cbWy?aqzIl-t79gAs~1XPU8K5DWF&Sr3N1T%vo5rRymgKbQ=g-2oTpXwesQEQknG z*M)ofM_^%kXQur3vmOlIS`w68RQK~)6hNg*hAqDsF4BA$W$q~BzSnrM_s=?PI9S=N z?ASRE(t`vQ6s*Rmbje7xJK(-D!ZLT1;ZTWN{UH&f0qgfwG=cqb{xSvz5h~ywm9#qch8qZapPXhu=U Date: Wed, 10 Dec 2025 18:12:18 -0800 Subject: [PATCH 09/69] Update NuGet push to run only on next/core branch Changed the pipeline condition so that NuGet packages are pushed only when building from the refs/heads/next/core branch, instead of the main branch. This restricts package publishing to the next/core branch. --- .azdo/cd-core.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.azdo/cd-core.yaml b/.azdo/cd-core.yaml index 6b71d0ab..c6e6c2e4 100644 --- a/.azdo/cd-core.yaml +++ b/.azdo/cd-core.yaml @@ -46,7 +46,7 @@ stages: - task: NuGetCommand@2 displayName: 'Push NuGet Packages' - condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main')) + condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/next/core')) inputs: command: push packagesToPush: '$(Build.ArtifactStagingDirectory)/*.nupkg' From 716e01be9cd8b429400051400bab946e583de0ba Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Wed, 10 Dec 2025 18:51:35 -0800 Subject: [PATCH 10/69] Update .gitignore to exclude config and settings files Ignored launchSettings.json, appsettings.Development.json, and .runsettings to prevent tracking of local configuration and test settings files. --- core/.gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/core/.gitignore b/core/.gitignore index 4055b442..2374e85d 100644 --- a/core/.gitignore +++ b/core/.gitignore @@ -1,2 +1,3 @@ launchSettings.json -appsettings.Development.json \ No newline at end of file +appsettings.Development.json +.runsettings \ No newline at end of file From cca6c26291c02db1d678ec8d1dfd7f1ed46205f7 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Wed, 10 Dec 2025 18:51:54 -0800 Subject: [PATCH 11/69] Add new test project and GitHub Actions workflow Introduce Microsoft.Bot.Core.Tests targeting .NET 10.0 with xUnit and code coverage. Add core-test.yaml workflow to run these tests with Azure AD credentials. Update solution file to include new test project and workflow. Implement ConversationClientTest for Teams activity scenarios. Update core-ci.yaml to run only unit tests. --- .github/workflows/core-ci.yaml | 2 +- .github/workflows/core-test.yaml | 41 +++++++++ core/core.slnx | 2 + .../ConversationClientTest.cs | 84 +++++++++++++++++++ .../Microsoft.Bot.Core.Tests.csproj | 25 ++++++ 5 files changed, 153 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/core-test.yaml create mode 100644 core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs create mode 100644 core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj diff --git a/.github/workflows/core-ci.yaml b/.github/workflows/core-ci.yaml index 62b9c8e8..1dcd7353 100644 --- a/.github/workflows/core-ci.yaml +++ b/.github/workflows/core-ci.yaml @@ -32,5 +32,5 @@ jobs: working-directory: core - name: Test - run: dotnet test --no-build --verbosity normal + run: dotnet test --no-build test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj working-directory: core \ No newline at end of file diff --git a/.github/workflows/core-test.yaml b/.github/workflows/core-test.yaml new file mode 100644 index 00000000..9ba13ad0 --- /dev/null +++ b/.github/workflows/core-test.yaml @@ -0,0 +1,41 @@ +name: Core-Test +permissions: + contents: read + pull-requests: write + +on: + workflow_dispatch: + +jobs: + build-and-test: + runs-on: ubuntu-latest + environment: test_tenant + + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup .NET + uses: actions/setup-dotnet@v4 + with: + dotnet-version: '10.0.x' + + - name: Restore dependencies + run: dotnet restore + working-directory: core + + - name: Build + run: dotnet build --no-restore + working-directory: core + + - name: Test + run: dotnet test --no-build test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj + working-directory: core + env: + AzureAd__Instance: 'https://login.microsoftonline.com/' + AzureAd__ClientId: 'aabdbd62-bc97-4afb-83ee-575594577de5' + AzureAd__TenantId: '56653e9d-2158-46ee-90d7-675c39642038' + AzureAd__Scope: 'https://api.botframework.com/.default' + AzureAd__ClientCredentials__0__SourceType: 'ClientSecret' + AzureAd__ClientCredentials__0__ClientSecret: ${{ secrets.CLIENT_SECRET}} \ No newline at end of file diff --git a/core/core.slnx b/core/core.slnx index 8cd7a525..be03a79d 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -2,6 +2,7 @@ + @@ -12,5 +13,6 @@ + diff --git a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs new file mode 100644 index 00000000..3ab32e11 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs @@ -0,0 +1,84 @@ +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; + +namespace Microsoft.Bot.Core.Tests; + +public class ConversationClientTest +{ + private readonly ServiceProvider _serviceProvider; + private readonly ConversationClient _conversationClient; + + public ConversationClientTest() + { + IConfigurationBuilder builder = new ConfigurationBuilder() + .SetBasePath(AppDomain.CurrentDomain.BaseDirectory) + .AddEnvironmentVariables(); + + IConfiguration configuration = builder.Build(); + + var services = new ServiceCollection(); + services.AddSingleton(configuration); + services.AddBotApplicationClients(); + _serviceProvider = services.BuildServiceProvider(); + _conversationClient = _serviceProvider.GetRequiredService(); + + } + + [Fact] + public async Task SendActivityDefault() + { + CoreActivity activity = new() + { + Type = ActivityTypes.Message, + Text = $"Message from Automated tests, running in SDK `{BotApplication.Version}` at `{DateTime.UtcNow:s}`", + ServiceUrl = new Uri("https://smba.trafficmanager.net/teams/"), + Conversation = new() + { + Id = Environment.GetEnvironmentVariable("TEST_ConversationId") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set") + } + }; + var res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); + Assert.NotNull(res); + Assert.Contains("\"id\"", res); + } + + + + [Fact] + public async Task SendActivityToChannel() + { + CoreActivity activity = new() + { + Type = ActivityTypes.Message, + Text = $"Message from Automated tests, running in SDK `{BotApplication.Version}` at `{DateTime.UtcNow:s}`", + ServiceUrl = new Uri("https://smba.trafficmanager.net/teams/"), + Conversation = new() + { + Id = "19:9f2af1bee7cc4a71af25ac72478fd5c6@thread.tacv2;messageid=1765420585482" + } + }; + var res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); + Assert.NotNull(res); + Assert.Contains("\"id\"", res); + } + + [Fact] + public async Task SendActivityToPersonalChat_FailsWithBad_ConversationId() + { + CoreActivity activity = new() + { + Type = ActivityTypes.Message, + Text = $"Message from Automated tests, running in SDK `{BotApplication.Version}` at `{DateTime.UtcNow:s}`", + ServiceUrl = new Uri("https://smba.trafficmanager.net/teams/"), + Conversation = new() + { + Id = "a:1" + } + }; + + await Assert.ThrowsAsync(() + => _conversationClient.SendActivityAsync(activity)); + } +} diff --git a/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj b/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj new file mode 100644 index 00000000..aa6e0128 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj @@ -0,0 +1,25 @@ + + + + net10.0 + enable + enable + false + + + + + + + + + + + + + + + + + + \ No newline at end of file From daae2404a4f89b950cd8f6f642901a6e00c7ee34 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Wed, 10 Dec 2025 18:58:55 -0800 Subject: [PATCH 12/69] Target unit tests in pipeline, fix conversation ID usage Updated the build pipeline to run tests only for the Microsoft.Bot.Core.UnitTests project. Changed environment variable to "TEST_CONVERSATIONID" in ConversationClientTest.cs and corrected the hardcoded conversation ID format by removing the message ID suffix. --- .azdo/cd-core.yaml | 2 +- core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.azdo/cd-core.yaml b/.azdo/cd-core.yaml index c6e6c2e4..86288793 100644 --- a/.azdo/cd-core.yaml +++ b/.azdo/cd-core.yaml @@ -36,7 +36,7 @@ stages: displayName: 'Build' workingDirectory: '$(Build.SourcesDirectory)/core' - - script: dotnet test --no-build --configuration Release + - script: dotnet test --no-build --configuration Release test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj displayName: 'Test' workingDirectory: '$(Build.SourcesDirectory)/core' diff --git a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs index 3ab32e11..34db2b18 100644 --- a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs +++ b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs @@ -36,7 +36,7 @@ public async Task SendActivityDefault() ServiceUrl = new Uri("https://smba.trafficmanager.net/teams/"), Conversation = new() { - Id = Environment.GetEnvironmentVariable("TEST_ConversationId") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set") + Id = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set") } }; var res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); @@ -56,7 +56,7 @@ public async Task SendActivityToChannel() ServiceUrl = new Uri("https://smba.trafficmanager.net/teams/"), Conversation = new() { - Id = "19:9f2af1bee7cc4a71af25ac72478fd5c6@thread.tacv2;messageid=1765420585482" + Id = "19:9f2af1bee7cc4a71af25ac72478fd5c6@thread.tacv2" } }; var res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); From 6535d6ae39579769ac61c1345badb546817c26e5 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Wed, 10 Dec 2025 19:17:26 -0800 Subject: [PATCH 13/69] Update echo message, logging, and exception handling - Prefix echo replies with "Echo from BF Compat" - Change default log level to Warning; add Debug for Microsoft.Bot - Remove using statement for TurnContext in CompatAdapter - Expand exception handling to rethrow non-HttpOperationException - Add debug/info logging to BotApplication activity processing --- core/samples/CompatBot/EchoBot.cs | 2 +- core/samples/CompatBot/appsettings.json | 5 +++-- core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs | 6 +++++- core/src/Microsoft.Bot.Core/BotApplication.cs | 3 +++ 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 925c0c04..388cf110 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -24,7 +24,7 @@ protected override async Task OnMessageActivityAsync(ITurnContext(nameof(ConversationData)); var conversationData = await conversationStateAccessors.GetAsync(turnContext, () => new ConversationData(), cancellationToken); - var replyText = $"Echo [{conversationData.MessageCount++}]: {turnContext.Activity.Text}"; + var replyText = $"Echo from BF Compat [{conversationData.MessageCount++}]: {turnContext.Activity.Text}"; await turnContext.SendActivityAsync(MessageFactory.Text(replyText, replyText), cancellationToken); } diff --git a/core/samples/CompatBot/appsettings.json b/core/samples/CompatBot/appsettings.json index 10f68b8c..4638b699 100644 --- a/core/samples/CompatBot/appsettings.json +++ b/core/samples/CompatBot/appsettings.json @@ -1,8 +1,9 @@ { "Logging": { "LogLevel": { - "Default": "Information", - "Microsoft.AspNetCore": "Warning" + "Default": "Warning", + "Microsoft.AspNetCore": "Warning", + "Microsoft.Bot": "Debug" } }, "AllowedHosts": "*" diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs index fdab68e2..ed248da2 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs @@ -62,7 +62,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons CoreActivity? activity = null; botApplication.OnActivity = (activity, cancellationToken1) => { - using TurnContext turnContext = new(compatBotAdapter, activity.ToCompatActivity()); + TurnContext turnContext = new(compatBotAdapter, activity.ToCompatActivity()); //turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); return bot.OnTurnAsync(turnContext, cancellationToken1); }; @@ -90,6 +90,10 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons throw; } } + else + { + throw; + } } } diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs index 66c43b07..9ce88a0d 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -69,8 +69,11 @@ public async Task ProcessAsync(HttpContext httpContext, Cancellati ArgumentNullException.ThrowIfNull(httpContext); ArgumentNullException.ThrowIfNull(_conversationClient); + _logger.LogDebug("Start processing HTTP request for activity"); CoreActivity activity = await CoreActivity.FromJsonStreamAsync(httpContext.Request.Body, cancellationToken).ConfigureAwait(false) ?? throw new InvalidOperationException("Invalid Activity"); + + _logger.LogInformation("Processing activity: {Id} {Type}", activity.Id, activity.Type); if (_logger.IsEnabled(LogLevel.Trace)) { From 74934be8d7a8cecb45b7b774be8f626ff4db5dc4 Mon Sep 17 00:00:00 2001 From: Rido Date: Thu, 11 Dec 2025 08:03:03 +0000 Subject: [PATCH 14/69] Update .gitignore to include runsettings files and add README for test configurations --- core/.gitignore | 2 +- .../Microsoft.Bot.Core.Tests.csproj | 4 ++- core/test/README.md | 30 +++++++++++++++++++ 3 files changed, 34 insertions(+), 2 deletions(-) create mode 100644 core/test/README.md diff --git a/core/.gitignore b/core/.gitignore index 2374e85d..1fe9a12f 100644 --- a/core/.gitignore +++ b/core/.gitignore @@ -1,3 +1,3 @@ launchSettings.json appsettings.Development.json -.runsettings \ No newline at end of file +*.runsettings \ No newline at end of file diff --git a/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj b/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj index aa6e0128..cc4861b0 100644 --- a/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj +++ b/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj @@ -6,7 +6,9 @@ enable false - + + ../../.runsettings + diff --git a/core/test/README.md b/core/test/README.md new file mode 100644 index 00000000..6149a020 --- /dev/null +++ b/core/test/README.md @@ -0,0 +1,30 @@ +# Tests + +.vscode/settings.json + +```json +{ + "dotnet.unitTests.runSettingsPath": "./.runsettings" +} +``` + + +.runsettings +```xml + + + + + test_value + 19:9f2af1bee7cc4a71af25ac72478fd5c6@thread.tacv2 + https://login.microsoftonline.com/ + + + ClientSecret + + Warning + Information + + + +``` \ No newline at end of file From 7a9aa2313fa286abcb8b70f17ad938d0d0109010 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Thu, 11 Dec 2025 07:23:26 -0800 Subject: [PATCH 15/69] Refactor test commands and update project references in CI configurations --- .azdo/cd-core.yaml | 2 +- .github/workflows/core-ci.yaml | 2 +- core/core.slnx | 1 - core/test/IntegrationTests.slnx | 7 +++++++ .../Microsoft.Bot.Core.Tests.csproj | 2 +- core/test/Microsoft.Bot.Core.Tests/readme.md | 21 +++++++++++++++++++ 6 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 core/test/IntegrationTests.slnx create mode 100644 core/test/Microsoft.Bot.Core.Tests/readme.md diff --git a/.azdo/cd-core.yaml b/.azdo/cd-core.yaml index 86288793..c6e6c2e4 100644 --- a/.azdo/cd-core.yaml +++ b/.azdo/cd-core.yaml @@ -36,7 +36,7 @@ stages: displayName: 'Build' workingDirectory: '$(Build.SourcesDirectory)/core' - - script: dotnet test --no-build --configuration Release test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj + - script: dotnet test --no-build --configuration Release displayName: 'Test' workingDirectory: '$(Build.SourcesDirectory)/core' diff --git a/.github/workflows/core-ci.yaml b/.github/workflows/core-ci.yaml index 1dcd7353..48e76809 100644 --- a/.github/workflows/core-ci.yaml +++ b/.github/workflows/core-ci.yaml @@ -32,5 +32,5 @@ jobs: working-directory: core - name: Test - run: dotnet test --no-build test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj + run: dotnet test --no-build working-directory: core \ No newline at end of file diff --git a/core/core.slnx b/core/core.slnx index be03a79d..a5e9ad4f 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -13,6 +13,5 @@ - diff --git a/core/test/IntegrationTests.slnx b/core/test/IntegrationTests.slnx new file mode 100644 index 00000000..49a0b21a --- /dev/null +++ b/core/test/IntegrationTests.slnx @@ -0,0 +1,7 @@ + + + + + + + diff --git a/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj b/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj index cc4861b0..1faa9888 100644 --- a/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj +++ b/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj @@ -7,7 +7,7 @@ false - ../../.runsettings + ../.runsettings diff --git a/core/test/Microsoft.Bot.Core.Tests/readme.md b/core/test/Microsoft.Bot.Core.Tests/readme.md new file mode 100644 index 00000000..125a5289 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.Tests/readme.md @@ -0,0 +1,21 @@ +# Microsoft.Bot.Core.Tests + +To run these tests we need to configure the environment variables using a `.runsettings` file, that should be localted in `core/` folder. + + +```xml + + + + + a:17vxw6pGQOb3Zfh8acXT8m_PqHycYpaFgzu2mFMUfkT-h0UskMctq5ZPPc7FIQxn2bx7rBSm5yE_HeUXsCcKZBrv77RgorB3_1_pAdvMhi39ClxQgawzyQ9GBFkdiwOxT + https://login.microsoftonline.com/ + + + https://api.botframework.com/.default + ClientSecret + + + + +``` \ No newline at end of file From 2073c71227e3d36d69635a31bdb4754948c10db4 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Thu, 11 Dec 2025 07:47:24 -0800 Subject: [PATCH 16/69] Add .editorconfig, rename reply method, update tests Introduce .editorconfig for code style and nullable strictness. Update solution to include .editorconfig. Rename CoreActivity.CreateReplyActivity to CreateReplyMessageActivity and update all usages. Extend CoreActivityJsonContext for Int64/Double support. Apply minor formatting fixes and missing braces. Strengthen and update unit tests for new property types and method changes. --- core/.editorconfig | 34 +++++++++++++++++++ core/core.slnx | 1 + core/samples/CompatBot/EchoBot.cs | 2 +- core/samples/CompatBot/Program.cs | 2 +- core/samples/CoreBot/Program.cs | 5 ++- .../CompatActivity.cs | 4 +-- .../CompatAdapter.cs | 4 +-- .../CompatBotAdapter.cs | 4 +-- .../CompatHostingExtensions.cs | 4 +-- .../CompatMiddlewareAdapter.cs | 4 +-- core/src/Microsoft.Bot.Core/BotApplication.cs | 8 ++--- .../Microsoft.Bot.Core/BotHandlerException.cs | 4 +-- .../Microsoft.Bot.Core/ConversationClient.cs | 4 +-- .../Hosting/AddBotApplicationExtensions.cs | 4 +-- .../Hosting/BotAuthenticationHandler.cs | 4 +-- .../src/Microsoft.Bot.Core/ITurnMiddleWare.cs | 4 +-- .../Schema/ActivityTypes.cs | 4 +-- .../Microsoft.Bot.Core/Schema/ChannelData.cs | 4 +-- .../Microsoft.Bot.Core/Schema/Conversation.cs | 4 +-- .../Schema/ConversationAccount.cs | 4 +-- .../Microsoft.Bot.Core/Schema/CoreActivity.cs | 7 ++-- .../Schema/CoreActivityJsonContext.cs | 4 ++- core/src/Microsoft.Bot.Core/TurnMiddleware.cs | 4 +-- .../MiddlewareTests.cs | 2 +- .../Schema/ActivityExtensibilityTests.cs | 11 +++--- .../Schema/CoreActivityTests.cs | 24 +++++++------ 26 files changed, 100 insertions(+), 60 deletions(-) create mode 100644 core/.editorconfig diff --git a/core/.editorconfig b/core/.editorconfig new file mode 100644 index 00000000..07d982b0 --- /dev/null +++ b/core/.editorconfig @@ -0,0 +1,34 @@ +root = true + +# All files +[*] +charset = utf-8 +insert_final_newline = true +trim_trailing_whitespace = true + +# C# files +[*.cs] +indent_style = space +indent_size = 4 +nullable = enable + +#### Nullable Reference Types #### +# Make nullable warnings strict +dotnet_diagnostic.CS8600.severity = error +dotnet_diagnostic.CS8602.severity = error +dotnet_diagnostic.CS8603.severity = error +dotnet_diagnostic.CS8604.severity = error +dotnet_diagnostic.CS8618.severity = error # Non-nullable field uninitialized + +# Code quality rules +dotnet_code_quality_unused_parameters = all:suggestion +dotnet_diagnostic.IDE0079.severity = warning + +#### Coding conventions #### +dotnet_sort_system_directives_first = true +csharp_new_line_before_open_brace = all +csharp_new_line_before_else = true + +# Test projects can be more lenient +[tests/**/*.cs] +dotnet_diagnostic.CS8602.severity = warning \ No newline at end of file diff --git a/core/core.slnx b/core/core.slnx index a5e9ad4f..699c3e90 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -3,6 +3,7 @@ + diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 388cf110..dbf8a992 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -32,4 +32,4 @@ protected override async Task OnMessageReactionActivityAsync(ITurnContext await adapter.ProcessAsync(request, response, bot)); -app.Run(); \ No newline at end of file +app.Run(); diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index d41ed9d3..7edd8b6e 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -2,7 +2,6 @@ using Microsoft.Bot.Core; using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Schema; WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); webAppBuilder.Services.AddBotApplication(); @@ -15,8 +14,8 @@ string replyText = $"CoreBot running on SDK {BotApplication.Version}."; replyText += $"\r\nYou sent: `{activity.Text}` in activity of type `{activity.Type}`."; replyText += $"\r\n to Conversation ID: `{activity.Conversation.Id}` type: `{activity.Conversation.Properties["conversationType"]}`"; - var replyActivity = activity.CreateReplyActivity(ActivityTypes.Message, replyText); + var replyActivity = activity.CreateReplyMessageActivity(replyText); await botApp.SendActivityAsync(replyActivity, cancellationToken); }; -webApp.Run(); \ No newline at end of file +webApp.Run(); diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs index 49de652b..8495243c 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs @@ -1,4 +1,4 @@ -using System.Text; +using System.Text; using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; using Microsoft.Bot.Core.Schema; @@ -24,4 +24,4 @@ public static CoreActivity FromCompatActivity(this Activity activity) BotMessageHandlerBase.BotMessageSerializer.Serialize(json, activity); return CoreActivity.FromJsonString(sb.ToString()); } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs index ed248da2..eda07262 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs @@ -1,4 +1,4 @@ -using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Http; using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Core.Schema; @@ -117,4 +117,4 @@ public async Task ContinueConversationAsync(string botId, ConversationReference using TurnContext turnContext = new(compatBotAdapter, reference.GetContinuationActivity()); await callback(turnContext, cancellationToken).ConfigureAwait(false); } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs index b2348a89..baa5c69a 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs @@ -1,4 +1,4 @@ -using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder; using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; @@ -64,4 +64,4 @@ public override Task UpdateActivityAsync(ITurnContext turnCont } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs b/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs index f0432ad9..6e3aa5af 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs @@ -1,4 +1,4 @@ -using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Core.Hosting; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; @@ -44,4 +44,4 @@ public static IServiceCollection AddCompatAdapter(this IServiceCollection servic services.AddSingleton(); return services; } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs index 298d295b..7f9d9e32 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs @@ -1,4 +1,4 @@ -using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder; using Microsoft.Bot.Core.Schema; namespace Microsoft.Bot.Core.Compat; @@ -11,4 +11,4 @@ public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, Ne return bfMiddleWare.OnTurnAsync(turnContext, (activity) => nextTurn(cancellationToken), cancellationToken); } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs index 9ce88a0d..010837cf 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -1,4 +1,4 @@ - + using Microsoft.AspNetCore.Http; using Microsoft.Bot.Core.Hosting; @@ -68,11 +68,11 @@ public async Task ProcessAsync(HttpContext httpContext, Cancellati { ArgumentNullException.ThrowIfNull(httpContext); ArgumentNullException.ThrowIfNull(_conversationClient); - + _logger.LogDebug("Start processing HTTP request for activity"); CoreActivity activity = await CoreActivity.FromJsonStreamAsync(httpContext.Request.Body, cancellationToken).ConfigureAwait(false) ?? throw new InvalidOperationException("Invalid Activity"); - + _logger.LogInformation("Processing activity: {Id} {Type}", activity.Id, activity.Type); if (_logger.IsEnabled(LogLevel.Trace)) @@ -132,4 +132,4 @@ public async Task SendActivityAsync(CoreActivity activity, CancellationT /// Gets the version of the SDK. /// public static string Version => ThisAssembly.NuGetPackageVersion; -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/BotHandlerException.cs b/core/src/Microsoft.Bot.Core/BotHandlerException.cs index 5d5b5ce6..1dacad47 100644 --- a/core/src/Microsoft.Bot.Core/BotHandlerException.cs +++ b/core/src/Microsoft.Bot.Core/BotHandlerException.cs @@ -1,4 +1,4 @@ - + using Microsoft.Bot.Core.Schema; namespace Microsoft.Bot.Core; @@ -50,4 +50,4 @@ public BotHandlerException(string message, Exception innerException, CoreActivit /// Accesses the bot activity associated with the exception. /// public CoreActivity? Activity { get; } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index 4ea434f7..f8f3602d 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -1,4 +1,4 @@ -using System.Net.Http.Json; +using System.Net.Http.Json; using Microsoft.Bot.Core.Hosting; using Microsoft.Bot.Core.Schema; @@ -48,4 +48,4 @@ public async Task SendActivityAsync(CoreActivity activity, CancellationT respContent : throw new HttpRequestException($"Error sending activity: {resp.StatusCode} - {respContent}"); } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 725eea84..58514343 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -1,4 +1,4 @@ -using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Http; using Microsoft.Bot.Core.Schema; using Microsoft.Extensions.Configuration; @@ -113,4 +113,4 @@ public static IServiceCollection AddBotApplicationClients(this IServiceCollectio return services; } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs index 412ea6f0..0c3895d0 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -1,4 +1,4 @@ -using System.Net.Http.Headers; +using System.Net.Http.Headers; using Microsoft.Bot.Core.Schema; using Microsoft.Extensions.Logging; @@ -123,4 +123,4 @@ private async Task GetAuthorizationHeaderAsync(AgenticIdentity? agenticI string appToken = await _authorizationHeaderProvider.CreateAuthorizationHeaderForAppAsync(_scope, options, cancellationToken).ConfigureAwait(false); return appToken; } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs index cdea8ff2..5f48cb91 100644 --- a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs +++ b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs @@ -1,4 +1,4 @@ -using Microsoft.Bot.Core.Schema; +using Microsoft.Bot.Core.Schema; namespace Microsoft.Bot.Core; @@ -28,4 +28,4 @@ public interface ITurnMiddleWare /// /// Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default); -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs index 2741c1b8..9db58061 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs @@ -1,4 +1,4 @@ -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Bot.Core.Schema; /// /// Provides constant values that represent activity types used in messaging workflows. @@ -11,4 +11,4 @@ public static class ActivityTypes /// Represents the default message string used for communication or display purposes. /// public const string Message = "message"; -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs index 9f4a0ee8..5843cf9b 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs @@ -1,4 +1,4 @@ -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Bot.Core.Schema; /// /// Represents channel-specific data associated with an activity. @@ -17,4 +17,4 @@ public class ChannelData #pragma warning disable CA2227 // Collection properties should be read only public ExtendedPropertiesDictionary Properties { get; set; } = []; #pragma warning restore CA2227 // Collection properties should be read only -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs index 2c4ae050..7897553a 100644 --- a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs +++ b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs @@ -1,4 +1,4 @@ -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Bot.Core.Schema; /// /// Represents a conversation, including its unique identifier and associated extended properties. @@ -18,4 +18,4 @@ public class Conversation() #pragma warning disable CA2227 // Collection properties should be read only public ExtendedPropertiesDictionary Properties { get; set; } = []; #pragma warning restore CA2227 // Collection properties should be read only -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs index 212a6e2b..0a29c9e8 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs @@ -1,4 +1,4 @@ -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Bot.Core.Schema; /// /// Represents a conversation account, including its unique identifier, display name, and any additional properties @@ -28,4 +28,4 @@ public class ConversationAccount() #pragma warning disable CA2227 // Collection properties should be read only public ExtendedPropertiesDictionary Properties { get; set; } = []; #pragma warning restore CA2227 // Collection properties should be read only -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs index 1018e18d..625cd75a 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs @@ -159,18 +159,17 @@ public static T FromJsonString(string json) where T : CoreActivity /// /// Creates a reply activity based on the current activity. /// - /// The type of the reply activity. Defaults to . /// The text content for the reply. Defaults to an empty string. /// A new configured as a reply to the current activity. /// /// The reply activity automatically swaps the From and Recipient accounts and preserves /// the conversation context, channel ID, and service URL from the original activity. /// - public CoreActivity CreateReplyActivity(string type, string text = "") + public CoreActivity CreateReplyMessageActivity(string text = "") { CoreActivity result = new() { - Type = type, + Type = ActivityTypes.Message, ChannelId = ChannelId, ServiceUrl = ServiceUrl, Conversation = Conversation, @@ -180,4 +179,4 @@ public CoreActivity CreateReplyActivity(string type, string text = "") }; return result; } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs index 5ca92f3c..2ab752ab 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs @@ -16,6 +16,8 @@ namespace Microsoft.Bot.Core.Schema; [JsonSerializable(typeof(System.Text.Json.JsonElement))] [JsonSerializable(typeof(System.Int32))] [JsonSerializable(typeof(System.Boolean))] +[JsonSerializable(typeof(System.Int64))] +[JsonSerializable(typeof(System.Double))] public partial class CoreActivityJsonContext : JsonSerializerContext { -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs index 4a07a144..087633b0 100644 --- a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs +++ b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs @@ -1,4 +1,4 @@ - + using System.Collections; using Microsoft.Bot.Core.Schema; @@ -46,4 +46,4 @@ IEnumerator IEnumerable.GetEnumerator() { return GetEnumerator(); } -} \ No newline at end of file +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs index b3a11e31..b9f8652a 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs @@ -23,7 +23,7 @@ public async Task BotApplication_Use_AddsMiddlewareToChain() Assert.NotNull(result); } - + [Fact] public async Task Middleware_ExecutesInOrder() diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs index 5dfa6786..13ba6c47 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs @@ -1,4 +1,4 @@ -using System.Text; +using System.Text; using System.Text.Json.Serialization; using Microsoft.Bot.Core.Schema; @@ -50,8 +50,9 @@ public void CustomChannelDataActivity_ExtendedProperties_SerializedAndDeserializ var json = MyCustomChannelDataActivity.ToJson(customChannelDataActivity); var deserializedActivity = CoreActivity.FromJsonString(json); Assert.NotNull(deserializedActivity); - Assert.NotNull(deserializedActivity!.ChannelData); - Assert.Equal("customFieldValue", deserializedActivity.ChannelData!.CustomField); + Assert.NotNull(deserializedActivity.ChannelData); + Assert.Equal(ActivityTypes.Message, deserializedActivity.Type); + Assert.Equal("customFieldValue", deserializedActivity.ChannelData.CustomField); Assert.Equal("12345", deserializedActivity.ChannelData.MyChannelId); } @@ -70,7 +71,7 @@ public void Deserialize_CustomChannelDataActivity() """; var deserializedActivity = CoreActivity.FromJsonString(json); Assert.NotNull(deserializedActivity); - Assert.NotNull(deserializedActivity!.ChannelData); + Assert.NotNull(deserializedActivity.ChannelData); Assert.Equal("customFieldValue", deserializedActivity.ChannelData.CustomField); Assert.Equal("12345", deserializedActivity.ChannelData.MyChannelId); } @@ -96,4 +97,4 @@ public class MyCustomChannelDataActivity : CoreActivity { [JsonPropertyName("channelData")] public new MyChannelData? ChannelData { get; set; } -} \ No newline at end of file +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs index 6a2f4aa2..babdaf93 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -1,4 +1,4 @@ -using Microsoft.Bot.Core.Schema; +using Microsoft.Bot.Core.Schema; namespace Microsoft.Bot.Core.UnitTests.Schema; @@ -86,6 +86,8 @@ public void Serialize_Unkown_Primitive_Fields() act.Properties["unknownInt"] = 123; act.Properties["unknownBool"] = true; act.Properties["unknownNull"] = null; + act.Properties["unknownLong"] = 1L; + act.Properties["unknownDouble"] = 1.0; string json = act.ToJson(); Assert.Contains("\"type\": \"message\"", json); @@ -94,6 +96,8 @@ public void Serialize_Unkown_Primitive_Fields() Assert.Contains("\"unknownInt\": 123", json); Assert.Contains("\"unknownBool\": true", json); Assert.Contains("\"unknownNull\": null", json); + Assert.Contains("\"unknownLong\": 1", json); + Assert.Contains("\"unknownDouble\": 1", json); } [Fact] @@ -248,18 +252,18 @@ public void CreateReply() Id = "conversation1" } }; - CoreActivity reply = act.CreateReplyActivity(ActivityTypes.Message, "reply"); + CoreActivity reply = act.CreateReplyMessageActivity("reply"); Assert.NotNull(reply); - Assert.Equal("message", reply.Type); + Assert.Equal(ActivityTypes.Message, reply.Type); Assert.Equal("reply", reply.Text); Assert.Equal("channel1", reply.ChannelId); Assert.NotNull(reply.ServiceUrl); Assert.Equal("http://service.url/", reply.ServiceUrl.ToString()); - Assert.Equal("conversation1", reply.Conversation?.Id); - Assert.Equal("bot1", reply.From?.Id); - Assert.Equal("Bot One", reply.From?.Name); - Assert.Equal("user1", reply.Recipient?.Id); - Assert.Equal("User One", reply.Recipient?.Name); + Assert.Equal("conversation1", reply.Conversation.Id); + Assert.Equal("bot1", reply.From.Id); + Assert.Equal("Bot One", reply.From.Name); + Assert.Equal("user1", reply.Recipient.Id); + Assert.Equal("User One", reply.Recipient.Name); } [Fact] @@ -283,9 +287,9 @@ public async Task DeserializeAsync() Assert.Equal("hello", act.Text); Assert.NotNull(act.From); Assert.IsType(act.From); - Assert.Equal("1", act.From!.Id); + Assert.Equal("1", act.From.Id); Assert.Equal("tester", act.From.Name); Assert.True(act.From.Properties.ContainsKey("aadObjectId")); Assert.Equal("123", act.From.Properties["aadObjectId"]?.ToString()); } -} \ No newline at end of file +} From 7690ea41c3de2e0623d69aaa07fdd9599fa75a9e Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Thu, 11 Dec 2025 07:50:20 -0800 Subject: [PATCH 17/69] Refactor: use explicit types instead of var everywhere Replaced all var declarations with explicit types across the codebase, including tests, bot implementations, and entry points. This improves code clarity and type safety, making variable types more visible and aiding maintainability. No functional changes were made. --- core/samples/CompatBot/EchoBot.cs | 6 +- core/samples/CompatBot/Program.cs | 8 +- core/samples/CoreBot/Program.cs | 5 +- core/samples/Proactive/Program.cs | 4 +- core/samples/Proactive/Worker.cs | 2 +- .../BotApplicationTests.cs | 102 +++++++++--------- .../ConversationClientTests.cs | 50 ++++----- .../MiddlewareTests.cs | 84 +++++++-------- .../Schema/ActivityExtensibilityTests.cs | 16 +-- .../Schema/CoreActivityTests.cs | 2 +- 10 files changed, 140 insertions(+), 139 deletions(-) diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index dbf8a992..b896615f 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -21,10 +21,10 @@ public override async Task OnTurnAsync(ITurnContext turnContext, CancellationTok protected override async Task OnMessageActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) { - var conversationStateAccessors = conversationState.CreateProperty(nameof(ConversationData)); - var conversationData = await conversationStateAccessors.GetAsync(turnContext, () => new ConversationData(), cancellationToken); + IStatePropertyAccessor conversationStateAccessors = conversationState.CreateProperty(nameof(ConversationData)); + ConversationData conversationData = await conversationStateAccessors.GetAsync(turnContext, () => new ConversationData(), cancellationToken); - var replyText = $"Echo from BF Compat [{conversationData.MessageCount++}]: {turnContext.Activity.Text}"; + string replyText = $"Echo from BF Compat [{conversationData.MessageCount++}]: {turnContext.Activity.Text}"; await turnContext.SendActivityAsync(MessageFactory.Text(replyText, replyText), cancellationToken); } diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index ada7eff5..7d12dadf 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -5,7 +5,7 @@ // using Microsoft.Bot.Connector.Authentication; using Microsoft.Bot.Core.Compat; -var builder = WebApplication.CreateBuilder(args); +WebApplicationBuilder builder = WebApplication.CreateBuilder(args); builder.AddCompatAdapter(); @@ -16,12 +16,12 @@ // provider.GetRequiredService>())); -var storage = new MemoryStorage(); -var conversationState = new ConversationState(storage); +MemoryStorage storage = new(); +ConversationState conversationState = new(storage); builder.Services.AddSingleton(conversationState); builder.Services.AddTransient(); -var app = builder.Build(); +WebApplication app = builder.Build(); app.MapPost("/api/messages", async (IBotFrameworkHttpAdapter adapter, IBot bot, HttpRequest request, HttpResponse response) => await adapter.ProcessAsync(request, response, bot)); diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index 7edd8b6e..3abb3aac 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -2,11 +2,12 @@ using Microsoft.Bot.Core; using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); webAppBuilder.Services.AddBotApplication(); WebApplication webApp = webAppBuilder.Build(); -var botApp = webApp.UseBotApplication(); +BotApplication botApp = webApp.UseBotApplication(); botApp.OnActivity = async (activity, cancellationToken) => @@ -14,7 +15,7 @@ string replyText = $"CoreBot running on SDK {BotApplication.Version}."; replyText += $"\r\nYou sent: `{activity.Text}` in activity of type `{activity.Type}`."; replyText += $"\r\n to Conversation ID: `{activity.Conversation.Id}` type: `{activity.Conversation.Properties["conversationType"]}`"; - var replyActivity = activity.CreateReplyMessageActivity(replyText); + CoreActivity replyActivity = activity.CreateReplyMessageActivity(replyText); await botApp.SendActivityAsync(replyActivity, cancellationToken); }; diff --git a/core/samples/Proactive/Program.cs b/core/samples/Proactive/Program.cs index 5f16887d..3a7bdcfe 100644 --- a/core/samples/Proactive/Program.cs +++ b/core/samples/Proactive/Program.cs @@ -2,9 +2,9 @@ using Proactive; -var builder = Host.CreateApplicationBuilder(args); +HostApplicationBuilder builder = Host.CreateApplicationBuilder(args); builder.Services.AddBotApplicationClients(); builder.Services.AddHostedService(); -var host = builder.Build(); +IHost host = builder.Build(); host.Run(); diff --git a/core/samples/Proactive/Worker.cs b/core/samples/Proactive/Worker.cs index 8a4251ce..87cb5762 100644 --- a/core/samples/Proactive/Worker.cs +++ b/core/samples/Proactive/Worker.cs @@ -22,7 +22,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken) Id = ConversationId } }; - var aid = await conversationClient.SendActivityAsync(proactiveMessage, stoppingToken); + string aid = await conversationClient.SendActivityAsync(proactiveMessage, stoppingToken); logger.LogInformation("Activity {Aid} sent", aid); } await Task.Delay(1000, stoppingToken); diff --git a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs index 4fa06033..d91309ed 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs @@ -14,11 +14,11 @@ public class BotApplicationTests [Fact] public void Constructor_InitializesProperties() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); Assert.NotNull(botApp); Assert.NotNull(botApp.ConversationClient); @@ -29,10 +29,10 @@ public void Constructor_InitializesProperties() [Fact] public async Task ProcessAsync_WithNullHttpContext_ThrowsArgumentNullException() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); await Assert.ThrowsAsync(() => botApp.ProcessAsync(null!)); @@ -41,12 +41,12 @@ await Assert.ThrowsAsync(() => [Fact] public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -54,7 +54,7 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() }; activity.Recipient.Properties["appId"] = "test-app-id"; - var httpContext = CreateHttpContextWithActivity(activity); + DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); bool onActivityCalled = false; botApp.OnActivity = (act, ct) => @@ -63,7 +63,7 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() return Task.CompletedTask; }; - var result = await botApp.ProcessAsync(httpContext); + CoreActivity result = await botApp.ProcessAsync(httpContext); Assert.NotNull(result); Assert.True(onActivityCalled); @@ -73,12 +73,12 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() [Fact] public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -86,10 +86,10 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() }; activity.Recipient.Properties["appId"] = "test-app-id"; - var httpContext = CreateHttpContextWithActivity(activity); + DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); bool middlewareCalled = false; - var mockMiddleware = new Mock(); + Mock mockMiddleware = new(); mockMiddleware .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -117,12 +117,12 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() [Fact] public async Task ProcessAsync_WithException_ThrowsBotHandlerException() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -130,11 +130,11 @@ public async Task ProcessAsync_WithException_ThrowsBotHandlerException() }; activity.Recipient.Properties["appId"] = "test-app-id"; - var httpContext = CreateHttpContextWithActivity(activity); + DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); botApp.OnActivity = (act, ct) => throw new InvalidOperationException("Test exception"); - var exception = await Assert.ThrowsAsync(() => + BotHandlerException exception = await Assert.ThrowsAsync(() => botApp.ProcessAsync(httpContext)); Assert.Equal("Error processing activity", exception.Message); @@ -144,14 +144,14 @@ public async Task ProcessAsync_WithException_ThrowsBotHandlerException() [Fact] public void Use_AddsMiddlewareToChain() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); - var mockMiddleware = new Mock(); + Mock mockMiddleware = new(); - var result = botApp.Use(mockMiddleware.Object); + ITurnMiddleWare result = botApp.Use(mockMiddleware.Object); Assert.NotNull(result); } @@ -159,7 +159,7 @@ public void Use_AddsMiddlewareToChain() [Fact] public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() { - var mockHttpMessageHandler = new Mock(); + Mock mockHttpMessageHandler = new(); mockHttpMessageHandler .Protected() .Setup>( @@ -172,13 +172,13 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() Content = new StringContent("{\"id\":\"activity123\"}") }); - var httpClient = new HttpClient(mockHttpMessageHandler.Object); - var conversationClient = new ConversationClient(httpClient); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + HttpClient httpClient = new(mockHttpMessageHandler.Object); + ConversationClient conversationClient = new(httpClient); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -186,7 +186,7 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() ServiceUrl = new Uri("https://test.service.url/") }; - var result = await botApp.SendActivityAsync(activity); + string result = await botApp.SendActivityAsync(activity); Assert.NotNull(result); Assert.Contains("activity123", result); @@ -195,10 +195,10 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() [Fact] public async Task SendActivityAsync_WithNullActivity_ThrowsArgumentNullException() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); await Assert.ThrowsAsync(() => botApp.SendActivityAsync(null!)); @@ -206,15 +206,15 @@ await Assert.ThrowsAsync(() => private static ConversationClient CreateMockConversationClient() { - var mockHttpClient = new Mock(); + Mock mockHttpClient = new(); return new ConversationClient(mockHttpClient.Object); } private static DefaultHttpContext CreateHttpContextWithActivity(CoreActivity activity) { - var httpContext = new DefaultHttpContext(); - var activityJson = activity.ToJson(); - var bodyBytes = Encoding.UTF8.GetBytes(activityJson); + DefaultHttpContext httpContext = new(); + string activityJson = activity.ToJson(); + byte[] bodyBytes = Encoding.UTF8.GetBytes(activityJson); httpContext.Request.Body = new MemoryStream(bodyBytes); httpContext.Request.ContentType = "application/json"; return httpContext; diff --git a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs index fc6ec82c..96171afd 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs @@ -10,7 +10,7 @@ public class ConversationClientTests [Fact] public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() { - var mockHttpMessageHandler = new Mock(); + Mock mockHttpMessageHandler = new(); mockHttpMessageHandler .Protected() .Setup>( @@ -23,10 +23,10 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() Content = new StringContent("{\"id\":\"activity123\"}") }); - var httpClient = new HttpClient(mockHttpMessageHandler.Object); - var conversationClient = new ConversationClient(httpClient); + HttpClient httpClient = new(mockHttpMessageHandler.Object); + ConversationClient conversationClient = new(httpClient); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -34,7 +34,7 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() ServiceUrl = new Uri("https://test.service.url/") }; - var result = await conversationClient.SendActivityAsync(activity); + string result = await conversationClient.SendActivityAsync(activity); Assert.NotNull(result); Assert.Contains("activity123", result); @@ -43,8 +43,8 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() [Fact] public async Task SendActivityAsync_WithNullActivity_ThrowsArgumentNullException() { - var httpClient = new HttpClient(); - var conversationClient = new ConversationClient(httpClient); + HttpClient httpClient = new(); + ConversationClient conversationClient = new(httpClient); await Assert.ThrowsAsync(() => conversationClient.SendActivityAsync(null!)); @@ -53,10 +53,10 @@ await Assert.ThrowsAsync(() => [Fact] public async Task SendActivityAsync_WithNullConversation_ThrowsArgumentNullException() { - var httpClient = new HttpClient(); - var conversationClient = new ConversationClient(httpClient); + HttpClient httpClient = new(); + ConversationClient conversationClient = new(httpClient); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -70,10 +70,10 @@ await Assert.ThrowsAsync(() => [Fact] public async Task SendActivityAsync_WithNullConversationId_ThrowsArgumentNullException() { - var httpClient = new HttpClient(); - var conversationClient = new ConversationClient(httpClient); + HttpClient httpClient = new(); + ConversationClient conversationClient = new(httpClient); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -88,10 +88,10 @@ await Assert.ThrowsAsync(() => [Fact] public async Task SendActivityAsync_WithNullServiceUrl_ThrowsArgumentNullException() { - var httpClient = new HttpClient(); - var conversationClient = new ConversationClient(httpClient); + HttpClient httpClient = new(); + ConversationClient conversationClient = new(httpClient); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -105,7 +105,7 @@ await Assert.ThrowsAsync(() => [Fact] public async Task SendActivityAsync_WithHttpError_ThrowsHttpRequestException() { - var mockHttpMessageHandler = new Mock(); + Mock mockHttpMessageHandler = new(); mockHttpMessageHandler .Protected() .Setup>( @@ -118,10 +118,10 @@ public async Task SendActivityAsync_WithHttpError_ThrowsHttpRequestException() Content = new StringContent("Bad request error") }); - var httpClient = new HttpClient(mockHttpMessageHandler.Object); - var conversationClient = new ConversationClient(httpClient); + HttpClient httpClient = new(mockHttpMessageHandler.Object); + ConversationClient conversationClient = new(httpClient); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -129,7 +129,7 @@ public async Task SendActivityAsync_WithHttpError_ThrowsHttpRequestException() ServiceUrl = new Uri("https://test.service.url/") }; - var exception = await Assert.ThrowsAsync(() => + HttpRequestException exception = await Assert.ThrowsAsync(() => conversationClient.SendActivityAsync(activity)); Assert.Contains("Error sending activity", exception.Message); @@ -140,7 +140,7 @@ public async Task SendActivityAsync_WithHttpError_ThrowsHttpRequestException() public async Task SendActivityAsync_ConstructsCorrectUrl() { HttpRequestMessage? capturedRequest = null; - var mockHttpMessageHandler = new Mock(); + Mock mockHttpMessageHandler = new(); mockHttpMessageHandler .Protected() .Setup>( @@ -154,10 +154,10 @@ public async Task SendActivityAsync_ConstructsCorrectUrl() Content = new StringContent("{\"id\":\"activity123\"}") }); - var httpClient = new HttpClient(mockHttpMessageHandler.Object); - var conversationClient = new ConversationClient(httpClient); + HttpClient httpClient = new(mockHttpMessageHandler.Object); + ConversationClient conversationClient = new(httpClient); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", diff --git a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs index b9f8652a..b49da7e2 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs @@ -12,14 +12,14 @@ public class MiddlewareTests [Fact] public async Task BotApplication_Use_AddsMiddlewareToChain() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); - var mockMiddleware = new Mock(); + Mock mockMiddleware = new(); - var result = botApp.Use(mockMiddleware.Object); + ITurnMiddleWare result = botApp.Use(mockMiddleware.Object); Assert.NotNull(result); } @@ -28,14 +28,14 @@ public async Task BotApplication_Use_AddsMiddlewareToChain() [Fact] public async Task Middleware_ExecutesInOrder() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); - var executionOrder = new List(); + List executionOrder = new(); - var mockMiddleware1 = new Mock(); + Mock mockMiddleware1 = new(); mockMiddleware1 .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -45,7 +45,7 @@ public async Task Middleware_ExecutesInOrder() }) .Returns(Task.CompletedTask); - var mockMiddleware2 = new Mock(); + Mock mockMiddleware2 = new(); mockMiddleware2 .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -58,7 +58,7 @@ public async Task Middleware_ExecutesInOrder() botApp.Use(mockMiddleware1.Object); botApp.Use(mockMiddleware2.Object); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -66,7 +66,7 @@ public async Task Middleware_ExecutesInOrder() }; activity.Recipient.Properties["appId"] = "test-app-id"; - var httpContext = CreateHttpContextWithActivity(activity); + DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); botApp.OnActivity = (act, ct) => { @@ -82,20 +82,20 @@ public async Task Middleware_ExecutesInOrder() [Fact] public async Task Middleware_CanShortCircuit() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); bool secondMiddlewareCalled = false; bool onActivityCalled = false; - var mockMiddleware1 = new Mock(); + Mock mockMiddleware1 = new(); mockMiddleware1 .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Returns(Task.CompletedTask); // Don't call next - var mockMiddleware2 = new Mock(); + Mock mockMiddleware2 = new(); mockMiddleware2 .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(() => secondMiddlewareCalled = true) @@ -104,7 +104,7 @@ public async Task Middleware_CanShortCircuit() botApp.Use(mockMiddleware1.Object); botApp.Use(mockMiddleware2.Object); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -112,7 +112,7 @@ public async Task Middleware_CanShortCircuit() }; activity.Recipient.Properties["appId"] = "test-app-id"; - var httpContext = CreateHttpContextWithActivity(activity); + DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); botApp.OnActivity = (act, ct) => { @@ -129,14 +129,14 @@ public async Task Middleware_CanShortCircuit() [Fact] public async Task Middleware_ReceivesCancellationToken() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); CancellationToken receivedToken = default; - var mockMiddleware = new Mock(); + Mock mockMiddleware = new(); mockMiddleware .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -148,7 +148,7 @@ public async Task Middleware_ReceivesCancellationToken() botApp.Use(mockMiddleware.Object); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -156,9 +156,9 @@ public async Task Middleware_ReceivesCancellationToken() }; activity.Recipient.Properties["appId"] = "test-app-id"; - var httpContext = CreateHttpContextWithActivity(activity); + DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); - var cts = new CancellationTokenSource(); + CancellationTokenSource cts = new(); await botApp.ProcessAsync(httpContext, cts.Token); @@ -168,14 +168,14 @@ public async Task Middleware_ReceivesCancellationToken() [Fact] public async Task Middleware_ReceivesActivity() { - var conversationClient = CreateMockConversationClient(); - var mockConfig = new Mock(); - var logger = NullLogger.Instance; - var botApp = new BotApplication(conversationClient, mockConfig.Object, logger); + ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + NullLogger logger = NullLogger.Instance; + BotApplication botApp = new(conversationClient, mockConfig.Object, logger); CoreActivity? receivedActivity = null; - var mockMiddleware = new Mock(); + Mock mockMiddleware = new(); mockMiddleware .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -187,7 +187,7 @@ public async Task Middleware_ReceivesActivity() botApp.Use(mockMiddleware.Object); - var activity = new CoreActivity + CoreActivity activity = new() { Type = ActivityTypes.Message, Text = "Test message", @@ -195,7 +195,7 @@ public async Task Middleware_ReceivesActivity() }; activity.Recipient.Properties["appId"] = "test-app-id"; - var httpContext = CreateHttpContextWithActivity(activity); + DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); await botApp.ProcessAsync(httpContext); @@ -206,15 +206,15 @@ public async Task Middleware_ReceivesActivity() private static ConversationClient CreateMockConversationClient() { - var mockHttpClient = new Mock(); + Mock mockHttpClient = new(); return new ConversationClient(mockHttpClient.Object); } private static DefaultHttpContext CreateHttpContextWithActivity(CoreActivity activity) { - var httpContext = new DefaultHttpContext(); - var activityJson = activity.ToJson(); - var bodyBytes = Encoding.UTF8.GetBytes(activityJson); + DefaultHttpContext httpContext = new(); + string activityJson = activity.ToJson(); + byte[] bodyBytes = Encoding.UTF8.GetBytes(activityJson); httpContext.Request.Body = new MemoryStream(bodyBytes); httpContext.Request.ContentType = "application/json"; return httpContext; diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs index 13ba6c47..0a163b39 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs @@ -10,12 +10,12 @@ public class ActivityExtensibilityTests [Fact] public void CustomActivity_ExtendedProperties_SerializedAndDeserialized() { - var customActivity = new MyCustomActivity + MyCustomActivity customActivity = new() { CustomField = "CustomValue" }; string json = MyCustomActivity.ToJson(customActivity); - var deserializedActivity = CoreActivity.FromJsonString(json); + MyCustomActivity deserializedActivity = CoreActivity.FromJsonString(json); Assert.NotNull(deserializedActivity); Assert.Equal("CustomValue", deserializedActivity.CustomField); } @@ -29,8 +29,8 @@ public async Task CustomActivity_ExtendedProperties_SerializedAndDeserialized_As "customField": "CustomValue" } """; - using var stream = new MemoryStream(Encoding.UTF8.GetBytes(json)); - var deserializedActivity = await CoreActivity.FromJsonStreamAsync(stream); + using MemoryStream stream = new(Encoding.UTF8.GetBytes(json)); + MyCustomActivity? deserializedActivity = await CoreActivity.FromJsonStreamAsync(stream); Assert.NotNull(deserializedActivity); Assert.Equal("CustomValue", deserializedActivity!.CustomField); } @@ -39,7 +39,7 @@ public async Task CustomActivity_ExtendedProperties_SerializedAndDeserialized_As [Fact] public void CustomChannelDataActivity_ExtendedProperties_SerializedAndDeserialized() { - var customChannelDataActivity = new MyCustomChannelDataActivity + MyCustomChannelDataActivity customChannelDataActivity = new() { ChannelData = new MyChannelData { @@ -47,8 +47,8 @@ public void CustomChannelDataActivity_ExtendedProperties_SerializedAndDeserializ MyChannelId = "12345" } }; - var json = MyCustomChannelDataActivity.ToJson(customChannelDataActivity); - var deserializedActivity = CoreActivity.FromJsonString(json); + string json = MyCustomChannelDataActivity.ToJson(customChannelDataActivity); + MyCustomChannelDataActivity deserializedActivity = CoreActivity.FromJsonString(json); Assert.NotNull(deserializedActivity); Assert.NotNull(deserializedActivity.ChannelData); Assert.Equal(ActivityTypes.Message, deserializedActivity.Type); @@ -69,7 +69,7 @@ public void Deserialize_CustomChannelDataActivity() } } """; - var deserializedActivity = CoreActivity.FromJsonString(json); + MyCustomChannelDataActivity deserializedActivity = CoreActivity.FromJsonString(json); Assert.NotNull(deserializedActivity); Assert.NotNull(deserializedActivity.ChannelData); Assert.Equal("customFieldValue", deserializedActivity.ChannelData.CustomField); diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs index babdaf93..8b50207f 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -280,7 +280,7 @@ public async Task DeserializeAsync() } } """; - using var ms = new MemoryStream(System.Text.Encoding.UTF8.GetBytes(json)); + using MemoryStream ms = new(System.Text.Encoding.UTF8.GetBytes(json)); CoreActivity? act = await CoreActivity.FromJsonStreamAsync(ms); Assert.NotNull(act); Assert.Equal("message", act.Type); From 1bb72296b56d0e984ca927bc5a682e1e97277227 Mon Sep 17 00:00:00 2001 From: Rido Date: Thu, 11 Dec 2025 10:56:19 -0800 Subject: [PATCH 18/69] Add copyright and MIT license headers to all files (#240) Added copyright and MIT license headers to all source and test files. Updated .editorconfig to enforce file header template for new files. Made minor code style improvements and access modifier updates. Ensured consistent attribution and licensing across the codebase. --- core/.editorconfig | 4 +++- core/samples/CompatBot/EchoBot.cs | 5 ++++- core/samples/CompatBot/Program.cs | 3 +++ core/samples/CoreBot/Program.cs | 3 ++- core/samples/Proactive/Program.cs | 3 +++ core/samples/Proactive/Worker.cs | 5 ++++- .../Microsoft.Bot.Core.Compat/CompatActivity.cs | 3 +++ .../Microsoft.Bot.Core.Compat/CompatAdapter.cs | 3 +++ .../CompatBotAdapter.cs | 3 +++ .../CompatHostingExtensions.cs | 3 +++ .../CompatMiddlewareAdapter.cs | 3 +++ core/src/Microsoft.Bot.Core/BotApplication.cs | 3 ++- .../Microsoft.Bot.Core/BotHandlerException.cs | 2 ++ .../Microsoft.Bot.Core/ConversationClient.cs | 3 +++ .../Hosting/AddBotApplicationExtensions.cs | 3 +++ .../Hosting/BotAuthenticationHandler.cs | 3 +++ core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs | 3 +++ .../Microsoft.Bot.Core/Schema/ActivityTypes.cs | 3 +++ .../Microsoft.Bot.Core/Schema/ChannelData.cs | 3 +++ .../Microsoft.Bot.Core/Schema/Conversation.cs | 3 +++ .../Schema/ConversationAccount.cs | 3 +++ .../Microsoft.Bot.Core/Schema/CoreActivity.cs | 3 +++ .../Schema/CoreActivityJsonContext.cs | 3 +++ core/src/Microsoft.Bot.Core/TurnMiddleware.cs | 2 ++ .../ConversationClientTest.cs | 17 ++++++++++------- .../BotApplicationTests.cs | 3 +++ .../ConversationClientTests.cs | 3 +++ .../MiddlewareTests.cs | 3 +++ .../Schema/ActivityExtensibilityTests.cs | 3 +++ .../Schema/CoreActivityTests.cs | 3 +++ 30 files changed, 95 insertions(+), 12 deletions(-) diff --git a/core/.editorconfig b/core/.editorconfig index 07d982b0..ad100670 100644 --- a/core/.editorconfig +++ b/core/.editorconfig @@ -29,6 +29,8 @@ dotnet_sort_system_directives_first = true csharp_new_line_before_open_brace = all csharp_new_line_before_else = true +file_header_template = Copyright (c) Microsoft Corporation.\nLicensed under the MIT License. + # Test projects can be more lenient [tests/**/*.cs] -dotnet_diagnostic.CS8602.severity = warning \ No newline at end of file +dotnet_diagnostic.CS8602.severity = warning diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index b896615f..2f1f31ce 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Teams; using Microsoft.Bot.Schema; @@ -10,7 +13,7 @@ public class ConversationData } -class EchoBot(ConversationState conversationState) : TeamsActivityHandler +internal class EchoBot(ConversationState conversationState) : TeamsActivityHandler { public override async Task OnTurnAsync(ITurnContext turnContext, CancellationToken cancellationToken = default) { diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index 7d12dadf..fb1a0b56 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using CompatBot; using Microsoft.Bot.Builder; diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index 3abb3aac..b47c0eb9 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -1,4 +1,5 @@ - +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. using Microsoft.Bot.Core; using Microsoft.Bot.Core.Hosting; diff --git a/core/samples/Proactive/Program.cs b/core/samples/Proactive/Program.cs index 3a7bdcfe..2411c10a 100644 --- a/core/samples/Proactive/Program.cs +++ b/core/samples/Proactive/Program.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Core.Hosting; using Proactive; diff --git a/core/samples/Proactive/Worker.cs b/core/samples/Proactive/Worker.cs index 87cb5762..15be17ec 100644 --- a/core/samples/Proactive/Worker.cs +++ b/core/samples/Proactive/Worker.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Core; using Microsoft.Bot.Core.Schema; @@ -5,7 +8,7 @@ namespace Proactive; public class Worker(ConversationClient conversationClient, ILogger logger) : BackgroundService { - const string ConversationId = "a:17vxw6pGQOb3Zfh8acXT8m_PqHycYpaFgzu2mFMUfkT-h0UskMctq5ZPPc7FIQxn2bx7rBSm5yE_HeUXsCcKZBrv77RgorB3_1_pAdvMhi39ClxQgawzyQ9GBFkdiwOxT"; + private const string ConversationId = "a:17vxw6pGQOb3Zfh8acXT8m_PqHycYpaFgzu2mFMUfkT-h0UskMctq5ZPPc7FIQxn2bx7rBSm5yE_HeUXsCcKZBrv77RgorB3_1_pAdvMhi39ClxQgawzyQ9GBFkdiwOxT"; protected override async Task ExecuteAsync(CancellationToken stoppingToken) { diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs index 8495243c..07da90ae 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using System.Text; using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs index eda07262..875682ec 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.AspNetCore.Http; using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs index baa5c69a..1ce0b0d3 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Builder; using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs b/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs index 6e3aa5af..0dbd3c8a 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Core.Hosting; using Microsoft.Extensions.DependencyInjection; diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs index 7f9d9e32..83b1d23a 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Builder; using Microsoft.Bot.Core.Schema; diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs index 010837cf..9e9ddc74 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -1,4 +1,5 @@ - +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. using Microsoft.AspNetCore.Http; using Microsoft.Bot.Core.Hosting; diff --git a/core/src/Microsoft.Bot.Core/BotHandlerException.cs b/core/src/Microsoft.Bot.Core/BotHandlerException.cs index 1dacad47..1cb3940e 100644 --- a/core/src/Microsoft.Bot.Core/BotHandlerException.cs +++ b/core/src/Microsoft.Bot.Core/BotHandlerException.cs @@ -1,3 +1,5 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. using Microsoft.Bot.Core.Schema; diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index f8f3602d..88815376 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using System.Net.Http.Json; using Microsoft.Bot.Core.Hosting; diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 58514343..9cd14daa 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Http; using Microsoft.Bot.Core.Schema; diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs index 0c3895d0..b4573bac 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using System.Net.Http.Headers; using Microsoft.Bot.Core.Schema; diff --git a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs index 5f48cb91..2ff8d5f8 100644 --- a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs +++ b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Core.Schema; namespace Microsoft.Bot.Core; diff --git a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs index 9db58061..b2371662 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + namespace Microsoft.Bot.Core.Schema; /// diff --git a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs index 5843cf9b..9500664b 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + namespace Microsoft.Bot.Core.Schema; /// diff --git a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs index 7897553a..473133d7 100644 --- a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs +++ b/core/src/Microsoft.Bot.Core/Schema/Conversation.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + namespace Microsoft.Bot.Core.Schema; /// diff --git a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs index 0a29c9e8..d286bbc5 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + namespace Microsoft.Bot.Core.Schema; /// diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs index 625cd75a..9f1041c1 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using System.Text.Json; using System.Text.Json.Nodes; diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs index 2ab752ab..39b7a9d2 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + namespace Microsoft.Bot.Core.Schema; /// diff --git a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs index 087633b0..f177c2d3 100644 --- a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs +++ b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs @@ -1,3 +1,5 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. using System.Collections; diff --git a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs index 34db2b18..ca5d5968 100644 --- a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs +++ b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs @@ -1,4 +1,7 @@ -using Microsoft.Bot.Core.Hosting; +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Hosting; using Microsoft.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; @@ -18,12 +21,12 @@ public ConversationClientTest() IConfiguration configuration = builder.Build(); - var services = new ServiceCollection(); + ServiceCollection services = new(); services.AddSingleton(configuration); services.AddBotApplicationClients(); _serviceProvider = services.BuildServiceProvider(); _conversationClient = _serviceProvider.GetRequiredService(); - + } [Fact] @@ -39,12 +42,12 @@ public async Task SendActivityDefault() Id = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set") } }; - var res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); + string res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); Assert.NotNull(res); Assert.Contains("\"id\"", res); } - + [Fact] public async Task SendActivityToChannel() @@ -59,7 +62,7 @@ public async Task SendActivityToChannel() Id = "19:9f2af1bee7cc4a71af25ac72478fd5c6@thread.tacv2" } }; - var res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); + string res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); Assert.NotNull(res); Assert.Contains("\"id\"", res); } @@ -78,7 +81,7 @@ public async Task SendActivityToPersonalChat_FailsWithBad_ConversationId() } }; - await Assert.ThrowsAsync(() + await Assert.ThrowsAsync(() => _conversationClient.SendActivityAsync(activity)); } } diff --git a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs index d91309ed..9b7f564d 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using System.Net; using System.Text; using Microsoft.AspNetCore.Http; diff --git a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs index 96171afd..90786acf 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using System.Net; using Microsoft.Bot.Core.Schema; using Moq; diff --git a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs index b49da7e2..f9f3fbe4 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using System.Text; using Microsoft.AspNetCore.Http; using Microsoft.Bot.Core.Schema; diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs index 0a163b39..40fb5416 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using System.Text; using System.Text.Json.Serialization; diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs index 8b50207f..6f1e8f6e 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Core.Schema; namespace Microsoft.Bot.Core.UnitTests.Schema; From 8c07ca134f68707d55fd4c44062cc81fc3a0eb5a Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Thu, 11 Dec 2025 10:57:49 -0800 Subject: [PATCH 19/69] Add proactive messaging endpoint and update EchoBot responses EchoBot now informs users how to trigger a proactive message via a new `/api/notify/{conversationId}` endpoint. Added a GET endpoint to send proactive messages to a conversation by ID. Updated message handling to support CancellationToken and included necessary usings for proactive messaging support. --- core/samples/CompatBot/EchoBot.cs | 3 ++- core/samples/CompatBot/Program.cs | 24 ++++++++++++++++++++++-- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index b896615f..56953381 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -10,7 +10,7 @@ public class ConversationData } -class EchoBot(ConversationState conversationState) : TeamsActivityHandler +internal class EchoBot(ConversationState conversationState) : TeamsActivityHandler { public override async Task OnTurnAsync(ITurnContext turnContext, CancellationToken cancellationToken = default) { @@ -26,6 +26,7 @@ protected override async Task OnMessageActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index 7d12dadf..a255567c 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -2,8 +2,11 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Core; + // using Microsoft.Bot.Connector.Authentication; using Microsoft.Bot.Core.Compat; +using Microsoft.Bot.Schema; WebApplicationBuilder builder = WebApplication.CreateBuilder(args); @@ -23,7 +26,24 @@ WebApplication app = builder.Build(); -app.MapPost("/api/messages", async (IBotFrameworkHttpAdapter adapter, IBot bot, HttpRequest request, HttpResponse response) => - await adapter.ProcessAsync(request, response, bot)); +app.MapPost("/api/messages", async (IBotFrameworkHttpAdapter adapter, IBot bot, HttpRequest request, HttpResponse response, CancellationToken ct) => + await adapter.ProcessAsync(request, response, bot, ct)); + +app.MapGet("/api/notify/{cid}", async (IBotFrameworkHttpAdapter adapter, string cid, CancellationToken ct) => +{ + Activity proactive = new() + { + Conversation = new() { Id = cid }, + ServiceUrl = "https://smba.trafficmanager.net/teams" + }; + await ((CompatAdapter)adapter).ContinueConversationAsync( + string.Empty, + proactive.GetConversationReference(), + async (turnContext, ct) => + { + await turnContext.SendActivityAsync($"Proactive Message send from SDK `{BotApplication.Version}` at {DateTime.Now:T}"); + }, + ct); +}); app.Run(); From 349f7e7f64682c0a1876115397483b038cfbfd4c Mon Sep 17 00:00:00 2001 From: Rido Date: Thu, 11 Dec 2025 16:47:46 -0800 Subject: [PATCH 20/69] Add Azure Monitor telemetry and improve logging/configs (#241) Integrate Azure Monitor Application Insights telemetry into both CompatBot and CoreBot using OpenTelemetry. Update appsettings.json to include a placeholder Application Insights connection string and adjust logging levels for better diagnostics. Refactor EchoBot to accept an ILogger and log version info; comment out some unused message handlers. Improve CoreBot reply robustness by safely extracting conversation type. Reformat project files for consistency and explicitly add Azure Monitor package. Update Proactive Worker to use constants for ServiceUrl and FromId. Refactor ConversationClient to use StringContent for activity payloads, ensuring correct JSON serialization and content type. --- core/samples/CompatBot/CompatBot.csproj | 22 +++++++------ core/samples/CompatBot/EchoBot.cs | 32 +++++++++++++++++-- core/samples/CompatBot/Program.cs | 8 +++-- core/samples/CompatBot/appsettings.json | 4 +-- core/samples/CoreBot/CoreBot.csproj | 22 +++++++------ core/samples/CoreBot/Program.cs | 11 ++++++- core/samples/CoreBot/appsettings.json | 7 ++-- core/samples/Proactive/Worker.cs | 10 +++--- .../Microsoft.Bot.Core/ConversationClient.cs | 15 +++++---- 9 files changed, 89 insertions(+), 42 deletions(-) diff --git a/core/samples/CompatBot/CompatBot.csproj b/core/samples/CompatBot/CompatBot.csproj index 500ef454..65555e22 100644 --- a/core/samples/CompatBot/CompatBot.csproj +++ b/core/samples/CompatBot/CompatBot.csproj @@ -1,13 +1,17 @@ - + - - net8.0 - enable - enable - + + net8.0 + enable + enable + - - - + + + + + + + diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 00dc66ef..1c08c522 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -3,7 +3,9 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Teams; +using Microsoft.Bot.Core; using Microsoft.Bot.Schema; +using Microsoft.Bot.Schema.Teams; namespace CompatBot; @@ -13,7 +15,7 @@ public class ConversationData } -internal class EchoBot(ConversationState conversationState) : TeamsActivityHandler +internal class EchoBot(ConversationState conversationState, ILogger logger) : TeamsActivityHandler { public override async Task OnTurnAsync(ITurnContext turnContext, CancellationToken cancellationToken = default) { @@ -24,16 +26,42 @@ public override async Task OnTurnAsync(ITurnContext turnContext, CancellationTok protected override async Task OnMessageActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) { + logger.LogInformation("EchoBot OnMessageActivityAsync " + BotApplication.Version); + IStatePropertyAccessor conversationStateAccessors = conversationState.CreateProperty(nameof(ConversationData)); ConversationData conversationData = await conversationStateAccessors.GetAsync(turnContext, () => new ConversationData(), cancellationToken); string replyText = $"Echo from BF Compat [{conversationData.MessageCount++}]: {turnContext.Activity.Text}"; await turnContext.SendActivityAsync(MessageFactory.Text(replyText, replyText), cancellationToken); - await turnContext.SendActivityAsync(MessageFactory.Text($"[Send a proactive message `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); + // await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive message `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); } protected override async Task OnMessageReactionActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) { await turnContext.SendActivityAsync(MessageFactory.Text("Message reaction received."), cancellationToken); } + + //protected override async Task OnInstallationUpdateActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) + //{ + // await turnContext.SendActivityAsync(MessageFactory.Text("Installation update received."), cancellationToken); + // await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive messages to `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); + //} + + //protected override async Task OnInstallationUpdateAddAsync(ITurnContext turnContext, CancellationToken cancellationToken) + //{ + // await turnContext.SendActivityAsync(MessageFactory.Text("Installation update Add received."), cancellationToken); + // await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive messages to `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); + //} + + //protected override async Task OnMembersAddedAsync(IList membersAdded, ITurnContext turnContext, CancellationToken cancellationToken) + //{ + // await turnContext.SendActivityAsync(MessageFactory.Text("Welcome."), cancellationToken); + // await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive messages to `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); + //} + + //protected override async Task OnTeamsMeetingStartAsync(MeetingStartEventDetails meeting, ITurnContext turnContext, CancellationToken cancellationToken) + //{ + // await turnContext.SendActivityAsync(MessageFactory.Text("Welcome to meeting: "), cancellationToken); + // await turnContext.SendActivityAsync(MessageFactory.Text($"{meeting.Title} {meeting.MeetingType}"), cancellationToken); + //} } diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index d0b4c5da..cbfa19a9 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -1,18 +1,19 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using Azure.Monitor.OpenTelemetry.AspNetCore; using CompatBot; using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Core; - -// using Microsoft.Bot.Connector.Authentication; using Microsoft.Bot.Core.Compat; using Microsoft.Bot.Schema; -WebApplicationBuilder builder = WebApplication.CreateBuilder(args); +// using Microsoft.Bot.Connector.Authentication; +WebApplicationBuilder builder = WebApplication.CreateBuilder(args); +builder.Services.AddOpenTelemetry().UseAzureMonitor(); builder.AddCompatAdapter(); //builder.Services.AddSingleton(); @@ -29,6 +30,7 @@ WebApplication app = builder.Build(); + app.MapPost("/api/messages", async (IBotFrameworkHttpAdapter adapter, IBot bot, HttpRequest request, HttpResponse response, CancellationToken ct) => await adapter.ProcessAsync(request, response, bot, ct)); diff --git a/core/samples/CompatBot/appsettings.json b/core/samples/CompatBot/appsettings.json index 4638b699..1ff8c135 100644 --- a/core/samples/CompatBot/appsettings.json +++ b/core/samples/CompatBot/appsettings.json @@ -1,9 +1,9 @@ { + "APPLICATIONINSIGHTS_CONNECTION_STRING": "InstrumentationKey=00000000-0000-0000-0000-000000000000;", "Logging": { "LogLevel": { "Default": "Warning", - "Microsoft.AspNetCore": "Warning", - "Microsoft.Bot": "Debug" + "Microsoft.Bot": "Trace" } }, "AllowedHosts": "*" diff --git a/core/samples/CoreBot/CoreBot.csproj b/core/samples/CoreBot/CoreBot.csproj index 1a260796..a70441d9 100644 --- a/core/samples/CoreBot/CoreBot.csproj +++ b/core/samples/CoreBot/CoreBot.csproj @@ -1,13 +1,17 @@  - - net10.0 - enable - enable - - - - - + + net10.0 + enable + enable + + + + + + + + + diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index b47c0eb9..b0e96bab 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -1,11 +1,13 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using Azure.Monitor.OpenTelemetry.AspNetCore; using Microsoft.Bot.Core; using Microsoft.Bot.Core.Hosting; using Microsoft.Bot.Core.Schema; WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddOpenTelemetry().UseAzureMonitor(); webAppBuilder.Services.AddBotApplication(); WebApplication webApp = webAppBuilder.Build(); BotApplication botApp = webApp.UseBotApplication(); @@ -15,7 +17,14 @@ { string replyText = $"CoreBot running on SDK {BotApplication.Version}."; replyText += $"\r\nYou sent: `{activity.Text}` in activity of type `{activity.Type}`."; - replyText += $"\r\n to Conversation ID: `{activity.Conversation.Id}` type: `{activity.Conversation.Properties["conversationType"]}`"; + + string? conversationType = "unknown conversation type"; + if (activity.Conversation.Properties.TryGetValue("conversationType", out var ctProp)) + { + conversationType = ctProp?.ToString(); + } + + replyText += $"\r\n to Conversation ID: `{activity.Conversation.Id}` conv type: `{conversationType}`"; CoreActivity replyActivity = activity.CreateReplyMessageActivity(replyText); await botApp.SendActivityAsync(replyActivity, cancellationToken); }; diff --git a/core/samples/CoreBot/appsettings.json b/core/samples/CoreBot/appsettings.json index 169ecf5b..e022efe7 100644 --- a/core/samples/CoreBot/appsettings.json +++ b/core/samples/CoreBot/appsettings.json @@ -1,11 +1,10 @@ { + "APPLICATIONINSIGHTS_CONNECTION_STRING": "InstrumentationKey=00000000-0000-0000-0000-000000000000;", "Logging": { "LogLevel": { - "Default": "Information", - "Microsoft.AspNetCore": "Warning", + "Default": "Warning", "Microsoft.Bot.Core": "Trace" } }, - "AllowedHosts": "*", - "Urls": "http://localhost:3978" + "AllowedHosts": "*" } diff --git a/core/samples/Proactive/Worker.cs b/core/samples/Proactive/Worker.cs index 15be17ec..7a980f34 100644 --- a/core/samples/Proactive/Worker.cs +++ b/core/samples/Proactive/Worker.cs @@ -9,6 +9,8 @@ namespace Proactive; public class Worker(ConversationClient conversationClient, ILogger logger) : BackgroundService { private const string ConversationId = "a:17vxw6pGQOb3Zfh8acXT8m_PqHycYpaFgzu2mFMUfkT-h0UskMctq5ZPPc7FIQxn2bx7rBSm5yE_HeUXsCcKZBrv77RgorB3_1_pAdvMhi39ClxQgawzyQ9GBFkdiwOxT"; + private const string FromId = "28:56653e9d-2158-46ee-90d7-675c39642038"; + private const string ServiceUrl = "https://smba.trafficmanager.net/teams/"; protected override async Task ExecuteAsync(CancellationToken stoppingToken) { @@ -19,11 +21,9 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken) CoreActivity proactiveMessage = new() { Text = $"Proactive hello at {DateTimeOffset.Now}", - ServiceUrl = new Uri("https://smba.trafficmanager.net/amer/56653e9d-2158-46ee-90d7-675c39642038/"), - Conversation = new() - { - Id = ConversationId - } + ServiceUrl = new Uri(ServiceUrl), + From = new() { Id = FromId }, + Conversation = new() { Id = ConversationId } }; string aid = await conversationClient.SendActivityAsync(proactiveMessage, stoppingToken); logger.LogInformation("Activity {Aid} sent", aid); diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index 88815376..db9e00e8 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -1,8 +1,10 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Net.Http.Headers; using System.Net.Http.Json; - +using System.Net.Mime; +using System.Text; using Microsoft.Bot.Core.Hosting; using Microsoft.Bot.Core.Schema; @@ -34,12 +36,11 @@ public async Task SendActivityAsync(CoreActivity activity, CancellationT ArgumentNullException.ThrowIfNullOrWhiteSpace(activity.Conversation.Id); ArgumentNullException.ThrowIfNull(activity.ServiceUrl); - using HttpRequestMessage request = new( - HttpMethod.Post, - $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{activity.Conversation.Id}/activities/") - { - Content = JsonContent.Create(activity, options: CoreActivity.DefaultJsonOptions), - }; + string url = $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{activity.Conversation.Id}/activities/"; + + using StringContent content = new(activity.ToJson(), Encoding.UTF8, MediaTypeNames.Application.Json); + + using HttpRequestMessage request = new(HttpMethod.Post, url) { Content = content }; request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity); From 4e2a51f8538ed6d34126134765e98ab5da66f049 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Thu, 11 Dec 2025 16:53:36 -0800 Subject: [PATCH 21/69] Remove unused usings and improve TryGetValue typing Removed unnecessary using directives from EchoBot.cs and ConversationClient.cs. Updated TryGetValue in Program.cs to use object? for better type safety and clarity. --- core/samples/CompatBot/EchoBot.cs | 1 - core/samples/CoreBot/Program.cs | 2 +- core/src/Microsoft.Bot.Core/ConversationClient.cs | 2 -- 3 files changed, 1 insertion(+), 4 deletions(-) diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 1c08c522..0b37569f 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -5,7 +5,6 @@ using Microsoft.Bot.Builder.Teams; using Microsoft.Bot.Core; using Microsoft.Bot.Schema; -using Microsoft.Bot.Schema.Teams; namespace CompatBot; diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index b0e96bab..cae91d05 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -19,7 +19,7 @@ replyText += $"\r\nYou sent: `{activity.Text}` in activity of type `{activity.Type}`."; string? conversationType = "unknown conversation type"; - if (activity.Conversation.Properties.TryGetValue("conversationType", out var ctProp)) + if (activity.Conversation.Properties.TryGetValue("conversationType", out object? ctProp)) { conversationType = ctProp?.ToString(); } diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index db9e00e8..eb4b1b75 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -1,8 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Net.Http.Headers; -using System.Net.Http.Json; using System.Net.Mime; using System.Text; using Microsoft.Bot.Core.Hosting; From 4d7ae86047071e015173d02e98cf734fd282ecc6 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Thu, 11 Dec 2025 17:00:06 -0800 Subject: [PATCH 22/69] Update pipeline triggers and add PushToADOFeed variable Refactored pipeline triggers to use path filters for PRs, targeting only core/** changes. Removed obsolete trigger config and comments. Introduced PushToADOFeed variable to control NuGet push step, replacing branch-based condition. --- .azdo/cd-core.yaml | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/.azdo/cd-core.yaml b/.azdo/cd-core.yaml index 8c618fc1..ef84ebbd 100644 --- a/.azdo/cd-core.yaml +++ b/.azdo/cd-core.yaml @@ -1,12 +1,10 @@ pr: -- next/* branches: include: - next/* - # Uncomment and edit the following lines to add path filters for PRs in the future - # paths: - # include: - # - core/** + paths: + include: + - core/** trigger: branches: @@ -16,11 +14,9 @@ trigger: include: - core/** - -trigger: - branches: - include: - - next/* +variables: +- name: PushToADOFeed + value: false pool: vmImage: 'ubuntu-22.04' @@ -62,7 +58,7 @@ stages: - task: NuGetCommand@2 displayName: 'Push NuGet Packages' - condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/next/core')) + condition: eq(variables['PushToADOFeed'], true) inputs: command: push packagesToPush: '$(Build.ArtifactStagingDirectory)/*.nupkg' From 0e90563dec9a9781017993862e1cef964420c354 Mon Sep 17 00:00:00 2001 From: Rido Date: Fri, 12 Dec 2025 07:16:34 +0000 Subject: [PATCH 23/69] Fix reply activity creation method in middleware --- core/samples/scenarios/middleware.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/samples/scenarios/middleware.cs b/core/samples/scenarios/middleware.cs index 71b65d52..9b9e28ea 100755 --- a/core/samples/scenarios/middleware.cs +++ b/core/samples/scenarios/middleware.cs @@ -18,7 +18,7 @@ botApp.OnActivity = async (activity, cancellationToken) => { - var replyActivity = activity.CreateReplyActivity("You said " + activity.Text); + var replyActivity = activity.CreateReplyMessageActivity("You said " + activity.Text); await botApp.SendActivityAsync(replyActivity, cancellationToken); }; From b9495ec8cf3821c04a441b187013db71bb0a361e Mon Sep 17 00:00:00 2001 From: Rido Date: Fri, 12 Dec 2025 15:08:39 -0800 Subject: [PATCH 24/69] Configure MSAL based on different configuration styles (#243) This pull request introduces significant improvements to the authentication and configuration system for bot applications, focusing on simplifying and unifying the way MSAL (Microsoft Authentication Library) configuration is handled. It introduces a new configuration API, refactors service registration methods, and adds a new test project to validate these changes. Additionally, it updates code style and suppresses certain warnings for better developer experience. **Authentication & Configuration Refactoring:** * Refactored the authentication service registration by replacing `AddBotApplicationClients` with a new `AddConversationClient` method, which provides a more flexible and unified way to configure MSAL using different sources (config section, environment variables, or Bot Framework config). This includes new helper methods for configuring MSAL with secrets, managed identity, or config sections. (`core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs`, `core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs`, `core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs`) [[1]](diffhunk://#diff-728b405fea621393bf54709dd9edcf171d5c2a2113e8a3fbf4732f403ba4e235R63-R199) [[2]](diffhunk://#diff-728b405fea621393bf54709dd9edcf171d5c2a2113e8a3fbf4732f403ba4e235L45-R49) [[3]](diffhunk://#diff-728ccc3d98609bc95b459589eb6973c2d6fa67d456334edf7b2a9c3cc1bb52c1R1-R38) [[4]](diffhunk://#diff-3e082ff899db0608432b5278502dfa1b5765cf4cf34c5a7c63fdf507d1746e3aL52-R61) [[5]](diffhunk://#diff-3e082ff899db0608432b5278502dfa1b5765cf4cf34c5a7c63fdf507d1746e3aL110-R109) * Updated the sample project (`Proactive`) and the main extension method to use `AddConversationClient` instead of the old `AddBotApplicationClients`, ensuring all samples and new code use the unified registration approach. (`core/samples/Proactive/Program.cs`, `core/samples/CoreBot/CoreBot.csproj`) [[1]](diffhunk://#diff-f32e1fd30a40c5aa42855895485dbb9c8b79d4029cd3db1a1446f48846f8604dL9-R9) [[2]](diffhunk://#diff-1087baf076a83b00d0c97ef01c02174668cb26c9fad5d2c33284e0889150ed65R7) **Testing & Validation:** * Added a new test project `msal-config-api` with a sample program to validate the new MSAL configuration API and ensure that the new registration and authentication flow works as expected. (`core/test/msal-config-api/Program.cs`, `core/test/msal-config-api/msal-config-api.csproj`, `core/core.slnx`) [[1]](diffhunk://#diff-11109e323e3906c20862f811ae5cd1fed439a5993872152d08b0fc80ea7be8f1R1-R47) [[2]](diffhunk://#diff-8764e4985371ddc60cf5f1c97c350ee3440584be4013586deb0b21116898f2d3R1-R15) [[3]](diffhunk://#diff-19ad97af5c1b7109a9c62f830310091f393489def210b9ec1ffce152b8bf958cR18) **Developer Experience Improvements:** * Updated `.editorconfig` to suppress certain warnings (e.g., missing XML comments, logger performance) for both the main codebase and samples, making development smoother. (`core/.editorconfig`) [[1]](diffhunk://#diff-f8a1aa667bae260675fe0c49b3ad037b4ce945cbb1ad3fb36a57a608695c3f11R14-R15) [[2]](diffhunk://#diff-f8a1aa667bae260675fe0c49b3ad037b4ce945cbb1ad3fb36a57a608695c3f11R36-R38) **Other Minor Changes:** * Added a missing `using` directive and made minor code cleanup in hosting and authentication handler files. (`core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs`, `core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs`) [[1]](diffhunk://#diff-728b405fea621393bf54709dd9edcf171d5c2a2113e8a3fbf4732f403ba4e235R4) [[2]](diffhunk://#diff-3e082ff899db0608432b5278502dfa1b5765cf4cf34c5a7c63fdf507d1746e3aL13) These changes collectively modernize and streamline bot authentication, making it more robust and easier to configure for different deployment scenarios. --- core/.editorconfig | 5 + core/core.slnx | 2 + core/samples/Proactive/Program.cs | 2 +- .../Hosting/AddBotApplicationExtensions.cs | 149 ++++++++++++++---- .../Hosting/BotAuthenticationHandler.cs | 11 +- .../Microsoft.Bot.Core/Hosting/BotConfig.cs | 38 +++++ core/test/msal-config-api/Program.cs | 47 ++++++ .../msal-config-api/msal-config-api.csproj | 15 ++ 8 files changed, 228 insertions(+), 41 deletions(-) create mode 100644 core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs create mode 100644 core/test/msal-config-api/Program.cs create mode 100644 core/test/msal-config-api/msal-config-api.csproj diff --git a/core/.editorconfig b/core/.editorconfig index ad100670..540657fa 100644 --- a/core/.editorconfig +++ b/core/.editorconfig @@ -11,6 +11,8 @@ trim_trailing_whitespace = true indent_style = space indent_size = 4 nullable = enable +#dotnet_diagnostic.CS1591.severity = none ## Suppress missing XML comment warnings +dotnet_diagnostic.CA1848.severity = warning #### Nullable Reference Types #### # Make nullable warnings strict @@ -31,6 +33,9 @@ csharp_new_line_before_else = true file_header_template = Copyright (c) Microsoft Corporation.\nLicensed under the MIT License. +[samples/**/*.cs] +dotnet_diagnostic.CA1848.severity = none # Suppress Logger perfomance in samples + # Test projects can be more lenient [tests/**/*.cs] dotnet_diagnostic.CS8602.severity = warning diff --git a/core/core.slnx b/core/core.slnx index 699c3e90..525caa66 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -5,6 +5,7 @@ + @@ -15,4 +16,5 @@ + diff --git a/core/samples/Proactive/Program.cs b/core/samples/Proactive/Program.cs index 2411c10a..ae7e7b25 100644 --- a/core/samples/Proactive/Program.cs +++ b/core/samples/Proactive/Program.cs @@ -6,7 +6,7 @@ using Proactive; HostApplicationBuilder builder = Host.CreateApplicationBuilder(args); -builder.Services.AddBotApplicationClients(); +builder.Services.AddConversationClient(); builder.Services.AddHostedService(); IHost host = builder.Build(); diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 9cd14daa..84d5f567 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Diagnostics.Eventing.Reader; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Http; using Microsoft.Bot.Core.Schema; @@ -42,10 +43,10 @@ public static TApp UseBotApplication( where TApp : BotApplication { ArgumentNullException.ThrowIfNull(builder); - WebApplication? webApp = builder as WebApplication; TApp app = builder.ApplicationServices.GetService() ?? throw new InvalidOperationException("Application not registered"); - - webApp?.MapPost(routePath, async (HttpContext httpContext, CancellationToken cancellationToken) => + WebApplication? webApp = builder as WebApplication; + ArgumentNullException.ThrowIfNull(webApp); + webApp.MapPost(routePath, async (HttpContext httpContext, CancellationToken cancellationToken) => { CoreActivity resp = await app.ProcessAsync(httpContext, cancellationToken).ConfigureAwait(false); return resp.Id; @@ -59,61 +60,141 @@ public static TApp UseBotApplication( /// /// /// + /// /// - public static IServiceCollection AddBotApplication(this IServiceCollection services) where TApp : BotApplication + public static IServiceCollection AddBotApplication(this IServiceCollection services, string sectionName = "AzureAd") where TApp : BotApplication { - services.AddBotApplicationClients(); + services.AddConversationClient(sectionName); services.AddSingleton(); return services; } - + /// - /// Adds and configures Bot Framework application clients and related authentication services to the specified - /// service collection. + /// Adds a conversation client to the service collection. /// - /// This method registers HTTP clients, token acquisition, in-memory token caching, and agent - /// identity services required for Bot Framework integration. It also configures authentication options using the - /// specified Azure AD configuration section. The method should be called during application startup as part of - /// service configuration. - /// The service collection to which the Bot Framework clients and authentication services will be added. Must not be - /// null. - /// The name of the configuration section containing Azure Active Directory settings. Defaults to "AzureAd" if not - /// specified. - /// The same service collection instance, enabling method chaining. - public static IServiceCollection AddBotApplicationClients(this IServiceCollection services, string aadConfigSectionName = "AzureAd") + /// service collection + /// Configuration Section name, defaults to AzureAD + /// + public static IServiceCollection AddConversationClient(this IServiceCollection services, string sectionName = "AzureAd") { IConfiguration configuration = services.BuildServiceProvider().GetRequiredService(); + ArgumentNullException.ThrowIfNull(configuration); + + string scope = "https://api.botframework.com/.default"; + if (configuration["${sectionName}:Scopes"] is not null) + { + scope = configuration[$"{sectionName}:Scopes"]!; + } + + if (configuration["Scope"] is not null) //ToChannelFromBotOAuthScope + { + scope = configuration["Scope"]!; + } + services .AddHttpClient() .AddTokenAcquisition(true) .AddInMemoryTokenCaches() .AddAgentIdentities(); - services.Configure(aadConfigSectionName, configuration.GetSection(aadConfigSectionName)); + services.ConfigureMSAL(configuration, sectionName); + services.AddHttpClient(ConversationClient.ConversationHttpClientName) + .AddHttpMessageHandler(sp => new BotAuthenticationHandler( + sp.GetRequiredService(), + sp.GetRequiredService>(), + scope)); + return services; + } + + private static IServiceCollection ConfigureMSAL(this IServiceCollection services, IConfiguration configuration, string sectionName) + { + ArgumentNullException.ThrowIfNull(configuration); + + if (configuration["MicrosoftAppId"] is not null) + { + var botConfig = BotConfig.FromBFConfig(configuration); + services.ConfigureMSALFromBotConfig(botConfig); + } + else if (configuration["CLIENT_ID"] is not null) + { + var botConfig = BotConfig.FromCoreConfig(configuration); + services.ConfigureMSALFromBotConfig(botConfig); + } + else + { + services.ConfigureMSALFromConfig(configuration.GetSection(sectionName)); + } + return services; + } + + private static IServiceCollection ConfigureMSALFromConfig(this IServiceCollection services, IConfigurationSection msalConfigSection) + { + ArgumentNullException.ThrowIfNull(msalConfigSection); + services.Configure(msalConfigSection); + return services; + } + + private static IServiceCollection ConfigureMSALWithSecret(this IServiceCollection services, string tenantId, string clientId, string clientSecret) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentNullException.ThrowIfNullOrWhiteSpace(clientId); + ArgumentNullException.ThrowIfNullOrWhiteSpace(clientSecret); - string agentScope = configuration[$"{aadConfigSectionName}:Scope"] ?? "https://api.botframework.com/.default"; + services.Configure(options => + { + options.Instance = "https://login.microsoftonline.com/"; + options.TenantId = tenantId; + options.ClientId = clientId; + options.ClientCredentials = [ + new CredentialDescription() + { + SourceType = CredentialSource.ClientSecret, + ClientSecret = clientSecret + } + ]; + }); + return services; + } + + private static IServiceCollection ConfigureMSALWithFIC(this IServiceCollection services, string tenantId, string clientId, string? ficClientId) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentNullException.ThrowIfNullOrWhiteSpace(clientId); - if (configuration.GetSection(aadConfigSectionName).Get() is null) + var ficCredential = new CredentialDescription() { -#pragma warning disable CA1848 // Use the LoggerMessage delegates - services.BuildServiceProvider().GetRequiredService() - .CreateLogger("AddBotApplicationExtensions") - .LogWarning("No configuration found for section {AadConfigSectionName}. BotAuthenticationHandler will not be configured.", aadConfigSectionName); -#pragma warning restore CA1848 // Use the LoggerMessage delegates + SourceType = CredentialSource.SignedAssertionFromManagedIdentity, + }; + if (!string.IsNullOrEmpty(ficClientId) && clientId != ficClientId) + { + ficCredential.ManagedIdentityClientId = ficClientId; + } - services.AddHttpClient(ConversationClient.ConversationHttpClientName); + services.Configure(options => + { + options.Instance = "https://login.microsoftonline.com/"; + options.TenantId = tenantId; + options.ClientId = clientId; + options.ClientCredentials = [ + ficCredential + ]; + }); + return services; + } + private static IServiceCollection ConfigureMSALFromBotConfig(this IServiceCollection services, BotConfig botConfig) + { + ArgumentNullException.ThrowIfNull(botConfig); + if (!string.IsNullOrEmpty(botConfig.ClientSecret)) + { + services.ConfigureMSALWithSecret(botConfig.TenantId, botConfig.ClientId, botConfig.ClientSecret); } else { - services.AddHttpClient(ConversationClient.ConversationHttpClientName) - .AddHttpMessageHandler(sp => new BotAuthenticationHandler( - sp.GetRequiredService(), - sp.GetRequiredService>(), - agentScope, - aadConfigSectionName)); + services.ConfigureMSALWithFIC(botConfig.TenantId, botConfig.ClientId, botConfig.FicClientId); } - return services; } + + } diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs index b4573bac..52d9fe0e 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -10,7 +10,6 @@ namespace Microsoft.Bot.Core.Hosting; - /// /// Represents an agentic identity for user-delegated token acquisition. /// @@ -49,17 +48,17 @@ internal sealed class AgenticIdentity /// The authorization header provider for acquiring tokens. /// The logger instance. /// The scope for the token request. -/// The configuration section name for Azure AD settings. internal sealed class BotAuthenticationHandler( IAuthorizationHeaderProvider authorizationHeaderProvider, ILogger logger, - string scope, - string aadConfigSectionName = "AzureAd") : DelegatingHandler + string scope) : DelegatingHandler { private readonly IAuthorizationHeaderProvider _authorizationHeaderProvider = authorizationHeaderProvider ?? throw new ArgumentNullException(nameof(authorizationHeaderProvider)); private readonly ILogger _logger = logger ?? throw new ArgumentNullException(nameof(logger)); private readonly string _scope = scope ?? throw new ArgumentNullException(nameof(scope)); - private readonly string _aadConfigSectionName = aadConfigSectionName ?? throw new ArgumentNullException(nameof(aadConfigSectionName)); + //private readonly string _aadConfigSectionName = aadConfigSectionName ?? throw new ArgumentNullException(nameof(aadConfigSectionName)); + + //_logger.LogInformation("BotAuthenticationHandler initialized with scope: {Scope} and AAD config section: {AadConfigSectionName}", scope, aadConfigSectionName); private static readonly Action LogAcquiringAgenticToken = LoggerMessage.Define( @@ -107,7 +106,7 @@ private async Task GetAuthorizationHeaderAsync(AgenticIdentity? agenticI { AcquireTokenOptions = new AcquireTokenOptions() { - AuthenticationOptionsName = _aadConfigSectionName, + //AuthenticationOptionsName = _aadConfigSectionName, } }; diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs b/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs new file mode 100644 index 00000000..17630ba1 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs @@ -0,0 +1,38 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Extensions.Configuration; + +namespace Microsoft.Bot.Core.Hosting; + + +internal sealed class BotConfig +{ + public string TenantId { get; set; } = string.Empty; + public string ClientId { get; set; } = string.Empty; + public string? ClientSecret { get; set; } + public string? FicClientId { get; set; } + + public static BotConfig FromBFConfig(IConfiguration configuration) + { + ArgumentNullException.ThrowIfNull(configuration); + return new() + { + TenantId = configuration["MicrosoftAppTenantId"] ?? string.Empty, + ClientId = configuration["MicrosoftAppId"] ?? string.Empty, + ClientSecret = configuration["MicrosoftAppPassword"], + }; + } + + public static BotConfig FromCoreConfig(IConfiguration configuration) + { + ArgumentNullException.ThrowIfNull(configuration); + return new() + { + TenantId = configuration["TENANT_ID"] ?? string.Empty, + ClientId = configuration["CLIENT_ID"] ?? string.Empty, + ClientSecret = configuration["CLIENT_SECRET"], + FicClientId = configuration["MANAGED_IDENTITY_CLIENT_ID"], + }; + } +} diff --git a/core/test/msal-config-api/Program.cs b/core/test/msal-config-api/Program.cs new file mode 100644 index 00000000..869f9b3f --- /dev/null +++ b/core/test/msal-config-api/Program.cs @@ -0,0 +1,47 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; + + +string ConversationId = "a:17vxw6pGQOb3Zfh8acXT8m_PqHycYpaFgzu2mFMUfkT-h0UskMctq5ZPPc7FIQxn2bx7rBSm5yE_HeUXsCcKZBrv77RgorB3_1_pAdvMhi39ClxQgawzyQ9GBFkdiwOxT"; +string FromId = "28:56653e9d-2158-46ee-90d7-675c39642038"; +string ServiceUrl = "https://smba.trafficmanager.net/teams/"; + +ConversationClient conversationClient = CreateConversationClient(); +await conversationClient.SendActivityAsync(new CoreActivity +{ + Text = "Hello from MSAL Config API test!", + Conversation = new() { Id = ConversationId }, + ServiceUrl = new Uri(ServiceUrl), + From = new() { Id = FromId } + +}, cancellationToken: default); + +static ConversationClient CreateConversationClient() +{ + ServiceCollection services = InitializeDIContainer(); + services.AddConversationClient(); + ServiceProvider serviceProvider = services.BuildServiceProvider(); + ConversationClient conversationClient = serviceProvider.GetRequiredService(); + return conversationClient; +} + +static ServiceCollection InitializeDIContainer() +{ + IConfigurationBuilder builder = new ConfigurationBuilder() + .SetBasePath(AppDomain.CurrentDomain.BaseDirectory) + .AddEnvironmentVariables(); + + IConfiguration configuration = builder.Build(); + + ServiceCollection services = new(); + services.AddSingleton(configuration); + services.AddLogging(configure => configure.AddConsole()); + return services; +} \ No newline at end of file diff --git a/core/test/msal-config-api/msal-config-api.csproj b/core/test/msal-config-api/msal-config-api.csproj new file mode 100644 index 00000000..73ff80f1 --- /dev/null +++ b/core/test/msal-config-api/msal-config-api.csproj @@ -0,0 +1,15 @@ + + + + Exe + net10.0 + msal_config_api + enable + enable + + + + + + + From 154b58a037f3c00990429981c897a1cfec5411e6 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Fri, 12 Dec 2025 16:25:03 -0800 Subject: [PATCH 25/69] compat bot handlers --- core/samples/CompatBot/EchoBot.cs | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 0b37569f..f23c1744 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -40,17 +40,17 @@ protected override async Task OnMessageReactionActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) - //{ - // await turnContext.SendActivityAsync(MessageFactory.Text("Installation update received."), cancellationToken); - // await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive messages to `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); - //} + protected override async Task OnInstallationUpdateActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) + { + await turnContext.SendActivityAsync(MessageFactory.Text("Installation update received."), cancellationToken); + await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive messages to `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); + } - //protected override async Task OnInstallationUpdateAddAsync(ITurnContext turnContext, CancellationToken cancellationToken) - //{ - // await turnContext.SendActivityAsync(MessageFactory.Text("Installation update Add received."), cancellationToken); - // await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive messages to `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); - //} + protected override async Task OnInstallationUpdateAddAsync(ITurnContext turnContext, CancellationToken cancellationToken) + { + await turnContext.SendActivityAsync(MessageFactory.Text("Installation update Add received."), cancellationToken); + await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive messages to `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); + } //protected override async Task OnMembersAddedAsync(IList membersAdded, ITurnContext turnContext, CancellationToken cancellationToken) //{ From 1dcd2798c12d45acad5c27e630e0cf52e87af83f Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Fri, 12 Dec 2025 17:05:43 -0800 Subject: [PATCH 26/69] Improve message formatting and agent identity handling - Use HTML line breaks in bot replies and proactive messages for better formatting. - Send proactive messages with MessageFactory.Text. - Extract AgenticIdentity per activity instead of storing on ConversationClient. - Register ConversationClient HttpClient with authentication handler. - Throw exception if no valid MSAL config is found. - Remove unused using directive in BotApplication.cs. --- core/samples/CompatBot/Program.cs | 3 ++- core/samples/CoreBot/Program.cs | 4 ++-- core/src/Microsoft.Bot.Core/BotApplication.cs | 4 ---- core/src/Microsoft.Bot.Core/ConversationClient.cs | 4 +--- .../Hosting/AddBotApplicationExtensions.cs | 7 ++++++- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index cbfa19a9..69d2ed71 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -46,7 +46,8 @@ proactive.GetConversationReference(), async (turnContext, ct) => { - await turnContext.SendActivityAsync($"Proactive Message send from SDK `{BotApplication.Version}` at {DateTime.Now:T}"); + await turnContext.SendActivityAsync( + MessageFactory.Text($"Proactive.
SDK `{BotApplication.Version}` at {DateTime.Now:T}"), ct); }, ct); }); diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index cae91d05..ed340094 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -16,7 +16,7 @@ botApp.OnActivity = async (activity, cancellationToken) => { string replyText = $"CoreBot running on SDK {BotApplication.Version}."; - replyText += $"\r\nYou sent: `{activity.Text}` in activity of type `{activity.Type}`."; + replyText += $"
You sent: `{activity.Text}` in activity of type `{activity.Type}`."; string? conversationType = "unknown conversation type"; if (activity.Conversation.Properties.TryGetValue("conversationType", out object? ctProp)) @@ -24,7 +24,7 @@ conversationType = ctProp?.ToString(); } - replyText += $"\r\n to Conversation ID: `{activity.Conversation.Id}` conv type: `{conversationType}`"; + replyText += $"
To Conversation ID: `{activity.Conversation.Id}` conv type: `{conversationType}`"; CoreActivity replyActivity = activity.CreateReplyMessageActivity(replyText); await botApp.SendActivityAsync(replyActivity, cancellationToken); }; diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs index 9e9ddc74..20c606a8 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -2,7 +2,6 @@ // Licensed under the MIT License. using Microsoft.AspNetCore.Http; -using Microsoft.Bot.Core.Hosting; using Microsoft.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; @@ -81,9 +80,6 @@ public async Task ProcessAsync(HttpContext httpContext, Cancellati _logger.LogTrace("Received activity: {Activity}", activity.ToJson()); } - AgenticIdentity? agenticIdentity = AgenticIdentity.FromProperties(activity.Recipient.Properties); - _conversationClient.AgenticIdentity = agenticIdentity; - using (_logger.BeginScope("Processing activity {Type} {Id}", activity.Type, activity.Id)) { try diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index eb4b1b75..a27de471 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -16,8 +16,6 @@ public class ConversationClient(HttpClient httpClient) { internal const string ConversationHttpClientName = "BotConversationClient"; - internal AgenticIdentity? AgenticIdentity { get; set; } - /// /// Sends the specified activity to the conversation endpoint asynchronously. /// @@ -40,7 +38,7 @@ public async Task SendActivityAsync(CoreActivity activity, CancellationT using HttpRequestMessage request = new(HttpMethod.Post, url) { Content = content }; - request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity); + request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity.FromProperties(activity.Recipient.Properties)); using HttpResponseMessage resp = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 84d5f567..1cb9187e 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -98,6 +98,7 @@ public static IServiceCollection AddConversationClient(this IServiceCollection s .AddAgentIdentities(); services.ConfigureMSAL(configuration, sectionName); + services.AddHttpClient(ConversationClient.ConversationHttpClientName) .AddHttpMessageHandler(sp => new BotAuthenticationHandler( sp.GetRequiredService(), @@ -120,10 +121,14 @@ private static IServiceCollection ConfigureMSAL(this IServiceCollection services var botConfig = BotConfig.FromCoreConfig(configuration); services.ConfigureMSALFromBotConfig(botConfig); } - else + else if (configuration.GetSection(sectionName) is not null) { services.ConfigureMSALFromConfig(configuration.GetSection(sectionName)); } + else + { + throw new InvalidOperationException("No valid MSAL configuration found."); + } return services; } From 23075bf7dd5cfe8ad7b612d544b9dcfd3dc70437 Mon Sep 17 00:00:00 2001 From: Aamir Jawaid <48929123+heyitsaamir@users.noreply.github.com> Date: Mon, 15 Dec 2025 14:20:39 -0800 Subject: [PATCH 27/69] Add UMI support (#244) Added UMI support to Core. This is done via `ManagedIdentityOptions` that need to be set. This type of auth is a bit off-band with the rest of MSAL. * Added UMI support (tested it) * Add some debug logging to tell us what kind of logs are being used. Unsure if this is the right approach TBH. * Add some unit tests --- .../Hosting/AddBotApplicationExtensions.cs | 77 ++++++- .../Hosting/BotAuthenticationHandler.cs | 40 ++-- .../Microsoft.Bot.Core/Hosting/BotConfig.cs | 2 + .../Microsoft.Bot.Core.csproj | 5 +- .../AddBotApplicationExtensionsTests.cs | 208 ++++++++++++++++++ 5 files changed, 301 insertions(+), 31 deletions(-) create mode 100644 core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 1cb9187e..c0226022 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -8,6 +8,7 @@ using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; using Microsoft.Identity.Web; using Microsoft.Identity.Web.TokenCacheProviders.InMemory; @@ -24,7 +25,6 @@ namespace Microsoft.Bot.Core.Hosting; /// methods are called in the application's service configuration pipeline. public static class AddBotApplicationExtensions { - /// /// Configures the application to handle bot messages at the specified route and returns the registered bot /// application instance. @@ -98,36 +98,36 @@ public static IServiceCollection AddConversationClient(this IServiceCollection s .AddAgentIdentities(); services.ConfigureMSAL(configuration, sectionName); - services.AddHttpClient(ConversationClient.ConversationHttpClientName) .AddHttpMessageHandler(sp => new BotAuthenticationHandler( sp.GetRequiredService(), sp.GetRequiredService>(), - scope)); + scope, + sp.GetService>())); return services; } private static IServiceCollection ConfigureMSAL(this IServiceCollection services, IConfiguration configuration, string sectionName) { ArgumentNullException.ThrowIfNull(configuration); + var logger = services.BuildServiceProvider().GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); if (configuration["MicrosoftAppId"] is not null) { + _logUsingBFConfig(logger, null); var botConfig = BotConfig.FromBFConfig(configuration); - services.ConfigureMSALFromBotConfig(botConfig); + services.ConfigureMSALFromBotConfig(botConfig, logger); } else if (configuration["CLIENT_ID"] is not null) { + _logUsingCoreConfig(logger, null); var botConfig = BotConfig.FromCoreConfig(configuration); - services.ConfigureMSALFromBotConfig(botConfig); - } - else if (configuration.GetSection(sectionName) is not null) - { - services.ConfigureMSALFromConfig(configuration.GetSection(sectionName)); + services.ConfigureMSALFromBotConfig(botConfig, logger); } else { - throw new InvalidOperationException("No valid MSAL configuration found."); + _logUsingSectionConfig(logger, sectionName, null); + services.ConfigureMSALFromConfig(configuration.GetSection(sectionName)); } return services; } @@ -147,6 +147,7 @@ private static IServiceCollection ConfigureMSALWithSecret(this IServiceCollectio services.Configure(options => { + // TODO: Make Instance configurable options.Instance = "https://login.microsoftonline.com/"; options.TenantId = tenantId; options.ClientId = clientId; @@ -170,13 +171,14 @@ private static IServiceCollection ConfigureMSALWithFIC(this IServiceCollection s { SourceType = CredentialSource.SignedAssertionFromManagedIdentity, }; - if (!string.IsNullOrEmpty(ficClientId) && clientId != ficClientId) + if (!string.IsNullOrEmpty(ficClientId) && !IsSystemAssignedManagedIdentity(ficClientId)) { ficCredential.ManagedIdentityClientId = ficClientId; } services.Configure(options => { + // TODO: Make Instance configurable options.Instance = "https://login.microsoftonline.com/"; options.TenantId = tenantId; options.ClientId = clientId; @@ -187,19 +189,70 @@ private static IServiceCollection ConfigureMSALWithFIC(this IServiceCollection s return services; } - private static IServiceCollection ConfigureMSALFromBotConfig(this IServiceCollection services, BotConfig botConfig) + private static IServiceCollection ConfigureMSALWithUMI(this IServiceCollection services, string tenantId, string clientId, string? managedIdentityClientId = null) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentNullException.ThrowIfNullOrWhiteSpace(clientId); + + // Register ManagedIdentityOptions for BotAuthenticationHandler to use + bool isSystemAssigned = IsSystemAssignedManagedIdentity(managedIdentityClientId); + string? umiClientId = isSystemAssigned ? null : (managedIdentityClientId ?? clientId); + + services.Configure(options => + { + options.UserAssignedClientId = umiClientId; + }); + + services.Configure(options => + { + // TODO: Make Instance configurable + options.Instance = "https://login.microsoftonline.com/"; + options.TenantId = tenantId; + options.ClientId = clientId; + }); + return services; + } + + private static IServiceCollection ConfigureMSALFromBotConfig(this IServiceCollection services, BotConfig botConfig, ILogger logger) { ArgumentNullException.ThrowIfNull(botConfig); if (!string.IsNullOrEmpty(botConfig.ClientSecret)) { + _logUsingClientSecret(logger, null); services.ConfigureMSALWithSecret(botConfig.TenantId, botConfig.ClientId, botConfig.ClientSecret); } + else if (string.IsNullOrEmpty(botConfig.FicClientId) || botConfig.FicClientId == botConfig.ClientId) + { + _logUsingUMI(logger, null); + services.ConfigureMSALWithUMI(botConfig.TenantId, botConfig.ClientId, botConfig.FicClientId); + } else { + bool isSystemAssigned = IsSystemAssignedManagedIdentity(botConfig.FicClientId); + _logUsingFIC(logger, isSystemAssigned ? "System-Assigned" : "User-Assigned", null); services.ConfigureMSALWithFIC(botConfig.TenantId, botConfig.ClientId, botConfig.FicClientId); } return services; } + /// + /// Determines if the provided client ID represents a system-assigned managed identity. + /// + private static bool IsSystemAssignedManagedIdentity(string? clientId) + => string.Equals(clientId, BotConfig.SystemManagedIdentityIdentifier, StringComparison.OrdinalIgnoreCase); + + private static readonly Action _logUsingBFConfig = + LoggerMessage.Define(LogLevel.Debug, new(1), "Configuring MSAL from Bot Framework configuration"); + private static readonly Action _logUsingCoreConfig = + LoggerMessage.Define(LogLevel.Debug, new(2), "Configuring MSAL from Core bot configuration"); + private static readonly Action _logUsingSectionConfig = + LoggerMessage.Define(LogLevel.Debug, new(3), "Configuring MSAL from {SectionName} configuration section"); + private static readonly Action _logUsingClientSecret = + LoggerMessage.Define(LogLevel.Debug, new(4), "Configuring authentication with client secret"); + private static readonly Action _logUsingUMI = + LoggerMessage.Define(LogLevel.Debug, new(5), "Configuring authentication with User-Assigned Managed Identity"); + private static readonly Action _logUsingFIC = + LoggerMessage.Define(LogLevel.Debug, new(6), "Configuring authentication with Federated Identity Credential (Managed Identity) with {IdentityType} Managed Identity"); + } diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs index 52d9fe0e..208f0c58 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -5,6 +5,7 @@ using Microsoft.Bot.Core.Schema; using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; using Microsoft.Identity.Web; @@ -48,29 +49,21 @@ internal sealed class AgenticIdentity /// The authorization header provider for acquiring tokens. /// The logger instance. /// The scope for the token request. +/// Optional managed identity options for user-assigned managed identity authentication. internal sealed class BotAuthenticationHandler( IAuthorizationHeaderProvider authorizationHeaderProvider, ILogger logger, - string scope) : DelegatingHandler + string scope, + IOptions? managedIdentityOptions = null) : DelegatingHandler { private readonly IAuthorizationHeaderProvider _authorizationHeaderProvider = authorizationHeaderProvider ?? throw new ArgumentNullException(nameof(authorizationHeaderProvider)); private readonly ILogger _logger = logger ?? throw new ArgumentNullException(nameof(logger)); private readonly string _scope = scope ?? throw new ArgumentNullException(nameof(scope)); - //private readonly string _aadConfigSectionName = aadConfigSectionName ?? throw new ArgumentNullException(nameof(aadConfigSectionName)); - - //_logger.LogInformation("BotAuthenticationHandler initialized with scope: {Scope} and AAD config section: {AadConfigSectionName}", scope, aadConfigSectionName); - - private static readonly Action LogAcquiringAgenticToken = - LoggerMessage.Define( - LogLevel.Debug, - new EventId(1, nameof(LogAcquiringAgenticToken)), - "Acquiring agentic token for appId: {AgenticAppId}, userId: {AgenticUserId}"); - - private static readonly Action LogAcquiringAppOnlyToken = - LoggerMessage.Define( - LogLevel.Debug, - new EventId(2, nameof(LogAcquiringAppOnlyToken)), - "Acquiring app-only token for scope: {Scope}"); + private readonly IOptions? _managedIdentityOptions = managedIdentityOptions; + private static readonly Action _logAgenticToken = + LoggerMessage.Define(LogLevel.Debug, new(2), "Acquiring agentic token for app {AgenticAppId}"); + private static readonly Action _logAppOnlyToken = + LoggerMessage.Define(LogLevel.Debug, new(3), "Acquiring app-only token for scope: {Scope}"); /// /// Key used to store the agentic identity in HttpRequestMessage options. @@ -110,18 +103,29 @@ private async Task GetAuthorizationHeaderAsync(AgenticIdentity? agenticI } }; + // Conditionally apply ManagedIdentity configuration if registered + if (_managedIdentityOptions is not null) + { + var miOptions = _managedIdentityOptions.Value; + + if (!string.IsNullOrEmpty(miOptions.UserAssignedClientId)) + { + options.AcquireTokenOptions.ManagedIdentity = miOptions; + } + } + if (agenticIdentity is not null && !string.IsNullOrEmpty(agenticIdentity.AgenticAppId) && !string.IsNullOrEmpty(agenticIdentity.AgenticUserId)) { - LogAcquiringAgenticToken(_logger, agenticIdentity.AgenticAppId, agenticIdentity.AgenticUserId, null); + _logAgenticToken(_logger, agenticIdentity.AgenticAppId, null); options.WithAgentUserIdentity(agenticIdentity.AgenticAppId, Guid.Parse(agenticIdentity.AgenticUserId)); string token = await _authorizationHeaderProvider.CreateAuthorizationHeaderAsync([_scope], options, null, cancellationToken).ConfigureAwait(false); return token; } - LogAcquiringAppOnlyToken(_logger, _scope, null); + _logAppOnlyToken(_logger, _scope, null); string appToken = await _authorizationHeaderProvider.CreateAuthorizationHeaderForAppAsync(_scope, options, cancellationToken).ConfigureAwait(false); return appToken; } diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs b/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs index 17630ba1..d39df8af 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs @@ -8,6 +8,8 @@ namespace Microsoft.Bot.Core.Hosting; internal sealed class BotConfig { + public const string SystemManagedIdentityIdentifier = "system"; + public string TenantId { get; set; } = string.Empty; public string ClientId { get; set; } = string.Empty; public string? ClientSecret { get; set; } diff --git a/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj b/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj index 15d8df74..cb181fc6 100644 --- a/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj +++ b/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj @@ -5,8 +5,11 @@ enable enable True - + + + + diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs new file mode 100644 index 00000000..5ff3cf34 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs @@ -0,0 +1,208 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; +using Microsoft.Identity.Abstractions; +using Microsoft.Identity.Web; +using Moq; + +namespace Microsoft.Bot.Core.UnitTests.Hosting; + +public class AddBotApplicationExtensionsTests +{ + private static ServiceProvider BuildServiceProvider(Dictionary configData, string? aadConfigSectionName = null) + { + var configuration = new ConfigurationBuilder() + .AddInMemoryCollection(configData) + .Build(); + + var services = new ServiceCollection(); + services.AddSingleton(configuration); + services.AddLogging(); + + if (aadConfigSectionName is null) + { + services.AddConversationClient(); + } + else + { + services.AddConversationClient(aadConfigSectionName); + } + + return services.BuildServiceProvider(); + } + + private static void AssertMsalOptions(ServiceProvider serviceProvider, string expectedClientId, string expectedTenantId, string expectedInstance = "https://login.microsoftonline.com/") + { + var msalOptions = serviceProvider.GetRequiredService>().Value; + Assert.Equal(expectedClientId, msalOptions.ClientId); + Assert.Equal(expectedTenantId, msalOptions.TenantId); + Assert.Equal(expectedInstance, msalOptions.Instance); + } + + [Fact] + public void AddConversationClient_WithBotFrameworkConfig_ConfiguresClientSecret() + { + // Arrange + var configData = new Dictionary + { + ["MicrosoftAppId"] = "test-app-id", + ["MicrosoftAppTenantId"] = "test-tenant-id", + ["MicrosoftAppPassword"] = "test-secret" + }; + + // Act + var serviceProvider = BuildServiceProvider(configData); + + // Assert + AssertMsalOptions(serviceProvider, "test-app-id", "test-tenant-id"); + var msalOptions = serviceProvider.GetRequiredService>().Value; + Assert.NotNull(msalOptions.ClientCredentials); + Assert.Single(msalOptions.ClientCredentials); + var credential = msalOptions.ClientCredentials.First(); + Assert.Equal(CredentialSource.ClientSecret, credential.SourceType); + Assert.Equal("test-secret", credential.ClientSecret); + } + + [Fact] + public void AddConversationClient_WithCoreConfigAndClientSecret_ConfiguresClientSecret() + { + // Arrange + var configData = new Dictionary + { + ["CLIENT_ID"] = "test-client-id", + ["TENANT_ID"] = "test-tenant-id", + ["CLIENT_SECRET"] = "test-client-secret" + }; + + // Act + var serviceProvider = BuildServiceProvider(configData); + + // Assert + AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); + var msalOptions = serviceProvider.GetRequiredService>().Value; + Assert.NotNull(msalOptions.ClientCredentials); + Assert.Single(msalOptions.ClientCredentials); + var credential = msalOptions.ClientCredentials.First(); + Assert.Equal(CredentialSource.ClientSecret, credential.SourceType); + Assert.Equal("test-client-secret", credential.ClientSecret); + } + + [Fact] + public void AddConversationClient_WithCoreConfigAndSystemAssignedMI_ConfiguresSystemAssignedFIC() + { + // Arrange + var configData = new Dictionary + { + ["CLIENT_ID"] = "test-client-id", + ["TENANT_ID"] = "test-tenant-id", + ["MANAGED_IDENTITY_CLIENT_ID"] = "system" + }; + + // Act + var serviceProvider = BuildServiceProvider(configData); + + // Assert + AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); + var msalOptions = serviceProvider.GetRequiredService>().Value; + Assert.NotNull(msalOptions.ClientCredentials); + Assert.Single(msalOptions.ClientCredentials); + var credential = msalOptions.ClientCredentials.First(); + Assert.Equal(CredentialSource.SignedAssertionFromManagedIdentity, credential.SourceType); + Assert.Null(credential.ManagedIdentityClientId); // System-assigned + + var managedIdentityOptions = serviceProvider.GetRequiredService>().Value; + Assert.Null(managedIdentityOptions.UserAssignedClientId); + } + + [Fact] + public void AddConversationClient_WithCoreConfigAndUserAssignedMI_ConfiguresUserAssignedFIC() + { + // Arrange + var configData = new Dictionary + { + ["CLIENT_ID"] = "test-client-id", + ["TENANT_ID"] = "test-tenant-id", + ["MANAGED_IDENTITY_CLIENT_ID"] = "umi-client-id" // Different from CLIENT_ID means FIC + }; + + // Act + var serviceProvider = BuildServiceProvider(configData); + + // Assert + AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); + var msalOptions = serviceProvider.GetRequiredService>().Value; + Assert.NotNull(msalOptions.ClientCredentials); + Assert.Single(msalOptions.ClientCredentials); + var credential = msalOptions.ClientCredentials.First(); + Assert.Equal(CredentialSource.SignedAssertionFromManagedIdentity, credential.SourceType); + Assert.Equal("umi-client-id", credential.ManagedIdentityClientId); + + var managedIdentityOptions = serviceProvider.GetRequiredService>().Value; + Assert.Null(managedIdentityOptions.UserAssignedClientId); + } + + [Fact] + public void AddConversationClient_WithCoreConfigAndNoManagedIdentity_ConfiguresUMIWithClientId() + { + // Arrange + var configData = new Dictionary + { + ["CLIENT_ID"] = "test-client-id", + ["TENANT_ID"] = "test-tenant-id" + }; + + // Act + var serviceProvider = BuildServiceProvider(configData); + + // Assert + AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); + var msalOptions = serviceProvider.GetRequiredService>().Value; + Assert.Null(msalOptions.ClientCredentials); + + var managedIdentityOptions = serviceProvider.GetRequiredService>().Value; + Assert.Equal("test-client-id", managedIdentityOptions.UserAssignedClientId); + } + + [Fact] + public void AddConversationClient_WithDefaultSection_ConfiguresFromSection() + { + // AzureAd is the default Section Name + // Arrange + var configData = new Dictionary + { + ["AzureAd:ClientId"] = "azuread-client-id", + ["AzureAd:TenantId"] = "azuread-tenant-id", + ["AzureAd:Instance"] = "https://login.microsoftonline.com/" + }; + + // Act + var serviceProvider = BuildServiceProvider(configData); + + // Assert + AssertMsalOptions(serviceProvider, "azuread-client-id", "azuread-tenant-id"); + } + + [Fact] + public void AddConversationClient_WithCustomSectionName_ConfiguresFromCustomSection() + { + // Arrange + var configData = new Dictionary + { + ["CustomAuth:ClientId"] = "custom-client-id", + ["CustomAuth:TenantId"] = "custom-tenant-id", + ["CustomAuth:Instance"] = "https://login.microsoftonline.com/" + }; + + // Act + var serviceProvider = BuildServiceProvider(configData, "CustomAuth"); + + // Assert + AssertMsalOptions(serviceProvider, "custom-client-id", "custom-tenant-id"); + } +} From c5e9b41e141fc5a71c2252f27de456251519c57f Mon Sep 17 00:00:00 2001 From: Rido Date: Mon, 15 Dec 2025 16:00:21 -0800 Subject: [PATCH 28/69] Add AF sample, adds SendTypingActivity (#245) This pull request introduces a new sample bot called `AFBot`, along with several improvements to resource handling, logging, and activity response types in the core libraries. The most significant changes are the addition of the `AFBot` sample (demonstrating integration with Azure OpenAI and Application Insights), updates to the way activities are sent and responded to (now returning typed `ResourceResponse` objects), and enhancements to logging and configuration for more robust diagnostics. **Key changes:** ### New Sample Bot: AFBot - Added the `AFBot` sample project, including its project file (`AFBot.csproj`), middleware (`DropTypingMiddleware.cs`), main program (`Program.cs`), and configuration/resource files for Application Insights integration. This sample demonstrates using Azure OpenAI and telemetry in a bot application. [[1]](diffhunk://#diff-e2502fc8bf931520eb7b37845a0ef4336820b422d8974475727f96e389454feaR1-R21) [[2]](diffhunk://#diff-b921767a8b614972c7a3bb5308b4fd797c60d44de331b9656065f3adbee7a248R1-R16) [[3]](diffhunk://#diff-b2eaa16ee58a54a25acb5e930ace0fe03ca3dea7b34c67a265dcddc8500ae41bR1-R41) [[4]](diffhunk://#diff-2c32c8a51d8362325fac473adb2c99e2233dd9373529a9f8e07a6f3a3291adf2R1-R67) [[5]](diffhunk://#diff-1694d6bdb818a04ebfc71382c65a682d7dc506a02632c8cde236f23d9a6cf571R1-R8) [[6]](diffhunk://#diff-ee44fc86192f51de6e025280640b7153430c1214bd4fa8db9eb06f0beeb6f54aR1-R10) [[7]](diffhunk://#diff-5cfff353a21840d25b0e5f1e0821ae7683f18e8d8659c2ea1b723f51eadb7a1cR1-R10) [[8]](diffhunk://#diff-19ad97af5c1b7109a9c62f830310091f393489def210b9ec1ffce152b8bf958cR13) ### Activity Sending and Response Handling - Changed `BotApplication.SendActivityAsync` and `ConversationClient.SendActivityAsync` to return a strongly typed `ResourceResponse` object (instead of just a string ID), improving type safety and extensibility. Also added a `SendTypingActivityAsync` helper. [[1]](diffhunk://#diff-eaf09c60c6baf0a5c99db7670427f663dfa0d7097f2eeb97691b35eb2a509ab4L120-R141) [[2]](diffhunk://#diff-0e831e4dc2aa2a5ce9c9830150117b244a841d76e56975055bc2fd9550fd1341L28-R29) [[3]](diffhunk://#diff-0e831e4dc2aa2a5ce9c9830150117b244a841d76e56975055bc2fd9550fd1341L41-R71) - Updated `CompatBotAdapter` to use the new `ResourceResponse` type and improved handling/logging for null responses. [[1]](diffhunk://#diff-a78277c4f790d08eca9fabaddd59cc03cd6de93ee7ff87eabb0bfc254dce0030L19-R22) [[2]](diffhunk://#diff-a78277c4f790d08eca9fabaddd59cc03cd6de93ee7ff87eabb0bfc254dce0030L41-R61) [[3]](diffhunk://#diff-a78277c4f790d08eca9fabaddd59cc03cd6de93ee7ff87eabb0bfc254dce0030L64-R74) ### Logging and Configuration Improvements - Enhanced logging in the conversation client configuration, including debug and warning logs for MSAL (Microsoft Authentication Library) configuration detection. Improved handling of missing configuration by conditionally adding the authentication handler. [[1]](diffhunk://#diff-728b405fea621393bf54709dd9edcf171d5c2a2113e8a3fbf4732f403ba4e235R77-R88) [[2]](diffhunk://#diff-728b405fea621393bf54709dd9edcf171d5c2a2113e8a3fbf4732f403ba4e235L100-R119) - Added missing `using` directives for logging in relevant files. [[1]](diffhunk://#diff-a78277c4f790d08eca9fabaddd59cc03cd6de93ee7ff87eabb0bfc254dce0030R7) [[2]](diffhunk://#diff-0e831e4dc2aa2a5ce9c9830150117b244a841d76e56975055bc2fd9550fd1341R4) ### Miscellaneous Improvements and Fixes - Fixed a bug in the proactive sample where the correct activity ID is now logged after sending a message. - Minor improvement: Added a root endpoint to the `CoreBot` sample for easier health checks. - Cleaned up unused variables in the Azure DevOps pipeline YAML. --- .azdo/cd-core.yaml | 4 -- core/core.slnx | 1 + core/samples/AFBot/AFBot.csproj | 21 ++++++++++ core/samples/AFBot/DropTypingMiddleware.cs | 16 ++++++++ core/samples/AFBot/Program.cs | 41 +++++++++++++++++++ core/samples/AFBot/appsettings.json | 10 +++++ core/samples/CoreBot/Program.cs | 1 + core/samples/Proactive/Worker.cs | 4 +- .../CompatBotAdapter.cs | 22 +++++++--- core/src/Microsoft.Bot.Core/BotApplication.cs | 29 +++++++++---- .../Microsoft.Bot.Core/ConversationClient.cs | 39 ++++++++++++++---- .../Hosting/AddBotApplicationExtensions.cs | 31 +++++++++----- .../Schema/ActivityTypes.cs | 4 ++ .../BotApplicationTests.cs | 4 +- .../ConversationClientTests.cs | 4 +- core/test/msal-config-api/Program.cs | 13 +++++- 16 files changed, 203 insertions(+), 41 deletions(-) create mode 100644 core/samples/AFBot/AFBot.csproj create mode 100644 core/samples/AFBot/DropTypingMiddleware.cs create mode 100644 core/samples/AFBot/Program.cs create mode 100644 core/samples/AFBot/appsettings.json diff --git a/.azdo/cd-core.yaml b/.azdo/cd-core.yaml index ef84ebbd..0bd65534 100644 --- a/.azdo/cd-core.yaml +++ b/.azdo/cd-core.yaml @@ -14,10 +14,6 @@ trigger: include: - core/** -variables: -- name: PushToADOFeed - value: false - pool: vmImage: 'ubuntu-22.04' diff --git a/core/core.slnx b/core/core.slnx index 525caa66..28857278 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -10,6 +10,7 @@ + diff --git a/core/samples/AFBot/AFBot.csproj b/core/samples/AFBot/AFBot.csproj new file mode 100644 index 00000000..4aeadde1 --- /dev/null +++ b/core/samples/AFBot/AFBot.csproj @@ -0,0 +1,21 @@ + + + + net10.0 + enable + enable + + + + + + + + + + + + + + + diff --git a/core/samples/AFBot/DropTypingMiddleware.cs b/core/samples/AFBot/DropTypingMiddleware.cs new file mode 100644 index 00000000..c93b2d08 --- /dev/null +++ b/core/samples/AFBot/DropTypingMiddleware.cs @@ -0,0 +1,16 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Schema; + +namespace AFBot; + +internal class DropTypingMiddleware : ITurnMiddleWare +{ + public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) + { + if (activity.Type == ActivityTypes.Typing) return Task.CompletedTask; + return nextTurn(cancellationToken); + } +} diff --git a/core/samples/AFBot/Program.cs b/core/samples/AFBot/Program.cs new file mode 100644 index 00000000..fd8630e9 --- /dev/null +++ b/core/samples/AFBot/Program.cs @@ -0,0 +1,41 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.ClientModel; +using AFBot; +using Azure.AI.OpenAI; +using Azure.Monitor.OpenTelemetry.AspNetCore; +using Microsoft.Agents.AI; +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; +using OpenAI; + +WebApplicationBuilder builder = WebApplication.CreateBuilder(args); + +WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddOpenTelemetry().UseAzureMonitor(); +webAppBuilder.Services.AddBotApplication(); +WebApplication webApp = webAppBuilder.Build(); +BotApplication botApp = webApp.UseBotApplication(); + +AzureOpenAIClient azureClient = new( + new Uri("https://ridofoundry.cognitiveservices.azure.com/"), + new ApiKeyCredential(Environment.GetEnvironmentVariable("AZURE_OpenAI_KEY")!)); + +ChatClientAgent agent = azureClient.GetChatClient("gpt-5-nano").CreateAIAgent( + instructions: "You are an expert acronym maker, made an acronym made up from the first three characters of the user's message. " + + "Some examples: OMW on my way, BTW by the way, TVM thanks very much, and so on." + + "Always respond with the three complete words only, and include a related emoji at the end.", + name: "AcronymMaker"); + +botApp.Use(new DropTypingMiddleware()); +botApp.OnActivity = async (activity, cancellationToken) => +{ + await botApp.SendTypingActivityAsync(activity, cancellationToken); + AgentRunResponse res = await agent.RunAsync(activity?.Text ?? "OMW"); + CoreActivity reply = activity!.CreateReplyMessageActivity(res.Text); + await botApp.SendActivityAsync(reply, cancellationToken); +}; + +webApp.Run(); \ No newline at end of file diff --git a/core/samples/AFBot/appsettings.json b/core/samples/AFBot/appsettings.json new file mode 100644 index 00000000..1ff8c135 --- /dev/null +++ b/core/samples/AFBot/appsettings.json @@ -0,0 +1,10 @@ +{ + "APPLICATIONINSIGHTS_CONNECTION_STRING": "InstrumentationKey=00000000-0000-0000-0000-000000000000;", + "Logging": { + "LogLevel": { + "Default": "Warning", + "Microsoft.Bot": "Trace" + } + }, + "AllowedHosts": "*" +} diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index ed340094..f147500a 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -12,6 +12,7 @@ WebApplication webApp = webAppBuilder.Build(); BotApplication botApp = webApp.UseBotApplication(); +webApp.MapGet("/", () => "CoreBot is running."); botApp.OnActivity = async (activity, cancellationToken) => { diff --git a/core/samples/Proactive/Worker.cs b/core/samples/Proactive/Worker.cs index 7a980f34..96276afe 100644 --- a/core/samples/Proactive/Worker.cs +++ b/core/samples/Proactive/Worker.cs @@ -25,8 +25,8 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken) From = new() { Id = FromId }, Conversation = new() { Id = ConversationId } }; - string aid = await conversationClient.SendActivityAsync(proactiveMessage, stoppingToken); - logger.LogInformation("Activity {Aid} sent", aid); + var aid = await conversationClient.SendActivityAsync(proactiveMessage, stoppingToken); + logger.LogInformation("Activity {Aid} sent", aid.Id); } await Task.Delay(1000, stoppingToken); } diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs index 1ce0b0d3..516da676 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs @@ -4,6 +4,7 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; +using Microsoft.Extensions.Logging; namespace Microsoft.Bot.Core.Compat; @@ -16,7 +17,9 @@ namespace Microsoft.Bot.Core.Compat; /// This class is intended for scenarios where integration with non-standard bot runtimes or legacy systems is /// required. /// The bot application instance used to process and send activities within the adapter. -public class CompatBotAdapter(BotApplication botApplication) : BotAdapter +/// The +[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] +public class CompatBotAdapter(BotApplication botApplication, ILogger logger = default!) : BotAdapter { /// /// Deletes an activity from the conversation. @@ -38,17 +41,24 @@ public override Task DeleteActivityAsync(ITurnContext turnContext, ConversationR /// /// /// - public override async Task SendActivitiesAsync(ITurnContext turnContext, Activity[] activities, CancellationToken cancellationToken) + public override async Task SendActivitiesAsync(ITurnContext turnContext, Activity[] activities, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(activities); - ResourceResponse[] responses = new ResourceResponse[1]; + Microsoft.Bot.Schema.ResourceResponse[] responses = new Microsoft.Bot.Schema.ResourceResponse[1]; for (int i = 0; i < activities.Length; i++) { CoreActivity a = activities[i].FromCompatActivity(); - string resp = await botApplication.SendActivityAsync(a, cancellationToken).ConfigureAwait(false); - responses[i] = new ResourceResponse(id: resp); + ResourceResponse? resp = await botApplication.SendActivityAsync(a, cancellationToken).ConfigureAwait(false); + if (resp is not null) + { + responses[i] = new Microsoft.Bot.Schema.ResourceResponse() { Id = resp.Id }; + } + else + { + logger.LogWarning("Found null ResourceResponse after calling SendActivityAsync"); + } } return responses; } @@ -61,7 +71,7 @@ public override async Task SendActivitiesAsync(ITurnContext /// /// /// - public override Task UpdateActivityAsync(ITurnContext turnContext, Activity activity, CancellationToken cancellationToken) + public override Task UpdateActivityAsync(ITurnContext turnContext, Activity activity, CancellationToken cancellationToken) { throw new NotImplementedException(); } diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs index 20c606a8..a4a13bb5 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -11,6 +11,7 @@ namespace Microsoft.Bot.Core; /// /// Represents a bot application. /// +[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class BotApplication { private readonly ILogger _logger; @@ -28,15 +29,16 @@ public class BotApplication /// The client used to manage and interact with conversations for the bot. /// The application configuration settings used to retrieve environment variables and service credentials. /// The logger used to record operational and diagnostic information for the bot application. - /// The configuration key identifying the authentication service. Defaults to "AzureAd" if not specified. - [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] - public BotApplication(ConversationClient conversationClient, IConfiguration config, ILogger logger, string serviceKey = "AzureAd") + /// The configuration key identifying the authentication service. Defaults to "AzureAd" if not specified. + public BotApplication(ConversationClient conversationClient, IConfiguration config, ILogger logger, string sectionName = "AzureAd") { + ArgumentNullException.ThrowIfNull(config); _logger = logger; - _serviceKey = serviceKey; + _serviceKey = sectionName; MiddleWare = new TurnMiddleware(); _conversationClient = conversationClient; - logger.LogInformation("Started bot listener on {Port} for AppID:{AppId} with SDK version {SdkVersion}", config?["ASPNETCORE_URLS"], config?[$"{_serviceKey}:ClientId"], Version); + string appId = config["MicrosoftAppId"] ?? config["CLIENT_ID"] ?? config[$"{sectionName}:ClientId"] ?? "Unknown AppID"; + logger.LogInformation("Started bot listener on {Port} for AppID:{AppId} with SDK version {SdkVersion}", config?["ASPNETCORE_URLS"], appId, Version); } @@ -63,7 +65,6 @@ public BotApplication(ConversationClient conversationClient, IConfiguration conf /// /// /// - [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(httpContext); @@ -117,7 +118,7 @@ public ITurnMiddleWare Use(ITurnMiddleWare middleware) /// A cancellation token that can be used to cancel the send operation. /// A task that represents the asynchronous operation. The task result contains the identifier of the sent activity. /// Thrown if the conversation client has not been initialized. - public async Task SendActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) + public async Task SendActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(activity); ArgumentNullException.ThrowIfNull(_conversationClient, "ConversationClient not initialized"); @@ -125,6 +126,20 @@ public async Task SendActivityAsync(CoreActivity activity, CancellationT return await _conversationClient.SendActivityAsync(activity, cancellationToken).ConfigureAwait(false); } + /// + /// Sends a typing activity to the conversation asynchronously. + /// + /// The activity containing conversation information. + /// + /// + public async Task SendTypingActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(activity); + var typing = activity.CreateReplyMessageActivity(); + typing.Type = ActivityTypes.Typing; + return await SendActivityAsync(typing, cancellationToken).ConfigureAwait(false); + } + /// /// Gets the version of the SDK. /// diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index a27de471..06a8724a 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -1,8 +1,10 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Net.Http.Json; using System.Net.Mime; using System.Text; +using System.Text.Json; using Microsoft.Bot.Core.Hosting; using Microsoft.Bot.Core.Schema; @@ -25,7 +27,7 @@ public class ConversationClient(HttpClient httpClient) /// the activity is sent successfully. /// Thrown if the activity could not be sent successfully. The exception message includes the HTTP status code and /// response content. - public async Task SendActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) + public async Task SendActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(activity); ArgumentNullException.ThrowIfNull(activity.Conversation); @@ -38,14 +40,37 @@ public async Task SendActivityAsync(CoreActivity activity, CancellationT using HttpRequestMessage request = new(HttpMethod.Post, url) { Content = content }; - request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity.FromProperties(activity.Recipient.Properties)); + request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity.FromProperties(activity.From.Properties)); using HttpResponseMessage resp = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); - string respContent = await resp.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); - - return resp.IsSuccessStatusCode ? - respContent : - throw new HttpRequestException($"Error sending activity: {resp.StatusCode} - {respContent}"); + if (resp.IsSuccessStatusCode) + { + string responseString = await resp.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); + if (responseString.Length > 2) // to handle empty response + { + ResourceResponse? resourceResponse = JsonSerializer.Deserialize(responseString); + return resourceResponse ?? new ResourceResponse(); + } + return new ResourceResponse(); + } + else + { + string errResponseString = await resp.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); + throw new HttpRequestException($"Error sending activity {resp.StatusCode}. {errResponseString}"); + } } + +} + +/// +/// Resource Response +/// +public class ResourceResponse +{ + /// + /// Id of the activity + /// + [JsonPropertyName("id")] + public string? Id { get; set; } } diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index c0226022..2593e239 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Diagnostics.Eventing.Reader; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Http; using Microsoft.Bot.Core.Schema; @@ -68,7 +67,7 @@ public static IServiceCollection AddBotApplication(this IServiceCollection services.AddSingleton(); return services; } - + /// /// Adds a conversation client to the service collection. /// @@ -77,13 +76,15 @@ public static IServiceCollection AddBotApplication(this IServiceCollection /// public static IServiceCollection AddConversationClient(this IServiceCollection services, string sectionName = "AzureAd") { - IConfiguration configuration = services.BuildServiceProvider().GetRequiredService(); + var sp = services.BuildServiceProvider(); + IConfiguration configuration = sp.GetRequiredService(); + ILogger logger = sp.GetRequiredService>(); ArgumentNullException.ThrowIfNull(configuration); string scope = "https://api.botframework.com/.default"; - if (configuration["${sectionName}:Scopes"] is not null) + if (configuration[$"{sectionName}:Scope"] is not null) { - scope = configuration[$"{sectionName}:Scopes"]!; + scope = configuration[$"{sectionName}:Scope"]!; } if (configuration["Scope"] is not null) //ToChannelFromBotOAuthScope @@ -97,17 +98,25 @@ public static IServiceCollection AddConversationClient(this IServiceCollection s .AddInMemoryTokenCaches() .AddAgentIdentities(); - services.ConfigureMSAL(configuration, sectionName); - services.AddHttpClient(ConversationClient.ConversationHttpClientName) + if (services.ConfigureMSAL(configuration, sectionName)) + { + + services.AddHttpClient(ConversationClient.ConversationHttpClientName) .AddHttpMessageHandler(sp => new BotAuthenticationHandler( sp.GetRequiredService(), sp.GetRequiredService>(), scope, sp.GetService>())); + } + else + { + _logAuthConfigNotFound(logger, null); + services.AddHttpClient(ConversationClient.ConversationHttpClientName); + } return services; } - private static IServiceCollection ConfigureMSAL(this IServiceCollection services, IConfiguration configuration, string sectionName) + private static bool ConfigureMSAL(this IServiceCollection services, IConfiguration configuration, string sectionName) { ArgumentNullException.ThrowIfNull(configuration); var logger = services.BuildServiceProvider().GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); @@ -129,7 +138,7 @@ private static IServiceCollection ConfigureMSAL(this IServiceCollection services _logUsingSectionConfig(logger, sectionName, null); services.ConfigureMSALFromConfig(configuration.GetSection(sectionName)); } - return services; + return true; } private static IServiceCollection ConfigureMSALFromConfig(this IServiceCollection services, IConfigurationSection msalConfigSection) @@ -253,6 +262,8 @@ private static bool IsSystemAssignedManagedIdentity(string? clientId) LoggerMessage.Define(LogLevel.Debug, new(5), "Configuring authentication with User-Assigned Managed Identity"); private static readonly Action _logUsingFIC = LoggerMessage.Define(LogLevel.Debug, new(6), "Configuring authentication with Federated Identity Credential (Managed Identity) with {IdentityType} Managed Identity"); + private static readonly Action _logAuthConfigNotFound = + LoggerMessage.Define(LogLevel.Warning, new(7), "Authentication configuration not found. Running without Auth"); + - } diff --git a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs index b2371662..3837f391 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs @@ -14,4 +14,8 @@ public static class ActivityTypes /// Represents the default message string used for communication or display purposes. /// public const string Message = "message"; + /// + /// Represents a typing indicator activity. + /// + public const string Typing = "typing"; } diff --git a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs index 9b7f564d..fc243c4f 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs @@ -189,10 +189,10 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() ServiceUrl = new Uri("https://test.service.url/") }; - string result = await botApp.SendActivityAsync(activity); + var result = await botApp.SendActivityAsync(activity); Assert.NotNull(result); - Assert.Contains("activity123", result); + Assert.Contains("activity123", result.Id); } [Fact] diff --git a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs index 90786acf..a844588f 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs @@ -37,10 +37,10 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() ServiceUrl = new Uri("https://test.service.url/") }; - string result = await conversationClient.SendActivityAsync(activity); + var result = await conversationClient.SendActivityAsync(activity); Assert.NotNull(result); - Assert.Contains("activity123", result); + Assert.Contains("activity123", result.Id); } [Fact] diff --git a/core/test/msal-config-api/Program.cs b/core/test/msal-config-api/Program.cs index 869f9b3f..b79751b4 100644 --- a/core/test/msal-config-api/Program.cs +++ b/core/test/msal-config-api/Program.cs @@ -23,6 +23,17 @@ await conversationClient.SendActivityAsync(new CoreActivity }, cancellationToken: default); +await conversationClient.SendActivityAsync(new CoreActivity +{ + Text = "Hello from MSAL Config API test!", + Conversation = new() { Id = "bad conversation" }, + ServiceUrl = new Uri(ServiceUrl), + From = new() { Id = FromId } + +}, cancellationToken: default); + + + static ConversationClient CreateConversationClient() { ServiceCollection services = InitializeDIContainer(); @@ -44,4 +55,4 @@ static ServiceCollection InitializeDIContainer() services.AddSingleton(configuration); services.AddLogging(configure => configure.AddConsole()); return services; -} \ No newline at end of file +} From a2ea29b74abd3eda56f19a8434094798573aaa63 Mon Sep 17 00:00:00 2001 From: "Ricardo Minguez Pablos (RIDO)" Date: Tue, 16 Dec 2025 15:13:57 -0800 Subject: [PATCH 29/69] Move AgenticIdentity to Schema and make it public AgenticIdentity class moved from BotAuthenticationHandler.cs to AgenticIdentity.cs in the Microsoft.Bot.Core.Schema namespace. The class is now public and has improved XML documentation. No changes to logic or properties. --- .../Hosting/BotAuthenticationHandler.cs | 28 ----------- .../Schema/AgenticIdentity.cs | 47 +++++++++++++++++++ 2 files changed, 47 insertions(+), 28 deletions(-) create mode 100644 core/src/Microsoft.Bot.Core/Schema/AgenticIdentity.cs diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs index 208f0c58..7b7418c0 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -11,34 +11,6 @@ namespace Microsoft.Bot.Core.Hosting; -/// -/// Represents an agentic identity for user-delegated token acquisition. -/// -internal sealed class AgenticIdentity -{ - public string? AgenticAppId { get; set; } - public string? AgenticUserId { get; set; } - public string? AgenticAppBlueprintId { get; set; } - - public static AgenticIdentity? FromProperties(ExtendedPropertiesDictionary? properties) - { - if (properties is null) - { - return null; - } - - properties.TryGetValue("agenticAppId", out object? appIdObj); - properties.TryGetValue("agenticUserId", out object? userIdObj); - properties.TryGetValue("agenticAppBlueprintId", out object? bluePrintObj); - return new AgenticIdentity - { - AgenticAppId = appIdObj?.ToString(), - AgenticUserId = userIdObj?.ToString(), - AgenticAppBlueprintId = bluePrintObj?.ToString() - }; - } -} - /// /// HTTP message handler that automatically acquires and attaches authentication tokens /// for Bot Framework API calls. Supports both app-only and agentic (user-delegated) token acquisition. diff --git a/core/src/Microsoft.Bot.Core/Schema/AgenticIdentity.cs b/core/src/Microsoft.Bot.Core/Schema/AgenticIdentity.cs new file mode 100644 index 00000000..6ded3bcc --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Schema/AgenticIdentity.cs @@ -0,0 +1,47 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace Microsoft.Bot.Core.Schema; + +/// +/// Represents an agentic identity for user-delegated token acquisition. +/// +public sealed class AgenticIdentity +{ + /// + /// Agentic application ID. + /// + public string? AgenticAppId { get; set; } + /// + /// Agentic user ID. + /// + public string? AgenticUserId { get; set; } + + /// + /// Agentic application blueprint ID. + /// + public string? AgenticAppBlueprintId { get; set; } + + /// + /// Creates an instance from the provided properties dictionary. + /// + /// + /// + public static AgenticIdentity? FromProperties(ExtendedPropertiesDictionary? properties) + { + if (properties is null) + { + return null; + } + + properties.TryGetValue("agenticAppId", out object? appIdObj); + properties.TryGetValue("agenticUserId", out object? userIdObj); + properties.TryGetValue("agenticAppBlueprintId", out object? bluePrintObj); + return new AgenticIdentity + { + AgenticAppId = appIdObj?.ToString(), + AgenticUserId = userIdObj?.ToString(), + AgenticAppBlueprintId = bluePrintObj?.ToString() + }; + } +} From bd7bb402cb9cf9ed2382d3fad099012f49e0d4eb Mon Sep 17 00:00:00 2001 From: Lily Du Date: Thu, 18 Dec 2025 13:22:13 -0800 Subject: [PATCH 30/69] [core]: add JWT validation for bots & agents (#246) - added logic for JWT validation for bots & agents - tested locally with core bot (successful case & error case with invalid scope URL) - integration tests to be added once we decide on infrastructure for core --------- Co-authored-by: lilydu Co-authored-by: Ricardo Minguez Pablos (RIDO) Co-authored-by: Rido --- core/samples/CoreBot/appsettings.json | 2 +- .../Hosting/AddBotApplicationExtensions.cs | 27 ++- .../Hosting/BotAuthenticationHandler.cs | 4 +- .../Microsoft.Bot.Core/Hosting/BotConfig.cs | 14 +- .../Hosting/JwtExtensions.cs | 190 ++++++++++++++++++ .../AddBotApplicationExtensionsTests.cs | 26 ++- 6 files changed, 241 insertions(+), 22 deletions(-) create mode 100644 core/src/Microsoft.Bot.Core/Hosting/JwtExtensions.cs diff --git a/core/samples/CoreBot/appsettings.json b/core/samples/CoreBot/appsettings.json index e022efe7..22c313fa 100644 --- a/core/samples/CoreBot/appsettings.json +++ b/core/samples/CoreBot/appsettings.json @@ -3,7 +3,7 @@ "Logging": { "LogLevel": { "Default": "Warning", - "Microsoft.Bot.Core": "Trace" + "Microsoft.Bot.Core": "Information" } }, "AllowedHosts": "*" diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 2593e239..44d4c869 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -24,6 +24,8 @@ namespace Microsoft.Bot.Core.Hosting; /// methods are called in the application's service configuration pipeline. public static class AddBotApplicationExtensions { + internal const string MsalConfigKey = "AzureAd"; + /// /// Configures the application to handle bot messages at the specified route and returns the registered bot /// application instance. @@ -49,7 +51,7 @@ public static TApp UseBotApplication( { CoreActivity resp = await app.ProcessAsync(httpContext, cancellationToken).ConfigureAwait(false); return resp.Id; - }); + }).RequireAuthorization(); return app; } @@ -63,6 +65,9 @@ public static TApp UseBotApplication( /// public static IServiceCollection AddBotApplication(this IServiceCollection services, string sectionName = "AzureAd") where TApp : BotApplication { + ILogger logger = services.BuildServiceProvider().GetRequiredService>(); + + services.AddAuthorization(logger, sectionName); services.AddConversationClient(sectionName); services.AddSingleton(); return services; @@ -80,13 +85,13 @@ public static IServiceCollection AddConversationClient(this IServiceCollection s IConfiguration configuration = sp.GetRequiredService(); ILogger logger = sp.GetRequiredService>(); ArgumentNullException.ThrowIfNull(configuration); - + string scope = "https://api.botframework.com/.default"; if (configuration[$"{sectionName}:Scope"] is not null) { scope = configuration[$"{sectionName}:Scope"]!; } - + if (configuration["Scope"] is not null) //ToChannelFromBotOAuthScope { scope = configuration["Scope"]!; @@ -119,18 +124,18 @@ public static IServiceCollection AddConversationClient(this IServiceCollection s private static bool ConfigureMSAL(this IServiceCollection services, IConfiguration configuration, string sectionName) { ArgumentNullException.ThrowIfNull(configuration); - var logger = services.BuildServiceProvider().GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); + ILogger logger = services.BuildServiceProvider().GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); if (configuration["MicrosoftAppId"] is not null) { _logUsingBFConfig(logger, null); - var botConfig = BotConfig.FromBFConfig(configuration); + BotConfig botConfig = BotConfig.FromBFConfig(configuration); services.ConfigureMSALFromBotConfig(botConfig, logger); } else if (configuration["CLIENT_ID"] is not null) { _logUsingCoreConfig(logger, null); - var botConfig = BotConfig.FromCoreConfig(configuration); + BotConfig botConfig = BotConfig.FromCoreConfig(configuration); services.ConfigureMSALFromBotConfig(botConfig, logger); } else @@ -144,7 +149,7 @@ private static bool ConfigureMSAL(this IServiceCollection services, IConfigurati private static IServiceCollection ConfigureMSALFromConfig(this IServiceCollection services, IConfigurationSection msalConfigSection) { ArgumentNullException.ThrowIfNull(msalConfigSection); - services.Configure(msalConfigSection); + services.Configure(MsalConfigKey, msalConfigSection); return services; } @@ -154,7 +159,7 @@ private static IServiceCollection ConfigureMSALWithSecret(this IServiceCollectio ArgumentNullException.ThrowIfNullOrWhiteSpace(clientId); ArgumentNullException.ThrowIfNullOrWhiteSpace(clientSecret); - services.Configure(options => + services.Configure(MsalConfigKey, options => { // TODO: Make Instance configurable options.Instance = "https://login.microsoftonline.com/"; @@ -176,7 +181,7 @@ private static IServiceCollection ConfigureMSALWithFIC(this IServiceCollection s ArgumentNullException.ThrowIfNullOrWhiteSpace(tenantId); ArgumentNullException.ThrowIfNullOrWhiteSpace(clientId); - var ficCredential = new CredentialDescription() + CredentialDescription ficCredential = new() { SourceType = CredentialSource.SignedAssertionFromManagedIdentity, }; @@ -185,7 +190,7 @@ private static IServiceCollection ConfigureMSALWithFIC(this IServiceCollection s ficCredential.ManagedIdentityClientId = ficClientId; } - services.Configure(options => + services.Configure(MsalConfigKey, options => { // TODO: Make Instance configurable options.Instance = "https://login.microsoftonline.com/"; @@ -212,7 +217,7 @@ private static IServiceCollection ConfigureMSALWithUMI(this IServiceCollection s options.UserAssignedClientId = umiClientId; }); - services.Configure(options => + services.Configure(MsalConfigKey, options => { // TODO: Make Instance configurable options.Instance = "https://login.microsoftonline.com/"; diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs index 7b7418c0..215bf40f 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -71,14 +71,14 @@ private async Task GetAuthorizationHeaderAsync(AgenticIdentity? agenticI { AcquireTokenOptions = new AcquireTokenOptions() { - //AuthenticationOptionsName = _aadConfigSectionName, + AuthenticationOptionsName = AddBotApplicationExtensions.MsalConfigKey, } }; // Conditionally apply ManagedIdentity configuration if registered if (_managedIdentityOptions is not null) { - var miOptions = _managedIdentityOptions.Value; + ManagedIdentityOptions miOptions = _managedIdentityOptions.Value; if (!string.IsNullOrEmpty(miOptions.UserAssignedClientId)) { diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs b/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs index d39df8af..b77bca62 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs @@ -9,7 +9,7 @@ namespace Microsoft.Bot.Core.Hosting; internal sealed class BotConfig { public const string SystemManagedIdentityIdentifier = "system"; - + public string TenantId { get; set; } = string.Empty; public string ClientId { get; set; } = string.Empty; public string? ClientSecret { get; set; } @@ -37,4 +37,16 @@ public static BotConfig FromCoreConfig(IConfiguration configuration) FicClientId = configuration["MANAGED_IDENTITY_CLIENT_ID"], }; } + + public static BotConfig FromAadConfig(IConfiguration configuration, string sectionName = "AzureAd") + { + ArgumentNullException.ThrowIfNull(configuration); + IConfigurationSection section = configuration.GetSection(sectionName); + return new() + { + TenantId = section["TenantId"] ?? string.Empty, + ClientId = section["ClientId"] ?? string.Empty, + ClientSecret = section["ClientSecret"], + }; + } } diff --git a/core/src/Microsoft.Bot.Core/Hosting/JwtExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/JwtExtensions.cs new file mode 100644 index 00000000..91a24c11 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Hosting/JwtExtensions.cs @@ -0,0 +1,190 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.IdentityModel.Tokens.Jwt; +using Microsoft.AspNetCore.Authentication; +using Microsoft.AspNetCore.Authentication.JwtBearer; +using Microsoft.AspNetCore.Authorization; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.IdentityModel.Protocols; +using Microsoft.IdentityModel.Protocols.OpenIdConnect; +using Microsoft.IdentityModel.Tokens; +using Microsoft.IdentityModel.Validators; + +namespace Microsoft.Bot.Core.Hosting +{ + /// + /// Provides extension methods for configuring JWT authentication and authorization for bots and agents. + /// + [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] + public static class JwtExtensions + { + internal const string BotScheme = "BotScheme"; + internal const string AgentScheme = "AgentScheme"; + internal const string BotScope = "https://api.botframework.com/.default"; + internal const string AgentScope = "https://botapi.skype.com/.default"; + internal const string BotOIDC = "https://login.botframework.com/v1/.well-known/openid-configuration"; + internal const string AgentOIDC = "https://login.microsoftonline.com/"; + + /// + /// Adds JWT authentication for bots and agents. + /// + /// The service collection to add authentication to. + /// The application configuration containing the settings. + /// Indicates whether to use agent authentication (true) or bot authentication (false). + /// The configuration section name for the settings. Defaults to "AzureAd". + /// The logger instance for logging. + /// An for further authentication configuration. + public static AuthenticationBuilder AddBotAuthentication(this IServiceCollection services, IConfiguration configuration, bool useAgentAuth, ILogger logger, string aadSectionName = "AzureAd") + { + + // TODO: Task 5039187: Refactor use of BotConfig for MSAL and JWT + + AuthenticationBuilder builder = services.AddAuthentication(); + ArgumentNullException.ThrowIfNull(configuration); + string audience = configuration[$"{aadSectionName}:ClientId"] + ?? configuration["CLIENT_ID"] + ?? configuration["MicrosoftAppId"] + ?? throw new InvalidOperationException("ClientID not found in configuration, tried the 3 option"); + + if (!useAgentAuth) + { + string[] validIssuers = ["https://api.botframework.com"]; + builder.AddCustomJwtBearer(BotScheme, validIssuers, audience, logger); + } + else + { + string tenantId = configuration[$"{aadSectionName}:TenantId"] + ?? configuration["TENANT_ID"] + ?? configuration["MicrosoftAppTenantId"] + ?? "botframework.com"; // TODO: Task 5039198: Test JWT Validation for MultiTenant + + string[] validIssuers = [$"https://sts.windows.net/{tenantId}/", $"https://login.microsoftonline.com/{tenantId}/v2", "https://api.botframework.com"]; + builder.AddCustomJwtBearer(AgentScheme, validIssuers, audience, logger); + } + return builder; + } + + /// + /// Adds authorization policies to the service collection. + /// + /// The service collection to add authorization to. + /// The configuration section name for the settings. Defaults to "AzureAd". + /// The logger instance for logging. + /// An for further authorization configuration. + public static AuthorizationBuilder AddAuthorization(this IServiceCollection services, ILogger logger, string aadSectionName = "AzureAd") + { + IConfiguration configuration = services.BuildServiceProvider().GetRequiredService(); + string azureScope = configuration[$"Scope"]!; + bool useAgentAuth = false; + + if (string.Equals(azureScope, AgentScope, StringComparison.OrdinalIgnoreCase)) + { + useAgentAuth = true; + } + + services.AddBotAuthentication(configuration, useAgentAuth, logger, aadSectionName); + AuthorizationBuilder authorizationBuilder = services + .AddAuthorizationBuilder() + .AddDefaultPolicy("DefaultPolicy", policy => + { + if (!useAgentAuth) + { + policy.AuthenticationSchemes.Add(BotScheme); + } + else + { + policy.AuthenticationSchemes.Add(AgentScheme); + } + policy.RequireAuthenticatedUser(); + }); + return authorizationBuilder; + } + + private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuilder builder, string schemeName, string[] validIssuers, string audience, ILogger logger) + { + builder.AddJwtBearer(schemeName, jwtOptions => + { + jwtOptions.SaveToken = true; + jwtOptions.IncludeErrorDetails = true; + jwtOptions.Audience = audience; + jwtOptions.TokenValidationParameters = new TokenValidationParameters + { + ValidateIssuerSigningKey = true, + RequireSignedTokens = true, + ValidateIssuer = true, + ValidateAudience = true, + ValidIssuers = validIssuers + }; + jwtOptions.TokenValidationParameters.EnableAadSigningKeyIssuerValidation(); + jwtOptions.MapInboundClaims = true; + jwtOptions.Events = new JwtBearerEvents + { + OnMessageReceived = async context => + { + logger.LogDebug("OnMessageReceived invoked for scheme: {Scheme}", schemeName); + string authorizationHeader = context.Request.Headers.Authorization.ToString(); + + if (string.IsNullOrEmpty(authorizationHeader)) + { + // Default to AadTokenValidation handling + context.Options.TokenValidationParameters.ConfigurationManager ??= jwtOptions.ConfigurationManager as BaseConfigurationManager; + await Task.CompletedTask.ConfigureAwait(false); + logger.LogWarning("Authorization header is missing."); + return; + } + + string[] parts = authorizationHeader?.Split(' ')!; + if (parts.Length != 2 || parts[0] != "Bearer") + { + // Default to AadTokenValidation handling + context.Options.TokenValidationParameters.ConfigurationManager ??= jwtOptions.ConfigurationManager as BaseConfigurationManager; + await Task.CompletedTask.ConfigureAwait(false); + logger.LogWarning("Invalid authorization header format."); + return; + } + + JwtSecurityToken token = new(parts[1]); + string issuer = token.Claims.FirstOrDefault(claim => claim.Type == "iss")?.Value!; + string tid = token.Claims.FirstOrDefault(claim => claim.Type == "tid")?.Value!; + + string oidcAuthority = issuer.Equals("https://api.botframework.com", StringComparison.OrdinalIgnoreCase) + ? BotOIDC : $"{AgentOIDC}{tid ?? "botframework.com"}/v2.0/.well-known/openid-configuration"; + + logger.LogDebug("Using OIDC Authority: {OidcAuthority} for issuer: {Issuer}", oidcAuthority, issuer); + + jwtOptions.ConfigurationManager = new ConfigurationManager( + oidcAuthority, + new OpenIdConnectConfigurationRetriever(), + new HttpDocumentRetriever + { + RequireHttps = jwtOptions.RequireHttpsMetadata + }); + + + await Task.CompletedTask.ConfigureAwait(false); + }, + OnTokenValidated = context => + { + logger.LogInformation("Token validated successfully for scheme: {Scheme}", schemeName); + return Task.CompletedTask; + }, + OnForbidden = context => + { + logger.LogWarning("Forbidden response for scheme: {Scheme}", schemeName); + return Task.CompletedTask; + }, + OnAuthenticationFailed = context => + { + logger.LogWarning("Authentication failed for scheme: {Scheme}. Exception: {Exception}", schemeName, context.Exception); + return Task.CompletedTask; + } + }; + jwtOptions.Validate(); + }); + return builder; + } + } +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs index 5ff3cf34..3757382e 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs @@ -39,7 +39,9 @@ private static ServiceProvider BuildServiceProvider(Dictionary private static void AssertMsalOptions(ServiceProvider serviceProvider, string expectedClientId, string expectedTenantId, string expectedInstance = "https://login.microsoftonline.com/") { - var msalOptions = serviceProvider.GetRequiredService>().Value; + var msalOptions = serviceProvider + .GetRequiredService>() + .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.Equal(expectedClientId, msalOptions.ClientId); Assert.Equal(expectedTenantId, msalOptions.TenantId); Assert.Equal(expectedInstance, msalOptions.Instance); @@ -49,7 +51,7 @@ private static void AssertMsalOptions(ServiceProvider serviceProvider, string ex public void AddConversationClient_WithBotFrameworkConfig_ConfiguresClientSecret() { // Arrange - var configData = new Dictionary + var configData = new Dictionary { ["MicrosoftAppId"] = "test-app-id", ["MicrosoftAppTenantId"] = "test-tenant-id", @@ -61,7 +63,9 @@ public void AddConversationClient_WithBotFrameworkConfig_ConfiguresClientSecret( // Assert AssertMsalOptions(serviceProvider, "test-app-id", "test-tenant-id"); - var msalOptions = serviceProvider.GetRequiredService>().Value; + var msalOptions = serviceProvider + .GetRequiredService>() + .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); Assert.Single(msalOptions.ClientCredentials); var credential = msalOptions.ClientCredentials.First(); @@ -85,7 +89,9 @@ public void AddConversationClient_WithCoreConfigAndClientSecret_ConfiguresClient // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); - var msalOptions = serviceProvider.GetRequiredService>().Value; + var msalOptions = serviceProvider + .GetRequiredService>() + .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); Assert.Single(msalOptions.ClientCredentials); var credential = msalOptions.ClientCredentials.First(); @@ -109,7 +115,9 @@ public void AddConversationClient_WithCoreConfigAndSystemAssignedMI_ConfiguresSy // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); - var msalOptions = serviceProvider.GetRequiredService>().Value; + var msalOptions = serviceProvider + .GetRequiredService>() + .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); Assert.Single(msalOptions.ClientCredentials); var credential = msalOptions.ClientCredentials.First(); @@ -136,7 +144,9 @@ public void AddConversationClient_WithCoreConfigAndUserAssignedMI_ConfiguresUser // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); - var msalOptions = serviceProvider.GetRequiredService>().Value; + var msalOptions = serviceProvider + .GetRequiredService>() + .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); Assert.Single(msalOptions.ClientCredentials); var credential = msalOptions.ClientCredentials.First(); @@ -162,7 +172,9 @@ public void AddConversationClient_WithCoreConfigAndNoManagedIdentity_ConfiguresU // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); - var msalOptions = serviceProvider.GetRequiredService>().Value; + var msalOptions = serviceProvider + .GetRequiredService>() + .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.Null(msalOptions.ClientCredentials); var managedIdentityOptions = serviceProvider.GetRequiredService>().Value; From 051a8ba1103fdf8e9d93db2cfecfcd4f7d1e546b Mon Sep 17 00:00:00 2001 From: lilydu Date: Thu, 18 Dec 2025 15:08:25 -0800 Subject: [PATCH 31/69] add packable Set IsPackable to false in msal-config-api.csproj Added the IsPackable property and set it to false in the project file to prevent msal-config-api from being packed into a NuGet package. This ensures the project is not inadvertently distributed as a package. --- core/test/msal-config-api/msal-config-api.csproj | 1 + 1 file changed, 1 insertion(+) diff --git a/core/test/msal-config-api/msal-config-api.csproj b/core/test/msal-config-api/msal-config-api.csproj index 73ff80f1..23c08aec 100644 --- a/core/test/msal-config-api/msal-config-api.csproj +++ b/core/test/msal-config-api/msal-config-api.csproj @@ -6,6 +6,7 @@ msal_config_api enable enable + false From 666290abebc8a3429051044ff962701255a13525 Mon Sep 17 00:00:00 2001 From: Rido Date: Wed, 7 Jan 2026 17:20:39 -0800 Subject: [PATCH 32/69] Support for Invokes, TeamsAttachmentBuilder, Complete IConversationClient (#259) This pull request introduces several improvements and new features to the sample bots, test organization, and build process. The most significant changes are the addition of a comprehensive "AllFeatures" Teams bot sample, enhancements to the proactive messaging and activity handling in the sample bots, and better organization of solution and test projects. Below are the most important changes grouped by theme. **New Features & Samples** * Added a new `AllFeatures` Teams bot sample, including its project (`AllFeatures.csproj`), configuration (`appsettings.json`), HTTP test file, and main program logic demonstrating message handling, typing activities, and mentions. [[1]](diffhunk://#diff-c6d02c3a9a28c1afb6380d7f24485630894a3488bd6529f31cca342583be4897R1-R13) [[2]](diffhunk://#diff-ea0a609f6688222857d8302f64ba6a7d75aa4ffb1f9a70588b86caacd73dbad1R1-R9) [[3]](diffhunk://#diff-7c963be5ba9074d831ef650e68af0360787eb197181c39a12d0661a92c62fbc1R1-R6) [[4]](diffhunk://#diff-166193a2c938377ccf1794248deeb2df8cfafeb883aa6581b316b3fa9e361cdcR1-R28) **Sample Bot Improvements** * Enhanced `AFBot` and `CoreBot` activity handling to use builder patterns for creating reply activities and improved handling of activity properties, cancellation tokens, and logging. [[1]](diffhunk://#diff-b2eaa16ee58a54a25acb5e930ace0fe03ca3dea7b34c67a265dcddc8500ae41bR33-R61) [[2]](diffhunk://#diff-b94b53965e9052345453f2ab6bec21420a36c4b67c9a6c568b9c80edcd0882d1L20-R20) [[3]](diffhunk://#diff-b94b53965e9052345453f2ab6bec21420a36c4b67c9a6c568b9c80edcd0882d1L29-R37) * Improved proactive messaging in the `Proactive` sample by moving the message text to the `Properties["text"]` field and updating the build configuration to prevent packaging. [[1]](diffhunk://#diff-61d7e83f772e536a1729f5c12b1b028a2a396a28e2175541489e85d89d2758ecL23-R28) [[2]](diffhunk://#diff-ffe34fac742569e7a6cfb5589871a8b9571c7692f6af33e167f39cc2b8be3ed3L7-R7) * Expanded `CompatBot` functionality with a new middleware (`MyCompatMiddleware`), proactive messaging using the Conversations API, adaptive card feedback handling, and more complete Teams event handling (members added/removed, meeting start, invoke activities). [[1]](diffhunk://#diff-cef44960d160cf6ea51b595745c079353501a962650d7c9684bd9fa6e1456220R1-R65) [[2]](diffhunk://#diff-7ebf5cb9bab327c9f3ac4408277a56833a7622a64e74bb08742ec37804ed3878R1-R17) [[3]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL25-R71) [[4]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL55-R135) [[5]](diffhunk://#diff-62be1f70aaabb519334fe39cd50c0e25a98717ebb9fab85b688832917c9c75bbR33-R34) **Solution & Test Organization** * Refactored the solution file (`core.slnx`) to organize sample and test projects into folders, added new Teams bot app test project, and included the new Teams bot app source project. [[1]](diffhunk://#diff-19ad97af5c1b7109a9c62f830310091f393489def210b9ec1ffce152b8bf958cR2-R17) [[2]](diffhunk://#diff-19ad97af5c1b7109a9c62f830310091f393489def210b9ec1ffce152b8bf958cL13-R37) **Build & CI Process** * Updated the CI workflow to build the core tests directory explicitly, improving test reliability and clarity in the build steps. **Minor Fixes** * Fixed encoding in the copyright header for `DropTypingMiddleware.cs`. --------- Co-authored-by: heyitsaamir --- .github/workflows/core-ci.yaml | 8 +- core/README.md | 2 +- core/core.slnx | 29 +- core/samples/AFBot/DropTypingMiddleware.cs | 6 +- core/samples/AFBot/Program.cs | 33 +- core/samples/AllFeatures/AllFeatures.csproj | 13 + core/samples/AllFeatures/AllFeatures.http | 6 + core/samples/AllFeatures/Program.cs | 28 + core/samples/AllFeatures/appsettings.json | 9 + core/samples/CompatBot/Cards.cs | 65 ++ core/samples/CompatBot/EchoBot.cs | 101 ++- core/samples/CompatBot/MyCompatMiddleware.cs | 17 + core/samples/CompatBot/Program.cs | 2 + core/samples/CoreBot/Program.cs | 11 +- core/samples/Proactive/Proactive.csproj | 24 +- core/samples/Proactive/Worker.cs | 4 +- core/samples/TeamsBot/Cards.cs | 61 ++ core/samples/TeamsBot/Program.cs | 71 ++ core/samples/TeamsBot/TeamsBot.csproj | 13 + core/samples/TeamsBot/appsettings.json | 10 + core/samples/scenarios/hello-assistant.cs | 34 + core/samples/scenarios/middleware.cs | 7 +- .../CompatActivity.cs | 22 + .../CompatAdapter.cs | 34 +- .../CompatBotAdapter.cs | 25 +- .../CompatConnectorClient.cs | 31 + .../CompatConversations.cs | 338 +++++++ .../Microsoft.Bot.Core.Compat.csproj | 1 + core/src/Microsoft.Bot.Core/BotApplication.cs | 33 +- .../ConversationClient.Models.cs | 248 +++++ .../Microsoft.Bot.Core/ConversationClient.cs | 474 +++++++++- .../Hosting/AddBotApplicationExtensions.cs | 8 +- .../src/Microsoft.Bot.Core/ITurnMiddleWare.cs | 2 +- core/src/Microsoft.Bot.Core/InvokeResponse.cs | 36 + .../{ActivityTypes.cs => ActivityType.cs} | 7 +- .../Schema/ConversationAccount.cs | 23 + .../Microsoft.Bot.Core/Schema/CoreActivity.cs | 130 ++- .../Schema/CoreActivityBuilder.cs | 229 +++++ core/src/Microsoft.Bot.Core/TurnMiddleware.cs | 20 +- core/src/Microsoft.Teams.BotApps/Context.cs | 67 ++ .../Handlers/ConversationUpdateHandler.cs | 50 ++ .../Handlers/InstallationUpdateHandler.cs | 48 + .../Handlers/InvokeHandler.cs | 20 + .../Handlers/MessageHandler.cs | 55 ++ .../Handlers/MessageReactionHandler.cs | 62 ++ .../Microsoft.Teams.BotApps.csproj | 13 + .../Schema/Entities/ClientInfoEntity.cs | 111 +++ .../Schema/Entities/Entity.cs | 151 ++++ .../Schema/Entities/MentionEntity.cs | 118 +++ .../Schema/Entities/OMessageEntity.cs | 28 + .../Schema/Entities/ProductInfoEntity.cs | 33 + .../Schema/Entities/SensitiveUsageEntity.cs | 59 ++ .../Schema/Entities/StreamInfoEntity.cs | 51 ++ .../Microsoft.Teams.BotApps/Schema/Team.cs | 48 + .../Schema/TeamsActivity.cs | 142 +++ .../Schema/TeamsActivityBuilder.cs | 217 +++++ .../Schema/TeamsActivityJsonContext.cs | 36 + .../Schema/TeamsActivityType.cs | 44 + .../Schema/TeamsAttachment.cs | 90 ++ .../Schema/TeamsAttachmentBuilder.cs | 113 +++ .../Schema/TeamsChannel.cs | 35 + .../Schema/TeamsChannelData.cs | 78 ++ .../Schema/TeamsChannelDataSettings.cs | 28 + .../Schema/TeamsChannelDataTenant.cs | 17 + .../Schema/TeamsConversation.cs | 71 ++ .../Schema/TeamsConversationAccount .cs | 59 ++ .../TeamsBotApplication.cs | 106 +++ .../TeamsBotApplicationBuilder.cs | 83 ++ .../ConversationClientTest.cs | 663 +++++++++++++- .../BotApplicationTests.cs | 22 +- .../ConversationClientTests.cs | 18 +- .../CoreActivityBuilderTests.cs | 483 ++++++++++ .../AddBotApplicationExtensionsTests.cs | 50 +- .../MiddlewareTests.cs | 21 +- .../Schema/ActivityExtensibilityTests.cs | 2 +- .../Schema/CoreActivityTests.cs | 93 +- .../Schema/EntitiesTest.cs | 99 ++ .../ConversationUpdateActivityTests.cs | 115 +++ .../MessageReactionActivityTests.cs | 44 + .../Microsoft.Teams.BotApps.UnitTests.csproj | 25 + .../TeamsActivityBuilderTests.cs | 849 ++++++++++++++++++ .../TeamsActivityTests.cs | 357 ++++++++ core/test/msal-config-api/Program.cs | 7 +- .../msal-config-api/msal-config-api.csproj | 6 +- 84 files changed, 6844 insertions(+), 258 deletions(-) create mode 100644 core/samples/AllFeatures/AllFeatures.csproj create mode 100644 core/samples/AllFeatures/AllFeatures.http create mode 100644 core/samples/AllFeatures/Program.cs create mode 100644 core/samples/AllFeatures/appsettings.json create mode 100644 core/samples/CompatBot/Cards.cs create mode 100644 core/samples/CompatBot/MyCompatMiddleware.cs create mode 100644 core/samples/TeamsBot/Cards.cs create mode 100644 core/samples/TeamsBot/Program.cs create mode 100644 core/samples/TeamsBot/TeamsBot.csproj create mode 100644 core/samples/TeamsBot/appsettings.json create mode 100644 core/samples/scenarios/hello-assistant.cs create mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatConnectorClient.cs create mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs create mode 100644 core/src/Microsoft.Bot.Core/ConversationClient.Models.cs create mode 100644 core/src/Microsoft.Bot.Core/InvokeResponse.cs rename core/src/Microsoft.Bot.Core/Schema/{ActivityTypes.cs => ActivityType.cs} (83%) create mode 100644 core/src/Microsoft.Bot.Core/Schema/CoreActivityBuilder.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Context.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Handlers/ConversationUpdateHandler.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Handlers/InstallationUpdateHandler.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Handlers/MessageHandler.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Handlers/MessageReactionHandler.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/Entities/ClientInfoEntity.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/Entities/Entity.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/Entities/MentionEntity.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/Entities/OMessageEntity.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/Entities/SensitiveUsageEntity.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/Entities/StreamInfoEntity.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/Team.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityBuilder.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityJsonContext.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachmentBuilder.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsChannel.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataSettings.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataTenant.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsConversation.cs create mode 100644 core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs create mode 100644 core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs create mode 100644 core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs create mode 100644 core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs create mode 100644 core/test/Microsoft.Bot.Core.UnitTests/Schema/EntitiesTest.cs create mode 100644 core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs create mode 100644 core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs create mode 100644 core/test/Microsoft.Teams.BotApps.UnitTests/Microsoft.Teams.BotApps.UnitTests.csproj create mode 100644 core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityBuilderTests.cs create mode 100644 core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs diff --git a/.github/workflows/core-ci.yaml b/.github/workflows/core-ci.yaml index 48e76809..845f09f9 100644 --- a/.github/workflows/core-ci.yaml +++ b/.github/workflows/core-ci.yaml @@ -27,10 +27,14 @@ jobs: run: dotnet restore working-directory: core - - name: Build + - name: Build Core run: dotnet build --no-restore working-directory: core - name: Test run: dotnet test --no-build - working-directory: core \ No newline at end of file + working-directory: core + + - name: Build Core Tests + run: dotnet build + working-directory: core/test \ No newline at end of file diff --git a/core/README.md b/core/README.md index f401ffc8..61d0c5fe 100644 --- a/core/README.md +++ b/core/README.md @@ -67,7 +67,7 @@ botApp.OnActivity = async (activity, cancellationToken) => var replyText = $"CoreBot running on SDK {BotApplication.Version}."; replyText += $"\r\nYou sent: `{activity.Text}` in activity of type `{activity.Type}`."; replyText += $"\r\n to Conversation ID: `{activity.Conversation.Id}` type: `{activity.Conversation.Properties["conversationType"]}`"; - var replyActivity = activity.CreateReplyActivity(ActivityTypes.Message, replyText); + var replyActivity = activity.CreateReplyActivity(ActivityType.Message, replyText); await botApp.SendActivityAsync(replyActivity, cancellationToken); }; diff --git a/core/core.slnx b/core/core.slnx index 28857278..568dae41 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -1,4 +1,20 @@ + + + + + + + @@ -10,12 +26,13 @@ - - - - + + + + + + - - + diff --git a/core/samples/AFBot/DropTypingMiddleware.cs b/core/samples/AFBot/DropTypingMiddleware.cs index c93b2d08..2bc95269 100644 --- a/core/samples/AFBot/DropTypingMiddleware.cs +++ b/core/samples/AFBot/DropTypingMiddleware.cs @@ -1,4 +1,4 @@ -// Copyright (c) Microsoft Corporation. +// Copyright (c) Microsoft Corporation. // Licensed under the MIT License. using Microsoft.Bot.Core; @@ -10,7 +10,7 @@ internal class DropTypingMiddleware : ITurnMiddleWare { public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) { - if (activity.Type == ActivityTypes.Typing) return Task.CompletedTask; - return nextTurn(cancellationToken); + if (activity.Type == ActivityType.Typing) return Task.CompletedTask; + return nextTurn(cancellationToken); } } diff --git a/core/samples/AFBot/Program.cs b/core/samples/AFBot/Program.cs index fd8630e9..d37307b2 100644 --- a/core/samples/AFBot/Program.cs +++ b/core/samples/AFBot/Program.cs @@ -30,12 +30,35 @@ name: "AcronymMaker"); botApp.Use(new DropTypingMiddleware()); + botApp.OnActivity = async (activity, cancellationToken) => { - await botApp.SendTypingActivityAsync(activity, cancellationToken); - AgentRunResponse res = await agent.RunAsync(activity?.Text ?? "OMW"); - CoreActivity reply = activity!.CreateReplyMessageActivity(res.Text); - await botApp.SendActivityAsync(reply, cancellationToken); + ArgumentNullException.ThrowIfNull(activity); + + CancellationTokenSource timer = CancellationTokenSource.CreateLinkedTokenSource( + cancellationToken, new CancellationTokenSource(TimeSpan.FromSeconds(15)).Token); + + CoreActivity typing = CoreActivity.CreateBuilder() + .WithType(ActivityType.Typing) + .WithConversationReference(activity) + .Build(); + await botApp.SendActivityAsync(typing, cancellationToken); + + AgentRunResponse agentResponse = await agent.RunAsync(activity.Properties["text"]?.ToString() ?? "OMW", cancellationToken: timer.Token); + + var m1 = agentResponse.Messages.FirstOrDefault(); + Console.WriteLine($"AI:: GOT {agentResponse.Messages.Count} msgs"); + CoreActivity replyActivity = CoreActivity.CreateBuilder() + .WithType(ActivityType.Message) + .WithConversationReference(activity) + .WithProperty("text",m1!.Text) + .Build(); + + var res = await botApp.SendActivityAsync(replyActivity, cancellationToken); + + Console.WriteLine("SENT >>> => " + res?.Id); + return null!; + }; -webApp.Run(); \ No newline at end of file +webApp.Run(); diff --git a/core/samples/AllFeatures/AllFeatures.csproj b/core/samples/AllFeatures/AllFeatures.csproj new file mode 100644 index 00000000..a2d4b399 --- /dev/null +++ b/core/samples/AllFeatures/AllFeatures.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/core/samples/AllFeatures/AllFeatures.http b/core/samples/AllFeatures/AllFeatures.http new file mode 100644 index 00000000..e81f1fd6 --- /dev/null +++ b/core/samples/AllFeatures/AllFeatures.http @@ -0,0 +1,6 @@ +@AllFeatures_HostAddress = http://localhost:5290 + +GET {{AllFeatures_HostAddress}}/weatherforecast/ +Accept: application/json + +### diff --git a/core/samples/AllFeatures/Program.cs b/core/samples/AllFeatures/Program.cs new file mode 100644 index 00000000..b6745722 --- /dev/null +++ b/core/samples/AllFeatures/Program.cs @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.BotApps; +using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.BotApps.Schema.Entities; + +var builder = TeamsBotApplication.CreateBuilder(); +var teamsApp = builder.Build(); + +teamsApp.OnMessage = async (messageArgs, context, cancellationToken) => +{ + string replyText = $"You sent: `{messageArgs.Text}` in activity of type `{context.Activity.Type}`."; + + await context.SendTypingActivityAsync(cancellationToken); + + TeamsActivity reply = TeamsActivity.CreateBuilder() + .WithType(TeamsActivityType.Message) + .WithConversationReference(context.Activity) + .WithText(replyText) + .Build(); + + reply.AddMention(context.Activity.From!, "ridobotlocal", true); + + await context.TeamsBotApplication.SendActivityAsync(reply, cancellationToken); +}; + +teamsApp.Run(); diff --git a/core/samples/AllFeatures/appsettings.json b/core/samples/AllFeatures/appsettings.json new file mode 100644 index 00000000..10f68b8c --- /dev/null +++ b/core/samples/AllFeatures/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*" +} diff --git a/core/samples/CompatBot/Cards.cs b/core/samples/CompatBot/Cards.cs new file mode 100644 index 00000000..253ec28a --- /dev/null +++ b/core/samples/CompatBot/Cards.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Nodes; + +namespace CompatBot; + +internal class Cards +{ + + public static object ResponseCard(string? feedback) => new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new + { + type = "TextBlock", + text = "Form Submitted Successfully! ✓", + weight = "Bolder", + size = "Large", + color = "Good" + }, + new + { + type = "TextBlock", + text = $"You entered: **{feedback ?? "(empty)"}**", + wrap = true + } + } + }; + + public static readonly object FeedbackCardObj = new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new + { + type = "TextBlock", + text = "Please provide your feedback:", + weight = "Bolder", + size = "Medium" + }, + new + { + type = "Input.Text", + id = "feedback", + placeholder = "Enter your feedback here", + isMultiline = true + } + }, + actions = new object[] + { + new + { + type = "Action.Execute", + title = "Submit Feedback" + } + } + }; +} diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index f23c1744..5340200b 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -2,9 +2,14 @@ // Licensed under the MIT License. using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; using Microsoft.Bot.Builder.Teams; -using Microsoft.Bot.Core; +using Microsoft.Bot.Connector; +using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; +using Microsoft.Bot.Schema.Teams; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; namespace CompatBot; @@ -22,17 +27,49 @@ public override async Task OnTurnAsync(ITurnContext turnContext, CancellationTok await conversationState.SaveChangesAsync(turnContext, false, cancellationToken); } - protected override async Task OnMessageActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) { - logger.LogInformation("EchoBot OnMessageActivityAsync " + BotApplication.Version); - + logger.LogInformation("OnMessage"); IStatePropertyAccessor conversationStateAccessors = conversationState.CreateProperty(nameof(ConversationData)); ConversationData conversationData = await conversationStateAccessors.GetAsync(turnContext, () => new ConversationData(), cancellationToken); string replyText = $"Echo from BF Compat [{conversationData.MessageCount++}]: {turnContext.Activity.Text}"; await turnContext.SendActivityAsync(MessageFactory.Text(replyText, replyText), cancellationToken); // await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive message `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); + + var conversationClient = turnContext.TurnState.Get().Conversations; + + var cr = turnContext.Activity.GetConversationReference(); + var reply = Activity.CreateMessageActivity(); + reply.ApplyConversationReference(cr, isIncoming: false); + reply.Text = "This is a proactive message sent using the Conversations API."; + + var res = await conversationClient.SendToConversationAsync(cr.Conversation.Id, (Activity)reply, cancellationToken); + + await Task.Delay(2000, cancellationToken); + + await conversationClient.UpdateActivityAsync(cr.Conversation.Id, res.Id!, new Activity + { + Id = res.Id, + ServiceUrl = turnContext.Activity.ServiceUrl, + Type = ActivityType.Message, + Text = "This message has been updated.", + }, cancellationToken); + + await Task.Delay(2000, cancellationToken); + + await conversationClient.DeleteActivityAsync(cr.Conversation.Id, res.Id!, cancellationToken); + + await turnContext.SendActivityAsync(MessageFactory.Text("Proactive message sent and deleted."), cancellationToken); + + var attachment = new Attachment + { + ContentType = "application/vnd.microsoft.card.adaptive", + Content = Cards.FeedbackCardObj + }; + var attachmentReply = MessageFactory.Attachment(attachment); + await turnContext.SendActivityAsync(attachmentReply, cancellationToken); + } protected override async Task OnMessageReactionActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) @@ -52,15 +89,49 @@ protected override async Task OnInstallationUpdateAddAsync(ITurnContext membersAdded, ITurnContext turnContext, CancellationToken cancellationToken) - //{ - // await turnContext.SendActivityAsync(MessageFactory.Text("Welcome."), cancellationToken); - // await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive messages to `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); - //} - - //protected override async Task OnTeamsMeetingStartAsync(MeetingStartEventDetails meeting, ITurnContext turnContext, CancellationToken cancellationToken) - //{ - // await turnContext.SendActivityAsync(MessageFactory.Text("Welcome to meeting: "), cancellationToken); - // await turnContext.SendActivityAsync(MessageFactory.Text($"{meeting.Title} {meeting.MeetingType}"), cancellationToken); - //} + protected override async Task OnInvokeActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) + { + logger.LogInformation("Invoke Activity received: {Name}", turnContext.Activity.Name); + var actionValue = JObject.FromObject(turnContext.Activity.Value); + var action = actionValue["action"] as JObject; + var actionData = action?["data"] as JObject; + var userInput = actionData?["feedback"]?.ToString(); + //var userInput = actionValue["userInput"]?.ToString(); + + logger.LogInformation("Action: {Action}, User Input: {UserInput}", action, userInput); + + + + var attachment = new Attachment + { + ContentType = "application/vnd.microsoft.card.adaptive", + Content = Cards.ResponseCard(userInput) + }; + + var card = MessageFactory.Attachment(attachment); + await turnContext.SendActivityAsync(card, cancellationToken); + + return new InvokeResponse + { + Status = 200, + Body = "invokes from compat bot" + }; + } + + protected override async Task OnMembersAddedAsync(IList membersAdded, ITurnContext turnContext, CancellationToken cancellationToken) + { + await turnContext.SendActivityAsync(MessageFactory.Text("Welcome."), cancellationToken); + await turnContext.SendActivityAsync(MessageFactory.Text($"Send a proactive messages to `/api/notify/{turnContext.Activity.Conversation.Id}`"), cancellationToken); + } + + protected override Task OnMembersRemovedAsync(IList membersRemoved, ITurnContext turnContext, CancellationToken cancellationToken) + { + return turnContext.SendActivityAsync(MessageFactory.Text("Bye."), cancellationToken); + } + + protected override async Task OnTeamsMeetingStartAsync(MeetingStartEventDetails meeting, ITurnContext turnContext, CancellationToken cancellationToken) + { + await turnContext.SendActivityAsync(MessageFactory.Text("Welcome to meeting: "), cancellationToken); + await turnContext.SendActivityAsync(MessageFactory.Text($"{meeting.Title} {meeting.MeetingType}"), cancellationToken); + } } diff --git a/core/samples/CompatBot/MyCompatMiddleware.cs b/core/samples/CompatBot/MyCompatMiddleware.cs new file mode 100644 index 00000000..084384b6 --- /dev/null +++ b/core/samples/CompatBot/MyCompatMiddleware.cs @@ -0,0 +1,17 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Builder; + +namespace CompatBot +{ + public class MyCompatMiddleware : Microsoft.Bot.Builder.IMiddleware + { + public Task OnTurnAsync(ITurnContext turnContext, NextDelegate next, CancellationToken cancellationToken = default) + { + Console.WriteLine("MyCompatMiddleware: OnTurnAsync"); + Console.WriteLine(turnContext.Activity.Text); + return next(cancellationToken); + } + } +} diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index 69d2ed71..42220054 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -30,6 +30,8 @@ WebApplication app = builder.Build(); +CompatAdapter compatAdapter = (CompatAdapter)app.Services.GetRequiredService(); +compatAdapter.Use(new MyCompatMiddleware()); app.MapPost("/api/messages", async (IBotFrameworkHttpAdapter adapter, IBot bot, HttpRequest request, HttpResponse response, CancellationToken ct) => await adapter.ProcessAsync(request, response, bot, ct)); diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index f147500a..ddd05d10 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -17,7 +17,7 @@ botApp.OnActivity = async (activity, cancellationToken) => { string replyText = $"CoreBot running on SDK {BotApplication.Version}."; - replyText += $"
You sent: `{activity.Text}` in activity of type `{activity.Type}`."; + replyText += $"
You sent: `{activity.Properties["text"]}` in activity of type `{activity.Type}`."; string? conversationType = "unknown conversation type"; if (activity.Conversation.Properties.TryGetValue("conversationType", out object? ctProp)) @@ -26,8 +26,15 @@ } replyText += $"
To Conversation ID: `{activity.Conversation.Id}` conv type: `{conversationType}`"; - CoreActivity replyActivity = activity.CreateReplyMessageActivity(replyText); + + CoreActivity replyActivity = CoreActivity.CreateBuilder() + .WithType(ActivityType.Message) + .WithConversationReference(activity) + .WithProperty("text",replyText) + .Build(); + await botApp.SendActivityAsync(replyActivity, cancellationToken); + return null!; }; webApp.Run(); diff --git a/core/samples/Proactive/Proactive.csproj b/core/samples/Proactive/Proactive.csproj index 4a3268bc..5e44d94f 100644 --- a/core/samples/Proactive/Proactive.csproj +++ b/core/samples/Proactive/Proactive.csproj @@ -1,17 +1,17 @@ - - net8.0 - enable - enable - dotnet-Proactive-c4e4dec1-3f04-4738-9acf-33e72d1a339f - + + net8.0 + enable + enable + false + - - - + + + - - - + + + diff --git a/core/samples/Proactive/Worker.cs b/core/samples/Proactive/Worker.cs index 96276afe..aa7fe5af 100644 --- a/core/samples/Proactive/Worker.cs +++ b/core/samples/Proactive/Worker.cs @@ -20,12 +20,12 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken) { CoreActivity proactiveMessage = new() { - Text = $"Proactive hello at {DateTimeOffset.Now}", ServiceUrl = new Uri(ServiceUrl), From = new() { Id = FromId }, Conversation = new() { Id = ConversationId } }; - var aid = await conversationClient.SendActivityAsync(proactiveMessage, stoppingToken); + proactiveMessage.Properties["text"] = $"Proactive hello at {DateTimeOffset.Now}"; + var aid = await conversationClient.SendActivityAsync(proactiveMessage, cancellationToken: stoppingToken); logger.LogInformation("Activity {Aid} sent", aid.Id); } await Task.Delay(1000, stoppingToken); diff --git a/core/samples/TeamsBot/Cards.cs b/core/samples/TeamsBot/Cards.cs new file mode 100644 index 00000000..c6dcb77d --- /dev/null +++ b/core/samples/TeamsBot/Cards.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace TeamsBot; + +internal class Cards +{ + public static object ResponseCard(string? feedback) => new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new + { + type = "TextBlock", + text = "Form Submitted Successfully! ✓", + weight = "Bolder", + size = "Large", + color = "Good" + }, + new + { + type = "TextBlock", + text = $"You entered: **{feedback ?? "(empty)"}**", + wrap = true + } + } + }; + + public static readonly object FeedbackCardObj = new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new + { + type = "TextBlock", + text = "Please provide your feedback:", + weight = "Bolder", + size = "Medium" + }, + new + { + type = "Input.Text", + id = "feedback", + placeholder = "Enter your feedback here", + isMultiline = true + } + }, + actions = new object[] + { + new + { + type = "Action.Execute", + title = "Submit Feedback" + } + } + }; +} diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs new file mode 100644 index 00000000..2619024b --- /dev/null +++ b/core/samples/TeamsBot/Program.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Runtime.InteropServices.JavaScript; +using System.Text.Json; +using System.Text.Json.Nodes; +using Microsoft.Bot.Core; +using Microsoft.Teams.BotApps; +using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.BotApps.Schema.Entities; +using TeamsBot; + +var builder = TeamsBotApplication.CreateBuilder(); +var teamsApp = builder.Build(); + +teamsApp.OnMessage = async (messageArgs, context, cancellationToken) => +{ + await context.SendTypingActivityAsync(cancellationToken); + + string replyText = $"You sent: `{messageArgs.Text}` in activity of type `{context.Activity.Type}`."; + + TeamsActivity reply = TeamsActivity.CreateBuilder() + .WithText(replyText) + .Build(); + + reply.AddMention(context.Activity.From!, "ridobotlocal", true); + + await context.SendActivityAsync(reply, cancellationToken); + + TeamsActivity feedbackCard = TeamsActivity.CreateBuilder() + .WithAttachment(TeamsAttachment.CreateBuilder() + .WithAdaptiveCard(Cards.FeedbackCardObj) + .Build()) + .Build(); + await context.SendActivityAsync(feedbackCard, cancellationToken); +}; + +teamsApp.OnMessageReaction = async (args, context, cancellationToken) => +{ + string replyText = $"Message reaction activity of type `{context.Activity.Type}` received."; + replyText += args.ReactionsAdded != null + ? $"
Reactions Added: {string.Join(", ", args.ReactionsAdded.Select(r => r.Type))}." + : string.Empty; + replyText += args.ReactionsRemoved != null + ? $"
Reactions Removed: {string.Join(", ", args.ReactionsRemoved.Select(r => r.Type))}." + : string.Empty; + + await context.SendActivityAsync(replyText, cancellationToken); +}; + +teamsApp.OnInvoke = async (context, cancellationToken) => +{ + var valueNode = context.Activity.Value; + string? feedbackValue = valueNode?["action"]?["data"]?["feedback"]?.GetValue(); + + var reply = TeamsActivity.CreateBuilder() + .WithAttachment(TeamsAttachment.CreateBuilder() + .WithAdaptiveCard(Cards.ResponseCard(feedbackValue)) + .Build() + ) + .Build(); + + await context.SendActivityAsync(reply, cancellationToken); + + return new InvokeResponse(200) + { + Body = "Invokes are great !!" + }; +}; + +teamsApp.Run(); diff --git a/core/samples/TeamsBot/TeamsBot.csproj b/core/samples/TeamsBot/TeamsBot.csproj new file mode 100644 index 00000000..92f63141 --- /dev/null +++ b/core/samples/TeamsBot/TeamsBot.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/core/samples/TeamsBot/appsettings.json b/core/samples/TeamsBot/appsettings.json new file mode 100644 index 00000000..f88090b1 --- /dev/null +++ b/core/samples/TeamsBot/appsettings.json @@ -0,0 +1,10 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Warning", + "Microsoft.Bot": "Information", + "Microsoft.Teams": "Information" + } + }, + "AllowedHosts": "*" +} diff --git a/core/samples/scenarios/hello-assistant.cs b/core/samples/scenarios/hello-assistant.cs new file mode 100644 index 00000000..24496773 --- /dev/null +++ b/core/samples/scenarios/hello-assistant.cs @@ -0,0 +1,34 @@ +#!/usr/bin/dotnet run + +#:sdk Microsoft.NET.Sdk.Web + +#:project ../../src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj +#:project ../../src/Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj + + +using Microsoft.Teams.BotApps; +using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.BotApps.Schema.Entities; + +var builder = TeamsBotApplication.CreateBuilder(); +var teamsApp = builder.Build(); + +teamsApp.OnMessage = async (messageArgs, context, cancellationToken) => +{ + string replyText = $"You sent: `{messageArgs.Text}` in activity of type `{context.Activity.Type}`."; + + // await context.SendTypingActivityAsync(cancellationToken); + + // TeamsActivity reply = TeamsActivity.CreateBuilder() + // .WithType(TeamsActivityType.Message) + // .WithConversationReference(context.Activity) + // .WithText(replyText) + // .Build(); + + + // reply.AddMention(context.Activity.From!, "ridobotlocal", true); + + await context.SendActivityAsync(replyText, cancellationToken); +}; + +teamsApp.Run(); \ No newline at end of file diff --git a/core/samples/scenarios/middleware.cs b/core/samples/scenarios/middleware.cs index 9b9e28ea..7a172860 100755 --- a/core/samples/scenarios/middleware.cs +++ b/core/samples/scenarios/middleware.cs @@ -18,7 +18,12 @@ botApp.OnActivity = async (activity, cancellationToken) => { - var replyActivity = activity.CreateReplyMessageActivity("You said " + activity.Text); + string? text = activity.Properties.TryGetValue("text", out object? value) ? value?.ToString() : null; + var replyActivity = CoreActivity.CreateBuilder() + .WithType(ActivityType.Message) + .WithConversationReference(activity) + .WithProperty("text", "You said " + text) + .Build(); await botApp.SendActivityAsync(replyActivity, cancellationToken); }; diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs index 07da90ae..bfe28b25 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs @@ -27,4 +27,26 @@ public static CoreActivity FromCompatActivity(this Activity activity) BotMessageHandlerBase.BotMessageSerializer.Serialize(json, activity); return CoreActivity.FromJsonString(sb.ToString()); } + + public static Microsoft.Bot.Schema.ChannelAccount ToCompatChannelAccount(this Microsoft.Bot.Core.Schema.ConversationAccount account) + { + ChannelAccount channelAccount = new() + { + Id = account.Id, + Name = account.Name + }; + + // Extract AadObjectId and Role from Properties if they exist + if (account.Properties.TryGetValue("aadObjectId", out object? aadObjectId)) + { + channelAccount.AadObjectId = aadObjectId?.ToString(); + } + + if (account.Properties.TryGetValue("role", out object? role)) + { + channelAccount.Role = role?.ToString(); + } + + return channelAccount; + } } diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs index 875682ec..f41ef39c 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs @@ -6,6 +6,7 @@ using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; +using Newtonsoft.Json.Linq; namespace Microsoft.Bot.Core.Compat; @@ -60,15 +61,31 @@ public CompatAdapter Use(Builder.IMiddleware middleware) public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpResponse, IBot bot, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(httpRequest); + ArgumentNullException.ThrowIfNull(httpResponse); ArgumentNullException.ThrowIfNull(bot); + CoreActivity? coreActivity = null; - CoreActivity? activity = null; - botApplication.OnActivity = (activity, cancellationToken1) => + botApplication.OnActivity = async (activity, cancellationToken1) => { + coreActivity = activity; TurnContext turnContext = new(compatBotAdapter, activity.ToCompatActivity()); //turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); - return bot.OnTurnAsync(turnContext, cancellationToken1); + CompatConnectorClient connectionClient = new(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); + turnContext.TurnState.Add(connectionClient); + await bot.OnTurnAsync(turnContext, cancellationToken1).ConfigureAwait(false); + var invokeResponseAct = turnContext.TurnState.Get(BotAdapter.InvokeResponseKey); + if (invokeResponseAct is not null) + { + JObject valueObj = (JObject)invokeResponseAct.Value; + var body = valueObj["Body"]?.ToString(); + return new InvokeResponse(200) + { + Body = body, + }; + } + return null; }; + try { foreach (Builder.IMiddleware? middleware in MiddlewareSet) @@ -76,7 +93,12 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons botApplication.Use(new CompatMiddlewareAdapter(middleware)); } - activity = await botApplication.ProcessAsync(httpRequest.HttpContext, cancellationToken).ConfigureAwait(false); + var invokeResponse = await botApplication.ProcessAsync(httpRequest.HttpContext, cancellationToken).ConfigureAwait(false); + if (invokeResponse is not null) + { + httpResponse.StatusCode = invokeResponse.Status; + await httpResponse.WriteAsJsonAsync(invokeResponse, cancellationToken).ConfigureAwait(false); + } } catch (Exception ex) { @@ -84,8 +106,8 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons { if (ex is BotHandlerException aex) { - activity = aex.Activity; - using TurnContext turnContext = new(compatBotAdapter, activity!.ToCompatActivity()); + coreActivity = aex.Activity; + using TurnContext turnContext = new(compatBotAdapter, coreActivity!.ToCompatActivity()); await OnTurnError(turnContext, ex).ConfigureAwait(false); } else diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs index 516da676..2f8d1506 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs @@ -29,9 +29,10 @@ public class CompatBotAdapter(BotApplication botApplication, ILogger /// /// - public override Task DeleteActivityAsync(ITurnContext turnContext, ConversationReference reference, CancellationToken cancellationToken) + public override async Task DeleteActivityAsync(ITurnContext turnContext, ConversationReference reference, CancellationToken cancellationToken) { - throw new NotImplementedException(); + ArgumentNullException.ThrowIfNull(turnContext); + await botApplication.ConversationClient.DeleteActivityAsync(turnContext.Activity.FromCompatActivity(), cancellationToken: cancellationToken).ConfigureAwait(false); } /// @@ -44,13 +45,19 @@ public override Task DeleteActivityAsync(ITurnContext turnContext, ConversationR public override async Task SendActivitiesAsync(ITurnContext turnContext, Activity[] activities, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(activities); + ArgumentNullException.ThrowIfNull(turnContext); Microsoft.Bot.Schema.ResourceResponse[] responses = new Microsoft.Bot.Schema.ResourceResponse[1]; for (int i = 0; i < activities.Length; i++) { CoreActivity a = activities[i].FromCompatActivity(); - ResourceResponse? resp = await botApplication.SendActivityAsync(a, cancellationToken).ConfigureAwait(false); + if (a.Type == "invokeResponse") + { + turnContext.TurnState.Add(BotAdapter.InvokeResponseKey, a.ToCompatActivity()); + } + + SendActivityResponse? resp = await botApplication.SendActivityAsync(a, cancellationToken).ConfigureAwait(false); if (resp is not null) { responses[i] = new Microsoft.Bot.Schema.ResourceResponse() { Id = resp.Id }; @@ -59,6 +66,8 @@ public override Task DeleteActivityAsync(ITurnContext turnContext, ConversationR { logger.LogWarning("Found null ResourceResponse after calling SendActivityAsync"); } + + } return responses; } @@ -71,9 +80,15 @@ public override Task DeleteActivityAsync(ITurnContext turnContext, ConversationR /// /// /// - public override Task UpdateActivityAsync(ITurnContext turnContext, Activity activity, CancellationToken cancellationToken) + public override async Task UpdateActivityAsync(ITurnContext turnContext, Activity activity, CancellationToken cancellationToken) { - throw new NotImplementedException(); + ArgumentNullException.ThrowIfNull(activity); + var res = await botApplication.ConversationClient.UpdateActivityAsync( + activity.Conversation.Id, + activity.Id, + activity.FromCompatActivity(), + cancellationToken: cancellationToken).ConfigureAwait(false); + return new ResourceResponse() { Id = res.Id }; } diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatConnectorClient.cs b/core/src/Microsoft.Bot.Core.Compat/CompatConnectorClient.cs new file mode 100644 index 00000000..a74bd6b9 --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/CompatConnectorClient.cs @@ -0,0 +1,31 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Connector; +using Microsoft.Rest; +using Newtonsoft.Json; + +namespace Microsoft.Bot.Core.Compat +{ + internal sealed class CompatConnectorClient(CompatConversations conversations) : IConnectorClient + { + public IConversations Conversations => conversations; + + public Uri BaseUri { get => throw new NotImplementedException(); set => throw new NotImplementedException(); } + + public JsonSerializerSettings SerializationSettings => throw new NotImplementedException(); + + public JsonSerializerSettings DeserializationSettings => throw new NotImplementedException(); + + public ServiceClientCredentials Credentials => throw new NotImplementedException(); + + public IAttachments Attachments => throw new NotImplementedException(); + + + public void Dispose() + { + // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method + GC.SuppressFinalize(this); + } + } +} diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs b/core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs new file mode 100644 index 00000000..f2a95bcb --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs @@ -0,0 +1,338 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Connector; +using Microsoft.Bot.Core.Schema; +using Microsoft.Bot.Schema; +using Microsoft.Rest; + +// TODO: Figure out what to do with Agentic Identities. They're all "nulls" here right now. +// The identity is dependent on the incoming payload or supplied in for proactive scenarios. +namespace Microsoft.Bot.Core.Compat +{ + internal sealed class CompatConversations(ConversationClient client) : IConversations + { + private readonly ConversationClient _client = client; + internal string? ServiceUrl { get; set; } + + public async Task> CreateConversationWithHttpMessagesAsync( + Microsoft.Bot.Schema.ConversationParameters parameters, + Dictionary>? customHeaders = null, + CancellationToken cancellationToken = default) + { + Microsoft.Bot.Core.ConversationParameters convoParams = new() + { + Activity = parameters.Activity.FromCompatActivity() + }; + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + CreateConversationResponse res = await _client.CreateConversationAsync( + convoParams, + new Uri(ServiceUrl!), + AgenticIdentity.FromProperties(convoParams.Activity?.From.Properties), + convertedHeaders, + cancellationToken).ConfigureAwait(false); + + ConversationResourceResponse response = new() + { + ActivityId = res.ActivityId, + Id = res.Id, + ServiceUrl = res.ServiceUrl?.ToString(), + }; + + return new HttpOperationResponse + { + Body = response, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + + public async Task DeleteActivityWithHttpMessagesAsync(string conversationId, string activityId, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + await _client.DeleteActivityAsync( + conversationId, + activityId, + new Uri(ServiceUrl!), + null!, + ConvertHeaders(customHeaders), + cancellationToken).ConfigureAwait(false); + return new HttpOperationResponse + { + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + public async Task DeleteConversationMemberWithHttpMessagesAsync(string conversationId, string memberId, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + await _client.DeleteConversationMemberAsync( + conversationId, + memberId, + new Uri(ServiceUrl!), + null!, + ConvertHeaders(customHeaders), + cancellationToken).ConfigureAwait(false); + return new HttpOperationResponse { Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) }; + } + + public async Task>> GetActivityMembersWithHttpMessagesAsync(string conversationId, string activityId, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + IList members = await _client.GetActivityMembersAsync( + conversationId, + activityId, + new Uri(ServiceUrl!), + null, + convertedHeaders, + cancellationToken).ConfigureAwait(false); + + List channelAccounts = [.. members.Select(m => m.ToCompatChannelAccount())]; + + return new HttpOperationResponse> + { + Body = channelAccounts, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + public async Task>> GetConversationMembersWithHttpMessagesAsync(string conversationId, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + IList members = await _client.GetConversationMembersAsync( + conversationId, + new Uri(ServiceUrl!), + null, + convertedHeaders, + cancellationToken).ConfigureAwait(false); + + List channelAccounts = [.. members.Select(m => m.ToCompatChannelAccount())]; + + return new HttpOperationResponse> + { + Body = channelAccounts, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + public async Task> GetConversationPagedMembersWithHttpMessagesAsync(string conversationId, int? pageSize = null, string? continuationToken = null, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + PagedMembersResult pagedMembers = await _client.GetConversationPagedMembersAsync( + conversationId, + new Uri(ServiceUrl!), + pageSize, + continuationToken, + null, + convertedHeaders, + cancellationToken).ConfigureAwait(false); + + Bot.Schema.PagedMembersResult result = new() + { + ContinuationToken = pagedMembers.ContinuationToken, + Members = pagedMembers.Members?.Select(m => m.ToCompatChannelAccount()).ToList() + }; + + return new HttpOperationResponse + { + Body = result, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + public async Task> GetConversationsWithHttpMessagesAsync(string? continuationToken = null, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + GetConversationsResponse conversations = await _client.GetConversationsAsync( + new Uri(ServiceUrl!), + continuationToken, + null, + convertedHeaders, + cancellationToken).ConfigureAwait(false); + + ConversationsResult result = new() + { + ContinuationToken = conversations.ContinuationToken, + Conversations = conversations.Conversations?.Select(c => new Microsoft.Bot.Schema.ConversationMembers + { + Id = c.Id, + Members = c.Members?.Select(m => m.ToCompatChannelAccount()).ToList() + }).ToList() + }; + + return new HttpOperationResponse + { + Body = result, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + public async Task> ReplyToActivityWithHttpMessagesAsync(string conversationId, string activityId, Activity activity, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + CoreActivity coreActivity = activity.FromCompatActivity(); + + // ReplyToActivity is not available in ConversationClient, use SendActivityAsync with replyToId in Properties + coreActivity.Properties["replyToId"] = activityId; + if (coreActivity.Conversation == null) + { + coreActivity.Conversation = new Core.Schema.Conversation { Id = conversationId }; + } + else + { + coreActivity.Conversation.Id = conversationId; + } + + SendActivityResponse response = await _client.SendActivityAsync(coreActivity, convertedHeaders, cancellationToken).ConfigureAwait(false); + + ResourceResponse resourceResponse = new() + { + Id = response.Id + }; + + return new HttpOperationResponse + { + Body = resourceResponse, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + public async Task> SendConversationHistoryWithHttpMessagesAsync(string conversationId, Microsoft.Bot.Schema.Transcript transcript, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + Transcript coreTranscript = new() + { + Activities = transcript.Activities?.Select(a => a.FromCompatActivity()).ToList() + }; + + SendConversationHistoryResponse response = await _client.SendConversationHistoryAsync( + conversationId, + coreTranscript, + new Uri(ServiceUrl!), + null, + convertedHeaders, + cancellationToken).ConfigureAwait(false); + + ResourceResponse resourceResponse = new() + { + Id = response.Id + }; + + return new HttpOperationResponse + { + Body = resourceResponse, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + public async Task> SendToConversationWithHttpMessagesAsync(string conversationId, Activity activity, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + CoreActivity coreActivity = activity.FromCompatActivity(); + + // Ensure conversation ID is set + coreActivity.Conversation ??= new Core.Schema.Conversation { Id = conversationId }; + + SendActivityResponse response = await _client.SendActivityAsync(coreActivity, convertedHeaders, cancellationToken).ConfigureAwait(false); + + ResourceResponse resourceResponse = new() + { + Id = response.Id + }; + + return new HttpOperationResponse + { + Body = resourceResponse, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + public async Task> UpdateActivityWithHttpMessagesAsync(string conversationId, string activityId, Activity activity, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + CoreActivity coreActivity = activity.FromCompatActivity(); + + UpdateActivityResponse response = await _client.UpdateActivityAsync(conversationId, activityId, coreActivity, convertedHeaders, cancellationToken).ConfigureAwait(false); + + ResourceResponse resourceResponse = new() + { + Id = response.Id + }; + + return new HttpOperationResponse + { + Body = resourceResponse, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + public async Task> UploadAttachmentWithHttpMessagesAsync(string conversationId, Microsoft.Bot.Schema.AttachmentData attachmentUpload, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + AttachmentData coreAttachmentData = new() + { + Type = attachmentUpload.Type, + Name = attachmentUpload.Name, + OriginalBase64 = attachmentUpload.OriginalBase64, + ThumbnailBase64 = attachmentUpload.ThumbnailBase64 + }; + + UploadAttachmentResponse response = await _client.UploadAttachmentAsync( + conversationId, + coreAttachmentData, + new Uri(ServiceUrl!), + null, + convertedHeaders, + cancellationToken).ConfigureAwait(false); + + ResourceResponse resourceResponse = new() + { + Id = response.Id + }; + + return new HttpOperationResponse + { + Body = resourceResponse, + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + } + + private static Dictionary? ConvertHeaders(Dictionary>? customHeaders) + { + if (customHeaders == null) + { + return null; + } + + Dictionary convertedHeaders = []; + foreach (KeyValuePair> kvp in customHeaders) + { + convertedHeaders[kvp.Key] = string.Join(",", kvp.Value); + } + + return convertedHeaders; + } + + public async Task> GetConversationMemberWithHttpMessagesAsync(string userId, string conversationId, Dictionary> customHeaders = null!, CancellationToken cancellationToken = default) + { + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); + + Schema.ConversationAccount response = await _client.GetConversationMemberAsync(conversationId, userId, new Uri(ServiceUrl!), null!, convertedHeaders, cancellationToken).ConfigureAwait(false); + + return new HttpOperationResponse + { + Body = response.ToCompatChannelAccount(), + Response = new System.Net.Http.HttpResponseMessage(System.Net.HttpStatusCode.OK) + }; + + } + } +} diff --git a/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj b/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj index 51a12ef7..2ed30e36 100644 --- a/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj +++ b/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj @@ -10,5 +10,6 @@ + diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs index a4a13bb5..97b23022 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -38,7 +38,8 @@ public BotApplication(ConversationClient conversationClient, IConfiguration conf MiddleWare = new TurnMiddleware(); _conversationClient = conversationClient; string appId = config["MicrosoftAppId"] ?? config["CLIENT_ID"] ?? config[$"{sectionName}:ClientId"] ?? "Unknown AppID"; - logger.LogInformation("Started bot listener on {Port} for AppID:{AppId} with SDK version {SdkVersion}", config?["ASPNETCORE_URLS"], appId, Version); + logger.LogInformation("Started bot listener \n on {Port} \n for AppID:{AppId} \n with SDK version {SdkVersion}", config?["ASPNETCORE_URLS"], appId, Version); + } @@ -55,7 +56,7 @@ public BotApplication(ConversationClient conversationClient, IConfiguration conf /// Assign a delegate to process activities as they are received. The delegate should accept an /// and a , and return a representing the /// asynchronous operation. If , incoming activities will not be handled. - public Func? OnActivity { get; set; } + public Func>? OnActivity { get; set; } /// /// Processes an incoming HTTP request containing a bot activity. @@ -65,16 +66,18 @@ public BotApplication(ConversationClient conversationClient, IConfiguration conf /// /// /// - public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancellationToken = default) + public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(httpContext); ArgumentNullException.ThrowIfNull(_conversationClient); + InvokeResponse? invokeResponse = null; + _logger.LogDebug("Start processing HTTP request for activity"); CoreActivity activity = await CoreActivity.FromJsonStreamAsync(httpContext.Request.Body, cancellationToken).ConfigureAwait(false) ?? throw new InvalidOperationException("Invalid Activity"); - _logger.LogInformation("Processing activity: {Id} {Type}", activity.Id, activity.Type); + _logger.LogInformation("Processing activity {Type} {Id}", activity.Type, activity.Id); if (_logger.IsEnabled(LogLevel.Trace)) { @@ -85,7 +88,7 @@ public async Task ProcessAsync(HttpContext httpContext, Cancellati { try { - await MiddleWare.RunPipelineAsync(this, activity, this.OnActivity, 0, cancellationToken).ConfigureAwait(false); + invokeResponse = await MiddleWare.RunPipelineAsync(this, activity, this.OnActivity, 0, cancellationToken).ConfigureAwait(false); } catch (Exception ex) { @@ -96,7 +99,7 @@ public async Task ProcessAsync(HttpContext httpContext, Cancellati { _logger.LogInformation("Finished processing activity {Type} {Id}", activity.Type, activity.Id); } - return activity; + return invokeResponse; } } @@ -118,27 +121,15 @@ public ITurnMiddleWare Use(ITurnMiddleWare middleware) /// A cancellation token that can be used to cancel the send operation. /// A task that represents the asynchronous operation. The task result contains the identifier of the sent activity. /// Thrown if the conversation client has not been initialized. - public async Task SendActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) + public async Task SendActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(activity); ArgumentNullException.ThrowIfNull(_conversationClient, "ConversationClient not initialized"); - return await _conversationClient.SendActivityAsync(activity, cancellationToken).ConfigureAwait(false); + return await _conversationClient.SendActivityAsync(activity, cancellationToken: cancellationToken).ConfigureAwait(false); } - /// - /// Sends a typing activity to the conversation asynchronously. - /// - /// The activity containing conversation information. - /// - /// - public async Task SendTypingActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) - { - ArgumentNullException.ThrowIfNull(activity); - var typing = activity.CreateReplyMessageActivity(); - typing.Type = ActivityTypes.Typing; - return await SendActivityAsync(typing, cancellationToken).ConfigureAwait(false); - } + /// /// Gets the version of the SDK. diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.Models.cs b/core/src/Microsoft.Bot.Core/ConversationClient.Models.cs new file mode 100644 index 00000000..de0a345a --- /dev/null +++ b/core/src/Microsoft.Bot.Core/ConversationClient.Models.cs @@ -0,0 +1,248 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core; + +/// +/// Response from sending an activity. +/// +public class SendActivityResponse +{ + /// + /// Id of the activity + /// + [JsonPropertyName("id")] + public string? Id { get; set; } +} + +/// +/// Response from updating an activity. +/// +public class UpdateActivityResponse +{ + /// + /// Id of the activity + /// + [JsonPropertyName("id")] + public string? Id { get; set; } +} + +/// +/// Response from deleting an activity. +/// +public class DeleteActivityResponse +{ + /// + /// Id of the activity + /// + [JsonPropertyName("id")] + public string? Id { get; set; } +} + +/// +/// Response from getting conversations. +/// +public class GetConversationsResponse +{ + /// + /// Gets or sets the continuation token that can be used to get paged results. + /// + [JsonPropertyName("continuationToken")] + public string? ContinuationToken { get; set; } + + /// + /// Gets or sets the list of conversations. + /// + [JsonPropertyName("conversations")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? Conversations { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only +} + +/// +/// Represents a conversation and its members. +/// +public class ConversationMembers +{ + /// + /// Gets or sets the conversation ID. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Gets or sets the list of members in this conversation. + /// + [JsonPropertyName("members")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? Members { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only +} + +/// +/// Parameters for creating a new conversation. +/// +public class ConversationParameters +{ + /// + /// Gets or sets a value indicating whether the conversation is a group conversation. + /// + [JsonPropertyName("isGroup")] + public bool? IsGroup { get; set; } + + /// + /// Gets or sets the bot's account for this conversation. + /// + [JsonPropertyName("bot")] + public ConversationAccount? Bot { get; set; } + + /// + /// Gets or sets the list of members to add to the conversation. + /// + [JsonPropertyName("members")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? Members { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only + + /// + /// Gets or sets the topic name for the conversation (if supported by the channel). + /// + [JsonPropertyName("topicName")] + public string? TopicName { get; set; } + + /// + /// Gets or sets the initial activity to send when creating the conversation. + /// + [JsonPropertyName("activity")] + public CoreActivity? Activity { get; set; } + + /// + /// Gets or sets channel-specific payload for creating the conversation. + /// + [JsonPropertyName("channelData")] + public object? ChannelData { get; set; } + + /// + /// Gets or sets the tenant ID where the conversation should be created. + /// + [JsonPropertyName("tenantId")] + public string? TenantId { get; set; } +} + +/// +/// Response from creating a conversation. +/// +public class CreateConversationResponse +{ + /// + /// Gets or sets the ID of the activity (if sent). + /// + [JsonPropertyName("activityId")] + public string? ActivityId { get; set; } + + /// + /// Gets or sets the service endpoint where operations concerning the conversation may be performed. + /// + [JsonPropertyName("serviceUrl")] + public Uri? ServiceUrl { get; set; } + + /// + /// Gets or sets the identifier of the conversation resource. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } +} + +/// +/// Result from getting paged members of a conversation. +/// +public class PagedMembersResult +{ + /// + /// Gets or sets the continuation token that can be used to get paged results. + /// + [JsonPropertyName("continuationToken")] + public string? ContinuationToken { get; set; } + + /// + /// Gets or sets the list of members in this page. + /// + [JsonPropertyName("members")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? Members { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only +} + +/// +/// A collection of activities that represents a conversation transcript. +/// +public class Transcript +{ + /// + /// Gets or sets the collection of activities that conforms to the Transcript schema. + /// + [JsonPropertyName("activities")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? Activities { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only +} + +/// +/// Response from sending conversation history. +/// +public class SendConversationHistoryResponse +{ + /// + /// Gets or sets the ID of the resource. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } +} + +/// +/// Represents attachment data for uploading. +/// +public class AttachmentData +{ + /// + /// Gets or sets the Content-Type of the attachment. + /// + [JsonPropertyName("type")] + public string? Type { get; set; } + + /// + /// Gets or sets the name of the attachment. + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// + /// Gets or sets the attachment content as a byte array. + /// + [JsonPropertyName("originalBase64")] +#pragma warning disable CA1819 // Properties should not return arrays + public byte[]? OriginalBase64 { get; set; } +#pragma warning restore CA1819 // Properties should not return arrays + + /// + /// Gets or sets the attachment thumbnail as a byte array. + /// + [JsonPropertyName("thumbnailBase64")] +#pragma warning disable CA1819 // Properties should not return arrays + public byte[]? ThumbnailBase64 { get; set; } +#pragma warning restore CA1819 // Properties should not return arrays +} + +/// +/// Response from uploading an attachment. +/// +public class UploadAttachmentResponse +{ + /// + /// Gets or sets the ID of the uploaded attachment. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } +} diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index 06a8724a..727a31b9 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -1,76 +1,500 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Net.Http.Json; using System.Net.Mime; using System.Text; using System.Text.Json; using Microsoft.Bot.Core.Hosting; using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Logging; namespace Microsoft.Bot.Core; +using CustomHeaders = Dictionary; + /// /// Provides methods for sending activities to a conversation endpoint using HTTP requests. /// /// The HTTP client instance used to send requests to the conversation service. Must not be null. -public class ConversationClient(HttpClient httpClient) +/// The logger instance used for logging. Optional. +[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] +public class ConversationClient(HttpClient httpClient, ILogger logger = default!) { internal const string ConversationHttpClientName = "BotConversationClient"; + /// + /// Gets the default custom headers that will be included in all requests. + /// + public CustomHeaders DefaultCustomHeaders { get; } = []; + /// /// Sends the specified activity to the conversation endpoint asynchronously. /// /// The activity to send. Cannot be null. The activity must contain valid conversation and service URL information. + /// Optional custom headers to include in the request. /// A cancellation token that can be used to cancel the send operation. - /// A task that represents the asynchronous operation. The task result contains the response content as a string if - /// the activity is sent successfully. + /// A task that represents the asynchronous operation. The task result contains the response with the ID of the sent activity. /// Thrown if the activity could not be sent successfully. The exception message includes the HTTP status code and /// response content. - public async Task SendActivityAsync(CoreActivity activity, CancellationToken cancellationToken = default) + public async Task SendActivityAsync(CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(activity); ArgumentNullException.ThrowIfNull(activity.Conversation); ArgumentNullException.ThrowIfNullOrWhiteSpace(activity.Conversation.Id); ArgumentNullException.ThrowIfNull(activity.ServiceUrl); + if (activity.Type == "invokeResponse") + { + return new SendActivityResponse(); + } + string url = $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{activity.Conversation.Id}/activities/"; + string body = activity.ToJson(); + + logger?.LogTrace("Sending activity to {Url}: {Activity}", url, body); + + return await SendHttpRequestAsync( + HttpMethod.Post, + url, + body, + activity.From.GetAgenticIdentity(), + "sending activity", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + /// + /// Updates an existing activity in a conversation. + /// + /// The ID of the conversation. Cannot be null or whitespace. + /// The ID of the activity to update. Cannot be null or whitespace. + /// The updated activity data. Cannot be null. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the update operation. + /// A task that represents the asynchronous operation. The task result contains the response with the ID of the updated activity. + /// Thrown if the activity could not be updated successfully. + public async Task UpdateActivityAsync(string conversationId, string activityId, CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentNullException.ThrowIfNullOrWhiteSpace(activityId); + ArgumentNullException.ThrowIfNull(activity); + ArgumentNullException.ThrowIfNull(activity.ServiceUrl); + + string url = $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/activities/{activityId}"; + string body = activity.ToJson(); + + logger.LogTrace("Updating activity at {Url}: {Activity}", url, body); - using StringContent content = new(activity.ToJson(), Encoding.UTF8, MediaTypeNames.Application.Json); + return await SendHttpRequestAsync( + HttpMethod.Put, + url, + body, + activity.From.GetAgenticIdentity(), + "updating activity", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + + /// + /// Deletes an existing activity from a conversation. + /// + /// The ID of the conversation. Cannot be null or whitespace. + /// The ID of the activity to delete. Cannot be null or whitespace. + /// The service URL for the conversation. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the delete operation. + /// A task that represents the asynchronous operation. + /// Thrown if the activity could not be deleted successfully. + public async Task DeleteActivityAsync(string conversationId, string activityId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentNullException.ThrowIfNullOrWhiteSpace(activityId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/activities/{activityId}"; + + logger.LogTrace("Deleting activity at {Url}", url); + + await SendHttpRequestAsync( + HttpMethod.Delete, + url, + body: null, + agenticIdentity: agenticIdentity, + "deleting activity", + customHeaders, + cancellationToken).ConfigureAwait(false); + } - using HttpRequestMessage request = new(HttpMethod.Post, url) { Content = content }; + /// + /// Deletes an existing activity from a conversation using activity context. + /// + /// The activity to delete. Must contain valid Id, Conversation.Id, and ServiceUrl. Cannot be null. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the delete operation. + /// A task that represents the asynchronous operation. + /// Thrown if the activity could not be deleted successfully. + public async Task DeleteActivityAsync(CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentNullException.ThrowIfNullOrWhiteSpace(activity.Id); + ArgumentNullException.ThrowIfNull(activity.Conversation); + ArgumentNullException.ThrowIfNullOrWhiteSpace(activity.Conversation.Id); + ArgumentNullException.ThrowIfNull(activity.ServiceUrl); - request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity.FromProperties(activity.From.Properties)); + await DeleteActivityAsync( + activity.Conversation.Id, + activity.Id, + activity.ServiceUrl, + activity.From.GetAgenticIdentity(), + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + /// + /// Gets the members of a conversation. + /// + /// The ID of the conversation. Cannot be null or whitespace. + /// The service URL for the conversation. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains a list of conversation members. + /// Thrown if the members could not be retrieved successfully. + public async Task> GetConversationMembersAsync(string conversationId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/members"; + + logger.LogTrace("Getting conversation members from {Url}", url); + + return await SendHttpRequestAsync>( + HttpMethod.Get, + url, + body: null, + agenticIdentity, + "getting conversation members", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + + /// + /// Gets a specific member of a conversation. + /// + /// + /// + /// + /// + /// + /// + /// + public async Task GetConversationMemberAsync(string conversationId, string userId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentNullException.ThrowIfNull(serviceUrl); + ArgumentNullException.ThrowIfNullOrWhiteSpace(userId); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/members/{userId}"; + + logger.LogTrace("Getting conversation members from {Url}", url); + + return await SendHttpRequestAsync( + HttpMethod.Get, + url, + body: null, + agenticIdentity, + "getting conversation members", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + /// + /// Gets the conversations in which the bot has participated. + /// + /// The service URL for the bot. Cannot be null. + /// Optional continuation token for pagination. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the conversations and an optional continuation token. + /// Thrown if the conversations could not be retrieved successfully. + public async Task GetConversationsAsync(Uri serviceUrl, string? continuationToken = null, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations"; + if (!string.IsNullOrWhiteSpace(continuationToken)) + { + url += $"?continuationToken={Uri.EscapeDataString(continuationToken)}"; + } + + logger.LogTrace("Getting conversations from {Url}", url); + + return await SendHttpRequestAsync( + HttpMethod.Get, + url, + body: null, + agenticIdentity, + "getting conversations", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + /// + /// Gets the members of a specific activity. + /// + /// The ID of the conversation. Cannot be null or whitespace. + /// The ID of the activity. Cannot be null or whitespace. + /// The service URL for the conversation. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains a list of members for the activity. + /// Thrown if the activity members could not be retrieved successfully. + public async Task> GetActivityMembersAsync(string conversationId, string activityId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentNullException.ThrowIfNullOrWhiteSpace(activityId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/activities/{activityId}/members"; + + logger.LogTrace("Getting activity members from {Url}", url); + + return await SendHttpRequestAsync>( + HttpMethod.Get, + url, + body: null, + agenticIdentity, + "getting activity members", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + /// + /// Creates a new conversation. + /// + /// The parameters for creating the conversation. Cannot be null. + /// The service URL for the bot. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the conversation resource response with the conversation ID. + /// Thrown if the conversation could not be created successfully. + public async Task CreateConversationAsync(ConversationParameters parameters, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(parameters); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations"; + + logger.LogTrace("Creating conversation at {Url} with parameters: {Parameters}", url, JsonSerializer.Serialize(parameters)); + + return await SendHttpRequestAsync( + HttpMethod.Post, + url, + JsonSerializer.Serialize(parameters), + agenticIdentity, + "creating conversation", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + /// + /// Gets the members of a conversation one page at a time. + /// + /// The ID of the conversation. Cannot be null or whitespace. + /// The service URL for the conversation. Cannot be null. + /// Optional page size for the number of members to retrieve. + /// Optional continuation token for pagination. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains a page of members and an optional continuation token. + /// Thrown if the conversation members could not be retrieved successfully. + public async Task GetConversationPagedMembersAsync(string conversationId, Uri serviceUrl, int? pageSize = null, string? continuationToken = null, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/pagedmembers"; + + List queryParams = []; + if (pageSize.HasValue) + { + queryParams.Add($"pageSize={pageSize.Value}"); + } + if (!string.IsNullOrWhiteSpace(continuationToken)) + { + queryParams.Add($"continuationToken={Uri.EscapeDataString(continuationToken)}"); + } + if (queryParams.Count > 0) + { + url += $"?{string.Join("&", queryParams)}"; + } + + logger.LogTrace("Getting paged conversation members from {Url}", url); + + return await SendHttpRequestAsync( + HttpMethod.Get, + url, + body: null, + agenticIdentity, + "getting paged conversation members", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + /// + /// Deletes a member from a conversation. + /// + /// The ID of the conversation. Cannot be null or whitespace. + /// The ID of the member to delete. Cannot be null or whitespace. + /// The service URL for the conversation. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. + /// Thrown if the member could not be deleted successfully. + /// If the deleted member was the last member of the conversation, the conversation is also deleted. + public async Task DeleteConversationMemberAsync(string conversationId, string memberId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentNullException.ThrowIfNullOrWhiteSpace(memberId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/members/{memberId}"; + + logger.LogTrace("Deleting conversation member at {Url}", url); + + await SendHttpRequestAsync( + HttpMethod.Delete, + url, + body: null, + agenticIdentity, + "deleting conversation member", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + /// + /// Uploads and sends historic activities to the conversation. + /// + /// The ID of the conversation. Cannot be null or whitespace. + /// The transcript containing the historic activities. Cannot be null. + /// The service URL for the conversation. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the response with a resource ID. + /// Thrown if the history could not be sent successfully. + /// Activities in the transcript must have unique IDs and appropriate timestamps for proper rendering. + public async Task SendConversationHistoryAsync(string conversationId, Transcript transcript, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentNullException.ThrowIfNull(transcript); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/activities/history"; + + logger.LogTrace("Sending conversation history to {Url}: {Transcript}", url, JsonSerializer.Serialize(transcript)); + + return await SendHttpRequestAsync( + HttpMethod.Post, + url, + JsonSerializer.Serialize(transcript), + agenticIdentity, + "sending conversation history", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + /// + /// Uploads an attachment to the channel's blob storage. + /// + /// The ID of the conversation. Cannot be null or whitespace. + /// The attachment data to upload. Cannot be null. + /// The service URL for the conversation. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the response with an attachment ID. + /// Thrown if the attachment could not be uploaded successfully. + /// This is useful for storing data in a compliant store when dealing with enterprises. + public async Task UploadAttachmentAsync(string conversationId, AttachmentData attachmentData, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentNullException.ThrowIfNull(attachmentData); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/attachments"; + + logger.LogTrace("Uploading attachment to {Url}: {AttachmentData}", url, JsonSerializer.Serialize(attachmentData)); + + return await SendHttpRequestAsync( + HttpMethod.Post, + url, + JsonSerializer.Serialize(attachmentData), + agenticIdentity, + "uploading attachment", + customHeaders, + cancellationToken).ConfigureAwait(false); + } + + private async Task SendHttpRequestAsync(HttpMethod method, string url, string? body, AgenticIdentity? agenticIdentity, string operationDescription, CustomHeaders? customHeaders, CancellationToken cancellationToken) + { + using HttpRequestMessage request = new(method, url); + + if (body is not null) + { + request.Content = new StringContent(body, Encoding.UTF8, MediaTypeNames.Application.Json); + } + + if (agenticIdentity is not null) + { + request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, agenticIdentity); + } + + // Apply default custom headers + foreach (KeyValuePair header in DefaultCustomHeaders) + { + request.Headers.TryAddWithoutValidation(header.Key, header.Value); + } + + // Apply method-level custom headers (these override default headers if same key) + if (customHeaders is not null) + { + foreach (KeyValuePair header in customHeaders) + { + request.Headers.Remove(header.Key); + request.Headers.TryAddWithoutValidation(header.Key, header.Value); + } + } + + logger?.LogTrace("Sending HTTP {Method} request to {Url} with body: {Body}", method, url, body); using HttpResponseMessage resp = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); if (resp.IsSuccessStatusCode) { string responseString = await resp.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); - if (responseString.Length > 2) // to handle empty response + if (responseString.Length > 2) // to handle empty response { - ResourceResponse? resourceResponse = JsonSerializer.Deserialize(responseString); - return resourceResponse ?? new ResourceResponse(); + T? result = JsonSerializer.Deserialize(responseString); + return result ?? throw new InvalidOperationException($"Failed to deserialize response for {operationDescription}"); } - return new ResourceResponse(); + // Empty response - return default value (e.g., for DELETE operations) + return default!; } else { string errResponseString = await resp.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); - throw new HttpRequestException($"Error sending activity {resp.StatusCode}. {errResponseString}"); + throw new HttpRequestException($"Error {operationDescription} {resp.StatusCode}. {errResponseString}"); } } } - -/// -/// Resource Response -/// -public class ResourceResponse -{ - /// - /// Id of the activity - /// - [JsonPropertyName("id")] - public string? Id { get; set; } -} diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 44d4c869..458497ff 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -49,8 +49,10 @@ public static TApp UseBotApplication( ArgumentNullException.ThrowIfNull(webApp); webApp.MapPost(routePath, async (HttpContext httpContext, CancellationToken cancellationToken) => { - CoreActivity resp = await app.ProcessAsync(httpContext, cancellationToken).ConfigureAwait(false); - return resp.Id; + // TODO: BotFramework used to return activity.id if incoming activity was not "Invoke". + // We don't know if that is required. + InvokeResponse? resp = await app.ProcessAsync(httpContext, cancellationToken).ConfigureAwait(false); + return resp; }).RequireAuthorization(); return app; @@ -81,7 +83,7 @@ public static IServiceCollection AddBotApplication(this IServiceCollection /// public static IServiceCollection AddConversationClient(this IServiceCollection services, string sectionName = "AzureAd") { - var sp = services.BuildServiceProvider(); + ServiceProvider sp = services.BuildServiceProvider(); IConfiguration configuration = sp.GetRequiredService(); ILogger logger = sp.GetRequiredService>(); ArgumentNullException.ThrowIfNull(configuration); diff --git a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs index 2ff8d5f8..cbf32992 100644 --- a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs +++ b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs @@ -12,7 +12,7 @@ namespace Microsoft.Bot.Core; /// The cancellation token should be observed to support cooperative cancellation. /// A cancellation token that can be used to cancel the asynchronous operation. /// A task that represents the completion of the middleware invocation. -public delegate Task NextTurn(CancellationToken cancellationToken); +public delegate Task NextTurn(CancellationToken cancellationToken); /// /// Defines a middleware component that can process or modify activities during a bot turn. diff --git a/core/src/Microsoft.Bot.Core/InvokeResponse.cs b/core/src/Microsoft.Bot.Core/InvokeResponse.cs new file mode 100644 index 00000000..804321f2 --- /dev/null +++ b/core/src/Microsoft.Bot.Core/InvokeResponse.cs @@ -0,0 +1,36 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace Microsoft.Bot.Core; + +/// +/// Represents the response returned from an invocation handler. +/// +/// +/// Creates a new instance of the class with the specified status code and optional body. +/// +/// +/// +public class InvokeResponse(int status, object? body = null) +{ + /// + /// Status code of the response. + /// + [JsonPropertyName("status")] + public int Status { get; set; } = status; + + // TODO: This is strange - Should this be Value or Body? + /// + /// Gets or sets the message body content. + /// + [JsonPropertyName("value")] + public object? Body { get; set; } = body; + + // TODO: Get confirmation that this should be "Type" + // This particular type should be for AC responses + /// + /// Gets or Sets the Type + /// + [JsonPropertyName("type")] + public string? Type { get; set; } = "application/vnd.microsoft.activity.message"; +} diff --git a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs b/core/src/Microsoft.Bot.Core/Schema/ActivityType.cs similarity index 83% rename from core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs rename to core/src/Microsoft.Bot.Core/Schema/ActivityType.cs index 3837f391..93baec63 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ActivityTypes.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ActivityType.cs @@ -8,7 +8,7 @@ namespace Microsoft.Bot.Core.Schema; /// /// Use the fields of this class to specify or compare activity types in message-based systems. This /// class is typically used to avoid hardcoding string literals for activity type identifiers. -public static class ActivityTypes +public static class ActivityType { /// /// Represents the default message string used for communication or display purposes. @@ -18,4 +18,9 @@ public static class ActivityTypes /// Represents a typing indicator activity. /// public const string Typing = "typing"; + + /// + /// Represents an invoke activity. + /// + public const string Invoke = "invoke"; } diff --git a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs index d286bbc5..e57add35 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs @@ -31,4 +31,27 @@ public class ConversationAccount() #pragma warning disable CA2227 // Collection properties should be read only public ExtendedPropertiesDictionary Properties { get; set; } = []; #pragma warning restore CA2227 // Collection properties should be read only + + /// + /// Gets the agentic identity from the account properties. + /// + /// An AgenticIdentity instance if properties contain agentic identity information; otherwise, null. + internal AgenticIdentity? GetAgenticIdentity() + { + Properties.TryGetValue("agenticAppId", out object? appIdObj); + Properties.TryGetValue("agenticUserId", out object? userIdObj); + Properties.TryGetValue("agenticAppBlueprintId", out object? bluePrintObj); + + if (appIdObj is null && userIdObj is null && bluePrintObj is null) + { + return null; + } + + return new AgenticIdentity + { + AgenticAppId = appIdObj?.ToString(), + AgenticUserId = userIdObj?.ToString(), + AgenticAppBlueprintId = bluePrintObj?.ToString() + }; + } } diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs index 9f1041c1..b4113d59 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs @@ -3,6 +3,7 @@ using System.Text.Json; using System.Text.Json.Nodes; +using System.Text.Json.Serialization.Metadata; namespace Microsoft.Bot.Core.Schema; @@ -20,24 +21,20 @@ public class ExtendedPropertiesDictionary : Dictionary { } /// and includes extension properties for channel-specific data. /// Follows the Activity Protocol Specification: https://github.com/microsoft/Agents/blob/main/specs/activity/protocol-activity.md /// -public class CoreActivity(string type = ActivityTypes.Message) +public class CoreActivity { /// - /// Gets or sets the type of the activity. See for common values. + /// Gets or sets the type of the activity. See for common values. /// /// /// Common activity types include "message", "conversationUpdate", "contactRelationUpdate", etc. /// - [JsonPropertyName("type")] public string Type { get; set; } = type; + [JsonPropertyName("type")] public string Type { get; set; } /// /// Gets or sets the unique identifier for the channel on which this activity is occurring. /// [JsonPropertyName("channelId")] public string? ChannelId { get; set; } /// - /// Gets or sets the text content of the message. - /// - [JsonPropertyName("text")] public string? Text { get; set; } - /// /// Gets or sets the unique identifier for the activity. /// [JsonPropertyName("id")] public string? Id { get; set; } @@ -64,17 +61,30 @@ public class CoreActivity(string type = ActivityTypes.Message) /// Gets or sets the conversation in which this activity is taking place. /// [JsonPropertyName("conversation")] public Conversation Conversation { get; set; } = new(); + /// /// Gets the collection of entities contained in this activity. /// /// /// Entities are structured objects that represent mentions, places, or other data. /// - [JsonPropertyName("entities")] public JsonArray? Entities { get; } +#pragma warning disable CA2227 // Collection properties should be read only + [JsonPropertyName("entities")] public JsonArray? Entities { get; set; } + + /// + /// Gets the collection of attachments associated with this activity. + /// + [JsonPropertyName("attachments")] public JsonArray? Attachments { get; set; } + + // TODO: Can value need be a JSONObject? + /// + /// Gets or sets the value payload of the activity. + /// + [JsonPropertyName("value")] public JsonNode? Value { get; set; } + /// /// Gets the extension data dictionary for storing additional properties not defined in the schema. /// -#pragma warning disable CA2227 // Collection properties should be read only [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; #pragma warning restore CA2227 // Collection properties should be read only @@ -100,11 +110,63 @@ public class CoreActivity(string type = ActivityTypes.Message) PropertyNamingPolicy = JsonNamingPolicy.CamelCase }; + /// + /// Creates a new instance of the class with the specified activity type. + /// + /// + public CoreActivity(string type = ActivityType.Message) + { + Type = type; + } + + + /// + /// Creates a new instance of the class. As Message type by default. + /// + public CoreActivity() + { + Type = ActivityType.Message; + } + + /// + /// Creates a new instance of the class by copying properties from another activity. + /// + /// The source activity to copy from. + protected CoreActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + + Id = activity.Id; + ServiceUrl = activity.ServiceUrl; + ChannelId = activity.ChannelId; + Type = activity.Type; + // TODO: Figure out why this is needed... + // ReplyToId = activity.ReplyToId; + ChannelData = activity.ChannelData; + From = activity.From; + Recipient = activity.Recipient; + Conversation = activity.Conversation; + Entities = activity.Entities; + Attachments = activity.Attachments; + Properties = activity.Properties; + Value = activity.Value; + } + /// /// Serializes the current activity to a JSON string. /// /// A JSON string representation of the activity. - public string ToJson() => JsonSerializer.Serialize(this, CoreActivityJsonContext.Default.CoreActivity); + public string ToJson() + => JsonSerializer.Serialize(this, CoreActivityJsonContext.Default.CoreActivity); + + /// + /// Serializes the current activity to a JSON string using the specified JsonTypeInfo options. + /// + /// + /// + /// + public string ToJson(JsonTypeInfo ops) where T : CoreActivity + => JsonSerializer.Serialize(this, ops); /// /// Serializes the specified activity instance to a JSON string using the default serialization options. @@ -136,6 +198,16 @@ public static CoreActivity FromJsonString(string json) public static T FromJsonString(string json) where T : CoreActivity => JsonSerializer.Deserialize(json, ReflectionJsonOptions)!; + /// + /// Deserializes the specified JSON string to an object of type T using the provided JsonSerializerOptions. + /// + /// + /// + /// + /// + public static T FromJsonString(string json, JsonTypeInfo options) where T : CoreActivity + => JsonSerializer.Deserialize(json, options)!; + /// /// Asynchronously deserializes a JSON stream into a object. /// @@ -145,6 +217,17 @@ public static T FromJsonString(string json) where T : CoreActivity public static ValueTask FromJsonStreamAsync(Stream stream, CancellationToken cancellationToken = default) => JsonSerializer.DeserializeAsync(stream, CoreActivityJsonContext.Default.CoreActivity, cancellationToken); + /// + /// Deserializes a JSON stream into an instance of type T using the specified JsonTypeInfo options. + /// + /// + /// + /// + /// + /// + public static ValueTask FromJsonStreamAsync(Stream stream, JsonTypeInfo ops, CancellationToken cancellationToken = default) where T : CoreActivity + => JsonSerializer.DeserializeAsync(stream, ops, cancellationToken); + /// /// Asynchronously deserializes a JSON value from the specified stream into an instance of type T. /// @@ -157,29 +240,12 @@ public static T FromJsonString(string json) where T : CoreActivity /// A ValueTask that represents the asynchronous operation. The result contains an instance of type T if /// deserialization is successful; otherwise, null. public static ValueTask FromJsonStreamAsync(Stream stream, CancellationToken cancellationToken = default) where T : CoreActivity - => JsonSerializer.DeserializeAsync(stream, ReflectionJsonOptions, cancellationToken); + => JsonSerializer.DeserializeAsync(stream, ReflectionJsonOptions, cancellationToken); /// - /// Creates a reply activity based on the current activity. + /// Creates a new instance of the to construct activity instances. /// - /// The text content for the reply. Defaults to an empty string. - /// A new configured as a reply to the current activity. - /// - /// The reply activity automatically swaps the From and Recipient accounts and preserves - /// the conversation context, channel ID, and service URL from the original activity. - /// - public CoreActivity CreateReplyMessageActivity(string text = "") - { - CoreActivity result = new() - { - Type = ActivityTypes.Message, - ChannelId = ChannelId, - ServiceUrl = ServiceUrl, - Conversation = Conversation, - From = Recipient, - Recipient = From, - Text = text - }; - return result; - } + /// + public static CoreActivityBuilder CreateBuilder() => new(); + } diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivityBuilder.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivityBuilder.cs new file mode 100644 index 00000000..8d01c37d --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivityBuilder.cs @@ -0,0 +1,229 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace Microsoft.Bot.Core.Schema; + +/// +/// Provides a fluent API for building CoreActivity instances. +/// +/// The type of activity being built. +/// The type of the builder (for fluent method chaining). +public abstract class CoreActivityBuilder + where TActivity : CoreActivity + where TBuilder : CoreActivityBuilder +{ + /// + /// The activity being built. + /// +#pragma warning disable CA1051 // Do not declare visible instance fields + protected readonly TActivity _activity; +#pragma warning restore CA1051 // Do not declare visible instance fields + + /// + /// Initializes a new instance of the CoreActivityBuilder class. + /// + /// The activity to build upon. + protected CoreActivityBuilder(TActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + _activity = activity; + } + + /// + /// Apply Conversation Reference + /// + /// The source activity to copy conversation reference from. + /// The builder instance for chaining. + public TBuilder WithConversationReference(TActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentNullException.ThrowIfNull(activity.ChannelId); + ArgumentNullException.ThrowIfNull(activity.ServiceUrl); + ArgumentNullException.ThrowIfNull(activity.Conversation); + ArgumentNullException.ThrowIfNull(activity.From); + ArgumentNullException.ThrowIfNull(activity.Recipient); + + WithServiceUrl(activity.ServiceUrl); + WithChannelId(activity.ChannelId); + SetConversation(activity.Conversation); + SetFrom(activity.Recipient); + SetRecipient(activity.From); + + return (TBuilder)this; + } + + /// + /// Sets the conversation (to be overridden by derived classes for type-specific behavior). + /// + protected abstract void SetConversation(Conversation conversation); + + /// + /// Sets the From account (to be overridden by derived classes for type-specific behavior). + /// + protected abstract void SetFrom(ConversationAccount from); + + /// + /// Sets the Recipient account (to be overridden by derived classes for type-specific behavior). + /// + protected abstract void SetRecipient(ConversationAccount recipient); + + /// + /// Sets the activity ID. + /// + /// The activity ID. + /// The builder instance for chaining. + public TBuilder WithId(string id) + { + _activity.Id = id; + return (TBuilder)this; + } + + /// + /// Sets the service URL. + /// + /// The service URL. + /// The builder instance for chaining. + public TBuilder WithServiceUrl(Uri serviceUrl) + { + _activity.ServiceUrl = serviceUrl; + return (TBuilder)this; + } + + /// + /// Sets the channel ID. + /// + /// The channel ID. + /// The builder instance for chaining. + public TBuilder WithChannelId(string channelId) + { + _activity.ChannelId = channelId; + return (TBuilder)this; + } + + /// + /// Sets the activity type. + /// + /// The activity type. + /// The builder instance for chaining. + public TBuilder WithType(string type) + { + _activity.Type = type; + return (TBuilder)this; + } + + /// + /// Adds or updates a property in the activity's Properties dictionary. + /// + /// Name of the property. + /// Value of the property. + /// The builder instance for chaining. + public TBuilder WithProperty(string name, T? value) + { + _activity.Properties[name] = value; + return (TBuilder)this; + } + + /// + /// Sets the sender account information. + /// + /// The sender account. + /// The builder instance for chaining. + public TBuilder WithFrom(ConversationAccount from) + { + SetFrom(from); + return (TBuilder)this; + } + + /// + /// Sets the recipient account information. + /// + /// The recipient account. + /// The builder instance for chaining. + public TBuilder WithRecipient(ConversationAccount recipient) + { + SetRecipient(recipient); + return (TBuilder)this; + } + + /// + /// Sets the conversation information. + /// + /// The conversation information. + /// The builder instance for chaining. + public TBuilder WithConversation(Conversation conversation) + { + SetConversation(conversation); + return (TBuilder)this; + } + + /// + /// Sets the channel-specific data (to be overridden by derived classes for type-specific behavior). + /// + /// The channel data. + /// The builder instance for chaining. + public virtual TBuilder WithChannelData(ChannelData? channelData) + { + _activity.ChannelData = channelData; + return (TBuilder)this; + } + + /// + /// Builds and returns the configured activity instance. + /// + /// The configured activity. + public abstract TActivity Build(); +} + +/// +/// Provides a fluent API for building CoreActivity instances. +/// +public class CoreActivityBuilder : CoreActivityBuilder +{ + /// + /// Initializes a new instance of the CoreActivityBuilder class. + /// + internal CoreActivityBuilder() : base(new CoreActivity()) + { + } + + /// + /// Initializes a new instance of the CoreActivityBuilder class with an existing activity. + /// + /// The activity to build upon. + internal CoreActivityBuilder(CoreActivity activity) : base(activity) + { + } + + /// + /// Sets the conversation. + /// + protected override void SetConversation(Conversation conversation) + { + _activity.Conversation = conversation; + } + + /// + /// Sets the From account. + /// + protected override void SetFrom(ConversationAccount from) + { + _activity.From = from; + } + + /// + /// Sets the Recipient account. + /// + protected override void SetRecipient(ConversationAccount recipient) + { + _activity.Recipient = recipient; + } + + /// + /// Builds and returns the configured CoreActivity instance. + /// + /// The configured CoreActivity. + public override CoreActivity Build() + { + return _activity; + } +} diff --git a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs index f177c2d3..d3968077 100644 --- a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs +++ b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs @@ -24,19 +24,29 @@ public async Task OnTurnAsync(BotApplication botApplication, CoreActivity activi await next(cancellationToken).ConfigureAwait(false); } - public Task RunPipelineAsync(BotApplication botApplication, CoreActivity activity, Func? callback, int nextMiddlewareIndex, CancellationToken cancellationToken) + public async Task RunPipelineAsync(BotApplication botApplication, CoreActivity activity, Func>? callback, int nextMiddlewareIndex, CancellationToken cancellationToken) { + InvokeResponse? invokeResponse = null; if (nextMiddlewareIndex == _middlewares.Count) { - return callback is not null ? callback!(activity, cancellationToken) ?? Task.CompletedTask : Task.CompletedTask; + if (callback is not null) + { + invokeResponse = await callback(activity, cancellationToken).ConfigureAwait(false); + } + return invokeResponse; } + ITurnMiddleWare nextMiddleware = _middlewares[nextMiddlewareIndex]; - return nextMiddleware.OnTurnAsync( + await nextMiddleware.OnTurnAsync( botApplication, activity, - (ct) => RunPipelineAsync(botApplication, activity, callback, nextMiddlewareIndex + 1, ct), - cancellationToken); + async (ct) => { + invokeResponse = await RunPipelineAsync(botApplication, activity, callback, nextMiddlewareIndex + 1, ct).ConfigureAwait(false); + return invokeResponse; + }, + cancellationToken).ConfigureAwait(false); + return invokeResponse; } public IEnumerator GetEnumerator() diff --git a/core/src/Microsoft.Teams.BotApps/Context.cs b/core/src/Microsoft.Teams.BotApps/Context.cs new file mode 100644 index 00000000..cf4d96e9 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Context.cs @@ -0,0 +1,67 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core; +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Teams.BotApps; + +// TODO: Make Context Generic over the TeamsActivity type. +// It should be able to work with any type of TeamsActivity. + + +/// +/// Context for a bot turn. +/// +/// +/// +public class Context(TeamsBotApplication botApplication, TeamsActivity activity) +{ + /// + /// Base bot application. + /// + public TeamsBotApplication TeamsBotApplication { get; } = botApplication; + + /// + /// Current activity. + /// + public TeamsActivity Activity { get; } = activity; + + /// + /// Sends a message activity as a reply. + /// + /// + /// + /// + public Task SendActivityAsync(string text, CancellationToken cancellationToken = default) + => TeamsBotApplication.SendActivityAsync( + new TeamsActivityBuilder() + .WithConversationReference(Activity) + .WithText(text) + .Build(), cancellationToken); + + /// + /// Sends Activity + /// + /// + /// + /// + public Task SendActivityAsync(TeamsActivity activity, CancellationToken cancellationToken = default) + => TeamsBotApplication.SendActivityAsync( + new TeamsActivityBuilder(activity) + .WithConversationReference(Activity) + .Build(), cancellationToken); + + + /// + /// Sends a typing activity to the conversation asynchronously. + /// + /// + /// + public Task SendTypingActivityAsync(CancellationToken cancellationToken = default) + => TeamsBotApplication.SendActivityAsync( + TeamsActivity.CreateBuilder() + .WithType(TeamsActivityType.Typing) + .WithConversationReference(Activity) + .Build(), cancellationToken); +} diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/ConversationUpdateHandler.cs b/core/src/Microsoft.Teams.BotApps/Handlers/ConversationUpdateHandler.cs new file mode 100644 index 00000000..bc3b2062 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Handlers/ConversationUpdateHandler.cs @@ -0,0 +1,50 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Teams.BotApps.Handlers; + +/// +/// Delegate for handling conversation update activities. +/// +/// +/// +/// +/// +public delegate Task ConversationUpdateHandler(ConversationUpdateArgs conversationUpdateActivity, Context context, CancellationToken cancellationToken = default); + +/// +/// Conversation update activity arguments. +/// +/// +[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] +public class ConversationUpdateArgs(TeamsActivity act) +{ + /// + /// Activity for the conversation update. + /// + public TeamsActivity Activity { get; set; } = act; + + /// + /// Members added to the conversation. + /// + public IList? MembersAdded { get; set; } = + act.Properties.TryGetValue("membersAdded", out object? value) + && value is JsonElement je + && je.ValueKind == JsonValueKind.Array + ? JsonSerializer.Deserialize>(je.GetRawText()) + : null; + + /// + /// Members removed from the conversation. + /// + public IList? MembersRemoved { get; set; } = + act.Properties.TryGetValue("membersRemoved", out object? value2) + && value2 is JsonElement je2 + && je2.ValueKind == JsonValueKind.Array + ? JsonSerializer.Deserialize>(je2.GetRawText()) + : null; +} diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/InstallationUpdateHandler.cs b/core/src/Microsoft.Teams.BotApps/Handlers/InstallationUpdateHandler.cs new file mode 100644 index 00000000..518fc01d --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Handlers/InstallationUpdateHandler.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Teams.BotApps.Handlers; + +/// +/// Delegate for handling installation update activities. +/// +/// +/// +/// +/// +public delegate Task InstallationUpdateHandler(InstallationUpdateArgs installationUpdateActivity, Context context, CancellationToken cancellationToken = default); + + +/// +/// Installation update activity arguments. +/// +/// +public class InstallationUpdateArgs(TeamsActivity act) +{ + /// + /// Activity for the installation update. + /// + public TeamsActivity Activity { get; set; } = act; + + /// + /// Installation action: "add" or "remove". + /// + public string? Action { get; set; } = act.Properties.TryGetValue("action", out object? value) && value is string s ? s : null; + + /// + /// Gets or sets the identifier of the currently selected channel. + /// + public string? SelectedChannelId { get; set; } = act.ChannelData?.Settings?.SelectedChannel?.Id; + + /// + /// Gets a value indicating whether the current action is an add operation. + /// + public bool IsAdd => Action == "add"; + + /// + /// Gets a value indicating whether the current action is a remove operation. + /// + public bool IsRemove => Action == "remove"; +} diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs b/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs new file mode 100644 index 00000000..0053323b --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs @@ -0,0 +1,20 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; +using Microsoft.Bot.Core; + +namespace Microsoft.Teams.BotApps.Handlers; + +/// +/// Represents a method that handles an invocation request and returns a response asynchronously. +/// +/// The context for the invocation, containing request data and metadata required to process the operation. Cannot be +/// null. +/// A cancellation token that can be used to cancel the operation. The default value is . +/// A task that represents the asynchronous operation. The task result contains the response to the invocation. +public delegate Task InvokeHandler(Context context, CancellationToken cancellationToken = default); + + + diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/MessageHandler.cs b/core/src/Microsoft.Teams.BotApps/Handlers/MessageHandler.cs new file mode 100644 index 00000000..aff92d0e --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Handlers/MessageHandler.cs @@ -0,0 +1,55 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Teams.BotApps.Handlers; + +// TODO: Handlers should just have context instead of args + context. + +/// +/// Delegate for handling message activities. +/// +/// +/// +/// +/// +public delegate Task MessageHandler(MessageArgs messageArgs, Context context, CancellationToken cancellationToken = default); + + +/// +/// Message activity arguments. +/// +/// +public class MessageArgs(TeamsActivity act) +{ + /// + /// Activity for the message. + /// + public TeamsActivity Activity { get; set; } = act; + + /// + /// Gets or sets the text content of the message. + /// + public string? Text { get; set; } = + act.Properties.TryGetValue("text", out object? value) + && value is JsonElement je + && je.ValueKind == JsonValueKind.String + ? je.GetString() + : act.Properties.TryGetValue("text", out object? value2) + ? value2?.ToString() + : null; + + /// + /// Gets or sets the text format of the message (e.g., "plain", "markdown", "xml"). + /// + public string? TextFormat { get; set; } = + act.Properties.TryGetValue("textFormat", out object? value) + && value is JsonElement je + && je.ValueKind == JsonValueKind.String + ? je.GetString() + : act.Properties.TryGetValue("textFormat", out object? value2) + ? value2?.ToString() + : null; +} diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/MessageReactionHandler.cs b/core/src/Microsoft.Teams.BotApps/Handlers/MessageReactionHandler.cs new file mode 100644 index 00000000..4f006c1f --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Handlers/MessageReactionHandler.cs @@ -0,0 +1,62 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Teams.BotApps.Handlers; + +/// +/// Delegate for handling message reaction activities. +/// +/// +/// +/// +/// +public delegate Task MessageReactionHandler(MessageReactionArgs reactionActivity, Context context, CancellationToken cancellationToken = default); + + +/// +/// Message reaction activity arguments. +/// +/// +[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] +public class MessageReactionArgs(TeamsActivity act) +{ + /// + /// Activity for the message reaction. + /// + public TeamsActivity Activity { get; set; } = act; + + /// + /// Reactions added to the message. + /// + public IList? ReactionsAdded { get; set; } = + act.Properties.TryGetValue("reactionsAdded", out object? value) + && value is JsonElement je + && je.ValueKind == JsonValueKind.Array + ? JsonSerializer.Deserialize>(je.GetRawText()) + : null; + + /// + /// Reactions removed from the message. + /// + public IList? ReactionsRemoved { get; set; } = + act.Properties.TryGetValue("reactionsRemoved", out object? value2) + && value2 is JsonElement je2 + && je2.ValueKind == JsonValueKind.Array + ? JsonSerializer.Deserialize>(je2.GetRawText()) + : null; +} + +/// +/// Message reaction schema. +/// +public class MessageReaction +{ + /// + /// Type of the reaction (e.g., "like", "heart"). + /// + [JsonPropertyName("type")] public string? Type { get; set; } +} diff --git a/core/src/Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj b/core/src/Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj new file mode 100644 index 00000000..d9983477 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj @@ -0,0 +1,13 @@ + + + + net8.0;net10.0 + enable + enable + + + + + + + diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/ClientInfoEntity.cs b/core/src/Microsoft.Teams.BotApps/Schema/Entities/ClientInfoEntity.cs new file mode 100644 index 00000000..a6972734 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/Entities/ClientInfoEntity.cs @@ -0,0 +1,111 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.BotApps.Schema.Entities; + + +/// +/// Extension methods for Activity to handle client info. +/// +public static class ActivityClientInfoExtensions +{ + /// + /// Adds a client info to the activity. + /// + /// + /// + /// + /// + /// + /// + public static ClientInfoEntity AddClientInfo(this TeamsActivity activity, string platform, string country, string timeZone, string locale) + { + ArgumentNullException.ThrowIfNull(activity); + + ClientInfoEntity clientInfo = new(platform, country, timeZone, locale); + activity.Entities ??= []; + activity.Entities.Add(clientInfo); + activity.Rebase(); + return clientInfo; + } + + /// + /// Gets the client info from the activity's entities. + /// + /// + /// + public static ClientInfoEntity? GetClientInfo(this TeamsActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + if (activity.Entities == null) + { + return null; + } + ClientInfoEntity? clientInfo = activity.Entities.FirstOrDefault(e => e is ClientInfoEntity) as ClientInfoEntity; + + return clientInfo; + } +} + +/// +/// Client info entity. +/// +public class ClientInfoEntity : Entity +{ + /// + /// Creates a new instance of . + /// + public ClientInfoEntity() : base("clientInfo") + { + ToProperties(); + } + + + /// + /// Initializes a new instance of the class with specified parameters. + /// + /// + /// + /// + /// + public ClientInfoEntity(string platform, string country, string timezone, string locale) : base("clientInfo") + { + Locale = locale; + Country = country; + Platform = platform; + Timezone = timezone; + ToProperties(); + } + /// + /// Gets or sets the locale information. + /// + [JsonPropertyName("locale")] public string? Locale { get; set; } + + /// + /// Gets or sets the country information. + /// + [JsonPropertyName("country")] public string? Country { get; set; } + + /// + /// Gets or sets the platform information. + /// + [JsonPropertyName("platform")] public string? Platform { get; set; } + + /// + /// Gets or sets the timezone information. + /// + [JsonPropertyName("timezone")] public string? Timezone { get; set; } + + /// + /// Adds custom fields as properties. + /// + public override void ToProperties() + { + base.Properties.Add("locale", Locale); + base.Properties.Add("country", Country); + base.Properties.Add("platform", Platform); + base.Properties.Add("timezone", Timezone); + } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/Entity.cs b/core/src/Microsoft.Teams.BotApps/Schema/Entities/Entity.cs new file mode 100644 index 00000000..9c824115 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/Entities/Entity.cs @@ -0,0 +1,151 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Nodes; +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Teams.BotApps.Schema.Entities; + + +/// +/// List of Entity objects. +/// +[JsonConverter(typeof(EntityListJsonConverter))] +public class EntityList : List +{ + /// + /// Converts the Entities collection to a JsonArray. + /// + /// + public JsonArray? ToJsonArray() + { + JsonArray jsonArray = []; + foreach (Entity entity in this) + { + JsonObject jsonObject = new() + { + ["type"] = entity.Type + }; + foreach (KeyValuePair property in entity.Properties) + { + jsonObject[property.Key] = property.Value as JsonNode ?? JsonValue.Create(property.Value); + } + jsonArray.Add(jsonObject); + } + return jsonArray; + } + + /// + /// Parses a JsonArray into an Entities collection. + /// + /// + /// + /// + public static EntityList FromJsonArray(JsonArray? jsonArray, JsonSerializerOptions? options = null) + { + if (jsonArray == null) + { + return []; + } + EntityList entities = []; + foreach (JsonNode? item in jsonArray) + { + if (item is JsonObject jsonObject + && jsonObject.TryGetPropertyValue("type", out JsonNode? typeNode) + && typeNode is JsonValue typeValue + && typeValue.GetValue() is string typeString) + { + + // TODO: Investigate if there is any way for Parent to avoid + // Knowing the children. + // Maybe a registry pattern, or Converters? + Entity? entity = typeString switch + { + "clientInfo" => item.Deserialize(options), + "mention" => item.Deserialize(options), + //"message" or "https://schema.org/Message" => (Entity?)item.Deserialize(options), + "ProductInfo" => item.Deserialize(options), + "streaminfo" => item.Deserialize(options), + _ => null + }; + if (entity != null) + entities.Add(entity); + } + } + return entities; + } +} + +/// +/// Entity base class. +/// +/// +/// Initializes a new instance of the Entity class with the specified type. +/// +/// The type of the entity. Cannot be null. +public class Entity(string type) +{ + /// + /// Gets or sets the type identifier for the object represented by this instance. + /// + [JsonPropertyName("type")] + public string Type { get; set; } = type; + + /// + /// Gets or sets the OData type identifier for the object represented by this instance. + /// + [JsonPropertyName("@type")] public string? OType { get; set; } + + /// + /// Gets or sets the OData context for the object represented by this instance. + /// + [JsonPropertyName("@context")] public string? OContext { get; set; } + /// + /// Extended properties dictionary. + /// +#pragma warning disable CA2227 // Collection properties should be read only + [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; +#pragma warning restore CA2227 // Collection properties should be read only + + /// + /// Adds properties to the Properties dictionary. + /// + public virtual void ToProperties() + { + throw new NotImplementedException(); + } + +} + +/// +/// JSON converter for EntityList. +/// +public class EntityListJsonConverter : JsonConverter +{ + /// + /// Reads and converts the JSON to EntityList. + /// + public override EntityList? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + return null; + } + + JsonArray? jsonArray = JsonSerializer.Deserialize(ref reader, options); + return EntityList.FromJsonArray(jsonArray, options); + } + + /// + /// Writes the EntityList as JSON. + /// + public override void Write(Utf8JsonWriter writer, EntityList value, JsonSerializerOptions options) + { + ArgumentNullException.ThrowIfNull(value); + JsonArray? jsonArray = value.ToJsonArray(); + JsonSerializer.Serialize(writer, jsonArray, options); + } +} + diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/MentionEntity.cs b/core/src/Microsoft.Teams.BotApps/Schema/Entities/MentionEntity.cs new file mode 100644 index 00000000..458a591a --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/Entities/MentionEntity.cs @@ -0,0 +1,118 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Nodes; +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Teams.BotApps.Schema.Entities; + +/// +/// Extension methods for Activity to handle mentions. +/// +public static class ActivityMentionExtensions +{ + /// + /// Gets the MentionEntity from the activity's entities. + /// + /// The activity to extract the mention from. + /// The MentionEntity if found; otherwise, null. + public static IEnumerable GetMentions(this TeamsActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + if (activity.Entities == null) + { + return []; + } + return activity.Entities.Where(e => e is MentionEntity).Cast(); + } + + /// + /// Adds a mention to the activity. + /// + /// + /// + /// + /// + /// + public static MentionEntity AddMention(this TeamsActivity activity, ConversationAccount account, string? text = null, bool addText = true) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentNullException.ThrowIfNull(account); + string? mentionText = text ?? account.Name; + if (addText) + { + string? currentText = activity.Properties.TryGetValue("text", out object? value) ? value?.ToString() : null; + activity.Properties["text"] = $"{mentionText} {currentText}"; + } + activity.Entities ??= []; + MentionEntity mentionEntity = new(account, $"{mentionText}"); + activity.Entities.Add(mentionEntity); + activity.Rebase(); + return mentionEntity; + } +} + +/// +/// Mention entity. +/// +public class MentionEntity : Entity +{ + /// + /// Creates a new instance of . + /// + public MentionEntity() : base("mention") { } + + /// + /// Creates a new instance of with the specified mentioned account and text. + /// + /// + /// + public MentionEntity(ConversationAccount mentioned, string? text) : base("mention") + { + Mentioned = mentioned; + Text = text; + ToProperties(); + } + + /// + /// Mentioned conversation account. + /// + [JsonPropertyName("mentioned")] public ConversationAccount? Mentioned { get; set; } + + /// + /// Text of the mention. + /// + [JsonPropertyName("text")] public string? Text { get; set; } + + /// + /// Creates a new instance of the MentionEntity class from the specified JSON node. + /// + /// A JsonNode containing the data to deserialize. Must include a 'mentioned' property representing a + /// ConversationAccount. + /// A MentionEntity object populated with values from the provided JSON node. + /// Thrown if jsonNode is null or does not contain the required 'mentioned' property. + public static MentionEntity FromJsonElement(JsonNode? jsonNode) + { + MentionEntity res = new() + { + // TODO: Verify if throwing exceptions is okay here + Mentioned = jsonNode?["mentioned"] != null + ? JsonSerializer.Deserialize(jsonNode["mentioned"]!.ToJsonString())! + : throw new ArgumentNullException(nameof(jsonNode), "mentioned property is required"), + Text = jsonNode?["text"]?.GetValue() + }; + res.ToProperties(); + return res; + } + + /// + /// Adds custom fields as properties. + /// + public override void ToProperties() + { + base.Properties.Add("mentioned", Mentioned); + base.Properties.Add("text", Text); + } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/OMessageEntity.cs b/core/src/Microsoft.Teams.BotApps/Schema/Entities/OMessageEntity.cs new file mode 100644 index 00000000..c595c47e --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/Entities/OMessageEntity.cs @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.BotApps.Schema.Entities +{ + /// + /// OMessage entity. + /// + [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] + public class OMessageEntity : Entity + { + + /// + /// Creates a new instance of . + /// + public OMessageEntity() : base("https://schema.org/Message") + { + OType = "Message"; + OContext = "https://schema.org"; + } + /// + /// Gets or sets the additional type. + /// + [JsonPropertyName("additionalType")] public IList? AdditionalType { get; set; } + } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs b/core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs new file mode 100644 index 00000000..8c1ddfcf --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; +using static System.Net.Mime.MediaTypeNames; + +namespace Microsoft.Teams.BotApps.Schema.Entities; + + + + +/// +/// Product info entity. +/// +public class ProductInfoEntity : Entity +{ + /// + /// Creates a new instance of . + /// + public ProductInfoEntity() : base("ProductInfo") { } + /// + /// Ids the product id. + /// + [JsonPropertyName("id")] public string? Id { get; set; } + + /// + /// Adds custom fields as properties. + /// + public override void ToProperties() + { + + } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/SensitiveUsageEntity.cs b/core/src/Microsoft.Teams.BotApps/Schema/Entities/SensitiveUsageEntity.cs new file mode 100644 index 00000000..d4dd7a75 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/Entities/SensitiveUsageEntity.cs @@ -0,0 +1,59 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.BotApps.Schema.Entities; + +/// +/// Represents an entity that describes the usage of sensitive content, including its name, description, and associated +/// pattern. +/// +public class SensitiveUsageEntity : OMessageEntity +{ + /// + /// Creates a new instance of . + /// + public SensitiveUsageEntity() : base() => OType = "CreativeWork"; + + /// + /// Gets or sets the name of the sensitive usage. + /// + [JsonPropertyName("name")] public required string Name { get; set; } + + /// + /// Gets or sets the description of the sensitive usage. + /// + [JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// Gets or sets the pattern associated with the sensitive usage. + /// + [JsonPropertyName("pattern")] public DefinedTerm? Pattern { get; set; } +} + +/// +/// Defined term. +/// +public class DefinedTerm +{ + /// + /// Type of the defined term. + /// + [JsonPropertyName("@type")] public string Type { get; set; } = "DefinedTerm"; + + /// + /// OData type of the defined term. + /// + [JsonPropertyName("inDefinedTermSet")] public required string InDefinedTermSet { get; set; } + + /// + /// Gets or sets the name associated with the object. + /// + [JsonPropertyName("name")] public required string Name { get; set; } + + /// + /// Gets or sets the code that identifies the academic term. + /// + [JsonPropertyName("termCode")] public required string TermCode { get; set; } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/StreamInfoEntity.cs b/core/src/Microsoft.Teams.BotApps/Schema/Entities/StreamInfoEntity.cs new file mode 100644 index 00000000..86a68d32 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/Entities/StreamInfoEntity.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.BotApps.Schema.Entities; + +/// +/// Stream info entity. +/// +public class StreamInfoEntity : Entity +{ + /// + /// Creates a new instance of . + /// + public StreamInfoEntity() : base("streaminfo") { } + + /// + /// Gets or sets the stream id. + /// + [JsonPropertyName("streamId")] public string? StreamId { get; set; } + + /// + /// Gets or sets the stream type. See for possible values. + /// + [JsonPropertyName("streamType")] public string? StreamType { get; set; } + + /// + /// Gets or sets the stream sequence. + /// + [JsonPropertyName("streamSequence")] public int? StreamSequence { get; set; } +} + +/// +/// Represents the types of streams. +/// +public static class StreamType +{ + /// + /// Informative stream type. + /// + public const string Informative = "informative"; + /// + /// Streaming stream type. + /// + public const string Streaming = "streaming"; + /// + /// Represents the string literal "final". + /// + public const string Final = "final"; +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Team.cs b/core/src/Microsoft.Teams.BotApps/Schema/Team.cs new file mode 100644 index 00000000..9c2ac521 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/Team.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.BotApps.Schema +{ + /// + /// Represents a team, including its identity, group association, and membership details. + /// + public class Team + { + /// + /// Represents the unique identifier of the team. + /// + [JsonPropertyName("id")] public string? Id { get; set; } + + /// + /// Azure Active Directory (AAD) Group ID associated with the team. + /// + [JsonPropertyName("aadGroupId")] public string? AadGroupId { get; set; } + + /// + /// Gets or sets the unique identifier of the tenant associated with this entity. + /// + [JsonPropertyName("tenantId")] public string? TenantId { get; set; } + + /// + /// Gets or sets the type identifier for the object represented by this instance. + /// + [JsonPropertyName("type")] public string? Type { get; set; } + + /// + /// Gets or sets the name associated with the object. + /// + [JsonPropertyName("name")] public string? Name { get; set; } + + /// + /// Number of channels in the team. + /// + [JsonPropertyName("channelCount")] public int? ChannelCount { get; set; } + + /// + /// Number of members in the team. + /// + [JsonPropertyName("memberCount")] public int? MemberCount { get; set; } + } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs new file mode 100644 index 00000000..ca74aa59 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs @@ -0,0 +1,142 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Schema.Entities; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Teams Activity schema. +/// +[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] +public class TeamsActivity : CoreActivity +{ + /// + /// Creates a new instance of the TeamsActivity class from the specified Activity object. + /// + /// The Activity instance to convert. Cannot be null. + /// A TeamsActivity object that represents the specified Activity. + public static TeamsActivity FromActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + return new(activity); + } + + /// + /// Creates a new instance of the TeamsActivity class from the specified Activity object. + /// + /// + /// + public static new TeamsActivity FromJsonString(string json) + => FromJsonString(json, TeamsActivityJsonContext.Default.TeamsActivity); + + /// + /// Overrides the ToJson method to serialize the TeamsActivity object to a JSON string. + /// + /// + public new string ToJson() + => ToJson(TeamsActivityJsonContext.Default.TeamsActivity); + + /// + /// Default constructor. + /// + [JsonConstructor] + public TeamsActivity() + { + From = new TeamsConversationAccount(); + Recipient = new TeamsConversationAccount(); + Conversation = new TeamsConversation(); + } + + private TeamsActivity(CoreActivity activity) : base(activity) + { + // Convert base types to Teams-specific types + if (activity.ChannelData is not null) + { + ChannelData = new TeamsChannelData(activity.ChannelData); + } + From = new TeamsConversationAccount(activity.From); + Recipient = new TeamsConversationAccount(activity.Recipient); + Conversation = new TeamsConversation(activity.Conversation); + Attachments = TeamsAttachment.FromJArray(activity.Attachments); + Entities = EntityList.FromJsonArray(activity.Entities); + + Rebase(); + } + + /// + /// Resets shadow properties in base class + /// + /// + internal TeamsActivity Rebase() + { + base.Attachments = this.Attachments?.ToJsonArray(); + base.Entities = this.Entities?.ToJsonArray(); + base.ChannelData = this.ChannelData; + base.From = this.From; + base.Recipient = this.Recipient; + base.Conversation = this.Conversation; + + return this; + } + + /// + /// Gets or sets the account information for the sender of the Teams conversation. + /// + [JsonPropertyName("from")] public new TeamsConversationAccount From { get; set; } + + /// + /// Gets or sets the account information for the recipient of the Teams conversation. + /// + [JsonPropertyName("recipient")] public new TeamsConversationAccount Recipient { get; set; } + + /// + /// Gets or sets the conversation information for the Teams conversation. + /// + [JsonPropertyName("conversation")] public new TeamsConversation Conversation { get; set; } + + /// + /// Gets or sets the Teams-specific channel data associated with this activity. + /// + [JsonPropertyName("channelData")] public new TeamsChannelData? ChannelData { get; set; } + + /// + /// Gets or sets the entities specific to Teams. + /// + [JsonPropertyName("entities")] public new EntityList? Entities { get; set; } + + /// + /// Attachments specific to Teams. + /// + [JsonPropertyName("attachments")] public new IList? Attachments { get; set; } + + /// + /// Adds an entity to the activity's Entities collection. + /// + /// + /// + public TeamsActivity AddEntity(Entity entity) + { + // TODO: Pick up nuances about entities. + // For eg, there can only be 1 single MessageEntity + Entities ??= []; + Entities.Add(entity); + return this; + } + + /// + /// Creates a new TeamsActivityBuilder instance for building a TeamsActivity with a fluent API. + /// + /// A new TeamsActivityBuilder instance. + public static new TeamsActivityBuilder CreateBuilder() => new(); + + /// + /// Creates a new TeamsActivityBuilder instance initialized with the specified TeamsActivity. + /// + /// + /// + public static TeamsActivityBuilder CreateBuilder(TeamsActivity activity) => new(activity); + +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityBuilder.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityBuilder.cs new file mode 100644 index 00000000..d33b5762 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityBuilder.cs @@ -0,0 +1,217 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Schema.Entities; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Provides a fluent API for building TeamsActivity instances. +/// +public class TeamsActivityBuilder : CoreActivityBuilder +{ + /// + /// Initializes a new instance of the TeamsActivityBuilder class. + /// + internal TeamsActivityBuilder() : base(TeamsActivity.FromActivity(new CoreActivity())) + { + } + + /// + /// Initializes a new instance of the TeamsActivityBuilder class with an existing activity. + /// + /// The activity to build upon. + internal TeamsActivityBuilder(TeamsActivity activity) : base(activity) + { + } + + /// + /// Sets the conversation (override for Teams-specific type). + /// + protected override void SetConversation(Conversation conversation) + { + _activity.Conversation = conversation is TeamsConversation teamsConv + ? teamsConv + : new TeamsConversation(conversation); + } + + /// + /// Sets the From account (override for Teams-specific type). + /// + protected override void SetFrom(ConversationAccount from) + { + _activity.From = from is TeamsConversationAccount teamsAccount + ? teamsAccount + : new TeamsConversationAccount(from); + } + + /// + /// Sets the Recipient account (override for Teams-specific type). + /// + protected override void SetRecipient(ConversationAccount recipient) + { + _activity.Recipient = recipient is TeamsConversationAccount teamsAccount + ? teamsAccount + : new TeamsConversationAccount(recipient); + } + + /// + /// Sets the Teams-specific channel data. + /// + /// The channel data. + /// The builder instance for chaining. + public TeamsActivityBuilder WithChannelData(TeamsChannelData? channelData) + { + _activity.ChannelData = channelData; + return this; + } + + /// + /// Sets the entities collection. + /// + /// The entities collection. + /// The builder instance for chaining. + public TeamsActivityBuilder WithEntities(EntityList entities) + { + _activity.Entities = entities; + return this; + } + + /// + /// Sets the attachments collection. + /// + /// The attachments collection. + /// The builder instance for chaining. + public TeamsActivityBuilder WithAttachments(IList attachments) + { + _activity.Attachments = attachments; + return this; + } + + // TODO: Builders should only have "With" methods, not "Add" methods. + /// + /// Replaces the attachments collection with a single attachment. + /// + /// The attachment to set. Passing null clears the attachments. + /// The builder instance for chaining. + public TeamsActivityBuilder WithAttachment(TeamsAttachment? attachment) + { + _activity.Attachments = attachment is null + ? null + : [attachment]; + + return this; + } + + /// + /// Adds an entity to the activity's Entities collection. + /// + /// The entity to add. + /// The builder instance for chaining. + public TeamsActivityBuilder AddEntity(Entity entity) + { + _activity.Entities ??= []; + _activity.Entities.Add(entity); + return this; + } + + /// + /// Adds an attachment to the activity's Attachments collection. + /// + /// The attachment to add. + /// The builder instance for chaining. + public TeamsActivityBuilder AddAttachment(TeamsAttachment attachment) + { + _activity.Attachments ??= []; + _activity.Attachments.Add(attachment); + return this; + } + + /// + /// Adds an Adaptive Card attachment to the activity. + /// + /// The Adaptive Card payload. + /// Optional callback to further configure the attachment before it is added. + /// The builder instance for chaining. + public TeamsActivityBuilder AddAdaptiveCardAttachment(object adaptiveCard, Action? configure = null) + { + TeamsAttachment attachment = BuildAdaptiveCardAttachment(adaptiveCard, configure); + return AddAttachment(attachment); + } + + /// + /// Sets the activity attachments collection to a single Adaptive Card attachment. + /// + /// The Adaptive Card payload. + /// Optional callback to further configure the attachment. + /// The builder instance for chaining. + public TeamsActivityBuilder WithAdaptiveCardAttachment(object adaptiveCard, Action? configure = null) + { + TeamsAttachment attachment = BuildAdaptiveCardAttachment(adaptiveCard, configure); + return WithAttachment(attachment); + } + + /// + /// Adds or sets the text content of the activity. + /// + /// + /// + /// + public TeamsActivityBuilder WithText(string text, string textFormat = "plain") + { + WithProperty("text", text); + WithProperty("textFormat", textFormat); + return this; + } + + /// + /// Adds a mention to the activity. + /// + /// The account to mention. + /// Optional custom text for the mention. If null, uses the account name. + /// Whether to prepend the mention text to the activity's text content. + /// The builder instance for chaining. + public TeamsActivityBuilder AddMention(ConversationAccount account, string? text = null, bool addText = true) + { + ArgumentNullException.ThrowIfNull(account); + string? mentionText = text ?? account.Name; + + if (addText) + { + string? currentText = _activity.Properties.TryGetValue("text", out object? value) ? value?.ToString() : null; + WithProperty("text", $"{mentionText} {currentText}"); + } + + _activity.Entities ??= []; + _activity.Entities.Add(new MentionEntity(account, $"{mentionText}")); + + CoreActivity baseActivity = _activity; + baseActivity.Entities = _activity.Entities.ToJsonArray(); + + return this; + } + + /// + /// Builds and returns the configured TeamsActivity instance. + /// + /// The configured TeamsActivity. + public override TeamsActivity Build() + { + _activity.Rebase(); + return _activity; + } + + private static TeamsAttachment BuildAdaptiveCardAttachment(object adaptiveCard, Action? configure) + { + ArgumentNullException.ThrowIfNull(adaptiveCard); + + TeamsAttachmentBuilder attachmentBuilder = TeamsAttachment + .CreateBuilder() + .WithAdaptiveCard(adaptiveCard); + + configure?.Invoke(attachmentBuilder); + + return attachmentBuilder.Build(); + } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityJsonContext.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityJsonContext.cs new file mode 100644 index 00000000..f56a6e4e --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityJsonContext.cs @@ -0,0 +1,36 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Schema.Entities; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Json source generator context for Teams activity types. +/// +[JsonSourceGenerationOptions( + WriteIndented = true, + IncludeFields = true, + DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, + PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)] +[JsonSerializable(typeof(CoreActivity))] +[JsonSerializable(typeof(TeamsActivity))] +[JsonSerializable(typeof(Entity))] +[JsonSerializable(typeof(EntityList))] +[JsonSerializable(typeof(MentionEntity))] +[JsonSerializable(typeof(ClientInfoEntity))] +[JsonSerializable(typeof(TeamsChannelData))] +[JsonSerializable(typeof(ConversationAccount))] +[JsonSerializable(typeof(TeamsConversationAccount))] +[JsonSerializable(typeof(TeamsConversation))] +[JsonSerializable(typeof(ExtendedPropertiesDictionary))] +[JsonSerializable(typeof(System.Text.Json.JsonElement))] +[JsonSerializable(typeof(System.Int32))] +[JsonSerializable(typeof(System.Boolean))] +[JsonSerializable(typeof(System.Int64))] +[JsonSerializable(typeof(System.Double))] +public partial class TeamsActivityJsonContext : JsonSerializerContext +{ +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs new file mode 100644 index 00000000..2536d9e3 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs @@ -0,0 +1,44 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Provides constant values for activity types used in Microsoft Teams bot interactions. +/// +/// These activity type constants are used to identify the type of activity received or sent in a Teams +/// bot context. Use these values when handling or generating activities to ensure compatibility with the Teams +/// platform. +public static class TeamsActivityType +{ + + /// + /// Represents the default message string used for communication or display purposes. + /// + public const string Message = ActivityType.Message; + /// + /// Represents a typing indicator activity. + /// + public const string Typing = ActivityType.Typing; + + /// + /// Represents an invoke activity. + /// + public const string Invoke = ActivityType.Invoke; + + /// + /// Conversation update activity type. + /// + public static readonly string ConversationUpdate = "conversationUpdate"; + /// + /// Installation update activity type. + /// + public static readonly string InstallationUpdate = "installationUpdate"; + /// + /// Message reaction activity type. + /// + public static readonly string MessageReaction = "messageReaction"; + +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs new file mode 100644 index 00000000..fec9ceec --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs @@ -0,0 +1,90 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Nodes; +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Teams.BotApps.Schema; + + +/// +/// Extension methods for TeamsAttachment. +/// +public static class TeamsAttachmentExtensions +{ + static internal JsonArray ToJsonArray(this IList attachments) + { + JsonArray jsonArray = []; + foreach (TeamsAttachment attachment in attachments) + { + JsonNode jsonNode = JsonSerializer.SerializeToNode(attachment)!; + jsonArray.Add(jsonNode); + } + return jsonArray; + } +} + +/// +/// Teams attachment model. +/// +public class TeamsAttachment +{ + static internal IList FromJArray(JsonArray? jsonArray) + { + if (jsonArray is null) + { + return []; + } + List attachments = []; + foreach (JsonNode? item in jsonArray) + { + attachments.Add(JsonSerializer.Deserialize(item)!); + } + return attachments; + } + + /// + /// Content of the attachment. + /// + [JsonPropertyName("contentType")] public string ContentType { get; set; } = string.Empty; + + /// + /// Content URL of the attachment. + /// + [JsonPropertyName("contentUrl")] public Uri? ContentUrl { get; set; } + + /// + /// Content for the Attachment + /// + [JsonPropertyName("content")] public object? Content { get; set; } + + /// + /// Gets or sets the name of the attachment. + /// + [JsonPropertyName("name")] public string? Name { get; set; } + + /// + /// Gets or sets the thumbnail URL of the attachment. + /// + [JsonPropertyName("thumbnailUrl")] public Uri? ThumbnailUrl { get; set; } + + /// + /// Extension data for additional properties not explicitly defined by the type. + /// +#pragma warning disable CA2227 // Collection properties should be read only + [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; +#pragma warning restore CA2227 // Collection properties should be read only + + /// + /// Creates a builder for constructing a instance. + /// + public static TeamsAttachmentBuilder CreateBuilder() => new(); + + /// + /// Creates a builder initialized with an existing instance. + /// + /// The attachment to wrap. + public static TeamsAttachmentBuilder CreateBuilder(TeamsAttachment attachment) => new(attachment); +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachmentBuilder.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachmentBuilder.cs new file mode 100644 index 00000000..e0f344eb --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachmentBuilder.cs @@ -0,0 +1,113 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Provides a fluent API for creating instances. +/// +public class TeamsAttachmentBuilder +{ + private const string AdaptiveCardContentType = "application/vnd.microsoft.card.adaptive"; + + private readonly TeamsAttachment _attachment; + + internal TeamsAttachmentBuilder() : this(new TeamsAttachment()) + { + } + + internal TeamsAttachmentBuilder(TeamsAttachment attachment) + { + _attachment = attachment ?? throw new ArgumentNullException(nameof(attachment)); + } + + /// + /// Sets the content type for the attachment. + /// + public TeamsAttachmentBuilder WithContentType(string contentType) + { + if (string.IsNullOrWhiteSpace(contentType)) + { + throw new ArgumentException("Content type cannot be null or whitespace.", nameof(contentType)); + } + + _attachment.ContentType = contentType; + return this; + } + + /// + /// Sets the payload for the attachment. + /// + public TeamsAttachmentBuilder WithContent(object? content) + { + _attachment.Content = content; + return this; + } + + /// + /// Sets the content url for the attachment. + /// + public TeamsAttachmentBuilder WithContentUrl(Uri? contentUrl) + { + _attachment.ContentUrl = contentUrl; + return this; + } + + /// + /// Sets the friendly name for the attachment. + /// + public TeamsAttachmentBuilder WithName(string? name) + { + _attachment.Name = name; + return this; + } + + /// + /// Sets the thumbnail url for the attachment. + /// + public TeamsAttachmentBuilder WithThumbnailUrl(Uri? thumbnailUrl) + { + _attachment.ThumbnailUrl = thumbnailUrl; + return this; + } + + /// + /// Adds or updates an extension property on the attachment. + /// Passing a null value removes the property. + /// + public TeamsAttachmentBuilder WithProperty(string propertyName, object? value) + { + if (string.IsNullOrWhiteSpace(propertyName)) + { + throw new ArgumentException("Property name cannot be null or whitespace.", nameof(propertyName)); + } + + if (value is null) + { + _attachment.Properties.Remove(propertyName); + } + else + { + _attachment.Properties[propertyName] = value; + } + + return this; + } + + /// + /// Configures the attachment to contain an Adaptive Card payload. + /// + public TeamsAttachmentBuilder WithAdaptiveCard(object adaptiveCard) + { + ArgumentNullException.ThrowIfNull(adaptiveCard); + _attachment.ContentType = AdaptiveCardContentType; + _attachment.Content = adaptiveCard; + _attachment.ContentUrl = null; + return this; + } + + /// + /// Builds the attachment. + /// + public TeamsAttachment Build() => _attachment; +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannel.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannel.cs new file mode 100644 index 00000000..60d5f695 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannel.cs @@ -0,0 +1,35 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Represents a Microsoft Teams channel, including its identifier, type, and display name. +/// +/// This class is typically used to serialize or deserialize channel information when interacting with +/// Microsoft Teams APIs or webhooks. All properties are optional and may be null if the corresponding data is not +/// available. +public class TeamsChannel +{ + /// + /// Represents the unique identifier of the channel. + /// + [JsonPropertyName("id")] public string? Id { get; set; } + + /// + /// Azure Active Directory (AAD) Object ID associated with the channel. + /// + [JsonPropertyName("aadObjectId")] public string? AadObjectId { get; set; } + + /// + /// Type identifier for the channel. + /// + [JsonPropertyName("type")] public string? Type { get; set; } + + /// + /// Gets or sets the name associated with the object. + /// + [JsonPropertyName("name")] public string? Name { get; set; } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs new file mode 100644 index 00000000..d80d9402 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs @@ -0,0 +1,78 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Represents Teams-specific channel data. +/// +public class TeamsChannelData : ChannelData +{ + /// + /// Creates a new instance of the class. + /// + public TeamsChannelData() + { + } + + /// + /// Creates a new instance of the class from the specified object. + /// + /// + public TeamsChannelData(ChannelData? cd) + { + if (cd is not null) + { + if (cd.Properties.TryGetValue("teamsChannelId", out object? channelIdObj) && channelIdObj is JsonElement jeChannelId && jeChannelId.ValueKind == JsonValueKind.String) + { + TeamsChannelId = jeChannelId.GetString(); + } + + if (cd.Properties.TryGetValue("channel", out object? channelObj) && channelObj is JsonElement channelObjJE && channelObjJE.ValueKind == JsonValueKind.Object) + { + Channel = JsonSerializer.Deserialize(channelObjJE.GetRawText()); + } + + if (cd.Properties.TryGetValue("tenant", out object? tenantObj) && tenantObj is JsonElement je && je.ValueKind == JsonValueKind.Object) + { + Tenant = JsonSerializer.Deserialize(je.GetRawText()); + } + } + } + + + /// + /// Settings for the Teams channel. + /// + [JsonPropertyName("settings")] public TeamsChannelDataSettings? Settings { get; set; } + + /// + /// Gets or sets the unique identifier of the Microsoft Teams channel associated with this entity. + /// + [JsonPropertyName("teamsChannelId")] public string? TeamsChannelId { get; set; } + + /// + /// Teams Team Id. + /// + [JsonPropertyName("teamsTeamId")] public string? TeamsTeamId { get; set; } + + /// + /// Gets or sets the channel information associated with this entity. + /// + [JsonPropertyName("channel")] public TeamsChannel? Channel { get; set; } + + /// + /// Team information. + /// + [JsonPropertyName("team")] public Team? Team { get; set; } + + /// + /// Tenant information. + /// + [JsonPropertyName("tenant")] public TeamsChannelDataTenant? Tenant { get; set; } + +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataSettings.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataSettings.cs new file mode 100644 index 00000000..cf885a8b --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataSettings.cs @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Teams channel data settings. +/// +public class TeamsChannelDataSettings +{ + /// + /// Selected channel information. + /// + [JsonPropertyName("selectedChannel")] public required TeamsChannel SelectedChannel { get; set; } + + /// + /// Gets or sets the collection of additional properties not explicitly defined by the type. + /// + /// This property stores extra JSON fields encountered during deserialization that do not map to + /// known properties. It enables round-tripping of unknown or custom data without loss. The dictionary keys + /// correspond to the property names in the JSON payload. +#pragma warning disable CA2227 // Collection properties should be read only + [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; +#pragma warning restore CA2227 // Collection properties should be read only +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataTenant.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataTenant.cs new file mode 100644 index 00000000..77781977 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataTenant.cs @@ -0,0 +1,17 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Tenant information for Teams channel data. +/// +public class TeamsChannelDataTenant +{ + /// + /// Unique identifier of the tenant. + /// + [JsonPropertyName("id")] public string? Id { get; set; } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversation.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversation.cs new file mode 100644 index 00000000..7410b5b6 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversation.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Defines known conversation types for Teams. +/// +public static class ConversationType +{ + /// + /// One-to-one conversation between a user and a bot. + /// + public const string Personal = "personal"; + + /// + /// Group chat conversation. + /// + public const string GroupChat = "groupChat"; +} + +/// +/// Teams Conversation schema. +/// +public class TeamsConversation : Conversation +{ + /// + /// Initializes a new instance of the TeamsConversation class. + /// + [JsonConstructor] + public TeamsConversation() + { + Id = string.Empty; + } + + /// + /// Creates a new instance of the TeamsConversation class from the specified Conversation object. + /// + /// + public TeamsConversation(Conversation conversation) + { + ArgumentNullException.ThrowIfNull(conversation); + Id = conversation.Id ?? string.Empty; + if (conversation.Properties == null) + { + return; + } + if (conversation.Properties.TryGetValue("tenantId", out object? tenantObj) && tenantObj is JsonElement je && je.ValueKind == JsonValueKind.String) + { + TenantId = je.GetString(); + } + if (conversation.Properties.TryGetValue("conversationType", out object? convTypeObj) && convTypeObj is JsonElement je2 && je2.ValueKind == JsonValueKind.String) + { + ConversationType = je2.GetString(); + } + } + + /// + /// Tenant Id. + /// + [JsonPropertyName("tenantId")] public string? TenantId { get; set; } + + /// + /// Conversation Type. See for known values. + /// + [JsonPropertyName("conversationType")] public string? ConversationType { get; set; } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs new file mode 100644 index 00000000..f007673a --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs @@ -0,0 +1,59 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Teams.BotApps.Schema; + +/// +/// Represents a Microsoft Teams-specific conversation account, including Azure Active Directory (AAD) object +/// information. +/// +/// This class extends the base ConversationAccount to provide additional properties relevant to +/// Microsoft Teams, such as the Azure Active Directory object ID. It is typically used when working with Teams +/// conversations to access Teams-specific metadata. +public class TeamsConversationAccount : ConversationAccount +{ + /// + /// Conversation account. + /// + public ConversationAccount ConversationAccount { get; set; } + + /// + /// Initializes a new instance of the TeamsConversationAccount class. + /// + [JsonConstructor] + public TeamsConversationAccount() + { + ConversationAccount = new ConversationAccount(); + Id = string.Empty; + Name = string.Empty; + } + + /// + /// Initializes a new instance of the TeamsConversationAccount class using the specified conversation account. + /// + /// If the provided ConversationAccount contains an 'aadObjectId' property as a string, it is + /// used to set the AadObjectId property of the TeamsConversationAccount. + /// The ConversationAccount instance containing the conversation's identifier, name, and properties. Cannot be null. + public TeamsConversationAccount(ConversationAccount conversationAccount) + { + ArgumentNullException.ThrowIfNull(conversationAccount); + ConversationAccount = conversationAccount; + Properties = conversationAccount.Properties; + Id = conversationAccount.Id ?? string.Empty; + Name = conversationAccount.Name ?? string.Empty; + if (conversationAccount is not null && conversationAccount.Properties.TryGetValue("aadObjectId", out object? aadObj) + && aadObj is JsonElement je + && je.ValueKind == JsonValueKind.String) + { + AadObjectId = je.GetString(); + } + } + /// + /// Gets or sets the Azure Active Directory (AAD) Object ID associated with the conversation account. + /// + [JsonPropertyName("aadObjectId")] public string? AadObjectId { get; set; } +} diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs new file mode 100644 index 00000000..6f7677d7 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs @@ -0,0 +1,106 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.Logging; +using Microsoft.Teams.BotApps.Handlers; +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Teams.BotApps; + +/// +/// Teams specific Bot Application +/// +[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] +public class TeamsBotApplication : BotApplication +{ + + private static TeamsBotApplicationBuilder? _botApplicationBuilder; + + /// + /// Handler for message activities. + /// + public MessageHandler? OnMessage { get; set; } + + /// + /// Handler for message reaction activities. + /// + public MessageReactionHandler? OnMessageReaction { get; set; } + + /// + /// Handler for installation update activities. + /// + public InstallationUpdateHandler? OnInstallationUpdate { get; set; } + + /// + /// Handler for invoke activities. + /// + public InvokeHandler? OnInvoke { get; set; } + + /// + /// Handler for conversation update activities. + /// + public ConversationUpdateHandler? OnConversationUpdate { get; set; } + /// + /// + /// + /// + public TeamsBotApplication(ConversationClient conversationClient, IConfiguration config, ILogger logger, string sectionName = "AzureAd") : base(conversationClient, config, logger, sectionName) + { + OnActivity = async (activity, cancellationToken) => + { + InvokeResponse? invokeResponse = null; + logger.LogInformation("New {Type} activity received.", activity.Type); + TeamsActivity teamsActivity = TeamsActivity.FromActivity(activity); + Context context = new(this, teamsActivity); + if (teamsActivity.Type == TeamsActivityType.Message && OnMessage is not null) + { + await OnMessage.Invoke(new MessageArgs(teamsActivity), context, cancellationToken).ConfigureAwait(false); + } + if (teamsActivity.Type == TeamsActivityType.InstallationUpdate && OnInstallationUpdate is not null) + { + await OnInstallationUpdate.Invoke(new InstallationUpdateArgs(teamsActivity), context, cancellationToken).ConfigureAwait(false); + + } + if (teamsActivity.Type == TeamsActivityType.MessageReaction && OnMessageReaction is not null) + { + await OnMessageReaction.Invoke(new MessageReactionArgs(teamsActivity), context, cancellationToken).ConfigureAwait(false); + } + if (teamsActivity.Type == TeamsActivityType.ConversationUpdate && OnConversationUpdate is not null) + { + await OnConversationUpdate.Invoke(new ConversationUpdateArgs(teamsActivity), context, cancellationToken).ConfigureAwait(false); + } + if (teamsActivity.Type == TeamsActivityType.Invoke && OnInvoke is not null) + { + invokeResponse = await OnInvoke.Invoke(context, cancellationToken).ConfigureAwait(false); + + } + return invokeResponse; + }; + } + + /// + /// Creates a new instance of the TeamsBotApplicationBuilder to configure and build a Teams bot application. + /// + /// + public static TeamsBotApplicationBuilder CreateBuilder() + { + _botApplicationBuilder = new TeamsBotApplicationBuilder(); + return _botApplicationBuilder; + } + + /// + /// Runs the web application configured by the bot application builder. + /// + /// Call CreateBuilder() before invoking this method to ensure the bot application builder is + /// initialized. This method blocks the calling thread until the web application shuts down. +#pragma warning disable CA1822 // Mark members as static + public void Run() +#pragma warning restore CA1822 // Mark members as static + { + ArgumentNullException.ThrowIfNull(_botApplicationBuilder, "BotApplicationBuilder not initialized. Call CreateBuilder() first."); + + _botApplicationBuilder.WebApplication.Run(); + } +} diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs b/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs new file mode 100644 index 00000000..5941169b --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs @@ -0,0 +1,83 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting; +using Microsoft.AspNetCore.Http; +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; + +namespace Microsoft.Teams.BotApps; + +/// +/// Teams Bot Application Builder to configure and build a Teams bot application. +/// +public class TeamsBotApplicationBuilder +{ + private readonly WebApplicationBuilder _webAppBuilder; + private WebApplication? _webApp; + private string _routePath = "/api/messages"; + internal WebApplication WebApplication => _webApp ?? throw new InvalidOperationException("Call Build"); + /// + /// Accessor for the service collection used to configure application services. + /// + public IServiceCollection Services => _webAppBuilder.Services; + /// + /// Accessor for the application configuration used to configure services and settings. + /// + public IConfiguration Configuration => _webAppBuilder.Configuration; + /// + /// Accessor for the web hosting environment information. + /// + public IWebHostEnvironment Environment => _webAppBuilder.Environment; + /// + /// Accessor for configuring the host settings and services. + /// + public ConfigureHostBuilder Host => _webAppBuilder.Host; + /// + /// Accessor for configuring logging services and settings. + /// + public ILoggingBuilder Logging => _webAppBuilder.Logging; + /// + /// Creates a new instance of the BotApplicationBuilder with default configuration and registered bot services. + /// + public TeamsBotApplicationBuilder() + { + _webAppBuilder = WebApplication.CreateSlimBuilder(); + _webAppBuilder.Services.AddBotApplication(); + } + + /// + /// Builds and configures the bot application pipeline, returning a fully initialized instance of the bot + /// application. + /// + /// A configured instance representing the bot application pipeline. + public TeamsBotApplication Build() + { + _webApp = _webAppBuilder.Build(); + + TeamsBotApplication botApp = _webApp.Services.GetService() ?? throw new InvalidOperationException("Application not registered"); + _webApp.MapPost(_routePath, async (HttpContext httpContext, CancellationToken cancellationToken) => + { + var resp = await botApp.ProcessAsync(httpContext, cancellationToken).ConfigureAwait(false); + return resp; + }); + + return botApp; + } + + /// + /// Sets the route path used to handle incoming bot requests. Defaults to "/api/messages". + /// + /// The route path to use for bot endpoints. Cannot be null or empty. + /// The current instance of for method chaining. + public TeamsBotApplicationBuilder WithRoutePath(string routePath) + { + _routePath = routePath; + return this; + } +} diff --git a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs index ca5d5968..95719f36 100644 --- a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs +++ b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs @@ -12,6 +12,7 @@ public class ConversationClientTest { private readonly ServiceProvider _serviceProvider; private readonly ConversationClient _conversationClient; + private readonly Uri _serviceUrl; public ConversationClientTest() { @@ -22,11 +23,12 @@ public ConversationClientTest() IConfiguration configuration = builder.Build(); ServiceCollection services = new(); + services.AddLogging(); services.AddSingleton(configuration); - services.AddBotApplicationClients(); + services.AddBotApplication(); _serviceProvider = services.BuildServiceProvider(); _conversationClient = _serviceProvider.GetRequiredService(); - + _serviceUrl = new Uri(Environment.GetEnvironmentVariable("TEST_SERVICEURL") ?? "https://smba.trafficmanager.net/teams/"); } [Fact] @@ -34,37 +36,36 @@ public async Task SendActivityDefault() { CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = $"Message from Automated tests, running in SDK `{BotApplication.Version}` at `{DateTime.UtcNow:s}`", - ServiceUrl = new Uri("https://smba.trafficmanager.net/teams/"), + Type = ActivityType.Message, + Properties = { { "text", $"Message from Automated tests, running in SDK `{BotApplication.Version}` at `{DateTime.UtcNow:s}`" } }, + ServiceUrl = _serviceUrl, Conversation = new() { Id = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set") } }; - string res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); + SendActivityResponse res = await _conversationClient.SendActivityAsync(activity, cancellationToken: CancellationToken.None); Assert.NotNull(res); - Assert.Contains("\"id\"", res); + Assert.NotNull(res.Id); } - [Fact] public async Task SendActivityToChannel() { CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = $"Message from Automated tests, running in SDK `{BotApplication.Version}` at `{DateTime.UtcNow:s}`", - ServiceUrl = new Uri("https://smba.trafficmanager.net/teams/"), + Type = ActivityType.Message, + Properties = { { "text", $"Message from Automated tests, running in SDK `{BotApplication.Version}` at `{DateTime.UtcNow:s}`" } }, + ServiceUrl = _serviceUrl, Conversation = new() { - Id = "19:9f2af1bee7cc4a71af25ac72478fd5c6@thread.tacv2" + Id = Environment.GetEnvironmentVariable("TEST_CHANNELID") ?? throw new InvalidOperationException("TEST_CHANNELID environment variable not set") } }; - string res = await _conversationClient.SendActivityAsync(activity, CancellationToken.None); + SendActivityResponse res = await _conversationClient.SendActivityAsync(activity, cancellationToken: CancellationToken.None); Assert.NotNull(res); - Assert.Contains("\"id\"", res); + Assert.NotNull(res.Id); } [Fact] @@ -72,9 +73,9 @@ public async Task SendActivityToPersonalChat_FailsWithBad_ConversationId() { CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = $"Message from Automated tests, running in SDK `{BotApplication.Version}` at `{DateTime.UtcNow:s}`", - ServiceUrl = new Uri("https://smba.trafficmanager.net/teams/"), + Type = ActivityType.Message, + Properties = { { "text", $"Message from Automated tests, running in SDK `{BotApplication.Version}` at `{DateTime.UtcNow:s}`" } }, + ServiceUrl = _serviceUrl, Conversation = new() { Id = "a:1" @@ -84,4 +85,632 @@ public async Task SendActivityToPersonalChat_FailsWithBad_ConversationId() await Assert.ThrowsAsync(() => _conversationClient.SendActivityAsync(activity)); } + + [Fact] + public async Task UpdateActivity() + { + // First send an activity to get an ID + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Original message from Automated tests at `{DateTime.UtcNow:s}`" } }, + ServiceUrl = _serviceUrl, + Conversation = new() + { + Id = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set") + } + }; + + SendActivityResponse sendResponse = await _conversationClient.SendActivityAsync(activity, cancellationToken: CancellationToken.None); + Assert.NotNull(sendResponse); + Assert.NotNull(sendResponse.Id); + + // Now update the activity + CoreActivity updatedActivity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Updated message from Automated tests at `{DateTime.UtcNow:s}`" } }, + ServiceUrl = _serviceUrl, + }; + + UpdateActivityResponse updateResponse = await _conversationClient.UpdateActivityAsync( + activity.Conversation.Id, + sendResponse.Id, + updatedActivity, + cancellationToken: CancellationToken.None); + + Assert.NotNull(updateResponse); + Assert.NotNull(updateResponse.Id); + } + + [Fact] + public async Task DeleteActivity() + { + // First send an activity to get an ID + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Message to delete from Automated tests at `{DateTime.UtcNow:s}`" } }, + ServiceUrl = _serviceUrl, + Conversation = new() + { + Id = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set") + } + }; + + SendActivityResponse sendResponse = await _conversationClient.SendActivityAsync(activity, cancellationToken: CancellationToken.None); + Assert.NotNull(sendResponse); + Assert.NotNull(sendResponse.Id); + + // Add a delay for 5 seconds + await Task.Delay(TimeSpan.FromSeconds(5)); + + // Now delete the activity + await _conversationClient.DeleteActivityAsync( + activity.Conversation.Id, + sendResponse.Id, + _serviceUrl, + cancellationToken: CancellationToken.None); + + // If no exception was thrown, the delete was successful + } + + [Fact] + public async Task GetConversationMembers() + { + string conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set"); + + IList members = await _conversationClient.GetConversationMembersAsync( + conversationId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(members); + Assert.NotEmpty(members); + + // Log members + Console.WriteLine($"Found {members.Count} members in conversation {conversationId}:"); + foreach (ConversationAccount member in members) + { + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + Assert.NotNull(member); + Assert.NotNull(member.Id); + } + } + + [Fact] + public async Task GetConversationMember() + { + string conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set"); + string userId = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"); + + ConversationAccount member = await _conversationClient.GetConversationMemberAsync( + conversationId, + userId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(member); + + // Log member + Console.WriteLine($"Found member in conversation {conversationId}:"); + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + Assert.NotNull(member); + Assert.NotNull(member.Id); + } + + + [Fact] + public async Task GetConversationMembersInChannel() + { + string channelId = Environment.GetEnvironmentVariable("TEST_CHANNELID") ?? throw new InvalidOperationException("TEST_CHANNELID environment variable not set"); + + IList members = await _conversationClient.GetConversationMembersAsync( + channelId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(members); + Assert.NotEmpty(members); + + // Log members + Console.WriteLine($"Found {members.Count} members in channel {channelId}:"); + foreach (ConversationAccount member in members) + { + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + Assert.NotNull(member); + Assert.NotNull(member.Id); + } + } + + [Fact] + public async Task GetActivityMembers() + { + // First send an activity to get an activity ID + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Message for GetActivityMembers test at `{DateTime.UtcNow:s}`" } }, + ServiceUrl = _serviceUrl, + Conversation = new() + { + Id = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set") + } + }; + + SendActivityResponse sendResponse = await _conversationClient.SendActivityAsync(activity, cancellationToken: CancellationToken.None); + Assert.NotNull(sendResponse); + Assert.NotNull(sendResponse.Id); + + // Now get the members of this activity + IList members = await _conversationClient.GetActivityMembersAsync( + activity.Conversation.Id, + sendResponse.Id, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(members); + Assert.NotEmpty(members); + + // Log activity members + Console.WriteLine($"Found {members.Count} members for activity {sendResponse.Id}:"); + foreach (ConversationAccount member in members) + { + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + Assert.NotNull(member); + Assert.NotNull(member.Id); + } + } + + // TODO: This doesn't work + [Fact(Skip = "Method not allowed by API")] + public async Task GetConversations() + { + GetConversationsResponse response = await _conversationClient.GetConversationsAsync( + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(response); + Assert.NotNull(response.Conversations); + Assert.NotEmpty(response.Conversations); + + // Log conversations + Console.WriteLine($"Found {response.Conversations.Count} conversations:"); + foreach (ConversationMembers conversation in response.Conversations) + { + Console.WriteLine($" - Conversation Id: {conversation.Id}"); + Assert.NotNull(conversation); + Assert.NotNull(conversation.Id); + + if (conversation.Members != null && conversation.Members.Any()) + { + Console.WriteLine($" Members ({conversation.Members.Count}):"); + foreach (ConversationAccount member in conversation.Members) + { + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + } + } + } + } + + [Fact] + public async Task CreateConversation_WithMembers() + { + // Create a 1-on-1 conversation with a member + ConversationParameters parameters = new() + { + IsGroup = false, + Members = + [ + new() + { + Id = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"), + } + ], + // TODO: This is required for some reason. Should it be required in the api? + TenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set") + }; + + CreateConversationResponse response = await _conversationClient.CreateConversationAsync( + parameters, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(response); + Assert.NotNull(response.Id); + + Console.WriteLine($"Created conversation: {response.Id}"); + Console.WriteLine($" ActivityId: {response.ActivityId}"); + Console.WriteLine($" ServiceUrl: {response.ServiceUrl}"); + + // Send a message to the newly created conversation + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Test message to new conversation at {DateTime.UtcNow:s}" } }, + ServiceUrl = _serviceUrl, + Conversation = new() + { + Id = response.Id + } + }; + + SendActivityResponse sendResponse = await _conversationClient.SendActivityAsync(activity, cancellationToken: CancellationToken.None); + Assert.NotNull(sendResponse); + Assert.NotNull(sendResponse.Id); + + Console.WriteLine($" Sent message with activity ID: {sendResponse.Id}"); + } + + // TODO: This doesn't work + [Fact(Skip = "Incorrect conversation creation parameters")] + public async Task CreateConversation_WithGroup() + { + // Create a group conversation + ConversationParameters parameters = new() + { + IsGroup = true, + Members = + [ + new() + { + Id = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"), + }, + new() + { + Id = Environment.GetEnvironmentVariable("TEST_USER_ID_2") ?? throw new InvalidOperationException("TEST_USER_ID_2 environment variable not set"), + } + ], + TenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set") + }; + + CreateConversationResponse response = await _conversationClient.CreateConversationAsync( + parameters, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(response); + Assert.NotNull(response.Id); + + Console.WriteLine($"Created group conversation: {response.Id}"); + + // Send a message to the newly created group conversation + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Test message to new group conversation at {DateTime.UtcNow:s}" } }, + ServiceUrl = _serviceUrl, + Conversation = new() + { + Id = response.Id + } + }; + + SendActivityResponse sendResponse = await _conversationClient.SendActivityAsync(activity, cancellationToken: CancellationToken.None); + Assert.NotNull(sendResponse); + Assert.NotNull(sendResponse.Id); + + Console.WriteLine($" Sent message with activity ID: {sendResponse.Id}"); + } + + // TODO: This doesn't work + [Fact(Skip = "Incorrect conversation creation parameters")] + public async Task CreateConversation_WithTopicName() + { + // Create a conversation with a topic name + ConversationParameters parameters = new() + { + IsGroup = true, + TopicName = $"Test Conversation - {DateTime.UtcNow:s}", + Members = + [ + new() + { + Id = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"), + } + ], + TenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set") + }; + + CreateConversationResponse response = await _conversationClient.CreateConversationAsync( + parameters, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(response); + Assert.NotNull(response.Id); + + Console.WriteLine($"Created conversation with topic '{parameters.TopicName}': {response.Id}"); + + // Send a message to the newly created conversation + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Test message to conversation with topic name at {DateTime.UtcNow:s}" } }, + ServiceUrl = _serviceUrl, + Conversation = new() + { + Id = response.Id + } + }; + + SendActivityResponse sendResponse = await _conversationClient.SendActivityAsync(activity, cancellationToken: CancellationToken.None); + Assert.NotNull(sendResponse); + Assert.NotNull(sendResponse.Id); + + Console.WriteLine($" Sent message with activity ID: {sendResponse.Id}"); + } + + // TODO: This doesn't fail, but doesn't actually create the initial activity + [Fact] + public async Task CreateConversation_WithInitialActivity() + { + // Create a conversation with an initial message + ConversationParameters parameters = new() + { + IsGroup = false, + Members = + [ + new() + { + Id = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"), + } + ], + Activity = new CoreActivity + { + Type = ActivityType.Message, + Properties = { { "text", $"Initial message sent at {DateTime.UtcNow:s}" } }, + }, + TenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set") + }; + + CreateConversationResponse response = await _conversationClient.CreateConversationAsync( + parameters, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(response); + Assert.NotNull(response.Id); + // Assert.NotNull(response.ActivityId); // Should have an activity ID since we sent an initial message + + Console.WriteLine($"Created conversation with initial activity: {response.Id}"); + Console.WriteLine($" Initial activity ID: {response.ActivityId}"); + } + + [Fact] + public async Task CreateConversation_WithChannelData() + { + // Create a conversation with channel-specific data + ConversationParameters parameters = new() + { + IsGroup = false, + Members = + [ + new() + { + Id = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"), + } + ], + ChannelData = new + { + teamsChannelId = Environment.GetEnvironmentVariable("TEST_CHANNELID") + }, + TenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set") + }; + + CreateConversationResponse response = await _conversationClient.CreateConversationAsync( + parameters, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(response); + Assert.NotNull(response.Id); + + Console.WriteLine($"Created conversation with channel data: {response.Id}"); + } + + [Fact] + public async Task GetConversationPagedMembers() + { + string conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set"); + + PagedMembersResult result = await _conversationClient.GetConversationPagedMembersAsync( + conversationId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(result); + Assert.NotNull(result.Members); + Assert.NotEmpty(result.Members); + + Console.WriteLine($"Found {result.Members.Count} members in page:"); + foreach (ConversationAccount member in result.Members) + { + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + Assert.NotNull(member); + Assert.NotNull(member.Id); + } + + if (!string.IsNullOrWhiteSpace(result.ContinuationToken)) + { + Console.WriteLine($"Continuation token: {result.ContinuationToken}"); + } + } + + [Fact(Skip = "PageSize parameter not respected by API")] + public async Task GetConversationPagedMembers_WithPageSize() + { + string conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set"); + + PagedMembersResult result = await _conversationClient.GetConversationPagedMembersAsync( + conversationId, + _serviceUrl, + pageSize: 1, + cancellationToken: CancellationToken.None); + + Assert.NotNull(result); + Assert.NotNull(result.Members); + Assert.NotEmpty(result.Members); + Assert.Single(result.Members); + + Console.WriteLine($"Found {result.Members.Count} members with pageSize=1:"); + foreach (ConversationAccount member in result.Members) + { + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + } + + // If there's a continuation token, get the next page + if (!string.IsNullOrWhiteSpace(result.ContinuationToken)) + { + Console.WriteLine($"Getting next page with continuation token..."); + + PagedMembersResult nextPage = await _conversationClient.GetConversationPagedMembersAsync( + conversationId, + _serviceUrl, + pageSize: 1, + continuationToken: result.ContinuationToken, + cancellationToken: CancellationToken.None); + + Assert.NotNull(nextPage); + Assert.NotNull(nextPage.Members); + + Console.WriteLine($"Found {nextPage.Members.Count} members in next page:"); + foreach (ConversationAccount member in nextPage.Members) + { + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + } + } + } + + [Fact(Skip = "Method not allowed by API")] + public async Task DeleteConversationMember() + { + string conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set"); + + // Get members before deletion + IList membersBefore = await _conversationClient.GetConversationMembersAsync( + conversationId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(membersBefore); + Assert.NotEmpty(membersBefore); + + Console.WriteLine($"Members before deletion: {membersBefore.Count}"); + foreach (ConversationAccount member in membersBefore) + { + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + } + + // Delete the test user + string memberToDelete = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"); + + // Verify the member is in the conversation before attempting to delete + Assert.Contains(membersBefore, m => m.Id == memberToDelete); + + await _conversationClient.DeleteConversationMemberAsync( + conversationId, + memberToDelete, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Console.WriteLine($"Deleted member: {memberToDelete}"); + + // Get members after deletion + IList membersAfter = await _conversationClient.GetConversationMembersAsync( + conversationId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(membersAfter); + + Console.WriteLine($"Members after deletion: {membersAfter.Count}"); + foreach (ConversationAccount member in membersAfter) + { + Console.WriteLine($" - Id: {member.Id}, Name: {member.Name}"); + } + + // Verify the member was deleted + Assert.DoesNotContain(membersAfter, m => m.Id == memberToDelete); + } + + [Fact(Skip = "Unknown activity type error")] + public async Task SendConversationHistory() + { + string conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set"); + + // Create a transcript with historic activities + Transcript transcript = new() + { + Activities = + [ + new() + { + Type = ActivityType.Message, + Id = Guid.NewGuid().ToString(), + Properties = { { "text", "Historic message 1" } }, + ServiceUrl = _serviceUrl, + Conversation = new() { Id = conversationId } + }, + new() + { + Type = ActivityType.Message, + Id = Guid.NewGuid().ToString(), + Properties = { { "text", "Historic message 2" } }, + ServiceUrl = _serviceUrl, + Conversation = new() { Id = conversationId } + }, + new() + { + Type = ActivityType.Message, + Id = Guid.NewGuid().ToString(), + Properties = { { "text", "Historic message 3" } }, + ServiceUrl = _serviceUrl, + Conversation = new() { Id = conversationId } + } + ] + }; + + SendConversationHistoryResponse response = await _conversationClient.SendConversationHistoryAsync( + conversationId, + transcript, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(response); + + Console.WriteLine($"Sent conversation history with {transcript.Activities?.Count} activities"); + Console.WriteLine($"Response ID: {response.Id}"); + } + + [Fact(Skip = "Attachment upload endpoint not found")] + public async Task UploadAttachment() + { + string conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set"); + + // Create a simple text file as an attachment + string fileContent = "This is a test attachment file created at " + DateTime.UtcNow.ToString("s"); + byte[] fileBytes = System.Text.Encoding.UTF8.GetBytes(fileContent); + + AttachmentData attachmentData = new() + { + Type = "text/plain", + Name = "test-attachment.txt", + OriginalBase64 = fileBytes + }; + + UploadAttachmentResponse response = await _conversationClient.UploadAttachmentAsync( + conversationId, + attachmentData, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(response); + Assert.NotNull(response.Id); + + Console.WriteLine($"Uploaded attachment: {attachmentData.Name}"); + Console.WriteLine($" Attachment ID: {response.Id}"); + Console.WriteLine($" Content-Type: {attachmentData.Type}"); + Console.WriteLine($" Size: {fileBytes.Length} bytes"); + } } diff --git a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs index fc243c4f..8fc97ddf 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs @@ -51,10 +51,10 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Id = "act123" }; + activity.Properties["text"] = "Test message"; activity.Recipient.Properties["appId"] = "test-app-id"; DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); @@ -63,14 +63,13 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() botApp.OnActivity = (act, ct) => { onActivityCalled = true; - return Task.CompletedTask; + return Task.FromResult(null); }; - CoreActivity result = await botApp.ProcessAsync(httpContext); + InvokeResponse? result = await botApp.ProcessAsync(httpContext); - Assert.NotNull(result); + Assert.Null(result); Assert.True(onActivityCalled); - Assert.Equal(activity.Type, result.Type); } [Fact] @@ -83,8 +82,7 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Id = "act123" }; activity.Recipient.Properties["appId"] = "test-app-id"; @@ -108,7 +106,7 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() botApp.OnActivity = (act, ct) => { onActivityCalled = true; - return Task.CompletedTask; + return Task.FromResult(null); }; await botApp.ProcessAsync(httpContext); @@ -127,8 +125,7 @@ public async Task ProcessAsync_WithException_ThrowsBotHandlerException() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Id = "act123" }; activity.Recipient.Properties["appId"] = "test-app-id"; @@ -183,8 +180,7 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Conversation = new Conversation { Id = "conv123" }, ServiceUrl = new Uri("https://test.service.url/") }; diff --git a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs index a844588f..81a57280 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs @@ -31,8 +31,7 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Conversation = new Conversation { Id = "conv123" }, ServiceUrl = new Uri("https://test.service.url/") }; @@ -61,8 +60,7 @@ public async Task SendActivityAsync_WithNullConversation_ThrowsArgumentNullExcep CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, ServiceUrl = new Uri("https://test.service.url/") }; @@ -78,8 +76,7 @@ public async Task SendActivityAsync_WithNullConversationId_ThrowsArgumentNullExc CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Conversation = new Conversation() { Id = null! }, ServiceUrl = new Uri("https://test.service.url/") }; ; @@ -96,8 +93,7 @@ public async Task SendActivityAsync_WithNullServiceUrl_ThrowsArgumentNullExcepti CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Conversation = new Conversation { Id = "conv123" } }; @@ -126,8 +122,7 @@ public async Task SendActivityAsync_WithHttpError_ThrowsHttpRequestException() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Conversation = new Conversation { Id = "conv123" }, ServiceUrl = new Uri("https://test.service.url/") }; @@ -162,8 +157,7 @@ public async Task SendActivityAsync_ConstructsCorrectUrl() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Conversation = new Conversation { Id = "conv123" }, ServiceUrl = new Uri("https://test.service.url/") }; diff --git a/core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs new file mode 100644 index 00000000..053a0ff2 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs @@ -0,0 +1,483 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core.UnitTests; + +public class CoreActivityBuilderTests +{ + [Fact] + public void Constructor_DefaultConstructor_CreatesNewActivity() + { + CoreActivityBuilder builder = new(); + CoreActivity activity = builder.Build(); + + Assert.NotNull(activity); + Assert.NotNull(activity.From); + Assert.NotNull(activity.Recipient); + Assert.NotNull(activity.Conversation); + } + + [Fact] + public void Constructor_WithExistingActivity_UsesProvidedActivity() + { + CoreActivity existingActivity = new() + { + Id = "test-id", + }; + + CoreActivityBuilder builder = new(existingActivity); + CoreActivity activity = builder.Build(); + + Assert.Equal("test-id", activity.Id); + } + + [Fact] + public void Constructor_WithNullActivity_ThrowsArgumentNullException() + { + Assert.Throws(() => new CoreActivityBuilder(null!)); + } + + [Fact] + public void WithId_SetsActivityId() + { + CoreActivity activity = new CoreActivityBuilder() + .WithId("test-activity-id") + .Build(); + + Assert.Equal("test-activity-id", activity.Id); + } + + [Fact] + public void WithServiceUrl_SetsServiceUrl() + { + Uri serviceUrl = new("https://smba.trafficmanager.net/teams/"); + + CoreActivity activity = new CoreActivityBuilder() + .WithServiceUrl(serviceUrl) + .Build(); + + Assert.Equal(serviceUrl, activity.ServiceUrl); + } + + [Fact] + public void WithChannelId_SetsChannelId() + { + CoreActivity activity = new CoreActivityBuilder() + .WithChannelId("msteams") + .Build(); + + Assert.Equal("msteams", activity.ChannelId); + } + + [Fact] + public void WithType_SetsActivityType() + { + CoreActivity activity = new CoreActivityBuilder() + .WithType(ActivityType.Message) + .Build(); + + Assert.Equal(ActivityType.Message, activity.Type); + } + + [Fact] + public void WithText_SetsTextContent_As_Property() + { + CoreActivity activity = new CoreActivityBuilder() + .WithProperty("text","Hello, World!") + .Build(); + + Assert.Equal("Hello, World!", activity.Properties["text"]); + } + + [Fact] + public void WithFrom_SetsSenderAccount() + { + ConversationAccount fromAccount = new() + { + Id = "sender-id", + Name = "Sender Name" + }; + + CoreActivity activity = new CoreActivityBuilder() + .WithFrom(fromAccount) + .Build(); + + Assert.Equal("sender-id", activity.From.Id); + Assert.Equal("Sender Name", activity.From.Name); + } + + [Fact] + public void WithRecipient_SetsRecipientAccount() + { + ConversationAccount recipientAccount = new() + { + Id = "recipient-id", + Name = "Recipient Name" + }; + + CoreActivity activity = new CoreActivityBuilder() + .WithRecipient(recipientAccount) + .Build(); + + Assert.Equal("recipient-id", activity.Recipient.Id); + Assert.Equal("Recipient Name", activity.Recipient.Name); + } + + [Fact] + public void WithConversation_SetsConversationInfo() + { + Conversation conversation = new() + { + Id = "conversation-id" + }; + + CoreActivity activity = new CoreActivityBuilder() + .WithConversation(conversation) + .Build(); + + Assert.Equal("conversation-id", activity.Conversation.Id); + } + + [Fact] + public void WithChannelData_SetsChannelData() + { + ChannelData channelData = new(); + + CoreActivity activity = new CoreActivityBuilder() + .WithChannelData(channelData) + .Build(); + + Assert.NotNull(activity.ChannelData); + } + + [Fact] + public void FluentAPI_CompleteActivity_BuildsCorrectly() + { + CoreActivity activity = new CoreActivityBuilder() + .WithType(ActivityType.Message) + .WithId("activity-123") + .WithChannelId("msteams") + .WithProperty("text", "Test message") + .WithServiceUrl(new Uri("https://smba.trafficmanager.net/teams/")) + .WithFrom(new ConversationAccount + { + Id = "sender-id", + Name = "Sender" + }) + .WithRecipient(new ConversationAccount + { + Id = "recipient-id", + Name = "Recipient" + }) + .WithConversation(new Conversation + { + Id = "conv-id" + }) + .Build(); + + Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal("activity-123", activity.Id); + Assert.Equal("msteams", activity.ChannelId); + Assert.Equal("Test message", activity.Properties["text"]?.ToString()); + Assert.Equal("sender-id", activity.From.Id); + Assert.Equal("recipient-id", activity.Recipient.Id); + Assert.Equal("conv-id", activity.Conversation.Id); + } + + [Fact] + public void FluentAPI_MethodChaining_ReturnsBuilderInstance() + { + CoreActivityBuilder builder = new(); + + CoreActivityBuilder result1 = builder.WithId("id"); + CoreActivityBuilder result2 = builder.WithProperty("text", "text"); + CoreActivityBuilder result3 = builder.WithType(ActivityType.Message); + + Assert.Same(builder, result1); + Assert.Same(builder, result2); + Assert.Same(builder, result3); + } + + [Fact] + public void Build_CalledMultipleTimes_ReturnsSameInstance() + { + CoreActivityBuilder builder = new CoreActivityBuilder() + .WithId("test-id"); + + CoreActivity activity1 = builder.Build(); + CoreActivity activity2 = builder.Build(); + + Assert.Same(activity1, activity2); + } + + [Fact] + public void Builder_ModifyingExistingActivity_PreservesOriginalData() + { + CoreActivity original = new() + { + Id = "original-id", + Type = ActivityType.Message + }; + + CoreActivity modified = new CoreActivityBuilder(original) + .WithId("other-id") + .Build(); + + Assert.Equal("other-id", modified.Id); + Assert.Equal(ActivityType.Message, modified.Type); + } + + [Fact] + public void WithConversationReference_WithNullActivity_ThrowsArgumentNullException() + { + CoreActivityBuilder builder = new(); + + Assert.Throws(() => builder.WithConversationReference(null!)); + } + + [Fact] + public void WithConversationReference_WithNullChannelId_ThrowsArgumentNullException() + { + CoreActivityBuilder builder = new(); + CoreActivity sourceActivity = new() + { + ChannelId = null, + ServiceUrl = new Uri("https://test.com"), + Conversation = new Conversation(), + From = new ConversationAccount(), + Recipient = new ConversationAccount() + }; + + Assert.Throws(() => builder.WithConversationReference(sourceActivity)); + } + + [Fact] + public void WithConversationReference_WithNullServiceUrl_ThrowsArgumentNullException() + { + CoreActivityBuilder builder = new(); + CoreActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = null, + Conversation = new Conversation(), + From = new ConversationAccount(), + Recipient = new ConversationAccount() + }; + + Assert.Throws(() => builder.WithConversationReference(sourceActivity)); + } + + [Fact] + public void WithConversationReference_WithNullConversation_ThrowsArgumentNullException() + { + CoreActivityBuilder builder = new(); + CoreActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = new Uri("https://test.com"), + Conversation = null!, + From = new ConversationAccount(), + Recipient = new ConversationAccount() + }; + + Assert.Throws(() => builder.WithConversationReference(sourceActivity)); + } + + [Fact] + public void WithConversationReference_WithNullFrom_ThrowsArgumentNullException() + { + CoreActivityBuilder builder = new(); + CoreActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = new Uri("https://test.com"), + Conversation = new Conversation(), + From = null!, + Recipient = new ConversationAccount() + }; + + Assert.Throws(() => builder.WithConversationReference(sourceActivity)); + } + + [Fact] + public void WithConversationReference_WithNullRecipient_ThrowsArgumentNullException() + { + CoreActivityBuilder builder = new(); + CoreActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = new Uri("https://test.com"), + Conversation = new Conversation(), + From = new ConversationAccount(), + Recipient = null! + }; + + Assert.Throws(() => builder.WithConversationReference(sourceActivity)); + } + + [Fact] + public void WithConversationReference_AppliesConversationReference() + { + CoreActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = new Uri("https://smba.trafficmanager.net/teams/"), + Conversation = new Conversation { Id = "conv-123" }, + From = new ConversationAccount { Id = "user-1", Name = "User One" }, + Recipient = new ConversationAccount { Id = "bot-1", Name = "Bot" } + }; + + CoreActivity activity = new CoreActivityBuilder() + .WithConversationReference(sourceActivity) + .Build(); + + Assert.Equal("msteams", activity.ChannelId); + Assert.Equal(new Uri("https://smba.trafficmanager.net/teams/"), activity.ServiceUrl); + Assert.Equal("conv-123", activity.Conversation.Id); + Assert.Equal("bot-1", activity.From.Id); + Assert.Equal("Bot", activity.From.Name); + Assert.Equal("user-1", activity.Recipient.Id); + Assert.Equal("User One", activity.Recipient.Name); + } + + [Fact] + public void WithConversationReference_SwapsFromAndRecipient() + { + CoreActivity incomingActivity = new() + { + ChannelId = "msteams", + ServiceUrl = new Uri("https://test.com"), + Conversation = new Conversation { Id = "conv-123" }, + From = new ConversationAccount { Id = "user-id", Name = "User" }, + Recipient = new ConversationAccount { Id = "bot-id", Name = "Bot" } + }; + + CoreActivity replyActivity = new CoreActivityBuilder() + .WithConversationReference(incomingActivity) + .Build(); + + Assert.Equal("bot-id", replyActivity.From.Id); + Assert.Equal("Bot", replyActivity.From.Name); + Assert.Equal("user-id", replyActivity.Recipient.Id); + Assert.Equal("User", replyActivity.Recipient.Name); + } + + [Fact] + public void WithChannelData_WithNullValue_SetsToNull() + { + CoreActivity activity = new CoreActivityBuilder() + .WithChannelData(new ChannelData()) + .WithChannelData(null) + .Build(); + + Assert.Null(activity.ChannelData); + } + + [Fact] + public void WithId_WithEmptyString_SetsEmptyId() + { + CoreActivity activity = new CoreActivityBuilder() + .WithId(string.Empty) + .Build(); + + Assert.Equal(string.Empty, activity.Id); + } + + [Fact] + public void WithChannelId_WithEmptyString_SetsEmptyChannelId() + { + CoreActivity activity = new CoreActivityBuilder() + .WithChannelId(string.Empty) + .Build(); + + Assert.Equal(string.Empty, activity.ChannelId); + } + + [Fact] + public void WithType_WithEmptyString_SetsEmptyType() + { + CoreActivity activity = new CoreActivityBuilder() + .WithType(string.Empty) + .Build(); + + Assert.Equal(string.Empty, activity.Type); + } + + [Fact] + public void WithConversationReference_ChainedWithOtherMethods_MaintainsFluentInterface() + { + CoreActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = new Uri("https://test.com"), + Conversation = new Conversation { Id = "conv-123" }, + From = new ConversationAccount { Id = "user-1" }, + Recipient = new ConversationAccount { Id = "bot-1" } + }; + + CoreActivity activity = new CoreActivityBuilder() + .WithType(ActivityType.Message) + .WithConversationReference(sourceActivity) + .Build(); + + Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal("bot-1", activity.From.Id); + Assert.Equal("user-1", activity.Recipient.Id); + } + + [Fact] + public void Build_AfterModificationThenBuild_ReflectsChanges() + { + CoreActivityBuilder builder = new CoreActivityBuilder() + .WithId("id-1"); + + CoreActivity activity1 = builder.Build(); + Assert.Equal("id-1", activity1.Id); + + builder.WithId("id-2"); + CoreActivity activity2 = builder.Build(); + + Assert.Same(activity1, activity2); + Assert.Equal("id-2", activity2.Id); + } + + [Fact] + public void IntegrationTest_CreateComplexActivity() + { + Uri serviceUrl = new("https://smba.trafficmanager.net/amer/test/"); + ChannelData channelData = new(); + + CoreActivity activity = new CoreActivityBuilder() + .WithType(ActivityType.Message) + .WithId("msg-001") + .WithServiceUrl(serviceUrl) + .WithChannelId("msteams") + .WithFrom(new ConversationAccount + { + Id = "bot-id", + Name = "Bot" + }) + .WithRecipient(new ConversationAccount + { + Id = "user-id", + Name = "User" + }) + .WithConversation(new Conversation + { + Id = "conv-001" + }) + .WithChannelData(channelData) + .Build(); + + Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal("msg-001", activity.Id); + Assert.Equal(serviceUrl, activity.ServiceUrl); + Assert.Equal("msteams", activity.ChannelId); + Assert.Equal("bot-id", activity.From.Id); + Assert.Equal("user-id", activity.Recipient.Id); + Assert.Equal("conv-001", activity.Conversation.Id); + Assert.NotNull(activity.ChannelData); + } +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs index 3757382e..0158d551 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs @@ -2,14 +2,10 @@ // Licensed under the MIT License. using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; -using Microsoft.Identity.Web; -using Moq; namespace Microsoft.Bot.Core.UnitTests.Hosting; @@ -17,11 +13,11 @@ public class AddBotApplicationExtensionsTests { private static ServiceProvider BuildServiceProvider(Dictionary configData, string? aadConfigSectionName = null) { - var configuration = new ConfigurationBuilder() + IConfigurationRoot configuration = new ConfigurationBuilder() .AddInMemoryCollection(configData) .Build(); - var services = new ServiceCollection(); + ServiceCollection services = new(); services.AddSingleton(configuration); services.AddLogging(); @@ -51,7 +47,7 @@ private static void AssertMsalOptions(ServiceProvider serviceProvider, string ex public void AddConversationClient_WithBotFrameworkConfig_ConfiguresClientSecret() { // Arrange - var configData = new Dictionary + var configData = new Dictionary { ["MicrosoftAppId"] = "test-app-id", ["MicrosoftAppTenantId"] = "test-tenant-id", @@ -59,7 +55,7 @@ public void AddConversationClient_WithBotFrameworkConfig_ConfiguresClientSecret( }; // Act - var serviceProvider = BuildServiceProvider(configData); + ServiceProvider serviceProvider = BuildServiceProvider(configData); // Assert AssertMsalOptions(serviceProvider, "test-app-id", "test-tenant-id"); @@ -68,7 +64,7 @@ public void AddConversationClient_WithBotFrameworkConfig_ConfiguresClientSecret( .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); Assert.Single(msalOptions.ClientCredentials); - var credential = msalOptions.ClientCredentials.First(); + CredentialDescription credential = msalOptions.ClientCredentials.First(); Assert.Equal(CredentialSource.ClientSecret, credential.SourceType); Assert.Equal("test-secret", credential.ClientSecret); } @@ -77,7 +73,7 @@ public void AddConversationClient_WithBotFrameworkConfig_ConfiguresClientSecret( public void AddConversationClient_WithCoreConfigAndClientSecret_ConfiguresClientSecret() { // Arrange - var configData = new Dictionary + Dictionary configData = new() { ["CLIENT_ID"] = "test-client-id", ["TENANT_ID"] = "test-tenant-id", @@ -85,7 +81,7 @@ public void AddConversationClient_WithCoreConfigAndClientSecret_ConfiguresClient }; // Act - var serviceProvider = BuildServiceProvider(configData); + ServiceProvider serviceProvider = BuildServiceProvider(configData); // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); @@ -94,7 +90,7 @@ public void AddConversationClient_WithCoreConfigAndClientSecret_ConfiguresClient .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); Assert.Single(msalOptions.ClientCredentials); - var credential = msalOptions.ClientCredentials.First(); + CredentialDescription credential = msalOptions.ClientCredentials.First(); Assert.Equal(CredentialSource.ClientSecret, credential.SourceType); Assert.Equal("test-client-secret", credential.ClientSecret); } @@ -103,7 +99,7 @@ public void AddConversationClient_WithCoreConfigAndClientSecret_ConfiguresClient public void AddConversationClient_WithCoreConfigAndSystemAssignedMI_ConfiguresSystemAssignedFIC() { // Arrange - var configData = new Dictionary + Dictionary configData = new() { ["CLIENT_ID"] = "test-client-id", ["TENANT_ID"] = "test-tenant-id", @@ -111,7 +107,7 @@ public void AddConversationClient_WithCoreConfigAndSystemAssignedMI_ConfiguresSy }; // Act - var serviceProvider = BuildServiceProvider(configData); + ServiceProvider serviceProvider = BuildServiceProvider(configData); // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); @@ -120,11 +116,11 @@ public void AddConversationClient_WithCoreConfigAndSystemAssignedMI_ConfiguresSy .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); Assert.Single(msalOptions.ClientCredentials); - var credential = msalOptions.ClientCredentials.First(); + CredentialDescription credential = msalOptions.ClientCredentials.First(); Assert.Equal(CredentialSource.SignedAssertionFromManagedIdentity, credential.SourceType); Assert.Null(credential.ManagedIdentityClientId); // System-assigned - var managedIdentityOptions = serviceProvider.GetRequiredService>().Value; + ManagedIdentityOptions managedIdentityOptions = serviceProvider.GetRequiredService>().Value; Assert.Null(managedIdentityOptions.UserAssignedClientId); } @@ -132,7 +128,7 @@ public void AddConversationClient_WithCoreConfigAndSystemAssignedMI_ConfiguresSy public void AddConversationClient_WithCoreConfigAndUserAssignedMI_ConfiguresUserAssignedFIC() { // Arrange - var configData = new Dictionary + Dictionary configData = new() { ["CLIENT_ID"] = "test-client-id", ["TENANT_ID"] = "test-tenant-id", @@ -140,7 +136,7 @@ public void AddConversationClient_WithCoreConfigAndUserAssignedMI_ConfiguresUser }; // Act - var serviceProvider = BuildServiceProvider(configData); + ServiceProvider serviceProvider = BuildServiceProvider(configData); // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); @@ -149,11 +145,11 @@ public void AddConversationClient_WithCoreConfigAndUserAssignedMI_ConfiguresUser .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); Assert.Single(msalOptions.ClientCredentials); - var credential = msalOptions.ClientCredentials.First(); + CredentialDescription credential = msalOptions.ClientCredentials.First(); Assert.Equal(CredentialSource.SignedAssertionFromManagedIdentity, credential.SourceType); Assert.Equal("umi-client-id", credential.ManagedIdentityClientId); - var managedIdentityOptions = serviceProvider.GetRequiredService>().Value; + ManagedIdentityOptions managedIdentityOptions = serviceProvider.GetRequiredService>().Value; Assert.Null(managedIdentityOptions.UserAssignedClientId); } @@ -161,14 +157,14 @@ public void AddConversationClient_WithCoreConfigAndUserAssignedMI_ConfiguresUser public void AddConversationClient_WithCoreConfigAndNoManagedIdentity_ConfiguresUMIWithClientId() { // Arrange - var configData = new Dictionary + Dictionary configData = new() { ["CLIENT_ID"] = "test-client-id", ["TENANT_ID"] = "test-tenant-id" }; // Act - var serviceProvider = BuildServiceProvider(configData); + ServiceProvider serviceProvider = BuildServiceProvider(configData); // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); @@ -177,7 +173,7 @@ public void AddConversationClient_WithCoreConfigAndNoManagedIdentity_ConfiguresU .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.Null(msalOptions.ClientCredentials); - var managedIdentityOptions = serviceProvider.GetRequiredService>().Value; + ManagedIdentityOptions managedIdentityOptions = serviceProvider.GetRequiredService>().Value; Assert.Equal("test-client-id", managedIdentityOptions.UserAssignedClientId); } @@ -186,7 +182,7 @@ public void AddConversationClient_WithDefaultSection_ConfiguresFromSection() { // AzureAd is the default Section Name // Arrange - var configData = new Dictionary + Dictionary configData = new() { ["AzureAd:ClientId"] = "azuread-client-id", ["AzureAd:TenantId"] = "azuread-tenant-id", @@ -194,7 +190,7 @@ public void AddConversationClient_WithDefaultSection_ConfiguresFromSection() }; // Act - var serviceProvider = BuildServiceProvider(configData); + ServiceProvider serviceProvider = BuildServiceProvider(configData); // Assert AssertMsalOptions(serviceProvider, "azuread-client-id", "azuread-tenant-id"); @@ -204,7 +200,7 @@ public void AddConversationClient_WithDefaultSection_ConfiguresFromSection() public void AddConversationClient_WithCustomSectionName_ConfiguresFromCustomSection() { // Arrange - var configData = new Dictionary + Dictionary configData = new() { ["CustomAuth:ClientId"] = "custom-client-id", ["CustomAuth:TenantId"] = "custom-tenant-id", @@ -212,7 +208,7 @@ public void AddConversationClient_WithCustomSectionName_ConfiguresFromCustomSect }; // Act - var serviceProvider = BuildServiceProvider(configData, "CustomAuth"); + ServiceProvider serviceProvider = BuildServiceProvider(configData, "CustomAuth"); // Assert AssertMsalOptions(serviceProvider, "custom-client-id", "custom-tenant-id"); diff --git a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs index f9f3fbe4..c07d8e28 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs @@ -36,7 +36,7 @@ public async Task Middleware_ExecutesInOrder() NullLogger logger = NullLogger.Instance; BotApplication botApp = new(conversationClient, mockConfig.Object, logger); - List executionOrder = new(); + List executionOrder = []; Mock mockMiddleware1 = new(); mockMiddleware1 @@ -63,8 +63,7 @@ public async Task Middleware_ExecutesInOrder() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Id = "act123" }; activity.Recipient.Properties["appId"] = "test-app-id"; @@ -74,7 +73,7 @@ public async Task Middleware_ExecutesInOrder() botApp.OnActivity = (act, ct) => { executionOrder.Add(3); - return Task.CompletedTask; + return Task.FromResult(null); }; await botApp.ProcessAsync(httpContext); @@ -109,8 +108,7 @@ public async Task Middleware_CanShortCircuit() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Id = "act123" }; activity.Recipient.Properties["appId"] = "test-app-id"; @@ -120,7 +118,7 @@ public async Task Middleware_CanShortCircuit() botApp.OnActivity = (act, ct) => { onActivityCalled = true; - return Task.CompletedTask; + return Task.FromResult(null); }; await botApp.ProcessAsync(httpContext); @@ -153,8 +151,7 @@ public async Task Middleware_ReceivesCancellationToken() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Id = "act123" }; activity.Recipient.Properties["appId"] = "test-app-id"; @@ -192,8 +189,7 @@ public async Task Middleware_ReceivesActivity() CoreActivity activity = new() { - Type = ActivityTypes.Message, - Text = "Test message", + Type = ActivityType.Message, Id = "act123" }; activity.Recipient.Properties["appId"] = "test-app-id"; @@ -203,8 +199,7 @@ public async Task Middleware_ReceivesActivity() await botApp.ProcessAsync(httpContext); Assert.NotNull(receivedActivity); - Assert.Equal(ActivityTypes.Message, receivedActivity.Type); - Assert.Equal("Test message", receivedActivity.Text); + Assert.Equal(ActivityType.Message, receivedActivity.Type); } private static ConversationClient CreateMockConversationClient() diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs index 40fb5416..4137553f 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs @@ -54,7 +54,7 @@ public void CustomChannelDataActivity_ExtendedProperties_SerializedAndDeserializ MyCustomChannelDataActivity deserializedActivity = CoreActivity.FromJsonString(json); Assert.NotNull(deserializedActivity); Assert.NotNull(deserializedActivity.ChannelData); - Assert.Equal(ActivityTypes.Message, deserializedActivity.Type); + Assert.Equal(ActivityType.Message, deserializedActivity.Type); Assert.Equal("customFieldValue", deserializedActivity.ChannelData.CustomField); Assert.Equal("12345", deserializedActivity.ChannelData.MyChannelId); } diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs index 6f1e8f6e..bd8a4ae3 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -12,8 +12,7 @@ public void Ctor_And_Nulls() { CoreActivity a1 = new(); Assert.NotNull(a1); - Assert.Equal(ActivityTypes.Message, a1.Type); - Assert.Null(a1.Text); + Assert.Equal(ActivityType.Message, a1.Type); CoreActivity a2 = new() { @@ -21,7 +20,6 @@ public void Ctor_And_Nulls() }; Assert.NotNull(a2); Assert.Equal("mytype", a2.Type); - Assert.Null(a2.Text); } [Fact] @@ -36,7 +34,6 @@ public void Json_Nulls_Not_Deserialized() CoreActivity act = CoreActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("message", act.Type); - Assert.Null(act.Text); string json2 = """ { @@ -46,7 +43,6 @@ public void Json_Nulls_Not_Deserialized() CoreActivity act2 = CoreActivity.FromJsonString(json2); Assert.NotNull(act2); Assert.Equal("message", act2.Type); - Assert.Null(act2.Text); } @@ -66,7 +62,6 @@ public void Accept_Unkown_Primitive_Fields() CoreActivity act = CoreActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("message", act.Type); - Assert.Equal("hello", act.Text); Assert.True(act.Properties.ContainsKey("unknownString")); Assert.True(act.Properties.ContainsKey("unknownInt")); Assert.True(act.Properties.ContainsKey("unknownBool")); @@ -82,8 +77,7 @@ public void Serialize_Unkown_Primitive_Fields() { CoreActivity act = new() { - Type = ActivityTypes.Message, - Text = "hello", + Type = ActivityType.Message, }; act.Properties["unknownString"] = "some string"; act.Properties["unknownInt"] = 123; @@ -94,7 +88,6 @@ public void Serialize_Unkown_Primitive_Fields() string json = act.ToJson(); Assert.Contains("\"type\": \"message\"", json); - Assert.Contains("\"text\": \"hello\"", json); Assert.Contains("\"unknownString\": \"some string\"", json); Assert.Contains("\"unknownInt\": 123", json); Assert.Contains("\"unknownBool\": true", json); @@ -120,7 +113,6 @@ public void Deserialize_Unkown__Fields_In_KnownObjects() CoreActivity act = CoreActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("message", act.Type); - Assert.Equal("hello", act.Text); Assert.NotNull(act.From); Assert.IsType(act.From); Assert.Equal("1", act.From!.Id); @@ -144,16 +136,50 @@ public void Deserialize_Serialize_Unkown__Fields_In_KnownObjects() } """; CoreActivity act = CoreActivity.FromJsonString(json); - act.Text = "updated"; string json2 = act.ToJson(); Assert.Contains("\"type\": \"message\"", json2); - Assert.Contains("\"text\": \"updated\"", json2); + Assert.Contains("\"text\": \"hello\"", json2); Assert.Contains("\"from\": {", json2); Assert.Contains("\"id\": \"1\"", json2); Assert.Contains("\"name\": \"tester\"", json2); Assert.Contains("\"aadObjectId\": \"123\"", json2); } + [Fact] + public void Deserialize_Serialize_Entities() + { + string json = """ + { + "type": "message", + "text": "hello", + "entities": [ + { + "mentioned": { + "id": "28:0b6fe6d1-fece-44f7-9a48-56465e2d5ab8", + "name": "ridotest" + }, + "text": "\u003Cat\u003Eridotest\u003C/at\u003E", + "type": "mention" + }, + { + "locale": "en-US", + "country": "US", + "platform": "Web", + "timezone": "America/Los_Angeles", + "type": "clientInfo" + } + ] + } + """; + CoreActivity act = CoreActivity.FromJsonString(json); + string json2 = act.ToJson(); + Assert.Contains("\"type\": \"message\"", json2); + Assert.NotNull(act.Entities); + Assert.Equal(2, act.Entities!.Count); + + } + + [Fact] public void Handling_Nulls_from_default_serializer() { @@ -167,7 +193,7 @@ public void Handling_Nulls_from_default_serializer() CoreActivity? act = JsonSerializer.Deserialize(json); //without default options Assert.NotNull(act); Assert.Equal("message", act.Type); - Assert.Null(act.Text); + Assert.Null(act.Properties["text"]); Assert.Null(act.Properties["unknownString"]!); string json2 = JsonSerializer.Serialize(act); //without default options @@ -181,8 +207,7 @@ public void Serialize_With_Properties_Initialized() { CoreActivity act = new() { - Type = ActivityTypes.Message, - Text = "hello", + Type = ActivityType.Message, Properties = { { "customField", "customValue" } @@ -221,7 +246,6 @@ public void Serialize_With_Properties_Initialized() }; string json = act.ToJson(); Assert.Contains("\"type\": \"message\"", json); - Assert.Contains("\"text\": \"hello\"", json); Assert.Contains("\"customField\": \"customValue\"", json); Assert.Contains("\"channelCustomField\": \"channelCustomValue\"", json); Assert.Contains("\"conversationCustomField\": \"conversationCustomValue\"", json); @@ -236,7 +260,6 @@ public void CreateReply() CoreActivity act = new() { Type = "myActivityType", - Text = "hello", Id = "CoreActivity1", ChannelId = "channel1", ServiceUrl = new Uri("http://service.url"), @@ -255,10 +278,15 @@ public void CreateReply() Id = "conversation1" } }; - CoreActivity reply = act.CreateReplyMessageActivity("reply"); + CoreActivity reply = CoreActivity.CreateBuilder() + .WithType(ActivityType.Message) + .WithConversationReference(act) + .WithProperty("text", "reply") + .Build(); + Assert.NotNull(reply); - Assert.Equal(ActivityTypes.Message, reply.Type); - Assert.Equal("reply", reply.Text); + Assert.Equal(ActivityType.Message, reply.Type); + Assert.Equal("reply", reply.Properties["text"]); Assert.Equal("channel1", reply.ChannelId); Assert.NotNull(reply.ServiceUrl); Assert.Equal("http://service.url/", reply.ServiceUrl.ToString()); @@ -287,7 +315,7 @@ public async Task DeserializeAsync() CoreActivity? act = await CoreActivity.FromJsonStreamAsync(ms); Assert.NotNull(act); Assert.Equal("message", act.Type); - Assert.Equal("hello", act.Text); + Assert.Equal("hello", act.Properties["text"]?.ToString()); Assert.NotNull(act.From); Assert.IsType(act.From); Assert.Equal("1", act.From.Id); @@ -295,4 +323,27 @@ public async Task DeserializeAsync() Assert.True(act.From.Properties.ContainsKey("aadObjectId")); Assert.Equal("123", act.From.Properties["aadObjectId"]?.ToString()); } + + + [Fact] + public async Task DeserializeInvokeWithValueAsync() + { + string json = """ + { + "type": "invoke", + "value": { + "key1": "value1", + "key2": 2 + } + } + """; + using MemoryStream ms = new(System.Text.Encoding.UTF8.GetBytes(json)); + CoreActivity? act = await CoreActivity.FromJsonStreamAsync(ms); + Assert.NotNull(act); + Assert.Equal(ActivityType.Invoke, act.Type); + Assert.NotNull(act.Value); + Assert.NotNull(act.Value["key1"]); + Assert.Equal("value1", act.Value["key1"]?.GetValue()); + Assert.Equal(2, act.Value["key2"]?.GetValue()); + } } diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/EntitiesTest.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/EntitiesTest.cs new file mode 100644 index 00000000..9eeac0f6 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/EntitiesTest.cs @@ -0,0 +1,99 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Nodes; +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core.UnitTests.Schema; + +public class EntitiesTest +{ + [Fact] + public void Test_Entity_Deserialization() + { + string json = """ + { + "type": "message", + "entities": [ + { + "type": "mention", + "mentioned": { + "id": "user1", + "name": "User One" + }, + "text": "User One" + } + ] + } + """; + CoreActivity activity = CoreActivity.FromJsonString(json); + Assert.NotNull(activity); + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + JsonNode? e1 = activity.Entities[0]; + Assert.NotNull(e1); + Assert.Equal("mention", e1["type"]?.ToString()); + Assert.NotNull(e1["mentioned"]); + Assert.True(e1["mentioned"]?.AsObject().ContainsKey("id")); + Assert.NotNull(e1["mentioned"]?["id"]); + Assert.Equal("user1", e1["mentioned"]?["id"]?.ToString()); + Assert.Equal("User One", e1["mentioned"]?["name"]?.ToString()); + Assert.Equal("User One", e1["text"]?.ToString()); + } + + [Fact] + public void Entitiy_Serialization() + { + JsonNodeOptions nops = new() + { + PropertyNameCaseInsensitive = false + }; + + CoreActivity activity = new(ActivityType.Message); + JsonObject mentionEntity = new() + { + ["type"] = "mention", + ["mentioned"] = new JsonObject + { + ["id"] = "user1", + ["name"] = "UserOne" + }, + ["text"] = "User One" + }; + activity.Entities = new JsonArray(nops, mentionEntity); + string json = activity.ToJson(); + Assert.NotNull(json); + Assert.Contains("\"type\": \"mention\"", json); + Assert.Contains("\"id\": \"user1\"", json); + Assert.Contains("\"name\": \"UserOne\"", json); + Assert.Contains("\"text\": \"\\u003Cat\\u003EUser One\\u003C/at\\u003E\"", json); + } + + [Fact] + public void Entity_RoundTrip() + { + string json = """ + { + "type": "message", + "entities": [ + { + "type": "mention", + "mentioned": { + "id": "user1", + "name": "User One" + }, + "text": "User One" + } + ] + } + """; + CoreActivity activity = CoreActivity.FromJsonString(json); + string serialized = activity.ToJson(); + Assert.NotNull(serialized); + Assert.Contains("\"type\": \"mention\"", serialized); + Assert.Contains("\"id\": \"user1\"", serialized); + Assert.Contains("\"name\": \"User One\"", serialized); + Assert.Contains("\"text\": \"\\u003Cat\\u003EUser One\\u003C/at\\u003E\"", serialized); + + } +} diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs b/core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs new file mode 100644 index 00000000..211a7433 --- /dev/null +++ b/core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs @@ -0,0 +1,115 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Handlers; +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Teams.BotApps.UnitTests; + +public class ConversationUpdateActivityTests +{ + [Fact] + public void AsConversationUpdate_MembersAdded() + { + string json = """ + { + "type": "conversationUpdate", + "conversation": { + "id": "19" + }, + "membersAdded": [ + { + "id": "user1", + "name": "User One" + }, + { + "id": "bot1", + "name": "Bot One" + } + ] + } + """; + TeamsActivity act = CoreActivity.FromJsonString(json); + Assert.NotNull(act); + Assert.Equal("conversationUpdate", act.Type); + + ConversationUpdateArgs? cua = new(act); + + Assert.NotNull(cua); + Assert.NotNull(cua.MembersAdded); + Assert.Equal(2, cua.MembersAdded!.Count); + Assert.Equal("user1", cua.MembersAdded[0].Id); + Assert.Equal("User One", cua.MembersAdded[0].Name); + Assert.Equal("bot1", cua.MembersAdded[1].Id); + Assert.Equal("Bot One", cua.MembersAdded[1].Name); + } + + [Fact] + public void AsConversationUpdate_MembersRemoved() + { + string json = """ + { + "type": "conversationUpdate", + "conversation": { + "id": "19" + }, + "membersRemoved": [ + { + "id": "user2", + "name": "User Two" + } + ] + } + """; + TeamsActivity act = CoreActivity.FromJsonString(json); + Assert.NotNull(act); + Assert.Equal("conversationUpdate", act.Type); + + ConversationUpdateArgs? cua = new(act); + + Assert.NotNull(cua); + Assert.NotNull(cua.MembersRemoved); + Assert.Single(cua.MembersRemoved!); + Assert.Equal("user2", cua.MembersRemoved[0].Id); + Assert.Equal("User Two", cua.MembersRemoved[0].Name); + } + + [Fact] + public void AsConversationUpdate_BothMembersAddedAndRemoved() + { + string json = """ + { + "type": "conversationUpdate", + "conversation": { + "id": "19" + }, + "membersAdded": [ + { + "id": "newuser", + "name": "New User" + } + ], + "membersRemoved": [ + { + "id": "olduser", + "name": "Old User" + } + ] + } + """; + TeamsActivity act = CoreActivity.FromJsonString(json); + Assert.NotNull(act); + Assert.Equal("conversationUpdate", act.Type); + + ConversationUpdateArgs? cua = new(act); + + Assert.NotNull(cua); + Assert.NotNull(cua.MembersAdded); + Assert.NotNull(cua.MembersRemoved); + Assert.Single(cua.MembersAdded!); + Assert.Single(cua.MembersRemoved!); + Assert.Equal("newuser", cua.MembersAdded[0].Id); + Assert.Equal("olduser", cua.MembersRemoved[0].Id); + } +} diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs b/core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs new file mode 100644 index 00000000..a6f89b28 --- /dev/null +++ b/core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs @@ -0,0 +1,44 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Handlers; +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Teams.BotApps.UnitTests; + +public class MessageReactionActivityTests +{ + [Fact] + public void AsMessageReaction() + { + string json = """ + { + "type": "messageReaction", + "conversation": { + "id": "19" + }, + "reactionsAdded": [ + { + "type": "like" + }, + { + "type": "heart" + } + ] + } + """; + TeamsActivity act = CoreActivity.FromJsonString(json); + Assert.NotNull(act); + Assert.Equal("messageReaction", act.Type); + + // MessageReactionActivity? mra = MessageReactionActivity.FromActivity(act); + MessageReactionArgs? mra = new(act); + + Assert.NotNull(mra); + Assert.NotNull(mra!.ReactionsAdded); + Assert.Equal(2, mra!.ReactionsAdded!.Count); + Assert.Equal("like", mra!.ReactionsAdded[0].Type); + Assert.Equal("heart", mra!.ReactionsAdded[1].Type); + } +} diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/Microsoft.Teams.BotApps.UnitTests.csproj b/core/test/Microsoft.Teams.BotApps.UnitTests/Microsoft.Teams.BotApps.UnitTests.csproj new file mode 100644 index 00000000..0bfc94a1 --- /dev/null +++ b/core/test/Microsoft.Teams.BotApps.UnitTests/Microsoft.Teams.BotApps.UnitTests.csproj @@ -0,0 +1,25 @@ + + + + net8.0;net10.0 + enable + enable + false + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityBuilderTests.cs b/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityBuilderTests.cs new file mode 100644 index 00000000..e58f9d5f --- /dev/null +++ b/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityBuilderTests.cs @@ -0,0 +1,849 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.BotApps.Schema.Entities; + +namespace Microsoft.Teams.BotApps.UnitTests; + +public class TeamsActivityBuilderTests +{ + private readonly TeamsActivityBuilder builder; + public TeamsActivityBuilderTests() + { + builder = TeamsActivity.CreateBuilder(); + } + + [Fact] + public void Constructor_DefaultConstructor_CreatesNewActivity() + { + TeamsActivity activity = builder.Build(); + + Assert.NotNull(activity); + Assert.NotNull(activity.From); + Assert.NotNull(activity.Recipient); + Assert.NotNull(activity.Conversation); + } + + [Fact] + public void Constructor_WithExistingActivity_UsesProvidedActivity() + { + TeamsActivity existingActivity = new() + { + Id = "test-id" + }; + existingActivity.Properties["text"] = "existing text"; + + TeamsActivityBuilder taBuilder = TeamsActivity.CreateBuilder(existingActivity); + TeamsActivity activity = taBuilder.Build(); + + Assert.Equal("test-id", activity.Id); + Assert.Equal("existing text", activity.Properties["text"]); + } + + [Fact] + public void Constructor_WithNullActivity_ThrowsArgumentNullException() + { + Assert.Throws(() => TeamsActivity.CreateBuilder(null!)); + } + + [Fact] + public void WithId_SetsActivityId() + { + var activity = builder + .WithId("test-activity-id") + .Build(); + + Assert.Equal("test-activity-id", activity.Id); + } + + [Fact] + public void WithServiceUrl_SetsServiceUrl() + { + Uri serviceUrl = new("https://smba.trafficmanager.net/teams/"); + + var activity = builder + .WithServiceUrl(serviceUrl) + .Build(); + + Assert.Equal(serviceUrl, activity.ServiceUrl); + } + + [Fact] + public void WithChannelId_SetsChannelId() + { + var activity = builder + .WithChannelId("msteams") + .Build(); + + Assert.Equal("msteams", activity.ChannelId); + } + + [Fact] + public void WithType_SetsActivityType() + { + var activity = builder + .WithType(ActivityType.Message) + .Build(); + + Assert.Equal(ActivityType.Message, activity.Type); + } + + [Fact] + public void WithText_SetsTextContent() + { + var activity = builder + .WithText("Hello, World!") + .Build(); + + Assert.Equal("Hello, World!", activity.Properties["text"]); + } + + [Fact] + public void WithFrom_SetsSenderAccount() + { + TeamsConversationAccount fromAccount = new(new ConversationAccount + { + Id = "sender-id", + Name = "Sender Name" + }); + + var activity = builder + .WithFrom(fromAccount) + .Build(); + + Assert.Equal("sender-id", activity.From.Id); + Assert.Equal("Sender Name", activity.From.Name); + } + + [Fact] + public void WithRecipient_SetsRecipientAccount() + { + TeamsConversationAccount recipientAccount = new(new ConversationAccount + { + Id = "recipient-id", + Name = "Recipient Name" + }); + + var activity = builder + .WithRecipient(recipientAccount) + .Build(); + + Assert.Equal("recipient-id", activity.Recipient.Id); + Assert.Equal("Recipient Name", activity.Recipient.Name); + } + + [Fact] + public void WithConversation_SetsConversationInfo() + { + TeamsConversation conversation = new(new Conversation + { + Id = "conversation-id" + }) + { + TenantId = "tenant-123", + ConversationType = "channel" + }; + + var activity = builder + .WithConversation(conversation) + .Build(); + + Assert.Equal("conversation-id", activity.Conversation.Id); + Assert.Equal("tenant-123", activity.Conversation.TenantId); + Assert.Equal("channel", activity.Conversation.ConversationType); + } + + [Fact] + public void WithChannelData_SetsChannelData() + { + TeamsChannelData channelData = new() + { + TeamsChannelId = "19:channel-id@thread.tacv2", + TeamsTeamId = "19:team-id@thread.tacv2" + }; + + var activity = builder + .WithChannelData(channelData) + .Build(); + + Assert.NotNull(activity.ChannelData); + Assert.Equal("19:channel-id@thread.tacv2", activity.ChannelData.TeamsChannelId); + Assert.Equal("19:team-id@thread.tacv2", activity.ChannelData.TeamsTeamId); + } + + [Fact] + public void WithEntities_SetsEntitiesCollection() + { + EntityList entities = + [ + new ClientInfoEntity + { + Locale = "en-US", + Platform = "Web" + } + ]; + + var activity = builder + .WithEntities(entities) + .Build(); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + Assert.IsType(activity.Entities[0]); + } + + [Fact] + public void WithAttachments_SetsAttachmentsCollection() + { + List attachments = + [ + new() { + ContentType = "application/json", + Name = "test-attachment" + } + ]; + + var activity = builder + .WithAttachments(attachments) + .Build(); + + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + Assert.Equal("application/json", activity.Attachments[0].ContentType); + Assert.Equal("test-attachment", activity.Attachments[0].Name); + } + + [Fact] + public void WithAttachment_SetsSingleAttachment() + { + TeamsAttachment attachment = new() + { + ContentType = "application/json", + Name = "single" + }; + + var activity = builder + .WithAttachment(attachment) + .Build(); + + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + Assert.Equal("single", activity.Attachments[0].Name); + } + + [Fact] + public void AddEntity_AddsEntityToCollection() + { + ClientInfoEntity entity = new() + { + Locale = "en-US", + Country = "US" + }; + + var activity = builder + .AddEntity(entity) + .Build(); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + Assert.IsType(activity.Entities[0]); + } + + [Fact] + public void AddEntity_MultipleEntities_AddsAllToCollection() + { + var activity = builder + .AddEntity(new ClientInfoEntity { Locale = "en-US" }) + .AddEntity(new ProductInfoEntity { Id = "product-123" }) + .Build(); + + Assert.NotNull(activity.Entities); + Assert.Equal(2, activity.Entities.Count); + } + + [Fact] + public void AddAttachment_AddsAttachmentToCollection() + { + TeamsAttachment attachment = new() + { + ContentType = "text/html", + Name = "test.html" + }; + + var activity = builder + .AddAttachment(attachment) + .Build(); + + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + Assert.Equal("text/html", activity.Attachments[0].ContentType); + } + + [Fact] + public void AddAttachment_MultipleAttachments_AddsAllToCollection() + { + var activity = builder + .AddAttachment(new TeamsAttachment { ContentType = "text/html" }) + .AddAttachment(new TeamsAttachment { ContentType = "application/json" }) + .Build(); + + Assert.NotNull(activity.Attachments); + Assert.Equal(2, activity.Attachments.Count); + } + + [Fact] + public void AddAdaptiveCardAttachment_AddsAdaptiveCard() + { + var adaptiveCard = new { type = "AdaptiveCard", version = "1.2" }; + + var activity = builder + .AddAdaptiveCardAttachment(adaptiveCard) + .Build(); + + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + Assert.Equal("application/vnd.microsoft.card.adaptive", activity.Attachments[0].ContentType); + Assert.Same(adaptiveCard, activity.Attachments[0].Content); + } + + [Fact] + public void WithAdaptiveCardAttachment_ConfigureActionAppliesChanges() + { + var adaptiveCard = new { type = "AdaptiveCard" }; + + var activity = builder + .WithAdaptiveCardAttachment(adaptiveCard, b => b.WithName("feedback")) + .Build(); + + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + Assert.Equal("feedback", activity.Attachments[0].Name); + } + + [Fact] + public void AddAdaptiveCardAttachment_WithNullPayload_Throws() + { + Assert.Throws(() => builder.AddAdaptiveCardAttachment(null!)); + } + + [Fact] + public void AddMention_WithNullAccount_ThrowsArgumentNullException() + { + Assert.Throws(() => builder.AddMention(null!)); + } + + [Fact] + public void AddMention_WithAccountAndDefaultText_AddsMentionAndUpdatesText() + { + ConversationAccount account = new() + { + Id = "user-123", + Name = "John Doe" + }; + + var activity = builder + .WithText("said hello") + .AddMention(account) + .Build(); + + Assert.Equal("John Doe said hello", activity.Properties["text"]); + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + + MentionEntity? mention = activity.Entities[0] as MentionEntity; + Assert.NotNull(mention); + Assert.Equal("user-123", mention.Mentioned?.Id); + Assert.Equal("John Doe", mention.Mentioned?.Name); + Assert.Equal("John Doe", mention.Text); + } + + [Fact] + public void AddMention_WithCustomText_UsesCustomText() + { + ConversationAccount account = new() + { + Id = "user-123", + Name = "John Doe" + }; + + var activity = builder + .WithText("replied") + .AddMention(account, "CustomName") + .Build(); + + Assert.Equal("CustomName replied", activity.Properties["text"]); + + MentionEntity? mention = activity.Entities![0] as MentionEntity; + Assert.NotNull(mention); + Assert.Equal("CustomName", mention.Text); + } + + [Fact] + public void AddMention_WithAddTextFalse_DoesNotUpdateText() + { + ConversationAccount account = new() + { + Id = "user-123", + Name = "John Doe" + }; + + TeamsActivity activity = builder + .WithText("original text") + .AddMention(account, addText: false) + .Build(); + + Assert.Equal("original text", activity.Properties["text"]); + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + } + + [Fact] + public void AddMention_MultipleMentions_AddsAllMentions() + { + ConversationAccount account1 = new() { Id = "user-1", Name = "User One" }; + ConversationAccount account2 = new() { Id = "user-2", Name = "User Two" }; + + TeamsActivity activity = builder + .WithText("message") + .AddMention(account1) + .AddMention(account2) + .Build(); + + Assert.Equal("User Two User One message", activity.Properties["text"]); + Assert.NotNull(activity.Entities); + Assert.Equal(2, activity.Entities.Count); + } + + [Fact] + public void FluentAPI_CompleteActivity_BuildsCorrectly() + { + TeamsActivity activity = builder + .WithType(ActivityType.Message) + .WithId("activity-123") + .WithChannelId("msteams") + .WithText("Test message") + .WithServiceUrl(new Uri("https://smba.trafficmanager.net/teams/")) + .WithFrom(new TeamsConversationAccount(new ConversationAccount + { + Id = "sender-id", + Name = "Sender" + })) + .WithRecipient(new TeamsConversationAccount(new ConversationAccount + { + Id = "recipient-id", + Name = "Recipient" + })) + .WithConversation(new TeamsConversation(new Conversation + { + Id = "conv-id" + })) + .AddEntity(new ClientInfoEntity { Locale = "en-US" }) + .AddAttachment(new TeamsAttachment { ContentType = "text/html" }) + .AddMention(new ConversationAccount { Id = "user-1", Name = "User" }) + .Build(); + + Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal("activity-123", activity.Id); + Assert.Equal("msteams", activity.ChannelId); + Assert.Equal("User Test message", activity.Properties["text"]); + Assert.Equal("sender-id", activity.From.Id); + Assert.Equal("recipient-id", activity.Recipient.Id); + Assert.Equal("conv-id", activity.Conversation.Id); + Assert.NotNull(activity.Entities); + Assert.Equal(2, activity.Entities.Count); // ClientInfo + Mention + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + } + + [Fact] + public void FluentAPI_MethodChaining_ReturnsBuilderInstance() + { + + TeamsActivityBuilder result1 = builder.WithId("id"); + TeamsActivityBuilder result2 = builder.WithText("text"); + TeamsActivityBuilder result3 = builder.WithType(ActivityType.Message); + + Assert.Same(builder, result1); + Assert.Same(builder, result2); + Assert.Same(builder, result3); + } + + [Fact] + public void Build_CalledMultipleTimes_ReturnsSameInstance() + { + builder + .WithId("test-id"); + + TeamsActivity activity1 = builder.Build(); + TeamsActivity activity2 = builder.Build(); + + Assert.Same(activity1, activity2); + } + + [Fact] + public void Builder_ModifyingExistingActivity_PreservesOriginalData() + { + TeamsActivity original = new() + { + Id = "original-id", + Type = ActivityType.Message + }; + original.Properties["text"] = "original text"; + + TeamsActivity modified = TeamsActivity.CreateBuilder(original) + .WithText("modified text") + .Build(); + + Assert.Equal("original-id", modified.Id); + Assert.Equal("modified text", modified.Properties["text"]); + Assert.Equal(ActivityType.Message, modified.Type); + } + + [Fact] + public void AddMention_UpdatesBaseEntityCollection() + { + ConversationAccount account = new() + { + Id = "user-123", + Name = "Test User" + }; + + TeamsActivity activity = builder + .AddMention(account) + .Build(); + + CoreActivity baseActivity = activity; + Assert.NotNull(baseActivity.Entities); + Assert.NotEmpty(baseActivity.Entities); + } + + [Fact] + public void WithChannelData_NullValue_SetsToNull() + { + TeamsActivity activity = builder + .WithChannelData(null!) + .Build(); + + Assert.Null(activity.ChannelData); + } + + [Fact] + public void AddEntity_NullEntitiesCollection_InitializesCollection() + { + TeamsActivity activity = builder.Build(); + + Assert.NotNull(activity.Entities); + + ClientInfoEntity entity = new() { Locale = "en-US" }; + builder.AddEntity(entity); + + TeamsActivity result = builder.Build(); + Assert.NotNull(result.Entities); + Assert.Single(result.Entities); + } + + [Fact] + public void AddAttachment_NullAttachmentsCollection_InitializesCollection() + { + TeamsActivity activity = builder.Build(); + + Assert.NotNull(activity.Attachments); + + TeamsAttachment attachment = new() { ContentType = "text/html" }; + builder.AddAttachment(attachment); + + TeamsActivity result = builder.Build(); + Assert.NotNull(result.Attachments); + Assert.Single(result.Attachments); + } + + [Fact] + public void Builder_EmptyText_AddMention_PrependsMention() + { + ConversationAccount account = new() + { + Id = "user-123", + Name = "User" + }; + + TeamsActivity activity = builder + .AddMention(account) + .Build(); + + Assert.Equal("User ", activity.Properties["text"]); + } + + [Fact] + public void WithConversationReference_WithNullActivity_ThrowsArgumentNullException() + { + Assert.Throws(() => builder.WithConversationReference(null!)); + } + + [Fact] + public void WithConversationReference_WithNullChannelId_ThrowsArgumentNullException() + { + + TeamsActivity sourceActivity = new() + { + ChannelId = null, + ServiceUrl = new Uri("https://test.com"), + Conversation = new TeamsConversation(new Conversation()), + From = new TeamsConversationAccount(new ConversationAccount()), + Recipient = new TeamsConversationAccount(new ConversationAccount()) + }; + + Assert.Throws(() => builder.WithConversationReference(sourceActivity)); + } + + [Fact] + public void WithConversationReference_WithNullServiceUrl_ThrowsArgumentNullException() + { + TeamsActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = null, + Conversation = new TeamsConversation(new Conversation()), + From = new TeamsConversationAccount(new ConversationAccount()), + Recipient = new TeamsConversationAccount(new ConversationAccount()) + }; + + Assert.Throws(() => builder.WithConversationReference(sourceActivity)); + } + + [Fact] + public void WithConversationReference_WithEmptyConversationId_DoesNotThrow() + { + TeamsActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = new Uri("https://test.com"), + Conversation = new TeamsConversation(new Conversation()), + From = new TeamsConversationAccount(new ConversationAccount { Id = "user-1" }), + Recipient = new TeamsConversationAccount(new ConversationAccount { Id = "bot-1" }) + }; + + TeamsActivity result = builder.WithConversationReference(sourceActivity).Build(); + + Assert.NotNull(result.Conversation); + } + + [Fact] + public void WithConversationReference_WithEmptyFromId_DoesNotThrow() + { + TeamsActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = new Uri("https://test.com"), + Conversation = new TeamsConversation(new Conversation { Id = "conv-1" }), + From = new TeamsConversationAccount(new ConversationAccount()), + Recipient = new TeamsConversationAccount(new ConversationAccount { Id = "bot-1" }) + }; + + TeamsActivity result = builder.WithConversationReference(sourceActivity).Build(); + + Assert.NotNull(result.From); + } + + [Fact] + public void WithConversationReference_WithEmptyRecipientId_DoesNotThrow() + { + TeamsActivity sourceActivity = new() + { + ChannelId = "msteams", + ServiceUrl = new Uri("https://test.com"), + Conversation = new TeamsConversation(new Conversation { Id = "conv-1" }), + From = new TeamsConversationAccount(new ConversationAccount { Id = "user-1" }), + Recipient = new TeamsConversationAccount(new ConversationAccount()) + }; + + TeamsActivity result = builder.WithConversationReference(sourceActivity).Build(); + + Assert.NotNull(result.Recipient); + } + + [Fact] + public void WithFrom_WithBaseConversationAccount_ConvertsToTeamsConversationAccount() + { + ConversationAccount baseAccount = new() + { + Id = "user-123", + Name = "User Name" + }; + + TeamsActivity activity = builder + .WithFrom(baseAccount) + .Build(); + + Assert.IsType(activity.From); + Assert.Equal("user-123", activity.From.Id); + Assert.Equal("User Name", activity.From.Name); + } + + [Fact] + public void WithRecipient_WithBaseConversationAccount_ConvertsToTeamsConversationAccount() + { + ConversationAccount baseAccount = new() + { + Id = "bot-123", + Name = "Bot Name" + }; + + TeamsActivity activity = builder + .WithRecipient(baseAccount) + .Build(); + + Assert.IsType(activity.Recipient); + Assert.Equal("bot-123", activity.Recipient.Id); + Assert.Equal("Bot Name", activity.Recipient.Name); + } + + [Fact] + public void WithConversation_WithBaseConversation_ConvertsToTeamsConversation() + { + Conversation baseConversation = new() + { + Id = "conv-123" + }; + + TeamsActivity activity = builder + .WithConversation(baseConversation) + .Build(); + + Assert.IsType(activity.Conversation); + Assert.Equal("conv-123", activity.Conversation.Id); + } + + [Fact] + public void WithEntities_WithNullValue_SetsToNull() + { + TeamsActivity activity = builder + .WithEntities([new ClientInfoEntity()]) + .WithEntities(null!) + .Build(); + + Assert.Null(activity.Entities); + } + + [Fact] + public void WithAttachments_WithNullValue_SetsToNull() + { + TeamsActivity activity = builder + .WithAttachments([new()]) + .WithAttachments(null!) + .Build(); + + Assert.Null(activity.Attachments); + } + + [Fact] + public void AddMention_WithAccountWithNullName_UsesNullText() + { + ConversationAccount account = new() + { + Id = "user-123", + Name = null + }; + + TeamsActivity activity = builder + .WithText("message") + .AddMention(account) + .Build(); + + Assert.Equal(" message", activity.Properties["text"]); + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + } + + [Fact] + public void Build_MultipleCalls_ReturnsRebasedActivity() + { + builder + .AddEntity(new ClientInfoEntity { Locale = "en-US" }); + + TeamsActivity activity1 = builder.Build(); + CoreActivity baseActivity1 = activity1; + Assert.NotNull(baseActivity1.Entities); + + builder.AddEntity(new ProductInfoEntity { Id = "prod-1" }); + TeamsActivity activity2 = builder.Build(); + CoreActivity baseActivity2 = activity2; + + Assert.Same(activity1, activity2); + Assert.NotNull(baseActivity2.Entities); + Assert.Equal(2, activity2.Entities!.Count); + } + + [Fact] + public void IntegrationTest_CreateComplexActivity() + { + Uri serviceUrl = new("https://smba.trafficmanager.net/amer/test/"); + TeamsChannelData channelData = new() + { + TeamsChannelId = "19:channel@thread.tacv2", + TeamsTeamId = "19:team@thread.tacv2" + }; + + TeamsActivity activity = builder + .WithType(ActivityType.Message) + .WithId("msg-001") + .WithServiceUrl(serviceUrl) + .WithChannelId("msteams") + .WithText("Please review this document") + .WithFrom(new TeamsConversationAccount(new ConversationAccount + { + Id = "bot-id", + Name = "Bot" + })) + .WithRecipient(new TeamsConversationAccount(new ConversationAccount + { + Id = "user-id", + Name = "User" + })) + .WithConversation(new TeamsConversation(new Conversation + { + Id = "conv-001" + }) + { + TenantId = "tenant-001", + ConversationType = "channel" + }) + .WithChannelData(channelData) + .AddEntity(new ClientInfoEntity + { + Locale = "en-US", + Country = "US", + Platform = "Web" + }) + .AddAttachment(new TeamsAttachment + { + ContentType = "application/vnd.microsoft.card.adaptive", + Name = "adaptive-card.json" + }) + .AddMention(new ConversationAccount + { + Id = "manager-id", + Name = "Manager" + }, "Manager") + .Build(); + + // Verify all properties + Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal("msg-001", activity.Id); + Assert.Equal(serviceUrl, activity.ServiceUrl); + Assert.Equal("msteams", activity.ChannelId); + Assert.Equal("Manager Please review this document", activity.Properties["text"]); + Assert.Equal("bot-id", activity.From.Id); + Assert.Equal("user-id", activity.Recipient.Id); + Assert.Equal("conv-001", activity.Conversation.Id); + Assert.Equal("tenant-001", activity.Conversation.TenantId); + Assert.Equal("channel", activity.Conversation.ConversationType); + Assert.NotNull(activity.ChannelData); + Assert.Equal("19:channel@thread.tacv2", activity.ChannelData.TeamsChannelId); + Assert.NotNull(activity.Entities); + Assert.Equal(2, activity.Entities.Count); // ClientInfo + Mention + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + } +} diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs new file mode 100644 index 00000000..21a92303 --- /dev/null +++ b/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs @@ -0,0 +1,357 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Nodes; +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.BotApps.Schema.Entities; + +namespace Microsoft.Teams.BotApps.UnitTests; + +public class TeamsActivityTests +{ + + [Fact] + public void DeserializeActivityWithTeamsChannelData() + { + TeamsActivity activityWithTeamsChannelData = CoreActivity.FromJsonString(json); + TeamsChannelData tcd = activityWithTeamsChannelData.ChannelData!; + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.TeamsChannelId); + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.Channel!.Id); + // Assert.Equal("b15a9416-0ad3-4172-9210-7beb711d3f70", activity.From.AadObjectId); + } + + [Fact] + public void DeserializeTeamsActivityWithTeamsChannelData() + { + TeamsActivity activity = CoreActivity.FromJsonString(json); + TeamsChannelData tcd = activity.ChannelData!; + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.TeamsChannelId); + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.Channel!.Id); + Assert.Equal("b15a9416-0ad3-4172-9210-7beb711d3f70", activity.From.AadObjectId); + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", activity.Conversation.Id); + + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + Assert.Equal("text/html", activity.Attachments[0].ContentType); + + Assert.NotNull(activity.Entities); + Assert.Equal(2, activity.Entities.Count); + + } + + [Fact] + public void DownCastTeamsActivity_To_CoreActivity() + { + CoreActivity activity = CoreActivity.FromJsonString(json); + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", activity.Conversation!.Id); + TeamsActivity teamsActivity = TeamsActivity.FromActivity(activity); + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", teamsActivity.Conversation!.Id); + + static void AssertCid(CoreActivity a) + { + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", a.Conversation!.Id); + } + AssertCid(teamsActivity); + + } + + [Fact] + public void AddMentionEntity_To_TeamsActivity() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + activity + .AddMention(new ConversationAccount + { + Id = "user-id-01", + Name = "rido" + }, "ridotest"); + + + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + Assert.Equal("mention", activity.Entities[0].Type); + MentionEntity? mention = activity.Entities[0] as MentionEntity; + Assert.NotNull(mention); + Assert.Equal("user-id-01", mention.Mentioned?.Id); + Assert.Equal("rido", mention.Mentioned?.Name); + Assert.Equal("ridotest", mention.Text); + + string jsonResult = activity.ToJson(); + Assert.Contains("user-id-01", jsonResult); + } + + [Fact] + public void AddMentionEntity_Serialize_From_CoreActivity() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + activity.AddMention(new ConversationAccount + { + Id = "user-id-01", + Name = "rido" + }, "ridotest"); + + + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + Assert.Equal("mention", activity.Entities[0].Type); + MentionEntity? mention = activity.Entities[0] as MentionEntity; + Assert.NotNull(mention); + Assert.Equal("user-id-01", mention.Mentioned?.Id); + Assert.Equal("rido", mention.Mentioned?.Name); + Assert.Equal("ridotest", mention.Text); + + static void SerializeAndAssert(CoreActivity a) + { + string json = a.ToJson(); + Assert.Contains("user-id-01", json); + } + + SerializeAndAssert(activity); + } + + + [Fact] + public void TeamsActivityBuilder_FluentAPI() + { + TeamsActivity activity = TeamsActivity.CreateBuilder() + .WithType(ActivityType.Message) + .WithText("Hello World") + .WithChannelId("msteams") + .AddMention(new ConversationAccount + { + Id = "user-123", + Name = "TestUser" + }) + .Build(); + + Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal("TestUser Hello World", activity.Properties["text"]); + Assert.Equal("msteams", activity.ChannelId); + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + + MentionEntity? mention = activity.Entities[0] as MentionEntity; + Assert.NotNull(mention); + Assert.Equal("user-123", mention.Mentioned?.Id); + Assert.Equal("TestUser", mention.Mentioned?.Name); + } + + [Fact] + public void Deserialize_With_Entities() + { + TeamsActivity activity = CoreActivity.FromJsonString(json); + Assert.NotNull(activity.Entities); + Assert.Equal(2, activity.Entities.Count); + + List mentions = [.. activity.Entities.Where(e => e is MentionEntity)]; + Assert.Single(mentions); + MentionEntity? m1 = mentions[0] as MentionEntity; + Assert.NotNull(m1); + Assert.NotNull(m1.Mentioned); + Assert.Equal("28:0b6fe6d1-fece-44f7-9a48-56465e2d5ab8", m1.Mentioned.Id); + Assert.Equal("ridotest", m1.Mentioned.Name); + Assert.Equal("ridotest", m1.Text); + + List clientInfos = [.. activity.Entities.Where(e => e is ClientInfoEntity)]; + Assert.Single(clientInfos); + ClientInfoEntity? c1 = clientInfos[0] as ClientInfoEntity; + Assert.NotNull(c1); + Assert.Equal("en-US", c1.Locale); + Assert.Equal("US", c1.Country); + Assert.Equal("Web", c1.Platform); + Assert.Equal("America/Los_Angeles", c1.Timezone); + + } + + + [Fact] + public void Deserialize_With_Entities_Extensions() + { + TeamsActivity activity = CoreActivity.FromJsonString(json); + Assert.NotNull(activity.Entities); + Assert.Equal(2, activity.Entities.Count); + + var mentions = activity.GetMentions(); + Assert.Single(mentions); + MentionEntity? m1 = mentions.FirstOrDefault(); + Assert.NotNull(m1); + Assert.NotNull(m1.Mentioned); + Assert.Equal("28:0b6fe6d1-fece-44f7-9a48-56465e2d5ab8", m1.Mentioned.Id); + Assert.Equal("ridotest", m1.Mentioned.Name); + Assert.Equal("ridotest", m1.Text); + + var clientInfo = activity.GetClientInfo(); + Assert.NotNull(clientInfo); + Assert.Equal("en-US", clientInfo.Locale); + Assert.Equal("US", clientInfo.Country); + Assert.Equal("Web", clientInfo.Platform); + Assert.Equal("America/Los_Angeles", clientInfo.Timezone); + } + + [Fact] + public void Serialize_TeamsActivity_WithEntities() + { + TeamsActivity activity = TeamsActivity.CreateBuilder() + .WithType(ActivityType.Message) + .WithText("Hello World") + .WithChannelId("msteams") + .Build(); + + activity.AddClientInfo("Web", "US", "America/Los_Angeles", "en-US"); + + string jsonResult = activity.ToJson(); + Assert.Contains("clientInfo", jsonResult); + Assert.Contains("Web", jsonResult); + Assert.Contains("Hello World", jsonResult); + } + + [Fact] + public void Deserialize_TeamsActivity_WithAttachments() + { + TeamsActivity activity = CoreActivity.FromJsonString(json); + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + TeamsAttachment attachment = activity.Attachments[0] as TeamsAttachment; + Assert.NotNull(attachment); + Assert.Equal("text/html", attachment.ContentType); + Assert.Equal("

ridotest reply to thread

", attachment.Content?.ToString()); + } + + [Fact] + public void Deserialize_TeamsActivity_Invoke_WithValue() + { + //TeamsActivity activity = CoreActivity.FromJsonString(jsonInvoke); + TeamsActivity activity = TeamsActivity.FromActivity(CoreActivity.FromJsonString(jsonInvoke)) ; + Assert.NotNull(activity.Value); + string feedback = activity.Value?["action"]?["data"]?["feedback"]?.ToString()!; + Assert.Equal("test invokes", feedback); + } + + private const string jsonInvoke = """ + { + "type": "invoke", + "channelId": "msteams", + "id": "f:17b96347-e8b4-f340-10bc-eb52fc1a6ad4", + "serviceUrl": "https://smba.trafficmanager.net/amer/56653e9d-2158-46ee-90d7-675c39642038/", + "channelData": { + "tenant": { + "id": "56653e9d-2158-46ee-90d7-675c39642038" + }, + "source": { + "name": "message" + }, + "legacy": { + "replyToId": "1:12SWreU4430kJA9eZCb1kXDuo6A8KdDEGB6d9TkjuDYM" + } + }, + "from": { + "id": "29:1uMVvhoAyfTqdMsyvHL0qlJTTfQF9MOUSI8_cQts2kdSWEZVDyJO2jz-CsNOhQcdYq1Bw4cHT0__O6XDj4AZ-Jw", + "name": "Rido", + "aadObjectId": "c5e99701-2a32-49c1-a660-4629ceeb8c61" + }, + "recipient": { + "id": "28:aabdbd62-bc97-4afb-83ee-575594577de5", + "name": "ridobotlocal" + }, + "conversation": { + "id": "a:17vxw6pGQOb3Zfh8acXT8m_PqHycYpaFgzu2mFMUfkT-h0UskMctq5ZPPc7FIQxn2bx7rBSm5yE_HeUXsCcKZBrv77RgorB3_1_pAdvMhi39ClxQgawzyQ9GBFkdiwOxT", + "conversationType": "personal", + "tenantId": "56653e9d-2158-46ee-90d7-675c39642038" + }, + "entities": [ + { + "locale": "en-US", + "country": "US", + "platform": "Web", + "timezone": "America/Los_Angeles", + "type": "clientInfo" + } + ], + "value": { + "action": { + "type": "Action.Execute", + "title": "Submit Feedback", + "data": { + "feedback": "test invokes" + } + }, + "trigger": "manual" + }, + "name": "adaptiveCard/action", + "timestamp": "2026-01-07T06:04:59.89Z", + "localTimestamp": "2026-01-06T22:04:59.89-08:00", + "replyToId": "1767765488332", + "locale": "en-US", + "localTimezone": "America/Los_Angeles" + } + """; + + private const string json = """ + { + "type": "message", + "channelId": "msteams", + "text": "\u003Cat\u003Eridotest\u003C/at\u003E reply to thread", + "id": "1759944781430", + "serviceUrl": "https://smba.trafficmanager.net/amer/50612dbb-0237-4969-b378-8d42590f9c00/", + "channelData": { + "teamsChannelId": "19:6848757105754c8981c67612732d9aa7@thread.tacv2", + "teamsTeamId": "19:66P469zibfbsGI-_a0aN_toLTZpyzS6u7CT3TsXdgPw1@thread.tacv2", + "channel": { + "id": "19:6848757105754c8981c67612732d9aa7@thread.tacv2" + }, + "team": { + "id": "19:66P469zibfbsGI-_a0aN_toLTZpyzS6u7CT3TsXdgPw1@thread.tacv2" + }, + "tenant": { + "id": "50612dbb-0237-4969-b378-8d42590f9c00" + } + }, + "from": { + "id": "29:17bUvCasIPKfQIXHvNzcPjD86fwm6GkWc1PvCGP2-NSkNb7AyGYpjQ7Xw-XgTwaHW5JxZ4KMNDxn1kcL8fwX1Nw", + "name": "rido", + "aadObjectId": "b15a9416-0ad3-4172-9210-7beb711d3f70" + }, + "recipient": { + "id": "28:0b6fe6d1-fece-44f7-9a48-56465e2d5ab8", + "name": "ridotest" + }, + "conversation": { + "id": "19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", + "isGroup": true, + "conversationType": "channel", + "tenantId": "50612dbb-0237-4969-b378-8d42590f9c00" + }, + "entities": [ + { + "mentioned": { + "id": "28:0b6fe6d1-fece-44f7-9a48-56465e2d5ab8", + "name": "ridotest" + }, + "text": "\u003Cat\u003Eridotest\u003C/at\u003E", + "type": "mention" + }, + { + "locale": "en-US", + "country": "US", + "platform": "Web", + "timezone": "America/Los_Angeles", + "type": "clientInfo" + } + ], + "textFormat": "plain", + "attachments": [ + { + "contentType": "text/html", + "content": "\u003Cp\u003E\u003Cspan itemtype=\u0022http://schema.skype.com/Mention\u0022 itemscope=\u0022\u0022 itemid=\u00220\u0022\u003Eridotest\u003C/span\u003E\u0026nbsp;reply to thread\u003C/p\u003E" + } + ], + "timestamp": "2025-10-08T17:33:01.4953744Z", + "localTimestamp": "2025-10-08T10:33:01.4953744-07:00", + "locale": "en-US", + "localTimezone": "America/Los_Angeles" + } + """; +} diff --git a/core/test/msal-config-api/Program.cs b/core/test/msal-config-api/Program.cs index b79751b4..3d74d6bc 100644 --- a/core/test/msal-config-api/Program.cs +++ b/core/test/msal-config-api/Program.cs @@ -16,16 +16,17 @@ ConversationClient conversationClient = CreateConversationClient(); await conversationClient.SendActivityAsync(new CoreActivity { - Text = "Hello from MSAL Config API test!", Conversation = new() { Id = ConversationId }, ServiceUrl = new Uri(ServiceUrl), - From = new() { Id = FromId } + From = new() { Id = FromId }, + Properties = { { "text", "Test Message" } } + }, cancellationToken: default); await conversationClient.SendActivityAsync(new CoreActivity { - Text = "Hello from MSAL Config API test!", + //Text = "Hello from MSAL Config API test!", Conversation = new() { Id = "bad conversation" }, ServiceUrl = new Uri(ServiceUrl), From = new() { Id = FromId } diff --git a/core/test/msal-config-api/msal-config-api.csproj b/core/test/msal-config-api/msal-config-api.csproj index 23c08aec..f84df78e 100644 --- a/core/test/msal-config-api/msal-config-api.csproj +++ b/core/test/msal-config-api/msal-config-api.csproj @@ -9,8 +9,8 @@ false - - - + + + From 1ac1a075f1914ffa284d178d9a9dec900dc157bf Mon Sep 17 00:00:00 2001 From: Rido Date: Mon, 12 Jan 2026 13:23:49 -0800 Subject: [PATCH 33/69] Return Activity Id From api/messages (#261) BF Adapter base expects an Id in the SendActivity return value. Without this fix, the compat layer throws NRE This pull request introduces several updates to the bot framework sample applications and core libraries, mainly focusing on improving the handling and propagation of `InvokeResponse` objects, refining status codes, and enhancing logging and code structure. The changes help standardize response formats, improve traceability, and clarify code intent. **InvokeResponse Handling and Status Codes** * Added an `Id` property to the `InvokeResponse` class, ensuring responses can be correlated to originating activities, and updated serialization attributes for `Body` and `Type` to ignore nulls for cleaner JSON output. [[1]](diffhunk://#diff-0bb90273f82a3dca26df988769c1097864caf7838c52c6f100bcb52dfffda755R16-R22) [[2]](diffhunk://#diff-0bb90273f82a3dca26df988769c1097864caf7838c52c6f100bcb52dfffda755R34) [[3]](diffhunk://#diff-0bb90273f82a3dca26df988769c1097864caf7838c52c6f100bcb52dfffda755L35-R44) * Standardized and diversified status codes for `InvokeResponse` across sample bots and core libraries (`EchoBot`, `CoreBot`, `TeamsBot`, and core adapter), improving clarity in response semantics. [[1]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL116-R94) [[2]](diffhunk://#diff-b94b53965e9052345453f2ab6bec21420a36c4b67c9a6c568b9c80edcd0882d1L36-R37) [[3]](diffhunk://#diff-691809f7a90c5bda6ee5e4335c2c393864a32101545fb0b35c24bc659623361bL65-R65) [[4]](diffhunk://#diff-ee802b583e856949e14f231284969979f8827efaa484f0b431badb7936809855L81-R91) [[5]](diffhunk://#diff-a67e36b1d9c8013e013bbdef9a54f3051a67f3905405e6ce85ca46f8b50a73a8L53-R53) **Refactoring and Code Structure** * Moved proactive message send/update/delete logic in `EchoBot` to a dedicated helper method (`SendUpdateDeleteActivityAsync`), improving code readability and maintainability. [[1]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL42-R40) [[2]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aR115-R141) * Minor code cleanup in `EchoBot.cs`, such as removing unused `using` statements. **Logging and Diagnostics** * Enhanced logging in `CompatBotAdapter` to provide better traceability of activity responses, replacing a warning for null responses with information logs and always assigning the response ID. **Other Improvements** * Added null-handling and improved response assignment in activity deletion logic for the compat adapter. These updates collectively improve the reliability, maintainability, and clarity of bot applications and supporting libraries. --- core/samples/AFBot/Program.cs | 2 - core/samples/CompatBot/EchoBot.cs | 57 +++++++------- core/samples/CoreBot/Program.cs | 1 - core/samples/TeamsBot/Program.cs | 8 +- .../CompatAdapter.cs | 19 +---- .../CompatBotAdapter.cs | 77 +++++++++++++++---- core/src/Microsoft.Bot.Core/BotApplication.cs | 11 +-- .../Microsoft.Bot.Core/ConversationClient.cs | 37 ++++----- .../Hosting/AddBotApplicationExtensions.cs | 21 ++--- .../src/Microsoft.Bot.Core/ITurnMiddleWare.cs | 2 +- core/src/Microsoft.Bot.Core/InvokeResponse.cs | 36 --------- .../Microsoft.Bot.Core/Schema/ActivityType.cs | 5 -- core/src/Microsoft.Bot.Core/TurnMiddleware.cs | 25 ++---- .../Handlers/InvokeHandler.cs | 35 ++++++++- .../Schema/TeamsActivityType.cs | 2 +- .../TeamsBotApplication.cs | 17 ++-- .../TeamsBotApplicationBuilder.cs | 9 +-- .../BotApplicationTests.cs | 8 +- .../MiddlewareTests.cs | 4 +- .../Schema/CoreActivityTests.cs | 2 +- 20 files changed, 187 insertions(+), 191 deletions(-) delete mode 100644 core/src/Microsoft.Bot.Core/InvokeResponse.cs diff --git a/core/samples/AFBot/Program.cs b/core/samples/AFBot/Program.cs index d37307b2..5672f828 100644 --- a/core/samples/AFBot/Program.cs +++ b/core/samples/AFBot/Program.cs @@ -57,8 +57,6 @@ var res = await botApp.SendActivityAsync(replyActivity, cancellationToken); Console.WriteLine("SENT >>> => " + res?.Id); - return null!; - }; webApp.Run(); diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 5340200b..247a68c6 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -2,13 +2,11 @@ // Licensed under the MIT License. using Microsoft.Bot.Builder; -using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; using Microsoft.Bot.Builder.Teams; using Microsoft.Bot.Connector; using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Bot.Schema.Teams; -using Newtonsoft.Json; using Newtonsoft.Json.Linq; namespace CompatBot; @@ -35,32 +33,11 @@ protected override async Task OnMessageActivityAsync(ITurnContext().Conversations; + //var conversationClient = turnContext.TurnState.Get().Conversations; - var cr = turnContext.Activity.GetConversationReference(); - var reply = Activity.CreateMessageActivity(); - reply.ApplyConversationReference(cr, isIncoming: false); - reply.Text = "This is a proactive message sent using the Conversations API."; - - var res = await conversationClient.SendToConversationAsync(cr.Conversation.Id, (Activity)reply, cancellationToken); - - await Task.Delay(2000, cancellationToken); - - await conversationClient.UpdateActivityAsync(cr.Conversation.Id, res.Id!, new Activity - { - Id = res.Id, - ServiceUrl = turnContext.Activity.ServiceUrl, - Type = ActivityType.Message, - Text = "This message has been updated.", - }, cancellationToken); - - await Task.Delay(2000, cancellationToken); - - await conversationClient.DeleteActivityAsync(cr.Conversation.Id, res.Id!, cancellationToken); - - await turnContext.SendActivityAsync(MessageFactory.Text("Proactive message sent and deleted."), cancellationToken); + // await SendUpdateDeleteActivityAsync(turnContext, conversationClient, cancellationToken); var attachment = new Attachment { @@ -72,6 +49,7 @@ protected override async Task OnMessageActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) { await turnContext.SendActivityAsync(MessageFactory.Text("Message reaction received."), cancellationToken); @@ -134,4 +112,31 @@ protected override async Task OnTeamsMeetingStartAsync(MeetingStartEventDetails await turnContext.SendActivityAsync(MessageFactory.Text("Welcome to meeting: "), cancellationToken); await turnContext.SendActivityAsync(MessageFactory.Text($"{meeting.Title} {meeting.MeetingType}"), cancellationToken); } + + private static async Task SendUpdateDeleteActivityAsync(ITurnContext turnContext, IConversations conversationClient, CancellationToken cancellationToken) + { + var cr = turnContext.Activity.GetConversationReference(); + var reply = Activity.CreateMessageActivity(); + reply.ApplyConversationReference(cr, isIncoming: false); + reply.Text = "This is a proactive message sent using the Conversations API."; + + var res = await conversationClient.SendToConversationAsync(cr.Conversation.Id, (Activity)reply, cancellationToken); + + await Task.Delay(2000, cancellationToken); + + await conversationClient.UpdateActivityAsync(cr.Conversation.Id, res.Id!, new Activity + { + Id = res.Id, + ServiceUrl = turnContext.Activity.ServiceUrl, + Type = ActivityType.Message, + Text = "This message has been updated.", + }, cancellationToken); + + await Task.Delay(2000, cancellationToken); + + await conversationClient.DeleteActivityAsync(cr.Conversation.Id, res.Id!, cancellationToken); + + await turnContext.SendActivityAsync(MessageFactory.Text("Proactive message sent and deleted."), cancellationToken); + } + } diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index ddd05d10..956672b5 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -34,7 +34,6 @@ .Build(); await botApp.SendActivityAsync(replyActivity, cancellationToken); - return null!; }; webApp.Run(); diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 2619024b..67ce0238 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -1,11 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Runtime.InteropServices.JavaScript; -using System.Text.Json; -using System.Text.Json.Nodes; -using Microsoft.Bot.Core; using Microsoft.Teams.BotApps; +using Microsoft.Teams.BotApps.Handlers; using Microsoft.Teams.BotApps.Schema; using Microsoft.Teams.BotApps.Schema.Entities; using TeamsBot; @@ -62,8 +59,9 @@ await context.SendActivityAsync(reply, cancellationToken); - return new InvokeResponse(200) + return new CoreInvokeResponse(200) { + Type = "application/vnd.microsoft.activity.message", Body = "Invokes are great !!" }; }; diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs index f41ef39c..362f3b7f 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs @@ -64,7 +64,6 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons ArgumentNullException.ThrowIfNull(httpResponse); ArgumentNullException.ThrowIfNull(bot); CoreActivity? coreActivity = null; - botApplication.OnActivity = async (activity, cancellationToken1) => { coreActivity = activity; @@ -73,17 +72,6 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons CompatConnectorClient connectionClient = new(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); turnContext.TurnState.Add(connectionClient); await bot.OnTurnAsync(turnContext, cancellationToken1).ConfigureAwait(false); - var invokeResponseAct = turnContext.TurnState.Get(BotAdapter.InvokeResponseKey); - if (invokeResponseAct is not null) - { - JObject valueObj = (JObject)invokeResponseAct.Value; - var body = valueObj["Body"]?.ToString(); - return new InvokeResponse(200) - { - Body = body, - }; - } - return null; }; try @@ -93,12 +81,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons botApplication.Use(new CompatMiddlewareAdapter(middleware)); } - var invokeResponse = await botApplication.ProcessAsync(httpRequest.HttpContext, cancellationToken).ConfigureAwait(false); - if (invokeResponse is not null) - { - httpResponse.StatusCode = invokeResponse.Status; - await httpResponse.WriteAsJsonAsync(invokeResponse, cancellationToken).ConfigureAwait(false); - } + await botApplication.ProcessAsync(httpRequest.HttpContext, cancellationToken).ConfigureAwait(false); } catch (Exception ex) { diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs index 2f8d1506..f1f74a46 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs @@ -1,10 +1,14 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Text.Json; +using Microsoft.AspNetCore.Http; using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Extensions.Logging; +using Newtonsoft.Json; namespace Microsoft.Bot.Core.Compat; @@ -17,9 +21,10 @@ namespace Microsoft.Bot.Core.Compat; /// This class is intended for scenarios where integration with non-standard bot runtimes or legacy systems is /// required. /// The bot application instance used to process and send activities within the adapter. +/// The HTTP context accessor used to retrieve the current HTTP context. /// The [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] -public class CompatBotAdapter(BotApplication botApplication, ILogger logger = default!) : BotAdapter +public class CompatBotAdapter(BotApplication botApplication, IHttpContextAccessor httpContextAccessor = default!, ILogger logger = default!) : BotAdapter { /// /// Deletes an activity from the conversation. @@ -42,32 +47,33 @@ public override async Task DeleteActivityAsync(ITurnContext turnContext, Convers /// /// /// - public override async Task SendActivitiesAsync(ITurnContext turnContext, Activity[] activities, CancellationToken cancellationToken) + public override async Task SendActivitiesAsync(ITurnContext turnContext, Activity[] activities, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(activities); ArgumentNullException.ThrowIfNull(turnContext); - Microsoft.Bot.Schema.ResourceResponse[] responses = new Microsoft.Bot.Schema.ResourceResponse[1]; + ResourceResponse[] responses = new Microsoft.Bot.Schema.ResourceResponse[activities.Length]; + for (int i = 0; i < activities.Length; i++) { - CoreActivity a = activities[i].FromCompatActivity(); + var activity = activities[i]; - if (a.Type == "invokeResponse") + if (activity.Type == ActivityTypes.Trace) { - turnContext.TurnState.Add(BotAdapter.InvokeResponseKey, a.ToCompatActivity()); + return [new ResourceResponse() { Id = null }]; } - SendActivityResponse? resp = await botApplication.SendActivityAsync(a, cancellationToken).ConfigureAwait(false); - if (resp is not null) - { - responses[i] = new Microsoft.Bot.Schema.ResourceResponse() { Id = resp.Id }; - } - else + if (activity.Type == "invokeResponse") { - logger.LogWarning("Found null ResourceResponse after calling SendActivityAsync"); + await WriteInvokeResponseToHttpResponseAsync(activity.Value as InvokeResponse, cancellationToken).ConfigureAwait(false); + return [new ResourceResponse() { Id = null } ]; } + SendActivityResponse? resp = await botApplication.SendActivityAsync(activity.FromCompatActivity(), cancellationToken).ConfigureAwait(false); + + logger.LogInformation("Resp from SendActivitiesAsync: {RespId}", resp?.Id); + responses[i] = new Microsoft.Bot.Schema.ResourceResponse() { Id = resp?.Id }; } return responses; } @@ -91,5 +97,50 @@ public override async Task UpdateActivityAsync(ITurnContext tu return new ResourceResponse() { Id = res.Id }; } + private async Task WriteInvokeResponseToHttpResponseAsync(InvokeResponse? invokeResponse, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(invokeResponse); + var response = httpContextAccessor?.HttpContext?.Response; + ArgumentNullException.ThrowIfNull(response); + + using StreamWriter httpResponseStreamWriter = new (response.BodyWriter.AsStream()); + using JsonTextWriter httpResponseJsonWriter = new (httpResponseStreamWriter); + Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(httpResponseJsonWriter, invokeResponse.Body); + } + + //#pragma warning disable CA1869 // Cache and reuse 'JsonSerializerOptions' instances + // var options = new JsonSerializerOptions + // { + // PropertyNamingPolicy = JsonNamingPolicy.CamelCase, + // DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull, + // Converters = { + // new System.Text.Json.Serialization.JsonStringEnumConverter(JsonNamingPolicy.CamelCase), + // } + // }; + //#pragma warning restore CA1869 // Cache and reuse 'JsonSerializerOptions' instances + + // string jsonBody = System.Text.Json.JsonSerializer.Serialize(invokeResponse.Body, options); + + // response.StatusCode = invokeResponse.Status; + // response.ContentType = "application/json"; + // await response.WriteAsync(jsonBody, cancellationToken).ConfigureAwait(false); + + + //using StreamWriter sw = new StreamWriter(response.BodyWriter.AsStream()); + //using JsonWriter jw = new JsonTextWriter(sw); + //Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(jw, invokeResponse.Body); + + //JsonSerializerOptions options = new() + //{ + // PropertyNamingPolicy = JsonNamingPolicy.CamelCase, + // DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull, + // Converters = { + // new System.Text.Json.Serialization.JsonStringEnumConverter(JsonNamingPolicy.CamelCase), + // new AttachmentMemoryStreamConverter(), + // new AttachmentContentConverter() } + //}; + + //await response.WriteAsJsonAsync(invokeResponse.Body, options, cancellationToken).ConfigureAwait(false); + } diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs index 97b23022..9abfcb9c 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -56,7 +56,7 @@ public BotApplication(ConversationClient conversationClient, IConfiguration conf /// Assign a delegate to process activities as they are received. The delegate should accept an /// and a , and return a representing the /// asynchronous operation. If , incoming activities will not be handled. - public Func>? OnActivity { get; set; } + public Func? OnActivity { get; set; } /// /// Processes an incoming HTTP request containing a bot activity. @@ -66,13 +66,11 @@ public BotApplication(ConversationClient conversationClient, IConfiguration conf /// /// /// - public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancellationToken = default) + public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(httpContext); ArgumentNullException.ThrowIfNull(_conversationClient); - InvokeResponse? invokeResponse = null; - _logger.LogDebug("Start processing HTTP request for activity"); CoreActivity activity = await CoreActivity.FromJsonStreamAsync(httpContext.Request.Body, cancellationToken).ConfigureAwait(false) ?? throw new InvalidOperationException("Invalid Activity"); @@ -88,7 +86,7 @@ public BotApplication(ConversationClient conversationClient, IConfiguration conf { try { - invokeResponse = await MiddleWare.RunPipelineAsync(this, activity, this.OnActivity, 0, cancellationToken).ConfigureAwait(false); + await MiddleWare.RunPipelineAsync(this, activity, this.OnActivity, 0, cancellationToken).ConfigureAwait(false); } catch (Exception ex) { @@ -99,7 +97,6 @@ public BotApplication(ConversationClient conversationClient, IConfiguration conf { _logger.LogInformation("Finished processing activity {Type} {Id}", activity.Type, activity.Id); } - return invokeResponse; } } @@ -129,8 +126,6 @@ public ITurnMiddleWare Use(ITurnMiddleWare middleware) return await _conversationClient.SendActivityAsync(activity, cancellationToken: cancellationToken).ConfigureAwait(false); } - - /// /// Gets the version of the SDK. /// diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index 727a31b9..570d254b 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -43,11 +43,6 @@ public async Task SendActivityAsync(CoreActivity activity, ArgumentNullException.ThrowIfNullOrWhiteSpace(activity.Conversation.Id); ArgumentNullException.ThrowIfNull(activity.ServiceUrl); - if (activity.Type == "invokeResponse") - { - return new SendActivityResponse(); - } - string url = $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{activity.Conversation.Id}/activities/"; string body = activity.ToJson(); @@ -75,8 +70,8 @@ public async Task SendActivityAsync(CoreActivity activity, /// Thrown if the activity could not be updated successfully. public async Task UpdateActivityAsync(string conversationId, string activityId, CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); - ArgumentNullException.ThrowIfNullOrWhiteSpace(activityId); + ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentException.ThrowIfNullOrWhiteSpace(activityId); ArgumentNullException.ThrowIfNull(activity); ArgumentNullException.ThrowIfNull(activity.ServiceUrl); @@ -109,8 +104,8 @@ public async Task UpdateActivityAsync(string conversatio /// Thrown if the activity could not be deleted successfully. public async Task DeleteActivityAsync(string conversationId, string activityId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); - ArgumentNullException.ThrowIfNullOrWhiteSpace(activityId); + ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentException.ThrowIfNullOrWhiteSpace(activityId); ArgumentNullException.ThrowIfNull(serviceUrl); string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/activities/{activityId}"; @@ -138,9 +133,9 @@ await SendHttpRequestAsync( public async Task DeleteActivityAsync(CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(activity); - ArgumentNullException.ThrowIfNullOrWhiteSpace(activity.Id); + ArgumentException.ThrowIfNullOrWhiteSpace(activity.Id); ArgumentNullException.ThrowIfNull(activity.Conversation); - ArgumentNullException.ThrowIfNullOrWhiteSpace(activity.Conversation.Id); + ArgumentException.ThrowIfNullOrWhiteSpace(activity.Conversation.Id); ArgumentNullException.ThrowIfNull(activity.ServiceUrl); await DeleteActivityAsync( @@ -164,7 +159,7 @@ await DeleteActivityAsync( /// Thrown if the members could not be retrieved successfully. public async Task> GetConversationMembersAsync(string conversationId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(serviceUrl); string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/members"; @@ -194,9 +189,9 @@ public async Task> GetConversationMembersAsync(string /// public async Task GetConversationMemberAsync(string conversationId, string userId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(serviceUrl); - ArgumentNullException.ThrowIfNullOrWhiteSpace(userId); + ArgumentException.ThrowIfNullOrWhiteSpace(userId); string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/members/{userId}"; @@ -257,8 +252,8 @@ public async Task GetConversationsAsync(Uri serviceUrl /// Thrown if the activity members could not be retrieved successfully. public async Task> GetActivityMembersAsync(string conversationId, string activityId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); - ArgumentNullException.ThrowIfNullOrWhiteSpace(activityId); + ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentException.ThrowIfNullOrWhiteSpace(activityId); ArgumentNullException.ThrowIfNull(serviceUrl); string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/activities/{activityId}/members"; @@ -318,7 +313,7 @@ public async Task CreateConversationAsync(Conversati /// Thrown if the conversation members could not be retrieved successfully. public async Task GetConversationPagedMembersAsync(string conversationId, Uri serviceUrl, int? pageSize = null, string? continuationToken = null, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(serviceUrl); string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/pagedmembers"; @@ -363,8 +358,8 @@ public async Task GetConversationPagedMembersAsync(string co /// If the deleted member was the last member of the conversation, the conversation is also deleted. public async Task DeleteConversationMemberAsync(string conversationId, string memberId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); - ArgumentNullException.ThrowIfNullOrWhiteSpace(memberId); + ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentException.ThrowIfNullOrWhiteSpace(memberId); ArgumentNullException.ThrowIfNull(serviceUrl); string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/members/{memberId}"; @@ -395,7 +390,7 @@ await SendHttpRequestAsync( /// Activities in the transcript must have unique IDs and appropriate timestamps for proper rendering. public async Task SendConversationHistoryAsync(string conversationId, Transcript transcript, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(transcript); ArgumentNullException.ThrowIfNull(serviceUrl); @@ -427,7 +422,7 @@ public async Task SendConversationHistoryAsync( /// This is useful for storing data in a compliant store when dealing with enterprises. public async Task UploadAttachmentAsync(string conversationId, AttachmentData attachmentData, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(conversationId); + ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(attachmentData); ArgumentNullException.ThrowIfNull(serviceUrl); diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 458497ff..7d372236 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -47,13 +47,9 @@ public static TApp UseBotApplication( TApp app = builder.ApplicationServices.GetService() ?? throw new InvalidOperationException("Application not registered"); WebApplication? webApp = builder as WebApplication; ArgumentNullException.ThrowIfNull(webApp); - webApp.MapPost(routePath, async (HttpContext httpContext, CancellationToken cancellationToken) => - { - // TODO: BotFramework used to return activity.id if incoming activity was not "Invoke". - // We don't know if that is required. - InvokeResponse? resp = await app.ProcessAsync(httpContext, cancellationToken).ConfigureAwait(false); - return resp; - }).RequireAuthorization(); + webApp.MapPost(routePath, (HttpContext httpContext, CancellationToken cancellationToken) + => app.ProcessAsync(httpContext, cancellationToken) + ).RequireAuthorization(); return app; } @@ -68,7 +64,6 @@ public static TApp UseBotApplication( public static IServiceCollection AddBotApplication(this IServiceCollection services, string sectionName = "AzureAd") where TApp : BotApplication { ILogger logger = services.BuildServiceProvider().GetRequiredService>(); - services.AddAuthorization(logger, sectionName); services.AddConversationClient(sectionName); services.AddSingleton(); @@ -157,9 +152,9 @@ private static IServiceCollection ConfigureMSALFromConfig(this IServiceCollectio private static IServiceCollection ConfigureMSALWithSecret(this IServiceCollection services, string tenantId, string clientId, string clientSecret) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(tenantId); - ArgumentNullException.ThrowIfNullOrWhiteSpace(clientId); - ArgumentNullException.ThrowIfNullOrWhiteSpace(clientSecret); + ArgumentException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentException.ThrowIfNullOrWhiteSpace(clientId); + ArgumentException.ThrowIfNullOrWhiteSpace(clientSecret); services.Configure(MsalConfigKey, options => { @@ -180,8 +175,8 @@ private static IServiceCollection ConfigureMSALWithSecret(this IServiceCollectio private static IServiceCollection ConfigureMSALWithFIC(this IServiceCollection services, string tenantId, string clientId, string? ficClientId) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(tenantId); - ArgumentNullException.ThrowIfNullOrWhiteSpace(clientId); + ArgumentException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentException.ThrowIfNullOrWhiteSpace(clientId); CredentialDescription ficCredential = new() { diff --git a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs index cbf32992..2ff8d5f8 100644 --- a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs +++ b/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs @@ -12,7 +12,7 @@ namespace Microsoft.Bot.Core; /// The cancellation token should be observed to support cooperative cancellation. /// A cancellation token that can be used to cancel the asynchronous operation. /// A task that represents the completion of the middleware invocation. -public delegate Task NextTurn(CancellationToken cancellationToken); +public delegate Task NextTurn(CancellationToken cancellationToken); /// /// Defines a middleware component that can process or modify activities during a bot turn. diff --git a/core/src/Microsoft.Bot.Core/InvokeResponse.cs b/core/src/Microsoft.Bot.Core/InvokeResponse.cs deleted file mode 100644 index 804321f2..00000000 --- a/core/src/Microsoft.Bot.Core/InvokeResponse.cs +++ /dev/null @@ -1,36 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -namespace Microsoft.Bot.Core; - -/// -/// Represents the response returned from an invocation handler. -/// -/// -/// Creates a new instance of the class with the specified status code and optional body. -/// -/// -/// -public class InvokeResponse(int status, object? body = null) -{ - /// - /// Status code of the response. - /// - [JsonPropertyName("status")] - public int Status { get; set; } = status; - - // TODO: This is strange - Should this be Value or Body? - /// - /// Gets or sets the message body content. - /// - [JsonPropertyName("value")] - public object? Body { get; set; } = body; - - // TODO: Get confirmation that this should be "Type" - // This particular type should be for AC responses - /// - /// Gets or Sets the Type - /// - [JsonPropertyName("type")] - public string? Type { get; set; } = "application/vnd.microsoft.activity.message"; -} diff --git a/core/src/Microsoft.Bot.Core/Schema/ActivityType.cs b/core/src/Microsoft.Bot.Core/Schema/ActivityType.cs index 93baec63..ab86f26a 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ActivityType.cs +++ b/core/src/Microsoft.Bot.Core/Schema/ActivityType.cs @@ -18,9 +18,4 @@ public static class ActivityType /// Represents a typing indicator activity. /// public const string Typing = "typing"; - - /// - /// Represents an invoke activity. - /// - public const string Invoke = "invoke"; } diff --git a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs index d3968077..5a1ae039 100644 --- a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs +++ b/core/src/Microsoft.Bot.Core/TurnMiddleware.cs @@ -2,51 +2,36 @@ // Licensed under the MIT License. using System.Collections; - using Microsoft.Bot.Core.Schema; namespace Microsoft.Bot.Core; internal sealed class TurnMiddleware : ITurnMiddleWare, IEnumerable { - private readonly IList _middlewares = []; internal TurnMiddleware Use(ITurnMiddleWare middleware) { _middlewares.Add(middleware); return this; } - - public async Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn next, CancellationToken cancellationToken = default) { await RunPipelineAsync(botApplication, activity, null!, 0, cancellationToken).ConfigureAwait(false); await next(cancellationToken).ConfigureAwait(false); } - public async Task RunPipelineAsync(BotApplication botApplication, CoreActivity activity, Func>? callback, int nextMiddlewareIndex, CancellationToken cancellationToken) + public Task RunPipelineAsync(BotApplication botApplication, CoreActivity activity, Func? callback, int nextMiddlewareIndex, CancellationToken cancellationToken) { - InvokeResponse? invokeResponse = null; if (nextMiddlewareIndex == _middlewares.Count) { - if (callback is not null) - { - invokeResponse = await callback(activity, cancellationToken).ConfigureAwait(false); - } - return invokeResponse; + return callback is not null ? callback!(activity, cancellationToken) ?? Task.CompletedTask : Task.CompletedTask; } - ITurnMiddleWare nextMiddleware = _middlewares[nextMiddlewareIndex]; - await nextMiddleware.OnTurnAsync( + return nextMiddleware.OnTurnAsync( botApplication, activity, - async (ct) => { - invokeResponse = await RunPipelineAsync(botApplication, activity, callback, nextMiddlewareIndex + 1, ct).ConfigureAwait(false); - return invokeResponse; - }, - cancellationToken).ConfigureAwait(false); - - return invokeResponse; + (ct) => RunPipelineAsync(botApplication, activity, callback, nextMiddlewareIndex + 1, ct), + cancellationToken); } public IEnumerator GetEnumerator() diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs b/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs index 0053323b..f0da1252 100644 --- a/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs +++ b/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs @@ -14,7 +14,40 @@ namespace Microsoft.Teams.BotApps.Handlers; /// A cancellation token that can be used to cancel the operation. The default value is . /// A task that represents the asynchronous operation. The task result contains the response to the invocation. -public delegate Task InvokeHandler(Context context, CancellationToken cancellationToken = default); +public delegate Task InvokeHandler(Context context, CancellationToken cancellationToken = default); +/// +/// Represents the response returned from an invocation handler. +/// +/// +/// Creates a new instance of the class with the specified status code and optional body. +/// +/// +/// +public class CoreInvokeResponse(int status, object? body = null) +{ + /// + /// Status code of the response. + /// + [JsonPropertyName("status")] + public int Status { get; set; } = status; + + // TODO: This is strange - Should this be Value or Body? + /// + /// Gets or sets the message body content. + /// + [JsonPropertyName("value")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public object? Body { get; set; } = body; + + // TODO: Get confirmation that this should be "Type" + // This particular type should be for AC responses + /// + /// Gets or Sets the Type + /// + [JsonPropertyName("type")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Type { get; set; } +} diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs index 2536d9e3..93d20319 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs @@ -26,7 +26,7 @@ public static class TeamsActivityType /// /// Represents an invoke activity. /// - public const string Invoke = ActivityType.Invoke; + public const string Invoke = "invoke"; /// /// Conversation update activity type. diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs index 6f7677d7..05a52da8 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using Microsoft.AspNetCore.Http; using Microsoft.Bot.Core; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; @@ -44,13 +45,13 @@ public class TeamsBotApplication : BotApplication public ConversationUpdateHandler? OnConversationUpdate { get; set; } /// /// + /// /// /// - public TeamsBotApplication(ConversationClient conversationClient, IConfiguration config, ILogger logger, string sectionName = "AzureAd") : base(conversationClient, config, logger, sectionName) + public TeamsBotApplication(ConversationClient conversationClient, IConfiguration config, IHttpContextAccessor httpContextAccessor, ILogger logger, string sectionName = "AzureAd") : base(conversationClient, config, logger, sectionName) { OnActivity = async (activity, cancellationToken) => { - InvokeResponse? invokeResponse = null; logger.LogInformation("New {Type} activity received.", activity.Type); TeamsActivity teamsActivity = TeamsActivity.FromActivity(activity); Context context = new(this, teamsActivity); @@ -61,7 +62,7 @@ public TeamsBotApplication(ConversationClient conversationClient, IConfiguration if (teamsActivity.Type == TeamsActivityType.InstallationUpdate && OnInstallationUpdate is not null) { await OnInstallationUpdate.Invoke(new InstallationUpdateArgs(teamsActivity), context, cancellationToken).ConfigureAwait(false); - + } if (teamsActivity.Type == TeamsActivityType.MessageReaction && OnMessageReaction is not null) { @@ -73,10 +74,14 @@ public TeamsBotApplication(ConversationClient conversationClient, IConfiguration } if (teamsActivity.Type == TeamsActivityType.Invoke && OnInvoke is not null) { - invokeResponse = await OnInvoke.Invoke(context, cancellationToken).ConfigureAwait(false); - + var invokeResponse = await OnInvoke.Invoke(context, cancellationToken).ConfigureAwait(false); + var httpContext = httpContextAccessor.HttpContext; + if (httpContext is not null) + { + httpContext.Response.StatusCode = invokeResponse.Status; + await httpContext.Response.WriteAsJsonAsync(invokeResponse, cancellationToken).ConfigureAwait(false); + } } - return invokeResponse; }; } diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs b/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs index 5941169b..ef904dc1 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs +++ b/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs @@ -48,6 +48,7 @@ public class TeamsBotApplicationBuilder public TeamsBotApplicationBuilder() { _webAppBuilder = WebApplication.CreateSlimBuilder(); + _webAppBuilder.Services.AddHttpContextAccessor(); _webAppBuilder.Services.AddBotApplication(); } @@ -59,14 +60,8 @@ public TeamsBotApplicationBuilder() public TeamsBotApplication Build() { _webApp = _webAppBuilder.Build(); - TeamsBotApplication botApp = _webApp.Services.GetService() ?? throw new InvalidOperationException("Application not registered"); - _webApp.MapPost(_routePath, async (HttpContext httpContext, CancellationToken cancellationToken) => - { - var resp = await botApp.ProcessAsync(httpContext, cancellationToken).ConfigureAwait(false); - return resp; - }); - + _webApp.UseBotApplication(_routePath); return botApp; } diff --git a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs index 8fc97ddf..17a9862e 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs @@ -63,12 +63,12 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() botApp.OnActivity = (act, ct) => { onActivityCalled = true; - return Task.FromResult(null); + return Task.CompletedTask; }; - InvokeResponse? result = await botApp.ProcessAsync(httpContext); + await botApp.ProcessAsync(httpContext); - Assert.Null(result); + Assert.True(onActivityCalled); } @@ -106,7 +106,7 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() botApp.OnActivity = (act, ct) => { onActivityCalled = true; - return Task.FromResult(null); + return Task.CompletedTask; }; await botApp.ProcessAsync(httpContext); diff --git a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs index c07d8e28..2562641f 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs @@ -73,7 +73,7 @@ public async Task Middleware_ExecutesInOrder() botApp.OnActivity = (act, ct) => { executionOrder.Add(3); - return Task.FromResult(null); + return Task.CompletedTask; }; await botApp.ProcessAsync(httpContext); @@ -118,7 +118,7 @@ public async Task Middleware_CanShortCircuit() botApp.OnActivity = (act, ct) => { onActivityCalled = true; - return Task.FromResult(null); + return Task.CompletedTask; }; await botApp.ProcessAsync(httpContext); diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs index bd8a4ae3..62dcd151 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -340,7 +340,7 @@ public async Task DeserializeInvokeWithValueAsync() using MemoryStream ms = new(System.Text.Encoding.UTF8.GetBytes(json)); CoreActivity? act = await CoreActivity.FromJsonStreamAsync(ms); Assert.NotNull(act); - Assert.Equal(ActivityType.Invoke, act.Type); + Assert.Equal("invoke", act.Type); Assert.NotNull(act.Value); Assert.NotNull(act.Value["key1"]); Assert.Equal("value1", act.Value["key1"]?.GetValue()); From 73ef46836458393fe9178d5bf4260de670779dc1 Mon Sep 17 00:00:00 2001 From: Mehak Bindra Date: Tue, 13 Jan 2026 12:36:08 -0800 Subject: [PATCH 34/69] [core + compat]: Add UserTokenClient (#260) - added usertokenclient class and extension to hosting - added to botappplication - introduced usertokenclient.models - added compat usertokenclient - added to teamsbotapplication - tested locally with ABSTokenServiceClient - tested with sso sample note: `await WriteInvokeResponseToHttpResponseAsync(activity.Value as InvokeResponse,cancellationToken).ConfigureAwait(false);` seems to create issues for invoke responses --------- Co-authored-by: Mehak Bindra Co-authored-by: Ricardo Minguez Pablos (RIDO) --- core/core.slnx | 1 + .../CompatAdapter.cs | 2 +- .../CompatBotAdapter.cs | 2 +- .../CompatMiddlewareAdapter.cs | 7 +- .../CompatUserTokenClient.cs | 94 ++++++ core/src/Microsoft.Bot.Core/BotApplication.cs | 12 +- .../Microsoft.Bot.Core/ConversationClient.cs | 2 +- .../Hosting/AddBotApplicationExtensions.cs | 44 ++- .../UserTokenClient.Models.cs | 88 ++++++ .../src/Microsoft.Bot.Core/UserTokenClient.cs | 288 ++++++++++++++++++ .../TeamsBotApplication.cs | 3 +- .../ABSTokenServiceClient.csproj | 25 ++ core/test/ABSTokenServiceClient/Program.cs | 15 + .../UserTokenCLIService.cs | 74 +++++ .../ABSTokenServiceClient/appsettings.json | 28 ++ .../BotApplicationTests.cs | 32 +- .../MiddlewareTests.cs | 23 +- 17 files changed, 704 insertions(+), 36 deletions(-) create mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs create mode 100644 core/src/Microsoft.Bot.Core/UserTokenClient.Models.cs create mode 100644 core/src/Microsoft.Bot.Core/UserTokenClient.cs create mode 100644 core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj create mode 100644 core/test/ABSTokenServiceClient/Program.cs create mode 100644 core/test/ABSTokenServiceClient/UserTokenCLIService.cs create mode 100644 core/test/ABSTokenServiceClient/appsettings.json diff --git a/core/core.slnx b/core/core.slnx index 568dae41..a8233c5a 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -28,6 +28,7 @@ + diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs index 362f3b7f..b2137070 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs @@ -68,7 +68,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons { coreActivity = activity; TurnContext turnContext = new(compatBotAdapter, activity.ToCompatActivity()); - //turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); + turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); CompatConnectorClient connectionClient = new(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); turnContext.TurnState.Add(connectionClient); await bot.OnTurnAsync(turnContext, cancellationToken1).ConfigureAwait(false); diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs index f1f74a46..176a3ea2 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs @@ -141,6 +141,6 @@ private async Task WriteInvokeResponseToHttpResponseAsync(InvokeResponse? invoke //}; //await response.WriteAsJsonAsync(invokeResponse.Body, options, cancellationToken).ConfigureAwait(false); - + } diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs index 83b1d23a..bcd91aeb 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs @@ -10,7 +10,12 @@ internal sealed class CompatMiddlewareAdapter(IMiddleware bfMiddleWare) : ITurnM { public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) { - using TurnContext turnContext = new(new CompatBotAdapter(botApplication), activity.ToCompatActivity()); +#pragma warning disable CA2000 // Dispose objects before losing scope + TurnContext turnContext = new(new CompatBotAdapter(botApplication), activity.ToCompatActivity()); +#pragma warning restore CA2000 // Dispose objects before losing scope + turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); + CompatConnectorClient connectionClient = new(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); + turnContext.TurnState.Add(connectionClient); return bfMiddleWare.OnTurnAsync(turnContext, (activity) => nextTurn(cancellationToken), cancellationToken); } diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs b/core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs new file mode 100644 index 00000000..c0cf0914 --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs @@ -0,0 +1,94 @@ +using Microsoft.Bot.Connector.Authentication; +using Microsoft.Bot.Schema; + +namespace Microsoft.Bot.Core.Compat; + +internal sealed class CompatUserTokenClient(Core.UserTokenClient utc) : Connector.Authentication.UserTokenClient +{ + public async override Task GetTokenStatusAsync(string userId, string channelId, string includeFilter, CancellationToken cancellationToken) + { + GetTokenStatusResult[] res = await utc.GetTokenStatusAsync(userId, channelId, includeFilter, cancellationToken).ConfigureAwait(false); + return res.Select(t => new TokenStatus + { + ChannelId = channelId, + ConnectionName = t.ConnectionName, + HasToken = t.HasToken, + ServiceProviderDisplayName = t.ServiceProviderDisplayName, + }).ToArray(); + } + + public async override Task GetUserTokenAsync(string userId, string connectionName, string channelId, string magicCode, CancellationToken cancellationToken) + { + GetTokenResult? res = await utc.GetTokenAsync(userId, connectionName, channelId, magicCode, cancellationToken).ConfigureAwait(false); + if (res == null) + { + return null; + } + + return new TokenResponse + { + ChannelId = channelId, + ConnectionName = res.ConnectionName, + Token = res.Token + }; + } + + public async override Task GetSignInResourceAsync(string connectionName, Activity activity, string finalRedirect, CancellationToken cancellationToken) + { + ArgumentNullException.ThrowIfNull(activity); + GetSignInResourceResult res = await utc.GetSignInResource(activity.From.Id, connectionName, activity.ChannelId, finalRedirect, cancellationToken).ConfigureAwait(false); + var signInResource = new SignInResource + { + SignInLink = res!.SignInLink + }; + + if (res.TokenExchangeResource != null) + { + signInResource.TokenExchangeResource = new Bot.Schema.TokenExchangeResource + { + Id = res.TokenExchangeResource.Id, + Uri = res.TokenExchangeResource.Uri?.ToString(), + ProviderId = res.TokenExchangeResource.ProviderId + }; + } + + if (res.TokenPostResource != null) + { + signInResource.TokenPostResource = new Bot.Schema.TokenPostResource + { + SasUrl = res.TokenPostResource.SasUrl?.ToString() + }; + } + + return signInResource; + } + + public async override Task ExchangeTokenAsync(string userId, string connectionName, string channelId, + TokenExchangeRequest exchangeRequest, CancellationToken cancellationToken) + { + GetTokenResult resp = await utc.ExchangeTokenAsync(userId, connectionName, channelId, exchangeRequest.Token, + cancellationToken).ConfigureAwait(false); + return new TokenResponse + { + ChannelId = channelId, + ConnectionName = resp.ConnectionName, + Token = resp.Token + }; + } + + public async override Task SignOutUserAsync(string userId, string connectionName, string channelId, CancellationToken cancellationToken) + { + await utc.SignOutUserAsync(userId, connectionName, channelId, cancellationToken).ConfigureAwait(false); + } + + public async override Task> GetAadTokensAsync(string userId, string connectionName, string[] resourceUrls, string channelId, CancellationToken cancellationToken) + { + IDictionary res = await utc.GetAadTokensAsync(userId, connectionName, channelId, resourceUrls, cancellationToken).ConfigureAwait(false); + return res?.ToDictionary(kvp => kvp.Key, kvp => new TokenResponse + { + ChannelId = channelId, + ConnectionName = kvp.Value.ConnectionName, + Token = kvp.Value.Token + }) ?? new Dictionary(); + } +} diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs index 9abfcb9c..05361f28 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -16,6 +16,7 @@ public class BotApplication { private readonly ILogger _logger; private readonly ConversationClient? _conversationClient; + private UserTokenClient? _userTokenClient; private readonly string _serviceKey; internal TurnMiddleware MiddleWare { get; } @@ -27,16 +28,18 @@ public class BotApplication /// configuration and service key. The service key is used to locate authentication credentials in the /// configuration. /// The client used to manage and interact with conversations for the bot. + /// The client used to manage user tokens for authentication. /// The application configuration settings used to retrieve environment variables and service credentials. /// The logger used to record operational and diagnostic information for the bot application. /// The configuration key identifying the authentication service. Defaults to "AzureAd" if not specified. - public BotApplication(ConversationClient conversationClient, IConfiguration config, ILogger logger, string sectionName = "AzureAd") + public BotApplication(ConversationClient conversationClient, UserTokenClient userTokenClient, IConfiguration config, ILogger logger, string sectionName = "AzureAd") { ArgumentNullException.ThrowIfNull(config); _logger = logger; _serviceKey = sectionName; MiddleWare = new TurnMiddleware(); _conversationClient = conversationClient; + _userTokenClient = userTokenClient; string appId = config["MicrosoftAppId"] ?? config["CLIENT_ID"] ?? config[$"{sectionName}:ClientId"] ?? "Unknown AppID"; logger.LogInformation("Started bot listener \n on {Port} \n for AppID:{AppId} \n with SDK version {SdkVersion}", config?["ASPNETCORE_URLS"], appId, Version); @@ -50,6 +53,13 @@ public BotApplication(ConversationClient conversationClient, IConfiguration conf /// that the client is properly configured before use. public ConversationClient ConversationClient => _conversationClient ?? throw new InvalidOperationException("ConversationClient not initialized"); + /// + /// Gets the client used to manage user tokens for authentication. + /// + /// Accessing this property before the client is initialized will result in an exception. Ensure + /// that the client is properly configured before use. + public UserTokenClient UserTokenClient => _userTokenClient ?? throw new InvalidOperationException("UserTokenClient not registered"); + /// /// Gets or sets the delegate that is invoked to handle an incoming activity asynchronously. /// diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index 570d254b..f29f2e5e 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -427,7 +427,7 @@ public async Task UploadAttachmentAsync(string convers ArgumentNullException.ThrowIfNull(serviceUrl); string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/conversations/{conversationId}/attachments"; - + logger.LogTrace("Uploading attachment to {Url}: {AttachmentData}", url, JsonSerializer.Serialize(attachmentData)); return await SendHttpRequestAsync( diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 7d372236..65bf37e7 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -66,33 +66,44 @@ public static IServiceCollection AddBotApplication(this IServiceCollection ILogger logger = services.BuildServiceProvider().GetRequiredService>(); services.AddAuthorization(logger, sectionName); services.AddConversationClient(sectionName); + services.AddUserTokenClient(sectionName); services.AddSingleton(); return services; } /// - /// Adds a conversation client to the service collection. + /// Adds conversation client to the service collection. /// /// service collection /// Configuration Section name, defaults to AzureAD /// - public static IServiceCollection AddConversationClient(this IServiceCollection services, string sectionName = "AzureAd") + public static IServiceCollection AddConversationClient(this IServiceCollection services, string sectionName = "AzureAd") => + services.AddBotClient(ConversationClient.ConversationHttpClientName, sectionName); + + /// + /// Adds user token client to the service collection. + /// + /// service collection + /// Configuration Section name, defaults to AzureAD + /// + public static IServiceCollection AddUserTokenClient(this IServiceCollection services, string sectionName = "AzureAd") => + services.AddBotClient(UserTokenClient.UserTokenHttpClientName, sectionName); + + private static IServiceCollection AddBotClient( + this IServiceCollection services, + string httpClientName, + string sectionName) where TClient : class { - ServiceProvider sp = services.BuildServiceProvider(); - IConfiguration configuration = sp.GetRequiredService(); - ILogger logger = sp.GetRequiredService>(); + var sp = services.BuildServiceProvider(); + var configuration = sp.GetRequiredService(); + var logger = sp.GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); ArgumentNullException.ThrowIfNull(configuration); string scope = "https://api.botframework.com/.default"; - if (configuration[$"{sectionName}:Scope"] is not null) - { + if (!string.IsNullOrEmpty(configuration[$"{sectionName}:Scope"])) scope = configuration[$"{sectionName}:Scope"]!; - } - - if (configuration["Scope"] is not null) //ToChannelFromBotOAuthScope - { + if (!string.IsNullOrEmpty(configuration["Scope"])) scope = configuration["Scope"]!; - } services .AddHttpClient() @@ -102,9 +113,9 @@ public static IServiceCollection AddConversationClient(this IServiceCollection s if (services.ConfigureMSAL(configuration, sectionName)) { - - services.AddHttpClient(ConversationClient.ConversationHttpClientName) - .AddHttpMessageHandler(sp => new BotAuthenticationHandler( + services.AddHttpClient(httpClientName) + .AddHttpMessageHandler(sp => + new BotAuthenticationHandler( sp.GetRequiredService(), sp.GetRequiredService>(), scope, @@ -113,8 +124,9 @@ public static IServiceCollection AddConversationClient(this IServiceCollection s else { _logAuthConfigNotFound(logger, null); - services.AddHttpClient(ConversationClient.ConversationHttpClientName); + services.AddHttpClient(httpClientName); } + return services; } diff --git a/core/src/Microsoft.Bot.Core/UserTokenClient.Models.cs b/core/src/Microsoft.Bot.Core/UserTokenClient.Models.cs new file mode 100644 index 00000000..eb7206de --- /dev/null +++ b/core/src/Microsoft.Bot.Core/UserTokenClient.Models.cs @@ -0,0 +1,88 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace Microsoft.Bot.Core; + + +/// +/// Result object for GetTokenStatus API call. +/// +public class GetTokenStatusResult +{ + /// + /// The connection name associated with the token. + /// + public string? ConnectionName { get; set; } + /// + /// Indicates whether a token is available. + /// + public bool? HasToken { get; set; } + /// + /// The display name of the service provider. + /// + public string? ServiceProviderDisplayName { get; set; } +} + +/// +/// Result object for GetToken API call. +/// +public class GetTokenResult +{ + /// + /// The connection name associated with the token. + /// + public string? ConnectionName { get; set; } + /// + /// The token string. + /// + public string? Token { get; set; } +} + +/// +/// SignIn resource object. +/// +public class GetSignInResourceResult +{ + /// + /// The link for signing in. + /// + public string? SignInLink { get; set; } + /// + /// The resource for token post. + /// + public TokenPostResource? TokenPostResource { get; set; } + + /// + /// The token exchange resources. + /// + public TokenExchangeResource? TokenExchangeResource { get; set; } +} +/// +/// Token post resource object. +/// +public class TokenPostResource +{ + /// + /// The URL to which the token should be posted. + /// + public Uri? SasUrl { get; set; } +} + +/// +/// Token exchange resource object. +/// +public class TokenExchangeResource +{ + /// + /// ID of the token exchange resource. + /// + public string? Id { get; set; } + /// + /// Provider ID of the token exchange resource. + /// + public string? ProviderId { get; set; } + /// + /// URI of the token exchange resource. + /// + public Uri? Uri { get; set; } +} diff --git a/core/src/Microsoft.Bot.Core/UserTokenClient.cs b/core/src/Microsoft.Bot.Core/UserTokenClient.cs new file mode 100644 index 00000000..e9c5872f --- /dev/null +++ b/core/src/Microsoft.Bot.Core/UserTokenClient.cs @@ -0,0 +1,288 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.AspNetCore.WebUtilities; +using Microsoft.Extensions.Logging; +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; +using System.Text; +using System.Text.Json; + +namespace Microsoft.Bot.Core; + +/// +/// Client for managing user tokens via HTTP requests. +/// +/// +/// +[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] +public class UserTokenClient(HttpClient httpClient, ILogger logger) +{ + internal const string UserTokenHttpClientName = "BotUserTokenClient"; + private readonly ILogger _logger = logger; + private readonly string _apiEndpoint = "https://token.botframework.com"; + private readonly JsonSerializerOptions _defaultOptions = new() { PropertyNamingPolicy = JsonNamingPolicy.CamelCase }; + + internal AgenticIdentity? AgenticIdentity { get; set; } + + /// + /// Gets the token status for each connection for the given user. + /// + /// The user ID. + /// The channel ID. + /// The optional include parameter. + /// The cancellation token. + /// + public async Task GetTokenStatusAsync(string userId, string channelId, string? include = null, CancellationToken cancellationToken = default) + { + Dictionary queryParams = new() + { + { "userid", userId }, + { "channelId", channelId } + }; + + if (!string.IsNullOrEmpty(include)) + { + queryParams.Add("include", include); + } + + string? resJson = await CallApiAsync("api/usertoken/GetTokenStatus", queryParams, cancellationToken: cancellationToken).ConfigureAwait(false); + IList result = JsonSerializer.Deserialize>(resJson!, _defaultOptions)!; + if (result == null || result.Count == 0) + { + return [new GetTokenStatusResult { HasToken = false }]; + } + return [.. result]; + + } + + /// + /// Gets the user token for a particular connection. + /// + /// The user ID. + /// The connection name. + /// The channel ID. + /// The optional code. + /// The cancellation token. + /// + public async Task GetTokenAsync(string userId, string connectionName, string channelId, string? code = null, CancellationToken cancellationToken = default) + { + Dictionary queryParams = new() + { + { "userid", userId }, + { "connectionName", connectionName }, + { "channelId", channelId } + }; + + if (!string.IsNullOrEmpty(code)) + { + queryParams.Add("code", code); + } + string? resJson = await CallApiAsync("api/usertoken/GetToken", queryParams, cancellationToken: cancellationToken).ConfigureAwait(false); + + if (resJson is not null) + { + GetTokenResult result = JsonSerializer.Deserialize(resJson!, _defaultOptions)!; + return result; + } + return null; + } + + /// + /// Get the token or raw signin link to be sent to the user for signin for a connection. + /// + /// The user ID. + /// The connection name. + /// The channel ID. + /// The optional final redirect URL. + /// The cancellation token. + /// + public async Task GetSignInResource(string userId, string connectionName, string channelId, string? finalRedirect = null, CancellationToken cancellationToken = default) + { + var tokenExchangeState = new + { + ConnectionName = connectionName, + Conversation = new + { + User = new ConversationAccount { Id = userId }, + } + }; + var tokenExchangeStateJson = JsonSerializer.Serialize(tokenExchangeState, _defaultOptions); + var state = Convert.ToBase64String(Encoding.UTF8.GetBytes(tokenExchangeStateJson)); + + Dictionary queryParams = new() + { + { "state", state } + }; + + if (!string.IsNullOrEmpty(finalRedirect)) + { + queryParams.Add("finalRedirect", finalRedirect); + } + + string? resJson = await CallApiAsync("api/botsignin/GetSignInResource", queryParams, cancellationToken: cancellationToken).ConfigureAwait(false); + GetSignInResourceResult result = JsonSerializer.Deserialize(resJson!, _defaultOptions)!; + return result; + } + + /// + /// Exchanges a token for another token. + /// + /// The user ID. + /// The connection name. + /// The channel ID. + /// The token to exchange. + /// The cancellation token. + public async Task ExchangeTokenAsync(string userId, string connectionName, string channelId, string? exchangeToken, CancellationToken cancellationToken = default) + { + Dictionary queryParams = new() + { + { "userid", userId }, + { "connectionName", connectionName }, + { "channelId", channelId } + }; + + var tokenExchangeRequest = new + { + token = exchangeToken + }; + + string? resJson = await CallApiAsync("api/usertoken/exchange", queryParams, method: HttpMethod.Post, JsonSerializer.Serialize(tokenExchangeRequest), cancellationToken).ConfigureAwait(false); + GetTokenResult result = JsonSerializer.Deserialize(resJson!, _defaultOptions)!; + return result!; + } + + /// + /// Signs the user out of a connection. + /// The user ID. + /// The connection name. + /// The channel ID. + /// The cancellation token. + /// + public async Task SignOutUserAsync(string userId, string? connectionName = null, string? channelId = null, CancellationToken cancellationToken = default) + { + Dictionary queryParams = new() + { + { "userid", userId } + }; + + if (!string.IsNullOrEmpty(connectionName)) + { + queryParams.Add("connectionName", connectionName); + } + + if (!string.IsNullOrEmpty(channelId)) + { + queryParams.Add("channelId", channelId); + } + + await CallApiAsync("api/usertoken/SignOut", queryParams, HttpMethod.Delete, cancellationToken: cancellationToken).ConfigureAwait(false); + return; + } + + /// + /// Gets AAD tokens for a user. + /// + /// The user ID. + /// The connection name. + /// The channel ID. + /// The resource URLs. + /// The cancellation token. + /// + public async Task> GetAadTokensAsync(string userId, string connectionName, string channelId, string[]? resourceUrls = null, CancellationToken cancellationToken = default) + { + var body = new + { + channelId, + connectionName, + userId, + resourceUrls = resourceUrls ?? [] + }; + + string? respJson = await CallApiAsync("api/usertoken/GetAadTokens", body, cancellationToken).ConfigureAwait(false); + IDictionary res = JsonSerializer.Deserialize>(respJson!, _defaultOptions)!; + return res; + } + + private async Task CallApiAsync(string endpoint, Dictionary queryParams, HttpMethod? method = null, string? body = null, CancellationToken cancellationToken = default) + { + + var fullPath = $"{_apiEndpoint}/{endpoint}"; + var requestUri = QueryHelpers.AddQueryString(fullPath, queryParams); + _logger.LogInformation("Calling API endpoint: {Endpoint}", requestUri); + + HttpMethod httpMethod = method ?? HttpMethod.Get; + #pragma warning disable CA2000 // HttpClient.SendAsync disposes the request + HttpRequestMessage request = new(httpMethod, requestUri); + #pragma warning restore CA2000 + + // Pass the agentic identity to the handler via request options + request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity); + + if (httpMethod == HttpMethod.Post && !string.IsNullOrEmpty(body)) + { + request.Content = new StringContent(body, Encoding.UTF8, "application/json"); + } + + HttpResponseMessage response = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); + + if (response.IsSuccessStatusCode) + { + var content = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); + _logger.LogInformation("API call successful. Status: {StatusCode}", response.StatusCode); + return content; + } + else + { + var errorContent = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); + + if (response.StatusCode == System.Net.HttpStatusCode.NotFound) + { + _logger.LogWarning("User Token not found: {Endpoint}", requestUri); + return null; + } + else + { + _logger.LogError("API call failed. Status: {StatusCode}, Error: {Error}", + response.StatusCode, errorContent); + throw new HttpRequestException($"API call failed with status {response.StatusCode}: {errorContent}"); + } + } + } + + private async Task CallApiAsync(string endpoint, object body, CancellationToken cancellationToken = default) + { + var fullPath = $"{_apiEndpoint}/{endpoint}"; + + _logger.LogInformation("Calling API endpoint with POST: {Endpoint}", fullPath); + + var jsonContent = JsonSerializer.Serialize(body); + StringContent content = new(jsonContent, Encoding.UTF8, "application/json"); + + #pragma warning disable CA2000 // HttpClient.SendAsync disposes the request + HttpRequestMessage request = new(HttpMethod.Post, fullPath) + { + Content = content + }; + #pragma warning restore CA2000 + + request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity); + + HttpResponseMessage response = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); + + if (response.IsSuccessStatusCode) + { + var responseContent = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); + _logger.LogInformation("API call successful. Status: {StatusCode}", response.StatusCode); + return responseContent; + } + else + { + var errorContent = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); + _logger.LogError("API call failed. Status: {StatusCode}, Error: {Error}", + response.StatusCode, errorContent); + throw new HttpRequestException($"API call failed with status {response.StatusCode}: {errorContent}"); + } + } +} diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs index 05a52da8..d0a723db 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs @@ -44,11 +44,12 @@ public class TeamsBotApplication : BotApplication /// public ConversationUpdateHandler? OnConversationUpdate { get; set; } /// + /// /// /// /// /// - public TeamsBotApplication(ConversationClient conversationClient, IConfiguration config, IHttpContextAccessor httpContextAccessor, ILogger logger, string sectionName = "AzureAd") : base(conversationClient, config, logger, sectionName) + public TeamsBotApplication(ConversationClient conversationClient, UserTokenClient userTokenClient, IConfiguration config, IHttpContextAccessor httpContextAccessor, ILogger logger, string sectionName = "AzureAd") : base(conversationClient, userTokenClient, config, logger, sectionName) { OnActivity = async (activity, cancellationToken) => { diff --git a/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj b/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj new file mode 100644 index 00000000..5f042c02 --- /dev/null +++ b/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj @@ -0,0 +1,25 @@ + + + + Exe + net10.0 + enable + enable + + + + + + + + + + + + + + PreserveNewest + + + + diff --git a/core/test/ABSTokenServiceClient/Program.cs b/core/test/ABSTokenServiceClient/Program.cs new file mode 100644 index 00000000..b4105edc --- /dev/null +++ b/core/test/ABSTokenServiceClient/Program.cs @@ -0,0 +1,15 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using ABSTokenServiceClient; +using Microsoft.AspNetCore.Builder; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core; + +WebApplicationBuilder builder = WebApplication.CreateBuilder(args); + +builder.Services.AddUserTokenClient(); +builder.Services.AddHostedService(); +WebApplication host = builder.Build(); +host.Run(); diff --git a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs new file mode 100644 index 00000000..71d59bfb --- /dev/null +++ b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs @@ -0,0 +1,74 @@ +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; +using Microsoft.Bot.Core; +using System.Text.Json; + +namespace ABSTokenServiceClient +{ + [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] + internal class UserTokenCLIService(UserTokenClient userTokenClient, ILogger logger) : IHostedService + { + public Task StartAsync(CancellationToken cancellationToken) + { + return ExecuteAsync(cancellationToken); + } + + public Task StopAsync(CancellationToken cancellationToken) + { + return Task.CompletedTask; + } + + protected async Task ExecuteAsync(CancellationToken cancellationToken) + { + const string userId = "your-user-id"; + const string connectionName = "graph"; + const string channelId = "msteams"; + + logger.LogInformation("Application started"); + + try + { + logger.LogInformation("=== Testing GetTokenStatus ==="); + GetTokenStatusResult[] tokenStatus = await userTokenClient.GetTokenStatusAsync(userId, channelId, null, cancellationToken); + logger.LogInformation("GetTokenStatus result: {Result}", JsonSerializer.Serialize(tokenStatus, new JsonSerializerOptions { WriteIndented = true })); + + if (tokenStatus[0].HasToken == true) + { + GetTokenResult? tokenResponse = await userTokenClient.GetTokenAsync(userId, connectionName, channelId, null, cancellationToken); + logger.LogInformation("GetToken result: {Result}", JsonSerializer.Serialize(tokenResponse, new JsonSerializerOptions { WriteIndented = true })); + } + else + { + GetSignInResourceResult req = await userTokenClient.GetSignInResource(userId, connectionName, channelId, null, cancellationToken); + logger.LogInformation("GetSignInResource result: {Result}", JsonSerializer.Serialize(req, new JsonSerializerOptions { WriteIndented = true })); + + Console.WriteLine("Code?"); + string code = Console.ReadLine()!; + + GetTokenResult? tokenResponse2 = await userTokenClient.GetTokenAsync(userId, connectionName, channelId, code, cancellationToken); + logger.LogInformation("GetToken With Code result: {Result}", JsonSerializer.Serialize(tokenResponse2, new JsonSerializerOptions { WriteIndented = true })); + } + + Console.WriteLine("Want to signout? y/n"); + string yn = Console.ReadLine()!; + if ("y".Equals(yn, StringComparison.OrdinalIgnoreCase)) + { + try{ + await userTokenClient.SignOutUserAsync(userId, connectionName, channelId, cancellationToken); + logger.LogInformation("SignOutUser completed successfully"); + } + catch (Exception ex) { + logger.LogError(ex, "Error during SignOutUser"); + } + } + } + catch (Exception ex) + { + + logger.LogError(ex, "Error during API testing"); + } + + logger.LogInformation("Application completed successfully"); + } + } +} diff --git a/core/test/ABSTokenServiceClient/appsettings.json b/core/test/ABSTokenServiceClient/appsettings.json new file mode 100644 index 00000000..3c9252dc --- /dev/null +++ b/core/test/ABSTokenServiceClient/appsettings.json @@ -0,0 +1,28 @@ + +{ + "Logging": { + "LogLevel": { + "Default": "Warning", + "Program": "Information", + "ABSTokenServiceClient.UserTokenCLIService": "Information" + } + }, + "Console": { + "FormatterName": "simple", + "FormatterOptions": { + "SingleLine": true, + "TimestampFormat": "HH:mm:ss:ms " + } + }, + "AzureAd": { + "Instance": "https://login.microsoftonline.com/", + "TenantId": "your-tenant-id-here", + "ClientId": "your-client-id-here", + "ClientCredentials": [ + { + "SourceType": "ClientSecret", + "ClientSecret": "your-client-secret-here" + } + ] + } +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs index 17a9862e..2cc21dc1 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs @@ -18,11 +18,11 @@ public class BotApplicationTests public void Constructor_InitializesProperties() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); - + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); Assert.NotNull(botApp); Assert.NotNull(botApp.ConversationClient); } @@ -33,9 +33,10 @@ public void Constructor_InitializesProperties() public async Task ProcessAsync_WithNullHttpContext_ThrowsArgumentNullException() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); await Assert.ThrowsAsync(() => botApp.ProcessAsync(null!)); @@ -45,9 +46,10 @@ await Assert.ThrowsAsync(() => public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); CoreActivity activity = new() { @@ -76,9 +78,10 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); CoreActivity activity = new() { @@ -119,9 +122,10 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() public async Task ProcessAsync_WithException_ThrowsBotHandlerException() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); CoreActivity activity = new() { @@ -145,9 +149,10 @@ public async Task ProcessAsync_WithException_ThrowsBotHandlerException() public void Use_AddsMiddlewareToChain() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); Mock mockMiddleware = new(); @@ -175,8 +180,9 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() HttpClient httpClient = new(mockHttpMessageHandler.Object); ConversationClient conversationClient = new(httpClient); Mock mockConfig = new(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); CoreActivity activity = new() { @@ -195,9 +201,10 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() public async Task SendActivityAsync_WithNullActivity_ThrowsArgumentNullException() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); await Assert.ThrowsAsync(() => botApp.SendActivityAsync(null!)); @@ -209,6 +216,13 @@ private static ConversationClient CreateMockConversationClient() return new ConversationClient(mockHttpClient.Object); } + private static UserTokenClient CreateMockUserTokenClient() + { + Mock mockHttpClient = new(); + NullLogger logger = NullLogger.Instance; + return new UserTokenClient(mockHttpClient.Object, logger); + } + private static DefaultHttpContext CreateHttpContextWithActivity(CoreActivity activity) { DefaultHttpContext httpContext = new(); diff --git a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs index 2562641f..c3dd72f2 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs @@ -16,9 +16,10 @@ public class MiddlewareTests public async Task BotApplication_Use_AddsMiddlewareToChain() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); Mock mockMiddleware = new(); @@ -32,9 +33,10 @@ public async Task BotApplication_Use_AddsMiddlewareToChain() public async Task Middleware_ExecutesInOrder() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); List executionOrder = []; @@ -85,9 +87,10 @@ public async Task Middleware_ExecutesInOrder() public async Task Middleware_CanShortCircuit() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); bool secondMiddlewareCalled = false; bool onActivityCalled = false; @@ -131,9 +134,10 @@ public async Task Middleware_CanShortCircuit() public async Task Middleware_ReceivesCancellationToken() { ConversationClient conversationClient = CreateMockConversationClient(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); CancellationToken receivedToken = default; @@ -169,9 +173,11 @@ public async Task Middleware_ReceivesCancellationToken() public async Task Middleware_ReceivesActivity() { ConversationClient conversationClient = CreateMockConversationClient(); + Mock mockConfig = new(); + UserTokenClient userTokenClient = CreateMockUserTokenClient(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); CoreActivity? receivedActivity = null; @@ -208,6 +214,13 @@ private static ConversationClient CreateMockConversationClient() return new ConversationClient(mockHttpClient.Object); } + private static UserTokenClient CreateMockUserTokenClient() + { + Mock mockHttpClient = new(); + NullLogger logger = NullLogger.Instance; + return new UserTokenClient(mockHttpClient.Object, logger); + } + private static DefaultHttpContext CreateHttpContextWithActivity(CoreActivity activity) { DefaultHttpContext httpContext = new(); From 6906413cf7559d9c7c121ec92e5f1b1930941903 Mon Sep 17 00:00:00 2001 From: Rido Date: Thu, 15 Jan 2026 12:30:56 -0800 Subject: [PATCH 35/69] Update Compat Layer to target Teams features (#265) Add Teams activity support and extensibility with tests - Introduce TeamsActivity and TeamsConversationAccount support, including conversion and deserialization methods. - Enhance ToCompatChannelAccount to extract Teams-specific properties. - Make ConversationClient.GetConversationMemberAsync generic. - Remove generic CoreActivity.FromJsonString; use TeamsActivity.FromJsonString. - Add extensibility patterns for custom activity/channel data types. - Add unit and integration tests for TeamsInfo and activity conversion. - Update solution and test projects to include compat and Teams libraries. - Add InternalsVisibleTo for test access and improve code comments. --- core/samples/AFBot/Program.cs | 9 +- core/samples/CompatBot/EchoBot.cs | 45 +- core/samples/CoreBot/Program.cs | 13 +- core/samples/CoreBot/appsettings.json | 2 +- core/samples/TeamsBot/Cards.cs | 28 + core/samples/TeamsBot/Program.cs | 35 +- .../CompatActivity.cs | 83 ++- .../CompatAdapter.cs | 7 +- .../CompatAdapterMiddleware.cs | 40 ++ .../CompatBotAdapter.cs | 74 +-- .../CompatConversations.cs | 34 +- .../CompatHostingExtensions.cs | 4 +- .../CompatMiddlewareAdapter.cs | 22 - .../CompatUserTokenClient.cs | 6 +- .../InternalsVisibleTo.cs | 6 + .../Microsoft.Bot.Core.Compat.csproj | 4 +- core/src/Microsoft.Bot.Core/BotApplication.cs | 2 +- .../Microsoft.Bot.Core/ConversationClient.cs | 168 ++---- .../Hosting/AddBotApplicationExtensions.cs | 7 +- .../Microsoft.Bot.Core/Http/BotHttpClient.cs | 255 ++++++++ .../Http/BotRequestOptions.cs | 40 ++ .../Microsoft.Bot.Core.csproj | 1 + .../Microsoft.Bot.Core/Schema/CoreActivity.cs | 23 +- .../src/Microsoft.Bot.Core/UserTokenClient.cs | 177 +++--- .../Handlers/InvokeHandler.cs | 1 - .../Schema/Entities/ProductInfoEntity.cs | 1 - .../Schema/TeamsActivity.cs | 12 +- .../Schema/TeamsActivityType.cs | 2 +- .../Schema/TeamsAttachment.cs | 2 +- .../Schema/TeamsChannelData.cs | 12 +- .../Schema/TeamsConversationAccount .cs | 3 +- .../TeamsApiClient.Models.cs | 488 +++++++++++++++ .../Microsoft.Teams.BotApps/TeamsApiClient.cs | 444 ++++++++++++++ .../TeamsBotApplication.HostingExtensions.cs | 46 ++ .../TeamsBotApplication.cs | 24 +- .../TeamsBotApplicationBuilder.cs | 4 +- core/test/ABSTokenServiceClient/Program.cs | 4 +- .../UserTokenCLIService.cs | 12 +- core/test/IntegrationTests.slnx | 6 +- .../CompatActivityTests.cs | 104 ++++ ...Microsoft.Bot.Core.Compat.UnitTests.csproj | 26 + .../CompatConversationClientTests.cs | 126 ++++ .../ConversationClientTest.cs | 8 +- .../Microsoft.Bot.Core.Tests.csproj | 3 +- .../TeamsApiClientTests.cs | 562 ++++++++++++++++++ .../BotApplicationTests.cs | 5 +- .../CoreActivityBuilderTests.cs | 2 +- .../MiddlewareTests.cs | 3 +- .../Schema/ActivityExtensibilityTests.cs | 72 ++- .../ConversationUpdateActivityTests.cs | 6 +- .../MessageReactionActivityTests.cs | 2 +- .../TeamsActivityTests.cs | 30 +- core/version.json | 2 + version.json | 1 + 54 files changed, 2659 insertions(+), 439 deletions(-) create mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatAdapterMiddleware.cs delete mode 100644 core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs create mode 100644 core/src/Microsoft.Bot.Core.Compat/InternalsVisibleTo.cs create mode 100644 core/src/Microsoft.Bot.Core/Http/BotHttpClient.cs create mode 100644 core/src/Microsoft.Bot.Core/Http/BotRequestOptions.cs create mode 100644 core/src/Microsoft.Teams.BotApps/TeamsApiClient.Models.cs create mode 100644 core/src/Microsoft.Teams.BotApps/TeamsApiClient.cs create mode 100644 core/src/Microsoft.Teams.BotApps/TeamsBotApplication.HostingExtensions.cs create mode 100644 core/test/Microsoft.Bot.Core.Compat.UnitTests/CompatActivityTests.cs create mode 100644 core/test/Microsoft.Bot.Core.Compat.UnitTests/Microsoft.Bot.Core.Compat.UnitTests.csproj create mode 100644 core/test/Microsoft.Bot.Core.Tests/CompatConversationClientTests.cs create mode 100644 core/test/Microsoft.Bot.Core.Tests/TeamsApiClientTests.cs diff --git a/core/samples/AFBot/Program.cs b/core/samples/AFBot/Program.cs index 5672f828..4ff4c447 100644 --- a/core/samples/AFBot/Program.cs +++ b/core/samples/AFBot/Program.cs @@ -12,7 +12,6 @@ using OpenAI; WebApplicationBuilder builder = WebApplication.CreateBuilder(args); - WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); webAppBuilder.Services.AddOpenTelemetry().UseAzureMonitor(); webAppBuilder.Services.AddBotApplication(); @@ -20,7 +19,7 @@ BotApplication botApp = webApp.UseBotApplication(); AzureOpenAIClient azureClient = new( - new Uri("https://ridofoundry.cognitiveservices.azure.com/"), + new Uri("https://tsdkfoundry.openai.azure.com/"), new ApiKeyCredential(Environment.GetEnvironmentVariable("AZURE_OpenAI_KEY")!)); ChatClientAgent agent = azureClient.GetChatClient("gpt-5-nano").CreateAIAgent( @@ -44,14 +43,14 @@ .Build(); await botApp.SendActivityAsync(typing, cancellationToken); - AgentRunResponse agentResponse = await agent.RunAsync(activity.Properties["text"]?.ToString() ?? "OMW", cancellationToken: timer.Token); - + AgentRunResponse agentResponse = await agent.RunAsync(activity.Properties["text"]?.ToString() ?? "OMW", cancellationToken: timer.Token); + var m1 = agentResponse.Messages.FirstOrDefault(); Console.WriteLine($"AI:: GOT {agentResponse.Messages.Count} msgs"); CoreActivity replyActivity = CoreActivity.CreateBuilder() .WithType(ActivityType.Message) .WithConversationReference(activity) - .WithProperty("text",m1!.Text) + .WithProperty("text", m1!.Text) .Build(); var res = await botApp.SendActivityAsync(replyActivity, cancellationToken); diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 247a68c6..b6dc8a10 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -4,9 +4,13 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Teams; using Microsoft.Bot.Connector; +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Compat; using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Bot.Schema.Teams; +using Microsoft.Teams.BotApps; +using Microsoft.Teams.BotApps.Schema; using Newtonsoft.Json.Linq; namespace CompatBot; @@ -17,7 +21,8 @@ public class ConversationData } -internal class EchoBot(ConversationState conversationState, ILogger logger) : TeamsActivityHandler +internal class EchoBot(TeamsBotApplication teamsBotApp, ConversationState conversationState, ILogger logger) + : TeamsActivityHandler { public override async Task OnTurnAsync(ITurnContext turnContext, CancellationToken cancellationToken = default) { @@ -35,9 +40,12 @@ protected override async Task OnMessageActivityAsync(ITurnContext().Conversations; + // TeamsAPXClient provides Teams-specific operations like: + // - FetchTeamDetailsAsync, FetchChannelListAsync + // - FetchMeetingInfoAsync, FetchParticipantAsync, SendMeetingNotificationAsync + // - Batch messaging: SendMessageToListOfUsersAsync, SendMessageToAllUsersInTenantAsync, etc. - // await SendUpdateDeleteActivityAsync(turnContext, conversationClient, cancellationToken); + await SendUpdateDeleteActivityAsync(turnContext, teamsBotApp.ConversationClient, cancellationToken); var attachment = new Attachment { @@ -49,7 +57,7 @@ protected override async Task OnMessageActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) { await turnContext.SendActivityAsync(MessageFactory.Text("Message reaction received."), cancellationToken); @@ -113,28 +121,35 @@ protected override async Task OnTeamsMeetingStartAsync(MeetingStartEventDetails await turnContext.SendActivityAsync(MessageFactory.Text($"{meeting.Title} {meeting.MeetingType}"), cancellationToken); } - private static async Task SendUpdateDeleteActivityAsync(ITurnContext turnContext, IConversations conversationClient, CancellationToken cancellationToken) + private static async Task SendUpdateDeleteActivityAsync(ITurnContext turnContext, ConversationClient conversationClient, CancellationToken cancellationToken) { var cr = turnContext.Activity.GetConversationReference(); - var reply = Activity.CreateMessageActivity(); + Activity reply = (Activity)Activity.CreateMessageActivity(); reply.ApplyConversationReference(cr, isIncoming: false); reply.Text = "This is a proactive message sent using the Conversations API."; - var res = await conversationClient.SendToConversationAsync(cr.Conversation.Id, (Activity)reply, cancellationToken); + TeamsActivity ta = reply.FromCompatActivity(); + + var res = await conversationClient.SendActivityAsync(ta, null, cancellationToken); await Task.Delay(2000, cancellationToken); - await conversationClient.UpdateActivityAsync(cr.Conversation.Id, res.Id!, new Activity - { - Id = res.Id, - ServiceUrl = turnContext.Activity.ServiceUrl, - Type = ActivityType.Message, - Text = "This message has been updated.", - }, cancellationToken); + await conversationClient.UpdateActivityAsync( + cr.Conversation.Id, + res.Id!, + TeamsActivity.CreateBuilder() + .WithId(res.Id ?? "") + .WithServiceUrl(new Uri(turnContext.Activity.ServiceUrl)) + .WithType(ActivityType.Message) + .WithText("This message has been updated.") + .WithFrom(ta.From) + .Build(), + null, + cancellationToken); await Task.Delay(2000, cancellationToken); - await conversationClient.DeleteActivityAsync(cr.Conversation.Id, res.Id!, cancellationToken); + await conversationClient.DeleteActivityAsync(cr.Conversation.Id, res.Id!, new Uri(turnContext.Activity.ServiceUrl), AgenticIdentity.FromProperties(ta.From.Properties), null, cancellationToken); await turnContext.SendActivityAsync(MessageFactory.Text("Proactive message sent and deleted."), cancellationToken); } diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index 956672b5..ada6ecf1 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -17,7 +17,14 @@ botApp.OnActivity = async (activity, cancellationToken) => { string replyText = $"CoreBot running on SDK {BotApplication.Version}."; - replyText += $"
You sent: `{activity.Properties["text"]}` in activity of type `{activity.Type}`."; + + replyText += $"
Received Activity `{activity.Type}`."; + + //activity.Properties.Where(kvp => kvp.Key.StartsWith("text")).ToList().ForEach(kvp => + //{ + // replyText += $"
{kvp.Key}:`{kvp.Value}` "; + //}); + string? conversationType = "unknown conversation type"; if (activity.Conversation.Properties.TryGetValue("conversationType", out object? ctProp)) @@ -25,12 +32,12 @@ conversationType = ctProp?.ToString(); } - replyText += $"
To Conversation ID: `{activity.Conversation.Id}` conv type: `{conversationType}`"; + replyText += $"
To conv type: `{conversationType}` conv id: `{activity.Conversation.Id}`"; CoreActivity replyActivity = CoreActivity.CreateBuilder() .WithType(ActivityType.Message) .WithConversationReference(activity) - .WithProperty("text",replyText) + .WithProperty("text", replyText) .Build(); await botApp.SendActivityAsync(replyActivity, cancellationToken); diff --git a/core/samples/CoreBot/appsettings.json b/core/samples/CoreBot/appsettings.json index 22c313fa..1ff8c135 100644 --- a/core/samples/CoreBot/appsettings.json +++ b/core/samples/CoreBot/appsettings.json @@ -3,7 +3,7 @@ "Logging": { "LogLevel": { "Default": "Warning", - "Microsoft.Bot.Core": "Information" + "Microsoft.Bot": "Trace" } }, "AllowedHosts": "*" diff --git a/core/samples/TeamsBot/Cards.cs b/core/samples/TeamsBot/Cards.cs index c6dcb77d..afcb611f 100644 --- a/core/samples/TeamsBot/Cards.cs +++ b/core/samples/TeamsBot/Cards.cs @@ -28,6 +28,34 @@ internal class Cards } }; + public static object ReactionsCard(string? reactionsAdded, string? reactionsRemoved) => new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new + { + type = "TextBlock", + text = "Reaction Received", + weight = "Bolder", + size = "Medium" + }, + new + { + type = "TextBlock", + text = $"Reactions Added: {reactionsAdded ?? "(empty)"}", + wrap = true + }, + new + { + type = "TextBlock", + text = $"Reactions Removed: {reactionsRemoved ?? "(empty)"}", + wrap = true + } + } + }; + public static readonly object FeedbackCardObj = new { type = "AdaptiveCard", diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 67ce0238..8bc84437 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -10,6 +10,9 @@ var builder = TeamsBotApplication.CreateBuilder(); var teamsApp = builder.Build(); + + + teamsApp.OnMessage = async (messageArgs, context, cancellationToken) => { await context.SendTypingActivityAsync(cancellationToken); @@ -20,7 +23,7 @@ .WithText(replyText) .Build(); - reply.AddMention(context.Activity.From!, "ridobotlocal", true); + reply.AddMention(context.Activity.From!); await context.SendActivityAsync(reply, cancellationToken); @@ -34,15 +37,17 @@ teamsApp.OnMessageReaction = async (args, context, cancellationToken) => { - string replyText = $"Message reaction activity of type `{context.Activity.Type}` received."; - replyText += args.ReactionsAdded != null - ? $"
Reactions Added: {string.Join(", ", args.ReactionsAdded.Select(r => r.Type))}." - : string.Empty; - replyText += args.ReactionsRemoved != null - ? $"
Reactions Removed: {string.Join(", ", args.ReactionsRemoved.Select(r => r.Type))}." - : string.Empty; - - await context.SendActivityAsync(replyText, cancellationToken); + string reactionsAdded = string.Join(", ", args.ReactionsAdded?.Select(r => r.Type) ?? []); + string reactionsRemoved = string.Join(", ", args.ReactionsRemoved?.Select(r => r.Type) ?? []); + + var reply = TeamsActivity.CreateBuilder() + .WithAttachment(TeamsAttachment.CreateBuilder() + .WithAdaptiveCard(Cards.ReactionsCard(reactionsAdded, reactionsRemoved)) + .Build() + ) + .Build(); + + await context.SendActivityAsync(reply, cancellationToken); }; teamsApp.OnInvoke = async (context, cancellationToken) => @@ -66,4 +71,14 @@ }; }; +//teamsApp.OnActivity = async (activity, ct) => +//{ +// var reply = CoreActivity.CreateBuilder() +// .WithConversationReference(activity) +// .WithProperty("text", "yo") +// .Build(); +// await teamsApp.SendActivityAsync(reply, ct); +//}; + + teamsApp.Run(); diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs index bfe28b25..1353c53c 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs @@ -6,45 +6,106 @@ using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; - +using Microsoft.Teams.BotApps.Schema; using Newtonsoft.Json; namespace Microsoft.Bot.Core.Compat; -internal static class CompatActivity +/// +/// Extension methods for converting between Bot Framework Activity and CoreActivity/TeamsActivity. +/// +public static class CompatActivity { + /// + /// Converts a CoreActivity to a Bot Framework Activity. + /// + /// + /// public static Activity ToCompatActivity(this CoreActivity activity) { + ArgumentNullException.ThrowIfNull(activity); using JsonTextReader reader = new(new StringReader(activity.ToJson())); return BotMessageHandlerBase.BotMessageSerializer.Deserialize(reader)!; } - public static CoreActivity FromCompatActivity(this Activity activity) + /// + /// Converts a Bot Framework Activity to a TeamsActivity. + /// + /// + /// + public static TeamsActivity FromCompatActivity(this Activity activity) { StringBuilder sb = new(); using StringWriter stringWriter = new(sb); using JsonTextWriter json = new(stringWriter); BotMessageHandlerBase.BotMessageSerializer.Serialize(json, activity); - return CoreActivity.FromJsonString(sb.ToString()); + string jsonString = sb.ToString(); + CoreActivity coreActivity = CoreActivity.FromJsonString(jsonString); + return TeamsActivity.FromActivity(coreActivity); } + + /// + /// Converts a ConversationAccount to a ChannelAccount. + /// + /// + /// public static Microsoft.Bot.Schema.ChannelAccount ToCompatChannelAccount(this Microsoft.Bot.Core.Schema.ConversationAccount account) { - ChannelAccount channelAccount = new() + ArgumentNullException.ThrowIfNull(account); + + Microsoft.Bot.Schema.ChannelAccount channelAccount; + if (account is TeamsConversationAccount tae) { - Id = account.Id, - Name = account.Name - }; + channelAccount = new() + { + Id = account.Id, + Name = account.Name, + AadObjectId = tae.AadObjectId + }; + } + else + { + channelAccount = new() + { + Id = account.Id, + Name = account.Name + }; + } - // Extract AadObjectId and Role from Properties if they exist if (account.Properties.TryGetValue("aadObjectId", out object? aadObjectId)) { channelAccount.AadObjectId = aadObjectId?.ToString(); } - if (account.Properties.TryGetValue("role", out object? role)) + if (account.Properties.TryGetValue("userRole", out object? userRole)) + { + channelAccount.Role = userRole?.ToString(); + } + + if (account.Properties.TryGetValue("userPrincipalName", out object? userPrincipalName)) + { + channelAccount.Properties.Add("userPrincipalName", userPrincipalName?.ToString() ?? string.Empty); + } + + if (account.Properties.TryGetValue("givenName", out object? givenName)) + { + channelAccount.Properties.Add("givenName", givenName?.ToString() ?? string.Empty); + } + + if (account.Properties.TryGetValue("surname", out object? surname)) + { + channelAccount.Properties.Add("surname", surname?.ToString() ?? string.Empty); + } + + if (account.Properties.TryGetValue("email", out object? email)) + { + channelAccount.Properties.Add("email", email?.ToString() ?? string.Empty); + } + + if (account.Properties.TryGetValue("tenantId", out object? tenantId)) { - channelAccount.Role = role?.ToString(); + channelAccount.Properties.Add("tenantId", tenantId?.ToString() ?? string.Empty); } return channelAccount; diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs index b2137070..9343cfda 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs @@ -6,7 +6,7 @@ using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; -using Newtonsoft.Json.Linq; +using Microsoft.Teams.BotApps; namespace Microsoft.Bot.Core.Compat; @@ -21,7 +21,7 @@ namespace Microsoft.Bot.Core.Compat; /// requests. /// The bot application instance that handles activity processing and manages user token operations. /// The underlying bot adapter used to interact with the bot framework and create turn contexts. -public class CompatAdapter(BotApplication botApplication, CompatBotAdapter compatBotAdapter) : IBotFrameworkHttpAdapter +public class CompatAdapter(TeamsBotApplication botApplication, CompatBotAdapter compatBotAdapter) : IBotFrameworkHttpAdapter { /// /// Gets the collection of middleware components configured for the application. @@ -78,7 +78,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons { foreach (Builder.IMiddleware? middleware in MiddlewareSet) { - botApplication.Use(new CompatMiddlewareAdapter(middleware)); + botApplication.Use(new CompatAdapterMiddleware(middleware)); } await botApplication.ProcessAsync(httpRequest.HttpContext, cancellationToken).ConfigureAwait(false); @@ -123,6 +123,7 @@ public async Task ContinueConversationAsync(string botId, ConversationReference ArgumentNullException.ThrowIfNull(callback); using TurnContext turnContext = new(compatBotAdapter, reference.GetContinuationActivity()); + turnContext.TurnState.Add(new CompatConnectorClient(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = reference.ServiceUrl })); await callback(turnContext, cancellationToken).ConfigureAwait(false); } } diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapterMiddleware.cs b/core/src/Microsoft.Bot.Core.Compat/CompatAdapterMiddleware.cs new file mode 100644 index 00000000..212aea58 --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/CompatAdapterMiddleware.cs @@ -0,0 +1,40 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Builder; +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps; + +namespace Microsoft.Bot.Core.Compat; + +internal sealed class CompatAdapterMiddleware(IMiddleware bfMiddleWare) : ITurnMiddleWare +{ + public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) + { + + if (botApplication is TeamsBotApplication tba) + { +#pragma warning disable CA2000 // Dispose objects before losing scope + TurnContext turnContext = new(new CompatBotAdapter(tba), activity.ToCompatActivity()); +#pragma warning restore CA2000 // Dispose objects before losing scope + + turnContext.TurnState.Add( + new CompatUserTokenClient(botApplication.UserTokenClient) + ); + + turnContext.TurnState.Add( + new CompatConnectorClient( + new CompatConversations(botApplication.ConversationClient) + { + ServiceUrl = activity.ServiceUrl?.ToString() + } + ) + ); + + return bfMiddleWare.OnTurnAsync(turnContext, (activity) + => nextTurn(cancellationToken), cancellationToken); + } + return Task.CompletedTask; + } + +} diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs index 176a3ea2..7d7d623e 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs @@ -1,13 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text.Json; using Microsoft.AspNetCore.Http; using Microsoft.Bot.Builder; -using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; -using Microsoft.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Extensions.Logging; +using Microsoft.Teams.BotApps; using Newtonsoft.Json; @@ -24,7 +22,7 @@ namespace Microsoft.Bot.Core.Compat; /// The HTTP context accessor used to retrieve the current HTTP context. /// The [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] -public class CompatBotAdapter(BotApplication botApplication, IHttpContextAccessor httpContextAccessor = default!, ILogger logger = default!) : BotAdapter +public class CompatBotAdapter(TeamsBotApplication botApplication, IHttpContextAccessor httpContextAccessor = default!, ILogger logger = default!) : BotAdapter { /// /// Deletes an activity from the conversation. @@ -32,8 +30,6 @@ public class CompatBotAdapter(BotApplication botApplication, IHttpContextAccesso /// /// /// - /// - /// public override async Task DeleteActivityAsync(ITurnContext turnContext, ConversationReference reference, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(turnContext); @@ -56,7 +52,7 @@ public override async Task SendActivitiesAsync(ITurnContext for (int i = 0; i < activities.Length; i++) { - var activity = activities[i]; + Activity activity = activities[i]; if (activity.Type == ActivityTypes.Trace) { @@ -65,8 +61,8 @@ public override async Task SendActivitiesAsync(ITurnContext if (activity.Type == "invokeResponse") { - await WriteInvokeResponseToHttpResponseAsync(activity.Value as InvokeResponse, cancellationToken).ConfigureAwait(false); - return [new ResourceResponse() { Id = null } ]; + WriteInvokeResponseToHttpResponse(activity.Value as InvokeResponse); + return [new ResourceResponse() { Id = null }]; } SendActivityResponse? resp = await botApplication.SendActivityAsync(activity.FromCompatActivity(), cancellationToken).ConfigureAwait(false); @@ -84,12 +80,11 @@ public override async Task SendActivitiesAsync(ITurnContext /// /// /// - /// - /// + /// ResourceResponse public override async Task UpdateActivityAsync(ITurnContext turnContext, Activity activity, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(activity); - var res = await botApplication.ConversationClient.UpdateActivityAsync( + UpdateActivityResponse res = await botApplication.ConversationClient.UpdateActivityAsync( activity.Conversation.Id, activity.Id, activity.FromCompatActivity(), @@ -97,50 +92,19 @@ public override async Task UpdateActivityAsync(ITurnContext tu return new ResourceResponse() { Id = res.Id }; } - private async Task WriteInvokeResponseToHttpResponseAsync(InvokeResponse? invokeResponse, CancellationToken cancellationToken = default) + private void WriteInvokeResponseToHttpResponse(InvokeResponse? invokeResponse) { ArgumentNullException.ThrowIfNull(invokeResponse); - var response = httpContextAccessor?.HttpContext?.Response; - ArgumentNullException.ThrowIfNull(response); - - using StreamWriter httpResponseStreamWriter = new (response.BodyWriter.AsStream()); - using JsonTextWriter httpResponseJsonWriter = new (httpResponseStreamWriter); - Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(httpResponseJsonWriter, invokeResponse.Body); + HttpResponse? response = httpContextAccessor?.HttpContext?.Response; + if (response is not null && !response.HasStarted) + { + using StreamWriter httpResponseStreamWriter = new(response.BodyWriter.AsStream()); + using JsonTextWriter httpResponseJsonWriter = new(httpResponseStreamWriter); + Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(httpResponseJsonWriter, invokeResponse); + } + else + { + logger.LogWarning("HTTP response is null or has started. Cannot write invoke response. ResponseStarted: {ResponseStarted}", response?.HasStarted); + } } - - //#pragma warning disable CA1869 // Cache and reuse 'JsonSerializerOptions' instances - // var options = new JsonSerializerOptions - // { - // PropertyNamingPolicy = JsonNamingPolicy.CamelCase, - // DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull, - // Converters = { - // new System.Text.Json.Serialization.JsonStringEnumConverter(JsonNamingPolicy.CamelCase), - // } - // }; - //#pragma warning restore CA1869 // Cache and reuse 'JsonSerializerOptions' instances - - // string jsonBody = System.Text.Json.JsonSerializer.Serialize(invokeResponse.Body, options); - - // response.StatusCode = invokeResponse.Status; - // response.ContentType = "application/json"; - // await response.WriteAsync(jsonBody, cancellationToken).ConfigureAwait(false); - - - //using StreamWriter sw = new StreamWriter(response.BodyWriter.AsStream()); - //using JsonWriter jw = new JsonTextWriter(sw); - //Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(jw, invokeResponse.Body); - - //JsonSerializerOptions options = new() - //{ - // PropertyNamingPolicy = JsonNamingPolicy.CamelCase, - // DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull, - // Converters = { - // new System.Text.Json.Serialization.JsonStringEnumConverter(JsonNamingPolicy.CamelCase), - // new AttachmentMemoryStreamConverter(), - // new AttachmentContentConverter() } - //}; - - //await response.WriteAsJsonAsync(invokeResponse.Body, options, cancellationToken).ConfigureAwait(false); - - } diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs b/core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs index f2a95bcb..20ff4b45 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs @@ -20,6 +20,8 @@ public async Task> CreateCon Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { + ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); + Microsoft.Bot.Core.ConversationParameters convoParams = new() { Activity = parameters.Activity.FromCompatActivity() @@ -28,7 +30,7 @@ public async Task> CreateCon CreateConversationResponse res = await _client.CreateConversationAsync( convoParams, - new Uri(ServiceUrl!), + new Uri(ServiceUrl), AgenticIdentity.FromProperties(convoParams.Activity?.From.Properties), convertedHeaders, cancellationToken).ConfigureAwait(false); @@ -50,10 +52,12 @@ public async Task> CreateCon public async Task DeleteActivityWithHttpMessagesAsync(string conversationId, string activityId, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { + ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); + await _client.DeleteActivityAsync( conversationId, activityId, - new Uri(ServiceUrl!), + new Uri(ServiceUrl), null!, ConvertHeaders(customHeaders), cancellationToken).ConfigureAwait(false); @@ -65,10 +69,12 @@ await _client.DeleteActivityAsync( public async Task DeleteConversationMemberWithHttpMessagesAsync(string conversationId, string memberId, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { + ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); + await _client.DeleteConversationMemberAsync( conversationId, memberId, - new Uri(ServiceUrl!), + new Uri(ServiceUrl), null!, ConvertHeaders(customHeaders), cancellationToken).ConfigureAwait(false); @@ -98,11 +104,13 @@ public async Task>> GetActivityMembe public async Task>> GetConversationMembersWithHttpMessagesAsync(string conversationId, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { + ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); IList members = await _client.GetConversationMembersAsync( conversationId, - new Uri(ServiceUrl!), + new Uri(ServiceUrl), null, convertedHeaders, cancellationToken).ConfigureAwait(false); @@ -118,11 +126,13 @@ public async Task>> GetConversationM public async Task> GetConversationPagedMembersWithHttpMessagesAsync(string conversationId, int? pageSize = null, string? continuationToken = null, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { + ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); PagedMembersResult pagedMembers = await _client.GetConversationPagedMembersAsync( conversationId, - new Uri(ServiceUrl!), + new Uri(ServiceUrl), pageSize, continuationToken, null, @@ -203,17 +213,19 @@ public async Task> ReplyToActivityWithHt public async Task> SendConversationHistoryWithHttpMessagesAsync(string conversationId, Microsoft.Bot.Schema.Transcript transcript, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { + ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); Transcript coreTranscript = new() { - Activities = transcript.Activities?.Select(a => a.FromCompatActivity()).ToList() + Activities = transcript.Activities?.Select(a => a.FromCompatActivity() as CoreActivity).ToList() }; SendConversationHistoryResponse response = await _client.SendConversationHistoryAsync( conversationId, coreTranscript, - new Uri(ServiceUrl!), + new Uri(ServiceUrl), null, convertedHeaders, cancellationToken).ConfigureAwait(false); @@ -275,6 +287,7 @@ public async Task> UpdateActivityWithHtt public async Task> UploadAttachmentWithHttpMessagesAsync(string conversationId, Microsoft.Bot.Schema.AttachmentData attachmentUpload, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { + ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); Dictionary? convertedHeaders = ConvertHeaders(customHeaders); AttachmentData coreAttachmentData = new() @@ -288,7 +301,7 @@ public async Task> UploadAttachmentWithH UploadAttachmentResponse response = await _client.UploadAttachmentAsync( conversationId, coreAttachmentData, - new Uri(ServiceUrl!), + new Uri(ServiceUrl), null, convertedHeaders, cancellationToken).ConfigureAwait(false); @@ -323,9 +336,12 @@ public async Task> UploadAttachmentWithH public async Task> GetConversationMemberWithHttpMessagesAsync(string userId, string conversationId, Dictionary> customHeaders = null!, CancellationToken cancellationToken = default) { + ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); + Dictionary? convertedHeaders = ConvertHeaders(customHeaders); - Schema.ConversationAccount response = await _client.GetConversationMemberAsync(conversationId, userId, new Uri(ServiceUrl!), null!, convertedHeaders, cancellationToken).ConfigureAwait(false); + Teams.BotApps.Schema.TeamsConversationAccount response = await _client.GetConversationMemberAsync( + conversationId, userId, new Uri(ServiceUrl), null!, convertedHeaders, cancellationToken).ConfigureAwait(false); return new HttpOperationResponse { diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs b/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs index 0dbd3c8a..d076bd0a 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using Microsoft.Bot.Builder.Integration.AspNet.Core; -using Microsoft.Bot.Core.Hosting; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; +using Microsoft.Teams.BotApps; namespace Microsoft.Bot.Core.Compat; @@ -42,7 +42,7 @@ public static IHostApplicationBuilder AddCompatAdapter(this IHostApplicationBuil /// compatibility adapter and related services registered. public static IServiceCollection AddCompatAdapter(this IServiceCollection services) { - services.AddBotApplication(); + services.AddTeamsBotApplication(); services.AddSingleton(); services.AddSingleton(); return services; diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs b/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs deleted file mode 100644 index bcd91aeb..00000000 --- a/core/src/Microsoft.Bot.Core.Compat/CompatMiddlewareAdapter.cs +++ /dev/null @@ -1,22 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using Microsoft.Bot.Builder; -using Microsoft.Bot.Core.Schema; - -namespace Microsoft.Bot.Core.Compat; - -internal sealed class CompatMiddlewareAdapter(IMiddleware bfMiddleWare) : ITurnMiddleWare -{ - public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) - { -#pragma warning disable CA2000 // Dispose objects before losing scope - TurnContext turnContext = new(new CompatBotAdapter(botApplication), activity.ToCompatActivity()); -#pragma warning restore CA2000 // Dispose objects before losing scope - turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); - CompatConnectorClient connectionClient = new(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); - turnContext.TurnState.Add(connectionClient); - return bfMiddleWare.OnTurnAsync(turnContext, (activity) - => nextTurn(cancellationToken), cancellationToken); - } -} diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs b/core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs index c0cf0914..a3553390 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs +++ b/core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs @@ -1,4 +1,6 @@ -using Microsoft.Bot.Connector.Authentication; +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Schema; namespace Microsoft.Bot.Core.Compat; @@ -37,7 +39,7 @@ public async override Task GetSignInResourceAsync(string connect { ArgumentNullException.ThrowIfNull(activity); GetSignInResourceResult res = await utc.GetSignInResource(activity.From.Id, connectionName, activity.ChannelId, finalRedirect, cancellationToken).ConfigureAwait(false); - var signInResource = new SignInResource + SignInResource signInResource = new() { SignInLink = res!.SignInLink }; diff --git a/core/src/Microsoft.Bot.Core.Compat/InternalsVisibleTo.cs b/core/src/Microsoft.Bot.Core.Compat/InternalsVisibleTo.cs new file mode 100644 index 00000000..aacccbef --- /dev/null +++ b/core/src/Microsoft.Bot.Core.Compat/InternalsVisibleTo.cs @@ -0,0 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Runtime.CompilerServices; + +[assembly: InternalsVisibleTo("Microsoft.Bot.Core.Tests")] diff --git a/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj b/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj index 2ed30e36..6f7e7ba5 100644 --- a/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj +++ b/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj @@ -6,10 +6,10 @@ enable - + - + diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Bot.Core/BotApplication.cs index 05361f28..0ceab1d7 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Bot.Core/BotApplication.cs @@ -16,7 +16,7 @@ public class BotApplication { private readonly ILogger _logger; private readonly ConversationClient? _conversationClient; - private UserTokenClient? _userTokenClient; + private readonly UserTokenClient? _userTokenClient; private readonly string _serviceKey; internal TurnMiddleware MiddleWare { get; } diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Bot.Core/ConversationClient.cs index f29f2e5e..75e3b273 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Bot.Core/ConversationClient.cs @@ -1,10 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Net.Mime; -using System.Text; using System.Text.Json; -using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Http; using Microsoft.Bot.Core.Schema; using Microsoft.Extensions.Logging; @@ -20,6 +18,7 @@ namespace Microsoft.Bot.Core; [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class ConversationClient(HttpClient httpClient, ILogger logger = default!) { + private readonly BotHttpClient _botHttpClient = new(httpClient, logger); internal const string ConversationHttpClientName = "BotConversationClient"; /// @@ -40,22 +39,29 @@ public async Task SendActivityAsync(CoreActivity activity, { ArgumentNullException.ThrowIfNull(activity); ArgumentNullException.ThrowIfNull(activity.Conversation); - ArgumentNullException.ThrowIfNullOrWhiteSpace(activity.Conversation.Id); + ArgumentException.ThrowIfNullOrWhiteSpace(activity.Conversation.Id); ArgumentNullException.ThrowIfNull(activity.ServiceUrl); string url = $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{activity.Conversation.Id}/activities/"; + + if (activity.ChannelId == "agents") + { + logger.LogInformation("Truncating conversation ID for 'agents' channel to comply with length restrictions."); + string conversationId = activity.Conversation.Id; + string convId = conversationId.Length > 325 ? conversationId[..325] : conversationId; + url = $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{convId}/activities"; + } + string body = activity.ToJson(); logger?.LogTrace("Sending activity to {Url}: {Activity}", url, body); - return await SendHttpRequestAsync( + return (await _botHttpClient.SendAsync( HttpMethod.Post, url, body, - activity.From.GetAgenticIdentity(), - "sending activity", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(activity.From.GetAgenticIdentity(), "sending activity", customHeaders), + cancellationToken).ConfigureAwait(false))!; } /// @@ -80,14 +86,12 @@ public async Task UpdateActivityAsync(string conversatio logger.LogTrace("Updating activity at {Url}: {Activity}", url, body); - return await SendHttpRequestAsync( + return (await _botHttpClient.SendAsync( HttpMethod.Put, url, body, - activity.From.GetAgenticIdentity(), - "updating activity", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(activity.From.GetAgenticIdentity(), "updating activity", customHeaders), + cancellationToken).ConfigureAwait(false))!; } @@ -112,13 +116,11 @@ public async Task DeleteActivityAsync(string conversationId, string activityId, logger.LogTrace("Deleting activity at {Url}", url); - await SendHttpRequestAsync( + await _botHttpClient.SendAsync( HttpMethod.Delete, url, body: null, - agenticIdentity: agenticIdentity, - "deleting activity", - customHeaders, + CreateRequestOptions(agenticIdentity, "deleting activity", customHeaders), cancellationToken).ConfigureAwait(false); } @@ -166,14 +168,12 @@ public async Task> GetConversationMembersAsync(string logger.LogTrace("Getting conversation members from {Url}", url); - return await SendHttpRequestAsync>( + return (await _botHttpClient.SendAsync>( HttpMethod.Get, url, body: null, - agenticIdentity, - "getting conversation members", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(agenticIdentity, "getting conversation members", customHeaders), + cancellationToken).ConfigureAwait(false))!; } @@ -187,7 +187,7 @@ public async Task> GetConversationMembersAsync(string /// /// /// - public async Task GetConversationMemberAsync(string conversationId, string userId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public async Task GetConversationMemberAsync(string conversationId, string userId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) where T : ConversationAccount { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(serviceUrl); @@ -197,14 +197,12 @@ public async Task GetConversationMemberAsync(string convers logger.LogTrace("Getting conversation members from {Url}", url); - return await SendHttpRequestAsync( + return (await _botHttpClient.SendAsync( HttpMethod.Get, url, body: null, - agenticIdentity, - "getting conversation members", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(agenticIdentity, "getting conversation member", customHeaders), + cancellationToken).ConfigureAwait(false))!; } /// @@ -229,14 +227,12 @@ public async Task GetConversationsAsync(Uri serviceUrl logger.LogTrace("Getting conversations from {Url}", url); - return await SendHttpRequestAsync( + return (await _botHttpClient.SendAsync( HttpMethod.Get, url, body: null, - agenticIdentity, - "getting conversations", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(agenticIdentity, "getting conversations", customHeaders), + cancellationToken).ConfigureAwait(false))!; } /// @@ -260,14 +256,12 @@ public async Task> GetActivityMembersAsync(string con logger.LogTrace("Getting activity members from {Url}", url); - return await SendHttpRequestAsync>( + return (await _botHttpClient.SendAsync>( HttpMethod.Get, url, body: null, - agenticIdentity, - "getting activity members", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(agenticIdentity, "getting activity members", customHeaders), + cancellationToken).ConfigureAwait(false))!; } /// @@ -289,14 +283,12 @@ public async Task CreateConversationAsync(Conversati logger.LogTrace("Creating conversation at {Url} with parameters: {Parameters}", url, JsonSerializer.Serialize(parameters)); - return await SendHttpRequestAsync( + return (await _botHttpClient.SendAsync( HttpMethod.Post, url, JsonSerializer.Serialize(parameters), - agenticIdentity, - "creating conversation", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(agenticIdentity, "creating conversation", customHeaders), + cancellationToken).ConfigureAwait(false))!; } /// @@ -334,14 +326,12 @@ public async Task GetConversationPagedMembersAsync(string co logger.LogTrace("Getting paged conversation members from {Url}", url); - return await SendHttpRequestAsync( + return (await _botHttpClient.SendAsync( HttpMethod.Get, url, body: null, - agenticIdentity, - "getting paged conversation members", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(agenticIdentity, "getting paged conversation members", customHeaders), + cancellationToken).ConfigureAwait(false))!; } /// @@ -366,13 +356,11 @@ public async Task DeleteConversationMemberAsync(string conversationId, string me logger.LogTrace("Deleting conversation member at {Url}", url); - await SendHttpRequestAsync( + await _botHttpClient.SendAsync( HttpMethod.Delete, url, body: null, - agenticIdentity, - "deleting conversation member", - customHeaders, + CreateRequestOptions(agenticIdentity, "deleting conversation member", customHeaders), cancellationToken).ConfigureAwait(false); } @@ -398,14 +386,12 @@ public async Task SendConversationHistoryAsync( logger.LogTrace("Sending conversation history to {Url}: {Transcript}", url, JsonSerializer.Serialize(transcript)); - return await SendHttpRequestAsync( + return (await _botHttpClient.SendAsync( HttpMethod.Post, url, JsonSerializer.Serialize(transcript), - agenticIdentity, - "sending conversation history", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(agenticIdentity, "sending conversation history", customHeaders), + cancellationToken).ConfigureAwait(false))!; } /// @@ -430,66 +416,20 @@ public async Task UploadAttachmentAsync(string convers logger.LogTrace("Uploading attachment to {Url}: {AttachmentData}", url, JsonSerializer.Serialize(attachmentData)); - return await SendHttpRequestAsync( + return (await _botHttpClient.SendAsync( HttpMethod.Post, url, JsonSerializer.Serialize(attachmentData), - agenticIdentity, - "uploading attachment", - customHeaders, - cancellationToken).ConfigureAwait(false); + CreateRequestOptions(agenticIdentity, "uploading attachment", customHeaders), + cancellationToken).ConfigureAwait(false))!; } - private async Task SendHttpRequestAsync(HttpMethod method, string url, string? body, AgenticIdentity? agenticIdentity, string operationDescription, CustomHeaders? customHeaders, CancellationToken cancellationToken) - { - using HttpRequestMessage request = new(method, url); - - if (body is not null) + private BotRequestOptions CreateRequestOptions(AgenticIdentity? agenticIdentity, string operationDescription, CustomHeaders? customHeaders) => + new() { - request.Content = new StringContent(body, Encoding.UTF8, MediaTypeNames.Application.Json); - } - - if (agenticIdentity is not null) - { - request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, agenticIdentity); - } - - // Apply default custom headers - foreach (KeyValuePair header in DefaultCustomHeaders) - { - request.Headers.TryAddWithoutValidation(header.Key, header.Value); - } - - // Apply method-level custom headers (these override default headers if same key) - if (customHeaders is not null) - { - foreach (KeyValuePair header in customHeaders) - { - request.Headers.Remove(header.Key); - request.Headers.TryAddWithoutValidation(header.Key, header.Value); - } - } - - logger?.LogTrace("Sending HTTP {Method} request to {Url} with body: {Body}", method, url, body); - - using HttpResponseMessage resp = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); - - if (resp.IsSuccessStatusCode) - { - string responseString = await resp.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); - if (responseString.Length > 2) // to handle empty response - { - T? result = JsonSerializer.Deserialize(responseString); - return result ?? throw new InvalidOperationException($"Failed to deserialize response for {operationDescription}"); - } - // Empty response - return default value (e.g., for DELETE operations) - return default!; - } - else - { - string errResponseString = await resp.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); - throw new HttpRequestException($"Error {operationDescription} {resp.StatusCode}. {errResponseString}"); - } - } - + AgenticIdentity = agenticIdentity, + OperationDescription = operationDescription, + DefaultHeaders = DefaultCustomHeaders, + CustomHeaders = customHeaders + }; } diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 65bf37e7..000c408f 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -3,7 +3,6 @@ using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Http; -using Microsoft.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; @@ -94,9 +93,9 @@ private static IServiceCollection AddBotClient( string httpClientName, string sectionName) where TClient : class { - var sp = services.BuildServiceProvider(); - var configuration = sp.GetRequiredService(); - var logger = sp.GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); + ServiceProvider sp = services.BuildServiceProvider(); + IConfiguration configuration = sp.GetRequiredService(); + ILogger logger = sp.GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); ArgumentNullException.ThrowIfNull(configuration); string scope = "https://api.botframework.com/.default"; diff --git a/core/src/Microsoft.Bot.Core/Http/BotHttpClient.cs b/core/src/Microsoft.Bot.Core/Http/BotHttpClient.cs new file mode 100644 index 00000000..3e1911af --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Http/BotHttpClient.cs @@ -0,0 +1,255 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Globalization; +using System.Net; +using System.Net.Mime; +using System.Text; +using System.Text.Json; +using Microsoft.AspNetCore.WebUtilities; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Extensions.Logging; + +namespace Microsoft.Bot.Core.Http; +/// +/// Provides shared HTTP request functionality for bot clients. +/// +/// The HTTP client instance used to send requests. +/// The logger instance used for logging. Optional. +[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] +public class BotHttpClient(HttpClient httpClient, ILogger? logger = null) +{ + private static readonly JsonSerializerOptions DefaultJsonOptions = new() + { + PropertyNamingPolicy = JsonNamingPolicy.CamelCase + }; + + /// + /// Sends an HTTP request and deserializes the response. + /// + /// The type to deserialize the response to. + /// The HTTP method to use. + /// The full URL for the request. + /// The request body content. Optional. + /// The request options. Optional. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the deserialized response, or null if the response is empty or 404 (when ReturnNullOnNotFound is true). + /// Thrown if the request fails and the failure is not handled by options. + [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "String URLs are used for consistency with existing API patterns")] + public async Task SendAsync( + HttpMethod method, + string url, + string? body = null, + BotRequestOptions? options = null, + CancellationToken cancellationToken = default) + { + options ??= new BotRequestOptions(); + + using HttpRequestMessage request = CreateRequest(method, url, body, options); + + logger?.LogTrace("Sending HTTP {Method} request to {Url} with body: {Body}", method, url, body); + + using HttpResponseMessage response = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); + + return await HandleResponseAsync(response, method, url, options, cancellationToken).ConfigureAwait(false); + } + + /// + /// Sends an HTTP request with query parameters and deserializes the response. + /// + /// The type to deserialize the response to. + /// The HTTP method to use. + /// The base URL for the request. + /// The endpoint path to append to the base URL. + /// The query parameters to include in the request. Optional. + /// The request body content. Optional. + /// The request options. Optional. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the deserialized response, or null if the response is empty or 404 (when ReturnNullOnNotFound is true). + /// Thrown if the request fails and the failure is not handled by options. + [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "String URLs are used for consistency with existing API patterns")] + public async Task SendAsync( + HttpMethod method, + string baseUrl, + string endpoint, + Dictionary? queryParams = null, + string? body = null, + BotRequestOptions? options = null, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(baseUrl); + ArgumentNullException.ThrowIfNull(endpoint); + + string fullPath = $"{baseUrl.TrimEnd('/')}/{endpoint.TrimStart('/')}"; + string url = queryParams?.Count > 0 + ? QueryHelpers.AddQueryString(fullPath, queryParams) + : fullPath; + + return await SendAsync(method, url, body, options, cancellationToken).ConfigureAwait(false); + } + + /// + /// Sends an HTTP request without expecting a response body. + /// + /// The HTTP method to use. + /// The full URL for the request. + /// The request body content. Optional. + /// The request options. Optional. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. + /// Thrown if the request fails. + [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "String URLs are used for consistency with existing API patterns")] + public async Task SendAsync( + HttpMethod method, + string url, + string? body = null, + BotRequestOptions? options = null, + CancellationToken cancellationToken = default) + { + await SendAsync(method, url, body, options, cancellationToken).ConfigureAwait(false); + } + + /// + /// Sends an HTTP request with query parameters without expecting a response body. + /// + /// The HTTP method to use. + /// The base URL for the request. + /// The endpoint path to append to the base URL. + /// The query parameters to include in the request. Optional. + /// The request body content. Optional. + /// The request options. Optional. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. + /// Thrown if the request fails. + [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "String URLs are used for consistency with existing API patterns")] + public async Task SendAsync( + HttpMethod method, + string baseUrl, + string endpoint, + Dictionary? queryParams = null, + string? body = null, + BotRequestOptions? options = null, + CancellationToken cancellationToken = default) + { + await SendAsync(method, baseUrl, endpoint, queryParams, body, options, cancellationToken).ConfigureAwait(false); + } + + private static HttpRequestMessage CreateRequest(HttpMethod method, string url, string? body, BotRequestOptions options) + { + HttpRequestMessage request = new(method, url); + + if (body is not null) + { + request.Content = new StringContent(body, Encoding.UTF8, MediaTypeNames.Application.Json); + } + + if (options.AgenticIdentity is not null) + { + request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, options.AgenticIdentity); + } + + if (options.DefaultHeaders is not null) + { + foreach (KeyValuePair header in options.DefaultHeaders) + { + request.Headers.TryAddWithoutValidation(header.Key, header.Value); + } + } + + if (options.CustomHeaders is not null) + { + foreach (KeyValuePair header in options.CustomHeaders) + { + request.Headers.Remove(header.Key); + request.Headers.TryAddWithoutValidation(header.Key, header.Value); + } + } + + return request; + } + + private async Task HandleResponseAsync( + HttpResponseMessage response, + HttpMethod method, + string url, + BotRequestOptions options, + CancellationToken cancellationToken) + { + if (response.IsSuccessStatusCode) + { + return await DeserializeResponseAsync(response, options, cancellationToken).ConfigureAwait(false); + } + + if (response.StatusCode == HttpStatusCode.NotFound && options.ReturnNullOnNotFound) + { + logger?.LogWarning("Resource not found: {Url}", url); + return default; + } + + string errorContent = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); + string responseHeaders = FormatResponseHeaders(response); + + logger?.LogWarning( + "HTTP request error {Method} {Url}\nStatus Code: {StatusCode}\nResponse Headers: {ResponseHeaders}\nResponse Body: {ResponseBody}", + method, url, response.StatusCode, responseHeaders, errorContent); + + string operationDescription = options.OperationDescription ?? "request"; + throw new HttpRequestException( + $"Error {operationDescription} {response.StatusCode}. {errorContent}", + inner: null, + statusCode: response.StatusCode); + } + + private static async Task DeserializeResponseAsync( + HttpResponseMessage response, + BotRequestOptions options, + CancellationToken cancellationToken) + { + string responseString = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); + + if (string.IsNullOrWhiteSpace(responseString) || responseString.Length <= 2) + { + return default; + } + + if (typeof(T) == typeof(string)) + { + try + { + T? result = JsonSerializer.Deserialize(responseString, DefaultJsonOptions); + return result ?? (T)(object)responseString; + } + catch (JsonException) + { + return (T)(object)responseString; + } + } + + T? deserializedResult = JsonSerializer.Deserialize(responseString, DefaultJsonOptions); + + if (deserializedResult is null) + { + string operationDescription = options.OperationDescription ?? "request"; + throw new InvalidOperationException($"Failed to deserialize response for {operationDescription}"); + } + + return deserializedResult; + } + + private static string FormatResponseHeaders(HttpResponseMessage response) + { + StringBuilder sb = new(); + + foreach (KeyValuePair> header in response.Headers) + { + sb.AppendLine(CultureInfo.InvariantCulture, $"Response header: {header.Key} : {string.Join(",", header.Value)}"); + } + + foreach (KeyValuePair> header in response.TrailingHeaders) + { + sb.AppendLine(CultureInfo.InvariantCulture, $"Response trailing header: {header.Key} : {string.Join(",", header.Value)}"); + } + + return sb.ToString(); + } +} diff --git a/core/src/Microsoft.Bot.Core/Http/BotRequestOptions.cs b/core/src/Microsoft.Bot.Core/Http/BotRequestOptions.cs new file mode 100644 index 00000000..fb06885a --- /dev/null +++ b/core/src/Microsoft.Bot.Core/Http/BotRequestOptions.cs @@ -0,0 +1,40 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Schema; + +namespace Microsoft.Bot.Core.Http; + +using CustomHeaders = Dictionary; + +/// +/// Options for configuring a bot HTTP request. +/// +public record BotRequestOptions +{ + /// + /// Gets the agentic identity for authentication. + /// + public AgenticIdentity? AgenticIdentity { get; init; } + + /// + /// Gets the custom headers to include in the request. + /// These headers override default headers if the same key exists. + /// + public CustomHeaders? CustomHeaders { get; init; } + + /// + /// Gets the default custom headers that will be included in all requests. + /// + public CustomHeaders? DefaultHeaders { get; init; } + + /// + /// Gets a value indicating whether to return null instead of throwing on 404 responses. + /// + public bool ReturnNullOnNotFound { get; init; } + + /// + /// Gets a description of the operation for logging and error messages. + /// + public string? OperationDescription { get; init; } +} diff --git a/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj b/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj index cb181fc6..791c399b 100644 --- a/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj +++ b/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj @@ -9,6 +9,7 @@ + diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs index b4113d59..2f9ff483 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs @@ -187,27 +187,6 @@ public static string ToJson(T instance) where T : CoreActivity public static CoreActivity FromJsonString(string json) => JsonSerializer.Deserialize(json, CoreActivityJsonContext.Default.CoreActivity)!; - /// - /// Deserializes the specified JSON string to an object of type T. - /// - /// The deserialization uses default JSON options defined by the application. If the JSON is - /// invalid or does not match the target type, a JsonException may be thrown. - /// The type of the object to deserialize to. Must be compatible with the JSON structure. - /// The JSON string to deserialize. Cannot be null or empty. - /// An instance of type T that represents the deserialized JSON data. - public static T FromJsonString(string json) where T : CoreActivity - => JsonSerializer.Deserialize(json, ReflectionJsonOptions)!; - - /// - /// Deserializes the specified JSON string to an object of type T using the provided JsonSerializerOptions. - /// - /// - /// - /// - /// - public static T FromJsonString(string json, JsonTypeInfo options) where T : CoreActivity - => JsonSerializer.Deserialize(json, options)!; - /// /// Asynchronously deserializes a JSON stream into a object. /// @@ -247,5 +226,5 @@ public static T FromJsonString(string json, JsonTypeInfo options) where T /// /// public static CoreActivityBuilder CreateBuilder() => new(); - + } diff --git a/core/src/Microsoft.Bot.Core/UserTokenClient.cs b/core/src/Microsoft.Bot.Core/UserTokenClient.cs index e9c5872f..ed7430d6 100644 --- a/core/src/Microsoft.Bot.Core/UserTokenClient.cs +++ b/core/src/Microsoft.Bot.Core/UserTokenClient.cs @@ -1,27 +1,28 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.AspNetCore.WebUtilities; -using Microsoft.Extensions.Logging; -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Schema; using System.Text; using System.Text.Json; +using Microsoft.Bot.Core.Http; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.Logging; namespace Microsoft.Bot.Core; /// /// Client for managing user tokens via HTTP requests. /// +/// /// /// [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] -public class UserTokenClient(HttpClient httpClient, ILogger logger) +public class UserTokenClient(HttpClient httpClient, IConfiguration configuration, ILogger logger) { internal const string UserTokenHttpClientName = "BotUserTokenClient"; private readonly ILogger _logger = logger; - private readonly string _apiEndpoint = "https://token.botframework.com"; + private readonly BotHttpClient _botHttpClient = new(httpClient, logger); + private readonly string _apiEndpoint = configuration["UserTokenApiEndpoint"] ?? "https://token.botframework.com"; private readonly JsonSerializerOptions _defaultOptions = new() { PropertyNamingPolicy = JsonNamingPolicy.CamelCase }; internal AgenticIdentity? AgenticIdentity { get; set; } @@ -47,8 +48,16 @@ public async Task GetTokenStatusAsync(string userId, str queryParams.Add("include", include); } - string? resJson = await CallApiAsync("api/usertoken/GetTokenStatus", queryParams, cancellationToken: cancellationToken).ConfigureAwait(false); - IList result = JsonSerializer.Deserialize>(resJson!, _defaultOptions)!; + _logger.LogInformation("Calling API endpoint: {Endpoint}", "api/usertoken/GetTokenStatus"); + IList? result = await _botHttpClient.SendAsync>( + HttpMethod.Get, + _apiEndpoint, + "api/usertoken/GetTokenStatus", + queryParams, + body: null, + CreateRequestOptions("getting token status"), + cancellationToken).ConfigureAwait(false); + if (result == null || result.Count == 0) { return [new GetTokenStatusResult { HasToken = false }]; @@ -79,14 +88,16 @@ public async Task GetTokenStatusAsync(string userId, str { queryParams.Add("code", code); } - string? resJson = await CallApiAsync("api/usertoken/GetToken", queryParams, cancellationToken: cancellationToken).ConfigureAwait(false); - if (resJson is not null) - { - GetTokenResult result = JsonSerializer.Deserialize(resJson!, _defaultOptions)!; - return result; - } - return null; + _logger.LogInformation("Calling API endpoint: {Endpoint}", "api/usertoken/GetToken"); + return await _botHttpClient.SendAsync( + HttpMethod.Get, + _apiEndpoint, + "api/usertoken/GetToken", + queryParams, + body: null, + CreateRequestOptions("getting token", returnNullOnNotFound: true), + cancellationToken).ConfigureAwait(false); } /// @@ -108,8 +119,8 @@ public async Task GetSignInResource(string userId, stri User = new ConversationAccount { Id = userId }, } }; - var tokenExchangeStateJson = JsonSerializer.Serialize(tokenExchangeState, _defaultOptions); - var state = Convert.ToBase64String(Encoding.UTF8.GetBytes(tokenExchangeStateJson)); + string tokenExchangeStateJson = JsonSerializer.Serialize(tokenExchangeState, _defaultOptions); + string state = Convert.ToBase64String(Encoding.UTF8.GetBytes(tokenExchangeStateJson)); Dictionary queryParams = new() { @@ -121,9 +132,15 @@ public async Task GetSignInResource(string userId, stri queryParams.Add("finalRedirect", finalRedirect); } - string? resJson = await CallApiAsync("api/botsignin/GetSignInResource", queryParams, cancellationToken: cancellationToken).ConfigureAwait(false); - GetSignInResourceResult result = JsonSerializer.Deserialize(resJson!, _defaultOptions)!; - return result; + _logger.LogInformation("Calling API endpoint: {Endpoint}", "api/botsignin/GetSignInResource"); + return (await _botHttpClient.SendAsync( + HttpMethod.Get, + _apiEndpoint, + "api/botsignin/GetSignInResource", + queryParams, + body: null, + CreateRequestOptions("getting sign-in resource"), + cancellationToken).ConfigureAwait(false))!; } /// @@ -148,9 +165,15 @@ public async Task ExchangeTokenAsync(string userId, string conne token = exchangeToken }; - string? resJson = await CallApiAsync("api/usertoken/exchange", queryParams, method: HttpMethod.Post, JsonSerializer.Serialize(tokenExchangeRequest), cancellationToken).ConfigureAwait(false); - GetTokenResult result = JsonSerializer.Deserialize(resJson!, _defaultOptions)!; - return result!; + _logger.LogInformation("Calling API endpoint: {Endpoint}", "api/usertoken/exchange"); + return (await _botHttpClient.SendAsync( + HttpMethod.Post, + _apiEndpoint, + "api/usertoken/exchange", + queryParams, + JsonSerializer.Serialize(tokenExchangeRequest), + CreateRequestOptions("exchanging token"), + cancellationToken).ConfigureAwait(false))!; } /// @@ -177,8 +200,15 @@ public async Task SignOutUserAsync(string userId, string? connectionName = null, queryParams.Add("channelId", channelId); } - await CallApiAsync("api/usertoken/SignOut", queryParams, HttpMethod.Delete, cancellationToken: cancellationToken).ConfigureAwait(false); - return; + _logger.LogInformation("Calling API endpoint: {Endpoint}", "api/usertoken/SignOut"); + await _botHttpClient.SendAsync( + HttpMethod.Delete, + _apiEndpoint, + "api/usertoken/SignOut", + queryParams, + body: null, + CreateRequestOptions("signing out user"), + cancellationToken).ConfigureAwait(false); } /// @@ -200,89 +230,22 @@ public async Task> GetAadTokensAsync(string resourceUrls = resourceUrls ?? [] }; - string? respJson = await CallApiAsync("api/usertoken/GetAadTokens", body, cancellationToken).ConfigureAwait(false); - IDictionary res = JsonSerializer.Deserialize>(respJson!, _defaultOptions)!; - return res; + _logger.LogInformation("Calling API endpoint with POST: {Endpoint}", "api/usertoken/GetAadTokens"); + return (await _botHttpClient.SendAsync>( + HttpMethod.Post, + _apiEndpoint, + "api/usertoken/GetAadTokens", + queryParams: null, + JsonSerializer.Serialize(body), + CreateRequestOptions("getting AAD tokens"), + cancellationToken).ConfigureAwait(false))!; } - private async Task CallApiAsync(string endpoint, Dictionary queryParams, HttpMethod? method = null, string? body = null, CancellationToken cancellationToken = default) - { - - var fullPath = $"{_apiEndpoint}/{endpoint}"; - var requestUri = QueryHelpers.AddQueryString(fullPath, queryParams); - _logger.LogInformation("Calling API endpoint: {Endpoint}", requestUri); - - HttpMethod httpMethod = method ?? HttpMethod.Get; - #pragma warning disable CA2000 // HttpClient.SendAsync disposes the request - HttpRequestMessage request = new(httpMethod, requestUri); - #pragma warning restore CA2000 - - // Pass the agentic identity to the handler via request options - request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity); - - if (httpMethod == HttpMethod.Post && !string.IsNullOrEmpty(body)) - { - request.Content = new StringContent(body, Encoding.UTF8, "application/json"); - } - - HttpResponseMessage response = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); - - if (response.IsSuccessStatusCode) - { - var content = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); - _logger.LogInformation("API call successful. Status: {StatusCode}", response.StatusCode); - return content; - } - else + private BotRequestOptions CreateRequestOptions(string operationDescription, bool returnNullOnNotFound = false) => + new() { - var errorContent = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); - - if (response.StatusCode == System.Net.HttpStatusCode.NotFound) - { - _logger.LogWarning("User Token not found: {Endpoint}", requestUri); - return null; - } - else - { - _logger.LogError("API call failed. Status: {StatusCode}, Error: {Error}", - response.StatusCode, errorContent); - throw new HttpRequestException($"API call failed with status {response.StatusCode}: {errorContent}"); - } - } - } - - private async Task CallApiAsync(string endpoint, object body, CancellationToken cancellationToken = default) - { - var fullPath = $"{_apiEndpoint}/{endpoint}"; - - _logger.LogInformation("Calling API endpoint with POST: {Endpoint}", fullPath); - - var jsonContent = JsonSerializer.Serialize(body); - StringContent content = new(jsonContent, Encoding.UTF8, "application/json"); - - #pragma warning disable CA2000 // HttpClient.SendAsync disposes the request - HttpRequestMessage request = new(HttpMethod.Post, fullPath) - { - Content = content + AgenticIdentity = AgenticIdentity, + OperationDescription = operationDescription, + ReturnNullOnNotFound = returnNullOnNotFound }; - #pragma warning restore CA2000 - - request.Options.Set(BotAuthenticationHandler.AgenticIdentityKey, AgenticIdentity); - - HttpResponseMessage response = await httpClient.SendAsync(request, cancellationToken).ConfigureAwait(false); - - if (response.IsSuccessStatusCode) - { - var responseContent = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); - _logger.LogInformation("API call successful. Status: {StatusCode}", response.StatusCode); - return responseContent; - } - else - { - var errorContent = await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false); - _logger.LogError("API call failed. Status: {StatusCode}, Error: {Error}", - response.StatusCode, errorContent); - throw new HttpRequestException($"API call failed with status {response.StatusCode}: {errorContent}"); - } - } } diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs b/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs index f0da1252..9db28570 100644 --- a/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs +++ b/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs @@ -2,7 +2,6 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; -using Microsoft.Bot.Core; namespace Microsoft.Teams.BotApps.Handlers; diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs b/core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs index 8c1ddfcf..f1c3f505 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs +++ b/core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs @@ -2,7 +2,6 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; -using static System.Net.Mime.MediaTypeNames; namespace Microsoft.Teams.BotApps.Schema.Entities; diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs index ca74aa59..bfc8d81d 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs @@ -1,7 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Text.Json; using System.Text.Json.Serialization; +using System.Text.Json.Serialization.Metadata; using Microsoft.Bot.Core.Schema; using Microsoft.Teams.BotApps.Schema.Entities; @@ -29,8 +31,9 @@ public static TeamsActivity FromActivity(CoreActivity activity) /// /// /// - public static new TeamsActivity FromJsonString(string json) - => FromJsonString(json, TeamsActivityJsonContext.Default.TeamsActivity); + public static new TeamsActivity FromJsonString(string json) => + FromJsonString(json, TeamsActivityJsonContext.Default.TeamsActivity) + .Rebase(); /// /// Overrides the ToJson method to serialize the TeamsActivity object to a JSON string. @@ -50,6 +53,9 @@ public TeamsActivity() Conversation = new TeamsConversation(); } + private static TeamsActivity FromJsonString(string json, JsonTypeInfo options) + => JsonSerializer.Deserialize(json, options)!; + private TeamsActivity(CoreActivity activity) : base(activity) { // Convert base types to Teams-specific types @@ -74,7 +80,7 @@ internal TeamsActivity Rebase() { base.Attachments = this.Attachments?.ToJsonArray(); base.Entities = this.Entities?.ToJsonArray(); - base.ChannelData = this.ChannelData; + base.ChannelData = new TeamsChannelData(this.ChannelData); base.From = this.From; base.Recipient = this.Recipient; base.Conversation = this.Conversation; diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs index 93d20319..4739f1cb 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs @@ -40,5 +40,5 @@ public static class TeamsActivityType /// Message reaction activity type. /// public static readonly string MessageReaction = "messageReaction"; - + } diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs index fec9ceec..65bae5fc 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs @@ -24,7 +24,7 @@ static internal JsonArray ToJsonArray(this IList attachments) } return jsonArray; } -} +} /// /// Teams attachment model. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs index d80d9402..72cef021 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs @@ -27,17 +27,23 @@ public TeamsChannelData(ChannelData? cd) { if (cd is not null) { - if (cd.Properties.TryGetValue("teamsChannelId", out object? channelIdObj) && channelIdObj is JsonElement jeChannelId && jeChannelId.ValueKind == JsonValueKind.String) + if (cd.Properties.TryGetValue("teamsChannelId", out object? channelIdObj) + && channelIdObj is JsonElement jeChannelId + && jeChannelId.ValueKind == JsonValueKind.String) { TeamsChannelId = jeChannelId.GetString(); } - if (cd.Properties.TryGetValue("channel", out object? channelObj) && channelObj is JsonElement channelObjJE && channelObjJE.ValueKind == JsonValueKind.Object) + if (cd.Properties.TryGetValue("channel", out object? channelObj) + && channelObj is JsonElement channelObjJE + && channelObjJE.ValueKind == JsonValueKind.Object) { Channel = JsonSerializer.Deserialize(channelObjJE.GetRawText()); } - if (cd.Properties.TryGetValue("tenant", out object? tenantObj) && tenantObj is JsonElement je && je.ValueKind == JsonValueKind.Object) + if (cd.Properties.TryGetValue("tenant", out object? tenantObj) + && tenantObj is JsonElement je + && je.ValueKind == JsonValueKind.Object) { Tenant = JsonSerializer.Deserialize(je.GetRawText()); } diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs b/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs index f007673a..e6c8c9d0 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs +++ b/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs @@ -45,7 +45,8 @@ public TeamsConversationAccount(ConversationAccount conversationAccount) Properties = conversationAccount.Properties; Id = conversationAccount.Id ?? string.Empty; Name = conversationAccount.Name ?? string.Empty; - if (conversationAccount is not null && conversationAccount.Properties.TryGetValue("aadObjectId", out object? aadObj) + if (conversationAccount is not null + && conversationAccount.Properties.TryGetValue("aadObjectId", out object? aadObj) && aadObj is JsonElement je && je.ValueKind == JsonValueKind.String) { diff --git a/core/src/Microsoft.Teams.BotApps/TeamsApiClient.Models.cs b/core/src/Microsoft.Teams.BotApps/TeamsApiClient.Models.cs new file mode 100644 index 00000000..f8ef3905 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/TeamsApiClient.Models.cs @@ -0,0 +1,488 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Teams.BotApps; + +/// +/// Represents a list of channels in a team. +/// +public class ChannelList +{ + /// + /// Gets or sets the list of channel conversations. + /// + [JsonPropertyName("conversations")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? Channels { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only +} + +/// +/// Represents detailed information about a team. +/// +public class TeamDetails +{ + /// + /// Gets or sets the unique identifier of the team. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Gets or sets the name of the team. + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// + /// Gets or sets the Azure Active Directory group ID associated with the team. + /// + [JsonPropertyName("aadGroupId")] + public string? AadGroupId { get; set; } + + /// + /// Gets or sets the number of channels in the team. + /// + [JsonPropertyName("channelCount")] + public int? ChannelCount { get; set; } + + /// + /// Gets or sets the number of members in the team. + /// + [JsonPropertyName("memberCount")] + public int? MemberCount { get; set; } + + /// + /// Gets or sets the type of the team. Valid values are standard, sharedChannel and privateChannel. + /// + [JsonPropertyName("type")] + public string? Type { get; set; } +} + +/// +/// Represents information about a meeting. +/// +public class MeetingInfo +{ + ///// + ///// Gets or sets the unique identifier of the meeting. + ///// + //[JsonPropertyName("id")] + //public string? Id { get; set; } + + /// + /// Gets or sets the details of the meeting. + /// + [JsonPropertyName("details")] + public MeetingDetails? Details { get; set; } + + /// + /// Gets or sets the conversation associated with the meeting. + /// + [JsonPropertyName("conversation")] + public ConversationAccount? Conversation { get; set; } + + /// + /// Gets or sets the organizer of the meeting. + /// + [JsonPropertyName("organizer")] + public ConversationAccount? Organizer { get; set; } +} + +/// +/// Represents detailed information about a meeting. +/// +public class MeetingDetails +{ + /// + /// Gets or sets the unique identifier of the meeting. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Gets or sets the Microsoft Graph resource ID of the meeting. + /// + [JsonPropertyName("msGraphResourceId")] + public string? MsGraphResourceId { get; set; } + + /// + /// Gets or sets the scheduled start time of the meeting. + /// + [JsonPropertyName("scheduledStartTime")] + public DateTimeOffset? ScheduledStartTime { get; set; } + + /// + /// Gets or sets the scheduled end time of the meeting. + /// + [JsonPropertyName("scheduledEndTime")] + public DateTimeOffset? ScheduledEndTime { get; set; } + + /// + /// Gets or sets the join URL of the meeting. + /// + [JsonPropertyName("joinUrl")] + public Uri? JoinUrl { get; set; } + + /// + /// Gets or sets the title of the meeting. + /// + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// + /// Gets or sets the type of the meeting. + /// + [JsonPropertyName("type")] + public string? Type { get; set; } +} + +/// +/// Represents a meeting participant with their details. +/// +public class MeetingParticipant +{ + /// + /// Gets or sets the user information. + /// + [JsonPropertyName("user")] + public ConversationAccount? User { get; set; } + + /// + /// Gets or sets the meeting information. + /// + [JsonPropertyName("meeting")] + public MeetingParticipantInfo? Meeting { get; set; } + + /// + /// Gets or sets the conversation information. + /// + [JsonPropertyName("conversation")] + public ConversationAccount? Conversation { get; set; } +} + +/// +/// Represents meeting-specific participant information. +/// +public class MeetingParticipantInfo +{ + /// + /// Gets or sets the role of the participant in the meeting. + /// + [JsonPropertyName("role")] + public string? Role { get; set; } + + /// + /// Gets or sets a value indicating whether the participant is in the meeting. + /// + [JsonPropertyName("inMeeting")] + public bool? InMeeting { get; set; } +} + +/// +/// Base class for meeting notifications. +/// +public abstract class MeetingNotificationBase +{ + /// + /// Gets or sets the type of the notification. + /// + [JsonPropertyName("type")] + public abstract string Type { get; } +} + +/// +/// Represents a targeted meeting notification. +/// +public class TargetedMeetingNotification : MeetingNotificationBase +{ + /// + [JsonPropertyName("type")] + public override string Type => "targetedMeetingNotification"; + + /// + /// Gets or sets the value of the notification. + /// + [JsonPropertyName("value")] + public TargetedMeetingNotificationValue? Value { get; set; } +} + +/// +/// Represents the value of a targeted meeting notification. +/// +public class TargetedMeetingNotificationValue +{ + /// + /// Gets or sets the list of recipients for the notification. + /// + [JsonPropertyName("recipients")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? Recipients { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only + + /// + /// Gets or sets the surface configurations for the notification. + /// + [JsonPropertyName("surfaces")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? Surfaces { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only +} + +/// +/// Represents a surface for meeting notifications. +/// +public class MeetingNotificationSurface +{ + /// + /// Gets or sets the surface type (e.g., "meetingStage"). + /// + [JsonPropertyName("surface")] + public string? Surface { get; set; } + + /// + /// Gets or sets the content type of the notification. + /// + [JsonPropertyName("contentType")] + public string? ContentType { get; set; } + + /// + /// Gets or sets the content of the notification. + /// + [JsonPropertyName("content")] + public object? Content { get; set; } +} + +/// +/// Response from sending a meeting notification. +/// +public class MeetingNotificationResponse +{ + /// + /// Gets or sets the list of recipients for whom the notification failed. + /// + [JsonPropertyName("recipientsFailureInfo")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? RecipientsFailureInfo { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only +} + +/// +/// Information about a failed notification recipient. +/// +public class MeetingNotificationRecipientFailureInfo +{ + /// + /// Gets or sets the recipient ID. + /// + [JsonPropertyName("recipientMri")] + public string? RecipientMri { get; set; } + + /// + /// Gets or sets the error code. + /// + [JsonPropertyName("errorCode")] + public string? ErrorCode { get; set; } + + /// + /// Gets or sets the failure reason. + /// + [JsonPropertyName("failureReason")] + public string? FailureReason { get; set; } +} + +/// +/// Represents a team member for batch operations. +/// +public class TeamMember +{ + /// + /// Creates a new instance of the class. + /// + public TeamMember() + { + } + + /// + /// Creates a new instance of the class with the specified ID. + /// + /// The member ID. + public TeamMember(string id) + { + Id = id; + } + + /// + /// Gets or sets the member ID. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } +} + +/// +/// Represents the state of a batch operation. +/// +public class BatchOperationState +{ + /// + /// Gets or sets the state of the operation. + /// + [JsonPropertyName("state")] + public string? State { get; set; } + + /// + /// Gets or sets the status map containing the count of different statuses. + /// + [JsonPropertyName("statusMap")] + public BatchOperationStatusMap? StatusMap { get; set; } + + /// + /// Gets or sets the retry after date time. + /// + [JsonPropertyName("retryAfter")] + public DateTimeOffset? RetryAfter { get; set; } + + /// + /// Gets or sets the total entries count. + /// + [JsonPropertyName("totalEntriesCount")] + public int? TotalEntriesCount { get; set; } +} + +/// +/// Represents the status map for a batch operation. +/// +public class BatchOperationStatusMap +{ + /// + /// Gets or sets the count of successful entries. + /// + [JsonPropertyName("success")] + public int? Success { get; set; } + + /// + /// Gets or sets the count of failed entries. + /// + [JsonPropertyName("failed")] + public int? Failed { get; set; } + + /// + /// Gets or sets the count of throttled entries. + /// + [JsonPropertyName("throttled")] + public int? Throttled { get; set; } + + /// + /// Gets or sets the count of pending entries. + /// + [JsonPropertyName("pending")] + public int? Pending { get; set; } +} + +/// +/// Response containing failed entries from a batch operation. +/// +public class BatchFailedEntriesResponse +{ + /// + /// Gets or sets the continuation token for paging. + /// + [JsonPropertyName("continuationToken")] + public string? ContinuationToken { get; set; } + + /// + /// Gets or sets the list of failed entries. + /// + [JsonPropertyName("failedEntries")] +#pragma warning disable CA2227 // Collection properties should be read only + public IList? FailedEntries { get; set; } +#pragma warning restore CA2227 // Collection properties should be read only +} + +/// +/// Represents a failed entry in a batch operation. +/// +public class BatchFailedEntry +{ + /// + /// Gets or sets the ID of the failed entry. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Gets or sets the error code. + /// + [JsonPropertyName("error")] + public string? Error { get; set; } +} + +/// +/// Request body for sending a message to a list of users. +/// +internal sealed class SendMessageToUsersRequest +{ + /// + /// Gets or sets the list of members. + /// + [JsonPropertyName("members")] + public IList? Members { get; set; } + + /// + /// Gets or sets the activity to send. + /// + [JsonPropertyName("activity")] + public object? Activity { get; set; } + + /// + /// Gets or sets the tenant ID. + /// + [JsonPropertyName("tenantId")] + public string? TenantId { get; set; } +} + +/// +/// Request body for sending a message to all users in a tenant. +/// +internal sealed class SendMessageToTenantRequest +{ + /// + /// Gets or sets the activity to send. + /// + [JsonPropertyName("activity")] + public object? Activity { get; set; } + + /// + /// Gets or sets the tenant ID. + /// + [JsonPropertyName("tenantId")] + public string? TenantId { get; set; } +} + +/// +/// Request body for sending a message to all users in a team. +/// +internal sealed class SendMessageToTeamRequest +{ + /// + /// Gets or sets the activity to send. + /// + [JsonPropertyName("activity")] + public object? Activity { get; set; } + + /// + /// Gets or sets the team ID. + /// + [JsonPropertyName("teamId")] + public string? TeamId { get; set; } + + /// + /// Gets or sets the tenant ID. + /// + [JsonPropertyName("tenantId")] + public string? TenantId { get; set; } +} diff --git a/core/src/Microsoft.Teams.BotApps/TeamsApiClient.cs b/core/src/Microsoft.Teams.BotApps/TeamsApiClient.cs new file mode 100644 index 00000000..ee2fcc1f --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/TeamsApiClient.cs @@ -0,0 +1,444 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Http; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Logging; + +namespace Microsoft.Teams.BotApps; + +using CustomHeaders = Dictionary; + +/// +/// Provides methods for interacting with Teams-specific APIs. +/// +/// The HTTP client instance used to send requests to the Teams service. Must not be null. +/// The logger instance used for logging. Optional. +[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] +public class TeamsApiClient(HttpClient httpClient, ILogger logger = default!) +{ + private readonly BotHttpClient _botHttpClient = new(httpClient, logger); + internal const string TeamsHttpClientName = "TeamsAPXClient"; + + /// + /// Gets the default custom headers that will be included in all requests. + /// + public CustomHeaders DefaultCustomHeaders { get; } = []; + + #region Team Operations + + /// + /// Fetches the list of channels for a given team. + /// + /// The ID of the team. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the list of channels. + /// Thrown if the channel list could not be retrieved successfully. + public async Task FetchChannelListAsync(string teamId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(teamId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/teams/{Uri.EscapeDataString(teamId)}/conversations"; + + logger?.LogTrace("Fetching channel list from {Url}", url); + + return (await _botHttpClient.SendAsync( + HttpMethod.Get, + url, + body: null, + CreateRequestOptions(agenticIdentity, "fetching channel list", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + /// + /// Fetches details related to a team. + /// + /// The ID of the team. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the team details. + /// Thrown if the team details could not be retrieved successfully. + public async Task FetchTeamDetailsAsync(string teamId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(teamId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/teams/{Uri.EscapeDataString(teamId)}"; + + logger?.LogTrace("Fetching team details from {Url}", url); + + return (await _botHttpClient.SendAsync( + HttpMethod.Get, + url, + body: null, + CreateRequestOptions(agenticIdentity, "fetching team details", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + #endregion + + #region Meeting Operations + + /// + /// Fetches information about a meeting. + /// + /// The ID of the meeting, encoded as a BASE64 string. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the meeting information. + /// Thrown if the meeting info could not be retrieved successfully. + public async Task FetchMeetingInfoAsync(string meetingId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(meetingId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v1/meetings/{Uri.EscapeDataString(meetingId)}"; + + logger?.LogTrace("Fetching meeting info from {Url}", url); + + return (await _botHttpClient.SendAsync( + HttpMethod.Get, + url, + body: null, + CreateRequestOptions(agenticIdentity, "fetching meeting info", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + /// + /// Fetches details for a meeting participant. + /// + /// The ID of the meeting. Cannot be null or whitespace. + /// The ID of the participant. Cannot be null or whitespace. + /// The ID of the tenant. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the participant details. + /// Thrown if the participant details could not be retrieved successfully. + public async Task FetchParticipantAsync(string meetingId, string participantId, string tenantId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(meetingId); + ArgumentException.ThrowIfNullOrWhiteSpace(participantId); + ArgumentException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v1/meetings/{Uri.EscapeDataString(meetingId)}/participants/{Uri.EscapeDataString(participantId)}?tenantId={Uri.EscapeDataString(tenantId)}"; + + logger?.LogTrace("Fetching meeting participant from {Url}", url); + + return (await _botHttpClient.SendAsync( + HttpMethod.Get, + url, + body: null, + CreateRequestOptions(agenticIdentity, "fetching meeting participant", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + /// + /// Sends a notification to meeting participants. + /// + /// The ID of the meeting. Cannot be null or whitespace. + /// The notification to send. Cannot be null. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains information about failed recipients. + /// Thrown if the notification could not be sent successfully. + public async Task SendMeetingNotificationAsync(string meetingId, MeetingNotificationBase notification, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(meetingId); + ArgumentNullException.ThrowIfNull(notification); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v1/meetings/{Uri.EscapeDataString(meetingId)}/notification"; + string body = JsonSerializer.Serialize(notification); + + logger?.LogTrace("Sending meeting notification to {Url}: {Notification}", url, body); + + return (await _botHttpClient.SendAsync( + HttpMethod.Post, + url, + body, + CreateRequestOptions(agenticIdentity, "sending meeting notification", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + #endregion + + #region Batch Message Operations + + /// + /// Sends a message to a list of Teams users. + /// + /// The activity to send. Cannot be null. + /// The list of team members to send the message to. Cannot be null or empty. + /// The ID of the tenant. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the operation ID. + /// Thrown if the message could not be sent successfully. + public async Task SendMessageToListOfUsersAsync(CoreActivity activity, IList teamsMembers, string tenantId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentNullException.ThrowIfNull(teamsMembers); + if (teamsMembers.Count == 0) + { + throw new ArgumentException("teamsMembers cannot be empty", nameof(teamsMembers)); + } + ArgumentException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/batch/conversation/users/"; + SendMessageToUsersRequest request = new() + { + Members = teamsMembers, + Activity = activity, + TenantId = tenantId + }; + string body = JsonSerializer.Serialize(request); + + logger?.LogTrace("Sending message to list of users at {Url}: {Request}", url, body); + + return (await _botHttpClient.SendAsync( + HttpMethod.Post, + url, + body, + CreateRequestOptions(agenticIdentity, "sending message to list of users", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + /// + /// Sends a message to all users in a tenant. + /// + /// The activity to send. Cannot be null. + /// The ID of the tenant. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the operation ID. + /// Thrown if the message could not be sent successfully. + public async Task SendMessageToAllUsersInTenantAsync(CoreActivity activity, string tenantId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/batch/conversation/tenant/"; + SendMessageToTenantRequest request = new() + { + Activity = activity, + TenantId = tenantId + }; + string body = JsonSerializer.Serialize(request); + + logger?.LogTrace("Sending message to all users in tenant at {Url}: {Request}", url, body); + + return (await _botHttpClient.SendAsync( + HttpMethod.Post, + url, + body, + CreateRequestOptions(agenticIdentity, "sending message to all users in tenant", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + /// + /// Sends a message to all users in a team. + /// + /// The activity to send. Cannot be null. + /// The ID of the team. Cannot be null or whitespace. + /// The ID of the tenant. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the operation ID. + /// Thrown if the message could not be sent successfully. + public async Task SendMessageToAllUsersInTeamAsync(CoreActivity activity, string teamId, string tenantId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentException.ThrowIfNullOrWhiteSpace(teamId); + ArgumentException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/batch/conversation/team/"; + SendMessageToTeamRequest request = new() + { + Activity = activity, + TeamId = teamId, + TenantId = tenantId + }; + string body = JsonSerializer.Serialize(request); + + logger?.LogTrace("Sending message to all users in team at {Url}: {Request}", url, body); + + return (await _botHttpClient.SendAsync( + HttpMethod.Post, + url, + body, + CreateRequestOptions(agenticIdentity, "sending message to all users in team", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + /// + /// Sends a message to a list of Teams channels. + /// + /// The activity to send. Cannot be null. + /// The list of channels to send the message to. Cannot be null or empty. + /// The ID of the tenant. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the operation ID. + /// Thrown if the message could not be sent successfully. + public async Task SendMessageToListOfChannelsAsync(CoreActivity activity, IList channelMembers, string tenantId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentNullException.ThrowIfNull(channelMembers); + if (channelMembers.Count == 0) + { + throw new ArgumentException("channelMembers cannot be empty", nameof(channelMembers)); + } + ArgumentException.ThrowIfNullOrWhiteSpace(tenantId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/batch/conversation/channels/"; + SendMessageToUsersRequest request = new() + { + Members = channelMembers, + Activity = activity, + TenantId = tenantId + }; + string body = JsonSerializer.Serialize(request); + + logger?.LogTrace("Sending message to list of channels at {Url}: {Request}", url, body); + + return (await _botHttpClient.SendAsync( + HttpMethod.Post, + url, + body, + CreateRequestOptions(agenticIdentity, "sending message to list of channels", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + #endregion + + #region Batch Operation Management + + /// + /// Gets the state of a batch operation. + /// + /// The ID of the operation. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the operation state. + /// Thrown if the operation state could not be retrieved successfully. + public async Task GetOperationStateAsync(string operationId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(operationId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/batch/conversation/{Uri.EscapeDataString(operationId)}"; + + logger?.LogTrace("Getting operation state from {Url}", url); + + return (await _botHttpClient.SendAsync( + HttpMethod.Get, + url, + body: null, + CreateRequestOptions(agenticIdentity, "getting operation state", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + /// + /// Gets the failed entries of a batch operation with error code and message. + /// + /// The ID of the operation. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional continuation token for pagination. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains the failed entries. + /// Thrown if the failed entries could not be retrieved successfully. + public async Task GetPagedFailedEntriesAsync(string operationId, Uri serviceUrl, string? continuationToken = null, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(operationId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/batch/conversation/failedentries/{Uri.EscapeDataString(operationId)}"; + + if (!string.IsNullOrWhiteSpace(continuationToken)) + { + url += $"?continuationToken={Uri.EscapeDataString(continuationToken)}"; + } + + logger?.LogTrace("Getting paged failed entries from {Url}", url); + + return (await _botHttpClient.SendAsync( + HttpMethod.Get, + url, + body: null, + CreateRequestOptions(agenticIdentity, "getting paged failed entries", customHeaders), + cancellationToken).ConfigureAwait(false))!; + } + + /// + /// Cancels a batch operation by its ID. + /// + /// The ID of the operation to cancel. Cannot be null or whitespace. + /// The service URL for the Teams service. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. + /// Thrown if the operation could not be cancelled successfully. + public async Task CancelOperationAsync(string operationId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrWhiteSpace(operationId); + ArgumentNullException.ThrowIfNull(serviceUrl); + + string url = $"{serviceUrl.ToString().TrimEnd('/')}/v3/batch/conversation/{Uri.EscapeDataString(operationId)}"; + + logger?.LogTrace("Cancelling operation at {Url}", url); + + await _botHttpClient.SendAsync( + HttpMethod.Delete, + url, + body: null, + CreateRequestOptions(agenticIdentity, "cancelling operation", customHeaders), + cancellationToken).ConfigureAwait(false); + } + + #endregion + + #region Private Methods + + private BotRequestOptions CreateRequestOptions(AgenticIdentity? agenticIdentity, string operationDescription, CustomHeaders? customHeaders) => + new() + { + AgenticIdentity = agenticIdentity, + OperationDescription = operationDescription, + DefaultHeaders = DefaultCustomHeaders, + CustomHeaders = customHeaders + }; + + #endregion +} diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.HostingExtensions.cs b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.HostingExtensions.cs new file mode 100644 index 00000000..9d6c2452 --- /dev/null +++ b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.HostingExtensions.cs @@ -0,0 +1,46 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core.Hosting; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; +using Microsoft.Identity.Abstractions; + +namespace Microsoft.Teams.BotApps; + +/// +/// Extension methods for . +/// +public static class TeamsBotApplicationHostingExtensions +{ + /// + /// Adds TeamsBotApplication to the service collection. + /// + /// The WebApplicationBuilder instance. + /// The configuration section name for AzureAd settings. Default is "AzureAd". + /// The updated WebApplicationBuilder instance. + public static IServiceCollection AddTeamsBotApplication(this IServiceCollection services, string sectionName = "AzureAd") + { + ServiceProvider sp = services.BuildServiceProvider(); + IConfiguration configuration = sp.GetRequiredService(); + + string scope = "https://api.botframework.com/.default"; + if (!string.IsNullOrEmpty(configuration[$"{sectionName}:Scope"])) + scope = configuration[$"{sectionName}:Scope"]!; + if (!string.IsNullOrEmpty(configuration["Scope"])) + scope = configuration["Scope"]!; + + services.AddHttpClient(TeamsApiClient.TeamsHttpClientName) + .AddHttpMessageHandler(sp => + new BotAuthenticationHandler( + sp.GetRequiredService(), + sp.GetRequiredService>(), + scope, + sp.GetService>())); + + services.AddBotApplication(); + return services; + } +} diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs index d0a723db..4ca3508e 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs @@ -16,7 +16,7 @@ namespace Microsoft.Teams.BotApps; [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class TeamsBotApplication : BotApplication { - + private readonly TeamsApiClient _teamsAPXClient; private static TeamsBotApplicationBuilder? _botApplicationBuilder; /// @@ -39,18 +39,34 @@ public class TeamsBotApplication : BotApplication /// public InvokeHandler? OnInvoke { get; set; } + /// + /// Gets the client used to interact with the TeamsAPX service. + /// + public TeamsApiClient TeamsAPXClient => _teamsAPXClient; + /// /// Handler for conversation update activities. /// public ConversationUpdateHandler? OnConversationUpdate { get; set; } + /// /// + /// /// /// /// /// - public TeamsBotApplication(ConversationClient conversationClient, UserTokenClient userTokenClient, IConfiguration config, IHttpContextAccessor httpContextAccessor, ILogger logger, string sectionName = "AzureAd") : base(conversationClient, userTokenClient, config, logger, sectionName) + public TeamsBotApplication( + ConversationClient conversationClient, + UserTokenClient userTokenClient, + TeamsApiClient teamsAPXClient, + IConfiguration config, + IHttpContextAccessor httpContextAccessor, + ILogger logger, + string sectionName = "AzureAd") + : base(conversationClient, userTokenClient, config, logger, sectionName) { + _teamsAPXClient = teamsAPXClient; OnActivity = async (activity, cancellationToken) => { logger.LogInformation("New {Type} activity received.", activity.Type); @@ -75,8 +91,8 @@ public TeamsBotApplication(ConversationClient conversationClient, UserTokenClien } if (teamsActivity.Type == TeamsActivityType.Invoke && OnInvoke is not null) { - var invokeResponse = await OnInvoke.Invoke(context, cancellationToken).ConfigureAwait(false); - var httpContext = httpContextAccessor.HttpContext; + CoreInvokeResponse invokeResponse = await OnInvoke.Invoke(context, cancellationToken).ConfigureAwait(false); + HttpContext? httpContext = httpContextAccessor.HttpContext; if (httpContext is not null) { httpContext.Response.StatusCode = invokeResponse.Status; diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs b/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs index ef904dc1..09456c58 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs +++ b/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs @@ -3,10 +3,8 @@ using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; -using Microsoft.AspNetCore.Http; using Microsoft.Bot.Core; using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; @@ -49,7 +47,7 @@ public TeamsBotApplicationBuilder() { _webAppBuilder = WebApplication.CreateSlimBuilder(); _webAppBuilder.Services.AddHttpContextAccessor(); - _webAppBuilder.Services.AddBotApplication(); + _webAppBuilder.Services.AddTeamsBotApplication(); } /// diff --git a/core/test/ABSTokenServiceClient/Program.cs b/core/test/ABSTokenServiceClient/Program.cs index b4105edc..9714720a 100644 --- a/core/test/ABSTokenServiceClient/Program.cs +++ b/core/test/ABSTokenServiceClient/Program.cs @@ -3,9 +3,9 @@ using ABSTokenServiceClient; using Microsoft.AspNetCore.Builder; -using Microsoft.Extensions.DependencyInjection; -using Microsoft.Bot.Core.Hosting; using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Extensions.DependencyInjection; WebApplicationBuilder builder = WebApplication.CreateBuilder(args); diff --git a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs index 71d59bfb..4083c69d 100644 --- a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs +++ b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs @@ -1,7 +1,7 @@ -using Microsoft.Extensions.Hosting; -using Microsoft.Extensions.Logging; -using Microsoft.Bot.Core; using System.Text.Json; +using Microsoft.Bot.Core; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; namespace ABSTokenServiceClient { @@ -53,11 +53,13 @@ protected async Task ExecuteAsync(CancellationToken cancellationToken) string yn = Console.ReadLine()!; if ("y".Equals(yn, StringComparison.OrdinalIgnoreCase)) { - try{ + try + { await userTokenClient.SignOutUserAsync(userId, connectionName, channelId, cancellationToken); logger.LogInformation("SignOutUser completed successfully"); } - catch (Exception ex) { + catch (Exception ex) + { logger.LogError(ex, "Error during SignOutUser"); } } diff --git a/core/test/IntegrationTests.slnx b/core/test/IntegrationTests.slnx index 49a0b21a..cff9a04c 100644 --- a/core/test/IntegrationTests.slnx +++ b/core/test/IntegrationTests.slnx @@ -1,7 +1,11 @@ + + + + + - diff --git a/core/test/Microsoft.Bot.Core.Compat.UnitTests/CompatActivityTests.cs b/core/test/Microsoft.Bot.Core.Compat.UnitTests/CompatActivityTests.cs new file mode 100644 index 00000000..9da5d6e4 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.Compat.UnitTests/CompatActivityTests.cs @@ -0,0 +1,104 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using AdaptiveCards; +using Microsoft.Bot.Builder.Teams; +using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.BotApps.Schema; + +namespace Microsoft.Bot.Core.Compat.UnitTests +{ + public class CompatActivityTests + { + [Fact] + public void FromCompatActivity() + { + CoreActivity coreActivity = CoreActivity.FromJsonString(compatActivityJson); + Assert.NotNull(coreActivity); + Assert.NotNull(coreActivity.Attachments); + Assert.Single(coreActivity.Attachments); + TeamsActivity teamsActivity = TeamsActivity.FromActivity(coreActivity); + Assert.NotNull(teamsActivity); + Assert.NotNull(teamsActivity.Attachments); + Assert.Single(teamsActivity.Attachments); + var attachment = teamsActivity.Attachments[0]; + Assert.Equal("application/vnd.microsoft.card.adaptive", attachment.ContentType); + var content = attachment.Content; + var card = AdaptiveCard.FromJson(System.Text.Json.JsonSerializer.Serialize(content)).Card; + Assert.Equal(2, card.Body.Count); + var firstTextBlock = card.Body[0] as AdaptiveTextBlock; + Assert.NotNull(firstTextBlock); + Assert.Equal("Mention a user by User Principle Name: Hello Rido UPN", firstTextBlock.Text); + + } + + + string compatActivityJson = """ + { + "type": "message", + "serviceUrl": "https://smba.trafficmanager.net/amer/9a9b49fd-1dc5-4217-88b3-ecf855e91b0e/", + "channelId": "msteams", + "from": { + "id": "28:fa45fe59-200c-493c-aa4c-80c17ad6f307", + "name": "ridodev-local" + }, + "conversation": { + "conversationType": "personal", + "id": "a:188cfPEO2ZNiFxoCSq-2QwCkQTBywkMID0Y2704RpFR2QjMx8217cpDunnnI-rx95Qn_1ce11juGEelMnscuyEQvHTh_wRRRKR_WxbV8ZS4-1qFwb0l8T0Zrd9uiTCtLX", + "tenantId": "9a9b49fd-1dc5-4217-88b3-ecf855e91b0e" + }, + "recipient": { + "id": "29:1zIP3NcdoJbnv2Rp-x-7ukmDhrgy6JqXcDgYB4mFxGCtBRvVT7V0Iwu0obPlWlBd14M2qEa4p5qqJde0HTYy4cw", + "name": "Rido", + "aadObjectId": "16de8f24-f65d-4f6b-a837-3a7e638ab6e1" + }, + "attachmentLayout": "list", + "locale": "en-US", + "inputHint": "acceptingInput", + "attachments": [ + { + "contentType": "application/vnd.microsoft.card.adaptive", + "content": { + "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", + "type": "AdaptiveCard", + "version": "1.5", + "speak": "This card mentions a user by User Principle Name: Hello Rido", + "body": [ + { + "type": "TextBlock", + "text": "Mention a user by User Principle Name: Hello Rido UPN" + }, + { + "type": "TextBlock", + "text": "Mention a user by AAD Object Id: Hello Rido AAD" + } + ], + "msteams": { + "entities": [ + { + "type": "mention", + "text": "Rido UPN", + "mentioned": { + "id": "rido@tsdk1.onmicrosoft.com", + "name": "Rido" + } + }, + { + "type": "mention", + "text": "Rido AAD", + "mentioned": { + "id": "16de8f24-f65d-4f6b-a837-3a7e638ab6e1", + "name": "Rido" + } + } + ] + } + } + } + ], + "entities": [], + "replyToId": "f:d1c5de53-9e8b-b5c3-c24d-07c2823079cf" + } + """; + } +} diff --git a/core/test/Microsoft.Bot.Core.Compat.UnitTests/Microsoft.Bot.Core.Compat.UnitTests.csproj b/core/test/Microsoft.Bot.Core.Compat.UnitTests/Microsoft.Bot.Core.Compat.UnitTests.csproj new file mode 100644 index 00000000..66c3819c --- /dev/null +++ b/core/test/Microsoft.Bot.Core.Compat.UnitTests/Microsoft.Bot.Core.Compat.UnitTests.csproj @@ -0,0 +1,26 @@ + + + + net10.0 + enable + enable + false + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/core/test/Microsoft.Bot.Core.Tests/CompatConversationClientTests.cs b/core/test/Microsoft.Bot.Core.Tests/CompatConversationClientTests.cs new file mode 100644 index 00000000..6738567c --- /dev/null +++ b/core/test/Microsoft.Bot.Core.Tests/CompatConversationClientTests.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Builder.Teams; +using Microsoft.Bot.Core.Compat; +using Microsoft.Bot.Schema; +using Microsoft.Bot.Schema.Teams; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; + +namespace Microsoft.Bot.Core.Tests +{ + public class CompatConversationClientTests + { + string serviceUrl = "https://smba.trafficmanager.net/amer/"; + + string userId = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"); + string conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set"); + + [Fact(Skip = "not implemented")] + public async Task GetMemberAsync() + { + + var compatAdapter = InitializeCompatAdapter(); + ConversationReference conversationReference = new ConversationReference + + { + ChannelId = "msteams", + ServiceUrl = serviceUrl, + Conversation = new ConversationAccount + { + Id = conversationId + } + }; + + await compatAdapter.ContinueConversationAsync( + string.Empty, conversationReference, + async (turnContext, cancellationToken) => + { + TeamsChannelAccount member = await TeamsInfo.GetMemberAsync(turnContext, userId, cancellationToken: cancellationToken); + Assert.NotNull(member); + Assert.Equal(userId, member.Id); + + }, CancellationToken.None); + } + + [Fact] + public async Task GetPagedMembersAsync() + { + + var compatAdapter = InitializeCompatAdapter(); + ConversationReference conversationReference = new ConversationReference + + { + ChannelId = "msteams", + ServiceUrl = serviceUrl, + Conversation = new ConversationAccount + { + Id = conversationId + } + }; + + await compatAdapter.ContinueConversationAsync( + string.Empty, conversationReference, + async (turnContext, cancellationToken) => + { + var result = await TeamsInfo.GetPagedMembersAsync(turnContext, cancellationToken: cancellationToken); + Assert.NotNull(result); + Assert.True(result.Members.Count > 0); + var m0 = result.Members[0]; + Assert.Equal(userId, m0.Id); + + }, CancellationToken.None); + } + + [Fact(Skip = "not implemented")] + public async Task GetMeetingInfo() + { + string meetingId = Environment.GetEnvironmentVariable("TEST_MEETINGID") ?? throw new InvalidOperationException("TEST_MEETINGID environment variable not set"); + var compatAdapter = InitializeCompatAdapter(); + ConversationReference conversationReference = new ConversationReference + + { + ChannelId = "msteams", + ServiceUrl = serviceUrl, + Conversation = new ConversationAccount + { + Id = conversationId + } + }; + + await compatAdapter.ContinueConversationAsync( + string.Empty, conversationReference, + async (turnContext, cancellationToken) => + { + var result = await TeamsInfo.GetMeetingInfoAsync(turnContext, meetingId, cancellationToken); + Assert.NotNull(result); + + }, CancellationToken.None); + } + + + CompatAdapter InitializeCompatAdapter() + { + IConfigurationBuilder builder = new ConfigurationBuilder() + .SetBasePath(AppDomain.CurrentDomain.BaseDirectory) + .AddEnvironmentVariables(); + + IConfiguration configuration = builder.Build(); + + ServiceCollection services = new(); + services.AddSingleton>(NullLogger.Instance); + services.AddSingleton>(NullLogger.Instance); + services.AddSingleton(configuration); + services.AddCompatAdapter(); + services.AddLogging(configure => configure.AddConsole()); + + var serviceProvider = services.BuildServiceProvider(); + CompatAdapter compatAdapter = (CompatAdapter)serviceProvider.GetRequiredService(); + return compatAdapter; + } + } +} diff --git a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs index 95719f36..3ac1e7d4 100644 --- a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs +++ b/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs @@ -184,7 +184,7 @@ public async Task GetConversationMember() string conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? throw new InvalidOperationException("TEST_ConversationId environment variable not set"); string userId = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"); - ConversationAccount member = await _conversationClient.GetConversationMemberAsync( + ConversationAccount member = await _conversationClient.GetConversationMemberAsync( conversationId, userId, _serviceUrl, @@ -308,7 +308,7 @@ public async Task CreateConversation_WithMembers() } ], // TODO: This is required for some reason. Should it be required in the api? - TenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set") + TenantId = Environment.GetEnvironmentVariable("AzureAd__TenantId") ?? throw new InvalidOperationException("AzureAd__TenantId environment variable not set") }; CreateConversationResponse response = await _conversationClient.CreateConversationAsync( @@ -461,7 +461,7 @@ public async Task CreateConversation_WithInitialActivity() Type = ActivityType.Message, Properties = { { "text", $"Initial message sent at {DateTime.UtcNow:s}" } }, }, - TenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set") + TenantId = Environment.GetEnvironmentVariable("AzureAd__TenantId") ?? throw new InvalidOperationException("AzureAd__TenantId environment variable not set") }; CreateConversationResponse response = await _conversationClient.CreateConversationAsync( @@ -495,7 +495,7 @@ public async Task CreateConversation_WithChannelData() { teamsChannelId = Environment.GetEnvironmentVariable("TEST_CHANNELID") }, - TenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set") + TenantId = Environment.GetEnvironmentVariable("AzureAd__TenantId") ?? throw new InvalidOperationException("AzureAd__TenantId environment variable not set") }; CreateConversationResponse response = await _conversationClient.CreateConversationAsync( diff --git a/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj b/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj index 1faa9888..78e201ed 100644 --- a/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj +++ b/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj @@ -15,9 +15,8 @@ - - + diff --git a/core/test/Microsoft.Bot.Core.Tests/TeamsApiClientTests.cs b/core/test/Microsoft.Bot.Core.Tests/TeamsApiClientTests.cs new file mode 100644 index 00000000..e7e5b595 --- /dev/null +++ b/core/test/Microsoft.Bot.Core.Tests/TeamsApiClientTests.cs @@ -0,0 +1,562 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Core; +using Microsoft.Bot.Core.Hosting; +using Microsoft.Bot.Core.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Teams.BotApps; + +namespace Microsoft.Bot.Core.Tests; + +public class TeamsApiClientTests +{ + private readonly ServiceProvider _serviceProvider; + private readonly TeamsApiClient _teamsClient; + private readonly Uri _serviceUrl; + + public TeamsApiClientTests() + { + IConfigurationBuilder builder = new ConfigurationBuilder() + .SetBasePath(AppDomain.CurrentDomain.BaseDirectory) + .AddEnvironmentVariables(); + + IConfiguration configuration = builder.Build(); + + ServiceCollection services = new(); + services.AddLogging(); + services.AddSingleton(configuration); + services.AddTeamsBotApplication(); + _serviceProvider = services.BuildServiceProvider(); + _teamsClient = _serviceProvider.GetRequiredService(); + _serviceUrl = new Uri(Environment.GetEnvironmentVariable("TEST_SERVICEURL") ?? "https://smba.trafficmanager.net/teams/"); + } + + #region Team Operations Tests + + [Fact] + public async Task FetchChannelList() + { + string teamId = Environment.GetEnvironmentVariable("TEST_TEAMID") ?? throw new InvalidOperationException("TEST_TEAMID environment variable not set"); + + ChannelList result = await _teamsClient.FetchChannelListAsync( + teamId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(result); + Assert.NotNull(result.Channels); + Assert.NotEmpty(result.Channels); + + Console.WriteLine($"Found {result.Channels.Count} channels in team {teamId}:"); + foreach (var channel in result.Channels) + { + Console.WriteLine($" - Id: {channel.Id}, Name: {channel.Name}"); + Assert.NotNull(channel); + Assert.NotNull(channel.Id); + } + } + + [Fact] + public async Task FetchChannelList_FailsWithInvalidTeamId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchChannelListAsync("invalid-team-id", _serviceUrl)); + } + + [Fact] + public async Task FetchTeamDetails() + { + string teamId = Environment.GetEnvironmentVariable("TEST_TEAMID") ?? throw new InvalidOperationException("TEST_TEAMID environment variable not set"); + + TeamDetails result = await _teamsClient.FetchTeamDetailsAsync( + teamId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(result); + Assert.NotNull(result.Id); + + Console.WriteLine($"Team details for {teamId}:"); + Console.WriteLine($" - Id: {result.Id}"); + Console.WriteLine($" - Name: {result.Name}"); + Console.WriteLine($" - AAD Group Id: {result.AadGroupId}"); + Console.WriteLine($" - Channel Count: {result.ChannelCount}"); + Console.WriteLine($" - Member Count: {result.MemberCount}"); + Console.WriteLine($" - Type: {result.Type}"); + } + + [Fact] + public async Task FetchTeamDetails_FailsWithInvalidTeamId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchTeamDetailsAsync("invalid-team-id", _serviceUrl)); + } + + #endregion + + #region Meeting Operations Tests + + [Fact] + public async Task FetchMeetingInfo() + { + string meetingId = Environment.GetEnvironmentVariable("TEST_MEETINGID") ?? throw new InvalidOperationException("TEST_MEETINGID environment variable not set"); + + MeetingInfo result = await _teamsClient.FetchMeetingInfoAsync( + meetingId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(result); + //Assert.NotNull(result.Id); + + Console.WriteLine($"Meeting info for {meetingId}:"); + + if (result.Details != null) + { + Console.WriteLine($" - Title: {result.Details.Title}"); + Console.WriteLine($" - Type: {result.Details.Type}"); + Console.WriteLine($" - Join URL: {result.Details.JoinUrl}"); + Console.WriteLine($" - Scheduled Start: {result.Details.ScheduledStartTime}"); + Console.WriteLine($" - Scheduled End: {result.Details.ScheduledEndTime}"); + } + if (result.Organizer != null) + { + Console.WriteLine($" - Organizer: {result.Organizer.Name} ({result.Organizer.Id})"); + } + } + + [Fact] + public async Task FetchMeetingInfo_FailsWithInvalidMeetingId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchMeetingInfoAsync("invalid-meeting-id", _serviceUrl)); + } + + [Fact(Skip = "Requires active meeting context")] + public async Task FetchParticipant() + { + string meetingId = Environment.GetEnvironmentVariable("TEST_MEETINGID") ?? throw new InvalidOperationException("TEST_MEETINGID environment variable not set"); + string participantId = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"); + string tenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set"); + + MeetingParticipant result = await _teamsClient.FetchParticipantAsync( + meetingId, + participantId, + tenantId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(result); + + Console.WriteLine($"Participant info for {participantId} in meeting {meetingId}:"); + if (result.User != null) + { + Console.WriteLine($" - User Id: {result.User.Id}"); + Console.WriteLine($" - User Name: {result.User.Name}"); + } + if (result.Meeting != null) + { + Console.WriteLine($" - Role: {result.Meeting.Role}"); + Console.WriteLine($" - In Meeting: {result.Meeting.InMeeting}"); + } + } + + [Fact(Skip = "Requires active meeting context")] + public async Task SendMeetingNotification() + { + string meetingId = Environment.GetEnvironmentVariable("TEST_MEETINGID") ?? throw new InvalidOperationException("TEST_MEETINGID environment variable not set"); + string participantId = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"); + + var notification = new TargetedMeetingNotification + { + Value = new TargetedMeetingNotificationValue + { + Recipients = [participantId], + Surfaces = + [ + new MeetingNotificationSurface + { + Surface = "meetingStage", + ContentType = "task", + Content = new { title = "Test Notification", url = "https://example.com" } + } + ] + } + }; + + MeetingNotificationResponse result = await _teamsClient.SendMeetingNotificationAsync( + meetingId, + notification, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(result); + + Console.WriteLine($"Meeting notification sent to meeting {meetingId}"); + if (result.RecipientsFailureInfo != null && result.RecipientsFailureInfo.Count > 0) + { + Console.WriteLine($"Failed recipients:"); + foreach (var failure in result.RecipientsFailureInfo) + { + Console.WriteLine($" - {failure.RecipientMri}: {failure.ErrorCode} - {failure.FailureReason}"); + } + } + } + + #endregion + + #region Batch Message Operations Tests + + [Fact(Skip = "Batch operations require special permissions")] + public async Task SendMessageToListOfUsers() + { + string tenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set"); + string userId = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"); + + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Batch message from Automated tests at `{DateTime.UtcNow:s}`" } } + }; + + IList members = + [ + new TeamMember(userId) + ]; + + string operationId = await _teamsClient.SendMessageToListOfUsersAsync( + activity, + members, + tenantId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(operationId); + Assert.NotEmpty(operationId); + + Console.WriteLine($"Batch message sent. Operation ID: {operationId}"); + } + + [Fact(Skip = "Batch operations require special permissions")] + public async Task SendMessageToAllUsersInTenant() + { + string tenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set"); + + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Tenant-wide message from Automated tests at `{DateTime.UtcNow:s}`" } } + }; + + string operationId = await _teamsClient.SendMessageToAllUsersInTenantAsync( + activity, + tenantId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(operationId); + Assert.NotEmpty(operationId); + + Console.WriteLine($"Tenant-wide message sent. Operation ID: {operationId}"); + } + + [Fact(Skip = "Batch operations require special permissions")] + public async Task SendMessageToAllUsersInTeam() + { + string tenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set"); + string teamId = Environment.GetEnvironmentVariable("TEST_TEAMID") ?? throw new InvalidOperationException("TEST_TEAMID environment variable not set"); + + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Team-wide message from Automated tests at `{DateTime.UtcNow:s}`" } } + }; + + string operationId = await _teamsClient.SendMessageToAllUsersInTeamAsync( + activity, + teamId, + tenantId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(operationId); + Assert.NotEmpty(operationId); + + Console.WriteLine($"Team-wide message sent. Operation ID: {operationId}"); + } + + [Fact(Skip = "Batch operations require special permissions")] + public async Task SendMessageToListOfChannels() + { + string tenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set"); + string channelId = Environment.GetEnvironmentVariable("TEST_CHANNELID") ?? throw new InvalidOperationException("TEST_CHANNELID environment variable not set"); + + CoreActivity activity = new() + { + Type = ActivityType.Message, + Properties = { { "text", $"Channel batch message from Automated tests at `{DateTime.UtcNow:s}`" } } + }; + + IList channels = + [ + new TeamMember(channelId) + ]; + + string operationId = await _teamsClient.SendMessageToListOfChannelsAsync( + activity, + channels, + tenantId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(operationId); + Assert.NotEmpty(operationId); + + Console.WriteLine($"Channel batch message sent. Operation ID: {operationId}"); + } + + #endregion + + #region Batch Operation Management Tests + + [Fact(Skip = "Requires valid operation ID from batch operation")] + public async Task GetOperationState() + { + string operationId = Environment.GetEnvironmentVariable("TEST_OPERATION_ID") ?? throw new InvalidOperationException("TEST_OPERATION_ID environment variable not set"); + + BatchOperationState result = await _teamsClient.GetOperationStateAsync( + operationId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(result); + Assert.NotNull(result.State); + + Console.WriteLine($"Operation state for {operationId}:"); + Console.WriteLine($" - State: {result.State}"); + Console.WriteLine($" - Total Entries: {result.TotalEntriesCount}"); + if (result.StatusMap != null) + { + Console.WriteLine($" - Success: {result.StatusMap.Success}"); + Console.WriteLine($" - Failed: {result.StatusMap.Failed}"); + Console.WriteLine($" - Throttled: {result.StatusMap.Throttled}"); + Console.WriteLine($" - Pending: {result.StatusMap.Pending}"); + } + if (result.RetryAfter != null) + { + Console.WriteLine($" - Retry After: {result.RetryAfter}"); + } + } + + [Fact] + public async Task GetOperationState_FailsWithInvalidOperationId() + { + await Assert.ThrowsAsync(() + => _teamsClient.GetOperationStateAsync("invalid-operation-id", _serviceUrl)); + } + + [Fact(Skip = "Requires valid operation ID from batch operation")] + public async Task GetPagedFailedEntries() + { + string operationId = Environment.GetEnvironmentVariable("TEST_OPERATION_ID") ?? throw new InvalidOperationException("TEST_OPERATION_ID environment variable not set"); + + BatchFailedEntriesResponse result = await _teamsClient.GetPagedFailedEntriesAsync( + operationId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Assert.NotNull(result); + + Console.WriteLine($"Failed entries for operation {operationId}:"); + if (result.FailedEntries != null && result.FailedEntries.Count > 0) + { + foreach (var entry in result.FailedEntries) + { + Console.WriteLine($" - Id: {entry.Id}, Error: {entry.Error}"); + } + } + else + { + Console.WriteLine(" No failed entries"); + } + + if (!string.IsNullOrWhiteSpace(result.ContinuationToken)) + { + Console.WriteLine($"Continuation token: {result.ContinuationToken}"); + } + } + + [Fact(Skip = "Requires valid operation ID from batch operation")] + public async Task CancelOperation() + { + string operationId = Environment.GetEnvironmentVariable("TEST_OPERATION_ID") ?? throw new InvalidOperationException("TEST_OPERATION_ID environment variable not set"); + + await _teamsClient.CancelOperationAsync( + operationId, + _serviceUrl, + cancellationToken: CancellationToken.None); + + Console.WriteLine($"Operation {operationId} cancelled successfully"); + } + + #endregion + + #region Argument Validation Tests + + [Fact] + public async Task FetchChannelList_ThrowsOnNullTeamId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchChannelListAsync(null!, _serviceUrl)); + } + + [Fact] + public async Task FetchChannelList_ThrowsOnEmptyTeamId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchChannelListAsync("", _serviceUrl)); + } + + [Fact] + public async Task FetchChannelList_ThrowsOnNullServiceUrl() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchChannelListAsync("team-id", null!)); + } + + [Fact] + public async Task FetchTeamDetails_ThrowsOnNullTeamId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchTeamDetailsAsync(null!, _serviceUrl)); + } + + [Fact] + public async Task FetchMeetingInfo_ThrowsOnNullMeetingId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchMeetingInfoAsync(null!, _serviceUrl)); + } + + [Fact] + public async Task FetchParticipant_ThrowsOnNullMeetingId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchParticipantAsync(null!, "participant", "tenant", _serviceUrl)); + } + + [Fact] + public async Task FetchParticipant_ThrowsOnNullParticipantId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchParticipantAsync("meeting", null!, "tenant", _serviceUrl)); + } + + [Fact] + public async Task FetchParticipant_ThrowsOnNullTenantId() + { + await Assert.ThrowsAsync(() + => _teamsClient.FetchParticipantAsync("meeting", "participant", null!, _serviceUrl)); + } + + [Fact] + public async Task SendMeetingNotification_ThrowsOnNullMeetingId() + { + var notification = new TargetedMeetingNotification(); + await Assert.ThrowsAsync(() + => _teamsClient.SendMeetingNotificationAsync(null!, notification, _serviceUrl)); + } + + [Fact] + public async Task SendMeetingNotification_ThrowsOnNullNotification() + { + await Assert.ThrowsAsync(() + => _teamsClient.SendMeetingNotificationAsync("meeting", null!, _serviceUrl)); + } + + [Fact] + public async Task SendMessageToListOfUsers_ThrowsOnNullActivity() + { + await Assert.ThrowsAsync(() + => _teamsClient.SendMessageToListOfUsersAsync(null!, [new TeamMember("id")], "tenant", _serviceUrl)); + } + + [Fact] + public async Task SendMessageToListOfUsers_ThrowsOnNullMembers() + { + var activity = new CoreActivity { Type = ActivityType.Message }; + await Assert.ThrowsAsync(() + => _teamsClient.SendMessageToListOfUsersAsync(activity, null!, "tenant", _serviceUrl)); + } + + [Fact] + public async Task SendMessageToListOfUsers_ThrowsOnEmptyMembers() + { + var activity = new CoreActivity { Type = ActivityType.Message }; + await Assert.ThrowsAsync(() + => _teamsClient.SendMessageToListOfUsersAsync(activity, [], "tenant", _serviceUrl)); + } + + [Fact] + public async Task SendMessageToAllUsersInTenant_ThrowsOnNullActivity() + { + await Assert.ThrowsAsync(() + => _teamsClient.SendMessageToAllUsersInTenantAsync(null!, "tenant", _serviceUrl)); + } + + [Fact] + public async Task SendMessageToAllUsersInTenant_ThrowsOnNullTenantId() + { + var activity = new CoreActivity { Type = ActivityType.Message }; + await Assert.ThrowsAsync(() + => _teamsClient.SendMessageToAllUsersInTenantAsync(activity, null!, _serviceUrl)); + } + + [Fact] + public async Task SendMessageToAllUsersInTeam_ThrowsOnNullActivity() + { + await Assert.ThrowsAsync(() + => _teamsClient.SendMessageToAllUsersInTeamAsync(null!, "team", "tenant", _serviceUrl)); + } + + [Fact] + public async Task SendMessageToAllUsersInTeam_ThrowsOnNullTeamId() + { + var activity = new CoreActivity { Type = ActivityType.Message }; + await Assert.ThrowsAsync(() + => _teamsClient.SendMessageToAllUsersInTeamAsync(activity, null!, "tenant", _serviceUrl)); + } + + [Fact] + public async Task SendMessageToListOfChannels_ThrowsOnEmptyChannels() + { + var activity = new CoreActivity { Type = ActivityType.Message }; + await Assert.ThrowsAsync(() + => _teamsClient.SendMessageToListOfChannelsAsync(activity, [], "tenant", _serviceUrl)); + } + + [Fact] + public async Task GetOperationState_ThrowsOnNullOperationId() + { + await Assert.ThrowsAsync(() + => _teamsClient.GetOperationStateAsync(null!, _serviceUrl)); + } + + [Fact] + public async Task GetPagedFailedEntries_ThrowsOnNullOperationId() + { + await Assert.ThrowsAsync(() + => _teamsClient.GetPagedFailedEntriesAsync(null!, _serviceUrl)); + } + + [Fact] + public async Task CancelOperation_ThrowsOnNullOperationId() + { + await Assert.ThrowsAsync(() + => _teamsClient.CancelOperationAsync(null!, _serviceUrl)); + } + + #endregion +} diff --git a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs index 2cc21dc1..9d5cb09c 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs @@ -70,7 +70,7 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() await botApp.ProcessAsync(httpContext); - + Assert.True(onActivityCalled); } @@ -220,7 +220,8 @@ private static UserTokenClient CreateMockUserTokenClient() { Mock mockHttpClient = new(); NullLogger logger = NullLogger.Instance; - return new UserTokenClient(mockHttpClient.Object, logger); + Mock mockConfiguration = new(); + return new UserTokenClient(mockHttpClient.Object, mockConfiguration.Object, logger); } private static DefaultHttpContext CreateHttpContextWithActivity(CoreActivity activity) diff --git a/core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs index 053a0ff2..74ca5a64 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs @@ -85,7 +85,7 @@ public void WithType_SetsActivityType() public void WithText_SetsTextContent_As_Property() { CoreActivity activity = new CoreActivityBuilder() - .WithProperty("text","Hello, World!") + .WithProperty("text", "Hello, World!") .Build(); Assert.Equal("Hello, World!", activity.Properties["text"]); diff --git a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs index c3dd72f2..70c5f402 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs @@ -217,8 +217,9 @@ private static ConversationClient CreateMockConversationClient() private static UserTokenClient CreateMockUserTokenClient() { Mock mockHttpClient = new(); + Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - return new UserTokenClient(mockHttpClient.Object, logger); + return new UserTokenClient(mockHttpClient.Object, mockConfig.Object, logger); } private static DefaultHttpContext CreateHttpContextWithActivity(CoreActivity activity) diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs index 4137553f..f8b5ef96 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs +++ b/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs @@ -18,7 +18,7 @@ public void CustomActivity_ExtendedProperties_SerializedAndDeserialized() CustomField = "CustomValue" }; string json = MyCustomActivity.ToJson(customActivity); - MyCustomActivity deserializedActivity = CoreActivity.FromJsonString(json); + MyCustomActivity deserializedActivity = MyCustomActivity.FromActivity(CoreActivity.FromJsonString(json)); Assert.NotNull(deserializedActivity); Assert.Equal("CustomValue", deserializedActivity.CustomField); } @@ -50,8 +50,8 @@ public void CustomChannelDataActivity_ExtendedProperties_SerializedAndDeserializ MyChannelId = "12345" } }; - string json = MyCustomChannelDataActivity.ToJson(customChannelDataActivity); - MyCustomChannelDataActivity deserializedActivity = CoreActivity.FromJsonString(json); + string json = CoreActivity.ToJson(customChannelDataActivity); + MyCustomChannelDataActivity deserializedActivity = MyCustomChannelDataActivity.FromActivity(CoreActivity.FromJsonString(json)); Assert.NotNull(deserializedActivity); Assert.NotNull(deserializedActivity.ChannelData); Assert.Equal(ActivityType.Message, deserializedActivity.Type); @@ -72,7 +72,7 @@ public void Deserialize_CustomChannelDataActivity() } } """; - MyCustomChannelDataActivity deserializedActivity = CoreActivity.FromJsonString(json); + MyCustomChannelDataActivity deserializedActivity = MyCustomChannelDataActivity.FromActivity(CoreActivity.FromJsonString(json)); Assert.NotNull(deserializedActivity); Assert.NotNull(deserializedActivity.ChannelData); Assert.Equal("customFieldValue", deserializedActivity.ChannelData.CustomField); @@ -82,6 +82,29 @@ public void Deserialize_CustomChannelDataActivity() public class MyCustomActivity : CoreActivity { + internal static MyCustomActivity FromActivity(CoreActivity activity) + { + return new MyCustomActivity + { + Type = activity.Type, + ChannelId = activity.ChannelId, + Id = activity.Id, + ServiceUrl = activity.ServiceUrl, + ChannelData = activity.ChannelData, + From = activity.From, + Recipient = activity.Recipient, + Conversation = activity.Conversation, + Entities = activity.Entities, + Attachments = activity.Attachments, + Value = activity.Value, + Properties = activity.Properties, + CustomField = activity.Properties.TryGetValue("customField", out object? customFieldObj) + && customFieldObj is JsonElement jeCustomField + && jeCustomField.ValueKind == JsonValueKind.String + ? jeCustomField.GetString() + : null + }; + } [JsonPropertyName("customField")] public string? CustomField { get; set; } } @@ -89,6 +112,29 @@ public class MyCustomActivity : CoreActivity public class MyChannelData : ChannelData { + public MyChannelData() + { + } + public MyChannelData(ChannelData cd) + { + if (cd is not null) + { + if (cd.Properties.TryGetValue("customField", out object? channelIdObj) + && channelIdObj is JsonElement jeChannelId + && jeChannelId.ValueKind == JsonValueKind.String) + { + CustomField = jeChannelId.GetString(); + } + + if (cd.Properties.TryGetValue("myChannelId", out object? mychannelIdObj) + && mychannelIdObj is JsonElement jemyChannelId + && jemyChannelId.ValueKind == JsonValueKind.String) + { + MyChannelId = jemyChannelId.GetString(); + } + } + } + [JsonPropertyName("customField")] public string? CustomField { get; set; } @@ -100,4 +146,22 @@ public class MyCustomChannelDataActivity : CoreActivity { [JsonPropertyName("channelData")] public new MyChannelData? ChannelData { get; set; } + + internal static MyCustomChannelDataActivity FromActivity(CoreActivity coreActivity) + { + return new MyCustomChannelDataActivity + { + Type = coreActivity.Type, + ChannelId = coreActivity.ChannelId, + Id = coreActivity.Id, + ServiceUrl = coreActivity.ServiceUrl, + ChannelData = new MyChannelData(coreActivity.ChannelData ?? new Core.Schema.ChannelData()), + Recipient = coreActivity.Recipient, + Conversation = coreActivity.Conversation, + Entities = coreActivity.Entities, + Attachments = coreActivity.Attachments, + Value = coreActivity.Value, + Properties = coreActivity.Properties + }; + } } diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs b/core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs index 211a7433..9996aaa6 100644 --- a/core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs +++ b/core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs @@ -30,7 +30,7 @@ public void AsConversationUpdate_MembersAdded() ] } """; - TeamsActivity act = CoreActivity.FromJsonString(json); + TeamsActivity act = TeamsActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("conversationUpdate", act.Type); @@ -62,7 +62,7 @@ public void AsConversationUpdate_MembersRemoved() ] } """; - TeamsActivity act = CoreActivity.FromJsonString(json); + TeamsActivity act = TeamsActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("conversationUpdate", act.Type); @@ -98,7 +98,7 @@ public void AsConversationUpdate_BothMembersAddedAndRemoved() ] } """; - TeamsActivity act = CoreActivity.FromJsonString(json); + TeamsActivity act = TeamsActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("conversationUpdate", act.Type); diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs b/core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs index a6f89b28..9bb27d58 100644 --- a/core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs +++ b/core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs @@ -28,7 +28,7 @@ public void AsMessageReaction() ] } """; - TeamsActivity act = CoreActivity.FromJsonString(json); + TeamsActivity act = TeamsActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("messageReaction", act.Type); diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs index 21a92303..ba0b1ebe 100644 --- a/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs +++ b/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs @@ -14,7 +14,7 @@ public class TeamsActivityTests [Fact] public void DeserializeActivityWithTeamsChannelData() { - TeamsActivity activityWithTeamsChannelData = CoreActivity.FromJsonString(json); + TeamsActivity activityWithTeamsChannelData = TeamsActivity.FromJsonString(json); TeamsChannelData tcd = activityWithTeamsChannelData.ChannelData!; Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.TeamsChannelId); Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.Channel!.Id); @@ -24,7 +24,7 @@ public void DeserializeActivityWithTeamsChannelData() [Fact] public void DeserializeTeamsActivityWithTeamsChannelData() { - TeamsActivity activity = CoreActivity.FromJsonString(json); + TeamsActivity activity = TeamsActivity.FromJsonString(json); TeamsChannelData tcd = activity.ChannelData!; Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.TeamsChannelId); Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.Channel!.Id); @@ -56,6 +56,22 @@ static void AssertCid(CoreActivity a) } + [Fact] + public void DownCastTeamsActivity_To_CoreActivity_FromJsonString() + { + + TeamsActivity teamsActivity = TeamsActivity.FromJsonString(json); + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", teamsActivity.Conversation!.Id); + + static void AssertCid(CoreActivity a) + { + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", a.Conversation!.Id); + } + AssertCid(teamsActivity); + + } + + [Fact] public void AddMentionEntity_To_TeamsActivity() { @@ -142,11 +158,11 @@ public void TeamsActivityBuilder_FluentAPI() [Fact] public void Deserialize_With_Entities() { - TeamsActivity activity = CoreActivity.FromJsonString(json); + TeamsActivity activity = TeamsActivity.FromJsonString(json); Assert.NotNull(activity.Entities); Assert.Equal(2, activity.Entities.Count); - List mentions = [.. activity.Entities.Where(e => e is MentionEntity)]; + List mentions = activity.Entities.Where(e => e is MentionEntity).ToList(); Assert.Single(mentions); MentionEntity? m1 = mentions[0] as MentionEntity; Assert.NotNull(m1); @@ -170,7 +186,7 @@ public void Deserialize_With_Entities() [Fact] public void Deserialize_With_Entities_Extensions() { - TeamsActivity activity = CoreActivity.FromJsonString(json); + TeamsActivity activity = TeamsActivity.FromJsonString(json); Assert.NotNull(activity.Entities); Assert.Equal(2, activity.Entities.Count); @@ -211,7 +227,7 @@ public void Serialize_TeamsActivity_WithEntities() [Fact] public void Deserialize_TeamsActivity_WithAttachments() { - TeamsActivity activity = CoreActivity.FromJsonString(json); + TeamsActivity activity = TeamsActivity.FromJsonString(json); Assert.NotNull(activity.Attachments); Assert.Single(activity.Attachments); TeamsAttachment attachment = activity.Attachments[0] as TeamsAttachment; @@ -224,7 +240,7 @@ public void Deserialize_TeamsActivity_WithAttachments() public void Deserialize_TeamsActivity_Invoke_WithValue() { //TeamsActivity activity = CoreActivity.FromJsonString(jsonInvoke); - TeamsActivity activity = TeamsActivity.FromActivity(CoreActivity.FromJsonString(jsonInvoke)) ; + TeamsActivity activity = TeamsActivity.FromActivity(CoreActivity.FromJsonString(jsonInvoke)); Assert.NotNull(activity.Value); string feedback = activity.Value?["action"]?["data"]?["feedback"]?.ToString()!; Assert.Equal("test invokes", feedback); diff --git a/core/version.json b/core/version.json index 25d21e3a..ce1d64b1 100644 --- a/core/version.json +++ b/core/version.json @@ -1,8 +1,10 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", "version": "0.0.1-alpha.{height}", + "pathFilters": ["."], "publicReleaseRefSpec": [ "^refs/heads/main$", + "^refs/heads/next/core$", "^refs/heads/v\\d+(?:\\.\\d+)?$" ], "cloudBuild": { diff --git a/version.json b/version.json index 15ee855f..90a3ed7b 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,7 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", "version": "2.0.5-beta.{height}", + "pathFilters": ["./Libraries"], "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$", From 7ee0e41ad532b2cd9649fa68af4d812aefb63948 Mon Sep 17 00:00:00 2001 From: Rido Date: Thu, 15 Jan 2026 14:37:02 -0800 Subject: [PATCH 36/69] Rename projects to use Microsoft.Teams (#267) --- core/README.md | 41 +++++++++++-------- core/core.slnx | 10 ++--- core/samples/AFBot/AFBot.csproj | 2 +- core/samples/AFBot/DropTypingMiddleware.cs | 4 +- core/samples/AFBot/Program.cs | 6 +-- core/samples/AllFeatures/AllFeatures.csproj | 2 +- core/samples/AllFeatures/Program.cs | 6 +-- core/samples/CompatBot/CompatBot.csproj | 2 +- core/samples/CompatBot/EchoBot.cs | 10 ++--- core/samples/CompatBot/Program.cs | 4 +- core/samples/CoreBot/CoreBot.csproj | 2 +- core/samples/CoreBot/Program.cs | 6 +-- core/samples/Proactive/Proactive.csproj | 2 +- core/samples/Proactive/Program.cs | 2 +- core/samples/Proactive/Worker.cs | 4 +- core/samples/TeamsBot/Program.cs | 8 ++-- core/samples/TeamsBot/TeamsBot.csproj | 2 +- core/samples/scenarios/hello-assistant.cs | 10 ++--- core/samples/scenarios/middleware.cs | 6 +-- core/samples/scenarios/proactive.cs | 6 +-- .../Context.cs | 6 +-- .../Handlers/ConversationUpdateHandler.cs | 6 +-- .../Handlers/InstallationUpdateHandler.cs | 4 +- .../Handlers/InvokeHandler.cs | 2 +- .../Handlers/MessageHandler.cs | 4 +- .../Handlers/MessageReactionHandler.cs | 4 +- .../Microsoft.Teams.Bot.Apps.csproj} | 2 +- .../Schema/Entities/ClientInfoEntity.cs | 2 +- .../Schema/Entities/Entity.cs | 4 +- .../Schema/Entities/MentionEntity.cs | 4 +- .../Schema/Entities/OMessageEntity.cs | 2 +- .../Schema/Entities/ProductInfoEntity.cs | 2 +- .../Schema/Entities/SensitiveUsageEntity.cs | 2 +- .../Schema/Entities/StreamInfoEntity.cs | 2 +- .../Schema/Team.cs | 2 +- .../Schema/TeamsActivity.cs | 6 +-- .../Schema/TeamsActivityBuilder.cs | 6 +-- .../Schema/TeamsActivityJsonContext.cs | 6 +-- .../Schema/TeamsActivityType.cs | 4 +- .../Schema/TeamsAttachment.cs | 4 +- .../Schema/TeamsAttachmentBuilder.cs | 2 +- .../Schema/TeamsChannel.cs | 2 +- .../Schema/TeamsChannelData.cs | 4 +- .../Schema/TeamsChannelDataSettings.cs | 4 +- .../Schema/TeamsChannelDataTenant.cs | 2 +- .../Schema/TeamsConversation.cs | 4 +- .../Schema/TeamsConversationAccount .cs | 4 +- .../TeamsApiClient.Models.cs | 6 +-- .../TeamsApiClient.cs | 8 ++-- .../TeamsBotApplication.HostingExtensions.cs | 4 +- .../TeamsBotApplication.cs | 8 ++-- .../TeamsBotApplicationBuilder.cs | 6 +-- .../CompatActivity.cs | 8 ++-- .../CompatAdapter.cs | 13 +++--- .../CompatAdapterMiddleware.cs | 11 ++--- .../CompatBotAdapter.cs | 5 ++- .../CompatConnectorClient.cs | 2 +- .../CompatConversations.cs | 25 +++++------ .../CompatHostingExtensions.cs | 4 +- .../CompatUserTokenClient.cs | 9 ++-- .../InternalsVisibleTo.cs | 2 +- .../Microsoft.Teams.Bot.Compat.csproj} | 2 +- .../BotApplication.cs | 4 +- .../BotHandlerException.cs | 4 +- .../ConversationClient.Models.cs | 4 +- .../ConversationClient.cs | 6 +-- .../Hosting/AddBotApplicationExtensions.cs | 2 +- .../Hosting/BotAuthenticationHandler.cs | 4 +- .../Hosting/BotConfig.cs | 2 +- .../Hosting/JwtExtensions.cs | 2 +- .../Http/BotHttpClient.cs | 4 +- .../Http/BotRequestOptions.cs | 4 +- .../ITurnMiddleWare.cs | 4 +- .../Microsoft.Teams.Bot.Core.csproj} | 4 +- .../Schema/ActivityType.cs | 2 +- .../Schema/AgenticIdentity.cs | 2 +- .../Schema/ChannelData.cs | 2 +- .../Schema/Conversation.cs | 2 +- .../Schema/ConversationAccount.cs | 2 +- .../Schema/CoreActivity.cs | 2 +- .../Schema/CoreActivityBuilder.cs | 2 +- .../Schema/CoreActivityJsonContext.cs | 2 +- .../TurnMiddleware.cs | 4 +- .../UserTokenClient.Models.cs | 2 +- .../UserTokenClient.cs | 6 +-- .../ABSTokenServiceClient.csproj | 2 +- core/test/ABSTokenServiceClient/Program.cs | 4 +- .../UserTokenCLIService.cs | 2 +- core/test/IntegrationTests.slnx | 8 ++-- .../ConversationUpdateActivityTests.cs | 8 ++-- .../MessageReactionActivityTests.cs | 8 ++-- ...Microsoft.Teams.Bot.Apps.UnitTests.csproj} | 2 +- .../TeamsActivityBuilderTests.cs | 8 ++-- .../TeamsActivityTests.cs | 8 ++-- .../CompatActivityTests.cs | 6 +-- ...crosoft.Teams.Bot.Compat.UnitTests.csproj} | 4 +- .../CompatConversationClientTests.cs | 3 +- .../ConversationClientTest.cs | 5 ++- .../Microsoft.Teams.Bot.Core.Tests.csproj} | 2 +- .../TeamsApiClientTests.cs | 8 ++-- .../readme.md | 0 .../BotApplicationTests.cs | 4 +- .../ConversationClientTests.cs | 4 +- .../CoreActivityBuilderTests.cs | 4 +- .../AddBotApplicationExtensionsTests.cs | 4 +- ...Microsoft.Teams.Bot.Core.UnitTests.csproj} | 2 +- .../MiddlewareTests.cs | 4 +- .../Schema/ActivityExtensibilityTests.cs | 4 +- .../Schema/CoreActivityTests.cs | 4 +- .../Schema/EntitiesTest.cs | 4 +- core/test/aot-checks/Program.cs | 2 +- core/test/aot-checks/aot-checks.csproj | 2 +- core/test/msal-config-api/Program.cs | 6 +-- .../msal-config-api/msal-config-api.csproj | 2 +- 114 files changed, 276 insertions(+), 264 deletions(-) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Context.cs (95%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Handlers/ConversationUpdateHandler.cs (93%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Handlers/InstallationUpdateHandler.cs (94%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Handlers/InvokeHandler.cs (97%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Handlers/MessageHandler.cs (95%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Handlers/MessageReactionHandler.cs (96%) rename core/src/{Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj => Microsoft.Teams.Bot.Apps/Microsoft.Teams.Bot.Apps.csproj} (72%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/Entities/ClientInfoEntity.cs (98%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/Entities/Entity.cs (98%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/Entities/MentionEntity.cs (97%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/Entities/OMessageEntity.cs (94%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/Entities/ProductInfoEntity.cs (92%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/Entities/SensitiveUsageEntity.cs (97%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/Entities/StreamInfoEntity.cs (96%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/Team.cs (97%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsActivity.cs (97%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsActivityBuilder.cs (98%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsActivityJsonContext.cs (90%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsActivityType.cs (94%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsAttachment.cs (97%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsAttachmentBuilder.cs (98%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsChannel.cs (96%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsChannelData.cs (96%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsChannelDataSettings.cs (92%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsChannelDataTenant.cs (89%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsConversation.cs (96%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/Schema/TeamsConversationAccount .cs (96%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/TeamsApiClient.Models.cs (99%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/TeamsApiClient.cs (99%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/TeamsBotApplication.HostingExtensions.cs (96%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/TeamsBotApplication.cs (97%) rename core/src/{Microsoft.Teams.BotApps => Microsoft.Teams.Bot.Apps}/TeamsBotApplicationBuilder.cs (96%) rename core/src/{Microsoft.Bot.Core.Compat => Microsoft.Teams.Bot.Compat}/CompatActivity.cs (94%) rename core/src/{Microsoft.Bot.Core.Compat => Microsoft.Teams.Bot.Compat}/CompatAdapter.cs (93%) rename core/src/{Microsoft.Bot.Core.Compat => Microsoft.Teams.Bot.Compat}/CompatAdapterMiddleware.cs (79%) rename core/src/{Microsoft.Bot.Core.Compat => Microsoft.Teams.Bot.Compat}/CompatBotAdapter.cs (98%) rename core/src/{Microsoft.Bot.Core.Compat => Microsoft.Teams.Bot.Compat}/CompatConnectorClient.cs (96%) rename core/src/{Microsoft.Bot.Core.Compat => Microsoft.Teams.Bot.Compat}/CompatConversations.cs (92%) rename core/src/{Microsoft.Bot.Core.Compat => Microsoft.Teams.Bot.Compat}/CompatHostingExtensions.cs (97%) rename core/src/{Microsoft.Bot.Core.Compat => Microsoft.Teams.Bot.Compat}/CompatUserTokenClient.cs (90%) rename core/src/{Microsoft.Bot.Core.Compat => Microsoft.Teams.Bot.Compat}/InternalsVisibleTo.cs (64%) rename core/src/{Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj => Microsoft.Teams.Bot.Compat/Microsoft.Teams.Bot.Compat.csproj} (85%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/BotApplication.cs (98%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/BotHandlerException.cs (96%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/ConversationClient.Models.cs (98%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/ConversationClient.cs (99%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Hosting/AddBotApplicationExtensions.cs (99%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Hosting/BotAuthenticationHandler.cs (98%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Hosting/BotConfig.cs (97%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Hosting/JwtExtensions.cs (99%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Http/BotHttpClient.cs (99%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Http/BotRequestOptions.cs (93%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/ITurnMiddleWare.cs (95%) rename core/src/{Microsoft.Bot.Core/Microsoft.Bot.Core.csproj => Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj} (89%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Schema/ActivityType.cs (94%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Schema/AgenticIdentity.cs (97%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Schema/ChannelData.cs (95%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Schema/Conversation.cs (94%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Schema/ConversationAccount.cs (98%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Schema/CoreActivity.cs (99%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Schema/CoreActivityBuilder.cs (99%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/Schema/CoreActivityJsonContext.cs (95%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/TurnMiddleware.cs (95%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/UserTokenClient.Models.cs (98%) rename core/src/{Microsoft.Bot.Core => Microsoft.Teams.Bot.Core}/UserTokenClient.cs (98%) rename core/test/{Microsoft.Teams.BotApps.UnitTests => Microsoft.Teams.Bot.Apps.UnitTests}/ConversationUpdateActivityTests.cs (94%) rename core/test/{Microsoft.Teams.BotApps.UnitTests => Microsoft.Teams.Bot.Apps.UnitTests}/MessageReactionActivityTests.cs (86%) rename core/test/{Microsoft.Teams.BotApps.UnitTests/Microsoft.Teams.BotApps.UnitTests.csproj => Microsoft.Teams.Bot.Apps.UnitTests/Microsoft.Teams.Bot.Apps.UnitTests.csproj} (86%) rename core/test/{Microsoft.Teams.BotApps.UnitTests => Microsoft.Teams.Bot.Apps.UnitTests}/TeamsActivityBuilderTests.cs (99%) rename core/test/{Microsoft.Teams.BotApps.UnitTests => Microsoft.Teams.Bot.Apps.UnitTests}/TeamsActivityTests.cs (98%) rename core/test/{Microsoft.Bot.Core.Compat.UnitTests => Microsoft.Teams.Bot.Compat.UnitTests}/CompatActivityTests.cs (97%) rename core/test/{Microsoft.Bot.Core.Compat.UnitTests/Microsoft.Bot.Core.Compat.UnitTests.csproj => Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj} (75%) rename core/test/{Microsoft.Bot.Core.Tests => Microsoft.Teams.Bot.Core.Tests}/CompatConversationClientTests.cs (98%) rename core/test/{Microsoft.Bot.Core.Tests => Microsoft.Teams.Bot.Core.Tests}/ConversationClientTest.cs (99%) rename core/test/{Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj => Microsoft.Teams.Bot.Core.Tests/Microsoft.Teams.Bot.Core.Tests.csproj} (87%) rename core/test/{Microsoft.Bot.Core.Tests => Microsoft.Teams.Bot.Core.Tests}/TeamsApiClientTests.cs (99%) rename core/test/{Microsoft.Bot.Core.Tests => Microsoft.Teams.Bot.Core.Tests}/readme.md (100%) rename core/test/{Microsoft.Bot.Core.UnitTests => Microsoft.Teams.Bot.Core.UnitTests}/BotApplicationTests.cs (99%) rename core/test/{Microsoft.Bot.Core.UnitTests => Microsoft.Teams.Bot.Core.UnitTests}/ConversationClientTests.cs (98%) rename core/test/{Microsoft.Bot.Core.UnitTests => Microsoft.Teams.Bot.Core.UnitTests}/CoreActivityBuilderTests.cs (99%) rename core/test/{Microsoft.Bot.Core.UnitTests => Microsoft.Teams.Bot.Core.UnitTests}/Hosting/AddBotApplicationExtensionsTests.cs (98%) rename core/test/{Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj => Microsoft.Teams.Bot.Core.UnitTests/Microsoft.Teams.Bot.Core.UnitTests.csproj} (88%) rename core/test/{Microsoft.Bot.Core.UnitTests => Microsoft.Teams.Bot.Core.UnitTests}/MiddlewareTests.cs (99%) rename core/test/{Microsoft.Bot.Core.UnitTests => Microsoft.Teams.Bot.Core.UnitTests}/Schema/ActivityExtensibilityTests.cs (98%) rename core/test/{Microsoft.Bot.Core.UnitTests => Microsoft.Teams.Bot.Core.UnitTests}/Schema/CoreActivityTests.cs (99%) rename core/test/{Microsoft.Bot.Core.UnitTests => Microsoft.Teams.Bot.Core.UnitTests}/Schema/EntitiesTest.cs (97%) diff --git a/core/README.md b/core/README.md index 61d0c5fe..d28509f4 100644 --- a/core/README.md +++ b/core/README.md @@ -1,14 +1,14 @@ -# Microsoft.Bot.Core +# Microsoft.Teams.Bot.Core Bot Core implements the Activity Protocol, including schema, conversation client, user token client, and support for Bot and Agentic Identities. ## Design Principles -- Loose schema. `CoreActivity` contains only the strictly required fields for Conversation Client, additional fields are captured as a Dictitionary with JsonExtensionData attributes. -- Simple Serialization. `CoreActivity` can be serialized/deserialized without any custom logic, and trying to avoid custom converters as much as possible. +- Loose schema. `TeamsActivity` contains only the strictly required fields for Conversation Client, additional fields are captured as a Dictionary with JsonExtensionData attributes. +- Simple Serialization. `TeamsActivity` can be serialized/deserialized without any custom logic, and trying to avoid custom converters as much as possible. - Extensible schema. Fields subject to extension, such as `ChannelData` must define their own `Properties` to allow serialization of unknown fields. Use of generics to allow additional types that are not defined in the Core Library. - Auth based on MSAL. Token acquisition done on top of MSAL -- Respect ASP.NET DI. `BotApplication` dependencies are configured based on .NET ServiceCollection extensions, reusing the existing `HttpClient` +- Respect ASP.NET DI. `TeamsBotApplication` dependencies are configured based on .NET ServiceCollection extensions, reusing the existing `HttpClient` - Respect ILogger and IConfiguration. ## Samples @@ -25,7 +25,7 @@ public class MyChannelData : ChannelData public string? MyChannelId { get; set; } } -public class MyCustomChannelDataActivity : CoreActivity +public class MyCustomChannelDataActivity : TeamsActivity { [JsonPropertyName("channelData")] public new MyChannelData? ChannelData { get; set; } @@ -43,7 +43,7 @@ public void Deserialize_CustomChannelDataActivity() } } """; - var deserializedActivity = CoreActivity.FromJsonString(json); + var deserializedActivity = TeamsActivity.FromJsonString(json); Assert.NotNull(deserializedActivity); Assert.NotNull(deserializedActivity.ChannelData); Assert.Equal("customFieldValue", deserializedActivity.ChannelData.CustomField); @@ -51,27 +51,32 @@ public void Deserialize_CustomChannelDataActivity() } ``` -> Note `FromJsonString` lives in `CoreActivity`, and there is no need to override. +> Note `FromJsonString` lives in `TeamsActivity`, and there is no need to override. ### Basic Bot Application Usage ```cs -var webAppBuilder = WebApplication.CreateSlimBuilder(args); -webAppBuilder.Services.AddBotApplication(); -var webApp = webAppBuilder.Build(); -var botApp = webApp.UseBotApplication(); +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Schema; -botApp.OnActivity = async (activity, cancellationToken) => +var builder = TeamsBotApplication.CreateBuilder(); +var teamsApp = builder.Build(); + +teamsApp.OnMessage = async (messageArgs, context, cancellationToken) => { - var replyText = $"CoreBot running on SDK {BotApplication.Version}."; - replyText += $"\r\nYou sent: `{activity.Text}` in activity of type `{activity.Type}`."; - replyText += $"\r\n to Conversation ID: `{activity.Conversation.Id}` type: `{activity.Conversation.Properties["conversationType"]}`"; - var replyActivity = activity.CreateReplyActivity(ActivityType.Message, replyText); - await botApp.SendActivityAsync(replyActivity, cancellationToken); + await context.SendTypingActivityAsync(cancellationToken); + + string replyText = $"You sent: `{messageArgs.Text}` in activity of type `{context.Activity.Type}`."; + + TeamsActivity reply = TeamsActivity.CreateBuilder() + .WithText(replyText) + .Build(); + + await context.SendActivityAsync(reply, cancellationToken); }; -webApp.Run(); +teamsApp.Run(); ``` ## Testing in Teams diff --git a/core/core.slnx b/core/core.slnx index a8233c5a..f94b02cb 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -29,11 +29,11 @@ - - + + - - - + + + diff --git a/core/samples/AFBot/AFBot.csproj b/core/samples/AFBot/AFBot.csproj index 4aeadde1..cfd5f10d 100644 --- a/core/samples/AFBot/AFBot.csproj +++ b/core/samples/AFBot/AFBot.csproj @@ -15,7 +15,7 @@ - + diff --git a/core/samples/AFBot/DropTypingMiddleware.cs b/core/samples/AFBot/DropTypingMiddleware.cs index 2bc95269..3c997e77 100644 --- a/core/samples/AFBot/DropTypingMiddleware.cs +++ b/core/samples/AFBot/DropTypingMiddleware.cs @@ -1,8 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; namespace AFBot; diff --git a/core/samples/AFBot/Program.cs b/core/samples/AFBot/Program.cs index 4ff4c447..39ceb5d5 100644 --- a/core/samples/AFBot/Program.cs +++ b/core/samples/AFBot/Program.cs @@ -6,9 +6,9 @@ using Azure.AI.OpenAI; using Azure.Monitor.OpenTelemetry.AspNetCore; using Microsoft.Agents.AI; -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Schema; using OpenAI; WebApplicationBuilder builder = WebApplication.CreateBuilder(args); diff --git a/core/samples/AllFeatures/AllFeatures.csproj b/core/samples/AllFeatures/AllFeatures.csproj index a2d4b399..515a66f8 100644 --- a/core/samples/AllFeatures/AllFeatures.csproj +++ b/core/samples/AllFeatures/AllFeatures.csproj @@ -7,7 +7,7 @@ - + diff --git a/core/samples/AllFeatures/Program.cs b/core/samples/AllFeatures/Program.cs index b6745722..ff314f19 100644 --- a/core/samples/AllFeatures/Program.cs +++ b/core/samples/AllFeatures/Program.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.BotApps; -using Microsoft.Teams.BotApps.Schema; -using Microsoft.Teams.BotApps.Schema.Entities; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.Entities; var builder = TeamsBotApplication.CreateBuilder(); var teamsApp = builder.Build(); diff --git a/core/samples/CompatBot/CompatBot.csproj b/core/samples/CompatBot/CompatBot.csproj index 65555e22..abacede3 100644 --- a/core/samples/CompatBot/CompatBot.csproj +++ b/core/samples/CompatBot/CompatBot.csproj @@ -11,7 +11,7 @@ - + diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index b6dc8a10..7c594e9a 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -4,13 +4,13 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Teams; using Microsoft.Bot.Connector; -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Compat; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Compat; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Bot.Schema.Teams; -using Microsoft.Teams.BotApps; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Schema; using Newtonsoft.Json.Linq; namespace CompatBot; diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index 42220054..81f04a1d 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -6,8 +6,8 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Compat; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Compat; using Microsoft.Bot.Schema; // using Microsoft.Bot.Connector.Authentication; diff --git a/core/samples/CoreBot/CoreBot.csproj b/core/samples/CoreBot/CoreBot.csproj index a70441d9..48aeee8f 100644 --- a/core/samples/CoreBot/CoreBot.csproj +++ b/core/samples/CoreBot/CoreBot.csproj @@ -11,7 +11,7 @@ - + diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index ada6ecf1..529a3ffb 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using Azure.Monitor.OpenTelemetry.AspNetCore; -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Schema; WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); webAppBuilder.Services.AddOpenTelemetry().UseAzureMonitor(); diff --git a/core/samples/Proactive/Proactive.csproj b/core/samples/Proactive/Proactive.csproj index 5e44d94f..8cb14294 100644 --- a/core/samples/Proactive/Proactive.csproj +++ b/core/samples/Proactive/Proactive.csproj @@ -12,6 +12,6 @@ - + diff --git a/core/samples/Proactive/Program.cs b/core/samples/Proactive/Program.cs index ae7e7b25..85ccefa7 100644 --- a/core/samples/Proactive/Program.cs +++ b/core/samples/Proactive/Program.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Hosting; using Proactive; diff --git a/core/samples/Proactive/Worker.cs b/core/samples/Proactive/Worker.cs index aa7fe5af..aef0308e 100644 --- a/core/samples/Proactive/Worker.cs +++ b/core/samples/Proactive/Worker.cs @@ -1,8 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; namespace Proactive; diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 8bc84437..e97fd388 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.BotApps; -using Microsoft.Teams.BotApps.Handlers; -using Microsoft.Teams.BotApps.Schema; -using Microsoft.Teams.BotApps.Schema.Entities; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.Entities; using TeamsBot; var builder = TeamsBotApplication.CreateBuilder(); diff --git a/core/samples/TeamsBot/TeamsBot.csproj b/core/samples/TeamsBot/TeamsBot.csproj index 92f63141..f30bcbe3 100644 --- a/core/samples/TeamsBot/TeamsBot.csproj +++ b/core/samples/TeamsBot/TeamsBot.csproj @@ -7,7 +7,7 @@ - + diff --git a/core/samples/scenarios/hello-assistant.cs b/core/samples/scenarios/hello-assistant.cs index 24496773..eac282ce 100644 --- a/core/samples/scenarios/hello-assistant.cs +++ b/core/samples/scenarios/hello-assistant.cs @@ -2,13 +2,13 @@ #:sdk Microsoft.NET.Sdk.Web -#:project ../../src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj -#:project ../../src/Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj +#:project ../../src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj +#:project ../../src/Microsoft.Teams.Bot.Apps/Microsoft.Teams.Bot.Apps.csproj -using Microsoft.Teams.BotApps; -using Microsoft.Teams.BotApps.Schema; -using Microsoft.Teams.BotApps.Schema.Entities; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.Entities; var builder = TeamsBotApplication.CreateBuilder(); var teamsApp = builder.Build(); diff --git a/core/samples/scenarios/middleware.cs b/core/samples/scenarios/middleware.cs index 7a172860..5a771997 100755 --- a/core/samples/scenarios/middleware.cs +++ b/core/samples/scenarios/middleware.cs @@ -4,9 +4,9 @@ #:project ../../src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Schema; -using Microsoft.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Hosting; WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); diff --git a/core/samples/scenarios/proactive.cs b/core/samples/scenarios/proactive.cs index f489928a..9728133a 100644 --- a/core/samples/scenarios/proactive.cs +++ b/core/samples/scenarios/proactive.cs @@ -4,9 +4,9 @@ #:project ../../src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj -using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; var builder = Host.CreateApplicationBuilder(args); builder.Services.AddBotApplicationClients(); diff --git a/core/src/Microsoft.Teams.BotApps/Context.cs b/core/src/Microsoft.Teams.Bot.Apps/Context.cs similarity index 95% rename from core/src/Microsoft.Teams.BotApps/Context.cs rename to core/src/Microsoft.Teams.Bot.Apps/Context.cs index cf4d96e9..303ceaef 100644 --- a/core/src/Microsoft.Teams.BotApps/Context.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Context.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Teams.BotApps; +namespace Microsoft.Teams.Bot.Apps; // TODO: Make Context Generic over the TeamsActivity type. // It should be able to work with any type of TeamsActivity. diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/ConversationUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs similarity index 93% rename from core/src/Microsoft.Teams.BotApps/Handlers/ConversationUpdateHandler.cs rename to core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs index bc3b2062..e4aa68ae 100644 --- a/core/src/Microsoft.Teams.BotApps/Handlers/ConversationUpdateHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs @@ -2,10 +2,10 @@ // Licensed under the MIT License. using System.Text.Json; -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Teams.BotApps.Handlers; +namespace Microsoft.Teams.Bot.Apps.Handlers; /// /// Delegate for handling conversation update activities. diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/InstallationUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs similarity index 94% rename from core/src/Microsoft.Teams.BotApps/Handlers/InstallationUpdateHandler.cs rename to core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs index 518fc01d..fc139713 100644 --- a/core/src/Microsoft.Teams.BotApps/Handlers/InstallationUpdateHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Teams.BotApps.Handlers; +namespace Microsoft.Teams.Bot.Apps.Handlers; /// /// Delegate for handling installation update activities. diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs similarity index 97% rename from core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs rename to core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs index 9db28570..de737771 100644 --- a/core/src/Microsoft.Teams.BotApps/Handlers/InvokeHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.BotApps.Handlers; +namespace Microsoft.Teams.Bot.Apps.Handlers; /// /// Represents a method that handles an invocation request and returns a response asynchronously. diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/MessageHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs similarity index 95% rename from core/src/Microsoft.Teams.BotApps/Handlers/MessageHandler.cs rename to core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs index aff92d0e..f8066a9e 100644 --- a/core/src/Microsoft.Teams.BotApps/Handlers/MessageHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using System.Text.Json; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Teams.BotApps.Handlers; +namespace Microsoft.Teams.Bot.Apps.Handlers; // TODO: Handlers should just have context instead of args + context. diff --git a/core/src/Microsoft.Teams.BotApps/Handlers/MessageReactionHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs similarity index 96% rename from core/src/Microsoft.Teams.BotApps/Handlers/MessageReactionHandler.cs rename to core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs index 4f006c1f..2e55d26e 100644 --- a/core/src/Microsoft.Teams.BotApps/Handlers/MessageReactionHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs @@ -3,9 +3,9 @@ using System.Text.Json; using System.Text.Json.Serialization; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Teams.BotApps.Handlers; +namespace Microsoft.Teams.Bot.Apps.Handlers; /// /// Delegate for handling message reaction activities. diff --git a/core/src/Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj b/core/src/Microsoft.Teams.Bot.Apps/Microsoft.Teams.Bot.Apps.csproj similarity index 72% rename from core/src/Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj rename to core/src/Microsoft.Teams.Bot.Apps/Microsoft.Teams.Bot.Apps.csproj index d9983477..a25e40ad 100644 --- a/core/src/Microsoft.Teams.BotApps/Microsoft.Teams.BotApps.csproj +++ b/core/src/Microsoft.Teams.Bot.Apps/Microsoft.Teams.Bot.Apps.csproj @@ -7,7 +7,7 @@ - + diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/ClientInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs similarity index 98% rename from core/src/Microsoft.Teams.BotApps/Schema/Entities/ClientInfoEntity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs index a6972734..8e76775d 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/Entities/ClientInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.BotApps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema.Entities; /// diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/Entity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs similarity index 98% rename from core/src/Microsoft.Teams.BotApps/Schema/Entities/Entity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs index 9c824115..d82dd335 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/Entities/Entity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs @@ -4,9 +4,9 @@ using System.Text.Json; using System.Text.Json.Nodes; using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.BotApps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema.Entities; /// diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/MentionEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs similarity index 97% rename from core/src/Microsoft.Teams.BotApps/Schema/Entities/MentionEntity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs index 458a591a..3227cd43 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/Entities/MentionEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs @@ -4,9 +4,9 @@ using System.Text.Json; using System.Text.Json.Nodes; using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.BotApps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema.Entities; /// /// Extension methods for Activity to handle mentions. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/OMessageEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs similarity index 94% rename from core/src/Microsoft.Teams.BotApps/Schema/Entities/OMessageEntity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs index c595c47e..4edbafc9 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/Entities/OMessageEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.BotApps.Schema.Entities +namespace Microsoft.Teams.Bot.Apps.Schema.Entities { /// /// OMessage entity. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs similarity index 92% rename from core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs index f1c3f505..a56a4442 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/Entities/ProductInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.BotApps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema.Entities; diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/SensitiveUsageEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs similarity index 97% rename from core/src/Microsoft.Teams.BotApps/Schema/Entities/SensitiveUsageEntity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs index d4dd7a75..6e6444c1 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/Entities/SensitiveUsageEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.BotApps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema.Entities; /// /// Represents an entity that describes the usage of sensitive content, including its name, description, and associated diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Entities/StreamInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs similarity index 96% rename from core/src/Microsoft.Teams.BotApps/Schema/Entities/StreamInfoEntity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs index 86a68d32..718bf7ab 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/Entities/StreamInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.BotApps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema.Entities; /// /// Stream info entity. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/Team.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Team.cs similarity index 97% rename from core/src/Microsoft.Teams.BotApps/Schema/Team.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Team.cs index 9c2ac521..3aa75215 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/Team.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Team.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.BotApps.Schema +namespace Microsoft.Teams.Bot.Apps.Schema { /// /// Represents a team, including its identity, group association, and membership details. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs similarity index 97% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs index bfc8d81d..aea2a97c 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs @@ -4,10 +4,10 @@ using System.Text.Json; using System.Text.Json.Serialization; using System.Text.Json.Serialization.Metadata; -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Schema.Entities; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema.Entities; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Teams Activity schema. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityBuilder.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs similarity index 98% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityBuilder.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs index d33b5762..aed75764 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Schema.Entities; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema.Entities; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Provides a fluent API for building TeamsActivity instances. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityJsonContext.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs similarity index 90% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityJsonContext.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs index f56a6e4e..229a59eb 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityJsonContext.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs @@ -2,10 +2,10 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Schema.Entities; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema.Entities; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Json source generator context for Teams activity types. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs similarity index 94% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs index 4739f1cb..edc8f6a5 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsActivityType.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Provides constant values for activity types used in Microsoft Teams bot interactions. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs similarity index 97% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs index 65bae5fc..1746378c 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachment.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs @@ -4,9 +4,9 @@ using System.Text.Json; using System.Text.Json.Nodes; using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachmentBuilder.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachmentBuilder.cs similarity index 98% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachmentBuilder.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachmentBuilder.cs index e0f344eb..19cbec22 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsAttachmentBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachmentBuilder.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Provides a fluent API for creating instances. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannel.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannel.cs similarity index 96% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsChannel.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannel.cs index 60d5f695..2c85d9c0 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannel.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannel.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents a Microsoft Teams channel, including its identifier, type, and display name. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs similarity index 96% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs index 72cef021..d17f8adf 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelData.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs @@ -3,9 +3,9 @@ using System.Text.Json; using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents Teams-specific channel data. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataSettings.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataSettings.cs similarity index 92% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataSettings.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataSettings.cs index cf885a8b..0b6a5214 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataSettings.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataSettings.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Teams channel data settings. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataTenant.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataTenant.cs similarity index 89% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataTenant.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataTenant.cs index 77781977..5f2d59d6 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsChannelDataTenant.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataTenant.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Tenant information for Teams channel data. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversation.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs similarity index 96% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsConversation.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs index 7410b5b6..aa310b49 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversation.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs @@ -3,9 +3,9 @@ using System.Text.Json; using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Defines known conversation types for Teams. diff --git a/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount .cs similarity index 96% rename from core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount .cs index e6c8c9d0..da0b576d 100644 --- a/core/src/Microsoft.Teams.BotApps/Schema/TeamsConversationAccount .cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount .cs @@ -3,9 +3,9 @@ using System.Text.Json; using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.BotApps.Schema; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents a Microsoft Teams-specific conversation account, including Azure Active Directory (AAD) object diff --git a/core/src/Microsoft.Teams.BotApps/TeamsApiClient.Models.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs similarity index 99% rename from core/src/Microsoft.Teams.BotApps/TeamsApiClient.Models.cs rename to core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs index f8ef3905..837a3f69 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsApiClient.Models.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs @@ -2,10 +2,10 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Teams.BotApps; +namespace Microsoft.Teams.Bot.Apps; /// /// Represents a list of channels in a team. diff --git a/core/src/Microsoft.Teams.BotApps/TeamsApiClient.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs similarity index 99% rename from core/src/Microsoft.Teams.BotApps/TeamsApiClient.cs rename to core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs index ee2fcc1f..608654e5 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsApiClient.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs @@ -2,12 +2,12 @@ // Licensed under the MIT License. using System.Text.Json; -using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Http; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Http; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Logging; -namespace Microsoft.Teams.BotApps; +namespace Microsoft.Teams.Bot.Apps; using CustomHeaders = Dictionary; diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.HostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs similarity index 96% rename from core/src/Microsoft.Teams.BotApps/TeamsBotApplication.HostingExtensions.cs rename to core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs index 9d6c2452..f11b2cf2 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.HostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; -namespace Microsoft.Teams.BotApps; +namespace Microsoft.Teams.Bot.Apps; /// /// Extension methods for . diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs similarity index 97% rename from core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs rename to core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 4ca3508e..6ce733cf 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -2,13 +2,13 @@ // Licensed under the MIT License. using Microsoft.AspNetCore.Http; -using Microsoft.Bot.Core; +using Microsoft.Teams.Bot.Core; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; -using Microsoft.Teams.BotApps.Handlers; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Teams.BotApps; +namespace Microsoft.Teams.Bot.Apps; /// /// Teams specific Bot Application diff --git a/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs similarity index 96% rename from core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs rename to core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs index 09456c58..5b9d6966 100644 --- a/core/src/Microsoft.Teams.BotApps/TeamsBotApplicationBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs @@ -3,13 +3,13 @@ using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; -namespace Microsoft.Teams.BotApps; +namespace Microsoft.Teams.Bot.Apps; /// /// Teams Bot Application Builder to configure and build a Teams bot application. diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs similarity index 94% rename from core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs rename to core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs index 1353c53c..fbee125d 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs @@ -4,12 +4,12 @@ using System.Text; using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Bot.Schema; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Apps.Schema; using Newtonsoft.Json; -namespace Microsoft.Bot.Core.Compat; +namespace Microsoft.Teams.Bot.Compat; /// /// Extension methods for converting between Bot Framework Activity and CoreActivity/TeamsActivity. @@ -50,7 +50,7 @@ public static TeamsActivity FromCompatActivity(this Activity activity) /// /// /// - public static Microsoft.Bot.Schema.ChannelAccount ToCompatChannelAccount(this Microsoft.Bot.Core.Schema.ConversationAccount account) + public static Microsoft.Bot.Schema.ChannelAccount ToCompatChannelAccount(this Microsoft.Teams.Bot.Core.Schema.ConversationAccount account) { ArgumentNullException.ThrowIfNull(account); diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs similarity index 93% rename from core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs rename to core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index 9343cfda..5c93d33c 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -4,12 +4,13 @@ using Microsoft.AspNetCore.Http; using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Bot.Schema; -using Microsoft.Teams.BotApps; +using Microsoft.Teams.Bot.Apps; -namespace Microsoft.Bot.Core.Compat; +namespace Microsoft.Teams.Bot.Compat; /// /// Provides a compatibility adapter for processing bot activities and HTTP requests using legacy middleware and bot @@ -44,7 +45,7 @@ public class CompatAdapter(TeamsBotApplication botApplication, CompatBotAdapter /// /// The middleware component to be invoked during request processing. Cannot be null. /// The current instance, enabling method chaining. - public CompatAdapter Use(Builder.IMiddleware middleware) + public CompatAdapter Use(Microsoft.Bot.Builder.IMiddleware middleware) { MiddlewareSet.Use(middleware); return this; @@ -68,7 +69,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons { coreActivity = activity; TurnContext turnContext = new(compatBotAdapter, activity.ToCompatActivity()); - turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); + turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); CompatConnectorClient connectionClient = new(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); turnContext.TurnState.Add(connectionClient); await bot.OnTurnAsync(turnContext, cancellationToken1).ConfigureAwait(false); @@ -76,7 +77,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons try { - foreach (Builder.IMiddleware? middleware in MiddlewareSet) + foreach (Microsoft.Bot.Builder.IMiddleware? middleware in MiddlewareSet) { botApplication.Use(new CompatAdapterMiddleware(middleware)); } diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatAdapterMiddleware.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs similarity index 79% rename from core/src/Microsoft.Bot.Core.Compat/CompatAdapterMiddleware.cs rename to core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs index 212aea58..f999302a 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatAdapterMiddleware.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs @@ -2,10 +2,11 @@ // Licensed under the MIT License. using Microsoft.Bot.Builder; -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps; -namespace Microsoft.Bot.Core.Compat; +namespace Microsoft.Teams.Bot.Compat; internal sealed class CompatAdapterMiddleware(IMiddleware bfMiddleWare) : ITurnMiddleWare { @@ -18,11 +19,11 @@ public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, Ne TurnContext turnContext = new(new CompatBotAdapter(tba), activity.ToCompatActivity()); #pragma warning restore CA2000 // Dispose objects before losing scope - turnContext.TurnState.Add( + turnContext.TurnState.Add( new CompatUserTokenClient(botApplication.UserTokenClient) ); - turnContext.TurnState.Add( + turnContext.TurnState.Add( new CompatConnectorClient( new CompatConversations(botApplication.ConversationClient) { diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs similarity index 98% rename from core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs rename to core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs index 7d7d623e..b829ae62 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs @@ -5,11 +5,12 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Schema; using Microsoft.Extensions.Logging; -using Microsoft.Teams.BotApps; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Apps; using Newtonsoft.Json; -namespace Microsoft.Bot.Core.Compat; +namespace Microsoft.Teams.Bot.Compat; /// /// Provides a Bot Framework adapter that enables compatibility between the Bot Framework SDK and a custom bot diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatConnectorClient.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatConnectorClient.cs similarity index 96% rename from core/src/Microsoft.Bot.Core.Compat/CompatConnectorClient.cs rename to core/src/Microsoft.Teams.Bot.Compat/CompatConnectorClient.cs index a74bd6b9..4e8fb883 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatConnectorClient.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatConnectorClient.cs @@ -5,7 +5,7 @@ using Microsoft.Rest; using Newtonsoft.Json; -namespace Microsoft.Bot.Core.Compat +namespace Microsoft.Teams.Bot.Compat { internal sealed class CompatConnectorClient(CompatConversations conversations) : IConnectorClient { diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs similarity index 92% rename from core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs rename to core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs index 20ff4b45..3ad938d9 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatConversations.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs @@ -2,13 +2,14 @@ // Licensed under the MIT License. using Microsoft.Bot.Connector; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Rest; // TODO: Figure out what to do with Agentic Identities. They're all "nulls" here right now. // The identity is dependent on the incoming payload or supplied in for proactive scenarios. -namespace Microsoft.Bot.Core.Compat +namespace Microsoft.Teams.Bot.Compat { internal sealed class CompatConversations(ConversationClient client) : IConversations { @@ -22,7 +23,7 @@ public async Task> CreateCon { ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); - Microsoft.Bot.Core.ConversationParameters convoParams = new() + Microsoft.Teams.Bot.Core.ConversationParameters convoParams = new() { Activity = parameters.Activity.FromCompatActivity() }; @@ -85,7 +86,7 @@ public async Task>> GetActivityMembe { Dictionary? convertedHeaders = ConvertHeaders(customHeaders); - IList members = await _client.GetActivityMembersAsync( + IList members = await _client.GetActivityMembersAsync( conversationId, activityId, new Uri(ServiceUrl!), @@ -108,7 +109,7 @@ public async Task>> GetConversationM Dictionary? convertedHeaders = ConvertHeaders(customHeaders); - IList members = await _client.GetConversationMembersAsync( + IList members = await _client.GetConversationMembersAsync( conversationId, new Uri(ServiceUrl), null, @@ -130,7 +131,7 @@ public async Task>> GetConversationM Dictionary? convertedHeaders = ConvertHeaders(customHeaders); - PagedMembersResult pagedMembers = await _client.GetConversationPagedMembersAsync( + Microsoft.Teams.Bot.Core.PagedMembersResult pagedMembers = await _client.GetConversationPagedMembersAsync( conversationId, new Uri(ServiceUrl), pageSize, @@ -139,7 +140,7 @@ public async Task>> GetConversationM convertedHeaders, cancellationToken).ConfigureAwait(false); - Bot.Schema.PagedMembersResult result = new() + Microsoft.Bot.Schema.PagedMembersResult result = new() { ContinuationToken = pagedMembers.ContinuationToken, Members = pagedMembers.Members?.Select(m => m.ToCompatChannelAccount()).ToList() @@ -190,7 +191,7 @@ public async Task> ReplyToActivityWithHt coreActivity.Properties["replyToId"] = activityId; if (coreActivity.Conversation == null) { - coreActivity.Conversation = new Core.Schema.Conversation { Id = conversationId }; + coreActivity.Conversation = new Microsoft.Teams.Bot.Core.Schema.Conversation { Id = conversationId }; } else { @@ -217,7 +218,7 @@ public async Task> SendConversationHisto Dictionary? convertedHeaders = ConvertHeaders(customHeaders); - Transcript coreTranscript = new() + Microsoft.Teams.Bot.Core.Transcript coreTranscript = new() { Activities = transcript.Activities?.Select(a => a.FromCompatActivity() as CoreActivity).ToList() }; @@ -249,7 +250,7 @@ public async Task> SendToConversationWit CoreActivity coreActivity = activity.FromCompatActivity(); // Ensure conversation ID is set - coreActivity.Conversation ??= new Core.Schema.Conversation { Id = conversationId }; + coreActivity.Conversation ??= new Microsoft.Teams.Bot.Core.Schema.Conversation { Id = conversationId }; SendActivityResponse response = await _client.SendActivityAsync(coreActivity, convertedHeaders, cancellationToken).ConfigureAwait(false); @@ -290,7 +291,7 @@ public async Task> UploadAttachmentWithH ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); Dictionary? convertedHeaders = ConvertHeaders(customHeaders); - AttachmentData coreAttachmentData = new() + Microsoft.Teams.Bot.Core.AttachmentData coreAttachmentData = new() { Type = attachmentUpload.Type, Name = attachmentUpload.Name, @@ -340,7 +341,7 @@ public async Task> GetConversationMemberWi Dictionary? convertedHeaders = ConvertHeaders(customHeaders); - Teams.BotApps.Schema.TeamsConversationAccount response = await _client.GetConversationMemberAsync( + Microsoft.Teams.Bot.Apps.Schema.TeamsConversationAccount response = await _client.GetConversationMemberAsync( conversationId, userId, new Uri(ServiceUrl), null!, convertedHeaders, cancellationToken).ConfigureAwait(false); return new HttpOperationResponse diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs similarity index 97% rename from core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs rename to core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs index d076bd0a..b2b669fc 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatHostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs @@ -4,9 +4,9 @@ using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; -using Microsoft.Teams.BotApps; +using Microsoft.Teams.Bot.Apps; -namespace Microsoft.Bot.Core.Compat; +namespace Microsoft.Teams.Bot.Compat; /// /// Provides extension methods for registering compatibility adapters and related services to support legacy bot hosting diff --git a/core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatUserTokenClient.cs similarity index 90% rename from core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs rename to core/src/Microsoft.Teams.Bot.Compat/CompatUserTokenClient.cs index a3553390..f7218156 100644 --- a/core/src/Microsoft.Bot.Core.Compat/CompatUserTokenClient.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatUserTokenClient.cs @@ -2,10 +2,11 @@ // Licensed under the MIT License. using Microsoft.Bot.Schema; +using Microsoft.Teams.Bot.Core; -namespace Microsoft.Bot.Core.Compat; +namespace Microsoft.Teams.Bot.Compat; -internal sealed class CompatUserTokenClient(Core.UserTokenClient utc) : Connector.Authentication.UserTokenClient +internal sealed class CompatUserTokenClient(UserTokenClient utc) : Microsoft.Bot.Connector.Authentication.UserTokenClient { public async override Task GetTokenStatusAsync(string userId, string channelId, string includeFilter, CancellationToken cancellationToken) { @@ -46,7 +47,7 @@ public async override Task GetSignInResourceAsync(string connect if (res.TokenExchangeResource != null) { - signInResource.TokenExchangeResource = new Bot.Schema.TokenExchangeResource + signInResource.TokenExchangeResource = new Microsoft.Bot.Schema.TokenExchangeResource { Id = res.TokenExchangeResource.Id, Uri = res.TokenExchangeResource.Uri?.ToString(), @@ -56,7 +57,7 @@ public async override Task GetSignInResourceAsync(string connect if (res.TokenPostResource != null) { - signInResource.TokenPostResource = new Bot.Schema.TokenPostResource + signInResource.TokenPostResource = new Microsoft.Bot.Schema.TokenPostResource { SasUrl = res.TokenPostResource.SasUrl?.ToString() }; diff --git a/core/src/Microsoft.Bot.Core.Compat/InternalsVisibleTo.cs b/core/src/Microsoft.Teams.Bot.Compat/InternalsVisibleTo.cs similarity index 64% rename from core/src/Microsoft.Bot.Core.Compat/InternalsVisibleTo.cs rename to core/src/Microsoft.Teams.Bot.Compat/InternalsVisibleTo.cs index aacccbef..c1d99fd1 100644 --- a/core/src/Microsoft.Bot.Core.Compat/InternalsVisibleTo.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/InternalsVisibleTo.cs @@ -3,4 +3,4 @@ using System.Runtime.CompilerServices; -[assembly: InternalsVisibleTo("Microsoft.Bot.Core.Tests")] +[assembly: InternalsVisibleTo("Microsoft.Teams.Bot.Core.Tests")] diff --git a/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj b/core/src/Microsoft.Teams.Bot.Compat/Microsoft.Teams.Bot.Compat.csproj similarity index 85% rename from core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj rename to core/src/Microsoft.Teams.Bot.Compat/Microsoft.Teams.Bot.Compat.csproj index 6f7e7ba5..6b50258b 100644 --- a/core/src/Microsoft.Bot.Core.Compat/Microsoft.Bot.Core.Compat.csproj +++ b/core/src/Microsoft.Teams.Bot.Compat/Microsoft.Teams.Bot.Compat.csproj @@ -9,7 +9,7 @@ - + diff --git a/core/src/Microsoft.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs similarity index 98% rename from core/src/Microsoft.Bot.Core/BotApplication.cs rename to core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index 0ceab1d7..fbf7ca81 100644 --- a/core/src/Microsoft.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -2,11 +2,11 @@ // Licensed under the MIT License. using Microsoft.AspNetCore.Http; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; -namespace Microsoft.Bot.Core; +namespace Microsoft.Teams.Bot.Core; /// /// Represents a bot application. diff --git a/core/src/Microsoft.Bot.Core/BotHandlerException.cs b/core/src/Microsoft.Teams.Bot.Core/BotHandlerException.cs similarity index 96% rename from core/src/Microsoft.Bot.Core/BotHandlerException.cs rename to core/src/Microsoft.Teams.Bot.Core/BotHandlerException.cs index 1cb3940e..6301925b 100644 --- a/core/src/Microsoft.Bot.Core/BotHandlerException.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotHandlerException.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Bot.Core; +namespace Microsoft.Teams.Bot.Core; /// /// Represents errors that occur during bot activity processing and provides context about the associated activity. diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.Models.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.Models.cs similarity index 98% rename from core/src/Microsoft.Bot.Core/ConversationClient.Models.cs rename to core/src/Microsoft.Teams.Bot.Core/ConversationClient.Models.cs index de0a345a..72508267 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.Models.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.Models.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Bot.Core; +namespace Microsoft.Teams.Bot.Core; /// /// Response from sending an activity. diff --git a/core/src/Microsoft.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs similarity index 99% rename from core/src/Microsoft.Bot.Core/ConversationClient.cs rename to core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs index 75e3b273..d4e3d217 100644 --- a/core/src/Microsoft.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs @@ -2,11 +2,11 @@ // Licensed under the MIT License. using System.Text.Json; -using Microsoft.Bot.Core.Http; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Http; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Logging; -namespace Microsoft.Bot.Core; +namespace Microsoft.Teams.Bot.Core; using CustomHeaders = Dictionary; diff --git a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs similarity index 99% rename from core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs rename to core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 000c408f..41c15ace 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -11,7 +11,7 @@ using Microsoft.Identity.Web; using Microsoft.Identity.Web.TokenCacheProviders.InMemory; -namespace Microsoft.Bot.Core.Hosting; +namespace Microsoft.Teams.Bot.Core.Hosting; /// /// Provides extension methods for registering bot application clients and related authentication services with the diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs similarity index 98% rename from core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs rename to core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs index 215bf40f..5cb65517 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -3,13 +3,13 @@ using System.Net.Http.Headers; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; using Microsoft.Identity.Web; -namespace Microsoft.Bot.Core.Hosting; +namespace Microsoft.Teams.Bot.Core.Hosting; /// /// HTTP message handler that automatically acquires and attaches authentication tokens diff --git a/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs similarity index 97% rename from core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs rename to core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs index b77bca62..dddfe836 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/BotConfig.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs @@ -3,7 +3,7 @@ using Microsoft.Extensions.Configuration; -namespace Microsoft.Bot.Core.Hosting; +namespace Microsoft.Teams.Bot.Core.Hosting; internal sealed class BotConfig diff --git a/core/src/Microsoft.Bot.Core/Hosting/JwtExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs similarity index 99% rename from core/src/Microsoft.Bot.Core/Hosting/JwtExtensions.cs rename to core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs index 91a24c11..583f2db7 100644 --- a/core/src/Microsoft.Bot.Core/Hosting/JwtExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs @@ -13,7 +13,7 @@ using Microsoft.IdentityModel.Tokens; using Microsoft.IdentityModel.Validators; -namespace Microsoft.Bot.Core.Hosting +namespace Microsoft.Teams.Bot.Core.Hosting { /// /// Provides extension methods for configuring JWT authentication and authorization for bots and agents. diff --git a/core/src/Microsoft.Bot.Core/Http/BotHttpClient.cs b/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs similarity index 99% rename from core/src/Microsoft.Bot.Core/Http/BotHttpClient.cs rename to core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs index 3e1911af..03532835 100644 --- a/core/src/Microsoft.Bot.Core/Http/BotHttpClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs @@ -7,10 +7,10 @@ using System.Text; using System.Text.Json; using Microsoft.AspNetCore.WebUtilities; -using Microsoft.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Extensions.Logging; -namespace Microsoft.Bot.Core.Http; +namespace Microsoft.Teams.Bot.Core.Http; /// /// Provides shared HTTP request functionality for bot clients. /// diff --git a/core/src/Microsoft.Bot.Core/Http/BotRequestOptions.cs b/core/src/Microsoft.Teams.Bot.Core/Http/BotRequestOptions.cs similarity index 93% rename from core/src/Microsoft.Bot.Core/Http/BotRequestOptions.cs rename to core/src/Microsoft.Teams.Bot.Core/Http/BotRequestOptions.cs index fb06885a..cbeccb52 100644 --- a/core/src/Microsoft.Bot.Core/Http/BotRequestOptions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Http/BotRequestOptions.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Bot.Core.Http; +namespace Microsoft.Teams.Bot.Core.Http; using CustomHeaders = Dictionary; diff --git a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs b/core/src/Microsoft.Teams.Bot.Core/ITurnMiddleWare.cs similarity index 95% rename from core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs rename to core/src/Microsoft.Teams.Bot.Core/ITurnMiddleWare.cs index 2ff8d5f8..cb55c6ab 100644 --- a/core/src/Microsoft.Bot.Core/ITurnMiddleWare.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ITurnMiddleWare.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Bot.Core; +namespace Microsoft.Teams.Bot.Core; /// /// Represents a delegate that invokes the next middleware component in the pipeline asynchronously. diff --git a/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj b/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj similarity index 89% rename from core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj rename to core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj index 791c399b..b7c88f86 100644 --- a/core/src/Microsoft.Bot.Core/Microsoft.Bot.Core.csproj +++ b/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj @@ -8,8 +8,8 @@ - - + + diff --git a/core/src/Microsoft.Bot.Core/Schema/ActivityType.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/ActivityType.cs similarity index 94% rename from core/src/Microsoft.Bot.Core/Schema/ActivityType.cs rename to core/src/Microsoft.Teams.Bot.Core/Schema/ActivityType.cs index ab86f26a..ea381801 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ActivityType.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/ActivityType.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Teams.Bot.Core.Schema; /// /// Provides constant values that represent activity types used in messaging workflows. diff --git a/core/src/Microsoft.Bot.Core/Schema/AgenticIdentity.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/AgenticIdentity.cs similarity index 97% rename from core/src/Microsoft.Bot.Core/Schema/AgenticIdentity.cs rename to core/src/Microsoft.Teams.Bot.Core/Schema/AgenticIdentity.cs index 6ded3bcc..51c54329 100644 --- a/core/src/Microsoft.Bot.Core/Schema/AgenticIdentity.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/AgenticIdentity.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Teams.Bot.Core.Schema; /// /// Represents an agentic identity for user-delegated token acquisition. diff --git a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/ChannelData.cs similarity index 95% rename from core/src/Microsoft.Bot.Core/Schema/ChannelData.cs rename to core/src/Microsoft.Teams.Bot.Core/Schema/ChannelData.cs index 9500664b..680480bd 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ChannelData.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/ChannelData.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Teams.Bot.Core.Schema; /// /// Represents channel-specific data associated with an activity. diff --git a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/Conversation.cs similarity index 94% rename from core/src/Microsoft.Bot.Core/Schema/Conversation.cs rename to core/src/Microsoft.Teams.Bot.Core/Schema/Conversation.cs index 473133d7..59ef6d4f 100644 --- a/core/src/Microsoft.Bot.Core/Schema/Conversation.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/Conversation.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Teams.Bot.Core.Schema; /// /// Represents a conversation, including its unique identifier and associated extended properties. diff --git a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/ConversationAccount.cs similarity index 98% rename from core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs rename to core/src/Microsoft.Teams.Bot.Core/Schema/ConversationAccount.cs index e57add35..232cc3a6 100644 --- a/core/src/Microsoft.Bot.Core/Schema/ConversationAccount.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/ConversationAccount.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Teams.Bot.Core.Schema; /// /// Represents a conversation account, including its unique identifier, display name, and any additional properties diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs similarity index 99% rename from core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs rename to core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs index 2f9ff483..3fc0846b 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs @@ -5,7 +5,7 @@ using System.Text.Json.Nodes; using System.Text.Json.Serialization.Metadata; -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Teams.Bot.Core.Schema; /// /// Represents a dictionary for storing extended properties as key-value pairs. diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivityBuilder.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs similarity index 99% rename from core/src/Microsoft.Bot.Core/Schema/CoreActivityBuilder.cs rename to core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs index 8d01c37d..d05e635e 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivityBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Teams.Bot.Core.Schema; /// /// Provides a fluent API for building CoreActivity instances. diff --git a/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityJsonContext.cs similarity index 95% rename from core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs rename to core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityJsonContext.cs index 39b7a9d2..e8360273 100644 --- a/core/src/Microsoft.Bot.Core/Schema/CoreActivityJsonContext.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityJsonContext.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -namespace Microsoft.Bot.Core.Schema; +namespace Microsoft.Teams.Bot.Core.Schema; /// /// JSON source generator context for Core activity types. diff --git a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs b/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs similarity index 95% rename from core/src/Microsoft.Bot.Core/TurnMiddleware.cs rename to core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs index 5a1ae039..e0101a07 100644 --- a/core/src/Microsoft.Bot.Core/TurnMiddleware.cs +++ b/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using System.Collections; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Bot.Core; +namespace Microsoft.Teams.Bot.Core; internal sealed class TurnMiddleware : ITurnMiddleWare, IEnumerable { diff --git a/core/src/Microsoft.Bot.Core/UserTokenClient.Models.cs b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.Models.cs similarity index 98% rename from core/src/Microsoft.Bot.Core/UserTokenClient.Models.cs rename to core/src/Microsoft.Teams.Bot.Core/UserTokenClient.Models.cs index eb7206de..258aebc1 100644 --- a/core/src/Microsoft.Bot.Core/UserTokenClient.Models.cs +++ b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.Models.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -namespace Microsoft.Bot.Core; +namespace Microsoft.Teams.Bot.Core; /// diff --git a/core/src/Microsoft.Bot.Core/UserTokenClient.cs b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs similarity index 98% rename from core/src/Microsoft.Bot.Core/UserTokenClient.cs rename to core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs index ed7430d6..c3d5c85e 100644 --- a/core/src/Microsoft.Bot.Core/UserTokenClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs @@ -3,12 +3,12 @@ using System.Text; using System.Text.Json; -using Microsoft.Bot.Core.Http; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Http; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; -namespace Microsoft.Bot.Core; +namespace Microsoft.Teams.Bot.Core; /// /// Client for managing user tokens via HTTP requests. diff --git a/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj b/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj index 5f042c02..dd8df00f 100644 --- a/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj +++ b/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj @@ -13,7 +13,7 @@ - + diff --git a/core/test/ABSTokenServiceClient/Program.cs b/core/test/ABSTokenServiceClient/Program.cs index 9714720a..2cac7461 100644 --- a/core/test/ABSTokenServiceClient/Program.cs +++ b/core/test/ABSTokenServiceClient/Program.cs @@ -3,8 +3,8 @@ using ABSTokenServiceClient; using Microsoft.AspNetCore.Builder; -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Extensions.DependencyInjection; WebApplicationBuilder builder = WebApplication.CreateBuilder(args); diff --git a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs index 4083c69d..2ee9e2c1 100644 --- a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs +++ b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs @@ -1,5 +1,5 @@ using System.Text.Json; -using Microsoft.Bot.Core; +using Microsoft.Teams.Bot.Core; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; diff --git a/core/test/IntegrationTests.slnx b/core/test/IntegrationTests.slnx index cff9a04c..d3811a8d 100644 --- a/core/test/IntegrationTests.slnx +++ b/core/test/IntegrationTests.slnx @@ -1,11 +1,11 @@ - - - + + + - + diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs similarity index 94% rename from core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs rename to core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs index 9996aaa6..293e4198 100644 --- a/core/test/Microsoft.Teams.BotApps.UnitTests/ConversationUpdateActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Handlers; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Teams.BotApps.UnitTests; +namespace Microsoft.Teams.Bot.Apps.UnitTests; public class ConversationUpdateActivityTests { diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs similarity index 86% rename from core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs rename to core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs index 9bb27d58..56f66f1d 100644 --- a/core/test/Microsoft.Teams.BotApps.UnitTests/MessageReactionActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Handlers; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Teams.BotApps.UnitTests; +namespace Microsoft.Teams.Bot.Apps.UnitTests; public class MessageReactionActivityTests { diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/Microsoft.Teams.BotApps.UnitTests.csproj b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/Microsoft.Teams.Bot.Apps.UnitTests.csproj similarity index 86% rename from core/test/Microsoft.Teams.BotApps.UnitTests/Microsoft.Teams.BotApps.UnitTests.csproj rename to core/test/Microsoft.Teams.Bot.Apps.UnitTests/Microsoft.Teams.Bot.Apps.UnitTests.csproj index 0bfc94a1..3c769976 100644 --- a/core/test/Microsoft.Teams.BotApps.UnitTests/Microsoft.Teams.BotApps.UnitTests.csproj +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/Microsoft.Teams.Bot.Apps.UnitTests.csproj @@ -15,7 +15,7 @@ - + diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityBuilderTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs similarity index 99% rename from core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityBuilderTests.cs rename to core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs index e58f9d5f..1964ef5c 100644 --- a/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityBuilderTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Schema; -using Microsoft.Teams.BotApps.Schema.Entities; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.Entities; -namespace Microsoft.Teams.BotApps.UnitTests; +namespace Microsoft.Teams.Bot.Apps.UnitTests; public class TeamsActivityBuilderTests { diff --git a/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs similarity index 98% rename from core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs rename to core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs index ba0b1ebe..f1eae204 100644 --- a/core/test/Microsoft.Teams.BotApps.UnitTests/TeamsActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs @@ -2,11 +2,11 @@ // Licensed under the MIT License. using System.Text.Json.Nodes; -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Schema; -using Microsoft.Teams.BotApps.Schema.Entities; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.Entities; -namespace Microsoft.Teams.BotApps.UnitTests; +namespace Microsoft.Teams.Bot.Apps.UnitTests; public class TeamsActivityTests { diff --git a/core/test/Microsoft.Bot.Core.Compat.UnitTests/CompatActivityTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs similarity index 97% rename from core/test/Microsoft.Bot.Core.Compat.UnitTests/CompatActivityTests.cs rename to core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs index 9da5d6e4..1ebf562e 100644 --- a/core/test/Microsoft.Bot.Core.Compat.UnitTests/CompatActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs @@ -3,10 +3,10 @@ using AdaptiveCards; using Microsoft.Bot.Builder.Teams; -using Microsoft.Bot.Core.Schema; -using Microsoft.Teams.BotApps.Schema; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema; -namespace Microsoft.Bot.Core.Compat.UnitTests +namespace Microsoft.Teams.Bot.Compat.UnitTests { public class CompatActivityTests { diff --git a/core/test/Microsoft.Bot.Core.Compat.UnitTests/Microsoft.Bot.Core.Compat.UnitTests.csproj b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj similarity index 75% rename from core/test/Microsoft.Bot.Core.Compat.UnitTests/Microsoft.Bot.Core.Compat.UnitTests.csproj rename to core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj index 66c3819c..0eb1f233 100644 --- a/core/test/Microsoft.Bot.Core.Compat.UnitTests/Microsoft.Bot.Core.Compat.UnitTests.csproj +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj @@ -15,8 +15,8 @@ - - + + diff --git a/core/test/Microsoft.Bot.Core.Tests/CompatConversationClientTests.cs b/core/test/Microsoft.Teams.Bot.Core.Tests/CompatConversationClientTests.cs similarity index 98% rename from core/test/Microsoft.Bot.Core.Tests/CompatConversationClientTests.cs rename to core/test/Microsoft.Teams.Bot.Core.Tests/CompatConversationClientTests.cs index 6738567c..d78d74f3 100644 --- a/core/test/Microsoft.Bot.Core.Tests/CompatConversationClientTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.Tests/CompatConversationClientTests.cs @@ -3,13 +3,14 @@ using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Builder.Teams; -using Microsoft.Bot.Core.Compat; using Microsoft.Bot.Schema; using Microsoft.Bot.Schema.Teams; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.Teams.Bot.Compat; +using Microsoft.Teams.Bot.Core; namespace Microsoft.Bot.Core.Tests { diff --git a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs b/core/test/Microsoft.Teams.Bot.Core.Tests/ConversationClientTest.cs similarity index 99% rename from core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs rename to core/test/Microsoft.Teams.Bot.Core.Tests/ConversationClientTest.cs index 3ac1e7d4..85a583a6 100644 --- a/core/test/Microsoft.Bot.Core.Tests/ConversationClientTest.cs +++ b/core/test/Microsoft.Teams.Bot.Core.Tests/ConversationClientTest.cs @@ -1,10 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; +using Microsoft.Teams.Bot.Core; namespace Microsoft.Bot.Core.Tests; diff --git a/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj b/core/test/Microsoft.Teams.Bot.Core.Tests/Microsoft.Teams.Bot.Core.Tests.csproj similarity index 87% rename from core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj rename to core/test/Microsoft.Teams.Bot.Core.Tests/Microsoft.Teams.Bot.Core.Tests.csproj index 78e201ed..b7aad5b2 100644 --- a/core/test/Microsoft.Bot.Core.Tests/Microsoft.Bot.Core.Tests.csproj +++ b/core/test/Microsoft.Teams.Bot.Core.Tests/Microsoft.Teams.Bot.Core.Tests.csproj @@ -16,7 +16,7 @@ - + diff --git a/core/test/Microsoft.Bot.Core.Tests/TeamsApiClientTests.cs b/core/test/Microsoft.Teams.Bot.Core.Tests/TeamsApiClientTests.cs similarity index 99% rename from core/test/Microsoft.Bot.Core.Tests/TeamsApiClientTests.cs rename to core/test/Microsoft.Teams.Bot.Core.Tests/TeamsApiClientTests.cs index e7e5b595..4c1663b1 100644 --- a/core/test/Microsoft.Bot.Core.Tests/TeamsApiClientTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.Tests/TeamsApiClientTests.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; -using Microsoft.Teams.BotApps; +using Microsoft.Teams.Bot.Apps; namespace Microsoft.Bot.Core.Tests; diff --git a/core/test/Microsoft.Bot.Core.Tests/readme.md b/core/test/Microsoft.Teams.Bot.Core.Tests/readme.md similarity index 100% rename from core/test/Microsoft.Bot.Core.Tests/readme.md rename to core/test/Microsoft.Teams.Bot.Core.Tests/readme.md diff --git a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs similarity index 99% rename from core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs rename to core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs index 9d5cb09c..9f0dc316 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs @@ -4,13 +4,13 @@ using System.Net; using System.Text; using Microsoft.AspNetCore.Http; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging.Abstractions; using Moq; using Moq.Protected; -namespace Microsoft.Bot.Core.UnitTests; +namespace Microsoft.Teams.Bot.Core.UnitTests; public class BotApplicationTests { diff --git a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs similarity index 98% rename from core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs rename to core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs index 81a57280..212d4927 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/ConversationClientTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs @@ -2,11 +2,11 @@ // Licensed under the MIT License. using System.Net; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; using Moq; using Moq.Protected; -namespace Microsoft.Bot.Core.UnitTests; +namespace Microsoft.Teams.Bot.Core.UnitTests; public class ConversationClientTests { diff --git a/core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/CoreActivityBuilderTests.cs similarity index 99% rename from core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs rename to core/test/Microsoft.Teams.Bot.Core.UnitTests/CoreActivityBuilderTests.cs index 74ca5a64..c3f62fd0 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/CoreActivityBuilderTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/CoreActivityBuilderTests.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Bot.Core.UnitTests; +namespace Microsoft.Teams.Bot.Core.UnitTests; public class CoreActivityBuilderTests { diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs similarity index 98% rename from core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs rename to core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs index 0158d551..d13a72b8 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; -namespace Microsoft.Bot.Core.UnitTests.Hosting; +namespace Microsoft.Teams.Bot.Core.UnitTests.Hosting; public class AddBotApplicationExtensionsTests { diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Microsoft.Teams.Bot.Core.UnitTests.csproj similarity index 88% rename from core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj rename to core/test/Microsoft.Teams.Bot.Core.UnitTests/Microsoft.Teams.Bot.Core.UnitTests.csproj index 09875d75..fbef6c2e 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Microsoft.Bot.Core.UnitTests.csproj +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Microsoft.Teams.Bot.Core.UnitTests.csproj @@ -15,7 +15,7 @@ - + diff --git a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs similarity index 99% rename from core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs rename to core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs index 70c5f402..be9d1fd6 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs @@ -3,12 +3,12 @@ using System.Text; using Microsoft.AspNetCore.Http; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging.Abstractions; using Moq; -namespace Microsoft.Bot.Core.UnitTests; +namespace Microsoft.Teams.Bot.Core.UnitTests; public class MiddlewareTests { diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs similarity index 98% rename from core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs rename to core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs index f8b5ef96..d5d0f3e2 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/ActivityExtensibilityTests.cs @@ -4,9 +4,9 @@ using System.Text; using System.Text.Json.Serialization; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Bot.Core.UnitTests.Schema; +namespace Microsoft.Teams.Bot.Core.UnitTests.Schema; public class ActivityExtensibilityTests { diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/CoreActivityTests.cs similarity index 99% rename from core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs rename to core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/CoreActivityTests.cs index 62dcd151..36835f3b 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/CoreActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Bot.Core.UnitTests.Schema; +namespace Microsoft.Teams.Bot.Core.UnitTests.Schema; public class CoreCoreActivityTests { diff --git a/core/test/Microsoft.Bot.Core.UnitTests/Schema/EntitiesTest.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/EntitiesTest.cs similarity index 97% rename from core/test/Microsoft.Bot.Core.UnitTests/Schema/EntitiesTest.cs rename to core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/EntitiesTest.cs index 9eeac0f6..480ec83a 100644 --- a/core/test/Microsoft.Bot.Core.UnitTests/Schema/EntitiesTest.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/EntitiesTest.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using System.Text.Json.Nodes; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Bot.Core.UnitTests.Schema; +namespace Microsoft.Teams.Bot.Core.UnitTests.Schema; public class EntitiesTest { diff --git a/core/test/aot-checks/Program.cs b/core/test/aot-checks/Program.cs index 31b88d79..345f33d9 100644 --- a/core/test/aot-checks/Program.cs +++ b/core/test/aot-checks/Program.cs @@ -1,4 +1,4 @@ -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core.Schema; CoreActivity coreActivity = CoreActivity.FromJsonString(SampleActivities.TeamsMessage); diff --git a/core/test/aot-checks/aot-checks.csproj b/core/test/aot-checks/aot-checks.csproj index ead30dbb..b69654e0 100644 --- a/core/test/aot-checks/aot-checks.csproj +++ b/core/test/aot-checks/aot-checks.csproj @@ -1,7 +1,7 @@  - + diff --git a/core/test/msal-config-api/Program.cs b/core/test/msal-config-api/Program.cs index 3d74d6bc..18bd340a 100644 --- a/core/test/msal-config-api/Program.cs +++ b/core/test/msal-config-api/Program.cs @@ -1,9 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Bot.Core; -using Microsoft.Bot.Core.Hosting; -using Microsoft.Bot.Core.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; diff --git a/core/test/msal-config-api/msal-config-api.csproj b/core/test/msal-config-api/msal-config-api.csproj index f84df78e..9907a3f8 100644 --- a/core/test/msal-config-api/msal-config-api.csproj +++ b/core/test/msal-config-api/msal-config-api.csproj @@ -10,7 +10,7 @@ - + From a6e82129c45a97a6f83151a2449cc02cef65fd3a Mon Sep 17 00:00:00 2001 From: Rido Date: Fri, 16 Jan 2026 00:26:38 +0000 Subject: [PATCH 37/69] Set IsPackable property to false in ABSTokenServiceClient project --- core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj | 1 + 1 file changed, 1 insertion(+) diff --git a/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj b/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj index dd8df00f..f0e2c1c8 100644 --- a/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj +++ b/core/test/ABSTokenServiceClient/ABSTokenServiceClient.csproj @@ -5,6 +5,7 @@ net10.0 enable enable + false From b136884a8c2b858d79dfafe6c7c8879537f082e9 Mon Sep 17 00:00:00 2001 From: Rido Date: Tue, 20 Jan 2026 10:38:01 -0800 Subject: [PATCH 38/69] Fix Invoke Response (#268) Reorganize and clean up using directives across the codebase for consistency. In CompatBotAdapter, add indented JSON logging for InvokeResponse bodies, set HTTP status code from InvokeResponse.Status, and serialize only the response body. Update EchoBot to return an object for InvokeResponse body instead of a plain string. No core logic changes; improves maintainability and debugging. --- core/samples/CompatBot/EchoBot.cs | 2 +- core/src/Microsoft.Teams.Bot.Apps/Context.cs | 2 +- .../Handlers/ConversationUpdateHandler.cs | 2 +- .../src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs | 2 +- .../Schema/TeamsActivityBuilder.cs | 2 +- .../Schema/TeamsActivityJsonContext.cs | 2 +- .../Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs | 2 +- core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs | 3 +-- .../TeamsBotApplication.HostingExtensions.cs | 2 +- core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs | 2 +- .../TeamsBotApplicationBuilder.cs | 4 ++-- core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs | 3 +-- core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs | 4 ++-- .../CompatAdapterMiddleware.cs | 2 +- core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs | 9 +++++++-- .../Microsoft.Teams.Bot.Compat/CompatConversations.cs | 4 ++-- core/src/Microsoft.Teams.Bot.Core/BotApplication.cs | 2 +- core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs | 2 +- .../Hosting/BotAuthenticationHandler.cs | 3 +-- core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs | 2 +- core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs | 4 ++-- 21 files changed, 31 insertions(+), 29 deletions(-) diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 7c594e9a..7760a35d 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -100,7 +100,7 @@ protected override async Task OnInvokeActivityAsync(ITurnContext return new InvokeResponse { Status = 200, - Body = "invokes from compat bot" + Body = new { value = "invokes from compat bot" } }; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Context.cs b/core/src/Microsoft.Teams.Bot.Apps/Context.cs index 303ceaef..0285ac94 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Context.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Context.cs @@ -1,8 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core; namespace Microsoft.Teams.Bot.Apps; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs index e4aa68ae..dd1105cb 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs @@ -2,8 +2,8 @@ // Licensed under the MIT License. using System.Text.Json; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Handlers; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs index aea2a97c..6346d8e4 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs @@ -4,8 +4,8 @@ using System.Text.Json; using System.Text.Json.Serialization; using System.Text.Json.Serialization.Metadata; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema.Entities; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs index aed75764..b7853132 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs @@ -1,8 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema.Entities; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs index 229a59eb..ef201d16 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs @@ -2,8 +2,8 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema.Entities; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema; diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs index 837a3f69..5fae8608 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs @@ -2,8 +2,8 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps; diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs index 608654e5..2204127c 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs @@ -2,10 +2,9 @@ // Licensed under the MIT License. using System.Text.Json; -using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Core.Http; using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Extensions.Logging; namespace Microsoft.Teams.Bot.Apps; diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs index f11b2cf2..db2b52c2 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; +using Microsoft.Teams.Bot.Core.Hosting; namespace Microsoft.Teams.Bot.Apps; diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 6ce733cf..2606b29b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -2,11 +2,11 @@ // Licensed under the MIT License. using Microsoft.AspNetCore.Http; -using Microsoft.Teams.Bot.Core; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core; namespace Microsoft.Teams.Bot.Apps; diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs index 5b9d6966..3d5b79ca 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs @@ -3,11 +3,11 @@ using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; -using Microsoft.Teams.Bot.Core; -using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; namespace Microsoft.Teams.Bot.Apps; diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs index fbee125d..a1968a7c 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs @@ -2,11 +2,10 @@ // Licensed under the MIT License. using System.Text; - using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core.Schema; using Newtonsoft.Json; namespace Microsoft.Teams.Bot.Compat; diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index 5c93d33c..a02a99c0 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -4,10 +4,10 @@ using Microsoft.AspNetCore.Http; using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; -using Microsoft.Teams.Bot.Core; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Compat; diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs index f999302a..e270b64d 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using Microsoft.Bot.Builder; +using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Teams.Bot.Apps; namespace Microsoft.Teams.Bot.Compat; diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs index b829ae62..75a82b75 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs @@ -1,12 +1,13 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Text.Json; using Microsoft.AspNetCore.Http; using Microsoft.Bot.Builder; using Microsoft.Bot.Schema; using Microsoft.Extensions.Logging; -using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Core; using Newtonsoft.Json; @@ -25,6 +26,8 @@ namespace Microsoft.Teams.Bot.Compat; [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class CompatBotAdapter(TeamsBotApplication botApplication, IHttpContextAccessor httpContextAccessor = default!, ILogger logger = default!) : BotAdapter { + private readonly JsonSerializerOptions _writeIndentedJsonOptions = new() { WriteIndented = true }; + /// /// Deletes an activity from the conversation. /// @@ -99,9 +102,11 @@ private void WriteInvokeResponseToHttpResponse(InvokeResponse? invokeResponse) HttpResponse? response = httpContextAccessor?.HttpContext?.Response; if (response is not null && !response.HasStarted) { + response.StatusCode = invokeResponse.Status; using StreamWriter httpResponseStreamWriter = new(response.BodyWriter.AsStream()); using JsonTextWriter httpResponseJsonWriter = new(httpResponseStreamWriter); - Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(httpResponseJsonWriter, invokeResponse); + logger.LogTrace("Sending Invoke Response: \n {InvokeResponse} \n", System.Text.Json.JsonSerializer.Serialize(invokeResponse.Body, _writeIndentedJsonOptions)); + Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(httpResponseJsonWriter, invokeResponse.Body); } else { diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs index 3ad938d9..b22b1365 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs @@ -2,10 +2,10 @@ // Licensed under the MIT License. using Microsoft.Bot.Connector; -using Microsoft.Teams.Bot.Core; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Rest; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; // TODO: Figure out what to do with Agentic Identities. They're all "nulls" here right now. // The identity is dependent on the incoming payload or supplied in for proactive scenarios. diff --git a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index fbf7ca81..2ac1428d 100644 --- a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using Microsoft.AspNetCore.Http; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Core; diff --git a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs index d4e3d217..b7e57eeb 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using System.Text.Json; +using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Core.Http; using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Extensions.Logging; namespace Microsoft.Teams.Bot.Core; diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs index 5cb65517..b46ad5e3 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -2,12 +2,11 @@ // Licensed under the MIT License. using System.Net.Http.Headers; - -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; using Microsoft.Identity.Web; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Core.Hosting; diff --git a/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs b/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs index 03532835..bcfb61c4 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs @@ -7,8 +7,8 @@ using System.Text; using System.Text.Json; using Microsoft.AspNetCore.WebUtilities; -using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Extensions.Logging; +using Microsoft.Teams.Bot.Core.Hosting; namespace Microsoft.Teams.Bot.Core.Http; /// diff --git a/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs index c3d5c85e..43e9b61c 100644 --- a/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs @@ -3,10 +3,10 @@ using System.Text; using System.Text.Json; -using Microsoft.Teams.Bot.Core.Http; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; +using Microsoft.Teams.Bot.Core.Http; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Core; From 547ad4ded5d169d6b1655c9561c8b93260fcc795 Mon Sep 17 00:00:00 2001 From: Rido Date: Tue, 20 Jan 2026 15:01:42 -0800 Subject: [PATCH 39/69] Review XML comments in Public APIs (#271) This pull request improves code documentation throughout the Teams Bot Core and Compat libraries by enhancing XML doc comments for public classes, methods, and delegates. The changes clarify parameter purposes, return values, and overall behavior, making the codebase easier to understand and maintain for future developers. **Handler and Delegate Documentation Enhancements:** - Clarified XML documentation for handler delegates and argument classes in `ConversationUpdateHandler`, `InstallationUpdateHandler`, and `MessageReactionHandler`, specifying when handlers are invoked and detailing parameter and return value meanings. [[1]](diffhunk://#diff-520cbb31ec22b8f40b880f8c77056df61219382f41d4289fcf134ad376a477deL11-R22) [[2]](diffhunk://#diff-6a0ee37c3ed365cc18112bb823e064a58701192a6e6ddc95865cbd699b222826L9-R20) [[3]](diffhunk://#diff-f30f2a2f8907b41aea7962bdc2c935a725bf979ef8b99bc70379ed812e7dfcfeL11-R22) **Schema Entity Documentation Improvements:** - Expanded and clarified doc comments for methods and constructors in `ClientInfoEntity` and `MentionEntity`, explaining their purpose, parameter details, and return values. [[1]](diffhunk://#diff-41817d17ebfa1173983b9643204188f79cb2d675826bbdc28a385c5b42abd0b8L15-R22) [[2]](diffhunk://#diff-41817d17ebfa1173983b9643204188f79cb2d675826bbdc28a385c5b42abd0b8L35-R38) [[3]](diffhunk://#diff-41817d17ebfa1173983b9643204188f79cb2d675826bbdc28a385c5b42abd0b8L67-R72) [[4]](diffhunk://#diff-d2747143a751ee3809c1a3fe862ce6cec756f4ef1a94d1d91e9a4d63a70ef819L32-R38) [[5]](diffhunk://#diff-d2747143a751ee3809c1a3fe862ce6cec756f4ef1a94d1d91e9a4d63a70ef819L70-R71) **Compat Layer Documentation Updates:** - Added or improved XML documentation for key methods in `CompatAdapter`, `CompatBotAdapter`, and `CompatAdapterMiddleware`, including parameter requirements, operation descriptions, and return value details. [[1]](diffhunk://#diff-e6d701ce121dda6651c0dea00498d45e2cc0b0cec446a578f3058be691c7c0f5L57-R61) [[2]](diffhunk://#diff-c443812ac75b10f0cb9e0929a1165dee72b7c96adbd232d830a65348ccd1b42bL23-R34) [[3]](diffhunk://#diff-c443812ac75b10f0cb9e0929a1165dee72b7c96adbd232d830a65348ccd1b42bL43-R50) [[4]](diffhunk://#diff-c443812ac75b10f0cb9e0929a1165dee72b7c96adbd232d830a65348ccd1b42bL81-R91) [[5]](diffhunk://#diff-80a974c881b9ff3a697fe5b07985c8f55edb2e2896384d6d437a3e8dfa5a2817R11-R30) - Introduced a comprehensive class-level summary for `CompatConnectorClient`, clarifying its purpose as a stub for Bot Framework compatibility. **Invoke Response Documentation:** - Enhanced the summary and remarks for `CoreInvokeResponse` to clarify its role and typical usage in Adaptive Card and task module scenarios. --------- Co-authored-by: Claude Sonnet 4.5 --- .../Handlers/ConversationUpdateHandler.cs | 14 ++-- .../Handlers/InstallationUpdateHandler.cs | 15 ++-- .../Handlers/InvokeHandler.cs | 10 ++- .../Handlers/MessageReactionHandler.cs | 15 ++-- .../Schema/Entities/ClientInfoEntity.cs | 30 ++++---- .../Schema/Entities/MentionEntity.cs | 16 ++-- .../CompatAdapter.cs | 10 +-- .../CompatAdapterMiddleware.cs | 18 +++++ .../CompatBotAdapter.cs | 33 ++++---- .../CompatConnectorClient.cs | 13 ++++ .../CompatConversations.cs | 70 ++++++++++++++++- .../CompatUserTokenClient.cs | 77 +++++++++++++++++++ .../ConversationClient.cs | 21 +++-- .../Hosting/BotConfig.cs | 58 +++++++++++++- .../TurnMiddleware.cs | 33 ++++++++ .../UserTokenClient.cs | 24 +++--- 16 files changed, 370 insertions(+), 87 deletions(-) diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs index dd1105cb..97351a2b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs @@ -8,18 +8,18 @@ namespace Microsoft.Teams.Bot.Apps.Handlers; /// -/// Delegate for handling conversation update activities. +/// Delegate for handling conversation update activities when members are added or removed from a conversation. /// -/// -/// -/// -/// +/// The conversation update arguments containing member changes and activity details. +/// The turn context for sending responses and accessing conversation information. +/// A cancellation token that can be used to cancel the asynchronous operation. +/// A task that represents the asynchronous handler operation. public delegate Task ConversationUpdateHandler(ConversationUpdateArgs conversationUpdateActivity, Context context, CancellationToken cancellationToken = default); /// -/// Conversation update activity arguments. +/// Provides arguments for conversation update activities including members added and removed. /// -/// +/// The Teams activity containing the conversation update information. [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] public class ConversationUpdateArgs(TeamsActivity act) { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs index fc139713..35246f06 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs @@ -6,19 +6,18 @@ namespace Microsoft.Teams.Bot.Apps.Handlers; /// -/// Delegate for handling installation update activities. +/// Delegate for handling installation update activities when the bot is installed or uninstalled in a Teams scope. /// -/// -/// -/// -/// +/// The installation update arguments containing action details (add/remove) and selected channel information. +/// The turn context for sending responses and accessing conversation information. +/// A cancellation token that can be used to cancel the asynchronous operation. +/// A task that represents the asynchronous handler operation. public delegate Task InstallationUpdateHandler(InstallationUpdateArgs installationUpdateActivity, Context context, CancellationToken cancellationToken = default); - /// -/// Installation update activity arguments. +/// Provides arguments for installation update activities including installation action and selected channel. /// -/// +/// The Teams activity containing the installation update information. public class InstallationUpdateArgs(TeamsActivity act) { /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs index de737771..bddb3796 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs @@ -18,13 +18,15 @@ namespace Microsoft.Teams.Bot.Apps.Handlers; /// -/// Represents the response returned from an invocation handler. +/// Represents the response returned from an invocation handler, typically used for Adaptive Card actions and task module operations. /// /// -/// Creates a new instance of the class with the specified status code and optional body. +/// This class encapsulates the HTTP-style response sent back to Teams when handling invoke activities. +/// Common status codes include 200 for success, 400 for bad request, and 500 for errors. +/// The Body property contains the response payload, which is serialized to JSON and returned to the client. /// -/// -/// +/// The HTTP status code indicating the result of the invoke operation (e.g., 200 for success). +/// Optional response payload that will be serialized and sent to the client. public class CoreInvokeResponse(int status, object? body = null) { /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs index 2e55d26e..e45b6428 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs @@ -8,19 +8,18 @@ namespace Microsoft.Teams.Bot.Apps.Handlers; /// -/// Delegate for handling message reaction activities. +/// Delegate for handling message reaction activities when users add or remove emoji reactions to bot messages. /// -/// -/// -/// -/// +/// The message reaction arguments containing reactions added and removed. +/// The turn context for sending responses and accessing conversation information. +/// A cancellation token that can be used to cancel the asynchronous operation. +/// A task that represents the asynchronous handler operation. public delegate Task MessageReactionHandler(MessageReactionArgs reactionActivity, Context context, CancellationToken cancellationToken = default); - /// -/// Message reaction activity arguments. +/// Provides arguments for message reaction activities including reactions added and removed. /// -/// +/// The Teams activity containing the message reaction information. [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] public class MessageReactionArgs(TeamsActivity act) { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs index 8e76775d..57d0b856 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs @@ -12,14 +12,14 @@ namespace Microsoft.Teams.Bot.Apps.Schema.Entities; public static class ActivityClientInfoExtensions { /// - /// Adds a client info to the activity. + /// Adds client information to the activity's entity collection. /// - /// - /// - /// - /// - /// - /// + /// The activity to add client information to. Cannot be null. + /// The platform identifier (e.g., "web", "desktop", "mobile"). + /// The country code (e.g., "US", "GB"). + /// The time zone identifier (e.g., "America/New_York"). + /// The locale identifier (e.g., "en-US", "fr-FR"). + /// The created ClientInfoEntity that was added to the activity. public static ClientInfoEntity AddClientInfo(this TeamsActivity activity, string platform, string country, string timeZone, string locale) { ArgumentNullException.ThrowIfNull(activity); @@ -32,10 +32,10 @@ public static ClientInfoEntity AddClientInfo(this TeamsActivity activity, string } /// - /// Gets the client info from the activity's entities. + /// Retrieves the client information entity from the activity's entity collection. /// - /// - /// + /// The activity to extract client information from. Cannot be null. + /// The ClientInfoEntity if found in the activity's entities; otherwise, null. public static ClientInfoEntity? GetClientInfo(this TeamsActivity activity) { ArgumentNullException.ThrowIfNull(activity); @@ -64,12 +64,12 @@ public ClientInfoEntity() : base("clientInfo") /// - /// Initializes a new instance of the class with specified parameters. + /// Initializes a new instance of the class with specified client information. /// - /// - /// - /// - /// + /// The platform identifier (e.g., "web", "desktop", "mobile"). + /// The country code (e.g., "US", "GB"). + /// The time zone identifier (e.g., "America/New_York"). + /// The locale identifier (e.g., "en-US", "fr-FR"). public ClientInfoEntity(string platform, string country, string timezone, string locale) : base("clientInfo") { Locale = locale; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs index 3227cd43..65ce17db 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs @@ -29,13 +29,13 @@ public static IEnumerable GetMentions(this TeamsActivity activity } /// - /// Adds a mention to the activity. + /// Adds a mention (@ mention) of a user or bot to the activity. /// - /// - /// - /// - /// - /// + /// The activity to add the mention to. Cannot be null. + /// The conversation account being mentioned. Cannot be null. + /// Optional custom text for the mention. If null, uses the account name. + /// If true, prepends the mention text to the activity's existing text content. Defaults to true. + /// The created MentionEntity that was added to the activity. public static MentionEntity AddMention(this TeamsActivity activity, ConversationAccount account, string? text = null, bool addText = true) { ArgumentNullException.ThrowIfNull(activity); @@ -67,8 +67,8 @@ public MentionEntity() : base("mention") { } /// /// Creates a new instance of with the specified mentioned account and text. /// - /// - /// + /// The conversation account being mentioned. + /// The text representation of the mention, typically formatted as "<at>name</at>". public MentionEntity(ConversationAccount mentioned, string? text) : base("mention") { Mentioned = mentioned; diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index a02a99c0..656a0206 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -54,11 +54,11 @@ public CompatAdapter Use(Microsoft.Bot.Builder.IMiddleware middleware) /// /// Processes an incoming HTTP request and generates an appropriate HTTP response using the provided bot instance. /// - /// - /// - /// - /// - /// + /// The incoming HTTP request containing the bot activity. Cannot be null. + /// The HTTP response to write results to. Cannot be null. + /// The bot instance that will process the activity. Cannot be null. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// A task that represents the asynchronous processing operation. public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpResponse, IBot bot, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(httpRequest); diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs index e270b64d..463d8dc8 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs @@ -8,8 +8,26 @@ namespace Microsoft.Teams.Bot.Compat; +/// +/// Adapts Bot Framework SDK middleware to work with the Teams Bot Core middleware pipeline. +/// +/// +/// This adapter enables legacy Bot Framework middleware components to be used in the new Teams Bot Core architecture. +/// It converts CoreActivity instances to Bot Framework Activity format, creates appropriate turn contexts with +/// compatibility clients (UserTokenClient and ConnectorClient), and delegates processing to the Bot Framework middleware. +/// This allows gradual migration from Bot Framework SDK to Teams Bot Core while preserving existing middleware investments. +/// +/// The Bot Framework middleware component to adapt into the Teams Bot Core pipeline. internal sealed class CompatAdapterMiddleware(IMiddleware bfMiddleWare) : ITurnMiddleWare { + /// + /// Processes a turn by converting the CoreActivity to Bot Framework format and invoking the wrapped middleware. + /// + /// The bot application processing the turn. Must be a TeamsBotApplication instance. + /// The activity to process in Core format. + /// A delegate to invoke the next middleware in the pipeline. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// A task that represents the asynchronous operation. public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) { diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs index 75a82b75..706bf423 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs @@ -21,8 +21,8 @@ namespace Microsoft.Teams.Bot.Compat; /// This class is intended for scenarios where integration with non-standard bot runtimes or legacy systems is /// required. /// The bot application instance used to process and send activities within the adapter. -/// The HTTP context accessor used to retrieve the current HTTP context. -/// The +/// The HTTP context accessor used to retrieve the current HTTP context for writing invoke responses. +/// The logger instance for recording adapter operations and diagnostics. [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class CompatBotAdapter(TeamsBotApplication botApplication, IHttpContextAccessor httpContextAccessor = default!, ILogger logger = default!) : BotAdapter { @@ -31,9 +31,10 @@ public class CompatBotAdapter(TeamsBotApplication botApplication, IHttpContextAc /// /// Deletes an activity from the conversation. /// - /// - /// - /// + /// The turn context containing the activity information. Cannot be null. + /// The conversation reference identifying the activity to delete. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// A task that represents the asynchronous delete operation. public override async Task DeleteActivityAsync(ITurnContext turnContext, ConversationReference reference, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(turnContext); @@ -43,10 +44,13 @@ public override async Task DeleteActivityAsync(ITurnContext turnContext, Convers /// /// Sends a set of activities to the conversation. /// - /// - /// - /// - /// + /// The turn context for the conversation. Cannot be null. + /// An array of activities to send. Cannot be null. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains an array of + /// objects with the IDs of the sent activities. + /// public override async Task SendActivitiesAsync(ITurnContext turnContext, Activity[] activities, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(activities); @@ -81,10 +85,13 @@ public override async Task SendActivitiesAsync(ITurnContext /// /// Updates an existing activity in the conversation. /// - /// - /// - /// - /// ResourceResponse + /// The turn context for the conversation. + /// The activity with updated content. Cannot be null. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains a + /// with the ID of the updated activity. + /// public override async Task UpdateActivityAsync(ITurnContext turnContext, Activity activity, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(activity); diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatConnectorClient.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatConnectorClient.cs index 4e8fb883..2fe50811 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatConnectorClient.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatConnectorClient.cs @@ -7,8 +7,21 @@ namespace Microsoft.Teams.Bot.Compat { + /// + /// Provides a stub implementation of for compatibility with Bot Framework SDK. + /// + /// + /// This class serves as a minimal adapter to satisfy Bot Framework's requirement for an IConnectorClient instance. + /// Only the property is implemented; all other members throw . + /// This design allows legacy bots to access conversation operations through the CompatConversations adapter without + /// requiring full implementation of unused connector client features. + /// + /// The conversations adapter that handles conversation-related operations. internal sealed class CompatConnectorClient(CompatConversations conversations) : IConnectorClient { + /// + /// Gets the conversations interface for managing bot conversations. + /// public IConversations Conversations => conversations; public Uri BaseUri { get => throw new NotImplementedException(); set => throw new NotImplementedException(); } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs index b22b1365..5bf76b59 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs @@ -11,11 +11,37 @@ // The identity is dependent on the incoming payload or supplied in for proactive scenarios. namespace Microsoft.Teams.Bot.Compat { + /// + /// Provides a compatibility adapter that bridges the Teams Bot Core to the + /// Bot Framework's interface. + /// + /// + /// This adapter enables legacy Bot Framework bots to use the new Teams Bot Core conversation management + /// without code changes. It converts between Bot Framework and Core activity formats, handles HTTP operation + /// responses, and manages custom header translations. All operations delegate to the underlying Core ConversationClient. + /// + /// The underlying Teams Bot Core ConversationClient that performs the actual conversation operations. internal sealed class CompatConversations(ConversationClient client) : IConversations { private readonly ConversationClient _client = client; + + /// + /// Gets or sets the service URL for the bot service endpoint. + /// This URL is used for all conversation operations and must be set before making API calls. + /// internal string? ServiceUrl { get; set; } + /// + /// Creates a new conversation with the specified parameters. + /// + /// The conversation parameters including members and activity. Cannot be null. + /// Optional custom HTTP headers to include in the request. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains an HTTP operation response with + /// a containing the conversation ID, activity ID, and service URL. + /// + /// Thrown when is null or whitespace. public async Task> CreateConversationWithHttpMessagesAsync( Microsoft.Bot.Schema.ConversationParameters parameters, Dictionary>? customHeaders = null, @@ -50,7 +76,15 @@ public async Task> CreateCon }; } - + /// + /// Deletes an existing activity from a conversation. + /// + /// The unique identifier of the conversation. Cannot be null or whitespace. + /// The unique identifier of the activity to delete. Cannot be null or whitespace. + /// Optional custom HTTP headers to include in the request. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// A task that represents the asynchronous operation. The task result contains an HTTP operation response. + /// Thrown when is null or whitespace. public async Task DeleteActivityWithHttpMessagesAsync(string conversationId, string activityId, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); @@ -103,6 +137,17 @@ public async Task>> GetActivityMembe }; } + /// + /// Retrieves the list of members participating in a conversation. + /// + /// The unique identifier of the conversation. Cannot be null or whitespace. + /// Optional custom HTTP headers to include in the request. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains an HTTP operation response with + /// a list of objects representing the conversation members. + /// + /// Thrown when is null or whitespace. public async Task>> GetConversationMembersWithHttpMessagesAsync(string conversationId, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(ServiceUrl); @@ -243,6 +288,17 @@ public async Task> SendConversationHisto }; } + /// + /// Sends an activity to an existing conversation. + /// + /// The unique identifier of the conversation. Cannot be null or whitespace. + /// The activity to send. Cannot be null. + /// Optional custom HTTP headers to include in the request. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains an HTTP operation response with + /// a containing the ID of the sent activity. + /// public async Task> SendToConversationWithHttpMessagesAsync(string conversationId, Activity activity, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { Dictionary? convertedHeaders = ConvertHeaders(customHeaders); @@ -266,6 +322,18 @@ public async Task> SendToConversationWit }; } + /// + /// Updates an existing activity in a conversation. + /// + /// The unique identifier of the conversation. Cannot be null or whitespace. + /// The unique identifier of the activity to update. Cannot be null or whitespace. + /// The updated activity content. Cannot be null. + /// Optional custom HTTP headers to include in the request. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains an HTTP operation response with + /// a containing the ID of the updated activity. + /// public async Task> UpdateActivityWithHttpMessagesAsync(string conversationId, string activityId, Activity activity, Dictionary>? customHeaders = null, CancellationToken cancellationToken = default) { Dictionary? convertedHeaders = ConvertHeaders(customHeaders); diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatUserTokenClient.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatUserTokenClient.cs index f7218156..0dc79277 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatUserTokenClient.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatUserTokenClient.cs @@ -6,8 +6,29 @@ namespace Microsoft.Teams.Bot.Compat; +/// +/// Provides a compatibility layer that adapts the Teams Bot Core to the Bot Framework's +/// interface. +/// +/// +/// This adapter enables legacy Bot Framework bots to use the new Teams Bot Core token management system +/// without code changes. It converts between the two different token result formats and delegates all operations +/// to the underlying Core UserTokenClient. +/// +/// The underlying Teams Bot Core UserTokenClient that performs the actual token operations. internal sealed class CompatUserTokenClient(UserTokenClient utc) : Microsoft.Bot.Connector.Authentication.UserTokenClient { + /// + /// Gets the status of all tokens for a specific user across all configured OAuth connections. + /// + /// The unique identifier of the user. Cannot be null or empty. + /// The channel identifier where the user is interacting. Cannot be null or empty. + /// Optional filter to limit which token statuses are returned. Pass null or empty to include all. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains an array of + /// objects representing the status of each configured connection for the user. + /// public async override Task GetTokenStatusAsync(string userId, string channelId, string includeFilter, CancellationToken cancellationToken) { GetTokenStatusResult[] res = await utc.GetTokenStatusAsync(userId, channelId, includeFilter, cancellationToken).ConfigureAwait(false); @@ -20,6 +41,18 @@ public async override Task GetTokenStatusAsync(string userId, str }).ToArray(); } + /// + /// Retrieves an OAuth token for a user from a specific connection. + /// + /// The unique identifier of the user requesting the token. Cannot be null or empty. + /// The name of the OAuth connection configured in Azure Bot Service. Cannot be null or empty. + /// The channel identifier where the user is interacting. Cannot be null or empty. + /// Optional magic code from the OAuth callback. Used to complete the OAuth flow when provided. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains a with + /// the OAuth token if available, or null if the user has not completed authentication for this connection. + /// public async override Task GetUserTokenAsync(string userId, string connectionName, string channelId, string magicCode, CancellationToken cancellationToken) { GetTokenResult? res = await utc.GetTokenAsync(userId, connectionName, channelId, magicCode, cancellationToken).ConfigureAwait(false); @@ -36,6 +69,18 @@ public async override Task GetTokenStatusAsync(string userId, str }; } + /// + /// Retrieves the sign-in resource (URL and exchange resources) needed to initiate an OAuth flow for a user. + /// + /// The name of the OAuth connection configured in Azure Bot Service. Cannot be null or empty. + /// The activity associated with the sign-in request. Used to extract user and channel information. Cannot be null. + /// Optional URL to redirect the user to after completing authentication. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains a + /// with the sign-in link and optional token exchange or post resources for completing the OAuth flow. + /// + /// Thrown when is null. public async override Task GetSignInResourceAsync(string connectionName, Activity activity, string finalRedirect, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(activity); @@ -66,6 +111,18 @@ public async override Task GetSignInResourceAsync(string connect return signInResource; } + /// + /// Exchanges a token from one OAuth connection for a token from another connection using single sign-on (SSO). + /// + /// The unique identifier of the user whose token is being exchanged. Cannot be null or empty. + /// The name of the target OAuth connection to exchange to. Cannot be null or empty. + /// The channel identifier where the user is interacting. Cannot be null or empty. + /// The token exchange request containing the source token. Cannot be null. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains a + /// with the exchanged token for the target connection. + /// public async override Task ExchangeTokenAsync(string userId, string connectionName, string channelId, TokenExchangeRequest exchangeRequest, CancellationToken cancellationToken) { @@ -79,11 +136,31 @@ public async override Task ExchangeTokenAsync(string userId, stri }; } + /// + /// Signs out a user from a specific OAuth connection, revoking their stored token. + /// + /// The unique identifier of the user to sign out. Cannot be null or empty. + /// The name of the OAuth connection to sign out from. Cannot be null or empty. + /// The channel identifier where the user is interacting. Cannot be null or empty. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// A task that represents the asynchronous sign-out operation. public async override Task SignOutUserAsync(string userId, string connectionName, string channelId, CancellationToken cancellationToken) { await utc.SignOutUserAsync(userId, connectionName, channelId, cancellationToken).ConfigureAwait(false); } + /// + /// Retrieves Azure Active Directory (Azure AD) tokens for multiple resource URLs in a single request. + /// + /// The unique identifier of the user requesting the tokens. Cannot be null or empty. + /// The name of the OAuth connection configured for Azure AD. Cannot be null or empty. + /// An array of resource URLs (e.g., "https://graph.microsoft.com") to request tokens for. Cannot be null. + /// The channel identifier where the user is interacting. Cannot be null or empty. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// + /// A task that represents the asynchronous operation. The task result contains a dictionary mapping each + /// resource URL to its corresponding . Returns an empty dictionary if no tokens are available. + /// public async override Task> GetAadTokensAsync(string userId, string connectionName, string[] resourceUrls, string channelId, CancellationToken cancellationToken) { IDictionary res = await utc.GetAadTokensAsync(userId, connectionName, channelId, resourceUrls, cancellationToken).ConfigureAwait(false); diff --git a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs index b7e57eeb..bf89a24e 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs @@ -178,15 +178,20 @@ public async Task> GetConversationMembersAsync(string /// - /// Gets a specific member of a conversation. + /// Gets a specific member of a conversation with strongly-typed result. /// - /// - /// - /// - /// - /// - /// - /// + /// The type of conversation account to return. Must inherit from . + /// The ID of the conversation. Cannot be null or whitespace. + /// The ID of the user to retrieve. Cannot be null or whitespace. + /// The service URL for the conversation. Cannot be null. + /// Optional agentic identity for authentication. + /// Optional custom headers to include in the request. + /// A cancellation token that can be used to cancel the operation. + /// + /// A task that represents the asynchronous operation. The task result contains the conversation member + /// of type T with detailed information about the user. + /// + /// Thrown if the member could not be retrieved successfully. public async Task GetConversationMemberAsync(string conversationId, string userId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) where T : ConversationAccount { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs index dddfe836..16885dc4 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs @@ -5,16 +5,51 @@ namespace Microsoft.Teams.Bot.Core.Hosting; - +/// +/// Configuration model for bot authentication credentials. +/// +/// +/// This class consolidates bot authentication settings from various configuration sources including +/// Bot Framework SDK configuration, Core configuration, and Azure AD configuration sections. +/// It supports multiple authentication modes: client secrets, system-assigned managed identities, +/// user-assigned managed identities, and federated identity credentials (FIC). +/// internal sealed class BotConfig { + /// + /// Identifier used to specify system-assigned managed identity authentication. + /// When FicClientId equals this value, the system will use the system-assigned managed identity. + /// public const string SystemManagedIdentityIdentifier = "system"; + /// + /// Gets or sets the Azure AD tenant ID. + /// public string TenantId { get; set; } = string.Empty; + + /// + /// Gets or sets the application (client) ID from Azure AD app registration. + /// public string ClientId { get; set; } = string.Empty; + + /// + /// Gets or sets the client secret for client credentials authentication. + /// Optional if using managed identity or federated identity credentials. + /// public string? ClientSecret { get; set; } + + /// + /// Gets or sets the client ID for federated identity credentials or user-assigned managed identity. + /// Use to specify system-assigned managed identity. + /// public string? FicClientId { get; set; } + /// + /// Creates a BotConfig from Bot Framework SDK configuration format. + /// + /// Configuration containing MicrosoftAppId, MicrosoftAppPassword, and MicrosoftAppTenantId settings. + /// A new BotConfig instance with settings from Bot Framework configuration. + /// Thrown when is null. public static BotConfig FromBFConfig(IConfiguration configuration) { ArgumentNullException.ThrowIfNull(configuration); @@ -26,6 +61,16 @@ public static BotConfig FromBFConfig(IConfiguration configuration) }; } + /// + /// Creates a BotConfig from Teams Bot Core environment variable format. + /// + /// Configuration containing TENANT_ID, CLIENT_ID, CLIENT_SECRET, and MANAGED_IDENTITY_CLIENT_ID settings. + /// A new BotConfig instance with settings from Core configuration. + /// Thrown when is null. + /// + /// This format is typically used with environment variables in containerized deployments. + /// The MANAGED_IDENTITY_CLIENT_ID can be set to "system" for system-assigned managed identity. + /// public static BotConfig FromCoreConfig(IConfiguration configuration) { ArgumentNullException.ThrowIfNull(configuration); @@ -38,6 +83,17 @@ public static BotConfig FromCoreConfig(IConfiguration configuration) }; } + /// + /// Creates a BotConfig from Azure AD configuration section format. + /// + /// Configuration containing an Azure AD configuration section. + /// The name of the configuration section containing Azure AD settings. Defaults to "AzureAd". + /// A new BotConfig instance with settings from the Azure AD configuration section. + /// Thrown when is null. + /// + /// This format is compatible with Microsoft.Identity.Web configuration sections in appsettings.json. + /// The section should contain TenantId, ClientId, and optionally ClientSecret properties. + /// public static BotConfig FromAadConfig(IConfiguration configuration, string sectionName = "AzureAd") { ArgumentNullException.ThrowIfNull(configuration); diff --git a/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs b/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs index e0101a07..7d848350 100644 --- a/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs +++ b/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs @@ -6,20 +6,53 @@ namespace Microsoft.Teams.Bot.Core; +/// +/// Manages and executes a middleware pipeline for processing bot turns. +/// +/// +/// This class implements a chain of responsibility pattern where each middleware component can process +/// an activity before passing control to the next middleware in the pipeline. The pipeline executes +/// sequentially, with each middleware having the opportunity to modify the activity, perform side effects, +/// or short-circuit the pipeline. Middleware is executed in the order it was registered via the Use method. +/// internal sealed class TurnMiddleware : ITurnMiddleWare, IEnumerable { private readonly IList _middlewares = []; + + /// + /// Adds a middleware component to the end of the pipeline. + /// + /// The middleware to add. Cannot be null. + /// The current TurnMiddleware instance for method chaining. internal TurnMiddleware Use(ITurnMiddleWare middleware) { _middlewares.Add(middleware); return this; } + + /// + /// Processes a turn by executing the middleware pipeline. + /// + /// The bot application processing the turn. + /// The activity to process. + /// Delegate to invoke the next middleware in the outer pipeline. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous pipeline execution. public async Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn next, CancellationToken cancellationToken = default) { await RunPipelineAsync(botApplication, activity, null!, 0, cancellationToken).ConfigureAwait(false); await next(cancellationToken).ConfigureAwait(false); } + /// + /// Recursively executes the middleware pipeline starting from the specified index. + /// + /// The bot application processing the turn. + /// The activity to process. + /// Optional callback to invoke after all middleware has executed. + /// The index of the next middleware to execute in the pipeline. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous pipeline execution. public Task RunPipelineAsync(BotApplication botApplication, CoreActivity activity, Func? callback, int nextMiddlewareIndex, CancellationToken cancellationToken) { if (nextMiddlewareIndex == _middlewares.Count) diff --git a/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs index 43e9b61c..fe2a3e4b 100644 --- a/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs @@ -11,11 +11,16 @@ namespace Microsoft.Teams.Bot.Core; /// -/// Client for managing user tokens via HTTP requests. +/// Client for managing user tokens via HTTP requests to the Bot Framework Token Service. /// -/// -/// -/// +/// +/// This client provides methods for OAuth token management including retrieving tokens, exchanging tokens, +/// signing out users, and managing AAD tokens. The client communicates with the Bot Framework Token Service +/// API endpoint (defaults to https://token.botframework.com but can be configured via UserTokenApiEndpoint). +/// +/// The HTTP client for making requests to the token service. +/// Configuration containing the UserTokenApiEndpoint setting and other bot configuration. +/// Logger for diagnostic information and request tracking. [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class UserTokenClient(HttpClient httpClient, IConfiguration configuration, ILogger logger) { @@ -177,12 +182,13 @@ public async Task ExchangeTokenAsync(string userId, string conne } /// - /// Signs the user out of a connection. - /// The user ID. - /// The connection name. - /// The channel ID. - /// The cancellation token. + /// Signs the user out of a connection, revoking their OAuth token. /// + /// The unique identifier of the user to sign out. Cannot be null or empty. + /// Optional name of the OAuth connection to sign out from. If null, signs out from all connections. + /// Optional channel identifier. If provided, limits sign-out to tokens for this channel. + /// A cancellation token that can be used to cancel the asynchronous operation. + /// A task that represents the asynchronous sign-out operation. public async Task SignOutUserAsync(string userId, string? connectionName = null, string? channelId = null, CancellationToken cancellationToken = default) { Dictionary queryParams = new() From a86b27468dbd09e35d3a98191a0ca7867fb17e68 Mon Sep 17 00:00:00 2001 From: Kavin <115390646+singhk97@users.noreply.github.com> Date: Wed, 21 Jan 2026 13:04:14 -0500 Subject: [PATCH 40/69] Update `FromCompatActivity` extension to create `CoreActivity` instead (#272) Changed the `FromCompatActivity` extension method to return a `CoreActivity` directly from a `Bot.Schema.Activity` since it's better at handling unknown values (like entities). --- core/core.slnx | 1 + core/samples/CompatBot/EchoBot.cs | 8 ++-- .../Schema/Entities/Entity.cs | 1 + .../CompatActivity.cs | 5 +-- .../CompatActivityTests.cs | 43 ++++++++++++------- .../Schema/EntitiesTest.cs | 23 ++++++++++ 6 files changed, 59 insertions(+), 22 deletions(-) diff --git a/core/core.slnx b/core/core.slnx index f94b02cb..f77ebb4a 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -31,6 +31,7 @@ + diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 7760a35d..6b8da45e 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -128,9 +128,9 @@ private static async Task SendUpdateDeleteActivityAsync(ITurnContext() is string typeString) { + // TODO: Should be able to support unknown types (PA uses BotMessageMetadata). // TODO: Investigate if there is any way for Parent to avoid // Knowing the children. // Maybe a registry pattern, or Converters? diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs index a1968a7c..1ee1304a 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs @@ -32,15 +32,14 @@ public static Activity ToCompatActivity(this CoreActivity activity) /// /// /// - public static TeamsActivity FromCompatActivity(this Activity activity) + public static CoreActivity FromCompatActivity(this Activity activity) { StringBuilder sb = new(); using StringWriter stringWriter = new(sb); using JsonTextWriter json = new(stringWriter); BotMessageHandlerBase.BotMessageSerializer.Serialize(json, activity); string jsonString = sb.ToString(); - CoreActivity coreActivity = CoreActivity.FromJsonString(jsonString); - return TeamsActivity.FromActivity(coreActivity); + return CoreActivity.FromJsonString(jsonString); } diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs index 1ebf562e..31669e5b 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs @@ -2,9 +2,9 @@ // Licensed under the MIT License. using AdaptiveCards; -using Microsoft.Bot.Builder.Teams; +using Microsoft.Bot.Schema; using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Teams.Bot.Apps.Schema; +using Newtonsoft.Json; namespace Microsoft.Teams.Bot.Compat.UnitTests { @@ -13,26 +13,30 @@ public class CompatActivityTests [Fact] public void FromCompatActivity() { - CoreActivity coreActivity = CoreActivity.FromJsonString(compatActivityJson); + Activity botActivity = JsonConvert.DeserializeObject(compatActivityJson)!; + Assert.NotNull(botActivity); + + CoreActivity coreActivity = botActivity.FromCompatActivity(); Assert.NotNull(coreActivity); Assert.NotNull(coreActivity.Attachments); Assert.Single(coreActivity.Attachments); - TeamsActivity teamsActivity = TeamsActivity.FromActivity(coreActivity); - Assert.NotNull(teamsActivity); - Assert.NotNull(teamsActivity.Attachments); - Assert.Single(teamsActivity.Attachments); - var attachment = teamsActivity.Attachments[0]; - Assert.Equal("application/vnd.microsoft.card.adaptive", attachment.ContentType); - var content = attachment.Content; - var card = AdaptiveCard.FromJson(System.Text.Json.JsonSerializer.Serialize(content)).Card; + + var attachmentNode = coreActivity.Attachments[0]; + Assert.NotNull(attachmentNode); + var attachmentObj = attachmentNode.AsObject(); + + var contentType = attachmentObj["contentType"]?.GetValue(); + Assert.Equal("application/vnd.microsoft.card.adaptive", contentType); + + var content = attachmentObj["content"]; + Assert.NotNull(content); + var card = AdaptiveCard.FromJson(content.ToJsonString()).Card; Assert.Equal(2, card.Body.Count); var firstTextBlock = card.Body[0] as AdaptiveTextBlock; Assert.NotNull(firstTextBlock); Assert.Equal("Mention a user by User Principle Name: Hello Rido UPN", firstTextBlock.Text); - } - string compatActivityJson = """ { "type": "message", @@ -96,9 +100,18 @@ public void FromCompatActivity() } } ], - "entities": [], + "entities": [ + { + "type": "https://schema.org/Message", + "@context": "https://schema.org", + "@type": "Message", + "additionalType": [ + "AIGeneratedContent" + ] + }, + ], "replyToId": "f:d1c5de53-9e8b-b5c3-c24d-07c2823079cf" } """; } -} +} \ No newline at end of file diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/EntitiesTest.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/EntitiesTest.cs index 480ec83a..c9d1bf18 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/EntitiesTest.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/EntitiesTest.cs @@ -94,6 +94,29 @@ public void Entity_RoundTrip() Assert.Contains("\"id\": \"user1\"", serialized); Assert.Contains("\"name\": \"User One\"", serialized); Assert.Contains("\"text\": \"\\u003Cat\\u003EUser One\\u003C/at\\u003E\"", serialized); + } + [Fact] + public void Test_Unknown_Entity() + { + string json = """ + { + "type": "message", + "entities": [ + { + "type": "unknownEntityType", + "someProperty": "someValue" + } + ] + } + """; + CoreActivity activity = CoreActivity.FromJsonString(json); + Assert.NotNull(activity); + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + JsonNode? e1 = activity.Entities[0]; + Assert.NotNull(e1); + Assert.Equal("unknownEntityType", e1["type"]?.ToString()); + Assert.Equal("someValue", e1["someProperty"]?.ToString()); } } From ecb8c914d32c203a35d2bc9ecc35398b1d80b435 Mon Sep 17 00:00:00 2001 From: Mehak Bindra Date: Wed, 21 Jan 2026 17:11:17 -0800 Subject: [PATCH 41/69] [TeamsBotApps] Add type safe routing system and typed context (#275) Added a routing system and typed context support enabling type-safe activity handling with pattern matching. **Main changes:** - Added `Route` and `Router` classes for declarative route registration - Added `MessageActivity` class extending `TeamsActivity` with message-specific properties - Updated `Context` to support generic `Context` for type-safe activity handling - Refactored `MessageHandler` to use the new routing system - Removed handler classes (`ConversationUpdateHandler`, `InstallationUpdateHandler`, `MessageReactionHandler`) , will update in future - Updated TeamsBot sample to demonstrate the new routing pattern - Added MessageActivityTests --- core/samples/TeamsBot/Program.cs | 15 +- core/src/Microsoft.Teams.Bot.Apps/Context.cs | 4 +- .../Handlers/ConversationUpdateHandler.cs | 50 --- .../Handlers/InstallationUpdateHandler.cs | 47 --- .../Handlers/InvokeHandler.cs | 3 +- .../Handlers/MessageHandler.cs | 100 ++++-- .../Handlers/MessageReactionHandler.cs | 61 ---- .../Microsoft.Teams.Bot.Apps/Routing/Route.cs | 85 +++++ .../Routing/Router.cs | 67 ++++ .../MessageActivities/MessageActivity.cs | 258 ++++++++++++++++ .../Schema/TeamsActivity.cs | 29 +- .../Schema/TeamsActivityJsonContext.cs | 4 +- ...ccount .cs => TeamsConversationAccount.cs} | 0 .../TeamsBotApplication.cs | 63 +--- .../ConversationUpdateActivityTests.cs | 12 +- .../MessageActivityTests.cs | 292 ++++++++++++++++++ .../MessageReactionActivityTests.cs | 4 +- .../TeamsActivityTests.cs | 16 + 18 files changed, 846 insertions(+), 264 deletions(-) delete mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs delete mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs delete mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs rename core/src/Microsoft.Teams.Bot.Apps/Schema/{TeamsConversationAccount .cs => TeamsConversationAccount.cs} (100%) create mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index e97fd388..4b983d70 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -5,21 +5,20 @@ using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Apps.Schema.Entities; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using TeamsBot; var builder = TeamsBotApplication.CreateBuilder(); var teamsApp = builder.Build(); - - - -teamsApp.OnMessage = async (messageArgs, context, cancellationToken) => +teamsApp.OnMessage(async (context, cancellationToken) => { await context.SendTypingActivityAsync(cancellationToken); - string replyText = $"You sent: `{messageArgs.Text}` in activity of type `{context.Activity.Type}`."; + string replyText = $"You sent: `{context.Activity.Text}` in activity of type `{context.Activity.Type}`."; TeamsActivity reply = TeamsActivity.CreateBuilder() + .WithType(TeamsActivityType.Message) .WithText(replyText) .Build(); @@ -28,13 +27,14 @@ await context.SendActivityAsync(reply, cancellationToken); TeamsActivity feedbackCard = TeamsActivity.CreateBuilder() + .WithType(TeamsActivityType.Message) .WithAttachment(TeamsAttachment.CreateBuilder() .WithAdaptiveCard(Cards.FeedbackCardObj) .Build()) .Build(); await context.SendActivityAsync(feedbackCard, cancellationToken); -}; - +}); +/* teamsApp.OnMessageReaction = async (args, context, cancellationToken) => { string reactionsAdded = string.Join(", ", args.ReactionsAdded?.Select(r => r.Type) ?? []); @@ -79,6 +79,7 @@ // .Build(); // await teamsApp.SendActivityAsync(reply, ct); //}; +*/ teamsApp.Run(); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Context.cs b/core/src/Microsoft.Teams.Bot.Apps/Context.cs index 0285ac94..779d7f6a 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Context.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Context.cs @@ -15,7 +15,7 @@ namespace Microsoft.Teams.Bot.Apps; /// /// /// -public class Context(TeamsBotApplication botApplication, TeamsActivity activity) +public class Context(TeamsBotApplication botApplication, TActivity activity) where TActivity : TeamsActivity { /// /// Base bot application. @@ -25,7 +25,7 @@ public class Context(TeamsBotApplication botApplication, TeamsActivity activity) /// /// Current activity. /// - public TeamsActivity Activity { get; } = activity; + public TActivity Activity { get; } = activity; /// /// Sends a message activity as a reply. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs deleted file mode 100644 index 97351a2b..00000000 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs +++ /dev/null @@ -1,50 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using System.Text.Json; -using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Core.Schema; - -namespace Microsoft.Teams.Bot.Apps.Handlers; - -/// -/// Delegate for handling conversation update activities when members are added or removed from a conversation. -/// -/// The conversation update arguments containing member changes and activity details. -/// The turn context for sending responses and accessing conversation information. -/// A cancellation token that can be used to cancel the asynchronous operation. -/// A task that represents the asynchronous handler operation. -public delegate Task ConversationUpdateHandler(ConversationUpdateArgs conversationUpdateActivity, Context context, CancellationToken cancellationToken = default); - -/// -/// Provides arguments for conversation update activities including members added and removed. -/// -/// The Teams activity containing the conversation update information. -[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] -public class ConversationUpdateArgs(TeamsActivity act) -{ - /// - /// Activity for the conversation update. - /// - public TeamsActivity Activity { get; set; } = act; - - /// - /// Members added to the conversation. - /// - public IList? MembersAdded { get; set; } = - act.Properties.TryGetValue("membersAdded", out object? value) - && value is JsonElement je - && je.ValueKind == JsonValueKind.Array - ? JsonSerializer.Deserialize>(je.GetRawText()) - : null; - - /// - /// Members removed from the conversation. - /// - public IList? MembersRemoved { get; set; } = - act.Properties.TryGetValue("membersRemoved", out object? value2) - && value2 is JsonElement je2 - && je2.ValueKind == JsonValueKind.Array - ? JsonSerializer.Deserialize>(je2.GetRawText()) - : null; -} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs deleted file mode 100644 index 35246f06..00000000 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallationUpdateHandler.cs +++ /dev/null @@ -1,47 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using Microsoft.Teams.Bot.Apps.Schema; - -namespace Microsoft.Teams.Bot.Apps.Handlers; - -/// -/// Delegate for handling installation update activities when the bot is installed or uninstalled in a Teams scope. -/// -/// The installation update arguments containing action details (add/remove) and selected channel information. -/// The turn context for sending responses and accessing conversation information. -/// A cancellation token that can be used to cancel the asynchronous operation. -/// A task that represents the asynchronous handler operation. -public delegate Task InstallationUpdateHandler(InstallationUpdateArgs installationUpdateActivity, Context context, CancellationToken cancellationToken = default); - -/// -/// Provides arguments for installation update activities including installation action and selected channel. -/// -/// The Teams activity containing the installation update information. -public class InstallationUpdateArgs(TeamsActivity act) -{ - /// - /// Activity for the installation update. - /// - public TeamsActivity Activity { get; set; } = act; - - /// - /// Installation action: "add" or "remove". - /// - public string? Action { get; set; } = act.Properties.TryGetValue("action", out object? value) && value is string s ? s : null; - - /// - /// Gets or sets the identifier of the currently selected channel. - /// - public string? SelectedChannelId { get; set; } = act.ChannelData?.Settings?.SelectedChannel?.Id; - - /// - /// Gets a value indicating whether the current action is an add operation. - /// - public bool IsAdd => Action == "add"; - - /// - /// Gets a value indicating whether the current action is a remove operation. - /// - public bool IsRemove => Action == "remove"; -} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs index bddb3796..8fab5d4c 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs @@ -2,6 +2,7 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Apps.Schema; namespace Microsoft.Teams.Bot.Apps.Handlers; @@ -13,7 +14,7 @@ namespace Microsoft.Teams.Bot.Apps.Handlers; /// A cancellation token that can be used to cancel the operation. The default value is . /// A task that represents the asynchronous operation. The task result contains the response to the invocation. -public delegate Task InvokeHandler(Context context, CancellationToken cancellationToken = default); +public delegate Task InvokeHandler(Context context, CancellationToken cancellationToken = default); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs index f8066a9e..5b117b55 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs @@ -1,55 +1,95 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text.Json; -using Microsoft.Teams.Bot.Apps.Schema; +using System.Text.RegularExpressions; +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Handlers; -// TODO: Handlers should just have context instead of args + context. - /// /// Delegate for handling message activities. /// -/// /// /// /// -public delegate Task MessageHandler(MessageArgs messageArgs, Context context, CancellationToken cancellationToken = default); - +public delegate Task MessageHandler(Context context, CancellationToken cancellationToken = default); /// -/// Message activity arguments. +/// Extension methods for registering message activity handlers. /// -/// -public class MessageArgs(TeamsActivity act) +public static class MessageExtensions { /// - /// Activity for the message. + /// Registers a handler for message activities. /// - public TeamsActivity Activity { get; set; } = act; + /// + /// + /// + public static TeamsBotApplication OnMessage(this TeamsBotApplication app, MessageHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + + Name = ActivityType.Message, + Selector = _ => true, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } /// - /// Gets or sets the text content of the message. + /// Registers a handler for message activities matching the specified pattern. /// - public string? Text { get; set; } = - act.Properties.TryGetValue("text", out object? value) - && value is JsonElement je - && je.ValueKind == JsonValueKind.String - ? je.GetString() - : act.Properties.TryGetValue("text", out object? value2) - ? value2?.ToString() - : null; + /// + /// + /// + /// + public static TeamsBotApplication OnMessage(this TeamsBotApplication app, string pattern, MessageHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + var regex = new Regex(pattern); + + app.Router.Register(new Route + { + Name = ActivityType.Message, + Selector = msg => regex.IsMatch(msg.Text ?? ""), + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } /// - /// Gets or sets the text format of the message (e.g., "plain", "markdown", "xml"). + /// Registers a handler for message activities matching the specified regex. /// - public string? TextFormat { get; set; } = - act.Properties.TryGetValue("textFormat", out object? value) - && value is JsonElement je - && je.ValueKind == JsonValueKind.String - ? je.GetString() - : act.Properties.TryGetValue("textFormat", out object? value2) - ? value2?.ToString() - : null; + /// + /// + /// + /// + public static TeamsBotApplication OnMessage(this TeamsBotApplication app, Regex regex, MessageHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = ActivityType.Message, + Selector = msg => regex.IsMatch(msg.Text ?? ""), + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } } + diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs deleted file mode 100644 index e45b6428..00000000 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs +++ /dev/null @@ -1,61 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using System.Text.Json; -using System.Text.Json.Serialization; -using Microsoft.Teams.Bot.Apps.Schema; - -namespace Microsoft.Teams.Bot.Apps.Handlers; - -/// -/// Delegate for handling message reaction activities when users add or remove emoji reactions to bot messages. -/// -/// The message reaction arguments containing reactions added and removed. -/// The turn context for sending responses and accessing conversation information. -/// A cancellation token that can be used to cancel the asynchronous operation. -/// A task that represents the asynchronous handler operation. -public delegate Task MessageReactionHandler(MessageReactionArgs reactionActivity, Context context, CancellationToken cancellationToken = default); - -/// -/// Provides arguments for message reaction activities including reactions added and removed. -/// -/// The Teams activity containing the message reaction information. -[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] -public class MessageReactionArgs(TeamsActivity act) -{ - /// - /// Activity for the message reaction. - /// - public TeamsActivity Activity { get; set; } = act; - - /// - /// Reactions added to the message. - /// - public IList? ReactionsAdded { get; set; } = - act.Properties.TryGetValue("reactionsAdded", out object? value) - && value is JsonElement je - && je.ValueKind == JsonValueKind.Array - ? JsonSerializer.Deserialize>(je.GetRawText()) - : null; - - /// - /// Reactions removed from the message. - /// - public IList? ReactionsRemoved { get; set; } = - act.Properties.TryGetValue("reactionsRemoved", out object? value2) - && value2 is JsonElement je2 - && je2.ValueKind == JsonValueKind.Array - ? JsonSerializer.Deserialize>(je2.GetRawText()) - : null; -} - -/// -/// Message reaction schema. -/// -public class MessageReaction -{ - /// - /// Type of the reaction (e.g., "like", "heart"). - /// - [JsonPropertyName("type")] public string? Type { get; set; } -} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs new file mode 100644 index 00000000..914cc10e --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs @@ -0,0 +1,85 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Schema; + +namespace Microsoft.Teams.Bot.Apps.Routing; + +/// +/// Base class for routes, providing non-generic access to route functionality +/// +public abstract class RouteBase +{ + /// + /// Gets or sets the name of the route + /// + public abstract string Name { get; set; } + + /// + /// Determines if the route matches the given activity + /// + /// + /// + public abstract bool Matches (TeamsActivity activity); + + /// + /// Invokes the route handler if the activity matches the expected type + /// + /// + /// + /// + public abstract Task InvokeRoute(Context ctx, CancellationToken cancellationToken = default); +} + +/// +/// Represents a route for handling Teams activities +/// +public class Route : RouteBase where TActivity : TeamsActivity +{ + private string _name = string.Empty; + + /// + /// Gets or sets the name of the route + /// + public override string Name + { + get => _name; + set => _name = value; + } + + /// + /// Predicate function to determine if this route should handle the activity + /// + public Func Selector { get; set; } = _ => true; + + /// + /// Handler function to process the activity + /// + public Func, CancellationToken, Task> Handler { get; set; } = (_, __) => Task.CompletedTask; + + /// + /// Determines if the route matches the given activity + /// + /// + /// + public override bool Matches(TeamsActivity activity) + { + return activity is TActivity typedActivity && Selector(typedActivity); + } + + /// + /// Invokes the route handler if the activity matches the expected type + /// + /// + /// + /// + public override async Task InvokeRoute(Context ctx, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(ctx); + if (ctx.Activity is TActivity typedActivity) + { + Context typedContext = new(ctx.TeamsBotApplication, typedActivity); + await Handler(typedContext, cancellationToken).ConfigureAwait(false); + } + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs new file mode 100644 index 00000000..1c1aa3a1 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -0,0 +1,67 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Schema; + +namespace Microsoft.Teams.Bot.Apps.Routing; + +/// +/// Router for dispatching Teams activities to registered routes +/// +public class Router +{ + private readonly List _routes = []; + + /// + /// Routes registered in the router. + /// + public IReadOnlyList GetRoutes() => _routes.AsReadOnly(); + + /// + /// Registers a route. Routes are checked in registration order. + /// IMPORTANT: Register specific routes before general catch-all routes. + /// + public Router Register(Route route) where TActivity : TeamsActivity + { + _routes.Add(route); + return this; + } + + /// + /// Selects the first matching route for the given activity. + /// + public Route? Select(TActivity activity) where TActivity : TeamsActivity + { + return _routes + .OfType>() + .FirstOrDefault(r => r.Selector(activity)); + } + + /// + /// Selects all matching routes for the given activity. + /// + public IEnumerable> SelectAll(TActivity activity) where TActivity : TeamsActivity + { + return _routes + .OfType>() + .Where(r => r.Selector(activity)); + } + + /// + /// Dispatches the activity to the first matching route. + /// Routes are checked in registration order. + /// + public async Task DispatchAsync(Context ctx, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(ctx); + // TODO : support multiple routes? + foreach (var route in _routes) + { + if (route.Matches(ctx.Activity)) + { + await route.InvokeRoute(ctx, cancellationToken).ConfigureAwait(false); + return; + } + } + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs new file mode 100644 index 00000000..3a9afe46 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs @@ -0,0 +1,258 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +/// +/// Represents a message activity. +/// +public class MessageActivity : TeamsActivity +{ + + /// + /// Convenience method to create a MessageActivity from a CoreActivity. + /// + /// The CoreActivity to convert. + /// A MessageActivity instance. + public static new MessageActivity FromActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + return new MessageActivity(activity); + } + + /// + /// Deserializes a JSON string into a MessageActivity instance. + /// + /// The JSON string to deserialize. + /// A MessageActivity instance. + public static new MessageActivity FromJsonString(string json) + { + MessageActivity activity = JsonSerializer.Deserialize( + json, TeamsActivityJsonContext.Default.MessageActivity)!; + activity.Rebase(); + return activity; + } + + /// + /// Serializes the MessageActivity to JSON with all message-specific properties. + /// + /// JSON string representation of the MessageActivity + public new string ToJson() + => ToJson(TeamsActivityJsonContext.Default.MessageActivity); + + /// + /// Default constructor. + /// + [JsonConstructor] + public MessageActivity() : base(ActivityType.Message) + { + } + + /// + /// Initializes a new instance of the class with the specified text. + /// + /// The text content of the message. + public MessageActivity(string text) : base(ActivityType.Message) + { + Text = text; + } + + /// + /// Internal constructor to create MessageActivity from CoreActivity. + /// + /// The CoreActivity to convert. + protected MessageActivity(CoreActivity activity) : base(activity) + { + if (activity.Properties.TryGetValue("text", out var text)) + { + Text = text?.ToString(); + } + if (activity.Properties.TryGetValue("speak", out var speak)) + { + Speak = speak?.ToString(); + } + if (activity.Properties.TryGetValue("inputHint", out var inputHint)) + { + InputHint = inputHint?.ToString(); + } + if (activity.Properties.TryGetValue("summary", out var summary)) + { + Summary = summary?.ToString(); + } + if (activity.Properties.TryGetValue("textFormat", out var textFormat)) + { + TextFormat = textFormat?.ToString(); + } + if (activity.Properties.TryGetValue("attachmentLayout", out var attachmentLayout)) + { + AttachmentLayout = attachmentLayout?.ToString(); + } + if (activity.Properties.TryGetValue("importance", out var importance)) + { + Importance = importance?.ToString(); + } + if (activity.Properties.TryGetValue("deliveryMode", out var deliveryMode)) + { + DeliveryMode = deliveryMode?.ToString(); + } + if (activity.Properties.TryGetValue("expiration", out var expiration) && expiration != null) + { + if (DateTime.TryParse(expiration.ToString(), out var expirationDate)) + { + Expiration = expirationDate; + } + } + } + + /// + /// Gets or sets the text content of the message. + /// + [JsonPropertyName("text")] + public string? Text { get; set; } + + /// + /// Gets or sets the SSML speak content of the message. + /// + [JsonPropertyName("speak")] + public string? Speak { get; set; } + + /// + /// Gets or sets the input hint. See for common values. + /// + [JsonPropertyName("inputHint")] + public string? InputHint { get; set; } + + /// + /// Gets or sets the summary of the message. + /// + [JsonPropertyName("summary")] + public string? Summary { get; set; } + + /// + /// Gets or sets the text format. See for common values. + /// + [JsonPropertyName("textFormat")] + public string? TextFormat { get; set; } + + /// + /// Gets or sets the attachment layout. + /// + [JsonPropertyName("attachmentLayout")] + public string? AttachmentLayout { get; set; } + + /// + /// Gets or sets the importance. See for common values. + /// + [JsonPropertyName("importance")] + public string? Importance { get; set; } + + /// + /// Gets or sets the delivery mode. See for common values. + /// + [JsonPropertyName("deliveryMode")] + public string? DeliveryMode { get; set; } + + /// + /// Gets or sets the expiration time of the message. + /// + [JsonPropertyName("expiration")] + public DateTime? Expiration { get; set; } +} + +/// +/// String constants for input hints. +/// +public static class InputHints +{ + /// + /// Accepting input hint. + /// + public const string AcceptingInput = "acceptingInput"; + + /// + /// Ignoring input hint. + /// + public const string IgnoringInput = "ignoringInput"; + + /// + /// Expecting input hint. + /// + public const string ExpectingInput = "expectingInput"; +} + +/// +/// String constants for text formats. +/// +public static class TextFormats +{ + /// + /// Plain text format. + /// + public const string Plain = "plain"; + + /// + /// Markdown text format. + /// + public const string Markdown = "markdown"; + + /// + /// XML text format. + /// + public const string Xml = "xml"; +} + +/// +/// String constants for importance levels. +/// +public static class ImportanceLevels +{ + /// + /// Low importance. + /// + public const string Low = "low"; + + /// + /// Normal importance. + /// + public const string Normal = "normal"; + + /// + /// High importance. + /// + public const string High = "high"; + + /// + /// Urgent importance. + /// + public const string Urgent = "urgent"; +} + +/// +/// String constants for delivery modes. +/// +public static class DeliveryModes +{ + /// + /// Normal delivery mode. + /// + public const string Normal = "normal"; + + /// + /// Notification delivery mode. + /// + public const string Notification = "notification"; + + /// + /// Ephemeral delivery mode. + /// + public const string Ephemeral = "ephemeral"; + + /// + /// Expected replies delivery mode. + /// + public const string ExpectedReplies = "expectReplies"; +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs index 6346d8e4..e2680bd7 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs @@ -5,6 +5,7 @@ using System.Text.Json.Serialization; using System.Text.Json.Serialization.Metadata; using Microsoft.Teams.Bot.Apps.Schema.Entities; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema; @@ -23,7 +24,12 @@ public class TeamsActivity : CoreActivity public static TeamsActivity FromActivity(CoreActivity activity) { ArgumentNullException.ThrowIfNull(activity); - return new(activity); + + return activity.Type switch + { + ActivityType.Message => MessageActivity.FromActivity(activity), + _ => new TeamsActivity(activity) // Fallback to base type + }; } /// @@ -42,6 +48,18 @@ public static TeamsActivity FromActivity(CoreActivity activity) public new string ToJson() => ToJson(TeamsActivityJsonContext.Default.TeamsActivity); + /// + /// Constructor with type parameter. + /// + /// + public TeamsActivity(string type) + { + Type = type; + From = new TeamsConversationAccount(); + Recipient = new TeamsConversationAccount(); + Conversation = new TeamsConversation(); + } + /// /// Default constructor. /// @@ -56,8 +74,14 @@ public TeamsActivity() private static TeamsActivity FromJsonString(string json, JsonTypeInfo options) => JsonSerializer.Deserialize(json, options)!; - private TeamsActivity(CoreActivity activity) : base(activity) + /// + /// Protected constructor to create TeamsActivity from CoreActivity. + /// Allows derived classes to call via base(activity). + /// + /// The CoreActivity to convert. + protected TeamsActivity(CoreActivity activity) : base(activity) { + ArgumentNullException.ThrowIfNull(activity); // Convert base types to Teams-specific types if (activity.ChannelData is not null) { @@ -88,6 +112,7 @@ internal TeamsActivity Rebase() return this; } + /// /// Gets or sets the account information for the sender of the Teams conversation. /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs index ef201d16..51fe8a3f 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs @@ -2,8 +2,9 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; -using Microsoft.Teams.Bot.Apps.Schema.Entities; using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema.Entities; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.Schema; @@ -17,6 +18,7 @@ namespace Microsoft.Teams.Bot.Apps.Schema; PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)] [JsonSerializable(typeof(CoreActivity))] [JsonSerializable(typeof(TeamsActivity))] +[JsonSerializable(typeof(MessageActivity))] [JsonSerializable(typeof(Entity))] [JsonSerializable(typeof(EntityList))] [JsonSerializable(typeof(MentionEntity))] diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount .cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs similarity index 100% rename from core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount .cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 2606b29b..dda72af7 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -2,11 +2,12 @@ // Licensed under the MIT License. using Microsoft.AspNetCore.Http; +using Microsoft.Teams.Bot.Core; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; -using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps; @@ -18,36 +19,13 @@ public class TeamsBotApplication : BotApplication { private readonly TeamsApiClient _teamsAPXClient; private static TeamsBotApplicationBuilder? _botApplicationBuilder; - - /// - /// Handler for message activities. - /// - public MessageHandler? OnMessage { get; set; } - - /// - /// Handler for message reaction activities. - /// - public MessageReactionHandler? OnMessageReaction { get; set; } - - /// - /// Handler for installation update activities. - /// - public InstallationUpdateHandler? OnInstallationUpdate { get; set; } - - /// - /// Handler for invoke activities. - /// - public InvokeHandler? OnInvoke { get; set; } - + internal Router Router = new(); + /// /// Gets the client used to interact with the TeamsAPX service. /// public TeamsApiClient TeamsAPXClient => _teamsAPXClient; - /// - /// Handler for conversation update activities. - /// - public ConversationUpdateHandler? OnConversationUpdate { get; set; } /// /// @@ -71,34 +49,8 @@ public TeamsBotApplication( { logger.LogInformation("New {Type} activity received.", activity.Type); TeamsActivity teamsActivity = TeamsActivity.FromActivity(activity); - Context context = new(this, teamsActivity); - if (teamsActivity.Type == TeamsActivityType.Message && OnMessage is not null) - { - await OnMessage.Invoke(new MessageArgs(teamsActivity), context, cancellationToken).ConfigureAwait(false); - } - if (teamsActivity.Type == TeamsActivityType.InstallationUpdate && OnInstallationUpdate is not null) - { - await OnInstallationUpdate.Invoke(new InstallationUpdateArgs(teamsActivity), context, cancellationToken).ConfigureAwait(false); - - } - if (teamsActivity.Type == TeamsActivityType.MessageReaction && OnMessageReaction is not null) - { - await OnMessageReaction.Invoke(new MessageReactionArgs(teamsActivity), context, cancellationToken).ConfigureAwait(false); - } - if (teamsActivity.Type == TeamsActivityType.ConversationUpdate && OnConversationUpdate is not null) - { - await OnConversationUpdate.Invoke(new ConversationUpdateArgs(teamsActivity), context, cancellationToken).ConfigureAwait(false); - } - if (teamsActivity.Type == TeamsActivityType.Invoke && OnInvoke is not null) - { - CoreInvokeResponse invokeResponse = await OnInvoke.Invoke(context, cancellationToken).ConfigureAwait(false); - HttpContext? httpContext = httpContextAccessor.HttpContext; - if (httpContext is not null) - { - httpContext.Response.StatusCode = invokeResponse.Status; - await httpContext.Response.WriteAsJsonAsync(invokeResponse, cancellationToken).ConfigureAwait(false); - } - } + Context defaultContext = new(this, teamsActivity); + await Router.DispatchAsync(defaultContext, cancellationToken).ConfigureAwait(false); }; } @@ -125,4 +77,5 @@ public void Run() _botApplicationBuilder.WebApplication.Run(); } + } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs index 293e4198..8c9a918e 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs @@ -33,7 +33,7 @@ public void AsConversationUpdate_MembersAdded() TeamsActivity act = TeamsActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("conversationUpdate", act.Type); - + /* ConversationUpdateArgs? cua = new(act); Assert.NotNull(cua); @@ -42,7 +42,7 @@ public void AsConversationUpdate_MembersAdded() Assert.Equal("user1", cua.MembersAdded[0].Id); Assert.Equal("User One", cua.MembersAdded[0].Name); Assert.Equal("bot1", cua.MembersAdded[1].Id); - Assert.Equal("Bot One", cua.MembersAdded[1].Name); + Assert.Equal("Bot One", cua.MembersAdded[1].Name);*/ } [Fact] @@ -65,14 +65,14 @@ public void AsConversationUpdate_MembersRemoved() TeamsActivity act = TeamsActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("conversationUpdate", act.Type); - + /* ConversationUpdateArgs? cua = new(act); Assert.NotNull(cua); Assert.NotNull(cua.MembersRemoved); Assert.Single(cua.MembersRemoved!); Assert.Equal("user2", cua.MembersRemoved[0].Id); - Assert.Equal("User Two", cua.MembersRemoved[0].Name); + Assert.Equal("User Two", cua.MembersRemoved[0].Name);*/ } [Fact] @@ -101,7 +101,7 @@ public void AsConversationUpdate_BothMembersAddedAndRemoved() TeamsActivity act = TeamsActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("conversationUpdate", act.Type); - + /* ConversationUpdateArgs? cua = new(act); Assert.NotNull(cua); @@ -110,6 +110,6 @@ public void AsConversationUpdate_BothMembersAddedAndRemoved() Assert.Single(cua.MembersAdded!); Assert.Single(cua.MembersRemoved!); Assert.Equal("newuser", cua.MembersAdded[0].Id); - Assert.Equal("olduser", cua.MembersRemoved[0].Id); + Assert.Equal("olduser", cua.MembersRemoved[0].Id);*/ } } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs new file mode 100644 index 00000000..e8618a1f --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs @@ -0,0 +1,292 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Nodes; +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +namespace Microsoft.Teams.Bot.Apps.UnitTests; + +public class MessageActivityTests +{ + [Fact] + public void Constructor_Default_SetsMessageType() + { + MessageActivity activity = new(); + Assert.Equal(ActivityType.Message, activity.Type); + } + + [Fact] + public void Constructor_WithText_SetsTextAndMessageType() + { + MessageActivity activity = new("Hello World"); + Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal("Hello World", activity.Text); + } + + [Fact] + public void DeserializeMessageActivity_WithAllProperties() + { + MessageActivity activity = MessageActivity.FromJsonString(jsonMessageWithAllProps); + + Assert.Equal("message", activity.Type); + Assert.Equal("Hello World", activity.Text); + Assert.Equal("This is a summary", activity.Summary); + Assert.Equal("plain", activity.TextFormat); + Assert.Equal(InputHints.AcceptingInput, activity.InputHint); + Assert.Equal(ImportanceLevels.High, activity.Importance); + Assert.Equal(DeliveryModes.Normal, activity.DeliveryMode); + Assert.Equal("carousel", activity.AttachmentLayout); + Assert.NotNull(activity.Expiration); + } + + [Fact] + public void MessageActivity_FromCoreActivity_MapsAllProperties() + { + CoreActivity coreActivity = CoreActivity.FromJsonString(jsonMessageWithAllProps); + MessageActivity messageActivity = (MessageActivity)TeamsActivity.FromActivity(coreActivity); + + Assert.Equal("Hello World", messageActivity.Text); + Assert.Equal("This is a summary", messageActivity.Summary); + Assert.Equal("plain", messageActivity.TextFormat); + Assert.Equal(InputHints.AcceptingInput, messageActivity.InputHint); + Assert.Equal(ImportanceLevels.High, messageActivity.Importance); + Assert.Equal(DeliveryModes.Normal, messageActivity.DeliveryMode); + Assert.Equal("carousel", messageActivity.AttachmentLayout); + Assert.NotNull(messageActivity.Expiration); + } + + [Fact] + public void MessageActivity_Serialize_ToJson() + { + MessageActivity activity = new("Hello World") + { + Summary = "Test summary", + TextFormat = TextFormats.Markdown, + InputHint = InputHints.ExpectingInput, + Importance = ImportanceLevels.Urgent, + DeliveryMode = DeliveryModes.Notification + }; + + string json = activity.ToJson(); + + Assert.Contains("Hello World", json); + Assert.Contains("Test summary", json); + Assert.Contains("markdown", json); + Assert.Contains("expectingInput", json); + Assert.Contains("urgent", json); + Assert.Contains("notification", json); + } + + [Fact] + public void MessageActivity_WithAttachments_Deserialize() + { + MessageActivity activity = MessageActivity.FromJsonString(jsonMessageWithAttachment); + + Assert.Equal("Message with attachment", activity.Text); + Assert.NotNull(activity.Attachments); + Assert.Single(activity.Attachments); + Assert.Equal("application/vnd.microsoft.card.adaptive", activity.Attachments[0].ContentType); + } + + [Fact] + public void MessageActivity_WithEntities_Deserialize() + { + MessageActivity activity = MessageActivity.FromJsonString(jsonMessageWithEntities); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + Assert.Equal("mention", activity.Entities[0].Type); + } + + [Fact] + public void MessageActivity_WithSpeak_SerializeAndDeserialize() + { + MessageActivity activity = new("Hello") + { + Speak = "Hello World" + }; + + string json = activity.ToJson(); + MessageActivity deserialized = MessageActivity.FromJsonString(json); + Assert.Equal("Hello World", deserialized.Speak); + } + + [Fact] + public void MessageActivity_WithExpiration_SerializeAndDeserialize() + { + DateTime expirationDate = new DateTime(2026, 12, 31, 23, 59, 59, DateTimeKind.Utc); + MessageActivity activity = new("Expiring message") + { + Expiration = expirationDate + }; + + string json = activity.ToJson(); + MessageActivity deserialized = MessageActivity.FromJsonString(json); + + Assert.NotNull(deserialized.Expiration); + Assert.Equal(expirationDate.Year, deserialized.Expiration.Value.Year); + Assert.Equal(expirationDate.Month, deserialized.Expiration.Value.Month); + Assert.Equal(expirationDate.Day, deserialized.Expiration.Value.Day); + } + + [Fact] + public void MessageActivity_Constants_InputHints() + { + MessageActivity activity = new MessageActivity("Test") + { + InputHint = InputHints.AcceptingInput + }; + Assert.Equal("acceptingInput", activity.InputHint); + + activity.InputHint = InputHints.IgnoringInput; + Assert.Equal("ignoringInput", activity.InputHint); + + activity.InputHint = InputHints.ExpectingInput; + Assert.Equal("expectingInput", activity.InputHint); + } + + [Fact] + public void MessageActivity_Constants_TextFormats() + { + MessageActivity activity = new("Test") + { + TextFormat = TextFormats.Plain + }; + Assert.Equal("plain", activity.TextFormat); + + activity.TextFormat = TextFormats.Markdown; + Assert.Equal("markdown", activity.TextFormat); + + activity.TextFormat = TextFormats.Xml; + Assert.Equal("xml", activity.TextFormat); + } + + [Fact] + public void MessageActivity_Constants_ImportanceLevels() + { + MessageActivity activity = new("Test") + { + Importance = ImportanceLevels.Low + }; + Assert.Equal("low", activity.Importance); + + activity.Importance = ImportanceLevels.Normal; + Assert.Equal("normal", activity.Importance); + + activity.Importance = ImportanceLevels.High; + Assert.Equal("high", activity.Importance); + + activity.Importance = ImportanceLevels.Urgent; + Assert.Equal("urgent", activity.Importance); + } + + [Fact] + public void MessageActivity_Constants_DeliveryModes() + { + MessageActivity activity = new("Test") + { + DeliveryMode = DeliveryModes.Normal + }; + Assert.Equal("normal", activity.DeliveryMode); + + activity.DeliveryMode = DeliveryModes.Notification; + Assert.Equal("notification", activity.DeliveryMode); + + activity.DeliveryMode = DeliveryModes.Ephemeral; + Assert.Equal("ephemeral", activity.DeliveryMode); + + activity.DeliveryMode = DeliveryModes.ExpectedReplies; + Assert.Equal("expectReplies", activity.DeliveryMode); + } + + [Fact] + public void MessageActivity_FromCoreActivity_WithMissingProperties_HandlesGracefully() + { + CoreActivity coreActivity = new(ActivityType.Message); + MessageActivity messageActivity = MessageActivity.FromActivity(coreActivity); + + Assert.Null(messageActivity.Text); + Assert.Null(messageActivity.Speak); + Assert.Null(messageActivity.InputHint); + Assert.Null(messageActivity.Summary); + Assert.Null(messageActivity.TextFormat); + Assert.Null(messageActivity.AttachmentLayout); + Assert.Null(messageActivity.Importance); + Assert.Null(messageActivity.DeliveryMode); + Assert.Null(messageActivity.Expiration); + } + + private const string jsonMessageWithAllProps = """ + { + "type": "message", + "channelId": "msteams", + "text": "Hello World", + "speak": "Hello World", + "inputHint": "acceptingInput", + "summary": "This is a summary", + "textFormat": "plain", + "attachmentLayout": "carousel", + "importance": "high", + "deliveryMode": "normal", + "expiration": "2026-12-31T23:59:59Z", + "id": "1234567890", + "timestamp": "2026-01-21T12:00:00Z", + "serviceUrl": "https://smba.trafficmanager.net/amer/", + "from": { + "id": "user-123", + "name": "Test User" + }, + "conversation": { + "id": "conversation-123" + }, + "recipient": { + "id": "bot-123", + "name": "Test Bot" + } + } + """; + + private const string jsonMessageWithAttachment = """ + { + "type": "message", + "channelId": "msteams", + "text": "Message with attachment", + "id": "1234567890", + "attachments": [ + { + "contentType": "application/vnd.microsoft.card.adaptive", + "content": { + "type": "AdaptiveCard", + "version": "1.4", + "body": [ + { + "type": "TextBlock", + "text": "Hello from adaptive card" + } + ] + } + } + ] + } + """; + + private const string jsonMessageWithEntities = """ + { + "type": "message", + "channelId": "msteams", + "text": "TestUser hello", + "entities": [ + { + "type": "mention", + "mentioned": { + "id": "user-123", + "name": "TestUser" + }, + "text": "TestUser" + } + ] + } + """; +} diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs index 56f66f1d..b4ac917e 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs @@ -33,12 +33,12 @@ public void AsMessageReaction() Assert.Equal("messageReaction", act.Type); // MessageReactionActivity? mra = MessageReactionActivity.FromActivity(act); - MessageReactionArgs? mra = new(act); + /*MessageReactionArgs? mra = new(act); Assert.NotNull(mra); Assert.NotNull(mra!.ReactionsAdded); Assert.Equal(2, mra!.ReactionsAdded!.Count); Assert.Equal("like", mra!.ReactionsAdded[0].Type); - Assert.Equal("heart", mra!.ReactionsAdded[1].Type); + Assert.Equal("heart", mra!.ReactionsAdded[1].Type);*/ } } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs index f1eae204..77c9b93b 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs @@ -56,6 +56,22 @@ static void AssertCid(CoreActivity a) } + [Fact] + public void DownCastTeamsActivity_To_CoreActivity_FromBuilder() + { + + TeamsActivity teamsActivity = TeamsActivity + .CreateBuilder() + .WithConversation(new Conversation() { Id = "19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856" }) + .Build(); + + static void AssertCid(CoreActivity a) + { + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", a.Conversation!.Id); + } + AssertCid(teamsActivity); + } + [Fact] public void DownCastTeamsActivity_To_CoreActivity_FromJsonString() { From 3d480b9786ffb114176d91318552269df8d0893f Mon Sep 17 00:00:00 2001 From: Rido Date: Thu, 22 Jan 2026 10:17:10 -0800 Subject: [PATCH 42/69] Compat Teams Info (#280) This pull request introduces a comprehensive compatibility layer between the Bot Framework TeamsInfo API and the Teams Bot Core SDK, along with several supporting enhancements and documentation. The main focus is to provide seamless mapping and conversion between Bot Framework and Core SDK models, ensuring feature parity and interoperability. The changes include a detailed API mapping document, model enhancements for compatibility, new extension methods for type conversions, and some minor refactoring and bug fixes. **Key changes include:** ### 1. Compatibility Layer Documentation and API Mapping - Added `CompatTeamsInfo-API-Mapping.md`, a detailed document mapping all `CompatTeamsInfo` static methods to their corresponding REST endpoints and SDK client implementations, including usage examples, authentication, and model conversion strategies. ### 2. Model Enhancements for Teams Compatibility - Enhanced `TeamsConversationAccount` to extract and expose additional Teams-specific properties (`GivenName`, `Surname`, `Email`, `UserPrincipalName`, `UserRole`, `TenantId`) from the `Properties` dictionary, improving compatibility with the Bot Framework schema. [[1]](diffhunk://#diff-ab03c7985a1673a73536a9756293c78cba898a0de6197501e596ad144582a41aL38-R40) [[2]](diffhunk://#diff-ab03c7985a1673a73536a9756293c78cba898a0de6197501e596ad144582a41aL48-R133) - Updated `MeetingInfo` to use `TeamsConversationAccount` for the `Organizer` property instead of the more generic `ConversationAccount`, aligning with Bot Framework expectations. ### 3. Type Conversion Extension Methods - Added multiple extension methods in `CompatActivity.cs` for converting between Core SDK and Bot Framework types, including `TeamsChannelAccount`, `MeetingInfo`, `TeamsMeetingParticipant`, `ChannelInfo`, and paged member results. These methods ensure smooth interoperability and data mapping between the two frameworks. [[1]](diffhunk://#diff-92ebcca71bdaad244e949c815cbf1152d5a3d814cc007052ae7ad2dd8ab225a9R7) [[2]](diffhunk://#diff-92ebcca71bdaad244e949c815cbf1152d5a3d814cc007052ae7ad2dd8ab225a9R112-R283) ### 4. Refactoring and Naming Consistency - Renamed internal variables and properties from `TeamsAPXClient` to `TeamsApiClient` for clarity and consistency in `TeamsBotApplication`. ### 5. Bug Fixes and Method Signature Updates - Changed the parameter type of `SendMeetingNotificationAsync` in `TeamsApiClient` to accept a `TargetedMeetingNotification` instead of a more generic base type, ensuring stricter type safety. These changes provide a robust foundation for supporting Bot Framework TeamsInfo APIs on top of the Teams Bot Core SDK, facilitating migration and interoperability for bot developers. --- core/docs/Architecture.md | 938 ++++++++++++++++++ core/docs/CompatTeamsInfo-API-Mapping.md | 199 ++++ .../Schema/TeamsConversationAccount.cs | 88 +- .../TeamsApiClient.Models.cs | 2 +- .../TeamsApiClient.cs | 2 +- .../TeamsBotApplication.cs | 12 +- .../CompatActivity.cs | 173 ++++ .../CompatAdapter.cs | 2 + .../CompatAdapterMiddleware.cs | 2 + .../CompatConversations.cs | 2 +- .../CompatTeamsInfo.Models.cs | 172 ++++ .../CompatTeamsInfo.cs | 681 +++++++++++++ .../CompatTeamsInfoTests.cs | 591 +++++++++++ .../TeamsApiClientTests.cs | 4 +- 14 files changed, 2850 insertions(+), 18 deletions(-) create mode 100644 core/docs/Architecture.md create mode 100644 core/docs/CompatTeamsInfo-API-Mapping.md create mode 100644 core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.Models.cs create mode 100644 core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs create mode 100644 core/test/Microsoft.Teams.Bot.Core.Tests/CompatTeamsInfoTests.cs diff --git a/core/docs/Architecture.md b/core/docs/Architecture.md new file mode 100644 index 00000000..846bc76c --- /dev/null +++ b/core/docs/Architecture.md @@ -0,0 +1,938 @@ +# Teams Bot SDK Architecture Documentation + +## Overview + +The Teams Bot SDK consists of three layered projects that provide a modern, efficient, and backward-compatible framework for building Microsoft Teams bots. + +```mermaid +graph TB + subgraph "Application Layer" + UserBot[User Bot Application] + end + + subgraph "SDK Layers" + Compat[Microsoft.Teams.Bot.Compat
Bot Framework v4 Compatibility] + Apps[Microsoft.Teams.Bot.Apps
Teams-Specific Features] + Core[Microsoft.Teams.Bot.Core
Core Bot Infrastructure] + end + + subgraph "External Dependencies" + BotFramework[Bot Framework v4 SDK] + TeamsServices[Microsoft Teams Services] + end + + UserBot --> Compat + UserBot --> Apps + Compat --> Apps + Compat --> BotFramework + Apps --> Core + Core --> TeamsServices + + style Core fill:#e1f5ff + style Apps fill:#fff4e1 + style Compat fill:#ffe1f5 +``` + +--- + +## 1. Microsoft.Teams.Bot.Core + +**Purpose**: Provides the foundational infrastructure for building Teams bots with a clean, modern API focused on performance and System.Text.Json serialization. + +### Architecture Overview + +```mermaid +graph TB + subgraph "Core Components" + BotApp[BotApplication] + ConvClient[ConversationClient] + TokenClient[UserTokenClient] + HttpClient[BotHttpClient] + end + + subgraph "Schema Layer" + CoreActivity[CoreActivity] + AgenticId[AgenticIdentity] + ConvAccount[ConversationAccount] + JsonContext[CoreActivityJsonContext] + end + + subgraph "Middleware Pipeline" + TurnMW[TurnMiddleware] + CustomMW[ITurnMiddleware] + end + + subgraph "Hosting" + AuthHandler[BotAuthenticationHandler] + Extensions[AddBotApplicationExtensions] + Config[BotConfig] + end + + BotApp --> TurnMW + BotApp --> ConvClient + BotApp --> TokenClient + ConvClient --> HttpClient + TokenClient --> HttpClient + TurnMW --> CustomMW + BotApp --> CoreActivity + CoreActivity --> JsonContext + + style BotApp fill:#4a90e2 + style CoreActivity fill:#7ed321 + style TurnMW fill:#f5a623 +``` + +### Core Patterns + +#### 1. **Middleware Pipeline Pattern** + +The middleware pipeline allows processing activities through a chain of handlers. + +```mermaid +sequenceDiagram + participant HTTP as HTTP Request + participant BotApp as BotApplication + participant Pipeline as TurnMiddleware + participant MW1 as Middleware 1 + participant MW2 as Middleware 2 + participant Handler as OnActivity Handler + + HTTP->>BotApp: ProcessAsync(HttpContext) + BotApp->>BotApp: Deserialize CoreActivity + BotApp->>Pipeline: RunPipelineAsync(activity) + Pipeline->>MW1: OnTurnAsync(activity, next) + MW1->>Pipeline: next(activity) + Pipeline->>MW2: OnTurnAsync(activity, next) + MW2->>Pipeline: next(activity) + Pipeline->>Handler: Invoke(activity) + Handler-->>Pipeline: Complete + Pipeline-->>BotApp: Complete + BotApp-->>HTTP: Response +``` + +**Key Classes**: +- `TurnMiddleware`: Manages the middleware pipeline execution +- `ITurnMiddleware`: Interface for custom middleware components +- `BotApplication`: Orchestrates activity processing + +#### 2. **Client Pattern** + +Separate clients handle different aspects of bot communication. + +```mermaid +graph LR + subgraph "Client Layer" + ConvClient[ConversationClient] + TokenClient[UserTokenClient] + end + + subgraph "HTTP Layer" + BotHttpClient[BotHttpClient] + RequestOpts[BotRequestOptions] + end + + subgraph "Services" + ConvAPI["/v3/conversations"] + TokenAPI["/api/usertoken"] + end + + ConvClient --> BotHttpClient + TokenClient --> BotHttpClient + BotHttpClient --> RequestOpts + BotHttpClient --> ConvAPI + BotHttpClient --> TokenAPI + + style ConvClient fill:#4a90e2 + style TokenClient fill:#4a90e2 +``` + +**Key Features**: +- `ConversationClient`: Manages conversation operations (send, reply, get members) +- `UserTokenClient`: Handles OAuth token operations +- `BotHttpClient`: Centralized HTTP client with authentication and retry logic +- `BotRequestOptions`: Configures requests with authentication and custom headers + +#### 3. **Schema with Source Generation** + +Uses System.Text.Json source generators for optimal performance. + +```csharp +[JsonSerializable(typeof(CoreActivity))] +[JsonSerializable(typeof(ConversationAccount))] +internal partial class CoreActivityJsonContext : JsonSerializerContext +{ +} +``` + +**Benefits**: +- Zero-allocation JSON serialization +- AOT (Ahead-of-Time) compilation support +- Faster startup time +- Smaller deployment size + +### Key Components + +| Component | Purpose | Pattern | +|-----------|---------|---------| +| `BotApplication` | Main entry point for processing activities | Facade | +| `ConversationClient` | Manages conversation operations | Client | +| `UserTokenClient` | Handles user authentication tokens | Client | +| `BotHttpClient` | Centralized HTTP communication | Client | +| `TurnMiddleware` | Executes middleware pipeline | Chain of Responsibility | +| `CoreActivity` | Activity model with source generation | DTO | +| `AgenticIdentity` | Authentication identity for API calls | DTO | +| `BotAuthenticationHandler` | JWT authentication for ASP.NET Core | Authentication Handler | + +### Configuration + +```csharp +services.AddBotApplication(configuration); +// Registers: +// - BotApplication (Singleton) +// - ConversationClient (Singleton) +// - UserTokenClient (Singleton) +// - BotHttpClient (Singleton) +// - Authentication handlers +``` + +--- + +## 2. Microsoft.Teams.Bot.Apps + +**Purpose**: Extends Core with Teams-specific features, handlers, and the TeamsApiClient for advanced Teams operations. + +### Architecture Overview + +```mermaid +graph TB + subgraph "Application Layer" + TeamsBotApp[TeamsBotApplication] + Builder[TeamsBotApplicationBuilder] + end + + subgraph "Handler System" + MsgHandler[MessageHandler] + ConvHandler[ConversationUpdateHandler] + InvokeHandler[InvokeHandler] + InstallHandler[InstallationUpdateHandler] + ReactionHandler[MessageReactionHandler] + end + + subgraph "Teams API Client" + TeamsAPI[TeamsApiClient] + MeetingOps[Meeting Operations] + TeamOps[Team Operations] + BatchOps[Batch Operations] + end + + subgraph "Schema Layer" + TeamsActivity[TeamsActivity] + TeamsChannelData[TeamsChannelData] + TeamsAttachment[TeamsAttachment] + Entities[Entity Types] + end + + subgraph "Context" + Context[Context] + end + + TeamsBotApp --> TeamsAPI + TeamsBotApp --> MsgHandler + TeamsBotApp --> ConvHandler + TeamsBotApp --> InvokeHandler + TeamsBotApp --> InstallHandler + TeamsBotApp --> ReactionHandler + + MsgHandler --> Context + ConvHandler --> Context + InvokeHandler --> Context + + TeamsAPI --> MeetingOps + TeamsAPI --> TeamOps + TeamsAPI --> BatchOps + + TeamsBotApp --> TeamsActivity + TeamsActivity --> TeamsChannelData + + style TeamsBotApp fill:#5856d6 + style TeamsAPI fill:#ff9500 + style Context fill:#34c759 +``` + +### Core Patterns + +#### 1. **Handler Pattern with Typed Arguments** + +Teams-specific activities are routed to typed handlers. + +```mermaid +sequenceDiagram + participant Core as BotApplication + participant Teams as TeamsBotApplication + participant Handler as MessageHandler + participant UserCode as User Handler + + Core->>Teams: OnActivity(CoreActivity) + Teams->>Teams: Convert to TeamsActivity + Teams->>Teams: Create Context + Teams->>Handler: Invoke(MessageArgs, Context) + Handler->>UserCode: Execute(args, context) + UserCode-->>Handler: Complete + Handler-->>Teams: Complete + Teams-->>Core: Complete +``` + +**Handler Types**: +```csharp +public delegate Task MessageHandler(MessageArgs args, Context context, CancellationToken ct); +public delegate Task ConversationUpdateHandler(ConversationUpdateArgs args, Context context, CancellationToken ct); +public delegate Task InvokeHandler(Context context, CancellationToken ct); +public delegate Task InstallationUpdateHandler(InstallationUpdateArgs args, Context context, CancellationToken ct); +public delegate Task MessageReactionHandler(MessageReactionArgs args, Context context, CancellationToken ct); +``` + +#### 2. **Builder Pattern for Application Configuration** + +Fluent API for configuring Teams bot applications. + +```mermaid +graph LR + Start[TeamsBotApplicationBuilder] --> OnMsg[OnMessage] + OnMsg --> OnConv[OnConversationUpdate] + OnConv --> OnInvoke[OnInvoke] + OnInvoke --> OnInstall[OnInstallationUpdate] + OnInstall --> OnReact[OnMessageReaction] + OnReact --> Build[Build] + Build --> App[TeamsBotApplication] + + style Start fill:#5856d6 + style App fill:#5856d6 +``` + +**Usage**: +```csharp +var builder = new TeamsBotApplicationBuilder() + .OnMessage(async (args, context, ct) => { + await context.SendActivityAsync("Hello!"); + }) + .OnConversationUpdate(async (args, context, ct) => { + // Handle member added/removed + }) + .OnInvoke(async (context, ct) => { + return new CoreInvokeResponse { Status = 200 }; + }); + +var app = builder.Build(services); +``` + +#### 3. **Context Pattern** + +Provides a rich context object for bot operations. + +```mermaid +graph TB + Context[Context] + + Context --> Activity[TeamsActivity] + Context --> BotApp[TeamsBotApplication] + Context --> Conv[ConversationClient] + Context --> Token[UserTokenClient] + Context --> Teams[TeamsApiClient] + + Context --> Send[SendActivityAsync] + Context --> Reply[ReplyAsync] + Context --> Update[UpdateActivityAsync] + Context --> Delete[DeleteActivityAsync] + + style Context fill:#34c759 +``` + +**Key Features**: +- Encapsulates current activity and bot application +- Provides convenience methods for common operations +- Access to all clients (Conversation, Token, Teams) +- Simplified response methods + +#### 4. **Teams API Client Pattern** + +Specialized client for Teams-specific operations. + +```mermaid +graph TB + subgraph "TeamsApiClient" + Client[TeamsApiClient] + end + + subgraph "Meeting Operations" + FetchMeeting[FetchMeetingInfoAsync] + FetchParticipant[FetchParticipantAsync] + SendNotification[SendMeetingNotificationAsync] + end + + subgraph "Team Operations" + FetchTeam[FetchTeamDetailsAsync] + FetchChannels[FetchChannelListAsync] + end + + subgraph "Batch Operations" + SendToUsers[SendMessageToListOfUsersAsync] + SendToChannels[SendMessageToListOfChannelsAsync] + SendToTeam[SendMessageToAllUsersInTeamAsync] + SendToTenant[SendMessageToAllUsersInTenantAsync] + GetOpState[GetOperationStateAsync] + GetFailed[GetPagedFailedEntriesAsync] + Cancel[CancelOperationAsync] + end + + Client --> FetchMeeting + Client --> FetchParticipant + Client --> SendNotification + Client --> FetchTeam + Client --> FetchChannels + Client --> SendToUsers + Client --> SendToChannels + Client --> SendToTeam + Client --> SendToTenant + Client --> GetOpState + Client --> GetFailed + Client --> Cancel + + style Client fill:#ff9500 +``` + +### Key Components + +| Component | Purpose | Pattern | +|-----------|---------|---------| +| `TeamsBotApplication` | Teams-specific bot application | Specialization | +| `TeamsBotApplicationBuilder` | Fluent configuration API | Builder | +| `TeamsApiClient` | Teams-specific API operations | Client | +| `Context` | Rich context for handlers | Context Object | +| `TeamsActivity` | Teams-enhanced activity model | DTO | +| `MessageHandler` | Delegate for message handling | Handler | +| `ConversationUpdateHandler` | Delegate for conversation updates | Handler | +| `InvokeHandler` | Delegate for invoke activities | Handler | +| `TeamsChannelData` | Teams-specific channel data | DTO | +| `Entity` | Base class for activity entities | DTO | + +### REST API Endpoints + +| Operation | Endpoint | Description | +|-----------|----------|-------------| +| Meeting Info | `GET /v1/meetings/{meetingId}` | Get meeting details | +| Participant | `GET /v1/meetings/{meetingId}/participants/{participantId}` | Get participant info | +| Notification | `POST /v1/meetings/{meetingId}/notification` | Send in-meeting notification | +| Team Details | `GET /v3/teams/{teamId}` | Get team information | +| Channels | `GET /v3/teams/{teamId}/channels` | List team channels | +| Batch Users | `POST /v3/batch/conversation/users/` | Message multiple users | +| Batch Channels | `POST /v3/batch/conversation/channels/` | Message multiple channels | +| Batch Team | `POST /v3/batch/conversation/team/` | Message all team members | +| Batch Tenant | `POST /v3/batch/conversation/tenant/` | Message entire tenant | +| Operation State | `GET /v3/batch/conversation/{operationId}` | Get batch operation status | +| Failed Entries | `GET /v3/batch/conversation/failedentries/{operationId}` | Get failed batch entries | +| Cancel Operation | `DELETE /v3/batch/conversation/{operationId}` | Cancel batch operation | + +### Configuration + +```csharp +services.AddTeamsBotApplication(configuration); +// Registers everything from Core plus: +// - TeamsBotApplication (Singleton) +// - TeamsApiClient (Singleton) +// - IHttpContextAccessor +``` + +--- + +## 3. Microsoft.Teams.Bot.Compat + +**Purpose**: Provides backward compatibility with Bot Framework v4 SDK, allowing existing bots to migrate incrementally to the new Teams SDK. + +### Architecture Overview + +```mermaid +graph TB + subgraph "Compatibility Layer" + CompatAdapter[CompatAdapter] + CompatBotAdapter[CompatBotAdapter] + CompatMiddleware[CompatAdapterMiddleware] + end + + subgraph "Client Adapters" + CompatConnector[CompatConnectorClient] + CompatConversations[CompatConversations] + CompatUserToken[CompatUserTokenClient] + end + + subgraph "Static Helpers" + CompatTeamsInfo[CompatTeamsInfo] + CompatActivity[CompatActivity Extensions] + end + + subgraph "Bot Framework v4" + BFAdapter[IBotFrameworkHttpAdapter] + BFBot[IBot] + BFMiddleware[IMiddleware] + TurnContext[ITurnContext] + end + + subgraph "Teams SDK" + TeamsBotApp[TeamsBotApplication] + ConvClient[ConversationClient] + TokenClient[UserTokenClient] + TeamsAPI[TeamsApiClient] + end + + CompatAdapter -.implements.-> BFAdapter + CompatMiddleware -.implements.-> ITurnMiddleware + + CompatAdapter --> TeamsBotApp + CompatAdapter --> CompatBotAdapter + CompatAdapter --> CompatMiddleware + + CompatConnector --> CompatConversations + CompatConversations --> ConvClient + CompatUserToken --> TokenClient + + CompatTeamsInfo --> ConvClient + CompatTeamsInfo --> TeamsAPI + CompatTeamsInfo --> CompatActivity + + BFBot --> TurnContext + TurnContext --> CompatConnector + + style CompatAdapter fill:#ff2d55 + style CompatTeamsInfo fill:#ff2d55 +``` + +### Core Patterns + +#### 1. **Adapter Pattern** + +Bridges Bot Framework v4 interfaces to Teams SDK implementations. + +```mermaid +sequenceDiagram + participant BF as Bot Framework Bot (IBot) + participant Adapter as CompatAdapter + participant Core as TeamsBotApplication + participant Handler as User Handler + + BF->>Adapter: ProcessAsync(request, response) + Adapter->>Adapter: Register OnActivity handler + Adapter->>Core: ProcessAsync(HttpContext) + Core->>Core: Process CoreActivity + Core->>Adapter: OnActivity callback + Adapter->>Adapter: Convert CoreActivity to Activity + Adapter->>Adapter: Create TurnContext + Adapter->>Adapter: Add clients to TurnState + Adapter->>BF: bot.OnTurnAsync(turnContext) + BF->>Handler: User code executes + Handler-->>BF: Complete + BF-->>Adapter: Complete + Adapter-->>Core: Complete +``` + +**Key Adaptations**: +- `IBotFrameworkHttpAdapter` → `TeamsBotApplication` +- `IBot.OnTurnAsync` → `BotApplication.OnActivity` +- `ITurnContext` → `CoreActivity` +- `IConnectorClient` → `ConversationClient` +- `UserTokenClient` → `UserTokenClient` + +#### 2. **Wrapper Pattern for Clients** + +Wraps Core SDK clients to implement Bot Framework v4 interfaces. + +```mermaid +graph TB + subgraph "Bot Framework Interfaces" + IConnector[IConnectorClient] + IConversations[IConversations] + IUserToken[UserTokenClient BF] + end + + subgraph "Compatibility Wrappers" + CompatConn[CompatConnectorClient] + CompatConv[CompatConversations] + CompatToken[CompatUserTokenClient] + end + + subgraph "Core SDK Clients" + ConvClient[ConversationClient] + TokenClient[UserTokenClient] + end + + CompatConn -.implements.-> IConnector + CompatConv -.implements.-> IConversations + CompatToken -.implements.-> IUserToken + + CompatConn --> CompatConv + CompatConv --> ConvClient + CompatToken --> TokenClient + + style CompatConn fill:#ff3b30 + style CompatConv fill:#ff3b30 + style CompatToken fill:#ff3b30 +``` + +#### 3. **Static Helper Adaptation Pattern** + +Replicates Bot Framework TeamsInfo static methods using Core SDK. + +```mermaid +graph LR + subgraph "Bot Framework v4" + TeamsInfo[TeamsInfo static class] + end + + subgraph "Compatibility Layer" + CompatTeamsInfo[CompatTeamsInfo static class] + Conversions[CompatActivity Extensions] + end + + subgraph "Core SDK" + ConvClient[ConversationClient] + TeamsAPI[TeamsApiClient] + end + + TeamsInfo -.replicated by.-> CompatTeamsInfo + + CompatTeamsInfo --> ConvClient + CompatTeamsInfo --> TeamsAPI + CompatTeamsInfo --> Conversions + + Conversions --> JSONRoundTrip["JSON Round-Trip Serialization"] + Conversions --> DirectMap["Direct Property Mapping"] + + style CompatTeamsInfo fill:#ff9500 +``` + +**Key Methods** (19 total): +- Member operations: GetMemberAsync, GetPagedMembersAsync, etc. +- Meeting operations: GetMeetingInfoAsync, SendMeetingNotificationAsync +- Team operations: GetTeamDetailsAsync, GetTeamChannelsAsync +- Batch operations: SendMessageToListOfUsersAsync, GetOperationStateAsync + +#### 4. **Middleware Bridge Pattern** + +Allows Bot Framework middleware to work with Core SDK middleware pipeline. + +```mermaid +sequenceDiagram + participant Core as Core Pipeline + participant Bridge as CompatAdapterMiddleware + participant BFMiddleware as Bot Framework Middleware + participant Next as Next Handler + + Core->>Bridge: OnTurnAsync(activity, next) + Bridge->>Bridge: Convert CoreActivity to Activity + Bridge->>Bridge: Create TurnContext + Bridge->>BFMiddleware: OnTurnAsync(turnContext, nextDelegate) + BFMiddleware->>Next: nextDelegate() + Next-->>BFMiddleware: Complete + BFMiddleware-->>Bridge: Complete + Bridge->>Core: await next(activity) + Core-->>Bridge: Complete +``` + +#### 5. **Model Conversion Pattern** + +Two strategies for converting between Bot Framework and Core models: + +**Strategy 1: Direct Property Mapping** +```csharp +public static TeamsChannelAccount ToCompatTeamsChannelAccount( + this TeamsConversationAccount account) +{ + return new TeamsChannelAccount + { + Id = account.Id, + Name = account.Name, + AadObjectId = account.AadObjectId, + Email = account.Email, + GivenName = account.GivenName, + Surname = account.Surname, + UserPrincipalName = account.UserPrincipalName, + UserRole = account.UserRole, + TenantId = account.TenantId + }; +} +``` + +**Strategy 2: JSON Round-Trip** (for complex models) +```csharp +public static TeamDetails ToCompatTeamDetails(this Apps.TeamDetails teamDetails) +{ + var json = System.Text.Json.JsonSerializer.Serialize(teamDetails); + return Newtonsoft.Json.JsonConvert.DeserializeObject(json)!; +} +``` + +### Key Components + +| Component | Purpose | Pattern | +|-----------|---------|---------| +| `CompatAdapter` | Main adapter implementing Bot Framework interface | Adapter | +| `CompatBotAdapter` | Base adapter for turn context creation | Adapter | +| `CompatConnectorClient` | Wraps connector client functionality | Wrapper | +| `CompatConversations` | Wraps conversation operations | Wrapper | +| `CompatUserTokenClient` | Wraps token client functionality | Wrapper | +| `CompatAdapterMiddleware` | Bridges middleware systems | Bridge | +| `CompatTeamsInfo` | Static helper methods for Teams operations | Static Helper | +| `CompatActivity` | Extension methods for model conversion | Extension Methods | + +### Migration Path + +```mermaid +graph LR + subgraph Phase1["Phase 1: Drop-in Replacement"] + BFBot1[Existing Bot Framework Bot] + AddCompat1[services.AddCompatAdapter] + BFBot1 --> AddCompat1 + end + + subgraph Phase2["Phase 2: Incremental Migration"] + BFBot2[Mixed Usage] + UseCore[Use Core SDK for new features] + KeepBF[Keep BF code for existing] + BFBot2 --> UseCore + BFBot2 --> KeepBF + end + + subgraph Phase3["Phase 3: Full Migration"] + CoreBot[Pure Teams SDK Bot] + TeamsBotApp[TeamsBotApplication] + Handlers[Typed Handlers] + CoreBot --> TeamsBotApp + CoreBot --> Handlers + end + + AddCompat1 -.Next Phase.-> BFBot2 + KeepBF -.Next Phase.-> CoreBot + + style Phase1 fill:#ff3b30 + style Phase2 fill:#ff9500 + style Phase3 fill:#34c759 +``` + +### Configuration + +```csharp +services.AddCompatAdapter(configuration); +// Registers everything from Apps plus: +// - CompatAdapter as IBotFrameworkHttpAdapter (Singleton) +// - CompatBotAdapter (Singleton) +``` + +--- + +## Cross-Cutting Patterns + +### 1. **Dependency Injection Pattern** + +All three projects use ASP.NET Core DI extensively. + +```mermaid +graph TB + subgraph "DI Container" + Services[IServiceCollection] + end + + subgraph "Core Registrations" + BotApp[BotApplication] + ConvClient[ConversationClient] + TokenClient[UserTokenClient] + HttpClient[BotHttpClient] + end + + subgraph "Apps Registrations" + TeamsBotApp[TeamsBotApplication] + TeamsAPI[TeamsApiClient] + HttpCtx[IHttpContextAccessor] + end + + subgraph "Compat Registrations" + Adapter[CompatAdapter] + BotAdapter[CompatBotAdapter] + end + + Services --> BotApp + Services --> ConvClient + Services --> TokenClient + Services --> HttpClient + Services --> TeamsBotApp + Services --> TeamsAPI + Services --> HttpCtx + Services --> Adapter + Services --> BotAdapter + + TeamsBotApp -.extends.-> BotApp + Adapter -.uses.-> TeamsBotApp +``` + +### 2. **Configuration Pattern** + +Hierarchical configuration with conventions. + +```csharp +{ + "AzureAd": { + "ClientId": "...", + "TenantId": "...", + "ClientSecret": "..." + }, + "MicrosoftAppId": "...", + "MicrosoftAppPassword": "...", + "MicrosoftAppType": "MultiTenant" +} +``` + +**Configuration Precedence**: +1. Environment variables +2. appsettings.json +3. Configuration section (AzureAd, etc.) +4. Fallback defaults + +### 3. **Authentication Pattern** + +JWT bearer token authentication for API calls. + +```mermaid +sequenceDiagram + participant Client as Bot Client + participant Auth as BotAuthenticationHandler + participant AAD as Azure AD + participant API as Teams API + + Client->>Auth: Request with credentials + Auth->>AAD: Get access token + AAD-->>Auth: JWT token + Auth->>Auth: Add Authorization header + Auth->>API: Request with Bearer token + API-->>Auth: Response + Auth-->>Client: Response +``` + +### 4. **Error Handling Pattern** + +Structured exception handling with custom exceptions. + +```csharp +public class BotHandlerException : Exception +{ + public CoreActivity Activity { get; } + public BotHandlerException(CoreActivity activity, string message, Exception? innerException) + : base(message, innerException) + { + Activity = activity; + } +} +``` + +### 5. **Logging Pattern** + +Structured logging with scopes and log levels. + +```csharp +using (_logger.BeginScope("Processing activity {Type} {Id}", activity.Type, activity.Id)) +{ + _logger.LogInformation("Processing activity {Type}", activity.Type); + _logger.LogTrace("Activity details: {Activity}", activity.ToJson()); +} +``` + +--- + +## Performance Considerations + +### 1. **System.Text.Json Source Generation** + +- **Core SDK**: Uses source-generated JSON serializers for zero-allocation deserialization +- **AOT Ready**: Supports ahead-of-time compilation +- **Performance**: 2-3x faster than reflection-based serialization + +### 2. **Object Pooling** + +- Reuses objects where possible to reduce GC pressure +- Particularly important for high-throughput scenarios + +### 3. **Async/Await Best Practices** + +- ConfigureAwait(false) used throughout to avoid context switching +- Cancellation token support for graceful shutdown +- ValueTask for hot paths where appropriate + +### 4. **Minimal Allocations** + +- Uses Span and Memory where applicable +- Avoids unnecessary string allocations +- Lazy initialization of expensive resources + +--- + +## Testing Strategy + +```mermaid +graph TB + subgraph "Test Levels" + Unit[Unit Tests] + Integration[Integration Tests] + E2E[End-to-End Tests] + end + + subgraph "Test Projects" + CoreTests[Microsoft.Teams.Bot.Core.UnitTests] + AppsTests[Microsoft.Teams.Bot.Apps.UnitTests] + CompatTests[Microsoft.Teams.Bot.Compat.UnitTests] + IntTests[Microsoft.Teams.Bot.Core.Tests] + end + + Unit --> CoreTests + Unit --> AppsTests + Unit --> CompatTests + + Integration --> IntTests + + style Unit fill:#34c759 + style Integration fill:#ff9500 + style E2E fill:#ff3b30 +``` + +### Test Patterns + +1. **Unit Tests**: Mock dependencies, test in isolation +2. **Integration Tests**: Test with live services (requires credentials) +3. **Compatibility Tests**: Verify Bot Framework v4 compatibility + +--- + +## Summary + +### Design Principles + +1. **Separation of Concerns**: Clear layering with distinct responsibilities +2. **Dependency Inversion**: Depend on abstractions, not implementations +3. **Single Responsibility**: Each class has one reason to change +4. **Open/Closed**: Open for extension, closed for modification +5. **Performance First**: Optimized for high-throughput scenarios +6. **Backward Compatibility**: Smooth migration path from Bot Framework v4 + +### Key Takeaways + +| Layer | Primary Pattern | Main Benefit | +|-------|----------------|--------------| +| **Core** | Middleware Pipeline | Extensible activity processing | +| **Apps** | Handler Pattern | Type-safe Teams-specific routing | +| **Compat** | Adapter Pattern | Seamless migration from Bot Framework v4 | + +### Evolution Path + +```mermaid +timeline + title SDK Evolution + Phase 1 (Current) : Bot Framework v4 with Compat layer + Phase 2 (Transition) : Mixed usage - Core for new features + Phase 3 (Target) : Pure Teams SDK with typed handlers + Phase 4 (Future) : Cloud-native with additional performance optimizations +``` diff --git a/core/docs/CompatTeamsInfo-API-Mapping.md b/core/docs/CompatTeamsInfo-API-Mapping.md new file mode 100644 index 00000000..51301610 --- /dev/null +++ b/core/docs/CompatTeamsInfo-API-Mapping.md @@ -0,0 +1,199 @@ +# CompatTeamsInfo API Mapping + +This document provides a comprehensive mapping of Bot Framework TeamsInfo static methods to their corresponding REST API endpoints and the Teams Bot Core SDK client implementations. + +## Overview + +The `CompatTeamsInfo` class provides a compatibility layer that adapts the Bot Framework v4 SDK TeamsInfo API to use the Teams Bot Core SDK. It implements 19 static methods organized into four functional categories. + +## API Method Mappings + +### Member & Participant Methods + +| Method | REST Endpoint | Client | Description | +|--------|--------------|--------|-------------| +| `GetMemberAsync` | `GET /v3/conversations/{conversationId}/members/{userId}` | ConversationClient | Gets a single conversation member by user ID | +| `GetMembersAsync` ⚠️ | `GET /v3/conversations/{conversationId}/members` | ConversationClient | Gets all conversation members (deprecated - use paged version) | +| `GetPagedMembersAsync` | `GET /v3/conversations/{conversationId}/pagedmembers?pageSize={pageSize}&continuationToken={token}` | ConversationClient | Gets paginated list of conversation members | +| `GetTeamMemberAsync` | `GET /v3/conversations/{teamId}/members/{userId}` | ConversationClient | Gets a single team member by user ID | +| `GetTeamMembersAsync` ⚠️ | `GET /v3/conversations/{teamId}/members` | ConversationClient | Gets all team members (deprecated - use paged version) | +| `GetPagedTeamMembersAsync` | `GET /v3/conversations/{teamId}/pagedmembers?pageSize={pageSize}&continuationToken={token}` | ConversationClient | Gets paginated list of team members | + +⚠️ *Deprecated by Microsoft Teams - use paged versions instead* + +### Meeting Methods + +| Method | REST Endpoint | Client | Description | +|--------|--------------|--------|-------------| +| `GetMeetingInfoAsync` | `GET /v1/meetings/{meetingId}` | TeamsApiClient | Gets meeting information by meeting ID | +| `GetMeetingParticipantAsync` | `GET /v1/meetings/{meetingId}/participants/{participantId}?tenantId={tenantId}` | TeamsApiClient | Gets a specific meeting participant's information | +| `SendMeetingNotificationAsync` | `POST /v1/meetings/{meetingId}/notification` | TeamsApiClient | Sends an in-meeting notification to participants | + +### Team & Channel Methods + +| Method | REST Endpoint | Client | Description | +|--------|--------------|--------|-------------| +| `GetTeamDetailsAsync` | `GET /v3/teams/{teamId}` | TeamsApiClient | Gets detailed information about a team | +| `GetTeamChannelsAsync` | `GET /v3/teams/{teamId}/channels` | TeamsApiClient | Gets list of channels in a team | + +### Batch Messaging Methods + +| Method | REST Endpoint | Client | Description | +|--------|--------------|--------|-------------| +| `SendMessageToListOfUsersAsync` | `POST /v3/batch/conversation/users/` | TeamsApiClient | Sends a message to a list of users | +| `SendMessageToListOfChannelsAsync` | `POST /v3/batch/conversation/channels/` | TeamsApiClient | Sends a message to a list of channels | +| `SendMessageToAllUsersInTeamAsync` | `POST /v3/batch/conversation/team/` | TeamsApiClient | Sends a message to all users in a team | +| `SendMessageToAllUsersInTenantAsync` | `POST /v3/batch/conversation/tenant/` | TeamsApiClient | Sends a message to all users in a tenant | +| `SendMessageToTeamsChannelAsync` | Uses Bot Framework Adapter | BotAdapter.CreateConversationAsync | Creates a conversation in a Teams channel and sends a message | + +### Batch Operation Management Methods + +| Method | REST Endpoint | Client | Description | +|--------|--------------|--------|-------------| +| `GetOperationStateAsync` | `GET /v3/batch/conversation/{operationId}` | TeamsApiClient | Gets the state of a batch operation | +| `GetPagedFailedEntriesAsync` | `GET /v3/batch/conversation/failedentries/{operationId}?continuationToken={token}` | TeamsApiClient | Gets failed entries from a batch operation | +| `CancelOperationAsync` | `DELETE /v3/batch/conversation/{operationId}` | TeamsApiClient | Cancels a batch operation | + +## Client Distribution + +The implementation uses two primary clients from the Teams Bot Core SDK: + +### ConversationClient (6 methods) +Used for member and participant operations in conversations and teams. Accessed via the `IConnectorClient` in TurnState. + +**Methods:** +- GetMemberAsync +- GetMembersAsync +- GetPagedMembersAsync +- GetTeamMemberAsync +- GetTeamMembersAsync +- GetPagedTeamMembersAsync + +### TeamsApiClient (12 methods) +Used for Teams-specific operations including meetings, team details, channels, and batch messaging. Added to TurnState by the CompatAdapter. + +**Methods:** +- GetMeetingInfoAsync +- GetMeetingParticipantAsync +- SendMeetingNotificationAsync +- GetTeamDetailsAsync +- GetTeamChannelsAsync +- SendMessageToListOfUsersAsync +- SendMessageToListOfChannelsAsync +- SendMessageToAllUsersInTeamAsync +- SendMessageToAllUsersInTenantAsync +- GetOperationStateAsync +- GetPagedFailedEntriesAsync +- CancelOperationAsync + +### Bot Framework Adapter (1 method) +One method uses the Bot Framework adapter directly for backward compatibility. + +**Methods:** +- SendMessageToTeamsChannelAsync + +## Implementation Details + +### Model Conversion Strategy + +The implementation uses two strategies for converting between Bot Framework and Core SDK models: + +1. **Direct Property Mapping**: For simple models like `TeamsChannelAccount`, `ChannelInfo`, etc. +2. **JSON Round-Trip**: For complex models like `TeamDetails`, `MeetingNotificationResponse`, `BatchOperationState`, etc. + +### Type Conversions + +Key extension methods in `CompatActivity.cs`: + +| Extension Method | Source Type | Target Type | Strategy | +|------------------|-------------|-------------|----------| +| `ToCompatTeamsChannelAccount` | Core TeamsConversationAccount | BF TeamsChannelAccount | Direct mapping | +| `ToCompatMeetingInfo` | Core MeetingInfo | BF MeetingInfo | Direct mapping | +| `ToCompatTeamsMeetingParticipant` | Core MeetingParticipant | BF TeamsMeetingParticipant | Direct mapping | +| `ToCompatChannelInfo` | Core Channel | BF ChannelInfo | Direct mapping | +| `ToCompatTeamsPagedMembersResult` | Core PagedMembersResult | BF TeamsPagedMembersResult | Direct mapping | +| `ToCompatTeamDetails` | Core TeamDetails | BF TeamDetails | JSON round-trip | +| `ToCompatMeetingNotificationResponse` | Core MeetingNotificationResponse | BF MeetingNotificationResponse | JSON round-trip | +| `ToCompatBatchOperationState` | Core BatchOperationState | BF BatchOperationState | JSON round-trip | +| `ToCompatBatchFailedEntriesResponse` | Core BatchFailedEntriesResponse | BF BatchFailedEntriesResponse | JSON round-trip | +| `FromCompatTeamMember` | BF TeamMember | Core TeamMember | JSON round-trip | + +### Authentication + +All methods use `AgenticIdentity` extracted from the turn context activity properties for authentication with the Teams services. + +### Service URL + +All API calls use the service URL from the turn context activity (`turnContext.Activity.ServiceUrl`), which points to the appropriate Teams channel service endpoint. + +## Usage Examples + +### Getting a Team Member + +```csharp +var member = await TeamsInfo.GetMemberAsync(turnContext, userId, cancellationToken); +Console.WriteLine($"Member: {member.Name} ({member.Email})"); +``` + +### Getting Meeting Information + +```csharp +var meetingInfo = await TeamsInfo.GetMeetingInfoAsync(turnContext, meetingId, cancellationToken); +Console.WriteLine($"Meeting: {meetingInfo.Details.Title}"); +``` + +### Sending a Batch Message + +```csharp +var activity = MessageFactory.Text("Hello from bot!"); +var members = new List { new TeamMember(userId1), new TeamMember(userId2) }; +var operationId = await TeamsInfo.SendMessageToListOfUsersAsync( + turnContext, activity, members, tenantId, cancellationToken); + +// Check operation status +var state = await TeamsInfo.GetOperationStateAsync(turnContext, operationId, cancellationToken); +Console.WriteLine($"Operation state: {state.State}"); +``` + +### Getting Team Channels + +```csharp +var channels = await TeamsInfo.GetTeamChannelsAsync(turnContext, teamId, cancellationToken); +foreach (var channel in channels) +{ + Console.WriteLine($"Channel: {channel.Name} ({channel.Id})"); +} +``` + +## Testing + +Comprehensive integration tests are available in `test/Microsoft.Teams.Bot.Core.Tests/CompatTeamsInfoTests.cs`. All tests are marked with `[Fact(Skip = "Requires live service credentials")]` and require environment variables to be set for live testing: + +- `TEST_USER_ID` +- `TEST_CONVERSATIONID` +- `TEST_TEAMID` +- `TEST_CHANNELID` +- `TEST_MEETINGID` +- `TEST_TENANTID` + +## Modified Core Models + +To support full compatibility, the following Core SDK models were enhanced: + +### TeamsConversationAccount +Added properties to match Bot Framework `TeamsChannelAccount`: +- `GivenName` +- `Surname` +- `Email` +- `UserPrincipalName` +- `UserRole` +- `TenantId` + +### MeetingInfo +Changed `Organizer` property type from `ConversationAccount` to `TeamsConversationAccount` to match Bot Framework schema. + +## References + +- [Bot Framework TeamsInfo Source](https://github.com/microsoft/botbuilder-dotnet/blob/main/libraries/Microsoft.Bot.Builder/Teams/TeamsInfo.cs) +- [Teams REST API Documentation](https://docs.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference) +- [Teams Meeting Notifications](https://docs.microsoft.com/en-us/microsoftteams/platform/apps-in-teams-meetings/meeting-apps-apis) diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs index da0b576d..774df35e 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs @@ -35,8 +35,9 @@ public TeamsConversationAccount() /// /// Initializes a new instance of the TeamsConversationAccount class using the specified conversation account. /// - /// If the provided ConversationAccount contains an 'aadObjectId' property as a string, it is - /// used to set the AadObjectId property of the TeamsConversationAccount. + /// If the provided ConversationAccount contains Teams-specific properties in the Properties dictionary + /// (such as 'aadObjectId', 'givenName', 'surname', 'email', 'userPrincipalName', 'userRole', 'tenantId'), + /// they are extracted and used to populate the corresponding properties of the TeamsConversationAccount. /// The ConversationAccount instance containing the conversation's identifier, name, and properties. Cannot be null. public TeamsConversationAccount(ConversationAccount conversationAccount) { @@ -45,16 +46,89 @@ public TeamsConversationAccount(ConversationAccount conversationAccount) Properties = conversationAccount.Properties; Id = conversationAccount.Id ?? string.Empty; Name = conversationAccount.Name ?? string.Empty; - if (conversationAccount is not null - && conversationAccount.Properties.TryGetValue("aadObjectId", out object? aadObj) - && aadObj is JsonElement je - && je.ValueKind == JsonValueKind.String) + + // Extract properties from the Properties dictionary + if (conversationAccount.Properties.TryGetValue("aadObjectId", out object? aadObj) + && aadObj is JsonElement aadJe + && aadJe.ValueKind == JsonValueKind.String) + { + AadObjectId = aadJe.GetString(); + } + + if (conversationAccount.Properties.TryGetValue("givenName", out object? givenNameObj) + && givenNameObj is JsonElement givenNameJe + && givenNameJe.ValueKind == JsonValueKind.String) + { + GivenName = givenNameJe.GetString(); + } + + if (conversationAccount.Properties.TryGetValue("surname", out object? surnameObj) + && surnameObj is JsonElement surnameJe + && surnameJe.ValueKind == JsonValueKind.String) + { + Surname = surnameJe.GetString(); + } + + if (conversationAccount.Properties.TryGetValue("email", out object? emailObj) + && emailObj is JsonElement emailJe + && emailJe.ValueKind == JsonValueKind.String) + { + Email = emailJe.GetString(); + } + + if (conversationAccount.Properties.TryGetValue("userPrincipalName", out object? upnObj) + && upnObj is JsonElement upnJe + && upnJe.ValueKind == JsonValueKind.String) + { + UserPrincipalName = upnJe.GetString(); + } + + if (conversationAccount.Properties.TryGetValue("userRole", out object? roleObj) + && roleObj is JsonElement roleJe + && roleJe.ValueKind == JsonValueKind.String) + { + UserRole = roleJe.GetString(); + } + + if (conversationAccount.Properties.TryGetValue("tenantId", out object? tenantObj) + && tenantObj is JsonElement tenantJe + && tenantJe.ValueKind == JsonValueKind.String) { - AadObjectId = je.GetString(); + TenantId = tenantJe.GetString(); } } /// /// Gets or sets the Azure Active Directory (AAD) Object ID associated with the conversation account. /// [JsonPropertyName("aadObjectId")] public string? AadObjectId { get; set; } + + /// + /// Gets or sets given name part of the user name. + /// + [JsonPropertyName("givenName")] public string? GivenName { get; set; } + + /// + /// Gets or sets surname part of the user name. + /// + [JsonPropertyName("surname")] public string? Surname { get; set; } + + /// + /// Gets or sets email Id of the user. + /// + [JsonPropertyName("email")] public string? Email { get; set; } + + /// + /// Gets or sets unique user principal name. + /// + [JsonPropertyName("userPrincipalName")] public string? UserPrincipalName { get; set; } + + /// + /// Gets or sets the UserRole. + /// + [JsonPropertyName("userRole")] public string? UserRole { get; set; } + + /// + /// Gets or sets the TenantId. + /// + [JsonPropertyName("tenantId")] public string? TenantId { get; set; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs index 5fae8608..a91ed85e 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs @@ -90,7 +90,7 @@ public class MeetingInfo /// Gets or sets the organizer of the meeting. /// [JsonPropertyName("organizer")] - public ConversationAccount? Organizer { get; set; } + public Microsoft.Teams.Bot.Apps.Schema.TeamsConversationAccount? Organizer { get; set; } } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs index 2204127c..7e2099d5 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs @@ -155,7 +155,7 @@ public async Task FetchParticipantAsync(string meetingId, st /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains information about failed recipients. /// Thrown if the notification could not be sent successfully. - public async Task SendMeetingNotificationAsync(string meetingId, MeetingNotificationBase notification, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public async Task SendMeetingNotificationAsync(string meetingId, TargetedMeetingNotification notification, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(meetingId); ArgumentNullException.ThrowIfNull(notification); diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index dda72af7..741547fc 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -17,19 +17,19 @@ namespace Microsoft.Teams.Bot.Apps; [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class TeamsBotApplication : BotApplication { - private readonly TeamsApiClient _teamsAPXClient; + private readonly TeamsApiClient _teamsApiClient; private static TeamsBotApplicationBuilder? _botApplicationBuilder; internal Router Router = new(); /// - /// Gets the client used to interact with the TeamsAPX service. + /// Gets the client used to interact with the Teams API service. /// - public TeamsApiClient TeamsAPXClient => _teamsAPXClient; + public TeamsApiClient TeamsApiClient => _teamsApiClient; /// /// - /// + /// /// /// /// @@ -37,14 +37,14 @@ public class TeamsBotApplication : BotApplication public TeamsBotApplication( ConversationClient conversationClient, UserTokenClient userTokenClient, - TeamsApiClient teamsAPXClient, + TeamsApiClient teamsApiClient, IConfiguration config, IHttpContextAccessor httpContextAccessor, ILogger logger, string sectionName = "AzureAd") : base(conversationClient, userTokenClient, config, logger, sectionName) { - _teamsAPXClient = teamsAPXClient; + _teamsApiClient = teamsApiClient; OnActivity = async (activity, cancellationToken) => { logger.LogInformation("New {Type} activity received.", activity.Type); diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs index 1ee1304a..daef3841 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs @@ -4,6 +4,7 @@ using System.Text; using Microsoft.Bot.Builder.Integration.AspNet.Core.Handlers; using Microsoft.Bot.Schema; +using Microsoft.Bot.Schema.Teams; using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Core.Schema; using Newtonsoft.Json; @@ -108,4 +109,176 @@ public static Microsoft.Bot.Schema.ChannelAccount ToCompatChannelAccount(this Mi return channelAccount; } + + /// + /// Converts a TeamsConversationAccount to a TeamsChannelAccount. + /// + /// + /// + public static Microsoft.Bot.Schema.Teams.TeamsChannelAccount ToCompatTeamsChannelAccount(this Microsoft.Teams.Bot.Apps.Schema.TeamsConversationAccount account) + { + ArgumentNullException.ThrowIfNull(account); + + return new Microsoft.Bot.Schema.Teams.TeamsChannelAccount + { + Id = account.Id, + Name = account.Name, + AadObjectId = account.AadObjectId, + Email = account.Email, + GivenName = account.GivenName, + Surname = account.Surname, + UserPrincipalName = account.UserPrincipalName, + UserRole = account.UserRole, + TenantId = account.TenantId + }; + } + + /// + /// Converts a Core MeetingInfo to a Bot Framework MeetingInfo. + /// + /// + /// + public static Microsoft.Bot.Schema.Teams.MeetingInfo ToCompatMeetingInfo(this Microsoft.Teams.Bot.Apps.MeetingInfo meetingInfo) + { + ArgumentNullException.ThrowIfNull(meetingInfo); + + return new Microsoft.Bot.Schema.Teams.MeetingInfo + { + Details = meetingInfo.Details != null ? new Microsoft.Bot.Schema.Teams.MeetingDetails + { + Id = meetingInfo.Details.Id, + MsGraphResourceId = meetingInfo.Details.MsGraphResourceId, + ScheduledStartTime = meetingInfo.Details.ScheduledStartTime?.DateTime, + ScheduledEndTime = meetingInfo.Details.ScheduledEndTime?.DateTime, + JoinUrl = meetingInfo.Details.JoinUrl, + Title = meetingInfo.Details.Title, + Type = meetingInfo.Details.Type + } : null, + Conversation = meetingInfo.Conversation != null ? new Microsoft.Bot.Schema.ConversationAccount + { + Id = meetingInfo.Conversation.Id, + Name = meetingInfo.Conversation.Name + } : null, + Organizer = meetingInfo.Organizer != null ? meetingInfo.Organizer.ToCompatTeamsChannelAccount() : null + }; + } + + /// + /// Converts a Core MeetingParticipant to a Bot Framework TeamsMeetingParticipant. + /// + /// + /// + public static Microsoft.Bot.Schema.Teams.TeamsMeetingParticipant ToCompatTeamsMeetingParticipant(this Microsoft.Teams.Bot.Apps.MeetingParticipant participant) + { + ArgumentNullException.ThrowIfNull(participant); + + return new Microsoft.Bot.Schema.Teams.TeamsMeetingParticipant + { + User = participant.User != null ? participant.User.ToCompatTeamsChannelAccount() : null, + Meeting = participant.Meeting != null ? new Microsoft.Bot.Schema.Teams.MeetingParticipantInfo + { + Role = participant.Meeting.Role, + InMeeting = participant.Meeting.InMeeting + } : null, + Conversation = participant.Conversation != null ? new Microsoft.Bot.Schema.ConversationAccount + { + Id = participant.Conversation.Id + } : null + }; + } + + /// + /// Converts a Core TeamsChannel to a Bot Framework ChannelInfo. + /// + /// + /// + public static Microsoft.Bot.Schema.Teams.ChannelInfo ToCompatChannelInfo(this Microsoft.Teams.Bot.Apps.Schema.TeamsChannel channel) + { + ArgumentNullException.ThrowIfNull(channel); + + return new Microsoft.Bot.Schema.Teams.ChannelInfo + { + Id = channel.Id, + Name = channel.Name + }; + } + + /// + /// Converts a Core PagedMembersResult to a Bot Framework TeamsPagedMembersResult. + /// + /// + /// + public static Microsoft.Bot.Schema.Teams.TeamsPagedMembersResult ToCompatTeamsPagedMembersResult(this Microsoft.Teams.Bot.Core.PagedMembersResult pagedMembers) + { + ArgumentNullException.ThrowIfNull(pagedMembers); + + return new Microsoft.Bot.Schema.Teams.TeamsPagedMembersResult + { + ContinuationToken = pagedMembers.ContinuationToken, + Members = pagedMembers.Members?.Select(m => m.ToCompatTeamsChannelAccount()).ToList() + }; + } + + /// + /// Converts a ConversationAccount to a TeamsChannelAccount. + /// + /// + /// + public static Microsoft.Bot.Schema.Teams.TeamsChannelAccount ToCompatTeamsChannelAccount(this Microsoft.Teams.Bot.Core.Schema.ConversationAccount account) + { + ArgumentNullException.ThrowIfNull(account); + + var teamsChannelAccount = new Microsoft.Bot.Schema.Teams.TeamsChannelAccount + { + Id = account.Id, + Name = account.Name + }; + + // Extract properties from Properties dictionary + if (account.Properties.TryGetValue("aadObjectId", out object? aadObjectId)) + { + teamsChannelAccount.AadObjectId = aadObjectId?.ToString(); + } + + if (account.Properties.TryGetValue("userPrincipalName", out object? userPrincipalName)) + { + teamsChannelAccount.UserPrincipalName = userPrincipalName?.ToString(); + } + + if (account.Properties.TryGetValue("givenName", out object? givenName)) + { + teamsChannelAccount.GivenName = givenName?.ToString(); + } + + if (account.Properties.TryGetValue("surname", out object? surname)) + { + teamsChannelAccount.Surname = surname?.ToString(); + } + + if (account.Properties.TryGetValue("email", out object? email)) + { + teamsChannelAccount.Email = email?.ToString(); + } + + if (account.Properties.TryGetValue("tenantId", out object? tenantId)) + { + teamsChannelAccount.Properties.Add("tenantId", tenantId?.ToString() ?? string.Empty); + } + + return teamsChannelAccount; + } + + /// + /// Gets the TeamInfo object from the current activity. + /// + /// The activity. + /// The current activity's team's information, or null. + public static TeamInfo? TeamsGetTeamInfo(this IActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + var channelData = activity.GetChannelData(); + return channelData?.Team; + } + + } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index 656a0206..81142ecb 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -72,6 +72,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); CompatConnectorClient connectionClient = new(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); turnContext.TurnState.Add(connectionClient); + turnContext.TurnState.Add(botApplication.TeamsApiClient); await bot.OnTurnAsync(turnContext, cancellationToken1).ConfigureAwait(false); }; @@ -125,6 +126,7 @@ public async Task ContinueConversationAsync(string botId, ConversationReference using TurnContext turnContext = new(compatBotAdapter, reference.GetContinuationActivity()); turnContext.TurnState.Add(new CompatConnectorClient(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = reference.ServiceUrl })); + turnContext.TurnState.Add(botApplication.TeamsApiClient); await callback(turnContext, cancellationToken).ConfigureAwait(false); } } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs index 463d8dc8..4cdf9f7a 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs @@ -50,6 +50,8 @@ public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, Ne ) ); + turnContext.TurnState.Add(tba.TeamsApiClient); + return bfMiddleWare.OnTurnAsync(turnContext, (activity) => nextTurn(cancellationToken), cancellationToken); } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs index 5bf76b59..75b161ec 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs @@ -23,7 +23,7 @@ namespace Microsoft.Teams.Bot.Compat /// The underlying Teams Bot Core ConversationClient that performs the actual conversation operations. internal sealed class CompatConversations(ConversationClient client) : IConversations { - private readonly ConversationClient _client = client; + internal readonly ConversationClient _client = client; /// /// Gets or sets the service URL for the bot service endpoint. diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.Models.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.Models.cs new file mode 100644 index 00000000..9b107048 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.Models.cs @@ -0,0 +1,172 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Schema; +using Microsoft.Bot.Schema.Teams; + +namespace Microsoft.Teams.Bot.Compat; + +internal static class CompatTeamsInfoModels +{ + /// + /// Gets the TeamsMeetingInfo object from the current activity. + /// + /// The activity. + /// The current activity's meeting information, or null. + public static TeamsMeetingInfo? TeamsGetMeetingInfo(this IActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + var channelData = activity.GetChannelData(); + return channelData?.Meeting; + } + + /// + /// Converts a Core BatchOperationState to a Bot Framework BatchOperationState. + /// + /// The source state. + /// The converted Bot Framework BatchOperationState. + public static Microsoft.Bot.Schema.Teams.BatchOperationState ToCompatBatchOperationState(this Microsoft.Teams.Bot.Apps.BatchOperationState state) + { + ArgumentNullException.ThrowIfNull(state); + + var result = new Microsoft.Bot.Schema.Teams.BatchOperationState + { + State = state.State, + RetryAfter = state.RetryAfter?.DateTime, + TotalEntriesCount = state.TotalEntriesCount ?? 0 + }; + + // StatusMap in Bot Framework SDK is IDictionary (read-only property) + // Map from BatchOperationStatusMap to the dictionary format + if (state.StatusMap != null) + { + if (state.StatusMap.Success.HasValue) + { + result.StatusMap[0] = state.StatusMap.Success.Value; + } + + if (state.StatusMap.Failed.HasValue) + { + result.StatusMap[1] = state.StatusMap.Failed.Value; + } + + if (state.StatusMap.Throttled.HasValue) + { + result.StatusMap[2] = state.StatusMap.Throttled.Value; + } + + if (state.StatusMap.Pending.HasValue) + { + result.StatusMap[3] = state.StatusMap.Pending.Value; + } + } + + return result; + } + + /// + /// Converts a Core BatchFailedEntriesResponse to a Bot Framework BatchFailedEntriesResponse. + /// + /// The source response. + /// The converted Bot Framework BatchFailedEntriesResponse. + public static Microsoft.Bot.Schema.Teams.BatchFailedEntriesResponse ToCompatBatchFailedEntriesResponse(this Microsoft.Teams.Bot.Apps.BatchFailedEntriesResponse response) + { + ArgumentNullException.ThrowIfNull(response); + + var result = new Microsoft.Bot.Schema.Teams.BatchFailedEntriesResponse + { + ContinuationToken = response.ContinuationToken + }; + + // FailedEntries is a read-only property with private setter, populate via the collection + if (response.FailedEntries != null) + { + foreach (var entry in response.FailedEntries) + { + result.FailedEntries.Add(entry.ToCompatBatchFailedEntry()); + } + } + + return result; + } + + /// + /// Converts a Core BatchFailedEntry to a Bot Framework BatchFailedEntry. + /// + /// The source entry. + /// The converted Bot Framework BatchFailedEntry. + public static Microsoft.Bot.Schema.Teams.BatchFailedEntry ToCompatBatchFailedEntry(this Microsoft.Teams.Bot.Apps.BatchFailedEntry entry) + { + ArgumentNullException.ThrowIfNull(entry); + + return new Microsoft.Bot.Schema.Teams.BatchFailedEntry + { + EntryId = entry.Id, + Error = entry.Error + }; + } + + /// + /// Converts a Core TeamDetails to a Bot Framework TeamDetails. + /// + /// The source team details. + /// The converted Bot Framework TeamDetails. + public static Microsoft.Bot.Schema.Teams.TeamDetails ToCompatTeamDetails(this Microsoft.Teams.Bot.Apps.TeamDetails teamDetails) + { + ArgumentNullException.ThrowIfNull(teamDetails); + + return new Microsoft.Bot.Schema.Teams.TeamDetails + { + Id = teamDetails.Id, + Name = teamDetails.Name, + AadGroupId = teamDetails.AadGroupId, + ChannelCount = teamDetails.ChannelCount ?? 0, + MemberCount = teamDetails.MemberCount ?? 0, + Type = teamDetails.Type + }; + } + + /// + /// Converts a Core MeetingNotificationResponse to a Bot Framework MeetingNotificationResponse. + /// + /// The source response. + /// The converted Bot Framework MeetingNotificationResponse. + public static Microsoft.Bot.Schema.Teams.MeetingNotificationResponse ToCompatMeetingNotificationResponse(this Microsoft.Teams.Bot.Apps.MeetingNotificationResponse response) + { + ArgumentNullException.ThrowIfNull(response); + + return new Microsoft.Bot.Schema.Teams.MeetingNotificationResponse + { + RecipientsFailureInfo = response.RecipientsFailureInfo?.Select(r => r.ToCompatMeetingNotificationRecipientFailureInfo()).ToList() + }; + } + + /// + /// Converts a Core MeetingNotificationRecipientFailureInfo to a Bot Framework MeetingNotificationRecipientFailureInfo. + /// + /// The source failure info. + /// The converted Bot Framework MeetingNotificationRecipientFailureInfo. + public static Microsoft.Bot.Schema.Teams.MeetingNotificationRecipientFailureInfo ToCompatMeetingNotificationRecipientFailureInfo(this Microsoft.Teams.Bot.Apps.MeetingNotificationRecipientFailureInfo info) + { + ArgumentNullException.ThrowIfNull(info); + + return new Microsoft.Bot.Schema.Teams.MeetingNotificationRecipientFailureInfo + { + RecipientMri = info.RecipientMri, + ErrorCode = info.ErrorCode, + FailureReason = info.FailureReason + }; + } + + /// + /// Converts a Bot Framework TeamMember to a Core TeamMember. + /// + /// The source team member. + /// The converted Core TeamMember. + public static Microsoft.Teams.Bot.Apps.TeamMember FromCompatTeamMember(this Microsoft.Bot.Schema.Teams.TeamMember teamMember) + { + ArgumentNullException.ThrowIfNull(teamMember); + + return new Microsoft.Teams.Bot.Apps.TeamMember(teamMember.Id); + } +} diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs new file mode 100644 index 00000000..e8711045 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs @@ -0,0 +1,681 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Builder; +using Microsoft.Bot.Connector; +using Microsoft.Bot.Schema; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; +using BotFrameworkTeams = Microsoft.Bot.Schema.Teams; +using AppsTeams = Microsoft.Teams.Bot.Apps; +using Microsoft.Bot.Schema.Teams; + +namespace Microsoft.Teams.Bot.Compat; + +/// +/// Provides utility methods for the events and interactions that occur within Microsoft Teams. +/// This class adapts the Teams Bot Core SDK to the Bot Framework v4 SDK TeamsInfo API. +/// +public static class CompatTeamsInfo +{ + #region Helper Methods + + private static readonly System.Text.Json.JsonSerializerOptions s_jsonOptions = new() + { + PropertyNameCaseInsensitive = true + }; + + private static ConversationClient GetConversationClient(ITurnContext turnContext) + { + var connectorClient = turnContext.TurnState.Get() + ?? throw new InvalidOperationException("This method requires a connector client."); + + if (connectorClient is CompatConnectorClient compatClient) + { + return ((CompatConversations)compatClient.Conversations)._client; + } + + throw new InvalidOperationException("Connector client is not compatible."); + } + + private static TeamsApiClient GetTeamsApiClient(ITurnContext turnContext) + { + return turnContext.TurnState.Get() + ?? throw new InvalidOperationException("This method requires TeamsApiClient."); + } + + private static string GetServiceUrl(ITurnContext turnContext) + { + return turnContext.Activity.ServiceUrl + ?? throw new InvalidOperationException("ServiceUrl is required."); + } + + private static AgenticIdentity GetIdentity(ITurnContext turnContext) + { + var coreActivity = ((Activity)turnContext.Activity).FromCompatActivity(); + return AgenticIdentity.FromProperties(coreActivity.From.Properties) ?? new AgenticIdentity(); + } + + #endregion + + #region Member & Participant Methods + + /// + /// Gets the account of a single conversation member. + /// This works in one-on-one, group, and teams scoped conversations. + /// + /// Turn context. + /// ID of the user in question. + /// Cancellation token. + /// The member's channel account information. + public static async Task GetMemberAsync( + ITurnContext turnContext, + string userId, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + var teamInfo = turnContext.Activity.TeamsGetTeamInfo(); + + if (teamInfo?.Id != null) + { + return await GetTeamMemberAsync(turnContext, userId, teamInfo.Id, cancellationToken).ConfigureAwait(false); + } + else + { + var conversationId = turnContext.Activity?.Conversation?.Id + ?? throw new InvalidOperationException("The GetMember operation needs a valid conversation Id."); + + if (userId == null) + { + throw new InvalidOperationException("The GetMember operation needs a valid user Id."); + } + + var client = GetConversationClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var result = await client.GetConversationMemberAsync( + conversationId, userId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return result.ToCompatTeamsChannelAccount(); + } + } + + /// + /// Gets the conversation members of a one-on-one or group chat. + /// + /// Turn context. + /// Cancellation token. + /// List of channel accounts. + [Obsolete("Microsoft Teams is deprecating the non-paged version of the getMembers API which this method uses. Please use GetPagedMembersAsync instead of this API.")] + public static async Task> GetMembersAsync( + ITurnContext turnContext, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + var teamInfo = turnContext.Activity.TeamsGetTeamInfo(); + + if (teamInfo?.Id != null) + { + return await GetTeamMembersAsync(turnContext, teamInfo.Id, cancellationToken).ConfigureAwait(false); + } + else + { + var conversationId = turnContext.Activity?.Conversation?.Id + ?? throw new InvalidOperationException("The GetMembers operation needs a valid conversation Id."); + + var client = GetConversationClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var members = await client.GetConversationMembersAsync( + conversationId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return members.Select(m => m.ToCompatTeamsChannelAccount()); + } + } + + /// + /// Gets a paginated list of members of one-on-one, group, or team conversation. + /// + /// Turn context. + /// Suggested number of entries on a page. + /// Continuation token. + /// Cancellation token. + /// Paged members result. + public static async Task GetPagedMembersAsync( + ITurnContext turnContext, + int? pageSize = default, + string? continuationToken = default, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + var teamInfo = turnContext.Activity.TeamsGetTeamInfo(); + + if (teamInfo?.Id != null) + { + return await GetPagedTeamMembersAsync(turnContext, teamInfo.Id, continuationToken, pageSize, cancellationToken).ConfigureAwait(false); + } + else + { + var conversationId = turnContext.Activity?.Conversation?.Id + ?? throw new InvalidOperationException("The GetMembers operation needs a valid conversation Id."); + + var client = GetConversationClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var pagedMembers = await client.GetConversationPagedMembersAsync( + conversationId, serviceUrl, pageSize, continuationToken, identity, null, cancellationToken).ConfigureAwait(false); + + return pagedMembers.ToCompatTeamsPagedMembersResult(); + } + } + + /// + /// Gets the member of a teams scoped conversation. + /// + /// Turn context. + /// User id. + /// ID of the Teams team. + /// Cancellation token. + /// Team member's channel account. + public static async Task GetTeamMemberAsync( + ITurnContext turnContext, + string userId, + string? teamId = null, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); + + if (userId == null) + { + throw new InvalidOperationException("The GetMember operation needs a valid user Id."); + } + + var client = GetConversationClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var result = await client.GetConversationMemberAsync( + t, userId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return result.ToCompatTeamsChannelAccount(); + } + + /// + /// Gets the list of BotFrameworkTeams.TeamsChannelAccounts within a team. + /// This only works in teams scoped conversations. + /// + /// Turn context. + /// ID of the Teams team. + /// Cancellation token. + /// List of team members. + [Obsolete("Microsoft Teams is deprecating the non-paged version of the getMembers API which this method uses. Please use GetPagedTeamMembersAsync instead of this API.")] + public static async Task> GetTeamMembersAsync( + ITurnContext turnContext, + string? teamId = null, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); + + var client = GetConversationClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var members = await client.GetConversationMembersAsync( + t, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return members.Select(m => m.ToCompatTeamsChannelAccount()); + } + + /// + /// Gets a paginated list of members of a team. + /// This only works in teams scoped conversations. + /// + /// Turn context. + /// ID of the Teams team. + /// Continuation token. + /// Number of entries on the page. + /// Cancellation token. + /// Paged team members result. + public static async Task GetPagedTeamMembersAsync( + ITurnContext turnContext, + string? teamId = null, + string? continuationToken = default, + int? pageSize = default, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); + + var client = GetConversationClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var pagedMembers = await client.GetConversationPagedMembersAsync( + t, serviceUrl, pageSize, continuationToken, identity, null, cancellationToken).ConfigureAwait(false); + + return pagedMembers.ToCompatTeamsPagedMembersResult(); + } + + #endregion + + #region Meeting Methods + + /// + /// Gets the information for the given meeting id. + /// + /// Turn context. + /// The BASE64-encoded id of the Teams meeting. + /// Cancellation token. + /// Meeting information. + public static async Task GetMeetingInfoAsync( + ITurnContext turnContext, + string? meetingId = null, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + meetingId ??= turnContext.Activity.TeamsGetMeetingInfo()?.Id + ?? throw new InvalidOperationException("The meetingId can only be null if turnContext is within the scope of a MS Teams Meeting."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var result = await client.FetchMeetingInfoAsync( + meetingId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return result.ToCompatMeetingInfo(); + } + + /// + /// Gets the details for the given meeting participant. This only works in teams meeting scoped conversations. + /// + /// Turn context. + /// The id of the Teams meeting. BotFrameworkTeams.TeamsChannelData.Meeting.Id will be used if none provided. + /// The id of the Teams meeting participant. From.AadObjectId will be used if none provided. + /// The id of the Teams meeting Tenant. BotFrameworkTeams.TeamsChannelData.Tenant.Id will be used if none provided. + /// Cancellation token. + /// Team participant channel account. + public static async Task GetMeetingParticipantAsync( + ITurnContext turnContext, + string? meetingId = null, + string? participantId = null, + string? tenantId = null, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + meetingId ??= turnContext.Activity.TeamsGetMeetingInfo()?.Id + ?? throw new InvalidOperationException("This method is only valid within the scope of a MS Teams Meeting."); + participantId ??= turnContext.Activity.From.AadObjectId + ?? throw new InvalidOperationException($"{nameof(participantId)} is required."); + tenantId ??= turnContext.Activity.GetChannelData()?.Tenant?.Id + ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var result = await client.FetchParticipantAsync( + meetingId, participantId, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return result.ToCompatTeamsMeetingParticipant(); + } + + /// + /// Sends a notification to meeting participants. This functionality is available only in teams meeting scoped conversations. + /// + /// Turn context. + /// The notification to send to Teams. + /// The id of the Teams meeting. BotFrameworkTeams.TeamsChannelData.Meeting.Id will be used if none provided. + /// Cancellation token. + /// Meeting notification response. + public static async Task SendMeetingNotificationAsync( + ITurnContext turnContext, + BotFrameworkTeams.MeetingNotificationBase? notification, + string? meetingId = null, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + meetingId ??= turnContext.Activity.TeamsGetMeetingInfo()?.Id + ?? throw new InvalidOperationException("This method is only valid within the scope of a MS Teams Meeting."); + notification = notification ?? throw new InvalidOperationException($"{nameof(notification)} is required."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + // Convert Bot Framework MeetingNotificationBase to Core MeetingNotificationBase using JSON round-trip + var json = Newtonsoft.Json.JsonConvert.SerializeObject(notification); + var coreNotification = System.Text.Json.JsonSerializer.Deserialize(json, s_jsonOptions); + + + var result = await client.SendMeetingNotificationAsync( + meetingId, coreNotification!, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return result.ToCompatMeetingNotificationResponse(); + } + + #endregion + + #region Team & Channel Methods + + /// + /// Gets the details for the given team id. This only works in teams scoped conversations. + /// + /// Turn context. + /// The id of the Teams team. + /// Cancellation token. + /// Team details. + public static async Task GetTeamDetailsAsync( + ITurnContext turnContext, + string? teamId = null, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var result = await client.FetchTeamDetailsAsync( + t, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return result.ToCompatTeamDetails(); + } + + /// + /// Returns a list of channels in a Team. + /// This only works in teams scoped conversations. + /// + /// Turn context. + /// ID of the Teams team. + /// Cancellation token. + /// List of channel information. + public static async Task> GetTeamChannelsAsync( + ITurnContext turnContext, + string? teamId = null, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var channelList = await client.FetchChannelListAsync( + t, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return channelList.Channels?.Select(c => c.ToCompatChannelInfo()).ToList() ?? []; + } + + #endregion + + #region Batch Messaging Methods + + /// + /// Sends a message to the provided list of Teams members. + /// + /// Turn context. + /// The activity to send. + /// The list of members. + /// The tenant ID. + /// Cancellation token. + /// The operation Id. + public static async Task SendMessageToListOfUsersAsync( + ITurnContext turnContext, + IActivity activity, + IList teamsMembers, + string tenantId, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + activity = activity ?? throw new InvalidOperationException($"{nameof(activity)} is required."); + teamsMembers = teamsMembers ?? throw new InvalidOperationException($"{nameof(teamsMembers)} is required."); + tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + var coreActivity = ((Activity)activity).FromCompatActivity(); + + var coreTeamsMembers = teamsMembers.Select(m => m.FromCompatTeamMember()).ToList(); + + return await client.SendMessageToListOfUsersAsync( + coreActivity, coreTeamsMembers, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + } + + /// + /// Sends a message to the provided list of Teams channels. + /// + /// Turn context. + /// The activity to send. + /// The list of channels. + /// The tenant ID. + /// Cancellation token. + /// The operation Id. + public static async Task SendMessageToListOfChannelsAsync( + ITurnContext turnContext, + IActivity activity, + IList channelsMembers, + string tenantId, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + activity = activity ?? throw new InvalidOperationException($"{nameof(activity)} is required."); + channelsMembers = channelsMembers ?? throw new InvalidOperationException($"{nameof(channelsMembers)} is required."); + tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + var coreActivity = ((Activity)activity).FromCompatActivity(); + + var coreChannelsMembers = channelsMembers.Select(m => m.FromCompatTeamMember()).ToList(); + + return await client.SendMessageToListOfChannelsAsync( + coreActivity, coreChannelsMembers, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + } + + /// + /// Sends a message to all the users in a team. + /// + /// The turn context. + /// The activity to send to the users in the team. + /// The team ID. + /// The tenant ID. + /// Cancellation token. + /// The operation Id. + public static async Task SendMessageToAllUsersInTeamAsync( + ITurnContext turnContext, + IActivity activity, + string teamId, + string tenantId, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + activity = activity ?? throw new InvalidOperationException($"{nameof(activity)} is required."); + teamId = teamId ?? throw new InvalidOperationException($"{nameof(teamId)} is required."); + tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + var coreActivity = ((Activity)activity).FromCompatActivity(); + + return await client.SendMessageToAllUsersInTeamAsync( + coreActivity, teamId, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + } + + /// + /// Sends a message to all the users in a tenant. + /// + /// The turn context. + /// The activity to send to the tenant. + /// The tenant ID. + /// Cancellation token. + /// The operation Id. + public static async Task SendMessageToAllUsersInTenantAsync( + ITurnContext turnContext, + IActivity activity, + string tenantId, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + activity = activity ?? throw new InvalidOperationException($"{nameof(activity)} is required."); + tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + var coreActivity = ((Activity)activity).FromCompatActivity(); + + return await client.SendMessageToAllUsersInTenantAsync( + coreActivity, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + } + + /// + /// Creates a new thread in a team chat and sends an activity to that new thread. + /// Use this method if you are using CloudAdapter where credentials are handled by the adapter. + /// + /// Turn context. + /// The activity to send on starting the new thread. + /// The Team's Channel ID, note this is distinct from the Bot Framework activity property with same name. + /// The bot's appId. + /// Cancellation token. + /// Tuple with conversation reference and activity id. + public static async Task> SendMessageToTeamsChannelAsync( + ITurnContext turnContext, + IActivity activity, + string teamsChannelId, + string botAppId, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + + if (turnContext.Activity == null) + { + throw new InvalidOperationException(nameof(turnContext.Activity)); + } + + ArgumentException.ThrowIfNullOrWhiteSpace(teamsChannelId); + + ConversationReference? conversationReference = null; + var newActivityId = string.Empty; + var serviceUrl = turnContext.Activity.ServiceUrl; + var conversationParameters = new Microsoft.Bot.Schema.ConversationParameters + { + IsGroup = true, + ChannelData = new BotFrameworkTeams.TeamsChannelData { Channel = new BotFrameworkTeams.ChannelInfo { Id = teamsChannelId } }, + Activity = (Activity)activity, + }; + + await turnContext.Adapter.CreateConversationAsync( + botAppId, + Channels.Msteams, + serviceUrl, + null, + conversationParameters, + (t, ct) => + { + conversationReference = t.Activity.GetConversationReference(); + newActivityId = t.Activity.Id; + return Task.CompletedTask; + }, + cancellationToken).ConfigureAwait(false); + + return new Tuple(conversationReference!, newActivityId); + } + + #endregion + + #region Batch Operation Management + + /// + /// Gets the state of an operation. + /// + /// Turn context. + /// The operationId to get the state of. + /// Cancellation token. + /// The state and responses of the operation. + public static async Task GetOperationStateAsync( + ITurnContext turnContext, + string operationId, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + operationId = operationId ?? throw new InvalidOperationException($"{nameof(operationId)} is required."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var result = await client.GetOperationStateAsync( + operationId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + + return result.ToCompatBatchOperationState(); + } + + /// + /// Gets the failed entries of a batch operation. + /// + /// The turn context. + /// The operationId to get the failed entries of. + /// The continuation token. + /// Cancellation token. + /// The list of failed entries of the operation. + public static async Task GetPagedFailedEntriesAsync( + ITurnContext turnContext, + string operationId, + string? continuationToken = null, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + operationId = operationId ?? throw new InvalidOperationException($"{nameof(operationId)} is required."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + var result = await client.GetPagedFailedEntriesAsync( + operationId, serviceUrl, continuationToken, identity, null, cancellationToken).ConfigureAwait(false); + + return result.ToCompatBatchFailedEntriesResponse(); + } + + /// + /// Cancels a batch operation by its id. + /// + /// The turn context. + /// The id of the operation to cancel. + /// Cancellation token. + /// A task representing the asynchronous operation. + public static async Task CancelOperationAsync( + ITurnContext turnContext, + string operationId, + CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(turnContext); + operationId = operationId ?? throw new InvalidOperationException($"{nameof(operationId)} is required."); + + var client = GetTeamsApiClient(turnContext); + var serviceUrl = new Uri(GetServiceUrl(turnContext)); + var identity = GetIdentity(turnContext); + + await client.CancelOperationAsync( + operationId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); + } + + #endregion +} diff --git a/core/test/Microsoft.Teams.Bot.Core.Tests/CompatTeamsInfoTests.cs b/core/test/Microsoft.Teams.Bot.Core.Tests/CompatTeamsInfoTests.cs new file mode 100644 index 00000000..0546c7da --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Core.Tests/CompatTeamsInfoTests.cs @@ -0,0 +1,591 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Schema; +using Microsoft.Bot.Schema.Teams; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.Teams.Bot.Compat; +using Microsoft.Teams.Bot.Core; + +namespace Microsoft.Bot.Core.Tests +{ + /// + /// Integration tests for CompatTeamsInfo static methods. + /// These tests verify that the compatibility layer correctly adapts + /// Bot Framework TeamsInfo API to Teams Bot Core SDK. + /// + public class CompatTeamsInfoTests + { + private readonly string _serviceUrl = "https://smba.trafficmanager.net/amer/"; + private readonly string _userId; + private readonly string _conversationId; + private readonly string _teamId; + private readonly string _channelId; + private readonly string _meetingId; + private readonly string _tenantId; + + public CompatTeamsInfoTests() + { + // These tests require environment variables for live integration testing + _userId = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? "29:test-user-id"; + _conversationId = Environment.GetEnvironmentVariable("TEST_CONVERSATIONID") ?? "19:test-conversation-id"; + _teamId = Environment.GetEnvironmentVariable("TEST_TEAMID") ?? "19:test-team-id"; + _channelId = Environment.GetEnvironmentVariable("TEST_CHANNELID") ?? "19:test-channel-id"; + _meetingId = Environment.GetEnvironmentVariable("TEST_MEETINGID") ?? "test-meeting-id"; + _tenantId = Environment.GetEnvironmentVariable("TEST_TENANTID") ?? "test-tenant-id"; + } + + [Fact] + public async Task GetMemberAsync_WithValidUserId_ReturnsMember() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + TeamsChannelAccount member = await CompatTeamsInfo.GetMemberAsync( + turnContext, + _userId, + cancellationToken); + + Assert.NotNull(member); + Assert.Equal(_userId, member.Id); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetMembersAsync_ReturnsMembers() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { +#pragma warning disable CS0618 // Type or member is obsolete + var members = await CompatTeamsInfo.GetMembersAsync(turnContext, cancellationToken); +#pragma warning restore CS0618 // Type or member is obsolete + + Assert.NotNull(members); + Assert.NotEmpty(members); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetPagedMembersAsync_ReturnsPagedResult() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var result = await CompatTeamsInfo.GetPagedMembersAsync( + turnContext, + pageSize: 10, + cancellationToken: cancellationToken); + + Assert.NotNull(result); + Assert.NotNull(result.Members); + Assert.True(result.Members.Count > 0); + + var firstMember = result.Members[0]; + Assert.NotNull(firstMember.Id); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetTeamMemberAsync_WithValidUserId_ReturnsMember() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var member = await CompatTeamsInfo.GetTeamMemberAsync( + turnContext, + _userId, + _teamId, + cancellationToken); + + Assert.NotNull(member); + Assert.Equal(_userId, member.Id); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetTeamMembersAsync_ReturnsTeamMembers() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { +#pragma warning disable CS0618 // Type or member is obsolete + var members = await CompatTeamsInfo.GetTeamMembersAsync( + turnContext, + _teamId, + cancellationToken); +#pragma warning restore CS0618 // Type or member is obsolete + + Assert.NotNull(members); + Assert.NotEmpty(members); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetPagedTeamMembersAsync_ReturnsPagedResult() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var result = await CompatTeamsInfo.GetPagedTeamMembersAsync( + turnContext, + _teamId, + pageSize: 5, + cancellationToken: cancellationToken); + + Assert.NotNull(result); + Assert.NotNull(result.Members); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetMeetingInfoAsync_WithMeetingId_ReturnsMeetingInfo() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var meetingInfo = await CompatTeamsInfo.GetMeetingInfoAsync( + turnContext, + _meetingId, + cancellationToken); + + Assert.NotNull(meetingInfo); + Assert.NotNull(meetingInfo.Details); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetMeetingParticipantAsync_WithParticipantId_ReturnsParticipant() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var participant = await CompatTeamsInfo.GetMeetingParticipantAsync( + turnContext, + _meetingId, + _userId, + _tenantId, + cancellationToken); + + Assert.NotNull(participant); + Assert.NotNull(participant.User); + }, + CancellationToken.None); + } + + [Fact] + public async Task SendMeetingNotificationAsync_SendsNotification() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + // Create a simple targeted meeting notification + // Note: In real scenarios, you would construct the proper notification object + // with surfaces and content according to the Teams schema + var notification = new TargetedMeetingNotification + { + Value = new TargetedMeetingNotificationValue + { + Recipients = new List { _userId }, + Surfaces = new List + { + new MeetingStageSurface() + { + ContentType = ContentType.Task, + Content = new TaskModuleContinueResponse + { + Value = new TaskModuleTaskInfo + { + Title = "Test Notification", + Url = "https://www.example.com", + Height = 200, + Width = 400 + } + } + } + } + } + }; + + var response = await CompatTeamsInfo.SendMeetingNotificationAsync( + turnContext, + notification, + _meetingId, + cancellationToken); + + Assert.NotNull(response); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetTeamDetailsAsync_WithTeamId_ReturnsTeamDetails() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var teamDetails = await CompatTeamsInfo.GetTeamDetailsAsync( + turnContext, + _teamId, + cancellationToken); + + Assert.NotNull(teamDetails); + Assert.NotNull(teamDetails.Id); + Assert.NotNull(teamDetails.Name); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetTeamChannelsAsync_WithTeamId_ReturnsChannels() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var channels = await CompatTeamsInfo.GetTeamChannelsAsync( + turnContext, + _teamId, + cancellationToken); + + Assert.NotNull(channels); + Assert.NotEmpty(channels); + + var firstChannel = channels[0]; + Assert.NotNull(firstChannel.Id); + Assert.NotNull(firstChannel.Name); + }, + CancellationToken.None); + } + + [Fact] + public async Task SendMessageToListOfUsersAsync_ReturnsOperationId() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var activity = new Activity + { + Type = ActivityTypes.Message, + Text = "Test message" + }; + var members = new List + { + new TeamMember(_userId), + new TeamMember(_userId), + new TeamMember(_userId), + new TeamMember(_userId), + new TeamMember(_userId) + + }; + + var operationId = await CompatTeamsInfo.SendMessageToListOfUsersAsync( + turnContext, + activity, + members, + _tenantId, + cancellationToken); + + Assert.NotNull(operationId); + Assert.NotEmpty(operationId); + }, + CancellationToken.None); + } + + [Fact] + public async Task SendMessageToListOfChannelsAsync_ReturnsOperationId() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var activity = new Activity + { + Type = ActivityTypes.Message, + Text = "Test message" + }; + var channels = new List + { + new TeamMember(_channelId) + }; + + var operationId = await CompatTeamsInfo.SendMessageToListOfChannelsAsync( + turnContext, + activity, + channels, + _tenantId, + cancellationToken); + + Assert.NotNull(operationId); + Assert.NotEmpty(operationId); + }, + CancellationToken.None); + } + + [Fact] + public async Task SendMessageToAllUsersInTeamAsync_ReturnsOperationId() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var activity = new Activity + { + Type = ActivityTypes.Message, + Text = "Test message to team" + }; + + var operationId = await CompatTeamsInfo.SendMessageToAllUsersInTeamAsync( + turnContext, + activity, + _teamId, + _tenantId, + cancellationToken); + + Assert.NotNull(operationId); + Assert.NotEmpty(operationId); + }, + CancellationToken.None); + } + + [Fact] + public async Task SendMessageToAllUsersInTenantAsync_ReturnsOperationId() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var activity = new Activity + { + Type = ActivityTypes.Message, + Text = "Test message to tenant" + }; + + var operationId = await CompatTeamsInfo.SendMessageToAllUsersInTenantAsync( + turnContext, + activity, + _tenantId, + cancellationToken); + + Assert.NotNull(operationId); + Assert.NotEmpty(operationId); + }, + CancellationToken.None); + } + + [Fact] + public async Task SendMessageToTeamsChannelAsync_CreatesConversationAndSendsMessage() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var activity = new Activity + { + Type = ActivityTypes.Message, + Text = "Test message to channel" + }; + var botAppId = Environment.GetEnvironmentVariable("MicrosoftAppId") ?? string.Empty; + + var result = await CompatTeamsInfo.SendMessageToTeamsChannelAsync( + turnContext, + activity, + _channelId, + botAppId, + cancellationToken); + + Assert.NotNull(result); + Assert.NotNull(result.Item1); // ConversationReference + Assert.NotNull(result.Item2); // ActivityId + }, + CancellationToken.None); + } + + [Fact] + public async Task GetOperationStateAsync_WithOperationId_ReturnsState() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + var operationId = "amer_9e0e3ba8-c562-440f-ba9d-10603ee31837"; + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var state = await CompatTeamsInfo.GetOperationStateAsync( + turnContext, + operationId, + cancellationToken); + + Assert.NotNull(state); + Assert.NotNull(state.State); + }, + CancellationToken.None); + } + + [Fact] + public async Task GetPagedFailedEntriesAsync_WithOperationId_ReturnsFailedEntries() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + var operationId = "amer_9e0e3ba8-c562-440f-ba9d-10603ee31837"; + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + var response = await CompatTeamsInfo.GetPagedFailedEntriesAsync( + turnContext, + operationId, + cancellationToken: cancellationToken); + + Assert.NotNull(response); + }, + CancellationToken.None); + } + + [Fact] + public async Task CancelOperationAsync_WithOperationId_CancelsOperation() + { + var adapter = InitializeCompatAdapter(); + var conversationReference = CreateConversationReference(_conversationId); + var operationId = "amer_9e0e3ba8-c562-440f-ba9d-10603ee31837"; + + await adapter.ContinueConversationAsync( + string.Empty, + conversationReference, + async (turnContext, cancellationToken) => + { + await CompatTeamsInfo.CancelOperationAsync( + turnContext, + operationId, + cancellationToken); + + // If no exception is thrown, the operation succeeded + Assert.True(true); + }, + CancellationToken.None); + } + + private CompatAdapter InitializeCompatAdapter() + { + IConfigurationBuilder builder = new ConfigurationBuilder() + .SetBasePath(AppDomain.CurrentDomain.BaseDirectory) + .AddEnvironmentVariables(); + + IConfiguration configuration = builder.Build(); + + ServiceCollection services = new(); + services.AddSingleton>(NullLogger.Instance); + services.AddSingleton>(NullLogger.Instance); + services.AddSingleton(configuration); + services.AddCompatAdapter(); + services.AddLogging(configure => configure.AddConsole()); + + var serviceProvider = services.BuildServiceProvider(); + CompatAdapter compatAdapter = (CompatAdapter)serviceProvider.GetRequiredService(); + return compatAdapter; + } + + private ConversationReference CreateConversationReference(string conversationId) + { + return new ConversationReference + { + ChannelId = "msteams", + ServiceUrl = _serviceUrl, + Conversation = new ConversationAccount + { + Id = conversationId + } + }; + } + } +} diff --git a/core/test/Microsoft.Teams.Bot.Core.Tests/TeamsApiClientTests.cs b/core/test/Microsoft.Teams.Bot.Core.Tests/TeamsApiClientTests.cs index 4c1663b1..861a4ad2 100644 --- a/core/test/Microsoft.Teams.Bot.Core.Tests/TeamsApiClientTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.Tests/TeamsApiClientTests.cs @@ -134,12 +134,12 @@ await Assert.ThrowsAsync(() => _teamsClient.FetchMeetingInfoAsync("invalid-meeting-id", _serviceUrl)); } - [Fact(Skip = "Requires active meeting context")] + [Fact] public async Task FetchParticipant() { string meetingId = Environment.GetEnvironmentVariable("TEST_MEETINGID") ?? throw new InvalidOperationException("TEST_MEETINGID environment variable not set"); string participantId = Environment.GetEnvironmentVariable("TEST_USER_ID") ?? throw new InvalidOperationException("TEST_USER_ID environment variable not set"); - string tenantId = Environment.GetEnvironmentVariable("TENANT_ID") ?? throw new InvalidOperationException("TENANT_ID environment variable not set"); + string tenantId = Environment.GetEnvironmentVariable("TEST_TENANTID") ?? throw new InvalidOperationException("TEST_TENANTID environment variable not set"); MeetingParticipant result = await _teamsClient.FetchParticipantAsync( meetingId, From 456f29c66410179055a66f41c3ff88b13b99f662 Mon Sep 17 00:00:00 2001 From: Rido Date: Fri, 23 Jan 2026 08:42:39 -0800 Subject: [PATCH 43/69] Fix Write Invoke Response when called from CompatMiddleware (#284) This pull request refactors the `CompatAdapter` and related middleware to use dependency injection for service resolution, improving maintainability and aligning with modern .NET practices. The main changes involve replacing constructor parameters with `IServiceProvider`, updating middleware to resolve dependencies, and enhancing logging in the `CompatBotAdapter`. **Dependency Injection Refactoring:** * `CompatAdapter` now receives an `IServiceProvider` in its constructor, and uses it to resolve `TeamsBotApplication` and `CompatBotAdapter` instead of receiving them directly as parameters. All usages of these services within the class have been updated accordingly. * `CompatAdapterMiddleware` now receives both the Bot Framework middleware and an `IServiceProvider`, enabling it to resolve required services such as `IHttpContextAccessor` and `ILogger`. **Middleware and Adapter Updates:** * Middleware instantiation in `CompatAdapter` is updated to pass the `IServiceProvider` to each `CompatAdapterMiddleware`, ensuring dependencies are available during middleware execution. * Within `CompatAdapterMiddleware`, the `CompatBotAdapter` is now constructed with resolved `IHttpContextAccessor` and `ILogger` instances, improving logging and context-awareness. **Logging Improvements:** * Enhanced logging in `CompatBotAdapter` to include HTTP status codes when sending invoke responses, and to avoid serialization if the response body is null. **General Code Modernization:** * Added missing `using` statements for dependency injection and logging namespaces in affected files. [[1]](diffhunk://#diff-e6d701ce121dda6651c0dea00498d45e2cc0b0cec446a578f3058be691c7c0f5R8) [[2]](diffhunk://#diff-80a974c881b9ff3a697fe5b07985c8f55edb2e2896384d6d437a3e8dfa5a2817R5-R6) --- .../CompatAdapter.cs | 45 +++++++++++++------ .../CompatAdapterMiddleware.cs | 10 +++-- .../CompatBotAdapter.cs | 7 ++- 3 files changed, 43 insertions(+), 19 deletions(-) diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index 81142ecb..55aa0e6f 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -5,6 +5,7 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Schema; +using Microsoft.Extensions.DependencyInjection; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Schema; @@ -20,10 +21,24 @@ namespace Microsoft.Teams.Bot.Compat; /// The adapter allows registration of middleware and error handling delegates, and supports processing HTTP requests /// and continuing conversations. Thread safety is not guaranteed; instances should not be shared across concurrent /// requests. -/// The bot application instance that handles activity processing and manages user token operations. -/// The underlying bot adapter used to interact with the bot framework and create turn contexts. -public class CompatAdapter(TeamsBotApplication botApplication, CompatBotAdapter compatBotAdapter) : IBotFrameworkHttpAdapter +public class CompatAdapter : IBotFrameworkHttpAdapter { + private readonly TeamsBotApplication _teamsBotApplication; + private readonly CompatBotAdapter _compatBotAdapter; + private readonly IServiceProvider _sp; + + + /// + /// Creates a new instance of the class. + /// + /// + public CompatAdapter(IServiceProvider sp) + { + _sp = sp; + _teamsBotApplication = sp.GetRequiredService(); + _compatBotAdapter = sp.GetRequiredService(); + } + /// /// Gets the collection of middleware components configured for the application. /// @@ -64,26 +79,28 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons ArgumentNullException.ThrowIfNull(httpRequest); ArgumentNullException.ThrowIfNull(httpResponse); ArgumentNullException.ThrowIfNull(bot); + CoreActivity? coreActivity = null; - botApplication.OnActivity = async (activity, cancellationToken1) => + _teamsBotApplication.OnActivity = async (activity, cancellationToken1) => { coreActivity = activity; - TurnContext turnContext = new(compatBotAdapter, activity.ToCompatActivity()); - turnContext.TurnState.Add(new CompatUserTokenClient(botApplication.UserTokenClient)); - CompatConnectorClient connectionClient = new(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); + TurnContext turnContext = new(_compatBotAdapter, activity.ToCompatActivity()); + turnContext.TurnState.Add(new CompatUserTokenClient(_teamsBotApplication.UserTokenClient)); + CompatConnectorClient connectionClient = new(new CompatConversations(_teamsBotApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); turnContext.TurnState.Add(connectionClient); - turnContext.TurnState.Add(botApplication.TeamsApiClient); + turnContext.TurnState.Add(_teamsBotApplication.TeamsApiClient); await bot.OnTurnAsync(turnContext, cancellationToken1).ConfigureAwait(false); }; + try { foreach (Microsoft.Bot.Builder.IMiddleware? middleware in MiddlewareSet) { - botApplication.Use(new CompatAdapterMiddleware(middleware)); + _teamsBotApplication.Use(new CompatAdapterMiddleware(middleware, _sp)); } - await botApplication.ProcessAsync(httpRequest.HttpContext, cancellationToken).ConfigureAwait(false); + await _teamsBotApplication.ProcessAsync(httpRequest.HttpContext, cancellationToken).ConfigureAwait(false); } catch (Exception ex) { @@ -92,7 +109,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons if (ex is BotHandlerException aex) { coreActivity = aex.Activity; - using TurnContext turnContext = new(compatBotAdapter, coreActivity!.ToCompatActivity()); + using TurnContext turnContext = new(_compatBotAdapter, coreActivity!.ToCompatActivity()); await OnTurnError(turnContext, ex).ConfigureAwait(false); } else @@ -124,9 +141,9 @@ public async Task ContinueConversationAsync(string botId, ConversationReference ArgumentNullException.ThrowIfNull(reference); ArgumentNullException.ThrowIfNull(callback); - using TurnContext turnContext = new(compatBotAdapter, reference.GetContinuationActivity()); - turnContext.TurnState.Add(new CompatConnectorClient(new CompatConversations(botApplication.ConversationClient) { ServiceUrl = reference.ServiceUrl })); - turnContext.TurnState.Add(botApplication.TeamsApiClient); + using TurnContext turnContext = new(_compatBotAdapter, reference.GetContinuationActivity()); + turnContext.TurnState.Add(new CompatConnectorClient(new CompatConversations(_teamsBotApplication.ConversationClient) { ServiceUrl = reference.ServiceUrl })); + turnContext.TurnState.Add(_teamsBotApplication.TeamsApiClient); await callback(turnContext, cancellationToken).ConfigureAwait(false); } } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs index 4cdf9f7a..1df8acbf 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs @@ -2,6 +2,8 @@ // Licensed under the MIT License. using Microsoft.Bot.Builder; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Schema; @@ -18,7 +20,8 @@ namespace Microsoft.Teams.Bot.Compat; /// This allows gradual migration from Bot Framework SDK to Teams Bot Core while preserving existing middleware investments. /// /// The Bot Framework middleware component to adapt into the Teams Bot Core pipeline. -internal sealed class CompatAdapterMiddleware(IMiddleware bfMiddleWare) : ITurnMiddleWare +/// The service provider used to resolve required services such as HTTP context accessor and logger. +internal sealed class CompatAdapterMiddleware(IMiddleware bfMiddleWare, IServiceProvider sp) : ITurnMiddleWare { /// /// Processes a turn by converting the CoreActivity to Bot Framework format and invoking the wrapped middleware. @@ -30,13 +33,14 @@ internal sealed class CompatAdapterMiddleware(IMiddleware bfMiddleWare) : ITurnM /// A task that represents the asynchronous operation. public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) { + AspNetCore.Http.IHttpContextAccessor httpContextAccessor = sp.GetRequiredService(); + ILogger logger = sp.GetRequiredService>(); if (botApplication is TeamsBotApplication tba) { #pragma warning disable CA2000 // Dispose objects before losing scope - TurnContext turnContext = new(new CompatBotAdapter(tba), activity.ToCompatActivity()); + TurnContext turnContext = new(new CompatBotAdapter(tba, httpContextAccessor, logger), activity.ToCompatActivity()); #pragma warning restore CA2000 // Dispose objects before losing scope - turnContext.TurnState.Add( new CompatUserTokenClient(botApplication.UserTokenClient) ); diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs index 706bf423..f611918e 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs @@ -112,8 +112,11 @@ private void WriteInvokeResponseToHttpResponse(InvokeResponse? invokeResponse) response.StatusCode = invokeResponse.Status; using StreamWriter httpResponseStreamWriter = new(response.BodyWriter.AsStream()); using JsonTextWriter httpResponseJsonWriter = new(httpResponseStreamWriter); - logger.LogTrace("Sending Invoke Response: \n {InvokeResponse} \n", System.Text.Json.JsonSerializer.Serialize(invokeResponse.Body, _writeIndentedJsonOptions)); - Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(httpResponseJsonWriter, invokeResponse.Body); + logger.LogTrace("Sending Invoke Response: \n {InvokeResponse} with status: {Status} \n", System.Text.Json.JsonSerializer.Serialize(invokeResponse.Body, _writeIndentedJsonOptions), invokeResponse.Status); + if (invokeResponse.Body is not null) + { + Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(httpResponseJsonWriter, invokeResponse.Body); + } } else { From a354cc986f28c15d8915d9d73667f4747eaac75f Mon Sep 17 00:00:00 2001 From: Rido Date: Mon, 26 Jan 2026 06:53:41 -0800 Subject: [PATCH 44/69] Remove CompatMiddlewareAdapter (#286) The CompatMiddlware Adapter was creating a new TurnContext, and that created problems with Middleware. Instead of trying to adapt the middlware, we can just run the BF Middleware pipeline --- core/samples/CompatBot/MyCompatMiddleware.cs | 7 +- core/samples/CompatBot/Program.cs | 1 + .../CompatAdapter.cs | 8 +-- .../CompatAdapterMiddleware.cs | 65 ------------------- 4 files changed, 7 insertions(+), 74 deletions(-) delete mode 100644 core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs diff --git a/core/samples/CompatBot/MyCompatMiddleware.cs b/core/samples/CompatBot/MyCompatMiddleware.cs index 084384b6..ef87a97e 100644 --- a/core/samples/CompatBot/MyCompatMiddleware.cs +++ b/core/samples/CompatBot/MyCompatMiddleware.cs @@ -7,11 +7,14 @@ namespace CompatBot { public class MyCompatMiddleware : Microsoft.Bot.Builder.IMiddleware { - public Task OnTurnAsync(ITurnContext turnContext, NextDelegate next, CancellationToken cancellationToken = default) + public async Task OnTurnAsync(ITurnContext turnContext, NextDelegate next, CancellationToken cancellationToken = default) { Console.WriteLine("MyCompatMiddleware: OnTurnAsync"); Console.WriteLine(turnContext.Activity.Text); - return next(cancellationToken); + + await turnContext.SendActivityAsync(MessageFactory.Text("Hello from MyCompatMiddleware!"), cancellationToken); + + await next(cancellationToken).ConfigureAwait(false); } } } diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index 81f04a1d..ee8614ee 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -32,6 +32,7 @@ CompatAdapter compatAdapter = (CompatAdapter)app.Services.GetRequiredService(); compatAdapter.Use(new MyCompatMiddleware()); +compatAdapter.Use(new MyCompatMiddleware()); app.MapPost("/api/messages", async (IBotFrameworkHttpAdapter adapter, IBot bot, HttpRequest request, HttpResponse response, CancellationToken ct) => await adapter.ProcessAsync(request, response, bot, ct)); diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index 55aa0e6f..4182b9ba 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -89,17 +89,11 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons CompatConnectorClient connectionClient = new(new CompatConversations(_teamsBotApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); turnContext.TurnState.Add(connectionClient); turnContext.TurnState.Add(_teamsBotApplication.TeamsApiClient); - await bot.OnTurnAsync(turnContext, cancellationToken1).ConfigureAwait(false); + await MiddlewareSet.ReceiveActivityWithStatusAsync(turnContext, bot.OnTurnAsync, cancellationToken).ConfigureAwait(false); }; - try { - foreach (Microsoft.Bot.Builder.IMiddleware? middleware in MiddlewareSet) - { - _teamsBotApplication.Use(new CompatAdapterMiddleware(middleware, _sp)); - } - await _teamsBotApplication.ProcessAsync(httpRequest.HttpContext, cancellationToken).ConfigureAwait(false); } catch (Exception ex) diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs deleted file mode 100644 index 1df8acbf..00000000 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapterMiddleware.cs +++ /dev/null @@ -1,65 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using Microsoft.Bot.Builder; -using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.Logging; -using Microsoft.Teams.Bot.Apps; -using Microsoft.Teams.Bot.Core; -using Microsoft.Teams.Bot.Core.Schema; - -namespace Microsoft.Teams.Bot.Compat; - -/// -/// Adapts Bot Framework SDK middleware to work with the Teams Bot Core middleware pipeline. -/// -/// -/// This adapter enables legacy Bot Framework middleware components to be used in the new Teams Bot Core architecture. -/// It converts CoreActivity instances to Bot Framework Activity format, creates appropriate turn contexts with -/// compatibility clients (UserTokenClient and ConnectorClient), and delegates processing to the Bot Framework middleware. -/// This allows gradual migration from Bot Framework SDK to Teams Bot Core while preserving existing middleware investments. -/// -/// The Bot Framework middleware component to adapt into the Teams Bot Core pipeline. -/// The service provider used to resolve required services such as HTTP context accessor and logger. -internal sealed class CompatAdapterMiddleware(IMiddleware bfMiddleWare, IServiceProvider sp) : ITurnMiddleWare -{ - /// - /// Processes a turn by converting the CoreActivity to Bot Framework format and invoking the wrapped middleware. - /// - /// The bot application processing the turn. Must be a TeamsBotApplication instance. - /// The activity to process in Core format. - /// A delegate to invoke the next middleware in the pipeline. - /// A cancellation token that can be used to cancel the asynchronous operation. - /// A task that represents the asynchronous operation. - public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) - { - AspNetCore.Http.IHttpContextAccessor httpContextAccessor = sp.GetRequiredService(); - ILogger logger = sp.GetRequiredService>(); - - if (botApplication is TeamsBotApplication tba) - { -#pragma warning disable CA2000 // Dispose objects before losing scope - TurnContext turnContext = new(new CompatBotAdapter(tba, httpContextAccessor, logger), activity.ToCompatActivity()); -#pragma warning restore CA2000 // Dispose objects before losing scope - turnContext.TurnState.Add( - new CompatUserTokenClient(botApplication.UserTokenClient) - ); - - turnContext.TurnState.Add( - new CompatConnectorClient( - new CompatConversations(botApplication.ConversationClient) - { - ServiceUrl = activity.ServiceUrl?.ToString() - } - ) - ); - - turnContext.TurnState.Add(tba.TeamsApiClient); - - return bfMiddleWare.OnTurnAsync(turnContext, (activity) - => nextTurn(cancellationToken), cancellationToken); - } - return Task.CompletedTask; - } - -} From a1275672e7c5d6be344bba86bd28c7ce26bba81f Mon Sep 17 00:00:00 2001 From: Rido Date: Tue, 27 Jan 2026 10:31:05 -0800 Subject: [PATCH 45/69] Review app Hosting and Auth pipeline (#289) This pull request refactors and improves the bot application hosting and authentication pipeline. The main goals are to defer configuration reading until the service provider is built, avoid building the service provider during service registration (an anti-pattern), and improve logging flexibility and reliability. New options classes are introduced to cleanly pass configuration, and authentication/authorization registration is made safer and more robust. Key changes include: **Configuration and Options Refactoring:** * Introduced `BotClientOptions` and `AuthenticationSchemeOptions` classes to encapsulate bot client and authentication scheme configuration, deferring configuration reading until the service provider is available. [[1]](diffhunk://#diff-65196a45c43063ad64be1ce1c69cd1cf0ddcc2f8b999b5679d74bb6d4a610ff0R1-R20) [[2]](diffhunk://#diff-13be7f71b9314c04c36d3d24e99723628e236cfc008159b22f6d9a862f8c75e0R1-R20) * Refactored `AddTeamsBotApplication` and `AddBotClient` to register options and avoid building the service provider during registration, using `AddOptions().Configure()` instead. [[1]](diffhunk://#diff-a5c655bf5836d61efb23de5aba33c6dc81b61cabaf9341f68c9f2a28afc48b58L26-R47) [[2]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L96-R163) * Updated MSAL configuration to pass the logger as a parameter and select configuration and logger from service descriptors if available, only building a temporary provider as a fallback. **Authentication and Authorization Pipeline:** * Refactored `AddAuthorization` to accept an optional logger and to select configuration and logger from service descriptors, only building a temporary provider if necessary. * Improved JWT Bearer authentication to resolve the logger from request services at runtime, ensuring correct logging context and using a `NullLogger` fallback. [[1]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L106-R121) [[2]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L127-R156) [[3]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L145-R166) [[4]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L156-R177) **Middleware and Endpoint Registration:** * Changed `UseBotApplication` to operate on `IEndpointRouteBuilder` instead of `IApplicationBuilder`, improving flexibility and ensuring authentication/authorization middleware is added safely. **Logging Improvements:** * Ensured that loggers are created from `ILoggerFactory` if available, otherwise defaulting to `NullLogger`, and that logging is robust throughout the authentication and configuration process. [[1]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L65-R81) [[2]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L75-R102) [[3]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L127-R156) **General Code Quality:** * Added missing `using` directives for LINQ and other dependencies. [[1]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7R4-R10) [[2]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70R5) These changes collectively improve the reliability, maintainability, and testability of the bot application hosting and authentication infrastructure. --- **Configuration and Options Refactoring:** - Introduced `BotClientOptions` and `AuthenticationSchemeOptions` classes for encapsulating bot client and authentication scheme configuration, deferring configuration reading until the service provider is available. [[1]](diffhunk://#diff-65196a45c43063ad64be1ce1c69cd1cf0ddcc2f8b999b5679d74bb6d4a610ff0R1-R20) [[2]](diffhunk://#diff-13be7f71b9314c04c36d3d24e99723628e236cfc008159b22f6d9a862f8c75e0R1-R20) - Refactored `AddTeamsBotApplication` and `AddBotClient` to use options registration and avoid building the service provider during registration. [[1]](diffhunk://#diff-a5c655bf5836d61efb23de5aba33c6dc81b61cabaf9341f68c9f2a28afc48b58L26-R47) [[2]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L96-R163) - Updated MSAL configuration to pass the logger as a parameter and to select configuration/logger from service descriptors, only building a temporary provider if necessary. **Authentication and Authorization Pipeline:** - Refactored `AddAuthorization` to accept an optional logger, select configuration/logger from service descriptors, and only build a temporary provider as a fallback. - Improved JWT Bearer authentication to resolve the logger from request services at runtime and use a `NullLogger` fallback, ensuring robust logging. [[1]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L106-R121) [[2]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L127-R156) [[3]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L145-R166) [[4]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L156-R177) **Middleware and Endpoint Registration:** - Changed `UseBotApplication` to work with `IEndpointRouteBuilder` instead of `IApplicationBuilder`, ensuring authentication/authorization middleware is added correctly and improving endpoint mapping flexibility. **Logging Improvements:** - Ensured loggers are created from `ILoggerFactory` when available, otherwise using a `NullLogger`, and improved logging reliability throughout the configuration and authentication process. [[1]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L65-R81) [[2]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L75-R102) [[3]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L127-R156) **General Code Quality:** - Added missing `using` directives for LINQ and other dependencies. [[1]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7R4-R10) [[2]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70R5) --- .../TeamsBotApplication.HostingExtensions.cs | 28 ++-- .../Hosting/AddBotApplicationExtensions.cs | 105 ++++++++++----- .../Hosting/AuthenticationSchemeOptions.cs | 20 +++ .../Hosting/BotClientOptions.cs | 20 +++ .../Hosting/JwtExtensions.cs | 127 +++++++++++++++--- 5 files changed, 242 insertions(+), 58 deletions(-) create mode 100644 core/src/Microsoft.Teams.Bot.Core/Hosting/AuthenticationSchemeOptions.cs create mode 100644 core/src/Microsoft.Teams.Bot.Core/Hosting/BotClientOptions.cs diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs index db2b52c2..c8644507 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs @@ -23,22 +23,28 @@ public static class TeamsBotApplicationHostingExtensions /// The updated WebApplicationBuilder instance. public static IServiceCollection AddTeamsBotApplication(this IServiceCollection services, string sectionName = "AzureAd") { - ServiceProvider sp = services.BuildServiceProvider(); - IConfiguration configuration = sp.GetRequiredService(); - - string scope = "https://api.botframework.com/.default"; - if (!string.IsNullOrEmpty(configuration[$"{sectionName}:Scope"])) - scope = configuration[$"{sectionName}:Scope"]!; - if (!string.IsNullOrEmpty(configuration["Scope"])) - scope = configuration["Scope"]!; + // Register options to defer configuration reading until ServiceProvider is built + services.AddOptions() + .Configure((options, configuration) => + { + options.Scope = "https://api.botframework.com/.default"; + if (!string.IsNullOrEmpty(configuration[$"{sectionName}:Scope"])) + options.Scope = configuration[$"{sectionName}:Scope"]!; + if (!string.IsNullOrEmpty(configuration["Scope"])) + options.Scope = configuration["Scope"]!; + options.SectionName = sectionName; + }); services.AddHttpClient(TeamsApiClient.TeamsHttpClientName) .AddHttpMessageHandler(sp => - new BotAuthenticationHandler( + { + var options = sp.GetRequiredService>().Value; + return new BotAuthenticationHandler( sp.GetRequiredService(), sp.GetRequiredService>(), - scope, - sp.GetService>())); + options.Scope, + sp.GetService>()); + }); services.AddBotApplication(); return services; diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 41c15ace..e264ba45 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -1,10 +1,13 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Linq; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Routing; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Http; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; @@ -29,28 +32,36 @@ public static class AddBotApplicationExtensions /// Configures the application to handle bot messages at the specified route and returns the registered bot /// application instance. /// - /// This method adds authentication and authorization middleware to the request pipeline and maps - /// a POST endpoint for bot messages. The endpoint requires authorization. Ensure that the bot application is - /// registered in the service container before calling this method. + /// This method adds authentication and authorization middleware to the HTTP pipeline and maps + /// a POST endpoint for bot messages. The endpoint requires authorization. Ensure that the bot application + /// is registered in the service container before calling this method. /// The type of the bot application to use. Must inherit from BotApplication. - /// The application builder used to configure the request pipeline. + /// The endpoint route builder used to configure endpoints. /// The route path at which to listen for incoming bot messages. Defaults to "api/messages". /// The registered bot application instance of type TApp. - /// Thrown if the bot application of type TApp is not registered in the application's service container. + /// Thrown if the bot application of type TApp is not registered in the application's service container. public static TApp UseBotApplication( - this IApplicationBuilder builder, + this IEndpointRouteBuilder endpoints, string routePath = "api/messages") where TApp : BotApplication { - ArgumentNullException.ThrowIfNull(builder); - TApp app = builder.ApplicationServices.GetService() ?? throw new InvalidOperationException("Application not registered"); - WebApplication? webApp = builder as WebApplication; - ArgumentNullException.ThrowIfNull(webApp); - webApp.MapPost(routePath, (HttpContext httpContext, CancellationToken cancellationToken) - => app.ProcessAsync(httpContext, cancellationToken) + ArgumentNullException.ThrowIfNull(endpoints); + + // Add authentication and authorization middleware to the pipeline + // This is safe because WebApplication implements both IEndpointRouteBuilder and IApplicationBuilder + if (endpoints is IApplicationBuilder app) + { + app.UseAuthentication(); + app.UseAuthorization(); + } + + TApp botApp = endpoints.ServiceProvider.GetService() ?? throw new InvalidOperationException("Application not registered"); + + endpoints.MapPost(routePath, (HttpContext httpContext, CancellationToken cancellationToken) + => botApp.ProcessAsync(httpContext, cancellationToken) ).RequireAuthorization(); - return app; + return botApp; } /// @@ -62,7 +73,12 @@ public static TApp UseBotApplication( /// public static IServiceCollection AddBotApplication(this IServiceCollection services, string sectionName = "AzureAd") where TApp : BotApplication { - ILogger logger = services.BuildServiceProvider().GetRequiredService>(); + // Extract ILoggerFactory from service collection to create logger without BuildServiceProvider + var loggerFactoryDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(ILoggerFactory)); + var loggerFactory = loggerFactoryDescriptor?.ImplementationInstance as ILoggerFactory; + ILogger logger = loggerFactory?.CreateLogger() + ?? (ILogger)Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + services.AddAuthorization(logger, sectionName); services.AddConversationClient(sectionName); services.AddUserTokenClient(sectionName); @@ -93,16 +109,17 @@ private static IServiceCollection AddBotClient( string httpClientName, string sectionName) where TClient : class { - ServiceProvider sp = services.BuildServiceProvider(); - IConfiguration configuration = sp.GetRequiredService(); - ILogger logger = sp.GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); - ArgumentNullException.ThrowIfNull(configuration); - - string scope = "https://api.botframework.com/.default"; - if (!string.IsNullOrEmpty(configuration[$"{sectionName}:Scope"])) - scope = configuration[$"{sectionName}:Scope"]!; - if (!string.IsNullOrEmpty(configuration["Scope"])) - scope = configuration["Scope"]!; + // Register options to defer scope configuration reading + services.AddOptions() + .Configure((options, configuration) => + { + options.Scope = "https://api.botframework.com/.default"; + if (!string.IsNullOrEmpty(configuration[$"{sectionName}:Scope"])) + options.Scope = configuration[$"{sectionName}:Scope"]!; + if (!string.IsNullOrEmpty(configuration["Scope"])) + options.Scope = configuration["Scope"]!; + options.SectionName = sectionName; + }); services .AddHttpClient() @@ -110,15 +127,40 @@ private static IServiceCollection AddBotClient( .AddInMemoryTokenCaches() .AddAgentIdentities(); - if (services.ConfigureMSAL(configuration, sectionName)) + // Get configuration and logger to configure MSAL during registration + // Try to get from service descriptors first + var configDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(IConfiguration)); + IConfiguration? configuration = configDescriptor?.ImplementationInstance as IConfiguration; + + var loggerFactoryDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(ILoggerFactory)); + var loggerFactory = loggerFactoryDescriptor?.ImplementationInstance as ILoggerFactory; + ILogger logger = loggerFactory?.CreateLogger(typeof(AddBotApplicationExtensions)) + ?? (ILogger)Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + + // If configuration not available as instance, build temporary provider + if (configuration == null) + { + using var tempProvider = services.BuildServiceProvider(); + configuration = tempProvider.GetRequiredService(); + if (loggerFactory == null) + { + logger = tempProvider.GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); + } + } + + // Configure MSAL during registration (not deferred) + if (services.ConfigureMSAL(configuration, sectionName, logger)) { services.AddHttpClient(httpClientName) .AddHttpMessageHandler(sp => - new BotAuthenticationHandler( - sp.GetRequiredService(), - sp.GetRequiredService>(), - scope, - sp.GetService>())); + { + var botOptions = sp.GetRequiredService>().Value; + return new BotAuthenticationHandler( + sp.GetRequiredService(), + sp.GetRequiredService>(), + botOptions.Scope, + sp.GetService>()); + }); } else { @@ -129,10 +171,9 @@ private static IServiceCollection AddBotClient( return services; } - private static bool ConfigureMSAL(this IServiceCollection services, IConfiguration configuration, string sectionName) + private static bool ConfigureMSAL(this IServiceCollection services, IConfiguration configuration, string sectionName, ILogger logger) { ArgumentNullException.ThrowIfNull(configuration); - ILogger logger = services.BuildServiceProvider().GetRequiredService().CreateLogger(typeof(AddBotApplicationExtensions)); if (configuration["MicrosoftAppId"] is not null) { diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/AuthenticationSchemeOptions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AuthenticationSchemeOptions.cs new file mode 100644 index 00000000..6a120c7a --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/AuthenticationSchemeOptions.cs @@ -0,0 +1,20 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace Microsoft.Teams.Bot.Core.Hosting; + +/// +/// Options for determining which authentication scheme to use. +/// +internal sealed class AuthenticationSchemeOptions +{ + /// + /// Gets or sets a value indicating whether to use Agent authentication (true) or Bot authentication (false). + /// + public bool UseAgentAuth { get; set; } + + /// + /// Gets or sets the scope value used to determine the authentication scheme. + /// + public string Scope { get; set; } = "https://api.botframework.com/.default"; +} diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotClientOptions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotClientOptions.cs new file mode 100644 index 00000000..6316cc75 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotClientOptions.cs @@ -0,0 +1,20 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace Microsoft.Teams.Bot.Core.Hosting; + +/// +/// Options for configuring bot client HTTP clients. +/// +internal sealed class BotClientOptions +{ + /// + /// Gets or sets the scope for bot authentication. + /// + public string Scope { get; set; } = "https://api.botframework.com/.default"; + + /// + /// Gets or sets the configuration section name. + /// + public string SectionName { get; set; } = "AzureAd"; +} diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs index 583f2db7..58536188 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs @@ -2,6 +2,7 @@ // Licensed under the MIT License. using System.IdentityModel.Tokens.Jwt; +using System.Linq; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Authentication.JwtBearer; using Microsoft.AspNetCore.Authorization; @@ -72,19 +73,33 @@ public static AuthenticationBuilder AddBotAuthentication(this IServiceCollection /// /// The service collection to add authorization to. /// The configuration section name for the settings. Defaults to "AzureAd". - /// The logger instance for logging. + /// Optional logger instance for logging. If null, a NullLogger will be used. /// An for further authorization configuration. - public static AuthorizationBuilder AddAuthorization(this IServiceCollection services, ILogger logger, string aadSectionName = "AzureAd") + public static AuthorizationBuilder AddAuthorization(this IServiceCollection services, ILogger? logger = null, string aadSectionName = "AzureAd") { - IConfiguration configuration = services.BuildServiceProvider().GetRequiredService(); - string azureScope = configuration[$"Scope"]!; - bool useAgentAuth = false; + // Use NullLogger if no logger provided + logger ??= Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + + // We need IConfiguration to determine which authentication scheme to register (Bot vs Agent) + // This is a registration-time decision that cannot be deferred + // Try to get it from service descriptors first (fast path) + var configDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(IConfiguration)); + IConfiguration? configuration = configDescriptor?.ImplementationInstance as IConfiguration; - if (string.Equals(azureScope, AgentScope, StringComparison.OrdinalIgnoreCase)) + // If not available as ImplementationInstance, build a temporary ServiceProvider + // NOTE: This is generally an anti-pattern, but acceptable here because: + // 1. We need configuration at registration time to select auth scheme + // 2. We properly dispose the temporary ServiceProvider immediately + // 3. This only happens once during application startup + if (configuration == null) { - useAgentAuth = true; + using var tempProvider = services.BuildServiceProvider(); + configuration = tempProvider.GetRequiredService(); } + string? azureScope = configuration["Scope"]; + bool useAgentAuth = string.Equals(azureScope, AgentScope, StringComparison.OrdinalIgnoreCase); + services.AddBotAuthentication(configuration, useAgentAuth, logger, aadSectionName); AuthorizationBuilder authorizationBuilder = services .AddAuthorizationBuilder() @@ -103,7 +118,7 @@ public static AuthorizationBuilder AddAuthorization(this IServiceCollection serv return authorizationBuilder; } - private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuilder builder, string schemeName, string[] validIssuers, string audience, ILogger logger) + private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuilder builder, string schemeName, string[] validIssuers, string audience, ILogger? logger) { builder.AddJwtBearer(schemeName, jwtOptions => { @@ -124,7 +139,13 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild { OnMessageReceived = async context => { - logger.LogDebug("OnMessageReceived invoked for scheme: {Scheme}", schemeName); + // Resolve logger at runtime from request services to ensure we always have proper logging + var loggerFactory = context.HttpContext.RequestServices.GetService(); + var requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") + ?? logger + ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + + requestLogger.LogDebug("OnMessageReceived invoked for scheme: {Scheme}", schemeName); string authorizationHeader = context.Request.Headers.Authorization.ToString(); if (string.IsNullOrEmpty(authorizationHeader)) @@ -132,7 +153,7 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild // Default to AadTokenValidation handling context.Options.TokenValidationParameters.ConfigurationManager ??= jwtOptions.ConfigurationManager as BaseConfigurationManager; await Task.CompletedTask.ConfigureAwait(false); - logger.LogWarning("Authorization header is missing."); + requestLogger.LogWarning("Authorization header is missing for scheme: {Scheme}", schemeName); return; } @@ -142,7 +163,7 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild // Default to AadTokenValidation handling context.Options.TokenValidationParameters.ConfigurationManager ??= jwtOptions.ConfigurationManager as BaseConfigurationManager; await Task.CompletedTask.ConfigureAwait(false); - logger.LogWarning("Invalid authorization header format."); + requestLogger.LogWarning("Invalid authorization header format for scheme: {Scheme}", schemeName); return; } @@ -153,7 +174,7 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild string oidcAuthority = issuer.Equals("https://api.botframework.com", StringComparison.OrdinalIgnoreCase) ? BotOIDC : $"{AgentOIDC}{tid ?? "botframework.com"}/v2.0/.well-known/openid-configuration"; - logger.LogDebug("Using OIDC Authority: {OidcAuthority} for issuer: {Issuer}", oidcAuthority, issuer); + requestLogger.LogDebug("Using OIDC Authority: {OidcAuthority} for issuer: {Issuer}", oidcAuthority, issuer); jwtOptions.ConfigurationManager = new ConfigurationManager( oidcAuthority, @@ -168,17 +189,93 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild }, OnTokenValidated = context => { - logger.LogInformation("Token validated successfully for scheme: {Scheme}", schemeName); + // Resolve logger at runtime + var loggerFactory = context.HttpContext.RequestServices.GetService(); + var requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") + ?? logger + ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + + requestLogger.LogInformation("Token validated successfully for scheme: {Scheme}", schemeName); return Task.CompletedTask; }, OnForbidden = context => { - logger.LogWarning("Forbidden response for scheme: {Scheme}", schemeName); + // Resolve logger at runtime + var loggerFactory = context.HttpContext.RequestServices.GetService(); + var requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") + ?? logger + ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + + requestLogger.LogWarning("Forbidden response for scheme: {Scheme}", schemeName); return Task.CompletedTask; }, OnAuthenticationFailed = context => { - logger.LogWarning("Authentication failed for scheme: {Scheme}. Exception: {Exception}", schemeName, context.Exception); + // Resolve logger at runtime to ensure authentication failures are always logged + var loggerFactory = context.HttpContext.RequestServices.GetService(); + var requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") + ?? logger + ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + + // Extract detailed information for troubleshooting + string? tokenAudience = null; + string? tokenIssuer = null; + string? tokenExpiration = null; + string? tokenSubject = null; + + try + { + // Try to parse the token to extract claims + string authHeader = context.Request.Headers.Authorization.ToString(); + if (!string.IsNullOrEmpty(authHeader) && authHeader.StartsWith("Bearer ", StringComparison.OrdinalIgnoreCase)) + { + string tokenString = authHeader.Substring("Bearer ".Length).Trim(); + var token = new JwtSecurityToken(tokenString); + + tokenAudience = token.Audiences?.FirstOrDefault(); + tokenIssuer = token.Issuer; + tokenExpiration = token.ValidTo.ToString("o"); + tokenSubject = token.Subject; + } + } +#pragma warning disable CA1031 // Do not catch general exception types - we want to continue logging even if token parsing fails + catch + { + // If we can't parse the token, continue with logging the exception + } +#pragma warning restore CA1031 + + // Get configured validation parameters + var validationParams = context.Options?.TokenValidationParameters; + string configuredAudience = validationParams?.ValidAudience ?? "null"; + string configuredAudiences = validationParams?.ValidAudiences != null + ? string.Join(", ", validationParams.ValidAudiences) + : "null"; + string configuredIssuers = validationParams?.ValidIssuers != null + ? string.Join(", ", validationParams.ValidIssuers) + : "null"; + + // Log detailed failure information + requestLogger.LogError(context.Exception, + "JWT Authentication failed for scheme: {Scheme}\n" + + " Failure Reason: {ExceptionMessage}\n" + + " Token Audience: {TokenAudience}\n" + + " Expected Audience: {ConfiguredAudience}\n" + + " Expected Audiences: {ConfiguredAudiences}\n" + + " Token Issuer: {TokenIssuer}\n" + + " Valid Issuers: {ConfiguredIssuers}\n" + + " Token Expiration: {TokenExpiration}\n" + + " Token Subject: {TokenSubject}", + schemeName, + context.Exception.Message, + tokenAudience ?? "Unable to parse", + configuredAudience, + configuredAudiences, + tokenIssuer ?? "Unable to parse", + configuredIssuers, + tokenExpiration ?? "Unable to parse", + tokenSubject ?? "Unable to parse"); + return Task.CompletedTask; } }; From c6fe4dfb7f42e6870261866b440f0dc6566c65f5 Mon Sep 17 00:00:00 2001 From: Mehak Bindra Date: Wed, 28 Jan 2026 15:27:14 -0800 Subject: [PATCH 46/69] [TeamsBotApps] Add all message activity handlers and schema (#282) **Key changes:** **Activity Handler Extensions and Delegates** - Added new handler delegates and extension methods for message update, message delete, and message reaction activities (`OnMessageUpdate`, `OnMessageDelete`, `OnMessageReaction`, `OnMessageReactionAdded`, `OnMessageReactionRemoved`), enabling straightforward registration of handlers for these Teams activity types. - Refactored the invoke handler to use a strongly-typed `Context` and provided an `OnInvoke` extension method for registering invoke handlers. **Routing Infrastructure Enhancements** - Updated the `Route` and `Router` classes to support handler functions that can return a response (`HandlerWithReturn`) and added the `InvokeRouteWithReturn` and `DispatchWithReturnAsync` methods to enable this. - Changed route matching logic to use the `TeamsActivityType` string for more precise activity type matching. --------- Co-authored-by: Rido --- core/samples/TeamsBot/Program.cs | 63 +++--- .../Handlers/InvokeHandler.cs | 31 ++- .../Handlers/MessageDeleteHandler.cs | 44 ++++ .../Handlers/MessageHandler.cs | 8 +- .../Handlers/MessageReactionHandler.cs | 88 ++++++++ .../Handlers/MessageUpdateHandler.cs | 44 ++++ .../Microsoft.Teams.Bot.Apps/Routing/Route.cs | 45 +++- .../Routing/Router.cs | 25 +++ .../Schema/Entities/ClientInfoEntity.cs | 38 ++-- .../Schema/Entities/Entity.cs | 8 - .../Schema/Entities/MentionEntity.cs | 28 +-- .../Schema/Entities/OMessageEntity.cs | 7 +- .../Schema/Entities/ProductInfoEntity.cs | 12 +- .../Schema/Entities/SensitiveUsageEntity.cs | 21 +- .../Schema/Entities/StreamInfoEntity.cs | 23 +- .../MessageActivities/InvokeActivity.cs | 205 ++++++++++++++++++ .../MessageActivities/MessageActivity.cs | 115 +++++----- .../MessageDeleteActivity.cs | 58 +++++ .../MessageReactionActivity.cs | 197 +++++++++++++++++ .../MessageUpdateActivity.cs | 69 ++++++ .../Schema/TeamsActivity.cs | 89 ++++++-- .../Schema/TeamsActivityJsonContext.cs | 4 + .../Schema/TeamsActivityType.cs | 32 ++- .../TeamsBotApplication.cs | 19 +- .../BotApplication.cs | 6 +- .../InvokeActivityTest.cs | 51 +++++ .../MessageActivityTests.cs | 89 ++++---- .../MessageDeleteActivityTests.cs | 86 ++++++++ .../MessageReactionActivityTests.cs | 110 +++++++++- .../MessageUpdateActivityTests.cs | 142 ++++++++++++ .../TeamsActivityBuilderTests.cs | 18 +- .../TeamsActivityTests.cs | 62 +++++- 32 files changed, 1592 insertions(+), 245 deletions(-) create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageDeleteHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageUpdateHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs create mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs create mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageDeleteActivityTests.cs create mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageUpdateActivityTests.cs diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 4b983d70..3216774c 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -11,46 +11,53 @@ var builder = TeamsBotApplication.CreateBuilder(); var teamsApp = builder.Build(); + +teamsApp.OnMessageUpdate(async (context, cancellationToken) => +{ + string updatedText = context.Activity.Text ?? ""; + MessageActivity reply = new($"I saw that you updated your message to: `{updatedText}`"); + await context.SendActivityAsync(reply, cancellationToken); +}); + teamsApp.OnMessage(async (context, cancellationToken) => { await context.SendTypingActivityAsync(cancellationToken); string replyText = $"You sent: `{context.Activity.Text}` in activity of type `{context.Activity.Type}`."; - TeamsActivity reply = TeamsActivity.CreateBuilder() - .WithType(TeamsActivityType.Message) - .WithText(replyText) - .Build(); - + MessageActivity reply = new(replyText); reply.AddMention(context.Activity.From!); await context.SendActivityAsync(reply, cancellationToken); - TeamsActivity feedbackCard = TeamsActivity.CreateBuilder() - .WithType(TeamsActivityType.Message) - .WithAttachment(TeamsAttachment.CreateBuilder() + TeamsAttachment feedbackCard = TeamsAttachment.CreateBuilder() .WithAdaptiveCard(Cards.FeedbackCardObj) - .Build()) - .Build(); - await context.SendActivityAsync(feedbackCard, cancellationToken); + .Build(); + MessageActivity feedbackActivity = new([feedbackCard]); + await context.SendActivityAsync(feedbackActivity, cancellationToken); }); -/* -teamsApp.OnMessageReaction = async (args, context, cancellationToken) => + +teamsApp.OnMessageReaction( async (context, cancellationToken) => { - string reactionsAdded = string.Join(", ", args.ReactionsAdded?.Select(r => r.Type) ?? []); - string reactionsRemoved = string.Join(", ", args.ReactionsRemoved?.Select(r => r.Type) ?? []); + string reactionsAdded = string.Join(", ", context.Activity.ReactionsAdded?.Select(r => r.Type) ?? []); + string reactionsRemoved = string.Join(", ", context.Activity.ReactionsRemoved?.Select(r => r.Type) ?? []); - var reply = TeamsActivity.CreateBuilder() - .WithAttachment(TeamsAttachment.CreateBuilder() + TeamsAttachment reactionsCard = TeamsAttachment.CreateBuilder() .WithAdaptiveCard(Cards.ReactionsCard(reactionsAdded, reactionsRemoved)) - .Build() - ) - .Build(); + .Build(); + MessageActivity reply = new([reactionsCard]); await context.SendActivityAsync(reply, cancellationToken); -}; +}); -teamsApp.OnInvoke = async (context, cancellationToken) => +teamsApp.OnMessageDelete(async (context, cancellationToken) => +{ + + await context.SendActivityAsync("I saw that message you deleted", cancellationToken); +}); + + +teamsApp.OnInvoke(async (context, cancellationToken) => { var valueNode = context.Activity.Value; string? feedbackValue = valueNode?["action"]?["data"]?["feedback"]?.GetValue(); @@ -69,17 +76,7 @@ Type = "application/vnd.microsoft.activity.message", Body = "Invokes are great !!" }; -}; - -//teamsApp.OnActivity = async (activity, ct) => -//{ -// var reply = CoreActivity.CreateBuilder() -// .WithConversationReference(activity) -// .WithProperty("text", "yo") -// .Build(); -// await teamsApp.SendActivityAsync(reply, ct); -//}; -*/ +}); teamsApp.Run(); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs index 8fab5d4c..7b595371 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs @@ -2,7 +2,9 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.Handlers; @@ -14,9 +16,34 @@ namespace Microsoft.Teams.Bot.Apps.Handlers; /// A cancellation token that can be used to cancel the operation. The default value is . /// A task that represents the asynchronous operation. The task result contains the response to the invocation. -public delegate Task InvokeHandler(Context context, CancellationToken cancellationToken = default); - +public delegate Task InvokeHandler(Context context, CancellationToken cancellationToken = default); +/// +/// Provides extension methods for registering handlers for invoke activities in a Teams bot application. +/// +public static class InvokeExtensions +{ + /// + /// Registers a handler for invoke activities. + /// + /// The Teams bot application. + /// The invoke handler to register. + /// The updated Teams bot application. + public static TeamsBotApplication OnInvoke(this TeamsBotApplication app, InvokeHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = TeamsActivityType.Invoke, + Selector = _ => true, + HandlerWithReturn = async (ctx, cancellationToken) => + { + return await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + return app; + } +} /// /// Represents the response returned from an invocation handler, typically used for Adaptive Card actions and task module operations. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageDeleteHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageDeleteHandler.cs new file mode 100644 index 00000000..a0b8c709 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageDeleteHandler.cs @@ -0,0 +1,44 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling message delete activities. +/// +/// +/// +/// +public delegate Task MessageDeleteHandler(Context context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering message delete activity handlers. +/// +public static class MessageDeleteExtensions +{ + /// + /// Registers a handler for message delete activities. + /// + /// + /// + /// + public static TeamsBotApplication OnMessageDelete(this TeamsBotApplication app, MessageDeleteHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = TeamsActivityType.MessageDelete, + Selector = _ => true, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs index 5b117b55..fad0488e 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs @@ -3,8 +3,8 @@ using System.Text.RegularExpressions; using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; -using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Handlers; @@ -33,7 +33,7 @@ public static TeamsBotApplication OnMessage(this TeamsBotApplication app, Messag app.Router.Register(new Route { - Name = ActivityType.Message, + Name = TeamsActivityType.Message, Selector = _ => true, Handler = async (ctx, cancellationToken) => { @@ -58,7 +58,7 @@ public static TeamsBotApplication OnMessage(this TeamsBotApplication app, string app.Router.Register(new Route { - Name = ActivityType.Message, + Name = TeamsActivityType.Message, Selector = msg => regex.IsMatch(msg.Text ?? ""), Handler = async (ctx, cancellationToken) => { @@ -81,7 +81,7 @@ public static TeamsBotApplication OnMessage(this TeamsBotApplication app, Regex ArgumentNullException.ThrowIfNull(app, nameof(app)); app.Router.Register(new Route { - Name = ActivityType.Message, + Name = TeamsActivityType.Message, Selector = msg => regex.IsMatch(msg.Text ?? ""), Handler = async (ctx, cancellationToken) => { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs new file mode 100644 index 00000000..b34c653b --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs @@ -0,0 +1,88 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling message reaction activities. +/// +/// +/// +/// +public delegate Task MessageReactionHandler(Context context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering message reaction activity handlers. +/// +public static class MessageReactionExtensions +{ + /// + /// Registers a handler for message reaction activities. + /// + /// + /// + /// + public static TeamsBotApplication OnMessageReaction(this TeamsBotApplication app, MessageReactionHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = TeamsActivityType.MessageReaction, + Selector = _ => true, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for message reaction activities where reactions were added. + /// + /// + /// + /// + public static TeamsBotApplication OnMessageReactionAdded(this TeamsBotApplication app, MessageReactionHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = TeamsActivityType.MessageReaction, + Selector = activity => activity.ReactionsAdded?.Count > 0, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for message reaction activities where reactions were removed. + /// + /// + /// + /// + public static TeamsBotApplication OnMessageReactionRemoved(this TeamsBotApplication app, MessageReactionHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = TeamsActivityType.MessageReaction, + Selector = activity => activity.ReactionsRemoved?.Count > 0, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageUpdateHandler.cs new file mode 100644 index 00000000..dcb48e98 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageUpdateHandler.cs @@ -0,0 +1,44 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling message update activities. +/// +/// +/// +/// +public delegate Task MessageUpdateHandler(Context context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering message update activity handlers. +/// +public static class MessageUpdateExtensions +{ + /// + /// Registers a handler for message update activities. + /// + /// + /// + /// + public static TeamsBotApplication OnMessageUpdate(this TeamsBotApplication app, MessageUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = TeamsActivityType.MessageUpdate, + Selector = _ => true, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs index 914cc10e..20a22d62 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. +using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; namespace Microsoft.Teams.Bot.Apps.Routing; @@ -29,6 +30,14 @@ public abstract class RouteBase /// /// public abstract Task InvokeRoute(Context ctx, CancellationToken cancellationToken = default); + + /// + /// Invokes the route handler if the activity matches the expected type and returns a response + /// + /// + /// + /// + public abstract Task InvokeRouteWithReturn(Context ctx, CancellationToken cancellationToken = default); } /// @@ -55,7 +64,12 @@ public override string Name /// /// Handler function to process the activity /// - public Func, CancellationToken, Task> Handler { get; set; } = (_, __) => Task.CompletedTask; + public Func, CancellationToken, Task>? Handler { get; set; } + + /// + /// Handler function to process the activity and return a response + /// + public Func, CancellationToken, Task>? HandlerWithReturn { get; set; } /// /// Determines if the route matches the given activity @@ -64,7 +78,8 @@ public override string Name /// public override bool Matches(TeamsActivity activity) { - return activity is TActivity typedActivity && Selector(typedActivity); + ArgumentNullException.ThrowIfNull(activity); + return (activity.Type.Equals(Name, StringComparison.Ordinal)) && Selector((TActivity)activity); } /// @@ -79,7 +94,31 @@ public override async Task InvokeRoute(Context ctx, CancellationT if (ctx.Activity is TActivity typedActivity) { Context typedContext = new(ctx.TeamsBotApplication, typedActivity); - await Handler(typedContext, cancellationToken).ConfigureAwait(false); + if (Handler is not null) + { + await Handler(typedContext, cancellationToken).ConfigureAwait(false); + } + } + } + + /// + /// Invokes the route handler if the activity matches the expected type and returns a response + /// + /// + /// + /// + /// + public override async Task InvokeRouteWithReturn(Context ctx, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(ctx); + if (ctx.Activity is TActivity typedActivity) + { + Context typedContext = new(ctx.TeamsBotApplication, typedActivity); + if (HandlerWithReturn is not null) + { + return await HandlerWithReturn(typedContext, cancellationToken).ConfigureAwait(false); + } } + return null!; // TODO: throw? } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs index 1c1aa3a1..9c9ccbf5 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. +using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; namespace Microsoft.Teams.Bot.Apps.Routing; @@ -54,6 +55,7 @@ public IEnumerable> SelectAll(TActivity activity) wh public async Task DispatchAsync(Context ctx, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(ctx); + // TODO : support multiple routes? foreach (var route in _routes) { @@ -64,4 +66,27 @@ public async Task DispatchAsync(Context ctx, CancellationToken ca } } } + + /// + /// Dispatches the specified activity context to all matching routes and returns the result of the invocation. + /// + /// The activity context to dispatch. Cannot be null. + /// A cancellation token that can be used to cancel the operation. + /// A task that represents the asynchronous operation. The task result contains a response object with the outcome + /// of the invocation. + public async Task DispatchWithReturnAsync(Context ctx, CancellationToken cancellationToken = default) + { + ArgumentNullException.ThrowIfNull(ctx); + + // TODO : support multiple routes? + foreach (var route in _routes) + { + if (route.Matches(ctx.Activity)) + { + return await route.InvokeRouteWithReturn(ctx, cancellationToken).ConfigureAwait(false); + } + } + + return null!; // TODO : return appropriate response + } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs index 57d0b856..91317cf9 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs @@ -59,7 +59,6 @@ public class ClientInfoEntity : Entity /// public ClientInfoEntity() : base("clientInfo") { - ToProperties(); } @@ -76,36 +75,45 @@ public ClientInfoEntity(string platform, string country, string timezone, string Country = country; Platform = platform; Timezone = timezone; - ToProperties(); } + /// /// Gets or sets the locale information. /// - [JsonPropertyName("locale")] public string? Locale { get; set; } + [JsonPropertyName("locale")] + public string? Locale + { + get => base.Properties.TryGetValue("locale", out var value) ? value?.ToString() : null; + set => base.Properties["locale"] = value; + } /// /// Gets or sets the country information. /// - [JsonPropertyName("country")] public string? Country { get; set; } + [JsonPropertyName("country")] + public string? Country + { + get => base.Properties.TryGetValue("country", out var value) ? value?.ToString() : null; + set => base.Properties["country"] = value; + } /// /// Gets or sets the platform information. /// - [JsonPropertyName("platform")] public string? Platform { get; set; } + [JsonPropertyName("platform")] + public string? Platform + { + get => base.Properties.TryGetValue("platform", out var value) ? value?.ToString() : null; + set => base.Properties["platform"] = value; + } /// /// Gets or sets the timezone information. /// - [JsonPropertyName("timezone")] public string? Timezone { get; set; } - - /// - /// Adds custom fields as properties. - /// - public override void ToProperties() + [JsonPropertyName("timezone")] + public string? Timezone { - base.Properties.Add("locale", Locale); - base.Properties.Add("country", Country); - base.Properties.Add("platform", Platform); - base.Properties.Add("timezone", Timezone); + get => base.Properties.TryGetValue("timezone", out var value) ? value?.ToString() : null; + set => base.Properties["timezone"] = value; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs index b0186cb3..7a95ce14 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs @@ -110,14 +110,6 @@ public class Entity(string type) [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; #pragma warning restore CA2227 // Collection properties should be read only - /// - /// Adds properties to the Properties dictionary. - /// - public virtual void ToProperties() - { - throw new NotImplementedException(); - } - } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs index 65ce17db..07dc22b2 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs @@ -4,6 +4,7 @@ using System.Text.Json; using System.Text.Json.Nodes; using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema.Entities; @@ -43,7 +44,7 @@ public static MentionEntity AddMention(this TeamsActivity activity, Conversation string? mentionText = text ?? account.Name; if (addText) { - string? currentText = activity.Properties.TryGetValue("text", out object? value) ? value?.ToString() : null; + string? currentText = activity.Properties.TryGetValue("text", out var t) ? t?.ToString() : null; activity.Properties["text"] = $"{mentionText} {currentText}"; } activity.Entities ??= []; @@ -73,18 +74,27 @@ public MentionEntity(ConversationAccount mentioned, string? text) : base("mentio { Mentioned = mentioned; Text = text; - ToProperties(); } /// /// Mentioned conversation account. /// - [JsonPropertyName("mentioned")] public ConversationAccount? Mentioned { get; set; } + [JsonPropertyName("mentioned")] + public ConversationAccount? Mentioned + { + get => base.Properties.TryGetValue("mentioned", out var value) ? value as ConversationAccount : null; + set => base.Properties["mentioned"] = value; + } /// /// Text of the mention. /// - [JsonPropertyName("text")] public string? Text { get; set; } + [JsonPropertyName("text")] + public string? Text + { + get => base.Properties.TryGetValue("text", out var value) ? value?.ToString() : null; + set => base.Properties["text"] = value; + } /// /// Creates a new instance of the MentionEntity class from the specified JSON node. @@ -103,16 +113,6 @@ public static MentionEntity FromJsonElement(JsonNode? jsonNode) : throw new ArgumentNullException(nameof(jsonNode), "mentioned property is required"), Text = jsonNode?["text"]?.GetValue() }; - res.ToProperties(); return res; } - - /// - /// Adds custom fields as properties. - /// - public override void ToProperties() - { - base.Properties.Add("mentioned", Mentioned); - base.Properties.Add("text", Text); - } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs index 4edbafc9..efb6da3c 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs @@ -23,6 +23,11 @@ public OMessageEntity() : base("https://schema.org/Message") /// /// Gets or sets the additional type. /// - [JsonPropertyName("additionalType")] public IList? AdditionalType { get; set; } + [JsonPropertyName("additionalType")] + public IList? AdditionalType + { + get => base.Properties.TryGetValue("additionalType", out var value) ? value as IList : null; + set => base.Properties["additionalType"] = value; + } } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs index a56a4442..995e2d39 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs @@ -17,16 +17,14 @@ public class ProductInfoEntity : Entity /// Creates a new instance of . /// public ProductInfoEntity() : base("ProductInfo") { } - /// - /// Ids the product id. - /// - [JsonPropertyName("id")] public string? Id { get; set; } /// - /// Adds custom fields as properties. + /// Gets or sets the product id. /// - public override void ToProperties() + [JsonPropertyName("id")] + public string? Id { - + get => base.Properties.TryGetValue("id", out var value) ? value?.ToString() : null; + set => base.Properties["id"] = value; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs index 6e6444c1..87ba6482 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs @@ -19,17 +19,32 @@ public class SensitiveUsageEntity : OMessageEntity /// /// Gets or sets the name of the sensitive usage. /// - [JsonPropertyName("name")] public required string Name { get; set; } + [JsonPropertyName("name")] + public required string Name + { + get => base.Properties.TryGetValue("name", out var value) ? value?.ToString() ?? string.Empty : string.Empty; + set => base.Properties["name"] = value; + } /// /// Gets or sets the description of the sensitive usage. /// - [JsonPropertyName("description")] public string? Description { get; set; } + [JsonPropertyName("description")] + public string? Description + { + get => base.Properties.TryGetValue("description", out var value) ? value?.ToString() : null; + set => base.Properties["description"] = value; + } /// /// Gets or sets the pattern associated with the sensitive usage. /// - [JsonPropertyName("pattern")] public DefinedTerm? Pattern { get; set; } + [JsonPropertyName("pattern")] + public DefinedTerm? Pattern + { + get => base.Properties.TryGetValue("pattern", out var value) ? value as DefinedTerm : null; + set => base.Properties["pattern"] = value; + } } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs index 718bf7ab..5649e513 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs @@ -18,17 +18,34 @@ public StreamInfoEntity() : base("streaminfo") { } /// /// Gets or sets the stream id. /// - [JsonPropertyName("streamId")] public string? StreamId { get; set; } + [JsonPropertyName("streamId")] + public string? StreamId + { + get => base.Properties.TryGetValue("streamId", out var value) ? value?.ToString() : null; + set => base.Properties["streamId"] = value; + } /// /// Gets or sets the stream type. See for possible values. /// - [JsonPropertyName("streamType")] public string? StreamType { get; set; } + [JsonPropertyName("streamType")] + public string? StreamType + { + get => base.Properties.TryGetValue("streamType", out var value) ? value?.ToString() : null; + set => base.Properties["streamType"] = value; + } /// /// Gets or sets the stream sequence. /// - [JsonPropertyName("streamSequence")] public int? StreamSequence { get; set; } + [JsonPropertyName("streamSequence")] + public int? StreamSequence + { + get => base.Properties.TryGetValue("streamSequence", out var value) && value != null + ? (int.TryParse(value.ToString(), out var intVal) ? intVal : null) + : null; + set => base.Properties["streamSequence"] = value; + } } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs new file mode 100644 index 00000000..7f14b6c3 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs @@ -0,0 +1,205 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +/// +/// Represents an invoke activity. +/// +public class InvokeActivity : TeamsActivity +{ + /// + /// Creates an InvokeActivity from a CoreActivity. + /// + /// + /// + public static new InvokeActivity FromActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + return new InvokeActivity(activity); + } + + /// + /// Convenience method to deserialize a JSON string into an InvokeActivity instance. + /// + /// + /// + public static new InvokeActivity FromJsonString(string json) + { + return FromJsonString(json, TeamsActivityJsonContext.Default.InvokeActivity); + } + + /// + /// Gets or sets the name of the operation. See for common values. + /// + [JsonPropertyName("name")] + public string? Name + { + get => base.Properties.TryGetValue("name", out var value) ? value?.ToString() : null; + set => base.Properties["name"] = value; + } + ///// + ///// Gets or sets a value that is associated with the activity. + ///// + //[JsonPropertyName("value")] + //public object? Value { get; set; } + + /// + /// Initializes a new instance of the class. + /// + [JsonConstructor] + public InvokeActivity() : base(TeamsActivityType.Invoke) + { + } + + /// + /// Initializes a new instance of the class with the specified name. + /// + /// The invoke operation name. + + public InvokeActivity(string name) : base(TeamsActivityType.Invoke) + { + Name = name; + } + + /// + /// Initializes a new instance of the InvokeActivity class with the specified core activity. + /// + /// The core activity to be invoked. Cannot be null. + protected InvokeActivity(CoreActivity activity) : base(TeamsActivityType.Invoke) + { + ArgumentNullException.ThrowIfNull(activity); + this.Value = activity.Value; + this.ChannelId = activity.ChannelId; + this.ChannelData = new TeamsChannelData(activity.ChannelData); + this.ServiceUrl = activity.ServiceUrl; + this.Conversation = new TeamsConversation(activity.Conversation); + this.From = new TeamsConversationAccount(activity.From); + this.Recipient = new TeamsConversationAccount(activity.Recipient); + this.Properties = activity.Properties; + } +} + +/// +/// String constants for invoke activity names. +/// +public static class InvokeNames +{ + /// + /// Execute action invoke name. + /// + public const string ExecuteAction = "actionableMessage/executeAction"; + + /// + /// File consent invoke name. + /// + public const string FileConsent = "fileConsent/invoke"; + + /// + /// Handoff invoke name. + /// + public const string Handoff = "handoff/action"; + + /// + /// Search invoke name. + /// + public const string Search = "search"; + + /// + /// Adaptive card action invoke name. + /// + public const string AdaptiveCardAction = "adaptiveCard/action"; + + /// + /// Config fetch invoke name. + /// + public const string ConfigFetch = "config/fetch"; + + /// + /// Config submit invoke name. + /// + public const string ConfigSubmit = "config/submit"; + + /// + /// Tab fetch invoke name. + /// + public const string TabFetch = "tab/fetch"; + + /// + /// Tab submit invoke name. + /// + public const string TabSubmit = "tab/submit"; + + /// + /// Task fetch invoke name. + /// + public const string TaskFetch = "task/fetch"; + + /// + /// Task submit invoke name. + /// + public const string TaskSubmit = "task/submit"; + + /// + /// Sign-in token exchange invoke name. + /// + public const string SignInTokenExchange = "signin/tokenExchange"; + + /// + /// Sign-in verify state invoke name. + /// + public const string SignInVerifyState = "signin/verifyState"; + + /// + /// Message submit action invoke name. + /// + public const string MessageSubmitAction = "message/submitAction"; + + /// + /// Message extension anonymous query link invoke name. + /// + public const string MessageExtensionAnonQueryLink = "composeExtension/anonymousQueryLink"; + + /// + /// Message extension card button clicked invoke name. + /// + public const string MessageExtensionCardButtonClicked = "composeExtension/onCardButtonClicked"; + + /// + /// Message extension fetch task invoke name. + /// + public const string MessageExtensionFetchTask = "composeExtension/fetchTask"; + + /// + /// Message extension query invoke name. + /// + public const string MessageExtensionQuery = "composeExtension/query"; + + /// + /// Message extension query link invoke name. + /// + public const string MessageExtensionQueryLink = "composeExtension/queryLink"; + + /// + /// Message extension query setting URL invoke name. + /// + public const string MessageExtensionQuerySettingUrl = "composeExtension/querySettingUrl"; + + /// + /// Message extension select item invoke name. + /// + public const string MessageExtensionSelectItem = "composeExtension/selectItem"; + + /// + /// Message extension setting invoke name. + /// + public const string MessageExtensionSetting = "composeExtension/setting"; + + /// + /// Message extension submit action invoke name. + /// + public const string MessageExtensionSubmitAction = "composeExtension/submitAction"; +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs index 3a9afe46..a320da5b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs @@ -31,10 +31,7 @@ public class MessageActivity : TeamsActivity /// A MessageActivity instance. public static new MessageActivity FromJsonString(string json) { - MessageActivity activity = JsonSerializer.Deserialize( - json, TeamsActivityJsonContext.Default.MessageActivity)!; - activity.Rebase(); - return activity; + return FromJsonString(json, TeamsActivityJsonContext.Default.MessageActivity); } /// @@ -48,7 +45,7 @@ public class MessageActivity : TeamsActivity /// Default constructor. /// [JsonConstructor] - public MessageActivity() : base(ActivityType.Message) + public MessageActivity() : base(TeamsActivityType.Message) { } @@ -56,111 +53,121 @@ public MessageActivity() : base(ActivityType.Message) /// Initializes a new instance of the class with the specified text. /// /// The text content of the message. - public MessageActivity(string text) : base(ActivityType.Message) + public MessageActivity(string text) : base(TeamsActivityType.Message) { Text = text; } + + /// + /// Initializes a new instance of the class with the specified text. + /// + /// The list of attachments for the message. + public MessageActivity(IList attachments) : base(TeamsActivityType.Message) + { + Attachments = attachments; + } + /// /// Internal constructor to create MessageActivity from CoreActivity. /// /// The CoreActivity to convert. protected MessageActivity(CoreActivity activity) : base(activity) { - if (activity.Properties.TryGetValue("text", out var text)) - { - Text = text?.ToString(); - } - if (activity.Properties.TryGetValue("speak", out var speak)) - { - Speak = speak?.ToString(); - } - if (activity.Properties.TryGetValue("inputHint", out var inputHint)) - { - InputHint = inputHint?.ToString(); - } - if (activity.Properties.TryGetValue("summary", out var summary)) - { - Summary = summary?.ToString(); - } - if (activity.Properties.TryGetValue("textFormat", out var textFormat)) - { - TextFormat = textFormat?.ToString(); - } - if (activity.Properties.TryGetValue("attachmentLayout", out var attachmentLayout)) - { - AttachmentLayout = attachmentLayout?.ToString(); - } - if (activity.Properties.TryGetValue("importance", out var importance)) - { - Importance = importance?.ToString(); - } - if (activity.Properties.TryGetValue("deliveryMode", out var deliveryMode)) - { - DeliveryMode = deliveryMode?.ToString(); - } - if (activity.Properties.TryGetValue("expiration", out var expiration) && expiration != null) - { - if (DateTime.TryParse(expiration.ToString(), out var expirationDate)) - { - Expiration = expirationDate; - } - } } /// /// Gets or sets the text content of the message. /// [JsonPropertyName("text")] - public string? Text { get; set; } + public string? Text + { + get => base.Properties.TryGetValue("text", out var value) ? value?.ToString() : null; + set => base.Properties["text"] = value; + } /// /// Gets or sets the SSML speak content of the message. /// [JsonPropertyName("speak")] - public string? Speak { get; set; } + public string? Speak + { + get => base.Properties.TryGetValue("speak", out var value) ? value?.ToString() : null; + set => base.Properties["speak"] = value; + } /// /// Gets or sets the input hint. See for common values. /// [JsonPropertyName("inputHint")] - public string? InputHint { get; set; } + public string? InputHint + { + get => base.Properties.TryGetValue("inputHint", out var value) ? value?.ToString() : null; + set => base.Properties["inputHint"] = value; + } /// /// Gets or sets the summary of the message. /// [JsonPropertyName("summary")] - public string? Summary { get; set; } + public string? Summary + { + get => base.Properties.TryGetValue("summary", out var value) ? value?.ToString() : null; + set => base.Properties["summary"] = value; + } /// /// Gets or sets the text format. See for common values. /// [JsonPropertyName("textFormat")] - public string? TextFormat { get; set; } + public string? TextFormat + { + get => base.Properties.TryGetValue("textFormat", out var value) ? value?.ToString() : null; + set => base.Properties["textFormat"] = value; + } /// /// Gets or sets the attachment layout. /// [JsonPropertyName("attachmentLayout")] - public string? AttachmentLayout { get; set; } + public string? AttachmentLayout + { + get => base.Properties.TryGetValue("attachmentLayout", out var value) ? value?.ToString() : null; + set => base.Properties["attachmentLayout"] = value; + } /// /// Gets or sets the importance. See for common values. /// [JsonPropertyName("importance")] - public string? Importance { get; set; } + public string? Importance + { + get => base.Properties.TryGetValue("importance", out var value) ? value?.ToString() : null; + set => base.Properties["importance"] = value; + } /// /// Gets or sets the delivery mode. See for common values. /// [JsonPropertyName("deliveryMode")] - public string? DeliveryMode { get; set; } + public string? DeliveryMode + { + get => base.Properties.TryGetValue("deliveryMode", out var value) ? value?.ToString() : null; + set => base.Properties["deliveryMode"] = value; + } /// /// Gets or sets the expiration time of the message. /// [JsonPropertyName("expiration")] - public DateTime? Expiration { get; set; } + public DateTime? Expiration + { + get => base.Properties.TryGetValue("expiration", out var value) && value != null + ? (DateTime.TryParse(value.ToString(), out var date) ? date : null) + : null; + set => base.Properties["expiration"] = value; + } + } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs new file mode 100644 index 00000000..02292fd2 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs @@ -0,0 +1,58 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +/// +/// Represents a message delete activity. +/// +public class MessageDeleteActivity : TeamsActivity +{ + /// + /// Convenience method to create a MessageDeleteActivity from a CoreActivity. + /// + /// The CoreActivity to convert. + /// A MessageDeleteActivity instance. + public static new MessageDeleteActivity FromActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + return new MessageDeleteActivity(activity); + } + + /// + /// Deserializes a JSON string into a MessageDeleteActivity instance. + /// + /// The JSON string to deserialize. + /// A MessageDeleteActivity instance. + public static new MessageDeleteActivity FromJsonString(string json) + { + return FromJsonString(json, TeamsActivityJsonContext.Default.MessageDeleteActivity); + } + + /// + /// Serializes the MessageDeleteActivity to JSON with all message delete-specific properties. + /// + /// JSON string representation of the MessageDeleteActivity + public new string ToJson() + => ToJson(TeamsActivityJsonContext.Default.MessageDeleteActivity); + + /// + /// Default constructor. + /// + [JsonConstructor] + public MessageDeleteActivity() : base(TeamsActivityType.MessageDelete) + { + } + + /// + /// Internal constructor to create MessageDeleteActivity from CoreActivity. + /// + /// The CoreActivity to convert. + protected MessageDeleteActivity(CoreActivity activity) : base(activity) + { + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs new file mode 100644 index 00000000..8b918211 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs @@ -0,0 +1,197 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Collections.Generic; +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +/// +/// Represents a message reaction activity. +/// +[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] +public class MessageReactionActivity : TeamsActivity +{ + /// + /// Convenience method to create a MessageReactionActivity from a CoreActivity. + /// + /// The CoreActivity to convert. + /// A MessageReactionActivity instance. + public static new MessageReactionActivity FromActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + return new MessageReactionActivity(activity); + } + + /// + /// Deserializes a JSON string into a MessageReactionActivity instance. + /// + /// The JSON string to deserialize. + /// A MessageReactionActivity instance. + public static new MessageReactionActivity FromJsonString(string json) + { + return FromJsonString(json, TeamsActivityJsonContext.Default.MessageReactionActivity); + } + + /// + /// Serializes the MessageReactionActivity to JSON with all message reaction-specific properties. + /// + /// JSON string representation of the MessageReactionActivity + public new string ToJson() + => ToJson(TeamsActivityJsonContext.Default.MessageReactionActivity); + + /// + /// Default constructor. + /// + [JsonConstructor] + public MessageReactionActivity() : base(TeamsActivityType.MessageReaction) + { + } + + /// + /// Internal constructor to create MessageReactionActivity from CoreActivity. + /// + /// The CoreActivity to convert. + protected MessageReactionActivity(CoreActivity activity) : base(activity) + { + if (activity.Properties.TryGetValue("reactionsAdded", out var reactionsAdded)) + { + ReactionsAdded = JsonSerializer.Deserialize>( + reactionsAdded?.ToString() ?? "[]"); + } + if (activity.Properties.TryGetValue("reactionsRemoved", out var reactionsRemoved)) + { + ReactionsRemoved = JsonSerializer.Deserialize>( + reactionsRemoved?.ToString() ?? "[]"); + } + } + + /// + /// Gets or sets the reactions added to the message. + /// + [JsonPropertyName("reactionsAdded")] + public IList? ReactionsAdded { get; set; } + + /// + /// Gets or sets the reactions removed from the message. + /// + [JsonPropertyName("reactionsRemoved")] + public IList? ReactionsRemoved { get; set; } +} + +/// +/// Represents a reaction to a message. +/// +public class MessageReaction +{ + /// + /// Gets or sets the type of reaction. + /// + [JsonPropertyName("type")] + public string? Type { get; set; } + + /// + /// Gets or sets the date and time when the reaction was created. + /// + [JsonPropertyName("createdDateTime")] + public DateTime? CreatedDateTime { get; set; } + + /// + /// Gets or sets the user who created the reaction. + /// + [JsonPropertyName("user")] + public ReactionUser? User { get; set; } +} + +/// +/// Represents a user who created a reaction. +/// +public class ReactionUser +{ + /// + /// Gets or sets the user identifier. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Gets or sets the user identity type. + /// + [JsonPropertyName("userIdentityType")] + public string? UserIdentityType { get; set; } + + /// + /// Gets or sets the display name of the user. + /// + [JsonPropertyName("displayName")] + public string? DisplayName { get; set; } +} + +/// +/// String constants for reaction types. +/// +public static class ReactionTypes +{ + /// + /// Like reaction. + /// + public const string Like = "like"; + + /// + /// Heart reaction. + /// + public const string Heart = "heart"; + + /// + /// Laugh reaction. + /// + public const string Laugh = "laugh"; + + /// + /// Surprise reaction. + /// + public const string Surprise = "surprise"; + + /// + /// Sad reaction. + /// + public const string Sad = "sad"; + + /// + /// Angry reaction. + /// + public const string Angry = "angry"; + + /// + /// Plus one reaction. + /// + public const string PlusOne = "plusOne"; +} + +/// +/// String constants for user identity types. +/// +public static class UserIdentityTypes +{ + /// + /// Azure Active Directory user. + /// + public const string AadUser = "aadUser"; + + /// + /// On-premise Azure Active Directory user. + /// + public const string OnPremiseAadUser = "onPremiseAadUser"; + + /// + /// Anonymous guest user. + /// + public const string AnonymousGuest = "anonymousGuest"; + + /// + /// Federated user. + /// + public const string FederatedUser = "federatedUser"; +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs new file mode 100644 index 00000000..2133a881 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs @@ -0,0 +1,69 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +/// +/// Represents a message update activity. +/// +public class MessageUpdateActivity : MessageActivity +{ + /// + /// Convenience method to create a MessageUpdateActivity from a CoreActivity. + /// + /// The CoreActivity to convert. + /// A MessageUpdateActivity instance. + public static new MessageUpdateActivity FromActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + return new MessageUpdateActivity(activity); + } + + /// + /// Deserializes a JSON string into a MessageUpdateActivity instance. + /// + /// The JSON string to deserialize. + /// A MessageUpdateActivity instance. + public static new MessageUpdateActivity FromJsonString(string json) + { + return FromJsonString(json, TeamsActivityJsonContext.Default.MessageUpdateActivity); + } + + /// + /// Serializes the MessageUpdateActivity to JSON with all message update-specific properties. + /// + /// JSON string representation of the MessageUpdateActivity + public new string ToJson() + => ToJson(TeamsActivityJsonContext.Default.MessageUpdateActivity); + + /// + /// Default constructor. + /// + [JsonConstructor] + public MessageUpdateActivity() : base() + { + Type = TeamsActivityType.MessageUpdate; + } + + /// + /// Initializes a new instance of the class with the specified text. + /// + /// The text content of the message. + public MessageUpdateActivity(string text) : base(text) + { + Type = TeamsActivityType.MessageUpdate; + } + + /// + /// Internal constructor to create MessageUpdateActivity from CoreActivity. + /// + /// The CoreActivity to convert. + protected MessageUpdateActivity(CoreActivity activity) : base(activity) + { + Type = TeamsActivityType.MessageUpdate; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs index e2680bd7..1775eb1e 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Text; using System.Text.Json; using System.Text.Json.Serialization; using System.Text.Json.Serialization.Metadata; using Microsoft.Teams.Bot.Apps.Schema.Entities; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema; @@ -25,11 +25,9 @@ public static TeamsActivity FromActivity(CoreActivity activity) { ArgumentNullException.ThrowIfNull(activity); - return activity.Type switch - { - ActivityType.Message => MessageActivity.FromActivity(activity), - _ => new TeamsActivity(activity) // Fallback to base type - }; + return TeamsActivityType.ActivityDeserializerMap.TryGetValue(activity.Type, out var factory) + ? factory.FromActivity(activity) + : new TeamsActivity(activity); // Fallback to base type } /// @@ -37,9 +35,42 @@ public static TeamsActivity FromActivity(CoreActivity activity) /// /// /// - public static new TeamsActivity FromJsonString(string json) => - FromJsonString(json, TeamsActivityJsonContext.Default.TeamsActivity) - .Rebase(); + public static new TeamsActivity FromJsonString(string json) + { + string? type = null; + var jsonBytes = Encoding.UTF8.GetBytes(json); + var reader = new Utf8JsonReader(jsonBytes); + + while (reader.Read()) + { + if (reader.TokenType == JsonTokenType.PropertyName && + reader.ValueTextEquals("type"u8)) + { + reader.Read(); + type = reader.GetString(); + break; + } + } + + return type != null && TeamsActivityType.ActivityDeserializerMap.TryGetValue(type, out var factory) + ? factory.FromJson(json) + : FromJsonString(json, TeamsActivityJsonContext.Default.TeamsActivity); + } + + /// + /// Creates a new instance of the specified activity type from JSON string. + /// + /// The expected activity type. + /// The JSON string to deserialize. + /// The JSON type info for deserialization. + /// An activity of type T. + public static T FromJsonString(string json, JsonTypeInfo typeInfo) where T : TeamsActivity + { + T activity = JsonSerializer.Deserialize(json, typeInfo)!; + activity.Rebase(); + return activity; + } + /// /// Overrides the ToJson method to serialize the TeamsActivity object to a JSON string. @@ -52,12 +83,9 @@ public static TeamsActivity FromActivity(CoreActivity activity) /// Constructor with type parameter. /// /// - public TeamsActivity(string type) + protected TeamsActivity(string type) : this() { Type = type; - From = new TeamsConversationAccount(); - Recipient = new TeamsConversationAccount(); - Conversation = new TeamsConversation(); } /// @@ -71,9 +99,6 @@ public TeamsActivity() Conversation = new TeamsConversation(); } - private static TeamsActivity FromJsonString(string json, JsonTypeInfo options) - => JsonSerializer.Deserialize(json, options)!; - /// /// Protected constructor to create TeamsActivity from CoreActivity. /// Allows derived classes to call via base(activity). @@ -104,10 +129,6 @@ internal TeamsActivity Rebase() { base.Attachments = this.Attachments?.ToJsonArray(); base.Entities = this.Entities?.ToJsonArray(); - base.ChannelData = new TeamsChannelData(this.ChannelData); - base.From = this.From; - base.Recipient = this.Recipient; - base.Conversation = this.Conversation; return this; } @@ -116,22 +137,42 @@ internal TeamsActivity Rebase() /// /// Gets or sets the account information for the sender of the Teams conversation. /// - [JsonPropertyName("from")] public new TeamsConversationAccount From { get; set; } + [JsonPropertyName("from")] + public new TeamsConversationAccount From + { + get => (base.From as TeamsConversationAccount) ?? new TeamsConversationAccount(base.From); + set => base.From = value; + } /// /// Gets or sets the account information for the recipient of the Teams conversation. /// - [JsonPropertyName("recipient")] public new TeamsConversationAccount Recipient { get; set; } + [JsonPropertyName("recipient")] + public new TeamsConversationAccount Recipient + { + get => (base.Recipient as TeamsConversationAccount) ?? new TeamsConversationAccount(base.Recipient); + set => base.Recipient = value; + } /// /// Gets or sets the conversation information for the Teams conversation. /// - [JsonPropertyName("conversation")] public new TeamsConversation Conversation { get; set; } + [JsonPropertyName("conversation")] + public new TeamsConversation Conversation + { + get => (base.Conversation as TeamsConversation) ?? new TeamsConversation(base.Conversation); + set => base.Conversation = value; + } /// /// Gets or sets the Teams-specific channel data associated with this activity. /// - [JsonPropertyName("channelData")] public new TeamsChannelData? ChannelData { get; set; } + [JsonPropertyName("channelData")] + public new TeamsChannelData? ChannelData + { + get => base.ChannelData as TeamsChannelData; + set => base.ChannelData = value; + } /// /// Gets or sets the entities specific to Teams. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs index 51fe8a3f..c9f31db6 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs @@ -19,6 +19,10 @@ namespace Microsoft.Teams.Bot.Apps.Schema; [JsonSerializable(typeof(CoreActivity))] [JsonSerializable(typeof(TeamsActivity))] [JsonSerializable(typeof(MessageActivity))] +[JsonSerializable(typeof(MessageReactionActivity))] +[JsonSerializable(typeof(MessageUpdateActivity))] +[JsonSerializable(typeof(MessageDeleteActivity))] +[JsonSerializable(typeof(InvokeActivity))] [JsonSerializable(typeof(Entity))] [JsonSerializable(typeof(EntityList))] [JsonSerializable(typeof(MentionEntity))] diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs index edc8f6a5..9795fb82 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema; @@ -24,21 +25,34 @@ public static class TeamsActivityType public const string Typing = ActivityType.Typing; /// - /// Represents an invoke activity. + /// Represents a message reaction activity. /// - public const string Invoke = "invoke"; - + public const string MessageReaction = "messageReaction"; /// - /// Conversation update activity type. + /// Represents a message update activity. /// - public static readonly string ConversationUpdate = "conversationUpdate"; + public const string MessageUpdate = "messageUpdate"; /// - /// Installation update activity type. + /// Represents a message delete activity. /// - public static readonly string InstallationUpdate = "installationUpdate"; + public const string MessageDelete = "messageDelete"; + /// - /// Message reaction activity type. + /// Represents the string value "invoke" used to identify an invoke operation or action. /// - public static readonly string MessageReaction = "messageReaction"; + public const string Invoke = "invoke"; + /// + /// Registry of activity type factories for creating specialized activity instances. + /// + internal static readonly Dictionary FromActivity, + Func FromJson)> ActivityDeserializerMap = new() + { + [TeamsActivityType.Message] = (MessageActivity.FromActivity, MessageActivity.FromJsonString), + [TeamsActivityType.MessageReaction] = (MessageReactionActivity.FromActivity, MessageReactionActivity.FromJsonString), + [TeamsActivityType.MessageUpdate] = (MessageUpdateActivity.FromActivity, MessageUpdateActivity.FromJsonString), + [TeamsActivityType.MessageDelete] = (MessageDeleteActivity.FromActivity, MessageDeleteActivity.FromJsonString), + [TeamsActivityType.Invoke] = (InvokeActivity.FromActivity, InvokeActivity.FromJsonString), + }; // TODO: Review if we need FromJson in this map } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 741547fc..9f23824b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -8,6 +8,8 @@ using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Identity.Client; namespace Microsoft.Teams.Bot.Apps; @@ -50,7 +52,22 @@ public TeamsBotApplication( logger.LogInformation("New {Type} activity received.", activity.Type); TeamsActivity teamsActivity = TeamsActivity.FromActivity(activity); Context defaultContext = new(this, teamsActivity); - await Router.DispatchAsync(defaultContext, cancellationToken).ConfigureAwait(false); + + if (teamsActivity.Type != TeamsActivityType.Invoke) + { + await Router.DispatchAsync(defaultContext, cancellationToken).ConfigureAwait(false); + } + else // invokes + { + CoreInvokeResponse invokeResponse = await Router.DispatchWithReturnAsync(defaultContext, cancellationToken).ConfigureAwait(false); + HttpContext? httpContext = httpContextAccessor.HttpContext; + if (httpContext is not null && invokeResponse is not null) + { + httpContext.Response.StatusCode = invokeResponse.Status; + await httpContext.Response.WriteAsJsonAsync(invokeResponse, cancellationToken).ConfigureAwait(false); + + } + } }; } diff --git a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index 2ac1428d..beb15be0 100644 --- a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -1,7 +1,9 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Diagnostics; using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Mvc.Formatters; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Core.Schema; @@ -96,7 +98,9 @@ public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancel { try { - await MiddleWare.RunPipelineAsync(this, activity, this.OnActivity, 0, cancellationToken).ConfigureAwait(false); + var token = Debugger.IsAttached ? CancellationToken.None : cancellationToken; + await MiddleWare.RunPipelineAsync(this, activity, this.OnActivity, 0, token).ConfigureAwait(false); + } catch (Exception ex) { diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs new file mode 100644 index 00000000..fab4f714 --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Text; +using System.Text.Json.Nodes; +using System.Threading.Tasks; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.UnitTests; + +public class InvokeActivityTest +{ + [Fact] + public void DefaultCtor() + { + var ia = new InvokeActivity(); + Assert.NotNull(ia); + Assert.Equal(TeamsActivityType.Invoke, ia.Type); + Assert.Null(ia.Name); + Assert.Null(ia.Value); + // Assert.Null(ia.Conversation); + } + + [Fact] + public void FromCoreActivityWithValue() + { + var coreActivity = new CoreActivity + { + Type = TeamsActivityType.Invoke, + Value = JsonNode.Parse("{ \"key\": \"value\" }"), + Conversation = new Conversation { Id = "convId" }, + Properties = new ExtendedPropertiesDictionary + { + { "name", "testName" } + } + }; + var ia = InvokeActivity.FromActivity(coreActivity); + Assert.NotNull(ia); + Assert.Equal(TeamsActivityType.Invoke, ia.Type); + Assert.Equal("testName", ia.Name); + Assert.NotNull(ia.Value); + Assert.Equal("convId", ia.Conversation?.Id); + Assert.Equal("value", ia.Value?["key"]?.ToString()); + } +} diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs index e8618a1f..747141eb 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs @@ -14,14 +14,14 @@ public class MessageActivityTests public void Constructor_Default_SetsMessageType() { MessageActivity activity = new(); - Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal(TeamsActivityType.Message, activity.Type); } [Fact] public void Constructor_WithText_SetsTextAndMessageType() { MessageActivity activity = new("Hello World"); - Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal(TeamsActivityType.Message, activity.Type); Assert.Equal("Hello World", activity.Text); } @@ -30,7 +30,7 @@ public void DeserializeMessageActivity_WithAllProperties() { MessageActivity activity = MessageActivity.FromJsonString(jsonMessageWithAllProps); - Assert.Equal("message", activity.Type); + Assert.Equal(TeamsActivityType.Message, activity.Type); Assert.Equal("Hello World", activity.Text); Assert.Equal("This is a summary", activity.Summary); Assert.Equal("plain", activity.TextFormat); @@ -45,7 +45,7 @@ public void DeserializeMessageActivity_WithAllProperties() public void MessageActivity_FromCoreActivity_MapsAllProperties() { CoreActivity coreActivity = CoreActivity.FromJsonString(jsonMessageWithAllProps); - MessageActivity messageActivity = (MessageActivity)TeamsActivity.FromActivity(coreActivity); + MessageActivity messageActivity = MessageActivity.FromActivity(coreActivity); Assert.Equal("Hello World", messageActivity.Text); Assert.Equal("This is a summary", messageActivity.Summary); @@ -134,7 +134,7 @@ public void MessageActivity_WithExpiration_SerializeAndDeserialize() [Fact] public void MessageActivity_Constants_InputHints() { - MessageActivity activity = new MessageActivity("Test") + MessageActivity activity = new("Test") { InputHint = InputHints.AcceptingInput }; @@ -163,44 +163,6 @@ public void MessageActivity_Constants_TextFormats() Assert.Equal("xml", activity.TextFormat); } - [Fact] - public void MessageActivity_Constants_ImportanceLevels() - { - MessageActivity activity = new("Test") - { - Importance = ImportanceLevels.Low - }; - Assert.Equal("low", activity.Importance); - - activity.Importance = ImportanceLevels.Normal; - Assert.Equal("normal", activity.Importance); - - activity.Importance = ImportanceLevels.High; - Assert.Equal("high", activity.Importance); - - activity.Importance = ImportanceLevels.Urgent; - Assert.Equal("urgent", activity.Importance); - } - - [Fact] - public void MessageActivity_Constants_DeliveryModes() - { - MessageActivity activity = new("Test") - { - DeliveryMode = DeliveryModes.Normal - }; - Assert.Equal("normal", activity.DeliveryMode); - - activity.DeliveryMode = DeliveryModes.Notification; - Assert.Equal("notification", activity.DeliveryMode); - - activity.DeliveryMode = DeliveryModes.Ephemeral; - Assert.Equal("ephemeral", activity.DeliveryMode); - - activity.DeliveryMode = DeliveryModes.ExpectedReplies; - Assert.Equal("expectReplies", activity.DeliveryMode); - } - [Fact] public void MessageActivity_FromCoreActivity_WithMissingProperties_HandlesGracefully() { @@ -218,6 +180,47 @@ public void MessageActivity_FromCoreActivity_WithMissingProperties_HandlesGracef Assert.Null(messageActivity.Expiration); } + [Fact] + public void MessageActivity_CopiesTextToProperties() + { + MessageActivity activity = new("Hello World") + { + Speak = "Test speak", + Summary = "Test summary", + TextFormat = TextFormats.Markdown, + InputHint = InputHints.AcceptingInput, + Importance = ImportanceLevels.High, + DeliveryMode = DeliveryModes.Normal, + AttachmentLayout = "carousel" + }; + + Assert.Equal("Hello World", activity.Properties["text"]); + Assert.Equal("Test speak", activity.Properties["speak"]); + Assert.Equal("Test summary", activity.Properties["summary"]); + Assert.Equal(TextFormats.Markdown, activity.Properties["textFormat"]); + Assert.Equal(InputHints.AcceptingInput, activity.Properties["inputHint"]); + Assert.Equal(ImportanceLevels.High, activity.Properties["importance"]); + Assert.Equal(DeliveryModes.Normal, activity.Properties["deliveryMode"]); + Assert.Equal("carousel", activity.Properties["attachmentLayout"]); + } + + + [Fact] + public void MessageActivity_SerializedAsCoreActivity_IncludesText() + { + MessageActivity messageActivity = new("Hello World") + { + Type = ActivityType.Message, + ServiceUrl = new Uri("https://test.service.url/") + }; + + CoreActivity coreActivity = messageActivity; + string json = coreActivity.ToJson(); + + Assert.Contains("Hello World", json); + Assert.Contains("\"text\"", json); + } + private const string jsonMessageWithAllProps = """ { "type": "message", diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageDeleteActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageDeleteActivityTests.cs new file mode 100644 index 00000000..9ac14ee9 --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageDeleteActivityTests.cs @@ -0,0 +1,86 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +namespace Microsoft.Teams.Bot.Apps.UnitTests; + +public class MessageDeleteActivityTests +{ + [Fact] + public void Constructor_Default_SetsMessageDeleteType() + { + MessageDeleteActivity activity = new(); + Assert.Equal(TeamsActivityType.MessageDelete, activity.Type); + } + + [Fact] + public void DeserializeMessageDeleteFromJson() + { + string json = """ + { + "type": "messageDelete", + "conversation": { + "id": "19" + }, + "id": "1234567890" + } + """; + MessageDeleteActivity act = MessageDeleteActivity.FromJsonString(json); + Assert.NotNull(act); + Assert.Equal("messageDelete", act.Type); + + Assert.Equal("1234567890", act.Id); + } + + [Fact] + public void SerializeMessageDeleteToJson() + { + var activity = new MessageDeleteActivity + { + Id = "msg123" + }; + + string json = activity.ToJson(); + Assert.Contains("\"type\": \"messageDelete\"", json); + Assert.Contains("\"id\": \"msg123\"", json); + } + + [Fact] + public void FromActivityConvertsCorrectly() + { + var coreActivity = new CoreActivity + { + Type = TeamsActivityType.MessageDelete, + Id = "deleted-msg-id" + }; + + MessageDeleteActivity messageDelete = MessageDeleteActivity.FromActivity(coreActivity); + Assert.NotNull(messageDelete); + Assert.Equal(TeamsActivityType.MessageDelete, messageDelete.Type); + Assert.Equal("deleted-msg-id", messageDelete.Id); + } + + [Fact] + public void FromJsonStringCreatesCorrectType() + { + string json = """ + { + "type": "messageDelete", + "id": "test-id", + "conversation": { + "id": "conv-123" + } + } + """; + + TeamsActivity activity = TeamsActivity.FromJsonString(json); + Assert.IsType(activity); + MessageDeleteActivity? mda = activity as MessageDeleteActivity; + Assert.NotNull(mda); + Assert.Equal(TeamsActivityType.MessageDelete, mda.Type); + Assert.Equal("test-id", activity.Id); + } +} diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs index b4ac917e..fd762415 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs @@ -2,15 +2,15 @@ // Licensed under the MIT License. using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.UnitTests; public class MessageReactionActivityTests { [Fact] - public void AsMessageReaction() + public void DeserializeMessageReactionFromJson() { string json = """ { @@ -28,17 +28,107 @@ public void AsMessageReaction() ] } """; - TeamsActivity act = TeamsActivity.FromJsonString(json); + MessageReactionActivity act = MessageReactionActivity.FromJsonString(json); Assert.NotNull(act); Assert.Equal("messageReaction", act.Type); + Assert.NotNull(act.ReactionsAdded); + Assert.Equal(2, act.ReactionsAdded!.Count); + Assert.Equal("like", act.ReactionsAdded[0].Type); + Assert.Equal("heart", act.ReactionsAdded[1].Type); + } + + [Fact] + public void DeserializeMessageReactionWithReactionsRemoved() + { + string json = """ + { + "type": "messageReaction", + "conversation": { + "id": "19" + }, + "reactionsRemoved": [ + { + "type": "sad" + } + ] + } + """; + MessageReactionActivity act = MessageReactionActivity.FromJsonString(json); + Assert.NotNull(act); + + Assert.NotNull(act.ReactionsRemoved); + Assert.Single(act.ReactionsRemoved!); + Assert.Equal("sad", act.ReactionsRemoved[0].Type); + } + + [Fact] + public void SerializeMessageReactionToJson() + { + var activity = new MessageReactionActivity + { + ReactionsAdded = new List + { + new MessageReaction { Type = ReactionTypes.Like }, + new MessageReaction { Type = ReactionTypes.Heart } + } + }; - // MessageReactionActivity? mra = MessageReactionActivity.FromActivity(act); - /*MessageReactionArgs? mra = new(act); + string json = activity.ToJson(); + Assert.Contains("\"type\": \"messageReaction\"", json); + Assert.Contains("\"reactionsAdded\"", json); + Assert.Contains("\"like\"", json); + Assert.Contains("\"heart\"", json); + } + + [Fact] + public void FromActivityConvertsCorrectly() + { + var coreActivity = new CoreActivity + { + Type = TeamsActivityType.MessageReaction + }; + coreActivity.Properties["reactionsAdded"] = System.Text.Json.JsonSerializer.SerializeToElement(new[] + { + new { type = "like" }, + new { type = "heart" } + }); - Assert.NotNull(mra); - Assert.NotNull(mra!.ReactionsAdded); - Assert.Equal(2, mra!.ReactionsAdded!.Count); - Assert.Equal("like", mra!.ReactionsAdded[0].Type); - Assert.Equal("heart", mra!.ReactionsAdded[1].Type);*/ + MessageReactionActivity activity = MessageReactionActivity.FromActivity(coreActivity); + Assert.NotNull(activity); + Assert.Equal(TeamsActivityType.MessageReaction, activity.Type); + Assert.NotNull(activity.ReactionsAdded); + Assert.Equal(2, activity.ReactionsAdded!.Count); + } + + [Fact] + public void MessageReactionWithUserInfo() + { + string json = """ + { + "type": "messageReaction", + "conversation": { + "id": "19" + }, + "reactionsAdded": [ + { + "type": "like", + "createdDateTime": "2026-01-22T12:00:00Z", + "user": { + "id": "user-123", + "displayName": "Test User", + "userIdentityType": "aadUser" + } + } + ] + } + """; + MessageReactionActivity activity = MessageReactionActivity.FromJsonString(json); + Assert.NotNull(activity.ReactionsAdded); + Assert.Single(activity.ReactionsAdded!); + Assert.Equal("like", activity.ReactionsAdded[0].Type); + Assert.NotNull(activity.ReactionsAdded[0].User); + Assert.Equal("user-123", activity.ReactionsAdded[0].User!.Id); + Assert.Equal("Test User", activity.ReactionsAdded[0].User!.DisplayName); + Assert.Equal(UserIdentityTypes.AadUser, activity.ReactionsAdded[0].User!.UserIdentityType); } } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageUpdateActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageUpdateActivityTests.cs new file mode 100644 index 00000000..04011f96 --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageUpdateActivityTests.cs @@ -0,0 +1,142 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +namespace Microsoft.Teams.Bot.Apps.UnitTests; + +public class MessageUpdateActivityTests +{ + [Fact] + public void Constructor_Default_SetsMessageUpdateType() + { + MessageUpdateActivity activity = new(); + Assert.Equal(TeamsActivityType.MessageUpdate, activity.Type); + } + + [Fact] + public void Constructor_WithText_SetsTextAndMessageUpdateType() + { + MessageUpdateActivity activity = new("Updated text"); + Assert.Equal(TeamsActivityType.MessageUpdate, activity.Type); + Assert.Equal("Updated text", activity.Text); + } + + [Fact] + public void DeserializeMessageUpdateFromJson() + { + string json = """ + { + "type": "messageUpdate", + "text": "Updated message text", + "conversation": { + "id": "19" + } + } + """; + MessageUpdateActivity act = MessageUpdateActivity.FromJsonString(json); + Assert.NotNull(act); + Assert.Equal("messageUpdate", act.Type); + + Assert.Equal("Updated message text", act.Text); + } + + [Fact] + public void SerializeMessageUpdateToJson() + { + var activity = new MessageUpdateActivity + { + Text = "Updated message", + Speak = "Updated message spoken" + }; + + string json = activity.ToJson(); + Assert.Contains("\"type\": \"messageUpdate\"", json); + Assert.Contains("\"text\": \"Updated message\"", json); + Assert.Contains("\"speak\": \"Updated message spoken\"", json); + } + + [Fact] + public void MessageUpdateInheritsFromMessageActivity() + { + var activity = new MessageUpdateActivity + { + Text = "Updated", + InputHint = InputHints.AcceptingInput, + TextFormat = TextFormats.Markdown + }; + + Assert.Equal("Updated", activity.Text); + Assert.Equal(InputHints.AcceptingInput, activity.InputHint); + Assert.Equal(TextFormats.Markdown, activity.TextFormat); + } + + [Fact] + public void FromActivityConvertsCorrectly() + { + var coreActivity = new CoreActivity + { + Type = TeamsActivityType.MessageUpdate + }; + coreActivity.Properties["text"] = "Test message"; + + MessageUpdateActivity messageUpdate = MessageUpdateActivity.FromActivity(coreActivity); + Assert.NotNull(messageUpdate); + Assert.Equal(TeamsActivityType.MessageUpdate, messageUpdate.Type); + Assert.Equal("Test message", messageUpdate.Text); + } + + [Fact] + public void FromJsonStringCreatesCorrectType() + { + string json = """ + { + "type": "messageUpdate", + "text": "Updated content", + "textFormat": "markdown", + "conversation": { + "id": "conv-123" + } + } + """; + + TeamsActivity activity = TeamsActivity.FromJsonString(json); + Assert.IsType(activity); + MessageUpdateActivity? mua = activity as MessageUpdateActivity; + Assert.NotNull(mua); + Assert.Equal(TeamsActivityType.MessageUpdate, activity.Type); + Assert.Equal("Updated content", mua.Text); + Assert.Equal("markdown", mua.TextFormat); + } + + [Fact] + public void MessageUpdateActivity_Constructor_CopiesTextToProperties() + { + MessageUpdateActivity activity = new("Updated message text"); + + Assert.Equal("Updated message text", activity.Text); + Assert.Equal("Updated message text", activity.Properties["text"]); + } + + [Fact] + public void MessageUpdateActivity_SerializedAsCoreActivity_IncludesText() + { + MessageUpdateActivity messageUpdateActivity = new("Message update text") + { + Type = TeamsActivityType.MessageUpdate, + ServiceUrl = new Uri("https://test.service.url/"), + Speak = "Message update spoken" + }; + + CoreActivity coreActivity = messageUpdateActivity; + string json = coreActivity.ToJson(); + + Assert.Contains("Message update text", json); + Assert.Contains("\"text\"", json); + Assert.Contains("Message update spoken", json); + Assert.Contains("\"speak\"", json); + Assert.Contains("messageUpdate", json); + } +} diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs index 1964ef5c..d8242c36 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs @@ -84,10 +84,10 @@ public void WithChannelId_SetsChannelId() public void WithType_SetsActivityType() { var activity = builder - .WithType(ActivityType.Message) + .WithType(TeamsActivityType.Message) .Build(); - Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal(TeamsActivityType.Message, activity.Type); } [Fact] @@ -420,7 +420,7 @@ public void AddMention_MultipleMentions_AddsAllMentions() public void FluentAPI_CompleteActivity_BuildsCorrectly() { TeamsActivity activity = builder - .WithType(ActivityType.Message) + .WithType(TeamsActivityType.Message) .WithId("activity-123") .WithChannelId("msteams") .WithText("Test message") @@ -444,7 +444,7 @@ public void FluentAPI_CompleteActivity_BuildsCorrectly() .AddMention(new ConversationAccount { Id = "user-1", Name = "User" }) .Build(); - Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal(TeamsActivityType.Message, activity.Type); Assert.Equal("activity-123", activity.Id); Assert.Equal("msteams", activity.ChannelId); Assert.Equal("User Test message", activity.Properties["text"]); @@ -463,7 +463,7 @@ public void FluentAPI_MethodChaining_ReturnsBuilderInstance() TeamsActivityBuilder result1 = builder.WithId("id"); TeamsActivityBuilder result2 = builder.WithText("text"); - TeamsActivityBuilder result3 = builder.WithType(ActivityType.Message); + TeamsActivityBuilder result3 = builder.WithType(TeamsActivityType.Message); Assert.Same(builder, result1); Assert.Same(builder, result2); @@ -488,7 +488,7 @@ public void Builder_ModifyingExistingActivity_PreservesOriginalData() TeamsActivity original = new() { Id = "original-id", - Type = ActivityType.Message + Type = TeamsActivityType.Message }; original.Properties["text"] = "original text"; @@ -498,7 +498,7 @@ public void Builder_ModifyingExistingActivity_PreservesOriginalData() Assert.Equal("original-id", modified.Id); Assert.Equal("modified text", modified.Properties["text"]); - Assert.Equal(ActivityType.Message, modified.Type); + Assert.Equal(TeamsActivityType.Message, modified.Type); } [Fact] @@ -786,7 +786,7 @@ public void IntegrationTest_CreateComplexActivity() }; TeamsActivity activity = builder - .WithType(ActivityType.Message) + .WithType(TeamsActivityType.Message) .WithId("msg-001") .WithServiceUrl(serviceUrl) .WithChannelId("msteams") @@ -829,7 +829,7 @@ public void IntegrationTest_CreateComplexActivity() .Build(); // Verify all properties - Assert.Equal(ActivityType.Message, activity.Type); + Assert.Equal(TeamsActivityType.Message, activity.Type); Assert.Equal("msg-001", activity.Id); Assert.Equal(serviceUrl, activity.ServiceUrl); Assert.Equal("msteams", activity.ChannelId); diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs index 77c9b93b..c292d452 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs @@ -5,6 +5,7 @@ using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Apps.Schema.Entities; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.UnitTests; @@ -87,6 +88,25 @@ static void AssertCid(CoreActivity a) } + [Fact] + public void DownCastTeamsActivity_To_CoreActivity_WithoutRebase() + { + TeamsActivity teamsActivity = new TeamsActivity() { + Conversation = new TeamsConversation() + { + Id = "19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856" + } + }; + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", teamsActivity.Conversation!.Id); + + static void AssertCid(CoreActivity a) + { + Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", a.Conversation!.Id); + } + AssertCid(teamsActivity); + + } + [Fact] public void AddMentionEntity_To_TeamsActivity() @@ -149,7 +169,7 @@ static void SerializeAndAssert(CoreActivity a) public void TeamsActivityBuilder_FluentAPI() { TeamsActivity activity = TeamsActivity.CreateBuilder() - .WithType(ActivityType.Message) + .WithType(TeamsActivityType.Message) .WithText("Hello World") .WithChannelId("msteams") .AddMention(new ConversationAccount @@ -386,4 +406,44 @@ public void Deserialize_TeamsActivity_Invoke_WithValue() "localTimezone": "America/Los_Angeles" } """; + + [Fact] + public void FromJsonString_ReturnsDerivedType_WhenRegistered() + { + string json = """{"type": "message", "text": "Hello World"}"""; + TeamsActivity activity = TeamsActivity.FromJsonString(json); + + Assert.IsType(activity); + MessageActivity messageActivity = (MessageActivity)activity; + Assert.Equal("Hello World", messageActivity.Text); + } + + [Fact] + public void FromJsonString_ReturnsBaseType_WhenNotRegistered() + { + string json = """{"type": "unknownType"}"""; + TeamsActivity activity = TeamsActivity.FromJsonString(json); + + Assert.Equal(typeof(TeamsActivity), activity.GetType()); + Assert.Equal("unknownType", activity.Type); + } + + [Fact] + public void FromActivity_ReturnsDerivedType_WhenRegistered() + { + CoreActivity coreActivity = new CoreActivity(ActivityType.Message); + TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); + + Assert.IsType(activity); + } + + [Fact] + public void FromActivity_ReturnsBaseType_WhenNotRegistered() + { + CoreActivity coreActivity = new CoreActivity("unknownType"); + TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); + + Assert.Equal(typeof(TeamsActivity), activity.GetType()); + Assert.Equal("unknownType", activity.Type); + } } From 712f4974490dbf411e87d1587d3566b5da6b45e7 Mon Sep 17 00:00:00 2001 From: Rido Date: Thu, 29 Jan 2026 09:52:09 -0800 Subject: [PATCH 47/69] Downgrade Bot.Builder.Integration.AspNet.Core to 4.22.3 (#296) Revert the Microsoft.Bot.Builder.Integration.AspNet.Core NuGet package version in Microsoft.Teams.Bot.Compat.csproj from 4.23.1 to 4.22.3. No other changes were made. --------- Co-authored-by: Kavin Singh --- .../Microsoft.Teams.Bot.Compat.csproj | 2 +- .../Microsoft.Teams.Bot.Compat.UnitTests.csproj | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/core/src/Microsoft.Teams.Bot.Compat/Microsoft.Teams.Bot.Compat.csproj b/core/src/Microsoft.Teams.Bot.Compat/Microsoft.Teams.Bot.Compat.csproj index 6b50258b..540a19fa 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/Microsoft.Teams.Bot.Compat.csproj +++ b/core/src/Microsoft.Teams.Bot.Compat/Microsoft.Teams.Bot.Compat.csproj @@ -6,7 +6,7 @@ enable - + diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj index 0eb1f233..e9a2060e 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj @@ -12,6 +12,7 @@ + @@ -23,4 +24,4 @@ - \ No newline at end of file + From 17cc382dda50be823ac8bcabe59a60f530eb6979 Mon Sep 17 00:00:00 2001 From: Kavin <115390646+singhk97@users.noreply.github.com> Date: Tue, 3 Feb 2026 13:21:39 -0500 Subject: [PATCH 48/69] add tests to `FromCompatActivity` (#300) ## Summary Refactored and expanded CompatActivityTests to provide comprehensive coverage of the `FromCompatActivity()` method, including support for complex `SuggestedActions` payloads. ## Changes ### Test Structure: - Refactored into component-based tests (12 total) organized by Activity aspect: - Core Properties (2 tests) - Attachments (2 tests) - Entities (2 tests) - SuggestedActions (2 tests) - ChannelData (2 tests) - Integration/Round-trip (2 tests) --- .../CompatActivityTests.cs | 335 +++++++++++++----- ...icrosoft.Teams.Bot.Compat.UnitTests.csproj | 9 +- .../TestData/AdaptiveCardActivity.json | 74 ++++ .../TestData/SuggestedActionsActivity.json | 240 +++++++++++++ 4 files changed, 578 insertions(+), 80 deletions(-) create mode 100644 core/test/Microsoft.Teams.Bot.Compat.UnitTests/TestData/AdaptiveCardActivity.json create mode 100644 core/test/Microsoft.Teams.Bot.Compat.UnitTests/TestData/SuggestedActionsActivity.json diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs index 31669e5b..a49b3b48 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs @@ -5,18 +5,78 @@ using Microsoft.Bot.Schema; using Microsoft.Teams.Bot.Core.Schema; using Newtonsoft.Json; +using System.Text.Json; +using System.Text.Json.Nodes; namespace Microsoft.Teams.Bot.Compat.UnitTests { public class CompatActivityTests { + #region Core Properties Tests + + [Fact] + public void FromCompatActivity_PreservesCoreProperties() + { + var activity = new Activity + { + Type = ActivityTypes.Message, + ServiceUrl = "https://smba.trafficmanager.net/teams", + ChannelId = "msteams", + Id = "test-id-123", + From = new ChannelAccount { Id = "user-123", Name = "Test User" }, + Recipient = new ChannelAccount { Id = "bot-456", Name = "Test Bot" }, + Conversation = new Microsoft.Bot.Schema.ConversationAccount { Id = "conv-789", Name = "Test Conversation" } + }; + + CoreActivity coreActivity = activity.FromCompatActivity(); + + Assert.NotNull(coreActivity); + Assert.Equal(activity.Type, coreActivity.Type); + Assert.Equal(activity.ServiceUrl, coreActivity.ServiceUrl?.ToString()); + Assert.Equal(activity.ChannelId, coreActivity.ChannelId); + Assert.Equal(activity.Id, coreActivity.Id); + Assert.Equal(activity.From.Id, coreActivity.From.Id); + Assert.Equal(activity.From.Name, coreActivity.From.Name); + Assert.Equal(activity.Recipient.Id, coreActivity.Recipient.Id); + Assert.Equal(activity.Conversation.Id, coreActivity.Conversation.Id); + } + [Fact] - public void FromCompatActivity() + public void FromCompatActivity_PreservesTextAndMetadata() { - Activity botActivity = JsonConvert.DeserializeObject(compatActivityJson)!; + var activity = new Activity + { + Type = ActivityTypes.Message, + Text = "Hello, this is a test message", + TextFormat = "plain", + Locale = "en-US", + InputHint = "acceptingInput", + ReplyToId = "reply-to-123" + }; + + CoreActivity coreActivity = activity.FromCompatActivity(); + + Assert.NotNull(coreActivity); + Assert.Equal(activity.Text, coreActivity.Properties["text"]?.ToString()); + Assert.Equal(activity.InputHint, coreActivity.Properties["inputHint"]?.ToString()); + Assert.Equal(activity.ReplyToId, coreActivity.Properties["replyToId"]?.ToString()); + Assert.Equal(activity.Locale, coreActivity.Properties["locale"]?.ToString()); + } + + #endregion + + #region Attachments Tests + + [Fact] + public void FromCompatActivity_PreservesAdaptiveCardAttachment() + { + string json = LoadTestData("AdaptiveCardActivity.json"); + Activity botActivity = JsonConvert.DeserializeObject(json)!; Assert.NotNull(botActivity); + Assert.Single(botActivity.Attachments); CoreActivity coreActivity = botActivity.FromCompatActivity(); + Assert.NotNull(coreActivity); Assert.NotNull(coreActivity.Attachments); Assert.Single(coreActivity.Attachments); @@ -34,84 +94,201 @@ public void FromCompatActivity() Assert.Equal(2, card.Body.Count); var firstTextBlock = card.Body[0] as AdaptiveTextBlock; Assert.NotNull(firstTextBlock); - Assert.Equal("Mention a user by User Principle Name: Hello Rido UPN", firstTextBlock.Text); + Assert.Equal("Mention a user by User Principle Name: Hello Test User UPN", firstTextBlock.Text); + } + + [Fact] + public void FromCompatActivity_PreservesMultipleAttachments() + { + var activity = new Activity + { + Type = ActivityTypes.Message, + Attachments = new List + { + new Attachment { ContentType = "text/plain", Content = "First attachment" }, + new Attachment { ContentType = "image/png", ContentUrl = "https://example.com/image.png" } + } + }; + + CoreActivity coreActivity = activity.FromCompatActivity(); + + Assert.NotNull(coreActivity.Attachments); + Assert.Equal(2, coreActivity.Attachments.Count); + Assert.Equal("text/plain", coreActivity.Attachments[0]?["contentType"]?.GetValue()); + Assert.Equal("image/png", coreActivity.Attachments[1]?["contentType"]?.GetValue()); + } + + #endregion + + #region Entities Tests + + [Fact] + public void FromCompatActivity_PreservesEntities() + { + string json = LoadTestData("AdaptiveCardActivity.json"); + Activity botActivity = JsonConvert.DeserializeObject(json)!; + + CoreActivity coreActivity = botActivity.FromCompatActivity(); + + Assert.NotNull(coreActivity.Entities); + Assert.Single(coreActivity.Entities); + + var entity = coreActivity.Entities[0]?.AsObject(); + Assert.NotNull(entity); + Assert.Equal("https://schema.org/Message", entity["type"]?.GetValue()); + } + + [Fact] + public void FromCompatActivity_PreservesMultipleEntities() + { + string json = LoadTestData("SuggestedActionsActivity.json"); + Activity botActivity = JsonConvert.DeserializeObject(json)!; + + CoreActivity coreActivity = botActivity.FromCompatActivity(); + + Assert.NotNull(coreActivity.Entities); + Assert.Equal(2, coreActivity.Entities.Count); + + var firstEntity = coreActivity.Entities[0]?.AsObject(); + Assert.Equal("https://schema.org/Message", firstEntity?["type"]?.GetValue()); + + var secondEntity = coreActivity.Entities[1]?.AsObject(); + Assert.Equal("BotMessageMetadata", secondEntity?["type"]?.GetValue()); + } + + #endregion + + #region SuggestedActions Tests + + [Fact] + public void FromCompatActivity_PreservesSuggestedActions() + { + string json = LoadTestData("SuggestedActionsActivity.json"); + Activity botActivity = JsonConvert.DeserializeObject(json)!; + Assert.NotNull(botActivity.SuggestedActions); + Assert.Equal(3, botActivity.SuggestedActions.Actions.Count); + + CoreActivity coreActivity = botActivity.FromCompatActivity(); + + Assert.True(coreActivity.Properties.ContainsKey("suggestedActions")); + + string coreActivityJson = coreActivity.ToJson(); + JsonNode coreActivityNode = JsonNode.Parse(coreActivityJson)!; + + var suggestedActions = coreActivityNode["suggestedActions"]; + Assert.NotNull(suggestedActions); + + var actions = suggestedActions["actions"]?.AsArray(); + Assert.NotNull(actions); + Assert.Equal(3, actions.Count); } - string compatActivityJson = """ + [Fact] + public void FromCompatActivity_PreservesSuggestedActionDetails() + { + string json = LoadTestData("SuggestedActionsActivity.json"); + Activity botActivity = JsonConvert.DeserializeObject(json)!; + + CoreActivity coreActivity = botActivity.FromCompatActivity(); + string coreActivityJson = coreActivity.ToJson(); + JsonNode coreActivityNode = JsonNode.Parse(coreActivityJson)!; + + var actions = coreActivityNode["suggestedActions"]?["actions"]?.AsArray(); + Assert.NotNull(actions); + + // Verify Action.Odsl actions + Assert.Equal("Action.Odsl", actions[0]?["type"]?.GetValue()); + Assert.Equal("Add reviewers", actions[0]?["title"]?.GetValue()); + Assert.NotNull(actions[0]?["value"]); + + Assert.Equal("Action.Odsl", actions[1]?["type"]?.GetValue()); + Assert.Equal("Open agent settings", actions[1]?["title"]?.GetValue()); + + // Verify Action.Compose action + Assert.Equal("Action.Compose", actions[2]?["type"]?.GetValue()); + Assert.Equal("Ask me a question", actions[2]?["title"]?.GetValue()); + Assert.NotNull(actions[2]?["value"]); + } + + #endregion + + #region ChannelData Tests + + [Fact] + public void FromCompatActivity_PreservesChannelData() + { + var activity = new Activity { - "type": "message", - "serviceUrl": "https://smba.trafficmanager.net/amer/9a9b49fd-1dc5-4217-88b3-ecf855e91b0e/", - "channelId": "msteams", - "from": { - "id": "28:fa45fe59-200c-493c-aa4c-80c17ad6f307", - "name": "ridodev-local" - }, - "conversation": { - "conversationType": "personal", - "id": "a:188cfPEO2ZNiFxoCSq-2QwCkQTBywkMID0Y2704RpFR2QjMx8217cpDunnnI-rx95Qn_1ce11juGEelMnscuyEQvHTh_wRRRKR_WxbV8ZS4-1qFwb0l8T0Zrd9uiTCtLX", - "tenantId": "9a9b49fd-1dc5-4217-88b3-ecf855e91b0e" - }, - "recipient": { - "id": "29:1zIP3NcdoJbnv2Rp-x-7ukmDhrgy6JqXcDgYB4mFxGCtBRvVT7V0Iwu0obPlWlBd14M2qEa4p5qqJde0HTYy4cw", - "name": "Rido", - "aadObjectId": "16de8f24-f65d-4f6b-a837-3a7e638ab6e1" - }, - "attachmentLayout": "list", - "locale": "en-US", - "inputHint": "acceptingInput", - "attachments": [ - { - "contentType": "application/vnd.microsoft.card.adaptive", - "content": { - "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", - "type": "AdaptiveCard", - "version": "1.5", - "speak": "This card mentions a user by User Principle Name: Hello Rido", - "body": [ - { - "type": "TextBlock", - "text": "Mention a user by User Principle Name: Hello Rido UPN" - }, - { - "type": "TextBlock", - "text": "Mention a user by AAD Object Id: Hello Rido AAD" - } - ], - "msteams": { - "entities": [ - { - "type": "mention", - "text": "Rido UPN", - "mentioned": { - "id": "rido@tsdk1.onmicrosoft.com", - "name": "Rido" - } - }, - { - "type": "mention", - "text": "Rido AAD", - "mentioned": { - "id": "16de8f24-f65d-4f6b-a837-3a7e638ab6e1", - "name": "Rido" - } - } - ] - } - } - } - ], - "entities": [ - { - "type": "https://schema.org/Message", - "@context": "https://schema.org", - "@type": "Message", - "additionalType": [ - "AIGeneratedContent" - ] - }, - ], - "replyToId": "f:d1c5de53-9e8b-b5c3-c24d-07c2823079cf" - } - """; + Type = ActivityTypes.Message, + ChannelData = new { customProperty = "customValue", nestedObject = new { key = "value" } } + }; + + CoreActivity coreActivity = activity.FromCompatActivity(); + + Assert.NotNull(coreActivity.ChannelData); + Assert.True(coreActivity.ChannelData.Properties.ContainsKey("customProperty")); + Assert.Equal("customValue", coreActivity.ChannelData.Properties["customProperty"]?.ToString()); + } + + [Fact] + public void FromCompatActivity_PreservesComplexChannelData() + { + string json = LoadTestData("SuggestedActionsActivity.json"); + Activity botActivity = JsonConvert.DeserializeObject(json)!; + + CoreActivity coreActivity = botActivity.FromCompatActivity(); + + Assert.NotNull(coreActivity.ChannelData); + Assert.True(coreActivity.ChannelData.Properties.ContainsKey("feedbackLoopEnabled")); + + var feedbackLoopValue = (JsonElement)coreActivity.ChannelData.Properties["feedbackLoopEnabled"]!; + Assert.True(feedbackLoopValue.GetBoolean()); + } + + #endregion + + #region Integration Tests + + [Fact] + public void FromCompatActivity_CompleteRoundTrip_AdaptiveCard() + { + // Verify the complete adaptive card payload round-trips successfully + string originalJson = LoadTestData("AdaptiveCardActivity.json"); + Activity botActivity = JsonConvert.DeserializeObject(originalJson)!; + + CoreActivity coreActivity = botActivity.FromCompatActivity(); + string coreActivityJson = coreActivity.ToJson(); + + // Use JsonNode.DeepEquals to verify structural equality + JsonNode originalNode = JsonNode.Parse(originalJson)!; + JsonNode coreNode = JsonNode.Parse(coreActivityJson)!; + + Assert.True(JsonNode.DeepEquals(originalNode, coreNode)); + } + + [Fact] + public void FromCompatActivity_CompleteRoundTrip_SuggestedActions() + { + // Verify the complete suggested actions payload round-trips successfully + string originalJson = LoadTestData("SuggestedActionsActivity.json"); + Activity botActivity = JsonConvert.DeserializeObject(originalJson)!; + + CoreActivity coreActivity = botActivity.FromCompatActivity(); + string coreActivityJson = coreActivity.ToJson(); + + // Use JsonNode.DeepEquals to verify structural equality + JsonNode originalNode = JsonNode.Parse(originalJson)!; + JsonNode coreNode = JsonNode.Parse(coreActivityJson)!; + + Assert.True(JsonNode.DeepEquals(originalNode, coreNode)); + } + + #endregion + + private static string LoadTestData(string fileName) + { + string testDataPath = Path.Combine(AppContext.BaseDirectory, "TestData", fileName); + return File.ReadAllText(testDataPath); + } } -} \ No newline at end of file +} diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj index e9a2060e..cd76813f 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj @@ -1,4 +1,5 @@ - + + net10.0 @@ -24,4 +25,10 @@ + + + PreserveNewest + + + diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/TestData/AdaptiveCardActivity.json b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/TestData/AdaptiveCardActivity.json new file mode 100644 index 00000000..0e825200 --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/TestData/AdaptiveCardActivity.json @@ -0,0 +1,74 @@ +{ + "type": "message", + "serviceUrl": "https://smba.trafficmanager.net/amer/1a2b3c4d-5e6f-4789-a0b1-c2d3e4f5a6b7/", + "channelId": "msteams", + "from": { + "id": "28:b1c2d3e4-f5a6-4b7c-8d9e-0f1a2b3c4d5e", + "name": "testbot-local" + }, + "conversation": { + "conversationType": "personal", + "id": "a:1AbCdEfGhIjKlMnOpQrStUvWxYz2AbCdEfGhIjKlMnOpQrStUvWxYz3AbCdEfGhIjKlMnOpQrStUvWxYz4AbCdEfGhIjKlMnOpQrStUvWxYz5AbCdEf", + "tenantId": "1a2b3c4d-5e6f-4789-a0b1-c2d3e4f5a6b7" + }, + "recipient": { + "id": "29:9xYzAbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIjKlMnOpQrStUvWxYzAb", + "name": "Test User", + "aadObjectId": "7f8e9d0c-1b2a-4354-6758-9a0b1c2d3e4f" + }, + "attachmentLayout": "list", + "locale": "en-US", + "inputHint": "acceptingInput", + "attachments": [ + { + "contentType": "application/vnd.microsoft.card.adaptive", + "content": { + "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", + "type": "AdaptiveCard", + "version": "1.5", + "speak": "This card mentions a user by User Principle Name: Hello Test User", + "body": [ + { + "type": "TextBlock", + "text": "Mention a user by User Principle Name: Hello Test User UPN" + }, + { + "type": "TextBlock", + "text": "Mention a user by AAD Object Id: Hello Test User AAD" + } + ], + "msteams": { + "entities": [ + { + "type": "mention", + "text": "Test User UPN", + "mentioned": { + "id": "testuser@example.onmicrosoft.com", + "name": "Test User" + } + }, + { + "type": "mention", + "text": "Test User AAD", + "mentioned": { + "id": "7f8e9d0c-1b2a-4354-6758-9a0b1c2d3e4f", + "name": "Test User" + } + } + ] + } + } + } + ], + "entities": [ + { + "type": "https://schema.org/Message", + "@context": "https://schema.org", + "@type": "Message", + "additionalType": [ + "AIGeneratedContent" + ] + } + ], + "replyToId": "f:a1b2c3d4-e5f6-4789-a0b1-c2d3e4f5a6b7" +} diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/TestData/SuggestedActionsActivity.json b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/TestData/SuggestedActionsActivity.json new file mode 100644 index 00000000..617c6616 --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/TestData/SuggestedActionsActivity.json @@ -0,0 +1,240 @@ +{ + "type": "message", + "serviceUrl": "https://smba.trafficmanager.net/teams", + "from": { + "id": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6" + }, + "recipient": {}, + "conversation": { + "id": "19:xYz9pQrS8tUv5wXy3zAbCdEfGhIjKlMnOpQrStUvWx-Y2@thread.tacv2" + }, + "text": "Hi there.\n\nI'm working on a status report and will share it in this chat shortly. You'll be able to make edits, and once it's ready, send it to the channel.\n\n\n\nYou can add more reviewers anytime.", + "inputHint": "acceptingInput", + "suggestedActions": { + "actions": [ + { + "type": "Action.Odsl", + "title": "Add reviewers", + "value": { + "actions": { + "odsl": { + "statements": [ + { + "name": "statusReportConfiguration", + "arguments": [ + { + "name": "agentId", + "value": "" + }, + { + "name": "agentName", + "value": "PA Test" + }, + { + "name": "agentType", + "value": 0 + }, + { + "name": "teamId", + "value": "" + }, + { + "name": "channelId", + "value": "19:xYz9pQrS8tUv5wXy3zAbCdEfGhIjKlMnOpQrStUvWx-Y2@thread.tacv2" + }, + { + "name": "recurrence", + "value": { + "pattern": { + "patternType": "test" + }, + "range": { + "startDate": "test", + "endDate": "test" + } + } + }, + { + "name": "approvalList", + "value": [ + "123", + "345" + ] + }, + { + "name": "welcomeMessageType", + "value": "ApproversChat" + }, + { + "name": "chatId", + "value": "19:xYz9pQrS8tUv5wXy3zAbCdEfGhIjKlMnOpQrStUvWx-Y2@thread.tacv2" + }, + { + "name": "displayText", + "value": "Add reviewers" + }, + { + "name": "deleteAgentDisplayText", + "value": "" + } + ] + } + ] + } + }, + "entities": [ + "chat" + ] + } + }, + { + "type": "Action.Odsl", + "title": "Open agent settings", + "value": { + "actions": { + "odsl": { + "statements": [ + { + "name": "agentConfiguration", + "arguments": [ + { + "name": "agentId", + "value": "" + }, + { + "name": "agentName", + "value": "PA Test" + }, + { + "name": "agentType", + "value": 0 + }, + { + "name": "teamId", + "value": "" + }, + { + "name": "channelId", + "value": "19:xYz9pQrS8tUv5wXy3zAbCdEfGhIjKlMnOpQrStUvWx-Y2@thread.tacv2" + }, + { + "name": "recurrence", + "value": { + "pattern": { + "patternType": "test" + }, + "range": { + "startDate": "test", + "endDate": "test" + } + } + }, + { + "name": "approvalList", + "value": [ + "123", + "345" + ] + }, + { + "name": "welcomeMessageType", + "value": "ApproversChat" + }, + { + "name": "chatId", + "value": "19:xYz9pQrS8tUv5wXy3zAbCdEfGhIjKlMnOpQrStUvWx-Y2@thread.tacv2" + }, + { + "name": "displayText", + "value": "Open agent settings" + }, + { + "name": "deleteAgentDisplayText", + "value": "" + } + ] + } + ] + } + }, + "entities": [ + "chat" + ] + } + }, + { + "type": "Action.Compose", + "title": "Ask me a question", + "value": { + "type": "Teams.chatMessage", + "data": { + "body": { + "additionalData": {}, + "backingStore": { + "returnOnlyChangedValues": false, + "initializationCompleted": true + }, + "content": "PA Test" + }, + "mentions": [ + { + "additionalData": {}, + "backingStore": { + "returnOnlyChangedValues": false, + "initializationCompleted": false + }, + "id": 0, + "mentioned": { + "additionalData": {}, + "backingStore": { + "returnOnlyChangedValues": false, + "initializationCompleted": false + }, + "odataType": "#microsoft.graph.chatMessageMentionedIdentitySet", + "user": { + "additionalData": {}, + "backingStore": { + "returnOnlyChangedValues": false, + "initializationCompleted": false + }, + "displayName": "PA Test", + "id": "28:a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6", + "appId": "" + } + }, + "mentionText": "PA Test" + } + ], + "additionalData": {}, + "backingStore": { + "returnOnlyChangedValues": false, + "initializationCompleted": true + } + } + } + } + ] + }, + "attachments": [], + "entities": [ + { + "type": "https://schema.org/Message", + "@context": "https://schema.org", + "@type": "Message", + "additionalType": [ + "AIGeneratedContent" + ] + }, + { + "type": "BotMessageMetadata", + "botTelemetryMessageType": "Welcome-AddApproverChat", + "aiMetadata": { + "botAiSkill": "{\"cv\":\"GsaulSWnUUWlHf97qANDWA.0.0\",\"reasoningActive\":false}" + } + } + ], + "channelData": { + "feedbackLoopEnabled": true + }, + "replyToId": "f7e8d9c0-b1a2-4536-9271-a8b9c0d1e2f3" +} From a1189ca8dc885a2b73c269f182ac3cbe5df1e043 Mon Sep 17 00:00:00 2001 From: Kavin <115390646+singhk97@users.noreply.github.com> Date: Tue, 3 Feb 2026 13:39:22 -0500 Subject: [PATCH 49/69] Add `ICompatAdapter` interface (#304) **Why?** Makes it easier to mock the `CompatAdapter.ContinueConversationAsync` method when testing. Without the interface, the class itself would first have to be mocked, which means all the underlying components will have to be configured by hand. --- .../CompatAdapter.cs | 2 +- .../ICompatAdapter.cs | 25 +++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 core/src/Microsoft.Teams.Bot.Compat/ICompatAdapter.cs diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index 4182b9ba..8355f720 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -21,7 +21,7 @@ namespace Microsoft.Teams.Bot.Compat; /// The adapter allows registration of middleware and error handling delegates, and supports processing HTTP requests /// and continuing conversations. Thread safety is not guaranteed; instances should not be shared across concurrent /// requests. -public class CompatAdapter : IBotFrameworkHttpAdapter +public class CompatAdapter : ICompatAdapter { private readonly TeamsBotApplication _teamsBotApplication; private readonly CompatBotAdapter _compatBotAdapter; diff --git a/core/src/Microsoft.Teams.Bot.Compat/ICompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/ICompatAdapter.cs new file mode 100644 index 00000000..cf27a175 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Compat/ICompatAdapter.cs @@ -0,0 +1,25 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Schema; + +namespace Microsoft.Teams.Bot.Compat +{ + /// + /// Defines an adapter interface for compatibility with Teams bots. + /// + public interface ICompatAdapter : IBotFrameworkHttpAdapter + { + /// + /// Continues a conversation with the specified bot and conversation reference. + /// + /// The bot identifier. + /// The conversation reference. + /// The bot callback handler to execute. + /// A cancellation token for the operation. + /// A task representing the asynchronous operation. + public Task ContinueConversationAsync(string botId, ConversationReference reference, BotCallbackHandler callback, CancellationToken cancellationToken); + } +} From ede4af04ec1ea25ba93a598ce59ae82ffac01ddc Mon Sep 17 00:00:00 2001 From: Kavin <115390646+singhk97@users.noreply.github.com> Date: Wed, 4 Feb 2026 17:43:46 -0500 Subject: [PATCH 50/69] Refactor `CompatAdapter` to extend `CompatBotAdapter` (#307) 1. Keeps the same pattern as CloudAdapter 2. `TurnContext.Adapter` will reference the `CompatAdapter` and not just the `CompatBotAdapter` as it was before this change. This means the same adapter is used everywhere. 3. Updated `ContinueConversationAsync` to follow the implementation of `BotAdapter`. I also ensure that our override is used even if the object is typecast to `BotAdapter`. `BotAdapter.ContinueConversationAsync` creates a brand new turn context without the underlying compat clients which is not intended. 4. Removed `ICloudAdapter` because it is not needed anymore. `BotAdapter` is an abstract class that allows easy mocking of the CompatAdapter. 5. Without a separate `CompatBotAdapter` DI setup is simplified --- core/samples/CompatBot/Program.cs | 2 +- .../CompatAdapter.cs | 47 ++------ .../CompatBotAdapter.cs | 16 +-- .../CompatHostingExtensions.cs | 1 - .../ICompatAdapter.cs | 25 ----- .../CompatAdapterTests.cs | 103 ++++++++++++++++++ ...icrosoft.Teams.Bot.Compat.UnitTests.csproj | 1 + 7 files changed, 122 insertions(+), 73 deletions(-) delete mode 100644 core/src/Microsoft.Teams.Bot.Compat/ICompatAdapter.cs create mode 100644 core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index ee8614ee..172cefae 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -44,7 +44,7 @@ Conversation = new() { Id = cid }, ServiceUrl = "https://smba.trafficmanager.net/teams" }; - await ((CompatAdapter)adapter).ContinueConversationAsync( + await ((BotAdapter)adapter).ContinueConversationAsync( string.Empty, proactive.GetConversationReference(), async (turnContext, ct) => diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index 8355f720..c93a9a00 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -21,49 +21,17 @@ namespace Microsoft.Teams.Bot.Compat; /// The adapter allows registration of middleware and error handling delegates, and supports processing HTTP requests /// and continuing conversations. Thread safety is not guaranteed; instances should not be shared across concurrent /// requests. -public class CompatAdapter : ICompatAdapter +public class CompatAdapter : CompatBotAdapter, IBotFrameworkHttpAdapter { private readonly TeamsBotApplication _teamsBotApplication; - private readonly CompatBotAdapter _compatBotAdapter; - private readonly IServiceProvider _sp; - /// /// Creates a new instance of the class. /// /// - public CompatAdapter(IServiceProvider sp) + public CompatAdapter(IServiceProvider sp) : base(sp) { - _sp = sp; _teamsBotApplication = sp.GetRequiredService(); - _compatBotAdapter = sp.GetRequiredService(); - } - - /// - /// Gets the collection of middleware components configured for the application. - /// - /// Use this property to access or inspect the set of middleware that will be invoked during - /// request processing. The returned collection is read-only and reflects the current middleware pipeline. - public MiddlewareSet MiddlewareSet { get; } = new MiddlewareSet(); - - /// - /// Gets or sets the error handling callback to be invoked when an exception occurs during a turn. - /// - /// Assign a delegate to customize how errors are handled within the bot's turn processing. The - /// callback receives the current turn context and the exception that was thrown. If not set, unhandled exceptions - /// may propagate and result in default error behavior. This property is typically used to log errors, send - /// user-friendly messages, or perform cleanup actions. - public Func? OnTurnError { get; set; } - - /// - /// Adds the specified middleware to the adapter's processing pipeline. - /// - /// The middleware component to be invoked during request processing. Cannot be null. - /// The current instance, enabling method chaining. - public CompatAdapter Use(Microsoft.Bot.Builder.IMiddleware middleware) - { - MiddlewareSet.Use(middleware); - return this; } /// @@ -84,7 +52,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons _teamsBotApplication.OnActivity = async (activity, cancellationToken1) => { coreActivity = activity; - TurnContext turnContext = new(_compatBotAdapter, activity.ToCompatActivity()); + TurnContext turnContext = new(this, activity.ToCompatActivity()); turnContext.TurnState.Add(new CompatUserTokenClient(_teamsBotApplication.UserTokenClient)); CompatConnectorClient connectionClient = new(new CompatConversations(_teamsBotApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); turnContext.TurnState.Add(connectionClient); @@ -103,7 +71,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons if (ex is BotHandlerException aex) { coreActivity = aex.Activity; - using TurnContext turnContext = new(_compatBotAdapter, coreActivity!.ToCompatActivity()); + using TurnContext turnContext = new(this, coreActivity!.ToCompatActivity()); await OnTurnError(turnContext, ex).ConfigureAwait(false); } else @@ -130,14 +98,15 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons /// cancellation token. /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. - public async Task ContinueConversationAsync(string botId, ConversationReference reference, BotCallbackHandler callback, CancellationToken cancellationToken) + public async override Task ContinueConversationAsync(string botId, ConversationReference reference, BotCallbackHandler callback, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(reference); ArgumentNullException.ThrowIfNull(callback); - using TurnContext turnContext = new(_compatBotAdapter, reference.GetContinuationActivity()); + using TurnContext turnContext = new(this, reference.GetContinuationActivity()); + turnContext.TurnState.Add(new CompatUserTokenClient(_teamsBotApplication.UserTokenClient)); turnContext.TurnState.Add(new CompatConnectorClient(new CompatConversations(_teamsBotApplication.ConversationClient) { ServiceUrl = reference.ServiceUrl })); turnContext.TurnState.Add(_teamsBotApplication.TeamsApiClient); - await callback(turnContext, cancellationToken).ConfigureAwait(false); + await RunPipelineAsync(turnContext, callback, cancellationToken).ConfigureAwait(false); } } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs index f611918e..21c7700b 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs @@ -5,6 +5,7 @@ using Microsoft.AspNetCore.Http; using Microsoft.Bot.Builder; using Microsoft.Bot.Schema; +using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Core; @@ -20,13 +21,14 @@ namespace Microsoft.Teams.Bot.Compat; /// Use this adapter to bridge Bot Framework turn contexts and activities with a custom bot application. /// This class is intended for scenarios where integration with non-standard bot runtimes or legacy systems is /// required. -/// The bot application instance used to process and send activities within the adapter. -/// The HTTP context accessor used to retrieve the current HTTP context for writing invoke responses. -/// The logger instance for recording adapter operations and diagnostics. +/// The service provider used to resolve dependencies. [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] -public class CompatBotAdapter(TeamsBotApplication botApplication, IHttpContextAccessor httpContextAccessor = default!, ILogger logger = default!) : BotAdapter +public class CompatBotAdapter(IServiceProvider sp) : BotAdapter { private readonly JsonSerializerOptions _writeIndentedJsonOptions = new() { WriteIndented = true }; + private readonly TeamsBotApplication botApplication = sp.GetRequiredService(); + private readonly IHttpContextAccessor? httpContextAccessor = sp.GetService(); + private readonly ILogger? logger = sp.GetService>(); /// /// Deletes an activity from the conversation. @@ -75,7 +77,7 @@ public override async Task SendActivitiesAsync(ITurnContext SendActivityResponse? resp = await botApplication.SendActivityAsync(activity.FromCompatActivity(), cancellationToken).ConfigureAwait(false); - logger.LogInformation("Resp from SendActivitiesAsync: {RespId}", resp?.Id); + logger?.LogInformation("Resp from SendActivitiesAsync: {RespId}", resp?.Id); responses[i] = new Microsoft.Bot.Schema.ResourceResponse() { Id = resp?.Id }; } @@ -112,7 +114,7 @@ private void WriteInvokeResponseToHttpResponse(InvokeResponse? invokeResponse) response.StatusCode = invokeResponse.Status; using StreamWriter httpResponseStreamWriter = new(response.BodyWriter.AsStream()); using JsonTextWriter httpResponseJsonWriter = new(httpResponseStreamWriter); - logger.LogTrace("Sending Invoke Response: \n {InvokeResponse} with status: {Status} \n", System.Text.Json.JsonSerializer.Serialize(invokeResponse.Body, _writeIndentedJsonOptions), invokeResponse.Status); + logger?.LogTrace("Sending Invoke Response: \n {InvokeResponse} with status: {Status} \n", System.Text.Json.JsonSerializer.Serialize(invokeResponse.Body, _writeIndentedJsonOptions), invokeResponse.Status); if (invokeResponse.Body is not null) { Microsoft.Bot.Builder.Integration.AspNet.Core.HttpHelper.BotMessageSerializer.Serialize(httpResponseJsonWriter, invokeResponse.Body); @@ -120,7 +122,7 @@ private void WriteInvokeResponseToHttpResponse(InvokeResponse? invokeResponse) } else { - logger.LogWarning("HTTP response is null or has started. Cannot write invoke response. ResponseStarted: {ResponseStarted}", response?.HasStarted); + logger?.LogWarning("HTTP response is null or has started. Cannot write invoke response. ResponseStarted: {ResponseStarted}", response?.HasStarted); } } } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs index b2b669fc..9762f5c6 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs @@ -43,7 +43,6 @@ public static IHostApplicationBuilder AddCompatAdapter(this IHostApplicationBuil public static IServiceCollection AddCompatAdapter(this IServiceCollection services) { services.AddTeamsBotApplication(); - services.AddSingleton(); services.AddSingleton(); return services; } diff --git a/core/src/Microsoft.Teams.Bot.Compat/ICompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/ICompatAdapter.cs deleted file mode 100644 index cf27a175..00000000 --- a/core/src/Microsoft.Teams.Bot.Compat/ICompatAdapter.cs +++ /dev/null @@ -1,25 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using Microsoft.Bot.Builder; -using Microsoft.Bot.Builder.Integration.AspNet.Core; -using Microsoft.Bot.Schema; - -namespace Microsoft.Teams.Bot.Compat -{ - /// - /// Defines an adapter interface for compatibility with Teams bots. - /// - public interface ICompatAdapter : IBotFrameworkHttpAdapter - { - /// - /// Continues a conversation with the specified bot and conversation reference. - /// - /// The bot identifier. - /// The conversation reference. - /// The bot callback handler to execute. - /// A cancellation token for the operation. - /// A task representing the asynchronous operation. - public Task ContinueConversationAsync(string botId, ConversationReference reference, BotCallbackHandler callback, CancellationToken cancellationToken); - } -} diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs new file mode 100644 index 00000000..10edf32c --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs @@ -0,0 +1,103 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.AspNetCore.Http; +using Microsoft.Bot.Builder; +using Microsoft.Bot.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Core; +using Moq; + +namespace Microsoft.Teams.Bot.Compat.UnitTests +{ + public class CompatAdapterTests + { + [Fact] + public async Task ContinueConversationAsync_WhenCastToBotAdapter_BuildsTurnContextWithUnderlyingClients() + { + // Arrange + var (compatAdapter, teamsApiClient) = CreateCompatAdapter(); + + // Cast to BotAdapter to ensure we're using the base class method + BotAdapter botAdapter = compatAdapter; + + var conversationReference = new ConversationReference + { + ServiceUrl = "https://smba.trafficmanager.net/teams", + ChannelId = "msteams", + Conversation = new Microsoft.Bot.Schema.ConversationAccount { Id = "test-conversation-id" } + }; + + bool callbackInvoked = false; + Microsoft.Bot.Connector.Authentication.UserTokenClient? capturedUserTokenClient = null; + Microsoft.Bot.Connector.IConnectorClient? capturedConnectorClient = null; + Microsoft.Teams.Bot.Apps.TeamsApiClient? capturedTeamsApiClient = null; + + BotCallbackHandler callback = async (turnContext, cancellationToken) => + { + callbackInvoked = true; + capturedUserTokenClient = turnContext.TurnState.Get(); + capturedConnectorClient = turnContext.TurnState.Get(); + capturedTeamsApiClient = turnContext.TurnState.Get(); + await Task.CompletedTask; + }; + + // Act + await botAdapter.ContinueConversationAsync( + "test-bot-id", + conversationReference, + callback, + CancellationToken.None); + + // Assert + Assert.True(callbackInvoked); + + // Verify UserTokenClient is CompatUserTokenClient (check by type name since it's internal) + Assert.NotNull(capturedUserTokenClient); + Assert.Equal("CompatUserTokenClient", capturedUserTokenClient.GetType().Name); + Assert.IsAssignableFrom(capturedUserTokenClient); + + // Verify ConnectorClient is CompatConnectorClient (check by type name since it's internal) + Assert.NotNull(capturedConnectorClient); + Assert.Equal("CompatConnectorClient", capturedConnectorClient.GetType().Name); + Assert.IsAssignableFrom(capturedConnectorClient); + + // Verify TeamsApiClient is the same instance we set up + Assert.NotNull(capturedTeamsApiClient); + Assert.Same(teamsApiClient, capturedTeamsApiClient); + } + + private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() + { + var httpClient = new HttpClient(); + var conversationClient = new ConversationClient(httpClient, NullLogger.Instance); + + var mockConfig = new Mock(); + mockConfig.Setup(c => c["UserTokenApiEndpoint"]).Returns("https://token.botframework.com"); + + var userTokenClient = new UserTokenClient(httpClient, mockConfig.Object, NullLogger.Instance); + var teamsApiClient = new TeamsApiClient(httpClient, NullLogger.Instance); + + var teamsBotApplication = new TeamsBotApplication( + conversationClient, + userTokenClient, + teamsApiClient, + mockConfig.Object, + Mock.Of(), + NullLogger.Instance); + + var mockServiceProvider = new Mock(); + mockServiceProvider + .Setup(sp => sp.GetService(typeof(TeamsBotApplication))) + .Returns(teamsBotApplication); + + var compatAdapter = new CompatAdapter(mockServiceProvider.Object); + + return (compatAdapter, teamsApiClient); + } + } +} diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj index cd76813f..0d3d0f06 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/Microsoft.Teams.Bot.Compat.UnitTests.csproj @@ -11,6 +11,7 @@ + From cdc4d28d52dbd14e0fd902454944b4a86333957d Mon Sep 17 00:00:00 2001 From: Mehak Bindra Date: Thu, 5 Feb 2026 18:38:50 -0800 Subject: [PATCH 51/69] Add install & conv activity handlers , simplify activities, add warning for multiple matching routes (#301) - Introduced `ConversationUpdateActivity` and `InstallUpdateActivity` . - Implemented handlers for conversation update (members added/removed, channel created/deleted etc..) and installation update events in `TeamsBot`. - Added support for pattern-based and regex-based message handlers (e.g., responding to "hello" or slash commands like `/help`). - Added TeamsChannelBot, for Channel and Teams related testing - Added warning logs if multiple routes match an activity - Made names for handlers more specific so that warning logs are clear - Added Router to hosting - Removed deserialization methods for teams activities - we never read from json strings - Removed serialization methods for non msg/invoke activities - we only send message activities - Serialization for msg and invoke activities handled centrally be teams activity class - Simplified constructing activities from core activity - Refactored TeamsChannelData to move small channel data specific classes into same file - Fixed duplication of conversation account - Added TODOs for unverified properties/handlers and commented it for now - Moved tests for non msg activities to one file (very few per class) - Made DateTime - > string --- core/core.slnx | 1 + core/samples/TeamsBot/Cards.cs | 120 ++--- core/samples/TeamsBot/Program.cs | 111 +++++ core/samples/TeamsChannelBot/Program.cs | 141 ++++++ core/samples/TeamsChannelBot/README.md | 53 +++ .../TeamsChannelBot/TeamsChannelBot.csproj | 13 + core/samples/TeamsChannelBot/appsettings.json | 10 + .../Handlers/ConversationUpdateHandler.cs | 447 ++++++++++++++++++ .../Handlers/InstallUpdateHandler.cs | 88 ++++ .../Handlers/MessageHandler.cs | 5 +- .../Handlers/MessageReactionHandler.cs | 4 +- .../Microsoft.Teams.Bot.Apps/Routing/Route.cs | 2 +- .../Routing/Router.cs | 85 ++-- .../ConversationUpdateActivity.cs | 213 +++++++++ .../Schema/Entities/MentionEntity.cs | 5 +- .../InstallUpdateActivity.cs | 67 +++ .../MessageActivities/InvokeActivity.cs | 33 +- .../MessageActivities/MessageActivity.cs | 198 ++++---- .../MessageDeleteActivity.cs | 17 - .../MessageReactionActivity.cs | 97 ++-- .../MessageUpdateActivity.cs | 17 - .../Schema/TeamsActivity.cs | 56 +-- .../Schema/TeamsActivityJsonContext.cs | 8 +- .../Schema/TeamsActivityType.cs | 48 +- .../Schema/TeamsChannelData.cs | 89 ++++ .../Schema/TeamsChannelDataSettings.cs | 28 -- .../Schema/TeamsChannelDataTenant.cs | 17 - .../Schema/TeamsConversation.cs | 24 +- .../Schema/TeamsConversationAccount.cs | 14 +- .../TeamsBotApplication.HostingExtensions.cs | 2 + .../TeamsBotApplication.cs | 13 +- .../Schema/CoreActivity.cs | 2 +- .../ActivitiesTests.cs | 146 ++++++ .../ConversationUpdateActivityTests.cs | 115 ----- .../MessageActivityTests.cs | 177 ++----- .../MessageDeleteActivityTests.cs | 86 ---- .../MessageReactionActivityTests.cs | 134 ------ .../MessageUpdateActivityTests.cs | 142 ------ .../TeamsActivityTests.cs | 168 ++----- .../CompatAdapterTests.cs | 5 +- 40 files changed, 1817 insertions(+), 1184 deletions(-) create mode 100644 core/samples/TeamsChannelBot/Program.cs create mode 100644 core/samples/TeamsChannelBot/README.md create mode 100644 core/samples/TeamsChannelBot/TeamsChannelBot.csproj create mode 100644 core/samples/TeamsChannelBot/appsettings.json create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallUpdateHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/InstallActivities/InstallUpdateActivity.cs delete mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataSettings.cs delete mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataTenant.cs create mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs delete mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs delete mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageDeleteActivityTests.cs delete mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs delete mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageUpdateActivityTests.cs diff --git a/core/core.slnx b/core/core.slnx index f77ebb4a..6944f616 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -12,6 +12,7 @@ + diff --git a/core/samples/TeamsBot/Cards.cs b/core/samples/TeamsBot/Cards.cs index afcb611f..173692b0 100644 --- a/core/samples/TeamsBot/Cards.cs +++ b/core/samples/TeamsBot/Cards.cs @@ -1,88 +1,90 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Text.Json.Nodes; + namespace TeamsBot; internal class Cards { - public static object ResponseCard(string? feedback) => new + public static object ResponseCard(string? feedback) => new JsonObject { - type = "AdaptiveCard", - version = "1.4", - body = new object[] + ["type"] = "AdaptiveCard", + ["version"] = "1.4", + ["body"] = new JsonArray + { + new JsonObject + { + ["type"] = "TextBlock", + ["text"] = "Form Submitted Successfully! ✓", + ["weight"] = "Bolder", + ["size"] = "Large", + ["color"] = "Good" + }, + new JsonObject { - new - { - type = "TextBlock", - text = "Form Submitted Successfully! ✓", - weight = "Bolder", - size = "Large", - color = "Good" - }, - new - { - type = "TextBlock", - text = $"You entered: **{feedback ?? "(empty)"}**", - wrap = true - } + ["type"] = "TextBlock", + ["text"] = $"You entered: **{feedback ?? "(empty)"}**", + ["wrap"] = true } + } }; - public static object ReactionsCard(string? reactionsAdded, string? reactionsRemoved) => new + public static object ReactionsCard(string? reactionsAdded, string? reactionsRemoved) => new JsonObject { - type = "AdaptiveCard", - version = "1.4", - body = new object[] + ["type"] = "AdaptiveCard", + ["version"] = "1.4", + ["body"] = new JsonArray + { + new JsonObject { - new - { - type = "TextBlock", - text = "Reaction Received", - weight = "Bolder", - size = "Medium" - }, - new - { - type = "TextBlock", - text = $"Reactions Added: {reactionsAdded ?? "(empty)"}", - wrap = true - }, - new - { - type = "TextBlock", - text = $"Reactions Removed: {reactionsRemoved ?? "(empty)"}", - wrap = true - } + ["type"] = "TextBlock", + ["text"] = "Reaction Received", + ["weight"] = "Bolder", + ["size"] = "Medium" + }, + new JsonObject + { + ["type"] = "TextBlock", + ["text"] = $"Reactions Added: {reactionsAdded ?? "(empty)"}", + ["wrap"] = true + }, + new JsonObject + { + ["type"] = "TextBlock", + ["text"] = $"Reactions Removed: {reactionsRemoved ?? "(empty)"}", + ["wrap"] = true } + } }; - public static readonly object FeedbackCardObj = new + public static readonly object FeedbackCardObj = new JsonObject { - type = "AdaptiveCard", - version = "1.4", - body = new object[] + ["type"] = "AdaptiveCard", + ["version"] = "1.4", + ["body"] = new JsonArray { - new + new JsonObject { - type = "TextBlock", - text = "Please provide your feedback:", - weight = "Bolder", - size = "Medium" + ["type"] = "TextBlock", + ["text"] = "Please provide your feedback:", + ["weight"] = "Bolder", + ["size"] = "Medium" }, - new + new JsonObject { - type = "Input.Text", - id = "feedback", - placeholder = "Enter your feedback here", - isMultiline = true + ["type"] = "Input.Text", + ["id"] = "feedback", + ["placeholder"] = "Enter your feedback here", + ["isMultiline"] = true } }, - actions = new object[] + ["actions"] = new JsonArray { - new + new JsonObject { - type = "Action.Execute", - title = "Submit Feedback" + ["type"] = "Action.Execute", + ["title"] = "Submit Feedback" } } }; diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 3216774c..7cb57fb4 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -6,11 +6,82 @@ using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Apps.Schema.Entities; using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +using System.Text.RegularExpressions; using TeamsBot; var builder = TeamsBotApplication.CreateBuilder(); var teamsApp = builder.Build(); +// ==================== MESSAGE HANDLERS ==================== + +// Pattern-based handler: matches "hello" (case-insensitive) +teamsApp.OnMessage("(?i)hello", async (context, cancellationToken) => +{ + await context.SendActivityAsync("Hi there! 👋 You said hello!", cancellationToken); +}); + +// Markdown handler: matches "markdown" (case-insensitive) +teamsApp.OnMessage("(?i)markdown", async (context, cancellationToken) => +{ + var markdownMessage = new MessageActivity(""" +# Markdown Examples + +Here are some **markdown** formatting examples: + +## Text Formatting +- **Bold text** +- *Italic text* +- ~~Strikethrough~~ +- `inline code` + +## Lists +1. First item +2. Second item +3. Third item + +## Code Block +```csharp +public class Example +{ + public string Name { get; set; } +} +``` + +## Links +[Visit Microsoft](https://www.microsoft.com) + +## Quotes +> This is a blockquote +> It can span multiple lines +""") + { + TextFormat = TextFormats.Markdown + }; + + await context.SendActivityAsync(markdownMessage, cancellationToken); +}); + +// Regex-based handler: matches commands starting with "/" +var commandRegex = new Regex(@"^/(\w+)(.*)$", RegexOptions.Compiled); +teamsApp.OnMessage(commandRegex, async (context, cancellationToken) => +{ + var match = commandRegex.Match(context.Activity.Text ?? ""); + if (match.Success) + { + string command = match.Groups[1].Value; + string args = match.Groups[2].Value.Trim(); + + string response = command.ToLower() switch + { + "help" => "Available commands: /help, /about, /time", + "about" => "I'm a Teams bot built with the Microsoft Teams Bot SDK!", + "time" => $"Current server time: {DateTime.Now:yyyy-MM-dd HH:mm:ss}", + _ => $"Unknown command: /{command}. Type /help for available commands." + }; + + await context.SendActivityAsync(response, cancellationToken); + } +}); teamsApp.OnMessageUpdate(async (context, cancellationToken) => { @@ -56,6 +127,7 @@ await context.SendActivityAsync("I saw that message you deleted", cancellationToken); }); +// ==================== INVOKE ==================== teamsApp.OnInvoke(async (context, cancellationToken) => { @@ -78,5 +150,44 @@ }; }); +// ==================== CONVERSATION UPDATE HANDLERS ==================== + +teamsApp.OnMembersAdded(async (context, cancellationToken) => +{ + Console.WriteLine($"[MembersAdded] {context.Activity.MembersAdded?.Count ?? 0} member(s) added"); + + var memberNames = string.Join(", ", context.Activity.MembersAdded?.Select(m => m.Name ?? m.Id) ?? []); + await context.SendActivityAsync($"Welcome! Members added: {memberNames}", cancellationToken); +}); + +teamsApp.OnMembersRemoved(async (context, cancellationToken) => +{ + Console.WriteLine($"[MembersRemoved] {context.Activity.MembersRemoved?.Count ?? 0} member(s) removed"); + + var memberNames = string.Join(", ", context.Activity.MembersRemoved?.Select(m => m.Name ?? m.Id) ?? []); + await context.SendActivityAsync($"Goodbye! Members removed: {memberNames}", cancellationToken); +}); + +// ==================== INSTALL UPDATE HANDLERS ==================== + +teamsApp.OnInstallUpdate(async (context, cancellationToken) => +{ + var action = context.Activity.Action ?? "unknown"; + Console.WriteLine($"[InstallUpdate] Installation action: {action}"); + await context.SendActivityAsync($"Installation update: {action}", cancellationToken); +}); + +teamsApp.OnInstall(async (context, cancellationToken) => +{ + Console.WriteLine($"[InstallAdd] Bot was installed"); + await context.SendActivityAsync("Thanks for installing me! I'm ready to help.", cancellationToken); +}); + +teamsApp.OnUnInstall((context, cancellationToken) => +{ + Console.WriteLine($"[InstallRemove] Bot was uninstalled"); + return Task.CompletedTask; +}); + teamsApp.Run(); diff --git a/core/samples/TeamsChannelBot/Program.cs b/core/samples/TeamsChannelBot/Program.cs new file mode 100644 index 00000000..9404c72e --- /dev/null +++ b/core/samples/TeamsChannelBot/Program.cs @@ -0,0 +1,141 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Handlers; + +var builder = TeamsBotApplication.CreateBuilder(); +var app = builder.Build(); + + +//TODO : implement next(); +/*app.OnConversationUpdate(async (context, cancellationToken) => +{ + Console.WriteLine($"[ConversationUpdate] Conversation updated"); +} +); +;*/ + +// ==================== CHANNEL EVENT HANDLERS ==================== + +app.OnChannelCreated(async (context, cancellationToken) => +{ + var channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; + Console.WriteLine($"[ChannelCreated] Channel '{channelName}' was created"); + await context.SendActivityAsync($"New channel created: {channelName}", cancellationToken); +}); + +app.OnChannelDeleted(async (context, cancellationToken) => +{ + var channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; + Console.WriteLine($"[ChannelDeleted] Channel '{channelName}' was deleted"); + await context.SendActivityAsync($"Channel deleted: {channelName}", cancellationToken); +}); + +app.OnChannelRenamed(async (context, cancellationToken) => +{ + var channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; + Console.WriteLine($"[ChannelRenamed] Channel renamed to '{channelName}'"); + await context.SendActivityAsync($"Channel renamed to: {channelName}", cancellationToken); +}); + +/* +//not able to test - no activity received +app.OnChannelRestored(async (context, cancellationToken) => +{ + var channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; + Console.WriteLine($"[ChannelRestored] Channel '{channelName}' was restored"); + await context.SendActivityAsync($"Channel restored: {channelName}", cancellationToken); +}); + +// not able to test - can't add bot to shared channel +app.OnChannelShared(async (context, cancellationToken) => +{ + var channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; + Console.WriteLine($"[ChannelShared] Channel '{channelName}' was shared"); + await context.SendActivityAsync($"Channel shared: {channelName}", cancellationToken); +}); + +// not able to test - can't add bot to shared channel +app.OnChannelUnshared(async (context, cancellationToken) => +{ + var channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; + Console.WriteLine($"[ChannelUnshared] Channel '{channelName}' was unshared"); + await context.SendActivityAsync($"Channel unshared: {channelName}", cancellationToken); +}); + +// not able to test - can't add bot to private/shared channel +app.OnChannelMemberAdded(async (context, cancellationToken) => +{ + Console.WriteLine($"[ChannelMemberAdded] Member added to channel"); + await context.SendActivityAsync("A member was added to the channel", cancellationToken); +}); + +// not able to test - can't add bot to private/shared channel +app.OnChannelMemberRemoved(async (context, cancellationToken) => +{ + Console.WriteLine($"[ChannelMemberRemoved] Member removed from channel"); + await context.SendActivityAsync("A member was removed from the channel", cancellationToken); +}); +*/ + +// ==================== TEAM EVENT HANDLERS ==================== + +app.OnTeamMemberAdded(async (context, cancellationToken) => +{ + Console.WriteLine($"[TeamMemberAdded] Member added to team"); + await context.SendActivityAsync("A member was added to the team", cancellationToken); +}); + +app.OnTeamMemberRemoved(async (context, cancellationToken) => +{ + Console.WriteLine($"[TeamMemberRemoved] Member removed from team"); + await context.SendActivityAsync("A member was removed from the team", cancellationToken); +}); + +app.OnTeamArchived((context, cancellationToken) => +{ + var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + Console.WriteLine($"[TeamArchived] Team '{teamName}' was archived"); + return Task.CompletedTask; +}); + +app.OnTeamDeleted((context, cancellationToken) => +{ + var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + Console.WriteLine($"[TeamDeleted] Team '{teamName}' was deleted"); + return Task.CompletedTask; +}); + +app.OnTeamRenamed(async (context, cancellationToken) => +{ + var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + Console.WriteLine($"[TeamRenamed] Team renamed to '{teamName}'"); + await context.SendActivityAsync($"Team renamed to: {teamName}", cancellationToken); +}); + +app.OnTeamUnarchived(async (context, cancellationToken) => +{ + var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + Console.WriteLine($"[TeamUnarchived] Team '{teamName}' was unarchived"); + await context.SendActivityAsync($"Team unarchived: {teamName}", cancellationToken); +}); +/* +// how to test ? +app.OnTeamHardDeleted((context, cancellationToken) => +{ + var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + Console.WriteLine($"[TeamHardDeleted] Team '{teamName}' was permanently deleted"); + return Task.CompletedTask; +}); + +// how to test ? Restore is unarchived +app.OnTeamRestored(async (context, cancellationToken) => +{ + var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + Console.WriteLine($"[TeamRestored] Team '{teamName}' was restored"); + await context.SendActivityAsync($"Team restored: {teamName}", cancellationToken); +}); +*/ + +app.Run(); diff --git a/core/samples/TeamsChannelBot/README.md b/core/samples/TeamsChannelBot/README.md new file mode 100644 index 00000000..7ae59db3 --- /dev/null +++ b/core/samples/TeamsChannelBot/README.md @@ -0,0 +1,53 @@ +# ConversationSample + +This sample demonstrates all **ConversationUpdate** and **InstallUpdate** activity handlers available in the Teams Bot framework. + +## Handlers Demonstrated + +### ConversationUpdate Handlers + +#### General Handlers +- **OnConversationUpdate** - Catches all conversation update activities +- **OnMembersAdded** - Triggered when members are added to a conversation +- **OnMembersRemoved** - Triggered when members are removed from a conversation + +#### Channel Event Handlers +- **OnChannelCreated** - Channel is created in a team +- **OnChannelDeleted** - Channel is deleted from a team +- **OnChannelRenamed** - Channel name is changed +- **OnChannelRestored** - Deleted channel is restored +- **OnChannelShared** - Channel is shared with another team +- **OnChannelUnshared** - Channel sharing is removed +- **OnChannelMemberAdded** - Member is added to a specific channel +- **OnChannelMemberRemoved** - Member is removed from a specific channel + +#### Team Event Handlers +- **OnTeamArchived** - Team is archived +- **OnTeamDeleted** - Team is soft-deleted +- **OnTeamHardDeleted** - Team is permanently deleted +- **OnTeamRenamed** - Team name is changed +- **OnTeamRestored** - Deleted team is restored +- **OnTeamUnarchived** - Archived team is unarchived + +### InstallUpdate Handlers +- **OnInstallUpdate** - Catches all installation update activities +- **OnInstallAdd** - Bot is installed to a team/chat +- **OnInstallRemove** - Bot is uninstalled from a team/chat + +## Running the Sample + +1. Build and run the project: + ```bash + dotnet run --project samples/ConversationSample/ConversationSample.csproj + ``` + +2. Configure your bot in the Teams Developer Portal or Bot Framework portal to point to `http://localhost:3978/api/messages` + +3. Install the bot in a Teams team or chat to trigger the various conversation and installation events + +## Notes + +- Each handler logs to the console when triggered +- Most handlers send a confirmation message back to the conversation +- The `OnInstallRemove` handler typically cannot send messages (bot is being removed) +- Channel and Team event handlers require the activity's `ChannelData.EventType` to be set appropriately diff --git a/core/samples/TeamsChannelBot/TeamsChannelBot.csproj b/core/samples/TeamsChannelBot/TeamsChannelBot.csproj new file mode 100644 index 00000000..f30bcbe3 --- /dev/null +++ b/core/samples/TeamsChannelBot/TeamsChannelBot.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/core/samples/TeamsChannelBot/appsettings.json b/core/samples/TeamsChannelBot/appsettings.json new file mode 100644 index 00000000..f88090b1 --- /dev/null +++ b/core/samples/TeamsChannelBot/appsettings.json @@ -0,0 +1,10 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Warning", + "Microsoft.Bot": "Information", + "Microsoft.Teams": "Information" + } + }, + "AllowedHosts": "*" +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs new file mode 100644 index 00000000..2bb878d2 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs @@ -0,0 +1,447 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.ConversationActivities; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling conversation update activities. +/// +/// +/// +/// +public delegate Task ConversationUpdateHandler(Context context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering conversation update activity handlers. +/// +public static class ConversationUpdateExtensions +{ + /// + /// Registers a handler for conversation update activities. + /// + /// + /// + /// + public static TeamsBotApplication OnConversationUpdate(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = TeamsActivityType.ConversationUpdate, + Selector = _ => true, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for conversation update activities where members were added. + /// + /// + /// + /// + public static TeamsBotApplication OnMembersAdded(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, "membersAdded"]), + Selector = activity => activity.MembersAdded?.Count > 0, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for conversation update activities where members were removed. + /// + /// + /// + /// + public static TeamsBotApplication OnMembersRemoved(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, "membersRemoved"]), + Selector = activity => activity.MembersRemoved?.Count > 0, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + // Channel Event Handlers + + /// + /// Registers a handler for channel created events. + /// + /// + /// + /// + public static TeamsBotApplication OnChannelCreated(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.ChannelCreated]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.ChannelCreated, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for channel deleted events. + /// + /// + /// + /// + public static TeamsBotApplication OnChannelDeleted(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.ChannelDeleted]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.ChannelDeleted, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for channel renamed events. + /// + /// + /// + /// + public static TeamsBotApplication OnChannelRenamed(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.ChannelRenamed]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.ChannelRenamed, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /* + /// + /// Registers a handler for channel restored events. + /// + /// + /// + /// + public static TeamsBotApplication OnChannelRestored(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.ChannelRestored]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.ChannelRestored, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for channel shared events. + /// + /// + /// + /// + public static TeamsBotApplication OnChannelShared(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.ChannelShared]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.ChannelShared, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for channel unshared events. + /// + /// + /// + /// + public static TeamsBotApplication OnChannelUnshared(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.ChannelUnShared]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.ChannelUnShared, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for channel member added events. + /// + /// + /// + /// + public static TeamsBotApplication OnChannelMemberAdded(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.ChannelMemberAdded]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.ChannelMemberAdded, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for channel member removed events. + /// + /// + /// + /// + public static TeamsBotApplication OnChannelMemberRemoved(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.ChannelMemberRemoved]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.ChannelMemberRemoved, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + */ + + // Team Event Handlers + + /// + /// Registers a handler for team member added events. + /// + /// + /// + /// + public static TeamsBotApplication OnTeamMemberAdded(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.TeamMemberAdded]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.TeamMemberAdded, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for team member removed events. + /// + /// + /// + /// + public static TeamsBotApplication OnTeamMemberRemoved(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.TeamMemberRemoved]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.TeamMemberRemoved, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for team archived events. + /// + /// + /// + /// + public static TeamsBotApplication OnTeamArchived(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.TeamArchived]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.TeamArchived, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for team deleted events. + /// + /// + /// + /// + public static TeamsBotApplication OnTeamDeleted(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.TeamDeleted]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.TeamDeleted, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for team renamed events. + /// + /// + /// + /// + public static TeamsBotApplication OnTeamRenamed(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.TeamRenamed]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.TeamRenamed, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for team unarchived events. + /// + /// + /// + /// + public static TeamsBotApplication OnTeamUnarchived(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.TeamUnarchived]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.TeamUnarchived, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /* + /// Registers a handler for team restored events. + /// + /// + /// + /// + public static TeamsBotApplication OnTeamRestored(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.TeamRestored]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.TeamRestored, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for team hard deleted events. + /// + /// + /// + /// + public static TeamsBotApplication OnTeamHardDeleted(this TeamsBotApplication app, ConversationUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.ConversationUpdate, ConversationEventTypes.TeamHardDeleted]), + Selector = activity => activity.ChannelData?.EventType == ConversationEventTypes.TeamHardDeleted, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + */ +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallUpdateHandler.cs new file mode 100644 index 00000000..3ecb1a26 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallUpdateHandler.cs @@ -0,0 +1,88 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.InstallActivities; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling installation update activities. +/// +/// +/// +/// +public delegate Task InstallUpdateHandler(Context context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering installation update activity handlers. +/// +public static class InstallUpdateExtensions +{ + /// + /// Registers a handler for installation update activities. + /// + /// + /// + /// + public static TeamsBotApplication OnInstallUpdate(this TeamsBotApplication app, InstallUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = TeamsActivityType.InstallationUpdate, + Selector = _ => true, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for installation add activities. + /// + /// + /// + /// + public static TeamsBotApplication OnInstall(this TeamsBotApplication app, InstallUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.InstallationUpdate, InstallUpdateActions.Add]), + Selector = activity => activity.Action == InstallUpdateActions.Add, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for installation remove activities. + /// + /// + /// + /// + public static TeamsBotApplication OnUnInstall(this TeamsBotApplication app, InstallUpdateHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", [TeamsActivityType.InstallationUpdate, InstallUpdateActions.Remove]), + Selector = activity => activity.Action == InstallUpdateActions.Remove, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs index fad0488e..9c13e69f 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs @@ -58,7 +58,7 @@ public static TeamsBotApplication OnMessage(this TeamsBotApplication app, string app.Router.Register(new Route { - Name = TeamsActivityType.Message, + Name = string.Join("/", [TeamsActivityType.Message, pattern]), Selector = msg => regex.IsMatch(msg.Text ?? ""), Handler = async (ctx, cancellationToken) => { @@ -79,9 +79,10 @@ public static TeamsBotApplication OnMessage(this TeamsBotApplication app, string public static TeamsBotApplication OnMessage(this TeamsBotApplication app, Regex regex, MessageHandler handler) { ArgumentNullException.ThrowIfNull(app, nameof(app)); + ArgumentNullException.ThrowIfNull(regex, nameof(regex)); app.Router.Register(new Route { - Name = TeamsActivityType.Message, + Name = string.Join("/", [TeamsActivityType.Message, regex.ToString()]), Selector = msg => regex.IsMatch(msg.Text ?? ""), Handler = async (ctx, cancellationToken) => { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs index b34c653b..29f468ba 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs @@ -53,7 +53,7 @@ public static TeamsBotApplication OnMessageReactionAdded(this TeamsBotApplicatio ArgumentNullException.ThrowIfNull(app, nameof(app)); app.Router.Register(new Route { - Name = TeamsActivityType.MessageReaction, + Name = string.Join("/", [TeamsActivityType.MessageReaction, "reactionsAdded"]), Selector = activity => activity.ReactionsAdded?.Count > 0, Handler = async (ctx, cancellationToken) => { @@ -75,7 +75,7 @@ public static TeamsBotApplication OnMessageReactionRemoved(this TeamsBotApplicat ArgumentNullException.ThrowIfNull(app, nameof(app)); app.Router.Register(new Route { - Name = TeamsActivityType.MessageReaction, + Name = string.Join("/", [TeamsActivityType.MessageReaction, "reactionsRemoved"]), Selector = activity => activity.ReactionsRemoved?.Count > 0, Handler = async (ctx, cancellationToken) => { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs index 20a22d62..1a012707 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs @@ -79,7 +79,7 @@ public override string Name public override bool Matches(TeamsActivity activity) { ArgumentNullException.ThrowIfNull(activity); - return (activity.Type.Equals(Name, StringComparison.Ordinal)) && Selector((TActivity)activity); + return activity is TActivity && Selector((TActivity)activity); } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs index 9c9ccbf5..df73f91f 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. +using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; @@ -9,7 +10,9 @@ namespace Microsoft.Teams.Bot.Apps.Routing; /// /// Router for dispatching Teams activities to registered routes /// -public class Router +[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] + +public sealed class Router(ILogger logger) { private readonly List _routes = []; @@ -21,50 +24,44 @@ public class Router /// /// Registers a route. Routes are checked in registration order. /// IMPORTANT: Register specific routes before general catch-all routes. + /// Call Next() in handlers to continue to the next matching route. /// - public Router Register(Route route) where TActivity : TeamsActivity + internal Router Register(Route route) where TActivity : TeamsActivity { _routes.Add(route); return this; } - /// - /// Selects the first matching route for the given activity. - /// - public Route? Select(TActivity activity) where TActivity : TeamsActivity - { - return _routes - .OfType>() - .FirstOrDefault(r => r.Selector(activity)); - } - - /// - /// Selects all matching routes for the given activity. - /// - public IEnumerable> SelectAll(TActivity activity) where TActivity : TeamsActivity - { - return _routes - .OfType>() - .Where(r => r.Selector(activity)); - } - /// /// Dispatches the activity to the first matching route. /// Routes are checked in registration order. /// - public async Task DispatchAsync(Context ctx, CancellationToken cancellationToken = default) + internal async Task DispatchAsync(Context ctx, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(ctx); - // TODO : support multiple routes? - foreach (var route in _routes) - { - if (route.Matches(ctx.Activity)) + var matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); + + if (matchingRoutes.Count == 0 && _routes.Count > 0) { - await route.InvokeRoute(ctx, cancellationToken).ConfigureAwait(false); - return; - } + logger.LogDebug( + "No routes matched activity type '{Type}'", + ctx.Activity.Type + ); + return; + } + + if (matchingRoutes.Count > 1) + { + logger.LogWarning( + "Activity type '{Type}' matched {Count} routes: [{Routes}]. Only the first route will execute without Next().", + ctx.Activity.Type, + matchingRoutes.Count, + string.Join(", ", matchingRoutes.Select(r => r.Name)) + ); } + + await matchingRoutes[0].InvokeRoute(ctx, cancellationToken).ConfigureAwait(false); } /// @@ -74,19 +71,31 @@ public async Task DispatchAsync(Context ctx, CancellationToken ca /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains a response object with the outcome /// of the invocation. - public async Task DispatchWithReturnAsync(Context ctx, CancellationToken cancellationToken = default) + internal async Task DispatchWithReturnAsync(Context ctx, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(ctx); - // TODO : support multiple routes? - foreach (var route in _routes) + var matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); + + if (matchingRoutes.Count == 0 && _routes.Count > 0) { - if (route.Matches(ctx.Activity)) - { - return await route.InvokeRouteWithReturn(ctx, cancellationToken).ConfigureAwait(false); - } + logger.LogWarning( + "No routes matched activity type '{Type}'", + ctx.Activity.Type + ); + return null!; // TODO : return appropriate response + } + + if (matchingRoutes.Count > 1) + { + logger.LogWarning( + "Activity type '{Type}' matched {Count} routes: [{Routes}]. Only the first route will execute without Next().", + ctx.Activity.Type, + matchingRoutes.Count, + string.Join(", ", matchingRoutes.Select(r => r.Name)) + ); } - return null!; // TODO : return appropriate response + return await matchingRoutes[0].InvokeRouteWithReturn(ctx, cancellationToken).ConfigureAwait(false); } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs new file mode 100644 index 00000000..165649d9 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs @@ -0,0 +1,213 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.Schema.ConversationActivities; + +/// +/// Represents a conversation update activity. +/// +[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] +public class ConversationUpdateActivity : TeamsActivity +{ + /// + /// Convenience method to create a ConversationUpdateActivity from a CoreActivity. + /// + /// The CoreActivity to convert. + /// A ConversationUpdateActivity instance. + public static new ConversationUpdateActivity FromActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + return new ConversationUpdateActivity(activity); + } + + /// + /// Default constructor. + /// + [JsonConstructor] + public ConversationUpdateActivity() : base(TeamsActivityType.ConversationUpdate) + { + } + + /// + /// Internal constructor to create ConversationUpdateActivity from CoreActivity. + /// + /// The CoreActivity to convert. + protected ConversationUpdateActivity(CoreActivity activity) : base(activity) + { + /* + if (activity.Properties.TryGetValue("topicName", out var topicName)) + { + TopicName = topicName?.ToString(); + activity.Properties.Remove("topicName"); + } + + if (activity.Properties.TryGetValue("historyDisclosed", out var historyDisclosed) && historyDisclosed != null) + { + if (historyDisclosed is JsonElement je) + { + if (je.ValueKind == JsonValueKind.True) + HistoryDisclosed = true; + else if (je.ValueKind == JsonValueKind.False) + HistoryDisclosed = false; + } + else if (historyDisclosed is bool boolValue) + { + HistoryDisclosed = boolValue; + } + else if (bool.TryParse(historyDisclosed.ToString(), out var result)) + { + HistoryDisclosed = result; + } + activity.Properties.Remove("historyDisclosed"); + } + */ + + if (activity.Properties.TryGetValue("membersAdded", out var membersAdded) && membersAdded != null) + { + if (membersAdded is JsonElement je) + { + MembersAdded = JsonSerializer.Deserialize>(je.GetRawText()); + } + else + { + MembersAdded = membersAdded as IList; + } + activity.Properties.Remove("membersAdded"); + } + + if (activity.Properties.TryGetValue("membersRemoved", out var membersRemoved) && membersRemoved != null) + { + if (membersRemoved is JsonElement je) + { + MembersRemoved = JsonSerializer.Deserialize>(je.GetRawText()); + } + else + { + MembersRemoved = membersRemoved as IList; + } + activity.Properties.Remove("membersRemoved"); + } + } + + //TODO : review properties + /* + /// + /// Gets or sets the updated topic name of the conversation. + /// + [JsonPropertyName("topicName")] + public string? TopicName { get; set; } + + /// + /// Gets or sets a value indicating whether the prior history is disclosed. + /// + [JsonPropertyName("historyDisclosed")] + public bool? HistoryDisclosed { get; set; } + */ + + /// + /// Gets or sets the collection of members added to the conversation. + /// + [JsonPropertyName("membersAdded")] + public IList? MembersAdded { get; set; } + + /// + /// Gets or sets the collection of members removed from the conversation. + /// + [JsonPropertyName("membersRemoved")] + public IList? MembersRemoved { get; set; } +} + +/// +/// String constants for conversation event types. +/// +public static class ConversationEventTypes +{ + /// + /// Channel created event. + /// + public const string ChannelCreated = "channelCreated"; + + /// + /// Channel deleted event. + /// + public const string ChannelDeleted = "channelDeleted"; + + /// + /// Channel renamed event. + /// + public const string ChannelRenamed = "channelRenamed"; + + //TODO : review these events + /* + /// + /// Channel restored event. + /// + public const string ChannelRestored = "channelRestored"; + + /// + /// Channel shared event. + /// + public const string ChannelShared = "channelShared"; + + /// + /// Channel unshared event. + /// + public const string ChannelUnShared = "channelUnShared"; + + /// + /// Channel member added event. + /// + public const string ChannelMemberAdded = "channelMemberAdded"; + + /// + /// Channel member removed event. + /// + public const string ChannelMemberRemoved = "channelMemberRemoved"; + */ + + /// + /// Team member added event. + /// + public const string TeamMemberAdded = "teamMemberAdded"; + + /// + /// Team member removed event. + /// + public const string TeamMemberRemoved = "teamMemberRemoved"; + + /// + /// Team archived event. + /// + public const string TeamArchived = "teamArchived"; + + /// + /// Team deleted event. + /// + public const string TeamDeleted = "teamDeleted"; + + /// + /// Team renamed event. + /// + public const string TeamRenamed = "teamRenamed"; + + /// + /// Team unarchived event. + /// + public const string TeamUnarchived = "teamUnarchived"; + + /*TODO : review these events + /// + /// Team hard deleted event. + /// + public const string TeamHardDeleted = "teamHardDeleted"; + + /// + /// Team restored event. + /// + public const string TeamRestored = "teamRestored"; + */ +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs index 07dc22b2..41111012 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs @@ -42,10 +42,9 @@ public static MentionEntity AddMention(this TeamsActivity activity, Conversation ArgumentNullException.ThrowIfNull(activity); ArgumentNullException.ThrowIfNull(account); string? mentionText = text ?? account.Name; - if (addText) + if (addText && activity is MessageActivity msg) { - string? currentText = activity.Properties.TryGetValue("text", out var t) ? t?.ToString() : null; - activity.Properties["text"] = $"{mentionText} {currentText}"; + msg.Text = $"{mentionText} {msg.Text}"; } activity.Entities ??= []; MentionEntity mentionEntity = new(account, $"{mentionText}"); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/InstallActivities/InstallUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/InstallActivities/InstallUpdateActivity.cs new file mode 100644 index 00000000..964157b5 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/InstallActivities/InstallUpdateActivity.cs @@ -0,0 +1,67 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.Schema.InstallActivities; + +/// +/// Represents an installation update activity. +/// +public class InstallUpdateActivity : TeamsActivity +{ + /// + /// Convenience method to create an InstallUpdateActivity from a CoreActivity. + /// + /// The CoreActivity to convert. + /// An InstallUpdateActivity instance. + public static new InstallUpdateActivity FromActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + return new InstallUpdateActivity(activity); + } + + /// + /// Default constructor. + /// + [JsonConstructor] + public InstallUpdateActivity() : base(TeamsActivityType.InstallationUpdate) + { + } + + /// + /// Internal constructor to create InstallUpdateActivity from CoreActivity. + /// + /// The CoreActivity to convert. + protected InstallUpdateActivity(CoreActivity activity) : base(activity) + { + if (activity.Properties.TryGetValue("action", out var action)) + { + Action = action?.ToString(); + activity.Properties.Remove("action"); + } + } + + /// + /// Gets or sets the action for the installation update. See for known values. + /// + [JsonPropertyName("action")] + public string? Action { get; set; } +} + +/// +/// String constants for installation update actions. +/// +public static class InstallUpdateActions +{ + /// + /// Add action constant. + /// + public const string Add = "add"; + + /// + /// Remove action constant. + /// + public const string Remove = "remove"; +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs index 7f14b6c3..edbb31a5 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs @@ -19,28 +19,14 @@ public class InvokeActivity : TeamsActivity public static new InvokeActivity FromActivity(CoreActivity activity) { ArgumentNullException.ThrowIfNull(activity); - return new InvokeActivity(activity); - } - - /// - /// Convenience method to deserialize a JSON string into an InvokeActivity instance. - /// - /// - /// - public static new InvokeActivity FromJsonString(string json) - { - return FromJsonString(json, TeamsActivityJsonContext.Default.InvokeActivity); + return new InvokeActivity(activity); } /// /// Gets or sets the name of the operation. See for common values. /// [JsonPropertyName("name")] - public string? Name - { - get => base.Properties.TryGetValue("name", out var value) ? value?.ToString() : null; - set => base.Properties["name"] = value; - } + public string? Name { get; set; } ///// ///// Gets or sets a value that is associated with the activity. ///// @@ -69,17 +55,14 @@ public InvokeActivity(string name) : base(TeamsActivityType.Invoke) /// Initializes a new instance of the InvokeActivity class with the specified core activity. /// /// The core activity to be invoked. Cannot be null. - protected InvokeActivity(CoreActivity activity) : base(TeamsActivityType.Invoke) + protected InvokeActivity(CoreActivity activity) : base(activity) { ArgumentNullException.ThrowIfNull(activity); - this.Value = activity.Value; - this.ChannelId = activity.ChannelId; - this.ChannelData = new TeamsChannelData(activity.ChannelData); - this.ServiceUrl = activity.ServiceUrl; - this.Conversation = new TeamsConversation(activity.Conversation); - this.From = new TeamsConversationAccount(activity.From); - this.Recipient = new TeamsConversationAccount(activity.Recipient); - this.Properties = activity.Properties; + if (activity.Properties.TryGetValue("name", out var name)) + { + Name = name?.ToString(); + activity.Properties.Remove("name"); + } } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs index a320da5b..95f8b58d 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System; using System.Text.Json; using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; @@ -24,23 +25,6 @@ public class MessageActivity : TeamsActivity return new MessageActivity(activity); } - /// - /// Deserializes a JSON string into a MessageActivity instance. - /// - /// The JSON string to deserialize. - /// A MessageActivity instance. - public static new MessageActivity FromJsonString(string json) - { - return FromJsonString(json, TeamsActivityJsonContext.Default.MessageActivity); - } - - /// - /// Serializes the MessageActivity to JSON with all message-specific properties. - /// - /// JSON string representation of the MessageActivity - public new string ToJson() - => ToJson(TeamsActivityJsonContext.Default.MessageActivity); - /// /// Default constructor. /// @@ -74,142 +58,158 @@ public MessageActivity(IList attachments) : base(TeamsActivityT /// The CoreActivity to convert. protected MessageActivity(CoreActivity activity) : base(activity) { + if (activity.Properties.TryGetValue("text", out var text)) + { + Text = text?.ToString(); + activity.Properties.Remove("text"); + } + if (activity.Properties.TryGetValue("textFormat", out var textFormat)) + { + TextFormat = textFormat?.ToString(); + activity.Properties.Remove("textFormat"); + } + if (activity.Properties.TryGetValue("attachmentLayout", out var attachmentLayout)) + { + AttachmentLayout = attachmentLayout?.ToString(); + activity.Properties.Remove("attachmentLayout"); + } + /* + if (activity.Properties.TryGetValue("speak", out var speak)) + { + Speak = speak?.ToString(); + activity.Properties.Remove("speak"); + } + if (activity.Properties.TryGetValue("inputHint", out var inputHint)) + { + InputHint = inputHint?.ToString(); + activity.Properties.Remove("inputHint"); + } + if (activity.Properties.TryGetValue("summary", out var summary)) + { + Summary = summary?.ToString(); + activity.Properties.Remove("summary"); + } + if (activity.Properties.TryGetValue("importance", out var importance)) + { + Importance = importance?.ToString(); + activity.Properties.Remove("importance"); + } + if (activity.Properties.TryGetValue("deliveryMode", out var deliveryMode)) + { + DeliveryMode = deliveryMode?.ToString(); + activity.Properties.Remove("deliveryMode"); + } + if (activity.Properties.TryGetValue("expiration", out var expiration)) + { + Expiration = expiration?.ToString(); + activity.Properties.Remove("expiration"); + } + */ } /// /// Gets or sets the text content of the message. /// [JsonPropertyName("text")] - public string? Text - { - get => base.Properties.TryGetValue("text", out var value) ? value?.ToString() : null; - set => base.Properties["text"] = value; - } + public string? Text { get; set; } + /// + /// Gets or sets the text format. See for common values. + /// + [JsonPropertyName("textFormat")] + public string? TextFormat { get; set; } + /// + /// Gets or sets the attachment layout. + /// + [JsonPropertyName("attachmentLayout")] + public string? AttachmentLayout { get; set; } + + //TODO : Review properties + /* /// /// Gets or sets the SSML speak content of the message. /// [JsonPropertyName("speak")] - public string? Speak - { - get => base.Properties.TryGetValue("speak", out var value) ? value?.ToString() : null; - set => base.Properties["speak"] = value; - } + public string? Speak { get; set; } /// /// Gets or sets the input hint. See for common values. /// [JsonPropertyName("inputHint")] - public string? InputHint - { - get => base.Properties.TryGetValue("inputHint", out var value) ? value?.ToString() : null; - set => base.Properties["inputHint"] = value; - } + public string? InputHint { get; set; } /// /// Gets or sets the summary of the message. /// [JsonPropertyName("summary")] - public string? Summary - { - get => base.Properties.TryGetValue("summary", out var value) ? value?.ToString() : null; - set => base.Properties["summary"] = value; - } - - /// - /// Gets or sets the text format. See for common values. - /// - [JsonPropertyName("textFormat")] - public string? TextFormat - { - get => base.Properties.TryGetValue("textFormat", out var value) ? value?.ToString() : null; - set => base.Properties["textFormat"] = value; - } - - /// - /// Gets or sets the attachment layout. - /// - [JsonPropertyName("attachmentLayout")] - public string? AttachmentLayout - { - get => base.Properties.TryGetValue("attachmentLayout", out var value) ? value?.ToString() : null; - set => base.Properties["attachmentLayout"] = value; - } + public string? Summary { get; set; } /// /// Gets or sets the importance. See for common values. /// [JsonPropertyName("importance")] - public string? Importance - { - get => base.Properties.TryGetValue("importance", out var value) ? value?.ToString() : null; - set => base.Properties["importance"] = value; - } + public string? Importance { get; set; } /// /// Gets or sets the delivery mode. See for common values. /// [JsonPropertyName("deliveryMode")] - public string? DeliveryMode - { - get => base.Properties.TryGetValue("deliveryMode", out var value) ? value?.ToString() : null; - set => base.Properties["deliveryMode"] = value; - } + public string? DeliveryMode { get; set; } /// /// Gets or sets the expiration time of the message. /// [JsonPropertyName("expiration")] - public DateTime? Expiration - { - get => base.Properties.TryGetValue("expiration", out var value) && value != null - ? (DateTime.TryParse(value.ToString(), out var date) ? date : null) - : null; - set => base.Properties["expiration"] = value; - } + public string? Expiration { get; set; } + + [JsonPropertyName("suggestedActions")] + public SuggestedActions? SuggestedActions { get; set; } + */ } /// -/// String constants for input hints. +/// String constants for text formats. /// -public static class InputHints +public static class TextFormats { /// - /// Accepting input hint. + /// Plain text format. /// - public const string AcceptingInput = "acceptingInput"; + public const string Plain = "plain"; /// - /// Ignoring input hint. + /// Markdown text format. /// - public const string IgnoringInput = "ignoringInput"; + public const string Markdown = "markdown"; /// - /// Expecting input hint. + /// XML text format. /// - public const string ExpectingInput = "expectingInput"; + public const string Xml = "xml"; } + +/* /// -/// String constants for text formats. +/// String constants for input hints. /// -public static class TextFormats +public static class InputHints { /// - /// Plain text format. + /// Accepting input hint. /// - public const string Plain = "plain"; + public const string AcceptingInput = "acceptingInput"; /// - /// Markdown text format. + /// Ignoring input hint. /// - public const string Markdown = "markdown"; + public const string IgnoringInput = "ignoringInput"; /// - /// XML text format. + /// Expecting input hint. /// - public const string Xml = "xml"; + public const string ExpectingInput = "expectingInput"; } /// @@ -263,3 +263,21 @@ public static class DeliveryModes /// public const string ExpectedReplies = "expectReplies"; } + + +public class SuggestedActions +{ + /// + /// Ids of the recipients that the actions should be shown to. These Ids are relative to the + /// channelId and a subset of all recipients of the activity + /// + [JsonPropertyName("to")] + public IList To { get; set; } = []; + + /// + /// Actions that can be shown to the user + /// + [JsonPropertyName("actions")] + public IList Actions { get; set; } = []; +} +*/ diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs index 02292fd2..dea042dd 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs @@ -23,23 +23,6 @@ public class MessageDeleteActivity : TeamsActivity return new MessageDeleteActivity(activity); } - /// - /// Deserializes a JSON string into a MessageDeleteActivity instance. - /// - /// The JSON string to deserialize. - /// A MessageDeleteActivity instance. - public static new MessageDeleteActivity FromJsonString(string json) - { - return FromJsonString(json, TeamsActivityJsonContext.Default.MessageDeleteActivity); - } - - /// - /// Serializes the MessageDeleteActivity to JSON with all message delete-specific properties. - /// - /// JSON string representation of the MessageDeleteActivity - public new string ToJson() - => ToJson(TeamsActivityJsonContext.Default.MessageDeleteActivity); - /// /// Default constructor. /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs index 8b918211..5222dec8 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs @@ -25,23 +25,6 @@ public class MessageReactionActivity : TeamsActivity return new MessageReactionActivity(activity); } - /// - /// Deserializes a JSON string into a MessageReactionActivity instance. - /// - /// The JSON string to deserialize. - /// A MessageReactionActivity instance. - public static new MessageReactionActivity FromJsonString(string json) - { - return FromJsonString(json, TeamsActivityJsonContext.Default.MessageReactionActivity); - } - - /// - /// Serializes the MessageReactionActivity to JSON with all message reaction-specific properties. - /// - /// JSON string representation of the MessageReactionActivity - public new string ToJson() - => ToJson(TeamsActivityJsonContext.Default.MessageReactionActivity); - /// /// Default constructor. /// @@ -56,15 +39,29 @@ public MessageReactionActivity() : base(TeamsActivityType.MessageReaction) /// The CoreActivity to convert. protected MessageReactionActivity(CoreActivity activity) : base(activity) { - if (activity.Properties.TryGetValue("reactionsAdded", out var reactionsAdded)) + if (activity.Properties.TryGetValue("reactionsAdded", out var reactionsAdded) && reactionsAdded != null) { - ReactionsAdded = JsonSerializer.Deserialize>( - reactionsAdded?.ToString() ?? "[]"); + if (reactionsAdded is JsonElement je) + { + ReactionsAdded = JsonSerializer.Deserialize>(je.GetRawText()); + } + else + { + ReactionsAdded = reactionsAdded as IList; + } + activity.Properties.Remove("reactionsAdded"); } - if (activity.Properties.TryGetValue("reactionsRemoved", out var reactionsRemoved)) + if (activity.Properties.TryGetValue("reactionsRemoved", out var reactionsRemoved) && reactionsRemoved != null) { - ReactionsRemoved = JsonSerializer.Deserialize>( - reactionsRemoved?.ToString() ?? "[]"); + if (reactionsRemoved is JsonElement je) + { + ReactionsRemoved = JsonSerializer.Deserialize>(je.GetRawText()); + } + else + { + ReactionsRemoved = reactionsRemoved as IList; + } + activity.Properties.Remove("reactionsRemoved"); } } @@ -92,41 +89,19 @@ public class MessageReaction [JsonPropertyName("type")] public string? Type { get; set; } + /* /// /// Gets or sets the date and time when the reaction was created. /// [JsonPropertyName("createdDateTime")] - public DateTime? CreatedDateTime { get; set; } + public string? CreatedDateTime { get; set; } /// /// Gets or sets the user who created the reaction. /// [JsonPropertyName("user")] public ReactionUser? User { get; set; } -} - -/// -/// Represents a user who created a reaction. -/// -public class ReactionUser -{ - /// - /// Gets or sets the user identifier. - /// - [JsonPropertyName("id")] - public string? Id { get; set; } - - /// - /// Gets or sets the user identity type. - /// - [JsonPropertyName("userIdentityType")] - public string? UserIdentityType { get; set; } - - /// - /// Gets or sets the display name of the user. - /// - [JsonPropertyName("displayName")] - public string? DisplayName { get; set; } + */ } /// @@ -170,6 +145,31 @@ public static class ReactionTypes public const string PlusOne = "plusOne"; } +/* +/// +/// Represents a user who created a reaction. +/// +public class ReactionUser +{ + /// + /// Gets or sets the user identifier. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Gets or sets the user identity type. + /// + [JsonPropertyName("userIdentityType")] + public string? UserIdentityType { get; set; } + + /// + /// Gets or sets the display name of the user. + /// + [JsonPropertyName("displayName")] + public string? DisplayName { get; set; } +} + /// /// String constants for user identity types. /// @@ -195,3 +195,4 @@ public static class UserIdentityTypes /// public const string FederatedUser = "federatedUser"; } +*/ diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs index 2133a881..037d5051 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs @@ -23,23 +23,6 @@ public class MessageUpdateActivity : MessageActivity return new MessageUpdateActivity(activity); } - /// - /// Deserializes a JSON string into a MessageUpdateActivity instance. - /// - /// The JSON string to deserialize. - /// A MessageUpdateActivity instance. - public static new MessageUpdateActivity FromJsonString(string json) - { - return FromJsonString(json, TeamsActivityJsonContext.Default.MessageUpdateActivity); - } - - /// - /// Serializes the MessageUpdateActivity to JSON with all message update-specific properties. - /// - /// JSON string representation of the MessageUpdateActivity - public new string ToJson() - => ToJson(TeamsActivityJsonContext.Default.MessageUpdateActivity); - /// /// Default constructor. /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs index 1775eb1e..bbd47520 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs @@ -1,10 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text; -using System.Text.Json; using System.Text.Json.Serialization; -using System.Text.Json.Serialization.Metadata; using Microsoft.Teams.Bot.Apps.Schema.Entities; using Microsoft.Teams.Bot.Core.Schema; @@ -26,59 +23,22 @@ public static TeamsActivity FromActivity(CoreActivity activity) ArgumentNullException.ThrowIfNull(activity); return TeamsActivityType.ActivityDeserializerMap.TryGetValue(activity.Type, out var factory) - ? factory.FromActivity(activity) + ? factory(activity) : new TeamsActivity(activity); // Fallback to base type } /// - /// Creates a new instance of the TeamsActivity class from the specified Activity object. - /// - /// - /// - public static new TeamsActivity FromJsonString(string json) - { - string? type = null; - var jsonBytes = Encoding.UTF8.GetBytes(json); - var reader = new Utf8JsonReader(jsonBytes); - - while (reader.Read()) - { - if (reader.TokenType == JsonTokenType.PropertyName && - reader.ValueTextEquals("type"u8)) - { - reader.Read(); - type = reader.GetString(); - break; - } - } - - return type != null && TeamsActivityType.ActivityDeserializerMap.TryGetValue(type, out var factory) - ? factory.FromJson(json) - : FromJsonString(json, TeamsActivityJsonContext.Default.TeamsActivity); - } - - /// - /// Creates a new instance of the specified activity type from JSON string. + /// Overrides the ToJson method to serialize the TeamsActivity object to a JSON string. + /// Uses the activity type serializer map to select the appropriate JSON type info. /// - /// The expected activity type. - /// The JSON string to deserialize. - /// The JSON type info for deserialization. - /// An activity of type T. - public static T FromJsonString(string json, JsonTypeInfo typeInfo) where T : TeamsActivity + /// A JSON string representation of the activity using the type-specific serializer. + public override string ToJson() { - T activity = JsonSerializer.Deserialize(json, typeInfo)!; - activity.Rebase(); - return activity; + return TeamsActivityType.ActivitySerializerMap.TryGetValue(Type, out var serializer) + ? serializer(this) + : ToJson(TeamsActivityJsonContext.Default.TeamsActivity); // Fallback to base type } - - /// - /// Overrides the ToJson method to serialize the TeamsActivity object to a JSON string. - /// - /// - public new string ToJson() - => ToJson(TeamsActivityJsonContext.Default.TeamsActivity); - /// /// Constructor with type parameter. /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs index c9f31db6..d7271825 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs @@ -19,9 +19,6 @@ namespace Microsoft.Teams.Bot.Apps.Schema; [JsonSerializable(typeof(CoreActivity))] [JsonSerializable(typeof(TeamsActivity))] [JsonSerializable(typeof(MessageActivity))] -[JsonSerializable(typeof(MessageReactionActivity))] -[JsonSerializable(typeof(MessageUpdateActivity))] -[JsonSerializable(typeof(MessageDeleteActivity))] [JsonSerializable(typeof(InvokeActivity))] [JsonSerializable(typeof(Entity))] [JsonSerializable(typeof(EntityList))] @@ -32,7 +29,12 @@ namespace Microsoft.Teams.Bot.Apps.Schema; [JsonSerializable(typeof(TeamsConversationAccount))] [JsonSerializable(typeof(TeamsConversation))] [JsonSerializable(typeof(ExtendedPropertiesDictionary))] +[JsonSerializable(typeof(TeamsAttachment))] [JsonSerializable(typeof(System.Text.Json.JsonElement))] +[JsonSerializable(typeof(System.Text.Json.Nodes.JsonObject))] +[JsonSerializable(typeof(System.Text.Json.Nodes.JsonNode))] +[JsonSerializable(typeof(System.Text.Json.Nodes.JsonArray))] +[JsonSerializable(typeof(System.Text.Json.Nodes.JsonValue))] [JsonSerializable(typeof(System.Int32))] [JsonSerializable(typeof(System.Boolean))] [JsonSerializable(typeof(System.Int64))] diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs index 9795fb82..9994e503 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs @@ -1,6 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using Microsoft.Teams.Bot.Apps.Schema.ConversationActivities; +using Microsoft.Teams.Bot.Apps.Schema.InstallActivities; using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using Microsoft.Teams.Bot.Core.Schema; @@ -37,6 +39,23 @@ public static class TeamsActivityType /// public const string MessageDelete = "messageDelete"; + /// + /// Represents a conversation update activity. + /// + public const string ConversationUpdate = "conversationUpdate"; + + /* + /// + /// Represents an end of conversation activity. + /// + public const string EndOfConversation = "endOfConversation"; + */ + + /// + /// Represents an installation update activity. + /// + public const string InstallationUpdate = "installationUpdate"; + /// /// Represents the string value "invoke" used to identify an invoke operation or action. /// @@ -45,14 +64,25 @@ public static class TeamsActivityType /// /// Registry of activity type factories for creating specialized activity instances. /// - internal static readonly Dictionary FromActivity, - Func FromJson)> ActivityDeserializerMap = new() + internal static readonly Dictionary> ActivityDeserializerMap = new() + { + [TeamsActivityType.Message] = MessageActivity.FromActivity, + [TeamsActivityType.MessageReaction] = MessageReactionActivity.FromActivity, + [TeamsActivityType.MessageUpdate] = MessageUpdateActivity.FromActivity, + [TeamsActivityType.MessageDelete] = MessageDeleteActivity.FromActivity, + [TeamsActivityType.ConversationUpdate] = ConversationUpdateActivity.FromActivity, + //[TeamsActivityType.EndOfConversation] = EndOfConversationActivity.FromActivity, + [TeamsActivityType.InstallationUpdate] = InstallUpdateActivity.FromActivity, + [TeamsActivityType.Invoke] = InvokeActivity.FromActivity, + }; + + /// + /// Registry of serialization functions for specialized activity instances. + /// Maps activity types to functions that serialize the activity using the appropriate JsonTypeInfo. + /// + internal static readonly Dictionary> ActivitySerializerMap = new() { - [TeamsActivityType.Message] = (MessageActivity.FromActivity, MessageActivity.FromJsonString), - [TeamsActivityType.MessageReaction] = (MessageReactionActivity.FromActivity, MessageReactionActivity.FromJsonString), - [TeamsActivityType.MessageUpdate] = (MessageUpdateActivity.FromActivity, MessageUpdateActivity.FromJsonString), - [TeamsActivityType.MessageDelete] = (MessageDeleteActivity.FromActivity, MessageDeleteActivity.FromJsonString), - [TeamsActivityType.Invoke] = (InvokeActivity.FromActivity, InvokeActivity.FromJsonString), - }; // TODO: Review if we need FromJson in this map + [TeamsActivityType.Message] = activity => activity.ToJson(TeamsActivityJsonContext.Default.MessageActivity), + [TeamsActivityType.Invoke] = activity => activity.ToJson(TeamsActivityJsonContext.Default.InvokeActivity), + }; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs index d17f8adf..bcd50055 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs @@ -7,6 +7,49 @@ namespace Microsoft.Teams.Bot.Apps.Schema; +/// +/// Represents the source of a Teams activity. +/// +public class TeamsChannelDataSource +{ + /// + /// The name of the source. + /// + [JsonPropertyName("name")] public string? Name { get; set; } +} + +/// +/// Tenant information for Teams channel data. +/// +public class TeamsChannelDataTenant +{ + /// + /// Unique identifier of the tenant. + /// + [JsonPropertyName("id")] public string? Id { get; set; } +} + +/// +/// Teams channel data settings. +/// +public class TeamsChannelDataSettings +{ + /// + /// Selected channel information. + /// + [JsonPropertyName("selectedChannel")] public required TeamsChannel SelectedChannel { get; set; } + + /// + /// Gets or sets the collection of additional properties not explicitly defined by the type. + /// + /// This property stores extra JSON fields encountered during deserialization that do not map to + /// known properties. It enables round-tripping of unknown or custom data without loss. The dictionary keys + /// correspond to the property names in the JSON payload. +#pragma warning disable CA2227 // Collection properties should be read only + [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; +#pragma warning restore CA2227 // Collection properties should be read only +} + /// /// Represents Teams-specific channel data. /// @@ -27,6 +70,7 @@ public TeamsChannelData(ChannelData? cd) { if (cd is not null) { + //TODO : is channel id needed ? what is teamschannleid and teamsteamid ? if (cd.Properties.TryGetValue("teamsChannelId", out object? channelIdObj) && channelIdObj is JsonElement jeChannelId && jeChannelId.ValueKind == JsonValueKind.String) @@ -34,6 +78,20 @@ public TeamsChannelData(ChannelData? cd) TeamsChannelId = jeChannelId.GetString(); } + if (cd.Properties.TryGetValue("teamsTeamId", out object? teamIdObj) + && teamIdObj is JsonElement jeTeamId + && jeTeamId.ValueKind == JsonValueKind.String) + { + TeamsTeamId = jeTeamId.GetString(); + } + + if (cd.Properties.TryGetValue("settings", out object? settingsObj) + && settingsObj is JsonElement settingsObjJE + && settingsObjJE.ValueKind == JsonValueKind.Object) + { + Settings = JsonSerializer.Deserialize(settingsObjJE.GetRawText()); + } + if (cd.Properties.TryGetValue("channel", out object? channelObj) && channelObj is JsonElement channelObjJE && channelObjJE.ValueKind == JsonValueKind.Object) @@ -47,6 +105,27 @@ public TeamsChannelData(ChannelData? cd) { Tenant = JsonSerializer.Deserialize(je.GetRawText()); } + + if (cd.Properties.TryGetValue("eventType", out object? eventTypeObj) + && eventTypeObj is JsonElement jeEventType + && jeEventType.ValueKind == JsonValueKind.String) + { + EventType = jeEventType.GetString(); + } + + if (cd.Properties.TryGetValue("team", out object? teamObj) + && teamObj is JsonElement teamObjJE + && teamObjJE.ValueKind == JsonValueKind.Object) + { + Team = JsonSerializer.Deserialize(teamObjJE.GetRawText()); + } + + if (cd.Properties.TryGetValue("source", out object? sourceObj) + && sourceObj is JsonElement sourceObjJE + && sourceObjJE.ValueKind == JsonValueKind.Object) + { + Source = JsonSerializer.Deserialize(sourceObjJE.GetRawText()); + } } } @@ -81,4 +160,14 @@ public TeamsChannelData(ChannelData? cd) /// [JsonPropertyName("tenant")] public TeamsChannelDataTenant? Tenant { get; set; } + /// + /// Gets or sets the event type for conversation updates. See for known values. + /// + [JsonPropertyName("eventType")] public string? EventType { get; set; } + + /// + /// Source information for the activity. + /// + [JsonPropertyName("source")] public TeamsChannelDataSource? Source { get; set; } + } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataSettings.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataSettings.cs deleted file mode 100644 index 0b6a5214..00000000 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataSettings.cs +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using System.Text.Json.Serialization; -using Microsoft.Teams.Bot.Core.Schema; - -namespace Microsoft.Teams.Bot.Apps.Schema; - -/// -/// Teams channel data settings. -/// -public class TeamsChannelDataSettings -{ - /// - /// Selected channel information. - /// - [JsonPropertyName("selectedChannel")] public required TeamsChannel SelectedChannel { get; set; } - - /// - /// Gets or sets the collection of additional properties not explicitly defined by the type. - /// - /// This property stores extra JSON fields encountered during deserialization that do not map to - /// known properties. It enables round-tripping of unknown or custom data without loss. The dictionary keys - /// correspond to the property names in the JSON payload. -#pragma warning disable CA2227 // Collection properties should be read only - [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; -#pragma warning restore CA2227 // Collection properties should be read only -} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataTenant.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataTenant.cs deleted file mode 100644 index 5f2d59d6..00000000 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelDataTenant.cs +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using System.Text.Json.Serialization; - -namespace Microsoft.Teams.Bot.Apps.Schema; - -/// -/// Tenant information for Teams channel data. -/// -public class TeamsChannelDataTenant -{ - /// - /// Unique identifier of the tenant. - /// - [JsonPropertyName("id")] public string? Id { get; set; } -} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs index aa310b49..e33d1eec 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs @@ -21,6 +21,11 @@ public static class ConversationType /// Group chat conversation. /// public const string GroupChat = "groupChat"; + + /// + /// Channel conversation + /// + public const string Channel = "channel"; } /// @@ -34,7 +39,6 @@ public class TeamsConversation : Conversation [JsonConstructor] public TeamsConversation() { - Id = string.Empty; } /// @@ -44,7 +48,7 @@ public TeamsConversation() public TeamsConversation(Conversation conversation) { ArgumentNullException.ThrowIfNull(conversation); - Id = conversation.Id ?? string.Empty; + Id = conversation.Id; if (conversation.Properties == null) { return; @@ -57,6 +61,17 @@ public TeamsConversation(Conversation conversation) { ConversationType = je2.GetString(); } + if (conversation.Properties.TryGetValue("isGroup", out object? isGroupObj) && isGroupObj is JsonElement je3) + { + if (je3.ValueKind == JsonValueKind.True) + { + IsGroup = true; + } + else if (je3.ValueKind == JsonValueKind.False) + { + IsGroup = false; + } + } } /// @@ -68,4 +83,9 @@ public TeamsConversation(Conversation conversation) /// Conversation Type. See for known values. /// [JsonPropertyName("conversationType")] public string? ConversationType { get; set; } + + /// + /// Indicates whether the conversation is a group conversation. + /// + [JsonPropertyName("isGroup")] public bool? IsGroup { get; set; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs index 774df35e..3b966fb7 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs @@ -16,20 +16,12 @@ namespace Microsoft.Teams.Bot.Apps.Schema; /// conversations to access Teams-specific metadata. public class TeamsConversationAccount : ConversationAccount { - /// - /// Conversation account. - /// - public ConversationAccount ConversationAccount { get; set; } - /// /// Initializes a new instance of the TeamsConversationAccount class. /// [JsonConstructor] public TeamsConversationAccount() { - ConversationAccount = new ConversationAccount(); - Id = string.Empty; - Name = string.Empty; } /// @@ -42,10 +34,8 @@ public TeamsConversationAccount() public TeamsConversationAccount(ConversationAccount conversationAccount) { ArgumentNullException.ThrowIfNull(conversationAccount); - ConversationAccount = conversationAccount; - Properties = conversationAccount.Properties; - Id = conversationAccount.Id ?? string.Empty; - Name = conversationAccount.Name ?? string.Empty; + Id = conversationAccount.Id; + Name = conversationAccount.Name; // Extract properties from the Properties dictionary if (conversationAccount.Properties.TryGetValue("aadObjectId", out object? aadObj) diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs index c8644507..99285853 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs @@ -6,6 +6,7 @@ using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; +using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Core.Hosting; namespace Microsoft.Teams.Bot.Apps; @@ -46,6 +47,7 @@ public static IServiceCollection AddTeamsBotApplication(this IServiceCollection sp.GetService>()); }); + services.AddSingleton(); services.AddBotApplication(); return services; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 9f23824b..037ce953 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -7,9 +7,7 @@ using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Apps.Routing; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using Microsoft.Teams.Bot.Apps.Handlers; -using Microsoft.Identity.Client; namespace Microsoft.Teams.Bot.Apps; @@ -21,8 +19,12 @@ public class TeamsBotApplication : BotApplication { private readonly TeamsApiClient _teamsApiClient; private static TeamsBotApplicationBuilder? _botApplicationBuilder; - internal Router Router = new(); - + + /// + /// Gets the router for dispatching Teams activities to registered routes. + /// + internal Router Router { get; } + /// /// Gets the client used to interact with the Teams API service. /// @@ -35,6 +37,7 @@ public class TeamsBotApplication : BotApplication /// /// /// + /// /// public TeamsBotApplication( ConversationClient conversationClient, @@ -43,10 +46,12 @@ public TeamsBotApplication( IConfiguration config, IHttpContextAccessor httpContextAccessor, ILogger logger, + Router router, string sectionName = "AzureAd") : base(conversationClient, userTokenClient, config, logger, sectionName) { _teamsApiClient = teamsApiClient; + Router = router; OnActivity = async (activity, cancellationToken) => { logger.LogInformation("New {Type} activity received.", activity.Type); diff --git a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs index 3fc0846b..1bd1a5b6 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs @@ -156,7 +156,7 @@ protected CoreActivity(CoreActivity activity) /// Serializes the current activity to a JSON string. /// /// A JSON string representation of the activity. - public string ToJson() + public virtual string ToJson() => JsonSerializer.Serialize(this, CoreActivityJsonContext.Default.CoreActivity); /// diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs new file mode 100644 index 00000000..56a76154 --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs @@ -0,0 +1,146 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Core.Schema; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Apps.Schema.ConversationActivities; +using Microsoft.Teams.Bot.Apps.Schema.InstallActivities; +using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; + +namespace Microsoft.Teams.Bot.Apps.UnitTests; + +/// +/// Tests for simple activity types. +/// +public class ActivitiesTests +{ + [Fact] + public void MessageReaction_FromActivityConvertsCorrectly() + { + var coreActivity = new CoreActivity + { + Type = TeamsActivityType.MessageReaction + }; + coreActivity.Properties["reactionsAdded"] = System.Text.Json.JsonSerializer.SerializeToElement(new[] + { + new { type = "like" }, + new { type = "heart" } + }); + + MessageReactionActivity activity = MessageReactionActivity.FromActivity(coreActivity); + Assert.NotNull(activity); + Assert.Equal(TeamsActivityType.MessageReaction, activity.Type); + Assert.NotNull(activity.ReactionsAdded); + Assert.Equal(2, activity.ReactionsAdded!.Count); + } + + [Fact] + public void MessageDelete_Constructor_Default_SetsMessageDeleteType() + { + MessageDeleteActivity activity = new(); + Assert.Equal(TeamsActivityType.MessageDelete, activity.Type); + } + + [Fact] + public void MessageDelete_FromActivityConvertsCorrectly() + { + var coreActivity = new CoreActivity + { + Type = TeamsActivityType.MessageDelete, + Id = "deleted-msg-id" + }; + + MessageDeleteActivity messageDelete = MessageDeleteActivity.FromActivity(coreActivity); + Assert.NotNull(messageDelete); + Assert.Equal(TeamsActivityType.MessageDelete, messageDelete.Type); + Assert.Equal("deleted-msg-id", messageDelete.Id); + } + + [Fact] + public void MessageUpdate_Constructor_Default_SetsMessageUpdateType() + { + MessageUpdateActivity activity = new(); + Assert.Equal(TeamsActivityType.MessageUpdate, activity.Type); + } + + [Fact] + public void MessageUpdate_Constructor_WithText_SetsTextAndMessageUpdateType() + { + MessageUpdateActivity activity = new("Updated text"); + Assert.Equal(TeamsActivityType.MessageUpdate, activity.Type); + Assert.Equal("Updated text", activity.Text); + } + + [Fact] + public void MessageUpdate_InheritsFromMessageActivity() + { + var activity = new MessageUpdateActivity + { + Text = "Updated", + TextFormat = TextFormats.Markdown + }; + + Assert.Equal("Updated", activity.Text); + //Assert.Equal(InputHints.AcceptingInput, activity.InputHint); + Assert.Equal(TextFormats.Markdown, activity.TextFormat); + } + + [Fact] + public void MessageUpdate_FromActivityConvertsCorrectly() + { + var coreActivity = new CoreActivity + { + Type = TeamsActivityType.MessageUpdate + }; + coreActivity.Properties["text"] = "Test message"; + + MessageUpdateActivity messageUpdate = MessageUpdateActivity.FromActivity(coreActivity); + Assert.NotNull(messageUpdate); + Assert.Equal(TeamsActivityType.MessageUpdate, messageUpdate.Type); + Assert.Equal("Test message", messageUpdate.Text); + } + + [Fact] + public void ConversationUpdate_Constructor_Default_SetsConversationUpdateType() + { + ConversationUpdateActivity activity = new(); + Assert.Equal(TeamsActivityType.ConversationUpdate, activity.Type); + } + + [Fact] + public void ConversationUpdate_FromActivityConvertsCorrectly() + { + var coreActivity = new CoreActivity + { + Type = TeamsActivityType.ConversationUpdate + }; + //coreActivity.Properties["topicName"] = "Converted Topic"; + + ConversationUpdateActivity activity = ConversationUpdateActivity.FromActivity(coreActivity); + Assert.NotNull(activity); + Assert.Equal(TeamsActivityType.ConversationUpdate, activity.Type); + //Assert.Equal("Converted Topic", activity.TopicName); + } + + [Fact] + public void InstallUpdate_Constructor_Default_SetsInstallationUpdateType() + { + InstallUpdateActivity activity = new(); + Assert.Equal(TeamsActivityType.InstallationUpdate, activity.Type); + } + + [Fact] + public void InstallUpdate_FromActivityConvertsCorrectly() + { + var coreActivity = new CoreActivity + { + Type = TeamsActivityType.InstallationUpdate + }; + coreActivity.Properties["action"] = "remove"; + + InstallUpdateActivity activity = InstallUpdateActivity.FromActivity(coreActivity); + Assert.NotNull(activity); + Assert.Equal(TeamsActivityType.InstallationUpdate, activity.Type); + Assert.Equal("remove", activity.Action); + } +} diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs deleted file mode 100644 index 8c9a918e..00000000 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ConversationUpdateActivityTests.cs +++ /dev/null @@ -1,115 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Teams.Bot.Apps.Handlers; -using Microsoft.Teams.Bot.Apps.Schema; - -namespace Microsoft.Teams.Bot.Apps.UnitTests; - -public class ConversationUpdateActivityTests -{ - [Fact] - public void AsConversationUpdate_MembersAdded() - { - string json = """ - { - "type": "conversationUpdate", - "conversation": { - "id": "19" - }, - "membersAdded": [ - { - "id": "user1", - "name": "User One" - }, - { - "id": "bot1", - "name": "Bot One" - } - ] - } - """; - TeamsActivity act = TeamsActivity.FromJsonString(json); - Assert.NotNull(act); - Assert.Equal("conversationUpdate", act.Type); - /* - ConversationUpdateArgs? cua = new(act); - - Assert.NotNull(cua); - Assert.NotNull(cua.MembersAdded); - Assert.Equal(2, cua.MembersAdded!.Count); - Assert.Equal("user1", cua.MembersAdded[0].Id); - Assert.Equal("User One", cua.MembersAdded[0].Name); - Assert.Equal("bot1", cua.MembersAdded[1].Id); - Assert.Equal("Bot One", cua.MembersAdded[1].Name);*/ - } - - [Fact] - public void AsConversationUpdate_MembersRemoved() - { - string json = """ - { - "type": "conversationUpdate", - "conversation": { - "id": "19" - }, - "membersRemoved": [ - { - "id": "user2", - "name": "User Two" - } - ] - } - """; - TeamsActivity act = TeamsActivity.FromJsonString(json); - Assert.NotNull(act); - Assert.Equal("conversationUpdate", act.Type); - /* - ConversationUpdateArgs? cua = new(act); - - Assert.NotNull(cua); - Assert.NotNull(cua.MembersRemoved); - Assert.Single(cua.MembersRemoved!); - Assert.Equal("user2", cua.MembersRemoved[0].Id); - Assert.Equal("User Two", cua.MembersRemoved[0].Name);*/ - } - - [Fact] - public void AsConversationUpdate_BothMembersAddedAndRemoved() - { - string json = """ - { - "type": "conversationUpdate", - "conversation": { - "id": "19" - }, - "membersAdded": [ - { - "id": "newuser", - "name": "New User" - } - ], - "membersRemoved": [ - { - "id": "olduser", - "name": "Old User" - } - ] - } - """; - TeamsActivity act = TeamsActivity.FromJsonString(json); - Assert.NotNull(act); - Assert.Equal("conversationUpdate", act.Type); - /* - ConversationUpdateArgs? cua = new(act); - - Assert.NotNull(cua); - Assert.NotNull(cua.MembersAdded); - Assert.NotNull(cua.MembersRemoved); - Assert.Single(cua.MembersAdded!); - Assert.Single(cua.MembersRemoved!); - Assert.Equal("newuser", cua.MembersAdded[0].Id); - Assert.Equal("olduser", cua.MembersRemoved[0].Id);*/ - } -} diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs index 747141eb..09993c38 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text.Json.Nodes; using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; @@ -25,22 +24,6 @@ public void Constructor_WithText_SetsTextAndMessageType() Assert.Equal("Hello World", activity.Text); } - [Fact] - public void DeserializeMessageActivity_WithAllProperties() - { - MessageActivity activity = MessageActivity.FromJsonString(jsonMessageWithAllProps); - - Assert.Equal(TeamsActivityType.Message, activity.Type); - Assert.Equal("Hello World", activity.Text); - Assert.Equal("This is a summary", activity.Summary); - Assert.Equal("plain", activity.TextFormat); - Assert.Equal(InputHints.AcceptingInput, activity.InputHint); - Assert.Equal(ImportanceLevels.High, activity.Importance); - Assert.Equal(DeliveryModes.Normal, activity.DeliveryMode); - Assert.Equal("carousel", activity.AttachmentLayout); - Assert.NotNull(activity.Expiration); - } - [Fact] public void MessageActivity_FromCoreActivity_MapsAllProperties() { @@ -48,13 +31,13 @@ public void MessageActivity_FromCoreActivity_MapsAllProperties() MessageActivity messageActivity = MessageActivity.FromActivity(coreActivity); Assert.Equal("Hello World", messageActivity.Text); - Assert.Equal("This is a summary", messageActivity.Summary); + //Assert.Equal("This is a summary", messageActivity.Summary); Assert.Equal("plain", messageActivity.TextFormat); - Assert.Equal(InputHints.AcceptingInput, messageActivity.InputHint); - Assert.Equal(ImportanceLevels.High, messageActivity.Importance); - Assert.Equal(DeliveryModes.Normal, messageActivity.DeliveryMode); + //Assert.Equal(InputHints.AcceptingInput, messageActivity.InputHint); + //Assert.Equal(ImportanceLevels.High, messageActivity.Importance); + //Assert.Equal(DeliveryModes.Normal, messageActivity.DeliveryMode); Assert.Equal("carousel", messageActivity.AttachmentLayout); - Assert.NotNull(messageActivity.Expiration); + //Assert.NotNull(messageActivity.Expiration); } [Fact] @@ -62,46 +45,26 @@ public void MessageActivity_Serialize_ToJson() { MessageActivity activity = new("Hello World") { - Summary = "Test summary", + // Summary = "Test summary", TextFormat = TextFormats.Markdown, - InputHint = InputHints.ExpectingInput, - Importance = ImportanceLevels.Urgent, - DeliveryMode = DeliveryModes.Notification + //InputHint = InputHints.ExpectingInput, + //Importance = ImportanceLevels.Urgent, + //DeliveryMode = DeliveryModes.Notification }; string json = activity.ToJson(); Assert.Contains("Hello World", json); - Assert.Contains("Test summary", json); + //Assert.Contains("Test summary", json); Assert.Contains("markdown", json); - Assert.Contains("expectingInput", json); - Assert.Contains("urgent", json); - Assert.Contains("notification", json); - } - - [Fact] - public void MessageActivity_WithAttachments_Deserialize() - { - MessageActivity activity = MessageActivity.FromJsonString(jsonMessageWithAttachment); - - Assert.Equal("Message with attachment", activity.Text); - Assert.NotNull(activity.Attachments); - Assert.Single(activity.Attachments); - Assert.Equal("application/vnd.microsoft.card.adaptive", activity.Attachments[0].ContentType); + //Assert.Contains("expectingInput", json); + //Assert.Contains("urgent", json); + //Assert.Contains("notification", json); } + /* [Fact] - public void MessageActivity_WithEntities_Deserialize() - { - MessageActivity activity = MessageActivity.FromJsonString(jsonMessageWithEntities); - - Assert.NotNull(activity.Entities); - Assert.Single(activity.Entities); - Assert.Equal("mention", activity.Entities[0].Type); - } - - [Fact] - public void MessageActivity_WithSpeak_SerializeAndDeserialize() + public void MessageActivity_WithSpeak_Serialize() { MessageActivity activity = new("Hello") { @@ -109,43 +72,24 @@ public void MessageActivity_WithSpeak_SerializeAndDeserialize() }; string json = activity.ToJson(); - MessageActivity deserialized = MessageActivity.FromJsonString(json); - Assert.Equal("Hello World", deserialized.Speak); + Assert.Contains("\"speak\":", json); + Assert.Contains("Hello World", json); } [Fact] - public void MessageActivity_WithExpiration_SerializeAndDeserialize() + public void MessageActivity_WithExpiration_Serialize() { - DateTime expirationDate = new DateTime(2026, 12, 31, 23, 59, 59, DateTimeKind.Utc); + string expirationDate = "2026-12-31T23:59:59Z"; MessageActivity activity = new("Expiring message") { Expiration = expirationDate }; string json = activity.ToJson(); - MessageActivity deserialized = MessageActivity.FromJsonString(json); - - Assert.NotNull(deserialized.Expiration); - Assert.Equal(expirationDate.Year, deserialized.Expiration.Value.Year); - Assert.Equal(expirationDate.Month, deserialized.Expiration.Value.Month); - Assert.Equal(expirationDate.Day, deserialized.Expiration.Value.Day); + Assert.Contains("2026-12-31T23:59:59Z", json); } + */ - [Fact] - public void MessageActivity_Constants_InputHints() - { - MessageActivity activity = new("Test") - { - InputHint = InputHints.AcceptingInput - }; - Assert.Equal("acceptingInput", activity.InputHint); - - activity.InputHint = InputHints.IgnoringInput; - Assert.Equal("ignoringInput", activity.InputHint); - - activity.InputHint = InputHints.ExpectingInput; - Assert.Equal("expectingInput", activity.InputHint); - } [Fact] public void MessageActivity_Constants_TextFormats() @@ -170,41 +114,16 @@ public void MessageActivity_FromCoreActivity_WithMissingProperties_HandlesGracef MessageActivity messageActivity = MessageActivity.FromActivity(coreActivity); Assert.Null(messageActivity.Text); - Assert.Null(messageActivity.Speak); - Assert.Null(messageActivity.InputHint); - Assert.Null(messageActivity.Summary); + //Assert.Null(messageActivity.Speak); + //Assert.Null(messageActivity.InputHint); + //Assert.Null(messageActivity.Summary); Assert.Null(messageActivity.TextFormat); Assert.Null(messageActivity.AttachmentLayout); - Assert.Null(messageActivity.Importance); - Assert.Null(messageActivity.DeliveryMode); - Assert.Null(messageActivity.Expiration); + //Assert.Null(messageActivity.Importance); + //Assert.Null(messageActivity.DeliveryMode); + //Assert.Null(messageActivity.Expiration); } - [Fact] - public void MessageActivity_CopiesTextToProperties() - { - MessageActivity activity = new("Hello World") - { - Speak = "Test speak", - Summary = "Test summary", - TextFormat = TextFormats.Markdown, - InputHint = InputHints.AcceptingInput, - Importance = ImportanceLevels.High, - DeliveryMode = DeliveryModes.Normal, - AttachmentLayout = "carousel" - }; - - Assert.Equal("Hello World", activity.Properties["text"]); - Assert.Equal("Test speak", activity.Properties["speak"]); - Assert.Equal("Test summary", activity.Properties["summary"]); - Assert.Equal(TextFormats.Markdown, activity.Properties["textFormat"]); - Assert.Equal(InputHints.AcceptingInput, activity.Properties["inputHint"]); - Assert.Equal(ImportanceLevels.High, activity.Properties["importance"]); - Assert.Equal(DeliveryModes.Normal, activity.Properties["deliveryMode"]); - Assert.Equal("carousel", activity.Properties["attachmentLayout"]); - } - - [Fact] public void MessageActivity_SerializedAsCoreActivity_IncludesText() { @@ -250,46 +169,4 @@ public void MessageActivity_SerializedAsCoreActivity_IncludesText() } } """; - - private const string jsonMessageWithAttachment = """ - { - "type": "message", - "channelId": "msteams", - "text": "Message with attachment", - "id": "1234567890", - "attachments": [ - { - "contentType": "application/vnd.microsoft.card.adaptive", - "content": { - "type": "AdaptiveCard", - "version": "1.4", - "body": [ - { - "type": "TextBlock", - "text": "Hello from adaptive card" - } - ] - } - } - ] - } - """; - - private const string jsonMessageWithEntities = """ - { - "type": "message", - "channelId": "msteams", - "text": "TestUser hello", - "entities": [ - { - "type": "mention", - "mentioned": { - "id": "user-123", - "name": "TestUser" - }, - "text": "TestUser" - } - ] - } - """; } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageDeleteActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageDeleteActivityTests.cs deleted file mode 100644 index 9ac14ee9..00000000 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageDeleteActivityTests.cs +++ /dev/null @@ -1,86 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; - -namespace Microsoft.Teams.Bot.Apps.UnitTests; - -public class MessageDeleteActivityTests -{ - [Fact] - public void Constructor_Default_SetsMessageDeleteType() - { - MessageDeleteActivity activity = new(); - Assert.Equal(TeamsActivityType.MessageDelete, activity.Type); - } - - [Fact] - public void DeserializeMessageDeleteFromJson() - { - string json = """ - { - "type": "messageDelete", - "conversation": { - "id": "19" - }, - "id": "1234567890" - } - """; - MessageDeleteActivity act = MessageDeleteActivity.FromJsonString(json); - Assert.NotNull(act); - Assert.Equal("messageDelete", act.Type); - - Assert.Equal("1234567890", act.Id); - } - - [Fact] - public void SerializeMessageDeleteToJson() - { - var activity = new MessageDeleteActivity - { - Id = "msg123" - }; - - string json = activity.ToJson(); - Assert.Contains("\"type\": \"messageDelete\"", json); - Assert.Contains("\"id\": \"msg123\"", json); - } - - [Fact] - public void FromActivityConvertsCorrectly() - { - var coreActivity = new CoreActivity - { - Type = TeamsActivityType.MessageDelete, - Id = "deleted-msg-id" - }; - - MessageDeleteActivity messageDelete = MessageDeleteActivity.FromActivity(coreActivity); - Assert.NotNull(messageDelete); - Assert.Equal(TeamsActivityType.MessageDelete, messageDelete.Type); - Assert.Equal("deleted-msg-id", messageDelete.Id); - } - - [Fact] - public void FromJsonStringCreatesCorrectType() - { - string json = """ - { - "type": "messageDelete", - "id": "test-id", - "conversation": { - "id": "conv-123" - } - } - """; - - TeamsActivity activity = TeamsActivity.FromJsonString(json); - Assert.IsType(activity); - MessageDeleteActivity? mda = activity as MessageDeleteActivity; - Assert.NotNull(mda); - Assert.Equal(TeamsActivityType.MessageDelete, mda.Type); - Assert.Equal("test-id", activity.Id); - } -} diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs deleted file mode 100644 index fd762415..00000000 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageReactionActivityTests.cs +++ /dev/null @@ -1,134 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; - -namespace Microsoft.Teams.Bot.Apps.UnitTests; - -public class MessageReactionActivityTests -{ - [Fact] - public void DeserializeMessageReactionFromJson() - { - string json = """ - { - "type": "messageReaction", - "conversation": { - "id": "19" - }, - "reactionsAdded": [ - { - "type": "like" - }, - { - "type": "heart" - } - ] - } - """; - MessageReactionActivity act = MessageReactionActivity.FromJsonString(json); - Assert.NotNull(act); - Assert.Equal("messageReaction", act.Type); - Assert.NotNull(act.ReactionsAdded); - Assert.Equal(2, act.ReactionsAdded!.Count); - Assert.Equal("like", act.ReactionsAdded[0].Type); - Assert.Equal("heart", act.ReactionsAdded[1].Type); - } - - [Fact] - public void DeserializeMessageReactionWithReactionsRemoved() - { - string json = """ - { - "type": "messageReaction", - "conversation": { - "id": "19" - }, - "reactionsRemoved": [ - { - "type": "sad" - } - ] - } - """; - MessageReactionActivity act = MessageReactionActivity.FromJsonString(json); - Assert.NotNull(act); - - Assert.NotNull(act.ReactionsRemoved); - Assert.Single(act.ReactionsRemoved!); - Assert.Equal("sad", act.ReactionsRemoved[0].Type); - } - - [Fact] - public void SerializeMessageReactionToJson() - { - var activity = new MessageReactionActivity - { - ReactionsAdded = new List - { - new MessageReaction { Type = ReactionTypes.Like }, - new MessageReaction { Type = ReactionTypes.Heart } - } - }; - - string json = activity.ToJson(); - Assert.Contains("\"type\": \"messageReaction\"", json); - Assert.Contains("\"reactionsAdded\"", json); - Assert.Contains("\"like\"", json); - Assert.Contains("\"heart\"", json); - } - - [Fact] - public void FromActivityConvertsCorrectly() - { - var coreActivity = new CoreActivity - { - Type = TeamsActivityType.MessageReaction - }; - coreActivity.Properties["reactionsAdded"] = System.Text.Json.JsonSerializer.SerializeToElement(new[] - { - new { type = "like" }, - new { type = "heart" } - }); - - MessageReactionActivity activity = MessageReactionActivity.FromActivity(coreActivity); - Assert.NotNull(activity); - Assert.Equal(TeamsActivityType.MessageReaction, activity.Type); - Assert.NotNull(activity.ReactionsAdded); - Assert.Equal(2, activity.ReactionsAdded!.Count); - } - - [Fact] - public void MessageReactionWithUserInfo() - { - string json = """ - { - "type": "messageReaction", - "conversation": { - "id": "19" - }, - "reactionsAdded": [ - { - "type": "like", - "createdDateTime": "2026-01-22T12:00:00Z", - "user": { - "id": "user-123", - "displayName": "Test User", - "userIdentityType": "aadUser" - } - } - ] - } - """; - MessageReactionActivity activity = MessageReactionActivity.FromJsonString(json); - Assert.NotNull(activity.ReactionsAdded); - Assert.Single(activity.ReactionsAdded!); - Assert.Equal("like", activity.ReactionsAdded[0].Type); - Assert.NotNull(activity.ReactionsAdded[0].User); - Assert.Equal("user-123", activity.ReactionsAdded[0].User!.Id); - Assert.Equal("Test User", activity.ReactionsAdded[0].User!.DisplayName); - Assert.Equal(UserIdentityTypes.AadUser, activity.ReactionsAdded[0].User!.UserIdentityType); - } -} diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageUpdateActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageUpdateActivityTests.cs deleted file mode 100644 index 04011f96..00000000 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageUpdateActivityTests.cs +++ /dev/null @@ -1,142 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; - -namespace Microsoft.Teams.Bot.Apps.UnitTests; - -public class MessageUpdateActivityTests -{ - [Fact] - public void Constructor_Default_SetsMessageUpdateType() - { - MessageUpdateActivity activity = new(); - Assert.Equal(TeamsActivityType.MessageUpdate, activity.Type); - } - - [Fact] - public void Constructor_WithText_SetsTextAndMessageUpdateType() - { - MessageUpdateActivity activity = new("Updated text"); - Assert.Equal(TeamsActivityType.MessageUpdate, activity.Type); - Assert.Equal("Updated text", activity.Text); - } - - [Fact] - public void DeserializeMessageUpdateFromJson() - { - string json = """ - { - "type": "messageUpdate", - "text": "Updated message text", - "conversation": { - "id": "19" - } - } - """; - MessageUpdateActivity act = MessageUpdateActivity.FromJsonString(json); - Assert.NotNull(act); - Assert.Equal("messageUpdate", act.Type); - - Assert.Equal("Updated message text", act.Text); - } - - [Fact] - public void SerializeMessageUpdateToJson() - { - var activity = new MessageUpdateActivity - { - Text = "Updated message", - Speak = "Updated message spoken" - }; - - string json = activity.ToJson(); - Assert.Contains("\"type\": \"messageUpdate\"", json); - Assert.Contains("\"text\": \"Updated message\"", json); - Assert.Contains("\"speak\": \"Updated message spoken\"", json); - } - - [Fact] - public void MessageUpdateInheritsFromMessageActivity() - { - var activity = new MessageUpdateActivity - { - Text = "Updated", - InputHint = InputHints.AcceptingInput, - TextFormat = TextFormats.Markdown - }; - - Assert.Equal("Updated", activity.Text); - Assert.Equal(InputHints.AcceptingInput, activity.InputHint); - Assert.Equal(TextFormats.Markdown, activity.TextFormat); - } - - [Fact] - public void FromActivityConvertsCorrectly() - { - var coreActivity = new CoreActivity - { - Type = TeamsActivityType.MessageUpdate - }; - coreActivity.Properties["text"] = "Test message"; - - MessageUpdateActivity messageUpdate = MessageUpdateActivity.FromActivity(coreActivity); - Assert.NotNull(messageUpdate); - Assert.Equal(TeamsActivityType.MessageUpdate, messageUpdate.Type); - Assert.Equal("Test message", messageUpdate.Text); - } - - [Fact] - public void FromJsonStringCreatesCorrectType() - { - string json = """ - { - "type": "messageUpdate", - "text": "Updated content", - "textFormat": "markdown", - "conversation": { - "id": "conv-123" - } - } - """; - - TeamsActivity activity = TeamsActivity.FromJsonString(json); - Assert.IsType(activity); - MessageUpdateActivity? mua = activity as MessageUpdateActivity; - Assert.NotNull(mua); - Assert.Equal(TeamsActivityType.MessageUpdate, activity.Type); - Assert.Equal("Updated content", mua.Text); - Assert.Equal("markdown", mua.TextFormat); - } - - [Fact] - public void MessageUpdateActivity_Constructor_CopiesTextToProperties() - { - MessageUpdateActivity activity = new("Updated message text"); - - Assert.Equal("Updated message text", activity.Text); - Assert.Equal("Updated message text", activity.Properties["text"]); - } - - [Fact] - public void MessageUpdateActivity_SerializedAsCoreActivity_IncludesText() - { - MessageUpdateActivity messageUpdateActivity = new("Message update text") - { - Type = TeamsActivityType.MessageUpdate, - ServiceUrl = new Uri("https://test.service.url/"), - Speak = "Message update spoken" - }; - - CoreActivity coreActivity = messageUpdateActivity; - string json = coreActivity.ToJson(); - - Assert.Contains("Message update text", json); - Assert.Contains("\"text\"", json); - Assert.Contains("Message update spoken", json); - Assert.Contains("\"speak\"", json); - Assert.Contains("messageUpdate", json); - } -} diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs index c292d452..56848775 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs @@ -11,36 +11,6 @@ namespace Microsoft.Teams.Bot.Apps.UnitTests; public class TeamsActivityTests { - - [Fact] - public void DeserializeActivityWithTeamsChannelData() - { - TeamsActivity activityWithTeamsChannelData = TeamsActivity.FromJsonString(json); - TeamsChannelData tcd = activityWithTeamsChannelData.ChannelData!; - Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.TeamsChannelId); - Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.Channel!.Id); - // Assert.Equal("b15a9416-0ad3-4172-9210-7beb711d3f70", activity.From.AadObjectId); - } - - [Fact] - public void DeserializeTeamsActivityWithTeamsChannelData() - { - TeamsActivity activity = TeamsActivity.FromJsonString(json); - TeamsChannelData tcd = activity.ChannelData!; - Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.TeamsChannelId); - Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2", tcd.Channel!.Id); - Assert.Equal("b15a9416-0ad3-4172-9210-7beb711d3f70", activity.From.AadObjectId); - Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", activity.Conversation.Id); - - Assert.NotNull(activity.Attachments); - Assert.Single(activity.Attachments); - Assert.Equal("text/html", activity.Attachments[0].ContentType); - - Assert.NotNull(activity.Entities); - Assert.Equal(2, activity.Entities.Count); - - } - [Fact] public void DownCastTeamsActivity_To_CoreActivity() { @@ -73,21 +43,6 @@ static void AssertCid(CoreActivity a) AssertCid(teamsActivity); } - [Fact] - public void DownCastTeamsActivity_To_CoreActivity_FromJsonString() - { - - TeamsActivity teamsActivity = TeamsActivity.FromJsonString(json); - Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", teamsActivity.Conversation!.Id); - - static void AssertCid(CoreActivity a) - { - Assert.Equal("19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856", a.Conversation!.Id); - } - AssertCid(teamsActivity); - - } - [Fact] public void DownCastTeamsActivity_To_CoreActivity_WithoutRebase() { @@ -191,58 +146,6 @@ public void TeamsActivityBuilder_FluentAPI() Assert.Equal("TestUser", mention.Mentioned?.Name); } - [Fact] - public void Deserialize_With_Entities() - { - TeamsActivity activity = TeamsActivity.FromJsonString(json); - Assert.NotNull(activity.Entities); - Assert.Equal(2, activity.Entities.Count); - - List mentions = activity.Entities.Where(e => e is MentionEntity).ToList(); - Assert.Single(mentions); - MentionEntity? m1 = mentions[0] as MentionEntity; - Assert.NotNull(m1); - Assert.NotNull(m1.Mentioned); - Assert.Equal("28:0b6fe6d1-fece-44f7-9a48-56465e2d5ab8", m1.Mentioned.Id); - Assert.Equal("ridotest", m1.Mentioned.Name); - Assert.Equal("ridotest", m1.Text); - - List clientInfos = [.. activity.Entities.Where(e => e is ClientInfoEntity)]; - Assert.Single(clientInfos); - ClientInfoEntity? c1 = clientInfos[0] as ClientInfoEntity; - Assert.NotNull(c1); - Assert.Equal("en-US", c1.Locale); - Assert.Equal("US", c1.Country); - Assert.Equal("Web", c1.Platform); - Assert.Equal("America/Los_Angeles", c1.Timezone); - - } - - - [Fact] - public void Deserialize_With_Entities_Extensions() - { - TeamsActivity activity = TeamsActivity.FromJsonString(json); - Assert.NotNull(activity.Entities); - Assert.Equal(2, activity.Entities.Count); - - var mentions = activity.GetMentions(); - Assert.Single(mentions); - MentionEntity? m1 = mentions.FirstOrDefault(); - Assert.NotNull(m1); - Assert.NotNull(m1.Mentioned); - Assert.Equal("28:0b6fe6d1-fece-44f7-9a48-56465e2d5ab8", m1.Mentioned.Id); - Assert.Equal("ridotest", m1.Mentioned.Name); - Assert.Equal("ridotest", m1.Text); - - var clientInfo = activity.GetClientInfo(); - Assert.NotNull(clientInfo); - Assert.Equal("en-US", clientInfo.Locale); - Assert.Equal("US", clientInfo.Country); - Assert.Equal("Web", clientInfo.Platform); - Assert.Equal("America/Los_Angeles", clientInfo.Timezone); - } - [Fact] public void Serialize_TeamsActivity_WithEntities() { @@ -260,18 +163,6 @@ public void Serialize_TeamsActivity_WithEntities() Assert.Contains("Hello World", jsonResult); } - [Fact] - public void Deserialize_TeamsActivity_WithAttachments() - { - TeamsActivity activity = TeamsActivity.FromJsonString(json); - Assert.NotNull(activity.Attachments); - Assert.Single(activity.Attachments); - TeamsAttachment attachment = activity.Attachments[0] as TeamsAttachment; - Assert.NotNull(attachment); - Assert.Equal("text/html", attachment.ContentType); - Assert.Equal("

ridotest reply to thread

", attachment.Content?.ToString()); - } - [Fact] public void Deserialize_TeamsActivity_Invoke_WithValue() { @@ -282,6 +173,44 @@ public void Deserialize_TeamsActivity_Invoke_WithValue() Assert.Equal("test invokes", feedback); } + [Fact] + public void Serialize_Does_Not_Repeat_AAdObjectId() + { + var coreActivity = CoreActivity.FromJsonString(""" + { + "type": "message", + "recipient": { + "id": "rec1", + "name": "recname", + "aadObjectId": "rec-aadId-1" + } + } + """); + var teamsActivity = TeamsActivity.FromActivity(coreActivity); + string json = teamsActivity.ToJson(); + string[] found = json.Split("aadObjectId"); + Assert.Equal(1, found.Length - 1); // only one occurrence + } + + [Fact] + public void FromActivity_Overrides_Recipient() + { + var coreActivity = CoreActivity.FromJsonString(""" + { + "type": "message", + "recipient": { + "id": "rec1", + "name": "recname", + "aadObjectId": "rec-aadId-1" + } + } + """); + var teamsActivity = TeamsActivity.FromActivity(coreActivity); + Assert.Equal("rec1", teamsActivity.Recipient?.Id); + Assert.Equal("recname", teamsActivity.Recipient?.Name); + Assert.Equal("rec-aadId-1", teamsActivity.Recipient?.AadObjectId); + } + private const string jsonInvoke = """ { "type": "invoke", @@ -407,27 +336,6 @@ public void Deserialize_TeamsActivity_Invoke_WithValue() } """; - [Fact] - public void FromJsonString_ReturnsDerivedType_WhenRegistered() - { - string json = """{"type": "message", "text": "Hello World"}"""; - TeamsActivity activity = TeamsActivity.FromJsonString(json); - - Assert.IsType(activity); - MessageActivity messageActivity = (MessageActivity)activity; - Assert.Equal("Hello World", messageActivity.Text); - } - - [Fact] - public void FromJsonString_ReturnsBaseType_WhenNotRegistered() - { - string json = """{"type": "unknownType"}"""; - TeamsActivity activity = TeamsActivity.FromJsonString(json); - - Assert.Equal(typeof(TeamsActivity), activity.GetType()); - Assert.Equal("unknownType", activity.Type); - } - [Fact] public void FromActivity_ReturnsDerivedType_WhenRegistered() { diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs index 10edf32c..ac1a560e 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs @@ -9,6 +9,7 @@ using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Core; using Moq; @@ -81,6 +82,7 @@ private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() var userTokenClient = new UserTokenClient(httpClient, mockConfig.Object, NullLogger.Instance); var teamsApiClient = new TeamsApiClient(httpClient, NullLogger.Instance); + var router = new Router(NullLogger.Instance); var teamsBotApplication = new TeamsBotApplication( conversationClient, @@ -88,7 +90,8 @@ private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() teamsApiClient, mockConfig.Object, Mock.Of(), - NullLogger.Instance); + NullLogger.Instance, + router); var mockServiceProvider = new Mock(); mockServiceProvider From 1078412922451bfe606b0079b01ffd0e673c1d0a Mon Sep 17 00:00:00 2001 From: Rido Date: Mon, 9 Feb 2026 11:07:42 -0800 Subject: [PATCH 52/69] Fix Agentic support in TeamsBotApplication (#314) This pull request introduces several improvements and refactorings across the Teams bot codebase, focusing on simplifying property management in conversation accounts, enhancing logging for authentication and activity flows, and updating tests for agentic identity support. **TeamsConversationAccount property management:** * Refactored `TeamsConversationAccount` to store all Teams-specific properties in the `Properties` dictionary and provide strongly-typed accessors for each property (e.g., `AadObjectId`, `GivenName`, `Surname`, etc.), simplifying construction and property access. **Logging enhancements:** * Improved logging in `BotAuthenticationHandler` by raising log levels for token acquisition events, and added trace-level logging to output JWT token claims for better debugging. [[1]](diffhunk://#diff-0d237734ffe42c3bd2a77d27777c6ffc86396b9db5cba4f26c22b41918d0384bL35-R40) [[2]](diffhunk://#diff-0d237734ffe42c3bd2a77d27777c6ffc86396b9db5cba4f26c22b41918d0384bR58-R59) [[3]](diffhunk://#diff-0d237734ffe42c3bd2a77d27777c6ffc86396b9db5cba4f26c22b41918d0384bR106-R123) * Enhanced activity sending logs in `ConversationClient` to include the destination URL and improved log message clarity. * Updated startup logs in `BotApplication` to include the listener type for better traceability. **Test and configuration updates:** * Updated unit tests in `TeamsActivityTests` to verify agentic identity properties in the recipient, ensuring correct parsing and assignment. * Added a local settings file to allow specific Bash commands for building and testing in the `core/.claude/settings.local.json`. **Other minor changes:** * Cleaned up configuration code by removing outdated TODO comments about making the MSAL instance configurable. [[1]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L213) [[2]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L244) [[3]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L271) * Fixed logger type in `TeamsBotApplication` constructor for consistency. * Minor formatting improvements in unit tests. * Added missing `using` directive for JWT token handling. * Removed redundant activity logging in `TeamsBotApplication`. --- core/.claude/settings.local.json | 8 ++ .../Schema/TeamsConversationAccount.cs | 113 ++++++++---------- .../TeamsBotApplication.cs | 3 +- .../BotApplication.cs | 2 +- .../ConversationClient.cs | 4 +- .../Hosting/AddBotApplicationExtensions.cs | 3 - .../Hosting/BotAuthenticationHandler.cs | 27 ++++- .../TeamsActivityTests.cs | 13 +- .../CompatAdapterTests.cs | 2 +- 9 files changed, 101 insertions(+), 74 deletions(-) create mode 100644 core/.claude/settings.local.json diff --git a/core/.claude/settings.local.json b/core/.claude/settings.local.json new file mode 100644 index 00000000..dcf34652 --- /dev/null +++ b/core/.claude/settings.local.json @@ -0,0 +1,8 @@ +{ + "permissions": { + "allow": [ + "Bash(dotnet build:*)", + "Bash(dotnet test:*)" + ] + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs index 3b966fb7..06f35db8 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs @@ -27,98 +27,91 @@ public TeamsConversationAccount() /// /// Initializes a new instance of the TeamsConversationAccount class using the specified conversation account. /// - /// If the provided ConversationAccount contains Teams-specific properties in the Properties dictionary - /// (such as 'aadObjectId', 'givenName', 'surname', 'email', 'userPrincipalName', 'userRole', 'tenantId'), - /// they are extracted and used to populate the corresponding properties of the TeamsConversationAccount. /// The ConversationAccount instance containing the conversation's identifier, name, and properties. Cannot be null. public TeamsConversationAccount(ConversationAccount conversationAccount) { ArgumentNullException.ThrowIfNull(conversationAccount); Id = conversationAccount.Id; Name = conversationAccount.Name; - - // Extract properties from the Properties dictionary - if (conversationAccount.Properties.TryGetValue("aadObjectId", out object? aadObj) - && aadObj is JsonElement aadJe - && aadJe.ValueKind == JsonValueKind.String) - { - AadObjectId = aadJe.GetString(); - } - - if (conversationAccount.Properties.TryGetValue("givenName", out object? givenNameObj) - && givenNameObj is JsonElement givenNameJe - && givenNameJe.ValueKind == JsonValueKind.String) - { - GivenName = givenNameJe.GetString(); - } - - if (conversationAccount.Properties.TryGetValue("surname", out object? surnameObj) - && surnameObj is JsonElement surnameJe - && surnameJe.ValueKind == JsonValueKind.String) - { - Surname = surnameJe.GetString(); - } - - if (conversationAccount.Properties.TryGetValue("email", out object? emailObj) - && emailObj is JsonElement emailJe - && emailJe.ValueKind == JsonValueKind.String) - { - Email = emailJe.GetString(); - } - - if (conversationAccount.Properties.TryGetValue("userPrincipalName", out object? upnObj) - && upnObj is JsonElement upnJe - && upnJe.ValueKind == JsonValueKind.String) - { - UserPrincipalName = upnJe.GetString(); - } - - if (conversationAccount.Properties.TryGetValue("userRole", out object? roleObj) - && roleObj is JsonElement roleJe - && roleJe.ValueKind == JsonValueKind.String) - { - UserRole = roleJe.GetString(); - } - - if (conversationAccount.Properties.TryGetValue("tenantId", out object? tenantObj) - && tenantObj is JsonElement tenantJe - && tenantJe.ValueKind == JsonValueKind.String) - { - TenantId = tenantJe.GetString(); - } + Properties = conversationAccount.Properties; } + /// /// Gets or sets the Azure Active Directory (AAD) Object ID associated with the conversation account. /// - [JsonPropertyName("aadObjectId")] public string? AadObjectId { get; set; } + [JsonIgnore] + public string? AadObjectId + { + get => GetStringProperty("aadObjectId"); + set => Properties["aadObjectId"] = value; + } /// /// Gets or sets given name part of the user name. /// - [JsonPropertyName("givenName")] public string? GivenName { get; set; } + [JsonIgnore] + public string? GivenName + { + get => GetStringProperty("givenName"); + set => Properties["givenName"] = value; + } /// /// Gets or sets surname part of the user name. /// - [JsonPropertyName("surname")] public string? Surname { get; set; } + [JsonIgnore] + public string? Surname + { + get => GetStringProperty("surname"); + set => Properties["surname"] = value; + } /// /// Gets or sets email Id of the user. /// - [JsonPropertyName("email")] public string? Email { get; set; } + [JsonIgnore] + public string? Email + { + get => GetStringProperty("email"); + set => Properties["email"] = value; + } /// /// Gets or sets unique user principal name. /// - [JsonPropertyName("userPrincipalName")] public string? UserPrincipalName { get; set; } + [JsonIgnore] + public string? UserPrincipalName + { + get => GetStringProperty("userPrincipalName"); + set => Properties["userPrincipalName"] = value; + } /// /// Gets or sets the UserRole. /// - [JsonPropertyName("userRole")] public string? UserRole { get; set; } + [JsonIgnore] + public string? UserRole + { + get => GetStringProperty("userRole"); + set => Properties["userRole"] = value; + } /// /// Gets or sets the TenantId. /// - [JsonPropertyName("tenantId")] public string? TenantId { get; set; } + [JsonIgnore] + public string? TenantId + { + get => GetStringProperty("tenantId"); + set => Properties["tenantId"] = value; + } + + private string? GetStringProperty(string key) + { + if (Properties.TryGetValue(key, out var val) && val is JsonElement je && je.ValueKind == JsonValueKind.String) + { + return je.GetString(); + } + return val?.ToString(); + } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 037ce953..2e43acdc 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -45,7 +45,7 @@ public TeamsBotApplication( TeamsApiClient teamsApiClient, IConfiguration config, IHttpContextAccessor httpContextAccessor, - ILogger logger, + ILogger logger, Router router, string sectionName = "AzureAd") : base(conversationClient, userTokenClient, config, logger, sectionName) @@ -54,7 +54,6 @@ public TeamsBotApplication( Router = router; OnActivity = async (activity, cancellationToken) => { - logger.LogInformation("New {Type} activity received.", activity.Type); TeamsActivity teamsActivity = TeamsActivity.FromActivity(activity); Context defaultContext = new(this, teamsActivity); diff --git a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index beb15be0..b739e973 100644 --- a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -43,7 +43,7 @@ public BotApplication(ConversationClient conversationClient, UserTokenClient use _conversationClient = conversationClient; _userTokenClient = userTokenClient; string appId = config["MicrosoftAppId"] ?? config["CLIENT_ID"] ?? config[$"{sectionName}:ClientId"] ?? "Unknown AppID"; - logger.LogInformation("Started bot listener \n on {Port} \n for AppID:{AppId} \n with SDK version {SdkVersion}", config?["ASPNETCORE_URLS"], appId, Version); + logger.LogInformation(" Started {ThisType} listener \n on {Port} \n for AppID:{AppId} \n with SDK version {SdkVersion}", this.GetType().Name, config?["ASPNETCORE_URLS"], appId, Version); } diff --git a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs index bf89a24e..c396f8e7 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs @@ -52,9 +52,11 @@ public async Task SendActivityAsync(CoreActivity activity, url = $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{convId}/activities"; } + logger?.LogInformation("Sending activity to {Url}", url); + string body = activity.ToJson(); - logger?.LogTrace("Sending activity to {Url}: {Activity}", url, body); + logger?.LogTrace("Outgoing Activity :\r {Activity}", body); return (await _botHttpClient.SendAsync( HttpMethod.Post, diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs index e264ba45..806a1849 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -210,7 +210,6 @@ private static IServiceCollection ConfigureMSALWithSecret(this IServiceCollectio services.Configure(MsalConfigKey, options => { - // TODO: Make Instance configurable options.Instance = "https://login.microsoftonline.com/"; options.TenantId = tenantId; options.ClientId = clientId; @@ -241,7 +240,6 @@ private static IServiceCollection ConfigureMSALWithFIC(this IServiceCollection s services.Configure(MsalConfigKey, options => { - // TODO: Make Instance configurable options.Instance = "https://login.microsoftonline.com/"; options.TenantId = tenantId; options.ClientId = clientId; @@ -268,7 +266,6 @@ private static IServiceCollection ConfigureMSALWithUMI(this IServiceCollection s services.Configure(MsalConfigKey, options => { - // TODO: Make Instance configurable options.Instance = "https://login.microsoftonline.com/"; options.TenantId = tenantId; options.ClientId = clientId; diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs index b46ad5e3..cb331628 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.IdentityModel.Tokens.Jwt; using System.Net.Http.Headers; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; @@ -32,10 +33,12 @@ internal sealed class BotAuthenticationHandler( private readonly string _scope = scope ?? throw new ArgumentNullException(nameof(scope)); private readonly IOptions? _managedIdentityOptions = managedIdentityOptions; private static readonly Action _logAgenticToken = - LoggerMessage.Define(LogLevel.Debug, new(2), "Acquiring agentic token for app {AgenticAppId}"); + LoggerMessage.Define(LogLevel.Information, new(2), "Acquiring agentic token for AgenticAppId {AgenticAppId}"); private static readonly Action _logAppOnlyToken = - LoggerMessage.Define(LogLevel.Debug, new(3), "Acquiring app-only token for scope: {Scope}"); - + LoggerMessage.Define(LogLevel.Information, new(3), "Acquiring app-only token for scope: {Scope}"); + private static readonly Action _logTokenClaims = + LoggerMessage.Define(LogLevel.Trace, new(4), "Acquired token claims:{Claims}"); + /// /// Key used to store the agentic identity in HttpRequestMessage options. /// @@ -52,6 +55,8 @@ protected override async Task SendAsync(HttpRequestMessage ? token["Bearer ".Length..] : token; + LogTokenClaims(tokenValue); + request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", tokenValue); return await base.SendAsync(request, cancellationToken).ConfigureAwait(false); @@ -98,6 +103,22 @@ private async Task GetAuthorizationHeaderAsync(AgenticIdentity? agenticI _logAppOnlyToken(_logger, _scope, null); string appToken = await _authorizationHeaderProvider.CreateAuthorizationHeaderForAppAsync(_scope, options, cancellationToken).ConfigureAwait(false); + + return appToken; } + + private void LogTokenClaims(string token) + { + if (!_logger.IsEnabled(LogLevel.Trace)) + { + return; + } + + + var jwtToken = new JwtSecurityToken(token); + var claims = Environment.NewLine + string.Join(Environment.NewLine, jwtToken.Claims.Select(c => $" {c.Type}: {c.Value}")); + _logTokenClaims(_logger, claims, null); + + } } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs index 56848775..740f956f 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs @@ -46,7 +46,8 @@ static void AssertCid(CoreActivity a) [Fact] public void DownCastTeamsActivity_To_CoreActivity_WithoutRebase() { - TeamsActivity teamsActivity = new TeamsActivity() { + TeamsActivity teamsActivity = new TeamsActivity() + { Conversation = new TeamsConversation() { Id = "19:6848757105754c8981c67612732d9aa7@thread.tacv2;messageid=1759881511856" @@ -201,14 +202,20 @@ public void FromActivity_Overrides_Recipient() "recipient": { "id": "rec1", "name": "recname", - "aadObjectId": "rec-aadId-1" + "agenticUserId": "0d5eb8a3-1642-4e63-9ccc-a89aa461716c", + "agenticAppId": "3fc62d4f-b04e-4c71-878b-02a2fa395fe2", + "agenticAppBlueprintId": "24fff850-d7fb-4d32-a6e7-a1178874430e" } } """); var teamsActivity = TeamsActivity.FromActivity(coreActivity); Assert.Equal("rec1", teamsActivity.Recipient?.Id); Assert.Equal("recname", teamsActivity.Recipient?.Name); - Assert.Equal("rec-aadId-1", teamsActivity.Recipient?.AadObjectId); + var agenticIdentity = AgenticIdentity.FromProperties(teamsActivity.Recipient?.Properties); + Assert.NotNull(agenticIdentity); + Assert.Equal("0d5eb8a3-1642-4e63-9ccc-a89aa461716c", agenticIdentity.AgenticUserId); + Assert.Equal("3fc62d4f-b04e-4c71-878b-02a2fa395fe2", agenticIdentity.AgenticAppId); + Assert.Equal("24fff850-d7fb-4d32-a6e7-a1178874430e", agenticIdentity.AgenticAppBlueprintId); } private const string jsonInvoke = """ diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs index ac1a560e..8c782ee4 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs @@ -90,7 +90,7 @@ private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() teamsApiClient, mockConfig.Object, Mock.Of(), - NullLogger.Instance, + NullLogger.Instance, router); var mockServiceProvider = new Mock(); From afa51c0effb3a73d98bce881c812e5c0612f501c Mon Sep 17 00:00:00 2001 From: Rido Date: Mon, 9 Feb 2026 11:09:27 -0800 Subject: [PATCH 53/69] Fix Agentic support in TeamsBotApplication (#314) This pull request introduces several improvements and refactorings across the Teams bot codebase, focusing on simplifying property management in conversation accounts, enhancing logging for authentication and activity flows, and updating tests for agentic identity support. **TeamsConversationAccount property management:** * Refactored `TeamsConversationAccount` to store all Teams-specific properties in the `Properties` dictionary and provide strongly-typed accessors for each property (e.g., `AadObjectId`, `GivenName`, `Surname`, etc.), simplifying construction and property access. **Logging enhancements:** * Improved logging in `BotAuthenticationHandler` by raising log levels for token acquisition events, and added trace-level logging to output JWT token claims for better debugging. [[1]](diffhunk://#diff-0d237734ffe42c3bd2a77d27777c6ffc86396b9db5cba4f26c22b41918d0384bL35-R40) [[2]](diffhunk://#diff-0d237734ffe42c3bd2a77d27777c6ffc86396b9db5cba4f26c22b41918d0384bR58-R59) [[3]](diffhunk://#diff-0d237734ffe42c3bd2a77d27777c6ffc86396b9db5cba4f26c22b41918d0384bR106-R123) * Enhanced activity sending logs in `ConversationClient` to include the destination URL and improved log message clarity. * Updated startup logs in `BotApplication` to include the listener type for better traceability. **Test and configuration updates:** * Updated unit tests in `TeamsActivityTests` to verify agentic identity properties in the recipient, ensuring correct parsing and assignment. * Added a local settings file to allow specific Bash commands for building and testing in the `core/.claude/settings.local.json`. **Other minor changes:** * Cleaned up configuration code by removing outdated TODO comments about making the MSAL instance configurable. [[1]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L213) [[2]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L244) [[3]](diffhunk://#diff-32c43eec964cc43a0cc857afbe1da981ec6000ac6c95c94aef469c4ce859ebe7L271) * Fixed logger type in `TeamsBotApplication` constructor for consistency. * Minor formatting improvements in unit tests. * Added missing `using` directive for JWT token handling. * Removed redundant activity logging in `TeamsBotApplication`. From 728e8a90c07dd9b8e5c1bbd26829cde25c729266 Mon Sep 17 00:00:00 2001 From: Rido Date: Mon, 9 Feb 2026 17:38:40 -0800 Subject: [PATCH 54/69] Update MSAL, and minor API imrpovements (#316) Expanded logging, builder arg support, improved middleware token handling, new AddBotApplication overload, and upgraded NuGet packages for authentication and identity. This pull request introduces several improvements to the Teams bot application framework, focusing on enhanced configuration flexibility, improved dependency management, and minor code cleanups. The most significant changes include updating method signatures to accept command-line arguments, refining dependency injection patterns, and updating package versions for better compatibility and security. **Configuration and Dependency Injection Enhancements:** * Changed `TeamsBotApplication.CreateBuilder` and `TeamsBotApplicationBuilder` constructors to accept a `string[] args` parameter, allowing applications to pass command-line arguments for more flexible configuration. (`core/samples/TeamsBot/Program.cs`, `core/samples/TeamsChannelBot/Program.cs`, `core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs`, `core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs`) [[1]](diffhunk://#diff-691809f7a90c5bda6ee5e4335c2c393864a32101545fb0b35c24bc659623361bL12-R12) [[2]](diffhunk://#diff-42051fe23037cc0bf4fa811f899bd3e9cb86edb6178d1ff28bf63ac349db96a9L7-R7) [[3]](diffhunk://#diff-e196e9ff5fcfc2368d02d38f06cf768e98cf7f8df31c730c799ca33def23a80eL82-R82) [[4]](diffhunk://#diff-aafa3df8194fb624a2e49d4d9e6065209cbbc17844152cd6fd2e1edfcf7f9fe6L46-R48) * Added a new `AddBotApplication` extension method to `IServiceCollection` with a default configuration section name ("AzureAd"), simplifying bot application registration. (`core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs`) **Dependency Updates:** * Updated package references in `Microsoft.Teams.Bot.Core.csproj` to newer versions for `Microsoft.AspNetCore.Authentication.JwtBearer`, `Microsoft.AspNetCore.Authentication.OpenIdConnect`, and `Microsoft.Identity.Web` packages, improving compatibility and security. (`core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj`) **Code Quality and Cleanup:** * Removed a pending suppress message attribute from the `TeamsBotApplication` class, cleaning up unnecessary code annotations. (`core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs`) * Updated variable names in the `CompatAdapter` to improve clarity and consistency, and ensured cancellation tokens are propagated correctly. (`core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs`) **Minor Configuration Update:** * Changed logging configuration in `appsettings.json` to trace logs for `Microsoft.Teams` instead of `Microsoft.Bot`, aligning logging with the Teams bot framework. (`core/samples/CoreBot/appsettings.json`) --- core/samples/CoreBot/appsettings.json | 2 +- core/samples/TeamsBot/Program.cs | 2 +- core/samples/TeamsChannelBot/Program.cs | 2 +- core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs | 6 ++---- .../TeamsBotApplicationBuilder.cs | 4 ++-- core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs | 4 ++-- .../Hosting/AddBotApplicationExtensions.cs | 9 +++++++++ .../Microsoft.Teams.Bot.Core.csproj | 8 ++++---- 8 files changed, 22 insertions(+), 15 deletions(-) diff --git a/core/samples/CoreBot/appsettings.json b/core/samples/CoreBot/appsettings.json index 1ff8c135..396e887e 100644 --- a/core/samples/CoreBot/appsettings.json +++ b/core/samples/CoreBot/appsettings.json @@ -3,7 +3,7 @@ "Logging": { "LogLevel": { "Default": "Warning", - "Microsoft.Bot": "Trace" + "Microsoft.Teams": "Trace" } }, "AllowedHosts": "*" diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 7cb57fb4..3edd5283 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -9,7 +9,7 @@ using System.Text.RegularExpressions; using TeamsBot; -var builder = TeamsBotApplication.CreateBuilder(); +var builder = TeamsBotApplication.CreateBuilder(args); var teamsApp = builder.Build(); // ==================== MESSAGE HANDLERS ==================== diff --git a/core/samples/TeamsChannelBot/Program.cs b/core/samples/TeamsChannelBot/Program.cs index 9404c72e..7caa20d9 100644 --- a/core/samples/TeamsChannelBot/Program.cs +++ b/core/samples/TeamsChannelBot/Program.cs @@ -4,7 +4,7 @@ using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Apps.Handlers; -var builder = TeamsBotApplication.CreateBuilder(); +var builder = TeamsBotApplication.CreateBuilder(args); var app = builder.Build(); diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 2e43acdc..95494afd 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -14,7 +14,6 @@ namespace Microsoft.Teams.Bot.Apps; /// /// Teams specific Bot Application /// -[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class TeamsBotApplication : BotApplication { private readonly TeamsApiClient _teamsApiClient; @@ -69,7 +68,6 @@ public TeamsBotApplication( { httpContext.Response.StatusCode = invokeResponse.Status; await httpContext.Response.WriteAsJsonAsync(invokeResponse, cancellationToken).ConfigureAwait(false); - } } }; @@ -79,9 +77,9 @@ public TeamsBotApplication( /// Creates a new instance of the TeamsBotApplicationBuilder to configure and build a Teams bot application. /// /// - public static TeamsBotApplicationBuilder CreateBuilder() + public static TeamsBotApplicationBuilder CreateBuilder(string[] args) { - _botApplicationBuilder = new TeamsBotApplicationBuilder(); + _botApplicationBuilder = new TeamsBotApplicationBuilder(args); return _botApplicationBuilder; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs index 3d5b79ca..5b212fc6 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs @@ -43,9 +43,9 @@ public class TeamsBotApplicationBuilder /// /// Creates a new instance of the BotApplicationBuilder with default configuration and registered bot services. /// - public TeamsBotApplicationBuilder() + public TeamsBotApplicationBuilder(string[] args) { - _webAppBuilder = WebApplication.CreateSlimBuilder(); + _webAppBuilder = WebApplication.CreateSlimBuilder(args); _webAppBuilder.Services.AddHttpContextAccessor(); _webAppBuilder.Services.AddTeamsBotApplication(); } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index c93a9a00..54db1629 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -49,7 +49,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons ArgumentNullException.ThrowIfNull(bot); CoreActivity? coreActivity = null; - _teamsBotApplication.OnActivity = async (activity, cancellationToken1) => + _teamsBotApplication.OnActivity = async (activity, ct) => { coreActivity = activity; TurnContext turnContext = new(this, activity.ToCompatActivity()); @@ -57,7 +57,7 @@ public async Task ProcessAsync(HttpRequest httpRequest, HttpResponse httpRespons CompatConnectorClient connectionClient = new(new CompatConversations(_teamsBotApplication.ConversationClient) { ServiceUrl = activity.ServiceUrl?.ToString() }); turnContext.TurnState.Add(connectionClient); turnContext.TurnState.Add(_teamsBotApplication.TeamsApiClient); - await MiddlewareSet.ReceiveActivityWithStatusAsync(turnContext, bot.OnTurnAsync, cancellationToken).ConfigureAwait(false); + await MiddlewareSet.ReceiveActivityWithStatusAsync(turnContext, bot.OnTurnAsync, ct).ConfigureAwait(false); }; try diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 806a1849..74c8a9e3 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -64,6 +64,15 @@ public static TApp UseBotApplication( return botApp; } + /// + /// Adds a bot application to the service collection with the default configuration section name "AzureAd". + /// + /// + /// + /// + public static IServiceCollection AddBotApplication(this IServiceCollection services, string sectionName = "AzureAd") + => services.AddBotApplication(sectionName); + /// /// Adds a bot application to the service collection. /// diff --git a/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj b/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj index b7c88f86..c214cec1 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj +++ b/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj @@ -16,12 +16,12 @@ - - + + - - + + From 0e6c20a273827679a1ba057646c91c706c4e481e Mon Sep 17 00:00:00 2001 From: Rido Date: Fri, 13 Feb 2026 09:28:32 -0800 Subject: [PATCH 55/69] Consolidate SuppressMessage attributes in GlobalSuppresions (#332) Seems our CI is broken because of https://github.com/dotnet/sdk/issues/53006 I use this opportunity to consolidate SuppressError messages. This pull request refactors how code analysis suppressions are managed across the solution. Instead of applying `[SuppressMessage]` attributes directly to classes and methods, project-level suppressions are now centralized in `GlobalSuppressions.cs` files for each relevant project. This change improves maintainability and reduces clutter in the codebase. Key changes include: **Centralization of Code Analysis Suppressions:** * Added new `GlobalSuppressions.cs` files in `Microsoft.Teams.Bot.Core`, `Microsoft.Teams.Bot.Apps`, and `Microsoft.Teams.Bot.Compat` projects to house all project-level suppressions, including rules related to logging performance and design guidelines. [[1]](diffhunk://#diff-a31618c3543ca08086480902914d1b8a2662d91867b152f35a919465c3ac1623R1-R24) [[2]](diffhunk://#diff-46bb45f0e912e49218b1f21c4aa2cdc301655c75a508bc71d8c2e1aa0691c9b4R1-R24) [[3]](diffhunk://#diff-cee1e0aaa0d1fdbef17c0bb1c2b0a64fd3e6680a31c013f8c6b9a70d6fb8ad7bR1-R18) **Removal of Inline SuppressMessage Attributes:** * Removed `[SuppressMessage]` attributes from classes and methods in files such as `Router.cs`, `TeamsApiClient.cs`, `CompatBotAdapter.cs`, `BotApplication.cs`, `ConversationClient.cs`, `JwtExtensions.cs`, `UserTokenClient.cs`, and `BotHttpClient.cs`, as well as from multiple schema/activity/entity classes. These suppressions are now handled at the project level. [[1]](diffhunk://#diff-39661a1e6d086cf06cff19e9627a3424084ccb66df2254a6b56623ef4ccf5016L13-L14) [[2]](diffhunk://#diff-a7b99b48404c7a1f8b81a59f20ace5e826e134eedaeda28dd38a0931db8c4c84L18) [[3]](diffhunk://#diff-c443812ac75b10f0cb9e0929a1165dee72b7c96adbd232d830a65348ccd1b42bL25) [[4]](diffhunk://#diff-2c89073290ce62fb61faed0da2a6153c8e93b318a57364fdbf4c3da6e440a436L16) [[5]](diffhunk://#diff-d62a8ce4aac677906758eb430b84c9432f61ff95342701fdcae909310e2aed27L18) [[6]](diffhunk://#diff-d3d44d1fb1f7c0af05be370ba32f80e12a136f7876e896ecf1a9facf97655c70L22) [[7]](diffhunk://#diff-1943bfd92d68530022946c449fa60ec24a9032e9ad2bee4978ae0dc59bdc1739L24) [[8]](diffhunk://#diff-44232a3c089c8de3dc8fdc228feebdda822293f4be104d00e28275525c46c8c2L19) [[9]](diffhunk://#diff-44232a3c089c8de3dc8fdc228feebdda822293f4be104d00e28275525c46c8c2L38) [[10]](diffhunk://#diff-44232a3c089c8de3dc8fdc228feebdda822293f4be104d00e28275525c46c8c2L70) [[11]](diffhunk://#diff-44232a3c089c8de3dc8fdc228feebdda822293f4be104d00e28275525c46c8c2L101) [[12]](diffhunk://#diff-44232a3c089c8de3dc8fdc228feebdda822293f4be104d00e28275525c46c8c2L124) [[13]](diffhunk://#diff-b9fe8c2661f373312865c34021dcd68b97c7a7308d3814767e941a9e275212f4L13) [[14]](diffhunk://#diff-f1c9ac72f51f1e74cdd25fd72f5b26a7ef64c41e998340dc92bf0c3501e4ee50L13) [[15]](diffhunk://#diff-c012032b5d678f0c2c0adc3b209525719f308955fd766238e6f64ec324ca2c45L14) [[16]](diffhunk://#diff-8fea9343e8aa50c65ec8c4a88b2040380b0b27da68735c7474bda5e7379e7456L11) **Addition of New Suppression Rules:** * Introduced a new suppression for `CA1054:URI-like parameters should not be strings` in the `Microsoft.Teams.Bot.Core.Http` namespace, with justification for consistency with existing API patterns. These changes collectively make code analysis suppression more scalable and easier to manage as the codebase evolves. --- core/samples/Directory.Build.props | 6 +++++ .../GlobalSuppressions.cs | 24 +++++++++++++++++++ .../Routing/Router.cs | 2 -- .../ConversationUpdateActivity.cs | 1 - .../Schema/Entities/OMessageEntity.cs | 1 - .../MessageReactionActivity.cs | 1 - .../Schema/TeamsActivity.cs | 1 - .../TeamsApiClient.cs | 1 - .../CompatBotAdapter.cs | 1 - .../GlobalSuppressions.cs | 18 ++++++++++++++ .../BotApplication.cs | 1 - .../ConversationClient.cs | 1 - .../GlobalSuppressions.cs | 24 +++++++++++++++++++ .../Hosting/JwtExtensions.cs | 1 - .../Http/BotHttpClient.cs | 5 ---- .../Microsoft.Teams.Bot.Core.csproj | 9 +++---- .../UserTokenClient.cs | 1 - 17 files changed, 77 insertions(+), 21 deletions(-) create mode 100644 core/samples/Directory.Build.props create mode 100644 core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs create mode 100644 core/src/Microsoft.Teams.Bot.Compat/GlobalSuppressions.cs create mode 100644 core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs diff --git a/core/samples/Directory.Build.props b/core/samples/Directory.Build.props new file mode 100644 index 00000000..f4880b17 --- /dev/null +++ b/core/samples/Directory.Build.props @@ -0,0 +1,6 @@ + + + all + true + + diff --git a/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs b/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs new file mode 100644 index 00000000..738c1ea9 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs @@ -0,0 +1,24 @@ +// This file is used by Code Analysis to maintain SuppressMessage +// attributes that are applied to this project. +// Project-level suppressions either have no target or are given +// a specific target and scoped to a namespace, type, member, etc. + +using System.Diagnostics.CodeAnalysis; + +[assembly: SuppressMessage("Performance", + "CA1873:Avoid potentially expensive logging", + Justification = "", + Scope = "namespaceanddescendants", + Target = "~N:Microsoft.Teams.Bot.Apps")] + +[assembly: SuppressMessage("Performance", + "CA1848:Use the LoggerMessage delegates", + Justification = "", + Scope = "namespaceanddescendants", + Target = "~N:Microsoft.Teams.Bot.Apps")] + +[assembly: SuppressMessage("Usage", + "CA2227:Collection properties should be read only", + Justification = "", + Scope = "namespaceanddescendants", + Target = "~N:Microsoft.Teams.Bot.Apps.Schema")] diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs index df73f91f..e3f4b01b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -10,8 +10,6 @@ namespace Microsoft.Teams.Bot.Apps.Routing; /// /// Router for dispatching Teams activities to registered routes /// -[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] - public sealed class Router(ILogger logger) { private readonly List _routes = []; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs index 165649d9..9f5415e3 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs @@ -10,7 +10,6 @@ namespace Microsoft.Teams.Bot.Apps.Schema.ConversationActivities; /// /// Represents a conversation update activity. /// -[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] public class ConversationUpdateActivity : TeamsActivity { /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs index efb6da3c..692c56b0 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs @@ -8,7 +8,6 @@ namespace Microsoft.Teams.Bot.Apps.Schema.Entities /// /// OMessage entity. /// - [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] public class OMessageEntity : Entity { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs index 5222dec8..70a0bdd6 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs @@ -11,7 +11,6 @@ namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; /// /// Represents a message reaction activity. /// -[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] public class MessageReactionActivity : TeamsActivity { /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs index bbd47520..15300a1c 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs @@ -10,7 +10,6 @@ namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Teams Activity schema. /// -[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227: Collection Properties should be read only", Justification = "")] public class TeamsActivity : CoreActivity { /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs index 7e2099d5..d4a5a74a 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.cs @@ -15,7 +15,6 @@ namespace Microsoft.Teams.Bot.Apps; /// /// The HTTP client instance used to send requests to the Teams service. Must not be null. /// The logger instance used for logging. Optional. -[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class TeamsApiClient(HttpClient httpClient, ILogger logger = default!) { private readonly BotHttpClient _botHttpClient = new(httpClient, logger); diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs index 21c7700b..9112b02c 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs @@ -22,7 +22,6 @@ namespace Microsoft.Teams.Bot.Compat; /// This class is intended for scenarios where integration with non-standard bot runtimes or legacy systems is /// required. /// The service provider used to resolve dependencies. -[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class CompatBotAdapter(IServiceProvider sp) : BotAdapter { private readonly JsonSerializerOptions _writeIndentedJsonOptions = new() { WriteIndented = true }; diff --git a/core/src/Microsoft.Teams.Bot.Compat/GlobalSuppressions.cs b/core/src/Microsoft.Teams.Bot.Compat/GlobalSuppressions.cs new file mode 100644 index 00000000..eea350bd --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Compat/GlobalSuppressions.cs @@ -0,0 +1,18 @@ +// This file is used by Code Analysis to maintain SuppressMessage +// attributes that are applied to this project. +// Project-level suppressions either have no target or are given +// a specific target and scoped to a namespace, type, member, etc. + +using System.Diagnostics.CodeAnalysis; + +[assembly: SuppressMessage("Performance", + "CA1873:Avoid potentially expensive logging", + Justification = "", + Scope = "namespaceanddescendants", + Target = "~N:Microsoft.Teams.Bot.Compat")] + +[assembly: SuppressMessage("Performance", + "CA1848:Use the LoggerMessage delegates", + Justification = "", + Scope = "namespaceanddescendants", + Target = "~N:Microsoft.Teams.Bot.Compat")] diff --git a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index b739e973..565cbaf2 100644 --- a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -13,7 +13,6 @@ namespace Microsoft.Teams.Bot.Core; /// /// Represents a bot application. /// -[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class BotApplication { private readonly ILogger _logger; diff --git a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs index c396f8e7..c74886ba 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs @@ -15,7 +15,6 @@ namespace Microsoft.Teams.Bot.Core; /// /// The HTTP client instance used to send requests to the conversation service. Must not be null. /// The logger instance used for logging. Optional. -[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class ConversationClient(HttpClient httpClient, ILogger logger = default!) { private readonly BotHttpClient _botHttpClient = new(httpClient, logger); diff --git a/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs b/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs new file mode 100644 index 00000000..68ddd28b --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs @@ -0,0 +1,24 @@ +// This file is used by Code Analysis to maintain SuppressMessage +// attributes that are applied to this project. +// Project-level suppressions either have no target or are given +// a specific target and scoped to a namespace, type, member, etc. + +using System.Diagnostics.CodeAnalysis; + +[assembly: SuppressMessage("Performance", + "CA1873:Avoid potentially expensive logging", + Justification = "", + Scope = "namespaceanddescendants", + Target = "~N:Microsoft.Teams.Bot.Core")] + +[assembly: SuppressMessage("Performance", + "CA1848:Use the LoggerMessage delegates", + Justification = "", + Scope = "namespaceanddescendants", + Target = "~N:Microsoft.Teams.Bot.Core")] + +[assembly: SuppressMessage("Design", + "CA1054:URI-like parameters should not be strings", + Justification = "String URLs are used for consistency with existing API patterns", + Scope = "namespaceanddescendants", + Target = "~N:Microsoft.Teams.Bot.Core.Http")] diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs index 58536188..994f4fdd 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs @@ -19,7 +19,6 @@ namespace Microsoft.Teams.Bot.Core.Hosting /// /// Provides extension methods for configuring JWT authentication and authorization for bots and agents. /// - [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public static class JwtExtensions { internal const string BotScheme = "BotScheme"; diff --git a/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs b/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs index bcfb61c4..f972895d 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Http/BotHttpClient.cs @@ -16,7 +16,6 @@ namespace Microsoft.Teams.Bot.Core.Http; /// /// The HTTP client instance used to send requests. /// The logger instance used for logging. Optional. -[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class BotHttpClient(HttpClient httpClient, ILogger? logger = null) { private static readonly JsonSerializerOptions DefaultJsonOptions = new() @@ -35,7 +34,6 @@ public class BotHttpClient(HttpClient httpClient, ILogger? logger = null) /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains the deserialized response, or null if the response is empty or 404 (when ReturnNullOnNotFound is true). /// Thrown if the request fails and the failure is not handled by options. - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "String URLs are used for consistency with existing API patterns")] public async Task SendAsync( HttpMethod method, string url, @@ -67,7 +65,6 @@ public class BotHttpClient(HttpClient httpClient, ILogger? logger = null) /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains the deserialized response, or null if the response is empty or 404 (when ReturnNullOnNotFound is true). /// Thrown if the request fails and the failure is not handled by options. - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "String URLs are used for consistency with existing API patterns")] public async Task SendAsync( HttpMethod method, string baseUrl, @@ -98,7 +95,6 @@ public class BotHttpClient(HttpClient httpClient, ILogger? logger = null) /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. /// Thrown if the request fails. - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "String URLs are used for consistency with existing API patterns")] public async Task SendAsync( HttpMethod method, string url, @@ -121,7 +117,6 @@ public async Task SendAsync( /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. /// Thrown if the request fails. - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:URI-like parameters should not be strings", Justification = "String URLs are used for consistency with existing API patterns")] public async Task SendAsync( HttpMethod method, string baseUrl, diff --git a/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj b/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj index c214cec1..210e9608 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj +++ b/core/src/Microsoft.Teams.Bot.Core/Microsoft.Teams.Bot.Core.csproj @@ -12,12 +12,13 @@ - - + + + - - + + diff --git a/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs index fe2a3e4b..346ea430 100644 --- a/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs @@ -21,7 +21,6 @@ namespace Microsoft.Teams.Bot.Core; /// The HTTP client for making requests to the token service. /// Configuration containing the UserTokenApiEndpoint setting and other bot configuration. /// Logger for diagnostic information and request tracking. -[System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] public class UserTokenClient(HttpClient httpClient, IConfiguration configuration, ILogger logger) { internal const string UserTokenHttpClientName = "BotUserTokenClient"; From 55e9fcfa12fd2cd9ca3b422f4f73a025240cd853 Mon Sep 17 00:00:00 2001 From: Kavin <115390646+singhk97@users.noreply.github.com> Date: Fri, 13 Feb 2026 13:12:42 -0500 Subject: [PATCH 56/69] fix transitive package dependency issue + refactor router setup (#325) - Create Router internally with dedicated logger instead of injecting as dependency --------- Co-authored-by: Claude Sonnet 4.5 --- core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs | 2 +- core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs | 4 +--- .../CompatAdapterTests.cs | 4 +--- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs index e3f4b01b..0ee054e5 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -10,7 +10,7 @@ namespace Microsoft.Teams.Bot.Apps.Routing; /// /// Router for dispatching Teams activities to registered routes /// -public sealed class Router(ILogger logger) +public sealed class Router(ILogger logger) { private readonly List _routes = []; diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 95494afd..60a8de90 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -36,7 +36,6 @@ public class TeamsBotApplication : BotApplication /// /// /// - /// /// public TeamsBotApplication( ConversationClient conversationClient, @@ -45,12 +44,11 @@ public TeamsBotApplication( IConfiguration config, IHttpContextAccessor httpContextAccessor, ILogger logger, - Router router, string sectionName = "AzureAd") : base(conversationClient, userTokenClient, config, logger, sectionName) { _teamsApiClient = teamsApiClient; - Router = router; + Router = new Router(logger); OnActivity = async (activity, cancellationToken) => { TeamsActivity teamsActivity = TeamsActivity.FromActivity(activity); diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs index 8c782ee4..1559ee1a 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs @@ -82,7 +82,6 @@ private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() var userTokenClient = new UserTokenClient(httpClient, mockConfig.Object, NullLogger.Instance); var teamsApiClient = new TeamsApiClient(httpClient, NullLogger.Instance); - var router = new Router(NullLogger.Instance); var teamsBotApplication = new TeamsBotApplication( conversationClient, @@ -90,8 +89,7 @@ private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() teamsApiClient, mockConfig.Object, Mock.Of(), - NullLogger.Instance, - router); + NullLogger.Instance); var mockServiceProvider = new Mock(); mockServiceProvider From c91f619b61833479d19e5c1d5f2ebada9dc198e6 Mon Sep 17 00:00:00 2001 From: Mehak Bindra Date: Tue, 17 Feb 2026 11:05:54 -0800 Subject: [PATCH 57/69] Add invoke payloads and handlers (#326) * Added all invoke activities ( some are commented that could not be tested ) * Added `AllInvokesBot` sample project for adaptive card actions, task modules, file consent, and other invoke scenarios. * Added `MessageExtensionBot` sample project. * Made invoke activity and invoke response strongly typed vi generics. --- core/.editorconfig | 1 - core/core.slnx | 2 + .../AllInvokesBot/AllInvokesBot.csproj | 13 + core/samples/AllInvokesBot/Cards.cs | 141 +++++++ core/samples/AllInvokesBot/Program.cs | 283 ++++++++++++++ core/samples/AllInvokesBot/README.md | 52 +++ core/samples/AllInvokesBot/appsettings.json | 9 + core/samples/AllInvokesBot/manifest.json | 61 +++ core/samples/CompatBot/EchoBot.cs | 4 +- core/samples/MessageExtensionBot/Cards.cs | 117 ++++++ .../MessageExtensionBot.csproj | 13 + core/samples/MessageExtensionBot/Program.cs | 260 +++++++++++++ core/samples/MessageExtensionBot/README.md | 55 +++ .../MessageExtensionBot/appsettings.json | 10 + .../samples/MessageExtensionBot/manifest.json | 123 ++++++ core/samples/TeamsBot/Program.cs | 10 +- core/samples/TeamsChannelBot/Program.cs | 14 +- core/src/Microsoft.Teams.Bot.Apps/Context.cs | 1 + .../GlobalSuppressions.cs | 2 +- .../Handlers/AdaptiveCardHandler.cs | 39 ++ .../Handlers/ConversationUpdateHandler.cs | 1 - .../Handlers/FileConsentHandler.cs | 40 ++ .../Handlers/InstallUpdateHandler.cs | 1 - .../Handlers/InvokeHandler.cs | 40 +- .../Handlers/MessageDeleteHandler.cs | 1 - .../Handlers/MessageExtensionHandler.cs | 258 +++++++++++++ .../Handlers/MessageHandler.cs | 1 - .../Handlers/MessageReactionHandler.cs | 1 - .../Handlers/MessageUpdateHandler.cs | 1 - .../Handlers/TaskHandler.cs | 61 +++ .../Microsoft.Teams.Bot.Apps/Routing/Route.cs | 7 +- .../Routing/Router.cs | 9 +- .../ConversationUpdateActivity.cs | 2 +- .../InstallUpdateActivity.cs | 2 +- .../InvokeActivity.cs | 135 ++++--- .../MessageActivity.cs | 4 +- .../MessageDeleteActivity.cs | 2 +- .../MessageReactionActivity.cs | 88 +---- .../MessageUpdateActivity.cs | 3 +- .../Schema/Entities/ClientInfoEntity.cs | 2 +- .../Schema/Entities/Entity.cs | 4 +- .../Schema/Entities/MentionEntity.cs | 3 +- .../Schema/Entities/OMessageEntity.cs | 41 +- .../Schema/Entities/ProductInfoEntity.cs | 2 +- .../Schema/Entities/SensitiveUsageEntity.cs | 2 +- .../Schema/Entities/StreamInfoEntity.cs | 2 +- .../Schema/Invokes/AdaptiveCardActionValue.cs | 68 ++++ .../Schema/Invokes/AdaptiveCardResponse.cs | 136 +++++++ .../Schema/Invokes/FileConsentValue.cs | 74 ++++ .../Schema/Invokes/InvokeResponse.cs | 57 +++ .../Schema/Invokes/MessageExtensionAction.cs | 345 +++++++++++++++++ .../Invokes/MessageExtensionActionResponse.cs | 94 +++++ .../Schema/Invokes/MessageExtensionQuery.cs | 77 ++++ .../Invokes/MessageExtensionQueryLink.cs | 27 ++ .../Invokes/MessageExtensionResponse.cs | 359 ++++++++++++++++++ .../Schema/Invokes/TaskModuleRequest.cs | 36 ++ .../Schema/Invokes/TaskModuleResponse.cs | 260 +++++++++++++ .../Microsoft.Teams.Bot.Apps/Schema/Team.cs | 77 ++-- .../Schema/TeamsActivity.cs | 42 +- .../Schema/TeamsActivityBuilder.cs | 1 - .../Schema/TeamsActivityJsonContext.cs | 3 - .../Schema/TeamsActivityType.cs | 27 +- .../Schema/TeamsAttachment.cs | 88 ++++- .../Schema/TeamsChannelData.cs | 4 +- .../Schema/TeamsConversation.cs | 2 +- .../TeamsApiClient.Models.cs | 12 +- .../TeamsBotApplication.HostingExtensions.cs | 1 - .../TeamsBotApplication.cs | 9 +- .../ConversationClient.Models.cs | 10 - .../GlobalSuppressions.cs | 6 + .../Schema/ChannelData.cs | 2 - .../Schema/Conversation.cs | 2 - .../Schema/ConversationAccount.cs | 2 - .../Schema/CoreActivity.cs | 2 - .../UserTokenCLIService.cs | 1 - .../ActivitiesTests.cs | 5 +- .../InvokeActivityTest.cs | 7 - .../MessageActivityTests.cs | 3 +- .../TeamsActivityBuilderTests.cs | 3 +- .../TeamsActivityTests.cs | 6 +- 80 files changed, 3413 insertions(+), 358 deletions(-) create mode 100644 core/samples/AllInvokesBot/AllInvokesBot.csproj create mode 100644 core/samples/AllInvokesBot/Cards.cs create mode 100644 core/samples/AllInvokesBot/Program.cs create mode 100644 core/samples/AllInvokesBot/README.md create mode 100644 core/samples/AllInvokesBot/appsettings.json create mode 100644 core/samples/AllInvokesBot/manifest.json create mode 100644 core/samples/MessageExtensionBot/Cards.cs create mode 100644 core/samples/MessageExtensionBot/MessageExtensionBot.csproj create mode 100644 core/samples/MessageExtensionBot/Program.cs create mode 100644 core/samples/MessageExtensionBot/README.md create mode 100644 core/samples/MessageExtensionBot/appsettings.json create mode 100644 core/samples/MessageExtensionBot/manifest.json create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/AdaptiveCardHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/FileConsentHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageExtensionHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/TaskHandler.cs rename core/src/Microsoft.Teams.Bot.Apps/Schema/{ConversationActivities => Activities}/ConversationUpdateActivity.cs (98%) rename core/src/Microsoft.Teams.Bot.Apps/Schema/{InstallActivities => Activities}/InstallUpdateActivity.cs (96%) rename core/src/Microsoft.Teams.Bot.Apps/Schema/{MessageActivities => Activities}/InvokeActivity.cs (59%) rename core/src/Microsoft.Teams.Bot.Apps/Schema/{MessageActivities => Activities}/MessageActivity.cs (98%) rename core/src/Microsoft.Teams.Bot.Apps/Schema/{MessageActivities => Activities}/MessageDeleteActivity.cs (95%) rename core/src/Microsoft.Teams.Bot.Apps/Schema/{MessageActivities => Activities}/MessageReactionActivity.cs (69%) rename core/src/Microsoft.Teams.Bot.Apps/Schema/{MessageActivities => Activities}/MessageUpdateActivity.cs (94%) create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/AdaptiveCardActionValue.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/AdaptiveCardResponse.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/FileConsentValue.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/InvokeResponse.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionAction.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionActionResponse.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionQuery.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionQueryLink.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionResponse.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleRequest.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleResponse.cs diff --git a/core/.editorconfig b/core/.editorconfig index 540657fa..c25f7d71 100644 --- a/core/.editorconfig +++ b/core/.editorconfig @@ -12,7 +12,6 @@ indent_style = space indent_size = 4 nullable = enable #dotnet_diagnostic.CS1591.severity = none ## Suppress missing XML comment warnings -dotnet_diagnostic.CA1848.severity = warning #### Nullable Reference Types #### # Make nullable warnings strict diff --git a/core/core.slnx b/core/core.slnx index 6944f616..24c672d2 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -11,9 +11,11 @@ --> + + diff --git a/core/samples/AllInvokesBot/AllInvokesBot.csproj b/core/samples/AllInvokesBot/AllInvokesBot.csproj new file mode 100644 index 00000000..f30bcbe3 --- /dev/null +++ b/core/samples/AllInvokesBot/AllInvokesBot.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/core/samples/AllInvokesBot/Cards.cs b/core/samples/AllInvokesBot/Cards.cs new file mode 100644 index 00000000..e16d35c5 --- /dev/null +++ b/core/samples/AllInvokesBot/Cards.cs @@ -0,0 +1,141 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Nodes; +using Microsoft.Teams.Bot.Apps.Schema; + +namespace AllInvokesBot; + +public static class Cards +{ + public static JsonObject CreateWelcomeCard() + { + return new JsonObject + { + ["type"] = "AdaptiveCard", + ["version"] = "1.4", + ["body"] = new JsonArray + { + new JsonObject + { + ["type"] = "TextBlock", + ["text"] = "Welcome to InvokesBot!", + ["size"] = "Large", + ["weight"] = "Bolder" + }, + new JsonObject + { + ["type"] = "TextBlock", + ["text"] = "Click the buttons below to test different invoke handlers:" + } + }, + ["actions"] = new JsonArray + { + new JsonObject + { + ["type"] = "Action.Execute", + ["id"] = "1234", + ["title"] = "Test Adaptive Card Action", + ["verb"] = "testAction", + ["data"] = new JsonObject + { + ["message"] = "Button clicked!" + } + }, + new JsonObject + { + ["type"] = "Action.Submit", + ["title"] = "Open Task Module", + ["data"] = new JsonObject + { + ["msteams"] = new JsonObject + { + ["type"] = "task/fetch" + } + } + }, + new JsonObject + { + ["type"] = "Action.Execute", + ["title"] = "Request File Upload", + ["verb"] = "requestFileUpload" + } + } + }; + } + + public static JsonObject CreateFileConsentCard() + { + return new JsonObject + { + ["description"] = "This is a sample file to demonstrate file consent", + ["sizeInBytes"] = 1024, + ["acceptContext"] = new JsonObject + { + ["fileId"] = "123456" + }, + ["declineContext"] = new JsonObject + { + ["fileId"] = "123456" + } + }; + } + + public static JsonObject CreateAdaptiveActionResponseCard(string? verb, string? message) + { + return new JsonObject + { + ["type"] = "AdaptiveCard", + ["version"] = "1.4", + ["body"] = new JsonArray + { + new JsonObject + { + ["type"] = "TextBlock", + ["text"] = $"Action '{verb}' executed", + ["weight"] = "Bolder" + }, + new JsonObject + { + ["type"] = "TextBlock", + ["text"] = $"Message: {message}", + ["wrap"] = true + } + } + }; + } + + public static JsonObject CreateTaskModuleCard() + { + return new JsonObject + { + ["type"] = "AdaptiveCard", + ["version"] = "1.4", + ["body"] = new JsonArray + { + new JsonObject + { + ["type"] = "TextBlock", + ["text"] = "Task Module" + } + }, + ["actions"] = new JsonArray + { + new JsonObject + { + ["type"] = "Action.Submit", + ["title"] = "Submit" + } + } + }; + } + + public static JsonObject CreateFileInfoCard(string? uniqueId, string? fileType) + { + return new JsonObject + { + ["uniqueId"] = uniqueId, + ["fileType"] = fileType + }; + } +} diff --git a/core/samples/AllInvokesBot/Program.cs b/core/samples/AllInvokesBot/Program.cs new file mode 100644 index 00000000..d0aed19c --- /dev/null +++ b/core/samples/AllInvokesBot/Program.cs @@ -0,0 +1,283 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using AllInvokesBot; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Teams.Bot.Apps.Schema; + +var builder = TeamsBotApplication.CreateBuilder(args); +var bot = builder.Build(); + +// ==================== MESSAGE - SEND SIMPLE CARD ==================== +bot.OnMessage(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnMessage"); + + var card = Cards.CreateWelcomeCard(); + + TeamsAttachment attachment = TeamsAttachment.CreateBuilder() + .WithAdaptiveCard(card) + .Build(); + + await context.SendActivityAsync(new MessageActivity([attachment]), cancellationToken); +}); + +// ==================== ADAPTIVE CARD ACTION ==================== +bot.OnAdaptiveCardAction(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnAdaptiveCardAction"); + var value = context.Activity.Value; + var action = value?.Action; + string? verb = action?.Verb; + var data = action?.Data; + + Console.WriteLine($" Verb: {verb}"); + Console.WriteLine($" Data: {JsonSerializer.Serialize(data)}"); + + // Handle file upload request + if (verb == "requestFileUpload") + { + var fileConsentCard = Cards.CreateFileConsentCard(); + TeamsAttachment fileConsentCardResponse = TeamsAttachment.CreateBuilder() + .WithContent(fileConsentCard).WithContentType(AttachmentContentType.FileConsentCard) + .WithName("file_consent.json").Build(); + await context.SendActivityAsync(new MessageActivity([fileConsentCardResponse]), cancellationToken); + + return AdaptiveCardResponse.CreateMessageResponse("File Consent requested!"); + } + + string? message = data != null && data.TryGetValue("message", out var msgValue) ? msgValue?.ToString() : null; + + var adaptiveActionCard = Cards.CreateAdaptiveActionResponseCard(verb, message); + TeamsAttachment adaptiveActionCardResponse = TeamsAttachment.CreateBuilder().WithAdaptiveCard(adaptiveActionCard).Build(); + await context.SendActivityAsync(new MessageActivity([adaptiveActionCardResponse]), cancellationToken); + + return AdaptiveCardResponse.CreateMessageResponse("Action submitted!"); +}); + +// ==================== TASK MODULE - FETCH ==================== +bot.OnTaskFetch(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnTaskFetch"); + TeamsAttachment taskModuleCardResponse = TeamsAttachment.CreateBuilder() + .WithAdaptiveCard(Cards.CreateTaskModuleCard()).Build(); + return TaskModuleResponse.CreateBuilder() + .WithType(TaskModuleResponseType.Continue) + .WithTitle("Task") + .WithHeight("medium") + .WithWidth("medium") + .WithCard(taskModuleCardResponse) + .Build(); + +}); + +// ==================== TASK MODULE - SUBMIT ==================== +bot.OnTaskSubmit(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnTaskSubmit"); + return TaskModuleResponse.CreateBuilder() + .WithType(TaskModuleResponseType.Message) + .WithMessage("Done") + .Build(); +}); + +// ==================== FILE CONSENT ==================== +bot.OnFileConsent(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnFileConsent"); + + var value = context.Activity.Value; + string? action = value?.Action; + var uploadInfo = value?.UploadInfo; + var consentContext = value?.Context; + + if (action == "accept") + { + Console.WriteLine($" File accepted!"); + + // Upload the file + string? uploadUrl = uploadInfo?.UploadUrl?.ToString(); + string? fileName = uploadInfo?.Name; + string? contentUrl = uploadInfo?.ContentUrl?.ToString(); + string? uniqueId = uploadInfo?.UniqueId; + + if (uploadUrl!=null && contentUrl != null) + { + // Create sample file content + string fileContent = "This is a sample file uploaded via file consent!"; + byte[] fileBytes = System.Text.Encoding.UTF8.GetBytes(fileContent); + int fileSize = fileBytes.Length; + + using var httpClient = new HttpClient(); + using var content = new ByteArrayContent(fileBytes); + content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/octet-stream"); + content.Headers.ContentRange = new System.Net.Http.Headers.ContentRangeHeaderValue(0, fileSize - 1, fileSize); + + try + { + var uploadResponse = await httpClient.PutAsync(uploadUrl, content, cancellationToken); + Console.WriteLine($" Upload Status: {uploadResponse.StatusCode}"); + + if (uploadResponse.IsSuccessStatusCode) + { + var fileInfoContent = Cards.CreateFileInfoCard(uniqueId, uploadInfo?.FileType); + + TeamsAttachment fileUploadResponse = TeamsAttachment.CreateBuilder() + .WithName(fileName) + .WithContentType(AttachmentContentType.FileInfoCard) + .WithContentUrl(contentUrl != null ? new Uri(contentUrl) : null) + .WithContent(fileInfoContent).Build(); + + await context.SendActivityAsync(new MessageActivity([fileUploadResponse]), cancellationToken); + } + else + { + Console.WriteLine($" File upload failed: {await uploadResponse.Content.ReadAsStringAsync(cancellationToken)}"); + } + } + catch (Exception ex) + { + Console.WriteLine($" File upload error: {ex.Message}"); + } + } + } + else if (action == "decline") + { + Console.WriteLine($" File declined!"); + Console.WriteLine($" Context: {JsonSerializer.Serialize(consentContext)}"); + } + + return AdaptiveCardResponse.CreateBuilder() + .WithStatusCode(200) + .Build(); +}); + +/* +// ==================== EXECUTE ACTION ==================== +bot.OnExecuteAction(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnExecuteAction"); + + var responseBody = new JsonObject + { + ["status"] = "completed" + }; + + return new CoreInvokeResponse(200, responseBody); +}); + +// ==================== HANDOFF ==================== +bot.OnHandoff(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnHandoff"); + return new CoreInvokeResponse(200); +}); + +// ==================== SEARCH ==================== +bot.OnSearch(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnSearch"); + + var responseBody = new JsonObject + { + ["results"] = new JsonArray + { + new JsonObject + { + ["id"] = "1", + ["title"] = "Result" + } + } + }; + + return new CoreInvokeResponse(200, responseBody); +}); + +// ==================== MESSAGE SUBMIT ACTION ==================== +bot.OnMessageSubmitAction(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnMessageSubmitAction"); + + var data = context.Activity.Value; + Console.WriteLine($" Data: {System.Text.Json.JsonSerializer.Serialize(data)}"); + + // Extract data fields + var jsonData = System.Text.Json.JsonSerializer.Deserialize( + System.Text.Json.JsonSerializer.Serialize(data)); + + string? action = jsonData.TryGetProperty("action", out var a) ? a.GetString() : "unknown"; + string? value = jsonData.TryGetProperty("value", out var v) ? v.GetString() : "no value"; + + Console.WriteLine($" Action: {action}"); + Console.WriteLine($" Value: {value}"); + + var responseBody = new JsonObject + { + ["statusCode"] = 200, + ["type"] = "application/vnd.microsoft.activity.message", + ["value"] = $"Message action '{action}' submitted! Value: {value}" + }; + + return new CoreInvokeResponse(200, responseBody); +}); + +// ==================== CONFIG FETCH ==================== +bot.OnConfigFetch(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnConfigFetch"); + + var card = new + { + contentType = AttachmentContentType.AdaptiveCard, + content = new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new { type = "TextBlock", text = "Extension Settings", size = "large", weight = "bolder" }, + new { type = "TextBlock", text = "Configure your messaging extension settings below:", wrap = true }, + new { type = "Input.Text", id = "apiKey", label = "API Key", placeholder = "Enter your API key" }, + new { type = "Input.Toggle", id = "enableNotifications", label = "Enable Notifications", value = "true" } + }, + actions = new object[] + { + new { type = "Action.Submit", title = "Save Settings" } + } + } + }; + + var response = TaskModuleResponse.CreateBuilder() + .WithType(TaskModuleResponseType.Continue) + .WithTitle("Configure Messaging Extension") + .WithHeight(TaskModuleSize.Medium) + .WithWidth(TaskModuleSize.Medium) + .WithCard(card) + .Build(); + + return new CoreInvokeResponse(200, response); +}); + +// ==================== CONFIG SUBMIT ==================== +bot.OnConfigSubmit(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnConfigSubmit"); + + var data = context.Activity.Value; + Console.WriteLine($" Config data: {System.Text.Json.JsonSerializer.Serialize(data)}"); + + // In a real app, you would save these settings to a database + // associated with the user/team + + var response = TaskModuleResponse.CreateBuilder() + .WithType(TaskModuleResponseType.Message) + .WithMessage("Settings saved successfully!") + .Build(); + + return new CoreInvokeResponse(200, response); +}); +*/ + +bot.Run(); diff --git a/core/samples/AllInvokesBot/README.md b/core/samples/AllInvokesBot/README.md new file mode 100644 index 00000000..bcb0805e --- /dev/null +++ b/core/samples/AllInvokesBot/README.md @@ -0,0 +1,52 @@ +# AllInvokesBot Testing Guide + +A sample bot demonstrating Teams invoke handlers. + +## Setup + +1. Configure bot credentials in `appsettings.json` or environment variables +2. Run the bot: `dotnet run` +3. Upload `manifest.json` to Teams + +## Testing Handlers + +### OnMessage +**Manifest:** `bots` section with appropriate `scopes` (personal, team, groupChat) + +1. Send any message to the bot in 1:1 chat +2. Verify welcome card with action buttons appears + +### OnAdaptiveCardAction +**Manifest:** No specific requirement (triggered by adaptive card actions) + +1. After receiving the welcome card +2. Click any action button on the card +3. Verify action response card appears +4. Console logs will show the verb and data + +**File Upload Flow:** +1. Click "Request File Upload" button +2. Verify file consent card appears + +### OnFileConsent +**Manifest:** `bots.supportsFiles: true` +**Azure:** Delegated permission `Files.ReadWrite.All` required in Azure app registration + +1. After requesting file upload (see above) +2. Click Accept or Decline on the file consent card +3. If Accept - verify file uploads and file info card appears +4. If Decline - verify console logs the decline action + +### OnTaskFetch +**Manifest:** No specific requirement (triggered by task module actions) + +1. Click "Open Task Module" button on the welcome card +2. Verify task module dialog opens with input form + +### OnTaskSubmit +**Manifest:** No specific requirement (works with OnTaskFetch) + +1. Open task module (see OnTaskFetch) +2. Fill in the form +3. Click submit +4. Verify "Done" message appears diff --git a/core/samples/AllInvokesBot/appsettings.json b/core/samples/AllInvokesBot/appsettings.json new file mode 100644 index 00000000..10f68b8c --- /dev/null +++ b/core/samples/AllInvokesBot/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*" +} diff --git a/core/samples/AllInvokesBot/manifest.json b/core/samples/AllInvokesBot/manifest.json new file mode 100644 index 00000000..53406f9e --- /dev/null +++ b/core/samples/AllInvokesBot/manifest.json @@ -0,0 +1,61 @@ +{ + "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.24/MicrosoftTeams.schema.json", + "version": "1.0.0", + "manifestVersion": "1.24", + "id": "YOUR_BOT_ID", + "name": { + "short": "YOUR_BOT_NAME", + "full": "YOUR_BOT_NAME" + }, + "developer": { + "name": "Microsoft", + "mpnId": "", + "websiteUrl": "https://microsoft.com", + "privacyUrl": "https://privacy.microsoft.com/privacystatement", + "termsOfUseUrl": "https://www.microsoft.com/legal/terms-of-use" + }, + "description": { + "short": "YOUR_BOT_NAME", + "full": "YOUR_BOT_NAME" + }, + "icons": { + "outline": "outline.png", + "color": "color.png" + }, + "accentColor": "#FFFFFF", + "staticTabs": [ + { + "entityId": "conversations", + "scopes": [ + "personal" + ] + }, + { + "entityId": "about", + "scopes": [ + "personal" + ] + } + ], + "bots": [ + { + "botId": "YOUR_BOT_ID", + "scopes": [ + "personal", + "team", + "groupChat" + ], + "isNotificationOnly": false, + "supportsCalling": false, + "supportsVideo": false, + "supportsFiles": true + } + ], + "validDomains": [ + "*.microsoft.com" + ], + "webApplicationInfo": { + "id": "YOUR_BOT_ID", + "resource": "https://graph.microsoft.com" + } +} diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 6b8da45e..5853a8c0 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -75,7 +75,7 @@ protected override async Task OnInstallationUpdateAddAsync(ITurnContext OnInvokeActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) + protected override async Task OnInvokeActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) { logger.LogInformation("Invoke Activity received: {Name}", turnContext.Activity.Name); var actionValue = JObject.FromObject(turnContext.Activity.Value); @@ -97,7 +97,7 @@ protected override async Task OnInvokeActivityAsync(ITurnContext var card = MessageFactory.Attachment(attachment); await turnContext.SendActivityAsync(card, cancellationToken); - return new InvokeResponse + return new Microsoft.Bot.Builder.InvokeResponse { Status = 200, Body = new { value = "invokes from compat bot" } diff --git a/core/samples/MessageExtensionBot/Cards.cs b/core/samples/MessageExtensionBot/Cards.cs new file mode 100644 index 00000000..e2751529 --- /dev/null +++ b/core/samples/MessageExtensionBot/Cards.cs @@ -0,0 +1,117 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace MessageExtensionBot; + +public static class Cards +{ + public static object[] CreateQueryResultCards(string searchText) + { + return new[] + { + new + { + title = $"Result 1: {searchText}", + text = "Click to see full details", + tap = new + { + type = "invoke", + value = new + { + itemId = "item-1", + title = $"Full details for Result 1: {searchText}", + description = "This is the expanded content" + } + } + }, + new + { + title = $"Result 2: {searchText}", + text = "Click to see full details", + tap = new + { + type = "invoke", + value = new + { + itemId = "item-2", + title = $"Full details for Result 2: {searchText}", + description = "This is more expanded content" + } + } + } + }; + } + + public static object CreateSelectItemCard(string? itemId, string? title, string? description) + { + return new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new { type = "TextBlock", text = title, size = "large", weight = "bolder" }, + new { type = "TextBlock", text = description, wrap = true }, + new { type = "FactSet", facts = new[] + { + new { title = "Item ID:", value = itemId } + } + } + } + }; + } + + public static object CreateFetchTaskCard(string? commandId) + { + return new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new { type = "TextBlock", text = $"Fetch Task for: {commandId}", size = "large", weight = "bolder" }, + new { type = "Input.Text", id = "title", label = "Title", placeholder = "Enter a title" }, + new { type = "Input.Text", id = "description", label = "Description", placeholder = "Enter a description", isMultiline = true } + }, + actions = new object[] + { + new { type = "Action.Submit", title = "Submit" } + } + }; + } + + public static object CreateEditFormCard(string? previewTitle, string? previewDescription) + { + return new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new { type = "TextBlock", text = "Edit Your Card", size = "large", weight = "bolder" }, + new { type = "Input.Text", id = "title", label = "Title", placeholder = "Enter a title", value = previewTitle }, + new { type = "Input.Text", id = "description", label = "Description", placeholder = "Enter a description", isMultiline = true, value = previewDescription } + }, + actions = new object[] { new { type = "Action.Submit", title = "Submit" } } + }; + } + + public static object CreateSubmitActionCard(string? title, string? description) + { + return new + { + type = "AdaptiveCard", + version = "1.4", + body = new object[] + { + new { type = "TextBlock", text = title ?? "Untitled", size = "large", weight = "bolder", color = "accent" }, + new { type = "TextBlock", text = description ?? "No description", wrap = true } + } + }; + } + + public static object CreateLinkUnfurlCard(string? url) + { + return new { title = $"Link Unfurled: {url}" }; + } +} diff --git a/core/samples/MessageExtensionBot/MessageExtensionBot.csproj b/core/samples/MessageExtensionBot/MessageExtensionBot.csproj new file mode 100644 index 00000000..f30bcbe3 --- /dev/null +++ b/core/samples/MessageExtensionBot/MessageExtensionBot.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/core/samples/MessageExtensionBot/Program.cs b/core/samples/MessageExtensionBot/Program.cs new file mode 100644 index 00000000..4ae569ce --- /dev/null +++ b/core/samples/MessageExtensionBot/Program.cs @@ -0,0 +1,260 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using MessageExtensionBot; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Teams.Bot.Apps.Schema; + +var builder = TeamsBotApplication.CreateBuilder(args); +var bot = builder.Build(); + +// ==================== MESSAGE EXTENSION QUERY ==================== +bot.OnQuery(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnQuery"); + + MessageExtensionQuery? query = context.Activity.Value; + string commandId = query?.CommandId ?? "unknown"; + string searchText = query?.Parameters + .FirstOrDefault(p => !p.Name.Equals("initialRun"))? + .Value ?? "default"; + + if (searchText.Equals("help", StringComparison.OrdinalIgnoreCase)) + { + return MessageExtensionResponse.CreateBuilder() + .WithType(MessageExtensionResponseType.Message) + .WithText("💡 Search for any keyword to see results.") + .Build(); + } + + // Create results with tap actions to trigger OnSelectItem + var cards = Cards.CreateQueryResultCards(searchText); + TeamsAttachment[] attachments = [.. cards.Select(card => TeamsAttachment.CreateBuilder().WithContent(card) + .WithContentType(AttachmentContentType.ThumbnailCard).Build())]; + + return MessageExtensionResponse.CreateBuilder() + .WithType(MessageExtensionResponseType.Result) + .WithAttachmentLayout(TeamsAttachmentLayout.List) + .WithAttachments(attachments) + .Build(); +}); + +// ==================== MESSAGE EXTENSION SELECT ITEM ==================== +bot.OnSelectItem(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnSelectItem"); + + var selectedItem = context.Activity.Value; + var itemData = selectedItem as JsonElement?; + string? itemId = itemData.Value.TryGetProperty("itemId", out var id) ? id.GetString() : "unknown"; + string? title = itemData.Value.TryGetProperty("title", out var t) ? t.GetString() : "Selected Item"; + string? description = itemData.Value.TryGetProperty("description", out var d) ? d.GetString() : "No description"; + + var card = Cards.CreateSelectItemCard(itemId, title, description); + TeamsAttachment attachment = TeamsAttachment.CreateBuilder().WithAdaptiveCard(card).Build(); + + return MessageExtensionResponse.CreateBuilder() + .WithType(MessageExtensionResponseType.Result) + .WithAttachmentLayout(TeamsAttachmentLayout.List) + .WithAttachments(attachment) + .Build(); +}); + +// ==================== MESSAGE EXTENSION FETCH TASK ==================== +bot.OnFetchTask(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnFetchTask"); + + MessageExtensionAction? action = context.Activity.Value; + + var fetchTaskCard = Cards.CreateFetchTaskCard(action?.CommandId ?? "unknown"); + TeamsAttachment fetchTaskCardResponse = TeamsAttachment.CreateBuilder() + .WithAdaptiveCard(fetchTaskCard).Build(); + return MessageExtensionActionResponse.CreateBuilder() + .WithTask(TaskModuleResponse.CreateBuilder() + .WithType(TaskModuleResponseType.Continue) + .WithTitle("Task Module") + .WithCard(fetchTaskCardResponse)) + .Build(); +}); + +// Helper: Extract title and description from preview card +(string?, string?) GetDataFromPreview(TeamsActivity? preview) +{ + if (preview?.Attachments == null) return (null, null); + + var cardData = JsonSerializer.Deserialize( + JsonSerializer.Serialize(preview.Attachments[0].Content)); + + if (!cardData.TryGetProperty("body", out var body) || body.ValueKind != JsonValueKind.Array) + return (null, null); + + var title = body.GetArrayLength() > 0 && body[0].TryGetProperty("text", out var t) ? t.GetString() : null; + var description = body.GetArrayLength() > 1 && body[1].TryGetProperty("text", out var d) ? d.GetString() : null; + + return (title, description); +} + + +// ==================== MESSAGE EXTENSION SUBMIT ACTION ==================== +bot.OnSubmitAction(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnSubmitAction"); + + MessageExtensionAction? action = context.Activity.Value; + + // Handle "edit" - user clicked edit on the preview, show the form again + if (action?.BotMessagePreviewAction == "edit") + { + Console.WriteLine("Handling EDIT action - returning to form"); + var (previewTitle, previewDescription) = GetDataFromPreview(action.BotActivityPreview?.FirstOrDefault()); + + var editFormCard = Cards.CreateEditFormCard(previewTitle, previewDescription); + TeamsAttachment editFormCardResponse = TeamsAttachment.CreateBuilder() + .WithAdaptiveCard(editFormCard).Build(); + return MessageExtensionActionResponse.CreateBuilder() + .WithTask(TaskModuleResponse.CreateBuilder() + .WithType(TaskModuleResponseType.Continue) + .WithTitle("Edit Card") + .WithCard(editFormCardResponse)) + .Build(); + } + + // Handle "send" - user clicked send on the preview, finalize the card + //TODO : when I start from the compose box or message, i get an error at this point but seems to be a teams issue ( no activity is sent on clicking send) + if (action?.BotMessagePreviewAction == "send") + { + Console.WriteLine("Handling SEND action - finalizing card"); + var (previewTitle, previewDescription) = GetDataFromPreview(action.BotActivityPreview?.FirstOrDefault()); + + var card = Cards.CreateSubmitActionCard(previewTitle, previewDescription); + TeamsAttachment attachment2 = TeamsAttachment.CreateBuilder().WithAdaptiveCard(card).Build(); + + return MessageExtensionActionResponse.CreateBuilder() + .WithComposeExtension(MessageExtensionResponse.CreateBuilder() + .WithType(MessageExtensionResponseType.Result) + .WithAttachmentLayout(TeamsAttachmentLayout.List) + .WithAttachments(attachment2)) + .Build(); + } + + + var data = action?.Data as JsonElement?; + string? title = data != null && data.Value.TryGetProperty("title", out var t) ? t.GetString() : "Untitled"; + string? description = data != null && data.Value.TryGetProperty("description", out var d) ? d.GetString() : "No description"; + + var previewCard = Cards.CreateSubmitActionCard(title, description); + TeamsAttachment attachment = TeamsAttachment.CreateBuilder().WithAdaptiveCard(previewCard).Build(); + + return MessageExtensionActionResponse.CreateBuilder() + .WithComposeExtension(MessageExtensionResponse.CreateBuilder() + .WithType(MessageExtensionResponseType.BotMessagePreview) + .WithActivityPreview(new MessageActivity([attachment])) + ) + .Build(); +}); + +// ==================== MESSAGE EXTENSION QUERY LINK ==================== +bot.OnQueryLink(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnQueryLink"); + + MessageExtensionQueryLink? queryLink = context.Activity.Value; + + var card = Cards.CreateLinkUnfurlCard(queryLink?.Url?.ToString()); + TeamsAttachment attachment = TeamsAttachment.CreateBuilder() + .WithContent(card).WithContentType(AttachmentContentType.ThumbnailCard).Build(); + + return MessageExtensionResponse.CreateBuilder() + .WithType(MessageExtensionResponseType.Result) + .WithAttachmentLayout(TeamsAttachmentLayout.List) + .WithAttachments(attachment) + .Build(); +}); + +// ==================== MESSAGE EXTENSION ANON QUERY LINK ==================== +//TODO : difficult to test, app must be published to catalog +bot.OnAnonQueryLink(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnAnonQueryLink"); + + MessageExtensionQueryLink? anonQueryLink = context.Activity.Value; + if (anonQueryLink != null) + { + Console.WriteLine($" URL: '{anonQueryLink.Url}'"); + } + + var card = Cards.CreateLinkUnfurlCard(anonQueryLink?.Url?.ToString()); + TeamsAttachment attachment = TeamsAttachment.CreateBuilder() + .WithContent(card).WithContentType(AttachmentContentType.ThumbnailCard).Build(); + + return MessageExtensionResponse.CreateBuilder() + .WithType(MessageExtensionResponseType.Result) + .WithAttachmentLayout(TeamsAttachmentLayout.List) + .WithAttachments(attachment) + .Build(); +}); + + +// ==================== MESSAGE EXTENSION QUERY SETTING URL ==================== +bot.OnQuerySettingUrl(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnQuerySettingUrl"); + + var query = context.Activity.Value; + + var action = new + { + Type = "openUrl", + Value = "https://www.microsoft.com" + }; + + return MessageExtensionResponse.CreateBuilder() + .WithType(MessageExtensionResponseType.Config) + .WithSuggestedActions([action]) + .Build(); +}); + + +//TODO : this is deprecated ? +// ==================== MESSAGE EXTENSION CARD BUTTON CLICKED ==================== +//bot.OnCardButtonClicked(async (context, cancellationToken) => +//{ +// Console.WriteLine("✓ OnCardButtonClicked"); +// Console.WriteLine($" Activity Type: {context.Activity.GetType().Name}"); +// +// return new CoreInvokeResponse(200); +//}); + +//TODO : only able to get OnQuerySettingUrl activity, how do we get onSetting or OnConfigFetch +/* +// ==================== MESSAGE EXTENSION SETTING ==================== +bot.OnSetting(async (context, cancellationToken) => +{ + Console.WriteLine("✓ OnSetting"); + + var query = context.Activity.Value; + if (query != null) + { + Console.WriteLine($" Command ID: '{query.CommandId}'"); + } + + var action = new MessagingExtensionAction + { + Type = "openUrl", + Value = "https://microsoft.com", + Title = "Configure Settings" + }; + + var response = MessagingExtensionResponse.CreateBuilder() + .WithType(MessagingExtensionResponseType.Config) + .WithSuggestedActions(action) + .Build(); + + return new CoreInvokeResponse(200, response); +}); +*/ + +bot.Run(); \ No newline at end of file diff --git a/core/samples/MessageExtensionBot/README.md b/core/samples/MessageExtensionBot/README.md new file mode 100644 index 00000000..f8062b00 --- /dev/null +++ b/core/samples/MessageExtensionBot/README.md @@ -0,0 +1,55 @@ +# MessageExtensionBot Testing Guide + +A sample bot demonstrating Teams message extension handlers. + +## Setup + +1. Configure bot credentials in `appsettings.json` or environment variables +2. Run the bot: `dotnet run` +3. Upload `manifest.json` to Teams + +## Testing Handlers + +### OnQuery (Search) +**Manifest:** `composeExtensions.commands` with `type: "query"` + +1. Open message compose box +2. Select the message extension +3. Type a search term +4. Verify results display in list format +5. Type "help" to test message response + +### OnSelectItem +**Manifest:** No specific requirement (works with OnQuery results) + +1. After running a search (OnQuery) +2. Click on any search result +3. Verify adaptive card preview appears + +### OnFetchTask (Action - Task Module) +**Manifest:** `composeExtensions.commands` with `type: "action"` and `fetchTask: true` + +1. Click the message extension action button (createAction) +2. Verify task module opens with input form + +### OnSubmitAction (Action Submit) +**Manifest:** No specific requirement (works with OnFetchTask) + +1. Fill form in task module +2. Click submit +3. Verify preview card appears with Edit/Send buttons +4. Click Edit - verify form reopens with values +5. Click Send - verify final card posts to conversation -- Currently this only works when we start from commandbox. + +### OnQueryLink (Link Unfurling) +**Manifest:** `composeExtensions.messageHandlers` with `type: "link"` and `domains` + +1. Paste a URL in compose box that matches the unfurl domain in manifest (*.example.com) +2. Verify card unfurls automatically + +### OnQuerySettingUrl (Settings) +**Manifest:** `composeExtensions.canUpdateConfiguration: true` + +1. Right-click message extension icon +2. Select Settings +3. Verify settings URL opens (microsoft.com) diff --git a/core/samples/MessageExtensionBot/appsettings.json b/core/samples/MessageExtensionBot/appsettings.json new file mode 100644 index 00000000..f88090b1 --- /dev/null +++ b/core/samples/MessageExtensionBot/appsettings.json @@ -0,0 +1,10 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Warning", + "Microsoft.Bot": "Information", + "Microsoft.Teams": "Information" + } + }, + "AllowedHosts": "*" +} diff --git a/core/samples/MessageExtensionBot/manifest.json b/core/samples/MessageExtensionBot/manifest.json new file mode 100644 index 00000000..d6c36e98 --- /dev/null +++ b/core/samples/MessageExtensionBot/manifest.json @@ -0,0 +1,123 @@ +{ + "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.24/MicrosoftTeams.schema.json", + "version": "1.0.0", + "manifestVersion": "1.24", + "id": "YOUR_BOT_ID", + "name": { + "short": "YOUR_BOT_NAME", + "full": "YOUR_BOT_NAME" + }, + "developer": { + "name": "Microsoft", + "mpnId": "", + "websiteUrl": "https://microsoft.com", + "privacyUrl": "https://privacy.microsoft.com/privacystatement", + "termsOfUseUrl": "https://www.microsoft.com/legal/terms-of-use" + }, + "description": { + "short": "YOUR_BOT_NAME", + "full": "YOUR_BOT_NAME" + }, + "icons": { + "outline": "outline.png", + "color": "color.png" + }, + "accentColor": "#FFFFFF", + "staticTabs": [ + { + "entityId": "conversations", + "scopes": [ + "personal" + ] + }, + { + "entityId": "about", + "scopes": [ + "personal" + ] + } + ], + "bots": [ + { + "botId": "YOUR_BOT_ID", + "scopes": [ + "personal", + "team", + "groupChat" + ], + "isNotificationOnly": false, + "supportsCalling": false, + "supportsVideo": false, + "supportsFiles": false + } + ], + "composeExtensions": [ + { + "botId": "YOUR_BOT_ID", + "commands": [ + { + "id": "searchQuery", + "type": "query", + "title": "searchQuery", + "description": "Enter search text", + "initialRun": true, + "fetchTask": false, + "context": [ + "commandBox", + "compose", + "message" + ], + "parameters": [ + { + "name": "searchText", + "title": "searchText", + "description": "Enter search text", + "inputType": "text" + } + ] + }, + { + "id": "createAction", + "type": "action", + "title": "createAction", + "description": "Create a new item", + "initialRun": true, + "fetchTask": true, + "context": [ + "commandBox", + "compose", + "message" + ], + "parameters": [ + { + "name": "createAction", + "title": "createAction", + "description": "Create a new item", + "inputType": "text" + } + ] + } + ], + "canUpdateConfiguration": true, + "messageHandlers": [ + { + "type": "link", + "value": { + "domains": [ + "*.example.com", + "*.microsoft.com" + ], + "supportsAnonymizedPayloads": true + } + } + ] + } + ], + "validDomains": [ + "*.microsoft.com" + ], + "webApplicationInfo": { + "id": "YOUR_BOT_ID", + "resource": "https://graph.microsoft.com" + } +} diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 3edd5283..b6d463c6 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -1,12 +1,10 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Text.RegularExpressions; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.Entities; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; -using System.Text.RegularExpressions; using TeamsBot; var builder = TeamsBotApplication.CreateBuilder(args); @@ -143,11 +141,7 @@ [Visit Microsoft](https://www.microsoft.com) await context.SendActivityAsync(reply, cancellationToken); - return new CoreInvokeResponse(200) - { - Type = "application/vnd.microsoft.activity.message", - Body = "Invokes are great !!" - }; + return AdaptiveCardResponse.CreateMessageResponse("Invokes are great!!"); }); // ==================== CONVERSATION UPDATE HANDLERS ==================== diff --git a/core/samples/TeamsChannelBot/Program.cs b/core/samples/TeamsChannelBot/Program.cs index 7caa20d9..acd713e6 100644 --- a/core/samples/TeamsChannelBot/Program.cs +++ b/core/samples/TeamsChannelBot/Program.cs @@ -20,21 +20,21 @@ app.OnChannelCreated(async (context, cancellationToken) => { - var channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; + string channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; Console.WriteLine($"[ChannelCreated] Channel '{channelName}' was created"); await context.SendActivityAsync($"New channel created: {channelName}", cancellationToken); }); app.OnChannelDeleted(async (context, cancellationToken) => { - var channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; + string channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; Console.WriteLine($"[ChannelDeleted] Channel '{channelName}' was deleted"); await context.SendActivityAsync($"Channel deleted: {channelName}", cancellationToken); }); app.OnChannelRenamed(async (context, cancellationToken) => { - var channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; + string channelName = context.Activity.ChannelData?.Channel?.Name ?? "unknown"; Console.WriteLine($"[ChannelRenamed] Channel renamed to '{channelName}'"); await context.SendActivityAsync($"Channel renamed to: {channelName}", cancellationToken); }); @@ -95,28 +95,28 @@ app.OnTeamArchived((context, cancellationToken) => { - var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + string teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; Console.WriteLine($"[TeamArchived] Team '{teamName}' was archived"); return Task.CompletedTask; }); app.OnTeamDeleted((context, cancellationToken) => { - var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + string teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; Console.WriteLine($"[TeamDeleted] Team '{teamName}' was deleted"); return Task.CompletedTask; }); app.OnTeamRenamed(async (context, cancellationToken) => { - var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + string teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; Console.WriteLine($"[TeamRenamed] Team renamed to '{teamName}'"); await context.SendActivityAsync($"Team renamed to: {teamName}", cancellationToken); }); app.OnTeamUnarchived(async (context, cancellationToken) => { - var teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; + string teamName = context.Activity.ChannelData?.Team?.Name ?? "unknown"; Console.WriteLine($"[TeamUnarchived] Team '{teamName}' was unarchived"); await context.SendActivityAsync($"Team unarchived: {teamName}", cancellationToken); }); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Context.cs b/core/src/Microsoft.Teams.Bot.Apps/Context.cs index 779d7f6a..b627c97b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Context.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Context.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Core; diff --git a/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs b/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs index 738c1ea9..9ab4ece0 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs @@ -21,4 +21,4 @@ "CA2227:Collection properties should be read only", Justification = "", Scope = "namespaceanddescendants", - Target = "~N:Microsoft.Teams.Bot.Apps.Schema")] + Target = "~N:Microsoft.Teams.Bot.Apps")] diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/AdaptiveCardHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/AdaptiveCardHandler.cs new file mode 100644 index 00000000..dbc1097a --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/AdaptiveCardHandler.cs @@ -0,0 +1,39 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling adaptive card action invoke activities. +/// +public delegate Task AdaptiveCardActionHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering adaptive card action invoke handlers. +/// +public static class AdaptiveCardExtensions +{ + /// + /// Registers a handler for adaptive card action invoke activities. + /// + public static TeamsBotApplication OnAdaptiveCardAction(this TeamsBotApplication app, AdaptiveCardActionHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.AdaptiveCardAction), + Selector = activity => activity.Name == InvokeNames.AdaptiveCardAction, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs index 2bb878d2..ad69b8f7 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/ConversationUpdateHandler.cs @@ -3,7 +3,6 @@ using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.ConversationActivities; namespace Microsoft.Teams.Bot.Apps.Handlers; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/FileConsentHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/FileConsentHandler.cs new file mode 100644 index 00000000..4c215e01 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/FileConsentHandler.cs @@ -0,0 +1,40 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling file consent invoke activities. +/// +public delegate Task> FileConsentValueHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering file consent invoke handlers. +/// +public static class FileConsentExtensions +{ + + /// + /// Registers a handler for file consent invoke activities. + /// + public static TeamsBotApplication OnFileConsent(this TeamsBotApplication app, FileConsentValueHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.FileConsent), + Selector = activity => activity.Name == InvokeNames.FileConsent, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallUpdateHandler.cs index 3ecb1a26..c97b4a60 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallUpdateHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InstallUpdateHandler.cs @@ -3,7 +3,6 @@ using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.InstallActivities; namespace Microsoft.Teams.Bot.Apps.Handlers; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs index 7b595371..0f95c820 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/InvokeHandler.cs @@ -1,10 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.Handlers; @@ -16,7 +14,7 @@ namespace Microsoft.Teams.Bot.Apps.Handlers; /// A cancellation token that can be used to cancel the operation. The default value is . /// A task that represents the asynchronous operation. The task result contains the response to the invocation. -public delegate Task InvokeHandler(Context context, CancellationToken cancellationToken = default); +public delegate Task InvokeHandler(Context context, CancellationToken cancellationToken = default); /// /// Provides extension methods for registering handlers for invoke activities in a Teams bot application. @@ -44,39 +42,3 @@ public static TeamsBotApplication OnInvoke(this TeamsBotApplication app, InvokeH return app; } } - -/// -/// Represents the response returned from an invocation handler, typically used for Adaptive Card actions and task module operations. -/// -/// -/// This class encapsulates the HTTP-style response sent back to Teams when handling invoke activities. -/// Common status codes include 200 for success, 400 for bad request, and 500 for errors. -/// The Body property contains the response payload, which is serialized to JSON and returned to the client. -/// -/// The HTTP status code indicating the result of the invoke operation (e.g., 200 for success). -/// Optional response payload that will be serialized and sent to the client. -public class CoreInvokeResponse(int status, object? body = null) -{ - /// - /// Status code of the response. - /// - [JsonPropertyName("status")] - public int Status { get; set; } = status; - - // TODO: This is strange - Should this be Value or Body? - /// - /// Gets or sets the message body content. - /// - [JsonPropertyName("value")] - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - public object? Body { get; set; } = body; - - // TODO: Get confirmation that this should be "Type" - // This particular type should be for AC responses - /// - /// Gets or Sets the Type - /// - [JsonPropertyName("type")] - [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] - public string? Type { get; set; } -} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageDeleteHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageDeleteHandler.cs index a0b8c709..a140491a 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageDeleteHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageDeleteHandler.cs @@ -3,7 +3,6 @@ using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.Handlers; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageExtensionHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageExtensionHandler.cs new file mode 100644 index 00000000..24d0c8d2 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageExtensionHandler.cs @@ -0,0 +1,258 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling message extension query invoke activities. +/// +public delegate Task> MessageExtensionQueryHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling message extension submit action invoke activities. +/// Can return either a TaskModuleResponse or MessageExtensionResponse. +/// +public delegate Task> MessageExtensionSubmitActionHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling message extension fetch task invoke activities. +/// Can return either a TaskModuleResponse or MessageExtensionResponse. +/// +public delegate Task> MessageExtensionFetchTaskHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling message extension query link invoke activities. +/// +public delegate Task> MessageExtensionQueryLinkHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling message extension anonymous query link invoke activities. +/// +public delegate Task> MessageExtensionAnonQueryLinkHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling message extension select item invoke activities. +/// +public delegate Task> MessageExtensionSelectItemHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling message extension query setting URL invoke activities. +/// +public delegate Task> MessageExtensionQuerySettingUrlHandler(Context> context, CancellationToken cancellationToken = default); + +/* +/// +/// Delegate for handling message extension card button clicked invoke activities. +/// +public delegate Task MessageExtensionCardButtonClickedHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling message extension setting invoke activities. +/// +public delegate Task MessageExtensionSettingHandler(Context> context, CancellationToken cancellationToken = default); +*/ + +/// +/// Extension methods for registering message extension invoke handlers. +/// +public static class MessageExtensionExtensions +{ + //TODO : add msg ext prefix to handlers ? very confusing right now as we have both onFetchTask and onTaskFetch. + //onSubmitAction is confusing as it is similar to adaptive cards + + /// + /// Registers a handler for message extension query invoke activities with strongly-typed response. + /// + public static TeamsBotApplication OnQuery(this TeamsBotApplication app, MessageExtensionQueryHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.MessageExtensionQuery), + Selector = activity => activity.Name == InvokeNames.MessageExtensionQuery, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for message extension submit action invoke activities. + /// + public static TeamsBotApplication OnSubmitAction(this TeamsBotApplication app, MessageExtensionSubmitActionHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.MessageExtensionSubmitAction), + Selector = activity => activity.Name == InvokeNames.MessageExtensionSubmitAction, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for message extension query link invoke activities with strongly-typed response. + /// + public static TeamsBotApplication OnQueryLink(this TeamsBotApplication app, MessageExtensionQueryLinkHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.MessageExtensionQueryLink), + Selector = activity => activity.Name == InvokeNames.MessageExtensionQueryLink, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for message extension anonymous query link invoke activities with strongly-typed response. + /// + public static TeamsBotApplication OnAnonQueryLink(this TeamsBotApplication app, MessageExtensionAnonQueryLinkHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.MessageExtensionAnonQueryLink), + Selector = activity => activity.Name == InvokeNames.MessageExtensionAnonQueryLink, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for message extension fetch task invoke activities. + /// + public static TeamsBotApplication OnFetchTask(this TeamsBotApplication app, MessageExtensionFetchTaskHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.MessageExtensionFetchTask), + Selector = activity => activity.Name == InvokeNames.MessageExtensionFetchTask, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for message extension select item invoke activities with strongly-typed response. + /// + public static TeamsBotApplication OnSelectItem(this TeamsBotApplication app, MessageExtensionSelectItemHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.MessageExtensionSelectItem), + Selector = activity => activity.Name == InvokeNames.MessageExtensionSelectItem, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for message extension query setting URL invoke activities with strongly-typed response. + /// + public static TeamsBotApplication OnQuerySettingUrl(this TeamsBotApplication app, MessageExtensionQuerySettingUrlHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.MessageExtensionQuerySettingUrl), + Selector = activity => activity.Name == InvokeNames.MessageExtensionQuerySettingUrl, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + + /* + /// + /// Registers a handler for message extension card button clicked invoke activities. + /// + public static TeamsBotApplication OnCardButtonClicked(this TeamsBotApplication app, MessageExtensionCardButtonClickedHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.MessageExtensionCardButtonClicked), + Selector = activity => activity.Name == InvokeNames.MessageExtensionCardButtonClicked, + HandlerWithReturn = async (ctx, cancellationToken) => + { + var typedActivity = new InvokeActivity(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for message extension setting invoke activities. + /// + public static TeamsBotApplication OnSetting(this TeamsBotApplication app, MessageExtensionSettingHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.MessageExtensionSetting), + Selector = activity => activity.Name == InvokeNames.MessageExtensionSetting, + HandlerWithReturn = async (ctx, cancellationToken) => + { + var typedActivity = new InvokeActivity(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + */ +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs index 9c13e69f..35828247 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs @@ -4,7 +4,6 @@ using System.Text.RegularExpressions; using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.Handlers; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs index 29f468ba..86165af6 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageReactionHandler.cs @@ -3,7 +3,6 @@ using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.Handlers; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageUpdateHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageUpdateHandler.cs index dcb48e98..c0e1f975 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageUpdateHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageUpdateHandler.cs @@ -3,7 +3,6 @@ using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.Handlers; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/TaskHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/TaskHandler.cs new file mode 100644 index 00000000..a87e89e0 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/TaskHandler.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling task module invoke activities. +/// +public delegate Task> TaskModuleHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering task module invoke handlers. +/// +public static class TaskExtensions +{ + + /// + /// Registers a handler for task module fetch invoke activities. + /// + public static TeamsBotApplication OnTaskFetch(this TeamsBotApplication app, TaskModuleHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.TaskFetch), + Selector = activity => activity.Name == InvokeNames.TaskFetch, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new (ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false);; + } + }); + + return app; + } + + /// + /// Registers a handler for task module submit invoke activities with strongly-typed value and response. + /// + public static TeamsBotApplication OnTaskSubmit(this TeamsBotApplication app, TaskModuleHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Invoke, InvokeNames.TaskSubmit), + Selector = activity => activity.Name == InvokeNames.TaskSubmit, + HandlerWithReturn = async (ctx, cancellationToken) => + { + InvokeActivity typedActivity = new (ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + return await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs index 1a012707..ba67152d 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; namespace Microsoft.Teams.Bot.Apps.Routing; @@ -37,7 +36,7 @@ public abstract class RouteBase /// /// /// - public abstract Task InvokeRouteWithReturn(Context ctx, CancellationToken cancellationToken = default); + public abstract Task InvokeRouteWithReturn(Context ctx, CancellationToken cancellationToken = default); } /// @@ -69,7 +68,7 @@ public override string Name /// /// Handler function to process the activity and return a response /// - public Func, CancellationToken, Task>? HandlerWithReturn { get; set; } + public Func, CancellationToken, Task>? HandlerWithReturn { get; set; } /// /// Determines if the route matches the given activity @@ -108,7 +107,7 @@ public override async Task InvokeRoute(Context ctx, CancellationT /// /// /// - public override async Task InvokeRouteWithReturn(Context ctx, CancellationToken cancellationToken = default) + public override async Task InvokeRouteWithReturn(Context ctx, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(ctx); if (ctx.Activity is TActivity typedActivity) diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs index 0ee054e5..f8be8f1f 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -2,7 +2,6 @@ // Licensed under the MIT License. using Microsoft.Extensions.Logging; -using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; namespace Microsoft.Teams.Bot.Apps.Routing; @@ -10,7 +9,7 @@ namespace Microsoft.Teams.Bot.Apps.Routing; /// /// Router for dispatching Teams activities to registered routes /// -public sealed class Router(ILogger logger) +internal sealed class Router(ILogger logger) { private readonly List _routes = []; @@ -24,7 +23,7 @@ public sealed class Router(ILogger logger) /// IMPORTANT: Register specific routes before general catch-all routes. /// Call Next() in handlers to continue to the next matching route. /// - internal Router Register(Route route) where TActivity : TeamsActivity + public Router Register(Route route) where TActivity : TeamsActivity { _routes.Add(route); return this; @@ -34,7 +33,7 @@ internal Router Register(Route route) where TActivity : Te /// Dispatches the activity to the first matching route. /// Routes are checked in registration order. /// - internal async Task DispatchAsync(Context ctx, CancellationToken cancellationToken = default) + public async Task DispatchAsync(Context ctx, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(ctx); @@ -69,7 +68,7 @@ internal async Task DispatchAsync(Context ctx, CancellationToken /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains a response object with the outcome /// of the invocation. - internal async Task DispatchWithReturnAsync(Context ctx, CancellationToken cancellationToken = default) + public async Task DispatchWithReturnAsync(Context ctx, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(ctx); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/ConversationUpdateActivity.cs similarity index 98% rename from core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/ConversationUpdateActivity.cs index 9f5415e3..79010f7f 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/ConversationActivities/ConversationUpdateActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/ConversationUpdateActivity.cs @@ -5,7 +5,7 @@ using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.Bot.Apps.Schema.ConversationActivities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents a conversation update activity. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/InstallActivities/InstallUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs similarity index 96% rename from core/src/Microsoft.Teams.Bot.Apps/Schema/InstallActivities/InstallUpdateActivity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs index 964157b5..31147c59 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/InstallActivities/InstallUpdateActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs @@ -4,7 +4,7 @@ using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.Bot.Apps.Schema.InstallActivities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents an installation update activity. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InvokeActivity.cs similarity index 59% rename from core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InvokeActivity.cs index edbb31a5..09405b1d 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/InvokeActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InvokeActivity.cs @@ -1,10 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Text.Json; using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents an invoke activity. @@ -27,16 +28,11 @@ public class InvokeActivity : TeamsActivity /// [JsonPropertyName("name")] public string? Name { get; set; } - ///// - ///// Gets or sets a value that is associated with the activity. - ///// - //[JsonPropertyName("value")] - //public object? Value { get; set; } - - /// - /// Initializes a new instance of the class. - /// - [JsonConstructor] + + /// + /// Initializes a new instance of the class. + /// + [JsonConstructor] public InvokeActivity() : base(TeamsActivityType.Invoke) { } @@ -45,7 +41,7 @@ public InvokeActivity() : base(TeamsActivityType.Invoke) /// Initializes a new instance of the class with the specified name. /// /// The invoke operation name. - + public InvokeActivity(string name) : base(TeamsActivityType.Invoke) { Name = name; @@ -67,44 +63,64 @@ protected InvokeActivity(CoreActivity activity) : base(activity) } /// -/// String constants for invoke activity names. +/// Represents an invoke activity with a strongly-typed value. /// -public static class InvokeNames +/// +/// The strongly-typed Value property provides compile-time type safety while maintaining a single storage location +/// through the base class. Both the typed and untyped Value properties access the same underlying JsonNode value. +/// +/// The type of the value payload. +public class InvokeActivity : InvokeActivity { /// - /// Execute action invoke name. + /// Gets or sets the strongly-typed value associated with the invoke activity. + /// This property shadows the base class Value property but uses the same underlying storage, + /// ensuring no synchronization issues between typed and untyped access. /// - public const string ExecuteAction = "actionableMessage/executeAction"; - - /// - /// File consent invoke name. - /// - public const string FileConsent = "fileConsent/invoke"; + public new TValue? Value + { + get => base.Value != null ? JsonSerializer.Deserialize(base.Value.ToJsonString()) : default; + set => base.Value = value != null ? JsonSerializer.SerializeToNode(value) : null; + } /// - /// Handoff invoke name. + /// Initializes a new instance of the class. /// - public const string Handoff = "handoff/action"; + public InvokeActivity() : base() + { + } /// - /// Search invoke name. + /// Initializes a new instance of the class with the specified name. /// - public const string Search = "search"; + /// The invoke operation name. + public InvokeActivity(string name) : base(name) + { + } /// - /// Adaptive card action invoke name. + /// Initializes a new instance of the class from an InvokeActivity. /// - public const string AdaptiveCardAction = "adaptiveCard/action"; + /// The invoke activity. + public InvokeActivity(InvokeActivity activity) : base(activity) + { + } +} +/// +/// String constants for invoke activity names. +/// +public static class InvokeNames +{ /// - /// Config fetch invoke name. + /// File consent invoke name. /// - public const string ConfigFetch = "config/fetch"; + public const string FileConsent = "fileConsent/invoke"; /// - /// Config submit invoke name. + /// Adaptive card action invoke name. /// - public const string ConfigSubmit = "config/submit"; + public const string AdaptiveCardAction = "adaptiveCard/action"; /// /// Tab fetch invoke name. @@ -136,21 +152,11 @@ public static class InvokeNames /// public const string SignInVerifyState = "signin/verifyState"; - /// - /// Message submit action invoke name. - /// - public const string MessageSubmitAction = "message/submitAction"; - /// /// Message extension anonymous query link invoke name. /// public const string MessageExtensionAnonQueryLink = "composeExtension/anonymousQueryLink"; - /// - /// Message extension card button clicked invoke name. - /// - public const string MessageExtensionCardButtonClicked = "composeExtension/onCardButtonClicked"; - /// /// Message extension fetch task invoke name. /// @@ -176,13 +182,50 @@ public static class InvokeNames /// public const string MessageExtensionSelectItem = "composeExtension/selectItem"; - /// - /// Message extension setting invoke name. - /// - public const string MessageExtensionSetting = "composeExtension/setting"; - /// /// Message extension submit action invoke name. /// public const string MessageExtensionSubmitAction = "composeExtension/submitAction"; + + //TODO : review + /* + /// + /// Execute action invoke name. + /// + public const string ExecuteAction = "actionableMessage/executeAction"; + + /// + /// Handoff invoke name. + /// + public const string Handoff = "handoff/action"; + + /// + /// Search invoke name. + /// + public const string Search = "search"; + /// + /// Config fetch invoke name. + /// + public const string ConfigFetch = "config/fetch"; + + /// + /// Config submit invoke name. + /// + public const string ConfigSubmit = "config/submit"; + + /// + /// Message submit action invoke name. + /// + public const string MessageSubmitAction = "message/submitAction"; + + /// + /// Message extension card button clicked invoke name. + /// + public const string MessageExtensionCardButtonClicked = "composeExtension/onCardButtonClicked"; + + /// + /// Message extension setting invoke name. + /// + public const string MessageExtensionSetting = "composeExtension/setting"; + */ } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageActivity.cs similarity index 98% rename from core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageActivity.cs index 95f8b58d..c9cc06c9 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageActivity.cs @@ -1,12 +1,10 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System; -using System.Text.Json; using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents a message activity. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageDeleteActivity.cs similarity index 95% rename from core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageDeleteActivity.cs index dea042dd..86137862 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageDeleteActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageDeleteActivity.cs @@ -5,7 +5,7 @@ using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents a message delete activity. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs similarity index 69% rename from core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs index 70a0bdd6..0bad1baa 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageReactionActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs @@ -1,12 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Collections.Generic; using System.Text.Json; using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents a message reaction activity. @@ -62,6 +61,18 @@ protected MessageReactionActivity(CoreActivity activity) : base(activity) } activity.Properties.Remove("reactionsRemoved"); } + if (activity.Properties.TryGetValue("replyToId", out var replyToId) && replyToId != null) + { + if (replyToId is JsonElement jeReplyToId && jeReplyToId.ValueKind == JsonValueKind.String) + { + ReplyToId = jeReplyToId.GetString(); + } + else + { + ReplyToId = replyToId.ToString(); + } + activity.Properties.Remove("replyToId"); + } } /// @@ -75,6 +86,12 @@ protected MessageReactionActivity(CoreActivity activity) : base(activity) /// [JsonPropertyName("reactionsRemoved")] public IList? ReactionsRemoved { get; set; } + + /// + /// Gets or sets the ID of the message being reacted to. + /// + [JsonPropertyName("replyToId")] + public string? ReplyToId { get; set; } } /// @@ -84,23 +101,10 @@ public class MessageReaction { /// /// Gets or sets the type of reaction. + /// See for common values. /// [JsonPropertyName("type")] public string? Type { get; set; } - - /* - /// - /// Gets or sets the date and time when the reaction was created. - /// - [JsonPropertyName("createdDateTime")] - public string? CreatedDateTime { get; set; } - - /// - /// Gets or sets the user who created the reaction. - /// - [JsonPropertyName("user")] - public ReactionUser? User { get; set; } - */ } /// @@ -143,55 +147,3 @@ public static class ReactionTypes /// public const string PlusOne = "plusOne"; } - -/* -/// -/// Represents a user who created a reaction. -/// -public class ReactionUser -{ - /// - /// Gets or sets the user identifier. - /// - [JsonPropertyName("id")] - public string? Id { get; set; } - - /// - /// Gets or sets the user identity type. - /// - [JsonPropertyName("userIdentityType")] - public string? UserIdentityType { get; set; } - - /// - /// Gets or sets the display name of the user. - /// - [JsonPropertyName("displayName")] - public string? DisplayName { get; set; } -} - -/// -/// String constants for user identity types. -/// -public static class UserIdentityTypes -{ - /// - /// Azure Active Directory user. - /// - public const string AadUser = "aadUser"; - - /// - /// On-premise Azure Active Directory user. - /// - public const string OnPremiseAadUser = "onPremiseAadUser"; - - /// - /// Anonymous guest user. - /// - public const string AnonymousGuest = "anonymousGuest"; - - /// - /// Federated user. - /// - public const string FederatedUser = "federatedUser"; -} -*/ diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageUpdateActivity.cs similarity index 94% rename from core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs rename to core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageUpdateActivity.cs index 037d5051..7a2ead30 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/MessageActivities/MessageUpdateActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageUpdateActivity.cs @@ -1,11 +1,10 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text.Json; using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents a message update activity. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs index 91317cf9..e14a2faa 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.Bot.Apps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs index 7a95ce14..7eac6993 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs @@ -6,7 +6,7 @@ using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.Bot.Apps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// @@ -106,9 +106,7 @@ public class Entity(string type) /// /// Extended properties dictionary. /// -#pragma warning disable CA2227 // Collection properties should be read only [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; -#pragma warning restore CA2227 // Collection properties should be read only } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs index 41111012..8ac3d2cb 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs @@ -4,10 +4,9 @@ using System.Text.Json; using System.Text.Json.Nodes; using System.Text.Json.Serialization; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using Microsoft.Teams.Bot.Core.Schema; -namespace Microsoft.Teams.Bot.Apps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Extension methods for Activity to handle mentions. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs index 692c56b0..f9991050 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs @@ -3,30 +3,29 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.Bot.Apps.Schema.Entities +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// OMessage entity. +/// +public class OMessageEntity : Entity { + /// - /// OMessage entity. + /// Creates a new instance of . /// - public class OMessageEntity : Entity + public OMessageEntity() : base("https://schema.org/Message") { - - /// - /// Creates a new instance of . - /// - public OMessageEntity() : base("https://schema.org/Message") - { - OType = "Message"; - OContext = "https://schema.org"; - } - /// - /// Gets or sets the additional type. - /// - [JsonPropertyName("additionalType")] - public IList? AdditionalType - { - get => base.Properties.TryGetValue("additionalType", out var value) ? value as IList : null; - set => base.Properties["additionalType"] = value; - } + OType = "Message"; + OContext = "https://schema.org"; + } + /// + /// Gets or sets the additional type. + /// + [JsonPropertyName("additionalType")] + public IList? AdditionalType + { + get => base.Properties.TryGetValue("additionalType", out var value) ? value as IList : null; + set => base.Properties["additionalType"] = value; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs index 995e2d39..3990e1d1 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.Bot.Apps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs index 87ba6482..8f2de594 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.Bot.Apps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Represents an entity that describes the usage of sensitive content, including its name, description, and associated diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs index 5649e513..6e1541d8 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs @@ -3,7 +3,7 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.Bot.Apps.Schema.Entities; +namespace Microsoft.Teams.Bot.Apps.Schema; /// /// Stream info entity. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/AdaptiveCardActionValue.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/AdaptiveCardActionValue.cs new file mode 100644 index 00000000..b526fad3 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/AdaptiveCardActionValue.cs @@ -0,0 +1,68 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Defines the structure that arrives in the Activity.Value for Invoke activity with +/// Name of 'adaptiveCard/action'. +/// +public class AdaptiveCardActionValue +{ + /// + /// The action of this adaptive card invoke action value. + /// + [JsonPropertyName("action")] + public AdaptiveCardAction? Action { get; set; } + + /// + /// The state for this adaptive card invoke action value. + /// + [JsonPropertyName("state")] + public string? State { get; set; } + + /// + /// What triggered the action. + /// + [JsonPropertyName("trigger")] + public string? Trigger { get; set; } +} + +/// +/// Defines the structure that arrives in the Activity.Value.Action for Invoke +/// activity with Name of 'adaptiveCard/action'. +/// +public class AdaptiveCardAction +{ + /// + /// The Type of this Adaptive Card Invoke Action. + /// + [JsonPropertyName("type")] + public string? Type { get; set; } + + /// + /// The id of this Adaptive Card Invoke Action. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// The title of this Adaptive Card Invoke Action. + /// + [JsonPropertyName("title")] + public string? Title { get; set; } + + /// + /// The Verb of this adaptive card action invoke. + /// + [JsonPropertyName("verb")] + public string? Verb { get; set; } + + /// + /// The Data of this adaptive card action invoke. + /// + [JsonPropertyName("data")] + public Dictionary? Data { get; set; } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/AdaptiveCardResponse.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/AdaptiveCardResponse.cs new file mode 100644 index 00000000..57ec7aa1 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/AdaptiveCardResponse.cs @@ -0,0 +1,136 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Adaptive card response types. +/// +public static class AdaptiveCardResponseType +{ + /// + /// Message type - displays a message to the user. + /// + public const string Message = "application/vnd.microsoft.activity.message"; + + /// + /// Card type - updates the card with new content. + /// + public const string Card = "application/vnd.microsoft.card.adaptive"; +} + +/// +/// +/// Response for adaptive card action activities. +/// +public class AdaptiveCardResponse +{ + /// + /// HTTP status code for the response. + /// + [JsonPropertyName("statusCode")] + public int StatusCode { get; set; } = 200; + + /// + /// Type of response. See for common values. + /// + [JsonPropertyName("type")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Type { get; set; } + + /// + /// Value for the response. Can be a string message or card content. + /// + [JsonPropertyName("value")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public object? Value { get; set; } + + /// + /// Creates a new builder for AdaptiveCardResponse. + /// + public static AdaptiveCardResponseBuilder CreateBuilder() + { + return new AdaptiveCardResponseBuilder(); + } + + /// + /// Creates a InvokeResponse with a message response. + /// + /// The message to display to the user. + /// The HTTP status code (default: 200). + public static InvokeResponse CreateMessageResponse(string message, int statusCode = 200) + { + return new InvokeResponse(statusCode, new AdaptiveCardResponse + { + StatusCode = statusCode, + Type = AdaptiveCardResponseType.Message, + Value = message + }); + } + + /// + /// Creates a InvokeResponse with a card response. + /// + /// The card content to display. + /// The HTTP status code (default: 200). + public static InvokeResponse CreateCardResponse(object card, int statusCode = 200) + { + return new InvokeResponse(statusCode, new AdaptiveCardResponse + { + StatusCode = statusCode, + Type = AdaptiveCardResponseType.Card, + Value = card + }); + } +} + +/// +/// Builder for AdaptiveCardResponse. +/// +public class AdaptiveCardResponseBuilder +{ + private int _statusCode = 200; + private string? _type; + private object? _value; + + /// + /// + public AdaptiveCardResponseBuilder WithStatusCode(int statusCode) + { + _statusCode = statusCode; + return this; + } + + /// + /// Sets the type of the response. See for common values. + /// + public AdaptiveCardResponseBuilder WithType(string type) + { + _type = type; + return this; + } + + /// + /// Sets the value for the response. + /// + public AdaptiveCardResponseBuilder WithValue(object value) + { + _value = value; + return this; + } + + /// + /// Builds the AdaptiveCardResponse and wraps it in a InvokeResponse. + /// + public InvokeResponse Build() + { + return new InvokeResponse(_statusCode, new AdaptiveCardResponse + { + StatusCode = _statusCode, + Type = _type, + Value = _value + }); + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/FileConsentValue.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/FileConsentValue.cs new file mode 100644 index 00000000..c7bc3a76 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/FileConsentValue.cs @@ -0,0 +1,74 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Represents the value of the invoke activity sent when the user acts on a +/// file consent card. +/// +public class FileConsentValue +{ + /// + /// The type of file consent activity. Typically "fileUpload". + /// + [JsonPropertyName("type")] + public string? Type { get; set; } + + /// + /// The action the user took. Possible values: 'accept', 'decline'. + /// + [JsonPropertyName("action")] + public string? Action { get; set; } + + /// + /// The context associated with the action. + /// + [JsonPropertyName("context")] + public object? Context { get; set; } + + /// + /// If the user accepted the file, + /// contains information about the file to be uploaded. + /// + [JsonPropertyName("uploadInfo")] + public FileUploadInfo? UploadInfo { get; set; } +} + +/// +/// File upload info for accepted file consent. +/// +public class FileUploadInfo +{ + /// + /// Name of the file. + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// + /// URL to upload file content. + /// + [JsonPropertyName("uploadUrl")] + public Uri? UploadUrl { get; set; } + + /// + /// URL to file content after upload. + /// + [JsonPropertyName("contentUrl")] + public Uri? ContentUrl { get; set; } + + /// + /// Unique ID for the file. + /// + [JsonPropertyName("uniqueId")] + public string? UniqueId { get; set; } + + /// + /// Type of the file. + /// + [JsonPropertyName("fileType")] + public string? FileType { get; set; } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/InvokeResponse.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/InvokeResponse.cs new file mode 100644 index 00000000..22d1fa78 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/InvokeResponse.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + + +/// +/// Represents the response returned from an invocation handler, typically used for Adaptive Card actions and task module operations. +/// +/// +/// This class encapsulates the HTTP-style response sent back to Teams when handling invoke activities. +/// Common status codes include 200 for success, 400 for bad request, and 500 for errors. +/// The Body property contains the response payload, which is serialized to JSON and returned to the client. +/// +/// The HTTP status code indicating the result of the invoke operation (e.g., 200 for success). +/// Optional response payload that will be serialized and sent to the client. +public class InvokeResponse(int status, object? body = null) +{ + /// + /// Status code of the response. + /// + [JsonPropertyName("status")] + public int Status { get; set; } = status; + + /// + /// Gets or sets the response body. + /// + [JsonPropertyName("value")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public object? Body { get; set; } = body; +} + +/// +/// Represents a strongly-typed response returned from an invocation handler. +/// +/// +/// The strongly-typed Body property provides compile-time type safety while maintaining a single storage location +/// through the base class. Both the typed and untyped Body properties access the same underlying body. +/// +/// The type of the response body. +/// The HTTP status code indicating the result of the invoke operation (e.g., 200 for success). +/// Optional strongly-typed response payload that will be serialized and sent to the client. +public class InvokeResponse(int status, TBody? body = default) : InvokeResponse(status, body) where TBody : notnull +{ + /// + /// Gets or sets the strongly-typed response body. + /// This property shadows the base class Body property but uses the same underlying storage, + /// ensuring no synchronization issues between typed and untyped access. + /// + public new TBody? Body + { + get => (TBody?)base.Body; + set => base.Body = value; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionAction.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionAction.cs new file mode 100644 index 00000000..39b070bf --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionAction.cs @@ -0,0 +1,345 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Message extension command context values. +/// +public static class MessageExtensionCommandContext +{ + /// + /// Command invoked from a message (message action). + /// + public const string Message = "message"; + + /// + /// Command invoked from the compose box. + /// + public const string Compose = "compose"; + + /// + /// Command invoked from the command box. + /// + public const string CommandBox = "commandbox"; +} + +/// +/// Bot message preview action values. +/// +public static class BotMessagePreviewAction +{ + /// + /// User clicked edit on the preview. + /// + public const string Edit = "edit"; + + /// + /// User clicked send on the preview. + /// + public const string Send = "send"; +} + +/// +/// Context information for message extension actions. +/// +public class MessageExtensionContext +{ + /// + /// The theme of the Teams client. Common values: "default", "dark", "contrast". + /// + [JsonPropertyName("theme")] + public string? Theme { get; set; } +} + +/// +/// Message extension action payload for submit action and fetch task activities. +/// +public class MessageExtensionAction +{ + /// + /// Id of the command assigned by the bot. + /// + [JsonPropertyName("commandId")] + public required string CommandId { get; set; } + + /// + /// The context from which the command originates. + /// See for common values. + /// + [JsonPropertyName("commandContext")] + public required string CommandContext { get; set; } + + /// + /// Bot message preview action taken by user. + /// See for common values. + /// + [JsonPropertyName("botMessagePreviewAction")] + public string? BotMessagePreviewAction { get; set; } + + /// + /// The activity preview that was originally sent to Teams when showing the bot message preview. + /// This is sent back by Teams when the user clicks 'edit' or 'send' on the preview. + /// + // TODO : this needs to be activity type or something else - format is type, attachments[] + [JsonPropertyName("botActivityPreview")] + public IList? BotActivityPreview { get; set; } + + /// + /// Data included with the submit action. + /// + [JsonPropertyName("data")] + public object? Data { get; set; } + + /// + /// Message content sent as part of the command request when the command is invoked from a message. + /// + [JsonPropertyName("messagePayload")] + public MessagePayload? MessagePayload { get; set; } + + /// + /// Context information for the action. + /// + [JsonPropertyName("context")] + public MessageExtensionContext? Context { get; set; } +} + +/// +/// Represents the individual message within a chat or channel where a message +/// action is taken. +/// +public class MessagePayload +{ + /// + /// Unique id of the message. + /// + [JsonPropertyName("id")] + public required string Id { get; set; } + + /// + /// Timestamp of when the message was created. + /// + [JsonPropertyName("createdDateTime")] + public string? CreatedDateTime { get; set; } + + /// + /// Indicates whether a message has been soft deleted. + /// + [JsonPropertyName("deleted")] + public bool? Deleted { get; set; } + + /// + /// Subject line of the message. + /// + [JsonPropertyName("subject")] + public string? Subject { get; set; } + + /// + /// The importance of the message. + /// + /// + /// See for common values. + /// + [JsonPropertyName("importance")] + public string? Importance { get; set; } + + /// + /// Locale of the message set by the client. + /// + [JsonPropertyName("locale")] + public string? Locale { get; set; } + + /// + /// Link back to the message. + /// + [JsonPropertyName("linkToMessage")] + public string? LinkToMessage { get; set; } + + /// + /// Sender of the message. + /// + [JsonPropertyName("from")] + public MessageFrom? From { get; set; } + + /// + /// Plaintext/HTML representation of the content of the message. + /// + [JsonPropertyName("body")] + public MessagePayloadBody? Body { get; set; } + + /// + /// How the attachment(s) are displayed in the message. + /// + [JsonPropertyName("attachmentLayout")] + public string? AttachmentLayout { get; set; } + + /// + /// Attachments in the message - card, image, file, etc. + /// + [JsonPropertyName("attachments")] + public IList? Attachments { get; set; } + + /// + /// List of entities mentioned in the message. + /// + [JsonPropertyName("mentions")] + public IList? Mentions { get; set; } + + /// + /// Reactions for the message. + /// + [JsonPropertyName("reactions")] + public IList? Reactions { get; set; } +} + +/// +/// Sender of the message. +/// +public class MessageFrom +{ + /// + /// User information of the sender. + /// + [JsonPropertyName("user")] + public User? User { get; set; } +} + +/// +/// String constants for message importance levels. +/// +public static class MessagePayloadImportance +{ + /// + /// Normal importance. + /// + public const string Normal = "normal"; + + /// + /// High importance. + /// + public const string High = "high"; + + /// + /// Urgent importance. + /// + public const string Urgent = "urgent"; +} + +/// +/// Message body content. +/// +public class MessagePayloadBody +{ + /// + /// Type of content. Common values: "text", "html". + /// + [JsonPropertyName("contentType")] + public string? ContentType { get; set; } + + /// + /// The content of the message. + /// + [JsonPropertyName("content")] + public string? Content { get; set; } +} + +/// +/// Attachment in a message payload. +/// +public class MessagePayloadAttachment +{ + /// + /// Unique identifier for the attachment. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Type of attachment content. See for common values. + /// + [JsonPropertyName("contentType")] + public string? ContentType { get; set; } + + /// + /// The attachment content. + /// + [JsonPropertyName("content")] + public object? Content { get; set; } +} + +/// +/// Reaction to a message. +/// +public class MessagePayloadReaction +{ + /// + /// Type of reaction + /// See for common values. + /// + [JsonPropertyName("reactionType")] + public string? ReactionType { get; set; } + + /// + /// Timestamp when the reaction was created. + /// + [JsonPropertyName("createdDateTime")] + public string? CreatedDateTime { get; set; } + + /// + /// User who reacted. + /// + [JsonPropertyName("user")] + public User? User { get; set; } +} + +/// +/// Represents a user who created a reaction. +/// +public class User +{ + /// + /// Gets or sets the user identifier. + /// + [JsonPropertyName("id")] + public string? Id { get; set; } + + /// + /// Gets or sets the user identity type. + /// + [JsonPropertyName("userIdentityType")] + public string? UserIdentityType { get; set; } + + /// + /// Gets or sets the display name of the user. + /// + [JsonPropertyName("displayName")] + public string? DisplayName { get; set; } +} + +/// +/// String constants for user identity types. +/// +public static class UserIdentityTypes +{ + /// + /// Azure Active Directory user. + /// + public const string AadUser = "aadUser"; + + /// + /// On-premise Azure Active Directory user. + /// + public const string OnPremiseAadUser = "onPremiseAadUser"; + + /// + /// Anonymous guest user. + /// + public const string AnonymousGuest = "anonymousGuest"; + + /// + /// Federated user. + /// + public const string FederatedUser = "federatedUser"; +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionActionResponse.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionActionResponse.cs new file mode 100644 index 00000000..cd3a50a7 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionActionResponse.cs @@ -0,0 +1,94 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Represents a response from a message extension action that can contain either a task module or compose extension response. +/// +public class MessageExtensionActionResponse +{ + /// + /// The task module result. + /// + [JsonPropertyName("task")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public Response? Task { get; set; } + + /// + /// The compose extension result (for message extension results, auth, config, etc.). + /// + [JsonPropertyName("composeExtension")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public ComposeExtension? ComposeExtension { get; set; } + + /// + /// Creates a new builder for MessageExtensionActionResponse. + /// + public static MessageExtensionActionResponseBuilder CreateBuilder() + { + return new MessageExtensionActionResponseBuilder(); + } +} + +/// +/// Builder for MessageExtensionActionResponse. +/// +public class MessageExtensionActionResponseBuilder +{ + private TaskModuleResponse? _taskResponse; + private MessageExtensionResponse? _extensionResponse; + + /// + /// Sets the task module response using a TaskModuleResponseBuilder. + /// + public MessageExtensionActionResponseBuilder WithTask(TaskModuleResponseBuilder builder) + { + ArgumentNullException.ThrowIfNull(builder); + _taskResponse = builder.Validate(); + return this; + } + + /// + /// Sets the compose extension response using a MessageExtensionResponseBuilder. + /// + public MessageExtensionActionResponseBuilder WithComposeExtension(MessageExtensionResponseBuilder builder) + { + ArgumentNullException.ThrowIfNull(builder); + _extensionResponse = builder.Validate(); + return this; + } + + /// + /// Validates and builds the MessageExtensionActionResponse. + /// + private MessageExtensionActionResponse Validate() + { + if (_taskResponse == null && _extensionResponse == null) + { + throw new InvalidOperationException("Either Task or ComposeExtension must be set. Use WithTask() or WithComposeExtension()."); + } + + if (_taskResponse != null && _extensionResponse != null) + { + throw new InvalidOperationException("Cannot set both Task and ComposeExtension. Use either WithTask() or WithComposeExtension(), not both."); + } + + return new MessageExtensionActionResponse + { + Task = _taskResponse?.Task, + ComposeExtension = _extensionResponse?.ComposeExtension + }; + } + + /// + /// Builds the MessageExtensionActionResponse and wraps it in a InvokeResponse. + /// + /// The HTTP status code (default: 200). + public InvokeResponse Build(int statusCode = 200) + { + return new InvokeResponse(statusCode, Validate()); + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionQuery.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionQuery.cs new file mode 100644 index 00000000..7da6685c --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionQuery.cs @@ -0,0 +1,77 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Messaging extension query payload. +/// +public class MessageExtensionQuery +{ + /// + /// Id of the command assigned by the bot. + /// + [JsonPropertyName("commandId")] + public required string CommandId { get; set; } + + /// + /// Parameters for the query. + /// + [JsonPropertyName("parameters")] + public required IList Parameters { get; set; } + + /// + /// Query options for pagination. + /// + [JsonPropertyName("queryOptions")] + public QueryOptions? QueryOptions { get; set; } + + //TODO : check how to use this ? auth ? + /* + /// + /// State parameter passed back to the bot after authentication/configuration flow. + /// + [JsonPropertyName("state")] + public string? State { get; set; } + */ +} + +/// +/// Query parameter. +/// +public class QueryParameter +{ + /// + /// Name of the parameter. + /// + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// + /// Value of the parameter. + /// + [JsonPropertyName("value")] + public required string Value { get; set; } +} + + +/// +/// Query options for pagination. +/// +public class QueryOptions +{ + /// + /// Number of entities to skip. + /// + [JsonPropertyName("skip")] + public int? Skip { get; set; } + + /// + /// Number of entities to fetch. + /// + [JsonPropertyName("count")] + public int? Count { get; set; } +} + diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionQueryLink.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionQueryLink.cs new file mode 100644 index 00000000..78e2871a --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionQueryLink.cs @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// App-based query link payload for link unfurling. +/// +public class MessageExtensionQueryLink +{ + /// + /// URL queried by user. + /// + [JsonPropertyName("url")] + public Uri? Url { get; set; } + + //TODO : review + /* + /// + /// State parameter for OAuth flow. + /// + [JsonPropertyName("state")] + public string? State { get; set; } + */ +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionResponse.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionResponse.cs new file mode 100644 index 00000000..2924d2fc --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/MessageExtensionResponse.cs @@ -0,0 +1,359 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Messaging extension response types. +/// +public static class MessageExtensionResponseType +{ + /// + /// Result type - displays a list of search results. + /// + public const string Result = "result"; + + /// + /// Message type - displays a plain text message. + /// + public const string Message = "message"; + + /// + /// Bot message preview type - shows a preview that can be edited before sending. + /// + public const string BotMessagePreview = "botMessagePreview"; + + /// + /// Config type - prompts the user to set up the message extension. + /// + public const string Config = "config"; + + //TODO : review + /* + /// + /// Auth type - prompts the user to authenticate. + /// + public const string Auth = "auth"; + */ +} + +/// +/// Messaging extension response wrapper. +/// +public class MessageExtensionResponse +{ + /// + /// The compose extension result (for message extension results, auth, config, etc.). + /// + [JsonPropertyName("composeExtension")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public ComposeExtension? ComposeExtension { get; set; } + + /// + /// Creates a new builder for MessagingExtensionResponse. + /// + public static MessageExtensionResponseBuilder CreateBuilder() + { + return new MessageExtensionResponseBuilder(); + } +} + + +/// +/// Messaging extension result. +/// +public class ComposeExtension +{ + /// + /// Type of result. + /// See for common values. + /// + [JsonPropertyName("type")] + public string? Type { get; set; } + + /// + /// Layout for attachments. + /// See for common values. + /// + [JsonPropertyName("attachmentLayout")] + public string? AttachmentLayout { get; set; } + + /// + /// Array of attachments (cards) to display. + /// + // TODO : there is an extra preview field but when is it used ? + [JsonPropertyName("attachments")] + public IList? Attachments { get; set; } + + /// + /// Text to display. + /// + [JsonPropertyName("text")] + public string? Text { get; set; } + + /// + /// Activity preview for bot message preview. + /// + //TODO : this needs to be activity type or something else - format is type, attachments[] + [JsonPropertyName("activityPreview")] + public TeamsActivity? ActivityPreview { get; set; } + + /// + /// Suggested actions for config type. + /// + [JsonPropertyName("suggestedActions")] + public MessageExtensionSuggestedAction? SuggestedActions { get; set; } +} + +/// +/// Suggested actions for messaging extension configuration. +/// +public class MessageExtensionSuggestedAction +{ + //TODO : this should come from cards package + + /// + /// Array of actions. + /// + [JsonPropertyName("actions")] + public IList? Actions { get; set; } +} + + +/// +/// Builder for MessagingExtensionResponse. +/// +public class MessageExtensionResponseBuilder +{ + private string? _type; + private string? _attachmentLayout; + private TeamsAttachment[]? _attachments; + private TeamsActivity? _activityPreview; + private object[]? _suggestedActions; + private string? _text; + + /// + /// Sets the type of the response. Common values: "result", "auth", "config", "message", "botMessagePreview". + /// + public MessageExtensionResponseBuilder WithType(string type) + { + _type = type; + return this; + } + + /// + /// Sets the attachment layout. Common values: "list", "grid". + /// + public MessageExtensionResponseBuilder WithAttachmentLayout(string layout) + { + _attachmentLayout = layout; + return this; + } + + /// + /// Sets the attachments for the response. + /// + public MessageExtensionResponseBuilder WithAttachments(params TeamsAttachment[] attachments) + { + _attachments = attachments; + return this; + } + + /// + /// Sets the activity preview for bot message preview type. + /// + public MessageExtensionResponseBuilder WithActivityPreview(TeamsActivity activityPreview) + { + _activityPreview = activityPreview; + return this; + } + + /// + /// Sets suggested actions for config type. + /// + public MessageExtensionResponseBuilder WithSuggestedActions(params object[] actions) + { + _suggestedActions = actions; + return this; + } + + /// + /// Sets the text message for message type. + /// + public MessageExtensionResponseBuilder WithText(string text) + { + _text = text; + return this; + } + + /// + /// Validates and builds the MessagingExtensionResponse. + /// + internal MessageExtensionResponse Validate() + { + if (string.IsNullOrEmpty(_type)) + { + throw new InvalidOperationException("Type must be set. Use WithType() to specify MessageExtensionResponseType.Result, Message, BotMessagePreview, or Config."); + } + + return _type switch + { + MessageExtensionResponseType.Result => ValidateResultType(), + MessageExtensionResponseType.Message => ValidateMessageType(), + MessageExtensionResponseType.BotMessagePreview => ValidateBotMessagePreviewType(), + MessageExtensionResponseType.Config => ValidateConfigType(), + _ => throw new InvalidOperationException($"Unknown message extension response type: {_type}") + }; + } + + private MessageExtensionResponse ValidateResultType() + { + if (_attachments == null || _attachments.Length == 0) + { + throw new InvalidOperationException("Attachments must be set for Result type. Use WithAttachments()."); + } + + if (!string.IsNullOrEmpty(_text)) + { + throw new InvalidOperationException("Text cannot be set for Result type. Text is only used with Message type."); + } + + if (_activityPreview != null) + { + throw new InvalidOperationException("ActivityPreview cannot be set for Result type. ActivityPreview is only used with BotMessagePreview type."); + } + + if (_suggestedActions != null) + { + throw new InvalidOperationException("SuggestedActions cannot be set for Result type. SuggestedActions is only used with Config type."); + } + + return new MessageExtensionResponse + { + ComposeExtension = new ComposeExtension + { + Type = _type, + AttachmentLayout = _attachmentLayout, + Attachments = _attachments + } + }; + } + + private MessageExtensionResponse ValidateMessageType() + { + if (string.IsNullOrEmpty(_text)) + { + throw new InvalidOperationException("Text must be set for Message type. Use WithText()."); + } + + if (_attachments != null) + { + throw new InvalidOperationException("Attachments cannot be set for Message type. Attachments is only used with Result or BotMessagePreview type."); + } + + if (!string.IsNullOrEmpty(_attachmentLayout)) + { + throw new InvalidOperationException("AttachmentLayout cannot be set for Message type. AttachmentLayout is only used with Result type."); + } + + if (_activityPreview != null) + { + throw new InvalidOperationException("ActivityPreview cannot be set for Message type. ActivityPreview is only used with BotMessagePreview type."); + } + + if (_suggestedActions != null) + { + throw new InvalidOperationException("SuggestedActions cannot be set for Message type. SuggestedActions is only used with Config type."); + } + + return new MessageExtensionResponse + { + ComposeExtension = new ComposeExtension + { + Type = _type, + Text = _text + } + }; + } + + private MessageExtensionResponse ValidateBotMessagePreviewType() + { + if (_activityPreview == null) + { + throw new InvalidOperationException("ActivityPreview must be set for BotMessagePreview type. Use WithActivityPreview()."); + } + + if (!string.IsNullOrEmpty(_text)) + { + throw new InvalidOperationException("Text cannot be set for BotMessagePreview type. Text is only used with Message type."); + } + + if (!string.IsNullOrEmpty(_attachmentLayout)) + { + throw new InvalidOperationException("AttachmentLayout cannot be set for BotMessagePreview type. AttachmentLayout is only used with Result type."); + } + + if (_suggestedActions != null) + { + throw new InvalidOperationException("SuggestedActions cannot be set for BotMessagePreview type. SuggestedActions is only used with Config type."); + } + + return new MessageExtensionResponse + { + ComposeExtension = new ComposeExtension + { + Type = _type, + ActivityPreview = _activityPreview, + Attachments = _attachments + } + }; + } + + private MessageExtensionResponse ValidateConfigType() + { + if (_suggestedActions == null || _suggestedActions.Length == 0) + { + throw new InvalidOperationException("SuggestedActions must be set for Config type. Use WithSuggestedActions()."); + } + + if (_attachments != null) + { + throw new InvalidOperationException("Attachments cannot be set for Config type. Attachments is only used with Result or BotMessagePreview type."); + } + + if (!string.IsNullOrEmpty(_attachmentLayout)) + { + throw new InvalidOperationException("AttachmentLayout cannot be set for Config type. AttachmentLayout is only used with Result type."); + } + + if (!string.IsNullOrEmpty(_text)) + { + throw new InvalidOperationException("Text cannot be set for Config type. Text is only used with Message type."); + } + + if (_activityPreview != null) + { + throw new InvalidOperationException("ActivityPreview cannot be set for Config type. ActivityPreview is only used with BotMessagePreview type."); + } + + return new MessageExtensionResponse + { + ComposeExtension = new ComposeExtension + { + Type = _type, + SuggestedActions = new MessageExtensionSuggestedAction { Actions = _suggestedActions } + } + }; + } + + /// + /// Builds the MessagingExtensionResponse and wraps it in a InvokeResponse. + /// + /// The HTTP status code (default: 200). + public InvokeResponse Build(int statusCode = 200) + { + return new InvokeResponse(statusCode, Validate()); + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleRequest.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleRequest.cs new file mode 100644 index 00000000..d0941b8d --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleRequest.cs @@ -0,0 +1,36 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Task module invoke request value payload. +/// +public class TaskModuleRequest +{ + /// + /// User input data. Free payload with key-value pairs. + /// + [JsonPropertyName("data")] + public object? Data { get; set; } + + /// + /// Current user context, i.e., the current theme. + /// + [JsonPropertyName("context")] + public TaskModuleRequestContext? Context { get; set; } +} + +/// +/// Current user context, i.e., the current theme. +/// +public class TaskModuleRequestContext +{ + /// + /// The user's current theme. + /// + [JsonPropertyName("theme")] + public string? Theme { get; set; } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleResponse.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleResponse.cs new file mode 100644 index 00000000..2fcecc55 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleResponse.cs @@ -0,0 +1,260 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Task module response types. +/// +public static class TaskModuleResponseType +{ + /// + /// Continue type - displays a card or URL in the task module. + /// + public const string Continue = "continue"; + + /// + /// Message type - displays a plain text message. + /// + public const string Message = "message"; +} + +/// +/// Task module size constants. +/// +public static class TaskModuleSize +{ + /// + /// Small size. + /// + public const string Small = "small"; + + /// + /// Medium size. + /// + public const string Medium = "medium"; + + /// + /// Large size. + /// + public const string Large = "large"; +} + +/// +/// Task module response wrapper. +/// +public class TaskModuleResponse +{ + /// + /// The task module result. + /// + [JsonPropertyName("task")] + public Response? Task { get; set; } + + /// + /// Creates a new builder for TaskModuleResponse. + /// + public static TaskModuleResponseBuilder CreateBuilder() + { + return new TaskModuleResponseBuilder(); + } +} + +/// +/// Builder for TaskModuleResponse. +/// +public class TaskModuleResponseBuilder +{ + private string? _type; + private string? _title; + private object? _card; + private object _height = TaskModuleSize.Small; + private object _width = TaskModuleSize.Small; + private string? _message; + //private string? _url; + //private string? _fallbackUrl; + //private string? _completionBotId; + + /// + /// Sets the type of the response. Use TaskModuleResponseType constants. + /// + public TaskModuleResponseBuilder WithType(string type) + { + _type = type; + return this; + } + + /// + /// Sets the title of the task module. + /// + public TaskModuleResponseBuilder WithTitle(string title) + { + _title = title; + return this; + } + + /// + /// Sets the card content for continue type. + /// + public TaskModuleResponseBuilder WithCard(object card) + { + _card = card; + return this; + } + + /// + /// Sets the height. Can be a number (pixels) or use TaskModuleSize constants. + /// + public TaskModuleResponseBuilder WithHeight(object height) + { + _height = height; + return this; + } + + /// + /// Sets the width. Can be a number (pixels) or use TaskModuleSize constants. + /// + public TaskModuleResponseBuilder WithWidth(object width) + { + _width = width; + return this; + } + + /// + /// Sets the message for message type. + /// + public TaskModuleResponseBuilder WithMessage(string message) + { + _message = message; + return this; + } + + /* + /// + /// Sets the URL for continue type. + /// + public TaskModuleResponseBuilder WithUrl(string url) + { + _url = url; + return this; + } + + /// + /// Sets the fallback URL if the card cannot be displayed. + /// + public TaskModuleResponseBuilder WithFallbackUrl(string fallbackUrl) + { + _fallbackUrl = fallbackUrl; + return this; + } + + /// + /// Sets the completion bot ID. + /// + public TaskModuleResponseBuilder WithCompletionBotId(string completionBotId) + { + _completionBotId = completionBotId; + return this; + } + */ + + /// + /// Builds the TaskModuleResponse. + /// + internal TaskModuleResponse Validate() + { + if (string.IsNullOrEmpty(_type)) + { + throw new InvalidOperationException("Type must be set. Use WithType() to specify TaskModuleResponseType.Continue or TaskModuleResponseType.Message."); + } + + object? value = _type switch + { + TaskModuleResponseType.Continue => ValidateContinueType(), + TaskModuleResponseType.Message => ValidateMessageType(), + _ => throw new InvalidOperationException($"Unknown task module response type: {_type}") + }; + + return new TaskModuleResponse + { + Task = new Response + { + Type = _type, + Value = value + } + }; + } + + private object ValidateContinueType() + { + if (_card == null) + { + throw new InvalidOperationException("Card must be set for Continue type. Use WithCard()."); + } + + if (!string.IsNullOrEmpty(_message)) + { + throw new InvalidOperationException("Message cannot be set for Continue type. Message is only used with Message type."); + } + + return new + { + title = _title, + height = _height, + width = _width, + card = _card, + //url = _url, + //fallbackUrl = _fallbackUrl, + //completionBotId = _completionBotId + }; + } + + private string ValidateMessageType() + { + if (string.IsNullOrEmpty(_message)) + { + throw new InvalidOperationException("Message must be set for Message type. Use WithMessage()."); + } + + if (!string.IsNullOrEmpty(_title)) + { + throw new InvalidOperationException("Title cannot be set for Message type. Title is only used with Continue type."); + } + + if (_card != null) + { + throw new InvalidOperationException("Card cannot be set for Message type. Card is only used with Continue type."); + } + + return _message; + } + + /// + /// Builds the TaskModuleResponse and wraps it in a InvokeResponse. + /// + /// The HTTP status code (default: 200). + public InvokeResponse Build(int statusCode = 200) + { + return new InvokeResponse(statusCode, Validate()); + } +} + +/// +/// Task module result. +/// +public class Response +{ + /// + /// Type of result. + /// + [JsonPropertyName("type")] + public required string Type { get; set; } + + /// + /// Value + /// + [JsonPropertyName("value")] + public object? Value { get; set; } +} \ No newline at end of file diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Team.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Team.cs index 3aa75215..8293525b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Team.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Team.cs @@ -3,46 +3,45 @@ using System.Text.Json.Serialization; -namespace Microsoft.Teams.Bot.Apps.Schema +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Represents a team, including its identity, group association, and membership details. +/// +public class Team { /// - /// Represents a team, including its identity, group association, and membership details. + /// Represents the unique identifier of the team. + /// + [JsonPropertyName("id")] public string? Id { get; set; } + + /// + /// Azure Active Directory (AAD) Group ID associated with the team. + /// + [JsonPropertyName("aadGroupId")] public string? AadGroupId { get; set; } + + /// + /// Gets or sets the unique identifier of the tenant associated with this entity. + /// + [JsonPropertyName("tenantId")] public string? TenantId { get; set; } + + /// + /// Gets or sets the type identifier for the object represented by this instance. + /// + [JsonPropertyName("type")] public string? Type { get; set; } + + /// + /// Gets or sets the name associated with the object. + /// + [JsonPropertyName("name")] public string? Name { get; set; } + + /// + /// Number of channels in the team. + /// + [JsonPropertyName("channelCount")] public int? ChannelCount { get; set; } + + /// + /// Number of members in the team. /// - public class Team - { - /// - /// Represents the unique identifier of the team. - /// - [JsonPropertyName("id")] public string? Id { get; set; } - - /// - /// Azure Active Directory (AAD) Group ID associated with the team. - /// - [JsonPropertyName("aadGroupId")] public string? AadGroupId { get; set; } - - /// - /// Gets or sets the unique identifier of the tenant associated with this entity. - /// - [JsonPropertyName("tenantId")] public string? TenantId { get; set; } - - /// - /// Gets or sets the type identifier for the object represented by this instance. - /// - [JsonPropertyName("type")] public string? Type { get; set; } - - /// - /// Gets or sets the name associated with the object. - /// - [JsonPropertyName("name")] public string? Name { get; set; } - - /// - /// Number of channels in the team. - /// - [JsonPropertyName("channelCount")] public int? ChannelCount { get; set; } - - /// - /// Number of members in the team. - /// - [JsonPropertyName("memberCount")] public int? MemberCount { get; set; } - } + [JsonPropertyName("memberCount")] public int? MemberCount { get; set; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs index 15300a1c..c306df6f 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs @@ -2,7 +2,7 @@ // Licensed under the MIT License. using System.Text.Json.Serialization; -using Microsoft.Teams.Bot.Apps.Schema.Entities; + using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema; @@ -28,13 +28,13 @@ public static TeamsActivity FromActivity(CoreActivity activity) /// /// Overrides the ToJson method to serialize the TeamsActivity object to a JSON string. - /// Uses the activity type serializer map to select the appropriate JSON type info. + /// Uses the appropriate JSON type info based on the activity type. /// /// A JSON string representation of the activity using the type-specific serializer. public override string ToJson() { - return TeamsActivityType.ActivitySerializerMap.TryGetValue(Type, out var serializer) - ? serializer(this) + return Type == TeamsActivityType.Message + ? ToJson(TeamsActivityJsonContext.Default.MessageActivity) : ToJson(TeamsActivityJsonContext.Default.TeamsActivity); // Fallback to base type } @@ -86,8 +86,8 @@ protected TeamsActivity(CoreActivity activity) : base(activity) /// internal TeamsActivity Rebase() { - base.Attachments = this.Attachments?.ToJsonArray(); - base.Entities = this.Entities?.ToJsonArray(); + base.Attachments = Attachments?.ToJsonArray(); + base.Entities = Entities?.ToJsonArray(); return this; } @@ -99,7 +99,7 @@ internal TeamsActivity Rebase() [JsonPropertyName("from")] public new TeamsConversationAccount From { - get => (base.From as TeamsConversationAccount) ?? new TeamsConversationAccount(base.From); + get => base.From as TeamsConversationAccount ?? new TeamsConversationAccount(base.From); set => base.From = value; } @@ -109,7 +109,7 @@ internal TeamsActivity Rebase() [JsonPropertyName("recipient")] public new TeamsConversationAccount Recipient { - get => (base.Recipient as TeamsConversationAccount) ?? new TeamsConversationAccount(base.Recipient); + get => base.Recipient as TeamsConversationAccount ?? new TeamsConversationAccount(base.Recipient); set => base.Recipient = value; } @@ -119,7 +119,7 @@ internal TeamsActivity Rebase() [JsonPropertyName("conversation")] public new TeamsConversation Conversation { - get => (base.Conversation as TeamsConversation) ?? new TeamsConversation(base.Conversation); + get => base.Conversation as TeamsConversation ?? new TeamsConversation(base.Conversation); set => base.Conversation = value; } @@ -143,6 +143,30 @@ internal TeamsActivity Rebase() /// [JsonPropertyName("attachments")] public new IList? Attachments { get; set; } + /// + /// UTC timestamp of when the activity was sent. + /// + [JsonPropertyName("timestamp")] + public string? Timestamp { get; set; } + + /// + /// Local timestamp of when the activity was sent, including timezone offset. + /// + [JsonPropertyName("localTimestamp")] + public string? LocalTimestamp { get; set; } + + /// + /// Locale of the activity set by the client (e.g., "en-US"). + /// + [JsonPropertyName("locale")] + public string? Locale { get; set; } + + /// + /// Local timezone of the client (e.g., "America/Los_Angeles"). + /// + [JsonPropertyName("localTimezone")] + public string? LocalTimezone { get; set; } + /// /// Adds an entity to the activity's Entities collection. /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs index b7853132..1c9d4223 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Apps.Schema.Entities; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs index d7271825..48e2487b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs @@ -3,8 +3,6 @@ using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; -using Microsoft.Teams.Bot.Apps.Schema.Entities; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; namespace Microsoft.Teams.Bot.Apps.Schema; @@ -19,7 +17,6 @@ namespace Microsoft.Teams.Bot.Apps.Schema; [JsonSerializable(typeof(CoreActivity))] [JsonSerializable(typeof(TeamsActivity))] [JsonSerializable(typeof(MessageActivity))] -[JsonSerializable(typeof(InvokeActivity))] [JsonSerializable(typeof(Entity))] [JsonSerializable(typeof(EntityList))] [JsonSerializable(typeof(MentionEntity))] diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs index 9994e503..4c855d52 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs @@ -1,9 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Apps.Schema.ConversationActivities; -using Microsoft.Teams.Bot.Apps.Schema.InstallActivities; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.Schema; @@ -66,23 +63,13 @@ public static class TeamsActivityType /// internal static readonly Dictionary> ActivityDeserializerMap = new() { - [TeamsActivityType.Message] = MessageActivity.FromActivity, - [TeamsActivityType.MessageReaction] = MessageReactionActivity.FromActivity, - [TeamsActivityType.MessageUpdate] = MessageUpdateActivity.FromActivity, - [TeamsActivityType.MessageDelete] = MessageDeleteActivity.FromActivity, - [TeamsActivityType.ConversationUpdate] = ConversationUpdateActivity.FromActivity, + [Message] = MessageActivity.FromActivity, + [MessageReaction] = MessageReactionActivity.FromActivity, + [MessageUpdate] = MessageUpdateActivity.FromActivity, + [MessageDelete] = MessageDeleteActivity.FromActivity, + [ConversationUpdate] = ConversationUpdateActivity.FromActivity, //[TeamsActivityType.EndOfConversation] = EndOfConversationActivity.FromActivity, - [TeamsActivityType.InstallationUpdate] = InstallUpdateActivity.FromActivity, - [TeamsActivityType.Invoke] = InvokeActivity.FromActivity, - }; - - /// - /// Registry of serialization functions for specialized activity instances. - /// Maps activity types to functions that serialize the activity using the appropriate JsonTypeInfo. - /// - internal static readonly Dictionary> ActivitySerializerMap = new() - { - [TeamsActivityType.Message] = activity => activity.ToJson(TeamsActivityJsonContext.Default.MessageActivity), - [TeamsActivityType.Invoke] = activity => activity.ToJson(TeamsActivityJsonContext.Default.InvokeActivity), + [InstallationUpdate] = InstallUpdateActivity.FromActivity, + [Invoke] = InvokeActivity.FromActivity, }; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs index 1746378c..929ef71a 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs @@ -8,6 +8,90 @@ namespace Microsoft.Teams.Bot.Apps.Schema; +/// +/// Teams attachment content types. +/// +public static class AttachmentContentType +{ + /// + /// Adaptive Card content type. + /// + public const string AdaptiveCard = "application/vnd.microsoft.card.adaptive"; + + /// + /// Hero Card content type. + /// + public const string HeroCard = "application/vnd.microsoft.card.hero"; + + /// + /// Thumbnail Card content type. + /// + public const string ThumbnailCard = "application/vnd.microsoft.card.thumbnail"; + + /// + /// Office 365 Connector Card content type. + /// + public const string O365ConnectorCard = "application/vnd.microsoft.teams.card.o365connector"; + + /// + /// File consent card content type. + /// + public const string FileConsentCard = "application/vnd.microsoft.teams.card.file.consent"; + + /// + /// File info card content type. + /// + public const string FileInfoCard = "application/vnd.microsoft.teams.card.file.info"; + + //TODO : verify these + /* + /// + /// Receipt Card content type. + /// + public const string ReceiptCard = "application/vnd.microsoft.card.receipt"; + + /// + /// Signin Card content type. + /// + public const string SigninCard = "application/vnd.microsoft.card.signin"; + + /// + /// Animation content type. + /// + public const string Animation = "application/vnd.microsoft.card.animation"; + + /// + /// Audio content type. + /// + public const string Audio = "application/vnd.microsoft.card.audio"; + + /// + /// Video content type. + /// + public const string Video = "application/vnd.microsoft.card.video"; + */ +} + +/// +/// Attachment layout types. +/// +public static class TeamsAttachmentLayout +{ + /// + /// List layout - displays attachments in a vertical list. + /// + public const string List = "list"; + + /// + /// Grid layout - displays attachments in a grid. + /// + public const string Grid = "grid"; + + /// + /// Carousel layout - displays attachments in a horizontal carousel. + /// + public const string Carousel = "carousel"; +} /// /// Extension methods for TeamsAttachment. @@ -40,7 +124,7 @@ static internal IList FromJArray(JsonArray? jsonArray) List attachments = []; foreach (JsonNode? item in jsonArray) { - attachments.Add(JsonSerializer.Deserialize(item)!); + attachments.Add(item.Deserialize()!); } return attachments; } @@ -73,9 +157,7 @@ static internal IList FromJArray(JsonArray? jsonArray) /// /// Extension data for additional properties not explicitly defined by the type. /// -#pragma warning disable CA2227 // Collection properties should be read only [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; -#pragma warning restore CA2227 // Collection properties should be read only /// /// Creates a builder for constructing a instance. diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs index bcd50055..718cd73f 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs @@ -45,9 +45,7 @@ public class TeamsChannelDataSettings /// This property stores extra JSON fields encountered during deserialization that do not map to /// known properties. It enables round-tripping of unknown or custom data without loss. The dictionary keys /// correspond to the property names in the JSON payload. -#pragma warning disable CA2227 // Collection properties should be read only [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; -#pragma warning restore CA2227 // Collection properties should be read only } /// @@ -161,7 +159,7 @@ public TeamsChannelData(ChannelData? cd) [JsonPropertyName("tenant")] public TeamsChannelDataTenant? Tenant { get; set; } /// - /// Gets or sets the event type for conversation updates. See for known values. + /// Gets or sets the event type for conversation updates. See for known values. /// [JsonPropertyName("eventType")] public string? EventType { get; set; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs index e33d1eec..74fe3484 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs @@ -80,7 +80,7 @@ public TeamsConversation(Conversation conversation) [JsonPropertyName("tenantId")] public string? TenantId { get; set; } /// - /// Conversation Type. See for known values. + /// Conversation Type. See for known values. /// [JsonPropertyName("conversationType")] public string? ConversationType { get; set; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs index a91ed85e..b554efce 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsApiClient.Models.cs @@ -16,9 +16,7 @@ public class ChannelList /// Gets or sets the list of channel conversations. /// [JsonPropertyName("conversations")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? Channels { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only } /// @@ -90,7 +88,7 @@ public class MeetingInfo /// Gets or sets the organizer of the meeting. /// [JsonPropertyName("organizer")] - public Microsoft.Teams.Bot.Apps.Schema.TeamsConversationAccount? Organizer { get; set; } + public TeamsConversationAccount? Organizer { get; set; } } /// @@ -220,17 +218,13 @@ public class TargetedMeetingNotificationValue /// Gets or sets the list of recipients for the notification. /// [JsonPropertyName("recipients")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? Recipients { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only /// /// Gets or sets the surface configurations for the notification. /// [JsonPropertyName("surfaces")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? Surfaces { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only } /// @@ -266,9 +260,7 @@ public class MeetingNotificationResponse /// Gets or sets the list of recipients for whom the notification failed. /// [JsonPropertyName("recipientsFailureInfo")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? RecipientsFailureInfo { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only } /// @@ -398,9 +390,7 @@ public class BatchFailedEntriesResponse /// Gets or sets the list of failed entries. /// [JsonPropertyName("failedEntries")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? FailedEntries { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs index 99285853..00453a55 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs @@ -47,7 +47,6 @@ public static IServiceCollection AddTeamsBotApplication(this IServiceCollection sp.GetService>()); }); - services.AddSingleton(); services.AddBotApplication(); return services; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 60a8de90..50111fc8 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -5,9 +5,9 @@ using Microsoft.Teams.Bot.Core; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; -using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Teams.Bot.Apps.Schema; namespace Microsoft.Teams.Bot.Apps; @@ -51,6 +51,7 @@ public TeamsBotApplication( Router = new Router(logger); OnActivity = async (activity, cancellationToken) => { + logger.LogInformation("New {Type} activity received.", activity.Type); TeamsActivity teamsActivity = TeamsActivity.FromActivity(activity); Context defaultContext = new(this, teamsActivity); @@ -60,12 +61,14 @@ public TeamsBotApplication( } else // invokes { - CoreInvokeResponse invokeResponse = await Router.DispatchWithReturnAsync(defaultContext, cancellationToken).ConfigureAwait(false); + InvokeResponse invokeResponse = await Router.DispatchWithReturnAsync(defaultContext, cancellationToken).ConfigureAwait(false); HttpContext? httpContext = httpContextAccessor.HttpContext; if (httpContext is not null && invokeResponse is not null) { httpContext.Response.StatusCode = invokeResponse.Status; - await httpContext.Response.WriteAsJsonAsync(invokeResponse, cancellationToken).ConfigureAwait(false); + logger.LogTrace("Sending invoke response with status {Status} and Body {Body}", invokeResponse.Status, invokeResponse.Body); + await httpContext.Response.WriteAsJsonAsync(invokeResponse.Body, cancellationToken).ConfigureAwait(false); + } } }; diff --git a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.Models.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.Models.cs index 72508267..4e794595 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.Models.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.Models.cs @@ -56,9 +56,7 @@ public class GetConversationsResponse /// Gets or sets the list of conversations. /// [JsonPropertyName("conversations")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? Conversations { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only } /// @@ -76,9 +74,7 @@ public class ConversationMembers /// Gets or sets the list of members in this conversation. /// [JsonPropertyName("members")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? Members { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only } /// @@ -102,9 +98,7 @@ public class ConversationParameters /// Gets or sets the list of members to add to the conversation. /// [JsonPropertyName("members")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? Members { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only /// /// Gets or sets the topic name for the conversation (if supported by the channel). @@ -170,9 +164,7 @@ public class PagedMembersResult /// Gets or sets the list of members in this page. /// [JsonPropertyName("members")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? Members { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only } /// @@ -184,9 +176,7 @@ public class Transcript /// Gets or sets the collection of activities that conforms to the Transcript schema. /// [JsonPropertyName("activities")] -#pragma warning disable CA2227 // Collection properties should be read only public IList? Activities { get; set; } -#pragma warning restore CA2227 // Collection properties should be read only } /// diff --git a/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs b/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs index 68ddd28b..532d5c9c 100644 --- a/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs @@ -22,3 +22,9 @@ Justification = "String URLs are used for consistency with existing API patterns", Scope = "namespaceanddescendants", Target = "~N:Microsoft.Teams.Bot.Core.Http")] + +[assembly: SuppressMessage("Usage", + "CA2227:Collection properties should be read only", + Justification = "", + Scope = "namespaceanddescendants", + Target = "~N:Microsoft.Teams.Bot.Core")] diff --git a/core/src/Microsoft.Teams.Bot.Core/Schema/ChannelData.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/ChannelData.cs index 680480bd..214c14a2 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Schema/ChannelData.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/ChannelData.cs @@ -17,7 +17,5 @@ public class ChannelData /// Gets the extension data dictionary for storing channel-specific properties. /// [JsonExtensionData] -#pragma warning disable CA2227 // Collection properties should be read only public ExtendedPropertiesDictionary Properties { get; set; } = []; -#pragma warning restore CA2227 // Collection properties should be read only } diff --git a/core/src/Microsoft.Teams.Bot.Core/Schema/Conversation.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/Conversation.cs index 59ef6d4f..b10a11ed 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Schema/Conversation.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/Conversation.cs @@ -18,7 +18,5 @@ public class Conversation() /// Gets the extension data dictionary for storing additional properties not defined in the schema. /// [JsonExtensionData] -#pragma warning disable CA2227 // Collection properties should be read only public ExtendedPropertiesDictionary Properties { get; set; } = []; -#pragma warning restore CA2227 // Collection properties should be read only } diff --git a/core/src/Microsoft.Teams.Bot.Core/Schema/ConversationAccount.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/ConversationAccount.cs index 232cc3a6..daac2813 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Schema/ConversationAccount.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/ConversationAccount.cs @@ -28,9 +28,7 @@ public class ConversationAccount() /// Gets the extension data dictionary for storing additional properties not defined in the schema. /// [JsonExtensionData] -#pragma warning disable CA2227 // Collection properties should be read only public ExtendedPropertiesDictionary Properties { get; set; } = []; -#pragma warning restore CA2227 // Collection properties should be read only /// /// Gets the agentic identity from the account properties. diff --git a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs index 1bd1a5b6..6ddd186e 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs @@ -68,7 +68,6 @@ public class CoreActivity /// /// Entities are structured objects that represent mentions, places, or other data. /// -#pragma warning disable CA2227 // Collection properties should be read only [JsonPropertyName("entities")] public JsonArray? Entities { get; set; } /// @@ -86,7 +85,6 @@ public class CoreActivity /// Gets the extension data dictionary for storing additional properties not defined in the schema. /// [JsonExtensionData] public ExtendedPropertiesDictionary Properties { get; set; } = []; -#pragma warning restore CA2227 // Collection properties should be read only /// /// Gets the default JSON serializer options used for serializing and deserializing activities. diff --git a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs index 2ee9e2c1..6f2c1a2e 100644 --- a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs +++ b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs @@ -5,7 +5,6 @@ namespace ABSTokenServiceClient { - [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1848:Use the LoggerMessage delegates", Justification = "")] internal class UserTokenCLIService(UserTokenClient userTokenClient, ILogger logger) : IHostedService { public Task StartAsync(CancellationToken cancellationToken) diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs index 56a76154..42fbaf9d 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs @@ -1,11 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.ConversationActivities; -using Microsoft.Teams.Bot.Apps.Schema.InstallActivities; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.UnitTests; diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs index fab4f714..406d3b99 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs @@ -1,15 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.Linq; -using System.Text; using System.Text.Json.Nodes; -using System.Threading.Tasks; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.UnitTests; diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs index 09993c38..1362a7ee 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs @@ -1,9 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.UnitTests; diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs index d8242c36..3d25944b 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs @@ -1,9 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.Entities; +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.UnitTests; diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs index 740f956f..99eea281 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs @@ -1,12 +1,8 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text.Json.Nodes; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Teams.Bot.Apps.Schema; -using Microsoft.Teams.Bot.Apps.Schema.Entities; -using Microsoft.Teams.Bot.Apps.Schema.MessageActivities; - +using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.UnitTests; public class TeamsActivityTests From 041831824005c99263ee3a4d48db07016843ecb1 Mon Sep 17 00:00:00 2001 From: Rido Date: Tue, 17 Feb 2026 16:32:20 -0800 Subject: [PATCH 58/69] Sample PA Bot with advanced DI, including multi hosting (#308) - Refactored `CompatAdapter` to take in the required objects instead of the service provider object, and then resolving them through it. - Introduce `KeyedBotAuthenticationHandler` which configures auth based on keyed configurations. Add MSAL configurations under a key, and use that the instantiate this object and viola! - Update incomming token validation to be based on keyed configurations as well. - As a consequence of the above changes, it is possible multiple keyed instances of `TeamsBotApplication` and `CompatAdapter` allowing for multiples apps to be hosted in a single process. - Introduce PABot and CompatProactive samples, that test out PA scenarios and proactive messaging scenarios, respectively. **Testing** - [x] PABot setup working - [x] PABot EchoBot working - [ ] PABot TeamsBot working - [ ] CompatProactive working - [x] Integration with PA codebase working --------- Co-authored-by: Kavin Singh --- core/core.slnx | 8 +- .../CompatProactive/CompatProactive.csproj | 20 +++ .../CompatProactive/ProactiveWorker.cs | 39 +++++ core/samples/CompatProactive/Program.cs | 13 ++ core/samples/CompatProactive/appsettings.json | 8 + core/samples/PABot/AdapterWithErrorHandler.cs | 66 +++++++ core/samples/PABot/Bots/DialogBot.cs | 84 +++++++++ core/samples/PABot/Bots/EchoBot.cs | 19 ++ core/samples/PABot/Bots/SsoBot.cs | 52 ++++++ core/samples/PABot/Bots/TeamsBot.cs | 66 +++++++ core/samples/PABot/Dialogs/LogoutDialog.cs | 105 +++++++++++ core/samples/PABot/Dialogs/MainDialog.cs | 165 ++++++++++++++++++ core/samples/PABot/InitCompatAdapter.cs | 110 ++++++++++++ core/samples/PABot/PABot.csproj | 18 ++ core/samples/PABot/PACustomAuthHandler.cs | 92 ++++++++++ core/samples/PABot/Program.cs | 63 +++++++ .../Properties/launchSettings.TEMPLATE.json | 26 +++ core/samples/PABot/SimpleGraphClient.cs | 165 ++++++++++++++++++ core/samples/PABot/appsettings.json | 2 + .../CompatAdapter.cs | 14 +- .../CompatBotAdapter.cs | 16 +- .../CompatHostingExtensions.cs | 2 +- .../KeyedBotAuthenticationHandler.cs | 131 ++++++++++++++ .../Hosting/JwtExtensions.cs | 6 +- .../CompatAdapterTests.cs | 10 +- 25 files changed, 1277 insertions(+), 23 deletions(-) create mode 100644 core/samples/CompatProactive/CompatProactive.csproj create mode 100644 core/samples/CompatProactive/ProactiveWorker.cs create mode 100644 core/samples/CompatProactive/Program.cs create mode 100644 core/samples/CompatProactive/appsettings.json create mode 100644 core/samples/PABot/AdapterWithErrorHandler.cs create mode 100644 core/samples/PABot/Bots/DialogBot.cs create mode 100644 core/samples/PABot/Bots/EchoBot.cs create mode 100644 core/samples/PABot/Bots/SsoBot.cs create mode 100644 core/samples/PABot/Bots/TeamsBot.cs create mode 100644 core/samples/PABot/Dialogs/LogoutDialog.cs create mode 100644 core/samples/PABot/Dialogs/MainDialog.cs create mode 100644 core/samples/PABot/InitCompatAdapter.cs create mode 100644 core/samples/PABot/PABot.csproj create mode 100644 core/samples/PABot/PACustomAuthHandler.cs create mode 100644 core/samples/PABot/Program.cs create mode 100644 core/samples/PABot/Properties/launchSettings.TEMPLATE.json create mode 100644 core/samples/PABot/SimpleGraphClient.cs create mode 100644 core/samples/PABot/appsettings.json create mode 100644 core/src/Microsoft.Teams.Bot.Compat/KeyedBotAuthenticationHandler.cs diff --git a/core/core.slnx b/core/core.slnx index 24c672d2..ff19b43d 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -13,6 +13,8 @@ + + @@ -32,12 +34,12 @@ - - + + + - diff --git a/core/samples/CompatProactive/CompatProactive.csproj b/core/samples/CompatProactive/CompatProactive.csproj new file mode 100644 index 00000000..e2d156f7 --- /dev/null +++ b/core/samples/CompatProactive/CompatProactive.csproj @@ -0,0 +1,20 @@ + + + + Exe + net8.0 + enable + false + enable + + + + + + + + + + + + diff --git a/core/samples/CompatProactive/ProactiveWorker.cs b/core/samples/CompatProactive/ProactiveWorker.cs new file mode 100644 index 00000000..180241e8 --- /dev/null +++ b/core/samples/CompatProactive/ProactiveWorker.cs @@ -0,0 +1,39 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Schema; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; +using Microsoft.Teams.Bot.Compat; + +namespace CompatProactive; + +internal class ProactiveWorker(IBotFrameworkHttpAdapter compatAdapter, ILogger logger) : BackgroundService +{ + protected override async Task ExecuteAsync(CancellationToken stoppingToken) + { + ConversationReference conversationReference = new() + { + ServiceUrl = "https://smba.trafficmanager.net/teams/", + Conversation = new() { Id = "19:ad37a1f8af5549e3b81edf249fe5cb1b@thread.tacv2" }, + }; + + await ((CompatAdapter)compatAdapter).ContinueConversationAsync("", conversationReference, callback, stoppingToken); + logger.LogInformation("Proactive message sent"); + } + + private async Task callback(ITurnContext turnContext, CancellationToken cancellationToken) + { + await turnContext.SendActivitiesAsync(new Activity[] + { + MessageFactory.Text($"Proactive with Compat Layer {DateTimeOffset.Now}") + }, cancellationToken); + } +} diff --git a/core/samples/CompatProactive/Program.cs b/core/samples/CompatProactive/Program.cs new file mode 100644 index 00000000..e1dd4499 --- /dev/null +++ b/core/samples/CompatProactive/Program.cs @@ -0,0 +1,13 @@ +using CompatProactive; +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; +using Microsoft.Teams.Bot.Compat; +using Microsoft.Teams.Bot.Core.Hosting; + + +HostApplicationBuilder builder = Host.CreateApplicationBuilder(args); +builder.Services.AddCompatAdapter(); +builder.Services.AddHostedService(); +IHost host = builder.Build(); +host.Run(); diff --git a/core/samples/CompatProactive/appsettings.json b/core/samples/CompatProactive/appsettings.json new file mode 100644 index 00000000..8a27e253 --- /dev/null +++ b/core/samples/CompatProactive/appsettings.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.Teams": "Trace" + } + } +} diff --git a/core/samples/PABot/AdapterWithErrorHandler.cs b/core/samples/PABot/AdapterWithErrorHandler.cs new file mode 100644 index 00000000..90d80f62 --- /dev/null +++ b/core/samples/PABot/AdapterWithErrorHandler.cs @@ -0,0 +1,66 @@ +// +// Copyright (c) Microsoft. All rights reserved. +// + +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Builder.Teams; +using Microsoft.Bot.Builder.TraceExtensions; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Compat; + +namespace PABot +{ + public class AdapterWithErrorHandler : CompatAdapter + { + public AdapterWithErrorHandler( + TeamsBotApplication teamsBotApp, + IHttpContextAccessor httpContextAccessor, + IConfiguration configuration, + ILogger logger, + IStorage storage, + ConversationState conversationState + ) + : base( + teamsBotApp, + httpContextAccessor, + logger) + { + base.Use(new TeamsSSOTokenExchangeMiddleware(storage, configuration["ConnectionName"] ?? "graph")); + + OnTurnError = async (turnContext, exception) => + { + // Log any leaked exception from the application. + // NOTE: In production environment, you should consider logging this to + // Azure Application Insights. Visit https://aka.ms/bottelemetry to see how + // to add telemetry capture to your bot. + logger.LogError(exception, $"[OnTurnError] unhandled error : {exception.Message}"); + + // Uncomment below commented line for local debugging.. + // await turnContext.SendActivityAsync($"Sorry, it looks like something went wrong. Exception Caught: {exception.Message}"); + + if (conversationState != null) + { + try + { + // Delete the conversationState for the current conversation to prevent the + // bot from getting stuck in a error-loop caused by being in a bad state. + // ConversationState should be thought of as similar to "cookie-state" in a Web pages. + await conversationState.DeleteAsync(turnContext); + } + catch (Exception e) + { + logger.LogError(e, $"Exception caught on attempting to Delete ConversationState : {e.Message}"); + } + } + + // Send a trace activity, which will be displayed in the Bot Framework Emulator + await turnContext.TraceActivityAsync( + "OnTurnError Trace", + exception.Message, + "https://www.botframework.com/schemas/error", + "TurnError"); + }; + } + } +} diff --git a/core/samples/PABot/Bots/DialogBot.cs b/core/samples/PABot/Bots/DialogBot.cs new file mode 100644 index 00000000..89052cf3 --- /dev/null +++ b/core/samples/PABot/Bots/DialogBot.cs @@ -0,0 +1,84 @@ +// +// Copyright (c) Microsoft. All rights reserved. +// + +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Dialogs; +using Microsoft.Bot.Builder.Teams; +using Microsoft.Bot.Schema; +using Microsoft.Extensions.Logging; + +namespace PABot.Bots +{ + /// + /// This IBot implementation can run any type of Dialog. The use of type parameterization allows multiple different bots + /// to be run at different endpoints within the same project. This can be achieved by defining distinct Controller types + /// each with dependency on distinct IBot types, this way ASP Dependency Injection can glue everything together without ambiguity. + /// The ConversationState is used by the Dialog system. The UserState isn't, however, it might have been used in a Dialog implementation, + /// and the requirement is that all BotState objects are saved at the end of a turn. + /// + /// The type of the dialog. + public class DialogBot : TeamsActivityHandler where T : Dialog + { + protected readonly BotState _conversationState; + protected readonly Dialog _dialog; + protected readonly ILogger _logger; + protected readonly BotState _userState; + + /// + /// Initializes a new instance of the class. + /// + /// The conversation state. + /// The user state. + /// The dialog. + /// The logger. + public DialogBot(ConversationState conversationState, UserState userState, T dialog, ILogger> logger) + { + _conversationState = conversationState; + _userState = userState; + _dialog = dialog; + _logger = logger; + } + + /// + /// Handles an incoming activity. + /// + /// Context object containing information cached for a single turn of conversation with a user. + /// Propagates notification that operations should be canceled. + /// A task that represents the work queued to execute. + /// + /// Reference link: https://docs.microsoft.com/en-us/dotnet/api/microsoft.bot.builder.activityhandler.onturnasync?view=botbuilder-dotnet-stable. + /// + public override async Task OnTurnAsync( + ITurnContext turnContext, + CancellationToken cancellationToken = default(CancellationToken)) + { + await base.OnTurnAsync(turnContext, cancellationToken); + + // Save any state changes that might have occurred during the turn. + await _conversationState.SaveChangesAsync(turnContext, false, cancellationToken); + await _userState.SaveChangesAsync(turnContext, false, cancellationToken); + } + + /// + /// Handles when a message is addressed to the bot. + /// + /// Context object containing information cached for a single turn of conversation with a user. + /// Propagates notification that operations should be canceled. + /// A Task resolving to either a login card or the adaptive card of the Reddit post. + /// + /// For more information on bot messaging in Teams, see the documentation + /// https://docs.microsoft.com/en-us/microsoftteams/platform/bots/how-to/conversations/conversation-basics?tabs=dotnet#receive-a-message. + /// + protected override async Task OnMessageActivityAsync( + ITurnContext turnContext, + CancellationToken cancellationToken) + { + _logger.LogInformation("Running dialog with Message Activity."); + + await _dialog.RunAsync(turnContext, _conversationState.CreateProperty(nameof(DialogState)), cancellationToken); + } + } +} \ No newline at end of file diff --git a/core/samples/PABot/Bots/EchoBot.cs b/core/samples/PABot/Bots/EchoBot.cs new file mode 100644 index 00000000..a0ee8747 --- /dev/null +++ b/core/samples/PABot/Bots/EchoBot.cs @@ -0,0 +1,19 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Builder; +using Microsoft.Bot.Schema; + +namespace PABot.Bots +{ + public class EchoBot : ActivityHandler + { + protected override async Task OnMessageActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) + { + await turnContext.SendActivityAsync(MessageFactory.Text($"Echo: {turnContext.Activity.Text}"), cancellationToken); + } + } +} diff --git a/core/samples/PABot/Bots/SsoBot.cs b/core/samples/PABot/Bots/SsoBot.cs new file mode 100644 index 00000000..9c1fb6aa --- /dev/null +++ b/core/samples/PABot/Bots/SsoBot.cs @@ -0,0 +1,52 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Bot.Builder; +using Microsoft.Bot.Connector.Authentication; +using Microsoft.Bot.Schema; +using Newtonsoft.Json; + +namespace PABot.Bots +{ + public class SsoBot(ILogger logger) : ActivityHandler + { + protected override async Task OnMessageActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) + { + await turnContext.SendActivityAsync(MessageFactory.Text($"Echo: {turnContext.Activity.Text}"), cancellationToken); + + UserTokenClient utc = turnContext.TurnState.Get(); + + TokenStatus[] tokenStatus = await utc.GetTokenStatusAsync(turnContext.Activity.From.Id, turnContext.Activity.ChannelId, string.Empty, cancellationToken); + + logger.LogInformation("Token status count"); + //logger.LogInformation(JsonConvert.SerializeObject(tokenStatus)); + await turnContext.SendActivityAsync($"Token status count: {tokenStatus.Length}"); + + foreach (var ts in tokenStatus) + { + if (ts.HasToken == true) + { + var tokenResponse = await utc.GetUserTokenAsync(turnContext.Activity.From.Id, turnContext.Activity.ChannelId, ts.ConnectionName, null, cancellationToken); + //logger.LogInformation("Token for connection '{ConnectionName}': {Token}", ts.ConnectionName, tokenResponse?.Token); + await turnContext.SendActivityAsync(MessageFactory.Text($"Token for connection '{ts.ConnectionName}': {tokenResponse?.Token}"), cancellationToken); + } + else + { + //logger.LogInformation("No token for connection '{ConnectionName}'", ts.ConnectionName); + await turnContext.SendActivityAsync(MessageFactory.Text($"No token for connection '{ts.ConnectionName}'"), cancellationToken); + + Activity? a = turnContext.Activity as Activity; + var signInResource = await utc.GetSignInResourceAsync(ts.ConnectionName, a, string.Empty, cancellationToken); + //logger.LogInformation("Sign-in resource for connection '{ConnectionName}': {SignInLink}", ts.ConnectionName, signInResource.SignInLink); + await turnContext.SendActivityAsync(MessageFactory.Text($"Sign-in resource for connection '{ts.ConnectionName}': {signInResource.SignInLink}"), cancellationToken); + + } + } + + + } + } +} diff --git a/core/samples/PABot/Bots/TeamsBot.cs b/core/samples/PABot/Bots/TeamsBot.cs new file mode 100644 index 00000000..13bcda92 --- /dev/null +++ b/core/samples/PABot/Bots/TeamsBot.cs @@ -0,0 +1,66 @@ +// +// Copyright (c) Microsoft. All rights reserved. +// + +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Dialogs; +using Microsoft.Bot.Schema; +using Microsoft.Extensions.Logging; + +namespace PABot.Bots +{ + /// + /// This bot is derived from the TeamsActivityHandler class and handles Teams-specific activities. + /// + /// The type of the dialog. + public class TeamsBot : DialogBot where T : Dialog + { + /// + /// Initializes a new instance of the class. + /// + /// The conversation state. + /// The user state. + /// The dialog. + /// The logger. + public TeamsBot(ConversationState conversationState, UserState userState, T dialog, ILogger> logger) + : base(conversationState, userState, dialog, logger) + { + } + + /// + /// Handles the event when members are added to the conversation. + /// + /// The list of members added. + /// The turn context. + /// The cancellation token. + /// A task that represents the work queued to execute. + protected override async Task OnMembersAddedAsync(IList membersAdded, ITurnContext turnContext, CancellationToken cancellationToken) + { + foreach (var member in membersAdded) + { + if (member.Id != turnContext.Activity.Recipient.Id) + { + await turnContext.SendActivityAsync(MessageFactory.Text("Welcome to AuthenticationBot. Type anything to get logged in. Type 'logout' to sign-out."), cancellationToken); + } + } + } + + /// + /// Handles the Teams sign-in verification state. + /// + /// The turn context. + /// The cancellation token. + /// A task that represents the work queued to execute. + protected override async Task OnTeamsSigninVerifyStateAsync(ITurnContext turnContext, CancellationToken cancellationToken) + { + _logger.LogInformation("Running dialog with sign-in/verify state from an Invoke Activity."); + + // The OAuth Prompt needs to see the Invoke Activity in order to complete the login process. + // Run the Dialog with the new Invoke Activity. + await _dialog.RunAsync(turnContext, _conversationState.CreateProperty(nameof(DialogState)), cancellationToken); + } + } +} \ No newline at end of file diff --git a/core/samples/PABot/Dialogs/LogoutDialog.cs b/core/samples/PABot/Dialogs/LogoutDialog.cs new file mode 100644 index 00000000..668d0b14 --- /dev/null +++ b/core/samples/PABot/Dialogs/LogoutDialog.cs @@ -0,0 +1,105 @@ +// +// Copyright (c) Microsoft. All rights reserved. +// + +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Dialogs; +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Bot.Connector.Authentication; +using Microsoft.Bot.Schema; + +namespace PABot.Dialogs +{ + /// + /// A dialog that handles user logout. + /// + public class LogoutDialog : ComponentDialog + { + /// + /// Initializes a new instance of the class. + /// + /// The dialog ID. + /// The connection name configured in Azure Bot service. + public LogoutDialog(string id, string connectionName) + : base(id) + { + ConnectionName = connectionName; + } + + /// + /// Gets the configured connection name in Azure Bot service. + /// + protected string ConnectionName { get; } + + /// + /// Called when the dialog is started and pushed onto the parent's dialog stack. + /// + /// The inner DialogContext for the current turn of conversation. + /// Initial information to pass to the dialog. + /// Propagates notification that operations should be canceled. + /// A task representing the asynchronous operation. + protected override async Task OnBeginDialogAsync( + DialogContext innerDc, + object options, + CancellationToken cancellationToken = default(CancellationToken)) + { + var result = await InterruptAsync(innerDc, cancellationToken); + if (result != null) + { + return result; + } + + return await base.OnBeginDialogAsync(innerDc, options, cancellationToken); + } + + /// + /// Called when the dialog is continued, where it is the active dialog and the user replies with a new activity. + /// + /// The inner DialogContext for the current turn of conversation. + /// Propagates notification that operations should be canceled. + /// A task representing the asynchronous operation. + protected override async Task OnContinueDialogAsync( + DialogContext innerDc, + CancellationToken cancellationToken = default(CancellationToken)) + { + var result = await InterruptAsync(innerDc, cancellationToken); + if (result != null) + { + return result; + } + + return await base.OnContinueDialogAsync(innerDc, cancellationToken); + } + + /// + /// Called when the dialog is interrupted, where it is the active dialog and the user replies with a new activity. + /// + /// The inner DialogContext for the current turn of conversation. + /// Propagates notification that operations should be canceled. + /// A task representing the asynchronous operation. + private async Task InterruptAsync( + DialogContext innerDc, + CancellationToken cancellationToken = default(CancellationToken)) + { + if (innerDc.Context.Activity.Type == ActivityTypes.Message) + { + var text = innerDc.Context.Activity.Text.ToLowerInvariant(); + + // Allow logout anywhere in the command + if (text.Contains("logout")) + { + // The UserTokenClient encapsulates the authentication processes. + var userTokenClient = innerDc.Context.TurnState.Get(); + await userTokenClient.SignOutUserAsync(innerDc.Context.Activity.From.Id, ConnectionName, innerDc.Context.Activity.ChannelId, cancellationToken).ConfigureAwait(false); + + await innerDc.Context.SendActivityAsync(MessageFactory.Text("You have been signed out."), cancellationToken); + return await innerDc.CancelAllDialogsAsync(cancellationToken); + } + } + + return null!; + } + } +} diff --git a/core/samples/PABot/Dialogs/MainDialog.cs b/core/samples/PABot/Dialogs/MainDialog.cs new file mode 100644 index 00000000..e64a4ba5 --- /dev/null +++ b/core/samples/PABot/Dialogs/MainDialog.cs @@ -0,0 +1,165 @@ +// +// Copyright (c) Microsoft. All rights reserved. +// + +using System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Dialogs; +using Microsoft.Bot.Connector.Authentication; +using Microsoft.Bot.Schema; +using Microsoft.Extensions.Configuration; +using Microsoft.Extensions.Logging; + +namespace PABot.Dialogs +{ + /// + /// Main dialog that handles the authentication and user interactions. + /// + public class MainDialog : LogoutDialog + { + protected readonly ILogger _logger; + + /// + /// Initializes a new instance of the class. + /// + /// The configuration. + /// The logger. + public MainDialog(IConfiguration configuration, ILogger logger) + : base(nameof(MainDialog), configuration["ConnectionName"] ?? "graph") + { + _logger = logger; + + AddDialog(new OAuthPrompt( + nameof(OAuthPrompt), + new OAuthPromptSettings + { + ConnectionName = ConnectionName, + Text = "Please Sign In", + Title = "Sign In", + Timeout = 300000, // User has 5 minutes to login (1000 * 60 * 5) + EndOnInvalidMessage = true + })); + + AddDialog(new ConfirmPrompt(nameof(ConfirmPrompt))); + + AddDialog(new WaterfallDialog(nameof(WaterfallDialog), new WaterfallStep[] + { + PromptStepAsync, + LoginStepAsync, + DisplayTokenPhase1Async, + DisplayTokenPhase2Async, + })); + + // The initial child Dialog to run. + InitialDialogId = nameof(WaterfallDialog); + } + + /// + /// Prompts the user to sign in. + /// + /// The waterfall step context. + /// The cancellation token. + /// A task representing the asynchronous operation. + private async Task PromptStepAsync(WaterfallStepContext stepContext, CancellationToken cancellationToken) + { + _logger.LogInformation("PromptStepAsync() called."); + return await stepContext.BeginDialogAsync(nameof(OAuthPrompt), null, cancellationToken); + } + + /// + /// Handles the login step. + /// + /// The waterfall step context. + /// The cancellation token. + /// A task representing the asynchronous operation. + private async Task LoginStepAsync(WaterfallStepContext stepContext, CancellationToken cancellationToken) + { + var tokenResponse = (TokenResponse)stepContext.Result; + if (tokenResponse?.Token != null) + { + try + { + var client = new SimpleGraphClient(tokenResponse.Token); + var me = await client.GetMeAsync(); + var title = !string.IsNullOrEmpty(me.JobTitle) ? me.JobTitle : "Unknown"; + + await stepContext.Context.SendActivityAsync($"You're logged in as {me.DisplayName} ({me.UserPrincipalName}); your job title is: {title}"); + + var photo = await client.GetPhotoAsync(); + + if (!string.IsNullOrEmpty(photo)) + { + var cardImage = new CardImage(photo); + var card = new ThumbnailCard(images: new List { cardImage }); + var reply = MessageFactory.Attachment(card.ToAttachment()); + + await stepContext.Context.SendActivityAsync(reply, cancellationToken); + } + else + { + await stepContext.Context.SendActivityAsync(MessageFactory.Text("Sorry! User doesn't have a profile picture to display."), cancellationToken); + } + + return await stepContext.PromptAsync( + nameof(ConfirmPrompt), + new PromptOptions { Prompt = MessageFactory.Text("Would you like to view your token?") }, + cancellationToken); + } + catch (Exception ex) + { + _logger.LogError(ex, "Error occurred while processing your request."); + } + } + else + { + _logger.LogInformation("Response token is null or empty."); + } + + await stepContext.Context.SendActivityAsync(MessageFactory.Text("Login was not successful, please try again."), cancellationToken); + return await stepContext.EndDialogAsync(cancellationToken: cancellationToken); + } + + /// + /// Displays the token if the user confirms. + /// + /// The waterfall step context. + /// The cancellation token. + /// A task representing the asynchronous operation. + private async Task DisplayTokenPhase1Async(WaterfallStepContext stepContext, CancellationToken cancellationToken) + { + _logger.LogInformation("DisplayTokenPhase1Async() method called."); + + await stepContext.Context.SendActivityAsync(MessageFactory.Text("Thank you."), cancellationToken); + + var result = (bool)stepContext.Result; + if (result) + { + return await stepContext.BeginDialogAsync(nameof(OAuthPrompt), cancellationToken: cancellationToken); + } + + return await stepContext.EndDialogAsync(cancellationToken: cancellationToken); + } + + /// + /// Displays the token to the user. + /// + /// The waterfall step context. + /// The cancellation token. + /// A task representing the asynchronous operation. + private async Task DisplayTokenPhase2Async(WaterfallStepContext stepContext, CancellationToken cancellationToken) + { + _logger.LogInformation("DisplayTokenPhase2Async() method called."); + + var tokenResponse = (TokenResponse)stepContext.Result; + if (tokenResponse != null) + { + await stepContext.Context.SendActivityAsync(MessageFactory.Text($"Here is your token: {tokenResponse.Token}"), cancellationToken); + } + + return await stepContext.EndDialogAsync(cancellationToken: cancellationToken); + } + } +} diff --git a/core/samples/PABot/InitCompatAdapter.cs b/core/samples/PABot/InitCompatAdapter.cs new file mode 100644 index 00000000..a5804f56 --- /dev/null +++ b/core/samples/PABot/InitCompatAdapter.cs @@ -0,0 +1,110 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Extensions.Options; +using Microsoft.Identity.Abstractions; +using Microsoft.Identity.Web; +using Microsoft.Identity.Web.TokenCacheProviders.InMemory; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; + +namespace PABot +{ + internal static class InitCompatAdapter + { + private const string DefaultScope = "https://api.botframework.com/.default"; + + public static IServiceCollection AddTeamsBotApplications(this IServiceCollection services) + { + // Register shared services (needed once for all adapters) + services.AddHttpClient(); + services.AddTokenAcquisition(true); + services.AddInMemoryTokenCaches(); + services.AddAgentIdentities(); + services.AddHttpContextAccessor(); + + // Register each keyed adapter instance + RegisterKeyedTeamsBotApplication(services, "AdapterOne"); + RegisterKeyedTeamsBotApplication(services, "AdapterTwo"); + + return services; + } + + private static void RegisterKeyedTeamsBotApplication(IServiceCollection services, string keyName) + { + // Get configuration for this key + var configSection = services.BuildServiceProvider().GetRequiredService().GetSection(keyName); + + // Configure authorization and authentication for this key + // This sets up JWT bearer authentication and authorization policies + services.AddAuthorization(null, keyName); + + // Configure MSAL options for this key + services.Configure(keyName, configSection); + + // Register named HttpClients with custom auth handlers + services.AddHttpClient($"{keyName}_ConversationClient") + .AddHttpMessageHandler(sp => CreatePACustomAuthHandler(sp, keyName, DefaultScope)); + + services.AddHttpClient($"{keyName}_UserTokenClient") + .AddHttpMessageHandler(sp => CreatePACustomAuthHandler(sp, keyName, DefaultScope)); + + services.AddHttpClient($"{keyName}_TeamsApiClient") + .AddHttpMessageHandler(sp => CreatePACustomAuthHandler(sp, keyName, DefaultScope)); + + // Register keyed ConversationClient + services.AddKeyedSingleton(keyName, (sp, key) => + { + var httpClient = sp.GetRequiredService() + .CreateClient($"{keyName}_ConversationClient"); + return new ConversationClient(httpClient, sp.GetRequiredService>()); + }); + + // Register keyed UserTokenClient + services.AddKeyedSingleton(keyName, (sp, key) => + { + var httpClient = sp.GetRequiredService() + .CreateClient($"{keyName}_UserTokenClient"); + return new UserTokenClient( + httpClient, + sp.GetRequiredService(), + sp.GetRequiredService>()); + }); + + // Register keyed TeamsApiClient + services.AddKeyedSingleton(keyName, (sp, key) => + { + var httpClient = sp.GetRequiredService() + .CreateClient($"{keyName}_TeamsApiClient"); + return new TeamsApiClient(httpClient, sp.GetRequiredService>()); + }); + + // Register keyed TeamsBotApplication + services.AddKeyedSingleton(keyName, (sp, key) => + { + return new TeamsBotApplication( + sp.GetRequiredKeyedService(keyName), + sp.GetRequiredKeyedService(keyName), + sp.GetRequiredKeyedService(keyName), + sp.GetRequiredService(), + sp.GetRequiredService(), + sp.GetRequiredService>(), + keyName); + }); + } + + private static DelegatingHandler CreatePACustomAuthHandler( + IServiceProvider sp, + string keyName, + string scope) + { + return new PACustomAuthHandler( + keyName, + sp.GetRequiredService(), + sp.GetRequiredService>(), + scope, + sp.GetService>()); + } + } +} diff --git a/core/samples/PABot/PABot.csproj b/core/samples/PABot/PABot.csproj new file mode 100644 index 00000000..ffcd3bcf --- /dev/null +++ b/core/samples/PABot/PABot.csproj @@ -0,0 +1,18 @@ + + + + net10.0 + enable + enable + + + + + + + + + + + + diff --git a/core/samples/PABot/PACustomAuthHandler.cs b/core/samples/PABot/PACustomAuthHandler.cs new file mode 100644 index 00000000..3eb142f3 --- /dev/null +++ b/core/samples/PABot/PACustomAuthHandler.cs @@ -0,0 +1,92 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Net.Http.Headers; +using Microsoft.Extensions.Options; +using Microsoft.Identity.Abstractions; +using Microsoft.Identity.Web; +using Microsoft.Teams.Bot.Core.Schema; + +namespace PABot +{ + internal class PACustomAuthHandler( + string msalOptionName, + IAuthorizationHeaderProvider authorizationHeaderProvider, + ILogger logger, + string scope, + IOptions? managedIdentityOptions = null) : DelegatingHandler + { + private readonly IAuthorizationHeaderProvider _authorizationHeaderProvider = authorizationHeaderProvider ?? throw new ArgumentNullException(nameof(authorizationHeaderProvider)); + private readonly ILogger _logger = logger ?? throw new ArgumentNullException(nameof(logger)); + private readonly string _scope = scope ?? throw new ArgumentNullException(nameof(scope)); + private readonly IOptions? _managedIdentityOptions = managedIdentityOptions; + + /// + /// Key used to store the agentic identity in HttpRequestMessage options. + /// + public static readonly HttpRequestOptionsKey AgenticIdentityKey = new("AgenticIdentity"); + + /// + protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) + { + request.Options.TryGetValue(AgenticIdentityKey, out AgenticIdentity? agenticIdentity); + + string token = await GetAuthorizationHeaderAsync(agenticIdentity, cancellationToken).ConfigureAwait(false); + + string tokenValue = token.StartsWith("Bearer ", StringComparison.OrdinalIgnoreCase) + ? token["Bearer ".Length..] + : token; + + request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", tokenValue); + + return await base.SendAsync(request, cancellationToken).ConfigureAwait(false); + } + + /// + /// Gets an authorization header for Bot Framework API calls. + /// Supports both app-only and agentic (user-delegated) token acquisition. + /// + /// Optional agentic identity for user-delegated token acquisition. If not provided, acquires an app-only token. + /// Cancellation token. + /// The authorization header value. + private async Task GetAuthorizationHeaderAsync(AgenticIdentity? agenticIdentity, CancellationToken cancellationToken) + { + AuthorizationHeaderProviderOptions options = new() + { + AcquireTokenOptions = new AcquireTokenOptions() + { + AuthenticationOptionsName = msalOptionName + } + }; + + // Conditionally apply ManagedIdentity configuration if registered + if (_managedIdentityOptions is not null) + { + ManagedIdentityOptions miOptions = _managedIdentityOptions.Value; + + if (!string.IsNullOrEmpty(miOptions.UserAssignedClientId)) + { + options.AcquireTokenOptions.ManagedIdentity = miOptions; + } + } + + if (agenticIdentity is not null && + !string.IsNullOrEmpty(agenticIdentity.AgenticAppId) && + !string.IsNullOrEmpty(agenticIdentity.AgenticUserId)) + { + _logger.LogInformation("Acquiring agentic token for scope '{Scope}' with AppId '{AppId}' and UserId '{UserId}'.", + _scope, + agenticIdentity.AgenticAppId, + agenticIdentity.AgenticUserId); + + options.WithAgentUserIdentity(agenticIdentity.AgenticAppId, Guid.Parse(agenticIdentity.AgenticUserId)); + string token = await _authorizationHeaderProvider.CreateAuthorizationHeaderAsync([_scope], options, null, cancellationToken).ConfigureAwait(false); + return token; + } + + _logger.LogInformation("Acquiring app-only token for scope: {Scope}", _scope); + string appToken = await _authorizationHeaderProvider.CreateAuthorizationHeaderForAppAsync(_scope, options, cancellationToken).ConfigureAwait(false); + return appToken; + } + } +} diff --git a/core/samples/PABot/Program.cs b/core/samples/PABot/Program.cs new file mode 100644 index 00000000..731de0f3 --- /dev/null +++ b/core/samples/PABot/Program.cs @@ -0,0 +1,63 @@ +// +// Copyright (c) Microsoft. All rights reserved. +// + +using Microsoft.Bot.Builder; +using Microsoft.Bot.Builder.Integration.AspNet.Core; +using Microsoft.Teams.Bot.Apps; +using PABot; +using PABot.Bots; +using PABot.Dialogs; + +var builder = WebApplication.CreateBuilder(args); + +// Register all the keyed services (ConversationClient, UserTokenClient, TeamsApiClient, TeamsBotApplication) +builder.Services.AddTeamsBotApplications(); + +// Register keyed adapters using the keyed TeamsBotApplication +builder.Services.AddKeyedSingleton("AdapterOne", (sp, keyName) => +{ + return new AdapterWithErrorHandler( + sp.GetRequiredKeyedService("AdapterOne"), + sp.GetRequiredService(), + sp.GetRequiredService(), + sp.GetRequiredService>(), + sp.GetRequiredService(), + sp.GetRequiredService()); +}); + +builder.Services.AddKeyedSingleton("AdapterTwo", (sp, keyName) => +{ + return new AdapterWithErrorHandler( + sp.GetRequiredKeyedService("AdapterTwo"), + sp.GetRequiredService(), + sp.GetRequiredService(), + sp.GetRequiredService>(), + sp.GetRequiredService(), + sp.GetRequiredService()); +}); + +// Register bot state and dialog +builder.Services.AddSingleton(); +builder.Services.AddSingleton(); +builder.Services.AddSingleton(); +builder.Services.AddSingleton(); + +// Register bots +builder.Services.AddKeyedTransient>("TeamsBot"); +builder.Services.AddKeyedTransient("EchoBot"); + +var app = builder.Build(); + +// Get the keyed adapters +var adapterOne = app.Services.GetRequiredKeyedService("AdapterOne"); +var adapterTwo = app.Services.GetRequiredKeyedService("AdapterTwo"); + +// Map endpoints with their respective adapters and authorization policies +app.MapPost("/api/messages", (HttpRequest request, HttpResponse response, [FromKeyedServices("EchoBot")]IBot bot, CancellationToken ct) => + adapterOne.ProcessAsync(request, response, bot, ct)).RequireAuthorization("AdapterOne"); + +app.MapPost("/api/v2/messages", (HttpRequest request, HttpResponse response, [FromKeyedServices("TeamsBot")]IBot bot, CancellationToken ct) => + adapterTwo.ProcessAsync(request, response, bot, ct)).RequireAuthorization("AdapterTwo"); + +app.Run(); diff --git a/core/samples/PABot/Properties/launchSettings.TEMPLATE.json b/core/samples/PABot/Properties/launchSettings.TEMPLATE.json new file mode 100644 index 00000000..c6433d62 --- /dev/null +++ b/core/samples/PABot/Properties/launchSettings.TEMPLATE.json @@ -0,0 +1,26 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "profiles": { + "ridotest-local-msal": { + "commandName": "Project", + "launchBrowser": false, + "applicationUrl": "http://localhost:3978", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "ConnectionName": "graph", + "AdapterOne__Scope": "https://api.botframework.com/.default", + "AdapterOne__Instance": "https://login.microsoftonline.com/", + "AdapterOne__TenantId": "", + "AdapterOne__ClientId": "", + "AdapterOne__ClientCredentials__0__SourceType": "ClientSecret", + "AdapterOne__ClientCredentials__0__ClientSecret": "", + "AdapterTwo__Scope": "https://botapi.skype.com/.default", + "AdapterTwo__Instance": "https://login.microsoftonline.com/", + "AdapterTwo__TenantId": "", + "AdapterTwo__ClientId": "", + "AdapterTwo__ClientCredentials__0__SourceType": "ClientSecret", + "AdapterTwo__ClientCredentials__0__ClientSecret": "", + } + } + } + } diff --git a/core/samples/PABot/SimpleGraphClient.cs b/core/samples/PABot/SimpleGraphClient.cs new file mode 100644 index 00000000..6866cd18 --- /dev/null +++ b/core/samples/PABot/SimpleGraphClient.cs @@ -0,0 +1,165 @@ +// +// Copyright (c) Microsoft. All rights reserved. +// + +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Net.Http.Headers; +using System.Threading.Tasks; +using Microsoft.Graph; +using Microsoft.Graph.Models; +using Microsoft.Graph.Me.SendMail; +using Microsoft.Kiota.Abstractions.Authentication; +using System.Threading; + + +namespace PABot +{ + /// + /// This class is a wrapper for the Microsoft Graph API. + /// See: https://developer.microsoft.com/en-us/graph + /// + public class SimpleGraphClient + { + private readonly string _token; + + /// + /// Initializes a new instance of the class. + /// + /// The token issued to the user. + public SimpleGraphClient(string token) + { + if (string.IsNullOrWhiteSpace(token)) + { + throw new ArgumentNullException(nameof(token)); + } + + _token = token; + } + + /// + /// Sends an email on the user's behalf using the Microsoft Graph API. + /// + /// The recipient's email address. + /// The subject of the email. + /// The content of the email. + /// A task representing the asynchronous operation. + public async Task SendMailAsync(string toAddress, string subject, string content) + { + if (string.IsNullOrWhiteSpace(toAddress)) + { + throw new ArgumentNullException(nameof(toAddress)); + } + + if (string.IsNullOrWhiteSpace(subject)) + { + throw new ArgumentNullException(nameof(subject)); + } + + if (string.IsNullOrWhiteSpace(content)) + { + throw new ArgumentNullException(nameof(content)); + } + + var graphClient = GetAuthenticatedClient(); + var recipients = new List + { + new Recipient + { + EmailAddress = new EmailAddress + { + Address = toAddress, + }, + }, + }; + + // Create the message. + var email = new Message + { + Body = new ItemBody + { + Content = content, + ContentType = BodyType.Text, + }, + Subject = subject, + ToRecipients = recipients, + }; + + // Send the message. + await graphClient.Me.SendMail.PostAsync(new SendMailPostRequestBody { Message = email, SaveToSentItems = true }); + } + + /// + /// Gets recent mail for the user using the Microsoft Graph API. + /// + /// An array of recent messages. + public async Task GetRecentMailAsync() + { + var graphClient = GetAuthenticatedClient(); + var messages = await graphClient.Me.MailFolders["inbox"].Messages.GetAsync(); + + return messages?.Value?.Take(5).ToArray()!; + } + + /// + /// Gets information about the user. + /// + /// The user information. + public async Task GetMeAsync() + { + var graphClient = GetAuthenticatedClient(); + var me = await graphClient.Me.GetAsync(); + return me!; + } + + /// + /// Gets the user's photo. + /// + /// The user's photo as a base64 string. + public async Task GetPhotoAsync() + { + var graphClient = GetAuthenticatedClient(); + var photo = await graphClient.Me.Photo.Content.GetAsync(); + if (photo != null) + { + using var ms = new MemoryStream(); + await photo.CopyToAsync(ms); + var buffers = ms.ToArray(); + return $"data:image/png;base64,{Convert.ToBase64String(buffers)}"; + } + return string.Empty; + } + + /// + /// Gets an authenticated Microsoft Graph client using the token issued to the user. + /// + /// The authenticated GraphServiceClient. + private GraphServiceClient GetAuthenticatedClient() + { + var tokenProvider = new SimpleAccessTokenProvider(_token); + + var authProvider = new BaseBearerTokenAuthenticationProvider(tokenProvider); + + return new GraphServiceClient(authProvider); + } + + public class SimpleAccessTokenProvider : IAccessTokenProvider + { + private readonly string _accessToken; + + public SimpleAccessTokenProvider(string accessToken) + { + _accessToken = accessToken; + } + + public Task GetAuthorizationTokenAsync(Uri uri, Dictionary? context = null!, CancellationToken cancellationToken = default) + { + return Task.FromResult(_accessToken); + } + + public AllowedHostsValidator AllowedHostsValidator => new AllowedHostsValidator(); + } + } +} diff --git a/core/samples/PABot/appsettings.json b/core/samples/PABot/appsettings.json new file mode 100644 index 00000000..2c63c085 --- /dev/null +++ b/core/samples/PABot/appsettings.json @@ -0,0 +1,2 @@ +{ +} diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs index 54db1629..4f586dcb 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatAdapter.cs @@ -5,7 +5,7 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Schema; -using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Schema; @@ -28,10 +28,16 @@ public class CompatAdapter : CompatBotAdapter, IBotFrameworkHttpAdapter /// /// Creates a new instance of the class. /// - /// - public CompatAdapter(IServiceProvider sp) : base(sp) + /// The Teams bot application instance. + /// The HTTP context accessor. + /// The logger instance. + public CompatAdapter( + TeamsBotApplication teamsBotApplication, + IHttpContextAccessor? httpContextAccessor = null, + ILogger? logger = null) + : base(teamsBotApplication, httpContextAccessor, logger) { - _teamsBotApplication = sp.GetRequiredService(); + _teamsBotApplication = teamsBotApplication; } /// diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs index 9112b02c..14260927 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatBotAdapter.cs @@ -5,7 +5,6 @@ using Microsoft.AspNetCore.Http; using Microsoft.Bot.Builder; using Microsoft.Bot.Schema; -using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Core; @@ -21,13 +20,18 @@ namespace Microsoft.Teams.Bot.Compat; /// Use this adapter to bridge Bot Framework turn contexts and activities with a custom bot application. /// This class is intended for scenarios where integration with non-standard bot runtimes or legacy systems is /// required. -/// The service provider used to resolve dependencies. -public class CompatBotAdapter(IServiceProvider sp) : BotAdapter +/// The Teams bot application instance. +/// The HTTP context accessor. +/// The logger instance. +public class CompatBotAdapter( + TeamsBotApplication botApplication, + IHttpContextAccessor? httpContextAccessor = null, + ILogger? logger = null) : BotAdapter { private readonly JsonSerializerOptions _writeIndentedJsonOptions = new() { WriteIndented = true }; - private readonly TeamsBotApplication botApplication = sp.GetRequiredService(); - private readonly IHttpContextAccessor? httpContextAccessor = sp.GetService(); - private readonly ILogger? logger = sp.GetService>(); + private readonly TeamsBotApplication botApplication = botApplication; + private readonly IHttpContextAccessor? httpContextAccessor = httpContextAccessor; + private readonly ILogger? logger = logger; /// /// Deletes an activity from the conversation. diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs index 9762f5c6..f0fac166 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs @@ -46,4 +46,4 @@ public static IServiceCollection AddCompatAdapter(this IServiceCollection servic services.AddSingleton(); return services; } -} +} \ No newline at end of file diff --git a/core/src/Microsoft.Teams.Bot.Compat/KeyedBotAuthenticationHandler.cs b/core/src/Microsoft.Teams.Bot.Compat/KeyedBotAuthenticationHandler.cs new file mode 100644 index 00000000..7e5f71ab --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Compat/KeyedBotAuthenticationHandler.cs @@ -0,0 +1,131 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Net.Http.Headers; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; +using Microsoft.Identity.Abstractions; +using Microsoft.Identity.Web; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Compat; + +/// +/// A delegating handler that adds authentication headers to outgoing HTTP requests +/// using named MSAL configuration options. +/// +/// +/// +/// This handler acquires OAuth tokens using the Microsoft Identity platform and adds +/// them to outgoing requests. It supports both app-only tokens and agentic (user-delegated) +/// tokens when an is present in the request options. +/// +/// +/// The handler uses named to support +/// multi-instance scenarios where different bot configurations require different credentials. +/// +/// +internal sealed class KeyedBotAuthenticationHandler : DelegatingHandler +{ + private readonly string _msalOptionsName; + private readonly IAuthorizationHeaderProvider _authorizationHeaderProvider; + private readonly ILogger _logger; + private readonly string _scope; + private readonly IOptions? _managedIdentityOptions; + + /// + /// Key used to store the agentic identity in HttpRequestMessage options. + /// + public static readonly HttpRequestOptionsKey AgenticIdentityKey = new("AgenticIdentity"); + + /// + /// Initializes a new instance of the class. + /// + /// The name of the MSAL configuration options to use for token acquisition. + /// The provider used to create authorization headers. + /// The logger for diagnostic output. + /// The OAuth scope for token acquisition. + /// Optional managed identity configuration. + /// + /// Thrown when , , + /// or is null. + /// + public KeyedBotAuthenticationHandler( + string msalOptionsName, + IAuthorizationHeaderProvider authorizationHeaderProvider, + ILogger logger, + string scope, + IOptions? managedIdentityOptions = null) + { + _msalOptionsName = msalOptionsName ?? throw new ArgumentNullException(nameof(msalOptionsName)); + _authorizationHeaderProvider = authorizationHeaderProvider ?? throw new ArgumentNullException(nameof(authorizationHeaderProvider)); + _logger = logger ?? throw new ArgumentNullException(nameof(logger)); + _scope = scope ?? throw new ArgumentNullException(nameof(scope)); + _managedIdentityOptions = managedIdentityOptions; + } + + /// + protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) + { + request.Options.TryGetValue(AgenticIdentityKey, out AgenticIdentity? agenticIdentity); + + string token = await GetAuthorizationHeaderAsync(agenticIdentity, cancellationToken).ConfigureAwait(false); + + string tokenValue = token.StartsWith("Bearer ", StringComparison.OrdinalIgnoreCase) + ? token["Bearer ".Length..] + : token; + + request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", tokenValue); + + return await base.SendAsync(request, cancellationToken).ConfigureAwait(false); + } + + /// + /// Gets an authorization header for Bot Framework API calls. + /// Supports both app-only and agentic (user-delegated) token acquisition. + /// + private async Task GetAuthorizationHeaderAsync(AgenticIdentity? agenticIdentity, CancellationToken cancellationToken) + { + AuthorizationHeaderProviderOptions options = new() + { + AcquireTokenOptions = new AcquireTokenOptions() + { + AuthenticationOptionsName = _msalOptionsName + } + }; + + // Conditionally apply ManagedIdentity configuration if registered + if (_managedIdentityOptions is not null) + { + ManagedIdentityOptions miOptions = _managedIdentityOptions.Value; + + if (!string.IsNullOrEmpty(miOptions.UserAssignedClientId)) + { + options.AcquireTokenOptions.ManagedIdentity = miOptions; + } + } + + if (agenticIdentity is not null && + !string.IsNullOrEmpty(agenticIdentity.AgenticAppId) && + !string.IsNullOrEmpty(agenticIdentity.AgenticUserId)) + { + _logger.LogInformation( + "Acquiring agentic token for scope '{Scope}' with AppId '{AppId}' and UserId '{UserId}'.", + _scope, + agenticIdentity.AgenticAppId, + agenticIdentity.AgenticUserId); + + options.WithAgentUserIdentity(agenticIdentity.AgenticAppId, Guid.Parse(agenticIdentity.AgenticUserId)); + string token = await _authorizationHeaderProvider + .CreateAuthorizationHeaderAsync([_scope], options, null, cancellationToken) + .ConfigureAwait(false); + return token; + } + + _logger.LogInformation("Acquiring app-only token for scope: {Scope}", _scope); + string appToken = await _authorizationHeaderProvider + .CreateAuthorizationHeaderForAppAsync(_scope, options, cancellationToken) + .ConfigureAwait(false); + return appToken; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs index 994f4fdd..da77f8ea 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs @@ -52,7 +52,7 @@ public static AuthenticationBuilder AddBotAuthentication(this IServiceCollection if (!useAgentAuth) { string[] validIssuers = ["https://api.botframework.com"]; - builder.AddCustomJwtBearer(BotScheme, validIssuers, audience, logger); + builder.AddCustomJwtBearer($"BotScheme_{aadSectionName}", validIssuers, audience, logger); } else { @@ -102,11 +102,11 @@ public static AuthorizationBuilder AddAuthorization(this IServiceCollection serv services.AddBotAuthentication(configuration, useAgentAuth, logger, aadSectionName); AuthorizationBuilder authorizationBuilder = services .AddAuthorizationBuilder() - .AddDefaultPolicy("DefaultPolicy", policy => + .AddDefaultPolicy(aadSectionName, policy => { if (!useAgentAuth) { - policy.AuthenticationSchemes.Add(BotScheme); + policy.AuthenticationSchemes.Add($"BotScheme_{aadSectionName}"); } else { diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs index 1559ee1a..36ce6bff 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs @@ -91,12 +91,10 @@ private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() Mock.Of(), NullLogger.Instance); - var mockServiceProvider = new Mock(); - mockServiceProvider - .Setup(sp => sp.GetService(typeof(TeamsBotApplication))) - .Returns(teamsBotApplication); - - var compatAdapter = new CompatAdapter(mockServiceProvider.Object); + var compatAdapter = new CompatAdapter( + teamsBotApplication, + Mock.Of(), + NullLogger.Instance); return (compatAdapter, teamsApiClient); } From c888afb6feb9749082b0f718b3eb9d881cb07369 Mon Sep 17 00:00:00 2001 From: Mehak Bindra Date: Wed, 18 Feb 2026 16:37:19 -0800 Subject: [PATCH 59/69] Add events(meetings) to core + sample (#337) **Core SDK Enhancements:** * Introduced `EventActivity` and `EventActivity` classes to represent event activities, including strongly-typed value payloads. Also added `EventNames` constants for meeting event types. * Defined strongly-typed value classes for meeting events: `MeetingStartValue`, `MeetingEndValue`, `MeetingParticipantJoinValue`, and `MeetingParticipantLeaveValue`, as well as related participant info classes. * Added `MeetingHandler.cs` with extension methods for registering handlers for meeting start, end, participant join, and participant leave events in `TeamsBotApplication`. **Sample Bot and Documentation:** * Added a new sample bot, `MeetingsBot`, including its project file, implementation (`Program.cs`), configuration (`appsettings.json`), and a detailed README explaining manifest requirements and Teams setup for meeting events. * Updated the solution file `core.slnx` to include the new `MeetingsBot` sample. --- core/core.slnx | 5 +- core/samples/AllInvokesBot/appsettings.json | 4 +- core/samples/MeetingsBot/MeetingsBot.csproj | 13 ++ core/samples/MeetingsBot/Program.cs | 66 ++++++++++ core/samples/MeetingsBot/README.md | 51 ++++++++ core/samples/MeetingsBot/appsettings.json | 9 ++ .../MessageExtensionBot/appsettings.json | 1 - core/samples/TeamsBot/Program.cs | 8 ++ core/samples/TeamsBot/appsettings.json | 1 - core/samples/TeamsChannelBot/appsettings.json | 1 - .../Handlers/EventHandler.cs | 60 +++++++++ .../Handlers/MeetingHandler.cs | 117 +++++++++++++++++ .../Schema/Activities/EventActivity.cs | 119 ++++++++++++++++++ .../Schema/Activities/MeetingValues.cs | 106 ++++++++++++++++ .../Schema/TeamsActivityType.cs | 19 +++ 15 files changed, 573 insertions(+), 7 deletions(-) create mode 100644 core/samples/MeetingsBot/MeetingsBot.csproj create mode 100644 core/samples/MeetingsBot/Program.cs create mode 100644 core/samples/MeetingsBot/README.md create mode 100644 core/samples/MeetingsBot/appsettings.json create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/EventHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Handlers/MeetingHandler.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/EventActivity.cs create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MeetingValues.cs diff --git a/core/core.slnx b/core/core.slnx index ff19b43d..cd660185 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -14,11 +14,12 @@ - - + + + diff --git a/core/samples/AllInvokesBot/appsettings.json b/core/samples/AllInvokesBot/appsettings.json index 10f68b8c..5febf4fe 100644 --- a/core/samples/AllInvokesBot/appsettings.json +++ b/core/samples/AllInvokesBot/appsettings.json @@ -1,8 +1,8 @@ { "Logging": { "LogLevel": { - "Default": "Information", - "Microsoft.AspNetCore": "Warning" + "Default": "Warning", + "Microsoft.Teams": "Information" } }, "AllowedHosts": "*" diff --git a/core/samples/MeetingsBot/MeetingsBot.csproj b/core/samples/MeetingsBot/MeetingsBot.csproj new file mode 100644 index 00000000..f30bcbe3 --- /dev/null +++ b/core/samples/MeetingsBot/MeetingsBot.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/core/samples/MeetingsBot/Program.cs b/core/samples/MeetingsBot/Program.cs new file mode 100644 index 00000000..035fd9a0 --- /dev/null +++ b/core/samples/MeetingsBot/Program.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Teams.Bot.Apps.Schema; + +var builder = TeamsBotApplication.CreateBuilder(args); +var teamsApp = builder.Build(); + +// ==================== MEETING HANDLERS ==================== + +teamsApp.OnMeetingStart(async (context, cancellationToken) => +{ + var meeting = context.Activity.Value; + Console.WriteLine($"[MeetingStart] Title: {meeting?.Title}"); + await context.SendActivityAsync($"Meeting started: **{meeting?.Title}**", cancellationToken); +}); + +teamsApp.OnMeetingEnd(async (context, cancellationToken) => +{ + var meeting = context.Activity.Value; + Console.WriteLine($"[MeetingEnd] Title: {meeting?.Title}, EndTime: {meeting?.EndTime:u}"); + await context.SendActivityAsync($"Meeting ended: **{meeting?.Title}**\nEnd time: {meeting?.EndTime:u}", cancellationToken); +}); + +teamsApp.OnMeetingParticipantJoin(async (context, cancellationToken) => +{ + var members = context.Activity.Value?.Members ?? []; + var names = string.Join(", ", members.Select(m => m.User.Name ?? m.User.Id)); + Console.WriteLine($"[MeetingParticipantJoin] Members: {names}"); + await context.SendActivityAsync($"Participant(s) joined: {names}", cancellationToken); +}); + +teamsApp.OnMeetingParticipantLeave(async (context, cancellationToken) => +{ + var members = context.Activity.Value?.Members ?? []; + var names = string.Join(", ", members.Select(m => m.User.Name ?? m.User.Id)); + Console.WriteLine($"[MeetingParticipantLeave] Members: {names}"); + await context.SendActivityAsync($"Participant(s) left: {names}", cancellationToken); +}); + +//TODO : review if we can trigger these +// ==================== COMMAND HANDLERS ==================== +/* + +teamsApp.OnCommand(async (context, cancellationToken) => +{ + var commandId = context.Activity.Value?.CommandId ?? "unknown"; + Console.WriteLine($"[Command] CommandId: {commandId}"); + await context.SendActivityAsync($"Received command: **{commandId}**", cancellationToken); +}); + +teamsApp.OnCommandResult(async (context, cancellationToken) => +{ + var commandId = context.Activity.Value?.CommandId ?? "unknown"; + var error = context.Activity.Value?.Error; + Console.WriteLine($"[CommandResult] CommandId: {commandId}, HasError: {error is not null}"); + + if (error is not null) + await context.SendActivityAsync($"Command **{commandId}** failed: {error.Message}", cancellationToken); + else + await context.SendActivityAsync($"Command **{commandId}** completed successfully.", cancellationToken); +}); +*/ +teamsApp.Run(); diff --git a/core/samples/MeetingsBot/README.md b/core/samples/MeetingsBot/README.md new file mode 100644 index 00000000..db4b6eaf --- /dev/null +++ b/core/samples/MeetingsBot/README.md @@ -0,0 +1,51 @@ +# Sample: Meetings + +This sample demonstrates how to handle real-time updates for meeting events and meeting participant events. + +## Manifest Requirements + +There are a few requirements in the Teams app manifest (manifest.json) to support these events. + +1) The `scopes` section must include `team`, and `groupChat`: + +```json + "bots": [ + { + "botId": "", + "scopes": [ + "team", + "personal", + "groupChat" + ], + "isNotificationOnly": false + } + ] +``` + +2) In the authorization section, make sure to specify the following resource-specific permissions: + +```json + "authorization":{ + "permissions":{ + "resourceSpecific":[ + { + "name":"OnlineMeetingParticipant.Read.Chat", + "type":"Application" + }, + { + "name":"ChannelMeeting.ReadBasic.Group", + "type":"Application" + }, + { + "name":"OnlineMeeting.ReadBasic.Chat", + "type":"Application" + } + ] + } + } +``` + +### Teams Developer Portal: Bot Configuration + +For your Bot, make sure the [Meeting Event Subscriptions](https://learn.microsoft.com/en-us/microsoftteams/platform/apps-in-teams-meetings/meeting-apps-apis?branch=pr-en-us-8455&tabs=channel-meeting%2Cguest-user%2Cone-on-one-call%2Cdotnet3%2Cdotnet2%2Cdotnet%2Cparticipant-join-event%2Cparticipant-join-event1#receive-meeting-participant-events) are checked. +This enables you to receive the Meeting Participant events. diff --git a/core/samples/MeetingsBot/appsettings.json b/core/samples/MeetingsBot/appsettings.json new file mode 100644 index 00000000..5febf4fe --- /dev/null +++ b/core/samples/MeetingsBot/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Warning", + "Microsoft.Teams": "Information" + } + }, + "AllowedHosts": "*" +} diff --git a/core/samples/MessageExtensionBot/appsettings.json b/core/samples/MessageExtensionBot/appsettings.json index f88090b1..5febf4fe 100644 --- a/core/samples/MessageExtensionBot/appsettings.json +++ b/core/samples/MessageExtensionBot/appsettings.json @@ -2,7 +2,6 @@ "Logging": { "LogLevel": { "Default": "Warning", - "Microsoft.Bot": "Information", "Microsoft.Teams": "Information" } }, diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index b6d463c6..1e45225c 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -144,6 +144,14 @@ [Visit Microsoft](https://www.microsoft.com) return AdaptiveCardResponse.CreateMessageResponse("Invokes are great!!"); }); +// ==================== EVENT HANDLERS ==================== + +teamsApp.OnEvent(async (context, cancellationToken) => +{ + Console.WriteLine($"[Event] Name: {context.Activity.Name}"); + await context.SendActivityAsync($"Received event: `{context.Activity.Name}`", cancellationToken); +}); + // ==================== CONVERSATION UPDATE HANDLERS ==================== teamsApp.OnMembersAdded(async (context, cancellationToken) => diff --git a/core/samples/TeamsBot/appsettings.json b/core/samples/TeamsBot/appsettings.json index f88090b1..5febf4fe 100644 --- a/core/samples/TeamsBot/appsettings.json +++ b/core/samples/TeamsBot/appsettings.json @@ -2,7 +2,6 @@ "Logging": { "LogLevel": { "Default": "Warning", - "Microsoft.Bot": "Information", "Microsoft.Teams": "Information" } }, diff --git a/core/samples/TeamsChannelBot/appsettings.json b/core/samples/TeamsChannelBot/appsettings.json index f88090b1..5febf4fe 100644 --- a/core/samples/TeamsChannelBot/appsettings.json +++ b/core/samples/TeamsChannelBot/appsettings.json @@ -2,7 +2,6 @@ "Logging": { "LogLevel": { "Default": "Warning", - "Microsoft.Bot": "Information", "Microsoft.Teams": "Information" } }, diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/EventHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/EventHandler.cs new file mode 100644 index 00000000..4fec727e --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/EventHandler.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling any event activity. +/// +public delegate Task EventActivityHandler(Context context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering generic event activity handlers. +/// +public static class EventExtensions +{ + /// + /// Registers a handler for all event activities. + /// + public static TeamsBotApplication OnEvent(this TeamsBotApplication app, EventActivityHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = TeamsActivityType.Event, + Selector = _ => true, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /* + /// + /// Registers a handler for read receipt event activities. + /// Fired by Teams when a user reads a message sent by the bot in a 1:1 chat. + /// No value payload — the event itself is the notification. + /// + public static TeamsBotApplication OnReadReceipt(this TeamsBotApplication app, EventActivityHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Event, EventNames.ReadReceipt), + Selector = activity => activity.Name == EventNames.ReadReceipt, + Handler = async (ctx, cancellationToken) => + { + await handler(ctx, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + */ +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MeetingHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MeetingHandler.cs new file mode 100644 index 00000000..4598f42d --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MeetingHandler.cs @@ -0,0 +1,117 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; + +namespace Microsoft.Teams.Bot.Apps.Handlers; + +/// +/// Delegate for handling meeting start event activities. +/// +public delegate Task MeetingStartHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling meeting end event activities. +/// +public delegate Task MeetingEndHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling meeting participant join event activities. +/// +public delegate Task MeetingParticipantJoinHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Delegate for handling meeting participant leave event activities. +/// +public delegate Task MeetingParticipantLeaveHandler(Context> context, CancellationToken cancellationToken = default); + +/// +/// Extension methods for registering meeting event activity handlers. +/// +public static class MeetingExtensions +{ + /// + /// Registers a handler for meeting start event activities. + /// + public static TeamsBotApplication OnMeetingStart(this TeamsBotApplication app, MeetingStartHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Event, EventNames.MeetingStart), + Selector = activity => activity.Name == EventNames.MeetingStart, + Handler = async (ctx, cancellationToken) => + { + EventActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for meeting end event activities. + /// + public static TeamsBotApplication OnMeetingEnd(this TeamsBotApplication app, MeetingEndHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Event, EventNames.MeetingEnd), + Selector = activity => activity.Name == EventNames.MeetingEnd, + Handler = async (ctx, cancellationToken) => + { + EventActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for meeting participant join event activities. + /// + public static TeamsBotApplication OnMeetingParticipantJoin(this TeamsBotApplication app, MeetingParticipantJoinHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Event, EventNames.MeetingParticipantJoin), + Selector = activity => activity.Name == EventNames.MeetingParticipantJoin, + Handler = async (ctx, cancellationToken) => + { + EventActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } + + /// + /// Registers a handler for meeting participant leave event activities. + /// + public static TeamsBotApplication OnMeetingParticipantLeave(this TeamsBotApplication app, MeetingParticipantLeaveHandler handler) + { + ArgumentNullException.ThrowIfNull(app, nameof(app)); + app.Router.Register(new Route + { + Name = string.Join("/", TeamsActivityType.Event, EventNames.MeetingParticipantLeave), + Selector = activity => activity.Name == EventNames.MeetingParticipantLeave, + Handler = async (ctx, cancellationToken) => + { + EventActivity typedActivity = new(ctx.Activity); + Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); + await handler(typedContext, cancellationToken).ConfigureAwait(false); + } + }); + + return app; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/EventActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/EventActivity.cs new file mode 100644 index 00000000..17739610 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/EventActivity.cs @@ -0,0 +1,119 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Represents an event activity. +/// +public class EventActivity : TeamsActivity +{ + /// + /// Creates an EventActivity from a CoreActivity. + /// + public static new EventActivity FromActivity(CoreActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + return new EventActivity(activity); + } + + /// + /// Gets or sets the name of the event. See for common values. + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// + /// Initializes a new instance of the class. + /// + [JsonConstructor] + public EventActivity() : base(TeamsActivityType.Event) + { + } + + /// + /// Initializes a new instance of the class with the specified name. + /// + public EventActivity(string name) : base(TeamsActivityType.Event) + { + Name = name; + } + + /// + /// Initializes a new instance of the class from a CoreActivity. + /// + protected EventActivity(CoreActivity activity) : base(activity) + { + if (activity.Properties.TryGetValue("name", out var name)) + { + Name = name?.ToString(); + activity.Properties.Remove("name"); + } + } +} + +/// +/// Represents an event activity with a strongly-typed value. +/// +/// The type of the value payload. +public class EventActivity : EventActivity +{ + /// + /// Gets or sets the strongly-typed value associated with the event activity. + /// Shadows the base class Value property, deserializing from the underlying JsonNode on access. + /// + public new TValue? Value + { + get => base.Value != null ? JsonSerializer.Deserialize(base.Value.ToJsonString()) : default; + set => base.Value = value != null ? JsonSerializer.SerializeToNode(value) : null; + } + + /// + /// Initializes a new instance of the class. + /// + public EventActivity() : base() + { + } + + /// + /// Initializes a new instance of the class with the specified name. + /// + public EventActivity(string name) : base(name) + { + } + + /// + /// Initializes a new instance of the class from an EventActivity. + /// + public EventActivity(EventActivity activity) : base(activity) + { + } +} + +/// +/// String constants for event activity names. +/// +public static class EventNames +{ + /// Meeting start event name. + public const string MeetingStart = "application/vnd.microsoft.meetingStart"; + + /// Meeting end event name. + public const string MeetingEnd = "application/vnd.microsoft.meetingEnd"; + + /// Meeting participant join event name. + public const string MeetingParticipantJoin = "application/vnd.microsoft.meetingParticipantJoin"; + + /// Meeting participant leave event name. + public const string MeetingParticipantLeave = "application/vnd.microsoft.meetingParticipantLeave"; + + //TODO : review read receipts + /* + /// Read receipt event name. Fired when a user reads a message in a 1:1 chat with the bot. + public const string ReadReceipt = "application/vnd.microsoft.readReceipt"; + */ +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MeetingValues.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MeetingValues.cs new file mode 100644 index 00000000..b5a5846a --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MeetingValues.cs @@ -0,0 +1,106 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Value payload for a meeting start event. +/// +public class MeetingStartValue +{ + /// The meeting's Id, encoded as a BASE64 string. + [JsonPropertyName("Id")] + public required string Id { get; set; } + + /// The meeting's type. + [JsonPropertyName("MeetingType")] + public string? MeetingType { get; set; } = string.Empty; + + /// The URL used to join the meeting. + [JsonPropertyName("JoinUrl")] + public Uri? JoinUrl { get; set; } + + /// The title of the meeting. + [JsonPropertyName("Title")] + public string? Title { get; set; } = string.Empty; + + /// Timestamp for meeting start, in UTC. + [JsonPropertyName("StartTime")] + public string? StartTime { get; set; } +} + +/// +/// Value payload for a meeting end event. +/// +public class MeetingEndValue +{ + /// The meeting's Id, encoded as a BASE64 string. + [JsonPropertyName("Id")] + public required string Id { get; set; } + + /// The meeting's type. + [JsonPropertyName("MeetingType")] + public string? MeetingType { get; set; } + + /// The URL used to join the meeting. + [JsonPropertyName("JoinUrl")] + public Uri? JoinUrl { get; set; } + + /// The title of the meeting. + [JsonPropertyName("Title")] + public string? Title { get; set; } + + /// Timestamp for meeting end, in UTC. + [JsonPropertyName("EndTime")] + public string? EndTime { get; set; } +} + +/// +/// Value payload for a meeting participant join event. +/// +public class MeetingParticipantJoinValue +{ + /// The list of participants who joined. + [JsonPropertyName("members")] + public IList Members { get; set; } = []; +} + +/// +/// Value payload for a meeting participant leave event. +/// +public class MeetingParticipantLeaveValue +{ + /// The list of participants who left. + [JsonPropertyName("members")] + public IList Members { get; set; } = []; +} + +/// +/// Represents a member in a meeting participant event. +/// +public class MeetingParticipantMember +{ + /// The participant's account. + [JsonPropertyName("user")] + public TeamsConversationAccount User { get; set; } = new(); + + /// The participant's meeting info. + [JsonPropertyName("meeting")] + public MeetingParticipantInfo Meeting { get; set; } = new(); +} + +/// +/// Represents a participant's meeting info. +/// +public class MeetingParticipantInfo +{ + /// Whether the user is currently in the meeting. + [JsonPropertyName("inMeeting")] + public bool InMeeting { get; set; } + + /// The participant's role in the meeting. + [JsonPropertyName("role")] + public string? Role { get; set; } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs index 4c855d52..c7c1df97 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityType.cs @@ -58,6 +58,24 @@ public static class TeamsActivityType /// public const string Invoke = "invoke"; + /// + /// Represents an event activity. + /// + public const string Event = "event"; + + //TODO : review command activity + /* + /// + /// Represents a command activity. + /// + public const string Command = "command"; + + /// + /// Represents a command result activity. + /// + public const string CommandResult = "commandResult"; + */ + /// /// Registry of activity type factories for creating specialized activity instances. /// @@ -71,5 +89,6 @@ public static class TeamsActivityType //[TeamsActivityType.EndOfConversation] = EndOfConversationActivity.FromActivity, [InstallationUpdate] = InstallUpdateActivity.FromActivity, [Invoke] = InvokeActivity.FromActivity, + [Event] = EventActivity.FromActivity }; } From 1ce3e0046b136caa27d51c5a431049ce321d57e2 Mon Sep 17 00:00:00 2001 From: Rido Date: Mon, 23 Feb 2026 12:44:23 -0800 Subject: [PATCH 60/69] Add ReplyToId support and simplify bot setup (#341) Introduced ReplyToId property in CoreActivity and builder, enabling reply tracking in activities. Updated ConversationClient to append ReplyToId to outgoing URLs and adjusted "agents" channel ID truncation. Simplified bot setup in Program.cs by removing telemetry and generic parameters. Added a default route overload for UseBotApplication. Minor logging and comment improvements. This pull request introduces improvements to how reply handling is managed in the bot framework, particularly around supporting and propagating the `ReplyToId` property in activities. The changes ensure that reply chains are correctly maintained and that conversation IDs are truncated to the correct length for the 'agents' channel. Additionally, the API for registering the bot application has been streamlined. **Reply handling and activity schema improvements:** * Added a `ReplyToId` property to the `CoreActivity` class, enabling activities to specify which message they are replying to. * Updated `CoreActivityBuilder` to set `ReplyToId` when copying from another activity and added a `WithReplyToId` method for explicit setting. [[1]](diffhunk://#diff-5e00975e375bcb87e6b0d28d2367d865865a1254f089cfcab0d6abbb5db4be38R52-R56) [[2]](diffhunk://#diff-5e00975e375bcb87e6b0d28d2367d865865a1254f089cfcab0d6abbb5db4be38R86-R96) **Message sending and routing improvements:** * Modified `SendActivityAsync` in `ConversationClient` to append `ReplyToId` to the outgoing message URL if present, ensuring replies are correctly threaded. Also, fixed conversation ID truncation for the 'agents' channel to a maximum of 100 characters (was 325). * Added a new overload of `UseBotApplication` to simplify bot application setup with a default route. **Sample and registration cleanup:** * Updated the sample bot (`CoreBot/Program.cs`) to use the new `AddBotApplication` and `UseBotApplication` APIs, and cleaned up reply message formatting. --- core/samples/CoreBot/Program.cs | 25 +-- .../Activities/MessageReactionActivity.cs | 6 - .../ConversationClient.cs | 9 +- .../Hosting/AddBotApplicationExtensions.cs | 11 ++ .../Schema/CoreActivity.cs | 5 + .../Schema/CoreActivityBuilder.cs | 16 ++ .../CompatActivityTests.cs | 2 +- .../ConversationClientTests.cs | 150 ++++++++++++++++++ 8 files changed, 194 insertions(+), 30 deletions(-) diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index 529a3ffb..c4d15f65 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -7,33 +7,16 @@ using Microsoft.Teams.Bot.Core.Schema; WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); -webAppBuilder.Services.AddOpenTelemetry().UseAzureMonitor(); -webAppBuilder.Services.AddBotApplication(); +webAppBuilder.Services.AddBotApplication(); WebApplication webApp = webAppBuilder.Build(); -BotApplication botApp = webApp.UseBotApplication(); webApp.MapGet("/", () => "CoreBot is running."); +BotApplication botApp = webApp.UseBotApplication(); botApp.OnActivity = async (activity, cancellationToken) => { - string replyText = $"CoreBot running on SDK {BotApplication.Version}."; - - replyText += $"
Received Activity `{activity.Type}`."; - - //activity.Properties.Where(kvp => kvp.Key.StartsWith("text")).ToList().ForEach(kvp => - //{ - // replyText += $"
{kvp.Key}:`{kvp.Value}` "; - //}); - - - string? conversationType = "unknown conversation type"; - if (activity.Conversation.Properties.TryGetValue("conversationType", out object? ctProp)) - { - conversationType = ctProp?.ToString(); - } - - replyText += $"
To conv type: `{conversationType}` conv id: `{activity.Conversation.Id}`"; - + string replyText = $"CoreBot running on SDK `{BotApplication.Version}`."; + CoreActivity replyActivity = CoreActivity.CreateBuilder() .WithType(ActivityType.Message) .WithConversationReference(activity) diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs index 0bad1baa..6960e52b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs @@ -86,12 +86,6 @@ protected MessageReactionActivity(CoreActivity activity) : base(activity) /// [JsonPropertyName("reactionsRemoved")] public IList? ReactionsRemoved { get; set; } - - /// - /// Gets or sets the ID of the message being reacted to. - /// - [JsonPropertyName("replyToId")] - public string? ReplyToId { get; set; } } /// diff --git a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs index c74886ba..ce93f9c3 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs @@ -47,8 +47,13 @@ public async Task SendActivityAsync(CoreActivity activity, { logger.LogInformation("Truncating conversation ID for 'agents' channel to comply with length restrictions."); string conversationId = activity.Conversation.Id; - string convId = conversationId.Length > 325 ? conversationId[..325] : conversationId; - url = $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{convId}/activities"; + string convId = conversationId.Length > 100 ? conversationId[..100] : conversationId; + url = $"{activity.ServiceUrl.ToString().TrimEnd('/')}/v3/conversations/{convId}/activities/"; + } + + if (!string.IsNullOrEmpty(activity.ReplyToId)) + { + url += activity.ReplyToId; } logger?.LogInformation("Sending activity to {Url}", url); diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 74c8a9e3..c99ffba9 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -28,6 +28,17 @@ public static class AddBotApplicationExtensions { internal const string MsalConfigKey = "AzureAd"; + /// + /// Initializes the default route + /// + /// + /// + /// + public static BotApplication UseBotApplication( + this IEndpointRouteBuilder endpoints, + string routePath = "api/messages") + => UseBotApplication(endpoints, routePath); + /// /// Configures the application to handle bot messages at the specified route and returns the registered bot /// application instance. diff --git a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs index 6ddd186e..6960e6bc 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs @@ -81,6 +81,11 @@ public class CoreActivity /// [JsonPropertyName("value")] public JsonNode? Value { get; set; } + /// + /// Reply to Id + /// + [JsonPropertyName("replyToId")] public string? ReplyToId { get; set; } + /// /// Gets the extension data dictionary for storing additional properties not defined in the schema. /// diff --git a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs index d05e635e..317435ea 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs @@ -49,6 +49,11 @@ public TBuilder WithConversationReference(TActivity activity) SetFrom(activity.Recipient); SetRecipient(activity.From); + if (!string.IsNullOrEmpty(activity.Id)) + { + WithReplyToId(activity.Id); + } + return (TBuilder)this; } @@ -78,6 +83,17 @@ public TBuilder WithId(string id) return (TBuilder)this; } + /// + /// Sets the Reply to id + /// + /// + /// + public TBuilder WithReplyToId(string replyToId) + { + _activity.ReplyToId = replyToId; + return (TBuilder)this; + } + /// /// Sets the service URL. /// diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs index a49b3b48..a629fc76 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs @@ -59,7 +59,7 @@ public void FromCompatActivity_PreservesTextAndMetadata() Assert.NotNull(coreActivity); Assert.Equal(activity.Text, coreActivity.Properties["text"]?.ToString()); Assert.Equal(activity.InputHint, coreActivity.Properties["inputHint"]?.ToString()); - Assert.Equal(activity.ReplyToId, coreActivity.Properties["replyToId"]?.ToString()); + Assert.Equal(activity.ReplyToId, coreActivity.ReplyToId); Assert.Equal(activity.Locale, coreActivity.Properties["locale"]?.ToString()); } diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs index 212d4927..c520b16b 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs @@ -2,6 +2,8 @@ // Licensed under the MIT License. using System.Net; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Teams.Bot.Core.Schema; using Moq; using Moq.Protected; @@ -168,4 +170,152 @@ public async Task SendActivityAsync_ConstructsCorrectUrl() Assert.Equal("https://test.service.url/v3/conversations/conv123/activities/", capturedRequest.RequestUri?.ToString()); Assert.Equal(HttpMethod.Post, capturedRequest.Method); } + + [Fact] + public async Task SendActivityAsync_WithReplyToId_AppendsReplyToIdToUrl() + { + HttpRequestMessage? capturedRequest = null; + Mock mockHttpMessageHandler = new(); + mockHttpMessageHandler + .Protected() + .Setup>( + "SendAsync", + ItExpr.IsAny(), + ItExpr.IsAny()) + .Callback((req, ct) => capturedRequest = req) + .ReturnsAsync(new HttpResponseMessage + { + StatusCode = HttpStatusCode.OK, + Content = new StringContent("{\"id\":\"activity123\"}") + }); + + HttpClient httpClient = new(mockHttpMessageHandler.Object); + ConversationClient conversationClient = new(httpClient); + + CoreActivity activity = new() + { + Type = ActivityType.Message, + Conversation = new Conversation { Id = "conv123" }, + ServiceUrl = new Uri("https://test.service.url/"), + ReplyToId = "originalActivity456" + }; + + await conversationClient.SendActivityAsync(activity); + + Assert.NotNull(capturedRequest); + Assert.Equal("https://test.service.url/v3/conversations/conv123/activities/originalActivity456", capturedRequest.RequestUri?.ToString()); + Assert.Equal(HttpMethod.Post, capturedRequest.Method); + } + + [Fact] + public async Task SendActivityAsync_WithEmptyReplyToId_DoesNotAppendReplyToIdToUrl() + { + HttpRequestMessage? capturedRequest = null; + Mock mockHttpMessageHandler = new(); + mockHttpMessageHandler + .Protected() + .Setup>( + "SendAsync", + ItExpr.IsAny(), + ItExpr.IsAny()) + .Callback((req, ct) => capturedRequest = req) + .ReturnsAsync(new HttpResponseMessage + { + StatusCode = HttpStatusCode.OK, + Content = new StringContent("{\"id\":\"activity123\"}") + }); + + HttpClient httpClient = new(mockHttpMessageHandler.Object); + ConversationClient conversationClient = new(httpClient); + + CoreActivity activity = new() + { + Type = ActivityType.Message, + Conversation = new Conversation { Id = "conv123" }, + ServiceUrl = new Uri("https://test.service.url/"), + ReplyToId = "" + }; + + await conversationClient.SendActivityAsync(activity); + + Assert.NotNull(capturedRequest); + Assert.Equal("https://test.service.url/v3/conversations/conv123/activities/", capturedRequest.RequestUri?.ToString()); + } + + [Fact] + public async Task SendActivityAsync_WithAgentsChannel_TruncatesConversationId() + { + HttpRequestMessage? capturedRequest = null; + Mock mockHttpMessageHandler = new(); + mockHttpMessageHandler + .Protected() + .Setup>( + "SendAsync", + ItExpr.IsAny(), + ItExpr.IsAny()) + .Callback((req, ct) => capturedRequest = req) + .ReturnsAsync(new HttpResponseMessage + { + StatusCode = HttpStatusCode.OK, + Content = new StringContent("{\"id\":\"activity123\"}") + }); + + HttpClient httpClient = new(mockHttpMessageHandler.Object); + ILogger logger = NullLogger.Instance; + ConversationClient conversationClient = new(httpClient, logger); + + string longConversationId = new('x', 150); + CoreActivity activity = new() + { + Type = ActivityType.Message, + ChannelId = "agents", + Conversation = new Conversation { Id = longConversationId }, + ServiceUrl = new Uri("https://test.service.url/") + }; + + await conversationClient.SendActivityAsync(activity); + + Assert.NotNull(capturedRequest); + string expectedTruncatedId = new('x', 100); + Assert.Equal($"https://test.service.url/v3/conversations/{expectedTruncatedId}/activities/", capturedRequest.RequestUri?.ToString()); + } + + [Fact] + public async Task SendActivityAsync_WithAgentsChannelAndReplyToId_TruncatesConversationIdAndAppendsReplyToId() + { + HttpRequestMessage? capturedRequest = null; + Mock mockHttpMessageHandler = new(); + mockHttpMessageHandler + .Protected() + .Setup>( + "SendAsync", + ItExpr.IsAny(), + ItExpr.IsAny()) + .Callback((req, ct) => capturedRequest = req) + .ReturnsAsync(new HttpResponseMessage + { + StatusCode = HttpStatusCode.OK, + Content = new StringContent("{\"id\":\"activity123\"}") + }); + + HttpClient httpClient = new(mockHttpMessageHandler.Object); + ILogger logger = NullLogger.Instance; + ConversationClient conversationClient = new(httpClient, logger); + + string longConversationId = new('x', 150); + CoreActivity activity = new() + { + Type = ActivityType.Message, + ChannelId = "agents", + Conversation = new Conversation { Id = longConversationId }, + ServiceUrl = new Uri("https://test.service.url/"), + ReplyToId = "replyActivity789" + }; + + await conversationClient.SendActivityAsync(activity); + + Assert.NotNull(capturedRequest); + string expectedTruncatedId = new('x', 100); + Assert.Equal($"https://test.service.url/v3/conversations/{expectedTruncatedId}/activities/replyActivity789", capturedRequest.RequestUri?.ToString()); + } } From f1eebceaaa806b858a899fb414e09b5547020e15 Mon Sep 17 00:00:00 2001 From: Kavin <115390646+singhk97@users.noreply.github.com> Date: Mon, 23 Feb 2026 15:59:33 -0500 Subject: [PATCH 61/69] Simplify BotApplication constructors with BotApplicationOptions (#342) ## Summary - Decoupling `IConfiguration` from the `TeamsBotApplication` and `BotApplication` classes since it's not clear what configurations are required. ## Test plan - [x] Verify bot starts and logs the correct AppID at startup - [x] Test with each config format: `MicrosoftAppId`, `CLIENT_ID`, and `AzureAd:ClientId` - [x] Confirm `BotApplicationOptions.AppId` defaults to empty string when no config key is present --------- Co-authored-by: Claude Sonnet 4.6 --- core/samples/PABot/InitCompatAdapter.cs | 16 ++- .../TeamsBotApplication.cs | 12 +- .../BotApplication.cs | 23 ++-- .../Hosting/AddBotApplicationExtensions.cs | 8 ++ .../Hosting/BotApplicationOptions.cs | 15 +++ .../CompatAdapterTests.cs | 6 +- .../BotApplicationTests.cs | 51 +++----- .../AddBotApplicationExtensionsTests.cs | 110 ++++++++++++++++++ .../MiddlewareTests.cs | 35 ++---- 9 files changed, 185 insertions(+), 91 deletions(-) create mode 100644 core/src/Microsoft.Teams.Bot.Core/Hosting/BotApplicationOptions.cs diff --git a/core/samples/PABot/InitCompatAdapter.cs b/core/samples/PABot/InitCompatAdapter.cs index a5804f56..81b1e8b5 100644 --- a/core/samples/PABot/InitCompatAdapter.cs +++ b/core/samples/PABot/InitCompatAdapter.cs @@ -80,17 +80,25 @@ private static void RegisterKeyedTeamsBotApplication(IServiceCollection services return new TeamsApiClient(httpClient, sp.GetRequiredService>()); }); + services.AddKeyedSingleton(keyName, (sp, _) => + { + return new BotApplicationOptions() + { + AppId = configSection["ClientId"] ?? string.Empty + }; + }); + // Register keyed TeamsBotApplication - services.AddKeyedSingleton(keyName, (sp, key) => + services.AddKeyedSingleton(keyName, (sp, key) => { return new TeamsBotApplication( sp.GetRequiredKeyedService(keyName), sp.GetRequiredKeyedService(keyName), sp.GetRequiredKeyedService(keyName), - sp.GetRequiredService(), + sp.GetRequiredKeyedService(keyName), sp.GetRequiredService(), - sp.GetRequiredService>(), - keyName); + sp.GetRequiredService>() + ); }); } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 50111fc8..19ebcb22 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -3,11 +3,11 @@ using Microsoft.AspNetCore.Http; using Microsoft.Teams.Bot.Core; -using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core.Hosting; namespace Microsoft.Teams.Bot.Apps; @@ -33,19 +33,17 @@ public class TeamsBotApplication : BotApplication /// /// /// - /// + /// Options containing the application (client) ID, used for logging and diagnostics. /// /// - /// public TeamsBotApplication( ConversationClient conversationClient, UserTokenClient userTokenClient, TeamsApiClient teamsApiClient, - IConfiguration config, + BotApplicationOptions options, IHttpContextAccessor httpContextAccessor, - ILogger logger, - string sectionName = "AzureAd") - : base(conversationClient, userTokenClient, config, logger, sectionName) + ILogger logger) + : base(conversationClient, userTokenClient, options, logger) { _teamsApiClient = teamsApiClient; Router = new Router(logger); diff --git a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index 565cbaf2..3cd543b1 100644 --- a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -4,8 +4,8 @@ using System.Diagnostics; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc.Formatters; -using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging; +using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Core; @@ -18,32 +18,25 @@ public class BotApplication private readonly ILogger _logger; private readonly ConversationClient? _conversationClient; private readonly UserTokenClient? _userTokenClient; - private readonly string _serviceKey; internal TurnMiddleware MiddleWare { get; } /// - /// Initializes a new instance of the BotApplication class with the specified conversation client, configuration, - /// logger, and optional service key. + /// Initializes a new instance of the BotApplication class with the specified conversation client, app ID, + /// and logger. /// - /// This constructor sets up the bot application and starts the bot listener using the provided - /// configuration and service key. The service key is used to locate authentication credentials in the - /// configuration. /// The client used to manage and interact with conversations for the bot. /// The client used to manage user tokens for authentication. - /// The application configuration settings used to retrieve environment variables and service credentials. + /// Options containing the application (client) ID, used for logging and diagnostics. /// The logger used to record operational and diagnostic information for the bot application. - /// The configuration key identifying the authentication service. Defaults to "AzureAd" if not specified. - public BotApplication(ConversationClient conversationClient, UserTokenClient userTokenClient, IConfiguration config, ILogger logger, string sectionName = "AzureAd") + public BotApplication(ConversationClient conversationClient, UserTokenClient userTokenClient, BotApplicationOptions options, ILogger logger) { - ArgumentNullException.ThrowIfNull(config); + ArgumentNullException.ThrowIfNull(options); + _logger = logger; - _serviceKey = sectionName; MiddleWare = new TurnMiddleware(); _conversationClient = conversationClient; _userTokenClient = userTokenClient; - string appId = config["MicrosoftAppId"] ?? config["CLIENT_ID"] ?? config[$"{sectionName}:ClientId"] ?? "Unknown AppID"; - logger.LogInformation(" Started {ThisType} listener \n on {Port} \n for AppID:{AppId} \n with SDK version {SdkVersion}", this.GetType().Name, config?["ASPNETCORE_URLS"], appId, Version); - + logger.LogInformation("Started {ThisType} listener for AppID:{AppId} with SDK version {SdkVersion}", this.GetType().Name, options.AppId, Version); } diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs index c99ffba9..df3a3f02 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -99,6 +99,14 @@ public static IServiceCollection AddBotApplication(this IServiceCollection ILogger logger = loggerFactory?.CreateLogger() ?? (ILogger)Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + services.AddSingleton(sp => + { + var config = sp.GetRequiredService(); + return new BotApplicationOptions + { + AppId = config["MicrosoftAppId"] ?? config["CLIENT_ID"] ?? config[$"{sectionName}:ClientId"] ?? string.Empty + }; + }); services.AddAuthorization(logger, sectionName); services.AddConversationClient(sectionName); services.AddUserTokenClient(sectionName); diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotApplicationOptions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotApplicationOptions.cs new file mode 100644 index 00000000..5e23f17b --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotApplicationOptions.cs @@ -0,0 +1,15 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace Microsoft.Teams.Bot.Core.Hosting; + +/// +/// Options for configuring a bot application instance. +/// +public sealed class BotApplicationOptions +{ + /// + /// Gets or sets the application (client) ID, used for logging and diagnostics. + /// + public string AppId { get; set; } = string.Empty; +} diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs index 36ce6bff..14a4a7fb 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs @@ -5,12 +5,10 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Schema; using Microsoft.Extensions.Configuration; -using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Teams.Bot.Apps; -using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; using Moq; namespace Microsoft.Teams.Bot.Compat.UnitTests @@ -87,7 +85,7 @@ private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() conversationClient, userTokenClient, teamsApiClient, - mockConfig.Object, + new BotApplicationOptions(), Mock.Of(), NullLogger.Instance); diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs index 9f0dc316..f953ea89 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs @@ -7,6 +7,7 @@ using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.Teams.Bot.Core.Hosting; using Moq; using Moq.Protected; @@ -19,12 +20,12 @@ public void Constructor_InitializesProperties() { ConversationClient conversationClient = CreateMockConversationClient(); UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, CreateOptions("test-app-id"), logger); Assert.NotNull(botApp); Assert.NotNull(botApp.ConversationClient); + Assert.NotNull(botApp.UserTokenClient); } @@ -32,11 +33,7 @@ public void Constructor_InitializesProperties() [Fact] public async Task ProcessAsync_WithNullHttpContext_ThrowsArgumentNullException() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); await Assert.ThrowsAsync(() => botApp.ProcessAsync(null!)); @@ -45,11 +42,7 @@ await Assert.ThrowsAsync(() => [Fact] public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); CoreActivity activity = new() { @@ -70,18 +63,13 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() await botApp.ProcessAsync(httpContext); - Assert.True(onActivityCalled); } [Fact] public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); CoreActivity activity = new() { @@ -121,11 +109,7 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() [Fact] public async Task ProcessAsync_WithException_ThrowsBotHandlerException() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); CoreActivity activity = new() { @@ -148,11 +132,7 @@ public async Task ProcessAsync_WithException_ThrowsBotHandlerException() [Fact] public void Use_AddsMiddlewareToChain() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); Mock mockMiddleware = new(); @@ -179,10 +159,9 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() HttpClient httpClient = new(mockHttpMessageHandler.Object); ConversationClient conversationClient = new(httpClient); - Mock mockConfig = new(); UserTokenClient userTokenClient = CreateMockUserTokenClient(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = new(conversationClient, userTokenClient, CreateOptions(), logger); CoreActivity activity = new() { @@ -200,16 +179,18 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() [Fact] public async Task SendActivityAsync_WithNullActivity_ThrowsArgumentNullException() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); await Assert.ThrowsAsync(() => botApp.SendActivityAsync(null!)); } + private static BotApplicationOptions CreateOptions(string appId = "") => + new() { AppId = appId }; + + private static BotApplication CreateBotApplication() => + new(CreateMockConversationClient(), CreateMockUserTokenClient(), CreateOptions(), NullLogger.Instance); + private static ConversationClient CreateMockConversationClient() { Mock mockHttpClient = new(); diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs index d13a72b8..c59a5110 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs @@ -213,4 +213,114 @@ public void AddConversationClient_WithCustomSectionName_ConfiguresFromCustomSect // Assert AssertMsalOptions(serviceProvider, "custom-client-id", "custom-tenant-id"); } + + // --- BotApplicationOptions (AppId) tests --- + + private static ServiceProvider BuildServiceProviderForBotApp(Dictionary configData, string? sectionName = null) + { + IConfigurationRoot configuration = new ConfigurationBuilder() + .AddInMemoryCollection(configData) + .Build(); + + ServiceCollection services = new(); + services.AddSingleton(configuration); + services.AddLogging(); + + if (sectionName is null) + services.AddBotApplication(); + else + services.AddBotApplication(sectionName); + + return services.BuildServiceProvider(); + } + + private static string GetAppId(ServiceProvider serviceProvider) => + serviceProvider.GetRequiredService().AppId; + + [Fact] + public void AddBotApplication_WithMicrosoftAppId_SetsAppIdFromMicrosoftAppId() + { + // Arrange + Dictionary configData = new() + { + ["MicrosoftAppId"] = "bf-app-id", + ["MicrosoftAppTenantId"] = "bf-tenant-id" + }; + + // Act + ServiceProvider serviceProvider = BuildServiceProviderForBotApp(configData); + + // Assert + Assert.Equal("bf-app-id", GetAppId(serviceProvider)); + } + + [Fact] + public void AddBotApplication_WithClientId_SetsAppIdFromClientId() + { + // Arrange + Dictionary configData = new() + { + ["CLIENT_ID"] = "core-client-id", + ["TENANT_ID"] = "core-tenant-id" + }; + + // Act + ServiceProvider serviceProvider = BuildServiceProviderForBotApp(configData); + + // Assert + Assert.Equal("core-client-id", GetAppId(serviceProvider)); + } + + [Fact] + public void AddBotApplication_WithAzureAdSection_SetsAppIdFromSection() + { + // Arrange + Dictionary configData = new() + { + ["AzureAd:ClientId"] = "azuread-client-id", + ["AzureAd:TenantId"] = "azuread-tenant-id" + }; + + // Act + ServiceProvider serviceProvider = BuildServiceProviderForBotApp(configData); + + // Assert + Assert.Equal("azuread-client-id", GetAppId(serviceProvider)); + } + + [Fact] + public void AddBotApplication_WithCustomSection_SetsAppIdFromCustomSection() + { + // Arrange + Dictionary configData = new() + { + ["CustomAuth:ClientId"] = "custom-client-id", + ["CustomAuth:TenantId"] = "custom-tenant-id" + }; + + // Act + ServiceProvider serviceProvider = BuildServiceProviderForBotApp(configData, "CustomAuth"); + + // Assert + Assert.Equal("custom-client-id", GetAppId(serviceProvider)); + } + + [Fact] + public void AddBotApplication_MicrosoftAppIdTakesPrecedenceOverClientId() + { + // Arrange — both keys present; MicrosoftAppId is highest priority + Dictionary configData = new() + { + ["MicrosoftAppId"] = "bf-app-id", + ["MicrosoftAppTenantId"] = "bf-tenant-id", + ["CLIENT_ID"] = "core-client-id", + ["TENANT_ID"] = "core-tenant-id" + }; + + // Act + ServiceProvider serviceProvider = BuildServiceProviderForBotApp(configData); + + // Assert + Assert.Equal("bf-app-id", GetAppId(serviceProvider)); + } } diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs index be9d1fd6..0aeb35e1 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs @@ -6,6 +6,7 @@ using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.Teams.Bot.Core.Hosting; using Moq; namespace Microsoft.Teams.Bot.Core.UnitTests; @@ -15,11 +16,7 @@ public class MiddlewareTests [Fact] public async Task BotApplication_Use_AddsMiddlewareToChain() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); Mock mockMiddleware = new(); @@ -32,11 +29,7 @@ public async Task BotApplication_Use_AddsMiddlewareToChain() [Fact] public async Task Middleware_ExecutesInOrder() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); List executionOrder = []; @@ -86,11 +79,7 @@ public async Task Middleware_ExecutesInOrder() [Fact] public async Task Middleware_CanShortCircuit() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); bool secondMiddlewareCalled = false; bool onActivityCalled = false; @@ -133,11 +122,7 @@ public async Task Middleware_CanShortCircuit() [Fact] public async Task Middleware_ReceivesCancellationToken() { - ConversationClient conversationClient = CreateMockConversationClient(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - Mock mockConfig = new(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); CancellationToken receivedToken = default; @@ -172,12 +157,7 @@ public async Task Middleware_ReceivesCancellationToken() [Fact] public async Task Middleware_ReceivesActivity() { - ConversationClient conversationClient = CreateMockConversationClient(); - - Mock mockConfig = new(); - UserTokenClient userTokenClient = CreateMockUserTokenClient(); - NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, mockConfig.Object, logger); + BotApplication botApp = CreateBotApplication(); CoreActivity? receivedActivity = null; @@ -208,6 +188,9 @@ public async Task Middleware_ReceivesActivity() Assert.Equal(ActivityType.Message, receivedActivity.Type); } + private static BotApplication CreateBotApplication() => + new(CreateMockConversationClient(), CreateMockUserTokenClient(), new(), NullLogger.Instance); + private static ConversationClient CreateMockConversationClient() { Mock mockHttpClient = new(); From a3d68342f6c400eb167c4f21c9163b1e5cf54992 Mon Sep 17 00:00:00 2001 From: Kavin <115390646+singhk97@users.noreply.github.com> Date: Wed, 25 Feb 2026 15:21:25 -0500 Subject: [PATCH 62/69] Make BotApplicationOptions an optional parameter (#345) When setting up components manually BotApplicationOptions is probably the least important argument. So it makes sense to make it optional. --------- Co-authored-by: Claude Sonnet 4.6 --- core/samples/PABot/InitCompatAdapter.cs | 8 -------- .../Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs | 8 ++++---- core/src/Microsoft.Teams.Bot.Core/BotApplication.cs | 10 ++++++---- .../CompatAdapterTests.cs | 2 -- .../BotApplicationTests.cs | 9 +++++---- .../MiddlewareTests.cs | 3 +-- 6 files changed, 16 insertions(+), 24 deletions(-) diff --git a/core/samples/PABot/InitCompatAdapter.cs b/core/samples/PABot/InitCompatAdapter.cs index 81b1e8b5..874bf1e3 100644 --- a/core/samples/PABot/InitCompatAdapter.cs +++ b/core/samples/PABot/InitCompatAdapter.cs @@ -80,13 +80,6 @@ private static void RegisterKeyedTeamsBotApplication(IServiceCollection services return new TeamsApiClient(httpClient, sp.GetRequiredService>()); }); - services.AddKeyedSingleton(keyName, (sp, _) => - { - return new BotApplicationOptions() - { - AppId = configSection["ClientId"] ?? string.Empty - }; - }); // Register keyed TeamsBotApplication services.AddKeyedSingleton(keyName, (sp, key) => @@ -95,7 +88,6 @@ private static void RegisterKeyedTeamsBotApplication(IServiceCollection services sp.GetRequiredKeyedService(keyName), sp.GetRequiredKeyedService(keyName), sp.GetRequiredKeyedService(keyName), - sp.GetRequiredKeyedService(keyName), sp.GetRequiredService(), sp.GetRequiredService>() ); diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 19ebcb22..1bc09259 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -33,17 +33,17 @@ public class TeamsBotApplication : BotApplication /// /// /// - /// Options containing the application (client) ID, used for logging and diagnostics. /// /// + /// Options containing the application (client) ID, used for logging and diagnostics. Defaults to an empty instance if not provided. public TeamsBotApplication( ConversationClient conversationClient, UserTokenClient userTokenClient, TeamsApiClient teamsApiClient, - BotApplicationOptions options, IHttpContextAccessor httpContextAccessor, - ILogger logger) - : base(conversationClient, userTokenClient, options, logger) + ILogger logger, + BotApplicationOptions? options = null) + : base(conversationClient, userTokenClient, logger, options) { _teamsApiClient = teamsApiClient; Router = new Router(logger); diff --git a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index 3cd543b1..b77ff7cd 100644 --- a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -23,20 +23,22 @@ public class BotApplication /// /// Initializes a new instance of the BotApplication class with the specified conversation client, app ID, /// and logger. + /// Initializes a new instance of the BotApplication class with the specified conversation client, app ID, + /// and logger. /// /// The client used to manage and interact with conversations for the bot. /// The client used to manage user tokens for authentication. - /// Options containing the application (client) ID, used for logging and diagnostics. /// The logger used to record operational and diagnostic information for the bot application. - public BotApplication(ConversationClient conversationClient, UserTokenClient userTokenClient, BotApplicationOptions options, ILogger logger) + /// Options containing the application (client) ID, used for logging and diagnostics. Defaults to an empty instance if not provided. + public BotApplication(ConversationClient conversationClient, UserTokenClient userTokenClient, ILogger logger, BotApplicationOptions? options = null) { - ArgumentNullException.ThrowIfNull(options); - + options ??= new(); _logger = logger; MiddleWare = new TurnMiddleware(); _conversationClient = conversationClient; _userTokenClient = userTokenClient; logger.LogInformation("Started {ThisType} listener for AppID:{AppId} with SDK version {SdkVersion}", this.GetType().Name, options.AppId, Version); + logger.LogInformation("Started {ThisType} listener for AppID:{AppId} with SDK version {SdkVersion}", this.GetType().Name, options.AppId, Version); } diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs index 14a4a7fb..33813b4f 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs @@ -8,7 +8,6 @@ using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Core; -using Microsoft.Teams.Bot.Core.Hosting; using Moq; namespace Microsoft.Teams.Bot.Compat.UnitTests @@ -85,7 +84,6 @@ private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() conversationClient, userTokenClient, teamsApiClient, - new BotApplicationOptions(), Mock.Of(), NullLogger.Instance); diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs index f953ea89..252a8cbc 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs @@ -22,10 +22,11 @@ public void Constructor_InitializesProperties() UserTokenClient userTokenClient = CreateMockUserTokenClient(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, CreateOptions("test-app-id"), logger); + BotApplication botApp = new(conversationClient, userTokenClient, logger, CreateOptions("test-app-id")); Assert.NotNull(botApp); Assert.NotNull(botApp.ConversationClient); Assert.NotNull(botApp.UserTokenClient); + Assert.NotNull(botApp.UserTokenClient); } @@ -161,7 +162,7 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() ConversationClient conversationClient = new(httpClient); UserTokenClient userTokenClient = CreateMockUserTokenClient(); NullLogger logger = NullLogger.Instance; - BotApplication botApp = new(conversationClient, userTokenClient, CreateOptions(), logger); + BotApplication botApp = new(conversationClient, userTokenClient, logger); CoreActivity activity = new() { @@ -185,11 +186,11 @@ await Assert.ThrowsAsync(() => botApp.SendActivityAsync(null!)); } - private static BotApplicationOptions CreateOptions(string appId = "") => + private static BotApplicationOptions CreateOptions(string appId) => new() { AppId = appId }; private static BotApplication CreateBotApplication() => - new(CreateMockConversationClient(), CreateMockUserTokenClient(), CreateOptions(), NullLogger.Instance); + new(CreateMockConversationClient(), CreateMockUserTokenClient(), NullLogger.Instance); private static ConversationClient CreateMockConversationClient() { diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs index 0aeb35e1..350db477 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs @@ -6,7 +6,6 @@ using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging.Abstractions; -using Microsoft.Teams.Bot.Core.Hosting; using Moq; namespace Microsoft.Teams.Bot.Core.UnitTests; @@ -189,7 +188,7 @@ public async Task Middleware_ReceivesActivity() } private static BotApplication CreateBotApplication() => - new(CreateMockConversationClient(), CreateMockUserTokenClient(), new(), NullLogger.Instance); + new(CreateMockConversationClient(), CreateMockUserTokenClient(), NullLogger.Instance); private static ConversationClient CreateMockConversationClient() { From 576d55c2f2dfc3e34c3876d3c0d78f34cfdb398b Mon Sep 17 00:00:00 2001 From: Mehak Bindra Date: Thu, 26 Feb 2026 17:16:40 -0800 Subject: [PATCH 63/69] Routing: run all handlers sequentially and add startup validation (#343) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Summary - All matching routes now run sequentially for non-invoke activities. Previously only the first matching route executed, silently swallowing any subsequent handlers. Registration order is preserved. - Invoke routing remains first-match-wins. Invoke activities require exactly one InvokeResponse back to Teams — running multiple handlers is undefined behaviour. - Startup throws if OnInvoke and specific invoke handlers are mixed. Registering both OnInvoke and eg. OnAdaptiveCardAction guarantees one response is silently swallowed. The valid approaches are: OnInvoke exclusively with an internal if/else, or specific handlers exclusively. - Startup throws if the same route is registered twice. Duplicate registration is assumed to be a bug. - Removed ILogger from Router. The logger passed was ILogger. Startup errors now throw exceptions instead of logging. --- core/samples/TeamsBot/Program.cs | 6 +- .../Microsoft.Teams.Bot.Apps.csproj | 4 + .../Routing/Router.cs | 79 +++++++------ .../RouterTests.cs | 108 ++++++++++++++++++ 4 files changed, 160 insertions(+), 37 deletions(-) create mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/RouterTests.cs diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 1e45225c..54bc1fcf 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -176,7 +176,11 @@ [Visit Microsoft](https://www.microsoft.com) { var action = context.Activity.Action ?? "unknown"; Console.WriteLine($"[InstallUpdate] Installation action: {action}"); - await context.SendActivityAsync($"Installation update: {action}", cancellationToken); + + if (context.Activity.Action != InstallUpdateActions.Remove) + { + await context.SendActivityAsync($"Installation update: {action}", cancellationToken); + } }); teamsApp.OnInstall(async (context, cancellationToken) => diff --git a/core/src/Microsoft.Teams.Bot.Apps/Microsoft.Teams.Bot.Apps.csproj b/core/src/Microsoft.Teams.Bot.Apps/Microsoft.Teams.Bot.Apps.csproj index a25e40ad..bcc1e6bb 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Microsoft.Teams.Bot.Apps.csproj +++ b/core/src/Microsoft.Teams.Bot.Apps/Microsoft.Teams.Bot.Apps.csproj @@ -10,4 +10,8 @@ + + + + diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs index f8be8f1f..0155ad0e 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -1,6 +1,5 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. - using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps.Schema; @@ -9,9 +8,16 @@ namespace Microsoft.Teams.Bot.Apps.Routing; /// /// Router for dispatching Teams activities to registered routes /// -internal sealed class Router(ILogger logger) +// TODO : add inline docs to handlers for breaking change +internal sealed class Router { private readonly List _routes = []; + private readonly ILogger _logger; + + internal Router(ILogger logger) + { + _logger = logger; + } /// /// Routes registered in the router. @@ -19,19 +25,38 @@ internal sealed class Router(ILogger logger) public IReadOnlyList GetRoutes() => _routes.AsReadOnly(); /// - /// Registers a route. Routes are checked in registration order. - /// IMPORTANT: Register specific routes before general catch-all routes. - /// Call Next() in handlers to continue to the next matching route. + /// Registers a route. Routes are checked and invoked in registration order. + /// For non-invoke activities all matching routes run sequentially. + /// For invoke activities — routes must be non-overlapping. /// + /// + /// Thrown if a route with the same name is already registered, or if an invoke catch-all + /// is mixed with specific invoke handlers. + /// public Router Register(Route route) where TActivity : TeamsActivity { + if (_routes.Any(r => r.Name == route.Name)) + { + throw new InvalidOperationException($"A route with name '{route.Name}' is already registered."); + } + + string invokePrefix = TeamsActivityType.Invoke + "/"; + + if (route.Name == TeamsActivityType.Invoke && _routes.Any(r => r.Name.StartsWith(invokePrefix, StringComparison.Ordinal))) + { + throw new InvalidOperationException("Cannot register a catch-all invoke handler when specific invoke handlers are already registered. Use specific handlers or handle all invoke types inside OnInvoke."); + } + + if (route.Name.StartsWith(invokePrefix, StringComparison.Ordinal) && _routes.Any(r => r.Name == TeamsActivityType.Invoke)) + { + throw new InvalidOperationException($"Cannot register '{route.Name}' when a catch-all invoke handler is already registered. Remove OnInvoke or use specific handlers exclusively."); + } _routes.Add(route); return this; } /// - /// Dispatches the activity to the first matching route. - /// Routes are checked in registration order. + /// Dispatches the activity to all matching routes in registration order. /// public async Task DispatchAsync(Context ctx, CancellationToken cancellationToken = default) { @@ -39,30 +64,21 @@ public async Task DispatchAsync(Context ctx, CancellationToken ca var matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); - if (matchingRoutes.Count == 0 && _routes.Count > 0) - { - logger.LogDebug( - "No routes matched activity type '{Type}'", - ctx.Activity.Type - ); + if (matchingRoutes.Count == 0 && _routes.Count>0) + { + _logger.LogDebug("No routes matched activity of type '{Type}'.", ctx.Activity.Type); return; } - if (matchingRoutes.Count > 1) + foreach (var route in matchingRoutes) { - logger.LogWarning( - "Activity type '{Type}' matched {Count} routes: [{Routes}]. Only the first route will execute without Next().", - ctx.Activity.Type, - matchingRoutes.Count, - string.Join(", ", matchingRoutes.Select(r => r.Name)) - ); + _logger.LogDebug("Dispatching '{Type}' activity to route '{Name}'.", ctx.Activity.Type, route.Name); + await route.InvokeRoute(ctx, cancellationToken).ConfigureAwait(false); } - - await matchingRoutes[0].InvokeRoute(ctx, cancellationToken).ConfigureAwait(false); } /// - /// Dispatches the specified activity context to all matching routes and returns the result of the invocation. + /// Dispatches the specified activity context to the first matching route and returns the result of the invocation. /// /// The activity context to dispatch. Cannot be null. /// A cancellation token that can be used to cancel the operation. @@ -73,26 +89,17 @@ public async Task DispatchWithReturnAsync(Context ArgumentNullException.ThrowIfNull(ctx); var matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); + var name = ctx.Activity is InvokeActivity inv ? inv.Name : null; if (matchingRoutes.Count == 0 && _routes.Count > 0) { - logger.LogWarning( - "No routes matched activity type '{Type}'", - ctx.Activity.Type - ); + _logger.LogDebug("No routes matched invoke activity with name '{Name}'; handler will not execute.", name); return null!; // TODO : return appropriate response } - if (matchingRoutes.Count > 1) - { - logger.LogWarning( - "Activity type '{Type}' matched {Count} routes: [{Routes}]. Only the first route will execute without Next().", - ctx.Activity.Type, - matchingRoutes.Count, - string.Join(", ", matchingRoutes.Select(r => r.Name)) - ); - } + _logger.LogDebug("Dispatching invoke activity with name '{Name}' to route '{Route}'", name, matchingRoutes[0].Name); return await matchingRoutes[0].InvokeRouteWithReturn(ctx, cancellationToken).ConfigureAwait(false); } + } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/RouterTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/RouterTests.cs new file mode 100644 index 00000000..f599a228 --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/RouterTests.cs @@ -0,0 +1,108 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.Teams.Bot.Apps.Routing; +using Microsoft.Teams.Bot.Apps.Schema; + +namespace Microsoft.Teams.Bot.Apps.UnitTests; + +public class RouterTests +{ + private static Route MakeRoute(string name) where TActivity : TeamsActivity + => new() { Name = name, Selector = _ => true }; + + // ==================== Duplicate name ==================== + + [Fact] + public void Register_DuplicateName_Throws() + { + var router = new Router(NullLogger.Instance); + router.Register(MakeRoute("Message")); + + var ex = Assert.Throws(() + => router.Register(MakeRoute("Message"))); + + Assert.Contains("Message", ex.Message); + } + + [Fact] + public void Register_UniqueNames_Succeeds() + { + var router = new Router(NullLogger.Instance); + router.Register(MakeRoute("Message/hello")); + router.Register(MakeRoute("Message/bye")); + + Assert.Equal(2, router.GetRoutes().Count); + } + + // ==================== Invoke conflict ==================== + + [Fact] + public void Register_CatchAllInvokeAfterSpecific_Throws() + { + var router = new Router(NullLogger.Instance); + router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.AdaptiveCardAction}")); + + var ex = Assert.Throws(() + => router.Register(MakeRoute(TeamsActivityType.Invoke))); + + Assert.Contains("catch-all", ex.Message); + } + + [Fact] + public void Register_SpecificInvokeAfterCatchAll_Throws() + { + var router = new Router(NullLogger.Instance); + router.Register(MakeRoute(TeamsActivityType.Invoke)); + + var ex = Assert.Throws(() + => router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.TaskFetch}"))); + + Assert.Contains("invoke", ex.Message); + } + + [Fact] + public void Register_MultipleCatchAllInvokes_ThrowsDuplicateName() + { + var router = new Router(NullLogger.Instance); + router.Register(MakeRoute(TeamsActivityType.Invoke)); + + Assert.Throws(() + => router.Register(MakeRoute(TeamsActivityType.Invoke))); + } + + [Fact] + public void Register_MultipleSpecificInvokeHandlers_Succeeds() + { + var router = new Router(NullLogger.Instance); + router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.AdaptiveCardAction}")); + router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.TaskFetch}")); + router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.TaskSubmit}")); + + Assert.Equal(3, router.GetRoutes().Count); + } + + // ==================== Non-invoke catch-all + specific is allowed ==================== + + [Fact] + public void Register_ConversationUpdateCatchAllAndSpecific_Succeeds() + { + var router = new Router(NullLogger.Instance); + router.Register(MakeRoute(TeamsActivityType.ConversationUpdate)); + router.Register(MakeRoute($"{TeamsActivityType.ConversationUpdate}/membersAdded")); + + Assert.Equal(2, router.GetRoutes().Count); + } + + [Fact] + public void Register_InstallUpdateCatchAllAndSpecific_Succeeds() + { + var router = new Router(NullLogger.Instance); + router.Register(MakeRoute(TeamsActivityType.InstallationUpdate)); + router.Register(MakeRoute($"{TeamsActivityType.InstallationUpdate}/add")); + router.Register(MakeRoute($"{TeamsActivityType.InstallationUpdate}/remove")); + + Assert.Equal(3, router.GetRoutes().Count); + } +} From 71db83aeeba83d6e00d78af36f110ea40ac87d7f Mon Sep 17 00:00:00 2001 From: Rido Date: Fri, 27 Feb 2026 11:35:01 -0800 Subject: [PATCH 64/69] Refactor for type safety and code clarity (#356) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## No new features; focus is on code quality. Explicit types replace var throughout for improved readability and maintainability. Formatting and whitespace are standardized. Property accessors use object? for nullability. Dependency injection and routing use explicit types. Comments and documentation clarified. Minor bug fixes and copyright headers updated. This pull request primarily focuses on code cleanup and modernization across several files, including improvements to copyright headers, variable declarations, and import ordering. The changes help standardize the codebase and make it more readable and maintainable. **Copyright and Licensing Updates:** * Updated copyright headers in `Route.cs` and `Router.cs` to remove "All rights reserved" and ensure consistency with MIT licensing. [[1]](diffhunk://#diff-770b878e7b1d580f51d38d08640ad9a37b9234dd9f80d1365738f44f225a8f56L1-R1) [[2]](diffhunk://#diff-39661a1e6d086cf06cff19e9627a3424084ccb66df2254a6b56623ef4ccf5016L1-R3) * Added proper copyright and licensing information to `GlobalSuppressions.cs`. **Code Style Improvements:** * Replaced explicit variable declarations with type inference (e.g., `var` → `List`) in `Router.cs` to improve readability and clarity. [[1]](diffhunk://#diff-39661a1e6d086cf06cff19e9627a3424084ccb66df2254a6b56623ef4ccf5016L65-R74) [[2]](diffhunk://#diff-39661a1e6d086cf06cff19e9627a3424084ccb66df2254a6b56623ef4ccf5016L91-R92) * Updated regex instantiation in `MessageHandler.cs` to use target-typed `new` for conciseness. **Import and Namespace Ordering:** * Reordered and cleaned up using statements in `EchoBot.cs`, `Program.cs`, and `SimpleGraphClient.cs` for better organization and consistency. [[1]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL7-R13) [[2]](diffhunk://#diff-62be1f70aaabb519334fe39cd50c0e25a98717ebb9fab85b688832917c9c75bbL6-R10) [[3]](diffhunk://#diff-891dee2b4796177cac44609d7ec803a964633f9f214eb096a70aa612910c2ce6R10-L15) * Removed unnecessary using statements in `Context.cs`. **Type Safety Enhancements:** * Improved type safety in `ConversationUpdateActivity.cs` by explicitly specifying `object?` in property retrievals. [[1]](diffhunk://#diff-8f9b05b82c5484251ba864fad6bd6ec711ff8b9d4ef23929c7122f8cbc23f05aL68-R68) [[2]](diffhunk://#diff-8f9b05b82c5484251ba864fad6bd6ec711ff8b9d4ef23929c7122f8cbc23f05aL81-R81) --- core/samples/AllInvokesBot/Cards.cs | 2 +- core/samples/AllInvokesBot/Program.cs | 2 +- core/samples/CompatBot/EchoBot.cs | 6 +- core/samples/CompatBot/Program.cs | 5 +- core/samples/CoreBot/Program.cs | 2 +- core/samples/MessageExtensionBot/Program.cs | 6 +- core/samples/PABot/Bots/DialogBot.cs | 2 +- core/samples/PABot/Bots/SsoBot.cs | 4 +- core/samples/PABot/Bots/TeamsBot.cs | 2 +- core/samples/PABot/PACustomAuthHandler.cs | 2 +- core/samples/PABot/Program.cs | 4 +- core/samples/PABot/SimpleGraphClient.cs | 4 +- core/samples/TeamsBot/Program.cs | 2 +- core/src/Microsoft.Teams.Bot.Apps/Context.cs | 1 - .../GlobalSuppressions.cs | 6 +- .../Handlers/MessageHandler.cs | 2 +- .../Handlers/TaskHandler.cs | 6 +- .../Microsoft.Teams.Bot.Apps/Routing/Route.cs | 4 +- .../Routing/Router.cs | 11 +- .../Activities/ConversationUpdateActivity.cs | 4 +- .../Schema/Activities/EventActivity.cs | 2 +- .../Activities/InstallUpdateActivity.cs | 2 +- .../Schema/Activities/InvokeActivity.cs | 64 ++++---- .../Schema/Activities/MessageActivity.cs | 6 +- .../Activities/MessageDeleteActivity.cs | 1 - .../Activities/MessageReactionActivity.cs | 6 +- .../Schema/Entities/ClientInfoEntity.cs | 8 +- .../Schema/Entities/MentionEntity.cs | 4 +- .../Schema/Entities/OMessageEntity.cs | 2 +- .../Schema/Entities/ProductInfoEntity.cs | 2 +- .../Schema/Entities/SensitiveUsageEntity.cs | 6 +- .../Schema/Entities/StreamInfoEntity.cs | 8 +- .../Schema/Invokes/InvokeResponse.cs | 2 +- .../Schema/Invokes/TaskModuleResponse.cs | 2 +- .../Schema/TeamsActivity.cs | 2 +- .../Schema/TeamsConversationAccount.cs | 2 +- .../TeamsBotApplication.HostingExtensions.cs | 3 +- .../TeamsBotApplication.cs | 3 +- .../CompatActivity.cs | 6 +- .../CompatConversations.cs | 2 +- .../CompatHostingExtensions.cs | 2 +- .../CompatTeamsInfo.Models.cs | 8 +- .../CompatTeamsInfo.cs | 145 +++++++++--------- .../GlobalSuppressions.cs | 6 +- .../BotApplication.cs | 4 +- .../GlobalSuppressions.cs | 6 +- .../Hosting/AddBotApplicationExtensions.cs | 20 ++- .../Hosting/BotAuthenticationHandler.cs | 6 +- .../Hosting/JwtExtensions.cs | 25 ++- core/test/ABSTokenServiceClient/Program.cs | 2 +- .../UserTokenCLIService.cs | 2 +- .../MessageActivityTests.cs | 2 +- .../CompatActivityTests.cs | 4 +- .../BotApplicationTests.cs | 2 +- .../AddBotApplicationExtensionsTests.cs | 2 +- .../MiddlewareTests.cs | 2 +- core/test/msal-config-api/Program.cs | 6 +- 57 files changed, 220 insertions(+), 234 deletions(-) diff --git a/core/samples/AllInvokesBot/Cards.cs b/core/samples/AllInvokesBot/Cards.cs index e16d35c5..196c20a2 100644 --- a/core/samples/AllInvokesBot/Cards.cs +++ b/core/samples/AllInvokesBot/Cards.cs @@ -127,7 +127,7 @@ public static JsonObject CreateTaskModuleCard() ["title"] = "Submit" } } - }; + }; } public static JsonObject CreateFileInfoCard(string? uniqueId, string? fileType) diff --git a/core/samples/AllInvokesBot/Program.cs b/core/samples/AllInvokesBot/Program.cs index d0aed19c..b0e9db01 100644 --- a/core/samples/AllInvokesBot/Program.cs +++ b/core/samples/AllInvokesBot/Program.cs @@ -103,7 +103,7 @@ string? contentUrl = uploadInfo?.ContentUrl?.ToString(); string? uniqueId = uploadInfo?.UniqueId; - if (uploadUrl!=null && contentUrl != null) + if (uploadUrl != null && contentUrl != null) { // Create sample file content string fileContent = "This is a sample file uploaded via file consent!"; diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 5853a8c0..1aadf094 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -4,13 +4,13 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Teams; using Microsoft.Bot.Connector; -using Microsoft.Teams.Bot.Core; -using Microsoft.Teams.Bot.Compat; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Bot.Schema; using Microsoft.Bot.Schema.Teams; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Compat; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Schema; using Newtonsoft.Json.Linq; namespace CompatBot; diff --git a/core/samples/CompatBot/Program.cs b/core/samples/CompatBot/Program.cs index 172cefae..673bea7e 100644 --- a/core/samples/CompatBot/Program.cs +++ b/core/samples/CompatBot/Program.cs @@ -3,12 +3,11 @@ using Azure.Monitor.OpenTelemetry.AspNetCore; using CompatBot; - using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; -using Microsoft.Teams.Bot.Core; -using Microsoft.Teams.Bot.Compat; using Microsoft.Bot.Schema; +using Microsoft.Teams.Bot.Compat; +using Microsoft.Teams.Bot.Core; // using Microsoft.Bot.Connector.Authentication; diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index c4d15f65..9357442f 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -16,7 +16,7 @@ botApp.OnActivity = async (activity, cancellationToken) => { string replyText = $"CoreBot running on SDK `{BotApplication.Version}`."; - + CoreActivity replyActivity = CoreActivity.CreateBuilder() .WithType(ActivityType.Message) .WithConversationReference(activity) diff --git a/core/samples/MessageExtensionBot/Program.cs b/core/samples/MessageExtensionBot/Program.cs index 4ae569ce..0297beab 100644 --- a/core/samples/MessageExtensionBot/Program.cs +++ b/core/samples/MessageExtensionBot/Program.cs @@ -205,10 +205,10 @@ var query = context.Activity.Value; - var action = new + var action = new { Type = "openUrl", - Value = "https://www.microsoft.com" + Value = "https://www.microsoft.com" }; return MessageExtensionResponse.CreateBuilder() @@ -257,4 +257,4 @@ }); */ -bot.Run(); \ No newline at end of file +bot.Run(); diff --git a/core/samples/PABot/Bots/DialogBot.cs b/core/samples/PABot/Bots/DialogBot.cs index 89052cf3..114e65cc 100644 --- a/core/samples/PABot/Bots/DialogBot.cs +++ b/core/samples/PABot/Bots/DialogBot.cs @@ -81,4 +81,4 @@ protected override async Task OnMessageActivityAsync( await _dialog.RunAsync(turnContext, _conversationState.CreateProperty(nameof(DialogState)), cancellationToken); } } -} \ No newline at end of file +} diff --git a/core/samples/PABot/Bots/SsoBot.cs b/core/samples/PABot/Bots/SsoBot.cs index 9c1fb6aa..f778c381 100644 --- a/core/samples/PABot/Bots/SsoBot.cs +++ b/core/samples/PABot/Bots/SsoBot.cs @@ -40,9 +40,9 @@ protected override async Task OnMessageActivityAsync(ITurnContext(nameof(DialogState)), cancellationToken); } } -} \ No newline at end of file +} diff --git a/core/samples/PABot/PACustomAuthHandler.cs b/core/samples/PABot/PACustomAuthHandler.cs index 3eb142f3..04a524ad 100644 --- a/core/samples/PABot/PACustomAuthHandler.cs +++ b/core/samples/PABot/PACustomAuthHandler.cs @@ -20,7 +20,7 @@ internal class PACustomAuthHandler( private readonly ILogger _logger = logger ?? throw new ArgumentNullException(nameof(logger)); private readonly string _scope = scope ?? throw new ArgumentNullException(nameof(scope)); private readonly IOptions? _managedIdentityOptions = managedIdentityOptions; - + /// /// Key used to store the agentic identity in HttpRequestMessage options. /// diff --git a/core/samples/PABot/Program.cs b/core/samples/PABot/Program.cs index 731de0f3..da3d1f5b 100644 --- a/core/samples/PABot/Program.cs +++ b/core/samples/PABot/Program.cs @@ -54,10 +54,10 @@ var adapterTwo = app.Services.GetRequiredKeyedService("AdapterTwo"); // Map endpoints with their respective adapters and authorization policies -app.MapPost("/api/messages", (HttpRequest request, HttpResponse response, [FromKeyedServices("EchoBot")]IBot bot, CancellationToken ct) => +app.MapPost("/api/messages", (HttpRequest request, HttpResponse response, [FromKeyedServices("EchoBot")] IBot bot, CancellationToken ct) => adapterOne.ProcessAsync(request, response, bot, ct)).RequireAuthorization("AdapterOne"); -app.MapPost("/api/v2/messages", (HttpRequest request, HttpResponse response, [FromKeyedServices("TeamsBot")]IBot bot, CancellationToken ct) => +app.MapPost("/api/v2/messages", (HttpRequest request, HttpResponse response, [FromKeyedServices("TeamsBot")] IBot bot, CancellationToken ct) => adapterTwo.ProcessAsync(request, response, bot, ct)).RequireAuthorization("AdapterTwo"); app.Run(); diff --git a/core/samples/PABot/SimpleGraphClient.cs b/core/samples/PABot/SimpleGraphClient.cs index 6866cd18..3ae6f3d6 100644 --- a/core/samples/PABot/SimpleGraphClient.cs +++ b/core/samples/PABot/SimpleGraphClient.cs @@ -7,12 +7,12 @@ using System.IO; using System.Linq; using System.Net.Http.Headers; +using System.Threading; using System.Threading.Tasks; using Microsoft.Graph; -using Microsoft.Graph.Models; using Microsoft.Graph.Me.SendMail; +using Microsoft.Graph.Models; using Microsoft.Kiota.Abstractions.Authentication; -using System.Threading; namespace PABot diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 54bc1fcf..cedf38fb 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -106,7 +106,7 @@ [Visit Microsoft](https://www.microsoft.com) await context.SendActivityAsync(feedbackActivity, cancellationToken); }); -teamsApp.OnMessageReaction( async (context, cancellationToken) => +teamsApp.OnMessageReaction(async (context, cancellationToken) => { string reactionsAdded = string.Join(", ", context.Activity.ReactionsAdded?.Select(r => r.Type) ?? []); string reactionsRemoved = string.Join(", ", context.Activity.ReactionsRemoved?.Select(r => r.Type) ?? []); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Context.cs b/core/src/Microsoft.Teams.Bot.Apps/Context.cs index b627c97b..779d7f6a 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Context.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Context.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Core; diff --git a/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs b/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs index 9ab4ece0..f401a5f1 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/GlobalSuppressions.cs @@ -1,7 +1,5 @@ -// This file is used by Code Analysis to maintain SuppressMessage -// attributes that are applied to this project. -// Project-level suppressions either have no target or are given -// a specific target and scoped to a namespace, type, member, etc. +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. using System.Diagnostics.CodeAnalysis; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs index 35828247..a607c2c7 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/MessageHandler.cs @@ -53,7 +53,7 @@ public static TeamsBotApplication OnMessage(this TeamsBotApplication app, Messag public static TeamsBotApplication OnMessage(this TeamsBotApplication app, string pattern, MessageHandler handler) { ArgumentNullException.ThrowIfNull(app, nameof(app)); - var regex = new Regex(pattern); + Regex regex = new(pattern); app.Router.Register(new Route { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Handlers/TaskHandler.cs b/core/src/Microsoft.Teams.Bot.Apps/Handlers/TaskHandler.cs index a87e89e0..a871fbd4 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Handlers/TaskHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Handlers/TaskHandler.cs @@ -29,9 +29,9 @@ public static TeamsBotApplication OnTaskFetch(this TeamsBotApplication app, Task Selector = activity => activity.Name == InvokeNames.TaskFetch, HandlerWithReturn = async (ctx, cancellationToken) => { - InvokeActivity typedActivity = new (ctx.Activity); + InvokeActivity typedActivity = new(ctx.Activity); Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); - return await handler(typedContext, cancellationToken).ConfigureAwait(false);; + return await handler(typedContext, cancellationToken).ConfigureAwait(false); ; } }); @@ -50,7 +50,7 @@ public static TeamsBotApplication OnTaskSubmit(this TeamsBotApplication app, Tas Selector = activity => activity.Name == InvokeNames.TaskSubmit, HandlerWithReturn = async (ctx, cancellationToken) => { - InvokeActivity typedActivity = new (ctx.Activity); + InvokeActivity typedActivity = new(ctx.Activity); Context> typedContext = new(ctx.TeamsBotApplication, typedActivity); return await handler(typedContext, cancellationToken).ConfigureAwait(false); } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs index ba67152d..65613a66 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Route.cs @@ -1,4 +1,4 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. +// Copyright (c) Microsoft Corporation. // Licensed under the MIT License. using Microsoft.Teams.Bot.Apps.Schema; @@ -20,7 +20,7 @@ public abstract class RouteBase /// /// /// - public abstract bool Matches (TeamsActivity activity); + public abstract bool Matches(TeamsActivity activity); /// /// Invokes the route handler if the activity matches the expected type diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs index 0155ad0e..5c7b7048 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -1,5 +1,6 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. +// Copyright (c) Microsoft Corporation. // Licensed under the MIT License. + using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps.Schema; @@ -62,15 +63,15 @@ public async Task DispatchAsync(Context ctx, CancellationToken ca { ArgumentNullException.ThrowIfNull(ctx); - var matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); + List matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); - if (matchingRoutes.Count == 0 && _routes.Count>0) + if (matchingRoutes.Count == 0 && _routes.Count > 0) { _logger.LogDebug("No routes matched activity of type '{Type}'.", ctx.Activity.Type); return; } - foreach (var route in matchingRoutes) + foreach (RouteBase route in matchingRoutes) { _logger.LogDebug("Dispatching '{Type}' activity to route '{Name}'.", ctx.Activity.Type, route.Name); await route.InvokeRoute(ctx, cancellationToken).ConfigureAwait(false); @@ -88,7 +89,7 @@ public async Task DispatchWithReturnAsync(Context { ArgumentNullException.ThrowIfNull(ctx); - var matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); + List matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); var name = ctx.Activity is InvokeActivity inv ? inv.Name : null; if (matchingRoutes.Count == 0 && _routes.Count > 0) diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/ConversationUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/ConversationUpdateActivity.cs index 79010f7f..80e0314b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/ConversationUpdateActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/ConversationUpdateActivity.cs @@ -65,7 +65,7 @@ protected ConversationUpdateActivity(CoreActivity activity) : base(activity) } */ - if (activity.Properties.TryGetValue("membersAdded", out var membersAdded) && membersAdded != null) + if (activity.Properties.TryGetValue("membersAdded", out object? membersAdded) && membersAdded != null) { if (membersAdded is JsonElement je) { @@ -78,7 +78,7 @@ protected ConversationUpdateActivity(CoreActivity activity) : base(activity) activity.Properties.Remove("membersAdded"); } - if (activity.Properties.TryGetValue("membersRemoved", out var membersRemoved) && membersRemoved != null) + if (activity.Properties.TryGetValue("membersRemoved", out object? membersRemoved) && membersRemoved != null) { if (membersRemoved is JsonElement je) { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/EventActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/EventActivity.cs index 17739610..baaa5039 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/EventActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/EventActivity.cs @@ -48,7 +48,7 @@ public EventActivity(string name) : base(TeamsActivityType.Event) /// protected EventActivity(CoreActivity activity) : base(activity) { - if (activity.Properties.TryGetValue("name", out var name)) + if (activity.Properties.TryGetValue("name", out object? name)) { Name = name?.ToString(); activity.Properties.Remove("name"); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs index 31147c59..67107f5f 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs @@ -36,7 +36,7 @@ public InstallUpdateActivity() : base(TeamsActivityType.InstallationUpdate) /// The CoreActivity to convert. protected InstallUpdateActivity(CoreActivity activity) : base(activity) { - if (activity.Properties.TryGetValue("action", out var action)) + if (activity.Properties.TryGetValue("action", out object? action)) { Action = action?.ToString(); activity.Properties.Remove("action"); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InvokeActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InvokeActivity.cs index 09405b1d..da20337b 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InvokeActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InvokeActivity.cs @@ -54,7 +54,7 @@ public InvokeActivity(string name) : base(TeamsActivityType.Invoke) protected InvokeActivity(CoreActivity activity) : base(activity) { ArgumentNullException.ThrowIfNull(activity); - if (activity.Properties.TryGetValue("name", out var name)) + if (activity.Properties.TryGetValue("name", out object? name)) { Name = name?.ToString(); activity.Properties.Remove("name"); @@ -188,44 +188,44 @@ public static class InvokeNames public const string MessageExtensionSubmitAction = "composeExtension/submitAction"; //TODO : review - /* - /// - /// Execute action invoke name. - /// - public const string ExecuteAction = "actionableMessage/executeAction"; + /* + /// + /// Execute action invoke name. + /// + public const string ExecuteAction = "actionableMessage/executeAction"; - /// - /// Handoff invoke name. - /// - public const string Handoff = "handoff/action"; + /// + /// Handoff invoke name. + /// + public const string Handoff = "handoff/action"; + + /// + /// Search invoke name. + /// + public const string Search = "search"; + /// + /// Config fetch invoke name. + /// + public const string ConfigFetch = "config/fetch"; + + /// + /// Config submit invoke name. + /// + public const string ConfigSubmit = "config/submit"; /// - /// Search invoke name. + /// Message submit action invoke name. /// - public const string Search = "search"; + public const string MessageSubmitAction = "message/submitAction"; + /// - /// Config fetch invoke name. + /// Message extension card button clicked invoke name. /// - public const string ConfigFetch = "config/fetch"; + public const string MessageExtensionCardButtonClicked = "composeExtension/onCardButtonClicked"; /// - /// Config submit invoke name. + /// Message extension setting invoke name. /// - public const string ConfigSubmit = "config/submit"; - - /// - /// Message submit action invoke name. - /// - public const string MessageSubmitAction = "message/submitAction"; - - /// - /// Message extension card button clicked invoke name. - /// - public const string MessageExtensionCardButtonClicked = "composeExtension/onCardButtonClicked"; - - /// - /// Message extension setting invoke name. - /// - public const string MessageExtensionSetting = "composeExtension/setting"; - */ + public const string MessageExtensionSetting = "composeExtension/setting"; + */ } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageActivity.cs index c9cc06c9..e4ba52fd 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageActivity.cs @@ -56,17 +56,17 @@ public MessageActivity(IList attachments) : base(TeamsActivityT /// The CoreActivity to convert. protected MessageActivity(CoreActivity activity) : base(activity) { - if (activity.Properties.TryGetValue("text", out var text)) + if (activity.Properties.TryGetValue("text", out object? text)) { Text = text?.ToString(); activity.Properties.Remove("text"); } - if (activity.Properties.TryGetValue("textFormat", out var textFormat)) + if (activity.Properties.TryGetValue("textFormat", out object? textFormat)) { TextFormat = textFormat?.ToString(); activity.Properties.Remove("textFormat"); } - if (activity.Properties.TryGetValue("attachmentLayout", out var attachmentLayout)) + if (activity.Properties.TryGetValue("attachmentLayout", out object? attachmentLayout)) { AttachmentLayout = attachmentLayout?.ToString(); activity.Properties.Remove("attachmentLayout"); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageDeleteActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageDeleteActivity.cs index 86137862..df392c17 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageDeleteActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageDeleteActivity.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text.Json; using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs index 6960e52b..01bd6970 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs @@ -37,7 +37,7 @@ public MessageReactionActivity() : base(TeamsActivityType.MessageReaction) /// The CoreActivity to convert. protected MessageReactionActivity(CoreActivity activity) : base(activity) { - if (activity.Properties.TryGetValue("reactionsAdded", out var reactionsAdded) && reactionsAdded != null) + if (activity.Properties.TryGetValue("reactionsAdded", out object? reactionsAdded) && reactionsAdded != null) { if (reactionsAdded is JsonElement je) { @@ -49,7 +49,7 @@ protected MessageReactionActivity(CoreActivity activity) : base(activity) } activity.Properties.Remove("reactionsAdded"); } - if (activity.Properties.TryGetValue("reactionsRemoved", out var reactionsRemoved) && reactionsRemoved != null) + if (activity.Properties.TryGetValue("reactionsRemoved", out object? reactionsRemoved) && reactionsRemoved != null) { if (reactionsRemoved is JsonElement je) { @@ -61,7 +61,7 @@ protected MessageReactionActivity(CoreActivity activity) : base(activity) } activity.Properties.Remove("reactionsRemoved"); } - if (activity.Properties.TryGetValue("replyToId", out var replyToId) && replyToId != null) + if (activity.Properties.TryGetValue("replyToId", out object? replyToId) && replyToId != null) { if (replyToId is JsonElement jeReplyToId && jeReplyToId.ValueKind == JsonValueKind.String) { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs index e14a2faa..468b39bb 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ClientInfoEntity.cs @@ -83,7 +83,7 @@ public ClientInfoEntity(string platform, string country, string timezone, string [JsonPropertyName("locale")] public string? Locale { - get => base.Properties.TryGetValue("locale", out var value) ? value?.ToString() : null; + get => base.Properties.TryGetValue("locale", out object? value) ? value?.ToString() : null; set => base.Properties["locale"] = value; } @@ -93,7 +93,7 @@ public string? Locale [JsonPropertyName("country")] public string? Country { - get => base.Properties.TryGetValue("country", out var value) ? value?.ToString() : null; + get => base.Properties.TryGetValue("country", out object? value) ? value?.ToString() : null; set => base.Properties["country"] = value; } @@ -103,7 +103,7 @@ public string? Country [JsonPropertyName("platform")] public string? Platform { - get => base.Properties.TryGetValue("platform", out var value) ? value?.ToString() : null; + get => base.Properties.TryGetValue("platform", out object? value) ? value?.ToString() : null; set => base.Properties["platform"] = value; } @@ -113,7 +113,7 @@ public string? Platform [JsonPropertyName("timezone")] public string? Timezone { - get => base.Properties.TryGetValue("timezone", out var value) ? value?.ToString() : null; + get => base.Properties.TryGetValue("timezone", out object? value) ? value?.ToString() : null; set => base.Properties["timezone"] = value; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs index 8ac3d2cb..6c867b01 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/MentionEntity.cs @@ -80,7 +80,7 @@ public MentionEntity(ConversationAccount mentioned, string? text) : base("mentio [JsonPropertyName("mentioned")] public ConversationAccount? Mentioned { - get => base.Properties.TryGetValue("mentioned", out var value) ? value as ConversationAccount : null; + get => base.Properties.TryGetValue("mentioned", out object? value) ? value as ConversationAccount : null; set => base.Properties["mentioned"] = value; } @@ -90,7 +90,7 @@ public ConversationAccount? Mentioned [JsonPropertyName("text")] public string? Text { - get => base.Properties.TryGetValue("text", out var value) ? value?.ToString() : null; + get => base.Properties.TryGetValue("text", out object? value) ? value?.ToString() : null; set => base.Properties["text"] = value; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs index f9991050..b0dd31c7 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/OMessageEntity.cs @@ -25,7 +25,7 @@ public OMessageEntity() : base("https://schema.org/Message") [JsonPropertyName("additionalType")] public IList? AdditionalType { - get => base.Properties.TryGetValue("additionalType", out var value) ? value as IList : null; + get => base.Properties.TryGetValue("additionalType", out object? value) ? value as IList : null; set => base.Properties["additionalType"] = value; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs index 3990e1d1..f08725f1 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/ProductInfoEntity.cs @@ -24,7 +24,7 @@ public ProductInfoEntity() : base("ProductInfo") { } [JsonPropertyName("id")] public string? Id { - get => base.Properties.TryGetValue("id", out var value) ? value?.ToString() : null; + get => base.Properties.TryGetValue("id", out object? value) ? value?.ToString() : null; set => base.Properties["id"] = value; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs index 8f2de594..20b0d61c 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/SensitiveUsageEntity.cs @@ -22,7 +22,7 @@ public class SensitiveUsageEntity : OMessageEntity [JsonPropertyName("name")] public required string Name { - get => base.Properties.TryGetValue("name", out var value) ? value?.ToString() ?? string.Empty : string.Empty; + get => base.Properties.TryGetValue("name", out object? value) ? value?.ToString() ?? string.Empty : string.Empty; set => base.Properties["name"] = value; } @@ -32,7 +32,7 @@ public required string Name [JsonPropertyName("description")] public string? Description { - get => base.Properties.TryGetValue("description", out var value) ? value?.ToString() : null; + get => base.Properties.TryGetValue("description", out object? value) ? value?.ToString() : null; set => base.Properties["description"] = value; } @@ -42,7 +42,7 @@ public string? Description [JsonPropertyName("pattern")] public DefinedTerm? Pattern { - get => base.Properties.TryGetValue("pattern", out var value) ? value as DefinedTerm : null; + get => base.Properties.TryGetValue("pattern", out object? value) ? value as DefinedTerm : null; set => base.Properties["pattern"] = value; } } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs index 6e1541d8..eb7fcc72 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/StreamInfoEntity.cs @@ -21,7 +21,7 @@ public StreamInfoEntity() : base("streaminfo") { } [JsonPropertyName("streamId")] public string? StreamId { - get => base.Properties.TryGetValue("streamId", out var value) ? value?.ToString() : null; + get => base.Properties.TryGetValue("streamId", out object? value) ? value?.ToString() : null; set => base.Properties["streamId"] = value; } @@ -31,7 +31,7 @@ public string? StreamId [JsonPropertyName("streamType")] public string? StreamType { - get => base.Properties.TryGetValue("streamType", out var value) ? value?.ToString() : null; + get => base.Properties.TryGetValue("streamType", out object? value) ? value?.ToString() : null; set => base.Properties["streamType"] = value; } @@ -41,8 +41,8 @@ public string? StreamType [JsonPropertyName("streamSequence")] public int? StreamSequence { - get => base.Properties.TryGetValue("streamSequence", out var value) && value != null - ? (int.TryParse(value.ToString(), out var intVal) ? intVal : null) + get => base.Properties.TryGetValue("streamSequence", out object? value) && value != null + ? (int.TryParse(value.ToString(), out int intVal) ? intVal : null) : null; set => base.Properties["streamSequence"] = value; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/InvokeResponse.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/InvokeResponse.cs index 22d1fa78..f31f20c7 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/InvokeResponse.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/InvokeResponse.cs @@ -1,4 +1,4 @@ -// Copyright (c) Microsoft Corporation. +// Copyright (c) Microsoft Corporation. // Licensed under the MIT License. using System.Text.Json.Serialization; diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleResponse.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleResponse.cs index 2fcecc55..e81ac1a6 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleResponse.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Invokes/TaskModuleResponse.cs @@ -257,4 +257,4 @@ public class Response /// [JsonPropertyName("value")] public object? Value { get; set; } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs index c306df6f..24d2b608 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs @@ -21,7 +21,7 @@ public static TeamsActivity FromActivity(CoreActivity activity) { ArgumentNullException.ThrowIfNull(activity); - return TeamsActivityType.ActivityDeserializerMap.TryGetValue(activity.Type, out var factory) + return TeamsActivityType.ActivityDeserializerMap.TryGetValue(activity.Type, out Func? factory) ? factory(activity) : new TeamsActivity(activity); // Fallback to base type } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs index 06f35db8..f8c4df26 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs @@ -108,7 +108,7 @@ public string? TenantId private string? GetStringProperty(string key) { - if (Properties.TryGetValue(key, out var val) && val is JsonElement je && je.ValueKind == JsonValueKind.String) + if (Properties.TryGetValue(key, out object? val) && val is JsonElement je && je.ValueKind == JsonValueKind.String) { return je.GetString(); } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs index 00453a55..8dfd01d7 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs @@ -6,7 +6,6 @@ using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; -using Microsoft.Teams.Bot.Apps.Routing; using Microsoft.Teams.Bot.Core.Hosting; namespace Microsoft.Teams.Bot.Apps; @@ -39,7 +38,7 @@ public static IServiceCollection AddTeamsBotApplication(this IServiceCollection services.AddHttpClient(TeamsApiClient.TeamsHttpClientName) .AddHttpMessageHandler(sp => { - var options = sp.GetRequiredService>().Value; + BotClientOptions options = sp.GetRequiredService>().Value; return new BotAuthenticationHandler( sp.GetRequiredService(), sp.GetRequiredService>(), diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 1bc09259..168569f3 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -2,11 +2,10 @@ // Licensed under the MIT License. using Microsoft.AspNetCore.Http; -using Microsoft.Teams.Bot.Core; using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Apps.Routing; -using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Hosting; namespace Microsoft.Teams.Bot.Apps; diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs index daef3841..86ef65d3 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatActivity.cs @@ -228,7 +228,7 @@ public static Microsoft.Bot.Schema.Teams.TeamsChannelAccount ToCompatTeamsChanne { ArgumentNullException.ThrowIfNull(account); - var teamsChannelAccount = new Microsoft.Bot.Schema.Teams.TeamsChannelAccount + TeamsChannelAccount teamsChannelAccount = new() { Id = account.Id, Name = account.Name @@ -276,9 +276,9 @@ public static Microsoft.Bot.Schema.Teams.TeamsChannelAccount ToCompatTeamsChanne public static TeamInfo? TeamsGetTeamInfo(this IActivity activity) { ArgumentNullException.ThrowIfNull(activity); - var channelData = activity.GetChannelData(); + Microsoft.Bot.Schema.Teams.TeamsChannelData channelData = activity.GetChannelData(); return channelData?.Team; } - + } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs index 75b161ec..0c382810 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs @@ -265,7 +265,7 @@ public async Task> SendConversationHisto Microsoft.Teams.Bot.Core.Transcript coreTranscript = new() { - Activities = transcript.Activities?.Select(a => a.FromCompatActivity() as CoreActivity).ToList() + Activities = transcript.Activities?.Select(a => a.FromCompatActivity()).ToList() }; SendConversationHistoryResponse response = await _client.SendConversationHistoryAsync( diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs index f0fac166..9762f5c6 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatHostingExtensions.cs @@ -46,4 +46,4 @@ public static IServiceCollection AddCompatAdapter(this IServiceCollection servic services.AddSingleton(); return services; } -} \ No newline at end of file +} diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.Models.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.Models.cs index 9b107048..f2bb3a9a 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.Models.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.Models.cs @@ -16,7 +16,7 @@ internal static class CompatTeamsInfoModels public static TeamsMeetingInfo? TeamsGetMeetingInfo(this IActivity activity) { ArgumentNullException.ThrowIfNull(activity); - var channelData = activity.GetChannelData(); + TeamsChannelData channelData = activity.GetChannelData(); return channelData?.Meeting; } @@ -29,7 +29,7 @@ public static Microsoft.Bot.Schema.Teams.BatchOperationState ToCompatBatchOperat { ArgumentNullException.ThrowIfNull(state); - var result = new Microsoft.Bot.Schema.Teams.BatchOperationState + BatchOperationState result = new() { State = state.State, RetryAfter = state.RetryAfter?.DateTime, @@ -73,7 +73,7 @@ public static Microsoft.Bot.Schema.Teams.BatchFailedEntriesResponse ToCompatBatc { ArgumentNullException.ThrowIfNull(response); - var result = new Microsoft.Bot.Schema.Teams.BatchFailedEntriesResponse + BatchFailedEntriesResponse result = new() { ContinuationToken = response.ContinuationToken }; @@ -81,7 +81,7 @@ public static Microsoft.Bot.Schema.Teams.BatchFailedEntriesResponse ToCompatBatc // FailedEntries is a read-only property with private setter, populate via the collection if (response.FailedEntries != null) { - foreach (var entry in response.FailedEntries) + foreach (Apps.BatchFailedEntry entry in response.FailedEntries) { result.FailedEntries.Add(entry.ToCompatBatchFailedEntry()); } diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs index e8711045..c0368b97 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs @@ -4,12 +4,13 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Connector; using Microsoft.Bot.Schema; +using Microsoft.Bot.Schema.Teams; using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Schema; -using BotFrameworkTeams = Microsoft.Bot.Schema.Teams; using AppsTeams = Microsoft.Teams.Bot.Apps; -using Microsoft.Bot.Schema.Teams; +using BotFrameworkTeams = Microsoft.Bot.Schema.Teams; namespace Microsoft.Teams.Bot.Compat; @@ -28,7 +29,7 @@ public static class CompatTeamsInfo private static ConversationClient GetConversationClient(ITurnContext turnContext) { - var connectorClient = turnContext.TurnState.Get() + IConnectorClient connectorClient = turnContext.TurnState.Get() ?? throw new InvalidOperationException("This method requires a connector client."); if (connectorClient is CompatConnectorClient compatClient) @@ -53,7 +54,7 @@ private static string GetServiceUrl(ITurnContext turnContext) private static AgenticIdentity GetIdentity(ITurnContext turnContext) { - var coreActivity = ((Activity)turnContext.Activity).FromCompatActivity(); + CoreActivity coreActivity = turnContext.Activity.FromCompatActivity(); return AgenticIdentity.FromProperties(coreActivity.From.Properties) ?? new AgenticIdentity(); } @@ -75,7 +76,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(turnContext); - var teamInfo = turnContext.Activity.TeamsGetTeamInfo(); + TeamInfo? teamInfo = turnContext.Activity.TeamsGetTeamInfo(); if (teamInfo?.Id != null) { @@ -83,7 +84,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) } else { - var conversationId = turnContext.Activity?.Conversation?.Id + string conversationId = turnContext.Activity?.Conversation?.Id ?? throw new InvalidOperationException("The GetMember operation needs a valid conversation Id."); if (userId == null) @@ -91,11 +92,11 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) throw new InvalidOperationException("The GetMember operation needs a valid user Id."); } - var client = GetConversationClient(turnContext); + ConversationClient client = GetConversationClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var result = await client.GetConversationMemberAsync( + TeamsConversationAccount result = await client.GetConversationMemberAsync( conversationId, userId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return result.ToCompatTeamsChannelAccount(); @@ -114,7 +115,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(turnContext); - var teamInfo = turnContext.Activity.TeamsGetTeamInfo(); + TeamInfo? teamInfo = turnContext.Activity.TeamsGetTeamInfo(); if (teamInfo?.Id != null) { @@ -122,14 +123,14 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) } else { - var conversationId = turnContext.Activity?.Conversation?.Id + string conversationId = turnContext.Activity?.Conversation?.Id ?? throw new InvalidOperationException("The GetMembers operation needs a valid conversation Id."); - var client = GetConversationClient(turnContext); + ConversationClient client = GetConversationClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var members = await client.GetConversationMembersAsync( + IList members = await client.GetConversationMembersAsync( conversationId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return members.Select(m => m.ToCompatTeamsChannelAccount()); @@ -151,7 +152,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(turnContext); - var teamInfo = turnContext.Activity.TeamsGetTeamInfo(); + TeamInfo? teamInfo = turnContext.Activity.TeamsGetTeamInfo(); if (teamInfo?.Id != null) { @@ -159,14 +160,14 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) } else { - var conversationId = turnContext.Activity?.Conversation?.Id + string conversationId = turnContext.Activity?.Conversation?.Id ?? throw new InvalidOperationException("The GetMembers operation needs a valid conversation Id."); - var client = GetConversationClient(turnContext); + ConversationClient client = GetConversationClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var pagedMembers = await client.GetConversationPagedMembersAsync( + Core.PagedMembersResult pagedMembers = await client.GetConversationPagedMembersAsync( conversationId, serviceUrl, pageSize, continuationToken, identity, null, cancellationToken).ConfigureAwait(false); return pagedMembers.ToCompatTeamsPagedMembersResult(); @@ -188,7 +189,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(turnContext); - var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + string t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); if (userId == null) @@ -196,11 +197,11 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) throw new InvalidOperationException("The GetMember operation needs a valid user Id."); } - var client = GetConversationClient(turnContext); + ConversationClient client = GetConversationClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var result = await client.GetConversationMemberAsync( + TeamsConversationAccount result = await client.GetConversationMemberAsync( t, userId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return result.ToCompatTeamsChannelAccount(); @@ -221,14 +222,14 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(turnContext); - var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + string t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); - var client = GetConversationClient(turnContext); + ConversationClient client = GetConversationClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var members = await client.GetConversationMembersAsync( + IList members = await client.GetConversationMembersAsync( t, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return members.Select(m => m.ToCompatTeamsChannelAccount()); @@ -252,14 +253,14 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(turnContext); - var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + string t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); - var client = GetConversationClient(turnContext); + ConversationClient client = GetConversationClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var pagedMembers = await client.GetConversationPagedMembersAsync( + Core.PagedMembersResult pagedMembers = await client.GetConversationPagedMembersAsync( t, serviceUrl, pageSize, continuationToken, identity, null, cancellationToken).ConfigureAwait(false); return pagedMembers.ToCompatTeamsPagedMembersResult(); @@ -285,11 +286,11 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) meetingId ??= turnContext.Activity.TeamsGetMeetingInfo()?.Id ?? throw new InvalidOperationException("The meetingId can only be null if turnContext is within the scope of a MS Teams Meeting."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var result = await client.FetchMeetingInfoAsync( + AppsTeams.MeetingInfo result = await client.FetchMeetingInfoAsync( meetingId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return result.ToCompatMeetingInfo(); @@ -319,11 +320,11 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) tenantId ??= turnContext.Activity.GetChannelData()?.Tenant?.Id ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var result = await client.FetchParticipantAsync( + MeetingParticipant result = await client.FetchParticipantAsync( meetingId, participantId, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return result.ToCompatTeamsMeetingParticipant(); @@ -348,16 +349,16 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) ?? throw new InvalidOperationException("This method is only valid within the scope of a MS Teams Meeting."); notification = notification ?? throw new InvalidOperationException($"{nameof(notification)} is required."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); // Convert Bot Framework MeetingNotificationBase to Core MeetingNotificationBase using JSON round-trip - var json = Newtonsoft.Json.JsonConvert.SerializeObject(notification); - var coreNotification = System.Text.Json.JsonSerializer.Deserialize(json, s_jsonOptions); + string json = Newtonsoft.Json.JsonConvert.SerializeObject(notification); + AppsTeams.TargetedMeetingNotification? coreNotification = System.Text.Json.JsonSerializer.Deserialize(json, s_jsonOptions); - var result = await client.SendMeetingNotificationAsync( + AppsTeams.MeetingNotificationResponse result = await client.SendMeetingNotificationAsync( meetingId, coreNotification!, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return result.ToCompatMeetingNotificationResponse(); @@ -380,14 +381,14 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(turnContext); - var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + string t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var result = await client.FetchTeamDetailsAsync( + AppsTeams.TeamDetails result = await client.FetchTeamDetailsAsync( t, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return result.ToCompatTeamDetails(); @@ -407,14 +408,14 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(turnContext); - var t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id + string t = teamId ?? turnContext.Activity.TeamsGetTeamInfo()?.Id ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var channelList = await client.FetchChannelListAsync( + ChannelList channelList = await client.FetchChannelListAsync( t, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return channelList.Channels?.Select(c => c.ToCompatChannelInfo()).ToList() ?? []; @@ -445,10 +446,10 @@ public static async Task SendMessageToListOfUsersAsync( teamsMembers = teamsMembers ?? throw new InvalidOperationException($"{nameof(teamsMembers)} is required."); tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); - var coreActivity = ((Activity)activity).FromCompatActivity(); + AgenticIdentity identity = GetIdentity(turnContext); + CoreActivity coreActivity = ((Activity)activity).FromCompatActivity(); var coreTeamsMembers = teamsMembers.Select(m => m.FromCompatTeamMember()).ToList(); @@ -477,10 +478,10 @@ public static async Task SendMessageToListOfChannelsAsync( channelsMembers = channelsMembers ?? throw new InvalidOperationException($"{nameof(channelsMembers)} is required."); tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); - var coreActivity = ((Activity)activity).FromCompatActivity(); + AgenticIdentity identity = GetIdentity(turnContext); + CoreActivity coreActivity = ((Activity)activity).FromCompatActivity(); var coreChannelsMembers = channelsMembers.Select(m => m.FromCompatTeamMember()).ToList(); @@ -509,10 +510,10 @@ public static async Task SendMessageToAllUsersInTeamAsync( teamId = teamId ?? throw new InvalidOperationException($"{nameof(teamId)} is required."); tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); - var coreActivity = ((Activity)activity).FromCompatActivity(); + AgenticIdentity identity = GetIdentity(turnContext); + CoreActivity coreActivity = ((Activity)activity).FromCompatActivity(); return await client.SendMessageToAllUsersInTeamAsync( coreActivity, teamId, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); @@ -536,10 +537,10 @@ public static async Task SendMessageToAllUsersInTenantAsync( activity = activity ?? throw new InvalidOperationException($"{nameof(activity)} is required."); tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); - var coreActivity = ((Activity)activity).FromCompatActivity(); + AgenticIdentity identity = GetIdentity(turnContext); + CoreActivity coreActivity = ((Activity)activity).FromCompatActivity(); return await client.SendMessageToAllUsersInTenantAsync( coreActivity, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); @@ -572,8 +573,8 @@ public static async Task> SendMessageToTeam ArgumentException.ThrowIfNullOrWhiteSpace(teamsChannelId); ConversationReference? conversationReference = null; - var newActivityId = string.Empty; - var serviceUrl = turnContext.Activity.ServiceUrl; + string newActivityId = string.Empty; + string serviceUrl = turnContext.Activity.ServiceUrl; var conversationParameters = new Microsoft.Bot.Schema.ConversationParameters { IsGroup = true, @@ -617,11 +618,11 @@ await turnContext.Adapter.CreateConversationAsync( ArgumentNullException.ThrowIfNull(turnContext); operationId = operationId ?? throw new InvalidOperationException($"{nameof(operationId)} is required."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var result = await client.GetOperationStateAsync( + AppsTeams.BatchOperationState result = await client.GetOperationStateAsync( operationId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); return result.ToCompatBatchOperationState(); @@ -644,11 +645,11 @@ await turnContext.Adapter.CreateConversationAsync( ArgumentNullException.ThrowIfNull(turnContext); operationId = operationId ?? throw new InvalidOperationException($"{nameof(operationId)} is required."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); - var result = await client.GetPagedFailedEntriesAsync( + AppsTeams.BatchFailedEntriesResponse result = await client.GetPagedFailedEntriesAsync( operationId, serviceUrl, continuationToken, identity, null, cancellationToken).ConfigureAwait(false); return result.ToCompatBatchFailedEntriesResponse(); @@ -669,9 +670,9 @@ public static async Task CancelOperationAsync( ArgumentNullException.ThrowIfNull(turnContext); operationId = operationId ?? throw new InvalidOperationException($"{nameof(operationId)} is required."); - var client = GetTeamsApiClient(turnContext); + TeamsApiClient client = GetTeamsApiClient(turnContext); var serviceUrl = new Uri(GetServiceUrl(turnContext)); - var identity = GetIdentity(turnContext); + AgenticIdentity identity = GetIdentity(turnContext); await client.CancelOperationAsync( operationId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); diff --git a/core/src/Microsoft.Teams.Bot.Compat/GlobalSuppressions.cs b/core/src/Microsoft.Teams.Bot.Compat/GlobalSuppressions.cs index eea350bd..9bfa5cf9 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/GlobalSuppressions.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/GlobalSuppressions.cs @@ -1,7 +1,5 @@ -// This file is used by Code Analysis to maintain SuppressMessage -// attributes that are applied to this project. -// Project-level suppressions either have no target or are given -// a specific target and scoped to a namespace, type, member, etc. +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. using System.Diagnostics.CodeAnalysis; diff --git a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index b77ff7cd..5f0291c7 100644 --- a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -3,7 +3,6 @@ using System.Diagnostics; using Microsoft.AspNetCore.Http; -using Microsoft.AspNetCore.Mvc.Formatters; using Microsoft.Extensions.Logging; using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Teams.Bot.Core.Schema; @@ -38,7 +37,6 @@ public BotApplication(ConversationClient conversationClient, UserTokenClient use _conversationClient = conversationClient; _userTokenClient = userTokenClient; logger.LogInformation("Started {ThisType} listener for AppID:{AppId} with SDK version {SdkVersion}", this.GetType().Name, options.AppId, Version); - logger.LogInformation("Started {ThisType} listener for AppID:{AppId} with SDK version {SdkVersion}", this.GetType().Name, options.AppId, Version); } @@ -92,7 +90,7 @@ public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancel { try { - var token = Debugger.IsAttached ? CancellationToken.None : cancellationToken; + CancellationToken token = Debugger.IsAttached ? CancellationToken.None : cancellationToken; await MiddleWare.RunPipelineAsync(this, activity, this.OnActivity, 0, token).ConfigureAwait(false); } diff --git a/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs b/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs index 532d5c9c..480d1b6f 100644 --- a/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/GlobalSuppressions.cs @@ -1,7 +1,5 @@ -// This file is used by Code Analysis to maintain SuppressMessage -// attributes that are applied to this project. -// Project-level suppressions either have no target or are given -// a specific target and scoped to a namespace, type, member, etc. +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. using System.Diagnostics.CodeAnalysis; diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs index df3a3f02..288ad2db 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -1,13 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Linq; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Routing; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.Http; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; @@ -94,14 +92,14 @@ public static IServiceCollection AddBotApplication(this IServiceCollection servi public static IServiceCollection AddBotApplication(this IServiceCollection services, string sectionName = "AzureAd") where TApp : BotApplication { // Extract ILoggerFactory from service collection to create logger without BuildServiceProvider - var loggerFactoryDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(ILoggerFactory)); - var loggerFactory = loggerFactoryDescriptor?.ImplementationInstance as ILoggerFactory; + ServiceDescriptor? loggerFactoryDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(ILoggerFactory)); + ILoggerFactory? loggerFactory = loggerFactoryDescriptor?.ImplementationInstance as ILoggerFactory; ILogger logger = loggerFactory?.CreateLogger() ?? (ILogger)Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; services.AddSingleton(sp => { - var config = sp.GetRequiredService(); + IConfiguration config = sp.GetRequiredService(); return new BotApplicationOptions { AppId = config["MicrosoftAppId"] ?? config["CLIENT_ID"] ?? config[$"{sectionName}:ClientId"] ?? string.Empty @@ -157,18 +155,18 @@ private static IServiceCollection AddBotClient( // Get configuration and logger to configure MSAL during registration // Try to get from service descriptors first - var configDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(IConfiguration)); + ServiceDescriptor? configDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(IConfiguration)); IConfiguration? configuration = configDescriptor?.ImplementationInstance as IConfiguration; - var loggerFactoryDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(ILoggerFactory)); - var loggerFactory = loggerFactoryDescriptor?.ImplementationInstance as ILoggerFactory; + ServiceDescriptor? loggerFactoryDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(ILoggerFactory)); + ILoggerFactory? loggerFactory = loggerFactoryDescriptor?.ImplementationInstance as ILoggerFactory; ILogger logger = loggerFactory?.CreateLogger(typeof(AddBotApplicationExtensions)) - ?? (ILogger)Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + ?? Extensions.Logging.Abstractions.NullLogger.Instance; // If configuration not available as instance, build temporary provider if (configuration == null) { - using var tempProvider = services.BuildServiceProvider(); + using ServiceProvider tempProvider = services.BuildServiceProvider(); configuration = tempProvider.GetRequiredService(); if (loggerFactory == null) { @@ -182,7 +180,7 @@ private static IServiceCollection AddBotClient( services.AddHttpClient(httpClientName) .AddHttpMessageHandler(sp => { - var botOptions = sp.GetRequiredService>().Value; + BotClientOptions botOptions = sp.GetRequiredService>().Value; return new BotAuthenticationHandler( sp.GetRequiredService(), sp.GetRequiredService>(), diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs index cb331628..4dd8d07e 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotAuthenticationHandler.cs @@ -38,7 +38,7 @@ internal sealed class BotAuthenticationHandler( LoggerMessage.Define(LogLevel.Information, new(3), "Acquiring app-only token for scope: {Scope}"); private static readonly Action _logTokenClaims = LoggerMessage.Define(LogLevel.Trace, new(4), "Acquired token claims:{Claims}"); - + /// /// Key used to store the agentic identity in HttpRequestMessage options. /// @@ -116,8 +116,8 @@ private void LogTokenClaims(string token) } - var jwtToken = new JwtSecurityToken(token); - var claims = Environment.NewLine + string.Join(Environment.NewLine, jwtToken.Claims.Select(c => $" {c.Type}: {c.Value}")); + JwtSecurityToken jwtToken = new(token); + string claims = Environment.NewLine + string.Join(Environment.NewLine, jwtToken.Claims.Select(c => $" {c.Type}: {c.Value}")); _logTokenClaims(_logger, claims, null); } diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs index da77f8ea..b25cd792 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs @@ -2,7 +2,6 @@ // Licensed under the MIT License. using System.IdentityModel.Tokens.Jwt; -using System.Linq; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Authentication.JwtBearer; using Microsoft.AspNetCore.Authorization; @@ -82,7 +81,7 @@ public static AuthorizationBuilder AddAuthorization(this IServiceCollection serv // We need IConfiguration to determine which authentication scheme to register (Bot vs Agent) // This is a registration-time decision that cannot be deferred // Try to get it from service descriptors first (fast path) - var configDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(IConfiguration)); + ServiceDescriptor? configDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(IConfiguration)); IConfiguration? configuration = configDescriptor?.ImplementationInstance as IConfiguration; // If not available as ImplementationInstance, build a temporary ServiceProvider @@ -92,7 +91,7 @@ public static AuthorizationBuilder AddAuthorization(this IServiceCollection serv // 3. This only happens once during application startup if (configuration == null) { - using var tempProvider = services.BuildServiceProvider(); + using ServiceProvider tempProvider = services.BuildServiceProvider(); configuration = tempProvider.GetRequiredService(); } @@ -139,8 +138,8 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild OnMessageReceived = async context => { // Resolve logger at runtime from request services to ensure we always have proper logging - var loggerFactory = context.HttpContext.RequestServices.GetService(); - var requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") + ILoggerFactory? loggerFactory = context.HttpContext.RequestServices.GetService(); + ILogger requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") ?? logger ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; @@ -189,8 +188,8 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild OnTokenValidated = context => { // Resolve logger at runtime - var loggerFactory = context.HttpContext.RequestServices.GetService(); - var requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") + ILoggerFactory? loggerFactory = context.HttpContext.RequestServices.GetService(); + ILogger requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") ?? logger ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; @@ -200,8 +199,8 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild OnForbidden = context => { // Resolve logger at runtime - var loggerFactory = context.HttpContext.RequestServices.GetService(); - var requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") + ILoggerFactory? loggerFactory = context.HttpContext.RequestServices.GetService(); + ILogger requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") ?? logger ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; @@ -211,8 +210,8 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild OnAuthenticationFailed = context => { // Resolve logger at runtime to ensure authentication failures are always logged - var loggerFactory = context.HttpContext.RequestServices.GetService(); - var requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") + ILoggerFactory? loggerFactory = context.HttpContext.RequestServices.GetService(); + ILogger requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") ?? logger ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; @@ -229,7 +228,7 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild if (!string.IsNullOrEmpty(authHeader) && authHeader.StartsWith("Bearer ", StringComparison.OrdinalIgnoreCase)) { string tokenString = authHeader.Substring("Bearer ".Length).Trim(); - var token = new JwtSecurityToken(tokenString); + JwtSecurityToken token = new(tokenString); tokenAudience = token.Audiences?.FirstOrDefault(); tokenIssuer = token.Issuer; @@ -245,7 +244,7 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild #pragma warning restore CA1031 // Get configured validation parameters - var validationParams = context.Options?.TokenValidationParameters; + TokenValidationParameters? validationParams = context.Options?.TokenValidationParameters; string configuredAudience = validationParams?.ValidAudience ?? "null"; string configuredAudiences = validationParams?.ValidAudiences != null ? string.Join(", ", validationParams.ValidAudiences) diff --git a/core/test/ABSTokenServiceClient/Program.cs b/core/test/ABSTokenServiceClient/Program.cs index 2cac7461..b41a7613 100644 --- a/core/test/ABSTokenServiceClient/Program.cs +++ b/core/test/ABSTokenServiceClient/Program.cs @@ -3,9 +3,9 @@ using ABSTokenServiceClient; using Microsoft.AspNetCore.Builder; +using Microsoft.Extensions.DependencyInjection; using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Hosting; -using Microsoft.Extensions.DependencyInjection; WebApplicationBuilder builder = WebApplication.CreateBuilder(args); diff --git a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs index 6f2c1a2e..c8aa55cc 100644 --- a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs +++ b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs @@ -1,7 +1,7 @@ using System.Text.Json; -using Microsoft.Teams.Bot.Core; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; +using Microsoft.Teams.Bot.Core; namespace ABSTokenServiceClient { diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs index 1362a7ee..f0345f5a 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/MessageActivityTests.cs @@ -44,7 +44,7 @@ public void MessageActivity_Serialize_ToJson() { MessageActivity activity = new("Hello World") { - // Summary = "Test summary", + // Summary = "Test summary", TextFormat = TextFormats.Markdown, //InputHint = InputHints.ExpectingInput, //Importance = ImportanceLevels.Urgent, diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs index a629fc76..455f1239 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Text.Json; +using System.Text.Json.Nodes; using AdaptiveCards; using Microsoft.Bot.Schema; using Microsoft.Teams.Bot.Core.Schema; using Newtonsoft.Json; -using System.Text.Json; -using System.Text.Json.Nodes; namespace Microsoft.Teams.Bot.Compat.UnitTests { diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs index 252a8cbc..fde05efb 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs @@ -4,10 +4,10 @@ using System.Net; using System.Text; using Microsoft.AspNetCore.Http; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Schema; using Moq; using Moq.Protected; diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs index c59a5110..3b33e8fd 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Options; using Microsoft.Identity.Abstractions; +using Microsoft.Teams.Bot.Core.Hosting; namespace Microsoft.Teams.Bot.Core.UnitTests.Hosting; diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs index 350db477..a4d9562d 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs @@ -3,9 +3,9 @@ using System.Text; using Microsoft.AspNetCore.Http; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.Teams.Bot.Core.Schema; using Moq; namespace Microsoft.Teams.Bot.Core.UnitTests; diff --git a/core/test/msal-config-api/Program.cs b/core/test/msal-config-api/Program.cs index 18bd340a..4844d4aa 100644 --- a/core/test/msal-config-api/Program.cs +++ b/core/test/msal-config-api/Program.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.Teams.Bot.Core; -using Microsoft.Teams.Bot.Core.Hosting; -using Microsoft.Teams.Bot.Core.Schema; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; +using Microsoft.Teams.Bot.Core.Schema; string ConversationId = "a:17vxw6pGQOb3Zfh8acXT8m_PqHycYpaFgzu2mFMUfkT-h0UskMctq5ZPPc7FIQxn2bx7rBSm5yE_HeUXsCcKZBrv77RgorB3_1_pAdvMhi39ClxQgawzyQ9GBFkdiwOxT"; From 07c72c155c3913f40a5a77f3f7d44b5269867344 Mon Sep 17 00:00:00 2001 From: Kavin <115390646+singhk97@users.noreply.github.com> Date: Fri, 27 Feb 2026 17:13:12 -0500 Subject: [PATCH 65/69] Revisit `LogInformation` statements (#351) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Motivation We expect developers to have `LogInformation` statements (and hence greater log levels) enabled in production. And so it should provide just enough information to be achieve the following goals: - Be able to identify the issues by tracing logs through internal activity processing pipeline. - Get suggestions when incomming activity is not handled. - Have access to metadata that helps us, as SDK owners, with debugging. - No PIIs should be logged. - Logs shouldn't be too verbose or contain redundant information. # Changes - Removed `BeginScope` since it will add the passed context to every log statement, forcing the developer to manually configure filtering in their logging infrastructure. - On `BotApplication.ProcessAsync` add logging of the MSCV & ServiceUrl. # How logs look like right now ae4f3ffc-02ef-40d0-ae81-89848948cde1 # Program flow and where info logs are present ```mermaid flowchart TD A["Teams Service (POST /api/messages)"] B["JWT token validation
ℹ️ token validated successfully "] C["BotApplication.ProcessAsync
ℹ️ Activity received
ℹ️ Finished processing activity"] D["TurnMiddleware Pipeline"] E["TeamsBotApplication.OnActivity
ℹ️ Routing incoming activity"] F["Router
⚠️ no routes found, or registered"] G["User Handler"] H["ConversationClient
ℹ️ sending message to url" ] I["BotAuthenticationHandler
ℹ️ Acquiring token for scope"] J["APX
"] A --> B --> C --> D --> E --> F --> G --> H --> I --> J ``` --- .../Microsoft.Teams.Bot.Apps/Routing/Router.cs | 5 ++++- .../TeamsBotApplication.cs | 2 +- .../KeyedBotAuthenticationHandler.cs | 2 +- .../Microsoft.Teams.Bot.Core/BotApplication.cs | 15 ++++++++++----- .../ConversationClient.cs | 2 +- .../HttpRequestExtensions.cs | 18 ++++++++++++++++++ 6 files changed, 35 insertions(+), 9 deletions(-) create mode 100644 core/src/Microsoft.Teams.Bot.Core/HttpRequestExtensions.cs diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs index 5c7b7048..27f1d721 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -67,7 +67,10 @@ public async Task DispatchAsync(Context ctx, CancellationToken ca if (matchingRoutes.Count == 0 && _routes.Count > 0) { - _logger.LogDebug("No routes matched activity of type '{Type}'.", ctx.Activity.Type); + _logger.LogWarning( + "No routes matched activity of type '{Type}'", + ctx.Activity.Type + ); return; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index 168569f3..ebcf3970 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -48,7 +48,7 @@ public TeamsBotApplication( Router = new Router(logger); OnActivity = async (activity, cancellationToken) => { - logger.LogInformation("New {Type} activity received.", activity.Type); + logger.LogInformation("OnActivity invoked for activity: Id={Id}", activity.Id); TeamsActivity teamsActivity = TeamsActivity.FromActivity(activity); Context defaultContext = new(this, teamsActivity); diff --git a/core/src/Microsoft.Teams.Bot.Compat/KeyedBotAuthenticationHandler.cs b/core/src/Microsoft.Teams.Bot.Compat/KeyedBotAuthenticationHandler.cs index 7e5f71ab..31ef4aa5 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/KeyedBotAuthenticationHandler.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/KeyedBotAuthenticationHandler.cs @@ -110,7 +110,7 @@ private async Task GetAuthorizationHeaderAsync(AgenticIdentity? agenticI !string.IsNullOrEmpty(agenticIdentity.AgenticUserId)) { _logger.LogInformation( - "Acquiring agentic token for scope '{Scope}' with AppId '{AppId}' and UserId '{UserId}'.", + "Acquiring agentic token for scope '{Scope}' with AppId '{AppId}' and AgentUserId '{AgentUserId}'.", _scope, agenticIdentity.AgenticAppId, agenticIdentity.AgenticUserId); diff --git a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index 5f0291c7..0c675619 100644 --- a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -79,29 +79,34 @@ public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancel CoreActivity activity = await CoreActivity.FromJsonStreamAsync(httpContext.Request.Body, cancellationToken).ConfigureAwait(false) ?? throw new InvalidOperationException("Invalid Activity"); - _logger.LogInformation("Processing activity {Type} {Id}", activity.Type, activity.Id); + _logger.LogInformation("Activity received: Type={Type} Id={Id} ServiceUrl={ServiceUrl} MSCV={MSCV}", + activity.Type, + activity.Id, + activity.ServiceUrl, + httpContext.Request.GetCorrelationVector()); if (_logger.IsEnabled(LogLevel.Trace)) { _logger.LogTrace("Received activity: {Activity}", activity.ToJson()); } - using (_logger.BeginScope("Processing activity {Type} {Id}", activity.Type, activity.Id)) + // TODO: Replace with structured scope data, ensure it works with OpenTelemetry and other logging providers + using (_logger.BeginScope("ActivityType={ActivityType} ActivityId={ActivityId} ServiceUrl={ServiceUrl} MSCV={MSCV}", + activity.Type, activity.Id, activity.ServiceUrl, httpContext.Request.GetCorrelationVector())) { try { CancellationToken token = Debugger.IsAttached ? CancellationToken.None : cancellationToken; await MiddleWare.RunPipelineAsync(this, activity, this.OnActivity, 0, token).ConfigureAwait(false); - } catch (Exception ex) { - _logger.LogError(ex, "Error processing activity {Type} {Id}", activity.Type, activity.Id); + _logger.LogError(ex, "Error processing activity: Id={Id}", activity.Id); throw new BotHandlerException("Error processing activity", ex, activity); } finally { - _logger.LogInformation("Finished processing activity {Type} {Id}", activity.Type, activity.Id); + _logger.LogInformation("Finished processing activity: Id={Id}", activity.Id); } } } diff --git a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs index ce93f9c3..cfdd7e6a 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs @@ -56,7 +56,7 @@ public async Task SendActivityAsync(CoreActivity activity, url += activity.ReplyToId; } - logger?.LogInformation("Sending activity to {Url}", url); + logger?.LogInformation("Sending activity with type `{Type}` to {Url}", activity.Type, url); string body = activity.ToJson(); diff --git a/core/src/Microsoft.Teams.Bot.Core/HttpRequestExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/HttpRequestExtensions.cs new file mode 100644 index 00000000..5d027b9f --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Core/HttpRequestExtensions.cs @@ -0,0 +1,18 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.AspNetCore.Http; + +namespace Microsoft.Teams.Bot.Core; + +/// +/// Extension methods for . +/// +public static class HttpRequestExtensions +{ + /// + /// Gets the Microsoft Correlation Vector (MS-CV) from the request headers, if present. + /// + public static string? GetCorrelationVector(this HttpRequest request) + => request != null ? request.Headers["MS-CV"].FirstOrDefault() : string.Empty; +} From b23042ba7a5e9048f84d1f92e2fc11f7b5b90199 Mon Sep 17 00:00:00 2001 From: Rido Date: Tue, 3 Mar 2026 17:09:20 -0800 Subject: [PATCH 66/69] CoreActivity, make From/Recipient/Conversation optional (nullable fields) (#360) This pull request introduces comprehensive changes to support nullability for key properties in activity-related classes and their usage throughout the codebase. The main goal is to improve robustness when handling activities that may lack sender, recipient, or conversation information, and to ensure consistent null handling in both implementation and tests. Key changes include: - Making `From`, `Recipient`, and `Conversation` properties nullable in activity and related classes. - Updating constructors, methods, and serialization logic to handle possible null values. - Adjusting tests to account for and verify nullability. The most important changes are: **Core Schema and Model Updates:** * Made the `From`, `Recipient`, and `Conversation` properties nullable in `CoreActivity`, `TeamsActivity`, and related classes, and updated constructors to handle null inputs gracefully. This ensures activities can be created and processed even when some participants or conversation info are missing. [[1]](diffhunk://#diff-aa65632fe28a87aec3d29025384c7f1e687d5839d848f1220e8ed59e76dcd35bL55-R63) [[2]](diffhunk://#diff-b9fe8c2661f373312865c34021dcd68b97c7a7308d3814767e941a9e275212f4L100-R134) [[3]](diffhunk://#diff-ab03c7985a1673a73536a9756293c78cba898a0de6197501e596ad144582a41aL31-R36) [[4]](diffhunk://#diff-5b4ce81153a4e786cdcc3ed1fce3951c3285b532d484ec1df6b20d9e40a359e4L48-R54) * Changed entity and attachment collections (`EntityList`, `TeamsAttachment`) to return `null` instead of empty collections when input JSON arrays are null, standardizing the nullability contract. [[1]](diffhunk://#diff-54676e96eda404a3efa65124857df40e5cb3e19ec4a2b1222c9e08cacac8eaa0L46-R50) [[2]](diffhunk://#diff-7d6dee59c1c828283d2d29d6f55c39949d8a35887c613f85643286c553e6f1a3L118-R122) **Method and API Usage Adjustments:** * Updated various method signatures and internal usages to accept nullable types and to check for nulls before accessing properties, including in `WithFrom`, `WithRecipient`, and `WithConversation` builder methods, and in `AgenticIdentity` extraction logic. [[1]](diffhunk://#diff-5e00975e375bcb87e6b0d28d2367d865865a1254f089cfcab0d6abbb5db4be38L147-R152) [[2]](diffhunk://#diff-21605a1ddfd84b8b511a41a957d5e130441cf05eb3dc192579480425e0746a0aL58-R58) [[3]](diffhunk://#diff-2b447b715e5c577302421ca232985ced9354b64def7b26219525758928d097daL61-R61) [[4]](diffhunk://#diff-d62a8ce4aac677906758eb430b84c9432f61ff95342701fdcae909310e2aed27L69-R69) [[5]](diffhunk://#diff-d62a8ce4aac677906758eb430b84c9432f61ff95342701fdcae909310e2aed27L99-R99) [[6]](diffhunk://#diff-d62a8ce4aac677906758eb430b84c9432f61ff95342701fdcae909310e2aed27L153-R153) [[7]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL152-R152) **Test Suite Updates:** * Updated unit tests to expect nulls for properties and collections where appropriate, and to use null-safe assertions and property access throughout. [[1]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL23-R25) [[2]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL115-R116) [[3]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL132-R133) [[4]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL152-R154) [[5]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL171-R172) [[6]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL262-R262) [[7]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL292-R292) [[8]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL415-R415) [[9]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL450-R454) [[10]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL536-R536) [[11]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL551-R551) [[12]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL679-R680) [[13]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL697-R698) [[14]](diffhunk://#diff-ec253b7d2876187c3585381aa6cd8b1cbfca2227eb6ac23752253bbcda19484fL714-R714) **Constructor and Null Handling Improvements:** * Constructors for `TeamsConversationAccount` and `TeamsConversation` now handle null arguments without throwing exceptions, returning early if input is null. [[1]](diffhunk://#diff-ab03c7985a1673a73536a9756293c78cba898a0de6197501e596ad144582a41aL31-R36) [[2]](diffhunk://#diff-5b4ce81153a4e786cdcc3ed1fce3951c3285b532d484ec1df6b20d9e40a359e4L48-R54) **General Codebase Consistency:** * Ensured all usages of `From`, `Recipient`, `Conversation`, `Entities`, and `Attachments` are null-safe across the codebase, including in activity updates, deletions, and proactive messaging scenarios. [[1]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL152-R152) [[2]](diffhunk://#diff-b9fe8c2661f373312865c34021dcd68b97c7a7308d3814767e941a9e275212f4R74-R88) These changes collectively make the bot framework more resilient to incomplete or partially populated activities and improve code safety and clarity when handling optional data. --- core/samples/CompatBot/EchoBot.cs | 2 +- .../Activities/InstallUpdateActivity.cs | 1 + .../Activities/MessageReactionActivity.cs | 1 + .../Schema/Entities/Entity.cs | 4 +- .../Schema/TeamsActivity.cs | 30 ++-- .../Schema/TeamsActivityBuilder.cs | 12 +- .../Schema/TeamsAttachment.cs | 4 +- .../Schema/TeamsConversation.cs | 35 ++--- .../Schema/TeamsConversationAccount.cs | 15 +- .../CompatConversations.cs | 2 +- .../CompatTeamsInfo.cs | 2 +- .../ConversationClient.cs | 6 +- .../Schema/CoreActivity.cs | 6 +- .../Schema/CoreActivityBuilder.cs | 18 +-- .../TeamsActivityBuilderTests.cs | 147 +++++++++--------- .../TeamsActivityTests.cs | 103 ++++++++++-- .../CompatActivityTests.cs | 24 +-- .../BotApplicationTests.cs | 17 +- .../ConversationClientTests.cs | 2 +- .../CoreActivityBuilderTests.cs | 50 +++--- .../MiddlewareTests.cs | 22 ++- .../Schema/CoreActivityTests.cs | 10 +- 22 files changed, 316 insertions(+), 197 deletions(-) diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index 1aadf094..ee1116bb 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -149,7 +149,7 @@ await conversationClient.UpdateActivityAsync( await Task.Delay(2000, cancellationToken); - await conversationClient.DeleteActivityAsync(cr.Conversation.Id, res.Id!, new Uri(turnContext.Activity.ServiceUrl), AgenticIdentity.FromProperties(ca.From.Properties), null, cancellationToken); + await conversationClient.DeleteActivityAsync(cr.Conversation.Id, res.Id!, new Uri(turnContext.Activity.ServiceUrl), AgenticIdentity.FromProperties(ca.From?.Properties), null, cancellationToken); await turnContext.SendActivityAsync(MessageFactory.Text("Proactive message sent and deleted."), cancellationToken); } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs index 67107f5f..35b51be9 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/InstallUpdateActivity.cs @@ -36,6 +36,7 @@ public InstallUpdateActivity() : base(TeamsActivityType.InstallationUpdate) /// The CoreActivity to convert. protected InstallUpdateActivity(CoreActivity activity) : base(activity) { + ArgumentNullException.ThrowIfNull(activity); if (activity.Properties.TryGetValue("action", out object? action)) { Action = action?.ToString(); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs index 01bd6970..63f1289e 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Activities/MessageReactionActivity.cs @@ -37,6 +37,7 @@ public MessageReactionActivity() : base(TeamsActivityType.MessageReaction) /// The CoreActivity to convert. protected MessageReactionActivity(CoreActivity activity) : base(activity) { + ArgumentNullException.ThrowIfNull(activity); if (activity.Properties.TryGetValue("reactionsAdded", out object? reactionsAdded) && reactionsAdded != null) { if (reactionsAdded is JsonElement je) diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs index 7eac6993..0408ea30 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs @@ -43,11 +43,11 @@ public class EntityList : List /// /// /// - public static EntityList FromJsonArray(JsonArray? jsonArray, JsonSerializerOptions? options = null) + public static EntityList? FromJsonArray(JsonArray? jsonArray, JsonSerializerOptions? options = null) { if (jsonArray == null) { - return []; + return null; } EntityList entities = []; foreach (JsonNode? item in jsonArray) diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs index 24d2b608..2bedb799 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivity.cs @@ -71,9 +71,21 @@ protected TeamsActivity(CoreActivity activity) : base(activity) { ChannelData = new TeamsChannelData(activity.ChannelData); } - From = new TeamsConversationAccount(activity.From); - Recipient = new TeamsConversationAccount(activity.Recipient); - Conversation = new TeamsConversation(activity.Conversation); + + if (activity.From is not null) + { + From = TeamsConversationAccount.FromConversationAccount(activity.From); + } + + if (activity.Recipient is not null) + { + Recipient = TeamsConversationAccount.FromConversationAccount(activity.Recipient); + } + + if (activity.Conversation is not null) + { + Conversation = TeamsConversation.FromConversation(activity.Conversation); + } Attachments = TeamsAttachment.FromJArray(activity.Attachments); Entities = EntityList.FromJsonArray(activity.Entities); @@ -97,9 +109,9 @@ internal TeamsActivity Rebase() /// Gets or sets the account information for the sender of the Teams conversation. /// [JsonPropertyName("from")] - public new TeamsConversationAccount From + public new TeamsConversationAccount? From { - get => base.From as TeamsConversationAccount ?? new TeamsConversationAccount(base.From); + get => base.From as TeamsConversationAccount; set => base.From = value; } @@ -107,9 +119,9 @@ internal TeamsActivity Rebase() /// Gets or sets the account information for the recipient of the Teams conversation. /// [JsonPropertyName("recipient")] - public new TeamsConversationAccount Recipient + public new TeamsConversationAccount? Recipient { - get => base.Recipient as TeamsConversationAccount ?? new TeamsConversationAccount(base.Recipient); + get => base.Recipient as TeamsConversationAccount; set => base.Recipient = value; } @@ -117,9 +129,9 @@ internal TeamsActivity Rebase() /// Gets or sets the conversation information for the Teams conversation. /// [JsonPropertyName("conversation")] - public new TeamsConversation Conversation + public new TeamsConversation? Conversation { - get => base.Conversation as TeamsConversation ?? new TeamsConversation(base.Conversation); + get => base.Conversation as TeamsConversation; set => base.Conversation = value; } diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs index 1c9d4223..89dd1ba3 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityBuilder.cs @@ -28,31 +28,31 @@ internal TeamsActivityBuilder(TeamsActivity activity) : base(activity) /// /// Sets the conversation (override for Teams-specific type). /// - protected override void SetConversation(Conversation conversation) + protected override void SetConversation(Conversation? conversation) { _activity.Conversation = conversation is TeamsConversation teamsConv ? teamsConv - : new TeamsConversation(conversation); + : TeamsConversation.FromConversation(conversation); } /// /// Sets the From account (override for Teams-specific type). /// - protected override void SetFrom(ConversationAccount from) + protected override void SetFrom(ConversationAccount? from) { _activity.From = from is TeamsConversationAccount teamsAccount ? teamsAccount - : new TeamsConversationAccount(from); + : TeamsConversationAccount.FromConversationAccount(from); } /// /// Sets the Recipient account (override for Teams-specific type). /// - protected override void SetRecipient(ConversationAccount recipient) + protected override void SetRecipient(ConversationAccount? recipient) { _activity.Recipient = recipient is TeamsConversationAccount teamsAccount ? teamsAccount - : new TeamsConversationAccount(recipient); + : TeamsConversationAccount.FromConversationAccount(recipient); } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs index 929ef71a..6832acbe 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsAttachment.cs @@ -115,11 +115,11 @@ static internal JsonArray ToJsonArray(this IList attachments) /// public class TeamsAttachment { - static internal IList FromJArray(JsonArray? jsonArray) + static internal IList? FromJArray(JsonArray? jsonArray) { if (jsonArray is null) { - return []; + return null; } List attachments = []; foreach (JsonNode? item in jsonArray) diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs index 74fe3484..64429c7a 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs @@ -42,36 +42,35 @@ public TeamsConversation() } /// - /// Creates a new instance of the TeamsConversation class from the specified Conversation object. + /// Creates a Teams Conversation from a Conversation /// /// - public TeamsConversation(Conversation conversation) + /// + public static TeamsConversation? FromConversation(Conversation? conversation) { - ArgumentNullException.ThrowIfNull(conversation); - Id = conversation.Id; + if (conversation is null) + { + return null; + } + TeamsConversation result = new TeamsConversation(); + result.Id = conversation.Id; if (conversation.Properties == null) { - return; + return result; } - if (conversation.Properties.TryGetValue("tenantId", out object? tenantObj) && tenantObj is JsonElement je && je.ValueKind == JsonValueKind.String) + if (conversation.Properties.TryGetValue("tenantId", out object? tenantObj)) { - TenantId = je.GetString(); + result.TenantId = tenantObj?.ToString(); } - if (conversation.Properties.TryGetValue("conversationType", out object? convTypeObj) && convTypeObj is JsonElement je2 && je2.ValueKind == JsonValueKind.String) + if (conversation.Properties.TryGetValue("conversationType", out object? convTypeObj)) { - ConversationType = je2.GetString(); + result.ConversationType = convTypeObj?.ToString(); } - if (conversation.Properties.TryGetValue("isGroup", out object? isGroupObj) && isGroupObj is JsonElement je3) + if (conversation.Properties.TryGetValue("isGroup", out object? isGroupObj)) { - if (je3.ValueKind == JsonValueKind.True) - { - IsGroup = true; - } - else if (je3.ValueKind == JsonValueKind.False) - { - IsGroup = false; - } + result.IsGroup = Convert.ToBoolean(isGroupObj?.ToString()); } + return result; } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs index f8c4df26..15cf5007 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs @@ -28,12 +28,17 @@ public TeamsConversationAccount() /// Initializes a new instance of the TeamsConversationAccount class using the specified conversation account. /// /// The ConversationAccount instance containing the conversation's identifier, name, and properties. Cannot be null. - public TeamsConversationAccount(ConversationAccount conversationAccount) + public static TeamsConversationAccount? FromConversationAccount(ConversationAccount? conversationAccount) { - ArgumentNullException.ThrowIfNull(conversationAccount); - Id = conversationAccount.Id; - Name = conversationAccount.Name; - Properties = conversationAccount.Properties; + if (conversationAccount is null) + { + return null; + } + TeamsConversationAccount result = new TeamsConversationAccount(); + result.Id = conversationAccount.Id; + result.Name = conversationAccount.Name; + result.Properties = conversationAccount.Properties; + return result; } /// diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs index 0c382810..d1562500 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatConversations.cs @@ -58,7 +58,7 @@ public async Task> CreateCon CreateConversationResponse res = await _client.CreateConversationAsync( convoParams, new Uri(ServiceUrl), - AgenticIdentity.FromProperties(convoParams.Activity?.From.Properties), + AgenticIdentity.FromProperties(convoParams.Activity?.From?.Properties), convertedHeaders, cancellationToken).ConfigureAwait(false); diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs index c0368b97..5c96c80d 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs @@ -55,7 +55,7 @@ private static string GetServiceUrl(ITurnContext turnContext) private static AgenticIdentity GetIdentity(ITurnContext turnContext) { CoreActivity coreActivity = turnContext.Activity.FromCompatActivity(); - return AgenticIdentity.FromProperties(coreActivity.From.Properties) ?? new AgenticIdentity(); + return AgenticIdentity.FromProperties(coreActivity.From?.Properties) ?? new AgenticIdentity(); } #endregion diff --git a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs index cfdd7e6a..3aebf412 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs @@ -66,7 +66,7 @@ public async Task SendActivityAsync(CoreActivity activity, HttpMethod.Post, url, body, - CreateRequestOptions(activity.From.GetAgenticIdentity(), "sending activity", customHeaders), + CreateRequestOptions(activity.From?.GetAgenticIdentity(), "sending activity", customHeaders), cancellationToken).ConfigureAwait(false))!; } @@ -96,7 +96,7 @@ public async Task UpdateActivityAsync(string conversatio HttpMethod.Put, url, body, - CreateRequestOptions(activity.From.GetAgenticIdentity(), "updating activity", customHeaders), + CreateRequestOptions(activity.From?.GetAgenticIdentity(), "updating activity", customHeaders), cancellationToken).ConfigureAwait(false))!; } @@ -150,7 +150,7 @@ await DeleteActivityAsync( activity.Conversation.Id, activity.Id, activity.ServiceUrl, - activity.From.GetAgenticIdentity(), + activity.From?.GetAgenticIdentity(), customHeaders, cancellationToken).ConfigureAwait(false); } diff --git a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs index 6960e6bc..0cc30d63 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivity.cs @@ -52,15 +52,15 @@ public class CoreActivity /// /// Gets or sets the account that sent this activity. /// - [JsonPropertyName("from")] public ConversationAccount From { get; set; } = new(); + [JsonPropertyName("from")] public ConversationAccount? From { get; set; } /// /// Gets or sets the account that should receive this activity. /// - [JsonPropertyName("recipient")] public ConversationAccount Recipient { get; set; } = new(); + [JsonPropertyName("recipient")] public ConversationAccount? Recipient { get; set; } /// /// Gets or sets the conversation in which this activity is taking place. /// - [JsonPropertyName("conversation")] public Conversation Conversation { get; set; } = new(); + [JsonPropertyName("conversation")] public Conversation? Conversation { get; set; } /// /// Gets the collection of entities contained in this activity. diff --git a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs index 317435ea..cf65c86f 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Schema/CoreActivityBuilder.cs @@ -60,17 +60,17 @@ public TBuilder WithConversationReference(TActivity activity) /// /// Sets the conversation (to be overridden by derived classes for type-specific behavior). /// - protected abstract void SetConversation(Conversation conversation); + protected abstract void SetConversation(Conversation? conversation); /// /// Sets the From account (to be overridden by derived classes for type-specific behavior). /// - protected abstract void SetFrom(ConversationAccount from); + protected abstract void SetFrom(ConversationAccount? from); /// /// Sets the Recipient account (to be overridden by derived classes for type-specific behavior). /// - protected abstract void SetRecipient(ConversationAccount recipient); + protected abstract void SetRecipient(ConversationAccount? recipient); /// /// Sets the activity ID. @@ -144,7 +144,7 @@ public TBuilder WithProperty(string name, T? value) /// /// The sender account. /// The builder instance for chaining. - public TBuilder WithFrom(ConversationAccount from) + public TBuilder WithFrom(ConversationAccount? from) { SetFrom(from); return (TBuilder)this; @@ -155,7 +155,7 @@ public TBuilder WithFrom(ConversationAccount from) /// /// The recipient account. /// The builder instance for chaining. - public TBuilder WithRecipient(ConversationAccount recipient) + public TBuilder WithRecipient(ConversationAccount? recipient) { SetRecipient(recipient); return (TBuilder)this; @@ -166,7 +166,7 @@ public TBuilder WithRecipient(ConversationAccount recipient) /// /// The conversation information. /// The builder instance for chaining. - public TBuilder WithConversation(Conversation conversation) + public TBuilder WithConversation(Conversation? conversation) { SetConversation(conversation); return (TBuilder)this; @@ -213,7 +213,7 @@ internal CoreActivityBuilder(CoreActivity activity) : base(activity) /// /// Sets the conversation. /// - protected override void SetConversation(Conversation conversation) + protected override void SetConversation(Conversation? conversation) { _activity.Conversation = conversation; } @@ -221,7 +221,7 @@ protected override void SetConversation(Conversation conversation) /// /// Sets the From account. /// - protected override void SetFrom(ConversationAccount from) + protected override void SetFrom(ConversationAccount? from) { _activity.From = from; } @@ -229,7 +229,7 @@ protected override void SetFrom(ConversationAccount from) /// /// Sets the Recipient account. /// - protected override void SetRecipient(ConversationAccount recipient) + protected override void SetRecipient(ConversationAccount? recipient) { _activity.Recipient = recipient; } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs index 3d25944b..3a29e102 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs @@ -17,12 +17,12 @@ public TeamsActivityBuilderTests() [Fact] public void Constructor_DefaultConstructor_CreatesNewActivity() { - TeamsActivity activity = builder.Build(); + TeamsActivity activity = TeamsActivity.CreateBuilder().Build(); Assert.NotNull(activity); - Assert.NotNull(activity.From); - Assert.NotNull(activity.Recipient); - Assert.NotNull(activity.Conversation); + Assert.Null(activity.From); + Assert.Null(activity.Recipient); + Assert.Null(activity.Conversation); } [Fact] @@ -102,7 +102,7 @@ public void WithText_SetsTextContent() [Fact] public void WithFrom_SetsSenderAccount() { - TeamsConversationAccount fromAccount = new(new ConversationAccount + TeamsConversationAccount? fromAccount = TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "sender-id", Name = "Sender Name" @@ -112,46 +112,47 @@ public void WithFrom_SetsSenderAccount() .WithFrom(fromAccount) .Build(); - Assert.Equal("sender-id", activity.From.Id); - Assert.Equal("Sender Name", activity.From.Name); + Assert.Equal("sender-id", activity.From?.Id); + Assert.Equal("Sender Name", activity.From?.Name); } [Fact] public void WithRecipient_SetsRecipientAccount() { - TeamsConversationAccount recipientAccount = new(new ConversationAccount + TeamsConversationAccount? recipientAccount = TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "recipient-id", Name = "Recipient Name" }); - + Assert.NotNull(recipientAccount); var activity = builder .WithRecipient(recipientAccount) .Build(); - Assert.Equal("recipient-id", activity.Recipient.Id); - Assert.Equal("Recipient Name", activity.Recipient.Name); + Assert.Equal("recipient-id", activity.Recipient?.Id); + Assert.Equal("Recipient Name", activity.Recipient?.Name); } [Fact] public void WithConversation_SetsConversationInfo() { - TeamsConversation conversation = new(new Conversation + Conversation baseConversation = new Conversation { Id = "conversation-id" - }) - { - TenantId = "tenant-123", - ConversationType = "channel" }; + Assert.NotNull(baseConversation); + baseConversation.Properties.Add("tenantId", "tenant-123"); + baseConversation.Properties.Add("conversationType", "channel"); + TeamsConversation? conversation = TeamsConversation.FromConversation(baseConversation); + var activity = builder .WithConversation(conversation) .Build(); - Assert.Equal("conversation-id", activity.Conversation.Id); - Assert.Equal("tenant-123", activity.Conversation.TenantId); - Assert.Equal("channel", activity.Conversation.ConversationType); + Assert.Equal("conversation-id", activity.Conversation?.Id); + Assert.Equal("tenant-123", activity.Conversation?.TenantId); + Assert.Equal("channel", activity.Conversation?.ConversationType); } [Fact] @@ -168,8 +169,8 @@ public void WithChannelData_SetsChannelData() .Build(); Assert.NotNull(activity.ChannelData); - Assert.Equal("19:channel-id@thread.tacv2", activity.ChannelData.TeamsChannelId); - Assert.Equal("19:team-id@thread.tacv2", activity.ChannelData.TeamsTeamId); + Assert.Equal("19:channel-id@thread.tacv2", activity.ChannelData?.TeamsChannelId); + Assert.Equal("19:team-id@thread.tacv2", activity.ChannelData?.TeamsTeamId); } [Fact] @@ -259,7 +260,7 @@ public void AddEntity_MultipleEntities_AddsAllToCollection() .Build(); Assert.NotNull(activity.Entities); - Assert.Equal(2, activity.Entities.Count); + Assert.Equal(2, activity.Entities?.Count); } [Fact] @@ -289,7 +290,7 @@ public void AddAttachment_MultipleAttachments_AddsAllToCollection() .Build(); Assert.NotNull(activity.Attachments); - Assert.Equal(2, activity.Attachments.Count); + Assert.Equal(2, activity.Attachments?.Count); } [Fact] @@ -412,7 +413,7 @@ public void AddMention_MultipleMentions_AddsAllMentions() Assert.Equal("User Two User One message", activity.Properties["text"]); Assert.NotNull(activity.Entities); - Assert.Equal(2, activity.Entities.Count); + Assert.Equal(2, activity.Entities?.Count); } [Fact] @@ -424,17 +425,17 @@ public void FluentAPI_CompleteActivity_BuildsCorrectly() .WithChannelId("msteams") .WithText("Test message") .WithServiceUrl(new Uri("https://smba.trafficmanager.net/teams/")) - .WithFrom(new TeamsConversationAccount(new ConversationAccount + .WithFrom(TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "sender-id", Name = "Sender" })) - .WithRecipient(new TeamsConversationAccount(new ConversationAccount + .WithRecipient(TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "recipient-id", Name = "Recipient" })) - .WithConversation(new TeamsConversation(new Conversation + .WithConversation(TeamsConversation.FromConversation(new Conversation { Id = "conv-id" })) @@ -447,11 +448,11 @@ public void FluentAPI_CompleteActivity_BuildsCorrectly() Assert.Equal("activity-123", activity.Id); Assert.Equal("msteams", activity.ChannelId); Assert.Equal("User Test message", activity.Properties["text"]); - Assert.Equal("sender-id", activity.From.Id); - Assert.Equal("recipient-id", activity.Recipient.Id); - Assert.Equal("conv-id", activity.Conversation.Id); + Assert.Equal("sender-id", activity.From?.Id); + Assert.Equal("recipient-id", activity.Recipient?.Id); + Assert.Equal("conv-id", activity.Conversation?.Id); Assert.NotNull(activity.Entities); - Assert.Equal(2, activity.Entities.Count); // ClientInfo + Mention + Assert.Equal(2, activity.Entities?.Count); // ClientInfo + Mention Assert.NotNull(activity.Attachments); Assert.Single(activity.Attachments); } @@ -533,7 +534,7 @@ public void AddEntity_NullEntitiesCollection_InitializesCollection() { TeamsActivity activity = builder.Build(); - Assert.NotNull(activity.Entities); + Assert.Null(activity.Entities); ClientInfoEntity entity = new() { Locale = "en-US" }; builder.AddEntity(entity); @@ -548,7 +549,7 @@ public void AddAttachment_NullAttachmentsCollection_InitializesCollection() { TeamsActivity activity = builder.Build(); - Assert.NotNull(activity.Attachments); + Assert.Null(activity.Attachments); TeamsAttachment attachment = new() { ContentType = "text/html" }; builder.AddAttachment(attachment); @@ -588,9 +589,9 @@ public void WithConversationReference_WithNullChannelId_ThrowsArgumentNullExcept { ChannelId = null, ServiceUrl = new Uri("https://test.com"), - Conversation = new TeamsConversation(new Conversation()), - From = new TeamsConversationAccount(new ConversationAccount()), - Recipient = new TeamsConversationAccount(new ConversationAccount()) + Conversation = TeamsConversation.FromConversation(new Conversation()), + From = TeamsConversationAccount.FromConversationAccount(new ConversationAccount()), + Recipient = TeamsConversationAccount.FromConversationAccount(new ConversationAccount()) }; Assert.Throws(() => builder.WithConversationReference(sourceActivity)); @@ -603,9 +604,9 @@ public void WithConversationReference_WithNullServiceUrl_ThrowsArgumentNullExcep { ChannelId = "msteams", ServiceUrl = null, - Conversation = new TeamsConversation(new Conversation()), - From = new TeamsConversationAccount(new ConversationAccount()), - Recipient = new TeamsConversationAccount(new ConversationAccount()) + Conversation = TeamsConversation.FromConversation(new Conversation()), + From = TeamsConversationAccount.FromConversationAccount(new ConversationAccount()), + Recipient = TeamsConversationAccount.FromConversationAccount(new ConversationAccount()) }; Assert.Throws(() => builder.WithConversationReference(sourceActivity)); @@ -618,9 +619,9 @@ public void WithConversationReference_WithEmptyConversationId_DoesNotThrow() { ChannelId = "msteams", ServiceUrl = new Uri("https://test.com"), - Conversation = new TeamsConversation(new Conversation()), - From = new TeamsConversationAccount(new ConversationAccount { Id = "user-1" }), - Recipient = new TeamsConversationAccount(new ConversationAccount { Id = "bot-1" }) + Conversation = TeamsConversation.FromConversation(new Conversation()), + From = TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "user-1" }), + Recipient = TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "bot-1" }) }; TeamsActivity result = builder.WithConversationReference(sourceActivity).Build(); @@ -635,9 +636,9 @@ public void WithConversationReference_WithEmptyFromId_DoesNotThrow() { ChannelId = "msteams", ServiceUrl = new Uri("https://test.com"), - Conversation = new TeamsConversation(new Conversation { Id = "conv-1" }), - From = new TeamsConversationAccount(new ConversationAccount()), - Recipient = new TeamsConversationAccount(new ConversationAccount { Id = "bot-1" }) + Conversation = TeamsConversation.FromConversation(new Conversation { Id = "conv-1" }), + From = TeamsConversationAccount.FromConversationAccount(new ConversationAccount()), + Recipient = TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "bot-1" }) }; TeamsActivity result = builder.WithConversationReference(sourceActivity).Build(); @@ -652,9 +653,9 @@ public void WithConversationReference_WithEmptyRecipientId_DoesNotThrow() { ChannelId = "msteams", ServiceUrl = new Uri("https://test.com"), - Conversation = new TeamsConversation(new Conversation { Id = "conv-1" }), - From = new TeamsConversationAccount(new ConversationAccount { Id = "user-1" }), - Recipient = new TeamsConversationAccount(new ConversationAccount()) + Conversation = TeamsConversation.FromConversation(new Conversation { Id = "conv-1" }), + From = TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "user-1" }), + Recipient = TeamsConversationAccount.FromConversationAccount(new ConversationAccount()) }; TeamsActivity result = builder.WithConversationReference(sourceActivity).Build(); @@ -676,8 +677,8 @@ public void WithFrom_WithBaseConversationAccount_ConvertsToTeamsConversationAcco .Build(); Assert.IsType(activity.From); - Assert.Equal("user-123", activity.From.Id); - Assert.Equal("User Name", activity.From.Name); + Assert.Equal("user-123", activity.From?.Id); + Assert.Equal("User Name", activity.From?.Name); } [Fact] @@ -694,8 +695,8 @@ public void WithRecipient_WithBaseConversationAccount_ConvertsToTeamsConversatio .Build(); Assert.IsType(activity.Recipient); - Assert.Equal("bot-123", activity.Recipient.Id); - Assert.Equal("Bot Name", activity.Recipient.Name); + Assert.Equal("bot-123", activity.Recipient?.Id); + Assert.Equal("Bot Name", activity.Recipient?.Name); } [Fact] @@ -711,7 +712,7 @@ public void WithConversation_WithBaseConversation_ConvertsToTeamsConversation() .Build(); Assert.IsType(activity.Conversation); - Assert.Equal("conv-123", activity.Conversation.Id); + Assert.Equal("conv-123", activity.Conversation?.Id); } [Fact] @@ -784,30 +785,36 @@ public void IntegrationTest_CreateComplexActivity() TeamsTeamId = "19:team@thread.tacv2" }; + var conv = new Conversation + { + Id = "conv-001", + Properties = + { + { "tenantId", "tenant-001" }, + { "conversationType", "channel" } + } + }; + + TeamsConversation? tc = TeamsConversation.FromConversation(conv); + Assert.NotNull(tc); + TeamsActivity activity = builder .WithType(TeamsActivityType.Message) .WithId("msg-001") .WithServiceUrl(serviceUrl) .WithChannelId("msteams") .WithText("Please review this document") - .WithFrom(new TeamsConversationAccount(new ConversationAccount + .WithFrom(TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "bot-id", Name = "Bot" })) - .WithRecipient(new TeamsConversationAccount(new ConversationAccount + .WithRecipient(TeamsConversationAccount.FromConversationAccount(new ConversationAccount { Id = "user-id", Name = "User" })) - .WithConversation(new TeamsConversation(new Conversation - { - Id = "conv-001" - }) - { - TenantId = "tenant-001", - ConversationType = "channel" - }) + .WithConversation(tc) .WithChannelData(channelData) .AddEntity(new ClientInfoEntity { @@ -833,15 +840,15 @@ public void IntegrationTest_CreateComplexActivity() Assert.Equal(serviceUrl, activity.ServiceUrl); Assert.Equal("msteams", activity.ChannelId); Assert.Equal("Manager Please review this document", activity.Properties["text"]); - Assert.Equal("bot-id", activity.From.Id); - Assert.Equal("user-id", activity.Recipient.Id); - Assert.Equal("conv-001", activity.Conversation.Id); - Assert.Equal("tenant-001", activity.Conversation.TenantId); - Assert.Equal("channel", activity.Conversation.ConversationType); + Assert.Equal("bot-id", activity.From?.Id); + Assert.Equal("user-id", activity.Recipient?.Id); + Assert.Equal("conv-001", activity.Conversation?.Id); + Assert.Equal("tenant-001", activity.Conversation?.TenantId); + Assert.Equal("channel", activity.Conversation?.ConversationType); Assert.NotNull(activity.ChannelData); - Assert.Equal("19:channel@thread.tacv2", activity.ChannelData.TeamsChannelId); + Assert.Equal("19:channel@thread.tacv2", activity.ChannelData?.TeamsChannelId); Assert.NotNull(activity.Entities); - Assert.Equal(2, activity.Entities.Count); // ClientInfo + Mention + Assert.Equal(2, activity.Entities?.Count); // ClientInfo + Mention Assert.NotNull(activity.Attachments); Assert.Single(activity.Attachments); } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs index 99eea281..ef737604 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using Microsoft.AspNetCore.Mvc.ApplicationParts; using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.UnitTests; @@ -214,6 +215,91 @@ public void FromActivity_Overrides_Recipient() Assert.Equal("24fff850-d7fb-4d32-a6e7-a1178874430e", agenticIdentity.AgenticAppBlueprintId); } + [Fact] + public void FromActivity_ReturnsDerivedType_WhenRegistered() + { + CoreActivity coreActivity = new CoreActivity(ActivityType.Message); + TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); + + Assert.IsType(activity); + } + + [Fact] + public void FromActivity_ReturnsBaseType_WhenNotRegistered() + { + CoreActivity coreActivity = new CoreActivity("unknownType"); + TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); + + Assert.Equal(typeof(TeamsActivity), activity.GetType()); + Assert.Equal("unknownType", activity.Type); + } + + [Fact] + public void EmptyTeamsActivity() + { + string minActivityJson = """ + { + "type": "message" + } + """; + + var teamsActivity = TeamsActivity.CreateBuilder().Build(); + Assert.NotNull(teamsActivity); + var json = teamsActivity.ToJson(); + Assert.Equal(minActivityJson, json); + } + + [Fact] + public void BaseFieldsAsBaseTypes() + { + CoreActivity ca = new CoreActivity(); + ca.Conversation = new Conversation() { Id = "conv1" }; + ca.Conversation.Properties.Add("tenantId", "tenant-1"); + CoreActivity ta = TeamsActivity.FromActivity(ca); + if (ta.Conversation is not null) + { + Assert.NotNull(ta.Conversation); + Assert.Equal("conv1", ta.Conversation.Id); + Assert.Empty(ta.Conversation.Properties); + } + else + { + Assert.Fail("Conversation not set"); + } + } + + [Fact] + public void Deserialize_with_Conversation_and_Tenant() + { + var json = """ + { + "type" : "message", + "conversation": { + "id" : "conv1", + "tenantId" : "tenant-1" + } + } + """; + var ca = CoreActivity.FromJsonString(json); + Assert.NotNull(ca); + Assert.NotNull(ca.Conversation); + Assert.Equal("conv1", ca.Conversation.Id); + if (ca.Conversation.Properties.TryGetValue("tenantId", out var outTenantId)) + { + Assert.Equal("tenant-1", outTenantId?.ToString()); + } + else + { + Assert.Fail("conversation tenant not set"); + } + TeamsActivity ta = TeamsActivity.FromActivity(ca); + Assert.NotNull(ta); + Assert.NotNull(ta.Conversation); + Assert.Equal("conv1", ta.Conversation.Id); + Assert.Equal("tenant-1", ta.Conversation.TenantId); + } + + private const string jsonInvoke = """ { "type": "invoke", @@ -339,22 +425,5 @@ public void FromActivity_Overrides_Recipient() } """; - [Fact] - public void FromActivity_ReturnsDerivedType_WhenRegistered() - { - CoreActivity coreActivity = new CoreActivity(ActivityType.Message); - TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); - - Assert.IsType(activity); - } - - [Fact] - public void FromActivity_ReturnsBaseType_WhenNotRegistered() - { - CoreActivity coreActivity = new CoreActivity("unknownType"); - TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); - Assert.Equal(typeof(TeamsActivity), activity.GetType()); - Assert.Equal("unknownType", activity.Type); - } } diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs index 455f1239..6f24bccb 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs @@ -35,10 +35,10 @@ public void FromCompatActivity_PreservesCoreProperties() Assert.Equal(activity.ServiceUrl, coreActivity.ServiceUrl?.ToString()); Assert.Equal(activity.ChannelId, coreActivity.ChannelId); Assert.Equal(activity.Id, coreActivity.Id); - Assert.Equal(activity.From.Id, coreActivity.From.Id); - Assert.Equal(activity.From.Name, coreActivity.From.Name); - Assert.Equal(activity.Recipient.Id, coreActivity.Recipient.Id); - Assert.Equal(activity.Conversation.Id, coreActivity.Conversation.Id); + Assert.Equal(activity.From?.Id, coreActivity.From?.Id); + Assert.Equal(activity.From?.Name, coreActivity.From?.Name); + Assert.Equal(activity.Recipient?.Id, coreActivity.Recipient?.Id); + Assert.Equal(activity.Conversation?.Id, coreActivity.Conversation?.Id); } [Fact] @@ -91,8 +91,8 @@ public void FromCompatActivity_PreservesAdaptiveCardAttachment() var content = attachmentObj["content"]; Assert.NotNull(content); var card = AdaptiveCard.FromJson(content.ToJsonString()).Card; - Assert.Equal(2, card.Body.Count); - var firstTextBlock = card.Body[0] as AdaptiveTextBlock; + Assert.Equal(2, card.Body?.Count); + var firstTextBlock = card?.Body?[0] as AdaptiveTextBlock; Assert.NotNull(firstTextBlock); Assert.Equal("Mention a user by User Principle Name: Hello Test User UPN", firstTextBlock.Text); } @@ -113,9 +113,9 @@ public void FromCompatActivity_PreservesMultipleAttachments() CoreActivity coreActivity = activity.FromCompatActivity(); Assert.NotNull(coreActivity.Attachments); - Assert.Equal(2, coreActivity.Attachments.Count); - Assert.Equal("text/plain", coreActivity.Attachments[0]?["contentType"]?.GetValue()); - Assert.Equal("image/png", coreActivity.Attachments[1]?["contentType"]?.GetValue()); + Assert.Equal(2, coreActivity.Attachments?.Count); + Assert.Equal("text/plain", coreActivity.Attachments?[0]?["contentType"]?.GetValue()); + Assert.Equal("image/png", coreActivity.Attachments?[1]?["contentType"]?.GetValue()); } #endregion @@ -147,12 +147,12 @@ public void FromCompatActivity_PreservesMultipleEntities() CoreActivity coreActivity = botActivity.FromCompatActivity(); Assert.NotNull(coreActivity.Entities); - Assert.Equal(2, coreActivity.Entities.Count); + Assert.Equal(2, coreActivity.Entities?.Count); - var firstEntity = coreActivity.Entities[0]?.AsObject(); + var firstEntity = coreActivity.Entities?[0]?.AsObject(); Assert.Equal("https://schema.org/Message", firstEntity?["type"]?.GetValue()); - var secondEntity = coreActivity.Entities[1]?.AsObject(); + var secondEntity = coreActivity.Entities?[1]?.AsObject(); Assert.Equal("BotMessageMetadata", secondEntity?["type"]?.GetValue()); } diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs index fde05efb..93e82b7f 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs @@ -51,7 +51,11 @@ public async Task ProcessAsync_WithValidActivity_ProcessesSuccessfully() Id = "act123" }; activity.Properties["text"] = "Test message"; - activity.Recipient.Properties["appId"] = "test-app-id"; + + if (activity.Recipient is not null) + { + activity.Recipient.Properties["appId"] = "test-app-id"; + } DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); @@ -77,7 +81,10 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() Type = ActivityType.Message, Id = "act123" }; - activity.Recipient.Properties["appId"] = "test-app-id"; + if (activity.Recipient is not null) + { + activity.Recipient.Properties["appId"] = "test-app-id"; + } DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); @@ -117,7 +124,11 @@ public async Task ProcessAsync_WithException_ThrowsBotHandlerException() Type = ActivityType.Message, Id = "act123" }; - activity.Recipient.Properties["appId"] = "test-app-id"; + + if (activity.Recipient is not null) + { + activity.Recipient.Properties["appId"] = "test-app-id"; + } DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs index c520b16b..89efedf2 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs @@ -66,7 +66,7 @@ public async Task SendActivityAsync_WithNullConversation_ThrowsArgumentNullExcep ServiceUrl = new Uri("https://test.service.url/") }; - await Assert.ThrowsAsync(() => + await Assert.ThrowsAsync(() => conversationClient.SendActivityAsync(activity)); } diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/CoreActivityBuilderTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/CoreActivityBuilderTests.cs index c3f62fd0..39669430 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/CoreActivityBuilderTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/CoreActivityBuilderTests.cs @@ -14,9 +14,9 @@ public void Constructor_DefaultConstructor_CreatesNewActivity() CoreActivity activity = builder.Build(); Assert.NotNull(activity); - Assert.NotNull(activity.From); - Assert.NotNull(activity.Recipient); - Assert.NotNull(activity.Conversation); + Assert.Null(activity.From); + Assert.Null(activity.Recipient); + Assert.Null(activity.Conversation); } [Fact] @@ -104,8 +104,8 @@ public void WithFrom_SetsSenderAccount() .WithFrom(fromAccount) .Build(); - Assert.Equal("sender-id", activity.From.Id); - Assert.Equal("Sender Name", activity.From.Name); + Assert.Equal("sender-id", activity.From?.Id); + Assert.Equal("Sender Name", activity.From?.Name); } [Fact] @@ -121,8 +121,8 @@ public void WithRecipient_SetsRecipientAccount() .WithRecipient(recipientAccount) .Build(); - Assert.Equal("recipient-id", activity.Recipient.Id); - Assert.Equal("Recipient Name", activity.Recipient.Name); + Assert.Equal("recipient-id", activity.Recipient?.Id); + Assert.Equal("Recipient Name", activity.Recipient?.Name); } [Fact] @@ -137,7 +137,7 @@ public void WithConversation_SetsConversationInfo() .WithConversation(conversation) .Build(); - Assert.Equal("conversation-id", activity.Conversation.Id); + Assert.Equal("conversation-id", activity.Conversation?.Id); } [Fact] @@ -181,9 +181,9 @@ public void FluentAPI_CompleteActivity_BuildsCorrectly() Assert.Equal("activity-123", activity.Id); Assert.Equal("msteams", activity.ChannelId); Assert.Equal("Test message", activity.Properties["text"]?.ToString()); - Assert.Equal("sender-id", activity.From.Id); - Assert.Equal("recipient-id", activity.Recipient.Id); - Assert.Equal("conv-id", activity.Conversation.Id); + Assert.Equal("sender-id", activity.From?.Id); + Assert.Equal("recipient-id", activity.Recipient?.Id); + Assert.Equal("conv-id", activity.Conversation?.Id); } [Fact] @@ -335,11 +335,11 @@ public void WithConversationReference_AppliesConversationReference() Assert.Equal("msteams", activity.ChannelId); Assert.Equal(new Uri("https://smba.trafficmanager.net/teams/"), activity.ServiceUrl); - Assert.Equal("conv-123", activity.Conversation.Id); - Assert.Equal("bot-1", activity.From.Id); - Assert.Equal("Bot", activity.From.Name); - Assert.Equal("user-1", activity.Recipient.Id); - Assert.Equal("User One", activity.Recipient.Name); + Assert.Equal("conv-123", activity.Conversation?.Id); + Assert.Equal("bot-1", activity.From?.Id); + Assert.Equal("Bot", activity.From?.Name); + Assert.Equal("user-1", activity.Recipient?.Id); + Assert.Equal("User One", activity.Recipient?.Name); } [Fact] @@ -358,10 +358,10 @@ public void WithConversationReference_SwapsFromAndRecipient() .WithConversationReference(incomingActivity) .Build(); - Assert.Equal("bot-id", replyActivity.From.Id); - Assert.Equal("Bot", replyActivity.From.Name); - Assert.Equal("user-id", replyActivity.Recipient.Id); - Assert.Equal("User", replyActivity.Recipient.Name); + Assert.Equal("bot-id", replyActivity.From?.Id); + Assert.Equal("Bot", replyActivity.From?.Name); + Assert.Equal("user-id", replyActivity.Recipient?.Id); + Assert.Equal("User", replyActivity.Recipient?.Name); } [Fact] @@ -423,8 +423,8 @@ public void WithConversationReference_ChainedWithOtherMethods_MaintainsFluentInt .Build(); Assert.Equal(ActivityType.Message, activity.Type); - Assert.Equal("bot-1", activity.From.Id); - Assert.Equal("user-1", activity.Recipient.Id); + Assert.Equal("bot-1", activity.From?.Id); + Assert.Equal("user-1", activity.Recipient?.Id); } [Fact] @@ -475,9 +475,9 @@ public void IntegrationTest_CreateComplexActivity() Assert.Equal("msg-001", activity.Id); Assert.Equal(serviceUrl, activity.ServiceUrl); Assert.Equal("msteams", activity.ChannelId); - Assert.Equal("bot-id", activity.From.Id); - Assert.Equal("user-id", activity.Recipient.Id); - Assert.Equal("conv-001", activity.Conversation.Id); + Assert.Equal("bot-id", activity.From?.Id); + Assert.Equal("user-id", activity.Recipient?.Id); + Assert.Equal("conv-001", activity.Conversation?.Id); Assert.NotNull(activity.ChannelData); } } diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs index a4d9562d..2c006158 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs @@ -60,7 +60,10 @@ public async Task Middleware_ExecutesInOrder() Type = ActivityType.Message, Id = "act123" }; - activity.Recipient.Properties["appId"] = "test-app-id"; + if (activity.Recipient is not null) + { + activity.Recipient.Properties["appId"] = "test-app-id"; + } DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); @@ -102,7 +105,10 @@ public async Task Middleware_CanShortCircuit() Type = ActivityType.Message, Id = "act123" }; - activity.Recipient.Properties["appId"] = "test-app-id"; + if (activity.Recipient is not null) + { + activity.Recipient.Properties["appId"] = "test-app-id"; + } DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); @@ -142,7 +148,11 @@ public async Task Middleware_ReceivesCancellationToken() Type = ActivityType.Message, Id = "act123" }; - activity.Recipient.Properties["appId"] = "test-app-id"; + + if (activity.Recipient is not null) + { + activity.Recipient.Properties["appId"] = "test-app-id"; + } DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); @@ -177,7 +187,11 @@ public async Task Middleware_ReceivesActivity() Type = ActivityType.Message, Id = "act123" }; - activity.Recipient.Properties["appId"] = "test-app-id"; + + if (activity.Recipient is not null) + { + activity.Recipient.Properties["appId"] = "test-app-id"; + } DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/CoreActivityTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/CoreActivityTests.cs index 36835f3b..d853c41a 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/CoreActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Schema/CoreActivityTests.cs @@ -290,11 +290,11 @@ public void CreateReply() Assert.Equal("channel1", reply.ChannelId); Assert.NotNull(reply.ServiceUrl); Assert.Equal("http://service.url/", reply.ServiceUrl.ToString()); - Assert.Equal("conversation1", reply.Conversation.Id); - Assert.Equal("bot1", reply.From.Id); - Assert.Equal("Bot One", reply.From.Name); - Assert.Equal("user1", reply.Recipient.Id); - Assert.Equal("User One", reply.Recipient.Name); + Assert.Equal("conversation1", reply.Conversation?.Id); + Assert.Equal("bot1", reply.From?.Id); + Assert.Equal("Bot One", reply.From?.Name); + Assert.Equal("user1", reply.Recipient?.Id); + Assert.Equal("User One", reply.Recipient?.Name); } [Fact] From e2efe052792ba394b46f2004d1390a3cdfcd0c1e Mon Sep 17 00:00:00 2001 From: Rido Date: Wed, 4 Mar 2026 12:26:02 -0800 Subject: [PATCH 67/69] Refactor Teams bot hosting; add CustomHosting sample (#362) - Removed TeamsBotApplicationBuilder and static CreateBuilder/Run pattern. - Introduced DI-based AddTeamsBotApplication() and UseTeamsBotApplication() extension methods for flexible bot registration and endpoint configuration. - Added CustomHosting sample project demonstrating custom TeamsBotApplication subclassing and registration. - Renamed ITurnMiddleWare to ITurnMiddleware; updated middleware usage to UseMiddleware. - Made ConversationClient and UserTokenClient methods virtual for extensibility. - Improved type safety, replaced var with explicit types, and modernized code style across samples and tests. - Updated all samples to use new hosting and middleware APIs. - Improved documentation, error handling, and code consistency. - No breaking changes for DI-based consumers; legacy builder pattern removed. This pull request introduces a new `CustomHosting` sample to demonstrate custom hosting scenarios for Teams bots, and applies a variety of improvements and modernizations across several existing bot samples. Key changes include the addition of the `CustomHosting` project, improved type safety, modernization of code patterns, and minor cleanup of unused usings and dependencies. **New Sample: Custom Hosting** * Added a new sample project `CustomHosting`, including `CustomHosting.csproj`, `MyTeamsBotApp.cs`, `Program.cs`, and `appsettings.json`, to demonstrate how to set up and run a Teams bot application with custom hosting logic. (`core/core.slnx`, `core/samples/CustomHosting/CustomHosting.csproj`, `core/samples/CustomHosting/MyTeamsBotApp.cs`, `core/samples/CustomHosting/Program.cs`, `core/samples/CustomHosting/appsettings.json`) [[1]](diffhunk://#diff-19ad97af5c1b7109a9c62f830310091f393489def210b9ec1ffce152b8bf958cR18) [[2]](diffhunk://#diff-9a0a358fefed3a2d514a075dde6393f9d54f88b65e6701443355af6741f8ce80R1-R13) [[3]](diffhunk://#diff-ec0a36e06aeb2c4f3f7620e01891a6123198cfac9bf6bf1e851ccd913e5b8440R1-R20) [[4]](diffhunk://#diff-71299e3fd10a90f2601fa1e84cdda5006a3cf3676a2fb32e2ef1e830608558f2R1-R15) [[5]](diffhunk://#diff-1741a37e03d344704fdb47a90f621df777f6d1888075ec76923bb392ac4e5d0cR1-R9) **Type Safety and Modernization** * Improved type safety and code clarity in multiple samples by using explicit types (e.g., `ChatMessage?`, `SendActivityResponse?`, `JObject?`, `IList`, etc.), nullable reference types, and modern C# object initializers. (`core/samples/AFBot/Program.cs`, `core/samples/CompatBot/EchoBot.cs`, `core/samples/MeetingsBot/Program.cs`, `core/samples/AllInvokesBot/Program.cs`, `core/samples/MessageExtensionBot/Program.cs`) [[1]](diffhunk://#diff-b2eaa16ee58a54a25acb5e930ace0fe03ca3dea7b34c67a265dcddc8500ae41bL48-R57) [[2]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL50-R54) [[3]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL81-R96) [[4]](diffhunk://#diff-b9be640e365d9187b0d1a2021dddb84311b737f8c28b16428e3b2a450a4f331aL126-R132) [[5]](diffhunk://#diff-b0cc7807e2f91f921ec82978833465533c565f637b0aa56802f0d713f6688306L15-R38) [[6]](diffhunk://#diff-8f290ac497e620d9799b6a57476f6d5051a39df15e2bb71755ffb6849d2b1b35L31-R47) [[7]](diffhunk://#diff-8f290ac497e620d9799b6a57476f6d5051a39df15e2bb71755ffb6849d2b1b35L51-R58) [[8]](diffhunk://#diff-8f290ac497e620d9799b6a57476f6d5051a39df15e2bb71755ffb6849d2b1b35L91-R99) [[9]](diffhunk://#diff-8f290ac497e620d9799b6a57476f6d5051a39df15e2bb71755ffb6849d2b1b35L113-R130) [[10]](diffhunk://#diff-9da189387a8b06507339b8044bf5a572c0f84620969ebe735248a73252da901fL33-R33) * Updated middleware usage patterns and naming to align with modern conventions (e.g., using `UseMiddleware` instead of `Use`, fixing interface name typo from `ITurnMiddleWare` to `ITurnMiddleware`). (`core/samples/AFBot/DropTypingMiddleware.cs`, `core/samples/AFBot/Program.cs`) [[1]](diffhunk://#diff-b921767a8b614972c7a3bb5308b4fd797c60d44de331b9656065f3adbee7a248L9-R9) [[2]](diffhunk://#diff-b2eaa16ee58a54a25acb5e930ace0fe03ca3dea7b34c67a265dcddc8500ae41bL31-R32) **Dependency and Usings Cleanup** * Removed unused or redundant `using` statements from several files for clarity and maintainability. (`core/samples/CompatProactive/ProactiveWorker.cs`, `core/samples/CompatBot/Cards.cs`, `core/samples/CoreBot/Program.cs`, `core/samples/AllInvokesBot/Cards.cs`) [[1]](diffhunk://#diff-cb27bc8500d98e9cd996a878c9d25274502563720748d6ba31525b75e46bbc46L4-L8) [[2]](diffhunk://#diff-cef44960d160cf6ea51b595745c079353501a962650d7c9684bd9fa6e1456220L4-L6) [[3]](diffhunk://#diff-b94b53965e9052345453f2ab6bec21420a36c4b67c9a6c568b9c80edcd0882d1L4) [[4]](diffhunk://#diff-935a6ffb850a503e4af48c17543f2215a7ab022dd4835efb60f8207c01698520L5) **Project and Build System Updates** * Added the new `CustomHosting` sample to the solution file `core.slnx` for inclusion in the build. **Minor Fixes and Consistency Improvements** * Standardized variable naming and initialization, improved null handling, and modernized HTTP client usage in the AllInvokesBot and other samples. (`core/samples/AllInvokesBot/Program.cs`) [[1]](diffhunk://#diff-8f290ac497e620d9799b6a57476f6d5051a39df15e2bb71755ffb6849d2b1b35L31-R47) [[2]](diffhunk://#diff-8f290ac497e620d9799b6a57476f6d5051a39df15e2bb71755ffb6849d2b1b35L51-R58) [[3]](diffhunk://#diff-8f290ac497e620d9799b6a57476f6d5051a39df15e2bb71755ffb6849d2b1b35L91-R99) [[4]](diffhunk://#diff-8f290ac497e620d9799b6a57476f6d5051a39df15e2bb71755ffb6849d2b1b35L113-R130) [[5]](diffhunk://#diff-8f290ac497e620d9799b6a57476f6d5051a39df15e2bb71755ffb6849d2b1b35L283-R288) These changes collectively improve the maintainability, clarity, and extensibility of the sample bots, while providing a new example for custom hosting scenarios. --- core/core.slnx | 1 + core/samples/AFBot/DropTypingMiddleware.cs | 2 +- core/samples/AFBot/Program.cs | 7 +- core/samples/AllInvokesBot/Cards.cs | 1 - core/samples/AllInvokesBot/Program.cs | 39 +++++----- core/samples/CompatBot/Cards.cs | 3 - core/samples/CompatBot/EchoBot.cs | 21 +++-- .../CompatProactive/ProactiveWorker.cs | 5 -- core/samples/CompatProactive/Program.cs | 5 +- core/samples/CoreBot/Program.cs | 1 - .../CustomHosting/CustomHosting.csproj | 13 ++++ core/samples/CustomHosting/MyTeamsBotApp.cs | 20 +++++ core/samples/CustomHosting/Program.cs | 15 ++++ core/samples/CustomHosting/appsettings.json | 9 +++ core/samples/MeetingsBot/Program.cs | 21 ++--- core/samples/MessageExtensionBot/Program.cs | 57 +++++++------- core/samples/PABot/AdapterWithErrorHandler.cs | 5 +- core/samples/PABot/Bots/DialogBot.cs | 8 +- core/samples/PABot/Bots/SsoBot.cs | 7 +- core/samples/PABot/Bots/TeamsBot.cs | 11 +-- core/samples/PABot/Dialogs/LogoutDialog.cs | 16 ++-- core/samples/PABot/Dialogs/MainDialog.cs | 35 ++++----- core/samples/PABot/InitCompatAdapter.cs | 10 +-- core/samples/PABot/Program.cs | 13 ++-- core/samples/PABot/SimpleGraphClient.cs | 47 +++++------- core/samples/Proactive/Worker.cs | 2 +- core/samples/TeamsBot/GlobalSuppressions.cs | 8 ++ core/samples/TeamsBot/Program.cs | 31 +++++--- core/samples/TeamsChannelBot/Program.cs | 9 ++- .../Routing/Router.cs | 6 +- .../Schema/TeamsConversation.cs | 3 +- .../Schema/TeamsConversationAccount.cs | 2 +- .../TeamsBotApplication.HostingExtensions.cs | 61 ++++++++++++++- .../TeamsBotApplication.cs | 26 ------- .../TeamsBotApplicationBuilder.cs | 76 ------------------- .../CompatTeamsInfo.cs | 42 +++++----- .../BotApplication.cs | 16 +++- .../ConversationClient.cs | 26 +++---- .../Hosting/AddBotApplicationExtensions.cs | 6 +- .../Hosting/JwtExtensions.cs | 2 +- .../ITurnMiddleWare.cs | 2 +- .../TurnMiddleware.cs | 10 +-- .../UserTokenClient.cs | 12 +-- core/test/ABSTokenServiceClient/Program.cs | 1 - .../UserTokenCLIService.cs | 3 + .../ActivitiesTests.cs | 12 +-- .../InvokeActivityTest.cs | 6 +- .../RouterTests.cs | 22 +++--- .../TeamsActivityBuilderTests.cs | 50 ++++++------ .../TeamsActivityTests.cs | 29 ++++--- .../CompatActivityTests.cs | 38 +++++----- .../CompatAdapterTests.cs | 18 ++--- .../BotApplicationTests.cs | 10 +-- .../ConversationClientTests.cs | 2 +- .../AddBotApplicationExtensionsTests.cs | 14 ++-- .../MiddlewareTests.cs | 28 +++---- 56 files changed, 478 insertions(+), 467 deletions(-) create mode 100644 core/samples/CustomHosting/CustomHosting.csproj create mode 100644 core/samples/CustomHosting/MyTeamsBotApp.cs create mode 100644 core/samples/CustomHosting/Program.cs create mode 100644 core/samples/CustomHosting/appsettings.json create mode 100644 core/samples/TeamsBot/GlobalSuppressions.cs delete mode 100644 core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs diff --git a/core/core.slnx b/core/core.slnx index cd660185..4762e584 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -15,6 +15,7 @@ + diff --git a/core/samples/AFBot/DropTypingMiddleware.cs b/core/samples/AFBot/DropTypingMiddleware.cs index 3c997e77..92c7a172 100644 --- a/core/samples/AFBot/DropTypingMiddleware.cs +++ b/core/samples/AFBot/DropTypingMiddleware.cs @@ -6,7 +6,7 @@ namespace AFBot; -internal class DropTypingMiddleware : ITurnMiddleWare +internal class DropTypingMiddleware : ITurnMiddleware { public Task OnTurnAsync(BotApplication botApplication, CoreActivity activity, NextTurn nextTurn, CancellationToken cancellationToken = default) { diff --git a/core/samples/AFBot/Program.cs b/core/samples/AFBot/Program.cs index 39ceb5d5..3913af59 100644 --- a/core/samples/AFBot/Program.cs +++ b/core/samples/AFBot/Program.cs @@ -6,6 +6,7 @@ using Azure.AI.OpenAI; using Azure.Monitor.OpenTelemetry.AspNetCore; using Microsoft.Agents.AI; +using Microsoft.Extensions.AI; using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Teams.Bot.Core.Schema; @@ -28,7 +29,7 @@ "Always respond with the three complete words only, and include a related emoji at the end.", name: "AcronymMaker"); -botApp.Use(new DropTypingMiddleware()); +botApp.UseMiddleware(new DropTypingMiddleware()); botApp.OnActivity = async (activity, cancellationToken) => { @@ -45,7 +46,7 @@ AgentRunResponse agentResponse = await agent.RunAsync(activity.Properties["text"]?.ToString() ?? "OMW", cancellationToken: timer.Token); - var m1 = agentResponse.Messages.FirstOrDefault(); + ChatMessage? m1 = agentResponse.Messages.FirstOrDefault(); Console.WriteLine($"AI:: GOT {agentResponse.Messages.Count} msgs"); CoreActivity replyActivity = CoreActivity.CreateBuilder() .WithType(ActivityType.Message) @@ -53,7 +54,7 @@ .WithProperty("text", m1!.Text) .Build(); - var res = await botApp.SendActivityAsync(replyActivity, cancellationToken); + SendActivityResponse? res = await botApp.SendActivityAsync(replyActivity, cancellationToken); Console.WriteLine("SENT >>> => " + res?.Id); }; diff --git a/core/samples/AllInvokesBot/Cards.cs b/core/samples/AllInvokesBot/Cards.cs index 196c20a2..6a9c6f31 100644 --- a/core/samples/AllInvokesBot/Cards.cs +++ b/core/samples/AllInvokesBot/Cards.cs @@ -2,7 +2,6 @@ // Licensed under the MIT License. using System.Text.Json.Nodes; -using Microsoft.Teams.Bot.Apps.Schema; namespace AllInvokesBot; diff --git a/core/samples/AllInvokesBot/Program.cs b/core/samples/AllInvokesBot/Program.cs index b0e9db01..064b6218 100644 --- a/core/samples/AllInvokesBot/Program.cs +++ b/core/samples/AllInvokesBot/Program.cs @@ -2,20 +2,25 @@ // Licensed under the MIT License. using System.Text.Json; +using System.Text.Json.Nodes; using AllInvokesBot; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core.Hosting; -var builder = TeamsBotApplication.CreateBuilder(args); -var bot = builder.Build(); +WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddTeamsBotApplication(); +WebApplication webApp = webAppBuilder.Build(); + +TeamsBotApplication bot = webApp.UseBotApplication(); // ==================== MESSAGE - SEND SIMPLE CARD ==================== bot.OnMessage(async (context, cancellationToken) => { Console.WriteLine("✓ OnMessage"); - var card = Cards.CreateWelcomeCard(); + JsonObject card = Cards.CreateWelcomeCard(); TeamsAttachment attachment = TeamsAttachment.CreateBuilder() .WithAdaptiveCard(card) @@ -28,10 +33,10 @@ bot.OnAdaptiveCardAction(async (context, cancellationToken) => { Console.WriteLine("✓ OnAdaptiveCardAction"); - var value = context.Activity.Value; - var action = value?.Action; + AdaptiveCardActionValue? value = context.Activity.Value; + AdaptiveCardAction? action = value?.Action; string? verb = action?.Verb; - var data = action?.Data; + Dictionary? data = action?.Data; Console.WriteLine($" Verb: {verb}"); Console.WriteLine($" Data: {JsonSerializer.Serialize(data)}"); @@ -39,7 +44,7 @@ // Handle file upload request if (verb == "requestFileUpload") { - var fileConsentCard = Cards.CreateFileConsentCard(); + JsonObject fileConsentCard = Cards.CreateFileConsentCard(); TeamsAttachment fileConsentCardResponse = TeamsAttachment.CreateBuilder() .WithContent(fileConsentCard).WithContentType(AttachmentContentType.FileConsentCard) .WithName("file_consent.json").Build(); @@ -48,9 +53,9 @@ return AdaptiveCardResponse.CreateMessageResponse("File Consent requested!"); } - string? message = data != null && data.TryGetValue("message", out var msgValue) ? msgValue?.ToString() : null; + string? message = data != null && data.TryGetValue("message", out object? msgValue) ? msgValue?.ToString() : null; - var adaptiveActionCard = Cards.CreateAdaptiveActionResponseCard(verb, message); + JsonObject adaptiveActionCard = Cards.CreateAdaptiveActionResponseCard(verb, message); TeamsAttachment adaptiveActionCardResponse = TeamsAttachment.CreateBuilder().WithAdaptiveCard(adaptiveActionCard).Build(); await context.SendActivityAsync(new MessageActivity([adaptiveActionCardResponse]), cancellationToken); @@ -88,10 +93,10 @@ { Console.WriteLine("✓ OnFileConsent"); - var value = context.Activity.Value; + FileConsentValue? value = context.Activity.Value; string? action = value?.Action; - var uploadInfo = value?.UploadInfo; - var consentContext = value?.Context; + FileUploadInfo? uploadInfo = value?.UploadInfo; + object? consentContext = value?.Context; if (action == "accept") { @@ -110,19 +115,19 @@ byte[] fileBytes = System.Text.Encoding.UTF8.GetBytes(fileContent); int fileSize = fileBytes.Length; - using var httpClient = new HttpClient(); - using var content = new ByteArrayContent(fileBytes); + using HttpClient httpClient = new(); + using ByteArrayContent content = new(fileBytes); content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/octet-stream"); content.Headers.ContentRange = new System.Net.Http.Headers.ContentRangeHeaderValue(0, fileSize - 1, fileSize); try { - var uploadResponse = await httpClient.PutAsync(uploadUrl, content, cancellationToken); + HttpResponseMessage uploadResponse = await httpClient.PutAsync(uploadUrl, content, cancellationToken); Console.WriteLine($" Upload Status: {uploadResponse.StatusCode}"); if (uploadResponse.IsSuccessStatusCode) { - var fileInfoContent = Cards.CreateFileInfoCard(uniqueId, uploadInfo?.FileType); + JsonObject fileInfoContent = Cards.CreateFileInfoCard(uniqueId, uploadInfo?.FileType); TeamsAttachment fileUploadResponse = TeamsAttachment.CreateBuilder() .WithName(fileName) @@ -280,4 +285,4 @@ }); */ -bot.Run(); +webApp.Run(); diff --git a/core/samples/CompatBot/Cards.cs b/core/samples/CompatBot/Cards.cs index 253ec28a..4ba0be86 100644 --- a/core/samples/CompatBot/Cards.cs +++ b/core/samples/CompatBot/Cards.cs @@ -1,9 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text.Json; -using System.Text.Json.Nodes; - namespace CompatBot; internal class Cards diff --git a/core/samples/CompatBot/EchoBot.cs b/core/samples/CompatBot/EchoBot.cs index ee1116bb..1d68f2c0 100644 --- a/core/samples/CompatBot/EchoBot.cs +++ b/core/samples/CompatBot/EchoBot.cs @@ -3,7 +3,6 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Teams; -using Microsoft.Bot.Connector; using Microsoft.Bot.Schema; using Microsoft.Bot.Schema.Teams; using Microsoft.Teams.Bot.Apps; @@ -47,12 +46,12 @@ protected override async Task OnMessageActivityAsync(ITurnContext OnInvokeActivityAsync(ITurnContext turnContext, CancellationToken cancellationToken) { logger.LogInformation("Invoke Activity received: {Name}", turnContext.Activity.Name); - var actionValue = JObject.FromObject(turnContext.Activity.Value); - var action = actionValue["action"] as JObject; - var actionData = action?["data"] as JObject; - var userInput = actionData?["feedback"]?.ToString(); + JObject actionValue = JObject.FromObject(turnContext.Activity.Value); + JObject? action = actionValue["action"] as JObject; + JObject? actionData = action?["data"] as JObject; + string? userInput = actionData?["feedback"]?.ToString(); //var userInput = actionValue["userInput"]?.ToString(); logger.LogInformation("Action: {Action}, User Input: {UserInput}", action, userInput); - var attachment = new Attachment + Attachment attachment = new() { ContentType = "application/vnd.microsoft.card.adaptive", Content = Cards.ResponseCard(userInput) }; - var card = MessageFactory.Attachment(attachment); + IMessageActivity card = MessageFactory.Attachment(attachment); await turnContext.SendActivityAsync(card, cancellationToken); return new Microsoft.Bot.Builder.InvokeResponse @@ -123,14 +122,14 @@ protected override async Task OnTeamsMeetingStartAsync(MeetingStartEventDetails private static async Task SendUpdateDeleteActivityAsync(ITurnContext turnContext, ConversationClient conversationClient, CancellationToken cancellationToken) { - var cr = turnContext.Activity.GetConversationReference(); + ConversationReference cr = turnContext.Activity.GetConversationReference(); Activity reply = (Activity)Activity.CreateMessageActivity(); reply.ApplyConversationReference(cr, isIncoming: false); reply.Text = "This is a proactive message sent using the Conversations API."; CoreActivity ca = reply.FromCompatActivity(); - var res = await conversationClient.SendActivityAsync(ca, null, cancellationToken); + SendActivityResponse res = await conversationClient.SendActivityAsync(ca, null, cancellationToken); await Task.Delay(2000, cancellationToken); diff --git a/core/samples/CompatProactive/ProactiveWorker.cs b/core/samples/CompatProactive/ProactiveWorker.cs index 180241e8..0ba69924 100644 --- a/core/samples/CompatProactive/ProactiveWorker.cs +++ b/core/samples/CompatProactive/ProactiveWorker.cs @@ -1,11 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Schema; diff --git a/core/samples/CompatProactive/Program.cs b/core/samples/CompatProactive/Program.cs index e1dd4499..440d3bad 100644 --- a/core/samples/CompatProactive/Program.cs +++ b/core/samples/CompatProactive/Program.cs @@ -1,9 +1,10 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using CompatProactive; -using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using Microsoft.Teams.Bot.Compat; -using Microsoft.Teams.Bot.Core.Hosting; HostApplicationBuilder builder = Host.CreateApplicationBuilder(args); diff --git a/core/samples/CoreBot/Program.cs b/core/samples/CoreBot/Program.cs index 9357442f..b3396f9e 100644 --- a/core/samples/CoreBot/Program.cs +++ b/core/samples/CoreBot/Program.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Azure.Monitor.OpenTelemetry.AspNetCore; using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Teams.Bot.Core.Schema; diff --git a/core/samples/CustomHosting/CustomHosting.csproj b/core/samples/CustomHosting/CustomHosting.csproj new file mode 100644 index 00000000..f30bcbe3 --- /dev/null +++ b/core/samples/CustomHosting/CustomHosting.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/core/samples/CustomHosting/MyTeamsBotApp.cs b/core/samples/CustomHosting/MyTeamsBotApp.cs new file mode 100644 index 00000000..05f39dec --- /dev/null +++ b/core/samples/CustomHosting/MyTeamsBotApp.cs @@ -0,0 +1,20 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Apps.Handlers; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; + +namespace CustomHosting; + +public class MyTeamsBotApp : TeamsBotApplication +{ + public MyTeamsBotApp(ConversationClient conversationClient, UserTokenClient userTokenClient, TeamsApiClient teamsApiClient, IHttpContextAccessor httpContextAccessor, ILogger logger, BotApplicationOptions? options = null) : base(conversationClient, userTokenClient, teamsApiClient, httpContextAccessor, logger, options) + { + this.OnMessage(async (ctx, ct) => + { + await ctx.SendActivityAsync("Hello from MyTeamsBotApp!", ct); + }); + } +} diff --git a/core/samples/CustomHosting/Program.cs b/core/samples/CustomHosting/Program.cs new file mode 100644 index 00000000..068d7759 --- /dev/null +++ b/core/samples/CustomHosting/Program.cs @@ -0,0 +1,15 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using CustomHosting; +using Microsoft.Teams.Bot.Apps; +using Microsoft.Teams.Bot.Core.Hosting; + +WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddTeamsBotApplication(); +WebApplication webApp = webAppBuilder.Build(); + +webApp.MapGet("/", () => $"Teams Bot App is running {TeamsBotApplication.Version}."); +webApp.UseBotApplication(); + +webApp.Run(); diff --git a/core/samples/CustomHosting/appsettings.json b/core/samples/CustomHosting/appsettings.json new file mode 100644 index 00000000..10f68b8c --- /dev/null +++ b/core/samples/CustomHosting/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*" +} diff --git a/core/samples/MeetingsBot/Program.cs b/core/samples/MeetingsBot/Program.cs index 035fd9a0..6f686ca3 100644 --- a/core/samples/MeetingsBot/Program.cs +++ b/core/samples/MeetingsBot/Program.cs @@ -5,37 +5,40 @@ using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; -var builder = TeamsBotApplication.CreateBuilder(args); -var teamsApp = builder.Build(); +WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddTeamsBotApplication(); +WebApplication webApp = webAppBuilder.Build(); + +TeamsBotApplication teamsApp = webApp.UseTeamsBotApplication(); // ==================== MEETING HANDLERS ==================== teamsApp.OnMeetingStart(async (context, cancellationToken) => { - var meeting = context.Activity.Value; + MeetingStartValue? meeting = context.Activity.Value; Console.WriteLine($"[MeetingStart] Title: {meeting?.Title}"); await context.SendActivityAsync($"Meeting started: **{meeting?.Title}**", cancellationToken); }); teamsApp.OnMeetingEnd(async (context, cancellationToken) => { - var meeting = context.Activity.Value; + MeetingEndValue? meeting = context.Activity.Value; Console.WriteLine($"[MeetingEnd] Title: {meeting?.Title}, EndTime: {meeting?.EndTime:u}"); await context.SendActivityAsync($"Meeting ended: **{meeting?.Title}**\nEnd time: {meeting?.EndTime:u}", cancellationToken); }); teamsApp.OnMeetingParticipantJoin(async (context, cancellationToken) => { - var members = context.Activity.Value?.Members ?? []; - var names = string.Join(", ", members.Select(m => m.User.Name ?? m.User.Id)); + IList members = context.Activity.Value?.Members ?? []; + string names = string.Join(", ", members.Select(m => m.User.Name ?? m.User.Id)); Console.WriteLine($"[MeetingParticipantJoin] Members: {names}"); await context.SendActivityAsync($"Participant(s) joined: {names}", cancellationToken); }); teamsApp.OnMeetingParticipantLeave(async (context, cancellationToken) => { - var members = context.Activity.Value?.Members ?? []; - var names = string.Join(", ", members.Select(m => m.User.Name ?? m.User.Id)); + IList members = context.Activity.Value?.Members ?? []; + string names = string.Join(", ", members.Select(m => m.User.Name ?? m.User.Id)); Console.WriteLine($"[MeetingParticipantLeave] Members: {names}"); await context.SendActivityAsync($"Participant(s) left: {names}", cancellationToken); }); @@ -63,4 +66,4 @@ await context.SendActivityAsync($"Command **{commandId}** completed successfully.", cancellationToken); }); */ -teamsApp.Run(); +webApp.Run(); diff --git a/core/samples/MessageExtensionBot/Program.cs b/core/samples/MessageExtensionBot/Program.cs index 0297beab..8583a359 100644 --- a/core/samples/MessageExtensionBot/Program.cs +++ b/core/samples/MessageExtensionBot/Program.cs @@ -7,8 +7,11 @@ using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; -var builder = TeamsBotApplication.CreateBuilder(args); -var bot = builder.Build(); +WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddTeamsBotApplication(); +WebApplication webApp = webAppBuilder.Build(); + +TeamsBotApplication bot = webApp.UseTeamsBotApplication(); // ==================== MESSAGE EXTENSION QUERY ==================== bot.OnQuery(async (context, cancellationToken) => @@ -30,7 +33,7 @@ } // Create results with tap actions to trigger OnSelectItem - var cards = Cards.CreateQueryResultCards(searchText); + object[] cards = Cards.CreateQueryResultCards(searchText); TeamsAttachment[] attachments = [.. cards.Select(card => TeamsAttachment.CreateBuilder().WithContent(card) .WithContentType(AttachmentContentType.ThumbnailCard).Build())]; @@ -46,13 +49,13 @@ { Console.WriteLine("✓ OnSelectItem"); - var selectedItem = context.Activity.Value; - var itemData = selectedItem as JsonElement?; - string? itemId = itemData.Value.TryGetProperty("itemId", out var id) ? id.GetString() : "unknown"; - string? title = itemData.Value.TryGetProperty("title", out var t) ? t.GetString() : "Selected Item"; - string? description = itemData.Value.TryGetProperty("description", out var d) ? d.GetString() : "No description"; + JsonElement selectedItem = context.Activity.Value; + JsonElement? itemData = selectedItem; + string? itemId = itemData.Value.TryGetProperty("itemId", out JsonElement id) ? id.GetString() : "unknown"; + string? title = itemData.Value.TryGetProperty("title", out JsonElement t) ? t.GetString() : "Selected Item"; + string? description = itemData.Value.TryGetProperty("description", out JsonElement d) ? d.GetString() : "No description"; - var card = Cards.CreateSelectItemCard(itemId, title, description); + object card = Cards.CreateSelectItemCard(itemId, title, description); TeamsAttachment attachment = TeamsAttachment.CreateBuilder().WithAdaptiveCard(card).Build(); return MessageExtensionResponse.CreateBuilder() @@ -69,7 +72,7 @@ MessageExtensionAction? action = context.Activity.Value; - var fetchTaskCard = Cards.CreateFetchTaskCard(action?.CommandId ?? "unknown"); + object fetchTaskCard = Cards.CreateFetchTaskCard(action?.CommandId ?? "unknown"); TeamsAttachment fetchTaskCardResponse = TeamsAttachment.CreateBuilder() .WithAdaptiveCard(fetchTaskCard).Build(); return MessageExtensionActionResponse.CreateBuilder() @@ -81,18 +84,18 @@ }); // Helper: Extract title and description from preview card -(string?, string?) GetDataFromPreview(TeamsActivity? preview) +static (string?, string?) GetDataFromPreview(TeamsActivity? preview) { if (preview?.Attachments == null) return (null, null); - var cardData = JsonSerializer.Deserialize( + JsonElement cardData = JsonSerializer.Deserialize( JsonSerializer.Serialize(preview.Attachments[0].Content)); - if (!cardData.TryGetProperty("body", out var body) || body.ValueKind != JsonValueKind.Array) + if (!cardData.TryGetProperty("body", out JsonElement body) || body.ValueKind != JsonValueKind.Array) return (null, null); - var title = body.GetArrayLength() > 0 && body[0].TryGetProperty("text", out var t) ? t.GetString() : null; - var description = body.GetArrayLength() > 1 && body[1].TryGetProperty("text", out var d) ? d.GetString() : null; + string? title = body.GetArrayLength() > 0 && body[0].TryGetProperty("text", out JsonElement t) ? t.GetString() : null; + string? description = body.GetArrayLength() > 1 && body[1].TryGetProperty("text", out JsonElement d) ? d.GetString() : null; return (title, description); } @@ -109,9 +112,9 @@ if (action?.BotMessagePreviewAction == "edit") { Console.WriteLine("Handling EDIT action - returning to form"); - var (previewTitle, previewDescription) = GetDataFromPreview(action.BotActivityPreview?.FirstOrDefault()); + (string? previewTitle, string? previewDescription) = GetDataFromPreview(action.BotActivityPreview?.FirstOrDefault()); - var editFormCard = Cards.CreateEditFormCard(previewTitle, previewDescription); + object editFormCard = Cards.CreateEditFormCard(previewTitle, previewDescription); TeamsAttachment editFormCardResponse = TeamsAttachment.CreateBuilder() .WithAdaptiveCard(editFormCard).Build(); return MessageExtensionActionResponse.CreateBuilder() @@ -127,9 +130,9 @@ if (action?.BotMessagePreviewAction == "send") { Console.WriteLine("Handling SEND action - finalizing card"); - var (previewTitle, previewDescription) = GetDataFromPreview(action.BotActivityPreview?.FirstOrDefault()); + (string? previewTitle, string? previewDescription) = GetDataFromPreview(action.BotActivityPreview?.FirstOrDefault()); - var card = Cards.CreateSubmitActionCard(previewTitle, previewDescription); + object card = Cards.CreateSubmitActionCard(previewTitle, previewDescription); TeamsAttachment attachment2 = TeamsAttachment.CreateBuilder().WithAdaptiveCard(card).Build(); return MessageExtensionActionResponse.CreateBuilder() @@ -141,11 +144,11 @@ } - var data = action?.Data as JsonElement?; - string? title = data != null && data.Value.TryGetProperty("title", out var t) ? t.GetString() : "Untitled"; - string? description = data != null && data.Value.TryGetProperty("description", out var d) ? d.GetString() : "No description"; + JsonElement? data = action?.Data as JsonElement?; + string? title = data != null && data.Value.TryGetProperty("title", out JsonElement t) ? t.GetString() : "Untitled"; + string? description = data != null && data.Value.TryGetProperty("description", out JsonElement d) ? d.GetString() : "No description"; - var previewCard = Cards.CreateSubmitActionCard(title, description); + object previewCard = Cards.CreateSubmitActionCard(title, description); TeamsAttachment attachment = TeamsAttachment.CreateBuilder().WithAdaptiveCard(previewCard).Build(); return MessageExtensionActionResponse.CreateBuilder() @@ -163,7 +166,7 @@ MessageExtensionQueryLink? queryLink = context.Activity.Value; - var card = Cards.CreateLinkUnfurlCard(queryLink?.Url?.ToString()); + object card = Cards.CreateLinkUnfurlCard(queryLink?.Url?.ToString()); TeamsAttachment attachment = TeamsAttachment.CreateBuilder() .WithContent(card).WithContentType(AttachmentContentType.ThumbnailCard).Build(); @@ -186,7 +189,7 @@ Console.WriteLine($" URL: '{anonQueryLink.Url}'"); } - var card = Cards.CreateLinkUnfurlCard(anonQueryLink?.Url?.ToString()); + object card = Cards.CreateLinkUnfurlCard(anonQueryLink?.Url?.ToString()); TeamsAttachment attachment = TeamsAttachment.CreateBuilder() .WithContent(card).WithContentType(AttachmentContentType.ThumbnailCard).Build(); @@ -203,7 +206,7 @@ { Console.WriteLine("✓ OnQuerySettingUrl"); - var query = context.Activity.Value; + MessageExtensionQuery? query = context.Activity.Value; var action = new { @@ -257,4 +260,4 @@ }); */ -bot.Run(); +webApp.Run(); diff --git a/core/samples/PABot/AdapterWithErrorHandler.cs b/core/samples/PABot/AdapterWithErrorHandler.cs index 90d80f62..c349993a 100644 --- a/core/samples/PABot/AdapterWithErrorHandler.cs +++ b/core/samples/PABot/AdapterWithErrorHandler.cs @@ -1,6 +1,5 @@ -// -// Copyright (c) Microsoft. All rights reserved. -// +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; diff --git a/core/samples/PABot/Bots/DialogBot.cs b/core/samples/PABot/Bots/DialogBot.cs index 114e65cc..02004832 100644 --- a/core/samples/PABot/Bots/DialogBot.cs +++ b/core/samples/PABot/Bots/DialogBot.cs @@ -1,14 +1,10 @@ -// -// Copyright (c) Microsoft. All rights reserved. -// +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. -using System.Threading; -using System.Threading.Tasks; using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Dialogs; using Microsoft.Bot.Builder.Teams; using Microsoft.Bot.Schema; -using Microsoft.Extensions.Logging; namespace PABot.Bots { diff --git a/core/samples/PABot/Bots/SsoBot.cs b/core/samples/PABot/Bots/SsoBot.cs index f778c381..4bd59cef 100644 --- a/core/samples/PABot/Bots/SsoBot.cs +++ b/core/samples/PABot/Bots/SsoBot.cs @@ -7,7 +7,6 @@ using Microsoft.Bot.Builder; using Microsoft.Bot.Connector.Authentication; using Microsoft.Bot.Schema; -using Newtonsoft.Json; namespace PABot.Bots { @@ -25,11 +24,11 @@ protected override async Task OnMessageActivityAsync(ITurnContext -// Copyright (c) Microsoft. All rights reserved. -// +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. -using System.Collections.Generic; -using System.Threading; -using System.Threading.Tasks; using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Dialogs; using Microsoft.Bot.Schema; -using Microsoft.Extensions.Logging; namespace PABot.Bots { @@ -39,7 +34,7 @@ public TeamsBot(ConversationState conversationState, UserState userState, T dial /// A task that represents the work queued to execute. protected override async Task OnMembersAddedAsync(IList membersAdded, ITurnContext turnContext, CancellationToken cancellationToken) { - foreach (var member in membersAdded) + foreach (ChannelAccount member in membersAdded) { if (member.Id != turnContext.Activity.Recipient.Id) { diff --git a/core/samples/PABot/Dialogs/LogoutDialog.cs b/core/samples/PABot/Dialogs/LogoutDialog.cs index 668d0b14..24cb4283 100644 --- a/core/samples/PABot/Dialogs/LogoutDialog.cs +++ b/core/samples/PABot/Dialogs/LogoutDialog.cs @@ -1,12 +1,8 @@ -// -// Copyright (c) Microsoft. All rights reserved. -// +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. -using System.Threading; -using System.Threading.Tasks; using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Dialogs; -using Microsoft.Bot.Builder.Integration.AspNet.Core; using Microsoft.Bot.Connector.Authentication; using Microsoft.Bot.Schema; @@ -45,7 +41,7 @@ protected override async Task OnBeginDialogAsync( object options, CancellationToken cancellationToken = default(CancellationToken)) { - var result = await InterruptAsync(innerDc, cancellationToken); + DialogTurnResult result = await InterruptAsync(innerDc, cancellationToken); if (result != null) { return result; @@ -64,7 +60,7 @@ protected override async Task OnContinueDialogAsync( DialogContext innerDc, CancellationToken cancellationToken = default(CancellationToken)) { - var result = await InterruptAsync(innerDc, cancellationToken); + DialogTurnResult result = await InterruptAsync(innerDc, cancellationToken); if (result != null) { return result; @@ -85,13 +81,13 @@ private async Task InterruptAsync( { if (innerDc.Context.Activity.Type == ActivityTypes.Message) { - var text = innerDc.Context.Activity.Text.ToLowerInvariant(); + string text = innerDc.Context.Activity.Text.ToLowerInvariant(); // Allow logout anywhere in the command if (text.Contains("logout")) { // The UserTokenClient encapsulates the authentication processes. - var userTokenClient = innerDc.Context.TurnState.Get(); + UserTokenClient userTokenClient = innerDc.Context.TurnState.Get(); await userTokenClient.SignOutUserAsync(innerDc.Context.Activity.From.Id, ConnectionName, innerDc.Context.Activity.ChannelId, cancellationToken).ConfigureAwait(false); await innerDc.Context.SendActivityAsync(MessageFactory.Text("You have been signed out."), cancellationToken); diff --git a/core/samples/PABot/Dialogs/MainDialog.cs b/core/samples/PABot/Dialogs/MainDialog.cs index e64a4ba5..3344fa4a 100644 --- a/core/samples/PABot/Dialogs/MainDialog.cs +++ b/core/samples/PABot/Dialogs/MainDialog.cs @@ -1,17 +1,10 @@ -// -// Copyright (c) Microsoft. All rights reserved. -// - -using System; -using System.Collections.Generic; -using System.Threading; -using System.Threading.Tasks; +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Dialogs; -using Microsoft.Bot.Connector.Authentication; using Microsoft.Bot.Schema; -using Microsoft.Extensions.Configuration; -using Microsoft.Extensions.Logging; +using Microsoft.Graph.Models; namespace PABot.Dialogs { @@ -77,24 +70,24 @@ private async Task PromptStepAsync(WaterfallStepContext stepCo /// A task representing the asynchronous operation. private async Task LoginStepAsync(WaterfallStepContext stepContext, CancellationToken cancellationToken) { - var tokenResponse = (TokenResponse)stepContext.Result; + TokenResponse tokenResponse = (TokenResponse)stepContext.Result; if (tokenResponse?.Token != null) { try { - var client = new SimpleGraphClient(tokenResponse.Token); - var me = await client.GetMeAsync(); - var title = !string.IsNullOrEmpty(me.JobTitle) ? me.JobTitle : "Unknown"; + SimpleGraphClient client = new(tokenResponse.Token); + User me = await client.GetMeAsync(); + string title = !string.IsNullOrEmpty(me.JobTitle) ? me.JobTitle : "Unknown"; await stepContext.Context.SendActivityAsync($"You're logged in as {me.DisplayName} ({me.UserPrincipalName}); your job title is: {title}"); - var photo = await client.GetPhotoAsync(); + string photo = await client.GetPhotoAsync(); if (!string.IsNullOrEmpty(photo)) { - var cardImage = new CardImage(photo); - var card = new ThumbnailCard(images: new List { cardImage }); - var reply = MessageFactory.Attachment(card.ToAttachment()); + CardImage cardImage = new(photo); + ThumbnailCard card = new(images: new List { cardImage }); + IMessageActivity reply = MessageFactory.Attachment(card.ToAttachment()); await stepContext.Context.SendActivityAsync(reply, cancellationToken); } @@ -134,7 +127,7 @@ private async Task DisplayTokenPhase1Async(WaterfallStepContex await stepContext.Context.SendActivityAsync(MessageFactory.Text("Thank you."), cancellationToken); - var result = (bool)stepContext.Result; + bool result = (bool)stepContext.Result; if (result) { return await stepContext.BeginDialogAsync(nameof(OAuthPrompt), cancellationToken: cancellationToken); @@ -153,7 +146,7 @@ private async Task DisplayTokenPhase2Async(WaterfallStepContex { _logger.LogInformation("DisplayTokenPhase2Async() method called."); - var tokenResponse = (TokenResponse)stepContext.Result; + TokenResponse tokenResponse = (TokenResponse)stepContext.Result; if (tokenResponse != null) { await stepContext.Context.SendActivityAsync(MessageFactory.Text($"Here is your token: {tokenResponse.Token}"), cancellationToken); diff --git a/core/samples/PABot/InitCompatAdapter.cs b/core/samples/PABot/InitCompatAdapter.cs index 874bf1e3..c74ddac1 100644 --- a/core/samples/PABot/InitCompatAdapter.cs +++ b/core/samples/PABot/InitCompatAdapter.cs @@ -34,11 +34,11 @@ public static IServiceCollection AddTeamsBotApplications(this IServiceCollection private static void RegisterKeyedTeamsBotApplication(IServiceCollection services, string keyName) { // Get configuration for this key - var configSection = services.BuildServiceProvider().GetRequiredService().GetSection(keyName); + IConfigurationSection configSection = services.BuildServiceProvider().GetRequiredService().GetSection(keyName); // Configure authorization and authentication for this key // This sets up JWT bearer authentication and authorization policies - services.AddAuthorization(null, keyName); + services.AddBotAuthorization(null, keyName); // Configure MSAL options for this key services.Configure(keyName, configSection); @@ -56,7 +56,7 @@ private static void RegisterKeyedTeamsBotApplication(IServiceCollection services // Register keyed ConversationClient services.AddKeyedSingleton(keyName, (sp, key) => { - var httpClient = sp.GetRequiredService() + HttpClient httpClient = sp.GetRequiredService() .CreateClient($"{keyName}_ConversationClient"); return new ConversationClient(httpClient, sp.GetRequiredService>()); }); @@ -64,7 +64,7 @@ private static void RegisterKeyedTeamsBotApplication(IServiceCollection services // Register keyed UserTokenClient services.AddKeyedSingleton(keyName, (sp, key) => { - var httpClient = sp.GetRequiredService() + HttpClient httpClient = sp.GetRequiredService() .CreateClient($"{keyName}_UserTokenClient"); return new UserTokenClient( httpClient, @@ -75,7 +75,7 @@ private static void RegisterKeyedTeamsBotApplication(IServiceCollection services // Register keyed TeamsApiClient services.AddKeyedSingleton(keyName, (sp, key) => { - var httpClient = sp.GetRequiredService() + HttpClient httpClient = sp.GetRequiredService() .CreateClient($"{keyName}_TeamsApiClient"); return new TeamsApiClient(httpClient, sp.GetRequiredService>()); }); diff --git a/core/samples/PABot/Program.cs b/core/samples/PABot/Program.cs index da3d1f5b..9995235e 100644 --- a/core/samples/PABot/Program.cs +++ b/core/samples/PABot/Program.cs @@ -1,6 +1,5 @@ -// -// Copyright (c) Microsoft. All rights reserved. -// +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. using Microsoft.Bot.Builder; using Microsoft.Bot.Builder.Integration.AspNet.Core; @@ -9,7 +8,7 @@ using PABot.Bots; using PABot.Dialogs; -var builder = WebApplication.CreateBuilder(args); +WebApplicationBuilder builder = WebApplication.CreateBuilder(args); // Register all the keyed services (ConversationClient, UserTokenClient, TeamsApiClient, TeamsBotApplication) builder.Services.AddTeamsBotApplications(); @@ -47,11 +46,11 @@ builder.Services.AddKeyedTransient>("TeamsBot"); builder.Services.AddKeyedTransient("EchoBot"); -var app = builder.Build(); +WebApplication app = builder.Build(); // Get the keyed adapters -var adapterOne = app.Services.GetRequiredKeyedService("AdapterOne"); -var adapterTwo = app.Services.GetRequiredKeyedService("AdapterTwo"); +IBotFrameworkHttpAdapter adapterOne = app.Services.GetRequiredKeyedService("AdapterOne"); +IBotFrameworkHttpAdapter adapterTwo = app.Services.GetRequiredKeyedService("AdapterTwo"); // Map endpoints with their respective adapters and authorization policies app.MapPost("/api/messages", (HttpRequest request, HttpResponse response, [FromKeyedServices("EchoBot")] IBot bot, CancellationToken ct) => diff --git a/core/samples/PABot/SimpleGraphClient.cs b/core/samples/PABot/SimpleGraphClient.cs index 3ae6f3d6..a3461368 100644 --- a/core/samples/PABot/SimpleGraphClient.cs +++ b/core/samples/PABot/SimpleGraphClient.cs @@ -1,14 +1,6 @@ -// -// Copyright (c) Microsoft. All rights reserved. -// - -using System; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using System.Net.Http.Headers; -using System.Threading; -using System.Threading.Tasks; +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using Microsoft.Graph; using Microsoft.Graph.Me.SendMail; using Microsoft.Graph.Models; @@ -63,11 +55,10 @@ public async Task SendMailAsync(string toAddress, string subject, string content throw new ArgumentNullException(nameof(content)); } - var graphClient = GetAuthenticatedClient(); - var recipients = new List - { - new Recipient - { + GraphServiceClient graphClient = GetAuthenticatedClient(); + List recipients = new() + { + new() { EmailAddress = new EmailAddress { Address = toAddress, @@ -76,7 +67,7 @@ public async Task SendMailAsync(string toAddress, string subject, string content }; // Create the message. - var email = new Message + Message email = new() { Body = new ItemBody { @@ -97,8 +88,8 @@ public async Task SendMailAsync(string toAddress, string subject, string content /// An array of recent messages. public async Task GetRecentMailAsync() { - var graphClient = GetAuthenticatedClient(); - var messages = await graphClient.Me.MailFolders["inbox"].Messages.GetAsync(); + GraphServiceClient graphClient = GetAuthenticatedClient(); + MessageCollectionResponse? messages = await graphClient.Me.MailFolders["inbox"].Messages.GetAsync(); return messages?.Value?.Take(5).ToArray()!; } @@ -109,8 +100,8 @@ public async Task GetRecentMailAsync() /// The user information. public async Task GetMeAsync() { - var graphClient = GetAuthenticatedClient(); - var me = await graphClient.Me.GetAsync(); + GraphServiceClient graphClient = GetAuthenticatedClient(); + User? me = await graphClient.Me.GetAsync(); return me!; } @@ -120,13 +111,13 @@ public async Task GetMeAsync() /// The user's photo as a base64 string. public async Task GetPhotoAsync() { - var graphClient = GetAuthenticatedClient(); - var photo = await graphClient.Me.Photo.Content.GetAsync(); + GraphServiceClient graphClient = GetAuthenticatedClient(); + Stream? photo = await graphClient.Me.Photo.Content.GetAsync(); if (photo != null) { - using var ms = new MemoryStream(); + using MemoryStream ms = new(); await photo.CopyToAsync(ms); - var buffers = ms.ToArray(); + byte[] buffers = ms.ToArray(); return $"data:image/png;base64,{Convert.ToBase64String(buffers)}"; } return string.Empty; @@ -138,9 +129,9 @@ public async Task GetPhotoAsync() /// The authenticated GraphServiceClient. private GraphServiceClient GetAuthenticatedClient() { - var tokenProvider = new SimpleAccessTokenProvider(_token); + SimpleAccessTokenProvider tokenProvider = new(_token); - var authProvider = new BaseBearerTokenAuthenticationProvider(tokenProvider); + BaseBearerTokenAuthenticationProvider authProvider = new(tokenProvider); return new GraphServiceClient(authProvider); } @@ -159,7 +150,7 @@ public Task GetAuthorizationTokenAsync(Uri uri, Dictionary new AllowedHostsValidator(); + public AllowedHostsValidator AllowedHostsValidator => new(); } } } diff --git a/core/samples/Proactive/Worker.cs b/core/samples/Proactive/Worker.cs index aef0308e..3ec509b7 100644 --- a/core/samples/Proactive/Worker.cs +++ b/core/samples/Proactive/Worker.cs @@ -25,7 +25,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken) Conversation = new() { Id = ConversationId } }; proactiveMessage.Properties["text"] = $"Proactive hello at {DateTimeOffset.Now}"; - var aid = await conversationClient.SendActivityAsync(proactiveMessage, cancellationToken: stoppingToken); + SendActivityResponse aid = await conversationClient.SendActivityAsync(proactiveMessage, cancellationToken: stoppingToken); logger.LogInformation("Activity {Aid} sent", aid.Id); } await Task.Delay(1000, stoppingToken); diff --git a/core/samples/TeamsBot/GlobalSuppressions.cs b/core/samples/TeamsBot/GlobalSuppressions.cs new file mode 100644 index 00000000..134f3be4 --- /dev/null +++ b/core/samples/TeamsBot/GlobalSuppressions.cs @@ -0,0 +1,8 @@ +// This file is used by Code Analysis to maintain SuppressMessage +// attributes that are applied to this project. +// Project-level suppressions either have no target or are given +// a specific target and scoped to a namespace, type, member, etc. + +using System.Diagnostics.CodeAnalysis; + +[assembly: SuppressMessage("Performance", "SYSLIB1045:Convert to 'GeneratedRegexAttribute'.", Justification = "")] diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index cedf38fb..3bcaa5cd 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -1,14 +1,18 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using System.Text.Json.Nodes; using System.Text.RegularExpressions; using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Apps.Handlers; using Microsoft.Teams.Bot.Apps.Schema; using TeamsBot; -var builder = TeamsBotApplication.CreateBuilder(args); -var teamsApp = builder.Build(); +WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddTeamsBotApplication(); +WebApplication webApp = webAppBuilder.Build(); + +TeamsBotApplication teamsApp = webApp.UseTeamsBotApplication(); // ==================== MESSAGE HANDLERS ==================== @@ -21,7 +25,7 @@ // Markdown handler: matches "markdown" (case-insensitive) teamsApp.OnMessage("(?i)markdown", async (context, cancellationToken) => { - var markdownMessage = new MessageActivity(""" + MessageActivity markdownMessage = new(""" # Markdown Examples Here are some **markdown** formatting examples: @@ -60,10 +64,10 @@ [Visit Microsoft](https://www.microsoft.com) }); // Regex-based handler: matches commands starting with "/" -var commandRegex = new Regex(@"^/(\w+)(.*)$", RegexOptions.Compiled); +Regex commandRegex = Regexes.CommandRegex(); teamsApp.OnMessage(commandRegex, async (context, cancellationToken) => { - var match = commandRegex.Match(context.Activity.Text ?? ""); + Match match = commandRegex.Match(context.Activity.Text ?? ""); if (match.Success) { string command = match.Groups[1].Value; @@ -129,10 +133,10 @@ [Visit Microsoft](https://www.microsoft.com) teamsApp.OnInvoke(async (context, cancellationToken) => { - var valueNode = context.Activity.Value; + JsonNode? valueNode = context.Activity.Value; string? feedbackValue = valueNode?["action"]?["data"]?["feedback"]?.GetValue(); - var reply = TeamsActivity.CreateBuilder() + TeamsActivity reply = TeamsActivity.CreateBuilder() .WithAttachment(TeamsAttachment.CreateBuilder() .WithAdaptiveCard(Cards.ResponseCard(feedbackValue)) .Build() @@ -158,7 +162,7 @@ [Visit Microsoft](https://www.microsoft.com) { Console.WriteLine($"[MembersAdded] {context.Activity.MembersAdded?.Count ?? 0} member(s) added"); - var memberNames = string.Join(", ", context.Activity.MembersAdded?.Select(m => m.Name ?? m.Id) ?? []); + string memberNames = string.Join(", ", context.Activity.MembersAdded?.Select(m => m.Name ?? m.Id) ?? []); await context.SendActivityAsync($"Welcome! Members added: {memberNames}", cancellationToken); }); @@ -166,7 +170,7 @@ [Visit Microsoft](https://www.microsoft.com) { Console.WriteLine($"[MembersRemoved] {context.Activity.MembersRemoved?.Count ?? 0} member(s) removed"); - var memberNames = string.Join(", ", context.Activity.MembersRemoved?.Select(m => m.Name ?? m.Id) ?? []); + string memberNames = string.Join(", ", context.Activity.MembersRemoved?.Select(m => m.Name ?? m.Id) ?? []); await context.SendActivityAsync($"Goodbye! Members removed: {memberNames}", cancellationToken); }); @@ -174,7 +178,7 @@ [Visit Microsoft](https://www.microsoft.com) teamsApp.OnInstallUpdate(async (context, cancellationToken) => { - var action = context.Activity.Action ?? "unknown"; + string action = context.Activity.Action ?? "unknown"; Console.WriteLine($"[InstallUpdate] Installation action: {action}"); if (context.Activity.Action != InstallUpdateActions.Remove) @@ -195,5 +199,10 @@ [Visit Microsoft](https://www.microsoft.com) return Task.CompletedTask; }); +webApp.Run(); -teamsApp.Run(); +partial class Regexes +{ + [GeneratedRegex(@"^/(\w+)(.*)$")] + public static partial Regex CommandRegex(); +} diff --git a/core/samples/TeamsChannelBot/Program.cs b/core/samples/TeamsChannelBot/Program.cs index acd713e6..bde0f85c 100644 --- a/core/samples/TeamsChannelBot/Program.cs +++ b/core/samples/TeamsChannelBot/Program.cs @@ -4,8 +4,11 @@ using Microsoft.Teams.Bot.Apps; using Microsoft.Teams.Bot.Apps.Handlers; -var builder = TeamsBotApplication.CreateBuilder(args); -var app = builder.Build(); +WebApplicationBuilder webAppBuilder = WebApplication.CreateSlimBuilder(args); +webAppBuilder.Services.AddTeamsBotApplication(); +WebApplication webApp = webAppBuilder.Build(); + +TeamsBotApplication app = webApp.UseTeamsBotApplication(); //TODO : implement next(); @@ -138,4 +141,4 @@ }); */ -app.Run(); +webApp.Run(); diff --git a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs index 27f1d721..5a2b0f9d 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Routing/Router.cs @@ -63,7 +63,7 @@ public async Task DispatchAsync(Context ctx, CancellationToken ca { ArgumentNullException.ThrowIfNull(ctx); - List matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); + List matchingRoutes = [.. _routes.Where(r => r.Matches(ctx.Activity))]; if (matchingRoutes.Count == 0 && _routes.Count > 0) { @@ -92,8 +92,8 @@ public async Task DispatchWithReturnAsync(Context { ArgumentNullException.ThrowIfNull(ctx); - List matchingRoutes = _routes.Where(r => r.Matches(ctx.Activity)).ToList(); - var name = ctx.Activity is InvokeActivity inv ? inv.Name : null; + List matchingRoutes = [.. _routes.Where(r => r.Matches(ctx.Activity))]; + string? name = ctx.Activity is InvokeActivity inv ? inv.Name : null; if (matchingRoutes.Count == 0 && _routes.Count > 0) { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs index 64429c7a..1e5ee878 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversation.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.Text.Json; using System.Text.Json.Serialization; using Microsoft.Teams.Bot.Core.Schema; @@ -52,7 +51,7 @@ public TeamsConversation() { return null; } - TeamsConversation result = new TeamsConversation(); + TeamsConversation result = new(); result.Id = conversation.Id; if (conversation.Properties == null) { diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs index 15cf5007..ef7b0bb4 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsConversationAccount.cs @@ -34,7 +34,7 @@ public TeamsConversationAccount() { return null; } - TeamsConversationAccount result = new TeamsConversationAccount(); + TeamsConversationAccount result = new(); result.Id = conversationAccount.Id; result.Name = conversationAccount.Name; result.Properties = conversationAccount.Properties; diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs index 8dfd01d7..2d43b5da 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.HostingExtensions.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +using Microsoft.AspNetCore.Routing; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; @@ -16,12 +17,35 @@ namespace Microsoft.Teams.Bot.Apps; public static class TeamsBotApplicationHostingExtensions { /// - /// Adds TeamsBotApplication to the service collection. + /// Registers Teams bot application services with the specified service collection. + /// + /// This method provides a simplified way to configure Teams bot support by encapsulating the + /// necessary service registrations and configuration binding. + /// The service collection to which Teams bot application services will be added. Cannot be null. + /// The name of the configuration section containing Azure Active Directory settings. Defaults to "AzureAd" if not + /// specified. + /// The service collection with Teams bot application services registered. + public static IServiceCollection AddTeams(this IServiceCollection services, string sectionName = "AzureAd") + => AddTeamsBotApplication(services, sectionName); + + /// + /// Adds the Default TeamsBotApplication + /// + /// + /// + /// + public static IServiceCollection AddTeamsBotApplication(this IServiceCollection services, string sectionName = "AzureAd") + { + return AddTeamsBotApplication(services, sectionName); + } + + /// + /// Adds a custom TeamsBotApplication /// /// The WebApplicationBuilder instance. /// The configuration section name for AzureAd settings. Default is "AzureAd". /// The updated WebApplicationBuilder instance. - public static IServiceCollection AddTeamsBotApplication(this IServiceCollection services, string sectionName = "AzureAd") + public static IServiceCollection AddTeamsBotApplication(this IServiceCollection services, string sectionName = "AzureAd") where TApp : TeamsBotApplication { // Register options to defer configuration reading until ServiceProvider is built services.AddOptions() @@ -46,7 +70,38 @@ public static IServiceCollection AddTeamsBotApplication(this IServiceCollection sp.GetService>()); }); - services.AddBotApplication(); + services.AddBotApplication(); return services; } + + /// + /// Configures the TeamsBotApp + /// + /// + /// + /// + /// + public static TApp UseTeamsBotApplication(this IEndpointRouteBuilder endpoints, + string routePath = "api/messages") + where TApp : TeamsBotApplication + => endpoints.UseBotApplication(routePath); + + /// + /// Configures the default TeamsBotApplication + /// + /// + /// + /// + public static TeamsBotApplication UseTeamsBotApplication(this IEndpointRouteBuilder endpoints, + string routePath = "api/messages") + => endpoints.UseBotApplication(routePath); + + /// + /// Alias for backward compat + /// + /// + /// + /// + public static TeamsBotApplication UseTeams(this IEndpointRouteBuilder endpoints,string routePath = "api/messages") + => endpoints.UseBotApplication(routePath); } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index ebcf3970..e5a4a03d 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -16,7 +16,6 @@ namespace Microsoft.Teams.Bot.Apps; public class TeamsBotApplication : BotApplication { private readonly TeamsApiClient _teamsApiClient; - private static TeamsBotApplicationBuilder? _botApplicationBuilder; /// /// Gets the router for dispatching Teams activities to registered routes. @@ -70,29 +69,4 @@ public TeamsBotApplication( } }; } - - /// - /// Creates a new instance of the TeamsBotApplicationBuilder to configure and build a Teams bot application. - /// - /// - public static TeamsBotApplicationBuilder CreateBuilder(string[] args) - { - _botApplicationBuilder = new TeamsBotApplicationBuilder(args); - return _botApplicationBuilder; - } - - /// - /// Runs the web application configured by the bot application builder. - /// - /// Call CreateBuilder() before invoking this method to ensure the bot application builder is - /// initialized. This method blocks the calling thread until the web application shuts down. -#pragma warning disable CA1822 // Mark members as static - public void Run() -#pragma warning restore CA1822 // Mark members as static - { - ArgumentNullException.ThrowIfNull(_botApplicationBuilder, "BotApplicationBuilder not initialized. Call CreateBuilder() first."); - - _botApplicationBuilder.WebApplication.Run(); - } - } diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs deleted file mode 100644 index 5b212fc6..00000000 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplicationBuilder.cs +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -using Microsoft.AspNetCore.Builder; -using Microsoft.AspNetCore.Hosting; -using Microsoft.Extensions.Configuration; -using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.Logging; -using Microsoft.Teams.Bot.Core; -using Microsoft.Teams.Bot.Core.Hosting; - -namespace Microsoft.Teams.Bot.Apps; - -/// -/// Teams Bot Application Builder to configure and build a Teams bot application. -/// -public class TeamsBotApplicationBuilder -{ - private readonly WebApplicationBuilder _webAppBuilder; - private WebApplication? _webApp; - private string _routePath = "/api/messages"; - internal WebApplication WebApplication => _webApp ?? throw new InvalidOperationException("Call Build"); - /// - /// Accessor for the service collection used to configure application services. - /// - public IServiceCollection Services => _webAppBuilder.Services; - /// - /// Accessor for the application configuration used to configure services and settings. - /// - public IConfiguration Configuration => _webAppBuilder.Configuration; - /// - /// Accessor for the web hosting environment information. - /// - public IWebHostEnvironment Environment => _webAppBuilder.Environment; - /// - /// Accessor for configuring the host settings and services. - /// - public ConfigureHostBuilder Host => _webAppBuilder.Host; - /// - /// Accessor for configuring logging services and settings. - /// - public ILoggingBuilder Logging => _webAppBuilder.Logging; - /// - /// Creates a new instance of the BotApplicationBuilder with default configuration and registered bot services. - /// - public TeamsBotApplicationBuilder(string[] args) - { - _webAppBuilder = WebApplication.CreateSlimBuilder(args); - _webAppBuilder.Services.AddHttpContextAccessor(); - _webAppBuilder.Services.AddTeamsBotApplication(); - } - - /// - /// Builds and configures the bot application pipeline, returning a fully initialized instance of the bot - /// application. - /// - /// A configured instance representing the bot application pipeline. - public TeamsBotApplication Build() - { - _webApp = _webAppBuilder.Build(); - TeamsBotApplication botApp = _webApp.Services.GetService() ?? throw new InvalidOperationException("Application not registered"); - _webApp.UseBotApplication(_routePath); - return botApp; - } - - /// - /// Sets the route path used to handle incoming bot requests. Defaults to "/api/messages". - /// - /// The route path to use for bot endpoints. Cannot be null or empty. - /// The current instance of for method chaining. - public TeamsBotApplicationBuilder WithRoutePath(string routePath) - { - _routePath = routePath; - return this; - } -} diff --git a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs index 5c96c80d..2fe06299 100644 --- a/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs +++ b/core/src/Microsoft.Teams.Bot.Compat/CompatTeamsInfo.cs @@ -93,7 +93,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) } ConversationClient client = GetConversationClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); TeamsConversationAccount result = await client.GetConversationMemberAsync( @@ -127,7 +127,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) ?? throw new InvalidOperationException("The GetMembers operation needs a valid conversation Id."); ConversationClient client = GetConversationClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); IList members = await client.GetConversationMembersAsync( @@ -164,7 +164,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) ?? throw new InvalidOperationException("The GetMembers operation needs a valid conversation Id."); ConversationClient client = GetConversationClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); Core.PagedMembersResult pagedMembers = await client.GetConversationPagedMembersAsync( @@ -198,7 +198,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) } ConversationClient client = GetConversationClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); TeamsConversationAccount result = await client.GetConversationMemberAsync( @@ -226,7 +226,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); ConversationClient client = GetConversationClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); IList members = await client.GetConversationMembersAsync( @@ -257,7 +257,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); ConversationClient client = GetConversationClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); Core.PagedMembersResult pagedMembers = await client.GetConversationPagedMembersAsync( @@ -287,7 +287,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) ?? throw new InvalidOperationException("The meetingId can only be null if turnContext is within the scope of a MS Teams Meeting."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); AppsTeams.MeetingInfo result = await client.FetchMeetingInfoAsync( @@ -321,7 +321,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); MeetingParticipant result = await client.FetchParticipantAsync( @@ -350,7 +350,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) notification = notification ?? throw new InvalidOperationException($"{nameof(notification)} is required."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); // Convert Bot Framework MeetingNotificationBase to Core MeetingNotificationBase using JSON round-trip @@ -385,7 +385,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); AppsTeams.TeamDetails result = await client.FetchTeamDetailsAsync( @@ -412,7 +412,7 @@ private static AgenticIdentity GetIdentity(ITurnContext turnContext) ?? throw new InvalidOperationException("This method is only valid within the scope of MS Teams Team."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); ChannelList channelList = await client.FetchChannelListAsync( @@ -447,11 +447,11 @@ public static async Task SendMessageToListOfUsersAsync( tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); CoreActivity coreActivity = ((Activity)activity).FromCompatActivity(); - var coreTeamsMembers = teamsMembers.Select(m => m.FromCompatTeamMember()).ToList(); + List coreTeamsMembers = teamsMembers.Select(m => m.FromCompatTeamMember()).ToList(); return await client.SendMessageToListOfUsersAsync( coreActivity, coreTeamsMembers, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); @@ -479,11 +479,11 @@ public static async Task SendMessageToListOfChannelsAsync( tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); CoreActivity coreActivity = ((Activity)activity).FromCompatActivity(); - var coreChannelsMembers = channelsMembers.Select(m => m.FromCompatTeamMember()).ToList(); + List coreChannelsMembers = channelsMembers.Select(m => m.FromCompatTeamMember()).ToList(); return await client.SendMessageToListOfChannelsAsync( coreActivity, coreChannelsMembers, tenantId, serviceUrl, identity, null, cancellationToken).ConfigureAwait(false); @@ -511,7 +511,7 @@ public static async Task SendMessageToAllUsersInTeamAsync( tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); CoreActivity coreActivity = ((Activity)activity).FromCompatActivity(); @@ -538,7 +538,7 @@ public static async Task SendMessageToAllUsersInTenantAsync( tenantId = tenantId ?? throw new InvalidOperationException($"{nameof(tenantId)} is required."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); CoreActivity coreActivity = ((Activity)activity).FromCompatActivity(); @@ -575,7 +575,7 @@ public static async Task> SendMessageToTeam ConversationReference? conversationReference = null; string newActivityId = string.Empty; string serviceUrl = turnContext.Activity.ServiceUrl; - var conversationParameters = new Microsoft.Bot.Schema.ConversationParameters + Microsoft.Bot.Schema.ConversationParameters conversationParameters = new() { IsGroup = true, ChannelData = new BotFrameworkTeams.TeamsChannelData { Channel = new BotFrameworkTeams.ChannelInfo { Id = teamsChannelId } }, @@ -619,7 +619,7 @@ await turnContext.Adapter.CreateConversationAsync( operationId = operationId ?? throw new InvalidOperationException($"{nameof(operationId)} is required."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); AppsTeams.BatchOperationState result = await client.GetOperationStateAsync( @@ -646,7 +646,7 @@ await turnContext.Adapter.CreateConversationAsync( operationId = operationId ?? throw new InvalidOperationException($"{nameof(operationId)} is required."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); AppsTeams.BatchFailedEntriesResponse result = await client.GetPagedFailedEntriesAsync( @@ -671,7 +671,7 @@ public static async Task CancelOperationAsync( operationId = operationId ?? throw new InvalidOperationException($"{nameof(operationId)} is required."); TeamsApiClient client = GetTeamsApiClient(turnContext); - var serviceUrl = new Uri(GetServiceUrl(turnContext)); + Uri serviceUrl = new(GetServiceUrl(turnContext)); AgenticIdentity identity = GetIdentity(turnContext); await client.CancelOperationAsync( diff --git a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs index 0c675619..c7e181bb 100644 --- a/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Core/BotApplication.cs @@ -4,6 +4,7 @@ using System.Diagnostics; using Microsoft.AspNetCore.Http; using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; using Microsoft.Teams.Bot.Core.Hosting; using Microsoft.Teams.Bot.Core.Schema; @@ -19,6 +20,15 @@ public class BotApplication private readonly UserTokenClient? _userTokenClient; internal TurnMiddleware MiddleWare { get; } + /// + /// Creates a default instance, primarily for testing purposes. The ConversationClient and UserTokenClient properties will not be initialized + /// + protected BotApplication() + { + _logger = NullLogger.Instance; + MiddleWare = new TurnMiddleware(); + } + /// /// Initializes a new instance of the BotApplication class with the specified conversation client, app ID, /// and logger. @@ -60,7 +70,7 @@ public BotApplication(ConversationClient conversationClient, UserTokenClient use /// Assign a delegate to process activities as they are received. The delegate should accept an /// and a , and return a representing the /// asynchronous operation. If , incoming activities will not be handled. - public Func? OnActivity { get; set; } + public virtual Func? OnActivity { get; set; } /// /// Processes an incoming HTTP request containing a bot activity. @@ -70,7 +80,7 @@ public BotApplication(ConversationClient conversationClient, UserTokenClient use /// /// /// - public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancellationToken = default) + public virtual async Task ProcessAsync(HttpContext httpContext, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(httpContext); ArgumentNullException.ThrowIfNull(_conversationClient); @@ -116,7 +126,7 @@ public async Task ProcessAsync(HttpContext httpContext, CancellationToken cancel /// /// The middleware component to add to the pipeline. Cannot be null. /// An ITurnMiddleWare instance representing the updated middleware pipeline. - public ITurnMiddleWare Use(ITurnMiddleWare middleware) + public ITurnMiddleware UseMiddleware(ITurnMiddleware middleware) { MiddleWare.Use(middleware); return MiddleWare; diff --git a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs index 3aebf412..87b62f6e 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ConversationClient.cs @@ -34,7 +34,7 @@ public class ConversationClient(HttpClient httpClient, ILoggerA task that represents the asynchronous operation. The task result contains the response with the ID of the sent activity. /// Thrown if the activity could not be sent successfully. The exception message includes the HTTP status code and /// response content. - public async Task SendActivityAsync(CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task SendActivityAsync(CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(activity); ArgumentNullException.ThrowIfNull(activity.Conversation); @@ -80,7 +80,7 @@ public async Task SendActivityAsync(CoreActivity activity, /// A cancellation token that can be used to cancel the update operation. /// A task that represents the asynchronous operation. The task result contains the response with the ID of the updated activity. /// Thrown if the activity could not be updated successfully. - public async Task UpdateActivityAsync(string conversationId, string activityId, CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task UpdateActivityAsync(string conversationId, string activityId, CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentException.ThrowIfNullOrWhiteSpace(activityId); @@ -112,7 +112,7 @@ public async Task UpdateActivityAsync(string conversatio /// A cancellation token that can be used to cancel the delete operation. /// A task that represents the asynchronous operation. /// Thrown if the activity could not be deleted successfully. - public async Task DeleteActivityAsync(string conversationId, string activityId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task DeleteActivityAsync(string conversationId, string activityId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentException.ThrowIfNullOrWhiteSpace(activityId); @@ -138,7 +138,7 @@ await _botHttpClient.SendAsync( /// A cancellation token that can be used to cancel the delete operation. /// A task that represents the asynchronous operation. /// Thrown if the activity could not be deleted successfully. - public async Task DeleteActivityAsync(CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task DeleteActivityAsync(CoreActivity activity, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(activity); ArgumentException.ThrowIfNullOrWhiteSpace(activity.Id); @@ -165,7 +165,7 @@ await DeleteActivityAsync( /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains a list of conversation members. /// Thrown if the members could not be retrieved successfully. - public async Task> GetConversationMembersAsync(string conversationId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task> GetConversationMembersAsync(string conversationId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(serviceUrl); @@ -198,7 +198,7 @@ public async Task> GetConversationMembersAsync(string /// of type T with detailed information about the user. /// /// Thrown if the member could not be retrieved successfully. - public async Task GetConversationMemberAsync(string conversationId, string userId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) where T : ConversationAccount + public virtual async Task GetConversationMemberAsync(string conversationId, string userId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) where T : ConversationAccount { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(serviceUrl); @@ -226,7 +226,7 @@ public async Task GetConversationMemberAsync(string conversationId, string /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains the conversations and an optional continuation token. /// Thrown if the conversations could not be retrieved successfully. - public async Task GetConversationsAsync(Uri serviceUrl, string? continuationToken = null, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task GetConversationsAsync(Uri serviceUrl, string? continuationToken = null, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(serviceUrl); @@ -257,7 +257,7 @@ public async Task GetConversationsAsync(Uri serviceUrl /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains a list of members for the activity. /// Thrown if the activity members could not be retrieved successfully. - public async Task> GetActivityMembersAsync(string conversationId, string activityId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task> GetActivityMembersAsync(string conversationId, string activityId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentException.ThrowIfNullOrWhiteSpace(activityId); @@ -285,7 +285,7 @@ public async Task> GetActivityMembersAsync(string con /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains the conversation resource response with the conversation ID. /// Thrown if the conversation could not be created successfully. - public async Task CreateConversationAsync(ConversationParameters parameters, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task CreateConversationAsync(ConversationParameters parameters, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(parameters); ArgumentNullException.ThrowIfNull(serviceUrl); @@ -314,7 +314,7 @@ public async Task CreateConversationAsync(Conversati /// A cancellation token that can be used to cancel the operation. /// A task that represents the asynchronous operation. The task result contains a page of members and an optional continuation token. /// Thrown if the conversation members could not be retrieved successfully. - public async Task GetConversationPagedMembersAsync(string conversationId, Uri serviceUrl, int? pageSize = null, string? continuationToken = null, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task GetConversationPagedMembersAsync(string conversationId, Uri serviceUrl, int? pageSize = null, string? continuationToken = null, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(serviceUrl); @@ -357,7 +357,7 @@ public async Task GetConversationPagedMembersAsync(string co /// A task that represents the asynchronous operation. /// Thrown if the member could not be deleted successfully. /// If the deleted member was the last member of the conversation, the conversation is also deleted. - public async Task DeleteConversationMemberAsync(string conversationId, string memberId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task DeleteConversationMemberAsync(string conversationId, string memberId, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentException.ThrowIfNullOrWhiteSpace(memberId); @@ -387,7 +387,7 @@ await _botHttpClient.SendAsync( /// A task that represents the asynchronous operation. The task result contains the response with a resource ID. /// Thrown if the history could not be sent successfully. /// Activities in the transcript must have unique IDs and appropriate timestamps for proper rendering. - public async Task SendConversationHistoryAsync(string conversationId, Transcript transcript, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task SendConversationHistoryAsync(string conversationId, Transcript transcript, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(transcript); @@ -417,7 +417,7 @@ public async Task SendConversationHistoryAsync( /// A task that represents the asynchronous operation. The task result contains the response with an attachment ID. /// Thrown if the attachment could not be uploaded successfully. /// This is useful for storing data in a compliant store when dealing with enterprises. - public async Task UploadAttachmentAsync(string conversationId, AttachmentData attachmentData, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) + public virtual async Task UploadAttachmentAsync(string conversationId, AttachmentData attachmentData, Uri serviceUrl, AgenticIdentity? agenticIdentity = null, CustomHeaders? customHeaders = null, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(conversationId); ArgumentNullException.ThrowIfNull(attachmentData); diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs index 288ad2db..b6d689c8 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/AddBotApplicationExtensions.cs @@ -105,7 +105,8 @@ public static IServiceCollection AddBotApplication(this IServiceCollection AppId = config["MicrosoftAppId"] ?? config["CLIENT_ID"] ?? config[$"{sectionName}:ClientId"] ?? string.Empty }; }); - services.AddAuthorization(logger, sectionName); + services.AddHttpContextAccessor(); + services.AddBotAuthorization(logger, sectionName); services.AddConversationClient(sectionName); services.AddUserTokenClient(sectionName); services.AddSingleton(); @@ -156,7 +157,6 @@ private static IServiceCollection AddBotClient( // Get configuration and logger to configure MSAL during registration // Try to get from service descriptors first ServiceDescriptor? configDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(IConfiguration)); - IConfiguration? configuration = configDescriptor?.ImplementationInstance as IConfiguration; ServiceDescriptor? loggerFactoryDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(ILoggerFactory)); ILoggerFactory? loggerFactory = loggerFactoryDescriptor?.ImplementationInstance as ILoggerFactory; @@ -164,7 +164,7 @@ private static IServiceCollection AddBotClient( ?? Extensions.Logging.Abstractions.NullLogger.Instance; // If configuration not available as instance, build temporary provider - if (configuration == null) + if (configDescriptor?.ImplementationInstance is not IConfiguration configuration) { using ServiceProvider tempProvider = services.BuildServiceProvider(); configuration = tempProvider.GetRequiredService(); diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs index b25cd792..41408f09 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs @@ -73,7 +73,7 @@ public static AuthenticationBuilder AddBotAuthentication(this IServiceCollection /// The configuration section name for the settings. Defaults to "AzureAd". /// Optional logger instance for logging. If null, a NullLogger will be used. /// An for further authorization configuration. - public static AuthorizationBuilder AddAuthorization(this IServiceCollection services, ILogger? logger = null, string aadSectionName = "AzureAd") + public static AuthorizationBuilder AddBotAuthorization(this IServiceCollection services, ILogger? logger = null, string aadSectionName = "AzureAd") { // Use NullLogger if no logger provided logger ??= Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; diff --git a/core/src/Microsoft.Teams.Bot.Core/ITurnMiddleWare.cs b/core/src/Microsoft.Teams.Bot.Core/ITurnMiddleWare.cs index cb55c6ab..8dc1dfc0 100644 --- a/core/src/Microsoft.Teams.Bot.Core/ITurnMiddleWare.cs +++ b/core/src/Microsoft.Teams.Bot.Core/ITurnMiddleWare.cs @@ -20,7 +20,7 @@ namespace Microsoft.Teams.Bot.Core; /// Implement this interface to add custom logic before or after the bot processes an activity. /// Middleware can perform tasks such as logging, authentication, or altering activities. Multiple middleware components /// can be chained together; each should call the nextTurn delegate to continue the pipeline. -public interface ITurnMiddleWare +public interface ITurnMiddleware { /// /// Triggers the middleware to process an activity during a bot turn. diff --git a/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs b/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs index 7d848350..f0b996b1 100644 --- a/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs +++ b/core/src/Microsoft.Teams.Bot.Core/TurnMiddleware.cs @@ -15,16 +15,16 @@ namespace Microsoft.Teams.Bot.Core; /// sequentially, with each middleware having the opportunity to modify the activity, perform side effects, /// or short-circuit the pipeline. Middleware is executed in the order it was registered via the Use method. /// -internal sealed class TurnMiddleware : ITurnMiddleWare, IEnumerable +internal sealed class TurnMiddleware : ITurnMiddleware, IEnumerable { - private readonly IList _middlewares = []; + private readonly IList _middlewares = []; /// /// Adds a middleware component to the end of the pipeline. /// /// The middleware to add. Cannot be null. /// The current TurnMiddleware instance for method chaining. - internal TurnMiddleware Use(ITurnMiddleWare middleware) + internal TurnMiddleware Use(ITurnMiddleware middleware) { _middlewares.Add(middleware); return this; @@ -59,7 +59,7 @@ public Task RunPipelineAsync(BotApplication botApplication, CoreActivity activit { return callback is not null ? callback!(activity, cancellationToken) ?? Task.CompletedTask : Task.CompletedTask; } - ITurnMiddleWare nextMiddleware = _middlewares[nextMiddlewareIndex]; + ITurnMiddleware nextMiddleware = _middlewares[nextMiddlewareIndex]; return nextMiddleware.OnTurnAsync( botApplication, activity, @@ -67,7 +67,7 @@ public Task RunPipelineAsync(BotApplication botApplication, CoreActivity activit cancellationToken); } - public IEnumerator GetEnumerator() + public IEnumerator GetEnumerator() { return _middlewares.GetEnumerator(); } diff --git a/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs index 346ea430..e71e2c50 100644 --- a/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs +++ b/core/src/Microsoft.Teams.Bot.Core/UserTokenClient.cs @@ -39,7 +39,7 @@ public class UserTokenClient(HttpClient httpClient, IConfiguration configuration /// The optional include parameter. /// The cancellation token. /// - public async Task GetTokenStatusAsync(string userId, string channelId, string? include = null, CancellationToken cancellationToken = default) + public virtual async Task GetTokenStatusAsync(string userId, string channelId, string? include = null, CancellationToken cancellationToken = default) { Dictionary queryParams = new() { @@ -79,7 +79,7 @@ public async Task GetTokenStatusAsync(string userId, str /// The optional code. /// The cancellation token. /// - public async Task GetTokenAsync(string userId, string connectionName, string channelId, string? code = null, CancellationToken cancellationToken = default) + public virtual async Task GetTokenAsync(string userId, string connectionName, string channelId, string? code = null, CancellationToken cancellationToken = default) { Dictionary queryParams = new() { @@ -113,7 +113,7 @@ public async Task GetTokenStatusAsync(string userId, str /// The optional final redirect URL. /// The cancellation token. /// - public async Task GetSignInResource(string userId, string connectionName, string channelId, string? finalRedirect = null, CancellationToken cancellationToken = default) + public virtual async Task GetSignInResource(string userId, string connectionName, string channelId, string? finalRedirect = null, CancellationToken cancellationToken = default) { var tokenExchangeState = new { @@ -155,7 +155,7 @@ public async Task GetSignInResource(string userId, stri /// The channel ID. /// The token to exchange. /// The cancellation token. - public async Task ExchangeTokenAsync(string userId, string connectionName, string channelId, string? exchangeToken, CancellationToken cancellationToken = default) + public virtual async Task ExchangeTokenAsync(string userId, string connectionName, string channelId, string? exchangeToken, CancellationToken cancellationToken = default) { Dictionary queryParams = new() { @@ -188,7 +188,7 @@ public async Task ExchangeTokenAsync(string userId, string conne /// Optional channel identifier. If provided, limits sign-out to tokens for this channel. /// A cancellation token that can be used to cancel the asynchronous operation. /// A task that represents the asynchronous sign-out operation. - public async Task SignOutUserAsync(string userId, string? connectionName = null, string? channelId = null, CancellationToken cancellationToken = default) + public virtual async Task SignOutUserAsync(string userId, string? connectionName = null, string? channelId = null, CancellationToken cancellationToken = default) { Dictionary queryParams = new() { @@ -225,7 +225,7 @@ await _botHttpClient.SendAsync( /// The resource URLs. /// The cancellation token. /// - public async Task> GetAadTokensAsync(string userId, string connectionName, string channelId, string[]? resourceUrls = null, CancellationToken cancellationToken = default) + public virtual async Task> GetAadTokensAsync(string userId, string connectionName, string channelId, string[]? resourceUrls = null, CancellationToken cancellationToken = default) { var body = new { diff --git a/core/test/ABSTokenServiceClient/Program.cs b/core/test/ABSTokenServiceClient/Program.cs index b41a7613..98de782d 100644 --- a/core/test/ABSTokenServiceClient/Program.cs +++ b/core/test/ABSTokenServiceClient/Program.cs @@ -4,7 +4,6 @@ using ABSTokenServiceClient; using Microsoft.AspNetCore.Builder; using Microsoft.Extensions.DependencyInjection; -using Microsoft.Teams.Bot.Core; using Microsoft.Teams.Bot.Core.Hosting; WebApplicationBuilder builder = WebApplication.CreateBuilder(args); diff --git a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs index c8aa55cc..4271915f 100644 --- a/core/test/ABSTokenServiceClient/UserTokenCLIService.cs +++ b/core/test/ABSTokenServiceClient/UserTokenCLIService.cs @@ -1,3 +1,6 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + using System.Text.Json; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs index 42fbaf9d..6d758f2b 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/ActivitiesTests.cs @@ -14,7 +14,7 @@ public class ActivitiesTests [Fact] public void MessageReaction_FromActivityConvertsCorrectly() { - var coreActivity = new CoreActivity + CoreActivity coreActivity = new() { Type = TeamsActivityType.MessageReaction }; @@ -41,7 +41,7 @@ public void MessageDelete_Constructor_Default_SetsMessageDeleteType() [Fact] public void MessageDelete_FromActivityConvertsCorrectly() { - var coreActivity = new CoreActivity + CoreActivity coreActivity = new() { Type = TeamsActivityType.MessageDelete, Id = "deleted-msg-id" @@ -71,7 +71,7 @@ public void MessageUpdate_Constructor_WithText_SetsTextAndMessageUpdateType() [Fact] public void MessageUpdate_InheritsFromMessageActivity() { - var activity = new MessageUpdateActivity + MessageUpdateActivity activity = new() { Text = "Updated", TextFormat = TextFormats.Markdown @@ -85,7 +85,7 @@ public void MessageUpdate_InheritsFromMessageActivity() [Fact] public void MessageUpdate_FromActivityConvertsCorrectly() { - var coreActivity = new CoreActivity + CoreActivity coreActivity = new() { Type = TeamsActivityType.MessageUpdate }; @@ -107,7 +107,7 @@ public void ConversationUpdate_Constructor_Default_SetsConversationUpdateType() [Fact] public void ConversationUpdate_FromActivityConvertsCorrectly() { - var coreActivity = new CoreActivity + CoreActivity coreActivity = new() { Type = TeamsActivityType.ConversationUpdate }; @@ -129,7 +129,7 @@ public void InstallUpdate_Constructor_Default_SetsInstallationUpdateType() [Fact] public void InstallUpdate_FromActivityConvertsCorrectly() { - var coreActivity = new CoreActivity + CoreActivity coreActivity = new() { Type = TeamsActivityType.InstallationUpdate }; diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs index 406d3b99..2afc6d7c 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/InvokeActivityTest.cs @@ -12,7 +12,7 @@ public class InvokeActivityTest [Fact] public void DefaultCtor() { - var ia = new InvokeActivity(); + InvokeActivity ia = new(); Assert.NotNull(ia); Assert.Equal(TeamsActivityType.Invoke, ia.Type); Assert.Null(ia.Name); @@ -23,7 +23,7 @@ public void DefaultCtor() [Fact] public void FromCoreActivityWithValue() { - var coreActivity = new CoreActivity + CoreActivity coreActivity = new() { Type = TeamsActivityType.Invoke, Value = JsonNode.Parse("{ \"key\": \"value\" }"), @@ -33,7 +33,7 @@ public void FromCoreActivityWithValue() { "name", "testName" } } }; - var ia = InvokeActivity.FromActivity(coreActivity); + InvokeActivity ia = InvokeActivity.FromActivity(coreActivity); Assert.NotNull(ia); Assert.Equal(TeamsActivityType.Invoke, ia.Type); Assert.Equal("testName", ia.Name); diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/RouterTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/RouterTests.cs index f599a228..f54cf45a 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/RouterTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/RouterTests.cs @@ -17,10 +17,10 @@ private static Route MakeRoute(string name) where TActivit [Fact] public void Register_DuplicateName_Throws() { - var router = new Router(NullLogger.Instance); + Router router = new(NullLogger.Instance); router.Register(MakeRoute("Message")); - var ex = Assert.Throws(() + InvalidOperationException ex = Assert.Throws(() => router.Register(MakeRoute("Message"))); Assert.Contains("Message", ex.Message); @@ -29,7 +29,7 @@ public void Register_DuplicateName_Throws() [Fact] public void Register_UniqueNames_Succeeds() { - var router = new Router(NullLogger.Instance); + Router router = new(NullLogger.Instance); router.Register(MakeRoute("Message/hello")); router.Register(MakeRoute("Message/bye")); @@ -41,10 +41,10 @@ public void Register_UniqueNames_Succeeds() [Fact] public void Register_CatchAllInvokeAfterSpecific_Throws() { - var router = new Router(NullLogger.Instance); + Router router = new(NullLogger.Instance); router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.AdaptiveCardAction}")); - var ex = Assert.Throws(() + InvalidOperationException ex = Assert.Throws(() => router.Register(MakeRoute(TeamsActivityType.Invoke))); Assert.Contains("catch-all", ex.Message); @@ -53,10 +53,10 @@ public void Register_CatchAllInvokeAfterSpecific_Throws() [Fact] public void Register_SpecificInvokeAfterCatchAll_Throws() { - var router = new Router(NullLogger.Instance); + Router router = new(NullLogger.Instance); router.Register(MakeRoute(TeamsActivityType.Invoke)); - var ex = Assert.Throws(() + InvalidOperationException ex = Assert.Throws(() => router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.TaskFetch}"))); Assert.Contains("invoke", ex.Message); @@ -65,7 +65,7 @@ public void Register_SpecificInvokeAfterCatchAll_Throws() [Fact] public void Register_MultipleCatchAllInvokes_ThrowsDuplicateName() { - var router = new Router(NullLogger.Instance); + Router router = new(NullLogger.Instance); router.Register(MakeRoute(TeamsActivityType.Invoke)); Assert.Throws(() @@ -75,7 +75,7 @@ public void Register_MultipleCatchAllInvokes_ThrowsDuplicateName() [Fact] public void Register_MultipleSpecificInvokeHandlers_Succeeds() { - var router = new Router(NullLogger.Instance); + Router router = new(NullLogger.Instance); router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.AdaptiveCardAction}")); router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.TaskFetch}")); router.Register(MakeRoute($"{TeamsActivityType.Invoke}/{InvokeNames.TaskSubmit}")); @@ -88,7 +88,7 @@ public void Register_MultipleSpecificInvokeHandlers_Succeeds() [Fact] public void Register_ConversationUpdateCatchAllAndSpecific_Succeeds() { - var router = new Router(NullLogger.Instance); + Router router = new(NullLogger.Instance); router.Register(MakeRoute(TeamsActivityType.ConversationUpdate)); router.Register(MakeRoute($"{TeamsActivityType.ConversationUpdate}/membersAdded")); @@ -98,7 +98,7 @@ public void Register_ConversationUpdateCatchAllAndSpecific_Succeeds() [Fact] public void Register_InstallUpdateCatchAllAndSpecific_Succeeds() { - var router = new Router(NullLogger.Instance); + Router router = new(NullLogger.Instance); router.Register(MakeRoute(TeamsActivityType.InstallationUpdate)); router.Register(MakeRoute($"{TeamsActivityType.InstallationUpdate}/add")); router.Register(MakeRoute($"{TeamsActivityType.InstallationUpdate}/remove")); diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs index 3a29e102..afddaa53 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityBuilderTests.cs @@ -50,7 +50,7 @@ public void Constructor_WithNullActivity_ThrowsArgumentNullException() [Fact] public void WithId_SetsActivityId() { - var activity = builder + TeamsActivity activity = builder .WithId("test-activity-id") .Build(); @@ -62,7 +62,7 @@ public void WithServiceUrl_SetsServiceUrl() { Uri serviceUrl = new("https://smba.trafficmanager.net/teams/"); - var activity = builder + TeamsActivity activity = builder .WithServiceUrl(serviceUrl) .Build(); @@ -72,7 +72,7 @@ public void WithServiceUrl_SetsServiceUrl() [Fact] public void WithChannelId_SetsChannelId() { - var activity = builder + TeamsActivity activity = builder .WithChannelId("msteams") .Build(); @@ -82,7 +82,7 @@ public void WithChannelId_SetsChannelId() [Fact] public void WithType_SetsActivityType() { - var activity = builder + TeamsActivity activity = builder .WithType(TeamsActivityType.Message) .Build(); @@ -92,7 +92,7 @@ public void WithType_SetsActivityType() [Fact] public void WithText_SetsTextContent() { - var activity = builder + TeamsActivity activity = builder .WithText("Hello, World!") .Build(); @@ -108,7 +108,7 @@ public void WithFrom_SetsSenderAccount() Name = "Sender Name" }); - var activity = builder + TeamsActivity activity = builder .WithFrom(fromAccount) .Build(); @@ -125,7 +125,7 @@ public void WithRecipient_SetsRecipientAccount() Name = "Recipient Name" }); Assert.NotNull(recipientAccount); - var activity = builder + TeamsActivity activity = builder .WithRecipient(recipientAccount) .Build(); @@ -136,17 +136,17 @@ public void WithRecipient_SetsRecipientAccount() [Fact] public void WithConversation_SetsConversationInfo() { - Conversation baseConversation = new Conversation + Conversation baseConversation = new() { Id = "conversation-id" }; Assert.NotNull(baseConversation); baseConversation.Properties.Add("tenantId", "tenant-123"); - baseConversation.Properties.Add("conversationType", "channel"); + baseConversation.Properties.Add("conversationType", "channel"); TeamsConversation? conversation = TeamsConversation.FromConversation(baseConversation); - - var activity = builder + + TeamsActivity activity = builder .WithConversation(conversation) .Build(); @@ -164,7 +164,7 @@ public void WithChannelData_SetsChannelData() TeamsTeamId = "19:team-id@thread.tacv2" }; - var activity = builder + TeamsActivity activity = builder .WithChannelData(channelData) .Build(); @@ -185,7 +185,7 @@ public void WithEntities_SetsEntitiesCollection() } ]; - var activity = builder + TeamsActivity activity = builder .WithEntities(entities) .Build(); @@ -205,7 +205,7 @@ public void WithAttachments_SetsAttachmentsCollection() } ]; - var activity = builder + TeamsActivity activity = builder .WithAttachments(attachments) .Build(); @@ -224,7 +224,7 @@ public void WithAttachment_SetsSingleAttachment() Name = "single" }; - var activity = builder + TeamsActivity activity = builder .WithAttachment(attachment) .Build(); @@ -242,7 +242,7 @@ public void AddEntity_AddsEntityToCollection() Country = "US" }; - var activity = builder + TeamsActivity activity = builder .AddEntity(entity) .Build(); @@ -254,7 +254,7 @@ public void AddEntity_AddsEntityToCollection() [Fact] public void AddEntity_MultipleEntities_AddsAllToCollection() { - var activity = builder + TeamsActivity activity = builder .AddEntity(new ClientInfoEntity { Locale = "en-US" }) .AddEntity(new ProductInfoEntity { Id = "product-123" }) .Build(); @@ -272,7 +272,7 @@ public void AddAttachment_AddsAttachmentToCollection() Name = "test.html" }; - var activity = builder + TeamsActivity activity = builder .AddAttachment(attachment) .Build(); @@ -284,7 +284,7 @@ public void AddAttachment_AddsAttachmentToCollection() [Fact] public void AddAttachment_MultipleAttachments_AddsAllToCollection() { - var activity = builder + TeamsActivity activity = builder .AddAttachment(new TeamsAttachment { ContentType = "text/html" }) .AddAttachment(new TeamsAttachment { ContentType = "application/json" }) .Build(); @@ -298,7 +298,7 @@ public void AddAdaptiveCardAttachment_AddsAdaptiveCard() { var adaptiveCard = new { type = "AdaptiveCard", version = "1.2" }; - var activity = builder + TeamsActivity activity = builder .AddAdaptiveCardAttachment(adaptiveCard) .Build(); @@ -313,7 +313,7 @@ public void WithAdaptiveCardAttachment_ConfigureActionAppliesChanges() { var adaptiveCard = new { type = "AdaptiveCard" }; - var activity = builder + TeamsActivity activity = builder .WithAdaptiveCardAttachment(adaptiveCard, b => b.WithName("feedback")) .Build(); @@ -343,7 +343,7 @@ public void AddMention_WithAccountAndDefaultText_AddsMentionAndUpdatesText() Name = "John Doe" }; - var activity = builder + TeamsActivity activity = builder .WithText("said hello") .AddMention(account) .Build(); @@ -368,7 +368,7 @@ public void AddMention_WithCustomText_UsesCustomText() Name = "John Doe" }; - var activity = builder + TeamsActivity activity = builder .WithText("replied") .AddMention(account, "CustomName") .Build(); @@ -785,7 +785,7 @@ public void IntegrationTest_CreateComplexActivity() TeamsTeamId = "19:team@thread.tacv2" }; - var conv = new Conversation + Conversation conv = new() { Id = "conv-001", Properties = @@ -797,7 +797,7 @@ public void IntegrationTest_CreateComplexActivity() TeamsConversation? tc = TeamsConversation.FromConversation(conv); Assert.NotNull(tc); - + TeamsActivity activity = builder .WithType(TeamsActivityType.Message) .WithId("msg-001") diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs index ef737604..1a3f6938 100644 --- a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/TeamsActivityTests.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using Microsoft.AspNetCore.Mvc.ApplicationParts; using Microsoft.Teams.Bot.Apps.Schema; using Microsoft.Teams.Bot.Core.Schema; namespace Microsoft.Teams.Bot.Apps.UnitTests; @@ -43,7 +42,7 @@ static void AssertCid(CoreActivity a) [Fact] public void DownCastTeamsActivity_To_CoreActivity_WithoutRebase() { - TeamsActivity teamsActivity = new TeamsActivity() + TeamsActivity teamsActivity = new() { Conversation = new TeamsConversation() { @@ -174,7 +173,7 @@ public void Deserialize_TeamsActivity_Invoke_WithValue() [Fact] public void Serialize_Does_Not_Repeat_AAdObjectId() { - var coreActivity = CoreActivity.FromJsonString(""" + CoreActivity coreActivity = CoreActivity.FromJsonString(""" { "type": "message", "recipient": { @@ -184,7 +183,7 @@ public void Serialize_Does_Not_Repeat_AAdObjectId() } } """); - var teamsActivity = TeamsActivity.FromActivity(coreActivity); + TeamsActivity teamsActivity = TeamsActivity.FromActivity(coreActivity); string json = teamsActivity.ToJson(); string[] found = json.Split("aadObjectId"); Assert.Equal(1, found.Length - 1); // only one occurrence @@ -193,7 +192,7 @@ public void Serialize_Does_Not_Repeat_AAdObjectId() [Fact] public void FromActivity_Overrides_Recipient() { - var coreActivity = CoreActivity.FromJsonString(""" + CoreActivity coreActivity = CoreActivity.FromJsonString(""" { "type": "message", "recipient": { @@ -205,10 +204,10 @@ public void FromActivity_Overrides_Recipient() } } """); - var teamsActivity = TeamsActivity.FromActivity(coreActivity); + TeamsActivity teamsActivity = TeamsActivity.FromActivity(coreActivity); Assert.Equal("rec1", teamsActivity.Recipient?.Id); Assert.Equal("recname", teamsActivity.Recipient?.Name); - var agenticIdentity = AgenticIdentity.FromProperties(teamsActivity.Recipient?.Properties); + AgenticIdentity? agenticIdentity = AgenticIdentity.FromProperties(teamsActivity.Recipient?.Properties); Assert.NotNull(agenticIdentity); Assert.Equal("0d5eb8a3-1642-4e63-9ccc-a89aa461716c", agenticIdentity.AgenticUserId); Assert.Equal("3fc62d4f-b04e-4c71-878b-02a2fa395fe2", agenticIdentity.AgenticAppId); @@ -218,7 +217,7 @@ public void FromActivity_Overrides_Recipient() [Fact] public void FromActivity_ReturnsDerivedType_WhenRegistered() { - CoreActivity coreActivity = new CoreActivity(ActivityType.Message); + CoreActivity coreActivity = new(ActivityType.Message); TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); Assert.IsType(activity); @@ -227,7 +226,7 @@ public void FromActivity_ReturnsDerivedType_WhenRegistered() [Fact] public void FromActivity_ReturnsBaseType_WhenNotRegistered() { - CoreActivity coreActivity = new CoreActivity("unknownType"); + CoreActivity coreActivity = new("unknownType"); TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); Assert.Equal(typeof(TeamsActivity), activity.GetType()); @@ -243,16 +242,16 @@ public void EmptyTeamsActivity() } """; - var teamsActivity = TeamsActivity.CreateBuilder().Build(); + TeamsActivity teamsActivity = TeamsActivity.CreateBuilder().Build(); Assert.NotNull(teamsActivity); - var json = teamsActivity.ToJson(); + string json = teamsActivity.ToJson(); Assert.Equal(minActivityJson, json); } [Fact] public void BaseFieldsAsBaseTypes() { - CoreActivity ca = new CoreActivity(); + CoreActivity ca = new(); ca.Conversation = new Conversation() { Id = "conv1" }; ca.Conversation.Properties.Add("tenantId", "tenant-1"); CoreActivity ta = TeamsActivity.FromActivity(ca); @@ -271,7 +270,7 @@ public void BaseFieldsAsBaseTypes() [Fact] public void Deserialize_with_Conversation_and_Tenant() { - var json = """ + string json = """ { "type" : "message", "conversation": { @@ -280,11 +279,11 @@ public void Deserialize_with_Conversation_and_Tenant() } } """; - var ca = CoreActivity.FromJsonString(json); + CoreActivity ca = CoreActivity.FromJsonString(json); Assert.NotNull(ca); Assert.NotNull(ca.Conversation); Assert.Equal("conv1", ca.Conversation.Id); - if (ca.Conversation.Properties.TryGetValue("tenantId", out var outTenantId)) + if (ca.Conversation.Properties.TryGetValue("tenantId", out object? outTenantId)) { Assert.Equal("tenant-1", outTenantId?.ToString()); } diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs index 6f24bccb..06de29f3 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatActivityTests.cs @@ -17,7 +17,7 @@ public class CompatActivityTests [Fact] public void FromCompatActivity_PreservesCoreProperties() { - var activity = new Activity + Activity activity = new() { Type = ActivityTypes.Message, ServiceUrl = "https://smba.trafficmanager.net/teams", @@ -44,7 +44,7 @@ public void FromCompatActivity_PreservesCoreProperties() [Fact] public void FromCompatActivity_PreservesTextAndMetadata() { - var activity = new Activity + Activity activity = new() { Type = ActivityTypes.Message, Text = "Hello, this is a test message", @@ -81,18 +81,18 @@ public void FromCompatActivity_PreservesAdaptiveCardAttachment() Assert.NotNull(coreActivity.Attachments); Assert.Single(coreActivity.Attachments); - var attachmentNode = coreActivity.Attachments[0]; + JsonNode? attachmentNode = coreActivity.Attachments[0]; Assert.NotNull(attachmentNode); - var attachmentObj = attachmentNode.AsObject(); + JsonObject attachmentObj = attachmentNode.AsObject(); - var contentType = attachmentObj["contentType"]?.GetValue(); + string? contentType = attachmentObj["contentType"]?.GetValue(); Assert.Equal("application/vnd.microsoft.card.adaptive", contentType); - var content = attachmentObj["content"]; + JsonNode? content = attachmentObj["content"]; Assert.NotNull(content); - var card = AdaptiveCard.FromJson(content.ToJsonString()).Card; + AdaptiveCard card = AdaptiveCard.FromJson(content.ToJsonString()).Card; Assert.Equal(2, card.Body?.Count); - var firstTextBlock = card?.Body?[0] as AdaptiveTextBlock; + AdaptiveTextBlock? firstTextBlock = card?.Body?[0] as AdaptiveTextBlock; Assert.NotNull(firstTextBlock); Assert.Equal("Mention a user by User Principle Name: Hello Test User UPN", firstTextBlock.Text); } @@ -100,13 +100,13 @@ public void FromCompatActivity_PreservesAdaptiveCardAttachment() [Fact] public void FromCompatActivity_PreservesMultipleAttachments() { - var activity = new Activity + Activity activity = new() { Type = ActivityTypes.Message, Attachments = new List { - new Attachment { ContentType = "text/plain", Content = "First attachment" }, - new Attachment { ContentType = "image/png", ContentUrl = "https://example.com/image.png" } + new() { ContentType = "text/plain", Content = "First attachment" }, + new() { ContentType = "image/png", ContentUrl = "https://example.com/image.png" } } }; @@ -133,7 +133,7 @@ public void FromCompatActivity_PreservesEntities() Assert.NotNull(coreActivity.Entities); Assert.Single(coreActivity.Entities); - var entity = coreActivity.Entities[0]?.AsObject(); + JsonObject? entity = coreActivity.Entities[0]?.AsObject(); Assert.NotNull(entity); Assert.Equal("https://schema.org/Message", entity["type"]?.GetValue()); } @@ -149,10 +149,10 @@ public void FromCompatActivity_PreservesMultipleEntities() Assert.NotNull(coreActivity.Entities); Assert.Equal(2, coreActivity.Entities?.Count); - var firstEntity = coreActivity.Entities?[0]?.AsObject(); + JsonObject? firstEntity = coreActivity.Entities?[0]?.AsObject(); Assert.Equal("https://schema.org/Message", firstEntity?["type"]?.GetValue()); - var secondEntity = coreActivity.Entities?[1]?.AsObject(); + JsonObject? secondEntity = coreActivity.Entities?[1]?.AsObject(); Assert.Equal("BotMessageMetadata", secondEntity?["type"]?.GetValue()); } @@ -175,10 +175,10 @@ public void FromCompatActivity_PreservesSuggestedActions() string coreActivityJson = coreActivity.ToJson(); JsonNode coreActivityNode = JsonNode.Parse(coreActivityJson)!; - var suggestedActions = coreActivityNode["suggestedActions"]; + JsonNode? suggestedActions = coreActivityNode["suggestedActions"]; Assert.NotNull(suggestedActions); - var actions = suggestedActions["actions"]?.AsArray(); + JsonArray? actions = suggestedActions["actions"]?.AsArray(); Assert.NotNull(actions); Assert.Equal(3, actions.Count); } @@ -193,7 +193,7 @@ public void FromCompatActivity_PreservesSuggestedActionDetails() string coreActivityJson = coreActivity.ToJson(); JsonNode coreActivityNode = JsonNode.Parse(coreActivityJson)!; - var actions = coreActivityNode["suggestedActions"]?["actions"]?.AsArray(); + JsonArray? actions = coreActivityNode["suggestedActions"]?["actions"]?.AsArray(); Assert.NotNull(actions); // Verify Action.Odsl actions @@ -217,7 +217,7 @@ public void FromCompatActivity_PreservesSuggestedActionDetails() [Fact] public void FromCompatActivity_PreservesChannelData() { - var activity = new Activity + Activity activity = new() { Type = ActivityTypes.Message, ChannelData = new { customProperty = "customValue", nestedObject = new { key = "value" } } @@ -241,7 +241,7 @@ public void FromCompatActivity_PreservesComplexChannelData() Assert.NotNull(coreActivity.ChannelData); Assert.True(coreActivity.ChannelData.Properties.ContainsKey("feedbackLoopEnabled")); - var feedbackLoopValue = (JsonElement)coreActivity.ChannelData.Properties["feedbackLoopEnabled"]!; + JsonElement feedbackLoopValue = (JsonElement)coreActivity.ChannelData.Properties["feedbackLoopEnabled"]!; Assert.True(feedbackLoopValue.GetBoolean()); } diff --git a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs index 33813b4f..755cc1f6 100644 --- a/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs +++ b/core/test/Microsoft.Teams.Bot.Compat.UnitTests/CompatAdapterTests.cs @@ -18,12 +18,12 @@ public class CompatAdapterTests public async Task ContinueConversationAsync_WhenCastToBotAdapter_BuildsTurnContextWithUnderlyingClients() { // Arrange - var (compatAdapter, teamsApiClient) = CreateCompatAdapter(); + (CompatAdapter? compatAdapter, TeamsApiClient? teamsApiClient) = CreateCompatAdapter(); // Cast to BotAdapter to ensure we're using the base class method BotAdapter botAdapter = compatAdapter; - var conversationReference = new ConversationReference + ConversationReference conversationReference = new() { ServiceUrl = "https://smba.trafficmanager.net/teams", ChannelId = "msteams", @@ -71,23 +71,23 @@ await botAdapter.ContinueConversationAsync( private static (CompatAdapter, TeamsApiClient) CreateCompatAdapter() { - var httpClient = new HttpClient(); - var conversationClient = new ConversationClient(httpClient, NullLogger.Instance); + HttpClient httpClient = new(); + ConversationClient conversationClient = new(httpClient, NullLogger.Instance); - var mockConfig = new Mock(); + Mock mockConfig = new(); mockConfig.Setup(c => c["UserTokenApiEndpoint"]).Returns("https://token.botframework.com"); - var userTokenClient = new UserTokenClient(httpClient, mockConfig.Object, NullLogger.Instance); - var teamsApiClient = new TeamsApiClient(httpClient, NullLogger.Instance); + UserTokenClient userTokenClient = new(httpClient, mockConfig.Object, NullLogger.Instance); + TeamsApiClient teamsApiClient = new(httpClient, NullLogger.Instance); - var teamsBotApplication = new TeamsBotApplication( + TeamsBotApplication teamsBotApplication = new( conversationClient, userTokenClient, teamsApiClient, Mock.Of(), NullLogger.Instance); - var compatAdapter = new CompatAdapter( + CompatAdapter compatAdapter = new( teamsBotApplication, Mock.Of(), NullLogger.Instance); diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs index 93e82b7f..302327d0 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/BotApplicationTests.cs @@ -89,7 +89,7 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() DefaultHttpContext httpContext = CreateHttpContextWithActivity(activity); bool middlewareCalled = false; - Mock mockMiddleware = new(); + Mock mockMiddleware = new(); mockMiddleware .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -99,7 +99,7 @@ public async Task ProcessAsync_WithMiddleware_ExecutesMiddleware() }) .Returns(Task.CompletedTask); - botApp.Use(mockMiddleware.Object); + botApp.UseMiddleware(mockMiddleware.Object); bool onActivityCalled = false; botApp.OnActivity = (act, ct) => @@ -146,9 +146,9 @@ public void Use_AddsMiddlewareToChain() { BotApplication botApp = CreateBotApplication(); - Mock mockMiddleware = new(); + Mock mockMiddleware = new(); - ITurnMiddleWare result = botApp.Use(mockMiddleware.Object); + ITurnMiddleware result = botApp.UseMiddleware(mockMiddleware.Object); Assert.NotNull(result); } @@ -182,7 +182,7 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() ServiceUrl = new Uri("https://test.service.url/") }; - var result = await botApp.SendActivityAsync(activity); + SendActivityResponse? result = await botApp.SendActivityAsync(activity); Assert.NotNull(result); Assert.Contains("activity123", result.Id); diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs index 89efedf2..9eb027ca 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/ConversationClientTests.cs @@ -38,7 +38,7 @@ public async Task SendActivityAsync_WithValidActivity_SendsSuccessfully() ServiceUrl = new Uri("https://test.service.url/") }; - var result = await conversationClient.SendActivityAsync(activity); + SendActivityResponse result = await conversationClient.SendActivityAsync(activity); Assert.NotNull(result); Assert.Contains("activity123", result.Id); diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs index 3b33e8fd..ebef6800 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/Hosting/AddBotApplicationExtensionsTests.cs @@ -35,7 +35,7 @@ private static ServiceProvider BuildServiceProvider(Dictionary private static void AssertMsalOptions(ServiceProvider serviceProvider, string expectedClientId, string expectedTenantId, string expectedInstance = "https://login.microsoftonline.com/") { - var msalOptions = serviceProvider + MicrosoftIdentityApplicationOptions msalOptions = serviceProvider .GetRequiredService>() .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.Equal(expectedClientId, msalOptions.ClientId); @@ -47,7 +47,7 @@ private static void AssertMsalOptions(ServiceProvider serviceProvider, string ex public void AddConversationClient_WithBotFrameworkConfig_ConfiguresClientSecret() { // Arrange - var configData = new Dictionary + Dictionary configData = new() { ["MicrosoftAppId"] = "test-app-id", ["MicrosoftAppTenantId"] = "test-tenant-id", @@ -59,7 +59,7 @@ public void AddConversationClient_WithBotFrameworkConfig_ConfiguresClientSecret( // Assert AssertMsalOptions(serviceProvider, "test-app-id", "test-tenant-id"); - var msalOptions = serviceProvider + MicrosoftIdentityApplicationOptions msalOptions = serviceProvider .GetRequiredService>() .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); @@ -85,7 +85,7 @@ public void AddConversationClient_WithCoreConfigAndClientSecret_ConfiguresClient // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); - var msalOptions = serviceProvider + MicrosoftIdentityApplicationOptions msalOptions = serviceProvider .GetRequiredService>() .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); @@ -111,7 +111,7 @@ public void AddConversationClient_WithCoreConfigAndSystemAssignedMI_ConfiguresSy // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); - var msalOptions = serviceProvider + MicrosoftIdentityApplicationOptions msalOptions = serviceProvider .GetRequiredService>() .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); @@ -140,7 +140,7 @@ public void AddConversationClient_WithCoreConfigAndUserAssignedMI_ConfiguresUser // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); - var msalOptions = serviceProvider + MicrosoftIdentityApplicationOptions msalOptions = serviceProvider .GetRequiredService>() .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.NotNull(msalOptions.ClientCredentials); @@ -168,7 +168,7 @@ public void AddConversationClient_WithCoreConfigAndNoManagedIdentity_ConfiguresU // Assert AssertMsalOptions(serviceProvider, "test-client-id", "test-tenant-id"); - var msalOptions = serviceProvider + MicrosoftIdentityApplicationOptions msalOptions = serviceProvider .GetRequiredService>() .Get(AddBotApplicationExtensions.MsalConfigKey); Assert.Null(msalOptions.ClientCredentials); diff --git a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs index 2c006158..b9bf2d81 100644 --- a/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs +++ b/core/test/Microsoft.Teams.Bot.Core.UnitTests/MiddlewareTests.cs @@ -17,9 +17,9 @@ public async Task BotApplication_Use_AddsMiddlewareToChain() { BotApplication botApp = CreateBotApplication(); - Mock mockMiddleware = new(); + Mock mockMiddleware = new(); - ITurnMiddleWare result = botApp.Use(mockMiddleware.Object); + ITurnMiddleware result = botApp.UseMiddleware(mockMiddleware.Object); Assert.NotNull(result); } @@ -32,7 +32,7 @@ public async Task Middleware_ExecutesInOrder() List executionOrder = []; - Mock mockMiddleware1 = new(); + Mock mockMiddleware1 = new(); mockMiddleware1 .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -42,7 +42,7 @@ public async Task Middleware_ExecutesInOrder() }) .Returns(Task.CompletedTask); - Mock mockMiddleware2 = new(); + Mock mockMiddleware2 = new(); mockMiddleware2 .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -52,8 +52,8 @@ public async Task Middleware_ExecutesInOrder() }) .Returns(Task.CompletedTask); - botApp.Use(mockMiddleware1.Object); - botApp.Use(mockMiddleware2.Object); + botApp.UseMiddleware(mockMiddleware1.Object); + botApp.UseMiddleware(mockMiddleware2.Object); CoreActivity activity = new() { @@ -86,19 +86,19 @@ public async Task Middleware_CanShortCircuit() bool secondMiddlewareCalled = false; bool onActivityCalled = false; - Mock mockMiddleware1 = new(); + Mock mockMiddleware1 = new(); mockMiddleware1 .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Returns(Task.CompletedTask); // Don't call next - Mock mockMiddleware2 = new(); + Mock mockMiddleware2 = new(); mockMiddleware2 .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(() => secondMiddlewareCalled = true) .Returns(Task.CompletedTask); - botApp.Use(mockMiddleware1.Object); - botApp.Use(mockMiddleware2.Object); + botApp.UseMiddleware(mockMiddleware1.Object); + botApp.UseMiddleware(mockMiddleware2.Object); CoreActivity activity = new() { @@ -131,7 +131,7 @@ public async Task Middleware_ReceivesCancellationToken() CancellationToken receivedToken = default; - Mock mockMiddleware = new(); + Mock mockMiddleware = new(); mockMiddleware .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -141,7 +141,7 @@ public async Task Middleware_ReceivesCancellationToken() }) .Returns(Task.CompletedTask); - botApp.Use(mockMiddleware.Object); + botApp.UseMiddleware(mockMiddleware.Object); CoreActivity activity = new() { @@ -170,7 +170,7 @@ public async Task Middleware_ReceivesActivity() CoreActivity? receivedActivity = null; - Mock mockMiddleware = new(); + Mock mockMiddleware = new(); mockMiddleware .Setup(m => m.OnTurnAsync(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny())) .Callback(async (app, act, next, ct) => @@ -180,7 +180,7 @@ public async Task Middleware_ReceivesActivity() }) .Returns(Task.CompletedTask); - botApp.Use(mockMiddleware.Object); + botApp.UseMiddleware(mockMiddleware.Object); CoreActivity activity = new() { From 520c2e050f3463359a3fc41e8c8d8ab93ccf286d Mon Sep 17 00:00:00 2001 From: Corina <14900841+corinagum@users.noreply.github.com> Date: Thu, 5 Mar 2026 14:16:35 -0800 Subject: [PATCH 68/69] Add `CitationEntity` & citation extension methods (#361) Port `CitationEntity` and supporting types from main, adapted for `next/core`. - Adds `AddCitation`, `AddAIGenerated`, and `AddFeedback` methods to `TeamsActivity` - Enables `OMessage` sub-dispatch in `EntityList.FromJsonArray()` with `@type` routing (`"Message"` --> `CitationEntity`, `"CreativeWork"` --> `SensitiveUsageEntity`) - Adds typed `FeedbackLoopEnabled` property to `TeamsChannelData` - Registers new citation types in `TeamsActivityJsonContext`: (`CitationEntity`, `CitationClaim`, `CitationAppearanceDocument`, `CitationImageObject`, `CitationAppearance`) - Registers previously missing entity types in `TeamsActivityJsonContext`: (`OMessageEntity`, `SensitiveUsageEntity`, `DefinedTerm`, `ProductInfoEntity`, `StreamInfoEntity`) - Unit tests ### Notes - Not porting `UpdateEntity(IEntity, IEntity`); `AddCitation` does remove + add inline - `Samples.AI/CitationsHandler` not ported - `IMessageEntity` not needed - concrete classes only in 2.1 - `IMessageJsonConverter` replaced by `DeserializeMessageEntity` in EntityList --------- Co-authored-by: Corina Gum <> --- core/samples/TeamsBot/Program.cs | 30 ++ .../Schema/Entities/CitationEntity.cs | 385 ++++++++++++++++++ .../Schema/Entities/Entity.cs | 27 +- .../Schema/TeamsActivityJsonContext.cs | 10 + .../Schema/TeamsChannelData.cs | 12 + .../CitationEntityTests.cs | 380 +++++++++++++++++ 6 files changed, 843 insertions(+), 1 deletion(-) create mode 100644 core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/CitationEntity.cs create mode 100644 core/test/Microsoft.Teams.Bot.Apps.UnitTests/CitationEntityTests.cs diff --git a/core/samples/TeamsBot/Program.cs b/core/samples/TeamsBot/Program.cs index 3bcaa5cd..57ab1a6a 100644 --- a/core/samples/TeamsBot/Program.cs +++ b/core/samples/TeamsBot/Program.cs @@ -63,6 +63,36 @@ [Visit Microsoft](https://www.microsoft.com) await context.SendActivityAsync(markdownMessage, cancellationToken); }); +// Citation handler: matches "citation" (case-insensitive) +teamsApp.OnMessage("(?i)citation", async (context, cancellationToken) => +{ + MessageActivity reply = new("Here is a response with citations [1] [2].") + { + TextFormat = TextFormats.Markdown + }; + + reply.AddCitation(1, new CitationAppearance() + { + Name = "Teams SDK Documentation", + Abstract = "The Teams Bot SDK provides a streamlined way to build bots for Microsoft Teams.", + Url = new Uri("https://github.com/nicoco007/microsoft/teams.net"), + Icon = CitationIcon.Text, + EncodingFormat = EncodingFormats.AdaptiveCard + }); + + reply.AddCitation(2, new CitationAppearance() + { + Name = "Bot Framework Overview", + Abstract = "Build intelligent bots that interact naturally with users on Teams.", + Keywords = ["bot", "framework"] + }); + + reply.AddAIGenerated(); + reply.AddFeedback(); + + await context.SendActivityAsync(reply, cancellationToken); +}); + // Regex-based handler: matches commands starting with "/" Regex commandRegex = Regexes.CommandRegex(); teamsApp.OnMessage(commandRegex, async (context, cancellationToken) => diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/CitationEntity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/CitationEntity.cs new file mode 100644 index 00000000..353f44b1 --- /dev/null +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/CitationEntity.cs @@ -0,0 +1,385 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using System.Text.Json.Serialization; + +namespace Microsoft.Teams.Bot.Apps.Schema; + +/// +/// Extension methods for Activity to handle citations and AI-generated content. +/// +public static class ActivityCitationExtensions +{ + /// + /// Adds a citation to the activity. Creates or updates the root message entity + /// with the specified citation claim. + /// + /// The activity to add the citation to. Cannot be null. + /// The position of the citation in the message text. + /// The citation appearance information. + /// The created CitationEntity that was added to the activity. + public static CitationEntity AddCitation(this TeamsActivity activity, int position, CitationAppearance appearance) + { + ArgumentNullException.ThrowIfNull(activity); + ArgumentNullException.ThrowIfNull(appearance); + + activity.Entities ??= []; + var messageEntity = GetOrCreateRootMessageEntity(activity); + var citationEntity = new CitationEntity(messageEntity); + citationEntity.Citation ??= []; + citationEntity.Citation.Add(new CitationClaim() + { + Position = position, + Appearance = appearance.ToDocument() + }); + + activity.Entities.Remove(messageEntity); + activity.Entities.Add(citationEntity); + activity.Rebase(); + return citationEntity; + } + + /// + /// Adds the AI-generated content label to the activity's root message entity. + /// This method is idempotent — calling it multiple times has the same effect as calling it once. + /// + /// The activity to mark as AI-generated. Cannot be null. + /// The OMessageEntity with the AI-generated label applied. + public static OMessageEntity AddAIGenerated(this TeamsActivity activity) + { + ArgumentNullException.ThrowIfNull(activity); + + var messageEntity = GetOrCreateRootMessageEntity(activity); + messageEntity.AdditionalType ??= []; + + if (!messageEntity.AdditionalType.Contains("AIGeneratedContent")) + { + messageEntity.AdditionalType.Add("AIGeneratedContent"); + } + + activity.Rebase(); + return messageEntity; + } + + /// + /// Enables the feedback loop (thumbs up/down) on the activity's channel data. + /// + /// The activity to enable feedback on. Cannot be null. + /// Whether to enable feedback. Defaults to true. + /// The activity for chaining. + public static TeamsActivity AddFeedback(this TeamsActivity activity, bool value = true) + { + ArgumentNullException.ThrowIfNull(activity); + + activity.ChannelData ??= new TeamsChannelData(); + activity.ChannelData.FeedbackLoopEnabled = value; + return activity; + } + + // Gets or creates the single root-level OMessageEntity on the activity. + private static OMessageEntity GetOrCreateRootMessageEntity(TeamsActivity activity) + { + activity.Entities ??= []; + + var messageEntity = activity.Entities.FirstOrDefault( + e => e.Type == "https://schema.org/Message" && e.OType == "Message" + ) as OMessageEntity; + + if (messageEntity is null) + { + messageEntity = new OMessageEntity(); + activity.Entities.Add(messageEntity); + } + + return messageEntity; + } +} + +/// +/// Citation entity representing a message with citation claims. +/// +public class CitationEntity : OMessageEntity +{ + /// + /// Creates a new instance of . + /// + public CitationEntity() : base() + { + } + + /// + /// Creates a new instance of by copying data from an existing message entity. + /// + /// The message entity to copy from. Cannot be null. + public CitationEntity(OMessageEntity entity) : base() + { + ArgumentNullException.ThrowIfNull(entity); + OType = entity.OType; + OContext = entity.OContext; + Type = entity.Type; + AdditionalType = entity.AdditionalType != null + ? new List(entity.AdditionalType) + : null; + if (entity is CitationEntity citationEntity) + { + Citation = citationEntity.Citation != null + ? new List(citationEntity.Citation) + : null; + } + } + + /// + /// Gets or sets the list of citation claims. + /// + [JsonPropertyName("citation")] + public IList? Citation + { + get => base.Properties.TryGetValue("citation", out object? value) ? value as IList : null; + set => base.Properties["citation"] = value; + } +} + +/// +/// Represents a citation claim with a position and appearance document. +/// +public class CitationClaim +{ + /// + /// Gets or sets the schema.org type. Always "Claim". + /// + [JsonPropertyName("@type")] + public string Type { get; set; } = "Claim"; + + /// + /// Gets or sets the position of the citation in the message text. + /// + [JsonPropertyName("position")] + public required int Position { get; set; } + + /// + /// Gets or sets the appearance document describing the cited source. + /// + [JsonPropertyName("appearance")] + public required CitationAppearanceDocument Appearance { get; set; } +} + +/// +/// Represents the appearance of a cited document. +/// +public class CitationAppearanceDocument +{ + /// + /// Gets or sets the schema.org type. Always "DigitalDocument". + /// + [JsonPropertyName("@type")] + public string Type { get; set; } = "DigitalDocument"; + + /// + /// Gets or sets the name of the document (max length 80). + /// + [JsonPropertyName("name")] + public required string Name { get; set; } + + /// + /// Gets or sets a stringified adaptive card with additional information about the citation. + /// + [JsonPropertyName("text")] + public string? Text { get; set; } + + /// + /// Gets or sets the URL of the document. + /// + [JsonPropertyName("url")] + public Uri? Url { get; set; } + + /// + /// Gets or sets the extract of the referenced content (max length 160). + /// + [JsonPropertyName("abstract")] + public required string Abstract { get; set; } + + /// + /// Gets or sets the encoding format of the text. See for known values. + /// + [JsonPropertyName("encodingFormat")] + public string? EncodingFormat { get; set; } + + /// + /// Gets or sets the citation icon information. + /// + [JsonPropertyName("image")] + public CitationImageObject? Image { get; set; } + + /// + /// Gets or sets the keywords (max length 3, max keyword length 28). + /// + [JsonPropertyName("keywords")] + public IList? Keywords { get; set; } + + /// + /// Gets or sets the sensitivity usage information for the citation. + /// + [JsonPropertyName("usageInfo")] + public SensitiveUsageEntity? UsageInfo { get; set; } +} + +/// +/// Represents an image object used for citation icons. +/// +public class CitationImageObject +{ + /// + /// Gets or sets the schema.org type. Always "ImageObject". + /// + [JsonPropertyName("@type")] + public string Type { get; set; } = "ImageObject"; + + /// + /// Gets or sets the icon name. See for known values. + /// + [JsonPropertyName("name")] + public required string Name { get; set; } +} + +/// +/// Known citation icon names. +/// +public static class CitationIcon +{ + /// Microsoft Word icon. + public const string MicrosoftWord = "Microsoft Word"; + + /// Microsoft Excel icon. + public const string MicrosoftExcel = "Microsoft Excel"; + + /// Microsoft PowerPoint icon. + public const string MicrosoftPowerPoint = "Microsoft PowerPoint"; + + /// Microsoft OneNote icon. + public const string MicrosoftOneNote = "Microsoft OneNote"; + + /// Microsoft SharePoint icon. + public const string MicrosoftSharePoint = "Microsoft SharePoint"; + + /// Microsoft Visio icon. + public const string MicrosoftVisio = "Microsoft Visio"; + + /// Microsoft Loop icon. + public const string MicrosoftLoop = "Microsoft Loop"; + + /// Microsoft Whiteboard icon. + public const string MicrosoftWhiteboard = "Microsoft Whiteboard"; + + /// Adobe Illustrator icon. + public const string AdobeIllustrator = "Adobe Illustrator"; + + /// Adobe Photoshop icon. + public const string AdobePhotoshop = "Adobe Photoshop"; + + /// Adobe InDesign icon. + public const string AdobeInDesign = "Adobe InDesign"; + + /// Adobe Flash icon. + public const string AdobeFlash = "Adobe Flash"; + + /// Sketch icon. + public const string Sketch = "Sketch"; + + /// Source code icon. + public const string SourceCode = "Source Code"; + + /// Image icon. + public const string Image = "Image"; + + /// GIF icon. + public const string Gif = "GIF"; + + /// Video icon. + public const string Video = "Video"; + + /// Sound icon. + public const string Sound = "Sound"; + + /// ZIP icon. + public const string Zip = "ZIP"; + + /// Text icon. + public const string Text = "Text"; + + /// PDF icon. + public const string Pdf = "PDF"; +} + +/// +/// Known encoding format MIME types for citation documents. +/// +public static class EncodingFormats +{ + /// Adaptive card encoding format. + public const string AdaptiveCard = "application/vnd.microsoft.card.adaptive"; +} + +/// +/// Helper class for building citation appearance documents. +/// +public class CitationAppearance +{ + /// + /// Gets or sets the name of the document (max length 80). + /// + public required string Name { get; set; } + + /// + /// Gets or sets a stringified adaptive card with additional information. + /// + public string? Text { get; set; } + + /// + /// Gets or sets the URL of the document. + /// + public Uri? Url { get; set; } + + /// + /// Gets or sets the extract of the referenced content (max length 160). + /// + public required string Abstract { get; set; } + + /// + /// Gets or sets the encoding format of the text. See for known values. + /// + public string? EncodingFormat { get; set; } + + /// + /// Gets or sets the citation icon name. See for known values. + /// + public string? Icon { get; set; } + + /// + /// Gets or sets the keywords (max length 3, max keyword length 28). + /// + public IList? Keywords { get; set; } + + /// + /// Gets or sets the sensitivity usage information. + /// + public SensitiveUsageEntity? UsageInfo { get; set; } + + /// + /// Converts this appearance to a . + /// + /// The appearance document. + public CitationAppearanceDocument ToDocument() + { + return new() + { + Name = Name, + Text = Text, + Url = Url, + Abstract = Abstract, + EncodingFormat = EncodingFormat, + Image = Icon is null ? null : new CitationImageObject() { Name = Icon }, + Keywords = Keywords, + UsageInfo = UsageInfo + }; + } +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs index 0408ea30..b292c28a 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/Entities/Entity.cs @@ -28,6 +28,7 @@ public class EntityList : List { ["type"] = entity.Type }; + foreach (KeyValuePair property in entity.Properties) { jsonObject[property.Key] = property.Value as JsonNode ?? JsonValue.Create(property.Value); @@ -66,7 +67,7 @@ public class EntityList : List { "clientInfo" => item.Deserialize(options), "mention" => item.Deserialize(options), - //"message" or "https://schema.org/Message" => (Entity?)item.Deserialize(options), + "message" or "https://schema.org/Message" => DeserializeMessageEntity(item, options), "ProductInfo" => item.Deserialize(options), "streaminfo" => item.Deserialize(options), _ => null @@ -77,6 +78,30 @@ public class EntityList : List } return entities; } + + /// + /// Deserializes a message entity by checking the @type property to determine the specific type. + /// + /// The JSON node to deserialize. + /// The JSON serializer options. + /// The deserialized entity, or null if deserialization fails. + private static OMessageEntity? DeserializeMessageEntity(JsonNode item, JsonSerializerOptions? options) + { + if (item is JsonObject jsonObject + && jsonObject.TryGetPropertyValue("@type", out JsonNode? oTypeNode) + && oTypeNode is JsonValue oTypeValue + && oTypeValue.GetValue() is string oType) + { + return oType switch + { + "Message" => item.Deserialize(options), + "CreativeWork" => item.Deserialize(options), + _ => item.Deserialize(options) + }; + } + + return item.Deserialize(options); + } } /// diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs index 48e2487b..2f621d27 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsActivityJsonContext.cs @@ -21,6 +21,16 @@ namespace Microsoft.Teams.Bot.Apps.Schema; [JsonSerializable(typeof(EntityList))] [JsonSerializable(typeof(MentionEntity))] [JsonSerializable(typeof(ClientInfoEntity))] +[JsonSerializable(typeof(OMessageEntity))] +[JsonSerializable(typeof(SensitiveUsageEntity))] +[JsonSerializable(typeof(DefinedTerm))] +[JsonSerializable(typeof(ProductInfoEntity))] +[JsonSerializable(typeof(StreamInfoEntity))] +[JsonSerializable(typeof(CitationEntity))] +[JsonSerializable(typeof(CitationClaim))] +[JsonSerializable(typeof(CitationAppearanceDocument))] +[JsonSerializable(typeof(CitationImageObject))] +[JsonSerializable(typeof(CitationAppearance))] [JsonSerializable(typeof(TeamsChannelData))] [JsonSerializable(typeof(ConversationAccount))] [JsonSerializable(typeof(TeamsConversationAccount))] diff --git a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs index 718cd73f..ea5d7d22 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/Schema/TeamsChannelData.cs @@ -124,6 +124,13 @@ public TeamsChannelData(ChannelData? cd) { Source = JsonSerializer.Deserialize(sourceObjJE.GetRawText()); } + + if (cd.Properties.TryGetValue("feedbackLoopEnabled", out object? feedbackObj) + && feedbackObj is JsonElement jeFeedback + && jeFeedback.ValueKind is JsonValueKind.True or JsonValueKind.False) + { + FeedbackLoopEnabled = jeFeedback.GetBoolean(); + } } } @@ -168,4 +175,9 @@ public TeamsChannelData(ChannelData? cd) /// [JsonPropertyName("source")] public TeamsChannelDataSource? Source { get; set; } + /// + /// Gets or sets whether the feedback loop (thumbs up/down) is enabled for the activity. + /// + [JsonPropertyName("feedbackLoopEnabled")] public bool? FeedbackLoopEnabled { get; set; } + } diff --git a/core/test/Microsoft.Teams.Bot.Apps.UnitTests/CitationEntityTests.cs b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/CitationEntityTests.cs new file mode 100644 index 00000000..d83ac00c --- /dev/null +++ b/core/test/Microsoft.Teams.Bot.Apps.UnitTests/CitationEntityTests.cs @@ -0,0 +1,380 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core.Schema; + +namespace Microsoft.Teams.Bot.Apps.UnitTests; + +public class CitationEntityTests +{ + [Fact] + public void AddCitation_CreatesEntityWithClaim() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + + var citation = activity.AddCitation(1, new CitationAppearance + { + Name = "Test Document", + Abstract = "Test abstract content" + }); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + Assert.IsType(activity.Entities[0]); + Assert.NotNull(citation.Citation); + Assert.Single(citation.Citation); + Assert.Equal(1, citation.Citation[0].Position); + Assert.Equal("Test Document", citation.Citation[0].Appearance.Name); + Assert.Equal("Test abstract content", citation.Citation[0].Appearance.Abstract); + } + + [Fact] + public void AddCitation_MultipleCitations_AccumulateOnSameEntity() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + + activity.AddCitation(1, new CitationAppearance + { + Name = "Document One", + Abstract = "First abstract" + }); + + var citation = activity.AddCitation(2, new CitationAppearance + { + Name = "Document Two", + Abstract = "Second abstract" + }); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + Assert.NotNull(citation.Citation); + Assert.Equal(2, citation.Citation.Count); + Assert.Equal(1, citation.Citation[0].Position); + Assert.Equal(2, citation.Citation[1].Position); + Assert.Equal("Document One", citation.Citation[0].Appearance.Name); + Assert.Equal("Document Two", citation.Citation[1].Appearance.Name); + } + + [Fact] + public void AddAIGenerated_SetsAdditionalType() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + + var messageEntity = activity.AddAIGenerated(); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + Assert.IsType(activity.Entities[0]); + Assert.NotNull(messageEntity.AdditionalType); + Assert.Contains("AIGeneratedContent", messageEntity.AdditionalType); + } + + [Fact] + public void AddAIGenerated_CalledTwice_DoesNotDuplicate() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + + activity.AddAIGenerated(); + activity.AddAIGenerated(); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + var messageEntity = activity.Entities[0] as OMessageEntity; + Assert.NotNull(messageEntity?.AdditionalType); + Assert.Single(messageEntity.AdditionalType); + } + + [Fact] + public void AddAIGenerated_ThenAddCitation_PreservesAILabel() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + + activity.AddAIGenerated(); + var citation = activity.AddCitation(1, new CitationAppearance + { + Name = "Test Doc", + Abstract = "Test abstract" + }); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + Assert.IsType(activity.Entities[0]); + Assert.NotNull(citation.AdditionalType); + Assert.Contains("AIGeneratedContent", citation.AdditionalType); + Assert.NotNull(citation.Citation); + Assert.Single(citation.Citation); + } + + [Fact] + public void AddFeedback_SetsFeedbackLoopEnabled() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + + activity.AddFeedback(); + + Assert.NotNull(activity.ChannelData); + Assert.True(activity.ChannelData.FeedbackLoopEnabled); + } + + [Fact] + public void AddCitation_WithAllAppearanceFields_SetsCorrectly() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + + var citation = activity.AddCitation(1, new CitationAppearance + { + Name = "Full Document", + Abstract = "Full abstract", + Text = "{\"type\":\"AdaptiveCard\"}", + Url = new Uri("https://example.com/doc"), + EncodingFormat = EncodingFormats.AdaptiveCard, + Icon = CitationIcon.MicrosoftWord, + Keywords = ["keyword1", "keyword2"], + UsageInfo = new SensitiveUsageEntity { Name = "Confidential" } + }); + + Assert.NotNull(citation.Citation); + var appearance = citation.Citation[0].Appearance; + Assert.Equal("Full Document", appearance.Name); + Assert.Equal("Full abstract", appearance.Abstract); + Assert.Equal("{\"type\":\"AdaptiveCard\"}", appearance.Text); + Assert.Equal(new Uri("https://example.com/doc"), appearance.Url); + Assert.Equal(EncodingFormats.AdaptiveCard, appearance.EncodingFormat); + Assert.NotNull(appearance.Image); + Assert.Equal(CitationIcon.MicrosoftWord, appearance.Image.Name); + Assert.NotNull(appearance.Keywords); + Assert.Equal(2, appearance.Keywords.Count); + Assert.NotNull(appearance.UsageInfo); + Assert.Equal("Confidential", appearance.UsageInfo.Name); + } + + [Fact] + public void CitationEntity_RoundTrip_Serialization() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + + activity.AddAIGenerated(); + activity.AddCitation(1, new CitationAppearance + { + Name = "Test Document", + Abstract = "Test abstract content", + Url = new Uri("https://example.com"), + Icon = CitationIcon.Pdf, + Keywords = ["test", "citation"] + }); + activity.AddFeedback(); + + string json = activity.ToJson(); + + Assert.Contains("\"citation\"", json); + Assert.Contains("Test Document", json); + Assert.Contains("Test abstract content", json); + Assert.Contains("https://example.com", json); + Assert.Contains("AIGeneratedContent", json); + Assert.Contains("Claim", json); + Assert.Contains("DigitalDocument", json); + Assert.Contains("PDF", json); + Assert.Contains("feedbackLoopEnabled", json); + } + + [Fact] + public void CitationEntity_Rebase_SurvivesRoundTrip() + { + TeamsActivity activity = TeamsActivity.FromActivity(new CoreActivity(ActivityType.Message)); + + activity.AddAIGenerated(); + activity.AddCitation(1, new CitationAppearance + { + Name = "Rebase Test Doc", + Abstract = "Rebase test abstract", + Icon = CitationIcon.MicrosoftExcel + }); + + // Verify base CoreActivity.Entities (JsonArray) contains the citation data + CoreActivity coreActivity = activity; + Assert.NotNull(coreActivity.Entities); + Assert.Single(coreActivity.Entities); + + string? entityJson = coreActivity.Entities[0]?.ToJsonString(); + Assert.NotNull(entityJson); + Assert.Contains("citation", entityJson); + Assert.Contains("Rebase Test Doc", entityJson); + Assert.Contains("Rebase test abstract", entityJson); + Assert.Contains("AIGeneratedContent", entityJson); + Assert.Contains("Microsoft Excel", entityJson); + } + + [Fact] + public void Fixture_AdaptiveCardActivity_DeserializesAIGeneratedEntity() + { + string json = """ + { + "type": "message", + "channelId": "msteams", + "entities": [ + { + "type": "https://schema.org/Message", + "@context": "https://schema.org", + "@type": "Message", + "additionalType": [ + "AIGeneratedContent" + ] + } + ] + } + """; + + CoreActivity coreActivity = CoreActivity.FromJsonString(json); + TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + + var entity = activity.Entities[0]; + Assert.Equal("https://schema.org/Message", entity.Type); + Assert.Equal("Message", entity.OType); + + // Should deserialize as CitationEntity (since @type is "Message") + var citationEntity = entity as CitationEntity; + Assert.NotNull(citationEntity); + Assert.NotNull(citationEntity.AdditionalType); + Assert.Contains("AIGeneratedContent", citationEntity.AdditionalType); + } + + [Fact] + public void Fixture_SensitiveUsageEntity_DeserializesByOType() + { + string json = """ + { + "type": "message", + "entities": [ + { + "type": "https://schema.org/Message", + "@context": "https://schema.org", + "@type": "CreativeWork", + "name": "Confidential", + "description": "This is sensitive content" + } + ] + } + """; + + CoreActivity coreActivity = CoreActivity.FromJsonString(json); + TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + + var entity = activity.Entities[0] as SensitiveUsageEntity; + Assert.NotNull(entity); + Assert.Equal("Confidential", entity.Name); + Assert.Equal("This is sensitive content", entity.Description); + } + + [Fact] + public void OMessageEntity_WithUnknownOType_DeserializesAsOMessageEntity() + { + string json = """ + { + "type": "message", + "entities": [ + { + "type": "https://schema.org/Message", + "@context": "https://schema.org", + "@type": "UnknownType" + } + ] + } + """; + + CoreActivity coreActivity = CoreActivity.FromJsonString(json); + TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + + var entity = activity.Entities[0]; + Assert.IsType(entity); + Assert.Equal("UnknownType", entity.OType); + } + + [Fact] + public void Fixture_CitationEntity_DeserializesWithClaims() + { + string json = """ + { + "type": "message", + "entities": [ + { + "type": "https://schema.org/Message", + "@context": "https://schema.org", + "@type": "Message", + "additionalType": ["AIGeneratedContent"], + "citation": [ + { + "@type": "Claim", + "position": 1, + "appearance": { + "@type": "DigitalDocument", + "name": "Test Document", + "abstract": "Test abstract", + "url": "https://example.com/doc", + "encodingFormat": "application/vnd.microsoft.card.adaptive" + } + } + ] + } + ] + } + """; + + CoreActivity coreActivity = CoreActivity.FromJsonString(json); + TeamsActivity activity = TeamsActivity.FromActivity(coreActivity); + + Assert.NotNull(activity.Entities); + Assert.Single(activity.Entities); + + var citationEntity = activity.Entities[0] as CitationEntity; + Assert.NotNull(citationEntity); + Assert.NotNull(citationEntity.AdditionalType); + Assert.Contains("AIGeneratedContent", citationEntity.AdditionalType); + Assert.NotNull(citationEntity.Citation); + Assert.Single(citationEntity.Citation); + Assert.Equal(1, citationEntity.Citation[0].Position); + Assert.Equal("Test Document", citationEntity.Citation[0].Appearance.Name); + Assert.Equal("Test abstract", citationEntity.Citation[0].Appearance.Abstract); + Assert.Equal(EncodingFormats.AdaptiveCard, citationEntity.Citation[0].Appearance.EncodingFormat); + } + + [Fact] + public void CitationEntity_CopyConstructor_PreservesData() + { + var original = new CitationEntity(); + original.AdditionalType = ["AIGeneratedContent"]; + original.Citation = [ + new CitationClaim + { + Position = 1, + Appearance = new CitationAppearanceDocument + { + Name = "Doc", + Abstract = "Abstract" + } + } + ]; + + var copy = new CitationEntity(original); + + Assert.NotNull(copy.AdditionalType); + Assert.Contains("AIGeneratedContent", copy.AdditionalType); + Assert.NotNull(copy.Citation); + Assert.Single(copy.Citation); + Assert.Equal(1, copy.Citation[0].Position); + Assert.Equal("Doc", copy.Citation[0].Appearance.Name); + + // Ensure it's a deep copy (modifying copy doesn't affect original) + copy.AdditionalType.Add("NewType"); + Assert.Single(original.AdditionalType); + } +} From 93598b8373786d3ecce5275774ab4d37840a1177 Mon Sep 17 00:00:00 2001 From: Mehak Bindra Date: Tue, 10 Mar 2026 12:03:44 -0700 Subject: [PATCH 69/69] Add Tabs and Functions support to core (#354) ### New Sample Project: TabApp - Added `TabApp` sample project to the solution and project files, including its backend and frontend components. - Implemented backend logic in `Program.cs` for serving static tab content, handling Teams authentication, and providing server functions such as posting messages to chat. ### Frontend Implementation - Added a React/Vite frontend app with Teams JS SDK and MSAL integration, supporting features like context display, posting to chat, user info lookup, and presence toggling. ### Auth - Added entra token validation and cleaned up jwtExtension --- core/.gitignore | 6 +- core/core.slnx | 1 + core/samples/TabApp/Body.cs | 13 + core/samples/TabApp/Program.cs | 92 + core/samples/TabApp/README.md | 109 + core/samples/TabApp/TabApp.csproj | 18 + core/samples/TabApp/Web/index.html | 12 + core/samples/TabApp/Web/package-lock.json | 1897 +++++++++++++++++ core/samples/TabApp/Web/package.json | 22 + core/samples/TabApp/Web/src/App.css | 161 ++ core/samples/TabApp/Web/src/App.tsx | 159 ++ core/samples/TabApp/Web/src/main.tsx | 10 + core/samples/TabApp/Web/tsconfig.json | 21 + core/samples/TabApp/Web/vite.config.ts | 12 + core/samples/TabApp/appsettings.json | 9 + .../TeamsBotApplication.cs | 1 - .../Hosting/AuthenticationSchemeOptions.cs | 20 - .../Hosting/BotConfig.cs | 24 + .../Hosting/JwtExtensions.cs | 273 +-- 19 files changed, 2658 insertions(+), 202 deletions(-) create mode 100644 core/samples/TabApp/Body.cs create mode 100644 core/samples/TabApp/Program.cs create mode 100644 core/samples/TabApp/README.md create mode 100644 core/samples/TabApp/TabApp.csproj create mode 100644 core/samples/TabApp/Web/index.html create mode 100644 core/samples/TabApp/Web/package-lock.json create mode 100644 core/samples/TabApp/Web/package.json create mode 100644 core/samples/TabApp/Web/src/App.css create mode 100644 core/samples/TabApp/Web/src/App.tsx create mode 100644 core/samples/TabApp/Web/src/main.tsx create mode 100644 core/samples/TabApp/Web/tsconfig.json create mode 100644 core/samples/TabApp/Web/vite.config.ts create mode 100644 core/samples/TabApp/appsettings.json delete mode 100644 core/src/Microsoft.Teams.Bot.Core/Hosting/AuthenticationSchemeOptions.cs diff --git a/core/.gitignore b/core/.gitignore index 1fe9a12f..18b6c1e3 100644 --- a/core/.gitignore +++ b/core/.gitignore @@ -1,3 +1,7 @@ launchSettings.json appsettings.Development.json -*.runsettings \ No newline at end of file +*.runsettings + +# Web build output and dependencies +**/Web/bin/ +**/Web/node_modules/ \ No newline at end of file diff --git a/core/core.slnx b/core/core.slnx index 4762e584..96a54703 100644 --- a/core/core.slnx +++ b/core/core.slnx @@ -19,6 +19,7 @@ + diff --git a/core/samples/TabApp/Body.cs b/core/samples/TabApp/Body.cs new file mode 100644 index 00000000..c36c6cde --- /dev/null +++ b/core/samples/TabApp/Body.cs @@ -0,0 +1,13 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +namespace TabApp; + +public class PostToChatBody +{ + public required string Message { get; set; } + public string? ChatId { get; set; } + public string? ChannelId { get; set; } +} + +public record PostToChatResult(bool Ok); diff --git a/core/samples/TabApp/Program.cs b/core/samples/TabApp/Program.cs new file mode 100644 index 00000000..820b7c1e --- /dev/null +++ b/core/samples/TabApp/Program.cs @@ -0,0 +1,92 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT License. + +using Microsoft.AspNetCore.StaticFiles; +using Microsoft.Extensions.Caching.Memory; +using Microsoft.Identity.Web; +using Microsoft.Teams.Bot.Apps.Schema; +using Microsoft.Teams.Bot.Core; +using Microsoft.Teams.Bot.Core.Hosting; +using TabApp; + +WebApplicationBuilder builder = WebApplication.CreateSlimBuilder(args); +builder.Services.AddBotAuthorization(); +builder.Services.AddConversationClient(); +WebApplication app = builder.Build(); + +app.UseAuthentication(); +app.UseAuthorization(); + +// ==================== TABS ==================== + +var contentTypes = new FileExtensionContentTypeProvider(); +app.MapGet("/tabs/test/{*path}", (string? path) => +{ + var root = Path.Combine(Directory.GetCurrentDirectory(), "Web", "bin"); + var full = Path.Combine(root, path ?? "index.html"); + contentTypes.TryGetContentType(full, out var ct); + return Results.File(File.OpenRead(full), ct ?? "text/html"); +}); + +// ==================== SERVER FUNCTIONS ==================== + +app.MapPost("/functions/post-to-chat", async ( + PostToChatBody body, + HttpContext httpCtx, + ConversationClient conversations, + IConfiguration config, + IMemoryCache cache, + ILogger logger, + CancellationToken ct) => +{ + logger.LogInformation("post-to-chat called"); + + var serviceUrl = new Uri("https://smba.trafficmanager.net/teams"); + string conversationId; + + if (body.ChatId is not null) + { + // group chat or 1:1 chat tab — chat ID is the conversation ID + conversationId = body.ChatId; + } + else if (body.ChannelId is not null) + { + // channel tab — post to the channel directly + conversationId = body.ChannelId; + } + else + { + // personal tab — create or reuse a 1:1 conversation + string userId = httpCtx.User.GetObjectId() ?? throw new InvalidOperationException("User object ID claim not found."); + + if (!cache.TryGetValue($"conv:{userId}", out string? cached)) + { + string botId = config["AzureAd:ClientId"] ?? throw new InvalidOperationException("Bot client ID not configured."); + string tenantId = httpCtx.User.GetTenantId() ?? throw new InvalidOperationException("Tenant ID claim not found."); + + CreateConversationResponse res = await conversations.CreateConversationAsync(new ConversationParameters + { + IsGroup = false, + TenantId = tenantId, + Members = [new TeamsConversationAccount { Id = userId }] + }, serviceUrl, cancellationToken: ct); + + cached = res.Id ?? throw new InvalidOperationException("CreateConversation returned no ID."); + cache.Set($"conv:{userId}", cached); + } + + conversationId = cached!; + } + + TeamsActivity activity = TeamsActivity.CreateBuilder() + .WithType(TeamsActivityType.Message) + .WithText("Hello from the tab!") + .WithServiceUrl(serviceUrl) + .WithConversation(new TeamsConversation { Id = conversationId! }) + .Build(); + await conversations.SendActivityAsync(activity, cancellationToken: ct); + + return Results.Json(new PostToChatResult(Ok: true)); +}).RequireAuthorization(); + +app.Run(); diff --git a/core/samples/TabApp/README.md b/core/samples/TabApp/README.md new file mode 100644 index 00000000..30b6ba7b --- /dev/null +++ b/core/samples/TabApp/README.md @@ -0,0 +1,109 @@ +# TabApp + +A sample demonstrating a React/Vite tab served by the bot, with server functions and client-side Graph calls. + +| Feature | How it works | +|---|---| +| **Static tab** | Bot serves `Web/bin` via `app.WithTab("test", "./Web/bin")` at `/tabs/test` | +| **Teams Context** | Reads the raw Teams context via the Teams JS SDK | +| **Post to Chat** | Tab calls `POST /functions/post-to-chat` → bot sends a proactive message | +| **Who Am I** | Acquires a Graph token via MSAL and calls `GET /me` | +| **Toggle Presence** | Acquires a Graph token with `Presence.ReadWrite` and calls `POST /me/presence/setUserPreferredPresence` | + +--- + +## Azure App Registration + +### 1. Application ID URI + +Under **Expose an API → Application ID URI**, set it to: + +``` +api://{YOUR_CLIENT_ID} +``` + +Then add a scope named `access_as_user` and pre-authorize the Teams client IDs: + +| Client ID | App | +|---|---| +| `1fec8e78-bce4-4aaf-ab1b-5451cc387264` | Teams desktop / mobile | +| `5e3ce6c0-2b1f-4285-8d4b-75ee78787346` | Teams web | + +### 2. Redirect URI + +Under **Authentication → Add a platform → Single-page application**, add: + +``` +https://{YOUR_DOMAIN}/tabs/test +``` +and +``` +brk-multihub://{your_domain} +``` + +### 3. API permissions + +Under **API permissions → Add a permission → Microsoft Graph → Delegated**: + +| Permission | Required for | +|---|---| +| `User.Read` | Who Am I | +| `Presence.ReadWrite` | Toggle Presence | + +--- + +## Manifest + +**`webApplicationInfo`** — required for SSO (`authentication.getAuthToken()` and MSAL silent auth): + +```json +"webApplicationInfo": { + "id": "{YOUR_CLIENT_ID}", + "resource": "api://{YOUR_CLIENT_ID}" +} +``` + +**`staticTabs`**: + +```json +"staticTabs": [ + { + "entityId": "tab", + "name": "Tab", + "contentUrl": "https://{YOUR_DOMAIN}/tabs/test", + "websiteUrl": "https://{YOUR_DOMAIN}/tabs/test", + "scopes": ["personal"] + } +] +``` + +--- + +## Configuration + +**`launchSettings.json`** (or environment variables): + +```json +"AzureAD__TenantId": "{YOUR_TENANT_ID}", +"AzureAD__ClientId": "{YOUR_CLIENT_ID}", +"AzureAD__ClientCredentials__0__SourceType": "ClientSecret", +"AzureAd__ClientCredentials__0__ClientSecret": "{YOUR_CLIENT_SECRET}" +``` + +**`Web/.env`**: + +``` +VITE_CLIENT_ID={YOUR_CLIENT_ID} +``` + +--- + +## Build & Run + +```bash +# Build the React app +cd Web && npm install && npm run build + +# Run the bot +dotnet run +``` diff --git a/core/samples/TabApp/TabApp.csproj b/core/samples/TabApp/TabApp.csproj new file mode 100644 index 00000000..05793d5c --- /dev/null +++ b/core/samples/TabApp/TabApp.csproj @@ -0,0 +1,18 @@ + + + + net10.0 + enable + enable + + + + + + + + + + + + diff --git a/core/samples/TabApp/Web/index.html b/core/samples/TabApp/Web/index.html new file mode 100644 index 00000000..192d27c2 --- /dev/null +++ b/core/samples/TabApp/Web/index.html @@ -0,0 +1,12 @@ + + + + + + Teams Tab + + +
+ + + diff --git a/core/samples/TabApp/Web/package-lock.json b/core/samples/TabApp/Web/package-lock.json new file mode 100644 index 00000000..4a47acc8 --- /dev/null +++ b/core/samples/TabApp/Web/package-lock.json @@ -0,0 +1,1897 @@ +{ + "name": "tabsapp-web", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "tabsapp-web", + "version": "1.0.0", + "dependencies": { + "@azure/msal-browser": "^3.0.0", + "@microsoft/teams-js": "^2.32.0", + "react": "^18.3.1", + "react-dom": "^18.3.1" + }, + "devDependencies": { + "@types/react": "^18.3.12", + "@types/react-dom": "^18.3.1", + "@vitejs/plugin-react": "^4.3.3", + "typescript": "^5.6.3", + "vite": "^6.0.3" + } + }, + "node_modules/@azure/msal-browser": { + "version": "3.30.0", + "resolved": "https://registry.npmjs.org/@azure/msal-browser/-/msal-browser-3.30.0.tgz", + "integrity": "sha512-I0XlIGVdM4E9kYP5eTjgW8fgATdzwxJvQ6bm2PNiHaZhEuUz47NYw1xHthC9R+lXz4i9zbShS0VdLyxd7n0GGA==", + "license": "MIT", + "dependencies": { + "@azure/msal-common": "14.16.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/@azure/msal-common": { + "version": "14.16.1", + "resolved": "https://registry.npmjs.org/@azure/msal-common/-/msal-common-14.16.1.tgz", + "integrity": "sha512-nyxsA6NA4SVKh5YyRpbSXiMr7oQbwark7JU9LMeg6tJYTSPyAGkdx61wPT4gyxZfxlSxMMEyAsWaubBlNyIa1w==", + "license": "MIT", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.28.5", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/compat-data": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.0.tgz", + "integrity": "sha512-T1NCJqT/j9+cn8fvkt7jtwbLBfLC/1y1c7NtCeXFRgzGTsafi68MRv8yzkYSapBnFA6L3U2VSc02ciDzoAJhJg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/core": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz", + "integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helpers": "^7.28.6", + "@babel/parser": "^7.29.0", + "@babel/template": "^7.28.6", + "@babel/traverse": "^7.29.0", + "@babel/types": "^7.29.0", + "@jridgewell/remapping": "^2.3.5", + "convert-source-map": "^2.0.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "node_modules/@babel/generator": { + "version": "7.29.1", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.1.tgz", + "integrity": "sha512-qsaF+9Qcm2Qv8SRIMMscAvG4O3lJ0F1GuMo5HR/Bp02LopNgnZBC/EkbevHFeGs4ls/oPz9v+Bsmzbkbe+0dUw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.29.0", + "@babel/types": "^7.29.0", + "@jridgewell/gen-mapping": "^0.3.12", + "@jridgewell/trace-mapping": "^0.3.28", + "jsesc": "^3.0.2" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.28.6.tgz", + "integrity": "sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.28.6", + "@babel/helper-validator-option": "^7.27.1", + "browserslist": "^4.24.0", + "lru-cache": "^5.1.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-globals": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.28.0.tgz", + "integrity": "sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-imports": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.28.6.tgz", + "integrity": "sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-transforms": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.28.6.tgz", + "integrity": "sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-validator-identifier": "^7.28.5", + "@babel/traverse": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-plugin-utils": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.28.6.tgz", + "integrity": "sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", + "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-option": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz", + "integrity": "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helpers": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.28.6.tgz", + "integrity": "sha512-xOBvwq86HHdB7WUDTfKfT/Vuxh7gElQ+Sfti2Cy6yIWNW05P8iUslOVcZ4/sKbE+/jQaukQAdz/gf3724kYdqw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/template": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.0.tgz", + "integrity": "sha512-IyDgFV5GeDUVX4YdF/3CPULtVGSXXMLh1xVIgdCgxApktqnQV0r7/8Nqthg+8YLGaAtdyIlo2qIdZrbCv4+7ww==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.29.0" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx-self": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-self/-/plugin-transform-react-jsx-self-7.27.1.tgz", + "integrity": "sha512-6UzkCs+ejGdZ5mFFC/OCUrv028ab2fp1znZmCZjAOBKiBK2jXD1O+BPSfX8X2qjJ75fZBMSnQn3Rq2mrBJK2mw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx-source": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-source/-/plugin-transform-react-jsx-source-7.27.1.tgz", + "integrity": "sha512-zbwoTsBruTeKB9hSq73ha66iFeJHuaFkUbwvqElnygoNbj/jHRsSeokowZFN3CZ64IvEqcmmkVe89OPXc7ldAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/template": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.28.6.tgz", + "integrity": "sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.28.6", + "@babel/parser": "^7.28.6", + "@babel/types": "^7.28.6" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.0.tgz", + "integrity": "sha512-4HPiQr0X7+waHfyXPZpWPfWL/J7dcN1mx9gL6WdQVMbPnF3+ZhSMs8tCxN7oHddJE9fhNE7+lxdnlyemKfJRuA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", + "@babel/helper-globals": "^7.28.0", + "@babel/parser": "^7.29.0", + "@babel/template": "^7.28.6", + "@babel/types": "^7.29.0", + "debug": "^4.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.0.tgz", + "integrity": "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.27.1", + "@babel/helper-validator-identifier": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.12.tgz", + "integrity": "sha512-Hhmwd6CInZ3dwpuGTF8fJG6yoWmsToE+vYgD4nytZVxcu1ulHpUQRAB1UJ8+N1Am3Mz4+xOByoQoSZf4D+CpkA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.12.tgz", + "integrity": "sha512-VJ+sKvNA/GE7Ccacc9Cha7bpS8nyzVv0jdVgwNDaR4gDMC/2TTRc33Ip8qrNYUcpkOHUT5OZ0bUcNNVZQ9RLlg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.12.tgz", + "integrity": "sha512-6AAmLG7zwD1Z159jCKPvAxZd4y/VTO0VkprYy+3N2FtJ8+BQWFXU+OxARIwA46c5tdD9SsKGZ/1ocqBS/gAKHg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.12.tgz", + "integrity": "sha512-5jbb+2hhDHx5phYR2By8GTWEzn6I9UqR11Kwf22iKbNpYrsmRB18aX/9ivc5cabcUiAT/wM+YIZ6SG9QO6a8kg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.12.tgz", + "integrity": "sha512-N3zl+lxHCifgIlcMUP5016ESkeQjLj/959RxxNYIthIg+CQHInujFuXeWbWMgnTo4cp5XVHqFPmpyu9J65C1Yg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.12.tgz", + "integrity": "sha512-HQ9ka4Kx21qHXwtlTUVbKJOAnmG1ipXhdWTmNXiPzPfWKpXqASVcWdnf2bnL73wgjNrFXAa3yYvBSd9pzfEIpA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.12.tgz", + "integrity": "sha512-gA0Bx759+7Jve03K1S0vkOu5Lg/85dou3EseOGUes8flVOGxbhDDh/iZaoek11Y8mtyKPGF3vP8XhnkDEAmzeg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.12.tgz", + "integrity": "sha512-TGbO26Yw2xsHzxtbVFGEXBFH0FRAP7gtcPE7P5yP7wGy7cXK2oO7RyOhL5NLiqTlBh47XhmIUXuGciXEqYFfBQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.12.tgz", + "integrity": "sha512-lPDGyC1JPDou8kGcywY0YILzWlhhnRjdof3UlcoqYmS9El818LLfJJc3PXXgZHrHCAKs/Z2SeZtDJr5MrkxtOw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.12.tgz", + "integrity": "sha512-8bwX7a8FghIgrupcxb4aUmYDLp8pX06rGh5HqDT7bB+8Rdells6mHvrFHHW2JAOPZUbnjUpKTLg6ECyzvas2AQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.12.tgz", + "integrity": "sha512-0y9KrdVnbMM2/vG8KfU0byhUN+EFCny9+8g202gYqSSVMonbsCfLjUO+rCci7pM0WBEtz+oK/PIwHkzxkyharA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.12.tgz", + "integrity": "sha512-h///Lr5a9rib/v1GGqXVGzjL4TMvVTv+s1DPoxQdz7l/AYv6LDSxdIwzxkrPW438oUXiDtwM10o9PmwS/6Z0Ng==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.12.tgz", + "integrity": "sha512-iyRrM1Pzy9GFMDLsXn1iHUm18nhKnNMWscjmp4+hpafcZjrr2WbT//d20xaGljXDBYHqRcl8HnxbX6uaA/eGVw==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.12.tgz", + "integrity": "sha512-9meM/lRXxMi5PSUqEXRCtVjEZBGwB7P/D4yT8UG/mwIdze2aV4Vo6U5gD3+RsoHXKkHCfSxZKzmDssVlRj1QQA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.12.tgz", + "integrity": "sha512-Zr7KR4hgKUpWAwb1f3o5ygT04MzqVrGEGXGLnj15YQDJErYu/BGg+wmFlIDOdJp0PmB0lLvxFIOXZgFRrdjR0w==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.12.tgz", + "integrity": "sha512-MsKncOcgTNvdtiISc/jZs/Zf8d0cl/t3gYWX8J9ubBnVOwlk65UIEEvgBORTiljloIWnBzLs4qhzPkJcitIzIg==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.12.tgz", + "integrity": "sha512-uqZMTLr/zR/ed4jIGnwSLkaHmPjOjJvnm6TVVitAa08SLS9Z0VM8wIRx7gWbJB5/J54YuIMInDquWyYvQLZkgw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.12.tgz", + "integrity": "sha512-xXwcTq4GhRM7J9A8Gv5boanHhRa/Q9KLVmcyXHCTaM4wKfIpWkdXiMog/KsnxzJ0A1+nD+zoecuzqPmCRyBGjg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.12.tgz", + "integrity": "sha512-Ld5pTlzPy3YwGec4OuHh1aCVCRvOXdH8DgRjfDy/oumVovmuSzWfnSJg+VtakB9Cm0gxNO9BzWkj6mtO1FMXkQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.12.tgz", + "integrity": "sha512-fF96T6KsBo/pkQI950FARU9apGNTSlZGsv1jZBAlcLL1MLjLNIWPBkj5NlSz8aAzYKg+eNqknrUJ24QBybeR5A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.12.tgz", + "integrity": "sha512-MZyXUkZHjQxUvzK7rN8DJ3SRmrVrke8ZyRusHlP+kuwqTcfWLyqMOE3sScPPyeIXN/mDJIfGXvcMqCgYKekoQw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.12.tgz", + "integrity": "sha512-rm0YWsqUSRrjncSXGA7Zv78Nbnw4XL6/dzr20cyrQf7ZmRcsovpcRBdhD43Nuk3y7XIoW2OxMVvwuRvk9XdASg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.12.tgz", + "integrity": "sha512-3wGSCDyuTHQUzt0nV7bocDy72r2lI33QL3gkDNGkod22EsYl04sMf0qLb8luNKTOmgF/eDEDP5BFNwoBKH441w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.12.tgz", + "integrity": "sha512-rMmLrur64A7+DKlnSuwqUdRKyd3UE7oPJZmnljqEptesKM8wx9J8gx5u0+9Pq0fQQW8vqeKebwNXdfOyP+8Bsg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.12.tgz", + "integrity": "sha512-HkqnmmBoCbCwxUKKNPBixiWDGCpQGVsrQfJoVGYLPT41XWF8lHuE5N6WhVia2n4o5QK5M4tYr21827fNhi4byQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.12.tgz", + "integrity": "sha512-alJC0uCZpTFrSL0CCDjcgleBXPnCrEAhTBILpeAp7M/OFgoqtAetfBzX0xM00MUsVVPpVjlPuMbREqnZCXaTnA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.13", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", + "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/remapping": { + "version": "2.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/remapping/-/remapping-2.3.5.tgz", + "integrity": "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.31", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", + "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@microsoft/teams-js": { + "version": "2.48.1", + "resolved": "https://registry.npmjs.org/@microsoft/teams-js/-/teams-js-2.48.1.tgz", + "integrity": "sha512-zL+DzftBSfLnC2r8MK3DdzQBxsbCQcxvHpTO+AkSpxNQw+UD/bpEA1mzhs2r3fqjocjlOLWsSjY8yveNLPUEEA==", + "license": "MIT", + "dependencies": { + "base64-js": "^1.3.1", + "debug": "^4.3.3" + } + }, + "node_modules/@rolldown/pluginutils": { + "version": "1.0.0-beta.27", + "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-beta.27.tgz", + "integrity": "sha512-+d0F4MKMCbeVUJwG96uQ4SgAznZNSq93I3V+9NHA4OpvqG8mRCpGdKmK8l/dl02h2CCDHwW2FqilnTyDcAnqjA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.59.0.tgz", + "integrity": "sha512-upnNBkA6ZH2VKGcBj9Fyl9IGNPULcjXRlg0LLeaioQWueH30p6IXtJEbKAgvyv+mJaMxSm1l6xwDXYjpEMiLMg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.59.0.tgz", + "integrity": "sha512-hZ+Zxj3SySm4A/DylsDKZAeVg0mvi++0PYVceVyX7hemkw7OreKdCvW2oQ3T1FMZvCaQXqOTHb8qmBShoqk69Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.59.0.tgz", + "integrity": "sha512-W2Psnbh1J8ZJw0xKAd8zdNgF9HRLkdWwwdWqubSVk0pUuQkoHnv7rx4GiF9rT4t5DIZGAsConRE3AxCdJ4m8rg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.59.0.tgz", + "integrity": "sha512-ZW2KkwlS4lwTv7ZVsYDiARfFCnSGhzYPdiOU4IM2fDbL+QGlyAbjgSFuqNRbSthybLbIJ915UtZBtmuLrQAT/w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.59.0.tgz", + "integrity": "sha512-EsKaJ5ytAu9jI3lonzn3BgG8iRBjV4LxZexygcQbpiU0wU0ATxhNVEpXKfUa0pS05gTcSDMKpn3Sx+QB9RlTTA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.59.0.tgz", + "integrity": "sha512-d3DuZi2KzTMjImrxoHIAODUZYoUUMsuUiY4SRRcJy6NJoZ6iIqWnJu9IScV9jXysyGMVuW+KNzZvBLOcpdl3Vg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.59.0.tgz", + "integrity": "sha512-t4ONHboXi/3E0rT6OZl1pKbl2Vgxf9vJfWgmUoCEVQVxhW6Cw/c8I6hbbu7DAvgp82RKiH7TpLwxnJeKv2pbsw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.59.0.tgz", + "integrity": "sha512-CikFT7aYPA2ufMD086cVORBYGHffBo4K8MQ4uPS/ZnY54GKj36i196u8U+aDVT2LX4eSMbyHtyOh7D7Zvk2VvA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.59.0.tgz", + "integrity": "sha512-jYgUGk5aLd1nUb1CtQ8E+t5JhLc9x5WdBKew9ZgAXg7DBk0ZHErLHdXM24rfX+bKrFe+Xp5YuJo54I5HFjGDAA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.59.0.tgz", + "integrity": "sha512-peZRVEdnFWZ5Bh2KeumKG9ty7aCXzzEsHShOZEFiCQlDEepP1dpUl/SrUNXNg13UmZl+gzVDPsiCwnV1uI0RUA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.59.0.tgz", + "integrity": "sha512-gbUSW/97f7+r4gHy3Jlup8zDG190AuodsWnNiXErp9mT90iCy9NKKU0Xwx5k8VlRAIV2uU9CsMnEFg/xXaOfXg==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.59.0.tgz", + "integrity": "sha512-yTRONe79E+o0FWFijasoTjtzG9EBedFXJMl888NBEDCDV9I2wGbFFfJQQe63OijbFCUZqxpHz1GzpbtSFikJ4Q==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.59.0.tgz", + "integrity": "sha512-sw1o3tfyk12k3OEpRddF68a1unZ5VCN7zoTNtSn2KndUE+ea3m3ROOKRCZxEpmT9nsGnogpFP9x6mnLTCaoLkA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.59.0.tgz", + "integrity": "sha512-+2kLtQ4xT3AiIxkzFVFXfsmlZiG5FXYW7ZyIIvGA7Bdeuh9Z0aN4hVyXS/G1E9bTP/vqszNIN/pUKCk/BTHsKA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.59.0.tgz", + "integrity": "sha512-NDYMpsXYJJaj+I7UdwIuHHNxXZ/b/N2hR15NyH3m2qAtb/hHPA4g4SuuvrdxetTdndfj9b1WOmy73kcPRoERUg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.59.0.tgz", + "integrity": "sha512-nLckB8WOqHIf1bhymk+oHxvM9D3tyPndZH8i8+35p/1YiVoVswPid2yLzgX7ZJP0KQvnkhM4H6QZ5m0LzbyIAg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.59.0.tgz", + "integrity": "sha512-oF87Ie3uAIvORFBpwnCvUzdeYUqi2wY6jRFWJAy1qus/udHFYIkplYRW+wo+GRUP4sKzYdmE1Y3+rY5Gc4ZO+w==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.59.0.tgz", + "integrity": "sha512-3AHmtQq/ppNuUspKAlvA8HtLybkDflkMuLK4DPo77DfthRb71V84/c4MlWJXixZz4uruIH4uaa07IqoAkG64fg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.59.0.tgz", + "integrity": "sha512-2UdiwS/9cTAx7qIUZB/fWtToJwvt0Vbo0zmnYt7ED35KPg13Q0ym1g442THLC7VyI6JfYTP4PiSOWyoMdV2/xg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.59.0.tgz", + "integrity": "sha512-M3bLRAVk6GOwFlPTIxVBSYKUaqfLrn8l0psKinkCFxl4lQvOSz8ZrKDz2gxcBwHFpci0B6rttydI4IpS4IS/jQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.59.0.tgz", + "integrity": "sha512-tt9KBJqaqp5i5HUZzoafHZX8b5Q2Fe7UjYERADll83O4fGqJ49O1FsL6LpdzVFQcpwvnyd0i+K/VSwu/o/nWlA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.59.0.tgz", + "integrity": "sha512-V5B6mG7OrGTwnxaNUzZTDTjDS7F75PO1ae6MJYdiMu60sq0CqN5CVeVsbhPxalupvTX8gXVSU9gq+Rx1/hvu6A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.59.0.tgz", + "integrity": "sha512-UKFMHPuM9R0iBegwzKF4y0C4J9u8C6MEJgFuXTBerMk7EJ92GFVFYBfOZaSGLu6COf7FxpQNqhNS4c4icUPqxA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.59.0.tgz", + "integrity": "sha512-laBkYlSS1n2L8fSo1thDNGrCTQMmxjYY5G0WFWjFFYZkKPjsMBsgJfGf4TLxXrF6RyhI60L8TMOjBMvXiTcxeA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.59.0.tgz", + "integrity": "sha512-2HRCml6OztYXyJXAvdDXPKcawukWY2GpR5/nxKp4iBgiO3wcoEGkAaqctIbZcNB6KlUQBIqt8VYkNSj2397EfA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@types/babel__core": { + "version": "7.20.5", + "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", + "integrity": "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.20.7", + "@babel/types": "^7.20.7", + "@types/babel__generator": "*", + "@types/babel__template": "*", + "@types/babel__traverse": "*" + } + }, + "node_modules/@types/babel__generator": { + "version": "7.27.0", + "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.27.0.tgz", + "integrity": "sha512-ufFd2Xi92OAVPYsy+P4n7/U7e68fex0+Ee8gSG9KX7eo084CWiQ4sdxktvdl0bOPupXtVJPY19zk6EwWqUQ8lg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__template": { + "version": "7.4.4", + "resolved": "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.4.tgz", + "integrity": "sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.1.0", + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__traverse": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.28.0.tgz", + "integrity": "sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.28.2" + } + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/prop-types": { + "version": "15.7.15", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.15.tgz", + "integrity": "sha512-F6bEyamV9jKGAFBEmlQnesRPGOQqS2+Uwi0Em15xenOxHaf2hv6L8YCVn3rPdPJOiJfPiCnLIRyvwVaqMY3MIw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/react": { + "version": "18.3.28", + "resolved": "https://registry.npmjs.org/@types/react/-/react-18.3.28.tgz", + "integrity": "sha512-z9VXpC7MWrhfWipitjNdgCauoMLRdIILQsAEV+ZesIzBq/oUlxk0m3ApZuMFCXdnS4U7KrI+l3WRUEGQ8K1QKw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/prop-types": "*", + "csstype": "^3.2.2" + } + }, + "node_modules/@types/react-dom": { + "version": "18.3.7", + "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-18.3.7.tgz", + "integrity": "sha512-MEe3UeoENYVFXzoXEWsvcpg6ZvlrFNlOQ7EOsvhI3CfAXwzPfO8Qwuxd40nepsYKqyyVQnTdEfv68q91yLcKrQ==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "@types/react": "^18.0.0" + } + }, + "node_modules/@vitejs/plugin-react": { + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/@vitejs/plugin-react/-/plugin-react-4.7.0.tgz", + "integrity": "sha512-gUu9hwfWvvEDBBmgtAowQCojwZmJ5mcLn3aufeCsitijs3+f2NsrPtlAWIR6OPiqljl96GVCUbLe0HyqIpVaoA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.28.0", + "@babel/plugin-transform-react-jsx-self": "^7.27.1", + "@babel/plugin-transform-react-jsx-source": "^7.27.1", + "@rolldown/pluginutils": "1.0.0-beta.27", + "@types/babel__core": "^7.20.5", + "react-refresh": "^0.17.0" + }, + "engines": { + "node": "^14.18.0 || >=16.0.0" + }, + "peerDependencies": { + "vite": "^4.2.0 || ^5.0.0 || ^6.0.0 || ^7.0.0" + } + }, + "node_modules/base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/baseline-browser-mapping": { + "version": "2.10.0", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.0.tgz", + "integrity": "sha512-lIyg0szRfYbiy67j9KN8IyeD7q7hcmqnJ1ddWmNt19ItGpNN64mnllmxUNFIOdOm6by97jlL6wfpTTJrmnjWAA==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "baseline-browser-mapping": "dist/cli.cjs" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/browserslist": { + "version": "4.28.1", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.1.tgz", + "integrity": "sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "baseline-browser-mapping": "^2.9.0", + "caniuse-lite": "^1.0.30001759", + "electron-to-chromium": "^1.5.263", + "node-releases": "^2.0.27", + "update-browserslist-db": "^1.2.0" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001774", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001774.tgz", + "integrity": "sha512-DDdwPGz99nmIEv216hKSgLD+D4ikHQHjBC/seF98N9CPqRX4M5mSxT9eTV6oyisnJcuzxtZy4n17yKKQYmYQOA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "CC-BY-4.0" + }, + "node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "dev": true, + "license": "MIT" + }, + "node_modules/csstype": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", + "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/electron-to-chromium": { + "version": "1.5.302", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.302.tgz", + "integrity": "sha512-sM6HAN2LyK82IyPBpznDRqlTQAtuSaO+ShzFiWTvoMJLHyZ+Y39r8VMfHzwbU8MVBzQ4Wdn85+wlZl2TLGIlwg==", + "dev": true, + "license": "ISC" + }, + "node_modules/esbuild": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.12.tgz", + "integrity": "sha512-bbPBYYrtZbkt6Os6FiTLCTFxvq4tt3JKall1vRwshA3fdVztsLAatFaZobhkBC8/BrPetoa0oksYoKXoG4ryJg==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.25.12", + "@esbuild/android-arm": "0.25.12", + "@esbuild/android-arm64": "0.25.12", + "@esbuild/android-x64": "0.25.12", + "@esbuild/darwin-arm64": "0.25.12", + "@esbuild/darwin-x64": "0.25.12", + "@esbuild/freebsd-arm64": "0.25.12", + "@esbuild/freebsd-x64": "0.25.12", + "@esbuild/linux-arm": "0.25.12", + "@esbuild/linux-arm64": "0.25.12", + "@esbuild/linux-ia32": "0.25.12", + "@esbuild/linux-loong64": "0.25.12", + "@esbuild/linux-mips64el": "0.25.12", + "@esbuild/linux-ppc64": "0.25.12", + "@esbuild/linux-riscv64": "0.25.12", + "@esbuild/linux-s390x": "0.25.12", + "@esbuild/linux-x64": "0.25.12", + "@esbuild/netbsd-arm64": "0.25.12", + "@esbuild/netbsd-x64": "0.25.12", + "@esbuild/openbsd-arm64": "0.25.12", + "@esbuild/openbsd-x64": "0.25.12", + "@esbuild/openharmony-arm64": "0.25.12", + "@esbuild/sunos-x64": "0.25.12", + "@esbuild/win32-arm64": "0.25.12", + "@esbuild/win32-ia32": "0.25.12", + "@esbuild/win32-x64": "0.25.12" + } + }, + "node_modules/escalade": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "license": "MIT" + }, + "node_modules/jsesc": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz", + "integrity": "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==", + "dev": true, + "license": "MIT", + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/json5": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "dev": true, + "license": "MIT", + "bin": { + "json5": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "license": "MIT", + "dependencies": { + "js-tokens": "^3.0.0 || ^4.0.0" + }, + "bin": { + "loose-envify": "cli.js" + } + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "license": "ISC", + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/node-releases": { + "version": "2.0.27", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.27.tgz", + "integrity": "sha512-nmh3lCkYZ3grZvqcCH+fjmQ7X+H0OeZgP40OierEaAptX4XofMh5kwNbWh7lBduUzCcV/8kZ+NDLCwm2iorIlA==", + "dev": true, + "license": "MIT" + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/postcss": { + "version": "8.5.6", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", + "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/react": { + "version": "18.3.1", + "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz", + "integrity": "sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==", + "license": "MIT", + "dependencies": { + "loose-envify": "^1.1.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/react-dom": { + "version": "18.3.1", + "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz", + "integrity": "sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==", + "license": "MIT", + "dependencies": { + "loose-envify": "^1.1.0", + "scheduler": "^0.23.2" + }, + "peerDependencies": { + "react": "^18.3.1" + } + }, + "node_modules/react-refresh": { + "version": "0.17.0", + "resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.17.0.tgz", + "integrity": "sha512-z6F7K9bV85EfseRCp2bzrpyQ0Gkw1uLoCel9XBVWPg/TjRj94SkJzUTGfOa4bs7iJvBWtQG0Wq7wnI0syw3EBQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/rollup": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.59.0.tgz", + "integrity": "sha512-2oMpl67a3zCH9H79LeMcbDhXW/UmWG/y2zuqnF2jQq5uq9TbM9TVyXvA4+t+ne2IIkBdrLpAaRQAvo7YI/Yyeg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.59.0", + "@rollup/rollup-android-arm64": "4.59.0", + "@rollup/rollup-darwin-arm64": "4.59.0", + "@rollup/rollup-darwin-x64": "4.59.0", + "@rollup/rollup-freebsd-arm64": "4.59.0", + "@rollup/rollup-freebsd-x64": "4.59.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.59.0", + "@rollup/rollup-linux-arm-musleabihf": "4.59.0", + "@rollup/rollup-linux-arm64-gnu": "4.59.0", + "@rollup/rollup-linux-arm64-musl": "4.59.0", + "@rollup/rollup-linux-loong64-gnu": "4.59.0", + "@rollup/rollup-linux-loong64-musl": "4.59.0", + "@rollup/rollup-linux-ppc64-gnu": "4.59.0", + "@rollup/rollup-linux-ppc64-musl": "4.59.0", + "@rollup/rollup-linux-riscv64-gnu": "4.59.0", + "@rollup/rollup-linux-riscv64-musl": "4.59.0", + "@rollup/rollup-linux-s390x-gnu": "4.59.0", + "@rollup/rollup-linux-x64-gnu": "4.59.0", + "@rollup/rollup-linux-x64-musl": "4.59.0", + "@rollup/rollup-openbsd-x64": "4.59.0", + "@rollup/rollup-openharmony-arm64": "4.59.0", + "@rollup/rollup-win32-arm64-msvc": "4.59.0", + "@rollup/rollup-win32-ia32-msvc": "4.59.0", + "@rollup/rollup-win32-x64-gnu": "4.59.0", + "@rollup/rollup-win32-x64-msvc": "4.59.0", + "fsevents": "~2.3.2" + } + }, + "node_modules/scheduler": { + "version": "0.23.2", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.2.tgz", + "integrity": "sha512-UOShsPwz7NrMUqhR6t0hWjFduvOzbtv7toDH1/hIrfRNIDBnnBWd0CwJTGvTpngVlmwGCdP9/Zl/tVrDqcuYzQ==", + "license": "MIT", + "dependencies": { + "loose-envify": "^1.1.0" + } + }, + "node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/tinyglobby": { + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "fdir": "^6.5.0", + "picomatch": "^4.0.3" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/update-browserslist-db": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz", + "integrity": "sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "escalade": "^3.2.0", + "picocolors": "^1.1.1" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/vite": { + "version": "6.4.1", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.4.1.tgz", + "integrity": "sha512-+Oxm7q9hDoLMyJOYfUYBuHQo+dkAloi33apOPP56pzj+vsdJDzr+j1NISE5pyaAuKL4A3UD34qd0lx5+kfKp2g==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.25.0", + "fdir": "^6.4.4", + "picomatch": "^4.0.2", + "postcss": "^8.5.3", + "rollup": "^4.34.9", + "tinyglobby": "^0.2.13" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "jiti": ">=1.21.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true, + "license": "ISC" + } + } +} diff --git a/core/samples/TabApp/Web/package.json b/core/samples/TabApp/Web/package.json new file mode 100644 index 00000000..66ecefaa --- /dev/null +++ b/core/samples/TabApp/Web/package.json @@ -0,0 +1,22 @@ +{ + "name": "tabsapp-web", + "private": true, + "version": "1.0.0", + "type": "module", + "scripts": { + "build": "tsc --noEmit && vite build" + }, + "dependencies": { + "@azure/msal-browser": "^3.0.0", + "@microsoft/teams-js": "^2.32.0", + "react": "^18.3.1", + "react-dom": "^18.3.1" + }, + "devDependencies": { + "@types/react": "^18.3.12", + "@types/react-dom": "^18.3.1", + "@vitejs/plugin-react": "^4.3.3", + "typescript": "^5.6.3", + "vite": "^6.0.3" + } +} diff --git a/core/samples/TabApp/Web/src/App.css b/core/samples/TabApp/Web/src/App.css new file mode 100644 index 00000000..ec308897 --- /dev/null +++ b/core/samples/TabApp/Web/src/App.css @@ -0,0 +1,161 @@ +/* ─── Design tokens ──────────────────────────────────────────────────────── */ +:root { + --bg: #f5f5f5; /* page background */ + --surface: #ffffff; /* card / elevated surface */ + --text: #111111; + --accent: #6264a7; /* Teams purple */ + --accent-hover: #4f50a0; + --border: #e0e0e0; + --hint: #666; /* secondary / helper text */ +} + +/* ─── OS-level dark mode ─────────────────────────────────────────────────── */ +@media (prefers-color-scheme: dark) { + :root { + --bg: #1a1a1a; + --surface: #2d2d2d; + --text: #f0f0f0; + --accent: #9ea5ff; + --accent-hover: #b8bdff; + --border: #444; + --hint: #aaa; + } +} + +/* ─── Teams theme override ───────────────────────────────────────────────── + Teams injects a data-theme attribute on ("default", "dark", + "contrast"). */ +[data-theme='dark'], +[data-theme='contrast'] { + --bg: #1a1a1a; + --surface: #2d2d2d; + --text: #f0f0f0; + --accent: #9ea5ff; + --accent-hover: #b8bdff; + --border: #444; + --hint: #aaa; +} + +/* ─── Reset ──────────────────────────────────────────────────────────────── */ +* { + box-sizing: border-box; +} + +/* ─── Base ───────────────────────────────────────────────────────────────── + Segoe UI is the Teams typeface; the stack falls back gracefully on other + platforms. */ +body { + margin: 0; + font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; + background: var(--bg); + color: var(--text); + font-size: 14px; + line-height: 1.5; +} + +/* ─── Page layout ────────────────────────────────────────────────────────── + Constrain content width and centre it so the tab reads well on wide + desktop clients. */ +.app { + max-width: 680px; + margin: 0 auto; + padding: 24px 16px; +} + +h1 { + font-size: 1.4rem; + color: var(--accent); + margin: 0 0 20px; +} + +/* ─── Card ───────────────────────────────────────────────────────────────── + Each functional section (post-to-chat, who-am-i, …) lives in a card so + they're visually separated without hard dividers. */ +.card { + background: var(--surface); + border: 1px solid var(--border); + border-radius: 8px; + padding: 16px 20px; + margin-bottom: 14px; +} + +.card h2 { + margin: 0 0 8px; + font-size: 0.9rem; + font-weight: 600; + color: var(--accent); + text-transform: uppercase; + letter-spacing: 0.04em; +} + +/* ─── Helper text ────────────────────────────────────────────────────────── + Short description shown below a card heading. */ +.hint { + margin: 0 0 12px; + font-size: 0.82rem; + color: var(--hint); +} + +/* ─── JSON output ────────────────────────────────────────────────────────── + Used inside .result cards to display raw server responses. */ +pre { + background: var(--bg); + border-radius: 4px; + padding: 10px; + font-size: 0.8rem; + overflow-x: auto; + white-space: pre-wrap; + word-break: break-all; + margin: 0; +} + +/* ─── Text input ─────────────────────────────────────────────────────────── + Full-width so it stays aligned with the button below it. */ +input { + display: block; + width: 100%; + padding: 8px 10px; + margin-bottom: 10px; + border: 1px solid var(--border); + border-radius: 4px; + background: var(--bg); + color: var(--text); + font-size: 0.9rem; +} + +input:focus { + outline: 2px solid var(--accent); + outline-offset: 1px; +} + +/* ─── Button ─────────────────────────────────────────────────────────────── + Teams-purple fill; transitions smoothly on hover. */ +button { + background: var(--accent); + color: #fff; + border: none; + border-radius: 4px; + padding: 8px 18px; + cursor: pointer; + font-size: 0.9rem; + font-weight: 500; + transition: background 0.15s; +} + +button:hover { + background: var(--accent-hover); +} + +/* ─── Loading state ──────────────────────────────────────────────────────── + Shown while Teams SDK initialises (before app.initialize() resolves). */ +.loading { + padding: 60px; + text-align: center; + color: var(--hint); +} + +/* ─── Result card ────────────────────────────────────────────────────────── + Accent-coloured border makes the response stand out from regular cards. */ +.result pre { + border: 1px solid var(--accent); +} diff --git a/core/samples/TabApp/Web/src/App.tsx b/core/samples/TabApp/Web/src/App.tsx new file mode 100644 index 00000000..76080247 --- /dev/null +++ b/core/samples/TabApp/Web/src/App.tsx @@ -0,0 +1,159 @@ +import { useState, useEffect, useCallback } from 'react' +import { app } from '@microsoft/teams-js' +import { createNestablePublicClientApplication, InteractionRequiredAuthError, IPublicClientApplication } from '@azure/msal-browser' + +const clientId = import.meta.env.VITE_CLIENT_ID as string +let _msal: IPublicClientApplication + +//TODO : do we want to take dependency on teams.client +async function getMsal(): Promise { + if (!_msal) { + _msal = await createNestablePublicClientApplication({ + auth: { clientId, authority: '', redirectUri: '/' }, + }) + } + return _msal +} + +async function acquireToken(scopes: string[], context: app.Context | null): Promise { + const loginHint = context?.user?.loginHint + const msal = await getMsal() + + const accounts = msal.getAllAccounts() + const account = loginHint + ? (accounts.find(a => a.username === loginHint) ?? accounts[0]) + : accounts[0] + + try { + if (!account) throw new InteractionRequiredAuthError('no_account') + const result = await msal.acquireTokenSilent({ scopes, account }) + return result.accessToken + } catch (e) { + if (!(e instanceof InteractionRequiredAuthError)) throw e + const result = await msal.acquireTokenPopup({ scopes, loginHint }) + return result.accessToken + } +} + +export default function App() { + const [context, setContext] = useState(null) + const [message, setMessage] = useState('Hello from the tab!') + const [result, setResult] = useState('') + const [initialized, setInitialized] = useState(false) + const [status, setStatus] = useState(false) + + useEffect(() => { + app.initialize().then(() => { + app.getContext().then((ctx) => { + setContext(ctx) + setInitialized(true) + }) + }) + }, []) + + async function callFunction(name: string, body: unknown): Promise { + const msal = await getMsal() + const { accessToken } = await msal.acquireTokenSilent({ scopes: [`api://${clientId}/access_as_user`] }) + + const res = await fetch(`/functions/${name}`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': `Bearer ${accessToken}`, + }, + body: JSON.stringify(body), + }) + if (!res.ok) throw new Error(`HTTP ${res.status}`) + return res.json() + } + + async function run(fn: () => Promise) { + try { + const res = await fn() + setResult(JSON.stringify(res, null, 2)) + } catch (e) { + setResult(String(e)) + } + } + + const showContext = useCallback(() => run(async () => context), [context]) + const postToChat = useCallback(() => run(() => callFunction('post-to-chat', { message, chatId: context?.chat?.id, channelId: context?.channel?.id })), [message, context]) + const whoAmI = useCallback(() => run(async () => { + const accessToken = await acquireToken(['User.Read'], context) + return fetch('https://graph.microsoft.com/v1.0/me', { + headers: { Authorization: `Bearer ${accessToken}` }, + }).then(r => r.json()) + }), [context]) + + const toggleStatus = useCallback(() => run(async () => { + const accessToken = await acquireToken(['Presence.ReadWrite'], context) + + const presenceRes = await fetch('https://graph.microsoft.com/v1.0/me/presence', { + headers: { Authorization: `Bearer ${accessToken}` }, + }) + if (!presenceRes.ok) throw new Error(`Graph ${presenceRes.status}`) + const { availability: current } = await presenceRes.json() + + const isAvailable = current === 'Available' + const availability = isAvailable ? 'DoNotDisturb' : 'Available' + const activity = isAvailable ? 'DoNotDisturb' : 'Available' + + const res = await fetch('https://graph.microsoft.com/v1.0/me/presence/setUserPreferredPresence', { + method: 'POST', + headers: { 'Authorization': `Bearer ${accessToken}`, 'Content-Type': 'application/json' }, + body: JSON.stringify({ availability, activity }), + }) + if (!res.ok) { + const body = await res.json().catch(() => ({})) + throw new Error(`Graph ${res.status}: ${JSON.stringify(body)}`) + } + setStatus(availability === 'DoNotDisturb') + return { availability, activity } + }), [context]) + + if (!initialized) { + return
Initializing Teams SDK…
+ } + + return ( +
+

Teams Tab Sample

+ +
+

Teams Context

+

Shows the raw Teams context for this session.

+ +
+ +
+

Post to Chat

+

Sends a proactive message via the bot.

+ setMessage(e.target.value)} + placeholder="Message text" + /> + +
+ +
+

Who Am I

+

Looks up your member record.

+ +
+ +
+

Toggle Presence

+

Sets your Teams presence via Graph. Current: {status ? 'DoNotDisturb' : 'Available'}

+ +
+ + {result && ( +
+

Result

+ 
{result}
+
+ )} +
+ ) +} diff --git a/core/samples/TabApp/Web/src/main.tsx b/core/samples/TabApp/Web/src/main.tsx new file mode 100644 index 00000000..df579560 --- /dev/null +++ b/core/samples/TabApp/Web/src/main.tsx @@ -0,0 +1,10 @@ +import { StrictMode } from 'react' +import { createRoot } from 'react-dom/client' +import './App.css' +import App from './App' + +createRoot(document.getElementById('root')!).render( + + + , +) diff --git a/core/samples/TabApp/Web/tsconfig.json b/core/samples/TabApp/Web/tsconfig.json new file mode 100644 index 00000000..21cb8814 --- /dev/null +++ b/core/samples/TabApp/Web/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "target": "ES2020", + "useDefineForClassFields": true, + "lib": ["ES2020", "DOM", "DOM.Iterable"], + "module": "ESNext", + "skipLibCheck": true, + "moduleResolution": "bundler", + "allowImportingTsExtensions": true, + "isolatedModules": true, + "moduleDetection": "force", + "noEmit": true, + "jsx": "react-jsx", + "strict": true, + "noUnusedLocals": true, + "noUnusedParameters": true, + "noFallthroughCasesInSwitch": true, + "types": ["vite/client"] + }, + "include": ["src"] +} diff --git a/core/samples/TabApp/Web/vite.config.ts b/core/samples/TabApp/Web/vite.config.ts new file mode 100644 index 00000000..3ed0f3db --- /dev/null +++ b/core/samples/TabApp/Web/vite.config.ts @@ -0,0 +1,12 @@ +import { defineConfig } from 'vite' +import react from '@vitejs/plugin-react' + +export default defineConfig({ + plugins: [react()], + // Must match the tab name passed to app.WithTab("test", ...) + base: '/tabs/test', + build: { + outDir: 'bin', + emptyOutDir: true, + }, +}) diff --git a/core/samples/TabApp/appsettings.json b/core/samples/TabApp/appsettings.json new file mode 100644 index 00000000..5ebb41d0 --- /dev/null +++ b/core/samples/TabApp/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.Teams": "Information" + } + }, + "AllowedHosts": "*" +} diff --git a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs index e5a4a03d..b2df78ba 100644 --- a/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs +++ b/core/src/Microsoft.Teams.Bot.Apps/TeamsBotApplication.cs @@ -27,7 +27,6 @@ public class TeamsBotApplication : BotApplication /// public TeamsApiClient TeamsApiClient => _teamsApiClient; - /// /// /// diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/AuthenticationSchemeOptions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/AuthenticationSchemeOptions.cs deleted file mode 100644 index 6a120c7a..00000000 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/AuthenticationSchemeOptions.cs +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -namespace Microsoft.Teams.Bot.Core.Hosting; - -/// -/// Options for determining which authentication scheme to use. -/// -internal sealed class AuthenticationSchemeOptions -{ - /// - /// Gets or sets a value indicating whether to use Agent authentication (true) or Bot authentication (false). - /// - public bool UseAgentAuth { get; set; } - - /// - /// Gets or sets the scope value used to determine the authentication scheme. - /// - public string Scope { get; set; } = "https://api.botframework.com/.default"; -} diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs index 16885dc4..48386ced 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/BotConfig.cs @@ -105,4 +105,28 @@ public static BotConfig FromAadConfig(IConfiguration configuration, string secti ClientSecret = section["ClientSecret"], }; } + + /// + /// Resolves a BotConfig by trying all configuration formats in priority order: + /// AzureAd section, Core environment variables, then Bot Framework SDK keys. + /// + /// The application configuration. + /// The AAD configuration section name. Defaults to "AzureAd". + /// The first BotConfig with a non-empty ClientId. + /// Thrown when no ClientId is found in any configuration format. + public static BotConfig Resolve(IConfiguration configuration, string sectionName = "AzureAd") + { + ArgumentNullException.ThrowIfNull(configuration); + + BotConfig config = FromAadConfig(configuration, sectionName); + if (!string.IsNullOrEmpty(config.ClientId)) return config; + + config = FromCoreConfig(configuration); + if (!string.IsNullOrEmpty(config.ClientId)) return config; + + config = FromBFConfig(configuration); + if (!string.IsNullOrEmpty(config.ClientId)) return config; + + throw new InvalidOperationException("ClientID not found in configuration."); + } } diff --git a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs index 41408f09..76cc6f60 100644 --- a/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs +++ b/core/src/Microsoft.Teams.Bot.Core/Hosting/JwtExtensions.cs @@ -1,13 +1,16 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -using System.IdentityModel.Tokens.Jwt; +using System.Collections.Concurrent; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Authentication.JwtBearer; using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Http; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.IdentityModel.JsonWebTokens; using Microsoft.IdentityModel.Protocols; using Microsoft.IdentityModel.Protocols.OpenIdConnect; using Microsoft.IdentityModel.Tokens; @@ -20,49 +23,28 @@ namespace Microsoft.Teams.Bot.Core.Hosting /// public static class JwtExtensions { - internal const string BotScheme = "BotScheme"; - internal const string AgentScheme = "AgentScheme"; - internal const string BotScope = "https://api.botframework.com/.default"; - internal const string AgentScope = "https://botapi.skype.com/.default"; internal const string BotOIDC = "https://login.botframework.com/v1/.well-known/openid-configuration"; - internal const string AgentOIDC = "https://login.microsoftonline.com/"; + internal const string EntraOIDC = "https://login.microsoftonline.com/"; /// /// Adds JWT authentication for bots and agents. /// /// The service collection to add authentication to. - /// The application configuration containing the settings. - /// Indicates whether to use agent authentication (true) or bot authentication (false). /// The configuration section name for the settings. Defaults to "AzureAd". /// The logger instance for logging. /// An for further authentication configuration. - public static AuthenticationBuilder AddBotAuthentication(this IServiceCollection services, IConfiguration configuration, bool useAgentAuth, ILogger logger, string aadSectionName = "AzureAd") + public static AuthenticationBuilder AddBotAuthentication(this IServiceCollection services, ILogger logger, string aadSectionName = "AzureAd") { + AuthenticationBuilder builder = services.AddAuthentication(); - // TODO: Task 5039187: Refactor use of BotConfig for MSAL and JWT + ServiceDescriptor? configDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(IConfiguration)); + IConfiguration configuration = configDescriptor?.ImplementationInstance as IConfiguration + ?? services.BuildServiceProvider().GetRequiredService(); - AuthenticationBuilder builder = services.AddAuthentication(); - ArgumentNullException.ThrowIfNull(configuration); - string audience = configuration[$"{aadSectionName}:ClientId"] - ?? configuration["CLIENT_ID"] - ?? configuration["MicrosoftAppId"] - ?? throw new InvalidOperationException("ClientID not found in configuration, tried the 3 option"); + BotConfig botConfig = BotConfig.Resolve(configuration, aadSectionName); - if (!useAgentAuth) - { - string[] validIssuers = ["https://api.botframework.com"]; - builder.AddCustomJwtBearer($"BotScheme_{aadSectionName}", validIssuers, audience, logger); - } - else - { - string tenantId = configuration[$"{aadSectionName}:TenantId"] - ?? configuration["TENANT_ID"] - ?? configuration["MicrosoftAppTenantId"] - ?? "botframework.com"; // TODO: Task 5039198: Test JWT Validation for MultiTenant + builder.AddTeamsJwtBearer(aadSectionName, botConfig.ClientId, botConfig.TenantId, logger); - string[] validIssuers = [$"https://sts.windows.net/{tenantId}/", $"https://login.microsoftonline.com/{tenantId}/v2", "https://api.botframework.com"]; - builder.AddCustomJwtBearer(AgentScheme, validIssuers, audience, logger); - } return builder; } @@ -75,204 +57,130 @@ public static AuthenticationBuilder AddBotAuthentication(this IServiceCollection /// An for further authorization configuration. public static AuthorizationBuilder AddBotAuthorization(this IServiceCollection services, ILogger? logger = null, string aadSectionName = "AzureAd") { - // Use NullLogger if no logger provided - logger ??= Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + logger ??= NullLogger.Instance; - // We need IConfiguration to determine which authentication scheme to register (Bot vs Agent) - // This is a registration-time decision that cannot be deferred - // Try to get it from service descriptors first (fast path) - ServiceDescriptor? configDescriptor = services.FirstOrDefault(d => d.ServiceType == typeof(IConfiguration)); - IConfiguration? configuration = configDescriptor?.ImplementationInstance as IConfiguration; + services.AddBotAuthentication(logger, aadSectionName); - // If not available as ImplementationInstance, build a temporary ServiceProvider - // NOTE: This is generally an anti-pattern, but acceptable here because: - // 1. We need configuration at registration time to select auth scheme - // 2. We properly dispose the temporary ServiceProvider immediately - // 3. This only happens once during application startup - if (configuration == null) - { - using ServiceProvider tempProvider = services.BuildServiceProvider(); - configuration = tempProvider.GetRequiredService(); - } - - string? azureScope = configuration["Scope"]; - bool useAgentAuth = string.Equals(azureScope, AgentScope, StringComparison.OrdinalIgnoreCase); - - services.AddBotAuthentication(configuration, useAgentAuth, logger, aadSectionName); - AuthorizationBuilder authorizationBuilder = services + return services .AddAuthorizationBuilder() .AddDefaultPolicy(aadSectionName, policy => { - if (!useAgentAuth) - { - policy.AuthenticationSchemes.Add($"BotScheme_{aadSectionName}"); - } - else - { - policy.AuthenticationSchemes.Add(AgentScheme); - } + policy.AuthenticationSchemes.Add(aadSectionName); policy.RequireAuthenticatedUser(); }); - return authorizationBuilder; } - private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuilder builder, string schemeName, string[] validIssuers, string audience, ILogger? logger) + private static string ValidateTeamsIssuer(string issuer, SecurityToken token, string configuredTenantId) { + // Bot Framework tokens + if (issuer.Equals("https://api.botframework.com", StringComparison.OrdinalIgnoreCase)) + return issuer; + + // Entra tokens � bot-to-bot (agent) and user (tab/API) + // Use the token's own tid claim for multi-tenant; fall back to configured tenant + (_, string? tid) = GetTokenClaims(token); + string? effectiveTenant = string.IsNullOrEmpty(configuredTenantId) ? tid : configuredTenantId; + + if (effectiveTenant is not null && + (issuer == $"https://login.microsoftonline.com/{effectiveTenant}/v2.0" || + issuer == $"https://sts.windows.net/{effectiveTenant}/")) + return issuer; + + throw new SecurityTokenInvalidIssuerException($"Issuer '{issuer}' is not valid."); + } + + private static (string? iss, string? tid) GetTokenClaims(SecurityToken token) => + token is JsonWebToken jwt + ? (jwt.Issuer, jwt.TryGetClaim("tid", out var c) ? c.Value : null) + : (null, null); + + private static AuthenticationBuilder AddTeamsJwtBearer(this AuthenticationBuilder builder, string schemeName, string audience, string tenantId, ILogger? logger) + { + // One ConfigurationManager per OIDC authority, shared safely across all requests. + ConcurrentDictionary> configManagerCache = new(StringComparer.OrdinalIgnoreCase); + builder.AddJwtBearer(schemeName, jwtOptions => { jwtOptions.SaveToken = true; jwtOptions.IncludeErrorDetails = true; - jwtOptions.Audience = audience; jwtOptions.TokenValidationParameters = new TokenValidationParameters { ValidateIssuerSigningKey = true, RequireSignedTokens = true, ValidateIssuer = true, ValidateAudience = true, - ValidIssuers = validIssuers + ValidAudiences = [audience, $"api://{audience}"], + IssuerValidator = (issuer, token, _) => ValidateTeamsIssuer(issuer, token, tenantId), + IssuerSigningKeyResolver = (_, securityToken, _, _) => + { + (string? iss, string? tid) = GetTokenClaims(securityToken); + if (iss is null) return []; + + string authority = iss.Equals("https://api.botframework.com", StringComparison.OrdinalIgnoreCase) + ? BotOIDC + : $"{EntraOIDC}{tid ?? "botframework.com"}/v2.0/.well-known/openid-configuration"; + + ConfigurationManager manager = configManagerCache.GetOrAdd(authority, a => + new ConfigurationManager( + a, + new OpenIdConnectConfigurationRetriever(), + new HttpDocumentRetriever { RequireHttps = jwtOptions.RequireHttpsMetadata })); + + OpenIdConnectConfiguration config = manager.GetConfigurationAsync(CancellationToken.None).GetAwaiter().GetResult(); + return config.SigningKeys; + } }; jwtOptions.TokenValidationParameters.EnableAadSigningKeyIssuerValidation(); jwtOptions.MapInboundClaims = true; jwtOptions.Events = new JwtBearerEvents { - OnMessageReceived = async context => - { - // Resolve logger at runtime from request services to ensure we always have proper logging - ILoggerFactory? loggerFactory = context.HttpContext.RequestServices.GetService(); - ILogger requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") - ?? logger - ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; - - requestLogger.LogDebug("OnMessageReceived invoked for scheme: {Scheme}", schemeName); - string authorizationHeader = context.Request.Headers.Authorization.ToString(); - - if (string.IsNullOrEmpty(authorizationHeader)) - { - // Default to AadTokenValidation handling - context.Options.TokenValidationParameters.ConfigurationManager ??= jwtOptions.ConfigurationManager as BaseConfigurationManager; - await Task.CompletedTask.ConfigureAwait(false); - requestLogger.LogWarning("Authorization header is missing for scheme: {Scheme}", schemeName); - return; - } - - string[] parts = authorizationHeader?.Split(' ')!; - if (parts.Length != 2 || parts[0] != "Bearer") - { - // Default to AadTokenValidation handling - context.Options.TokenValidationParameters.ConfigurationManager ??= jwtOptions.ConfigurationManager as BaseConfigurationManager; - await Task.CompletedTask.ConfigureAwait(false); - requestLogger.LogWarning("Invalid authorization header format for scheme: {Scheme}", schemeName); - return; - } - - JwtSecurityToken token = new(parts[1]); - string issuer = token.Claims.FirstOrDefault(claim => claim.Type == "iss")?.Value!; - string tid = token.Claims.FirstOrDefault(claim => claim.Type == "tid")?.Value!; - - string oidcAuthority = issuer.Equals("https://api.botframework.com", StringComparison.OrdinalIgnoreCase) - ? BotOIDC : $"{AgentOIDC}{tid ?? "botframework.com"}/v2.0/.well-known/openid-configuration"; - - requestLogger.LogDebug("Using OIDC Authority: {OidcAuthority} for issuer: {Issuer}", oidcAuthority, issuer); - - jwtOptions.ConfigurationManager = new ConfigurationManager( - oidcAuthority, - new OpenIdConnectConfigurationRetriever(), - new HttpDocumentRetriever - { - RequireHttps = jwtOptions.RequireHttpsMetadata - }); - - - await Task.CompletedTask.ConfigureAwait(false); - }, OnTokenValidated = context => { - // Resolve logger at runtime - ILoggerFactory? loggerFactory = context.HttpContext.RequestServices.GetService(); - ILogger requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") - ?? logger - ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; - - requestLogger.LogInformation("Token validated successfully for scheme: {Scheme}", schemeName); + GetLogger(context.HttpContext, logger).LogDebug("Token validated for scheme: {Scheme}", schemeName); return Task.CompletedTask; }, OnForbidden = context => { - // Resolve logger at runtime - ILoggerFactory? loggerFactory = context.HttpContext.RequestServices.GetService(); - ILogger requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") - ?? logger - ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; - - requestLogger.LogWarning("Forbidden response for scheme: {Scheme}", schemeName); + GetLogger(context.HttpContext, logger).LogWarning("Forbidden for scheme: {Scheme}", schemeName); return Task.CompletedTask; }, OnAuthenticationFailed = context => { - // Resolve logger at runtime to ensure authentication failures are always logged - ILoggerFactory? loggerFactory = context.HttpContext.RequestServices.GetService(); - ILogger requestLogger = loggerFactory?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") - ?? logger - ?? Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance; + ILogger log = GetLogger(context.HttpContext, logger); - // Extract detailed information for troubleshooting - string? tokenAudience = null; string? tokenIssuer = null; + string? tokenAudience = null; string? tokenExpiration = null; string? tokenSubject = null; - - try + string authHeader = context.Request.Headers.Authorization.ToString(); + if (authHeader.StartsWith("Bearer ", StringComparison.OrdinalIgnoreCase)) { - // Try to parse the token to extract claims - string authHeader = context.Request.Headers.Authorization.ToString(); - if (!string.IsNullOrEmpty(authHeader) && authHeader.StartsWith("Bearer ", StringComparison.OrdinalIgnoreCase)) + try { - string tokenString = authHeader.Substring("Bearer ".Length).Trim(); - JwtSecurityToken token = new(tokenString); - - tokenAudience = token.Audiences?.FirstOrDefault(); - tokenIssuer = token.Issuer; - tokenExpiration = token.ValidTo.ToString("o"); - tokenSubject = token.Subject; + JsonWebToken jwt = new(authHeader["Bearer ".Length..].Trim()); + (tokenIssuer, _) = GetTokenClaims(jwt); + tokenAudience = jwt.GetClaim("aud")?.Value; + tokenExpiration = jwt.ValidTo.ToString("o"); + tokenSubject = jwt.Subject; } + catch (ArgumentException) { } } -#pragma warning disable CA1031 // Do not catch general exception types - we want to continue logging even if token parsing fails - catch - { - // If we can't parse the token, continue with logging the exception - } -#pragma warning restore CA1031 - // Get configured validation parameters TokenValidationParameters? validationParams = context.Options?.TokenValidationParameters; - string configuredAudience = validationParams?.ValidAudience ?? "null"; - string configuredAudiences = validationParams?.ValidAudiences != null + string expectedAudiences = validationParams?.ValidAudiences is not null ? string.Join(", ", validationParams.ValidAudiences) - : "null"; - string configuredIssuers = validationParams?.ValidIssuers != null - ? string.Join(", ", validationParams.ValidIssuers) - : "null"; - - // Log detailed failure information - requestLogger.LogError(context.Exception, - "JWT Authentication failed for scheme: {Scheme}\n" + - " Failure Reason: {ExceptionMessage}\n" + - " Token Audience: {TokenAudience}\n" + - " Expected Audience: {ConfiguredAudience}\n" + - " Expected Audiences: {ConfiguredAudiences}\n" + - " Token Issuer: {TokenIssuer}\n" + - " Valid Issuers: {ConfiguredIssuers}\n" + - " Token Expiration: {TokenExpiration}\n" + - " Token Subject: {TokenSubject}", + : validationParams?.ValidAudience ?? "n/a"; + log.LogError(context.Exception, + "JWT authentication failed for scheme {Scheme}: {ExceptionMessage} | " + + "token iss={TokenIssuer} aud={TokenAudience} exp={TokenExpiration} sub={TokenSubject} | " + + "expected aud={ConfiguredAudience}", schemeName, context.Exception.Message, - tokenAudience ?? "Unable to parse", - configuredAudience, - configuredAudiences, - tokenIssuer ?? "Unable to parse", - configuredIssuers, - tokenExpiration ?? "Unable to parse", - tokenSubject ?? "Unable to parse"); + tokenIssuer ?? "n/a", + tokenAudience ?? "n/a", + tokenExpiration ?? "n/a", + tokenSubject ?? "n/a", + expectedAudiences); return Task.CompletedTask; } @@ -281,5 +189,10 @@ private static AuthenticationBuilder AddCustomJwtBearer(this AuthenticationBuild }); return builder; } + + private static ILogger GetLogger(HttpContext context, ILogger? fallback) => + context.RequestServices.GetService()?.CreateLogger(typeof(JwtExtensions).FullName ?? "JwtExtensions") + ?? fallback + ?? NullLogger.Instance; } }