Development Environment - SJAA Members DB

Prerequisites

Before setting up your development environment, ensure you have:

Docker Desktop - Download from docker.com
- No subscription required, choose the free tier
- Required for running the containerized application
VS Code (Recommended) - For the best development experience with integrated tasks
Git - For cloning and managing the repository
.env file - Contains application secrets (contact developers for access)

The preferred and supported way to maintain a replicable development environment is with Docker. While you can set up your own environment without Docker, this is not covered in this documentation.

Initial Setup

First-Time Setup

Clone the repository:

git clone https://github.com/sjaa/sjaa-memberships.git
cd sjaa-memberships

Build the Docker containers:

docker compose build

Obtain the .env file:
- Contact the developers for the .env file containing application secrets
- Place it in the root directory of the project
- This file is not checked into version control for security reasons
Start the containers:

docker compose up

Initialize the database:
- On first run, the database is automatically initialized with a single admin account: vp@sjaa.net
- To generate sample data for development:

docker container exec -it sjaa-memberships-app-1 bin/rake generate_data

Access the application:
- Navigate to https://127.0.0.1:3001
- You’ll see a browser warning about the self-signed certificate
- This is normal in development - click through the warning to proceed

VS Code Tasks (Recommended)

The easiest way to run common development tasks is through VS Code’s built-in task runner. All tasks are pre-configured in .vscode/tasks.json and run commands inside the Docker container automatically.

Running Tasks

Access tasks through the Command Palette:

Press Cmd+Shift+P (macOS) or Ctrl+Shift+P (Windows/Linux)
Type “Tasks: Run Task”
Select from the list of available tasks

Or use the keyboard shortcut Cmd+Shift+B (macOS) or Ctrl+Shift+B (Windows/Linux) to run the default build task.

Available VS Code Tasks

Rails Console

Task Name: Rails Console Opens an interactive Rails console for debugging and exploring the application. What it does:

docker container exec -it sjaa-memberships-app-1 env RUBY_DEBUG_OPEN= bin/rails console

When to use:

Explore the database and ActiveRecord models
Test code snippets interactively
Debug data or relationships
Run one-off commands

Example session:

# Find a person by email
Person.joins(:contacts).where(contacts: {email: 'test@example.com'}).first

# Check membership status
Person.find_by(last_name: 'Smith').status.name

# Get all active members
Person.active_members

Run All Tests

Task Name: Run All Tests Runs the complete test suite (models, controllers, system tests). What it does:

docker compose run --rm app bin/rails test:all

When to use:

Before committing changes
After major refactoring
To ensure everything works together
CI/CD validation locally

Expected output:

Green dots (.) for passing tests
F for failures
E for errors
Final summary with test count and timing

Run Rails Tests

Task Name: Run Rails Tests Runs only unit and integration tests (excludes system tests for faster execution). What it does:

docker compose run --rm app bin/rails test

When to use:

Quick validation during development
Testing models and controllers only
Faster feedback loop than full test suite

Runs:

Model tests (test/models/)
Controller tests (test/controllers/)
Helper tests (test/helpers/)
Mailer tests (test/mailers/)

Run Single Test File

Task Name: Run Single Test File Runs tests from a specific file. VS Code prompts you to enter the test file path. What it does:

docker compose run --rm app bin/rails test test/models/person_test.rb

When to use:

Focused testing on specific functionality
Debugging a single failing test
Iterating on new test cases
Faster than running entire suite

Example paths:

test/models/person_test.rb
test/controllers/people_controller_test.rb
test/system/memberships_test.rb

Tip: You can also run a single test method:

docker compose run --rm app bin/rails test test/models/person_test.rb:42

(where 42 is the line number of the test method)

Run System Tests

Task Name: Run System Tests Runs browser-based integration tests using Capybara and Selenium. What it does:

docker compose run --rm app bin/rails test:system

When to use:

Testing full user workflows
Validating JavaScript interactions
End-to-end feature verification
Before deploying major UI changes

Note: System tests take longer as they start a headless browser for each test.

Start Rails Debug Server

Task Name: Start Rails Debug Server Starts the Rails server with remote debugging enabled on port 1234. What it does:

timeout 15 docker container exec sjaa-memberships-app-1 env RUBY_DEBUG_OPEN= bin/rails console

When to use:

When you need to set breakpoints in your code
Step-through debugging of complex logic
Inspecting variable state during execution

After starting:

Set breakpoints in your code (click in the gutter)
Open Run and Debug view (Cmd+Shift+D / Ctrl+Shift+D)
Select “Attach to Rails (Docker)”
Press F5 to attach the debugger

See Debugging section for detailed instructions.

Update Gemfile.lock

Task Name: Update Gemfile.lock Rebuilds the Docker image and extracts the updated Gemfile.lock after changing gems. What it does:

docker compose build app && \
docker create --name temp sjaa-memberships-app-1 && \
docker cp temp:/rails/Gemfile.lock ./ && \
docker rm temp && \
docker compose up -d

When to use:

After adding gems to Gemfile
After updating gem versions
After removing gems

Why this is necessary: The bind mount (./:/rails) overlays your local directory onto the container at runtime. The Gemfile.lock updated during build gets replaced by your local version. This task extracts it to keep them in sync.

Command-Line Tasks

If you prefer working directly with the command line, here are the essential commands:

Starting and Stopping

# Start all services (app + postgres)
docker compose up

# Start in background
docker compose up -d

# Stop all services
docker compose down

# Restart services
docker compose restart

Database Operations

# Run pending migrations
docker compose run --rm app bin/rails db:migrate

# Reset database (drop, create, migrate, seed)
docker compose run --rm app bin/rails db:reset

# Seed database with initial data
docker compose run --rm app bin/rails db:seed

# Open Rails console
docker compose run --rm app env RUBY_DEBUG_OPEN= bin/rails console

# Open database console
docker compose run --rm app bin/rails dbconsole

Running Tests

# All tests
docker compose run --rm app bin/rails test:all

# Just Rails tests (no system tests)
docker compose run --rm app bin/rails test

# Model tests only
docker compose run --rm app bin/rails test test/models/

# Controller tests only
docker compose run --rm app bin/rails test test/controllers/

# System tests only
docker compose run --rm app bin/rails test test/system/

# Single test file
docker compose run --rm app bin/rails test test/models/person_test.rb

# Single test method (by line number)
docker compose run --rm app bin/rails test test/models/person_test.rb:42

Background Jobs

# Run Calendar Sync Job
docker compose run --rm app bin/rails runner "CalendarSyncJob.perform_now('vp@sjaa.net')"

# Run Renewal Reminders Job
docker compose run --rm app bin/rails runner "RenewalRemindersJob.perform_now('enable', '* 1 *')"

# Process queued jobs with custom worker
docker compose run --rm app bin/rails runner lib/solid_queue_simple_worker.rb

# Process specific queue
docker compose run --rm app bin/rails runner "lib/solid_queue_simple_worker.rb -q default"

# With debug logging
docker compose run --rm app bin/rails runner "lib/solid_queue_simple_worker.rb -d"

# Clear all queued jobs
docker compose run --rm app bin/rails runner "SolidQueue::Job.delete_all"

# Clear only pending jobs
docker compose run --rm app bin/rails runner "SolidQueue::Job.where(finished_at: nil).delete_all"

Custom Rake Tasks

# Generate fake test data (100 people)
docker compose run --rm app bin/rails generate_data

# Port data from SJAA database
docker compose run --rm app bin/rails patch PATCH_FILE=file.csv COMMIT=true

# Compare membership lists
docker compose run --rm app bin/rails csv_compare CSV1=file1.csv CSV2=file2.csv

Updating Dependencies

When you update the Gemfile (add/remove/update gems):

# 1. Rebuild the Docker image (installs gems, updates Gemfile.lock)
docker compose build app

# 2. Extract updated Gemfile.lock from image to local filesystem
docker create --name temp sjaa-memberships-app-1 && \
docker cp temp:/rails/Gemfile.lock ./ && \
docker rm temp

# 3. Restart containers with updated configuration
docker compose up -d

Or use the VS Code task: “Update Gemfile.lock” (recommended)

Debugging

The application supports remote debugging using the debug gem with VS Code.

Starting a Debug Session

Option 1: VS Code Task (Recommended)

Run the “Start Rails Debug Server” task
Set breakpoints in your code (click in the gutter)
Open Run and Debug view (Cmd+Shift+D / Ctrl+Shift+D)
Select “Attach to Rails (Docker)”
Press F5 to attach

### Debug Configuration

The debug server runs on `localhost:1234` with these settings:
- **Remote workspace root:** `/rails`
- **Local workspace root:** Your project directory
- **Port:** 1234

### Debugging Commands

Once attached to the debugger:
- **Step Over** - Execute current line, don't enter functions
- **Step Into** - Enter function calls
- **Step Out** - Exit current function
- **Continue** - Run until next breakpoint
- **Restart** - Restart the debug session

**In code:** Add `debugger` anywhere to create a breakpoint:
```ruby
def some_method
  debugger  # Execution will pause here
  # ... rest of method
end

VS Code Debug Configurations

Three debug configurations are available in .vscode/launch.json:

Attach to Rails (Docker) - Primary option
Debug Rails (Docker) - Alternative - Fallback option
Connect to rdbg (Docker) - Direct rdbg connection

Troubleshooting Debugging

Problem: Can’t connect to debugger

Ensure port 1234 is not in use: lsof -i :1234
Check Docker logs: docker compose logs app
Verify debug gem is installed: docker compose run --rm app gem list debug
Restart containers: docker compose restart

Problem: Breakpoints not hitting

Ensure debug server is running
Verify breakpoint is in executed code path
Check that source maps are correctly configured
Try adding debugger statement directly in code

Common Workflows

Adding a New Feature

Create a new branch:

git checkout -b feature/my-new-feature

Make your changes in your editor
Write tests for the new functionality
Run tests using VS Code task “Run All Tests” or:

docker compose run --rm app bin/rails test:all

Test manually in the browser at https://127.0.0.1:3001
Commit and push:

git add .
git commit -m "Add new feature: description"
git push origin feature/my-new-feature

Fixing a Bug

Reproduce the bug in development environment
Write a failing test that exposes the bug
Use the debugger to understand what’s happening:
- Add debugger statement where bug occurs
- Run “Start Rails Debug Server” task
- Attach debugger and step through code
Fix the bug based on findings
Verify test passes using “Run All Tests” task
Commit the fix with descriptive message

Database Schema Changes

Generate migration:

docker compose run --rm app bin/rails generate migration AddFieldToPeople field:string

Edit the migration file in db/migrate/
Run the migration:

docker compose run --rm app bin/rails db:migrate

Update models and tests to reflect schema changes
Test thoroughly before committing

Adding or Updating Gems

Edit Gemfile to add/update/remove gems
Update Gemfile.lock using VS Code task “Update Gemfile.lock” or:

docker compose build app && \
docker create --name temp sjaa-memberships-app-1 && \
docker cp temp:/rails/Gemfile.lock ./ && \
docker rm temp && \
docker compose up -d

Verify application still works
Run tests to catch any issues
Commit both Gemfile and Gemfile.lock

Best Practices

Container Management

Start containers in background:

docker compose up -d

Check container logs:

docker compose logs app      # View all logs
docker compose logs -f app   # Follow logs in real-time

Restart after configuration changes:

docker compose restart

Clean up unused containers/images:

docker system prune

Testing

Run tests frequently:

Use “Run Rails Tests” task during development (faster)
Use “Run All Tests” task before committing
Use “Run Single Test File” task when focusing on specific feature

Write tests first:

Test-driven development helps catch issues early
Tests serve as documentation
Easier to refactor with good test coverage

Keep tests fast:

Use fixtures or factories efficiently
Minimize database calls in tests
Run system tests only when needed

Database

Regular backups in development:

docker compose exec db pg_dump -U postgres sjaa_memberships_development > backup.sql

Reset when needed:

After major schema changes
When test data becomes inconsistent
Use VS Code task “Generate Test Data” after reset

Don’t commit .env:

Contains secrets and credentials
Already in .gitignore
Get from developers for legitimate use

Troubleshooting

Port Already in Use

Problem: Error about port 3001 or 5432 already in use Solution:

# Find process using port
lsof -i :3001

# Kill the process (use PID from above)
kill -9 <PID>

# Or change port in docker-compose.yml

Database Connection Errors

Problem: Can’t connect to PostgreSQL database Solution:

# Restart database container
docker compose restart db

# Check database is running
docker compose ps

# View database logs
docker compose logs db

# Recreate database from scratch
docker compose down -v
docker compose up -d
docker compose run --rm app bin/rails db:setup

Container Won’t Start

Problem: Docker container fails to start Solution:

# Check logs for errors
docker compose logs app

# Rebuild from scratch
docker compose down
docker compose build --no-cache
docker compose up

# Ensure Docker Desktop is running
# Check disk space (Docker needs space for images)

Tests Failing

Problem: Tests that should pass are failing Solution:

# Reset test database
docker compose run --rm app bin/rails db:test:prepare

# Clear any cached data
docker compose down -v
docker compose up -d
docker compose run --rm app bin/rails db:setup

# Run tests with verbose output
docker compose run --rm app bin/rails test -v

Permission Errors

Problem: Permission denied errors when running commands Solution:

Ensure Docker Desktop has necessary permissions
On macOS: System Preferences → Security & Privacy
On Linux: Add user to docker group:

sudo usermod -aG docker $USER

Log out and back in for changes to take effect

Browser Certificate Warning

Problem: Browser shows security warning at https://127.0.0.1:3001 Solution:

This is expected with self-signed certificates
Safe to click “Advanced” → “Proceed to localhost”
Warning doesn’t appear in production with valid certificate

Changes Not Reflecting

Problem: Code changes don’t appear in running application Solution:

# Restart Rails server
docker compose restart app

# Or for immediate effect during development, use:
docker compose down
docker compose up

Note: In development mode, most changes are auto-reloaded. If not:

Check for syntax errors in logs
Restart may be needed for initializers or routes
Clear browser cache for asset changes

Environment Variables

Key environment variables in .env file:

Database: DATABASE_URL, POSTGRES_USER, POSTGRES_PASSWORD
Rails: RAILS_ENV, SECRET_KEY_BASE
PayPal: PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET
Google: OAuth credentials for Calendar, Groups, Admin Directory
Email: SMTP settings for Gmail

Never commit .env to version control. It contains sensitive credentials.

Additional Resources

CLAUDE.md - AI assistant instructions and command reference
.vscode/tasks.json - VS Code task definitions
.vscode/launch.json - Debugger configurations
docker-compose.yml - Container orchestration
Dockerfile - Application container definition
README.md - Project overview and quick start

Summary

The development environment is containerized with Docker for consistency and ease of setup. VS Code tasks provide the recommended workflow for common operations like running tests, accessing the console, and debugging. For developers who prefer the command line, all tasks can also be run with docker compose and docker container exec commands. Key points:

Use Docker Desktop for environment management
Use VS Code tasks for the best developer experience
Run tests frequently during development
Use the debugger to understand complex issues
Keep containers and database in sync with migrations
Follow the documented workflows for common tasks

Developer Guides

​Prerequisites

​Initial Setup

​First-Time Setup

​VS Code Tasks (Recommended)

​Running Tasks

​Available VS Code Tasks

​Rails Console

​Run All Tests

​Run Rails Tests

​Run Single Test File

​Run System Tests

​Start Rails Debug Server

​Update Gemfile.lock

​Command-Line Tasks

​Starting and Stopping

​Database Operations

​Running Tests

​Background Jobs

​Custom Rake Tasks

​Updating Dependencies

​Debugging

​Starting a Debug Session

​VS Code Debug Configurations

​Troubleshooting Debugging

​Common Workflows

​Adding a New Feature

​Fixing a Bug

​Database Schema Changes

​Adding or Updating Gems

​Best Practices

​Container Management

​Testing

​Database

​Troubleshooting

​Port Already in Use

​Database Connection Errors

​Container Won’t Start

​Tests Failing

​Permission Errors

​Browser Certificate Warning

​Changes Not Reflecting

​Environment Variables

​Additional Resources

​Summary

Prerequisites

Initial Setup

First-Time Setup

VS Code Tasks (Recommended)

Running Tasks

Available VS Code Tasks

Rails Console

Run All Tests

Run Rails Tests

Run Single Test File

Run System Tests

Start Rails Debug Server

Update Gemfile.lock

Command-Line Tasks

Starting and Stopping

Database Operations

Running Tests

Background Jobs

Custom Rake Tasks

Updating Dependencies

Debugging

Starting a Debug Session

VS Code Debug Configurations

Troubleshooting Debugging

Common Workflows

Adding a New Feature

Fixing a Bug

Database Schema Changes

Adding or Updating Gems

Best Practices

Container Management

Testing

Database

Troubleshooting

Port Already in Use

Database Connection Errors

Container Won’t Start

Tests Failing

Permission Errors

Browser Certificate Warning

Changes Not Reflecting

Environment Variables

Additional Resources

Summary