@griddo/cx 1.75.236 → 1.75.238

package/src/utils/cache.ts

@@ -5,6 +5,8 @@ import crypto from "crypto";
 import fs from "fs";
 import path from "path";
 
+import fsx from "fs-extra";
+
 // Consts
 const API_CACHE_DIR_PATH = path.resolve(__dirname, "./../../apiCache");
 const SITE_HASH_FILENAME = `${API_CACHE_DIR_PATH}/siteHash.json`;
@@ -73,10 +75,10 @@ function saveCache<T>(petition: Petition, content: T) {
 function searchCacheData<T>(petition: Petition) {
 	try {
 		const file = generateFilenameWithHash(petition);
-		const content = fs.readFileSync(file, {
+		const jsonData = fsx.readJSONSync(file, {
 			encoding: "utf-8",
 		});
-		return JSON.parse(content) as T;
+		return jsonData as T;
 	} catch {
 		return null;
 	}
@@ -87,9 +89,10 @@ function searchCacheData<T>(petition: Petition) {
  */
 function getHashSites(): HashSites {
 	try {
-		const content = fs.readFileSync(SITE_HASH_FILENAME, { encoding: "utf-8" });
-
-		return JSON.parse(content) || {};
+		const jsonData = fsx.readJSONSync(SITE_HASH_FILENAME, {
+			encoding: "utf-8",
+		});
+		return jsonData || {};
 	} catch {
 		return {};
 	}

package/src/utils/health-checks.ts

@@ -0,0 +1,60 @@
+import { logBox } from "./shared";
+
+const GRIDDO_SKIP_BUILD_CHECKS = process.env.GRIDDO_SKIP_BUILD_CHECKS;
+const GRIDDO_ENVS_VARS: ReadonlyArray<string> = [];
+
+/**
+ * Check if the environment is secure to launch a render.
+ * If something fails throws an error and exit
+ */
+function buildHealthCheck() {
+	// Bypass the check using this env var, handy for local renders.
+	if (GRIDDO_SKIP_BUILD_CHECKS) {
+		console.info(`🫥 Build health check skipped`);
+
+		return true;
+	}
+
+	// Checklist
+	const envsVars = checkEnvsVars(GRIDDO_ENVS_VARS);
+
+	// Render is safe if...
+	const renderingIsSave = envsVars;
+
+	// The environment is suitable for a build-render
+	if (renderingIsSave) {
+		console.info("✅ Build health check passed");
+
+		return true;
+	}
+
+	// Error
+	logBox(`Error. The environment is not suitable for a build.`);
+	process.exit(1);
+}
+
+/**
+ * Check if a list of environments variables exist with any value.
+ *
+ * @todo Also check the value.
+ * @param envs An array of environments variables
+ * @returns exists with (1) if there are missing envs vars
+ */
+function checkEnvsVars(envs: ReadonlyArray<string>) {
+	const missingEnvs = envs.filter((envName) => {
+		return !process.env[envName];
+	});
+
+	if (missingEnvs.length) {
+		const missingEnvsMsg = missingEnvs.join("\n");
+		console.log(
+			`ENV CHECK FAILED. These envs vars are missing: \n\n${missingEnvsMsg}`
+		);
+
+		return false;
+	}
+
+	return true;
+}
+
+export { buildHealthCheck };

package/src/utils/pages.ts

@@ -142,14 +142,11 @@ async function createGatsbyPageObject(
 	} = additionalInfo;
 
 	// Update page object
-	page = {
-		...page,
-		breadcrumb,
-		siteSlug,
-		apiUrl: baseUrl,
-		publicApiUrl: additionalInfo.publicBaseUrl,
-		instance: additionalInfo.instance,
-	};
+	page.breadcrumb = breadcrumb;
+	page.siteSlug = siteSlug;
+	page.apiUrl = baseUrl;
+	page.publicApiUrl = additionalInfo.publicBaseUrl;
+	page.instance = additionalInfo.instance;
 
 	const foundLanguage = siteLangs.find(({ id }) => id === page?.language);
 	const locale = foundLanguage?.locale.replace(/_/g, "-");
@@ -240,7 +237,7 @@ async function createGatsbyPageObject(
  * @param page A Griddo single page object.
  * @param additionalInfo Additional page info.
  */
-async function createGriddoSinglePage(
+async function createGriddoSinglePageForGatsby(
 	page: GriddoSinglePage,
 	additionalInfo: PageAdditionalInfo
 ) {
@@ -250,7 +247,7 @@ async function createGriddoSinglePage(
 /**
  * Create multiples pages from one page as list paginated pages
  */
-async function createGriddoListPages(
+async function createGriddoListPagesForGatsby(
 	{
 		page,
 		pages,
@@ -309,7 +306,7 @@ async function createGriddoListPages(
  * @param page A Griddo Multipage object.
  * @param additionalInfo Additional page info.
  */
-function createGriddoMultiPages(
+function createGriddoMultiPagesForGatsby(
 	page: GriddoMultiPage,
 	additionalInfo: PageAdditionalInfo
 ) {
@@ -375,7 +372,9 @@ function createGriddoMultiPages(
  *
  * @param page The page to get the multipage parts.
  */
-function getMultiPageElements(page: TemplateWithDistributor) {
+function getMultiPageElements(
+	page: TemplateWithDistributor
+): Promise<MultiPageElements> | null {
 	const multiPageElements = new Promise((resolve) => {
 		// Recursive
 		const getMultiPageComponent = (
@@ -542,9 +541,9 @@ function addPageNumberToTitle(title: string, pageNumber: number) {
 }
 
 export {
-	createGriddoListPages,
-	createGriddoMultiPages,
-	createGriddoSinglePage,
+	createGriddoListPagesForGatsby,
+	createGriddoMultiPagesForGatsby,
+	createGriddoSinglePageForGatsby,
 	getMultiPageElements,
 	getPaginatedPages,
 };

package/src/utils/shared.ts

@@ -1,12 +1,13 @@
+import type { APIResponses } from "../types/api";
+import type { APIPageObject } from "../types/pages";
+import type { Site } from "../types/sites";
+
 import chalk from "chalk";
 import dotenv from "dotenv";
 import fs from "fs-extra";
 import gradient from "gradient-string";
 
 import { version } from "../../package.json";
-import { APIResponses } from "../types/api";
-import { APIPageObject } from "../types/pages";
-import { Site } from "../types/sites";
 
 dotenv.config();
 

package/src/utils/sites.ts

@@ -11,7 +11,6 @@ import { deleteSites } from "./folders";
 import { logInfo } from "./shared";
 import { AuthService } from "../services/auth";
 import { SitesService } from "../services/sites";
-import { AllPagesResponse } from "../types/api";
 
 // Envs
 const API_URL = process.env.API_URL;
@@ -132,10 +131,6 @@ async function getSiteData(siteID: number) {
 	const socials = await SitesService.getSocials(siteID);
 	const siteLangsInfo = siteLangs.items;
 	const defaultLang = siteLangsInfo.find((lang) => lang.isDefault);
-	// TODO: Eliminado para validar que efectivamente no rompe nada si el cambio
-	// es correcto, hay que eliminar las 7 líneas que contienen "sitePages":
-	// const sitePages = await SitesService.getPages(siteID, cacheKey);
-	const sitePages: AllPagesResponse = [];
 
 	const { siteHash, unpublishHashes, publishIds } = buildData;
 	const { headers, footers } = siteInfo;
@@ -153,7 +148,6 @@ async function getSiteData(siteID: number) {
 		headers,
 		footers,
 		socials,
-		sitePages,
 	};
 
 	return siteData;
@@ -217,7 +211,7 @@ async function generateSitemaps(sites: Array<Site>) {
 			if (!langDomain) return;
 
 			const slug = Object.values(langDomain)[0];
-			const sitemaps: string[] = [];
+			const sitemaps: Array<string> = [];
 			const sitemapPageGroupKeys = Object.keys(sitemapPagesGroup);
 
 			const sitemapBasePath = path.resolve(