@prismicio/e2e-tests-utils 1.18.0 → 1.19.0

package/src/clients/wroom.ts

@@ -1,24 +1,20 @@
-import axios, { AxiosInstance, AxiosResponse } from "axios";
+import type { AxiosInstance, AxiosResponse } from "axios"
+import axios from "axios"
 
-import { AuthConfig } from "../types";
+import type { AuthConfig } from "../types"
+import { extractCookie } from "../utils/cookies"
+import { logHttpResponse, logger } from "../utils/log"
+import { getRepositoryUrl } from "../utils/urls"
 
-import { extractCookie } from "../utils/cookies";
-import { logHttpResponse, logger } from "../utils/log";
-import { getRepositoryUrl } from "../utils/urls";
-
-/**
- * Client for interacting with the Wroom service to perform operations on
- * repositories.
- */
+/** Client for interacting with the Wroom service to perform operations on repositories. */
 export class WroomClient {
-	private readonly client: AxiosInstance;
-	private loggedIn = false;
+	private readonly client: AxiosInstance
+	private loggedIn = false
 
 	/**
 	 * @param baseURL - The base URL of the Wroom app. ex: https://prismic.io
 	 * @param auth - Authentication credentials.
-	 * @param cluster - Cluster where to create the repository (only work in
-	 *   staging)
+	 * @param cluster - Cluster where to create the repository (only work in staging)
 	 */
 	constructor(
 		baseURL: string,
@@ -29,7 +25,7 @@ export class WroomClient {
 			? {
 					"X-Prismic-Cluster": cluster,
 				}
-			: {};
+			: {}
 
 		this.client = axios.create({
 			baseURL,
@@ -40,58 +36,54 @@ export class WroomClient {
 				"User-Agent": "prismic-cli/prismic-e2e-tests-utils",
 				...clusterHeader,
 			},
-		});
+		})
 
 		// cookies are not forwarded automatically in a non-browser env
 		this.client.interceptors.response.use((response) => {
-			const cookies = response.headers["set-cookie"];
+			const cookies = response.headers["set-cookie"]
 			if (cookies && extractCookie(cookies, "SESSION")) {
-				this.client.defaults.headers["Cookie"] = cookies;
+				this.client.defaults.headers["Cookie"] = cookies
 			}
 
-			return response;
-		});
+			return response
+		})
 	}
 
 	getBaseURL(): string {
-		return this.client.getUri();
+		return this.client.getUri()
 	}
 
-	/** authenticated GET request on the wroom backend */
+	/** Authenticated GET request on the wroom backend */
 	async get(repository: string | null, path: string): Promise<AxiosResponse> {
 		if (!this.loggedIn) {
-			await this.login();
+			await this.login()
 		}
 
-		let url = new URL(path, this.client.getUri()).toString();
+		let url = new URL(path, this.client.getUri()).toString()
 		if (repository) {
-			url = getRepositoryUrl(url, repository);
+			url = getRepositoryUrl(url, repository)
 		}
 
-		return this.client.get(url);
+		return this.client.get(url)
 	}
 
-	/** authenticated POST request on the wroom backend */
-	async post(
-		repository: string | null,
-		path: string,
-		data?: unknown,
-	): Promise<AxiosResponse> {
+	/** Authenticated POST request on the wroom backend */
+	async post(repository: string | null, path: string, data?: unknown): Promise<AxiosResponse> {
 		if (!this.loggedIn) {
-			await this.login();
+			await this.login()
 		}
 
-		let url = new URL(path, this.client.getUri()).toString();
+		let url = new URL(path, this.client.getUri()).toString()
 		if (repository) {
-			url = getRepositoryUrl(url, repository);
+			url = getRepositoryUrl(url, repository)
 		}
 		const response = await this.client.post(url.toString(), data, {
 			params: {
 				_: extractCookie(this.client.defaults.headers["Cookie"], "X_XSRF"),
 			},
-		});
+		})
 
-		return response;
+		return response
 	}
 
 	/**
@@ -100,18 +92,13 @@ export class WroomClient {
 	 * @param {string} repository - The repository name
 	 * @param {string} email - The email of the user
 	 * @param {string} role - The new role to be given
-	 *
 	 * @returns The Axios Reponse
 	 */
-	async updateRole(
-		repository: string,
-		email: string,
-		role: string,
-	): Promise<AxiosResponse> {
-		const params = new URLSearchParams({ email, profile: role });
-		const path = `/app/settings/users/profiles?${params.toString()}`;
+	async updateRole(repository: string, email: string, role: string): Promise<AxiosResponse> {
+		const params = new URLSearchParams({ email, profile: role })
+		const path = `/app/settings/users/profiles?${params.toString()}`
 
-		return this.post(repository, path);
+		return this.post(repository, path)
 	}
 
 	/**
@@ -120,7 +107,6 @@ export class WroomClient {
 	 * @param {string} repository - The repository name
 	 * @param {string} email - The email of the user
 	 * @param {string} rolePerLocal - The role per local object
-	 *
 	 * @returns The Axios Reponse
 	 */
 	async updateRolePerLocal(
@@ -128,10 +114,10 @@ export class WroomClient {
 		email: string,
 		rolePerLocal: Record<string, string>,
 	): Promise<AxiosResponse> {
-		const params = new URLSearchParams({ email });
-		const path = `/app/settings/users/rolesperlocale?${params.toString()}`;
+		const params = new URLSearchParams({ email })
+		const path = `/app/settings/users/rolesperlocale?${params.toString()}`
 
-		return this.post(repository, path, rolePerLocal);
+		return this.post(repository, path, rolePerLocal)
 	}
 
 	/**
@@ -140,17 +126,17 @@ export class WroomClient {
 	 * @throws Error if the login to Wroom fails.
 	 */
 	private async login(): Promise<void> {
-		const profiler = logger.startTimer();
+		const profiler = logger.startTimer()
 		const response = await this.client.post<string>("/authentication/signin", {
 			email: this.auth.email,
 			password: this.auth.password,
-		});
+		})
 
 		if (response.status !== 200) {
-			logHttpResponse(response);
-			throw new Error("Could not login to Prismic, check your credentials");
+			logHttpResponse(response)
+			throw new Error("Could not login to Prismic, check your credentials")
 		}
-		this.loggedIn = true;
-		profiler.done({ message: "logged in to Prismic" });
+		this.loggedIn = true
+		profiler.done({ message: "logged in to Prismic" })
 	}
 }

package/src/index.ts

@@ -1,7 +1,7 @@
-export * from "./managers/repositories";
-export * from "./managers/repository";
-export * from "./clients/coreApi";
-export * from "./clients/contentApi";
-export * from "./clients/assetApi";
-export * from "./clients/migrationApi";
-export * from "./types";
+export * from "./managers/repositories"
+export * from "./managers/repository"
+export * from "./clients/coreApi"
+export * from "./clients/contentApi"
+export * from "./clients/assetApi"
+export * from "./clients/migrationApi"
+export * from "./types"

package/src/managers/repositories.ts

@@ -1,26 +1,24 @@
-import { SetupConfiguration, UrlConfig } from "../types";
-
-import { AssetApiClient } from "../clients/assetApi";
-import { AuthenticationApiClient } from "../clients/authenticationApi";
-import { CoreApiClient } from "../clients/coreApi";
-import { CustomTypesApiClient } from "../clients/customTypesApi";
-import { IntegrationFieldsClient } from "../clients/integrationFields";
-import { ManageV2Client } from "../clients/manageV2";
-import { MigrationApiClient } from "../clients/migrationApi";
-import { WroomClient } from "../clients/wroom";
-import { EnvVariableManager } from "../utils/envVariableManager";
-import { logHttpResponse, logger } from "../utils/log";
-import { randomString } from "../utils/random";
-import { getRepositoryUrl } from "../utils/urls";
-
-import { RepositoryConfig, RepositoryManager } from "./repository";
+import { AssetApiClient } from "../clients/assetApi"
+import { AuthenticationApiClient } from "../clients/authenticationApi"
+import { CoreApiClient } from "../clients/coreApi"
+import { CustomTypesApiClient } from "../clients/customTypesApi"
+import { IntegrationFieldsClient } from "../clients/integrationFields"
+import { ManageV2Client } from "../clients/manageV2"
+import { MigrationApiClient } from "../clients/migrationApi"
+import { WroomClient } from "../clients/wroom"
+import type { SetupConfiguration, UrlConfig } from "../types"
+import { EnvVariableManager } from "../utils/envVariableManager"
+import { logHttpResponse, logger } from "../utils/log"
+import { randomString } from "../utils/random"
+import { getRepositoryUrl } from "../utils/urls"
+import type { RepositoryConfig } from "./repository"
+import { RepositoryManager } from "./repository"
 
 /**
- * Factory method to create a RepositoriesManager to manage repositories test
- * data.
+ * Factory method to create a RepositoriesManager to manage repositories test data.
  *
- * @param configuration - Global object containing the different configurations
- *   required to setup the RepositoriesManager.
+ * @param configuration - Global object containing the different configurations required to setup
+ *   the RepositoriesManager.
  *
  *       - {@link configuration.urlConfig}: Configuration around the API's URLs management.
  *       - {@link configuration.authConfig}: Configuration around the authentication of a user.
@@ -31,28 +29,23 @@ import { RepositoryConfig, RepositoryManager } from "./repository";
 export const createRepositoriesManager = (
 	configuration: SetupConfiguration,
 ): RepositoriesManager => {
-	return new RepositoriesManager(configuration);
-};
+	return new RepositoriesManager(configuration)
+}
 
 /** Utility object to manage Prismic test data */
 export class RepositoriesManager {
 	private readonly config: Omit<SetupConfiguration, "urlConfig"> & {
-		urlConfig: UrlConfig;
-	};
-	private readonly wroomClient: WroomClient;
-	private readonly authClient: AuthenticationApiClient;
-	private readonly manageV2Client: ManageV2Client;
-	/**
-	 * helper to keep track of repositories across independent test phases (setup,
-	 * teardown)
-	 */
-	private readonly repositories = new EnvVariableManager(
-		"_PRISMIC_E2E_TESTS_REPOS",
-	);
+		urlConfig: UrlConfig
+	}
+	private readonly wroomClient: WroomClient
+	private readonly authClient: AuthenticationApiClient
+	private readonly manageV2Client: ManageV2Client
+	/** Helper to keep track of repositories across independent test phases (setup, teardown) */
+	private readonly repositories = new EnvVariableManager("_PRISMIC_E2E_TESTS_REPOS")
 
 	/**
-	 * @param configuration - Global object containing the different configuration
-	 *   required to setup the different clients.
+	 * @param configuration - Global object containing the different configuration required to setup
+	 *   the different clients.
 	 * @param credentials - Authentication credentials (email and password)
 	 */
 	constructor(configuration: SetupConfiguration) {
@@ -64,39 +57,35 @@ export class RepositoriesManager {
 				typeof configuration.urlConfig === "string"
 					? this.inferUrls(configuration.urlConfig)
 					: configuration.urlConfig,
-		};
+		}
 
 		this.wroomClient = new WroomClient(
 			this.config.urlConfig.baseURL,
 			this.config.authConfig,
 			this.config.cluster,
-		);
+		)
 		this.authClient = new AuthenticationApiClient(
 			this.config.urlConfig.authenticationApi,
 			this.config.authConfig,
-		);
+		)
 		this.manageV2Client = new ManageV2Client(
 			this.config.urlConfig.baseURL,
 			this.config.manageV2Config,
-		);
+		)
 
 		// This logic specific to staging environment allow us to target a specific version of the custom types API.
 		// This is only works for unify-exp at the moment.
 		// Having this logic here avoids duplicating it across different CI workflows.
 		this.config.urlConfig.customTypesApi =
-			configuration.environment === "stage" &&
-			configuration.cluster === "unify-exp"
+			configuration.environment === "stage" && configuration.cluster === "unify-exp"
 				? `https://customtypes.wroom.io/${configuration.cluster}/`
-				: this.config.urlConfig.customTypesApi;
+				: this.config.urlConfig.customTypesApi
 	}
 
-	/**
-	 * If the baseURL is prismic.io, assume the other services have the format
-	 * <name>.prismic.io
-	 */
+	/** If the baseURL is prismic.io, assume the other services have the format <name>.prismic.io */
 	private inferUrls(baseURL: string): UrlConfig {
-		const url = new URL(baseURL);
-		const protocol = url.protocol.slice(0, -1); // Remove the trailing colon from the protocol
+		const url = new URL(baseURL)
+		const protocol = url.protocol.slice(0, -1) // Remove the trailing colon from the protocol
 
 		return {
 			baseURL: baseURL,
@@ -108,100 +97,91 @@ export class RepositoriesManager {
 				url.hostname === "prismic.io"
 					? `${protocol}://if-api.${url.hostname}`
 					: `${protocol}://api.${url.hostname}`,
-		};
+		}
 	}
 
 	/**
 	 * Generate a user token from the authentication service.
 	 *
-	 * @returns a JWT token
+	 * @returns A JWT token
 	 */
 	async getUserApiToken(): Promise<string> {
-		return this.authClient.getToken();
+		return this.authClient.getToken()
 	}
 
 	/**
 	 * Create a new repository in Wroom.
 	 *
 	 * @param repositoryName - The name of the repository.
-	 *
 	 * @throws Error if the repository creation fails.
 	 */
 	async createRepository(
 		config: {
-			prefix?: string;
+			prefix?: string
 		} & RepositoryConfig = {},
 	): Promise<RepositoryManager> {
-		const profiler = logger.startTimer();
-
-		const { prefix = "e2e-tests" } = config;
-		const repositoryName = `${prefix}-${randomString()}`;
-
-		const response = await this.wroomClient.post(
-			null,
-			"authentication/newrepository",
-			{
-				domain: repositoryName,
-				framework: "next",
-				plan: "personal",
-				isAnnual: "false",
-				role: "developer",
-			},
-		);
+		const profiler = logger.startTimer()
+
+		const { prefix = "e2e-tests" } = config
+		const repositoryName = `${prefix}-${randomString()}`
+
+		const response = await this.wroomClient.post(null, "authentication/newrepository", {
+			domain: repositoryName,
+			framework: "next",
+			plan: "personal",
+			isAnnual: "false",
+			role: "developer",
+		})
 		if (response.status !== 200) {
-			logHttpResponse(response);
-			throw new Error(`Could not create repository ${repositoryName}`);
+			logHttpResponse(response)
+			throw new Error(`Could not create repository ${repositoryName}`)
 		}
-		this.repositories.add(repositoryName);
+		this.repositories.add(repositoryName)
 
-		const repository = this.getRepositoryManager(repositoryName);
-		const version = await repository.getDeployedVersion();
+		const repository = this.getRepositoryManager(repositoryName)
+		const version = await repository.getDeployedVersion()
 
 		profiler.done({
 			message: `created repository '${repositoryName}', Wroom version is "${version}"`,
-		});
-		await repository.configure(config);
+		})
+		await repository.configure(config)
 
-		return repository;
+		return repository
 	}
 
 	/**
 	 * Delete a repository from Wroom.
 	 *
 	 * @param repository - The name of the repository.
-	 *
 	 * @throws Error if the repository deletion fails.
 	 */
 	async deleteRepository(repository: string): Promise<void> {
-		const profiler = logger.startTimer();
+		const profiler = logger.startTimer()
 
 		const post = async () =>
 			this.wroomClient.post(repository, "app/settings/delete", {
 				confirm: repository,
 				password: this.config.authConfig.password,
-			});
-		const response = await post();
+			})
+		const response = await post()
 		if (response.status !== 200) {
 			// sometimes the deletion returns 500 but actually succeeds
 			// we run the query again and check the repo is actually deleted (404)
-			const retry = await post();
+			const retry = await post()
 			if (retry.status !== 404) {
-				logHttpResponse(response);
-				throw new Error(`Could not delete repository ${repository}`);
+				logHttpResponse(response)
+				throw new Error(`Could not delete repository ${repository}`)
 			}
 		}
-		this.repositories.remove(repository);
-		profiler.done({ message: `deleted repository '${repository}'` });
+		this.repositories.remove(repository)
+		profiler.done({ message: `deleted repository '${repository}'` })
 	}
 
-	/**
-	 * Cleanup test data. For example, it deletes repositories created using
-	 * createRepository()
-	 */
+	/** Cleanup test data. For example, it deletes repositories created using createRepository() */
 	async tearDown(): Promise<void> {
-		const repositories = this.repositories.getAll();
+		const repositories = this.repositories.getAll()
 		for (const repository of repositories) {
-			await this.deleteRepository(repository);
+			await this.deleteRepository(repository)
 		}
 	}
 
@@ -211,34 +191,31 @@ export class RepositoriesManager {
 	 * @param repository - The name of the repository.
 	 */
 	getRepositoryManager(repository: string): RepositoryManager {
-		const { urlConfig } = this.config;
-		const authToken = () => this.authClient.getToken();
-		const customTypeClient = new CustomTypesApiClient(
-			urlConfig.customTypesApi,
-			{
-				authToken,
-				repository,
-			},
-		);
-		const coreApiUrl = getRepositoryUrl(urlConfig.baseURL, repository);
-		const coreApiClient = new CoreApiClient(coreApiUrl, authToken);
+		const { urlConfig } = this.config
+		const authToken = () => this.authClient.getToken()
+		const customTypeClient = new CustomTypesApiClient(urlConfig.customTypesApi, {
+			authToken,
+			repository,
+		})
+		const coreApiUrl = getRepositoryUrl(urlConfig.baseURL, repository)
+		const coreApiClient = new CoreApiClient(coreApiUrl, authToken)
 		const migrationApiClient = urlConfig.migrationApi
 			? new MigrationApiClient(urlConfig.migrationApi, {
 					authToken,
 					repository,
 				})
-			: undefined;
+			: undefined
 		const assetApiClient = new AssetApiClient(urlConfig.assetApi, {
 			authToken,
 			repository,
-		});
+		})
 		const integrationFieldsClient = urlConfig.integrationFieldApi
 			? new IntegrationFieldsClient(urlConfig.integrationFieldApi, {
 					customTypesApiClient: customTypeClient,
 					wroomClient: this.wroomClient,
 					repository,
 				})
-			: undefined;
+			: undefined
 
 		return new RepositoryManager(
 			repository,
@@ -250,6 +227,6 @@ export class RepositoriesManager {
 			assetApiClient,
 			this.manageV2Client,
 			integrationFieldsClient,
-		);
+		)
 	}
 }