add ApplicationStartingEvent (thrown just before managed and web services startup);

fix stubs rest early startup causing problims with jersey registrations in application run

Author: xvik

CHANGELOG.md

@@ -42,6 +42,8 @@
     - (BREAKING) deprecated targetMain(): replaced with targetApp()
     - (BREAKING) StubRest default status declaration removed as not useful
       (required status could be declared now with the new request builder)
+* Add guicey event ApplicationStartingEvent thrown just before managed and web services startup
+* Fix stubs rest too early startup, causing problems with jersey registrations in application run method
 
 ### 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/lifecycle/GuiceyLifecycle.java

@@ -154,12 +154,29 @@ public enum GuiceyLifecycle {
      * This point is before
      * {@link io.dropwizard.core.Application#run(
      * io.dropwizard.core.Configuration, io.dropwizard.core.setup.Environment)}. Ideal point for jersey and jetty
-     * listeners installation (with shortcut event methods).
+     * listeners installation (with shortcut event methods). To run after application run use
+     * {@link #ApplicationStarting}.
      */
     ApplicationRun(ApplicationRunEvent.class),
 
     // -- Application.run()
 
+    /**
+     * Called after complete application configuration ({@link io.dropwizard.core.Application#run(
+     * io.dropwizard.core.Configuration, io.dropwizard.core.setup.Environment)} called), but before lifecycle
+     * startup (before managed objects run). Actually the same as jetty lifecycle started event
+     * ({@link org.eclipse.jetty.util.component.LifeCycle.Listener#lifeCycleStarting(
+     * org.eclipse.jetty.util.component.LifeCycle)}.
+     * <p>
+     * May be used as for additional services startup (after all initializations), executed before "started" point,
+     * often used for reporting. As an example, sub rest use this event to run jersey context after initialization.
+     * This event also will be fired in guicey tests ({@link ru.vyarus.dropwizard.guice.test.jupiter.TestGuiceyApp}
+     * which does not start the web part).
+     * <p>
+     * NOTE: jersey context is not started yet!
+     */
+    ApplicationStarting(ApplicationStartingEvent.class),
+
     /**
      * Jersey context starting. At this point jersey is starting and jetty is only initializing. Since that point
      * jersey {@link org.glassfish.jersey.internal.inject.InjectionManager} is accessible.

dropwizard-guicey/src/main/java/ru/vyarus/dropwizard/guice/module/lifecycle/GuiceyLifecycleAdapter.java

@@ -14,6 +14,7 @@
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.configuration.ManualExtensionsValidatedEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.ApplicationShutdownEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.ApplicationStartedEvent;
+import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.ApplicationStartingEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.ApplicationStoppedEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.JerseyConfigurationEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.JerseyExtensionsInstalledByEvent;
@@ -100,6 +101,9 @@ public void onEvent(final GuiceyLifecycleEvent event) {
             case ApplicationRun:
                 applicationRun((ApplicationRunEvent) event);
                 break;
+            case ApplicationStarting:
+                applicationStarting((ApplicationStartingEvent) event);
+                break;
             case JerseyConfiguration:
                 jerseyConfiguration((JerseyConfigurationEvent) event);
                 break;
@@ -335,6 +339,20 @@ protected void applicationRun(final ApplicationRunEvent event) {
         // empty
     }
 
+    /**
+     * Called after complete application configuration ({@link io.dropwizard.core.Application#run(
+     * io.dropwizard.core.Configuration, io.dropwizard.core.setup.Environment)} called), but before lifecycle
+     * startup (before managed objects run). Actually the same as jetty lifecycle started event
+     * ({@link org.eclipse.jetty.util.component.LifeCycle.Listener#lifeCycleStarting(
+     * org.eclipse.jetty.util.component.LifeCycle)}.
+     *
+     * @param event event object
+     * @see GuiceyLifecycle#ApplicationStarting
+     */
+    protected void applicationStarting(final ApplicationStartingEvent event) {
+        // empty
+    }
+
     /**
      * Jersey context starting. At this point jersey and jetty is only initializing. Guicey jersey configuration
      * is not yer performed. Since that point jersey {@link org.glassfish.jersey.internal.inject.InjectionManager}

dropwizard-guicey/src/main/java/ru/vyarus/dropwizard/guice/module/lifecycle/event/jersey/ApplicationStartingEvent.java

@@ -0,0 +1,32 @@
+package ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey;
+
+import ru.vyarus.dropwizard.guice.module.lifecycle.GuiceyLifecycle;
+import ru.vyarus.dropwizard.guice.module.lifecycle.event.JerseyPhaseEvent;
+import ru.vyarus.dropwizard.guice.module.lifecycle.internal.EventsContext;
+
+/**
+ * Called after complete application configuration ({@link io.dropwizard.core.Application#run(
+ * io.dropwizard.core.Configuration, io.dropwizard.core.setup.Environment)} called), but before lifecycle  startup
+ * (before managed objects run). Actually the same as jetty lifecycle started event
+ * ({@link org.eclipse.jetty.util.component.LifeCycle.Listener#lifeCycleStarting(
+ * org.eclipse.jetty.util.component.LifeCycle)}.
+ * <p>
+ * May be used as for additional services startup (after all initializations), executed before "started" point,
+ * often used for reporting. As an example, sub rest use this event to run jersey context after initialization.
+ * This event also will be fired in guicey tests ({@link ru.vyarus.dropwizard.guice.test.jupiter.TestGuiceyApp}
+ * which does not start the web part).
+ *
+ * @author Vyacheslav Rusakov
+ * @since 16.10.2025
+ */
+public class ApplicationStartingEvent extends JerseyPhaseEvent {
+
+    /**
+     * Create event.
+     *
+     * @param context even context
+     */
+    public ApplicationStartingEvent(final EventsContext context) {
+        super(GuiceyLifecycle.ApplicationStarting, context);
+    }
+}

dropwizard-guicey/src/main/java/ru/vyarus/dropwizard/guice/module/lifecycle/internal/LifecycleSupport.java

@@ -38,6 +38,7 @@
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.configuration.ManualExtensionsValidatedEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.ApplicationShutdownEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.ApplicationStartedEvent;
+import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.ApplicationStartingEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.ApplicationStoppedEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.JerseyConfigurationEvent;
 import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.JerseyExtensionsInstalledByEvent;
@@ -225,6 +226,7 @@ public void initialized() {
      * @param configurationTree parsed configuration
      * @param environment       environment
      */
+    @SuppressWarnings("checkstyle:AnonInnerLength")
     public void runPhase(final Configuration configuration,
                          final ConfigurationTree configurationTree,
                          final Environment environment) {
@@ -234,6 +236,11 @@ public void runPhase(final Configuration configuration,
         broadcast(new BeforeRunEvent(context));
         // fire after complete initialization (final meta-event)
         environment.lifecycle().addEventListener(new LifeCycle.Listener() {
+            @Override
+            public void lifeCycleStarting(LifeCycle event) {
+                applicationStarting();
+            }
+
             @Override
             public void lifeCycleStarted(final LifeCycle event) {
                 applicationStarted();
@@ -354,6 +361,13 @@ public void applicationRun() {
         broadcast(new ApplicationRunEvent(context));
     }
 
+    /**
+     * Application starting (application run method is called but neither managed nor jersey context not started).
+     */
+    private void applicationStarting() {
+        broadcast(new ApplicationStartingEvent(context));
+    }
+
     /**
      * Jersey configuration started.
      *

dropwizard-guicey/src/main/java/ru/vyarus/dropwizard/guice/test/rest/RestStubsHook.java

@@ -12,7 +12,7 @@
 import ru.vyarus.dropwizard.guice.module.context.info.ItemInfo;
 import ru.vyarus.dropwizard.guice.module.installer.feature.jersey.ResourceInstaller;
 import ru.vyarus.dropwizard.guice.module.lifecycle.GuiceyLifecycle;
-import ru.vyarus.dropwizard.guice.module.lifecycle.event.run.ApplicationRunEvent;
+import ru.vyarus.dropwizard.guice.module.lifecycle.event.jersey.ApplicationStartingEvent;
 import ru.vyarus.dropwizard.guice.test.rest.support.GuiceyJerseyTest;
 
 import java.util.Collections;
@@ -104,11 +104,12 @@ public void configure(final GuiceBundle.Builder builder) throws Exception {
                 // to indicate)
                 .disable(Disables.webExtension().and(Disables.jerseyExtension().negate()))
 
-                // started with listeners to run before application startup event, which is widely used for
-                // reporting
+                // started just before lifecycle startup (even if managed beans processing will be disabled,
+                // lifecycle events will work). Important to run before ApplicationStarted even which is often
+                // used by reporters
                 .listen(event -> {
-                    if (event.getType().equals(GuiceyLifecycle.ApplicationRun)) {
-                        final ApplicationRunEvent evt = (ApplicationRunEvent) event;
+                    if (event.getType().equals(GuiceyLifecycle.ApplicationStarting)) {
+                        final ApplicationStartingEvent evt = (ApplicationStartingEvent) event;
 
                         // manual registration required to reproduce production environment
                         registerDropwizardExtensions(evt.getEnvironment(),

dropwizard-guicey/src/test/groovy/ru/vyarus/dropwizard/guice/debug/StartupDiagnosticTest.java

@@ -96,6 +96,7 @@ void testGuiceyRunReport() {
                 "\t\t\t\tGuicey time                        : 111 ms \n" +
                 "\t\t\t\t\tInstallers time                    : 111 ms \n" +
                 "\t\t\t\t\tListeners time                     : 111 ms \n" +
+                "\t\t\t\t\t\tApplicationStartingEvent           : 111 ms \n" +
                 "\t\t\t\t\t\tApplicationStartedEvent            : 111 ms");
 
         Assertions.assertThat(out).contains("Application shutdown time: \n" +
@@ -177,6 +178,7 @@ void testDwRunReport() {
                 "\t\t\t\t\tGuicey time                        : 111 ms \n" +
                 "\t\t\t\t\t\tInstallers time                    : 111 ms \n" +
                 "\t\t\t\t\t\tListeners time                     : 111 ms \n" +
+                "\t\t\t\t\t\t\tApplicationStartingEvent           : 111 ms \n" +
                 "\t\t\t\t\t\t\tJerseyConfigurationEvent           : 111 ms \n" +
                 "\t\t\t\t\t\t\tJerseyExtensionsInstalledByEvent   : 111 ms \n" +
                 "\t\t\t\t\t\t\tJerseyExtensionsInstalledEvent     : 111 ms \n" +
@@ -244,8 +246,6 @@ void testRestStubsRunReport() {
                 "\t\t\t\t\tExtensions installation            : 111 ms \n" +
                 "\t\t\t\tInjector creation                  : 111 ms \n");
 
-
-        // NOTE: jersey events here because rest stub runs at rnu phase
         Assertions.assertThat(out).contains("\t\t\t\tListeners time                     : 111 ms \n" +
                 "\t\t\t\t\tBeforeRunEvent                     : 111 ms \n" +
                 "\t\t\t\t\tBundlesStartedEvent                : 111 ms \n" +
@@ -255,9 +255,6 @@ void testRestStubsRunReport() {
                 "\t\t\t\t\tExtensionsInstalledByEvent         : 111 ms \n" +
                 "\t\t\t\t\tExtensionsInstalledEvent           : 111 ms \n" +
                 "\t\t\t\t\tApplicationRunEvent                : 111 ms \n" +
-                "\t\t\t\t\tJerseyConfigurationEvent           : 111 ms \n" +
-                "\t\t\t\t\tJerseyExtensionsInstalledByEvent   : 111 ms \n" +
-                "\t\t\t\t\tJerseyExtensionsInstalledEvent     : 111 ms \n" +
                 "\n" +
                 "\t\tWeb server startup                 : 111 ms \n" +
                 "\t\t\tLifecycle simulation time          : 111 ms \n" +
@@ -267,6 +264,10 @@ void testRestStubsRunReport() {
                 "\t\t\t\tGuicey time                        : 111 ms \n" +
                 "\t\t\t\t\tInstallers time                    : 111 ms \n" +
                 "\t\t\t\t\tListeners time                     : 111 ms \n" +
+                "\t\t\t\t\t\tApplicationStartingEvent           : 111 ms \n" +
+                "\t\t\t\t\t\tJerseyConfigurationEvent           : 111 ms \n" +
+                "\t\t\t\t\t\tJerseyExtensionsInstalledByEvent   : 111 ms \n" +
+                "\t\t\t\t\t\tJerseyExtensionsInstalledEvent     : 111 ms \n" +
                 "\t\t\t\t\t\tApplicationStartedEvent            : 111 ms");
 
         Assertions.assertThat(out).contains("Application shutdown time: \n" +

dropwizard-guicey/src/test/groovy/ru/vyarus/dropwizard/guice/lifecycle/EventsConsistencyTest.groovy

@@ -287,6 +287,11 @@ class EventsConsistencyTest extends AbstractTest {
             assert !event.getExtensions().isEmpty()
         }
 
+        @Override
+        protected void applicationStarting(ApplicationStartingEvent event) {
+            injectorChecks(event)
+        }
+
         @Override
         protected void applicationStarted(ApplicationStartedEvent event) {
             jerseyCheck(event)

dropwizard-guicey/src/test/groovy/ru/vyarus/dropwizard/guice/test/rest/ApplicationRunCompatibilityTest.java

@@ -0,0 +1,47 @@
+package ru.vyarus.dropwizard.guice.test.rest;
+
+import io.dropwizard.core.Application;
+import io.dropwizard.core.Configuration;
+import io.dropwizard.core.setup.Bootstrap;
+import io.dropwizard.core.setup.Environment;
+import org.junit.jupiter.api.Test;
+import ru.vyarus.dropwizard.guice.GuiceBundle;
+import ru.vyarus.dropwizard.guice.test.TestSupport;
+import ru.vyarus.dropwizard.guice.test.rest.support.Resource1;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Vyacheslav Rusakov
+ * @since 16.10.2025
+ */
+public class ApplicationRunCompatibilityTest {
+    @Test
+    void testSimpleRun() throws Exception {
+        final RestStubsHook rest = RestStubsHook.builder()
+                .disableDropwizardExceptionMappers(true)
+                .build();
+        TestSupport.build(App.class)
+                .hooks(rest)
+                .runCore(injector -> {
+
+                    assertThat(injector.getInstance(Environment.class).jersey()
+                            .getResourceConfig().isRegistered(Resource1.class)).isTrue();
+                    return null;
+                });
+
+    }
+
+    public static class App extends Application<Configuration> {
+
+        @Override
+        public void initialize(Bootstrap<Configuration> bootstrap) {
+            bootstrap.addBundle(GuiceBundle.builder().build());
+        }
+
+        @Override
+        public void run(Configuration configuration, Environment environment) throws Exception {
+            environment.jersey().register(Resource1.class);
+        }
+    }
+}