Merge pull request #121 from joomcode/feat/add-status-code-to-page

feat: add `statusCode` property on pages

Author: uid11

autotests/actions/setPageCookiesAndNavigateToUrl.ts

@@ -2,15 +2,15 @@ import {setHeadersAndNavigateToUrl} from 'e2ed/actions';
 import {LogEventType} from 'e2ed/constants';
 import {getHeaderValue, log, replaceSetCookie} from 'e2ed/utils';
 
-import type {Cookie, SetCookieHeaderString, StringHeaders, Url} from 'e2ed/types';
+import type {Cookie, NavigationReturn, SetCookieHeaderString, StringHeaders, Url} from 'e2ed/types';
 
 /**
  * Navigate to the url and set custom page cookies.
  */
-export const setPageCookiesAndNavigateToUrl = async (
+export const setPageCookiesAndNavigateToUrl = (
   url: Url,
   pageCookies: readonly Cookie[],
-): Promise<void> => {
+): Promise<NavigationReturn> => {
   const mapResponseHeaders = (headers: StringHeaders): StringHeaders => {
     const setCookies = getHeaderValue(headers, 'set-cookie');
 
@@ -28,5 +28,5 @@ export const setPageCookiesAndNavigateToUrl = async (
 
   log(`Navigate to ${url} and set page cookie`, {pageCookies, url}, LogEventType.Action);
 
-  await setHeadersAndNavigateToUrl(url, {mapResponseHeaders});
+  return setHeadersAndNavigateToUrl(url, {mapResponseHeaders});
 };

autotests/actions/setPageRequestHeadersAndNavigateToUrl.ts

@@ -2,15 +2,15 @@ import {setHeadersAndNavigateToUrl} from 'e2ed/actions';
 import {LogEventType} from 'e2ed/constants';
 import {log} from 'e2ed/utils';
 
-import type {StringHeaders, Url} from 'e2ed/types';
+import type {NavigationReturn, StringHeaders, Url} from 'e2ed/types';
 
 /**
  * Navigate to the url and set additional page request headers.
  */
-export const setPageRequestHeadersAndNavigateToUrl = async (
+export const setPageRequestHeadersAndNavigateToUrl = (
   url: Url,
   pageRequestHeaders: StringHeaders,
-): Promise<void> => {
+): Promise<NavigationReturn> => {
   const mapRequestHeaders = (): StringHeaders => pageRequestHeaders;
 
   log(
@@ -19,5 +19,5 @@ export const setPageRequestHeadersAndNavigateToUrl = async (
     LogEventType.Action,
   );
 
-  await setHeadersAndNavigateToUrl(url, {mapRequestHeaders});
+  return setHeadersAndNavigateToUrl(url, {mapRequestHeaders});
 };

autotests/pageObjects/pages/E2edReportExample/E2edReportExample.ts

@@ -10,7 +10,7 @@ import {setReadonlyProperty} from 'e2ed/utils';
 
 import {TestRunButton} from './TestRunButton';
 
-import type {Cookie, Selector, StringHeaders, Url} from 'e2ed/types';
+import type {Cookie, NavigationReturn, Selector, StringHeaders, Url} from 'e2ed/types';
 
 type CustomPageParams =
   | {pageCookies?: readonly Cookie[]; pageRequestHeaders?: StringHeaders}
@@ -110,7 +110,7 @@ export class E2edReportExample extends Page<CustomPageParams> {
     setReadonlyProperty(this, 'pageRequestHeaders', pageRequestHeaders);
   }
 
-  override navigateToPage(url: Url): Promise<void> {
+  override navigateToPage(url: Url): Promise<NavigationReturn> {
     if (this.pageRequestHeaders) {
       return setPageRequestHeadersAndNavigateToUrl(url, this.pageRequestHeaders);
     }

package-lock.json

@@ -25,27 +25,27 @@
     "url": "git+https://github.com/joomcode/e2ed.git"
   },
   "dependencies": {
-    "@playwright/test": "1.53.2",
+    "@playwright/test": "1.55.0",
     "create-locator": "0.0.27",
     "get-modules-graph": "0.0.11",
     "sort-json-keys": "1.0.3"
   },
   "devDependencies": {
-    "@playwright/browser-chromium": "1.53.2",
-    "@types/node": "24.0.8",
+    "@playwright/browser-chromium": "1.55.0",
+    "@types/node": "24.3.0",
     "@typescript-eslint/eslint-plugin": "7.18.0",
     "@typescript-eslint/parser": "7.18.0",
     "assert-modules-support-case-insensitive-fs": "1.0.1",
     "assert-package-lock-is-consistent": "1.0.0",
     "eslint": "8.57.1",
     "eslint-config-airbnb-base": "15.0.0",
-    "eslint-config-prettier": "10.1.5",
+    "eslint-config-prettier": "10.1.8",
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-simple-import-sort": "12.1.1",
     "eslint-plugin-typescript-sort-keys": "3.3.0",
     "husky": "9.1.7",
     "prettier": "3.6.2",
-    "typescript": "5.8.3"
+    "typescript": "5.9.2"
   },
   "peerDependencies": {
     "@types/node": ">=20",

package.json

@@ -7,10 +7,18 @@ import {CREATE_PAGE_TOKEN} from './constants/internal';
 import {assertValueIsTrue} from './utils/asserts';
 import {getFullPackConfig} from './utils/config';
 import {reloadDocument} from './utils/document';
+import {setReadonlyProperty} from './utils/object';
 import {getPlaywrightPage} from './useContext';
 
 import type {PageRoute} from './PageRoute';
-import type {AsyncVoid, NavigateToUrlOptions, PageClassTypeArgs, Url} from './types/internal';
+import type {
+  AsyncVoid,
+  NavigateToUrlOptions,
+  NavigationReturn,
+  PageClassTypeArgs,
+  StatusCode,
+  Url,
+} from './types/internal';
 
 /**
  * Abstract page with base methods.
@@ -43,6 +51,11 @@ export abstract class Page<PageParams = undefined> {
    */
   readonly pageParams: PageParams;
 
+  /**
+   * Status code of page, if any.
+   */
+  readonly statusCode: StatusCode | undefined;
+
   constructor(...args: PageClassTypeArgs<PageParams>) {
     const [createPageToken, pageParams] = args;
 
@@ -112,8 +125,21 @@ export abstract class Page<PageParams = undefined> {
   /**
    * Navigates to the page by url.
    */
-  navigateToPage(url: Url, options?: NavigateToUrlOptions): Promise<void> {
-    return navigateToUrl(url, {skipLogs: true, timeout: this.navigationTimeout, ...options});
+  async navigateToPage(
+    this: Page,
+    url: Url,
+    options?: NavigateToUrlOptions,
+  ): Promise<NavigationReturn> {
+    const navigationReturn = await navigateToUrl(url, {
+      skipLogs: true,
+      timeout: this.navigationTimeout,
+      ...options,
+    });
+    const {statusCode} = navigationReturn;
+
+    setReadonlyProperty(this, 'statusCode', statusCode);
+
+    return navigationReturn;
   }
 
   /**

src/Page.ts

@@ -2,15 +2,15 @@ import {LogEventType} from '../constants/internal';
 import {getPlaywrightPage} from '../useContext';
 import {log} from '../utils/log';
 
-import type {NavigateToUrlOptions, Url} from '../types/internal';
+import type {NavigateToUrlOptions, NavigationReturn, StatusCode, Url} from '../types/internal';
 
 /**
  * Navigate to the `url` (without waiting of interface stabilization).
  */
 export const navigateToUrl = async (
   url: Url,
   options: NavigateToUrlOptions = {},
-): Promise<void> => {
+): Promise<NavigationReturn> => {
   const {skipLogs = false} = options;
 
   if (skipLogs !== true) {
@@ -19,9 +19,16 @@ export const navigateToUrl = async (
 
   const page = getPlaywrightPage();
 
-  await page.goto(url, options);
+  const maybeResponse = await page.goto(url, options);
+  let statusCode: StatusCode | undefined;
+
+  if (maybeResponse !== null) {
+    statusCode = maybeResponse.status() as StatusCode;
+  }
 
   if (skipLogs !== true) {
     log(`Navigation to the url ${url} completed`, options, LogEventType.InternalAction);
   }
+
+  return {statusCode};
 };

src/actions/navigateToUrl.ts

@@ -8,7 +8,7 @@ import {log} from '../utils/log';
 
 import {navigateToUrl} from './navigateToUrl';
 
-import type {MapOptions, NavigateToUrlOptions, Url} from '../types/internal';
+import type {MapOptions, NavigateToUrlOptions, NavigationReturn, Url} from '../types/internal';
 
 /**
  * Navigate to the url and map custom response and request headers.
@@ -17,7 +17,7 @@ export const setHeadersAndNavigateToUrl = async (
   url: Url,
   options: MapOptions,
   navigateToUrlOptions?: NavigateToUrlOptions,
-): Promise<void> => {
+): Promise<NavigationReturn> => {
   const {mapRequestHeaders, mapResponseHeaders} = options;
 
   const page = getPlaywrightPage();
@@ -59,5 +59,5 @@ export const setHeadersAndNavigateToUrl = async (
     );
   }
 
-  await navigateToUrl(url, {skipLogs: true, ...navigateToUrlOptions});
+  return navigateToUrl(url, {skipLogs: true, ...navigateToUrlOptions});
 };

src/actions/setHeadersAndNavigateToUrl.ts

@@ -53,7 +53,7 @@ export type {
 } from './matchScreenshot';
 export type {ApiMockFunction} from './mockApiRoute';
 export type {WebSocketMockFunction} from './mockWebSocketRoute';
-export type {NavigateToUrlOptions} from './navigation';
+export type {NavigateToUrlOptions, NavigationReturn} from './navigation';
 export type {
   AnyPageClassType,
   NavigateToOrAssertPageArgs,
@@ -105,5 +105,6 @@ export type {
   UnionToIntersection,
   UnwrapSet,
   Values,
+  ZeroOrOneArg,
 } from './utils';
 export type {RequestPredicate, ResponsePredicate} from './waitForEvents';