@griddo/cx 11.9.17-rc.1 → 11.10.0

package/exporter/utils/store.ts

@@ -1,314 +0,0 @@
-import type { BuildMetaData } from "../types/api";
-import type { RenderInfo } from "../types/global";
-import type { GriddoPageObject } from "../types/pages";
-import type { Site } from "../types/sites";
-
-import fs from "node:fs";
-import path from "node:path";
-
-import fsx from "fs-extra";
-
-import { throwError } from "../errors";
-import { getConfig, removeProperties, walk, walkStore } from "./core-utils";
-import { verboseLog } from "./loggin";
-import { ReadFromStoreError, WriteToStoreError } from "../errors/errors-data";
-
-const config = getConfig();
-
-/**
- * Read all path pages stored in the `store` Griddo directory and returns the
- * absolute file path.
- *
- * @param domain - The domain to get the pages from.
- */
-function getBuildPagesFromCachedStore<PageType extends GriddoPageObject>(
-	domain: string,
-) {
-	const { __cache } = config.paths(domain);
-	return getBuildPagesFromStore<PageType>({
-		basePath: path.join(__cache, "store"),
-		withSizeProp: false,
-	});
-}
-
-/**
- * Read all pages stored in the `store` Griddo directory and returns one by one
- * with a generator.
- *
- * @param basePath - Base directory to get pages from.
- * @param options.withSizeProp - Add size prop to the page object.
- * @todo throw error if the basePath is not an store folder
- */
-function* getBuildPagesFromStore<PageType extends GriddoPageObject>(args?: {
-	basePath?: string;
-	withSizeProp?: boolean;
-}) {
-	const { basePath, withSizeProp } = args || {};
-	const { __cx } = config.paths();
-	const pagesDirPath = basePath || path.join(__cx, "store");
-
-	const jsonFilePaths = walkStore(pagesDirPath).filter(
-		(file) => path.extname(file) === ".json",
-	);
-
-	for (const filePath of jsonFilePaths) {
-		try {
-			const page = fsx.readJsonSync(filePath, {
-				encoding: "utf-8",
-			}) as PageType;
-
-			if (withSizeProp) {
-				const fileStats = fs.statSync(filePath);
-				page.size = fileStats.size / 1024;
-			}
-
-			// SECURITY: Only returns valid page objects
-			if (page.path) {
-				yield page;
-			}
-		} catch (error) {
-			throwError(ReadFromStoreError, error);
-		}
-	}
-}
-
-/**
- * Read all pages stored in `store` Griddo directory and return the absolute
- * path.
- */
-function getBuildPagesPath() {
-	const config = getConfig();
-	const { __cx } = config.paths();
-
-	const PAGES_DIR = path.join(__cx, "store");
-	const PAGE_FILES = walk(PAGES_DIR).filter(
-		(file) => path.extname(file) === ".json",
-	);
-
-	return PAGE_FILES;
-}
-
-/**
- * Get the build metadata from the Store.
- */
-async function getBuildMetadata(): Promise<BuildMetaData> {
-	const { __cx } = config.paths();
-	const { sitesToPublish, createdPages, buildProcessData } = fsx.readJSONSync(
-		path.join(__cx, "render-metadata.json"),
-	);
-
-	return {
-		buildProcessData,
-		createdPages,
-		sitesToPublish,
-	};
-}
-
-/**
- * Write render info into a file.
- * @param renderInfo - Data that will be saved related to the render process.
- */
-function saveRenderInfoInStore(renderInfo: RenderInfo) {
-	const { __cx } = config.paths();
-
-	fs.writeFileSync(
-		path.join(__cx, "render-metadata.json"),
-		JSON.stringify(renderInfo),
-	);
-}
-
-/**
- * Return an array of ids only from `.json` files (no dirs) in the `basePath` dir based in the file name and filtered by the pages ids in a concrete site.
- * @param basePath - Absolute path of the dir from which files will be read.
- * @returns A Array<number> of pages ids in `basePath` dir filtered by pages ids in a concrete site.
- */
-// function getPagesInStoreDirBySitePages(
-// 	basePath: string,
-// 	pages: Array<number>,
-// ): Array<number> {
-// 	const allPagesInStore = getPageInStoreDir(basePath);
-// 	const pagesBySite = allPagesInStore.filter((page) => pages.includes(page));
-
-// 	return pagesBySite;
-// }
-
-/**
- * Return an array of ids only from `.json` files (no dirs) in the `basePath` dir based in the file name.
- * @param basePath - Absolute path of the dir from which files will be read.
- * @returns A Array<number> of pages ids in `basePath` dir.
- */
-function getPageInStoreDir(basePath: string): Array<number> {
-	const filesInStore = fs.readdirSync(basePath);
-
-	return (
-		filesInStore
-			.filter((file) => {
-				const fullPathFile = `${basePath}/${file}`;
-				const stat = fs.statSync(fullPathFile);
-				// Si es un directorio, no lo incluimos.
-				if (stat?.isDirectory()) {
-					return false;
-				}
-				// Si es un archivo pero no tiene la extensión `.json`, no lo incluimos
-				if (path.extname(file) !== ".json") {
-					return false;
-				}
-				// Si es un archivo con el nombre NO pasable a número (NaN), no lo incluimos.
-				const baseFilename = path.basename(file, path.extname(file));
-				if (Number.isNaN(Number.parseInt(baseFilename))) {
-					return false;
-				}
-
-				// no es dir, es json y con nombre pasable a número, ok :)
-				return true;
-			})
-			// Tenemos solo jsons donde el nombre es un "número": "21345.json"
-			.map((page) => {
-				const filename = path.basename(page, path.extname(page));
-				return Number.parseInt(filename);
-			})
-	);
-}
-
-/**
- * Save the pages into the file system.
- * @param pages - An array of Griddo page objects to be saved.
- */
-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", siteDirName, filename);
-			fsx.writeJSONSync(filePath, page);
-		}
-	} catch (error) {
-		throwError(WriteToStoreError, error);
-	}
-}
-
-/**
- * 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,
-	pageIdsArray: Array<Array<number>>,
-) {
-	const { __cx } = config.paths();
-
-	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}`);
-			}
-		}
-	};
-
-	for (const pageIds of pageIdsArray) {
-		processPageIdsArray(pageIds);
-	}
-}
-
-/**
- * Removes sites that exist in the store that should no longer be there because
- * the domain has been changed. This is necessary because those sites will not
- * be marked as `sitesToUnpublish` so they must be removed manually.
- */
-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),
-	);
-
-	for (const site of sitesToDelete) {
-		fs.rmSync(path.join(__cx, "store", site), { recursive: true, force: true });
-		verboseLog(`Removed orphan site id: ${site}`);
-	}
-}
-
-/**
- * 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, activePages: 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 pageInStore = Number.parseInt(pageFileNameWithoutExtension);
-
-		// What the hell is `pageIdInStore > 0` ??
-		// Las páginas de listados estáticos y multipage tiene ids "basura", que
-		// en este caso son ids negativos y siempre so borran al final del render.
-		// En este caso hay que ignorarlas porque NUNCA van a estar en el
-		// `activePages`, estaríamos borrándolas siempre antes de la fase de
-		// SSG.
-		if (!activePages.includes(pageInStore) && pageInStore > 0) {
-			zombiePages.push(pageInStore);
-		}
-	}
-
-	return zombiePages;
-}
-
-export {
-	getBuildMetadata,
-	getBuildPagesFromCachedStore,
-	getBuildPagesFromStore,
-	getBuildPagesPath,
-	getMissingPublishedPagesInStore,
-	getPageInStoreDir,
-	getZombiePagesInStore,
-	removeOrphanSites,
-	removeSitePagesFromStore,
-	saveSitePagesInStore,
-	saveRenderInfoInStore,
-};

package/src/README.md

@@ -1,7 +0,0 @@
-# Griddo CX + Gatsby
-
-The `/src` dir and almost every file in the root dir is now 100% Gatsby related code along with the historical `/public`, `/dist`, `/apiCache`, `/store`, etc.. render dirs.
-
-Griddo CX code (the business logic) is now in `/exporter` dir.
-
-In the future, Griddo CX and Gatsby will split int their own packages dirs inside the mono-repo.

package/start-render.js

@@ -1,7 +0,0 @@
-#!/usr/bin/env node
-/* eslint-disable node/shebang */
-/* eslint-disable node/no-missing-require */
-
-// This is the "bin" for the griddo-cx package used by "infra" to trigger a
-// render running `npm run griddo-cx`.
-require("./build/start-render.js");