Skip to content

Health check depth for database and Horizon #101

@greatest0fallt1me

Description

@greatest0fallt1me

Description

Extend /health to report dependency readiness (database ping, Horizon reachability) for orchestrators.

Requirements and context

  • Fast fail for liveness versus slower readiness semantics documented.

Suggested execution

Fork and branch

Fork the repo and create a branch:

git checkout -b feature/health-dependencies

Implement changes

  • Update Creditra-Backend/src/routes/health.ts.
  • Tests in src/__tests__/health.test.ts and tests/health.test.ts.

Test and commit

Run tests, cover edge cases, and attach test output plus security or ops notes (auth, PII, Stellar keys) in the PR.

Run tests

npm test

Example commit message

feat(health): dependency checks in health endpoint

Guidelines

  • Minimum 95% coverage on touched modules where applicable (npm test / coverage report).

  • Clear documentation (OpenAPI openapi.yaml, README, and inline comments for non-obvious logic).

  • Timeframe: 96 hours.

  • Run npm run build or tsc if types change.

  • Keep OpenAPI in sync with route behavior.

Metadata

Metadata

Assignees

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions