Dialogs.OAuthPrompt.GetUserTokenAsync bugfix

[mark-szabo]

Fixing a ArgumentNullException bug which is triggered if I call the Dialogs.OAuthPrompt.GetUserTokenAsync after a non-text message (ex. button click), and context.Activity.Text is not set.

[cleemullins]

@mark-szabo Thanks! This looks good to me, but a code change means there should be a new Unit Test validating the old & behavior. Are you able to add that unit test?

@johnataylor Can you confirm the behaivor in the JS SDK? We should have the same behavior here, and I'm not sure which behavior is correct. Certainly the bug that Mark fixed here looks like a clear-cut bug.

[mark-szabo]

Hi @cleemullins sadly I don't have a dev env for botbuilder-dotnet, so it'd take time... If it's not fitting into your schedule, I'll do it as soon as I have time to set up a dev env and get familiar with your unit tests.

[cleemullins]

Thanks @mark-szabo. The unit tests should be pretty straight forward. There is already a file that has tests for that area ("[filename]Tests.cs")

[mark-szabo]

HI @cleemullins, I have started to write a unit test for this but I think that's sadly not possible for this specific method.

Here is the test I wrote:

[TestClass]
public class OAuthPromptTests
{
    [TestMethod]
    public async Task OAuthPromptShouldNotThrowWhenNonTextMessage()
    {
        var convoState = new ConversationState(new MemoryStorage());
        var dialogState = convoState.CreateProperty<DialogState>("dialogState");

        var adapter = new TestAdapter()
            .Use(new AutoSaveStateMiddleware(convoState));

        var dialogs = new DialogSet(dialogState);

        var prompt = new OAuthPrompt(
            "TestOAuthPrompt",
            new OAuthPromptSettings
            {
                ConnectionName = "adal",
                Text = "Click to sign in!",
                Title = "Sign in",
                Timeout = 300000, // User has 5 minutes to login (1000 * 60 * 5)
            });

        dialogs.Add(prompt);

        var activity = new Activity { Type = ActivityTypes.Message, Value = 2 };

        await new TestFlow(adapter, async (turnContext, cancellationToken) =>
        {
            var dc = await dialogs.CreateContextAsync(turnContext, cancellationToken);

            var tokenResponse = prompt.GetUserTokenAsync(dc.Context, cancellationToken);

            var results = await dc.ContinueDialogAsync(cancellationToken);

            if (results.Status == DialogTurnStatus.Waiting)
            {
                await turnContext.SendActivityAsync("Test complete.");
            }
        })
        .Send(activity)
        .AssertReply("Test complete.")
        .StartTestAsync();
    }
}

The issue is that the TestAdapter adapter is not a BotFrameworkAdapter which OAuthPrompt.GetUserToken() expects:
https://github.com/Microsoft/botbuilder-dotnet/blob/2f73c35c1a06705b811e108321fadacda059210e/libraries/Microsoft.Bot.Builder.Dialogs/Prompts/OAuthPrompt.cs#L187-L190

[cleemullins]

Thanks. I've merged this in. This should show up on the daily build server tonight, and will ship as part of our 4.3 release in mid-feb.

[mark-szabo]

Awesome, thanks @cleemullins! 😉