chrome.events

Description

Concepts et utilisation

Un Event est un objet qui vous permet d'être averti lorsqu'il se passe quelque chose d'intéressant. Voici un exemple d'utilisation de l'événement chrome.alarms.onAlarm pour être averti chaque fois qu'une alarme se termine:

chrome.alarms.onAlarm.addListener((alarm) => {
  appendToLog(`alarms.onAlarm -- name: ${alarm.name}, scheduledTime: ${alarm.scheduledTime}`);
});

Comme le montre l'exemple, vous vous inscrivez pour recevoir des notifications à l'aide de addListener(). L'argument de addListener() est toujours une fonction que vous définissez pour gérer l'événement, mais les paramètres de la fonction dépendent de l'événement que vous gérez. En consultant la documentation de alarms.onAlarm, vous pouvez constater que la fonction comporte un seul paramètre: un objet alarms.Alarm contenant des détails sur l'alarme écoulée.

Exemples d'API utilisant des événements: alarms, i18n, identity, runtime. La plupart des API Chrome le font.

Gestionnaires d'événements déclaratifs

Les gestionnaires d'événements déclaratifs permettent de définir des règles composées de conditions et d'actions déclaratives. Les conditions sont évaluées dans le navigateur plutôt que dans le moteur JavaScript, ce qui réduit les latences aller-retour et offre une efficacité très élevée.

Les gestionnaires d'événements déclaratifs sont utilisés, par exemple, dans Declarative Content API. Cette page décrit les concepts sous-jacents de tous les gestionnaires d'événements déclaratifs.

Règles

La règle la plus simple est constituée d'une ou de plusieurs conditions et d'une ou plusieurs actions:

const rule = {
  conditions: [ /* my conditions */ ],
  actions: [ /* my actions */ ]
};

Si l'une des conditions est remplie, toutes les actions sont exécutées.

En plus des conditions et des actions, vous pouvez attribuer à chaque règle un identifiant, ce qui simplifie l'annulation de l'enregistrement des règles précédemment enregistrées, ainsi qu'une priorité pour définir des priorités entre les règles. Les priorités ne sont prises en compte que si les règles sont en conflit ou doivent être exécutées dans un ordre spécifique. Les actions sont exécutées dans l'ordre décroissant de priorité de leurs règles.

const rule = {
  id: "my rule",  // optional, will be generated if not set.
  priority: 100,  // optional, defaults to 100.
  conditions: [ /* my conditions */ ],
  actions: [ /* my actions */ ]
};

Objets d'événement

Les objets d'événement peuvent accepter des règles. Ces objets d'événement n'appellent pas de fonction de rappel lorsque des événements se produisent, mais vérifient si une règle enregistrée a au moins une condition remplie et exécutent les actions associées à cette règle. Les objets d'événement compatibles avec l'API déclarative sont associés à trois méthodes pertinentes: events.Event.addRules(), events.Event.removeRules() et events.Event.getRules().

Ajouter des règles

Pour ajouter des règles, appelez la fonction addRules() de l'objet événement. Son premier paramètre est un tableau d'instances de règle, ainsi qu'une fonction de rappel appelée une fois l'opération terminée.

const rule_list = [rule1, rule2, ...];
addRules(rule_list, (details) => {...});

Si les règles ont bien été insérées, le paramètre details contient un tableau de règles insérées qui apparaissent dans le même ordre que dans le rule_list transmis, où les paramètres facultatifs id et priority étaient remplis avec les valeurs générées. Si une règle n'est pas valide (par exemple, parce qu'elle contient une condition ou une action non valide), aucune règle n'est ajoutée et la variable runtime.lastError est définie lorsque la fonction de rappel est appelée. Chaque règle de rule_list doit contenir un identifiant unique qui n'est pas déjà utilisé par une autre règle ou un identifiant vide.

Supprimer des règles

Pour supprimer des règles, appelez la fonction removeRules(). Elle accepte un tableau facultatif d'identifiants de règles comme premier paramètre et une fonction de rappel comme deuxième paramètre.

const rule_ids = ["id1", "id2", ...];
removeRules(rule_ids, () => {...});

Si rule_ids est un tableau d'identifiants, toutes les règles comportant des identifiants répertoriés dans le tableau sont supprimées. Si rule_ids indique un identifiant inconnu, cet identifiant est ignoré sans notification. Si rule_ids est défini sur undefined, toutes les règles enregistrées de cette extension sont supprimées. La fonction callback() est appelée lorsque les règles ont été supprimées.

Récupérer les règles

Pour récupérer la liste des règles enregistrées, appelez la fonction getRules(). Elle accepte un tableau facultatif d'identifiants de règles avec la même sémantique que removeRules(), ainsi qu'une fonction de rappel.

const rule_ids = ["id1", "id2", ...];
getRules(rule_ids, (details) => {...});

Le paramètre details transmis à la fonction callback() fait référence à un tableau de règles comprenant des paramètres facultatifs renseignés.

Performances

Pour optimiser les performances, tenez compte des consignes suivantes.

Enregistrez et annulez l'enregistrement de règles de manière groupée. Après chaque enregistrement ou désinscription, Chrome doit mettre à jour les structures de données internes. Cette mise à jour est une opération coûteuse.

const rule1 = {...};
const rule2 = {...};
chrome.declarativeWebRequest.onRequest.addRules([rule1]);
chrome.declarativeWebRequest.onRequest.addRules([rule2]);

const rule1 = {...};
const rule2 = {...};
chrome.declarativeWebRequest.onRequest.addRules([rule1, rule2]);

Privilégiez la correspondance de sous-chaîne aux expressions régulières dans events.UrlFilter. La mise en correspondance basée sur une sous-chaîne est extrêmement rapide.

const match = new chrome.declarativeWebRequest.RequestMatcher({
  url: {urlMatches: "example.com/[^?]*foo" }
});

const match = new chrome.declarativeWebRequest.RequestMatcher({
  url: {hostSuffix: "example.com", pathContains: "foo"}
});

Si plusieurs règles partagent les mêmes actions, fusionnez-les en une seule. Les règles déclenchent leurs actions dès qu'une seule condition est remplie. Cela accélère la mise en correspondance et réduit la consommation de mémoire pour les ensembles d'actions en double.

const condition1 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'example.com' }
});
const condition2 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'foobar.com' }
});
const rule1 = { conditions: [condition1],
                actions: [new chrome.declarativeWebRequest.CancelRequest()]
              };
const rule2 = { conditions: [condition2],
                actions: [new chrome.declarativeWebRequest.CancelRequest()]
              };
chrome.declarativeWebRequest.onRequest.addRules([rule1, rule2]);

const condition1 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'example.com' }
});
const condition2 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'foobar.com' }
});
const rule = { conditions: [condition1, condition2],
              actions: [new chrome.declarativeWebRequest.CancelRequest()]
             };
chrome.declarativeWebRequest.onRequest.addRules([rule]);

Événements filtrés

Les événements filtrés sont un mécanisme qui permet aux écouteurs de spécifier un sous-ensemble d'événements qui les intéressent. Un écouteur qui utilise un filtre n'est pas appelé pour les événements qui ne le transmettent pas, ce qui rend le code d'écoute plus déclaratif et efficace. Un service worker n'a pas besoin d'être activé pour gérer les événements dont il n'a pas besoin.

Les événements filtrés sont destinés à permettre une transition depuis le code de filtrage manuel.

chrome.webNavigation.onCommitted.addListener((event) => {
  if (hasHostSuffix(event.url, 'google.com') ||
      hasHostSuffix(event.url, 'google.com.au')) {
    // ...
  }
});

chrome.webNavigation.onCommitted.addListener((event) => {
  // ...
}, {url: [{hostSuffix: 'google.com'},
          {hostSuffix: 'google.com.au'}]});

Les événements acceptent les filtres spécifiques qui sont pertinents pour cet événement. La liste des filtres compatibles avec un événement est répertoriée dans la documentation de cet événement, dans la section "Filtres".

Lorsque vous faites correspondre des URL (comme dans l'exemple ci-dessus), les filtres d'événement prennent en charge les mêmes fonctionnalités de mise en correspondance d'URL que celles qui peuvent être exprimées avec un events.UrlFilter, à l'exception de la mise en correspondance du schéma et des ports.