Add new test service api to return label values for filter: Fixes #1767

Apply suggestions from code review

Co-authored-by: Andrea Lamparelli <[email protected]>

Author: johnaohara

docs/site/content/en/openapi/openapi.yaml

@@ -2032,6 +2032,29 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/TestExport'
+  /api/test/{id}/filteringLabelValues:
+    get:
+      tags:
+      - Test
+      description: List all unique Label Values for a Test
+      operationId: filteringLabelValues
+      parameters:
+      - name: id
+        in: path
+        description: Test ID to retrieve Filtering Label Values for
+        required: true
+        schema:
+          format: int32
+          type: integer
+        example: 10
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items: {}
   /api/test/{id}/fingerprint:
     get:
       tags:

horreum-api/src/main/java/io/hyperfoil/tools/horreum/api/services/TestService.java

@@ -252,6 +252,21 @@ List<ExportedLabelValues> labelValues(
            @QueryParam("exclude") @Separator(",") List<String> exclude,
            @QueryParam("multiFilter") @DefaultValue("false") boolean multiFilter);
 
+   @GET
+   @Path("{id}/filteringLabelValues")
+   @Operation(description="List all unique Label Values for a Test")
+   @Parameters(value = {
+           @Parameter(name = "id", description = "Test ID to retrieve Filtering Label Values for", example = "10"),
+   })
+   @APIResponses(
+           value = { @APIResponse( responseCode = "200",
+                   content = {
+                           @Content ( schema = @Schema(type = SchemaType.ARRAY, implementation = Object.class)) }
+           )}
+   )
+   List<ObjectNode> filteringLabelValues(
+           @PathParam("id") int testId);
+
    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    @Path("{id}/transformers")

horreum-backend/src/main/java/io/hyperfoil/tools/horreum/svc/TestServiceImpl.java

@@ -46,6 +46,7 @@
 import jakarta.transaction.TransactionManager;
 import jakarta.transaction.Transactional;
 import jakarta.ws.rs.DefaultValue;
+import jakarta.ws.rs.PathParam;
 import jakarta.ws.rs.WebApplicationException;
 import jakarta.ws.rs.core.Response;
 import org.hibernate.Hibernate;
@@ -103,6 +104,15 @@ SELECT DISTINCT COALESCE(jsonb_object_agg(label.name, lv.value) FILTER (WHERE la
          ) select * from combined FILTER_PLACEHOLDER ORDER_PLACEHOLDER limit :limit offset :offset
          """;
 
+   protected static final String LABEL_VALUES_SUMMARY_QUERY = """
+         SELECT DISTINCT COALESCE(jsonb_object_agg(label.name, lv.value), '{}'::jsonb) AS values
+                  FROM dataset
+                  INNER JOIN label_values lv ON dataset.id = lv.dataset_id
+                  INNER JOIN label ON label.id = lv.label_id
+                  WHERE dataset.testid = :testId AND label.filtering
+                  GROUP BY dataset.id, runId
+         """;
+
 
    //@formatter:on
    @Inject
@@ -821,6 +831,26 @@ public List<ExportedLabelValues> labelValues(int testId, String filter, String b
            return ExportedLabelValues.parse( query.getResultList() );
    }
 
+   @Transactional
+   @WithRoles
+   @Override
+   public List<ObjectNode> filteringLabelValues(
+           @PathParam("id") int testId){
+
+      TestDAO.findByIdOptional(testId).orElseThrow(() -> ServiceException.serverError("Cannot find test " + testId));
+
+      NativeQuery<ObjectNode> query = ((NativeQuery<ObjectNode>) em.createNativeQuery(LABEL_VALUES_SUMMARY_QUERY))
+              .setParameter("testId", testId);
+
+      query
+              .unwrap(NativeQuery.class)
+              .addScalar("values", JsonBinaryType.INSTANCE);
+      List<ObjectNode> filters = query.getResultList();
+
+      return filters != null ? filters : new ArrayList<>();
+
+   }
+
    @WithRoles
    @Transactional
    @Override

horreum-backend/src/test/java/io/hyperfoil/tools/horreum/svc/BaseServiceTest.java

@@ -503,11 +503,20 @@ protected int addLabel(Schema schema, String name, String function, Extractor...
       return lastAddedLabelId;
    }
 
+   protected int addLabel(Schema schema, String name, String function, boolean filtering, boolean metric, Extractor... extractors) {
+      lastAddedLabelId = postLabel(schema, name, function, null, filtering, metric, extractors);
+      return lastAddedLabelId;
+   }
+
    protected int updateLabel(Schema schema, int labelId, String name, String function, Extractor... extractors) {
       return postLabel(schema, name, function, l -> l.id = labelId, extractors);
    }
 
    protected int postLabel(Schema schema, String name, String function, Consumer<Label> mutate, Extractor... extractors) {
+      return postLabel(schema, name, function, mutate, true, true, extractors);
+   }
+
+   protected int postLabel(Schema schema, String name, String function, Consumer<Label> mutate, boolean filtering, boolean metric,  Extractor... extractors) {
       Label l = new Label();
       l.name = name;
       l.function = function;

horreum-backend/src/test/java/io/hyperfoil/tools/horreum/svc/TestServiceTest.java

@@ -248,6 +248,56 @@ public void testLabelValues(TestInfo info) throws InterruptedException {
       assertEquals(2, values.size());
       assertTrue(values.get(1).values.containsKey("value"));
    }
+   @org.junit.jupiter.api.Test
+   public void testFilterLabelValues(TestInfo info) throws InterruptedException {
+      Test test = createTest(createExampleTest(getTestName(info)));
+
+      String name = info.getTestClass().map(Class::getName).orElse("<unknown>") + "." + info.getDisplayName();
+      Schema schema = createSchema(name, uriForTest(info, "1.0"));
+
+
+      addLabel(schema, "filter-1", null, true, false, new Extractor("filter", "$.filter1", false));
+      addLabel(schema, "filter-2", null, true, false, new Extractor("filter", "$.filter2", false));
+
+
+      BlockingQueue<Dataset.LabelsUpdatedEvent> newDatasetQueue = serviceMediator.getEventQueue(AsyncEventChannels.DATASET_UPDATED_LABELS, test.id);
+      ObjectNode run;
+
+      run = runWithValue(42, schema);
+      run.put("filter1", "foo");
+      run.put("filter2", "bar");
+      uploadRun(run, test.name);
+
+      run = runWithValue(43, schema);
+      run.put("filter1", "foo");
+      run.put("filter2", "bar");
+      uploadRun(run, test.name);
+
+      run = runWithValue(44, schema);
+      run.put("filter1", "biz");
+      run.put("filter2", "bar");
+      uploadRun(run, test.name);
+
+      run = runWithValue(45, schema);
+      run.put("filter1", "foo");
+      run.put("filter2", "baz");
+      uploadRun(run, test.name);
+
+      for( int i = 0 ; i < 4; i++){
+         assertNotNull(newDatasetQueue.poll(10, TimeUnit.SECONDS));
+      }
+
+      List<ObjectNode> values = jsonRequest().get("/api/test/" + test.id + "/filteringLabelValues").then().statusCode(200).
+              extract().body().as(new TypeRef<>() {});
+      assertNotNull(values);
+      assertFalse(values.isEmpty());
+      assertEquals(3, values.size());
+      assertNotNull(values.stream().filter( node -> node.get("filter-1").asText().equals("foo") && node.get("filter-2").asText().equals("bar")).findAny().orElse(null));
+      assertNotNull(values.stream().filter( node -> node.get("filter-1").asText().equals("biz") && node.get("filter-2").asText().equals("bar")).findAny().orElse(null));
+      assertNotNull(values.stream().filter( node -> node.get("filter-1").asText().equals("foo") && node.get("filter-2").asText().equals("baz")).findAny().orElse(null));
+
+   }
+
    @org.junit.jupiter.api.Test
    public void testImportFromFile() throws JsonProcessingException {
       Path p = new File(getClass().getClassLoader().getResource(".").getPath()).toPath();

horreum-web/src/domain/runs/TestDatasets.tsx

@@ -205,20 +205,9 @@ export default function TestDatasets() {
         })
         return allColumns
     }, [test, token, comparedDatasets, viewId, views])
-    const flattenLabelValues = (labelValues: Array<ExportedLabelValues>) => {
-        const resultArr : any = [];
-        labelValues.forEach( (labelValue) => {
-            resultArr.push(labelValue.values)
-        })
-        return resultArr;
-    }
 
-    const labelsSource = useCallback(() => {
-        return testApi.labelValues(testIdInt)
-            .then((result: Array<ExportedLabelValues>) => {
-                return flattenLabelValues(result);
-            })
-    }, [testIdInt, teams, token])
+    const labelsSource = useCallback(() => testApi.filteringLabelValues(testIdInt), [testIdInt, teams, token])
+
     return (
         <>
             <Toolbar className="pf-v5-u-justify-content-space-between" style={{ width: "100%" }}>