Update docs and remove separate wasm CI step

Integrated into the appropriate existing steps.

Author: nhooyr

.github/CONTRIBUTING.md

@@ -27,25 +27,29 @@ CI must pass on your changes for them to be merged.
 
 ### CI
 
-CI will ensure your code is formatted correctly, passes linting and tests.
+CI will ensure your code is formatted, lints and passes tests.
 It will collect coverage and report it to [codecov](https://codecov.io/gh/nhooyr/websocket)
-and also upload a `coverage` artifact that you can download to inspect browse coverage.
+and also upload a html `coverage` artifact that you can download to browse coverage.
 
-You can run CI locally. The various steps are located in [ci/\*.sh](../ci).
+You can run CI locally. You only need [Go](https://golang.org), [nodejs](https://nodejs.org/en/) and [yarn](https://yarnpkg.com).
 
-1. [fmt.sh](../ci/fmt.sh) which requires node (specifically prettier).
-1. [lint.sh](../ci/lint.sh) which requires [shellcheck](https://github.com/koalaman/shellcheck#installing).
-1. [test.sh](../ci/test.sh)
-1. [run.sh](../ci/run.sh) which runs the above scripts in order.
+See the scripts in [package.json](../package.json).
 
-For coverage details locally, see `ci/out/coverage.html` after running [test.sh](../ci/test.sh).
+1. `yarn fmt` performs code generation and formatting.
+1. `yarn lint` performs linting.
+1. `yarn test` runs tests.
+1. `yarn all` runs the above scripts in parallel.
+
+For coverage details locally, see `ci/out/coverage.html` after running `yarn test`.
+
+CI is written with nodejs to enable running as much as possible concurrently.
 
 See [ci/image/Dockerfile](../ci/image/Dockerfile) for the installation of the CI dependencies on Ubuntu.
 
-You can also run tests normally with `go test`. [test.sh](../ci/test.sh) just passes a default set of flags to
-`go test` to collect coverage and also prettify the output.
+You can also run tests normally with `go test`. `yarn test` just passes a default set of flags to
+`go test` to collect coverage and runs the WASM tests.
 
-You can pass flags to [test.sh](../ci/test.sh) if you want to run a specific test or otherwise
+You can pass flags to `yarn test` if you want to run a specific test or otherwise
 control the behaviour of `go test` but also get coverage.
 
 Coverage percentage from codecov and the CI scripts will be different because they are calculated differently.

.github/workflows/ci.yml

@@ -4,19 +4,19 @@ on: [push]
 jobs:
   fmt:
     runs-on: ubuntu-latest
-    container: nhooyr/websocket-ci@sha256:7f5513545dcbaa3ed06a2919acfd1cfbff1e6e0decc1602c98672a4aad2f68ab
+    container: nhooyr/websocket-ci@sha256:f8b6e53a9fd256bcf6c90029276385b9ec730b76a0d7ccf3ff19084bce210c50
     steps:
       - uses: actions/checkout@v1
       - run: yarn --frozen-lockfile && yarn fmt
   lint:
     runs-on: ubuntu-latest
-    container: nhooyr/websocket-ci@sha256:7f5513545dcbaa3ed06a2919acfd1cfbff1e6e0decc1602c98672a4aad2f68ab
+    container: nhooyr/websocket-ci@sha256:f8b6e53a9fd256bcf6c90029276385b9ec730b76a0d7ccf3ff19084bce210c50
     steps:
       - uses: actions/checkout@v1
       - run: yarn --frozen-lockfile && yarn lint
   test:
     runs-on: ubuntu-latest
-    container: nhooyr/websocket-ci@sha256:7f5513545dcbaa3ed06a2919acfd1cfbff1e6e0decc1602c98672a4aad2f68ab
+    container: nhooyr/websocket-ci@sha256:f8b6e53a9fd256bcf6c90029276385b9ec730b76a0d7ccf3ff19084bce210c50
     steps:
       - uses: actions/checkout@v1
       - run: yarn --frozen-lockfile && yarn test
@@ -27,9 +27,3 @@ jobs:
         with:
           name: coverage
           path: ci/out/coverage.html
-  wasm:
-    runs-on: ubuntu-latest
-    container: nhooyr/websocket-ci@sha256:7f5513545dcbaa3ed06a2919acfd1cfbff1e6e0decc1602c98672a4aad2f68ab
-    steps:
-      - uses: actions/checkout@v1
-      - run: yarn --frozen-lockfile && yarn wasm

ci/all.ts

@@ -4,7 +4,6 @@ import { fmt, gen } from "./fmt"
 import { main } from "./lib"
 import { lint } from "./lint"
 import { test } from "./test"
-import { wasm } from "./wasm"
 
 main(run)
 
@@ -15,6 +14,5 @@ async function run(ctx: Promise<unknown>) {
     fmt(ctx),
     lint(ctx),
     test(ctx),
-    wasm(ctx),
   ])
 }

ci/fmt.ts

@@ -2,7 +2,7 @@
 
 import { exec, main } from "./lib"
 
-if (process.argv[1] === __filename) {
+if (require.main === module) {
   main(async (ctx: Promise<unknown>) => {
     await gen(ctx)
     await fmt(ctx)

ci/image/Dockerfile

@@ -6,17 +6,17 @@ RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
 RUN curl -sL https://deb.nodesource.com/setup_12.x | bash -
 RUN apt-get install -y nodejs chromium yarn
 
-RUN git config --global color.ui always
+COPY ./ci/image/gitignore /etc/git/ignore
+RUN git config --system color.ui always
+# Need to set set this explicitly for the system since github uses HOME=/home/github.
+RUN git config --system core.excludesfile /etc/git/ignore
 
 ENV GOPATH=/root/gopath
 ENV PATH=$GOPATH/bin:$PATH
 ENV GOFLAGS="-mod=readonly"
 ENV PAGER=cat
 ENV CI=true
 
-RUN mkdir -p ~/.config/git
-COPY ./ci/image/gitignore ~/.config/git/ignore
-
 # Cache go modules, build cache and yarn cache.
 COPY . /tmp/websocket
 RUN cd /tmp/websocket && \

ci/image/push.ts

@@ -13,11 +13,9 @@ async function run(ctx: Promise<unknown>) {
 
   try {
     await spawn(ctx, "docker build -f ./ci/image/Dockerfile -t nhooyr/websocket-ci .", [], {
-      timeout: 180_000,
       stdio: "inherit",
     })
     await spawn(ctx, "docker push nhooyr/websocket-ci", [], {
-      timeout: 30_000,
       stdio: "inherit",
     })
   } finally {

ci/lib.ts

@@ -5,7 +5,7 @@ import { ExecOptions, SpawnOptions } from "child_process"
 export async function main(fn: (ctx: Promise<unknown>) => void, opts: {
   timeout: number
 } = {
-  timeout: 180_000,
+  timeout: 3 * 60_000,
 }) {
 
   const timer = new Timeout();
@@ -45,7 +45,6 @@ export async function main(fn: (ctx: Promise<unknown>) => void, opts: {
 // TODO promisify native versions
 export async function exec(ctx: Promise<unknown>, cmd: string, opts?: ExecOptions) {
   opts = {
-    timeout: 60_000,
     ...opts,
   }
   const p = cp.exec(cmd, opts)
@@ -62,7 +61,6 @@ export async function spawn(ctx: Promise<unknown>, cmd: string, args: string[],
     args = []
   }
   opts = {
-    timeout: 60_000,
     shell: true,
     ...opts,
   }
@@ -115,3 +113,10 @@ export function withCancel<T>(p: Promise<T>) {
     p: p,
   }
 }
+
+
+export const wasmEnv = {
+  ...process.env,
+  GOOS: "js",
+  GOARCH: "wasm",
+}

ci/lint.ts

@@ -1,8 +1,8 @@
 #!/usr/bin/env -S npx ts-node -P ci/tsconfig.json
 
-import { exec, main } from "./lib"
+import { exec, main, wasmEnv } from "./lib"
 
-if (process.argv[1] === __filename) {
+if (require.main === module) {
   main(lint)
 }
 
@@ -13,6 +13,15 @@ export async function lint(ctx: Promise<unknown>) {
       exec(ctx, "git ls-files '*.ts' | xargs npx eslint --max-warnings 0 --fix", {
         cwd: "ci",
       }),
+      wasmLint(ctx),
     ],
   )
 }
+
+
+async function wasmLint(ctx: Promise<unknown>) {
+  await exec(ctx, "go install golang.org/x/lint/golint")
+  await exec(ctx, "golint -set_exit_status ./...", {
+    env: wasmEnv,
+  })
+}

ci/test.ts

@@ -1,10 +1,12 @@
 #!/usr/bin/env -S npx ts-node -P ci/tsconfig.json
 
-import * as https from "https"
+import cp from "child_process"
+import * as events from "events"
+import * as readline from "readline"
 import replaceInFile from "replace-in-file"
-import { exec, main, selectCtx, spawn } from "./lib"
+import { exec, main, selectCtx, spawn, wasmEnv } from "./lib"
 
-if (process.argv[1] === __filename) {
+if (require.main === module) {
   main(test)
 }
 
@@ -26,32 +28,67 @@ export async function test(ctx: Promise<unknown>) {
     args.push("./...")
   }
 
-  await spawn(ctx, "go", ["test", ...args], {
-    timeout: 60_000,
+  const p1 = spawn(ctx, "go", ["test", ...args], {
     stdio: "inherit",
   })
+  const p2 = wasmTest(ctx)
+  await Promise.all([p1, p2])
 
   // Depending on the code tested, we may not have replaced anything so we do not
   // check whether anything was replaced.
   await selectCtx(ctx, replaceInFile({
     files: "./ci/out/coverage.prof",
     from: [
-      /.+frame_stringer.go:.+\n/g,
-      /.+wsjstest:.+\n/g,
-      /.+wsecho:.+\n/g,
+      /.+frame_stringer.go.+\n/g,
+      /.+wsjstest.+\n/g,
+      /.+wsecho.+\n/g,
     ],
     to: "",
   }))
 
   let p: Promise<unknown> = exec(ctx, "go tool cover -html=ci/out/coverage.prof -o=ci/out/coverage.html")
 
   if (process.env.CI) {
-    const script = https.get("https://codecov.io/bash")
-    const p2 = spawn(ctx, "bash -Z -R . -f ci/out/coverage.prof", [], {
-      stdio: [script],
-    })
-    p = Promise.all([p, p2])
+    p = Promise.all([p, codecov(ctx)])
   }
 
   await p
 }
+
+
+async function wasmTest(ctx: Promise<unknown>) {
+  await Promise.all([
+    exec(ctx, "go install ./internal/wsjstest"),
+    exec(ctx, "go install github.com/agnivade/wasmbrowsertest"),
+  ])
+
+  const url = await startWasmTestServer(ctx)
+
+  await exec(ctx, "go test -exec=wasmbrowsertest ./...", {
+    env: {
+      ...wasmEnv,
+      WS_ECHO_SERVER_URL: url,
+    },
+  })
+}
+
+async function startWasmTestServer(ctx: Promise<unknown>): Promise<string> {
+  const wsjstest = cp.spawn("wsjstest")
+  ctx.finally(wsjstest.kill.bind(wsjstest))
+
+  const rl = readline.createInterface({
+    input: wsjstest.stdout!,
+  })
+
+  try {
+    const p = events.once(rl, "line")
+    const a = await selectCtx(ctx, p)
+    return a[0]
+  } finally {
+    rl.close()
+  }
+}
+
+function codecov(ctx: Promise<unknown>) {
+  return exec(ctx, "curl -s https://codecov.io/bash | bash -s -- -Z -f ci/out/coverage.prof")
+}