-
Notifications
You must be signed in to change notification settings - Fork 70
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.
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
feat: update GrpcBlobReadChannel to allow seek/limit after read #1834
Merged
+293
−313
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
149 changes: 149 additions & 0 deletions
149
google-cloud-storage/src/main/java/com/google/cloud/storage/BaseStorageReadChannel.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,149 @@ | ||
| /* | ||
| * 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.storage; | ||
|
|
||
| import static com.google.cloud.storage.ByteSizeConstants._2MiB; | ||
| import static java.util.Objects.requireNonNull; | ||
|
|
||
| import com.google.cloud.storage.BufferedReadableByteChannelSession.BufferedReadableByteChannel; | ||
| import java.io.IOException; | ||
| import java.nio.ByteBuffer; | ||
| import org.checkerframework.checker.nullness.qual.Nullable; | ||
|
|
||
| abstract class BaseStorageReadChannel<T> implements StorageReadChannel { | ||
|
|
||
| private ByteRangeSpec byteRangeSpec; | ||
| private int chunkSize = _2MiB; | ||
| private BufferHandle bufferHandle; | ||
| private LazyReadChannel<T> lazyReadChannel; | ||
|
|
||
| @Nullable private T resolvedObject; | ||
|
|
||
| protected BaseStorageReadChannel() { | ||
| this.byteRangeSpec = ByteRangeSpec.nullRange(); | ||
| } | ||
|
|
||
| @Override | ||
| public final synchronized void setChunkSize(int chunkSize) { | ||
| StorageException.wrapIOException(() -> maybeResetChannel(true)); | ||
| this.chunkSize = chunkSize; | ||
| } | ||
|
|
||
| @Override | ||
| public final synchronized boolean isOpen() { | ||
| if (lazyReadChannel == null) { | ||
| return true; | ||
| } else { | ||
| LazyReadChannel<T> tmp = internalGetLazyChannel(); | ||
| return tmp.isOpen(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public final synchronized void close() { | ||
| if (internalGetLazyChannel().isOpen()) { | ||
| StorageException.wrapIOException(internalGetLazyChannel().getChannel()::close); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public final synchronized StorageReadChannel setByteRangeSpec(ByteRangeSpec byteRangeSpec) { | ||
| requireNonNull(byteRangeSpec, "byteRangeSpec must be non null"); | ||
| StorageException.wrapIOException(() -> maybeResetChannel(false)); | ||
| this.byteRangeSpec = byteRangeSpec; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public final ByteRangeSpec getByteRangeSpec() { | ||
| return byteRangeSpec; | ||
| } | ||
|
|
||
| @Override | ||
| public final synchronized int read(ByteBuffer dst) throws IOException { | ||
| long diff = byteRangeSpec.length(); | ||
| if (diff <= 0) { | ||
| close(); | ||
| return -1; | ||
| } | ||
| try { | ||
| int read = internalGetLazyChannel().getChannel().read(dst); | ||
| if (read != -1) { | ||
| byteRangeSpec = byteRangeSpec.withShiftBeginOffset(read); | ||
| } else { | ||
| close(); | ||
| } | ||
| return read; | ||
| } catch (StorageException e) { | ||
| if (e.getCode() == 416) { | ||
| // HttpStorageRpc turns 416 into a null etag with an empty byte array, leading | ||
| // BlobReadChannel to believe it read 0 bytes, returning -1 and leaving the channel open. | ||
| // Emulate that same behavior here to preserve behavior compatibility, though this should | ||
| // be removed in the next major version. | ||
| return -1; | ||
| } else { | ||
| throw new IOException(e); | ||
| } | ||
| } catch (IOException e) { | ||
| throw e; | ||
| } catch (Exception e) { | ||
| throw new IOException(StorageException.coalesce(e)); | ||
| } | ||
| } | ||
|
|
||
| protected final BufferHandle getBufferHandle() { | ||
| if (bufferHandle == null) { | ||
| bufferHandle = BufferHandle.allocate(chunkSize); | ||
| } | ||
| return bufferHandle; | ||
| } | ||
|
|
||
| protected final int getChunkSize() { | ||
| return chunkSize; | ||
| } | ||
|
|
||
| @Nullable | ||
| protected T getResolvedObject() { | ||
| return resolvedObject; | ||
| } | ||
|
|
||
| protected void setResolvedObject(@Nullable T resolvedObject) { | ||
| this.resolvedObject = resolvedObject; | ||
| } | ||
|
|
||
| protected abstract LazyReadChannel<T> newLazyReadChannel(); | ||
|
|
||
| private void maybeResetChannel(boolean freeBuffer) throws IOException { | ||
| if (lazyReadChannel != null && lazyReadChannel.isOpen()) { | ||
| try (BufferedReadableByteChannel ignore = lazyReadChannel.getChannel()) { | ||
| if (bufferHandle != null && !freeBuffer) { | ||
| bufferHandle.get().clear(); | ||
| } else if (freeBuffer) { | ||
| bufferHandle = null; | ||
| } | ||
| lazyReadChannel = null; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private LazyReadChannel<T> internalGetLazyChannel() { | ||
| if (lazyReadChannel == null) { | ||
| lazyReadChannel = newLazyReadChannel(); | ||
| } | ||
| return lazyReadChannel; | ||
| } | ||
| } | ||
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is broad; is there a specific set of Exception types that are expected?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For grpc, the scope is more narrow, but for JSON there isn't really a common base since things can be socket issues, ssl issues or any other number of exceptions.
This catch is primarily here to guarantee we're always doing our best to present an actionable exception to whatever is catching.