Fase 2 ADR 0006 Etapa 2: plugin de Meilisearch + ruta de facetas

Instala @rokmohar/medusa-plugin-meilisearch@^1.4.1 (linea v1, la unica
compatible con nuestro Medusa 2.18.0 exacto -- confirmado contra
peerDependencies reales de npm: @medusajs/* ^2.15.2, satisfecho por
2.18.0). Conectado via un array `plugins:` nuevo en medusa-config.ts
(primer uso en este repo, no `modules:`), env vars leidos con `?? ""`
en vez de required() -- si Meilisearch esta caido o mal configurado,
el plugin se degrada solo en vez de tumbar el arranque de Medusa
entero.

No se escribe un subscriber propio: se verifico contra el codigo
fuente real del paquete (descargado el tarball exacto de npm,
inspeccionado en /app/node_modules dentro de una imagen Docker de
verdad) que trae sus propios subscribers de product/category/
collection/variant/etc, descubiertos por Medusa en runtime desde
dentro del propio paquete -- confirmado que sobreviven a
`npm prune --omit=dev` y llegan intactos a la imagen final. Tambien
trae un job de indexado inicial de una sola corrida al boot
(numberOfExecutions: 1, no un cron recurrente -- no viola la
restriccion del ADR de "nunca cron").

Nueva ruta Store API propia (src/api/store/search/route.ts): las
rutas /store/meilisearch/* que trae el plugin no devuelven
facetDistribution (verificado leyendo su codigo fuente), asi que esta
ruta pide facets explicitamente via additionalOptions.facets, y
despues re-hidrata los productos via query.graph (mismos campos que
ya usa el storefront) en vez de confiar en precios/inventario
indexados -- mismo patron "safe path" que ya usa la ruta oficial del
plugin para /store/meilisearch/products.

Transformer custom en medusa-config.ts que espeja mapProduct() del
storefront (category/collection/brand/ageRange desde metadata,
disponibilidad desde la primera variante) para que el documento
indexado sea exactamente lo que el storefront ya muestra.

Validado en vivo: build completo de Docker (target builder) corre
limpio -- npm ci, medusa build (typecheck + compile backend/frontend),
npm prune -- cero errores. package-lock.json regenerado con un
contenedor node:22.18.0-bookworm-slim real (mismo base image que el
Dockerfile), no a mano.

Dockerfile: dummy MEILISEARCH_HOST/MEILISEARCH_API_KEY en el stage de
build (insurance barata, no son required() asi que no eran
estrictamente necesarios para que el build pasara, y de hecho paso
sin ellos en la prueba -- se dejan de todas formas por consistencia
con el resto de dummies de esa capa).
This commit is contained in:
devops committed 2026-08-26 15:39:30 -05:00
1 parent 688a7d8e97
commit 6be8dd409c
5 files changed
+336 -3

No files matched your search

+3 -1
View File
@@ -21,7 +21,9 @@ ENV CI=true \
S3_ACCESS_KEY_ID=build-access-key \
S3_SECRET_ACCESS_KEY=build-secret-key \
S3_BUCKET=ari-shopping \
S3_ENDPOINT=http://127.0.0.1:9000
S3_ENDPOINT=http://127.0.0.1:9000 \
MEILISEARCH_HOST=http://127.0.0.1:7700 \
MEILISEARCH_API_KEY=build-only-meili-key
COPY package.json package-lock.json .npmrc ./
+140
View File
@@ -10,6 +10,79 @@ const required = (name: string): string => {
return value
}
// Mismos campos derivados de metadata/categories/collection/variants que
// mapProduct() en workloads/ecommerce/lib/headless/providers/medusa.ts --
// el documento indexado debe reflejar exactamente lo que el storefront
// ya muestra, no una vista distinta del catálogo.
function stringMetadata(
metadata: Record<string, unknown> | null | undefined,
key: string,
): string {
const value = metadata?.[key]
return typeof value === "string" ? value : ""
}
function booleanMetadata(
metadata: Record<string, unknown> | null | undefined,
key: string,
): boolean {
const value = metadata?.[key]
return value === true || value === "true"
}
async function meilisearchProductTransformer(
document: Record<string, unknown>,
) {
const metadata = (document.metadata ?? null) as Record<
string,
unknown
> | null
const categories = document.categories as
| Array<{ name?: string | null }>
| null
| undefined
const collection = document.collection as { title?: string | null } | null
const variants = document.variants as
| Array<{
inventory_quantity?: number | null
manage_inventory?: boolean | null
allow_backorder?: boolean | null
calculated_price?: { calculated_amount?: number | null } | null
}>
| null
| undefined
const variant = variants?.[0]
const tags = document.tags as Array<{ value?: string | null }> | null
const category =
categories?.[0]?.name || stringMetadata(metadata, "category") || "Variedades"
const available =
!variant ||
variant.allow_backorder === true ||
variant.manage_inventory === false ||
(variant.inventory_quantity ?? 0) > 0
return {
id: document.id,
name: document.title || "Producto ARI Shopping",
shortDescription: document.subtitle || document.title || "",
description: document.description || "",
category,
collection: collection?.title || stringMetadata(metadata, "collection") || "",
brand: stringMetadata(metadata, "brand") || "ARI Shopping",
ageRange: stringMetadata(metadata, "ageRange") || "Todas",
tags: (tags || []).map((tag) => tag.value).filter(Boolean),
price:
typeof variant?.calculated_price?.calculated_amount === "number"
? variant.calculated_price.calculated_amount
: null,
available,
isNew: booleanMetadata(metadata, "isNew"),
featured: booleanMetadata(metadata, "featured"),
}
}
module.exports = defineConfig({
projectConfig: {
databaseUrl: required("DATABASE_URL"),
@@ -73,4 +146,71 @@ module.exports = defineConfig({
},
},
],
// ADR 0006 Etapa 2. Sin required(): a diferencia de S3/DB, Meilisearch
// es un servicio nuevo y todavia no probado en produccion en un host
// con historial de swap saturado -- si esta caido o mal configurado,
// el plugin se degrada solo (soporta enabled:false, "silently skipped"
// segun su propio README) en vez de tumbar el arranque de Medusa
// entero, que es lo que si haria required().
plugins: [
{
resolve: "@rokmohar/medusa-plugin-meilisearch",
options: {
config: {
host: process.env.MEILISEARCH_HOST ?? "",
apiKey: process.env.MEILISEARCH_API_KEY ?? "",
},
settings: {
products: {
type: "products",
enabled: Boolean(process.env.MEILISEARCH_HOST),
primaryKey: "id",
// Campos que el plugin pide via query.graph antes de pasarlos
// al transformer de arriba -- si falta alguno acá, llega
// undefined al transformer sin importar lo que este haga.
fields: [
"id",
"title",
"subtitle",
"description",
"handle",
"status",
"thumbnail",
"metadata",
"tags.value",
"categories.name",
"collection.title",
"variants.inventory_quantity",
"variants.manage_inventory",
"variants.allow_backorder",
"variants.calculated_price.calculated_amount",
],
indexSettings: {
// Tabla de ADR 0006 §3: Buscable / Filtrable-faceta / Ordenable.
searchableAttributes: [
"name",
"shortDescription",
"description",
"category",
"collection",
"brand",
"tags",
],
filterableAttributes: [
"category",
"collection",
"brand",
"ageRange",
"price",
"available",
],
sortableAttributes: ["price", "isNew", "featured"],
},
transformer: meilisearchProductTransformer,
},
},
},
},
],
})
+30 -1
View File
@@ -12,7 +12,8 @@
"@medusajs/admin-sdk": "2.18.0",
"@medusajs/cli": "2.18.0",
"@medusajs/framework": "2.18.0",
"@medusajs/medusa": "2.18.0"
"@medusajs/medusa": "2.18.0",
"@rokmohar/medusa-plugin-meilisearch": "^1.4.1"
},
"devDependencies": {
"@swc/core": "^1.7.28",
@@ -6561,6 +6562,28 @@
"node": ">=14.0.0"
}
},
"node_modules/@rokmohar/medusa-plugin-meilisearch": {
"version": "1.4.3",
"resolved": "https://registry.npmjs.org/@rokmohar/medusa-plugin-meilisearch/-/medusa-plugin-meilisearch-1.4.3.tgz",
"integrity": "sha512-+iStv5sc2vuLk+O7OcQLlNR99fMBhGdBOJMCmDJYoTFGhzBA4ZEV18IIr2xqxUDgdQo1haF0TtYv3JmRQUuY1w==",
"license": "MIT",
"dependencies": {
"meilisearch": "^0.56.0"
},
"engines": {
"node": ">=22"
},
"peerDependencies": {
"@medusajs/admin-sdk": "^2.15.2",
"@medusajs/framework": "^2.15.2",
"@medusajs/medusa": "^2.15.2",
"@medusajs/ui": "^4.1.12",
"@tanstack/react-query": "5.64.2",
"awilix": "^8.0.1",
"react": "^18",
"react-dom": "^18"
}
},
"node_modules/@rolldown/pluginutils": {
"version": "1.0.0-beta.27",
"resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-beta.27.tgz",
@@ -11774,6 +11797,12 @@
"node": ">= 0.6"
}
},
"node_modules/meilisearch": {
"version": "0.56.0",
"resolved": "https://registry.npmjs.org/meilisearch/-/meilisearch-0.56.0.tgz",
"integrity": "sha512-kBXba8DcSrLWHYqopCm2JL90oBy97VdIfHkP1ii7/eHufeEEEk9Zu5Vv/IFQpNzmhEpWszVFVlGvZoI6QJeGzA==",
"license": "MIT"
},
"node_modules/merge-descriptors": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz",
+2 -1
View File
@@ -14,7 +14,8 @@
"@medusajs/admin-sdk": "2.18.0",
"@medusajs/cli": "2.18.0",
"@medusajs/framework": "2.18.0",
"@medusajs/medusa": "2.18.0"
"@medusajs/medusa": "2.18.0",
"@rokmohar/medusa-plugin-meilisearch": "^1.4.1"
},
"devDependencies": {
"@swc/core": "^1.7.28",
@@ -0,0 +1,161 @@
import type { MedusaRequest, MedusaResponse } from "@medusajs/framework";
import { ContainerRegistrationKeys } from "@medusajs/framework/utils";
import {
MEILISEARCH_MODULE,
type MeiliSearchService,
} from "@rokmohar/medusa-plugin-meilisearch";
// Las rutas /store/meilisearch/* que trae el plugin (ver ADR 0006 nota de
// implementacion) no devuelven facetDistribution -- necesitamos esta
// ruta propia para pedirlo explicitamente via additionalOptions.facets,
// que el servicio del plugin reenvia tal cual al cliente Meilisearch.
const FACETS = ["category", "collection", "brand", "ageRange"];
// Mismos campos que ya usa el storefront contra /store/products
// (workloads/ecommerce/lib/headless/providers/medusa.ts) -- una vez que
// Meilisearch nos da los ids candidatos, volvemos a Medusa via
// query.graph para precio/inventario reales, nunca confiamos en el
// valor indexado (puede tener unos segundos de retraso respecto al
// evento de sincronizacion).
const PRODUCT_FIELDS = [
"id",
"handle",
"title",
"subtitle",
"description",
"thumbnail",
"external_id",
"metadata",
"images.url",
"tags.value",
"categories.name",
"collection.title",
"variants.id",
"variants.title",
"variants.sku",
"variants.manage_inventory",
"variants.allow_backorder",
"variants.inventory_quantity",
"variants.calculated_price.calculated_amount",
"variants.calculated_price.original_amount",
"variants.calculated_price.currency_code",
"variants.options.value",
"variants.options.option.title",
];
function stringParam(
query: MedusaRequest["query"],
name: string,
): string | undefined {
const value = query[name];
return typeof value === "string" && value.length > 0 ? value : undefined;
}
function numberParam(
query: MedusaRequest["query"],
name: string,
): number | undefined {
const value = stringParam(query, name);
if (!value) return undefined;
const parsed = Number(value);
return Number.isFinite(parsed) ? parsed : undefined;
}
// Meilisearch usa comillas dobles para valores de filtro con espacios;
// escapamos las que vengan en el propio valor para no romper la sintaxis.
function escapeFilterValue(value: string): string {
return value.replace(/\\/g, "\\\\").replace(/"/g, '\\"');
}
export async function GET(req: MedusaRequest, res: MedusaResponse) {
const meilisearchService = req.scope.resolve<MeiliSearchService>(
MEILISEARCH_MODULE,
);
const query = req.scope.resolve(ContainerRegistrationKeys.QUERY);
const q = stringParam(req.query, "q") ?? "";
const limit = numberParam(req.query, "limit") ?? 24;
const offset = numberParam(req.query, "offset") ?? 0;
const filterParts: string[] = [];
for (const facet of ["category", "collection", "brand", "ageRange"]) {
const value = stringParam(req.query, facet);
if (value) {
filterParts.push(`${facet} = "${escapeFilterValue(value)}"`);
}
}
const minPrice = numberParam(req.query, "minPrice");
const maxPrice = numberParam(req.query, "maxPrice");
if (typeof minPrice === "number") filterParts.push(`price >= ${minPrice}`);
if (typeof maxPrice === "number") filterParts.push(`price <= ${maxPrice}`);
const indexes = await meilisearchService.getIndexesByType("products");
if (indexes.length === 0) {
// Meilisearch no configurado o el indice "products" esta
// deshabilitado -- degradar a "sin resultados" en vez de 500, el
// frontend cae de nuevo a su propio filtrado si esta ruta falla.
res.json({ products: [], facetDistribution: {}, count: 0, limit, offset });
return;
}
const results = await Promise.all(
indexes.map((indexKey) =>
meilisearchService.search(indexKey, q, {
filter: filterParts.length ? filterParts.join(" AND ") : undefined,
paginationOptions: { limit, offset },
additionalOptions: { facets: FACETS },
}),
),
);
const hits = results.flatMap((result) => result.hits);
const totalCount = results.reduce(
(sum, result) => sum + result.estimatedTotalHits,
0,
);
const facetDistribution: Record<string, Record<string, number>> = {};
for (const result of results) {
const resultFacets = (
result as unknown as {
facetDistribution?: Record<string, Record<string, number>>;
}
).facetDistribution;
if (!resultFacets) continue;
for (const [facet, values] of Object.entries(resultFacets)) {
facetDistribution[facet] ??= {};
for (const [value, count] of Object.entries(values)) {
facetDistribution[facet][value] =
(facetDistribution[facet][value] ?? 0) + count;
}
}
}
const productIds = hits.map((hit) => (hit as { id: string }).id);
if (productIds.length === 0) {
res.json({ products: [], facetDistribution, count: 0, limit, offset });
return;
}
const { data: products = [] } = await query.graph({
entity: "product",
fields: PRODUCT_FIELDS,
filters: { id: productIds },
});
// Preserva el ranking de relevancia de Meilisearch -- query.graph no
// garantiza el mismo orden que la busqueda.
const orderedProducts = [...products].sort(
(a, b) => productIds.indexOf(a.id) - productIds.indexOf(b.id),
);
res.json({
products: orderedProducts,
facetDistribution,
count: totalCount,
limit,
offset,
});
}