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],
+  );
+});

package.json

@@ -124,10 +124,10 @@
     "pretest:docker:copy": "rm -rf ./build/docker && mkdir --parents ./build/docker/node_modules/e2ed",
     "test:docker:copy": "cp -R ./build/autotests ./build/docker/autotests && rm -rf ./build/docker/autotests/reports",
     "posttest:docker:copy": "./bin/addPackageJsonToBuildDocker.sh",
-    "test:docker": "(cd ./build/docker && E2ED_ORIGIN=https://google.com ./autotests/bin/runDocker.sh ./autotests/packs/allTests.ts)",
+    "test:docker": "(cd ./build/docker && E2ED_ORIGIN=https://www.google.com ./autotests/bin/runDocker.sh ./autotests/packs/allTests.ts)",
     "test:dependencies": "node ./build/testDependencies.js",
     "test:esm": "node ./build/testEsmExports.mjs",
-    "test:local": "(cd ./build && E2ED_ORIGIN=https://google.com ./node_modules/e2ed/bin/localEntrypoint.js ./autotests/packs/allTests.ts)",
+    "test:local": "(cd ./build && E2ED_ORIGIN=https://www.google.com ./node_modules/e2ed/bin/localEntrypoint.js ./autotests/packs/allTests.ts)",
     "testcafe-hammerhead-up:publish": "./bin/forks/testcafe-hammerhead-up/publish.sh",
     "testcafe-hammerhead-up:clean": "./bin/forks/testcafe-hammerhead-up/clean.sh",
     "testcafe-hammerhead-up:test:install": "./bin/forks/testcafe-hammerhead-up/testInstall.sh",

src/context/waitForEventsState.ts

@@ -30,7 +30,9 @@ export const getWaitForEventsState = (
 
   const waitForEventsState: WaitForEventsState = {
     allRequestsCompletePredicates: new Set<AllRequestsCompletePredicateWithPromise>(),
-    hashOfNotCompleteRequests: {},
+    hashOfNotCompleteRequests: Object.create(
+      null,
+    ) as WaitForEventsState['hashOfNotCompleteRequests'],
     hook: {} as RequestHookToWaitForEvents,
     requestPredicates: new Set<RequestPredicateWithPromise>(),
     responsePredicates: new Set<ResponsePredicateWithPromise>(),

src/testcaferc.ts

@@ -38,6 +38,7 @@ const frozenPartOfTestCafeConfig: FrozenPartOfTestCafeConfig = {
       options: {esModuleInterop: true, resolveJsonModule: true},
     },
   },
+  disableMultipleWindows: true,
   hostname: 'localhost',
   pageLoadTimeout: 0,
   reporter: [{name: 'for-e2ed'}],

src/types/config/config.ts

@@ -36,6 +36,7 @@ export type FrozenPartOfTestCafeConfig = DeepReadonly<{
       options?: {esModuleInterop?: boolean; resolveJsonModule?: boolean};
     };
   };
+  disableMultipleWindows: boolean;
   hostname: string;
   pageLoadTimeout: number;
   reporter: readonly {name: string; output?: string}[];

src/types/global.d.ts

@@ -79,9 +79,33 @@ declare module 'testcafe-hammerhead-up/lib/processing/encoding/charset' {
 declare module 'testcafe-hammerhead-up/lib/request-pipeline/request-hooks/events/factory' {
   type RequestHookClassWithContext = import('./requestHooks').RequestHookClassWithContext;
 
-  const RequestPipelineRequestHookEventFactory: RequestHookClassWithContext;
+  const RequestHookEventFactory: RequestHookClassWithContext;
 
-  export default RequestPipelineRequestHookEventFactory;
+  export default RequestHookEventFactory;
+}
+
+/**
+ * Internal TestCafe module with request-hooks frame navigated events factory class for native automation.
+ * @internal
+ */
+declare module 'testcafe-without-typecheck/lib/native-automation/request-hooks/event-factory/frame-navigated-event-based' {
+  type RequestHookClassWithContext = import('./requestHooks').RequestHookClassWithContext;
+
+  const RequestHookEventFactory: RequestHookClassWithContext;
+
+  export default RequestHookEventFactory;
+}
+
+/**
+ * Internal TestCafe module with request-hooks events factory class for native automation.
+ * @internal
+ */
+declare module 'testcafe-without-typecheck/lib/native-automation/request-hooks/event-factory/request-paused-event-based' {
+  type RequestHookClassWithContext = import('./requestHooks').RequestHookClassWithContext;
+
+  const RequestHookEventFactory: RequestHookClassWithContext;
+
+  export default RequestHookEventFactory;
 }
 
 /**

src/types/http/http.ts

@@ -6,6 +6,12 @@ import type {UtcTimeInMs} from '../date';
 import type {CookieHeaderString, SetCookieHeaderString} from './cookie';
 import type {StatusCode} from './statusCode';
 
+/**
+ * Header entry from CDP.
+ * {@link https://chromedevtools.github.io/devtools-protocol/tot/Fetch/#type-HeaderEntry}
+ */
+export type HeaderEntry = Readonly<{name: string; value: string}>;
+
 /**
  * General type of arbitrary HTTP headers. All headers are in lower case.
  */
@@ -20,7 +26,7 @@ export type Headers = Readonly<
  * Maps headers to new (overridden) headers.
  * All headers must be in lower case.
  */
-export type MapHeaders = (headers: Headers) => Headers;
+export type MapHeaders = (this: void, headers: Headers) => Headers;
 
 /**
  * Options for mappers of headers.

src/types/http/index.ts

@@ -1,5 +1,6 @@
 export type {Cookie, CookieHeaderString, SameSite, SetCookieHeaderString} from './cookie';
 export type {
+  HeaderEntry,
   Headers,
   MapHeaders,
   MapOptions,

src/types/index.ts

@@ -11,6 +11,7 @@ export type {Fn, MergeFunctions} from './fn';
 export type {
   Cookie,
   CookieHeaderString,
+  HeaderEntry,
   Headers,
   MapHeaders,
   MapOptions,

src/types/internal.ts

@@ -35,6 +35,7 @@ export type {SafeHtml} from './html';
 export type {
   Cookie,
   CookieHeaderString,
+  HeaderEntry,
   Headers,
   MapHeaders,
   MapOptions,
@@ -103,6 +104,7 @@ export type {
   TestRunButtonProps,
 } from './report';
 export type {
+  HeadersModifiers,
   RequestHookConfigureResponseEvent,
   RequestHookContextId,
   RequestHookRequestEvent,

src/types/requestHooks.ts

@@ -6,7 +6,7 @@ import type {Brand} from './brand';
 import type {Class} from './class';
 import type {DeepReadonly} from './deep';
 import type {Fn} from './fn';
-import type {Headers, StatusCode} from './http';
+import type {HeaderEntry, Headers, StatusCode} from './http';
 
 /**
  * Maybe object with request hook context key.
@@ -15,22 +15,33 @@ import type {Headers, StatusCode} from './http';
 type MaybeWithContextKey = Partial<WithContextKey> | null | undefined;
 
 /**
- * TestCafe internal request hook context (RequestPipelineContext).
- * Here we describe only the specific context fields used.
- * {@link https://github.com/DevExpress/testcafe-hammerhead/blob/master/src/request-pipeline/context/index.ts}
+ * TestCafe internal request hook context (BaseRequestHookEventFactory).
+ * Here we describe only the specific fields used.
+ * Only the version without native automation has field `_ctx`,
+ * and only the version with native automation (CPD) has field `_event`.
+ * {@link https://github.com/DevExpress/testcafe-hammerhead/blob/master/src/request-pipeline/request-hooks/events/factory/index.ts}
+ * {@link https://github.com/DevExpress/testcafe/blob/master/src/native-automation/request-hooks/event-factory/request-paused-event-based.ts}
+ * {@link https://github.com/DevExpress/testcafe/blob/master/src/native-automation/request-hooks/event-factory/frame-navigated-event-based.ts}
  */
-type RequestHookContext = DeepReadonly<{
+type RequestHookContext = Readonly<{
   [REQUEST_HOOK_CONTEXT_ID_KEY]?: RequestHookContextId;
-  destRes: {
-    headers?: Headers;
-  };
+  _ctx?: Readonly<{destRes?: Readonly<{headers?: Headers}>}>;
+  _event?: Readonly<{requestId: string; responseHeaders?: readonly HeaderEntry[]}>;
 }>;
 
 /**
  * Any object with request hook context key.
  */
 type WithContextKey = {readonly [REQUEST_HOOK_CONTEXT_KEY]: RequestHookContext};
 
+/**
+ * Headers modification functions.
+ */
+export type HeadersModifiers = Readonly<{
+  removeHeader(this: void, name: string): void;
+  setHeader(this: void, name: string, value: string): void;
+}>;
+
 /**
  * TestCafe charset class instance for encode/decode request/response body buffers.
  * @internal
@@ -44,7 +55,7 @@ export type RequestHookCharset = Brand<object, 'RequestHookCharset'>;
  */
 export type RequestHookClassWithContext = Class<
   unknown[],
-  Readonly<{_ctx: RequestHookContext} & Record<string, Fn<never[], MaybeWithContextKey>>>
+  RequestHookContext & Readonly<Record<string, Fn<never[], MaybeWithContextKey>>>
 >;
 
 /**
@@ -70,10 +81,7 @@ export type RequestHookRequestEvent = DeepReadonly<{
  */
 export type RequestHookConfigureResponseEvent = DeepReadonly<
   WithContextKey & {
-    _modifyResponseFunctions: {
-      removeHeader(name: string): Promise<void>;
-      setHeader(name: string, value: string): Promise<void>;
-    };
+    _modifyResponseFunctions: HeadersModifiers;
   }
 >;
 
@@ -83,6 +91,7 @@ export type RequestHookConfigureResponseEvent = DeepReadonly<
 export type RequestHookResponseEvent = Readonly<{
   body?: Buffer;
   headers?: Headers;
+  requestId?: string;
   statusCode?: StatusCode;
 }>;