feat: add verification function to the configuration of s3 object storage policy

build.gradle

@@ -16,7 +16,7 @@ repositories {
 }
 
 dependencies {
- implementation platform('run.halo.tools.platform:plugin:2.13.0-SNAPSHOT')
+ implementation platform('run.halo.tools.platform:plugin:2.14.0-SNAPSHOT')
  compileOnly 'run.halo.app:api'
 
  implementation platform('software.amazon.awssdk:bom:2.19.8')
@@ -36,7 +36,7 @@ configurations.runtimeClasspath {
 
 
 halo {
- version = '2.12.1'
+ version = '2.14.0'
 }
 
 haloPlugin {

src/main/java/run/halo/s3os/PolicyConfigValidationController.java

@@ -0,0 +1,123 @@
+package run.halo.s3os;
+
+import static run.halo.s3os.S3OsAttachmentHandler.MULTIPART_MIN_PART_SIZE;
+import static run.halo.s3os.S3OsAttachmentHandler.checkResult;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.core.io.DefaultResourceLoader;
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.buffer.DataBuffer;
+import org.springframework.core.io.buffer.DataBufferUtils;
+import org.springframework.core.io.buffer.DefaultDataBufferFactory;
+import org.springframework.util.StringUtils;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+import run.halo.app.infra.utils.PathUtils;
+import run.halo.app.plugin.ApiVersion;
+import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest;
+import software.amazon.awssdk.services.s3.model.CompletedMultipartUpload;
+import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest;
+import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
+import software.amazon.awssdk.utils.SdkAutoCloseable;
+
+@ApiVersion("s3os.halo.run/v1alpha1")
+@RestController
+@RequiredArgsConstructor
+@Slf4j
+public class PolicyConfigValidationController {
+ private final S3OsAttachmentHandler handler;
+
+ @PostMapping("/policies/s3/validation")
+ public Mono<Void> validatePolicyConfig(@RequestBody S3OsProperties properties) {
+ var filename = "halo-s3-plugin-test-file-" + System.currentTimeMillis() + ".jpg";
+ var content = readImage();
+ return Mono.using(() -> handler.buildS3Client(properties),
+ client -> {
+ var uploadState =
+ new S3OsAttachmentHandler.UploadState(properties, filename, false);
+
+ return handler.checkFileExistsAndRename(uploadState, client)
+ // init multipart upload
+ .flatMap(state -> Mono.fromCallable(() -> client.createMultipartUpload(
+ CreateMultipartUploadRequest.builder()
+ .bucket(properties.getBucket())
+ .contentType(state.contentType)
+ .key(state.objectKey)
+ .build())))
+ .doOnNext((response) -> {
+ checkResult(response, "createMultipartUpload");
+ uploadState.uploadId = response.uploadId();
+ })
+ .thenMany(handler.reshape(content, MULTIPART_MIN_PART_SIZE))
+ // buffer to part
+ .windowUntil((buffer) -> {
+ uploadState.buffered += buffer.readableByteCount();
+ if (uploadState.buffered >= MULTIPART_MIN_PART_SIZE) {
+ uploadState.buffered = 0;
+ return true;
+ } else {
+ return false;
+ }
+ })
+ // upload part
+ .concatMap((window) -> window.collectList().flatMap((bufferList) -> {
+ var buffer = S3OsAttachmentHandler.concatBuffers(bufferList);
+ return handler.uploadPart(uploadState, buffer, client);
+ }))
+ .reduce(uploadState, (state, completedPart) -> {
+ state.completedParts.put(completedPart.partNumber(), completedPart);
+ return state;
+ })
+ // complete multipart upload
+ .flatMap((state) -> Mono.just(client.completeMultipartUpload(
+ CompleteMultipartUploadRequest
+ .builder()
+ .bucket(properties.getBucket())
+ .uploadId(state.uploadId)
+ .multipartUpload(CompletedMultipartUpload.builder()
+ .parts(state.completedParts.values())
+ .build())
+ .key(state.objectKey)
+ .build())
+ ))
+ // get object metadata
+ .flatMap((response) -> {
+ checkResult(response, "completeUpload");
+ return Mono.just(client.headObject(
+ HeadObjectRequest.builder()
+ .bucket(properties.getBucket())
+ .key(uploadState.objectKey)
+ .build()
+ ));
+ })
+ // check object metadata
+ .doOnNext((response) -> {
+ checkResult(response, "headObject");
+ })
+ // delete object
+ .flatMap((response) -> Mono.just(client.deleteObject(
+ software.amazon.awssdk.services.s3.model.DeleteObjectRequest.builder()
+ .bucket(properties.getBucket())
+ .key(uploadState.objectKey)
+ .build()
+ )))
+ .doOnNext((response) -> checkResult(response, "deleteObject"))
+ .then();
+ },
+ SdkAutoCloseable::close)
+ .onErrorMap(S3ExceptionHandler::map);
+ }
+
+ private Flux<DataBuffer> readImage() {
+ DefaultResourceLoader resourceLoader = new DefaultResourceLoader(this.getClass()
+ .getClassLoader());
+ String path = PathUtils.combinePath("validation.jpg");
+ String simplifyPath = StringUtils.cleanPath(path);
+ Resource resource = resourceLoader.getResource(simplifyPath);
+ return DataBufferUtils.read(resource, new DefaultDataBufferFactory(), 1024);
+ }
+}

src/main/java/run/halo/s3os/S3OsAttachmentHandler.java

@@ -390,8 +390,8 @@ Mono<ObjectDetail> upload(UploadContext uploadContext, S3OsProperties properties
  SdkAutoCloseable::close);
  }
 
- private Mono<UploadState> checkFileExistsAndRename(UploadState uploadState,
- S3Client s3client) {
+ Mono<UploadState> checkFileExistsAndRename(UploadState uploadState,
+  S3Client s3client) {
  return Mono.defer(() -> {
  // deduplication of uploading files
  if (uploadingFile.put(uploadState.getUploadingMapKey(),
@@ -437,8 +437,8 @@ private Mono<UploadState> checkFileExistsAndRename(UploadState uploadState,
  }
 
 
- private Mono<CompletedPart> uploadPart(UploadState uploadState, ByteBuffer buffer,
- S3Client s3client) {
+ Mono<CompletedPart> uploadPart(UploadState uploadState, ByteBuffer buffer,
+  S3Client s3client) {
  final int partNumber = ++uploadState.partCounter;
  return Mono.just(s3client.uploadPart(UploadPartRequest.builder()
  .bucket(uploadState.properties.getBucket())
@@ -457,15 +457,15 @@ private Mono<CompletedPart> uploadPart(UploadState uploadState, ByteBuffer buffe
  });
  }
 
- private static void checkResult(SdkResponse result, String operation) {
+ static void checkResult(SdkResponse result, String operation) {
  log.info("operation: {}, result: {}", operation, result);
  if (result.sdkHttpResponse() == null || !result.sdkHttpResponse().isSuccessful()) {
  log.error("Failed to upload object, response: {}", result.sdkHttpResponse());
  throw new ServerErrorException("对象存储响应错误，无法将对象上传到S3对象存储", null);
  }
  }
 
- private static ByteBuffer concatBuffers(List<DataBuffer> buffers) {
+ static ByteBuffer concatBuffers(List<DataBuffer> buffers) {
  int partSize = 0;
  for (DataBuffer b : buffers) {
  partSize += b.readableByteCount();