@griddo/cx 10.6.4 → 10.6.6

package/exporter/utils/folders.ts

@@ -4,6 +4,7 @@ import path from "node:path";
 import fsx, { MakeDirectoryOptions } from "fs-extra";
 
 import { getConfig } from "./core-utils";
+import { verboseLog } from "./loggin";
 import { getPageInStoreDir, removePagesFromStore } from "./store";
 
 const config = getConfig();
@@ -90,7 +91,7 @@ function copyDirsSync(
 	dirs: Array<string>,
 	options = {
 		withBackup: false,
-	}
+	},
 ) {
 	const { withBackup } = options;
 	for (const dir of dirs) {
@@ -132,53 +133,6 @@ function copyDirsSync(
 	}
 }
 
-/**
- * Move artifacts between CX valid directories.
- *
- * @param src - Source directory.
- * @param dst - Destination directory.
- * @param dirs - Directories to move.
- * @param options - Options.
- */
-function moveDirsSync(
-	src: string,
-	dst: string,
-	dirs: Array<string>,
-	options?: { withBackup?: boolean; override?: boolean }
-) {
-	const { override, withBackup } = options || {};
-
-	for (const dir of dirs) {
-		const srcCompose = path.join(src, dir);
-		const dstCompose = path.join(dst, dir);
-
-		if (!fsx.existsSync(srcCompose)) {
-			continue;
-		}
-
-		if (withBackup) {
-			createBackup(dstCompose);
-		}
-
-		try {
-			// Clean destination
-			if (override && fsx.existsSync(dstCompose)) {
-				fs.rmSync(dstCompose, { recursive: true, force: true });
-			}
-			fs.renameSync(srcCompose, dstCompose);
-			if (withBackup) {
-				deleteBackup(dstCompose);
-			}
-		} catch (e) {
-			console.log("Move failed!");
-			if (withBackup) {
-				restoreBackup(dstCompose);
-				console.log("Backup has been restored.");
-			}
-		}
-	}
-}
-
 /**
  * Remove directories from `basePath` directory.
  *
@@ -255,7 +209,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.",
 		);
 	}
 }
@@ -293,12 +247,171 @@ function clearSitemapsFromDirs(initialFolder: string) {
 	removeXmlFiles(initialFolder);
 }
 
+/**
+ * Removes multiple artifact directories.
+ *
+ * @param artifacts - An array of artifact directory paths.
+ */
+function removeArtifacts(artifacts: Array<string>) {
+	for (const dir of artifacts) {
+		if (!dir) {
+			continue;
+		}
+
+		if (fsx.existsSync(dir)) {
+			fs.rmSync(dir, { recursive: true, force: true });
+			verboseLog(`removed directory: ${dir}`);
+		}
+	}
+}
+
+/**
+ * Creates multiple directories.
+ *
+ * @param dirs - An array of directory paths.
+ * @param options - Same option as `fs.mkdirSync()`
+ */
+function createArtifacts(dirs: Array<string>, options?: MakeDirectoryOptions) {
+	for (const dir of dirs) {
+		if (!fs.existsSync(dir)) {
+			fs.mkdirSync(dir, { recursive: true, ...options });
+			verboseLog(`create directory: ${dir}`);
+		}
+	}
+}
+
+/**
+ * Copy multiple directories with backup option.
+ *
+ * @param src - Source directory.
+ * @param dst - Destination directory.
+ * @param dirs - Directories to copy.
+ * @param options.withBackup - Create a previous backup before copy.
+ */
+function copyArtifacts(
+	src: string,
+	dst: string,
+	dirs: Array<string>,
+	options = {
+		withBackup: false,
+	},
+) {
+	const { withBackup } = options;
+	for (const dir of dirs) {
+		const srcCompose = path.join(src, dir);
+		const dstCompose = path.join(dst, dir);
+
+		// The dir we want to copy, doesn't exist.
+		if (!fsx.existsSync(srcCompose)) {
+			console.log(
+				`(Maybe first render) Source directory does not exist: ${srcCompose}`,
+			);
+			continue;
+		}
+
+		// Create the backup
+		if (withBackup) {
+			createBackup(dstCompose);
+			verboseLog(`create backup: ${dstCompose}`);
+		}
+
+		// Copy directory
+		try {
+			// First clean destination
+			if (fsx.existsSync(dstCompose)) {
+				fs.rmSync(dstCompose, { recursive: true, force: true });
+				verboseLog(`clean destination: ${dstCompose}`);
+			}
+
+			// Then copy src to dst
+			fs.cpSync(srcCompose, dstCompose, {
+				recursive: true,
+				preserveTimestamps: true,
+			});
+			verboseLog(`copy: ${srcCompose} to ${dstCompose}`);
+
+			if (withBackup) {
+				deleteBackup(dstCompose);
+				verboseLog(`delete backup: ${dstCompose}`);
+			}
+		} catch (e) {
+			console.log("copy failed!");
+			if (withBackup) {
+				restoreBackup(dstCompose);
+				console.log("Backup has been restored.");
+			}
+		}
+	}
+}
+
+function renameArtifact(src: string, dst: string) {
+	if (fs.existsSync(src)) {
+		fs.renameSync(src, dst);
+		verboseLog(`rename ${src} to ${dst}`);
+	}
+}
+
+/**
+ * Move artifacts between cx-paths
+ *
+ * @param src - Source directory.
+ * @param dst - Destination directory.
+ * @param dirs - Directories to move.
+ * @param options - Options.
+ */
+function moveArtifacts(
+	src: string,
+	dst: string,
+	dirs: Array<string>,
+	options?: { withBackup?: boolean; override?: boolean },
+) {
+	const { override, withBackup } = options || {};
+
+	for (const dir of dirs) {
+		const srcCompose = path.join(src, dir);
+		const dstCompose = path.join(dst, dir);
+
+		if (!fsx.existsSync(srcCompose)) {
+			continue;
+		}
+
+		if (withBackup) {
+			createBackup(dstCompose);
+		}
+
+		try {
+			// Clean destination
+			if (override && fsx.existsSync(dstCompose)) {
+				fs.rmSync(dstCompose, { recursive: true, force: true });
+			}
+
+			fs.renameSync(srcCompose, dstCompose);
+			verboseLog(`moved: ${srcCompose} to ${dstCompose}`);
+
+			if (withBackup) {
+				deleteBackup(dstCompose);
+			}
+		} catch (e) {
+			if (withBackup) {
+				restoreBackup(dstCompose);
+				console.log("Backup has been restored.");
+			}
+
+			throw new Error(JSON.stringify(e));
+		}
+	}
+}
+
 export {
 	clearEmptyDirs,
 	clearSitemapsFromDirs,
+	copyArtifacts,
 	copyDirsSync,
+	createArtifacts,
 	createDirsSync,
-	moveDirsSync,
+	moveArtifacts,
+	removeArtifacts,
 	removeDirsSync,
 	removeVirtualPagesFromStore,
+	renameArtifact,
 };

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,
+};

package/exporter/utils/pages.ts

@@ -78,8 +78,8 @@ function getPageMetaData(params: Core.Page): Core.Page["pageMetaData"] {
 			canonicalURL && canonicalURL.trim() && canonicalURL !== fullUrl
 				? canonicalURL.trim()
 				: isIndexed
-				? fullUrl
-				: undefined,
+					? fullUrl
+					: undefined,
 		locale,
 		url,
 		index: isIndexed ? "index" : "noindex",
@@ -105,7 +105,7 @@ function getPageMetaData(params: Core.Page): Core.Page["pageMetaData"] {
  */
 async function createGriddoPageObject(
 	page: GriddoSinglePage | GriddoListPage | GriddoMultiPage,
-	additionalInfo: PageAdditionalInfo
+	additionalInfo: PageAdditionalInfo,
 ): Promise<GriddoPageObject> {
 	// Extract some props from page
 	const {
@@ -207,7 +207,7 @@ async function createGriddoPageObject(
  */
 async function createGriddoSinglePage(
 	page: GriddoSinglePage,
-	additionalInfo: PageAdditionalInfo
+	additionalInfo: PageAdditionalInfo,
 ) {
 	return await createGriddoPageObject(page, additionalInfo);
 }
@@ -224,7 +224,7 @@ async function createGriddoListPages(
 		template,
 		totalQueriedItems,
 	}: GriddoListPage,
-	additionalInfo: PageAdditionalInfo
+	additionalInfo: PageAdditionalInfo,
 ) {
 	const allPages = pages.map(async (dataInPage, idx) => {
 		const isFirstPage = idx === 0;
@@ -287,12 +287,12 @@ async function createGriddoListPages(
  */
 function createGriddoMultiPages(
 	page: GriddoMultiPage,
-	additionalInfo: PageAdditionalInfo
+	additionalInfo: PageAdditionalInfo,
 ) {
 	const { multiPageElements: multiPageElementsBulk, ...cleanPage } = page;
 	// TODO: Use structuredClone() when node 18 is available.
 	const multiPageElements: MultiPageElements = JSON.parse(
-		JSON.stringify(multiPageElementsBulk)
+		JSON.stringify(multiPageElementsBulk),
 	);
 
 	// Si no hay un elemento sin slug, como mínimo hay que dibujar una página
@@ -365,7 +365,7 @@ function createGriddoMultiPages(
  * @param page The page to get the multipage parts.
  */
 function getMultiPageElements(
-	page: TemplateWithDistributor
+	page: TemplateWithDistributor,
 ): Promise<MultiPageElements> | null {
 	const multiPageElements = new Promise((resolve) => {
 		// Recursive
@@ -373,7 +373,7 @@ function getMultiPageElements(
 			// No puede ser Core.Page['template'] porque a medida que va bajando en
 			// el árbol ya no es la estructura de un template.
 			template: Record<string, unknown>,
-			level = 0
+			level = 0,
 		) => {
 			// If it doesn't have a "template strcuture"
 			if (!template || typeof template !== "object") return;
@@ -388,7 +388,7 @@ function getMultiPageElements(
 				const isValidComponent =
 					currentComponent || typeof currentComponent === "object";
 				const hasGriddoMultiPageProp = JSON.stringify(
-					currentComponent
+					currentComponent,
 				).includes('"hasGriddoMultiPage":true');
 
 				if (!isValidComponent) continue;
@@ -434,7 +434,7 @@ function getMultiPageElements(
 function getPage(
 	itemsPerPage: number,
 	items: Array<Fields.QueriedDataItem>,
-	page: number
+	page: number,
 ) {
 	return items?.slice(itemsPerPage * (page - 1), itemsPerPage * page);
 }
@@ -451,13 +451,13 @@ function getPage(
  */
 function getPageCluster(
 	itemsPerPage: number,
-	items: Array<Fields.QueriedDataItem>
+	items: Array<Fields.QueriedDataItem>,
 ) {
 	const totalPagesCount = Math.ceil(items.length / itemsPerPage) || 1;
 	const pageNumbers = Array.from({ length: totalPagesCount }, (_, i) => i + 1);
 
 	return pageNumbers?.map((pageNumber) =>
-		getPage(itemsPerPage, items, pageNumber)
+		getPage(itemsPerPage, items, pageNumber),
 	);
 }
 
@@ -501,7 +501,7 @@ function removeDuplicateTrailing(url: string) {
 function addPageNumberToUrl(
 	url: string,
 	pageNumber: number,
-	options?: { addEndingSlash: boolean }
+	options?: { addEndingSlash: boolean },
 ) {
 	const trailingSlash = url.endsWith("/") ? "" : "/";
 	const endingSlash = options?.addEndingSlash ? "/" : "";
@@ -511,7 +511,7 @@ function addPageNumberToUrl(
 	}
 
 	return removeDuplicateTrailing(
-		`${url}${trailingSlash}${pageNumber}${endingSlash}`
+		`${url}${trailingSlash}${pageNumber}${endingSlash}`,
 	);
 }
 

package/exporter/utils/render.ts

@@ -0,0 +1,49 @@
+import fs from "node:fs";
+import path from "node:path";
+
+import { getConfig } from "./core-utils";
+import { throwError } from "../errors";
+import { RenderUUIDError } from "../errors/errors-data";
+
+const config = getConfig();
+
+/**
+ * Creates a sentinel file with the current date and time.
+ * This file is used to track later if node_modules/@griddo/cx was cleaned by a
+ * npm install from a deploy.
+ */
+function createSentinelRenderFile() {
+	const { __cx } = config.paths();
+	const renderSentinelFile = path.join(__cx, ".render-sentinel");
+	fs.writeFileSync(renderSentinelFile, new Date().toISOString());
+}
+
+function deleteSentinelRenderFile() {
+	const { __cx } = config.paths();
+	const renderSentinelFile = path.join(__cx, ".render-sentinel");
+	fs.unlinkSync(renderSentinelFile);
+}
+
+function isValidRenderProcessOrThrow() {
+	const { __cx } = config.paths();
+	const renderSentinelFile = path.join(__cx, ".render-sentinel");
+	if (!fs.existsSync(renderSentinelFile)) {
+		throwError(RenderUUIDError);
+	}
+}
+
+function initRender() {
+	createSentinelRenderFile();
+}
+
+function finishRender() {
+	return undefined;
+}
+
+export {
+	finishRender,
+	initRender,
+	isValidRenderProcessOrThrow,
+	createSentinelRenderFile,
+	deleteSentinelRenderFile,
+};