Gérer les événements avec les service workers

Tutoriel sur les concepts d'extension Service Worker

Présentation

Ce tutoriel présente les service workers des extensions Chrome. Dans ce tutoriel, vous allez créer une extension permettant aux utilisateurs d'accéder rapidement aux pages de référence de l'API Chrome à l'aide de l'omnibox. Vous allez apprendre à effectuer les tâches suivantes :

• Enregistrez votre service worker et vos modules d'importation.
• Déboguer votre service worker d'extension
• Gérer l'état et les événements
• Déclencher des événements périodiques
• Communiquer à l'aide de scripts de contenu

Avant de commencer

Ce guide suppose que vous disposez d'une expérience de base en développement Web. Nous vous recommandons de consulter les sections Extensions 101 et Hello World pour une introduction au développement d'extensions.

Créer l'extension

Commencez par créer un répertoire nommé quick-api-reference qui contiendra les fichiers d'extension, ou téléchargez le code source à partir de notre dépôt d'exemples GitHub.

Étape 1: Enregistrer le service worker

Créez le fichier manifest à la racine du projet et ajoutez le code suivant:

manifest.json:

{
  "manifest_version": 3,
  "name": "Open extension API reference",
  "version": "1.0.0",
  "icons": {
    "16": "images/icon-16.png",
    "128": "images/icon-128.png"
  },
  "background": {
    "service_worker": "service-worker.js",
  },
}

Les extensions enregistrent leur service worker dans le fichier manifeste, ce qui n'accepte qu'un seul fichier JavaScript. Il n'est pas nécessaire d'appeler navigator.serviceWorker.register(), comme vous le feriez dans une page Web.

Créez un dossier images, puis téléchargez les icônes dans celui-ci.

Consultez les premières étapes du tutoriel sur le temps de lecture pour en savoir plus sur les métadonnées et les icônes de l'extension dans le fichier manifeste.

Étape 2: Importez plusieurs modules de service worker

Notre service worker implémente deux fonctionnalités. Pour faciliter la gestion, nous implémenterons chaque fonctionnalité dans un module distinct. Tout d'abord, nous devons déclarer le service worker en tant que module ES dans notre fichier manifeste, ce qui nous permet d'importer des modules dans notre service worker:

manifest.json:

{
 "background": {
    "service_worker": "service-worker.js",
    "type": "module"
  },
}

Créez le fichier service-worker.js et importez deux modules:

import './sw-omnibox.js';
import './sw-tips.js';

Créez ces fichiers et ajoutez-y un journal de console.

console.log("sw-omnibox.js")

console.log("sw-tips.js")

Pour découvrir d'autres façons d'importer plusieurs fichiers dans un service worker, consultez la page Importer des scripts.

Facultatif: Déboguer le service worker

Je vais vous expliquer comment trouver les journaux du service worker et savoir quand cela a pris fin. Tout d'abord, suivez les instructions pour charger une extension non empaquetée.

Au bout de 30 secondes, le message "Service worker (inactif)" s'affiche, ce qui signifie qu'il a arrêté le service. Cliquez sur le lien "Service worker (inactif)" pour l'inspecter. L'animation suivante illustre ce processus.

Avez-vous remarqué que l'inspection du service worker l'a réveillé ? Si vous ouvrez le service worker dans les outils de développement, il restera actif. Pour vous assurer que votre extension se comporte correctement en cas d'arrêt de votre service worker, pensez à fermer les outils de développement.

À présent, interrompez l'extension pour savoir où localiser les erreurs. Pour ce faire, vous pouvez supprimer ".js" de l'importation './sw-omnibox.js' dans le fichier service-worker.js. Chrome ne pourra pas enregistrer le service worker.

Revenez à la page chrome://extensions et actualisez l'extension. Deux erreurs s'affichent:

Service worker registration failed. Status code: 3.

An unknown error occurred when fetching the script.

Consultez Déboguer les extensions pour découvrir d'autres façons de déboguer le service worker d'extension.

Étape 4: Initialiser l'état

Chrome fermera les service workers qui ne sont pas nécessaires. Nous utilisons l'API chrome.storage pour conserver l'état entre les sessions des service workers. Pour accéder à l'espace de stockage, nous devons demander une autorisation dans le fichier manifeste:

manifest.json:

{
  ...
  "permissions": ["storage"],
}

Commencez par enregistrer les suggestions par défaut dans l'espace de stockage. Nous pouvons initialiser l'état lorsque l'extension est installée pour la première fois en écoutant l'événement runtime.onInstalled():

sw-omnibox.js:

...
// Save default API suggestions
chrome.runtime.onInstalled.addListener(({ reason }) => {
  if (reason === 'install') {
    chrome.storage.local.set({
      apiSuggestions: ['tabs', 'storage', 'scripting']
    });
  }
});

Les service workers n'ont pas d'accès direct à l'objet window et ne peuvent donc pas utiliser window.localStorage pour stocker des valeurs. De plus, les service workers sont des environnements d'exécution de courte durée. Ils sont arrêtés à plusieurs reprises lors de la session de navigateur de l'utilisateur, ce qui les rend incompatibles avec les variables globales. Utilisez plutôt chrome.storage.local, qui stocke les données sur la machine locale.

Pour en savoir plus sur les autres options de stockage pour les service workers d'extension, consultez Persistance des données au lieu d'utiliser des variables globales.

Étape 5: Enregistrez vos événements

Tous les écouteurs d'événements doivent être enregistrés de manière statique dans le champ d'application global du service worker. En d'autres termes, les écouteurs d'événements ne doivent pas être imbriqués dans des fonctions asynchrones. Chrome peut ainsi garantir la restauration de tous les gestionnaires d'événements en cas de redémarrage d'un service worker.

Dans cet exemple, nous allons utiliser l'API chrome.omnibox, mais nous devons d'abord déclarer le déclencheur du mot clé de l'omnibox dans le fichier manifeste:

manifest.json:

{
  ...
  "minimum_chrome_version": "102",
  "omnibox": {
    "keyword": "api"
  },
}

À présent, enregistrez les écouteurs d'événements de l'omnibox au niveau supérieur du script. Lorsque l'utilisateur saisit le mot clé de l'omnibox (api) dans la barre d'adresse, suivi d'une tabulation ou d'un espace, Chrome affiche une liste de suggestions basées sur les mots clés stockés dans l'espace de stockage. L'événement onInputChanged(), qui utilise l'entrée utilisateur actuelle et un objet suggestResult, est chargé de renseigner ces suggestions.

sw-omnibox.js:

...
const URL_CHROME_EXTENSIONS_DOC =
  'https://developer.chrome.com/docs/extensions/reference/';
const NUMBER_OF_PREVIOUS_SEARCHES = 4;

// Display the suggestions after user starts typing
chrome.omnibox.onInputChanged.addListener(async (input, suggest) => {
  await chrome.omnibox.setDefaultSuggestion({
    description: 'Enter a Chrome API or choose from past searches'
  });
  const { apiSuggestions } = await chrome.storage.local.get('apiSuggestions');
  const suggestions = apiSuggestions.map((api) => {
    return { content: api, description: `Open chrome.${api} API` };
  });
  suggest(suggestions);
});

Lorsque l'utilisateur sélectionne une suggestion, onInputEntered() ouvre la page de référence de l'API Chrome correspondante.

sw-omnibox.js:

...
// Open the reference page of the chosen API
chrome.omnibox.onInputEntered.addListener((input) => {
  chrome.tabs.create({ url: URL_CHROME_EXTENSIONS_DOC + input });
  // Save the latest keyword
  updateHistory(input);
});

La fonction updateHistory() prend l'entrée de l'omnibox et l'enregistre dans storage.local. Ainsi, le terme de recherche le plus récent peut être utilisé ultérieurement comme suggestion dans l'omnibox.

sw-omnibox.js:

...
async function updateHistory(input) {
  const { apiSuggestions } = await chrome.storage.local.get('apiSuggestions');
  apiSuggestions.unshift(input);
  apiSuggestions.splice(NUMBER_OF_PREVIOUS_SEARCHES);
  return chrome.storage.local.set({ apiSuggestions });
}

Étape 6: Configurez un événement périodique

Les méthodes setTimeout() ou setInterval() sont couramment utilisées pour effectuer des tâches retardées ou périodiques. Toutefois, ces API peuvent échouer, car le programmeur annule les minuteurs lorsque le service worker est arrêté. À la place, les extensions peuvent utiliser l'API chrome.alarms.

Commencez par demander l'autorisation "alarms" dans le fichier manifeste. De plus, pour récupérer les conseils d'extension à partir d'un emplacement hébergé à distance, vous devez demander l'autorisation d'hôte:

manifest.json:

{
  ...
  "permissions": ["storage", "alarms"],
  "permissions": ["storage"],
  "host_permissions": ["https://extension-tips.glitch.me/*"],
}

L'extension va récupérer tous les conseils, en choisir un au hasard et l'enregistrer dans l'espace de stockage. Nous allons créer une alarme qui se déclenchera une fois par jour pour mettre à jour le pourboire. Les alarmes ne sont pas enregistrées lorsque vous fermez Chrome. Nous devons donc vérifier si l'alarme existe et la créer si ce n'est pas le cas.

sw-tips.js:

// Fetch tip & save in storage
const updateTip = async () => {
  const response = await fetch('https://extension-tips.glitch.me/tips.json');
  const tips = await response.json();
  const randomIndex = Math.floor(Math.random() * tips.length);
  return chrome.storage.local.set({ tip: tips[randomIndex] });
};

const ALARM_NAME = 'tip';

// Check if alarm exists to avoid resetting the timer.
// The alarm might be removed when the browser session restarts.
async function createAlarm() {
  const alarm = await chrome.alarms.get(ALARM_NAME);
  if (typeof alarm === 'undefined') {
    chrome.alarms.create(ALARM_NAME, {
      delayInMinutes: 1,
      periodInMinutes: 1440
    });
    updateTip();
  }
}

createAlarm();

// Update tip once a day
chrome.alarms.onAlarm.addListener(updateTip);

Étape 7: Communiquez dans d'autres contextes

Les extensions utilisent des scripts de contenu pour lire et modifier le contenu de la page. Lorsqu'un utilisateur consulte une page de référence de l'API Chrome, le script de contenu de l'extension met à jour la page avec le conseil du jour. Il envoie un message pour demander le pourboire du jour au service worker.

Commencez par déclarer le script de contenu dans le fichier manifeste, puis ajoutez le format de correspondance correspondant à la documentation de référence de l'API Chrome.

manifest.json:

{
  ...
  "content_scripts": [
    {
      "matches": ["https://developer.chrome.com/docs/extensions/reference/*"],
      "js": ["content.js"]
    }
  ]
}

Créez un fichier de contenu. Le code suivant envoie un message au service worker demandant le pourboire. Ajoute ensuite un bouton qui ouvre une fenêtre contextuelle contenant l'astuce de l'extension. Ce code utilise la nouvelle API Popover de la plate-forme Web.

content.js:

(async () => {
  // Sends a message to the service worker and receives a tip in response
  const { tip } = await chrome.runtime.sendMessage({ greeting: 'tip' });

  const nav = document.querySelector('.upper-tabs > nav');
  
  const tipWidget = createDomElement(`
    <button type="button" popovertarget="tip-popover" popovertargetaction="show" style="padding: 0 12px; height: 36px;">
      <span style="display: block; font: var(--devsite-link-font,500 14px/20px var(--devsite-primary-font-family));">Tip</span>
    </button>
  `);

  const popover = createDomElement(
    `<div id='tip-popover' popover style="margin: auto;">${tip}</div>`
  );

  document.body.append(popover);
  nav.append(tipWidget);
})();

function createDomElement(html) {
  const dom = new DOMParser().parseFromString(html, 'text/html');
  return dom.body.firstElementChild;
}

La dernière étape consiste à ajouter un gestionnaire de messages à notre service worker qui envoie une réponse au script de contenu avec le pourboire du jour.

sw-tips.js:

...
// Send tip to content script via messaging
chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
  if (message.greeting === 'tip') {
    chrome.storage.local.get('tip').then(sendResponse);
    return true;
  }
});

Tester son fonctionnement

Vérifiez que la structure de fichiers de votre projet se présente comme suit:

Charger votre extension en local

Pour charger une extension non empaquetée en mode développeur, suivez la procédure décrite dans Hello World.

Ouvrir une page de référence

1. Saisissez le mot clé "api" dans la barre d'adresse du navigateur.
2. Appuyez sur la touche de tabulation ou la barre d'espace.
3. Saisissez le nom complet de l'API.
   • OU choisissez-en une dans la liste des recherches précédentes.
4. Une nouvelle page s'ouvre sur la page de référence de l'API Chrome.

Votre écran devrait ressembler à ceci :

Ouvrir le conseil du jour

Cliquez sur le bouton Conseil situé dans la barre de navigation pour ouvrir l'info-bulle relative à l'extension.

Aspera Des améliorations potentielles

En vous basant sur ce que vous avez appris aujourd'hui, essayez d'accomplir l'une des actions suivantes:

• Découvrez une autre façon d'implémenter les suggestions de l'omnibox.
• Créez votre propre modale personnalisée pour afficher le conseil de l'extension.
• Ouvrez une page supplémentaire sur les pages de l'API de référence des extensions Web de MDN.

Continuez de développer !

Félicitations, vous avez terminé ce tutoriel 🎉. Continuez à améliorer vos compétences en suivant d'autres tutoriels pour débutants:

Continuer à explorer

Pour poursuivre votre parcours de formation sur les Extensions Service Worker, nous vous recommandons de consulter les articles suivants:

• À propos des service workers d'extension
• Cycle de vie d'un service worker d'extension.
• Événements dans les service workers