@griddo/cx 10.4.8 → 10.4.9

package/exporter/adapters/gatsby/index.ts

@@ -1,17 +1,51 @@
 import { attempts, getGatsbyDomainRunner } from "./utils";
+import { getGatsbyAssetPrefixSlug } from "../../../src/gatsby-node-utils";
+import { RobotsService } from "../../services/robots";
 import { getInstanceDomains } from "../../utils/domains";
 import { createBuildData } from "../../utils/download-build-data";
-import { clearEmptyDirs, removeMultiPagesFromStore } from "../../utils/folders";
+import {
+	clearEmptyDirs,
+	copyArtifacts,
+	removeArtifacts,
+	removeMultiPagesFromStore,
+} from "../../utils/folders";
 import { uploadSearchContentToAPI } from "../../utils/searches";
 import { doLifeCycle, pause, printExporterLogo } from "../../utils/shared";
+import { generateBuildReport, generateSitemaps } from "../../utils/sites";
+import {
+	getConfig,
+	legacy__createDistFromGatsbyPublic,
+} from "../../utils/temp-utils";
 
 async function runGatsbyAdapter() {
 	printExporterLogo("gatsby");
 
 	const domains = await getInstanceDomains();
+	const config = await getConfig();
 
 	for (const domain of domains) {
 		const runner = getGatsbyDomainRunner(domain);
+		const { __components, __cx } = config.dirs(domain);
+		const assetPrefix = getGatsbyAssetPrefixSlug(domain);
+		const needsAssetPrefix = !!assetPrefix && assetPrefix !== "";
+
+		/**
+		 * Prepare
+		 */
+		await doLifeCycle({
+			name: "Prepare",
+			steps: [
+				() =>
+					copyArtifacts({
+						artifacts: ["static"],
+						from: __components,
+						to: __cx,
+					}),
+				runner.init,
+				() => pause("Prepared LifeCycle"),
+			],
+			attempts: attempts.prepare,
+		});
 
 		/**
 		 * Restore
@@ -22,12 +56,9 @@ async function runGatsbyAdapter() {
 			name: "Restore",
 			attempts: attempts.restore,
 			steps: [
-				runner.init,
-				() => pause("init done!"),
 				runner.restoreArtifacts,
-				() => pause("Restore `dist` and `assets` dirs done!"),
 				runner.restoreCacheArtifacts,
-				() => pause("Restore `apiCache`, `store` and `.cache` restored!"),
+				() => pause("Restore LifeCycle"),
 			],
 		});
 
@@ -40,10 +71,7 @@ async function runGatsbyAdapter() {
 		await doLifeCycle({
 			name: "Data",
 			attempts: attempts.data,
-			steps: [
-				() => createBuildData(domain),
-				() => pause("Download data from API to `store` done!"),
-			],
+			steps: [() => createBuildData(domain), () => pause("Data LifeCycle")],
 		});
 
 		/**
@@ -56,7 +84,18 @@ async function runGatsbyAdapter() {
 		await doLifeCycle({
 			name: "SSG",
 			attempts: attempts.ssg,
-			steps: [runner.runGatsbyBuild, () => pause("Gatsby build done!")],
+			steps: [runner.runGatsbyBuild, () => pause("SSG LifeCycle")],
+		});
+
+		/**
+		 * Relocation
+		 */
+		await doLifeCycle({
+			name: "Relocation",
+			steps: [
+				() => legacy__createDistFromGatsbyPublic(domain, needsAssetPrefix),
+				() => pause("Relocation LifeCycle"),
+			],
 		});
 
 		/**
@@ -72,7 +111,11 @@ async function runGatsbyAdapter() {
 			name: "Meta",
 			attempts: attempts.meta,
 			steps: [
+				() => generateBuildReport(),
+				() => RobotsService.writeFiles(domain),
+				() => generateSitemaps(),
 				() => (shouldUploadSearchData ? uploadSearchContentToAPI() : undefined),
+				() => pause("Meta LifeCycle"),
 			],
 		});
 
@@ -90,16 +133,25 @@ async function runGatsbyAdapter() {
 				// aseguramos que se vuelven a crear por Gatsby siempre
 				// actualizadas.
 				removeMultiPagesFromStore,
-				() => pause("MultiPages removed from `store`"),
 				() => clearEmptyDirs(),
-				() => pause("Clean empty dirs done!"),
 				runner.removeDisposableArtifacts,
-				() => pause("Clean `public` done!"),
 				runner.archiveArtifacts,
-				() => pause("Archive `dist` and `assets` done!"),
 				runner.archiveCacheArtifacts,
-				() => pause("Archive `apiCache`, `.cache` and `store` done!"),
+				() => pause("Archive LifeCycle"),
+			],
+		});
+
+		await doLifeCycle({
+			name: "Clean",
+			steps: [
+				() =>
+					removeArtifacts({
+						from: __cx,
+						artifacts: ["static", "apiCache"],
+					}),
+				() => pause("Clean LifeCycle"),
 			],
+			attempts: attempts.clean,
 		});
 	}
 }

package/exporter/adapters/gatsby/utils.ts

@@ -24,7 +24,6 @@ const attempts = {
 	clean: JSON.parse(process.env.GRIDDO_CLEAN_LIFECYCLE_MAX_ATTEMPTS || "1"),
 };
 
-
 /**
  * Return a runner, a serie of functions to manage the Gatsby render artifacts.
  */
@@ -58,10 +57,8 @@ function getGatsbyDomainRunner(domain: string) {
 	const assetPrefix = getGatsbyAssetPrefixSlug(domain);
 
 	const run = getEnvRunner({
-		DOMAIN: domain,
 		GRIDDO_ASSET_PREFIX: assetPrefix,
-		NEEDS_ASSET_DOMAIN_PREFIX: assetPrefix && assetPrefix !== "",
-		GRIDDO_RENDERID: new Date().valueOf(),
+		FOO: "true-and-false",
 	});
 
 	/**
@@ -378,4 +375,3 @@ function getGatsbyAssetPrefixSlug(domain: string) {
 }
 
 export { attempts, getGatsbyDomainRunner };
-

package/exporter/adapters/index.ts

@@ -1,5 +1,4 @@
-import { runAstroAdapter } from "./astro";
 import { runGatsbyAdapter } from "./gatsby";
 
-export type Adapters = "gatsby" | "astro";
-export { runAstroAdapter, runGatsbyAdapter };
+export type Adapters = "gatsby";
+export { runGatsbyAdapter };

package/exporter/services/robots.ts

@@ -8,6 +8,7 @@ dotenv.config();
 import dotenv from "dotenv";
 
 import { get } from "../utils/api";
+import { getConfig } from "../utils/temp-utils";
 
 /**
  * TODO: JSDoc
@@ -48,27 +49,29 @@ class RobotsService {
 	/**
 	 * Write robots.txt files for the current rendering domain.
 	 */
-	async writeFiles(basePath: string) {
+	async writeFiles(domain: string) {
+		const config = await getConfig();
+		const dirs = config.dirs(domain);
+		const distDirectory = path.join(dirs.__cx, "dist");
+
 		await this.getRobots();
 
-		const robot = this.robots.find(
-			({ path }) => path === `/${process.env.DOMAIN}`
-		);
+		const robot = this.robots.find(({ path }) => path === `/${domain}`);
 
 		if (!robot) {
-			console.log(`Robots not found for ${process.env.DOMAIN}`);
+			console.log(`Robots not found for ${domain}`);
 			return;
 		}
 
-		if (fs.existsSync(basePath)) {
+		if (fs.existsSync(distDirectory)) {
 			const fileLocation = JSON.parse(
 				process.env.GRIDDO_EXPORT_STRIP_DOMAIN_FROM_PATH || "false"
 			)
-				? path.join(basePath, "robots.txt")
-				: path.join(basePath, robot.path, "robots.txt");
+				? path.join(distDirectory, "robots.txt")
+				: path.join(distDirectory, robot.path, "robots.txt");
 			fs.writeFileSync(fileLocation, robot?.content);
 		} else {
-			console.log(`${basePath} not found`);
+			console.log(`${distDirectory} not found`);
 		}
 	}
 }

package/exporter/services/store.ts

@@ -39,7 +39,7 @@ dotenv.config();
 /* prettier-ignore */ const REACT_APP_INSTANCE = process.env.GRIDDO_REACT_APP_INSTANCE || process.env.REACT_APP_INSTANCE;
 /* prettier-ignore */ const API_CONCURRENCY_COUNT = parseInt(process.env.GRIDDO_API_CONCURRENCY_COUNT || "10");
 /* prettier-ignore */ const PUBLIC_API_URL = process.env.PUBLIC_API_URL as string;
-/* prettier-ignore */ const RENDER_ID = process.env.GRIDDO_RENDERID || new Date().valueOf().toString();
+/* prettier-ignore */ const RENDER_ID = new Date().valueOf().toString();
 
 /**
  * Fetch, process and save object pages and sites data into the file system to

package/exporter/types/global.ts

@@ -86,7 +86,13 @@ type LifeCyclesNames =
 	| "Archive"
 	| "Clean";
 
-type CXDir = "__exports" | "__cache" | "__cx" | "__ssg";
+type CXDir =
+	| "__exports"
+	| "__cache"
+	| "__cx"
+	| "__ssg"
+	| "__components"
+	| "__root";
 
 interface CXConfig {
 	proDomain: string;

package/exporter/utils/folders.ts

@@ -121,27 +121,22 @@ const clearEmptyDirs = (baseDir?: string) => {
 /**
  * Copy artifacts between CX valid directories.
  *
- * @param args.domain - The render domain
  * @param args.from - Source dir
  * @param args.to - Destination dir
  * @param args.artifacts - Artifact names
  * @param args.withBackup - Create a previous backup
  */
-async function copyArtifacts(args: {
-	domain: string;
-	from: CXDir;
-	to: CXDir;
+function copyArtifacts(args: {
+	from: string;
+	to: string;
 	artifacts: Array<string>;
 	withBackup?: boolean;
 }) {
-	const { artifacts, domain, from, to, withBackup } = args;
-
-	const config = await getConfig();
-	const dirs = config.dirs(domain);
+	const { artifacts, from, to, withBackup } = args;
 
 	for (const artifact of artifacts) {
-		const src = path.join(dirs[from], artifact);
-		const dest = path.join(dirs[to], artifact);
+		const src = path.join(from, artifact);
+		const dest = path.join(to, artifact);
 
 		// The dir we want to copy, doesn't exist.
 		if (!fsx.existsSync(src)) {
@@ -177,42 +172,27 @@ async function copyArtifacts(args: {
 /**
  * Move artifacts between CX valid directories.
  *
- * @param domain - The render domain
  * @param from - Source dir
  * @param to - Destination dir
  * @param artifacts - Artifact names
  *
  * @example
  * // normal
- * moveArtifacts({domain: domain, from: "__cx", to: "__ssg", ["dist"]})
- * // renaming
- * moveArtifacts({
- *
- * 	domain: domain,
- *  from: "__cx",
- *	to: "__ssg",
- * 	["foo", "taz", "bar"],
- * 	["foo", "taz", "bar-renamed"]
- *
- * })
+ * moveArtifacts({from: __cx, to: __ssg, ["dist"]})
  * // with backup
- * moveArtifacts({domain: domain, from: "__cx", to: "__ssg", ["dist"]})
+ * moveArtifacts({from: __cx, to: __ssg, ["dist"]})
  */
-async function moveArtifacts(args: {
-	domain: string;
-	from: CXDir;
-	to: CXDir;
+function moveArtifacts(args: {
+	from: string;
+	to: string;
 	artifacts: Array<string>;
 	withBackup?: boolean;
 }) {
-	const { artifacts, domain, from, to, withBackup } = args;
-
-	const config = await getConfig();
-	const dirs = config.dirs(domain);
+	const { artifacts, from, to, withBackup } = args;
 
 	for (const artifact of artifacts) {
-		const src = path.join(dirs[from], artifact);
-		const dest = path.join(dirs[to], artifact);
+		const src = path.join(from, artifact);
+		const dest = path.join(to, artifact);
 
 		// The dir we want to move, doesn't exist.
 		if (!fsx.existsSync(src)) {
@@ -246,27 +226,19 @@ async function moveArtifacts(args: {
 /**
  * Remove artifacts from CX valid directories.
  *
- * @param domain - The render domain
  * @param from - Source dir
  * @param to - Destination dir
  * @param artifacts - Artifact names
  *
  * @example
- * removeArtifacts(domain, "__cx", "__ssg", ["dist"], ["public"])
+ * removeArtifacts({from: __cx, to: __ssg, ["dist", "public"]})
  */
-async function removeArtifacts(args: {
-	domain: string;
-	from: CXDir;
-	artifacts: Array<string>;
-}) {
-	const { artifacts, domain, from } = args;
-
-	const config = await getConfig();
-	const dirs = config.dirs(domain);
+function removeArtifacts(args: { from: string; artifacts: Array<string> }) {
+	const { artifacts, from } = args;
 
 	for (const artifact of artifacts) {
 		if (artifact) {
-			const src = path.join(dirs[from], artifact);
+			const src = path.join(from, artifact);
 			if (fsx.existsSync(src)) {
 				spawnSync("rm", ["-rf", src]);
 			}

package/exporter/utils/instance.ts

@@ -62,15 +62,18 @@ function getComponentsLibAliases() {
 			};
 		},
 		{
+			// Por este motivo se puede hacer `... import from "@components" en
+			// los packages del monorepo.
+			"@components": `${resolveComponentsPath()}/src/index.js`,
 			components: `${resolveComponentsPath()}/src/index.js`,
 		}
 	);
 }
 
 export {
-	getComponentsJSConfig,
-	getComponentsLibAliases,
 	IS_COMPONENT_LIBRARY,
 	PROJECT_ALIASES,
+	getComponentsJSConfig,
+	getComponentsLibAliases,
 	resolveComponentsPath,
 };

package/exporter/utils/shared.ts

@@ -292,7 +292,7 @@ function pause(title: string) {
 
 	return new Promise<void>((resolve) => {
 		console.log("\n");
-		logBox(title, "🥓", 1, 0);
+		logBox(`⌛️ ${title}`, "", 1, 0);
 		process.stdin.once("data", () => {
 			resolve();
 		});

package/exporter/utils/sites.ts

@@ -1,4 +1,3 @@
-import type { BuildProcessData } from "../types/global";
 import type { Site, SiteData } from "../types/sites";
 
 import path from "node:path";
@@ -7,6 +6,8 @@ import fs from "fs-extra";
 import { parse } from "js2xmlparser";
 
 import { logInfo } from "./shared";
+import { getBuildMetadata } from "./store";
+import { getConfig } from "./temp-utils";
 import { AuthService } from "../services/auth";
 import { SitesService } from "../services/sites";
 
@@ -148,14 +149,16 @@ async function getSiteData(siteID: number) {
 
 /**
  * Save a file with the end of build process
- *
- * @param filePathName The pathname for the file report
- * @param buildProcessData The whole build process data.
  */
-async function generateBuildReport(
-	filePathName: string,
-	buildProcessData: BuildProcessData
-) {
+async function generateBuildReport() {
+	const config = await getConfig();
+	const dirs = config.dirs();
+
+	const DIST_FOLDER = path.join(dirs.__cx, "dist");
+
+	const { buildProcessData } = await getBuildMetadata();
+	const filePathName = path.join(DIST_FOLDER, "__build-report__.json");
+
 	// Get the token
 	const authControl = await AuthService.login();
 
@@ -179,8 +182,13 @@ async function generateBuildReport(
  *
  * @param sites An array of sites
  */
-async function generateSitemaps(sites: Array<Site>) {
-	const promisesOfSites = sites.map(async (site) => {
+async function generateSitemaps() {
+	const { sitesToPublish } = await getBuildMetadata();
+	const config = await getConfig();
+	const dirs = config.dirs();
+	const basePath = path.resolve(dirs.__cx, "dist");
+
+	const promisesOfSites = sitesToPublish.map(async (site) => {
 		const { id: siteID, languages } = site;
 
 		const promisesOfLanguages = languages.map(async (lang) => {
@@ -207,11 +215,9 @@ async function generateSitemaps(sites: Array<Site>) {
 			const sitemaps: Array<string> = [];
 			const sitemapPageGroupKeys = Object.keys(sitemapPagesGroup);
 
-			const sitemapBasePath = path.resolve(
-				__dirname,
-				`../../public/${
-					STRIP_DOMAIN_FROM_PATH ? slug.replace(domain, "") : slug
-				}`
+			const sitemapBasePath = path.join(
+				basePath,
+				`${STRIP_DOMAIN_FROM_PATH ? slug.replace(domain, "") : slug}`
 			);
 
 			for (const templateId of sitemapPageGroupKeys) {

package/exporter/utils/store.ts

@@ -9,6 +9,7 @@ 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";
 
 /**
@@ -44,9 +45,13 @@ async function* getBuildPages<PageType extends GriddoPageObject>(
  * Get the build metadata from the Store.
  * TODO: Refactorizar para leer un solo archivo: __metadata__.json
  */
-function getBuildMetadata(basePath: string): BuildMetaData {
+async function getBuildMetadata(): Promise<BuildMetaData> {
+	const config = await getConfig();
+	const dirs = config.dirs();
+	const storePath = path.join(dirs.__cx, "store");
+
 	const { sitesToPublish, createdPages, buildProcessData } = fsx.readJSONSync(
-		path.resolve(basePath, "metadata", "render-info.json")
+		path.resolve(storePath, "metadata", "render-info.json")
 	);
 	return {
 		buildProcessData,

package/exporter/utils/temp-utils.ts

@@ -1,3 +1,19 @@
+import path from "node:path";
+
+import fsx from "fs-extra";
+
+function getConfigSync() {
+	try {
+		// eslint-disable-next-line @typescript-eslint/no-var-requires, node/no-missing-require, node/no-unpublished-require
+		const configModule = require("../../cx.config");
+		const config = configModule.default;
+
+		return config;
+	} catch (error) {
+		process.exit(1);
+	}
+}
+
 async function getConfig() {
 	try {
 		// eslint-disable-next-line node/no-unpublished-import
@@ -10,4 +26,61 @@ async function getConfig() {
 	}
 }
 
-export { getConfig };
+/**
+ * Update the Griddo's `/dist` dir with the contents from `public` dir only
+ * with files of type: js, json and css.
+ */
+async function legacy__createDistFromGatsbyPublic(
+	domain: string,
+	needsAssetPrefix: boolean
+) {
+	const config = await getConfig();
+	const dirs = config.dirs(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 validFiles = fsx
+		.readdirSync(publicDir)
+		.filter(
+			(file) =>
+				path.extname(file) === ".js" ||
+				path.extname(file) === ".json" ||
+				path.extname(file) === ".css"
+		);
+
+	const pageDataSrc = `${publicDir}/page-data`;
+	const pageDataDest = `${cxAssetsDir}/page-data`;
+
+	const projectStaticSrc = path.resolve(dirs.__cx, "./static");
+	const projectStaticDest = cxAssetsDir;
+
+	const gatsbyStaticSrc = `${cxDistDir}/static`;
+	const gatsbyStaticDest = `${cxAssetsDir}/static`;
+
+	try {
+		fsx.mkdirSync(cxAssetsDir, { recursive: true });
+		fsx.copySync(publicDir, cxDistDir);
+
+		if (needsAssetPrefix) {
+			fsx.copySync(pageDataSrc, pageDataDest);
+			fsx.copySync(projectStaticSrc, projectStaticDest, { overwrite: false });
+			fsx.copySync(gatsbyStaticSrc, gatsbyStaticDest, { overwrite: false });
+			fsx.copySync(projectStaticSrc, cxDistDirWithDomain, {
+				overwrite: false,
+			});
+
+			validFiles.map(async (file) => {
+				const fileSrc = `${publicDir}/${file}`;
+				const fileDest = `${cxAssetsDir}/${file}`;
+				fsx.copySync(fileSrc, fileDest);
+			});
+		}
+	} catch (err) {
+		console.error(err);
+	}
+}
+
+export { legacy__createDistFromGatsbyPublic, getConfig, getConfigSync };

package/gatsby-browser.tsx

@@ -1,8 +1,7 @@
 import type { GatsbyBrowser } from "gatsby";
 
+import { browser } from "@components";
 import { SessionProvider } from "@griddo/core";
-// @ts-expect-error components is unknown
-import { browser } from "components";
 import * as React from "react";
 
 export const disableCorePrefetching = () => {

package/gatsby-config.ts

@@ -6,7 +6,8 @@ import { resolveComponentsPath } from "./exporter/utils/instance";
 
 dotenv.config();
 
-// Envs
+// Este process.env.GRIDDO_ASSET_PREFIX se lee porque se ha introducido en
+// `getEnvRunner()`.
 const GRIDDO_ASSET_PREFIX = process.env.GRIDDO_ASSET_PREFIX || undefined;
 
 // Gatsby configuration file from client

package/gatsby-node.ts

@@ -2,67 +2,38 @@ import type { GatsbyNode } from "gatsby";
 
 import path from "node:path";
 
-import { RobotsService } from "./exporter/services/robots";
 import { logInfo, logPageSize } from "./exporter/utils/shared";
-import { generateBuildReport, generateSitemaps } from "./exporter/utils/sites";
-import { getBuildMetadata, getBuildPages } from "./exporter/utils/store";
-import {
-	getMatchPath,
-	prepareStaticDir,
-	updateDist,
-} from "./src/gatsby-node-utils";
+import { getBuildPages } from "./exporter/utils/store";
+import { getConfigSync } from "./exporter/utils/temp-utils";
+import { getMatchPath } from "./src/gatsby-node-utils";
 import { GatsbyPageObject } from "./src/types";
 
-const publicDirPath = path.resolve(__dirname, "./public");
-const storeDirPath = path.resolve(__dirname, "./store/");
-const reportFilePath = path.resolve(publicDirPath, "__build-report__.json");
-const gatsbyTemplateFile = path.resolve(
-	__dirname,
-	"./src/components/template.tsx"
-);
+const dirs = getConfigSync().dirs();
+const storeDir = path.join(dirs.__cx, "store");
+const templateFile = path.join(dirs.__ssg, "src/components/template.tsx");
 
-// onPreInit
-const onPreInit = async () => {
-	prepareStaticDir();
-};
-
-// createPages
-const createPages: GatsbyNode["createPages"] = async ({
-	actions: { createPage },
-}) => {
-	const pages = getBuildPages<GatsbyPageObject>(storeDirPath);
+const createPages: GatsbyNode["createPages"] = async ({ actions }) => {
+	const pages = getBuildPages<GatsbyPageObject>(storeDir);
 
 	for await (const page of pages) {
-		// SECURITY
-		if (!page) {
-			return;
-		}
+		if (!page) return;
+
 		const { domain, compose } = page.context.fullPath;
 		const matchPath = getMatchPath(domain, compose);
 
-		page.component = gatsbyTemplateFile;
+		page.component = templateFile;
 		page.matchPath = matchPath;
 
-		createPage(page);
+		actions.createPage(page);
 
-		logInfo(
-			`Creating page ${page.path} - ${page.context.id} - ${logPageSize(
-				Math.round(page.size || 0)
-			)}`
-		);
-	}
-};
-
-// onPostBuild
-const onPostBuild = async () => {
-	const { buildProcessData, sitesToPublish } = getBuildMetadata(storeDirPath);
+		const path = page.path;
+		const id = page.context.id;
+		const size = logPageSize(Math.round(page.size || 0));
 
-	await generateBuildReport(reportFilePath, buildProcessData);
-	await RobotsService.writeFiles(publicDirPath);
-	await generateSitemaps(sitesToPublish);
-	await updateDist();
+		logInfo(`Creating page ${path} - ${id} - ${size}`);
+	}
 };
 
 // onCreateWebpackConfig
 export { onCreateWebpackConfig } from "./src/gatsby-node-utils";
-export { createPages, onPostBuild, onPreInit };
+export { createPages };