concord-server: default message for unexpected errors (#1096)

Author: benbroadaway

plugins/tasks/misc/src/main/java/com/walmartlabs/concord/plugins/misc/CollectionsTaskV2.java

@@ -1,5 +1,25 @@
 package com.walmartlabs.concord.plugins.misc;
 
+/*-
+ * *****
+ * Concord
+ * -----
+ * Copyright (C) 2017 - 2025 Walmart Inc.
+ * -----
+ * 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
+ * 
+ *      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.
+ * =====
+ */
+
 import com.google.common.collect.Lists;
 import com.walmartlabs.concord.runtime.v2.sdk.DryRunReady;
 import com.walmartlabs.concord.runtime.v2.sdk.Task;

plugins/tasks/misc/src/main/java/com/walmartlabs/concord/plugins/misc/EnvTaskV2.java

@@ -1,5 +1,25 @@
 package com.walmartlabs.concord.plugins.misc;
 
+/*-
+ * *****
+ * Concord
+ * -----
+ * Copyright (C) 2017 - 2025 Walmart Inc.
+ * -----
+ * 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
+ * 
+ *      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.
+ * =====
+ */
+
 import com.walmartlabs.concord.runtime.v2.sdk.DryRunReady;
 import com.walmartlabs.concord.runtime.v2.sdk.Task;
 

server/impl/src/main/java/com/walmartlabs/concord/server/ApiServerModule.java

@@ -72,6 +72,7 @@ public void configure(Binder binder) {
         // RequestErrorHandler
 
         newSetBinder(binder, RequestErrorHandler.class).addBinding().to(FormRequestErrorHandler.class);
+        newSetBinder(binder, RequestErrorHandler.class).addBinding().to(GenericRequestErrorHandler.class);
 
         // ContextHandlerConfigurator
 

server/impl/src/main/java/com/walmartlabs/concord/server/GenericRequestErrorHandler.java

@@ -0,0 +1,64 @@
+package com.walmartlabs.concord.server;
+
+/*-
+ * *****
+ * Concord
+ * -----
+ * Copyright (C) 2017 - 2025 Walmart Inc.
+ * -----
+ * 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
+ * 
+ *      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.
+ * =====
+ */
+
+import com.walmartlabs.concord.server.boot.RequestErrorHandler;
+import com.walmartlabs.concord.server.console.ResponseTemplates;
+import org.apache.http.HttpHeaders;
+import org.eclipse.jetty.http.MimeTypes;
+
+import javax.inject.Inject;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Map;
+
+public class GenericRequestErrorHandler implements RequestErrorHandler {
+
+    private final ResponseTemplates responseTemplates;
+
+    @Inject
+    public GenericRequestErrorHandler(ResponseTemplates responseTemplates) {
+        this.responseTemplates = responseTemplates;
+    }
+
+    @Override
+    public boolean handle(HttpServletRequest request, HttpServletResponse response) throws IOException {
+        Map<String, Object> args = Map.of("statusCode", response.getStatus());
+
+        OutputStream out = response.getOutputStream();
+        response.setCharacterEncoding(StandardCharsets.UTF_8.name());
+        String accept = request.getHeader(HttpHeaders.ACCEPT);
+
+        if (accept.toLowerCase().startsWith(MimeTypes.Type.APPLICATION_JSON.asString())) {
+            response.setContentType(MimeTypes.Type.APPLICATION_JSON_UTF_8.asString());
+            out.write("{\"error\": \"An unexpected error occurred.\"}".getBytes(StandardCharsets.UTF_8));
+        } else {
+            responseTemplates.genericError(out, args);
+            response.setContentType(MimeTypes.Type.TEXT_HTML.asString());
+        }
+
+        return true;
+    }
+
+}

server/impl/src/main/java/com/walmartlabs/concord/server/console/ResponseTemplates.java

@@ -39,6 +39,7 @@ public class ResponseTemplates {
     private final Mustache processError;
     private final Mustache inProgressWait;
     private final Mustache formNotFound;
+    private final Mustache genericError;
 
     public ResponseTemplates() {
         MustacheFactory mf = new DefaultMustacheFactory();
@@ -47,6 +48,7 @@ public ResponseTemplates() {
         processError = mf.compile("com/walmartlabs/concord/server/console/processError.html");
         inProgressWait = mf.compile("com/walmartlabs/concord/server/console/inProgress.html");
         formNotFound = mf.compile("com/walmartlabs/concord/server/console/formNotFound.html");
+        genericError = mf.compile("com/walmartlabs/concord/server/console/genericError.html");
     }
 
     private ResponseBuilder html(Mustache m, ResponseBuilder r, Map<String, Object> args) {
@@ -79,4 +81,10 @@ public void formNotFound(OutputStream out, Map<String, Object> args) throws IOEx
             formNotFound.execute(w, args);
         }
     }
+
+    public void genericError(OutputStream out, Map<String, Object> args) throws IOException {
+        try (OutputStreamWriter w = new OutputStreamWriter(out)) {
+            genericError.execute(w, args);
+        }
+    }
 }

server/impl/src/main/resources/com/walmartlabs/concord/server/console/genericError.html

@@ -0,0 +1,8 @@
+{{> header}}
+
+<div class="ui negative message">
+    <div class="header">Unexpected Error - {{ statusCode }}</div>
+    <p>The application has encountered an unknown error. Check request URL and parameters.</p>
+</div>
+
+{{> footer}}