Fix #32571: improve SpEL error-reporting

Author: LEDfan

src/main/java/eu/openanalytics/containerproxy/backend/dispatcher/proxysharing/ProxySharingScaler.java

@@ -54,6 +54,8 @@
 import eu.openanalytics.containerproxy.service.leader.ILeaderService;
 import eu.openanalytics.containerproxy.spec.expression.SpecExpressionContext;
 import eu.openanalytics.containerproxy.spec.expression.SpecExpressionResolver;
+import eu.openanalytics.containerproxy.spec.expression.SpelContextObjectNotAvailableException;
+import eu.openanalytics.containerproxy.spec.expression.SpelException;
 import eu.openanalytics.containerproxy.spec.expression.SpelField;
 import eu.openanalytics.containerproxy.util.ExecutorServiceFactory;
 import eu.openanalytics.containerproxy.util.MathUtil;
@@ -417,6 +419,10 @@ private Runnable createDelegateProxyJob(DelegateProxy originalDelegateProxy) {
                         applicationEventPublisher.publishEvent(new SeatAvailableEvent(proxySpec.getId(), intendedProxyId));
                     }
                 }
+            } catch (SpelContextObjectNotAvailableException | SpelException ex) {
+                // remove seats and other data
+                globalEventLoop.schedule(() -> markDelegateProxyForRemoval(id));
+                logger.error("Failed to start DelegateProxy, problem while resolving SpEL expressions. You can only use the objects 'containerSpec', 'proxySpec' and 'proxy' when using pre-initialized containers. Cause: " + ex.getMessage());
             } catch (ProxyFailedToStartException t) {
                 logError(originalDelegateProxy, t, "Failed to start DelegateProxy");
                 try {

src/main/java/eu/openanalytics/containerproxy/spec/expression/SpecExpressionContext.java

@@ -40,7 +40,7 @@
 import java.util.List;
 
 @Value
-@EqualsAndHashCode()
+@EqualsAndHashCode(doNotUseGetters = true)
 @Builder(toBuilder = true)
 @AllArgsConstructor
 public class SpecExpressionContext {
@@ -149,4 +149,73 @@ public SpecExpressionContext copy(Object... objects) {
         return create(toBuilder(), objects);
     }
 
+    public ProxySpec getProxySpec() {
+        if (proxySpec == null) {
+            throw new SpelContextObjectNotAvailableException("proxySpec");
+        }
+        return proxySpec;
+    }
+
+    public ContainerSpec getContainerSpec() {
+        if (containerSpec == null) {
+            throw new SpelContextObjectNotAvailableException("containerSpec");
+        }
+        return containerSpec;
+    }
+
+    public Proxy getProxy() {
+        if (proxy == null) {
+            throw new SpelContextObjectNotAvailableException("proxy");
+        }
+        return proxy;
+    }
+
+    public OpenIDAuthenticationBackend.CustomNameOidcUser getOidcUser() {
+        if (oidcUser == null) {
+            throw new SpelContextObjectNotAvailableException("oidcUser");
+        }
+        return oidcUser;
+    }
+
+    public ResponseAuthenticationConverter.Saml2AuthenticatedPrincipal getSamlCredential() {
+        if (samlCredential == null) {
+            throw new SpelContextObjectNotAvailableException("samlCredential");
+        }
+        return samlCredential;
+    }
+
+    public LdapUserDetails getLdapUser() {
+        if (ldapUser == null) {
+            throw new SpelContextObjectNotAvailableException("ldapUser");
+        }
+        return ldapUser;
+    }
+
+    public WebServiceAuthenticationBackend.WebServiceUser getWebServiceUser() {
+        if (oidcUser == null) {
+            throw new SpelContextObjectNotAvailableException("webServiceUser");
+        }
+        return webServiceUser;
+    }
+
+    public List<String> getGroups() {
+        if (groups == null) {
+            throw new SpelContextObjectNotAvailableException("groups");
+        }
+        return groups;
+    }
+
+    public String getUserId() {
+        if (userId == null) {
+            throw new SpelContextObjectNotAvailableException("userId");
+        }
+        return userId;
+    }
+
+    public JsonNode getJson() {
+        if (json == null) {
+            throw new SpelContextObjectNotAvailableException("json");
+        }
+        return json;
+    }
 }

src/main/java/eu/openanalytics/containerproxy/spec/expression/SpecExpressionResolver.java

@@ -22,6 +22,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.google.common.base.Throwables;
 import org.springframework.beans.factory.config.ConfigurableBeanFactory;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ConfigurableApplicationContext;
@@ -106,7 +107,13 @@ public <T> T evaluate(String expression, SpecExpressionContext context, Class<T>
             }
 
             return expr.getValue(sec, resType);
+        } catch (SpelContextObjectNotAvailableException ex) {
+            throw new SpelException(ex, expression);
         } catch (ExpressionException ex) {
+            Throwable rootCause = Throwables.getRootCause(ex);
+            if (rootCause instanceof SpelContextObjectNotAvailableException contextObjectNotAvailableException) {
+                throw new SpelContextObjectNotAvailableException(contextObjectNotAvailableException, expression);
+            }
             throw new SpelException(ex, expression);
         } catch (Throwable ex) {
             throw new SpelException(ex, expression);

src/main/java/eu/openanalytics/containerproxy/spec/expression/SpelContextObjectNotAvailableException.java

@@ -0,0 +1,33 @@
+/**
+ * ContainerProxy
+ *
+ * Copyright (C) 2016-2024 Open Analytics
+ *
+ * ===========================================================================
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Apache License as published by
+ * The Apache Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * Apache License for more details.
+ *
+ * You should have received a copy of the Apache License
+ * along with this program.  If not, see <http://www.apache.org/licenses/>
+ */
+package eu.openanalytics.containerproxy.spec.expression;
+
+public class SpelContextObjectNotAvailableException extends RuntimeException {
+
+    public SpelContextObjectNotAvailableException(String objectName) {
+        super("Object \"" + objectName + "\" not available in SpelContext.");
+    }
+
+    public SpelContextObjectNotAvailableException(SpelContextObjectNotAvailableException ex, String expression) {
+        super("Error while resolving expression: \"" + expression + "\", error: " + ex.getMessage());
+    }
+
+}

src/main/java/eu/openanalytics/containerproxy/spec/expression/SpelException.java

@@ -28,6 +28,10 @@ public SpelException(ExpressionException cause, String originalExpression) {
         super("Error while resolving expression: \"" + originalExpression + "\", error: " + cause.getMessage());
     }
 
+    public SpelException(SpelContextObjectNotAvailableException cause, String originalExpression) {
+        super("Error while resolving expression: \"" + originalExpression + "\", error: " + cause.getMessage());
+    }
+
     public SpelException(Throwable cause, String originalExpression) {
         super("Error while resolving expression: \"" + originalExpression + "\", error: " + cause.getMessage(), cause);
     }