Ce site a été réalisé à des fins pédagogiques dans le cadre du cursus Bachelor de l’école HETIC. Les contenus présentés n'ont pas fait l'objet d'une demande de droit d'utilisation. Ce site ne sera en aucun cas exploité à des fins commerciales.
Notre application côté back, se présente comme une API. Nous avons décidé de séparer la partie client et serveur,
pour permettre une plus grande malléabilité, si jamais nous devons changer la technologie front-end ou back-end.
Pour gérer les connexions, nous avons utilisé les JWT Tokens pour permettre aux utilisateurs de se connecter et d'avoir accès
aux routes dédiées à leur groupe respectif. Pour des soucis de sécurité, le token expire toutes les 15 minutes et nécessite
un rafraichissement (refresh_token). Ce rafraichissement renverra un nouveau token JWT ainsi qu'un tout nouveau refresh token.
Nous avons créé la base de données à partir de l'outil CLI de Symfony étant donné que sur un projet précédent, nous avions
mappé notre base de données sur notre projet, ce qui nous avait généré de multiples problèmes à l'époque, sur les Entités notamment.
Nous avons dû mettre en place des routines (CRON), qui permettent de vérifier à des instants précis plusieurs états
de nos datas, via les commandes custom Symfony. Voir CRON Symfony commands !
La commande app:simulateMesure est une commande qui ne devrait pas exister dans un vrai projet, elle est ici pour simuler les données
que devrait renvoyer le dispositif (Agora) installé dans les foyers.
Concernant la partie de développement, nous avons intégré des tests permettant de vérifier que les routes fonctionnent bien,
couplé à un Git hook de pre-commit, qui run les tests avant chaque commit et bloque potentiellement le commit si les tests ne sont
pas concluants. Cela permet de savoir si le code modifié impacte ou non les routes existantes.
Au niveau de la génération de fausses données, Faker a été l'outil de fixtures que nous avons utilisé. Il nous a permis de générer avec aise, une grande quantité de données sans faire trop d'effort.
Cette fois-ci, nous voulions générer notre documentation quasiment automatiquement, c'est pourquoi nous avons installé et utilisé
Swagger (Open API) sur notre projet. À l'aide d'annotations, il nous est donc possible de détailler les spécifications de nos routes et entités,
tout cela grâce à un fichier JSON que nous générons à partir d'une commande.
En terme d'hébergement, nous avons décidé d'utiliser Heroku. Heroku nous permet à l'aide de JawsDB de mettre facilement en place
la base de données MySQL et de push rapidement notre projet en production. En plus de ça, nous avons un nom de domaine
assigné par Heroku qui permet au client de notre application d'avoir une adresse de l'API qui ne change pas, peu importe
le redémarrage du serveur.
Pour faciliter l'exécution de commandes répétitives, nous avons mis en place une Makefile permettant de raccourcir les
commandes les fastidieuses à écrire à la main.
Visit the documentation at route: Agora-API.
After cloning the project, go to the root of the project and create a .env.local file:
touch .env.localIn .env.local add these lines and make changes according to your configuration:
APP_ENV=dev
DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/agoraDb?serverVersion=5.7
CORS_ALLOW_ORIGIN=^https?://(localhost|127\.0\.0\.1)(:[0-9]+)?$Then, install dependencies:
composer installmake installCreate the Database:
./bin/console doctrine:database:createmake db-createExecute the last migration:
./bin/console doctrine:migration:migratemake db-migrationPopulate database with fixtures:
./bin/console doctrine:fixtures:loadmake db-fixtureLaunch the server:
symfony server:startmake startStop the server:
make stopFirst create the JWT Folder in config folder:
mkdir -p config/jwtThen, generate your .pem keys according to your JWT_PASSPHRASE located in .env, ie, when you will have to enter the passphrase enter the same value as the JWT_PASSPHRASE:
openssl genrsa -out config/jwt/private.pem -aes256 4096Same for this command:
openssl rsa -pubout -in config/jwt/private.pem -out config/jwt/public.pemNow, if you try to login as an existing user like so:
http POST localhost:8000/api/login username=aymeric.mayeux@hetic.net password=azertycurl -X POST -H "Content-Type: application/json" localhost:8000/api/login -d '{"username": "aymeric.mayeux@hetic.net", "password": "azerty"}'You will retrieve the JWT Token and the refresh Token:
{
"user": {
"id": 1,
"...": "..."
},
"tokens": {
"token": "eyJ0eXAi...",
"refresh_token": "337bb346 ..."
}
}With this JWT Token, you can now make request on routes /api of the application. You need to put the token in your Headers every time you want to make a request.
http --auth-type=jwt --auth="eyJ0eXAi..." localhost:8000/api/admin/userscurl -X GET localhost:8000/api/admin/users -H "Authorization: BEARER eyJ0eXAi..."Your JWT Token is set to expire at a certain time that is set in config/packages/lexik_jwt_authentication.yaml:
# Unit is in second. So 900 seconds.
token_ttl: 900If your JWT Token expire, you will need to re-generate a new one with the second token provided when you login, called refresh_token, the refresh_token can only be used once, but everytime you request a new JWT Token you will get a new refresh_token as well:
{
"refresh_token": "b1ca3f...",
"token": "eyJ0eXAi..."
}Retrieve a new valid JWT Token:
http POST localhost:8000/api/token/refresh refresh_token=b1ca3f...curl -X POST -H "Content-Type: application/json" localhost:8000/api/token/refresh -d '{"refresh_token": "b1ca3f..."}'With this new token, you will be able to fetch data from the API again.
Run:
crontab -eadd the following line and change <PATH_TO_PROJECT> to your project PATH:
*/15 * * * * cd ~/<PATH_TO_PROJECT>/agora-api && ./bash_scripts/launch-schedule.sh >> /dev/null 2>&1You do not know anything about CRON? Click here!
Open folder containing cron binary file:
open /usr/sbin-
Go to your System Settings > Security & Privacy > Disk access
-
Click on the lock at the bottom left corner and enter your password
-
Drag and drop the
cronbinary file into your System Settings Window. -
Cross the checkbox next to it.
Then it should fix the permission problem.
| NAME | DESCRIPTION | File | Time |
|---|---|---|---|
| app:newMonth | Creates a new month and new tasks for each user at the beginning of each month | src/Command/NewMonthCommand.php |
0 0 1 * * |
| app:simulateMesure | Simulates every 30 minutes the measurements for each user and check if their task is still valid | src/Command/SimulateAgoraMesureCommand.php |
*/30 * * * * |
| app:resetLevel | Every January 1st of each year resets the user level to 0 | src/Command/ReseyAllUserLevelCommand.php |
0 0 1 1 * |
Current hook will run all tests at every commit. The server must be running to perform tests.
./bash_scripts/install-hooks.shCreate a .env.test file and change db_user and db_password:
# define your env variables for the test env here
KERNEL_CLASS='App\Kernel'
APP_SECRET='$ecretf0rt3st'
SYMFONY_DEPRECATIONS_HELPER=999999
PANTHER_APP_ENV=panther
DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/agoraDbTest?serverVersion=5.7
JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private-test.pem
JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public-test.pem
JWT_PASSPHRASE=agoratestPrefix the following names with make:
| NAME | DESCRIPTION |
|---|---|
| start | Start the server |
| stop | Stop the server |
| cc | Clear the cache |
| router | List all routes |
| log | Display server logs |
| test | Run all tests |
| test-file | Run a specific test file that user enter. Example: UserTest |
| install | Install dependencies |
| db-create | Create the database |
| db-migration | Launch migrations |
| db-fixture | Load fixtures |
| db-update | Run db-migration and db-fixture |
| swagger | Update swagger documentation |
| NAME | ROLE |
|---|---|
| Virgil Caffier | Designer |
| Emilie Tombouyses | Front-end |
| Virgil Limongi | Front-end |
| Tristan Lemire | Back-end |
| Kento Monthubert | Back-end |
