Genera rapporti di prova

Cloud Firestore e Realtime Database si basano entrambi su linguaggi di regole potenti e concisi creati appositamente per governare la sicurezza delle informazioni e il controllo degli accessi. Tuttavia, man mano che le regole diventano più lunghe e complesse, potresti aver bisogno di aiuto per eseguire il debug degli errori nel loro comportamento.

Gli emulatori Firebase includono la possibilità di generare report sulla copertura delle regole, in modo da poter vedere esattamente il valore valutato da ciascuna sottoespressione quando si riproduce un errore. I report forniscono inoltre informazioni sulla frequenza con cui ogni caso di test ha utilizzato una regola, come le tradizionali tecniche di "copertura della linea".

Genera un rapporto

Dopo aver eseguito una serie di test, puoi accedere ai report sulla copertura dei test che mostrano come è stata valutata ciascuna delle tue regole di sicurezza.

Per ottenere i report, esegui una query su un endpoint esposto sull'emulatore mentre è in esecuzione. Per una versione ottimizzata per il browser, utilizzare il seguente URL:

Cloud Fire Store

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage.html
 

Banca dati in tempo reale

http://localhost:9000/.inspect/coverage?ns=<database_name>
 

Ciò suddivide le regole in espressioni e sottoespressioni su cui puoi passare il mouse per ulteriori informazioni, incluso il numero di valutazioni e valori restituiti. Per la versione JSON non elaborata di questi dati, includi il seguente URL nella query:

Cloud Fire Store

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage
 

Banca dati in tempo reale

http://localhost:9000/.inspect/coverage.json?ns=<database_name>
 

Regole di esempio di debug

Per generare facilmente un report di test, utilizza le guide di avvio rapido dell'emulatore disponibili su GitHub per Cloud Firestore e Realtime Database . Queste guide di avvio rapido ti guidano attraverso la corretta installazione e inizializzazione degli emulatori, quindi generando test di esempio da un insieme di regole di esempio.

Considera un'app di esempio che utilizza Cloud Firestore che conta quante volte gli utenti fanno clic su un pulsante. L'app utilizza le seguenti regole:

Cloud Fire Store

 service cloud.firestore {
   match /databases/{database}/documents {
     match /counters/{counter} {
       allow read;
       allow write: if request.resource.data.value == resource.data.value +1;
     }
   }
 }
 

Per eseguire il debug degli errori nelle regole mostrate sopra, utilizza il seguente test JavaScript di esempio:

const counter0 = db.collection("counters").doc("0");
await firebase.assertSucceeds(counter0.set({value: 0}));

L'emulatore genera un report disponibile all'URL sopra indicato:

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage.html

Il report mostra i seguenti errori non definiti e con valore null:

Il problema con questo esempio specifico è che le regole non fanno differenza tra la creazione del documento e l'aggiornamento del documento. Di conseguenza, la scrittura non è consentita se il documento non esiste, e il documento non può essere creato perché non esiste. Differenziare la "scrittura" in due operazioni più specifiche - "crea" e "aggiornamento" - risolve il problema.

Cloud Fire Store

 service cloud.firestore {
   match /databases/{database}/documents {
     match /counters/{counter} {
       allow read;
       allow create: if request.resource.data.value == 0;
       allow update: if request.resource.data.value == resource.data.value +1;
     }
   }
 }
 

Il report generato mostra la frequenza con cui è stata utilizzata ciascuna regola e cosa è stato restituito.