Merge pull request #176 from vplentinax/weak

WeakMap and WeakSet

Author: EzequielCaste

1-js/05-data-types/weakmap-weakset/01-recipients-read/solution.md

@@ -0,0 +1,43 @@
+Guardemos los mensajes leídos en `WeakSet`:
+
+```js run
+let messages = [
+  {text: "Hello", from: "John"},
+  {text: "How goes?", from: "John"},
+  {text: "See you soon", from: "Alice"}
+];
+
+let readMessages = new WeakSet();
+
+// se han leído dos mensajes
+readMessages.add(messages[0]);
+readMessages.add(messages[1]);
+// readMessages tiene 2 elementos
+
+// ...¡leamos nuevamente el primer mensaje!
+readMessages.add(messages[0]);
+// readMessages todavía tiene dos únicos elementos
+
+// respuesta: ¿se leyó el mensaje [0]?
+alert("Read message 0: " + readMessages.has(messages[0])); // true
+
+messages.shift();
+// ahora readMessages tiene 1 elemento (técnicamente la memoria puede limpiarse más tarde)
+```
+
+El `WeakEst` permite almacenar un conjunto de mensajes y verificar fácilmente la existencia de un mensaje en él.
+
+Se limpia automáticamente. La desventaja es que no podemos iterar sobre él, no podemos obtener "todos los mensajes leídos" directamente. Pero podemos hacerlo iterando sobre todos los mensajes y filtrando los que están en el conjunto.
+
+Otra solución diferente podría ser agregar una propiedad como `message.isRead = true` a un mensaje después de leerlo. Como los objetos de mensajes son administrados por otro código, generalmente se desaconseja, pero podemos usar una propiedad simbólica para evitar conflictos.
+
+Como esto:
+```js
+// la propiedad simbólica solo es conocida por nuestro código
+let isRead = Symbol("isRead");
+messages[0][isRead] = true;
+```
+
+Ahora el código de terceros probablemente no verá nuestra propiedad adicional.
+
+Aunque los símbolos permiten reducir la probabilidad de problemas, usar `WeakSet` es mejor desde el punto de vista arquitectónico.

1-js/05-data-types/weakmap-weakset/01-recipients-read/task.md

@@ -0,0 +1,23 @@
+importance: 5
+
+---
+
+# Almacenar banderas "no leídas"
+
+Hay un array de mensajes:
+
+```js
+let messages = [
+  {text: "Hello", from: "John"},
+  {text: "How goes?", from: "John"},
+  {text: "See you soon", from: "Alice"}
+];
+```
+
+Su código puede acceder a él, pero los mensajes son administrados por el código de otra persona. Se agregan mensajes nuevos, los códigos viejos se eliminan regularmente con ese código, y usted no sabe los momentos exactos en que sucede.
+
+Ahora, ¿qué estructura de datos podría usar para almacenar información sobre si el mensaje "ha sido leído"? La estructura debe ser adecuada para dar la respuesta "¿se leyó?" para el objeto del mensaje dado.
+
+P.D Cuando un mensaje se elimina de `messages`, también debería desaparecer de su estructura.
+
+P.P.D. No debemos modificar los objetos del mensaje, o agregarles nuestras propiedades. Como son administrados por el código de otra persona, eso puede generarnos resultados no deseados.

1-js/05-data-types/weakmap-weakset/02-recipients-when-read/solution.md

@@ -0,0 +1,15 @@
+
+Para almacenar una fecha, podemos usar `WeakMap`:
+
+```js
+let messages = [
+  {text: "Hello", from: "John"},
+  {text: "How goes?", from: "John"},
+  {text: "See you soon", from: "Alice"}
+];
+
+let readMap = new WeakMap();
+
+readMap.set(messages[0], new Date(2017, 1, 1));
+// // Obeto Date que estudiaremos más tarde
+```

1-js/05-data-types/weakmap-weakset/02-recipients-when-read/task.md

@@ -0,0 +1,21 @@
+importance: 5
+
+---
+
+# Almacenar fechas de lectura
+
+Hay un array semejante al de la actividad anterior [previous task](info:task/recipients-read). La sitación es similar:
+
+```js
+let messages = [
+  {text: "Hello", from: "John"},
+  {text: "How goes?", from: "John"},
+  {text: "See you soon", from: "Alice"}
+];
+```
+
+La pregunta ahora es: ¿qué estructura de datos es la adecuada para almacenar la información: "cuando se leyó el mensaje?".
+
+En la tarea anterior solo necesitábamos almacenar el hecho de "sí / no". Ahora necesitamos almacenar la fecha, y solo debe permanecer en la memoria hasta que el mensaje sea recolectado como basura.
+
+P.D Las fechas se pueden almacenar como objetos de la clase incorporada `Date`, que cubriremos más adelante.

1-js/05-data-types/weakmap-weakset/article.md

@@ -0,0 +1,288 @@
+# WeakMap y WeakSet
+
+Como sabemos por el capítulo  <info:garbage-collection>, el motor de JavaScript almacena un valor en la memoria mientras es accesible(y puede ser potencialmente usado).
+
+Por ejemplo:
+```js
+let john = { name: "John" };
+
+// se puede acceder al objeto, john es su referencia
+
+// sobrescribe la referencia
+john = null;
+
+*!*
+// el objeto será eliminado de la memoria
+*/!*
+```
+
+Por lo general, las propiedades de un objeto o elementos de un array u otra estructura de datos se consideran accesibles y se mantienen en la memoria mientras esa estructura de datos permanezca en la memoria.
+
+Por ejemplo, si colocamos un objeto en un array, mientras el array esté vivo, el objeto también estará vivo, incluso si no hay otras referencias a él.
+
+Como esto:
+
+```js
+let john = { name: "John" };
+
+let array = [ john ];
+
+john = null; // sobrescribe la referencia
+
+*!*
+// John se almacena dentro del array, por lo que no será recolectado por el recolector de basura
+// Lo podemos obtener como array[0]
+*/!*
+```
+
+Similar a eso, si usamos un objeto como la propiedad en un `Map` regular, entonces mientras exista el` Map`, ese objeto también existe. Este objeto ocupa memoria y no puede ser reclamado por el recolector de basura.
+
+Por ejemplo
+
+```js
+let john = { name: "John" };
+
+let map = new Map();
+map.set(john, "...");
+
+john = null; // sobreescribe la referencia
+
+*!*
+// john se almacena dentro de map,
+// podemos obtenerlo usando map.keys ()
+*/!*
+```
+
+`WeakMap` es fundamentalmente diferente en este aspecto. No impide la recolección de basura de propiedades de objetos.
+
+Veamos qué significa esto en los ejemplos.
+
+## WeakMap
+
+La primera diferencia con `Map` es que las propiedades `WeakMap` deben ser objetos, no valores primitivos:
+
+```js run
+let weakMap = new WeakMap();
+
+let obj = {};
+
+weakMap.set(obj, "ok"); // funciona bien (propiedad de objeto)
+
+*!*
+// no puede usar un string como propiedad
+weakMap.set("test", "Whoops"); // Error, porque "test" no es un objeto
+*/!*
+```
+
+Ahora, si usamos un objeto como propiedad y no hay otras referencias a ese objeto, se eliminará de la memoria (y del map) automáticamente.
+
+```js
+let john = { name: "John" };
+
+let weakMap = new WeakMap();
+weakMap.set(john, "...");
+
+john = null; // sobreescribe la referencia
+
+// ¡John se eliminó de la memoria!
+```
+
+Compárelo con el ejemplo del `Map` regular anterior. Ahora, si `john` solo existe como la propiedad de` WeakMap`, se eliminará automáticamente del map (y de la memoria).
+
+`WeakMap` no admite la iteración ni los métodos `keys()`, `values()`, `entries()`, así que no hay forma de obtener todas las propiedades o valores de él.
+
+`WeakMap` tiene solo los siguientes métodos:
+
+- `weakMap.get(propiedad)`
+- `weakMap.set(propiedad, valor)`
+- `weakMap.delete(propiedad)`
+- `weakMap.has(propiedad)`
+
+¿Por qué tanta limitación? Eso es por razones técnicas. Si un objeto ha perdido todas las demás referencias (como `john` en el código anterior), entonces se debe recolectar automáticamente como basura. Pero técnicamente no se especifica exactamente *cuándo se realiza la limpieza*.
+
+El motor de JavaScript decide eso. Puede optar por realizar la limpieza de la memoria inmediatamente o esperar y realizar la limpieza más tarde cuando ocurran más eliminaciones. Por lo tanto, técnicamente no se conoce el recuento actual de elementos de un `WeakMap`. El motor puede haberlo limpiado o no, o lo hizo parcialmente. Por esa razón, los métodos que acceden a todas las propiedades / valores no son compatibles.
+
+Ahora, ¿dónde necesitamos esta estructura de datos?
+
+## Caso de uso: datos adicionales
+
+El área principal de aplicación de `WeakMap` es en un *almacenamiento de datos adicional*.
+
+Si estamos trabajando con un objeto que "pertenece" a otro código, tal vez incluso una biblioteca de terceros, y quisiera almacenar algunos datos asociados con él, eso solo debería existir mientras el objeto esté vivo, entonces `WeakMap` es exactamente lo que se necesita.
+
+Ponemos los datos en un `WeakMap`, utilizando el objeto como propiedad, y cuando el objeto sea recolectado por el recolector de basura, esos datos también desaparecerán automáticamente.
+
+```js
+weakMap.set(john, "secret documents");
+// si John muere, secret documents será destruido automáticamente
+```
+
+Veamos un ejemplo.
+
+Por ejemplo, tenemos un código que mantiene un recuento de visitas para los usuarios. La información se almacena en un mapa: un objeto de usuario es la propiedad y el recuento de visitas es el valor. Cuando un usuario se va (su objeto será recolectado por el recolector de basura), ya no queremos almacenar su recuento de visitas.
+
+Aquí hay un ejemplo de una función de conteo con `Map`:
+
+```js
+// 📁 visitsCount.js
+let visitsCountMap = new Map(); // map: user => visits count
+
+// incrementar el recuento de visitas
+function countUser(user) {
+  let count = visitsCountMap.get(user) || 0;
+  visitsCountMap.set(user, count + 1);
+}
+```
+
+Y aquí hay otra parte del código, tal vez otro archivo usándolo:
+
+```js
+// 📁 main.js
+let john = { name: "John" };
+
+countUser(john); // cuenta sus visitas
+
+// luego John nos deja
+john = null;
+```
+
+Ahora el objeto `john` debería ser recolectado como basura, pero permanece en la memoria, ya que es una propiedad en` visitCountMap`.
+
+Necesitamos limpiar `visitCountMap` cuando eliminamos usuarios, de lo contrario, crecerá en la memoria indefinidamente. Tal limpieza puede convertirse en una tarea tediosa en arquitecturas complejas.
+
+Lo podemos evitar cambiando a `WeakMap` en su lugar:
+
+```js
+// 📁 visitsCount.js
+let visitsCountMap = new WeakMap(); // weakmap: user => visits count
+
+// incrementar el recuento de visitas
+function countUser(user) {
+  let count = visitsCountMap.get(user) || 0;
+  visitsCountMap.set(user, count + 1);
+}
+```
+
+Ahora no tenemos que limpiar `visitasCountMap`. Después de que el objeto `john` se vuelve inalcanzable por todos los medios excepto como una propiedad de` WeakMap`, se elimina de la memoria, junto con la información de esa propiedad de `WeakMap`.
+
+## Caso de uso: almacenamiento en caché
+
+Otro ejemplo común es el almacenamiento en caché: cuando se debe recordar el resultado de una función ("en caché"), para que las llamadas futuras en el mismo objeto lo reutilicen.
+
+Podemos usar `Map` para almacenar resultados, así:
+
+```js run
+// 📁 cache.js
+let cache = new Map();
+
+// calcular y recordar el resultado
+function process(obj) {
+  if (!cache.has(obj)) {
+    let result = /* calculations of the result for */ obj;
+
+    cache.set(obj, result);
+  }
+
+  return cache.get(obj);
+}
+
+*!*
+// Ahora nosotros usamos process() en otro archivo:
+*/!*
+
+// 📁 main.js
+let obj = {/* let's say we have an object */};
+
+let result1 = process(obj); // calculated
+
+// ...después, en otro lugar del código...
+let result2 = process(obj); // resultado recordado tomado de la memoria caché
+
+// ...después, cuando el objeto no se necesitará nada más:
+obj = null;
+
+alert(cache.size); // 1 (Ouch! ¡El objeto todavía está en caché, tomando memoria!)
+```
+
+Para múltiples llamadas de `proceso (obj)` con el mismo objeto, solo calcula el resultado la primera vez, y luego lo toma de `caché`. La desventaja es que necesitamos limpiar el 'caché' cuando el objeto ya no es necesario.
+
+Si reemplazamos `Map` por `WeakMap`, este problema desaparece: el resultado en caché se eliminará de la memoria automáticamente después de que el objeto se recolecte.
+
+```js run
+// 📁 cache.js
+*!*
+let cache = new WeakMap();
+*/!*
+
+// calcular y recordad el resultado
+function process(obj) {
+  if (!cache.has(obj)) {
+    let result = /* calcular el resultado para */ obj;
+
+    cache.set(obj, result);
+  }
+
+  return cache.get(obj);
+}
+
+// 📁 main.js
+let obj = {/* some object */};
+
+let result1 = process(obj);
+let result2 = process(obj);
+
+// ...después, cuando el objeto no se necesitará más:
+obj = null;
+
+// No se puede obtener cache.size, ya que es un WeakMap,
+// pero es 0 o pronto será 0
+// Cuando obj obtiene basura recolectada, los datos en caché también se eliminarán
+```
+
+## WeakSet
+
+`WeakSet` se comporta de manera similar:
+
+- Es análogo a `Set`, pero solo podemos agregar objetos a `WeakSet` (no primitivos).
+- Existe un objeto en el conjunto mientras es accesible desde otro lugar.
+- Al igual que `Set`, admite` add`, `has` y` delete`, pero no `size`,` keys()` ni iteraciones.
+
+Al ser "débil", también sirve como almacenamiento adicional. Pero no para datos arbitrarios, sino para hechos "sí / no". Una membresía en `WeakSet` puede significar algo sobre el objeto.
+
+Por ejemplo, podemos agregar usuarios a `WeakSet` para realizar un seguimiento de los que visitaron nuestro sitio:
+
+```js run
+let visitedSet = new WeakSet();
+
+let john = { name: "John" };
+let pete = { name: "Pete" };
+let mary = { name: "Mary" };
+
+visitedSet.add(john); // John nos visita
+visitedSet.add(pete); // luego Pete
+visitedSet.add(john); // John otra vez
+
+// visitedSet tiene 2 usuarios ahora
+
+// comprobar si John nos visitó?
+alert(visitedSet.has(john)); // true
+
+// comprobar si Mary nos visitó?
+alert(visitedSet.has(mary)); // false
+
+john = null;
+
+// visitedSet se limpiará automáticamente
+```
+
+ La limitación más notable de `WeakMap` y` WeakSet` es la ausencia de iteraciones y la imposibilidad de obtener todo el contenido actual. Esto puede parecer inconveniente, pero no impide que `WeakMap / WeakSet` haga su trabajo principal: ser un almacenamiento "adicional" de datos para objetos que se almacenan / administran en otro lugar.
+
+## Resumen
+
+`WeakMap` es una colección similar a `Map` que permite solo objetos como propiedades y los elimina junto con el valor asociado una vez que se vuelven inaccesibles por otros medios.
+
+`WeakSet` es una colección tipo `Set` que almacena solo objetos y los elimina una vez que se vuelven inaccesibles por otros medios.
+
+Ambos no admiten métodos y propiedades que se refieren a todas las propiedades o su recuento. Solo se permiten operaciones individuales.
+
+`WeakMap` y` WeakSet` se utilizan como estructuras de dato "secundarias" además del almacenamiento de objetos "principal". Una vez que el objeto se elimina del almacenamiento principal, si solo se encuentra como la propiedad de `WeakMap` o en un` WeakSet`, se limpiará automáticamente.