FI-943 feat: support CDP (aka native automation)

Author: uid11

autotests/actions/index.ts

@@ -1,2 +1,3 @@
 export {createRandomUser} from './createRandomUser';
 export {setPageCookiesAndNavigateToUrl} from './setPageCookiesAndNavigateToUrl';
+export {setPageRequestHeadersAndNavigateToUrl} from './setPageRequestHeadersAndNavigateToUrl';

autotests/actions/setPageCookiesAndNavigateToUrl.ts

@@ -1,6 +1,6 @@
 import {setHeadersAndNavigateToUrl} from 'e2ed/actions';
 import {LogEventType} from 'e2ed/constants';
-import {log, replaceSetCookie} from 'e2ed/utils';
+import {getHeaderValue, log, replaceSetCookie} from 'e2ed/utils';
 
 import type {Cookie, Headers, Url} from 'e2ed/types';
 
@@ -12,7 +12,7 @@ export const setPageCookiesAndNavigateToUrl = async (
   pageCookies: readonly Cookie[],
 ): Promise<void> => {
   const mapResponseHeaders = (headers: Headers): Headers => {
-    let setCookies = headers['set-cookie'];
+    let setCookies = getHeaderValue(headers, 'set-cookie');
 
     if (setCookies === undefined) {
       setCookies = [];

autotests/actions/setPageRequestHeadersAndNavigateToUrl.ts

@@ -0,0 +1,23 @@
+import {setHeadersAndNavigateToUrl} from 'e2ed/actions';
+import {LogEventType} from 'e2ed/constants';
+import {log} from 'e2ed/utils';
+
+import type {Headers, Url} from 'e2ed/types';
+
+/**
+ * Navigate to the url and set additional page request headers.
+ */
+export const setPageRequestHeadersAndNavigateToUrl = async (
+  url: Url,
+  pageRequestHeaders: Headers,
+): Promise<void> => {
+  const mapRequestHeaders = (): Headers => pageRequestHeaders;
+
+  log(
+    `Navigate to ${url} and set page request headers`,
+    {pageRequestHeaders, url},
+    LogEventType.Action,
+  );
+
+  await setHeadersAndNavigateToUrl(url, {mapRequestHeaders});
+};

autotests/bin/runDocker.sh

@@ -45,6 +45,7 @@ docker run \
        --env E2ED_ORIGIN=$E2ED_ORIGIN \
        --env E2ED_DEBUG=$E2ED_DEBUG \
        --env __INTERNAL_E2ED_PATH_TO_PACK=$1 \
+       --shm-size 512m \
        $DOCKER_IMAGE:$VERSION \
     & PID=$!
 

autotests/context/index.ts

@@ -1 +1,6 @@
 export {clearPageCookies, getPageCookies, setPageCookies} from './pageCookies';
+export {
+  clearPageRequestHeaders,
+  getPageRequestHeaders,
+  setPageRequestHeaders,
+} from './pageRequestHeaders';

autotests/context/pageRequestHeaders.ts

@@ -0,0 +1,9 @@
+import {useContext} from 'e2ed';
+
+import type {Headers} from 'e2ed/types';
+
+/**
+ * Get, set and clear additional page request headers, that will be added when navigating to the page.
+ */
+export const [getPageRequestHeaders, setPageRequestHeaders, clearPageRequestHeaders] =
+  useContext<Headers>();

autotests/hooks/navigateTo.ts

@@ -1,5 +1,13 @@
-import {setPageCookiesAndNavigateToUrl} from 'autotests/actions';
-import {clearPageCookies, getPageCookies} from 'autotests/context';
+import {
+  setPageCookiesAndNavigateToUrl,
+  setPageRequestHeadersAndNavigateToUrl,
+} from 'autotests/actions';
+import {
+  clearPageCookies,
+  clearPageRequestHeaders,
+  getPageCookies,
+  getPageRequestHeaders,
+} from 'autotests/context';
 import {navigateToUrl} from 'e2ed/actions';
 
 import type {NavigateTo} from 'autotests/types';
@@ -11,13 +19,17 @@ import type {NavigateTo} from 'autotests/types';
  */
 export const navigateTo: NavigateTo = async (url) => {
   const pageCookies = getPageCookies();
+  const pageRequestHeaders = getPageRequestHeaders();
 
-  if (pageCookies === undefined) {
-    // As with all hooks, you can replace it with your own implementation.
-    await navigateToUrl(url, {skipLogs: true});
-  } else {
+  if (pageCookies !== undefined) {
     clearPageCookies();
 
     await setPageCookiesAndNavigateToUrl(url, pageCookies);
+  } else if (pageRequestHeaders !== undefined) {
+    clearPageRequestHeaders();
+
+    await setPageRequestHeadersAndNavigateToUrl(url, pageRequestHeaders);
+  } else {
+    await navigateToUrl(url, {skipLogs: true});
   }
 };

autotests/packs/allTests.ts

@@ -23,7 +23,11 @@ import type {FilterTestsIntoPack, Pack} from 'autotests/types/packSpecific';
 const isLocalRun = runEnvironment === RunEnvironment.Local;
 
 const browser = isLocalRun ? 'chrome:headless' : 'chromium:headless';
-const browserFlags = ['--disable-dev-shm-usage', '--disable-web-security'];
+const browserFlags = [
+  '--disable-dev-shm-usage',
+  '--disable-web-security',
+  '--ignore-certificate-errors',
+];
 
 const filterTestsIntoPack: FilterTestsIntoPack = ({options}) => options.meta.testId !== '13';
 

autotests/pageObjects/pages/E2edReportExample.ts

@@ -1,12 +1,12 @@
-import {setPageCookies} from 'autotests/context';
+import {setPageCookies, setPageRequestHeaders} from 'autotests/context';
 import {E2edReportExample as E2edReportExampleRoute} from 'autotests/routes/pageRoutes';
 import {locatorIdSelector} from 'autotests/selectors';
 import {Page} from 'e2ed';
 import {setReadonlyProperty} from 'e2ed/utils';
 
-import type {Cookie, Selector} from 'e2ed/types';
+import type {Cookie, Headers, Selector} from 'e2ed/types';
 
-type CustomPageParams = {pageCookies?: readonly Cookie[]} | undefined;
+type CustomPageParams = {pageCookies?: readonly Cookie[]; pageRequestHeaders?: Headers} | undefined;
 
 /**
  * The e2ed report example page.
@@ -17,12 +17,18 @@ export class E2edReportExample extends Page<CustomPageParams> {
    */
   readonly pageCookies!: readonly Cookie[];
 
+  /**
+   * Request headers that we add to page request.
+   */
+  readonly pageRequestHeaders: Headers | undefined;
+
   override readonly pageStabilizationInterval = 600;
 
   override init(this: E2edReportExample): void {
-    const {pageCookies = []} = this.pageParams ?? {};
+    const {pageCookies = [], pageRequestHeaders} = this.pageParams ?? {};
 
     setReadonlyProperty(this, 'pageCookies', pageCookies);
+    setReadonlyProperty(this, 'pageRequestHeaders', pageRequestHeaders);
   }
 
   getRoute(): E2edReportExampleRoute {
@@ -52,11 +58,15 @@ export class E2edReportExample extends Page<CustomPageParams> {
   readonly testRunButton: Selector = this.testRunsList.findByLocatorId('app-retries-retry-button');
 
   /**
-   * Set page cookies to context before navigate.
+   * Set page cookies and page request headers to context before navigate.
    */
   override beforeNavigateToPage(): void {
     if (this.pageCookies.length !== 0) {
       setPageCookies(this.pageCookies);
     }
+
+    if (this.pageRequestHeaders !== undefined) {
+      setPageRequestHeaders(this.pageRequestHeaders);
+    }
   }
 }

autotests/tests/e2edReportExample/setPageRequestHeaders.ts

@@ -0,0 +1,14 @@
+import {test} from 'autotests';
+import {E2edReportExample} from 'autotests/pageObjects/pages';
+import {navigateToPage, waitForRequest} from 'e2ed/actions';
+
+const headerName = 'x-custom-header';
+const pageRequestHeaders = {[headerName]: 'foo'};
+
+test('set page request headers correctly', {meta: {testId: '17'}}, async () => {
+  void navigateToPage(E2edReportExample, {pageRequestHeaders});
+
+  await waitForRequest(
+    ({requestHeaders}) => requestHeaders[headerName] === pageRequestHeaders[headerName],
+  );
+});