Che cos'è un controllo di salute su un modulo?

Nell'ecosistema PrestaShop, il concetto di "healthcheck" è diventato un metodo centrale per garantire la stabilità, la connettività e il buon funzionamento dei moduli critici, in particolare quelli che si integrano con piattaforme esterne. Comprendere il ruolo di healthcheck e la necessità di accedere alle API esterne è essenziale per garantire il successo dell'integrazione dei moduli di Facebook e Google, ad esempio, in un negozio PrestaShop.

Definizione e ruolo dell'healthcheck in PrestaShop

L'healthcheck è una funzione fornita da un modulo PrestaShop che le consente di verificare in remoto la salute tecnica del modulo e delle sue dipendenze. Questo controllo può essere attivato da strumenti automatici o dai team di assistenza, senza richiedere l'accesso diretto al back office del negozio.

Healthcheck ha diversi obiettivi:

• Confermare che il modulo è installato e attivo (in caso contrario, viene restituito un errore HTTP 404 o 500 ).
• Verifichi la compatibilità con la versione di PrestaShop, il modulo e PHP, e la presenza delle dipendenze necessarie.
• Verifica la validità dei token di autenticazione o delle connessioni OAuth necessarie per l'integrazione con servizi di terze parti.
• Si assicuri che i connettori tecnici (come cURL o fopen) siano abilitati sul server.
• Verificare la connettività alle API esterne che sono essenziali per il funzionamento del modulo (ad esempio, endpoint di Facebook, account PrestaShop, CloudSync, ecc.)
• Restituisce una diagnosi strutturata, facilitando la rapida identificazione dei punti critici o degli errori durante l'integrazione o l'assistenza tecnica.

Un esempio di risposta alla verifica dello stato di salute di un modulo PrestaShop potrebbe essere il seguente:

{
  "prestashop_version": "1.7.8.7",
  "ps_facebook_version": "x.y.z",
  "php_version": "7.4.33",
  "oauthApiConnectivity": true,
  "facebookApiConnectivity": true,
  "cloudsyncApiConnectivity": true,
  "fopenActive": true,
  "curlActive": true,
  "shopLinked": true,
  "is_valid_jwt": true,
  "env": {
    "facebookApiUrl": "<https://graph.facebook.com>",
    "cloudsyncApiUrl": "<https://eventbus-sync.psessentials.net>"
  }
}

Questo rapporto può essere utilizzato per anticipare o diagnosticare i problemi di integrazione, autenticazione o sincronizzazione del catalogo.

Esempi specifici di controlli effettuati da healthcheck

• Connettività API di Facebook: chiamata di prova suhttps://graph.facebook.com per verificare la disponibilità del servizio e la validità dei token di accesso.
• Connettività CloudSync/EventBus: test suhttps://eventbus-sync.psessentials.net per garantire la trasmissione e la sincronizzazione dei dati del catalogo.
• Connettività dei conti PrestaShop: verificare se è possibile aggiornare o ottenere un token OAuth valido tramitehttps://accounts-api.distribution.prestashop.net/.
• Attivazione dei moduli PHP necessari (cURL, fopen, ecc.): per garantire che il server possa effettuare richieste HTTP in uscita.
• Verifica delle versioni e delle dipendenze: per garantire che il modulo funzioni in un ambiente compatibile.

L'healthcheck dei moduli di PrestaShop è una parte essenziale per garantire un'integrazione affidabile tra il negozio e i servizi di terze parti. Le permette di anticipare i problemi, di velocizzare l'assistenza e di garantire che il suo negozio sia tecnicamente conforme. Per svolgere efficacemente la sua missione, Healthcheck ha bisogno di un accesso illimitato alle API esterne critiche (Facebook, Google, Conti PrestaShop, CloudSync/EventBus). Qualsiasi restrizione di rete o firewall che impedisca questo accesso comporterà gravi malfunzionamenti e difficoltà di assistenza, rendendo l'esperienza del commerciante e del cliente insoddisfacente.