@griddo/cx 10.3.13 → 10.3.15

package/src/services/store.ts

@@ -1,423 +0,0 @@
-import type { BuildProcessData } from "../types/global";
-import type {
-	GatsbyPageObject,
-	GriddoListPage,
-	GriddoMultiPage,
-	GriddoSinglePage,
-	PageAdditionalInfo,
-} from "../types/pages";
-import type { Site } from "../types/sites";
-
-import fs from "fs";
-import fsp from "fs/promises";
-import path from "path";
-
-import dotenv from "dotenv";
-import fsx from "fs-extra";
-import pLimit from "p-limit";
-
-import { DistributorService } from "./distributors";
-import { NavigationService } from "./navigation";
-import { RobotsService } from "./robots";
-import { SettingsService } from "./settings";
-import { SitesService } from "./sites";
-import { version as griddoVersion } from "../../package.json";
-import { createSha256, updatedSiteHash } from "../utils/cache";
-import { deleteSites } from "../utils/folders";
-import {
-	createGriddoListPagesForGatsby,
-	createGriddoMultiPagesForGatsby,
-	createGriddoSinglePageForGatsby,
-	getMultiPageElements,
-	getPaginatedPages,
-} from "../utils/pages";
-import { logInfo, removeProperties, siteList, walk } from "../utils/shared";
-import { checkSites, getSiteData, unpublishSites } from "../utils/sites";
-
-dotenv.config();
-
-// Envs
-const API_URL = process.env.API_URL as string;
-const CXBRANCH = process.env.CXBRANCH;
-const REACT_APP_INSTANCE =
-	process.env.GRIDDO_REACT_APP_INSTANCE || process.env.REACT_APP_INSTANCE;
-const API_CONCURRENCY_COUNT =
-	parseInt(process.env.GRIDDO_API_CONCURRENCY_COUNT || "") || 10;
-const PUBLIC_API_URL = process.env.PUBLIC_API_URL as string;
-const RENDER_ID =
-	process.env.GRIDDO_RENDERID || new Date().valueOf().toString();
-
-// Consts
-const CREATED_PAGES: Array<number> = [];
-const BUILD_PROCESS_DATA: BuildProcessData = {};
-
-/**
- * Store service to fetch, process and save object pages and sites data to be
- * consumed by other services (Griddo itself, Gatsby, etc.)
- *
- * @example
- * import { StoreService } from "./store"
- *
- * // Init the store service.
- * StoreService.init("foo/pages")
- * // Save the data into files.
- * await StoreService.createBuildSource()
- * // Consume the pages as an interator.
- * const pages = StoreService.getPages()
- */
-class StoreService {
-	static basePath: string;
-	static pages: Array<GatsbyPageObject> = [];
-	static sitesToPublish: Array<Site>;
-	static buildProcessData: BuildProcessData;
-	static createdPages: Array<number>;
-
-	/**
-	 * Initialize the Store with a path to save files (file mode) and an option object to configure the Store.
-	 *
-	 * @param basePath The path to store the page files.
-	 * @param options An object configuration
-	 * @param options.mode Store mode
-	 */
-	public static init(basePath: string) {
-		console.log(
-			`🧶 Processing API page calls with ${API_CONCURRENCY_COUNT} threads`
-		);
-		console.log(`📦 Griddo Store initialized`);
-
-		this.basePath = basePath;
-
-		// Remove old store
-		if (fs.existsSync(basePath)) {
-			fs.rmSync(basePath, { recursive: true });
-		}
-
-		// Create new store
-		if (!fs.existsSync(basePath)) {
-			fs.mkdirSync(basePath);
-		}
-	}
-
-	/**
-	 * Create a complete build fetching the necessary data from API.
-	 */
-	public static async createBuildSource() {
-		try {
-			// Get sites objects to publish and unpublish.
-			const { sitesToPublish, sitesToUnpublish } = await checkSites();
-
-			// The settings will be extracted below in this process.
-			await SettingsService.getAll();
-
-			// If no activity in sites, exit
-			if (!(sitesToPublish.length || sitesToUnpublish.length)) {
-				console.warn("There are no sites to update");
-				process.exit(0);
-			}
-
-			console.log(`\n⬆ Sites to publish: ${siteList(sitesToPublish)}`);
-			console.log(`\n⬇ Sites to unpublish: ${siteList(sitesToUnpublish)}\n`);
-
-			// Unpublish (API) and delete sites
-			// TODO: Manage this to save end data to the __report-build__ file ???
-			await unpublishSites(sitesToUnpublish);
-
-			// Delete (clean) sites to publish
-			// SPREAD: await deleteSites(sitesToPublish);
-			await deleteSites([...sitesToPublish]);
-
-			// Set robots information to use later in the `onPostBuild` phase.
-			await RobotsService.loadRobots();
-
-			for (const site of sitesToPublish) {
-				const { id: siteId, slug: siteSlug, theme, favicon } = site;
-
-				const {
-					siteInfo,
-					validPagesIds,
-					siteHash,
-					unpublishHashes,
-					siteLangs,
-					defaultLang,
-					headers,
-					footers,
-					socials,
-				} = await getSiteData(siteId);
-
-				const {
-					cloudinaryName,
-					useMetaTitle,
-					useMetaKeywords,
-					showBasicMetaRobots,
-					avoidHrefLangsOnCanonicals,
-					avoidSelfReferenceCanonicals,
-					avoidHrefLangXDefault,
-					avoidDebugMetas,
-				} = SettingsService.settings;
-
-				BUILD_PROCESS_DATA[siteId] = {
-					siteHash,
-					unpublishHashes,
-					publishHashes: [],
-				};
-
-				const NavService = new NavigationService();
-
-				// Set `headers` and `footers` to the NavService to use later in this process.
-				NavService.navigations = { headers, footers };
-
-				site.languages = siteLangs;
-
-				const shouldUpdateSite = updatedSiteHash(siteId, siteHash);
-
-				const siteScript = siteInfo.siteScript;
-
-				const siteMetadata = {
-					siteUrl: siteInfo.slug,
-					title: siteInfo.name,
-					favicon,
-				};
-
-				const additionalInfo = {
-					baseUrl: API_URL,
-					publicBaseUrl: PUBLIC_API_URL,
-					instance: REACT_APP_INSTANCE,
-					siteSlug,
-					theme,
-					siteMetadata,
-					socials,
-					siteLangs,
-					cloudinaryName,
-					griddoVersion,
-					siteOptions: {
-						useMetaTitle,
-						useMetaKeywords,
-						showBasicMetaRobots,
-						avoidHrefLangsOnCanonicals,
-						avoidSelfReferenceCanonicals,
-						avoidHrefLangXDefault,
-						avoidDebugMetas,
-					},
-					BUILD_MODE: CXBRANCH,
-					siteScript,
-				};
-
-				logInfo(`𝍌 ${site.name} site`);
-
-				// -------------------------------------------------------------------------
-				// Pages loop promise creation
-				// -------------------------------------------------------------------------
-				// Async function that process every page for one site to use later in the
-				// `Promise.all` with pLimit.
-				const fetchPageAndSaveToStore = async (pageId: number) => {
-					// Here will be store every page returned by the API and processed by
-					// Griddo CX.
-					let gatsbyPageObjects: Array<GatsbyPageObject> = [];
-
-					// Get page data
-					const page = await SitesService.getPage(pageId, shouldUpdateSite);
-
-					// Probably a 404
-					if (!page) return;
-
-					// Update Array of page ids
-					CREATED_PAGES.push(pageId);
-
-					// TODO: Use structuredClone() when node 18 is available.
-					// SHAME: This new pageAdditionalInfo needs to be a copy because
-					// additionalInfo referenced from outside this function and
-					// its used by other pages.
-					const pageAdditionalInfo = JSON.parse(
-						JSON.stringify(additionalInfo)
-					) as PageAdditionalInfo;
-
-					// Updated with navigations (header & footer)
-					pageAdditionalInfo.navigations = NavService.getPageNavigations(page);
-
-					// Content Type Data Query
-					// Where the pair `hasDistributorData:true` and `data` prop exists, this
-					// function will attach a `queriedItems` prop with the result of the fetch
-					// for the data.
-					const template = await DistributorService.getDistributorData({
-						page,
-						cacheKey: RENDER_ID,
-					});
-
-					// MultiPage Query
-					// Where the pair `hasGriddoMultiPage:true` prop exists, this function
-					// will process the schema and return a multiPageElemtens array to use
-					// in `createGriddoMultiPagesForGatsby()`
-					const multiPageElements = await getMultiPageElements(template);
-
-					// -----------------------------------------------------------------------
-					// Build Griddo page objects.
-					// -----------------------------------------------------------------------
-					// A page from the API could be one of those:
-					// - List with pagination (static list template): needs to be splitted in n pages
-					// - Multi-page module: needs to be splitted in n pages
-					// - Single: just one page
-
-					// Griddo page types
-					const isStaticListPage = page?.mode === "list";
-					const isMultiPage = !isStaticListPage && multiPageElements;
-					const isSinglePage = !isMultiPage && !isStaticListPage;
-
-					// >> List (static list template) <<
-					if (isStaticListPage) {
-						const griddoListPage = {
-							page: page,
-							pages: getPaginatedPages(template),
-							isRoot: false,
-							defaultLang: defaultLang,
-							template: template,
-							totalQueriedItems: template.queriedItems,
-						} as GriddoListPage;
-
-						// pageObjects = await createGriddoListPages({ adapter: "Gatsby" })
-						gatsbyPageObjects = await createGriddoListPagesForGatsby(
-							griddoListPage,
-							pageAdditionalInfo
-						);
-					}
-
-					// >> Multi-page <<
-					if (isMultiPage) {
-						const griddoMultipage = page as GriddoMultiPage;
-
-						// The `template` key with the (maybe) distributor data items queried
-						griddoMultipage.template = template;
-						griddoMultipage.multiPageElements = multiPageElements;
-						griddoMultipage.defaultLang = defaultLang;
-
-						gatsbyPageObjects = await createGriddoMultiPagesForGatsby(
-							griddoMultipage,
-							pageAdditionalInfo
-						);
-					}
-
-					// >> Single template <<
-					if (isSinglePage) {
-						const griddoSinglePage = page as GriddoSinglePage;
-
-						// The `template` key with the (maybe) distributor data items queried
-						griddoSinglePage.template = template;
-						griddoSinglePage.defaultLang = defaultLang;
-
-						gatsbyPageObjects = [
-							await createGriddoSinglePageForGatsby(
-								griddoSinglePage,
-								pageAdditionalInfo
-							),
-						];
-					}
-
-					// Update hashes
-					BUILD_PROCESS_DATA[siteId].publishHashes.push(page.hash);
-
-					// Save build data to store
-					await this.savePages(gatsbyPageObjects); // gatsbyPageObjects is always an array regardless of whether it's just one page
-					this.setSitesToPublish(sitesToPublish);
-					this.setBuildProcessData(BUILD_PROCESS_DATA);
-					this.setCreatedPages(CREATED_PAGES);
-				};
-
-				// Create the pLimit array of promises
-				const limit = pLimit(API_CONCURRENCY_COUNT);
-				const pagesToRender = validPagesIds.map((id: number) =>
-					limit(() => fetchPageAndSaveToStore(id))
-				);
-
-				await Promise.all(pagesToRender);
-			}
-		} catch (e) {
-			const error = e as { message: string };
-
-			console.error(error.message);
-
-			process.exit(1);
-		}
-	}
-
-	/**
-	 * Save the pages into the file system.
-	 *
-	 * @param pages An array of pages to save in the store.
-	 */
-	public static async savePages(pages: Array<GatsbyPageObject>) {
-		pages.forEach((page) =>
-			removeProperties(page, ["editorID", "parentEditorID"])
-		);
-
-		const promises = pages.map(async (pageObject) => {
-			const filename = `${createSha256(pageObject.path)}.json`;
-			const fileContent = JSON.stringify(pageObject);
-			const filePath = path.resolve(this.basePath, filename);
-			await fsp.writeFile(filePath, fileContent);
-		});
-
-		await Promise.all(promises);
-	}
-
-	/**
-	 * Set site to publish data in the Store.
-	 *
-	 * @param sites An array of sites to be published.
-	 */
-	public static setSitesToPublish(sites: Array<Site>) {
-		this.sitesToPublish = sites;
-	}
-
-	/**
-	 * Set the build process data in the Store.
-	 *
-	 * @param buildProcessData An object that represents a build process data.
-	 */
-	public static setBuildProcessData(buildProcessData: BuildProcessData) {
-		this.buildProcessData = buildProcessData;
-	}
-
-	/**
-	 * Set the created pages in the Store.
-	 *
-	 * @param pages An array of pages ids.
-	 */
-	public static setCreatedPages(pages: Array<number>) {
-		this.createdPages = pages;
-	}
-
-	/**
-	 * Get the build metadata from the Store.
-	 */
-	public static getMetadata() {
-		return {
-			buildProcessData: this.buildProcessData,
-			createdPages: this.createdPages,
-			sitesToPublish: this.sitesToPublish,
-		};
-	}
-
-	/**
-	 * Return an iterator with pages read from the file system.
-	 */
-	public static async *getPages() {
-		const pagesDirPath = path.resolve(this.basePath);
-		const jsonFilePaths = walk(pagesDirPath).filter(
-			(file) => path.extname(file) === ".json"
-		);
-
-		for (const filePath of jsonFilePaths) {
-			try {
-				const fileStats = await fsp.stat(filePath);
-				const page = (await fsx.readJSON(filePath, {
-					encoding: "utf-8",
-				})) as GatsbyPageObject;
-				page.size = fileStats.size / 1024;
-				yield page;
-			} catch (error) {
-				console.error(`Error: The file ${filePath} doesn't exist`, error);
-			}
-		}
-	}
-}
-
-export { StoreService };

package/src/utils/folders.ts

@@ -1,125 +0,0 @@
-import type { Site } from "../types/sites";
-
-import path from "path";
-
-import fs from "fs-extra";
-
-import { resolveComponentsPath } from "./instance";
-import { logInfo } from "./shared";
-
-/**
- * Delete sites folders that will be updated from de file system.
- *
- * @param updateSites An array of sites to be updated.
- */
-async function deleteSites(updatedSites: Array<Site>) {
-	for await (const site of updatedSites) {
-		for (const domain of site.domains) {
-			const mappedDomain = Object.values(domain)[0];
-			const dir = path.resolve(__dirname, `../../dist${mappedDomain}`);
-			const pageDataDir = path.resolve(
-				__dirname,
-				`../../assets/page-data${mappedDomain}`
-			);
-
-			logInfo(`Site dir ${dir}`);
-			logInfo(`Page data dir ${pageDataDir}`);
-
-			// delete directory recursively
-			if (!fs.existsSync(dir)) return;
-
-			try {
-				await fs.rm(dir, { recursive: true });
-				logInfo(`${dir} is deleted!`);
-			} catch (err) {
-				console.log(err);
-			}
-
-			if (!fs.existsSync(pageDataDir)) return;
-
-			try {
-				await fs.rm(pageDataDir, { recursive: true });
-				console.log(`${pageDataDir} is deleted!`);
-			} catch (err) {
-				console.log(err);
-			}
-		}
-	}
-}
-
-/**
- * Update the Griddo's `/dist` folder with the contents from `/public` only with files of type:
- * - js
- * - json
- * - css
- */
-async function updateDist() {
-	const src = "./public";
-	const dest = "./dist";
-
-	const domainDestPath = `${dest}/${process.env.DOMAIN}`;
-
-	const files = fs
-		.readdirSync(src)
-		.filter(
-			(file) =>
-				path.extname(file) === ".js" ||
-				path.extname(file) === ".json" ||
-				path.extname(file) === ".css"
-		);
-
-	const assetsDest = "./assets";
-
-	const pageDataSrc = `${src}/page-data`;
-	const pageDataDest = `${assetsDest}/page-data`;
-
-	const projectStaticSrc = "./static";
-	const projectStaticDest = assetsDest;
-
-	const gatsbyStaticSrc = `${dest}/static`;
-	const gatsbyStaticDest = `${assetsDest}/static`;
-
-	try {
-		fs.mkdirSync(assetsDest, { recursive: true });
-		fs.copySync(src, dest);
-
-		if (process.env.NEEDS_ASSET_DOMAIN_PREFIX) {
-			fs.copySync(pageDataSrc, pageDataDest);
-			fs.copySync(projectStaticSrc, projectStaticDest, { overwrite: false });
-			fs.copySync(gatsbyStaticSrc, gatsbyStaticDest, { overwrite: false });
-			fs.copySync(projectStaticSrc, domainDestPath, { overwrite: false });
-
-			files.map(async (file) => {
-				const fileSrc = `${src}/${file}`;
-				const fileDest = `${assetsDest}/${file}`;
-				fs.copySync(fileSrc, fileDest);
-			});
-		}
-	} catch (err) {
-		console.error(err);
-	}
-}
-
-/**
- * Copy the instance's `/static` folder into the Gatsby's to take it into account for bundle.
- */
-function prepareStaticFolder() {
-	const src = resolveComponentsPath("static");
-	const dest = "./static";
-
-	const files = fs.readdirSync(src);
-
-	try {
-		files.map(async (file) => {
-			const fileSrc = `${src}/${file}`;
-			const fileDest = `${dest}/${file}`;
-			fs.copySync(fileSrc, fileDest);
-		});
-
-		console.log("📁 Components static folder copied");
-	} catch (err) {
-		console.error(err);
-	}
-}
-
-export { deleteSites, updateDist, prepareStaticFolder };

package/src/utils/gatsby.ts

@@ -1,47 +0,0 @@
-import type { GatsbyNode } from "gatsby";
-
-import { IS_COMPONENT_LIBRARY, PROJECT_ALIASES } from "./instance";
-
-// TODO: Use webpack types
-const onCreateWebpackConfig: GatsbyNode["onCreateWebpackConfig"] = ({
-	actions,
-	plugins,
-	loaders,
-	getConfig,
-	stage,
-}) => {
-	if (IS_COMPONENT_LIBRARY) {
-		const config = getConfig();
-		config.module.rules = [
-			// Omit the default rule where test === '\.jsx?$'
-			...config.module.rules.filter(
-				(rule: { test: string }) => String(rule.test) !== String(/\.jsx?$/)
-			),
-			// Recreate it with custom exclude filter
-			{
-				...loaders.js(),
-				test: /\.jsx?$/,
-				// Exclude all node_modules from transpilation, except for '@griddo/cx'
-				exclude: (modulePath: string) =>
-					/node_modules/.test(modulePath) && !/@griddo\/cx/.test(modulePath),
-			},
-		];
-		actions.replaceWebpackConfig(config);
-	}
-
-	// Add component-system aliases to Webpack's Resolve:
-	actions.setWebpackConfig({
-		resolve: {
-			fallback: { path: false },
-			alias: PROJECT_ALIASES,
-		},
-		plugins: [plugins.provide({ process: "process/browser", React: "react" })],
-	});
-
-	// No sourcemaps on builds
-	if (stage === "build-javascript") {
-		actions.setWebpackConfig({ devtool: false });
-	}
-};
-
-export { onCreateWebpackConfig };