From 321395d96ed8d375b2917d9a0bb2c2d3a8c57676 Mon Sep 17 00:00:00 2001
From: Milan Burda <milan.burda@gmail.com>
Date: Mon, 19 Oct 2020 02:24:51 +0200
Subject: [PATCH] refactor: use Map instead of Object for better semantics
 (#25982)

---
 lib/asar/fs-wrapper.ts            |  8 +++----
 lib/browser/api/touch-bar.ts      | 18 +++++++--------
 lib/browser/guest-view-manager.ts | 38 +++++++++++++++----------------
 3 files changed, 30 insertions(+), 34 deletions(-)

diff --git a/lib/asar/fs-wrapper.ts b/lib/asar/fs-wrapper.ts
index d03db08b2450..34f5a4ecc686 100644
--- a/lib/asar/fs-wrapper.ts
+++ b/lib/asar/fs-wrapper.ts
@@ -216,16 +216,16 @@ const makePromiseFunction = function (orig: Function, pathArgumentIndex: number)
 
 // Override fs APIs.
 export const wrapFsWithAsar = (fs: Record<string, any>) => {
-  const logFDs: Record<string, number> = {};
+  const logFDs = new Map<string, number>();
   const logASARAccess = (asarPath: string, filePath: string, offset: number) => {
     if (!process.env.ELECTRON_LOG_ASAR_READS) return;
-    if (!logFDs[asarPath]) {
+    if (!logFDs.has(asarPath)) {
       const path = require('path');
       const logFilename = `${path.basename(asarPath, '.asar')}-access-log.txt`;
       const logPath = path.join(require('os').tmpdir(), logFilename);
-      logFDs[asarPath] = fs.openSync(logPath, 'a');
+      logFDs.set(asarPath, fs.openSync(logPath, 'a'));
     }
-    fs.writeSync(logFDs[asarPath], `${offset}: ${filePath}\n`);
+    fs.writeSync(logFDs.get(asarPath), `${offset}: ${filePath}\n`);
   };
 
   const { lstatSync } = fs;
diff --git a/lib/browser/api/touch-bar.ts b/lib/browser/api/touch-bar.ts
index 1ce8b272f97e..0e6b92eafaa8 100644
--- a/lib/browser/api/touch-bar.ts
+++ b/lib/browser/api/touch-bar.ts
@@ -300,8 +300,8 @@ class TouchBar extends EventEmitter implements Electron.TouchBar {
     touchBar._addToWindow(window);
   }
 
-  private windowListeners: Record<number, Function> = {};
-  private items: Record<string, TouchBarItem<any>> = {};
+  private windowListeners = new Map<number, Function>();
+  private items = new Map<string, TouchBarItem<any>>();
   orderedItems: TouchBarItem<any>[] = [];
 
   constructor (options: Electron.TouchBarConstructorOptions) {
@@ -317,12 +317,10 @@ class TouchBar extends EventEmitter implements Electron.TouchBar {
       items = [];
     }
 
-    this.windowListeners = {};
-    this.items = {};
     this.escapeItem = (escapeItem as any) || null;
 
     const registerItem = (item: TouchBarItem<any>) => {
-      this.items[item.id] = item;
+      this.items.set(item.id, item);
       item.on('change', this.changeListener);
       if (item.child instanceof TouchBar) {
         item.child.orderedItems.forEach(registerItem);
@@ -387,7 +385,7 @@ class TouchBar extends EventEmitter implements Electron.TouchBar {
     const { id } = window;
 
     // Already added to window
-    if (Object.prototype.hasOwnProperty.call(this.windowListeners, id)) return;
+    if (this.windowListeners.has(id)) return;
 
     window._touchBar = this;
 
@@ -402,7 +400,7 @@ class TouchBar extends EventEmitter implements Electron.TouchBar {
     this.on('escape-item-change', escapeItemListener);
 
     const interactionListener = (_: any, itemID: string, details: any) => {
-      let item = this.items[itemID];
+      let item = this.items.get(itemID);
       if (item == null && this.escapeItem != null && this.escapeItem.id === itemID) {
         item = this.escapeItem;
       }
@@ -418,7 +416,7 @@ class TouchBar extends EventEmitter implements Electron.TouchBar {
       window.removeListener('-touch-bar-interaction', interactionListener);
       window.removeListener('closed', removeListeners);
       window._touchBar = null;
-      delete this.windowListeners[id];
+      this.windowListeners.delete(id);
       const unregisterItems = (items: TouchBarItem<any>[]) => {
         for (const item of items) {
           item.removeListener('change', this.changeListener);
@@ -433,14 +431,14 @@ class TouchBar extends EventEmitter implements Electron.TouchBar {
       }
     };
     window.once('closed', removeListeners);
-    this.windowListeners[id] = removeListeners;
+    this.windowListeners.set(id, removeListeners);
 
     window._setTouchBarItems(this.orderedItems);
     escapeItemListener(this.escapeItem);
   }
 
   _removeFromWindow (window: Electron.BrowserWindow) {
-    const removeListeners = this.windowListeners[window.id];
+    const removeListeners = this.windowListeners.get(window.id);
     if (removeListeners != null) removeListeners();
   }
 
diff --git a/lib/browser/guest-view-manager.ts b/lib/browser/guest-view-manager.ts
index 9135a4c442ba..b57fdecad4e6 100644
--- a/lib/browser/guest-view-manager.ts
+++ b/lib/browser/guest-view-manager.ts
@@ -18,8 +18,8 @@ const webViewManager = process._linkedBinding('electron_browser_web_view_manager
 
 const supportedWebViewEvents = Object.keys(webViewEvents);
 
-const guestInstances: Record<string, GuestInstance> = {};
-const embedderElementsMap: Record<string, number> = {};
+const guestInstances = new Map<number, GuestInstance>();
+const embedderElementsMap = new Map<string, number>();
 
 function sanitizeOptionsForGuest (options: Record<string, any>) {
   const ret = { ...options };
@@ -37,14 +37,14 @@ const createGuest = function (embedder: Electron.WebContents, params: Record<str
     embedder: embedder
   });
   const guestInstanceId = guest.id;
-  guestInstances[guestInstanceId] = {
+  guestInstances.set(guestInstanceId, {
     guest: guest,
     embedder: embedder
-  };
+  });
 
   // Clear the guest from map when it is destroyed.
   guest.once('destroyed', () => {
-    if (Object.prototype.hasOwnProperty.call(guestInstances, guestInstanceId)) {
+    if (guestInstances.has(guestInstanceId)) {
       detachGuest(embedder, guestInstanceId);
     }
   });
@@ -107,7 +107,7 @@ const createGuest = function (embedder: Electron.WebContents, params: Record<str
   // Notify guest of embedder window visibility when it is ready
   // FIXME Remove once https://github.com/electron/electron/issues/6828 is fixed
   guest.on('dom-ready', function () {
-    const guestInstance = guestInstances[guestInstanceId];
+    const guestInstance = guestInstances.get(guestInstanceId);
     if (guestInstance != null && guestInstance.visibilityState != null) {
       guest._sendInternal(IPC_MESSAGES.GUEST_INSTANCE_VISIBILITY_CHANGE, guestInstance.visibilityState);
     }
@@ -122,20 +122,20 @@ const attachGuest = function (event: Electron.IpcMainInvokeEvent,
   const embedder = event.sender;
   // Destroy the old guest when attaching.
   const key = `${embedder.id}-${elementInstanceId}`;
-  const oldGuestInstanceId = embedderElementsMap[key];
+  const oldGuestInstanceId = embedderElementsMap.get(key);
   if (oldGuestInstanceId != null) {
     // Reattachment to the same guest is just a no-op.
     if (oldGuestInstanceId === guestInstanceId) {
       return;
     }
 
-    const oldGuestInstance = guestInstances[oldGuestInstanceId];
+    const oldGuestInstance = guestInstances.get(oldGuestInstanceId);
     if (oldGuestInstance) {
       oldGuestInstance.guest.detachFromOuterFrame();
     }
   }
 
-  const guestInstance = guestInstances[guestInstanceId];
+  const guestInstance = guestInstances.get(guestInstanceId);
   // If this isn't a valid guest instance then do nothing.
   if (!guestInstance) {
     throw new Error(`Invalid guestInstanceId: ${guestInstanceId}`);
@@ -148,7 +148,7 @@ const attachGuest = function (event: Electron.IpcMainInvokeEvent,
   // If this guest is already attached to an element then remove it
   if (guestInstance.elementInstanceId) {
     const oldKey = `${guestInstance.embedder.id}-${guestInstance.elementInstanceId}`;
-    delete embedderElementsMap[oldKey];
+    embedderElementsMap.delete(oldKey);
 
     // Remove guest from embedder if moving across web views
     if (guest.viewInstanceId !== params.instanceId) {
@@ -210,7 +210,7 @@ const attachGuest = function (event: Electron.IpcMainInvokeEvent,
   }
 
   guest.attachParams = params;
-  embedderElementsMap[key] = guestInstanceId;
+  embedderElementsMap.set(key, guestInstanceId);
 
   guest.setEmbedder(embedder);
   guestInstance.embedder = embedder;
@@ -224,7 +224,7 @@ const attachGuest = function (event: Electron.IpcMainInvokeEvent,
 
 // Remove an guest-embedder relationship.
 const detachGuest = function (embedder: Electron.WebContents, guestInstanceId: number) {
-  const guestInstance = guestInstances[guestInstanceId];
+  const guestInstance = guestInstances.get(guestInstanceId);
 
   if (!guestInstance) return;
 
@@ -233,10 +233,10 @@ const detachGuest = function (embedder: Electron.WebContents, guestInstanceId: n
   }
 
   webViewManager.removeGuest(embedder, guestInstanceId);
-  delete guestInstances[guestInstanceId];
+  guestInstances.delete(guestInstanceId);
 
   const key = `${embedder.id}-${guestInstance.elementInstanceId}`;
-  delete embedderElementsMap[key];
+  embedderElementsMap.delete(key);
 };
 
 // Once an embedder has had a guest attached we watch it for destruction to
@@ -250,8 +250,7 @@ const watchEmbedder = function (embedder: Electron.WebContents) {
 
   // Forward embedder window visibility change events to guest
   const onVisibilityChange = function (visibilityState: VisibilityState) {
-    for (const guestInstanceId of Object.keys(guestInstances)) {
-      const guestInstance = guestInstances[guestInstanceId];
+    for (const guestInstance of guestInstances.values()) {
       guestInstance.visibilityState = visibilityState;
       if (guestInstance.embedder === embedder) {
         guestInstance.guest._sendInternal(IPC_MESSAGES.GUEST_INSTANCE_VISIBILITY_CHANGE, visibilityState);
@@ -264,10 +263,9 @@ const watchEmbedder = function (embedder: Electron.WebContents) {
     // Usually the guestInstances is cleared when guest is destroyed, but it
     // may happen that the embedder gets manually destroyed earlier than guest,
     // and the embedder will be invalid in the usual code path.
-    for (const guestInstanceId of Object.keys(guestInstances)) {
-      const guestInstance = guestInstances[guestInstanceId];
+    for (const [guestInstanceId, guestInstance] of guestInstances) {
       if (guestInstance.embedder === embedder) {
-        detachGuest(embedder, parseInt(guestInstanceId));
+        detachGuest(embedder, guestInstanceId);
       }
     }
     // Clear the listeners.
@@ -388,6 +386,6 @@ const getGuestForWebContents = function (guestInstanceId: number, contents: Elec
 
 // Returns WebContents from its guest id.
 const getGuest = function (guestInstanceId: number) {
-  const guestInstance = guestInstances[guestInstanceId];
+  const guestInstance = guestInstances.get(guestInstanceId);
   if (guestInstance != null) return guestInstance.guest;
 };