cnumr / ecoindex_bff Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 0.0 111 KB

Simple Back For Front project to interface with Ecoindex API and facilitate Badge status generation

License: MIT License

Dockerfile 1.15% Go 98.85%

ecoindex golang

ecoindex_bff's People

Contributors

Stargazers

Watchers

ecoindex_bff's Issues

[Enhancement]: Améliorer les retours de l'API - Aucune mesure disponible

Aucune mesure disponible pour https://www.yourdomain.tld

https://bff.ecoindex.fr/api/results/?url=https://novagaiaa.fr/test
L'API retourne une erreur 404, mais retourne un arbre de données vide.

{
  "count": 0,
  "latest-result": {
    "id": "",
    "grade": "",
    "score": 0,
    "date": "",
    "requests": 0,
    "size": 0,
    "nodes": 0,
    "url": "",
    "color": ""
  },
  "older-results": null,
  "host-results": null
}

Proposition

Utiliser le code 204
Ne pas retourner d'arbre vide, mais un message ;
Nombre de mesures restante pour ce domain pour cette journée.

{
  "code": 204,
  "message": "Aucune mesure disponible pour https://www.yourdomain.tld",
  "remaining-daily-requests": 4,
}

[Enhancement]: Améliorer les retours de l'API - Aucune mesure disponible pour la page

Aucune mesure disponible pour la page https://www.yourdomain.tld/test

https://bff.ecoindex.fr/api/results/?url=https://novagaia.fr/test
L'API retourne une erreur 200, mais retourne un latest-result vide.

{
  "count": 17,
  "latest-result": {
    "id": "",
    "grade": "",
    "score": 0,
    "date": "",
    "requests": 0,
    "size": 0,
    "nodes": 0,
    "url": "",
    "color": ""
  },
  "older-results": null,
  "host-results": [
    {
      "id": "46df881f-0cc3-4153-9fa9-871f65b22362",
      "grade": "B",
      "score": 74,
      "date": "2023-03-21T22:30:57",
      "requests": 39,
      "size": 1210.65,
      "nodes": 264,
      "url": "https://novagaia.fr/offres/creez-un-site-web-performant-et-moins-polluant/",
      "color": "#51B84B"
    },
    {
      "id": "430b0d3c-0bd2-4b75-bdea-8d410f2615d3",
      "grade": "B",
      "score": 72,
      "date": "2023-03-21T22:29:10",
      "requests": 55,
      "size": 779.939,
      "nodes": 273,
      "url": "https://novagaia.fr/",
      "color": "#51B84B"
    },
    // ...
  ]
}

Proposition

Retourner un code 204 ;
Un message ;
Nombre de mesures restante pour ce domain pour cette journée ;
Ne pas retourner latest-result.

Je ne sais pas comment gérer, à par tester que l'latest-result.id est vide...

{
  "code": 204,
  "message": "Aucune mesure disponible pour la page https://www.yourdomain.tld/test",
  "remaining-daily-requests": 4,
  "count": 17,
  "latest-result": {
    "id": "",
    "grade": "",
    "score": 0,
    "date": "",
    "requests": 0,
    "size": 0,
    "nodes": 0,
    "url": "",
    "color": ""
  },
  "older-results": null,
  "host-results": [
    {
      "id": "46df881f-0cc3-4153-9fa9-871f65b22362",
      "grade": "B",
      "score": 74,
      "date": "2023-03-21T22:30:57",
      "requests": 39,
      "size": 1210.65,
      "nodes": 264,
      "url": "https://novagaia.fr/offres/creez-un-site-web-performant-et-moins-polluant/",
      "color": "#51B84B"
    },
    {
      "id": "430b0d3c-0bd2-4b75-bdea-8d410f2615d3",
      "grade": "B",
      "score": 72,
      "date": "2023-03-21T22:29:10",
      "requests": 55,
      "size": 779.939,
      "nodes": 273,
      "url": "https://novagaia.fr/",
      "color": "#51B84B"
    },
    // ...
  ]
}

Déploiement sur Neutral IT

Github action

Lint
Tests
Build / Deploy

Documentation

Readme
Licence
Code of conduct

[Enhancement]: Améliorer les retours de l'API - Atteinte de limit de 10 test/j/domain

Atteinte de limit de 10 test/j/domain

J'ai une erreur 500, pas d'infos et l'extension chrome ne sait pas gérer, car elle mouline dans vide...

Proposition

code erreur: 429
message: Le domain https://www.yourdomain.tld/test a atteint le nombre des n mesures proposées par Ecoindex pour la journée du DD/MM/YY
nombre de tests restants sur ce domain pour cette journée (parfois, il faut lire le header de la response - je ne retrouve pas ça dans la doc -, parfois le body, simplifiez la vie en mettant tout dans le body et pourquoi pas dupliquez dans le header).

{
  "code": 429,
  "message": "Le domain https://www.yourdomain.tld/test a atteint le nombre des `n` mesures proposées par Ecoindex pour la journée du DD/MM/YY",
  "remaining-daily-requests": 3,
  "count": 17,
  "latest-result": {
    "id": "",
    "grade": "",
    "score": 0,
    "date": "",
    "requests": 0,
    "size": 0,
    "nodes": 0,
    "url": "",
    "color": ""
  },
  "older-results": null,
  "host-results": [
    {
      "id": "46df881f-0cc3-4153-9fa9-871f65b22362",
      "grade": "B",
      "score": 74,
      "date": "2023-03-21T22:30:57",
      "requests": 39,
      "size": 1210.65,
      "nodes": 264,
      "url": "https://novagaia.fr/offres/creez-un-site-web-performant-et-moins-polluant/",
      "color": "#51B84B"
    },
    {
      "id": "430b0d3c-0bd2-4b75-bdea-8d410f2615d3",
      "grade": "B",
      "score": 72,
      "date": "2023-03-21T22:29:10",
      "requests": 55,
      "size": 779.939,
      "nodes": 273,
      "url": "https://novagaia.fr/",
      "color": "#51B84B"
    },
    // ...
  ]
}

Migrer repo CNUMR

[Enhancement]: Améliorer les retours de l'API - Demande de mesure d'une URL

Demande de mesure d'une URL

Pourquoi recevoir un numéro de task (ce devrait être du json), plutôt qu'attendre et retourner l'arbre ?

"35c64f8e-9bca-4c0d-b5db-9dda4d1c6fe5"

Proposition

renvoyer le code 201
renvoyer l'arbre rempli par le test courant dans result ;
indiquer le nombre de test restant dans remaining-daily-requests.

{
  "code": 201,
  "remaining-daily-requests": 4,
  "count": 17,
  "result": {
      "id": "46df881f-0cc3-4153-9fa9-871f65b22362",
      "grade": "B",
      "score": 74,
      "date": "2023-03-21T22:30:57",
      "requests": 39,
      "size": 1210.65,
      "nodes": 264,
      "url": "https://novagaia.fr/offres/creez-un-site-web-performant-et-moins-polluant/",
      "color": "#51B84B"
    },
}

cnumr / ecoindex_bff Goto Github PK

ecoindex_bff's People

Contributors

Stargazers

Watchers

ecoindex_bff's Issues

Aucune mesure disponible pour https://www.yourdomain.tld

Proposition

Aucune mesure disponible pour la page https://www.yourdomain.tld/test

Proposition

Atteinte de limit de 10 test/j/domain

Proposition

Demande de mesure d'une URL

Proposition

Recommend Projects

Recommend Topics

Recommend Org