AI Assistant: add filter value to command default message

Author: anna-shakhova

packages/devextreme/js/__internal/grids/grid_core/ai_assistant/commands/__tests__/filtering.test.ts

@@ -204,11 +204,15 @@ describe('filterValueCommand', () => {
       expect(result.status).toBe('success');
     });
 
-    it('returns failure when option throws', async () => {
+    it('returns failure when applying the filter throws', async () => {
       const instance = await createGrid();
-      jest.spyOn(instance, 'option').mockImplementationOnce(() => {
-        throw new Error('Error');
-      });
+      const original = instance.option.bind(instance) as (...a: unknown[]) => unknown;
+      jest.spyOn(instance, 'option').mockImplementation(((...args: unknown[]) => {
+        if (args[0] === 'filterValue' && args.length > 1) {
+          throw new Error('Error');
+        }
+        return original(...args);
+      }) as never);
       const callbacks = createCallbacks();
 
       const result = await filterValueCommand.execute(instance, callbacks)({
@@ -220,15 +224,15 @@ describe('filterValueCommand', () => {
   });
 
   describe('default message', () => {
-    it('uses `Apply a filter.` when expression is set', async () => {
+    it('appends the human-readable filter text when expression is set', async () => {
       const instance = await createGrid();
       const callbacks = createCallbacks();
 
       await filterValueCommand.execute(instance, callbacks)({
         expression: basicExpr('name', '=', 'Alpha'),
       });
 
-      expect(callbacks.success).toHaveBeenCalledWith('Apply a filter.');
+      expect(callbacks.success).toHaveBeenCalledWith("Apply a filter: [Name] Equals 'Alpha'");
     });
 
     it('uses `Clear filter.` when expression is null', async () => {
@@ -242,18 +246,22 @@ describe('filterValueCommand', () => {
       expect(callbacks.success).toHaveBeenCalledWith('Clear filter.');
     });
 
-    it('passes the same default message to failure when executability fails', async () => {
+    it('passes the same readable default message to failure when applying the filter fails', async () => {
       const instance = await createGrid();
-      jest.spyOn(instance, 'option').mockImplementationOnce(() => {
-        throw new Error('Error');
-      });
+      const original = instance.option.bind(instance) as (...a: unknown[]) => unknown;
+      jest.spyOn(instance, 'option').mockImplementation(((...args: unknown[]) => {
+        if (args[0] === 'filterValue' && args.length > 1) {
+          throw new Error('Error');
+        }
+        return original(...args);
+      }) as never);
       const callbacks = createCallbacks();
 
       await filterValueCommand.execute(instance, callbacks)({
         expression: basicExpr('name', '=', 'Alpha'),
       });
 
-      expect(callbacks.failure).toHaveBeenCalledWith('Apply a filter.');
+      expect(callbacks.failure).toHaveBeenCalledWith("Apply a filter: [Name] Equals 'Alpha'");
     });
   });
 });

packages/devextreme/js/__internal/grids/grid_core/ai_assistant/commands/filtering.ts

@@ -1,5 +1,7 @@
 import type { SearchOperation } from '@js/common/data.types';
+import { when } from '@js/core/utils/deferred';
 import type { CommandResult } from '@ts/grids/grid_core/ai_assistant/types';
+import type { InternalGrid } from '@ts/grids/grid_core/m_types';
 import { z } from 'zod';
 
 import { defineGridCommand } from './defineGridCommand';
@@ -80,26 +82,44 @@ function convertFilterExprToArray(expr: FilterExprObj): FilterExprArray {
   }
 }
 
+const getFilterValueDefaultMessage = async (
+  component: InternalGrid,
+  filterValue: unknown,
+): Promise<string> => {
+  if (filterValue === undefined) {
+    return 'Clear filter.';
+  }
+
+  try {
+    const filterText: string = await when(
+      // Custom filter operations are omitted as not supported in command
+      component.getView('filterPanelView').getFilterText(filterValue, []),
+    );
+
+    return `Apply a filter: ${filterText}`;
+  } catch {
+    return 'Apply a filter.';
+  }
+};
+
 export const filterValueCommand = defineGridCommand({
   name: 'filterValue',
   description: 'Apply a filter expression to the grid. Replaces any existing filter; pass null for expression to clear. Expression forms: basic {"type":"basic","field":dataField,"operator":op,"value":val}, combined {"type":"combined","left":expr,"combiner":"and"|"or","right":expr}, negated {"type":"negated","expression":expr}. The "field" is the column dataField (not the caption). Supported operators: "=", "<>", "<", "<=", ">", ">=", "contains", "notcontains", "startswith", "endswith". To express "not and" / "not or", wrap the group in negation: {"type":"negated","expression":{"type":"combined",...}}.',
   schema: filterValueCommandSchema,
-  execute: (component, { success, failure }) => (args): Promise<CommandResult> => {
-    const defaultMessage = args.expression === null
-      ? 'Clear filter.'
-      : 'Apply a filter.';
+  execute: (component, { success, failure }) => async (args): Promise<CommandResult> => {
+    const filterValue = args.expression === null
+      ? undefined
+      : convertFilterExprToArray(args.expression);
 
-    try {
-      const filterValue = args.expression === null
-        ? undefined
-        : convertFilterExprToArray(args.expression);
+    const defaultMessage = await getFilterValueDefaultMessage(component, filterValue);
 
+    try {
       // Handles remote operations via data controller listening for the `filtering` change
       component.option('filterValue', filterValue);
 
-      return Promise.resolve(success(defaultMessage));
+      return success(defaultMessage);
     } catch {
-      return Promise.resolve(failure(defaultMessage));
+      return failure(defaultMessage);
     }
   },
 });

packages/devextreme/js/__internal/grids/grid_core/filter/m_filter_panel.ts

@@ -3,6 +3,7 @@ import eventsEngine from '@js/common/core/events/core/events_engine';
 import messageLocalization from '@js/common/core/localization/message';
 import type { dxElementWrapper } from '@js/core/renderer';
 import $ from '@js/core/renderer';
+import type { DeferredObj } from '@js/core/utils/deferred';
 import { Deferred, when } from '@js/core/utils/deferred';
 import { isDefined } from '@js/core/utils/type';
 import CheckBox from '@js/ui/check_box';
@@ -311,7 +312,7 @@ export class FilterPanelView extends modules.View {
     return result;
   }
 
-  private getFilterText(filterValue, customOperations) {
+  public getFilterText(filterValue, customOperations): DeferredObj<string> {
     const options = {
       customOperations,
       columns: this._columnsController.getFilteringColumns(),