Fix unstable tests (DevExpress#33267)

Author: Raushen

e2e/testcafe-devextreme/eslint-rules/no-is-ready-without-expect.js

@@ -0,0 +1,71 @@
+/**
+ * ESLint rule: no-is-ready-without-expect
+ *
+ * Disallows calling `.isReady()` outside of `t.expect()`.
+ *
+ * Correct:
+ *   await t.expect(dataGrid.isReady()).ok()
+ * or
+ *   await t
+ *     .expect(dataGrid.isReady())
+ *     .ok()
+ *
+ * Incorrect:
+ *   await dataGrid.isReady()
+ *   dataGrid.isReady()
+ *   const ready = await dataGrid.isReady()
+ */
+
+/* eslint-disable spellcheck/spell-checker */
+module.exports = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow calling .isReady() outside of t.expect()',
+        },
+        messages: {
+            noIsReadyWithoutExpect:
+                'isReady() must be used inside t.expect(), e.g.: await t.expect(widget.isReady()).ok()',
+        },
+        schema: [],
+    },
+    create(context) {
+        return {
+            CallExpression(node) {
+                const { callee } = node;
+
+                if (
+                    callee.type !== 'MemberExpression'
+                    || callee.property.type !== 'Identifier'
+                    || callee.property.name !== 'isReady'
+                ) {
+                    return;
+                }
+
+                // Walk up to find if this call is an argument of .expect()
+                let current = node;
+                let parent = current.parent;
+
+                while(parent) {
+                    if (
+                        parent.type === 'CallExpression'
+                        && parent.callee.type === 'MemberExpression'
+                        && parent.callee.property.type === 'Identifier'
+                        && parent.callee.property.name === 'expect'
+                    ) {
+                        // isReady() is inside .expect() — allowed
+                        return;
+                    }
+
+                    current = parent;
+                    parent = current.parent;
+                }
+
+                context.report({
+                    node,
+                    messageId: 'noIsReadyWithoutExpect',
+                });
+            },
+        };
+    },
+};

e2e/testcafe-devextreme/eslint.config.mjs

@@ -10,6 +10,8 @@ import { FlatCompat as FlatCompatibility } from '@eslint/eslintrc';
 import stylistic from '@stylistic/eslint-plugin';
 import { changeRulesToStylistic } from 'eslint-migration-utils';
 
+import noIsReadyWithoutExpect from './eslint-rules/no-is-ready-without-expect.js';
+
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const compatibility = new FlatCompatibility({
@@ -255,4 +257,22 @@ export default [
       '@typescript-eslint/no-empty-object-type': 'off',
     }
   },
+  {
+    files: [
+      'tests/dataGrid/**/*.ts',
+      'tests/cardView/**/*.ts',
+      'tests/common/treeList/**/*.ts',
+      'tests/common/filterBuilder/**/*.ts',
+    ],
+    plugins: {
+      'local': {
+        rules: {
+          'no-is-ready-without-expect': noIsReadyWithoutExpect,
+        },
+      },
+    },
+    rules: {
+      'local/no-is-ready-without-expect': 'error',
+    },
+  },
 ];

e2e/testcafe-devextreme/tests/cardView/editing/editing.functional.ts

@@ -30,10 +30,14 @@ const config = {
 
 test('should show default values in popup fields after onInitNewCard', async (t) => {
   const cardView = new CardView(CARD_VIEW_SELECTOR);
-  await cardView.isReady();
+  await t
+    .expect(cardView.isReady())
+    .ok();
 
   await t.click(cardView.getToolbar().getAddButton().element);
-  await cardView.isReady();
+  await t
+    .expect(cardView.isReady())
+    .ok();
 
   const popup = cardView.getEditingPopup();
 

e2e/testcafe-devextreme/tests/common/filterBuilder/filterBuilderScrolling.ts

@@ -11,7 +11,9 @@ fixture.disablePageReloads`Filter Builder Scrolling Test`
 test('FilterBuilder - The field drop-down closes with the page scroll', async (t) => {
   const filterBuilder = new FilterBuilder('#container');
 
-  await filterBuilder.isReady();
+  await t
+    .expect(filterBuilder.isReady())
+    .ok();
 
   await t
     .click(filterBuilder.getItem('operation'))

e2e/testcafe-devextreme/tests/common/treeList/adaptiveRow.ts

@@ -7,7 +7,9 @@ fixture.disablePageReloads`Adaptive Row`
 
 test.meta({ browserSize: [400, 400] })('Should be shown and hidden when the window is resized', async (t) => {
   const treeList = new TreeList('#container');
-  await treeList.isReady();
+  await t
+    .expect(treeList.isReady())
+    .ok();
 
   const adaptiveButton = treeList.getAdaptiveButton();
   await t.expect(adaptiveButton.exists).ok();

e2e/testcafe-devextreme/tests/common/treeList/rowDragging.ts

@@ -67,7 +67,9 @@ test('TreeList - Expand/collapse mechanism breaks after dragging action in the s
   test(`TreeList - The W1025 warning occurs when dragging a row (height: ${height ?? 'not set'}). (T1280519)`, async (t) => {
     const treeList = new TreeList('#container');
 
-    await treeList.isReady();
+    await t
+      .expect(treeList.isReady())
+      .ok();
 
     await treeList.moveRow(0, 10, 10, true);
 

e2e/testcafe-devextreme/tests/common/treeList/toast.ts

@@ -10,7 +10,10 @@ fixture.disablePageReloads`Toasts in TreeList`
 test('Toast should be visible after calling and should be not visible after default display time', async (t) => {
   const treeList = new TreeList('#container');
   const { takeScreenshot, compareResults } = createScreenshotsComparer(t);
-  await treeList.isReady();
+  await t
+    .expect(treeList.isReady())
+    .ok();
+
   await treeList.apiShowErrorToast();
   await t.expect(treeList.getToast().exists).ok();
 
@@ -21,5 +24,5 @@ test('Toast should be visible after calling and should be not visible after defa
     .ok(compareResults.errorMessages());
   await t.expect(treeList.getToast().exists).notOk();
 }).before(async () => {
-  createWidget('dxTreeList', {});
+  await createWidget('dxTreeList', {});
 });

e2e/testcafe-devextreme/tests/dataGrid/common/adaptivity/functional.ts

@@ -7,7 +7,9 @@ fixture.disablePageReloads`Adaptivity.Functional`
 
 test.meta({ browserSize: [400, 400] })('Should be shown and hidden when the window is resized', async (t) => {
   const dataGrid = new DataGrid('#container');
-  await dataGrid.isReady();
+  await t
+    .expect(dataGrid.isReady())
+    .ok();
 
   const adaptiveButton = dataGrid.getAdaptiveButton();
   await t.expect(adaptiveButton.exists).ok();

e2e/testcafe-devextreme/tests/dataGrid/common/columnChooser.ts

@@ -277,7 +277,10 @@ test(
 
 test('ColumnChooser should receive and render custom texts', async (t) => {
   const dataGrid = new DataGrid('#container');
-  await dataGrid.isReady();
+  await t
+    .expect(dataGrid.isReady())
+    .ok();
+
   const columnChooserBtn = dataGrid.getColumnChooserButton();
   await t.click(columnChooserBtn);
   const columnChooser = dataGrid.getColumnChooser();

e2e/testcafe-devextreme/tests/dataGrid/common/editing/visual.ts

@@ -305,6 +305,7 @@ test('DataGrid cell with checkbox should have outline on focused', async (t) =>
 
       const scrollTo = async (y) => {
         await dataGrid.scrollTo(t, { y });
+        // eslint-disable-next-line local/no-is-ready-without-expect
         return dataGrid.isReady();
       };