Back-Forward Cache notRestoredreasons API

ค้นหาว่าการนําทางใดถูกบล็อกไม่ให้ใช้ bfcache และสาเหตุ

พร็อพเพอร์ตี้ notRestoredReasons ซึ่งเพิ่มลงในคลาส PerformanceNavigationTiming จะรายงานข้อมูลว่าเฟรมที่แสดงในเอกสารถูกบล็อกไม่ให้ใช้ bfcache ในการนําทางหรือไม่ และเพราะเหตุใด นักพัฒนาแอปสามารถใช้ข้อมูลนี้เพื่อระบุหน้าที่ต้องอัปเดตเพื่อให้เข้ากันได้กับ bfcache ซึ่งจะช่วยปรับปรุงประสิทธิภาพของเว็บไซต์

สถานะปัจจุบัน

API notRestoredReasons ได้รับการจัดส่งจาก Chrome 123 และกำลังทยอยเปิดตัว

แนวคิดและการใช้งาน

เบราว์เซอร์ที่ทันสมัยมีฟีเจอร์การเพิ่มประสิทธิภาพสำหรับการไปยังส่วนต่างๆ ในประวัติการเข้าชมที่เรียกว่า Back-Forward Cache (bfcache) ซึ่งจะช่วยให้โหลดหน้าเว็บได้ทันทีเมื่อผู้ใช้กลับไปยังหน้าที่เคยเข้าชมแล้ว หน้าเว็บอาจถูกบล็อกไม่ให้เข้าสู่ bfcache หรือถูกนำออกขณะอยู่ใน bfcache ด้วยเหตุผลที่แตกต่างกัน โดยบางเหตุผลเป็นไปตามข้อกำหนด และบางเหตุผลก็เฉพาะเจาะจงสำหรับการใช้งานเบราว์เซอร์

ก่อนหน้านี้ นักพัฒนาซอฟต์แวร์ไม่มีวิธีค้นหาสาเหตุที่หน้าเว็บถูกบล็อกไม่ให้ใช้ bfcache ในภาคสนาม แม้ว่าจะมีการทดสอบในเครื่องมือสำหรับนักพัฒนาซอฟต์แวร์ Chrome ก็ตาม หากต้องการเปิดใช้การตรวจสอบในช่อง ระบบจะขยายคลาส PerformanceNavigationTiming ให้รวมพร็อพเพอร์ตี้ notRestoredReasons ซึ่งจะแสดงผลออบเจ็กต์ที่มีข้อมูลที่เกี่ยวข้องในเฟรมบนสุดและ iframe ทั้งหมดที่อยู่ในเอกสาร ดังนี้

  • สาเหตุที่บล็อกไม่ให้ใช้ bfcache
  • รายละเอียด เช่น เฟรม id และ name เพื่อช่วยระบุ iframe ใน HTML

    ซึ่งช่วยให้นักพัฒนาซอฟต์แวร์ดำเนินการเพื่อทำให้หน้าเหล่านั้นเข้ากันได้กับ bfcache ซึ่งจะช่วยปรับปรุงประสิทธิภาพของเว็บไซต์

ตัวอย่าง

คุณสามารถรับอินสแตนซ์ PerformanceNavigationTiming ได้จากฟีเจอร์ต่างๆ เช่น Performance.getEntriesByType() และ PerformanceObserver

ตัวอย่างเช่น คุณสามารถเรียกใช้ฟังก์ชันต่อไปนี้เพื่อแสดงผลออบเจ็กต์ PerformanceNavigationTiming ทั้งหมดที่อยู่ในไทม์ไลน์ประสิทธิภาพและบันทึก 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);
  }
}

สำหรับการนำทางประวัติ พร็อพเพอร์ตี้ PerformanceNavigationTiming.notRestoredReasons จะแสดงผลออบเจ็กต์ที่มีโครงสร้างต่อไปนี้ ซึ่งแสดงสถานะที่ถูกบล็อกของเฟรมระดับบนสุด

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

พร็อพเพอร์ตี้มีดังนี้

children
อาร์เรย์ของออบเจ็กต์ที่แสดงสถานะที่ถูกบล็อกของเฟรมต้นทางเดียวกันที่ฝังอยู่ในเฟรมระดับบนสุด ออบเจ็กต์แต่ละรายการมีโครงสร้างเหมือนกับออบเจ็กต์หลัก ซึ่งวิธีนี้จะช่วยให้แสดงเฟรมที่ฝังไว้จำนวนกี่ระดับก็ได้ภายในออบเจ็กต์แบบซ้ำๆ หากเฟรมไม่มีเฟรมย่อย อาร์เรย์จะว่างเปล่า
id
สตริงที่แสดงค่าแอตทริบิวต์ id ของเฟรม (เช่น <iframe id="foo" src="...">) หากเฟรมไม่มี id ค่าจะเป็น null สำหรับหน้าเว็บระดับบนสุด ค่านี้คือ null
name
สตริงที่แสดงค่าแอตทริบิวต์ name ของเฟรม (เช่น <iframe name="bar" src="...">) หากเฟรมไม่มี name ค่าจะเป็นสตริงว่าง สำหรับหน้าเว็บระดับบนสุด ค่านี้คือ null
reasons
อาร์เรย์ของสตริงที่แต่ละรายการแสดงเหตุผลที่หน้าเว็บที่ไปยังถูกบล็อกไม่ให้ใช้ bfcache การบล็อกอาจเกิดขึ้นได้จากหลายสาเหตุ ดูรายละเอียดเพิ่มเติมได้ที่ส่วนเหตุผลในการบล็อก
src
สตริงที่แสดงเส้นทางไปยังแหล่งที่มาของเฟรม (เช่น <iframe src="b.html">) หากเฟรมไม่มี src ค่าจะเป็นสตริงว่างเปล่า สำหรับหน้าเว็บระดับบนสุด ค่านี้คือ null
url
สตริงที่แสดง URL ของหน้า/iframe ที่ไปยัง

สำหรับออบเจ็กต์ PerformanceNavigationTiming ที่ไม่ได้แสดงถึงการไปยังส่วนต่างๆ ของประวัติ พร็อพเพอร์ตี้ notRestoredReasons จะแสดงผลเป็น null

โปรดทราบว่า notRestoredReasons จะแสดงผล null ด้วยเมื่อไม่มีสาเหตุการบล็อก ดังนั้นการที่ค่านี้เป็น null จึงไม่ได้เป็นตัวบ่งชี้ว่ามีการใช้ bfcache หรือไม่ หากต้องการดำเนินการดังกล่าว คุณต้องใช้พร็อพเพอร์ตี้ event.persisted

รายงานการบล็อก bfcache ในเฟรมต้นทางเดียวกัน

เมื่อหน้าเว็บมีเฟรมต้นทางเดียวกันฝังอยู่ ค่า notRestoredReasons ที่แสดงผลจะมีออบเจ็กต์อยู่ภายในพร็อพเพอร์ตี้ children ซึ่งแสดงสถานะที่ถูกบล็อกของเฟรมที่ฝังแต่ละเฟรม

เช่น

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

รายงานการบล็อก bfcache ในเฟรมแบบข้ามต้นทาง

เมื่อหน้าเว็บมีเฟรมแบบข้ามต้นทางฝังอยู่ เราจะจำกัดปริมาณข้อมูลที่แชร์เกี่ยวกับเฟรมเหล่านั้นเพื่อหลีกเลี่ยงการรั่วไหลของข้อมูลแบบข้ามต้นทาง เราจะรวมเฉพาะข้อมูลที่หน้านอกทราบอยู่แล้ว และข้อมูลที่ว่าซับทรีแบบข้ามต้นทางบล็อก bfcache หรือไม่ เราจะไม่รวมเหตุผลในการบล็อกหรือข้อมูลเกี่ยวกับระดับที่ต่ำกว่าของโครงสร้างย่อย (แม้ว่าระดับย่อยบางระดับจะมีต้นทางเดียวกันก็ตาม)

เช่น

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

สำหรับ iframe แบบข้ามต้นทางทั้งหมด เราจะรายงาน null สำหรับค่า reasons ของเฟรม และเฟรมระดับบนสุดจะแสดงเหตุผลเป็น "masked" โปรดทราบว่าอาจมีการใช้ "masked" ด้วยเหตุผลเฉพาะของ User Agent ดังนั้นจึงอาจไม่ได้บ่งชี้ถึงปัญหาใน iframe เสมอไป

ดูรายละเอียดเพิ่มเติมเกี่ยวกับข้อควรพิจารณาด้านความปลอดภัยและความเป็นส่วนตัวได้ที่ส่วนความปลอดภัยและความเป็นส่วนตัวในคำอธิบาย

เหตุผลในการบล็อก

ดังที่กล่าวไว้ก่อนหน้านี้ การบล็อกอาจเกิดขึ้นได้จากหลายสาเหตุ ดังนี้

ต่อไปนี้เป็นตัวอย่างสาเหตุที่พบบ่อยที่สุดที่ทำให้ใช้ bfcache ไม่ได้

  • unload-listener: หน้าเว็บลงทะเบียนแฮนเดิล unload ซึ่งป้องกันการใช้ bfcache ในบางเบราว์เซอร์ โปรดทราบว่า Chrome จะไม่แสดงเหตุผลนี้อีกต่อไปตั้งแต่ Chrome 155 เป็นต้นไป ยกเว้นในกรณีที่เว็บไซต์เลือกกลับมาใช้เหตุการณ์ unload ดูข้อมูลเพิ่มเติมได้ที่การเลิกใช้งานเหตุการณ์ Unload
  • response-cache-control-no-store: หน้าเว็บใช้ no-store เป็นค่า cache-control
  • related-active-contents: มีการเปิดหน้านี้จากหน้าอื่น (โดยใช้ "แท็บที่ซ้ำกัน") ซึ่งยังคงมีการอ้างอิงถึงหน้านี้

ความคิดเห็น

ทีม Chromium อยากทราบประสบการณ์การใช้งาน API notRestoredReasons ของ bfcache

บอกเราเกี่ยวกับการออกแบบ API

มีสิ่งใดเกี่ยวกับ API ที่ไม่ทำงานตามที่คุณคาดหวังหรือไม่ หรือมีเมธอดหรือพร็อพเพอร์ตี้ที่ขาดหายไปซึ่งคุณต้องใช้เพื่อนำแนวคิดไปใช้หรือไม่ หากมีคำถามหรือความคิดเห็นเกี่ยวกับรูปแบบการรักษาความปลอดภัย แจ้งปัญหาเกี่ยวกับข้อกำหนดเฉพาะในที่เก็บ GitHub ที่เกี่ยวข้อง หรือเพิ่มความคิดเห็นของคุณลงในปัญหาที่มีอยู่

รายงานปัญหาเกี่ยวกับการติดตั้งใช้งาน

หากพบข้อบกพร่องในการใช้งาน Chromium หรือการติดตั้งใช้งานแตกต่างจากข้อกำหนดหรือไม่ รายงานข้อบกพร่องใน Issue Tracker อย่าลืมใส่รายละเอียดให้มากที่สุดเท่าที่จะทำได้ วิธีการจำลองปัญหา และระบุคอมโพเนนต์เป็น UI > Browser > Navigation > BFCache

แสดงการสนับสนุน API

คุณวางแผนที่จะใช้ API notRestoredReasons ของ bfcache ไหม การสนับสนุนแบบสาธารณะของคุณจะช่วยให้ทีม Chromium จัดลำดับความสำคัญของฟีเจอร์และแสดงให้ผู้ให้บริการเบราว์เซอร์รายอื่นๆ เห็นว่าการรองรับฟีเจอร์เหล่านี้มีความสำคัญเพียงใด

ส่งทวีตถึง @ChromiumDev โดยใช้แฮชแท็ก #NotRestoredReasons และแจ้งให้เราทราบว่าคุณใช้ฟีเจอร์นี้ที่ไหนและอย่างไร

ลิงก์ที่มีประโยชน์