#19429

Committed 17 Aug 2024 03:55PM UTC coverage: 84.501% (+0.02%) from 84.482%

Build # #19429

Build Type

push

github

Committed by

ejona86

Commit Message

util: Remove MultiChildLB.getImmutableChildMap()

No usages actually needed a map nor a copy.

Run Details

33411 of 39539 relevant lines covered (84.5%)

0.85 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.98

/../util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java

/*
 * 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 io.grpc.util;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static io.grpc.ConnectivityState.CONNECTING;
import static io.grpc.ConnectivityState.IDLE;
import static io.grpc.ConnectivityState.READY;
import static io.grpc.ConnectivityState.SHUTDOWN;
import static io.grpc.ConnectivityState.TRANSIENT_FAILURE;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import io.grpc.Attributes;
import io.grpc.ConnectivityState;
import io.grpc.EquivalentAddressGroup;
import io.grpc.Internal;
import io.grpc.LoadBalancer;
import io.grpc.LoadBalancerProvider;
import io.grpc.Status;
import io.grpc.internal.PickFirstLoadBalancerProvider;
import java.net.SocketAddress;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;

/**
 * A base load balancing policy for those policies which has multiple children such as
 * ClusterManager or the petiole policies.  For internal use only.
 */
@Internal
public abstract class MultiChildLoadBalancer extends LoadBalancer {

  private static final Logger logger = Logger.getLogger(MultiChildLoadBalancer.class.getName());
  private final Map<Object, ChildLbState> childLbStates = new LinkedHashMap<>();
  private final Helper helper;
  // Set to true if currently in the process of handling resolved addresses.
  protected boolean resolvingAddresses;

  protected final LoadBalancerProvider pickFirstLbProvider = new PickFirstLoadBalancerProvider();

  protected ConnectivityState currentConnectivityState;


  protected MultiChildLoadBalancer(Helper helper) {
    this.helper = checkNotNull(helper, "helper");
    logger.log(Level.FINE, "Created");
  }

  /**
   * Using the state of all children will calculate the current connectivity state,
   * update fields, generate a picker and then call
   * {@link Helper#updateBalancingState(ConnectivityState, SubchannelPicker)}.
   */
  protected abstract void updateOverallBalancingState();

  /**
   * Override to utilize parsing of the policy configuration or alternative helper/lb generation.
   */
  protected Map<Object, ChildLbState> createChildLbMap(ResolvedAddresses resolvedAddresses) {
    Map<Object, ChildLbState> childLbMap = new HashMap<>();
    List<EquivalentAddressGroup> addresses = resolvedAddresses.getAddresses();
    for (EquivalentAddressGroup eag : addresses) {
      Endpoint endpoint = new Endpoint(eag); // keys need to be just addresses
      ChildLbState existingChildLbState = childLbStates.get(endpoint);
      if (existingChildLbState != null) {
        childLbMap.put(endpoint, existingChildLbState);
      } else {
        childLbMap.put(endpoint, createChildLbState(endpoint, null, resolvedAddresses));
      }
    }
    return childLbMap;
  }

  /**
   * Override to create an instance of a subclass.
   */
  protected ChildLbState createChildLbState(Object key, Object policyConfig,
      ResolvedAddresses resolvedAddresses) {
    return new ChildLbState(key, pickFirstLbProvider, policyConfig);
  }

  /**
   *   Override to completely replace the default logic or to do additional activities.
   */
  @Override
  public Status acceptResolvedAddresses(ResolvedAddresses resolvedAddresses) {
    try {
      resolvingAddresses = true;

      // process resolvedAddresses to update children
      AcceptResolvedAddrRetVal acceptRetVal = acceptResolvedAddressesInternal(resolvedAddresses);
      if (!acceptRetVal.status.isOk()) {
        return acceptRetVal.status;
      }

      // Update the picker and our connectivity state
      updateOverallBalancingState();

      // shutdown removed children
      shutdownRemoved(acceptRetVal.removedChildren);
      return acceptRetVal.status;
    } finally {
      resolvingAddresses = false;
    }
  }

  /**
   * Override this if your keys are not of type Endpoint.
   * @param key Key to identify the ChildLbState
   * @param resolvedAddresses list of addresses which include attributes
   * @param childConfig a load balancing policy config. This field is optional.
   * @return a fully loaded ResolvedAddresses object for the specified key
   */
  protected ResolvedAddresses getChildAddresses(Object key, ResolvedAddresses resolvedAddresses,
      Object childConfig) {
    Endpoint endpointKey;
    if (key instanceof EquivalentAddressGroup) {
      endpointKey = new Endpoint((EquivalentAddressGroup) key);
    } else {
      checkArgument(key instanceof Endpoint, "key is wrong type");
      endpointKey = (Endpoint) key;
    }

    // Retrieve the non-stripped version
    EquivalentAddressGroup eagToUse = null;
    for (EquivalentAddressGroup currEag : resolvedAddresses.getAddresses()) {
      if (endpointKey.equals(new Endpoint(currEag))) {
        eagToUse = currEag;
        break;
      }
    }

    checkNotNull(eagToUse, key + " no longer present in load balancer children");

    return resolvedAddresses.toBuilder()
        .setAddresses(Collections.singletonList(eagToUse))
        .setAttributes(Attributes.newBuilder().set(IS_PETIOLE_POLICY, true).build())
        .setLoadBalancingPolicyConfig(childConfig)
        .build();
  }

  /**
   * Handle the name resolution error.
   *
   * <p/>Override if you need special handling.
   */
  @Override
  public void handleNameResolutionError(Status error) {
    if (currentConnectivityState != READY)  {
      helper.updateBalancingState(
          TRANSIENT_FAILURE, new FixedResultPicker(PickResult.withError(error)));
    }
  }

  @Override
  public void shutdown() {
    logger.log(Level.FINE, "Shutdown");
    for (ChildLbState state : childLbStates.values()) {
      state.shutdown();
    }
    childLbStates.clear();
  }

  /**
   *   This does the work to update the child map and calculate which children have been removed.
   *   You must call {@link #updateOverallBalancingState} to update the picker
   *   and call {@link #shutdownRemoved(List)} to shutdown the endpoints that have been removed.
    */
  protected final AcceptResolvedAddrRetVal acceptResolvedAddressesInternal(
      ResolvedAddresses resolvedAddresses) {
    logger.log(Level.FINE, "Received resolution result: {0}", resolvedAddresses);

    // Subclass handles any special manipulation to create appropriate types of keyed ChildLbStates
    Map<Object, ChildLbState> newChildren = createChildLbMap(resolvedAddresses);

    // Handle error case
    if (newChildren.isEmpty()) {
      Status unavailableStatus = Status.UNAVAILABLE.withDescription(
          "NameResolver returned no usable address. " + resolvedAddresses);
      handleNameResolutionError(unavailableStatus);
      return new AcceptResolvedAddrRetVal(unavailableStatus, null);
    }

    addMissingChildren(newChildren);

    updateChildrenWithResolvedAddresses(resolvedAddresses, newChildren);

    return new AcceptResolvedAddrRetVal(Status.OK, getRemovedChildren(newChildren.keySet()));
  }

  private void addMissingChildren(Map<Object, ChildLbState> newChildren) {
    // Do adds and identify reused children
    for (Map.Entry<Object, ChildLbState> entry : newChildren.entrySet()) {
      final Object key = entry.getKey();
      if (!childLbStates.containsKey(key)) {
        childLbStates.put(key, entry.getValue());
      }
    }
  }

  private void updateChildrenWithResolvedAddresses(ResolvedAddresses resolvedAddresses,
                                                     Map<Object, ChildLbState> newChildren) {
    for (Map.Entry<Object, ChildLbState> entry : newChildren.entrySet()) {
      Object childConfig = entry.getValue().getConfig();
      ChildLbState childLbState = childLbStates.get(entry.getKey());
      ResolvedAddresses childAddresses =
          getChildAddresses(entry.getKey(), resolvedAddresses, childConfig);
      childLbState.setResolvedAddresses(childAddresses); // update child
      childLbState.lb.handleResolvedAddresses(childAddresses); // update child LB
    }
  }

  /**
   * Identifies which children have been removed (are not part of the newChildKeys).
   */
  private List<ChildLbState> getRemovedChildren(Set<Object> newChildKeys) {
    List<ChildLbState> removedChildren = new ArrayList<>();
    // Do removals
    for (Object key : ImmutableList.copyOf(childLbStates.keySet())) {
      if (!newChildKeys.contains(key)) {
        ChildLbState childLbState = childLbStates.remove(key);
        removedChildren.add(childLbState);
      }
    }
    return removedChildren;
  }

  protected final void shutdownRemoved(List<ChildLbState> removedChildren) {
    // Do shutdowns after updating picker to reduce the chance of failing an RPC by picking a
    // subchannel that has been shutdown.
    for (ChildLbState childLbState : removedChildren) {
      childLbState.shutdown();
    }
  }

  @Nullable
  protected static ConnectivityState aggregateState(
      @Nullable ConnectivityState overallState, ConnectivityState childState) {
    if (overallState == null) {
      return childState;
    }
    if (overallState == READY || childState == READY) {
      return READY;
    }
    if (overallState == CONNECTING || childState == CONNECTING) {
      return CONNECTING;
    }
    if (overallState == IDLE || childState == IDLE) {
      return IDLE;
    }
    return overallState;
  }

  protected final Helper getHelper() {
    return helper;
  }

  @VisibleForTesting
  public final Collection<ChildLbState> getChildLbStates() {
    return childLbStates.values();
  }

  @VisibleForTesting
  public final ChildLbState getChildLbState(Object key) {
    if (key == null) {
      return null;
    }
    if (key instanceof EquivalentAddressGroup) {
      key = new Endpoint((EquivalentAddressGroup) key);
    }
    return childLbStates.get(key);
  }

  @VisibleForTesting
  public final ChildLbState getChildLbStateEag(EquivalentAddressGroup eag) {
    return getChildLbState(new Endpoint(eag));
  }

  /**
   * Filters out non-ready child load balancers (subchannels).
   */
  protected final List<ChildLbState> getReadyChildren() {
    List<ChildLbState> activeChildren = new ArrayList<>();
    for (ChildLbState child : getChildLbStates()) {
      if (child.getCurrentState() == READY) {
        activeChildren.add(child);
      }
    }
    return activeChildren;
  }

  /**
   * This represents the state of load balancer children.  Each endpoint (represented by an
   * EquivalentAddressGroup or EDS string) will have a separate ChildLbState which in turn will
   * have a single child LoadBalancer created from the provided factory.
   *
   * <p>A ChildLbStateHelper is the glue between ChildLbState and the helpers associated with the
   * petiole policy above and the PickFirstLoadBalancer's helper below.
   *
   * <p>If you wish to store additional state information related to each subchannel, then extend
   * this class.
   */
  public class ChildLbState {
    private final Object key;
    private ResolvedAddresses resolvedAddresses;
    private final Object config;

    private final LoadBalancer lb;
    private ConnectivityState currentState;
    private SubchannelPicker currentPicker = new FixedResultPicker(PickResult.withNoResult());

    public ChildLbState(Object key, LoadBalancer.Factory policyFactory, Object childConfig) {
      this.key = key;
      this.config = childConfig;
      this.lb = policyFactory.newLoadBalancer(createChildHelper());
      this.currentState = CONNECTING;
    }

    protected ChildLbStateHelper createChildHelper() {
      return new ChildLbStateHelper();
    }

    /**
     * Override for unique behavior such as delayed shutdowns of subchannels.
     */
    protected void shutdown() {
      lb.shutdown();
      this.currentState = SHUTDOWN;
      logger.log(Level.FINE, "Child balancer {0} deleted", key);
    }

    @Override
    public String toString() {
      return "Address = " + key
          + ", state = " + currentState
          + ", picker type: " + currentPicker.getClass()
          + ", lb: " + lb;
    }

    public final Object getKey() {
      return key;
    }

    @VisibleForTesting
    public final LoadBalancer getLb() {
      return lb;
    }

    @VisibleForTesting
    public final SubchannelPicker getCurrentPicker() {
      return currentPicker;
    }

    public final ConnectivityState getCurrentState() {
      return currentState;
    }

    protected final void setCurrentState(ConnectivityState newState) {
      currentState = newState;
    }

    protected final void setCurrentPicker(SubchannelPicker newPicker) {
      currentPicker = newPicker;
    }

    public final EquivalentAddressGroup getEag() {
      if (resolvedAddresses == null || resolvedAddresses.getAddresses().isEmpty()) {
        return null;
      }
      return resolvedAddresses.getAddresses().get(0);
    }

    protected final void setResolvedAddresses(ResolvedAddresses newAddresses) {
      checkNotNull(newAddresses, "Missing address list for child");
      resolvedAddresses = newAddresses;
    }

    private Object getConfig() {
      return config;
    }

    @VisibleForTesting
    public final ResolvedAddresses getResolvedAddresses() {
      return resolvedAddresses;
    }

    /**
     * ChildLbStateHelper is the glue between ChildLbState and the helpers associated with the
     * petiole policy above and the PickFirstLoadBalancer's helper below.
     *
     * <p>The ChildLbState updates happen during updateBalancingState.  Otherwise, it is doing
     * simple forwarding.
     */
    protected class ChildLbStateHelper extends ForwardingLoadBalancerHelper {

      /**
       * Update current state and picker for this child and then use
       * {@link #updateOverallBalancingState()} for the parent LB.
       */
      @Override
      public void updateBalancingState(final ConnectivityState newState,
          final SubchannelPicker newPicker) {
        if (!childLbStates.containsKey(key)) {
          return;
        }

        currentState = newState;
        currentPicker = newPicker;
        // If we are already in the process of resolving addresses, the overall balancing state
        // will be updated at the end of it, and we don't need to trigger that update here.
        if (!resolvingAddresses) {
          updateOverallBalancingState();
        }
      }

      @Override
      protected Helper delegate() {
        return helper;
      }
    }
  }

  /**
   * Endpoint is an optimization to quickly lookup and compare EquivalentAddressGroup address sets.
   * It ignores the attributes. Is used as a key for ChildLbState for most load balancers
   * (ClusterManagerLB uses a String).
   */
  protected static class Endpoint {
    final Collection<SocketAddress> addrs;
    final int hashCode;

    public Endpoint(EquivalentAddressGroup eag) {
      checkNotNull(eag, "eag");

      if (eag.getAddresses().size() < 10) {
        addrs = eag.getAddresses();
      } else {
        // This is expected to be very unlikely in practice
        addrs = new HashSet<>(eag.getAddresses());
      }
      int sum = 0;
      for (SocketAddress address : eag.getAddresses()) {
        sum += address.hashCode();
      }
      hashCode = sum;
    }

    @Override
    public int hashCode() {
      return hashCode;
    }

    @Override
    public boolean equals(Object other) {
      if (this == other) {
        return true;
      }

      if (!(other instanceof Endpoint)) {
        return false;
      }
      Endpoint o = (Endpoint) other;
      if (o.hashCode != hashCode || o.addrs.size() != addrs.size()) {
        return false;
      }

      return o.addrs.containsAll(addrs);
    }

    @Override
    public String toString() {
      return addrs.toString();
    }
  }

  protected static class AcceptResolvedAddrRetVal {
    public final Status status;
    public final List<ChildLbState> removedChildren;

    public AcceptResolvedAddrRetVal(Status status, List<ChildLbState> removedChildren) {
      this.status = status;
      this.removedChildren = removedChildren;
    }
  }
}

1	/*
2	* Copyright 2023 The gRPC Authors
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* http://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16
17	package io.grpc.util;
18
19	import static com.google.common.base.Preconditions.checkArgument;
20	import static com.google.common.base.Preconditions.checkNotNull;
21	import static io.grpc.ConnectivityState.CONNECTING;
22	import static io.grpc.ConnectivityState.IDLE;
23	import static io.grpc.ConnectivityState.READY;
24	import static io.grpc.ConnectivityState.SHUTDOWN;
25	import static io.grpc.ConnectivityState.TRANSIENT_FAILURE;
26
27	import com.google.common.annotations.VisibleForTesting;
28	import com.google.common.collect.ImmutableList;
29	import io.grpc.Attributes;
30	import io.grpc.ConnectivityState;
31	import io.grpc.EquivalentAddressGroup;
32	import io.grpc.Internal;
33	import io.grpc.LoadBalancer;
34	import io.grpc.LoadBalancerProvider;
35	import io.grpc.Status;
36	import io.grpc.internal.PickFirstLoadBalancerProvider;
37	import java.net.SocketAddress;
38	import java.util.ArrayList;
39	import java.util.Collection;
40	import java.util.Collections;
41	import java.util.HashMap;
42	import java.util.HashSet;
43	import java.util.LinkedHashMap;
44	import java.util.List;
45	import java.util.Map;
46	import java.util.Set;
47	import java.util.logging.Level;
48	import java.util.logging.Logger;
49	import javax.annotation.Nullable;
50
51	/**
52	* A base load balancing policy for those policies which has multiple children such as
53	* ClusterManager or the petiole policies. For internal use only.
54	*/
55	@Internal
56	public abstract class MultiChildLoadBalancer extends LoadBalancer {
57
58	private static final Logger logger = Logger.getLogger(MultiChildLoadBalancer.class.getName());	1✔
59	private final Map<Object, ChildLbState> childLbStates = new LinkedHashMap<>();	1✔
60	private final Helper helper;
61	// Set to true if currently in the process of handling resolved addresses.
62	protected boolean resolvingAddresses;
63
64	protected final LoadBalancerProvider pickFirstLbProvider = new PickFirstLoadBalancerProvider();	1✔
65
66	protected ConnectivityState currentConnectivityState;
67
68
69	protected MultiChildLoadBalancer(Helper helper) {	1✔
70	this.helper = checkNotNull(helper, "helper");	1✔
71	logger.log(Level.FINE, "Created");	1✔
72	}	1✔
73
74	/**
75	* Using the state of all children will calculate the current connectivity state,
76	* update fields, generate a picker and then call
77	* {@link Helper#updateBalancingState(ConnectivityState, SubchannelPicker)}.
78	*/
79	protected abstract void updateOverallBalancingState();
80
81	/**
82	* Override to utilize parsing of the policy configuration or alternative helper/lb generation.
83	*/
84	protected Map<Object, ChildLbState> createChildLbMap(ResolvedAddresses resolvedAddresses) {
85	Map<Object, ChildLbState> childLbMap = new HashMap<>();	1✔
86	List<EquivalentAddressGroup> addresses = resolvedAddresses.getAddresses();	1✔
87	for (EquivalentAddressGroup eag : addresses) {	1✔
88	Endpoint endpoint = new Endpoint(eag); // keys need to be just addresses	1✔
89	ChildLbState existingChildLbState = childLbStates.get(endpoint);	1✔
90	if (existingChildLbState != null) {	1✔
91	childLbMap.put(endpoint, existingChildLbState);	1✔
92	} else {
93	childLbMap.put(endpoint, createChildLbState(endpoint, null, resolvedAddresses));	1✔
94	}
95	}	1✔
96	return childLbMap;	1✔
97	}
98
99	/**
100	* Override to create an instance of a subclass.
101	*/
102	protected ChildLbState createChildLbState(Object key, Object policyConfig,
103	ResolvedAddresses resolvedAddresses) {
104	return new ChildLbState(key, pickFirstLbProvider, policyConfig);	1✔
105	}
106
107	/**
108	* Override to completely replace the default logic or to do additional activities.
109	*/
110	@Override
111	public Status acceptResolvedAddresses(ResolvedAddresses resolvedAddresses) {
112	try {
113	resolvingAddresses = true;	1✔
114
115	// process resolvedAddresses to update children
116	AcceptResolvedAddrRetVal acceptRetVal = acceptResolvedAddressesInternal(resolvedAddresses);	1✔
117	if (!acceptRetVal.status.isOk()) {	1✔
118	return acceptRetVal.status;	1✔
119	}
120
121	// Update the picker and our connectivity state
122	updateOverallBalancingState();	1✔
123
124	// shutdown removed children
125	shutdownRemoved(acceptRetVal.removedChildren);	1✔
126	return acceptRetVal.status;	1✔
127	} finally {
128	resolvingAddresses = false;	1✔
129	}
130	}
131
132	/**
133	* Override this if your keys are not of type Endpoint.
134	* @param key Key to identify the ChildLbState
135	* @param resolvedAddresses list of addresses which include attributes
136	* @param childConfig a load balancing policy config. This field is optional.
137	* @return a fully loaded ResolvedAddresses object for the specified key
138	*/
139	protected ResolvedAddresses getChildAddresses(Object key, ResolvedAddresses resolvedAddresses,
140	Object childConfig) {
141	Endpoint endpointKey;
142	if (key instanceof EquivalentAddressGroup) {	1✔
143	endpointKey = new Endpoint((EquivalentAddressGroup) key);	×
144	} else {
145	checkArgument(key instanceof Endpoint, "key is wrong type");	1✔
146	endpointKey = (Endpoint) key;	1✔
147	}
148
149	// Retrieve the non-stripped version
150	EquivalentAddressGroup eagToUse = null;	1✔
151	for (EquivalentAddressGroup currEag : resolvedAddresses.getAddresses()) {	1✔
152	if (endpointKey.equals(new Endpoint(currEag))) {	1✔
153	eagToUse = currEag;	1✔
154	break;	1✔
155	}
156	}	1✔
157
158	checkNotNull(eagToUse, key + " no longer present in load balancer children");	1✔
159
160	return resolvedAddresses.toBuilder()	1✔
161	.setAddresses(Collections.singletonList(eagToUse))	1✔
162	.setAttributes(Attributes.newBuilder().set(IS_PETIOLE_POLICY, true).build())	1✔
163	.setLoadBalancingPolicyConfig(childConfig)	1✔
164	.build();	1✔
165	}
166
167	/**
168	* Handle the name resolution error.
169	*
170	* <p/>Override if you need special handling.
171	*/
172	@Override
173	public void handleNameResolutionError(Status error) {
174	if (currentConnectivityState != READY) {	1✔
175	helper.updateBalancingState(	1✔
176	TRANSIENT_FAILURE, new FixedResultPicker(PickResult.withError(error)));	1✔
177	}
178	}	1✔
179
180	@Override
181	public void shutdown() {
182	logger.log(Level.FINE, "Shutdown");	1✔
183	for (ChildLbState state : childLbStates.values()) {	1✔
184	state.shutdown();	1✔
185	}	1✔
186	childLbStates.clear();	1✔
187	}	1✔
188
189	/**
190	* This does the work to update the child map and calculate which children have been removed.
191	* You must call {@link #updateOverallBalancingState} to update the picker
192	* and call {@link #shutdownRemoved(List)} to shutdown the endpoints that have been removed.
193	*/
194	protected final AcceptResolvedAddrRetVal acceptResolvedAddressesInternal(
195	ResolvedAddresses resolvedAddresses) {
196	logger.log(Level.FINE, "Received resolution result: {0}", resolvedAddresses);	1✔
197
198	// Subclass handles any special manipulation to create appropriate types of keyed ChildLbStates
199	Map<Object, ChildLbState> newChildren = createChildLbMap(resolvedAddresses);	1✔
200
201	// Handle error case
202	if (newChildren.isEmpty()) {	1✔
203	Status unavailableStatus = Status.UNAVAILABLE.withDescription(	1✔
204	"NameResolver returned no usable address. " + resolvedAddresses);
205	handleNameResolutionError(unavailableStatus);	1✔
206	return new AcceptResolvedAddrRetVal(unavailableStatus, null);	1✔
207	}
208
209	addMissingChildren(newChildren);	1✔
210
211	updateChildrenWithResolvedAddresses(resolvedAddresses, newChildren);	1✔
212
213	return new AcceptResolvedAddrRetVal(Status.OK, getRemovedChildren(newChildren.keySet()));	1✔
214	}
215
216	private void addMissingChildren(Map<Object, ChildLbState> newChildren) {
217	// Do adds and identify reused children
218	for (Map.Entry<Object, ChildLbState> entry : newChildren.entrySet()) {	1✔
219	final Object key = entry.getKey();	1✔
220	if (!childLbStates.containsKey(key)) {	1✔
221	childLbStates.put(key, entry.getValue());	1✔
222	}
223	}	1✔
224	}	1✔
225
226	private void updateChildrenWithResolvedAddresses(ResolvedAddresses resolvedAddresses,
227	Map<Object, ChildLbState> newChildren) {
228	for (Map.Entry<Object, ChildLbState> entry : newChildren.entrySet()) {	1✔
229	Object childConfig = entry.getValue().getConfig();	1✔
230	ChildLbState childLbState = childLbStates.get(entry.getKey());	1✔
231	ResolvedAddresses childAddresses =	1✔
232	getChildAddresses(entry.getKey(), resolvedAddresses, childConfig);	1✔
233	childLbState.setResolvedAddresses(childAddresses); // update child	1✔
234	childLbState.lb.handleResolvedAddresses(childAddresses); // update child LB	1✔
235	}	1✔
236	}	1✔
237
238	/**
239	* Identifies which children have been removed (are not part of the newChildKeys).
240	*/
241	private List<ChildLbState> getRemovedChildren(Set<Object> newChildKeys) {
242	List<ChildLbState> removedChildren = new ArrayList<>();	1✔
243	// Do removals
244	for (Object key : ImmutableList.copyOf(childLbStates.keySet())) {	1✔
245	if (!newChildKeys.contains(key)) {	1✔
246	ChildLbState childLbState = childLbStates.remove(key);	1✔
247	removedChildren.add(childLbState);	1✔
248	}
249	}	1✔
250	return removedChildren;	1✔
251	}
252
253	protected final void shutdownRemoved(List<ChildLbState> removedChildren) {
254	// Do shutdowns after updating picker to reduce the chance of failing an RPC by picking a
255	// subchannel that has been shutdown.
256	for (ChildLbState childLbState : removedChildren) {	1✔
257	childLbState.shutdown();	1✔
258	}	1✔
259	}	1✔
260
261	@Nullable
262	protected static ConnectivityState aggregateState(
263	@Nullable ConnectivityState overallState, ConnectivityState childState) {
264	if (overallState == null) {	1✔
265	return childState;	1✔
266	}
267	if (overallState == READY \|\| childState == READY) {	1✔
268	return READY;	1✔
269	}
270	if (overallState == CONNECTING \|\| childState == CONNECTING) {	1✔
271	return CONNECTING;	1✔
272	}
273	if (overallState == IDLE \|\| childState == IDLE) {	1✔
274	return IDLE;	×
275	}
276	return overallState;	1✔
277	}
278
279	protected final Helper getHelper() {
280	return helper;	1✔
281	}
282
283	@VisibleForTesting
284	public final Collection<ChildLbState> getChildLbStates() {
285	return childLbStates.values();	1✔
286	}
287
288	@VisibleForTesting
289	public final ChildLbState getChildLbState(Object key) {
290	if (key == null) {	1✔
291	return null;	×
292	}
293	if (key instanceof EquivalentAddressGroup) {	1✔
294	key = new Endpoint((EquivalentAddressGroup) key);	1✔
295	}
296	return childLbStates.get(key);	1✔
297	}
298
299	@VisibleForTesting
300	public final ChildLbState getChildLbStateEag(EquivalentAddressGroup eag) {
301	return getChildLbState(new Endpoint(eag));	1✔
302	}
303
304	/**
305	* Filters out non-ready child load balancers (subchannels).
306	*/
307	protected final List<ChildLbState> getReadyChildren() {
308	List<ChildLbState> activeChildren = new ArrayList<>();	1✔
309	for (ChildLbState child : getChildLbStates()) {	1✔
310	if (child.getCurrentState() == READY) {	1✔
311	activeChildren.add(child);	1✔
312	}
313	}	1✔
314	return activeChildren;	1✔
315	}
316
317	/**
318	* This represents the state of load balancer children. Each endpoint (represented by an
319	* EquivalentAddressGroup or EDS string) will have a separate ChildLbState which in turn will
320	* have a single child LoadBalancer created from the provided factory.
321	*
322	* <p>A ChildLbStateHelper is the glue between ChildLbState and the helpers associated with the
323	* petiole policy above and the PickFirstLoadBalancer's helper below.
324	*
325	* <p>If you wish to store additional state information related to each subchannel, then extend
326	* this class.
327	*/
328	public class ChildLbState {
329	private final Object key;
330	private ResolvedAddresses resolvedAddresses;
331	private final Object config;
332
333	private final LoadBalancer lb;
334	private ConnectivityState currentState;
335	private SubchannelPicker currentPicker = new FixedResultPicker(PickResult.withNoResult());	1✔
336
337	public ChildLbState(Object key, LoadBalancer.Factory policyFactory, Object childConfig) {	1✔
338	this.key = key;	1✔
339	this.config = childConfig;	1✔
340	this.lb = policyFactory.newLoadBalancer(createChildHelper());	1✔
341	this.currentState = CONNECTING;	1✔
342	}	1✔
343
344	protected ChildLbStateHelper createChildHelper() {
345	return new ChildLbStateHelper();	1✔
346	}
347
348	/**
349	* Override for unique behavior such as delayed shutdowns of subchannels.
350	*/
351	protected void shutdown() {
352	lb.shutdown();	1✔
353	this.currentState = SHUTDOWN;	1✔
354	logger.log(Level.FINE, "Child balancer {0} deleted", key);	1✔
355	}	1✔
356
357	@Override
358	public String toString() {
359	return "Address = " + key	×
360	+ ", state = " + currentState
361	+ ", picker type: " + currentPicker.getClass()	×
362	+ ", lb: " + lb;
363	}
364
365	public final Object getKey() {
366	return key;	1✔
367	}
368
369	@VisibleForTesting
370	public final LoadBalancer getLb() {
371	return lb;	1✔
372	}
373
374	@VisibleForTesting
375	public final SubchannelPicker getCurrentPicker() {
376	return currentPicker;	1✔
377	}
378
379	public final ConnectivityState getCurrentState() {
380	return currentState;	1✔
381	}
382
383	protected final void setCurrentState(ConnectivityState newState) {
384	currentState = newState;	1✔
385	}	1✔
386
387	protected final void setCurrentPicker(SubchannelPicker newPicker) {
388	currentPicker = newPicker;	1✔
389	}	1✔
390
391	public final EquivalentAddressGroup getEag() {
392	if (resolvedAddresses == null \|\| resolvedAddresses.getAddresses().isEmpty()) {	1✔
393	return null;	×
394	}
395	return resolvedAddresses.getAddresses().get(0);	1✔
396	}
397
398	protected final void setResolvedAddresses(ResolvedAddresses newAddresses) {
399	checkNotNull(newAddresses, "Missing address list for child");	1✔
400	resolvedAddresses = newAddresses;	1✔
401	}	1✔
402
403	private Object getConfig() {
404	return config;	1✔
405	}
406
407	@VisibleForTesting
408	public final ResolvedAddresses getResolvedAddresses() {
409	return resolvedAddresses;	1✔
410	}
411
412	/**
413	* ChildLbStateHelper is the glue between ChildLbState and the helpers associated with the
414	* petiole policy above and the PickFirstLoadBalancer's helper below.
415	*
416	* <p>The ChildLbState updates happen during updateBalancingState. Otherwise, it is doing
417	* simple forwarding.
418	*/
419	protected class ChildLbStateHelper extends ForwardingLoadBalancerHelper {	1✔
420
421	/**
422	* Update current state and picker for this child and then use
423	* {@link #updateOverallBalancingState()} for the parent LB.
424	*/
425	@Override
426	public void updateBalancingState(final ConnectivityState newState,
427	final SubchannelPicker newPicker) {
428	if (!childLbStates.containsKey(key)) {	1✔
429	return;	×
430	}
431
432	currentState = newState;	1✔
433	currentPicker = newPicker;	1✔
434	// If we are already in the process of resolving addresses, the overall balancing state
435	// will be updated at the end of it, and we don't need to trigger that update here.
436	if (!resolvingAddresses) {	1✔
437	updateOverallBalancingState();	1✔
438	}
439	}	1✔
440
441	@Override
442	protected Helper delegate() {
443	return helper;	1✔
444	}
445	}
446	}
447
448	/**
449	* Endpoint is an optimization to quickly lookup and compare EquivalentAddressGroup address sets.
450	* It ignores the attributes. Is used as a key for ChildLbState for most load balancers
451	* (ClusterManagerLB uses a String).
452	*/
453	protected static class Endpoint {
454	final Collection<SocketAddress> addrs;
455	final int hashCode;
456
457	public Endpoint(EquivalentAddressGroup eag) {	1✔
458	checkNotNull(eag, "eag");	1✔
459
460	if (eag.getAddresses().size() < 10) {	1✔
461	addrs = eag.getAddresses();	1✔
462	} else {
463	// This is expected to be very unlikely in practice
464	addrs = new HashSet<>(eag.getAddresses());	1✔
465	}
466	int sum = 0;	1✔
467	for (SocketAddress address : eag.getAddresses()) {	1✔
468	sum += address.hashCode();	1✔
469	}	1✔
470	hashCode = sum;	1✔
471	}	1✔
472
473	@Override
474	public int hashCode() {
475	return hashCode;	1✔
476	}
477
478	@Override
479	public boolean equals(Object other) {
480	if (this == other) {	1✔
481	return true;	1✔
482	}
483
484	if (!(other instanceof Endpoint)) {	1✔
485	return false;	1✔
486	}
487	Endpoint o = (Endpoint) other;	1✔
488	if (o.hashCode != hashCode \|\| o.addrs.size() != addrs.size()) {	1✔
489	return false;	1✔
490	}
491
492	return o.addrs.containsAll(addrs);	1✔
493	}
494
495	@Override
496	public String toString() {
497	return addrs.toString();	1✔
498	}
499	}
500
501	protected static class AcceptResolvedAddrRetVal {
502	public final Status status;
503	public final List<ChildLbState> removedChildren;
504
505	public AcceptResolvedAddrRetVal(Status status, List<ChildLbState> removedChildren) {	1✔
506	this.status = status;	1✔
507	this.removedChildren = removedChildren;	1✔
508	}	1✔
509	}
510	}

grpc / grpc-java / #19429

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous