Empezando Apex Asíncrono por las colas

1. Introducción

En esta entrada me centraré, en cómo diseñar la ejecución de Procesos Asíncronos Apex (en adelante Apex Async), aprovechando las capacidades de la plataforma.

Pero lo haré de manera invertida a como se hace habitualmente, donde se explica como programar los mecanismos de programación. Pero en IMMO, si los desarrolladores, arquitectos y administradores, entendemos bien como gestiona Salesforce los procesos asíncronos, sus colas de Espera y Ejecución, sus límites asociados, etc., la elección del mecanismo de programación, es muy sencilla u obvia.

En el contexto asíncrono, un diseño centrado en la programación y no en las capacidades de la plataforma, puede suponer limitar el rendimiento y las prestaciones de nuestro proyecto.

Y  es que si lo hubieras sabido, te hubieras cortado el pelo antes, y  no hubieras ido con tu compañero.

  1. Introducción
  2. Back to Basics: ¿Qué és un proceso Apex asíncrono?
  3. Estados de un Job Apex asíncrono
  4. Apex Flex Queue(s) y la Apex Jobs Queue
    4.1. Apex Flex Queue
    4.1.1. Orden de inserción en la Flex Queue y reordenación de prioridades
    4.2. Test-Context Queue (la otra Flex Queue)
    4.3. Apex Jobs Queue
  5. Límites de las colas
  6. Monitorización de las colas
    6.1. Mediante Interfaz de usuario
    6.2. Mediante el objeto AsyncApexJob
    6.3. Mediante CronTrigger y CronJobDetail para los Jobs Scheduled
  7. Retos reales no cubiertos por la plataforma

2. Back to Basics: ¿Qué és un proceso Apex asíncrono?

Un Job de Apex con naturaleza asíncrona (en adelante Apex Async ó Job Async), se ejecuta cuando la plataforma tiene recursos disponibles (lo que sucede muy a menudo) sin ninguna horquilla de finalización ni ANS o ETC (Service Level Agreement – Estimated Time to Complete), y siempre sin perjudicar al ámbito síncrono, donde trabaja el usuario final, que se ejecuta con prioridad.

En contrapartida, los límites para un Job Async son límites superiores que para un proceso síncrono. Así un Job asíncrono posee:

Los Limites para Jobs Asíncronos son superiores en prestaciones clave

Recalco, no existe ETC por parte de Salesforce, y por tanto, nuestro diseño no puede suponer ninguno de los aspectos siguientes:

  1. Cuando se iniciará el proceso
  2. Cuanto durará el proceso
  3. Cuando estarán disponibles los resultados de la ejecución

Ejecución de Apex Asíncrono basado en colas

Existen diferentes tipos de Jobs Apex Async, seguro que has visto algún método con la anotación @Future, pero siendo muy útil y práctico, ese es el hermano menor de todos.

Existen 3 mecanismos adicionales, implementados mediante Interfaces (no asustarse es muy simple):

  1. @Queueable
  2. @Schedulable
  3. @Batchable

Pero como viste en la imagen anterior, se gestionan mediante colas. Por tanto, aquí empieza el Rock&Roll, veamos los estados de un proceso y como la plataforma gestiona los Jobs asíncronos.

Salesforce Queues para Apex Async

3. Estados de un Job Apex asíncrono

Los estados de un proceso (Job) Apex Async, transcurre por los siguientes estados:

Estado que reporta la plataforma Descripción y Cola en la que reside el Proceso Es un estado finalista?
Holding El proceso Batch se ha enviado correctamente, pero queda pendiente de ser ejecutado, cuando hay recursos disponibles, que permitan su ejecución. El proceso reside en la cola Flex No
Queued La ejecución es inminente. El proceso se transfiere de la cola Flex a la cola Jobs, y se mantendrá en esta cola hasta la finalización No
Preparing El método start es ejecutado, ha empezado el Rock&Roll No
Processing Se ejecuta la lógica completa del proceso No
Aborted Es un estado finalista, al que se llega si se decide abortar la ejecución de manera voluntaria Si
Completed El proceso ha finalizado, pueden existir errores o finalización totalmente correcta Si
Failed Estado que indica que algo salió mal a nivel de plataforma, y el proceso no fue finalizado correctamente  Si

Veamos como se relaciona la ejecución de un Job con las colas de la plataforma.

4. Apex Flex Queue(s) y la Apex Jobs Queue

La plataforma Salesforce, ofrece 3 colas, para la gestión de los procesos asíncronos:

  1. Apex Flex Queue (Flex por Flexible)
  2. Su homóloga para testing la Test-Context Queue
  3. Apex Jobs Queue

Nota: cuando Salesforce liberó la funcionalidad de la cola Apex Jobs en 2015, se hablaba de la Batch Queue, actualmente este término está deprecado.

4.1. Apex Flex Queue

Al crear un Job de Apex Async Batch, su ejecución no se inicia hasta confirmar que hay recursos disponibles para su ejecución. Por tanto, el proceso es:

  1. Crear el Job, serializarlo para ubicarlo en las colas de sistema
  2. Si se pudo crear el Job (límites, etc.) el sistema retorna un ID identificando el Job (este ID permite inspeccionar las características del Job)
  3. Si el Job es Batch, se coloca en la cola Flex Queue, en estado Holding – esto implica que no se está ejecutando – ninguna de sus métodos ha sido invocado excepto el constructor de la clase (esto es importante)
  4. Si el Job no es Batch, queda encolado en la cola de proceso Job Apex para su procesamiento cuando haya recursos

  5. En cuanto la plataforma tenga recursos disponibles, ejecutará el Job y lo moverá de la cola Flex a la cola Apex Jobs.

En esta cola, el proceso tiene todos los atributos (15) de ejecución: Job Type, Summitted By, Apex Class, Apex Method, etc.

Campos Descriptivos Job Flex Queue

4.1.1. Orden de inserción en la Flex Queue y reordenación de prioridades

El orden de inserción en la cola es fundamental, ya que indicará como el sistema iniciará la ejecución de los Jobs. Por tanto, el orden de inserción marcará el lanzamiento de la ejecución del Job.

Un error común, es considerar que los procesos Batch se ejecutarán uno detrás de otro, y puede no ser así, dado que la plataforma puede ejecutar hasta 5 procesos concurrentes simultáneamente. Por tanto el diseñador debe tener en consideración que:

  1. Los Jobs se iniciarán en orden de inserción en la cola Flex (salvo errores en su creación)
  2. Los Jobs pueden ejecutarse simultáneamente y se desconoce el orden de finalización, dado que son procesos asíncronos usando recursos disponibles. Suponer que la dependencia funcional, que 2 Jobs deben ser ejecutados en modo serie, será satisfecha por haber insertado uno detrás de otro, es un error de diseño.

Mientras el Job Batch está en la cola Flex, tanto el administrador como el programador tienen la posibilidad de reubicar los procesos.

El Administrador dispone de una interfaz de Monitorización de la cola:

Detalle de la Flex Queue y Opciones disponibles en la interfaz de usuario.

Por su parte, el programador tiene acceso a los 4 métodos de la clase FlexQueue:

  1. moveAfterJob(jobToMoveId, jobInQueueId)
  2. moveBeforeJob(jobToMoveId, jobInQueueId)
  3. moveJobToEnd(jobId)
  4. moveJobToFront(jobId)

4.2. Test-Context Queue (la otra Flex Queue)

La plataforma proporciona una cola adicional, para que los programadores puedan realiza Test del encolamiento en la Flex Queue. Estos métodos pertenecientes a la clase Test son:

  1. enqueueBatchJobs(numberOfJobs)que permite enviar a la cola el número indicado de jobs
  2. getFlexQueueOrder()que devuelve la lista de los identificadores de los Jobs presentes en la cola

Un ejemplo:

Ejemplo de uso de la Test Flex Queue

4.3. Apex Jobs Queue

Alberga todos los Jobs del sistema, tanto en estados intermedios como no finalistas (ver apartado anterior), y tanto Jobs internos de Salesforce como los creados por el programador. Estos son:

Jobs creados por un programador para procesamiento Apex asíncrono:

  1. Future
  2. Queueable
  3. ScheduledApex
  4. BatchApex

Jobs creados por Salesforce para la gestión interna del sistema:

  1. SharingRecalculation
  2. BatchApexWorker
  3. TestRequest
  4. TestWorker
  5. ApexToken

Aunque no documentado por Salesforce (como comenta Pedro Espada en la Success Comunity) los procesos Future se ejecutan prioritariamente, por delante de Queueable y Batchable. Quizás la razón, es porque este tipo de procesos están pensados inicialmente para fragmentos asíncronos sin una gran carga, llamadas a Web Services, etc.

5. Límites de las colas

Es imprescindible conocer los límites sobre las colas y Jobs, de los que considero más importantes son:

Límites Apex Async
  1. Pueden existir hasta 100 Jobs Batch en estado Holding. Por tanto la profundidad máxima de la cola Flex, es 100 Jobs.
  2. Solo pueden existir 5 Jobs Activos: *Queued, Preparing, Processing
Error al superar el límite de 100 Procesos
  1. Hasta 50 Jobs pueden enviarse a la cola Apex Job con la sentencia System.enqueueJob
Si tratamos de insertar +50 Jobs mediante System.Enqueue en la cola de ejecución Apex Job, obtendremos una excepción
  1. Análogamente para procesos Future también tenemos la limitación de 50 Jobs como máximo

Cualquier inserción en las colas que pretenda superar estos límites, recibe una excepción del sistema, y se rechaza.

6. Monitorización de las colas

6.1. Mediante Interfaz de usuario

La interfaz de Salesforce proporciona acceso a los procesos cronificados,  la Flex Queue y a la Apex Jobs.

Acceso a los interfaces de Monitorización de las colas

En el caso de la cola Flex además permite la reordenación de los Jobs y acceder a sus características. La reordenación se realiza indicando en qué posición se desea colocar el Job.

6.2. Mediante el objeto AsyncApexJob

Además de la interfaz, la plataforma proporciona un objeto, AsyncApexJob, donde cada registro describe un Job, con todos sus atributos. Este registro se actualiza a medida que el Job va transcurriendo por su ciclo de vida.

Este objeto es accesible vía SOQL, lo que nos permite obtener información sobre cuantos Jobs tenemos, cuantos son de cada tipo, cuantos están en un determinado estado, duración de los finalizados, ver las características de un Job concreto, etc.

Los procesos que residen en la cola Flex, también están presentes en AsyncApexJob, ya que son Jobs asíncronos como el resto, aunque en un estado determinado.

Consulta del objeto ApexJobAsync para mostrar los Jobs en Proceso y Completados

6.3. Mediante CronTrigger y CronJobDetail para los Jobs Scheduled

Para los Jobs de tipo Scheduled, la plataforma además nos proporciona los objetos CronTrigger y CronJobDetail. Existe mucha documentación en Trailhead y la API donde encontrar ejemplos de uso

  1. CronTrigger contiene varios campos como PreviousFireTime, TimesTriggered, State, NextFireTime, etc., que contienen la información del Job respecto a sus ejecuciones
  2. CronJobDetail contiene 2 miembros: JobType y Name

7. Retos no cubiertos por la plataforma

Casos de uso que requieren adaptaciones de la plataforma

Reto 1: Tengo procesos dependientes funcional que deben ejecutarse en serie

Conociendo el ciclo de vida de un Job y las colas empleadas para su gestión, podemos encontrar una limitación muy rápidamente: ¿Cómo asegurar que un Job se ejecute y complete previamente a otro, dado que existe una dependencia funcional de negocio entre ellos?

Si consideramos al Job inicial como “Job padre” y el dependiente como “Job hijo”, podemos traducir el caso de uso a la inserción del Job Hijo en la Flex Queue no debe realizarse hasta haber concluido la ejecución del proceso Padre.

Para ello tenemos varias alternativas:

  1. Si tenemos Jobs de tipo Queueable podemos utilizar Job Chaining
  1. Si tenemos Jobs de tipo Batchable, en el finish() del padre, podemos lanzar el Job hijo
  1. Sincronizamos la ejecución de los Jobs vía Platform Events: cuando el Job Padre finaliza, lanza un evento para que el Job hijo sea insertado en la Job Queue.

Los 3 esquemas anteriores, sufren de un defecto, ¿qué sucede si el hijo tiene varias dependencias, por ejemplo padre y madre, ó un padre y pero no iniciarme antes de las 22.00?

  1. Construir un planificador dinámico, que veremos en la siguiente entrada.

Reto 2: Tengo Jobs Scheduled que deben ejecutarse a una hora concreta o periódicamente de forma garantizada

Este caso es más complejo, dado que su traducción es **Cuando llegue el momento de ejecución de ese proceso, no debe haber más de 4 procesos ejecutándose, para tener las máximas garantías (no la seguridad total) de que ese proceso podrá ejecutarse.

Para ello, debemos tener un control de los procesos que están activos en la cola Apex Jobs y de los procesos en la cola Flex.

Este caso de uso, requiere nuevamente de un planificador dinámico que controle de forma adecuada ambas colas.

Enlaces interesantes

  1. Asynchronous Processing in Force com – Lectura y comprensión obligatoria
  2. Asynchronous Processing Basics
  3. Monitor Asynchronous Apex
  4. Monitoring the Apex Flex Queue
  5. Monitoring the Apex Job Queue
  6. SOAP API Developer Guide for AsyncApexJob
  7. Differences between job types for ‘AsyncApexJob’ object
  8. Trailhead – Async Apex
  9. Trailhead – Control Processes with Queueable Apex

2 thoughts on “Empezando Apex Asíncrono por las colas

    1. Hola Alba, mil gracias por tu comentario. Si, ya tengo uno es basico, pero cubre las necesidades explicadas en este artículo, seguramente te parecerá bastante básico, pero puede servir como punto de partida. A ver si para final de mes, puedo tener una entrada completa explicándolo.
      Un saludo!

      Me gusta

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s