Make strict config default for Bootstrap

Non-strict config is deprecated.
weijiii · Jul 18, 2021 · bf70fbc · bf70fbc
1 parent 323c229
commit bf70fbc
Show file tree

Hide file tree

Showing 17 changed files with 23 additions and 31 deletions.
diff --git a/CHANGES b/CHANGES
@@ -1,6 +1,7 @@
 208
 
 - Only bind HTTPS config for HTTP server when HTTPS is enabled.
+- Make strict config default for Bootstrap. Non-strict is deprecated.
 
 207
 

diff --git a/bootstrap/src/main/java/io/airlift/bootstrap/Bootstrap.java b/bootstrap/src/main/java/io/airlift/bootstrap/Bootstrap.java
@@ -76,7 +76,7 @@ public class Bootstrap
     private Map<String, String> optionalConfigurationProperties;
     private boolean initializeLogging = true;
     private boolean quiet;
-    private boolean strictConfig;
+    private boolean strictConfig = true;
     private boolean requireExplicitBindings = true;
 
     private boolean initialized;
@@ -139,12 +139,26 @@ public Bootstrap quiet()
         return this;
     }
 
+    /**
+     * @deprecated non-strict config is deprecated
+     */
+    @Deprecated(forRemoval = true)
     public Bootstrap strictConfig()
     {
         this.strictConfig = true;
         return this;
     }
 
+    /**
+     * @deprecated non-strict config is deprecated
+     */
+    @Deprecated(forRemoval = true)
+    public Bootstrap nonStrictConfig()
+    {
+        this.strictConfig = false;
+        return this;
+    }
+
     @SuppressWarnings("unused")
     public Bootstrap requireExplicitBindings(boolean requireExplicitBindings)
     {

diff --git a/bootstrap/src/test/java/io/airlift/bootstrap/TestBootstrap.java b/bootstrap/src/test/java/io/airlift/bootstrap/TestBootstrap.java
@@ -124,7 +124,6 @@ public void testEnvironmentVariableReplacement()
     public void testStrictConfig()
     {
         Bootstrap bootstrap = new Bootstrap()
-                .strictConfig()
                 .setRequiredConfigurationProperty("test-required", "foo");
 
         assertThatThrownBy(bootstrap::initialize)
@@ -133,11 +132,13 @@ public void testStrictConfig()
                                 new Message("Configuration property 'test-required' was not used")));
     }
 
+    @SuppressWarnings("removal")
     @Test
     public void testNonStrictConfig()
     {
         new Bootstrap()
                 .setRequiredConfigurationProperty("test-required", "foo")
+                .nonStrictConfig()
                 .initialize();
     }
 

diff --git a/bootstrap/src/test/java/io/airlift/bootstrap/TestConfigurationAwareModule.java b/bootstrap/src/test/java/io/airlift/bootstrap/TestConfigurationAwareModule.java
@@ -35,7 +35,6 @@ public class TestConfigurationAwareModule
     public void testConfigAvailable()
     {
         Injector injector = new Bootstrap(new FooModule())
-                .strictConfig()
                 .doNotInitializeLogging()
                 .setRequiredConfigurationProperty("foo.enabled", "true")
                 .setRequiredConfigurationProperty("bar.enabled", "true")
@@ -50,7 +49,6 @@ public void testConfigAvailable()
     public void testInvalidInstall()
     {
         Bootstrap bootstrap = new Bootstrap(new BrokenInstallModule())
-                .strictConfig()
                 .doNotInitializeLogging();
 
         assertThatThrownBy(bootstrap::initialize).isInstanceOfSatisfying(CreationException.class, e ->
@@ -82,7 +80,6 @@ protected void setup(Binder binder)
                 });
 
         Injector injector = new Bootstrap(combined)
-                .strictConfig()
                 .doNotInitializeLogging()
                 .setRequiredConfigurationProperty("foo.enabled", "true")
                 .setRequiredConfigurationProperty("bar.enabled", "true")

diff --git a/discovery/src/test/java/io/airlift/discovery/client/TestDiscoveryModule.java b/discovery/src/test/java/io/airlift/discovery/client/TestDiscoveryModule.java
@@ -31,7 +31,6 @@ public void testExecutorShutdown()
                 new DiscoveryModule());
 
         Injector injector = app
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 

diff --git a/docs/add_metrics.md b/docs/add_metrics.md
@@ -54,7 +54,7 @@ public class Service
                 new EventModule(),
                 new JsonModule(),
                 new JaxrsModule());
-        app.strictConfig().initialize();
+        app.initialize();
     }
 
     private Service() {}

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -178,7 +178,7 @@ public class Service
                 new EventModule(),
                 new JsonModule(),
                 new JaxrsModule());
-        app.strictConfig().initialize();
+        app.initialize();
     }
 
     private Service()

diff --git a/docs/getting_started_explanation.md b/docs/getting_started_explanation.md
@@ -39,5 +39,5 @@ modules here.
 Once the bootstrap instance is created, the Service is started via:
 
 ```
-app.strictConfig().initialize();
+app.initialize();
 ```
diff --git a/http-client/src/test/java/io/airlift/http/client/TestHttpClientBinder.java b/http-client/src/test/java/io/airlift/http/client/TestHttpClientBinder.java
@@ -53,7 +53,6 @@ public void testConfigDefaults()
                         .withConfigDefaults(config -> config.setRequestTimeout(new Duration(33, MINUTES))),
                 new TraceTokenModule())
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         JettyHttpClient httpClient = (JettyHttpClient) injector.getInstance(Key.get(HttpClient.class, FooClient.class));
@@ -80,7 +79,6 @@ public void testGlobalFilterBinding()
                 },
                 new TraceTokenModule())
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         JettyHttpClient fooClient = (JettyHttpClient) injector.getInstance(Key.get(HttpClient.class, FooClient.class));
@@ -112,7 +110,6 @@ public void testBindingMultipleFiltersAndClients()
                 },
                 new TraceTokenModule())
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         assertFilterCount(injector.getInstance(Key.get(HttpClient.class, FooClient.class)), 3);
@@ -129,7 +126,6 @@ public void testBindClientWithFilter()
                         .withTracing(),
                 new TraceTokenModule())
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         HttpClient httpClient = injector.getInstance(Key.get(HttpClient.class, FooClient.class));
@@ -142,7 +138,6 @@ public void testWithoutFilters()
         Injector injector = new Bootstrap(
                 binder -> httpClientBinder(binder).bindHttpClient("foo", FooClient.class))
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         assertNotNull(injector.getInstance(Key.get(HttpClient.class, FooClient.class)));
@@ -156,7 +151,6 @@ public void testAliases()
                         .withAlias(FooAlias1.class)
                         .withAliases(ImmutableList.of(FooAlias2.class, FooAlias3.class)))
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         HttpClient client = injector.getInstance(Key.get(HttpClient.class, FooClient.class));
@@ -173,7 +167,6 @@ public void testBindClientWithAliases()
                         .withAlias(FooAlias1.class)
                         .withAlias(FooAlias2.class))
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         HttpClient client = injector.getInstance(Key.get(HttpClient.class, FooClient.class));
@@ -190,7 +183,6 @@ public void testMultipleClients()
                     httpClientBinder(binder).bindHttpClient("bar", BarClient.class);
                 })
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         HttpClient fooClient = injector.getInstance(Key.get(HttpClient.class, FooClient.class));
@@ -207,7 +199,6 @@ public void testClientShutdown()
                     httpClientBinder(binder).bindHttpClient("bar", BarClient.class);
                 })
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         HttpClient fooClient = injector.getInstance(Key.get(HttpClient.class, FooClient.class));

diff --git a/http-server/src/test/java/io/airlift/http/server/TestHttpServerModule.java b/http-server/src/test/java/io/airlift/http/server/TestHttpServerModule.java
@@ -126,7 +126,6 @@ public void testCanConstructServer()
 
         Injector injector = app
                 .setRequiredConfigurationProperties(properties)
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 
@@ -151,7 +150,6 @@ public void testHttpServerUri()
 
         Injector injector = app
                 .setRequiredConfigurationProperties(properties)
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 
@@ -196,7 +194,6 @@ public void testServer()
 
         Injector injector = app
                 .setRequiredConfigurationProperties(properties)
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 
@@ -281,7 +278,6 @@ public void testHttpRequestEvent()
 
         Injector injector = app
                 .setRequiredConfigurationProperties(properties)
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 

diff --git a/http-server/src/test/java/io/airlift/http/server/testing/TestTestingHttpServer.java b/http-server/src/test/java/io/airlift/http/server/testing/TestTestingHttpServer.java
@@ -157,7 +157,6 @@ public void testGuiceInjectionWithoutFilters()
                 });
 
         Injector injector = app
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 
@@ -191,7 +190,6 @@ public void testGuiceInjectionWithFilters()
                 });
 
         Injector injector = app
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 
@@ -229,7 +227,6 @@ public void testGuiceInjectionWithResources()
                 });
 
         Injector injector = app
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 

diff --git a/jmx-http-rpc/src/test/java/io/airlift/jmx/http/rpc/TestMBeanServerResource.java b/jmx-http-rpc/src/test/java/io/airlift/jmx/http/rpc/TestMBeanServerResource.java
@@ -74,7 +74,6 @@ public void setup()
                 });
 
         Injector injector = app
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 

diff --git a/jmx-http/src/test/java/io/airlift/jmx/TestMBeanResource.java b/jmx-http/src/test/java/io/airlift/jmx/TestMBeanResource.java
@@ -65,7 +65,6 @@ public void setup()
 
         Injector injector = app
                 .quiet()
-                .strictConfig()
                 .initialize();
 
         lifeCycleManager = injector.getInstance(LifeCycleManager.class);

diff --git a/sample-server/src/main/java/io/airlift/sample/Main.java b/sample-server/src/main/java/io/airlift/sample/Main.java
@@ -56,7 +56,7 @@ public static void main(String[] args)
                 new MainModule());
 
         try {
-            Injector injector = app.strictConfig().initialize();
+            Injector injector = app.initialize();
             injector.getInstance(Announcer.class).start();
         }
         catch (Throwable e) {

diff --git a/sample-server/src/test/java/io/airlift/sample/TestServer.java b/sample-server/src/test/java/io/airlift/sample/TestServer.java
@@ -92,7 +92,6 @@ public void setup()
                 new MainModule());
 
         Injector injector = app
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
 

diff --git a/skeleton-server/src/main/java/io/airlift/skeleton/Main.java b/skeleton-server/src/main/java/io/airlift/skeleton/Main.java
@@ -56,7 +56,7 @@ public static void main(String[] args)
                 new MainModule());
 
         try {
-            Injector injector = app.strictConfig().initialize();
+            Injector injector = app.initialize();
             injector.getInstance(Announcer.class).start();
         }
         catch (Throwable e) {

diff --git a/skeleton-server/src/test/java/io/airlift/skeleton/TestServer.java b/skeleton-server/src/test/java/io/airlift/skeleton/TestServer.java
@@ -46,7 +46,6 @@ public void setup()
                 new MainModule());
 
         Injector injector = app
-                .strictConfig()
                 .doNotInitializeLogging()
                 .initialize();
Original file line number	Diff line number	Diff line change
		@@ -1,6 +1,7 @@
		208

		- Only bind HTTPS config for HTTP server when HTTPS is enabled.
		- Make strict config default for Bootstrap. Non-strict is deprecated.

		207

Expand Down