Chore: add playwright ee coverage (#26293)

Co-authored-by: souzaramon <25514401+souzaramon@users.noreply.github.com>
Co-authored-by: Kevin Aleman <11577696+KevLehman@users.noreply.github.com>
Co-authored-by: Guilherme Gazzo <5263975+ggazzo@users.noreply.github.com>
Co-authored-by: Murtaza Patrawala <34130764+murtaza98@users.noreply.github.com>
Co-authored-by: Rodrigo Nascimento <234261+rodrigok@users.noreply.github.com>

.github/workflows/build_and_test.yml

@@ -681,13 +681,31 @@ jobs:
           docker logs presence --tail=50
 
           cd ./apps/meteor
-          IS_EE=true npm run test:e2e
+
+          E2E_COVERAGE=true IS_EE=true npm run test:e2e
+
+      - name: Extract e2e:ee:coverage
+        run: |
+          cd ./apps/meteor
+          yarn test:e2e:nyc
+
+      - uses: codecov/codecov-action@v3
+        with:
+          directory: ./apps/meteor
+          flags: e2e
+          verbose: true
+
+      - name: Store e2e-ee-coverage
+        uses: actions/upload-artifact@v2
+        with:
+          name: e2e-ee-coverage
+          path: ./apps/meteor/coverage*
 
       - name: Store playwright test trace
         uses: actions/upload-artifact@v2
         if: failure()
         with:
-          name: playwright-test-trace
+          name: e2e-ee-testtrace
           path: ./apps/meteor/tests/e2e/test-failures*
 
   deploy:

apps/meteor/.babelrc

@@ -2,5 +2,8 @@
 	"presets": [
 		"@babel/preset-env",
 		"@babel/preset-react"
+	],
+	"plugins": [
+		"babel-plugin-istanbul"
 	]
 }

apps/meteor/package.json

@@ -33,6 +33,7 @@
 		"deploy": "npm run build && pm2 startOrRestart pm2.json",
 		"coverage": "nyc -r html mocha --config ./.mocharc.js",
 		"test:e2e": "playwright test",
+		"test:e2e:nyc": "nyc report --reporter=text-summary --reporter=lcov",
 		"testapi": "mocha --config ./.mocharc.api.js",
 		"testunit": "npm run .testunit:definition && npm run .testunit:client && npm run .testunit:server",
 		".testunit:server": "mocha --config ./.mocharc.js",
@@ -141,6 +142,7 @@
 		"autoprefixer": "^9.8.8",
 		"babel-loader": "^8.2.5",
 		"babel-plugin-array-includes": "^2.0.3",
+		"babel-plugin-istanbul": "^6.1.1",
 		"chai": "^4.3.6",
 		"chai-datetime": "^1.8.0",
 		"chai-dom": "^1.11.0",
@@ -159,6 +161,7 @@
 		"jsdom-global": "^3.0.2",
 		"mocha": "^9.2.2",
 		"mock-require": "^3.0.3",
+		"nyc": "^15.1.0",
 		"outdent": "~0.8.0",
 		"pino-pretty": "^7.6.1",
 		"postcss": "~8.4.14",

apps/meteor/tests/e2e/01-forgot-password.spec.ts

@@ -1,5 +1,4 @@
-import { test, expect } from '@playwright/test';
-
+import { test, expect } from './utils/test';
 import { Auth } from './page-objects';
 
 test.describe('Forgot Password', () => {

apps/meteor/tests/e2e/02-register.spec.ts

@@ -1,6 +1,6 @@
-import { test, expect } from '@playwright/test';
 import { faker } from '@faker-js/faker';
 
+import { test, expect } from './utils/test';
 import { Auth } from './page-objects';
 
 test.describe('Register', () => {

apps/meteor/tests/e2e/03-login.spec.ts

@@ -1,6 +1,6 @@
-import { test, expect } from '@playwright/test';
 import { faker } from '@faker-js/faker';
 
+import { test, expect } from './utils/test';
 import { Auth } from './page-objects';
 
 test.describe('Login', () => {

apps/meteor/tests/e2e/05-channel-creation.spec.ts

@@ -1,6 +1,6 @@
-import { test, expect } from '@playwright/test';
 import { faker } from '@faker-js/faker';
 
+import { test, expect } from './utils/test';
 import { HomeChannel, Auth } from './page-objects';
 
 test.describe('Channel Creation', () => {

apps/meteor/tests/e2e/06-messaging.spec.ts

@@ -1,5 +1,6 @@
-import { expect, test, Browser, Page } from '@playwright/test';
+import { Browser, Page } from '@playwright/test';
 
+import { test, expect } from './utils/test';
 import { validUserInserted } from './utils/mocks/userAndPasswordMock';
 import { Auth, HomeChannel } from './page-objects';
 

apps/meteor/tests/e2e/07-emoji.spec.ts

@@ -1,5 +1,4 @@
-import { test, expect } from '@playwright/test';
-
+import { test, expect } from './utils/test';
 import { Auth, HomeChannel } from './page-objects';
 
 test.describe('Emoji', () => {

apps/meteor/tests/e2e/09-channel.spec.ts

@@ -1,5 +1,4 @@
-import { test, expect } from '@playwright/test';
-
+import { test, expect } from './utils/test';
 import { publicChannelCreated, setPublicChannelCreated } from './utils/mocks/checks';
 import { Auth, HomeChannel } from './page-objects';
 

apps/meteor/tests/e2e/10-user-preferences.spec.ts

@@ -1,6 +1,6 @@
-import { test, expect } from '@playwright/test';
 import { faker } from '@faker-js/faker';
 
+import { test, expect } from './utils/test';
 import { Auth, HomeChannel, AccountProfile } from './page-objects';
 
 test.describe('User preferences', () => {

apps/meteor/tests/e2e/11-admin.spec.ts

@@ -1,5 +1,4 @@
-import { test, expect } from '@playwright/test';
-
+import { test, expect } from './utils/test';
 import { Auth, Administration } from './page-objects';
 
 test.describe('Administration', () => {

apps/meteor/tests/e2e/12-settings.spec.ts

@@ -1,6 +1,7 @@
-import { test, expect, Page } from '@playwright/test';
+import { Page } from '@playwright/test';
 import { v4 as uuid } from 'uuid';
 
+import { test, expect } from './utils/test';
 import { BASE_API_URL } from './utils/constants';
 import { adminLogin, validUserInserted, registerUser } from './utils/mocks/userAndPasswordMock';
 import { Auth, HomeChannel, AccountProfile, Administration } from './page-objects';

apps/meteor/tests/e2e/13-permissions.spec.ts

@@ -1,7 +1,7 @@
-import { test, expect } from '@playwright/test';
 import { v4 as uuid } from 'uuid';
 import faker from '@faker-js/faker';
 
+import { test, expect } from './utils/test';
 import { Auth, Administration, HomeChannel } from './page-objects';
 
 test.describe('Permissions', () => {

apps/meteor/tests/e2e/14-setting-permissions.spec.ts

@@ -1,8 +1,8 @@
-import { test, expect } from '@playwright/test';
 import faker from '@faker-js/faker';
 
-import { validUserInserted } from './utils/mocks/userAndPasswordMock';
+import { test, expect } from './utils/test';
 import { Auth, Administration, HomeChannel } from './page-objects';
+import { validUserInserted } from './utils/mocks/userAndPasswordMock';
 
 test.describe('Settings Permissions', () => {
 	let pageAuth: Auth;

apps/meteor/tests/e2e/15-message-popup.spec.ts

@@ -1,5 +1,4 @@
-import { test, expect } from '@playwright/test';
-
+import { test, expect } from './utils/test';
 import { Auth, HomeChannel } from './page-objects';
 
 test.describe('Message Popup', () => {

apps/meteor/tests/e2e/16-discussion.spec.ts

@@ -1,7 +1,7 @@
-import { test } from '@playwright/test';
 import { faker } from '@faker-js/faker';
 import { v4 as uuid } from 'uuid';
 
+import { test } from './utils/test';
 import { Auth, HomeDiscussion } from './page-objects';
 
 test.describe('[Discussion]', () => {

apps/meteor/tests/e2e/omnichannel-agents.spec.ts

@@ -1,5 +1,4 @@
-import { test, expect } from '@playwright/test';
-
+import { test, expect } from './utils/test';
 import { Auth, OmnichannelAgents } from './page-objects';
 
 test.describe('Agents', () => {

apps/meteor/tests/e2e/omnichannel-departaments.spec.ts

@@ -1,5 +1,4 @@
-import { test, expect } from '@playwright/test';
-
+import { test, expect } from './utils/test';
 import { Auth, OmnichannelDepartaments } from './page-objects';
 
 test.describe('Department', () => {

apps/meteor/tests/e2e/page-objects/administration.ts

@@ -1,5 +1,6 @@
-import { Locator, expect, Page } from '@playwright/test';
+import { Locator, Page } from '@playwright/test';
 
+import { expect } from '../utils/test';
 import { AdminFlextab, AdminSidenav } from './fragments';
 
 export class Administration {

apps/meteor/tests/e2e/page-objects/home-discussion.ts

@@ -1,5 +1,6 @@
-import { Locator, Page, expect } from '@playwright/test';
+import { Locator, Page } from '@playwright/test';
 
+import { expect } from '../utils/test';
 import { HomeContent, HomeSidenav, HomeFlextab } from './fragments';
 
 export class HomeDiscussion {

apps/meteor/tests/e2e/page-objects/omnichannel-agents.ts

@@ -1,4 +1,6 @@
-import { Locator, expect, Page } from '@playwright/test';
+import { Locator, Page } from '@playwright/test';
+
+import { expect } from '../utils/test';
 
 export class OmnichannelAgents {
 	private readonly page: Page;

apps/meteor/tests/e2e/utils/test.ts

@@ -0,0 +1,41 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+import { v4 as uuid } from 'uuid';
+import { test as baseTest } from '@playwright/test';
+
+const PATH_NYC_OUTPUT = path.join(process.cwd(), '.nyc_output');
+// @ts-ignore
+export const test = baseTest.extend({
+	context: async ({ context }, use) => {
+		if (!process.env.E2E_COVERAGE) {
+			await use(context);
+			await context.close();
+
+			return;
+		}
+
+		await context.addInitScript(() =>
+			window.addEventListener('beforeunload', () => (window as any).collectIstanbulCoverage(JSON.stringify((window as any).__coverage__))),
+		);
+
+		await fs.promises.mkdir(PATH_NYC_OUTPUT, { recursive: true });
+
+		await context.exposeFunction('collectIstanbulCoverage', (coverageJSON: string) => {
+			if (coverageJSON) {
+				fs.writeFileSync(path.join(PATH_NYC_OUTPUT, `playwright_coverage_${uuid()}.json`), coverageJSON);
+			}
+		});
+
+		await use(context);
+
+		await Promise.all(
+			context.pages().map(async (page) => {
+				await page.evaluate(() => (window as any).collectIstanbulCoverage(JSON.stringify((window as any).__coverage__)));
+				await page.close();
+			}),
+		);
+	},
+});
+
+export const { expect } = test;