feat(javalinWidgets): listen for POST requests to /widget/{name} endpoints to support larger param sets than query string / URI length (#243)

Author: darinkelkhoff

qqq-middleware-javalin/src/main/java/com/kingsrook/qqq/backend/javalin/QJavalinImplementation.java

@@ -436,21 +436,14 @@ public EndpointGroup getRoutes()
          post("/possibleValues/{possibleValueSourceName}", QJavalinImplementation::possibleValuesStandalone);
 
          get("/widget/{name}", QJavalinImplementation::widget); // todo - can we just do a slow log here?
+         post("/widget/{name}", QJavalinImplementation::widget);
 
          get("/serverInfo", QJavalinImplementation::serverInfo);
 
          ////////////////////
          // process routes //
          ////////////////////
          path("", QJavalinProcessHandler.getRoutes());
-
-         // todo... ? ////////////////
-         // todo... ? // api routes //
-         // todo... ? ////////////////
-         // todo... ? if(qInstance.getApiMetaData() != null)
-         // todo... ? {
-         // todo... ?    path("", QJavalinApiHandler.getRoutes());
-         // todo... ? }
       });
    }
 
@@ -1580,6 +1573,19 @@ private static void widget(Context context)
             }
          }
 
+         ////////////////////////////
+         // process form/post body //
+         ////////////////////////////
+         for(Map.Entry<String, List<String>> formParam : context.formParamMap().entrySet())
+         {
+            String       fieldName = formParam.getKey();
+            List<String> values    = formParam.getValue();
+            if(CollectionUtils.nullSafeHasContents(values))
+            {
+               input.addQueryParam(fieldName, values.get(0));
+            }
+         }
+
          RenderWidgetOutput output = new RenderWidgetAction().execute(input);
          QJavalinAccessLogger.logEndSuccessIfSlow(SLOW_LOG_THRESHOLD_MS, logPair("widgetName", widgetName), logPair("inputParams", input.getQueryParams()));
          context.result(JsonUtils.toJson(output.getWidgetData()));

qqq-middleware-javalin/src/test/java/com/kingsrook/qqq/backend/javalin/QJavalinImplementationTest.java

@@ -512,7 +512,7 @@ public void test_dataQueryWithFilterAndQueryJoin()
          """;
 
       HttpResponse<String> response = Unirest.get(BASE_URL + "/data/person?filter=" + URLEncoder.encode(filterJson, StandardCharsets.UTF_8)
-         + "&queryJoins=" + URLEncoder.encode(queryJoinsJson, StandardCharsets.UTF_8)).asString();
+                                                  + "&queryJoins=" + URLEncoder.encode(queryJoinsJson, StandardCharsets.UTF_8)).asString();
 
       assertEquals(200, response.getStatus());
       JSONObject jsonObject = JsonUtils.toJSONObject(response.getBody());
@@ -1056,6 +1056,7 @@ void testExportSupportedFormat()
    }
 
 
+
    /*******************************************************************************
     **
     *******************************************************************************/
@@ -1089,6 +1090,42 @@ void testWidget()
 
 
 
+   /*******************************************************************************
+    * verify that query string params form a GET are processed
+    *******************************************************************************/
+   @Test
+   void testWidgetQueryStringParam()
+   {
+      HttpResponse<String> response = Unirest.get(BASE_URL + "/widget/" + TestUtils.EchoWidgetRenderer.class.getSimpleName() + "?input=helloThere").asString();
+      assertEquals(200, response.getStatus());
+      JSONObject jsonObject = JsonUtils.toJSONObject(response.getBody());
+      assertNotNull(jsonObject);
+      assertEquals(WidgetType.HTML.getType(), jsonObject.getString("type"));
+      assertNotNull(jsonObject.getString("title"));
+      assertEquals("helloThere", jsonObject.getString("html"));
+   }
+
+
+
+   /*******************************************************************************
+    * verify the widget POST endpoint and that it accepts posted values (multipart form)
+    *******************************************************************************/
+   @Test
+   void testWidgetPost()
+   {
+      HttpResponse<String> response = Unirest.post(BASE_URL + "/widget/" + TestUtils.EchoWidgetRenderer.class.getSimpleName())
+         .field("input", "foobar")
+         .asString();
+      assertEquals(200, response.getStatus());
+      JSONObject jsonObject = JsonUtils.toJSONObject(response.getBody());
+      assertNotNull(jsonObject);
+      assertEquals(WidgetType.HTML.getType(), jsonObject.getString("type"));
+      assertNotNull(jsonObject.getString("title"));
+      assertEquals("foobar", jsonObject.getString("html"));
+   }
+
+
+
    /*******************************************************************************
     **
     *******************************************************************************/

qqq-middleware-javalin/src/test/java/com/kingsrook/qqq/backend/javalin/TestUtils.java

@@ -241,7 +241,7 @@ public static QInstance defineInstance()
          // similarly tests use apiName & apiVersion, but those fields aren't in the table because //
          // the api module isn't available, so, add them to make tests work.                       //
          ////////////////////////////////////////////////////////////////////////////////////////////
-         QTableMetaData table     = qInstance.getTable("scriptRevision");
+         QTableMetaData table = qInstance.getTable("scriptRevision");
          table.addField(new QFieldMetaData("content", QFieldType.STRING));
          table.addField(new QFieldMetaData("apiName", QFieldType.STRING));
          table.addField(new QFieldMetaData("apiVersion", QFieldType.STRING));
@@ -347,6 +347,10 @@ private static void defineWidgets(QInstance qInstance)
          .withType(WidgetType.HTML.getType())
          .withCodeReference(new QCodeReference(TimezoneWidgetRenderer.class)));
 
+      qInstance.addWidget(new QWidgetMetaData()
+         .withName(EchoWidgetRenderer.class.getSimpleName())
+         .withType(WidgetType.HTML.getType())
+         .withCodeReference(new QCodeReference(EchoWidgetRenderer.class)));
    }
 
 
@@ -844,6 +848,27 @@ public static void insertRecords(QInstance qInstance, QTableMetaData table, List
 
 
 
+   /***************************************************************************
+    * simple test widget, that echos back html (really just text) equal to the
+    * "input" param that it receives
+    ***************************************************************************/
+   public static class EchoWidgetRenderer extends AbstractWidgetRenderer
+   {
+
+      /***************************************************************************
+       **
+       ***************************************************************************/
+      @Override
+      public RenderWidgetOutput render(RenderWidgetInput input) throws QException
+      {
+         return (new RenderWidgetOutput(new RawHTML("title",
+            input.getQueryParams().get("input")
+         )));
+      }
+   }
+
+
+
    /***************************************************************************
     **
     ***************************************************************************/
@@ -858,7 +883,7 @@ public RenderWidgetOutput render(RenderWidgetInput input) throws QException
       {
          return (new RenderWidgetOutput(new RawHTML("title",
             QContext.getQSession().getValue(QSession.VALUE_KEY_USER_TIMEZONE_OFFSET_MINUTES)
-               + "|" + QContext.getQSession().getValue(QSession.VALUE_KEY_USER_TIMEZONE)
+            + "|" + QContext.getQSession().getValue(QSession.VALUE_KEY_USER_TIMEZONE)
          )));
       }
    }