Empty product array on "page.empty_cart" generate a invalid json schema

[matheusgr]

product: [] creates a items: [] property type, which is invalid.

we may cast it to an object so it will generate a valid json such as items: {}.

apps/vtex/actions/analytics/sendEvent.ts

Line 18 in 0246e5e

type: "page.empty_cart";

[decobot]

💡 Solução Detalhada - Empty Product Array Generates Invalid JSON Schema

🔍 Problema

Quando product: [] é definido, gera items: [] no schema, que é inválido. Deveria gerar items: {}.

📝 Solução

Localizar onde o schema é gerado e adicionar tratamento para arrays vazios:

// commerce/types.ts ou similar
import type { Product } from "apps/commerce/types.ts";

export interface EmptyCartEvent {
  "@type": "page.empty_cart";
  cart: {
    products: Product[]; // Mesmo vazio, mantém o tipo
  };
}

// Utility para garantir schema válido
export function normalizeSchemaItems<T>(items: T[]): T[] | Record<string, never> {
  return items.length === 0 ? {} as Record<string, never> : items;
}

🔧 Aplicar no Evento

Onde o evento page.empty_cart é criado:

// Exemplo: commerce/actions/cart/clear.ts
export default async function clearCart(
  props: Props,
  req: Request,
  ctx: AppContext,
) {
  // ... limpar carrinho ...
  
  // Emitir evento com schema correto
  const event = {
    "@type": "page.empty_cart" as const,
    cart: {
      products: [], // Array vazio está OK aqui
    },
  };
  
  // Ao serializar para analytics/schema
  const schemaEvent = {
    ...event,
    cart: {
      ...event.cart,
      // Converter array vazio para objeto vazio no schema
      products: event.cart.products.length === 0 
        ? {} 
        : event.cart.products,
    },
  };
  
  return schemaEvent;
}

🎯 Solução Genérica

Criar utility para sanitizar schemas:

// utils/schema.ts
export function sanitizeSchemaArray<T>(
  array: T[] | undefined | null
): T[] | Record<string, never> {
  if (!array || array.length === 0) {
    return {} as Record<string, never>;
  }
  return array;
}

// Uso:
const schema = {
  "@type": "page.empty_cart",
  cart: {
    products: sanitizeSchemaArray(products),
  },
};

📦 Solução para Analytics Events

Se o problema é no processamento de eventos analytics:

// analytics/utils/processEvent.ts
export function processEventForSchema(event: unknown): unknown {
  if (Array.isArray(event)) {
    return event.length === 0 ? {} : event.map(processEventForSchema);
  }
  
  if (typeof event === "object" && event !== null) {
    return Object.fromEntries(
      Object.entries(event).map(([key, value]) => [
        key,
        Array.isArray(value) && value.length === 0 
          ? {}
          : processEventForSchema(value),
      ])
    );
  }
  
  return event;
}

✅ Checklist

• Localizar onde page.empty_cart é emitido
• Adicionar conversão de [] para {} no schema
• Testar que JSON schema gerado é válido
• Verificar que não quebra outros eventos
• Aplicar fix para outros eventos que possam ter arrays vazios
• Validar schema com ferramenta JSON Schema validator