@prismicio/e2e-tests-utils 1.2.0 → 1.3.0

package/src/clients/manageV2.ts

@@ -0,0 +1,178 @@
+import axios, { AxiosInstance, AxiosResponse } from "axios";
+import jwt from "jsonwebtoken";
+
+import { ManageV2Config } from "../types";
+
+import { extractCookie } from "../utils/cookies";
+
+const ManageV2StaticAuthor = "prismic-e2e-tests-utils";
+
+/**
+ * Client for interacting with ManageV2 routes to perform operations on
+ * repositories.
+ */
+export class ManageV2Client {
+	readonly client: AxiosInstance; // Not private to have it available on tests
+	private token: string | null = null;
+
+	/**
+	 * @param baseURL - The base URL of the Wroom app. ex: https://prismic.io
+	 * @param config - ManageV2 configuration variable to call ManageV2.
+	 */
+	constructor(baseUrl: string, config?: ManageV2Config | undefined) {
+		this.token = config ? this.generateToken(config) : null;
+
+		this.client = axios.create({
+			baseURL: `${baseUrl}/manageroutes/`,
+			withCredentials: true,
+			validateStatus: () => true,
+			headers: {
+				"User-Agent": "prismic-cli/prismic-e2e-tests-utils",
+				Authorization: `Bearer ${this.token}`,
+			},
+		});
+
+		// cookies are not forwarded automatically in a non-browser env
+		this.client.interceptors.response.use((response) => {
+			const cookies = response.headers["set-cookie"];
+			if (cookies && extractCookie(cookies, "SESSION")) {
+				this.client.defaults.headers["Cookie"] = cookies;
+			}
+
+			return response;
+		});
+	}
+
+	/**
+	 * The function generates a JWT token using the provided configuration
+	 * parameters.
+	 *
+	 * @param {ManageV2Config} config - The `config` parameter in the
+	 *   `generateToken` function is of type `ManageV2Config`. It contains the
+	 *   following properties:
+	 *
+	 * @returns A JSON Web Token (JWT) is being returned by the `generateToken`
+	 *   function. The token is signed using the provided `config.secret` with the
+	 *   HS256 algorithm and includes the specified audience and issuer values.
+	 */
+	private generateToken(config: ManageV2Config): string {
+		return jwt.sign({}, config.secret, {
+			algorithm: "HS256",
+			audience: config.audience,
+			issuer: "prismic.io",
+		});
+	}
+
+	/**
+	 * The function `assertTokenExist` checks if a token exists before executing a
+	 * given function.
+	 *
+	 * @param f - The `assertTokenExist` function takes a function `f` as a
+	 *   parameter. This function `f` should accept a parameter of type
+	 *   `Parameters` and return a Promise that resolves to an AxiosResponse. The
+	 *   `assertTokenExist` function ensures that a token is not null before
+	 *   calling the provided
+	 *
+	 * @returns A function is being returned that takes a parameter of type
+	 *   Parameters and checks if the token is null. If the token is null, an
+	 *   error is thrown. Otherwise, the function f is called with the provided
+	 *   parameters.
+	 */
+	private assertTokenExist<Parameters>(
+		f: (_: Parameters) => Promise<AxiosResponse>,
+	) {
+		return (params: Parameters) => {
+			if (this.token === null) {
+				throw new Error(
+					"Undefined configuration for ManageV2 while trying to use it's routes",
+				);
+			} else {
+				return f(params);
+			}
+		};
+	}
+
+	getBaseURL(): string {
+		return this.client.getUri();
+	}
+
+	/**
+	 * The function `toggleRolePerLocal` enable or disable the role per local
+	 * feature
+	 *
+	 * @param repository - The Repository name
+	 * @param enabled - The feature new status
+	 */
+	toggleRolePerLocal = this.assertTokenExist(
+		(params: { repository: string; enabled: boolean }) => {
+			return this.client.post("/repository/toggleRolesPerLocale", {
+				domain: params.repository,
+				enabled: params.enabled,
+				author: ManageV2StaticAuthor,
+			});
+		},
+	);
+
+	/**
+	 * The function `changePlan` changes the plan of a repository the database
+	 *
+	 * @param repository - The Repository name
+	 * @param newPlanId - The new planId
+	 * @param bypassManualBilling - Beware that using this will not verify that
+	 *   the database and Stripe are in sync
+	 */
+	changePlan = this.assertTokenExist(
+		({
+			repository,
+			newPlanId,
+			bypassManualBilling = false,
+		}: {
+			repository: string;
+			newPlanId: string;
+			bypassManualBilling?: boolean;
+		}) => {
+			return this.client.post(
+				`/repository/changePlan?bypassManualBilling=${bypassManualBilling}`,
+				{
+					domain: repository,
+					newPlan: newPlanId,
+					author: ManageV2StaticAuthor,
+				},
+			);
+		},
+	);
+
+	/**
+	 * The function `addUserToRepository` adds a user corresponding to the email
+	 * to the given repository
+	 *
+	 * @param repository - The Repository name
+	 * @param email - The user email
+	 */
+	addUserToRepository = this.assertTokenExist(
+		({ repository, email }: { repository: string; email: string }) => {
+			return this.client.post("/repository/addUser", {
+				domain: repository,
+				email: email,
+				author: ManageV2StaticAuthor,
+			});
+		},
+	);
+
+	/**
+	 * The function `removeUserFromRepository` removes a user corresponding to the
+	 * email from the given repository
+	 *
+	 * @param repository - The Repository name
+	 * @param email - The user email
+	 */
+	removeUserFromRepository = this.assertTokenExist(
+		({ repository, email }: { repository: string; email: string }) => {
+			return this.client.post("/repository/removeUser", {
+				domain: repository,
+				email: email,
+				author: ManageV2StaticAuthor,
+			});
+		},
+	);
+}

package/src/clients/wroom.ts

@@ -1,6 +1,6 @@
 import axios, { AxiosInstance, AxiosResponse } from "axios";
 
-import { Credentials } from "../types";
+import { AuthConfig } from "../types";
 
 import { extractCookie } from "../utils/cookies";
 import { logHttpResponse, logger } from "../utils/log";
@@ -20,7 +20,7 @@ export class WroomClient {
 	 */
 	constructor(
 		baseURL: string,
-		private readonly auth: Credentials,
+		private readonly auth: AuthConfig,
 	) {
 		this.client = axios.create({
 			baseURL,
@@ -84,6 +84,46 @@ export class WroomClient {
 		return response;
 	}
 
+	/**
+	 * Update the role of a user in the repository
+	 *
+	 * @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()}`;
+
+		return this.post(repository, path);
+	}
+
+	/**
+	 * Update the role of a user in the repository
+	 *
+	 * @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(
+		repository: string,
+		email: string,
+		rolePerLocal: Record<string, string>,
+	): Promise<AxiosResponse> {
+		const params = new URLSearchParams({ email });
+		const path = `/app/settings/users/rolesperlocale?${params.toString()}`;
+
+		return this.post(repository, path, rolePerLocal);
+	}
+
 	/**
 	 * Authenticate Wroom to call Wroom unofficial endpoints.
 	 *

package/src/managers/repositories.ts

@@ -1,4 +1,4 @@
-import { Credentials } from "../types";
+import { SetupConfiguration, UrlConfig } from "../types";
 
 import {
 	AuthenticationClient,
@@ -6,6 +6,7 @@ import {
 } from "../clients/authenticationApi";
 import { createCoreApiClient } from "../clients/coreApi";
 import { createCustomTypesApiClient } from "../clients/customTypesApi";
+import { ManageV2Client } from "../clients/manageV2";
 import { WroomClient } from "../clients/wroom";
 import { EnvVariableManager } from "../utils/envVariableManager";
 import { logHttpResponse, logger } from "../utils/log";
@@ -18,30 +19,29 @@ import { RepositoryConfig, RepositoryManager } from "./repository";
  * Factory method to create a RepositoriesManager to manage repositories test
  * data.
  *
- * @param urlConfig - If provided as an object:
+ * @param configuration - Global object containing the different configurations
+ *   required to setup the RepositoriesManager.
  *
- *       - {@link UrlConfig.baseURL}: The Prismic base URL.
- *       - {@link UrlConfig.customTypesApi}: The base URL for the Custom Types API.
- *       - {@link UrlConfig.authenticationApi}: The base URL for the Authentication API.
- *
- *   If provided as a string: It is treated as the base URL for Prismic. Other
- *   URLs (Custom Types API, Auth API) will be derived from it.
- * @param auth - The authentication credentials
+ *       - {@link configuration.urlConfig}: Configuration around the API's URLs management.
+ *       - {@link configuration.authConfig}: Configuration around the authentication of a user.
+ *       - {@link configuration.manageV2Config}: Optional Configuration used to make calls to ManageV2.
  *
  * @returns An instance of {@link RepositoriesManager} to manage test data.
  */
 export const createRepositoriesManager = (
-	urlConfig: UrlConfig | string,
-	auth: Credentials,
+	configuration: SetupConfiguration,
 ): RepositoriesManager => {
-	return new RepositoriesManager(urlConfig, auth);
+	return new RepositoriesManager(configuration);
 };
 
 /** Utility object to manage Prismic test data */
 export class RepositoriesManager {
-	private readonly urls: UrlConfig;
+	private readonly config: Omit<SetupConfiguration, "urlConfig"> & {
+		urlConfig: UrlConfig;
+	};
 	private readonly wroomClient: WroomClient;
 	private readonly authClient: AuthenticationClient;
+	private readonly manageV2Client: ManageV2Client;
 	/**
 	 * helper to keep track of repositories across independent test phases (setup,
 	 * teardown)
@@ -51,22 +51,31 @@ export class RepositoriesManager {
 	);
 
 	/**
-	 * @param urlConfig - The base URL of the Wroom app.
+	 * @param configuration - Global object containing the different configuration
+	 *   required to setup the different clients.
 	 * @param credentials - Authentication credentials (email and password)
 	 */
-	constructor(
-		urlConfig: UrlConfig | string,
-		private readonly credentials: Credentials,
-	) {
-		if (typeof urlConfig === "string") {
+	constructor(configuration: SetupConfiguration) {
+		this.config = {
+			...configuration,
 			// When a string is provided, treat it as the 'base' property
-			urlConfig = this.inferUrls(urlConfig);
-		}
-		this.urls = urlConfig;
-		this.wroomClient = new WroomClient(this.urls.baseURL, this.credentials);
+			urlConfig:
+				typeof configuration.urlConfig === "string"
+					? this.inferUrls(configuration.urlConfig)
+					: configuration.urlConfig,
+		};
+
+		this.wroomClient = new WroomClient(
+			this.config.urlConfig.baseURL,
+			this.config.authConfig,
+		);
 		this.authClient = createAuthenticationApiClient(
-			this.urls.authenticationApi,
-			this.credentials,
+			this.config.urlConfig.authenticationApi,
+			this.config.authConfig,
+		);
+		this.manageV2Client = new ManageV2Client(
+			this.config.urlConfig.baseURL,
+			this.config.manageV2Config,
 		);
 	}
 
@@ -149,7 +158,7 @@ export class RepositoriesManager {
 		const post = async () =>
 			this.wroomClient.post(repository, "app/settings/delete", {
 				confirm: repository,
-				password: this.credentials.password,
+				password: this.config.authConfig.password,
 			});
 		const response = await post();
 		if (response.status !== 200) {
@@ -183,27 +192,20 @@ export class RepositoriesManager {
 	 */
 	getRepositoryManager(name: string): RepositoryManager {
 		const customTypeClient = createCustomTypesApiClient(
-			this.urls.customTypesApi,
+			this.config.urlConfig.customTypesApi,
 			name,
 			this.authClient,
 		);
-		const coreApiUrl = getRepositoryUrl(this.urls.baseURL, name);
+		const coreApiUrl = getRepositoryUrl(this.config.urlConfig.baseURL, name);
 		const coreApiClient = createCoreApiClient(coreApiUrl, this.authClient);
 
 		return new RepositoryManager(
 			name,
 			coreApiClient,
+			this.authClient,
 			this.wroomClient,
 			customTypeClient,
+			this.manageV2Client,
 		);
 	}
 }
-
-export type UrlConfig = {
-	/** Prismic base url */
-	baseURL: string;
-	/** Custom types api base url */
-	customTypesApi: string;
-	/** Auth service api base url */
-	authenticationApi: string;
-};