Aprendiendo a desarrollar Cron job en Magento 2

Primero si alguien aquí ya sabe de Linux y cron Jobs y más aún ha escuchado el concepto de crontab olvídelo por completo porque lo que veremos ahora no tienen que ver con ese mismo concepto, vamos a centrarnos en un simple archivo del lado de Magento llamado crontab.xml y que este archivo una vez sea creado en la ruta especifica de un componente podrá servir para que Magento cuando lo detecte tomara su configuración y creara un registro en una tabla navita de sus tablas de la base de datos específicamente llamada “cron_schedule” una vez creado este registro ahora Magento apilara todas esta configuraciones recogiendo cada una de cada módulos nativo o module creado por el propio desarrollador, al final esto debe verse como una lista de registros que indican parámetros de ejecución de las tareas programadas que se piensan ejecutar de forma automatizada.

Esta tabla nativa de una instalación de Magento 2 contiene una serie de columnas que es importante entender para que podamos leer lo que ha sucedido, está sucediendo y sucederá como si de un registro de estados se tratara, cuando se creó o registro en qué situación se encuentra y que pasara en el futuro.

• • shedule_id: el campo primario que ira autoincrementándose en la inserción de cada registro.
  • job_code: el identificador que ira en relación con el archivo XML llamado crontab.xml, cada archivo XML de cada módulo tendrá definido este atributo como indicador, recordar que es un nombre a forma de código así que su nomenclatura es importante y con palabras separadas por guion bajo para mejor entendimiento.
  • status: es el estado en el que se encuentra el registro colocando como pending como su estado inicial cuando se crear el registro, este estatus ira cambiando con forme va pasando cumpliendo un ciclo de vida del mismo, puede contener, pending, running, success, missed o error lo he colocado en ingles porque así es como tal cual se registrara en la tabla su expresión al español puede entenderse fácilmente.
  • messages: registrar un mensaje de lo que ha ocurrido con el proceso de ejecución, si ocurre una excepción, satisfacción o lo que haya pasado con el proceso nos dará un mini resumen de lo ocurrido.
  • created_at: la fecha de cuando se ha registrado en la tabla.
  • scheduled_at: la fecha de cuando se ha programado que suceda la acción, la fecha que el desarrollador programo que se ejecutara la acción.
  • execute_at: cuando por fin llega a cumplirse la fecha de ejecución este campo indicara en que momento exacto empezó a ejecutarse la acción.
  • finished_at: y claro valga la redundancia este campo indicar el momento en que finalizo la acción.

Para este ejercicio no usaremos un módulo real solo indicare donde va cada archivo y al final compartiré el código del ejemplo en un módulo básico para poder ver su ejecución.

Suponiendo que tenemos un módulo llamado Crones dentro de la carpeta de nuestra empresa Marcgento, el archivo crontab.xml debemos crearlo en esta ruta:  app/code/Macrgento/Crones/etc/crontab.xml como podemos ver este archivo debe existir dentro de la carpeta etc del proyecto y contendrá este contenido:

    
        
             */2 * * * *
        
    

Vamos a explicar que hay en este XML, primero la definición de esquemas indicada en los parámetros del nodo config son estándares del lado de Magento y es importante definir los en ese nodo, tratare de no adentrarme en este tema pero solo debes entender que estos esquemas son definición de validación para los archivos que se están creando, tienen una nomenclatura básica en el ejemplo se puede ver un esquema definido como

urn:magento:module:Magento_Cron:etc/crontab.xsd en donde:

• urn:magento: es el esquema URN.
• module: sera el tipo de referencia que se utilizara.
• Magento_Cron: sera el nombre del modulo en este caso es un modulo nativo de Magento y es el mismo que se definió en su archivo regsitration.php si lo quieres comprobar puedes mirar dentro de vendor/magento/module-cron/registration.php y finalmente la ruta relativa del archivo físicamente de la misma forma si quieres comprobarlo puede mirar que existe un archivo llamado crontab.xsd en: vendor/magento/module-cron/etc/crontab.xsd en resumen es un parámetro que indica la ruta de donde esta el archivo del esquema que pretendemos utilizar.

El primer parámetro xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” por buena practica deberás colocarlo es la URL del esquema donde se encuentra el espacio de nombre que define estos estándares tal vez no sea gran relevancia pero si sigues los lineamientos como lo indica Magento sera mejor en el futuro.

Nodos de crontab.xml

Veamos lo importante de esta estructura de XML, como podemos ver dentro del nodo principal <config> a continuación tenemos el nodo:

• <group> : que contiene solo un atributo id con el valor de “default”, para los que ya revisaron el artículo de Aprendiendo de Cron Jobs en Magento 2 ahora entenderán las agrupaciones de Cron Jobs del lado de Magento le sera mas sencillo lo que comentare a continuación, y es que este atributo es el que define el grupo a donde estará registrado este CRON al final todos se registran y se ejecutan, esto es mas un orden de cara al administrador como al desarrollador ya que puede identificar fácilmente donde ha colocado sus tareas programadas, veamos la siguiente imagen:Aquí se puede ver como hay diferentes agrupaciones de las cuales en el ejemplo se ha utilizado la que dice “default” pero bien podrías haber utilizado “index”, “staging” incluso en el mismo ejemplo se pueden ver como se a creado un grupo del modulo Mailchip que define el grupo “mailchip”, estas son la agrupaciones existentes pero el desarrollador puede ir agregando sus propias agrupaciones eso lo mostrare mas adelante.Ahora mostrare que hay en el interior y para que sirve si desplegamos un grupo por ejemplo desplegare “default” se muestra de esta forma:

  

  Y ahora todo esto que representa en Magento 2 y realizando las agrupaciones podemos en general indicar como apilar las tareas, agregando parametros de tiempo por horarios permitiendo separar las ejecuciones por cada grupo, o en ejecuciones paralelas.

  • Generate Schedules Every: este sera un valor numérico representado en minutos y es la frecuencia en la cual serán agregados los registros en la tabla cron_schedule esta ya la he mencionado anteriormente y sabes de lo que hablo si no mira nuevamente el articulo Aprendiendo de cron jobs en Magento 2 donde lo explico a detalle.
  • Schedule Ahead for: Este campo es numérico representado de igual forma en minutos e indica el tiempo de anticipación en el cual debe iniciar a escribirse los registros en la misma tabla cron_schedule, tal vez esto te genere confusión pero solo piensa esto que pasara si tienes un monto de tareas a registrar en un cierto horario pues este es un anticipado para indicarte si no hay algo pendiente por agregar puede antes de tiempo empezar a registrar en la tabla claro que por detrás Magento cuenta con una lógica interna que sabrá cuando ejecutar estas acciones bien el campo esta ahí y puedes mantener una organización adecuada.
  • Missed if Not Run Within: es un valor numérico representado en minutos que indicara a la tarea cuanto puede esperar para considerar que pueda ejecutarse de lo contrario lo considerara como perdido, es como el tiempo limite que tendrá cada tarea para poder iniciar su ejecución.
  • History Cleanup Every: este es un valor en minutos e indica el valor de histórico que el registro se mantendrá en la tabla cron_schedule, recuerda que estos son registros que se agregan en la base de datos dinamicamente en algún punto del tiempo estos deben ir desapareciendo automáticamente ya que al cumplir su ciclo de vida no hay caso que continúen ahí.
  • Success History Lifetime: es un valor numérico en minutos que indica el tiempo en que cada registro de la tabla cron_schedule fueron ejecutados con éxito y se mantendrán en la base de datos
  • Failure History Lifetime: es un valor numérico en minutos que indica el tiempo en que cada registro de la tabla cron_schedule fueron ejecutados fallidos y se mantendrán en la base de datos
  • Use Separate Process: esta bandera de configuración solo le indicara a los procesos en ejecución si especialmente este grupo de tareas deben ejecutarse en un proceso separado de la linea de ejecución de los registros de la tabla cron_schedule
• <job> : este nodo indica cada uno de los trabajos o tareas programadas aquí pueden ir tantos nodos se requiera cada uno representara a un registro en la tabla cron_schedule este nodo requiere principalmente de tres atributos que listare a continuación:
  • name: Es el nombre que representara a la tarea, este debe ser único dentro del grupo, incluso es el valor del campo de la columna job_code de la tabla cron_schedule así es como podrías identificar que esta dado de alta en la tabla de cron de Magento.
  • instance: Este valor es el nombre de la clase que debe instan ciar la tarea que se esta registrando como el indicativo de cual es la clase creada específicamente para esa tarea, la ruta es sencilla de entender primero indica el nombre de la carpeta o espacio de nombre, seguido de el nombre del modulo posterior el nombre de la carpeta Model y dentro se encontrara la clase Cron.php esto no es restrictivo ya que el usuario pudiera ubicarlo en cualquier parte de su modulo la idea es seguir las recomendaciones de Magento para cumplir con las buenas practicas de desarrollo y facilitar la búsqueda de futuros programadores.
  • method: Y finalmente en conjunto con el parámetro anterior este indicara cual es el método que se mandara a llamar una vez ubicada la instancia de la clase.

  Finalmente dentro del nodo job se encontrara el nodo:

• <schedule>: que indica el tiempo de ejecución de la tarea registrada, utilizando la misma expresión de tiempo registradas en las tareas programadas de los registros crontab del sistema operativo esta definido por 5 parámetros y como valor por defecto se puede colocar un asterisco por poner un ejemplo indicare una configuración que se ejecute cada 2 minutos se representaría de esta forma: ( */2 * * * *), como esta integrado esto pues bien:
  • * : el primer asterisco define a los minutos es por ello que colocando */2 indicaría cada 2 minutos esta valor solo puede ir de 0 a 59 específicamente a los 60 minutos existentes.
  • * : el segundo asteriscos indicara las horas, este valor solo puede ir de 0 a 23 indicando a las 24hrs que tiene el día.
  • * : el tercer asterisco indicara los días de un mes este valor solo puede ir de 1 a 31 indicando los 31 días máximo que pueden existir en un mes.
  • * : el cuarto asterisco indicara los meses del año su valor puede ir de 1 a 12 representando a los 12 meses del año que va de enero a diciembre.
  • * : el quinto asterisco indicara los días de la semana su valor puede ir de 0 a 6, que va de Domingo a Sábado donde cero es para el Domingo y 6 para Sábado.

Vamos a desarrollar la clase que se ha especificado en el archivo crontab.xml ya creado lo primero es en donde debemos crear esa clase cual es su objetivo y acciones finales.

Como se pudo observar en el archivo XML en el parámetro instance indica en que parte debemos crear la clase llamada Cron.php.

Continuando con el ejercicio del ejemplo, en el que contemos con un modulo básico vamos a definir donde debería crearse la clase necesaria.

• Ruta de creación: Marcgento\Crones\Model\Cron.php
• Metodo de la clase: cronEjemplo

_logger = $logger;
     }

     public function cronEjemplo()
     {
	$this->_logger->info('Mi primer ejemplo de Cron en Magento 2');
	return $this;
     }
}

Con la clase anterior Cron.php y el XML crontab.xml creo que empieza a tener sentido esto de las tareas programadas en Magento 2, que estará pasando a este punto de lo ya implementado, pues bien es algo muy básico que si en este momento damos de alta en el modulo básico los archivos ya definidos y ejecutáramos el comando de la CLI de Magento 2 php bin/magento cron:run estaríamos realizando un par de cosas, so tomaría nuestro archivo XML crontab.xml agregaría sus primeros registros en la tabla cron_schedule y pasado los 2 minutos se ejecutaría la Clase Cron.php específicamente el Método cronEjemplo() de la clase e iría registrando en un log el mensaje ‘Mi primer ejemplo de Cron en Magento 2’ y todo hace sentido así hasta que cambiemos el tiempo de ejecución del cron.

Pasemos a la parte en la que vamos a probar la ejecución de nuestro comando desde la consola de Magento 2 la llamada CLI que es una herramienta que facilita muchas de las tareas en Magento 2, basta con revisar el comando php bin/magento cron:run nos tenemos que colocar en la raíz de nuestro proyecto de Magento y ejecutar el comando tal cual, lo que sucederá aquí al ejecutar el comando es que se debe generar un nuevo registro en la tabla cron_schedule así como se muestra en la siguiente imagen:

Ten en cuenta que debes ser paciente cuando ejecutas este comando desde la linea de comandos de tu equipo local, puede ser que le ejecutas y si haces una consulta en la tabla cron_schedule no veas ningún registro, no te preocupes espera unos segundos mas y vuelve a ejecutar nuevamente el comando, incluso puede ocurrir, que si se logren agregan nuevos registros, pero que al buscar el de tu modulo recién creado no se muestren para lo cual debes volver a intentar ejecutar el comando y volver a validar si ya pinta tu nuevo cron dentro de la tabla cron_schedule, y no debes preocuparte por la tabla cron_schedule cuando nos encontramos desarrollando nuestro proyecto es muy común truncar esta tabla y esperar que sean cargados nuevamente los registros de las tareas programadas, recuerda que esta es como una tabla de registros temporales se dan de alta nuevos registros esperando cumplir su ciclo de vida y en el futuro automáticamente serán eliminados y agregados nuevos, su finalidad es una tabla de apilamiento de tareas programadas del lado de Magento esperando siendo ejecutadas.

Si has seguido este curso hasta el punto 2 del listado de secciones creo que ya sabes mucho sobre el desarrollo de Cron Jobs en Magento 2, pero ahora como punto final voy a mostrarte como puedes crear tus propias agrupaciones, es algo muy sencillo y se trata simplemente de hacer un archivo de configuración XML que te permitirá por un lado crear una nueva sección en las agrupaciones nativas de Magento dentro del BackEnd y segundo poderla utilizar para asignarla a tus propias creaciones de crons de tus módulos.

Antes de pasar a la creación del archivo XML quiero que se entienda esto de los grupos, para que sirve cual es su finalidad y donde los encontramos por que Magento no hace las cosas al ahí se va, entendamos que son desarrolladores como nosotros haciendo cosas para desarrolladores así que por algo lo crearon así para facilitarnos la forma de desarrollar en su plataforma.

Primero te vuelvo a mostrar esta imagen:

Como puedes vera estas son algunas agrupaciones que ya estas definidas en la plataforma de Magento y alguna por ahí que se genero una con un componente de terceros de pago como lo es mailchip y una mas propia customizada.

Para entenderlo de la forma mas sencilla digamos que tenemos 300 tareas programadas en nuestra tienda Magento algunas nativas de la plataforma y muchas de nosotros de nuestros propios componentes que pasaría si no estuvieran estas agrupaciones, no habría manera de clasificarlas o catalogarlas, que pasaría si solo necesito saber de un par de tareas especificas saber si están funcionando y que esta pasando con ellas, pues bien aquí es donde realmente hace sentido el agrupamiento que incluso la consola CLI de Magento de la que en ocasiones hemos hablado nos permite poder ejecutar las tareas por grupos, así que si genero mi propio grupo para colocar ahí todas las tareas de mi empresa pues al final podría solo estar monitoreando y ejecutando solo ese grupo sin afectar al resto de grupos, si lo vemos desde ese punto creo que es una tremenda ayuda para nosotros los desarrolladores y administradores de un ecommerce con estas capacidades.

app/code/Marcgento/Crones/ crearemos el XML cron_groups.xml dentro de la carpeta etc quedando de esta forma app/code/Marcgento/Crones/etc/cron_groups.xml

	
		1
		4
		2
		10
		60
		600
		1
	

Lo que podemos ver aquí es lo que ya habíamos explicado en la sección 1 Creando el archivo XML crontab.xml de lado de Magento 2, ahí podrás ver que significada cada nodo dentro del nodo <group> pero como puedes ver es bastante sencillo:

• <config>: es el nodo raíz con sus respectivas definiciones también ya comentado.
• <group>: solo recibe un atributo id y este es para darle un nombre identificador que sera el que utilizaremos para la definición de agrupamiento y id de nuestros archivos crontab.xml.

Para el resto de nodos ya se han explicado en la Sección 1 solo mencionar que los valores que se da a cada uno, serán los valores por default que se aplicaran al crear el grupo.

Una vez creado el archivo XML en la ruta indicada solo basta con limpiar la cache de Magento, puedes hacerlo ejecutando el siguiente comando: php bin/magento c:f una vez ejecutado el comando desde la consola CLI de Magento podrás ver ya el nuevo grupo creado en la sección, es importante que veas que aun que es una sección de configuración para los cron este XML no depende del comando de ejecución de las tareas programadas, ahora lo que podrás ver es ya el nuevo grupo en la sección de Cron (Scheduled Tasks) marcgento_crones_tareas: