Implement core API for WASM

Closes #121

Author: nhooyr

accept.go

@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
@@ -41,6 +43,12 @@ type AcceptOptions struct {
 }
 
 func verifyClientRequest(w http.ResponseWriter, r *http.Request) error {
+	if !r.ProtoAtLeast(1, 1) {
+		err := fmt.Errorf("websocket protocol violation: handshake request must be at least HTTP/1.1: %q", r.Proto)
+		http.Error(w, err.Error(), http.StatusBadRequest)
+		return err
+	}
+
 	if !headerValuesContainsToken(r.Header, "Connection", "Upgrade") {
 		err := fmt.Errorf("websocket protocol violation: Connection header %q does not contain Upgrade", r.Header.Get("Connection"))
 		http.Error(w, err.Error(), http.StatusBadRequest)

accept_test.go

@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
@@ -45,6 +47,7 @@ func Test_verifyClientHandshake(t *testing.T) {
 	testCases := []struct {
 		name    string
 		method  string
+		http1   bool
 		h       map[string]string
 		success bool
 	}{
@@ -86,6 +89,16 @@ func Test_verifyClientHandshake(t *testing.T) {
 				"Sec-WebSocket-Key":     "",
 			},
 		},
+		{
+			name: "badHTTPVersion",
+			h: map[string]string{
+				"Connection":            "Upgrade",
+				"Upgrade":               "websocket",
+				"Sec-WebSocket-Version": "13",
+				"Sec-WebSocket-Key":     "meow123",
+			},
+			http1: true,
+		},
 		{
 			name: "success",
 			h: map[string]string{
@@ -106,6 +119,12 @@ func Test_verifyClientHandshake(t *testing.T) {
 			w := httptest.NewRecorder()
 			r := httptest.NewRequest(tc.method, "/", nil)
 
+			r.ProtoMajor = 1
+			r.ProtoMinor = 1
+			if tc.http1 {
+				r.ProtoMinor = 0
+			}
+
 			for k, v := range tc.h {
 				r.Header.Set(k, v)
 			}

ci/wasm.sh

@@ -6,6 +6,5 @@ cd "$(git rev-parse --show-toplevel)"
 
 GOOS=js GOARCH=wasm go vet ./...
 go install golang.org/x/lint/golint
-# Get passing later.
-#GOOS=js GOARCH=wasm golint -set_exit_status ./...
-GOOS=js GOARCH=wasm go test ./internal/wsjs
+GOOS=js GOARCH=wasm golint -set_exit_status ./...
+GOOS=js GOARCH=wasm go test ./...

dial.go

@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
@@ -149,6 +151,10 @@ func verifyServerResponse(r *http.Request, resp *http.Response) error {
 		)
 	}
 
+	if proto := resp.Header.Get("Sec-WebSocket-Protocol"); proto != "" && !headerValuesContainsToken(r.Header, "Sec-WebSocket-Protocol", proto) {
+		return fmt.Errorf("websocket protocol violation: unexpected Sec-WebSocket-Protocol from server: %q", proto)
+	}
+
 	return nil
 }
 

dial_test.go

@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
@@ -97,6 +99,16 @@ func Test_verifyServerHandshake(t *testing.T) {
 			},
 			success: false,
 		},
+		{
+			name: "badSecWebSocketProtocol",
+			response: func(w http.ResponseWriter) {
+				w.Header().Set("Connection", "Upgrade")
+				w.Header().Set("Upgrade", "websocket")
+				w.Header().Set("Sec-WebSocket-Protocol", "xd")
+				w.WriteHeader(http.StatusSwitchingProtocols)
+			},
+			success: false,
+		},
 		{
 			name: "success",
 			response: func(w http.ResponseWriter) {

doc.go

@@ -1,3 +1,5 @@
+// +build !js
+
 // Package websocket is a minimal and idiomatic implementation of the WebSocket protocol.
 //
 // https://tools.ietf.org/html/rfc6455

example_echo_test.go

@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket_test
 
 import (

example_test.go

@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket_test
 
 import (

export_test.go

@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (

go.mod

@@ -22,6 +22,7 @@ require (
 	golang.org/x/sys v0.0.0-20190919044723-0c1ff786ef13 // indirect
 	golang.org/x/time v0.0.0-20190308202827-9d24e82272b4
 	golang.org/x/tools v0.0.0-20190920225731-5eefd052ad72
+	golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7
 	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
 	gotest.tools/gotestsum v0.3.5
 	mvdan.cc/sh v2.6.4+incompatible

go.sum

@@ -97,6 +97,7 @@ golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxb
 golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 golang.org/x/tools v0.0.0-20190920225731-5eefd052ad72 h1:bw9doJza/SFBEweII/rHQh338oozWyiFsBRHtrflcws=
 golang.org/x/tools v0.0.0-20190920225731-5eefd052ad72/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7 h1:9zdDQZ7Thm29KFXgAX/+yaf3eVbP7djjWp/dXAppNCc=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/airbrake/gobrake.v2 v2.0.9 h1:7z2uVWwn7oVeeugY1DtlPAy5H+KYgB1KeKTnqjNatLo=
 gopkg.in/airbrake/gobrake.v2 v2.0.9/go.mod h1:/h5ZAUhDkGaJfjzjKLSjv6zCL6O0LLBxU4K+aSYdM/U=

header.go

@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (

header_test.go

@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (

internal/echoserver/echoserver.go

@@ -0,0 +1,11 @@
+package echoserver
+
+import (
+	"net/http"
+)
+
+// EchoServer provides a streaming WebSocket echo server
+// for use in tests.
+func EchoServer(w http.ResponseWriter, r *http.Request) {
+
+}

internal/wsjs/wsjs.go

@@ -1,11 +1,11 @@
 // +build js
 
 // Package wsjs implements typed access to the browser javascript WebSocket API.
+//
 // https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
 package wsjs
 
 import (
-	"context"
 	"syscall/js"
 )
 
@@ -26,17 +26,18 @@ func handleJSError(err *error, onErr func()) {
 	}
 }
 
-func New(ctx context.Context, url string, protocols []string) (c *WebSocket, err error) {
+// New is a wrapper around the javascript WebSocket constructor.
+func New(url string, protocols []string) (c WebSocket, err error) {
 	defer handleJSError(&err, func() {
-		c = nil
+		c = WebSocket{}
 	})
 
 	jsProtocols := make([]interface{}, len(protocols))
 	for i, p := range protocols {
 		jsProtocols[i] = p
 	}
 
-	c = &WebSocket{
+	c = WebSocket{
 		v: js.Global().Get("WebSocket").New(url, jsProtocols),
 	}
 
@@ -49,6 +50,7 @@ func New(ctx context.Context, url string, protocols []string) (c *WebSocket, err
 	return c, nil
 }
 
+// WebSocket is a wrapper around a javascript WebSocket object.
 type WebSocket struct {
 	Extensions string
 	Protocol   string
@@ -57,29 +59,33 @@ type WebSocket struct {
 	v js.Value
 }
 
-func (c *WebSocket) setBinaryType(typ string) {
+func (c WebSocket) setBinaryType(typ string) {
 	c.v.Set("binaryType", string(typ))
 }
 
-func (c *WebSocket) BufferedAmount() uint32 {
-	return uint32(c.v.Get("bufferedAmount").Int())
-}
-
-func (c *WebSocket) addEventListener(eventType string, fn func(e js.Value)) {
-	c.v.Call("addEventListener", eventType, js.FuncOf(func(this js.Value, args []js.Value) interface{} {
+func (c WebSocket) addEventListener(eventType string, fn func(e js.Value)) func() {
+	f := js.FuncOf(func(this js.Value, args []js.Value) interface{} {
 		fn(args[0])
 		return nil
-	}))
+	})
+	c.v.Call("addEventListener", eventType, f)
+
+	return func() {
+		c.v.Call("removeEventListener", eventType, f)
+		f.Release()
+	}
 }
 
+// CloseEvent is the type passed to a WebSocket close handler.
 type CloseEvent struct {
 	Code     uint16
 	Reason   string
 	WasClean bool
 }
 
-func (c *WebSocket) OnClose(fn func(CloseEvent)) {
-	c.addEventListener("close", func(e js.Value) {
+// OnClose registers a function to be called when the WebSocket is closed.
+func (c WebSocket) OnClose(fn func(CloseEvent)) (remove func()) {
+	return c.addEventListener("close", func(e js.Value) {
 		ce := CloseEvent{
 			Code:     uint16(e.Get("code").Int()),
 			Reason:   e.Get("reason").String(),
@@ -89,23 +95,29 @@ func (c *WebSocket) OnClose(fn func(CloseEvent)) {
 	})
 }
 
-func (c *WebSocket) OnError(fn func(e js.Value)) {
-	c.addEventListener("error", fn)
+// OnError registers a function to be called when there is an error
+// with the WebSocket.
+func (c WebSocket) OnError(fn func(e js.Value)) (remove func()) {
+	return c.addEventListener("error", fn)
 }
 
+// MessageEvent is the type passed to a message handler.
 type MessageEvent struct {
-	Data []byte
-	// There are more types to the interface but we don't use them.
+	// string or []byte.
+	Data interface{}
+
+	// There are more fields to the interface but we don't use them.
 	// See https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent
 }
 
-func (c *WebSocket) OnMessage(fn func(m MessageEvent)) {
-	c.addEventListener("message", func(e js.Value) {
-		var data []byte
+// OnMessage registers a function to be called when the websocket receives a message.
+func (c WebSocket) OnMessage(fn func(m MessageEvent)) (remove func()) {
+	return c.addEventListener("message", func(e js.Value) {
+		var data interface{}
 
 		arrayBuffer := e.Get("data")
 		if arrayBuffer.Type() == js.TypeString {
-			data = []byte(arrayBuffer.String())
+			data = arrayBuffer.String()
 		} else {
 			data = extractArrayBuffer(arrayBuffer)
 		}
@@ -119,23 +131,29 @@ func (c *WebSocket) OnMessage(fn func(m MessageEvent)) {
 	})
 }
 
-func (c *WebSocket) OnOpen(fn func(e js.Value)) {
-	c.addEventListener("open", fn)
+// OnOpen registers a function to be called when the websocket is opened.
+func (c WebSocket) OnOpen(fn func(e js.Value)) (remove func()) {
+	return c.addEventListener("open", fn)
 }
 
-func (c *WebSocket) Close(code int, reason string) (err error) {
+// Close closes the WebSocket with the given code and reason.
+func (c WebSocket) Close(code int, reason string) (err error) {
 	defer handleJSError(&err, nil)
 	c.v.Call("close", code, reason)
 	return err
 }
 
-func (c *WebSocket) SendText(v string) (err error) {
+// SendText sends the given string as a text message
+// on the WebSocket.
+func (c WebSocket) SendText(v string) (err error) {
 	defer handleJSError(&err, nil)
 	c.v.Call("send", v)
 	return err
 }
 
-func (c *WebSocket) SendBytes(v []byte) (err error) {
+// SendBytes sends the given message as a binary message
+// on the WebSocket.
+func (c WebSocket) SendBytes(v []byte) (err error) {
 	defer handleJSError(&err, nil)
 	c.v.Call("send", uint8Array(v))
 	return err

internal/wsjs/wsjs_test.go

@@ -93,7 +93,7 @@ func (c *netConn) Read(p []byte) (int, error) {
 	}
 
 	if c.reader == nil {
-		typ, r, err := c.c.Reader(c.readContext)
+		typ, r, err := c.netConnReader(c.readContext)
 		if err != nil {
 			var ce CloseError
 			if errors.As(err, &ce) && (ce.Code == StatusNormalClosure) || (ce.Code == StatusGoingAway) {

netconn.go

@@ -0,0 +1,17 @@
+// +build js
+
+package websocket
+
+import (
+	"bytes"
+	"context"
+	"io"
+)
+
+func (c *netConn) netConnReader(ctx context.Context) (MessageType, io.Reader, error) {
+	typ, p, err := c.c.Read(ctx)
+	if err != nil {
+		return 0, nil, err
+	}
+	return typ, bytes.NewReader(p), nil
+}