Vim mode experimental

.github/FUNDING.yml

@@ -1,4 +1,3 @@
 # These are supported funding model platforms
 
-github: [tombh]
 patreon: browsh

.travis.yml

@@ -40,8 +40,8 @@ script:
   - cd $REPO_ROOT/interfacer && go test test/tty/*.go -v -ginkgo.slowSpecThreshold=30 -ginkgo.flakeAttempts=3
   - cd $REPO_ROOT/interfacer && go test test/http-server/*.go -v -ginkgo.slowSpecThreshold=30 -ginkgo.flakeAttempts=3
 after_failure:
-  - cat $REPO_ROOT/interfacer/test/tty/debug.log | curl -F 'f:1=<-' ix.io
-  - cat $REPO_ROOT/interfacer/test/http-server/debug.log | curl -F 'f:1=<-' ix.io
+  - cat $REPO_ROOT/interfacer/test/tty/debug.log
+  - cat $REPO_ROOT/interfacer/test/http-server/debug.log
 after_success:
   - $REPO_ROOT/contrib/release_if_new_version.sh
 

README.md

@@ -67,12 +67,12 @@ with symlinks. Anyway, to install the dependencies use: `dep ensure` inside the
 
 Then the ideal setup for development is:
   * have Webpack watch the JS code so that it rebuilds automatically:
-    `webpack --watch`
+    `webext> webpack --watch`
   * run the CLI client without giving it the responsibility to launch Firefox:
     `go run ./interfacer/src/main.go --firefox.use-existing --debug`
   * have Mozilla's handy `web-ext` tool run Firefox and reinstall the
     webextension everytime webpack rebuilds it: (in `webext/dist`)
-    `web-ext run --verbose`
+    `webext/dist> web-ext run --verbose`
 
 For generic Linux systems you can follow [this guide](https://github.com/browsh-org/browsh/blob/master/contrib/setup_linux_build_environment.md) on how to setup a build environment, that you may be able to adapt for other systems as well.
 

interfacer/src/browsh/browsh.go

@@ -3,6 +3,7 @@ package browsh
 import (
 	"encoding/base64"
 	"fmt"
+	"time"
 	"io/ioutil"
 	"net/url"
 	"os"
@@ -23,7 +24,7 @@ import (
 
 var (
 	logo = `
-////  ////
+ ////  ////
  / /   / /
  //    //
  //    //    ,,,,,,,,
@@ -72,7 +73,7 @@ func Log(msg string) {
 		}
 		defer f.Close()
 
-		msg = msg + "\n"
+		msg = time.Now().Format("01-02T15:04:05.999 ") + msg + "\n"
 		if _, wErr := f.WriteString(msg); wErr != nil {
 			Shutdown(wErr)
 		}

interfacer/src/browsh/comms.go

@@ -91,7 +91,7 @@ func handleWebextensionCommand(message []byte) {
 	case "/link_hints":
 		parseJSONLinkHints(strings.Join(parts[1:], ","))
 	default:
-		Log("WEBEXT: " + string(message))
+		Log("IGNORE " + string(message))
 	}
 }
 
@@ -130,7 +130,7 @@ func webSocketWriter(ws *websocket.Conn) {
 	defer ws.Close()
 	for {
 		message = <-stdinChannel
-		Log(fmt.Sprintf("TTY sending: %s", message))
+		// chatty Log(fmt.Sprintf("TTY sending: %s", message))
 		if err := ws.WriteMessage(websocket.TextMessage, []byte(message)); err != nil {
 			if err == websocket.ErrCloseSent {
 				Log("Socket writer detected that the browser closed the websocket")

interfacer/src/browsh/firefox.go

@@ -81,7 +81,7 @@ func startHeadlessFirefox() {
 	}
 	in := bufio.NewScanner(stdout)
 	for in.Scan() {
-		Log("FF-CONSOLE: " + in.Text())
+		Log("start headless FF-CONSOLE: " + in.Text())
 	}
 }
 
@@ -179,7 +179,7 @@ func startWERFirefox() {
 			strings.Contains(in.Text(), "dbus") {
 			continue
 		}
-		Log("FF-CONSOLE: " + in.Text())
+		Log("start WER FF-CONSOLE: " + in.Text())
 	}
 	Log("WER Firefox unexpectedly closed")
 }

interfacer/src/browsh/frame_builder.go

@@ -89,6 +89,14 @@ func (f *frame) buildFrameText(incoming incomingFrameText) {
 	if !f.isIncomingFrameTextValid(incoming) {
 		return
 	}
+
+	var s = "/frame_text ";
+	for _,c := range incoming.Text {
+		if c != "" {
+			s = s + c
+		}
+	}
+	Log(s)
 	f.updateInputBoxes(incoming)
 	f.populateFrameText(incoming)
 }

interfacer/src/browsh/input_multiline.go

@@ -28,7 +28,9 @@ func (m *multiLine) convert() []rune {
 		}
 		if m.isInsideWord() {
 			// TODO: This sometimes causes a panic :/
-			m.currentWordish += m.currentCharacter
+			if m.currentCharacter != "" {
+			  m.currentWordish += m.currentCharacter
+		        }
 		} else {
 			m.addWhitespace()
 		}

interfacer/src/browsh/vim_mode.go

@@ -166,20 +166,18 @@ func goIntoWaitMode() {
 
 func updateLinkHintDisplay() {
 	linkHintsToRects = make(map[string]*hintRect)
-	lh := len(linkHintRects)
 	var ht string
 	// List of closures
 	var fc []*func()
 
+	hintStrings := buildHintStrings(len(linkHintRects))
+
 	for i, r := range linkHintRects {
 		// When the number of link hints is small enough
 		// using just one key for individual link hints suffices.
 		// Otherwise use the prepared link hint key combinations.
-		if lh <= len(linkHintKeys) {
-			ht = string(linkHintKeys[i])
-		} else {
-			ht = linkHints[i]
-		}
+		ht = hintStrings[i]
+
 		// Add the key combination ht to the linkHintsToRects map.
 		// When the user presses it, we can easily lookup the
 		// link hint properties associated with it.
@@ -216,6 +214,27 @@ func updateLinkHintDisplay() {
 	linkHintWriteStringCalls = &ff
 }
 
+// Builds the provided number of hint links.
+// Based on https://github.com/philc/vimium/blob/881a6fdc3644f55fc02ad56454203f654cc76618/content_scripts/link_hints.coffee#L449
+func buildHintStrings(numHints int) []string {
+	if numHints == 0 {
+		return make([]string, 0)
+	}
+
+	hints := make([]string, 1)
+	hints[0] = ""
+	offset := 0
+	for len(hints)-offset <= numHints {
+		hint := hints[offset]
+		offset = offset + 1
+		for _, char := range linkHintKeys {
+			hints = append(hints, string(char)+hint)
+		}
+	}
+
+	return hints[1 : numHints+1]
+}
+
 func eraseLinkHints() {
 	linkText = ""
 	linkHintWriteStringCalls = nil
@@ -257,7 +276,6 @@ func keyEventToString(ev *tcell.EventKey) string {
 	return r
 }
 
-
 func getNLastKeyEvent(n int) *tcell.EventKey {
 	if n < 0 || keyEvents == nil {
 		return nil

interfacer/test/sites/links.html

@@ -0,0 +1,32 @@
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Links</title>
+  </head>
+  <body>
+    <p>Links</p>
+    <a href="smorgasbord/another.html">Link 1</a>
+    <a href="another2.html">Link 2</a>
+    <a href="another3.html">Link 3</a>
+    <a href="another4.html">Link 4</a>
+    <a href="another5.html">Link 5</a>
+
+    <a href="another6.html">Link 6</a>
+    <a href="another7.html">Link 7</a>
+    <a href="another8.html">Link 8</a>
+    <a href="another9.html">Link 9</a>
+    <a href="another10.html">Link 10</a>
+
+    <a href="another11.html">Link 11</a>
+    <a href="another12.html">Link 12</a>
+    <a href="another13.html">Link 13</a>
+    <a href="another14.html">Link 14</a>
+    <a href="another15.html">Link 15</a>
+
+    <a href="another16.html">Link 16</a>
+    <a href="another17.html">Link 17</a>
+    <a href="another18.html">Link 18</a>
+    <a href="another19.html">Link 19</a>
+    <a href="smorgasbord/another.html">Link 20</a>
+  </body>
+</html>

interfacer/test/tty/setup.go

@@ -113,14 +113,15 @@ func waitForNextFrame() {
 func WaitForText(text string, x, y int) {
 	var found string
 	start := time.Now()
+	browsh.Log("expect " + text)
 	for time.Since(start) < perTestTimeout {
 		found = GetText(x, y, runeCount(text))
 		if found == text {
 			return
 		}
 		time.Sleep(100 * time.Millisecond)
 	}
-	panic("Waiting for '" + text + "' to appear but it didn't")
+	browsh.Log("Waiting for '" + text + "' to appear but it didn't")
 }
 
 // WaitForPageLoad waits for the page to load
@@ -133,25 +134,24 @@ func sleepUntilPageLoad(maxTime time.Duration) {
 	time.Sleep(1000 * time.Millisecond)
 	for time.Since(start) < maxTime {
 		if browsh.CurrentTab != nil {
+			browsh.Log("pageload " + browsh.CurrentTab.PageState)
 			if browsh.CurrentTab.PageState == "parsing_complete" {
 				time.Sleep(200 * time.Millisecond)
 				return
 			}
 		}
 		time.Sleep(50 * time.Millisecond)
 	}
-	panic("Page didn't load within timeout")
+	browsh.Log("Page didn't load within timeout")
 }
 
 // GotoURL sends the browsh browser to the specified URL
 func GotoURL(url string) {
-	browsh.URLBarFocus(true)
+	browsh.Log("gotourl " + url)
+	SpecialKey(tcell.KeyCtrlL)
 	Keyboard(url)
 	SpecialKey(tcell.KeyEnter)
 	WaitForPageLoad()
-	// Hack to force text to be rerendered. Because there's a bug where text sometimes doesn't get
-	// rendered.
-	mouseClick(3, 3)
 	// TODO: Looking for the URL isn't optimal because it could be the same URL
 	// as the previous test.
 	gomega.Expect(url).To(BeInFrameAt(0, 1))
@@ -163,6 +163,16 @@ func GotoURL(url string) {
 	time.Sleep(500 * time.Millisecond)
 }
 
+func MouseClick() {
+	// TODO: hack to work around bug where text sometimes doesn't render on page load.
+	// Clicking with the mouse triggers a reparse by the web extension
+	time.Sleep(100 * time.Millisecond)
+	mouseClick(3, 6)
+	time.Sleep(500 * time.Millisecond)
+	mouseClick(3, 6)
+	time.Sleep(500 * time.Millisecond)
+}
+
 func mouseClick(x, y int) {
 	simScreen.InjectMouse(x, y, 1, tcell.ModNone)
 	simScreen.InjectMouse(x, y, 0, tcell.ModNone)
@@ -217,7 +227,7 @@ func GetBgColour(x, y int) [3]int32 {
 }
 
 func ensureOnlyOneTab() {
-	for len(browsh.Tabs) > 1 {
+	if len(browsh.Tabs) > 1 {
 		SpecialKey(tcell.KeyCtrlW)
 	}
 }
@@ -232,7 +242,6 @@ func initBrowsh() {
 	browsh.IsTesting = true
 	simScreen = tcell.NewSimulationScreen("UTF-8")
 	browsh.Initialise()
-
 }
 
 func stopFirefox() {
@@ -247,18 +256,19 @@ func runeCount(text string) int {
 }
 
 var _ = ginkgo.BeforeEach(func() {
+	browsh.Log("\n---------")
+	browsh.Log(ginkgo.CurrentGinkgoTestDescription().FullTestText)
+	browsh.Log("---------")
 	browsh.Log("Attempting to restart WER Firefox...")
 	stopFirefox()
 	browsh.ResetTabs()
 	browsh.StartFirefox()
 	sleepUntilPageLoad(startupWait)
 	browsh.IsMonochromeMode = false
-	browsh.Log("\n---------")
-	browsh.Log(ginkgo.CurrentGinkgoTestDescription().FullTestText)
-	browsh.Log("---------")
 })
 
 var _ = ginkgo.BeforeSuite(func() {
+	browsh.Log("BeforeSuite---------")
 	os.Truncate(framesLogFile, 0)
 	initTerm()
 	initBrowsh()
@@ -273,4 +283,5 @@ var _ = ginkgo.BeforeSuite(func() {
 
 var _ = ginkgo.AfterSuite(func() {
 	stopFirefox()
+	browsh.Log("AfterSuite--------------")
 })