Configura Xdebug

Nel terminale locale, apri il file .magento.app.yaml in un editor di testo.

Nella sezione runtime, in extensions, aggiungi xdebug. Ad esempio:

runtime:
    extensions:
        - redis
        - xsl
        - newrelic
        - sodium
        - xdebug

Salvare le modifiche apportate al file .magento.app.yaml e uscire dall'editor di testo.

Aggiungi, esegui il commit e invia le modifiche per ridistribuire l’ambiente.

git add .magento.app.yaml

git commit -m "add xdebug"

git push origin <environment-ID>

Nel progetto PhpStorm, apri il pannello Impostazioni.

• macOS—Seleziona PhpStorm > Impostazioni.
• Windows/Linux—Selezionare File > Impostazioni.

Nel pannello Impostazioni, espandi la sezione PHP e fai clic su Server.

Fare clic su + per aggiungere una configurazione del server. Il nome del progetto è in grigio nella parte superiore.

[Facoltativo] Configura le impostazioni seguenti per la nuova configurazione del server. Consulta Nessun server di debug configurato nella documentazione di PHPStorm.

• Nome - Immettere lo stesso nome host. Questo valore deve corrispondere al valore per la variabile PHP_IDE_CONFIG in Debug dei comandi CLI per utilizzare CLI per il debug.
• Host - Immettere il nome host.
• Porta - Immettere 443.
• Debugger—Selezionare Xdebug.

Seleziona Usa mappature percorso. Nel riquadro File/Directory viene visualizzata la directory principale del progetto per serverName.

Nella colonna Percorso assoluto sul server fare clic sull'icona Modifica e aggiungere un'impostazione basata sull'ambiente.

• Per tutti gli ambienti Starter e di integrazione Pro, il percorso remoto è /app.

• Per ambienti di staging e produzione Pro:

  • Produzione: /app/<project_code>/
  • Gestione temporanea: /app/<project_code>_stg/

Cambia la porta Xdebug in 9000,9003 oppure puoi limitarla a 9000 nel pannello PHP > Debug > Xdebug > Porta di debug.

Fare clic su Applica.

Aprire l'applicazione PHPStorm e fare clic su Add Configuration in alto a destra.

Fare clic su Add new run configuration.

Selezionare l'opzione PHP Remote Debug.

• Immettere un nome univoco ma riconoscibile.
• Selezionare la casella di controllo Filter debug connection by IDE key**.
• Selezionare il server creato nella sezione precedente. Se non lo hai ancora creato, puoi crearne uno ora, ma fai riferimento a quella parte della guida alla configurazione.
• Nel campo di testo IDE key(session id), immettere PHPSTORM in lettere maiuscole. La utilizzeremo in altre parti della configurazione, quindi è importante mantenere la stessa impostazione. Se si sceglie un'altra stringa, è necessario ricordarsi di utilizzarla in un'altra posizione nel processo di configurazione e configurazione.

Fare clic su Apply > OK.

Apri un terminale.

Utilizza SSH per stabilire la connessione.

ssh -R 9000:localhost:9000 <ssh url>

Utilizzare l'opzione -v (dettagliata) in modo che ogni volta che un socket è connesso alla porta che viene inoltrata venga visualizzato nel terminale.

Se viene visualizzato l'errore "Impossibile connettersi" o "Impossibile ascoltare la porta in remoto", potrebbe essere presente un'altra sessione SSH attiva persistente sul server che occupa la porta 9000. Se la connessione non viene utilizzata, è possibile terminarla.

Utilizza SSH per accedere all’integrazione remota, all’ambiente di staging o di produzione.

Visualizza elenco sessioni SSH: who

Visualizzare le sessioni SSH esistenti per utente. Fai attenzione a non avere effetti su utenti diversi da te!

• integrazione: i nomi utente sono simili a dd2q5ct7mhgus
• Staging: i nomi utente sono simili a dd2q5ct7mhgus_stg
• Produzione: i nomi utente sono simili a dd2q5ct7mhgus

Per una sessione utente precedente alla tua, trova il valore dello pseudo-terminale (PTS), ad esempio pts/0.

Termina il PID (Process ID) corrispondente al valore PTS.

ps aux | grep ssh
kill <PID>

Risposta di esempio:

dd2q5ct7mhgus        5504  0.0  0.0  82612  3664 ?      S    18:45   0:00 sshd: dd2q5ct7mhgus@pts/0

Per terminare la connessione, immettere un comando kill con l'ID processo (PID).

kill 3664

Se non lo hai già fatto, scarica Putty.

Avvia Putty.

Nel riquadro Categoria fare clic su Sessione.

Immettere le seguenti informazioni:

• Campo Nome host (o indirizzo IP): immetti l'URL SSH per il server cloud
• Campo Porta: immetti 22

Nel riquadro Categoria fare clic su Connessione > SSH > Tunnel.

Immettere le seguenti informazioni:

• Campo Porta Source: immetti 9000
• Campo Destinazione: immetti 127.0.0.1:9000
• Fai clic su Remoto

Fare clic su Aggiungi.

Nel riquadro Categoria fare clic su Sessione.

Nel campo Sessioni salvate immettere un nome per il tunnel SSH.

Fai clic su Salva.

Per verificare il tunnel SSH, fai clic su Carica, quindi su Apri.

Se viene visualizzato un errore di tipo "Impossibile connettersi", verificare quanto segue:

• Tutte le impostazioni di Putty sono corrette
• Stai eseguendo Putty sul computer in cui si trovano le chiavi SSH dell’infrastruttura cloud del tuo Adobe Commerce privato

Apri un terminale.

Pulizia di tutte le sessioni SSH per ogni nodo Web del cluster.

ssh USERNAME@CLUSTER.ent.magento.cloud 'rm /run/platform/USERNAME/xdebug.sock'

Impostare il tunnel SSH per Xdebug per ogni nodo Web del cluster.

ssh -R /run/platform/USERNAME/xdebug.sock:localhost:9000 -N USERNAME@CLUSTER.ent.magento.cloud

Abilitare il debug remoto; visitare il sito nel browser e aggiungere quanto segue all'URL in cui KEY è il valore per xdebug_key.

?XDEBUG_SESSION_START=KEY

Questo passaggio imposta il cookie che invia le richieste del browser per attivare Xdebug.

Completa il debug con Xdebug.

Quando si è pronti per terminare la sessione, utilizzare il comando seguente per rimuovere il cookie e terminare il debug tramite il browser, dove KEY è il valore di xdebug_key.

?XDEBUG_SESSION_STOP=KEY

SSH nel server di cui eseguire il debug utilizzando i comandi CLI.

Crea le seguenti variabili di ambiente:

export XDEBUG_CONFIG='PHPSTORM'

export PHP_IDE_CONFIG="serverName=<name of the server that is configured in PHPSTORM>"

Queste variabili vengono rimosse al termine della sessione SSH.

Inizio debug

Negli ambienti Starter e negli ambienti di integrazione Pro, eseguire il comando CLI per eseguire il debug.
È possibile aggiungere opzioni di runtime, ad esempio:

php -d xdebug.profiler_enable=On -d xdebug.max_nesting_level=9999 bin/magento cache:clean

Negli ambienti di staging e produzione Pro, è necessario specificare il percorso del file di configurazione PHP Xdebug durante il debug dei comandi CLI, ad esempio:

php -c /etc/platform/USERNAME/php.xdebug.ini bin/magento cache:clean

Nel menu Estensione, fai clic su Debug per abilitare.

Fare clic con il pulsante destro del mouse, selezionare il menu delle opzioni e impostare il tasto IDE su PHPSTORM.

Installa il client Xdebug nel browser. Configuralo e attivalo.

Crea un tunnel SSH nel server cloud.

Installa l'estensione Xdebug Helper dall'archivio Chrome.

Abilita l’estensione in Chrome come illustrato nella figura seguente.

In Chrome, fai clic con il pulsante destro del mouse sull’icona verde helper nella barra degli strumenti di Chrome.

Dal menu a comparsa, fare clic su Opzioni.

Nell'elenco Chiave IDE fare clic su PhpStorm.

Fai clic su Salva.

Apri il progetto PhpStorm.

Nella barra di navigazione superiore, fai clic sull'icona Avvia ascolto.

Se la barra di spostamento non è visualizzata, fare clic su Visualizza > Barra di spostamento.

Nel pannello di navigazione PhpStorm, fate doppio clic sul file PHP da testare.

Utilizza SSH per accedere all’ambiente remoto.

Comprimi i file.

tar -czf /tmp/<file-name>.tgz <directory list>

Ad esempio, per comprimere solo la directory vendor:

tar -czf /tmp/vendor.tgz vendor

Nell'ambiente locale, usare PhpStorm per comprimere i file.

cd <phpstorm project root dir>

rsync <SSH-URL>:/tmp/<file-name>.tgz .

tar xzf <file-name>.tgz