Suggestion for on-responded on prompts

On issue microsoft#3947, relying on the responded flag todecide whether to show the prompt interferes with logic that could be happening either

a. Concurrently
b. On some middleware
c. As part of how we reached the prompt

I believe the *intention* is to prevent sending a prompt twice to the user, using a symbol may be enough for that, without relying on global status

libraries/botbuilder-dialogs/src/prompts/prompt.ts

@@ -172,6 +172,28 @@ export abstract class Prompt<T> extends Dialog {
      */
     protected constructor(dialogId: string, private validator?: PromptValidator<T>) {
         super(dialogId);
+
+        if (!validator) validator = async (prompt) => prompt.recognized.succeeded;
+
+        this.validator = async (prompt) => {
+            const context = prompt.context;
+
+            const hasRespondedBeforeValidator = context.responded;
+            // Making the validator *only* consider as "responded" if responded has been set during a turn
+            // @ts-expect-error 
+            context._respondedRef.responded = false;
+            try {
+                const result = await validator(prompt);
+                const shouldReprompt = context.turnState.get(Prompt.shouldReprompt);
+                if (shouldReprompt == null) Prompt.setRepromptStatus(context, !context.responded);
+                return result;
+            } finally {
+                if (hasRespondedBeforeValidator) prompt.context.responded = true;
+            }
+        }
+
+
+
     }
 
     /**
@@ -206,6 +228,38 @@ export abstract class Prompt<T> extends Dialog {
         return Dialog.EndOfTurn;
     }
 
+    /**
+     * By default the bot re-prompts if there has not been any message sent to this user in this turn
+     * 
+     * However, that might be undesirable, you can set here whether you want it to reprompt or not.
+     * 
+     * To reset to the default status, you can set it back to undefined or null.
+     * @param context 
+     * @param shouldReprompt 
+     */
+    static setRepromptStatus(context:TurnContext, shouldReprompt: boolean | undefined | null = true) {
+        context.turnState.set(this.shouldReprompt, shouldReprompt);
+    }
+
+    /**
+     * How is determined if the prompt is retried, by default it checks whether the context.responded is false or not
+     * 
+     * You can change that behaviour by either (a) extending this function on your base class or (b)
+     * @param context 
+     * @returns 
+     */
+    protected shouldReprompt(context: TurnContext): boolean {
+        const shouldReprompt = context.turnState.get(Prompt.shouldReprompt);
+        if (shouldReprompt == null) return !context.responded;
+        return shouldReprompt;
+    }
+
+
+    /**
+     * Optional symbol to be used to *force* the context whether to reprompt or not based on the flag
+     */
+    private static shouldReprompt = Symbol('shouldReprompt');
+
     /**
      * Called when a prompt dialog is the active dialog and the user replied with a new activity.
      * @param dc The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation.
@@ -238,28 +292,26 @@ export abstract class Prompt<T> extends Dialog {
 
         // Validate the return value
         let isValid = false;
-        if (this.validator) {
-            if (state.state['attemptCount'] === undefined) {
-                state.state['attemptCount'] = 0;
-            }
-            isValid = await this.validator({
-                context: dc.context,
-                recognized: recognized,
-                state: state.state,
-                options: state.options,
-                attemptCount: ++state.state['attemptCount'],
-            });
-        } else if (recognized.succeeded) {
-            isValid = true;
+
+        if (state.state['attemptCount'] === undefined) {
+            state.state['attemptCount'] = 0;
         }
+        isValid = await this.validator({
+            context: dc.context,
+            recognized: recognized,
+            state: state.state,
+            options: state.options,
+            attemptCount: ++state.state['attemptCount'],
+        });
+
 
         // Return recognized value or re-prompt
         if (isValid) {
             return await dc.endDialog(recognized.value);
         } else {
-            if (!dc.context.responded) {
+            if (this.shouldReprompt(dc.context)) {
                 await this.onPrompt(dc.context, state.state, state.options, true);
-            }
+            } 
 
             return Dialog.EndOfTurn;
         }

libraries/botbuilder-dialogs/tests/textPrompt.test.js

@@ -1,5 +1,5 @@
 const { ActivityTypes, ConversationState, MemoryStorage, TestAdapter } = require('botbuilder-core');
-const { DialogSet, TextPrompt, DialogTurnStatus } = require('../');
+const { DialogSet, TextPrompt, DialogTurnStatus, Prompt } = require('../');
 const assert = require('assert');
 const lineReader = require('line-reader');
 const path = require('path');
@@ -191,5 +191,115 @@ describe('TextPrompt', function() {
             .send('test')
             .assertReply('test')
             .startTest();
+    });    
+
+    it('should send retryPrompt when a message is sent before validation.', async function() {
+
+        const alwaysSentMessage = 'Working on your answer, hold on a second.'
+        const adapter = new TestAdapter(async (turnContext) => {
+            await turnContext.sendActivity(alwaysSentMessage);
+            const dc = await dialogs.createContext(turnContext);
+
+            const results = await dc.continueDialog();
+            if (results.status === DialogTurnStatus.empty) {
+                await dc.prompt('prompt', { prompt: 'Please say something.', retryPrompt: 'Text is required.' });
+            } else if (results.status === DialogTurnStatus.complete) {
+                const reply = results.result;
+                await turnContext.sendActivity(reply);
+            }
+            await convoState.saveChanges(turnContext);
+        });
+
+        const convoState = new ConversationState(new MemoryStorage());
+
+        const dialogState = convoState.createProperty('dialogState');
+        const dialogs = new DialogSet(dialogState);
+        dialogs.add(new TextPrompt('prompt'));
+
+        await adapter.send('Hello')
+            .assertReply(alwaysSentMessage)
+            .assertReply('Please say something.')
+            .send(invalidMessage)
+            .assertReply(alwaysSentMessage)
+            .assertReply('Text is required.')
+            .send('test')
+            .assertReply(alwaysSentMessage)
+            .assertReply('test')
+            .startTest();
+
+    });    
+
+    it('should not send retryPrompt if  promptStatus is false.', async function() {
+
+        const alwaysSentMessage = 'Working on your answer, hold on a second.'
+        const adapter = new TestAdapter(async (turnContext) => {
+            await turnContext.sendActivity(alwaysSentMessage);
+            Prompt.setRepromptStatus(turnContext, false);
+            const dc = await dialogs.createContext(turnContext);
+
+            const results = await dc.continueDialog();
+            if (results.status === DialogTurnStatus.empty) {
+                await dc.prompt('prompt', { prompt: 'Please say something.', retryPrompt: 'Text is required.' });
+            } else if (results.status === DialogTurnStatus.complete) {
+                const reply = results.result;
+                await turnContext.sendActivity(reply);
+            }
+            await convoState.saveChanges(turnContext);
+        });
+
+        const convoState = new ConversationState(new MemoryStorage());
+
+        const dialogState = convoState.createProperty('dialogState');
+        const dialogs = new DialogSet(dialogState);
+        dialogs.add(new TextPrompt('prompt'));
+
+        await adapter.send('Hello')
+            .assertReply(alwaysSentMessage)
+            .assertReply('Please say something.')
+            .send(invalidMessage)
+            .assertReply(alwaysSentMessage)
+            .send('test')
+            .assertReply(alwaysSentMessage)
+            .assertReply('test')
+            .startTest();
+
+    });
+
+    it('should send retryPrompt even if validator replies when RepromptStatus is true', async function() {
+        const adapter = new TestAdapter(async (turnContext) => {
+            const dc = await dialogs.createContext(turnContext);
+
+            const results = await dc.continueDialog();
+            if (results.status === DialogTurnStatus.empty) {
+                await dc.prompt('prompt', { prompt: 'Please say something.', retryPrompt: 'Text is required.' });
+            } else if (results.status === DialogTurnStatus.complete) {
+                const reply = results.result;
+                await turnContext.sendActivity(reply);
+            }
+            await convoState.saveChanges(turnContext);
+        });
+
+        const convoState = new ConversationState(new MemoryStorage());
+
+        const dialogState = convoState.createProperty('dialogState');
+        const dialogs = new DialogSet(dialogState);
+        dialogs.add(new TextPrompt('prompt', async (prompt) => {
+            assert(prompt);
+            Prompt.setRepromptStatus(prompt.context, true)
+            const valid = prompt.recognized.value.length >= 3;
+            if (!valid) {
+                await prompt.context.sendActivity('too short');
+            }
+            return valid;
+        }));
+
+        await adapter.send('Hello')
+            .assertReply('Please say something.')
+            .send('i')
+            .assertReply('too short')
+            .assertReply('Text is required.')
+            .send('test')
+            .assertReply('test')
+            .startTest();
     });
 });