Compare commits
4 Commits
c7d90314fd
...
ci/make-ch
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
18b6f86eec | ||
|
|
28771144bf | ||
|
|
c01222a597 | ||
|
|
06e1cba0a9 |
@@ -1,9 +1,21 @@
|
|||||||
name: check
|
name: check
|
||||||
on: [push]
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
jobs:
|
jobs:
|
||||||
check:
|
check:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
# actions/checkout v4.2.2, 2026-02-22
|
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
|
||||||
- run: docker build .
|
- uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5
|
||||||
|
with:
|
||||||
|
go-version-file: go.mod
|
||||||
|
|
||||||
|
- name: Install golangci-lint
|
||||||
|
run: go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@5d1e709b7be35cb2025444e19de266b056b7b7ee # v2.10.1
|
||||||
|
|
||||||
|
- name: Run make check
|
||||||
|
run: make check
|
||||||
|
|||||||
16
Dockerfile
16
Dockerfile
@@ -13,20 +13,10 @@ RUN apk add --no-cache \
|
|||||||
curl
|
curl
|
||||||
|
|
||||||
# golangci-lint v2.10.1, 2026-02-25
|
# golangci-lint v2.10.1, 2026-02-25
|
||||||
# SHA-256 checksums per architecture (amd64 / arm64)
|
RUN curl -sSfL https://github.com/golangci/golangci-lint/releases/download/v2.10.1/golangci-lint-2.10.1-linux-amd64.tar.gz -o /tmp/golangci-lint.tar.gz && \
|
||||||
RUN set -e; \
|
echo "dfa775874cf0561b404a02a8f4481fc69b28091da95aa697259820d429b09c99 /tmp/golangci-lint.tar.gz" | sha256sum -c - && \
|
||||||
ARCH="$(uname -m)"; \
|
|
||||||
if [ "$ARCH" = "aarch64" ] || [ "$ARCH" = "arm64" ]; then \
|
|
||||||
GOARCH="arm64"; \
|
|
||||||
HASH="6652b42ae02915eb2f9cb2a2e0cac99514c8eded8388d88ae3e06e1a52c00de8"; \
|
|
||||||
else \
|
|
||||||
GOARCH="amd64"; \
|
|
||||||
HASH="dfa775874cf0561b404a02a8f4481fc69b28091da95aa697259820d429b09c99"; \
|
|
||||||
fi; \
|
|
||||||
curl -sSfL "https://github.com/golangci/golangci-lint/releases/download/v2.10.1/golangci-lint-2.10.1-linux-${GOARCH}.tar.gz" -o /tmp/golangci-lint.tar.gz && \
|
|
||||||
echo "${HASH} /tmp/golangci-lint.tar.gz" | sha256sum -c - && \
|
|
||||||
tar -xzf /tmp/golangci-lint.tar.gz -C /tmp && \
|
tar -xzf /tmp/golangci-lint.tar.gz -C /tmp && \
|
||||||
mv "/tmp/golangci-lint-2.10.1-linux-${GOARCH}/golangci-lint" /usr/local/bin/ && \
|
mv /tmp/golangci-lint-2.10.1-linux-amd64/golangci-lint /usr/local/bin/ && \
|
||||||
rm -rf /tmp/golangci-lint*
|
rm -rf /tmp/golangci-lint*
|
||||||
|
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
|
|||||||
101
TODO.md
101
TODO.md
@@ -1,64 +1,65 @@
|
|||||||
# Status
|
# Pixa 1.0 TODO
|
||||||
|
|
||||||
pre-1.0. No git tags. Full policy file set is present, but make check
|
Remaining tasks sorted by priority for a working 1.0 release.
|
||||||
fails on main with 10 gosec lint findings, so main is not green.
|
|
||||||
|
|
||||||
# Next Step
|
## P0: Critical for 1.0
|
||||||
|
|
||||||
Fix the 10 gosec findings so make check passes on main. Fix each issue
|
### Image Processing
|
||||||
properly (no blanket nolint suppressions) and confirm lint, tests, and
|
- [x] Add WebP encoding support (currently returns error)
|
||||||
CI are green. This restores the main-always-green policy.
|
- [ ] Add AVIF encoding support (currently returns error)
|
||||||
|
|
||||||
# Completed Steps
|
### Manual Testing (verify auth/encrypted URLs work)
|
||||||
|
- [ ] Manual test: visit `/`, see login form
|
||||||
|
- [ ] Manual test: enter wrong key, see error
|
||||||
|
- [ ] Manual test: enter correct signing key, see generator form
|
||||||
|
- [ ] Manual test: generate encrypted URL, verify it works
|
||||||
|
- [ ] Manual test: wait for expiration or use short TTL, verify expired URL returns 410
|
||||||
|
- [ ] Manual test: logout, verify redirected to login
|
||||||
|
|
||||||
- 2026-02-25: Docker arm64 build fixed via architecture detection for
|
### Cache Management
|
||||||
golangci-lint download (#16)
|
- [ ] Implement cache size management/eviction (prevent disk from filling up)
|
||||||
- 2026-02-25: full repo policy compliance pass (#14): LICENSE,
|
|
||||||
REPO_POLICIES.md, .editorconfig, Gitea Actions CI workflow, Docker
|
|
||||||
images pinned by hash, README restructured to policy sections, hooks
|
|
||||||
Makefile target, golangci-lint errors resolved
|
|
||||||
- 2026-02-20: stale local dev config files removed (#12)
|
|
||||||
- 2026-02-09: correctness fixes: negative cache checked in Service.Get()
|
|
||||||
before upstream fetch (#8); Stats() column scanning and HitRate
|
|
||||||
computation corrected (#9)
|
|
||||||
- 2026-02-08: AllowHTTP propagated to SourceURL() scheme selection (#6)
|
|
||||||
- WebP encoding support added (P0 item, checked off in TODO)
|
|
||||||
- 2026-01-08: initial implementation with Makefile and TODO checklist
|
|
||||||
|
|
||||||
# Future Steps
|
### Configuration
|
||||||
|
- [ ] Validate configuration on startup (fail fast on bad config)
|
||||||
|
|
||||||
Compliance:
|
## P1: Important for Production
|
||||||
|
|
||||||
- After the gosec fix lands, verify CI runs make check green on main
|
### Security
|
||||||
|
- [ ] Implement blocked networks configuration (extend SSRF protection)
|
||||||
|
- [ ] Add rate limiting global concurrent fetches (prevent resource exhaustion)
|
||||||
|
|
||||||
P0, critical for 1.0 (from existing TODO.md):
|
### Image Processing
|
||||||
|
- [ ] Implement EXIF/metadata stripping (privacy)
|
||||||
|
|
||||||
- Add AVIF encoding support (currently returns error)
|
## P2: Nice to Have
|
||||||
- Manual test pass for auth and encrypted URLs:
|
|
||||||
- visit /, see login form
|
|
||||||
- wrong key shows error; correct signing key shows generator form
|
|
||||||
- generated encrypted URL works
|
|
||||||
- expired URL (short TTL) returns 410
|
|
||||||
- logout redirects to login
|
|
||||||
- Implement cache size management and eviction (prevent disk fill)
|
|
||||||
- Validate configuration on startup (fail fast on bad config)
|
|
||||||
|
|
||||||
P1, important for production:
|
### Security
|
||||||
|
- [ ] Implement referer blacklist
|
||||||
|
- [ ] Add rate limiting per-IP
|
||||||
|
- [ ] Add rate limiting per-origin
|
||||||
|
|
||||||
- Blocked networks configuration (extend SSRF protection)
|
### HTTP Response Handling
|
||||||
- Rate limit global concurrent fetches (resource exhaustion)
|
- [ ] Implement Last-Modified headers
|
||||||
- EXIF/metadata stripping (privacy)
|
- [ ] Implement Vary header for content negotiation
|
||||||
|
- [ ] Implement X-Request-ID propagation
|
||||||
|
|
||||||
P2, nice to have:
|
### Additional Endpoints
|
||||||
|
- [ ] Implement auto-format selection (format=auto based on Accept header)
|
||||||
|
|
||||||
- Referer blacklist; per-IP and per-origin rate limiting
|
### Configuration
|
||||||
- Last-Modified headers; Vary header; X-Request-ID propagation
|
- [ ] Add all configuration options from README
|
||||||
- Auto-format selection (format=auto based on Accept header)
|
- [ ] Implement environment variable overrides
|
||||||
- All configuration options from README; env var overrides; YAML config
|
- [ ] Implement YAML config file support
|
||||||
file support
|
|
||||||
- Sentry error reporting (optional); comprehensive request logging;
|
### Operational
|
||||||
Prometheus metrics
|
- [ ] Implement Sentry error reporting (optional)
|
||||||
- Integration tests for the image proxy flow; load tests for the
|
- [ ] Add comprehensive request logging
|
||||||
1-5k req/s target
|
- [ ] Add performance metrics (Prometheus)
|
||||||
- Docs: configuration options, API endpoints, deployment guide, example
|
- [ ] Write integration tests for image proxy flow
|
||||||
nginx/caddy reverse proxy config
|
- [ ] Write load tests to verify 1-5k req/s target
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
- [ ] Document configuration options
|
||||||
|
- [ ] Document API endpoints
|
||||||
|
- [ ] Document deployment guide
|
||||||
|
- [ ] Add example nginx/caddy reverse proxy config
|
||||||
|
|||||||
@@ -15,7 +15,8 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func TestMain(m *testing.M) {
|
func TestMain(m *testing.M) {
|
||||||
initVips()
|
vips.LoggingSettings(nil, vips.LogLevelError)
|
||||||
|
vips.Startup(nil)
|
||||||
code := m.Run()
|
code := m.Run()
|
||||||
vips.Shutdown()
|
vips.Shutdown()
|
||||||
os.Exit(code)
|
os.Exit(code)
|
||||||
|
|||||||
Reference in New Issue
Block a user