Skip to content

feat(pubsub): implement HedgeSettings and integrate with Publisher#13735

Open
tonyyyycui wants to merge 7 commits into
googleapis:mainfrom
tonyyyycui:publish-hedging-settings
Open

feat(pubsub): implement HedgeSettings and integrate with Publisher#13735
tonyyyycui wants to merge 7 commits into
googleapis:mainfrom
tonyyyycui:publish-hedging-settings

Conversation

@tonyyyycui

Copy link
Copy Markdown

This PR implements a data class hedgeSettings and a method class hedgeTokenBucket used for publish hedging functionality. Publisher is modified to integrate the new hedgeSettings class.

Within hedgeSettings, hedgeDelay is a user-configurable field used to represent the duration (in ms) before a hedged publish request is sent. All other fields are abstracted away from the user.

The hedgeTokenBucket class implements a token-based method to throttle the number of hedged publish requests on the client side.

@tonyyyycui tonyyyycui requested review from a team as code owners July 13, 2026 17:31

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a hedging mechanism for the Pub/Sub Publisher, adding HedgeSettings for configuration and a thread-safe HedgeTokenBucket to limit hedged requests. The feedback suggests replacing the synchronized methods in HedgeTokenBucket with explicit ReentrantLock to reduce lock contention and improve performance on the critical path.

Comment on lines +19 to +64
import com.google.common.annotations.VisibleForTesting;
import javax.annotation.concurrent.GuardedBy;

/** Token bucket for limiting hedged requests. Thread-safe. */
final class HedgeTokenBucket {
private final int maxTokens;
private final float refillAmount;

@GuardedBy("this")
private float tokens;

HedgeTokenBucket(HedgeSettings settings) {
this.maxTokens = settings.getMaxTokens();
this.refillAmount = settings.getRefill();
this.tokens = maxTokens;
}

@VisibleForTesting
HedgeTokenBucket(int maxTokens, float refillAmount) {
this.maxTokens = maxTokens;
this.refillAmount = refillAmount;
this.tokens = maxTokens;
}

/**
* Attempts to acquire a token for a hedged request.
*
* @return {@code true} if a token was acquired, {@code false} otherwise.
*/
synchronized boolean tryAcquire() {
if (tokens >= 1.0f) {
tokens -= 1.0f;
return true;
}
return false;
}

/** Refills the bucket by the configured refill amount, capped at max tokens. */
synchronized void refill() {
tokens = Math.min(maxTokens, tokens + refillAmount);
}

@VisibleForTesting
synchronized float getTokens() {
return tokens;
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

In performance-sensitive code like the Pub/Sub Publisher, using synchronized methods on the critical path can introduce significant lock contention and performance overhead. To protect shared state while ensuring thread safety and visibility, prefer using explicit locks (such as ReentrantLock) over the synchronized keyword.

import com.google.common.annotations.VisibleForTesting;
import java.util.concurrent.locks.ReentrantLock;

/** Token bucket for limiting hedged requests. Thread-safe. */
final class HedgeTokenBucket {
  private final ReentrantLock lock = new ReentrantLock();
  private final int maxTokens;
  private final float refillAmount;
  private float tokens;

  HedgeTokenBucket(HedgeSettings settings) {
    this.maxTokens = settings.getMaxTokens();
    this.refillAmount = settings.getRefill();
    this.tokens = maxTokens;
  }

  @VisibleForTesting
  HedgeTokenBucket(int maxTokens, float refillAmount) {
    this.maxTokens = maxTokens;
    this.refillAmount = refillAmount;
    this.tokens = maxTokens;
  }

  /**
   * Attempts to acquire a token for a hedged request.
   *
   * @return {@code true} if a token was acquired, {@code false} otherwise.
   */
  boolean tryAcquire() {
    lock.lock();
    try {
      if (tokens < 1.0f) {
        return false;
      }
      tokens -= 1.0f;
      return true;
    } finally {
      lock.unlock();
    }
  }

  /** Refills the bucket by the configured refill amount, capped at max tokens. */
  void refill() {
    lock.lock();
    try {
      tokens = Math.min((float) maxTokens, tokens + refillAmount);
    } finally {
      lock.unlock();
    }
  }

  @VisibleForTesting
  float getTokens() {
    lock.lock();
    try {
      return tokens;
    } finally {
      lock.unlock();
    }
  }
References
  1. In performance-sensitive code, prefer using explicit locks over the 'synchronized' keyword to protect shared state while ensuring thread safety and visibility.

@tonyyyycui tonyyyycui changed the title Add HedgeSettings and integrate with publisher for token operations feat(pubsub): add HedgeSettings and integrate with Publisher Jul 13, 2026
@tonyyyycui tonyyyycui changed the title feat(pubsub): add HedgeSettings and integrate with Publisher feat(pubsub): implement HedgeSettings and integrate with Publisher Jul 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant