@codewalla_india/openspec 1.3.2 → 1.3.3

package/dist/comprehension-quiz/quiz-executor.d.ts

@@ -7,7 +7,8 @@
  *
  * @module comprehension-quiz/quiz-executor
  */
-import type { Question, QuizResult } from './types.js';
+import type { QuizResult } from './types.js';
+import type { QuizQuestionStream } from './question-generator.js';
 /**
  * Quiz executor class
  *
@@ -17,54 +18,58 @@ import type { Question, QuizResult } from './types.js';
  */
 export declare class QuizExecutor {
     private state;
-    private currentQuestionIndex;
-    private questions;
-    private answers;
+    private totalQuestions;
+    private correctCount;
     private questionDisplayedAt;
-    private answerReceivedAt;
     private changeName;
     private attemptNumber;
+    /** Minimum ms the question must be visible before ANY input is accepted (FR-4, NFR-4). */
+    private static readonly DISPLAY_LOCK_MS;
+    /** Minimum ms between question display and a valid answer (FR-9). */
+    private static readonly MIN_ANSWER_MS;
     /**
-     * Execute quiz with given questions
+     * Execute quiz using an on-demand question stream.
      *
-     * @param questions - Array of questions to ask
+     * Questions are fetched one at a time from the stream — the next question is
+     * NOT fetched until the user has answered the current one. This means at most
+     * one Question object is in memory at any point, and its correctOption never
+     * appears in stdout.
+     *
+     * @param stream - QuizQuestionStream supplying one question per call
      * @param changeName - Name of the change being tested
      * @returns Quiz result with score and pass/fail status
      */
-    executeQuiz(questions: Question[], changeName: string): Promise<QuizResult>;
-    /**
-     * Transition to a new state
-     *
-     * @param newState - New state to transition to
-     */
+    executeQuiz(stream: QuizQuestionStream, changeName: string): Promise<QuizResult>;
     private transitionTo;
     /**
-     * Ask a question to the user
-     *
-     * @param questionIndex - Index of the question to ask
+     * Display a question to the user.
+     * Records the display timestamp for timing enforcement.
+     * correctOption is NOT printed — it stays in process memory only.
      */
-    private askQuestion;
+    private displayQuestion;
     /**
-     * Wait for user answer with timing constraints
+     * Collect a valid answer from stdin, looping until one is received.
      *
-     * Enforces a minimum 2-second wait time after question display before
-     * accepting input to prevent automated answering.
+     * Enforces:
+     *   - 4-second display lock: any input before 4s is silently discarded (FR-4 / NFR-4)
+     *   - Batch input rejection: multiple newline-separated values in one write → re-prompt
+     *   - Skip/show-all rejection: any non-option text → "Answer this question to continue."
+     *   - 2-second minimum read time: answers faster than 2s after display → re-prompt (FR-9)
      *
-     * @returns User's answer (1, 2, or 3), or -1 if invalid/too early
+     * @returns The user's selected option number (1, 2, or 3)
      */
-    private waitForAnswer;
+    private collectValidAnswer;
     /**
-     * Show feedback on the answer
-     *
-     * @param questionIndex - Index of the question
-     * @param answer - User's answer
+     * Read a single line from stdin without echoing the prompt.
+     * Uses raw mode to capture the full write in one shot so batch detection works.
      */
-    private showFeedback;
+    private readLine;
     /**
-     * Calculate quiz result
-     *
-     * @returns Quiz result with score and pass/fail status
+     * Show pass/fail feedback for a single answer.
+     * Does NOT reveal the correctOption number to stdout if the user was correct —
+     * only shows "Correct" or "Incorrect" with the correct option disclosed on wrong answers.
      */
-    private calculateResult;
+    private showFeedback;
+    private sleep;
 }
 //# sourceMappingURL=quiz-executor.d.ts.map

package/dist/comprehension-quiz/quiz-executor.js

@@ -19,147 +19,163 @@ import { getPassRecord } from './pass-record.js';
  */
 export class QuizExecutor {
     state = 'START';
-    currentQuestionIndex = 0;
-    questions = [];
-    answers = [];
+    totalQuestions = 0;
+    correctCount = 0;
     questionDisplayedAt = 0;
-    answerReceivedAt = 0;
     changeName = '';
     attemptNumber = 1;
+    /** Minimum ms the question must be visible before ANY input is accepted (FR-4, NFR-4). */
+    static DISPLAY_LOCK_MS = 4000;
+    /** Minimum ms between question display and a valid answer (FR-9). */
+    static MIN_ANSWER_MS = 2000;
     /**
-     * Execute quiz with given questions
+     * Execute quiz using an on-demand question stream.
      *
-     * @param questions - Array of questions to ask
+     * Questions are fetched one at a time from the stream — the next question is
+     * NOT fetched until the user has answered the current one. This means at most
+     * one Question object is in memory at any point, and its correctOption never
+     * appears in stdout.
+     *
+     * @param stream - QuizQuestionStream supplying one question per call
      * @param changeName - Name of the change being tested
      * @returns Quiz result with score and pass/fail status
      */
-    async executeQuiz(questions, changeName) {
-        this.questions = questions;
+    async executeQuiz(stream, changeName) {
         this.changeName = changeName;
-        this.currentQuestionIndex = 0;
-        this.answers = [];
+        this.totalQuestions = stream.total;
+        this.correctCount = 0;
         this.state = 'START';
-        // Track attempt number from existing pass record
         const existingRecord = await getPassRecord(changeName);
         this.attemptNumber = existingRecord ? existingRecord.attemptCount + 1 : 1;
-        // Track attempt start
         await trackComprehensionAttempt(changeName, this.attemptNumber);
-        // Start the quiz
-        await this.transitionTo('WAITING_FOR_QUESTION_1');
-        for (let i = 0; i < questions.length; i++) {
-            await this.askQuestion(i);
-            const answer = await this.waitForAnswer();
-            this.answers.push(answer);
-            await this.showFeedback(i, answer);
-            if (i < questions.length - 1) {
-                await this.transitionTo(`WAITING_FOR_QUESTION_${i + 2}`);
+        let questionIndex = 0;
+        while (stream.hasNext) {
+            await this.transitionTo(`WAITING_FOR_QUESTION_${questionIndex + 1}`);
+            // Fetch exactly one question — only now, not before
+            const question = await stream.next();
+            if (!question)
+                break;
+            this.displayQuestion(question, questionIndex);
+            // Loop until a valid answer is received (re-prompt on any invalid/early/batch/skip input)
+            const userAnswer = await this.collectValidAnswer(question);
+            await this.transitionTo('ACCEPTING_ANSWER');
+            if (userAnswer === question.correctOption + 1) {
+                this.correctCount += 1;
             }
+            await this.transitionTo('FEEDBACK');
+            this.showFeedback(question, userAnswer);
+            questionIndex += 1;
         }
         await this.transitionTo('DONE');
-        const result = this.calculateResult();
-        // Track completion
-        await trackComprehensionCompletion(changeName, result.scorePercent, result.passed ? 'pass' : 'fail', this.attemptNumber);
-        // If passed, emit apply_ready milestone
-        if (result.passed) {
+        const scorePercent = this.totalQuestions > 0
+            ? Math.round((this.correctCount / this.totalQuestions) * 100)
+            : 0;
+        const passed = scorePercent >= 80;
+        console.log(`\n${'─'.repeat(50)}`);
+        console.log(`Result: ${this.correctCount}/${this.totalQuestions} correct (${scorePercent}%)`);
+        console.log(passed ? '✓ PASS — apply is now unblocked.' : '✗ FAIL — retry to proceed.');
+        console.log('─'.repeat(50));
+        await trackComprehensionCompletion(changeName, scorePercent, passed ? 'pass' : 'fail', this.attemptNumber);
+        if (passed) {
             await trackApplyReady(changeName);
         }
-        return result;
+        return {
+            correct: this.correctCount,
+            total: this.totalQuestions,
+            scorePercent,
+            passed,
+            attemptNumber: this.attemptNumber,
+        };
     }
-    /**
-     * Transition to a new state
-     *
-     * @param newState - New state to transition to
-     */
     async transitionTo(newState) {
         this.state = newState;
     }
     /**
-     * Ask a question to the user
-     *
-     * @param questionIndex - Index of the question to ask
+     * Display a question to the user.
+     * Records the display timestamp for timing enforcement.
+     * correctOption is NOT printed — it stays in process memory only.
      */
-    async askQuestion(questionIndex) {
-        const question = this.questions[questionIndex];
-        console.log(`\nQuestion ${questionIndex + 1}/${this.questions.length}:`);
+    displayQuestion(question, index) {
+        console.clear();
+        console.log(`Question ${index + 1} of ${this.totalQuestions}\n`);
         console.log(question.text);
         console.log('');
-        console.log('1)', question.options[0]);
-        console.log('2)', question.options[1]);
-        console.log('3)', question.options[2]);
+        console.log(`  1)  ${question.options[0]}`);
+        console.log(`  2)  ${question.options[1]}`);
+        console.log(`  3)  ${question.options[2]}`);
         console.log('');
         this.questionDisplayedAt = Date.now();
     }
     /**
-     * Wait for user answer with timing constraints
+     * Collect a valid answer from stdin, looping until one is received.
      *
-     * Enforces a minimum 2-second wait time after question display before
-     * accepting input to prevent automated answering.
+     * Enforces:
+     *   - 4-second display lock: any input before 4s is silently discarded (FR-4 / NFR-4)
+     *   - Batch input rejection: multiple newline-separated values in one write → re-prompt
+     *   - Skip/show-all rejection: any non-option text → "Answer this question to continue."
+     *   - 2-second minimum read time: answers faster than 2s after display → re-prompt (FR-9)
      *
-     * @returns User's answer (1, 2, or 3), or -1 if invalid/too early
+     * @returns The user's selected option number (1, 2, or 3)
      */
-    async waitForAnswer() {
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout,
-        });
-        const answer = await new Promise((resolve) => {
-            rl.question('', (answer) => {
+    async collectValidAnswer(question) {
+        while (true) {
+            const elapsed = Date.now() - this.questionDisplayedAt;
+            if (elapsed < QuizExecutor.DISPLAY_LOCK_MS) {
+                // Still within the 4-second display lock — wait out the remainder silently
+                await this.sleep(QuizExecutor.DISPLAY_LOCK_MS - elapsed);
+            }
+            const raw = await this.readLine();
+            const answerReceivedAt = Date.now();
+            // Reject batch input: more than one non-empty line in a single write
+            if (raw.includes('\n') && raw.split('\n').filter((l) => l.trim()).length > 1) {
+                console.log('Answer this question to continue.');
+                continue;
+            }
+            const trimmed = raw.trim();
+            // Reject empty, skip commands, show-all, or anything not "1" / "2" / "3"
+            if (trimmed === '' || !['1', '2', '3'].includes(trimmed)) {
+                console.log('Answer this question to continue.');
+                continue;
+            }
+            // Enforce minimum 2-second read time after question was displayed
+            const timeSinceDisplay = answerReceivedAt - this.questionDisplayedAt;
+            if (timeSinceDisplay < QuizExecutor.MIN_ANSWER_MS) {
+                console.log('Answer this question to continue.');
+                continue;
+            }
+            return parseInt(trimmed, 10);
+        }
+    }
+    /**
+     * Read a single line from stdin without echoing the prompt.
+     * Uses raw mode to capture the full write in one shot so batch detection works.
+     */
+    readLine() {
+        return new Promise((resolve) => {
+            const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+            rl.question('Enter 1, 2, or 3: ', (answer) => {
                 rl.close();
-                const trimmed = answer.trim();
-                // Check if answer was submitted too early (less than 2 seconds after question display)
-                const timeSinceDisplay = Date.now() - this.questionDisplayedAt;
-                if (timeSinceDisplay < 2000) {
-                    console.log('Answer submitted too early. Please wait at least 2 seconds before answering.');
-                    resolve(-1);
-                    return;
-                }
-                // Validate input
-                if (trimmed === '1' || trimmed === '2' || trimmed === '3') {
-                    resolve(parseInt(trimmed, 10));
-                }
-                else {
-                    console.log('Answer this question to continue.');
-                    resolve(-1);
-                }
+                resolve(answer);
             });
         });
-        return answer;
     }
     /**
-     * Show feedback on the answer
-     *
-     * @param questionIndex - Index of the question
-     * @param answer - User's answer
+     * Show pass/fail feedback for a single answer.
+     * Does NOT reveal the correctOption number to stdout if the user was correct —
+     * only shows "Correct" or "Incorrect" with the correct option disclosed on wrong answers.
      */
-    async showFeedback(questionIndex, answer) {
-        const question = this.questions[questionIndex];
-        const isCorrect = answer === question.correctOption + 1;
+    showFeedback(question, userAnswer) {
+        const isCorrect = userAnswer === question.correctOption + 1;
         if (isCorrect) {
-            console.log('✓ Correct');
+            console.log('\n✓ Correct\n');
         }
         else {
-            console.log('✗ Incorrect');
-            console.log(`The correct answer was ${question.correctOption + 1}`);
+            console.log('\n✗ Incorrect');
+            console.log(`  The correct answer was option ${question.correctOption + 1}.\n`);
         }
-        // Clear terminal screen
-        console.clear();
     }
-    /**
-     * Calculate quiz result
-     *
-     * @returns Quiz result with score and pass/fail status
-     */
-    calculateResult() {
-        const correct = this.answers.filter((answer, index) => answer === this.questions[index].correctOption + 1).length;
-        const total = this.questions.length;
-        const scorePercent = Math.round((correct / total) * 100);
-        return {
-            correct,
-            total,
-            scorePercent,
-            passed: scorePercent >= 80,
-            attemptNumber: 1, // TODO: Track attempt count
-        };
+    sleep(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
     }
 }
 //# sourceMappingURL=quiz-executor.js.map

package/dist/comprehension-quiz/types.d.ts

@@ -72,6 +72,28 @@ export interface LLMProvider {
      * @returns Array of generated questions
      */
     generateQuestions(artifactContent: string, questionCount: number, artifactType: 'proposal' | 'design' | 'specs' | 'plan' | 'tasks'): Promise<Question[]>;
+    /**
+     * Generate a single quiz question on-demand from artifact content.
+     *
+     * This method MUST be used during quiz execution to fetch one question at a time.
+     * The correct answer index is included in the returned Question object so the CLI
+     * process can validate the user's answer locally. The correct answer MUST NOT be
+     * included in any conversational context or stdout — it stays in process memory only.
+     *
+     * The LLM prompt used by implementors MUST:
+     *   1. Ask for exactly ONE question, not a list or array.
+     *   2. Return a JSON object with: text, options (3 strings), correctOption (0-2), artifactSource.
+     *   3. NEVER ask the LLM to explain the answer or include the answer text in any prose.
+     *   4. Use a system message that forbids the model from listing multiple questions.
+     *
+     * @param artifactContent - The content of the artifact to generate from
+     * @param artifactType - Type of artifact (proposal, design, specs, plan, tasks)
+     * @param questionIndex - 0-based index of this question in the quiz (for diversity)
+     * @param totalQuestions - Total number of questions in the quiz (for context)
+     * @param previousQuestionTexts - Texts of already-asked questions to avoid duplicates
+     * @returns A single generated question (text + options + correctOption + artifactSource)
+     */
+    generateSingleQuestion(artifactContent: string, artifactType: 'proposal' | 'design' | 'specs' | 'plan' | 'tasks', questionIndex: number, totalQuestions: number, previousQuestionTexts: string[]): Promise<Question>;
     /**
      * Validate provider configuration
      * @throws Error if configuration is invalid