Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,16 @@ services:
ROUTECRAFT_CORS_ALLOWED_ORIGINS: http://localhost:3000,http://127.0.0.1:3000
ports:
- "18080:18080"
healthcheck:
test: ["CMD", "curl", "--fail", "--silent", "http://localhost:18080/health"]
interval: 5s
timeout: 2s
retries: 10
depends_on:
postgres:
condition: service_healthy
routecraft-engine:
condition: service_healthy

volumes:
routecraft_postgres_data:
1 change: 1 addition & 0 deletions services/routecraft-api/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ COPY src src
RUN ./mvnw -q -DskipTests package

FROM eclipse-temurin:21-jre
RUN apt-get update && apt-get install -y --no-install-recommends curl && rm -rf /var/lib/apt/lists/*
WORKDIR /app
COPY --from=build /workspace/target/routecraft-api-0.0.1-SNAPSHOT.jar app.jar
EXPOSE 18080
Expand Down
2 changes: 2 additions & 0 deletions services/routecraft-api/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# RouteCraft API

Saved routes can be downloaded as GPX 1.1 for Garmin and other sports devices with `GET /api/saved-routes/{id}/export.gpx`. A matching route returns `200` with `Content-Type: application/gpx+xml` and `Content-Disposition: attachment; filename="{id}.gpx"`; missing routes return `404`, and payloads whose `geometry` is missing, not an array, or shorter than two points return `400`.

Liveness can be checked with `GET /health` (returns `200 {"status":"UP"}` when the database answers `SELECT 1`, otherwise `503 {"status":"DOWN"}`) or Spring Actuator at `GET /actuator/health`. Neither endpoint probes the Rust routing engine.
4 changes: 4 additions & 0 deletions services/routecraft-api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webmvc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package com.routecraft.api;

import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Map;

import javax.sql.DataSource;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
class HealthController {

private final DataSource dataSource;

HealthController(DataSource dataSource) {
this.dataSource = dataSource;
}

@GetMapping("/health")
ResponseEntity<Map<String, String>> health() {
try (Connection connection = dataSource.getConnection();
Statement statement = connection.createStatement()) {
statement.execute("SELECT 1");
return ResponseEntity.ok(Map.of("status", "UP"));
} catch (SQLException ex) {
return ResponseEntity.status(HttpStatus.SERVICE_UNAVAILABLE)
.body(Map.of("status", "DOWN"));
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

import com.routecraft.api.config.RoutingProperties;

@SpringBootApplication
@EnableConfigurationProperties(RoutingProperties.class)
public class RoutecraftApiApplication {

public static void main(String[] args) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package com.routecraft.api.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;

import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Pattern;
import jakarta.validation.constraints.Positive;

@ConfigurationProperties(prefix = "routecraft.routing")
@Validated
public record RoutingProperties(
@NotBlank
@Pattern(regexp = "java|rust")
String engine,
@NotBlank
String engineUrl,
@Positive
long engineBudgetSeconds) {
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ routecraft.elevation.lookup-timeout-ms=${ROUTECRAFT_ELEVATION_LOOKUP_TIMEOUT_MS:
routecraft.routing.engine=${ROUTECRAFT_ROUTING_ENGINE:rust}
routecraft.routing.engine-url=${ROUTECRAFT_ENGINE_URL:http://routecraft-engine:8090}
routecraft.routing.engine-budget-seconds=${ROUTECRAFT_ENGINE_BUDGET_SECONDS:30}

management.endpoints.web.exposure.include=health
management.endpoint.health.show-details=never
management.endpoint.health.probes.enabled=true
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
package com.routecraft.api.config;

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.Set;

import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

import jakarta.validation.ConstraintViolation;
import jakarta.validation.Validation;
import jakarta.validation.Validator;
import jakarta.validation.ValidatorFactory;

class RoutingPropertiesTest {

private static Validator validator;

@BeforeAll
static void setUpValidator() {
ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
validator = factory.getValidator();
}

@Test
void acceptsJavaAndRustEngines() {
assertTrue(validator.validate(new RoutingProperties("java", "http://localhost:8090", 30)).isEmpty());
assertTrue(validator.validate(new RoutingProperties("rust", "http://routecraft-engine:8090", 1)).isEmpty());
}

@Test
void rejectsInvalidEngine() {
Set<ConstraintViolation<RoutingProperties>> violations =
validator.validate(new RoutingProperties("python", "http://localhost:8090", 30));
assertFalse(violations.isEmpty());
}

@Test
void rejectsBlankEngineUrl() {
Set<ConstraintViolation<RoutingProperties>> violations =
validator.validate(new RoutingProperties("rust", " ", 30));
assertFalse(violations.isEmpty());
}

@Test
void rejectsNonPositiveBudget() {
assertFalse(validator.validate(new RoutingProperties("rust", "http://localhost:8090", 0)).isEmpty());
assertFalse(validator.validate(new RoutingProperties("rust", "http://localhost:8090", -5)).isEmpty());
}
}
Loading