Light, fluffy, and always free - The AWS Local Emulator alternative
refactor(apigateway,appsync): extract shared VTL $util functions into a common utility (#3583)
Priamo Germosen7a228c532597
diff --git a/src/main/java/io/github/hectorvent/floci/core/common/vtl/VtlUtilFunctions.java b/src/main/java/io/github/hectorvent/floci/core/common/vtl/VtlUtilFunctions.javanew file mode 100644index 0000000000..d739ccd976--- /dev/null+++ b/src/main/java/io/github/hectorvent/floci/core/common/vtl/VtlUtilFunctions.java@@ -0,0 +1,105 @@+package io.github.hectorvent.floci.core.common.vtl;++import com.fasterxml.jackson.core.JsonProcessingException;+import com.fasterxml.jackson.databind.ObjectMapper;++import java.net.URLDecoder;+import java.net.URLEncoder;+import java.nio.charset.StandardCharsets;+import java.util.Base64;+import java.util.Map;++/**+ * Implements the AWS VTL {@code $util} functions that API Gateway and AppSync specify+ * identically: string escaping, URL and base64 encoding, and JSON parsing. AWS documents+ * {@code $util} as one shared contract across both services' mapping-template specs, so+ * these implementations are shared rather than kept as two independently maintained+ * copies. Each service's own {@code $util} wrapper (API Gateway's+ * {@code VtlTemplateEngine.UtilVariable}, AppSync's {@code AppSyncUtil}) delegates the+ * overlapping functions here and keeps everything specific to its own template dialect+ * (error signaling, GraphQL-specific helpers, response overrides, etc.) to itself.+ */+public final class VtlUtilFunctions {++ private VtlUtilFunctions() {+ }++ /**+ * Escapes a string using EcmaScript/JavaScript string rules, matching AWS's+ * {@code $util.escapeJavaScript} (Apache Commons Lang escapeEcmaScript). Escapes:+ * backslash, double/single quotes, forward slash, control chars, and non-ASCII+ * characters (outside 0x20-0x7E) as unicode escape sequences.+ */+ public static String escapeJavaScript(String s) {+ if (s == null) return "";+ StringBuilder sb = new StringBuilder(s.length() + 16);+ for (int i = 0; i < s.length(); i++) {+ char c = s.charAt(i);+ switch (c) {+ case '\\' -> sb.append("\\\\");+ case '"' -> sb.append("\\\"");+ case '\'' -> sb.append("\\'");+ case '/' -> sb.append("\\/");+ case '\b' -> sb.append("\\b");+ case '\t' -> sb.append("\\t");+ case '\n' -> sb.append("\\n");+ case '\f' -> sb.append("\\f");+ case '\r' -> sb.append("\\r");+ default -> {+ if (c < 0x20 || c > 0x7E) {+ sb.append("\\u").append(String.format("%04x", (int) c));+ } else {+ sb.append(c);+ }+ }+ }+ }+ return sb.toString();+ }++ /** URL-encodes a string. */+ public static String urlEncode(String s) {+ if (s == null) return "";+ return URLEncoder.encode(s, StandardCharsets.UTF_8);+ }++ /** URL-decodes a string. */+ public static String urlDecode(String s) {+ if (s == null) return "";+ return URLDecoder.decode(s, StandardCharsets.UTF_8);+ }++ /**+ * Base64-encodes a string, UTF-8 encoded first. This is API Gateway's+ * {@code $util.base64Encode}, which takes a string.+ */+ public static String base64Encode(String s) {+ if (s == null) return "";+ return Base64.getEncoder().encodeToString(s.getBytes(StandardCharsets.UTF_8));+ }++ /**+ * Base64-encodes raw bytes. This is AppSync's {@code $util.base64Encode}, which+ * operates on a Blob rather than a string.+ */+ public static String base64Encode(byte[] data) {+ if (data == null) return "";+ return Base64.getEncoder().encodeToString(data);+ }++ /** Base64-decodes a string. */+ public static String base64Decode(String s) {+ if (s == null) return "";+ return new String(Base64.getDecoder().decode(s), StandardCharsets.UTF_8);+ }++ /** Parses a JSON string into a Map/List structure navigable in VTL. */+ public static Object parseJson(ObjectMapper objectMapper, String s) {+ if (s == null || s.isEmpty()) return Map.of();+ try {+ return objectMapper.readValue(s, Object.class);+ } catch (JsonProcessingException e) {+ return Map.of();+ }+ }+}diff --git a/src/main/java/io/github/hectorvent/floci/services/apigateway/VtlTemplateEngine.java b/src/main/java/io/github/hectorvent/floci/services/apigateway/VtlTemplateEngine.javaindex d9ca54cf85..dc3bef7f23 100644--- a/src/main/java/io/github/hectorvent/floci/services/apigateway/VtlTemplateEngine.java+++ b/src/main/java/io/github/hectorvent/floci/services/apigateway/VtlTemplateEngine.java@@ -1,8 +1,8 @@package io.github.hectorvent.floci.services.apigateway;-import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.JsonNode;import com.fasterxml.jackson.databind.ObjectMapper;+import io.github.hectorvent.floci.core.common.vtl.VtlUtilFunctions;import jakarta.enterprise.context.ApplicationScoped;import jakarta.inject.Inject;import io.quarkus.runtime.annotations.RegisterForReflection;@@ -28,11 +28,7 @@ import org.apache.velocity.util.introspection.TypeConversionHandlerImpl;import org.apache.velocity.util.introspection.UberspectImpl;import java.io.StringWriter;-import java.net.URLDecoder;-import java.net.URLEncoder;-import java.nio.charset.StandardCharsets;import java.util.AbstractMap;-import java.util.Base64;import java.util.HashMap;import java.util.Map;import java.util.Set;@@ -336,68 +332,34 @@ public class VtlTemplateEngine {/*** Escapes a string using EcmaScript/JavaScript string rules.* Matches AWS API Gateway behavior (Apache Commons Lang escapeEcmaScript).- * Escapes: backslash, double/single quotes, forward slash, control chars,- * and non-ASCII characters (outside 0x20-0x7E) as unicode escape sequences.*/public String escapeJavaScript(String s) {- if (s == null) return "";- StringBuilder sb = new StringBuilder(s.length() + 16);- for (int i = 0; i < s.length(); i++) {- char c = s.charAt(i);- switch (c) {- case '\\' -> sb.append("\\\\");- case '"' -> sb.append("\\\"");- case '\'' -> sb.append("\\'");- case '/' -> sb.append("\\/");- case '\b' -> sb.append("\\b");- case '\t' -> sb.append("\\t");- case '\n' -> sb.append("\\n");- case '\f' -> sb.append("\\f");- case '\r' -> sb.append("\\r");- default -> {- if (c < 0x20 || c > 0x7E) {- sb.append("\\u").append(String.format("%04x", (int) c));- } else {- sb.append(c);- }- }- }- }- return sb.toString();+ return VtlUtilFunctions.escapeJavaScript(s);}/** URL-encodes a string. */public String urlEncode(String s) {- if (s == null) return "";- return URLEncoder.encode(s, StandardCharsets.UTF_8);+ return VtlUtilFunctions.urlEncode(s);}/** URL-decodes a string. */public String urlDecode(String s) {- if (s == null) return "";- return URLDecoder.decode(s, StandardCharsets.UTF_8);+ return VtlUtilFunctions.urlDecode(s);}/** Base64-encodes a string. */public String base64Encode(String s) {- if (s == null) return "";- return Base64.getEncoder().encodeToString(s.getBytes(StandardCharsets.UTF_8));+ return VtlUtilFunctions.base64Encode(s);}/** Base64-decodes a string. */public String base64Decode(String s) {- if (s == null) return "";- return new String(Base64.getDecoder().decode(s), StandardCharsets.UTF_8);+ return VtlUtilFunctions.base64Decode(s);}/** Parses a JSON string into a Map/List structure navigable in VTL. */public Object parseJson(String s) {- if (s == null || s.isEmpty()) return Map.of();- try {- return objectMapper.readValue(s, Object.class);- } catch (JsonProcessingException e) {- return Map.of();- }+ return VtlUtilFunctions.parseJson(objectMapper, s);}}}diff --git a/src/main/java/io/github/hectorvent/floci/services/appsync/graphql/util/AppSyncUtil.java b/src/main/java/io/github/hectorvent/floci/services/appsync/graphql/util/AppSyncUtil.javaindex 7aa3346aca..ee2bde04be 100644--- a/src/main/java/io/github/hectorvent/floci/services/appsync/graphql/util/AppSyncUtil.java+++ b/src/main/java/io/github/hectorvent/floci/services/appsync/graphql/util/AppSyncUtil.java@@ -2,10 +2,8 @@ package io.github.hectorvent.floci.services.appsync.graphql.util;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;+import io.github.hectorvent.floci.core.common.vtl.VtlUtilFunctions;-import java.net.URLDecoder;-import java.net.URLEncoder;-import java.nio.charset.StandardCharsets;import java.util.*;import java.util.regex.Pattern;@@ -50,59 +48,27 @@ public class AppSyncUtil {public MapUtil getMap() { return mapUtil; }public String escapeJavaScript(String s) {- if (s == null) return "";- StringBuilder sb = new StringBuilder(s.length() + 16);- for (int i = 0; i < s.length(); i++) {- char c = s.charAt(i);- switch (c) {- case '\\' -> sb.append("\\\\");- case '"' -> sb.append("\\\"");- case '\'' -> sb.append("\\'");- case '/' -> sb.append("\\/");- case '\b' -> sb.append("\\b");- case '\t' -> sb.append("\\t");- case '\n' -> sb.append("\\n");- case '\f' -> sb.append("\\f");- case '\r' -> sb.append("\\r");- default -> {- if (c < 0x20 || c > 0x7E) {- sb.append("\\u").append(String.format("%04x", (int) c));- } else {- sb.append(c);- }- }- }- }- return sb.toString();+ return VtlUtilFunctions.escapeJavaScript(s);}public String urlEncode(String s) {- if (s == null) return "";- return URLEncoder.encode(s, StandardCharsets.UTF_8);+ return VtlUtilFunctions.urlEncode(s);}public String urlDecode(String s) {- if (s == null) return "";- return URLDecoder.decode(s, StandardCharsets.UTF_8);+ return VtlUtilFunctions.urlDecode(s);}public String base64Encode(byte[] data) {- if (data == null) return "";- return Base64.getEncoder().encodeToString(data);+ return VtlUtilFunctions.base64Encode(data);}public String base64Decode(String s) {- if (s == null) return "";- return new String(Base64.getDecoder().decode(s), StandardCharsets.UTF_8);+ return VtlUtilFunctions.base64Decode(s);}public Object parseJson(String s) {- if (s == null || s.isEmpty()) return Map.of();- try {- return objectMapper.readValue(s, Object.class);- } catch (JsonProcessingException e) {- return Map.of();- }+ return VtlUtilFunctions.parseJson(objectMapper, s);}public String toJson(Object o) {