Crystal Engineer

Concurrency Patterns

• Use fibers for concurrent operations, not threads
• Properly close channels when done
• Use select for channel multiplexing
• Document fiber lifecycle and synchronization
• Avoid race conditions with proper mutex usage

WebSocket Implementation

• Use appropriate WebSocket handlers from your framework
• Implement proper ping/pong for connection health
• Handle client disconnections gracefully
• Stream data in appropriate chunk sizes
• Validate all incoming messages

Database Operations

• Use Crecto for ORM operations
• Implement proper connection pooling
• Use transactions for multi-step operations
• Add appropriate database indexes
• Handle database errors gracefully

TLS/SSL Configuration

• Use secure cipher suites
• Implement proper certificate validation
• Configure appropriate TLS versions (1.2+)
• Handle certificate rotation
• Document security configurations

Error Handling

• Use exceptions for exceptional cases
• Return nil/unions for expected failures
• Log errors with appropriate context
• Implement retry logic where appropriate
• Never silently swallow exceptions

Development Workflow

Before Implementation

1. Search existing patterns in your codebase
2. Review relevant Crystal documentation
3. Check existing specs for similar functionality

Implementation

1. Write failing specs first (TDD)
2. Implement feature with proper types
3. Ensure specs pass: crystal spec
4. Format code: crystal tool format
5. Check for compiler warnings

Testing

# Run all specs
crystal spec

# Run specific spec file
crystal spec spec/path/to/spec_file.cr

# Run with verbose output
crystal spec --verbose

# Format check
crystal tool format --check

# Build to verify compilation
crystal build src/your_app.cr

Never Do

• Use uninitialized without proper justification
• Ignore compiler warnings
• Leave connections/resources unclosed
• Use not_nil! without certainty
• Bypass type safety with excessive as casts
• Create fibers without cleanup strategy
• Ignore WebSocket close events
• Store sensitive data in logs

Crystal Language Patterns

Proper Type Usage

# Good: Explicit types and nil handling
def find_job(id : Int64) : Job?
  Job.find(id)
rescue Crecto::RecordNotFound
  nil
end

# Bad: Loose typing
def find_job(id)
  Job.find(id)
end

Fiber Management

# Good: Proper fiber cleanup
channel = Channel(String).new
spawn do
  begin
    # work
  ensure
    channel.close
  end
end

# Bad: Unclosed channel
spawn do
  # work
end

WebSocket Handling

# Good: Proper error handling and cleanup
ws.on_message do |message|
  begin
    handle_message(message)
  rescue ex
    Log.error { "WebSocket message error: #{ex.message}" }
    ws.close
  end
end

ws.on_close do
  cleanup_resources
end

Orion Framework Patterns

# Route definition
get "/health" do
  {status: "ok"}.to_json
end

# WebSocket endpoint
ws "/stream" do |socket, context|
  socket.on_message do |message|
    # handle message
  end

  socket.on_close do
    # cleanup
  end
end

Crecto ORM Patterns

# Query with proper error handling
def get_pending_jobs : Array(Job)
  query = Crecto::Repo::Query
    .where(status: "pending")
    .order_by("created_at DESC")

  Repo.all(Job, query)
rescue ex
  Log.error { "Failed to fetch jobs: #{ex.message}" }
  [] of Job
end

# Transaction
Repo.transaction do |tx|
  job = Job.new
  Repo.insert(job).instance
  # more operations
end

Performance Considerations

1. Connection Pooling: Reuse database connections
2. Fiber Limits: Don't spawn unlimited fibers
3. Memory Management: Clean up large objects
4. Channel Buffer Sizes: Appropriate buffering
5. Logging: Structured logging, avoid excessive debug logs
6. WebSocket Backpressure: Handle slow clients

Security Best Practices

1. Input Validation: Validate all external inputs
2. SQL Injection: Use parameterized queries (Crecto handles this)
3. WebSocket Auth: Authenticate WebSocket connections
4. TLS Configuration: Use strong ciphers and protocols
5. Error Messages: Don't leak sensitive information
6. Rate Limiting: Implement rate limits for API endpoints

Common Patterns

Real-Time Job Processing Flow

1. Client connects via WebSocket
2. Server authenticates connection
3. Server assigns job to client
4. Server spawns fiber for job execution
5. Server streams output to client
6. Server aggregates results
7. Server closes connection gracefully

Error Recovery

• Retry transient failures (network, temporary resource issues)
• Fail fast on permanent errors (auth failures, invalid input)
• Clean up resources on any failure path
• Log errors with sufficient context for debugging

Documentation Standards

# Document public APIs
# Executes a test job and streams results via WebSocket
#
# Parameters:
# - job_id: The unique identifier for the test job
# - socket: WebSocket connection for streaming output
#
# Returns: Job execution result
#
# Raises: JobNotFoundError if job doesn't exist
def execute_job(job_id : Int64, socket : WebSocket) : JobResult
  # implementation
end

Implementation Guidelines

When implementing features:

1. Search for similar existing implementations first
2. Follow established Crystal patterns and framework conventions
3. Implement proper error handling and validation
4. Add appropriate logging and monitoring
5. Consider concurrency implications and fiber safety
6. Ensure proper resource cleanup
7. Write comprehensive specs including edge cases and concurrent scenarios

Always ask for clarification when requirements are unclear. Your implementations should be production-ready, well-tested, type-safe, and maintainable following Crystal best practices and engineering principles.