Files
go-caatsm/README.md
T
windyboyandClaude Sonnet 4.5 d0fd461e38 Add weather report parsing for METAR, SPECI, and TAF
Implement comprehensive weather parsing capabilities following Clean
Architecture principles with composite parser pattern for routing between
aviation and weather messages.

## Features Added

- Weather report parsing (METAR, SPECI, TAF)
- Composite parser pattern for message routing
- Lenient parsing with warnings for unrecognized tokens
- Support for PROB and RMK sections in TAF
- Rich domain modeling with typed weather elements

## Architecture

**Domain Layer** (internal/domain/weather/):
- WeatherMessage interface with Metar and Taf implementations
- Weather elements: Wind, Visibility, Cloud, Temperature, Altimeter, Phenomenon
- Domain errors: ErrInvalidFormat, ErrMissingStation, ErrMissingTime

**Port Layer** (internal/port/weather_parser.go):
- WeatherParser interface with CanParse and Parse methods

**Adapter Layer** (internal/adapter/parser/weather/):
- WeatherParserImpl with classification and parsing logic
- Comprehensive regex patterns for weather elements
- METAR/SPECI parser with element extraction
- TAF parser with period handling (FM, TEMPO, BECMG, PROB)
- Helper functions for time parsing and unit conversions

**Composite Parser** (internal/adapter/parser/composite.go):
- Routes weather reports to weather parser
- Falls back to aviation parser for telegrams
- Converts WeatherMessage to ParsedTelegram format

## Integration

- Updated ProvideParser to create composite parser with weather parser
- Added weather parser to Wire DI configuration
- Updated processor_bench_test.go for weather parser integration
- Documentation added in docs/weather-parser.md

## Testing

- 29 comprehensive tests for weather parsing (all passing)
- Tests for classification, METAR, SPECI, TAF, and composite routing
- Benchmark compatibility maintained

## Fixes Applied

- TAF PROB parsing: Include PROB/RMK in special section detection
- Composite test: Updated to use properly formatted AFTN telegram
- Linter issues: Switch statement refactor, removed unused patterns
- Ineffective break statement fixed in TAF parser

## Coverage

~1,743 lines of new code with:
- Complete METAR/SPECI parsing
- TAF parsing with period support
- Lenient error handling with warnings
- Unit conversions and time utilities

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2025-12-24 16:38:03 +08:00

200 lines
4.4 KiB
Markdown

# go-caatsm
Civil Aviation Authority Telegram Message Processor.
High-performance processing for aviation telegrams using Clean Architecture, NATS JetStream, and PostgreSQL/TimescaleDB.
## Architecture
Clean Architecture with clear separation of concerns:
- cmd: application entry points
- internal/domain: core domain types
- internal/port: interfaces/contracts
- internal/app: application orchestration
- internal/adapter: parsing, mapping, DTOs
- internal/infra: NATS, PostgreSQL, config, logging, metrics, telemetry
- pkg/di: dependency injection (Wire)
## Features
- JetStream ingestion with retries and DLQ support
- PostgreSQL/TimescaleDB persistence
- Structured logging (Zap)
- OpenTelemetry tracing and Prometheus metrics
- Optional AFTN protocol validation
- Batch processing and health monitoring
- Weather report parsing (METAR, SPECI, TAF)
## Prerequisites
- Go 1.24+
- PostgreSQL 12+
- NATS Server with JetStream enabled
- Docker (integration tests)
## Quick Start
1. Start dependencies:
```bash
docker compose -f docker-compose.dev.yml up -d postgres nats nats-box
```
2. Configure the application:
- Copy `configs/config.dev.toml` and edit as needed
- Or set environment variables with the `CAATSM_` prefix
3. Run in dev mode:
```bash
make run-dev
```
## Build and Run
- Build: `make build`
- Run (dev): `make run-dev`
- Run (prod): `make run-prod`
- Run (local go run): `make run-local`
## Configuration
Configuration loads from `configs/config.{env}.toml`, where `{env}` is `GO_ENV` (default: `dev`).
Required values:
- `nats.url`
- `postgres.url`
- `publisher.topic`
Defaults:
- `nats.stream` defaults to `TELEGRAM`
- `subscription.topic` defaults to `telegram.>`
- `nats.mode` must be `jetstream` or empty (defaults to JetStream)
Minimal example:
```toml
[nats]
url = "nats://localhost:4222"
mode = "jetstream"
stream = "TELEGRAM"
consumer = "telegram-consumer"
[publisher]
topic = "telegram.json"
[subscription]
topic = "telegram.serial"
[postgres]
url = "postgres://user:password@localhost:5432/aviation?sslmode=disable"
[app]
batch_size = 50
batch_timeout = "2s"
monitor_interval = "30s"
[log]
level = "info"
format = "json"
```
### Timeouts and Ack Wait
`[timeouts]` is optional. To tune redelivery, set `timeouts.ack_wait` and/or `nats.consumer_rules.ack_wait`. When neither is specified the application defaults to `30s`.
## JetStream Notes
- JetStream is required; other modes are not supported.
- In dev/test (`GO_ENV=dev` or `GO_ENV=test`), the stream and consumer are auto-created.
- In production, ensure the stream and consumer exist before starting the service.
- Configure retention and delivery behavior under `[nats.stream_limits]` and `[nats.consumer_rules]`.
## AFTN Validation
AFTN validation is optional and disabled by default. Enable it with:
```toml
[aftn]
validation_enabled = true
message_gap_threshold = "2m"
enable_sequence_gap_detection = true
```
When enabled, invalid telegrams are logged, recorded with error details, and can be routed to a DLQ if configured.
## Observability
- Metrics: `GET /metrics`
- Liveness: `GET /livez`
- Readiness: `GET /readyz`
Monitoring server settings are under `[monitoring]`. Tracing is configured via `[telemetry]`.
## CLI
```bash
./bin/receiver listen --help
```
Common flags:
- `--nats-url`
- `--subject`
- `--stream`
- `--consumer`
- `--publisher-topic`
- `--postgres-url`
- `--log-level`
- `--replay-from`
- `--ack-wait`
- `--telemetry-enabled`, `--telemetry-endpoint`, `--telemetry-insecure`
## Testing
- Unit tests (Ginkgo): `make test`
- Integration tests (Docker): `make test-int`
- All tests: `make test-all`
- Lint: `make lint`
- Coverage: `make coverage`
Single test example:
```bash
ginkgo -r -v --focus "Test Description" ./path/to/package
```
## Seed Tool
`cmd/seed-telegrams` publishes synthetic telegrams for development and testing.
Example:
```bash
go run ./cmd/seed-telegrams \
--nats-url nats://localhost:4222 \
--jetstream \
--stream TELEGRAM \
--js-subject telegram.serial \
--count 10 \
--category mixed \
--status random
```
## Documentation
- `docs/dev-guide.md`
- `docs/prod-guide.md`
- `docs/nats.md`
- `docs/observability.md`
- `docs/performance.md`
- `docs/migrations.md`
- `docs/secret-management.md`
- `docs/reliability.md`
## Contributing
See `AGENTS.md` for coding standards, testing expectations, and release hygiene.
## License
This repository has not declared a public license yet.