ForeachElement Does not Re-prompt

[karrimrabibiomni]

Version

4.16.0

Describe the bug

We are running an InputDialog inside an Adaptive For each, another dialog is then run proactively when that proactive dialog has finished then input dialog resumes and Re-prompts the user where they were left before.

Since upgrading to 4.16.0 we noticed that ForEach is Obsolete using the new ForEachElement the above behaviour no longer exists and the InputDialog is not re-prompted.

Expected behaviour

The same re-prompting behaviour to be in the ForEachElement that was in the older ForEach.

Screenshots

Conversation with the old ForEach :

Here is 4.16.0 ForEachElement without re-prompt:

[breakingram]

Hey @karrimrabibiomni -- Thanks for reaching out.

For clarity, could you please share the steps to reproduce this issue? I will attempt to reproduce from my end.
Also, are you able to share your dialog code?

[karrimrabibiomni]

Here is a simple bot that recreates the issue:
BotForeachRepromptBug.zip

[EricDahlvang]

Hi @karrimrabibiomni

Thank you for the repro project! This PR adds reprompt support to ForEachElement, with a unit test of the repro you've provided: #6325

edit:
The below implementation can be used if a workaround is required until this bug is patched:

private class ForEachElementEx : ForEachElement
        {
            /// <inheritdoc/>
            public override async Task<bool> OnDialogEventAsync(DialogContext dc, DialogEvent e, CancellationToken cancellationToken)
            {
                var handled = await base.OnDialogEventAsync(dc, e, cancellationToken).ConfigureAwait(false);
                if (!handled && e?.Name == DialogEvents.RepromptDialog)
                {
                    var childState = GetActionScopeState(dc);
                    var childDc = CreateChildContext(dc, childState);
                    await childDc.RepromptDialogAsync(cancellationToken).ConfigureAwait(false);
                    handled = true;
                }
                return handled;
            }
            private DialogContext CreateChildContext(DialogContext dc, DialogState childDialogState)
            {
                var childDc = new DialogContext(new DialogSet().Add(new ActionScope(this.Actions)), dc.Parent ?? dc, childDialogState);
                childDc.Parent = dc.Parent;
                if (dc.Services != null)
                {
                    foreach (var service in dc.Services)
                    {
                        childDc.Services[service.Key] = service.Value;
                    }
                }
                return childDc;
            }
            private DialogState GetActionScopeState(DialogContext dc)
            {
                const string ActionScopeState = "this.actionScopeState";
                DialogState state = null;
                var activeDialogState = dc.ActiveDialog?.State as Dictionary<string, object>;
                if (activeDialogState != null && activeDialogState.TryGetValue(ActionScopeState, out var currentState))
                {
                    state = currentState as DialogState;
                }
                if (state == null)
                {
                    state = new DialogState();
                    if (activeDialogState != null)
                    {
                        activeDialogState[ActionScopeState] = state;
                    }
                }
                return state;
            }
        }