@griddo/cx 11.7.11 → 11.7.12-rc.1

package/exporter/utils/cache.ts

@@ -2,24 +2,21 @@ import type { Petition } from "../types/global";
 import type { HashSites, SiteHash } from "../types/sites";
 
 import crypto from "node:crypto";
-import fs from "node:fs";
+import fsp from "node:fs/promises";
 import path from "node:path";
 
-import fsx from "fs-extra";
-
-import { getConfig } from "./core-utils";
-
-const config = getConfig();
+import { pathExists } from "../utils/folders";
+import { getRenderPathsFromDB } from "./render";
 
 /**
  * Creates an `apiCache` dir to store pages fetched from them API.
  */
-function createAPICacheDir() {
-	const { __cx } = config.paths();
-	const apiCacheDir = path.join(__cx, "apiCache");
+async function createAPICacheDir(options: { basePath: string }) {
+	const { basePath } = options;
+	const apiCacheDir = path.join(basePath, "apiCache");
 
-	if (!fs.existsSync(apiCacheDir)) {
-		fs.mkdirSync(apiCacheDir);
+	if (!(await pathExists(apiCacheDir))) {
+		await fsp.mkdir(apiCacheDir);
 	}
 
 	console.info("Cache initialized");
@@ -27,13 +24,11 @@ function createAPICacheDir() {
 
 /**
  * Generate a filename with a hash using a Petition object
- *
- * @todo Merge with createSha256
  * @param petition An object
  */
-function generateFilenameWithHash(petition: Petition) {
-	const { __cx } = config.paths();
-	const apiCacheDir = path.join(__cx, "apiCache");
+async function generateFilenameWithHash(petition: Petition) {
+	const { __root } = await getRenderPathsFromDB();
+	const apiCacheDir = path.join(__root, "apiCache");
 
 	const hashSum = crypto.createHash("sha256");
 	hashSum.update(JSON.stringify(petition));
@@ -41,35 +36,22 @@ function generateFilenameWithHash(petition: Petition) {
 	return `${apiCacheDir}/${hashSum.digest("hex")}`;
 }
 
-/**
- * Generate a filename with a hash using a string.
- *
- * @todo Merge with generateFilenameWithHash
- * @param data A string to create a sha256 based on.
- */
-function createSha256(data: string) {
-	const uniqueString = crypto.randomBytes(16).toString("hex");
-	const hash = crypto.createHash("sha256");
-	hash.update(`${data}${uniqueString}`);
-
-	return hash.digest("hex");
-}
-
 /**
  * Save a file using a hash name.
  *
  * @param petition An object.
  * @param content Content to be saved.
  */
-function saveCache<T>(petition: Petition, content: T) {
-	const stringContent =
-		typeof content === "string" ? content : JSON.stringify(content);
-	const filename = generateFilenameWithHash(petition);
+async function saveCache<T>(petition: Petition, content: T) {
+	const stringContent = typeof content === "string" ? content : JSON.stringify(content);
+	const filename = await generateFilenameWithHash(petition);
 	const filepath = path.dirname(filename);
-	if (!fs.existsSync(filepath)) {
-		fs.mkdirSync(filepath, { recursive: true });
+
+	if (!(await pathExists(filepath))) {
+		await fsp.mkdir(filepath, { recursive: true });
 	}
-	fs.writeFileSync(filename, stringContent, "utf8");
+
+	await fsp.writeFile(filename, stringContent, "utf8");
 }
 
 /**
@@ -78,13 +60,13 @@ function saveCache<T>(petition: Petition, content: T) {
  *
  * @param petition An object
  */
-function searchCacheData<T>(petition: Petition) {
+async function searchCacheData<T>(petition: Petition) {
 	try {
-		const file = generateFilenameWithHash(petition);
-		const jsonData = fsx.readJSONSync(file, {
-			encoding: "utf-8",
-		});
-		return jsonData as T;
+		const file = await generateFilenameWithHash(petition);
+		const fileContent = await fsp.readFile(file, "utf8");
+		const jsonData = JSON.parse(fileContent) as T;
+
+		return jsonData;
 	} catch {
 		return null;
 	}
@@ -93,15 +75,14 @@ function searchCacheData<T>(petition: Petition) {
 /**
  * Get site hashes from the file as an object
  */
-function getHashSites(): HashSites {
-	const { __cx } = config.paths();
-	const apiCacheDir = path.join(__cx, "apiCache");
+async function getHashSites(): Promise<HashSites> {
+	const { __root } = await getRenderPathsFromDB();
+	const apiCacheDir = path.join(__root, "apiCache");
 	const siteHasFilename = `${apiCacheDir}/siteHash.json`;
 
 	try {
-		const jsonData = fsx.readJSONSync(siteHasFilename, {
-			encoding: "utf-8",
-		});
+		const fileContent = await fsp.readFile(siteHasFilename, "utf8");
+		const jsonData = JSON.parse(fileContent);
 		return jsonData || {};
 	} catch {
 		return {};
@@ -114,18 +95,18 @@ function getHashSites(): HashSites {
  * @param siteId The id of the site.
  * @param siteHash The has of the site.
  */
-function updatedSiteHash(siteId: number, siteHash: SiteHash) {
-	const allHash = getHashSites();
+async function updatedSiteHash(siteId: number, siteHash: SiteHash) {
+	const allHash = await getHashSites();
 	const lastHash = allHash[siteId];
-	const currentHash = siteHash || lastHash || new Date().valueOf();
+	const currentHash = siteHash || lastHash || Date.now();
 
-	const { __cx } = config.paths();
-	const apiCacheDir = path.join(__cx, "apiCache");
+	const { __root } = await getRenderPathsFromDB();
+	const apiCacheDir = path.join(__root, "apiCache");
 	const siteHasFilename = `${apiCacheDir}/siteHash.json`;
 
 	if (currentHash !== lastHash) {
 		allHash[siteId] = currentHash;
-		fs.writeFileSync(siteHasFilename, JSON.stringify(allHash), {
+		await fsp.writeFile(siteHasFilename, JSON.stringify(allHash), {
 			encoding: "utf-8",
 		});
 	}
@@ -133,10 +114,4 @@ function updatedSiteHash(siteId: number, siteHash: SiteHash) {
 	return currentHash.toString();
 }
 
-export {
-	createAPICacheDir,
-	createSha256,
-	saveCache,
-	searchCacheData,
-	updatedSiteHash,
-};
+export { createAPICacheDir, saveCache, searchCacheData, updatedSiteHash };

package/exporter/utils/check-environment-health.ts

@@ -0,0 +1,80 @@
+#!/usr/bin/env node
+
+import { CheckHealthError } from "../constants/errors";
+import { isTruthy } from "./core-utils";
+import { throwError } from "./errors";
+import { infoLog } from "./loggin";
+
+const GRIDDO_ENVS_VARS: ReadonlyArray<string> = [];
+const GRIDDO_SKIP_BUILD_CHECKS = isTruthy(process.env.GRIDDO_SKIP_BUILD_CHECKS);
+
+/**
+ * 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.error(`Env check failed. These envs vars are missing: \n\n${missingEnvsMsg}`);
+
+		return false;
+	}
+
+	return true;
+}
+
+function checkEnvsVarsAndValues(envs: Array<Record<string, string>>): boolean {
+	for (const env of envs) {
+		const [key, expected] = Object.entries(env)[0];
+		const actual = process.env[key];
+
+		if (actual !== expected) {
+			return false;
+		}
+	}
+	return true;
+}
+
+/**
+ * Check if the environment is secure to launch a render.
+ * If something fails then log an error message and exit from the process.
+ * Otherwise just return true.
+ */
+export function checkEnvironmentHealth() {
+	// Bypass the check using this env var, handy for local renders.
+	if (GRIDDO_SKIP_BUILD_CHECKS) {
+		infoLog("Build health check skipped");
+
+		return true;
+	}
+
+	// Checklist
+	// check if it's setted
+	const areRequiredEnvsSet = checkEnvsVars(GRIDDO_ENVS_VARS);
+	// check if it's setted and the value
+	const areEnvsMatchingExpected = checkEnvsVarsAndValues([
+		{
+			GRIDDO_RENDER_BY_DOMAINS: "true",
+		},
+	]);
+
+	// Render is safe if...
+	const isSafeToRender = areRequiredEnvsSet && areEnvsMatchingExpected;
+
+	// The environment is suitable for a build-render
+	if (isSafeToRender) {
+		console.info("\nBuild health check passed\n");
+
+		return true;
+	}
+
+	// Error
+	throwError(CheckHealthError);
+}