@griddo/cx 1.75.222 → 1.75.224

package/src/utils/api.ts

@@ -12,7 +12,7 @@ import axios from "axios";
 import chalk from "chalk";
 import dotenv from "dotenv";
 
-import { getCache, saveCache } from "./cache";
+import { searchCacheData, saveCache } from "./cache";
 import { delay, getSafeSiteId, logInfo, msToSec } from "./shared";
 import { AuthService } from "../services/auth";
 
@@ -32,26 +32,35 @@ const {
  * @example
  *	const response = await requestAPI<Site>({
  *		endpoint: "...",
- *		cached: true,
+ *		cacheKey: "..."",
  *	}, { method:"get" });
  */
 async function requestAPI<T extends APIResponses>(
-	props: APIRequest & { method: Method }
+	props: APIRequest & { method: Method },
+	appendToLog = ""
 ): Promise<T> {
-	const { endpoint, body, cached, attempt = 1, method, headers } = props;
-	const cacheOptions = { endpoint, body, cached };
+	const { endpoint, body, cacheKey = "", attempt = 1, method, headers } = props;
+	const cacheOptions = { endpoint, body, headers, cacheKey };
 
 	// Cache
-	if (cached) {
-		const cacheData = getCache<T>(cacheOptions);
+	if (cacheKey) {
+		const start = new Date();
+		const cacheData = searchCacheData<T>(cacheOptions);
 
 		if (cacheData) {
+			const siteId = getSafeSiteId(cacheData);
+			const siteIdMsg = siteId ? `site: ${siteId}` : "";
+			const duration = msToSec(new Date().getTime() - start.getTime());
+			logInfo(
+				`${method} (cache) ${siteIdMsg} ${endpoint} ${duration}s ${appendToLog}`
+			);
 			return cacheData;
 		}
 	}
 
 	// Network
 	try {
+		const start = new Date();
 		const { data }: { data: T } = await axios({
 			url: endpoint,
 			method,
@@ -59,6 +68,13 @@ async function requestAPI<T extends APIResponses>(
 			data: body,
 		});
 
+		const siteId = getSafeSiteId(data);
+		const siteIdMsg = siteId ? `site: ${siteId}` : "";
+		const duration = msToSec(new Date().getTime() - start.getTime());
+		logInfo(
+			`${method} (fetch) ${siteIdMsg} ${endpoint} ${duration}s ${appendToLog}`
+		);
+
 		saveCache(cacheOptions, data);
 
 		return data;
@@ -80,13 +96,16 @@ async function requestAPI<T extends APIResponses>(
 
 		await delay(parseInt(RETRY_WAIT_SECONDS) * 1000);
 
-		return requestAPI({
-			endpoint,
-			body,
-			cached,
-			method,
-			attempt: attempt + 1,
-		});
+		return requestAPI<T>(
+			{
+				endpoint,
+				body,
+				cacheKey,
+				method,
+				attempt: attempt + 1,
+			},
+			appendToLog
+		);
 	}
 }
 
@@ -97,22 +116,7 @@ async function requestAPI<T extends APIResponses>(
  * @returns A promise that is resolved with the data from the API response.
  */
 async function getApi<T extends APIResponses>(props: GetAPI) {
-	// Starts
-	const start = new Date();
-	const { endpoint } = props;
-
-	// Fetching...
-	const response = await requestAPI<T>({ ...props, method: "get" });
-
-	// Ends
-	const cacheMsg = props.cached ? "(cached)" : "(fetch)";
-	const siteId = getSafeSiteId(response);
-	const siteIdMsg = siteId ? `site: ${siteId} ` : "";
-	const duration = msToSec(new Date().getTime() - start.getTime());
-
-	logInfo(`GET ${cacheMsg} ${siteIdMsg} ${endpoint} - ${duration}s`);
-
-	return response;
+	return await requestAPI<T>({ ...props, method: "get" });
 }
 
 /**
@@ -122,20 +126,7 @@ async function getApi<T extends APIResponses>(props: GetAPI) {
  * @returns A promise that is resolved with the data from the API response.
  */
 async function putApi<T extends APIResponses>(props: PutAPI) {
-	// Starts
-	const start = new Date();
-	const { endpoint } = props;
-
-	// Fetching...
-	const response = await requestAPI<T>({ ...props, method: "put" });
-
-	// Ends
-	const cacheMsg = props.cached ? "(cached)" : "(fetch)";
-	const duration = msToSec(new Date().getTime() - start.getTime());
-
-	logInfo(`PUT ${cacheMsg} ${endpoint} - ${duration}s`);
-
-	return response;
+	return await requestAPI<T>({ ...props, method: "put" });
 }
 
 /**
@@ -145,27 +136,17 @@ async function putApi<T extends APIResponses>(props: PutAPI) {
  * @returns A promise that is resolved with the data from the API response.
  */
 async function postApi<T extends APIResponses>(props: PostAPI) {
-	// Starts
-	const start = new Date();
 	const { endpoint, body, headers } = props;
-	const distributorBodyParams = endpoint.endsWith("/distributor")
-		? `# Distributor body: ${JSON.stringify(body)} - lang: ${JSON.stringify(
-				headers?.lang
-		  )}`
-		: "";
-
-	// Fetching...
-	const response = await requestAPI<T>({ ...props, method: "post" });
-
-	// Ends
-	const cacheMsg = props.cached ? "(cached)" : "(fetch)";
-	const duration = msToSec(new Date().getTime() - start.getTime());
-
-	logInfo(
-		`POST ${cacheMsg} ${endpoint} - ${duration}s ${distributorBodyParams}`
+	const distributorBodyParams =
+		endpoint.endsWith("/distributor") &&
+		`# Distributor body: ${JSON.stringify(body)} lang: ${JSON.stringify(
+			headers?.lang
+		)}`;
+
+	return await requestAPI<T>(
+		{ ...props, method: "post" },
+		distributorBodyParams || ""
 	);
-
-	return response;
 }
 
 /**

package/src/utils/cache.ts

@@ -60,16 +60,17 @@ function saveCache<T>(petition: Petition, content: T) {
 }
 
 /**
- * Read a cache file and return it as an object
+ * Search in the `apiCache` folder for a file using the petition as hash generator.
+ * Return the file content if found or null if not.
  *
  * @param petition An object
  */
-function getCache<T>(petition: Petition) {
+function searchCacheData<T>(petition: Petition) {
 	try {
-		const content = fs.readFileSync(generateFilenameWithHash(petition), {
+		const file = generateFilenameWithHash(petition);
+		const content = fs.readFileSync(file, {
 			encoding: "utf-8",
 		});
-
 		return JSON.parse(content) as T;
 	} catch {
 		return null;
@@ -107,7 +108,7 @@ function updatedSiteHash(siteId: number, siteHash: SiteHash) {
 		});
 	}
 
-	return currentHash;
+	return currentHash.toString();
 }
 
-export { createSha256, updatedSiteHash, getCache, saveCache, initCache };
+export { createSha256, updatedSiteHash, searchCacheData, saveCache, initCache };

package/src/utils/folders.ts

@@ -22,8 +22,8 @@ async function deleteSites(updatedSites: Array<Site>) {
 				`../../assets/page-data${mappedDomain}`
 			);
 
-			logInfo("Site dir", dir);
-			logInfo("Page data dir", pageDataDir);
+			logInfo(`Site dir ${dir}`);
+			logInfo(`Page data dir ${pageDataDir}`);
 
 			// delete directory recursively
 			if (!fs.existsSync(dir)) return;

package/src/utils/shared.ts

@@ -5,6 +5,7 @@ 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();
@@ -49,12 +50,13 @@ function logBox(str: string) {
 
 /**
  * Custom basic logging function controlled by a environment variable.
+ * Strip double spaces.
  *
- * @param str The string or strings separated by commans to be logged.
+ * @param str The string to be logged.
  */
-function logInfo(...str: Array<unknown>) {
+function logInfo(str: string) {
 	if (GRIDDO_BUILD_LOGS) {
-		console.info(...str);
+		console.info(str.replace(/(\s)\s+/g, "$1"));
 	}
 }
 
@@ -187,6 +189,70 @@ function exporterLogo() {
 	console.log(gradient.cristal(logo));
 }
 
+/**
+ * Remove unused files (old) inside the `apiCache` folder
+ *
+ * @param folderPath The path for the `apiCache` folder
+ * @todo remove other file types: sites, socials, etc..
+ */
+function sanitizeApiCache(folderPath: string) {
+	// Read all `apiCache` file paths
+	const allCachedFiles = fs.readdirSync(folderPath);
+
+	// Object to store the the more rencent file names
+	// Record<string, string> = { "234856872634", "3268746238747238.json"};
+	const filesByIdMap: Record<string, string> = {};
+	//                      ^id     ^path
+
+	// Page files.
+	// We only need files that describes a page object.
+	const pageFilePaths = allCachedFiles.filter((fileName) => {
+		const filePath = `${folderPath}/${fileName}`;
+		const fileObject = fs.readJSONSync(filePath, "utf-8") as APIPageObject;
+		const { id, entity, fullUrl } = fileObject;
+
+		// Is a page file if has id, entity and fullUrl
+		return !!(id && entity && fullUrl);
+	});
+
+	// Fill the filesById object
+	for (const fileName of pageFilePaths) {
+		const filePath = `${folderPath}/${fileName}`;
+		const fileObject = fs.readJSONSync(filePath, "utf-8") as APIPageObject;
+		const fileCreationDate = fs.statSync(filePath).mtimeMs;
+
+		const { id } = fileObject;
+
+		// Is a valid page if doesn't exists in the store object or is newer
+		// that the stored one.
+		const validPageFile =
+			!filesByIdMap[id] ||
+			fileCreationDate >
+				fs.statSync(`${folderPath}/${filesByIdMap[id]}`).mtimeMs;
+
+		if (validPageFile) filesByIdMap[id] = fileName;
+	}
+
+	// TODO: Remove this counter for production
+	let counter = 0;
+
+	// Delete files using the store object filesById as reference map.
+	for (const fileName of pageFilePaths) {
+		const filePath = `${folderPath}/${fileName}`;
+		const fileObject = fs.readJSONSync(filePath, "utf-8") as APIPageObject;
+
+		const { id } = fileObject;
+
+		// If the filename is not present in the map, remove it!
+		if (fileName !== filesByIdMap[id]) {
+			fs.unlinkSync(filePath);
+			counter++;
+		}
+	}
+
+	console.log(`>>> Sanitize apiCache folder for ${counter} files <<<`);
+}
+
 export {
 	delay,
 	exporterLogo,
@@ -195,6 +261,7 @@ export {
 	logPageSize,
 	measureFunctions,
 	removeProperties,
+	sanitizeApiCache,
 	siteList,
 	splash,
 	walk,

package/src/utils/sites.ts

@@ -109,7 +109,7 @@ async function unpublishSites(sites: Array<Site>) {
 			unpublishHashes: [],
 		};
 
-		logInfo("Unpublish site starts", buildInfo);
+		logInfo(`Unpublish site starts ${buildInfo}`);
 
 		await SitesService.endSiteRender(site.id, body);
 	}
@@ -121,20 +121,20 @@ async function unpublishSites(sites: Array<Site>) {
  * Return a single site generic data.
  *
  * @param siteID The site id.
- * @param cached Boolean that indicates if we want to get cache version.
+ * @param cacheKey Boolean that indicates if we want to get cache version.
  *
  * @see SiteData
  */
-async function getSiteData(siteID: number, cached: boolean) {
+async function getSiteData(siteID: number) {
 	const buildData = await SitesService.startSiteRender(siteID);
-	const siteInfo = await SitesService.getInfo(siteID, cached);
-	const siteLangs = await SitesService.getLanguages(siteID, cached);
-	const socials = await SitesService.getSocials(siteID, cached);
+	const siteInfo = await SitesService.getInfo(siteID);
+	const siteLangs = await SitesService.getLanguages(siteID);
+	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, cached);
+	// const sitePages = await SitesService.getPages(siteID, cacheKey);
 	const sitePages: AllPagesResponse = [];
 
 	const { siteHash, unpublishHashes, publishIds } = buildData;