Minor tidy up

- rename article to feFixture in load-page
- undo playwright.config changes used for testing
- set local workers to 2 to improve stability

Author: arelra

dotcom-rendering/playwright.config.ts

@@ -3,12 +3,10 @@ import { defineConfig, devices } from '@playwright/test';
 const isDev = process.env.NODE_ENV !== 'production';
 
 /**
- * Server port
- * 	local development: 3030
- * 	CI: 9000
+ * The server port for local development or CI
  */
 export const PORT = isDev ? 3030 : 9000;
-export const ORIGIN = `http://localhost:9000`;
+export const ORIGIN = `http://localhost:${PORT}`;
 
 /**
  * See https://playwright.dev/docs/test-configuration.
@@ -23,7 +21,7 @@ export default defineConfig({
 	// Retry on CI only
 	retries: process.env.CI ? 3 : 1,
 	// Workers run tests files in parallel
-	workers: process.env.CI ? 4 : undefined,
+	workers: process.env.CI ? 4 : 2,
 	// Reporter to use. See https://playwright.dev/docs/test-reporters
 	reporter: [['line'], ['html', { open: 'never' }]],
 	// Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions
@@ -42,12 +40,12 @@ export default defineConfig({
 			use: { ...devices['Desktop Chrome'] },
 		},
 	],
-	// webServer: {
-	// 	// On CI the server is already started so a no-op
-	// 	command: ':',
-	// 	url: ORIGIN,
-	// 	reuseExistingServer: true,
-	// 	stdout: 'pipe',
-	// 	stderr: 'pipe',
-	// },
+	webServer: {
+		// On CI the server is already started so a no-op
+		command: isDev ? 'make dev' : ':',
+		url: ORIGIN,
+		reuseExistingServer: true,
+		stdout: 'pipe',
+		stderr: 'pipe',
+	},
 });

dotcom-rendering/playwright/lib/load-page.ts

@@ -17,7 +17,7 @@ type LoadPageOptions = {
 	overrides?: {
 		configOverrides?: Record<string, unknown>;
 		switchOverrides?: Record<string, unknown>;
-		article?: FEArticle;
+		feFixture?: FEArticle | FEFront;
 	};
 };
 
@@ -91,7 +91,7 @@ const validateJson = (path: string, json: unknown): FEArticle | FEFront => {
 	} else if (path.startsWith('/Front')) {
 		return validateAsFEFront(json);
 	}
-	throw new Error(`Unsupported URL for validating article: ${path}`);
+	throw new Error(`Unsupported URL for validating payload for: ${path}`);
 };
 
 /**
@@ -164,22 +164,22 @@ const loadPage = async ({
 
 	const cookies = await page.context().cookies();
 
-	// If overrides exist, but no article fixture we fetch it from Frontend
-	const frontendPage = await (overrides.article
-		? Promise.resolve(overrides.article)
+	// If overrides exist, but no fixture is provided we fetch it from Frontend
+	const frontendModel = await (overrides.feFixture
+		? Promise.resolve(overrides.feFixture)
 		: validateJson(
 				path,
 				await getFrontendJson(path, cookies, queryParams),
 		  ));
 
-	// Apply the overrides to the article config and switches
+	// Apply the config and switch overrides
 	const postData = {
-		...frontendPage,
+		...frontendModel,
 		config: {
-			...frontendPage.config,
+			...frontendModel.config,
 			...overrides.configOverrides,
 			switches: {
-				...frontendPage.config.switches,
+				...frontendModel.config.switches,
 				...overrides.switchOverrides,
 			},
 		},

dotcom-rendering/playwright/tests/lightbox.e2e.spec.ts

@@ -77,7 +77,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: photoEssayArticle },
+			overrides: { feFixture: photoEssayArticle },
 		});
 
 		await expectToNotBeVisible(page, '#gu-lightbox');
@@ -102,7 +102,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: photoEssayArticle },
+			overrides: { feFixture: photoEssayArticle },
 		});
 
 		await expectToNotBeVisible(page, '#gu-lightbox');
@@ -124,7 +124,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: photoEssayArticle },
+			overrides: { feFixture: photoEssayArticle },
 		});
 
 		await page.locator('article img').first().click({ force: true });
@@ -173,7 +173,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: photoEssayArticle },
+			overrides: { feFixture: photoEssayArticle },
 		});
 
 		await expectToNotBeVisible(page, '#gu-lightbox');
@@ -265,7 +265,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: photoEssayArticle },
+			overrides: { feFixture: photoEssayArticle },
 		});
 
 		// eq(6) here means the 7th button is clicked (base zero)
@@ -308,7 +308,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: photoEssayArticle },
+			overrides: { feFixture: photoEssayArticle },
 		});
 
 		await page.locator('button.open-lightbox').nth(1).click();
@@ -359,7 +359,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: photoEssayArticle },
+			overrides: { feFixture: photoEssayArticle },
 		});
 
 		await page.locator('button.open-lightbox').nth(1).click();
@@ -405,7 +405,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: LiveBlog },
+			overrides: { feFixture: LiveBlog },
 		});
 
 		await page.locator('button.open-lightbox').nth(1).click();
@@ -436,7 +436,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: photoEssayArticle },
+			overrides: { feFixture: photoEssayArticle },
 		});
 
 		await page.locator('button.open-lightbox').nth(1).click();
@@ -470,7 +470,7 @@ test.describe('Lightbox', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: photoEssayArticle },
+			overrides: { feFixture: photoEssayArticle },
 		});
 
 		await expectToNotBeVisible(page, '#gu-lightbox');

dotcom-rendering/playwright/tests/signed-out.e2e.spec.ts

@@ -13,7 +13,7 @@ test.describe('Signed out readers', () => {
 		await loadPage({
 			page,
 			path: '/Article',
-			overrides: { article: standardArticle },
+			overrides: { feFixture: standardArticle },
 		});
 
 		await waitForIsland(page, 'DiscussionWeb');