@griddo/cx 10.4.2 → 10.4.4

package/exporter/adapters/astro/index.ts

@@ -14,14 +14,14 @@ async function runAstroAdapter() {
 	for (const domain of domains) {
 		const runner = getAstroDomainRunner(domain);
 		// ---------------------------------------------------------------------- //
-		// Init the render, restore Gatsby /.cache and /public folders            //
+		// Init the render, restore Gatsby /.cache and /public dirs               //
 		// ---------------------------------------------------------------------- //
 		runner.init();
 		// runner.whatEverAction();
 		// runner.otherAstroRelatedFunction();
 
 		// ---------------------------------------------------------------------- //
-		// Download domain build data (sites, pages, etc) and generator a folder  //
+		// Download domain build data (sites, pages, etc) and generator a dirs    //
 		// called `store` where all the domain render data is saved.              //
 		// ---------------------------------------------------------------------- //
 		await createBuildData(domain);

package/exporter/adapters/gatsby/index.ts

@@ -1,174 +1,96 @@
-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,
-	startLifeCycle,
-	successLifeCyle,
-} from "../../utils/shared";
+import { doLifeCycle, pause, printExporterLogo } from "../../utils/shared";
 
-/**
- * Gatsby adapter for Griddo.
- */
-async function runGatsbyAdapter(lifeCycles: LifeCycles) {
+async function runGatsbyAdapter() {
 	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.
+		 * Restore
 		 *
-		 * Init the render, restore Gatsby `.cache` and `public` folders.
+		 * Init the render, restore Gatsby `.cache` and `public` dirs.
 		 */
-		if (doRestore) {
-			startLifeCycle(`Restore ${domain}`);
-
-			exeTime = await measureExecutionTime(
+		await doLifeCycle({
+			name: "Restore",
+			steps: [
 				runner.init,
 				() => pause("init done!"),
 				runner.restoreArtifacts,
-				() => pause("Restore `dist` and `assets` folders done!"),
+				() => pause("Restore `dist` and `assets` dirs 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`);
-		}
+				() => pause("Restore `apiCache`, `store` and `.cache` restored!"),
+			],
+		});
 
 		/**
-		 * Phases:
-		 * - Data.
+		 * Data
 		 *
-		 * Download domain build data (sites, pages, etc) and generator a folder
+		 * Download domain build data (sites, pages, etc) and create a dir
 		 * called `store` where all the domain render data is saved.
 		 */
-		if (doData) {
-			startLifeCycle(`Data ${domain}`);
-
-			exeTime = await measureExecutionTime(
+		await doLifeCycle({
+			name: "Data",
+			steps: [
 				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`);
-		}
+				() => pause("Download data from API to `store` dir done!"),
+			],
+		});
 
 		/**
-		 * Phases:
-		 * - SSG.
+		 * 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.
 		 */
-		if (doSSG) {
-			startLifeCycle(`SSG ${domain}`);
-
-			exeTime = await measureExecutionTime(runner.runGatsbyBuild, () =>
-				pause("Gatsby build done!")
-			).catch((err) => {
-				console.error(
-					"Error in runGatsbyBuild() :",
-					err?.stdout?.toString() || err
-				);
-				process.exit(1);
-			});
+		await doLifeCycle({
+			name: "SSG",
+			steps: [runner.runGatsbyBuild, () => pause("Gatsby build done!")],
+		});
 
-			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.
+		/**
+		 * Meta
+		 *
+		 * 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`);
-			}
-		}
+		const shouldUploadSearchData = JSON.parse(
+			process.env.GRIDDO_SEARCH_FEATURE || "false"
+		);
+		await doLifeCycle({
+			name: "Meta",
+			steps: [
+				() => (shouldUploadSearchData ? uploadSearchContentToAPI() : undefined),
+			],
+		});
 
 		/**
-		 * Phases:
-		 * - Clean.
-		 * - Archive.
+		 * Archive
 		 *
 		 * When Gatsby ends, remove disposable artifacts and save .cache and
 		 * public foler to use in the next render.
 		 */
-		if (doArchive) {
-			startLifeCycle(`Archive ${domain}`);
-
-			exeTime = await measureExecutionTime(
+		await doLifeCycle({
+			name: "Archive",
+			steps: [
 				() => clearEmptyDirs(),
-				() => pause("Clean empty dirs!"),
+				() => pause("Clean empty dirs done!"),
 				runner.removeDisposableArtifacts,
 				() => pause("Clean `public` done!"),
 				runner.archiveArtifacts,
-				() => pause("Archive dist and assets done!"),
+				() => 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`);
-		}
+				() => pause("Archive `apiCache`, `.cache` and `store` done!"),
+			],
+		});
 	}
 }
 

package/exporter/adapters/gatsby/utils.ts

@@ -6,7 +6,7 @@ import dotenv from "dotenv";
 
 import { deleteSites } from "../../utils/folders";
 import { getEnvRunner } from "../../utils/runners";
-import { CXRootFolder, instanceRootFolder } from "../../utils/shared";
+import { CXRootDir, instanceRootDir } from "../../utils/shared";
 import { checkSites } from "../../utils/sites";
 
 dotenv.config();
@@ -38,10 +38,7 @@ function getGatsbyDomainRunner(domain: string) {
 	}
 
 	// Where we are going to find archived exports
-	const exportArchiveBasePath = path.resolve(
-		instanceRootFolder,
-		"exports/sites"
-	);
+	const exportArchiveBasePath = path.resolve(instanceRootDir, "exports/sites");
 	const exportCachesArchivePath = path.resolve(__dirname, "../caches");
 
 	const assetPrefix = getGatsbyAssetPrefixSlug(domain);
@@ -55,7 +52,7 @@ function getGatsbyDomainRunner(domain: string) {
 
 	/**
 	 * Initialize exporter clearing artifacts data from a unsuccessful build and
-	 * creating necesary folders to store a new build.
+	 * creating necesary dirs to store a new build.
 	 */
 	const init = () => {
 		console.info(`Initializing exporter for the domain ${domain}`);
@@ -115,7 +112,7 @@ function getGatsbyDomainRunner(domain: string) {
 		);
 
 		const currentExportBackupPath = `${currentExportArchivePath}-BACKUP`;
-		const currentExportWorkingPath = path.resolve(CXRootFolder, artifact);
+		const currentExportWorkingPath = path.resolve(CXRootDir, artifact);
 
 		return {
 			domainExportArchiveBasePath,
@@ -148,7 +145,7 @@ function getGatsbyDomainRunner(domain: string) {
 	};
 
 	/**
-	 * Creates necesary folders.
+	 * Creates necesary dirs.
 	 */
 	const createBaseExportPaths = () => {
 		const {
@@ -272,7 +269,7 @@ function getGatsbyDomainRunner(domain: string) {
 	};
 
 	/**
-	 * Remove sites folder from restoring phase.
+	 * Remove sites dir from restoring phase.
 	 */
 	const cleanUpSites = async () => {
 		const { sitesToPublish, sitesToUnpublish } = await checkSites(domain);

package/exporter/build-complete.ts

@@ -6,7 +6,7 @@ import pkgDir from "pkg-dir";
 import { AuthService } from "./services/auth";
 import { SitesService } from "./services/sites";
 
-// Where we are going to find export folders
+// Where we are going to find export dirs
 const execBasePath = pkgDir.sync(path.resolve(__dirname, "../.."))!;
 
 // Where we are going to find archived exports

package/exporter/index.ts

@@ -5,15 +5,12 @@ import { runGatsbyAdapter } from "./adapters";
 import { logBox, measureExecutionTime } from "./utils/shared";
 
 async function main() {
-	const exeTime = await measureExecutionTime(() =>
-		runGatsbyAdapter({
-			doRestore: true,
-			doData: true,
-			doSSG: true,
-			doRelocation: true,
-			doMeta: true,
-			doArchive: true,
-		})
+	const exeTime = await measureExecutionTime(() => runGatsbyAdapter()).catch(
+		(e) => {
+			console.log(e);
+			console.log("[[[ Render will be reset ]]]");
+			process.exit(1);
+		}
 	);
 	logBox(`All domains rendered in ${exeTime}s.`, "", 1, 0);
 	process.exit(0);

package/exporter/services/store.ts

@@ -49,7 +49,7 @@ const buildProcessData: BuildProcessData = {};
  * Fetch, process and save object pages and sites data into the file system to
  * be consumed by other services (Griddo itself, Adapters, etc.)
  */
-async function createStore(storeFolder: string, domain: string) {
+async function createStore(storeDir: string, domain: string) {
 	console.info(`API calls with ${API_CONCURRENCY_COUNT} threads`);
 
 	try {
@@ -259,7 +259,7 @@ async function createStore(storeFolder: string, domain: string) {
 				}
 
 				// Save build data to store
-				savePagesInStore(storeFolder, griddoPageObjects);
+				savePagesInStore(storeDir, griddoPageObjects);
 			};
 
 			// Pages to be created or deleted in the store
@@ -268,7 +268,7 @@ async function createStore(storeFolder: string, domain: string) {
 				pagesMissingInStore,
 				pagesToDeleteFromStore,
 				pagesToWriteToStore,
-			} = await getPagesToCreateOrDelete(storeFolder, {
+			} = await getPagesToCreateOrDelete(storeDir, {
 				sitesToPublish,
 				pages,
 				validPagesIds,
@@ -276,7 +276,7 @@ async function createStore(storeFolder: string, domain: string) {
 			});
 
 			// Delete pages from published, unpublished and deleted sites.
-			removePagesFromStore(storeFolder, pagesToDeleteFromStore);
+			removePagesFromStore(storeDir, pagesToDeleteFromStore);
 
 			// Debug time
 			const changedPageLogs = `Store:               ${pagesInStore.length} -> ${pagesInStore}
@@ -302,7 +302,7 @@ async function createStore(storeFolder: string, domain: string) {
 		// Después de renderizar todos los sites y sus páginas (las que sean que
 		// hayan cambiado etc.) guardamos un archivo con la información del
 		// render para usos posteriores.
-		saveRenderInfoInStore(storeFolder, {
+		saveRenderInfoInStore(storeDir, {
 			buildProcessData,
 			createdPages,
 			sitesToPublish,

package/exporter/types/global.ts

@@ -76,20 +76,36 @@ interface RenderInfo {
 	sitesToPublish: Array<Site>;
 }
 
-type LifeCycles = {
-	doRestore?: boolean;
-	doData?: boolean;
-	doSSG?: boolean;
-	doRelocation?: boolean;
-	doMeta?: boolean;
-	doArchive?: boolean;
-};
+type LifeCyclesNames =
+	| "Prepare"
+	| "Restore"
+	| "Data"
+	| "SSG"
+	| "Relocation"
+	| "Meta"
+	| "Archive"
+	| "Clean";
+
+type CXDir = "__exports" | "__cache" | "__cx" | "__ssg";
+
+interface CXConfig {
+	proDomain: string;
+	CXDir: {
+		EXPORTS: "__exports";
+		CACHE: "__cache";
+		CX: "__cx";
+		SSG: "__ssg";
+	};
+	dirs: (domain: string) => Record<CXDir, string>;
+}
 
 export {
 	BuildProcessData,
+	CXConfig,
+	CXDir,
 	Domains,
 	FetchDataProps,
-	LifeCycles,
+	LifeCyclesNames,
 	Petition,
 	PostSearchInfoProps,
 	RenderInfo,

package/exporter/utils/cache.ts

@@ -12,9 +12,9 @@ const API_CACHE_DIR_PATH = path.resolve(__dirname, "./../apiCache");
 const SITE_HASH_FILENAME = `${API_CACHE_DIR_PATH}/siteHash.json`;
 
 /**
- * Creates an `apiCache` folder to store pages fetched from them API.
+ * Creates an `apiCache` dir to store pages fetched from them API.
  */
-function createAPICacheFolder() {
+function createAPICacheDir() {
 	if (!fs.existsSync(API_CACHE_DIR_PATH)) {
 		fs.mkdirSync(API_CACHE_DIR_PATH);
 	}
@@ -67,7 +67,7 @@ function saveCache<T>(petition: Petition, content: T) {
 }
 
 /**
- * Search in the `apiCache` folder for a file using the petition as hash generator.
+ * Search in the `apiCache` dir for a file using the petition as hash generator.
  * Return the file content if found or null if not.
  *
  * @param petition An object
@@ -124,5 +124,5 @@ export {
 	updatedSiteHash,
 	searchCacheData,
 	saveCache,
-	createAPICacheFolder,
+	createAPICacheDir,
 };

package/exporter/utils/download-build-data.ts

@@ -1,24 +1,24 @@
 import path from "node:path";
 
-import { createAPICacheFolder } from "./cache";
-import { sanitizeAPICacheFolder } from "./shared";
-import { createStoreFolder } from "./store";
+import { createAPICacheDir } from "./cache";
+import { sanitizeAPICacheDir } from "./shared";
+import { createStoreDir } from "./store";
 import { createStore } from "../services/store";
 
-const storeFolder = path.resolve(__dirname, "../store/");
-const apiCacheFolder = path.resolve(__dirname, "../apiCache");
+const storeDir = path.resolve(__dirname, "../store/");
+const apiCacheDir = path.resolve(__dirname, "../apiCache");
 
 /**
  * Download all data: sites, pages etc.. from the instance private Griddo API.
  * Then you can use the generator funcion `getBuildPages()` to get the pages and
  * `getBuildMetadata()` to get build and sites metadata as objects. Both from
- * exporter utils sites folder.
+ * exporter utils sites dir.
  */
 async function createBuildData(domain: string) {
-	createAPICacheFolder();
-	createStoreFolder(storeFolder);
-	await createStore(storeFolder, domain);
-	sanitizeAPICacheFolder(apiCacheFolder);
+	createAPICacheDir();
+	createStoreDir(storeDir);
+	await createStore(storeDir, domain);
+	sanitizeAPICacheDir(apiCacheDir);
 }
 
 export { createBuildData };