Problema con detección de inconsistencias en MyQuill

irenelab

Hola a todos,

Estoy teniendo un problema un poco raro con el módulo MyQuill en mi tienda PrestaShop 1.7.1.2. He notado que el Gestor de Módulos nunca me avisa de posibles inconsistencias con MyQuill, aunque yo sé que a veces me faltan archivos o he modificado algo mal.

Investigando un poco, he visto que en el archivo myquill/myquill.php hay una función inconsistency que parece ser la culpable. Siempre devuelve true, y me imagino que por eso el Gestor de Módulos cree que todo está perfecto.

Aquí tenéis el fragmento de código que encontré:

function inconsistency($ret = null)
    {
        return true;
    }

¿Alguien sabe cómo debería ser esta función para que realmente detecte si falta algo o hay algún problema? O es que se usa de otra manera? ¡Cualquier ayuda es bienvenida!

miguel_deco50

Hola @irenelab, eso es un clásico. Muchas veces los desarrolladores de módulos dejan esa función con un return true; por defecto o una implementación muy básica para pasar el control de PrestaShop. En tu versión de PrestaShop 1.7.1.2, esta función es clave para que el Back Office te alerte de posibles fallos en el módulo.

Sin una lógica real dentro, el sistema asume que el módulo está siempre "consistente", incluso si le faltan archivos css o js, o si alguna dependencia no está.

Para que sea útil, esa función debería comprobar la existencia de archivos críticos, permisos, o incluso algunas tablas de base de datos que el módulo necesite. Tal cual está, no va a detectar nada.

mariobici

Confirmo lo que dice @miguel_deco50. Me ha pasado con otros módulos, que el método inconsistency era prácticamente inútil. En mi caso, era un módulo de sincronización y me causó bastantes dolores de cabeza porque no me avisaba de errores de configuración hasta que la tienda dejaba de sincronizar.

Para el editor, podrías empezar por comprobar si los archivos principales del editor, como los JS o CSS de Quill, existen en las rutas esperadas. Eso ya sería un buen punto de partida para que la función sea un poco más inteligente y no devuelva siempre true.

Milo

Hola @irenelab, el problema que describes es bastante común en módulos que no implementan una lógica robusta en el método inconsistency(). Como bien han señalado @miguel_deco50 y @mariobici, un simple return true; inutiliza completamente la capacidad del Gestor de Módulos para informarte sobre posibles problemas.

En PrestaShop 1.7.1.2, esta función se ejecuta durante la verificación del módulo y es fundamental para la estabilidad. Para que funcione correctamente, debe verificar la existencia de los archivos clave del módulo. Aquí te propongo una modificación básica que puedes aplicar en myquill/myquill.php. Esta versión comprobará si el archivo principal de JavaScript del editor Quill existe:

function inconsistency($ret = null)
    {
        $editorFilePath = _PS_MODULE_DIR_ . $this->name . '/views/js/quill.min.js';
        if (!file_exists($editorFilePath)) {
            return 'Falta el archivo principal de Quill: ' . $editorFilePath;
        }
        return true;
    }

He añadido una comprobación simple para un archivo JS crítico. Si el archivo quill.min.js no se encuentra, la función devolverá un mensaje de error legible en lugar de true. Esto hará que el Gestor de Módulos te muestre una advertencia.

Ten en cuenta que esta es una solución básica. Para una gestión más completa y mantenible de un editor visual moderno Quill, siempre es más recomendable usar la versión oficial del módulo que ya incluye estas comprobaciones y está diseñada para funcionar sin conflictos ni parches manuales.

irenelab

¡Muchísimas gracias, @Milo! Acabo de aplicar tu código en myquill.php y, efectivamente, ahora el Gestor de Módulos me ha avisado de que me faltaba ese archivo de Quill que mencionaste. ¡Qué alivio saber que ahora puedo detectar estos problemas!

De verdad, me has salvado de un problema mayor en el futuro. Voy a considerar seriamente lo de la versión oficial para evitar estos parches. ¡Gracias de nuevo!