Métaprogrammation

À partir d'ECMAScript 2015, JavaScript fournit les objets natifs Proxy et Reflect. Ces objets permettent d'intercepter et de définir des comportements spécifiques pour certaines opérations fondamentales du langage (par exemple la recherche d'une propriété, l'affectation, l'énumération, l'appel d'une fonction, etc.). Grâce à ces deux objets, il est possible d'interagir avec le langage lui-même (on parle alors de métaprogrammation).

Les proxies

Introduits avec ECMAScript 2015, les objets Proxy permettent d'intercepter certaines opérations JavaScript et de définir le comportement à avoir quand celles-ci se produisent. Par exemple, on peut intercepter l'accès à une propriété d'un objet :

var handler = {
  get: function (cible, nom) {
    return nom in cible ? cible[nom] : 42;
  },
};
var p = new Proxy({}, handler);
p.a = 1;
console.log(p.a, p.b); // 1, 42

Ici, l'objet Proxy définit une cible (ici c'est un objet vide) et un gestionnaire (handler) qui implémente une trappe pour l'opération get. Ainsi, l'objet qui est « proxyfié » ne renverra pas undefined lorsqu'on tentera d'accéder à une propriété qui n'est pas définie, à la place le nombre 42 sera renvoyé.

Note : D'autres exemples sont disponibles sur la page de l'objet Proxy.

Terminologie

Lorsqu'on utilise les proxies et leurs fonctionnalités, on utilisera les termes suivants :

gestionnaire (handler): L'objet qui contient les trappes.
trappes: Les méthodes qui fournissent l'accès aux propriétés. Ce concept est analogue aux trappes utilisées dans les systèmes d'exploitations.
cible: L'objet que le proxy virtualise. C'est généralement un objet utilisé en arrière-plan pour stocker les informations. Les invariants (c'est-à-dire les éléments sémantiques qui doivent rester inchangés) concernant le caractère non-extensible de l'objet ou l'aspect non-configurable des propriétés sont vérifiés par rapport à cet objet cible.
invariants: Les éléments sémantiques qui ne doivent pas être modifiés par les opérations définies dans les proxies. Si un invariant n'est pas respecté au sein d'un gestionnaire, cela provoquera une exception TypeError.

Les gestionnaires et les trappes

Le tableau suivant résume les différentes trappes disponibles pour les objets Proxy. Pour plus d'explications et de détails, voir les différents pages de la référence sur chacun de ces concepts.

Gestionnaires / Trappes	Opérations interceptées	Invariants
`handler.getPrototypeOf()`	`Object.getPrototypeOf()` `Reflect.getPrototypeOf()` `__proto__` `Object.prototype.isPrototypeOf()` `instanceof`	`getPrototypeOf` doit renvoyer un objet ou `null`. Si `cible` n'est pas extensible, `Object.getPrototypeOf(proxy)` doit renvoyer le même objet que `Object.getPrototypeOf(cible)`.
`handler.setPrototypeOf()`	`Object.setPrototypeOf()` `Reflect.setPrototypeOf()`	Si `cible` n'est pas extensible, le paramètre `prototype` doit être la même valeur que `Object.getPrototypeOf(cible)`.
`handler.isExtensible()`	`Object.isExtensible()` `Reflect.isExtensible()`	`Object.isExtensible(proxy)` doit renvoyer la même valeur que `Object.isExtensible(target)`.
`handler.preventExtensions()`	`Object.preventExtensions()` `Reflect.preventExtensions()`	`Object.preventExtensions(proxy)` ne renvoie `true` que si `Object.isExtensible(proxy)` vaut `false`.
`handler.getOwnPropertyDescriptor()`	`Object.getOwnPropertyDescriptor()` `Reflect.getOwnPropertyDescriptor()`	`getOwnPropertyDescriptor` doit renvoyer un objet ou `undefined`. Une propriété ne peut pas être vue comme non-existante si elle existe comme une propriété propre non-configurable de l'objet cible. Une propriété ne peut pas être vue comme non-existante si elle existe comme une propriété propre de la cible et que l'objet cible n'est pas extensible. Une propriété ne peut pas être vue comme existante si elle n'existe pas comme une propriété propre de l'objet cible et que l'objet cible n'est pas extensible. Une propriété ne peut pas être vue comme non-configurable si elle n'existe pas comme une propriété propre de l'objet cible ou si elle existe comme une propriété configurable propre de l'objet cible. Le résultat de `Object.getOwnPropertyDescriptor(cible)` peut être appliqué à la cible en utilisant `Object.defineProperty` sans que cela ne lève d'exception.
`handler.defineProperty()`	`Object.defineProperty()` `Reflect.defineProperty()`	Une propriété ne peut pas être ajoutée si l'objet cible n'est pas extensible. Une propriété ne peut pas être ajoutée ou être modifiée afin d'être non-configurable si elle n'existe pas comme une propriété propre de l'objet cible et qu'elle n'est pas non-configurable. Une propriété peut ne pas être non-configurable si une propriété correspondante configurable existe sur l'objet cible. Si une propriété possède une propriété correspondante sur l'objet cible, `Object.defineProperty(cible, prop, descripteur)` ne doit pas renvoyer d'exception. En mode strict, si la valeur de retour de `defineProperty` est `false`, cela entraînera une exception `TypeError` exception.
`handler.has()`	Requête d'une propriété : `toto in proxy` Requête d'une propriété héritée : `toto in Object.create(proxy)` `Reflect.has()`	Une propriété ne peut pas être vue comme non-existante si elle existe comme propriété propre non-configurable de l'objet cible. Une propriété ne peut pas être vue comme non-existante si elle existe comme propriété propre de l'objet cible et que l'objet cible n'est pas extensible.
`handler.get()`	Accès à une propriété : `proxy[toto]` et `proxy.truc` Accès à une propriété héritée : `Object.create(proxy)[toto]` `Reflect.get()`	La valeur rapportée pour la propriété doit être la même que la valeur de la propriété correspondante sur l'objet cible si celle-ci est une propriété de donnée non accessible en écriture et non-configurable.. La valeur rapportée pour une propriété doit être `undefined` si la propriété correspondante de l'objet cible est une propriété d'accesseur dont l'attribut [[Get]] vaut `undefined`.
`handler.set()`	Affection d'une propriété : `proxy[toto] = truc` et `proxy.toto = truc` Affectation d'une propriété héritée : `Object.create(proxy)[toto] = truc` `Reflect.set()`	Il est impossible de modifier la valeur d'une propriété pour que celle-ci soit différente de la valeur de la propriété correspondante de l'objet cible si la propriété de l'objet cible est une propriété de donnée qui n'est pas accessible en écriture et qui n'est pas configurable. Il est impossible de modifier la valeur d'une propriété si la propriété correspondante de l'objet cible est une propriété d'accesseur non-configurable dont l'attribut [[Set]] vaut `undefined`. En mode strict, si le gestionnaire pour `set` renvoie `false`, cela provoquera une exception `TypeError`.
`handler.deleteProperty()`	Suppression d'une propriété : `delete proxy[toto]` et `delete proxy.toto` `Reflect.deleteProperty()`	Une propriété ne peut pas être supprimée si elle existe comme une propriété propre non-configurable de l'objet cible.
`handler.enumerate()`	Lister les propriétés avec `for...in` : `for (var nom in proxy) {...}` `Reflect.enumerate()`	La méthode `enumerate` doit renvoyer un objet.
`handler.ownKeys()`	`Object.getOwnPropertyNames()` `Object.getOwnPropertySymbols()` `Object.keys()` `Reflect.ownKeys()`	Le résultat de `ownKeys` est une liste. Le type de chaque élément de la liste est soit une `String` soit un `Symbol`. La liste résultatnte doit contenir les clés de toutes les propriétés non-configurables de l'objet cible. Si l'objet cible n'est pas extensible, la liste résultante doit contenir toutes les clés des propriétés propres de l'objet cibles et aucune autre valeur.
`handler.apply()`	`proxy(..args)` `Function.prototype.apply()` and `Function.prototype.call()` `Reflect.apply()`	Il n'y a pas d'invariant pour la méthode `handler.apply`.
`handler.construct()`	`new proxy(...args)` `Reflect.construct()`	Le résultat doit être un `Objet`.

Proxies révocables

La méthode Proxy.revocable() est utilisée pour créer un objet Proxy qui puisse être révoqué. Cela signifie que que le proxy pourra être révoqué avec la fonction revoke et arrêtera le proxy. Après cet arrêt, toute opération sur le proxy entraînera une exception TypeError.

var revocable = Proxy.revocable(
  {},
  {
    get: function (cible, nom) {
      return "[[" + nom + "]]";
    },
  },
);
var proxy = revocable.proxy;
console.log(proxy.toto); // "[[toto]]"

revocable.revoke();

console.log(proxy.toto); // déclenche une TypeError
proxy.toto = 1; // une TypeError encore
delete proxy.toto; // toujours une TypeError
typeof proxy; // "object", typeof ne déclenche aucune trappe

Réflexion

Reflect est un objet natif qui fournit des méthodes pour les opérations JavaScript qui peuvent être interceptées. Ces méthodes sont les mêmes que celles gérées par les gestionnaires de proxy. Reflect n'est pas un constructeur et ne peut pas être utilisé comme une fonction !

Reflect aide à transférer les opérations par défaut depuis le gestionnaire vers la cible.

Par exemple, avec Reflect.has(), on obtient le comportement de l'opérateur in sous forme d'une fonction :

Reflect.has(Object, "assign"); // true