Support JSON object state values in SignIn VerifyState activities (non-breaking) by Copilot · Pull Request #329 · microsoft/teams.net

Copilot · 2026-02-12T17:53:46Z

Original prompt

This section details on the original issue you should resolve

<issue_title>SignIn VerifyState activity state may be json objects on android and ios devices</issue_title>
<issue_description>Please refer to OfficeDev/microsoft-teams-library-js#2189, OfficeDev/microsoft-teams-library-js#528. The state property may not be string type, so it can cause json deserialization error when user signin on android and ios devices.

System.Text.Json.JsonException: The JSON value could not be converted to System.String. Path: $.value.state | LineNumber: 0 | BytePositionInLine: 1123.
[ERROR]  ---> System.InvalidOperationException: Cannot get the value of a token type 'StartObject' as a string.
[ERROR]    at System.Text.Json.ThrowHelper.ThrowInvalidOperationException_ExpectedString(JsonTokenType tokenType)
[ERROR]    at System.Text.Json.Serialization.Metadata.JsonPropertyInfo`1.ReadJsonAndSetMember(Object obj, ReadStack& state, Utf8JsonReader& reader)        
[ERROR]    at System.Text.Json.Serialization.Converters.ObjectDefaultConverter`1.OnTryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value)
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.TryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value, Boolean& isPopulatedValue)
[ERROR]    at System.Text.Json.Serialization.Metadata.JsonPropertyInfo`1.ReadJsonAndSetMember(Object obj, ReadStack& state, Utf8JsonReader& reader)        
[ERROR]    at System.Text.Json.Serialization.Converters.ObjectDefaultConverter`1.OnTryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value)
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.TryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value, Boolean& isPopulatedValue)
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.ReadCore(Utf8JsonReader& reader, T& value, JsonSerializerOptions options, ReadStack& state)   
[ERROR]    --- End of inner exception stack trace ---
[ERROR]    at System.Text.Json.ThrowHelper.ReThrowWithPath(ReadStack& state, Utf8JsonReader& reader, Exception ex)
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.ReadCore(Utf8JsonReader& reader, T& value, JsonSerializerOptions options, ReadStack& state)   
[ERROR]    at System.Text.Json.JsonSerializer.ReadFromSpan[TValue](ReadOnlySpan`1 json, JsonTypeInfo`1 jsonTypeInfo)
[ERROR]    at System.Text.Json.JsonSerializer.Deserialize[TValue](String json, JsonSerializerOptions options)
[ERROR]    at Microsoft.Teams.Api.Activities.Invokes.SignInActivity.JsonConverter.Read(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options)
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.TryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value, Boolean& isPopulatedValue)
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.ReadCore(Utf8JsonReader& reader, T& value, JsonSerializerOptions options, ReadStack& state)   
[ERROR]    at System.Text.Json.JsonSerializer.ReadFromSpan[TValue](ReadOnlySpan`1 json, JsonTypeInfo`1 jsonTypeInfo)
[ERROR]    at System.Text.Json.JsonSerializer.Deserialize[TValue](String json, JsonSerializerOptions options)
[ERROR]    at Microsoft.Teams.Api.Activities.InvokeActivity.JsonConverter.Read(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options)  
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.TryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value, Boolean& isPopulatedValue)
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.ReadCore(Utf8JsonReader& reader, T& value, JsonSerializerOptions options, ReadStack& state)   
[ERROR]    at System.Text.Json.JsonSerializer.ReadFromNode[TValue](JsonNode node, JsonTypeInfo`1 jsonTypeInfo)
[ERROR]    at Microsoft.Teams.Api.Activities.Activity.JsonConverter.Read(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options)        
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.TryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value, Boolean& isPopulatedValue)
[ERROR]    at System.Text.Json.Serialization.JsonConverter`1.ReadCore(Utf8JsonReader& reader, T& value, JsonSerializerOptions options, ReadStack& state)   
[ERROR]    at System.Text.Json.JsonSerializer.ReadFromSpan[TValue](ReadOnlySpan`1 json, JsonTypeInfo`1 jsonTypeInfo)
[ERROR]    at System.Text.Json.JsonSerializer.Deserialize[TValue](String json, JsonSerializerOptions options)
[ERROR]    at Microsoft.Teams.Plugins.AspNetCore.AspNetCorePlugin.ParseActivity(HttpRequest httpRequest)
[ERROR]    at Microsoft.Teams.Plugins.AspNetCore.AspNetCorePlugin.Do(HttpContext httpContext, CancellationToken ca...

</details>



<!-- START COPILOT CODING AGENT SUFFIX -->

- Fixes microsoft/teams.net#302

<!-- START COPILOT CODING AGENT TIPS -->
---

✨ Let Copilot coding agent [set things up for you](https://github.com/microsoft/teams.net/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo.

…nd object types Co-authored-by: singhk97 <115390646+singhk97@users.noreply.github.com>

Co-authored-by: singhk97 <115390646+singhk97@users.noreply.github.com>

singhk97 · 2026-02-13T17:47:58Z

#302 issue for reference

singhk97 · 2026-02-13T17:58:02Z

Libraries/Microsoft.Teams.Api/SignIn/StateVerifyQuery.cs

    /// </summary>
    [JsonPropertyName("state")]
    [JsonPropertyOrder(0)]
-    public string? State { get; set; }


@copilot This is a change that will break existing customers. Can you help me understand if it's possible to keep this as a string, and deserialize values (even if they're json objects) into a string as well. How will that look like?

I've updated the implementation to use a custom JsonConverter that keeps the State property as string?, maintaining full backward compatibility. The converter automatically handles both cases:

When the value is a string, it returns it directly

When the value is a JSON object (Android/iOS), it serializes it to a JSON string

This approach is non-breaking - existing code that reads State as a string will continue to work without any changes. See commit 415b665.

singhk97 · 2026-02-13T18:00:33Z

Libraries/Microsoft.Teams.Api/SignIn/StateVerifyQuery.cs

    [JsonPropertyName("state")]
    [JsonPropertyOrder(0)]
-    public string? State { get; set; }
+    public JsonElement? State { get; set; }


@copilot also consider the scenario where if state is not a string this would be parsed as the default value, and the onus is on the end user to access this from a catch all property bag.

I want to make sure I understand your suggestion correctly. Are you proposing that:

If state is a string → State property gets the string value

If state is an object → State property is null, and the object is available in a Properties extension data dictionary?

The concern I have with this approach is that it would lose the state information when it's sent as an object (Android/iOS case). The current implementation converts objects to JSON strings, so the state data is preserved and accessible via the State property, maintaining backward compatibility while ensuring no data loss.

Could you clarify if you're suggesting this alternative, or if you have a different scenario in mind?

Co-authored-by: singhk97 <115390646+singhk97@users.noreply.github.com>

Copilot · 2026-02-13T18:05:39Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

token.botframework.com
- Triggering command: /usr/share/dotnet/dotnet /usr/share/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/teams.net/teams.net/Tests/Microsoft.Teams.Apps.Tests/bin/Debug/net8.0/Microsoft.Teams.Apps.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/teams.net/teams.net/Tests/Microsoft.Teams.Apps.Tests/bin/Debug/net8.0/Microsoft.Teams.Apps.Tests.deps.json /home/REDACTED/work/teams.net/teams.net/Tests/Microsoft.Teams.Apps.Tests/bin/Debug/net8.0/testhost.dll --port 39419 --endpoint 127.0.0.1:039419 --role client --parentprocessid 4364 --telemetryoptedin false (dns block)
- Triggering command: /usr/share/dotnet/dotnet /usr/share/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/teams.net/teams.net/Tests/Microsoft.Teams.Apps.Tests/bin/Debug/net10.0/Microsoft.Teams.Apps.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/teams.net/teams.net/Tests/Microsoft.Teams.Apps.Tests/bin/Debug/net10.0/Microsoft.Teams.Apps.Tests.deps.json /home/REDACTED/work/teams.net/teams.net/Tests/Microsoft.Teams.Apps.Tests/bin/Debug/net10.0/testhost.dll --port 39019 --endpoint 127.0.0.1:039019 --role client --parentprocessid 4399 --telemetryoptedin false (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

singhk97 · 2026-02-13T18:27:17Z

Tests/Microsoft.Teams.Api.Tests/Activities/Invokes/SignIn/VerifyStateSignInActivityTests.cs

    }
+
+    [Fact]
+    public void setupSignInVerifyStateActivity_StateAsString()


@copilot remove this test case as it is redundant

Removed the redundant test case. The string state behavior is already covered by the existing tests. See commit 641a08c.

Co-authored-by: singhk97 <115390646+singhk97@users.noreply.github.com>

Initial plan

c1dc597

Copilot AI assigned Copilot and singhk97 Feb 12, 2026

Copilot started work on behalf of singhk97 February 12, 2026 17:54 View session

Copilot AI and others added 2 commits February 12, 2026 17:59

Fix SignIn VerifyState state deserialization to support both string a…

e432673

…nd object types Co-authored-by: singhk97 <115390646+singhk97@users.noreply.github.com>

Use JsonSerializer.Serialize for proper JSON formatting

e8db783

Co-authored-by: singhk97 <115390646+singhk97@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Fix JSON deserialization error in SignIn VerifyState activity~~ Support JSON object state values in SignIn VerifyState activities Feb 12, 2026

Copilot finished work on behalf of singhk97 February 12, 2026 18:05

Copilot AI requested a review from singhk97 February 12, 2026 18:05

singhk97 reviewed Feb 13, 2026

View reviewed changes

Copilot started work on behalf of singhk97 February 13, 2026 17:58 View session

singhk97 reviewed Feb 13, 2026

View reviewed changes

Copilot AI and others added 2 commits February 13, 2026 18:01

Use custom JsonConverter to keep State as string (non-breaking)

415b665

Co-authored-by: singhk97 <115390646+singhk97@users.noreply.github.com>

Prevent potential recursion in JsonSerializer.Serialize call

8381831

Co-authored-by: singhk97 <115390646+singhk97@users.noreply.github.com>

Copilot AI changed the title ~~Support JSON object state values in SignIn VerifyState activities~~ Support JSON object state values in SignIn VerifyState activities (non-breaking) Feb 13, 2026

Copilot AI requested a review from singhk97 February 13, 2026 18:05

Copilot finished work on behalf of singhk97 February 13, 2026 18:05

Copilot started work on behalf of singhk97 February 13, 2026 18:06 View session

Copilot finished work on behalf of singhk97 February 13, 2026 18:07

singhk97 reviewed Feb 13, 2026

View reviewed changes

Copilot started work on behalf of singhk97 February 13, 2026 18:27 View session

Remove redundant test case setupSignInVerifyStateActivity_StateAsString

641a08c

Co-authored-by: singhk97 <115390646+singhk97@users.noreply.github.com>

Copilot AI requested a review from singhk97 February 13, 2026 18:30

Copilot finished work on behalf of singhk97 February 13, 2026 18:30

rido-min mentioned this pull request Feb 25, 2026

Feat: add signin/failure invoke handling #347

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support JSON object state values in SignIn VerifyState activities (non-breaking)#329

Support JSON object state values in SignIn VerifyState activities (non-breaking)#329
Copilot wants to merge 6 commits intomainfrom
copilot/fix-signin-verifystate-json-error

Copilot AI commented Feb 12, 2026 •

edited

Loading

Uh oh!

singhk97 commented Feb 13, 2026

Uh oh!

singhk97 Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

singhk97 Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI commented Feb 13, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

singhk97 Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Copilot AI commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

singhk97 commented Feb 13, 2026

Uh oh!

singhk97 Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

singhk97 Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Feb 13, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

singhk97 Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Feb 12, 2026 •

edited

Loading