fix: add expect method toBeInViewport instead of separate asserts

Author: uid11

autotests/tests/main/exists.ts

@@ -44,6 +44,8 @@ test('exists', {meta: {testId: '1'}, testIdleTimeout: 10_000, testTimeout: 15_00
 
   const mainPage = await navigateToPage(Main, {language});
 
+  await expect(mainPage.header, 'header is in viewport').toBeInViewport({ratio: 1});
+
   await expect(mainPage.header.textContent, 'header text is ok').ok();
 
   const urlObject = await urlObjectPromise;

src/actions/asserts/distanceBetweenSelectors/assertDistanceBetweenSelectorsGte.ts

@@ -1,7 +1,7 @@
 import {LogEventType} from '../../../constants/internal';
 import {expect} from '../../../expect';
+import {step} from '../../../step';
 import {getDistanceBetweenSelectors} from '../../../utils/distanceBetweenSelectors';
-import {log} from '../../../utils/log';
 
 import type {Selector} from '../../../types/internal';
 
@@ -14,11 +14,18 @@ export const assertDistanceBetweenSelectorsGte = async (
   selectorB: Selector,
   minDistance: number,
 ): Promise<void> => {
-  const distance = await getDistanceBetweenSelectors(selectorA, selectorB);
-  const message = `distance between selectors is greater than or equal to ${minDistance}`;
+  const message = `distance between selectors is greater than or equal to ${minDistance}px`;
 
-  log(`Asserts that ${message}`, {distance, minDistance}, LogEventType.InternalAssert);
+  await step(
+    `Asserts that ${message}`,
+    async () => {
+      const distance = await getDistanceBetweenSelectors(selectorA, selectorB);
 
-  // TODO: support Smart Assertions
-  await expect(distance, message).gte(minDistance);
+      // TODO: support Smart Assertions
+      await expect(distance, message).gte(minDistance);
+
+      return {distance};
+    },
+    {payload: {minDistance}, type: LogEventType.InternalAction},
+  );
 };

src/actions/asserts/distanceBetweenSelectors/assertDistanceBetweenSelectorsLte.ts

@@ -1,7 +1,7 @@
 import {LogEventType} from '../../../constants/internal';
 import {expect} from '../../../expect';
+import {step} from '../../../step';
 import {getDistanceBetweenSelectors} from '../../../utils/distanceBetweenSelectors';
-import {log} from '../../../utils/log';
 
 import type {Selector} from '../../../types/internal';
 
@@ -14,11 +14,18 @@ export const assertDistanceBetweenSelectorsLte = async (
   selectorB: Selector,
   maxDistance: number,
 ): Promise<void> => {
-  const distance = await getDistanceBetweenSelectors(selectorA, selectorB);
-  const message = `distance between selectors is less than or equal to ${maxDistance}`;
+  const message = `distance between selectors is less than or equal to ${maxDistance}px`;
 
-  log(`Asserts that ${message}`, {distance, maxDistance}, LogEventType.InternalAssert);
+  await step(
+    `Asserts that ${message}`,
+    async () => {
+      const distance = await getDistanceBetweenSelectors(selectorA, selectorB);
 
-  // TODO: support Smart Assertions
-  await expect(distance, message).lte(maxDistance);
+      // TODO: support Smart Assertions
+      await expect(distance, message).lte(maxDistance);
+
+      return {distance};
+    },
+    {payload: {maxDistance}, type: LogEventType.InternalAction},
+  );
 };

src/actions/asserts/index.ts

@@ -4,4 +4,3 @@ export {
   assertDistanceBetweenSelectorsGte,
   assertDistanceBetweenSelectorsLte,
 } from './distanceBetweenSelectors';
-export {assertSelectorEntirelyInViewport, assertSelectorInViewport} from './viewport';

src/actions/asserts/viewport/assertSelectorEntirelyInViewport.ts

@@ -2,8 +2,6 @@ export {
   assertDistanceBetweenSelectorsGte,
   assertDistanceBetweenSelectorsLte,
   assertNumbersAreApproximatelyEqual,
-  assertSelectorEntirelyInViewport,
-  assertSelectorInViewport,
   assertUrlMatchRoute,
 } from './asserts';
 export {blur} from './blur';

src/actions/asserts/viewport/assertSelectorInViewport.ts

@@ -5,7 +5,7 @@ import {getPlaywrightPage} from '../useContext';
 import type {NavigateToUrlOptions, NavigationReturn, StatusCode, Url} from '../types/internal';
 
 /**
- * Navigate to the `url` (without waiting of interface stabilization).
+ * Navigates to the `url` (without waiting of interface stabilization).
  */
 export const navigateToUrl = async (
   url: Url,

src/actions/asserts/viewport/index.ts

@@ -1,18 +1,21 @@
 import {LogEventType} from '../constants/internal';
+import {step} from '../step';
 import {getPlaywrightPage} from '../useContext';
-import {log} from '../utils/log';
 
 import type {Cookie} from '../types/internal';
 
 /**
  * Set cookies with the specified cookies parameters.
  */
-export const setCookies = async (cookies: readonly Cookie[]): Promise<void> => {
-  log('Set cookies with the specified cookies parameters', {cookies}, LogEventType.InternalAction);
+export const setCookies = (cookies: readonly Cookie[]): Promise<void> =>
+  step(
+    'Set cookies with the specified cookies parameters',
+    async () => {
+      const page = getPlaywrightPage();
 
-  const page = getPlaywrightPage();
+      const browserContext = page.context();
 
-  const browserContext = page.context();
-
-  await browserContext.addCookies(cookies);
-};
+      await browserContext.addCookies(cookies);
+    },
+    {payload: {cookies}, type: LogEventType.InternalAction},
+  );