deprecate: deprecate DynamicTheme.initialize(AppShellSettings)

Author: javier-godoy

README.md

@@ -67,20 +67,7 @@ public class AppShellConfiguratorImpl implements AppShellConfigurator {
 
 The annotation is read when the application starts, so the default theme also applies to sessions that did not load `index.html` (for example, after the server restarts while a page is open, or when `index.html` is served from a cache).
 
-Alternatively, `DynamicTheme` can be initialized in the `configurePage` method of the `AppShellConfigurator`. With this approach, the default theme is only known after `index.html` has been served at least once.
-
-```java
-public class AppShellConfiguratorImpl implements AppShellConfigurator {
-
-  @Override
-  public void configurePage(AppShellSettings settings) {
-    if (DynamicTheme.isFeatureSupported()) {
-      DynamicTheme.LUMO.initialize(settings);
-    }
-  }
-
-}
-```
+Initializing `DynamicTheme` from the `configurePage` method of the `AppShellConfigurator` (i.e. calling `DynamicTheme.LUMO.initialize(settings)`) is deprecated, because the default theme is only known after `index.html` has been served at least once. Replace that call by annotating the `AppShellConfigurator` with `@DefaultDynamicTheme`.
 
 When targeting Vaadin 14-25 or 23-25, the `AppShellConfigurator` approach cannot be used due to framework and library limitations.
 To resolve this, you must create a configuration file `src/test/resources/META-INF/dynamic-theme.properties` with the following content:

base/src/main/java/com/flowingcode/vaadin/addons/demo/DynamicTheme.java

@@ -169,7 +169,12 @@ public static DynamicTheme getCurrent() {
    * @throws UnsupportedOperationException if the runtime Vaadin version is older than 25
    * @throws IllegalStateException if the {@link AppShellConfigurator} is configured with the legacy
    *         {@link Theme} annotation
+   * @deprecated Annotate the {@link AppShellConfigurator} with {@link DefaultDynamicTheme} instead.
+   *             This method is only invoked when {@code index.html} is generated, therefore the
+   *             default theme is unknown to sessions that did not load {@code index.html} until it
+   *             has been served at least once.
    */
+  @Deprecated(since = "5.5.0", forRemoval = true)
   public void initialize(AppShellSettings settings) {
     assertFeatureSupported();
     assertNotLegacyTheme();

base/src/test/java/com/flowingcode/vaadin/addons/demo/AppShellConfiguratorImpl.java

@@ -20,15 +20,8 @@
 package com.flowingcode.vaadin.addons.demo;
 
 import com.vaadin.flow.component.page.AppShellConfigurator;
-import com.vaadin.flow.server.AppShellSettings;
 
+@DefaultDynamicTheme(DynamicTheme.LUMO)
 public class AppShellConfiguratorImpl implements AppShellConfigurator {
 
-  @Override
-  public void configurePage(AppShellSettings settings) {
-    if (DynamicTheme.isFeatureSupported()) {
-      DynamicTheme.LUMO.initialize(settings);
-    }
-  }
-
 }