@griddo/cx 10.3.26 → 10.4.0

package/exporter/adapters/astro/index.ts

@@ -1,8 +1,7 @@
-import { getInstanceDomains } from "@exporter/utils/domains";
-import { downloadBuildData } from "@exporter/utils/download-build-data";
-import { printExporterLogo } from "@exporter/utils/shared";
-
 import { getAstroDomainRunner } from "./utils";
+import { getInstanceDomains } from "../../utils/domains";
+import { createBuildData } from "../../utils/download-build-data";
+import { printExporterLogo } from "../../utils/shared";
 
 /**
  * Astro adapter for Griddo.
@@ -25,7 +24,7 @@ async function runAstroAdapter() {
 		// Download domain build data (sites, pages, etc) and generator a folder  //
 		// called `store` where all the domain render data is saved.              //
 		// ---------------------------------------------------------------------- //
-		await downloadBuildData();
+		await createBuildData(domain);
 
 		// ---------------------------------------------------------------------- //
 		// Call the `astro build` command.                                        //

package/exporter/adapters/astro/utils.ts

@@ -1,6 +1,7 @@
-import { getEnvRunner } from "@exporter/utils/runners";
 import dotenv from "dotenv";
 
+import { getEnvRunner } from "../../utils/runners";
+
 dotenv.config();
 
 /**

package/exporter/adapters/gatsby/index.ts

@@ -1,104 +1,174 @@
-import { getInstanceDomains } from "@exporter/utils/domains";
-import { downloadBuildData } from "@exporter/utils/download-build-data";
-import { uploadSearchContentToAPI } from "@exporter/utils/searches";
+import type { LifeCycles } from "../../types/global";
+
+import { getGatsbyDomainRunner } from "./utils";
+import { getInstanceDomains } from "../../utils/domains";
+import { createBuildData } from "../../utils/download-build-data";
+import { clearEmptyDirs } from "../../utils/folders";
+import { printWarningMessage } from "../../utils/messages";
+import { uploadSearchContentToAPI } from "../../utils/searches";
 import {
 	measureExecutionTime,
+	pause,
 	printExporterLogo,
-} from "@exporter/utils/shared";
-
-import { getGatsbyDomainRunner } from "./utils";
+	startLifeCycle,
+	successLifeCyle,
+} from "../../utils/shared";
 
 /**
  * Gatsby adapter for Griddo.
  */
-async function runGatsbyAdapter() {
+async function runGatsbyAdapter(lifeCycles: LifeCycles) {
 	printExporterLogo("gatsby");
+	const { doArchive, doData, doRestore, doMeta, doSSG } = lifeCycles;
 
 	let exeTime = 0;
 	const domains = await getInstanceDomains();
+	if (!domains.length) {
+		printWarningMessage(
+			"We didn't find any domains to render during the adapter phase.",
+			"getInstanceDomains",
+			"Function getInstanceDomains returned an empty array of domains. Check if the domains are correctly set in the instance's database."
+		);
+		process.exit(1);
+	}
 
 	for (const domain of domains) {
 		const runner = getGatsbyDomainRunner(domain);
 
-		/*
+		/**
+		 * Phases:
+		 * - Prepare.
+		 * - Folders.
+		 * - Restore.
+		 *
 		 * Init the render, restore Gatsby `.cache` and `public` folders.
 		 */
-		exeTime = await measureExecutionTime(
-			runner.init,
-			runner.restoreArtifacts,
-			runner.restoreCacheArtifacts
-		).catch((err) => {
-			console.error(
-				"Error in init() || restoreArtifacts() || restoreCacheArtifacts() :",
-				err?.stdout?.toString() || err
-			);
-			process.exit(1);
-		});
+		if (doRestore) {
+			startLifeCycle(`Restore ${domain}`);
 
-		console.info(`success restore ${domain} - ${exeTime}s`);
+			exeTime = await measureExecutionTime(
+				runner.init,
+				() => pause("init done!"),
+				runner.restoreArtifacts,
+				() => pause("Restore `dist` and `assets` folders done!"),
+				runner.restoreCacheArtifacts,
+				() => pause("Restore `apiCache`, `store` and `.cache` restored!")
+				// runner.cleanUpSites,
+				// () => pause("cleanUpSites done!")
+			).catch((err) => {
+				console.error(
+					"Error in init() || restoreArtifacts() || restoreCacheArtifacts() :",
+					err?.stdout?.toString() || err
+				);
+				process.exit(1);
+			});
 
-		/*
+			successLifeCyle(`Restore ${domain} - ${exeTime}s`);
+		}
+
+		/**
+		 * Phases:
+		 * - Data.
+		 *
 		 * Download domain build data (sites, pages, etc) and generator a folder
 		 * called `store` where all the domain render data is saved.
 		 */
-		exeTime = await measureExecutionTime(
-			async () => await downloadBuildData(domain)
-		).catch((err) => {
-			console.error(
-				"Error in downloadBuildData() :",
-				err?.stdout?.toString() || err
-			);
-			process.exit(1);
-		});
-		console.info(`success download ${domain} - ${exeTime}s`);
+		if (doData) {
+			startLifeCycle(`Data ${domain}`);
 
-		/*
+			exeTime = await measureExecutionTime(
+				async () => await createBuildData(domain),
+				() => pause("Download data from API to store folder done!")
+			).catch((err) => {
+				console.error(
+					"Error in createBuildData() :",
+					err?.stdout?.toString() || err
+				);
+				process.exit(1);
+			});
+
+			successLifeCyle(`Data ${domain} - ${exeTime}s`);
+		}
+
+		/**
+		 * Phases:
+		 * - SSG.
+		 *
 		 * Call the `gatsby build` command.
 		 * Gatsby will use the downloaded data and create the static build.
 		 * `gatsby-node.ts` is the main file where the stati generation happens.
 		 */
-		exeTime = await measureExecutionTime(runner.runGatsbyBuild).catch((err) => {
-			console.error(
-				"Error in runGatsbyBuild() :",
-				err?.stdout?.toString() || err
-			);
-			process.exit(1);
-		});
+		if (doSSG) {
+			startLifeCycle(`SSG ${domain}`);
 
-		console.info(`success gatsby build command - ${exeTime}s`);
-
-		/*
-		* Gatsby build is done, if the .env GRIDDO_SEARCH_FEATURE is set to true 
-		* we save the search data in the API. 
-		*/
-		const shouldUploadSearchData = JSON.parse(process.env.GRIDDO_SEARCH_FEATURE || "false");
-		if (shouldUploadSearchData) {
-			exeTime = await measureExecutionTime(uploadSearchContentToAPI).catch((err) => {
+			exeTime = await measureExecutionTime(runner.runGatsbyBuild, () =>
+				pause("Gatsby build done!")
+			).catch((err) => {
 				console.error(
-					"Error while uploads search content in DDBB :",
+					"Error in runGatsbyBuild() :",
 					err?.stdout?.toString() || err
 				);
 				process.exit(1);
 			});
-	
-			console.info(`success upload search information to DDBB - ${exeTime}s`);
+
+			successLifeCyle(`SSG ${domain} - ${exeTime}s`);
 		}
+
 		/*
+		 * Gatsby build is done, if the .env GRIDDO_SEARCH_FEATURE is set to true
+		 * we save the search data in the API.
+		 */
+		if (doMeta) {
+			startLifeCycle(`Meta ${domain}`);
+
+			const shouldUploadSearchData = JSON.parse(
+				process.env.GRIDDO_SEARCH_FEATURE || "false"
+			);
+			if (shouldUploadSearchData) {
+				exeTime = await measureExecutionTime(uploadSearchContentToAPI).catch(
+					(err) => {
+						console.error(
+							"Error while uploads search content in DDBB :",
+							err?.stdout?.toString() || err
+						);
+						process.exit(1);
+					}
+				);
+
+				successLifeCyle(`Meta ${domain} - ${exeTime}s`);
+			}
+		}
+
+		/**
+		 * Phases:
+		 * - Clean.
+		 * - Archive.
+		 *
 		 * When Gatsby ends, remove disposable artifacts and save .cache and
 		 * public foler to use in the next render.
 		 */
-		exeTime = await measureExecutionTime(
-			runner.removeDisposableArtifacts,
-			runner.archiveArtifacts,
-			runner.archiveCacheArtifacts
-		).catch((err) => {
-			console.error(
-				"Error in removeDisposableArtifacts() || archiveArtifacts()|| archiveCacheArtifacts() :",
-				err?.stdout?.toString() || err
-			);
-			process.exit(1);
-		});
-		console.info(`success archive ${domain} - ${exeTime}s`);
+		if (doArchive) {
+			startLifeCycle(`Archive ${domain}`);
+
+			exeTime = await measureExecutionTime(
+				() => clearEmptyDirs(),
+				() => pause("Clean empty dirs!"),
+				runner.removeDisposableArtifacts,
+				() => pause("Clean `public` done!"),
+				runner.archiveArtifacts,
+				() => pause("Archive dist and assets done!"),
+				runner.archiveCacheArtifacts,
+				() => pause("Archive apiCache, .cache and store done!")
+			).catch((err) => {
+				console.error(
+					"Error in removeDisposableArtifacts() || archiveArtifacts()|| archiveCacheArtifacts() :",
+					err?.stdout?.toString() || err
+				);
+				process.exit(1);
+			});
+
+			successLifeCyle(`Archive ${domain} - ${exeTime}s`);
+		}
 	}
 }
 

package/exporter/adapters/gatsby/utils.ts

@@ -1,11 +1,14 @@
 import fs from "node:fs";
 import path from "node:path";
 
-import { getEnvRunner } from "@exporter/utils/runners";
-import { CXRootFolder, instanceRootFolder } from "@exporter/utils/shared";
 import chalk from "chalk";
 import dotenv from "dotenv";
 
+import { deleteSites } from "../../utils/folders";
+import { getEnvRunner } from "../../utils/runners";
+import { CXRootFolder, instanceRootFolder } from "../../utils/shared";
+import { checkSites } from "../../utils/sites";
+
 dotenv.config();
 
 /**
@@ -17,11 +20,11 @@ function getGatsbyDomainRunner(domain: string) {
 
 	// Artifacts to remove after export
 	// if STRIP_DOMAIN_FROM_PATH is false `.cache` will be added.
-	const artifactsDisposable = ["public", "store"];
+	const artifactsDisposable = ["public"];
 
 	// Artifacts to make exports faster
 	// if STRIP_DOMAIN_FROM_PATH is true `.cache` will be added.
-	const artifactsCache = ["apiCache" /* , ".cache" */];
+	const artifactsCache = ["apiCache", "store" /* , ".cache" */];
 
 	// TODO: Remove STRIP_DOMAIN_FROM_PATH behaviour when all instances are over 1.75.219
 	const STRIP_DOMAIN_FROM_PATH = JSON.parse(
@@ -268,6 +271,16 @@ function getGatsbyDomainRunner(domain: string) {
 		}
 	};
 
+	/**
+	 * Remove sites folder from restoring phase.
+	 */
+	const cleanUpSites = async () => {
+		const { sitesToPublish, sitesToUnpublish } = await checkSites(domain);
+
+		await deleteSites(sitesToUnpublish, domain);
+		await deleteSites(sitesToPublish, domain);
+	};
+
 	/**
 	 * Restore Gatsby cache artifacts from a previous render to improve
 	 * performance.
@@ -350,6 +363,7 @@ function getGatsbyDomainRunner(domain: string) {
 		deleteArtifactBackup,
 		archiveCacheArtifacts,
 		restoreCacheArtifacts,
+		cleanUpSites,
 		runGatsbyBuild,
 		removeDisposableArtifacts,
 	};

package/exporter/build-complete.ts

@@ -28,6 +28,9 @@ type Report = {
 	}>;
 };
 
+/**
+ * Informa a la API del estado de publicación de los sites: published y unpublished.
+ */
 export async function buildComplete(report: Report) {
 	await AuthService.login();
 
@@ -45,13 +48,16 @@ export async function buildComplete(report: Report) {
 }
 
 function getExportedDomains() {
-	const domains = fs.readdirSync(exportArchiveBasePath);
+	const domains = fs
+		.readdirSync(exportArchiveBasePath)
+		// Avoid empty files, usually .DS_Store from local renders.
+		.filter((file) => !file.startsWith("."));
 
 	return domains;
 }
 
 function getBuildReports(domains: Array<string>) {
-	const reports = [];
+	const reports: Array<Report> = [];
 
 	for (const domain of domains) {
 		const buildReportFile = path.resolve(

package/exporter/create-build-data.ts

@@ -0,0 +1,22 @@
+import { getInstanceDomains } from "./utils/domains";
+import { createBuildData } from "./utils/download-build-data";
+
+async function main() {
+	const domains = await getInstanceDomains();
+
+	for (const domain of domains) {
+		createBuildData(domain).catch((err) => {
+			console.error("Error", err?.stdout?.toString() || err);
+			process.exit(1);
+		});
+		process.exit(0);
+	}
+}
+
+main().catch((err) => {
+	console.error(
+		"Error in create-build-data.ts:",
+		err?.stdout?.toString() || err
+	);
+	process.exit(1);
+});

package/exporter/index.ts

@@ -2,9 +2,21 @@
 /* eslint-disable node/shebang */
 
 import { runGatsbyAdapter } from "./adapters";
+import { logBox, measureExecutionTime } from "./utils/shared";
 
 async function main() {
-	await runGatsbyAdapter();
+	const exeTime = await measureExecutionTime(() =>
+		runGatsbyAdapter({
+			doRestore: true,
+			doData: true,
+			doSSG: true,
+			doRelocation: true,
+			doMeta: true,
+			doArchive: true,
+		})
+	);
+	logBox(`All domains rendered in ${exeTime}s.`, "", 1, 0);
+	process.exit(0);
 }
 
 // Go render, go!

package/exporter/services/distributors.ts

@@ -89,7 +89,8 @@ class DistributorService {
 		// Distrubutor with `hasDistributorDat: true` but without `data` prop
 		if (!data) {
 			logBox(
-				`Error: Page ${page.id} has \`hasDistributorData: true\` but it doesn't have a \`data\` prop`
+				`Error: Page ${page.id} has \`hasDistributorData: true\` but it doesn't have a \`data\` prop`,
+				"No data in ReferenceField"
 			);
 
 			return [];
@@ -98,7 +99,8 @@ class DistributorService {
 		// Avoid fetch distributors with empty `data.sources`
 		if (Array.isArray(data.sources) && data.sources.length < 1) {
 			logBox(
-				`Warning: Page with id: ${page.id} has a ReferenceField with empty \`data.sources\``
+				`Warning: Page with id: ${page.id} has a ReferenceField with empty \`data.sources\``,
+				"Empty data.sources in ReferenceField"
 			);
 
 			return [];