Development¶

Guide for building, testing, and contributing to Signal Fish Server.

Prerequisites¶

Rust 1.88.0 or later (see rust-version in Cargo.toml)
No system libraries required for the default build

Building¶

Debug Build¶

Bash

cargo build

Release Build¶

Bash

cargo build --release

Optimized and stripped for production.

With Optional Features¶

Bash

# TLS support
cargo build --features tls

# Legacy full-mesh mode
cargo build --features legacy-fullmesh

# All features
cargo build --all-features

Running¶

Development¶

Bash

cargo run

With Custom Config¶

Bash

# Using -c flag (not implemented - config.json is loaded by default)
# The server automatically looks for config.json in the working directory
cargo run

Note: The -c flag shown in some examples is not currently implemented. The server automatically loads config.json from the working directory if it exists.

Validate Config¶

Bash

cargo run -- --validate-config

Print Resolved Config¶

Bash

cargo run -- --print-config

Testing¶

Run All Tests¶

Bash

cargo test

Test with All Features¶

Bash

cargo test --all-features

Run Specific Test¶

Bash

cargo test test_room_creation

Test with Output¶

Bash

cargo test -- --nocapture

Integration Tests¶

Bash

cargo test --test integration_tests

E2E Tests¶

Bash

cargo test --test e2e_tests

Linting¶

Format Check¶

Bash

cargo fmt --check

Apply Formatting¶

Bash

cargo fmt

Clippy (Default)¶

Bash

cargo clippy --all-targets -- -D warnings

Clippy (All Features)¶

Bash

cargo clippy --all-targets --all-features -- -D warnings

Markdown Linting¶

Check markdown files for formatting issues, missing language identifiers, and inconsistencies:

Bash

./scripts/check-markdown.sh

Auto-fix markdown issues where possible:

Bash

./scripts/check-markdown.sh fix

Common markdown linting rules enforced by CI:

MD040: All code blocks must have language identifiers (e.g., ```bash not just ```)
MD046: Use fenced code blocks consistently
MD013: Lines should not exceed 120 characters (except tables)
MD044: Proper capitalization of technical terms (JavaScript, GitHub, WebSocket, etc.)

See .markdownlint.json for the complete rule configuration.

Spell Checking¶

Check for typos in code and documentation:

Bash

typos

Technical terms that are commonly flagged as typos are configured in .typos.toml. If a legitimate technical term is flagged, add it to the [default.extend-words] section.

Benchmarks¶

Bash

cargo bench

View results in target/criterion/report/index.html.

Code Coverage¶

Bash

cargo install cargo-tarpaulin
cargo tarpaulin --out Html --output-dir coverage

Open coverage/index.html to view results.

Docker Development¶

Build Image¶

Bash

docker build -t signal-fish-server .

Build with Cache¶

Bash

docker build -t signal-fish-server --cache-from ghcr.io/ambiguous-interactive/signal-fish-server:latest .

Run Image¶

Bash

docker run -p 3536:3536 signal-fish-server

With Custom Config¶

Bash

docker run -p 3536:3536 -v ./config.json:/app/config.json:ro signal-fish-server

Project Structure¶

Text Only

signal-fish-server/
├── src/
│   ├── main.rs                  # Binary entry point
│   ├── lib.rs                   # Library crate root
│   ├── server.rs                # EnhancedGameServer core
│   ├── auth/                    # Authentication
│   ├── config/                  # Configuration
│   ├── coordination/            # Room coordination
│   ├── database/                # Database trait + impl
│   ├── protocol/                # Message types
│   ├── security/                # TLS and crypto
│   ├── server/                  # Room service logic
│   └── websocket/               # WebSocket handlers
├── tests/                       # Integration tests
├── benches/                     # Benchmarks
├── config.example.json          # Example config
├── Cargo.toml
└── Dockerfile

Adding a New Feature¶

Write tests first

Bash

# Add test in tests/integration_tests.rs
cargo test test_new_feature -- --nocapture

Implement the feature

Bash

# Make changes in src/
cargo build

Run full test suite

Bash

cargo test --all-features

Lint and format

Bash

cargo fmt
cargo clippy --all-targets --all-features -- -D warnings

Update documentation
Add doc comments to public APIs
Update CHANGELOG.md
Update README.md if user-facing

Debug Logging¶

Set log level:

Bash

RUST_LOG=debug cargo run

Trace level (very verbose):

Bash

RUST_LOG=trace cargo run

Module-specific logging:

Bash

RUST_LOG=signal_fish_server::websocket=debug cargo run

Profiling¶

CPU Profiling¶

Bash

cargo install flamegraph
cargo flamegraph --bench benchmark_name

Memory Profiling¶

Bash

cargo install cargo-valgrind
cargo valgrind --bin signal-fish-server

Common Development Tasks¶

Add a Protocol Message¶

Add enum variant to ClientMessage or ServerMessage in src/protocol/messages.rs
Implement serialization/deserialization
Add handler in src/server.rs or src/server/ submodule
Add tests in tests/integration_tests.rs
Update protocol documentation in docs/protocol.md

Add a Configuration Option¶

Add field to appropriate config struct in src/config/
Add default value in src/config/defaults.rs
Add validation in src/config/validation.rs
Update config.example.json
Add tests for default, custom, and invalid values

Add a New Endpoint¶

Add route in src/websocket/routes.rs
Implement handler function
Add tests in tests/e2e_tests.rs
Update endpoint documentation

Testing Strategy¶

Unit Tests¶

Place in the same file as the code:

Rust

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_room_code_generation() {
        let code = generate_room_code(6);
        assert_eq!(code.len(), 6);
    }
}

Integration Tests¶

Place in tests/ directory:

Rust

#[tokio::test]
async fn test_create_and_join_room() {
    let server = create_test_server().await;
    // Test multi-step flows
}

E2E Tests¶

Test full WebSocket flows:

Rust

#[tokio::test]
async fn test_websocket_connection() {
    let addr = spawn_test_server().await;
    let ws = connect_websocket(&addr).await;
    // Test complete session
}

MSRV and Toolchain Management¶

Minimum Supported Rust Version (MSRV)¶

The project MSRV is defined in Cargo.toml (rust-version = "1.88.0"). This is the oldest Rust compiler version guaranteed to build the project.

Verifying MSRV Consistency¶

Before committing changes that update the MSRV, verify all configuration files are consistent:

Bash

./scripts/check-msrv-consistency.sh

This script validates that the following files all use the same Rust version:

Cargo.toml (source of truth)
rust-toolchain.toml (developer toolchain)
clippy.toml (MSRV-aware lints)
Dockerfile (production build environment)

Updating MSRV¶

When a dependency requires a newer Rust version, follow the MSRV update checklist:

Update all configuration files:
Cargo.toml: rust-version = "1.XX.0"
rust-toolchain.toml: channel = "1.XX.0"
clippy.toml: msrv = "1.XX.0"
Dockerfile: FROM rust:1.XX-bookworm
Verify consistency:

Bash

./scripts/check-msrv-consistency.sh

Test with new MSRV:

Bash

cargo clean
cargo check --locked --all-targets
cargo test --locked --all-features

Update documentation:
Update this file's Prerequisites section
Update CHANGELOG.md
Document reason for MSRV bump in commit message

See MSRV Management for comprehensive MSRV management guidance.

Continuous Integration¶

The project uses GitHub Actions for CI. All PRs must pass:

cargo fmt --check - Code formatting
cargo clippy --all-targets --all-features -- -D warnings - Rust linting
cargo test --all-features - All tests
cargo build --release - Release build
MSRV verification - Validates MSRV consistency and builds with exact MSRV
Markdown linting - Validates markdown files for formatting and best practices
Spell checking - Checks for typos in code and documentation
YAML validation - Validates workflow files and configuration
Actionlint - Validates GitHub Actions workflow syntax

Running All CI Checks Locally¶

Before pushing, run all CI checks locally:

Bash

# Format check
cargo fmt --check

# Clippy
cargo clippy --all-targets --all-features -- -D warnings

# Tests
cargo test --all-features

# Markdown linting
./scripts/check-markdown.sh

# Spell checking (install with: cargo install typos-cli)
typos

# MSRV consistency
./scripts/check-msrv-consistency.sh

Or use the pre-commit hook to run checks automatically:

Bash

./scripts/enable-hooks.sh

Release Process¶

Update version in Cargo.toml
Update CHANGELOG.md
Run full test suite: cargo test --all-features
Build release: cargo build --release
Tag release: git tag v0.x.x
Push: git push origin v0.x.x

Next Steps¶

Library Usage - Embedding the server
Architecture - System design