You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2019/10/30 15:03:26 UTC

[isis] 07/07: ISIS-2158: remove obsolete layer of abstraction: MetaModelDeficiencies

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

ahuber pushed a commit to branch v2
in repository https://gitbox.apache.org/repos/asf/isis.git

commit af84c1c15fe2d8e151618c93f0ab297a4be8c89d
Author: Andi Huber <ah...@apache.org>
AuthorDate: Wed Oct 30 15:47:41 2019 +0100

    ISIS-2158: remove obsolete layer of abstraction: MetaModelDeficiencies
    
    - with previous commits finally reinstates validation error handling
---
 .../validator/MetaModelDeficiencies.java           | 49 ----------------------
 .../validator/MetaModelInvalidException.java       |  7 +++-
 .../specloader/validator/ValidationFailures.java   | 33 ++++++++++-----
 .../isis/runtime/system/context/IsisContext.java   | 29 +++++--------
 .../validate/ValidateDomainModel.java              |  2 +-
 .../IsisRestfulObjectsSessionFilter.java           | 27 ++++++------
 .../wicket/viewer/IsisWicketApplication.java       |  9 ++--
 .../integration/wicket/WebRequestCycleForIsis.java | 48 +++++++++++----------
 8 files changed, 82 insertions(+), 122 deletions(-)

diff --git a/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/MetaModelDeficiencies.java b/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/MetaModelDeficiencies.java
deleted file mode 100644
index b4bd481..0000000
--- a/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/MetaModelDeficiencies.java
+++ /dev/null
@@ -1,49 +0,0 @@
-/*
- *  Licensed to the Apache Software Foundation (ASF) under one
- *  or more contributor license agreements.  See the NOTICE file
- *  distributed with this work for additional information
- *  regarding copyright ownership.  The ASF licenses this file
- *  to you under the Apache License, Version 2.0 (the
- *  "License"); you may not use this file except in compliance
- *  with the License.  You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing,
- *  software distributed under the License is distributed on an
- *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- *  KIND, either express or implied.  See the License for the
- *  specific language governing permissions and limitations
- *  under the License.
- */
-package org.apache.isis.metamodel.specloader.validator;
-
-import java.io.Serializable;
-import java.util.Collection;
-
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
-import lombok.val;
-
-@RequiredArgsConstructor(staticName="of")
-public class MetaModelDeficiencies implements Serializable {
-
-    private static final long serialVersionUID = 1L;
-
-    @Getter private final Collection<String> validationErrors;
-
-    public String getValidationErrorsAsString() {
-        return concatenate(validationErrors);
-    }
-
-    // //////////////////////////////////////
-
-    private static String concatenate(Collection<String> messages) {
-        val buf = new StringBuilder();
-        int i=0;
-        for (val message : messages) {
-            buf.append(++i).append(": ").append(message).append("\n");
-        }
-        return buf.toString();
-    }
-}
diff --git a/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/MetaModelInvalidException.java b/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/MetaModelInvalidException.java
index 0a8b2dc..90e1dde 100644
--- a/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/MetaModelInvalidException.java
+++ b/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/MetaModelInvalidException.java
@@ -19,12 +19,15 @@
 
 package org.apache.isis.metamodel.specloader.validator;
 
+import java.util.Optional;
+
 public class MetaModelInvalidException extends IllegalStateException {
 
     private static final long serialVersionUID = 1L;
 
-    public MetaModelInvalidException(MetaModelDeficiencies metaModelDeficiencies) {
-        super(metaModelDeficiencies.getValidationErrorsAsString());
+    public MetaModelInvalidException(Optional<String> failuresAsLineNumberedString) {
+        // fails if failuresAsLineNumberedString is empty, which would indicate misuse
+        super(failuresAsLineNumberedString.get());  
     }
 
 }
diff --git a/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/ValidationFailures.java b/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/ValidationFailures.java
index 8f26eb7..4e454cc 100644
--- a/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/ValidationFailures.java
+++ b/core/metamodel/src/main/java/org/apache/isis/metamodel/specloader/validator/ValidationFailures.java
@@ -18,9 +18,11 @@
  */
 package org.apache.isis.metamodel.specloader.validator;
 
+import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.Iterator;
-import java.util.List;
+import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
 
@@ -31,7 +33,6 @@ import lombok.val;
 
 public final class ValidationFailures implements Iterable<ValidationFailure> {
 
-    
     private final Set<ValidationFailure> failures = _Sets.newConcurrentHashSet();
 
     public void add(Identifier origin, String pattern, Object... arguments) {
@@ -53,12 +54,11 @@ public final class ValidationFailures implements Iterable<ValidationFailure> {
         return Collections.unmodifiableSet(failures);
     }
     
-    public List<String> getMessages() {
+    public ArrayList<String> getMessages() { // <-- ensure serializable
         val messages = failures.stream() // already sorted
         .map(ValidationFailure::getMessage)
-        .collect(Collectors.toList());
-        
-        return Collections.unmodifiableList(messages);
+        .collect(Collectors.toCollection(ArrayList::new));
+        return messages;
     }
 
     public int getNumberOfFailures() {
@@ -70,15 +70,26 @@ public final class ValidationFailures implements Iterable<ValidationFailure> {
         return getFailures().iterator();
     }
     
-    public boolean occurred() {
+    public boolean hasFailures() {
         return !failures.isEmpty();
     }
+    
+    public Optional<String> getAsLineNumberedString() {
+        if (!hasFailures()) {
+            return Optional.empty();
+        }
+        return Optional.of(toLineNumberedString(getMessages()));
+    }
+
+    // -- HELPER
 
-    public MetaModelDeficiencies getDeficienciesIfAny() {
-        if (!occurred()) {
-            return null;
+    private static String toLineNumberedString(Collection<String> messages) {
+        val buf = new StringBuilder();
+        int i=0;
+        for (val message : messages) {
+            buf.append(++i).append(": ").append(message).append("\n");
         }
-        return MetaModelDeficiencies.of(getMessages());
+        return buf.toString();
     }
 
 
diff --git a/core/runtime/src/main/java/org/apache/isis/runtime/system/context/IsisContext.java b/core/runtime/src/main/java/org/apache/isis/runtime/system/context/IsisContext.java
index 841493b..b64d888 100644
--- a/core/runtime/src/main/java/org/apache/isis/runtime/system/context/IsisContext.java
+++ b/core/runtime/src/main/java/org/apache/isis/runtime/system/context/IsisContext.java
@@ -26,7 +26,6 @@ import java.util.function.Supplier;
 import org.apache.isis.commons.internal.context._Context;
 import org.apache.isis.metamodel.adapter.ObjectAdapter;
 import org.apache.isis.metamodel.adapter.oid.RootOid;
-import org.apache.isis.metamodel.specloader.validator.MetaModelDeficiencies;
 import org.apache.isis.metamodel.specloader.validator.MetaModelInvalidException;
 import org.apache.isis.runtime.system.persistence.PersistenceSession;
 import org.apache.isis.runtime.system.session.IsisSession;
@@ -42,14 +41,6 @@ import lombok.val;
 public interface IsisContext {
 
     /**
-     * Populated only if the meta-model was found to be invalid.
-     * @return null, if there is none
-     */
-    public static MetaModelDeficiencies getMetaModelDeficienciesIfAny() {
-        return _Context.getIfAny(MetaModelDeficiencies.class);
-    }
-
-    /**
      *
      * @return Isis's default class loader
      */
@@ -81,6 +72,17 @@ public interface IsisContext {
     public static Optional<IsisSession> getCurrentIsisSession() {
         return IsisSession.current();
     }
+    
+    /**
+     * @return framework's current AuthenticationSession (if any)
+     * @throws IllegalStateException - if IsisSessionFactory not resolvable
+     */
+    public static Optional<AuthenticationSession> getAuthenticationSession() {
+        return getCurrentIsisSession()
+                .map(IsisSession::getAuthenticationSession);
+    }
+    
+    // -- DEPRECATIONS
 
     /**
      * TODO [2033] its unclear whether there is only one or multiple
@@ -102,14 +104,5 @@ public interface IsisContext {
         }; 
     }
 
-    /**
-     * @return framework's current AuthenticationSession (if any)
-     * @throws IllegalStateException - if IsisSessionFactory not resolvable
-     */
-    public static Optional<AuthenticationSession> getAuthenticationSession() {
-        return getCurrentIsisSession()
-                .map(IsisSession::getAuthenticationSession);
-    }
-
 
 }
diff --git a/core/testsupport/integtestsupport/src/main/java/org/apache/isis/integtestsupport/validate/ValidateDomainModel.java b/core/testsupport/integtestsupport/src/main/java/org/apache/isis/integtestsupport/validate/ValidateDomainModel.java
index 0c43144..639d080 100644
--- a/core/testsupport/integtestsupport/src/main/java/org/apache/isis/integtestsupport/validate/ValidateDomainModel.java
+++ b/core/testsupport/integtestsupport/src/main/java/org/apache/isis/integtestsupport/validate/ValidateDomainModel.java
@@ -63,7 +63,7 @@ public class ValidateDomainModel implements Runnable {
             });
         }
 
-        if (validationFailures.occurred()) {
+        if (validationFailures.hasFailures()) {
             throwFailureException(
                     validationFailures.getNumberOfFailures() + " problems found.", 
                     validationFailures.getMessages());
diff --git a/core/viewer-restfulobjects/server/src/main/java/org/apache/isis/viewer/restfulobjects/IsisRestfulObjectsSessionFilter.java b/core/viewer-restfulobjects/server/src/main/java/org/apache/isis/viewer/restfulobjects/IsisRestfulObjectsSessionFilter.java
index f5d6190..4076472 100644
--- a/core/viewer-restfulobjects/server/src/main/java/org/apache/isis/viewer/restfulobjects/IsisRestfulObjectsSessionFilter.java
+++ b/core/viewer-restfulobjects/server/src/main/java/org/apache/isis/viewer/restfulobjects/IsisRestfulObjectsSessionFilter.java
@@ -29,7 +29,6 @@ import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import javax.inject.Inject;
 import javax.servlet.Filter;
 import javax.servlet.FilterChain;
 import javax.servlet.FilterConfig;
@@ -44,7 +43,8 @@ import org.apache.isis.commons.internal.collections._Lists;
 import org.apache.isis.commons.internal.factory.InstanceUtil;
 import org.apache.isis.config.SystemConstants;
 import org.apache.isis.metamodel.commons.StringExtensions;
-import org.apache.isis.runtime.system.context.IsisContext;
+import org.apache.isis.metamodel.specloader.SpecificationLoader;
+import org.apache.isis.metamodel.specloader.validator.MetaModelInvalidException;
 import org.apache.isis.runtime.system.session.IsisSessionFactory;
 import org.apache.isis.webapp.IsisWebAppUtils;
 import org.apache.isis.webapp.auth.AuthenticationSessionStrategy;
@@ -150,7 +150,8 @@ public class IsisRestfulObjectsSessionFilter implements Filter {
         return Pattern.compile(".*\\." + input);
     };
 
-    @Inject private IsisSessionFactory isisSessionFactory;
+    private IsisSessionFactory isisSessionFactory;
+    private SpecificationLoader specificationLoader;
     
     private List<String> passThruList = Collections.emptyList();
 
@@ -234,6 +235,8 @@ public class IsisRestfulObjectsSessionFilter implements Filter {
     private WhenNoSession whenNotAuthenticated;
     private String redirectToOnException;
     private Collection<Pattern> ignoreExtensions;
+
+
     
 
     // /////////////////////////////////////////////////////////////////
@@ -250,6 +253,7 @@ public class IsisRestfulObjectsSessionFilter implements Filter {
         
         val servletContext  = config.getServletContext();
         isisSessionFactory = IsisWebAppUtils.getManagedBean(IsisSessionFactory.class, servletContext);
+        specificationLoader = IsisWebAppUtils.getManagedBean(SpecificationLoader.class, servletContext);
     }
 
     /**
@@ -337,8 +341,9 @@ public class IsisRestfulObjectsSessionFilter implements Filter {
     public void doFilter(final ServletRequest request, final ServletResponse response, final FilterChain chain) throws IOException, ServletException {
 
         requires(isisSessionFactory, "isisSessionFactory");
+        requires(specificationLoader, "specificationLoader");
         
-        ensureMetamodelIsValid();
+        ensureMetamodelIsValid(specificationLoader);
 
         val httpServletRequest = (HttpServletRequest) request;
         val httpServletResponse = (HttpServletResponse) response;
@@ -395,16 +400,10 @@ public class IsisRestfulObjectsSessionFilter implements Filter {
     }
 
 
-    private static void ensureMetamodelIsValid() {
-        val metaModelDeficiencies = IsisContext.getMetaModelDeficienciesIfAny();
-
-        if(metaModelDeficiencies != null) {
-            val validationErrors = metaModelDeficiencies.getValidationErrors();
-            val buf = new StringBuilder();
-            for (String validationError : validationErrors) {
-                buf.append(validationError).append("\n");
-            }
-            throw new IllegalStateException("Metamodel validation errors: \n" + buf.toString());
+    private static void ensureMetamodelIsValid(SpecificationLoader specificationLoader) {
+        val validationResult = specificationLoader.getValidationResult();
+        if(validationResult.hasFailures()) {
+            throw new MetaModelInvalidException(validationResult.getAsLineNumberedString());
         }
     }
 
diff --git a/core/viewer-wicket/impl/src/main/java/org/apache/isis/viewer/wicket/viewer/IsisWicketApplication.java b/core/viewer-wicket/impl/src/main/java/org/apache/isis/viewer/wicket/viewer/IsisWicketApplication.java
index ae5f974..391b436 100644
--- a/core/viewer-wicket/impl/src/main/java/org/apache/isis/viewer/wicket/viewer/IsisWicketApplication.java
+++ b/core/viewer-wicket/impl/src/main/java/org/apache/isis/viewer/wicket/viewer/IsisWicketApplication.java
@@ -71,9 +71,8 @@ import org.apache.isis.commons.internal.environment.IsisSystemEnvironment;
 import org.apache.isis.config.IsisConfiguration;
 import org.apache.isis.metamodel.MetaModelContext;
 import org.apache.isis.metamodel.spec.ManagedObject;
-import org.apache.isis.metamodel.specloader.validator.MetaModelDeficiencies;
+import org.apache.isis.metamodel.specloader.validator.ValidationFailures;
 import org.apache.isis.runtime.memento.ObjectAdapterMemento;
-import org.apache.isis.runtime.system.context.IsisContext;
 import org.apache.isis.viewer.wicket.model.isis.WicketViewerSettings;
 import org.apache.isis.viewer.wicket.model.isis.WicketViewerSettingsAccessor;
 import org.apache.isis.viewer.wicket.model.models.PageType;
@@ -283,9 +282,9 @@ IsisWebAppCommonContext.Provider {
             SharedResources sharedResources = getSharedResources();
 
             //XXX lombok issue, cannot use val when super is referenced in same method
-            MetaModelDeficiencies metaModelDeficiencies = IsisContext.getMetaModelDeficienciesIfAny();
-            if(metaModelDeficiencies != null) {
-                log(metaModelDeficiencies.getValidationErrors());
+            ValidationFailures validationResult = commonContext.getSpecificationLoader().getValidationResult();
+            if(validationResult.hasFailures()) {
+                log(validationResult.getMessages());
             }
 
             if(systemEnvironment.isPrototyping()) {
diff --git a/core/viewer-wicket/impl/src/main/java/org/apache/isis/viewer/wicket/viewer/integration/wicket/WebRequestCycleForIsis.java b/core/viewer-wicket/impl/src/main/java/org/apache/isis/viewer/wicket/viewer/integration/wicket/WebRequestCycleForIsis.java
index 1fa88e8..c0023cf 100644
--- a/core/viewer-wicket/impl/src/main/java/org/apache/isis/viewer/wicket/viewer/integration/wicket/WebRequestCycleForIsis.java
+++ b/core/viewer-wicket/impl/src/main/java/org/apache/isis/viewer/wicket/viewer/integration/wicket/WebRequestCycleForIsis.java
@@ -58,6 +58,7 @@ import org.apache.isis.runtime.system.session.IsisSession;
 import org.apache.isis.runtime.system.session.IsisSessionFactory;
 import org.apache.isis.security.authentication.AuthenticationSession;
 import org.apache.isis.security.authentication.MessageBroker;
+import org.apache.isis.viewer.wicket.model.common.CommonContextUtils;
 import org.apache.isis.viewer.wicket.model.models.PageType;
 import org.apache.isis.viewer.wicket.ui.errors.ExceptionModel;
 import org.apache.isis.viewer.wicket.ui.pages.PageClassRegistry;
@@ -85,7 +86,7 @@ public class WebRequestCycleForIsis implements IRequestCycleListener {
     
     private PageClassRegistry pageClassRegistry;
     private IsisWebAppCommonContext commonContext;
-
+    
     @Override
     public synchronized void onBeginRequest(RequestCycle requestCycle) {
 
@@ -97,10 +98,11 @@ public class WebRequestCycleForIsis implements IRequestCycleListener {
             return;
         }
 
-        val wicketSession = AuthenticatedWebSessionForIsis.get();
-        this.commonContext = wicketSession.getCommonContext();        
+        val commonContext = getCommonContext();
+        val authenticationSession = AuthenticatedWebSessionForIsis.get().getAuthenticationSession();
+        
+        //fails yet _Assert.assertEquals("expected same", authenticationSession, commonContext.getAuthenticationSession());
         
-        val authenticationSession = wicketSession.getAuthenticationSession();
         if (authenticationSession == null) {
             log.debug("onBeginRequest out - session was not opened (because no authenticationSession)");
             return;
@@ -123,17 +125,17 @@ public class WebRequestCycleForIsis implements IRequestCycleListener {
         log.debug("onRequestHandlerResolved in");
 
         if(handler instanceof RenderPageRequestHandler) {
-
-            val metaModelDeficiencies = IsisContext.getMetaModelDeficienciesIfAny();
-
-            if(metaModelDeficiencies != null) {
+            
+            val validationResult = getCommonContext().getSpecificationLoader().getValidationResult();
+            
+            if(validationResult.hasFailures()) {
                 RenderPageRequestHandler requestHandler = (RenderPageRequestHandler) handler;
                 final IRequestablePage nextPage = requestHandler.getPage();
                 if(nextPage instanceof ErrorPage || nextPage instanceof MmvErrorPage) {
                     // do nothing
                     return;
                 }
-                throw new MetaModelInvalidException(metaModelDeficiencies);
+                throw new MetaModelInvalidException(validationResult.getAsLineNumberedString());
             }
         }
 
@@ -202,11 +204,10 @@ public class WebRequestCycleForIsis implements IRequestCycleListener {
     public IRequestHandler onException(RequestCycle cycle, Exception ex) {
 
         log.debug("onException");
-
-        val metaModelDeficiencies = IsisContext.getMetaModelDeficienciesIfAny();
-        if(metaModelDeficiencies != null) {
-            val validationErrors = metaModelDeficiencies.getValidationErrors();
-            val mmvErrorPage = new MmvErrorPage(validationErrors);
+        
+        val validationResult = getCommonContext().getSpecificationLoader().getValidationResult();
+        if(validationResult.hasFailures()) {
+            val mmvErrorPage = new MmvErrorPage(validationResult.getMessages());
             return new RenderPageRequestHandler(new PageProvider(mmvErrorPage), RedirectPolicy.ALWAYS_REDIRECT);
         }
 
@@ -227,7 +228,7 @@ public class WebRequestCycleForIsis implements IRequestCycleListener {
 
 
             // handle recognized exceptions gracefully also
-            final Stream<ExceptionRecognizer> exceptionRecognizers = commonContext.getServiceRegistry()
+            final Stream<ExceptionRecognizer> exceptionRecognizers = getCommonContext().getServiceRegistry()
                     .select(ExceptionRecognizer.class)
                     .stream();
 
@@ -287,7 +288,7 @@ public class WebRequestCycleForIsis implements IRequestCycleListener {
         if(text == null) {
             return null;
         }
-        return commonContext.getTranslationService().translate(WebRequestCycleForIsis.class.getName(), text);
+        return getCommonContext().getTranslationService().translate(WebRequestCycleForIsis.class.getName(), text);
     }
 
     protected PageProvider errorPageProviderFor(Exception ex) {
@@ -309,21 +310,20 @@ public class WebRequestCycleForIsis implements IRequestCycleListener {
         exceptionRecognizers.add(pageExpiredExceptionRecognizer);
 
         if(inIsisSession()) {
-            commonContext.getServiceRegistry()
+            getCommonContext().getServiceRegistry()
             .select(ExceptionRecognizer.class)
             .forEach(exceptionRecognizers::add);
         } else {
-            val metaModelDeficiencies = IsisContext.getMetaModelDeficienciesIfAny();
-            if(metaModelDeficiencies != null) {
-                val validationErrors = metaModelDeficiencies.getValidationErrors();
-                return new MmvErrorPage(validationErrors);
+            val validationResult = getCommonContext().getSpecificationLoader().getValidationResult();
+            if(validationResult.hasFailures()) {
+                return new MmvErrorPage(validationResult.getMessages());
             }
             // not sure whether this can ever happen now...
             log.warn("Unable to obtain exceptionRecognizers (no session), "
                     + "will be treated as unrecognized exception", ex);
         }
         String recognizedMessageIfAny = new ExceptionRecognizerComposite(exceptionRecognizers).recognize(ex);
-        ExceptionModel exceptionModel = ExceptionModel.create(commonContext, recognizedMessageIfAny, ex);
+        ExceptionModel exceptionModel = ExceptionModel.create(getCommonContext(), recognizedMessageIfAny, ex);
 
         return isSignedIn() ? new ErrorPage(exceptionModel) : newSignInPage(exceptionModel);
     }
@@ -380,6 +380,10 @@ public class WebRequestCycleForIsis implements IRequestCycleListener {
     }
 
     // -- DEPENDENCIES
+    
+    public IsisWebAppCommonContext getCommonContext() {
+        return commonContext = CommonContextUtils.computeIfAbsent(commonContext);
+    }
 
     private boolean inIsisSession() {
         return IsisSession.currentOrElseNull()!=null;