@griddo/cx 11.2.8 → 11.2.9

package/exporter/utils/render.ts

@@ -28,7 +28,7 @@ function deleteSentinelRenderFile() {
 	fs.unlinkSync(renderSentinelFile);
 }
 
-function isValidRenderProcessOrThrow() {
+function isValidRender() {
 	const { __cx } = config.paths();
 	const renderSentinelFile = path.join(__cx, ".render-sentinel");
 	if (!fs.existsSync(renderSentinelFile)) {
@@ -36,14 +36,6 @@ function isValidRenderProcessOrThrow() {
 	}
 }
 
-function initRender() {
-	createSentinelRenderFile();
-}
-
-function finishRender() {
-	return undefined;
-}
-
 /**
  * Send the default registers through Griddo alerts.
  */
@@ -74,9 +66,6 @@ function sendGriddoDefaultAlerts() {
 export {
 	createSentinelRenderFile,
 	deleteSentinelRenderFile,
-	finishRender,
-	initRender,
-	isValidRenderProcessOrThrow,
-	sendGriddoDefaultAlerts
+	isValidRender,
+	sendGriddoDefaultAlerts,
 };
-

package/exporter/utils/sites.ts

@@ -12,7 +12,7 @@ import { getBuildMetadata } from "./store";
 import { AuthService } from "../services/auth";
 import {
 	endSiteRender,
-	getAllSitesFromDomain,
+	getAllSites,
 	getSiteInfo,
 	getSiteLanguages,
 	getSitemap,
@@ -26,19 +26,56 @@ const config = getConfig();
  * Check the instance sites and returns site prepared to be published and unpublished.
  */
 async function getSitesToRender(domain: string) {
-	const allSites = await getAllSitesFromDomain(domain);
+	console.info(`API URL ${envs.GRIDDO_API_URL as string}`);
+
+	// Login to API
+	await AuthService.login();
+
+	// Get all sites. An array of Site
+	const allSites = await getAllSites(domain);
+
+	// Filter the array of sites to get only the ones to build/render
+	const validSites = envs.GRIDDO_RENDER_ALL_SITES
+		? allSites.filter(
+				(site) =>
+					!envs.GRIDDO_RENDER_SITE || site.id === envs.GRIDDO_RENDER_SITE,
+			)
+		: allSites.filter((site) =>
+				envs.GRIDDO_RENDER_SITE
+					? site.id === envs.GRIDDO_RENDER_SITE
+					: !!site.shouldBeUpdated,
+			);
+
+	// If there are valid sites...
+	// En este paso se añade al objeto `Site` la información de los dominios
+	// utilizando los idiomas.
+	if (validSites.length) {
+		for (const site of validSites) {
+			const { items } = await getSiteLanguages(site.id);
+
+			// Añadimos la prop domains con el dominio "cocinado" con los
+			// idiomas y teniendo en cuenta solo el dominio actual.
+			site.domains = items
+				.filter(
+					(item) =>
+						item.domain &&
+						(item.domain.slug === domain || item.domain.slug === `/${domain}`),
+				)
+				.map((item) => ({ [item.id]: `${item.domain.slug}${item.path}` }));
+		}
+	}
 
 	// Save sites object to publish
-	const sitesToPublish = allSites.filter((site) => {
-		return envs.GRIDDO_RENDER_SITE
+	const sitesToPublish = validSites.filter((site) =>
+		envs.GRIDDO_RENDER_SITE
 			? site.id === envs.GRIDDO_RENDER_SITE
-			: !!site.isPublished;
-	});
+			: !!site.isPublished,
+	);
 
 	// Save sites object to unpublish
-	const sitesToUnpublish = allSites.filter((site) => {
-		return !site.isPublished && site.shouldBeUpdated;
-	});
+	const sitesToUnpublish = validSites.filter(
+		(site) => !site.isPublished && site.shouldBeUpdated,
+	);
 
 	return {
 		sitesToPublish,

package/exporter/utils/store.ts

@@ -21,7 +21,9 @@ const config = getConfig();
  *
  * @param domain - The domain to get the pages from.
  */
-function getBuildPagesFromCachedStore<PageType extends GriddoPageObject>(domain: string) {
+function getBuildPagesFromCachedStore<PageType extends GriddoPageObject>(
+	domain: string,
+) {
 	const { __cache } = config.paths(domain);
 	return getBuildPagesFromStore<PageType>({
 		basePath: path.join(__cache, "store"),
@@ -45,7 +47,9 @@ function* getBuildPagesFromStore<PageType extends GriddoPageObject>(args?: {
 	const { __cx } = config.paths();
 	const pagesDirPath = basePath || path.join(__cx, "store");
 
-	const jsonFilePaths = walkStore(pagesDirPath).filter((file) => path.extname(file) === ".json");
+	const jsonFilePaths = walkStore(pagesDirPath).filter(
+		(file) => path.extname(file) === ".json",
+	);
 
 	for (const filePath of jsonFilePaths) {
 		try {
@@ -77,7 +81,9 @@ function getBuildPagesPath() {
 	const { __cx } = config.paths();
 
 	const PAGES_DIR = path.join(__cx, "store");
-	const PAGE_FILES = walk(PAGES_DIR).filter((file) => path.extname(file) === ".json");
+	const PAGE_FILES = walk(PAGES_DIR).filter(
+		(file) => path.extname(file) === ".json",
+	);
 
 	return PAGE_FILES;
 }
@@ -98,21 +104,6 @@ async function getBuildMetadata(): Promise<BuildMetaData> {
 	};
 }
 
-/**
- * Creates an `store` dir to store pages transformed by createStore
- */
-function createStoreDir() {
-	const { __cx } = config.paths();
-	const storeDir = path.join(__cx, "store");
-
-	if (!fs.existsSync(storeDir)) {
-		fs.mkdirSync(storeDir);
-		fs.mkdirSync(path.join(storeDir, "metadata"));
-	}
-
-	console.info("Store initialized");
-}
-
 /**
  * Write render info into a file.
  * @param renderInfo - Data that will be saved related to the render process.
@@ -120,7 +111,10 @@ function createStoreDir() {
 function saveRenderInfoInStore(renderInfo: RenderInfo) {
 	const { __cx } = config.paths();
 
-	fs.writeFileSync(path.join(__cx, "render-metadata.json"), JSON.stringify(renderInfo));
+	fs.writeFileSync(
+		path.join(__cx, "render-metadata.json"),
+		JSON.stringify(renderInfo),
+	);
 }
 
 /**
@@ -180,14 +174,17 @@ function getPageInStoreDir(basePath: string): Array<number> {
  * Save the pages into the file system.
  * @param pages - An array of Griddo page objects to be saved.
  */
-function savePagesInStore(siteFolderName: string, pages: Array<GriddoPageObject>) {
+function saveSitePagesInStore(
+	siteDirName: string,
+	pages: Array<GriddoPageObject>,
+) {
 	const { __cx } = config.paths();
 
 	try {
 		for (const page of pages) {
 			removeProperties(page, ["editorID", "parentEditorID"]);
 			const filename = `${page.context.page.id}.json`;
-			const filePath = path.join(__cx, "store", siteFolderName, filename);
+			const filePath = path.join(__cx, "store", siteDirName, filename);
 			fsx.writeJSONSync(filePath, page);
 		}
 	} catch (error) {
@@ -196,156 +193,44 @@ function savePagesInStore(siteFolderName: string, pages: Array<GriddoPageObject>
 }
 
 /**
- * Remove files from dir.
- * @param filenames - An array of ids representing file page names.
+ * Removes JSON files from the specified site directory based on the provided arrays of page numbers.
+ * For each number in the arrays, a corresponding file with the format `<number>.json` is removed if it exists.
+ *
+ * WARNING: This function may end up handling large arrays, so don't be tempted
+ * to refactor it to use something cool like the spread operator and make a
+ * single array, etc..
+ *
+ * @param siteDirName - The name of the site directory containing the pages.
+ * @param pageIdsArray - A two-dimensional array where each inner array contains numbers representing page files to be removed.
  */
-function removeSitePagesFromStore(siteDirName: string, filenames: Array<number>) {
+function removeSitePagesFromStore(
+	siteDirName: string,
+	pageIdsArray: Array<Array<number>>,
+) {
 	const { __cx } = config.paths();
 
-	if (filenames.length === 0) {
-		return;
-	}
-
-	for (const filename of filenames) {
-		const filePath = path.join(__cx, "store", siteDirName, `${filename}.json`);
-		try {
-			fs.unlinkSync(filePath);
-		} catch (error) {
-			console.log(error);
-			throw new Error(`Error removing file ${filename}`);
+	const processPageIdsArray = (pageIds: Array<number>) => {
+		for (const filename of pageIds) {
+			const filePath = path.join(
+				__cx,
+				"store",
+				siteDirName,
+				`${filename}.json`,
+			);
+			try {
+				if (fs.existsSync(filePath)) {
+					fs.unlinkSync(filePath);
+					verboseLog(`Removed file: ${filePath}`);
+				}
+			} catch (error) {
+				console.log(error);
+				throw new Error(`Error removing file ${filename}`);
+			}
 		}
-	}
-}
-
-/**
- * Returns pages that need to be created or deleted for a site in the store based on the provided arguments.
- * @param sitePages - Properties for page retrieval.
- * @param props.storeDir - Absolute path of the Griddo store.
- * @param props.pages - Exhaustive array of all pages in the site.
- * @param props.validPagesIds - Array of valid pages in the site.
- * @param props.changedPages - Array of pages that have been modified in the site.
- * @returns - An object containing the pages to be created and deleted in the site.
- */
-async function getSitePagesToCreateOrDelete(sitePages: {
-	sitesToPublish: Array<Site>;
-	validPagesIds: Array<number>;
-	changedPages: Array<number>;
-	siteDirName: string;
-}) {
-	const { __cx } = config.paths();
-	const storeDir = path.join(__cx, "store");
-	const { changedPages, validPagesIds, siteDirName } = sitePages;
-
-	// Array<ids> de las páginas que están físicamente en el store en el
-	// site actual del bucle.
-	const siteDirStorePath = path.join(storeDir, siteDirName);
-	const pagesInStore = getPageInStoreDir(siteDirStorePath);
-
-	// Array<ids> que están el `validPagesIds` pero no están por algún
-	// motivo en el store. Se incluyen porque deben ser creadas.
-	const pagesMissingInStore = validPagesIds.filter((page) => !pagesInStore.includes(page));
-
-	// Array<ids> para enviar al store, que son las que han cambiado y
-	// las missings.
-	const pagesToStore = pagesMissingInStore.concat(changedPages);
-
-	// Array<ids> de las páginas que han sido eliminadas para quitarlas
-	// físicamente de la carpeta store.
-	const pagesToDeleteFromStore = pagesInStore.filter((page) => {
-		// Las que no estén en validPages
-		return !validPagesIds.includes(page);
-	});
-
-	// 1 - Elimina del array final las páginas borradas.
-	// 2 - Elimina las posibles páginas (ids) duplicadas. (new Set)
-	const pagesToWriteToStore = Array.from(new Set(pagesToStore)).filter(
-		(page) => !pagesToDeleteFromStore.includes(page),
-	);
-
-	return {
-		pagesInStore,
-		pagesMissingInStore,
-		pagesToDeleteFromStore: [
-			...pagesToDeleteFromStore,
-			// ...pagesFromInvalidSites,
-		],
-		pagesToWriteToStore,
-	};
-}
-
-/**
- * Returns pages that need to be created or deleted for a site in the store based on the provided arguments.
- * @param sitePages - Properties for page retrieval.
- * @param props.storeDir - Absolute path of the Griddo store.
- * @param props.pages - Exhaustive array of all pages in the site.
- * @param props.validPagesIds - Array of valid pages in the site.
- * @param props.changedPages - Array of pages that have been modified in the site.
- * @returns - An object containing the pages to be created and deleted in the site.
- */
-async function getSitePagesToCreateOrDeleteCached(sitePages: {
-	sitesToPublish: Array<Site>;
-	validPagesIds: Array<number>;
-	changedPages: Array<number>;
-	siteDirName: string;
-	domain: string;
-}) {
-	const { changedPages, validPagesIds, siteDirName, domain } = sitePages;
-
-	const { __cache } = config.paths(domain);
-	const storeDir = path.join(__cache, "store");
-
-	// Array<ids> de las páginas que están físicamente en el store en el
-	// site actual del bucle.
-	const siteDirStorePath = path.join(storeDir, siteDirName);
-	const pagesInStore = getPageInStoreDir(siteDirStorePath);
-
-	// Array<ids> que están el `validPagesIds` pero no están por algún
-	// motivo en el store. Se incluyen porque deben ser creadas.
-	const pagesMissingInStore = validPagesIds.filter((page) => !pagesInStore.includes(page));
-
-	// Array<ids> para enviar al store, que son las que han cambiado y
-	// las missings.
-	const pagesToStore = pagesMissingInStore.concat(changedPages);
-
-	// Array<ids> de las páginas que han sido eliminadas para quitarlas
-	// físicamente de la carpeta store.
-	const pagesToDeleteFromStore = pagesInStore.filter((page) => {
-		// Las que no estén en validPages
-		return !validPagesIds.includes(page);
-	});
-
-	// 1 - Elimina del array final las páginas borradas.
-	// 2 - Elimina las posibles páginas (ids) duplicadas. (new Set)
-	const pagesToWriteToStore = Array.from(new Set(pagesToStore)).filter(
-		(page) => !pagesToDeleteFromStore.includes(page),
-	);
-
-	return {
-		pagesInStore,
-		pagesMissingInStore,
-		pagesToDeleteFromStore: [
-			...pagesToDeleteFromStore,
-			// ...pagesFromInvalidSites,
-		],
-		pagesToWriteToStore,
 	};
-}
 
-/**
- * Removes sites from store that are not in `sitesToPublish` array.
- */
-function deleteZombieSitesFoldersFromStore(sitesToPublish: Array<Site>) {
-	const { __cx } = getConfig().paths();
-	const storeDir = path.join(__cx, "store");
-	const siteDirs = fs.readdirSync(storeDir, { withFileTypes: true });
-	const siteIds = sitesToPublish.map((site) => `${site.id}`);
-	for (const dir of siteDirs) {
-		if (dir.isDirectory() && !siteIds.includes(dir.name)) {
-			fs.rmSync(path.join(storeDir, dir.name), {
-				force: true,
-				recursive: true,
-			});
-		}
+	for (const pageIds of pageIdsArray) {
+		processPageIdsArray(pageIds);
 	}
 }
 
@@ -358,7 +243,9 @@ function removeOrphanSites(sitesToPublish: Array<Site>, domain: string) {
 	const { __cx } = getConfig().paths(domain);
 	const currentSitesInStore = fs.readdirSync(path.join(__cx, "store"));
 	const sitesFromAPI = sitesToPublish.map(({ id }) => `${id}`);
-	const sitesToDelete = currentSitesInStore.filter((site) => !sitesFromAPI.includes(site));
+	const sitesToDelete = currentSitesInStore.filter(
+		(site) => !sitesFromAPI.includes(site),
+	);
 
 	for (const site of sitesToDelete) {
 		fs.rmSync(path.join(__cx, "store", site), { recursive: true, force: true });
@@ -366,18 +253,55 @@ function removeOrphanSites(sitesToPublish: Array<Site>, domain: string) {
 	}
 }
 
+/**
+ * Returns the list of `activePages` pages that do not currently exist in a
+ * site's store (probably due to a failed render).
+ */
+function getMissingPublishedPagesInStore(
+	siteName: string,
+	activePages: Array<number>,
+) {
+	const { __cx } = config.paths();
+	const pagesInStore = getPageInStoreDir(path.join(__cx, "store", siteName));
+	const missingActivePages: Array<number> = [];
+	for (const activePage of activePages) {
+		if (!pagesInStore.includes(activePage)) {
+			missingActivePages.push(activePage);
+		}
+	}
+	return missingActivePages;
+}
+
+/**
+ * Get pages that are not active anymore but are in the store.
+ */
+function getZombiePagesInStore(siteDir: string, pages: Array<number>) {
+	const { __cx } = getConfig().paths();
+	const storeDir = path.join(__cx, "store", siteDir);
+	const sitePages = fs.readdirSync(storeDir);
+
+	let zombiePages: Array<number> = [];
+	for (const pageFileName of sitePages) {
+		const pageFileNameWithoutExtension = pageFileName.split(".")[0];
+		const pageId = Number.parseInt(pageFileNameWithoutExtension);
+		if (!pages.includes(pageId)) {
+			zombiePages.push(pageId);
+		}
+	}
+
+	return zombiePages;
+}
+
 export {
-	createStoreDir,
-	deleteZombieSitesFoldersFromStore,
 	getBuildMetadata,
 	getBuildPagesFromCachedStore,
 	getBuildPagesFromStore,
 	getBuildPagesPath,
+	getMissingPublishedPagesInStore,
 	getPageInStoreDir,
-	getSitePagesToCreateOrDelete,
-	getSitePagesToCreateOrDeleteCached,
+	getZombiePagesInStore,
 	removeOrphanSites,
 	removeSitePagesFromStore,
-	savePagesInStore,
+	saveSitePagesInStore,
 	saveRenderInfoInStore,
 };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "11.2.8",
+	"version": "11.2.9",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -38,9 +38,9 @@
 		"build": "sh ./exporter/build.sh",
 		"build:debug": "sh ./exporter/build.sh --debug",
 		"// TESTS": "",
-		"test": "tsx ./__tests__/utils/tests-health.ts && jest --verbose",
-		"test:create-render-fixtures": "tsx ./__tests__/utils/create-fixtures.ts",
-		"test:remove-render-fixtures": "tsx ./__tests__/utils/remove-fixtures.ts",
+		"test": "NODE_OPTIONS='--import tsx' env-cmd node --test ./__tests__/*",
+		"test:create-render-fixtures": "env-cmd tsx ./__tests__/utils/create-fixtures.ts",
+		"test:remove-render-fixtures": "env-cmd tsx ./__tests__/utils/remove-fixtures.ts",
 		"// INFRA SCRIPTS": "",
 		"upload-search-content": "node ./build/upload-search-content.js",
 		"complete-render": "node ./build/end-render.js",
@@ -65,7 +65,7 @@
 		"@babel/preset-env": "7.26.0",
 		"@babel/preset-react": "7.26.3",
 		"@babel/preset-typescript": "7.26.0",
-		"@griddo/core": "11.2.8",
+		"@griddo/core": "11.2.9",
 		"@svgr/webpack": "5.5.0",
 		"axios": "1.7.9",
 		"babel-loader": "9.2.1",
@@ -90,7 +90,6 @@
 		"@types/cheerio": "0.22.35",
 		"@types/eslint": "8.56.10",
 		"@types/fs-extra": "11.0.4",
-		"@types/jest": "29.5.14",
 		"@types/node": "20.17.10",
 		"@types/webpack": "5.28.5",
 		"@typescript-eslint/eslint-plugin": "^8.0.0",
@@ -103,9 +102,7 @@
 		"eslint-plugin-react-hooks": "^4.6.0",
 		"eslint-plugin-testing-library": "^6.2.0",
 		"globals": "^16.0.0",
-		"jest": "29.7.0",
-		"prettier": "3.4.2",
-		"ts-jest": "29.2.5"
+		"prettier": "3.4.2"
 	},
 	"peerDependencies": {
 		"@types/react": ">=18 <19",
@@ -133,5 +130,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "058e6737daf99b0f3651067d326446e7747a0403"
+	"gitHead": "7ccf2bdd0e654a539eb8fadc4a419152d7623b66"
 }

package/build/utils/publish.d.ts

@@ -1,7 +0,0 @@
-/**
- * Spawn a new node process to upload the domain content.
- * @note This proccess can not access to the custom Griddo `process.env` so it
- * needs variables passed to it via the `env` prop
- */
-declare function publishDomain(domain: string): string;
-export { publishDomain };

package/exporter/utils/publish.ts

@@ -1,29 +0,0 @@
-import { spawn } from "node:child_process";
-
-import dotenv from "dotenv";
-
-import { getConfig } from "./core-utils";
-
-dotenv.config();
-
-/**
- * Spawn a new node process to upload the domain content.
- * @note This proccess can not access to the custom Griddo `process.env` so it
- * needs variables passed to it via the `env` prop
- */
-function publishDomain(domain: string) {
-	return domain;
-	// const config = getConfig();
-	// const { __exports_dist } = config.paths(domain);
-	// const command = spawn("aws-scyn", [".", "bucket"], {
-	// 	cwd: __exports_dist,
-	// 	stdio: ["ignore", "inherit", "ignore"],
-	// 	shell: true,
-	// });
-
-	// command.on("error", (error) => {
-	// 	console.error("Error in publishDomain:", error);
-	// });
-}
-
-export { publishDomain };