Add bundling flow control #213

michaelbausor · 2017-02-25T00:28:11Z

This is WIP to make sure I am on the right track adding FlowController support to bundling.

One question I had is: at what point (if any) do we want to convert a FlowControlException into an ApiException? Note that if we don't do this, we will end up adding a checked exception (FlowControlException) into the signature of FutureCallable.

garrettjonesgoogle

I don't think we should add a new checked exception into the signature of FutureCallable.

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

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2016, Google Inc. All rights reserved.


pongad

I understand the sentiment of not adding more checked exceptions. Maybe RuntimeException with @throw doc?

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

-        outputCollection.addAll(outBundle.getData());
+        List<E> data = outBundle.getData();
+        outputCollection.addAll(data);
+        if (flowController != null) {


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

@@ -103,6 +103,12 @@
  /** Returns the Boolean object to indicate if the bundling is enabled. Default to true */
  public abstract Boolean getIsEnabled();

+  public abstract Boolean getIsFlowControlEnabled();


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

@@ -155,6 +161,12 @@ public Builder setRequestByteThreshold(Integer requestByteThreshold) {
     */
    public abstract Builder setIsEnabled(Boolean enabled);

+    public abstract Builder setIsFlowControlEnabled(Boolean enabled);
+
+    public abstract Builder setFailOnFlowControlLimits(Boolean failOnFlowControlLimits);


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

+package com.google.api.gax.bundling;
+
+import com.google.api.gax.grpc.FlowController;
+import com.google.api.gax.grpc.FlowController.FlowControlException;


michaelbausor

PTAL. More work to come before complete.

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

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2016, Google Inc. All rights reserved.


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

+package com.google.api.gax.bundling;
+
+import com.google.api.gax.grpc.FlowController;
+import com.google.api.gax.grpc.FlowController.FlowControlException;


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

-        outputCollection.addAll(outBundle.getData());
+        List<E> data = outBundle.getData();
+        outputCollection.addAll(data);
+        if (flowController != null) {


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

@@ -155,6 +161,12 @@ public Builder setRequestByteThreshold(Integer requestByteThreshold) {
     */
    public abstract Builder setIsEnabled(Boolean enabled);

+    public abstract Builder setIsFlowControlEnabled(Boolean enabled);
+
+    public abstract Builder setFailOnFlowControlLimits(Boolean failOnFlowControlLimits);


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

@@ -103,6 +103,12 @@
  /** Returns the Boolean object to indicate if the bundling is enabled. Default to true */
  public abstract Boolean getIsEnabled();

+  public abstract Boolean getIsFlowControlEnabled();


- Move FlowController into core - Move BundlingSettings in bundling - Address other PR feedback

michaelbausor · 2017-02-27T19:45:27Z

Do you have a preference for (a) a new FlowControlRuntimeException type? Or (b) use ApiException, with status code UNKNOWN. My initial thought was to use ApiException, but it seems that we are not using ApiException except in cases where it is the remote call that has failed.

garrettjonesgoogle

Who is "you" here? As for me, I think I'd to have the bundling code throw FlowControlRuntimeException, and limit the usage of ApiException to the callable classes. I think the question of whether FlowControlRuntimeException is wrapped in ApiException when thrown from the callable classes depends on whether users can take specific action to recover from FlowControlRuntimeException or not.

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

@@ -103,6 +104,10 @@
  /** Returns the Boolean object to indicate if the bundling is enabled. Default to true */
  public abstract Boolean getIsEnabled();

+  /** Get the flow control settings to use. */
+  @Nullable
+  public abstract FlowControlSettings getFlowControlSettings();


src/main/java/com/google/api/gax/core/FlowControlSettings.java

+   * Control whether the FlowController will fail with an exception or block the thread when flow
+   * control limits are exceeded.
+   */
+  public abstract boolean getShouldFailOnFlowControlLimits();


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

-     * Build the ThresholdBundler.
-     */
+    /** Set the flow controller for the ThresholdBundler. */
+    public Builder<E> setFlowControler(BundlingFlowController<E> flowController) {


Also address PR feedback

michaelbausor · 2017-02-28T00:00:05Z

"You" is @garrettjonesgoogle and @pongad

Updated to address feedback and add tests and runtime exception, PTAL

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

@@ -129,11 +129,14 @@ private Builder() {
   *
   * @throws FlowControlException
   */
-  public void add(E e) throws FlowControlException {
+  public synchronized void add(E e) throws FlowControlException {


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

+    flowController.reserve(e);
+    // We need to reserve resources from flowController outside the lock, but we also need to
+    // prevent concurrent calls to add(E e) from all reserving flowController resources and then
+    // waiting to acquire the lock, so this method is marked as synchronized.


src/main/java/com/google/api/gax/core/FlowControlSettings.java

-    return new AutoValue_FlowControlSettings.Builder().setIsEnabled(true);
+    return new AutoValue_FlowControlSettings.Builder()
+        .setIsEnabled(true)
+        .setExceedLimitBehavior(LimitExceededBehavior.ThrowException);


michaelbausor

PTAL

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

+    flowController.reserve(e);
+    // We need to reserve resources from flowController outside the lock, but we also need to
+    // prevent concurrent calls to add(E e) from all reserving flowController resources and then
+    // waiting to acquire the lock, so this method is marked as synchronized.


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

@@ -129,11 +129,14 @@ private Builder() {
   *
   * @throws FlowControlException
   */
-  public void add(E e) throws FlowControlException {
+  public synchronized void add(E e) throws FlowControlException {


src/main/java/com/google/api/gax/core/FlowControlSettings.java

-    return new AutoValue_FlowControlSettings.Builder().setIsEnabled(true);
+    return new AutoValue_FlowControlSettings.Builder()
+        .setIsEnabled(true)
+        .setExceedLimitBehavior(LimitExceededBehavior.ThrowException);


codecov-io · 2017-02-28T01:37:03Z

Codecov Report

Merging #213 into master will increase coverage by 0.44%.
The diff coverage is 89.15%.

@@             Coverage Diff              @@
##             master     #213      +/-   ##
============================================
+ Coverage      69.9%   70.35%   +0.44%     
- Complexity      475      484       +9     
============================================
  Files            66       67       +1     
  Lines          2479     2540      +61     
  Branches        262      268       +6     
============================================
+ Hits           1733     1787      +54     
- Misses          649      655       +6     
- Partials         97       98       +1

Impacted Files	Coverage Δ	Complexity Δ
.../com/google/api/gax/grpc/BundlingCallSettings.java	`78.78% <ø> (ø)`	`3 <0> (ø)`	❌
...in/java/com/google/api/gax/grpc/UnaryCallable.java	`90% <ø> (ø)`	`17 <0> (ø)`	❌
...e/api/gax/bundling/ThresholdBundlingForwarder.java	`87.5% <ø> (+3.12%)`	`4 <0> (ø)`	❌
...oogle/api/gax/bundling/BundlingFlowController.java	`100% <100%> (ø)`	`3 <3> (?)`
...a/com/google/api/gax/core/FlowControlSettings.java	`81.25% <100%> (ø)`	`3 <1> (?)`
.../com/google/api/gax/bundling/BundlingSettings.java	`72.22% <100%> (ø)`	`3 <1> (?)`
.../com/google/api/gax/bundling/ThresholdBundler.java	`96.72% <100%> (+0.39%)`	`28 <4> (+1)`	✅
...java/com/google/api/gax/grpc/BundlingCallable.java	`88.88% <50%> (-11.12%)`	`3 <0> (ø)`
...n/java/com/google/api/gax/core/FlowController.java	`77.96% <68.42%> (ø)`	`17 <17> (?)`
...n/java/com/google/api/gax/grpc/BundlerFactory.java	`83.05% <90%> (+1.41%)`	`11 <1> (+1)`	✅
... and 3 more

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 f049262...d02a888. Read the comment docs.

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

-        currentOpenBundle.start();
-        signalBundleIsReady = true;
-      }
+      flowController.reserve(e);


src/main/java/com/google/api/gax/core/FlowControlSettings.java

@@ -49,12 +49,23 @@ public static FlowControlSettings getDefaultInstance() {
  @Nullable
  public abstract Integer getMaxOutstandingRequestBytes();

+  /** Is flow control enabled. Defaults to true. */
+  public abstract boolean getIsEnabled();


src/main/java/com/google/api/gax/core/FlowController.java

  @Nullable private final Semaphore outstandingElementCount;
  @Nullable private final Semaphore outstandingByteCount;
+  private final boolean flowControlEnabled;


src/main/java/com/google/api/gax/core/FlowControlSettings.java

-    return new AutoValue_FlowControlSettings.Builder();
+    return new AutoValue_FlowControlSettings.Builder()
+        .setIsEnabled(true)
+        .setLimitExceededBehavior(LimitExceededBehavior.ThrowException);


src/main/java/com/google/api/gax/core/FlowControlSettings.java

+   * <p>The expected behavior for each of these values is: ThrowException: the FlowController will
+   * throw a {@link FlowControlException} if any of the limits are exceeded. Block: the reserve()
+   * method of FlowController will block until the quote is available to be reserved. Ignore: all
+   * flow control limits will be ignored; the FlowController is disabled.


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

+        new FlowController(
+            bundlingSettings.getFlowControlSettings() != null
+                ? bundlingSettings.getFlowControlSettings()
+                : FlowControlSettings.newBuilder().setIsEnabled(false).build());


src/main/java/com/google/api/gax/core/FlowControlSettings.java

+   * limits are exceeded.
+   * <li>Block: the reserve() method of FlowController will block until the quote is available to be
+   * reserved.
+   * <li>Ignore: all flow control limits will be ignored; the FlowController is disabled.
   */


michaelbausor · 2017-03-01T00:59:21Z

PTAL

garrettjonesgoogle · 2017-03-01T01:15:34Z

LGTM - @pongad ?

This reverts commit ec2e656.

…is#221)" This reverts commit 47179c0.

WIP: add bundling flow control

5cd3459

michaelbausor assigned pongad and garrettjonesgoogle Feb 25, 2017

garrettjonesgoogle reviewed Feb 25, 2017

View reviewed changes

src/main/java/com/google/api/gax/bundling/BundlingFlowController.java Outdated

@@ -0,0 +1,65 @@

/*

* Copyright 2016, Google Inc. All rights reserved.

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

pongad reviewed Feb 26, 2017

View reviewed changes

garrettjonesgoogle reviewed Feb 27, 2017

View reviewed changes

michaelbausor commented Feb 27, 2017

View reviewed changes

Address PR comments

540984e

- Move FlowController into core - Move BundlingSettings in bundling - Address other PR feedback

garrettjonesgoogle reviewed Feb 27, 2017

View reviewed changes

Add tests, add FlowControllerRuntimeException

343a24a

Also address PR feedback

garrettjonesgoogle reviewed Feb 28, 2017

View reviewed changes

Addressed PR feedback

8e261d7

michaelbausor commented Feb 28, 2017

View reviewed changes

michaelbausor mentioned this pull request Feb 28, 2017

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

Closed

pongad reviewed Feb 28, 2017

View reviewed changes

michaelbausor added 2 commits February 28, 2017 14:59

Update FlowController with Ignore setting, and documentation.

86eef1a

Update documentation, address PR feedback

f1f5422

garrettjonesgoogle reviewed Mar 1, 2017

View reviewed changes

Apply formatting, fix tests

98f2103

garrettjonesgoogle reviewed Mar 1, 2017

View reviewed changes

Fix doc tags

d02a888

michaelbausor changed the title ~~WIP: add bundling flow control~~ Add bundling flow control Mar 1, 2017

pongad approved these changes Mar 1, 2017

View reviewed changes

michaelbausor merged commit ec2e656 into googleapis:master Mar 1, 2017

michaelbausor deleted the bundling-flow-control branch March 1, 2017 16:14

michaelbausor added a commit to michaelbausor/gax-java that referenced this pull request Mar 3, 2017

Revert "Add bundling flow control (googleapis#213)"

ddd8309

This reverts commit ec2e656.

michaelbausor added a commit that referenced this pull request Mar 3, 2017

Revert "Add bundling flow control (#213)" (#221)

47179c0

This reverts commit ec2e656.

michaelbausor added a commit to michaelbausor/gax-java that referenced this pull request Mar 3, 2017

Revert "Revert "Add bundling flow control (googleapis#213)" (googleap…

0a3ced6

…is#221)" This reverts commit 47179c0.

		@@ -0,0 +1,65 @@
		/*
		* Copyright 2016, Google Inc. All rights reserved.

Add bundling flow control #213

Add bundling flow control #213

Conversation

michaelbausor commented Feb 25, 2017

garrettjonesgoogle left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

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.

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.

michaelbausor commented Feb 27, 2017

garrettjonesgoogle 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.

michaelbausor commented Feb 28, 2017

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.

codecov-io commented Feb 28, 2017 • edited Loading

Codecov Report

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 commented Mar 1, 2017

garrettjonesgoogle commented Mar 1, 2017

codecov-io commented Feb 28, 2017 •

edited

Loading