#19763

Committed 04 Apr 2025 05:53AM UTC coverage: 88.616% (+0.02%) from 88.598%

Build # #19763

Build Type

push

github

Committed by

web-flow

Commit Message

refactor: prevents global stats config freeze in ConfiguratorRegistry.getConfigurators() (#11991)

Run Details

34742 of 39205 relevant lines covered (88.62%)

0.89 hits per line

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

64.71

/../api/src/main/java/io/grpc/ConfiguratorRegistry.java

/*
 * Copyright 2024 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;

import com.google.errorprone.annotations.concurrent.GuardedBy;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * A registry for {@link Configurator} instances.
 *
 * <p>This class is responsible for maintaining a list of configurators and providing access to
 * them. The default registry can be obtained using {@link #getDefaultRegistry()}.
 */
final class ConfiguratorRegistry {
  private static ConfiguratorRegistry instance;

  @GuardedBy("this")
  private boolean wasConfiguratorsSet;
  @GuardedBy("this")
  private List<Configurator> configurators = Collections.emptyList();
  @GuardedBy("this")
  private int configuratorsCallCountBeforeSet = 0;

  ConfiguratorRegistry() {}

  /**
   * Returns the default global instance of the configurator registry.
   */
  public static synchronized ConfiguratorRegistry getDefaultRegistry() {
    if (instance == null) {
      instance = new ConfiguratorRegistry();
    }
    return instance;
  }

  /**
   * Sets the configurators in this registry. This method can only be called once.
   *
   * @param configurators the configurators to set
   * @throws IllegalStateException if this method is called more than once
   */
  public synchronized void setConfigurators(List<? extends Configurator> configurators) {
    if (wasConfiguratorsSet) {
      throw new IllegalStateException("Configurators are already set");
    }
    this.configurators = Collections.unmodifiableList(new ArrayList<>(configurators));
    wasConfiguratorsSet = true;
  }

  /**
   * Returns a list of the configurators in this registry.
   */
  public synchronized List<Configurator> getConfigurators() {
    if (!wasConfiguratorsSet) {
      configuratorsCallCountBeforeSet++;
    }
    return configurators;
  }

  /**
   * Returns the number of times getConfigurators() was called before
   * setConfigurators() was successfully invoked.
   */
  public synchronized int getConfiguratorsCallCountBeforeSet() {
    return configuratorsCallCountBeforeSet;
  }

  public synchronized boolean wasSetConfiguratorsCalled() {
    return wasConfiguratorsSet;
  }
}

1	/*
2	* Copyright 2024 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;
18
19	import com.google.errorprone.annotations.concurrent.GuardedBy;
20	import java.util.ArrayList;
21	import java.util.Collections;
22	import java.util.List;
23
24	/**
25	* A registry for {@link Configurator} instances.
26	*
27	* <p>This class is responsible for maintaining a list of configurators and providing access to
28	* them. The default registry can be obtained using {@link #getDefaultRegistry()}.
29	*/
30	final class ConfiguratorRegistry {
31	private static ConfiguratorRegistry instance;
32
33	@GuardedBy("this")
34	private boolean wasConfiguratorsSet;
35	@GuardedBy("this")	1✔
36	private List<Configurator> configurators = Collections.emptyList();	1✔
37	@GuardedBy("this")	1✔
38	private int configuratorsCallCountBeforeSet = 0;
39
40	ConfiguratorRegistry() {}	1✔
41
42	/**
43	* Returns the default global instance of the configurator registry.
44	*/
45	public static synchronized ConfiguratorRegistry getDefaultRegistry() {
46	if (instance == null) {	1✔
47	instance = new ConfiguratorRegistry();	1✔
48	}
49	return instance;	1✔
50	}
51
52	/**
53	* Sets the configurators in this registry. This method can only be called once.
54	*
55	* @param configurators the configurators to set
56	* @throws IllegalStateException if this method is called more than once
57	*/
58	public synchronized void setConfigurators(List<? extends Configurator> configurators) {
59	if (wasConfiguratorsSet) {	×
60	throw new IllegalStateException("Configurators are already set");	×
61	}
62	this.configurators = Collections.unmodifiableList(new ArrayList<>(configurators));	×
63	wasConfiguratorsSet = true;	×
64	}	×
65
66	/**
67	* Returns a list of the configurators in this registry.
68	*/
69	public synchronized List<Configurator> getConfigurators() {
70	if (!wasConfiguratorsSet) {	1✔
71	configuratorsCallCountBeforeSet++;	1✔
72	}
73	return configurators;	1✔
74	}
75
76	/**
77	* Returns the number of times getConfigurators() was called before
78	* setConfigurators() was successfully invoked.
79	*/
80	public synchronized int getConfiguratorsCallCountBeforeSet() {
81	return configuratorsCallCountBeforeSet;	×
82	}
83
84	public synchronized boolean wasSetConfiguratorsCalled() {
85	return wasConfiguratorsSet;	1✔
86	}
87	}

grpc / grpc-java / #19763

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