Mengupdate kode

Pembaruan yang tidak terkait dengan masalah lain

Ini adalah bagian pertama dari tiga bagian yang menjelaskan perubahan yang diperlukan untuk kode yang bukan bagian dari pekerja layanan ekstensi. Bagian ini ditujukan untuk perubahan kode wajib yang tidak terkait dengan masalah lain. Dua bagian berikutnya membahas mengganti permintaan web yang diblokir dan meningkatkan keamanan.

Mengganti tab.ExecuteScript() dengan scripting.executeScript()

Di Manifes V3, executeScript() berpindah dari tabs API ke scripting API. Hal ini memerlukan perubahan pada izin di file manifes selain perubahan kode aktual.

Untuk metode executeScript(), Anda memerlukan:

• Izin "scripting".
• Izin host atau izin "activeTab".

Metode scripting.executeScript() mirip dengan cara kerjanya dengan tabs.executeScript(). Ada beberapa perbedaan.

• Meskipun metode lama hanya dapat mengambil satu file, metode baru dapat mengambil array file.
• Anda juga meneruskan objek ScriptInjection, bukan InjectDetails. Ada beberapa perbedaan di antara keduanya. Misalnya, tabId kini diteruskan sebagai anggota ScriptInjection.target, bukan sebagai argumen metode.

Contoh tersebut menunjukkan cara melakukannya.

async function getCurrentTab() {/* ... */}
let tab = await getCurrentTab();

chrome.tabs.executeScript(
  tab.id,
  {
    file: 'content-script.js'
  }
);

async function getCurrentTab()
let tab = await getCurrentTab();

chrome.scripting.executeScript({
  target: {tabId: tab.id},
  files: ['content-script.js']
});

Ganti tab.insertCSS() dansertas.removeCSS() dengan scripting.insertCSS() dan scripting.removeCSS()

Di Manifes V3, insertCSS() dan removeCSS() berpindah dari tabs API ke scripting API. Perubahan ini memerlukan perubahan pada izin di file manifes selain perubahan kode:

• Izin "scripting".
• Izin host atau izin "activeTab".

Fungsi di scripting API mirip dengan fungsi di tabs. Ada beberapa perbedaan.

• Saat memanggil metode ini, Anda meneruskan objek CSSInjection, bukan InjectDetails.
• tabId kini diteruskan sebagai anggota CSSInjection.target, bukan sebagai argumen metode.

Contoh ini menunjukkan cara melakukannya untuk insertCSS(). Prosedur untuk removeCSS() sama.

chrome.tabs.insertCSS(tabId, injectDetails, () => {
  // callback code
});

const insertPromise = await chrome.scripting.insertCSS({
  files: ["style.css"],
  target: { tabId: tab.id }
});
// Remaining code. 

Mengganti Tindakan Browser dan Tindakan Halaman dengan Tindakan

Tindakan browser dan tindakan halaman adalah konsep terpisah di Manifes V2. Meskipun mereka memulai dengan peran yang berbeda, perbedaan di antara mereka menurun seiring waktu. Di Manifes V3, konsep ini digabungkan ke dalam Action API. Proses ini memerlukan perubahan pada manifest.json dan kode ekstensi yang berbeda dari yang akan Anda masukkan di skrip latar belakang Manifes V2.

Tindakan di Manifes V3 paling mirip dengan tindakan browser; tetapi, action API tidak menyediakan hide() dan show() seperti pageAction. Jika masih memerlukan tindakan halaman, Anda dapat mengemulasikannya menggunakan konten deklaratif atau memanggil enable() atau disable() dengan ID tab.

Ganti "browser_action" dan "page_action" dengan "action"

Di manifest.json, ganti kolom "browser_action" dan "page_action" dengan kolom "action". Lihat referensi untuk informasi tentang kolom "action".

{
  ...
  "page_action": { ... },
  "browser_action": {
    "default_popup": "popup.html"
   }
  ...
}

{
  ...
  "action": {
    "default_popup": "popup.html"
  }

  ...
}

Mengganti browserAction dan pageAction API dengan action API

Jika Manifest V2 menggunakan browserAction dan pageAction API, Anda kini harus menggunakan action API.

chrome.browserAction.onClicked.addListener(tab => { ... });
chrome.pageAction.onClicked.addListener(tab => { ... });

chrome.action.onClicked.addListener(tab => { ... });

Mengganti callback dengan promise

Di Manifes V3, banyak metode API ekstensi menampilkan promise. Promise adalah proxy atau placeholder untuk nilai yang ditampilkan oleh metode asinkron. Jika belum pernah menggunakan Promise, Anda dapat membacanya di MDN. Halaman ini menjelaskan hal-hal yang perlu Anda ketahui untuk menggunakannya di ekstensi Chrome.

Untuk kompatibilitas mundur, banyak metode terus mendukung callback setelah dukungan promise ditambahkan. Perhatikan bahwa Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Jika Anda meneruskan callback, fungsi tersebut tidak akan menampilkan promise dan jika Anda ingin promise yang ditampilkan, jangan meneruskan callback. Beberapa fitur API, seperti pemroses peristiwa, akan terus memerlukan callback. Untuk memeriksa apakah suatu metode mendukung promise, cari label "Promise" dalam referensi API-nya.

Untuk mengonversi dari callback ke promise, hapus callback dan tangani promise yang ditampilkan. Contoh di bawah ini diambil dari contoh izin opsional, khususnya newtab.js. Versi callback menunjukkan tampilan panggilan contoh ke request() dengan callback. Perhatikan bahwa versi promise dapat ditulis ulang dengan async dan await.

chrome.permissions.request(newPerms, (granted) => {
  if (granted) {
    console.log('granted');
  } else {
    console.log('not granted');
  }
});

const newPerms = { permissions: ['topSites'] };
chrome.permissions.request(newPerms)
.then((granted) => {
  if (granted) {
    console.log('granted');
  } else {
    console.log('not granted');
  }
});

Mengganti fungsi yang mengharapkan konteks latar belakang Manifes V2

Konteks ekstensi lainnya hanya dapat berinteraksi dengan pekerja layanan ekstensi menggunakan penyampaian pesan. Akibatnya, Anda harus mengganti panggilan yang mengharapkan konteks latar belakang, khususnya:

• chrome.runtime.getBackgroundPage()
• chrome.extension.getBackgroundPage()
• chrome.extension.getExtensionTabs()

Skrip ekstensi Anda harus menggunakan penerusan pesan untuk berkomunikasi antara pekerja layanan dan bagian lain dari ekstensi Anda. Saat ini, proses tersebut memerlukan penggunaan sendMessage() dan penerapan chrome.runtime.onMessage dalam pekerja layanan ekstensi Anda. Dalam jangka panjang, Anda harus mengganti panggilan ini dengan postMessage() dan pengendali peristiwa pesan pekerja layanan.

Mengganti API yang tidak didukung

Metode dan properti yang tercantum di bawah perlu diubah di Manifes V3.