Bundling restructure #214

michaelbausor · 2017-03-01T18:59:32Z

Updates bundling to accumulate requests in a request builder, rather than a list of requests. The major change is to introduce the Bundle interface and the BundleImpl class, which replaces a list of BundlingContext objects.

codecov-io · 2017-03-01T19:04:30Z

Codecov Report

Merging #214 into master will increase coverage by 0.23%.
The diff coverage is 94.17%.

@@             Coverage Diff              @@
##             master     #214      +/-   ##
============================================
+ Coverage     70.25%   70.48%   +0.23%     
- Complexity      483      490       +7     
============================================
  Files            67       68       +1     
  Lines          2538     2558      +20     
  Branches        266      264       -2     
============================================
+ Hits           1783     1803      +20     
+ Misses          657      656       -1     
- Partials         98       99       +1

Impacted Files	Coverage Δ	Complexity Δ
...e/api/gax/bundling/AccumulatingBundleReceiver.java	`83.33% <100%> (ø)`	`3 <1> (ø)`	❌
.../com/google/api/gax/bundling/ThresholdBundler.java	`96.55% <100%> (-0.03%)`	`27 <0> (-1)`
...n/java/com/google/api/gax/grpc/BundleExecutor.java	`100% <100%> (ø)`	`4 <1> (-2)`	❌
...java/com/google/api/gax/grpc/BundlingCallable.java	`88.88% <100%> (ø)`	`3 <0> (ø)`	❌
.../com/google/api/gax/grpc/BundledRequestIssuer.java	`78.94% <75%> (ø)`	`6 <2> (?)`
...e/api/gax/bundling/ThresholdBundlingForwarder.java	`87.5% <83.33%> (ø)`	`4 <0> (ø)`	❌
...n/java/com/google/api/gax/grpc/BundlerFactory.java	`81.25% <83.33%> (+0.92%)`	`12 <9> (+1)`	✅
.../main/java/com/google/api/gax/grpc/BundleImpl.java	`96.66% <96.66%> (ø)`	`10 <10> (?)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ec2e656...d449bf3. Read the comment docs.

pongad

I have a few comments but looks good in general.

I earlier sent a WIP PR to change ThresholdBundlingForwarder from pulling to pushing logic. With this change, that PR becomes much less important. I still think it's valuable because it lets us avoid manual thread-synchronization. If we want the change, I think it should land after this change but before more work on logging flush. WDYT?

src/main/java/com/google/api/gax/bundling/Bundle.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016, Google Inc. All rights reserved.
+ * Copyright 2017, Google Inc. All rights reserved.


src/main/java/com/google/api/gax/bundling/BundleFactory.java

+package com.google.api.gax.bundling;
+
+public interface BundleFactory<T> {
+  T createBundle();


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java


  private final Lock lock = new ReentrantLock();
  private final Condition bundleCondition = lock.newCondition();
-  private Bundle currentOpenBundle;
-  private List<Bundle> closedBundles = new ArrayList<>();
+  private TrackedBundle currentOpenTrackedBundle;


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java

    final Lock lock = this.lock;
    lock.lock();
    try {
-      Bundle outBundle = null;
+      E outBundle = null;
      if (closedBundles.size() > 0) {
        outBundle = closedBundles.remove(0);


michaelbausor

I agree that we still want the change to a pushing bundler, and that it makes sense to do it before any more work on logging flush.

src/main/java/com/google/api/gax/bundling/Bundle.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016, Google Inc. All rights reserved.
+ * Copyright 2017, Google Inc. All rights reserved.


src/main/java/com/google/api/gax/bundling/BundleFactory.java

+package com.google.api.gax.bundling;
+
+public interface BundleFactory<T> {
+  T createBundle();


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java

    final Lock lock = this.lock;
    lock.lock();
    try {
-      Bundle outBundle = null;
+      E outBundle = null;
      if (closedBundles.size() > 0) {
        outBundle = closedBundles.remove(0);


src/main/java/com/google/api/gax/bundling/Bundle.java

-   */
-  void setResponse(ResponseT response);
+public interface Bundle<T> {
+  void merge(T t);


src/main/java/com/google/api/gax/bundling/ThresholdBundleReceiver.java

-   */
-  void processBundle(List<T> bundle);
+  /** Process the given bundle. */
+  void processBundle(T bundle);


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java

-   * referenced is still the active one.
-   */
-  private class Bundle {
+  private class TrackedBundle {


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java


  private final Lock lock = new ReentrantLock();
  private final Condition bundleCondition = lock.newCondition();
-  private Bundle currentOpenBundle;
-  private List<Bundle> closedBundles = new ArrayList<>();
+  private TrackedBundle currentOpenTrackedBundle;


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java


  private ImmutableList<BundlingThreshold<E>> thresholdPrototypes;
  private final Duration maxDelay;
  private final BundlingFlowController<E> flowController;
+  private final BundleSupplier<E> bundleFactory;


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java

@@ -182,56 +189,48 @@ public void flush() {
   *
   * @return the number of items added to 'bundle'.
   */
-  public int drainNextBundleTo(Collection<? super E> outputCollection) {
+  public E takeBundle() {


src/main/java/com/google/api/gax/grpc/BundleImpl.java

+import java.util.ArrayList;
+import java.util.List;
+
+public class BundleImpl<RequestT, ResponseT> implements Bundle<BundleImpl<RequestT, ResponseT>> {


michaelbausor

Addressed PR feedback. I have pushed here to help the review process, but I will be closing this PR and reopening against https://github.com/googleapis/gax-java/tree/bundling-flowcontrol-branch

src/main/java/com/google/api/gax/bundling/Bundle.java

-   */
-  void setResponse(ResponseT response);
+public interface Bundle<T> {
+  void merge(T t);


src/main/java/com/google/api/gax/bundling/ThresholdBundleReceiver.java

-   */
-  void processBundle(List<T> bundle);
+  /** Process the given bundle. */
+  void processBundle(T bundle);


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java


  private ImmutableList<BundlingThreshold<E>> thresholdPrototypes;
  private final Duration maxDelay;
  private final BundlingFlowController<E> flowController;
+  private final BundleSupplier<E> bundleFactory;


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java


  private final Lock lock = new ReentrantLock();
  private final Condition bundleCondition = lock.newCondition();
-  private Bundle currentOpenBundle;
-  private List<Bundle> closedBundles = new ArrayList<>();
+  private TrackedBundle currentOpenTrackedBundle;


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java

@@ -182,56 +189,48 @@ public void flush() {
   *
   * @return the number of items added to 'bundle'.
   */
-  public int drainNextBundleTo(Collection<? super E> outputCollection) {
+  public E takeBundle() {


src/main/java/com/google/api/gax/bundling/ThresholdBundler.java

-   * referenced is still the active one.
-   */
-  private class Bundle {
+  private class TrackedBundle {


src/main/java/com/google/api/gax/grpc/BundleImpl.java

+import java.util.ArrayList;
+import java.util.List;
+
+public class BundleImpl<RequestT, ResponseT> implements Bundle<BundleImpl<RequestT, ResponseT>> {


michaelbausor · 2017-03-04T00:53:41Z

Replacement PR: #226

michaelbausor added 4 commits March 1, 2017 09:29

Start updating bundling

a3a49e5

Initial commit to restructure to reduce memory consumption

6499837

Add request builder to bundling descriptor

60c3480

Update closed bundles, remove unused

ba01724

michaelbausor requested review from pongad and garrettjonesgoogle March 1, 2017 18:59

michaelbausor mentioned this pull request Mar 1, 2017

Large memory usage by gcloud-logging API. googleapis/google-cloud-java#1449

Closed

pongad reviewed Mar 2, 2017

View reviewed changes

Address PR feedback

bc02b61

michaelbausor commented Mar 2, 2017

View reviewed changes

garrettjonesgoogle reviewed Mar 3, 2017

View reviewed changes

michaelbausor mentioned this pull request Mar 3, 2017

WIP: Bundling restructure googleapis/gapic-generator#1087

Closed

michaelbausor added 2 commits March 2, 2017 17:09

WIP commit - address PR feedback

09716b2

Address PR feedback

d449bf3

michaelbausor commented Mar 3, 2017

View reviewed changes

michaelbausor mentioned this pull request Mar 4, 2017

Bundling restructure #226

Merged

michaelbausor closed this Mar 5, 2017

Bundling restructure #214

Bundling restructure #214

Conversation

michaelbausor commented Mar 1, 2017

codecov-io commented Mar 1, 2017 • edited Loading

Codecov Report

pongad left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

michaelbausor left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

michaelbausor left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

michaelbausor commented Mar 4, 2017

codecov-io commented Mar 1, 2017 •

edited

Loading