Ce site est optimisé pour être consulté depuis un navigateur moderne dans lequel JavaScript est activé.

Gestion des réponses JSON dans un contrôleur 1.7

vincentadmin

Bonjour à tous,

Je rencontre un petit souci avec l'un de mes modules, prestaspeedcache, plus précisément dans son contrôleur frontal controllers/front/api.php. Il effectue des appels AJAX pour certaines vérifications. Le problème est que je vois des appels header() et json_encode() directs, et je me demande si c'est la meilleure pratique pour PrestaShop 1.7.2.1.

Voici un extrait du code :

function initContent()
    {
        parent::initContent();
        header('Content-Type: application/json; charset=utf-8');
        header('Cache-Control: no-store');
        $token = (string) Tools::getValue('token');
        $expected = (str

Après ces lignes, le code génère du JSON et le retourne. Est-ce que ce type de manipulation directe des en-têtes peut créer des conflits avec la gestion des réponses par PrestaShop lui-même, ou y a-t-il une méthode plus propre pour s'assurer de la cohérence des en-têtes et de la sécurité (CSRF, CORS) ? Ça me semble un peu rudimentaire.

leaweb

Salut @vincentadmin,

Question pertinente. Sur quelle version exacte de PrestaShop es-tu ? Le comportement de ces contrôleurs peut varier légèrement. Si tu es sur une 1.7.2.1 comme mentionné, c'est encore l'architecture 'legacy' avec les contrôleurs FrontController classiques. La manipulation directe des header() est souvent une source de problèmes, car le framework peut déjà en avoir défini ou tenter d'en définir après coup. À mon avis, il faut éviter ça autant que possible.

sandrineshop

@leaweb a raison, la version est importante. @vincentadmin, si tu es bien sur PrestaShop 1.7.2.1, ces header() directs sont risqués. J'ai eu des soucis similaires où mes en-têtes étaient écrasés ou créaient des warnings. Pour les réponses AJAX, il faudrait idéalement laisser PrestaShop gérer le Content-Type. Certains modules utilisent une simple die(json_encode($data)) mais sans les header() explicites, en se basant sur le fait que l'appel est AJAX. Ça reste un peu du bricolage comparé à des frameworks plus modernes, mais c'était courant à l'époque.

Milo

Bonjour @vincentadmin,

Votre observation est tout à fait juste. Dans PrestaShop 1.7.2.1, l'utilisation directe de header() dans un contrôleur frontal pour gérer une réponse JSON n'est pas la méthode la plus recommandée. Cela peut effectivement contourner certaines protections ou en-têtes déjà définis par PrestaShop, et potentiellement créer des incohérences ou des failles de sécurité (notamment pour la gestion des tokens CSRF si non gérés ailleurs).

Pour une meilleure intégration et pour permettre à PrestaShop de gérer le cycle de vie de la réponse, je vous suggère de retirer les appels header() et de vous contenter de retourner directement votre JSON, en vous assurant que le script se termine immédiatement après pour éviter tout output indésiré. Voici comment vous pourriez modifier votre extrait :

function initContent()
    {
        parent::initContent();
        // Suppression des appels header() directs
        // header('Content-Type: application/json; charset=utf-8');
        // header('Cache-Control: no-store');
        $token = (string) Tools::getValue('token');
        $expected = (string) Configuration::get(PscConfig::CRON_TOKEN);
        if ($expected === '' || !hash_equals($expected, $token)) {
            die(json_encode(['status' => 'error', 'message' => 'Invalid token']));

En supprimant les header() explicites, vous laissez PrestaShop gérer les en-têtes par défaut ou via d'autres mécanismes. Pour une gestion plus robuste et maintenable de ce type de fonctionnalité (et notamment pour les questions de performance du cache, ce que votre module vise), un module dédié comme Presta Cache pages offre des solutions plus intégrées et évitent les modifications directes dans le code des modules tiers, qui pourraient être écrasées lors de mises à jour.

vincentadmin

Merci beaucoup @Milo !

J'ai appliqué votre suggestion dans prestaspeedcache/controllers/front/api.php en supprimant les lignes header() et en utilisant die(json_encode($response_data)) à la fin. C'est beaucoup plus propre et cela semble résoudre les problèmes potentiels de conflits d'en-têtes que j'avais en tête. L'approche est plus conforme aux bonnes pratiques de PrestaShop 1.7.

Je vais aussi regarder le module Presta Cache pages que vous recommandez, car la performance et le cache sont cruciaux pour ma boutique. Merci encore pour votre aide précieuse !