@griddo/cx 11.7.5 → 11.7.6-rc.0

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

@@ -0,0 +1,70 @@
+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/index.ts

@@ -1,162 +1,76 @@
-import type {
-	Artifacts,
-	LifeCyclesNames,
-	LifeCycleSteps,
-} from "../../types/global";
+import type { SSG } from "./shared/types";
 
 import path from "node:path";
 
-import {
-	createDistFromGatsbyPublic,
-	getGatsbyAssetPrefixWithDomain,
-	runGatsbyBuildCommand,
-} from "./utils";
-import getCxArtifacts from "../../artifacts";
-import { AuthService } from "../../services/auth";
-import {
-	createDomainMetadata,
-	doLifeCycle,
-	getConfig,
-	saveBuildEndLogs,
-} from "../../utils/core-utils";
-import { createDomainRenderData } from "../../utils/create-build-data";
-import {
-	copyArtifacts,
-	createArtifacts,
-	deleteDisposableSiteDirs,
-	moveArtifacts,
-	removeArtifacts,
-	removeVirtualPagesFromStore,
-	renameArtifact,
-} from "../../utils/folders";
+import { GRIDDO_ASSET_PREFIX } from "../../constants/envs";
+import { getCxArtifacts } from "../../utils/artifacts";
+import { doLifeCycle } from "../../utils/core-utils";
 import { infoLog } from "../../utils/loggin";
-import {
-	createSentinelRenderFile,
-	deleteSentinelRenderFile,
-	isValidRender,
-} from "../../utils/render";
+import { getRenderMetadataFromDB, getRenderMode, getRenderPathsFromDB } from "../../utils/render";
+import { cleanAction } from "./actions/clean";
+import { closeAction } from "./actions/close";
+import { dataAction } from "./actions/data";
+import { healthCheckAction } from "./actions/healthCheck";
+import { initAction } from "./actions/init";
+import { metaAction } from "./actions/meta";
+import { prepareAction } from "./actions/prepare";
+import { relocationAction } from "./actions/relocation";
+import { restoreAction } from "./actions/restore";
+import { ssgAction } from "./actions/ssg";
+import { syncAction } from "./actions/sync";
+import { RenderContext } from "./shared/context";
 
 /**
- * Render every instance domain with the Gatsby adapter.
+ * Executes a complete Gatsby render process for a given domain.
+ *
+ * The render process consists of multiple lifecycle steps that handle cleaning,
+ * preparing, building and syncing the site. It can run in two modes:
+ * - FROM_SCRATCH: Performs a complete rebuild of the site
+ * - INCREMENTAL: Only rebuilds changed pages while preserving the rest
  */
-export async function renderDomainsWithGatsbyAdapter(domain: string) {
-	await AuthService.login();
-	const config = getConfig();
+export async function gatsbyRenderDomain(domain: string) {
+	const { renderMode, reason } = await getRenderMode(domain);
 
-	infoLog(`Initializing render for the domain ${domain}\n`);
-
-	const {
-		//
-		__ssg,
-		__exports,
-		__cache,
-		__cx,
-		__components,
-	} = config.paths(domain);
+	if (renderMode === "IDLE") {
+		return;
+	}
 
-	// Griddo artifacts
-	const cxArtifacts = getCxArtifacts(domain);
+	const renderReason = reason ? `<${reason}>` : "";
+	infoLog(`Init render (${renderMode}) ${renderReason} for domain ${domain}\n`);
 
-	// Gatsby artifacts
-	const gatsbyArtifacts: Pick<Artifacts, "disposables" | "cacheables"> = {
+	const renderMetadata = await getRenderMetadataFromDB();
+	const paths = await getRenderPathsFromDB({ domain });
+	const cxArtifacts = await getCxArtifacts(domain);
+	const domainNeedsAssetPrefix = GRIDDO_ASSET_PREFIX && domain.startsWith(renderMetadata.proDomain);
+	const assetPrefix = domainNeedsAssetPrefix ? `${GRIDDO_ASSET_PREFIX}/${domain}` : "";
+	const ssgArtifacts = {
 		disposables: [
-			path.join(__ssg, "public"),
-			path.join(__ssg, "static"),
-			path.join(__ssg, ".cache"),
+			path.join(paths.__ssg, "public"),
+			path.join(paths.__ssg, "static"),
+			path.join(paths.__ssg, ".cache"),
+			path.join(paths.__ssg, "domains.json"), // Este disposable es de griddo pero está en la ruta __ssg
 		],
 		cacheables: [".cache"],
 	};
 
-	// These variables are involved in the build for create the dist directory
-	// from public and pass to the gatsby-build command via spawnSync.
-	const assetPrefix = getGatsbyAssetPrefixWithDomain(domain);
-	const needsAssetPrefix = !!assetPrefix && assetPrefix !== "";
-
-	// Compose artifacts
-	const disposableArtifacts = [
-		...cxArtifacts.disposables,
-		...gatsbyArtifacts.disposables,
-	];
-
-	// LifeCycles
-
-	const allLifeCycles: Array<{
-		name: LifeCyclesNames;
-		steps: LifeCycleSteps;
-	}> = [
-		{
-			name: "Init",
-			steps: [() => createSentinelRenderFile()],
-		},
-
-		{
-			name: "Clean",
-			steps: [() => removeArtifacts(disposableArtifacts)],
-		},
-
-		{
-			name: "Prepare",
-			steps: [() => createArtifacts(cxArtifacts.initials)],
-		},
-
-		{
-			name: "Restore",
-			steps: [
-				() => copyArtifacts(__components, __ssg, ["static"]),
-				() => copyArtifacts(__exports, __cx, cxArtifacts.archivables),
-				() =>
-					renameArtifact(path.join(__cx, "dist"), path.join(__ssg, "public")),
-				() => moveArtifacts(__cache, __cx, cxArtifacts.cacheables),
-				() => moveArtifacts(__cache, __ssg, gatsbyArtifacts.cacheables),
-			],
-		},
-
-		{
-			name: "Data",
-			steps: [() => createDomainRenderData(domain)],
-		},
-
-		{
-			name: "SSG",
-			steps: [() => runGatsbyBuildCommand(assetPrefix)],
-		},
-
-		{
-			name: "Relocation",
-			steps: [() => createDistFromGatsbyPublic(domain, needsAssetPrefix)],
-		},
-
-		{
-			name: "Meta",
-			steps: [() => createDomainMetadata(domain), () => saveBuildEndLogs()],
-		},
-
-		{
-			name: "Archive",
-			steps: [
-				() => removeVirtualPagesFromStore(),
-				() => deleteDisposableSiteDirs(),
-				() =>
-					moveArtifacts(__cx, __exports, cxArtifacts.archivables, {
-						withBackup: true,
-					}),
-				() => moveArtifacts(__cx, __cache, cxArtifacts.cacheables),
-				() => moveArtifacts(__ssg, __cache, gatsbyArtifacts.cacheables),
-			],
-		},
-
-		{
-			name: "Close",
-			steps: [() => removeArtifacts(disposableArtifacts)],
-		},
-
-		{
-			name: "HealthCheck",
-			steps: [() => isValidRender(), () => deleteSentinelRenderFile()],
-		},
-	];
-
-	for (const { name, steps } of allLifeCycles) {
-		await doLifeCycle(name, steps);
-	}
+	const context = new RenderContext<SSG>({
+		domain,
+		renderMode,
+		paths,
+		renderMetadata,
+		cxArtifacts,
+		ssg: { assetPrefix, ssgArtifacts },
+	});
+
+	await doLifeCycle("Init", async () => initAction(context));
+	await doLifeCycle("Clean", async () => cleanAction(context));
+	await doLifeCycle("Prepare", async () => prepareAction(context));
+	await doLifeCycle("Restore", async () => restoreAction(context));
+	await doLifeCycle("Data", async () => dataAction(context));
+	await doLifeCycle("SSG", async () => ssgAction(context));
+	await doLifeCycle("Relocation", async () => relocationAction(context));
+	await doLifeCycle("Meta", async () => metaAction(context));
+	await doLifeCycle("Sync", async () => syncAction(context));
+	await doLifeCycle("Close", async () => closeAction(context));
+	await doLifeCycle("HealthCheck", async () => healthCheckAction(context));
 }

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

@@ -0,0 +1,50 @@
+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

@@ -0,0 +1,61 @@
+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

@@ -0,0 +1,54 @@
+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 };