Generar payload de ejemplo para una fuente de evento de componente

Generación de payload

Un component event listener escucha un evento específico que ocurre en uno de los componentes de Catalyst, luego activa la función objetivo asociada y le pasa los datos del componente. Ya está creado por defecto en un proyecto. Puedes obtener datos de ejemplo del mismo patrón en el CLI, para la fuente y la acción que necesites.

El comando general para generar un payload de ejemplo de un evento en el CLI es:

Puedes proporcionar cualquiera de las fuentes y acciones asociadas de un evento de componente de Catalyst, en el comando que se muestra en la tabla a continuación:

Por ejemplo, para generar un payload de ejemplo para un evento de inserción en Data Store, ejecuta el siguiente comando:

Esto generará el siguiente payload JSON para esta fuente y acción. El payload contendrá los detalles reales de tu proyecto, los detalles del event bus predeterminado y detalles de entidad de ejemplo.

Puedes pasar estos datos a una función Event a través del shell de funciones y probarla según tus necesidades.

También puedes guardar directamente el payload JSON en un archivo en lugar de mostrarlo en el CLI, creando un archivo en la ruta que necesites de la siguiente manera:

Entradas opcionales

Además del par obligatorio de fuente y acción, también puedes proporcionar entradas opcionales sobre la fuente de la entidad, como se muestra en la tabla. Por ejemplo, si especificas el nombre o ID de la tabla al generar el payload de ejemplo para una operación de inserción en Data Store, Catalyst verificará en tu proyecto remoto si existe una tabla con ese nombre o ID. Si la entidad existe, el CLI mostrará los datos de esa tabla en el payload JSON.

Si no proporcionas entradas opcionales, o si no hay entidades que coincidan con tus entradas, el CLI generará el payload JSON con datos de ejemplo aleatorios.

Por ejemplo, para generar un payload de ejemplo para un evento de put en caché en un segmento existente configurado en la consola remota, se ejecuta el siguiente comando:

Catalyst busca un segmento con ese nombre o ID. Si existe, generará el payload incluyendo los datos de ese segmento. El ID del segmento que se pasó se especifica como el valor para source_entity_id en el ejemplo que se muestra a continuación.

Opciones de generación de eventos de componentes

El comando catalyst event:generate admite dos opciones que puedes usar con él. Sin embargo, solo una de esas opciones es aplicable cuando generas un payload de ejemplo de una fuente de evento de componente.

-e | --event-bus <event_bus_name>

La opción --event-bus o -e te permite especificar el nombre del event bus que debe usarse en el payload de ejemplo. Puedes usar esto al generar el payload de cualquier fuente o acción. El JSON event_bus_details contendrá el nombre que pases como nombre del bus.

Si no especificas el nombre del event bus, el nombre del bus será ‘Default’ en el payload de un evento de componente.

Por ejemplo, para generar el payload de un evento de put en caché y especificar el nombre del event bus con él, ejecuta el siguiente comando:

Esto generará el payload e incluirá el nombre del event bus en event_bus_details.

Discutiremos las opciones disponibles en el contexto de una fuente de evento personalizado en la siguiente sección.