CAUSEWAY-3641: simplified handling of the MetaModelContext singleton

apache · Nov 6, 2023 · ba64a7f · ba64a7f
1 parent 9ea799a
commit ba64a7f
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 54 deletions.
diff --git a/...rc/main/java/org/apache/causeway/core/metamodel/_testing/MetaModelContext_forTesting.java b/...rc/main/java/org/apache/causeway/core/metamodel/_testing/MetaModelContext_forTesting.java
@@ -114,6 +114,17 @@
 public final class MetaModelContext_forTesting
 implements MetaModelContext {
 
+    public static MetaModelContext_forTestingBuilder builder() {
+        return new MetaModelContext_forTestingBuilder() {
+            @Override
+            public MetaModelContext_forTesting build() {
+                var mmc = super.build();
+                MetaModelContext.INSTANCE_HOLDER.set(mmc);
+                return mmc;
+            }
+        };
+    }
+
     public static MetaModelContext buildDefault() {
         return MetaModelContext_forTesting.builder()
         .build();

diff --git a/.../metamodel/src/main/java/org/apache/causeway/core/metamodel/context/MetaModelContext.java b/.../metamodel/src/main/java/org/apache/causeway/core/metamodel/context/MetaModelContext.java
@@ -18,6 +18,12 @@
  */
 package org.apache.causeway.core.metamodel.context;
 
+import java.util.Optional;
+import java.util.concurrent.atomic.AtomicReference;
+
+import org.springframework.lang.Nullable;
+
+import org.apache.causeway.commons.internal.exceptions._Exceptions;
 import org.apache.causeway.core.metamodel.object.ManagedObject;
 
 /**
@@ -30,9 +36,25 @@ default MetaModelContext getMetaModelContext() {
         return this;
     }
 
+    // -- INSTANCE (SINGLETON)
+
+    static final AtomicReference<MetaModelContext> INSTANCE_HOLDER = new AtomicReference<>();
+    @Nullable
+    static MetaModelContext instanceNullable() {
+        return INSTANCE_HOLDER.get();
+    }
+    static Optional<MetaModelContext> instance() {
+        return Optional.ofNullable(instanceNullable());
+    }
+    static MetaModelContext instanceElseFail() {
+        return instance()
+                .orElseThrow(()->_Exceptions.noSuchElement("MetaModelContext not yet or no longer available."));
+    }
+
     // -- EXTRACTORS
 
-    public static MetaModelContext from(final ManagedObject adapter) {
+    @Deprecated
+    static MetaModelContext from(final ManagedObject adapter) {
         return adapter.getSpecification().getMetaModelContext();
     }
 

diff --git a/...rc/main/java/org/apache/causeway/core/metamodel/context/MetaModelContext_usingSpring.java b/...rc/main/java/org/apache/causeway/core/metamodel/context/MetaModelContext_usingSpring.java
@@ -64,6 +64,14 @@ public MetaModelContext_usingSpring(final _IocContainer iocContainer) {
         this.iocContainer = iocContainer;
     }
 
+    /**
+     * Called by Spring as instructed by bean declaration
+     * {@link MetaModelContexts#metaModelContext(CausewaySystemEnvironment)}.
+     */
+    void onDestroy() {
+        MetaModelContext.INSTANCE_HOLDER.set(null);
+    }
+
     @Getter(lazy=true)
     private final CausewaySystemEnvironment systemEnvironment =
     getSingletonElseFail(CausewaySystemEnvironment.class);

diff --git a/...metamodel/src/main/java/org/apache/causeway/core/metamodel/context/MetaModelContexts.java b/...metamodel/src/main/java/org/apache/causeway/core/metamodel/context/MetaModelContexts.java
@@ -19,7 +19,6 @@
 package org.apache.causeway.core.metamodel.context;
 
 import javax.inject.Named;
-import javax.inject.Singleton;
 
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -37,9 +36,12 @@
 @Named(CausewayModuleCoreMetamodel.NAMESPACE + ".MetaModelContexts")
 public class MetaModelContexts {
 
-    @Bean @Singleton @Primary
+    @Primary
+    @Bean(destroyMethod = "onDestroy")
     public MetaModelContext metaModelContext(final CausewaySystemEnvironment systemEnvironment) {
-        return new MetaModelContext_usingSpring(systemEnvironment.getIocContainer());
+        var mmc = new MetaModelContext_usingSpring(systemEnvironment.getIocContainer());
+        MetaModelContext.INSTANCE_HOLDER.set(mmc);
+        return mmc;
     }
 
 }
diff --git a/...et/model/src/main/java/org/apache/causeway/viewer/wicket/model/util/ComponentHintKey.java b/...et/model/src/main/java/org/apache/causeway/viewer/wicket/model/util/ComponentHintKey.java
@@ -163,7 +163,7 @@ public HintStore getHintStore() {
     private <X> X computeIfAbsent(final Class<X> type, final X existingIfAny) {
         return existingIfAny!=null
                 ? existingIfAny
-                : WktContext.getMetaModelContext().lookupServiceElseFail(type);
+                : MetaModelContext.instanceElseFail().lookupServiceElseFail(type);
     }
 
 }
diff --git a/...s/wicket/model/src/main/java/org/apache/causeway/viewer/wicket/model/util/WktContext.java b/...s/wicket/model/src/main/java/org/apache/causeway/viewer/wicket/model/util/WktContext.java
@@ -18,20 +18,12 @@
  */
 package org.apache.causeway.viewer.wicket.model.util;
 
-import java.util.Optional;
-
-import org.apache.wicket.Application;
-import org.apache.wicket.ThreadContext;
 import org.apache.wicket.core.request.handler.ListenerRequestHandler;
 import org.apache.wicket.request.cycle.RequestCycle;
 import org.springframework.lang.Nullable;
 
-import org.apache.causeway.commons.internal.base._Casts;
-import org.apache.causeway.commons.internal.base._Strings;
-import org.apache.causeway.core.metamodel.context.HasMetaModelContext;
 import org.apache.causeway.core.metamodel.context.MetaModelContext;
 
-import lombok.NonNull;
 import lombok.experimental.UtilityClass;
 
 /**
@@ -40,45 +32,11 @@
 @UtilityClass
 public class WktContext {
 
-    @Nullable
-    public String getApplicationKey() {
-        final Application application = ThreadContext.getApplication(); // nullable
-        return Optional.ofNullable(application)
-                .map(Application::getName)
-                .orElse(null);
-    }
-
-    @Nullable
-    public MetaModelContext getMetaModelContext() {
-        final Application application = ThreadContext.getApplication(); // nullable
-        return _Casts.castTo(HasMetaModelContext.class, application)
-                .map(HasMetaModelContext::getMetaModelContext)
-                .orElse(null);
-    }
-
-    @Nullable
-    public MetaModelContext getMetaModelContext(final @NonNull String applicationKey) {
-        final Application application = Application.get(applicationKey); // nullable
-        return _Casts.castTo(HasMetaModelContext.class, application)
-                .map(HasMetaModelContext::getMetaModelContext)
-                .orElse(null);
-    }
-
     @Nullable
     public MetaModelContext computeIfAbsent(final MetaModelContext mmc) {
         return mmc!=null
                 ? mmc
-                : getMetaModelContext();
-    }
-
-    @Nullable
-    public MetaModelContext computeIfAbsent(
-            final @Nullable MetaModelContext mmc, final @Nullable String applicationKey) {
-        return mmc!=null
-                ? mmc
-                : _Strings.isEmpty(applicationKey)
-                        ? getMetaModelContext()
-                        : getMetaModelContext(applicationKey);
+                : MetaModelContext.instanceNullable();
     }
 
     public void pageReload() {

diff --git a/viewers/wicket/ui/src/main/java/org/apache/causeway/viewer/wicket/ui/util/WktTooltips.java b/viewers/wicket/ui/src/main/java/org/apache/causeway/viewer/wicket/ui/util/WktTooltips.java
@@ -17,7 +17,6 @@
 package org.apache.causeway.viewer.wicket.ui.util;
 
 import java.time.Duration;
-import java.util.Optional;
 
 import org.apache.wicket.Component;
 import org.apache.wicket.model.IModel;
@@ -30,7 +29,6 @@
 import org.apache.causeway.core.metamodel.context.MetaModelContext;
 import org.apache.causeway.viewer.commons.model.decorators.TooltipDecorator.TooltipDecorationModel;
 import org.apache.causeway.viewer.commons.model.layout.UiPlacementDirection;
-import org.apache.causeway.viewer.wicket.model.util.WktContext;
 import org.apache.causeway.viewer.wicket.ui.components.widgets.linkandlabel.ActionLink;
 import org.apache.causeway.viewer.wicket.ui.util.ExtendedPopoverConfig.PopoverBoundary;
 
@@ -205,7 +203,7 @@ private PopoverConfig createPopoverConfigDefault() {
      * Lookup in config, else returns default.
      */
     private static TextMode getTooltipTextMode() {
-        val textMode = Optional.ofNullable(WktContext.getMetaModelContext())
+        val textMode = MetaModelContext.instance()
                 .map(MetaModelContext::getConfiguration)
                 .map(cfg->cfg.getViewer().getWicket().getTooltipTextMode())
                 .orElseGet(TextMode::defaults);

diff --git a/.../apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway.java b/.../apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway.java
@@ -105,7 +105,7 @@ public static AuthenticatedWebSessionForCauseway get() {
     @Nullable
     @Override
     public MetaModelContext getMetaModelContext() {
-        return mmc = WktContext.computeIfAbsent(mmc, applicationKey);
+        return mmc = WktContext.computeIfAbsent(mmc);
     }
 
     /**
@@ -162,7 +162,6 @@ public void setPrimedInteractionContext(final @NonNull InteractionContext authen
     @Getter
     private UUID sessionGuid;
     private String cachedSessionId;
-    private @Nullable String applicationKey; // nullable ... JUnit support
 
     /**
      * Optionally the current HttpSession's Id,
@@ -181,7 +180,6 @@ public Optional<String> getCachedSessionId() {
     public AuthenticatedWebSessionForCauseway(final Request request) {
         super(request);
         sessionGuid = UUID.randomUUID();
-        applicationKey = WktContext.getApplicationKey();
     }
 
     @Override