public-transport/cached-hafas-client

implement store.checkHealth

Open

#27 opened on May 3, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1 fork)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (10 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Right now, every user of cached-hafas-client has to implement store-specific health check logic; This is a waste of time.

The Redis store would do a PING (as hvv-rest currently does manually). The SQLite store would always report as healthy because there's no network in between.

Contributor guide

Research direction
Look at the existing store implementations (Redis, SQLite) and their interface, then add a `checkHealth` method that returns a promise resolving to true if healthy. For Redis, use the PING command; for SQLite, simply resolve true.
Tech stack
javascript
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsUnderstanding of store pattern
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70