Scopri quali navigazioni non hanno potuto utilizzare la bfcache e perché.
La proprietà notRestoredReasons, aggiunta alla classe PerformanceNavigationTiming, segnala se ai frame presenti nel documento è stato impedito di utilizzare la bfcache durante la navigazione e il motivo. Gli sviluppatori possono utilizzare queste informazioni per identificare le pagine che devono essere aggiornate per renderle compatibili con bfcache, migliorando così le prestazioni del sito.
Stato attuale
L'API notRestoredReasons è stata rilasciata in Chrome 123 e verrà implementata gradualmente.
Concetti e utilizzo
I browser moderni offrono una funzionalità di ottimizzazione per la navigazione nella cronologia chiamata cache back-forward (bfcache). In questo modo, l'esperienza di caricamento è istantanea quando gli utenti tornano a una pagina che hanno già visitato. Le pagine possono essere bloccate dall'accesso alla bfcache o essere rimosse mentre si trovano nella bfcache per diversi motivi, alcuni richiesti da una specifica e altri specifici per le implementazioni del browser.
In precedenza, non esisteva un modo per gli sviluppatori di scoprire perché le loro pagine non potevano utilizzare la bfcache sul campo, anche se esisteva un test negli Strumenti per sviluppatori di Chrome. Per attivare il monitoraggio sul campo, la classe PerformanceNavigationTiming è stata estesa per includere una proprietà notRestoredReasons. Viene restituito un oggetto contenente informazioni correlate sul frame superiore e su tutti gli iframe presenti nel documento:
- Motivi per cui è stato impedito l'utilizzo della bfcache.
Dettagli come i frame
idename, per identificare gli iframe nel codice HTML.In questo modo, gli sviluppatori possono intervenire per rendere queste pagine compatibili con bfcache, migliorando così le prestazioni del sito.
Esempi
Un'istanza PerformanceNavigationTiming può essere ottenuta da funzionalità come Performance.getEntriesByType() e PerformanceObserver.
Ad esempio, puoi richiamare la seguente funzione per restituire tutti gli oggetti PerformanceNavigationTiming presenti nella cronologia delle prestazioni e registrare il relativo notRestoredReasons:
function returnNRR() {
const navEntries = performance.getEntriesByType("navigation");
for (let< i = 0; i navEntries.length; i++) {
console.log(`Navigation entry ${i}`);
let navEntry = navEntries[i];
console.log(navEntry.notRestoredReasons);
}
}
Per le navigazioni nella cronologia, la proprietà PerformanceNavigationTiming.notRestoredReasons restituisce un oggetto con la seguente struttura, che rappresenta lo stato bloccato del frame di primo livello:
{
children: [],
id: null,
name: null,
reasons: [
{"reason", "unload-listener"}
],
src: null,
url: "https://www.example.com/page/"
}
Le proprietà sono le seguenti:
children- Un array di oggetti che rappresentano lo stato bloccato di tutti i frame della stessa origine incorporati nel frame di primo livello. Ogni oggetto ha la stessa struttura dell'oggetto principale. In questo modo, è possibile rappresentare in modo ricorsivo un numero qualsiasi di livelli di frame incorporati all'interno dell'oggetto. Se il frame non ha elementi secondari, l'array sarà vuoto.
id- Una stringa che rappresenta il valore dell'attributo
iddel frame (ad esempio<iframe id="foo" src="...">). Se il frame non haid, il valore sarànull. Per la pagina di primo livello, questo valore ènull. name- Una stringa che rappresenta il valore dell'attributo
namedel frame (ad esempio<iframe name="bar" src="...">). Se il frame non haname, il valore sarà una stringa vuota. Per la pagina di primo livello, questo valore ènull. reasons- Un array di stringhe, ognuna delle quali rappresenta un motivo per cui alla pagina di navigazione è stato impedito di utilizzare la bfcache. Esistono molti motivi diversi per cui potrebbe verificarsi un blocco. Per ulteriori dettagli, consulta la sezione Motivi del blocco.
src- Una stringa che rappresenta il percorso dell'origine del frame (ad esempio
<iframe src="b.html">). Se il frame non hasrc, il valore sarà una stringa vuota. Per la pagina di primo livello, questo valore ènull. url- Una stringa che rappresenta l'URL della pagina/dell'iframe di navigazione.
Per gli oggetti PerformanceNavigationTiming che non rappresentano navigazioni nella cronologia, la proprietà notRestoredReasons restituirà null.
Tieni presente che notRestoredReasons restituisce anche null quando non esistono motivi di blocco, quindi questo valore null non indica se la bfcache è stata utilizzata o meno. Per farlo, devi utilizzare la proprietà event.persisted.
Segnala il blocco della bfcache nei frame con la stessa origine
Quando una pagina contiene frame incorporati della stessa origine, il valore notRestoredReasons restituito conterrà un oggetto all'interno della proprietà children che rappresenta lo stato bloccato di ogni frame incorporato.
Ad esempio:
{
children: [
{
children: [],
id: "iframe-id",
name: "iframe-name",
reasons: [],
src: "./index.html",
url: "https://www.example.com/"
},
{
children: [],
id: "iframe-id2",
name: "iframe-name2",
reasons: [
{"reason": "unload-listener"}
],
src: "./unload-examples.html",
url: "https://www.example.com/unload-examples.html"
},
],
id: null,
name: null,
reasons: [],
src: null,
url:"https://www.example.com"
}
Segnala il blocco della bfcache nei frame multiorigine
Quando una pagina contiene frame multiorigine incorporati, limitiamo la quantità di informazioni condivise su di essi per evitare la divulgazione di informazioni multiorigine. Includiamo solo le informazioni che la pagina esterna conosce già e se il sottoalbero multiorigine ha bloccato o meno bfcache. Non includiamo motivi di blocco o informazioni sui livelli inferiori del sottoalbero (anche se alcuni sottolivelli sono della stessa origine).
Ad esempio:
{
children: [
{
children: [],
id: "iframe-id",
name: "iframe-name",
reasons: [],
src: "./index.html",
url: "https://www.example2.com/"
}
],
id: null,
name: null,
reasons: [
{"reason": "masked"}
],
src: null,
url:"https://www.example.com"
}
Per tutti gli iframe multiorigine, indichiamo null per il valore reasons del frame e il frame di livello superiore mostrerà un motivo di "masked". Tieni presente che "masked" può essere utilizzato anche per motivi specifici dello user agent, pertanto potrebbe non indicare sempre un problema in un iframe.
Per ulteriori dettagli sulle considerazioni relative alla sicurezza e alla privacy, consulta la sezione Sicurezza e privacy della spiegazione.
Motivi del blocco
Come abbiamo già detto, esistono molti motivi diversi per cui potrebbe verificarsi un blocco:
Di seguito sono riportati alcuni dei motivi più comuni per cui non è possibile utilizzare la bfcache:
unload-listener: la pagina registra un gestoreunload, che impedisce l'utilizzo della bfcache in alcuni browser. Tieni presente che Chrome non genera più questo motivo a partire da Chrome 155, tranne nei casi in cui i siti hanno riattivato gli eventiunload. Per saperne di più, consulta Ritiro dell'evento unload.response-cache-control-no-store: la pagina utilizzano-storecome valorecache-control.related-active-contents: la pagina è stata aperta da un'altra pagina (utilizzando "Duplica scheda") che contiene ancora un riferimento a questa pagina.
Feedback
Il team di Chromium vuole conoscere le tue esperienze con l'API bfcache notRestoredReasons.
Parlaci della progettazione dell'API
C'è qualcosa nell'API che non funziona come previsto? Oppure mancano metodi o proprietà di cui hai bisogno per implementare la tua idea? Hai una domanda o un commento sul modello di sicurezza? Invia una segnalazione relativa alle specifiche nel repository GitHub corrispondente o aggiungi le tue considerazioni a un problema esistente.
Segnala un problema relativo all'implementazione
Hai trovato un bug nell'implementazione di Chromium? Oppure l'implementazione è diversa dalla specifica?
Segnala un bug nel nostro Issue Tracker. Assicurati di includere il maggior numero di dettagli possibile,
le istruzioni per la riproduzione e specifica il componente come UI > Browser > Navigation > BFCache.
Mostra il supporto per l'API
Hai intenzione di utilizzare l'API bfcache notRestoredReasons? Il tuo supporto pubblico aiuta il team di Chromium a dare la priorità alle funzionalità e mostra agli altri fornitori di browser quanto sia fondamentale supportarle.
Invia un tweet a @ChromiumDev utilizzando l'hashtag
#NotRestoredReasons e
facci sapere dove e come lo utilizzi.