Griddo package

TO-DO

• [ ] Crear el store utilizando un HASH como nombre de archivo y no el ID.
• [ ] Manejar el store teniendo en cuenta el ID de las páginas leyendo el objeto y no el nombre del archivo.

El package griddo-cx está dividido en dos carpetas principales: una para la lógica de negocio en /exporter y otra para Gatsby (builder) /src.

Estas dos carpetas estarían representando dos estados o fases diferenciadas en la ejecución de un "render/build de cx" completo.

1. Fetching: Obtención, postprocesado y guardado de los datos en el sistema de archivos.

2. Rendering Ejecución de Gatsby para construir los sites utilizando los datos descargados

1. Fetching

En la fase de Griddo se desarrolla todo lo necesario para la conexión con API, post-procesado de los datos y generación de JSONS finales de los sites con "un formato Griddo". Aquí es donde se ejecuta la mayor parte de la lógica: obtención de páginas, listados, distribuidores, idomas, etc.

Si hay un requerimiento en CX es muy probable que sea en esta parte donde haya que trabajar.

Estructura de carpetas

| exporter/
  | adapters/
    | gatsby/ # Adapta la salida (JSON) de Griddo -> Gatsby
  | services/
  | types/
  | utils/
  | create-build-data.ts
  | build-complete.ts
  | index.ts
  | reset-render.ts

2. Rendering (Gatsby)

Esta fase se ejecuta inmediatamente después de la primera. Se ejecuta yarn gatsby build lo que generá un build utilizando todos los datos que se descargaron en la carpeta store.

El código de Gatsby (por ahora el único SSG usado por Griddo) está en la carpeta ./src junto con los archivos en el root: gatsby-config.ts, gastsby-node.ts, gatsby-browser.ts y gatsby-ssr.ts.

| src/
  | components/
    | Head.tsx
    | template.tsx
  | htm.tsx
  | gatsby-node-utils.ts
  | types.ts
  | utils.ts
| gatsby-browser.ts
| gatsby-config.ts
| gatsby-node.ts
| gatsby-ssr.ts

Griddo Exporter

El punto de entrada para CX está en src/index.js que ejecuta Griddo Exporter, publicado en ./build/index.js del cual podemos encontrar el código TypeScript en ./scripts/griddo-exporter.ts

Griddo Exporter es el script orquestador que llama una vez por cada dominio a los distintos procesos que implican la realización del build de un dominio.

BUILD-COMPLETO = PROCESOS * DOMINIOS

Los procesos

Los distintos procesos llamados desde Griddo Exporter son:

API Fetch

yarn run api-fetch

Realiza toda la consulta de datos a la API de los sites (páginas, distribuidores, etc...) de un dominio, post-procesa y construye los pageObjets. Estos pageObjects son guardados como archivos JSON en una carpeta del sistema de archivos, creando lo que llamamos un Store.

Este Store no está acoplado con ningún sistema de renderización (Gatsby), son solo archivos JSON que describen los sites y páginas con el estándar que hemos diseñado desde Griddo.

Gatsby build

gatsby-build

Se leen los JSON del store y se crean las páginas pasándolos directamente (0 pre/post procesado) a la función creatPages de Gatsby.

Post build

• Se crean Robots
• Se crean sitemaps.xml del render
• Se crear un archivo build_reportinfo.json para notificar a la API de la finalización del render
• Se mueven el bundle generado por Gatsby de /public a /dist (esto se debería deprecar)

post-build