chore: encapsulate BlobDescriptorState

Author: BenWhitehead

google-cloud-storage/src/main/java/com/google/cloud/storage/BlobDescriptorImpl.java

@@ -28,24 +28,18 @@
 import com.google.cloud.storage.ResponseContentLifecycleHandle.ChildRef;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.protobuf.ByteString;
-import com.google.storage.v2.BidiReadHandle;
 import com.google.storage.v2.BidiReadObjectRequest;
 import com.google.storage.v2.BidiReadObjectResponse;
-import com.google.storage.v2.Object;
 import com.google.storage.v2.ObjectRangeData;
 import com.google.storage.v2.ReadRange;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
-import java.util.Map;
-import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Executor;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
-import java.util.concurrent.atomic.AtomicLong;
-import java.util.concurrent.atomic.AtomicReference;
 
 final class BlobDescriptorImpl implements BlobDescriptor {
 
@@ -56,18 +50,18 @@ final class BlobDescriptorImpl implements BlobDescriptor {
   private BlobDescriptorImpl(BlobDescriptorStream stream, BlobDescriptorState state) {
     this.stream = stream;
     this.state = state;
-    this.info = Conversions.grpc().blobInfo().decode(state.metadata.get());
+    this.info = Conversions.grpc().blobInfo().decode(state.getMetadata());
   }
 
   @Override
   public ApiFuture<byte[]> readRangeAsBytes(ByteRangeSpec range) {
-    long readId = state.readIdSeq.getAndIncrement();
+    long readId = state.newReadId();
     SettableApiFuture<byte[]> future = SettableApiFuture.create();
     OutstandingReadToArray value =
         new OutstandingReadToArray(readId, range.beginOffset(), range.length(), future);
     BidiReadObjectRequest request =
         BidiReadObjectRequest.newBuilder().addReadRanges(value.makeReadRange()).build();
-    state.outstandingReads.put(readId, value);
+    state.putOutstandingRead(readId, value);
     stream.send(request);
     return future;
   }
@@ -248,10 +242,10 @@ protected void onResponseImpl(BidiReadObjectResponse response) {
       try (ResponseContentLifecycleHandle<BidiReadObjectResponse> handle =
           bidiResponseContentLifecycleManager.get(response)) {
         if (response.hasMetadata()) {
-          state.metadata.set(response.getMetadata());
+          state.setMetadata(response.getMetadata());
         }
         if (response.hasReadHandle()) {
-          state.ref.set(response.getReadHandle());
+          state.setBidiReadHandle(response.getReadHandle());
         }
         List<ObjectRangeData> rangeData = response.getObjectDataRangesList();
         if (rangeData.isEmpty()) {
@@ -260,7 +254,7 @@ protected void onResponseImpl(BidiReadObjectResponse response) {
         for (int i = 0; i < rangeData.size(); i++) {
           ObjectRangeData d = rangeData.get(i);
           long id = d.getReadRange().getReadId();
-          OutstandingReadToArray read = state.outstandingReads.get(id);
+          OutstandingReadToArray read = state.getOutstandingRead(id);
           if (read == null) {
             continue;
           }
@@ -277,7 +271,7 @@ protected void onResponseImpl(BidiReadObjectResponse response) {
                   try {
                     read.eof();
                     // don't remove the outstanding read until the future has been resolved
-                    state.outstandingReads.remove(id);
+                    state.removeOutstandingRead(id);
                   } catch (IOException e) {
                     // TODO: sync this up with stream restarts when the time comes
                     throw StorageException.coalesce(e);
@@ -340,20 +334,4 @@ public ReadRange makeReadRange() {
           .build();
     }
   }
-
-  private static final class BlobDescriptorState {
-    private final BidiReadObjectRequest openRequest;
-    private final AtomicReference<BidiReadHandle> ref;
-    private final AtomicReference<Object> metadata;
-    private final AtomicLong readIdSeq;
-    private final Map<Long, OutstandingReadToArray> outstandingReads;
-
-    public BlobDescriptorState(BidiReadObjectRequest openRequest) {
-      this.openRequest = openRequest;
-      this.ref = new AtomicReference<>();
-      this.metadata = new AtomicReference<>();
-      this.readIdSeq = new AtomicLong(1);
-      this.outstandingReads = new ConcurrentHashMap<>();
-    }
-  }
 }

google-cloud-storage/src/main/java/com/google/cloud/storage/BlobDescriptorState.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2024 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 com.google.cloud.storage.BlobDescriptorImpl.OutstandingReadToArray;
+import com.google.storage.v2.BidiReadHandle;
+import com.google.storage.v2.BidiReadObjectRequest;
+import com.google.storage.v2.Object;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.atomic.AtomicLong;
+import java.util.concurrent.atomic.AtomicReference;
+
+final class BlobDescriptorState {
+
+  private final BidiReadObjectRequest openRequest;
+  private final AtomicReference<BidiReadHandle> bidiReadHandle;
+  private final AtomicReference<Object> metadata;
+  private final AtomicLong readIdSeq;
+  private final Map<Long, OutstandingReadToArray> outstandingReads;
+
+  BlobDescriptorState(BidiReadObjectRequest openRequest) {
+    this.openRequest = openRequest;
+    this.bidiReadHandle = new AtomicReference<>();
+    this.metadata = new AtomicReference<>();
+    this.readIdSeq = new AtomicLong(1);
+    this.outstandingReads = new ConcurrentHashMap<>();
+  }
+
+  BidiReadHandle getBidiReadHandle() {
+    return bidiReadHandle.get();
+  }
+
+  void setBidiReadHandle(BidiReadHandle newValue) {
+    bidiReadHandle.set(newValue);
+  }
+
+  Object getMetadata() {
+    return metadata.get();
+  }
+
+  void setMetadata(Object metadata) {
+    this.metadata.set(metadata);
+  }
+
+  long newReadId() {
+    return readIdSeq.getAndIncrement();
+  }
+
+  OutstandingReadToArray getOutstandingRead(long key) {
+    return outstandingReads.get(key);
+  }
+
+  void putOutstandingRead(long key, OutstandingReadToArray value) {
+    outstandingReads.put(key, value);
+  }
+
+  void removeOutstandingRead(long key) {
+    outstandingReads.remove(key);
+  }
+}