object stored in shared state, implementing AutoClosable, would be closed on application shutdown;

add SharedConfigurationState.lookupOrCreate method to simplify static state usage

Author: xvik

CHANGELOG.md

@@ -7,6 +7,9 @@
     - Add `useApacheClient()` (shortcut) method into extension and generic builders
 * @StubRest RestClient:
     - Add patch method shortcuts
+* Shared state:
+    - State objects, implementing AutoClosable, now would be closed on application shutdown
+    - Add SharedConfigurationState.lookupOrCreate method to simplify static state usage
 
 ### 7.2.1 (2025-05-12)
 * Fix NoClassDefFoundError on guicey startup due to junit classes leak into core (#428)

dropwizard-guicey/src/main/java/ru/vyarus/dropwizard/guice/module/context/SharedConfigurationState.java

@@ -55,6 +55,10 @@
  * Shared value could be set only once (to prevent complex situations with state substitutions). It is advised
  * to initialize shared value only in initialization phase (to avoid potential static access errors).
  * <p>
+ * If stored state object implements {@link AutoCloseable} it will be automatically closed on application shutdown
+ * (which is closed in most cases under tests). This is mostly useful to guarantee resource cleanup after the test
+ * (when it can't be managed directly).
+ * <p>
  * Objects available in shared state by default: {@link io.dropwizard.core.setup.Bootstrap},
  * {@link io.dropwizard.core.Configuration}, {@link Environment},
  * {@link ru.vyarus.dropwizard.guice.module.yaml.ConfigurationTree}, {@link com.google.inject.Injector},
@@ -312,7 +316,17 @@ public Set<String> getKeys() {
      */
     @VisibleForTesting
     public void shutdown() {
-        STATE.remove(application);
+        getKeys().forEach(key -> {
+            Object res = get(key);
+            if (res instanceof AutoCloseable) {
+                try {
+                    ((AutoCloseable) res).close();
+                } catch (Exception e) {}
+            }
+        });
+        if (application != null) {
+            STATE.remove(application);
+        }
     }
 
     @Override
@@ -434,6 +448,38 @@ public static <V> V lookupOrFail(final Environment environment,
                 .orElseThrow(() -> new IllegalStateException(Strings.lenientFormat(message, args)));
     }
 
+    /**
+     * Shortcut for {@link #lookup(Application, Class)} to get ot initialize shared state value.
+     *
+     * @param application application instance
+     * @param key         shared object key
+     * @param defSupplier   default value supplier (used when state is not exists to initialize it)
+     * @param <V>         shared object type
+     * @return value (never null)
+     * @throws IllegalStateException if value not available
+     */
+    public static <V> V lookupOrCreate(final Application application,
+                                     final Class<V> key,
+                                     final Supplier<V> defSupplier) {
+        return getOrFail(application, "State is not available yet").get(key, defSupplier);
+    }
+
+    /**
+     * Shortcut for {@link #lookup(Environment, Class)}  to get ot initialize shared state value.
+     *
+     * @param environment environment instance
+     * @param key         shared object key
+     * @param defSupplier   default value supplier (used when state is not exists to initialize it)
+     * @param <V>         shared object type
+     * @return value (never null)
+     * @throws IllegalStateException if value not available
+     */
+    public static <V> V lookupOrCreate(final Environment environment,
+                                     final Class<V> key,
+                                     final Supplier<V> defSupplier) {
+        return getOrFail(environment, "State is not available yet").get(key, defSupplier);
+    }
+
     /**
      * Static lookup for entire application registry.
      *
@@ -501,6 +547,7 @@ public static SharedConfigurationState getOrFail(final Environment environment,
      */
     @VisibleForTesting
     public static void clear() {
+        STATE.values().forEach(SharedConfigurationState::shutdown);
         STATE.clear();
     }
 

dropwizard-guicey/src/test/groovy/ru/vyarus/dropwizard/guice/config/sharedstate/SharedStateTest.groovy

@@ -74,10 +74,14 @@ class SharedStateTest extends Specification {
         SharedConfigurationState.lookup(app, App).get() == app
         SharedConfigurationState.lookupOrFail(app, App, "2") == app
 
+        and: "access or create work"
+        SharedConfigurationState.lookupOrCreate(app, CustomState, () -> new CustomState())
+        SharedConfigurationState.lookupOrFail(app, CustomState, "err")
+
         when: "to string state"
         res = state.toString()
         then: "ok"
-        res == "Shared state with 1 objects: $App.name"
+        res == "Shared state with 2 objects: $CustomState.name, $App.name"
 
     }
 
@@ -159,10 +163,43 @@ class SharedStateTest extends Specification {
         SharedConfigurationState.lookup(environment, App).get() == app
         SharedConfigurationState.lookupOrFail(environment, App, "2") == app
 
+        and: "access and create"
+        SharedConfigurationState.lookupOrCreate(environment, CustomState, () -> new CustomState())
+        SharedConfigurationState.lookupOrFail(environment, CustomState, "err")
+
         when: "to string state"
         res = state.toString()
         then: "ok"
-        res == "Shared state with 1 objects: $App.name"
+        res == "Shared state with 2 objects: $CustomState.name, $App.name"
+    }
+
+    def "Check auto closable support on shutdown"() {
+
+        setup: "prepare state"
+        SharedConfigurationState state = new SharedConfigurationState()
+
+        when: "register closable object"
+        CustomState val = new CustomState()
+        state.put(CustomState, val)
+        state.shutdown()
+
+        then: "cleanup called"
+        val.called
+    }
+
+    def "Check auto closable support on clean"() {
+
+        setup: "prepare state"
+        SharedConfigurationState state = new SharedConfigurationState()
+        state.assignTo(new App())
+
+        when: "register closable object"
+        CustomState val = new CustomState()
+        state.put(CustomState, val)
+        SharedConfigurationState.clear()
+
+        then: "cleanup called"
+        val.called
     }
 
     static class App extends Application<Configuration> {
@@ -175,4 +212,14 @@ class SharedStateTest extends Specification {
         void run(Configuration configuration, Environment environment) throws Exception {
         }
     }
+
+    static class CustomState implements AutoCloseable {
+
+        boolean called
+
+        @Override
+        void close() throws Exception {
+            called = true
+        }
+    }
 }