Bump v11.0.0-nightly.20200717

* build: tsify asar and move to webpack js2c pipeline

* build: use the webpack provider for fs-wrapper

.circleci/config.yml

@@ -77,12 +77,12 @@ machine-linux-2xlarge: &machine-linux-2xlarge
 
 machine-mac: &machine-mac
   macos:
-    xcode: "11.1.0"
+    xcode: "11.5.0"
 
 machine-mac-large: &machine-mac-large
   resource_class: large
   macos:
-    xcode: "11.1.0"
+    xcode: "11.5.0"
 
 # Build configurations options.
 env-testing-build: &env-testing-build
@@ -312,14 +312,23 @@ step-get-more-space-on-mac: &step-get-more-space-on-mac
     name: Free up space on MacOS
     command: |
       if [ "`uname`" == "Darwin" ]; then
-        sudo rm -rf /Library/Developer/CoreSimulator
-        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/AppleTVOS.platform
-        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform
-        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/WatchOS.platform
-        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/WatchSimulator.platform
-        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/AppleTVSimulator.platform
-        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform
+        sudo mkdir -p $TMPDIR/del-target
+        tmpify() {
+          sudo mv $1 $TMPDIR/del-target/$(echo $1|shasum -a 256|head -n1|cut -d " " -f1)
+        }
+        tmpify /Library/Developer/CoreSimulator
+        tmpify $(xcode-select -p)/Platforms/AppleTVOS.platform
+        tmpify $(xcode-select -p)/Platforms/iPhoneOS.platform
+        tmpify $(xcode-select -p)/Platforms/WatchOS.platform
+        tmpify $(xcode-select -p)/Platforms/WatchSimulator.platform
+        tmpify $(xcode-select -p)/Platforms/AppleTVSimulator.platform
+        tmpify $(xcode-select -p)/Platforms/iPhoneSimulator.platform
+        tmpify ~/.rubies
+        tmpify ~/Library/Caches/Homebrew
+        tmpify /usr/local/Homebrew
+        sudo rm -rf $TMPDIR/del-target
       fi
+    background: true
 
 # On macOS delete all .git directories under src/ expect for
 # third_party/angle/ because of build time generation of file
@@ -418,6 +427,7 @@ step-electron-build: &step-electron-build
       fi
       cd src
       ninja -C out/Default electron -j $NUMBER_OF_NINJA_PROCESSES
+      node electron/script/check-symlinks.js
 
 step-native-unittests-build: &step-native-unittests-build
   run:
@@ -670,8 +680,10 @@ step-mksnapshot-build: &step-mksnapshot-build
       if [ "`uname`" != "Darwin" ]; then
         if [ "$TARGET_ARCH" == "arm" ]; then
           electron/script/strip-binaries.py --file $PWD/out/Default/clang_x86_v8_arm/mksnapshot
+          electron/script/strip-binaries.py --file $PWD/out/Default/clang_x86_v8_arm/v8_context_snapshot_generator
         elif [ "$TARGET_ARCH" == "arm64" ]; then
           electron/script/strip-binaries.py --file $PWD/out/Default/clang_x64_v8_arm64/mksnapshot
+          electron/script/strip-binaries.py --file $PWD/out/Default/clang_x64_v8_arm64/v8_context_snapshot_generator
         else
           electron/script/strip-binaries.py --file $PWD/out/Default/mksnapshot
           electron/script/strip-binaries.py --file $PWD/out/Default/v8_context_snapshot_generator
@@ -704,6 +716,7 @@ step-hunspell-store: &step-hunspell-store
 step-maybe-generate-breakpad-symbols: &step-maybe-generate-breakpad-symbols
   run:
     name: Generate breakpad symbols
+    no_output_timeout: 30m
     command: |
       if [ "$GENERATE_SYMBOLS" == "true" ]; then
         cd src
@@ -808,8 +821,13 @@ step-touch-sync-done: &step-touch-sync-done
 step-maybe-restore-src-cache: &step-maybe-restore-src-cache
   restore_cache:
     keys:
-      - v7-src-cache-{{ checksum "src/electron/.depshash" }}
+      - v8-src-cache-{{ checksum "src/electron/.depshash" }}
     name: Restoring src cache
+step-maybe-restore-src-cache-marker: &step-maybe-restore-src-cache-marker
+  restore_cache:
+    keys:
+      - v1-src-cache-marker-{{ checksum "src/electron/.depshash" }}
+    name: Restoring src cache marker
 
 # Restore exact or closest git cache based on the hash of DEPS and .circle-sync-done
 # If the src cache was restored above then this will match an empty cache
@@ -828,7 +846,7 @@ step-restore-out-cache: &step-restore-out-cache
     paths:
       - ./src/out/Default
     keys:
-      - v7-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
+      - v9-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
     name: Restoring out cache
 
 step-set-git-cache-path: &step-set-git-cache-path
@@ -852,7 +870,7 @@ step-save-out-cache: &step-save-out-cache
   save_cache:
     paths:
       - ./src/out/Default
-    key: v7-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
+    key: v9-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
     name: Persisting out cache
 
 step-run-electron-only-hooks: &step-run-electron-only-hooks
@@ -886,9 +904,18 @@ step-minimize-workspace-size-from-checkout: &step-minimize-workspace-size-from-c
 step-save-src-cache: &step-save-src-cache
   save_cache:
     paths:
-      - /portal
-    key: v7-src-cache-{{ checksum "/portal/src/electron/.depshash" }}
+      - /var/portal
+    key: v8-src-cache-{{ checksum "/var/portal/src/electron/.depshash" }}
     name: Persisting src cache
+step-make-src-cache-marker: &step-make-src-cache-marker
+  run:
+    name: Making src cache marker
+    command: touch .src-cache-marker
+step-save-src-cache-marker: &step-save-src-cache-marker
+  save_cache:
+    paths:
+      - .src-cache-marker
+    key: v1-src-cache-marker-{{ checksum "/var/portal/src/electron/.depshash" }}
 
 # Check for doc only change
 step-check-for-doc-only-change: &step-check-for-doc-only-change
@@ -994,7 +1021,8 @@ steps-checkout-and-save-cache: &steps-checkout-and-save-cache
 
     - *step-generate-deps-hash
     - *step-touch-sync-done
-    - maybe-restore-portaled-src-cache
+    - maybe-restore-portaled-src-cache:
+        halt-if-successful: true
     - *step-maybe-restore-git-cache
     - *step-set-git-cache-path
     # This sync call only runs if .circle-sync-done is an EMPTY file
@@ -1015,10 +1043,12 @@ steps-checkout-and-save-cache: &steps-checkout-and-save-cache
     - run:
         name: Move src folder to the cross-OS portal
         command: |
-          sudo mkdir -p /portal
-          sudo chown -R $(id -u):$(id -g) /portal
-          mv ./src /portal
+          sudo mkdir -p /var/portal
+          sudo chown -R $(id -u):$(id -g) /var/portal
+          mv ./src /var/portal
     - *step-save-src-cache
+    - *step-make-src-cache-marker
+    - *step-save-src-cache-marker
 
 steps-electron-gn-check: &steps-electron-gn-check
   steps:
@@ -1039,8 +1069,8 @@ steps-electron-ts-compile-for-doc-change: &steps-electron-ts-compile-for-doc-cha
     - *step-depot-tools-get
     - *step-depot-tools-add-to-path
     - *step-restore-brew-cache
-    - *step-get-more-space-on-mac
     - *step-install-gnutar-on-mac
+    - *step-get-more-space-on-mac
     - *step-generate-deps-hash
     - *step-touch-sync-done
     - maybe-restore-portaled-src-cache
@@ -1162,8 +1192,8 @@ steps-tests: &steps-tests
           ELECTRON_DISABLE_SECURITY_WARNINGS: 1
         command: |
           cd src
-          (cd electron && node script/yarn test --runners=main --enable-logging --files $(circleci tests glob spec-main/*-spec.ts | circleci tests split))
-          (cd electron && node script/yarn test --runners=remote --enable-logging --files $(circleci tests glob spec/*-spec.js | circleci tests split))
+          (cd electron && node script/yarn test --runners=main --trace-uncaught --enable-logging --files $(circleci tests glob spec-main/*-spec.ts | circleci tests split))
+          (cd electron && node script/yarn test --runners=remote --trace-uncaught --enable-logging --files $(circleci tests glob spec/*-spec.js | circleci tests split))
     - run:
         name: Check test results existence
         command: |
@@ -1222,20 +1252,34 @@ chromium-upgrade-branches: &chromium-upgrade-branches
 # Command Aliases
 commands:
   maybe-restore-portaled-src-cache:
+    parameters:
+      halt-if-successful:
+        type: boolean
+        default: false
     steps:
       - run:
           name: Prepare for cross-OS sync restore
           command: |
-            sudo mkdir -p /portal
-            sudo chown -R $(id -u):$(id -g) /portal
+            sudo mkdir -p /var/portal
+            sudo chown -R $(id -u):$(id -g) /var/portal
+      - when:
+          condition: << parameters.halt-if-successful >>
+          steps:
+            - *step-maybe-restore-src-cache-marker
+            - run:
+                name: Halt the job early if the src cache exists
+                command: |
+                  if [ -f ".src-cache-marker" ]; then
+                    circleci-agent step halt
+                  fi
       - *step-maybe-restore-src-cache
       - run:
           name: Fix the src cache restore point on macOS
           command: |
-            if [ -d "/portal/src" ]; then
+            if [ -d "/var/portal/src" ]; then
               echo Relocating Cache
               rm -rf src
-              mv /portal/src ./
+              mv /var/portal/src ./
             fi
   checkout-from-cache:
     steps:

.eslintrc.json

@@ -27,7 +27,13 @@
     "sourceType": "module"
   },
   "globals": {
-    "standardScheme": "readonly"
+    "standardScheme": "readonly",
+    "globalThis": "readonly",
+    "BUILDFLAG": "readonly",
+    "ENABLE_DESKTOP_CAPTURER": "readonly",
+    "ENABLE_REMOTE_MODULE": "readonly",
+    "ENABLE_VIEWS_API": "readonly",
+    "BigInt": "readonly"
   },
   "overrides": [
     {

.github/PULL_REQUEST_TEMPLATE.md

@@ -15,6 +15,7 @@ Contributors guide: https://github.com/electron/electron/blob/master/CONTRIBUTIN
 - [ ] relevant documentation is changed or added
 - [ ] PR title follows semantic [commit guidelines](https://github.com/electron/electron/blob/master/docs/development/pull-requests.md#commit-message-guidelines)
 - [ ] [PR release notes](https://github.com/electron/clerk/blob/master/README.md) describe the change in a way relevant to app developers, and are [capitalized, punctuated, and past tense](https://github.com/electron/clerk/blob/master/README.md#examples).
+- [ ] This is **NOT A BREAKING CHANGE**. Breaking changes may not be merged to master until 11-x-y is branched.
 
 #### Release Notes
 

BUILD.gn

@@ -3,6 +3,7 @@ import("//build/config/ui.gni")
 import("//build/config/win/manifest.gni")
 import("//components/spellcheck/spellcheck_build_features.gni")
 import("//content/public/app/mac_helpers.gni")
+import("//extensions/buildflags/buildflags.gni")
 import("//pdf/features.gni")
 import("//ppapi/buildflags/buildflags.gni")
 import("//printing/buildflags/buildflags.gni")
@@ -58,6 +59,17 @@ if (is_mas_build) {
          "It doesn't make sense to build a MAS build on a non-mac platform")
 }
 
+if (enable_pdf_viewer) {
+  assert(enable_pdf, "PDF viewer support requires enable_pdf=true")
+  assert(enable_electron_extensions,
+         "PDF viewer support requires enable_electron_extensions=true")
+}
+
+if (enable_electron_extensions) {
+  assert(enable_extensions,
+         "Chrome extension support requires enable_extensions=true")
+}
+
 config("branding") {
   defines = [
     "ELECTRON_PRODUCT_NAME=\"$electron_product_name\"",
@@ -82,6 +94,15 @@ npm_action("build_electron_definitions") {
   outputs = [ "$target_gen_dir/tsc/typings/electron.d.ts" ]
 }
 
+webpack_build("electron_asar_bundle") {
+  deps = [ ":build_electron_definitions" ]
+
+  inputs = auto_filenames.asar_bundle_deps
+
+  config_file = "//electron/build/webpack/webpack.config.asar.js"
+  out_file = "$target_gen_dir/js2c/asar_bundle.js"
+}
+
 webpack_build("electron_browser_bundle") {
   deps = [ ":build_electron_definitions" ]
 
@@ -127,48 +148,25 @@ webpack_build("electron_isolated_renderer_bundle") {
   out_file = "$target_gen_dir/js2c/isolated_bundle.js"
 }
 
-webpack_build("electron_content_script_bundle") {
-  deps = [ ":build_electron_definitions" ]
-
-  inputs = auto_filenames.content_script_bundle_deps
-
-  config_file = "//electron/build/webpack/webpack.config.content_script.js"
-  out_file = "$target_gen_dir/js2c/content_script_bundle.js"
-}
-
-copy("electron_js2c_copy") {
-  sources = [
-    "lib/common/asar.js",
-    "lib/common/asar_init.js",
-  ]
-  outputs = [ "$target_gen_dir/js2c/{{source_file_part}}" ]
-}
-
 action("electron_js2c") {
   deps = [
+    ":electron_asar_bundle",
     ":electron_browser_bundle",
-    ":electron_content_script_bundle",
     ":electron_isolated_renderer_bundle",
-    ":electron_js2c_copy",
     ":electron_renderer_bundle",
     ":electron_sandboxed_renderer_bundle",
     ":electron_worker_bundle",
   ]
 
-  webpack_sources = [
+  sources = [
+    "$target_gen_dir/js2c/asar_bundle.js",
     "$target_gen_dir/js2c/browser_init.js",
-    "$target_gen_dir/js2c/content_script_bundle.js",
     "$target_gen_dir/js2c/isolated_bundle.js",
     "$target_gen_dir/js2c/renderer_init.js",
     "$target_gen_dir/js2c/sandbox_bundle.js",
     "$target_gen_dir/js2c/worker_init.js",
   ]
 
-  sources = webpack_sources + [
-              "$target_gen_dir/js2c/asar.js",
-              "$target_gen_dir/js2c/asar_init.js",
-            ]
-
   inputs = sources + [ "//third_party/electron_node/tools/js2c.py" ]
   outputs = [ "$root_gen_dir/electron_natives.cc" ]
 
@@ -321,6 +319,7 @@ source_set("electron_lib") {
     "shell/common/api:mojo",
     "//base:base_static",
     "//base/allocator:buildflags",
+    "//chrome/app:command_ids",
     "//chrome/app/resources:platform_locale_settings",
     "//chrome/services/printing/public/mojom",
     "//components/certificate_transparency",
@@ -330,7 +329,10 @@ source_set("electron_lib") {
     "//components/network_hints/common:mojo_bindings",
     "//components/network_hints/renderer",
     "//components/network_session_configurator/common",
+    "//components/pref_registry",
     "//components/prefs",
+    "//components/upload_list",
+    "//components/user_prefs",
     "//components/viz/host",
     "//components/viz/service",
     "//content/public/browser",
@@ -342,6 +344,7 @@ source_set("electron_lib") {
     "//device/bluetooth",
     "//device/bluetooth/public/cpp",
     "//gin",
+    "//media/blink:blink",
     "//media/capture/mojom:video_capture",
     "//media/mojo/mojom",
     "//net:extras",
@@ -359,6 +362,7 @@ source_set("electron_lib") {
     "//third_party/blink/public:blink",
     "//third_party/boringssl",
     "//third_party/electron_node:node_lib",
+    "//third_party/inspector_protocol:crdtp",
     "//third_party/leveldatabase",
     "//third_party/libyuv",
     "//third_party/webrtc_overrides:webrtc_component",
@@ -376,7 +380,7 @@ source_set("electron_lib") {
   public_deps = [
     "//base",
     "//base:i18n",
-    "//content/public/app:both",
+    "//content/public/app",
   ]
 
   include_dirs = [
@@ -426,6 +430,9 @@ source_set("electron_lib") {
       "*\bviews/*",
     ]
   }
+  if (!is_mas_build) {
+    deps += [ "//components/crash/core/app" ]
+  }
 
   set_sources_assignment_filter(
       sources_assignment_filter + extra_source_filters)
@@ -443,6 +450,10 @@ source_set("electron_lib") {
     ]
   }
 
+  if (is_linux) {
+    deps += [ "//components/crash/content/browser" ]
+  }
+
   if (is_mac) {
     deps += [
       "//components/remote_cocoa/app_shim",
@@ -450,6 +461,10 @@ source_set("electron_lib") {
       "//ui/accelerated_widget_mac",
     ]
 
+    if (!is_mas_build) {
+      deps += [ "//third_party/crashpad/crashpad/client" ]
+    }
+
     libs = [
       "AVFoundation.framework",
       "Carbon.framework",
@@ -468,25 +483,28 @@ source_set("electron_lib") {
     ]
     if (is_mas_build) {
       sources += [ "shell/browser/api/electron_api_app_mas.mm" ]
-      sources -= [
-        "shell/browser/auto_updater_mac.mm",
-        "shell/common/crash_reporter/crash_reporter_mac.h",
-        "shell/common/crash_reporter/crash_reporter_mac.mm",
-      ]
+      sources -= [ "shell/browser/auto_updater_mac.mm" ]
       defines += [ "MAS_BUILD" ]
+      sources -= [
+        "shell/app/electron_crash_reporter_client.cc",
+        "shell/app/electron_crash_reporter_client.h",
+        "shell/common/crash_keys.cc",
+        "shell/common/crash_keys.h",
+      ]
     } else {
       libs += [
         "Squirrel.framework",
-        "ReactiveCocoa.framework",
+        "ReactiveObjC.framework",
         "Mantle.framework",
       ]
-      cflags_objcc = [
-        "-F",
-        rebase_path("external_binaries", root_build_dir),
+
+      deps += [
+        "//third_party/squirrel.mac:reactiveobjc_framework+link",
+        "//third_party/squirrel.mac:squirrel_framework+link",
       ]
 
-      # ReactiveCocoa which is used by Squirrel requires using __weak.
-      cflags_objcc += [ "-fobjc-weak" ]
+      # ReactiveObjC which is used by Squirrel requires using __weak.
+      cflags_objcc = [ "-fobjc-weak" ]
     }
   }
   if (is_linux) {
@@ -495,7 +513,6 @@ source_set("electron_lib") {
       "//build/config/linux/gtk",
       "//dbus",
       "//device/bluetooth",
-      "//third_party/breakpad:client",
       "//ui/events/devices/x11",
       "//ui/events/platform/x11",
       "//ui/gtk",
@@ -505,11 +522,10 @@ source_set("electron_lib") {
     if (use_x11) {
       deps += [
         "//ui/gfx/x",
-        "//ui/gtk:x",
+        "//ui/gtk/x",
       ]
     }
     configs += [ ":gio_unix" ]
-    include_dirs += [ "//third_party/breakpad" ]
     configs += [ "//build/config/linux:x11" ]
     defines += [
       # Disable warnings for g_settings_list_schemas.
@@ -518,6 +534,16 @@ source_set("electron_lib") {
 
     sources += filenames.lib_sources_nss
     sources += [
+      "shell/browser/ui/gtk/app_indicator_icon.cc",
+      "shell/browser/ui/gtk/app_indicator_icon.h",
+      "shell/browser/ui/gtk/app_indicator_icon_menu.cc",
+      "shell/browser/ui/gtk/app_indicator_icon_menu.h",
+      "shell/browser/ui/gtk/gtk_status_icon.cc",
+      "shell/browser/ui/gtk/gtk_status_icon.h",
+      "shell/browser/ui/gtk/menu_util.cc",
+      "shell/browser/ui/gtk/menu_util.h",
+      "shell/browser/ui/gtk/status_icon.cc",
+      "shell/browser/ui/gtk/status_icon.h",
       "shell/browser/ui/gtk_util.cc",
       "shell/browser/ui/gtk_util.h",
     ]
@@ -525,6 +551,7 @@ source_set("electron_lib") {
   if (is_win) {
     libs += [ "dwmapi.lib" ]
     deps += [
+      "//components/crash/core/app:crash_export_thunks",
       "//ui/native_theme:native_theme_browser",
       "//ui/views/controls/webview",
       "//ui/wm",
@@ -536,14 +563,6 @@ source_set("electron_lib") {
     ]
   }
 
-  if ((is_mac && !is_mas_build) || is_win) {
-    sources += [
-      "shell/common/crash_reporter/crash_reporter_crashpad.cc",
-      "shell/common/crash_reporter/crash_reporter_crashpad.h",
-    ]
-    deps += [ "//third_party/crashpad/crashpad/client" ]
-  }
-
   if (enable_plugins) {
     deps += [ "chromium_src:plugins" ]
     sources += [
@@ -581,17 +600,6 @@ source_set("electron_lib") {
     ]
   }
 
-  if (enable_remote_module) {
-    sources += [
-      "shell/common/api/remote/object_life_monitor.cc",
-      "shell/common/api/remote/object_life_monitor.h",
-      "shell/common/api/remote/remote_callback_freer.cc",
-      "shell/common/api/remote/remote_callback_freer.h",
-      "shell/common/api/remote/remote_object_freer.cc",
-      "shell/common/api/remote/remote_object_freer.h",
-    ]
-  }
-
   if (enable_desktop_capturer) {
     if (is_component_build && !is_linux) {
       # On windows the implementation relies on unexported
@@ -622,15 +630,6 @@ source_set("electron_lib") {
     deps += [ "//components/printing/common:mojo_interfaces" ]
   }
 
-  deps += [
-    "//components/pref_registry",
-    "//components/user_prefs",
-    "//extensions/browser",
-    "//extensions/browser:core_api_provider",
-    "//extensions/common",
-    "//extensions/common:core_api_provider",
-    "//extensions/renderer",
-  ]
   if (enable_electron_extensions) {
     sources += filenames.lib_sources_extensions
     deps += [
@@ -639,6 +638,11 @@ source_set("electron_lib") {
       "shell/common/extensions/api:extensions_features",
       "//chrome/browser/resources:component_extension_resources",
       "//components/zoom",
+      "//extensions/browser",
+      "//extensions/browser:core_api_provider",
+      "//extensions/common",
+      "//extensions/common:core_api_provider",
+      "//extensions/renderer",
     ]
   }
 
@@ -654,6 +658,7 @@ source_set("electron_lib") {
     deps += [
       "//components/pdf/browser",
       "//components/pdf/renderer",
+      "//pdf:pdf_ppapi",
     ]
     sources += [
       "shell/browser/electron_pdf_web_contents_helper_client.cc",
@@ -752,11 +757,17 @@ if (is_mac) {
   }
 
   bundle_data("electron_crashpad_helper") {
-    sources = [ "$root_out_dir/crashpad_handler" ]
+    sources = [ "$root_out_dir/chrome_crashpad_handler" ]
 
-    outputs = [ "{{bundle_resources_dir}}/{{source_file_part}}" ]
+    outputs = [ "{{bundle_contents_dir}}/Helpers/{{source_file_part}}" ]
 
-    public_deps = [ "//third_party/crashpad/crashpad/handler:crashpad_handler" ]
+    public_deps = [ "//components/crash/core/app:chrome_crashpad_handler" ]
+
+    if (is_asan) {
+      # crashpad_handler requires the ASan runtime at its @executable_path.
+      sources += [ "$root_out_dir/libclang_rt.asan_osx_dynamic.dylib" ]
+      public_deps += [ "//build/config/sanitizers:copy_asan_runtime" ]
+    }
   }
 
   mac_framework_bundle("electron_framework") {
@@ -766,6 +777,9 @@ if (is_mac) {
       "Resources",
       "Libraries",
     ]
+    if (!is_mas_build) {
+      framework_contents += [ "Helpers" ]
+    }
     public_deps = [
       ":electron_framework_libraries",
       ":electron_lib",
@@ -796,8 +810,6 @@ if (is_mac) {
     }
 
     ldflags = [
-      "-F",
-      rebase_path("external_binaries", root_build_dir),
       "-Wl,-install_name,@rpath/$output_name.framework/$output_name",
       "-rpath",
       "@loader_path/Libraries",
@@ -848,17 +860,49 @@ if (is_mac) {
     }
   }
 
+  template("stripped_framework") {
+    action(target_name) {
+      assert(defined(invoker.framework))
+
+      script = "//electron/build/strip_framework.py"
+
+      forward_variables_from(invoker, [ "deps" ])
+      inputs = [ "$root_out_dir/" + invoker.framework ]
+      outputs = [ "$target_out_dir/stripped_frameworks/" + invoker.framework ]
+
+      args = rebase_path(inputs) + rebase_path(outputs)
+    }
+  }
+
+  stripped_framework("stripped_mantle_framework") {
+    framework = "Mantle.framework"
+    deps = [ "//third_party/squirrel.mac:mantle_framework" ]
+  }
+
+  stripped_framework("stripped_reactiveobjc_framework") {
+    framework = "ReactiveObjC.framework"
+    deps = [ "//third_party/squirrel.mac:reactiveobjc_framework" ]
+  }
+
+  stripped_framework("stripped_squirrel_framework") {
+    framework = "Squirrel.framework"
+    deps = [ "//third_party/squirrel.mac:squirrel_framework" ]
+  }
+
   bundle_data("electron_app_framework_bundle_data") {
     sources = [ "$root_out_dir/$electron_framework_name.framework" ]
     if (!is_mas_build) {
-      sources += [
-        "external_binaries/Mantle.framework",
-        "external_binaries/ReactiveCocoa.framework",
-        "external_binaries/Squirrel.framework",
-      ]
+      sources += get_target_outputs(":stripped_mantle_framework") +
+                 get_target_outputs(":stripped_reactiveobjc_framework") +
+                 get_target_outputs(":stripped_squirrel_framework")
     }
     outputs = [ "{{bundle_contents_dir}}/Frameworks/{{source_file_part}}" ]
-    public_deps = [ ":electron_framework+link" ]
+    public_deps = [
+      ":electron_framework+link",
+      ":stripped_mantle_framework",
+      ":stripped_reactiveobjc_framework",
+      ":stripped_squirrel_framework",
+    ]
 
     foreach(helper_params, content_mac_helpers) {
       sources +=
@@ -988,21 +1032,24 @@ if (is_mac) {
     }
 
     extract_symbols("crashpad_handler_syms") {
-      binary = "$root_out_dir/crashpad_handler"
+      binary = "$root_out_dir/chrome_crashpad_handler"
       symbol_dir = "$root_out_dir/breakpad_symbols"
-      dsym_file = "$root_out_dir/crashpad_handler.dSYM/Contents/Resources/DWARF/crashpad_handler"
-      deps = [ "//third_party/crashpad/crashpad/handler:crashpad_handler" ]
+      dsym_file = "$root_out_dir/chrome_crashpad_handler.dSYM/Contents/Resources/DWARF/chrome_crashpad_handler"
+      deps = [ "//components/crash/core/app:chrome_crashpad_handler" ]
     }
 
     group("electron_symbols") {
       deps = [
-        ":crashpad_handler_syms",
         ":electron_app_syms",
         ":electron_framework_syms",
         ":swiftshader_egl_syms",
         ":swiftshader_gles_syms",
       ]
 
+      if (!is_mas_build) {
+        deps += [ ":crashpad_handler_syms" ]
+      }
+
       foreach(helper_params, content_mac_helpers) {
         _helper_target = helper_params[0]
         deps += [ ":electron_helper_syms_${_helper_target}" ]
@@ -1032,6 +1079,7 @@ if (is_mac) {
       ":electron_app_manifest",
       ":electron_lib",
       ":packed_resources",
+      "//components/crash/core/app",
       "//content:sandbox_helper_win",
       "//electron/buildflags",
       "//ui/strings",
@@ -1052,7 +1100,9 @@ if (is_mac) {
       data += [ "$root_out_dir/resources/default_app.asar" ]
     }
 
-    public_deps = [ "//tools/v8_context_snapshot:v8_context_snapshot" ]
+    if (use_v8_context_snapshot) {
+      public_deps = [ "//tools/v8_context_snapshot:v8_context_snapshot" ]
+    }
 
     if (is_win) {
       sources += [
@@ -1061,6 +1111,11 @@ if (is_mac) {
         "shell/browser/resources/win/resource.h",
       ]
 
+      deps += [
+        "//components/browser_watcher:browser_watcher_client",
+        "//components/crash/core/app:run_as_crashpad_handler",
+      ]
+
       libs = [
         "comctl32.lib",
         "uiautomationcore.lib",
@@ -1155,18 +1210,6 @@ test("shell_browser_ui_unittests") {
     "//ui/base",
     "//ui/strings",
   ]
-
-  if (is_mac) {
-    # Resolve paths owing to different test executable locations
-    ldflags = [
-      "-F",
-      rebase_path("external_binaries", root_build_dir),
-      "-rpath",
-      "@loader_path",
-      "-rpath",
-      "@executable_path/" + rebase_path("external_binaries", root_build_dir),
-    ]
-  }
 }
 
 template("dist_zip") {
@@ -1264,10 +1307,13 @@ dist_zip("electron_chromedriver_zip") {
 
 mksnapshot_deps = [
   ":licenses",
-  "//tools/v8_context_snapshot:v8_context_snapshot_generator",
   "//v8:mksnapshot($v8_snapshot_toolchain)",
 ]
 
+if (use_v8_context_snapshot) {
+  mksnapshot_deps += [ "//tools/v8_context_snapshot:v8_context_snapshot_generator($v8_snapshot_toolchain)" ]
+}
+
 group("electron_mksnapshot") {
   public_deps = mksnapshot_deps
 }

CODE_OF_CONDUCT.md

@@ -1,46 +1,135 @@
-# Contributor Covenant Code of Conduct:
+# Code of Conduct
 
-## Our Pledge
+As a member project of the OpenJS Foundation, Electron uses [Contributor Covenant v2.0](https://contributor-covenant.org/version/2/0/code_of_conduct) as their code of conduct. The full text is included [below](#contributor-covenant-code-of-conduct) in English, and translations are available from the Contributor Covenant organisation:
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+- [contributor-covenant.org/translations](https://www.contributor-covenant.org/translations)
+- [github.com/ContributorCovenant](https://github.com/ContributorCovenant/contributor_covenant/tree/release/content/version/2/0)
 
-## Our Standards
+## Contributor Covenant Code of Conduct
 
-Examples of behavior that contributes to creating a positive environment include:
+### Our Pledge
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
 
-Examples of unacceptable behavior by participants include:
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+### Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
-## Our Responsibilities
+### Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
-## Scope
+### Scope
 
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
-## Enforcement
+### Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [coc@electronjs.org](mailto:coc@electronjs.org). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[coc@electronjs.org](mailto:coc@electronjs.org).
+All complaints will be reviewed and investigated promptly and fairly.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
 
-## Attribution
+### Enforcement Guidelines
 
-This Code of Conduct is adapted from the [Contributor-Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
 
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/
+#### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+#### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+#### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+#### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

DEPS

@@ -5,18 +5,22 @@ gclient_gn_args = [
   'checkout_android_native_support',
   'checkout_libaom',
   'checkout_nacl',
+  'checkout_pgo_profiles',
   'checkout_oculus_sdk',
   'checkout_openxr',
-  'checkout_google_benchmark'
+  'checkout_google_benchmark',
+  'mac_xcode_version',
 ]
 
 vars = {
   'chromium_version':
-    'c5cbec6b4ac8f405dc5d5e416ffaf640aa3d088a',
+    '0ee01724797ab0f6deadb33bb3a0201cd2d21602',
   'node_version':
-    'v12.16.2',
+    'v12.18.2',
   'nan_version':
     '2c4ee8a32a299eada3cd6e468bbd0a473bfea96d',
+  'squirrel.mac_version':
+    '44468f858ce0d25c27bd5e674abfa104e0119738',
 
   'boto_version': 'f7574aa6cc2c819430c1f05e9a1a1a666ef8169b',
   'pyyaml_version': '3.12',
@@ -28,6 +32,7 @@ vars = {
   'nodejs_git': 'https://github.com/nodejs',
   'requests_git': 'https://github.com/kennethreitz',
   'yaml_git': 'https://github.com/yaml',
+  'squirrel_git': 'https://github.com/Squirrel',
 
   # KEEP IN SYNC WITH utils.js FILE
   'yarn_version': '1.15.2',
@@ -42,6 +47,7 @@ vars = {
   'checkout_chromium': True,
   'checkout_node': True,
   'checkout_nan': True,
+  'checkout_pgo_profiles': True,
 
   # It's only needed to parse the native tests configurations.
   'checkout_pyyaml': False,
@@ -49,6 +55,8 @@ vars = {
   # Python "requests" module is used for releases only.
   'checkout_requests': False,
 
+  'mac_xcode_version': 'default',
+
   # To allow running hooks without parsing the DEPS tree
   'process_deps': True,
 
@@ -99,6 +107,18 @@ deps = {
     'url': Var('requests_git') + '/requests.git' + '@' +  Var('requests_version'),
     'condition': 'checkout_requests and process_deps',
   },
+  'src/third_party/squirrel.mac': {
+    'url': Var("squirrel_git") + '/Squirrel.Mac.git@' + Var("squirrel.mac_version"),
+    'condition': 'process_deps',
+  },
+  'src/third_party/squirrel.mac/vendor/ReactiveObjC': {
+    'url': 'https://github.com/ReactiveCocoa/ReactiveObjC.git@74ab5baccc6f7202c8ac69a8d1e152c29dc1ea76',
+    'condition': 'process_deps'
+  },
+  'src/third_party/squirrel.mac/vendor/Mantle': {
+    'url': 'https://github.com/Mantle/Mantle.git@78d3966b3c331292ea29ec38661b25df0a245948',
+    'condition': 'process_deps',
+  }
 }
 
 hooks = [
@@ -107,7 +127,7 @@ hooks = [
     'condition': '(checkout_chromium and apply_patches) and process_deps',
     'pattern': 'src/electron',
     'action': [
-      'python',
+      'python3',
       'src/electron/script/apply_all_patches.py',
       'src/electron/patches/config.json',
     ],
@@ -125,7 +145,7 @@ hooks = [
     'name': 'electron_npm_deps',
     'pattern': 'src/electron/package.json',
     'action': [
-      'python',
+      'python3',
       '-c',
       'import os, subprocess; os.chdir(os.path.join("src", "electron")); subprocess.check_call(["python", "script/lib/npx.py", "yarn@' + (Var("yarn_version")) + '", "install", "--frozen-lockfile"]);',
     ],
@@ -135,7 +155,7 @@ hooks = [
     'pattern': 'src/electron',
     'condition': 'checkout_boto and process_deps',
     'action': [
-      'python',
+      'python3',
       '-c',
       'import os, subprocess; os.chdir(os.path.join("src", "electron", "vendor", "boto")); subprocess.check_call(["python", "setup.py", "build"]);',
     ],
@@ -145,7 +165,7 @@ hooks = [
     'pattern': 'src/electron',
     'condition': 'checkout_requests and process_deps',
     'action': [
-      'python',
+      'python3',
       '-c',
       'import os, subprocess; os.chdir(os.path.join("src", "electron", "vendor", "requests")); subprocess.check_call(["python", "setup.py", "build"]);',
     ],
@@ -154,4 +174,5 @@ hooks = [
 
 recursedeps = [
   'src',
+  'src/third_party/squirrel.mac',
 ]

ELECTRON_VERSION

@@ -1 +1 @@
-10.0.0-nightly.20200416
+11.0.0-nightly.20200717

appveyor.yml

@@ -29,7 +29,7 @@
 
 version: 1.0.{build}
 build_cloud: electron-16-core
-image: vs2019bt-16.4.0
+image: vs2019bt-16.6.2
 environment:
   GIT_CACHE_PATH: C:\Users\electron\libcc_cache
   ELECTRON_OUT_DIR: Default
@@ -152,7 +152,11 @@ build_script:
   - ninja -C out/ffmpeg electron:electron_ffmpeg_zip
   - ninja -C out/Default electron:electron_dist_zip
   - ninja -C out/Default shell_browser_ui_unittests
+  - gn desc out/Default v8:run_mksnapshot_default args > out/Default/mksnapshot_args
   - ninja -C out/Default electron:electron_mksnapshot_zip
+  - cd out\Default
+  - 7z a mksnapshot.zip mksnapshot_args gen\v8\embedded.S
+  - cd ..\..
   - ninja -C out/Default electron:hunspell_dictionaries_zip
   - ninja -C out/Default electron:electron_chromedriver_zip
   - ninja -C out/Default third_party/electron_node:headers
@@ -200,11 +204,10 @@ test_script:
         echo "Skipping tests for $env:GN_CONFIG build"
       }
   - cd electron
-  - if "%RUN_TESTS%"=="true" ( echo Running test suite & node script/yarn test -- --enable-logging)
+  - if "%RUN_TESTS%"=="true" ( echo Running test suite & node script/yarn test -- --trace-uncaught --enable-logging)
   - cd ..
   - if "%RUN_TESTS%"=="true" ( echo Verifying non proprietary ffmpeg & python electron\script\verify-ffmpeg.py --build-dir out\Default --source-root %cd% --ffmpeg-path out\ffmpeg )
-  - echo "About to verify mksnapshot"  
-  - if "%RUN_TESTS%"=="true" ( gn desc out\Default v8:run_mksnapshot_default args > out\Default\mksnapshot_args )
+  - echo "About to verify mksnapshot"
   - if "%RUN_TESTS%"=="true" ( echo Verifying mksnapshot & python electron\script\verify-mksnapshot.py --build-dir out\Default --source-root %cd% )
   - echo "Done verifying mksnapshot"
   - if "%RUN_TESTS%"=="true" ( echo Verifying chromedriver & python electron\script\verify-chromedriver.py --build-dir out\Default --source-root %cd% )

azure-pipelines-woa.yml

@@ -88,5 +88,6 @@ steps:
 - powershell: |
     Get-Process | Where Name –Like "electron*" | Stop-Process
     Get-Process | Where Name –Like "MicrosoftEdge*" | Stop-Process
+    Get-Process | Where Name –Like "msedge*" | Stop-Process
   displayName: 'Kill processes left running from last test run'
   condition: always()

build/args/all.gn

@@ -20,7 +20,3 @@ angle_enable_vulkan_validation_layers = false
 dawn_enable_vulkan_validation_layers = false
 
 is_cfi = false
-
-enable_osr = true
-
-enable_electron_extensions = true

build/strip_framework.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+import os
+import subprocess
+import sys
+
+source = sys.argv[1]
+dest = sys.argv[2]
+
+# Ensure any existing framework is removed
+subprocess.check_output(["rm", "-rf", dest])
+
+subprocess.check_output(["cp", "-a", source, dest])
+
+# Strip headers, we do not need to ship them
+subprocess.check_output(["rm", "-r", os.path.join(dest, 'Headers')])
+subprocess.check_output(["rm", "-r", os.path.join(dest, 'Versions', 'Current', 'Headers')])

build/webpack/get-outputs.js

@@ -1,2 +1,2 @@
-process.env.PRINT_WEBPACK_GRAPH = true
-require('./run-compiler')
+process.env.PRINT_WEBPACK_GRAPH = true;
+require('./run-compiler');

build/webpack/run-compiler.js

@@ -1,22 +1,38 @@
-const path = require('path')
-const webpack = require('webpack')
+const fs = require('fs');
+const path = require('path');
+const webpack = require('webpack');
 
-const configPath = process.argv[2]
-const outPath = path.resolve(process.argv[3])
-const config = require(configPath)
+const configPath = process.argv[2];
+const outPath = path.resolve(process.argv[3]);
+const config = require(configPath);
 config.output = {
   path: path.dirname(outPath),
   filename: path.basename(outPath)
-}
+};
+
+const { wrapInitWithProfilingTimeout } = config;
+delete config.wrapInitWithProfilingTimeout;
 
 webpack(config, (err, stats) => {
   if (err) {
-    console.error(err)
-    process.exit(1)
+    console.error(err);
+    process.exit(1);
   } else if (stats.hasErrors()) {
-    console.error(stats.toString('normal'))
-    process.exit(1)
+    console.error(stats.toString('normal'));
+    process.exit(1);
   } else {
-    process.exit(0)
+    if (wrapInitWithProfilingTimeout) {
+      const contents = fs.readFileSync(outPath, 'utf8');
+      const newContents = `function ___electron_webpack_init__() {
+${contents}
+};
+if ((globalThis.process || binding.process).argv.includes("--profile-electron-init")) {
+  setTimeout(___electron_webpack_init__, 0);
+} else {
+  ___electron_webpack_init__();
+}`;
+      fs.writeFileSync(outPath, newContents);
+    }
+    process.exit(0);
   }
-})
+});

build/webpack/webpack.config.asar.js

@@ -0,0 +1,5 @@
+module.exports = require('./webpack.config.base')({
+  target: 'asar',
+  alwaysHasNode: true,
+  targetDeletesNodeGlobals: true
+});

build/webpack/webpack.config.base.js

@@ -1,61 +1,118 @@
-const fs = require('fs')
-const path = require('path')
-const webpack = require('webpack')
+const fs = require('fs');
+const path = require('path');
+const webpack = require('webpack');
+const TerserPlugin = require('terser-webpack-plugin');
 
-const electronRoot = path.resolve(__dirname, '../..')
+const electronRoot = path.resolve(__dirname, '../..');
 
-const onlyPrintingGraph = !!process.env.PRINT_WEBPACK_GRAPH
+const onlyPrintingGraph = !!process.env.PRINT_WEBPACK_GRAPH;
 
 class AccessDependenciesPlugin {
-  apply(compiler) {
+  apply (compiler) {
     // Only hook into webpack when we are printing the dependency graph
-    if (!onlyPrintingGraph) return
+    if (!onlyPrintingGraph) return;
 
     compiler.hooks.compilation.tap('AccessDependenciesPlugin', compilation => {
       compilation.hooks.finishModules.tap('AccessDependenciesPlugin', modules => {
-        const filePaths = modules.map(m => m.resource).filter(p => p).map(p => path.relative(electronRoot, p))
-        console.info(JSON.stringify(filePaths))
-      })
-    })
+        const filePaths = modules.map(m => m.resource).filter(p => p).map(p => path.relative(electronRoot, p));
+        console.info(JSON.stringify(filePaths));
+      });
+    });
   }
 }
 
+const defines = {
+  BUILDFLAG: onlyPrintingGraph ? '(a => a)' : ''
+};
+
+const buildFlagsPrefix = '--buildflags=';
+const buildFlagArg = process.argv.find(arg => arg.startsWith(buildFlagsPrefix));
+
+if (buildFlagArg) {
+  const buildFlagPath = buildFlagArg.substr(buildFlagsPrefix.length);
+
+  const flagFile = fs.readFileSync(buildFlagPath, 'utf8');
+  for (const line of flagFile.split(/(\r\n|\r|\n)/g)) {
+    const flagMatch = line.match(/#define BUILDFLAG_INTERNAL_(.+?)\(\) \(([01])\)/);
+    if (flagMatch) {
+      const [, flagName, flagValue] = flagMatch;
+      defines[flagName] = JSON.stringify(Boolean(parseInt(flagValue, 10)));
+    }
+  }
+}
+
+const ignoredModules = [];
+
+if (defines.ENABLE_DESKTOP_CAPTURER === 'false') {
+  ignoredModules.push(
+    '@electron/internal/browser/desktop-capturer',
+    '@electron/internal/browser/api/desktop-capturer',
+    '@electron/internal/renderer/api/desktop-capturer'
+  );
+}
+
+if (defines.ENABLE_REMOTE_MODULE === 'false') {
+  ignoredModules.push(
+    '@electron/internal/browser/remote/server',
+    '@electron/internal/renderer/api/remote'
+  );
+}
+
+if (defines.ENABLE_VIEWS_API === 'false') {
+  ignoredModules.push(
+    '@electron/internal/browser/api/views/image-view.js'
+  );
+}
+
 module.exports = ({
   alwaysHasNode,
   loadElectronFromAlternateTarget,
   targetDeletesNodeGlobals,
-  target
+  target,
+  wrapInitWithProfilingTimeout
 }) => {
-  let entry = path.resolve(electronRoot, 'lib', target, 'init.ts')
+  let entry = path.resolve(electronRoot, 'lib', target, 'init.ts');
   if (!fs.existsSync(entry)) {
-    entry = path.resolve(electronRoot, 'lib', target, 'init.js')
+    entry = path.resolve(electronRoot, 'lib', target, 'init.js');
   }
 
+  const electronAPIFile = path.resolve(electronRoot, 'lib', loadElectronFromAlternateTarget || target, 'api', 'exports', 'electron.ts');
+
   return ({
     mode: 'development',
-    devtool: 'inline-source-map',
+    devtool: false,
     entry,
     target: alwaysHasNode ? 'node' : 'web',
     output: {
       filename: `${target}.bundle.js`
     },
+    wrapInitWithProfilingTimeout,
     resolve: {
       alias: {
         '@electron/internal': path.resolve(electronRoot, 'lib'),
-        'electron': path.resolve(electronRoot, 'lib', loadElectronFromAlternateTarget || target, 'api', 'exports', 'electron.ts'),
-        // Force timers to resolve to our dependency that doens't use window.postMessage
-        'timers': path.resolve(electronRoot, 'node_modules', 'timers-browserify', 'main.js')
+        electron$: electronAPIFile,
+        'electron/main$': electronAPIFile,
+        'electron/renderer$': electronAPIFile,
+        'electron/common$': electronAPIFile,
+        // Force timers to resolve to our dependency that doesn't use window.postMessage
+        timers: path.resolve(electronRoot, 'node_modules', 'timers-browserify', 'main.js')
       },
       extensions: ['.ts', '.js']
     },
     module: {
       rules: [{
+        test: (moduleName) => !onlyPrintingGraph && ignoredModules.includes(moduleName),
+        loader: 'null-loader'
+      }, {
         test: /\.ts$/,
         loader: 'ts-loader',
         options: {
           configFile: path.resolve(electronRoot, 'tsconfig.electron.json'),
           transpileOnly: onlyPrintingGraph,
-          ignoreDiagnostics: [6059]
+          ignoreDiagnostics: [
+            // File '{0}' is not under 'rootDir' '{1}'.
+            6059
+          ]
         }
       }]
     },
@@ -64,20 +121,32 @@ module.exports = ({
       __filename: false,
       // We provide our own "timers" import above, any usage of setImmediate inside
       // one of our renderer bundles should import it from the 'timers' package
-      setImmediate: false,
+      setImmediate: false
+    },
+    optimization: {
+      minimize: true,
+      minimizer: [
+        new TerserPlugin({
+          terserOptions: {
+            keep_classnames: true,
+            keep_fnames: true
+          }
+        })
+      ]
     },
     plugins: [
       new AccessDependenciesPlugin(),
       ...(targetDeletesNodeGlobals ? [
         new webpack.ProvidePlugin({
-          process: ['@electron/internal/renderer/webpack-provider', 'process'],
-          global: ['@electron/internal/renderer/webpack-provider', '_global'],
-          Buffer: ['@electron/internal/renderer/webpack-provider', 'Buffer'],
+          process: ['@electron/internal/common/webpack-provider', 'process'],
+          global: ['@electron/internal/common/webpack-provider', '_global'],
+          Buffer: ['@electron/internal/common/webpack-provider', 'Buffer']
         })
       ] : []),
       new webpack.ProvidePlugin({
-        Promise: ['@electron/internal/common/webpack-globals-provider', 'Promise'],
+        Promise: ['@electron/internal/common/webpack-globals-provider', 'Promise']
       }),
+      new webpack.DefinePlugin(defines)
     ]
-  })
-}
+  });
+};

build/webpack/webpack.config.browser.js

@@ -1,4 +1,4 @@
 module.exports = require('./webpack.config.base')({
   target: 'browser',
   alwaysHasNode: true
-})
+});

build/webpack/webpack.config.content_script.js

@@ -1,4 +0,0 @@
-module.exports = require('./webpack.config.base')({
-  target: 'content_script',
-  alwaysHasNode: false
-})

build/webpack/webpack.config.isolated_renderer.js

@@ -1,4 +1,4 @@
 module.exports = require('./webpack.config.base')({
   target: 'isolated_renderer',
   alwaysHasNode: false
-})
+});

build/webpack/webpack.config.renderer.js

@@ -1,5 +1,6 @@
 module.exports = require('./webpack.config.base')({
   target: 'renderer',
   alwaysHasNode: true,
-  targetDeletesNodeGlobals: true
-})
+  targetDeletesNodeGlobals: true,
+  wrapInitWithProfilingTimeout: true
+});

build/webpack/webpack.config.sandboxed_renderer.js

@@ -1,4 +1,5 @@
 module.exports = require('./webpack.config.base')({
   target: 'sandboxed_renderer',
-  alwaysHasNode: false
-})
+  alwaysHasNode: false,
+  wrapInitWithProfilingTimeout: true
+});

build/webpack/webpack.config.worker.js

@@ -3,4 +3,4 @@ module.exports = require('./webpack.config.base')({
   loadElectronFromAlternateTarget: 'renderer',
   alwaysHasNode: true,
   targetDeletesNodeGlobals: true
-})
+});

build/webpack/webpack.gni

@@ -16,6 +16,7 @@ template("webpack_build") {
     inputs = [
                invoker.config_file,
                "//electron/build/webpack/webpack.config.base.js",
+               "//electron/build/webpack/run-compiler.js",
                "//electron/tsconfig.json",
                "//electron/yarn.lock",
                "//electron/typings/internal-ambient.d.ts",
@@ -25,7 +26,9 @@ template("webpack_build") {
     args = [
       rebase_path(invoker.config_file),
       rebase_path(invoker.out_file),
+      "--buildflags=" + rebase_path("$target_gen_dir/buildflags/buildflags.h"),
     ]
+    deps += [ "buildflags" ]
 
     outputs = [ invoker.out_file ]
   }

build/zip.py

@@ -25,6 +25,15 @@ PATHS_TO_SKIP = [
   # //chrome/browser/resources/ssl/ssl_error_assistant, but we don't need to
   # ship it.
   'pyproto',
+
+  # On Windows, this binary doesn't exist (the crashpad handler is built-in).
+  # On MacOS, the binary is called 'chrome_crashpad_handler' and is inside the
+  # app bundle.
+  # On Linux, we don't use crashpad, but this binary is still built for some
+  # reason. Exclude it from the zip.
+  './crashpad_handler',
+
+  'resources/inspector', #Skipping because these are outputs that we don't need
 ]
 
 def skip_path(dep, dist_zip, target_cpu):

buildflags/buildflags.gni

@@ -32,7 +32,7 @@ declare_args() {
   enable_pepper_flash = true
 
   # Enable Chrome extensions support.
-  enable_electron_extensions = false
+  enable_electron_extensions = true
 
   # Enable Spellchecker support
   enable_builtin_spellchecker = true

chromium_src/BUILD.gn

@@ -12,8 +12,12 @@ import("//third_party/widevine/cdm/widevine.gni")
 static_library("chrome") {
   visibility = [ "//electron:electron_lib" ]
   sources = [
+    "//chrome/browser/accessibility/accessibility_ui.cc",
+    "//chrome/browser/accessibility/accessibility_ui.h",
     "//chrome/browser/browser_process.cc",
     "//chrome/browser/browser_process.h",
+    "//chrome/browser/crash_upload_list/crash_upload_list_crashpad.cc",
+    "//chrome/browser/crash_upload_list/crash_upload_list_crashpad.h",
     "//chrome/browser/devtools/devtools_contents_resizing_strategy.cc",
     "//chrome/browser/devtools/devtools_contents_resizing_strategy.h",
     "//chrome/browser/devtools/devtools_embedder_message_dispatcher.cc",
@@ -55,6 +59,8 @@ static_library("chrome") {
     "//chrome/browser/ui/views/autofill/autofill_popup_view_utils.h",
     "//chrome/browser/win/chrome_process_finder.cc",
     "//chrome/browser/win/chrome_process_finder.h",
+    "//chrome/child/v8_crashpad_support_win.cc",
+    "//chrome/child/v8_crashpad_support_win.h",
     "//extensions/browser/app_window/size_constraints.cc",
     "//extensions/browser/app_window/size_constraints.h",
   ]
@@ -62,12 +68,14 @@ static_library("chrome") {
     "//chrome/common",
     "//chrome/common:version_header",
     "//components/keyed_service/content",
+    "//components/paint_preview/buildflags",
     "//components/proxy_config",
     "//components/security_state/content",
     "//content/public/browser",
   ]
   deps = [
     "//chrome/browser:resource_prefetch_predictor_proto",
+    "//chrome/services/speech:buildflags",
     "//components/feature_engagement:buildflags",
     "//components/optimization_guide/proto:optimization_guide_proto",
   ]
@@ -88,6 +96,14 @@ static_library("chrome") {
     ]
   }
 
+  if (is_win) {
+    sources += [
+      "//chrome/browser/win/icon_reader_service.cc",
+      "//chrome/browser/win/icon_reader_service.h",
+    ]
+    public_deps += [ "//chrome/services/util_win:lib" ]
+  }
+
   if (enable_desktop_capturer) {
     sources += [
       "//chrome/browser/media/webrtc/desktop_media_list.h",
@@ -148,13 +164,6 @@ static_library("chrome") {
     }
   }
 
-  if (enable_tts) {
-    sources += [
-      "//chrome/browser/speech/tts_controller_delegate_impl.cc",
-      "//chrome/browser/speech/tts_controller_delegate_impl.h",
-    ]
-  }
-
   if (enable_widevine) {
     sources += [
       "//chrome/renderer/media/chrome_key_systems.cc",
@@ -239,17 +248,22 @@ static_library("chrome") {
     sources += [
       "//chrome/browser/extensions/chrome_url_request_util.cc",
       "//chrome/browser/extensions/chrome_url_request_util.h",
-      "//chrome/browser/pdf/pdf_extension_util.cc",
-      "//chrome/browser/pdf/pdf_extension_util.h",
       "//chrome/browser/plugins/plugin_response_interceptor_url_loader_throttle.cc",
       "//chrome/browser/plugins/plugin_response_interceptor_url_loader_throttle.h",
       "//chrome/renderer/extensions/extension_hooks_delegate.cc",
       "//chrome/renderer/extensions/extension_hooks_delegate.h",
       "//chrome/renderer/extensions/tabs_hooks_delegate.cc",
       "//chrome/renderer/extensions/tabs_hooks_delegate.h",
-      "//chrome/renderer/pepper/chrome_pdf_print_client.cc",
-      "//chrome/renderer/pepper/chrome_pdf_print_client.h",
     ]
+
+    if (enable_pdf_viewer) {
+      sources += [
+        "//chrome/browser/pdf/pdf_extension_util.cc",
+        "//chrome/browser/pdf/pdf_extension_util.h",
+        "//chrome/renderer/pepper/chrome_pdf_print_client.cc",
+        "//chrome/renderer/pepper/chrome_pdf_print_client.h",
+      ]
+    }
   }
 }
 
@@ -268,12 +282,14 @@ source_set("plugins") {
     "//chrome/browser/renderer_host/pepper/pepper_isolated_file_system_message_filter.h",
   ]
   deps += [
-    "//components/pdf/browser",
     "//media:media_buildflags",
     "//ppapi/buildflags",
     "//ppapi/proxy:ipc",
     "//services/device/public/mojom",
   ]
+  if (enable_pdf_viewer) {
+    deps += [ "//components/pdf/browser" ]
+  }
   if (enable_pepper_flash) {
     sources += [
       "//chrome/browser/renderer_host/pepper/pepper_flash_browser_host.cc",
@@ -319,9 +335,11 @@ source_set("plugins") {
       "//chrome/renderer/pepper/pepper_flash_font_file_host.cc",
       "//chrome/renderer/pepper/pepper_flash_font_file_host.h",
     ]
+    if (enable_pdf_viewer) {
+      deps += [ "//components/pdf/renderer" ]
+    }
   }
   deps += [
-    "//components/pdf/renderer",
     "//components/strings",
     "//media:media_buildflags",
     "//ppapi/host",
@@ -350,8 +368,8 @@ source_set("chrome_spellchecker") {
       "//chrome/browser/spellchecker/spellcheck_factory.h",
       "//chrome/browser/spellchecker/spellcheck_hunspell_dictionary.cc",
       "//chrome/browser/spellchecker/spellcheck_hunspell_dictionary.h",
-      "//chrome/browser/spellchecker/spellcheck_language_blacklist_policy_handler.cc",
-      "//chrome/browser/spellchecker/spellcheck_language_blacklist_policy_handler.h",
+      "//chrome/browser/spellchecker/spellcheck_language_blocklist_policy_handler.cc",
+      "//chrome/browser/spellchecker/spellcheck_language_blocklist_policy_handler.h",
       "//chrome/browser/spellchecker/spellcheck_language_policy_handler.cc",
       "//chrome/browser/spellchecker/spellcheck_language_policy_handler.h",
       "//chrome/browser/spellchecker/spellcheck_service.cc",

chromium_src/chrome/browser/process_singleton_posix.cc

@@ -68,7 +68,6 @@
 #include "base/logging.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
-#include "base/message_loop/message_loop.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/path_service.h"
 #include "base/posix/eintr_wrapper.h"

chromium_src/chrome/browser/ui/views/frame/global_menu_bar_registrar_x11.cc

@@ -24,18 +24,18 @@ GlobalMenuBarRegistrarX11* GlobalMenuBarRegistrarX11::GetInstance() {
   return base::Singleton<GlobalMenuBarRegistrarX11>::get();
 }
 
-void GlobalMenuBarRegistrarX11::OnWindowMapped(unsigned long xid) {
-  live_xids_.insert(xid);
+void GlobalMenuBarRegistrarX11::OnWindowMapped(x11::Window window) {
+  live_windows_.insert(window);
 
   if (registrar_proxy_)
-    RegisterXID(xid);
+    RegisterXWindow(window);
 }
 
-void GlobalMenuBarRegistrarX11::OnWindowUnmapped(unsigned long xid) {
+void GlobalMenuBarRegistrarX11::OnWindowUnmapped(x11::Window window) {
   if (registrar_proxy_)
-    UnregisterXID(xid);
+    UnregisterXWindow(window);
 
-  live_xids_.erase(xid);
+  live_windows_.erase(window);
 }
 
 GlobalMenuBarRegistrarX11::GlobalMenuBarRegistrarX11()
@@ -63,9 +63,9 @@ GlobalMenuBarRegistrarX11::~GlobalMenuBarRegistrarX11() {
   }
 }
 
-void GlobalMenuBarRegistrarX11::RegisterXID(unsigned long xid) {
+void GlobalMenuBarRegistrarX11::RegisterXWindow(x11::Window window) {
   DCHECK(registrar_proxy_);
-  std::string path = electron::GlobalMenuBarX11::GetPathForWindow(xid);
+  std::string path = electron::GlobalMenuBarX11::GetPathForWindow(window);
 
   ANNOTATE_SCOPED_MEMORY_LEAK;  // http://crbug.com/314087
   // TODO(erg): The mozilla implementation goes to a lot of callback trouble
@@ -76,13 +76,13 @@ void GlobalMenuBarRegistrarX11::RegisterXID(unsigned long xid) {
   // I don't see any reason why we should care if "RegisterWindow" completes or
   // not.
   g_dbus_proxy_call(registrar_proxy_, "RegisterWindow",
-                    g_variant_new("(uo)", xid, path.c_str()),
+                    g_variant_new("(uo)", window, path.c_str()),
                     G_DBUS_CALL_FLAGS_NONE, -1, nullptr, nullptr, nullptr);
 }
 
-void GlobalMenuBarRegistrarX11::UnregisterXID(unsigned long xid) {
+void GlobalMenuBarRegistrarX11::UnregisterXWindow(x11::Window window) {
   DCHECK(registrar_proxy_);
-  std::string path = electron::GlobalMenuBarX11::GetPathForWindow(xid);
+  std::string path = electron::GlobalMenuBarX11::GetPathForWindow(window);
 
   ANNOTATE_SCOPED_MEMORY_LEAK;  // http://crbug.com/314087
   // TODO(erg): The mozilla implementation goes to a lot of callback trouble
@@ -93,7 +93,7 @@ void GlobalMenuBarRegistrarX11::UnregisterXID(unsigned long xid) {
   // I don't see any reason why we should care if "UnregisterWindow" completes
   // or not.
   g_dbus_proxy_call(registrar_proxy_, "UnregisterWindow",
-                    g_variant_new("(u)", xid), G_DBUS_CALL_FLAGS_NONE, -1,
+                    g_variant_new("(u)", window), G_DBUS_CALL_FLAGS_NONE, -1,
                     nullptr, nullptr, nullptr);
 }
 
@@ -120,10 +120,10 @@ void GlobalMenuBarRegistrarX11::OnProxyCreated(GObject* source,
 
 void GlobalMenuBarRegistrarX11::OnNameOwnerChanged(GObject* /* ignored */,
                                                    GParamSpec* /* ignored */) {
-  // If the name owner changed, we need to reregister all the live xids with
-  // the system.
-  for (std::set<unsigned long>::const_iterator it = live_xids_.begin();
-       it != live_xids_.end(); ++it) {
-    RegisterXID(*it);
+  // If the name owner changed, we need to reregister all the live x11::Window
+  // with the system.
+  for (std::set<x11::Window>::const_iterator it = live_windows_.begin();
+       it != live_windows_.end(); ++it) {
+    RegisterXWindow(*it);
   }
 }

chromium_src/chrome/browser/ui/views/frame/global_menu_bar_registrar_x11.h

@@ -12,19 +12,20 @@
 #include "base/memory/ref_counted.h"
 #include "base/memory/singleton.h"
 #include "ui/base/glib/glib_signal.h"
+#include "ui/gfx/x/xproto.h"
 
 // Advertises our menu bars to Unity.
 //
 // GlobalMenuBarX11 is responsible for managing the DbusmenuServer for each
-// XID. We need a separate object to own the dbus channel to
+// x11::Window. We need a separate object to own the dbus channel to
 // com.canonical.AppMenu.Registrar and to register/unregister the mapping
-// between a XID and the DbusmenuServer instance we are offering.
+// between a x11::Window and the DbusmenuServer instance we are offering.
 class GlobalMenuBarRegistrarX11 {
  public:
   static GlobalMenuBarRegistrarX11* GetInstance();
 
-  void OnWindowMapped(unsigned long xid);
-  void OnWindowUnmapped(unsigned long xid);
+  void OnWindowMapped(x11::Window window);
+  void OnWindowUnmapped(x11::Window window);
 
  private:
   friend struct base::DefaultSingletonTraits<GlobalMenuBarRegistrarX11>;
@@ -33,8 +34,8 @@ class GlobalMenuBarRegistrarX11 {
   ~GlobalMenuBarRegistrarX11();
 
   // Sends the actual message.
-  void RegisterXID(unsigned long xid);
-  void UnregisterXID(unsigned long xid);
+  void RegisterXWindow(x11::Window window);
+  void UnregisterXWindow(x11::Window window);
 
   CHROMEG_CALLBACK_1(GlobalMenuBarRegistrarX11,
                      void,
@@ -49,9 +50,9 @@ class GlobalMenuBarRegistrarX11 {
 
   GDBusProxy* registrar_proxy_;
 
-  // Window XIDs which want to be registered, but haven't yet been because
+  // x11::Window which want to be registered, but haven't yet been because
   // we're waiting for the proxy to become available.
-  std::set<unsigned long> live_xids_;
+  std::set<x11::Window> live_windows_;
 
   DISALLOW_COPY_AND_ASSIGN(GlobalMenuBarRegistrarX11);
 };

default_app/default_app.ts

@@ -1,5 +1,6 @@
 import { app, dialog, BrowserWindow, shell, ipcMain } from 'electron';
 import * as path from 'path';
+import * as url from 'url';
 
 let mainWindow: BrowserWindow | null = null;
 
@@ -29,12 +30,11 @@ function isTrustedSender (webContents: Electron.WebContents) {
     return false;
   }
 
-  const parsedUrl = new URL(webContents.getURL());
-  const urlPath = process.platform === 'win32'
-    // Strip the prefixed "/" that occurs on windows
-    ? path.resolve(parsedUrl.pathname.substr(1))
-    : parsedUrl.pathname;
-  return parsedUrl.protocol === 'file:' && urlPath === indexPath;
+  try {
+    return url.fileURLToPath(webContents.getURL()) === indexPath;
+  } catch {
+    return false;
+  }
 }
 
 ipcMain.handle('bootstrap', (event) => {

default_app/index.html

@@ -53,31 +53,31 @@
     <nav>
       <div class="linkcol">
         <a class="hero-link" target="_blank" href="https://electronjs.org/blog">
-          <span class="octicon hero-octicon octicon-gist" aria-hidden="true"></span>
+          <span class="octicon hero-octicon octicon-code-square-24" aria-hidden="true"></span>
           <h4>Blog</h4>
         </a>
       </div>
       <div class="linkcol">
         <a class="hero-link" target="_blank" href="https://github.com/electron/electron">
-          <span class="octicon hero-octicon octicon-mark-github" aria-hidden="true"></span>
+          <span class="octicon hero-octicon octicon-mark-github-16" aria-hidden="true"></span>
           <h4>Repository</h4>
         </a>
       </div>
       <div class="linkcol">
         <a class="hero-link" target="_blank" href="https://electronjs.org/docs">
-          <span class="octicon hero-octicon octicon-gear" aria-hidden="true"></span>
+          <span class="octicon hero-octicon octicon-book-24" aria-hidden="true"></span>
           <h4>Docs</h4>
         </a>
       </div>
       <div class="linkcol">
         <a class="hero-link" target="_blank" href="https://github.com/electron/electron-api-demos">
-          <span class="octicon hero-octicon octicon-star" aria-hidden="true"></span>
+          <span class="octicon hero-octicon octicon-star-fill-24" aria-hidden="true"></span>
           <h4>API Demos</h4>
         </a>
       </div>
       <div class="linkcol">
         <a class="hero-link" target="_blank" href="https://electronforge.io">
-          <span class="octicon hero-octicon octicon-gift" aria-hidden="true"></span>
+          <span class="octicon hero-octicon octicon-gift-24" aria-hidden="true"></span>
           <h4>Forge</h4>
         </a>
       </div>

default_app/main.ts

@@ -1,8 +1,9 @@
-import { app, dialog } from 'electron';
+import * as electron from 'electron';
 
 import * as fs from 'fs';
 import * as path from 'path';
 import * as url from 'url';
+const { app, dialog } = electron;
 
 type DefaultAppOptions = {
   file: null | string;
@@ -145,13 +146,90 @@ function startRepl () {
     process.exit(1);
   }
 
-  // prevent quitting
+  // Prevent quitting.
   app.on('window-all-closed', () => {});
 
-  const repl = require('repl');
-  repl.start('> ').on('exit', () => {
+  const GREEN = '32';
+  const colorize = (color: string, s: string) => `\x1b[${color}m${s}\x1b[0m`;
+  const electronVersion = colorize(GREEN, `v${process.versions.electron}`);
+  const nodeVersion = colorize(GREEN, `v${process.versions.node}`);
+
+  console.info(`
+    Welcome to the Electron.js REPL \\[._.]/
+
+    You can access all Electron.js modules here as well as Node.js modules.
+    Using: Node.js ${nodeVersion} and Electron.js ${electronVersion}
+  `);
+
+  const { REPLServer } = require('repl');
+  const repl = new REPLServer({
+    prompt: '> '
+  }).on('exit', () => {
     process.exit(0);
   });
+
+  function defineBuiltin (context: any, name: string, getter: Function) {
+    const setReal = (val: any) => {
+      // Deleting the property before re-assigning it disables the
+      // getter/setter mechanism.
+      delete context[name];
+      context[name] = val;
+    };
+
+    Object.defineProperty(context, name, {
+      get: () => {
+        const lib = getter();
+
+        delete context[name];
+        Object.defineProperty(context, name, {
+          get: () => lib,
+          set: setReal,
+          configurable: true,
+          enumerable: false
+        });
+
+        return lib;
+      },
+      set: setReal,
+      configurable: true,
+      enumerable: false
+    });
+  }
+
+  defineBuiltin(repl.context, 'electron', () => electron);
+  for (const api of Object.keys(electron) as (keyof typeof electron)[]) {
+    defineBuiltin(repl.context, api, () => electron[api]);
+  }
+
+  // Copied from node/lib/repl.js. For better DX, we don't want to
+  // show e.g 'contentTracing' at a higher priority than 'const', so
+  // we only trigger custom tab-completion when no common words are
+  // potentially matches.
+  const commonWords = [
+    'async', 'await', 'break', 'case', 'catch', 'const', 'continue',
+    'debugger', 'default', 'delete', 'do', 'else', 'export', 'false',
+    'finally', 'for', 'function', 'if', 'import', 'in', 'instanceof', 'let',
+    'new', 'null', 'return', 'switch', 'this', 'throw', 'true', 'try',
+    'typeof', 'var', 'void', 'while', 'with', 'yield'
+  ];
+
+  const electronBuiltins = [...Object.keys(electron), 'original-fs', 'electron'];
+
+  const defaultComplete = repl.completer;
+  repl.completer = (line: string, callback: Function) => {
+    const lastSpace = line.lastIndexOf(' ');
+    const currentSymbol = line.substring(lastSpace + 1, repl.cursor);
+
+    const filterFn = (c: string) => c.startsWith(currentSymbol);
+    const ignores = commonWords.filter(filterFn);
+    const hits = electronBuiltins.filter(filterFn);
+
+    if (!ignores.length && hits.length) {
+      callback(null, [hits, currentSymbol]);
+    } else {
+      defaultComplete.apply(repl, [line, callback]);
+    }
+  };
 }
 
 // Start the specified app if there is one specified in command line, otherwise

docs/README.md

@@ -92,7 +92,6 @@ These individual tutorials expand on topics discussed in the guide above.
 * Electron Releases & Developer Feedback
   * [Versioning Policy](tutorial/electron-versioning.md)
   * [Release Timelines](tutorial/electron-timelines.md)
-  * [App Feedback Program](tutorial/app-feedback-program.md)
 * [Packaging App Source Code with asar](tutorial/application-packaging.md)
   * [Generating asar Archives](tutorial/application-packaging.md#generating-asar-archives)
   * [Using asar Archives](tutorial/application-packaging.md#using-asar-archives)

docs/api/app.md

@@ -140,6 +140,16 @@ this event, such as launching the application for the first time, attempting
 to re-launch the application when it's already running, or clicking on the
 application's dock or taskbar icon.
 
+### Event: 'did-become-active' _macOS_
+
+Returns:
+
+* `event` Event
+
+Emitted when mac application become active. Difference from `activate` event is
+that `did-become-active` is emitted every time the app becomes active, not only
+when Dock icon is clicked or application is re-launched.
+
 ### Event: 'continue-activity' _macOS_
 
 Returns:
@@ -359,7 +369,7 @@ Returns:
 
 Emitted when the GPU process crashes or is killed.
 
-### Event: 'renderer-process-crashed'
+### Event: 'renderer-process-crashed' _Deprecated_
 
 Returns:
 
@@ -369,6 +379,30 @@ Returns:
 
 Emitted when the renderer process of `webContents` crashes or is killed.
 
+**Deprecated:** This event is superceded by the `render-process-gone` event
+which contains more information about why the render process dissapeared. It
+isn't always because it crashed.  The `killed` boolean can be replaced by
+checking `reason === 'killed'` when you switch to that event.
+
+#### Event: 'render-process-gone'
+
+Returns:
+
+* `event` Event
+* `webContents` [WebContents](web-contents.md)
+* `details` Object
+  * `reason` String - The reason the render process is gone.  Possible values:
+    * `clean-exit` - Process exited with an exit code of zero
+    * `abnormal-exit` - Process exited with a non-zero exit code
+    * `killed` - Process was sent a SIGTERM or otherwise killed externally
+    * `crashed` - Process crashed
+    * `oom` - Process ran out of memory
+    * `launch-failure` - Process never successfully launched
+    * `integrity-failure` - Windows code integrity checks failed
+
+Emitted when the renderer process unexpectedly dissapears.  This is normally
+because it was crashed or killed.
+
 ### Event: 'accessibility-support-changed' _macOS_ _Windows_
 
 Returns:
@@ -414,6 +448,8 @@ and `workingDirectory` is its current working directory. Usually
 applications respond to this by making their primary window focused and
 non-minimized.
 
+**Note:** If the second instance is started by a different user than the first, the `argv` array will not include the arguments.
+
 This event is guaranteed to be emitted after the `ready` event of `app`
 gets emitted.
 
@@ -606,8 +642,10 @@ Returns `String` - The current application directory.
   * `music` Directory for a user's music.
   * `pictures` Directory for a user's pictures.
   * `videos` Directory for a user's videos.
+  * `recent` Directory for the user's recent files (Windows only).
   * `logs` Directory for your app's log folder.
   * `pepperFlashSystemPlugin` Full path to the system version of the Pepper Flash plugin.
+  * `crashDumps` Directory where crash dumps are stored.
 
 Returns `String` - A path to a special directory or file associated with `name`. On
 failure, an `Error` is thrown.
@@ -777,6 +815,20 @@ Returns `String` - Name of the application handling the protocol, or an empty
 This method returns the application name of the default handler for the protocol
 (aka URI scheme) of a URL.
 
+### `app.getApplicationInfoForProtocol(url)` _macOS_ _Windows_
+
+* `url` String - a URL with the protocol name to check. Unlike the other
+  methods in this family, this accepts an entire URL, including `://` at a
+  minimum (e.g. `https://`).
+
+Returns `Promise<Object>` - Resolve with an object containing the following:
+  * `icon` NativeImage - the display icon of the app handling the protocol.
+  * `path` String  - installation path of the app handling the protocol.
+  * `name` String - display name of the app handling the protocol.
+
+This method returns a promise that contains the application name, icon and path of the default handler for the protocol
+(aka URI scheme) of a URL.
+
 ### `app.setUserTasks(tasks)` _Windows_
 
 * `tasks` [Task[]](structures/task.md) - Array of `Task` objects
@@ -938,6 +990,7 @@ if (!gotTheLock) {
 
   // Create myWindow, load the rest of the app, etc...
   app.whenReady().then(() => {
+    myWindow = createWindow()
   })
 }
 ```
@@ -1053,8 +1106,10 @@ For `infoType` equal to `complete`:
 For `infoType` equal to `basic`:
   Promise is fulfilled with `Object` containing fewer attributes than when requested with `complete`. Here's an example of basic response:
 ```js
-{ auxAttributes:
-   { amdSwitchable: true,
+{
+  auxAttributes:
+   {
+     amdSwitchable: true,
      canSupportThreadedTextureMailbox: false,
      directComposition: false,
      directRendering: true,
@@ -1067,12 +1122,14 @@ For `infoType` equal to `basic`:
      sandboxed: false,
      softwareRendering: false,
      supportsOverlays: false,
-     videoDecodeAcceleratorFlags: 0 },
-gpuDevice:
-   [ { active: true, deviceId: 26657, vendorId: 4098 },
-     { active: false, deviceId: 3366, vendorId: 32902 } ],
-machineModelName: 'MacBookPro',
-machineModelVersion: '11.5' }
+     videoDecodeAcceleratorFlags: 0
+   },
+  gpuDevice:
+   [{ active: true, deviceId: 26657, vendorId: 4098 },
+     { active: false, deviceId: 3366, vendorId: 32902 }],
+  machineModelName: 'MacBookPro',
+  machineModelVersion: '11.5'
+}
 ```
 
 Using `basic` should be preferred if only basic information like `vendorId` or `driverId` is needed.
@@ -1194,7 +1251,7 @@ Show the app's about panel options. These options can be overridden with `app.se
   * `credits` String (optional) _macOS_ _Windows_ - Credit information.
   * `authors` String[] (optional) _Linux_ - List of app authors.
   * `website` String (optional) _Linux_ - The app's website.
-  * `iconPath` String (optional) _Linux_ _Windows_ - Path to the app's icon. On Linux, will be shown as 64x64 pixels while retaining aspect ratio.
+  * `iconPath` String (optional) _Linux_ _Windows_ - Path to the app's icon in a JPEG or PNG file format. On Linux, will be shown as 64x64 pixels while retaining aspect ratio.
 
 Set the about panel options. This will override the values defined in the app's `.plist` file on macOS. See the [Apple docs][about-panel-options] for more details. On Linux, values must be set in order to be shown; there are no defaults.
 
@@ -1276,6 +1333,25 @@ app.moveToApplicationsFolder({
 
 Would mean that if an app already exists in the user directory, if the user chooses to 'Continue Move' then the function would continue with its default behavior and the existing app will be trashed and the active app moved into its place.
 
+### `app.isSecureKeyboardEntryEnabled()` _macOS_
+
+Returns `Boolean` - whether `Secure Keyboard Entry` is enabled.
+
+By default this API will return `false`.
+
+### `app.setSecureKeyboardEntryEnabled(enabled)` _macOS_
+
+* `enabled` Boolean - Enable or disable `Secure Keyboard Entry`
+
+Set the `Secure Keyboard Entry` is enabled in your application.
+
+By using this API, important information such as password and other sensitive information can be prevented from being intercepted by other processes.
+
+See [Apple's documentation](https://developer.apple.com/library/archive/technotes/tn2150/_index.html) for more
+details.
+
+**Note:** Enable `Secure Keyboard Entry` only when it is needed and disable it when it is no longer needed.
+
 ## Properties
 
 ### `app.accessibilitySupportEnabled` _macOS_ _Windows_
@@ -1302,6 +1378,9 @@ On macOS, setting this with any nonzero integer shows on the dock icon. On Linux
 **Note:** Unity launcher requires the existence of a `.desktop` file to work,
 for more information please read [Desktop Environment Integration][unity-requirement].
 
+**Note:** On macOS, you need to ensure that your application has the permission
+to display notifications for this property to take effect.
+
 ### `app.commandLine` _Readonly_
 
 A [`CommandLine`](./command-line.md) object that allows you to read and manipulate the
@@ -1353,7 +1432,7 @@ in your app's initialization to ensure that your overridden value is used.
 
 A `Boolean` which when `true` disables the overrides that Electron has in place
 to ensure renderer processes are restarted on every navigation.  The current
-default value for this property is `false`.
+default value for this property is `true`.
 
 The intention is for these overrides to become disabled by default and then at
 some point in the future this property will be removed.  This property impacts

docs/api/browser-view.md

@@ -28,25 +28,6 @@ view.webContents.loadURL('https://electronjs.org')
 * `options` Object (optional)
   * `webPreferences` Object (optional) - See [BrowserWindow](browser-window.md).
 
-### Static Methods
-
-#### `BrowserView.getAllViews()`
-
-Returns `BrowserView[]` - An array of all opened BrowserViews.
-
-#### `BrowserView.fromWebContents(webContents)`
-
-* `webContents` [WebContents](web-contents.md)
-
-Returns `BrowserView | null` - The BrowserView that owns the given `webContents`
-or `null` if the contents are not owned by a BrowserView.
-
-#### `BrowserView.fromId(id)`
-
-* `id` Integer
-
-Returns `BrowserView` - The view with the given `id`.
-
 ### Instance Properties
 
 Objects created with `new BrowserView` have the following properties:
@@ -55,10 +36,6 @@ Objects created with `new BrowserView` have the following properties:
 
 A [`WebContents`](web-contents.md) object owned by this view.
 
-#### `view.id` _Experimental_
-
-A `Integer` representing the unique ID of the view.
-
 ### Instance Methods
 
 Objects created with `new BrowserView` have the following instance methods:

docs/api/browser-window.md

@@ -38,7 +38,7 @@ the window after this event will have no visual flash:
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow({ show: false })
+const win = new BrowserWindow({ show: false })
 win.once('ready-to-show', () => {
   win.show()
 })
@@ -60,7 +60,7 @@ immediately, and use a `backgroundColor` close to your app's background:
 ```javascript
 const { BrowserWindow } = require('electron')
 
-let win = new BrowserWindow({ backgroundColor: '#2e2c29' })
+const win = new BrowserWindow({ backgroundColor: '#2e2c29' })
 win.loadURL('https://github.com')
 ```
 
@@ -74,8 +74,8 @@ By using `parent` option, you can create child windows:
 ```javascript
 const { BrowserWindow } = require('electron')
 
-let top = new BrowserWindow()
-let child = new BrowserWindow({ parent: top })
+const top = new BrowserWindow()
+const child = new BrowserWindow({ parent: top })
 child.show()
 top.show()
 ```
@@ -90,7 +90,7 @@ window, you have to set both `parent` and `modal` options:
 ```javascript
 const { BrowserWindow } = require('electron')
 
-let child = new BrowserWindow({ parent: top, modal: true, show: false })
+const child = new BrowserWindow({ parent: top, modal: true, show: false })
 child.loadURL('https://github.com')
 child.once('ready-to-show', () => {
   child.show()
@@ -385,6 +385,15 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
       visible to users.
     * `spellcheck` Boolean (optional) - Whether to enable the builtin spellchecker.
       Default is `true`.
+    * `enableWebSQL` Boolean (optional) - Whether to enable the [WebSQL api](https://www.w3.org/TR/webdatabase/).
+      Default is `true`.
+    * `v8CacheOptions` String (optional) - Enforces the v8 code caching policy
+      used by blink. Accepted values are
+      * `none` - Disables code caching
+      * `code` - Heuristic based code caching
+      * `bypassHeatCheck` - Bypass code caching heuristics but with lazy compilation
+      * `bypassHeatCheckAndEagerCompile` - Same as above except compilation is eager.
+      Default policy is `code`.
 
 When setting minimum or maximum window size with `minWidth`/`maxWidth`/
 `minHeight`/`maxHeight`, it only constrains the users. It won't prevent you from
@@ -588,7 +597,7 @@ e.g. `APPCOMMAND_BROWSER_BACKWARD` is emitted as `browser-backward`.
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 win.on('app-command', (e, cmd) => {
   // Navigate the window back when the user hits their mouse back button
   if (cmd === 'browser-backward' && win.webContents.canGoBack()) {
@@ -623,6 +632,12 @@ Returns:
 
 Emitted on 3-finger swipe. Possible directions are `up`, `right`, `down`, `left`.
 
+The method underlying this event is built to handle older macOS-style trackpad swiping,
+where the content on the screen doesn't move with the swipe. Most macOS trackpads are not
+configured to allow this kind of swiping anymore, so in order for it to emit properly the
+'Swipe between pages' preference in `System Preferences > Trackpad > More Gestures` must be
+set to 'Swipe with two or three fingers'.
+
 #### Event: 'rotate-gesture' _macOS_
 
 Returns:
@@ -677,7 +692,7 @@ Returns `BrowserWindow | null` - The window that owns the given `browserView`. I
 
 * `id` Integer
 
-Returns `BrowserWindow` - The window with the given `id`.
+Returns `BrowserWindow | null` - The window with the given `id`.
 
 #### `BrowserWindow.addExtension(path)` _Deprecated_
 
@@ -757,7 +772,7 @@ To check if a DevTools extension is installed you can run the following:
 ```javascript
 const { BrowserWindow } = require('electron')
 
-let installed = BrowserWindow.getDevToolsExtensions().hasOwnProperty('devtron')
+const installed = 'devtron' in BrowserWindow.getDevToolsExtensions()
 console.log(installed)
 ```
 
@@ -774,7 +789,7 @@ Objects created with `new BrowserWindow` have the following properties:
 ```javascript
 const { BrowserWindow } = require('electron')
 // In this example `win` is our instance
-let win = new BrowserWindow({ width: 800, height: 600 })
+const win = new BrowserWindow({ width: 800, height: 600 })
 win.loadURL('https://github.com')
 ```
 
@@ -801,6 +816,10 @@ hide it immediately.
 
 A `Boolean` property that determines whether the window is in simple (pre-Lion) fullscreen mode.
 
+#### `win.fullScreen`
+
+A `Boolean` property that determines whether the window is in fullscreen mode.
+
 #### `win.visibleOnAllWorkspaces`
 
 A `Boolean` property that determines whether the window is visible on all workspaces.
@@ -1104,7 +1123,7 @@ Disable or enable the window.
 
 #### `win.isEnabled()`
 
-Returns Boolean - whether the window is enabled.
+Returns `Boolean` - whether the window is enabled.
 
 #### `win.setSize(width, height[, animate])`
 
@@ -1295,9 +1314,9 @@ a HTML-rendered toolbar. For example:
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 
-let toolbarRect = document.getElementById('toolbar').getBoundingClientRect()
+const toolbarRect = document.getElementById('toolbar').getBoundingClientRect()
 win.setSheetOffset(toolbarRect.height)
 ```
 
@@ -1421,7 +1440,7 @@ Node's [`url.format`](https://nodejs.org/api/url.html#url_url_format_urlobject)
 method:
 
 ```javascript
-let url = require('url').format({
+const url = require('url').format({
   protocol: 'file',
   slashes: true,
   pathname: require('path').join(__dirname, 'index.html')

docs/api/command-line-switches.md

@@ -36,6 +36,10 @@ for integrated authentication. Without `*` prefix the URL has to match exactly.
 A comma-separated list of servers for which delegation of user credentials is required.
 Without `*` prefix the URL has to match exactly.
 
+### --disable-ntlm-v2
+
+Disables NTLM v2 for posix platforms, no effect elsewhere.
+
 ### --disable-http-cache
 
 Disables the disk cache for HTTP requests.

docs/api/crash-reporter.md

@@ -4,18 +4,13 @@
 
 Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
 
-The following is an example of automatically submitting a crash report to a
-remote server:
+The following is an example of setting up Electron to automatically submit
+crash reports to a remote server:
 
 ```javascript
 const { crashReporter } = require('electron')
 
-crashReporter.start({
-  productName: 'YourName',
-  companyName: 'YourCompany',
-  submitURL: 'https://your-domain.com/url-to-submit',
-  uploadToServer: true
-})
+crashReporter.start({ submitURL: 'https://your-domain.com/url-to-submit' })
 ```
 
 For setting up a server to accept and process crash reports, you can use
@@ -30,11 +25,19 @@ Or use a 3rd party hosted solution:
 * [Sentry](https://docs.sentry.io/clients/electron)
 * [BugSplat](https://www.bugsplat.com/docs/platforms/electron)
 
-Crash reports are saved locally in an application-specific temp directory folder.
-For a `productName` of `YourName`, crash reports will be stored in a folder
-named `YourName Crashes` inside the temp directory. You can customize this temp
-directory location for your app by calling the `app.setPath('temp', '/my/custom/temp')`
-API before starting the crash reporter.
+Crash reports are stored temporarily before being uploaded in a directory
+underneath the app's user data directory (called 'Crashpad' on Windows and Mac,
+or 'Crash Reports' on Linux). You can override this directory by calling
+`app.setPath('crashDumps', '/path/to/crashes')` before starting the crash
+reporter.
+
+On Windows and macOS, Electron uses
+[crashpad](https://chromium.googlesource.com/crashpad/crashpad/+/master/README.md)
+to monitor and report crashes. On Linux, Electron uses
+[breakpad](https://chromium.googlesource.com/breakpad/breakpad/+/master/). This
+is an implementation detail driven by Chromium, and it may change in future. In
+particular, crashpad is newer and will likely eventually replace breakpad on
+all platforms.
 
 ## Methods
 
@@ -43,45 +46,67 @@ The `crashReporter` module has the following methods:
 ### `crashReporter.start(options)`
 
 * `options` Object
-  * `companyName` String
   * `submitURL` String - URL that crash reports will be sent to as POST.
   * `productName` String (optional) - Defaults to `app.name`.
-  * `uploadToServer` Boolean (optional) - Whether crash reports should be sent to the server. Default is `true`.
-  * `ignoreSystemCrashHandler` Boolean (optional) - Default is `false`.
+  * `companyName` String (optional) _Deprecated_ - Deprecated alias for
+    `{ globalExtra: { _companyName: ... } }`.
+  * `uploadToServer` Boolean (optional) - Whether crash reports should be sent
+    to the server. If false, crash reports will be collected and stored in the
+    crashes directory, but not uploaded. Default is `true`.
+  * `ignoreSystemCrashHandler` Boolean (optional) - If true, crashes generated
+    in the main process will not be forwarded to the system crash handler.
+    Default is `false`.
   * `rateLimit` Boolean (optional) _macOS_ _Windows_ - If true, limit the
     number of crashes uploaded to 1/hour. Default is `false`.
-  * `compress` Boolean (optional) _macOS_ _Windows_ - If true, crash reports
-    will be compressed and uploaded with `Content-Encoding: gzip`. Not all
-    collection servers support compressed payloads. Default is `false`.
-  * `extra` Record<String, String> (optional) - An object you can define that will be sent along with the
-    report. Only string properties are sent correctly. Nested objects are not
-    supported. When using Windows, the property names and values must be fewer than 64 characters.
-  * `crashesDirectory` String (optional) - Directory to store the crash reports temporarily (only used when the crash reporter is started via `process.crashReporter.start`).
+  * `compress` Boolean (optional) - If true, crash reports will be compressed
+    and uploaded with `Content-Encoding: gzip`. Default is `false`.
+  * `extra` Record<String, String> (optional) - Extra string key/value
+    annotations that will be sent along with crash reports that are generated
+    in the main process. Only string values are supported. Crashes generated in
+    child processes will not contain these extra
+    parameters to crash reports generated from child processes, call
+    [`addExtraParameter`](#crashreporteraddextraparameterkey-value) from the
+    child process.
+  * `globalExtra` Record<String, String> (optional) - Extra string key/value
+    annotations that will be sent along with any crash reports generated in any
+    process. These annotations cannot be changed once the crash reporter has
+    been started. If a key is present in both the global extra parameters and
+    the process-specific extra parameters, then the global one will take
+    precedence. By default, `productName` and the app version are included, as
+    well as the Electron version.
 
-You are required to call this method before using any other `crashReporter` APIs
-and in each process (main/renderer) from which you want to collect crash reports.
-You can pass different options to `crashReporter.start` when calling from different processes.
+This method must be called before using any other `crashReporter` APIs. Once
+initialized this way, the crashpad handler collects crashes from all
+subsequently created processes. The crash reporter cannot be disabled once
+started.
 
-**Note** Child processes created via the `child_process` module will not have access to the Electron modules.
-Therefore, to collect crash reports from them, use `process.crashReporter.start` instead. Pass the same options as above
-along with an additional one called `crashesDirectory` that should point to a directory to store the crash
-reports temporarily. You can test this out by calling `process.crash()` to crash the child process.
+This method should be called as early as possible in app startup, preferably
+before `app.on('ready')`. If the crash reporter is not initialized at the time
+a renderer process is created, then that renderer process will not be monitored
+by the crash reporter.
 
-**Note:** If you need send additional/updated `extra` parameters after your
-first call `start` you can call `addExtraParameter` on macOS or call `start`
-again with the new/updated `extra` parameters on Linux and Windows.
+**Note:** You can test out the crash reporter by generating a crash using
+`process.crash()`.
 
-**Note:** On macOS and windows, Electron uses a new `crashpad` client for crash collection and reporting.
-If you want to enable crash reporting, initializing `crashpad` from the main process using `crashReporter.start` is required
-regardless of which process you want to collect crashes from. Once initialized this way, the crashpad handler collects
-crashes from all processes. You still have to call `crashReporter.start` from the renderer or child process, otherwise crashes from
-them will get reported without `companyName`, `productName` or any of the `extra` information.
+**Note:** If you need to send additional/updated `extra` parameters after your
+first call `start` you can call `addExtraParameter`.
+
+**Note:** Parameters passed in `extra`, `globalExtra` or set with
+`addExtraParameter` have limits on the length of the keys and values. Key names
+must be at most 39 bytes long, and values must be no longer than 127 bytes.
+Keys with names longer than the maximum will be silently ignored. Key values
+longer than the maximum length will be truncated.
+
+**Note:** Calling this method from the renderer process is deprecated.
 
 ### `crashReporter.getLastCrashReport()`
 
-Returns [`CrashReport`](structures/crash-report.md):
+Returns [`CrashReport`](structures/crash-report.md) - The date and ID of the
+last crash report. Only crash reports that have been uploaded will be returned;
+even if a crash report is present on disk it will not be returned until it is
+uploaded. In the case that there are no uploaded reports, `null` is returned.
 
-Returns the date and ID of the last crash report. Only crash reports that have been uploaded will be returned; even if a crash report is present on disk it will not be returned until it is uploaded. In the case that there are no uploaded reports, `null` is returned.
+**Note:** Calling this method from the renderer process is deprecated.
 
 ### `crashReporter.getUploadedReports()`
 
@@ -90,43 +115,61 @@ Returns [`CrashReport[]`](structures/crash-report.md):
 Returns all uploaded crash reports. Each report contains the date and uploaded
 ID.
 
+**Note:** Calling this method from the renderer process is deprecated.
+
 ### `crashReporter.getUploadToServer()`
 
 Returns `Boolean` - Whether reports should be submitted to the server. Set through
 the `start` method or `setUploadToServer`.
 
-**Note:** This API can only be called from the main process.
+**Note:** Calling this method from the renderer process is deprecated.
 
 ### `crashReporter.setUploadToServer(uploadToServer)`
 
-* `uploadToServer` Boolean _macOS_ - Whether reports should be submitted to the server.
+* `uploadToServer` Boolean - Whether reports should be submitted to the server.
 
 This would normally be controlled by user preferences. This has no effect if
 called before `start` is called.
 
-**Note:** This API can only be called from the main process.
+**Note:** Calling this method from the renderer process is deprecated.
 
-### `crashReporter.addExtraParameter(key, value)` _macOS_ _Windows_
+### `crashReporter.getCrashesDirectory()` _Deprecated_
 
-* `key` String - Parameter key, must be less than 64 characters long.
-* `value` String - Parameter value, must be less than 64 characters long.
+Returns `String` - The directory where crashes are temporarily stored before being uploaded.
 
-Set an extra parameter to be sent with the crash report. The values
-specified here will be sent in addition to any values set via the `extra` option when `start` was called. This API is only available on macOS and windows, if you need to add/update extra parameters on Linux after your first call to `start` you can call `start` again with the updated `extra` options.
+**Note:** This method is deprecated, use `app.getPath('crashDumps')` instead.
 
-### `crashReporter.removeExtraParameter(key)` _macOS_ _Windows_
+### `crashReporter.addExtraParameter(key, value)`
 
-* `key` String - Parameter key, must be less than 64 characters long.
+* `key` String - Parameter key, must be no longer than 39 bytes.
+* `value` String - Parameter value, must be no longer than 127 bytes.
 
-Remove a extra parameter from the current set of parameters so that it will not be sent with the crash report.
+Set an extra parameter to be sent with the crash report. The values specified
+here will be sent in addition to any values set via the `extra` option when
+`start` was called.
+
+Parameters added in this fashion (or via the `extra` parameter to
+`crashReporter.start`) are specific to the calling process. Adding extra
+parameters in the main process will not cause those parameters to be sent along
+with crashes from renderer or other child processes. Similarly, adding extra
+parameters in a renderer process will not result in those parameters being sent
+with crashes that occur in other renderer processes or in the main process.
+
+**Note:** Parameters have limits on the length of the keys and values. Key
+names must be no longer than 39 bytes, and values must be no longer than 127
+bytes. Keys with names longer than the maximum will be silently ignored. Key
+values longer than the maximum length will be truncated.
+
+### `crashReporter.removeExtraParameter(key)`
+
+* `key` String - Parameter key, must be no longer than 39 bytes.
+
+Remove a extra parameter from the current set of parameters. Future crashes
+will not include this parameter.
 
 ### `crashReporter.getParameters()`
 
-See all of the current parameters being passed to the crash reporter.
-
-### `crashReporter.getCrashesDirectory()`
-
-Returns `String` - The directory where crashes are temporarily stored before being uploaded.
+Returns `Record<String, String>` - The current 'extra' parameters of the crash reporter.
 
 ## Crash Report Payload
 

docs/api/debugger.md

@@ -9,7 +9,7 @@ runtime that allows interacting with pages and instrumenting them.
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 
 try {
   win.webContents.debugger.attach('1.1')
@@ -52,6 +52,8 @@ Returns:
 * `method` String - Method name.
 * `params` any - Event parameters defined by the 'parameters'
    attribute in the remote debugging protocol.
+* `sessionId` String - Unique identifier of attached debugging session,
+   will match the value sent from `debugger.sendCommand`.
 
 Emitted whenever the debugging target issues an instrumentation event.
 
@@ -74,11 +76,16 @@ Returns `Boolean` - Whether a debugger is attached to the `webContents`.
 
 Detaches the debugger from the `webContents`.
 
-#### `debugger.sendCommand(method[, commandParams])`
+#### `debugger.sendCommand(method[, commandParams, sessionId])`
 
 * `method` String - Method name, should be one of the methods defined by the
    [remote debugging protocol][rdp].
 * `commandParams` any (optional) - JSON object with request parameters.
+* `sessionId` String (optional) - send command to the target with associated
+   debugging session id. The initial value can be obtained by sending
+   [Target.attachToTarget][attachToTarget] message.
+
+[attachToTarget]: https://chromedevtools.github.io/devtools-protocol/tot/Target/#method-attachToTarget
 
 Returns `Promise<any>` - A promise that resolves with the response defined by
 the 'returns' attribute of the command description in the remote debugging protocol

docs/api/desktop-capturer.md

@@ -3,7 +3,7 @@
 > Access information about media sources that can be used to capture audio and
 > video from the desktop using the [`navigator.mediaDevices.getUserMedia`] API.
 
-Process: [Renderer](../glossary.md#renderer-process)
+Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
 
 The following example shows how to capture video from a desktop window whose
 title is `Electron`:
@@ -72,6 +72,50 @@ const constraints = {
 }
 ```
 
+This example shows how to capture a video from a [WebContents](web-contents.md)
+
+```javascript
+// In the renderer process.
+const { desktopCapturer, remote } = require('electron')
+
+desktopCapturer.getMediaSourceIdForWebContents(remote.getCurrentWebContents().id).then(async mediaSourceId => {
+  try {
+    const stream = await navigator.mediaDevices.getUserMedia({
+      audio: {
+        mandatory: {
+          chromeMediaSource: 'tab',
+          chromeMediaSourceId: mediaSourceId
+        }
+      },
+      video: {
+        mandatory: {
+          chromeMediaSource: 'tab',
+          chromeMediaSourceId: mediaSourceId,
+          minWidth: 1280,
+          maxWidth: 1280,
+          minHeight: 720,
+          maxHeight: 720
+        }
+      }
+    })
+    handleStream(stream)
+  } catch (e) {
+    handleError(e)
+  }
+})
+
+function handleStream (stream) {
+  const video = document.querySelector('video')
+  video.srcObject = stream
+  video.onloadedmetadata = (e) => video.play()
+}
+
+function handleError (e) {
+  console.log(e)
+}
+```
+
+
 ## Methods
 
 The `desktopCapturer` module has the following methods:
@@ -94,6 +138,15 @@ Returns `Promise<DesktopCapturerSource[]>` - Resolves with an array of [`Desktop
 **Note** Capturing the screen contents requires user consent on macOS 10.15 Catalina or higher,
 which can detected by [`systemPreferences.getMediaAccessStatus`].
 
+### `desktopCapturer.getMediaSourceIdForWebContents(webContentsId)`
+
+* `webContentsId` number - Id of the WebContents to get stream of
+
+Returns `Promise<string>` - Resolves with the identifier of a WebContents stream, this identifier can be
+used with [`navigator.mediaDevices.getUserMedia`].
+The identifier is **only valid for 10 seconds**.
+The identifier may be empty if not requested from a renderer process.
+
 [`navigator.mediaDevices.getUserMedia`]: https://developer.mozilla.org/en/docs/Web/API/MediaDevices/getUserMedia
 [`systemPreferences.getMediaAccessStatus`]: system-preferences.md#systempreferencesgetmediaaccessstatusmediatype-macos
 

docs/api/download-item.md

@@ -11,7 +11,7 @@ control the download item.
 ```javascript
 // In the main process.
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 win.webContents.session.on('will-download', (event, item, webContents) => {
   // Set the save path, making Electron not to prompt a save dialog.
   item.setSavePath('/tmp/save.pdf')

docs/api/environment-variables.md

@@ -147,3 +147,14 @@ the one downloaded by `npm install`. Usage:
 ```sh
 export ELECTRON_OVERRIDE_DIST_PATH=/Users/username/projects/electron/out/Testing
 ```
+
+## Set By Electron
+
+Electron sets some variables in your environment at runtime.
+
+### `ORIGINAL_XDG_CURRENT_DESKTOP`
+
+This variable is set to the value of `XDG_CURRENT_DESKTOP` that your application
+originally launched with.  Electron sometimes modifies the value of `XDG_CURRENT_DESKTOP`
+to affect other logic within Chromium so if you want access to the _original_ value
+you should look up this environment variable instead.

docs/api/frameless-window.md

@@ -15,7 +15,7 @@ To create a frameless window, you need to set `frame` to `false` in
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow({ width: 800, height: 600, frame: false })
+const win = new BrowserWindow({ width: 800, height: 600, frame: false })
 win.show()
 ```
 
@@ -33,7 +33,7 @@ Results in a hidden title bar and a full size content window, yet the title bar
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow({ titleBarStyle: 'hidden' })
+const win = new BrowserWindow({ titleBarStyle: 'hidden' })
 win.show()
 ```
 
@@ -43,7 +43,7 @@ Results in a hidden title bar with an alternative look where the traffic light b
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow({ titleBarStyle: 'hiddenInset' })
+const win = new BrowserWindow({ titleBarStyle: 'hiddenInset' })
 win.show()
 ```
 
@@ -58,7 +58,7 @@ This option is only applicable for frameless windows.
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow({ titleBarStyle: 'customButtonsOnHover', frame: false })
+const win = new BrowserWindow({ titleBarStyle: 'customButtonsOnHover', frame: false })
 win.show()
 ```
 
@@ -69,7 +69,7 @@ window transparent:
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow({ transparent: true, frame: false })
+const win = new BrowserWindow({ transparent: true, frame: false })
 win.show()
 ```
 
@@ -100,7 +100,7 @@ API:
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 win.setIgnoreMouseEvents(true)
 ```
 
@@ -112,8 +112,8 @@ optional parameter can be used to forward mouse move messages to the web page,
 allowing events such as `mouseleave` to be emitted:
 
 ```javascript
-let win = require('electron').remote.getCurrentWindow()
-let el = document.getElementById('clickThroughElement')
+const win = require('electron').remote.getCurrentWindow()
+const el = document.getElementById('clickThroughElement')
 el.addEventListener('mouseenter', () => {
   win.setIgnoreMouseEvents(true, { forward: true })
 })

docs/api/menu-item.md

@@ -12,9 +12,9 @@ See [`Menu`](menu.md) for examples.
   * `click` Function (optional) - Will be called with
     `click(menuItem, browserWindow, event)` when the menu item is clicked.
     * `menuItem` MenuItem
-    * `browserWindow` [BrowserWindow](browser-window.md)
+    * `browserWindow` [BrowserWindow](browser-window.md) | undefined - This will not be defined if no window is open.
     * `event` [KeyboardEvent](structures/keyboard-event.md)
-  * `role` String (optional) - Can be `undo`, `redo`, `cut`, `copy`, `paste`, `pasteAndMatchStyle`, `delete`, `selectAll`, `reload`, `forceReload`, `toggleDevTools`, `resetZoom`, `zoomIn`, `zoomOut`, `togglefullscreen`, `window`, `minimize`, `close`, `help`, `about`, `services`, `hide`, `hideOthers`, `unhide`, `quit`, `startSpeaking`, `stopSpeaking`, `minimize`, `zoom`, `front`, `appMenu`, `fileMenu`, `editMenu`, `viewMenu`, `recentDocuments`, `toggleTabBar`, `selectNextTab`, `selectPreviousTab`, `mergeAllWindows`, `clearRecentDocuments`, `moveTabToNewWindow` or `windowMenu` - Define the action of the menu item, when specified the
+  * `role` String (optional) - Can be `undo`, `redo`, `cut`, `copy`, `paste`, `pasteAndMatchStyle`, `delete`, `selectAll`, `reload`, `forceReload`, `toggleDevTools`, `resetZoom`, `zoomIn`, `zoomOut`, `togglefullscreen`, `window`, `minimize`, `close`, `help`, `about`, `services`, `hide`, `hideOthers`, `unhide`, `quit`, `startSpeaking`, `stopSpeaking`, `zoom`, `front`, `appMenu`, `fileMenu`, `editMenu`, `viewMenu`, `recentDocuments`, `toggleTabBar`, `selectNextTab`, `selectPreviousTab`, `mergeAllWindows`, `clearRecentDocuments`, `moveTabToNewWindow` or `windowMenu` - Define the action of the menu item, when specified the
     `click` property will be ignored. See [roles](#roles).
   * `type` String (optional) - Can be `normal`, `separator`, `submenu`, `checkbox` or
     `radio`.
@@ -69,6 +69,7 @@ a `type`.
 The `role` property can have following values:
 
 * `undo`
+* `about` - Trigger a native about panel (custom message box on Window, which does not provide its own).
 * `redo`
 * `cut`
 * `copy`
@@ -94,7 +95,6 @@ The `role` property can have following values:
 The following additional roles are available on _macOS_:
 
 * `appMenu` - Whole default "App" menu (About, Services, etc.)
-* `about` - Map to the `orderFrontStandardAboutPanel` action.
 * `hide` - Map to the `hide` action.
 * `hideOthers` - Map to the `hideOtherApplications` action.
 * `unhide` - Map to the `unhideAllApplications` action.
@@ -151,7 +151,7 @@ A `String` indicating the type of the item. Can be `normal`, `separator`, `subme
 
 #### `menuItem.role`
 
-A `String` (optional) indicating the item's role, if set. Can be `undo`, `redo`, `cut`, `copy`, `paste`, `pasteAndMatchStyle`, `delete`, `selectAll`, `reload`, `forceReload`, `toggleDevTools`, `resetZoom`, `zoomIn`, `zoomOut`, `togglefullscreen`, `window`, `minimize`, `close`, `help`, `about`, `services`, `hide`, `hideOthers`, `unhide`, `quit`, `startSpeaking`, `stopSpeaking`, `close`, `minimize`, `zoom`, `front`, `appMenu`, `fileMenu`, `editMenu`, `viewMenu`, `recentDocuments`, `toggleTabBar`, `selectNextTab`, `selectPreviousTab`, `mergeAllWindows`, `clearRecentDocuments`, `moveTabToNewWindow` or `windowMenu`
+A `String` (optional) indicating the item's role, if set. Can be `undo`, `redo`, `cut`, `copy`, `paste`, `pasteAndMatchStyle`, `delete`, `selectAll`, `reload`, `forceReload`, `toggleDevTools`, `resetZoom`, `zoomIn`, `zoomOut`, `togglefullscreen`, `window`, `minimize`, `close`, `help`, `about`, `services`, `hide`, `hideOthers`, `unhide`, `quit`, `startSpeaking`, `stopSpeaking`, `zoom`, `front`, `appMenu`, `fileMenu`, `editMenu`, `viewMenu`, `recentDocuments`, `toggleTabBar`, `selectNextTab`, `selectPreviousTab`, `mergeAllWindows`, `clearRecentDocuments`, `moveTabToNewWindow` or `windowMenu`
 
 #### `menuItem.accelerator`
 

docs/api/menu.md

@@ -96,7 +96,7 @@ Appends the `menuItem` to the menu.
 
 * `id` String
 
-Returns `MenuItem` the item with the specified `id`
+Returns `MenuItem | null` the item with the specified `id`
 
 #### `menu.insert(pos, menuItem)`
 

docs/api/modernization/property-updates.md

@@ -34,6 +34,7 @@ The Electron team is currently undergoing an initiative to convert separate gett
   * `fullscreenable`
   * `movable`
   * `closable`
+  * `backgroundThrottling`
 * `NativeImage`
   * `isMacTemplateImage`
 * `SystemPreferences` module

docs/api/native-image.md

@@ -266,9 +266,13 @@ image instead of a copy, so you _must_ ensure that the associated
 
 Returns `Boolean` - Whether the image is empty.
 
-#### `image.getSize()`
+#### `image.getSize([scaleFactor])`
 
-Returns [`Size`](structures/size.md)
+* `scaleFactor` Double (optional) - Defaults to 1.0.
+
+Returns [`Size`](structures/size.md).
+
+If `scaleFactor` is passed, this will return the size corresponding to the image representation most closely matching the passed value.
 
 #### `image.setTemplateImage(option)`
 
@@ -303,10 +307,18 @@ Returns `NativeImage` - The resized image.
 If only the `height` or the `width` are specified then the current aspect ratio
 will be preserved in the resized image.
 
-#### `image.getAspectRatio()`
+#### `image.getAspectRatio([scaleFactor])`
+
+* `scaleFactor` Double (optional) - Defaults to 1.0.
 
 Returns `Float` - The image's aspect ratio.
 
+If `scaleFactor` is passed, this will return the aspect ratio corresponding to the image representation most closely matching the passed value.
+
+#### `image.getScaleFactors()`
+
+Returns `Float[]` - An array of all scale factors corresponding to representations for a given nativeImage.
+
 #### `image.addRepresentation(options)`
 
 * `options` Object

docs/api/protocol-ns.md

@@ -1,309 +0,0 @@
-# protocol (NetworkService) (Draft)
-
-This document describes the new protocol APIs based on the [NetworkService](https://www.chromium.org/servicification).
-
-We don't currently have an estimate of when we will enable the `NetworkService` by
-default in Electron, but as Chromium is already removing non-`NetworkService`
-code, we will probably switch before Electron 10.
-
-The content of this document should be moved to `protocol.md` after we have
-enabled the `NetworkService` by default in Electron.
-
-> Register a custom protocol and intercept existing protocol requests.
-
-Process: [Main](../glossary.md#main-process)
-
-An example of implementing a protocol that has the same effect as the
-`file://` protocol:
-
-```javascript
-const { app, protocol } = require('electron')
-const path = require('path')
-
-app.whenReady().then(() => {
-  protocol.registerFileProtocol('atom', (request, callback) => {
-    const url = request.url.substr(7)
-    callback({ path: path.normalize(`${__dirname}/${url}`) })
-  })
-})
-```
-
-**Note:** All methods unless specified can only be used after the `ready` event
-of the `app` module gets emitted.
-
-## Using `protocol` with a custom `partition` or `session`
-
-A protocol is registered to a specific Electron [`session`](./session.md)
-object. If you don't specify a session, then your `protocol` will be applied to
-the default session that Electron uses. However, if you define a `partition` or
-`session` on your `browserWindow`'s `webPreferences`, then that window will use
-a different session and your custom protocol will not work if you just use
-`electron.protocol.XXX`.
-
-To have your custom protocol work in combination with a custom session, you need
-to register it to that session explicitly.
-
-```javascript
-const { session, app, protocol } = require('electron')
-const path = require('path')
-
-app.whenReady().then(() => {
-  const partition = 'persist:example'
-  const ses = session.fromPartition(partition)
-
-  ses.protocol.registerFileProtocol('atom', (request, callback) => {
-    const url = request.url.substr(7)
-    callback({ path: path.normalize(`${__dirname}/${url}`) })
-  })
-
-  mainWindow = new BrowserWindow({ webPreferences: { partition } })
-})
-```
-
-## Methods
-
-The `protocol` module has the following methods:
-
-### `protocol.registerSchemesAsPrivileged(customSchemes)`
-
-* `customSchemes` [CustomScheme[]](structures/custom-scheme.md)
-
-**Note:** This method can only be used before the `ready` event of the `app`
-module gets emitted and can be called only once.
-
-Registers the `scheme` as standard, secure, bypasses content security policy for
-resources, allows registering ServiceWorker and supports fetch API. Specify a
-privilege with the value of `true` to enable the capability.
-
-An example of registering a privileged scheme, that bypasses Content Security
-Policy:
-
-```javascript
-const { protocol } = require('electron')
-protocol.registerSchemesAsPrivileged([
-  { scheme: 'foo', privileges: { bypassCSP: true } }
-])
-```
-
-A standard scheme adheres to what RFC 3986 calls [generic URI
-syntax](https://tools.ietf.org/html/rfc3986#section-3). For example `http` and
-`https` are standard schemes, while `file` is not.
-
-Registering a scheme as standard allows relative and absolute resources to
-be resolved correctly when served. Otherwise the scheme will behave like the
-`file` protocol, but without the ability to resolve relative URLs.
-
-For example when you load following page with custom protocol without
-registering it as standard scheme, the image will not be loaded because
-non-standard schemes can not recognize relative URLs:
-
-```html
-<body>
-  <img src='test.png'>
-</body>
-```
-
-Registering a scheme as standard will allow access to files through the
-[FileSystem API][file-system-api]. Otherwise the renderer will throw a security
-error for the scheme.
-
-By default web storage apis (localStorage, sessionStorage, webSQL, indexedDB,
-cookies) are disabled for non standard schemes. So in general if you want to
-register a custom protocol to replace the `http` protocol, you have to register
-it as a standard scheme.
-
-### `protocol.registerFileProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` (String | [ProtocolResponse](structures/protocol-response.md))
-
-Registers a protocol of `scheme` that will send a file as the response. The
-`handler` will be called with `request` and `callback` where `request` is
-an incoming request for the `scheme`.
-
-To handle the `request`, the `callback` should be called with either the file's
-path or an object that has a `path` property, e.g. `callback(filePath)` or
-`callback({ path: filePath })`. The `filePath` must be an absolute path.
-
-By default the `scheme` is treated like `http:`, which is parsed differently
-from protocols that follow the "generic URI syntax" like `file:`.
-
-### `protocol.registerBufferProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` (Buffer | [ProtocolResponse](structures/protocol-response.md))
-
-Registers a protocol of `scheme` that will send a `Buffer` as a response.
-
-The usage is the same with `registerFileProtocol`, except that the `callback`
-should be called with either a `Buffer` object or an object that has the `data`
-property.
-
-Example:
-
-```javascript
-protocol.registerBufferProtocol('atom', (request, callback) => {
-  callback({ mimeType: 'text/html', data: Buffer.from('<h5>Response</h5>') })
-})
-```
-
-### `protocol.registerStringProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` (String | [ProtocolResponse](structures/protocol-response.md))
-
-Registers a protocol of `scheme` that will send a `String` as a response.
-
-The usage is the same with `registerFileProtocol`, except that the `callback`
-should be called with either a `String` or an object that has the `data`
-property.
-
-### `protocol.registerHttpProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` ProtocolResponse
-
-Registers a protocol of `scheme` that will send an HTTP request as a response.
-
-The usage is the same with `registerFileProtocol`, except that the `callback`
-should be called with an object that has the `url` property.
-
-### `protocol.registerStreamProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` (ReadableStream | [ProtocolResponse](structures/protocol-response.md))
-
-Registers a protocol of `scheme` that will send a stream as a response.
-
-The usage is the same with `registerFileProtocol`, except that the
-`callback` should be called with either a [`ReadableStream`](https://nodejs.org/api/stream.html#stream_class_stream_readable) object or an object that
-has the `data` property.
-
-Example:
-
-```javascript
-const { protocol } = require('electron')
-const { PassThrough } = require('stream')
-
-function createStream (text) {
-  const rv = new PassThrough() // PassThrough is also a Readable stream
-  rv.push(text)
-  rv.push(null)
-  return rv
-}
-
-protocol.registerStreamProtocol('atom', (request, callback) => {
-  callback({
-    statusCode: 200,
-    headers: {
-      'content-type': 'text/html'
-    },
-    data: createStream('<h5>Response</h5>')
-  })
-})
-```
-
-It is possible to pass any object that implements the readable stream API (emits
-`data`/`end`/`error` events). For example, here's how a file could be returned:
-
-```javascript
-protocol.registerStreamProtocol('atom', (request, callback) => {
-  callback(fs.createReadStream('index.html'))
-})
-```
-
-### `protocol.unregisterProtocol(scheme)`
-
-* `scheme` String
-
-Unregisters the custom protocol of `scheme`.
-
-### `protocol.isProtocolRegistered(scheme)`
-
-* `scheme` String
-
-Returns `Boolean` - Whether `scheme` is already registered.
-
-### `protocol.interceptFileProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` (String | [ProtocolResponse](structures/protocol-response.md))
-
-Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
-which sends a file as a response.
-
-### `protocol.interceptStringProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` (String | [ProtocolResponse](structures/protocol-response.md))
-
-Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
-which sends a `String` as a response.
-
-### `protocol.interceptBufferProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` (Buffer | [ProtocolResponse](structures/protocol-response.md))
-
-Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
-which sends a `Buffer` as a response.
-
-### `protocol.interceptHttpProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` ProtocolResponse
-
-Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
-which sends a new HTTP request as a response.
-
-### `protocol.interceptStreamProtocol(scheme, handler)`
-
-* `scheme` String
-* `handler` Function
-  * `request` ProtocolRequest
-  * `callback` Function
-    * `response` (ReadableStream | [ProtocolResponse](structures/protocol-response.md))
-
-Same as `protocol.registerStreamProtocol`, except that it replaces an existing
-protocol handler.
-
-### `protocol.uninterceptProtocol(scheme)`
-
-* `scheme` String
-
-Remove the interceptor installed for `scheme` and restore its original handler.
-
-### `protocol.isProtocolIntercepted(scheme)`
-
-* `scheme` String
-
-Returns `Boolean` - Whether `scheme` is already intercepted.
-
-[file-system-api]: https://developer.mozilla.org/en-US/docs/Web/API/LocalFileSystem

docs/api/protocol.md

@@ -15,8 +15,6 @@ app.whenReady().then(() => {
   protocol.registerFileProtocol('atom', (request, callback) => {
     const url = request.url.substr(7)
     callback({ path: path.normalize(`${__dirname}/${url}`) })
-  }, (error) => {
-    if (error) console.error('Failed to register protocol')
   })
 })
 ```
@@ -26,9 +24,15 @@ of the `app` module gets emitted.
 
 ## Using `protocol` with a custom `partition` or `session`
 
-A protocol is registered to a specific Electron [`session`](./session.md) object. If you don't specify a session, then your `protocol` will be applied to the default session that Electron uses. However, if you define a `partition` or `session` on your `browserWindow`'s `webPreferences`, then that window will use a different session and your custom protocol will not work if you just use `electron.protocol.XXX`.
+A protocol is registered to a specific Electron [`session`](./session.md)
+object. If you don't specify a session, then your `protocol` will be applied to
+the default session that Electron uses. However, if you define a `partition` or
+`session` on your `browserWindow`'s `webPreferences`, then that window will use
+a different session and your custom protocol will not work if you just use
+`electron.protocol.XXX`.
 
-To have your custom protocol work in combination with a custom session, you need to register it to that session explicitly.
+To have your custom protocol work in combination with a custom session, you need
+to register it to that session explicitly.
 
 ```javascript
 const { session, app, protocol } = require('electron')
@@ -41,17 +45,9 @@ app.whenReady().then(() => {
   ses.protocol.registerFileProtocol('atom', (request, callback) => {
     const url = request.url.substr(7)
     callback({ path: path.normalize(`${__dirname}/${url}`) })
-  }, (error) => {
-    if (error) console.error('Failed to register protocol')
   })
 
-  mainWindow = new BrowserWindow({
-    width: 800,
-    height: 600,
-    webPreferences: {
-      partition: partition
-    }
-  })
+  mainWindow = new BrowserWindow({ webPreferences: { partition } })
 })
 ```
 
@@ -63,15 +59,15 @@ The `protocol` module has the following methods:
 
 * `customSchemes` [CustomScheme[]](structures/custom-scheme.md)
 
-
 **Note:** This method can only be used before the `ready` event of the `app`
 module gets emitted and can be called only once.
 
-Registers the `scheme` as standard, secure, bypasses content security policy for resources,
-allows registering ServiceWorker and supports fetch API.
+Registers the `scheme` as standard, secure, bypasses content security policy for
+resources, allows registering ServiceWorker, supports fetch API, and streaming
+video/audio. Specify a privilege with the value of `true` to enable the capability.
 
-Specify a privilege with the value of `true` to enable the capability.
-An example of registering a privileged scheme, with bypassing Content Security Policy:
+An example of registering a privileged scheme, that bypasses Content Security
+Policy:
 
 ```javascript
 const { protocol } = require('electron')
@@ -84,7 +80,7 @@ A standard scheme adheres to what RFC 3986 calls [generic URI
 syntax](https://tools.ietf.org/html/rfc3986#section-3). For example `http` and
 `https` are standard schemes, while `file` is not.
 
-Registering a scheme as standard, will allow relative and absolute resources to
+Registering a scheme as standard allows relative and absolute resources to
 be resolved correctly when served. Otherwise the scheme will behave like the
 `file` protocol, but without the ability to resolve relative URLs.
 
@@ -102,168 +98,107 @@ Registering a scheme as standard will allow access to files through the
 [FileSystem API][file-system-api]. Otherwise the renderer will throw a security
 error for the scheme.
 
-By default web storage apis (localStorage, sessionStorage, webSQL, indexedDB, cookies)
-are disabled for non standard schemes. So in general if you want to register a
-custom protocol to replace the `http` protocol, you have to register it as a standard scheme.
+By default web storage apis (localStorage, sessionStorage, webSQL, indexedDB,
+cookies) are disabled for non standard schemes. So in general if you want to
+register a custom protocol to replace the `http` protocol, you have to register
+it as a standard scheme.
 
-`protocol.registerSchemesAsPrivileged` can be used to replicate the functionality of the previous `protocol.registerStandardSchemes`, `webFrame.registerURLSchemeAs*` and `protocol.registerServiceWorkerSchemes` functions that existed prior to Electron 5.0.0, for example:
+Protocols that use streams (http and stream protocols) should set `stream: true`.
+The `<video>` and `<audio>` HTML elements expect protocols to buffer their
+responses by default. The `stream` flag configures those elements to correctly
+expect streaming responses.
 
-**before (<= v4.x)**
-```javascript
-// Main
-protocol.registerStandardSchemes(['scheme1', 'scheme2'], { secure: true })
-// Renderer
-webFrame.registerURLSchemeAsPrivileged('scheme1', { secure: true })
-webFrame.registerURLSchemeAsPrivileged('scheme2', { secure: true })
-```
-
-**after (>= v5.x)**
-```javascript
-protocol.registerSchemesAsPrivileged([
-  { scheme: 'scheme1', privileges: { standard: true, secure: true } },
-  { scheme: 'scheme2', privileges: { standard: true, secure: true } }
-])
-```
-
-### `protocol.registerFileProtocol(scheme, handler[, completion])`
+### `protocol.registerFileProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `filePath` String | [FilePathWithHeaders](structures/file-path-with-headers.md) (optional)
-* `completion` Function (optional)
-  * `error` Error
+    * `response` (String | [ProtocolResponse](structures/protocol-response.md))
 
-Registers a protocol of `scheme` that will send the file as a response. The
-`handler` will be called with `handler(request, callback)` when a `request` is
-going to be created with `scheme`. `completion` will be called with
-`completion(null)` when `scheme` is successfully registered or
-`completion(error)` when failed.
+Returns `Boolean` - Whether the protocol was successfully registered
+
+Registers a protocol of `scheme` that will send a file as the response. The
+`handler` will be called with `request` and `callback` where `request` is
+an incoming request for the `scheme`.
 
 To handle the `request`, the `callback` should be called with either the file's
 path or an object that has a `path` property, e.g. `callback(filePath)` or
-`callback({ path: filePath })`. The object may also have a `headers` property
-which gives a map of headers to values for the response headers, e.g.
-`callback({ path: filePath, headers: {"Content-Security-Policy": "default-src 'none'"]})`.
-
-When `callback` is called with nothing, a number, or an object that has an
-`error` property, the `request` will fail with the `error` number you
-specified. For the available error numbers you can use, please see the
-[net error list][net-error].
+`callback({ path: filePath })`. The `filePath` must be an absolute path.
 
 By default the `scheme` is treated like `http:`, which is parsed differently
-than protocols that follow the "generic URI syntax" like `file:`.
+from protocols that follow the "generic URI syntax" like `file:`.
 
-### `protocol.registerBufferProtocol(scheme, handler[, completion])`
+### `protocol.registerBufferProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `buffer` (Buffer | [MimeTypedBuffer](structures/mime-typed-buffer.md)) (optional)
-* `completion` Function (optional)
-  * `error` Error
+    * `response` (Buffer | [ProtocolResponse](structures/protocol-response.md))
+
+Returns `Boolean` - Whether the protocol was successfully registered
 
 Registers a protocol of `scheme` that will send a `Buffer` as a response.
 
 The usage is the same with `registerFileProtocol`, except that the `callback`
-should be called with either a `Buffer` object or an object that has the `data`,
-`mimeType`, and `charset` properties.
+should be called with either a `Buffer` object or an object that has the `data`
+property.
 
 Example:
 
 ```javascript
-const { protocol } = require('electron')
-
 protocol.registerBufferProtocol('atom', (request, callback) => {
   callback({ mimeType: 'text/html', data: Buffer.from('<h5>Response</h5>') })
-}, (error) => {
-  if (error) console.error('Failed to register protocol')
 })
 ```
 
-### `protocol.registerStringProtocol(scheme, handler[, completion])`
+### `protocol.registerStringProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `data` (String | [StringProtocolResponse](structures/string-protocol-response.md)) (optional)
-* `completion` Function (optional)
-  * `error` Error
+    * `response` (String | [ProtocolResponse](structures/protocol-response.md))
+
+Returns `Boolean` - Whether the protocol was successfully registered
 
 Registers a protocol of `scheme` that will send a `String` as a response.
 
 The usage is the same with `registerFileProtocol`, except that the `callback`
-should be called with either a `String` or an object that has the `data`,
-`mimeType`, and `charset` properties.
+should be called with either a `String` or an object that has the `data`
+property.
 
-### `protocol.registerHttpProtocol(scheme, handler[, completion])`
+### `protocol.registerHttpProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `redirectRequest` Object
-      * `url` String
-      * `method` String (optional)
-      * `session` Session | null (optional)
-      * `uploadData` [ProtocolResponseUploadData](structures/protocol-response-upload-data.md) (optional)
-* `completion` Function (optional)
-  * `error` Error
+    * `response` ProtocolResponse
+
+Returns `Boolean` - Whether the protocol was successfully registered
 
 Registers a protocol of `scheme` that will send an HTTP request as a response.
 
 The usage is the same with `registerFileProtocol`, except that the `callback`
-should be called with a `redirectRequest` object that has the `url`, `method`,
-`referrer`, `uploadData` and `session` properties.
+should be called with an object that has the `url` property.
 
-By default the HTTP request will reuse the current session. If you want the
-request to have a different session you should set `session` to `null`.
-
-For POST requests the `uploadData` object must be provided.
-
-### `protocol.registerStreamProtocol(scheme, handler[, completion])`
+### `protocol.registerStreamProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `stream` (ReadableStream | [StreamProtocolResponse](structures/stream-protocol-response.md)) (optional)
-* `completion` Function (optional)
-  * `error` Error
+    * `response` (ReadableStream | [ProtocolResponse](structures/protocol-response.md))
 
-Registers a protocol of `scheme` that will send a `Readable` as a response.
+Returns `Boolean` - Whether the protocol was successfully registered
 
-The usage is similar to the other `register{Any}Protocol`, except that the
-`callback` should be called with either a `Readable` object or an object that
-has the `data`, `statusCode`, and `headers` properties.
+Registers a protocol of `scheme` that will send a stream as a response.
+
+The usage is the same with `registerFileProtocol`, except that the
+`callback` should be called with either a [`ReadableStream`](https://nodejs.org/api/stream.html#stream_class_stream_readable) object or an object that
+has the `data` property.
 
 Example:
 
@@ -286,8 +221,6 @@ protocol.registerStreamProtocol('atom', (request, callback) => {
     },
     data: createStream('<h5>Response</h5>')
   })
-}, (error) => {
-  if (error) console.error('Failed to register protocol')
 })
 ```
 
@@ -295,132 +228,102 @@ It is possible to pass any object that implements the readable stream API (emits
 `data`/`end`/`error` events). For example, here's how a file could be returned:
 
 ```javascript
-const { protocol } = require('electron')
-const fs = require('fs')
-
 protocol.registerStreamProtocol('atom', (request, callback) => {
   callback(fs.createReadStream('index.html'))
-}, (error) => {
-  if (error) console.error('Failed to register protocol')
 })
 ```
 
-### `protocol.unregisterProtocol(scheme[, completion])`
+### `protocol.unregisterProtocol(scheme)`
 
 * `scheme` String
-* `completion` Function (optional)
-  * `error` Error
+
+Returns `Boolean` - Whether the protocol was successfully unregistered
 
 Unregisters the custom protocol of `scheme`.
 
-### `protocol.isProtocolHandled(scheme)`
+### `protocol.isProtocolRegistered(scheme)`
 
 * `scheme` String
 
-Returns `Promise<Boolean>` - fulfilled with a boolean that indicates whether there is
-already a handler for `scheme`.
+Returns `Boolean` - Whether `scheme` is already registered.
 
-### `protocol.interceptFileProtocol(scheme, handler[, completion])`
+### `protocol.interceptFileProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `filePath` String
-* `completion` Function (optional)
-  * `error` Error
+    * `response` (String | [ProtocolResponse](structures/protocol-response.md))
+
+Returns `Boolean` - Whether the protocol was successfully intercepted
 
 Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
 which sends a file as a response.
 
-### `protocol.interceptStringProtocol(scheme, handler[, completion])`
+### `protocol.interceptStringProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `data` (String | [StringProtocolResponse](structures/string-protocol-response.md)) (optional)
-* `completion` Function (optional)
-  * `error` Error
+    * `response` (String | [ProtocolResponse](structures/protocol-response.md))
+
+Returns `Boolean` - Whether the protocol was successfully intercepted
 
 Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
 which sends a `String` as a response.
 
-### `protocol.interceptBufferProtocol(scheme, handler[, completion])`
+### `protocol.interceptBufferProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `buffer` Buffer (optional)
-* `completion` Function (optional)
-  * `error` Error
+    * `response` (Buffer | [ProtocolResponse](structures/protocol-response.md))
+
+Returns `Boolean` - Whether the protocol was successfully intercepted
 
 Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
 which sends a `Buffer` as a response.
 
-### `protocol.interceptHttpProtocol(scheme, handler[, completion])`
+### `protocol.interceptHttpProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `redirectRequest` Object
-      * `url` String
-      * `method` String (optional)
-      * `session` Session | null (optional)
-      * `uploadData` [ProtocolResponseUploadData](structures/protocol-response-upload-data.md) (optional)
-* `completion` Function (optional)
-  * `error` Error
+    * `response` [ProtocolResponse](structures/protocol-response.md)
+
+Returns `Boolean` - Whether the protocol was successfully intercepted
 
 Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
 which sends a new HTTP request as a response.
 
-### `protocol.interceptStreamProtocol(scheme, handler[, completion])`
+### `protocol.interceptStreamProtocol(scheme, handler)`
 
 * `scheme` String
 * `handler` Function
-  * `request` Object
-    * `url` String
-    * `headers` Record<String, String>
-    * `referrer` String
-    * `method` String
-    * `uploadData` [UploadData[]](structures/upload-data.md)
+  * `request` ProtocolRequest
   * `callback` Function
-    * `stream` (ReadableStream | [StreamProtocolResponse](structures/stream-protocol-response.md)) (optional)
-* `completion` Function (optional)
-  * `error` Error
+    * `response` (ReadableStream | [ProtocolResponse](structures/protocol-response.md))
+
+Returns `Boolean` - Whether the protocol was successfully intercepted
 
 Same as `protocol.registerStreamProtocol`, except that it replaces an existing
 protocol handler.
 
-### `protocol.uninterceptProtocol(scheme[, completion])`
+### `protocol.uninterceptProtocol(scheme)`
 
 * `scheme` String
-* `completion` Function (optional)
-  * `error` Error
+
+Returns `Boolean` - Whether the protocol was successfully unintercepted
 
 Remove the interceptor installed for `scheme` and restore its original handler.
 
-[net-error]: https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h
+### `protocol.isProtocolIntercepted(scheme)`
+
+* `scheme` String
+
+Returns `Boolean` - Whether `scheme` is already intercepted.
+
 [file-system-api]: https://developer.mozilla.org/en-US/docs/Web/API/LocalFileSystem

docs/api/remote.md

@@ -17,7 +17,7 @@ renderer process:
 
 ```javascript
 const { BrowserWindow } = require('electron').remote
-let win = new BrowserWindow({ width: 800, height: 600 })
+const win = new BrowserWindow({ width: 800, height: 600 })
 win.loadURL('https://github.com')
 ```
 

docs/api/sandbox-option.md

@@ -154,24 +154,43 @@ More may be added as needed to expose more Electron APIs in the sandbox, but any
 module in the main process can already be used through
 `electron.remote.require`.
 
-## Status
+## Rendering untrusted content
 
-Please use the `sandbox` option with care, as it is still an experimental
-feature. We are still not aware of the security implications of exposing some
-Electron renderer APIs to the preload script, but here are some things to
-consider before rendering untrusted content:
+Rendering untrusted content in Electron is still somewhat uncharted territory,
+though some apps are finding success (e.g. Beaker Browser). Our goal is to get
+as close to Chrome as we can in terms of the security of sandboxed content, but
+ultimately we will always be behind due to a few fundamental issues:
+
+1. We do not have the dedicated resources or expertise that Chromium has to
+   apply to the security of its product. We do our best to make use of what we
+   have, to inherit everything we can from Chromium, and to respond quickly to
+   security issues, but Electron cannot be as secure as Chromium without the
+   resources that Chromium is able to dedicate.
+2. Some security features in Chrome (such as Safe Browsing and Certificate
+   Transparency) require a centralized authority and dedicated servers, both of
+   which run counter to the goals of the Electron project. As such, we disable
+   those features in Electron, at the cost of the associated security they
+   would otherwise bring.
+3. There is only one Chromium, whereas there are many thousands of apps built
+   on Electron, all of which behave slightly differently. Accounting for those
+   differences can yield a huge possibility space, and make it challenging to
+   ensure the security of the platform in unusual use cases.
+4. We can't push security updates to users directly, so we rely on app vendors
+   to upgrade the version of Electron underlying their app in order for
+   security updates to reach users.
+
+Here are some things to consider before rendering untrusted content:
 
 - A preload script can accidentally leak privileged APIs to untrusted code,
   unless [`contextIsolation`](../tutorial/security.md#3-enable-context-isolation-for-remote-content)
   is also enabled.
-- Some bug in V8 engine may allow malicious code to access the renderer preload
-  APIs, effectively granting full access to the system through the `remote`
-  module. Therefore, it is highly recommended to
-  [disable the `remote` module](../tutorial/security.md#15-disable-the-remote-module).
-  If disabling is not feasible, you should selectively
-  [filter the `remote` module](../tutorial/security.md#16-filter-the-remote-module).
-
-Since rendering untrusted content in Electron is still uncharted territory,
-the APIs exposed to the sandbox preload script should be considered more
-unstable than the rest of Electron APIs, and may have breaking changes to fix
-security issues.
+- Some bug in the V8 engine may allow malicious code to access the renderer
+  preload APIs, effectively granting full access to the system through the
+  `remote` module. Therefore, it is highly recommended to [disable the `remote`
+  module](../tutorial/security.md#15-disable-the-remote-module).
+  If disabling is not feasible, you should selectively [filter the `remote`
+  module](../tutorial/security.md#16-filter-the-remote-module).
+- While we make our best effort to backport Chromium security fixes to older
+  versions of Electron, we do not make a guarantee that every fix will be
+  backported. Your best chance at staying secure is to be on the latest stable
+  version of Electron.

docs/api/screen.md

@@ -33,8 +33,8 @@ const { app, BrowserWindow, screen } = require('electron')
 let win
 
 app.whenReady().then(() => {
-  let displays = screen.getAllDisplays()
-  let externalDisplay = displays.find((display) => {
+  const displays = screen.getAllDisplays()
+  const externalDisplay = displays.find((display) => {
     return display.bounds.x !== 0 || display.bounds.y !== 0
   })
 

docs/api/service-workers.md

@@ -39,7 +39,7 @@ Returns:
   * `message` String - The actual console message
   * `versionId` Number - The version ID of the service worker that sent the log message
   * `source` String - The type of source for this message.  Can be `javascript`, `xml`, `network`, `console-api`, `storage`, `app-cache`, `rendering`, `security`, `deprecation`, `worker`, `violation`, `intervention`, `recommendation` or `other`.
-  * `level` Number - The log level, from 0 to 3.  In order it matches `verbose`, `info`, `warning` and `error`.
+  * `level` Number - The log level, from 0 to 3. In order it matches `verbose`, `info`, `warning` and `error`.
   * `sourceUrl` String - The URL the message came from
   * `lineNumber` Number - The line number of the source that triggered this console message
 

docs/api/session.md

@@ -12,7 +12,7 @@ property of [`WebContents`](web-contents.md), or from the `session` module.
 ```javascript
 const { BrowserWindow } = require('electron')
 
-let win = new BrowserWindow({ width: 800, height: 600 })
+const win = new BrowserWindow({ width: 800, height: 600 })
 win.loadURL('http://github.com')
 
 const ses = win.webContents.session
@@ -332,7 +332,7 @@ verify proc.
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 
 win.webContents.session.setCertificateVerifyProc((request, callback) => {
   const { hostname } = request
@@ -655,7 +655,7 @@ const path = require('path')
 app.whenReady().then(() => {
   const protocol = session.fromPartition('some-partition').protocol
   protocol.registerFileProtocol('atom', (request, callback) => {
-    let url = request.url.substr(7)
+    const url = request.url.substr(7)
     callback({ path: path.normalize(`${__dirname}/${url}`) })
   }, (error) => {
     if (error) console.error('Failed to register protocol')

docs/api/structures/custom-scheme.md

@@ -8,3 +8,4 @@
   * `allowServiceWorkers` Boolean (optional) - Default false.
   * `supportFetchAPI` Boolean (optional) - Default false.
   * `corsEnabled` Boolean (optional) - Default false.
+  * `stream` Boolean (optional) - Default false.

docs/api/structures/mime-typed-buffer.md

@@ -1,4 +1,5 @@
 # MimeTypedBuffer Object
 
-* `mimeType` String - The mimeType of the Buffer that you are sending.
+* `mimeType` String (optional) - MIME type of the buffer.
+* `charset` String (optional) - Charset of the buffer.
 * `data` Buffer - The actual Buffer content.

docs/api/structures/new-window-web-contents-event.md

@@ -0,0 +1,4 @@
+# NewWindowWebContentsEvent Object extends `Event`
+
+* `newGuest` BrowserWindow (optional)
+

docs/api/structures/process-metric.md

@@ -11,6 +11,8 @@
   * `Pepper Plugin`
   * `Pepper Plugin Broker`
   * `Unknown`
+* `name` String (optional) - The name of the process. i.e. for plugins it might be Flash.
+    Examples for utility: `Audio Service`, `Content Decryption Module Service`, `Network Service`, `Video Capture`, etc.
 * `cpu` [CPUUsage](cpu-usage.md) - CPU usage of the process.
 * `creationTime` Number - Creation time for this process.
     The time is represented as number of milliseconds since epoch.

docs/api/structures/protocol-request.md

@@ -4,3 +4,4 @@
 * `referrer` String
 * `method` String
 * `uploadData` [UploadData[]](upload-data.md) (optional)
+* `headers` Record<String, String>

docs/api/structures/trace-config.md

@@ -6,7 +6,7 @@
 * `trace_buffer_size_in_events` number (optional) - maximum size of the trace
   recording buffer in events.
 * `enable_argument_filter` boolean (optional) - if true, filter event data
-  according to a whitelist of events that have been manually vetted to not
+  according to a specific list of events that have been manually vetted to not
   include any PII. See [the implementation in
   Chromium][trace_event_args_whitelist.cc] for specifics.
 * `included_categories` String[] (optional) - a list of tracing categories to
@@ -41,7 +41,7 @@ An example TraceConfig that roughly matches what Chrome DevTools records:
     'disabled-by-default-v8.cpu_profiler',
     'disabled-by-default-v8.cpu_profiler.hires'
   ],
-  excluded_categories: [ '*' ]
+  excluded_categories: ['*']
 }
 ```
 

docs/api/system-preferences.md

@@ -209,7 +209,7 @@ not (transparent windows won't work correctly when DWM composition is disabled):
 
 ```javascript
 const { BrowserWindow, systemPreferences } = require('electron')
-let browserOptions = { width: 1000, height: 800 }
+const browserOptions = { width: 1000, height: 800 }
 
 // Make the window transparent only if the platform supports it.
 if (process.platform !== 'win32' || systemPreferences.isAeroGlassEnabled()) {
@@ -218,7 +218,7 @@ if (process.platform !== 'win32' || systemPreferences.isAeroGlassEnabled()) {
 }
 
 // Create the window.
-let win = new BrowserWindow(browserOptions)
+const win = new BrowserWindow(browserOptions)
 
 // Navigate.
 if (browserOptions.transparent) {
@@ -416,7 +416,7 @@ This API itself will not protect your user data; rather, it is a mechanism to al
 
 Returns `Boolean` - `true` if the current process is a trusted accessibility client and `false` if it is not.
 
-### `systemPreferences.getMediaAccessStatus(mediaType)` _macOS_
+### `systemPreferences.getMediaAccessStatus(mediaType)` _Windows_ _macOS_
 
 * `mediaType` String - Can be `microphone`, `camera` or `screen`.
 
@@ -426,6 +426,9 @@ This user consent was not required on macOS 10.13 High Sierra or lower so this m
 macOS 10.14 Mojave or higher requires consent for `microphone` and `camera` access.
 macOS 10.15 Catalina or higher requires consent for `screen` access.
 
+Windows 10 has a global setting controlling `microphone` and `camera` access for all win32 applications.
+It will always return `granted` for `screen` and for all media types on older versions of Windows.
+
 ### `systemPreferences.askForMediaAccess(mediaType)` _macOS_
 
 * `mediaType` String - the type of media being requested; can be `microphone`, `camera`.

docs/api/touch-bar-button.md

@@ -41,6 +41,10 @@ the button in the touch bar.
 A `NativeImage` representing the button's current icon. Changing this value immediately updates the button
 in the touch bar.
 
+#### `touchBarButton.iconPosition`
+
+A `String` - Can be `left`, `right` or `overlay`.  Defaults to `overlay`.
+
 #### `touchBarButton.enabled`
 
 A `Boolean` representing whether the button is in an enabled state.

docs/api/touch-bar-segmented-control.md

@@ -49,3 +49,7 @@ updates the control in the touch bar. Updating deep properties inside this array
 
 An `Integer` representing the currently selected segment. Changing this value immediately updates the control
 in the touch bar. User interaction with the touch bar will update this value automatically.
+
+#### `touchBarSegmentedControl.mode`
+
+A `String` representing the current selection mode of the control.  Can be `single`, `multiple` or `buttons`.

docs/api/touch-bar-spacer.md

@@ -11,3 +11,11 @@ Process: [Main](../tutorial/application-architecture.md#main-and-renderer-proces
     * `small` - Small space between items. Maps to `NSTouchBarItemIdentifierFixedSpaceSmall`. This is the default.
     * `large` - Large space between items. Maps to `NSTouchBarItemIdentifierFixedSpaceLarge`.
     * `flexible` - Take up all available space. Maps to `NSTouchBarItemIdentifierFlexibleSpace`.
+
+### Instance Properties
+
+The following properties are available on instances of `TouchBarSpacer`:
+
+#### `touchBarSpacer.size`
+
+A `String` representing the size of the spacer.  Can be `small`, `large` or `flexible`.

docs/api/web-contents.md

@@ -12,10 +12,10 @@ the [`BrowserWindow`](browser-window.md) object. An example of accessing the
 ```javascript
 const { BrowserWindow } = require('electron')
 
-let win = new BrowserWindow({ width: 800, height: 1500 })
+const win = new BrowserWindow({ width: 800, height: 1500 })
 win.loadURL('http://github.com')
 
-let contents = win.webContents
+const contents = win.webContents
 console.log(contents)
 ```
 
@@ -138,7 +138,7 @@ Emitted when page receives favicon urls.
 
 Returns:
 
-* `event` Event
+* `event` NewWindowWebContentsEvent
 * `url` String
 * `frameName` String
 * `disposition` String - Can be `default`, `foreground-tab`, `background-tab`,
@@ -338,7 +338,7 @@ win.webContents.on('will-prevent-unload', (event) => {
 })
 ```
 
-#### Event: 'crashed'
+#### Event: 'crashed' _Deprecated_
 
 Returns:
 
@@ -347,6 +347,29 @@ Returns:
 
 Emitted when the renderer process crashes or is killed.
 
+**Deprecated:** This event is superceded by the `render-process-gone` event
+which contains more information about why the render process dissapeared. It
+isn't always because it crashed.  The `killed` boolean can be replaced by
+checking `reason === 'killed'` when you switch to that event.
+
+#### Event: 'render-process-gone'
+
+Returns:
+
+* `event` Event
+* `details` Object
+  * `reason` String - The reason the render process is gone.  Possible values:
+    * `clean-exit` - Process exited with an exit code of zero
+    * `abnormal-exit` - Process exited with a non-zero exit code
+    * `killed` - Process was sent a SIGTERM or otherwise killed externally
+    * `crashed` - Process crashed
+    * `oom` - Process ran out of memory
+    * `launch-failure` - Process never successfully launched
+    * `integrity-failure` - Windows code integrity checks failed
+
+Emitted when the renderer process unexpectedly dissapears.  This is normally
+because it was crashed or killed.
+
 #### Event: 'unresponsive'
 
 Emitted when the web page becomes unresponsive.
@@ -379,6 +402,7 @@ Returns:
   * `key` String - Equivalent to [KeyboardEvent.key][keyboardevent].
   * `code` String - Equivalent to [KeyboardEvent.code][keyboardevent].
   * `isAutoRepeat` Boolean - Equivalent to [KeyboardEvent.repeat][keyboardevent].
+  * `isComposing` Boolean - Equivalent to [KeyboardEvent.isComposing][keyboardevent].
   * `shift` Boolean - Equivalent to [KeyboardEvent.shiftKey][keyboardevent].
   * `control` Boolean - Equivalent to [KeyboardEvent.controlKey][keyboardevent].
   * `alt` Boolean - Equivalent to [KeyboardEvent.altKey][keyboardevent].
@@ -394,7 +418,7 @@ To only prevent the menu shortcuts, use
 ```javascript
 const { BrowserWindow } = require('electron')
 
-let win = new BrowserWindow({ width: 800, height: 600 })
+const win = new BrowserWindow({ width: 800, height: 600 })
 
 win.webContents.on('before-input-event', (event, input) => {
   // For example, only enable application menu keyboard shortcuts when
@@ -641,7 +665,7 @@ app.whenReady().then(() => {
   win = new BrowserWindow({ width: 800, height: 600 })
   win.webContents.on('select-bluetooth-device', (event, deviceList, callback) => {
     event.preventDefault()
-    let result = deviceList.find((device) => {
+    const result = deviceList.find((device) => {
       return device.deviceName === 'test'
     })
     if (!result) {
@@ -667,7 +691,7 @@ buffer.
 ```javascript
 const { BrowserWindow } = require('electron')
 
-let win = new BrowserWindow({ webPreferences: { offscreen: true } })
+const win = new BrowserWindow({ webPreferences: { offscreen: true } })
 win.webContents.on('paint', (event, dirty, image) => {
   // updateBitmap(dirty, image.getBitmap())
 })
@@ -714,9 +738,9 @@ Emitted when a `<webview>` has been attached to this web contents.
 Returns:
 
 * `event` Event
-* `level` Integer
-* `message` String
-* `line` Integer
+* `level` Integer - The log level, from 0 to 3. In order it matches `verbose`, `info`, `warning` and `error`.
+* `message` String - The actual console message
+* `line` Integer - The line number of the source that triggered this console message
 * `sourceId` String
 
 Emitted when the associated window logs a console message.
@@ -883,11 +907,11 @@ Returns `String` - The URL of the current web page.
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow({ width: 800, height: 600 })
-win.loadURL('http://github.com')
-
-let currentURL = win.webContents.getURL()
-console.log(currentURL)
+const win = new BrowserWindow({ width: 800, height: 600 })
+win.loadURL('http://github.com').then(() => {
+  const currentURL = win.webContents.getURL()
+  console.log(currentURL)
+})
 ```
 
 #### `contents.getTitle()`
@@ -1287,6 +1311,8 @@ Returns [`PrinterInfo[]`](structures/printer-info.md)
   * `success` Boolean - Indicates success of the print call.
   * `failureReason` String - Error description called back if the print fails.
 
+When a custom `pageSize` is passed, Chromium attempts to validate platform specific minumum values for `width_microns` and `height_microns`. Width and height must both be minimum 353 microns but may be higher on some operating systems.
+
 Prints window's web page. When `silent` is set to `true`, Electron will pick
 the system's default printer if `deviceName` is empty and the default settings for printing.
 
@@ -1310,13 +1336,12 @@ win.webContents.print(options, (success, errorType) => {
   * `landscape` Boolean (optional) - `true` for landscape, `false` for portrait.
   * `marginsType` Integer (optional) - Specifies the type of margins to use. Uses 0 for
     default margin, 1 for no margin, and 2 for minimum margin.
-    and `width` in microns.
   * `scaleFactor` Number (optional) - The scale factor of the web page. Can range from 0 to 100.
   * `pageRanges` Record<string, number> (optional) - The page range to print.
     * `from` Number - the first page to print.
     * `to` Number - the last page to print (inclusive).
   * `pageSize` String | Size (optional) - Specify page size of the generated PDF. Can be `A3`,
-  `A4`, `A5`, `Legal`, `Letter`, `Tabloid` or an Object containing `height`
+  `A4`, `A5`, `Legal`, `Letter`, `Tabloid` or an Object containing `height` and `width` in microns.
   * `printBackground` Boolean (optional) - Whether to print CSS backgrounds.
   * `printSelectionOnly` Boolean (optional) - Whether to print selection only.
 
@@ -1347,19 +1372,22 @@ An example of `webContents.printToPDF`:
 ```javascript
 const { BrowserWindow } = require('electron')
 const fs = require('fs')
+const path = require('path')
+const os = require('os')
 
-let win = new BrowserWindow({ width: 800, height: 600 })
+const win = new BrowserWindow({ width: 800, height: 600 })
 win.loadURL('http://github.com')
 
 win.webContents.on('did-finish-load', () => {
   // Use default printing options
   win.webContents.printToPDF({}).then(data => {
-    fs.writeFile('/tmp/print.pdf', data, (error) => {
+    const pdfPath = path.join(os.homedir(), 'Desktop', 'temp.pdf')
+    fs.writeFile(pdfPath, data, (error) => {
       if (error) throw error
-      console.log('Write PDF successfully.')
+      console.log(`Wrote PDF successfully to ${pdfPath}`)
     })
   }).catch(error => {
-    console.log(error)
+    console.log(`Failed to write PDF to ${pdfPath}: `, error)
   })
 })
 ```
@@ -1373,7 +1401,7 @@ creation:
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 win.webContents.on('devtools-opened', () => {
   win.webContents.addWorkSpace(__dirname)
 })
@@ -1694,7 +1722,7 @@ Returns `Promise<void>` - resolves if the page is saved.
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 
 win.loadURL('https://github.com')
 
@@ -1789,6 +1817,11 @@ Returns `Promise<void>` - Indicates whether the snapshot has been created succes
 
 Takes a V8 heap snapshot and saves it to `filePath`.
 
+#### `contents.getBackgroundThrottling()`
+
+Returns `Boolean` - whether or not this WebContents will throttle animations and timers
+when the page becomes backgrounded. This also affects the Page Visibility API.
+
 #### `contents.setBackgroundThrottling(allowed)`
 
 * `allowed` Boolean
@@ -1843,7 +1876,7 @@ A [`WebContents`](web-contents.md) instance that might own this `WebContents`.
 
 #### `contents.devToolsWebContents` _Readonly_
 
-A `WebContents` of DevTools for this `WebContents`.
+A `WebContents | null` property that represents the of DevTools `WebContents` associated with a given `WebContents`.
 
 **Note:** Users should never store this object because it may become `null`
 when the DevTools has been closed.
@@ -1856,3 +1889,8 @@ A [`Debugger`](debugger.md) instance for this webContents.
 [event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter
 [SCA]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
 [`postMessage`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
+
+#### `contents.backgroundThrottling`
+
+A `Boolean` property that determines whether or not this WebContents will throttle animations and timers
+when the page becomes backgrounded. This also affects the Page Visibility API.

docs/api/web-frame.md

@@ -162,10 +162,14 @@ this limitation.
   * `error` Error
 
 Returns `Promise<any>` - A promise that resolves with the result of the executed
-code or is rejected if execution throws or results in a rejected promise.
+code or is rejected if execution could not start.
 
 Works like `executeJavaScript` but evaluates `scripts` in an isolated context.
 
+Note that when the execution of script fails, the returned promise will not
+reject and the `result` would be `undefined`. This is because Chromium does not
+dispatch errors of isolated worlds to foreign worlds.
+
 ### `webFrame.setIsolatedWorldInfo(worldId, info)`
 * `worldId` Integer - The ID of the world to run the javascript in, `0` is the default world, `999` is the world used by Electrons `contextIsolation` feature. Chrome extensions reserve the range of IDs in `[1 << 20, 1 << 29)`. You can provide any integer here.
 * `info` Object

docs/api/webview-tag.md

@@ -755,9 +755,9 @@ Fired when page leaves fullscreen triggered by HTML API.
 
 Returns:
 
-* `level` Integer
-* `message` String
-* `line` Integer
+* `level` Integer - The log level, from 0 to 3. In order it matches `verbose`, `info`, `warning` and `error`.
+* `message` String - The actual console message
+* `line` Integer - The line number of the source that triggered this console message
 * `sourceId` String
 
 Fired when the guest window logs a console message.
@@ -816,7 +816,7 @@ const { shell } = require('electron')
 const webview = document.querySelector('webview')
 
 webview.addEventListener('new-window', async (e) => {
-  const protocol = require('url').parse(e.url).protocol
+  const protocol = (new URL(e.url)).protocol
   if (protocol === 'http:' || protocol === 'https:') {
     await shell.openExternal(e.url)
   }

docs/api/window-open.md

@@ -94,6 +94,6 @@ mainWindow.webContents.on('new-window', (event, url, frameName, disposition, opt
 
 ```javascript
 // renderer process (mainWindow)
-let modal = window.open('', 'modal')
+const modal = window.open('', 'modal')
 modal.document.write('<h1>Hello</h1>')
 ```

docs/breaking-changes.md

@@ -12,8 +12,101 @@ This document uses the following convention to categorize breaking changes:
 - **Deprecated:** An API was marked as deprecated. The API will continue to function, but will emit a deprecation warning, and will be removed in a future release.
 - **Removed:** An API or feature was removed, and is no longer supported by Electron.
 
+## Planned Breaking API Changes (12.0)
+
+### Default Changed: `contextIsolation` defaults to `true`
+
+In Electron 12, `contextIsolation` will be enabled by default.  To restore
+the previous behavior, `contextIsolation: false` must be specified in WebPreferences.
+
+We [recommend having contextIsolation enabled](https://github.com/electron/electron/blob/master/docs/tutorial/security.md#3-enable-context-isolation-for-remote-content) for the security of your application.
+
+For more details see: https://github.com/electron/electron/issues/23506
+
+### Removed: `crashReporter` methods in the renderer process
+
+The following `crashReporter` methods are no longer available in the renderer
+process:
+
+- `crashReporter.start`
+- `crashReporter.getLastCrashReport`
+- `crashReporter.getUploadedReports`
+- `crashReporter.getUploadToServer`
+- `crashReporter.setUploadToServer`
+- `crashReporter.getCrashesDirectory`
+
+They should be called only from the main process.
+
+See [#23265](https://github.com/electron/electron/pull/23265) for more details.
+
+### Default Changed: `crashReporter.start({ compress: true })`
+
+The default value of the `compress` option to `crashReporter.start` has changed
+from `false` to `true`. This means that crash dumps will be uploaded to the
+crash ingestion server with the `Content-Encoding: gzip` header, and the body
+will be compressed.
+
+If your crash ingestion server does not support compressed payloads, you can
+turn off compression by specifying `{ compress: false }` in the crash reporter
+options.
+
+## Planned Breaking API Changes (11.0)
+
+There are no breaking changes planned for 11.0.
+
 ## Planned Breaking API Changes (10.0)
 
+### Deprecated: `companyName` argument to `crashReporter.start()`
+
+The `companyName` argument to `crashReporter.start()`, which was previously
+required, is now optional, and further, is deprecated. To get the same
+behavior in a non-deprecated way, you can pass a `companyName` value in
+`globalExtra`.
+
+```js
+// Deprecated in Electron 10
+crashReporter.start({ companyName: 'Umbrella Corporation' })
+// Replace with
+crashReporter.start({ globalExtra: { _companyName: 'Umbrella Corporation' } })
+```
+
+### Deprecated: `crashReporter.getCrashesDirectory()`
+
+The `crashReporter.getCrashesDirectory` method has been deprecated. Usage
+should be replaced by `app.getPath('crashDumps')`.
+
+```js
+// Deprecated in Electron 10
+crashReporter.getCrashesDirectory()
+// Replace with
+app.getPath('crashDumps')
+```
+
+### Deprecated: `crashReporter` methods in the renderer process
+
+Calling the following `crashReporter` methods from the renderer process is
+deprecated:
+
+- `crashReporter.start`
+- `crashReporter.getLastCrashReport`
+- `crashReporter.getUploadedReports`
+- `crashReporter.getUploadToServer`
+- `crashReporter.setUploadToServer`
+- `crashReporter.getCrashesDirectory`
+
+The only non-deprecated methods remaining in the `crashReporter` module in the
+renderer are `addExtraParameter`, `removeExtraParameter` and `getParameters`.
+
+All above methods remain non-deprecated when called from the main process.
+
+See [#23265](https://github.com/electron/electron/pull/23265) for more details.
+
+### Deprecated: `crashReporter.start({ compress: false })`
+
+Setting `{ compress: false }` in `crashReporter.start` is deprecated. Nearly
+all crash ingestion servers support gzip compression. This option will be
+removed in a future version of Electron.
+
 ### Removed: Browser Window Affinity
 
 The `affinity` option when constructing a new `BrowserWindow` will be removed
@@ -173,7 +266,7 @@ const getGuestForWebContents = (webContentsId, contents) => {
     throw new Error(`Invalid webContentsId: ${webContentsId}`)
   }
   if (guest.hostWebContents !== contents) {
-    throw new Error(`Access denied to webContents`)
+    throw new Error('Access denied to webContents')
   }
   return guest
 }
@@ -229,7 +322,7 @@ powerMonitor.querySystemIdleState(threshold, callback)
 const idleState = powerMonitor.getSystemIdleState(threshold)
 ```
 
-### API Changed: `powerMonitor.querySystemIdleTime` is now `powerMonitor.getSystemIdleState`
+### API Changed: `powerMonitor.querySystemIdleTime` is now `powerMonitor.getSystemIdleTime`
 
 ```js
 // Removed in Electron 7.0
@@ -517,11 +610,11 @@ const { memory } = metrics[0] // Deprecated property
 
 ```js
 // Deprecated
-let optionsA = { webPreferences: { blinkFeatures: '' } }
-let windowA = new BrowserWindow(optionsA)
+const optionsA = { webPreferences: { blinkFeatures: '' } }
+const windowA = new BrowserWindow(optionsA)
 // Replace with
-let optionsB = { webPreferences: { enableBlinkFeatures: '' } }
-let windowB = new BrowserWindow(optionsB)
+const optionsB = { webPreferences: { enableBlinkFeatures: '' } }
+const windowB = new BrowserWindow(optionsB)
 
 // Deprecated
 window.on('app-command', (e, cmd) => {
@@ -692,11 +785,11 @@ The following list includes the breaking API changes made in Electron 2.0.
 
 ```js
 // Deprecated
-let optionsA = { titleBarStyle: 'hidden-inset' }
-let windowA = new BrowserWindow(optionsA)
+const optionsA = { titleBarStyle: 'hidden-inset' }
+const windowA = new BrowserWindow(optionsA)
 // Replace with
-let optionsB = { titleBarStyle: 'hiddenInset' }
-let windowB = new BrowserWindow(optionsB)
+const optionsB = { titleBarStyle: 'hiddenInset' }
+const windowB = new BrowserWindow(optionsB)
 ```
 
 ### `menu`

docs/development/README.md

@@ -23,4 +23,3 @@ For guides on Electron app development, see
 * [Debugging on macOS](debugging-instructions-macos.md)
 * [Setting Up Symbol Server in Debugger](setting-up-symbol-server.md)
 * [Patches](patches.md)
-* [Upgrading Node](upgrading-node.md)

docs/development/build-instructions-gn.md

@@ -10,6 +10,10 @@ Check the build prerequisites for your platform before proceeding
   * [Linux](build-instructions-linux.md#prerequisites)
   * [Windows](build-instructions-windows.md#prerequisites)
 
+## Build Tools
+
+[Electron's Build Tools](https://github.com/electron/build-tools) automate much of the setup for compiling Electron from source with different configurations and build targets. If you wish to set up the environment manually, the instructions are listed below.
+
 ## GN prerequisites
 
 You'll need to install [`depot_tools`][depot-tools], the toolset
@@ -24,13 +28,12 @@ try to download a Google-internal version that only Googlers have access to).
 
 [depot-tools]: http://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up
 
-## Cached builds (optional step)
+### Setting up the git cache
 
-### GIT\_CACHE\_PATH
-
-If you plan on building Electron more than once, adding a git cache will
-speed up subsequent calls to `gclient`. To do this, set a `GIT_CACHE_PATH`
-environment variable:
+If you plan on checking out Electron more than once (for example, to have
+multiple parallel directories checked out to different branches), using the git
+cache will speed up subsequent calls to `gclient`. To do this, set a
+`GIT_CACHE_PATH` environment variable:
 
 ```sh
 $ export GIT_CACHE_PATH="${HOME}/.git_cache"
@@ -38,22 +41,10 @@ $ mkdir -p "${GIT_CACHE_PATH}"
 # This will use about 16G.
 ```
 
-### sccache
-
-Thousands of files must be compiled to build Chromium and Electron.
-You can avoid much of the wait by reusing Electron CI's build output via
-[sccache](https://github.com/mozilla/sccache). This requires some
-optional steps (listed below) and these two environment variables:
-
-```sh
-export SCCACHE_BUCKET="electronjs-sccache-ci"
-export SCCACHE_TWO_TIER=true
-```
-
 ## Getting the code
 
 ```sh
-$ mkdir electron-gn && cd electron-gn
+$ mkdir electron && cd electron
 $ gclient config --name "src/electron" --unmanaged https://github.com/electron/electron
 $ gclient sync --with_branch_heads --with_tags
 # This will take a while, go get a coffee.

docs/development/debug-instructions-windows.md

@@ -3,7 +3,7 @@
 If you experience crashes or issues in Electron that you believe are not caused
 by your JavaScript application, but instead by Electron itself, debugging can
 be a little bit tricky, especially for developers not used to native/C++
-debugging. However, using Visual Studio, GitHub's hosted Electron Symbol Server,
+debugging. However, using Visual Studio, Electron's hosted Symbol Server,
 and the Electron source code, you can enable step-through debugging
 with breakpoints inside Electron's source code.
 
@@ -22,7 +22,7 @@ with breakpoints inside Electron's source code.
 
 * **Visual Studio with C++ Tools**: The free community editions of Visual
   Studio 2013 and Visual Studio 2015 both work. Once installed,
-  [configure Visual Studio to use GitHub's Electron Symbol server](setting-up-symbol-server.md).
+  [configure Visual Studio to use Electron's Symbol server](setting-up-symbol-server.md).
   It will enable Visual Studio to gain a better understanding of what happens
   inside Electron, making it easier to present variables in a human-readable
   format.

docs/development/upgrading-node.md

@@ -1,121 +0,0 @@
-# Upgrading Node
-
-## Discussion
-
-Chromium and Node.js both depend on V8, and Electron contains
-only a single copy of V8, so it's important to ensure that the
-version of V8 chosen is compatible with the build's version of
-Node.js and Chromium.
-
-Upgrading Node is much easier than upgrading Chromium, so fewer
-conflicts arise if one upgrades Chromium first, then chooses the
-upstream Node release whose version of V8 is closest to the one
-Chromium contains.
-
-Electron has its own [Node fork](https://github.com/electron/node)
-with modifications for the V8 build details mentioned above
-and for exposing API needed by Electron. Once an upstream Node
-release is chosen, it's placed in a branch in Electron's Node fork
-and any Electron Node patches are applied there.
-
-Another factor is that the Node project patches its version of V8.
-As mentioned above, Electron builds everything with a single copy
-of V8, so Node's V8 patches must be ported to that copy.
-
-Once all of Electron's dependencies are building and using the same
-copy of V8, the next step is to fix any Electron code issues caused
-by the Node upgrade.
-
-[FIXME] something about a Node debugger in Atom that we (e.g. deepak)
-use and need to confirm doesn't break with the Node upgrade?
-
-So in short, the primary steps are:
-
-1. Update Electron's Node fork to the desired version
-2. Backport Node's V8 patches to our copy of V8
-3. Update the GN build files, porting changes from node's GYP files
-4. Update Electron's DEPS to use new version of Node
-
-## Updating Electron's Node [fork](https://github.com/electron/node)
-
-1. Ensure that `master` on `electron/node` has updated release tags from `nodejs/node`
-2. Create a branch in https://github.com/electron/node: `electron-node-vX.X.X` where the base that you're branching from is the tag for the desired update
-  - `vX.X.X` Must use a version of Node compatible with our current version of Chromium
-3. Re-apply our commits from the previous version of Node we were using (`vY.Y.Y`) to `v.X.X.X`
-  - Check release tag and select the range of commits we need to re-apply
-  - Cherry-pick commit range:
-    1. Checkout both `vY.Y.Y` & `v.X.X.X`
-    2. `git cherry-pick FIRST_COMMIT_HASH..LAST_COMMIT_HASH`
-  - Resolve merge conflicts in each file encountered, then:
-    1. `git add <conflict-file>`
-    2. `git cherry-pick --continue`
-    3. Repeat until finished
-
-
-## Updating [V8](https://github.com/electron/node/src/V8) Patches
-
-We need to generate a patch file from each patch that Node
-applies to V8.
-
-```sh
-$ cd third_party/electron_node
-$ CURRENT_NODE_VERSION=vX.Y.Z
-# Find the last commit with the message "deps: update V8 to <some version>"
-# This commit corresponds to Node resetting V8 to its pristine upstream
-# state at the stated version.
-$ LAST_V8_UPDATE="$(git log --grep='^deps: update V8' --format='%H' -1 deps/v8)"
-# This creates a patch file containing all changes in deps/v8 from
-# $LAST_V8_UPDATE up to the current Node version, formatted in a way that
-# it will apply cleanly to the V8 repository (i.e. with `deps/v8`
-# stripped off the path and excluding the v8/gypfiles directory, which
-# isn't present in V8.
-$ git format-patch \
-    --relative=deps/v8 \
-    $LAST_V8_UPDATE..$CURRENT_NODE_VERSION \
-    deps/v8 \
-    ':(exclude)deps/v8/gypfiles' \
-    --stdout \
-    > ../../electron/common/patches/v8/node_v8_patches.patch
-```
-
-This list of patches will probably include one that claims to
-make the V8 API backwards-compatible with a previous version of
-V8. Unfortunately, those patches almost always change the V8 API
-in a way that is incompatible with Chromium.
-
-It's usually easier to update Node to work without the
-compatibility patch than to update Chromium to work with the
-compatibility patch, so it's recommended to revert the
-compatibility patch and fix any errors that arise when compiling
-Node.
-
-## Update Electron's `DEPS` file
-
-Update the `DEPS` file in the root of
-[electron/electron](https://github.com/electron/electron) to
-point to the git hash of the updated Node.
-
-## Notes
-
-- Node maintains its own fork of V8
-  - They backport a small amount of things as needed
-  - Documentation in Node about how [they work with V8](https://nodejs.org/api/v8.html)
-- We update code such that we only use one copy of V8 across all of Electron
-  - E.g Electron, Chromium, and Node.js
-- We don’t track upstream closely due to logistics:
-   - Upstream uses multiple repos and so merging into a single repo
-   would result in lost history. So we only update when we’re planning
-   a Node version bump in Electron.
-- Chromium is large and time-consuming to update, so we typically
-  choose the Node version based on which of its releases has a version
-  of V8 that’s closest to the version in Chromium that we’re using.
-  - We sometimes have to wait for the next periodic Node release
-   because it will sync more closely with the version of V8 in the new Chromium
- - Electron keeps all its patches in the repo because it’s simpler than
-   maintaining different repos for patches for each upstream project.
-   - Crashpad, Node.js, Chromium, Skia etc. patches are all kept in the same place
- - Building Node:
-   - We maintain our own GN build files for Node.js to make it easier to ensure
-     that eevrything is built with the same compiler flags.
-     This means that every time we upgrade Node.js we have to do a modest amount of
-     work to synchronize the GN files with the upstream GYP files.

docs/faq.md

@@ -107,7 +107,7 @@ To solve this, you can turn off node integration in Electron:
 ```javascript
 // In the main process.
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow({
+const win = new BrowserWindow({
   webPreferences: {
     nodeIntegration: false
   }
@@ -155,7 +155,7 @@ To achieve this goal, set the background in the constructor for [BrowserWindow][
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow({
+const win = new BrowserWindow({
   backgroundColor: '#fff'
 })
 ```

docs/tutorial/app-feedback-program.md

@@ -1,3 +0,0 @@
-# Electron App Feedback Program
-
-Electron is working on building a streamlined release process and having faster releases. To help with that, we have the App Feedback Program for large-scale Electron apps to test our beta releases and report app-specific issues to the Electron team. We use this program to help us prioritize work and get applications upgraded to the next stable release as soon as possible. There are a few requirements we expect from participants, such as attending short, online weekly check-ins. Please visit the [blog post](https://electronjs.org/blog/app-feedback-program) for details and sign-up.

docs/tutorial/application-debugging.md

@@ -15,7 +15,7 @@ can open them programmatically by calling the `openDevTools()` API on the
 ```javascript
 const { BrowserWindow } = require('electron')
 
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 win.webContents.openDevTools()
 ```
 

docs/tutorial/application-packaging.md

@@ -70,7 +70,7 @@ fs.readdirSync('/path/to/example.asar')
 Use a module from the archive:
 
 ```javascript
-require('/path/to/example.asar/dir/module.js')
+require('./path/to/example.asar/dir/module.js')
 ```
 
 You can also display a web page in an `asar` archive with `BrowserWindow`:

docs/tutorial/automated-testing-with-a-custom-driver.md

@@ -9,9 +9,9 @@ const childProcess = require('child_process')
 const electronPath = require('electron')
 
 // spawn the process
-let env = { /* ... */ }
-let stdio = ['inherit', 'inherit', 'inherit', 'ipc']
-let appProcess = childProcess.spawn(electronPath, ['./app'], { stdio, env })
+const env = { /* ... */ }
+const stdio = ['inherit', 'inherit', 'inherit', 'ipc']
+const appProcess = childProcess.spawn(electronPath, ['./app'], { stdio, env })
 
 // listen for IPC messages from the app
 appProcess.on('message', (msg) => {
@@ -50,7 +50,7 @@ class TestDriver {
     // handle rpc responses
     this.process.on('message', (message) => {
       // pop the handler
-      let rpcCall = this.rpcCalls[message.msgId]
+      const rpcCall = this.rpcCalls[message.msgId]
       if (!rpcCall) return
       this.rpcCalls[message.msgId] = null
       // reject/resolve
@@ -70,7 +70,7 @@ class TestDriver {
   // to use: driver.rpc('method', 1, 2, 3).then(...)
   async rpc (cmd, ...args) {
     // send rpc request
-    let msgId = this.rpcCalls.length
+    const msgId = this.rpcCalls.length
     this.process.send({ msgId, cmd, args })
     return new Promise((resolve, reject) => this.rpcCalls.push({ resolve, reject }))
   }
@@ -92,10 +92,10 @@ async function onMessage ({ msgId, cmd, args }) {
   let method = METHODS[cmd]
   if (!method) method = () => new Error('Invalid method: ' + cmd)
   try {
-    let resolve = await method(...args)
+    const resolve = await method(...args)
     process.send({ msgId, resolve })
   } catch (err) {
-    let reject = {
+    const reject = {
       message: err.message,
       stack: err.stack,
       name: err.name
@@ -119,7 +119,7 @@ Then, in your test suite, you can use your test-driver as follows:
 const test = require('ava')
 const electronPath = require('electron')
 
-let app = new TestDriver({
+const app = new TestDriver({
   path: electronPath,
   args: ['./app'],
   env: {

docs/tutorial/code-signing.md

@@ -6,52 +6,172 @@ created by you.
 On macOS the system can detect any change to the app, whether the change is
 introduced accidentally or by malicious code.
 
-On Windows the system assigns a trust level to your code signing certificate which
-if you don't have, or if your trust level is low will cause security dialogs to
-appear when users start using your application.  Trust level builds over time
-so it's better to start code signing as early as possible.
+On Windows, the system assigns a trust level to your code signing certificate
+which if you don't have, or if your trust level is low, will cause security
+dialogs to appear when users start using your application.  Trust level builds
+over time so it's better to start code signing as early as possible.
 
 While it is possible to distribute unsigned apps, it is not recommended. Both
-Windows and macOS will, by default, prevent either the download or the
-execution of unsigned applications. Starting with macOS Catalina (version 10.15),
-users have to go through multiple manual steps to open unsigned applications.
+Windows and macOS will, by default, prevent either the download or the execution
+of unsigned applications. Starting with macOS Catalina (version 10.15), users
+have to go through multiple manual steps to open unsigned applications.
 
-![macOS Catalina Gatekeeper warning: The app cannot be opened because the developer cannot be verified](../images/gatekeeper.png)
+![macOS Catalina Gatekeeper warning: The app cannot be opened because the
+developer cannot be verified](../images/gatekeeper.png)
 
 As you can see, users get two options: Move the app straight to the trash or
 cancel running it. You don't want your users to see that dialog.
 
 If you are building an Electron app that you intend to package and distribute,
-it should be code-signed. The Mac and Windows app stores do not allow unsigned
-apps.
+it should be code-signed.
 
-# Signing macOS builds
+# Signing & notarizing macOS builds
 
-Before signing macOS builds, you must do the following:
+Properly preparing macOS applications for release requires two steps: First, the
+app needs to be code-signed. Then, the app needs to be uploaded to Apple for a
+process called "notarization", where automated systems will further verify that
+your app isn't doing anything to endanger its users.
+
+To start the process, ensure that you fulfill the requirements for signing and
+notarizing your app:
 
 1. Enroll in the [Apple Developer Program] (requires an annual fee)
-2. Download and install [Xcode]
+2. Download and install [Xcode] - this requires a computer running macOS
 3. Generate, download, and install [signing certificates]
 
-There are a number of tools for signing your packaged app:
+Electron's ecosystem favors configuration and freedom, so there are multiple
+ways to get your application signed and notarized.
 
-- [`electron-osx-sign`] is a standalone tool for signing macOS packages.
-- [`electron-packager`] bundles `electron-osx-sign`. If you're using `electron-packager`,
-pass the `--osx-sign=true` flag to sign your build.
-  - [`electron-forge`] uses `electron-packager` internally, you can set the `osxSign` option
-    in your forge config.
-- [`electron-builder`] has built-in code-signing capabilities. See [electron.build/code-signing](https://www.electron.build/code-signing)
+## `electron-forge`
 
-## Notarization
+If you're using Electron's favorite build tool, getting your application signed
+and notarized requires a few additions to your configuration. [Forge](https://electronforge.io) is a
+collection of the official Electron tools, using [`electron-packager`],
+[`electron-osx-sign`], and [`electron-notarize`] under the hood.
 
-Starting with macOS Catalina, Apple requires applications to be notarized.
-"Notarization" as defined by Apple means that you upload your previously signed
-application to Apple for additional verification _before_ distributing the app
-to your users.
+Let's take a look at an example configuration with all required fields. Not all
+of them are required: the tools will be clever enough to automatically find a
+suitable `identity`, for instance, but we recommend that you are explicit.
 
-To automate this process, you can use the [`electron-notarize`] module. You
-do not necessarily need to complete this step for every build you make – just
-the builds you intend to ship to users.
+```json
+{
+  "name": "my-app",
+  "version": "0.0.1",
+  "config": {
+    "forge": {
+      "packagerConfig": {
+        "osxSign": {
+          "identity": "Developer ID Application: Felix Rieseberg (LT94ZKYDCJ)",
+          "hardened-runtime": true,
+          "entitlements": "entitlements.plist",
+          "entitlements-inherit": "entitlements.plist",
+          "signature-flags": "library"
+        },
+        "osxNotarize": {
+          "appleId": "felix@felix.fun",
+          "appleIdPassword": "my-apple-id-password",
+        }
+      }
+    }
+  }
+}
+```
+
+The `plist` file referenced here needs the following macOS-specific entitlements
+to assure the Apple security mechanisms that your app is doing these things
+without meaning any harm:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>com.apple.security.cs.allow-jit</key>
+    <true/>
+    <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
+    <true/>
+    <key>com.apple.security.cs.debugger</key>
+    <true/>
+  </dict>
+</plist>
+```
+
+To see all of this in action, check out Electron Fiddle's source code,
+[especially its `electron-forge` configuration
+file](https://github.com/electron/fiddle/blob/master/forge.config.js).
+
+If you plan to access the microphone or camera within your app using Electron's APIs, you'll also
+need to add the following entitlements:
+
+```xml
+<key>com.apple.security.device.audio-input</key>
+<true/>
+<key>com.apple.security.device.camera</key>
+<true/>
+```
+
+If these are not present in your app's entitlements when you invoke, for example:
+
+```js
+const { systemPreferences } = require('electron')
+
+const microphone = systemPreferences.askForMediaAccess('microphone')
+```
+
+Your app may crash. See the Resource Access section in [Hardened Runtime](https://developer.apple.com/documentation/security/hardened_runtime) for more information and entitlements you may need.
+
+## `electron-builder`
+
+Electron Builder comes with a custom solution for signing your application. You
+can find [its documentation here](https://www.electron.build/code-signing).
+
+## `electron-packager`
+
+If you're not using an integrated build pipeline like Forge or Builder, you
+are likely using [`electron-packager`], which includes [`electron-osx-sign`] and
+[`electron-notarize`].
+
+If you're using Packager's API, you can pass [in configuration that both signs
+and notarizes your
+application](https://electron.github.io/electron-packager/master/interfaces/electronpackager.options.html).
+
+```js
+const packager = require('electron-packager')
+
+packager({
+  dir: '/path/to/my/app',
+  osxSign: {
+    identity: 'Developer ID Application: Felix Rieseberg (LT94ZKYDCJ)',
+    'hardened-runtime': true,
+    entitlements: 'entitlements.plist',
+    'entitlements-inherit': 'entitlements.plist',
+    'signature-flags': 'library'
+  },
+  osxNotarize: {
+    appleId: 'felix@felix.fun',
+    appleIdPassword: 'my-apple-id-password'
+  }
+})
+```
+
+The `plist` file referenced here needs the following macOS-specific entitlements
+to assure the Apple security mechanisms that your app is doing these things
+without meaning any harm:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>com.apple.security.cs.allow-jit</key>
+    <true/>
+    <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
+    <true/>
+    <key>com.apple.security.cs.debugger</key>
+    <true/>
+  </dict>
+</plist>
+```
 
 ## Mac App Store
 
@@ -62,19 +182,24 @@ See the [Mac App Store Guide].
 Before signing Windows builds, you must do the following:
 
 1. Get a Windows Authenticode code signing certificate (requires an annual fee)
-2. Install Visual Studio 2015/2017 (to get the signing utility)
+2. Install Visual Studio to get the signing utility (the free [Community
+   Edition](https://visualstudio.microsoft.com/vs/community/) is enough)
 
-You can get a code signing certificate from a lot of resellers. Prices vary, so it may be worth your time to shop around. Popular resellers include:
+You can get a code signing certificate from a lot of resellers. Prices vary, so
+it may be worth your time to shop around. Popular resellers include:
 
 * [digicert](https://www.digicert.com/code-signing/microsoft-authenticode.htm)
 * [Comodo](https://www.comodo.com/landing/ssl-certificate/authenticode-signature/)
 * [GoDaddy](https://au.godaddy.com/web-security/code-signing-certificate)
-* Amongst others, please shop around to find one that suits your needs, Google is your friend :)
+* Amongst others, please shop around to find one that suits your needs, Google
+  is your friend 😄
 
 There are a number of tools for signing your packaged app:
 
-- [`electron-winstaller`] will generate an installer for windows and sign it for you
-- [`electron-forge`] can sign installers it generates through the Squirrel.Windows or MSI targets.
+- [`electron-winstaller`] will generate an installer for windows and sign it for
+  you
+- [`electron-forge`] can sign installers it generates through the
+  Squirrel.Windows or MSI targets.
 - [`electron-builder`] can sign some of its windows targets
 
 ## Windows Store

docs/tutorial/context-isolation.md

@@ -0,0 +1,70 @@
+# Context Isolation
+
+## What is it?
+
+Context Isolation is a feature that ensures that both your `preload` scripts and Electron's internal logic run in a separate context to the website you load in a [`webContents`](../api/web-contents.md).  This is important for security purposes as it helps prevent the website from accessing Electron internals or the powerful APIs your preload script has access to.
+
+This means that the `window` object that your preload script has access to is actually a **different** object than the website would have access to.  For example, if you set `window.hello = 'wave'` in your preload script and context isolation is enabled `window.hello` will be undefined if the website tries to access it.
+
+Every single application should have context isolation enabled and from Electron 12 it will be enabled by default.
+
+## How do I enable it?
+
+From Electron 12, it will be enabled by default. For lower versions it is an option in the `webPreferences` option when constructing `new BrowserWindow`'s.
+
+```javascript
+const mainWindow = new BrowserWindow({
+  webPreferences: {
+    contextIsolation: true
+  }
+})
+```
+
+## Migration
+
+> I used to provide APIs from my preload script using `window.X = apiObject` now what?
+
+Exposing APIs from your preload script to the loaded website is a common usecase and there is a dedicated module in Electron to help you do this in a painless way.
+
+**Before: With context isolation disabled**
+
+```javascript
+window.myAPI = {
+  doAThing: () => {}
+}
+```
+
+**After: With context isolation enabled**
+
+```javascript
+const { contextBridge } = require('electron')
+
+contextBridge.exposeInMainWorld('myAPI', {
+  doAThing: () => {}
+})
+```
+
+The [`contextBridge`](../api/context-bridge.md) module can be used to **safely** expose APIs from the isolated context your preload script runs in to the context the website is running in. The API will also be accessible from the website on `window.myAPI` just like it was before.
+
+You should read the `contextBridge` documentation linked above to fully understand its limitations.  For instance you can't send custom prototypes or symbols over the bridge.
+
+## Security Considerations
+
+Just enabling `contextIsolation` and using `contextBridge` does not automatically mean that everything you do is safe.  For instance this code is **unsafe**.
+
+```javascript
+// ❌ Bad code
+contextBridge.exposeInMainWorld('myAPI', {
+  send: ipcRenderer.send
+})
+```
+
+It directly exposes a powerful API without any kind of argument filtering. This would allow any website to send arbitrary IPC messages which you do not want to be possible. The correct way to expose IPC-based APIs would instead be to provide one method per IPC message.
+
+```javascript
+// ✅ Good code
+contextBridge.exposeInMainWorld('myAPI', {
+  loadPreferences: () => ipcRenderer.invoke('load-prefs')
+})
+```
+

docs/tutorial/devtools-extension.md

@@ -64,7 +64,7 @@ Following Devtools Extensions are tested and guaranteed to work in Electron:
 * [jQuery Debugger](https://chrome.google.com/webstore/detail/jquery-debugger/dbhhnnnpaeobfddmlalhnehgclcmjimi)
 * [AngularJS Batarang](https://chrome.google.com/webstore/detail/angularjs-batarang/ighdmehidhipcmcojjgiloacoafjmpfk)
 * [Vue.js devtools](https://chrome.google.com/webstore/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
-* [Cerebral Debugger](https://cerebraljs.com/docs/introduction/debugger.html)
+* [Cerebral Debugger](https://cerebraljs.com/docs/introduction/devtools.html)
 * [Redux DevTools Extension](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd)
 * [MobX Developer Tools](https://chrome.google.com/webstore/detail/mobx-developer-tools/pfgnfdagidkfgccljigdamigbcnndkod)
 

docs/tutorial/electron-timelines.md

@@ -4,15 +4,17 @@
 * We strive for weekly beta releases, however we often release more betas than scheduled.
 * All dates are our goals but there may be reasons for adjusting the stable deadline, such as security bugs.
 * Take a look at the [5.0.0 Timeline blog post](https://electronjs.org/blog/electron-5-0-timeline) for info about publicizing our release dates.
+* Since Electron 6.0, we've been targetting every other Chromium version and releasing our stable on the same day as Chrome stable. You can reference Chromium's release schedule [here](https://chromiumdash.appspot.com/schedule). See [Electron's new release cadence blog post](https://www.electronjs.org/blog/12-week-cadence) for more details on our release schedule.
 
 | Version | -beta.1 | Stable | Chrome | Node |
 | ------- | ------- | ------ | ------ | ---- |
-| 2.0.0 | 2018-02-21 | 2018-05-01 | M61 | v8 |
-| 3.0.0 | 2018-06-21 | 2018-09-18 | M66 | v10 |
-| 4.0.0 | 2018-10-11 | 2018-12-20 | M69 | v10 |
-| 5.0.0 | 2019-01-22 | 2019-04-24 | M73 | v12 |
-| 6.0.0 | 2019-05-01 | 2019-07-30 | M76 | v12 |
-| 7.0.0 | 2019-08-01 | 2019-10-22 | M78 | v12 |
-| 8.0.0 | 2019-10-24 | 2020-02-04 | M80 | v12 |
-| 9.0.0 | 2020-02-06 | 2020-05-19 | M83 | v12 |
-| 10.0.0 | TBD | TBD | TBD | TBD |
+| 2.0.0 | 2018-02-21 | 2018-05-01 | M61 | v8.9 |
+| 3.0.0 | 2018-06-21 | 2018-09-18 | M66 | v10.2 |
+| 4.0.0 | 2018-10-11 | 2018-12-20 | M69 | v10.11 |
+| 5.0.0 | 2019-01-22 | 2019-04-24 | M73 | v12.0 |
+| 6.0.0 | 2019-05-01 | 2019-07-30 | M76 | v12.4 |
+| 7.0.0 | 2019-08-01 | 2019-10-22 | M78 | v12.8 |
+| 8.0.0 | 2019-10-24 | 2020-02-04 | M80 | v12.13 |
+| 9.0.0 | 2020-02-06 | 2020-05-19 | M83 | v12.14 |
+| 10.0.0 | 2020-05-21 | 2020-08-25 | M85 | v12.x |
+| 11.0.0 | TBD | TBD | TBD| TBD |

docs/tutorial/electron-versioning.md

@@ -57,7 +57,7 @@ Stabilization branches are branches that run parallel to master, taking in only
 
 ![](../images/versioning-sketch-1.png)
 
-Stabilization branches are always either **major** or **minor** version lines, and named against the following template `$MAJOR-$MINOR-x` e.g. `2-0-x`.
+Since Electron 8, stabilization branches are always **major** version lines, and named against the following template `$MAJOR-x-y` e.g. `8-x-y`.  Prior to that we used **minor** version lines and named them as `$MAJOR-$MINOR-x` e.g. `2-0-x`
 
 We allow for multiple stabilization branches to exist simultaneously, and intend to support at least two in parallel at all times, backporting security fixes as necessary.
 ![](../images/versioning-sketch-2.png)
@@ -87,7 +87,7 @@ e.g. `2.0.1`.
 
 Specifically, the above means:
 
-1. Admitting non-breaking-API changes before Week 3 in the beta cycle is okay, even if those changes have the potential to cause moderate side-affects
+1. Admitting non-breaking-API changes before Week 3 in the beta cycle is okay, even if those changes have the potential to cause moderate side-effects
 2. Admitting feature-flagged changes, that do not otherwise alter existing code paths, at most points in the beta cycle is okay. Users can explicitly enable those flags in their apps.
 3. Admitting features of any sort after Week 3 in the beta cycle is 👎 without a very good reason.
 
@@ -139,7 +139,7 @@ We seek to increase clarity at all levels of the update and releases process. St
 * Commits that would result in a semver **minor** bump must start with `feat:`.
 * Commits that would result in a semver **patch** bump must start with `fix:`.
 
-* We allow squashing of commits, provided that the squashed message adheres the the above message format.
+* We allow squashing of commits, provided that the squashed message adheres to the above message format.
 * It is acceptable for some commits in a pull request to not include a semantic prefix, as long as the pull request title contains a meaningful encompassing semantic message.
 
 # Versioned `master`

docs/tutorial/first-app.md

@@ -44,23 +44,10 @@ run the main process. An example of your `package.json` might look like this:
 ```
 
 __Note__: If the `main` field is not present in `package.json`, Electron will
-attempt to load an `index.js` (as Node.js does). If this was actually
-a simple Node application, you would add a `start` script that instructs `node`
-to execute the current package:
+attempt to load an `index.js` (as Node.js does).
 
-```json
-{
-  "name": "your-app",
-  "version": "0.1.0",
-  "main": "main.js",
-  "scripts": {
-    "start": "node ."
-  }
-}
-```
-
-Turning this Node application into an Electron application is quite simple - we
-merely replace the `node` runtime with the `electron` runtime.
+By default, `npm start` would run the main script with Node.js. in order to make
+it run with Electron, you can add a `start` script:
 
 ```json
 {
@@ -109,7 +96,7 @@ const { app, BrowserWindow } = require('electron')
 
 function createWindow () {
   // Create the browser window.
-  let win = new BrowserWindow({
+  const win = new BrowserWindow({
     width: 800,
     height: 600,
     webPreferences: {
@@ -154,10 +141,10 @@ function createWindow () {
 // Some APIs can only be used after this event occurs.
 app.whenReady().then(createWindow)
 
-// Quit when all windows are closed.
+// Quit when all windows are closed, except on macOS. There, it's common
+// for applications and their menu bar to stay active until the user quits
+// explicitly with Cmd + Q.
 app.on('window-all-closed', () => {
-  // On macOS it is common for applications and their menu bar
-  // to stay active until the user quits explicitly with Cmd + Q
   if (process.platform !== 'darwin') {
     app.quit()
   }

docs/tutorial/in-app-purchases.md

@@ -37,18 +37,18 @@ inAppPurchase.on('transactions-updated', (event, transactions) => {
 
   // Check each transaction.
   transactions.forEach(function (transaction) {
-    let payment = transaction.payment
+    const payment = transaction.payment
 
     switch (transaction.transactionState) {
       case 'purchasing':
         console.log(`Purchasing ${payment.productIdentifier}...`)
         break
-      case 'purchased':
 
+      case 'purchased': {
         console.log(`${payment.productIdentifier} purchased.`)
 
         // Get the receipt url.
-        let receiptURL = inAppPurchase.getReceiptURL()
+        const receiptURL = inAppPurchase.getReceiptURL()
 
         console.log(`Receipt URL: ${receiptURL}`)
 
@@ -62,6 +62,8 @@ inAppPurchase.on('transactions-updated', (event, transactions) => {
         inAppPurchase.finishTransactionByDate(transaction.transactionDate)
 
         break
+      }
+
       case 'failed':
 
         console.log(`Failed to purchase ${payment.productIdentifier}.`)
@@ -105,8 +107,8 @@ inAppPurchase.getProducts(PRODUCT_IDS).then(products => {
   })
 
   // Ask the user which product he/she wants to purchase.
-  let selectedProduct = products[0]
-  let selectedQuantity = 1
+  const selectedProduct = products[0]
+  const selectedQuantity = 1
 
   // Purchase the selected product.
   inAppPurchase.purchaseProduct(selectedProduct.productIdentifier, selectedQuantity).then(isProductValid => {

docs/tutorial/multithreading.md

@@ -10,7 +10,7 @@ so the `nodeIntegrationInWorker` option should be set to `true` in
 `webPreferences`.
 
 ```javascript
-let win = new BrowserWindow({
+const win = new BrowserWindow({
   webPreferences: {
     nodeIntegrationInWorker: true
   }
@@ -44,7 +44,7 @@ loads no native modules after the Web Workers get started.
 process.dlopen = () => {
   throw new Error('Load native module is not safe')
 }
-let worker = new Worker('script.js')
+const worker = new Worker('script.js')
 ```
 
 [web-workers]: https://developer.mozilla.org/en/docs/Web/API/Web_Workers_API/Using_web_workers

docs/tutorial/notifications.md

@@ -10,7 +10,7 @@ you want to show Notifications in the main process please check out the
 [Notification](../api/notification.md) module.
 
 ```javascript
-let myNotification = new Notification('Title', {
+const myNotification = new Notification('Title', {
   body: 'Lorem Ipsum Dolor Sit Amet'
 })
 

docs/tutorial/performance.md

@@ -42,7 +42,7 @@ improve performance.
 
 To learn more about how to profile your app's code, familiarize yourself with
 the Chrome Developer Tools. For advanced analysis looking at multiple processes
-at once, consider the [Chrome Tracing] tool.
+at once, consider the [Chrome Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) tool.
 
 ### Recommended Reading
 
@@ -352,7 +352,7 @@ Many users of Electron start with an entirely web-based app that they're
 turning into a desktop application. As web developers, we are used to loading
 resources from a variety of content delivery networks. Now that you are
 shipping a proper desktop application, attempt to "cut the cord" where possible
- - and avoid letting your users wait for resources that never change and could
+and avoid letting your users wait for resources that never change and could
 easily be included  in your app.
 
 A typical example is Google Fonts. Many developers make use of Google's

docs/tutorial/security.md

@@ -239,51 +239,10 @@ to enable this behavior.
 Even when you use `nodeIntegration: false` to enforce strong isolation and
 prevent the use of Node primitives, `contextIsolation` must also be used.
 
-### Why?
+### Why & How?
 
-Context isolation allows each of the scripts running in the renderer to make
-changes to its JavaScript environment without worrying about conflicting with
-the scripts in the Electron API or the preload script.
-
-While still an experimental Electron feature, context isolation adds an
-additional layer of security. It creates a new JavaScript world for Electron
-APIs and preload scripts, which mitigates so-called "Prototype Pollution" attacks.
-
-At the same time, preload scripts still have access to the  `document` and
-`window` objects. In other words, you're getting a decent return on a likely
-very small investment.
-
-### How?
-
-```js
-// Main process
-const mainWindow = new BrowserWindow({
-  webPreferences: {
-    contextIsolation: true,
-    preload: path.join(app.getAppPath(), 'preload.js')
-  }
-})
-```
-
-```js
-// Preload script
-
-// Set a variable in the page before it loads
-webFrame.executeJavaScript('window.foo = "foo";')
-
-// The loaded page will not be able to access this, it is only available
-// in this context
-window.bar = 'bar'
-
-document.addEventListener('DOMContentLoaded', () => {
-  // Will log out 'undefined' since window.foo is only available in the main
-  // context
-  console.log(window.foo)
-
-  // Will log out 'bar' since window.bar is available in this context
-  console.log(window.bar)
-})
-```
+For more information on what `contextIsolation` is and how to enable it please
+see our dedicated [Context Isolation](context-isolation.md) document.
 
 
 ## 4) Handle Session Permission Requests From Remote Content

docs/tutorial/spellchecker.md

@@ -0,0 +1,74 @@
+# SpellChecker
+
+Electron has built-in support for Chromium's spellchecker since Electron 8.  On Windows and Linux this is powered by Hunspell dictionaries, and on macOS it makes use of the native spellchecker APIs.
+
+## How to enable the spellchecker?
+
+For Electron 9 and higher the spellchecker is enabled by default.  For Electron 8 you need to enable it in `webPreferences`.
+
+```js
+const myWindow = new BrowserWindow({
+  webPreferences: {
+    spellcheck: true
+  }
+})
+```
+
+## How to set the languages the spellchecker uses?
+
+On macOS as we use the native APIs there is no way to set the language that the spellchecker uses. By default on macOS the native spellchecker will automatically detect the language being used for you.
+
+For Windows and Linux there are a few Electron APIs you should use to set the languages for the spellchecker.
+
+```js
+// Sets the spellchecker to check English US and French
+myWindow.session.setSpellCheckerLanguages(['en-US', 'fr'])
+
+// An array of all available language codes
+const possibleLanguages = myWindow.session.availableSpellCheckerLanguages
+```
+
+By default the spellchecker will enable the language matching the current OS locale.
+
+## How do I put the results of the spellchecker in my context menu?
+
+All the required information to generate a context menu is provided in the [`context-menu`](../api/web-contents.md#event-context-menu) event on each `webContents` instance.  A small example
+of how to make a context menu with this information is provided below.
+
+```js
+const { Menu, MenuItem } = require('electron')
+
+myWindow.webContents.on('context-menu', (event, params) => {
+  const menu = new Menu()
+
+  // Add each spelling suggestion
+  for (const suggestion of params.dictionarySuggestions) {
+    menu.append(new MenuItem({
+      label: suggestion,
+      click: () => mainWindow.webContents.replaceMisspelling(suggestion)
+    }))
+  }
+
+  // Allow users to add the misspelled word to the dictionary
+  if (params.misspelledWord) {
+    menu.append(
+      new MenuItem({
+        label: 'Add to dictionary',
+        click: () => mainWindow.webContents.session.addWordToSpellCheckerDictionary(params.misspelledWord)
+      })
+    )
+  }
+
+  menu.popup()
+})
+```
+
+## Does the spellchecker use any Google services?
+
+Although the spellchecker itself does not send any typings, words or user input to Google services the hunspell dictionary files are downloaded from a Google CDN by default.  If you want to avoid this you can provide an alternative URL to download the dictionaries from.
+
+```js
+myWindow.session.setSpellCheckerDictionaryDownloadURL('https://example.com/dictionaries/')
+```
+
+Check out the docs for [`session.setSpellCheckerDictionaryDownloadURL`](https://www.electronjs.org/docs/api/session#sessetspellcheckerdictionarydownloadurlurl) for more information on where to get the dictionary files from and how you need to host them.

docs/tutorial/support.md

@@ -58,9 +58,9 @@ threshold, we will attempt to support backwards compatibility beyond two version
 until the maintainers feel the maintenance burden is too high to continue doing so.
 
 ### Currently supported versions
-- 8.1.x
-- 7.1.x
-- 6.1.x
+- 9.x.y
+- 8.x.y
+- 7.x.y
 
 ### End-of-life
 

docs/tutorial/updates.md

@@ -7,7 +7,7 @@ Electron's [autoUpdater](../api/auto-updater.md) module.
 
 ## Using `update.electronjs.org`
 
-GitHub's Electron team maintains [update.electronjs.org], a free and open-source
+The Electron team maintains [update.electronjs.org], a free and open-source
 webservice that Electron apps can use to self-update. The service is designed
 for Electron apps that meet the following criteria:
 
@@ -80,9 +80,9 @@ Next, construct the URL of the update server and tell
 
 ```javascript
 const server = 'https://your-deployment-url.com'
-const feed = `${server}/update/${process.platform}/${app.getVersion()}`
+const url = `${server}/update/${process.platform}/${app.getVersion()}`
 
-autoUpdater.setFeedURL(feed)
+autoUpdater.setFeedURL({ url })
 ```
 
 As the final step, check for updates. The example below will check every minute:
@@ -132,6 +132,10 @@ autoUpdater.on('error', message => {
 })
 ```
 
+## Handing Updates Manually
+
+Because the requests made by Auto Update aren't under your direct control, you may find situations that are difficult to handle (such as if the update server is behind authentication). The `url` field does support files, which means that with some effort, you can sidestep the server-communication aspect of the process. [Here's an example of how this could work](https://github.com/electron/electron/issues/5020#issuecomment-477636990).
+
 [now]: https://zeit.co/now
 [hazel]: https://github.com/zeit/hazel
 [nuts]: https://github.com/GitbookIO/nuts

docs/tutorial/using-pepper-flash-plugin.md

@@ -42,7 +42,7 @@ app.commandLine.appendSwitch('ppapi-flash-path', path.join(__dirname, pluginName
 app.commandLine.appendSwitch('ppapi-flash-version', '17.0.0.169')
 
 app.whenReady().then(() => {
-  let win = new BrowserWindow({
+  const win = new BrowserWindow({
     width: 800,
     height: 600,
     webPreferences: {

docs/tutorial/using-selenium-and-webdriver.md

@@ -146,7 +146,7 @@ const options = {
   }
 }
 
-let client = webdriverio.remote(options)
+const client = webdriverio.remote(options)
 
 client
   .init()

docs/tutorial/windows-taskbar.md

@@ -149,7 +149,7 @@ To set the overlay icon for a window, you can use the
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 win.setOverlayIcon('path/to/overlay.png', 'Description for overlay')
 ```
 
@@ -168,7 +168,7 @@ To flash the BrowserWindow taskbar button, you can use the
 
 ```javascript
 const { BrowserWindow } = require('electron')
-let win = new BrowserWindow()
+const win = new BrowserWindow()
 win.once('focus', () => win.flashFrame(false))
 win.flashFrame(true)
 ```

electron_paks.gni

@@ -54,8 +54,11 @@ template("electron_extra_paks") {
                            ])
     output = "${invoker.output_dir}/resources.pak"
     sources = [
+      "$root_gen_dir/chrome/dev_ui_browser_resources.pak",
       "$root_gen_dir/components/components_resources.pak",
+      "$root_gen_dir/content/browser/resources/media/media_internals_resources.pak",
       "$root_gen_dir/content/browser/tracing/tracing_resources.pak",
+      "$root_gen_dir/content/browser/webrtc/resources/webrtc_internals_resources.pak",
       "$root_gen_dir/content/content_resources.pak",
       "$root_gen_dir/content/dev_ui_content_resources.pak",
       "$root_gen_dir/mojo/public/js/mojo_bindings_resources.pak",
@@ -65,10 +68,13 @@ template("electron_extra_paks") {
       "$target_gen_dir/electron_resources.pak",
     ]
     deps = [
+      "//chrome/browser:dev_ui_browser_resources",
       "//components/resources",
       "//content:content_resources",
       "//content:dev_ui_content_resources",
+      "//content/browser/resources/media:media_internals_resources",
       "//content/browser/tracing:resources",
+      "//content/browser/webrtc/resources",
       "//electron:resources",
       "//mojo/public/js:resources",
       "//net:net_resources",

electron_strings.grdp

@@ -75,4 +75,9 @@
   <message name="IDS_ACCEPT_LANGUAGES" use_name_for_id="true">
     en-US,en
   </message>
+  <if expr="is_win">
+    <message name="IDS_UTILITY_PROCESS_UTILITY_WIN_NAME" desc="The name of the utility process used to handle Windows utility operations.">
+      Windows Utilities
+    </message>
+  </if>
 </grit-part>

filenames.auto.gni

@@ -43,7 +43,6 @@ auto_filenames = {
     "docs/api/power-monitor.md",
     "docs/api/power-save-blocker.md",
     "docs/api/process.md",
-    "docs/api/protocol-ns.md",
     "docs/api/protocol.md",
     "docs/api/remote.md",
     "docs/api/sandbox-option.md",
@@ -100,6 +99,7 @@ auto_filenames = {
     "docs/api/structures/mime-typed-buffer.md",
     "docs/api/structures/mouse-input-event.md",
     "docs/api/structures/mouse-wheel-input-event.md",
+    "docs/api/structures/new-window-web-contents-event.md",
     "docs/api/structures/notification-action.md",
     "docs/api/structures/point.md",
     "docs/api/structures/post-body.md",
@@ -134,30 +134,22 @@ auto_filenames = {
   ]
 
   sandbox_bundle_deps = [
-    "lib/browser/api/module-keys.js",
-    "lib/common/api/clipboard.js",
+    "lib/browser/api/module-names.ts",
+    "lib/common/api/clipboard.ts",
     "lib/common/api/deprecate.ts",
     "lib/common/api/module-list.ts",
-    "lib/common/api/native-image.js",
-    "lib/common/api/shell.js",
-    "lib/common/crash-reporter.js",
+    "lib/common/api/native-image.ts",
+    "lib/common/api/shell.ts",
     "lib/common/define-properties.ts",
-    "lib/common/electron-binding-setup.ts",
     "lib/common/type-utils.ts",
     "lib/common/web-view-methods.ts",
     "lib/common/webpack-globals-provider.ts",
     "lib/renderer/api/context-bridge.ts",
-    "lib/renderer/api/crash-reporter.js",
+    "lib/renderer/api/crash-reporter.ts",
     "lib/renderer/api/desktop-capturer.ts",
     "lib/renderer/api/ipc-renderer.ts",
-    "lib/renderer/api/remote.js",
+    "lib/renderer/api/remote.ts",
     "lib/renderer/api/web-frame.ts",
-    "lib/renderer/chrome-api.ts",
-    "lib/renderer/content-scripts-injector.ts",
-    "lib/renderer/extensions/event.ts",
-    "lib/renderer/extensions/i18n.ts",
-    "lib/renderer/extensions/storage.ts",
-    "lib/renderer/extensions/web-navigation.ts",
     "lib/renderer/inspector.ts",
     "lib/renderer/ipc-renderer-internal-utils.ts",
     "lib/renderer/ipc-renderer-internal.ts",
@@ -173,83 +165,65 @@ auto_filenames = {
     "lib/renderer/window-setup.ts",
     "lib/sandboxed_renderer/api/exports/electron.ts",
     "lib/sandboxed_renderer/api/module-list.ts",
-    "lib/sandboxed_renderer/init.js",
+    "lib/sandboxed_renderer/init.ts",
     "package.json",
     "tsconfig.electron.json",
     "tsconfig.json",
+    "typings/internal-ambient.d.ts",
+    "typings/internal-electron.d.ts",
   ]
 
   isolated_bundle_deps = [
-    "lib/common/electron-binding-setup.ts",
-    "lib/isolated_renderer/init.js",
-    "lib/renderer/ipc-renderer-internal-utils.ts",
-    "lib/renderer/ipc-renderer-internal.ts",
+    "lib/isolated_renderer/init.ts",
     "lib/renderer/web-view/web-view-constants.ts",
     "lib/renderer/web-view/web-view-element.ts",
-    "lib/renderer/window-setup.ts",
-    "package.json",
-    "tsconfig.electron.json",
-    "tsconfig.json",
-  ]
-
-  content_script_bundle_deps = [
-    "lib/common/electron-binding-setup.ts",
-    "lib/common/webpack-globals-provider.ts",
-    "lib/content_script/init.js",
-    "lib/renderer/chrome-api.ts",
-    "lib/renderer/extensions/event.ts",
-    "lib/renderer/extensions/i18n.ts",
-    "lib/renderer/extensions/storage.ts",
-    "lib/renderer/extensions/web-navigation.ts",
-    "lib/renderer/ipc-renderer-internal-utils.ts",
-    "lib/renderer/ipc-renderer-internal.ts",
-    "lib/renderer/window-setup.ts",
     "package.json",
     "tsconfig.electron.json",
     "tsconfig.json",
+    "typings/internal-ambient.d.ts",
+    "typings/internal-electron.d.ts",
   ]
 
   browser_bundle_deps = [
     "lib/browser/api/app.ts",
-    "lib/browser/api/auto-updater.js",
-    "lib/browser/api/auto-updater/auto-updater-native.js",
-    "lib/browser/api/auto-updater/auto-updater-win.js",
-    "lib/browser/api/auto-updater/squirrel-update-win.js",
-    "lib/browser/api/browser-view.js",
-    "lib/browser/api/browser-window.js",
-    "lib/browser/api/content-tracing.js",
-    "lib/browser/api/crash-reporter.js",
-    "lib/browser/api/dialog.js",
+    "lib/browser/api/auto-updater.ts",
+    "lib/browser/api/auto-updater/auto-updater-native.ts",
+    "lib/browser/api/auto-updater/auto-updater-win.ts",
+    "lib/browser/api/auto-updater/squirrel-update-win.ts",
+    "lib/browser/api/base-window.ts",
+    "lib/browser/api/browser-view.ts",
+    "lib/browser/api/browser-window.ts",
+    "lib/browser/api/content-tracing.ts",
+    "lib/browser/api/crash-reporter.ts",
+    "lib/browser/api/desktop-capturer.ts",
+    "lib/browser/api/dialog.ts",
     "lib/browser/api/exports/electron.ts",
-    "lib/browser/api/global-shortcut.js",
-    "lib/browser/api/in-app-purchase.js",
+    "lib/browser/api/global-shortcut.ts",
+    "lib/browser/api/in-app-purchase.ts",
     "lib/browser/api/ipc-main.ts",
-    "lib/browser/api/menu-item-roles.js",
-    "lib/browser/api/menu-item.js",
-    "lib/browser/api/menu-utils.js",
-    "lib/browser/api/menu.js",
+    "lib/browser/api/menu-item-roles.ts",
+    "lib/browser/api/menu-item.ts",
+    "lib/browser/api/menu-utils.ts",
+    "lib/browser/api/menu.ts",
     "lib/browser/api/message-channel.ts",
     "lib/browser/api/module-list.ts",
     "lib/browser/api/native-theme.ts",
-    "lib/browser/api/net-log.js",
-    "lib/browser/api/net.js",
-    "lib/browser/api/notification.js",
+    "lib/browser/api/net-log.ts",
+    "lib/browser/api/net.ts",
+    "lib/browser/api/notification.ts",
     "lib/browser/api/power-monitor.ts",
-    "lib/browser/api/power-save-blocker.js",
+    "lib/browser/api/power-save-blocker.ts",
     "lib/browser/api/protocol.ts",
     "lib/browser/api/screen.ts",
-    "lib/browser/api/session.js",
+    "lib/browser/api/session.ts",
     "lib/browser/api/system-preferences.ts",
-    "lib/browser/api/top-level-window.js",
-    "lib/browser/api/touch-bar.js",
-    "lib/browser/api/tray.js",
-    "lib/browser/api/view.js",
-    "lib/browser/api/views/image-view.js",
-    "lib/browser/api/web-contents-view.js",
-    "lib/browser/api/web-contents.js",
-    "lib/browser/chrome-extension-shim.js",
-    "lib/browser/chrome-extension.js",
-    "lib/browser/crash-reporter-init.js",
+    "lib/browser/api/touch-bar.ts",
+    "lib/browser/api/tray.ts",
+    "lib/browser/api/view.ts",
+    "lib/browser/api/views/image-view.ts",
+    "lib/browser/api/web-contents-view.ts",
+    "lib/browser/api/web-contents.ts",
+    "lib/browser/chrome-extension-shim.ts",
     "lib/browser/default-menu.ts",
     "lib/browser/desktop-capturer.ts",
     "lib/browser/devtools.ts",
@@ -260,21 +234,19 @@ auto_filenames = {
     "lib/browser/ipc-main-internal-utils.ts",
     "lib/browser/ipc-main-internal.ts",
     "lib/browser/message-port-main.ts",
-    "lib/browser/navigation-controller.js",
+    "lib/browser/navigation-controller.ts",
     "lib/browser/remote/objects-registry.ts",
     "lib/browser/remote/server.ts",
-    "lib/browser/rpc-server.js",
+    "lib/browser/rpc-server.ts",
     "lib/browser/utils.ts",
-    "lib/common/api/clipboard.js",
+    "lib/common/api/clipboard.ts",
     "lib/common/api/deprecate.ts",
     "lib/common/api/module-list.ts",
-    "lib/common/api/native-image.js",
-    "lib/common/api/shell.js",
-    "lib/common/crash-reporter.js",
+    "lib/common/api/native-image.ts",
+    "lib/common/api/shell.ts",
     "lib/common/define-properties.ts",
-    "lib/common/electron-binding-setup.ts",
     "lib/common/init.ts",
-    "lib/common/parse-features-string.js",
+    "lib/common/parse-features-string.ts",
     "lib/common/reset-search-paths.ts",
     "lib/common/type-utils.ts",
     "lib/common/web-view-methods.ts",
@@ -284,37 +256,32 @@ auto_filenames = {
     "package.json",
     "tsconfig.electron.json",
     "tsconfig.json",
+    "typings/internal-ambient.d.ts",
+    "typings/internal-electron.d.ts",
   ]
 
   renderer_bundle_deps = [
-    "lib/browser/api/module-keys.js",
-    "lib/common/api/clipboard.js",
+    "lib/browser/api/module-names.ts",
+    "lib/common/api/clipboard.ts",
     "lib/common/api/deprecate.ts",
     "lib/common/api/module-list.ts",
-    "lib/common/api/native-image.js",
-    "lib/common/api/shell.js",
-    "lib/common/crash-reporter.js",
+    "lib/common/api/native-image.ts",
+    "lib/common/api/shell.ts",
     "lib/common/define-properties.ts",
-    "lib/common/electron-binding-setup.ts",
     "lib/common/init.ts",
     "lib/common/reset-search-paths.ts",
     "lib/common/type-utils.ts",
     "lib/common/web-view-methods.ts",
     "lib/common/webpack-globals-provider.ts",
+    "lib/common/webpack-provider.ts",
     "lib/renderer/api/context-bridge.ts",
-    "lib/renderer/api/crash-reporter.js",
+    "lib/renderer/api/crash-reporter.ts",
     "lib/renderer/api/desktop-capturer.ts",
     "lib/renderer/api/exports/electron.ts",
     "lib/renderer/api/ipc-renderer.ts",
     "lib/renderer/api/module-list.ts",
-    "lib/renderer/api/remote.js",
+    "lib/renderer/api/remote.ts",
     "lib/renderer/api/web-frame.ts",
-    "lib/renderer/chrome-api.ts",
-    "lib/renderer/content-scripts-injector.ts",
-    "lib/renderer/extensions/event.ts",
-    "lib/renderer/extensions/i18n.ts",
-    "lib/renderer/extensions/storage.ts",
-    "lib/renderer/extensions/web-navigation.ts",
     "lib/renderer/init.ts",
     "lib/renderer/inspector.ts",
     "lib/renderer/ipc-renderer-internal-utils.ts",
@@ -328,42 +295,54 @@ auto_filenames = {
     "lib/renderer/web-view/web-view-element.ts",
     "lib/renderer/web-view/web-view-impl.ts",
     "lib/renderer/web-view/web-view-init.ts",
-    "lib/renderer/webpack-provider.ts",
     "lib/renderer/window-setup.ts",
     "package.json",
     "tsconfig.electron.json",
     "tsconfig.json",
+    "typings/internal-ambient.d.ts",
+    "typings/internal-electron.d.ts",
   ]
 
   worker_bundle_deps = [
-    "lib/browser/api/module-keys.js",
-    "lib/common/api/clipboard.js",
+    "lib/browser/api/module-names.ts",
+    "lib/common/api/clipboard.ts",
     "lib/common/api/deprecate.ts",
     "lib/common/api/module-list.ts",
-    "lib/common/api/native-image.js",
-    "lib/common/api/shell.js",
-    "lib/common/crash-reporter.js",
+    "lib/common/api/native-image.ts",
+    "lib/common/api/shell.ts",
     "lib/common/define-properties.ts",
-    "lib/common/electron-binding-setup.ts",
     "lib/common/init.ts",
     "lib/common/reset-search-paths.ts",
     "lib/common/type-utils.ts",
     "lib/common/webpack-globals-provider.ts",
+    "lib/common/webpack-provider.ts",
     "lib/renderer/api/context-bridge.ts",
-    "lib/renderer/api/crash-reporter.js",
+    "lib/renderer/api/crash-reporter.ts",
     "lib/renderer/api/desktop-capturer.ts",
     "lib/renderer/api/exports/electron.ts",
     "lib/renderer/api/ipc-renderer.ts",
     "lib/renderer/api/module-list.ts",
-    "lib/renderer/api/remote.js",
+    "lib/renderer/api/remote.ts",
     "lib/renderer/api/web-frame.ts",
     "lib/renderer/ipc-renderer-internal-utils.ts",
     "lib/renderer/ipc-renderer-internal.ts",
     "lib/renderer/remote/callbacks-registry.ts",
-    "lib/renderer/webpack-provider.ts",
-    "lib/worker/init.js",
+    "lib/worker/init.ts",
     "package.json",
     "tsconfig.electron.json",
     "tsconfig.json",
+    "typings/internal-ambient.d.ts",
+    "typings/internal-electron.d.ts",
+  ]
+
+  asar_bundle_deps = [
+    "lib/asar/fs-wrapper.ts",
+    "lib/asar/init.ts",
+    "lib/common/webpack-provider.ts",
+    "package.json",
+    "tsconfig.electron.json",
+    "tsconfig.json",
+    "typings/internal-ambient.d.ts",
+    "typings/internal-electron.d.ts",
   ]
 }

filenames.gni

@@ -14,11 +14,11 @@ filenames = {
 
   default_app_octicon_sources = [
     "node_modules/@primer/octicons/build/build.css",
-    "node_modules/@primer/octicons/build/svg/gear.svg",
-    "node_modules/@primer/octicons/build/svg/gift.svg",
-    "node_modules/@primer/octicons/build/svg/gist.svg",
-    "node_modules/@primer/octicons/build/svg/mark-github.svg",
-    "node_modules/@primer/octicons/build/svg/star.svg",
+    "node_modules/@primer/octicons/build/svg/book-24.svg",
+    "node_modules/@primer/octicons/build/svg/code-square-24.svg",
+    "node_modules/@primer/octicons/build/svg/gift-24.svg",
+    "node_modules/@primer/octicons/build/svg/mark-github-16.svg",
+    "node_modules/@primer/octicons/build/svg/star-fill-24.svg",
   ]
 
   lib_sources = [
@@ -31,6 +31,8 @@ filenames = {
     "shell/app/command_line_args.h",
     "shell/app/electron_content_client.cc",
     "shell/app/electron_content_client.h",
+    "shell/app/electron_crash_reporter_client.cc",
+    "shell/app/electron_crash_reporter_client.h",
     "shell/app/electron_main_delegate.cc",
     "shell/app/electron_main_delegate.h",
     "shell/app/electron_main_delegate_mac.h",
@@ -42,6 +44,8 @@ filenames = {
     "shell/browser/api/electron_api_app_mac.mm",
     "shell/browser/api/electron_api_auto_updater.cc",
     "shell/browser/api/electron_api_auto_updater.h",
+    "shell/browser/api/electron_api_base_window.cc",
+    "shell/browser/api/electron_api_base_window.h",
     "shell/browser/api/electron_api_browser_view.cc",
     "shell/browser/api/electron_api_browser_view.h",
     "shell/browser/api/electron_api_browser_window.cc",
@@ -51,6 +55,8 @@ filenames = {
     "shell/browser/api/electron_api_content_tracing.cc",
     "shell/browser/api/electron_api_cookies.cc",
     "shell/browser/api/electron_api_cookies.h",
+    "shell/browser/api/electron_api_crash_reporter.cc",
+    "shell/browser/api/electron_api_crash_reporter.h",
     "shell/browser/api/electron_api_data_pipe_holder.cc",
     "shell/browser/api/electron_api_data_pipe_holder.h",
     "shell/browser/api/electron_api_debugger.cc",
@@ -75,7 +81,6 @@ filenames = {
     "shell/browser/api/electron_api_native_theme.h",
     "shell/browser/api/electron_api_native_theme_mac.mm",
     "shell/browser/api/electron_api_net.cc",
-    "shell/browser/api/electron_api_net.h",
     "shell/browser/api/electron_api_net_log.cc",
     "shell/browser/api/electron_api_net_log.h",
     "shell/browser/api/electron_api_notification.cc",
@@ -98,8 +103,6 @@ filenames = {
     "shell/browser/api/electron_api_system_preferences.h",
     "shell/browser/api/electron_api_system_preferences_mac.mm",
     "shell/browser/api/electron_api_system_preferences_win.cc",
-    "shell/browser/api/electron_api_top_level_window.cc",
-    "shell/browser/api/electron_api_top_level_window.h",
     "shell/browser/api/electron_api_tray.cc",
     "shell/browser/api/electron_api_tray.h",
     "shell/browser/api/electron_api_url_loader.cc",
@@ -170,7 +173,6 @@ filenames = {
     "shell/browser/electron_javascript_dialog_manager.h",
     "shell/browser/electron_navigation_throttle.cc",
     "shell/browser/electron_navigation_throttle.h",
-    "shell/browser/electron_paths.h",
     "shell/browser/electron_permission_manager.cc",
     "shell/browser/electron_permission_manager.h",
     "shell/browser/electron_quota_permission_context.cc",
@@ -354,8 +356,6 @@ filenames = {
     "shell/browser/ui/inspectable_web_contents.cc",
     "shell/browser/ui/inspectable_web_contents.h",
     "shell/browser/ui/inspectable_web_contents_delegate.h",
-    "shell/browser/ui/inspectable_web_contents_impl.cc",
-    "shell/browser/ui/inspectable_web_contents_impl.h",
     "shell/browser/ui/inspectable_web_contents_view.h",
     "shell/browser/ui/inspectable_web_contents_view_delegate.cc",
     "shell/browser/ui/inspectable_web_contents_view_delegate.h",
@@ -398,6 +398,10 @@ filenames = {
     "shell/browser/ui/views/submenu_button.h",
     "shell/browser/ui/views/win_frame_view.cc",
     "shell/browser/ui/views/win_frame_view.h",
+    "shell/browser/ui/webui/accessibility_ui.cc",
+    "shell/browser/ui/webui/accessibility_ui.h",
+    "shell/browser/ui/win/dialog_thread.cc",
+    "shell/browser/ui/win/dialog_thread.h",
     "shell/browser/ui/win/electron_desktop_native_widget_aura.cc",
     "shell/browser/ui/win/electron_desktop_native_widget_aura.h",
     "shell/browser/ui/win/electron_desktop_window_tree_host_win.cc",
@@ -442,7 +446,6 @@ filenames = {
     "shell/common/api/electron_api_clipboard.h",
     "shell/common/api/electron_api_clipboard_mac.mm",
     "shell/common/api/electron_api_command_line.cc",
-    "shell/common/api/electron_api_crash_reporter.cc",
     "shell/common/api/electron_api_key_weak_map.h",
     "shell/common/api/electron_api_native_image.cc",
     "shell/common/api/electron_api_native_image.h",
@@ -452,6 +455,8 @@ filenames = {
     "shell/common/api/electron_bindings.cc",
     "shell/common/api/electron_bindings.h",
     "shell/common/api/features.cc",
+    "shell/common/api/object_life_monitor.cc",
+    "shell/common/api/object_life_monitor.h",
     "shell/common/application_info.cc",
     "shell/common/application_info.h",
     "shell/common/application_info_linux.cc",
@@ -465,22 +470,13 @@ filenames = {
     "shell/common/asar/scoped_temporary_file.h",
     "shell/common/color_util.cc",
     "shell/common/color_util.h",
-    "shell/common/crash_reporter/crash_reporter.cc",
-    "shell/common/crash_reporter/crash_reporter.h",
-    "shell/common/crash_reporter/crash_reporter_linux.cc",
-    "shell/common/crash_reporter/crash_reporter_linux.h",
-    "shell/common/crash_reporter/crash_reporter_mac.h",
-    "shell/common/crash_reporter/crash_reporter_mac.mm",
-    "shell/common/crash_reporter/crash_reporter_win.cc",
-    "shell/common/crash_reporter/crash_reporter_win.h",
-    "shell/common/crash_reporter/linux/crash_dump_handler.cc",
-    "shell/common/crash_reporter/linux/crash_dump_handler.h",
-    "shell/common/crash_reporter/win/crash_service_main.cc",
-    "shell/common/crash_reporter/win/crash_service_main.h",
+    "shell/common/crash_keys.cc",
+    "shell/common/crash_keys.h",
     "shell/common/electron_command_line.cc",
     "shell/common/electron_command_line.h",
     "shell/common/electron_constants.cc",
     "shell/common/electron_constants.h",
+    "shell/common/electron_paths.h",
     "shell/common/gin_converters/accelerator_converter.cc",
     "shell/common/gin_converters/accelerator_converter.h",
     "shell/common/gin_converters/blink_converter.cc",
@@ -488,8 +484,6 @@ filenames = {
     "shell/common/gin_converters/callback_converter.h",
     "shell/common/gin_converters/content_converter.cc",
     "shell/common/gin_converters/content_converter.h",
-    "shell/common/gin_converters/extension_converter.cc",
-    "shell/common/gin_converters/extension_converter.h",
     "shell/common/gin_converters/file_dialog_converter.cc",
     "shell/common/gin_converters/file_dialog_converter.h",
     "shell/common/gin_converters/file_path_converter.h",
@@ -504,6 +498,8 @@ filenames = {
     "shell/common/gin_converters/net_converter.cc",
     "shell/common/gin_converters/net_converter.h",
     "shell/common/gin_converters/std_converter.h",
+    "shell/common/gin_converters/time_converter.cc",
+    "shell/common/gin_converters/time_converter.h",
     "shell/common/gin_converters/value_converter.cc",
     "shell/common/gin_converters/value_converter.h",
     "shell/common/gin_helper/arguments.cc",
@@ -528,6 +524,8 @@ filenames = {
     "shell/common/gin_helper/function_template_extensions.h",
     "shell/common/gin_helper/locker.cc",
     "shell/common/gin_helper/locker.h",
+    "shell/common/gin_helper/microtasks_scope.cc",
+    "shell/common/gin_helper/microtasks_scope.h",
     "shell/common/gin_helper/object_template_builder.cc",
     "shell/common/gin_helper/object_template_builder.h",
     "shell/common/gin_helper/persistent_dictionary.cc",
@@ -545,6 +543,10 @@ filenames = {
     "shell/common/key_weak_map.h",
     "shell/common/keyboard_util.cc",
     "shell/common/keyboard_util.h",
+    "shell/common/language_util.h",
+    "shell/common/language_util_linux.cc",
+    "shell/common/language_util_mac.mm",
+    "shell/common/language_util_win.cc",
     "shell/common/mac/main_application_bundle.h",
     "shell/common/mac/main_application_bundle.mm",
     "shell/common/mouse_util.cc",
@@ -577,11 +579,10 @@ filenames = {
     "shell/common/world_ids.h",
     "shell/renderer/api/context_bridge/object_cache.cc",
     "shell/renderer/api/context_bridge/object_cache.h",
-    "shell/renderer/api/context_bridge/render_frame_function_store.cc",
-    "shell/renderer/api/context_bridge/render_frame_function_store.h",
     "shell/renderer/api/electron_api_context_bridge.cc",
     "shell/renderer/api/electron_api_context_bridge.h",
-    "shell/renderer/api/electron_api_renderer_ipc.cc",
+    "shell/renderer/api/electron_api_crash_reporter_renderer.cc",
+    "shell/renderer/api/electron_api_ipc_renderer.cc",
     "shell/renderer/api/electron_api_spell_check_client.cc",
     "shell/renderer/api/electron_api_spell_check_client.h",
     "shell/renderer/api/electron_api_web_frame.cc",
@@ -651,6 +652,8 @@ filenames = {
     "shell/browser/extensions/electron_extensions_browser_api_provider.h",
     "shell/browser/extensions/electron_extensions_browser_client.cc",
     "shell/browser/extensions/electron_extensions_browser_client.h",
+    "shell/browser/extensions/electron_kiosk_delegate.cc",
+    "shell/browser/extensions/electron_kiosk_delegate.h",
     "shell/browser/extensions/electron_messaging_delegate.cc",
     "shell/browser/extensions/electron_messaging_delegate.h",
     "shell/browser/extensions/electron_navigation_ui_data.cc",
@@ -661,6 +664,8 @@ filenames = {
     "shell/common/extensions/electron_extensions_api_provider.h",
     "shell/common/extensions/electron_extensions_client.cc",
     "shell/common/extensions/electron_extensions_client.h",
+    "shell/common/gin_converters/extension_converter.cc",
+    "shell/common/gin_converters/extension_converter.h",
     "shell/renderer/extensions/electron_extensions_dispatcher_delegate.cc",
     "shell/renderer/extensions/electron_extensions_dispatcher_delegate.h",
     "shell/renderer/extensions/electron_extensions_renderer_client.cc",

filenames.hunspell.gni

@@ -10,6 +10,7 @@ hunspell_dictionaries = [
   "//third_party/hunspell_dictionaries/en-AU-9-0.bdic",
   "//third_party/hunspell_dictionaries/en-CA-9-0.bdic",
   "//third_party/hunspell_dictionaries/en-GB-9-0.bdic",
+  "//third_party/hunspell_dictionaries/en-GB-oxendict-9-0.bdic",
   "//third_party/hunspell_dictionaries/en-US-9-0.bdic",
   "//third_party/hunspell_dictionaries/es-ES-3-0.bdic",
   "//third_party/hunspell_dictionaries/et-EE-3-0.bdic",

lib/asar/fs-wrapper.ts

@@ -0,0 +1,804 @@
+import { Buffer } from 'buffer';
+import * as path from 'path';
+import * as util from 'util';
+
+const asar = process._linkedBinding('electron_common_asar');
+const v8Util = process._linkedBinding('electron_common_v8_util');
+
+const Module = require('module');
+
+const Promise: PromiseConstructor = global.Promise as any;
+
+const envNoAsar = process.env.ELECTRON_NO_ASAR &&
+    process.type !== 'browser' &&
+    process.type !== 'renderer';
+const isAsarDisabled = () => process.noAsar || envNoAsar;
+
+const internalBinding = (process as any).internalBinding;
+delete (process as any).internalBinding;
+
+const nextTick = (functionToCall: Function, args: any[] = []) => {
+  process.nextTick(() => functionToCall(...args));
+};
+
+// Cache asar archive objects.
+const cachedArchives = new Map<string, NodeJS.AsarArchive>();
+
+const getOrCreateArchive = (archivePath: string) => {
+  const isCached = cachedArchives.has(archivePath);
+  if (isCached) {
+    return cachedArchives.get(archivePath);
+  }
+
+  const newArchive = asar.createArchive(archivePath);
+  if (!newArchive) return null;
+
+  cachedArchives.set(archivePath, newArchive);
+  return newArchive;
+};
+
+// Separate asar package's path from full path.
+const splitPath = (archivePathOrBuffer: string | Buffer) => {
+  // Shortcut for disabled asar.
+  if (isAsarDisabled()) return { isAsar: <const>false };
+
+  // Check for a bad argument type.
+  let archivePath = archivePathOrBuffer;
+  if (Buffer.isBuffer(archivePathOrBuffer)) {
+    archivePath = archivePathOrBuffer.toString();
+  }
+  if (typeof archivePath !== 'string') return { isAsar: <const>false };
+
+  return asar.splitPath(path.normalize(archivePath));
+};
+
+// Convert asar archive's Stats object to fs's Stats object.
+let nextInode = 0;
+
+const uid = process.getuid != null ? process.getuid() : 0;
+const gid = process.getgid != null ? process.getgid() : 0;
+
+const fakeTime = new Date();
+
+const asarStatsToFsStats = function (stats: NodeJS.AsarFileStat) {
+  const { Stats, constants } = require('fs');
+
+  let mode = constants.S_IROTH ^ constants.S_IRGRP ^ constants.S_IRUSR ^ constants.S_IWUSR;
+
+  if (stats.isFile) {
+    mode ^= constants.S_IFREG;
+  } else if (stats.isDirectory) {
+    mode ^= constants.S_IFDIR;
+  } else if (stats.isLink) {
+    mode ^= constants.S_IFLNK;
+  }
+
+  return new Stats(
+    1, // dev
+    mode, // mode
+    1, // nlink
+    uid,
+    gid,
+    0, // rdev
+    undefined, // blksize
+    ++nextInode, // ino
+    stats.size,
+    undefined, // blocks,
+    fakeTime.getTime(), // atim_msec
+    fakeTime.getTime(), // mtim_msec
+    fakeTime.getTime(), // ctim_msec
+    fakeTime.getTime() // birthtim_msec
+  );
+};
+
+const enum AsarError {
+  NOT_FOUND = 'NOT_FOUND',
+  NOT_DIR = 'NOT_DIR',
+  NO_ACCESS = 'NO_ACCESS',
+  INVALID_ARCHIVE = 'INVALID_ARCHIVE'
+}
+
+type AsarErrorObject = Error & { code?: string, errno?: number };
+
+const createError = (errorType: AsarError, { asarPath, filePath }: { asarPath?: string, filePath?: string } = {}) => {
+  let error: AsarErrorObject;
+  switch (errorType) {
+    case AsarError.NOT_FOUND:
+      error = new Error(`ENOENT, ${filePath} not found in ${asarPath}`);
+      error.code = 'ENOENT';
+      error.errno = -2;
+      break;
+    case AsarError.NOT_DIR:
+      error = new Error('ENOTDIR, not a directory');
+      error.code = 'ENOTDIR';
+      error.errno = -20;
+      break;
+    case AsarError.NO_ACCESS:
+      error = new Error(`EACCES: permission denied, access '${filePath}'`);
+      error.code = 'EACCES';
+      error.errno = -13;
+      break;
+    case AsarError.INVALID_ARCHIVE:
+      error = new Error(`Invalid package ${asarPath}`);
+      break;
+    default:
+      throw new Error(`Invalid error type "${errorType}" passed to createError.`);
+  }
+  return error;
+};
+
+const overrideAPISync = function (module: Record<string, any>, name: string, pathArgumentIndex?: number | null, fromAsync: boolean = false) {
+  if (pathArgumentIndex == null) pathArgumentIndex = 0;
+  const old = module[name];
+  const func = function (this: any, ...args: any[]) {
+    const pathArgument = args[pathArgumentIndex!];
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return old.apply(this, args);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) throw createError(AsarError.INVALID_ARCHIVE, { asarPath });
+
+    const newPath = archive.copyFileOut(filePath);
+    if (!newPath) throw createError(AsarError.NOT_FOUND, { asarPath, filePath });
+
+    args[pathArgumentIndex!] = newPath;
+    return old.apply(this, args);
+  };
+  if (fromAsync) {
+    return func;
+  }
+  module[name] = func;
+};
+
+const overrideAPI = function (module: Record<string, any>, name: string, pathArgumentIndex?: number | null) {
+  if (pathArgumentIndex == null) pathArgumentIndex = 0;
+  const old = module[name];
+  module[name] = function (this: any, ...args: any[]) {
+    const pathArgument = args[pathArgumentIndex!];
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return old.apply(this, args);
+    const { asarPath, filePath } = pathInfo;
+
+    const callback = args[args.length - 1];
+    if (typeof callback !== 'function') {
+      return overrideAPISync(module, name, pathArgumentIndex!, true)!.apply(this, args);
+    }
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      const error = createError(AsarError.INVALID_ARCHIVE, { asarPath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    const newPath = archive.copyFileOut(filePath);
+    if (!newPath) {
+      const error = createError(AsarError.NOT_FOUND, { asarPath, filePath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    args[pathArgumentIndex!] = newPath;
+    return old.apply(this, args);
+  };
+
+  if (old[util.promisify.custom]) {
+    module[name][util.promisify.custom] = makePromiseFunction(old[util.promisify.custom], pathArgumentIndex);
+  }
+
+  if (module.promises && module.promises[name]) {
+    module.promises[name] = makePromiseFunction(module.promises[name], pathArgumentIndex);
+  }
+};
+
+const makePromiseFunction = function (orig: Function, pathArgumentIndex: number) {
+  return function (this: any, ...args: any[]) {
+    const pathArgument = args[pathArgumentIndex];
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return orig.apply(this, args);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      return Promise.reject(createError(AsarError.INVALID_ARCHIVE, { asarPath }));
+    }
+
+    const newPath = archive.copyFileOut(filePath);
+    if (!newPath) {
+      return Promise.reject(createError(AsarError.NOT_FOUND, { asarPath, filePath }));
+    }
+
+    args[pathArgumentIndex] = newPath;
+    return orig.apply(this, args);
+  };
+};
+
+// Override fs APIs.
+export const wrapFsWithAsar = (fs: Record<string, any>) => {
+  const logFDs: Record<string, number> = {};
+  const logASARAccess = (asarPath: string, filePath: string, offset: number) => {
+    if (!process.env.ELECTRON_LOG_ASAR_READS) return;
+    if (!logFDs[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');
+    }
+    fs.writeSync(logFDs[asarPath], `${offset}: ${filePath}\n`);
+  };
+
+  const { lstatSync } = fs;
+  fs.lstatSync = (pathArgument: string, options: any) => {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return lstatSync(pathArgument, options);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) throw createError(AsarError.INVALID_ARCHIVE, { asarPath });
+
+    const stats = archive.stat(filePath);
+    if (!stats) throw createError(AsarError.NOT_FOUND, { asarPath, filePath });
+
+    return asarStatsToFsStats(stats);
+  };
+
+  const { lstat } = fs;
+  fs.lstat = function (pathArgument: string, options: any, callback: any) {
+    const pathInfo = splitPath(pathArgument);
+    if (typeof options === 'function') {
+      callback = options;
+      options = {};
+    }
+    if (!pathInfo.isAsar) return lstat(pathArgument, options, callback);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      const error = createError(AsarError.INVALID_ARCHIVE, { asarPath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    const stats = archive.stat(filePath);
+    if (!stats) {
+      const error = createError(AsarError.NOT_FOUND, { asarPath, filePath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    const fsStats = asarStatsToFsStats(stats);
+    nextTick(callback, [null, fsStats]);
+  };
+
+  fs.promises.lstat = util.promisify(fs.lstat);
+
+  const { statSync } = fs;
+  fs.statSync = (pathArgument: string, options: any) => {
+    const { isAsar } = splitPath(pathArgument);
+    if (!isAsar) return statSync(pathArgument, options);
+
+    // Do not distinguish links for now.
+    return fs.lstatSync(pathArgument, options);
+  };
+
+  const { stat } = fs;
+  fs.stat = (pathArgument: string, options: any, callback: any) => {
+    const { isAsar } = splitPath(pathArgument);
+    if (typeof options === 'function') {
+      callback = options;
+      options = {};
+    }
+    if (!isAsar) return stat(pathArgument, options, callback);
+
+    // Do not distinguish links for now.
+    process.nextTick(() => fs.lstat(pathArgument, options, callback));
+  };
+
+  fs.promises.stat = util.promisify(fs.stat);
+
+  const wrapRealpathSync = function (realpathSync: Function) {
+    return function (this: any, pathArgument: string, options: any) {
+      const pathInfo = splitPath(pathArgument);
+      if (!pathInfo.isAsar) return realpathSync.apply(this, arguments);
+      const { asarPath, filePath } = pathInfo;
+
+      const archive = getOrCreateArchive(asarPath);
+      if (!archive) {
+        throw createError(AsarError.INVALID_ARCHIVE, { asarPath });
+      }
+
+      const fileRealPath = archive.realpath(filePath);
+      if (fileRealPath === false) {
+        throw createError(AsarError.NOT_FOUND, { asarPath, filePath });
+      }
+
+      return path.join(realpathSync(asarPath, options), fileRealPath);
+    };
+  };
+
+  const { realpathSync } = fs;
+  fs.realpathSync = wrapRealpathSync(realpathSync);
+  fs.realpathSync.native = wrapRealpathSync(realpathSync.native);
+
+  const wrapRealpath = function (realpath: Function) {
+    return function (this: any, pathArgument: string, options: any, callback: any) {
+      const pathInfo = splitPath(pathArgument);
+      if (!pathInfo.isAsar) return realpath.apply(this, arguments);
+      const { asarPath, filePath } = pathInfo;
+
+      if (arguments.length < 3) {
+        callback = options;
+        options = {};
+      }
+
+      const archive = getOrCreateArchive(asarPath);
+      if (!archive) {
+        const error = createError(AsarError.INVALID_ARCHIVE, { asarPath });
+        nextTick(callback, [error]);
+        return;
+      }
+
+      const fileRealPath = archive.realpath(filePath);
+      if (fileRealPath === false) {
+        const error = createError(AsarError.NOT_FOUND, { asarPath, filePath });
+        nextTick(callback, [error]);
+        return;
+      }
+
+      realpath(asarPath, options, (error: Error | null, archiveRealPath: string) => {
+        if (error === null) {
+          const fullPath = path.join(archiveRealPath, fileRealPath);
+          callback(null, fullPath);
+        } else {
+          callback(error);
+        }
+      });
+    };
+  };
+
+  const { realpath } = fs;
+  fs.realpath = wrapRealpath(realpath);
+  fs.realpath.native = wrapRealpath(realpath.native);
+
+  fs.promises.realpath = util.promisify(fs.realpath.native);
+
+  const { exists } = fs;
+  fs.exists = (pathArgument: string, callback: any) => {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return exists(pathArgument, callback);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      const error = createError(AsarError.INVALID_ARCHIVE, { asarPath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    const pathExists = (archive.stat(filePath) !== false);
+    nextTick(callback, [pathExists]);
+  };
+
+  fs.exists[util.promisify.custom] = (pathArgument: string) => {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return exists[util.promisify.custom](pathArgument);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      const error = createError(AsarError.INVALID_ARCHIVE, { asarPath });
+      return Promise.reject(error);
+    }
+
+    return Promise.resolve(archive.stat(filePath) !== false);
+  };
+
+  const { existsSync } = fs;
+  fs.existsSync = (pathArgument: string) => {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return existsSync(pathArgument);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) return false;
+
+    return archive.stat(filePath) !== false;
+  };
+
+  const { access } = fs;
+  fs.access = function (pathArgument: string, mode: any, callback: any) {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return access.apply(this, arguments);
+    const { asarPath, filePath } = pathInfo;
+
+    if (typeof mode === 'function') {
+      callback = mode;
+      mode = fs.constants.F_OK;
+    }
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      const error = createError(AsarError.INVALID_ARCHIVE, { asarPath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    const info = archive.getFileInfo(filePath);
+    if (!info) {
+      const error = createError(AsarError.NOT_FOUND, { asarPath, filePath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    if (info.unpacked) {
+      const realPath = archive.copyFileOut(filePath);
+      return fs.access(realPath, mode, callback);
+    }
+
+    const stats = archive.stat(filePath);
+    if (!stats) {
+      const error = createError(AsarError.NOT_FOUND, { asarPath, filePath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    if (mode & fs.constants.W_OK) {
+      const error = createError(AsarError.NO_ACCESS, { asarPath, filePath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    nextTick(callback);
+  };
+
+  fs.promises.access = util.promisify(fs.access);
+
+  const { accessSync } = fs;
+  fs.accessSync = function (pathArgument: string, mode: any) {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return accessSync.apply(this, arguments);
+    const { asarPath, filePath } = pathInfo;
+
+    if (mode == null) mode = fs.constants.F_OK;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      throw createError(AsarError.INVALID_ARCHIVE, { asarPath });
+    }
+
+    const info = archive.getFileInfo(filePath);
+    if (!info) {
+      throw createError(AsarError.NOT_FOUND, { asarPath, filePath });
+    }
+
+    if (info.unpacked) {
+      const realPath = archive.copyFileOut(filePath);
+      return fs.accessSync(realPath, mode);
+    }
+
+    const stats = archive.stat(filePath);
+    if (!stats) {
+      throw createError(AsarError.NOT_FOUND, { asarPath, filePath });
+    }
+
+    if (mode & fs.constants.W_OK) {
+      throw createError(AsarError.NO_ACCESS, { asarPath, filePath });
+    }
+  };
+
+  const { readFile } = fs;
+  fs.readFile = function (pathArgument: string, options: any, callback: any) {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return readFile.apply(this, arguments);
+    const { asarPath, filePath } = pathInfo;
+
+    if (typeof options === 'function') {
+      callback = options;
+      options = { encoding: null };
+    } else if (typeof options === 'string') {
+      options = { encoding: options };
+    } else if (options === null || options === undefined) {
+      options = { encoding: null };
+    } else if (typeof options !== 'object') {
+      throw new TypeError('Bad arguments');
+    }
+
+    const { encoding } = options;
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      const error = createError(AsarError.INVALID_ARCHIVE, { asarPath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    const info = archive.getFileInfo(filePath);
+    if (!info) {
+      const error = createError(AsarError.NOT_FOUND, { asarPath, filePath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    if (info.size === 0) {
+      nextTick(callback, [null, encoding ? '' : Buffer.alloc(0)]);
+      return;
+    }
+
+    if (info.unpacked) {
+      const realPath = archive.copyFileOut(filePath);
+      return fs.readFile(realPath, options, callback);
+    }
+
+    const buffer = Buffer.alloc(info.size);
+    const fd = archive.getFd();
+    if (!(fd >= 0)) {
+      const error = createError(AsarError.NOT_FOUND, { asarPath, filePath });
+      nextTick(callback, [error]);
+      return;
+    }
+
+    logASARAccess(asarPath, filePath, info.offset);
+    fs.read(fd, buffer, 0, info.size, info.offset, (error: Error) => {
+      callback(error, encoding ? buffer.toString(encoding) : buffer);
+    });
+  };
+
+  fs.promises.readFile = util.promisify(fs.readFile);
+
+  const { readFileSync } = fs;
+  fs.readFileSync = function (pathArgument: string, options: any) {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return readFileSync.apply(this, arguments);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) throw createError(AsarError.INVALID_ARCHIVE, { asarPath });
+
+    const info = archive.getFileInfo(filePath);
+    if (!info) throw createError(AsarError.NOT_FOUND, { asarPath, filePath });
+
+    if (info.size === 0) return (options) ? '' : Buffer.alloc(0);
+    if (info.unpacked) {
+      const realPath = archive.copyFileOut(filePath);
+      return fs.readFileSync(realPath, options);
+    }
+
+    if (!options) {
+      options = { encoding: null };
+    } else if (typeof options === 'string') {
+      options = { encoding: options };
+    } else if (typeof options !== 'object') {
+      throw new TypeError('Bad arguments');
+    }
+
+    const { encoding } = options;
+    const buffer = Buffer.alloc(info.size);
+    const fd = archive.getFd();
+    if (!(fd >= 0)) throw createError(AsarError.NOT_FOUND, { asarPath, filePath });
+
+    logASARAccess(asarPath, filePath, info.offset);
+    fs.readSync(fd, buffer, 0, info.size, info.offset);
+    return (encoding) ? buffer.toString(encoding) : buffer;
+  };
+
+  const { readdir } = fs;
+  fs.readdir = function (pathArgument: string, options: { encoding?: string | null; withFileTypes?: boolean } = {}, callback?: Function) {
+    const pathInfo = splitPath(pathArgument);
+    if (typeof options === 'function') {
+      callback = options;
+      options = {};
+    }
+    if (!pathInfo.isAsar) return readdir.apply(this, arguments);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      const error = createError(AsarError.INVALID_ARCHIVE, { asarPath });
+      nextTick(callback!, [error]);
+      return;
+    }
+
+    const files = archive.readdir(filePath);
+    if (!files) {
+      const error = createError(AsarError.NOT_FOUND, { asarPath, filePath });
+      nextTick(callback!, [error]);
+      return;
+    }
+
+    if (options.withFileTypes) {
+      const dirents = [];
+      for (const file of files) {
+        const stats = archive.stat(file);
+        if (!stats) {
+          const error = createError(AsarError.NOT_FOUND, { asarPath, filePath: file });
+          nextTick(callback!, [error]);
+          return;
+        }
+        if (stats.isFile) {
+          dirents.push(new fs.Dirent(file, fs.constants.UV_DIRENT_FILE));
+        } else if (stats.isDirectory) {
+          dirents.push(new fs.Dirent(file, fs.constants.UV_DIRENT_DIR));
+        } else if (stats.isLink) {
+          dirents.push(new fs.Dirent(file, fs.constants.UV_DIRENT_LINK));
+        }
+      }
+      nextTick(callback!, [null, dirents]);
+      return;
+    }
+
+    nextTick(callback!, [null, files]);
+  };
+
+  fs.promises.readdir = util.promisify(fs.readdir);
+
+  const { readdirSync } = fs;
+  fs.readdirSync = function (pathArgument: string, options: { encoding: BufferEncoding | null; withFileTypes?: false } | BufferEncoding | null) {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return readdirSync.apply(this, arguments);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) {
+      throw createError(AsarError.INVALID_ARCHIVE, { asarPath });
+    }
+
+    const files = archive.readdir(filePath);
+    if (!files) {
+      throw createError(AsarError.NOT_FOUND, { asarPath, filePath });
+    }
+
+    if (options && (options as any).withFileTypes) {
+      const dirents = [];
+      for (const file of files) {
+        const stats = archive.stat(file);
+        if (!stats) {
+          throw createError(AsarError.NOT_FOUND, { asarPath, filePath: file });
+        }
+        if (stats.isFile) {
+          dirents.push(new fs.Dirent(file, fs.constants.UV_DIRENT_FILE));
+        } else if (stats.isDirectory) {
+          dirents.push(new fs.Dirent(file, fs.constants.UV_DIRENT_DIR));
+        } else if (stats.isLink) {
+          dirents.push(new fs.Dirent(file, fs.constants.UV_DIRENT_LINK));
+        }
+      }
+      return dirents;
+    }
+
+    return files;
+  };
+
+  const { internalModuleReadJSON } = internalBinding('fs');
+  internalBinding('fs').internalModuleReadJSON = (pathArgument: string) => {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return internalModuleReadJSON(pathArgument);
+    const { asarPath, filePath } = pathInfo;
+
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) return;
+
+    const info = archive.getFileInfo(filePath);
+    if (!info) return;
+    if (info.size === 0) return '';
+    if (info.unpacked) {
+      const realPath = archive.copyFileOut(filePath);
+      return fs.readFileSync(realPath, { encoding: 'utf8' });
+    }
+
+    const buffer = Buffer.alloc(info.size);
+    const fd = archive.getFd();
+    if (!(fd >= 0)) return;
+
+    logASARAccess(asarPath, filePath, info.offset);
+    fs.readSync(fd, buffer, 0, info.size, info.offset);
+    return buffer.toString('utf8');
+  };
+
+  const { internalModuleStat } = internalBinding('fs');
+  internalBinding('fs').internalModuleStat = (pathArgument: string) => {
+    const pathInfo = splitPath(pathArgument);
+    if (!pathInfo.isAsar) return internalModuleStat(pathArgument);
+    const { asarPath, filePath } = pathInfo;
+
+    // -ENOENT
+    const archive = getOrCreateArchive(asarPath);
+    if (!archive) return -34;
+
+    // -ENOENT
+    const stats = archive.stat(filePath);
+    if (!stats) return -34;
+
+    return (stats.isDirectory) ? 1 : 0;
+  };
+
+  // Calling mkdir for directory inside asar archive should throw ENOTDIR
+  // error, but on Windows it throws ENOENT.
+  if (process.platform === 'win32') {
+    const { mkdir } = fs;
+    fs.mkdir = (pathArgument: string, options: any, callback: any) => {
+      if (typeof options === 'function') {
+        callback = options;
+        options = {};
+      }
+
+      const pathInfo = splitPath(pathArgument);
+      if (pathInfo.isAsar && pathInfo.filePath.length > 0) {
+        const error = createError(AsarError.NOT_DIR);
+        nextTick(callback, [error]);
+        return;
+      }
+
+      mkdir(pathArgument, options, callback);
+    };
+
+    fs.promises.mkdir = util.promisify(fs.mkdir);
+
+    const { mkdirSync } = fs;
+    fs.mkdirSync = function (pathArgument: string, options: any) {
+      const pathInfo = splitPath(pathArgument);
+      if (pathInfo.isAsar && pathInfo.filePath.length) throw createError(AsarError.NOT_DIR);
+      return mkdirSync(pathArgument, options);
+    };
+  }
+
+  function invokeWithNoAsar (func: Function) {
+    return function (this: any) {
+      const processNoAsarOriginalValue = process.noAsar;
+      process.noAsar = true;
+      try {
+        return func.apply(this, arguments);
+      } finally {
+        process.noAsar = processNoAsarOriginalValue;
+      }
+    };
+  }
+
+  // Strictly implementing the flags of fs.copyFile is hard, just do a simple
+  // implementation for now. Doing 2 copies won't spend much time more as OS
+  // has filesystem caching.
+  overrideAPI(fs, 'copyFile');
+  overrideAPISync(fs, 'copyFileSync');
+
+  overrideAPI(fs, 'open');
+  overrideAPISync(process, 'dlopen', 1);
+  overrideAPISync(Module._extensions, '.node', 1);
+  overrideAPISync(fs, 'openSync');
+
+  const overrideChildProcess = (childProcess: Record<string, any>) => {
+    // Executing a command string containing a path to an asar archive
+    // confuses `childProcess.execFile`, which is internally called by
+    // `childProcess.{exec,execSync}`, causing Electron to consider the full
+    // command as a single path to an archive.
+    const { exec, execSync } = childProcess;
+    childProcess.exec = invokeWithNoAsar(exec);
+    childProcess.exec[util.promisify.custom] = invokeWithNoAsar(exec[util.promisify.custom]);
+    childProcess.execSync = invokeWithNoAsar(execSync);
+
+    overrideAPI(childProcess, 'execFile');
+    overrideAPISync(childProcess, 'execFileSync');
+  };
+
+  // Lazily override the child_process APIs only when child_process is
+  // fetched the first time.  We will eagerly override the child_process APIs
+  // when this env var is set so that stack traces generated inside node unit
+  // tests will match. This env var will only slow things down in users apps
+  // and should not be used.
+  if (process.env.ELECTRON_EAGER_ASAR_HOOK_FOR_TESTING) {
+    overrideChildProcess(require('child_process'));
+  } else {
+    const originalModuleLoad = Module._load;
+    Module._load = (request: string, ...args: any[]) => {
+      const loadResult = originalModuleLoad(request, ...args);
+      if (request === 'child_process') {
+        if (!v8Util.getHiddenValue(loadResult, 'asar-ready')) {
+          v8Util.setHiddenValue(loadResult, 'asar-ready', true);
+          // Just to make it obvious what we are dealing with here
+          const childProcess = loadResult;
+
+          overrideChildProcess(childProcess);
+        }
+      }
+      return loadResult;
+    };
+  }
+};