@griddo/cx 10.6.3 → 10.6.5

package/exporter/utils/core-utils.ts

@@ -1,4 +1,3 @@
-import type { Adapters } from "../adapters";
 import type { APIResponses } from "../types/api";
 import type { CXConfig, LifeCyclesNames } from "../types/global";
 import type { APIPageObject } from "../types/pages";
@@ -10,33 +9,18 @@ import path from "node:path";
 import chalk from "chalk";
 import dotenv from "dotenv";
 import fsx from "fs-extra";
-import gradient from "gradient-string";
 import pkgDir from "pkg-dir";
 
 import { createDirsSync, removeDirsSync } from "./folders";
+import { boxLog, verboseLog } from "./loggin";
+import { envs } from "../constants";
 
 dotenv.config();
 
 const config = getConfig();
 
-const GRIDDO_DEBUG_LOGS = isTruthy(process.env.GRIDDO_DEBUG_LOGS);
-const GRIDDO_BUILD_LOGS = isTruthy(process.env.GRIDDO_BUILD_LOGS);
-
 const instanceRootDir = pkgDir.sync()!; // instance root dir
 
-const attempts = {
-	clean: JSON.parse(process.env.GRIDDO_CLEAN_LIFECYCLE_MAX_ATTEMPTS || "1"),
-	prepare: JSON.parse(process.env.GRIDDO_PREPARE_LIFECYCLE_MAX_ATTEMPTS || "1"),
-	restore: JSON.parse(process.env.GRIDDO_RESTORE_LIFECYCLE_MAX_ATTEMPTS || "1"),
-	data: JSON.parse(process.env.GRIDDO_DATA_LIFECYCLE_MAX_ATTEMPTS || "1"),
-	ssg: JSON.parse(process.env.GRIDDO_SSG_LIFECYCLE_MAX_ATTEMPTS || "2"),
-	relocation: JSON.parse(
-		process.env.GRIDDO_RELOCATION_LIFECYCLE_MAX_ATTEMPTS || "1"
-	),
-	meta: JSON.parse(process.env.GRIDDO_META_LIFECYCLE_MAX_ATTEMPTS || "4"),
-	archive: JSON.parse(process.env.GRIDDO_ARCHIVE_LIFECYCLE_MAX_ATTEMPTS || "1"),
-};
-
 /**
  * Returns the configuration file content.
  *
@@ -67,9 +51,9 @@ async function exporterCreateInitialDirectories(domain: string) {
 	const { __exports, __caches } = config.paths(domain);
 
 	createDirsSync([__exports]);
-	verbose("create `exports/sites/<domain>` directory");
+	verboseLog("create `exports/sites/<domain>` directory");
 	createDirsSync([__caches]);
-	verbose("create `caches/<domain>` directory");
+	verboseLog("create `caches/<domain>` directory");
 }
 
 /**
@@ -81,21 +65,7 @@ async function exporterCleanDisposableDirectories(domain: string) {
 	const { __cx } = config.paths(domain);
 
 	removeDirsSync(__cx, ["store", "apiCache", "dist"]);
-	verbose("clean `store`, `apiCache` and `dist` directories from `__cx`");
-}
-
-/**
- * Custom basic logging function controlled by a environment variable.
- *
- * @param str The string to be logged.
- */
-function verbose(str: string) {
-	if (GRIDDO_DEBUG_LOGS) {
-		console.log(
-			chalk.hex("#ffff33")("verbose"),
-			chalk.gray(str.replace(/(\s)\s+/g, "$1").trim())
-		);
-	}
+	verboseLog("clean `store`, `apiCache` and `dist` directories from `__cx`");
 }
 
 /**
@@ -142,70 +112,6 @@ function walk(dir: string) {
 	return results;
 }
 
-/**
- * Custom log inside a line-box.
- *
- * @param stringValue The string to be logged.
- * @param paddingInline The number of white spaces inside the box at left and right.
- * @param paddingBlock The number of white spaces inside the box at top and bottom.
- */
-function logBox(
-	stringValue: string,
-	title = "",
-	paddingInline = 1,
-	paddingBlock = 1
-) {
-	const lines = stringValue
-		.split("\n") // lines
-		.map((line) => line.trim()); // remove extra spaces
-	const windowTitle = title ? ` ${title} ` : "";
-	const windowTitleLength = title ? windowTitle.length : 0;
-	const longerContent =
-		Math.max(...lines.map((l) => l.length)) + paddingInline * 2;
-	const longerLine = Math.max(longerContent, windowTitleLength);
-	const paddingBlockString = `│${" ".repeat(longerLine)}│\n`.repeat(
-		paddingBlock
-	);
-	const minWidth = longerLine;
-	const borderTop = `╭${windowTitle}${"─".repeat(
-		minWidth - windowTitleLength
-	)}╮\n`;
-	const borderBottom = `╰${"─".repeat(minWidth)}╯`;
-	const content = lines
-		.map((l) => {
-			const mr = " ".repeat(longerLine - l.length - paddingInline);
-			return `│${" ".repeat(paddingInline)}${l}${mr}│\n`;
-		})
-		.join("");
-
-	console.log(
-		`${borderTop}${paddingBlockString}${content}${paddingBlockString}${borderBottom}`
-	);
-}
-
-/**
- * Custom basic logging function controlled by a environment variable.
- * Strip double spaces.
- *
- * @param str The string to be logged.
- */
-function logInfo(str: string) {
-	if (GRIDDO_BUILD_LOGS) {
-		console.info(str.replace(/(\s)\s+/g, "$1").trim());
-	}
-}
-
-/**
- * Internal log
- * @param values The values to be logged.
- */
-function debug(...values: Array<unknown>) {
-	if (!GRIDDO_DEBUG_LOGS) {
-		return;
-	}
-	console.log(...values);
-}
-
 /**
  * Custom delay using the "promise hack",
  *
@@ -215,33 +121,6 @@ function delay(ms: number) {
 	return new Promise((res) => setTimeout(res, ms));
 }
 
-/**
- * Return a scale size colors with a number and a measure string (KB by default).
- *
- * @param size The page size in KB.
- * @param measure The measure string to be added in the log.
- */
-function logPageSize(size: number, measure = "KB") {
-	const sizeScale = {
-		low: 50,
-		mid: 80,
-		large: 130,
-		extraLarge: 210,
-	};
-
-	// Ternary pawa!
-	const color =
-		size > sizeScale.large
-			? "red"
-			: size > sizeScale.mid
-			? "magenta"
-			: size > sizeScale.low
-			? "blue"
-			: "green";
-
-	return chalk[color].bold(`${size}${measure}`);
-}
-
 /**
  * Converts milliseconds to seconds with a fixed number of decimals.
  *
@@ -259,9 +138,9 @@ export function msToSec(ms: number, decimals = 3) {
  */
 export function getSafeSiteId(response: APIResponses) {
 	if (typeof response === "string") {
-		return undefined
+		return undefined;
 	}
-	
+
 	return "site" in response && response.site ? response?.site : undefined;
 }
 
@@ -290,23 +169,6 @@ function siteList(sites: Array<Site>) {
 	return sites.map(({ name, id }) => `${name} (${id})`).join(", ");
 }
 
-/**
- * Print the great Griddo Exporter logo in ASCII.
- */
-function printExporterLogo(adapter: Adapters) {
-	const nodeVersion = process.version;
-	const { griddoVersion } = config;
-	const logo = `
-··
-··      Griddo Exporter ${griddoVersion}
-··      Adapter: ${adapter}
-··      Node: ${nodeVersion}
-··
-`;
-
-	console.log(gradient.cristal(logo));
-}
-
 /**
  * Remove unused files (old) inside the `apiCache` dir
  *
@@ -376,12 +238,16 @@ function sanitizeAPICacheDir() {
  * @returns A promise that resolves with the total execution time in seconds.
  */
 async function measureExecutionTime(
-	...functions: Array<(...args: Array<unknown>) => unknown | Promise<any>>
+	functions: Array<(...args: Array<unknown>) => unknown | Promise<unknown>>,
+	delayInMS = 0,
 ): Promise<number> {
 	const start = process.hrtime();
 
 	for (const func of functions) {
 		await func();
+		if (delayInMS > 0) {
+			await delay(delayInMS);
+		}
 	}
 
 	const [seconds, miliseconds] = process.hrtime(start);
@@ -392,7 +258,7 @@ async function measureExecutionTime(
 
 function pause(title: string) {
 	const isPauseEnabled = !!JSON.parse(
-		process.env.GRIDDO_RENDER_BREAKPOINTS_FEATURE || "false"
+		process.env.GRIDDO_RENDER_BREAKPOINTS_FEATURE || "false",
 	);
 
 	if (!isPauseEnabled) {
@@ -401,51 +267,63 @@ function pause(title: string) {
 
 	return new Promise<void>((resolve) => {
 		console.log("\n");
-		logBox(`⌛️ ${title}`, "", 1, 0);
+		boxLog(`⌛️ ${title}`, "", 1, 0);
 		process.stdin.once("data", () => {
 			resolve();
 		});
 	});
 }
 
-function startLifeCycle(lifeCyleName: string) {
-	console.info(`
-${chalk.blue(`info`)} start ${lifeCyleName} life-cycle`);
-}
-
-function successLifeCyle(value: string) {
-	console.info(`${chalk.green("success")} ${value}`);
-}
-
 /**
  * Executes a life cycle process, which involves executing an array of
  * functions, printing to the console, and handling errors with optional
  * retries.
  *
  * @async
- * @param args - The arguments object.
- * @param args.steps - An array of functions to execute.
- * @param args.name - The name of the life cycle.
- * @param args.attempts=1 - The number of retry attempts allowed in case of errors.
- * @param args.bypass - Skip the step functions.
+ * @param options - The arguments object.
+ * @param options.steps - An array of functions to execute.
+ * @param options.delay - Delay between steps functions.
+ * @param options.bypass - Skip the step functions.
  * @returns - A promise that resolves when the life cycle process is completed.
  */
-async function doLifeCycle(args: {
-	steps: Array<(...args: Array<unknown>) => unknown | Promise<any>>;
-	name: LifeCyclesNames;
-	attempts?: number;
-}) {
-	const { steps, name, attempts } = args;
+async function doLifeCycle(
+	name: LifeCyclesNames,
+	options: {
+		steps: Array<(...args: Array<unknown>) => unknown | Promise<any>>;
+		delay?: number;
+		bypass?: boolean;
+	},
+) {
+	const { steps, bypass, delay } = options;
+
+	if (bypass) {
+		return;
+	}
+
+	const attemptsByLifeCycleName: Record<LifeCyclesNames, number> = {
+		Archive: envs.GRIDDO_ARCHIVE_LIFECYCLE_MAX_ATTEMPTS,
+		Data: envs.GRIDDO_DATA_LIFECYCLE_MAX_ATTEMPTS,
+		Meta: envs.GRIDDO_META_LIFECYCLE_MAX_ATTEMPTS,
+		Relocation: envs.GRIDDO_RELOCATION_LIFECYCLE_MAX_ATTEMPTS,
+		Clean: envs.GRIDDO_CLEAN_LIFECYCLE_MAX_ATTEMPTS,
+		Restore: envs.GRIDDO_RESTORE_LIFECYCLE_MAX_ATTEMPTS,
+		Prepare: envs.GRIDDO_PREPARE_LIFECYCLE_MAX_ATTEMPTS,
+		Close: envs.GRIDDO_CLOSE_LIFECYCLE_MAX_ATTEMPTS,
+		SSG: envs.GRIDDO_SSG_LIFECYCLE_MAX_ATTEMPTS,
+		HealthCheck: 1,
+		__DEBUG__: 1,
+	};
 
 	let trysCount = 0;
-	const maxTrysAccepted = attempts || 1;
+	const maxTrysAccepted = attemptsByLifeCycleName[name] || 1;
 
 	while (trysCount < maxTrysAccepted) {
 		try {
 			console.info(`\n${chalk.blue(`info`)} start ${name} life-cycle`);
-			const exeTime = await measureExecutionTime(...steps);
+			const exeTime = await measureExecutionTime(steps, delay);
 			console.info(`${chalk.green("success")} ${name} - ${exeTime}s`);
 			// if no errors, go out!! :)
+			await pause(`${name} LifeCycle`);
 			break;
 		} catch (error) {
 			const errorString = chalk.bgRed.black(` Error in ${name} LifeCycle `);
@@ -459,7 +337,7 @@ async function doLifeCycle(args: {
 	}
 	if (trysCount === maxTrysAccepted) {
 		throw new Error(
-			`Exceeded maximum retry attempts (${maxTrysAccepted}) for ${name} LifeCycle`
+			`Exceeded maximum retry attempts (${maxTrysAccepted}) for ${name} LifeCycle`,
 		);
 	}
 }
@@ -484,8 +362,6 @@ function isVersionLowerThan(versionA: string, versionB: string) {
 }
 
 export {
-	attempts,
-	debug,
 	delay,
 	doLifeCycle,
 	exporterCleanDisposableDirectories,
@@ -495,17 +371,10 @@ export {
 	isTruthy,
 	isVersionGreaterThan,
 	isVersionLowerThan,
-	logBox,
-	logInfo,
-	logPageSize,
 	measureExecutionTime,
 	pause,
-	printExporterLogo,
 	removeProperties,
 	sanitizeAPICacheDir,
 	siteList,
-	startLifeCycle,
-	successLifeCyle,
-	verbose,
 	walk,
 };

package/exporter/utils/domains.ts

@@ -1,9 +1,27 @@
 import type { Domains } from "../types/global";
 
-import { verbose } from "./core-utils";
+import { verboseLog } from "./loggin";
+import { throwError } from "../errors";
+import { NoDomainsFoundError } from "../errors/errors-data";
 import { AuthService } from "../services/auth";
 import { DomainsService } from "../services/domains";
 
+/**
+ * Return an array of domains name (string) of the current instance.
+ */
+async function getInstanceDomainsOrThrow() {
+	await AuthService.login();
+	const domains = await DomainsService.getAll();
+
+	if (!domains.length) {
+		throwError(NoDomainsFoundError);
+	}
+
+	verboseLog(`getting domains names (${domains.length})`);
+
+	return getDomainSlugs(domains);
+}
+
 /**
  * Return an array of domains name (string) of the current instance.
  */
@@ -11,7 +29,7 @@ async function getInstanceDomains() {
 	await AuthService.login();
 	const domains = await DomainsService.getAll();
 
-	verbose(`Getting domains slugs (${domains.length})`);
+	verboseLog(`Getting domains slugs (${domains.length})`);
 
 	return getDomainSlugs(domains);
 }
@@ -30,4 +48,4 @@ function getDomainSlugs(domains: Domains) {
 	return [...new Set(filteredDomains)];
 }
 
-export { getInstanceDomains };
+export { getInstanceDomains, getInstanceDomainsOrThrow };

package/exporter/utils/folders.ts

@@ -90,7 +90,7 @@ function copyDirsSync(
 	dirs: Array<string>,
 	options = {
 		withBackup: false,
-	}
+	},
 ) {
 	const { withBackup } = options;
 	for (const dir of dirs) {
@@ -144,7 +144,7 @@ function moveDirsSync(
 	src: string,
 	dst: string,
 	dirs: Array<string>,
-	options?: { withBackup?: boolean; override?: boolean }
+	options?: { withBackup?: boolean; override?: boolean },
 ) {
 	const { override, withBackup } = options || {};
 
@@ -255,7 +255,7 @@ async function removeVirtualPagesFromStore() {
 		removePagesFromStore(multiPageFiles);
 	} catch (e) {
 		console.info(
-			"`store` folder does not exist. Skipping multipage or static list template cleaning."
+			"`store` folder does not exist. Skipping multipage or static list template cleaning.",
 		);
 	}
 }

package/exporter/utils/health-checks.ts

@@ -1,4 +1,4 @@
-import { logBox } from "./core-utils";
+import { boxLog } from "./loggin";
 
 const GRIDDO_SKIP_BUILD_CHECKS = process.env.GRIDDO_SKIP_BUILD_CHECKS;
 const GRIDDO_ENVS_VARS: ReadonlyArray<string> = [];
@@ -30,9 +30,9 @@ function checkRenderHealthOrExit() {
 	}
 
 	// Error
-	logBox(
+	boxLog(
 		`Error. The environment is not suitable for a build.`,
-		"Not valid environment"
+		"Not valid environment",
 	);
 	process.exit(1);
 }
@@ -52,7 +52,7 @@ function checkEnvsVars(envs: ReadonlyArray<string>) {
 	if (missingEnvs.length) {
 		const missingEnvsMsg = missingEnvs.join("\n");
 		console.error(
-			`Env check failed. These envs vars are missing: \n\n${missingEnvsMsg}`
+			`Env check failed. These envs vars are missing: \n\n${missingEnvsMsg}`,
 		);
 
 		return false;

package/exporter/utils/instance.ts

@@ -18,8 +18,8 @@ function resolveComponentsPath(customPath = "") {
 		: path.resolve(
 				pkgDir.sync(__dirname) as string,
 				"../griddo-components",
-				customPath
-		  );
+				customPath,
+			);
 }
 
 /**
@@ -65,7 +65,7 @@ function getComponentsLibAliases() {
 			// Por este motivo se puede hacer `... import from "@griddo-instance" en
 			// los packages del monorepo.
 			"@griddo-instance": `${resolveComponentsPath()}/src/index.js`,
-		}
+		},
 	);
 }
 

package/exporter/utils/integrations.ts

@@ -10,7 +10,7 @@ function isObject(value: unknown) {
 
 function filterBodyIntegrationFromPosition(
 	integrations: Array<Core.PageIntegration>,
-	position: "start" | "end"
+	position: "start" | "end",
 ) {
 	return (
 		integrations
@@ -18,7 +18,7 @@ function filterBodyIntegrationFromPosition(
 				(integration) =>
 					integration.contentBody !== null &&
 					integration.contentBody !== "" &&
-					integration.contentBodyPosition === position
+					integration.contentBodyPosition === position,
 			)
 			.map((integration) => {
 				return { content: integration.contentBody!, type: integration.type };
@@ -32,11 +32,11 @@ function filterHeadIntegrations(integrations: Array<Core.PageIntegration>) {
 	return integrations
 		?.filter(
 			(integration) =>
-				(integration.type==='addon' && integration.contentHead !== null && integration.contentHead !== "")
-				||
-				(integration.type === 'analytics')
-				||
-				(integration.type === 'datalayer')
+				(integration.type === "addon" &&
+					integration.contentHead !== null &&
+					integration.contentHead !== "") ||
+				integration.type === "analytics" ||
+				integration.type === "datalayer",
 		)
 		.map((integration) => {
 			return {
@@ -48,7 +48,7 @@ function filterHeadIntegrations(integrations: Array<Core.PageIntegration>) {
 
 export const filterPositionIntegrations = (
 	integrations: Array<Core.PageIntegration>,
-	position: "head" | "start" | "end"
+	position: "head" | "start" | "end",
 ) => {
 	switch (position) {
 		case "head":
@@ -70,7 +70,7 @@ export function composeAnalytics(
 		};
 	},
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	generateAutomaticDimensions = (page: Record<string, unknown>) => null
+	generateAutomaticDimensions = (page: Record<string, unknown>) => null,
 ) {
 	const analyticsScript = siteScriptRaw ? siteScriptRaw.trim() : "";
 
@@ -96,10 +96,10 @@ export function composeAnalytics(
 				dimensionValue?.startsWith(dynamicValuePrefix)
 					? `${dimensionValue.slice(
 							dynamicValuePrefix.length,
-							dimensionValue.endsWith(";") ? -1 : dimensionValue.length
-					  )}`
+							dimensionValue.endsWith(";") ? -1 : dimensionValue.length,
+						)}`
 					: `"${dimensionValue}"`
-			}`
+			}`,
 		);
 	}
 

package/exporter/utils/loggin.ts

@@ -0,0 +1,159 @@
+import type { Adapters } from "../adapters";
+
+import kleur from "kleur";
+import { version as reactVersion } from "react";
+
+import { getConfig } from "./core-utils";
+import { envs } from "../constants";
+
+/**
+ * Custom basic logging function controlled by a environment variable.
+ *
+ * @param str The string to be logged.
+ */
+function verboseLog(str: string) {
+	if (envs.GRIDDO_VERBOSE_LOGS) {
+		console.log(
+			kleur.yellow("verbose"),
+			kleur.dim(str.replace(/(\s)\s+/g, "$1").trim()),
+		);
+	}
+}
+
+/**
+ * Custom log inside a line-box.
+ *
+ * @param stringValue The string to be logged.
+ * @param paddingInline The number of white spaces inside the box at left and right.
+ * @param paddingBlock The number of white spaces inside the box at top and bottom.
+ */
+function boxLog(
+	stringValue: string,
+	title = "",
+	paddingInline = 1,
+	paddingBlock = 1,
+) {
+	const lines = stringValue
+		.split("\n") // lines
+		.map((line) => line.trim()); // remove extra spaces
+	const windowTitle = title ? ` ${title} ` : "";
+	const windowTitleLength = title ? windowTitle.length : 0;
+	const longerContent =
+		Math.max(...lines.map((l) => l.length)) + paddingInline * 2;
+	const longerLine = Math.max(longerContent, windowTitleLength);
+	const paddingBlockString = `│${" ".repeat(longerLine)}│\n`.repeat(
+		paddingBlock,
+	);
+	const minWidth = longerLine;
+	const borderTop = `╭${windowTitle}${"─".repeat(
+		minWidth - windowTitleLength,
+	)}╮\n`;
+	const borderBottom = `╰${"─".repeat(minWidth)}╯`;
+	const content = lines
+		.map((l) => {
+			const mr = " ".repeat(longerLine - l.length - paddingInline);
+			return `│${" ".repeat(paddingInline)}${l}${mr}│\n`;
+		})
+		.join("");
+
+	console.log(
+		`${borderTop}${paddingBlockString}${content}${paddingBlockString}${borderBottom}`,
+	);
+}
+
+/**
+ * Custom basic logging function controlled by a environment variable.
+ * Strip double spaces.
+ *
+ * @param str The string to be logged.
+ */
+function buildLog(str: string) {
+	if (envs.GRIDDO_BUILD_LOGS) {
+		console.info(str.replace(/(\s)\s+/g, "$1").trim());
+	}
+}
+
+/**
+ * Console log with a blue color in the info prefix.
+ * @param str The string to be logged.
+ */
+function infoLog(str: string) {
+	console.info(`${kleur.blue("info")} ${str}`);
+}
+
+/**
+ * Console log with a green color in the success prefix.
+ * @param str The string to be logged.
+ */
+function successLog(str: string) {
+	console.info(`${kleur.green("success")} ${str}`);
+}
+
+/**
+ * Internal log
+ * @param values The values to be logged.
+ */
+function debugLog(...values: Array<unknown>) {
+	if (!envs.GRIDDO_DEBUG_LOGS) {
+		return;
+	}
+	console.log(...values);
+}
+
+/**
+ * Return a scale size colors with a number and a measure string (KB by default).
+ *
+ * @param size The page size in KB.
+ * @param measure The measure string to be added in the log.
+ */
+function pageSizeLog(size: number, measure = "KB") {
+	const sizeScale = {
+		low: 50,
+		mid: 80,
+		large: 130,
+		extraLarge: 210,
+	};
+
+	// Ternary pawa!
+	const color =
+		size > sizeScale.large
+			? "red"
+			: size > sizeScale.mid
+				? "magenta"
+				: size > sizeScale.low
+					? "blue"
+					: "green";
+
+	return kleur[color](kleur.bold(`${size}${measure}`));
+}
+
+/**
+ * Print Griddo, adapter and Node version.
+ */
+function printExporterLogo(adapter: Adapters) {
+	const config = getConfig();
+	const nodeVersion = process.version;
+	const { griddoVersion } = config;
+	const logo = `
+··
+··      Griddo ${griddoVersion}
+··
+··      Adapter: ${adapter}
+··      Node: ${nodeVersion}
+··      React: ${reactVersion}
+··
+`;
+
+	console.log(logo);
+}
+
+export {
+	boxLog,
+	buildLog,
+	debugLog,
+	infoLog,
+	pageSizeLog,
+	printExporterLogo,
+	successLog,
+	verboseLog,
+};