@griddo/cx 10.4.18 → 10.4.20

package/exporter/utils/folders.ts

@@ -3,26 +3,25 @@ import path from "node:path";
 
 import fsx, { MakeDirectoryOptions } from "fs-extra";
 
-import { CXRootDir } from "./shared";
 import { getPageInStoreDir, removePagesFromStore } from "./store";
 import { getConfig } from "./temp-utils";
 
+const config = getConfig();
+
 /**
  * Remove an empty directory from the basePath recursively.
  * If the directory has only .xml files it will handle as empty too (empty site)
  *
  * @param baseDir - The base directory.
  */
-const clearEmptyDirs = (baseDir?: string) => {
-	const dir = baseDir || path.resolve(CXRootDir, "dist");
-
-	const isDir = fsx.statSync(dir).isDirectory();
+const clearEmptyDirs = (baseDir: string) => {
+	const isDir = fsx.statSync(baseDir).isDirectory();
 	if (!isDir) {
 		return;
 	}
 
 	// archivos o direvtorios dentro de `dir`
-	let children = fsx.readdirSync(dir);
+	let children = fsx.readdirSync(baseDir);
 	// let children = childrenRaw.filter((file) => {
 	// 	return path.extname(file).toLowerCase() !== ".xml";
 	// });
@@ -40,25 +39,25 @@ const clearEmptyDirs = (baseDir?: string) => {
 		// Podemos borrarlos y dejar el dir vacío.
 		if (childrenCount === xmlCount) {
 			children.forEach(function (xmlFile) {
-				const fullPath = path.join(dir, xmlFile);
+				const fullPath = path.join(baseDir, xmlFile);
 				fsx.rmSync(fullPath);
 			});
-			children = fsx.readdirSync(dir);
+			children = fsx.readdirSync(baseDir);
 		}
 
 		children.forEach(function (file) {
-			const fullPath = path.join(dir, file);
+			const fullPath = path.join(baseDir, file);
 			clearEmptyDirs(fullPath);
 		});
 
 		// re-evaluate files; after deleting subdir we may have parent dir
 		// empty now...
-		children = fsx.readdirSync(dir);
+		children = fsx.readdirSync(baseDir);
 	}
 
 	// Si no tiene hijos, lo borramos
 	if (children.length === 0) {
-		fsx.rmdirSync(dir);
+		fsx.rmdirSync(baseDir);
 		return;
 	}
 };
@@ -245,12 +244,12 @@ function isVirtualPage(id: number) {
 }
 
 async function removeVirtualPagesFromStore() {
-	const config = getConfig();
-	const dirs = config.dirs();
-	const storePath = path.join(dirs.__cx, "store");
+	const { __cx } = config.paths();
+	const storePath = path.join(__cx, "store");
+
 	try {
 		const multiPageFiles = getPageInStoreDir(storePath).filter(isVirtualPage);
-		removePagesFromStore(storePath, multiPageFiles);
+		removePagesFromStore(multiPageFiles);
 	} catch (e) {
 		console.info(
 			"`store` folder does not exist. Skipping multipage or static list template cleaning."

package/exporter/utils/searches.ts

@@ -5,7 +5,8 @@ import fs from "node:fs";
 import path from "node:path";
 
 import { post } from "./api";
-import { getBuildPages } from "./store";
+import { getBuildPagesFromCachedStore } from "./store";
+import { getConfig } from "./temp-utils";
 
 // Envs
 const API_URL = process.env.API_URL as string;
@@ -106,21 +107,36 @@ function stripSpaces(str: string) {
  * Function that search in the `/public` dir the content info of the pages and
  * send it to the search table in the ddbb using the API.
  */
-async function uploadSearchContentToAPI() {
-	// Extraemos el path de la carpeta store
-	const storeDir = path.resolve(__dirname, `../store`);
+async function uploadRenderedSearchContentToAPI(
+	distDomainPath: string,
+	domain: string
+) {
+	const config = getConfig();
+	const { __caches } = config.paths(domain);
+
+	// Extraemos el path de la carpeta store dentro de un dominio
+	const storeFolder = path.join(__caches, "store");
+
+	// Este caso sería que el dominio existe en la instancia pero no hay sites
+	// renderizardos bajo el mismo. Por lo que `store` no existe.
+	if (!fs.existsSync(storeFolder)) {
+		console.log(
+			`Skipping uploading content to the search endpoint for the domain ${domain}, it has not exported sites.`
+		);
+		return;
+	}
 
-	for await (const store of getBuildPages(storeDir)) {
+	// Obtenemos las páginas del store cacheado de un dominio
+	const storePages = getBuildPagesFromCachedStore(domain);
+
+	for await (const store of storePages) {
 		const {
 			context: { page, openGraph },
 		} = store;
 
 		const { compose } = page.fullPath;
 
-		const contextPath = path.resolve(
-			__dirname,
-			`../dist/${compose}/index.html`
-		);
+		const contextPath = path.resolve(`${distDomainPath}/${compose}/index.html`);
 
 		const content = fs.readFileSync(contextPath).toString();
 
@@ -140,4 +156,4 @@ async function uploadSearchContentToAPI() {
 	}
 }
 
-export { postSearchInfo, uploadSearchContentToAPI };
+export { postSearchInfo, uploadRenderedSearchContentToAPI };

package/exporter/utils/shared.ts

@@ -12,6 +12,10 @@ import fs from "fs-extra";
 import gradient from "gradient-string";
 import pkgDir from "pkg-dir";
 
+import { getConfig } from "./temp-utils";
+
+const config = getConfig();
+
 dotenv.config();
 
 const GRIDDO_DEBUG_LOGS =
@@ -21,7 +25,6 @@ const GRIDDO_BUILD_LOGS =
 	(!!process.env.GRIDDO_BUILD_LOGS &&
 		!!JSON.parse(process.env.GRIDDO_BUILD_LOGS)) ||
 	(!!process.env.LOGS && !!JSON.parse(process.env.LOGS));
-const CXRootDir = pkgDir.sync(__dirname)!; // usually monorepo/packages/griddo-cx/
 const instanceRootDir = pkgDir.sync()!; // instance root dir
 
 /**
@@ -188,8 +191,9 @@ function siteList(sites: Array<Site>) {
  * Print the great Griddo Exporter logo in ASCII.
  */
 function printExporterLogo(adapter: Adapters) {
+	const { __cx } = config.paths();
 	const { version } = JSON.parse(
-		fs.readFileSync(path.resolve(__dirname, "../package.json"), "utf-8")
+		fs.readFileSync(path.join(__cx, "package.json"), "utf-8")
 	);
 	const logo = `
 ··
@@ -204,11 +208,11 @@ function printExporterLogo(adapter: Adapters) {
 /**
  * Remove unused files (old) inside the `apiCache` dir
  *
- * @param dirPath The path for the `apiCache` dir
  * @todo remove other file types: sites, socials, etc..
  */
-function sanitizeAPICacheDir(dirPath: string) {
-	// Read all `apiCache` file paths
+function sanitizeAPICacheDir() {
+	const { __cx } = config.paths();
+	const dirPath = path.join(__cx, "apiCache");
 	const allCachedFiles = fs.readdirSync(dirPath);
 
 	// Object to store the the more rencent file names
@@ -320,7 +324,8 @@ function successLifeCyle(value: string) {
  * @param args - The arguments object.
  * @param args.steps - An array of functions to execute.
  * @param args.name - The name of the life cycle.
- * @param [args.attempts=1] - The number of retry attempts allowed in case of errors.
+ * @param args.attempts=1 - The number of retry attempts allowed in case of errors.
+ * @param args.bypass - Skip the step functions.
  * @returns - A promise that resolves when the life cycle process is completed.
  */
 async function doLifeCycle(args: {
@@ -329,6 +334,7 @@ async function doLifeCycle(args: {
 	attempts?: number;
 }) {
 	const { steps, name, attempts } = args;
+
 	let trysCount = 0;
 	const maxTrysAccepted = attempts || 1;
 
@@ -351,12 +357,32 @@ async function doLifeCycle(args: {
 	}
 }
 
+function isVersionGreaterThan(versionA: string, versionB: string) {
+	const [majorA, minorA, patchA] = versionA.split(".").map(Number);
+	const [majorB, minorB, patchB] = versionB.split(".").map(Number);
+
+	if (majorA !== majorB) {
+		return majorA > majorB;
+	}
+
+	if (minorA !== minorB) {
+		return minorA > minorB;
+	}
+
+	return patchA > patchB;
+}
+
+function isVersionLowerThan(versionA: string, versionB: string) {
+	return !isVersionGreaterThan(versionA, versionB);
+}
+
 export {
-	CXRootDir,
 	debug,
 	delay,
 	doLifeCycle,
 	instanceRootDir,
+	isVersionGreaterThan,
+	isVersionLowerThan,
 	logBox,
 	logInfo,
 	logPageSize,

package/exporter/utils/sites.ts

@@ -29,6 +29,8 @@ const GRIDDO_RENDER_PAGES = (
 	.map((item) => parseInt(item))
 	.filter(Boolean);
 
+const config = getConfig();
+
 /**
  * Check the instance sites and returns site prepared to be published and unpublished.
  */
@@ -147,13 +149,9 @@ async function getSiteData(siteID: number) {
  * Save a file with the end of build process
  */
 async function generateBuildReport() {
-	const config = getConfig();
-	const dirs = config.dirs();
-
-	const DIST_FOLDER = path.join(dirs.__cx, "dist");
+	const { __cx } = config.paths();
 
 	const { buildProcessData } = await getBuildMetadata();
-	const filePathName = path.join(DIST_FOLDER, "__build-report__.json");
 
 	// Get the token
 	const authControl = await AuthService.login();
@@ -168,7 +166,10 @@ async function generateBuildReport() {
 		sites: buildSitesInfo,
 	};
 
-	fs.writeFileSync(filePathName, JSON.stringify(report));
+	fs.writeFileSync(
+		path.join(__cx, "dist", "__build-report__.json"),
+		JSON.stringify(report)
+	);
 
 	logInfo(`Build report saved for ${buildSitesInfo.length} site(s)`);
 }
@@ -180,9 +181,8 @@ async function generateBuildReport() {
  */
 async function generateSitemaps() {
 	const { sitesToPublish } = await getBuildMetadata();
-	const config = getConfig();
-	const dirs = config.dirs();
-	const basePath = path.resolve(dirs.__cx, "dist");
+	const { __cx } = config.paths();
+	const distDir = path.join(__cx, "dist");
 
 	const promisesOfSites = sitesToPublish.map(async (site) => {
 		const { id: siteID, languages } = site;
@@ -211,7 +211,7 @@ async function generateSitemaps() {
 			const sitemaps: Array<string> = [];
 			const sitemapPageGroupKeys = Object.keys(sitemapPagesGroup);
 
-			const sitemapBasePath = path.join(basePath, slug.replace(domain, ""));
+			const sitemapBasePath = path.join(distDir, slug.replace(domain, ""));
 
 			for (const templateId of sitemapPageGroupKeys) {
 				const sitemapPages = sitemapPagesGroup[templateId];

package/exporter/utils/store.ts

@@ -1,36 +1,64 @@
 import type { BuildMetaData } from "../types/api";
 import type { RenderInfo } from "../types/global";
 import type { GriddoPageObject } from "../types/pages";
+import type { Site } from "../types/sites";
 
 import fs from "node:fs";
-import fsp from "node:fs/promises";
 import path from "node:path";
 
 import fsx from "fs-extra";
 
 import { removeProperties, walk } from "./shared";
 import { getConfig } from "./temp-utils";
-import { Site } from "../types/sites";
+
+const config = getConfig();
 
 /**
- * Read all pages stored in `store` Griddo directory and return one by one with
- * a generator.
+ * Read all path pages stored in the `store` Griddo directory and returns the
+ * absolute file path.
+ *
+ * @param domain - The domain to get the pages from.
  */
-async function* getBuildPages<PageType extends GriddoPageObject>(
-	basePath: string
+function getBuildPagesFromCachedStore<PageType extends GriddoPageObject>(
+	domain: string
 ) {
-	const pagesDirPath = path.resolve(basePath);
+	const { __caches } = config.paths(domain);
+	return getBuildPagesFromStore<PageType>({
+		basePath: path.join(__caches, "store"),
+		withSizeProp: false,
+	});
+}
+
+/**
+ * Read all pages stored in the `store` Griddo directory and returns one by one
+ * with a generator.
+ *
+ * @param basePath - Base directory to get pages from.
+ * @param options.withSizeProp - Add size prop to the page object.
+ * @todo throw error if the basePath is not an store folder
+ */
+function* getBuildPagesFromStore<PageType extends GriddoPageObject>(args?: {
+	basePath?: string;
+	withSizeProp?: boolean;
+}) {
+	const { basePath, withSizeProp } = args || {};
+	const { __cx } = config.paths();
+	const pagesDirPath = basePath || path.join(__cx, "store");
 	const jsonFilePaths = walk(pagesDirPath).filter(
 		(file) => path.extname(file) === ".json"
 	);
 
 	for (const filePath of jsonFilePaths) {
 		try {
-			const fileStats = await fsp.stat(filePath);
-			const page = (await fsx.readJSON(filePath, {
+			const page = fsx.readJsonSync(filePath, {
 				encoding: "utf-8",
-			})) as PageType;
-			page.size = fileStats.size / 1024;
+			}) as PageType;
+
+			if (withSizeProp) {
+				const fileStats = fs.statSync(filePath);
+				page.size = fileStats.size / 1024;
+			}
+
 			// SECURITY: Only returns valid page objects
 			if (page.path) {
 				yield page;
@@ -41,18 +69,31 @@ async function* getBuildPages<PageType extends GriddoPageObject>(
 	}
 }
 
+/**
+ * Read all pages stored in `store` Griddo directory and return the absolute path.
+ */
+function getBuildPagesPath() {
+	const config = getConfig();
+	const { __cx } = config.paths();
+
+	const PAGES_DIR = path.join(__cx, "store");
+	const PAGE_FILES = walk(PAGES_DIR).filter(
+		(file) => path.extname(file) === ".json"
+	);
+
+	return PAGE_FILES;
+}
+
 /**
  * Get the build metadata from the Store.
  * TODO: Refactorizar para leer un solo archivo: __metadata__.json
  */
 async function getBuildMetadata(): Promise<BuildMetaData> {
-	const config = getConfig();
-	const dirs = config.dirs();
-	const storePath = path.join(dirs.__cx, "store");
-
+	const { __cx } = config.paths();
 	const { sitesToPublish, createdPages, buildProcessData } = fsx.readJSONSync(
-		path.resolve(storePath, "metadata", "render-info.json")
+		path.join(__cx, "store", "metadata", "render-info.json")
 	);
+
 	return {
 		buildProcessData,
 		createdPages,
@@ -63,10 +104,13 @@ async function getBuildMetadata(): Promise<BuildMetaData> {
 /**
  * Creates an `store` dir to store pages transformed by createStore
  */
-function createStoreDir(storeDir: string) {
+function createStoreDir() {
+	const { __cx } = config.paths();
+	const storeDir = path.join(__cx, "store");
+
 	if (!fs.existsSync(storeDir)) {
 		fs.mkdirSync(storeDir);
-		fs.mkdirSync(path.resolve(storeDir, "metadata"));
+		fs.mkdirSync(path.join(storeDir, "metadata"));
 	}
 
 	console.info("Store initialized");
@@ -78,8 +122,10 @@ function createStoreDir(storeDir: string) {
  * @param renderInfo - Data that will be saved related to the render process.
  */
 function saveRenderInfoInStore(basePath: string, renderInfo: RenderInfo) {
+	const { __cx } = config.paths();
+
 	fs.writeFileSync(
-		path.resolve(basePath, "metadata", "render-info.json"),
+		path.join(__cx, "store", "metadata", "render-info.json"),
 		JSON.stringify(renderInfo)
 	);
 }
@@ -139,30 +185,32 @@ function getPageInStoreDir(basePath: string): Array<number> {
 
 /**
  * Save the pages into the file system.
- * @param basePath - Absolute path of the dir from which files will be saved.
  * @param pages - An array of Griddo page objects to be saved.
  */
-function savePagesInStore(basePath: string, pages: Array<GriddoPageObject>) {
+function savePagesInStore(pages: Array<GriddoPageObject>) {
+	const { __cx } = config.paths();
+
 	pages.forEach((page) => {
 		removeProperties(page, ["editorID", "parentEditorID"]);
 		const filename = `${page.context.page.id}.json`;
-		const filePath = path.resolve(basePath, filename);
+		const filePath = path.join(__cx, "store", filename);
 		fsx.writeJSONSync(filePath, page);
 	});
 }
 
 /**
  * Remove files from dir.
- * @param basePath - Absolute path of the dir from which files will be removed.
  * @param filenames - An array of ids representing file page names.
  */
-function removePagesFromStore(basePath: string, filenames: Array<number>) {
+function removePagesFromStore(filenames: Array<number>) {
+	const { __cx } = config.paths();
+
 	if (filenames.length === 0) {
 		return;
 	}
 
 	filenames.forEach((filename) => {
-		const filePath = path.resolve(basePath, `${filename}.json`);
+		const filePath = path.join(__cx, "store", `${filename}.json`);
 		try {
 			fs.unlinkSync(filePath);
 		} catch (error) {
@@ -219,7 +267,7 @@ async function getPagesToCreateOrDelete(
 
 	// 1 - Leer el store
 	// 2 - eliminar las páginas que tengan como site uno despublicado o borrado
-	const allPagesInStore = getBuildPages(path.resolve(__dirname, "../store"));
+	const allPagesInStore = getBuildPagesFromStore();
 
 	const pagesFromInvalidSites: Array<number> = [];
 	for await (const page of allPagesInStore) {
@@ -247,7 +295,9 @@ async function getPagesToCreateOrDelete(
 export {
 	createStoreDir,
 	getBuildMetadata,
-	getBuildPages,
+	getBuildPagesPath,
+	getBuildPagesFromCachedStore,
+	getBuildPagesFromStore,
 	getPageInStoreDir,
 	getPagesToCreateOrDelete,
 	removePagesFromStore,

package/exporter/utils/temp-utils.ts

@@ -5,6 +5,8 @@ import fsx from "fs-extra";
 import { createDirsSync, removeDirsSync } from "./folders";
 import { CXConfig } from "../types/global";
 
+const config = getConfig();
+
 function getConfig(): CXConfig {
 	try {
 		// eslint-disable-next-line @typescript-eslint/no-var-requires, node/no-missing-require, node/no-unpublished-require
@@ -26,13 +28,12 @@ async function legacy__createDistFromGatsbyPublic(
 	domain: string,
 	needsAssetPrefix: boolean
 ) {
-	const config = getConfig();
-	const dirs = config.dirs(domain);
+	const { __cx, __ssg } = config.paths(domain);
 
-	const cxDistDir = path.resolve(dirs.__cx, "dist");
-	const cxAssetsDir = path.resolve(dirs.__cx, "assets");
-	const cxDistDirWithDomain = path.join(dirs.__cx, "dist", domain);
-	const publicDir = path.resolve(dirs.__ssg, "public");
+	const cxDistDir = path.join(__cx, "dist");
+	const cxAssetsDir = path.join(__cx, "assets");
+	const cxDistDirWithDomain = path.join(__cx, "dist", domain);
+	const publicDir = path.join(__ssg, "public");
 
 	console.log(publicDir);
 	const validFilesFromPublic = fsx
@@ -47,7 +48,7 @@ async function legacy__createDistFromGatsbyPublic(
 	const pageDataSrc = `${publicDir}/page-data`;
 	const pageDataDest = `${cxAssetsDir}/page-data`;
 
-	const projectStaticSrc = path.resolve(dirs.__ssg, "static");
+	const projectStaticSrc = path.join(__ssg, "static");
 	const projectStaticDest = cxAssetsDir;
 
 	const gatsbyStaticSrc = `${cxDistDir}/static`;
@@ -82,15 +83,15 @@ async function legacy__createDistFromGatsbyPublic(
 }
 
 async function griddoCreateInitialDirectories(domain: string) {
-	const config = getConfig();
-	const { __exports, __caches } = config.dirs(domain);
+	const { __exports, __caches } = config.paths(domain);
+
 	createDirsSync([__exports]);
 	createDirsSync([__caches]);
 }
 
 async function griddoCleanDisposableDirectories(domain: string) {
-	const config = getConfig();
-	const { __cx } = config.dirs(domain);
+	const { __cx } = config.paths(domain);
+
 	removeDirsSync(__cx, ["store", "apiCache", "dist"]);
 }
 

package/gatsby-config.ts

@@ -2,7 +2,7 @@ import type { GatsbyConfig } from "gatsby";
 
 import dotenv from "dotenv";
 
-import { resolveComponentsPath } from "./exporter/utils/instance";
+import { resolveComponentsPath } from "./build";
 
 dotenv.config();
 

package/gatsby-node.ts

@@ -1,22 +1,21 @@
+import type { GatsbyPageObject } from "./src/types";
 import type { GatsbyNode } from "gatsby";
 
 import path from "node:path";
 
-import { logInfo, logPageSize } from "./exporter/utils/shared";
-import { getBuildPages } from "./exporter/utils/store";
-import { getConfig } from "./exporter/utils/temp-utils";
+import { getConfig, logInfo, logPageSize } from "./build";
+import { getBuildPagesFromStore } from "./exporter/utils/store";
 import { getMatchPath } from "./src/gatsby-node-utils";
-import { GatsbyPageObject } from "./src/types";
-
-const dirs = getConfig().dirs();
-const store = path.join(dirs.__cx, "store");
-const template = path.join(dirs.__ssg, "src/components/template.tsx");
 
 const GRIDDO_BUILD_LOGS = JSON.parse(process.env.GRIDDO_BUILD_LOGS || "false");
 
-const createPages: GatsbyNode["createPages"] = async ({ actions }) => {
-	const pages = getBuildPages<GatsbyPageObject>(store);
+const { __ssg } = getConfig().paths();
+const template = path.join(__ssg, "src/components/template.tsx");
+const pages = getBuildPagesFromStore<GatsbyPageObject>({
+	withSizeProp: GRIDDO_BUILD_LOGS,
+});
 
+const createPages: GatsbyNode["createPages"] = async ({ actions }) => {
 	for await (const page of pages) {
 		if (!page) return;