@griddo/cx 10.3.26 → 10.4.0

package/exporter/utils/shared.ts

@@ -2,7 +2,6 @@ import type { APIResponses } from "../types/api";
 import type { APIPageObject } from "../types/pages";
 import type { Site } from "../types/sites";
 
-import { Adapters } from "@exporter/adapters";
 import chalk from "chalk";
 import dotenv from "dotenv";
 import fs from "fs-extra";
@@ -10,14 +9,17 @@ import gradient from "gradient-string";
 import pkgDir from "pkg-dir";
 
 import { version } from "../../package.json";
+import { Adapters } from "../adapters";
 
 dotenv.config();
 
+const GRIDDO_DEBUG_LOGS =
+	!!process.env.GRIDDO_DEBUG_LOGS &&
+	!!JSON.parse(process.env.GRIDDO_DEBUG_LOGS);
 const GRIDDO_BUILD_LOGS =
 	(!!process.env.GRIDDO_BUILD_LOGS &&
 		!!JSON.parse(process.env.GRIDDO_BUILD_LOGS)) ||
 	(!!process.env.LOGS && !!JSON.parse(process.env.LOGS));
-
 const CXRootFolder = pkgDir.sync(__dirname)!; // usually monorepo/packages/griddo-cx/
 const instanceRootFolder = pkgDir.sync()!; // instace root folder
 
@@ -40,17 +42,42 @@ function walk(dir: string) {
 /**
  * Custom log inside a line-box.
  *
- * @param str The string to be logged.
+ * @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(str: string) {
-	const len = str.length;
-	const minWidth = str.length + 2;
-	const margin = " ".repeat(Math.floor((minWidth - len) / 2));
-	const borderTop = `╭${"─".repeat(minWidth)}╮\n`;
-	const borderBottom = `\n╰${"─".repeat(minWidth)}╯`;
-	const content = `│${margin}${str}${margin}│`;
-
-	console.log(`${borderTop}${content}${borderBottom}`);
+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}`
+	);
 }
 
 /**
@@ -65,6 +92,17 @@ function logInfo(str: string) {
 	}
 }
 
+/**
+ * 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",
  *
@@ -239,33 +277,69 @@ function sanitizeAPICacheFolder(folderPath: string) {
 	console.log(`Sanitize apiCache folder for ${counter} files`);
 }
 
+/**
+ * Measures the execution time of a series of sync or async functions.
+ * @param functions - Functions to be executed to measure their execution time.
+ * @returns A promise that resolves with the total execution time in seconds.
+ */
 async function measureExecutionTime(
-	...fns: Array<(...args: Array<unknown>) => unknown | Promise<any>>
-) {
+	...functions: Array<(...args: Array<unknown>) => unknown | Promise<any>>
+): Promise<number> {
 	const start = process.hrtime();
 
-	for (const f of fns) {
-		await f();
+	for (const func of functions) {
+		await func();
 	}
 
-	const [s, ms] = process.hrtime(start);
-	const timeInSeconds = s + ms / 1e9;
+	const [seconds, miliseconds] = process.hrtime(start);
+	const timeInSeconds = seconds + miliseconds / 1e9;
 
 	return +timeInSeconds.toFixed(3);
 }
 
+function pause(title: string) {
+	const isPauseEnabled = !!JSON.parse(
+		process.env.GRIDDO_RENDER_BREAKPOINTS_FEATURE || "false"
+	);
+
+	if (!isPauseEnabled) {
+		return;
+	}
+
+	return new Promise<void>((resolve) => {
+		console.log("\n");
+		logBox(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}`);
+}
+
 export {
 	CXRootFolder,
+	debug,
 	delay,
 	instanceRootFolder,
 	logBox,
 	logInfo,
 	logPageSize,
 	measureExecutionTime,
+	pause,
 	printExporterLogo,
 	removeProperties,
 	sanitizeAPICacheFolder,
 	siteList,
 	splash,
+	startLifeCycle,
+	successLifeCyle,
 	walk,
 };

package/exporter/utils/sites.ts

@@ -6,7 +6,6 @@ import path from "node:path";
 import fs from "fs-extra";
 import { parse } from "js2xmlparser";
 
-import { deleteSites } from "./folders";
 import { logInfo } from "./shared";
 import { AuthService } from "../services/auth";
 import { SitesService } from "../services/sites";
@@ -89,9 +88,9 @@ async function checkSites(domain: string) {
 /**
  * Unpublish an array of sites in two steps:
  * - Sending the information to the API
- * - Removing the files from the file system
  *
  * @param sites An array of sites
+ * @see https://griddoio.notion.site/Sites-d7bb0b7cb8d24894a5337e1139fc3d09#2019d3255bda4d219c7e19cf28d0c4fe
  */
 async function unpublishSites(sites: Array<Site>) {
 	for (const site of sites) {
@@ -103,12 +102,8 @@ async function unpublishSites(sites: Array<Site>) {
 			unpublishHashes: [],
 		};
 
-		logInfo(`Unpublish site(s): ${buildInfo.publishIds}`);
-
 		await SitesService.endSiteRender(site.id, body);
 	}
-
-	await deleteSites(sites);
 }
 
 /**

package/exporter/utils/store.ts

@@ -1,11 +1,15 @@
+import type { BuildMetaData } from "../types/api";
+import type { RenderInfo } from "../types/global";
+import type { GriddoPageObject } from "../types/pages";
+
+import fs from "node:fs";
 import fsp from "node:fs/promises";
 import path from "node:path";
 
 import fsx from "fs-extra";
 
-import { walk } from "./shared";
-import { BuildMetaData } from "../types/api";
-import { GriddoPageObject } from "../types/pages";
+import { removeProperties, walk } from "./shared";
+import { Site } from "../types/sites";
 
 /**
  * Read all pages stored in `store` Griddo folder and return one by one with a
@@ -26,7 +30,10 @@ async function* getBuildPages<PageType extends GriddoPageObject>(
 				encoding: "utf-8",
 			})) as PageType;
 			page.size = fileStats.size / 1024;
-			yield page;
+			// SECURITY: Only returns valid page objects
+			if (page.path) {
+				yield page;
+			}
 		} catch (error) {
 			console.error(`Error: The file ${filePath} doesn't exist`, error);
 		}
@@ -35,16 +42,11 @@ async function* getBuildPages<PageType extends GriddoPageObject>(
 
 /**
  * Get the build metadata from the Store.
+ * TODO: Refactorizar para leer un solo archivo: __metadata__.json
  */
 function getBuildMetadata(basePath: string): BuildMetaData {
-	const buildProcessData = fsx.readJSONSync(
-		path.resolve(basePath, "metadata", "buildProcessData.json")
-	);
-	const createdPages = fsx.readJSONSync(
-		path.resolve(basePath, "metadata", "createdPages.json")
-	);
-	const sitesToPublish = fsx.readJSONSync(
-		path.resolve(basePath, "metadata", "sitesToPublish.json")
+	const { sitesToPublish, createdPages, buildProcessData } = fsx.readJSONSync(
+		path.resolve(basePath, "metadata", "render-info.json")
 	);
 	return {
 		buildProcessData,
@@ -53,4 +55,196 @@ function getBuildMetadata(basePath: string): BuildMetaData {
 	};
 }
 
-export { getBuildMetadata, getBuildPages };
+/**
+ * Creates an `store` folder to store pages transformed by createStore
+ */
+function createStoreFolder(storeFolder: string) {
+	if (!fs.existsSync(storeFolder)) {
+		fs.mkdirSync(storeFolder);
+		fs.mkdirSync(path.resolve(storeFolder, "metadata"));
+	}
+
+	console.info("Store initialized");
+}
+
+/**
+ * Write render info into a file.
+ * @param basePath - Absolute path of the folder from which files will be saved.
+ * @param renderInfo - Data that will be saved related to the render process.
+ */
+function saveRenderInfoInStore(basePath: string, renderInfo: RenderInfo) {
+	fs.writeFileSync(
+		path.resolve(basePath, "metadata", "render-info.json"),
+		JSON.stringify(renderInfo)
+	);
+}
+
+/**
+ * Return an array of ids only from `.json` files (no dirs) in the `basePath` folder based in the file name and filtered by the pages ids in a concrete site.
+ * @param basePath - Absolute path of the folder from which files will be read.
+ * @returns A Array<number> of pages ids in `basePath` folder filtered by pages ids in a concrete site.
+ */
+function getPagesInStoreFolderBySitePages(
+	basePath: string,
+	pages: Array<number>
+): Array<number> {
+	const allPagesInStore = getPageInStoreFolder(basePath);
+	const pagesBySite = allPagesInStore.filter((page) => pages.includes(page));
+
+	return pagesBySite;
+}
+
+/**
+ * Return an array of ids only from `.json` files (no dirs) in the `basePath` folder based in the file name.
+ * @param basePath - Absolute path of the folder from which files will be read.
+ * @returns A Array<number> of pages ids in `basePath` folder.
+ */
+function getPageInStoreFolder(basePath: string): Array<number> {
+	const filesInStore = fs.readdirSync(basePath);
+
+	return (
+		filesInStore
+			.filter((file) => {
+				const fullPathFile = `${basePath}/${file}`;
+				const stat = fs.statSync(fullPathFile);
+				// Si es un directorio, no lo incluimos.
+				if (stat && stat.isDirectory()) {
+					return false;
+				}
+				// Si es un archivo pero no tiene la extensión `.json`, no lo incluimos
+				if (path.extname(file) !== ".json") {
+					return false;
+				}
+				// Si es un archivo con el nombre NO pasable a número (NaN), no lo incluimos.
+				const baseFilename = path.basename(file, path.extname(file));
+				if (isNaN(parseInt(baseFilename))) {
+					return false;
+				}
+
+				// no es dir, es json y con nombre pasable a número, ok :)
+				return true;
+			})
+			// Tenemos solo jsons donde el nombre es un "número": "21345.json"
+			.map((page) => {
+				const filename = path.basename(page, path.extname(page));
+				return parseInt(filename);
+			})
+	);
+}
+
+/**
+ * Save the pages into the file system.
+ * @param basePath - Absolute path of the folder from which files will be saved.
+ * @param pages - An array of Griddo page objects to be saved.
+ */
+function savePagesInStore(basePath: string, pages: Array<GriddoPageObject>) {
+	pages.forEach((page) => {
+		removeProperties(page, ["editorID", "parentEditorID"]);
+		const filename = `${page.context.page.id}.json`;
+		const filePath = path.resolve(basePath, filename);
+		fsx.writeJSONSync(filePath, page);
+	});
+}
+
+/**
+ * Remove files from folder.
+ * @param basePath - Absolute path of the folder from which files will be removed.
+ * @param filenames - An array of ids representing file page names.
+ */
+function removePagesFromStore(basePath: string, filenames: Array<number>) {
+	if (filenames.length === 0) {
+		return;
+	}
+
+	filenames.forEach((filename) => {
+		const filePath = path.resolve(basePath, `${filename}.json`);
+		try {
+			fs.unlinkSync(filePath);
+		} catch (error) {
+			console.log(`Error removing file ${filename}`, (error as Error).message);
+		}
+	});
+}
+
+/**
+ * Returns pages that need to be created or deleted for a site in the store based on the provided arguments.
+ * @param sitePages - Properties for page retrieval.
+ * @param props.storeFolder - Absolute path of the Griddo store.
+ * @param props.pages - Exhaustive array of all pages in the site.
+ * @param props.validPagesIds - Array of valid pages in the site.
+ * @param props.changedPages - Array of pages that have been modified in the site.
+ * @returns - An object containing the pages to be created and deleted in the site.
+ */
+async function getPagesToCreateOrDelete(
+	storeFolder: string,
+	sitePages: {
+		sitesToPublish: Array<Site>;
+		pages: Array<number>;
+		validPagesIds: Array<number>;
+		changedPages: Array<number>;
+	}
+) {
+	const { changedPages, pages, validPagesIds, sitesToPublish } = sitePages;
+	// Array<ids> de las páginas que están físicamente en el store en el
+	// site actual del bucle.
+	const pagesInStore = getPagesInStoreFolderBySitePages(storeFolder, pages);
+
+	// Array<ids> que están el `validPagesIds` pero no están por algún
+	// motivo en el store. Se incluyen porque deben ser creadas.
+	const pagesMissingInStore = validPagesIds.filter(
+		(page) => !pagesInStore.includes(page)
+	);
+
+	// Array<ids> para enviar al store, que son las que han cambiado y
+	// las missings.
+	const pagesToStore = pagesMissingInStore.concat(changedPages);
+
+	// Array<ids> de las páginas que han sido eliminadas para quitarlas
+	// físicamente de la carpeta store.
+	const pagesToDeleteFromStore = pagesInStore.filter((page) => {
+		// Las que no estén en validPages
+		return !validPagesIds.includes(page);
+	});
+
+	// 1 - Elimina del array final las páginas borradas.
+	// 2 - Elimina las posibles páginas (ids) duplicadas. (new Set)
+	const pagesToWriteToStore = Array.from(new Set(pagesToStore)).filter(
+		(page) => !pagesToDeleteFromStore.includes(page)
+	);
+
+	// 1 - Leer el store
+	// 2 - eliminar las páginas que tengan como site uno despublicado o borrado
+	const allPagesInStore = getBuildPages(path.resolve(__dirname, "../store"));
+
+	const pagesFromInvalidSites: Array<number> = [];
+	for await (const page of allPagesInStore) {
+		const pageSite = page.context.page.site;
+		const pageId = page.context.page.id!;
+		// Si el `site.id` de la página no es ninguno de los `sitesToPublish`
+		// añadimos la página a `pagesFromIvalidSites` para borrarla
+		// posteriormente.
+		if (!sitesToPublish.map((site) => site.id).includes(pageSite)) {
+			pagesFromInvalidSites.push(pageId);
+		}
+	}
+
+	return {
+		pagesInStore,
+		pagesMissingInStore,
+		pagesToDeleteFromStore: [
+			...pagesToDeleteFromStore,
+			...pagesFromInvalidSites,
+		],
+		pagesToWriteToStore,
+	};
+}
+
+export {
+	createStoreFolder,
+	getBuildMetadata,
+	getBuildPages,
+	getPagesToCreateOrDelete,
+	removePagesFromStore,
+	savePagesInStore,
+	saveRenderInfoInStore,
+};

package/gatsby-node.ts

@@ -33,6 +33,10 @@ const createPages: GatsbyNode["createPages"] = async ({
 	const pages = getBuildPages<GatsbyPageObject>(storeFolderPath);
 
 	for await (const page of pages) {
+		// SECURITY
+		if (!page) {
+			return;
+		}
 		const { domain, compose } = page.context.fullPath;
 		const matchPath = getMatchPath(domain, compose);
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "10.3.26",
+	"version": "10.4.0",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -20,11 +20,11 @@
 		"griddo-cx": "./index.js"
 	},
 	"scripts": {
-		"build": "yarn build:exporter && yarn build:reset-render && yarn build:build-complete && yarn build:download-data",
+		"build": "yarn build:exporter && yarn build:reset-render && yarn build:build-complete && yarn build:create-build-data",
 		"build:exporter": "esbuild ./exporter/index.ts --bundle --platform=node --minify --outfile=./build/index.js",
 		"build:build-complete": "esbuild ./exporter/build-complete.ts --bundle --platform=node --minify --outfile=./build/build-complete.js",
 		"build:reset-render": "esbuild ./exporter/reset-render.ts --bundle --platform=node --minify --outfile=./build/reset-render.js",
-		"build:download-data": "esbuild ./exporter/download-data.ts --bundle --platform=node --minify --outfile=./build/download-data.js",
+		"build:create-build-data": "esbuild ./exporter/create-build-data.ts --bundle --platform=node --minify --outfile=./build/create-build-data.js",
 		"clean": "gatsby clean; rm -rf .cache public assets dist build store",
 		"export": "yarn build && yarn download:data && yarn gatsby-build",
 		"gatsby-build": "gatsby telemetry --disable && gatsby build --prefix-paths",
@@ -34,7 +34,7 @@
 		"watch:tscheck": "tsc --noEmit --watch",
 		"complete-render": "node ./build/build-complete.js",
 		"reset-render": "node ./build/reset-render.js",
-		"download:data": "node ./build/download-data.js"
+		"download:data": "node ./build/create-build-data.js"
 	},
 	"dependencies": {
 		"@babel/core": "^7.21.0",
@@ -70,7 +70,7 @@
 		"react-helmet": "^6.0.0"
 	},
 	"devDependencies": {
-		"@griddo/eslint-config-back": "^10.3.26",
+		"@griddo/eslint-config-back": "^10.4.0",
 		"@types/babel__core": "^7.20.0",
 		"@types/babel__preset-env": "^7.9.2",
 		"@types/csvtojson": "^2.0.0",
@@ -117,5 +117,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "8dd1e9969f77d2f1cbcd19f12eb236b51d804037"
+	"gitHead": "3b3b3de14cb767145da22162c196d8e706f7f7ad"
 }

package/src/components/template.tsx

@@ -16,7 +16,6 @@ export { Head } from "./Head";
 const Template = (data: TemplateProps) => {
 	const {
 		pageContext: {
-			BUILD_MODE,
 			cloudinaryName,
 			locale,
 			page,
@@ -49,7 +48,6 @@ const Template = (data: TemplateProps) => {
 	return (
 		<SiteProvider
 			apiUrl={page.apiUrl}
-			buildMode={BUILD_MODE}
 			cloudinaryCloudName={cloudinaryName}
 			instance={page.instance}
 			linkComponent={Link}

package/src/types.ts

@@ -56,7 +56,6 @@ export type GatsbyPageObject = {
 	size?: number;
 	context: {
 		// Page
-		BUILD_MODE?: string;
 		cloudinaryName?: string;
 		footer: Record<string, unknown> | null;
 		fullPath: Core.Page["fullPath"];