Skip to content

feat(app): add support for S3-compatible services #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 28, 2025
Merged

feat(app): add support for S3-compatible services #330

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 36 additions & 2 deletions app/src/main/java/org/naviqore/app/infrastructure/GtfsScheduleS3.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
import org.naviqore.service.repo.GtfsScheduleRepository;
import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
import software.amazon.awssdk.core.sync.ResponseTransformer;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.S3ClientBuilder;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;

import java.io.IOException;
Expand All @@ -19,12 +21,17 @@
* Repository for loading a static GTFS feed from an S3 bucket.
* <p>
* Expected format for the S3 URI: {@code s3://bucket-name/path/to/gtfs.zip}. AWS credentials and region must be
* provided via environment variables: {@code AWS_ACCESS_KEY_ID}, {@code AWS_SECRET_ACCESS_KEY}, {@code AWS_REGION}.
* provided via standard environment variables. Supports S3-compatible endpoints like MinIO via
* {@code AWS_ENDPOINT_URL_S3} and {@code AWS_S3_FORCE_PATH_STYLE}.
*/
@Slf4j
@RequiredArgsConstructor
public class GtfsScheduleS3 implements GtfsScheduleRepository {

private static final String AWS_REGION = "AWS_REGION";
private static final String AWS_ENDPOINT_URL = "AWS_ENDPOINT_URL";
private static final String AWS_ENDPOINT_URL_S_3 = "AWS_ENDPOINT_URL_S3";
private static final String AWS_S_3_FORCE_PATH_STYLE = "AWS_S3_FORCE_PATH_STYLE";
private static final String TMP_DIRECTORY_PREFIX = "tmp_gtfs_";
private static final String FILE_NAME = "gtfs.zip";

Expand All @@ -39,13 +46,40 @@ public GtfsSchedule get() throws IOException, InterruptedException {
Path tempDir = Files.createTempDirectory(TMP_DIRECTORY_PREFIX);
Path filePath = tempDir.resolve(FILE_NAME);

try (S3Client s3 = S3Client.builder().credentialsProvider(DefaultCredentialsProvider.create()).build()) {
// setup default builder
S3ClientBuilder s3ClientBuilder = S3Client.builder()
.credentialsProvider(DefaultCredentialsProvider.builder().build());

// configure region from environment variable
String region = System.getenv(AWS_REGION);
if (region != null && !region.isBlank()) {
s3ClientBuilder.region(Region.of(region));
}

// configure endpoint override; use the S3-specific variable first, then fall back to the generic one
String endpointOverride = System.getenv(AWS_ENDPOINT_URL_S_3);
if (endpointOverride == null || endpointOverride.isBlank()) {
endpointOverride = System.getenv(AWS_ENDPOINT_URL);
}
if (endpointOverride != null && !endpointOverride.isBlank()) {
log.debug("S3 endpoint override is set to: {}", endpointOverride);
s3ClientBuilder.endpointOverride(URI.create(endpointOverride));
}

// force path-style access if requested
String forcePathStyle = System.getenv(AWS_S_3_FORCE_PATH_STYLE);
if ("true".equalsIgnoreCase(forcePathStyle)) {
log.info("S3 path-style access is enabled.");
s3ClientBuilder.forcePathStyle(true);
}

try (S3Client s3 = s3ClientBuilder.build()) {
log.info("Downloading file: {}", s3Uri);
s3.getObject(GetObjectRequest.builder().bucket(bucket).key(key).build(),
ResponseTransformer.toFile(filePath));

return new GtfsScheduleReader().read(filePath.toString());

} finally {
Files.deleteIfExists(filePath);
Files.deleteIfExists(tempDir);
Expand Down