Merge pull request #53 from dustywusty/hashbrown

Hashbrown

Author: dustywusty

.gitignore

@@ -27,6 +27,9 @@ go.work.sum
 # env file
 .env
 
+# e2e artifacts
+e2e-artifacts/
+
 # Editor/IDE
 # .idea/
 # .vscode/

Makefile

@@ -2,11 +2,22 @@ APP := tinychess
 BIN := bin/$(APP)
 PKG := .
 PORT ?= 8080
+CHROMEDP_HEADLESS ?= 1
+CHROMEDP_VIEWPORT_WIDTH ?= 1280
+CHROMEDP_VIEWPORT_HEIGHT ?= 2000
+E2E_RECORD ?= 1
+E2E_RECORD_FORMAT ?= gif
+E2E_RECORD_FPS ?= 6
+E2E_MOVE_DELAY_MS ?= 0
+E2E_START_DELAY_MS ?= 0
+E2E_CAPTURE_DELAY_MS ?= 200
+E2E_RECORD_HOLD_MS ?= 2000
+E2E_SEND_EMOJI ?= 1
 
 # ldflags embeds a build stamp and commit hash; feel free to remove
 LDFLAGS := -s -w -X 'main.build=$$(date -u +%Y%m%d-%H%M%S)' -X 'main.commit=$$(git rev-parse --short HEAD)'
 
-.PHONY: all build run dev clean lint test race
+.PHONY: all build run dev clean lint test race test-e2e
 
 all: build
 
@@ -29,6 +40,26 @@ lint:
 test:
 	go test ./...
 
+test-e2e:
+	@if [ "$(E2E_RECORD)" = "1" ] && [ "$(E2E_RECORD_FORMAT)" != "frames" ]; then \
+		command -v ffmpeg >/dev/null || { echo "ffmpeg not found (set E2E_RECORD_FORMAT=frames to skip stitching)"; exit 1; }; \
+	fi
+	@mkdir -p e2e-artifacts
+	@rm -f e2e-artifacts/*.png e2e-artifacts/*.gif e2e-artifacts/*.mp4
+	CHROMEDP_HEADLESS=$(CHROMEDP_HEADLESS) \
+	CHROMEDP_VIEWPORT_WIDTH=$(CHROMEDP_VIEWPORT_WIDTH) \
+	CHROMEDP_VIEWPORT_HEIGHT=$(CHROMEDP_VIEWPORT_HEIGHT) \
+	E2E_RECORD=$(E2E_RECORD) \
+	E2E_RECORD_FORMAT=$(E2E_RECORD_FORMAT) \
+	E2E_RECORD_FPS=$(E2E_RECORD_FPS) \
+	E2E_RECORD_HOLD_MS=$(E2E_RECORD_HOLD_MS) \
+	E2E_MOVE_DELAY_MS=$(E2E_MOVE_DELAY_MS) \
+	E2E_START_DELAY_MS=$(E2E_START_DELAY_MS) \
+	E2E_CAPTURE_DELAY_MS=$(E2E_CAPTURE_DELAY_MS) \
+	E2E_SEND_EMOJI=$(E2E_SEND_EMOJI) \
+	go test -tags e2e ./internal/e2e -run TestPlay -v
+	@echo "e2e artifacts: e2e-artifacts/"
+
 dev:
 	@command -v air >/dev/null || { echo "air not found"; exit 1; }
-	air -c .air.toml
+	air -c .air.toml

README.md

@@ -14,6 +14,91 @@ Anyone else who opens the link is a spectator.
 
 Players can react with any emoji using the built-in emoji picker.
 
+## Local development
+
+### Bootstrap
+
+- Go 1.22+
+- Make
+- Optional: `air` for live reload (`go install github.com/cosmtrek/air@latest`)
+- Optional: Postgres if you want persistence
+
+### Install + run
+
+```sh
+go mod download
+make run
+```
+
+Open http://localhost:8080.
+
+### Live reload (optional)
+
+```sh
+make dev
+```
+
+### Database (optional)
+
+Set `DATABASE_URL` to enable persistence (Postgres DSN), for example:
+
+```sh
+export DATABASE_URL="postgres://user:pass@localhost:5432/tinychess?sslmode=disable"
+```
+
+## Tests
+
+### Unit tests
+
+```sh
+go test ./...
+```
+
+### Browser e2e test (full game)
+
+Runs a headless browser test that opens two clients and plays a complete legal
+game (Fool's Mate) to verify a game can finish.
+
+```sh
+go test -tags e2e ./internal/e2e -run TestPlayFullGame
+```
+
+Notes:
+- Requires a local Chrome/Chromium install.
+- If Chrome isn't on your PATH, set `CHROME_BIN` to the browser executable.
+- If your environment needs it, set `CHROMEDP_NO_SANDBOX=1`.
+- To watch the game being played, run headed with `CHROMEDP_HEADLESS=0`.
+- To slow down moves, set `E2E_MOVE_DELAY_MS` (milliseconds between moves).
+- To pause before the first move, set `E2E_START_DELAY_MS`.
+- To wait for UI updates before capturing, set `E2E_CAPTURE_DELAY_MS`.
+- Famous quick mates:
+  - Fool's Mate: `go test -tags e2e ./internal/e2e -run TestPlayFullGame`
+  - Scholar's Mate: `go test -tags e2e ./internal/e2e -run TestPlayScholarsMate`
+- A longer demo test is available: `go test -tags e2e ./internal/e2e -run TestPlayLongGame`.
+- Optional recording:
+  - Set `E2E_RECORD=1` to capture screenshots before each move (white client).
+  - Output defaults to `e2e-artifacts/` (override with `E2E_RECORD_DIR`).
+  - Use `E2E_RECORD_FORMAT=mp4` (default), `gif`, or `frames` (PNGs only).
+  - Set `E2E_RECORD_FPS` to control playback (default `6`).
+  - Set `E2E_RECORD_HOLD_MS` to hold the final frame (default `2000`).
+  - Requires `ffmpeg` on PATH for mp4/gif.
+
+### Make target (run all e2e tests + stitch gifs)
+
+```sh
+E2E_RECORD=1 E2E_RECORD_FORMAT=gif E2E_RECORD_FPS=6 make test-e2e
+```
+
+Defaults can be overridden:
+- `CHROMEDP_HEADLESS=0` to watch the run.
+- `CHROMEDP_VIEWPORT_WIDTH` and `CHROMEDP_VIEWPORT_HEIGHT` for mobile/aspect testing.
+- `E2E_MOVE_DELAY_MS` and `E2E_START_DELAY_MS` for timing.
+- `E2E_CAPTURE_DELAY_MS` to wait for SSE/UI updates before each capture.
+- `E2E_RECORD_HOLD_MS` to extend the final frame.
+- `E2E_RECORD_FORMAT=frames` to skip stitching (no ffmpeg needed).
+- `E2E_SEND_EMOJI=0` to skip the emoji taunt (default on).
+- `E2E_EMOJI` to override the emoji character.
+
 ## Links
 
 - Production: https://tinychess.dusty.wtf/

bin/tinychess

@@ -1,21 +1,29 @@
 module tinychess
 
-go 1.22.2
+go 1.24
 
 require (
+	github.com/chromedp/chromedp v0.14.2
 	github.com/corentings/chess/v2 v2.2.0
 	github.com/google/uuid v1.5.0
 	gorm.io/driver/postgres v1.5.4
 	gorm.io/gorm v1.25.5
 )
 
 require (
+	github.com/chromedp/cdproto v0.0.0-20250724212937-08a3db8b4327 // indirect
+	github.com/chromedp/sysutil v1.1.0 // indirect
+	github.com/go-json-experiment/json v0.0.0-20250725192818-e39067aee2d2 // indirect
+	github.com/gobwas/httphead v0.1.0 // indirect
+	github.com/gobwas/pool v0.2.1 // indirect
+	github.com/gobwas/ws v1.4.0 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
 	github.com/jackc/pgx/v5 v5.4.3 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	golang.org/x/crypto v0.14.0 // indirect
 	golang.org/x/exp v0.0.0-20250128182459-e0ece0dbea4c // indirect
+	golang.org/x/sys v0.34.0 // indirect
 	golang.org/x/text v0.13.0 // indirect
 )

go.mod

@@ -1,8 +1,22 @@
+github.com/chromedp/cdproto v0.0.0-20250724212937-08a3db8b4327 h1:UQ4AU+BGti3Sy/aLU8KVseYKNALcX9UXY6DfpwQ6J8E=
+github.com/chromedp/cdproto v0.0.0-20250724212937-08a3db8b4327/go.mod h1:NItd7aLkcfOA/dcMXvl8p1u+lQqioRMq/SqDp71Pb/k=
+github.com/chromedp/chromedp v0.14.2 h1:r3b/WtwM50RsBZHMUm9fsNhhzRStTHrKdr2zmwbZSzM=
+github.com/chromedp/chromedp v0.14.2/go.mod h1:rHzAv60xDE7VNy/MYtTUrYreSc0ujt2O1/C3bzctYBo=
+github.com/chromedp/sysutil v1.1.0 h1:PUFNv5EcprjqXZD9nJb9b/c9ibAbxiYo4exNWZyipwM=
+github.com/chromedp/sysutil v1.1.0/go.mod h1:WiThHUdltqCNKGc4gaU50XgYjwjYIhKWoHGPTUfWTJ8=
 github.com/corentings/chess/v2 v2.2.0 h1:cvponglvX2gw73hGCgeP2B/RJOWqS1NElwBKNc2eue8=
 github.com/corentings/chess/v2 v2.2.0/go.mod h1:JhWYDbjY81/7NECXrLzz4g2r9taaMEXvyqS4gYZciVE=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-json-experiment/json v0.0.0-20250725192818-e39067aee2d2 h1:iizUGZ9pEquQS5jTGkh4AqeeHCMbfbjeb0zMt0aEFzs=
+github.com/go-json-experiment/json v0.0.0-20250725192818-e39067aee2d2/go.mod h1:TiCD2a1pcmjd7YnhGH0f/zKNcCD06B029pHhzV23c2M=
+github.com/gobwas/httphead v0.1.0 h1:exrUm0f4YX0L7EBwZHuCF4GDp8aJfVeBrlLQrs6NqWU=
+github.com/gobwas/httphead v0.1.0/go.mod h1:O/RXo79gxV8G+RqlR/otEwx4Q36zl9rqC5u12GKvMCM=
+github.com/gobwas/pool v0.2.1 h1:xfeeEhW7pwmX8nuLVlqbzVc7udMDrwetjEv+TZIz1og=
+github.com/gobwas/pool v0.2.1/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6WezmKEw=
+github.com/gobwas/ws v1.4.0 h1:CTaoG1tojrh4ucGPcoJFiAQUAsEWekEWvLy7GsVNqGs=
+github.com/gobwas/ws v1.4.0/go.mod h1:G3gNqMNtPppf5XUz7O4shetPpcZ1VJ7zt18dlUeakrc=
 github.com/google/uuid v1.5.0 h1:1p67kYwdtXjb0gL0BPiP1Av9wiZPo5A8z2cWkTZ+eyU=
 github.com/google/uuid v1.5.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
@@ -15,6 +29,10 @@ github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD
 github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc=
 github.com/jinzhu/now v1.1.5 h1:/o9tlHleP7gOFmsnYNz3RGnqzefHA47wQpKrrdTIwXQ=
 github.com/jinzhu/now v1.1.5/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8=
+github.com/ledongthuc/pdf v0.0.0-20220302134840-0c2507a12d80 h1:6Yzfa6GP0rIo/kULo2bwGEkFvCePZ3qHDDTC3/J9Swo=
+github.com/ledongthuc/pdf v0.0.0-20220302134840-0c2507a12d80/go.mod h1:imJHygn/1yfhB7XSJJKlFZKl/J+dCPAknuiaGOshXAs=
+github.com/orisano/pixelmatch v0.0.0-20220722002657-fb0b55479cde h1:x0TT0RDC7UhAVbbWWBzr41ElhJx5tXPWkIHA2HWPRuw=
+github.com/orisano/pixelmatch v0.0.0-20220722002657-fb0b55479cde/go.mod h1:nZgzbfBr3hhjoZnS66nKrHmduYNpc34ny7RK4z5/HM0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
@@ -26,6 +44,9 @@ golang.org/x/crypto v0.14.0 h1:wBqGXzWJW6m1XrIKlAH0Hs1JJ7+9KBwnIO8v66Q9cHc=
 golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4=
 golang.org/x/exp v0.0.0-20250128182459-e0ece0dbea4c h1:KL/ZBHXgKGVmuZBZ01Lt57yE5ws8ZPSkkihmEyq7FXc=
 golang.org/x/exp v0.0.0-20250128182459-e0ece0dbea4c/go.mod h1:tujkw807nyEEAamNbDrEGzRav+ilXA7PCRAd6xsmwiU=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA=
+golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k=
 golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=