Men-debug aturan spekulasi dengan Chrome DevTools

Aturan spekulasi dapat digunakan untuk melakukan pra-pengambilan dan pra-render navigasi halaman berikutnya seperti yang dijelaskan dalam postingan sebelumnya. Hal ini dapat memungkinkan pemuatan halaman yang jauh lebih cepat—atau bahkan instan—sehingga sangat meningkatkan Core Web Vitals untuk navigasi halaman tambahan ini.

Men-debug aturan spekulasi bisa jadi rumit. Hal ini terutama berlaku untuk halaman yang dipra-render, karena halaman ini dirender di perender terpisah—seperti tab latar belakang tersembunyi yang menggantikan tab saat ini saat diaktifkan. Oleh karena itu, opsi DevTools biasa tidak selalu dapat digunakan untuk men-debug masalah.

Tim Chrome telah bekerja keras untuk meningkatkan dukungan DevTools untuk proses debug aturan spekulasi. Dalam postingan ini, Anda akan melihat berbagai cara menggunakan alat ini untuk memahami aturan spekulasi halaman, alasan aturan tersebut mungkin tidak berfungsi, dan kapan developer dapat menggunakan opsi DevTools yang lebih umum—dan kapan tidak.

Penjelasan istilah "pra-"

Ada banyak istilah "pra-" yang membingungkan, jadi kita akan memulai dengan penjelasan tentang istilah-istilah berikut:

  • Pramuat: mengambil resource atau dokumen terlebih dahulu untuk meningkatkan performa di masa mendatang. Postingan ini membahas pengambilan dokumen secara prefetch menggunakan Speculation Rules API, bukan opsi <link rel="prefetch"> yang serupa, tetapi lebih lama yang sering digunakan untuk mengambil sub-resource secara prefetch.
  • Pra-rendering: ini lebih dari sekadar pengambilan data dan benar-benar merender seluruh halaman seolah-olah pengguna telah membukanya, tetapi menyimpannya dalam proses perender latar belakang tersembunyi yang siap digunakan jika pengguna benar-benar membukanya. Sekali lagi, dokumen ini membahas versi Speculation Rules API yang lebih baru, bukan opsi <link rel="prerender"> yang lebih lama (yang tidak lagi melakukan pra-rendering penuh).
  • Navigasi spekulatif: istilah kolektif untuk opsi pramuat dan pra-rendering baru yang dipicu oleh aturan spekulasi.
  • Preload: istilah yang kelebihan beban yang dapat merujuk ke sejumlah teknologi dan proses, termasuk <link rel="preload">, pemindai pramuat, dan pramuat navigasi pekerja layanan. Item ini tidak akan dibahas di sini, tetapi istilah ini disertakan untuk membedakannya dengan jelas dari istilah "navigasi spekulatif".

Aturan spekulasi untuk prefetch

Aturan spekulasi dapat digunakan untuk melakukan pramuat dokumen navigasi berikutnya. Misalnya, saat menyisipkan JSON berikut ke dalam halaman, next.html dan next2.html akan dipramuat:

<script type="speculationrules">
  {
    "prefetch": [
      {
        "source": "list",
        "urls": ["next.html", "next2.html"]
      }
    ]
  }
</script>

Menggunakan aturan spekulasi untuk pengambilan data navigasi memiliki beberapa keunggulan dibandingkan sintaksis <link rel="prefetch"> lama, seperti API yang lebih ekspresif dan hasil yang disimpan dalam cache memori, bukan cache disk HTTP.

Men-debug aturan spekulasi prefetch

Pengambilan data yang dipicu oleh aturan spekulasi dapat dilihat di panel Jaringan dengan cara yang sama seperti pengambilan data lainnya:

Panel jaringan di Chrome DevTools yang menampilkan dokumen yang diambil sebelumnya
Panel jaringan di Chrome DevTools yang menampilkan dokumen yang diambil sebelumnya

Dua permintaan yang ditandai dengan warna merah adalah resource yang diambil sebelumnya, seperti yang dapat dilihat pada kolom Type. Resource ini diambil dengan prioritas Lowest karena ditujukan untuk navigasi mendatang dan Chrome memprioritaskan resource halaman saat ini.

Mengklik salah satu baris juga akan menampilkan header HTTP Sec-Purpose: prefetch, yang merupakan cara permintaan ini dapat diidentifikasi di sisi server:

Header pengambilan data di muka Chrome DevTools dengan Sec-Purpose ditetapkan ke pengambilan data di muka
Header pengambilan data di muka Chrome DevTools dengan Sec-Purpose ditetapkan ke pengambilan data di muka

Men-debug prefetch dengan tab Pemuatan spekulatif

Bagian Pemuatan spekulatif baru telah ditambahkan di panel Aplikasi Chrome DevTools, di bagian Layanan latar belakang, untuk membantu proses debug aturan spekulasi:

Tab Pemuatan spekulatif Chrome DevTools yang menampilkan aturan pengambilan data sebelumnya
Tab Pemuatan spekulatif Chrome DevTools yang menampilkan aturan pengambilan data

Ada tiga tab yang tersedia di bagian ini:

  • Pemuatan spekulatif yang mencantumkan status pra-rendering halaman saat ini.
  • Aturan yang mencantumkan semua kumpulan aturan yang ditemukan di halaman saat ini.
  • Spekulasi yang mencantumkan semua URL yang dipramuat dan diprarender dari kumpulan aturan.

Tab Spekulasi ditampilkan di screenshot sebelumnya, dan kita dapat melihat halaman contoh ini memiliki satu kumpulan aturan spekulasi untuk melakukan pengambilan data 3 halaman. Dua dari prefetch tersebut berhasil dan satu gagal. Ikon di samping Kumpulan aturan dapat diklik untuk mengarahkan Anda ke sumber kumpulan aturan di panel Elemen. Atau, link Status dapat diklik untuk mengarahkan Anda ke tab Spekulasi yang difilter ke kumpulan aturan tersebut.

Tab Spekulasi mencantumkan semua URL target, beserta tindakan (pramuat atau prarender), kumpulan aturan yang digunakan (karena mungkin ada beberapa di halaman), dan status setiap spekulasi:

Tab Spekulasi Chrome DevTools menampilkan URL yang dimuat sebelumnya beserta statusnya
Tab Spekulasi Chrome DevTools yang menampilkan URL yang dimuat sebelumnya beserta statusnya

Di atas URL, drop-down dapat digunakan untuk menampilkan URL dari semua kumpulan aturan, atau hanya URL dari kumpulan aturan tertentu. Di bawahnya, semua URL tercantum. Dengan mengklik URL, Anda akan mendapatkan informasi yang lebih mendetail.

Dalam screenshot ini, kita dapat melihat alasan kegagalan untuk halaman next3.html (yang tidak ada sehingga menampilkan 404, yang merupakan kode status HTTP non-2xx).

Tab ringkasan, Pemuatan spekulatif, menampilkan laporan Status pemuatan spekulatif untuk halaman ini untuk menunjukkan apakah pengambilan data atau pra-rendering digunakan untuk halaman ini atau tidak.

Untuk halaman yang diambil datanya sebelumnya, Anda akan melihat pesan berhasil saat halaman tersebut dibuka:

Tab Pemuatan spekulatif Chrome DevTools yang menampilkan pengambilan data yang berhasil
Tab Pemuatan spekulatif Chrome DevTools yang menampilkan pengambilan data yang berhasil

Spekulasi yang tidak cocok

Saat navigasi terjadi dari halaman dengan aturan spekulasi yang tidak menghasilkan pengambilan data atau pra-rendering yang digunakan, bagian tambahan pada tab akan menampilkan detail selengkapnya tentang alasan URL tidak cocok dengan URL spekulasi mana pun. Hal ini berguna untuk menemukan kesalahan ketik dalam aturan spekulasi Anda.

Tab Pemuatan spekulatif Chrome DevTools, yang menunjukkan bahwa URL saat ini tidak cocok dengan URL apa pun dalam aturan spekulasi halaman sebelumnya
URL yang tidak cocok ditandai di DevTools

Misalnya, di sini kita membuka next4.html, tetapi hanya next.html, next2.html, atau next3.html yang merupakan pengambilan data sebelumnya, sehingga kita dapat melihat bahwa ini tidak cocok dengan ketiga aturan tersebut.

Tab Speculative loads sangat berguna untuk men-debug aturan spekulasi itu sendiri, dan menemukan error sintaksis dalam JSON.

Untuk pengambilan data itu sendiri, panel Jaringan mungkin merupakan tempat yang lebih dikenal. Untuk contoh kegagalan pengambilan data, Anda dapat melihat 404 untuk pengambilan data di sini:

Panel Jaringan Chrome DevTools yang menampilkan prefetch yang gagal
Panel Jaringan Chrome DevTools yang menampilkan prefetch yang gagal

Namun, tab Beban spekulatif menjadi jauh lebih berguna untuk pra-rendering aturan spekulasi, yang akan dibahas berikutnya.

Aturan spekulasi untuk prerender

Aturan spekulasi pra-rendering mengikuti sintaksis yang sama dengan aturan spekulasi pengambilan data. Contoh:

<script type="speculationrules">
  {
    "prerender": [
      {
        "source": "list",
        "urls": ["next.html", "next2.html"]
      }
    ]
  }
</script>

Kumpulan aturan ini memicu pemuatan dan rendering penuh halaman yang ditentukan (tunduk pada batasan tertentu). Hal ini dapat memberikan pengalaman pemuatan instan—meskipun dengan biaya resource tambahan.

Namun, tidak seperti pengambilan data, data ini tidak dapat dilihat di panel Jaringan, karena data ini diambil dan dirender dalam proses rendering terpisah di Chrome. Hal ini membuat tab Beban spekulatif lebih penting untuk men-debug aturan spekulasi pra-rendering.

Men-debug prerender dengan tab Pemuatan spekulatif

Layar Pemuatan spekulatif yang sama dapat digunakan untuk aturan spekulasi pra-render seperti yang ditunjukkan dengan halaman demo serupa yang mencoba melakukan pra-render, bukan mengambil tiga halaman terlebih dahulu:

Chrome DevTools Spekulatif memuat tab untuk halaman dengan aturan spekulasi pra-render
Tab Pemuatan Spekulatif Chrome DevTools untuk halaman dengan aturan spekulasi pra-rendering

Di sini kita melihat lagi bahwa salah satu dari tiga URL gagal diprarender, dan developer dapat mendapatkan detail per URL di tab Speculations dengan mengklik link 2 Ready, 1 Failure.

Di Chrome 121, kami meluncurkan dukungan aturan dokumen. Hal ini memungkinkan browser mengambilnya dari link origin yang sama di halaman, bukan mencantumkan kumpulan URL tertentu:

<script type="speculationrules">
{
  "prerender": [
    {
      "source": "document",
      "where": {
        "and": [
          {"href_matches": "/*"},
          {"not": { "href_matches": "/not-safe-to-prerender/*"}}
        ]
      },
      "eagerness": "moderate"
    }
  ]
}
</script>

Contoh ini memilih semua link dengan origin yang sama, kecuali yang dimulai dengan /not-safe-to-prerender sebagai kandidat pra-render.

Fungsi ini juga menetapkan pra-rendering eagerness ke moderate yang berarti navigasi dipra-render saat link diarahkan kursor, atau diklik.

Ada aturan serupa seperti ini di situs demo aturan spekulatif, dan menggunakan bagian Beban spekulatif baru di situs ini menunjukkan kegunaan tab baru ini karena semua URL yang memenuhi syarat yang ditemukan browser di halaman tercantum:

Tab Spekulasi Chrome DevTools dengan sejumlah URL yang Tidak dipicu
Tab Spekulasi Chrome DevTools dengan sejumlah URL yang Tidak dipicu

Status adalah Not triggered karena proses pra-rendering untuk ini belum dimulai. Namun, saat mengarahkan kursor ke link, kita akan melihat perubahan status saat setiap URL dipra-render:

Tab Spekulasi Chrome DevTools dengan halaman pra-rendering yang dipicu
Tab Spekulasi Chrome DevTools dengan halaman pra-rendering yang dipicu

Chrome telah menetapkan batas pada pra-rendering, termasuk maksimum 2 pra-rendering untuk kesiapan moderate, sehingga setelah mengarahkan kursor ke link ke-3, kita akan melihat alasan kegagalan untuk URL tersebut:

Tab Spekulasi Chrome DevTools dengan pemuatan awal yang gagal ditampilkan
Tab Spekulasi Chrome DevTools dengan pemuatan awal yang gagal ditampilkan

Men-debug prerender dengan panel DevTools lainnya

Tidak seperti pengambilan data, halaman yang telah dipra-render tidak akan muncul dalam proses rendering saat ini di panel DevTools seperti panel Jaringan, karena halaman tersebut dirender di perender di balik layarnya sendiri.

Namun, sekarang Anda dapat mengganti perender yang digunakan oleh panel DevTools dengan menu drop-down di drop-down kanan atas, atau dengan memilih URL di bagian atas panel dan memilih Inspect:

Chrome DevTools kini memungkinkan Anda beralih perender yang menampilkan informasi
Chrome DevTools kini memungkinkan Anda beralih perender yang menampilkan informasi

Drop-down ini (dan nilai yang dipilih) juga dibagikan di semua panel lainnya, seperti panel Jaringan, tempat Anda dapat melihat halaman yang diminta adalah halaman yang dirender sebelumnya:

Panel Jaringan Chrome DevTools yang menampilkan permintaan jaringan untuk halaman yang diprarender
Panel Jaringan Chrome DevTools yang menampilkan permintaan jaringan untuk halaman yang dirender sebelumnya

Dengan melihat header HTTP untuk resource ini, kita dapat melihat bahwa semuanya akan ditetapkan dengan header Sec-Purpose: prefetch;prerender:

Panel Jaringan Chrome DevTools yang menampilkan header Sec-Purpose untuk halaman yang dirender sebelumnya
Panel Jaringan Chrome DevTools yang menampilkan header Sec-Purpose untuk halaman yang dirender sebelumnya

Atau panel Elemen, tempat Anda dapat melihat konten halaman, seperti pada screenshot berikut yang menampilkan elemen <h1> untuk halaman yang dirender sebelumnya:

Panel Elements Chrome DevTools untuk halaman yang diprarender
Panel Elements Chrome DevTools untuk halaman yang diprarender

Atau panel Konsol, tempat Anda dapat melihat log konsol yang dikeluarkan oleh halaman yang diprarender:

Panel Konsol Chrome DevTools yang menampilkan output konsol dari halaman yang dirender sebelumnya
Panel Konsol Chrome DevTools yang menampilkan output konsol dari halaman yang dirender sebelumnya

Men-debug aturan spekulasi di halaman pra-rendering

Bagian sebelumnya membahas cara men-debug halaman pra-rendering di halaman yang memulai pra-rendering. Namun, halaman yang diprarender itu sendiri juga dapat memberikan informasi proses debug, baik dengan melakukan panggilan analisis atau mencatat ke konsol (yang dapat dilihat seperti yang dijelaskan di bagian sebelumnya).

Selain itu, setelah halaman yang diprarender diaktifkan oleh pengguna yang membukanya, tab Pemuatan spekulatif akan menampilkan status ini, dan apakah halaman berhasil diprarender atau tidak. Jika tidak dapat dipra-render, penjelasan tentang alasannya akan diberikan:

Tab Pemuatan spekulatif Chrome DevTools menampilkan halaman pra-rendering yang berhasil dan gagal
Tab Pemuatan spekulatif Chrome DevTools yang menampilkan halaman pra-rendering yang berhasil dan gagal

Selain itu—seperti halnya pengambilan data—membuka halaman dengan aturan spekulasi yang tidak cocok dengan halaman saat ini akan mencoba menunjukkan alasan URL tidak cocok dengan URL yang tercakup dalam aturan spekulasi halaman sebelumnya di tab Pemuatan spekulatif:

Tab pemuatan Spekulatif Chrome DevTools yang menampilkan ketidakcocokan URL dari URL saat ini dan URL yang tercakup oleh halaman sebelumnya
Chrome DevTools menampilkan ketidakcocokan URL

Kesimpulan

Dalam postingan ini, kami telah menunjukkan berbagai cara yang dapat dilakukan developer untuk men-debug aturan spekulasi pramuat dan pra-render. Tim kami terus berupaya mengembangkan alat untuk aturan spekulasi, dan kami ingin mendengar saran dari developer tentang cara lain yang akan membantu proses debug API baru yang menarik ini. Sebaiknya developer melaporkan masalah di issue tracker Chrome untuk permintaan fitur atau bug yang ditemukan.

Ucapan terima kasih

Gambar thumbnail oleh Nubelson Fernandes di Unsplash.