Add WebSocket API

nhooyr · nhooyr · commit b6caac6f9772 · 2019-09-21T14:10:30.000-05:00
Closes #121
diff --git a/accept.go b/accept.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
diff --git a/accept_test.go b/accept_test.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
diff --git a/ci/wasm.sh b/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
diff --git a/dial.go b/dial.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
diff --git a/dial_test.go b/dial_test.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
diff --git a/doc.go b/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
diff --git a/example_echo_test.go b/example_echo_test.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket_test
 
 import (
diff --git a/example_test.go b/example_test.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket_test
 
 import (
diff --git a/export_test.go b/export_test.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
diff --git a/go.mod b/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
diff --git a/go.sum b/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=
diff --git a/header.go b/header.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
diff --git a/header_test.go b/header_test.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
diff --git a/internal/wsjs/wsjs.go b/internal/wsjs/wsjs.go
@@ -5,7 +5,6 @@
 package wsjs
 
 import (
-	"context"
 	"syscall/js"
 )
 
@@ -26,17 +25,17 @@ func handleJSError(err *error, onErr func()) {
 	}
 }
 
-func New(ctx context.Context, url string, protocols []string) (c *WebSocket, err error) {
+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),
 	}
 
@@ -57,19 +56,25 @@ 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 {
+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()
+	}
 }
 
 type CloseEvent struct {
@@ -78,8 +83,8 @@ type CloseEvent struct {
 	WasClean bool
 }
 
-func (c *WebSocket) OnClose(fn func(CloseEvent)) {
-	c.addEventListener("close", func(e js.Value) {
+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 +94,23 @@ func (c *WebSocket) OnClose(fn func(CloseEvent)) {
 	})
 }
 
-func (c *WebSocket) OnError(fn func(e js.Value)) {
-	c.addEventListener("error", fn)
+func (c WebSocket) OnError(fn func(e js.Value)) (remove func()) {
+	return c.addEventListener("error", fn)
 }
 
 type MessageEvent struct {
-	Data []byte
+	Data interface{}
 	// There are more types 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
+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 +124,23 @@ func (c *WebSocket) OnMessage(fn func(m MessageEvent)) {
 	})
 }
 
-func (c *WebSocket) OnOpen(fn func(e js.Value)) {
-	c.addEventListener("open", fn)
+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) {
+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) {
+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) {
+func (c WebSocket) SendBytes(v []byte) (err error) {
 	defer handleJSError(&err, nil)
 	c.v.Call("send", uint8Array(v))
 	return err
diff --git a/internal/wsjs/wsjs_test.go b/internal/wsjs/wsjs_test.go
@@ -3,7 +3,6 @@
 package wsjs
 
 import (
-	"context"
 	"syscall/js"
 	"testing"
 	"time"
@@ -12,7 +11,7 @@ import (
 func TestWebSocket(t *testing.T) {
 	t.Parallel()
 
-	c, err := New(context.Background(), "ws://localhost:8081", nil)
+	c, err := New("ws://localhost:8081", nil)
 	if err != nil {
 		t.Fatal(err)
 	}
diff --git a/netconn.go b/netconn.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) {
diff --git a/netconn_js.go b/netconn_js.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
+}
diff --git a/netconn_normal.go b/netconn_normal.go
@@ -0,0 +1,12 @@
+// +build !js
+
+package websocket
+
+import (
+	"context"
+	"io"
+)
+
+func (c *netConn) netConnReader(ctx context.Context) (MessageType, io.Reader, error) {
+	return c.c.Reader(c.readContext)
+}
diff --git a/opcode.go b/opcode.go
@@ -3,7 +3,7 @@ package websocket
 // opcode represents a WebSocket Opcode.
 type opcode int
 
-//go:generate go run golang.org/x/tools/cmd/stringer -type=opcode
+//go:generate go run golang.org/x/tools/cmd/stringer -type=opcode -tags js
 
 // opcode constants.
 const (
diff --git a/opcode_string.go b/opcode_string.go
diff --git a/websocket.go b/websocket.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket
 
 import (
diff --git a/websocket_autobahn_python_test.go b/websocket_autobahn_python_test.go
@@ -1,6 +1,7 @@
 // This file contains the old autobahn test suite tests that use the
-// python binary. The approach is very clunky and slow so new tests
+// python binary. The approach is clunky and slow so new tests
 // have been written in pure Go in websocket_test.go.
+// These have been kept for correctness purposes and are occasionally ran.
 // +build autobahn-python
 
 package websocket_test
diff --git a/websocket_bench_test.go b/websocket_bench_test.go
@@ -1,3 +1,5 @@
+// +build !js
+
 package websocket_test
 
 import (
diff --git a/websocket_js.go b/websocket_js.go
diff --git a/websocket_test.go b/websocket_test.go
diff --git a/wsjson/wsjson.go b/wsjson/wsjson.go
diff --git a/wsjson/wsjson_js.go b/wsjson/wsjson_js.go
diff --git a/wspb/wspb.go b/wspb/wspb.go
diff --git a/wspb/wspb_js.go b/wspb/wspb_js.go
diff --git a/xor.go b/xor.go
diff --git a/xor_test.go b/xor_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// +build !js`
	`2`	`+`
`1`	`3`	`package websocket`
`2`	`4`
`3`	`5`	`import (`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// +build !js`
	`2`	`+`
`1`	`3`	`// Package websocket is a minimal and idiomatic implementation of the WebSocket protocol.`
`2`	`4`	`//`
`3`	`5`	`// https://tools.ietf.org/html/rfc6455`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// +build !js`
	`2`	`+`
`1`	`3`	`package websocket_test`
`2`	`4`
`3`	`5`	`import (`