Geri-ileri önbellek notRestoredReasons API'sı

Hangi gezinmelerin geri-ileri önbelleği kullanmasının engellendiğini ve bunun nedenini öğrenin.

PerformanceNavigationTiming sınıfına eklenen notRestoredReasons özelliği, dokümandaki çerçevelerin gezinme sırasında bfcache kullanmasının engellenip engellenmediği ve engellendiyse bunun nedeni hakkında bilgi verir. Geliştiriciler bu bilgileri kullanarak geri-ileri önbellek ile uyumlu hale getirilmesi için güncellenmesi gereken sayfaları belirleyebilir ve böylece site performansını artırabilir.

Mevcut durum

notRestoredReasons API, Chrome 123'ten itibaren kullanıma sunuldu ve kademeli olarak dağıtılıyor.

Kavramlar ve kullanım

Modern tarayıcılar, geçmişte gezinme için geri-ileri önbellek (bfcache) adlı bir optimizasyon özelliği sunar. Bu sayede, kullanıcılar daha önce ziyaret ettikleri bir sayfaya geri döndüklerinde sayfa anında yüklenir. Sayfaların geri-ileri önbelleğe girmesi engellenebilir veya geri-ileri önbellekteyken farklı nedenlerle çıkarılabilir. Bu nedenlerden bazıları bir spesifikasyon tarafından zorunlu kılınır, bazıları ise tarayıcı uygulamalarına özeldir.

Daha önce, Chrome Geliştirici Araçları'nda bir test olmasına rağmen geliştiricilerin, sayfalarının sahada geri-ileri önbelleği kullanmasının neden engellendiğini öğrenmesinin bir yolu yoktu. Sahada izlemeyi etkinleştirmek için PerformanceNavigationTiming sınıfı, notRestoredReasons özelliğini içerecek şekilde genişletildi. Bu, üst çerçeve ve dokümandaki tüm iFrame'ler hakkında ilgili bilgileri içeren bir nesne döndürür:

  • Geri-ileri önbelleği kullanmalarının engellenme nedenleri.
  • HTML'deki iframe'leri tanımlamaya yardımcı olacak çerçeve id ve name gibi ayrıntılar.

    Bu sayede geliştiriciler, söz konusu sayfaları geri-ileri önbellek ile uyumlu hale getirmek için harekete geçerek site performansını artırabilir.

Örnekler

PerformanceNavigationTiming örneği, Performance.getEntriesByType() ve PerformanceObserver gibi özelliklerden alınabilir.

Örneğin, performans zaman çizelgesinde bulunan tüm PerformanceNavigationTiming nesnelerini döndürmek ve notRestoredReasons değerlerini günlüğe kaydetmek için aşağıdaki işlevi çağırabilirsiniz:

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);
  }
}

Geçmiş gezinmeleri için PerformanceNavigationTiming.notRestoredReasons özelliği, üst düzey çerçevenin engellenen durumunu temsil eden aşağıdaki yapıya sahip bir nesne döndürür:

{
  children: [],
  id: null,
  name: null,
  reasons: [
    {"reason", "unload-listener"}
  ],
  src: null,
  url: "https://www.example.com/page/"
}

Özellikler aşağıdaki gibidir:

children
Üst düzey çerçeveye yerleştirilmiş aynı kaynaklı çerçevelerin engellenme durumunu temsil eden bir nesne dizisi. Her nesne, üst nesneyle aynı yapıya sahiptir. Bu sayede, herhangi bir sayıda yerleştirilmiş çerçeve düzeyi, nesne içinde yinelemeli olarak temsil edilebilir. Çerçevede alt öğe yoksa dizi boş olur.
id
Çerçevenin id özellik değerini temsil eden bir dize (örneğin, <iframe id="foo" src="...">). Çerçevenin id özelliği yoksa değer null olur. Üst düzey sayfa için bu değer null şeklindedir.
name
Çerçevenin name özellik değerini temsil eden bir dize (örneğin, <iframe name="bar" src="...">). Çerçevenin name özelliği yoksa değer boş bir dize olur. Üst düzey sayfa için bu değer null şeklindedir.
reasons
Her biri, gidilen sayfanın geri-ileri önbelleği kullanmasının engellenme nedenini temsil eden dize dizisi. Engellemenin birçok farklı nedeni olabilir. Daha fazla bilgi için Engelleme nedenleri bölümüne bakın.
src
Çerçevenin kaynağına giden yolu temsil eden bir dize (örneğin, <iframe src="b.html">). Çerçevenin src değeri yoksa değer boş bir dize olur. Üst düzey sayfa için bu değer null şeklindedir.
url
Gidilen sayfanın/iframe'in URL'sini temsil eden bir dize.

Geçmişte gezinme işlemlerini temsil etmeyen PerformanceNavigationTiming nesneleri için notRestoredReasons özelliği null değerini döndürür.

notRestoredReasons, engelleyici nedenler olmadığında da null döndürür. Bu nedenle, null değeri geri-ileri önbelleğin kullanılıp kullanılmadığını göstermez. Bunun için event.persisted özelliğini kullanmanız gerekir.

Aynı kaynaklı çerçevelerde geri-ileri önbellek engellemeyi bildirme

Bir sayfada aynı kaynaklı yerleştirilmiş çerçeveler varsa döndürülen notRestoredReasons değeri, children özelliğinin içinde her bir yerleştirilmiş çerçevenin engellenme durumunu temsil eden bir nesne içerir.

Örneğin:

{
  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"
}

Çapraz kaynak çerçevelerinde geri-ileri önbellek engellemeyi bildirme

Bir sayfada yerleşik çapraz kaynak çerçeveleri varsa çapraz kaynak bilgilerinin sızdırılmasını önlemek için bu çerçeveler hakkında paylaşılan bilgi miktarını sınırlandırırız. Yalnızca dış sayfanın zaten bildiği bilgileri ve çapraz kaynak alt ağacının geri-ileri önbelleği engelleyip engellemediğini ekleriz. Engelleme nedenlerini veya alt ağacın alt düzeyleriyle ilgili bilgileri (bazı alt düzeyler aynı kaynak olsa bile) dahil etmeyiz.

Örneğin:

{
  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"
}

Tüm çapraz kaynaklı iFrame'ler için, iFrame'in reasons değeri olarak null raporlanır ve üst düzey iFrame'de "masked" nedeni gösterilir. "masked", kullanıcı aracısına özgü nedenlerle de kullanılabileceğinden her zaman bir iFrame'de sorun olduğunu göstermeyebilir.

Güvenlik ve gizlilikle ilgili dikkat edilmesi gereken noktalar hakkında daha fazla bilgi için açıklayıcıdaki Güvenlik ve gizlilik bölümüne bakın.

Engelleme nedenleri

Daha önce de belirttiğimiz gibi, engellemenin birçok farklı nedeni olabilir:

Geri-ileri önbelleğin kullanılamamasının en yaygın nedenlerinden bazıları şunlardır:

  • unload-listener: Sayfa, belirli tarayıcılarda geri-ileri önbellek kullanımını engelleyen bir unload işleyici kaydeder. Chrome'un, sitelerin unload etkinliklerini tekrar etkinleştirdiği durumlar dışında, Chrome 155'ten itibaren bu nedeni artık yayınlamadığını unutmayın. Daha fazla bilgi için Unload etkinliğinin desteğinin sonlandırılması başlıklı makaleyi inceleyin.
  • response-cache-control-no-store: Sayfa, cache-control değeri olarak no-store kullanıyor.
  • related-active-contents: Sayfa, hâlâ bu sayfaya referans veren başka bir sayfadan ("sekme kopyalama" kullanılarak) açılmıştır.

Geri bildirim

Chromium ekibi, bfcache notRestoredReasons API ile ilgili deneyimlerinizi öğrenmek istiyor.

API tasarımı hakkında bilgi verin

API'nin beklediğiniz gibi çalışmayan bir yönü var mı? Yoksa fikrinizi uygulamak için eksik yöntemler veya özellikler mi var? Güvenlik modeliyle ilgili sorunuz veya yorumunuz mu var? İlgili GitHub deposunda bir spesifikasyon sorunu bildirin veya mevcut bir soruna düşüncelerinizi ekleyin.

Uygulamayla ilgili sorun bildirme

Chromium'un uygulamasında bir hata mı buldunuz? Yoksa uygulama, spesifikasyondan farklı mı? Issue Tracker'ımızda hata bildiriminde bulunun. Mümkün olduğunca fazla ayrıntı ve sorunu yeniden oluşturma talimatlarını eklediğinizden ve bileşeni UI > Browser > Navigation > BFCache olarak belirttiğinizden emin olun.

API'yi desteklediğinizi gösterme

Geri-ileri önbellek notRestoredReasons API'sini kullanmayı planlıyor musunuz? Herkese açık desteğiniz, Chromium ekibinin özelliklere öncelik vermesine yardımcı olur ve diğer tarayıcı tedarikçilerine bu özellikleri desteklemenin ne kadar önemli olduğunu gösterir.

#NotRestoredReasons hashtag'ini kullanarak @ChromiumDev hesabına tweet gönderin ve bu özelliği nerede ve nasıl kullandığınızı bize bildirin.

Faydalı bağlantılar