@griddo/cx 11.9.17 → 11.10.0

package/exporter/{types → shared/types}/global.ts

@@ -1,6 +1,6 @@
+import type { Core, Fields } from "@griddo/core";
 import type { EndSiteRenderBody } from "./api";
 import type { Site } from "./sites";
-import type { Core, Fields } from "@griddo/core";
 
 interface Settings {
 	apiVersion?: string;
@@ -55,24 +55,22 @@ type Domain = {
 	url: string;
 };
 
-type Domains = Array<Domain>;
+type Domains = Domain[];
 
 /** Describes the type of build process data object. */
 type BuildProcessData = Record<string, EndSiteRenderBody>;
 
 type Robot = { path: string; content: string };
 
-type Robots = Array<Robot>;
+type Robots = Robot[];
 
 interface RenderInfo {
 	buildProcessData: BuildProcessData;
-	createdPages: Array<number>;
-	sitesToPublish: Array<Site>;
+	createdPages: number[];
+	sitesToPublish: Site[];
 }
 
-type LifeCycleSteps = Array<
-	(...args: Array<unknown>) => unknown | Promise<unknown>
->;
+type LifeCycleAction = (...args: unknown[]) => void | Promise<void>;
 
 type LifeCyclesNames =
 	| "Init"
@@ -82,12 +80,11 @@ type LifeCyclesNames =
 	| "SSG"
 	| "Relocation"
 	| "Meta"
-	| "Archive"
+	| "Sync"
 	| "Clean"
 	| "Close"
 	| "HealthCheck"
-	| "Close"
-	| "__DEBUG__";
+	| "Close";
 
 type PlaceholderPath =
 	| "__exports"
@@ -97,13 +94,11 @@ type PlaceholderPath =
 	| "__components"
 	| "__root"
 	| "__exports_dist"
-	| "__cx_dist";
+	| "__sites";
 
 interface CXConfig {
-	proDomain: string;
 	griddoVersion: string;
 	buildReportFileName: string;
-	paths: (domain?: string) => Record<PlaceholderPath, string>;
 }
 
 interface AIEmbeddingsResponse {
@@ -111,16 +106,17 @@ interface AIEmbeddingsResponse {
 	message: string;
 }
 
-interface Artifacts {
-	disposables: Array<string>;
-	cacheables: Array<string>;
-	initials: Array<string>;
-	archivables: Array<string>;
+interface RenderArtifacts {
+	disposables: string[];
+	cacheables: string[];
+	initials: string[];
+	archivables: string[];
+	restaurable: string[];
 }
 
 export type {
 	AIEmbeddingsResponse,
-	Artifacts,
+	RenderArtifacts,
 	BuildProcessData,
 	CXConfig,
 	Domain,
@@ -134,5 +130,5 @@ export type {
 	Robot,
 	Robots,
 	Settings,
-	LifeCycleSteps,
+	LifeCycleAction,
 };

package/exporter/{types → shared/types}/navigation.ts

@@ -4,7 +4,7 @@ export type Header = {
 	id: number;
 	isDefault: boolean;
 	language: number;
-	navigationLanguages: Array<{ navigationId: number }>;
+	navigationLanguages: { navigationId: number }[];
 	setAsDefault: boolean;
 	theme: null | string;
 	title: string;
@@ -17,9 +17,9 @@ export type Footer = {
 	id: number;
 	isDefault: boolean;
 	language: number;
-	navigationLanguages: Array<{ navigationId: number }>;
+	navigationLanguages: { navigationId: number }[];
 	setAsDefault: boolean;
 	theme: null | string;
 	title: string;
-	type: "header";
+	type: "footer";
 };

package/exporter/{types → shared/types}/pages.ts

@@ -1,7 +1,7 @@
+import type { Core, Fields } from "@griddo/core";
 import type { SocialsResponse } from "./api";
 import type { Settings } from "./global";
 import type { Site } from "./sites";
-import type { Core, Fields } from "@griddo/core";
 
 // TODO: In @griddo/core the type Core.Page has header/footer as React-Types,
 // but API return `number | null`.
@@ -35,7 +35,7 @@ export type GriddoSinglePage = Core.Page & {
 
 export type GriddoListPage = Core.Page & {
 	page: APIPageObject;
-	pages: Array<Array<Fields.QueriedDataItem>>;
+	pages: Fields.QueriedDataItem[][];
 	isRoot?: boolean;
 	defaultLang?: Core.SiteLanguage;
 	template: {
@@ -45,7 +45,7 @@ export type GriddoListPage = Core.Page & {
 		activeSectionSlug: string;
 		activeSectionBase: string;
 	};
-	totalQueriedItems: Array<Fields.QueriedDataItem>;
+	totalQueriedItems: Fields.QueriedDataItem[];
 };
 
 export type GriddoMultiPage = Core.Page & {
@@ -62,7 +62,7 @@ export interface AdditionalInfo {
 	griddoVersion: string;
 	instance?: string;
 	publicBaseUrl: string;
-	siteLangs: Array<Core.SiteLanguage>;
+	siteLangs: Core.SiteLanguage[];
 	siteMetadata: Site["siteMetadata"];
 	siteSlug: string;
 	socials: SocialsResponse;
@@ -90,14 +90,14 @@ export interface PageAdditionalInfo extends AdditionalInfo {
 export type MultiPageElement = {
 	component: string;
 	title: string | Required<Fields.Heading>;
-	elements: Array<Record<string, unknown>>;
-	componentModules: Array<Record<string, unknown>>;
+	elements: Record<string, unknown>[];
+	componentModules: Record<string, unknown>[];
 	sectionSlug: string;
 	metaTitle: string;
 	metaDescription: string;
 };
 
-export type MultiPageElements = Array<MultiPageElement>;
+export type MultiPageElements = MultiPageElement[];
 
 /**
  * Gatsby page object format.
@@ -140,7 +140,7 @@ export type GriddoPageObject = {
 		siteMetadata: Site["siteMetadata"];
 		theme: string;
 		title: string;
-		siteLangs: Array<Core.SiteLanguage>;
+		siteLangs: Core.SiteLanguage[];
 		siteOptions: AdditionalInfo["siteOptions"];
 		siteScript: string;
 		socials: SocialsResponse;
@@ -153,11 +153,10 @@ export interface Dimensions {
 	values: Record<string, string> | null;
 	contentSelect?: "group" | "individual" | null;
 	groupSelect?: string;
-	dimensionsSelect?: Array<string>;
+	dimensionsSelect?: string[];
 }
 
-export interface GatsbyPageTemplateProps
-	extends Omit<GriddoPageObject, "context"> {
+export interface GatsbyPageTemplateProps extends Omit<GriddoPageObject, "context"> {
 	pageContext: GriddoPageObject["context"] & {
 		page: Core.Page;
 	};

package/exporter/shared/types/render.ts

@@ -0,0 +1,65 @@
+import type { RenderInfo } from "./global";
+
+const RENDER_MODE = {
+	FROM_SCRATCH: "FROM_SCRATCH",
+	INCREMENTAL: "INCREMENTAL",
+	IDLE: "IDLE",
+	ERROR: "ERROR",
+	COMPLETED: "COMPLETED",
+} as const;
+
+type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
+
+export interface RenderModeTuple {
+	renderMode: RenderMode;
+	reason?: string;
+}
+
+type DomainLike = string;
+
+type RenderDB = {
+	griddoVersion: string;
+	buildReportFileName: string;
+	sortedDomains: DomainLike[];
+	needsRollbackOnError: boolean;
+	currentRenderingDomain: string | null;
+	commitHash: string;
+	commitMessage: string;
+	paths: {
+		root: string;
+		cx: string;
+		ssg: string;
+		cxCache: string;
+		components: string;
+		exportsDir: string;
+		exportsDirBackup: string;
+	};
+	domains: {
+		[key: DomainLike]: {
+			renderMode?: RenderMode;
+			shouldBeRendered?: boolean;
+			isRendering?: boolean;
+			renderInfo?: RenderInfo;
+			renderModeReason?: string;
+		};
+	};
+};
+
+interface Report {
+	authControl:
+		| {
+				Authorization: string;
+				"Cache-Control": string;
+				lang?: string | undefined;
+		  }
+		| undefined;
+	sites: {
+		siteId: number;
+		publishHashes: string[];
+		siteHash: string | null;
+		unpublishHashes: string[];
+		publishPagesIds: number[];
+	}[];
+}
+
+export { RENDER_MODE, type RenderDB, type RenderMode, type Report };

package/exporter/{types → shared/types}/sites.ts

@@ -1,6 +1,6 @@
+import type { Core } from "@griddo/core";
 import type { SocialsResponse } from "./api";
 import type { Footer, Header } from "./navigation";
-import type { Core } from "@griddo/core";
 
 /**
  * Describes a Griddo site object from API.
@@ -28,12 +28,12 @@ export interface Site
 	> {
 	author: string;
 	deleted: number;
-	domains: Array<Record<string, string>>;
-	footers: Array<Footer>;
+	domains: Record<string, string>[];
+	footers: Footer[];
 	hash: string | null;
-	headers: Array<Header>;
-	languages: Array<Core.SiteLanguage>; // in Core is Array<number>
-	languageSites: Array<number>;
+	headers: Header[];
+	languages: Core.SiteLanguage[]; // in Core is number[]
+	languageSites: number[];
 	navigationModules: { header?: string; footer?: string } | null;
 	/**
 	 * Array of all pages (from day 0): published, unpublished and deleted
@@ -41,9 +41,8 @@ export interface Site
 	 * `select/site/33/pages` -> [{id,label}, {id,label}, {id,label}] // array of published, pending, unpublished... page objects
 	 * `select/site/33/pages?liveStatus=active` -> // array of publishedpage objects
 	 */
-	pages: Array<number>;
-	onlinePages: Array<number>;
-	changedPages: Array<number>;
+	pages: number[];
+	onlinePages: number[];
 	published: string;
 	rendering: boolean;
 	renderingHours: number;
@@ -52,23 +51,23 @@ export interface Site
 	smallAvatar: string;
 	updated: boolean;
 	pagesStatus: {
-		active: Array<number>;
-		uploadPending: Array<number>;
-		offlinePending: Array<number>;
-		offline: Array<number>;
-		deleted: Array<number>;
+		active: number[];
+		uploadPending: number[];
+		offlinePending: number[];
+		offline: number[];
+		deleted: number[];
 	};
 }
 
 export interface SiteData {
 	siteInfo: Site;
-	validPagesIds: Array<number>;
+	validPagesIds: number[];
 	siteHash: string | null;
-	unpublishHashes: Array<string>;
-	siteLangs: Array<Core.SiteLanguage>;
+	unpublishHashes: string[];
+	siteLangs: Core.SiteLanguage[];
 	defaultLang: Core.SiteLanguage | undefined;
-	headers: Array<Header>;
-	footers: Array<Footer>;
+	headers: Header[];
+	footers: Footer[];
 	socials: SocialsResponse;
 }
 

package/exporter/shared/types.ts

@@ -0,0 +1,15 @@
+import type { Core } from "@griddo/core";
+import type { Dimensions, GriddoPageObject } from "@griddo/cx";
+import type { HeadProps } from "gatsby";
+
+interface CustomHeadProps extends HeadProps {
+	pageContext: GriddoPageObject["context"] & {
+		page: Core.Page & {
+			defaultLang: { id: number };
+			dimensions: Dimensions;
+			disableHrefLangs: number[];
+		};
+	};
+}
+
+export type { CustomHeadProps };

package/exporter/ssg-adapters/gatsby/actions/clean.ts

@@ -0,0 +1,26 @@
+import type { RenderContext } from "../../../shared/context";
+import type { SSG } from "../shared/types";
+
+import fsp from "node:fs/promises";
+import path from "node:path";
+
+import { rmDirs } from "../../../core/fs";
+import { RENDER_MODE } from "../../../shared/types/render";
+
+export async function cleanAction(context: RenderContext<SSG>) {
+	const {
+		renderArtifacts,
+		ssg: { ssgArtifacts },
+		pathsHydratedWithDomain: { __cache, __exports },
+		renderMode,
+	} = context;
+
+	if (renderMode === RENDER_MODE.FROM_SCRATCH) {
+		await fsp.rm(path.join(__cache, ".cache"), { recursive: true, force: true });
+		await fsp.rm(path.join(__exports, "dist"), { recursive: true, force: true });
+		await fsp.rm(path.join(__exports, "assets"), { recursive: true, force: true });
+	}
+
+	await rmDirs(renderArtifacts.disposables);
+	await rmDirs(ssgArtifacts.disposables);
+}

package/exporter/ssg-adapters/gatsby/actions/close.ts

@@ -0,0 +1,17 @@
+import type { RenderContext } from "../../../shared/context";
+import type { SSG } from "../shared/types";
+
+import { rmDirs } from "../../../core/fs";
+import { updateCommitFile } from "../../../services/render";
+
+export async function closeAction(context: RenderContext<SSG>) {
+	const {
+		renderArtifacts,
+		ssg: { ssgArtifacts },
+		pathsHydratedWithDomain: { __cache },
+	} = context;
+
+	await rmDirs(renderArtifacts.disposables);
+	await rmDirs(ssgArtifacts.disposables);
+	await updateCommitFile({ basePath: __cache });
+}

package/exporter/ssg-adapters/gatsby/actions/data.ts

@@ -0,0 +1,22 @@
+import type { RenderContext } from "../../../shared/context";
+
+import { createStore } from "../../../services/store";
+
+export async function dataAction(context: RenderContext) {
+	const {
+		domain,
+		renderMode,
+		renderMetadata: { griddoVersion },
+		pathsHydratedWithDomain: { __root },
+	} = context;
+
+	const { pagesToCreate, pagesToDelete } = await createStore({
+		domain,
+		renderMode,
+		griddoVersion,
+		basePath: __root,
+	});
+
+	context.pagesToCreate = pagesToCreate;
+	context.pagesToDelete = pagesToDelete;
+}

package/exporter/ssg-adapters/gatsby/actions/healthCheck.ts

@@ -0,0 +1,10 @@
+import type { RenderContext } from "../../../shared/context";
+
+import { assertRenderIsValid, markRenderAsCompleted } from "../../../services/render";
+
+export async function healthCheckAction(context: RenderContext) {
+	const { domain } = context;
+
+	await assertRenderIsValid(domain);
+	await markRenderAsCompleted(domain);
+}

package/exporter/ssg-adapters/gatsby/actions/init.ts

@@ -0,0 +1,12 @@
+import type { RenderContext } from "../../../shared/context";
+
+import { markRenderAsStarted } from "../../../services/render";
+
+export async function initAction(context: RenderContext) {
+	const {
+		domain,
+		pathsHydratedWithDomain: { __root },
+	} = context;
+
+	await markRenderAsStarted({ basePath: __root, domain });
+}

package/exporter/ssg-adapters/gatsby/actions/logs.ts

@@ -0,0 +1,10 @@
+import type { RenderContext } from "../../../shared/context";
+import type { SSG } from "../shared/types";
+
+import { saveDetailRenderLog } from "../../../core/logger";
+
+export async function logsAction(context: RenderContext<SSG>) {
+	const { domain } = context;
+
+	await saveDetailRenderLog(domain);
+}

package/exporter/ssg-adapters/gatsby/actions/meta.ts

@@ -0,0 +1,13 @@
+import type { RenderContext } from "../../../shared/context";
+
+import { generateBuildReport } from "../../../services/render";
+import { generateRobots } from "../../../services/robots";
+import { generateSitemaps } from "../../../services/sitemaps";
+
+export async function metaAction(context: RenderContext) {
+	const { domain } = context;
+
+	await generateBuildReport(domain);
+	await generateSitemaps(domain);
+	await generateRobots(domain);
+}

package/exporter/ssg-adapters/gatsby/actions/prepare.ts

@@ -0,0 +1,9 @@
+import type { RenderContext } from "../../../shared/context";
+
+import { mkDirs } from "../../../core/fs";
+
+export async function prepareAction(context: RenderContext) {
+	const { renderArtifacts } = context;
+
+	await mkDirs(renderArtifacts.initials);
+}

package/exporter/ssg-adapters/gatsby/actions/relocation.ts

@@ -0,0 +1,15 @@
+import type { RenderContext } from "../../../shared/context";
+
+import fsp from "node:fs/promises";
+import path from "node:path";
+
+export async function relocationAction(context: RenderContext) {
+	const {
+		pathsHydratedWithDomain: { __root, __ssg },
+	} = context;
+
+	const src = path.join(__ssg, "public");
+	const dst = path.join(__root, "current-dist");
+
+	await fsp.rename(src, dst);
+}

package/exporter/ssg-adapters/gatsby/actions/restore.ts

@@ -0,0 +1,21 @@
+import type { RenderContext } from "../../../shared/context";
+import type { SSG } from "../shared/types";
+
+import { cpDirs, mvDirs } from "../../../core/fs";
+import { RENDER_MODE } from "../../../shared/types/render";
+
+export async function restoreAction(context: RenderContext<SSG>) {
+	const {
+		renderMode,
+		ssg: { ssgArtifacts },
+		renderArtifacts,
+		pathsHydratedWithDomain: { __components, __root, __cache, __ssg },
+	} = context;
+
+	await cpDirs(__components, __ssg, ["static"]);
+
+	if (renderMode === RENDER_MODE.INCREMENTAL) {
+		await mvDirs(__cache, __ssg, ssgArtifacts.cacheables);
+		await mvDirs(__cache, __root, renderArtifacts.cacheables);
+	}
+}

package/exporter/ssg-adapters/gatsby/actions/ssg.ts

@@ -0,0 +1,12 @@
+import type { RenderContext } from "../../../shared/context";
+import type { SSG } from "../shared/types";
+
+import { gatsbyBuild } from "../shared/gatsby-build";
+
+export async function ssgAction(context: RenderContext<SSG>) {
+	const {
+		ssg: { assetPrefix },
+	} = context;
+
+	await gatsbyBuild(assetPrefix);
+}

package/exporter/ssg-adapters/gatsby/actions/sync.ts

@@ -0,0 +1,65 @@
+import type { RenderContext } from "../../../shared/context";
+import type { SSG } from "../shared/types";
+
+import fsp from "node:fs/promises";
+import path from "node:path";
+
+import { deleteDisposableSiteDirs, deleteEmptyDirectories, mvDirs } from "../../../core/fs";
+import { RENDER_MODE } from "../../../shared/types/render";
+import { extractAssetsFromDist } from "../shared/extract-assets";
+import { SyncRender } from "../shared/sync-render";
+
+export async function syncAction(context: RenderContext<SSG>) {
+	const {
+		renderMode,
+		renderArtifacts,
+		domain,
+		pagesToCreate,
+		pagesToDelete,
+		pathsHydratedWithDomain: { __root, __ssg, __cache, __exports },
+		ssg: { ssgArtifacts, assetPrefix },
+	} = context;
+
+	const needsAssetPrefix = !!assetPrefix && assetPrefix !== "";
+	const currentDist = path.join(__root, "current-dist");
+	const previousDist = path.join(__exports, "dist");
+
+	// caching...
+	await mvDirs(__root, __cache, renderArtifacts.cacheables, { override: true });
+	await mvDirs(__ssg, __cache, ssgArtifacts.cacheables, { override: true });
+
+	if (renderMode === RENDER_MODE.FROM_SCRATCH) {
+		await deleteDisposableSiteDirs(currentDist);
+		// Es render nuevo, así que el current-dist generado por gatsby hay que renombrarlo a dist
+		// porque muchas de las acciones posteriores asumen ese nombre en ese path...
+		// TODO: Cambiar eso y atomizar más las acciones.
+		await fsp.rm(previousDist, { force: true, recursive: true });
+		await fsp.rename(currentDist, previousDist);
+	}
+
+	if (renderMode === RENDER_MODE.INCREMENTAL) {
+		await deleteDisposableSiteDirs(previousDist);
+
+		const syncRender = new SyncRender({
+			src: currentDist,
+			dst: previousDist,
+			pagesToCreate,
+			pagesToDelete,
+			artifactsToCopyToExports: ["build-report.json"],
+		});
+
+		await syncRender.execute();
+		// después syncRender.execute() currentDist (que lo hizo gatsby) ya no es necesario
+		// esta todo en __exports/dist porque syncRender.execute() ya sincroninizó.
+		await fsp.rm(currentDist, { force: true, recursive: true });
+		await deleteEmptyDirectories(path.join(__exports, "dist"));
+	}
+
+	if (needsAssetPrefix) {
+		// TODO: Mejorar performance
+		await extractAssetsFromDist(domain);
+	}
+
+	// rsync assets
+	await mvDirs(__root, __exports, renderArtifacts.archivables, { override: true });
+}