Disable UI interaction while generating tests

jppellet · jppellet · commit 56104face1f9 · 2025-02-06T09:41:14.000+01:00
diff --git a/simulator/src/ComponentFactory.ts b/simulator/src/ComponentFactory.ts
@@ -514,19 +514,26 @@ export class ComponentFactory {
             return ""
         }
 
-        // TODO switch mode just like for running test cases
-        const testCases: TestCaseCombinational[] = []
-        for (let i = 0; i < numCases; i++) {
-            for (let j = 0; j < numInputs; j++) {
-                const value = (i & (1 << j)) !== 0
-                setBit(j, value)
+        const result = await editor.disableUIWhile(s.ComputingTestCases, async restoreAfter => {
+            for (const input of inputs) {
+                restoreAfter.set(input, input.value)
             }
-            editor.recalcPropagateAndDrawIfNeeded(true)
-            await editor.waitForPropagation()
-            testCases.push(this.makeTestCaseWithCurrentValues(editor, inputs, outputs, false))
-        }
 
-        return testCases
+            const testCases: TestCaseCombinational[] = []
+            for (let i = 0; i < numCases; i++) {
+                for (let j = 0; j < numInputs; j++) {
+                    const value = (i & (1 << j)) !== 0
+                    setBit(j, value)
+                }
+                editor.recalcPropagateAndDrawIfNeeded(true)
+                await editor.waitForPropagation()
+                testCases.push(this.makeTestCaseWithCurrentValues(editor, inputs, outputs, false))
+            }
+
+            return testCases
+        })
+
+        return result ?? ""
     }
 
     public tryModifyCustomComponent(def: CustomComponentDef, defRoot: CustomComponent): undefined | string {
diff --git a/simulator/src/LogicEditor.ts b/simulator/src/LogicEditor.ts
@@ -206,7 +206,7 @@ export class LogicEditor extends HTMLElement implements DrawableParent {
     private _isSingleton = false
     private _maxInstanceMode: Mode = MAX_MODE_WHEN_EMBEDDED // can be set later
     private _isDirty = false
-    private _isRunningTests = false
+    private _isUIDisabled = false // when inputs are being set programmatically over a longer period
     private _mode: Mode = DEFAULT_MODE
     private _initialData: InitialData | undefined = undefined
     private _options: EditorOptions = { ...DEFAULT_EDITOR_OPTIONS }
@@ -1035,8 +1035,7 @@ export class LogicEditor extends HTMLElement implements DrawableParent {
             }
             this.html.rootDiv.setAttribute(ATTRIBUTE_NAMES.nomodes, nomodes.join(" "))
 
-
-            // console.log(`Display/interaction is ${wantedModeStr} - ${mode}`)
+            // console.log(`Current mode is ${modeStr} - ${mode}`)
 
             this.editTools.redrawMgr.addReason("mode changed", null, true)
 
@@ -1741,26 +1740,45 @@ export class LogicEditor extends HTMLElement implements DrawableParent {
         }
     }
 
-    public async runTestSuite(testSuite: TestSuite, options?: { doLog?: boolean, fast?: boolean }): Promise<TestSuiteResults | undefined> {
-
-        if (this._isRunningTests) {
+    public async disableUIWhile<T>(message: string, action: (restoreAfter: Map<Input, LogicValue[]>) => Promise<T>): Promise<T | undefined> {
+        if (this._isUIDisabled) {
             // cannot run tests while already running
             return undefined
         }
 
+        this._isUIDisabled = true
+        const oldMode = this.mode
+        const restoreAfter = new Map<Input, LogicValue[]>()
+        const hideMsg = this.showMessage(message, 0)
+
+        try {
+            this.setMode(Mode.STATIC, false)
+            const result = await action(restoreAfter)
+            return result
+        } finally {
+            hideMsg()
+            this.setMode(oldMode, true)
+            for (const [input, value] of restoreAfter) {
+                input.setValue(value)
+            }
+            this._isUIDisabled = false
+            this.recalcPropagateAndDrawIfNeeded()
+        }
+
+    }
+
+    public async runTestSuite(testSuite: TestSuite, options?: { doLog?: boolean, fast?: boolean }): Promise<TestSuiteResults | undefined> {
+
         const palette = this.editTools.testsPalette
         if (palette === undefined) {
             return undefined
         }
 
-        this._isRunningTests = true
-        const oldMode = this.mode
         const fast = options?.fast ?? false
         const doLog = options?.doLog ?? false
-        const allOldInValues = new Map<Input, LogicValue[]>()
 
-        try {
-            this.setMode(Mode.STATIC, false)
+        return this.disableUIWhile(S.Messages.RunningTests, async restoreAfter => {
+
             this.setTestsPaletteVisible(true) // after setMode, which may hide it
 
             const results = new TestSuiteResults(testSuite)
@@ -1785,8 +1803,8 @@ export class LogicEditor extends HTMLElement implements DrawableParent {
                     const [oldInValues, result] = await this.runTestCase(testCase, testSuite, doLog)
                     testCaseResult = result
                     for (const [input, value] of oldInValues) {
-                        if (!allOldInValues.has(input)) {
-                            allOldInValues.set(input, value)
+                        if (!restoreAfter.has(input)) {
+                            restoreAfter.set(input, value)
                         }
                     }
                 }
@@ -1797,15 +1815,7 @@ export class LogicEditor extends HTMLElement implements DrawableParent {
                 }
             }
             return results
-
-        } finally {
-            this.setMode(oldMode, true)
-            for (const [input, value] of allOldInValues) {
-                input.setValue(value)
-            }
-            this._isRunningTests = false
-            this.recalcPropagateAndDrawIfNeeded()
-        }
+        })
     }
 
     public trySetInputsAndRecalc(inputs: TestCaseValueMap<Input>) {
@@ -1825,12 +1835,10 @@ export class LogicEditor extends HTMLElement implements DrawableParent {
         doLog: boolean
     ): Promise<[Map<Input, LogicValue[]>, TestCaseResult]> {
 
-        const fullTestNameParts = [sourceSuite.name, testCase.name].filter(Boolean)
-        const fullTestName = fullTestNameParts.length === 0 ? S.Tests.DefaultTestCaseName : fullTestNameParts.join("/")
-        const msg = S.Messages.RunningTestCase.expand({ name: fullTestName })
-        const hideMsg = this.showMessage(msg, 0)
         if (doLog) {
-            console.group(msg)
+            const fullTestNameParts = [sourceSuite.name, testCase.name].filter(Boolean)
+            const fullTestName = fullTestNameParts.length === 0 ? S.Tests.DefaultTestCaseName : fullTestNameParts.join("/")
+            console.group("Running test case " + fullTestName)
         }
 
         testCase.tryFixReferences(this.editorRoot.components)
@@ -1874,7 +1882,6 @@ export class LogicEditor extends HTMLElement implements DrawableParent {
             if (doLog) {
                 console.groupEnd()
             }
-            hideMsg()
         }
     }
 
diff --git a/simulator/src/TestsPalette.ts b/simulator/src/TestsPalette.ts
@@ -190,8 +190,10 @@ export class TestSuiteUI {
     }
 
     private makeComponentRefSpan(elem: Input | Output | string): HTMLElement {
-        const ref = isString(elem) ? elem : elem.ref ?? "?"
-        const link = a(ref, href("#")).render()
+        const compStr = isString(elem) ? elem
+            : isString(elem.name) ? elem.name
+                : elem.ref ?? "?"
+        const link = a(compStr, href("#")).render()
         link.addEventListener("click", () => {
             this.editor.highlight(elem)
         })
diff --git a/simulator/src/strings.ts b/simulator/src/strings.ts
@@ -236,13 +236,14 @@ const Strings_fr = {
         NothingToUndo: "Rien à annuler",
         NothingToRedo: "Rien à rétablir ou répéter",
 
-        RunningTestCase: template("Exécution du test ${name}..."),
         NewTestCaseTitle: "Création d’un nouveau test de circuit",
         NewTestCaseSetName: "Entrez le nom du test:",
         TestCaseInputToSet: template("Entrée$s{n} à régler:"),
         TestCaseOuputToCheck: template("Sorties$s{n} attendue$s{n}:"),
         TooManyInputsForAutoTestCases: template("Impossible de créer automatiquement des tests pour plus de ${max} entrées."),
         AutoTestCasesWarning: template("Ceci va créer ${numCases} tests, un pour chacune des combinaisons des ${numInputs} entrées. Voulez-vous continuer?"),
+        ComputingTestCases: "Génération des tests…",
+        RunningTests: "Excécution des tests…",
 
     },
     Components: {
@@ -1022,13 +1023,14 @@ const Strings_en: Strings = {
         NothingToUndo: "Nothing to undo",
         NothingToRedo: "Nothing to redo or repeat",
 
-        RunningTestCase: template("Running test case ${name}..."),
         NewTestCaseTitle: "Create a new test case",
         NewTestCaseSetName: "Enter the name of the new test case:",
         TestCaseInputToSet: template("Input$s{n} to set:"),
         TestCaseOuputToCheck: template("Output$s{n} to check:"),
         TooManyInputsForAutoTestCases: template("Cannot create test cases automatically for more than ${max} inputs."),
         AutoTestCasesWarning: template("This will create ${numCases} test cases, one for each combination of the ${numInputs} inputs. Do you want to continue?"),
+        ComputingTestCases: "Generating test cases…",
+        RunningTests: "Running test cases…",
 
     },
     Components: {
