@prismicio/e2e-tests-utils 1.3.2 → 1.4.0

package/src/managers/repositories.ts

@@ -1,13 +1,10 @@
 import { SetupConfiguration, UrlConfig } from "../types";
 
-import {
-	AuthenticationClient,
-	createAuthenticationApiClient,
-} from "../clients/authenticationApi";
-import { createCoreApiClient } from "../clients/coreApi";
-import { createCustomTypesApiClient } from "../clients/customTypesApi";
+import { AuthenticationApiClient } from "../clients/authenticationApi";
+import { CoreApiClient } from "../clients/coreApi";
+import { CustomTypesApiClient } from "../clients/customTypesApi";
 import { ManageV2Client } from "../clients/manageV2";
-import { createMigrationApiClient } from "../clients/migrationApi";
+import { MigrationApiClient } from "../clients/migrationApi";
 import { WroomClient } from "../clients/wroom";
 import { EnvVariableManager } from "../utils/envVariableManager";
 import { logHttpResponse, logger } from "../utils/log";
@@ -41,7 +38,7 @@ export class RepositoriesManager {
 		urlConfig: UrlConfig;
 	};
 	private readonly wroomClient: WroomClient;
-	private readonly authClient: AuthenticationClient;
+	private readonly authClient: AuthenticationApiClient;
 	private readonly manageV2Client: ManageV2Client;
 	/**
 	 * helper to keep track of repositories across independent test phases (setup,
@@ -70,7 +67,7 @@ export class RepositoriesManager {
 			this.config.urlConfig.baseURL,
 			this.config.authConfig,
 		);
-		this.authClient = createAuthenticationApiClient(
+		this.authClient = new AuthenticationApiClient(
 			this.config.urlConfig.authenticationApi,
 			this.config.authConfig,
 		);
@@ -139,9 +136,12 @@ export class RepositoriesManager {
 		}
 		this.repositories.add(repositoryName);
 
-		profiler.done({ message: `created repository '${repositoryName}'` });
-
 		const repository = this.getRepositoryManager(repositoryName);
+		const version = await repository.getDeployedVersion();
+
+		profiler.done({
+			message: `created repository '${repositoryName}', Wroom version is "${version}"`,
+		});
 		await repository.configure(config);
 
 		return repository;
@@ -190,23 +190,29 @@ export class RepositoriesManager {
 	/**
 	 * Return a repository utilities object for a repository.
 	 *
-	 * @param name - The name of the repository.
+	 * @param repository - The name of the repository.
 	 */
-	getRepositoryManager(name: string): RepositoryManager {
+	getRepositoryManager(repository: string): RepositoryManager {
 		const { urlConfig } = this.config;
-		const customTypeClient = createCustomTypesApiClient(
+		const authToken = () => this.authClient.getToken();
+		const customTypeClient = new CustomTypesApiClient(
 			urlConfig.customTypesApi,
-			name,
-			this.authClient,
+			{
+				authToken,
+				repository,
+			},
 		);
-		const coreApiUrl = getRepositoryUrl(urlConfig.baseURL, name);
-		const coreApiClient = createCoreApiClient(coreApiUrl, this.authClient);
+		const coreApiUrl = getRepositoryUrl(urlConfig.baseURL, repository);
+		const coreApiClient = new CoreApiClient(coreApiUrl, authToken);
 		const migrationApiClient = urlConfig.migrationApi
-			? createMigrationApiClient(urlConfig.migrationApi, name, this.authClient)
+			? new MigrationApiClient(urlConfig.migrationApi, {
+					authToken,
+					repository,
+				})
 			: undefined;
 
 		return new RepositoryManager(
-			name,
+			repository,
 			coreApiClient,
 			this.authClient,
 			this.wroomClient,

package/src/managers/repository.ts

@@ -6,15 +6,15 @@ import {
 	SharedSlice,
 } from "@prismicio/types-internal/lib/customtypes";
 
-import type { AuthenticationClient } from "../clients/authenticationApi";
+import { AuthenticationApiClient } from "../clients/authenticationApi";
 import { ContentApiClient } from "../clients/contentApi";
 import type { CoreClient } from "../clients/coreApi";
-import { CustomTypesClient } from "../clients/customTypesApi";
+import { CustomTypesApiClient } from "../clients/customTypesApi";
 import { ManageV2Client } from "../clients/manageV2";
 import {
 	DocumentPayload,
 	DocumentResponse,
-	MigrationClient,
+	MigrationApiClient,
 } from "../clients/migrationApi";
 import { WroomClient } from "../clients/wroom";
 import { logHttpResponse, logger } from "../utils/log";
@@ -25,10 +25,10 @@ export class RepositoryManager {
 	constructor(
 		readonly name: string,
 		private readonly coreApiClient: CoreClient,
-		private readonly authApiClient: AuthenticationClient,
+		private readonly authApiClient: AuthenticationApiClient,
 		private readonly wroomClient: WroomClient,
-		private readonly customTypesApiClient: CustomTypesClient,
-		private readonly migrationApiClient: MigrationClient | undefined,
+		private readonly customTypesApiClient: CustomTypesApiClient,
+		private readonly migrationApiClient: MigrationApiClient | undefined,
 		private readonly manageV2Client: ManageV2Client,
 	) {}
 
@@ -37,7 +37,6 @@ export class RepositoryManager {
 			config.defaultLocale || config.locales || config.customLocale;
 		if (hasLangConfig) {
 			const languages = await this.coreApiClient.getLanguages();
-
 			// default locale must be set first
 			if (config.defaultLocale) {
 				const master = languages.find(({ is_master }) => is_master === true);
@@ -105,6 +104,17 @@ export class RepositoryManager {
 		return new ContentApiClient(this.getBaseCdnURL(), config);
 	}
 
+	/** @returns the Wroom commit hash deployed on the current repository */
+	async getDeployedVersion(): Promise<string | undefined> {
+		const response = await this.wroomClient.get(
+			this.name,
+			"underground/834b34f16f451e00f268dd5c8c81d16e3c020275",
+		);
+
+		// Somehow axios directly parses the text response `Prismic version: <commit hash> into a version attribute
+		return response.data.version;
+	}
+
 	/**
 	 * Set additional standard locales for a repository in Wroom, does not fail if
 	 * the locales already exist.

package/src/utils/log.ts

@@ -1,3 +1,4 @@
+import { APIResponse } from "@playwright/test";
 import { AxiosResponse } from "axios";
 import { createLogger, format, transports } from "winston";
 
@@ -13,6 +14,16 @@ export const logHttpResponse = (response: AxiosResponse): void => {
 	);
 };
 
+export const logPlaywrightApiResponse = async (
+	response: APIResponse,
+): Promise<void> => {
+	logger.info(
+		`Call to ${response.url()} failed, received [${response.status()}] ${JSON.stringify(
+			await response.text(),
+		)}`,
+	);
+};
+
 const { combine, printf } = format;
 
 const customFormat = printf(({ message, durationMs }) => {