You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@causeway.apache.org by da...@apache.org on 2023/07/29 10:51:06 UTC

[causeway] 01/01: CAUSEWAY-3543: looks up the MetaModelContext from the wicket application object

This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch CAUSEWAY-3543
in repository https://gitbox.apache.org/repos/asf/causeway.git

commit 9a03439169aec99c77721a2138fcba6d23ca9502
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sat Jul 29 11:41:55 2023 +0100

    CAUSEWAY-3543: looks up the MetaModelContext from the wicket application object
---
 .../AuthenticatedWebSessionForCauseway.java        | 48 ++++++++++++++++++----
 .../wicketapp/CausewayWicketApplication.java       |  9 ----
 ...nticatedWebSessionForCauseway_Authenticate.java |  7 +++-
 .../AuthenticatedWebSessionForCauseway_SignIn.java |  9 ++--
 ...nticatedWebSessionForCauseway_TestAbstract.java | 13 +++---
 5 files changed, 57 insertions(+), 29 deletions(-)

diff --git a/viewers/wicket/viewer/src/main/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway.java b/viewers/wicket/viewer/src/main/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway.java
index fbb80fa5ec..ed13a54a86 100644
--- a/viewers/wicket/viewer/src/main/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway.java
+++ b/viewers/wicket/viewer/src/main/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway.java
@@ -22,6 +22,8 @@ import java.util.Optional;
 import java.util.UUID;
 import java.util.function.UnaryOperator;
 
+import org.apache.causeway.viewer.wicket.viewer.wicketapp.CausewayWicketApplication;
+
 import org.apache.wicket.Session;
 import org.apache.wicket.authroles.authentication.AuthenticatedWebSession;
 import org.apache.wicket.authroles.authorization.strategies.role.Roles;
@@ -72,12 +74,46 @@ implements
         return (AuthenticatedWebSessionForCauseway) Session.get();
     }
 
-    @Getter protected transient MetaModelContext metaModelContext;
+    /**
+     * Just returns the {@link MetaModelContext} as held by the {@link CausewayWicketApplication application}.
+     *
+     * <p>
+     * Previously the {@link MetaModelContext} was injected by the {@link CausewayWicketApplication} when it created
+     * the session.  However, the field was marked as transient because an {@link AuthenticatedWebSession session}
+     * object (obviously) has to be persistent, so in certain circumstances it could become null, resulting in NPEs
+     * and 500s.
+     * </p>
+     *
+     * <p>
+     *     The design now is simply to look up the {@link MetaModelContext} each time it is required.  The dependent
+     *     {@link BookmarkedPagesModel} and {@link BreadcrumbModel} are created lazily
+     *
+     * @see #getBookmarkedPagesModel()
+     * @see #getBreadcrumbModel()
+     */
+    @Override
+    public MetaModelContext getMetaModelContext() {
+        return CausewayWicketApplication.get().getMetaModelContext();
+    }
 
-    @Getter
+    /**
+     * lazily populated in {@link #getBreadcrumbModel()}
+     */
     private BreadcrumbModel breadcrumbModel;
-    @Getter
+    @Override
+    public BreadcrumbModel getBreadcrumbModel() {
+        return breadcrumbModel != null ? breadcrumbModel : (breadcrumbModel = new BreadcrumbModel(getMetaModelContext()));
+    }
+
+
+    /**
+     * lazily populated in {@link #getBookmarkedPagesModel()}
+     */
     private BookmarkedPagesModel bookmarkedPagesModel;
+    @Override
+    public BookmarkedPagesModel getBookmarkedPagesModel() {
+        return bookmarkedPagesModel != null ? bookmarkedPagesModel : (bookmarkedPagesModel = new BookmarkedPagesModel(getMetaModelContext()));
+    }
 
     /**
      * As populated in {@link #signIn(String, String)}.
@@ -127,12 +163,6 @@ implements
 
     public AuthenticatedWebSessionForCauseway(final Request request) {
         super(request);
-    }
-
-    public void init(final MetaModelContext metaModelContext) {
-        this.metaModelContext = metaModelContext;
-        bookmarkedPagesModel = new BookmarkedPagesModel(metaModelContext);
-        breadcrumbModel = new BreadcrumbModel(metaModelContext);
         sessionGuid = UUID.randomUUID();
     }
 
diff --git a/viewers/wicket/viewer/src/main/java/org/apache/causeway/viewer/wicket/viewer/wicketapp/CausewayWicketApplication.java b/viewers/wicket/viewer/src/main/java/org/apache/causeway/viewer/wicket/viewer/wicketapp/CausewayWicketApplication.java
index 656ba3b812..37dbc10cb3 100644
--- a/viewers/wicket/viewer/src/main/java/org/apache/causeway/viewer/wicket/viewer/wicketapp/CausewayWicketApplication.java
+++ b/viewers/wicket/viewer/src/main/java/org/apache/causeway/viewer/wicket/viewer/wicketapp/CausewayWicketApplication.java
@@ -230,15 +230,6 @@ implements
         return new _PageFactory(this, super.newPageFactory());
     }
 
-    /*
-     * @since 2.0 ... overrides the default, to 'inject' the commonContext into new sessions
-     */
-    @Override
-    public Session newSession(final Request request, final Response response) {
-        val newSession = (AuthenticatedWebSessionForCauseway) super.newSession(request, response);
-        newSession.init(getMetaModelContext());
-        return newSession;
-    }
 
     /**
      * protected visibility to allow ad-hoc overriding of some other authentication strategy.
diff --git a/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_Authenticate.java b/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_Authenticate.java
index 41dec57621..d87f442216 100644
--- a/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_Authenticate.java
+++ b/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_Authenticate.java
@@ -85,10 +85,15 @@ class AuthenticatedWebSessionForCauseway_Authenticate {
     protected void setupWebSession() {
         webSession = new AuthenticatedWebSessionForCauseway(mockRequest) {
             private static final long serialVersionUID = 1L;
-            { metaModelContext = mmc; }
+
             @Override public AuthenticationManager getAuthenticationManager() {
                 return authMgr;
             }
+
+            @Override
+            public MetaModelContext getMetaModelContext() {
+                return mmc;
+            }
         };
     }
 
diff --git a/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_SignIn.java b/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_SignIn.java
index 4c3f5c286e..65df8139e0 100644
--- a/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_SignIn.java
+++ b/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_SignIn.java
@@ -91,14 +91,15 @@ class AuthenticatedWebSessionForCauseway_SignIn {
         webSession = new AuthenticatedWebSessionForCauseway(mockRequest) {
             private static final long serialVersionUID = 1L;
 
-            {
-                metaModelContext = mmc;
-            }
-
             @Override
             public AuthenticationManager getAuthenticationManager() {
                 return authMgr;
             }
+
+            @Override
+            public MetaModelContext getMetaModelContext() {
+                return mmc;
+            }
         };
 
 
diff --git a/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_TestAbstract.java b/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_TestAbstract.java
index deacb61de1..488f083226 100644
--- a/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_TestAbstract.java
+++ b/viewers/wicket/viewer/src/test/java/org/apache/causeway/viewer/wicket/viewer/integration/AuthenticatedWebSessionForCauseway_TestAbstract.java
@@ -34,7 +34,7 @@ public abstract class AuthenticatedWebSessionForCauseway_TestAbstract {
 
     protected Request mockRequest = Mockito.mock(Request.class);
     protected AuthenticationManager mockAuthMgr = Mockito.mock(AuthenticationManager.class);
-    protected MetaModelContext mockCommonContext = Mockito.mock(MetaModelContext.class);
+    protected MetaModelContext mmc = Mockito.mock(MetaModelContext.class);
     protected InteractionService mockInteractionService = Mockito.mock(InteractionService.class);
     protected ServiceRegistry mockServiceRegistry = Mockito.mock(ServiceRegistry.class);
 
@@ -48,7 +48,7 @@ public abstract class AuthenticatedWebSessionForCauseway_TestAbstract {
         .thenReturn(Locale.getDefault());
 
         Mockito
-        .when(mockCommonContext.getServiceRegistry())
+        .when(mmc.getServiceRegistry())
         .thenReturn(mockServiceRegistry);
 
         Mockito
@@ -65,14 +65,15 @@ public abstract class AuthenticatedWebSessionForCauseway_TestAbstract {
         webSession = new AuthenticatedWebSessionForCauseway(mockRequest) {
             private static final long serialVersionUID = 1L;
 
-            {
-                metaModelContext = mockCommonContext;
-            }
-
             @Override
             public AuthenticationManager getAuthenticationManager() {
                 return mockAuthMgr;
             }
+
+            @Override
+            public MetaModelContext getMetaModelContext() {
+                return mmc;
+            }
         };
     }