DocumentationCommerceManuel d’implémentation

Bonnes pratiques relatives à la révision du code pour Adobe Commerce

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Expérimenté
  • Développeur

L’objectif principal de l’examen du code est de vérifier que les fonctionnalités mises en oeuvre répondent aux exigences de manière optimale, du point de vue des performances, de l’architecture et de la sécurité.

En outre, la révision du code est destinée à s’assurer que le code respecte les bonnes pratiques de développement d’Adobe Commerce, qu’il est facile à comprendre et à gérer et qu’il respecte les normes de codage. La plupart des normes de codage doivent être vérifiées automatiquement par les outils appropriés.

Processus recommandé de révision du code

À un niveau général, le processus de révision du code doit se composer des étapes suivantes :

  1. Branche des fonctionnalités de passage en caisse dans un environnement de développement local.
  2. S’il s’est écoulé un certain temps depuis que le code a été soumis pour révision, fusionnez les dernières modifications de la branche cible (généralement la branche AQ) et envoyez les mises à jour à la branche de fonctionnalités distantes (le cas échéant).
  3. Effectuez une révision de haut niveau pour vérifier que le code met en oeuvre toutes les exigences. En cas d’incohérences majeures, contactez le développeur pour obtenir des éclaircissements.
  4. L’exécution du code est facultative, mais si vous doutez que le code fonctionne comme prévu ou s’il facilite l’efficacité du processus, vérifiez que la fonctionnalité mise en oeuvre fonctionne comme prévu pour les scénarios d’utilisation principaux. En cas de problèmes majeurs, arrêtez le processus de révision, puis rouvrez le ticket avec les commentaires appropriés.
  5. Effectuez une révision approfondie pour vérifier que le code met en oeuvre toutes les exigences. En cas de problème, ajoutez les commentaires appropriés à la demande d’extraction et rouvrez le ticket.
  6. Si tout semble correct, fusionnez la requête de tirage (ou transmettez-la au niveau de révision du code suivant si celui-ci a été établi).

Tenez également compte des points suivants lors de l’implémentation des processus de révision du code :

  • L’examen du code est un outil principal de communication et de transfert des connaissances au sein d’une équipe. Même si une requête de tirage ne contient pas de problèmes majeurs et implémente la logique métier requise, vous pouvez l’utiliser comme une opportunité pour suggérer d’autres améliorations après sa fusion.

  • En moyenne, l’examen du code ne devrait pas prendre plus de 10 à 20 % de l’effort de développement. Cela suppose que l'équipe de développement soit composée d'ingénieurs de haut niveau qui travaillent bien ensemble. Si la révision du code prend plus de temps, elle peut affecter le budget et la chronologie du projet.

  • Résolvez les problèmes avec un effort excessif requis pour les révisions du code en identifiant la cause principale. En général, c'est parce que les exigences sont mal traduites en billets de développement (en raison de problèmes de communication, d'histoires d'utilisateurs médiocres) ou parce que c'est un problème de coaching. Dans le premier cas, la limitation recommandée consiste à s’assurer que les billets disposent de suffisamment d’informations pour que les membres de l’équipe puissent satisfaire efficacement aux exigences. Dans le deuxième cas, vous devrez peut-être ajuster la structure de l’équipe pour inclure plus d’ingénieurs expérimentés ou obtenir l’approbation en dehors du tutorat et de l’encadrement.

Produits et versions concernés

Toutes les versions prises en charge de :

  • Adobe Commerce sur l’infrastructure cloud
  • Adobe Commerce sur site

Que rechercher dans la révision du code

Style

Le style peut être testé automatiquement en exécutant l’inspection PhpStorm (voir ci-dessous).

Veillez à configurer PHPMD et PHPCS et à exécuter l’outil Coding Standard à partir de l’interface de ligne de commande (également ci-dessous). Il existe un certain chevauchement, mais les deux présentent également des tests uniques.

Convention et structure

Les révisions des conventions et de la structure sont effectuées manuellement.

  • La fonctionnalité de classe est-elle limitée à une seule responsabilité ?
  • La structure de répertoires a-t-elle un sens ?
  • Fonctionnalités exécutées au bon niveau (serveur, client, CSS, JS, base de données, structure, infrastructure).
  • Le contrôle de version est-il correct ?
  • Le code a-t-il l’air non conventionnel ou est-il en train d’essayer de contourner un problème de la mauvaise manière ?
  • La convention d’affectation des noms pour le nom du module, le nom du module et le nom du référentiel est-elle correctement appliquée ?
  • Vérifiez que les styles CSS globaux sont appliqués de manière réfléchie et qu’ils ne sont pas surutilisés.

Complétude

Les révisions pour l’exhaustivité sont effectuées manuellement.

  • Le code peut-il être activé ou désactivé par la configuration et tout le code nécessaire se comporte-t-il comme prévu ?
  • Est-ce que toute la configuration mentionnée dans le ticket est présente ? Vérifiez la portée, le type de données, la validation, la traduction et les valeurs par défaut.
  • La configuration est-elle toujours récupérée au niveau le plus bas possible (niveau d’affichage de la boutique, niveau du site web ou niveau global) ? La récupération de la configuration doit correspondre à la définition de la portée dans le fichier system.xml.
  • Tous les chemins dans le diagramme de flux de la spécification technique sont-ils pris en compte ? Toutes les autres spécifications techniques sont-elles couvertes ?
  • Les listes de contrôle d’accès sont-elles définies pour la nouvelle fonctionnalité ?
  • PhpDocs est-il clair ? Les messages de validation sont-ils clairs ?
  • Le code est-il commenté ou le code de débogage s’affiche-t-il ?

Performances

Les révisions des performances sont effectuées manuellement, ce qui peut être aidé par l’exécution du code en cas de doute.

  • Les requêtes sont-elles exécutées dans une boucle ? Cette boucle peut se trouver en dehors des fichiers modifiés.
  • Pouvez-vous repérer n’importe quel attribut cachable="false" ? Sont-elles correctement appliquées ?

Sécurité

Les révisions pour la sécurité sont effectuées manuellement, ce qui peut être aidé par la recherche de texte. Une partie de la vérification de sécurité est gérée par des tests automatisés.

  • Les exceptions sont-elles consignées si nécessaire ? Les types d’exceptions appropriés sont-ils utilisés ?
  • Les modules externes around peuvent-ils être évités ?
  • Les modules externes renvoient-ils les types de données corrects ?
  • Pouvez-vous trouver des requêtes SQL brutes qui doivent être créées à l’aide de la couche d’abstraction de base de données ?
  • Un nouveau type de données est-il exposé à tout type d’utilisateur, d’administrateur ou de frontal ? Cette exposition présente-t-elle un risque pour la sécurité ?
  • Les données générées par l’utilisateur sont-elles validées ? Tout ce qui provient du navigateur est considéré comme généré par l’utilisateur, y compris les valeurs de cookie et les en-têtes de serveur.

Confidentialité et RGPD

Les révisions pour la confidentialité et le RGPD sont effectuées manuellement.

  • Le code traite-t-il les données ou les e-mails des clients ? Faites attention.
  • Si ce code peut être exécuté dans une boucle, peut-il laisser passer les données client d’un cycle de boucle à un autre ?
  • Les indicateurs d’un risque sont les imports, les traitements cron, les emails transactionnels et les gestionnaires de file d’attente par lots.
  • Veillez à l’isolation des données utilisateur dans les boucles. Adobe conseille d’utiliser des usines ou des référentiels pour créer des modèles dans le cycle de boucle, qui ne sont pas accessibles en dehors de la boucle.

Mentorat

Les révisions pour le tutorat sont effectuées manuellement.

  • Recherchez des endroits où partager les connaissances dans le but d'éduquer l'équipe.
  • Si votre commentaire est purement éducatif, mais n’est pas essentiel pour répondre aux normes, indiquez qu’il n’est pas obligatoire pour l’auteur de le résoudre.
  • Si vous voyez quelque chose de bien, dites-le au développeur, en particulier quand il a très bien traité l'un de vos commentaires. Les examens de code se concentrent souvent sur les erreurs, mais ils devraient aussi encourager et apprécier les bonnes pratiques. C'est parfois encore plus précieux, en termes de tutorat, de dire à un développeur ce qu'il a fait de bien plutôt que de leur dire ce qu'il a fait de mal.

Automatisation

Les développeurs peuvent utiliser l’automatisation pour passer en revue la compilation d’ID, le schéma de base de données, la validation de compositeur et la conformité aux normes de codage :

  • Compilation d’ID : exécutez les commandes d’interface de ligne de commande suivantes pour voir si le code peut être compilé sans problème.

    code language-bash 
    bin/magento module:disable -n -q --all || exit;
bin/magento module:enable -n -q --all || exit;
bin/magento cache:enable -n -q || exit;
bin/magento cache:flush -n -q || exit;
rm -rf generated/*
rm -rf var/view_preprocessed/*
rm -rf pub/static/*
rm -rf var/cache/*
bin/magento deploy:mode:set --skip-compilation production || exit;
bin/magento setup:di:compile -vv || exit;
bin/magento setup:static-content:deploy en_US || exit;
bin/magento deploy:mode:set developer || exit;

  • Schéma de base de données whitelist.json : exécutez la commande d’interface de ligne de commande suivante et vérifiez que le fichier db_schema_whitelist.json n’a pas été ajouté ni modifié.

    code language-bash 
    bin/magento setup:db-declaration:generate-whitelist --module-name[=MODULE-NAME]

  • Composer validate : validez le fichier composer.json en exécutant la commande d’interface de ligne de commande suivante dans le répertoire contenant le fichier composer.json.

    code language-bash 
    composer validate

  • Coding standard : installez et exécutez l’outil Coding Standard et exécutez-le par rapport à votre module. Le fichier suivant montre comment l’exécuter n’importe où en tapant mcs ./app/code/Vendor/Module/.

    code language-bash 
    #!/usr/bin/env bash
$HOME/web/magento/magento-coding-standard/vendor/bin/phpcs --standard=Magento2 "$@"

  • Phpstan

    code language-bash 
    ./vendor/bin/phpstan analyze app/code/Vendor/Module

  • Inspection PhpStorm

  • Détecteur de copier/coller PHP PhpStorm

recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60