Merge pull request #118 from nhooyr/fixes

Improve CI and performance

Author: nhooyr

.circleci/config.yml

@@ -2,54 +2,59 @@ version: 2
 jobs:
   fmt:
     docker:
-      - image: golang:1
+      - image: nhooyr/websocket-ci
     steps:
       - checkout
       - restore_cache:
           keys:
-            - go-{{ checksum "go.sum" }}
+            - go-v3-{{ checksum "go.sum" }}
             # Fallback to using the latest cache if no exact match is found.
-            - go-
+            - go-v3-
       - run: ./ci/fmt.sh
       - save_cache:
           paths:
-            - /go
+            - /root/gopath
             - /root/.cache/go-build
-          key: go-{{ checksum "go.sum" }}
+          key: go-v3-{{ checksum "go.sum" }}
 
   lint:
     docker:
-      - image: golang:1
+      - image: nhooyr/websocket-ci
     steps:
       - checkout
       - restore_cache:
           keys:
-            - go-{{ checksum "go.sum" }}
+            - go-v3-{{ checksum "go.sum" }}
             # Fallback to using the latest cache if no exact match is found.
-            - go-
+            - go-v3-
       - run: ./ci/lint.sh
       - save_cache:
           paths:
-            - /go
+            - /root/gopath
             - /root/.cache/go-build
-          key: go-{{ checksum "go.sum" }}
+          key: go-v3-{{ checksum "go.sum" }}
 
   test:
     docker:
-      - image: golang:1
+      - image: nhooyr/websocket-ci
     steps:
       - checkout
       - restore_cache:
           keys:
-            - go-{{ checksum "go.sum" }}
+            - go-v3-{{ checksum "go.sum" }}
             # Fallback to using the latest cache if no exact match is found.
-            - go-
+            - go-v3-
       - run: ./ci/test.sh
+      - store_artifacts:
+          path: ci/out
+          destination: out
       - save_cache:
           paths:
-            - /go
+            - /root/gopath
             - /root/.cache/go-build
-          key: go-{{ checksum "go.sum" }}
+          key: go-v3-{{ checksum "go.sum" }}
+      - store_test_results:
+          path: ci/out
 
 workflows:
   version: 2

README.md

@@ -42,15 +42,15 @@ http.HandlerFunc(func (w http.ResponseWriter, r *http.Request) {
 
 	ctx, cancel := context.WithTimeout(r.Context(), time.Second*10)
 	defer cancel()
-	
+
 	var v interface{}
 	err = wsjson.Read(ctx, c, &v)
 	if err != nil {
 		// ...
 	}
-	
+
 	log.Printf("received: %v", v)
-	
+
 	c.Close(websocket.StatusNormalClosure, "")
 })
 ```
@@ -93,7 +93,7 @@ c.Close(websocket.StatusNormalClosure, "")
 ## Comparison
 
 Before the comparison, I want to point out that both gorilla/websocket and gobwas/ws were
-extremely useful in implementing the WebSocket protocol correctly so *big thanks* to the
+extremely useful in implementing the WebSocket protocol correctly so _big thanks_ to the
 authors of both. In particular, I made sure to go through the issue tracker of gorilla/websocket
 to ensure I implemented details correctly and understood how people were using WebSockets in
 production.
@@ -111,7 +111,7 @@ Just compare the godoc of
 The API for nhooyr/websocket has been designed such that there is only one way to do things
 which makes it easy to use correctly. Not only is the API simpler, the implementation is
 only 1700 lines whereas gorilla/websocket is at 3500 lines. That's more code to maintain,
- more code to test, more code to document and more surface area for bugs.
+more code to test, more code to document and more surface area for bugs.
 
 Moreover, nhooyr/websocket has support for newer Go idioms such as context.Context and
 also uses net/http's Client and ResponseWriter directly for WebSocket handshakes.
@@ -151,7 +151,7 @@ and clarity.
 
 This library is fantastic in terms of performance. The author put in significant
 effort to ensure its speed and I have applied as many of its optimizations as
-I could into nhooyr/websocket. Definitely check out his fantastic [blog post](https://medium.freecodecamp.org/million-websockets-and-go-cc58418460bb) 
+I could into nhooyr/websocket. Definitely check out his fantastic [blog post](https://medium.freecodecamp.org/million-websockets-and-go-cc58418460bb)
 about performant WebSocket servers.
 
 If you want a library that gives you absolute control over everything, this is the library,

ci/.gitignore

@@ -0,0 +1 @@
+out

ci/bench.sh

@@ -2,11 +2,7 @@
 
 set -euo pipefail
 cd "$(dirname "${0}")"
-source ./lib.sh
-
-unstaged_files() {
-  git ls-files --other --modified --exclude-standard
-}
+cd "$(git rev-parse --show-toplevel)"
 
 gen() {
   # Unfortunately, this is the only way to ensure go.mod and go.sum are correct.
@@ -21,17 +17,33 @@ fmt() {
   gofmt -w -s .
   go run go.coder.com/go-tools/cmd/goimports -w "-local=$(go list -m)" .
   go run mvdan.cc/sh/cmd/shfmt -i 2 -w -s -sr .
+  # shellcheck disable=SC2046
+  npx prettier \
+    --write \
+    --print-width 120 \
+    --no-semi \
+    --trailing-comma all \
+    --loglevel silent \
+    $(git ls-files "*.yaml" "*.yml" "*.md")
+}
+
+unstaged_files() {
+  git ls-files --other --modified --exclude-standard
+}
+
+check() {
+  if [[ ${CI:-} && $(unstaged_files) != "" ]]; then
+    echo
+    echo "Files need generation or are formatted incorrectly."
+    echo "Please run:"
+    echo "./ci/fmt.sh"
+    echo
+    git status
+    git diff
+    exit 1
+  fi
 }
 
 gen
 fmt
-
-if [[ $CI && $(unstaged_files) != "" ]]; then
-  echo
-  echo "Files either need generation or are formatted incorrectly."
-  echo "Please run:"
-  echo "./ci/fmt.sh"
-  echo
-  git status
-  exit 1
-fi
+check

ci/fmt.sh

@@ -0,0 +1,13 @@
+FROM golang:1
+
+ENV DEBIAN_FRONTEND=noninteractive
+ENV GOPATH=/root/gopath
+ENV GOFLAGS="-mod=readonly"
+ENV PAGER=cat
+
+RUN apt-get update && \
+  apt-get install -y shellcheck python-pip npm && \
+  pip2 install autobahntestsuite && \
+  npm install -g prettier
+
+RUN git config --global color.ui always

ci/image/Dockerfile

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+cd "$(dirname "${0}")"
+cd "$(git rev-parse --show-toplevel)"
+
+docker build -f ./ci/image/Dockerfile -t nhooyr/websocket-ci .
+docker push nhooyr/websocket-ci

ci/image/push.sh

@@ -2,14 +2,9 @@
 
 set -euo pipefail
 cd "$(dirname "${0}")"
-source ./lib.sh
-
-if [[ $CI ]]; then
-  apt-get update -qq
-  apt-get install -qq shellcheck > /dev/null
-fi
+cd "$(git rev-parse --show-toplevel)"
 
 # shellcheck disable=SC2046
-shellcheck -e SC1091 -x $(git ls-files "*.sh")
+shellcheck -x $(git ls-files "*.sh")
 go vet ./...
 go run golang.org/x/lint/golint -set_exit_status ./...