Record resolution errors for control panel (#463)

With this change, the control panel will now remember resolution
errors. This can be particularly useful when resolution fails on
the client side, and that the user doesn't really understand why.

By going to the control panel, the errors will be recorded per
resolver.

Author: melix

Diff for: test-resources-control-panel/src/main/java/io/micronaut/testresources/controlpanel/ControlPanelPropertyResolutionListener.java

@@ -20,6 +20,8 @@
 import io.micronaut.testresources.server.PropertyResolutionListener;
 import jakarta.inject.Singleton;
 
+import java.io.PrintWriter;
+import java.io.StringWriter;
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -36,6 +38,7 @@
 @Singleton
 public class ControlPanelPropertyResolutionListener implements PropertyResolutionListener {
     private final Map<String, Set<Resolution>> resolvedProperties = new HashMap<>();
+    private final Map<String, Set<ResolutionError>> errors = new HashMap<>();
 
     @Override
     public void resolved(String property, String resolvedValue, TestResourcesResolver resolver,
@@ -50,6 +53,13 @@ public void resolved(String property, String resolvedValue, TestResourcesResolve
             .add(resolution);
     }
 
+    @Override
+    public void errored(String property, TestResourcesResolver resolver, Throwable exception) {
+        var error = ResolutionError.of(property, exception);
+        errors.computeIfAbsent(resolver.getId(), k -> new HashSet<>())
+            .add(error);
+    }
+
     /**
      * Returns the resolutions performed by a particular resolver.
      * @param resolver the resolver
@@ -71,6 +81,18 @@ public List<Resolution> findById(String id) {
             .toList();
     }
 
+    /**
+     * Returns the resolutions performed by a particular resolver.
+     * @param id the resolver id
+     * @return the resolutions
+     */
+    public List<ResolutionError> findErrorsById(String id) {
+        return errors.getOrDefault(id, Set.of())
+            .stream()
+            .sorted(Comparator.comparing(ResolutionError::property))
+            .toList();
+    }
+
     private static Map<String, String> asStringMap(Map<String, Object> input) {
         return input.entrySet()
             .stream()
@@ -82,6 +104,7 @@ private static Map<String, String> asStringMap(Map<String, Object> input) {
 
     /**
      * A property resolution.
+     *
      * @param property the property which was resolved
      * @param resolvedValue the resolved value as a string
      * @param properties the properties which were used for the resolution context
@@ -96,4 +119,31 @@ public record Resolution(
     ) {
 
     }
+
+    /**
+     * A property resolution error.
+     *
+     * @param property the property which was resolved
+     * @param stackTrace the associated resolution error
+     */
+    @Introspected
+    public record ResolutionError(
+        String property,
+        String stackTrace
+    ) {
+
+        /**
+         * Builds a resolution error.
+         * @param property the property
+         * @param exception the exception
+         * @return a resolution error
+         */
+        public static ResolutionError of(String property, Throwable exception) {
+            var stackTrace = new StringWriter();
+            try (var writer = new PrintWriter(stackTrace)) {
+                exception.printStackTrace(writer);
+            }
+            return new ResolutionError(property, stackTrace.toString());
+        }
+    }
 }

Diff for: test-resources-control-panel/src/main/java/io/micronaut/testresources/controlpanel/TestResourcesControlPanel.java

@@ -18,15 +18,13 @@
 import io.micronaut.controlpanel.core.AbstractControlPanel;
 import io.micronaut.controlpanel.core.config.ControlPanelConfiguration;
 
-import java.util.List;
-
 /**
  * A control panel for test resource resolvers.
  * Each resolver will result in the creation of a separate control panel.
  * The control panel is responsible for showing the properties resolved
  * by this particular test resources resolver.
  */
-public class TestResourcesControlPanel extends AbstractControlPanel<List<ControlPanelPropertyResolutionListener.Resolution>> {
+public class TestResourcesControlPanel extends AbstractControlPanel<TestResourcesControlPanelBody> {
     private final ControlPanelPropertyResolutionListener resolutionListener;
     private final String id;
 
@@ -45,9 +43,16 @@ public String getBadge() {
         );
     }
 
+    public int getErrorCount() {
+        return resolutionListener.findErrorsById(id).size();
+    }
+
     @Override
-    public List<ControlPanelPropertyResolutionListener.Resolution> getBody() {
-        return resolutionListener.findById(id);
+    public TestResourcesControlPanelBody getBody() {
+        return new TestResourcesControlPanelBody(
+            resolutionListener.findById(id),
+            resolutionListener.findErrorsById(id)
+        );
     }
 
     @Override

Diff for: test-resources-control-panel/src/main/java/io/micronaut/testresources/controlpanel/TestResourcesControlPanelBody.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2017-2023 original authors
+ *
+ * Licensed 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
+ *
+ * https://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 io.micronaut.testresources.controlpanel;
+
+import io.micronaut.core.annotation.Introspected;
+
+import java.util.List;
+
+@Introspected
+public record TestResourcesControlPanelBody(
+    List<ControlPanelPropertyResolutionListener.Resolution> resolvedProperties,
+    List<ControlPanelPropertyResolutionListener.ResolutionError> errors
+) {
+}

Diff for: test-resources-control-panel/src/main/resources/views/test-resources/body.hbs

@@ -9,5 +9,14 @@
             Resolved {{badge}} properties.
         {{/eq}}
     {{/eq}}
+    {{#neq errorCount 0 }}
+        <div class="card bg-danger">
+            {{#eq errorCount 1}}
+                1 resolution failure
+            {{else}}
+                {{errorCount}} resolution failures
+            {{/eq}}
+        </div>
+    {{/neq}}
 
 {{/with}}

Diff for: test-resources-control-panel/src/main/resources/views/test-resources/detail.hbs

@@ -1,9 +1,9 @@
 <div class="card card-light">
-    {{#neq controlPanel.body.size 0}}
-        <div class="card-header">
-            <h3 class="card-title"><code>{{@key}}</code></h3>
-        </div>
-        <div class="card-body">
+    <div class="card-header">
+        <h3 class="card-title"><code>{{@key}}</code></h3>
+    </div>
+    <div class="card-body">
+        {{#neq controlPanel.body.resolvedProperties.size 0}}
             <p>
                 The following table contains the properties which were resolved by this test resources provider.
             </p>
@@ -17,7 +17,7 @@
                 </tr>
                 </thead>
                 <tbody>
-                {{#each controlPanel.body as |resolution|}}
+                {{#each controlPanel.body.resolvedProperties as |resolution|}}
                     <tr>
                         <td><code>{{resolution.property}}</code></td>
                         <td><code>{{resolution.resolvedValue}}</code></td>
@@ -28,8 +28,28 @@
                 {{/each}}
                 </tbody>
             </table>
-        </div>
-    {{else}}
-        This test resources provider hasn't resolved any property yet.
-    {{/neq}}
+        {{else}}
+            This test resources provider hasn't resolved any property yet.
+        {{/neq}}
+        {{#neq controlPanel.body.errors.size 0}}
+            <p>There were errors during resolution of properties.</p>
+            <table class="table">
+                <thead>
+                <tr>
+                    <th>Property</th>
+                    <th>Error</th>
+                </tr>
+                </thead>
+                <tbody>
+                {{#each controlPanel.body.errors as |error|}}
+                    <tr>
+                        <td><code>{{error.property}}</code></td>
+                        <td><code>{{error.stackTrace}}</code></td>
+                    </tr>
+                {{/each}}
+                </tbody>
+            </table>
+        {{/neq}}
+    </div>
+
 </div>

Diff for: test-resources-core/src/main/java/io/micronaut/testresources/core/TestResourcesResolutionException.java

@@ -31,4 +31,19 @@ public TestResourcesResolutionException(String message, Throwable cause) {
     public TestResourcesResolutionException(String message) {
         super(message);
     }
+
+    /**
+     * Returns a TestResourcesResolutionException from an exception. If
+     * the type of the exception is already TestResourcesResolutionException
+     * then the same instance is returned, otherwise the exception is
+     * wrapped into TestResourcesResolutionException.
+     * @param ex the exception
+     * @return a TestResourcesResolutionException
+     */
+    public static TestResourcesResolutionException wrap(Exception ex) {
+        if (ex instanceof TestResourcesResolutionException trre) {
+            return trre;
+        }
+        return new TestResourcesResolutionException(ex);
+    }
 }

Diff for: test-resources-server/src/main/java/io/micronaut/testresources/server/PropertyResolutionListener.java

@@ -37,4 +37,15 @@ void resolved(String property,
                   TestResourcesResolver resolver,
                   Map<String, Object> properties,
                   Map<String, Object> testResourcesConfig);
+
+    /**
+     * Records an error which happened during property resolution,
+     * for example if a container fails to start.
+     * @param property the property which we attempted to resolve
+     * @param resolver the resolver which failed
+     * @param error the error which happened
+     */
+    void errored(String property,
+                 TestResourcesResolver resolver,
+                 Throwable error);
 }