feat: add field-to-field comparison support in filters across data connectors

NoOne7135 · NoOne7135 · commit 037384be4a0e · 2025-09-19T10:26:31.000+03:00
diff --git a/adminforth/dataConnectors/baseConnector.ts b/adminforth/dataConnectors/baseConnector.ts
@@ -100,9 +100,14 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
       if (!filters.operator) {
         return { ok: false, error: `Field "operator" not specified in filter object: ${JSON.stringify(filters)}` };
       }
-      if (filtersAsSingle.value === undefined) {
+      // Either compare with value or with rightField (field-to-field). If rightField is set, value must be undefined.
+      const comparingWithRightField = filtersAsSingle.rightField !== undefined && filtersAsSingle.rightField !== null;
+      if (!comparingWithRightField && filtersAsSingle.value === undefined) {
         return { ok: false, error: `Field "value" not specified in filter object: ${JSON.stringify(filters)}` };
       }
+      if (comparingWithRightField && filtersAsSingle.value !== undefined) {
+        return { ok: false, error: `Specify either "value" or "rightField", not both: ${JSON.stringify(filters)}` };
+      }
       if (filtersAsSingle.insecureRawSQL) {
         return { ok: false, error: `Field "insecureRawSQL" should not be specified in filter object alongside "field": ${JSON.stringify(filters)}` };
       }
@@ -137,7 +142,15 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
         }
       }
       // value normalization
-      if (filters.operator == AdminForthFilterOperators.IN || filters.operator == AdminForthFilterOperators.NIN) {
+      if (comparingWithRightField) {
+        // ensure rightField exists in resource
+        const rightFieldObj = resource.dataSourceColumns.find((col) => col.name == filtersAsSingle.rightField);
+        if (!rightFieldObj) {
+          const similar = suggestIfTypo(resource.dataSourceColumns.map((col) => col.name), filtersAsSingle.rightField as string);
+          throw new Error(`Field '${filtersAsSingle.rightField}' not found in resource '${resource.resourceId}'. ${similar ? `Did you mean '${similar}'?` : ''}`);
+        }
+        // No value conversion needed for field-to-field comparison here
+      } else if (filters.operator == AdminForthFilterOperators.IN || filters.operator == AdminForthFilterOperators.NIN) {
         if (!Array.isArray(filters.value)) {
           return { ok: false, error: `Value for operator '${filters.operator}' should be an array, in filter object: ${JSON.stringify(filters) }` };
         }
diff --git a/adminforth/dataConnectors/clickhouse.ts b/adminforth/dataConnectors/clickhouse.ts
@@ -226,6 +226,13 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
   
     getFilterString(resource: AdminForthResource, filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): string {
       if ((filter as IAdminForthSingleFilter).field) {
+        // Field-to-field comparison support
+        if ((filter as IAdminForthSingleFilter).rightField) {
+          const left = (filter as IAdminForthSingleFilter).field;
+          const right = (filter as IAdminForthSingleFilter).rightField;
+          const operator = this.OperatorsMap[filter.operator];
+          return `${left} ${operator} ${right}`;
+        }
         // filter is a Single filter
         let field = (filter as IAdminForthSingleFilter).field;
         const column = resource.dataSourceColumns.find((col) => col.name == field);
@@ -280,6 +287,10 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
     
     getFilterParams(filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): any[] {
       if ((filter as IAdminForthSingleFilter).field) {
+        if ((filter as IAdminForthSingleFilter).rightField) {
+          // No params for field-to-field comparisons
+          return [];
+        }
         // filter is a Single filter
         if (filter.operator == AdminForthFilterOperators.LIKE || filter.operator == AdminForthFilterOperators.ILIKE) {
           return [{ 'f': `%${filter.value}%` }];
diff --git a/adminforth/dataConnectors/mongo.ts b/adminforth/dataConnectors/mongo.ts
@@ -224,6 +224,26 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
         }
 
         if ((filter as IAdminForthSingleFilter).field) {
+            // Field-to-field comparisons via $expr
+            if ((filter as IAdminForthSingleFilter).rightField) {
+                const left = `$${(filter as IAdminForthSingleFilter).field}`;
+                const right = `$${(filter as IAdminForthSingleFilter).rightField}`;
+                const op = (filter as IAdminForthSingleFilter).operator;
+                const exprOpMap = {
+                    [AdminForthFilterOperators.GT]: '$gt',
+                    [AdminForthFilterOperators.GTE]: '$gte',
+                    [AdminForthFilterOperators.LT]: '$lt',
+                    [AdminForthFilterOperators.LTE]: '$lte',
+                    [AdminForthFilterOperators.EQ]: '$eq',
+                    [AdminForthFilterOperators.NE]: '$ne',
+                } as const;
+                const mongoExprOp = exprOpMap[op];
+                if (!mongoExprOp) {
+                    // For unsupported ops with rightField, return empty condition
+                    return {};
+                }
+                return { $expr: { [mongoExprOp]: [left, right] } };
+            }
             const column = resource.dataSourceColumns.find((col) => col.name === (filter as IAdminForthSingleFilter).field);
             if (['integer', 'decimal', 'float'].includes(column.type)) {
                 return { [(filter as IAdminForthSingleFilter).field]: this.OperatorsMap[filter.operator](+(filter as IAdminForthSingleFilter).value) };
diff --git a/adminforth/dataConnectors/mysql.ts b/adminforth/dataConnectors/mysql.ts
@@ -204,6 +204,13 @@ class MysqlConnector extends AdminForthBaseConnector implements IAdminForthDataS
 
   getFilterString(filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): string {
     if ((filter as IAdminForthSingleFilter).field) {
+      // Field-to-field comparison support
+      if ((filter as IAdminForthSingleFilter).rightField) {
+        const left = (filter as IAdminForthSingleFilter).field;
+        const right = (filter as IAdminForthSingleFilter).rightField;
+        const operator = this.OperatorsMap[filter.operator];
+        return `${left} ${operator} ${right}`;
+      }
       // filter is a Single filter
       let placeholder = '?';
       let field = (filter as IAdminForthSingleFilter).field;
@@ -249,6 +256,10 @@ class MysqlConnector extends AdminForthBaseConnector implements IAdminForthDataS
   }
   getFilterParams(filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): any[] {
     if ((filter as IAdminForthSingleFilter).field) {
+      if ((filter as IAdminForthSingleFilter).rightField) {
+        // No params for field-to-field comparisons
+        return [];
+      }
       // filter is a Single filter
       if (filter.operator == AdminForthFilterOperators.LIKE || filter.operator == AdminForthFilterOperators.ILIKE) {
         return [`%${filter.value}%`];
diff --git a/adminforth/dataConnectors/postgres.ts b/adminforth/dataConnectors/postgres.ts
@@ -225,6 +225,13 @@ class PostgresConnector extends AdminForthBaseConnector implements IAdminForthDa
 
     getFilterString(resource: AdminForthResource, filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): string {
         if ((filter as IAdminForthSingleFilter).field) {
+            // Field-to-field comparison support
+            if ((filter as IAdminForthSingleFilter).rightField) {
+                const left = `"${(filter as IAdminForthSingleFilter).field}"`;
+                const right = `"${(filter as IAdminForthSingleFilter).rightField}"`;
+                const operator = this.OperatorsMap[filter.operator];
+                return `${left} ${operator} ${right}`;
+            }
             let placeholder = '$?';
             let field = (filter as IAdminForthSingleFilter).field;
             const fieldData = resource.dataSourceColumns.find((col) => col.name == field);
@@ -265,6 +272,10 @@ class PostgresConnector extends AdminForthBaseConnector implements IAdminForthDa
 
     getFilterParams(filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): any[] {
         if ((filter as IAdminForthSingleFilter).field) {
+            if ((filter as IAdminForthSingleFilter).rightField) {
+                // No params for field-to-field comparisons
+                return [];
+            }
             // filter is a Single filter
             if (filter.operator == AdminForthFilterOperators.LIKE || filter.operator == AdminForthFilterOperators.ILIKE) {
                 return [`%${filter.value}%`];
diff --git a/adminforth/dataConnectors/sqlite.ts b/adminforth/dataConnectors/sqlite.ts
@@ -179,6 +179,13 @@ class SQLiteConnector extends AdminForthBaseConnector implements IAdminForthData
   
     getFilterString(filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): string {
       if ((filter as IAdminForthSingleFilter).field) {
+        // Field-to-field comparison support
+        if ((filter as IAdminForthSingleFilter).rightField) {
+          const left = (filter as IAdminForthSingleFilter).field;
+          const right = (filter as IAdminForthSingleFilter).rightField;
+          const operator = this.OperatorsMap[filter.operator];
+          return `${left} ${operator} ${right}`;
+        }
         // filter is a Single filter
         let placeholder = '?';
         let field = (filter as IAdminForthSingleFilter).field;
@@ -222,6 +229,10 @@ class SQLiteConnector extends AdminForthBaseConnector implements IAdminForthData
     }
     getFilterParams(filter: IAdminForthSingleFilter | IAdminForthAndOrFilter): any[] {
       if ((filter as IAdminForthSingleFilter).field) {
+        if ((filter as IAdminForthSingleFilter).rightField) {
+          // No params for field-to-field comparisons
+          return [];
+        }
         // filter is a Single filter
         if (filter.operator == AdminForthFilterOperators.LIKE || filter.operator == AdminForthFilterOperators.ILIKE) {
           return [`%${filter.value}%`];
diff --git a/adminforth/types/Back.ts b/adminforth/types/Back.ts
@@ -130,6 +130,7 @@ export interface IAdminForthSingleFilter {
   | AdminForthFilterOperators.LTE | AdminForthFilterOperators.LIKE | AdminForthFilterOperators.ILIKE
   | AdminForthFilterOperators.IN | AdminForthFilterOperators.NIN;
   value?: any;
+  rightField?: string;
   insecureRawSQL?: string;
   insecureRawNoSQL?: any;
 }
@@ -1168,6 +1169,18 @@ export class Filters {
   static ILIKE(field: string, value: any): IAdminForthSingleFilter {
     return { field, operator: AdminForthFilterOperators.ILIKE, value };
   }
+  static COMPARE_GT(leftField: string, rightField: string): IAdminForthSingleFilter {
+    return { field: leftField, operator: AdminForthFilterOperators.GT, rightField };
+  }
+  static COMPARE_GTE(leftField: string, rightField: string): IAdminForthSingleFilter {
+    return { field: leftField, operator: AdminForthFilterOperators.GTE, rightField };
+  }
+  static COMPARE_LT(leftField: string, rightField: string): IAdminForthSingleFilter {
+    return { field: leftField, operator: AdminForthFilterOperators.LT, rightField };
+  }
+  static COMPARE_LTE(leftField: string, rightField: string): IAdminForthSingleFilter {
+    return { field: leftField, operator: AdminForthFilterOperators.LTE, rightField };
+  }
   static AND(
     ...args: (IAdminForthSingleFilter | IAdminForthAndOrFilter | Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>)[]
   ): IAdminForthAndOrFilter {

Original file line number	Diff line number	Diff line change
`@@ -100,9 +100,14 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon`
`100`	`100`	`if (!filters.operator) {`
`101`	`101`	return { ok: false, error: `Field "operator" not specified in filter object: ${JSON.stringify(filters)}` };
`102`	`102`	`}`
`103`		`- if (filtersAsSingle.value === undefined) {`
	`103`	`+ // Either compare with value or with rightField (field-to-field). If rightField is set, value must be undefined.`
	`104`	`+ const comparingWithRightField = filtersAsSingle.rightField !== undefined && filtersAsSingle.rightField !== null;`
	`105`	`+ if (!comparingWithRightField && filtersAsSingle.value === undefined) {`
`104`	`106`	return { ok: false, error: `Field "value" not specified in filter object: ${JSON.stringify(filters)}` };
`105`	`107`	`}`
	`108`	`+ if (comparingWithRightField && filtersAsSingle.value !== undefined) {`
	`109`	+ return { ok: false, error: `Specify either "value" or "rightField", not both: ${JSON.stringify(filters)}` };
	`110`	`+ }`
`106`	`111`	`if (filtersAsSingle.insecureRawSQL) {`
`107`	`112`	return { ok: false, error: `Field "insecureRawSQL" should not be specified in filter object alongside "field": ${JSON.stringify(filters)}` };
`108`	`113`	`}`
`@@ -137,7 +142,15 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon`
`137`	`142`	`}`
`138`	`143`	`}`
`139`	`144`	`// value normalization`
`140`		`- if (filters.operator == AdminForthFilterOperators.IN \|\| filters.operator == AdminForthFilterOperators.NIN) {`
	`145`	`+ if (comparingWithRightField) {`
	`146`	`+ // ensure rightField exists in resource`
	`147`	`+ const rightFieldObj = resource.dataSourceColumns.find((col) => col.name == filtersAsSingle.rightField);`
	`148`	`+ if (!rightFieldObj) {`
	`149`	`+ const similar = suggestIfTypo(resource.dataSourceColumns.map((col) => col.name), filtersAsSingle.rightField as string);`
	`150`	+ throw new Error(`Field '${filtersAsSingle.rightField}' not found in resource '${resource.resourceId}'. ${similar ? `Did you mean '${similar}'?` : ''}`);
	`151`	`+ }`
	`152`	`+ // No value conversion needed for field-to-field comparison here`
	`153`	`+ } else if (filters.operator == AdminForthFilterOperators.IN \|\| filters.operator == AdminForthFilterOperators.NIN) {`
`141`	`154`	`if (!Array.isArray(filters.value)) {`
`142`	`155`	return { ok: false, error: `Value for operator '${filters.operator}' should be an array, in filter object: ${JSON.stringify(filters) }` };
`143`	`156`	`}`