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 2021/08/21 17:42:38 UTC

[isis] branch master updated: ISIS-2853: cover remaining endpoints with Debug Logging

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 7b903e5  ISIS-2853: cover remaining endpoints with Debug Logging
7b903e5 is described below

commit 7b903e5d3328ef03a567ab43b4b2e3bac7d0863f
Author: andi-huber <ah...@apache.org>
AuthorDate: Sat Aug 21 19:42:30 2021 +0200

    ISIS-2853: cover remaining endpoints with Debug Logging
---
 .../viewer/resources/ImageResourceServerside.java  |  5 ++--
 .../viewer/resources/SwaggerSpecResource.java      | 12 ++++++---
 .../resources/VersionResourceServerside.java       | 31 +++++++++++++++++-----
 .../viewer/resources/_EndpointLogging.java         | 21 +++++++++++++++
 4 files changed, 57 insertions(+), 12 deletions(-)

diff --git a/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/ImageResourceServerside.java b/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/ImageResourceServerside.java
index 51ef03a..0b866b9 100644
--- a/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/ImageResourceServerside.java
+++ b/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/ImageResourceServerside.java
@@ -48,6 +48,7 @@ public class ImageResourceServerside extends ResourceAbstract {
             final IsisConfiguration isisConfiguration,
             final InteractionLayerTracker iInteractionLayerTracker) {
         super(metaModelContext, isisConfiguration, iInteractionLayerTracker);
+        log.debug("<init>");
     }
 
     @GET
@@ -63,7 +64,7 @@ public class ImageResourceServerside extends ResourceAbstract {
         //                "attachment; filename=SimpleObject.png");
         //        return response.build();
 
-        return Response.ok(bytes).build();
-
+        return _EndpointLogging.response(log, "GET /image",
+                Response.ok(bytes).build());
     }
 }
diff --git a/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/SwaggerSpecResource.java b/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/SwaggerSpecResource.java
index 7140b3d..51e35f8 100644
--- a/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/SwaggerSpecResource.java
+++ b/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/SwaggerSpecResource.java
@@ -59,6 +59,7 @@ public class SwaggerSpecResource {
             final InteractionService interactionService) {
         this.swaggerService = swaggerService;
         this.interactionService = interactionService;
+        log.debug("<init>");
     }
 
     @Path("/private")
@@ -68,7 +69,8 @@ public class SwaggerSpecResource {
         MediaType.APPLICATION_JSON, "text/yaml"
     })
     public String swaggerPrivate() {
-        return swagger(Visibility.PRIVATE);
+        return _EndpointLogging.stringResponse(log, "GET /swagger/private",
+                swagger(Visibility.PRIVATE));
     }
 
     @Path("/prototyping")
@@ -78,7 +80,8 @@ public class SwaggerSpecResource {
         MediaType.APPLICATION_JSON, "text/yaml"
     })
     public String swaggerPrototyping() {
-        return swagger(Visibility.PRIVATE_WITH_PROTOTYPING);
+        return _EndpointLogging.stringResponse(log, "GET /swagger/prototyping",
+                swagger(Visibility.PRIVATE_WITH_PROTOTYPING));
     }
 
     @Path("/public")
@@ -88,9 +91,12 @@ public class SwaggerSpecResource {
         MediaType.APPLICATION_JSON, "text/yaml"
     })
     public String swaggerPublic() {
-        return swagger(Visibility.PUBLIC);
+        return _EndpointLogging.stringResponse(log, "GET /swagger/public",
+                swagger(Visibility.PUBLIC));
     }
 
+    // -- HELPER
+
     private String swagger(final Visibility visibility) {
 
         val format = deriveFrom(httpHeaders);
diff --git a/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/VersionResourceServerside.java b/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/VersionResourceServerside.java
index 7d3709b..640a84e 100644
--- a/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/VersionResourceServerside.java
+++ b/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/VersionResourceServerside.java
@@ -57,7 +57,9 @@ import lombok.extern.log4j.Log4j2;
 @Component
 @Path("/version")
 @Log4j2
-public class VersionResourceServerside extends ResourceAbstract implements VersionResource {
+public class VersionResourceServerside
+extends ResourceAbstract
+implements VersionResource {
 
     @Inject
     public VersionResourceServerside(
@@ -65,6 +67,7 @@ public class VersionResourceServerside extends ResourceAbstract implements Versi
             final IsisConfiguration isisConfiguration,
             final InteractionLayerTracker iInteractionLayerTracker) {
         super(metaModelContext, isisConfiguration, iInteractionLayerTracker);
+        log.debug("<init>");
     }
 
     @Override
@@ -79,29 +82,43 @@ public class VersionResourceServerside extends ResourceAbstract implements Versi
         final VersionReprRenderer renderer = new VersionReprRenderer(resourceContext, null, JsonRepresentation.newMap());
         renderer.includesSelf();
 
-        return Responses.ofOk(renderer, Caching.ONE_DAY).build();
+        return _EndpointLogging.response(log, "GET /version",
+                Responses.ofOk(renderer, Caching.ONE_DAY).build());
     }
 
     @Override
     public Response deleteVersionNotAllowed() {
-        throw RestfulObjectsApplicationException.createWithMessage(RestfulResponse.HttpStatusCode.METHOD_NOT_ALLOWED, "Deleting the version resource is not allowed.");
+        throw _EndpointLogging.error(log, "DELETE /version",
+                RestfulObjectsApplicationException
+                .createWithMessage(
+                        RestfulResponse.HttpStatusCode.METHOD_NOT_ALLOWED,
+                        "Deleting the version resource is not allowed."));
     }
 
     @Override
     public Response putVersionNotAllowed() {
-        throw RestfulObjectsApplicationException.createWithMessage(RestfulResponse.HttpStatusCode.METHOD_NOT_ALLOWED, "Putting to the version resource is not allowed.");
+        throw _EndpointLogging.error(log, "PUT /version",
+                RestfulObjectsApplicationException
+                .createWithMessage(
+                        RestfulResponse.HttpStatusCode.METHOD_NOT_ALLOWED,
+                        "Putting to the version resource is not allowed."));
     }
 
     @Override
     public Response postVersionNotAllowed() {
-        throw RestfulObjectsApplicationException.createWithMessage(RestfulResponse.HttpStatusCode.METHOD_NOT_ALLOWED, "Posting to the version resource is not allowed.");
+        throw _EndpointLogging.error(log, "POST /version",
+                RestfulObjectsApplicationException
+                .createWithMessage(
+                        RestfulResponse.HttpStatusCode.METHOD_NOT_ALLOWED,
+                        "Posting to the version resource is not allowed."));
     }
 
-    private void fakeRuntimeExceptionIfXFail(ResourceContext resourceContext) {
+    private void fakeRuntimeExceptionIfXFail(final ResourceContext resourceContext) {
         final HttpHeaders httpHeaders = resourceContext.getHttpHeaders();
         final List<String> requestHeader = httpHeaders.getRequestHeader("X-Fail");
         if (requestHeader != null && !requestHeader.isEmpty()) {
-            throw RestfulObjectsApplicationException.create(HttpStatusCode.METHOD_FAILURE);
+            throw _EndpointLogging.error(log, "GET /version",
+                    RestfulObjectsApplicationException.create(HttpStatusCode.METHOD_FAILURE));
         }
     }
 
diff --git a/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/_EndpointLogging.java b/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/_EndpointLogging.java
index 31a5820..5cb3a73 100644
--- a/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/_EndpointLogging.java
+++ b/viewers/restfulobjects/viewer/src/main/java/org/apache/isis/viewer/restfulobjects/viewer/resources/_EndpointLogging.java
@@ -29,6 +29,21 @@ import lombok.experimental.UtilityClass;
 @UtilityClass
 class _EndpointLogging {
 
+
+    /**
+     * Returns given {@code stringResponse} untampered.
+     */
+    String stringResponse(
+            final Logger log,
+            final String format,
+            final String stringResponse) {
+        if(log.isDebugEnabled()) {
+            logRequest(log, format);
+            logResponse(log, stringResponse);
+        }
+        return stringResponse;
+    }
+
     /**
      * Returns given {@code Response} untampered.
      */
@@ -166,6 +181,12 @@ class _EndpointLogging {
         log.debug("--- END RESPONSE");
     }
 
+    private void logResponse(final Logger log, final String stringResponse) {
+        log.debug("<<< RESPONSE");
+        log.debug(stringResponse);
+        log.debug("--- END RESPONSE");
+    }
+
     private void logError(final Logger log, final RestfulObjectsApplicationException roException) {
         log.debug("<<< ERROR");
         log.debug(roException.getBody());