cleanup

Author: jrhee17

spring/boot4-xds/src/main/java/com/linecorp/armeria/spring/xds/SpringConfigSourceFactory.java

@@ -44,38 +44,17 @@
 /**
  * A {@link SotwConfigSourceSubscriptionFactory} that reads xDS resources from
  * Spring {@link Environment} properties. Each resource name is mapped to a
- * property key using a configurable prefix, and the property value is parsed
- * as the proto type corresponding to the subscribed {@link XdsType}.
- *
- * <p>Example properties:
- * <pre>{@code
- * armeria.xds.my-cluster: |
- *   name: my-cluster
- *   type: STATIC
- *   load_assignment:
- *     cluster_name: my-cluster
- *     endpoints:
- *       - lb_endpoints:
- *           - endpoint:
- *               address:
- *                 socket_address:
- *                   address: 127.0.0.1
- *                   port_value: 8080
- *
- * armeria.xds.my-listener: |
- *   name: my-listener
- *   address:
- *     socket_address:
- *       address: 0.0.0.0
- *       port_value: 8080
- * }</pre>
+ * property key of the form {@code <prefix>.<resource-name>}, and the property
+ * value is parsed as the type corresponding to the subscribed {@link XdsType}.
  *
  * <p>The property key prefix is configured via a {@link SpringConfigSource}
  * packed into the {@code typed_config} field of the bootstrap's
- * {@code custom_config_source}.
+ * {@code custom_config_source}. The default prefix is {@code armeria.xds.}.
  *
  * <p>Call {@link #refresh()} to re-read properties and push updated resources
  * to subscribers (e.g. from a Spring Cloud Config {@code EnvironmentChangeEvent}).
+ *
+ * @see SpringXdsAutoConfiguration
  */
 @UnstableApi
 public final class SpringConfigSourceFactory implements SotwConfigSourceSubscriptionFactory {
@@ -85,11 +64,6 @@ public final class SpringConfigSourceFactory implements SotwConfigSourceSubscrip
      */
     public static final String NAME = "armeria.config_source.spring";
 
-    /**
-     * The default prefix prepended to resource names to form property keys.
-     */
-    public static final String DEFAULT_PREFIX = "armeria.xds.";
-
     private static final Object SIGNAL = new Object();
 
     private final Environment environment;
@@ -98,7 +72,11 @@ public final class SpringConfigSourceFactory implements SotwConfigSourceSubscrip
     /**
      * Creates a new factory backed by the given Spring {@link Environment}.
      */
-    public SpringConfigSourceFactory(Environment environment) {
+    public static SpringConfigSourceFactory of(Environment environment) {
+        return new SpringConfigSourceFactory(environment);
+    }
+
+    private SpringConfigSourceFactory(Environment environment) {
         this.environment = requireNonNull(environment, "environment");
     }
 
@@ -111,10 +89,10 @@ public String name() {
     public SnapshotStream<DiscoveryResponse> create(ConfigSource configSource,
                                                     FactoryContext factoryContext,
                                                     SnapshotStream<InterestedResources> interestedResources) {
-        final String rawPrefix = factoryContext.validator()
-                                               .unpack(configSource.getCustomConfigSource().getTypedConfig(),
-                                                       SpringConfigSource.class)
-                                               .getPrefix();
+        final SpringConfigSource springConfigSource =
+                factoryContext.validator().unpack(configSource.getCustomConfigSource().getTypedConfig(),
+                                                  SpringConfigSource.class);
+        final String rawPrefix = springConfigSource.getPrefix();
         final String prefix = rawPrefix.endsWith(".") ? rawPrefix : rawPrefix + '.';
         final Map<XdsType, InterestedResources> accumulated = new EnumMap<>(XdsType.class);
         final SnapshotStream<Map<XdsType, InterestedResources>> allInterests =

spring/boot4-xds/src/main/java/com/linecorp/armeria/spring/xds/SpringXdsAutoConfiguration.java

@@ -39,6 +39,12 @@
  * Spring {@link Environment} properties and automatically refreshes on
  * {@link EnvironmentChangeEvent}.
  *
+ * <p><b>Note:</b> YAML configuration files ({@code application.yml}) are recommended
+ * over {@code .properties} files because xDS resource values are multi-line YAML
+ * that cannot be represented correctly in {@code .properties} format.
+ *
+ * <h2>xDS resources</h2>
+ *
  * <p>Each xDS resource is stored as a separate property with the key
  * {@code armeria.xds.<resource-name>} containing the resource YAML
  * (without {@code @type} wrappers — the type is inferred from the
@@ -61,6 +67,28 @@
  *                       address: 127.0.0.1
  *                       port_value: 8080
  * }</pre>
+ *
+ * <h2>Bootstrap</h2>
+ *
+ * <p>The xDS {@link Bootstrap} is created from the {@code armeria.xds.bootstrap} property.
+ * If not set, a default bootstrap is loaded from
+ * {@code META-INF/armeria/xds/default-bootstrap.yml}, which configures both LDS and CDS
+ * to use {@link SpringConfigSourceFactory} with the default prefix {@code armeria.xds.}.
+ *
+ * <p>To customize the bootstrap, set {@code armeria.xds.bootstrap} in your
+ * {@code application.yml}:
+ * <pre>{@code
+ * armeria:
+ *   xds:
+ *     bootstrap: |
+ *       dynamic_resources:
+ *         cds_config:
+ *           custom_config_source:
+ *             name: armeria.config_source.spring
+ *             typed_config:
+ *               "@type": type.googleapis.com/armeria.xds.spring.SpringConfigSource
+ *               prefix: "my.custom.prefix."
+ * }</pre>
  */
 @UnstableApi
 @AutoConfiguration
@@ -77,13 +105,12 @@ public class SpringXdsAutoConfiguration {
     @Bean
     @ConditionalOnMissingBean
     SpringConfigSourceFactory springConfigSourceFactory(Environment environment) {
-        return new SpringConfigSourceFactory(environment);
+        return SpringConfigSourceFactory.of(environment);
     }
 
     @Bean
     @ConditionalOnMissingBean
-    XdsBootstrap xdsBootstrap(Environment environment,
-                              List<XdsExtensionFactory> extensionFactories) {
+    XdsBootstrap xdsBootstrap(Environment environment, List<XdsExtensionFactory> extensionFactories) {
         final String bootstrapYaml = environment.getRequiredProperty(BOOTSTRAP_PROPERTY);
         final Bootstrap bootstrap = XdsResourceReader.from(bootstrapYaml, Bootstrap.class);
         return XdsBootstrap.builder(bootstrap)
@@ -92,8 +119,7 @@ XdsBootstrap xdsBootstrap(Environment environment,
     }
 
     @Bean
-    ApplicationListener<EnvironmentChangeEvent> springXdsRefreshListener(
-            SpringConfigSourceFactory factory) {
+    ApplicationListener<EnvironmentChangeEvent> springXdsRefreshListener(SpringConfigSourceFactory factory) {
         return event -> factory.refresh();
     }
 }

spring/boot4-xds/src/main/java/com/linecorp/armeria/spring/xds/SpringXdsTypeRegistryPackageProvider.java

@@ -18,11 +18,13 @@
 
 import java.util.List;
 
+import com.linecorp.armeria.common.annotation.UnstableApi;
 import com.linecorp.armeria.xds.XdsTypeRegistryPackageProvider;
 
 /**
  * Registers the {@link SpringConfigSource} protobuf type for xDS type registry discovery.
  */
+@UnstableApi
 public final class SpringXdsTypeRegistryPackageProvider implements XdsTypeRegistryPackageProvider {
 
     @Override

spring/boot4-xds/src/test/resources/application-xds-custom-bootstrap-test.yml

@@ -8,18 +8,6 @@ armeria:
             typed_config:
               "@type": type.googleapis.com/armeria.xds.spring.SpringConfigSource
               prefix: "custom.prefix."
-    custom-cluster: |
-      name: custom-cluster
-      type: STATIC
-      load_assignment:
-        cluster_name: custom-cluster
-        endpoints:
-          - lb_endpoints:
-              - endpoint:
-                  address:
-                    socket_address:
-                      address: 127.0.0.1
-                      port_value: 9090
 
 custom:
   prefix: