-
Notifications
You must be signed in to change notification settings - Fork 231
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add java storage implementation for delete objects method (#1079)
* Add java-storage implementation for delete objects API. * Use a direct executor for 0 thread count configuration.
- Loading branch information
1 parent
5eec76a
commit 84652b2
Showing
6 changed files
with
541 additions
and
170 deletions.
There are no files selected for viewing
125 changes: 125 additions & 0 deletions
125
gcsio/src/main/java/com/google/cloud/hadoop/gcsio/BatchExecutor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| /* | ||
| * Copyright 2023 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.hadoop.gcsio; | ||
|
|
||
| import static com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemImpl.getFromFuture; | ||
| import static com.google.common.base.Preconditions.checkState; | ||
| import static com.google.common.util.concurrent.MoreExecutors.newDirectExecutorService; | ||
|
|
||
| import com.google.common.flogger.GoogleLogger; | ||
| import com.google.common.util.concurrent.FutureCallback; | ||
| import com.google.common.util.concurrent.ThreadFactoryBuilder; | ||
| import java.io.IOException; | ||
| import java.util.Queue; | ||
| import java.util.concurrent.Callable; | ||
| import java.util.concurrent.ConcurrentLinkedQueue; | ||
| import java.util.concurrent.ExecutorService; | ||
| import java.util.concurrent.Future; | ||
| import java.util.concurrent.LinkedBlockingQueue; | ||
| import java.util.concurrent.ThreadPoolExecutor; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| /** | ||
| * BatchExecutor provides a means to manually batch requests using a thread pool. Execution is | ||
| * performed by the underlying {@link #requestsExecutor} ExecutorService. | ||
| * | ||
| * <p>Expected usage is to create a new BatchExecutor instance per client operation that represents | ||
| * logical grouping of requests(delete, copy, get). | ||
| * | ||
| * <p>Instance of this class can not be used again after {@link #shutdown()} method has been called. | ||
| */ | ||
| class BatchExecutor { | ||
|
|
||
| private static final GoogleLogger logger = GoogleLogger.forEnclosingClass(); | ||
|
|
||
| private final ExecutorService requestsExecutor; | ||
|
|
||
| private final Queue<Future<Void>> responseFutures = new ConcurrentLinkedQueue<>(); | ||
|
|
||
| public BatchExecutor(int numThreads) { | ||
| this.requestsExecutor = | ||
| numThreads == 0 ? newDirectExecutorService() : newRequestExecutor(numThreads); | ||
| } | ||
|
|
||
| private static ExecutorService newRequestExecutor(int numThreads) { | ||
| ThreadPoolExecutor executor = | ||
| new ThreadPoolExecutor( | ||
| /* corePoolSize= */ numThreads, | ||
| /* maximumPoolSize= */ numThreads, | ||
| /* keepAliveTime= */ 10L, | ||
| TimeUnit.SECONDS, | ||
| new LinkedBlockingQueue<>(numThreads * 20), | ||
| new ThreadFactoryBuilder() | ||
| .setNameFormat("gcs-grpc-manual-batching-pool-%d") | ||
| .setDaemon(true) | ||
| .build()); | ||
| executor.allowCoreThreadTimeOut(true); | ||
| executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy()); | ||
| return executor; | ||
| } | ||
|
|
||
| /** Adds a task to the execution queue. */ | ||
| public <T> void queue(Callable<T> task, FutureCallback<T> callback) { | ||
| checkState( | ||
| !requestsExecutor.isShutdown() && !requestsExecutor.isTerminated(), | ||
| "requestExecutor should not be terminated to queue request"); | ||
|
|
||
| responseFutures.add( | ||
| requestsExecutor.submit( | ||
| () -> { | ||
| execute(task, callback); | ||
| return null; | ||
| })); | ||
| } | ||
|
|
||
| private static <T> void execute(Callable<T> task, FutureCallback<T> callback) { | ||
| try { | ||
| T result = task.call(); | ||
| callback.onSuccess(result); | ||
| } catch (Throwable throwable) { | ||
| callback.onFailure(throwable); | ||
| } | ||
| } | ||
|
|
||
| /** Awaits until all tasks are terminated and then shutdowns the executor. */ | ||
| public void shutdown() throws IOException { | ||
| awaitRequestsCompletion(); | ||
| try { | ||
| checkState(responseFutures.isEmpty(), "responseFutures should be empty after flush"); | ||
| } finally { | ||
| requestsExecutor.shutdown(); | ||
| try { | ||
| if (!requestsExecutor.awaitTermination(1, TimeUnit.SECONDS)) { | ||
| logger.atWarning().log("Forcibly shutting down grpc manual batching thread pool."); | ||
| requestsExecutor.shutdownNow(); | ||
| } | ||
| } catch (InterruptedException e) { | ||
| Thread.currentThread().interrupt(); | ||
| logger.atFine().withCause(e).log( | ||
| "Failed to await termination: forcibly shutting down grpc manual batching thread pool."); | ||
| requestsExecutor.shutdownNow(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** Awaits until all sent requests are completed. Should be serialized */ | ||
| private void awaitRequestsCompletion() throws IOException { | ||
| while (!responseFutures.isEmpty()) { | ||
| getFromFuture(responseFutures.remove()); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
gcsio/src/test/java/com/google/cloud/hadoop/gcsio/BatchExecutorTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /* | ||
| * Copyright 2023 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.hadoop.gcsio; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static org.junit.Assert.assertThrows; | ||
|
|
||
| import com.google.common.util.concurrent.FutureCallback; | ||
| import java.io.IOException; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| /** Unit tests for {@link BatchExecutor}. */ | ||
| @RunWith(JUnit4.class) | ||
| public class BatchExecutorTest { | ||
|
|
||
| private BatchExecutor batchExecutor; | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| batchExecutor = new BatchExecutor(10); | ||
| } | ||
|
|
||
| @Test | ||
| public void queue_succeeds() { | ||
| batchExecutor.queue(() -> true, /* callback*/ assertCallBack()); | ||
| } | ||
|
|
||
| @Test | ||
| public void queue_throwsException_afterShutdownCalled() throws IOException { | ||
| batchExecutor.shutdown(); | ||
|
|
||
| IllegalStateException e = | ||
| assertThrows(IllegalStateException.class, () -> batchExecutor.queue(() -> null, null)); | ||
|
|
||
| assertThat(e) | ||
| .hasMessageThat() | ||
| .startsWith("requestExecutor should not be terminated to queue request"); | ||
| } | ||
|
|
||
| private FutureCallback<Boolean> assertCallBack() { | ||
| return new FutureCallback<>() { | ||
| @Override | ||
| public void onSuccess(Boolean result) { | ||
| assertThat(result).isEqualTo(true); | ||
| } | ||
|
|
||
| @Override | ||
| public void onFailure(Throwable throwable) {} | ||
| }; | ||
| } | ||
| } |
Oops, something went wrong.