@griddo/cx 11.7.6-rc.1 → 11.7.6

package/exporter/adapters/gatsby/actions/sync.ts

@@ -1,70 +0,0 @@
-import type { RenderContext } from "../shared/context";
-import type { SSG } from "../shared/types";
-
-import fsp from "node:fs/promises";
-import path from "node:path";
-
-import { RENDER_MODE } from "../../../types/render";
-import {
-	deleteDisposableSiteDirs,
-	deleteEmptyDirectories,
-	moveDirs,
-	removeVirtualPages,
-} from "../../../utils/folders";
-import { extractAssetsFromDist } from "../shared/extract-assets";
-import { SyncRender } from "../shared/sync-render";
-
-export async function syncAction(context: RenderContext<SSG>) {
-	const {
-		renderMode,
-		cxArtifacts,
-		domain,
-		pagesToCreate,
-		pagesToDelete,
-		paths: { __cx, __ssg, __cache, __exports },
-		ssg: { ssgArtifacts, assetPrefix },
-	} = context;
-
-	const needsAssetPrefix = !!assetPrefix && assetPrefix !== "";
-	const distDir = path.join(__cx, "dist");
-	const distRestoredDir = path.join(__cx, "dist-restored");
-	const storeDir = path.join(context.paths.__cx, "store");
-
-	await removeVirtualPages(storeDir);
-	// caching...
-	await moveDirs(__cx, __cache, cxArtifacts.cacheables);
-	await moveDirs(__ssg, __cache, ssgArtifacts.cacheables);
-
-	if (renderMode === RENDER_MODE.FROM_SCRATCH) {
-		await deleteDisposableSiteDirs(distDir);
-	}
-
-	if (renderMode === RENDER_MODE.INCREMENTAL) {
-		await deleteDisposableSiteDirs(distRestoredDir);
-
-		const syncRender = new SyncRender({
-			src: distDir,
-			dst: distRestoredDir,
-			pagesToCreate,
-			pagesToDelete,
-			artifactsToCopyToExports: ["build-report.json"],
-		});
-
-		syncRender.setPagesToDelete();
-		syncRender.setPagesToAdd();
-		syncRender.sync();
-
-		await fsp.rm(distDir, { force: true, recursive: true });
-		await fsp.rename(distRestoredDir, distDir);
-		await deleteEmptyDirectories(distDir);
-	}
-
-	if (needsAssetPrefix) {
-		await extractAssetsFromDist(domain);
-	}
-
-	// archiving...
-	await moveDirs(__cx, __exports, cxArtifacts.archivables, {
-		withBackup: true,
-	});
-}

package/exporter/adapters/gatsby/shared/context.ts

@@ -1,50 +0,0 @@
-import type { Artifacts, PlaceholderPath } from "../../../types/global";
-import type { RenderMode } from "../../../types/render";
-
-interface RenderContextProps<T> {
-	domain: string;
-	renderMode: RenderMode;
-	paths: Record<string, string>;
-	ssg: T;
-	renderMetadata: {
-		proDomain: string;
-		griddoVersion: string;
-		buildReportFileName: string;
-	};
-	cxArtifacts: Artifacts;
-}
-
-/**
- * Encapsulates the state, configuration, and artifacts for a single SSG
- * render process.
- *
- * This class is instantiated at the beginning of a render and passed through
- * each lifecycle step, providing a centralized and consistent context for all
- * operations. It is agnostic to the specific SSG being used.
- */
-export class RenderContext<T = unknown> {
-	readonly domain: string;
-	readonly renderMode: RenderMode;
-	readonly paths: Record<PlaceholderPath, string>;
-	pagesToCreate: number[] = [];
-	pagesToDelete: number[] = [];
-	ssg: T;
-	renderMetadata: { proDomain: string; griddoVersion: string; buildReportFileName: string };
-	cxArtifacts: Artifacts;
-
-	constructor({
-		domain,
-		renderMode,
-		ssg,
-		paths,
-		renderMetadata,
-		cxArtifacts,
-	}: RenderContextProps<T>) {
-		this.domain = domain;
-		this.renderMode = renderMode;
-		this.paths = paths;
-		this.renderMetadata = renderMetadata;
-		this.cxArtifacts = cxArtifacts;
-		this.ssg = ssg;
-	}
-}

package/exporter/adapters/gatsby/shared/extract-assets.ts

@@ -1,61 +0,0 @@
-import fsp from "node:fs/promises";
-import path from "node:path";
-
-import { pathExists } from "../../../utils/folders";
-import { getRenderPathsFromDB } from "../../../utils/render";
-
-/**
- * Update the Griddo's `/dist` dir with the contents from `public` dir only
- * with files of type: js, json and css.
- * TODO: Explicar que el static se copia a assets porque el js va en el subdominio de assets.
- */
-async function extractAssetsFromDist(domain: string) {
-	const { __cx } = await getRenderPathsFromDB({ domain });
-
-	// Archivos (no carpetas) válidos de public
-	const filesFromDist = (await fsp.readdir(path.join(__cx, "dist"))).filter(
-		(file) =>
-			path.extname(file) === ".js" ||
-			path.extname(file) === ".json" ||
-			path.extname(file) === ".css",
-	);
-
-	// Creamos assets si es necesario (needsAssetPrefix)
-	await fsp.mkdir(path.join(__cx, "assets"), { recursive: true });
-	// page-data folder
-	await fsp.cp(path.join(__cx, "dist", "page-data"), path.join(__cx, "assets", "page-data"), {
-		preserveTimestamps: true,
-		recursive: true,
-	});
-	// static folder si existe
-	if (await pathExists(path.join(__cx, "static"))) {
-		await fsp.cp(path.join(__cx, "static"), path.join(__cx, "assets"), {
-			force: false,
-			preserveTimestamps: true,
-			recursive: true,
-		});
-	}
-	// dist/static -> assets/static
-	await fsp.cp(path.join(__cx, "dist", "static"), path.join(__cx, "assets", "static"), {
-		force: false,
-		preserveTimestamps: true,
-		recursive: true,
-	});
-	// otro static...
-	if (await pathExists(path.join(__cx, "static"))) {
-		await fsp.cp(path.join(__cx, "static"), path.join(__cx, "dist", domain), {
-			preserveTimestamps: true,
-			recursive: true,
-			force: false,
-		});
-	}
-
-	// Copia el resto de archivos...
-	for (const file of filesFromDist) {
-		const fileSrc = path.join(__cx, "dist", file);
-		const fileDest = path.join(__cx, "assets", file);
-		await fsp.cp(fileSrc, fileDest, { preserveTimestamps: true, recursive: true });
-	}
-}
-
-export { extractAssetsFromDist };

package/exporter/adapters/gatsby/shared/gatsby-build.ts

@@ -1,54 +0,0 @@
-import { spawn } from "node:child_process";
-
-import { GRIDDO_SSG_VERBOSE_LOGS } from "../../../constants/envs";
-import { verboseLog } from "../../../utils/loggin";
-import { getRenderPathsFromDB } from "../../../utils/render";
-
-/**
- * Spawn a new node process `yarn gatsby-build`
- * @note This proccess (`yarn gatsby-build`) can not access to the custom Griddo
- * `process.env` so it needs variables passed to it via the `env` prop.
- */
-async function gatsbyBuild(assetPrefixWithDomain: string): Promise<void> {
-	verboseLog(`read assetPrefixWithDomain, ${assetPrefixWithDomain}`);
-	verboseLog(`using this NODE_OPTIONS in gatsby command: ${process.env.NODE_OPTIONS}`);
-
-	const { __ssg } = await getRenderPathsFromDB();
-
-	// Remove `--openssl-legacy-provider` from NODE_OPTIONS because this value
-	// break Gatsby render.
-	const nodeOptionsWithoutLegacyOpenSSL = process.env.NODE_OPTIONS
-		? process.env.NODE_OPTIONS.replace(/--openssl-legacy-provider\s*/g, "").trim()
-		: "";
-
-	const args = ["gatsby-build"];
-	if (GRIDDO_SSG_VERBOSE_LOGS) {
-		args.push("--verbose");
-	}
-
-	return new Promise((resolve, reject) => {
-		const child = spawn("yarn", args, {
-			cwd: __ssg,
-			stdio: ["ignore", "inherit", "inherit"], // stdout y stderr van a consola directamente
-			env: Object.assign(process.env, {
-				GRIDDO_EXPORTER: "true",
-				SPAWN_ASSET_PREFIX_WITH_DOMAIN: assetPrefixWithDomain,
-				NODE_OPTIONS: nodeOptionsWithoutLegacyOpenSSL,
-			}),
-		});
-
-		child.on("close", (code) => {
-			if (code === 0) {
-				resolve();
-			} else {
-				reject(new Error(`Gatsby build failed with exit code ${code}`));
-			}
-		});
-
-		child.on("error", (error) => {
-			reject(new Error(`Failed to start Gatsby build process: ${error.message}`));
-		});
-	});
-}
-
-export { gatsbyBuild };

package/exporter/adapters/gatsby/shared/sync-render.ts

@@ -1,294 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-
-import { verboseLog } from "../../../utils/loggin";
-
-type SyncRenderConfig = {
-	src: string;
-	dst: string;
-	pagesToCreate: Array<number>;
-	pagesToDelete: Array<number>;
-	artifactsToCopyToExports: Array<string>;
-};
-
-type CopyFilePath = {
-	from: string;
-	to: string;
-};
-
-type SyncState = {
-	htmlToAdd: Array<CopyFilePath>;
-	jsonToAdd: Array<CopyFilePath>;
-	htmlToDelete: Array<string>;
-	jsonToDelete: Array<string>;
-};
-
-class SyncRender {
-	private bundleDir: string;
-	private currentRenderDir: string;
-	private pagesToCreate: Array<number>;
-	private pagesToDelete: Array<number>;
-	private assetArtifacts: Array<string>;
-
-	private state: SyncState = {
-		htmlToAdd: [],
-		jsonToAdd: [],
-		htmlToDelete: [],
-		jsonToDelete: [],
-	};
-
-	constructor(config: SyncRenderConfig) {
-		this.bundleDir = config.dst;
-		this.currentRenderDir = config.src;
-		this.pagesToCreate = config.pagesToCreate;
-		this.pagesToDelete = config.pagesToDelete;
-		this.assetArtifacts = config.artifactsToCopyToExports;
-	}
-
-	// Se basa en los paths encontrados en page-data.json y no en recorrer físicamente el file-system
-	setPagesToDelete() {
-		// El set de ids están tanto las páginas que se van a crear como borrar.
-		// El por qué poner las que se van a crear es porque necesitamos quitar esas páginas con esos ids por si las que se van a crear tienen otro slug.
-		// Por ejemplo si se va crear la página id3 con slug /page-with-new-slug
-		// pero existía antes con el slug /page se borrará /page del sistema de
-		// ficheros y después se creará /page-with-new-slug ya que solo puede
-		// existir una página con el mismo id salvo que sea Multi-Page o
-		// Listado-Estático.
-		const idSet = new Set<number>([...this.pagesToDelete, ...this.pagesToCreate]);
-		const composePaths = this.getPageComposePaths(this.bundleDir);
-
-		for (const compose of composePaths) {
-			const normalizedCompose = compose === "/" ? "index" : compose;
-			const json = JSON.parse(
-				fs.readFileSync(
-					path.join(this.bundleDir, "page-data", normalizedCompose, "page-data.json"),
-					"utf8",
-				),
-			);
-			const id = json.result.pageContext.id;
-			const pagePath = json.result.pageContext.fullPath.compose as string;
-			// si el id de la página está en los ids para borrar (idSet) se añade
-			if (idSet.has(id)) {
-				try {
-					this.state.htmlToDelete.push(path.join(this.bundleDir, pagePath, "index.html"));
-					this.state.jsonToDelete.push(
-						path.join(
-							this.bundleDir,
-							"page-data",
-							pagePath === "/" ? "index" : pagePath,
-							"page-data.json",
-						),
-					);
-				} catch (e) {
-					console.log(e);
-				}
-			}
-		}
-
-		verboseLog(`${this.state.htmlToDelete.length} pages HTML to delete`);
-		verboseLog(`${this.state.jsonToDelete.length} pages JSON to delete`);
-	}
-
-	// Se basa en los paths encontrados en page-data.json y no en recorrer físicamente el file-system
-	// Cuando añadimos una página con id 3 (p.e.), hay que buscar todas las
-	// páginas con ese id en el bundle y borrar sus html/json. Esto va a pasar
-	// por ejemplo si cambiamos el slug de la página 3. Eso hará que se guarde
-	// en distintas carpetas pero no es una página que venga en "pagesToDelete"
-	setPagesToAdd() {
-		const idSet = new Set<number>(this.pagesToCreate);
-		const composePaths = this.getPageComposePaths(this.currentRenderDir);
-
-		for (const compose of composePaths) {
-			// 1 - leemos el page-data.json de la página para añadir
-			// Gatsby crea un directorio `index` para la página raíz `/`
-			const normalizedCompose = compose === "/" ? "index" : compose;
-			const json = JSON.parse(
-				fs.readFileSync(
-					path.join(this.currentRenderDir, "page-data", normalizedCompose, "page-data.json"),
-					"utf8",
-				),
-			);
-			// 2 - sacamos el id
-			const id = json.result.pageContext.id;
-
-			// 3 - obtenemos el src y dst del HTML
-			const htmlFrom = path.join(this.currentRenderDir, compose, "index.html");
-			const htmlTo = path.join(this.bundleDir, compose, "index.html");
-			// 4 - obtenemos el src/dst del JSON
-			const jsonFrom = path.join(
-				this.currentRenderDir,
-				"page-data",
-				normalizedCompose,
-				"page-data.json",
-			);
-			const jsonTo = path.join(this.bundleDir, "page-data", normalizedCompose, "page-data.json");
-
-			// Solo actuamos en la página si su id está en pagesToCreate
-			if (idSet.has(id)) {
-				try {
-					this.state.htmlToAdd.push({ from: htmlFrom, to: htmlTo });
-					this.state.jsonToAdd.push({ from: jsonFrom, to: jsonTo });
-				} catch (e) {
-					console.log(e);
-				}
-			}
-
-			verboseLog(`${this.state.htmlToAdd.length} pages HTML to create`);
-			verboseLog(`${this.state.jsonToAdd.length} pages JSON to create`);
-		}
-	}
-
-	/**
-	 * Realiza la sincronización de los archivos HTML y JSON entre el directorio
-	 * actual de renderizado y el directorio de exportación.
-	 */
-	sync() {
-		// remove html's
-		for (const html of this.state.htmlToDelete) {
-			try {
-				fs.rmSync(html);
-				verboseLog(`Sync (remove) : ${html}`);
-			} catch (e) {
-				console.log(`Does not exist ${html}`, e);
-			}
-		}
-
-		// remove json's
-		for (const json of this.state.jsonToDelete) {
-			try {
-				fs.rmSync(json);
-				verboseLog(`Sync (remove) : ${json}`);
-			} catch (e) {
-				console.log(`Does not exist ${json}`, e);
-			}
-		}
-
-		// copy html's
-		for (const html of this.state.htmlToAdd) {
-			fs.mkdirSync(path.dirname(html.to), { recursive: true });
-			fs.copyFileSync(html.from, html.to);
-			verboseLog(`Sync (copy) : ${html.from} -> ${html.to}`);
-		}
-
-		// copy json's
-		for (const json of this.state.jsonToAdd) {
-			fs.mkdirSync(path.dirname(json.to), { recursive: true });
-			fs.copyFileSync(json.from, json.to);
-			verboseLog(`Sync (copy) : ${json.from} -> ${json.to}`);
-		}
-
-		// update app-data.json (update the webpackCompilationHash)
-		this.copyAppDataJsonFile();
-
-		// copy artifacts
-		this.copyDirs();
-
-		// copy sitemaps
-		this.copySitemaps();
-	}
-
-	/**
-	 * Busca archivos por extensión de forma recursiva en un directorio.
-	 * @param dir Directorio base.
-	 * @param extension Extensión a buscar (ej: ".ts", ".js").
-	 * @returns Lista de rutas absolutas de archivos encontrados.
-	 */
-	private findFilesByExtension(dir: string, extension: string): Array<string> {
-		let results: Array<string> = [];
-
-		if (!fs.existsSync(dir)) {
-			return [];
-		}
-
-		const list = fs.readdirSync(dir, { withFileTypes: true });
-
-		for (const item of list) {
-			const fullPath = path.join(dir, item.name);
-
-			if (item.isDirectory()) {
-				results = results.concat(this.findFilesByExtension(fullPath, extension));
-			} else if (item.isFile() && fullPath.endsWith(extension)) {
-				results.push(fullPath);
-			}
-		}
-
-		return results;
-	}
-
-	private findAllPageDataJsons(dir: string) {
-		return this.findFilesByExtension(dir, ".json").filter((n) => n.endsWith("page-data.json"));
-	}
-
-	private getPageComposePaths(src: string) {
-		// [page-data/foo/bar/page-data.json, ...]
-		const allPageDataJson = this.findAllPageDataJsons(src);
-
-		// Array de fullPaths
-		// Entre ellos un fullPath puede ser: "/" (El root de la instancia)
-
-		// No sé si hacer esto en este momento...
-		// fullPath: "/foo/bar" => "foo/bar"
-		// fullPath: "/" => "index"
-		return allPageDataJson.map(
-			(p) => JSON.parse(fs.readFileSync(p, "utf-8")).result.pageContext.fullPath.compose,
-		);
-	}
-
-	private copyAppDataJsonFile() {
-		fs.copyFileSync(
-			path.join(this.currentRenderDir, "page-data", "app-data.json"),
-			path.join(this.bundleDir, "page-data", "app-data.json"),
-		);
-		verboseLog("Copied app-data.json");
-	}
-
-	private copyDirs() {
-		for (const assetArtifact of this.assetArtifacts) {
-			fs.copyFileSync(
-				path.join(this.currentRenderDir, assetArtifact),
-				path.join(this.bundleDir, assetArtifact),
-			);
-			verboseLog(
-				`Copied ${path.join(this.currentRenderDir, assetArtifact)} -> to -> ${path.join(
-					this.bundleDir,
-					assetArtifact,
-				)}`,
-			);
-		}
-	}
-
-	private copySitemaps() {
-		/*
-		1. buscar directorios que tengan como hijo un `sitemap.xml`
-		2. copiar todos los sitemap.xml y sitemap-* a /exports/sites/<domain>/<site>/ borrando previamente los .xmls que existan
-		*/
-		const renderSrc = path.resolve(this.currentRenderDir);
-		const renderDst = path.resolve(this.bundleDir);
-		const xmlFilesInSrc = this.findFilesByExtension(renderSrc, ".xml");
-		const xmlFilesInDst = this.findFilesByExtension(renderDst, ".xml");
-
-		// Eliminar los sitemaps de griddo que existan en el destino, se van a
-		// crear todos nuevos en la fase Meta.
-		for (const xmlFile of xmlFilesInDst) {
-			if (
-				path.basename(xmlFile).startsWith("sitemap-") ||
-				path.basename(xmlFile) === "sitemap.xml"
-			) {
-				fs.rmSync(xmlFile, { force: true });
-			}
-		}
-
-		for (const xmlFile of xmlFilesInSrc) {
-			const src = xmlFile;
-			// cambia la ruta, de src -> dst
-			const dst = xmlFile.replace(renderSrc, renderDst);
-
-			if (!fs.existsSync(path.dirname(dst))) {
-				fs.mkdirSync(path.dirname(dst), { recursive: true });
-			}
-			fs.copyFileSync(src, dst);
-		}
-	}
-}
-
-export { SyncRender };

package/exporter/adapters/gatsby/shared/types.ts

@@ -1,35 +0,0 @@
-interface SSG {
-	assetPrefix: string;
-	ssgArtifacts: {
-		disposables: string[];
-		cacheables: string[];
-	};
-}
-
-// Minimal representation of the page structure
-interface GatsbyPageData {
-	path: string;
-	result: {
-		pageContext: {
-			id: number;
-			title: string;
-			path: string;
-			openGraph: any;
-			pageMetadata: any;
-			page: {
-				site: number;
-				id: number;
-				fullPath: { compose: string };
-				language: number;
-				title: string;
-				fullUrl: string;
-				templateId: string;
-				template: {
-					templateType: string;
-				};
-			};
-		};
-	};
-}
-
-export type { GatsbyPageData, SSG };

package/exporter/build-esbuild.noop

@@ -1,42 +0,0 @@
-#!/usr/bin/env bash
-
-# Build CX script file
-#
-# This file generates the necessary builds for CX.
-# - Setup, to generate necessary elements (tsconfig, etc..)
-# - Library, CX library that will be used by the SSG framework.
-# - Scripts, CX scripts that will be used by infra during the render process.
-#
-# @todo:
-# In the future, we will try to eliminate the bundling processes and use
-# TypeScript or ESModules directly.
-
-# start
-echo "📦 Building ..."
-
-# CLI options
-log="--log-level=error"
-production_node_opts="--bundle --platform=node --minify --sourcemap"
-debugging_node_opts="--bundle --platform=node --sourcemap"
-# react_opts="--platform=node --external:@griddo-instance --external:react --external:react-dom --bundle --minify"
-
-# Manage --minify for debugging
-bundle_node_opts=$production_node_opts
-if [ "$1" = "--debug" ]; then
-    bundle_node_opts=$debugging_node_opts
-fi
-
-# library
-# esbuild ${log} ./exporter/index.ts ${bundle_node_opts} --outfile=./build/index.js
-# esbuild ${log} ./exporter/react/index.tsx ${react_opts} --outfile=./build/react/index.js
-
-# scripts
-esbuild ${log} ./exporter/commands/end-render.ts ${bundle_node_opts} --outfile=./build/end-render.js
-esbuild ${log} ./exporter/commands/upload-search-content.ts ${bundle_node_opts} --outfile=./build/upload-search-content.js
-esbuild ${log} ./exporter/commands/reset-render.ts ${bundle_node_opts} --outfile=./build/reset-render.js
-esbuild ${log} ./exporter/commands/start-render.ts ${bundle_node_opts} --outfile=./build/start-render.js
-esbuild ${log} ./exporter/commands/prepare-domains-render.ts ${bundle_node_opts} --outfile=./build/prepare-domains-render.js
-esbuild ${log} ./exporter/commands/prepare-assets-directory.ts ${bundle_node_opts} --outfile=./build/prepare-assets-directory.js
-
-# types
-tsc --emitDeclarationOnly --declaration --outDir build --project tsconfig.exporter.json

package/exporter/commands/prepare-assets-directory.ts

@@ -1,33 +0,0 @@
-#!/usr/bin/env node
-
-import childProcess from "node:child_process";
-import path from "node:path";
-
-import { doLifeCycle } from "../utils/core-utils";
-import { pathExists } from "../utils/folders";
-import { getRenderPathsFromDB } from "../utils/render";
-
-async function prepareAssetsAction() {
-	const [domain] = process.argv.slice(2);
-
-	const { __exports } = await getRenderPathsFromDB({ domain });
-
-	const assetsDir = path.join(__exports, "assets");
-	const domainAssetsDir = path.join(__exports, domain);
-
-	if (await pathExists(assetsDir)) {
-		childProcess.execSync(`rm -rf ${domainAssetsDir}`);
-		childProcess.execSync(`mv ${assetsDir} ${domainAssetsDir}`);
-	} else {
-		console.log("Assets directory not found");
-	}
-}
-
-async function main() {
-	await doLifeCycle("PrepareAssets(Internal)", prepareAssetsAction);
-}
-
-main().catch((err) => {
-	console.error("Error", err?.stdout?.toString() || err);
-	process.exit(1);
-});

package/exporter/services/db.ts

@@ -1,32 +0,0 @@
-import type { RenderDB } from "../types/render";
-
-import fsp from "node:fs/promises";
-import path from "node:path";
-
-import { pkgDirSync } from "../utils/folders";
-
-const root = pkgDirSync({ cwd: path.resolve(__dirname, "../../..") }) || "";
-const cache = path.join(root, ".cx-cache");
-const dbFilePath = path.join(cache, "db.json");
-
-async function readDB(customDBPath = "") {
-	const file = customDBPath || dbFilePath;
-	try {
-		return JSON.parse(await fsp.readFile(file, "utf-8")) as RenderDB;
-	} catch (error) {
-		console.error(`Failed to read DB file at ${file}:`, error);
-		throw error;
-	}
-}
-
-async function writeDB(renderDB: RenderDB, customDBPath = "") {
-	const file = customDBPath || dbFilePath;
-	try {
-		await fsp.writeFile(file, JSON.stringify(renderDB));
-	} catch (error) {
-		console.error(`Failed to write DB file at ${file}:`, error);
-		throw error;
-	}
-}
-
-export { readDB, writeDB };