com.alibaba.nacos.shaded.io.grpc.util.HealthProducerHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nacos-client Show documentation
Nacos client pom.xml file
There is a newer version: 2.4.2
/*
 * Copyright 2023 The gRPC Authors
 *
 * 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.alibaba.nacos.shaded.io.grpc.util;

import static com.alibaba.nacos.shaded.com.google.common.base.Preconditions.checkNotNull;
import static com.alibaba.nacos.shaded.io.grpc.LoadBalancer.HAS_HEALTH_PRODUCER_LISTENER_KEY;
import static com.alibaba.nacos.shaded.io.grpc.LoadBalancer.HEALTH_CONSUMER_LISTENER_ARG_KEY;

import com.alibaba.nacos.shaded.com.google.common.annotations.VisibleForTesting;
import com.alibaba.nacos.shaded.io.grpc.Attributes;
import com.alibaba.nacos.shaded.io.grpc.ConnectivityStateInfo;
import com.alibaba.nacos.shaded.io.grpc.Internal;
import com.alibaba.nacos.shaded.io.grpc.LoadBalancer;

/**
 * A new {@link com.alibaba.nacos.shaded.io.grpc.LoadBalancer.Helper} used by health producer systems to build health
 * notification chain, via {@link com.alibaba.nacos.shaded.io.grpc.LoadBalancer.CreateSubchannelArgs}.
 * The leaf health consumer is pick first. Each health producer uses this helper.
 * The health producers should make state listener a pass-through and manipulate the
 * {@link com.alibaba.nacos.shaded.io.grpc.LoadBalancer.CreateSubchannelArgs} for health notifications.
 * The helper detects health listener parent. The root health producer in the chain will fan out
 * the subchannel state change to both state listener and health listener.
 *
 * Example usage:
 * 
{@code
 * class HealthProducerLB {
 *   private final LoadBalancer.Helper helper;
 *   public HealthProducer(Helper helper) {
 *     this.helper = new MyHelper(HealthCheckUtil.HealthCheckHelper(helper));
 *   }
 *   class MyHelper implements LoadBalancer.Helper {
 *     public void createSubchannel(CreateSubchannelArgs args) {
 *       SubchannelStateListener originalListener =
 *         args.getAttributes(HEALTH_CHECK_CONSUMER_LISTENER);
 *       if (hcListener != null) {
 *         // Implement a health listener that producers health check information.
 *         SubchannelStateListener myListener = MyHealthListener(originalListener);
 *         args = args.toBuilder.setOption(HEALTH_CHECK_CONSUMER_LISTENER, myListener);
 *       }
 *       return super.createSubchannel(args);
 *     }
 *   }
 *  }
 * }
 */
@Internal
public final class HealthProducerHelper extends ForwardingLoadBalancerHelper {

  private final LoadBalancer.Helper delegate;

  public HealthProducerHelper(LoadBalancer.Helper helper) {
    this.delegate = checkNotNull(helper, "helper");
  }

  @Override
  public LoadBalancer.Subchannel createSubchannel(LoadBalancer.CreateSubchannelArgs args) {
    LoadBalancer.SubchannelStateListener healthConsumerListener =
        args.getOption(HEALTH_CONSUMER_LISTENER_ARG_KEY);
    LoadBalancer.Subchannel delegateSubchannel = super.createSubchannel(args);
    boolean alreadyParent = healthConsumerListener != null
        && delegateSubchannel.getAttributes().get(HAS_HEALTH_PRODUCER_LISTENER_KEY) == null;
    if (!alreadyParent) {
      return delegateSubchannel;
    }
    return new HealthProducerSubchannel(delegateSubchannel, healthConsumerListener);
  }

  @Override
  protected LoadBalancer.Helper delegate() {
    return delegate;
  }

  // The parent subchannel in the health check producer LB chain. It duplicates subchannel state to
  // both the state listener and health listener.
  @VisibleForTesting
  static final class HealthProducerSubchannel extends ForwardingSubchannel {
    private final LoadBalancer.Subchannel delegate;
    private final LoadBalancer.SubchannelStateListener healthListener;

    HealthProducerSubchannel(LoadBalancer.Subchannel delegate,
                             LoadBalancer.SubchannelStateListener healthListener) {
      this.delegate = checkNotNull(delegate, "delegate");
      this.healthListener = checkNotNull(healthListener, "healthListener");
    }

    @Override
    public LoadBalancer.Subchannel delegate() {
      return delegate;
    }

    @Override
    public void start(LoadBalancer.SubchannelStateListener listener) {
      delegate.start(new LoadBalancer.SubchannelStateListener() {
        @Override
        public void onSubchannelState(ConnectivityStateInfo newState) {
          listener.onSubchannelState(newState);
          healthListener.onSubchannelState(newState);
        }
      });
    }

    @Override
    public Attributes getAttributes() {
      return super.getAttributes().toBuilder().set(HAS_HEALTH_PRODUCER_LISTENER_KEY, Boolean.TRUE)
            .build();
    }
  }
}