Ejemplo de aplicación de consola basada en TeqFW

Fecha de publicación: 2024-06-05

Este proyecto pequeño pero operativo es una aplicación de consola para la tienda autobalta.com. Cada día, mediante cron, elimina de la base datos de intercambio obsoletos con sistemas externos y sesiones antiguas de usuarios.

Limpia las tablas oc_latakko_api_log, oc_latakko_api_queue, oc_latakko_log y oc_session.

`package.json`

TeqFW vive en el ecosistema npm/Node.js, por lo que la aplicación comienza en package.json. "type": "module" activa módulos ES: no necesita TypeScript ni transpilación. Las versiones de plataforma se fijan para que la instalación sea reproducible:

{
  "type": "module",
  "dependencies": {
    "@teqfw/core": "0.24.0",
    "@teqfw/db": "0.21.0",
    "@teqfw/di": "0.22.0",
    "mysql": "^2.18.1"
  },
  "scripts": { "start": "node ./bin/tequila.mjs app-clean" }
}

@teqfw/di carga módulos ES, crea objetos singleton y transitorios e inyecta dependencias;
@teqfw/core define reglas de identificadores y conecta con commander;
@teqfw/db ofrece acceso uniforme a bases relacionales sobre Knex.js;
mysql es el driver MySQL/MariaDB.

Se ejecuta con el habitual npm start.

Launcher común

bin/tequila.mjs es igual para las aplicaciones backend TeqFW: encuentra la raíz del proyecto y se la entrega al núcleo.
import { dirname, join } from 'node:path';
import { fileURLToPath } from 'node:url';
import teq from '@teqfw/core';

const path = join(dirname(fileURLToPath(import.meta.url)), '..');
teq({ path }).catch(console.error);

El núcleo examina node_modules, descubre plugins Teq, configura el contenedor y compone los comandos CLI.

`teqfw.json` y configuración

Un plugin Teq es un paquete npm normal con el descriptor teqfw.json. La aplicación declara su namespace, ruta de fuentes y el comando que añade:

{
  "@teqfw/di": { "autoload": { "ns": "Ab_Clean", "path": "./src" } },
  "@teqfw/core": { "commands": ["Ab_Clean_Back_Cli_Clean"] }
}

El archivo único cfg/local.json contiene configuración de todos los plugins. Aquí @teqfw/db recibe parámetros de Knex.js y conexión MySQL. Los secretos quedan en configuración local no publicada.

El comando `app-clean`

El comando se describe con prefijo (realm), nombre, descripción y acción. El prefijo app lo separa de los comandos de otros plugins:

const command = fCommand.create();
command.realm = 'app';
command.name = 'clean';
command.desc = 'Clean up expired data.';
command.action = action;

Así ./bin/tequila.mjs app-clean invoca la función de limpieza.

Base de datos

@teqfw/db describe las tablas usadas en módulos de esquema y ofrece la conexión TeqFw_Db_Back_RDb_IConnect junto al motor CRUD TeqFw_Db_Back_Api_RDb_CrudEngine. El patrón usa siempre una transacción:
const trx = await conn.startTransaction();
try {
  // Read or change data.
  await trx.commit();
} catch (error) {
  await trx.rollback();
  throw error;
} finally {
  await conn.disconnect();
}

Por ejemplo, para borrar sesiones de más de 45 días se pasan al CRUD la transacción, metadatos de tabla y condición:

const date = util.formatDate(util.subtractDays(45));
const rows = await crud.deleteSet(trx, rdbSession, function () {
  this.where(A_SESS.EXPIRE, '<', date);
});
logger.info(`Total '${rows}' sessions were deleted.`);

Conclusión

Este ejemplo muestra cómo TeqFW compone una tarea Node.js con módulos: los plugins declaran capacidades, el contenedor enlaza objetos al arrancar y el comando CLI realiza una operación de negocio clara. La estructura encaja bien en trabajos programados, integraciones y utilidades de servicio donde importan aislamiento, pruebas y evolución controlada del código.

package.json