@griddo/cx 10.4.22 → 10.4.23

package/build/utils/{shared.d.ts → core-utils.d.ts}

@@ -1,8 +1,50 @@
 import type { Adapters } from "../adapters";
 import type { APIResponses } from "../types/api";
-import type { LifeCyclesNames } from "../types/global";
+import type { CXConfig, LifeCyclesNames } from "../types/global";
 import type { Site } from "../types/sites";
 declare const instanceRootDir: string;
+declare const attempts: {
+    clean: any;
+    prepare: any;
+    restore: any;
+    data: any;
+    ssg: any;
+    relocation: any;
+    meta: any;
+    archive: any;
+};
+/**
+ * Returns the configuration file content.
+ *
+ * @example
+ * const config = getConfig()
+ * const { __cx } = config.paths()
+ * const { griddoVersion, proDomain } = config
+ */
+declare function getConfig(): CXConfig;
+/**
+ * Create the initial mandatory directories for a render.
+ *
+ * @param domain The current domain in render.
+ */
+declare function exporterCreateInitialDirectories(domain: string): Promise<void>;
+/**
+ * Remove trash directories from __cx, maybe from a failed render.
+ *
+ * @param domain The current domain in render.
+ */
+declare function exporterCleanDisposableDirectories(domain: string): Promise<void>;
+/**
+ * Custom basic logging function controlled by a environment variable.
+ *
+ * @param str The string to be logged.
+ */
+declare function verbose(str: string): void;
+/**
+ * Returns true for `true`, true, positive numbers
+ * Returns false for `false`, false, 0, negative integers and anything else
+ */
+declare function isTruthy(value: any): boolean;
 /**
  * Walk a directory and returns the file pathts.
  *
@@ -107,4 +149,4 @@ declare function doLifeCycle(args: {
 }): Promise<void>;
 declare function isVersionGreaterThan(versionA: string, versionB: string): boolean;
 declare function isVersionLowerThan(versionA: string, versionB: string): boolean;
-export { debug, delay, doLifeCycle, instanceRootDir, isVersionGreaterThan, isVersionLowerThan, logBox, logInfo, logPageSize, measureExecutionTime, pause, printExporterLogo, removeProperties, sanitizeAPICacheDir, siteList, startLifeCycle, successLifeCyle, walk, };
+export { attempts, debug, delay, doLifeCycle, exporterCleanDisposableDirectories, exporterCreateInitialDirectories, getConfig, instanceRootDir, isTruthy, isVersionGreaterThan, isVersionLowerThan, logBox, logInfo, logPageSize, measureExecutionTime, pause, printExporterLogo, removeProperties, sanitizeAPICacheDir, siteList, startLifeCycle, successLifeCyle, verbose, walk, };

package/build/utils/folders.d.ts

@@ -45,4 +45,9 @@ declare function moveDirsSync(src: string, dst: string, dirs: Array<string>, opt
  */
 declare function removeDirsSync(basePath: string, dirs: Array<string>): void;
 declare function removeVirtualPagesFromStore(): Promise<void>;
-export { clearEmptyDirs, copyDirsSync, createDirsSync, moveDirsSync, removeDirsSync, removeVirtualPagesFromStore, };
+/**
+ * Remove every .xml file in the directories in a recursive way
+ * @param initialFolder - The initial folder to start the searching...
+ */
+declare function clearSitemapsFromDirs(initialFolder: string): void;
+export { clearEmptyDirs, clearSitemapsFromDirs, copyDirsSync, createDirsSync, moveDirsSync, removeDirsSync, removeVirtualPagesFromStore, };

package/build/utils/store.d.ts

@@ -76,4 +76,4 @@ declare function getPagesToCreateOrDelete(storeDir: string, sitePages: {
     pagesToDeleteFromStore: number[];
     pagesToWriteToStore: number[];
 }>;
-export { createStoreDir, getBuildMetadata, getBuildPagesPath, getBuildPagesFromCachedStore, getBuildPagesFromStore, getPageInStoreDir, getPagesToCreateOrDelete, removePagesFromStore, savePagesInStore, saveRenderInfoInStore, };
+export { createStoreDir, getBuildMetadata, getBuildPagesFromCachedStore, getBuildPagesFromStore, getBuildPagesPath, getPageInStoreDir, getPagesToCreateOrDelete, removePagesFromStore, savePagesInStore, saveRenderInfoInStore, };

package/cx.config.js

@@ -12,8 +12,15 @@ const CX_CACHE_DIR = path.resolve(CX_ROOT_DIR, "caches");
 const COMPONENTS_DIR = resolveComponentsPath();
 const EXPORTS_DIR = path.join(REPO_ROOT_DIR, "exports/sites");
 
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { version: griddoVersion } = require(path.join(
+	CX_ROOT_DIR,
+	"package.json"
+));
+
 const config = {
 	proDomain: "pro-",
+	griddoVersion,
 	CXDir: {
 		EXPORTS: "__exports",
 		CACHE: "__caches",

package/exporter/adapters/gatsby/index.ts

@@ -2,11 +2,20 @@ import fs from "node:fs";
 import path from "node:path";
 
 import {
-	gatsbyBuild,
 	getGatsbyAssetPrefixWithDomain,
 	legacy__createDistFromGatsbyPublic,
+	runGatsbyBuildCommand,
 } from "./utils";
 import { RobotsService } from "../../services/robots";
+import {
+	attempts,
+	doLifeCycle,
+	getConfig,
+	logBox,
+	pause,
+	printExporterLogo,
+	verbose,
+} from "../../utils/core-utils";
 import { createBuildData } from "../../utils/create-build-data";
 import { getInstanceDomains } from "../../utils/domains";
 import {
@@ -17,14 +26,7 @@ import {
 	removeDirsSync,
 	removeVirtualPagesFromStore,
 } from "../../utils/folders";
-import {
-	doLifeCycle,
-	logBox,
-	pause,
-	printExporterLogo,
-} from "../../utils/shared";
 import { generateBuildReport, generateSitemaps } from "../../utils/sites";
-import { attempts, getConfig } from "../../utils/temp-utils";
 
 async function runGatsbyAdapter() {
 	printExporterLogo("gatsby");
@@ -55,7 +57,15 @@ async function runGatsbyAdapter() {
 			attempts: attempts.clean,
 			steps: [
 				() => removeDirsSync(__cx, ["store", "apiCache", "dist"]),
+				() =>
+					verbose(
+						"clean `store`, `apiCache` and `dist` directories from `__cx`"
+					),
 				() => removeDirsSync(__ssg, ["dist", "public", "static", ".cache"]),
+				() =>
+					verbose(
+						"clean `dist`, `public`, `static` and `.cache` directories from `__ssg`"
+					),
 				() => pause("Clean LifeCycle"),
 			],
 		});
@@ -71,8 +81,10 @@ async function runGatsbyAdapter() {
 			attempts: attempts.prepare,
 			steps: [
 				() => createDirsSync([__exports]),
+				() => verbose("create `exports/sites/<domain>` directory"),
 				() => createDirsSync([__caches]),
-				() => pause("Prepare LifeCycle"),
+				() => verbose("create `caches/<domain>` directory"),
+				() => pause("prepare LifeCycle"),
 			],
 		});
 
@@ -85,8 +97,17 @@ async function runGatsbyAdapter() {
 			steps: [
 				// Copy instance static directory into the gatsby one.
 				() => copyDirsSync(__components, __ssg, ["static"]),
+				() => verbose("copy `static` directory from `__components` to `__ssg`"),
 				() => copyDirsSync(__exports, __cx, ["assets"]),
+				() => verbose("copy `assets` directory from `__exports` to `__cx`"),
 				() => copyDirsSync(__exports, __ssg, ["dist"]),
+				// Eliminamos archivos de sitemaps para que Gatsby no los tenga
+				// en cuenta y evitar que se invalide el caché de HTMLs.
+				// De todas maneras estos .xml se generan siempre en cada
+				// render, y si hay algún problema no pasa nada porque se están
+				// eliminando los sitemaps de la copia de dist en el directorio
+				// de __cx.
+				// () => clearSitemapsFromDirs(path.join(__cx, "dist")),
 				// Renames dist to public.
 				// En este paso de dist to public también se sacan los "assets"
 				// de public si el dominio es "pro-". Este proceso es sacar
@@ -97,8 +118,14 @@ async function runGatsbyAdapter() {
 						fs.renameSync(path.join(__ssg, "dist"), path.join(__ssg, "public"));
 					}
 				},
+				() => verbose("rename `__ssg/dist` to `__ssg/public` directory."),
 				() => moveDirsSync(__caches, __cx, ["apiCache", "store"]),
+				() =>
+					verbose(
+						"move `apiCache` and `store` directories from `__caches` to `__cx`"
+					),
 				() => moveDirsSync(__caches, __ssg, [".cache"]),
+				() => verbose("move `.cache` directory from `__caches` to `__ssg`"),
 				() => pause("Restore LifeCycle"),
 			],
 		});
@@ -122,7 +149,10 @@ async function runGatsbyAdapter() {
 		await doLifeCycle({
 			name: "SSG",
 			attempts: attempts.ssg,
-			steps: [() => gatsbyBuild(assetPrefix), () => pause("SSG LifeCycle")],
+			steps: [
+				() => runGatsbyBuildCommand(assetPrefix),
+				() => pause("SSG LifeCycle"),
+			],
 		});
 
 		/*
@@ -133,6 +163,7 @@ async function runGatsbyAdapter() {
 			attempts: attempts.relocation,
 			steps: [
 				() => legacy__createDistFromGatsbyPublic(domain, needsAssetPrefix),
+				() => verbose("create an `assets` directory from `public`"),
 				() => pause("Relocation LifeCycle"),
 			],
 		});
@@ -145,8 +176,12 @@ async function runGatsbyAdapter() {
 			attempts: attempts.meta,
 			steps: [
 				() => generateBuildReport(),
+				() =>
+					verbose("create build report from `store/metadata/render-info.json`"),
 				() => RobotsService.writeFiles(domain),
+				() => verbose("create Robots.txt"),
 				() => generateSitemaps(),
+				() => verbose("generate sitemaps"),
 				() => pause("Meta LifeCycle"),
 			],
 		});
@@ -166,15 +201,30 @@ async function runGatsbyAdapter() {
 				// tenidas en cuenta por la API y por lo tanto escapan a la
 				// lógica de `changedPages` y la persistencia del store.
 				() => removeVirtualPagesFromStore(),
+				() =>
+					verbose(
+						"remove virtual pages from store (multipage and static list)"
+					),
 				// Eliminamos carpetas vacías que puedan quedar de sites
 				// despublicados. Incluye aquellas que solo tengan archivos .xml
 				() => clearEmptyDirs(path.join(__cx, "dist")),
+				() => verbose("remove empty site directories from `__cx/dist`"),
 				() =>
 					moveDirsSync(__cx, __exports, ["dist", "assets"], {
 						withBackup: true,
 					}),
+
+				() =>
+					verbose(
+						"move `dist` and `assets` directories from `__cx` to `__exports`"
+					),
 				() => moveDirsSync(__cx, __caches, ["apiCache", "store"]),
+				() =>
+					verbose(
+						"move `apiCache` and `store` directories from `__cx` to `__caches`"
+					),
 				() => moveDirsSync(__ssg, __caches, [".cache"]),
+				() => verbose("move `.cache` directory from `__ssg` to `__caches`"),
 				() => pause("Archive LifeCycle"),
 			],
 		});

package/exporter/adapters/gatsby/utils.ts

@@ -6,7 +6,7 @@ import path from "node:path";
 import dotenv from "dotenv";
 import fsx from "fs-extra";
 
-import { getConfig } from "../../utils/temp-utils";
+import { getConfig, verbose } from "../../utils/core-utils";
 
 dotenv.config();
 
@@ -29,19 +29,16 @@ function getGatsbyAssetPrefixWithDomain(domain: string) {
 	if (!assetPrefix || !domain) return "";
 	if (!domain.startsWith(proDomain)) return "";
 
-	if (process.env.GRIDDO_DEBUG_LOGS) {
-		console.log();
-		console.log("-- getGatsbyAssetPrefixWithDomain() --");
-		console.log(
-			"process.env.GRIDDO_ASSET_PREFIX",
-			process.env.GRIDDO_ASSET_PREFIX
-		);
-		console.log("assetPrefix", assetPrefix);
-		console.log("return", `${assetPrefix}/${domain}`);
-		console.log();
-	}
+	const assetPrefixWithDomain = `${assetPrefix}/${domain}`;
 
-	return `${assetPrefix}/${domain}`;
+	verbose(
+		`Reading env.GRIDDO_ASSET_PREFIX, ${process.env.GRIDDO_ASSET_PREFIX}`
+	);
+	verbose(
+		`Setting the asset prefix with the domain concatenated, ${assetPrefixWithDomain}`
+	);
+
+	return assetPrefixWithDomain;
 }
 
 /**
@@ -99,24 +96,25 @@ function addCloudinaryParams(image: string, params: string) {
  * @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.
  */
-function gatsbyBuild(assetPrefixWithDomain: string) {
-	if (process.env.GRIDDO_DEBUG_LOGS) {
-		console.log("-- gatsbyBuild() --");
-		console.log("assetPrefixWithDomain", assetPrefixWithDomain);
-	}
+function runGatsbyBuildCommand(assetPrefixWithDomain: string) {
+	verbose(`read assetPrefixWithDomain, ${assetPrefixWithDomain}`);
 
 	const { __ssg } = config.paths();
 
-	const command = spawnSync("yarn", ["gatsby-build"], {
-		cwd: __ssg,
-		stdio: ["ignore", "inherit", "ignore"],
-		encoding: "utf8",
-		shell: true,
-		env: Object.assign(process.env, {
-			GRIDDO_EXPORTER: "true",
-			SPAWN_ASSET_PREFIX_WITH_DOMAIN: assetPrefixWithDomain,
-		}),
-	});
+	const command = spawnSync(
+		"yarn",
+		["gatsby-build", process.env.GRIDDO_SSG_VERBOSE ? "--verbose" : ""],
+		{
+			cwd: __ssg,
+			stdio: ["ignore", "inherit", "ignore"],
+			encoding: "utf8",
+			shell: true,
+			env: Object.assign(process.env, {
+				GRIDDO_EXPORTER: "true",
+				SPAWN_ASSET_PREFIX_WITH_DOMAIN: assetPrefixWithDomain,
+			}),
+		}
+	);
 
 	if (command.status !== 0) {
 		throw new Error("Error in 'yarn gatsby-build'");
@@ -138,7 +136,6 @@ async function legacy__createDistFromGatsbyPublic(
 	const cxDistDirWithDomain = path.join(__cx, "dist", domain);
 	const publicDir = path.join(__ssg, "public");
 
-	console.log(publicDir);
 	const validFilesFromPublic = fsx
 		.readdirSync(publicDir)
 		.filter(
@@ -164,9 +161,13 @@ async function legacy__createDistFromGatsbyPublic(
 		if (needsAssetPrefix) {
 			fsx.copySync(pageDataSrc, pageDataDest);
 			if (fsx.existsSync(projectStaticSrc)) {
-				fsx.copySync(projectStaticSrc, projectStaticDest, { overwrite: false });
+				fsx.copySync(projectStaticSrc, projectStaticDest, {
+					overwrite: false,
+				});
 			}
-			fsx.copySync(gatsbyStaticSrc, gatsbyStaticDest, { overwrite: false });
+			fsx.copySync(gatsbyStaticSrc, gatsbyStaticDest, {
+				overwrite: false,
+			});
 			if (fsx.existsSync(projectStaticSrc)) {
 				fsx.copySync(projectStaticSrc, cxDistDirWithDomain, {
 					overwrite: false,
@@ -187,7 +188,7 @@ async function legacy__createDistFromGatsbyPublic(
 
 export {
 	formatImage,
-	gatsbyBuild,
 	getGatsbyAssetPrefixWithDomain,
 	legacy__createDistFromGatsbyPublic,
+	runGatsbyBuildCommand,
 };

package/exporter/index.ts

@@ -24,10 +24,9 @@
 /* prettier-ignore */ import type { Site } from "./types/sites";
 
 /* prettier-ignore */ import { startRender } from "./start-render";
+/* prettier-ignore */ import { getConfig, logInfo, logPageSize, verbose, walk } from "./utils/core-utils";
 /* prettier-ignore */ import { IS_COMPONENT_LIBRARY, PROJECT_ALIASES, resolveComponentsPath } from "./utils/instance";
-/* prettier-ignore */ import { logInfo, logPageSize, walk } from "./utils/shared";
 /* prettier-ignore */ import { getBuildPagesFromCachedStore, getBuildPagesFromStore, getBuildPagesPath } from "./utils/store";
-/* prettier-ignore */ import { getConfig } from "./utils/temp-utils";
 
 export {
 	AdditionalInfo,
@@ -40,11 +39,13 @@ export {
 	Site,
 	SocialsResponse,
 	getBuildPagesFromCachedStore,
-	getBuildPagesFromStore, getBuildPagesPath, getConfig,
+	getBuildPagesFromStore,
+	getBuildPagesPath,
+	getConfig,
 	logInfo,
 	logPageSize,
 	resolveComponentsPath,
 	startRender,
-	walk
+	verbose,
+	walk,
 };
-

package/exporter/react/Foo/index.tsx

@@ -0,0 +1,7 @@
+import * as React from "react";
+
+function Foo() {
+	return <div>React</div>;
+}
+
+export default Foo;

package/exporter/react/index.tsx

@@ -0,0 +1,3 @@
+import Foo from "./Foo";
+
+export { Foo };

package/exporter/services/distributors.ts

@@ -7,7 +7,7 @@ import type {
 } from "@griddo/core/dist/types/api-response-fields";
 
 import { SitesService } from "./sites";
-import { logBox } from "../utils/shared";
+import { logBox } from "../utils/core-utils";
 
 /**
  * Service to work with distributors.

package/exporter/services/robots.ts

@@ -8,7 +8,7 @@ dotenv.config();
 import dotenv from "dotenv";
 
 import { get } from "../utils/api";
-import { getConfig } from "../utils/temp-utils";
+import { getConfig } from "../utils/core-utils";
 
 const config = getConfig();
 

package/exporter/services/store.ts

@@ -7,7 +7,6 @@ import type {
 	PageAdditionalInfo,
 } from "../types/pages";
 
-import fs from "node:fs";
 import path from "node:path";
 
 import dotenv from "dotenv";
@@ -18,6 +17,7 @@ import { NavigationService } from "./navigation";
 import { SettingsService } from "./settings";
 import { SitesService } from "./sites";
 import { updatedSiteHash } from "../utils/cache";
+import { getConfig, logInfo, siteList, verbose } from "../utils/core-utils";
 import {
 	createGriddoListPages,
 	createGriddoMultiPages,
@@ -25,7 +25,6 @@ import {
 	getMultiPageElements,
 	getPaginatedPages,
 } from "../utils/pages";
-import { logBox, logInfo, siteList } from "../utils/shared";
 import { checkSites, getSiteData, unpublishSites } from "../utils/sites";
 import {
 	createStoreDir,
@@ -34,7 +33,6 @@ import {
 	savePagesInStore,
 	saveRenderInfoInStore,
 } from "../utils/store";
-import { getConfig } from "../utils/temp-utils";
 
 const config = getConfig();
 
@@ -57,10 +55,8 @@ async function createStore(domain: string) {
 	console.info(`API calls with ${API_CONCURRENCY_COUNT} threads`);
 
 	const { __cx } = config.paths();
+	const { griddoVersion } = config;
 	const storeDir = path.join(__cx, "store");
-	const { version: griddoVersion } = JSON.parse(
-		fs.readFileSync(path.join(__cx, "package.json"), "utf-8")
-	);
 
 	try {
 		// Vars to save later in the report file
@@ -293,16 +289,13 @@ async function createStore(domain: string) {
 			removePagesFromStore(pagesToDeleteFromStore);
 
 			// Debug time
-			const changedPageLogs = `Store:               ${pagesInStore.length} -> ${pagesInStore}
-				ValidPages:          ${validPagesIds.length} -> ${validPagesIds}
-				Changed:             ${changedPages.length} -> ${changedPages}
-				Deleted/Unpublished: ${pagesToDeleteFromStore.length} -> ${pagesToDeleteFromStore}
-				Missing in store:    ${pagesMissingInStore.length} -> ${pagesMissingInStore}
-				Finally to store:    ${pagesToWriteToStore.length} -> ${pagesToWriteToStore}`;
-
-			if (JSON.parse(process.env.GRIDDO_DEBUG_LOGS || "false")) {
-				logBox(changedPageLogs, `Site store: ${site.name}`, 1, 0);
-			}
+
+			verbose(`Store site: ${site.name}`);
+			verbose(`${validPagesIds.length} valid pages from API`);
+			verbose(`changed ${pagesToDeleteFromStore.length} pages from API`);
+			verbose(`deleted ${changedPages.length} pages in store`);
+			verbose(`missing ${pagesMissingInStore.length} pages in store`);
+			verbose(`write ${pagesToWriteToStore.length} pages to store`);
 
 			// Create (async)
 			const limit = pLimit(API_CONCURRENCY_COUNT);

package/exporter/start-render.ts

@@ -2,7 +2,7 @@
 /* eslint-disable node/shebang */
 
 import { runGatsbyAdapter } from "./adapters";
-import { logBox, measureExecutionTime } from "./utils/shared";
+import { logBox, measureExecutionTime } from "./utils/core-utils";
 
 async function startRender() {
 	const exeTime = await measureExecutionTime(runGatsbyAdapter).catch(() => {

package/exporter/types/global.ts

@@ -97,6 +97,7 @@ type CXDir =
 
 interface CXConfig {
 	proDomain: string;
+	griddoVersion: string;
 	CXDir: {
 		EXPORTS: "__exports";
 		CACHE: "__caches";

package/exporter/utils/api.ts

@@ -13,7 +13,7 @@ import chalk from "chalk";
 import dotenv from "dotenv";
 
 import { saveCache, searchCacheData } from "./cache";
-import { delay, getSafeSiteId, logInfo, msToSec } from "./shared";
+import { delay, getSafeSiteId, logInfo, msToSec } from "./core-utils";
 import { AuthService } from "../services/auth";
 
 dotenv.config();

package/exporter/utils/cache.ts

@@ -7,7 +7,7 @@ import path from "node:path";
 
 import fsx from "fs-extra";
 
-import { getConfig } from "./temp-utils";
+import { getConfig } from "./core-utils";
 
 const config = getConfig();