@griddo/cx 11.7.12-rc.4 → 11.7.12

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

@@ -1,58 +0,0 @@
-import { spawn } from "node:child_process";
-import path from "node:path";
-
-import { GRIDDO_SSG_VERBOSE_LOGS } from "../../../constants/envs";
-import { verboseLog } from "../../../utils/loggin";
-import { getRenderPathsFromDB } from "../../../utils/render";
-
-/**
- * Spawn a new node process `gatsby build`
- * @note This proccess 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()
-		: "";
-
-	// Ruta al ejecutable de Gatsby
-	const gatsbyExecutable = path.join(__ssg, "node_modules", ".bin", "gatsby");
-
-	const args = ["build", "--prefix-paths"];
-	if (GRIDDO_SSG_VERBOSE_LOGS) {
-		args.push("--verbose");
-	}
-
-	return new Promise((resolve, reject) => {
-		const child = spawn(gatsbyExecutable, args, {
-			cwd: __ssg,
-			stdio: ["ignore", "inherit", "inherit"],
-			env: {
-				...process.env,
-				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,276 +0,0 @@
-import fsp from "node:fs/promises";
-import path from "node:path";
-
-import { findFilesBySuffix } from "../../../utils/folders";
-import { infoLog, verboseLog } from "../../../utils/loggin";
-import { getAssetsDiffBetweenRenders, patchHtmlFile } from "./diff-assets";
-
-interface SyncRenderConfig {
-	src: string;
-	dst: string;
-	pagesToCreate: Array<number>;
-	pagesToDelete: Array<number>;
-	artifactsToCopyToExports: Array<string>;
-}
-interface CopyFilePath {
-	from: string;
-	to: string;
-}
-interface SyncState {
-	htmlToAdd: Array<CopyFilePath>;
-	jsonToAdd: Array<CopyFilePath>;
-	htmlToDelete: Array<string>;
-	jsonToDelete: Array<string>;
-}
-interface PageInfo {
-	id: number;
-	composePath: string; // p.ej. '/about-us' o '/'
-	htmlPath: string; // p.ej. '/path/to/public/about-us/index.html'
-	jsonPath: string; // p.ej. '/path/to/public/page-data/about-us/page-data.json'
-}
-interface GatsbyPageData {
-	result: {
-		pageContext: {
-			id: number;
-			fullPath: {
-				site: string;
-				domain: string;
-				domainUrl: string;
-				language: string;
-				page: string;
-				compose: 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;
-	}
-
-	public async execute() {
-		await this.setPagesToDelete();
-		await this.setPagesToAdd();
-		await this.sync();
-		await this.assertAssetsAreValid();
-	}
-
-	private async assertAssetsAreValid() {
-		const isDifferent = await getAssetsDiffBetweenRenders(this.currentRenderDir, this.bundleDir);
-		if (isDifferent) {
-			infoLog(
-				"Warning: JavaScript and CSS bundles must have the same files and content. You can ignore this warning if the rendering process only has pages to unpublish.",
-			);
-		} else {
-			infoLog("Previous and current JavaScript and CSS packages successfully matched");
-		}
-	}
-
-	private async setPagesToDelete() {
-		// ¿Por qué se incluyen this.pagesToCreate en las candidatas para borrarse?
-		// El set de ids incluye tanto las páginas a borrar como las que se van
-		// a crear para manejar correctamente por ejemplo los cambios de slug.
-		// Si la página `id=3` tiene slug `slug=about` y despues viene con
-		// `slug=about-us` borramos la página `id=3` en el render previo y la
-		// volvemos a crear.
-		// Resumido lo que pasará es que las páginas que se van a crear se
-		// borran previamente por si ha cambiado el slug. Porque el slug hace
-		// que se guarden en otro directorio.
-		// ¿Qué pasaría si no la borrásemos? que tendríamos las dos páginas
-		// `/about/index.html` y `/about-us/index.html`
-		const candidateIdsToDelete = new Set<number>([...this.pagesToDelete, ...this.pagesToCreate]);
-		const existingPreviousPages = await this.scanPages(this.bundleDir);
-
-		for (const page of existingPreviousPages) {
-			if (candidateIdsToDelete.has(page.id)) {
-				this.state.htmlToDelete.push(page.htmlPath);
-				this.state.jsonToDelete.push(page.jsonPath);
-			}
-		}
-
-		verboseLog(`${this.state.htmlToDelete.length} pages HTML to delete`);
-		verboseLog(`${this.state.jsonToDelete.length} pages JSON to delete`);
-	}
-
-	private async setPagesToAdd() {
-		const candidateIdsToCreate = new Set<number>(this.pagesToCreate);
-		const newPages = await this.scanPages(this.currentRenderDir);
-
-		for (const page of newPages) {
-			if (candidateIdsToCreate.has(page.id)) {
-				const htmlTo = path.join(this.bundleDir, page.composePath, "index.html");
-				const normalizedCompose = page.composePath === "/" ? "index" : page.composePath;
-				const jsonTo = path.join(this.bundleDir, "page-data", normalizedCompose, "page-data.json");
-
-				this.state.htmlToAdd.push({ from: page.htmlPath, to: htmlTo });
-				this.state.jsonToAdd.push({ from: page.jsonPath, to: jsonTo });
-			}
-		}
-
-		verboseLog(`${this.state.htmlToAdd.length} pages HTML to create`);
-		verboseLog(`${this.state.jsonToAdd.length} pages JSON to create`);
-	}
-
-	private async sync() {
-		// Delete...
-		const allFilesToDelete = [...this.state.htmlToDelete, ...this.state.jsonToDelete];
-		for (const file of allFilesToDelete) {
-			try {
-				// Usar `force: true` para no fallar si el archivo ya no existe.
-				await fsp.rm(file, { force: true });
-				verboseLog(`Sync (remove) : ${file}`);
-			} catch (e) {
-				// El error solo se registraría si es un problema de permisos, etc.
-				console.error(`Failed to remove ${file}:`, e);
-			}
-		}
-
-		await this.restoreWebpackCompilationHash();
-
-		// Copy...
-		const allFilesToAdd = [...this.state.htmlToAdd, ...this.state.jsonToAdd];
-		for (const file of allFilesToAdd) {
-			try {
-				await fsp.mkdir(path.dirname(file.to), { recursive: true });
-				await fsp.copyFile(file.from, file.to);
-				verboseLog(`Sync (copy) : ${file.from} -> ${file.to}`);
-			} catch (e) {
-				console.error(`Failed to copy ${file.from} to ${file.to}:`, e);
-			}
-		}
-
-		// AVOID TO RESTORE webpackCompilationHash
-		// await this.copyAppDataJsonFile();
-		await this.copyAssetArtifacts();
-		await this.copySitemaps();
-	}
-
-	private async restoreWebpackCompilationHash() {
-		const appDataJson = path.join(this.bundleDir, "page-data", "app-data.json");
-		const webpackCompilationHash = JSON.parse(
-			await fsp.readFile(appDataJson, "utf8"),
-		).webpackCompilationHash;
-		console.log(
-			"Leyendo el webpackCompilationHash desde",
-			appDataJson,
-			"=",
-			webpackCompilationHash,
-		);
-
-		const changedHtmlFilePaths = this.state.htmlToAdd.map(({ from }) => from);
-
-		for (const htmlFilePath of changedHtmlFilePaths) {
-			await patchHtmlFile(htmlFilePath, webpackCompilationHash);
-		}
-	}
-
-	// private async copyAppDataJsonFile() {
-	// 	try {
-	// 		const src = path.join(this.currentRenderDir, "page-data", "app-data.json");
-	// 		const dst = path.join(this.bundleDir, "page-data", "app-data.json");
-	// 		await fsp.copyFile(src, dst);
-	// 		verboseLog("Copied app-data.json");
-	// 	} catch (e) {
-	// 		console.error("Failed to copy app-data.json:", e);
-	// 	}
-	// }
-
-	private async copyAssetArtifacts() {
-		for (const assetArtifact of this.assetArtifacts) {
-			const src = path.join(this.currentRenderDir, assetArtifact);
-			const dst = path.join(this.bundleDir, assetArtifact);
-			try {
-				await fsp.mkdir(path.dirname(dst), { recursive: true });
-				await fsp.copyFile(src, dst);
-				verboseLog(`Copied artifact: ${assetArtifact}`);
-			} catch (e) {
-				console.error(`Failed to copy artifact ${src} to ${dst}:`, e);
-			}
-		}
-	}
-
-	private async copySitemaps() {
-		const renderSrc = path.resolve(this.currentRenderDir);
-		const renderDst = path.resolve(this.bundleDir);
-
-		// Primero, elimina los sitemaps existentes en el destino
-		const xmlFilesInDst = findFilesBySuffix(renderDst, ".xml");
-		for await (const xmlFile of xmlFilesInDst) {
-			const basename = path.basename(xmlFile);
-			if (basename.startsWith("sitemap-") || basename === "sitemap.xml") {
-				await fsp.rm(xmlFile, { force: true });
-			}
-		}
-
-		// Segundo, copia los nuevos sitemaps desde el origen
-		const xmlFilesInSrc = findFilesBySuffix(renderSrc, ".xml");
-		for await (const src of xmlFilesInSrc) {
-			// Reconstruye la ruta de destino de forma más robusta
-			const relativePath = path.relative(renderSrc, src);
-			const dst = path.join(renderDst, relativePath);
-
-			try {
-				await fsp.mkdir(path.dirname(dst), { recursive: true });
-				await fsp.copyFile(src, dst);
-			} catch (e) {
-				console.error(`Failed to copy sitemap ${src} to ${dst}:`, e);
-			}
-		}
-
-		verboseLog(`Copied sitemap files.`);
-	}
-
-	/**
-	 * Escanea un directorio de build de Gatsby y extrae la información esencial de cada página.
-	 * Lee cada page-data.json una sola vez para optimizar el rendimiento.
-	 * @param dir Directorio a escanear (src o dst).
-	 * @returns Un array con la información de cada página encontrada.
-	 */
-	private async scanPages(dir: string): Promise<Array<PageInfo>> {
-		// Array de paths de page-data.json
-		const gatsbyPageDataFiles = findFilesBySuffix(path.join(dir, "page-data"), "page-data.json");
-		const pagesFound: Array<PageInfo> = [];
-
-		for await (const jsonFile of gatsbyPageDataFiles) {
-			try {
-				const content = JSON.parse(await fsp.readFile(jsonFile, "utf-8")) as GatsbyPageData;
-				const id = content.result.pageContext.id;
-				const composePath = content.result.pageContext.fullPath.compose;
-				// Esto es necesario porque Gatsby convierte la ruta "/" en un
-				// directorio llamado "index" en lo que archivos page-data.json
-				// se refiere.
-				const normalizedCompose = composePath === "/" ? "index" : composePath;
-
-				pagesFound.push({
-					id,
-					composePath,
-					htmlPath: path.join(dir, composePath, "index.html"),
-					jsonPath: path.join(dir, "page-data", normalizedCompose, "page-data.json"),
-				});
-			} catch (e) {
-				console.error(`Error reading or parsing page data from ${jsonFile}:`, e);
-			}
-		}
-		return pagesFound;
-	}
-}
-
-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,30 +0,0 @@
-import childProcess from "node:child_process";
-import path from "node:path";
-
-import { pathExists } from "../utils/folders";
-import { getRenderPathsFromDB } from "../utils/render";
-
-async function prepareAssetsDir() {
-	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 prepareAssetsDir();
-}
-
-main().catch((err) => {
-	console.error("Error", err?.stdout?.toString() || err);
-	process.exit(1);
-});

package/exporter/services/db-class.ts

@@ -1,54 +0,0 @@
-import type { RenderDB } from "../types/render";
-
-import fsp from "node:fs/promises";
-import path from "node:path";
-
-import { pkgDirSync } from "../utils/npm-deps/pkg-dir";
-
-// Interfaz para abstraer la DB
-export interface Database {
-	read(): Promise<RenderDB>;
-	write(renderDB: RenderDB): Promise<void>;
-}
-
-export class JsonDatabase implements Database {
-	private readonly dbFilePath: string;
-
-	constructor(customDBPath?: string) {
-		this.dbFilePath =
-			customDBPath ??
-			path.join(
-				pkgDirSync({ cwd: path.resolve(__dirname, "../../..") }) ?? "",
-				".cx-cache",
-				"db.json",
-			);
-	}
-
-	async read(customDBFilePath?: string): Promise<RenderDB> {
-		try {
-			const raw = await fsp.readFile(customDBFilePath || this.dbFilePath, "utf-8");
-			return JSON.parse(raw) as RenderDB;
-		} catch (error) {
-			if (error instanceof Error) {
-				console.error(`Error reading DB file at ${this.dbFilePath}:`, error.message);
-			} else {
-				console.error(`Unknown error reading DB file at ${this.dbFilePath}:`, error);
-			}
-			throw error;
-		}
-	}
-
-	async write(renderDB: RenderDB): Promise<void> {
-		try {
-			await fsp.mkdir(path.dirname(this.dbFilePath), { recursive: true });
-			await fsp.writeFile(this.dbFilePath, JSON.stringify(renderDB, null, 2));
-		} catch (error) {
-			if (error instanceof Error) {
-				console.error(`Error writing to DB file at ${this.dbFilePath}:`, error.message);
-			} else {
-				console.error(`Unknown error writing to DB file at ${this.dbFilePath}:`, error);
-			}
-			throw error;
-		}
-	}
-}

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/npm-deps/pkg-dir";
-
-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 };

package/exporter/types/render.ts

@@ -1,59 +0,0 @@
-import type { RenderInfo } from "./global";
-
-const RENDER_MODE = {
-	FROM_SCRATCH: "FROM_SCRATCH",
-	INCREMENTAL: "INCREMENTAL",
-	IDLE: "IDLE",
-} as const;
-
-type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
-
-export interface RenderModeTuple {
-	renderMode: RenderMode;
-	reason?: string;
-}
-
-type DomainLike = string;
-
-type RenderDB = {
-	proDomainPrefix: string;
-	griddoVersion: string;
-	buildReportFileName: string;
-	sortedDomains: Array<DomainLike>;
-	paths: {
-		root: string;
-		cx: string;
-		ssg: string;
-		cxCache: string;
-		components: string;
-		exportsDir: string;
-	};
-	domains: {
-		[key: DomainLike]: {
-			renderMode?: RenderMode;
-			shouldBeRendered?: boolean;
-			isRendering?: boolean;
-			renderInfo?: RenderInfo;
-			renderModeReason?: string;
-		};
-	};
-};
-
-interface Report {
-	authControl:
-		| {
-				Authorization: string;
-				"Cache-Control": string;
-				lang?: string | undefined;
-		  }
-		| undefined;
-	sites: Array<{
-		siteId: number;
-		publishHashes: Array<string>;
-		siteHash: string | null;
-		unpublishHashes: Array<string>;
-		publishPagesIds: Array<number>;
-	}>;
-}
-
-export { RENDER_MODE, type RenderDB, type RenderMode, type Report };

package/exporter/utils/artifacts.ts

@@ -1,38 +0,0 @@
-import type { Artifacts } from "../types/global";
-
-import path from "node:path";
-
-import { getRenderPathsFromDB } from "./render";
-
-/**
- * Returns the artifacts of CX.
- */
-async function getCxArtifacts(domain: string): Promise<Artifacts> {
-	const { __exports, __cache, __root, __ssg } = await getRenderPathsFromDB({ domain });
-
-	return {
-		initials: [
-			__exports, // `<root>/exports/<domain>`
-			__cache, // `<root>/.cx-cache/<domain>`
-			path.join(__exports, "logs"),
-			path.join(__root, "store"),
-			path.join(__root, "apiCache"),
-		],
-		disposables: [
-			path.join(__root, "store"),
-			path.join(__root, "apiCache"),
-			path.join(__root, "dist"),
-			path.join(__root, "dist-restored"),
-			path.join(__root, "assets"),
-			path.join(__root, "render-detail-log.txt"),
-			path.join(__ssg, "domains.json"),
-			path.join(__ssg, "domains.txt"),
-			path.join(__ssg, "render-metadata.json"),
-		],
-		cacheables: [],
-		archivables: ["dist", "assets"],
-		restaurable: ["dist"],
-	};
-}
-
-export { getCxArtifacts };

package/exporter/utils/brush.ts

@@ -1,34 +0,0 @@
-//
-// Brush adds color to a string|number, it does not print it!
-// Its simple, no log, no chains, just color in a string|number
-// usage:
-// console.log(brush.green("sucess!"))
-//
-
-const RESET = "\x1b[0m";
-const CODES = {
-	black: "\x1b[30m",
-	red: "\x1b[31m",
-	green: "\x1b[32m",
-	yellow: "\x1b[33m",
-	blue: "\x1b[34m",
-	magenta: "\x1b[35m",
-	cyan: "\x1b[36m",
-	white: "\x1b[37m",
-	gray: "\x1b[90m",
-	bold: "\x1b[1m",
-	dim: "\x1b[2m",
-} as const;
-
-type ColorFunction = (text: string | number) => string;
-type ColorName = keyof typeof CODES;
-type Brush = Record<ColorName, ColorFunction>;
-
-const brush = {} as Brush;
-
-for (const color in CODES) {
-	const key = color as ColorName;
-	brush[key] = (text: string | number) => `${CODES[key]}${text}${RESET}`;
-}
-
-export { brush };