improve server side html template js api

ptrthomas · ptrthomas · commit 252aab7ec01c · 2021-05-16T10:54:58.000+05:30
diff --git a/karate-core/src/main/java/com/intuit/karate/core/ScenarioEngine.java b/karate-core/src/main/java/com/intuit/karate/core/ScenarioEngine.java
@@ -988,7 +988,7 @@ public void doc(String exp) {
         }
         if (templateEngine == null) {
             String prefixedPath = runtime.featureRuntime.rootFeature.feature.getResource().getPrefixedParentPath();
-            templateEngine = TemplateUtils.forResourcePath(JS, prefixedPath);
+            templateEngine = TemplateUtils.forResourceRoot(JS, prefixedPath);
         }
         String html = templateEngine.process(path);
         runtime.embed(FileUtils.toBytes(html), ResourceType.HTML);
diff --git a/karate-core/src/main/java/com/intuit/karate/http/ServerContext.java b/karate-core/src/main/java/com/intuit/karate/http/ServerContext.java
@@ -25,8 +25,11 @@
 
 import com.intuit.karate.FileUtils;
 import com.intuit.karate.graal.JsArray;
+import com.intuit.karate.graal.JsEngine;
 import com.intuit.karate.graal.JsValue;
 import com.intuit.karate.graal.Methods;
+import com.intuit.karate.template.KarateTemplateEngine;
+import com.intuit.karate.template.TemplateUtils;
 import io.netty.handler.codec.http.cookie.Cookie;
 import io.netty.handler.codec.http.cookie.ServerCookieDecoder;
 import java.io.InputStream;
@@ -108,6 +111,43 @@ public ServerContext(ServerConfig config, Request request, Map<String, Object> v
             }
             return http;
         };
+        RENDER_FUNCTION = o -> {
+            if (o instanceof String) {
+                return RequestCycle.get().getTemplateEngine().process((String) o);
+            }
+            Map<String, Object> map;
+            if (o instanceof Map) {
+                map = (Map) o;
+            } else {
+                logger.warn("invalid argument to render: {}", o);
+                return null;
+            }
+            Map<String, Object> templateVars = (Map) map.get("variables");
+            String path = (String) map.get("path");
+            if (path != null) {
+                if (templateVars == null) {
+                    return RequestCycle.get().getTemplateEngine().process(path);
+                }
+                JsEngine je = JsEngine.local();
+                je.putAll(templateVars);
+                KarateTemplateEngine kte = TemplateUtils.forResourceResolver(je, config.getResourceResolver());
+                return kte.process(path);
+            }
+            String html = (String) map.get("html");
+            if (html == null) {
+                logger.warn("invalid argument to render, path or html needed: {}", map);
+                return null;
+            }
+            JsEngine je;
+            if (templateVars == null) {
+                je = RequestCycle.get().getEngine();
+            } else {
+                je = JsEngine.local();
+                je.putAll(templateVars);
+            }
+            KarateTemplateEngine kte = TemplateUtils.forStrings(je);
+            return kte.process(html);
+        };
     }
 
     private static final String DOT_JS = ".js";
@@ -273,7 +313,9 @@ public void afterSettle(String js) {
 
     private static final Supplier<String> UUID_FUNCTION = () -> java.util.UUID.randomUUID().toString();
     private static final Function<String, Object> FROM_JSON_FUNCTION = s -> JsValue.fromString(s, false, null);
+
     private final Methods.FunVar HTTP_FUNCTION; // set in constructor
+    private final Function<Object, String> RENDER_FUNCTION; // set in constructor
 
     private final Consumer<String> SWITCH_FUNCTION = s -> {
         if (switched) {
@@ -307,8 +349,6 @@ public void afterSettle(String js) {
         return o;
     };
 
-    private final Function<String, String> RENDER_FUNCTION = s -> RequestCycle.get().getTemplateEngine().process(s);
-
     @Override
     public Object getMember(String key) {
         switch (key) {
diff --git a/karate-core/src/main/java/com/intuit/karate/report/Report.java b/karate-core/src/main/java/com/intuit/karate/report/Report.java
@@ -53,7 +53,7 @@ default File render() {
 
     default File render(String reportDir) {
         JsEngine je = getJsEngine();
-        KarateTemplateEngine engine = TemplateUtils.forResourcePath(je, getResourceRoot());
+        KarateTemplateEngine engine = TemplateUtils.forResourceRoot(je, getResourceRoot());
         String html = engine.process(getTemplate());
         if (reportDir == null) {
             reportDir = getReportDir();
diff --git a/karate-core/src/main/java/com/intuit/karate/template/TemplateUtils.java b/karate-core/src/main/java/com/intuit/karate/template/TemplateUtils.java
@@ -41,7 +41,7 @@ private TemplateUtils() {
         // only static methods
     }
 
-    private static final String HTMX_SCRIPT_TAG = "<script src=\"https://unpkg.com/htmx.org@1.2.0\"></script>";
+    private static final String HTMX_SCRIPT_TAG = "<script src=\"https://unpkg.com/htmx.org@1.3.3\"></script>";
 
     public static IModel generateHeadScriptTag(ITemplateContext ctx) {
         IModelFactory modelFactory = ctx.getModelFactory();
@@ -69,11 +69,14 @@ public static KarateTemplateEngine forStrings(JsEngine je) {
         return engine;
     }
 
-    public static KarateTemplateEngine forResourcePath(JsEngine je, String root) {
-        ResourceResolver resourceResolver = new ResourceResolver(root);
+    public static KarateTemplateEngine forResourceResolver(JsEngine je, ResourceResolver resourceResolver) {
         KarateTemplateEngine engine = new KarateTemplateEngine(je, new KarateScriptDialect(resourceResolver));
         engine.setTemplateResolver(new ResourceHtmlTemplateResolver(resourceResolver));
         return engine;
     }
 
+    public static KarateTemplateEngine forResourceRoot(JsEngine je, String root) {
+        return forResourceResolver(je, new ResourceResolver(root));
+    }
+
 }
diff --git a/karate-core/src/test/java/com/intuit/karate/resource/ResourceUtilsTest.java b/karate-core/src/test/java/com/intuit/karate/resource/ResourceUtilsTest.java
@@ -197,15 +197,15 @@ void testClassPathToFileThatDoesNotExist() {
     @Test
     void testFindJsFilesFromFileSystem() {
         Set<String> files = ResourceUtils.findJsFilesInDirectory(new File("src/test/java/demo").getAbsoluteFile());
-        assertEquals(3, files.size());
-        Match.that(new ArrayList(files)).contains("['api/demo.js', 'api/cats.js', 'api/payments.js']");
+        assertEquals(4, files.size());
+        Match.that(new ArrayList(files)).contains("['api/demo.js', 'api/cats.js', 'api/payments.js', 'api/render.js']");
     }
     
     @Test
     void testFindJsFilesFromClassPath() {
         Set<String> files = ResourceUtils.findJsFilesInClassPath("demo");
-        assertEquals(3, files.size());
-        Match.that(new ArrayList(files)).contains("['/api/demo.js', '/api/cats.js', '/api/payments.js']");
+        assertEquals(4, files.size());
+        Match.that(new ArrayList(files)).contains("['/api/demo.js', '/api/cats.js', '/api/payments.js', '/api/render.js']");
     }    
 
 }
diff --git a/karate-core/src/test/java/com/intuit/karate/template/TemplateTest.java b/karate-core/src/test/java/com/intuit/karate/template/TemplateTest.java
@@ -26,7 +26,7 @@ void testHtmlString() {
     @Test
     void testHtmlFile() {
         JsEngine je = JsEngine.local();
-        KarateTemplateEngine engine = TemplateUtils.forResourcePath(je, "classpath:com/intuit/karate/template");
+        KarateTemplateEngine engine = TemplateUtils.forResourceRoot(je, "classpath:com/intuit/karate/template");
         String rendered = engine.process("main.html");
         // logger.debug("rendered: {}", rendered);
         assertTrue(rendered.contains("<div id=\"before_one\"><span>js_one</span></div>"));
diff --git a/karate-core/src/test/java/demo/api/render.js b/karate-core/src/test/java/demo/api/render.js
@@ -0,0 +1,6 @@
+var someName = 'John';
+var msg1 = context.render('api/test');
+var msg2 = context.render({path: 'api/test.html', variables: {someName: 'Smith'}});
+var msg3 = context.render({html: '<div th:text="someName"></div>'});
+var msg4 = context.render({html: '<div th:text="someName"></div>', variables: {someName: 'Smith'}});
+response.body = {msg1: msg1, msg2: msg2, msg3: msg3, msg4: msg4};
diff --git a/karate-core/src/test/java/demo/api/test.html b/karate-core/src/test/java/demo/api/test.html
@@ -0,0 +1 @@
+<h1 th:text="someName"></h1>

Original file line number	Diff line number	Diff line change
`@@ -988,7 +988,7 @@ public void doc(String exp) {`
`988`	`988`	`}`
`989`	`989`	`if (templateEngine == null) {`
`990`	`990`	`String prefixedPath = runtime.featureRuntime.rootFeature.feature.getResource().getPrefixedParentPath();`
`991`		`- templateEngine = TemplateUtils.forResourcePath(JS, prefixedPath);`
	`991`	`+ templateEngine = TemplateUtils.forResourceRoot(JS, prefixedPath);`
`992`	`992`	`}`
`993`	`993`	`String html = templateEngine.process(path);`
`994`	`994`	`runtime.embed(FileUtils.toBytes(html), ResourceType.HTML);`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ private TemplateUtils() {`
`41`	`41`	`// only static methods`
`42`	`42`	`}`
`43`	`43`
`44`		`- private static final String HTMX_SCRIPT_TAG = "<script src=\"https://unpkg.com/htmx.org@1.2.0\"></script>";`
	`44`	`+ private static final String HTMX_SCRIPT_TAG = "<script src=\"https://unpkg.com/htmx.org@1.3.3\"></script>";`
`45`	`45`
`46`	`46`	`public static IModel generateHeadScriptTag(ITemplateContext ctx) {`
`47`	`47`	`IModelFactory modelFactory = ctx.getModelFactory();`
`@@ -69,11 +69,14 @@ public static KarateTemplateEngine forStrings(JsEngine je) {`
`69`	`69`	`return engine;`
`70`	`70`	`}`
`71`	`71`
`72`		`- public static KarateTemplateEngine forResourcePath(JsEngine je, String root) {`
`73`		`- ResourceResolver resourceResolver = new ResourceResolver(root);`
	`72`	`+ public static KarateTemplateEngine forResourceResolver(JsEngine je, ResourceResolver resourceResolver) {`
`74`	`73`	`KarateTemplateEngine engine = new KarateTemplateEngine(je, new KarateScriptDialect(resourceResolver));`
`75`	`74`	`engine.setTemplateResolver(new ResourceHtmlTemplateResolver(resourceResolver));`
`76`	`75`	`return engine;`
`77`	`76`	`}`
`78`	`77`
	`78`	`+ public static KarateTemplateEngine forResourceRoot(JsEngine je, String root) {`
	`79`	`+ return forResourceResolver(je, new ResourceResolver(root));`
	`80`	`+ }`
	`81`	`+`
`79`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -197,15 +197,15 @@ void testClassPathToFileThatDoesNotExist() {`
`197`	`197`	`@Test`
`198`	`198`	`void testFindJsFilesFromFileSystem() {`
`199`	`199`	`Set<String> files = ResourceUtils.findJsFilesInDirectory(new File("src/test/java/demo").getAbsoluteFile());`
`200`		`- assertEquals(3, files.size());`
`201`		`- Match.that(new ArrayList(files)).contains("['api/demo.js', 'api/cats.js', 'api/payments.js']");`
	`200`	`+ assertEquals(4, files.size());`
	`201`	`+ Match.that(new ArrayList(files)).contains("['api/demo.js', 'api/cats.js', 'api/payments.js', 'api/render.js']");`
`202`	`202`	`}`
`203`	`203`
`204`	`204`	`@Test`
`205`	`205`	`void testFindJsFilesFromClassPath() {`
`206`	`206`	`Set<String> files = ResourceUtils.findJsFilesInClassPath("demo");`
`207`		`- assertEquals(3, files.size());`
`208`		`- Match.that(new ArrayList(files)).contains("['/api/demo.js', '/api/cats.js', '/api/payments.js']");`
	`207`	`+ assertEquals(4, files.size());`
	`208`	`+ Match.that(new ArrayList(files)).contains("['/api/demo.js', '/api/cats.js', '/api/payments.js', '/api/render.js']");`
`209`	`209`	`}`
`210`	`210`
`211`	`211`	`}`