@prismicio/e2e-tests-utils 1.18.0 → 1.19.0-pr.37.6283e4a

package/src/clients/assetApi.ts

@@ -1,163 +1,156 @@
-import { logPlaywrightApiResponse } from "../utils/log";
-
-import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
+import { logPlaywrightApiResponse } from "../utils/log"
+import type { AuthServerToken } from "./apiClient"
+import { AuthenticatedApiClient } from "./apiClient"
 
 export interface AssetApiCreatePayload {
-	name: string;
-	mimeType: string;
-	buffer: Buffer;
+	name: string
+	mimeType: string
+	buffer: Buffer
 }
 
-export type AssetApiCreateResponse = AssetApiResponse;
+export type AssetApiCreateResponse = AssetApiResponse
 export interface AssetApiResponse {
-	id: string;
-	url: string;
-	filename: string;
-	size: number;
-	width: number;
-	height: number;
-	last_modified: number;
-	kind: string;
-	extension: string;
-	created_at: number;
-	uploader_id: string;
-	tags: string[];
+	id: string
+	url: string
+	filename: string
+	size: number
+	width: number
+	height: number
+	last_modified: number
+	kind: string
+	extension: string
+	created_at: number
+	uploader_id: string
+	tags: string[]
 	ai_metadata?: {
-		is_logo?: boolean;
-		logo_company_industry?: string;
-		logo_company_name?: string;
-		description?: string;
-		keywords?: string[];
-	};
+		is_logo?: boolean
+		logo_company_industry?: string
+		logo_company_name?: string
+		description?: string
+		keywords?: string[]
+	}
 }
 
 type AssetApiSearchParams = {
-	ids?: string[];
-	keyword?: string;
-	limit?: number;
-	assetType?: string;
-	cursor?: string;
-};
+	ids?: string[]
+	keyword?: string
+	limit?: number
+	assetType?: string
+	cursor?: string
+}
 
 interface AssetApiSearchResponse {
-	items: AssetApiResponse[];
-	total: number;
-	cursor: string;
-	is_opensearch_result: boolean;
+	items: AssetApiResponse[]
+	total: number
+	cursor: string
+	is_opensearch_result: boolean
 }
 
 interface PatchAssetArgs {
-	assetId: string;
-	filename?: string;
-	notes?: string;
-	credits?: string;
-	alt?: string;
-	tags?: string[];
+	assetId: string
+	filename?: string
+	notes?: string
+	credits?: string
+	alt?: string
+	tags?: string[]
 	ai_metadata?: {
-		description?: string;
-		keywords?: string[];
-	};
+		description?: string
+		keywords?: string[]
+	}
 }
 
 export class AssetApiClient extends AuthenticatedApiClient {
 	/**
-	 * @example To instantiate the class:
+	 * @example
+	 * 	To instantiate the class:
 	 *
-	 * ```js
-	 * new AssetApiClient("https://asset-api.prismic.io", {
+	 * 	```js
+	 * 	new AssetApiClient("https://asset-api.prismic.io", {
 	 * 	authToken: "my-secret-token",
 	 * 	repository: "my-repo-name",
-	 * });
-	 * ```
+	 * 	});
+	 * 	```
 	 *
 	 * @param baseURL - The API base URL, such as https://asset-api.prismic.io
 	 * @param config - Optional configuration
 	 *
-	 *   - {@link config.authToken}: API token generated from the auth service or a
-	 *       function to fetch it when it's needed.
+	 *   - {@link config.authToken}: API token generated from the auth service or a function to fetch it
+	 *     when it's needed.
 	 *   - {@link config.repository}: Repository name.
 	 */
-	constructor(
-		baseURL: string,
-		config: { authToken: AuthServerToken; repository: string },
-	) {
-		super(baseURL, config.authToken, { repository: config.repository });
+	constructor(baseURL: string, config: { authToken: AuthServerToken; repository: string }) {
+		super(baseURL, config.authToken, { repository: config.repository })
 	}
 
 	/**
 	 * Uploads an asset file to the server.
 	 *
 	 * @param data - The payload containing the file and filename.
-	 *
 	 * @returns The API response containing asset information.
-	 *
 	 * @throws An error if the upload fails.
 	 */
 	async createAsset(data: AssetApiCreatePayload): Promise<AssetApiResponse> {
-		const context = await this.getContext();
+		const context = await this.getContext()
 
 		const result = await context.post("assets", {
 			multipart: { file: data },
-		});
+		})
 
 		if (200 !== result.status()) {
-			await logPlaywrightApiResponse(result);
-			throw new Error("Could not upload the asset with the asset API.");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not upload the asset with the asset API.")
 		}
 
-		return result.json();
+		return result.json()
 	}
 
 	/**
 	 * Patch an existing asset.
 	 *
 	 * @param args - Asset id + the payload
-	 *
 	 * @returns The API response containing asset information.
-	 *
 	 * @throws An error if the upload fails.
 	 */
 	async patchAsset(args: PatchAssetArgs): Promise<AssetApiResponse> {
-		const context = await this.getContext();
-		const { assetId, ...data } = args;
-		const result = await context.patch(`assets/${assetId}`, { data });
+		const context = await this.getContext()
+		const { assetId, ...data } = args
+		const result = await context.patch(`assets/${assetId}`, { data })
 
 		if (200 !== result.status()) {
-			await logPlaywrightApiResponse(result);
-			throw new Error("Could not search the asset API.");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not search the asset API.")
 		}
 
-		return result.json();
+		return result.json()
 	}
 
 	/**
 	 * Searches for assets.
 	 *
 	 * @param params - Optional parameters to refine search results.
-	 *
 	 * @returns The API response containing assets.
 	 */
 	async search(params?: AssetApiSearchParams): Promise<AssetApiSearchResponse> {
-		const context = await this.getContext();
-		const { ids, ...rest } = params ?? {};
-		const query = new URLSearchParams();
+		const context = await this.getContext()
+		const { ids, ...rest } = params ?? {}
+		const query = new URLSearchParams()
 		for (const [key, value] of Object.entries(rest)) {
 			if (value !== undefined) {
-				query.set(key, String(value));
+				query.set(key, String(value))
 			}
 		}
 		for (const id of ids ?? []) {
-			query.append("ids", id);
+			query.append("ids", id)
 		}
-		const url = query.size ? `assets?${query}` : "assets";
+		const url = query.size ? `assets?${query}` : "assets"
 
-		const result = await context.get(url);
+		const result = await context.get(url)
 
 		if (200 !== result.status()) {
-			await logPlaywrightApiResponse(result);
-			throw new Error("Could not search the asset API.");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not search the asset API.")
 		}
 
-		return result.json();
+		return result.json()
 	}
 }

package/src/clients/authenticationApi.ts

@@ -1,84 +1,111 @@
-import { APIRequestContext, request } from "@playwright/test";
+import type { APIRequestContext } from "@playwright/test"
+import { request } from "@playwright/test"
 
-import { AuthConfig } from "../types";
+import type { AuthConfig } from "../types"
+import { logPlaywrightApiResponse, logger } from "../utils/log"
 
-import { logPlaywrightApiResponse, logger } from "../utils/log";
+const AUTH_API_TOKENS_ENV = "PRISMIC_E2E_TEST_UTILS_AUTH_API_TOKENS"
+
+function getAuthApiTokenFromEnv(email: string): string | undefined {
+	const value = process.env[AUTH_API_TOKENS_ENV]
+	if (!value) {
+		return undefined
+	}
+
+	for (const entry of value.split(",")) {
+		const separatorIndex = entry.indexOf(":")
+		if (separatorIndex === -1) {
+			continue
+		}
+
+		const entryEmail = entry.slice(0, separatorIndex).trim()
+		const token = entry.slice(separatorIndex + 1).trim()
+		if (entryEmail === email && token) {
+			return token
+		}
+	}
+
+	return undefined
+}
 
 /** Client for interacting with the authentication service to manage tokens */
 export class AuthenticationApiClient {
-	private authToken?: string;
-	private _context?: APIRequestContext;
+	private authToken?: string
+	private _context?: APIRequestContext
 
 	constructor(
 		private readonly baseURL: string,
 		private readonly auth: AuthConfig,
-	) {}
+	) {
+		this.authToken = getAuthApiTokenFromEnv(auth.email)
+		if (this.authToken) {
+			logger.info(`using user token for ${auth.email} from ${AUTH_API_TOKENS_ENV}`)
+		}
+	}
 
 	private async getContext(): Promise<APIRequestContext> {
 		if (!this._context) {
 			this._context = await request.newContext({
 				baseURL: this.baseURL,
-			});
+			})
 		}
 
-		return this._context;
+		return this._context
 	}
 
 	private async login(): Promise<string> {
-		const profiler = logger.startTimer();
+		const profiler = logger.startTimer()
 
-		const context = await this.getContext();
+		const context = await this.getContext()
 		const result = await context.post("login", {
 			data: {
 				email: this.auth.email,
 				password: this.auth.password,
 			},
-		});
+		})
 
-		const token = await result.text();
+		const token = await result.text()
 		if (!result.ok() || !token) {
-			logPlaywrightApiResponse(result);
-			throw new Error("Authentication failed, no token received.");
+			logPlaywrightApiResponse(result)
+			throw new Error("Authentication failed, no token received.")
 		}
 
 		profiler.done({
 			message: `generated user token for ${this.auth.email} from auth service`,
-		});
+		})
 
-		return token;
+		return token
 	}
 
 	/** Return an api user token. Creates one if needed. */
 	async getToken(): Promise<string> {
 		if (!this.authToken) {
-			this.authToken = await this.login();
+			this.authToken = await this.login()
 		}
 
-		return this.authToken;
+		return this.authToken
 	}
 
 	/** Return an api user token. Creates one if needed. */
 	async getMachine2MachineToken(repository: string): Promise<string> {
 		if (!this.authToken) {
-			this.authToken = await this.login();
+			this.authToken = await this.login()
 		}
 
-		const context = await this.getContext();
+		const context = await this.getContext()
 		const result = await context.get("machine2machine", {
 			headers: {
 				Authorization: `Bearer ${this.authToken}`,
 				repository,
 			},
-		});
+		})
 
 		if (!result.ok()) {
-			logPlaywrightApiResponse(result);
-			throw new Error(
-				"Machine2Machine token generation failed, no token received.",
-			);
+			logPlaywrightApiResponse(result)
+			throw new Error("Machine2Machine token generation failed, no token received.")
 		}
-		const token = (await result.json()).token;
+		const token = (await result.json()).token
 
-		return token;
+		return token
 	}
 }