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 2018/10/01 10:53:36 UTC

[isis] 02/02: ISIS-1976: cleanup ServiceUtil

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 eaeb0fe9178566299697b1aec56486aab7a72860
Author: Andi Huber <ah...@apache.org>
AuthorDate: Mon Oct 1 11:59:14 2018 +0200

    ISIS-1976: cleanup ServiceUtil
    
    improve ServiceInjector's service list validation for uniqueness to
    print all! duplicates
    
    Task-Url: https://issues.apache.org/jira/browse/ISIS-1976
---
 ...jectSpecIdFacetDerivedFromClassNameFactory.java |  2 +-
 .../isis/core/metamodel/services/ServiceUtil.java  | 60 ++++++++++++----------
 .../core/metamodel/services/ServicesInjector.java  | 24 ++++++---
 .../services/swagger/internal/Generation.java      |  9 +---
 .../core/metamodel/services/ServiceUtil_Test.java  | 24 ++++-----
 ...ObjectAdapterContext_ObjectAdapterProvider.java |  2 +-
 .../domainobjects/DomainObjectReprRenderer.java    |  2 +-
 .../domainobjects/DomainServiceLinkTo.java         |  2 +-
 8 files changed, 66 insertions(+), 59 deletions(-)

diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/objectspecid/classname/ObjectSpecIdFacetDerivedFromClassNameFactory.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/objectspecid/classname/ObjectSpecIdFacetDerivedFromClassNameFactory.java
index e02db27..59db0a7 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/objectspecid/classname/ObjectSpecIdFacetDerivedFromClassNameFactory.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/objectspecid/classname/ObjectSpecIdFacetDerivedFromClassNameFactory.java
@@ -74,7 +74,7 @@ MetaModelValidatorRefiner {
     private static ObjectSpecIdFacet createObjectSpecIdFacet(final FacetHolder facetHolder, final Class<?> substitutedClass) {
         final boolean isService = isService(facetHolder);
         if (isService) {
-            final String id = ServiceUtil.id(substitutedClass);
+            final String id = ServiceUtil.idOfType(substitutedClass);
             if (id != null) {
                 return new ObjectSpecIdFacetDerivedFromDomainServiceAnnotationElseGetId(id, facetHolder);
             }
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/ServiceUtil.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/ServiceUtil.java
index 54a8745..0bb7773 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/ServiceUtil.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/ServiceUtil.java
@@ -19,49 +19,51 @@
 
 package org.apache.isis.core.metamodel.services;
 
-import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.util.function.Supplier;
 
 import org.apache.isis.applib.annotation.DomainService;
 import org.apache.isis.commons.internal.base._Strings;
-import org.apache.isis.core.commons.exceptions.IsisException;
+import org.apache.isis.commons.internal.functions._Functions;
+import org.apache.isis.core.metamodel.spec.ManagedObject;
+import org.apache.isis.core.metamodel.spec.ObjectSpecification;
 
 public final class ServiceUtil {
 
     private ServiceUtil() {
     }
 
-    public static String id(final Class<?> serviceClass) {
-        final String serviceType = serviceTypeOf(serviceClass);
+    public static String idOfType(final Class<?> serviceClass) {
+        
+        final String serviceType = serviceTypeUsingAnnotation(serviceClass);
         if (serviceType != null) {
             return serviceType;
         }
 
-        try {
-            Object object = serviceClass.newInstance();
-            return getIdOf(object);
-        } catch (InstantiationException | IllegalAccessException | NoSuchMethodException e) {
-            return null;
-        }
+        return serviceTypeUsingIdGetterOrElseGet(serviceClass, ()->serviceClass.newInstance(), ()->null);
     }
 
-    public static String id(final Object object) {
-        final Class<?> serviceClass = object.getClass();
-        final String serviceType = serviceTypeOf(serviceClass);
+    public static String idOfPojo(final Object serviceObject) {
+        final Class<?> serviceClass = serviceObject.getClass();
+        final String serviceType = serviceTypeUsingAnnotation(serviceClass);
         if(serviceType != null) {
             return serviceType;
         }
 
-        try {
-            return getIdOf(object);
-        } catch (final NoSuchMethodException e) {
-            return fqcnOf(serviceClass);
-        }
+        return serviceTypeUsingIdGetterOrElseGet(serviceClass, ()->serviceObject, ()->normalize(serviceClass));
+    }
+    
+    public static String idOfSpec(final ObjectSpecification serviceSpec) {
+        return idOfType(serviceSpec.getCorrespondingClass());
+    }
+    
+    public static String idOfAdapter(final ManagedObject adapter) {
+        return idOfPojo(adapter.getPojo());
     }
     
     // -- HELPER
 
-    private static String serviceTypeOf(final Class<?> serviceClass) {
+    private static String serviceTypeUsingAnnotation(final Class<?> serviceClass) {
         final String serviceType;
         final DomainService domainService = serviceClass.getAnnotation(DomainService.class);
         if(domainService != null) {
@@ -73,17 +75,21 @@ public final class ServiceUtil {
         return null;
     }
 
-    private static String getIdOf(final Object object) throws NoSuchMethodException {
+    private static String serviceTypeUsingIdGetterOrElseGet(
+            final Class<?> serviceClass, 
+            final _Functions.CheckedSupplier<Object> objectSupplier,
+            final Supplier<String> orElse
+            ) {
+        
         try {
-            final Class<?> objectClass = object.getClass();
-            final Method m = objectClass.getMethod("getId");
-            return (String) m.invoke(object);
-        } catch (final SecurityException | IllegalArgumentException | IllegalAccessException | InvocationTargetException e) {
-            throw new IsisException(e);
+            final Method m = serviceClass.getMethod("getId");
+            return (String) m.invoke(objectSupplier.get());
+        } catch (Exception e) {
+            return orElse.get();
         }
     }
-
-    private static String fqcnOf(final Class<?> serviceClass) {
+    
+    private static String normalize(Class<?> serviceClass) {
         return serviceClass.getName();
     }
 
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/ServicesInjector.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/ServicesInjector.java
index c47bf50..8c6a927 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/ServicesInjector.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/ServicesInjector.java
@@ -35,6 +35,7 @@ import org.apache.isis.applib.annotation.Programmatic;
 import org.apache.isis.applib.services.exceprecog.ExceptionRecognizer;
 import org.apache.isis.commons.internal.base._Lazy;
 import org.apache.isis.commons.internal.base._NullSafe;
+import org.apache.isis.commons.internal.base._Strings;
 import org.apache.isis.commons.internal.collections._Collections;
 import org.apache.isis.commons.internal.collections._Lists;
 import org.apache.isis.commons.internal.collections._Maps;
@@ -180,19 +181,26 @@ public class ServicesInjector implements ApplicationScopedComponent {
     }
 
     private static void validate(List<Object> serviceList) {
+        
         final ListMultimap<String, Object> servicesById = _Multimaps.newListMultimap();
         for (Object service : serviceList) {
-            String id = ServiceUtil.id(service);
+            String id = ServiceUtil.idOfPojo(service);
             servicesById.putElement(id, service);
         }
 
-        servicesById.forEach((serviceId, services)->{
-            if(services.size() > 1) {
-                throw new IllegalStateException(
-                        String.format("Service ids must be unique; serviceId '%s' is declared by domain services %s",
-                                serviceId, classNamesFor(services)));
-            }
-        });
+        final String errorMsg = servicesById.entrySet().stream()
+        .filter(entry->entry.getValue().size()>1) // filter for duplicates
+        .map(entry->{
+            String serviceId = entry.getKey();
+            List<Object> duplicateServiceEntries = entry.getValue();
+            return String.format("serviceId '%s' is declared by domain services %s",
+                    serviceId, classNamesFor(duplicateServiceEntries));
+        })
+        .collect(Collectors.joining(", "));
+         
+        if(_Strings.isNotEmpty(errorMsg)) {
+            throw new IllegalStateException("Service ids must be unique! "+errorMsg);
+        }
     }
 
     private static String classNamesFor(Collection<Object> services) {
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/Generation.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/Generation.java
index 5f82cac..83baf78 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/Generation.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/swagger/internal/Generation.java
@@ -35,7 +35,6 @@ import org.apache.isis.applib.annotation.SemanticsOf;
 import org.apache.isis.applib.services.swagger.SwaggerService;
 import org.apache.isis.commons.internal.base._Strings;
 import org.apache.isis.commons.internal.collections._Sets;
-import org.apache.isis.core.commons.factory.InstanceUtil;
 import org.apache.isis.core.metamodel.facets.actcoll.typeof.TypeOfFacet;
 import org.apache.isis.core.metamodel.facets.object.domainservice.DomainServiceFacet;
 import org.apache.isis.core.metamodel.facets.object.mixin.MixinFacet;
@@ -783,14 +782,8 @@ class Generation {
                 .required("extensions");
     }
 
-    // TODO: this is horrid, there ought to be a facet we can call instead...
     static String serviceIdFor(final ObjectSpecification serviceSpec) {
-        Object tempServiceInstance = InstanceUtil.createInstance(serviceSpec.getCorrespondingClass());
-        return serviceId(tempServiceInstance);
-    }
-
-    static String serviceId(final Object object) {
-        return ServiceUtil.id(object);
+        return ServiceUtil.idOfSpec(serviceSpec);
     }
 
     static String objectTypeFor(final ObjectSpecification objectSpec) {
diff --git a/core/metamodel/src/test/java/org/apache/isis/core/metamodel/services/ServiceUtil_Test.java b/core/metamodel/src/test/java/org/apache/isis/core/metamodel/services/ServiceUtil_Test.java
index e36282e..4549312 100644
--- a/core/metamodel/src/test/java/org/apache/isis/core/metamodel/services/ServiceUtil_Test.java
+++ b/core/metamodel/src/test/java/org/apache/isis/core/metamodel/services/ServiceUtil_Test.java
@@ -18,15 +18,15 @@
  */
 package org.apache.isis.core.metamodel.services;
 
-import org.junit.Test;
-
-import org.apache.isis.applib.annotation.DomainService;
-
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.CoreMatchers.nullValue;
 import static org.junit.Assert.assertThat;
 
+import org.junit.Test;
+
+import org.apache.isis.applib.annotation.DomainService;
+
 public class ServiceUtil_Test {
 
     @DomainService(objectType = "foo.SomeServiceAnnotated")
@@ -59,11 +59,11 @@ public class ServiceUtil_Test {
     public void annotated() throws Exception {
 
         assertThat(
-                ServiceUtil.id(new SomeServiceAnnotated()),
+                ServiceUtil.idOfPojo(new SomeServiceAnnotated()),
                 is(equalTo("foo.SomeServiceAnnotated")));
 
         assertThat(
-                ServiceUtil.id(SomeServiceAnnotated.class),
+                ServiceUtil.idOfType(SomeServiceAnnotated.class),
                 is(equalTo("foo.SomeServiceAnnotated")));
     }
 
@@ -71,11 +71,11 @@ public class ServiceUtil_Test {
     public void id() throws Exception {
 
         assertThat(
-                ServiceUtil.id(new SomeServiceWithId()),
+                ServiceUtil.idOfPojo(new SomeServiceWithId()),
                 is(equalTo("bar.SomeServiceWithId")));
 
         assertThat(
-                ServiceUtil.id(SomeServiceWithId.class),
+                ServiceUtil.idOfType(SomeServiceWithId.class),
                 is(equalTo("bar.SomeServiceWithId")));
     }
 
@@ -83,21 +83,21 @@ public class ServiceUtil_Test {
     public void annotated_precedence_over_id() throws Exception {
 
         assertThat(
-                ServiceUtil.id(new SomeServiceAnnotatedAndWithId()),
+                ServiceUtil.idOfPojo(new SomeServiceAnnotatedAndWithId()),
                 is(equalTo("bop.SomeServiceAnnotated")));
 
         assertThat(
-                ServiceUtil.id(SomeServiceAnnotatedAndWithId.class),
+                ServiceUtil.idOfType(SomeServiceAnnotatedAndWithId.class),
                 is(equalTo("bop.SomeServiceAnnotated")));
     }
 
     @Test
     public void fallback_to_fqcn_for_obj_but_to_null_for_service() throws Exception {
         assertThat(
-                ServiceUtil.id(new SomeServiceWithoutAnnotationOrId()),
+                ServiceUtil.idOfPojo(new SomeServiceWithoutAnnotationOrId()),
                 is(equalTo("org.apache.isis.core.metamodel.services.ServiceUtil_Test$SomeServiceWithoutAnnotationOrId")));
         assertThat(
-                ServiceUtil.id(SomeServiceWithoutAnnotationOrId.class),
+                ServiceUtil.idOfType(SomeServiceWithoutAnnotationOrId.class),
                 is(nullValue()));
     }
 
diff --git a/core/runtime/src/main/java/org/apache/isis/core/runtime/system/persistence/adaptermanager/ObjectAdapterContext_ObjectAdapterProvider.java b/core/runtime/src/main/java/org/apache/isis/core/runtime/system/persistence/adaptermanager/ObjectAdapterContext_ObjectAdapterProvider.java
index a982773..31aaeff 100644
--- a/core/runtime/src/main/java/org/apache/isis/core/runtime/system/persistence/adaptermanager/ObjectAdapterContext_ObjectAdapterProvider.java
+++ b/core/runtime/src/main/java/org/apache/isis/core/runtime/system/persistence/adaptermanager/ObjectAdapterContext_ObjectAdapterProvider.java
@@ -155,7 +155,7 @@ class ObjectAdapterContext_ObjectAdapterProvider implements ObjectAdapterProvide
         .peek(serviceAdapter->{
             Assert.assertFalse("expected to not be 'transient'", serviceAdapter.getOid().isTransient());
         })
-        .collect(Collectors.toMap(a->ServiceUtil.id(a.getPojo()), v->v, (o,n)->n, LinkedHashMap::new));
+        .collect(Collectors.toMap(ServiceUtil::idOfAdapter, v->v, (o,n)->n, LinkedHashMap::new));
     }
     
    
diff --git a/core/viewer-restfulobjects-rendering/src/main/java/org/apache/isis/viewer/restfulobjects/rendering/domainobjects/DomainObjectReprRenderer.java b/core/viewer-restfulobjects-rendering/src/main/java/org/apache/isis/viewer/restfulobjects/rendering/domainobjects/DomainObjectReprRenderer.java
index 60b02d1..e6c32e2 100644
--- a/core/viewer-restfulobjects-rendering/src/main/java/org/apache/isis/viewer/restfulobjects/rendering/domainobjects/DomainObjectReprRenderer.java
+++ b/core/viewer-restfulobjects-rendering/src/main/java/org/apache/isis/viewer/restfulobjects/rendering/domainobjects/DomainObjectReprRenderer.java
@@ -163,7 +163,7 @@ public class DomainObjectReprRenderer extends ReprRendererAbstract<DomainObjectR
 
             // serviceId or instance Id
             if (isService) {
-                representation.mapPut("serviceId", ServiceUtil.id(objectAdapter.getPojo()));
+                representation.mapPut("serviceId", ServiceUtil.idOfAdapter(objectAdapter));
             } else {
                 final String domainType = getDomainType();
                 final String instanceId = getInstanceId();
diff --git a/core/viewer-restfulobjects-rendering/src/main/java/org/apache/isis/viewer/restfulobjects/rendering/domainobjects/DomainServiceLinkTo.java b/core/viewer-restfulobjects-rendering/src/main/java/org/apache/isis/viewer/restfulobjects/rendering/domainobjects/DomainServiceLinkTo.java
index 58412c8..3602c06 100644
--- a/core/viewer-restfulobjects-rendering/src/main/java/org/apache/isis/viewer/restfulobjects/rendering/domainobjects/DomainServiceLinkTo.java
+++ b/core/viewer-restfulobjects-rendering/src/main/java/org/apache/isis/viewer/restfulobjects/rendering/domainobjects/DomainServiceLinkTo.java
@@ -27,7 +27,7 @@ public class DomainServiceLinkTo extends DomainObjectLinkTo {
 
     @Override
     public ObjectAdapterLinkTo with(final ObjectAdapter objectAdapter) {
-        serviceId = ServiceUtil.id(objectAdapter.getPojo());
+        serviceId = ServiceUtil.idOfAdapter(objectAdapter);
         return super.with(objectAdapter);
     }