annaigjegourel / oc-p7-bilemo Goto Github PK

Install & Config Hateoas & JMS:

• Install Hateoas bundle
  https://github.com/willdurand/Hateoas
  https://github.com/willdurand/BazingaHateoasBundle
• Config JMSSerializer (replace Symfony Serializer) - NO: TRY WITHOUT JMS SERIALIZER - impossible: is required:
  https://github.com/willdurand/BazingaHateoasBundle/blob/master/Resources/doc/index.md

• Config jms

Update Controllers:

• Use JMSSerializerInterface & not Sf serializer in PhoneController
• Use JMSSerializerInterface & not Sf serializer in UserController
• Add context in functions + use JMS context in UserController

Update Entities:

• Use JMS\Serializer\Annotation\Groups instead of Symfony\Component\Serializer\Annotation\Groups in User Entity
• Same in Customer Entity
• Test in postman

Add links :

• Add links & use Hateoas to entity Phone
• Add links & use Hateoas to entity User

Add embedded? NO use here.

• Install Nelmio
• Config Nelmio: path in config/routes & config/packages/security
• Install Asset component & Twig extra bundle: composer require twig asset

Improvements:

• Config Nelmio with JWT to test routes
• Use Nelmio in PhoneController & comment methods to improve infos: specify page, element quantity
• same in UserController
• Write best messages & examples for UX

Add cache in PhoneController::getAllPhones()

• Use Sf cache component
• Add cache id & tag in getAllPhones()
• Add expire time

Add cache in UserController::getCustomerUsersList

• Use Sf cache component
• Add cache id & tag in getCustomerUsersList()
• Lazy loading: Serialize inside cache function OR Add Fetch mode EAGER in UserRepository
• Add refresh time

Add cache in other CRUD methods of UserController

• Use cache->invalidateTags() in deleteUser(), createUser(), updateUser()

Code style

• Improve code following Codacy

• Use case diagram
• Sequence diagram
• Class diagram

Improvements:

• Improve UML diagrams
• Doc: improve @OA annotations & make them consistent
• See also UserRepository: setpassword: Using wrong arguments / calling wrong class for upgradePassword()
  UserRepository::upgradePassword::$user->setPassword() unknown (use Entity/User instead of interface?)
• Add customer condition to User CRUD: isGranted? checkCustomer()? voters?
  https://symfony.com/doc/current/security/voters.html

Review code style:

• CodeClimate : Too much arguments and/or lines in some functions?
• use PHP-CSfixer?
  https://cs.symfony.com

• Install Symfony Validator
• Add Validator & Assert to User Entity
• Add Validation to UserController

https://symfony.com/doc/current/validation.html

Presentation:

• Make PPT
• Prepare demo & explanations
• Make & send deliverables
• Deploy app on line with Heroku?

Codacy

• Set Codacy ignoring basic Sf files

PHPstan

• Install PHPStan
• Set & run PHPstan analysis
• Test highest level
• Fix issues (2 left)

CodeClimate

• See also CodeClimate: maintainability B->A

Code

• Fix issues & disable useless patterns to get better badges

• Create deleteUser()
• Create createUser()
• Update createUser() creating id automatically
• Update createUser() creating customer (adding idCustomer)
• Update createUser() hashing password
• Create updateUser()

• install security bundle
• create User
• create entity Customer (relation to User)
• update AppFixtures adding Customer, admin & users
• create UserController
• update UserController making getAllUsers($customer) using argument

Fix

• fix circular reference adding group 'getUsers' to getAllUsers()
• admin fixture: remove

• Install Maker bundle
• Install Doctrine ORM
• Create Entity Phone
• [local] Create database, config .env.local, migrate entity

• Add requirements to POST, PUT, PATCH (username, password?)
• Add body to POST, PUT, PATCH (json)
• * require="", body...

• Create ExceptionSubscriber

Phones pagination:

• Create function findAllWithPagintation ($page, $limit) in PhoneRepository
• Use findAllWithPagination() & request page & limit from url in PhoneController::getAllPhones
• Test with Postman

Users pagination:

• Create findByCustomerPagin($idCustomer, $page, $limit) in UserRepository
• Use findByCustomerPagin() & request in UserController::getCustomerUsersList()
• Test with Postman

• Install Doctrine fixtures bundle
• Add content in AppFixtures.php
• Migrate to db
• Create PR, link to issue & merge to main

• Create local & distant repositories
• Add ReadMe
• Add Codacy & CodeClimate badges
• Add License
• Create issues
• Fix first issues following Codacy & VSCode

Debug

• Install Symfony debug bundle (including monolog & web profiler)
• (add debug mode to ExceptionSubscriber) OR #[When: env=prod]

Fix routes / methods

• Update POST (add conditions/ see pwd problem)
• Fix PUT saving every element
• Update PATCH (2 problems due to JMS serializer) & add Hateoas relation to entity... or delete this function?)

See also password problem:

• PATCH PUT POST -> error 500 "undefined array key password"
• Make it mandatory (like e-mail)

• Choose "Response" or "JsonResponse"
• Create Homepage
• Comment all functions
• Comment all variables
• PHPStan: Comment & fix
• Codacy: Enable comments patterns on Codacy & check
• Codacy: Check & fix
• PHPstan Entity/User.php::$roles type ??
  https://phpstan.org/blog/solving-phpstan-no-value-type-specified-in-iterable-type
• UserController::createUser() - > persist role (default: User) in db
• CodeClimate: refactoring Repos??
• Codacy: vérifier erreurs restantes & disabled patterns

Following Symfony best practices:
https://symfony.com/doc/current/best_practices.html
Symfony standards & PHP CS fixer:
https://symfony.com/doc/current/contributing/code/standards.html
See adr pattern (for apis)?

• Create PhoneController & test /api/phones with Postman
• Install Serializer
• Update getAllPhones() with Serializer
• Create getDetailsPhone()

https://github.com/lexik/LexikJWTAuthenticationBundle

• install JWT
• create config/jwt/ & both keys
• config JWT: security.yaml, .env.local, routes.yaml
• test: login_check to get token, 401 unauthorized without JWT, CRUD ok with JWT