Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e3324407ca |
+9
-80
@@ -1,80 +1,9 @@
|
|||||||
# .dockerignore does NOT use .gitignore semantics. Docker matches with
|
.git
|
||||||
# moby/patternmatcher: filepath.Match plus `**`, so `*` does not cross
|
*.md
|
||||||
# `/` and an unprefixed pattern is anchored at the context root. Every
|
!README.md
|
||||||
# depth-independent pattern therefore needs `**/`, or `config/.env` and
|
neoircd
|
||||||
# `certs/server.key` still ship while this file reads as solved. Only
|
neoirc-cli
|
||||||
# genuinely root-anchored entries go unprefixed. Never transplant these
|
data.db
|
||||||
# into .gitignore, where `**/` is wrong.
|
data.db-wal
|
||||||
#
|
data.db-shm
|
||||||
# Matching is case-sensitive, so secrets use character ranges rather
|
.env
|
||||||
# than an ALL-CAPS twin, which would still miss `Server.Key`.
|
|
||||||
#
|
|
||||||
# Extend with this repo's own host-built artifacts, written anchored:
|
|
||||||
# `/myapp`, never `**/myapp`, which also matches `cmd/myapp/` and
|
|
||||||
# deletes the package directory from the context.
|
|
||||||
|
|
||||||
# .git is sent without its config. Without a VERSION build argument the
|
|
||||||
# stage that compiles runs `git describe --tags --always` on .git, which
|
|
||||||
# does not need .git/config; that file can hold a credential, such as a
|
|
||||||
# password in a remote URL or the token the CI checkout step stores there.
|
|
||||||
# Each submodule keeps a config with the same exposure in its git directory
|
|
||||||
# under .git/modules/, nested again for a submodule's own submodules, or in
|
|
||||||
# its own .git directory when it keeps one.
|
|
||||||
# KNOWN GAP: a submodule whose name has a `config` segment (`config`,
|
|
||||||
# `deploy/config`, `config/lib`) loses its whole git directory, because
|
|
||||||
# `**/.git/modules/**/config` also matches that segment's directory
|
|
||||||
# under .git/modules/. Go's version stamping then fails the build;
|
|
||||||
# nothing leaks. Name such a submodule without that segment:
|
|
||||||
# `git submodule add --name`.
|
|
||||||
**/.git/config
|
|
||||||
**/.git/modules/**/config
|
|
||||||
|
|
||||||
# Agent scratch: one full checkout of the repo per in-flight agent.
|
|
||||||
# Anchored because it occurs once where agents run at the repo root.
|
|
||||||
# KNOWN GAP: a repo running agents in subdirectories still ships
|
|
||||||
# `services/api/.claude/` and must add its own anchored entry.
|
|
||||||
.claude
|
|
||||||
|
|
||||||
# Environment files. `*.env` covers bare `.env` and the `prod.env`
|
|
||||||
# convention. Re-include a committed template with a negation if the
|
|
||||||
# build needs one: `!docs/example.env`.
|
|
||||||
**/*.[eE][nN][vV]
|
|
||||||
**/.[eE][nN][vV].*
|
|
||||||
**/.[eE][nN][vV][rR][cC]
|
|
||||||
|
|
||||||
# Private keys and the bundles carrying them. Public certificates
|
|
||||||
# (*.crt, *.cer) are deliberately absent: they are legitimate inputs.
|
|
||||||
**/*.[pP][eE][mM]
|
|
||||||
**/*.[kK][eE][yY]
|
|
||||||
**/*.[pP]12
|
|
||||||
**/*.[pP][fF][xX]
|
|
||||||
**/[iI][dD]_[rR][sS][aA]
|
|
||||||
**/[iI][dD]_[dD][sS][aA]
|
|
||||||
**/[iI][dD]_[eE][cC][dD][sS][aA]
|
|
||||||
**/[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK]
|
|
||||||
**/[iI][dD]_[eE][dD]25519
|
|
||||||
**/[iI][dD]_[eE][dD]25519_[sS][kK]
|
|
||||||
|
|
||||||
# Dependencies: restored inside the image, never copied in.
|
|
||||||
**/node_modules
|
|
||||||
|
|
||||||
# OS metadata.
|
|
||||||
**/.DS_Store
|
|
||||||
**/Thumbs.db
|
|
||||||
|
|
||||||
# Editor state: never a build input, and it churns COPY.
|
|
||||||
**/*.swp
|
|
||||||
**/*.swo
|
|
||||||
**/*~
|
|
||||||
**/*.bak
|
|
||||||
**/.idea
|
|
||||||
**/.vscode
|
|
||||||
**/*.sublime-*
|
|
||||||
|
|
||||||
# This repository's host-built artifacts: the binaries, and the database
|
|
||||||
# a local run writes.
|
|
||||||
/neoircd
|
|
||||||
/neoirc-cli
|
|
||||||
/data.db
|
|
||||||
/data.db-wal
|
|
||||||
/data.db-shm
|
|
||||||
|
|||||||
@@ -10,8 +10,3 @@ insert_final_newline = true
|
|||||||
|
|
||||||
[Makefile]
|
[Makefile]
|
||||||
indent_style = tab
|
indent_style = tab
|
||||||
|
|
||||||
# This repository's own entries, after the shared content above.
|
|
||||||
|
|
||||||
[*.go]
|
|
||||||
indent_style = tab
|
|
||||||
|
|||||||
@@ -6,4 +6,4 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
# actions/checkout v4.2.2, 2026-02-22
|
# actions/checkout v4.2.2, 2026-02-22
|
||||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||||
- run: script/cibuild
|
- run: docker build .
|
||||||
|
|||||||
+10
-37
@@ -11,48 +11,19 @@ Thumbs.db
|
|||||||
.vscode/
|
.vscode/
|
||||||
*.sublime-*
|
*.sublime-*
|
||||||
|
|
||||||
# Agent scratch (worktrees of this repo, created and destroyed by
|
|
||||||
# in-flight tooling). Unanchored: .gitignore patterns already match at
|
|
||||||
# every depth, so no prefix is wanted here. This is not a .dockerignore
|
|
||||||
# entry and must not be given a `**/` prefix on the way into one.
|
|
||||||
.claude/
|
|
||||||
|
|
||||||
# Node
|
# Node
|
||||||
node_modules/
|
node_modules/
|
||||||
|
|
||||||
# Secrets. Unanchored like every entry above, so each matches at every
|
# Environment / secrets
|
||||||
# depth. Matching is case-sensitive on Linux, so names use character
|
.env
|
||||||
# ranges rather than a lowercase form that misses `Server.Key`.
|
.env.*
|
||||||
|
*.pem
|
||||||
# Environment files. `*.env` covers bare `.env` and the `prod.env`
|
*.key
|
||||||
# convention. Only the templates `example.env` and `sample.env` are
|
|
||||||
# re-included below. A repository that commits any other template adds
|
|
||||||
# its own negation after these lines, for example `!.env.example`.
|
|
||||||
*.[eE][nN][vV]
|
|
||||||
.[eE][nN][vV].*
|
|
||||||
.[eE][nN][vV][rR][cC]
|
|
||||||
!example.env
|
|
||||||
!sample.env
|
|
||||||
|
|
||||||
# Private keys and the bundles carrying them.
|
|
||||||
*.[pP][eE][mM]
|
|
||||||
*.[kK][eE][yY]
|
|
||||||
*.[pP]12
|
|
||||||
*.[pP][fF][xX]
|
|
||||||
[iI][dD]_[rR][sS][aA]
|
|
||||||
[iI][dD]_[dD][sS][aA]
|
|
||||||
[iI][dD]_[eE][cC][dD][sS][aA]
|
|
||||||
[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK]
|
|
||||||
[iI][dD]_[eE][dD]25519
|
|
||||||
[iI][dD]_[eE][dD]25519_[sS][kK]
|
|
||||||
|
|
||||||
# This repository's own entries, after the shared content above.
|
|
||||||
|
|
||||||
# Build artifacts
|
# Build artifacts
|
||||||
web/dist/
|
web/dist/
|
||||||
/bin/
|
|
||||||
/neoircd
|
/neoircd
|
||||||
/neoirc-cli
|
/bin/
|
||||||
*.exe
|
*.exe
|
||||||
*.dll
|
*.dll
|
||||||
*.so
|
*.so
|
||||||
@@ -61,6 +32,8 @@ web/dist/
|
|||||||
*.out
|
*.out
|
||||||
vendor/
|
vendor/
|
||||||
|
|
||||||
# Local database and logs
|
# Project
|
||||||
data.db
|
data.db
|
||||||
*.log
|
debug.log
|
||||||
|
/neoirc-cli
|
||||||
|
web/node_modules/
|
||||||
|
|||||||
+10
-73
@@ -1,30 +1,13 @@
|
|||||||
version: "2"
|
version: "2"
|
||||||
|
|
||||||
# Config schema uses the golangci-lint v2 layout (settings live under
|
|
||||||
# linters.settings, not top-level linters-settings) so that the
|
|
||||||
# thresholds below are actually applied by golangci-lint >= v2.
|
|
||||||
|
|
||||||
run:
|
run:
|
||||||
timeout: 5m
|
timeout: 5m
|
||||||
modules-download-mode: readonly
|
modules-download-mode: readonly
|
||||||
|
|
||||||
linters:
|
linters:
|
||||||
default: all
|
default: all
|
||||||
enable:
|
|
||||||
# Successor to the deprecated gomodguard. Named explicitly, rather than
|
|
||||||
# left to `default: all`, because it carries the module policy below.
|
|
||||||
- gomodguard_v2
|
|
||||||
disable:
|
disable:
|
||||||
# Genuinely incompatible with project patterns
|
- wsl # Deprecated in v2, replaced by wsl_v5
|
||||||
- exhaustruct # Requires all struct fields
|
|
||||||
- exhaustruct_v5 # Requires all struct fields (successor to exhaustruct)
|
|
||||||
- godot # Requires comments to end with periods
|
|
||||||
- wrapcheck # Too verbose for internal packages
|
|
||||||
- varnamelen # Short names like db, id are idiomatic Go
|
|
||||||
# Deprecated: the warning is attached to the old name, so it is
|
|
||||||
# silenced by disabling that name, not by enabling the successor.
|
|
||||||
- wsl # Deprecated, replaced by wsl_v5
|
|
||||||
- gomodguard # Deprecated, replaced by gomodguard_v2
|
|
||||||
settings:
|
settings:
|
||||||
lll:
|
lll:
|
||||||
line-length: 88
|
line-length: 88
|
||||||
@@ -35,65 +18,19 @@ linters:
|
|||||||
max-complexity: 15
|
max-complexity: 15
|
||||||
dupl:
|
dupl:
|
||||||
threshold: 100
|
threshold: 100
|
||||||
|
gosec:
|
||||||
|
excludes:
|
||||||
|
- G704
|
||||||
depguard:
|
depguard:
|
||||||
# Test-support code must not be compiled into the shipped binary. A
|
|
||||||
# test-support package exists to hand a test privileges the program
|
|
||||||
# itself must never have, so a file that is not a test must not import
|
|
||||||
# one. Test files, and the files inside a package whose directory name
|
|
||||||
# ends in `test`, are where that code belongs, and are exempt.
|
|
||||||
#
|
|
||||||
# The deny list below is the one part of this file a repository is
|
|
||||||
# expected to extend, and the only part it may. depguard matches an
|
|
||||||
# import path against a list of prefixes, so it cannot be told "any path
|
|
||||||
# whose last segment ends in test"; a repository's own test-support
|
|
||||||
# packages have to be named here one at a time, by full import path,
|
|
||||||
# under a module path that differs from repository to repository. Add
|
|
||||||
# them; change nothing else.
|
|
||||||
rules:
|
rules:
|
||||||
test-support:
|
all:
|
||||||
list-mode: lax
|
|
||||||
files:
|
|
||||||
- "$all"
|
|
||||||
- "!$test"
|
|
||||||
- "!**/*test/**"
|
|
||||||
deny:
|
deny:
|
||||||
- pkg: net/http/httptest
|
- pkg: "io/ioutil"
|
||||||
desc: >-
|
desc: "Deprecated; use io and os packages."
|
||||||
Test-support code belongs in test files and in packages whose
|
- pkg: "math/rand$"
|
||||||
directory name ends in test, not in the shipped binary.
|
desc: "Use crypto/rand for security-sensitive code."
|
||||||
# Only decisions already recorded in the Go package defaults are
|
|
||||||
# listed here. Every entry matches the module path exactly.
|
|
||||||
gomodguard_v2:
|
|
||||||
blocked:
|
|
||||||
- module: github.com/rs/zerolog
|
|
||||||
recommendations:
|
|
||||||
- log/slog
|
|
||||||
reason: "Structured logging is stdlib log/slog."
|
|
||||||
# One entry per pre-fork module path, because the later releases
|
|
||||||
# are separate paths. A prefix match would be shorter but would
|
|
||||||
# also reach github.com/go-redis/redismock, the test double for
|
|
||||||
# the successor these entries recommend.
|
|
||||||
- module: github.com/go-redis/redis
|
|
||||||
recommendations:
|
|
||||||
- github.com/redis/go-redis/v9
|
|
||||||
reason: "Pre-fork module; use the maintained go-redis v9."
|
|
||||||
- module: github.com/go-redis/redis/v7
|
|
||||||
recommendations:
|
|
||||||
- github.com/redis/go-redis/v9
|
|
||||||
reason: "Pre-fork module; use the maintained go-redis v9."
|
|
||||||
- module: github.com/go-redis/redis/v8
|
|
||||||
recommendations:
|
|
||||||
- github.com/redis/go-redis/v9
|
|
||||||
reason: "Pre-fork module; use the maintained go-redis v9."
|
|
||||||
- module: github.com/sergi/go-diff
|
|
||||||
recommendations:
|
|
||||||
- github.com/aymanbagabas/go-udiff
|
|
||||||
reason: "No unified diff output; use go-udiff."
|
|
||||||
- module: github.com/hexops/gotextdiff
|
|
||||||
recommendations:
|
|
||||||
- github.com/aymanbagabas/go-udiff
|
|
||||||
reason: "Unmaintained fork; use go-udiff."
|
|
||||||
|
|
||||||
issues:
|
issues:
|
||||||
|
exclude-use-default: false
|
||||||
max-issues-per-linter: 0
|
max-issues-per-linter: 0
|
||||||
max-same-issues: 0
|
max-same-issues: 0
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
node_modules/
|
|
||||||
yarn.lock
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"tabWidth": 4,
|
|
||||||
"proseWrap": "always"
|
|
||||||
}
|
|
||||||
@@ -2,12 +2,10 @@
|
|||||||
|
|
||||||
## Before Every Commit
|
## Before Every Commit
|
||||||
|
|
||||||
1. **Format**: `make fmt`
|
1. **Format**: `gofmt -s -w .` and `goimports -w .`
|
||||||
2. **Check**: `make check` — the tests and the linter, which run in Docker, and
|
2. **Lint**: `golangci-lint run --config .golangci.yml ./...` — zero issues
|
||||||
the format check: all passing, zero issues
|
3. **Test**: `go test -race ./...` — all passing
|
||||||
|
4. **Build**: `go build ./cmd/neoircd` — compiles clean
|
||||||
Never run `go test`, `golangci-lint` or `gofmt` directly; use the `make`
|
|
||||||
targets.
|
|
||||||
|
|
||||||
No commit lands on main with lint errors, test failures, or formatting issues.
|
No commit lands on main with lint errors, test failures, or formatting issues.
|
||||||
|
|
||||||
|
|||||||
+15
-21
@@ -1,8 +1,6 @@
|
|||||||
# Go HTTP Server Conventions
|
# Go HTTP Server Conventions
|
||||||
|
|
||||||
This document defines the architectural patterns, design decisions, and
|
This document defines the architectural patterns, design decisions, and conventions for building Go HTTP servers. All new projects must follow these standards.
|
||||||
conventions for building Go HTTP servers. All new projects must follow these
|
|
||||||
standards.
|
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
@@ -86,11 +84,10 @@ project-root/
|
|||||||
|
|
||||||
### Key Principles
|
### Key Principles
|
||||||
|
|
||||||
- **`cmd/{appname}/`**: Only the entry point. Minimal logic, just bootstrapping.
|
- **`cmd/{appname}/`**: Only the entry point. Minimal logic, just bootstrapping.
|
||||||
- **`internal/`**: All application packages. Not importable by external
|
- **`internal/`**: All application packages. Not importable by external projects.
|
||||||
projects.
|
- **One package per concern**: config, database, handlers, middleware, etc.
|
||||||
- **One package per concern**: config, database, handlers, middleware, etc.
|
- **Flat handler files**: One file per handler or logical group of handlers.
|
||||||
- **Flat handler files**: One file per handler or logical group of handlers.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -191,8 +188,7 @@ Providers are resolved automatically by fx, but conceptually follow this order:
|
|||||||
2. `logger.New` - Logger (depends on Globals)
|
2. `logger.New` - Logger (depends on Globals)
|
||||||
3. `config.New` - Configuration (depends on Globals, Logger)
|
3. `config.New` - Configuration (depends on Globals, Logger)
|
||||||
4. `database.New` - Database (depends on Logger, Config)
|
4. `database.New` - Database (depends on Logger, Config)
|
||||||
5. `healthcheck.New` - Health check (depends on Globals, Config, Logger,
|
5. `healthcheck.New` - Health check (depends on Globals, Config, Logger, Database)
|
||||||
Database)
|
|
||||||
6. `middleware.New` - Middleware (depends on Logger, Globals, Config)
|
6. `middleware.New` - Middleware (depends on Logger, Globals, Config)
|
||||||
7. `handlers.New` - Handlers (depends on Logger, Globals, Database, Healthcheck)
|
7. `handlers.New` - Handlers (depends on Logger, Globals, Database, Healthcheck)
|
||||||
8. `server.New` - Server (depends on all above)
|
8. `server.New` - Server (depends on all above)
|
||||||
@@ -456,11 +452,11 @@ func New(lc fx.Lifecycle, params HandlersParams) (*Handlers, error) {
|
|||||||
### Closure-Based Handler Pattern
|
### Closure-Based Handler Pattern
|
||||||
|
|
||||||
For JSON route handlers, both the request and the response structures are
|
For JSON route handlers, both the request and the response structures are
|
||||||
defined in the scope of the method that returns the HandlerFunc. They can be
|
defined in the scope of the method that returns the HandlerFunc. They can
|
||||||
called simply `Request` and `Response` or slightly more descriptive names.
|
be called simply `Request` and `Response` or slightly more descriptive
|
||||||
|
names.
|
||||||
|
|
||||||
All handlers return `http.HandlerFunc` using the closure pattern. This allows
|
All handlers return `http.HandlerFunc` using the closure pattern. This allows initialization logic to run once when the handler is created:
|
||||||
initialization logic to run once when the handler is created:
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
// internal/handlers/index.go
|
// internal/handlers/index.go
|
||||||
@@ -521,11 +517,10 @@ func (s *Handlers) decodeJSON(w http.ResponseWriter, r *http.Request, v interfac
|
|||||||
|
|
||||||
### Handler Naming Convention
|
### Handler Naming Convention
|
||||||
|
|
||||||
- `HandleIndex()` - Main page
|
- `HandleIndex()` - Main page
|
||||||
- `HandleLoginGET()` / `HandleLoginPOST()` - Form handlers with HTTP method
|
- `HandleLoginGET()` / `HandleLoginPOST()` - Form handlers with HTTP method suffix
|
||||||
suffix
|
- `HandleNow()` - API endpoints
|
||||||
- `HandleNow()` - API endpoints
|
- `HandleHealthCheck()` - System endpoints
|
||||||
- `HandleHealthCheck()` - System endpoints
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -746,8 +741,7 @@ func New(lc fx.Lifecycle, params ConfigParams) (*Config, error) {
|
|||||||
|
|
||||||
1. **Environment variables** (highest priority via `AutomaticEnv()`)
|
1. **Environment variables** (highest priority via `AutomaticEnv()`)
|
||||||
2. **`.env` file** (loaded via `godotenv/autoload` import)
|
2. **`.env` file** (loaded via `godotenv/autoload` import)
|
||||||
3. **Config files**: `/etc/{appname}/{appname}.yaml`,
|
3. **Config files**: `/etc/{appname}/{appname}.yaml`, `~/.config/{appname}/{appname}.yaml`
|
||||||
`~/.config/{appname}/{appname}.yaml`
|
|
||||||
4. **Defaults** (lowest priority)
|
4. **Defaults** (lowest priority)
|
||||||
|
|
||||||
### Environment Loading
|
### Environment Loading
|
||||||
|
|||||||
+19
-46
@@ -8,69 +8,42 @@ COPY web/src/ src/
|
|||||||
COPY web/build.sh build.sh
|
COPY web/build.sh build.sh
|
||||||
RUN sh build.sh
|
RUN sh build.sh
|
||||||
|
|
||||||
# Lint phase, built alone by script/lint. The linter is invoked directly
|
# Lint stage — fast feedback on formatting and lint issues
|
||||||
# rather than through `make lint`, which is itself a docker build and
|
# golangci/golangci-lint:v2.1.6, 2026-03-02
|
||||||
# would recurse into a daemon that does not exist in a build step.
|
FROM golangci/golangci-lint@sha256:568ee1c1c53493575fa9494e280e579ac9ca865787bafe4df3023ae59ecf299b AS lint
|
||||||
# golangci/golangci-lint:v2.14.0, 2026-10-06
|
|
||||||
FROM golangci/golangci-lint@sha256:ad862ba6b3798cbe0fd9fd7408d498fd74fbd2623a92406b2fd3898faf0bf98f AS lint
|
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
COPY . .
|
COPY . .
|
||||||
# Placeholder files so //go:embed dist/* in web/embed.go resolves
|
# Create placeholder files so //go:embed dist/* in web/embed.go resolves
|
||||||
# without waiting for the web-builder stage. The test phase does the same.
|
# without depending on the web-builder stage (lint should fail fast)
|
||||||
RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css web/dist/app.js
|
RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css web/dist/app.js
|
||||||
RUN golangci-lint run --config .golangci.yml ./...
|
RUN make fmt-check
|
||||||
|
RUN make lint
|
||||||
|
|
||||||
# Test phase, built alone by script/test. -race needs cgo and so a C
|
# Build stage
|
||||||
# compiler, which the Debian Go image ships and the alpine one does not.
|
|
||||||
# golang:1.24.13-bookworm, 2026-10-06
|
|
||||||
FROM golang@sha256:1a6d4452c65dea36aac2e2d606b01b4a029ec90cc1ae53890540ce6173ea77ac AS test
|
|
||||||
WORKDIR /src
|
|
||||||
COPY go.mod go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
COPY . .
|
|
||||||
RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css web/dist/app.js
|
|
||||||
# -p 4 because test runs on a shared build host cap their parallelism.
|
|
||||||
RUN go test -p 4 -timeout 90s -race -cover ./... || \
|
|
||||||
{ echo "--- Rerunning with -v for details ---"; \
|
|
||||||
go test -p 4 -timeout 90s -race -v ./...; exit 1; }
|
|
||||||
|
|
||||||
# Build stage. Nothing is wanted from either phase above; the copies
|
|
||||||
# are what make BuildKit build them first, so this stage cannot run
|
|
||||||
# unless lint and test passed.
|
|
||||||
# golang:1.24-alpine, 2026-02-26
|
# golang:1.24-alpine, 2026-02-26
|
||||||
FROM golang@sha256:8bee1901f1e530bfb4a7850aa7a479d17ae3a18beb6e09064ed54cfd245b7191 AS builder
|
FROM golang@sha256:8bee1901f1e530bfb4a7850aa7a479d17ae3a18beb6e09064ed54cfd245b7191 AS builder
|
||||||
COPY --from=lint /src/go.sum /dev/null
|
|
||||||
COPY --from=test /src/go.sum /dev/null
|
|
||||||
RUN apk add --no-cache git
|
|
||||||
# A tar-stream context keeps the sender's file owners, which git refuses.
|
|
||||||
RUN git config --system --add safe.directory /src
|
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
|
RUN apk add --no-cache git build-base make
|
||||||
|
|
||||||
|
# Force BuildKit to run the lint stage before proceeding
|
||||||
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
|
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
COPY --from=web-builder /web/dist/ web/dist/
|
COPY --from=web-builder /web/dist/ web/dist/
|
||||||
|
|
||||||
|
RUN make test
|
||||||
|
|
||||||
# Build static binaries (no cgo needed at runtime — modernc.org/sqlite is pure Go)
|
# Build static binaries (no cgo needed at runtime — modernc.org/sqlite is pure Go)
|
||||||
#
|
ARG VERSION=dev
|
||||||
# neoircd is stamped with the VERSION build arg when one is given, otherwise
|
RUN CGO_ENABLED=0 go build -trimpath -ldflags="-s -w -X main.Version=${VERSION}" -o /neoircd ./cmd/neoircd/
|
||||||
# with `git describe --tags --always` on the .git in the build context. With
|
|
||||||
# .git present, a version that is still empty, dev or unknown fails the build:
|
|
||||||
# git is missing or could not read the checkout.
|
|
||||||
ARG VERSION
|
|
||||||
RUN VERSION="${VERSION:-$(git describe --tags --always)}"; \
|
|
||||||
if [ -e .git ]; then \
|
|
||||||
case "$VERSION" in ""|dev|unknown) \
|
|
||||||
echo "version is '$VERSION' although .git is present" >&2; \
|
|
||||||
exit 1 ;; \
|
|
||||||
esac; \
|
|
||||||
fi; \
|
|
||||||
CGO_ENABLED=0 go build -trimpath -ldflags="-s -w -X main.Version=${VERSION}" -o /neoircd ./cmd/neoircd/
|
|
||||||
RUN CGO_ENABLED=0 go build -trimpath -ldflags="-s -w" -o /neoirc-cli ./cmd/neoirc-cli/
|
RUN CGO_ENABLED=0 go build -trimpath -ldflags="-s -w" -o /neoirc-cli ./cmd/neoirc-cli/
|
||||||
|
|
||||||
# Runtime stage, and the last one: a plain `docker build .` builds this
|
# Runtime stage
|
||||||
# stage's chain and nothing else.
|
|
||||||
# alpine:3.21, 2026-02-26
|
# alpine:3.21, 2026-02-26
|
||||||
FROM alpine@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709
|
FROM alpine@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709
|
||||||
RUN apk add --no-cache ca-certificates \
|
RUN apk add --no-cache ca-certificates \
|
||||||
|
|||||||
@@ -1,25 +1,16 @@
|
|||||||
.PHONY: all bootstrap setup build lint fmt fmt-check test check clean run debug docker hooks ensure-web-dist
|
.PHONY: all build lint fmt fmt-check test check clean run debug docker hooks ensure-web-dist
|
||||||
|
|
||||||
BINARY := neoircd
|
BINARY := neoircd
|
||||||
VERSION := $(shell git describe --tags --always --dirty 2>/dev/null || echo "dev")
|
VERSION := $(shell git describe --tags --always --dirty 2>/dev/null || echo "dev")
|
||||||
LDFLAGS := -X main.Version=$(VERSION)
|
BUILDARCH := $(shell go env GOARCH)
|
||||||
|
LDFLAGS := -X main.Version=$(VERSION) -X main.Buildarch=$(BUILDARCH)
|
||||||
# The standard targets are thin shims; the implementations live in
|
|
||||||
# script/ per the scripts-to-rule-them-all pattern (see the Entrypoints
|
|
||||||
# section of README.md).
|
|
||||||
|
|
||||||
all: check build
|
all: check build
|
||||||
|
|
||||||
bootstrap:
|
|
||||||
@script/bootstrap
|
|
||||||
|
|
||||||
setup:
|
|
||||||
@script/setup
|
|
||||||
|
|
||||||
# ensure-web-dist creates placeholder files so //go:embed dist/* in
|
# ensure-web-dist creates placeholder files so //go:embed dist/* in
|
||||||
# web/embed.go resolves without a full Node.js build. The real SPA is
|
# web/embed.go resolves without a full Node.js build. The real SPA is
|
||||||
# built by the web-builder Docker stage; these placeholders let
|
# built by the web-builder Docker stage; these placeholders let
|
||||||
# "make build" work outside Docker.
|
# "make test" and "make build" work outside Docker.
|
||||||
ensure-web-dist:
|
ensure-web-dist:
|
||||||
@if [ ! -d web/dist ]; then \
|
@if [ ! -d web/dist ]; then \
|
||||||
mkdir -p web/dist && \
|
mkdir -p web/dist && \
|
||||||
@@ -30,20 +21,25 @@ ensure-web-dist:
|
|||||||
build: ensure-web-dist
|
build: ensure-web-dist
|
||||||
go build -ldflags "$(LDFLAGS)" -o bin/$(BINARY) ./cmd/neoircd
|
go build -ldflags "$(LDFLAGS)" -o bin/$(BINARY) ./cmd/neoircd
|
||||||
|
|
||||||
test:
|
lint: ensure-web-dist
|
||||||
@script/test
|
golangci-lint run --config .golangci.yml ./...
|
||||||
|
|
||||||
lint:
|
|
||||||
@script/lint
|
|
||||||
|
|
||||||
fmt:
|
fmt:
|
||||||
@script/fmt
|
gofmt -s -w .
|
||||||
|
goimports -w .
|
||||||
|
|
||||||
fmt-check:
|
fmt-check:
|
||||||
@script/fmt-check
|
@test -z "$$(gofmt -l .)" || (echo "Files not formatted:" && gofmt -l . && exit 1)
|
||||||
|
|
||||||
check:
|
test: ensure-web-dist
|
||||||
@script/check
|
go test -timeout 120s -race -cover ./... || go test -timeout 120s -race -v ./...
|
||||||
|
|
||||||
|
# check runs all validation without making changes
|
||||||
|
# Used by CI and Docker build — fails if anything is wrong
|
||||||
|
check: test lint fmt-check
|
||||||
|
@echo "==> Building..."
|
||||||
|
go build -ldflags "$(LDFLAGS)" -o /dev/null ./cmd/neoircd
|
||||||
|
@echo "==> All checks passed!"
|
||||||
|
|
||||||
run: build
|
run: build
|
||||||
./bin/$(BINARY)
|
./bin/$(BINARY)
|
||||||
@@ -55,7 +51,10 @@ clean:
|
|||||||
rm -rf bin/ neoircd
|
rm -rf bin/ neoircd
|
||||||
|
|
||||||
docker:
|
docker:
|
||||||
@script/docker
|
docker build -t neoirc .
|
||||||
|
|
||||||
hooks:
|
hooks:
|
||||||
@script/install-precommit
|
@printf '#!/bin/sh\nset -e\n' > .git/hooks/pre-commit
|
||||||
|
@printf 'go mod tidy\ngo fmt ./...\ngit diff --exit-code -- go.mod go.sum || { echo "go mod tidy changed files; please stage and retry"; exit 1; }\n' >> .git/hooks/pre-commit
|
||||||
|
@printf 'make check\n' >> .git/hooks/pre-commit
|
||||||
|
@chmod +x .git/hooks/pre-commit
|
||||||
|
|||||||
+29
-513
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Repository Policies
|
title: Repository Policies
|
||||||
last_modified: 2026-10-04
|
last_modified: 2026-03-09
|
||||||
---
|
---
|
||||||
|
|
||||||
This document covers repository structure, tooling, and workflow standards. Code
|
This document covers repository structure, tooling, and workflow standards. Code
|
||||||
@@ -34,57 +34,10 @@ style conventions are in separate documents:
|
|||||||
every file before committing. There are zero exceptions to this rule.
|
every file before committing. There are zero exceptions to this rule.
|
||||||
|
|
||||||
- Every repo with software must have a root `Makefile` with these targets:
|
- Every repo with software must have a root `Makefile` with these targets:
|
||||||
`make bootstrap`, `make setup`, `make test`, `make lint`, `make fmt` (writes),
|
`make test`, `make lint`, `make fmt` (writes), `make fmt-check` (read-only),
|
||||||
`make fmt-check` (read-only), `make check` (runs `test`, `lint`, `fmt-check`),
|
`make check` (prereqs: `test`, `lint`, `fmt-check`), `make docker`, and
|
||||||
`make docker`, and `make hooks` (installs pre-commit hook). A model Makefile
|
`make hooks` (installs pre-commit hook). A model Makefile is at
|
||||||
is at `https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile`.
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile`.
|
||||||
|
|
||||||
- Repos follow the
|
|
||||||
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
|
||||||
pattern: the implementation of each Makefile target lives in an executable
|
|
||||||
script in `script/` (`script/bootstrap`, `script/setup`, `script/test`,
|
|
||||||
`script/lint`, `script/fmt`, `script/fmt-check`, `script/check`,
|
|
||||||
`script/docker`), and the Makefile targets are thin shims that call them. The
|
|
||||||
scripts must be POSIX sh (`#!/bin/sh`, `set -eu`, no bashisms) so they run in
|
|
||||||
minimal containers (e.g. alpine images have no bash); locate the repo root
|
|
||||||
with `$(cd "$(dirname "$0")/.." && pwd -P)` and `cd` there before acting. From
|
|
||||||
the standard's canonical set we use `bootstrap`, `setup` (make the repo ready
|
|
||||||
for development after a fresh clone: runs `bootstrap`, then
|
|
||||||
`install-precommit`, plus any repo-specific initialization), `test`, and
|
|
||||||
`cibuild`. `script/bootstrap` installs all dependencies idempotently and
|
|
||||||
assumes nothing is present: base tools come from nix, apt, brew, or apk
|
|
||||||
(detected in that order; apt runs noninteractive). For node it uses the
|
|
||||||
installed node if present; otherwise it installs a PINNED node version via
|
|
||||||
nvm, first installing nvm itself if missing — from a hash-verified GitHub
|
|
||||||
release archive (never `curl | sh`), with bash installed as an explicit
|
|
||||||
prerequisite since nvm requires bash. yarn is then pinned via
|
|
||||||
`corepack prepare yarn@<version> --activate`. Never install "latest" or "lts";
|
|
||||||
always exact versions. `script/cibuild` runs the CI build: it changes to the
|
|
||||||
repo root, runs `script/bootstrap`, runs `script/check`, and builds the image
|
|
||||||
with the version; the Gitea workflow calls it. **`script/cibuild` runs
|
|
||||||
`script/bootstrap` first**, because the workflow checks out the repo and runs
|
|
||||||
nothing else, while `script/fmt-check` runs the formatter on the host: on a
|
|
||||||
pristine checkout with nothing installed the run dies there, after the
|
|
||||||
containerised gates have passed. **The bootstrap alone is not enough**:
|
|
||||||
`script/bootstrap` installs node and yarn under nvm and leaves neither on the
|
|
||||||
`PATH` of the shell that called it, so a bare `yarn` still exits 127. The host
|
|
||||||
entrypoints that need yarn — `script/fmt` and `script/fmt-check` — therefore
|
|
||||||
source nvm for the pinned node version before invoking it, exactly as
|
|
||||||
`script/bootstrap`'s own install step does. A runner carrying nothing but
|
|
||||||
docker and git then gets through `script/check`. Four further scripts are our
|
|
||||||
own extensions to the standard: `script/check` runs `script/test`,
|
|
||||||
`script/lint` and `script/fmt-check`; `script/precommit` is what the git
|
|
||||||
pre-commit hook runs, and it calls `script/check`; `script/install-precommit`
|
|
||||||
installs the git pre-commit hook (the `make hooks` target shims to it); and
|
|
||||||
`script/projectname` (literally that filename) simply outputs the project's
|
|
||||||
name. Scripts that need the name call `script/projectname` — e.g.
|
|
||||||
`script/docker` assembles its image tag from it — so those scripts stay
|
|
||||||
byte-identical across all repos. Repo-type-specific pre-commit extras (e.g.
|
|
||||||
`go mod tidy` verification in Go repos) belong in `script/precommit`, not in
|
|
||||||
the hook itself. Model scripts are at
|
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/script/<name>`. The README
|
|
||||||
must document the provided scripts in an **Entrypoints** section (see the
|
|
||||||
README requirements below).
|
|
||||||
|
|
||||||
- Always use Makefile targets (`make fmt`, `make test`, `make lint`, etc.)
|
- Always use Makefile targets (`make fmt`, `make test`, `make lint`, etc.)
|
||||||
instead of invoking the underlying tools directly. The Makefile is the single
|
instead of invoking the underlying tools directly. The Makefile is the single
|
||||||
@@ -100,198 +53,15 @@ style conventions are in separate documents:
|
|||||||
contributor should be able to understand the entire development workflow by
|
contributor should be able to understand the entire development workflow by
|
||||||
reading the Makefile.
|
reading the Makefile.
|
||||||
|
|
||||||
- Every repo should have a `Dockerfile`, and it carries the repo's gates: a
|
- Every repo should have a `Dockerfile`. All Dockerfiles must run `make check`
|
||||||
`lint` phase and a `test` phase, with the final stage depending on both so the
|
as a build step so the build fails if the branch is not green. For non-server
|
||||||
image cannot be built unless they pass. For non-server repos the final stage
|
repos, the Dockerfile should bring up a development environment and run
|
||||||
brings up a development environment; for server repos it is the runtime image.
|
`make check`. For server repos, `make check` should run as an early build
|
||||||
The gate phases and the build stage start from their pinned base images and
|
stage before the final image is assembled.
|
||||||
install what those images lack either inline, as the canonical Go `Dockerfile`
|
|
||||||
below does for `git`, or by running `script/bootstrap`, as the `prompts`
|
|
||||||
repo's own `Dockerfile` does for its yarn packages. The development
|
|
||||||
environment stage installs development prerequisites by running
|
|
||||||
`script/bootstrap` rather than duplicating its installs inline. A stage that
|
|
||||||
runs `script/bootstrap` COPYs `script/` and the dependency manifests
|
|
||||||
(`package.json` + `yarn.lock`, `go.mod` + `go.sum`, etc.) before running it.
|
|
||||||
|
|
||||||
- **Linting and testing run in Docker, as phases of the `Dockerfile`.** There is
|
|
||||||
no separate lint file. `script/lint` and `script/test` each build one phase
|
|
||||||
and nothing else:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
docker build --no-cache --target lint -t "$(script/projectname)-lint" .
|
|
||||||
docker build --no-cache --target test -t "$(script/projectname)-test" .
|
|
||||||
```
|
|
||||||
|
|
||||||
**A stage that is not the last one in the file is built only when the final
|
|
||||||
stage's chain depends on it, or when `--target` names it.** That is why the
|
|
||||||
two gates are always invoked by name here, and why the final stage carries a
|
|
||||||
`COPY --from=` of a harmless file from each of them: without that edge a
|
|
||||||
plain `docker build .` builds the last stage alone and exits 0 having linted
|
|
||||||
and tested nothing.
|
|
||||||
|
|
||||||
**Every `docker build` in `script/` is tagged**, here and in
|
|
||||||
`script/cibuild` and `script/docker`. An untagged build leaves a dangling
|
|
||||||
image behind on every invocation, on every developer host and every CI
|
|
||||||
runner; a tagged one replaces the previous image.
|
|
||||||
|
|
||||||
Inside a phase the tool is invoked directly — `golangci-lint`, `go test`,
|
|
||||||
`eslint`, `prettier` — never through `make lint` or `script/test`, which are
|
|
||||||
themselves a `docker build` and would recurse into a daemon that does not
|
|
||||||
exist in a build step. Formatting is the exception and stays on the host:
|
|
||||||
`script/fmt` writes the working tree, and `script/fmt-check` is its
|
|
||||||
read-only twin.
|
|
||||||
|
|
||||||
**No lint verdict may come from a host invocation of the linter.** On a
|
|
||||||
shared host golangci-lint reads a result cache keyed on file content rather
|
|
||||||
than location, so a second checkout of the same content is served the first
|
|
||||||
one's findings, and a host-global lock in `$TMPDIR` makes concurrent runs
|
|
||||||
exit non-zero with `parallel golangci-lint is running` — a status a caller
|
|
||||||
cannot tell from real findings. Both have produced wrong verdicts in this
|
|
||||||
org, in both directions. A container has its own cache, its own `TMPDIR` and
|
|
||||||
a digest-pinned binary, so neither is reachable.
|
|
||||||
|
|
||||||
- **Any build that runs checks is built with `--no-cache`.** Docker invalidates
|
|
||||||
a `COPY` layer only when the copied content changes, so on an unchanged tree
|
|
||||||
the check `RUN` is served from cache, nothing executes, and the build still
|
|
||||||
exits 0. Every `docker build` in `script/` therefore passes `--no-cache`:
|
|
||||||
`script/lint`, `script/test`, `script/cibuild` and `script/docker` are the
|
|
||||||
four, and there is no fifth — `script/check` runs the two gate phases and
|
|
||||||
`script/fmt-check`, and builds no image of its own. A bare `docker build .` is
|
|
||||||
not evidence that anything ran: a sub-second build reporting success is a
|
|
||||||
cache hit, not a result. Never invalidate by pruning — `docker builder prune`
|
|
||||||
and friends destroy a build cache shared with every other build on the host.
|
|
||||||
When a check is added or changed, prove it works by planting a defect it must
|
|
||||||
catch and watching the run fail on it, then revert the defect. A green run
|
|
||||||
alone shows neither that the check ran nor that it covers what it should.
|
|
||||||
|
|
||||||
- **The gate phases are separate stages, and the build stage depends on both.**
|
|
||||||
The lint phase is based on the `golangci/golangci-lint` image (pinned by
|
|
||||||
hash), so lint failures surface in seconds rather than after a full compile,
|
|
||||||
and the test phase is based on the Debian Go image. The canonical Go repo
|
|
||||||
`Dockerfile`:
|
|
||||||
|
|
||||||
```dockerfile
|
|
||||||
# Lint phase
|
|
||||||
# golangci/golangci-lint:v2.x.x, YYYY-MM-DD
|
|
||||||
FROM golangci/golangci-lint@sha256:... AS lint
|
|
||||||
WORKDIR /src
|
|
||||||
COPY go.mod go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
COPY . .
|
|
||||||
RUN golangci-lint run --config .golangci.yml ./...
|
|
||||||
|
|
||||||
# Test phase. -race needs cgo and so a C compiler, which the Debian Go
|
|
||||||
# image ships and the alpine one does not.
|
|
||||||
# golang:1.x, YYYY-MM-DD
|
|
||||||
FROM golang@sha256:... AS test
|
|
||||||
WORKDIR /src
|
|
||||||
COPY go.mod go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
COPY . .
|
|
||||||
RUN go test -timeout 90s -race -cover ./... || \
|
|
||||||
{ echo "--- Rerunning with -v for details ---"; \
|
|
||||||
go test -timeout 90s -race -v ./...; exit 1; }
|
|
||||||
|
|
||||||
# Build stage. Nothing is wanted from either phase above; the copies
|
|
||||||
# are what make BuildKit build them first, so this stage cannot run
|
|
||||||
# unless lint and test passed.
|
|
||||||
# golang:1.x-alpine, YYYY-MM-DD
|
|
||||||
FROM golang@sha256:... AS builder
|
|
||||||
COPY --from=lint /src/go.sum /dev/null
|
|
||||||
COPY --from=test /src/go.sum /dev/null
|
|
||||||
RUN apk add --no-cache git
|
|
||||||
# A tar-stream context keeps the sender's file owners, which git refuses.
|
|
||||||
RUN git config --system --add safe.directory /src
|
|
||||||
WORKDIR /src
|
|
||||||
COPY go.mod go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# The VERSION build arg when one is given, otherwise
|
|
||||||
# `git describe --tags --always` on the .git in the build context. With
|
|
||||||
# .git present, a version that is still empty, dev or unknown fails the
|
|
||||||
# build: git is missing or could not read the checkout.
|
|
||||||
ARG VERSION
|
|
||||||
RUN VERSION="${VERSION:-$(git describe --tags --always)}"; \
|
|
||||||
if [ -e .git ]; then \
|
|
||||||
case "$VERSION" in ""|dev|unknown) \
|
|
||||||
echo "version is '$VERSION' although .git is present" >&2; \
|
|
||||||
exit 1 ;; \
|
|
||||||
esac; \
|
|
||||||
fi; \
|
|
||||||
CGO_ENABLED=0 go build -trimpath \
|
|
||||||
-ldflags="-s -w -X main.Version=${VERSION}" \
|
|
||||||
-o /app ./cmd/app/
|
|
||||||
|
|
||||||
# Runtime stage, and the last one
|
|
||||||
FROM alpine@sha256:...
|
|
||||||
COPY --from=builder /app /usr/local/bin/app
|
|
||||||
ENTRYPOINT ["app"]
|
|
||||||
```
|
|
||||||
|
|
||||||
Key points:
|
|
||||||
- The lint phase uses the `golangci/golangci-lint` image directly (it has
|
|
||||||
both Go and the linter), so nothing needs installing.
|
|
||||||
- `COPY --from=<phase> /src/go.sum /dev/null` is a no-op copy whose only
|
|
||||||
purpose is the ordering edge. BuildKit runs stages in parallel by default,
|
|
||||||
and a stage nothing depends on is not built at all, so without these two
|
|
||||||
lines a red gate would not fail the build.
|
|
||||||
- Keep the runtime stage last, and if you add a stage after it, give it the
|
|
||||||
same two copies. A plain `docker build .` builds the last stage's chain
|
|
||||||
and nothing else.
|
|
||||||
- If the project uses `//go:embed` directives that reference build artifacts
|
|
||||||
(e.g. a web frontend compiled in a separate stage), the lint phase must
|
|
||||||
create placeholder files so the embed directives resolve. Example:
|
|
||||||
`RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`.
|
|
||||||
- If the project requires CGO or system libraries for linting, install them
|
|
||||||
in the lint phase. The `golangci/golangci-lint` image is Debian-based and
|
|
||||||
has no `apk`, so install with `apt-get` under the Debian package name
|
|
||||||
(`libvips-dev`, where alpine says `vips-dev`), and delete the package
|
|
||||||
lists in the same `RUN`, so the layer does not keep them:
|
|
||||||
|
|
||||||
```dockerfile
|
|
||||||
RUN apt-get update \
|
|
||||||
&& apt-get install -y --no-install-recommends libvips-dev \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
|
||||||
```
|
|
||||||
|
|
||||||
- `.dockerignore` lets `.git` into the build context. It keeps out every git
|
|
||||||
`config` at any depth (`**/.git/config`, `**/.git/modules/**/config`): the
|
|
||||||
repository's own, each submodule's under `.git/modules/`, and that of a
|
|
||||||
submodule keeping its own `.git` directory. `git describe` does not need
|
|
||||||
them, and each can hold a credential: a password in a remote URL, or the
|
|
||||||
token the CI checkout step stores there. A submodule whose name has a
|
|
||||||
`config` segment (`config`, `deploy/config`, `config/lib`) loses its whole
|
|
||||||
git directory to `**/.git/modules/**/config`, and Go's version stamping
|
|
||||||
then fails the build: give it a name without that segment
|
|
||||||
(`git submodule add --name`). The stage that compiles has `git` (the
|
|
||||||
Debian Go image has it; an alpine one needs `apk add --no-cache git`) and
|
|
||||||
takes the version from the `VERSION` build argument when one is given,
|
|
||||||
otherwise from `git describe --tags --always`. That gives the tag on a
|
|
||||||
tagged commit; on a later commit, the tag, the number of commits since it
|
|
||||||
and the short commit (`v1.2.3-4-gabc1234`); and the short commit when no
|
|
||||||
tag is reachable. The stage that compiles also marks its working directory
|
|
||||||
safe for git (`git config --system --add safe.directory /src`): a context
|
|
||||||
sent as a tar stream keeps the sender's file owners, and git refuses a
|
|
||||||
checkout owned by another user, so the version would come out empty.
|
|
||||||
`ARG VERSION` has no default, and the build fails if the context carries
|
|
||||||
`.git` and the version still comes out empty, `dev` or `unknown`. A plain
|
|
||||||
`docker build .` with no build arguments must succeed; a Dockerfile that
|
|
||||||
refuses an empty build argument drops that refusal and keeps the argument.
|
|
||||||
|
|
||||||
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
||||||
runs `script/cibuild` on push, and checks out the repo as its only other step.
|
runs `docker build .` on push. Since the Dockerfile already runs `make check`,
|
||||||
That script bootstraps, runs the gate phases, and then builds the image, so a
|
a successful build implies all checks pass.
|
||||||
successful run means every check passed; a bare `docker build .` does not
|
|
||||||
carry the same guarantee, because its gate phases may come from the cache. The
|
|
||||||
image build is uncached and so runs the gate phases a second time. That is the
|
|
||||||
price of the rule above, and it is worth paying: the image that ships is built
|
|
||||||
from a run of its own gates rather than from a cache entry. A separate
|
|
||||||
workflow limited to `main` by a `branches` list under `on: push` cannot be
|
|
||||||
checked by review: to try a change to it, add the feature branch to that list
|
|
||||||
and push, then remove the branch from the list again before merging. Keep any
|
|
||||||
job in it that publishes behind `if: github.ref_name == 'main'`, so the run
|
|
||||||
from the feature branch publishes nothing.
|
|
||||||
|
|
||||||
- Use platform-standard formatters: `black` for Python, `prettier` for
|
- Use platform-standard formatters: `black` for Python, `prettier` for
|
||||||
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
|
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
|
||||||
@@ -299,11 +69,9 @@ style conventions are in separate documents:
|
|||||||
Markdown (hard-wrap at 80 columns). Documentation and writing repos (Markdown,
|
Markdown (hard-wrap at 80 columns). Documentation and writing repos (Markdown,
|
||||||
HTML, CSS) should also have `.prettierrc` and `.prettierignore`.
|
HTML, CSS) should also have `.prettierrc` and `.prettierignore`.
|
||||||
|
|
||||||
- Pre-commit hook: runs `script/precommit`, which calls `script/check`. If local
|
- Pre-commit hook: `make check` if local testing is possible, otherwise
|
||||||
testing is not possible in the repo, `script/precommit` may skip `script/test`
|
`make lint && make fmt-check`. The Makefile should provide a `make hooks`
|
||||||
and run only `script/lint` and `script/fmt-check`. The hook is installed by
|
target to install the pre-commit hook.
|
||||||
`script/install-precommit`; the Makefile must provide a `make hooks` target
|
|
||||||
that shims to it.
|
|
||||||
|
|
||||||
- All repos with software must have tests that run via the platform-standard
|
- All repos with software must have tests that run via the platform-standard
|
||||||
test framework (`go test`, `pytest`, `jest`/`vitest`, etc.). If no meaningful
|
test framework (`go test`, `pytest`, `jest`/`vitest`, etc.). If no meaningful
|
||||||
@@ -311,66 +79,8 @@ style conventions are in separate documents:
|
|||||||
module under test to verify it compiles/parses. There is no excuse for
|
module under test to verify it compiles/parses. There is no excuse for
|
||||||
`make test` to be a no-op.
|
`make test` to be a no-op.
|
||||||
|
|
||||||
- `make test` must complete in under 60 seconds. That is the hard cap, and a
|
- `make test` must complete in under 20 seconds. Add a 30-second timeout in the
|
||||||
suite that exceeds it fails. Under 20 seconds is the target. A suite between
|
Makefile.
|
||||||
20 and 60 seconds is still green, but the overage must be filed as an
|
|
||||||
improvement bug against that repo. Add a 90-second timeout to the test
|
|
||||||
invocation (`go test -timeout 90s`). The backstop deliberately sits above the
|
|
||||||
hard cap so that it catches a genuinely hung test rather than a merely slow
|
|
||||||
one.
|
|
||||||
|
|
||||||
- **The test command should use the conditional verbose rerun pattern.** Run
|
|
||||||
tests without `-v` (verbose) first. If tests fail, automatically rerun with
|
|
||||||
`-v` to show full output. This keeps CI logs and `docker build` output clean
|
|
||||||
on success (just package/suite summaries) while providing full diagnostic
|
|
||||||
detail on failure (every test case, every assertion). The command lives in the
|
|
||||||
`test` phase of the `Dockerfile`, since `script/test` builds that phase; the
|
|
||||||
Makefile form below is the same pattern for any repo-local invocation:
|
|
||||||
|
|
||||||
```makefile
|
|
||||||
test:
|
|
||||||
@<test-command> || \
|
|
||||||
{ echo "--- Rerunning with -v for details ---"; \
|
|
||||||
<test-command-with-v>; exit 1; }
|
|
||||||
```
|
|
||||||
|
|
||||||
Go example:
|
|
||||||
|
|
||||||
```makefile
|
|
||||||
test:
|
|
||||||
@go test -count=1 -timeout 90s -race -cover ./... || \
|
|
||||||
{ echo "--- Rerunning with -v for details ---"; \
|
|
||||||
go test -count=1 -timeout 90s -race -v ./...; exit 1; }
|
|
||||||
```
|
|
||||||
|
|
||||||
`-count=1` is required on both invocations: it defeats Go's test _result_
|
|
||||||
cache, so neither run can report a stored pass in place of running the
|
|
||||||
tests. It leaves the build cache alone, so it costs the runtime of the suite
|
|
||||||
and no recompilation.
|
|
||||||
|
|
||||||
That cache is Go's own, separate from Docker's layer cache. Go stores a
|
|
||||||
passing result in its cache directory (`GOCACHE`), and when the same tests
|
|
||||||
run again on unchanged code it prints that result, marked `(cached)`,
|
|
||||||
without running them. That matters on a developer's machine, where this
|
|
||||||
target runs and the directory lasts from one run to the next. The `test`
|
|
||||||
phase of the `Dockerfile` needs no `-count=1`: its base image holds no
|
|
||||||
result for this repo's tests and nothing before its `go test` step runs a
|
|
||||||
test, so there is nothing to replay. `--no-cache` (above) is what makes that
|
|
||||||
step run on an unchanged tree.
|
|
||||||
|
|
||||||
Python example:
|
|
||||||
|
|
||||||
```makefile
|
|
||||||
test:
|
|
||||||
@python -m pytest || \
|
|
||||||
{ echo "--- Rerunning with -v for details ---"; \
|
|
||||||
python -m pytest -v; exit 1; }
|
|
||||||
```
|
|
||||||
|
|
||||||
The `exit 1` ensures the target always fails after a rerun — the first run
|
|
||||||
already proved the tests are broken, so the build must not pass even if a
|
|
||||||
flaky test happens to succeed on the second attempt. The rerun exists solely
|
|
||||||
for diagnostic output.
|
|
||||||
|
|
||||||
- Docker builds must complete in under 5 minutes.
|
- Docker builds must complete in under 5 minutes.
|
||||||
|
|
||||||
@@ -383,84 +93,10 @@ style conventions are in separate documents:
|
|||||||
must be in `.gitignore`. No exceptions.
|
must be in `.gitignore`. No exceptions.
|
||||||
|
|
||||||
- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`),
|
- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`),
|
||||||
editor files (`.swp`, `*~`), in-repo agent scratch directories (`.claude/`),
|
editor files (`.swp`, `*~`), language build artifacts, and `node_modules/`.
|
||||||
language build artifacts, and `node_modules/`. Fetch the standard `.gitignore`
|
Fetch the standard `.gitignore` from
|
||||||
from `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when setting up
|
||||||
setting up a new repo. These patterns are written to `.gitignore`'s own
|
a new repo.
|
||||||
semantics, in which an unanchored pattern already matches at every depth; they
|
|
||||||
are not a `.dockerignore` and must not be transplanted into one unmodified.
|
|
||||||
|
|
||||||
- **`.dockerignore` does not use `.gitignore` semantics, and copying patterns
|
|
||||||
across unmodified leaves secrets in the build context.** Docker matches with
|
|
||||||
`moby/patternmatcher`: `filepath.Match` semantics plus a `**` extension, so
|
|
||||||
`*` does not cross `/` and a pattern without a leading `**/` is anchored at
|
|
||||||
the build-context root. A `.dockerignore` listing `.env`, `*.pem` and `*.key`
|
|
||||||
therefore excludes only the copies at the repository root, while `config/.env`
|
|
||||||
and `certs/server.key` still reach the context and can land in an image layer
|
|
||||||
— which is more dangerous than a short file with no secret patterns at all,
|
|
||||||
because it reads as solved and stops anyone looking. Give every
|
|
||||||
depth-independent pattern the `**/` prefix and leave only genuinely
|
|
||||||
root-anchored entries unprefixed: `.claude`, and the repo's own host-built
|
|
||||||
binary, written `/myapp` and never `**/myapp`, which would also match
|
|
||||||
`cmd/myapp/` and delete the package directory from the context. Matching is
|
|
||||||
case-sensitive, and an ALL-CAPS twin per pattern still misses `Server.Key`, so
|
|
||||||
secret names use character ranges — `**/*.[kK][eE][yY]`, `**/*.[pP][eE][mM]`,
|
|
||||||
and likewise for `.envrc` and the extensionless SSH keys. Where such a pattern
|
|
||||||
also catches something the build needs, re-include it with a negation
|
|
||||||
(`!docs/example.env`); deleting the pattern reopens the exposure for every
|
|
||||||
other file it covers. Fetch the standard `.dockerignore` from
|
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore` and extend
|
|
||||||
it with the repo's own artifacts.
|
|
||||||
|
|
||||||
- **In-repo agent scratch belongs in both files, written to each file's own
|
|
||||||
semantics.** `.claude/` holds one worktree per in-flight agent — an entire
|
|
||||||
additional checkout of the repo — so under `COPY . .` the build context
|
|
||||||
inflates by a multiple of the repo and another session's unreviewed work can
|
|
||||||
be copied into an image layer. In `.gitignore` the entry is `.claude/`,
|
|
||||||
unanchored. In `.dockerignore` it is `.claude`, anchored and with **no** `**/`
|
|
||||||
prefix, because the prefixed form would also delete any nested directory of
|
|
||||||
that name from the build. Anchoring carries a known gap that the canonical
|
|
||||||
`.dockerignore` states in its own comment, since consuming repos receive the
|
|
||||||
file and not the tracker: the directory is created in the agent's working
|
|
||||||
directory, so a repo running agents in subdirectories still ships
|
|
||||||
`services/api/.claude/` and must add its own anchored entry there.
|
|
||||||
|
|
||||||
- **A plain `docker build .` of a clone stamps the version that
|
|
||||||
`git describe --tags --always` gives**, derived from the `.git` in the build
|
|
||||||
context as the canonical `Dockerfile` above shows. Without its failure check,
|
|
||||||
a missing `git` or an unreadable checkout would leave `-X main.Version=` empty
|
|
||||||
and the build would still exit 0. `script/docker` and `script/cibuild` pass
|
|
||||||
the version they compute on the host; it takes precedence. They do this
|
|
||||||
byte-identically across repos:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# Own line: a failing command substitution inside an argument does not
|
|
||||||
# trip `set -e`, so the inline form degrades to an empty constant.
|
|
||||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
|
||||||
[ -n "$version" ] || version="unknown"
|
|
||||||
docker build --no-cache \
|
|
||||||
--build-arg VERSION="$version" \
|
|
||||||
-t "$(script/projectname)" .
|
|
||||||
```
|
|
||||||
|
|
||||||
`--always` makes an untagged repo yield an abbreviated commit hash rather
|
|
||||||
than failing, and the `[ -n "$version" ]` line is the single place the
|
|
||||||
fallback is applied — a live check that fires on a build from an export with
|
|
||||||
no `.git` and on a repository with no commits yet. Do not fold it into the
|
|
||||||
substitution as `|| echo unknown`, which makes the guard unreachable. The
|
|
||||||
Dockerfile's side is `ARG VERSION` in the stage that compiles, declared
|
|
||||||
there because `ARG` is stage-scoped; passing `VERSION` to a repo whose
|
|
||||||
Dockerfile declares no such `ARG` is ignored and costs nothing, which is why
|
|
||||||
the scripts stay byte-identical. One consequence for CI: the standard
|
|
||||||
checkout action clones shallow and fetches no tags, so a repo that embeds a
|
|
||||||
tag-derived version must set `fetch-depth: 0` on its checkout step.
|
|
||||||
|
|
||||||
- **Verify `.dockerignore` by enumerating the image, not by reading the
|
|
||||||
patterns.** Plant files at the root _and_ at least two directories deep, build
|
|
||||||
a probe image that does `COPY . .`, and list what actually landed
|
|
||||||
(`docker run --rm --entrypoint find IMAGE /app`). The `transferring context`
|
|
||||||
size is not a substitute: a nested secret is a few bytes, and BuildKit
|
|
||||||
transfers only the delta from the previous build.
|
|
||||||
|
|
||||||
- **No build artifacts in version control.** Code-derived data (compiled
|
- **No build artifacts in version control.** Code-derived data (compiled
|
||||||
bundles, minified output, generated assets) must never be committed to the
|
bundles, minified output, generated assets) must never be committed to the
|
||||||
@@ -476,56 +112,9 @@ style conventions are in separate documents:
|
|||||||
- Make all changes on a feature branch. You can do whatever you want on a
|
- Make all changes on a feature branch. You can do whatever you want on a
|
||||||
feature branch.
|
feature branch.
|
||||||
|
|
||||||
- `.golangci.yml` is standardized. The vendored copy in a consuming repo must
|
- `.golangci.yml` is standardized and must _NEVER_ be modified by an agent, only
|
||||||
_NEVER_ be modified by an agent: fetch it from
|
manually by the user. Fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml` and keep it
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml`.
|
||||||
byte-identical, so that no repo can quietly loosen its own linting. Linter
|
|
||||||
configuration changes are made to the canonical copy in the `prompts` repo and
|
|
||||||
reach consuming repos by re-vendoring; an agent may open a PR against
|
|
||||||
canonical, which only the user merges. One list is exempt from byte-identity,
|
|
||||||
because it cannot be written once for every repo: the `deny` list of the
|
|
||||||
`test-support` depguard rule, where a repo names its own test-support packages
|
|
||||||
by full import path. A repo adds entries there and changes nothing else, and a
|
|
||||||
re-vendor carries its entries forward. The canonical golangci-lint version is
|
|
||||||
v2.14.0 (released 2026-09-24), pinned as the digest of the lint phase's base
|
|
||||||
image
|
|
||||||
(`golangci/golangci-lint@sha256:ad862ba6b3798cbe0fd9fd7408d498fd74fbd2623a92406b2fd3898faf0bf98f`,
|
|
||||||
which reports `2.14.0 built with go1.27.0 from 114493f9`). A module's `go`
|
|
||||||
directive must not name a newer Go minor version than the one golangci-lint
|
|
||||||
was built with, or golangci-lint refuses to lint it: this release lints
|
|
||||||
`go 1.27.1` but not `go 1.28`. That digest is the only pin, since no repo
|
|
||||||
installs golangci-lint on the host. A repo sets the lint phase digest to the
|
|
||||||
one named here and re-vendors `.golangci.yml` in the same commit, whichever of
|
|
||||||
the two prompted the change: the canonical copy can name linters that an older
|
|
||||||
golangci-lint rejects, and a newer golangci-lint can add linters that
|
|
||||||
`default: all` switches on until the canonical copy disables them.
|
|
||||||
|
|
||||||
- **`script/bootstrap` installs a pinned tool by comparing versions, never by
|
|
||||||
testing presence.** An `if ! command -v <tool>; then install; fi` guard tests
|
|
||||||
`PATH` only, so on an already-provisioned machine the pin is inert and a
|
|
||||||
version bump is a silent no-op — while the Dockerfile, installing into a clean
|
|
||||||
image, gets the pinned version, so a local `make check` and `make docker` can
|
|
||||||
disagree about what the tool even is. The canonical form:
|
|
||||||
- compares the installed version against the pin over the **whole** version
|
|
||||||
token; a parser that stops at the first `-` reports `2.12.2` for a host
|
|
||||||
running `2.12.2-rc1` and skips the install;
|
|
||||||
- treats absent, non-zero, empty or unrecognised `--version` output as a
|
|
||||||
mismatch, so the failure direction is a redundant install and never a
|
|
||||||
skipped one;
|
|
||||||
- after installing, re-resolves the binary the way callers do — `hash -r`,
|
|
||||||
then through `PATH`, not through the directory the installer wrote to —
|
|
||||||
and fails naming the resolved path, since an install that a shadowing
|
|
||||||
binary hides succeeds while changing nothing any caller sees;
|
|
||||||
- is actually called, and prints the version on both success paths: a
|
|
||||||
function defined and never invoked has the same exit status and the same
|
|
||||||
empty output as one that worked.
|
|
||||||
|
|
||||||
Keep it POSIX sh: no arrays, no `[[`, no `grep -P`.
|
|
||||||
|
|
||||||
A Go tool a repo needs on the host is installed with `go install` pinned to
|
|
||||||
a commit hash (`go install <package>@<commit hash>`). It is never tracked as
|
|
||||||
a `go.mod` tool dependency or through a `tools.go` file, either of which
|
|
||||||
pulls the tool's own dependencies into the repo's `go.mod` and `go.sum`.
|
|
||||||
|
|
||||||
- When pinning images or packages by hash, add a comment above the reference
|
- When pinning images or packages by hash, add a comment above the reference
|
||||||
with the version and date (YYYY-MM-DD).
|
with the version and date (YYYY-MM-DD).
|
||||||
@@ -539,76 +128,12 @@ style conventions are in separate documents:
|
|||||||
- Dockerized web services listen on port 8080 by default, overridable with
|
- Dockerized web services listen on port 8080 by default, overridable with
|
||||||
`PORT`.
|
`PORT`.
|
||||||
|
|
||||||
- **HTTP/web services must be hardened for production internet exposure before
|
|
||||||
tagging 1.0.** This means full compliance with security best practices
|
|
||||||
including, without limitation, all of the following:
|
|
||||||
- **Security headers** on every response:
|
|
||||||
- `Strict-Transport-Security` (HSTS) with `max-age` of at least one year
|
|
||||||
and `includeSubDomains`.
|
|
||||||
- `Content-Security-Policy` (CSP) with a restrictive default policy
|
|
||||||
(`default-src 'self'` as a baseline, tightened per-resource as
|
|
||||||
needed). Never use `unsafe-inline` or `unsafe-eval` unless
|
|
||||||
unavoidable, and document the reason.
|
|
||||||
- `X-Frame-Options: DENY` (or `SAMEORIGIN` if framing is required).
|
|
||||||
Prefer the `frame-ancestors` CSP directive as the primary control.
|
|
||||||
- `X-Content-Type-Options: nosniff`.
|
|
||||||
- `Referrer-Policy: strict-origin-when-cross-origin` (or stricter).
|
|
||||||
- `Permissions-Policy` restricting access to browser features the
|
|
||||||
application does not use (camera, microphone, geolocation, etc.).
|
|
||||||
- **Request and response limits:**
|
|
||||||
- Maximum request body size enforced on all endpoints (e.g. Go
|
|
||||||
`http.MaxBytesReader`). Choose a sane default per-route; never accept
|
|
||||||
unbounded input.
|
|
||||||
- Maximum response body size where applicable (e.g. paginated APIs).
|
|
||||||
- `ReadTimeout` and `ReadHeaderTimeout` on the `http.Server` to defend
|
|
||||||
against slowloris attacks.
|
|
||||||
- `WriteTimeout` on the `http.Server`.
|
|
||||||
- `IdleTimeout` on the `http.Server`.
|
|
||||||
- Per-handler execution time limits via `context.WithTimeout` or
|
|
||||||
chi/stdlib `middleware.Timeout`.
|
|
||||||
- **Authentication and session security:**
|
|
||||||
- Rate limiting on password-based authentication endpoints. API keys are
|
|
||||||
high-entropy and not susceptible to brute force, so they are exempt.
|
|
||||||
- CSRF tokens on all state-mutating HTML forms. API endpoints
|
|
||||||
authenticated via `Authorization` header (Bearer token, API key) are
|
|
||||||
exempt because the browser does not attach these automatically.
|
|
||||||
- Passwords stored using bcrypt, scrypt, or argon2 — never plain-text,
|
|
||||||
MD5, or SHA.
|
|
||||||
- Session cookies set with `HttpOnly`, `Secure`, and `SameSite=Lax` (or
|
|
||||||
`Strict`) attributes.
|
|
||||||
- **Reverse proxy awareness:**
|
|
||||||
- True client IP detection when behind a reverse proxy
|
|
||||||
(`X-Forwarded-For`, `X-Real-IP`). The application must accept
|
|
||||||
forwarded headers only from a configured set of trusted proxy
|
|
||||||
addresses — never trust `X-Forwarded-For` unconditionally.
|
|
||||||
- **CORS:**
|
|
||||||
- Authenticated endpoints must restrict `Access-Control-Allow-Origin` to
|
|
||||||
an explicit allowlist of known origins. Wildcard (`*`) is acceptable
|
|
||||||
only for public, unauthenticated read-only APIs.
|
|
||||||
- **Error handling:**
|
|
||||||
- Internal errors must never leak stack traces, SQL queries, file paths,
|
|
||||||
or other implementation details to the client. Return generic error
|
|
||||||
messages in production; detailed errors only when `DEBUG` is enabled.
|
|
||||||
- **TLS:**
|
|
||||||
- Services never terminate TLS directly. They are always deployed behind
|
|
||||||
a TLS-terminating reverse proxy. The service itself listens on plain
|
|
||||||
HTTP. However, HSTS headers and `Secure` cookie flags must still be
|
|
||||||
set by the application so that the browser enforces HTTPS end-to-end.
|
|
||||||
|
|
||||||
This list is non-exhaustive. Apply defense-in-depth: if a standard security
|
|
||||||
hardening measure exists for HTTP services and is not listed here, it is
|
|
||||||
still expected. When in doubt, harden.
|
|
||||||
|
|
||||||
- `README.md` is the primary documentation. Required sections:
|
- `README.md` is the primary documentation. Required sections:
|
||||||
- **Description**: First line must include the project name, purpose,
|
- **Description**: First line must include the project name, purpose,
|
||||||
category (web server, SPA, CLI tool, etc.), license, and author. Example:
|
category (web server, SPA, CLI tool, etc.), license, and author. Example:
|
||||||
"µPaaS is an MIT-licensed Go web application by @sneak that receives
|
"µPaaS is an MIT-licensed Go web application by @sneak that receives
|
||||||
git-frontend webhooks and deploys applications via Docker in realtime."
|
git-frontend webhooks and deploys applications via Docker in realtime."
|
||||||
- **Getting Started**: Copy-pasteable install/usage code block.
|
- **Getting Started**: Copy-pasteable install/usage code block.
|
||||||
- **Entrypoints**: Opens by stating that the repo adheres to the
|
|
||||||
[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
|
|
||||||
standard (with that link), then documents each provided `script/`
|
|
||||||
entrypoint and its purpose.
|
|
||||||
- **Rationale**: Why does this exist?
|
- **Rationale**: Why does this exist?
|
||||||
- **Design**: How is the program structured?
|
- **Design**: How is the program structured?
|
||||||
- **TODO**: Update meticulously, even between commits. When planning, put
|
- **TODO**: Update meticulously, even between commits. When planning, put
|
||||||
@@ -639,14 +164,12 @@ style conventions are in separate documents:
|
|||||||
settings.
|
settings.
|
||||||
|
|
||||||
- Avoid putting files in the repo root unless necessary. Root should contain
|
- Avoid putting files in the repo root unless necessary. Root should contain
|
||||||
only project-level config files (`README.md`, `AGENTS.md`, `Makefile`,
|
only project-level config files (`README.md`, `Makefile`, `Dockerfile`,
|
||||||
`Dockerfile`, `LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`,
|
`LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`, and
|
||||||
and language-specific config). Everything else goes in a subdirectory.
|
language-specific config). Everything else goes in a subdirectory. Canonical
|
||||||
Canonical subdirectory names:
|
subdirectory names:
|
||||||
- `bin/` — executable scripts and tools
|
- `bin/` — executable scripts and tools
|
||||||
- `cmd/` — Go command entrypoints; thin only: one `main.go` per binary whose
|
- `cmd/` — Go command entrypoints
|
||||||
body is a single call into `internal/` or `pkg/`, no project logic in
|
|
||||||
`cmd/`
|
|
||||||
- `configs/` — configuration templates and examples
|
- `configs/` — configuration templates and examples
|
||||||
- `deploy/` — deployment manifests (k8s, compose, terraform)
|
- `deploy/` — deployment manifests (k8s, compose, terraform)
|
||||||
- `docs/` — documentation and markdown (README.md stays in root)
|
- `docs/` — documentation and markdown (README.md stays in root)
|
||||||
@@ -665,15 +188,8 @@ style conventions are in separate documents:
|
|||||||
- `README.md`, `.git`, `.gitignore`, `.editorconfig`
|
- `README.md`, `.git`, `.gitignore`, `.editorconfig`
|
||||||
- `LICENSE`, `REPO_POLICIES.md` (copy from the `prompts` repo)
|
- `LICENSE`, `REPO_POLICIES.md` (copy from the `prompts` repo)
|
||||||
- `Makefile`
|
- `Makefile`
|
||||||
- `script/` entrypoints (`bootstrap`, `setup`, `projectname`, `test`,
|
|
||||||
`lint`, `fmt`, `fmt-check`, `check`, `docker`, `cibuild`, `precommit`,
|
|
||||||
`install-precommit`)
|
|
||||||
- `Dockerfile`, `.dockerignore`
|
- `Dockerfile`, `.dockerignore`
|
||||||
- `.gitea/workflows/check.yml`
|
- `.gitea/workflows/check.yml`
|
||||||
- Go: `go.mod`, `go.sum`, `.golangci.yml`
|
- Go: `go.mod`, `go.sum`, `.golangci.yml`
|
||||||
- JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
- JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
||||||
- Python: `pyproject.toml`
|
- Python: `pyproject.toml`
|
||||||
|
|
||||||
- Guidance for coding agents lives in one `AGENTS.md` at the repository root. It
|
|
||||||
is never committed under a file or directory named after one agent tool, such
|
|
||||||
as `CLAUDE.md` or `.claude/`, and never split into separate memory files.
|
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"net"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/cookiejar"
|
"net/http/cookiejar"
|
||||||
"net/url"
|
"net/url"
|
||||||
@@ -42,34 +41,11 @@ func NewClient(baseURL string) *Client {
|
|||||||
BaseURL: baseURL,
|
BaseURL: baseURL,
|
||||||
HTTPClient: &http.Client{ //nolint:exhaustruct // defaults fine
|
HTTPClient: &http.Client{ //nolint:exhaustruct // defaults fine
|
||||||
Timeout: httpTimeout,
|
Timeout: httpTimeout,
|
||||||
Jar: loopbackJar{CookieJar: jar},
|
Jar: jar,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// loopbackJar also sends the server's auth cookie, which is
|
|
||||||
// always Secure, over plain HTTP to a server on localhost, as
|
|
||||||
// curl does. Go 1.24's cookie jar sends a Secure cookie only
|
|
||||||
// over HTTPS.
|
|
||||||
type loopbackJar struct {
|
|
||||||
http.CookieJar
|
|
||||||
}
|
|
||||||
|
|
||||||
// Cookies returns the cookies to send to target, treating a
|
|
||||||
// plain-HTTP target on localhost as HTTPS.
|
|
||||||
func (jar loopbackJar) Cookies(target *url.URL) []*http.Cookie {
|
|
||||||
host := target.Hostname()
|
|
||||||
loopback := host == "localhost" || net.ParseIP(host).IsLoopback()
|
|
||||||
|
|
||||||
if target.Scheme == "http" && loopback {
|
|
||||||
secure := *target
|
|
||||||
secure.Scheme = "https"
|
|
||||||
target = &secure
|
|
||||||
}
|
|
||||||
|
|
||||||
return jar.CookieJar.Cookies(target)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CreateSession creates a new session on the server.
|
// CreateSession creates a new session on the server.
|
||||||
// If the server requires hashcash proof-of-work, it
|
// If the server requires hashcash proof-of-work, it
|
||||||
// automatically fetches the difficulty and computes a
|
// automatically fetches the difficulty and computes a
|
||||||
|
|||||||
@@ -1,97 +0,0 @@
|
|||||||
package neoircapi_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"io"
|
|
||||||
"net"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"net/url"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
api "sneak.berlin/go/neoirc/internal/cli/api"
|
|
||||||
)
|
|
||||||
|
|
||||||
const cookieValue = "opaque-value"
|
|
||||||
|
|
||||||
// newSessionServer starts a plain-HTTP server that, like
|
|
||||||
// neoircd, sets a Secure auth cookie when a session is
|
|
||||||
// created and answers GET /api/v1/state only when that
|
|
||||||
// cookie comes back.
|
|
||||||
func newSessionServer(t *testing.T) *httptest.Server {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
mux := http.NewServeMux()
|
|
||||||
|
|
||||||
mux.HandleFunc("GET /api/v1/server", func(
|
|
||||||
writer http.ResponseWriter, _ *http.Request,
|
|
||||||
) {
|
|
||||||
_, _ = io.WriteString(writer, `{}`)
|
|
||||||
})
|
|
||||||
|
|
||||||
mux.HandleFunc("POST /api/v1/session", func(
|
|
||||||
writer http.ResponseWriter, _ *http.Request,
|
|
||||||
) {
|
|
||||||
http.SetCookie(writer, &http.Cookie{
|
|
||||||
Name: "neoirc_auth",
|
|
||||||
Value: cookieValue,
|
|
||||||
Path: "/",
|
|
||||||
HttpOnly: true,
|
|
||||||
Secure: true,
|
|
||||||
SameSite: http.SameSiteStrictMode,
|
|
||||||
})
|
|
||||||
writer.WriteHeader(http.StatusCreated)
|
|
||||||
|
|
||||||
_, _ = io.WriteString(writer, `{"id":1,"nick":"alice"}`)
|
|
||||||
})
|
|
||||||
|
|
||||||
mux.HandleFunc("GET /api/v1/state", func(
|
|
||||||
writer http.ResponseWriter, request *http.Request,
|
|
||||||
) {
|
|
||||||
cookie, err := request.Cookie("neoirc_auth")
|
|
||||||
if err != nil || cookie.Value != cookieValue {
|
|
||||||
writer.WriteHeader(http.StatusUnauthorized)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
_, _ = io.WriteString(
|
|
||||||
writer, `{"id":1,"nick":"alice","channels":[]}`,
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
server := httptest.NewServer(mux)
|
|
||||||
t.Cleanup(server.Close)
|
|
||||||
|
|
||||||
return server
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestClientKeepsSessionOverPlainHTTPOnLocalhost(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
server := newSessionServer(t)
|
|
||||||
|
|
||||||
serverURL, err := url.Parse(server.URL)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse server URL: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, host := range []string{"127.0.0.1", "localhost"} {
|
|
||||||
t.Run(host, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
client := api.NewClient(
|
|
||||||
"http://" + net.JoinHostPort(host, serverURL.Port()),
|
|
||||||
)
|
|
||||||
|
|
||||||
_, err := client.CreateSession("alice")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create session: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = client.GetState()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("state after creating the session: %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// Package db provides database access and migration management.
|
||||||
package db
|
package db
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|||||||
+12
-22
@@ -1150,8 +1150,7 @@ func scanMessages(
|
|||||||
code, _ := strconv.Atoi(msg.Command)
|
code, _ := strconv.Atoi(msg.Command)
|
||||||
msg.Code = code
|
msg.Code = code
|
||||||
|
|
||||||
mt, lookupErr := irc.FromInt(code)
|
if mt, err := irc.FromInt(code); err == nil {
|
||||||
if lookupErr == nil {
|
|
||||||
msg.Command = mt.Name()
|
msg.Command = mt.Name()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1374,9 +1373,7 @@ func (database *Database) GetStaleOrphanSessions(
|
|||||||
|
|
||||||
for rows.Next() {
|
for rows.Next() {
|
||||||
var stale StaleSession
|
var stale StaleSession
|
||||||
|
if err := rows.Scan(&stale.ID, &stale.Nick); err != nil {
|
||||||
err = rows.Scan(&stale.ID, &stale.Nick)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"scan stale session: %w", err,
|
"scan stale session: %w", err,
|
||||||
)
|
)
|
||||||
@@ -1385,8 +1382,7 @@ func (database *Database) GetStaleOrphanSessions(
|
|||||||
result = append(result, stale)
|
result = append(result, stale)
|
||||||
}
|
}
|
||||||
|
|
||||||
err = rows.Err()
|
if err := rows.Err(); err != nil {
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"iterate stale sessions: %w", err,
|
"iterate stale sessions: %w", err,
|
||||||
)
|
)
|
||||||
@@ -1909,10 +1905,9 @@ func (database *Database) ListChannelBans(
|
|||||||
for rows.Next() {
|
for rows.Next() {
|
||||||
var ban BanInfo
|
var ban BanInfo
|
||||||
|
|
||||||
scanErr := rows.Scan(
|
if scanErr := rows.Scan(
|
||||||
&ban.Mask, &ban.SetBy, &ban.CreatedAt,
|
&ban.Mask, &ban.SetBy, &ban.CreatedAt,
|
||||||
)
|
); scanErr != nil {
|
||||||
if scanErr != nil {
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"scan channel ban: %w", scanErr,
|
"scan channel ban: %w", scanErr,
|
||||||
)
|
)
|
||||||
@@ -1921,8 +1916,7 @@ func (database *Database) ListChannelBans(
|
|||||||
bans = append(bans, ban)
|
bans = append(bans, ban)
|
||||||
}
|
}
|
||||||
|
|
||||||
rowErr := rows.Err()
|
if rowErr := rows.Err(); rowErr != nil {
|
||||||
if rowErr != nil {
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"iterate channel bans: %w", rowErr,
|
"iterate channel bans: %w", rowErr,
|
||||||
)
|
)
|
||||||
@@ -2253,12 +2247,11 @@ func (database *Database) ListAllChannelsWithCountsFiltered(
|
|||||||
for rows.Next() {
|
for rows.Next() {
|
||||||
var chanInfo ChannelInfoFull
|
var chanInfo ChannelInfoFull
|
||||||
|
|
||||||
scanErr := rows.Scan(
|
if scanErr := rows.Scan(
|
||||||
&chanInfo.Name,
|
&chanInfo.Name,
|
||||||
&chanInfo.MemberCount,
|
&chanInfo.MemberCount,
|
||||||
&chanInfo.Topic,
|
&chanInfo.Topic,
|
||||||
)
|
); scanErr != nil {
|
||||||
if scanErr != nil {
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"scan channel: %w", scanErr,
|
"scan channel: %w", scanErr,
|
||||||
)
|
)
|
||||||
@@ -2267,8 +2260,7 @@ func (database *Database) ListAllChannelsWithCountsFiltered(
|
|||||||
channels = append(channels, chanInfo)
|
channels = append(channels, chanInfo)
|
||||||
}
|
}
|
||||||
|
|
||||||
rowErr := rows.Err()
|
if rowErr := rows.Err(); rowErr != nil {
|
||||||
if rowErr != nil {
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"iterate channels: %w", rowErr,
|
"iterate channels: %w", rowErr,
|
||||||
)
|
)
|
||||||
@@ -2316,12 +2308,11 @@ func (database *Database) GetSessionChannelsFiltered(
|
|||||||
for rows.Next() {
|
for rows.Next() {
|
||||||
var chanInfo ChannelInfo
|
var chanInfo ChannelInfo
|
||||||
|
|
||||||
scanErr := rows.Scan(
|
if scanErr := rows.Scan(
|
||||||
&chanInfo.ID,
|
&chanInfo.ID,
|
||||||
&chanInfo.Name,
|
&chanInfo.Name,
|
||||||
&chanInfo.Topic,
|
&chanInfo.Topic,
|
||||||
)
|
); scanErr != nil {
|
||||||
if scanErr != nil {
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"scan channel: %w", scanErr,
|
"scan channel: %w", scanErr,
|
||||||
)
|
)
|
||||||
@@ -2330,8 +2321,7 @@ func (database *Database) GetSessionChannelsFiltered(
|
|||||||
channels = append(channels, chanInfo)
|
channels = append(channels, chanInfo)
|
||||||
}
|
}
|
||||||
|
|
||||||
rowErr := rows.Err()
|
if rowErr := rows.Err(); rowErr != nil {
|
||||||
if rowErr != nil {
|
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
"iterate channels: %w", rowErr,
|
"iterate channels: %w", rowErr,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -987,12 +987,11 @@ func TestGetOperCount(t *testing.T) {
|
|||||||
sid2, _, _, err := database.CreateSession(
|
sid2, _, _, err := database.CreateSession(
|
||||||
ctx, "user2", "", "", "",
|
ctx, "user2", "", "", "",
|
||||||
)
|
)
|
||||||
|
_ = sid2
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
_ = sid2
|
|
||||||
|
|
||||||
// Initially zero opers.
|
// Initially zero opers.
|
||||||
count, err := database.GetOperCount(ctx)
|
count, err := database.GetOperCount(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -1024,25 +1023,23 @@ func TestGetOperCount(t *testing.T) {
|
|||||||
func TestWildcardMatch(t *testing.T) {
|
func TestWildcardMatch(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const hostmask = "nick!user@host"
|
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
pattern string
|
pattern string
|
||||||
input string
|
input string
|
||||||
match bool
|
match bool
|
||||||
}{
|
}{
|
||||||
{"*!*@*", hostmask, true},
|
{"*!*@*", "nick!user@host", true},
|
||||||
{"*!*@*.example.com", "nick!user@foo.example.com", true},
|
{"*!*@*.example.com", "nick!user@foo.example.com", true},
|
||||||
{"*!*@*.example.com", "nick!user@other.net", false},
|
{"*!*@*.example.com", "nick!user@other.net", false},
|
||||||
{"badnick!*@*", "badnick!user@host", true},
|
{"badnick!*@*", "badnick!user@host", true},
|
||||||
{"badnick!*@*", "goodnick!user@host", false},
|
{"badnick!*@*", "goodnick!user@host", false},
|
||||||
{hostmask, hostmask, true},
|
{"nick!user@host", "nick!user@host", true},
|
||||||
{hostmask, "nick!user@other", false},
|
{"nick!user@host", "nick!user@other", false},
|
||||||
{"*", "anything", true},
|
{"*", "anything", true},
|
||||||
{"?ick!*@*", hostmask, true},
|
{"?ick!*@*", "nick!user@host", true},
|
||||||
{"?ick!*@*", "nn!user@host", false},
|
{"?ick!*@*", "nn!user@host", false},
|
||||||
// Case-insensitive.
|
// Case-insensitive.
|
||||||
{"Nick!*@*", hostmask, true},
|
{"Nick!*@*", "nick!user@host", true},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range tests {
|
for _, tc := range tests {
|
||||||
|
|||||||
+60
-52
@@ -125,18 +125,21 @@ func (hdlr *Handlers) authSession(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// setAuthCookie sets the authentication cookie on the
|
// setAuthCookie sets the authentication cookie on the
|
||||||
// response. It is always Secure: the server runs behind a
|
// response.
|
||||||
// TLS-terminating reverse proxy.
|
|
||||||
func (hdlr *Handlers) setAuthCookie(
|
func (hdlr *Handlers) setAuthCookie(
|
||||||
writer http.ResponseWriter,
|
writer http.ResponseWriter,
|
||||||
|
request *http.Request,
|
||||||
token string,
|
token string,
|
||||||
) {
|
) {
|
||||||
|
secure := request.TLS != nil ||
|
||||||
|
request.Header.Get("X-Forwarded-Proto") == "https"
|
||||||
|
|
||||||
http.SetCookie(writer, &http.Cookie{ //nolint:exhaustruct // optional fields
|
http.SetCookie(writer, &http.Cookie{ //nolint:exhaustruct // optional fields
|
||||||
Name: authCookieName,
|
Name: authCookieName,
|
||||||
Value: token,
|
Value: token,
|
||||||
Path: "/",
|
Path: "/",
|
||||||
HttpOnly: true,
|
HttpOnly: true,
|
||||||
Secure: true,
|
Secure: secure,
|
||||||
SameSite: http.SameSiteStrictMode,
|
SameSite: http.SameSiteStrictMode,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -145,13 +148,17 @@ func (hdlr *Handlers) setAuthCookie(
|
|||||||
// the client.
|
// the client.
|
||||||
func (hdlr *Handlers) clearAuthCookie(
|
func (hdlr *Handlers) clearAuthCookie(
|
||||||
writer http.ResponseWriter,
|
writer http.ResponseWriter,
|
||||||
|
request *http.Request,
|
||||||
) {
|
) {
|
||||||
|
secure := request.TLS != nil ||
|
||||||
|
request.Header.Get("X-Forwarded-Proto") == "https"
|
||||||
|
|
||||||
http.SetCookie(writer, &http.Cookie{ //nolint:exhaustruct // optional fields
|
http.SetCookie(writer, &http.Cookie{ //nolint:exhaustruct // optional fields
|
||||||
Name: authCookieName,
|
Name: authCookieName,
|
||||||
Value: "",
|
Value: "",
|
||||||
Path: "/",
|
Path: "/",
|
||||||
HttpOnly: true,
|
HttpOnly: true,
|
||||||
Secure: true,
|
Secure: secure,
|
||||||
SameSite: http.SameSiteStrictMode,
|
SameSite: http.SameSiteStrictMode,
|
||||||
MaxAge: -1,
|
MaxAge: -1,
|
||||||
})
|
})
|
||||||
@@ -165,7 +172,7 @@ func (hdlr *Handlers) requireAuth(
|
|||||||
hdlr.authSession(request)
|
hdlr.authSession(request)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
hdlr.respondJSON(writer, request, map[string]any{
|
hdlr.respondJSON(writer, request, map[string]any{
|
||||||
errorKey: "not registered",
|
"error": "not registered",
|
||||||
"numeric": irc.ErrNotRegistered,
|
"numeric": irc.ErrNotRegistered,
|
||||||
}, http.StatusUnauthorized)
|
}, http.StatusUnauthorized)
|
||||||
|
|
||||||
@@ -278,11 +285,11 @@ func (hdlr *Handlers) executeCreateSession(
|
|||||||
|
|
||||||
hdlr.deliverMOTD(request, clientID, sessionID, nick)
|
hdlr.deliverMOTD(request, clientID, sessionID, nick)
|
||||||
|
|
||||||
hdlr.setAuthCookie(writer, token)
|
hdlr.setAuthCookie(writer, request, token)
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request, map[string]any{
|
hdlr.respondJSON(writer, request, map[string]any{
|
||||||
"id": sessionID,
|
"id": sessionID,
|
||||||
nickKey: nick,
|
"nick": nick,
|
||||||
}, http.StatusCreated)
|
}, http.StatusCreated)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -636,7 +643,7 @@ func (hdlr *Handlers) HandleState() http.HandlerFunc {
|
|||||||
|
|
||||||
hdlr.respondJSON(writer, request, map[string]any{
|
hdlr.respondJSON(writer, request, map[string]any{
|
||||||
"id": sessionID,
|
"id": sessionID,
|
||||||
nickKey: nick,
|
"nick": nick,
|
||||||
"channels": channels,
|
"channels": channels,
|
||||||
}, http.StatusOK)
|
}, http.StatusOK)
|
||||||
}
|
}
|
||||||
@@ -1083,7 +1090,7 @@ func (hdlr *Handlers) dispatchQueryCommand(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: statusError},
|
map[string]string{"status": "error"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1105,7 +1112,7 @@ func (hdlr *Handlers) handlePrivmsg(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: statusError},
|
map[string]string{"status": "error"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -1120,7 +1127,7 @@ func (hdlr *Handlers) handlePrivmsg(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: statusError},
|
map[string]string{"status": "error"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -1162,7 +1169,7 @@ func (hdlr *Handlers) respondIRCError(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: statusError},
|
map[string]string{"status": "error"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1250,7 +1257,7 @@ func (hdlr *Handlers) handleChannelMsg(
|
|||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{"id": uuid, statusKey: "sent"},
|
map[string]string{"id": uuid, "status": "sent"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1440,7 +1447,7 @@ func (hdlr *Handlers) handleDirectMsg(
|
|||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{
|
map[string]string{
|
||||||
"id": result.UUID, statusKey: "sent",
|
"id": result.UUID, "status": "sent",
|
||||||
},
|
},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
@@ -1515,7 +1522,7 @@ func (hdlr *Handlers) executeJoin(
|
|||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{
|
map[string]string{
|
||||||
statusKey: "joined",
|
"status": "joined",
|
||||||
"channel": channel,
|
"channel": channel,
|
||||||
},
|
},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
@@ -1672,7 +1679,6 @@ func (hdlr *Handlers) handlePart(
|
|||||||
|
|
||||||
// Extract reason from body for the service call.
|
// Extract reason from body for the service call.
|
||||||
reason := ""
|
reason := ""
|
||||||
|
|
||||||
if body != nil {
|
if body != nil {
|
||||||
var lines []string
|
var lines []string
|
||||||
if json.Unmarshal(body, &lines) == nil &&
|
if json.Unmarshal(body, &lines) == nil &&
|
||||||
@@ -1694,7 +1700,7 @@ func (hdlr *Handlers) handlePart(
|
|||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{
|
map[string]string{
|
||||||
statusKey: "parted",
|
"status": "parted",
|
||||||
"channel": channel,
|
"channel": channel,
|
||||||
},
|
},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
@@ -1733,7 +1739,7 @@ func (hdlr *Handlers) handleNick(
|
|||||||
if newNick == nick {
|
if newNick == nick {
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{
|
map[string]string{
|
||||||
statusKey: "ok", nickKey: newNick,
|
"status": "ok", "nick": newNick,
|
||||||
},
|
},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
|
|
||||||
@@ -1764,7 +1770,7 @@ func (hdlr *Handlers) executeNickChange(
|
|||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{
|
map[string]string{
|
||||||
statusKey: "ok", nickKey: newNick,
|
"status": "ok", "nick": newNick,
|
||||||
},
|
},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
@@ -1825,7 +1831,7 @@ func (hdlr *Handlers) handleTopic(
|
|||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{
|
map[string]string{
|
||||||
statusKey: "ok", "topic": topic,
|
"status": "ok", "topic": topic,
|
||||||
},
|
},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
@@ -1879,7 +1885,7 @@ func (hdlr *Handlers) dispatchInfoCommand(
|
|||||||
_ = target
|
_ = target
|
||||||
_ = bodyLines
|
_ = bodyLines
|
||||||
|
|
||||||
okResp := map[string]string{statusKey: "ok"}
|
okResp := map[string]string{"status": "ok"}
|
||||||
|
|
||||||
switch command {
|
switch command {
|
||||||
case irc.CmdMotd:
|
case irc.CmdMotd:
|
||||||
@@ -1910,7 +1916,6 @@ func (hdlr *Handlers) handleQuit(
|
|||||||
body json.RawMessage,
|
body json.RawMessage,
|
||||||
) {
|
) {
|
||||||
reason := "Client quit"
|
reason := "Client quit"
|
||||||
|
|
||||||
if body != nil {
|
if body != nil {
|
||||||
var lines []string
|
var lines []string
|
||||||
if json.Unmarshal(body, &lines) == nil &&
|
if json.Unmarshal(body, &lines) == nil &&
|
||||||
@@ -1923,10 +1928,10 @@ func (hdlr *Handlers) handleQuit(
|
|||||||
request.Context(), sessionID, nick, reason,
|
request.Context(), sessionID, nick, reason,
|
||||||
)
|
)
|
||||||
|
|
||||||
hdlr.clearAuthCookie(writer)
|
hdlr.clearAuthCookie(writer, request)
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "quit"},
|
map[string]string{"status": "quit"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1958,7 +1963,7 @@ func (hdlr *Handlers) handleMode(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -2059,7 +2064,7 @@ func (hdlr *Handlers) queryChannelMode(
|
|||||||
|
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2236,7 +2241,7 @@ func (hdlr *Handlers) applyParameterizedMode(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: statusError},
|
map[string]string{"status": "error"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2302,7 +2307,7 @@ func (hdlr *Handlers) applyUserMode(
|
|||||||
)
|
)
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2348,7 +2353,7 @@ func (hdlr *Handlers) setChannelFlag(
|
|||||||
)
|
)
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2432,7 +2437,7 @@ func (hdlr *Handlers) setHashcashMode(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2481,7 +2486,7 @@ func (hdlr *Handlers) clearHashcashMode(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2586,7 +2591,7 @@ func (hdlr *Handlers) executeBanChange(
|
|||||||
}
|
}
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2640,7 +2645,7 @@ func (hdlr *Handlers) listBans(
|
|||||||
|
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2704,7 +2709,7 @@ func (hdlr *Handlers) setChannelKeyMode(
|
|||||||
}
|
}
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2753,7 +2758,7 @@ func (hdlr *Handlers) clearChannelKeyMode(
|
|||||||
}
|
}
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2828,7 +2833,7 @@ func (hdlr *Handlers) setChannelLimitMode(
|
|||||||
}
|
}
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2878,7 +2883,7 @@ func (hdlr *Handlers) clearChannelLimitMode(
|
|||||||
}
|
}
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3045,7 +3050,7 @@ func (hdlr *Handlers) executeInvite(
|
|||||||
}
|
}
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3114,7 +3119,7 @@ func (hdlr *Handlers) handleNames(
|
|||||||
|
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3167,7 +3172,7 @@ func (hdlr *Handlers) handleList(
|
|||||||
|
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3257,7 +3262,7 @@ func (hdlr *Handlers) executeWhois(
|
|||||||
|
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3282,7 +3287,7 @@ func (hdlr *Handlers) whoisNotFound(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3449,7 +3454,7 @@ func (hdlr *Handlers) handleWho(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -3491,7 +3496,7 @@ func (hdlr *Handlers) handleWho(
|
|||||||
|
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3507,7 +3512,7 @@ func (hdlr *Handlers) handleLusers(
|
|||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3698,10 +3703,10 @@ func (hdlr *Handlers) HandleLogout() http.HandlerFunc {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
hdlr.clearAuthCookie(writer)
|
hdlr.clearAuthCookie(writer, request)
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -3804,7 +3809,7 @@ func (hdlr *Handlers) handleOper(
|
|||||||
|
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3852,7 +3857,7 @@ func (hdlr *Handlers) handleAway(
|
|||||||
|
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3914,7 +3919,7 @@ func (hdlr *Handlers) handleKick(
|
|||||||
}
|
}
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3938,7 +3943,10 @@ func (hdlr *Handlers) deliverWhoisIdle(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
idleSeconds := max(int64(time.Since(lastSeen).Seconds()), 0)
|
idleSeconds := int64(time.Since(lastSeen).Seconds())
|
||||||
|
if idleSeconds < 0 {
|
||||||
|
idleSeconds = 0
|
||||||
|
}
|
||||||
|
|
||||||
signonUnix := strconv.FormatInt(
|
signonUnix := strconv.FormatInt(
|
||||||
createdAt.Unix(), 10,
|
createdAt.Unix(), 10,
|
||||||
|
|||||||
+228
-321
File diff suppressed because it is too large
Load Diff
@@ -117,11 +117,11 @@ func (hdlr *Handlers) executeLogin(
|
|||||||
request, clientID, sessionID, nick,
|
request, clientID, sessionID, nick,
|
||||||
)
|
)
|
||||||
|
|
||||||
hdlr.setAuthCookie(writer, token)
|
hdlr.setAuthCookie(writer, request, token)
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request, map[string]any{
|
hdlr.respondJSON(writer, request, map[string]any{
|
||||||
"id": sessionID,
|
"id": sessionID,
|
||||||
nickKey: nick,
|
"nick": nick,
|
||||||
}, http.StatusOK)
|
}, http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -177,6 +177,6 @@ func (hdlr *Handlers) handlePass(
|
|||||||
}
|
}
|
||||||
|
|
||||||
hdlr.respondJSON(writer, request,
|
hdlr.respondJSON(writer, request,
|
||||||
map[string]string{statusKey: "ok"},
|
map[string]string{"status": "ok"},
|
||||||
http.StatusOK)
|
http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,14 +24,6 @@ import (
|
|||||||
|
|
||||||
var errUnauthorized = errors.New("unauthorized")
|
var errUnauthorized = errors.New("unauthorized")
|
||||||
|
|
||||||
// Field names and values used in many JSON responses.
|
|
||||||
const (
|
|
||||||
statusKey = "status"
|
|
||||||
statusError = "error"
|
|
||||||
errorKey = "error"
|
|
||||||
nickKey = "nick"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Params defines the dependencies for creating Handlers.
|
// Params defines the dependencies for creating Handlers.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -145,7 +137,7 @@ func (hdlr *Handlers) respondError(
|
|||||||
) {
|
) {
|
||||||
hdlr.respondJSON(
|
hdlr.respondJSON(
|
||||||
writer, request,
|
writer, request,
|
||||||
map[string]string{errorKey: msg},
|
map[string]string{"error": msg},
|
||||||
status,
|
status,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -100,10 +100,9 @@ func (v *Validator) Validate(
|
|||||||
dateStr := parts[2]
|
dateStr := parts[2]
|
||||||
resource := parts[3]
|
resource := parts[3]
|
||||||
|
|
||||||
err := v.validateHeader(
|
if err := v.validateHeader(
|
||||||
version, bitsStr, resource, requiredBits,
|
version, bitsStr, resource, requiredBits,
|
||||||
)
|
); err != nil {
|
||||||
if err != nil {
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -112,13 +111,13 @@ func (v *Validator) Validate(
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
err = validateTime(stampTime)
|
if err := validateTime(stampTime); err != nil {
|
||||||
if err != nil {
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
err = validateProof(stamp, requiredBits)
|
if err := validateProof(
|
||||||
if err != nil {
|
stamp, requiredBits,
|
||||||
|
); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -159,7 +159,9 @@ func (c *Conn) handleJoin(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
for chanName := range strings.SplitSeq(msg.Params[0], ",") {
|
channels := strings.Split(msg.Params[0], ",")
|
||||||
|
|
||||||
|
for _, chanName := range channels {
|
||||||
chanName = strings.TrimSpace(chanName)
|
chanName = strings.TrimSpace(chanName)
|
||||||
|
|
||||||
if !strings.HasPrefix(chanName, "#") {
|
if !strings.HasPrefix(chanName, "#") {
|
||||||
@@ -303,7 +305,9 @@ func (c *Conn) handlePart(
|
|||||||
reason = msg.Params[1]
|
reason = msg.Params[1]
|
||||||
}
|
}
|
||||||
|
|
||||||
for ch := range strings.SplitSeq(msg.Params[0], ",") {
|
channels := strings.Split(msg.Params[0], ",")
|
||||||
|
|
||||||
|
for _, ch := range channels {
|
||||||
ch = strings.TrimSpace(ch)
|
ch = strings.TrimSpace(ch)
|
||||||
c.partChannel(ctx, ch, reason)
|
c.partChannel(ctx, ch, reason)
|
||||||
}
|
}
|
||||||
@@ -615,8 +619,8 @@ func (c *Conn) applyChannelModes(
|
|||||||
) {
|
) {
|
||||||
adding := true
|
adding := true
|
||||||
argIdx := 0
|
argIdx := 0
|
||||||
|
applied := ""
|
||||||
var applied, appliedArgs strings.Builder
|
appliedArgs := ""
|
||||||
|
|
||||||
for _, modeChar := range modeStr {
|
for _, modeChar := range modeStr {
|
||||||
var res modeResult
|
var res modeResult
|
||||||
@@ -668,13 +672,16 @@ func (c *Conn) applyChannelModes(
|
|||||||
argIdx += res.consumed
|
argIdx += res.consumed
|
||||||
|
|
||||||
if !res.skip {
|
if !res.skip {
|
||||||
applied.WriteString(res.applied)
|
applied += res.applied
|
||||||
appliedArgs.WriteString(res.appliedArgs)
|
appliedArgs += res.appliedArgs
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if applied.Len() > 0 {
|
if applied != "" {
|
||||||
modeReply := applied.String() + appliedArgs.String()
|
modeReply := applied
|
||||||
|
if appliedArgs != "" {
|
||||||
|
modeReply += appliedArgs
|
||||||
|
}
|
||||||
|
|
||||||
c.send(FormatMessage(
|
c.send(FormatMessage(
|
||||||
c.hostmask(), "MODE", channel, modeReply,
|
c.hostmask(), "MODE", channel, modeReply,
|
||||||
|
|||||||
@@ -62,6 +62,7 @@ type Conn struct {
|
|||||||
|
|
||||||
lastQueueID int64
|
lastQueueID int64
|
||||||
closed bool
|
closed bool
|
||||||
|
cancel context.CancelFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
func newConn(
|
func newConn(
|
||||||
@@ -150,10 +151,8 @@ func resolveHost(ctx context.Context, addr string) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// serve is the main loop for a single IRC client connection.
|
// serve is the main loop for a single IRC client connection.
|
||||||
// Cancelling ctx when it returns stops the relay goroutine.
|
|
||||||
func (c *Conn) serve(ctx context.Context) {
|
func (c *Conn) serve(ctx context.Context) {
|
||||||
ctx, cancel := context.WithCancel(ctx)
|
ctx, c.cancel = context.WithCancel(ctx)
|
||||||
defer cancel()
|
|
||||||
defer c.cleanup(ctx)
|
defer c.cleanup(ctx)
|
||||||
|
|
||||||
scanner := bufio.NewScanner(c.conn)
|
scanner := bufio.NewScanner(c.conn)
|
||||||
@@ -482,7 +481,7 @@ func (c *Conn) deliverMOTD() {
|
|||||||
"- %s Message of the Day -", c.serverSfx,
|
"- %s Message of the Day -", c.serverSfx,
|
||||||
))
|
))
|
||||||
|
|
||||||
for line := range strings.SplitSeq(motd, "\n") {
|
for _, line := range strings.Split(motd, "\n") {
|
||||||
c.sendNumeric(irc.RplMotd, "- "+line)
|
c.sendNumeric(irc.RplMotd, "- "+line)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -282,7 +282,6 @@ func TestIntegrationTwoClients(t *testing.T) {
|
|||||||
|
|
||||||
// Both nicks should appear in the name list.
|
// Both nicks should appear in the name list.
|
||||||
foundBothNames := false
|
foundBothNames := false
|
||||||
|
|
||||||
for _, line := range aliceNames {
|
for _, line := range aliceNames {
|
||||||
if strings.Contains(line, " 353 ") &&
|
if strings.Contains(line, " 353 ") &&
|
||||||
strings.Contains(line, "alice") &&
|
strings.Contains(line, "alice") &&
|
||||||
@@ -672,7 +671,6 @@ func TestIntegrationTwoClients(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
foundPartErr := false
|
foundPartErr := false
|
||||||
|
|
||||||
for _, line := range bobPartFail {
|
for _, line := range bobPartFail {
|
||||||
if strings.Contains(line, " 403 ") ||
|
if strings.Contains(line, " 403 ") ||
|
||||||
strings.Contains(line, " 442 ") {
|
strings.Contains(line, " 442 ") {
|
||||||
@@ -835,7 +833,6 @@ func TestIntegrationModeModerated(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
foundModErr := false
|
foundModErr := false
|
||||||
|
|
||||||
for _, line := range bobLines {
|
for _, line := range bobLines {
|
||||||
if strings.Contains(line, " 404 ") ||
|
if strings.Contains(line, " 404 ") ||
|
||||||
strings.Contains(line, " 482 ") {
|
strings.Contains(line, " 482 ") {
|
||||||
@@ -862,7 +859,6 @@ func TestIntegrationModeModerated(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
bob.send("PRIVMSG #modtest :voiced message")
|
bob.send("PRIVMSG #modtest :voiced message")
|
||||||
|
|
||||||
aliceLines := alice.readUntil(func(l string) bool {
|
aliceLines := alice.readUntil(func(l string) bool {
|
||||||
return strings.Contains(l, "voiced message")
|
return strings.Contains(l, "voiced message")
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -4,18 +4,12 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"sneak.berlin/go/neoirc/internal/ircserver"
|
"sneak.berlin/go/neoirc/internal/ircserver"
|
||||||
"sneak.berlin/go/neoirc/pkg/irc"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
//nolint:funlen // table-driven test
|
//nolint:funlen // table-driven test
|
||||||
func TestParseMessage(t *testing.T) {
|
func TestParseMessage(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const (
|
|
||||||
nick = "alice"
|
|
||||||
channel = "#general"
|
|
||||||
)
|
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
input string
|
input string
|
||||||
@@ -30,10 +24,10 @@ func TestParseMessage(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "simple command",
|
name: "simple command",
|
||||||
input: irc.CmdPing,
|
input: "PING",
|
||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: irc.CmdPing,
|
Command: "PING",
|
||||||
Params: nil,
|
Params: nil,
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
@@ -44,7 +38,7 @@ func TestParseMessage(t *testing.T) {
|
|||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: "NICK",
|
Command: "NICK",
|
||||||
Params: []string{nick},
|
Params: []string{"alice"},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
},
|
},
|
||||||
@@ -63,8 +57,8 @@ func TestParseMessage(t *testing.T) {
|
|||||||
input: "PRIVMSG #general :hello world",
|
input: "PRIVMSG #general :hello world",
|
||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: irc.CmdPrivmsg,
|
Command: "PRIVMSG",
|
||||||
Params: []string{channel, "hello world"},
|
Params: []string{"#general", "hello world"},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
},
|
},
|
||||||
@@ -74,7 +68,7 @@ func TestParseMessage(t *testing.T) {
|
|||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "server.example.com",
|
Prefix: "server.example.com",
|
||||||
Command: "001",
|
Command: "001",
|
||||||
Params: []string{nick, "Welcome to IRC"},
|
Params: []string{"alice", "Welcome to IRC"},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
},
|
},
|
||||||
@@ -85,7 +79,7 @@ func TestParseMessage(t *testing.T) {
|
|||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: "USER",
|
Command: "USER",
|
||||||
Params: []string{
|
Params: []string{
|
||||||
nick, "0", "*", "Alice Smith",
|
"alice", "0", "*", "Alice Smith",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
@@ -96,7 +90,7 @@ func TestParseMessage(t *testing.T) {
|
|||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: "JOIN",
|
Command: "JOIN",
|
||||||
Params: []string{channel},
|
Params: []string{"#general"},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
},
|
},
|
||||||
@@ -105,17 +99,17 @@ func TestParseMessage(t *testing.T) {
|
|||||||
input: "QUIT :leaving now",
|
input: "QUIT :leaving now",
|
||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: irc.CmdQuit,
|
Command: "QUIT",
|
||||||
Params: []string{"leaving now"},
|
Params: []string{"leaving now"},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "quit without reason",
|
name: "quit without reason",
|
||||||
input: irc.CmdQuit,
|
input: "QUIT",
|
||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: irc.CmdQuit,
|
Command: "QUIT",
|
||||||
Params: nil,
|
Params: nil,
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
@@ -126,7 +120,7 @@ func TestParseMessage(t *testing.T) {
|
|||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: "MODE",
|
Command: "MODE",
|
||||||
Params: []string{channel},
|
Params: []string{"#general"},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
},
|
},
|
||||||
@@ -137,7 +131,7 @@ func TestParseMessage(t *testing.T) {
|
|||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: "KICK",
|
Command: "KICK",
|
||||||
Params: []string{
|
Params: []string{
|
||||||
channel, "bob", "misbehaving",
|
"#general", "bob", "misbehaving",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
@@ -147,8 +141,8 @@ func TestParseMessage(t *testing.T) {
|
|||||||
input: "PRIVMSG #general :",
|
input: "PRIVMSG #general :",
|
||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: irc.CmdPrivmsg,
|
Command: "PRIVMSG",
|
||||||
Params: []string{channel, ""},
|
Params: []string{"#general", ""},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
},
|
},
|
||||||
@@ -167,7 +161,7 @@ func TestParseMessage(t *testing.T) {
|
|||||||
input: "PING :irc.example.com",
|
input: "PING :irc.example.com",
|
||||||
want: &ircserver.Message{
|
want: &ircserver.Message{
|
||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: irc.CmdPing,
|
Command: "PING",
|
||||||
Params: []string{"irc.example.com"},
|
Params: []string{"irc.example.com"},
|
||||||
},
|
},
|
||||||
wantNil: false,
|
wantNil: false,
|
||||||
@@ -179,7 +173,7 @@ func TestParseMessage(t *testing.T) {
|
|||||||
Prefix: "",
|
Prefix: "",
|
||||||
Command: "TOPIC",
|
Command: "TOPIC",
|
||||||
Params: []string{
|
Params: []string{
|
||||||
channel,
|
"#general",
|
||||||
"Welcome to the channel!",
|
"Welcome to the channel!",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -243,12 +237,6 @@ func TestParseMessage(t *testing.T) {
|
|||||||
func TestFormatMessage(t *testing.T) {
|
func TestFormatMessage(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const (
|
|
||||||
nick = "alice"
|
|
||||||
channel = "#general"
|
|
||||||
serverName = "server"
|
|
||||||
)
|
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
prefix string
|
prefix string
|
||||||
@@ -259,35 +247,35 @@ func TestFormatMessage(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "simple command",
|
name: "simple command",
|
||||||
prefix: "",
|
prefix: "",
|
||||||
command: irc.CmdPing,
|
command: "PING",
|
||||||
params: nil,
|
params: nil,
|
||||||
want: irc.CmdPing,
|
want: "PING",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "with prefix",
|
name: "with prefix",
|
||||||
prefix: serverName,
|
prefix: "server",
|
||||||
command: "PONG",
|
command: "PONG",
|
||||||
params: []string{serverName},
|
params: []string{"server"},
|
||||||
want: ":server PONG server",
|
want: ":server PONG server",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "privmsg with trailing",
|
name: "privmsg with trailing",
|
||||||
prefix: "alice!alice@host",
|
prefix: "alice!alice@host",
|
||||||
command: irc.CmdPrivmsg,
|
command: "PRIVMSG",
|
||||||
params: []string{channel, "hello world"},
|
params: []string{"#general", "hello world"},
|
||||||
want: ":alice!alice@host PRIVMSG #general :hello world",
|
want: ":alice!alice@host PRIVMSG #general :hello world",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "numeric reply",
|
name: "numeric reply",
|
||||||
prefix: serverName,
|
prefix: "server",
|
||||||
command: "001",
|
command: "001",
|
||||||
params: []string{nick, "Welcome to IRC"},
|
params: []string{"alice", "Welcome to IRC"},
|
||||||
want: ":server 001 alice :Welcome to IRC",
|
want: ":server 001 alice :Welcome to IRC",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "empty trailing",
|
name: "empty trailing",
|
||||||
prefix: serverName,
|
prefix: "server",
|
||||||
command: irc.CmdPrivmsg,
|
command: "PRIVMSG",
|
||||||
params: []string{"#chan", ""},
|
params: []string{"#chan", ""},
|
||||||
want: ":server PRIVMSG #chan :",
|
want: ":server PRIVMSG #chan :",
|
||||||
},
|
},
|
||||||
@@ -314,7 +302,7 @@ func TestParseFormatRoundTrip(t *testing.T) {
|
|||||||
// parameter either contains a space (gets ':' prefix
|
// parameter either contains a space (gets ':' prefix
|
||||||
// on format) or is a non-trailing single token.
|
// on format) or is a non-trailing single token.
|
||||||
lines := []string{
|
lines := []string{
|
||||||
irc.CmdPing,
|
"PING",
|
||||||
"NICK alice",
|
"NICK alice",
|
||||||
"PRIVMSG #general :hello world",
|
"PRIVMSG #general :hello world",
|
||||||
"JOIN #general",
|
"JOIN #general",
|
||||||
|
|||||||
@@ -81,24 +81,22 @@ func New(
|
|||||||
// start begins listening for TCP connections.
|
// start begins listening for TCP connections.
|
||||||
//
|
//
|
||||||
//nolint:contextcheck // long-lived server ctx, not the short Fx one
|
//nolint:contextcheck // long-lived server ctx, not the short Fx one
|
||||||
func (s *Server) start(ctx context.Context, addr string) error {
|
func (s *Server) start(_ context.Context, addr string) error {
|
||||||
var listenConfig net.ListenConfig
|
ln, err := net.Listen("tcp", addr)
|
||||||
|
|
||||||
ln, err := listenConfig.Listen(ctx, "tcp", addr)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("irc listen: %w", err)
|
return fmt.Errorf("irc listen: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
s.listener = ln
|
s.listener = ln
|
||||||
|
|
||||||
serverCtx, cancel := context.WithCancel(context.Background())
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
s.cancel = cancel
|
s.cancel = cancel
|
||||||
|
|
||||||
s.log.Info(
|
s.log.Info(
|
||||||
"irc server listening", "addr", addr,
|
"irc server listening", "addr", addr,
|
||||||
)
|
)
|
||||||
|
|
||||||
go s.acceptLoop(serverCtx)
|
go s.acceptLoop(ctx)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"net"
|
"net"
|
||||||
"os"
|
"os"
|
||||||
"runtime"
|
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
@@ -72,9 +71,7 @@ func newTestEnv(t *testing.T) *testEnv {
|
|||||||
MOTD: "Welcome to test IRC",
|
MOTD: "Welcome to test IRC",
|
||||||
}
|
}
|
||||||
|
|
||||||
var listenConfig net.ListenConfig
|
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
||||||
|
|
||||||
listener, err := listenConfig.Listen(t.Context(), "tcp", "127.0.0.1:0")
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("listen: %v", err)
|
t.Fatalf("listen: %v", err)
|
||||||
}
|
}
|
||||||
@@ -119,12 +116,10 @@ func newTestEnv(t *testing.T) *testEnv {
|
|||||||
func (env *testEnv) dial(t *testing.T) *testClient {
|
func (env *testEnv) dial(t *testing.T) *testClient {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
dialer := net.Dialer{Timeout: testTimeout}
|
conn, err := net.DialTimeout(
|
||||||
|
|
||||||
conn, err := dialer.DialContext(
|
|
||||||
t.Context(),
|
|
||||||
"tcp",
|
"tcp",
|
||||||
env.srv.Listener().Addr().String(),
|
env.srv.Listener().Addr().String(),
|
||||||
|
testTimeout,
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("dial: %v", err)
|
t.Fatalf("dial: %v", err)
|
||||||
@@ -328,7 +323,6 @@ func TestPrivmsgBetweenClients(t *testing.T) {
|
|||||||
bob.joinAndDrain("#chat")
|
bob.joinAndDrain("#chat")
|
||||||
|
|
||||||
alice.send("PRIVMSG #chat :hello bob!")
|
alice.send("PRIVMSG #chat :hello bob!")
|
||||||
|
|
||||||
lines := bob.sendAndExpect("PING :sync", "hello bob!")
|
lines := bob.sendAndExpect("PING :sync", "hello bob!")
|
||||||
assertContains(t, lines, "hello bob!", "channel PRIVMSG")
|
assertContains(t, lines, "hello bob!", "channel PRIVMSG")
|
||||||
}
|
}
|
||||||
@@ -609,56 +603,6 @@ func TestNamesNonExistentChannel(t *testing.T) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestRelayStopsWhenConnectionCloses checks that closing a
|
|
||||||
// registered client's connection stops the goroutine that
|
|
||||||
// relays its messages.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // counts every goroutine in the process
|
|
||||||
func TestRelayStopsWhenConnectionCloses(t *testing.T) {
|
|
||||||
env := newTestEnv(t)
|
|
||||||
client := env.dial(t)
|
|
||||||
|
|
||||||
client.register("relaystop")
|
|
||||||
waitForRelayGoroutines(t, 1)
|
|
||||||
|
|
||||||
err := client.conn.Close()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("close: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
waitForRelayGoroutines(t, 0)
|
|
||||||
}
|
|
||||||
|
|
||||||
const (
|
|
||||||
stackDumpSize = 1 << 20
|
|
||||||
relayCheckStep = 10 * time.Millisecond
|
|
||||||
)
|
|
||||||
|
|
||||||
// waitForRelayGoroutines waits until exactly want goroutines
|
|
||||||
// are running the relay loop, and fails the test if that does
|
|
||||||
// not happen within testTimeout.
|
|
||||||
func waitForRelayGoroutines(t *testing.T, want int) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
deadline := time.Now().Add(testTimeout)
|
|
||||||
stacks := make([]byte, stackDumpSize)
|
|
||||||
|
|
||||||
for {
|
|
||||||
n := runtime.Stack(stacks, true)
|
|
||||||
got := strings.Count(string(stacks[:n]), "(*Conn).relayMessages(")
|
|
||||||
|
|
||||||
if got == want {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if time.Now().After(deadline) {
|
|
||||||
t.Fatalf("relay goroutines: got %d, want %d", got, want)
|
|
||||||
}
|
|
||||||
|
|
||||||
time.Sleep(relayCheckStep)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkParseMessage(b *testing.B) {
|
func BenchmarkParseMessage(b *testing.B) {
|
||||||
line := ":nick!user@host PRIVMSG #channel :Hello, world!"
|
line := ":nick!user@host PRIVMSG #channel :Hello, world!"
|
||||||
|
|
||||||
|
|||||||
@@ -78,9 +78,7 @@ func New(
|
|||||||
srv.enableSentry()
|
srv.enableSentry()
|
||||||
srv.SetupRoutes()
|
srv.SetupRoutes()
|
||||||
|
|
||||||
// The start hook's context ends when the hook
|
go srv.serve() //nolint:contextcheck
|
||||||
// returns; serving must outlive it.
|
|
||||||
go srv.serve() //nolint:contextcheck,gosec // G118
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
|
|||||||
+28
-29
@@ -19,12 +19,6 @@ import (
|
|||||||
"sneak.berlin/go/neoirc/pkg/irc"
|
"sneak.berlin/go/neoirc/pkg/irc"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Error texts that several commands reply with.
|
|
||||||
const (
|
|
||||||
msgNoSuchChannel = "No such channel"
|
|
||||||
msgNotChannelOp = "You're not channel operator"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Params defines the dependencies for creating a Service.
|
// Params defines the dependencies for creating a Service.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -148,7 +142,7 @@ func (s *Service) SendChannelMessage(
|
|||||||
return 0, "", &IRCError{
|
return 0, "", &IRCError{
|
||||||
irc.ErrNoSuchChannel,
|
irc.ErrNoSuchChannel,
|
||||||
[]string{channel},
|
[]string{channel},
|
||||||
msgNoSuchChannel,
|
"No such channel",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -262,11 +256,10 @@ func (s *Service) JoinChannel(
|
|||||||
isCreator := countErr == nil && memberCount == 0
|
isCreator := countErr == nil && memberCount == 0
|
||||||
|
|
||||||
if !isCreator {
|
if !isCreator {
|
||||||
joinErr := checkJoinRestrictions(
|
if joinErr := checkJoinRestrictions(
|
||||||
ctx, s.db, chID, sessionID,
|
ctx, s.db, chID, sessionID,
|
||||||
channel, suppliedKey, memberCount,
|
channel, suppliedKey, memberCount,
|
||||||
)
|
); joinErr != nil {
|
||||||
if joinErr != nil {
|
|
||||||
return nil, joinErr
|
return nil, joinErr
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -313,7 +306,7 @@ func (s *Service) PartChannel(
|
|||||||
return &IRCError{
|
return &IRCError{
|
||||||
irc.ErrNoSuchChannel,
|
irc.ErrNoSuchChannel,
|
||||||
[]string{channel},
|
[]string{channel},
|
||||||
msgNoSuchChannel,
|
"No such channel",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -355,7 +348,7 @@ func (s *Service) SetTopic(
|
|||||||
return &IRCError{
|
return &IRCError{
|
||||||
irc.ErrNoSuchChannel,
|
irc.ErrNoSuchChannel,
|
||||||
[]string{channel},
|
[]string{channel},
|
||||||
msgNoSuchChannel,
|
"No such channel",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -379,13 +372,14 @@ func (s *Service) SetTopic(
|
|||||||
return &IRCError{
|
return &IRCError{
|
||||||
irc.ErrChanOpPrivsNeeded,
|
irc.ErrChanOpPrivsNeeded,
|
||||||
[]string{channel},
|
[]string{channel},
|
||||||
msgNotChannelOp,
|
"You're not channel operator",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
setErr := s.db.SetTopic(ctx, channel, topic)
|
if setErr := s.db.SetTopic(
|
||||||
if setErr != nil {
|
ctx, channel, topic,
|
||||||
|
); setErr != nil {
|
||||||
return fmt.Errorf("set topic: %w", setErr)
|
return fmt.Errorf("set topic: %w", setErr)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -415,7 +409,7 @@ func (s *Service) KickUser(
|
|||||||
return &IRCError{
|
return &IRCError{
|
||||||
irc.ErrNoSuchChannel,
|
irc.ErrNoSuchChannel,
|
||||||
[]string{channel},
|
[]string{channel},
|
||||||
msgNoSuchChannel,
|
"No such channel",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -426,7 +420,7 @@ func (s *Service) KickUser(
|
|||||||
return &IRCError{
|
return &IRCError{
|
||||||
irc.ErrChanOpPrivsNeeded,
|
irc.ErrChanOpPrivsNeeded,
|
||||||
[]string{channel},
|
[]string{channel},
|
||||||
msgNotChannelOp,
|
"You're not channel operator",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -615,7 +609,7 @@ func (s *Service) ValidateChannelOp(
|
|||||||
return 0, &IRCError{
|
return 0, &IRCError{
|
||||||
irc.ErrNoSuchChannel,
|
irc.ErrNoSuchChannel,
|
||||||
[]string{channel},
|
[]string{channel},
|
||||||
msgNoSuchChannel,
|
"No such channel",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -626,7 +620,7 @@ func (s *Service) ValidateChannelOp(
|
|||||||
return 0, &IRCError{
|
return 0, &IRCError{
|
||||||
irc.ErrChanOpPrivsNeeded,
|
irc.ErrChanOpPrivsNeeded,
|
||||||
[]string{channel},
|
[]string{channel},
|
||||||
msgNotChannelOp,
|
"You're not channel operator",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -688,28 +682,33 @@ func (s *Service) SetChannelFlag(
|
|||||||
) error {
|
) error {
|
||||||
switch flag {
|
switch flag {
|
||||||
case 'm':
|
case 'm':
|
||||||
err := s.db.SetChannelModerated(ctx, chID, setting)
|
if err := s.db.SetChannelModerated(
|
||||||
if err != nil {
|
ctx, chID, setting,
|
||||||
|
); err != nil {
|
||||||
return fmt.Errorf("set moderated: %w", err)
|
return fmt.Errorf("set moderated: %w", err)
|
||||||
}
|
}
|
||||||
case 't':
|
case 't':
|
||||||
err := s.db.SetChannelTopicLocked(ctx, chID, setting)
|
if err := s.db.SetChannelTopicLocked(
|
||||||
if err != nil {
|
ctx, chID, setting,
|
||||||
|
); err != nil {
|
||||||
return fmt.Errorf("set topic locked: %w", err)
|
return fmt.Errorf("set topic locked: %w", err)
|
||||||
}
|
}
|
||||||
case 'i':
|
case 'i':
|
||||||
err := s.db.SetChannelInviteOnly(ctx, chID, setting)
|
if err := s.db.SetChannelInviteOnly(
|
||||||
if err != nil {
|
ctx, chID, setting,
|
||||||
|
); err != nil {
|
||||||
return fmt.Errorf("set invite only: %w", err)
|
return fmt.Errorf("set invite only: %w", err)
|
||||||
}
|
}
|
||||||
case 's':
|
case 's':
|
||||||
err := s.db.SetChannelSecret(ctx, chID, setting)
|
if err := s.db.SetChannelSecret(
|
||||||
if err != nil {
|
ctx, chID, setting,
|
||||||
|
); err != nil {
|
||||||
return fmt.Errorf("set secret: %w", err)
|
return fmt.Errorf("set secret: %w", err)
|
||||||
}
|
}
|
||||||
case 'n':
|
case 'n':
|
||||||
err := s.db.SetChannelNoExternal(ctx, chID, setting)
|
if err := s.db.SetChannelNoExternal(
|
||||||
if err != nil {
|
ctx, chID, setting,
|
||||||
|
); err != nil {
|
||||||
return fmt.Errorf(
|
return fmt.Errorf(
|
||||||
"set no external: %w", err,
|
"set no external: %w", err,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,6 +0,0 @@
|
|||||||
{
|
|
||||||
"private": true,
|
|
||||||
"devDependencies": {
|
|
||||||
"prettier": "3.8.1"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+1
-2
@@ -68,7 +68,6 @@ const (
|
|||||||
// Command responses (200-399).
|
// Command responses (200-399).
|
||||||
const (
|
const (
|
||||||
// RFC 2812 trace/stats/links replies (200-219).
|
// RFC 2812 trace/stats/links replies (200-219).
|
||||||
|
|
||||||
RplTraceLink IRCMessageType = 200
|
RplTraceLink IRCMessageType = 200
|
||||||
RplTraceConnecting IRCMessageType = 201
|
RplTraceConnecting IRCMessageType = 201
|
||||||
RplTraceHandshake IRCMessageType = 202
|
RplTraceHandshake IRCMessageType = 202
|
||||||
@@ -225,7 +224,7 @@ const (
|
|||||||
|
|
||||||
// names maps numeric codes to their standard IRC names.
|
// names maps numeric codes to their standard IRC names.
|
||||||
//
|
//
|
||||||
//nolint:gochecknoglobals,gosec // G101: IRC numeric names, not credentials
|
//nolint:gochecknoglobals
|
||||||
var names = map[IRCMessageType]string{
|
var names = map[IRCMessageType]string{
|
||||||
RplWelcome: "RPL_WELCOME",
|
RplWelcome: "RPL_WELCOME",
|
||||||
RplYourHost: "RPL_YOURHOST",
|
RplYourHost: "RPL_YOURHOST",
|
||||||
|
|||||||
+45
-46
@@ -22,20 +22,19 @@ Structured: {"command": "PUBKEY", "body": {"alg": "ed25519", "key": "base64..."}
|
|||||||
|
|
||||||
Common fields (see `message.json` for full schema):
|
Common fields (see `message.json` for full schema):
|
||||||
|
|
||||||
| Field | Type | Description |
|
| Field | Type | Description |
|
||||||
| --------- | --------------- | ---------------------------------------------------- |
|
|-----------|----------------|------------------------------------------------------|
|
||||||
| `id` | string (uuid) | Server-assigned message UUID |
|
| `id` | string (uuid) | Server-assigned message UUID |
|
||||||
| `command` | string | IRC command or 3-digit numeric code |
|
| `command` | string | IRC command or 3-digit numeric code |
|
||||||
| `from` | string | Source nick or server name (IRC prefix) |
|
| `from` | string | Source nick or server name (IRC prefix) |
|
||||||
| `to` | string | Target: #channel or nick |
|
| `to` | string | Target: #channel or nick |
|
||||||
| `params` | string[] | Middle parameters (mainly for numerics) |
|
| `params` | string[] | Middle parameters (mainly for numerics) |
|
||||||
| `body` | array \| object | Structured body — never a raw string (see below) |
|
| `body` | array \| object | Structured body — never a raw string (see below) |
|
||||||
| `ts` | string | ISO 8601 timestamp (server-assigned, not in raw IRC) |
|
| `ts` | string | ISO 8601 timestamp (server-assigned, not in raw IRC) |
|
||||||
| `meta` | object | Extensible metadata (signatures, hashes, etc.) |
|
| `meta` | object | Extensible metadata (signatures, hashes, etc.) |
|
||||||
|
|
||||||
**Structured bodies:** `body` is always an array of strings (for text) or an
|
**Structured bodies:** `body` is always an array of strings (for text) or an
|
||||||
object (for structured data like PUBKEY). Never a raw string. This enables:
|
object (for structured data like PUBKEY). Never a raw string. This enables:
|
||||||
|
|
||||||
- Multiline messages without escape sequences
|
- Multiline messages without escape sequences
|
||||||
- Deterministic canonicalization via RFC 8785 JCS for signing
|
- Deterministic canonicalization via RFC 8785 JCS for signing
|
||||||
- Structured data where needed
|
- Structured data where needed
|
||||||
@@ -44,20 +43,20 @@ object (for structured data like PUBKEY). Never a raw string. This enables:
|
|||||||
|
|
||||||
IRC commands used for client↔server and server↔server communication.
|
IRC commands used for client↔server and server↔server communication.
|
||||||
|
|
||||||
| Command | File | RFC | Description |
|
| Command | File | RFC | Description |
|
||||||
| --------- | ----------------------- | ----------- | -------------------------- |
|
|-----------|---------------------------|-----------|--------------------------------|
|
||||||
| `PRIVMSG` | `commands/PRIVMSG.json` | 1459 §4.4.1 | Message to channel or user |
|
| `PRIVMSG` | `commands/PRIVMSG.json` | 1459 §4.4.1 | Message to channel or user |
|
||||||
| `NOTICE` | `commands/NOTICE.json` | 1459 §4.4.2 | Notice (no auto-reply) |
|
| `NOTICE` | `commands/NOTICE.json` | 1459 §4.4.2 | Notice (no auto-reply) |
|
||||||
| `JOIN` | `commands/JOIN.json` | 1459 §4.2.1 | Join a channel |
|
| `JOIN` | `commands/JOIN.json` | 1459 §4.2.1 | Join a channel |
|
||||||
| `PART` | `commands/PART.json` | 1459 §4.2.2 | Leave a channel |
|
| `PART` | `commands/PART.json` | 1459 §4.2.2 | Leave a channel |
|
||||||
| `QUIT` | `commands/QUIT.json` | 1459 §4.1.6 | User disconnected |
|
| `QUIT` | `commands/QUIT.json` | 1459 §4.1.6 | User disconnected |
|
||||||
| `NICK` | `commands/NICK.json` | 1459 §4.1.2 | Change nickname |
|
| `NICK` | `commands/NICK.json` | 1459 §4.1.2 | Change nickname |
|
||||||
| `TOPIC` | `commands/TOPIC.json` | 1459 §4.2.4 | Get/set channel topic |
|
| `TOPIC` | `commands/TOPIC.json` | 1459 §4.2.4 | Get/set channel topic |
|
||||||
| `MODE` | `commands/MODE.json` | 1459 §4.2.3 | Set channel/user modes |
|
| `MODE` | `commands/MODE.json` | 1459 §4.2.3 | Set channel/user modes |
|
||||||
| `KICK` | `commands/KICK.json` | 1459 §4.2.8 | Kick user from channel |
|
| `KICK` | `commands/KICK.json` | 1459 §4.2.8 | Kick user from channel |
|
||||||
| `PING` | `commands/PING.json` | 1459 §4.6.2 | Keepalive |
|
| `PING` | `commands/PING.json` | 1459 §4.6.2 | Keepalive |
|
||||||
| `PONG` | `commands/PONG.json` | 1459 §4.6.3 | Keepalive response |
|
| `PONG` | `commands/PONG.json` | 1459 §4.6.3 | Keepalive response |
|
||||||
| `PUBKEY` | `commands/PUBKEY.json` | (extension) | Announce/relay signing key |
|
| `PUBKEY` | `commands/PUBKEY.json` | (extension) | Announce/relay signing key |
|
||||||
|
|
||||||
## Numeric Replies
|
## Numeric Replies
|
||||||
|
|
||||||
@@ -65,30 +64,30 @@ Three-digit codes for server responses, per IRC convention.
|
|||||||
|
|
||||||
### Success / Informational (0xx–3xx)
|
### Success / Informational (0xx–3xx)
|
||||||
|
|
||||||
| Code | Name | File | Description |
|
| Code | Name | File | Description |
|
||||||
| ----- | -------------- | ------------------- | ------------------------------ |
|
|-------|-------------------|-----------------------|--------------------------------|
|
||||||
| `001` | RPL_WELCOME | `numerics/001.json` | Welcome after session creation |
|
| `001` | RPL_WELCOME | `numerics/001.json` | Welcome after session creation |
|
||||||
| `002` | RPL_YOURHOST | `numerics/002.json` | Server host info |
|
| `002` | RPL_YOURHOST | `numerics/002.json` | Server host info |
|
||||||
| `003` | RPL_CREATED | `numerics/003.json` | Server creation date |
|
| `003` | RPL_CREATED | `numerics/003.json` | Server creation date |
|
||||||
| `004` | RPL_MYINFO | `numerics/004.json` | Server info and modes |
|
| `004` | RPL_MYINFO | `numerics/004.json` | Server info and modes |
|
||||||
| `322` | RPL_LIST | `numerics/322.json` | Channel list entry |
|
| `322` | RPL_LIST | `numerics/322.json` | Channel list entry |
|
||||||
| `323` | RPL_LISTEND | `numerics/323.json` | End of channel list |
|
| `323` | RPL_LISTEND | `numerics/323.json` | End of channel list |
|
||||||
| `332` | RPL_TOPIC | `numerics/332.json` | Channel topic |
|
| `332` | RPL_TOPIC | `numerics/332.json` | Channel topic |
|
||||||
| `353` | RPL_NAMREPLY | `numerics/353.json` | Channel member list |
|
| `353` | RPL_NAMREPLY | `numerics/353.json` | Channel member list |
|
||||||
| `366` | RPL_ENDOFNAMES | `numerics/366.json` | End of NAMES list |
|
| `366` | RPL_ENDOFNAMES | `numerics/366.json` | End of NAMES list |
|
||||||
| `372` | RPL_MOTD | `numerics/372.json` | MOTD line |
|
| `372` | RPL_MOTD | `numerics/372.json` | MOTD line |
|
||||||
| `375` | RPL_MOTDSTART | `numerics/375.json` | Start of MOTD |
|
| `375` | RPL_MOTDSTART | `numerics/375.json` | Start of MOTD |
|
||||||
| `376` | RPL_ENDOFMOTD | `numerics/376.json` | End of MOTD |
|
| `376` | RPL_ENDOFMOTD | `numerics/376.json` | End of MOTD |
|
||||||
|
|
||||||
### Errors (4xx)
|
### Errors (4xx)
|
||||||
|
|
||||||
| Code | Name | File | Description |
|
| Code | Name | File | Description |
|
||||||
| ----- | -------------------- | ------------------- | ----------------------- |
|
|-------|----------------------|-----------------------|--------------------------------|
|
||||||
| `401` | ERR_NOSUCHNICK | `numerics/401.json` | No such nick/channel |
|
| `401` | ERR_NOSUCHNICK | `numerics/401.json` | No such nick/channel |
|
||||||
| `403` | ERR_NOSUCHCHANNEL | `numerics/403.json` | No such channel |
|
| `403` | ERR_NOSUCHCHANNEL | `numerics/403.json` | No such channel |
|
||||||
| `433` | ERR_NICKNAMEINUSE | `numerics/433.json` | Nickname already in use |
|
| `433` | ERR_NICKNAMEINUSE | `numerics/433.json` | Nickname already in use |
|
||||||
| `442` | ERR_NOTONCHANNEL | `numerics/442.json` | Not on that channel |
|
| `442` | ERR_NOTONCHANNEL | `numerics/442.json` | Not on that channel |
|
||||||
| `482` | ERR_CHANOPRIVSNEEDED | `numerics/482.json` | Not channel operator |
|
| `482` | ERR_CHANOPRIVSNEEDED | `numerics/482.json` | Not channel operator |
|
||||||
|
|
||||||
## Federation (S2S)
|
## Federation (S2S)
|
||||||
|
|
||||||
|
|||||||
@@ -1,143 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/bootstrap: install all dependencies needed to build and develop
|
|
||||||
# this repo. Idempotent: every install is guarded by a check so already
|
|
||||||
# installed tools are skipped. Base tooling comes from nix, apt, brew,
|
|
||||||
# or apk (detected in that order); assumes nothing is present. Node is
|
|
||||||
# used directly if installed; otherwise it is installed at a pinned
|
|
||||||
# version via nvm (installing nvm itself first, from a hash-verified
|
|
||||||
# release archive, never curl | sh).
|
|
||||||
#
|
|
||||||
# The Go install at the end of main() is this repo's addition.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
# Pinned versions, 2026-07-06
|
|
||||||
NODE_VERSION="22.17.0"
|
|
||||||
NVM_VERSION="0.40.3"
|
|
||||||
# sha256 of https://github.com/nvm-sh/nvm/archive/refs/tags/v0.40.3.tar.gz
|
|
||||||
NVM_SHA256="5f4d6aaa04a177dc93c985e31dbc411ab6b8c6e1e21d8015dbc1372625fcd1d0"
|
|
||||||
YARN_VERSION="1.22.22"
|
|
||||||
|
|
||||||
PKGMGR=""
|
|
||||||
SUDO=""
|
|
||||||
|
|
||||||
detect_pkgmgr() {
|
|
||||||
[ -n "$PKGMGR" ] && return 0
|
|
||||||
if command -v nix-env >/dev/null 2>&1; then
|
|
||||||
PKGMGR="nix"
|
|
||||||
elif command -v apt-get >/dev/null 2>&1; then
|
|
||||||
PKGMGR="apt"
|
|
||||||
elif command -v brew >/dev/null 2>&1; then
|
|
||||||
PKGMGR="brew"
|
|
||||||
elif command -v apk >/dev/null 2>&1; then
|
|
||||||
PKGMGR="apk"
|
|
||||||
else
|
|
||||||
echo "bootstrap: no supported package manager (nix, apt, brew, apk)" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
if [ "$PKGMGR" = "apt" ]; then
|
|
||||||
export DEBIAN_FRONTEND=noninteractive
|
|
||||||
if [ "$(id -u)" != "0" ]; then
|
|
||||||
SUDO="sudo"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# pkg_install <nix-attr> <apt-pkg> <brew-formula> <apk-pkg>
|
|
||||||
pkg_install() {
|
|
||||||
detect_pkgmgr
|
|
||||||
case "$PKGMGR" in
|
|
||||||
nix) nix-env -iA "nixpkgs.$1" ;;
|
|
||||||
apt) $SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y "$2" ;;
|
|
||||||
brew) brew install "$3" ;;
|
|
||||||
apk) apk add --no-cache "$4" ;;
|
|
||||||
esac
|
|
||||||
}
|
|
||||||
|
|
||||||
missing() {
|
|
||||||
! command -v "$1" >/dev/null 2>&1
|
|
||||||
}
|
|
||||||
|
|
||||||
# verify_sha256 <file> <expected-hash>
|
|
||||||
verify_sha256() {
|
|
||||||
if command -v sha256sum >/dev/null 2>&1; then
|
|
||||||
actual="$(sha256sum "$1" | cut -d' ' -f1)"
|
|
||||||
else
|
|
||||||
actual="$(shasum -a 256 "$1" | cut -d' ' -f1)"
|
|
||||||
fi
|
|
||||||
if [ "$actual" != "$2" ]; then
|
|
||||||
echo "bootstrap: sha256 mismatch for $1" >&2
|
|
||||||
echo " expected: $2" >&2
|
|
||||||
echo " actual: $actual" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# nvm is a bash script; run a command in a bash with nvm loaded
|
|
||||||
nvm_sh() {
|
|
||||||
bash -c ". \"\$HOME/.nvm/nvm.sh\" && $*"
|
|
||||||
}
|
|
||||||
|
|
||||||
ensure_nvm() {
|
|
||||||
[ -s "$HOME/.nvm/nvm.sh" ] && return 0
|
|
||||||
# nvm prerequisites; nvm itself requires bash
|
|
||||||
if missing bash; then pkg_install bash bash bash bash; fi
|
|
||||||
if missing curl; then pkg_install curl curl curl curl; fi
|
|
||||||
if missing git; then pkg_install git git git git; fi
|
|
||||||
tmp="$(mktemp -d)"
|
|
||||||
curl -fsSL -o "$tmp/nvm.tar.gz" \
|
|
||||||
"https://github.com/nvm-sh/nvm/archive/refs/tags/v${NVM_VERSION}.tar.gz"
|
|
||||||
verify_sha256 "$tmp/nvm.tar.gz" "$NVM_SHA256"
|
|
||||||
mkdir -p "$HOME/.nvm"
|
|
||||||
tar -xzf "$tmp/nvm.tar.gz" -C "$HOME/.nvm" --strip-components=1
|
|
||||||
rm -rf "$tmp"
|
|
||||||
}
|
|
||||||
|
|
||||||
ensure_node() {
|
|
||||||
if ! missing node; then return 0; fi
|
|
||||||
ensure_nvm
|
|
||||||
nvm_sh "nvm install $NODE_VERSION"
|
|
||||||
}
|
|
||||||
|
|
||||||
ensure_yarn() {
|
|
||||||
if ! missing yarn; then return 0; fi
|
|
||||||
if ! missing corepack; then
|
|
||||||
corepack enable
|
|
||||||
corepack prepare "yarn@$YARN_VERSION" --activate
|
|
||||||
elif [ -s "$HOME/.nvm/nvm.sh" ]; then
|
|
||||||
nvm_sh "nvm use $NODE_VERSION >/dev/null && corepack enable && \
|
|
||||||
corepack prepare yarn@$YARN_VERSION --activate"
|
|
||||||
else
|
|
||||||
npm install -g "yarn@$YARN_VERSION"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
install_js_deps() {
|
|
||||||
if missing yarn && [ -s "$HOME/.nvm/nvm.sh" ]; then
|
|
||||||
nvm_sh "nvm use $NODE_VERSION >/dev/null && cd \"$ROOT\" && \
|
|
||||||
yarn install --frozen-lockfile"
|
|
||||||
else
|
|
||||||
yarn install --frozen-lockfile
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
|
|
||||||
if missing make; then pkg_install gnumake make make make; fi
|
|
||||||
if missing git; then pkg_install git git git git; fi
|
|
||||||
|
|
||||||
ensure_node
|
|
||||||
ensure_yarn
|
|
||||||
install_js_deps
|
|
||||||
|
|
||||||
# Go, for make build, script/precommit and the gofmt step of
|
|
||||||
# script/fmt and script/fmt-check. golangci-lint is not installed: it
|
|
||||||
# runs only in the Dockerfile's lint phase.
|
|
||||||
if missing go; then pkg_install go golang go go; fi
|
|
||||||
|
|
||||||
echo "bootstrap complete"
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/check: run all checks (test, lint, fmt-check). Our own
|
|
||||||
# extension to scripts-to-rule-them-all. test and lint are Docker
|
|
||||||
# phases; fmt-check is native, because a formatter writes the working
|
|
||||||
# tree. Must not modify any files.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
"$SCRIPT_DIR/test"
|
|
||||||
"$SCRIPT_DIR/lint"
|
|
||||||
"$SCRIPT_DIR/fmt-check"
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/cibuild: run the CI build. It bootstraps first: a CI runner
|
|
||||||
# checks out and runs this and nothing else, and script/fmt-check runs
|
|
||||||
# the formatter on the host, which a pristine checkout cannot do.
|
|
||||||
# --no-cache for the same reason as script/docker: the gate phases the
|
|
||||||
# final stage depends on are RUN steps, and a cached one is a check that
|
|
||||||
# did not run.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
|
||||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
"$SCRIPT_DIR/bootstrap"
|
|
||||||
"$SCRIPT_DIR/check"
|
|
||||||
# Own line: a failing command substitution inside an argument does
|
|
||||||
# not trip `set -e`, so the inline form degrades silently to an
|
|
||||||
# empty constant. The VERSION build argument takes precedence over
|
|
||||||
# the version a build stage derives from the .git in the context.
|
|
||||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
|
||||||
[ -n "$version" ] || version="unknown"
|
|
||||||
docker build --no-cache \
|
|
||||||
--build-arg VERSION="$version" \
|
|
||||||
-t "$("$SCRIPT_DIR/projectname")" .
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/docker: build the Docker image tagged with the project name.
|
|
||||||
# Identical in all repos; the tag comes from script/projectname.
|
|
||||||
# --no-cache because the gate phases the final stage depends on are RUN
|
|
||||||
# steps, and a cached one is a check that did not run.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
|
||||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
# Own line: a failing command substitution inside an argument does
|
|
||||||
# not trip `set -e`, so the inline form degrades silently to an
|
|
||||||
# empty constant. The VERSION build argument takes precedence over
|
|
||||||
# the version a build stage derives from the .git in the context.
|
|
||||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
|
||||||
[ -n "$version" ] || version="unknown"
|
|
||||||
docker build --no-cache \
|
|
||||||
--build-arg VERSION="$version" \
|
|
||||||
-t "$("$SCRIPT_DIR/projectname")" .
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
-35
@@ -1,35 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/fmt: format all files (writes).
|
|
||||||
#
|
|
||||||
# The gofmt step in main() is this repo's addition.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
# Must match the pin in script/bootstrap.
|
|
||||||
NODE_VERSION="22.17.0"
|
|
||||||
|
|
||||||
# script/bootstrap installs node and yarn under nvm and leaves neither
|
|
||||||
# on the PATH of the shell that called it, so resolve the pinned
|
|
||||||
# toolchain here the way bootstrap's own install step does. nvm is a
|
|
||||||
# bash script, hence the subshell.
|
|
||||||
run_yarn() {
|
|
||||||
if command -v yarn >/dev/null 2>&1; then
|
|
||||||
exec yarn "$@"
|
|
||||||
fi
|
|
||||||
if [ ! -s "$HOME/.nvm/nvm.sh" ]; then
|
|
||||||
echo "fmt: no yarn; run script/bootstrap first" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
exec bash -c '. "$HOME/.nvm/nvm.sh" && nvm use "$1" >/dev/null &&
|
|
||||||
shift && exec yarn "$@"' bash "$NODE_VERSION" "$@"
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
# Before prettier, because run_yarn replaces this shell with yarn.
|
|
||||||
gofmt -s -w .
|
|
||||||
run_yarn run prettier --write '**/*.md' --tab-width 4 --prose-wrap always
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/fmt-check: check formatting (read-only).
|
|
||||||
#
|
|
||||||
# The gofmt check in main() is this repo's addition.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
# Must match the pin in script/bootstrap.
|
|
||||||
NODE_VERSION="22.17.0"
|
|
||||||
|
|
||||||
# script/bootstrap installs node and yarn under nvm and leaves neither
|
|
||||||
# on the PATH of the shell that called it, so resolve the pinned
|
|
||||||
# toolchain here the way bootstrap's own install step does. nvm is a
|
|
||||||
# bash script, hence the subshell.
|
|
||||||
run_yarn() {
|
|
||||||
if command -v yarn >/dev/null 2>&1; then
|
|
||||||
exec yarn "$@"
|
|
||||||
fi
|
|
||||||
if [ ! -s "$HOME/.nvm/nvm.sh" ]; then
|
|
||||||
echo "fmt-check: no yarn; run script/bootstrap first" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
exec bash -c '. "$HOME/.nvm/nvm.sh" && nvm use "$1" >/dev/null &&
|
|
||||||
shift && exec yarn "$@"' bash "$NODE_VERSION" "$@"
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
# Before prettier, because run_yarn replaces this shell with yarn.
|
|
||||||
unformatted="$(gofmt -s -l .)"
|
|
||||||
if [ -n "$unformatted" ]; then
|
|
||||||
echo "fmt-check: run make fmt; gofmt would change:" >&2
|
|
||||||
echo "$unformatted" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
run_yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/install-precommit: install the git pre-commit hook that runs
|
|
||||||
# script/precommit. Our own extension to scripts-to-rule-them-all.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
hook=".git/hooks/pre-commit"
|
|
||||||
printf '#!/bin/sh\nset -e\nscript/precommit\n' > .git/hooks/pre-commit
|
|
||||||
chmod +x .git/hooks/pre-commit
|
|
||||||
echo "pre-commit hook installed: runs script/precommit"
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
-23
@@ -1,23 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/lint: run the linter. Linting is a phase of the Dockerfile and
|
|
||||||
# this builds that phase alone; the linter is never installed or run on
|
|
||||||
# a developer host, where a shared result cache and a host-global lock
|
|
||||||
# make its answer untrustworthy.
|
|
||||||
#
|
|
||||||
# The phase is not the last stage in the file, so it is built only when
|
|
||||||
# --target names it. --no-cache because a cached lint layer is a lint
|
|
||||||
# that did not run. The tag makes each build replace the previous image
|
|
||||||
# instead of leaving a dangling one behind.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
|
||||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
docker build --no-cache \
|
|
||||||
--target lint \
|
|
||||||
-t "$("$SCRIPT_DIR/projectname")-lint" .
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/precommit: run by the git pre-commit hook; fails the commit if
|
|
||||||
# checks fail. Our own extension to scripts-to-rule-them-all.
|
|
||||||
#
|
|
||||||
# This repo's addition: go mod tidy runs first, failing the commit if it
|
|
||||||
# changes go.mod or go.sum.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
|
||||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
go mod tidy
|
|
||||||
git diff --exit-code -- go.mod go.sum || {
|
|
||||||
echo "precommit: go mod tidy changed go.mod or go.sum;" \
|
|
||||||
"stage the changes and retry" >&2
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
"$SCRIPT_DIR/check"
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/projectname: output the name of this project. Our own
|
|
||||||
# extension to scripts-to-rule-them-all. Other scripts that need the
|
|
||||||
# name (e.g. script/docker) call this, so they can stay identical
|
|
||||||
# across all repos.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
main() {
|
|
||||||
echo "neoirc"
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/setup: set up the repo for development after a fresh clone:
|
|
||||||
# installs dependencies and the git pre-commit hook.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
"$SCRIPT_DIR/bootstrap"
|
|
||||||
"$SCRIPT_DIR/install-precommit"
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
-19
@@ -1,19 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# script/test: run the test suite. Testing is a phase of the Dockerfile
|
|
||||||
# and this builds that phase alone, on the same terms as script/lint:
|
|
||||||
# --target because a phase that is not the last stage is built only when
|
|
||||||
# named, --no-cache because a cached test layer is a test that did not
|
|
||||||
# run, and a tag so each build replaces the previous image.
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
|
||||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
cd "$ROOT"
|
|
||||||
docker build --no-cache \
|
|
||||||
--target test \
|
|
||||||
-t "$("$SCRIPT_DIR/projectname")-test" .
|
|
||||||
}
|
|
||||||
|
|
||||||
main "$@"
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
||||||
# yarn lockfile v1
|
|
||||||
|
|
||||||
|
|
||||||
prettier@3.8.1:
|
|
||||||
version "3.8.1"
|
|
||||||
resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.8.1.tgz#edf48977cf991558f4fcbd8a3ba6015ba2a3a173"
|
|
||||||
integrity sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==
|
|
||||||
Reference in New Issue
Block a user