Come fare il debug in Magento

I files di log

La prima cosa da fare, senza dubbio, è attivare le funzioni di log. In questo modo, Magento scriverà gli eventuali errori generati ed altre informazioni utili in un file, con tanto di data, ora e punto in cui si è generato l’errore, così da poter risalire in un batter d’occhio alla causa dei malfunzionamenti.

Nell’articolo:

abbiamo già visto come fare, ma è sempre bene rinfrescarci la memoria, no?

Per abilitare il log degli errori, ti basta entrare nel backend di Magento ed andare su:

Sistema > Configurazione

nel menu in alto, e scegliere:

SVILUPPATORE

in basso, nel menu laterale. Nella tab:

IMPOSTAZIONI LOG

ti basta scegliere:

ABILITA

ed il gioco è fatto!

Da questo momento, gli errori generati da Magento verranno scritti nel file:

/var/log/system.log

mentre le semplici eccezioni saranno situate nel file:

/var/log/exception.log

Come leggere il file di log

Prendiamo ad esempio questo file di log di Magento ed analizziamolo insieme, per comprendere meglio come leggerlo:

In questo esempio (generato ad-hoc per l’occasione), leggiamo per prima cosa la data ed ora in cui si è generata la riga di log.
Dopodiché, troveremo la descrizione didascalica dell’errore, con tanto di file (completo di percorso in cui reperirlo) in cui l’errore si è generato e perfino la riga esatta in cui cercare!

Come gestire le eccezioni

Quando per qualche oscuro motivo Magento genera un’eccezione, il comportamento predefinito della piattaforma rende ancora più oscuro il riuscire a scovarlo. Ma questo non deve essere una giustificazione a demordere o a deporre le armi. Lo scopo di un buon developer è quello di riuscire a trovare anche il più piccolo errore tra i più profondi meandri del codice e porvi rimedio!

Per quanti di voi stanno maledicendo il famigerato messaggio:

There has been an error processing your request
Exception printing is disabled by default for security reasons.
Error log record number: 1084660608081

ecco qualche dritta che potrà risparmiarvi un bel po’ di tempo.

Magento genera ad ogni eccezione un singolo file di log dedicato, che è possibile reperire nella cartella:

/var/report/{error_log_number}

Dove {error_log_number} è un identificativo che Magento genera e assegna di volta in volta all’errore che si è verificato.
Ancora una volta, è qui che potremo trovare informazioni utili per rimuovere il problema:

Nell’esempio (anche stavolta generato ad-hoc a scopo didattico), troviamo come prima riga l’errore che ha generato l’interruzione. Nel caso in esame, non è stato trovato l’indice [1] nell’array:

array( ‘demo’ => ‘demo’ ).

Inoltre, leggiamo anche stavolta il percorso completo del file in cui si è verificato l’errore:

/app/code/core/Mage/Catalog/controllers/CategoryController.php

esattamente alla riga (45).

Impostare una DEV MODE

Per chi volesse semplificarsi la vita in fase di sviluppo, ci sono una serie di impostazioni che consiglio vivamente di controllare per avere a portata di mano tutte le informazioni più importanti in caso di errori.

• Attivare il log degli errori (come descritto all’inizio della guida):
  System > Configuration > Advanced > Developer > Log Settings > Enabled => Yes
• Disabilitare tutte le cache di sistema:
  System > Cache Management > Disable All
• Effettuare una reindicizzazione dei dati:
  System > Index Management > Reindex All
• Abilitare la modalità sviluppo:
  Aprire il file .htaccess presente nella root di Magento ed inserire:
  SetEnv MAGE_IS_DEVELOPER_MODE “true”
• Abilitare la visualizzazione degli errori PHP:
  Aprire il file index.php presente nella root di Magento, ed alla riga (73) rimuovere il simbolo # all’inizio dell’istruzione:
  ini_set( ‘display_errors’, 1 );
• Abilitare la modalità di visualizzazione in chiaro delle eccezioni:
  Rinominare il file /errors/local.xml.sample in /errors/local.xml
• Assicurati che files CSS e JavaScript non siano concatenati:
  System > Configuration > Advanced > Developer > JavaScript Settings > Merge JavaScript Files => No e System > Configuration > Advanced > Developer > CSS Settings > Merge CSS Files => No

In pochi passaggi, il tuo Magento è configurato per semplificare le operazioni di debutto, rendendo le tue ore di sviluppo un po’ meno tortuose.

Ovviamente, non dimenticare di ripercorrere a ritroso questi passaggi quando tutto sarà pronto per la pubblicazio…

Buono sviluppo con Magento!