Why does the playwright's onEnd() results not include the duration as specified in the documentation? What am I overlooking?

Question

Why does the playwright's onEnd() results not include the duration as specified in the documentation? What am I overlooking?

The built-in onEnd method can have a results object that is accessible within the function. According to the documentation here, this object should include the property duration, which represents the time in milliseconds. However, when I attempt to access results.duration, the value returned is undefined.

The code block provided below should display the start time, duration, and result of the entire test run, but only the result.status property appears to be defined.

async onEnd(result): Promise<void> {
    const suiteData: LogSuiteData = {
        "@timeStamp": result.startTime,
        suiteDuration: result.duration,
        suiteResult: result.status,
    };

    logArray.push(suiteData);

    await logCallHandler.postReportDataBatch(logArray);
}

Further investigation led me to discover the Playwright type FullResult, which is not documented officially. The included type within Playwright types only contains the status property, as shown in this screenshot.

Could it be that the official Playwright documentation is incorrect? Have I made an error somewhere in my implementation? Any assistance would be greatly appreciated.

For reference, I am currently using version 1.34.1.

typescript automated-tests playwright duration playwright-typescript

Answer 1

Answer №1

Instead of using result.durationMinutes, try using result.duration. Below is a complete example that works with @playwright/test ^1.42.1:

pw-reporter.js:

class MyReporter {
  onEnd(result) {
    console.log(result.duration);
  }
}

module.exports = MyReporter;

playwright.config.js:

import {defineConfig} from "@playwright/test";

export default defineConfig({
  reporter: [["./pw-reporter.js"]]
};

pw.test.js:

import {expect, test} from "@playwright/test";

test("1 is 1", async ({page}) => {
  await expect(1).toBe(1);
});

When you run npx playwright test, you should see a duration of 414.995 or something similar.

I noticed a typo in the documentation:

export default defineConfig({
  reporter: ['./my-awesome-reporter.ts', { customOption: 'some value' }],
});

This should actually be:

export default defineConfig({
  reporter: [['./my-awesome-reporter.ts', { customOption: 'some value' }]],
});

I have submitted a fix on GitHub.

Answer 2

Instead of using result.durationMinutes, try using result.duration. Below is a complete example that works with @playwright/test ^1.42.1:

pw-reporter.js:

class MyReporter {
  onEnd(result) {
    console.log(result.duration);
  }
}

module.exports = MyReporter;

playwright.config.js:

import {defineConfig} from "@playwright/test";

export default defineConfig({
  reporter: [["./pw-reporter.js"]]
};

pw.test.js:

import {expect, test} from "@playwright/test";

test("1 is 1", async ({page}) => {
  await expect(1).toBe(1);
});

When you run npx playwright test, you should see a duration of 414.995 or something similar.

I noticed a typo in the documentation:

export default defineConfig({
  reporter: ['./my-awesome-reporter.ts', { customOption: 'some value' }],
});

This should actually be:

export default defineConfig({
  reporter: [['./my-awesome-reporter.ts', { customOption: 'some value' }]],
});

I have submitted a fix on GitHub.

Why does the playwright's onEnd() results not include the duration as specified in the documentation? What am I overlooking?

Answer №1

Similar questions

JavaScript: Translating Date into Moment

What is the reason behind Webpack's behavior of loading all files from a folder during lazy loading

Arrange photos in a grid using React Dropzone uploaders

Conflicts arise when trying to create several objects with different material types in ThreeJS within the

Transform the object into an array of JSON with specified keys

Creating a personalized state object containing unresolved promises in React Native utilizing axios inside a custom React Hook

Share a callback function with child components via props

Cannot locate: Unable to find the module '@react-stately/collections' in the Next.js application

Discovering the generic type from an optional parameter within a constructor

How to implement a Typescript interface without necessarily implementing the parent interfaces

Enabling or disabling a button dynamically in Ionic based on a conditional statement

Enhance the readability of your Angular/Ionic applications with proper hyphenation

What are the steps to troubleshoot a Node Package Manager library in Visual Studio Code?

What is the best way to combine properties from Type1 and Type2 to create a new type in Typescript?

Excluding certain source files in Typescript's tsconfig is a common practice to

Error in React Native Navigation: Passing parameters is not functioning properly

What is the recommended data type to assign to the `CardElement` when using the `@stripe/react-stripe-js` package in TypeScript?

Instructions for opening a URL in a new tab using Angular

The problem with MUI SwipeableDrawer not being recognized as a JSX.Element

What is the procedure for utilizing custom .d.ts files in an Angular 15 project?