filter by variables (#349)

FLPATH-1991
https://issues.redhat.com/browse/FLPATH-1991

Signed-off-by: Yaron Dayagi <ydayagi@redhat.com>

Author: ydayagi

workspaces/orchestrator/.changeset/warm-news-give.md

@@ -0,0 +1,6 @@
+---
+'@red-hat-developer-hub/backstage-plugin-orchestrator-backend': patch
+'@red-hat-developer-hub/backstage-plugin-orchestrator-common': patch
+---
+
+add filter by variables and nested variables

workspaces/orchestrator/plugins/orchestrator-backend/src/helpers/filterBuilder.ts

@@ -20,6 +20,7 @@ import {
   Filter,
   IntrospectionField,
   LogicalFilter,
+  NestedFilter,
   TypeName,
 } from '@red-hat-developer-hub/backstage-plugin-orchestrator-common';
 
@@ -64,6 +65,10 @@ function isLogicalFilter(filter: Filter): filter is LogicalFilter {
   return (filter as LogicalFilter).filters !== undefined;
 }
 
+function isNestedFilter(filter: Filter): filter is NestedFilter {
+  return (filter as NestedFilter).nested !== undefined;
+}
+
 function handleLogicalFilter(
   introspection: IntrospectionField[],
   type: ProcessType,
@@ -78,6 +83,21 @@ function handleLogicalFilter(
   return `${filter.operator.toLowerCase()}: {${subClauses.join(', ')}}`;
 }
 
+function handleNestedFilter(
+  introspection: IntrospectionField[],
+  type: ProcessType,
+  filter: NestedFilter,
+): string {
+  const subClauses = buildFilterCondition(
+    introspection,
+    type,
+    filter.nested,
+    true,
+  );
+
+  return `${filter.field}: {${subClauses}}`;
+}
+
 function handleBetweenOperator(filter: FieldFilter): string {
   if (!Array.isArray(filter.value) || filter.value.length !== 2) {
     throw new Error('Between operator requires an array of two elements');
@@ -114,7 +134,7 @@ function isValidEnumOperator(operator: FieldFilterOperatorEnum): boolean {
 
 function handleBinaryOperator(
   binaryFilter: FieldFilter,
-  fieldDef: IntrospectionField,
+  fieldDef: IntrospectionField | undefined,
   type: 'ProcessDefinition' | 'ProcessInstance',
 ): string {
   if (isEnumFilter(binaryFilter.field, type)) {
@@ -138,11 +158,16 @@ export function buildFilterCondition(
   introspection: IntrospectionField[],
   type: ProcessType,
   filters?: Filter,
+  isNested?: boolean,
 ): string {
   if (!filters) {
     return '';
   }
 
+  if (isNestedFilter(filters)) {
+    return handleNestedFilter(introspection, type, filters);
+  }
+
   if (isLogicalFilter(filters)) {
     return handleLogicalFilter(introspection, type, filters);
   }
@@ -153,16 +178,21 @@ export function buildFilterCondition(
     );
   }
 
-  const fieldDef = introspection.find(f => f.name === filters.field);
-  if (!fieldDef) {
-    throw new Error(`Can't find field "${filters.field}" definition`);
-  }
+  let fieldDef;
 
-  if (!isOperatorAllowedForField(filters.operator, fieldDef, type)) {
-    const allowedOperators = supportedOperatorsByType[fieldDef.type.name] || [];
-    throw new Error(
-      `Unsupported operator ${filters.operator} for field "${fieldDef.name}" of type "${fieldDef.type.name}". Allowed operators are: ${allowedOperators.join(', ')}`,
-    );
+  if (!isNested) {
+    fieldDef = introspection.find(f => f.name === filters.field);
+    if (!fieldDef) {
+      throw new Error(`Can't find field "${filters.field}" definition`);
+    }
+
+    if (!isOperatorAllowedForField(filters.operator, fieldDef, type)) {
+      const allowedOperators =
+        supportedOperatorsByType[fieldDef.type.name] || [];
+      throw new Error(
+        `Unsupported operator ${filters.operator} for field "${fieldDef.name}" of type "${fieldDef.type.name}". Allowed operators are: ${allowedOperators.join(', ')}`,
+      );
+    }
   }
 
   switch (filters.operator) {
@@ -221,9 +251,13 @@ function convertToBoolean(value: any): boolean {
 function formatValue(
   fieldName: string,
   fieldValue: any,
-  fieldDef: IntrospectionField,
+  fieldDef: IntrospectionField | undefined,
   type: ProcessType,
 ): string {
+  if (!fieldDef) {
+    return `"${fieldValue}"`;
+  }
+
   if (!isFieldFilterSupported) {
     throw new Error(`Unsupported field type ${fieldDef.type.name}`);
   }

workspaces/orchestrator/plugins/orchestrator-common/report.api.md

@@ -1 +1 @@
-cb305ab5d700a2949eb303ad16653ed83d86e53c
+64f078a27298ae8c5f83d7f244f3ab7cd6c9e39c

workspaces/orchestrator/plugins/orchestrator-common/src/generated/.METADATA.sha1

@@ -162,7 +162,7 @@ export type FieldFilterValue = any | boolean | number | string;
  * @type Filter
  * @export
  */
-export type Filter = FieldFilter | LogicalFilter;
+export type Filter = FieldFilter | LogicalFilter | NestedFilter;
 
 /**
  * 
@@ -230,6 +230,31 @@ export const LogicalFilterOperatorEnum = {
 
 export type LogicalFilterOperatorEnum = typeof LogicalFilterOperatorEnum[keyof typeof LogicalFilterOperatorEnum];
 
+/**
+ * 
+ * @export
+ * @interface NestedFilter
+ */
+export interface NestedFilter {
+    /**
+     * 
+     * @type {string}
+     * @memberof NestedFilter
+     */
+    'field': string;
+    /**
+     * 
+     * @type {NestedFilterNested}
+     * @memberof NestedFilter
+     */
+    'nested': NestedFilterNested;
+}
+/**
+ * @type NestedFilterNested
+ * @export
+ */
+export type NestedFilterNested = FieldFilter | NestedFilter;
+
 /**
  * 
  * @export

workspaces/orchestrator/plugins/orchestrator-common/src/generated/api/definition.ts

@@ -702,6 +702,19 @@ spec:
           oneOf:
             - $ref: '#/components/schemas/LogicalFilter'
             - $ref: '#/components/schemas/FieldFilter'
+            - $ref: '#/components/schemas/NestedFilter'
+        NestedFilter:
+          type: object
+          required:
+            - field
+            - nested
+          properties:
+            field:
+              type: string
+            nested:
+              oneOf:
+                - $ref: '#/components/schemas/FieldFilter'
+                - $ref: '#/components/schemas/NestedFilter'
         LogicalFilter:
           type: object
           required:

workspaces/orchestrator/plugins/orchestrator-common/src/generated/client/api.ts

@@ -948,6 +948,8 @@
     "$ref" : "#/components/schemas/LogicalFilter"
   }, {
     "$ref" : "#/components/schemas/FieldFilter"
+  }, {
+    "$ref" : "#/components/schemas/NestedFilter"
   } ]
 };
     defs["GetOverviewsRequestParams"] = {
@@ -984,6 +986,24 @@
       }
     }
   }
+};
+    defs["NestedFilter"] = {
+  "required" : [ "field", "nested" ],
+  "properties" : {
+    "field" : {
+      "type" : "string"
+    },
+    "nested" : {
+      "$ref" : "#/components/schemas/NestedFilter_nested"
+    }
+  }
+};
+    defs["NestedFilter_nested"] = {
+  "oneOf" : [ {
+    "$ref" : "#/components/schemas/FieldFilter"
+  }, {
+    "$ref" : "#/components/schemas/NestedFilter"
+  } ]
 };
     defs["NodeInstanceDTO"] = {
   "required" : [ "id" ],

workspaces/orchestrator/plugins/orchestrator-common/src/generated/docs/api-doc/orchestrator-api.yaml

@@ -11,6 +11,8 @@ Models/Filter.md
 Models/GetOverviewsRequestParams.md
 Models/InputSchemaResponseDTO.md
 Models/LogicalFilter.md
+Models/NestedFilter.md
+Models/NestedFilter_nested.md
 Models/NodeInstanceDTO.md
 Models/PaginationInfoDTO.md
 Models/ProcessInstanceDTO.md

workspaces/orchestrator/plugins/orchestrator-common/src/generated/docs/html/index.html

@@ -7,6 +7,7 @@
 | **filters** | [**oas_any_type_not_mapped**](.md) |  | [default to null] |
 | **field** | [**oas_any_type_not_mapped**](.md) |  | [default to null] |
 | **value** | [**FieldFilter_value**](FieldFilter_value.md) |  | [default to null] |
+| **nested** | [**NestedFilter_nested**](NestedFilter_nested.md) |  | [default to null] |
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)