pmproducer/src/main/java/org/oran/pmproducer/datastore/S3ObjectStore.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2023 Nordix Foundation
   6  * %%
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ========================LICENSE_END===================================
  19  */
  20
  21 package org.oran.pmproducer.datastore;
  22
  23 import java.net.URI;
  24 import java.nio.file.Path;
  25 import java.util.concurrent.CompletableFuture;
  26
  27 import org.oran.pmproducer.configuration.ApplicationConfig;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 import reactor.core.publisher.Flux;
  32 import reactor.core.publisher.Mono;
  33 import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
  34 import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
  35 import software.amazon.awssdk.core.BytesWrapper;
  36 import software.amazon.awssdk.core.ResponseBytes;
  37 import software.amazon.awssdk.core.async.AsyncRequestBody;
  38 import software.amazon.awssdk.core.async.AsyncResponseTransformer;
  39 import software.amazon.awssdk.regions.Region;
  40 import software.amazon.awssdk.services.s3.S3AsyncClient;
  41 import software.amazon.awssdk.services.s3.S3AsyncClientBuilder;
  42 import software.amazon.awssdk.services.s3.model.CreateBucketRequest;
  43 import software.amazon.awssdk.services.s3.model.CreateBucketResponse;
  44 import software.amazon.awssdk.services.s3.model.DeleteBucketRequest;
  45 import software.amazon.awssdk.services.s3.model.DeleteBucketResponse;
  46 import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
  47 import software.amazon.awssdk.services.s3.model.DeleteObjectResponse;
  48 import software.amazon.awssdk.services.s3.model.GetObjectRequest;
  49 import software.amazon.awssdk.services.s3.model.GetObjectResponse;
  50 import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
  51 import software.amazon.awssdk.services.s3.model.HeadObjectResponse;
  52 import software.amazon.awssdk.services.s3.model.ListObjectsRequest;
  53 import software.amazon.awssdk.services.s3.model.ListObjectsResponse;
  54 import software.amazon.awssdk.services.s3.model.PutObjectRequest;
  55 import software.amazon.awssdk.services.s3.model.PutObjectResponse;
  56 import software.amazon.awssdk.services.s3.model.S3Object;
  57
  58 class S3ObjectStore implements DataStore {
  59     private static final Logger logger = LoggerFactory.getLogger(S3ObjectStore.class);
  60     private final ApplicationConfig applicationConfig;
  61
  62     private static S3AsyncClient s3AsynchClient;
  63
  64     public S3ObjectStore(ApplicationConfig applicationConfig) {
  65         this.applicationConfig = applicationConfig;
  66
  67         getS3AsynchClient(applicationConfig);
  68     }
  69
  70     @SuppressWarnings({"java:S3010", "java:S2209"})
  71     public S3ObjectStore(ApplicationConfig applicationConfig, S3AsyncClient s3AsynchClient) {
  72         this.applicationConfig = applicationConfig;
  73         this.s3AsynchClient = s3AsynchClient;
  74     }
  75
  76     private static synchronized S3AsyncClient getS3AsynchClient(ApplicationConfig applicationConfig) {
  77         if (applicationConfig.isS3Enabled() && s3AsynchClient == null) {
  78             s3AsynchClient = getS3AsyncClientBuilder(applicationConfig).build();
  79         }
  80         return s3AsynchClient;
  81     }
  82
  83     private static S3AsyncClientBuilder getS3AsyncClientBuilder(ApplicationConfig applicationConfig) {
  84         URI uri = URI.create(applicationConfig.getS3EndpointOverride());
  85         return S3AsyncClient.builder() //
  86                 .region(Region.US_EAST_1) //
  87                 .endpointOverride(uri) //
  88                 .credentialsProvider(StaticCredentialsProvider.create( //
  89                         AwsBasicCredentials.create(applicationConfig.getS3AccessKeyId(), //
  90                                 applicationConfig.getS3SecretAccessKey())));
  91     }
  92
  93     @Override
  94     public Flux<String> listObjects(Bucket bucket, String prefix) {
  95         return listObjectsInBucket(bucket(bucket), prefix).map(S3Object::key);
  96     }
  97
  98     @Override
  99     public Mono<Boolean> createLock(String name) {
 100         return getHeadObject(bucket(Bucket.LOCKS), name).flatMap(head -> createLock(name, head)) //
 101                 .onErrorResume(t -> createLock(name, null));
 102     }
 103
 104     private Mono<Boolean> createLock(String name, HeadObjectResponse head) {
 105         if (head == null) {
 106
 107             return this.putObject(Bucket.LOCKS, name, "") //
 108                     .flatMap(resp -> Mono.just(true)) //
 109                     .doOnError(t -> logger.warn("Failed to create lock {}, reason: {}", name, t.getMessage())) //
 110                     .onErrorResume(t -> Mono.just(false));
 111         } else {
 112             return Mono.just(false);
 113         }
 114     }
 115
 116     @Override
 117     public Mono<Boolean> deleteLock(String name) {
 118         return deleteObject(Bucket.LOCKS, name);
 119     }
 120
 121     @Override
 122     public Mono<Boolean> deleteObject(Bucket bucket, String name) {
 123
 124         DeleteObjectRequest request = DeleteObjectRequest.builder() //
 125                 .bucket(bucket(bucket)) //
 126                 .key(name) //
 127                 .build();
 128
 129         CompletableFuture<DeleteObjectResponse> future = s3AsynchClient.deleteObject(request);
 130
 131         return Mono.fromFuture(future).map(resp -> true);
 132     }
 133
 134     @Override
 135     public Mono<byte[]> readObject(Bucket bucket, String fileName) {
 136         return getDataFromS3Object(bucket(bucket), fileName);
 137     }
 138
 139     public Mono<String> putObject(Bucket bucket, String fileName, String bodyString) {
 140         PutObjectRequest request = PutObjectRequest.builder() //
 141                 .bucket(bucket(bucket)) //
 142                 .key(fileName) //
 143                 .build();
 144
 145         AsyncRequestBody body = AsyncRequestBody.fromString(bodyString);
 146
 147         CompletableFuture<PutObjectResponse> future = s3AsynchClient.putObject(request, body);
 148
 149         return Mono.fromFuture(future) //
 150                 .map(putObjectResponse -> fileName) //
 151                 .doOnError(t -> logger.error("Failed to store file in S3 {}", t.getMessage()));
 152     }
 153
 154     @Override
 155     public Mono<String> copyFileTo(Path fromFile, String toFile) {
 156         return copyFileToS3Bucket(bucket(Bucket.FILES), fromFile, toFile);
 157     }
 158
 159     @Override
 160     public Mono<String> create(Bucket bucket) {
 161         return createS3Bucket(bucket(bucket));
 162     }
 163
 164     private Mono<String> createS3Bucket(String s3Bucket) {
 165
 166         CreateBucketRequest request = CreateBucketRequest.builder() //
 167                 .bucket(s3Bucket) //
 168                 .build();
 169
 170         CompletableFuture<CreateBucketResponse> future = s3AsynchClient.createBucket(request);
 171
 172         return Mono.fromFuture(future) //
 173                 .map(f -> s3Bucket) //
 174                 .doOnError(t -> logger.trace("Could not create S3 bucket: {}", t.getMessage()))
 175                 .onErrorResume(t -> Mono.just(s3Bucket));
 176     }
 177
 178     @Override
 179     public Mono<String> deleteBucket(Bucket bucket) {
 180         return listObjects(bucket, "") //
 181                 .flatMap(key -> deleteObject(bucket, key)) //
 182                 .collectList() //
 183                 .flatMap(list -> deleteBucketFromS3Storage(bucket)) //
 184                 .map(resp -> "OK")
 185                 .doOnError(t -> logger.warn("Could not delete bucket: {}, reason: {}", bucket(bucket), t.getMessage()))
 186                 .onErrorResume(t -> Mono.just("NOK"));
 187     }
 188
 189     private Mono<DeleteBucketResponse> deleteBucketFromS3Storage(Bucket bucket) {
 190         DeleteBucketRequest request = DeleteBucketRequest.builder() //
 191                 .bucket(bucket(bucket)) //
 192                 .build();
 193
 194         CompletableFuture<DeleteBucketResponse> future = s3AsynchClient.deleteBucket(request);
 195
 196         return Mono.fromFuture(future);
 197     }
 198
 199     private String bucket(Bucket bucket) {
 200         return bucket == Bucket.FILES ? applicationConfig.getS3Bucket() : applicationConfig.getS3LocksBucket();
 201     }
 202
 203     private Mono<String> copyFileToS3Bucket(String s3Bucket, Path fileName, String s3Key) {
 204
 205         PutObjectRequest request = PutObjectRequest.builder() //
 206                 .bucket(s3Bucket) //
 207                 .key(s3Key) //
 208                 .build();
 209
 210         AsyncRequestBody body = AsyncRequestBody.fromFile(fileName);
 211
 212         CompletableFuture<PutObjectResponse> future = s3AsynchClient.putObject(request, body);
 213
 214         return Mono.fromFuture(future) //
 215                 .map(f -> s3Key) //
 216                 .doOnError(t -> logger.error("Failed to store file in S3 {}", t.getMessage()));
 217
 218     }
 219
 220     private Mono<HeadObjectResponse> getHeadObject(String bucket, String key) {
 221         HeadObjectRequest request = HeadObjectRequest.builder().bucket(bucket).key(key).build();
 222
 223         CompletableFuture<HeadObjectResponse> future = s3AsynchClient.headObject(request);
 224         return Mono.fromFuture(future);
 225     }
 226
 227     private Mono<ListObjectsResponse> listObjectsRequest(String bucket, String prefix,
 228             ListObjectsResponse prevResponse) {
 229         ListObjectsRequest.Builder builder = ListObjectsRequest.builder() //
 230                 .bucket(bucket) //
 231                 .maxKeys(1000) //
 232                 .prefix(prefix);
 233
 234         if (prevResponse != null) {
 235             if (Boolean.TRUE.equals(prevResponse.isTruncated())) {
 236                 builder.marker(prevResponse.nextMarker());
 237             } else {
 238                 return Mono.empty();
 239             }
 240         }
 241
 242         ListObjectsRequest listObjectsRequest = builder.build();
 243         CompletableFuture<ListObjectsResponse> future = s3AsynchClient.listObjects(listObjectsRequest);
 244         return Mono.fromFuture(future);
 245     }
 246
 247     private Flux<S3Object> listObjectsInBucket(String bucket, String prefix) {
 248
 249         return listObjectsRequest(bucket, prefix, null) //
 250                 .expand(response -> listObjectsRequest(bucket, prefix, response)) //
 251                 .map(ListObjectsResponse::contents) //
 252                 .doOnNext(f -> logger.debug("Found objects in {}: {}", bucket, f.size())) //
 253                 .doOnError(t -> logger.warn("Error fromlist objects: {}", t.getMessage())) //
 254                 .flatMap(Flux::fromIterable) //
 255                 .doOnNext(obj -> logger.debug("Found object: {}", obj.key()));
 256     }
 257
 258     private Mono<byte[]> getDataFromS3Object(String bucket, String key) {
 259
 260         GetObjectRequest request = GetObjectRequest.builder() //
 261                 .bucket(bucket) //
 262                 .key(key) //
 263                 .build();
 264
 265         CompletableFuture<ResponseBytes<GetObjectResponse>> future =
 266                 s3AsynchClient.getObject(request, AsyncResponseTransformer.toBytes());
 267
 268         return Mono.fromFuture(future) //
 269                 .map(BytesWrapper::asByteArray) //
 270                 .doOnError(t -> logger.error("Failed to get file from S3, key:{}, bucket: {}, {}", key, bucket,
 271                         t.getMessage())) //
 272                 .doOnNext(n -> logger.debug("Read file from S3: {} {}", bucket, key)) //
 273                 .onErrorResume(t -> Mono.empty());
 274     }
 275
 276 }