fix for glitchy tab completion test

Fixes #699

Author: starpit

app/content/js/repl.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corporation
+ * Copyright 2017-18 IBM Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -514,6 +514,23 @@ const emptyPromise = () => {
     return emptyPromise
 }
 
+/**
+ * Remove any .repl-temporary structures from the given dom
+ *
+ */
+const removeAnyTemps = block => {
+    const temps = block.querySelectorAll('.repl-temporary')
+
+    for (let idx = 0; idx < temps.length; idx++) {
+        const temp = temps[idx]
+        if (temp.parentNode) {
+            temp.parentNode.removeChild(temp)
+        }
+    }
+
+    return block
+}
+
 /** turn --foo into foo and -f into f */
 const unflag = opt => opt.replace(/^[-]+/,'')
 
@@ -561,6 +578,12 @@ self.exec = (commandUntrimmed, execOptions) => {
         nextBlock = execOptions && execOptions.nextBlock
     }
 
+    if (nextBlock) {
+        // remove any .repl-temporary that might've come along for the
+        // ride when we cloned the current block
+        removeAnyTemps(nextBlock)
+    }
+
     // blank line, after removing comments?
     const command = commandUntrimmed.trim().replace(patterns.commentLine, '')
     if (!command) {
@@ -973,7 +996,7 @@ self.paste = event => {
 self.doCancel = () => {
     debug('doCancel')
 
-    const block = ui.getCurrentProcessingBlock() || ui.getCurrentBlock(),
+    const block = removeAnyTemps(ui.getCurrentProcessingBlock() || ui.getCurrentBlock()),
           nextBlock = block.cloneNode(true),
           nextBlockPrompt = ui.getPrompt(nextBlock)
 

app/plugins/ui/commands/tab-completion.js

@@ -107,10 +107,17 @@ const listenForUpDown = prompt => {
 
     const previousKeyDown = prompt.onkeydown
     prompt.onkeydown = evt => { // keydown is necessary for evt.preventDefault() to work; keyup would otherwise also work
-        if (evt.keyCode === ui.keys.DOWN) {
+        const char = evt.keyCode
+
+        if (char === ui.keys.DOWN) {
             moveTo('nextSibling', evt)
-        } else if (evt.keyCode === ui.keys.UP) {
+
+        } else if (char === ui.keys.UP) {
             moveTo('previousSibling', evt)
+
+        } else if (char === ui.keys.C && event.ctrlKey) {
+            // Ctrl+C, cancel
+            repl.doCancel()
         }
     }
 
@@ -143,22 +150,6 @@ const listenForEscape = prompt => {
     return cleanup
 }
 
-/** safeguard: only one tab completion temporary at a time, please */
-const cleaner = () => {
-    const safeguard = document.querySelectorAll('.tab-completion-temporary')
-    for (let idx = 0; idx < safeguard.length; idx++) {
-        try {
-            console.error('removing glitch')
-            const old = safeguard[idx]
-            if (old.parentNode) {
-                old.parentNode.removeChid(safeguard)
-            }
-        } catch (err) {
-            console.error('error removing glitch', err)
-        }
-    }
-}
-
 /**
   * Make a container UI for tab completions
   *
@@ -167,7 +158,13 @@ const makeCompletionContainer = (block, prompt, partial, dirname, lastIdx) => {
     const input = block.querySelector('input')
 
     const temporaryContainer = document.createElement('div')
-    temporaryContainer.className = 'tab-completion-temporary scrollable fade-in'
+    temporaryContainer.className = 'tab-completion-temporary scrollable repl-temporary'
+
+    if (!process.env.RUNNING_SHELL_TEST) {
+        // see shell issue #699; chrome seems not to play the fade-in
+        // animation when the window is offscreen
+        temporaryContainer.classList.add('fade-in')
+    }
 
     // determine pixel width of current input value
     const tmp = document.createElement('div')

tests/lib/ui.js

@@ -298,7 +298,7 @@ exports.expectSubset = struct1 => string => {
 }
 
 /** is the given actual array the same as the given expected array? */
-exports.expectArray = expected => actual => {
+exports.expectArray = (expected, failFast=true) => actual => {
     if (!Array.isArray(actual)) {
         // webdriver.io's getText will return a singleton if there is only one match
         actual = [actual]
@@ -313,7 +313,11 @@ exports.expectArray = expected => actual => {
         console.error(`array mismatch; expected=${expected} actual=${actual}`)
     }
 
-    assert.ok(ok)
+    if (failFast) {
+        assert.ok(ok)
+    } else {
+        return ok
+    }
 }
 
 /**

tests/tests/passes/02/tab-completion.js

@@ -104,14 +104,7 @@ describe('Tab completion', function() {
                 }
             })
             .catch(err => this.app.client.execute('repl.doCancel()') // clear the line
-                   .then(() => {
-                       if (iter < 5) {
-                           console.error('retry', iter)
-                           return tabbyWithOptions(app, partial, expected, full, { click, nTabs, expectOK, iter: iter + 1 })
-                       } else {
-                           return common.oops(this)(err)
-                       }
-                   }))
+                   .then(() => common.oops(this)(err)))
     }
 
     const tabbyWithOptionsThenCancel = (app, partial, expected) => app.client.waitForExist(ui.selectors.CURRENT_PROMPT_BLOCK)
@@ -131,11 +124,11 @@ describe('Tab completion', function() {
     it('should have an active repl', () => cli.waitForRepl(this.app))
 
     // tab completion with options, then click on the second (idx=1) entry of the expected cmpletion list
-    it('should tab complete local file path', () => tabbyWithOptions(this.app,
-                                                                     'lls data/com',
-                                                                     options,
-                                                                     'lls data/composer-source/',
-                                                                     { click: 1 }))
+    it('should tab complete local file path with options', () => tabbyWithOptions(this.app,
+                                                                                  'lls data/com',
+                                                                                  options,
+                                                                                  'lls data/composer-source/',
+                                                                                  { click: 1 }))
 
     it('should tab complete the data directory', () => tabby(this.app, 'lls da', 'lls data/'))
     it('should tab complete the data/fsm.js file', () => tabby(this.app, 'lls data/fsm.js', 'lls data/fsm.json'))