Bump v15.1.1

* fix: sanitize params for 'context-menu' event sent over IPC for webview

* Revert "fix: sanitize params for 'context-menu' event sent over IPC for webview"

This reverts commit 7fee455138.

* fix: make frame property non-enumerable in params for 'context-menu' event

Co-authored-by: Milan Burda <milan.burda@gmail.com>

.devcontainer/README.md

@@ -1,59 +0,0 @@
-# Electron Dev on Codespaces
-
-Welcome to the Codespaces Electron Developer Environment.
-
-## Quick Start
-
-Upon creation of your codespace you should have [build tools](https://github.com/electron/build-tools) installed and an initialized gclient checkout of Electron.  In order to build electron you'll need to run the following commands.
-
-```bash
-e sync -vv
-e build
-```
-
-The initial sync will take approximately ~30 minutes and the build will take ~8 minutes.  Incremental syncs and incremental builds are substantially quicker.
-
-## Directory Structure
-
-Codespaces doesn't lean very well into gclient based checkouts, the directory structure is slightly strange.  There are two locations for the `electron` checkout that both map to the same files under the hood.
-
-```graphql
-# Primary gclient checkout container
-/workspaces/gclient/*
-  └─ src/* - # Chromium checkout
-     └─ electron - # Electron checkout
-# Symlinked Electron checkout (identical to the above)
-/workspaces/electron
-```
-
-## Goma
-
-If you are a maintainer [with Goma access](../docs/development/goma.md) it should be automatically configured and authenticated when you spin up a new codespaces instance.  You can validate this by checking `e d goma_auth info` or by checking that your build-tools configuration has a goma mode of `cluster`.
-
-## Running Electron
-
-You can run Electron in a few ways.  If you just want to see if it launches:
-
-```bash
-# Enter an interactive JS prompt headlessly
-xvfb-run e start -i
-```
-
-But if you want to actually see Electron you will need to use the built-in VNC capability.  If you click "Ports" in codespaces and then open the `VNC web client` forwarded port you should see a web based VNC portal in your browser.  When you are asked for a password use `builduser`.
-
-Once in the VNC UI you can open `Applications -> System -> XTerm` which will open a VNC based terminal app and then you can run `e start` like normal and Electron will open in your VNC session.
-
-## Running Tests
-
-You run tests via build-tools and `xvfb`.
-
-```bash
-# Run all tests
-xvfb-run e test
-
-# Run the main process tests
-xvfb-run e test --runners=main
-
-# Run the old remote tests
-xvfb-run e test --runners=remote
-```

.devcontainer/devcontainer.json

@@ -1,43 +0,0 @@
-{
-	"dockerComposeFile": "docker-compose.yml",
-	"service": "buildtools",
-	"onCreateCommand": ".devcontainer/on-create-command.sh",
-	"workspaceFolder": "/workspaces/gclient/src/electron",
-	"extensions": [
-		"joeleinbinder.mojom-language",
-		"rafaelmaiolla.diff",
-		"surajbarkale.ninja",
-		"ms-vscode.cpptools",
-		"mutantdino.resourcemonitor",
-		"dbaeumer.vscode-eslint",
-		"shakram02.bash-beautify",
-		"marshallofsound.gnls-electron"
-	],
-	"settings": {
-		"[gn]": {
-			"editor.formatOnSave": true
-		},
-		"editor.tabSize": 2,
-		"bashBeautify.tabSize": 2
-	},
-	"forwardPorts": [8088, 6080, 5901],
-	"portsAttributes": {
-		"8088": {
-			"label": "Goma Control Panel",
-			"onAutoForward": "silent"
-		},
-		"6080": {
-			"label": "VNC web client (noVNC)",
-			"onAutoForward": "silent"
-		},
-		"5901": {
-			"label": "VNC TCP port",
-			"onAutoForward": "silent"
-		}
-	},
-	"hostRequirements": {
-		"storage": "32gb",
-		"cpus": 8
-	},
-	"remoteUser": "builduser"
-}

.devcontainer/docker-compose.yml

@@ -1,19 +0,0 @@
-version: '3'
-
-services:
-  buildtools:
-    image: ghcr.io/electron/devcontainer:27db4a3e3512bfd2e47f58cea69922da0835f1d9
-
-    volumes:
-      - ..:/workspaces/gclient/src/electron:cached
-
-      - /var/run/docker.sock:/var/run/docker.sock 
-
-    command: /bin/sh -c "while sleep 1000; do :; done"  
-
-    user: builduser
-
-    cap_add:
-      - SYS_PTRACE
-    security_opt:
-      - seccomp:unconfined

.devcontainer/on-create-command.sh

@@ -1,74 +0,0 @@
-#!/bin/bash
-
-set -eo pipefail
-
-buildtools=$HOME/.electron_build_tools
-gclient_root=/workspaces/gclient
-buildtools_configs=/workspaces/buildtools-configs
-
-export PATH="$PATH:$buildtools/src"
-
-# Create the persisted buildtools config folder
-mkdir -p $buildtools_configs
-rm -f $buildtools/configs
-ln -s $buildtools_configs $buildtools/configs
-
-# Write the gclient config if it does not already exist
-if [ ! -f $gclient_root/.gclient ]; then
-  echo "solutions = [
-      { \"name\"        : \"src/electron\",
-          \"url\"         : \"https://github.com/electron/electron\",
-          \"deps_file\"   : \"DEPS\",
-          \"managed\"     : False,
-          \"custom_deps\" : {
-          },
-          \"custom_vars\": {},
-      },
-    ]
-  " >$gclient_root/.gclient
-fi
-
-# Write the default buildtools config file if it does
-# not already exist
-if [ ! -f $buildtools/configs/evm.testing.json ]; then
-  write_config() {
-    echo "
-        {
-            \"root\": \"/workspaces/gclient\",
-            \"goma\": \"$1\",
-            \"gen\": {
-                \"args\": [
-                    \"import(\\\"//electron/build/args/testing.gn\\\")\",
-                    \"import(\\\"/home/builduser/.electron_build_tools/third_party/goma.gn\\\")\"
-                ],
-                \"out\": \"Testing\"
-            },
-            \"env\": {
-                \"CHROMIUM_BUILDTOOLS_PATH\": \"/workspaces/gclient/src/buildtools\",
-                \"GIT_CACHE_PATH\": \"/workspaces/gclient/.git-cache\"
-            },
-            \"remotes\": {
-                \"electron\": {
-                    \"origin\": \"https://github.com/electron/electron.git\"
-                }
-            }
-        }
-    " >$buildtools/configs/evm.testing.json
-  }
-
-  # Start out as cache only
-  write_config cache-only
-
-  e use testing
-
-  # Attempt to auth to the goma service via codespaces tokens
-  # if it works we can use the goma cluster
-  export NOTGOMA_CODESPACES_TOKEN=$GITHUB_TOKEN
-  if e d goma_auth login; then
-    write_config cluster
-  fi
-else
-  # Even if the config file existed we still need to re-auth with the goma
-  # cluster
-  NOTGOMA_CODESPACES_TOKEN=$GITHUB_TOKEN e d goma_auth login || true
-fi

.github/CODEOWNERS

@@ -4,7 +4,7 @@
 # https://git-scm.com/docs/gitignore
 
 # Upgrades WG
-/patches/                               @electron/wg-upgrades @electron/wg-security
+/patches/                               @electron/wg-upgrades
 DEPS                                    @electron/wg-upgrades
 
 # Releases WG
@@ -16,4 +16,3 @@ DEPS                                    @electron/wg-upgrades
 /lib/browser/guest-view-manager.ts      @electron/wg-security
 /lib/browser/guest-window-proxy.ts      @electron/wg-security
 /lib/browser/rpc-server.ts              @electron/wg-security
-/lib/renderer/security-warnings.ts      @electron/wg-security

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -37,4 +37,4 @@ body:
     label: Additional Information
     description: Add any other context about the problem here.
   validations:
-    required: false
+    required: true

.nvmrc

@@ -1 +0,0 @@
-14

BUILD.gn

@@ -187,12 +187,6 @@ action("electron_js2c") {
          rebase_path(sources, root_build_dir)
 }
 
-action("generate_config_gypi") {
-  outputs = [ "$root_gen_dir/config.gypi" ]
-  script = "script/generate-config-gypi.py"
-  args = rebase_path(outputs) + [ target_cpu ]
-}
-
 target_gen_default_app_js = "$target_gen_dir/js/default_app"
 
 typescript_build("default_app_js") {
@@ -313,23 +307,6 @@ action("electron_fuses") {
   args = rebase_path(outputs)
 }
 
-action("electron_generate_node_defines") {
-  script = "build/generate_node_defines.py"
-
-  inputs = [
-    "//third_party/electron_node/src/tracing/trace_event_common.h",
-    "//third_party/electron_node/src/tracing/trace_event.h",
-    "//third_party/electron_node/src/util.h",
-  ]
-
-  outputs = [
-    "$target_gen_dir/push_and_undef_node_defines.h",
-    "$target_gen_dir/pop_node_defines.h",
-  ]
-
-  args = [ rebase_path(target_gen_dir) ] + rebase_path(inputs)
-}
-
 source_set("electron_lib") {
   configs += [ "//v8:external_startup_data" ]
   configs += [ "//third_party/electron_node:node_internals" ]
@@ -341,7 +318,6 @@ source_set("electron_lib") {
 
   deps = [
     ":electron_fuses",
-    ":electron_generate_node_defines",
     ":electron_js2c",
     ":electron_version_header",
     ":resources",
@@ -353,7 +329,6 @@ source_set("electron_lib") {
     "//base/allocator:buildflags",
     "//chrome/app:command_ids",
     "//chrome/app/resources:platform_locale_settings",
-    "//components/autofill/core/common:features",
     "//components/certificate_transparency",
     "//components/language/core/browser",
     "//components/net_log",
@@ -420,6 +395,7 @@ source_set("electron_lib") {
   ]
 
   include_dirs = [
+    "chromium_src",
     ".",
     "$target_gen_dir",
 
@@ -553,9 +529,8 @@ source_set("electron_lib") {
       "GLIB_DISABLE_DEPRECATION_WARNINGS",
     ]
 
+    sources += filenames.lib_sources_nss
     sources += [
-      "shell/browser/certificate_manager_model.cc",
-      "shell/browser/certificate_manager_model.h",
       "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",
@@ -1386,13 +1361,11 @@ dist_zip("electron_dist_zip") {
   if (is_linux) {
     data_deps += [ "//sandbox/linux:chrome_sandbox" ]
   }
-  deps = data_deps
   outputs = [ "$root_build_dir/dist.zip" ]
 }
 
 dist_zip("electron_ffmpeg_zip") {
   data_deps = [ "//third_party/ffmpeg" ]
-  deps = data_deps
   outputs = [ "$root_build_dir/ffmpeg.zip" ]
 }
 
@@ -1410,7 +1383,6 @@ group("electron_chromedriver") {
 dist_zip("electron_chromedriver_zip") {
   testonly = true
   data_deps = electron_chromedriver_deps
-  deps = data_deps
   outputs = [ "$root_build_dir/chromedriver.zip" ]
 }
 
@@ -1429,7 +1401,6 @@ group("electron_mksnapshot") {
 
 dist_zip("electron_mksnapshot_zip") {
   data_deps = mksnapshot_deps
-  deps = data_deps
   outputs = [ "$root_build_dir/mksnapshot.zip" ]
 }
 
@@ -1440,7 +1411,6 @@ copy("hunspell_dictionaries") {
 
 dist_zip("hunspell_dictionaries_zip") {
   data_deps = [ ":hunspell_dictionaries" ]
-  deps = data_deps
   flatten = true
 
   outputs = [ "$root_build_dir/hunspell_dictionaries.zip" ]
@@ -1454,7 +1424,6 @@ copy("libcxx_headers") {
 
 dist_zip("libcxx_headers_zip") {
   data_deps = [ ":libcxx_headers" ]
-  deps = data_deps
   flatten = true
   flatten_relative_to = rebase_path(
           "$target_gen_dir/electron_libcxx_include/buildtools/third_party/libc++/trunk",
@@ -1470,7 +1439,6 @@ copy("libcxxabi_headers") {
 
 dist_zip("libcxxabi_headers_zip") {
   data_deps = [ ":libcxxabi_headers" ]
-  deps = data_deps
   flatten = true
   flatten_relative_to = rebase_path(
           "$target_gen_dir/electron_libcxxabi_include/buildtools/third_party/libc++abi/trunk",

DEPS

@@ -15,9 +15,9 @@ gclient_gn_args = [
 
 vars = {
   'chromium_version':
-    '96.0.4664.174',
+    '94.0.4606.61',
   'node_version':
-    'v16.9.1',
+    'v16.5.0',
   'nan_version':
     # The following commit hash of NAN is v2.14.2 with *only* changes to the
     # test suite. This should be updated to a specific tag when one becomes

ELECTRON_VERSION

@@ -1 +1 @@
-16.1.0
+15.1.1

README.md

@@ -60,6 +60,7 @@ npm start
 - [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - Sample starter apps created by the community
 - [electron/simple-samples](https://github.com/electron/simple-samples) - Small applications with ideas for taking them further
 - [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - An Electron app that teaches you how to use Electron
+- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - Small demo apps for the various Electron APIs
 
 ## Programmatic usage
 

appveyor.yml

@@ -112,7 +112,7 @@ build_script:
           }
         }
       }
-  - if "%RUN_GCLIENT_SYNC%"=="true" ( gclient sync )
+  - if "%RUN_GCLIENT_SYNC%"=="true" ( gclient sync --with_branch_heads --with_tags --ignore_locks)
   - ps: >-
       if ($env:SAVE_GCLIENT_SRC -eq 'true') {
         # archive current source for future use 

build/args/all.gn

@@ -2,7 +2,7 @@ is_electron_build = true
 root_extra_deps = [ "//electron" ]
 
 # Registry of NMVs --> https://github.com/nodejs/node/blob/master/doc/abi_version_registry.json
-node_module_version = 99
+node_module_version = 98
 
 v8_promise_internal_field_count = 1
 v8_typed_array_max_size_in_heap = 0

build/generate_node_defines.py

@@ -1,34 +0,0 @@
-import os
-import re
-import sys
-
-DEFINE_EXTRACT_REGEX = re.compile('^ *# *define (\w*)', re.MULTILINE)
-
-def main(outDir, headers):
-  defines = []
-  for filename in headers:
-    with open(filename, 'r') as f:
-      content = f.read()
-      defines += read_defines(content)
-
-  push_and_undef = ''
-  for define in defines:
-    push_and_undef += '#pragma push_macro("%s")\n' % define
-    push_and_undef += '#undef %s\n' % define
-  with open(os.path.join(outDir, 'push_and_undef_node_defines.h'), 'w') as o:
-    o.write(push_and_undef)
-
-  pop = ''
-  for define in defines:
-    pop += '#pragma pop_macro("%s")\n' % define
-  with open(os.path.join(outDir, 'pop_node_defines.h'), 'w') as o:
-    o.write(pop)
-
-def read_defines(content):
-  defines = []
-  for match in DEFINE_EXTRACT_REGEX.finditer(content):
-    defines.append(match.group(1))
-  return defines
-
-if __name__ == '__main__':
-  main(sys.argv[1], sys.argv[2:])

build/npm.gni

@@ -5,8 +5,8 @@ template("npm_action") {
 
   action("npm_pre_flight_" + target_name) {
     inputs = [
-      "//electron/package.json",
-      "//electron/yarn.lock",
+      "package.json",
+      "yarn.lock",
     ]
     script = "//electron/build/npm-run.py"
 

build/webpack/webpack.gni

@@ -36,7 +36,7 @@ template("webpack_build") {
           rebase_path("$target_gen_dir/buildflags/buildflags.h"),
       "--env.mode=" + mode,
     ]
-    deps += [ "//electron/buildflags" ]
+    deps += [ "buildflags" ]
 
     outputs = [ invoker.out_file ]
   }

chromium_src/BUILD.gn

@@ -15,10 +15,6 @@ static_library("chrome") {
   sources = [
     "//chrome/browser/accessibility/accessibility_ui.cc",
     "//chrome/browser/accessibility/accessibility_ui.h",
-    "//chrome/browser/app_mode/app_mode_utils.cc",
-    "//chrome/browser/app_mode/app_mode_utils.h",
-    "//chrome/browser/browser_features.cc",
-    "//chrome/browser/browser_features.h",
     "//chrome/browser/browser_process.cc",
     "//chrome/browser/browser_process.h",
     "//chrome/browser/devtools/devtools_contents_resizing_strategy.cc",
@@ -29,7 +25,6 @@ static_library("chrome") {
     "//chrome/browser/devtools/devtools_eye_dropper.h",
     "//chrome/browser/devtools/devtools_file_system_indexer.cc",
     "//chrome/browser/devtools/devtools_file_system_indexer.h",
-    "//chrome/browser/devtools/devtools_settings.h",
     "//chrome/browser/extensions/global_shortcut_listener.cc",
     "//chrome/browser/extensions/global_shortcut_listener.h",
     "//chrome/browser/icon_loader.cc",
@@ -52,23 +47,6 @@ static_library("chrome") {
     "//chrome/browser/predictors/proxy_lookup_client_impl.h",
     "//chrome/browser/predictors/resolve_host_client_impl.cc",
     "//chrome/browser/predictors/resolve_host_client_impl.h",
-    "//chrome/browser/process_singleton.h",
-    "//chrome/browser/ui/browser_dialogs.cc",
-    "//chrome/browser/ui/browser_dialogs.h",
-    "//chrome/browser/ui/exclusive_access/exclusive_access_bubble_type.cc",
-    "//chrome/browser/ui/exclusive_access/exclusive_access_bubble_type.h",
-    "//chrome/browser/ui/exclusive_access/exclusive_access_controller_base.cc",
-    "//chrome/browser/ui/exclusive_access/exclusive_access_controller_base.h",
-    "//chrome/browser/ui/exclusive_access/exclusive_access_manager.cc",
-    "//chrome/browser/ui/exclusive_access/exclusive_access_manager.h",
-    "//chrome/browser/ui/exclusive_access/fullscreen_controller.cc",
-    "//chrome/browser/ui/exclusive_access/fullscreen_controller.h",
-    "//chrome/browser/ui/exclusive_access/fullscreen_within_tab_helper.cc",
-    "//chrome/browser/ui/exclusive_access/fullscreen_within_tab_helper.h",
-    "//chrome/browser/ui/exclusive_access/keyboard_lock_controller.cc",
-    "//chrome/browser/ui/exclusive_access/keyboard_lock_controller.h",
-    "//chrome/browser/ui/exclusive_access/mouse_lock_controller.cc",
-    "//chrome/browser/ui/exclusive_access/mouse_lock_controller.h",
     "//chrome/browser/ui/views/autofill/autofill_popup_view_utils.cc",
     "//chrome/browser/ui/views/autofill/autofill_popup_view_utils.h",
     "//chrome/browser/ui/views/eye_dropper/eye_dropper.cc",
@@ -79,10 +57,6 @@ static_library("chrome") {
     "//extensions/browser/app_window/size_constraints.h",
   ]
 
-  if (is_posix) {
-    sources += [ "//chrome/browser/process_singleton_posix.cc" ]
-  }
-
   if (is_mac) {
     sources += [
       "//chrome/browser/extensions/global_shortcut_listener_mac.h",
@@ -91,7 +65,6 @@ static_library("chrome") {
       "//chrome/browser/media/webrtc/system_media_capture_permissions_mac.h",
       "//chrome/browser/media/webrtc/system_media_capture_permissions_mac.mm",
       "//chrome/browser/media/webrtc/window_icon_util_mac.mm",
-      "//chrome/browser/process_singleton_mac.mm",
       "//chrome/browser/ui/views/eye_dropper/eye_dropper_view_mac.h",
       "//chrome/browser/ui/views/eye_dropper/eye_dropper_view_mac.mm",
     ]
@@ -103,7 +76,6 @@ static_library("chrome") {
       "//chrome/browser/extensions/global_shortcut_listener_win.h",
       "//chrome/browser/icon_loader_win.cc",
       "//chrome/browser/media/webrtc/window_icon_util_win.cc",
-      "//chrome/browser/process_singleton_win.cc",
       "//chrome/browser/ui/frame/window_frame_util.h",
       "//chrome/browser/ui/view_ids.h",
       "//chrome/browser/win/chrome_process_finder.cc",
@@ -115,7 +87,7 @@ static_library("chrome") {
   }
 
   if (is_linux) {
-    sources += [ "//chrome/browser/media/webrtc/window_icon_util_ozone.cc" ]
+    sources += [ "//chrome/browser/media/webrtc/window_icon_util_linux.cc" ]
   }
 
   if (use_aura) {
@@ -132,13 +104,13 @@ static_library("chrome") {
     "//components/keyed_service/content",
     "//components/paint_preview/buildflags",
     "//components/proxy_config",
-    "//components/services/language_detection/public/mojom",
     "//content/public/browser",
     "//services/strings",
   ]
 
   deps = [
     "//chrome/browser:resource_prefetch_predictor_proto",
+    "//chrome/services/speech:buildflags",
     "//components/optimization_guide/proto:optimization_guide_proto",
   ]
 
@@ -148,6 +120,16 @@ static_library("chrome") {
 
   if (is_linux) {
     sources += [ "//chrome/browser/icon_loader_auralinux.cc" ]
+    if (use_x11 || use_ozone) {
+      sources +=
+          [ "//chrome/browser/extensions/global_shortcut_listener_linux.cc" ]
+    }
+    if (use_x11) {
+      sources += [
+        "//chrome/browser/extensions/global_shortcut_listener_x11.cc",
+        "//chrome/browser/extensions/global_shortcut_listener_x11.h",
+      ]
+    }
     if (use_ozone) {
       deps += [ "//ui/ozone" ]
       sources += [
@@ -177,7 +159,6 @@ static_library("chrome") {
 
   if (enable_desktop_capturer) {
     sources += [
-      "//chrome/browser/media/webrtc/desktop_media_list.cc",
       "//chrome/browser/media/webrtc/desktop_media_list.h",
       "//chrome/browser/media/webrtc/desktop_media_list_base.cc",
       "//chrome/browser/media/webrtc/desktop_media_list_base.h",
@@ -215,13 +196,6 @@ static_library("chrome") {
       "//chrome/browser/printing/printing_service.h",
     ]
 
-    if (enable_oop_printing) {
-      sources += [
-        "//chrome/browser/printing/print_backend_service_manager.cc",
-        "//chrome/browser/printing/print_backend_service_manager.h",
-      ]
-    }
-
     public_deps += [
       "//chrome/services/printing:lib",
       "//components/printing/browser",
@@ -229,7 +203,6 @@ static_library("chrome") {
       "//components/services/print_compositor",
       "//components/services/print_compositor/public/cpp",
       "//components/services/print_compositor/public/mojom",
-      "//printing/backend",
     ]
 
     deps += [

chromium_src/chrome/browser/certificate_manager_model.cc

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#include "shell/browser/certificate_manager_model.h"
+#include "chrome/browser/certificate_manager_model.h"
 
 #include <utility>
 

chromium_src/chrome/browser/certificate_manager_model.h

@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#ifndef SHELL_BROWSER_CERTIFICATE_MANAGER_MODEL_H_
-#define SHELL_BROWSER_CERTIFICATE_MANAGER_MODEL_H_
+#ifndef CHROME_BROWSER_CERTIFICATE_MANAGER_MODEL_H_
+#define CHROME_BROWSER_CERTIFICATE_MANAGER_MODEL_H_
 
 #include <memory>
 #include <string>
@@ -112,4 +112,4 @@ class CertificateManagerModel {
   DISALLOW_COPY_AND_ASSIGN(CertificateManagerModel);
 };
 
-#endif  // SHELL_BROWSER_CERTIFICATE_MANAGER_MODEL_H_
+#endif  // CHROME_BROWSER_CERTIFICATE_MANAGER_MODEL_H_

chromium_src/chrome/browser/process_singleton.h

@@ -0,0 +1,185 @@
+// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CHROME_BROWSER_PROCESS_SINGLETON_H_
+#define CHROME_BROWSER_PROCESS_SINGLETON_H_
+
+#if defined(OS_WIN)
+#include <windows.h>
+#endif  // defined(OS_WIN)
+
+#include "base/callback.h"
+#include "base/command_line.h"
+#include "base/files/file_path.h"
+#include "base/logging.h"
+#include "base/memory/ref_counted.h"
+#include "base/process/process.h"
+#include "base/sequence_checker.h"
+#include "ui/gfx/native_widget_types.h"
+
+#if defined(OS_POSIX) && !defined(OS_ANDROID)
+#include "base/files/scoped_temp_dir.h"
+#endif
+
+#if defined(OS_WIN)
+#include "base/win/message_window.h"
+#endif  // defined(OS_WIN)
+
+namespace base {
+class CommandLine;
+}
+
+// ProcessSingleton ----------------------------------------------------------
+//
+// This class allows different browser processes to communicate with
+// each other.  It is named according to the user data directory, so
+// we can be sure that no more than one copy of the application can be
+// running at once with a given data directory.
+//
+// Implementation notes:
+// - the Windows implementation uses an invisible global message window;
+// - the Linux implementation uses a Unix domain socket in the user data dir.
+
+class ProcessSingleton {
+ public:
+  enum NotifyResult {
+    PROCESS_NONE,
+    PROCESS_NOTIFIED,
+    PROFILE_IN_USE,
+    LOCK_ERROR,
+  };
+
+  // Implement this callback to handle notifications from other processes. The
+  // callback will receive the command line and directory with which the other
+  // Chrome process was launched. Return true if the command line will be
+  // handled within the current browser instance or false if the remote process
+  // should handle it (i.e., because the current process is shutting down).
+  using NotificationCallback = base::RepeatingCallback<bool(
+      const base::CommandLine::StringVector& command_line,
+      const base::FilePath& current_directory)>;
+
+  ProcessSingleton(const base::FilePath& user_data_dir,
+                   const NotificationCallback& notification_callback);
+  ~ProcessSingleton();
+
+  // Notify another process, if available. Otherwise sets ourselves as the
+  // singleton instance. Returns PROCESS_NONE if we became the singleton
+  // instance. Callers are guaranteed to either have notified an existing
+  // process or have grabbed the singleton (unless the profile is locked by an
+  // unreachable process).
+  // TODO(brettw): Make the implementation of this method non-platform-specific
+  // by making Linux re-use the Windows implementation.
+  NotifyResult NotifyOtherProcessOrCreate();
+  void StartListeningOnSocket();
+  void OnBrowserReady();
+
+  // Sets ourself up as the singleton instance.  Returns true on success.  If
+  // false is returned, we are not the singleton instance and the caller must
+  // exit.
+  // NOTE: Most callers should generally prefer NotifyOtherProcessOrCreate() to
+  // this method, only callers for whom failure is preferred to notifying
+  // another process should call this directly.
+  bool Create();
+
+  // Clear any lock state during shutdown.
+  void Cleanup();
+
+#if defined(OS_POSIX) && !defined(OS_ANDROID)
+  static void DisablePromptForTesting();
+#endif
+#if defined(OS_WIN)
+  // Called to query whether to kill a hung browser process that has visible
+  // windows. Return true to allow killing the hung process.
+  using ShouldKillRemoteProcessCallback = base::RepeatingCallback<bool()>;
+  void OverrideShouldKillRemoteProcessCallbackForTesting(
+      const ShouldKillRemoteProcessCallback& display_dialog_callback);
+#endif
+
+ protected:
+  // Notify another process, if available.
+  // Returns true if another process was found and notified, false if we should
+  // continue with the current process.
+  // On Windows, Create() has to be called before this.
+  NotifyResult NotifyOtherProcess();
+
+#if defined(OS_POSIX) && !defined(OS_ANDROID)
+  // Exposed for testing.  We use a timeout on Linux, and in tests we want
+  // this timeout to be short.
+  NotifyResult NotifyOtherProcessWithTimeout(
+      const base::CommandLine& command_line,
+      int retry_attempts,
+      const base::TimeDelta& timeout,
+      bool kill_unresponsive);
+  NotifyResult NotifyOtherProcessWithTimeoutOrCreate(
+      const base::CommandLine& command_line,
+      int retry_attempts,
+      const base::TimeDelta& timeout);
+  void OverrideCurrentPidForTesting(base::ProcessId pid);
+  void OverrideKillCallbackForTesting(
+      const base::RepeatingCallback<void(int)>& callback);
+#endif
+
+ private:
+  NotificationCallback notification_callback_;  // Handler for notifications.
+
+#if defined(OS_WIN)
+  HWND remote_window_ = nullptr;     // The HWND_MESSAGE of another browser.
+  base::win::MessageWindow window_;  // The message-only window.
+  bool is_virtualized_ =
+      false;  // Stuck inside Microsoft Softricity VM environment.
+  HANDLE lock_file_ = INVALID_HANDLE_VALUE;
+  base::FilePath user_data_dir_;
+  ShouldKillRemoteProcessCallback should_kill_remote_process_callback_;
+#elif defined(OS_POSIX) && !defined(OS_ANDROID)
+  // Start listening to the socket.
+  void StartListening(int sock);
+
+  // Return true if the given pid is one of our child processes.
+  // Assumes that the current pid is the root of all pids of the current
+  // instance.
+  bool IsSameChromeInstance(pid_t pid);
+
+  // Extract the process's pid from a symbol link path and if it is on
+  // the same host, kill the process, unlink the lock file and return true.
+  // If the process is part of the same chrome instance, unlink the lock file
+  // and return true without killing it.
+  // If the process is on a different host, return false.
+  bool KillProcessByLockPath();
+
+  // Default function to kill a process, overridable by tests.
+  void KillProcess(int pid);
+
+  // Allow overriding for tests.
+  base::ProcessId current_pid_;
+
+  // Function to call when the other process is hung and needs to be killed.
+  // Allows overriding for tests.
+  base::RepeatingCallback<void(int)> kill_callback_;
+
+  // Path in file system to the socket.
+  base::FilePath socket_path_;
+
+  // Path in file system to the lock.
+  base::FilePath lock_path_;
+
+  // Path in file system to the cookie file.
+  base::FilePath cookie_path_;
+
+  // Temporary directory to hold the socket.
+  base::ScopedTempDir socket_dir_;
+
+  // Helper class for linux specific messages.  LinuxWatcher is ref counted
+  // because it posts messages between threads.
+  class LinuxWatcher;
+  scoped_refptr<LinuxWatcher> watcher_;
+  int sock_ = -1;
+  bool listen_on_ready_ = false;
+#endif
+
+  SEQUENCE_CHECKER(sequence_checker_);
+
+  DISALLOW_COPY_AND_ASSIGN(ProcessSingleton);
+};
+
+#endif  // CHROME_BROWSER_PROCESS_SINGLETON_H_

chromium_src/chrome/browser/process_singleton_win.cc

@@ -0,0 +1,315 @@
+// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "chrome/browser/process_singleton.h"
+
+#include <windows.h>
+#include <shellapi.h>
+
+#include "base/base_paths.h"
+#include "base/bind.h"
+#include "base/command_line.h"
+#include "base/files/file_path.h"
+#include "base/files/file_util.h"
+#include "base/process/process.h"
+#include "base/process/process_info.h"
+#include "base/strings/string_number_conversions.h"
+#include "base/strings/stringprintf.h"
+#include "base/strings/utf_string_conversions.h"
+#include "base/time/time.h"
+#include "base/win/registry.h"
+#include "base/win/scoped_handle.h"
+#include "base/win/windows_version.h"
+#include "chrome/browser/win/chrome_process_finder.h"
+#include "content/public/common/result_codes.h"
+#include "net/base/escape.h"
+#include "ui/gfx/win/hwnd_util.h"
+
+namespace {
+
+const char kLockfile[] = "lockfile";
+
+// A helper class that acquires the given |mutex| while the AutoLockMutex is in
+// scope.
+class AutoLockMutex {
+ public:
+  explicit AutoLockMutex(HANDLE mutex) : mutex_(mutex) {
+    DWORD result = ::WaitForSingleObject(mutex_, INFINITE);
+    DPCHECK(result == WAIT_OBJECT_0) << "Result = " << result;
+  }
+
+  ~AutoLockMutex() {
+    BOOL released = ::ReleaseMutex(mutex_);
+    DPCHECK(released);
+  }
+
+ private:
+  HANDLE mutex_;
+  DISALLOW_COPY_AND_ASSIGN(AutoLockMutex);
+};
+
+// A helper class that releases the given |mutex| while the AutoUnlockMutex is
+// in scope and immediately re-acquires it when going out of scope.
+class AutoUnlockMutex {
+ public:
+  explicit AutoUnlockMutex(HANDLE mutex) : mutex_(mutex) {
+    BOOL released = ::ReleaseMutex(mutex_);
+    DPCHECK(released);
+  }
+
+  ~AutoUnlockMutex() {
+    DWORD result = ::WaitForSingleObject(mutex_, INFINITE);
+    DPCHECK(result == WAIT_OBJECT_0) << "Result = " << result;
+  }
+
+ private:
+  HANDLE mutex_;
+  DISALLOW_COPY_AND_ASSIGN(AutoUnlockMutex);
+};
+
+// Checks the visibility of the enumerated window and signals once a visible
+// window has been found.
+BOOL CALLBACK BrowserWindowEnumeration(HWND window, LPARAM param) {
+  bool* result = reinterpret_cast<bool*>(param);
+  *result = ::IsWindowVisible(window) != 0;
+  // Stops enumeration if a visible window has been found.
+  return !*result;
+}
+
+bool ParseCommandLine(const COPYDATASTRUCT* cds,
+                      base::CommandLine::StringVector* parsed_command_line,
+                      base::FilePath* current_directory) {
+  // We should have enough room for the shortest command (min_message_size)
+  // and also be a multiple of wchar_t bytes. The shortest command
+  // possible is L"START\0\0" (empty current directory and command line).
+  static const int min_message_size = 7;
+  if (cds->cbData < min_message_size * sizeof(wchar_t) ||
+      cds->cbData % sizeof(wchar_t) != 0) {
+    LOG(WARNING) << "Invalid WM_COPYDATA, length = " << cds->cbData;
+    return false;
+  }
+
+  // We split the string into 4 parts on NULLs.
+  DCHECK(cds->lpData);
+  const std::wstring msg(static_cast<wchar_t*>(cds->lpData),
+                         cds->cbData / sizeof(wchar_t));
+  const std::wstring::size_type first_null = msg.find_first_of(L'\0');
+  if (first_null == 0 || first_null == std::wstring::npos) {
+    // no NULL byte, don't know what to do
+    LOG(WARNING) << "Invalid WM_COPYDATA, length = " << msg.length()
+                 << ", first null = " << first_null;
+    return false;
+  }
+
+  // Decode the command, which is everything until the first NULL.
+  if (msg.substr(0, first_null) == L"START") {
+    // Another instance is starting parse the command line & do what it would
+    // have done.
+    VLOG(1) << "Handling STARTUP request from another process";
+    const std::wstring::size_type second_null =
+        msg.find_first_of(L'\0', first_null + 1);
+    if (second_null == std::wstring::npos || first_null == msg.length() - 1 ||
+        second_null == msg.length()) {
+      LOG(WARNING) << "Invalid format for start command, we need a string in 4 "
+                      "parts separated by NULLs";
+      return false;
+    }
+
+    // Get current directory.
+    *current_directory =
+        base::FilePath(msg.substr(first_null + 1, second_null - first_null));
+
+    const std::wstring::size_type third_null =
+        msg.find_first_of(L'\0', second_null + 1);
+    if (third_null == std::wstring::npos || third_null == msg.length()) {
+      LOG(WARNING) << "Invalid format for start command, we need a string in 4 "
+                      "parts separated by NULLs";
+    }
+
+    // Get command line.
+    const std::wstring cmd_line =
+        msg.substr(second_null + 1, third_null - second_null);
+    *parsed_command_line = base::CommandLine::FromString(cmd_line).argv();
+    return true;
+  }
+  return false;
+}
+
+bool ProcessLaunchNotification(
+    const ProcessSingleton::NotificationCallback& notification_callback,
+    UINT message,
+    WPARAM wparam,
+    LPARAM lparam,
+    LRESULT* result) {
+  if (message != WM_COPYDATA)
+    return false;
+
+  // Handle the WM_COPYDATA message from another process.
+  const COPYDATASTRUCT* cds = reinterpret_cast<COPYDATASTRUCT*>(lparam);
+
+  base::CommandLine::StringVector parsed_command_line;
+  base::FilePath current_directory;
+  if (!ParseCommandLine(cds, &parsed_command_line, &current_directory)) {
+    *result = TRUE;
+    return true;
+  }
+
+  *result = notification_callback.Run(parsed_command_line, current_directory)
+                ? TRUE
+                : FALSE;
+  return true;
+}
+
+bool TerminateAppWithError() {
+  // TODO: This is called when the secondary process can't ping the primary
+  // process. Need to find out what to do here.
+  return false;
+}
+
+}  // namespace
+
+ProcessSingleton::ProcessSingleton(
+    const base::FilePath& user_data_dir,
+    const NotificationCallback& notification_callback)
+    : notification_callback_(notification_callback),
+      user_data_dir_(user_data_dir),
+      should_kill_remote_process_callback_(
+          base::BindRepeating(&TerminateAppWithError)) {
+  // The user_data_dir may have not been created yet.
+  base::CreateDirectoryAndGetError(user_data_dir, nullptr);
+}
+
+ProcessSingleton::~ProcessSingleton() {
+  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
+  if (lock_file_ != INVALID_HANDLE_VALUE)
+    ::CloseHandle(lock_file_);
+}
+
+// Code roughly based on Mozilla.
+ProcessSingleton::NotifyResult ProcessSingleton::NotifyOtherProcess() {
+  if (is_virtualized_)
+    return PROCESS_NOTIFIED;  // We already spawned the process in this case.
+  if (lock_file_ == INVALID_HANDLE_VALUE && !remote_window_) {
+    return LOCK_ERROR;
+  } else if (!remote_window_) {
+    return PROCESS_NONE;
+  }
+
+  switch (chrome::AttemptToNotifyRunningChrome(remote_window_)) {
+    case chrome::NOTIFY_SUCCESS:
+      return PROCESS_NOTIFIED;
+    case chrome::NOTIFY_FAILED:
+      remote_window_ = NULL;
+      return PROCESS_NONE;
+    case chrome::NOTIFY_WINDOW_HUNG:
+      // Fall through and potentially terminate the hung browser.
+      break;
+  }
+
+  DWORD process_id = 0;
+  DWORD thread_id = ::GetWindowThreadProcessId(remote_window_, &process_id);
+  if (!thread_id || !process_id) {
+    remote_window_ = NULL;
+    return PROCESS_NONE;
+  }
+  base::Process process = base::Process::Open(process_id);
+
+  // The window is hung. Scan for every window to find a visible one.
+  bool visible_window = false;
+  ::EnumThreadWindows(thread_id, &BrowserWindowEnumeration,
+                      reinterpret_cast<LPARAM>(&visible_window));
+
+  // If there is a visible browser window, ask the user before killing it.
+  if (visible_window && !should_kill_remote_process_callback_.Run()) {
+    // The user denied. Quit silently.
+    return PROCESS_NOTIFIED;
+  }
+
+  // Time to take action. Kill the browser process.
+  process.Terminate(content::RESULT_CODE_HUNG, true);
+  remote_window_ = NULL;
+  return PROCESS_NONE;
+}
+
+ProcessSingleton::NotifyResult ProcessSingleton::NotifyOtherProcessOrCreate() {
+  ProcessSingleton::NotifyResult result = PROCESS_NONE;
+  if (!Create()) {
+    result = NotifyOtherProcess();
+    if (result == PROCESS_NONE)
+      result = PROFILE_IN_USE;
+  }
+  return result;
+}
+
+void ProcessSingleton::StartListeningOnSocket() {}
+void ProcessSingleton::OnBrowserReady() {}
+
+// Look for a Chrome instance that uses the same profile directory. If there
+// isn't one, create a message window with its title set to the profile
+// directory path.
+bool ProcessSingleton::Create() {
+  static const wchar_t kMutexName[] = L"Local\\AtomProcessSingletonStartup!";
+
+  remote_window_ = chrome::FindRunningChromeWindow(user_data_dir_);
+  if (!remote_window_) {
+    // Make sure we will be the one and only process creating the window.
+    // We use a named Mutex since we are protecting against multi-process
+    // access. As documented, it's clearer to NOT request ownership on creation
+    // since it isn't guaranteed we will get it. It is better to create it
+    // without ownership and explicitly get the ownership afterward.
+    base::win::ScopedHandle only_me(::CreateMutex(NULL, FALSE, kMutexName));
+    if (!only_me.IsValid()) {
+      DPLOG(FATAL) << "CreateMutex failed";
+      return false;
+    }
+
+    AutoLockMutex auto_lock_only_me(only_me.Get());
+
+    // We now own the mutex so we are the only process that can create the
+    // window at this time, but we must still check if someone created it
+    // between the time where we looked for it above and the time the mutex
+    // was given to us.
+    remote_window_ = chrome::FindRunningChromeWindow(user_data_dir_);
+    if (!remote_window_) {
+      // We have to make sure there is no Chrome instance running on another
+      // machine that uses the same profile.
+      base::FilePath lock_file_path = user_data_dir_.AppendASCII(kLockfile);
+      lock_file_ =
+          ::CreateFile(lock_file_path.value().c_str(), GENERIC_WRITE,
+                       FILE_SHARE_READ, NULL, CREATE_ALWAYS,
+                       FILE_ATTRIBUTE_NORMAL | FILE_FLAG_DELETE_ON_CLOSE, NULL);
+      DWORD error = ::GetLastError();
+      LOG_IF(WARNING, lock_file_ != INVALID_HANDLE_VALUE &&
+                          error == ERROR_ALREADY_EXISTS)
+          << "Lock file exists but is writable.";
+      LOG_IF(ERROR, lock_file_ == INVALID_HANDLE_VALUE)
+          << "Lock file can not be created! Error code: " << error;
+
+      if (lock_file_ != INVALID_HANDLE_VALUE) {
+        // Set the window's title to the path of our user data directory so
+        // other Chrome instances can decide if they should forward to us.
+        bool result =
+            window_.CreateNamed(base::BindRepeating(&ProcessLaunchNotification,
+                                                    notification_callback_),
+                                user_data_dir_.value());
+
+        // NB: Ensure that if the primary app gets started as elevated
+        // admin inadvertently, secondary windows running not as elevated
+        // will still be able to send messages
+        ::ChangeWindowMessageFilterEx(window_.hwnd(), WM_COPYDATA, MSGFLT_ALLOW,
+                                      NULL);
+        CHECK(result && window_.hwnd());
+      }
+    }
+  }
+
+  return window_.hwnd() != NULL;
+}
+
+void ProcessSingleton::Cleanup() {}
+
+void ProcessSingleton::OverrideShouldKillRemoteProcessCallbackForTesting(
+    const ShouldKillRemoteProcessCallback& display_dialog_callback) {
+  should_kill_remote_process_callback_ = display_dialog_callback;
+}

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

@@ -2,9 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#include "shell/browser/ui/views/global_menu_bar_registrar_x11.h"
-
-#include <string>
+#include "chrome/browser/ui/views/frame/global_menu_bar_registrar_x11.h"
 
 #include "base/bind.h"
 #include "base/debug/leak_annotations.h"
@@ -51,7 +49,7 @@ GlobalMenuBarRegistrarX11::GlobalMenuBarRegistrarX11() {
                                    G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START),
       nullptr, kAppMenuRegistrarName, kAppMenuRegistrarPath,
       kAppMenuRegistrarName,
-      nullptr,  // Probably want a real cancelable.
+      nullptr,  // TODO: Probalby want a real cancelable.
       static_cast<GAsyncReadyCallback>(OnProxyCreatedThunk), this);
 }
 

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

@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#ifndef SHELL_BROWSER_UI_VIEWS_GLOBAL_MENU_BAR_REGISTRAR_X11_H_
-#define SHELL_BROWSER_UI_VIEWS_GLOBAL_MENU_BAR_REGISTRAR_X11_H_
+#ifndef CHROME_BROWSER_UI_VIEWS_FRAME_GLOBAL_MENU_BAR_REGISTRAR_X11_H_
+#define CHROME_BROWSER_UI_VIEWS_FRAME_GLOBAL_MENU_BAR_REGISTRAR_X11_H_
 
 #include <gio/gio.h>
 
@@ -57,4 +57,4 @@ class GlobalMenuBarRegistrarX11 {
   DISALLOW_COPY_AND_ASSIGN(GlobalMenuBarRegistrarX11);
 };
 
-#endif  // SHELL_BROWSER_UI_VIEWS_GLOBAL_MENU_BAR_REGISTRAR_X11_H_
+#endif  // CHROME_BROWSER_UI_VIEWS_FRAME_GLOBAL_MENU_BAR_REGISTRAR_X11_H_

docs/README.md

@@ -59,9 +59,10 @@ an issue:
 * [Testing and Debugging](tutorial/application-debugging.md)
   * [Debugging the Main Process](tutorial/debugging-main-process.md)
   * [Debugging with Visual Studio Code](tutorial/debugging-vscode.md)
+  * [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
   * [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
   * [DevTools Extension](tutorial/devtools-extension.md)
-  * [Automated Testing](tutorial/automated-testing.md)
+  * [Automated Testing with a Custom Driver](tutorial/automated-testing-with-a-custom-driver.md)
   * [REPL](tutorial/repl.md)
 * [Distribution](tutorial/application-distribution.md)
   * [Supported Platforms](tutorial/support.md#supported-platforms)

docs/api/app.md

@@ -36,10 +36,10 @@ Returns:
 * `launchInfo` Record<string, any> | [NotificationResponse](structures/notification-response.md) _macOS_
 
 Emitted once, when Electron has finished initializing. On macOS, `launchInfo`
-holds the `userInfo` of the [`NSUserNotification`](https://developer.apple.com/documentation/foundation/nsusernotification)
-or information from [`UNNotificationResponse`](https://developer.apple.com/documentation/usernotifications/unnotificationresponse)
-that was used to open the application, if it was launched from Notification Center.
-You can also call `app.isReady()` to check if this event has already fired and `app.whenReady()`
+holds the `userInfo` of the `NSUserNotification` or information from
+[`UNNotificationResponse`](structures/notification-response.md) that was used to open the
+application, if it was launched from Notification Center. You can also call
+`app.isReady()` to check if this event has already fired and `app.whenReady()`
 to get a Promise that is fulfilled when Electron is initialized.
 
 ### Event: 'window-all-closed'
@@ -483,7 +483,6 @@ Returns:
 * `event` Event
 * `argv` String[] - An array of the second instance's command line arguments
 * `workingDirectory` String - The second instance's working directory
-* `additionalData` unknown - A JSON object of additional data passed from the second instance
 
 This event will be emitted inside the primary instance of your application
 when a second instance has been executed and calls `app.requestSingleInstanceLock()`.
@@ -940,9 +939,7 @@ app.setJumpList([
 ])
 ```
 
-### `app.requestSingleInstanceLock([additionalData])`
-
-* `additionalData` Record<any, any> (optional) - A JSON object containing additional data to send to the first instance.
+### `app.requestSingleInstanceLock()`
 
 Returns `Boolean`
 
@@ -969,16 +966,12 @@ starts:
 const { app } = require('electron')
 let myWindow = null
 
-const additionalData = { myKey: 'myValue' }
-const gotTheLock = app.requestSingleInstanceLock(additionalData)
+const gotTheLock = app.requestSingleInstanceLock()
 
 if (!gotTheLock) {
   app.quit()
 } else {
-  app.on('second-instance', (event, commandLine, workingDirectory, additionalData) => {
-    // Print out data received from the second instance.
-    console.log(additionalData)
-
+  app.on('second-instance', (event, commandLine, workingDirectory) => {
     // Someone tried to run a second instance, we should focus our window.
     if (myWindow) {
       if (myWindow.isMinimized()) myWindow.restore()

docs/api/browser-view.md

@@ -15,16 +15,14 @@ Process: [Main](../glossary.md#main-process)
 
 ```javascript
 // In the main process.
-const { app, BrowserView, BrowserWindow } = require('electron')
+const { BrowserView, BrowserWindow } = require('electron')
 
-app.whenReady().then(() => {
-  const win = new BrowserWindow({ width: 800, height: 600 })
+const win = new BrowserWindow({ width: 800, height: 600 })
 
-  const view = new BrowserView()
-  win.setBrowserView(view)
-  view.setBounds({ x: 0, y: 0, width: 300, height: 300 })
-  view.webContents.loadURL('https://electronjs.org')
-})
+const view = new BrowserView()
+win.setBrowserView(view)
+view.setBounds({ x: 0, y: 0, width: 300, height: 300 })
+view.webContents.loadURL('https://electronjs.org')
 ```
 
 ### `new BrowserView([options])` _Experimental_

docs/api/browser-window.md

@@ -17,11 +17,10 @@ win.loadURL('https://github.com')
 win.loadFile('index.html')
 ```
 
-## Window customization
+## Frameless window
 
-The `BrowserWindow` class exposes various ways to modify the look and behavior of
-your app's windows. For more details, see the [Window Customization](../tutorial/window-customization.md)
-tutorial.
+To create a window without chrome, or a transparent window in arbitrary shape,
+you can use the [Frameless Window](frameless-window.md) API.
 
 ## Showing the window gracefully
 
@@ -185,7 +184,7 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
     `true`.
   * `paintWhenInitiallyHidden` Boolean (optional) - Whether the renderer should be active when `show` is `false` and it has just been created.  In order for `document.visibilityState` to work correctly on first load with `show: false` you should set this to `false`.  Setting this to `false` will cause the `ready-to-show` event to not fire.  Default is `true`.
   * `frame` Boolean (optional) - Specify `false` to create a
-    [frameless window](../tutorial/window-customization.md#create-frameless-windows). Default is `true`.
+    [Frameless Window](frameless-window.md). Default is `true`.
   * `parent` BrowserWindow (optional) - Specify parent window. Default is `null`.
   * `modal` Boolean (optional) - Whether this is a modal window. This only works when the
     window is a child window. Default is `false`.
@@ -207,7 +206,7 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
     transparent) and 1.0 (fully opaque). This is only implemented on Windows and macOS.
   * `darkTheme` Boolean (optional) - Forces using dark theme for the window, only works on
     some GTK+3 desktop environments. Default is `false`.
-  * `transparent` Boolean (optional) - Makes the window [transparent](../tutorial/window-customization.md#create-transparent-windows).
+  * `transparent` Boolean (optional) - Makes the window [transparent](frameless-window.md#transparent-window).
     Default is `false`. On Windows, does not work unless the window is frameless.
   * `type` String (optional) - The type of window, default is normal window. See more about
     this below.
@@ -394,7 +393,6 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
   * `titleBarOverlay` Object | Boolean (optional) -  When using a frameless window in conjuction with `win.setWindowButtonVisibility(true)` on macOS or using a `titleBarStyle` so that the standard window controls ("traffic lights" on macOS) are visible, this property enables the Window Controls Overlay [JavaScript APIs][overlay-javascript-apis] and [CSS Environment Variables][overlay-css-env-vars]. Specifying `true` will result in an overlay with default system colors. Default is `false`.
     * `color` String (optional) _Windows_ - The CSS color of the Window Controls Overlay when enabled. Default is the system color.
     * `symbolColor` String (optional) _Windows_ - The CSS color of the symbols on the Window Controls Overlay when enabled. Default is the system color.
-    * `height` Integer (optional) _macOS_ _Windows_ - The height of the title bar and Window Controls Overlay in pixels. Default is system height.
 
 When setting minimum or maximum window size with `minWidth`/`maxWidth`/
 `minHeight`/`maxHeight`, it only constrains the users. It won't prevent you from
@@ -560,7 +558,7 @@ Returns:
 
 Emitted before the window is moved. On Windows, calling `event.preventDefault()` will prevent the window from being moved.
 
-Note that this is only emitted when the window is being moved manually. Moving the window with `setPosition`/`setBounds`/`center` will not emit this event.
+Note that this is only emitted when the window is being resized manually. Resizing the window with `setBounds`/`setSize` will not emit this event.
 
 #### Event: 'move'
 
@@ -1000,7 +998,7 @@ APIs like `win.setSize`.
   is `true`). Default is `#FFF` (white).
 
 Sets the background color of the window. See [Setting
-`backgroundColor`](#setting-the-backgroundcolor-property).
+`backgroundColor`](#setting-backgroundcolor).
 
 #### `win.previewFile(path[, displayName])` _macOS_
 
@@ -1045,7 +1043,7 @@ Returns [`Rectangle`](structures/rectangle.md) - The `bounds` of the window as `
 #### `win.getBackgroundColor()`
 
 Returns `String` - Gets the background color of the window. See [Setting
-`backgroundColor`](#setting-the-backgroundcolor-property).
+`backgroundColor`](#setting-backgroundcolor).
 
 #### `win.setContentBounds(bounds[, animate])`
 
@@ -1698,7 +1696,7 @@ current window into a top-level window.
 
 #### `win.getParentWindow()`
 
-Returns `BrowserWindow | null` - The parent window or `null` if there is no parent.
+Returns `BrowserWindow` - The parent window.
 
 #### `win.getChildWindows()`
 

docs/api/clipboard.md

@@ -76,7 +76,7 @@ Writes `markup` to the clipboard.
 ```js
 const { clipboard } = require('electron')
 
-clipboard.writeHTML('<b>Hi</b>')
+clipboard.writeHTML('<b>Hi</b')
 ```
 
 ### `clipboard.readImage([type])`
@@ -131,15 +131,15 @@ Returns `Object`:
 
 Returns an Object containing `title` and `url` keys representing the bookmark in
 the clipboard. The `title` and `url` values will be empty strings when the
-bookmark is unavailable.  The `title` value will always be empty on Windows.
+bookmark is unavailable.
 
 ### `clipboard.writeBookmark(title, url[, type])` _macOS_ _Windows_
 
-* `title` String - Unused on Windows
+* `title` String
 * `url` String
 * `type` String (optional) - Can be `selection` or `clipboard`; default is 'clipboard'. `selection` is only available on Linux.
 
-Writes the `title` (macOS only) and `url` into the clipboard as a bookmark.
+Writes the `title` and `url` into the clipboard as a bookmark.
 
 **Note:** Most apps on Windows don't support pasting bookmarks into them so
 you can use `clipboard.write` to write both a bookmark and fallback text to the
@@ -197,7 +197,7 @@ Returns `Boolean` - Whether the clipboard supports the specified `format`.
 ```js
 const { clipboard } = require('electron')
 
-const hasFormat = clipboard.has('public/utf8-plain-text')
+const hasFormat = clipboard.has('<p>selection</p>')
 console.log(hasFormat)
 // 'true' or 'false'
 ```

docs/api/command-line.md

@@ -53,12 +53,3 @@ Returns `Boolean` - Whether the command-line switch is present.
 Returns `String` - The command-line switch value.
 
 **Note:** When the switch is not present or has no value, it returns empty string.
-
-#### `commandLine.removeSwitch(switch)`
-
-* `switch` String - A command-line switch
-
-Removes the specified switch from Chromium's command line.
-
-**Note:** This will not affect `process.argv`. The intended usage of this function is to
-control Chromium's behavior.

docs/api/context-bridge.md

@@ -102,8 +102,8 @@ has been included below for completeness:
 | `Boolean` | Simple | ✅ | ✅ | N/A |
 | `Object` | Complex | ✅ | ✅ | Keys must be supported using only "Simple" types in this table.  Values must be supported in this table.  Prototype modifications are dropped.  Sending custom classes will copy values but not the prototype. |
 | `Array` | Complex | ✅ | ✅ | Same limitations as the `Object` type |
-| `Error` | Complex | ✅ | ✅ | Errors that are thrown are also copied, this can result in the message and stack trace of the error changing slightly due to being thrown in a different context, and any custom properties on the Error object [will be lost](https://github.com/electron/electron/issues/25596) |
-| `Promise` | Complex | ✅ | ✅ | N/A
+| `Error` | Complex | ✅ | ✅ | Errors that are thrown are also copied, this can result in the message and stack trace of the error changing slightly due to being thrown in a different context |
+| `Promise` | Complex | ✅ | ✅ | Promises are only proxied if they are the return value or exact parameter.  Promises nested in arrays or objects will be dropped. |
 | `Function` | Complex | ✅ | ✅ | Prototype modifications are dropped.  Sending classes or constructors will not work. |
 | [Cloneable Types](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm) | Simple | ✅ | ✅ | See the linked document on cloneable types |
 | `Element` | Complex | ✅ | ✅ | Prototype modifications are dropped.  Sending custom elements will not work. |

docs/api/cookies.md

@@ -99,7 +99,7 @@ the response.
   * `expirationDate` Double (optional) - The expiration date of the cookie as the number of
     seconds since the UNIX epoch. If omitted then the cookie becomes a session
     cookie and will not be retained between sessions.
-  * `sameSite` String (optional) - The [Same Site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#SameSite_cookies) policy to apply to this cookie.  Can be `unspecified`, `no_restriction`, `lax` or `strict`.  Default is `lax`.
+  * `sameSite` String (optional) - The [Same Site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#SameSite_cookies) policy to apply to this cookie.  Can be `unspecified`, `no_restriction`, `lax` or `strict`.  Default is `no_restriction`.
 
 Returns `Promise<void>` - A promise which resolves when the cookie has been set
 

docs/api/crash-reporter.md

@@ -19,9 +19,6 @@ following projects:
 * [socorro](https://github.com/mozilla/socorro)
 * [mini-breakpad-server](https://github.com/electron/mini-breakpad-server)
 
-> **Note:** Electron uses Crashpad, not Breakpad, to collect and upload
-> crashes, but for the time being, the [upload protocol is the same](https://chromium.googlesource.com/crashpad/crashpad/+/HEAD/doc/overview_design.md#Upload-to-collection-server).
-
 Or use a 3rd party hosted solution:
 
 * [Backtrace](https://backtrace.io/electron/)
@@ -29,12 +26,49 @@ Or use a 3rd party hosted solution:
 * [BugSplat](https://www.bugsplat.com/docs/platforms/electron)
 
 Crash reports are stored temporarily before being uploaded in a directory
-underneath the app's user data directory, called 'Crashpad'. You can override
-this directory by calling `app.setPath('crashDumps', '/path/to/crashes')`
-before starting the crash reporter.
+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.
 
-Electron uses [crashpad](https://chromium.googlesource.com/crashpad/crashpad/+/refs/heads/main/README.md)
-to monitor and report crashes.
+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.
+
+### Note about Node child processes on Linux
+
+If you are using the Node.js `child_process` module and want to report crashes
+from those processes on Linux, there is an extra step you will need to take to
+properly initialize the crash reporter in the child process. This is not
+necessary on Mac or Windows, as those platforms use Crashpad, which
+automatically monitors child processes.
+
+Since `require('electron')` is not available in Node child processes, the
+following APIs are available on the `process` object in Node child processes.
+Note that, on Linux, each Node child process has its own separate instance of
+the breakpad crash reporter. This is dissimilar to renderer child processes,
+which have a "stub" breakpad reporter which returns information to the main
+process for reporting.
+
+#### `process.crashReporter.start(options)`
+
+See [`crashReporter.start()`](#crashreporterstartoptions).
+
+#### `process.crashReporter.getParameters()`
+
+See [`crashReporter.getParameters()`](#crashreportergetparameters).
+
+#### `process.crashReporter.addExtraParameter(key, value)`
+
+See [`crashReporter.addExtraParameter(key, value)`](#crashreporteraddextraparameterkey-value).
+
+#### `process.crashReporter.removeExtraParameter(key)`
+
+See [`crashReporter.removeExtraParameter(key)`](#crashreporterremoveextraparameterkey).
 
 ## Methods
 
@@ -152,6 +186,12 @@ names must be no longer than 39 bytes, and values must be no longer than 20320
 bytes. Keys with names longer than the maximum will be silently ignored. Key
 values longer than the maximum length will be truncated.
 
+**Note:** On linux values that are longer than 127 bytes will be chunked into
+multiple keys, each 127 bytes in length.  E.g. `addExtraParameter('foo', 'a'.repeat(130))`
+will result in two chunked keys `foo__1` and `foo__2`, the first will contain
+the first 127 bytes and the second will contain the remaining 3 bytes.  On
+your crash reporting backend you should stitch together keys in this format.
+
 ### `crashReporter.removeExtraParameter(key)`
 
 * `key` String - Parameter key, must be no longer than 39 bytes.
@@ -163,32 +203,6 @@ will not include this parameter.
 
 Returns `Record<String, String>` - The current 'extra' parameters of the crash reporter.
 
-## In Node child processes
-
-Since `require('electron')` is not available in Node child processes, the
-following APIs are available on the `process` object in Node child processes.
-
-#### `process.crashReporter.start(options)`
-
-See [`crashReporter.start()`](#crashreporterstartoptions).
-
-Note that if the crash reporter is started in the main process, it will
-automatically monitor child processes, so it should not be started in the child
-process. Only use this method if the main process does not initialize the crash
-reporter.
-
-#### `process.crashReporter.getParameters()`
-
-See [`crashReporter.getParameters()`](#crashreportergetparameters).
-
-#### `process.crashReporter.addExtraParameter(key, value)`
-
-See [`crashReporter.addExtraParameter(key, value)`](#crashreporteraddextraparameterkey-value).
-
-#### `process.crashReporter.removeExtraParameter(key)`
-
-See [`crashReporter.removeExtraParameter(key)`](#crashreporterremoveextraparameterkey).
-
 ## Crash Report Payload
 
 The crash reporter will send the following data to the `submitURL` as

docs/api/environment-variables.md

@@ -122,7 +122,7 @@ Prints Chromium's internal logging to the console.
 
 Setting this variable is the same as passing `--enable-logging`
 on the command line. For more info, see `--enable-logging` in [command-line
-switches](./command-line-switches.md#--enable-loggingfile).
+switches](./command-line-switches.md#enable-loggingfile).
 
 ### `ELECTRON_LOG_FILE`
 
@@ -130,7 +130,7 @@ Sets the file destination for Chromium's internal logging.
 
 Setting this variable is the same as passing `--log-file`
 on the command line. For more info, see `--log-file` in [command-line
-switches](./command-line-switches.md#--log-filepath).
+switches](./command-line-switches.md#log-filepath).
 
 ### `ELECTRON_DEBUG_DRAG_REGIONS`
 

docs/api/extensions.md

@@ -100,8 +100,6 @@ The following methods of `chrome.tabs` are supported:
 
 - `chrome.tabs.sendMessage`
 - `chrome.tabs.executeScript`
-- `chrome.tabs.update` (partial support)
-  - supported properties: `url`, `muted`.
 
 > **Note:** In Chrome, passing `-1` as a tab ID signifies the "currently active
 > tab". Since Electron has no such concept, passing `-1` as a tab ID is not

docs/api/frameless-window.md

@@ -0,0 +1,221 @@
+# Frameless Window
+
+> Open a window without toolbars, borders, or other graphical "chrome".
+
+A frameless window is a window that has no
+[chrome](https://developer.mozilla.org/en-US/docs/Glossary/Chrome), the parts of
+the window, like toolbars, that are not a part of the web page. These are
+options on the [`BrowserWindow`](browser-window.md) class.
+
+## Create a frameless window
+
+To create a frameless window, you need to set `frame` to `false` in
+[BrowserWindow](browser-window.md)'s `options`:
+
+```javascript
+const { BrowserWindow } = require('electron')
+const win = new BrowserWindow({ width: 800, height: 600, frame: false })
+win.show()
+```
+
+### Alternatives
+
+There's an alternative way to specify a chromeless window on macOS and Windows.
+Instead of setting `frame` to `false` which disables both the titlebar and window controls,
+you may want to have the title bar hidden and your content extend to the full window size,
+yet still preserve the window controls ("traffic lights" on macOS) for standard window actions.
+You can do so by specifying the `titleBarStyle` option:
+
+#### `hidden`
+
+Results in a hidden title bar and a full size content window. On macOS, the title bar still has the standard window controls (“traffic lights”) in the top left.
+
+```javascript
+const { BrowserWindow } = require('electron')
+const win = new BrowserWindow({ titleBarStyle: 'hidden' })
+win.show()
+```
+
+### Alternatives on macOS
+
+#### `hiddenInset`
+
+Results in a hidden title bar with an alternative look where the traffic light buttons are slightly more inset from the window edge.
+
+```javascript
+const { BrowserWindow } = require('electron')
+const win = new BrowserWindow({ titleBarStyle: 'hiddenInset' })
+win.show()
+```
+
+#### `customButtonsOnHover`
+
+Uses custom drawn close, and miniaturize buttons that display
+when hovering in the top left of the window. The fullscreen button
+is not available due to restrictions of frameless windows as they
+interface with Apple's macOS window masks. These custom buttons prevent
+issues with mouse events that occur with the standard window toolbar buttons.
+This option is only applicable for frameless windows.
+
+```javascript
+const { BrowserWindow } = require('electron')
+const win = new BrowserWindow({ titleBarStyle: 'customButtonsOnHover', frame: false })
+win.show()
+```
+
+## Windows Control Overlay
+
+When using a frameless window in conjuction with `win.setWindowButtonVisibility(true)` on macOS, using one of the `titleBarStyle`s as described above so
+that the traffic lights are visible, or using `titleBarStyle: hidden` on Windows, you can access the Window Controls Overlay [JavaScript APIs][overlay-javascript-apis] and
+[CSS Environment Variables][overlay-css-env-vars] by setting the `titleBarOverlay` option to true. Specifying `true` will result in an overlay with default system colors.
+
+On Windows, you can also specify the color of the overlay and its symbols by setting `titleBarOverlay` to an object with the options `color` and `symbolColor`. If an option is not specified, the color will default to its system color for the window control buttons:
+
+```javascript
+const { BrowserWindow } = require('electron')
+const win = new BrowserWindow({
+  titleBarStyle: 'hidden',
+  titleBarOverlay: true
+})
+win.show()
+```
+
+```javascript
+const { BrowserWindow } = require('electron')
+const win = new BrowserWindow({
+  titleBarStyle: 'hidden',
+  titleBarOverlay: {
+    color: '#2f3241',
+    symbolColor: '#74b1be'
+  }
+})
+win.show()
+```
+
+## Transparent window
+
+By setting the `transparent` option to `true`, you can also make the frameless
+window transparent:
+
+```javascript
+const { BrowserWindow } = require('electron')
+const win = new BrowserWindow({ transparent: true, frame: false })
+win.show()
+```
+
+### Limitations
+
+* You can not click through the transparent area. We are going to introduce an
+  API to set window shape to solve this, see
+  [our issue](https://github.com/electron/electron/issues/1335) for details.
+* Transparent windows are not resizable. Setting `resizable` to `true` may make
+  a transparent window stop working on some platforms.
+* The `blur` filter only applies to the web page, so there is no way to apply
+  blur effect to the content below the window (i.e. other applications open on
+  the user's system).
+* The window will not be transparent when DevTools is opened.
+* On Windows operating systems,
+  * transparent windows will not work when DWM is
+  disabled.
+  * transparent windows can not be maximized using the Windows system menu or by double clicking the title bar. The reasoning behind this can be seen on [this pull request](https://github.com/electron/electron/pull/28207).
+* On Linux, users have to put `--enable-transparent-visuals --disable-gpu` in
+  the command line to disable GPU and allow ARGB to make transparent window,
+  this is caused by an upstream bug that [alpha channel doesn't work on some
+  NVidia drivers](https://bugs.chromium.org/p/chromium/issues/detail?id=369209) on
+  Linux.
+* On Mac, the native window shadow will not be shown on a transparent window.
+
+## Click-through window
+
+To create a click-through window, i.e. making the window ignore all mouse
+events, you can call the [win.setIgnoreMouseEvents(ignore)][ignore-mouse-events]
+API:
+
+```javascript
+const { BrowserWindow } = require('electron')
+const win = new BrowserWindow()
+win.setIgnoreMouseEvents(true)
+```
+
+### Forwarding
+
+Ignoring mouse messages makes the web page oblivious to mouse movement, meaning
+that mouse movement events will not be emitted. On Windows operating systems an
+optional parameter can be used to forward mouse move messages to the web page,
+allowing events such as `mouseleave` to be emitted:
+
+```javascript
+const { ipcRenderer } = require('electron')
+const el = document.getElementById('clickThroughElement')
+el.addEventListener('mouseenter', () => {
+  ipcRenderer.send('set-ignore-mouse-events', true, { forward: true })
+})
+el.addEventListener('mouseleave', () => {
+  ipcRenderer.send('set-ignore-mouse-events', false)
+})
+
+// Main process
+const { ipcMain } = require('electron')
+ipcMain.on('set-ignore-mouse-events', (event, ...args) => {
+  BrowserWindow.fromWebContents(event.sender).setIgnoreMouseEvents(...args)
+})
+```
+
+This makes the web page click-through when over `el`, and returns to normal
+outside it.
+
+## Draggable region
+
+By default, the frameless window is non-draggable. Apps need to specify
+`-webkit-app-region: drag` in CSS to tell Electron which regions are draggable
+(like the OS's standard titlebar), and apps can also use
+`-webkit-app-region: no-drag` to exclude the non-draggable area from the
+ draggable region. Note that only rectangular shapes are currently supported.
+
+Note: `-webkit-app-region: drag` is known to have problems while the developer tools are open. See this [GitHub issue](https://github.com/electron/electron/issues/3647) for more information including a workaround.
+
+To make the whole window draggable, you can add `-webkit-app-region: drag` as
+`body`'s style:
+
+```html
+<body style="-webkit-app-region: drag">
+</body>
+```
+
+And note that if you have made the whole window draggable, you must also mark
+buttons as non-draggable, otherwise it would be impossible for users to click on
+them:
+
+```css
+button {
+  -webkit-app-region: no-drag;
+}
+```
+
+If you're only setting a custom titlebar as draggable, you also need to make all
+buttons in titlebar non-draggable.
+
+## Text selection
+
+In a frameless window the dragging behavior may conflict with selecting text.
+For example, when you drag the titlebar you may accidentally select the text on
+the titlebar. To prevent this, you need to disable text selection within a
+draggable area like this:
+
+```css
+.titlebar {
+  -webkit-user-select: none;
+  -webkit-app-region: drag;
+}
+```
+
+## Context menu
+
+On some platforms, the draggable area will be treated as a non-client frame, so
+when you right click on it a system menu will pop up. To make the context menu
+behave correctly on all platforms you should never use a custom context menu on
+draggable areas.
+
+[ignore-mouse-events]: browser-window.md#winsetignoremouseeventsignore-options
+[overlay-javascript-apis]: https://github.com/WICG/window-controls-overlay/blob/main/explainer.md#javascript-apis
+[overlay-css-env-vars]: https://github.com/WICG/window-controls-overlay/blob/main/explainer.md#css-environment-variables

docs/api/session.md

@@ -297,35 +297,6 @@ app.whenReady().then(() => {
     width: 800,
     height: 600
   })
-
-  win.webContents.session.setPermissionCheckHandler((webContents, permission, requestingOrigin, details) => {
-    if (permission === 'serial') {
-      // Add logic here to determine if permission should be given to allow serial selection
-      return true
-    }
-    return false
-  })
-
-  // Optionally, retrieve previously persisted devices from a persistent store
-  const grantedDevices = fetchGrantedDevices()
-
-  win.webContents.session.setDevicePermissionHandler((details) => {
-    if (new URL(details.origin).hostname === 'some-host' && details.deviceType === 'serial') {
-      if (details.device.vendorId === 123 && details.device.productId === 345) {
-        // Always allow this type of device (this allows skipping the call to `navigator.serial.requestPort` first)
-        return true
-      }
-
-      // Search through the list of devices that have previously been granted permission
-      return grantedDevices.some((grantedDevice) => {
-        return grantedDevice.vendorId === details.device.vendorId &&
-              grantedDevice.productId === details.device.productId &&
-              grantedDevice.serialNumber && grantedDevice.serialNumber === details.device.serialNumber
-      })
-    }
-    return false
-  })
-
   win.webContents.session.on('select-serial-port', (event, portList, webContents, callback) => {
     event.preventDefault()
     const selectedPort = portList.find((device) => {
@@ -562,8 +533,7 @@ the original network configuration.
     * `hostname` String
     * `certificate` [Certificate](structures/certificate.md)
     * `validatedCertificate` [Certificate](structures/certificate.md)
-    * `isIssuedByKnownRoot` Boolean - `true` if Chromium recognises the root CA as a standard root. If it isn't then it's probably the case that this certificate was generated by a MITM proxy whose root has been installed locally (for example, by a corporate proxy). This should not be trusted if the `verificationResult` is not `OK`.
-    * `verificationResult` String - `OK` if the certificate is trusted, otherwise an error like `CERT_REVOKED`.
+    * `verificationResult` String - Verification result from chromium.
     * `errorCode` Integer - Error code.
   * `callback` Function
     * `verificationResult` Integer - Value can be one of certificate error codes
@@ -618,7 +588,6 @@ win.webContents.session.setCertificateVerifyProc((request, callback) => {
     * `permissionGranted` Boolean - Allow or deny the permission.
   * `details` Object - Some properties are only available on certain permission types.
     * `externalURL` String (optional) - The url of the `openExternal` request.
-    * `securityOrigin` String (optional) - The security origin of the `media` request.
     * `mediaTypes` String[] (optional) - The types of media access being requested, elements can be `video`
       or `audio`
     * `requestingUrl` String - The last URL the requesting frame loaded
@@ -677,9 +646,9 @@ session.fromPartition('some-partition').setPermissionCheckHandler((webContents,
 
 * `handler` Function\<Boolean> | null
   * `details` Object
-    * `deviceType` String - The type of device that permission is being requested on, can be `hid` or `serial`.
+    * `deviceType` String - The type of device that permission is being requested on, can be `hid`.
     * `origin` String - The origin URL of the device permission check.
-    * `device` [HIDDevice](structures/hid-device.md) | [SerialPort](structures/serial-port.md)- the device that permission is being requested for.
+    * `device` [HIDDevice](structures/hid-device.md) - the device that permission is being requested for.
     * `frame` [WebFrameMain](web-frame-main.md) - WebFrameMain checking the device permission.
 
 Sets the handler which can be used to respond to device permission checks for the `session`.
@@ -704,8 +673,6 @@ app.whenReady().then(() => {
     if (permission === 'hid') {
       // Add logic here to determine if permission should be given to allow HID selection
       return true
-    } else if (permission === 'serial') {
-      // Add logic here to determine if permission should be given to allow serial port selection
     }
     return false
   })
@@ -726,11 +693,6 @@ app.whenReady().then(() => {
               grantedDevice.productId === details.device.productId &&
               grantedDevice.serialNumber && grantedDevice.serialNumber === details.device.serialNumber
       })
-    } else if (details.deviceType === 'serial') {
-      if (details.device.vendorId === 123 && details.device.productId === 345) {
-        // Always allow this type of device (this allows skipping the call to `navigator.hid.requestDevice` first)
-        return true
-      }
     }
     return false
   })
@@ -903,10 +865,8 @@ setting with the current OS locale.  This setting is persisted across restarts.
 By default Electron will download hunspell dictionaries from the Chromium CDN.  If you want to override this
 behavior you can use this API to point the dictionary downloader at your own hosted version of the hunspell
 dictionaries.  We publish a `hunspell_dictionaries.zip` file with each release which contains the files you need
-to host here.
-
-The file server must be **case insensitive**. If you cannot do this, you must upload each file twice: once with
-the case it has in the ZIP file and once with the filename as all lowercase.
+to host here, the file server must be **case insensitive** you must upload each file twice, once with the case it
+has in the ZIP file and once with the filename as all lower case.
 
 If the files present in `hunspell_dictionaries.zip` are available at `https://example.com/dictionaries/language-code.bdic`
 then you should call this api with `ses.setSpellCheckerDictionaryDownloadURL('https://example.com/dictionaries/')`.  Please

docs/api/web-contents.md

@@ -736,8 +736,6 @@ first available device will be selected. `callback` should be called with
 `deviceId` to be selected, passing empty string to `callback` will
 cancel the request.
 
-If no event listener is added for this event, all bluetooth requests will be cancelled.
-
 ```javascript
 const { app, BrowserWindow } = require('electron')
 
@@ -1496,8 +1494,8 @@ win.loadURL('http://github.com')
 
 win.webContents.on('did-finish-load', () => {
   // Use default printing options
-  const pdfPath = path.join(os.homedir(), 'Desktop', 'temp.pdf')
   win.webContents.printToPDF({}).then(data => {
+    const pdfPath = path.join(os.homedir(), 'Desktop', 'temp.pdf')
     fs.writeFile(pdfPath, data, (error) => {
       if (error) throw error
       console.log(`Wrote PDF successfully to ${pdfPath}`)
@@ -1612,7 +1610,7 @@ app.whenReady().then(() => {
 
 * `options` Object (optional)
   * `mode` String - Opens the devtools with specified dock state, can be
-    `left`, `right`, `bottom`, `undocked`, `detach`. Defaults to last used dock state.
+    `right`, `bottom`, `undocked`, `detach`. Defaults to last used dock state.
     In `undocked` mode it's possible to dock back. In `detach` mode it's not.
   * `activate` Boolean (optional) - Whether to bring the opened devtools window
     to the foreground. The default is `true`.
@@ -1840,7 +1838,7 @@ the cursor when dragging.
 
 #### `contents.savePage(fullPath, saveType)`
 
-* `fullPath` String - The absolute file path.
+* `fullPath` String - The full file path.
 * `saveType` String - Specify the save type.
   * `HTMLOnly` - Save only the HTML of the page.
   * `HTMLComplete` - Save complete-html page.

docs/api/web-frame.md

@@ -5,8 +5,8 @@
 Process: [Renderer](../glossary.md#renderer-process)
 
 `webFrame` export of the Electron module is an instance of the `WebFrame`
-class representing the current frame. Sub-frames can be retrieved by
-certain properties and methods (e.g. `webFrame.firstChild`).
+class representing the top frame of the current `BrowserWindow`. Sub-frames can
+be retrieved by certain properties and methods (e.g. `webFrame.firstChild`).
 
 An example of zooming current page to 200%.
 

docs/api/webview-tag.md

@@ -1025,78 +1025,3 @@ Emitted when DevTools is focused / opened.
 
 [runtime-enabled-features]: https://cs.chromium.org/chromium/src/third_party/blink/renderer/platform/runtime_enabled_features.json5?l=70
 [chrome-webview]: https://developer.chrome.com/docs/extensions/reference/webviewTag/
-
-### Event: 'context-menu'
-
-Returns:
-
-* `params` Object
-  * `x` Integer - x coordinate.
-  * `y` Integer - y coordinate.
-  * `linkURL` String - URL of the link that encloses the node the context menu
-    was invoked on.
-  * `linkText` String - Text associated with the link. May be an empty
-    string if the contents of the link are an image.
-  * `pageURL` String - URL of the top level page that the context menu was
-    invoked on.
-  * `frameURL` String - URL of the subframe that the context menu was invoked
-    on.
-  * `srcURL` String - Source URL for the element that the context menu
-    was invoked on. Elements with source URLs are images, audio and video.
-  * `mediaType` String - Type of the node the context menu was invoked on. Can
-    be `none`, `image`, `audio`, `video`, `canvas`, `file` or `plugin`.
-  * `hasImageContents` Boolean - Whether the context menu was invoked on an image
-    which has non-empty contents.
-  * `isEditable` Boolean - Whether the context is editable.
-  * `selectionText` String - Text of the selection that the context menu was
-    invoked on.
-  * `titleText` String - Title text of the selection that the context menu was
-    invoked on.
-  * `altText` String - Alt text of the selection that the context menu was
-    invoked on.
-  * `suggestedFilename` String - Suggested filename to be used when saving file through 'Save
-    Link As' option of context menu.
-  * `selectionRect` [Rectangle](structures/rectangle.md) - Rect representing the coordinates in the document space of the selection.
-  * `selectionStartOffset` Number - Start position of the selection text.
-  * `referrerPolicy` [Referrer](structures/referrer.md) - The referrer policy of the frame on which the menu is invoked.
-  * `misspelledWord` String - The misspelled word under the cursor, if any.
-  * `dictionarySuggestions` String[] - An array of suggested words to show the
-    user to replace the `misspelledWord`.  Only available if there is a misspelled
-    word and spellchecker is enabled.
-  * `frameCharset` String - The character encoding of the frame on which the
-    menu was invoked.
-  * `inputFieldType` String - If the context menu was invoked on an input
-    field, the type of that field. Possible values are `none`, `plainText`,
-    `password`, `other`.
-  * `spellcheckEnabled` Boolean - If the context is editable, whether or not spellchecking is enabled.
-  * `menuSourceType` String - Input source that invoked the context menu.
-    Can be `none`, `mouse`, `keyboard`, `touch`, `touchMenu`, `longPress`, `longTap`, `touchHandle`, `stylus`, `adjustSelection`, or `adjustSelectionReset`.
-  * `mediaFlags` Object - The flags for the media element the context menu was
-    invoked on.
-    * `inError` Boolean - Whether the media element has crashed.
-    * `isPaused` Boolean - Whether the media element is paused.
-    * `isMuted` Boolean - Whether the media element is muted.
-    * `hasAudio` Boolean - Whether the media element has audio.
-    * `isLooping` Boolean - Whether the media element is looping.
-    * `isControlsVisible` Boolean - Whether the media element's controls are
-      visible.
-    * `canToggleControls` Boolean - Whether the media element's controls are
-      toggleable.
-    * `canPrint` Boolean - Whether the media element can be printed.
-    * `canSave` Boolean - Whether or not the media element can be downloaded.
-    * `canShowPictureInPicture` Boolean - Whether the media element can show picture-in-picture.
-    * `isShowingPictureInPicture` Boolean - Whether the media element is currently showing picture-in-picture.
-    * `canRotate` Boolean - Whether the media element can be rotated.
-    * `canLoop` Boolean - Whether the media element can be looped.
-  * `editFlags` Object - These flags indicate whether the renderer believes it
-    is able to perform the corresponding action.
-    * `canUndo` Boolean - Whether the renderer believes it can undo.
-    * `canRedo` Boolean - Whether the renderer believes it can redo.
-    * `canCut` Boolean - Whether the renderer believes it can cut.
-    * `canCopy` Boolean - Whether the renderer believes it can copy.
-    * `canPaste` Boolean - Whether the renderer believes it can paste.
-    * `canDelete` Boolean - Whether the renderer believes it can delete.
-    * `canSelectAll` Boolean - Whether the renderer believes it can select all.
-    * `canEditRichly` Boolean - Whether the renderer believes it can edit text richly.
-
-Emitted when there is a new context menu that needs to be handled.

docs/api/window-open.md

@@ -64,9 +64,6 @@ window.open('https://github.com', '_blank', 'top=500,left=200,frame=false,nodeIn
   `features` will be passed to any registered `webContents`'s
   `did-create-window` event handler in the `options` argument.
 * `frameName` follows the specification of `windowName` located in the [native documentation](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#parameters).
-* When opening `about:blank`, the child window's `WebPreferences` will be copied
-  from the parent window, and there is no way to override it because Chromium
-  skips browser side navigation in this case.
 
 To customize or cancel the creation of the window, you can optionally set an
 override handler with `webContents.setWindowOpenHandler()` from the main

docs/breaking-changes.md

@@ -12,75 +12,6 @@ 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 (17.0)
-
-### Removed: `desktopCapturer.getSources` in the renderer
-
-The `desktopCapturer.getSources` API is now only available in the main process.
-This has been changed in order to improve the default security of Electron
-apps.
-
-If you need this functionality, it can be replaced as follows:
-
-```js
-// Main process
-const { ipcMain, desktopCapturer } = require('electron')
-
-ipcMain.handle(
-  'DESKTOP_CAPTURER_GET_SOURCES',
-  (event, opts) => desktopCapturer.getSources(opts)
-)
-```
-
-```js
-// Renderer process
-const { ipcRenderer } = require('electron')
-
-const desktopCapturer = {
-  getSources: (opts) => ipcRenderer.invoke('DESKTOP_CAPTURER_GET_SOURCES', opts)
-}
-```
-
-However, you should consider further restricting the information returned to
-the renderer; for instance, displaying a source selector to the user and only
-returning the selected source.
-
-## Planned Breaking API Changes (16.0)
-
-### Behavior Changed: `crashReporter` implementation switched to Crashpad on Linux
-
-The underlying implementation of the `crashReporter` API on Linux has changed
-from Breakpad to Crashpad, bringing it in line with Windows and Mac. As a
-result of this, child processes are now automatically monitored, and calling
-`process.crashReporter.start` in Node child processes is no longer needed (and
-is not advisable, as it will start a second instance of the Crashpad reporter).
-
-There are also some subtle changes to how annotations will be reported on
-Linux, including that long values will no longer be split between annotations
-appended with `__1`, `__2` and so on, and instead will be truncated at the
-(new, longer) annotation value limit.
-
-### Deprecated: `desktopCapturer.getSources` in the renderer
-
-Usage of the `desktopCapturer.getSources` API in the renderer has been
-deprecated and will be removed. This change improves the default security of
-Electron apps.
-
-See [here](#removed-desktopcapturergetsources-in-the-renderer) for details on
-how to replace this API in your app.
-
-## Planned Breaking API Changes (15.0)
-
-### Default Changed: `nativeWindowOpen` defaults to `true`
-
-Prior to Electron 15, `window.open` was by default shimmed to use
-`BrowserWindowProxy`. This meant that `window.open('about:blank')` did not work
-to open synchronously scriptable child windows, among other incompatibilities.
-`nativeWindowOpen` is no longer experimental, and is now the default.
-
-See the documentation for [window.open in Electron](api/window-open.md)
-for more details.
-
 ## Planned Breaking API Changes (14.0)
 
 ### Removed: `remote` module
@@ -131,6 +62,16 @@ ensure your code works with this property enabled.  It has been enabled by defau
 
 You will be affected by this change if you use either `webFrame.executeJavaScript` or `webFrame.executeJavaScriptInIsolatedWorld`. You will need to ensure that values returned by either of those methods are supported by the [Context Bridge API](api/context-bridge.md#parameter--error--return-type-support) as these methods use the same value passing semantics.
 
+### Default Changed: `nativeWindowOpen` defaults to `true`
+
+Prior to Electron 14, `window.open` was by default shimmed to use
+`BrowserWindowProxy`. This meant that `window.open('about:blank')` did not work
+to open synchronously scriptable child windows, among other incompatibilities.
+`nativeWindowOpen` is no longer experimental, and is now the default.
+
+See the documentation for [window.open in Electron](api/window-open.md)
+for more details.
+
 ### Removed: BrowserWindowConstructorOptions inheriting from parent windows
 
 Prior to Electron 14, windows opened with `window.open` would inherit

docs/development/build-instructions-gn.md

@@ -85,37 +85,42 @@ $ gclient sync -f
 
 ## Building
 
-**Set the environment variable for chromium build tools**
-
-On Linux & MacOS
-
 ```sh
 $ cd src
 $ export CHROMIUM_BUILDTOOLS_PATH=`pwd`/buildtools
+$ gn gen out/Testing --args="import(\"//electron/build/args/testing.gn\") $GN_EXTRA_ARGS"
 ```
 
-On Windows:
+Or on Windows (without the optional argument):
 
 ```sh
 $ cd src
 $ set CHROMIUM_BUILDTOOLS_PATH=%cd%\buildtools
-```
-
-**To generate Testing build config of Electron:**
-
-```sh
 $ gn gen out/Testing --args="import(\"//electron/build/args/testing.gn\")"
 ```
 
-**To generate Release build config of Electron:**
+This will generate a build directory `out/Testing` under `src/` with
+the testing build configuration. You can replace `Testing` with another name,
+but it should be a subdirectory of `out`.
+Also you shouldn't have to run `gn gen` again—if you want to change the
+build arguments, you can run `gn args out/Testing` to bring up an editor.
+
+To see the list of available build configuration options, run `gn args
+out/Testing --list`.
+
+**For generating Testing build config of
+Electron:**
 
 ```sh
-$ gn gen out/Release --args="import(\"//electron/build/args/release.gn\")"
+$ gn gen out/Testing --args="import(\"//electron/build/args/testing.gn\") $GN_EXTRA_ARGS"
 ```
 
-**Note:** This will generate a `out/Testing` or `out/Release` build directory under `src/` with the testing or release build depending upon the configuration passed above. You can replace `Testing|Release` with another names, but it should be a subdirectory of `out`.
+**For generating Release (aka "non-component" or "static") build config of
+Electron:**
 
-Also you shouldn't have to run `gn gen` again—if you want to change the build arguments, you can run `gn args out/Testing` to bring up an editor. To see the list of available build configuration options, run `gn args out/Testing --list`.
+```sh
+$ gn gen out/Release --args="import(\"//electron/build/args/release.gn\") $GN_EXTRA_ARGS"
+```
 
 **To build, run `ninja` with the `electron` target:**
 Nota Bene: This will also take a while and probably heat up your lap.
@@ -151,13 +156,13 @@ $ ./out/Testing/electron
 On linux, first strip the debugging and symbol information:
 
 ```sh
-$ electron/script/strip-binaries.py -d out/Release
+electron/script/strip-binaries.py -d out/Release
 ```
 
 To package the electron build as a distributable zip file:
 
 ```sh
-$ ninja -C out/Release electron:electron_dist_zip
+ninja -C out/Release electron:electron_dist_zip
 ```
 
 ### Cross-compiling

docs/development/creating-api.md

@@ -1,171 +0,0 @@
-# Creating a New Electron Browser Module
-
-Welcome to the Electron API guide! If you are unfamiliar with creating a new Electron API module within the [`browser`](https://github.com/electron/electron/tree/main/shell/browser) directory, this guide serves as a checklist for some of the necessary steps that you will need to implement.
-
-This is not a comprehensive end-all guide to creating an Electron Browser API, rather an outline documenting some of the more unintuitive steps.
-
-## Add your files to Electron's project configuration
-
-Electron uses [GN](https://gn.googlesource.com/gn) as a meta build system to generate files for its compiler, [Ninja](https://ninja-build.org/). This means that in order to tell Electron to compile your code, we have to add your API's code and header file names into [`filenames.gni`](https://github.com/electron/electron/blob/main/filenames.gni).
-
-You will need to append your API file names alphabetically into the appropriate files like so:
-
-```cpp title='filenames.gni'
-lib_sources = [
-    "path/to/api/api_name.cc",
-    "path/to/api/api_name.h",
-]
-
-lib_sources_mac = [
-    "path/to/api/api_name_mac.h",
-    "path/to/api/api_name_mac.mm",
-]
-
-lib_sources_win = [
-    "path/to/api/api_name_win.cc",
-    "path/to/api/api_name_win.h",
-]
-
-lib_sources_linux = [
-    "path/to/api/api_name_linux.cc",
-    "path/to/api/api_name_linux.h",
-]
-```
-
-Note that the Windows, macOS and Linux array additions are optional and should only be added if your API has specific platform implementations.
-
-## Create API documentation
-
-Type definitions are generated by Electron using [`@electron/docs-parser`](https://github.com/electron/docs-parser) and [`@electron/typescript-definitions`](https://github.com/electron/typescript-definitions). This step is necessary to ensure consistency across Electron's API documentation. This means that for your API type definition to appear in the `electron.d.ts` file, we must create a `.md` file. Examples can be found in [this folder](https://github.com/electron/electron/tree/main/docs/api).
-
-## Set up `ObjectTemplateBuilder` and `Wrappable`
-
-Electron constructs its modules using [`object_template_builder`](https://www.electronjs.org/blog/from-native-to-js#mateobjecttemplatebuilder).
-
-[`wrappable`](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/gin/wrappable.h) is a base class for C++ objects that have corresponding v8 wrapper objects.
-
-Here is a basic example of code that you may need to add, in order to incorporate `object_template_builder` and `wrappable` into your API. For further reference, you can find more implementations [here](https://github.com/electron/electron/tree/main/shell/browser/api).
-
-In your `api_name.h` file:
-
-```cpp title='api_name.h'
-
-#ifndef SHELL_BROWSER_API_ELECTRON_API_{API_NAME}_H_
-#define SHELL_BROWSER_API_ELECTRON_API_{API_NAME}_H_
-
-#include "gin/handle.h"
-#include "gin/wrappable.h"
-
-namespace electron {
-
-namespace api {
-
-class ApiName : public gin::Wrappable<ApiName>  {
- public:
-  static gin::Handle<ApiName> Create(v8::Isolate* isolate);
-
-  // gin::Wrappable
-  static gin::WrapperInfo kWrapperInfo;
-  gin::ObjectTemplateBuilder GetObjectTemplateBuilder(
-      v8::Isolate* isolate) override;
-  const char* GetTypeName() override;
-} // namespace api
-} // namespace electron
-```
-
-In your `api_name.cc` file:
-
-```cpp title='api_name.cc'
-#include "shell/browser/api/electron_api_safe_storage.h"
-
-#include "shell/browser/browser.h"
-#include "shell/common/gin_converters/base_converter.h"
-#include "shell/common/gin_converters/callback_converter.h"
-#include "shell/common/gin_helper/dictionary.h"
-#include "shell/common/gin_helper/object_template_builder.h"
-#include "shell/common/node_includes.h"
-#include "shell/common/platform_util.h"
-
-namespace electron {
-
-namespace api {
-
-gin::WrapperInfo ApiName::kWrapperInfo = {gin::kEmbedderNativeGin};
-
-gin::ObjectTemplateBuilder ApiName::GetObjectTemplateBuilder(
-    v8::Isolate* isolate) {
-  return gin::ObjectTemplateBuilder(isolate)
-      .SetMethod("methodName", &ApiName::methodName);
-}
-
-const char* ApiName::GetTypeName() {
-  return "ApiName";
-}
-
-// static
-gin::Handle<ApiName> ApiName::Create(v8::Isolate* isolate) {
-  return gin::CreateHandle(isolate, new ApiName());
-}
-
-} // namespace api
-
-} // namespace electron
-
-namespace {
-
-void Initialize(v8::Local<v8::Object> exports,
-                v8::Local<v8::Value> unused,
-                v8::Local<v8::Context> context,
-                void* priv) {
-  v8::Isolate* isolate = context->GetIsolate();
-  gin_helper::Dictionary dict(isolate, exports);
-  dict.Set("apiName", electron::api::ApiName::Create(isolate));
-}
-
-}  // namespace
-```
-
-## Link your Electron API with Node
-
-In the [`typings/internal-ambient.d.ts`](https://github.com/electron/electron/blob/main/typings/internal-ambient.d.ts) file, we need to append a new property onto the `Process` interface like so:
-
-```ts title='typings/internal-ambient.d.ts'
-interface Process {
-    _linkedBinding(name: 'electron_browser_{api_name}', Electron.ApiName);
-}
-```
-
-At the very bottom of your `api_name.cc` file:
-
-```cpp title='api_name.cc'
-NODE_LINKED_MODULE_CONTEXT_AWARE(electron_browser_{api_name},Initialize)
-```
-
-In your [`shell/common/node_bindings.cc`](https://github.com/electron/electron/blob/main/shell/common/node_bindings.cc) file, add your node binding name to Electron's built-in modules.
-
-```cpp title='shell/common/node_bindings.cc'
-#define ELECTRON_BUILTIN_MODULES(V)      \
-  V(electron_browser_{api_name})
-```
-
-> Note: More technical details on how Node links with Electron can be found on [our blog](https://www.electronjs.org/blog/electron-internals-using-node-as-a-library#link-node-with-electron).
-
-## Expose your API to TypeScript
-
-### Export your API as a module
-
-We will need to create a new TypeScript file in the path that follows:
-
-`"lib/browser/api/{electron_browser_{api_name}}.ts"`
-
-An example of the contents of this file can be found [here](https://github.com/electron/electron/blob/main/lib/browser/api/native-image.ts).
-
-### Expose your module to TypeScript
-
-Add your module to the module list found at `"lib/browser/api/module-list.ts"` like so:
-
-```typescript title='lib/browser/api/module-list.ts'
-export const browserModuleList: ElectronInternal.ModuleEntry[] = [
-  { name: 'apiName', loader: () => require('./api-name') },
-];
-```

docs/development/setting-up-symbol-server.md

@@ -43,9 +43,8 @@ SRV*c:\code\symbols\*https://msdl.microsoft.com/download/symbols;SRV*c:\code\sym
 
 ## Using the symbol server in Visual Studio
 
-![Tools -> Options](../images/vs-tools-options.png)
-
-![Symbols Settings](../images/vs-options-debugging-symbols.png)
+![Tools -> Options](https://mdn.mozillademos.org/files/733/symbol-server-vc8express-menu.jpg)
+![Symbols Settings](https://mdn.mozillademos.org/files/2497/2005_options.gif)
 
 ## Troubleshooting: Symbols will not load
 

docs/fiddles/windows/manage-windows/frameless-window/index.html

@@ -59,9 +59,8 @@
 
           <p>
             For more details, see the
-            <a href="https://electronjs.org/docs/tutorial/window-customization/">
-              Window Customization
-
+            <a href="https://electronjs.org/docs/api/frameless-window/">
+              Frameless Window
             </a>
             documentation.
           </p>

docs/tutorial/accessibility.md

@@ -1,7 +1,48 @@
 # Accessibility
 
+Making accessible applications is important and we're happy to provide
+functionality to [Devtron][devtron] and [Spectron][spectron] that gives
+developers the opportunity to make their apps better for everyone.
+
+---
+
 Accessibility concerns in Electron applications are similar to those of
-websites because they're both ultimately HTML.
+websites because they're both ultimately HTML. With Electron apps, however,
+you can't use the online resources for accessibility audits because your app
+doesn't have a URL to point the auditor to.
+
+These features bring those auditing tools to your Electron app. You can
+choose to add audits to your tests with Spectron or use them within DevTools
+with Devtron. Read on for a summary of the tools.
+
+## Spectron
+
+In the testing framework Spectron, you can now audit each window and `<webview>`
+tag in your application. For example:
+
+```javascript
+app.client.auditAccessibility().then(function (audit) {
+  if (audit.failed) {
+    console.error(audit.message)
+  }
+})
+```
+
+You can read more about this feature in [Spectron's documentation][spectron-a11y].
+
+## Devtron
+
+In Devtron, there is an accessibility tab which will allow you to audit a
+page in your app, sort and filter the results.
+
+![devtron screenshot][devtron-screenshot]
+
+Both of these tools are using the [Accessibility Developer Tools][a11y-devtools]
+library built by Google for Chrome. You can learn more about the accessibility
+audit rules this library uses on that [repository's wiki][a11y-devtools-wiki].
+
+If you know of other great accessibility tools for Electron, add them to the
+accessibility documentation with a pull request.
 
 ## Manually enabling accessibility features
 
@@ -43,6 +84,10 @@ CFStringRef kAXManualAccessibility = CFSTR("AXManualAccessibility");
 }
 ```
 
+[devtron]: https://electronjs.org/devtron
+[devtron-screenshot]: https://cloud.githubusercontent.com/assets/1305617/17156618/9f9bcd72-533f-11e6-880d-389115f40a2a.png
+[spectron]: https://electronjs.org/spectron
+[spectron-a11y]: https://github.com/electron/spectron#accessibility-testing
 [a11y-docs]: https://www.chromium.org/developers/design-documents/accessibility#TOC-How-Chrome-detects-the-presence-of-Assistive-Technology
 [a11y-devtools]: https://github.com/GoogleChrome/accessibility-developer-tools
 [a11y-devtools-wiki]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules

docs/tutorial/application-distribution.md

@@ -56,7 +56,7 @@ will then be your distribution to deliver to users.
 
 ### With an app source code archive
 
-Instead of shipping your app by copying all of its source files, you can
+Instead of from shipping your app by copying all of its source files, you can
 package your app into an [asar] archive to improve the performance of reading
 files on platforms like Windows, if you are not already using a bundler such
 as Parcel or Webpack.

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

@@ -0,0 +1,135 @@
+# Automated Testing with a Custom Driver
+
+To write automated tests for your Electron app, you will need a way to "drive" your application. [Spectron](https://electronjs.org/spectron) is a commonly-used solution which lets you emulate user actions via [WebDriver](https://webdriver.io/). However, it's also possible to write your own custom driver using node's builtin IPC-over-STDIO. The benefit of a custom driver is that it tends to require less overhead than Spectron, and lets you expose custom methods to your test suite.
+
+To create a custom driver, we'll use Node.js' [child_process](https://nodejs.org/api/child_process.html) API. The test suite will spawn the Electron process, then establish a simple messaging protocol:
+
+```js
+const childProcess = require('child_process')
+const electronPath = require('electron')
+
+// spawn the process
+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) => {
+  // ...
+})
+
+// send an IPC message to the app
+appProcess.send({ my: 'message' })
+```
+
+From within the Electron app, you can listen for messages and send replies using the Node.js [process](https://nodejs.org/api/process.html) API:
+
+```js
+// listen for IPC messages from the test suite
+process.on('message', (msg) => {
+  // ...
+})
+
+// send an IPC message to the test suite
+process.send({ my: 'message' })
+```
+
+We can now communicate from the test suite to the Electron app using the `appProcess` object.
+
+For convenience, you may want to wrap `appProcess` in a driver object that provides more high-level functions. Here is an example of how you can do this:
+
+```js
+class TestDriver {
+  constructor ({ path, args, env }) {
+    this.rpcCalls = []
+
+    // start child process
+    env.APP_TEST_DRIVER = 1 // let the app know it should listen for messages
+    this.process = childProcess.spawn(path, args, { stdio: ['inherit', 'inherit', 'inherit', 'ipc'], env })
+
+    // handle rpc responses
+    this.process.on('message', (message) => {
+      // pop the handler
+      const rpcCall = this.rpcCalls[message.msgId]
+      if (!rpcCall) return
+      this.rpcCalls[message.msgId] = null
+      // reject/resolve
+      if (message.reject) rpcCall.reject(message.reject)
+      else rpcCall.resolve(message.resolve)
+    })
+
+    // wait for ready
+    this.isReady = this.rpc('isReady').catch((err) => {
+      console.error('Application failed to start', err)
+      this.stop()
+      process.exit(1)
+    })
+  }
+
+  // simple RPC call
+  // to use: driver.rpc('method', 1, 2, 3).then(...)
+  async rpc (cmd, ...args) {
+    // send rpc request
+    const msgId = this.rpcCalls.length
+    this.process.send({ msgId, cmd, args })
+    return new Promise((resolve, reject) => this.rpcCalls.push({ resolve, reject }))
+  }
+
+  stop () {
+    this.process.kill()
+  }
+}
+```
+
+In the app, you'd need to write a simple handler for the RPC calls:
+
+```js
+if (process.env.APP_TEST_DRIVER) {
+  process.on('message', onMessage)
+}
+
+async function onMessage ({ msgId, cmd, args }) {
+  let method = METHODS[cmd]
+  if (!method) method = () => new Error('Invalid method: ' + cmd)
+  try {
+    const resolve = await method(...args)
+    process.send({ msgId, resolve })
+  } catch (err) {
+    const reject = {
+      message: err.message,
+      stack: err.stack,
+      name: err.name
+    }
+    process.send({ msgId, reject })
+  }
+}
+
+const METHODS = {
+  isReady () {
+    // do any setup needed
+    return true
+  }
+  // define your RPC-able methods here
+}
+```
+
+Then, in your test suite, you can use your test-driver as follows:
+
+```js
+const test = require('ava')
+const electronPath = require('electron')
+
+const app = new TestDriver({
+  path: electronPath,
+  args: ['./app'],
+  env: {
+    NODE_ENV: 'test'
+  }
+})
+test.before(async t => {
+  await app.isReady
+})
+test.after.always('cleanup', async t => {
+  await app.stop()
+})
+```

docs/tutorial/automated-testing.md

@@ -1,409 +0,0 @@
-# Automated Testing
-
-Test automation is an efficient way of validating that your application code works as intended.
-While Electron doesn't actively maintain its own testing solution, this guide will go over a couple
-ways you can run end-to-end automated tests on your Electron app.
-
-## Using the WebDriver interface
-
-From [ChromeDriver - WebDriver for Chrome][chrome-driver]:
-
-> WebDriver is an open source tool for automated testing of web apps across many
-> browsers. It provides capabilities for navigating to web pages, user input,
-> JavaScript execution, and more. ChromeDriver is a standalone server which
-> implements WebDriver's wire protocol for Chromium. It is being developed by
-> members of the Chromium and WebDriver teams.
-
-There are a few ways that you can set up testing using WebDriver.
-
-### With WebdriverIO
-
-[WebdriverIO](https://webdriver.io/) (WDIO) is a test automation framework that provides a
-Node.js package for testing with WebDriver. Its ecosystem also includes various plugins
-(e.g. reporter and services) that can help you put together your test setup.
-
-#### Install the testrunner
-
-First you need to run the WebdriverIO starter toolkit in your project root directory:
-
-```sh npm2yarn
-npx wdio . --yes
-```
-
-This installs all necessary packages for you and generates a `wdio.conf.js` configuration file.
-
-#### Connect WDIO to your Electron app
-
-Update the capabilities in your configuration file to point to your Electron app binary:
-
-```javascript title='wdio.conf.js'
-export.config = {
-  // ...
-  capabilities: [{
-    browserName: 'chrome',
-    'goog:chromeOptions': {
-      binary: '/path/to/your/electron/binary', // Path to your Electron binary.
-      args: [/* cli arguments */] // Optional, perhaps 'app=' + /path/to/your/app/
-    }
-  }]
-  // ...
-}
-```
-
-#### Run your tests
-
-To run your tests:
-
-```sh
-$ npx wdio run wdio.conf.js
-```
-
-### With Selenium
-
-[Selenium](https://www.selenium.dev/) is a web automation framework that
-exposes bindings to WebDriver APIs in many languages. Their Node.js bindings
-are available under the `selenium-webdriver` package on NPM.
-
-#### Run a ChromeDriver server
-
-In order to use Selenium with Electron, you need to download the `electron-chromedriver`
-binary, and run it:
-
-```sh npm2yarn
-npm install --save-dev electron-chromedriver
-./node_modules/.bin/chromedriver
-Starting ChromeDriver (v2.10.291558) on port 9515
-Only local connections are allowed.
-```
-
-Remember the port number `9515`, which will be used later.
-
-#### Connect Selenium to ChromeDriver
-
-Next, install Selenium into your project:
-
-```sh npm2yarn
-npm install --save-dev selenium-webdriver
-```
-
-Usage of `selenium-webdriver` with Electron is the same as with
-normal websites, except that you have to manually specify how to connect
-ChromeDriver and where to find the binary of your Electron app:
-
-```js title='test.js'
-const webdriver = require('selenium-webdriver')
-const driver = new webdriver.Builder()
-  // The "9515" is the port opened by ChromeDriver.
-  .usingServer('http://localhost:9515')
-  .withCapabilities({
-    'goog:chromeOptions': {
-      // Here is the path to your Electron binary.
-      binary: '/Path-to-Your-App.app/Contents/MacOS/Electron'
-    }
-  })
-  .forBrowser('chrome') // note: use .forBrowser('electron') for selenium-webdriver <= 3.6.0
-  .build()
-driver.get('http://www.google.com')
-driver.findElement(webdriver.By.name('q')).sendKeys('webdriver')
-driver.findElement(webdriver.By.name('btnG')).click()
-driver.wait(() => {
-  return driver.getTitle().then((title) => {
-    return title === 'webdriver - Google Search'
-  })
-}, 1000)
-driver.quit()
-```
-
-## Using Playwright
-
-[Microsoft Playwright](https://playwright.dev) is an end-to-end testing framework built
-using browser-specific remote debugging protocols, similar to the [Puppeteer] headless
-Node.js API but geared towards end-to-end testing. Playwright has experimental Electron
-support via Electron's support for the [Chrome DevTools Protocol] (CDP).
-
-### Install dependencies
-
-You can install Playwright through your preferred Node.js package manager. The Playwright team
-recommends using the `PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD` environment variable to avoid
-unnecessary browser downloads when testing an Electron app.
-
-```sh npm2yarn
-PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm install --save-dev playwright
-```
-
-Playwright also comes with its own test runner, Playwright Test, which is built for end-to-end
-testing. You can also install it as a dev dependency in your project:
-
-```sh npm2yarn
-npm install --save-dev @playwright/test
-```
-
-:::caution Dependencies
-This tutorial was written `playwright@1.16.3` and `@playwright/test@1.16.3`. Check out
-[Playwright's releases][playwright-releases] page to learn about
-changes that might affect the code below.
-:::
-
-:::info Using third-party test runners
-If you're interested in using an alternative test runner (e.g. Jest or Mocha), check out
-Playwright's [Third-Party Test Runner][playwright-test-runners] guide.
-:::
-
-### Write your tests
-
-Playwright launches your app in development mode through the `_electron.launch` API.
-To point this API to your Electron app, you can pass the path to your main process
-entry point (here, it is `main.js`).
-
-```js {5}
-const { _electron: electron } = require('playwright')
-const { test } = require('@playwright/test')
-
-test('launch app', async () => {
-  const electronApp = await electron.launch({ args: ['main.js'] })
-  // close app
-  await electronApp.close()
-})
-```
-
-After that, you will access to an instance of Playwright's `ElectronApp` class. This
-is a powerful class that has access to main process modules for example:
-
-```js {6-11}
-const { _electron: electron } = require('playwright')
-const { test } = require('@playwright/test')
-
-test('get isPackaged', async () => {
-  const electronApp = await electron.launch({ args: ['main.js'] })
-  const isPackaged = await electronApp.evaluate(async ({ app }) => {
-    // This runs in Electron's main process, parameter here is always
-    // the result of the require('electron') in the main app script.
-    return app.isPackaged
-  })
-  console.log(isPackaged) // false (because we're in development mode)
-  // close app
-  await electronApp.close()
-})
-```
-
-It can also create individual [Page][playwright-page] objects from Electron BrowserWindow instances.
-For example, to grab the first BrowserWindow and save a screenshot:
-
-```js {6-7}
-const { _electron: electron } = require('playwright')
-const { test } = require('@playwright/test')
-
-test('save screenshot', async () => {
-  const electronApp = await electron.launch({ args: ['main.js'] })
-  const window = await electronApp.firstWindow()
-  await window.screenshot({ path: 'intro.png' })
-  // close app
-  await electronApp.close()
-})
-```
-
-Putting all this together using the PlayWright Test runner, let's create a `example.spec.js`
-test file with a single test and assertion:
-
-```js title='example.spec.js'
-const { _electron: electron } = require('playwright')
-const { test, expect } = require('@playwright/test')
-
-test('example test', async () => {
-  const electronApp = await electron.launch({ args: ['.'] })
-  const isPackaged = await electronApp.evaluate(async ({ app }) => {
-    // This runs in Electron's main process, parameter here is always
-    // the result of the require('electron') in the main app script.
-    return app.isPackaged;
-  });
-
-  expect(isPackaged).toBe(false);
-
-  // Wait for the first BrowserWindow to open
-  // and return its Page object
-  const window = await electronApp.firstWindow()
-  await window.screenshot({ path: 'intro.png' })
-
-  // close app
-  await electronApp.close()
-});
-```
-
-Then, run Playwright Test using `npx playwright test`. You should see the test pass in your
-console, and have an `intro.png` screenshot on your filesystem.
-
-```console
-☁  $ npx playwright test
-
-Running 1 test using 1 worker
-
-  ✓  example.spec.js:4:1 › example test (1s)
-```
-
-:::info
-Playwright Test will automatically run any files matching the `.*(test|spec)\.(js|ts|mjs)` regex.
-You can customize this match in the [Playwright Test configuration options][playwright-test-config].
-:::
-
-:::tip Further reading
-Check out Playwright's documentation for the full [Electron][playwright-electron]
-and [ElectronApplication][playwright-electronapplication] class APIs.
-:::
-
-## Using a custom test driver
-
-It's also possible to write your own custom driver using Node.js' built-in IPC-over-STDIO.
-Custom test drivers require you to write additional app code, but have lower overhead and let you
-expose custom methods to your test suite.
-
-To create a custom driver, we'll use Node.js' [`child_process`](https://nodejs.org/api/child_process.html) API.
-The test suite will spawn the Electron process, then establish a simple messaging protocol:
-
-```js title='testDriver.js'
-const childProcess = require('child_process')
-const electronPath = require('electron')
-
-// spawn the process
-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) => {
-  // ...
-})
-
-// send an IPC message to the app
-appProcess.send({ my: 'message' })
-```
-
-From within the Electron app, you can listen for messages and send replies using the Node.js
-[`process`](https://nodejs.org/api/process.html) API:
-
-```js title='main.js'
-// listen for messages from the test suite
-process.on('message', (msg) => {
-  // ...
-})
-
-// send a message to the test suite
-process.send({ my: 'message' })
-```
-
-We can now communicate from the test suite to the Electron app using the `appProcess` object.
-
-For convenience, you may want to wrap `appProcess` in a driver object that provides more
-high-level functions. Here is an example of how you can do this. Let's start by creating
-a `TestDriver` class:
-
-```js title='testDriver.js'
-class TestDriver {
-  constructor ({ path, args, env }) {
-    this.rpcCalls = []
-
-    // start child process
-    env.APP_TEST_DRIVER = 1 // let the app know it should listen for messages
-    this.process = childProcess.spawn(path, args, { stdio: ['inherit', 'inherit', 'inherit', 'ipc'], env })
-
-    // handle rpc responses
-    this.process.on('message', (message) => {
-      // pop the handler
-      const rpcCall = this.rpcCalls[message.msgId]
-      if (!rpcCall) return
-      this.rpcCalls[message.msgId] = null
-      // reject/resolve
-      if (message.reject) rpcCall.reject(message.reject)
-      else rpcCall.resolve(message.resolve)
-    })
-
-    // wait for ready
-    this.isReady = this.rpc('isReady').catch((err) => {
-      console.error('Application failed to start', err)
-      this.stop()
-      process.exit(1)
-    })
-  }
-
-  // simple RPC call
-  // to use: driver.rpc('method', 1, 2, 3).then(...)
-  async rpc (cmd, ...args) {
-    // send rpc request
-    const msgId = this.rpcCalls.length
-    this.process.send({ msgId, cmd, args })
-    return new Promise((resolve, reject) => this.rpcCalls.push({ resolve, reject }))
-  }
-
-  stop () {
-    this.process.kill()
-  }
-}
-
-module.exports = { TestDriver };
-```
-
-In your app code, can then write a simple handler to receive RPC calls:
-
-```js title='main.js'
-const METHODS = {
-  isReady () {
-    // do any setup needed
-    return true
-  }
-  // define your RPC-able methods here
-}
-
-const onMessage = async ({ msgId, cmd, args }) => {
-  let method = METHODS[cmd]
-  if (!method) method = () => new Error('Invalid method: ' + cmd)
-  try {
-    const resolve = await method(...args)
-    process.send({ msgId, resolve })
-  } catch (err) {
-    const reject = {
-      message: err.message,
-      stack: err.stack,
-      name: err.name
-    }
-    process.send({ msgId, reject })
-  }
-}
-
-if (process.env.APP_TEST_DRIVER) {
-  process.on('message', onMessage)
-}
-```
-
-Then, in your test suite, you can use your `TestDriver` class with the test automation
-framework of your choosing. The following example uses
-[`ava`](https://www.npmjs.com/package/ava), but other popular choices like Jest
-or Mocha would work as well:
-
-```js title='test.js'
-const test = require('ava')
-const electronPath = require('electron')
-const { TestDriver } = require('./testDriver')
-
-const app = new TestDriver({
-  path: electronPath,
-  args: ['./app'],
-  env: {
-    NODE_ENV: 'test'
-  }
-})
-test.before(async t => {
-  await app.isReady
-})
-test.after.always('cleanup', async t => {
-  await app.stop()
-})
-```
-
-[chrome-driver]: https://sites.google.com/chromium.org/driver/
-[Puppeteer]: https://github.com/puppeteer/puppeteer
-[playwright-electron]: https://playwright.dev/docs/api/class-electron/
-[playwright-electronapplication]: https://playwright.dev/docs/api/class-electronapplication
-[playwright-page]: https://playwright.dev/docs/api/class-page
-[playwright-releases]: https://github.com/microsoft/playwright/releases
-[playwright-test-config]: https://playwright.dev/docs/api/class-testconfig#test-config-test-match
-[playwright-test-runners]: https://playwright.dev/docs/test-runners/
-[Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/

docs/tutorial/dark-mode.md

@@ -138,7 +138,7 @@ Finally, the `main.js` file represents the main process and contains the actual
 const { app, BrowserWindow, ipcMain, nativeTheme } = require('electron')
 const path = require('path')
 
-const createWindow = () => {
+function createWindow () {
   const win = new BrowserWindow({
     width: 800,
     height: 600,

docs/tutorial/devices.md

@@ -84,22 +84,13 @@ There are several additional APIs for working with the Web Serial API:
   and [`serial-port-removed`](../api/session.md#event-serial-port-removed) events
   on the Session can be used to handle devices being plugged in or unplugged during the
   `navigator.serial.requestPort` process.
-* [`ses.setDevicePermissionHandler(handler)`](../api/session.md#sessetdevicepermissionhandlerhandler)
-  can be used to provide default permissioning to devices without first calling
-  for permission to devices via `navigator.serial.requestPort`.  Additionally,
-  the default behavior of Electron is to store granted device permision through
-  the lifetime of the corresponding WebContents.  If longer term storage is
-  needed, a developer can store granted device permissions (eg when handling
-  the `select-serial-port` event) and then read from that storage with
-  `setDevicePermissionHandler`.
 * [`ses.setPermissionCheckHandler(handler)`](../api/session.md#sessetpermissioncheckhandlerhandler)
   can be used to disable serial access for specific origins.
 
 ### Example
 
 This example demonstrates an Electron application that automatically selects
-serial devices through [`ses.setDevicePermissionHandler(handler)`](../api/session.md#sessetdevicepermissionhandlerhandler)
-as well as demonstrating selecting the first available Arduino Uno serial device (if connected) through
+the first available Arduino Uno serial device (if connected) through
 [`select-serial-port` event on the Session](../api/session.md#event-select-serial-port)
 when the `Test Web Serial` button is clicked.
 

docs/tutorial/electron-timelines.md

@@ -7,7 +7,7 @@ Special notes:
 * 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 targeting 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.
-* Starting in Electron 16.0, we will release on an 8-week cadence. See [Electron's new 8-week cadence blog post](https://www.electronjs.org/blog/8-week-cadence) for more details.
+* Electron 15.0 only will include a special Alpha release. Starting in Electron 16.0, we will release on an 8-week cadence. See [Electron's new 8-week cadence blog post](https://www.electronjs.org/blog/8-week-cadence) for more details.
 
 | Electron | Alpha | Beta | Stable | Chrome | Node |
 | ------- | ----- | ------- | ------ | ------ | ---- |
@@ -25,5 +25,4 @@ Special notes:
 | 13.0.0 | -- | 2021-Mar-04 | 2021-May-25 | M91 | v14.16 |
 | 14.0.0 | -- | 2021-May-27 | 2021-Aug-31 | M93 | v14.17 |
 | 15.0.0 | 2021-Jul-20 | 2021-Sep-01 | 2021-Sep-21 | M94 | v16.5 |
-| 16.0.0 | 2021-Sep-23 | 2021-Oct-20 | 2021-Nov-16 | M96 | v16.9 |
-| 17.0.0 | 2021-Nov-18 | 2022-Jan-06 | 2022-Feb-01 | M98 | TBD |
+| 16.0.0 | -- | 2021-Sep-23 | 2021-Nov-16 | M96 | TBD |

docs/tutorial/electron-versioning.md

@@ -2,31 +2,43 @@
 
 > A detailed look at our versioning policy and implementation.
 
-As of version 2.0.0, Electron follows the [SemVer](#semver) spec. The following command will install the most recent stable build of Electron:
+As of version 2.0.0, Electron follows [SemVer](#semver). The following command will install the most recent stable build of Electron:
 
-```sh npm2yarn
+```sh
 npm install --save-dev electron
 ```
 
 To update an existing project to use the latest stable version:
 
-```sh npm2yarn
+```sh
 npm install --save-dev electron@latest
 ```
 
-## Versioning scheme
+## Version 1.x
+
+Electron versions *< 2.0* did not conform to the [SemVer](https://semver.org) spec: major versions corresponded to end-user API changes, minor versions corresponded to Chromium major releases, and patch versions corresponded to new features and bug fixes. While convenient for developers merging features, it creates problems for developers of client-facing applications. The QA testing cycles of major apps like Slack, Stride, Teams, Skype, VS Code, Atom, and Desktop can be lengthy and stability is a highly desired outcome. There is a high risk in adopting new features while trying to absorb bug fixes.
+
+Here is an example of the 1.x strategy:
+
+![1.x Versioning](../images/versioning-sketch-0.png)
+
+An app developed with `1.8.1` cannot take the `1.8.3` bug fix without either absorbing the `1.8.2` feature, or by backporting the fix and maintaining a new release line.
+
+## Version 2.0 and Beyond
 
 There are several major changes from our 1.x strategy outlined below. Each change is intended to satisfy the needs and priorities of developers/maintainers and app developers.
 
-1. Strict use of the the [SemVer](#semver) spec
+1. Strict use of SemVer
 2. Introduction of semver-compliant `-beta` tags
 3. Introduction of [conventional commit messages](https://conventionalcommits.org/)
 4. Well-defined stabilization branches
-5. The `main` branch is versionless; only stabilization branches contain version information
+5. The `master` branch is versionless; only stabilization branches contain version information
 
 We will cover in detail how git branching works, how npm tagging works, what developers should expect to see, and how one can backport changes.
 
-## SemVer
+# SemVer
+
+From 2.0 onward, Electron will follow SemVer.
 
 Below is a table explicitly mapping types of changes to their corresponding category of SemVer (e.g. Major, Minor, Patch).
 
@@ -36,25 +48,22 @@ Below is a table explicitly mapping types of changes to their corresponding cate
 | Node.js major version updates   | Node.js minor version updates      | Node.js patch version updates |
 | Chromium version updates        |                                    | fix-related chromium patches  |
 
-For more information, see the [Semantic Versioning 2.0.0](https://semver.org/) spec.
-
 Note that most Chromium updates will be considered breaking. Fixes that can be backported will likely be cherry-picked as patches.
 
-## Stabilization branches
+# Stabilization Branches
 
-Stabilization branches are branches that run parallel to `main`, taking in only cherry-picked commits that are related to security or stability. These branches are never merged back to `main`.
+Stabilization branches are branches that run parallel to master, taking in only cherry-picked commits that are related to security or stability. These branches are never merged back to master.
 
 ![Stabilization Branches](../images/versioning-sketch-1.png)
 
-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, one for each supported version. For more details on which versions are supported, see our [Electron Release Timelines](./electron-timelines.md) doc.
+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.
 ![Multiple Stability Branches](../images/versioning-sketch-2.png)
 
-Older lines will not be supported by the Electron project, but other groups can take ownership and backport stability and security fixes on their own. We discourage this, but recognize that it makes life easier for many app developers.
+Older lines will not be supported by GitHub, but other groups can take ownership and backport stability and security fixes on their own. We discourage this, but recognize that it makes life easier for many app developers.
 
-## Beta releases and bug fixes
+# Beta Releases and Bug Fixes
 
 Developers want to know which releases are _safe_ to use. Even seemingly innocent features can introduce regressions in complex applications. At the same time, locking to a fixed version is dangerous because you’re ignoring security patches and bug fixes that may have come out since your version. Our goal is to allow the following standard semver ranges in `package.json` :
 
@@ -107,7 +116,15 @@ A few examples of how various SemVer ranges will pick up new releases:
 
 ![Semvers and Releases](../images/versioning-sketch-7.png)
 
-## Feature flags
+# Missing Features: Alphas
+
+Our strategy has a few tradeoffs, which for now we feel are appropriate. Most importantly that new features in master may take a while before reaching a stable release line. If you want to try a new feature immediately, you will have to build Electron yourself.
+
+As a future consideration, we may introduce one or both of the following:
+
+* alpha releases that have looser stability constraints to betas; for example it would be allowable to admit new features while a stability channel is in _alpha_
+
+# Feature Flags
 
 Feature flags are a common practice in Chromium, and are well-established in the web-development ecosystem. In the context of Electron, a feature flag or **soft branch** must have the following properties:
 
@@ -115,29 +132,20 @@ Feature flags are a common practice in Chromium, and are well-established in the
 * it completely segments new and old code paths; refactoring old code to support a new feature _violates_ the feature-flag contract
 * feature flags are eventually removed after the feature is released
 
-## Semantic commits
+# Semantic Commits
 
-All pull requests must adhere to the [Conventional Commits](https://conventionalcommits.org/) spec, which can be summarized as follows:
+We seek to increase clarity at all levels of the update and releases process. Starting with `2.0.0` we will require pull requests adhere to the [Conventional Commits](https://conventionalcommits.org/) spec, which can be summarized as follows:
 
 * Commits that would result in a SemVer **major** bump must start their body with `BREAKING CHANGE:`.
 * 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:`.
 
-The `electron/electron` repository also enforces squash merging, so you only need to make sure that your pull request has the correct title prefix.
+* 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 `main` branch
+# Versioned `master`
 
-* The `main` branch will always contain the next major version `X.0.0-nightly.DATE` in its `package.json`.
-* Release branches are never merged back to `main`.
-* Release branches _do_ contain the correct version in their `package.json`.
-* As soon as a release branch is cut for a major, `main` must be bumped to the next major (i.e. `main` is always versioned as the next theoretical release branch).
-
-## Historical versioning (Electron 1.X)
-
-Electron versions *< 2.0* did not conform to the [SemVer](https://semver.org) spec: major versions corresponded to end-user API changes, minor versions corresponded to Chromium major releases, and patch versions corresponded to new features and bug fixes. While convenient for developers merging features, it creates problems for developers of client-facing applications. The QA testing cycles of major apps like Slack, Teams, Skype, VS Code, and GitHub Desktop can be lengthy and stability is a highly desired outcome. There is a high risk in adopting new features while trying to absorb bug fixes.
-
-Here is an example of the 1.x strategy:
-
-![1.x Versioning](../images/versioning-sketch-0.png)
-
-An app developed with `1.8.1` cannot take the `1.8.3` bug fix without either absorbing the `1.8.2` feature, or by backporting the fix and maintaining a new release line.
+* The `master` branch will always contain the next major version `X.0.0-nightly.DATE` in its `package.json`
+* Release branches are never merged back to master
+* Release branches _do_ contain the correct version in their `package.json`
+* As soon as a release branch is cut for a major, master must be bumped to the next major.  I.e. `master` is always versioned as the next theoretical release branch

docs/tutorial/fuses.md

@@ -12,7 +12,7 @@ Fuses are the solution to this problem, at a high level they are "magic bits" in
 
 ### The easy way
 
-We've made a handy module, [`@electron/fuses`](https://npmjs.com/package/@electron/fuses), to make flipping these fuses easy.  Check out the README of that module for more details on usage and potential error cases.
+We've made a handy module `@electron/fuses` to make flipping these fuses easy.  Check out the README of that module for more details on usage and potential error cases.
 
 ```js
 require('@electron/fuses').flipFuses(

docs/tutorial/in-app-purchases.md

@@ -39,7 +39,7 @@ inAppPurchase.on('transactions-updated', (event, transactions) => {
   }
 
   // Check each transaction.
-  transactions.forEach((transaction) => {
+  transactions.forEach(function (transaction) {
     const payment = transaction.payment
 
     switch (transaction.transactionState) {

docs/tutorial/installation.md

@@ -91,7 +91,7 @@ The above configuration will download from URLs such as
 `https://npm.taobao.org/mirrors/electron/8.0.0/electron-v8.0.0-linux-x64.zip`.
 
 If your mirror serves artifacts with different checksums to the official
-Electron release you may have to set `electron_use_remote_checksums=1` to
+Electron release you may have to set `ELECTRON_USE_REMOTE_CHECKSUMS=1` to
 force Electron to use the remote `SHASUMS256.txt` file to verify the checksum
 instead of the embedded checksums.
 

docs/tutorial/introduction.md

@@ -56,4 +56,4 @@ problem. If not, feel free to fill out our bug report template and submit a new
 [comic]: https://www.google.com/googlebooks/chrome/
 [fiddle]: https://electronjs.org/fiddle
 [issue-tracker]: https://github.com/electron/electron/issues
-[discord]: https://discord.gg/electronjs
+[discord]: https://discord.gg/electron

docs/tutorial/keyboard-shortcuts.md

@@ -82,7 +82,7 @@ listen for the `keyup` and `keydown` [DOM events][dom-events] inside the
 renderer process using the [addEventListener() API][addEventListener-api].
 
 ```javascript fiddle='docs/fiddles/features/keyboard-shortcuts/web-apis|focus=renderer.js'
-const handleKeyPress = (event) => {
+function handleKeyPress(event) {
   // You can put code here to handle the keypress.
   document.getElementById("last-keypress").innerText = event.key;
   console.log(`You pressed ${event.key}`);

docs/tutorial/macos-dock.md

@@ -25,7 +25,7 @@ Starting with a working application from the
 ```javascript fiddle='docs/fiddles/features/macos-dock-menu'
 const { app, BrowserWindow, Menu } = require('electron')
 
-const createWindow = () => {
+function createWindow () {
   const win = new BrowserWindow({
     width: 800,
     height: 600,

docs/tutorial/message-ports.md

@@ -134,7 +134,7 @@ app.whenReady().then(async () => {
 <script>
 const { ipcRenderer } = require('electron')
 
-const doWork = (input) => {
+function doWork(input) {
   // Something cpu-intensive.
   return input * 2
 }
@@ -185,7 +185,7 @@ stream of data.
 ```js
 // renderer.js ///////////////////////////////////////////////////////////////
 
-const makeStreamingRequest = (element, callback) => {
+function makeStreamingRequest (element, callback) {
   // MessageChannels are lightweight--it's cheap to create a new one for each
   // request.
   const { port1, port2 } = new MessageChannel()

docs/tutorial/notifications.md

@@ -54,7 +54,7 @@ const { Notification } = require('electron')
 const NOTIFICATION_TITLE = 'Basic Notification'
 const NOTIFICATION_BODY = 'Notification from the Main process'
 
-const showNotification = () => {
+function showNotification () {
   new Notification({ title: NOTIFICATION_TITLE, body: NOTIFICATION_BODY }).show()
 }
 
@@ -146,7 +146,7 @@ desktop environment that follows [Desktop Notifications
 Specification][notification-spec], including Cinnamon, Enlightenment, Unity,
 GNOME, KDE.
 
-[notification-spec]: https://developer-old.gnome.org/notification-spec/
+[notification-spec]: https://developer.gnome.org/notification-spec/
 [app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
 [set-app-user-model-id]: ../api/app.md#appsetappusermodelidid-windows
 [squirrel-events]: https://github.com/electron/windows-installer/blob/master/README.md#handling-squirrel-events

docs/tutorial/offscreen-rendering.md

@@ -17,7 +17,7 @@ the dirty area is passed to the `paint` event to be more efficient.
 losses with no benefits.
 * When nothing is happening on a webpage, no frames are generated.
 * An offscreen window is always created as a
-[Frameless Window](../tutorial/window-customization.md)..
+[Frameless Window](../api/frameless-window.md).
 
 ### Rendering Modes
 

docs/tutorial/online-offline-events.md

@@ -41,7 +41,7 @@ Starting with an HTML file `index.html`, this example will demonstrate how the `
 In order to mutate the DOM, create a `renderer.js` file that adds event listeners to the `'online'` and `'offline'` `window` events. The event handler sets the content of the `<strong id='status'>` element depending on the result of `navigator.onLine`.
 
 ```js title='renderer.js'
-const updateOnlineStatus = () => {
+function updateOnlineStatus () {
   document.getElementById('status').innerHTML = navigator.onLine ? 'online' : 'offline'
 }
 
@@ -56,7 +56,7 @@ Finally, create a `main.js` file for main process that creates the window.
 ```js title='main.js'
 const { app, BrowserWindow } = require('electron')
 
-const createWindow = () => {
+function createWindow () {
   const onlineStatusWindow = new BrowserWindow({
     width: 400,
     height: 100

docs/tutorial/process-model.md

@@ -84,7 +84,7 @@ uses `app` APIs to create a more native application window experience.
 
 ```js title='main.js'
 // quitting the app when no windows are open on non-macOS platforms
-app.on('window-all-closed', () => {
+app.on('window-all-closed', function () {
   if (process.platform !== 'darwin') app.quit()
 })
 ```

docs/tutorial/progress-bar.md

@@ -7,7 +7,7 @@ without the need of switching to the window itself.
 
 On Windows, you can use a taskbar button to display a progress bar.
 
-![Windows Progress Bar](../images/windows-progress-bar.png)
+![Windows Progress Bar][https://cloud.githubusercontent.com/assets/639601/5081682/16691fda-6f0e-11e4-9676-49b6418f1264.png]
 
 On macOS, the progress bar will be displayed as a part of the dock icon.
 
@@ -48,7 +48,7 @@ const { app, BrowserWindow } = require('electron')
 
 let progressInterval
 
-const createWindow = () => {
+function createWindow () {
   const win = new BrowserWindow({
     width: 800,
     height: 600

docs/tutorial/quick-start.md

@@ -119,7 +119,7 @@ of your project.
 
 Before we can create a window for our application, we need to create the content that
 will be loaded into it. In Electron, each window displays web contents that can be loaded
-from either a local HTML file or a remote URL.
+from either from a local HTML file or a remote URL.
 
 For this tutorial, you will be doing the former. Create an `index.html` file in the root
 folder of your project:
@@ -166,7 +166,7 @@ Then, add a `createWindow()` function that loads `index.html` into a new `Browse
 instance.
 
 ```js
-const createWindow = () => {
+function createWindow () {
   const win = new BrowserWindow({
     width: 800,
     height: 600
@@ -216,7 +216,7 @@ To implement this, listen for the `app` module's [`'window-all-closed'`][window-
 event, and call [`app.quit()`][app-quit] if the user is not on macOS (`darwin`).
 
 ```js
-app.on('window-all-closed', () => {
+app.on('window-all-closed', function () {
   if (process.platform !== 'darwin') app.quit()
 })
 ```
@@ -244,7 +244,7 @@ from within your existing `whenReady()` callback.
 app.whenReady().then(() => {
   createWindow()
 
-  app.on('activate', () => {
+  app.on('activate', function () {
     if (BrowserWindow.getAllWindows().length === 0) createWindow()
   })
 })
@@ -295,7 +295,7 @@ to the `webPreferences.preload` option in your existing `BrowserWindow` construc
 const path = require('path')
 
 // modify your existing createWindow() function
-const createWindow = () => {
+function createWindow () {
   const win = new BrowserWindow({
     width: 800,
     height: 600,
@@ -360,7 +360,7 @@ The full code is available below:
 const { app, BrowserWindow } = require('electron')
 const path = require('path')
 
-const createWindow = () => {
+function createWindow () {
   // Create the browser window.
   const mainWindow = new BrowserWindow({
     width: 800,
@@ -383,7 +383,7 @@ const createWindow = () => {
 app.whenReady().then(() => {
   createWindow()
 
-  app.on('activate', () => {
+  app.on('activate', function () {
     // On macOS it's common to re-create a window in the app when the
     // dock icon is clicked and there are no other windows open.
     if (BrowserWindow.getAllWindows().length === 0) createWindow()
@@ -393,7 +393,7 @@ app.whenReady().then(() => {
 // 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', () => {
+app.on('window-all-closed', function () {
   if (process.platform !== 'darwin') app.quit()
 })
 

docs/tutorial/recent-documents.md

@@ -22,7 +22,7 @@ const { app, BrowserWindow } = require('electron')
 const fs = require('fs')
 const path = require('path')
 
-const createWindow = () => {
+function createWindow () {
   const win = new BrowserWindow({
     width: 800,
     height: 600

docs/tutorial/represented-file.md

@@ -24,7 +24,7 @@ To set the represented file of window, you can use the
 const { app, BrowserWindow } = require('electron')
 const os = require('os');
 
-const createWindow = () => {
+function createWindow () {
   const win = new BrowserWindow({
     width: 800,
     height: 600

docs/tutorial/security.md

@@ -216,7 +216,7 @@ access to a `window.readConfig()` method, but no Node.js features.
 ```js
 const { readFileSync } = require('fs')
 
-window.readConfig = () => {
+window.readConfig = function () {
   const data = readFileSync('./config.json')
   return data
 }

docs/tutorial/support.md

@@ -70,10 +70,10 @@ until the maintainers feel the maintenance burden is too high to continue doing
 
 ### Currently supported versions
 
-* 16.x.y
 * 15.x.y
 * 14.x.y
 * 13.x.y
+* 12
 
 ### End-of-life
 

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

@@ -0,0 +1,173 @@
+# Selenium and WebDriver
+
+From [ChromeDriver - WebDriver for Chrome][chrome-driver]:
+
+> WebDriver is an open source tool for automated testing of web apps across many
+> browsers. It provides capabilities for navigating to web pages, user input,
+> JavaScript execution, and more. ChromeDriver is a standalone server which
+> implements WebDriver's wire protocol for Chromium. It is being developed by
+> members of the Chromium and WebDriver teams.
+
+## Setting up Spectron
+
+[Spectron][spectron] is the officially supported ChromeDriver testing framework
+for Electron. It is built on top of [WebdriverIO](https://webdriver.io/) and
+has helpers to access Electron APIs in your tests and bundles ChromeDriver.
+
+```sh
+$ npm install --save-dev spectron
+```
+
+```javascript
+// A simple test to verify a visible window is opened with a title
+const Application = require('spectron').Application
+const assert = require('assert')
+
+const myApp = new Application({
+  path: '/Applications/MyApp.app/Contents/MacOS/MyApp'
+})
+
+const verifyWindowIsVisibleWithTitle = async (app) => {
+  await app.start()
+  try {
+    // Check if the window is visible
+    const isVisible = await app.browserWindow.isVisible()
+    // Verify the window is visible
+    assert.strictEqual(isVisible, true)
+    // Get the window's title
+    const title = await app.client.getTitle()
+    // Verify the window's title
+    assert.strictEqual(title, 'My App')
+  } catch (error) {
+    // Log any failures
+    console.error('Test failed', error.message)
+  }
+  // Stop the application
+  await app.stop()
+}
+
+verifyWindowIsVisibleWithTitle(myApp)
+```
+
+## Setting up with WebDriverJs
+
+[WebDriverJs](https://www.selenium.dev/selenium/docs/api/javascript/index.html) provides
+a Node package for testing with web driver, we will use it as an example.
+
+### 1. Start ChromeDriver
+
+First you need to download the `chromedriver` binary, and run it:
+
+```sh
+$ npm install electron-chromedriver
+$ ./node_modules/.bin/chromedriver
+Starting ChromeDriver (v2.10.291558) on port 9515
+Only local connections are allowed.
+```
+
+Remember the port number `9515`, which will be used later
+
+### 2. Install WebDriverJS
+
+```sh
+$ npm install selenium-webdriver
+```
+
+### 3. Connect to ChromeDriver
+
+The usage of `selenium-webdriver` with Electron is the same with
+upstream, except that you have to manually specify how to connect
+chrome driver and where to find Electron's binary:
+
+```javascript
+const webdriver = require('selenium-webdriver')
+
+const driver = new webdriver.Builder()
+  // The "9515" is the port opened by chrome driver.
+  .usingServer('http://localhost:9515')
+  .withCapabilities({
+    'goog:chromeOptions': {
+      // Here is the path to your Electron binary.
+      binary: '/Path-to-Your-App.app/Contents/MacOS/Electron'
+    }
+  })
+  .forBrowser('chrome') // note: use .forBrowser('electron') for selenium-webdriver <= 3.6.0
+  .build()
+
+driver.get('http://www.google.com')
+driver.findElement(webdriver.By.name('q')).sendKeys('webdriver')
+driver.findElement(webdriver.By.name('btnG')).click()
+driver.wait(() => {
+  return driver.getTitle().then((title) => {
+    return title === 'webdriver - Google Search'
+  })
+}, 1000)
+
+driver.quit()
+```
+
+## Setting up with WebdriverIO
+
+[WebdriverIO](https://webdriver.io/) provides a Node package for testing with web
+driver.
+
+### 1. Start ChromeDriver
+
+First you need to download the `chromedriver` binary, and run it:
+
+```sh
+$ npm install electron-chromedriver
+$ ./node_modules/.bin/chromedriver --url-base=wd/hub --port=9515
+Starting ChromeDriver (v2.10.291558) on port 9515
+Only local connections are allowed.
+```
+
+Remember the port number `9515`, which will be used later
+
+### 2. Install WebdriverIO
+
+```sh
+$ npm install webdriverio
+```
+
+### 3. Connect to chrome driver
+
+```javascript
+const webdriverio = require('webdriverio')
+const options = {
+  host: 'localhost', // Use localhost as chrome driver server
+  port: 9515, // "9515" is the port opened by chrome driver.
+  desiredCapabilities: {
+    browserName: 'chrome',
+    'goog:chromeOptions': {
+      binary: '/Path-to-Your-App/electron', // Path to your Electron binary.
+      args: [/* cli arguments */] // Optional, perhaps 'app=' + /path/to/your/app/
+    }
+  }
+}
+
+const client = webdriverio.remote(options)
+
+client
+  .init()
+  .url('http://google.com')
+  .setValue('#q', 'webdriverio')
+  .click('#btnG')
+  .getTitle().then((title) => {
+    console.log('Title was: ' + title)
+  })
+  .end()
+```
+
+## Workflow
+
+To test your application without rebuilding Electron,
+[place](application-distribution.md)
+your app source into Electron's resource directory.
+
+Alternatively, pass an argument to run with your Electron binary that points to
+your app's folder. This eliminates the need to copy-paste your app into
+Electron's resource directory.
+
+[chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/
+[spectron]: https://electronjs.org/spectron

docs/tutorial/window-customization.md

@@ -1,271 +0,0 @@
-# Window Customization
-
-The `BrowserWindow` module is the foundation of your Electron application, and it exposes
-many APIs that can change the look and behavior of your browser windows. In this
-tutorial, we will be going over the various use-cases for window customization on
-macOS, Windows, and Linux.
-
-## Create frameless windows
-
-A frameless window is a window that has no [chrome]. Not to be confused with the Google
-Chrome browser, window _chrome_ refers to the parts of the window (e.g. toolbars, controls)
-that are not a part of the web page.
-
-To create a frameless window, you need to set `frame` to `false` in the `BrowserWindow`
-constructor.
-
-```javascript title='main.js'
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow({ frame: false })
-```
-
-## Apply custom title bar styles _macOS_ _Windows_
-
-Title bar styles allow you to hide most of a BrowserWindow's chrome while keeping the
-system's native window controls intact and can be configured with the `titleBarStyle`
-option in the `BrowserWindow` constructor.
-
-Applying the `hidden` title bar style results in a hidden title bar and a full-size
-content window.
-
-```javascript title='main.js'
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow({ titleBarStyle: 'hidden' })
-```
-
-### Control the traffic lights _macOS_
-
-On macOS, applying the `hidden` title bar style will still expose the standard window
-controls (“traffic lights”) in the top left.
-
-#### Customize the look of your traffic lights _macOS_
-
-The `customButtonsOnHover` title bar style will hide the traffic lights until you hover
-over them. This is useful if you want to create custom traffic lights in your HTML but still
-use the native UI to control the window.
-
-```javascript
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow({ titleBarStyle: 'customButtonsOnHover' })
-```
-
-#### Customize the traffic light position _macOS_
-
-To modify the position of the traffic light window controls, there are two configuration
-options available.
-
-Applying `hiddenInset` title bar style will shift the vertical inset of the traffic lights
-by a fixed amount.
-
-```javascript title='main.js'
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow({ titleBarStyle: 'hiddenInset' })
-```
-
-If you need more granular control over the positioning of the traffic lights, you can pass
-a set of coordinates to the `trafficLightPosition` option in the `BrowserWindow`
-constructor.
-
-```javascript title='main.js'
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow({
-  titleBarStyle: 'hidden',
-  trafficLightPosition: { x: 10, y: 10 }
-})
-```
-
-#### Show and hide the traffic lights programmatically _macOS_
-
-You can also show and hide the traffic lights programmatically from the main process.
-The `win.setWindowButtonVisibility` forces traffic lights to be show or hidden depending
-on the value of its boolean parameter.
-
-```javascript title='main.js'
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow()
-// hides the traffic lights
-win.setWindowButtonVisibility(false)
-```
-
-> Note: Given the number of APIs available, there are many ways of achieving this. For instance,
-> combining `frame: false` with `win.setWindowButtonVisibility(true)` will yield the same
-> layout outcome as setting `titleBarStyle: 'hidden'`.
-
-## Window Controls Overlay _macOS_ _Windows_
-
-The [Window Controls Overlay API] is a web standard that gives web apps the ability to
-customize their title bar region when installed on desktop. Electron exposes this API
-through the `BrowserWindow` constructor option `titleBarOverlay`.
-
-This option only works whenever a custom `titlebarStyle` is applied on macOS or Windows.
-When `titleBarOverlay` is enabled, the window controls become exposed in their default
-position, and DOM elements cannot use the area underneath this region.
-
-The `titleBarOverlay` option accepts two different value formats.
-
-Specifying `true` on either platform will result in an overlay region with default
-system colors:
-
-```javascript title='main.js'
-// on macOS or Windows
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow({
-  titleBarStyle: 'hidden',
-  titleBarOverlay: true
-})
-```
-
-On Windows, you can also specify the color of the overlay and its symbols by setting
-`titleBarOverlay` to an object with the `color` and `symbolColor` properties. If an option
-is not specified, the color will default to its system color for the window control buttons:
-
-```javascript title='main.js'
-// on Windows
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow({
-  titleBarStyle: 'hidden',
-  titleBarOverlay: {
-    color: '#2f3241',
-    symbolColor: '#74b1be'
-  }
-})
-```
-
-> Note: Once your title bar overlay is enabled from the main process, you can access the overlay's
-> color and dimension values from a renderer using a set of readonly
-> [JavaScript APIs][overlay-javascript-apis] and [CSS Environment Variables][overlay-css-env-vars].
-
-## Create transparent windows
-
-By setting the `transparent` option to `true`, you can make a fully transparent window.
-
-```javascript title='main.js'
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow({ transparent: true })
-```
-
-### Limitations
-
-* You cannot click through the transparent area. See
-  [#1335](https://github.com/electron/electron/issues/1335) for details.
-* Transparent windows are not resizable. Setting `resizable` to `true` may make
-  a transparent window stop working on some platforms.
-* The CSS [`blur()`] filter only applies to the window's web contents, so there is no way to apply
-  blur effect to the content below the window (i.e. other applications open on
-  the user's system).
-* The window will not be transparent when DevTools is opened.
-* On _Windows_:
-  * Transparent windows will not work when DWM is disabled.
-  * Transparent windows can not be maximized using the Windows system menu or by double
-  clicking the title bar. The reasoning behind this can be seen on
-  PR [#28207](https://github.com/electron/electron/pull/28207).
-* On _macOS_:
-  * The native window shadow will not be shown on a transparent window.
-
-## Create click-through windows
-
-To create a click-through window, i.e. making the window ignore all mouse
-events, you can call the [win.setIgnoreMouseEvents(ignore)][ignore-mouse-events]
-API:
-
-```javascript title='main.js'
-const { BrowserWindow } = require('electron')
-const win = new BrowserWindow()
-win.setIgnoreMouseEvents(true)
-```
-
-### Forward mouse events _macOS_ _Windows_
-
-Ignoring mouse messages makes the web contents oblivious to mouse movement,
-meaning that mouse movement events will not be emitted. On Windows and macOS, an
-optional parameter can be used to forward mouse move messages to the web page,
-allowing events such as `mouseleave` to be emitted:
-
-```javascript title='main.js'
-const { BrowserWindow, ipcMain } = require('electron')
-const path = require('path')
-
-const win = new BrowserWindow({
-  webPreferences: {
-    preload: path.join(__dirname, 'preload.js')
-  }
-})
-
-ipcMain.on('set-ignore-mouse-events', (event, ...args) => {
-  const win = BrowserWindow.fromWebContents(event.sender)
-  win.setIgnoreMouseEvents(...args)
-})
-```
-
-```javascript title='preload.js'
-window.addEventListener('DOMContentLoaded', () => {
-  const el = document.getElementById('clickThroughElement')
-  el.addEventListener('mouseenter', () => {
-    ipcRenderer.send('set-ignore-mouse-events', true, { forward: true })
-  })
-  el.addEventListener('mouseleave', () => {
-    ipcRenderer.send('set-ignore-mouse-events', false)
-  })
-})
-```
-
-This makes the web page click-through when over the `#clickThroughElement` element,
-and returns to normal outside it.
-
-## Set custom draggable region
-
-By default, the frameless window is non-draggable. Apps need to specify
-`-webkit-app-region: drag` in CSS to tell Electron which regions are draggable
-(like the OS's standard titlebar), and apps can also use
-`-webkit-app-region: no-drag` to exclude the non-draggable area from the
- draggable region. Note that only rectangular shapes are currently supported.
-
-To make the whole window draggable, you can add `-webkit-app-region: drag` as
-`body`'s style:
-
-```css title='styles.css'
-body {
-  -webkit-app-region: drag;
-}
-```
-
-And note that if you have made the whole window draggable, you must also mark
-buttons as non-draggable, otherwise it would be impossible for users to click on
-them:
-
-```css title='styles.css'
-button {
-  -webkit-app-region: no-drag;
-}
-```
-
-If you're only setting a custom titlebar as draggable, you also need to make all
-buttons in titlebar non-draggable.
-
-### Tip: disable text selection
-
-When creating a draggable region, the dragging behavior may conflict with text selection.
-For example, when you drag the titlebar, you may accidentally select its text contents.
-To prevent this, you need to disable text selection within a draggable area like this:
-
-```css
-.titlebar {
-  -webkit-user-select: none;
-  -webkit-app-region: drag;
-}
-```
-
-### Tip: disable context menus
-
-On some platforms, the draggable area will be treated as a non-client frame, so
-when you right click on it, a system menu will pop up. To make the context menu
-behave correctly on all platforms, you should never use a custom context menu on
-draggable areas.
-
-[`blur()`]: https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/blur()
-[`BrowserWindow`]: ../api/browser-window.md
-[chrome]: https://developer.mozilla.org/en-US/docs/Glossary/Chrome
-[ignore-mouse-events]: ../api/browser-window.md#winsetignoremouseeventsignore-options
-[overlay-css-env-vars]: https://github.com/WICG/window-controls-overlay/blob/main/explainer.md#css-environment-variables
-[overlay-javascript-apis]: https://github.com/WICG/window-controls-overlay/blob/main/explainer.md#javascript-apis
-[Window Controls Overlay API]: https://github.com/WICG/window-controls-overlay/blob/main/explainer.md

electron_resources.grd

@@ -19,7 +19,6 @@
     <includes>
       <include name="IDR_CONTENT_SHELL_DEVTOOLS_DISCOVERY_PAGE" file="${target_gen_dir}/shell_devtools_discovery_page.html" use_base_dir="false" type="BINDATA" />
       <include name="IDR_PDF_MANIFEST" file="../chrome/browser/resources/pdf/manifest.json" type="BINDATA" />
-      <include name="IDR_CRYPTOTOKEN_MANIFEST" file="../chrome/browser/resources/cryptotoken/manifest.json" type="BINDATA" />
     </includes>
   </release>
 </grit>

electron_strings.grdp

@@ -33,23 +33,6 @@
     {SCREEN_INDEX, plural, =1{Screen #} other{Screen #}}
   </message>
 
-  <!-- File Select Helper-->
-  <message name="IDS_IMAGE_FILES" desc="The description of the image file extensions in the select file dialog.">
-    Image Files
-  </message>
-  <message name="IDS_AUDIO_FILES" desc="The description of the audio file extensions in the select file dialog.">
-    Audio Files
-  </message>
-  <message name="IDS_VIDEO_FILES" desc="The description of the video file extensions in the select file dialog.">
-    Video Files
-  </message>
-  <message name="IDS_CUSTOM_FILES" desc="The description of the custom file extensions in the select file dialog.">
-    Custom Files
-  </message>
-  <message name="IDS_DEFAULT_DOWNLOAD_FILENAME" desc="Default name for downloaded files when we have no idea what they could be.">
-    download
-  </message>
-
   <!-- Picture-in-Picture -->
   <if expr="is_macosx">
     <message name="IDS_PICTURE_IN_PICTURE_TITLE_TEXT" desc="Title of the Picture-in-Picture window. This appears in the system tray and window header.">

filenames.auto.gni

@@ -23,6 +23,7 @@ auto_filenames = {
     "docs/api/environment-variables.md",
     "docs/api/extensions.md",
     "docs/api/file-object.md",
+    "docs/api/frameless-window.md",
     "docs/api/global-shortcut.md",
     "docs/api/in-app-purchase.md",
     "docs/api/incoming-message.md",
@@ -135,14 +136,16 @@ auto_filenames = {
 
   sandbox_bundle_deps = [
     "lib/common/api/deprecate.ts",
-    "lib/common/api/native-image.ts",
     "lib/common/define-properties.ts",
     "lib/common/ipc-messages.ts",
+    "lib/common/type-utils.ts",
+    "lib/common/web-view-events.ts",
     "lib/common/web-view-methods.ts",
     "lib/renderer/api/context-bridge.ts",
     "lib/renderer/api/crash-reporter.ts",
     "lib/renderer/api/desktop-capturer.ts",
     "lib/renderer/api/ipc-renderer.ts",
+    "lib/renderer/api/native-image.ts",
     "lib/renderer/api/web-frame.ts",
     "lib/renderer/inspector.ts",
     "lib/renderer/ipc-renderer-internal-utils.ts",
@@ -167,6 +170,7 @@ auto_filenames = {
   ]
 
   isolated_bundle_deps = [
+    "lib/common/type-utils.ts",
     "lib/common/web-view-methods.ts",
     "lib/isolated_renderer/init.ts",
     "lib/renderer/web-view/web-view-attributes.ts",
@@ -203,6 +207,7 @@ auto_filenames = {
     "lib/browser/api/menu.ts",
     "lib/browser/api/message-channel.ts",
     "lib/browser/api/module-list.ts",
+    "lib/browser/api/native-image.ts",
     "lib/browser/api/native-theme.ts",
     "lib/browser/api/net-log.ts",
     "lib/browser/api/net.ts",
@@ -237,13 +242,13 @@ auto_filenames = {
     "lib/common/api/clipboard.ts",
     "lib/common/api/deprecate.ts",
     "lib/common/api/module-list.ts",
-    "lib/common/api/native-image.ts",
     "lib/common/api/shell.ts",
     "lib/common/define-properties.ts",
     "lib/common/init.ts",
     "lib/common/ipc-messages.ts",
     "lib/common/parse-features-string.ts",
     "lib/common/reset-search-paths.ts",
+    "lib/common/type-utils.ts",
     "lib/common/web-view-events.ts",
     "lib/common/web-view-methods.ts",
     "lib/common/webpack-globals-provider.ts",
@@ -260,12 +265,13 @@ auto_filenames = {
     "lib/common/api/clipboard.ts",
     "lib/common/api/deprecate.ts",
     "lib/common/api/module-list.ts",
-    "lib/common/api/native-image.ts",
     "lib/common/api/shell.ts",
     "lib/common/define-properties.ts",
     "lib/common/init.ts",
     "lib/common/ipc-messages.ts",
     "lib/common/reset-search-paths.ts",
+    "lib/common/type-utils.ts",
+    "lib/common/web-view-events.ts",
     "lib/common/web-view-methods.ts",
     "lib/common/webpack-provider.ts",
     "lib/renderer/api/context-bridge.ts",
@@ -274,6 +280,7 @@ auto_filenames = {
     "lib/renderer/api/exports/electron.ts",
     "lib/renderer/api/ipc-renderer.ts",
     "lib/renderer/api/module-list.ts",
+    "lib/renderer/api/native-image.ts",
     "lib/renderer/api/web-frame.ts",
     "lib/renderer/init.ts",
     "lib/renderer/inspector.ts",
@@ -299,12 +306,12 @@ auto_filenames = {
     "lib/common/api/clipboard.ts",
     "lib/common/api/deprecate.ts",
     "lib/common/api/module-list.ts",
-    "lib/common/api/native-image.ts",
     "lib/common/api/shell.ts",
     "lib/common/define-properties.ts",
     "lib/common/init.ts",
     "lib/common/ipc-messages.ts",
     "lib/common/reset-search-paths.ts",
+    "lib/common/type-utils.ts",
     "lib/common/webpack-provider.ts",
     "lib/renderer/api/context-bridge.ts",
     "lib/renderer/api/crash-reporter.ts",
@@ -312,6 +319,7 @@ auto_filenames = {
     "lib/renderer/api/exports/electron.ts",
     "lib/renderer/api/ipc-renderer.ts",
     "lib/renderer/api/module-list.ts",
+    "lib/renderer/api/native-image.ts",
     "lib/renderer/api/web-frame.ts",
     "lib/renderer/ipc-renderer-internal-utils.ts",
     "lib/renderer/ipc-renderer-internal.ts",

filenames.gni

@@ -44,8 +44,8 @@ filenames = {
   ]
 
   lib_sources_linux_x11 = [
-    "shell/browser/ui/views/global_menu_bar_registrar_x11.cc",
-    "shell/browser/ui/views/global_menu_bar_registrar_x11.h",
+    "chromium_src/chrome/browser/ui/views/frame/global_menu_bar_registrar_x11.cc",
+    "chromium_src/chrome/browser/ui/views/frame/global_menu_bar_registrar_x11.h",
     "shell/browser/ui/views/global_menu_bar_x11.cc",
     "shell/browser/ui/views/global_menu_bar_x11.h",
     "shell/browser/ui/x/event_disabler.cc",
@@ -56,9 +56,13 @@ filenames = {
     "shell/browser/ui/x/x_window_utils.h",
   ]
 
-  lib_sources_posix = [ "shell/browser/electron_browser_main_parts_posix.cc" ]
+  lib_sources_posix = [
+    "chromium_src/chrome/browser/process_singleton_posix.cc",
+    "shell/browser/electron_browser_main_parts_posix.cc",
+  ]
 
   lib_sources_win = [
+    "chromium_src/chrome/browser/process_singleton_win.cc",
     "shell/browser/api/electron_api_power_monitor_win.cc",
     "shell/browser/api/electron_api_system_preferences_win.cc",
     "shell/browser/browser_win.cc",
@@ -233,6 +237,7 @@ filenames = {
   ]
 
   lib_sources = [
+    "chromium_src/chrome/browser/process_singleton.h",
     "shell/app/command_line_args.cc",
     "shell/app/command_line_args.h",
     "shell/app/electron_content_client.cc",
@@ -504,6 +509,8 @@ filenames = {
     "shell/browser/web_contents_preferences.h",
     "shell/browser/web_contents_zoom_controller.cc",
     "shell/browser/web_contents_zoom_controller.h",
+    "shell/browser/web_dialog_helper.cc",
+    "shell/browser/web_dialog_helper.h",
     "shell/browser/web_view_guest_delegate.cc",
     "shell/browser/web_view_guest_delegate.h",
     "shell/browser/web_view_manager.cc",
@@ -675,11 +682,14 @@ filenames = {
     "shell/utility/electron_content_utility_client.h",
   ]
 
+  lib_sources_nss = [
+    "chromium_src/chrome/browser/certificate_manager_model.cc",
+    "chromium_src/chrome/browser/certificate_manager_model.h",
+  ]
+
   lib_sources_extensions = [
     "shell/browser/extensions/api/i18n/i18n_api.cc",
     "shell/browser/extensions/api/i18n/i18n_api.h",
-    "shell/browser/extensions/api/cryptotoken_private/cryptotoken_private_api.cc",
-    "shell/browser/extensions/api/cryptotoken_private/cryptotoken_private_api.h",
     "shell/browser/extensions/api/management/electron_management_api_delegate.cc",
     "shell/browser/extensions/api/management/electron_management_api_delegate.h",
     "shell/browser/extensions/api/resources_private/resources_private_api.cc",

lib/browser/api/app.ts

@@ -39,8 +39,7 @@ Object.assign(app, {
     hasSwitch: (theSwitch: string) => commandLine.hasSwitch(String(theSwitch)),
     getSwitchValue: (theSwitch: string) => commandLine.getSwitchValue(String(theSwitch)),
     appendSwitch: (theSwitch: string, value?: string) => commandLine.appendSwitch(String(theSwitch), typeof value === 'undefined' ? value : String(value)),
-    appendArgument: (arg: string) => commandLine.appendArgument(String(arg)),
-    removeSwitch: (theSwitch: string) => commandLine.removeSwitch(String(theSwitch))
+    appendArgument: (arg: string) => commandLine.appendArgument(String(arg))
   } as Electron.CommandLine
 });
 

lib/browser/api/menu-item-roles.ts

@@ -143,10 +143,7 @@ export const roleList: Record<RoleId, Role> = {
     label: 'Toggle Developer Tools',
     accelerator: isMac ? 'Alt+Command+I' : 'Ctrl+Shift+I',
     nonNativeMacOSRole: true,
-    webContentsMethod: wc => {
-      const bw = wc.getOwnerBrowserWindow();
-      if (bw) bw.webContents.toggleDevTools();
-    }
+    windowMethod: w => w.webContents.toggleDevTools()
   },
   togglefullscreen: {
     label: 'Toggle Full Screen',

lib/browser/api/module-list.ts

@@ -16,6 +16,7 @@ export const browserModuleList: ElectronInternal.ModuleEntry[] = [
   { name: 'Menu', loader: () => require('./menu') },
   { name: 'MenuItem', loader: () => require('./menu-item') },
   { name: 'MessageChannelMain', loader: () => require('./message-channel') },
+  { name: 'nativeImage', loader: () => require('./native-image') },
   { name: 'nativeTheme', loader: () => require('./native-theme') },
   { name: 'net', loader: () => require('./net') },
   { name: 'netLog', loader: () => require('./net-log') },

lib/browser/api/web-contents.ts

@@ -593,9 +593,6 @@ WebContents.prototype._init = function () {
       ipcMainInternal.emit(channel, event, ...args);
     } else {
       addReplyToEvent(event);
-      if (this.listenerCount('ipc-message-sync') === 0 && ipcMain.listenerCount(channel) === 0) {
-        console.warn(`WebContents #${this.id} called ipcRenderer.sendSync() with '${channel}' channel without listeners.`);
-      }
       this.emit('ipc-message-sync', event, channel, ...args);
       ipcMain.emit(channel, event, ...args);
     }
@@ -669,6 +666,16 @@ WebContents.prototype._init = function () {
         postBody
       };
       windowOpenOverriddenOptions = this._callWindowOpenHandler(event, details);
+      // if attempting to use this API with the deprecated new-window event,
+      // windowOpenOverriddenOptions will always return null. This ensures
+      // short-term backwards compatibility until new-window is removed.
+      const parsedFeatures = parseFeatures(rawFeatures);
+      const overriddenFeatures: BrowserWindowConstructorOptions = {
+        ...parsedFeatures.options,
+        webPreferences: parsedFeatures.webPreferences
+      };
+      windowOpenOverriddenOptions = windowOpenOverriddenOptions || overriddenFeatures;
+
       if (!event.defaultPrevented) {
         const secureOverrideWebPreferences = windowOpenOverriddenOptions ? {
           // Allow setting of backgroundColor as a webPreference even though
@@ -678,19 +685,9 @@ WebContents.prototype._init = function () {
           transparent: windowOpenOverriddenOptions.transparent,
           ...windowOpenOverriddenOptions.webPreferences
         } : undefined;
-        // TODO(zcbenz): The features string is parsed twice: here where it is
-        // passed to C++, and in |makeBrowserWindowOptions| later where it is
-        // not actually used since the WebContents is created here.
-        // We should be able to remove the latter once the |nativeWindowOpen|
-        // option is removed.
-        const { webPreferences: parsedWebPreferences } = parseFeatures(rawFeatures);
-        // Parameters should keep same with |makeBrowserWindowOptions|.
-        const webPreferences = makeWebPreferences({
-          embedder: event.sender,
-          insecureParsedWebPreferences: parsedWebPreferences,
-          secureOverrideWebPreferences
-        });
-        this._setNextChildWebPreferences(webPreferences);
+        this._setNextChildWebPreferences(
+          makeWebPreferences({ embedder: event.sender, secureOverrideWebPreferences })
+        );
       }
     });
 
@@ -738,14 +735,6 @@ WebContents.prototype._init = function () {
     }
   });
 
-  this.on('select-bluetooth-device', (event, devices, callback) => {
-    if (this.listenerCount('select-bluetooth-device') === 1) {
-      // Cancel it if there are no handlers
-      event.preventDefault();
-      callback('');
-    }
-  });
-
   const event = process._linkedBinding('electron_browser_event').createEmpty();
   app.emit('web-contents-created', event, this);
 

lib/browser/api/web-frame-main.ts

@@ -7,11 +7,7 @@ WebFrameMain.prototype.send = function (channel, ...args) {
     throw new Error('Missing required channel argument');
   }
 
-  try {
-    return this._send(false /* internal */, channel, args);
-  } catch (e) {
-    console.error('Error sending from webFrameMain: ', e);
-  }
+  return this._send(false /* internal */, channel, args);
 };
 
 WebFrameMain.prototype._sendInternal = function (channel, ...args) {
@@ -19,11 +15,7 @@ WebFrameMain.prototype._sendInternal = function (channel, ...args) {
     throw new Error('Missing required channel argument');
   }
 
-  try {
-    return this._send(true /* internal */, channel, args);
-  } catch (e) {
-    console.error('Error sending from webFrameMain: ', e);
-  }
+  return this._send(true /* internal */, channel, args);
 };
 
 WebFrameMain.prototype.postMessage = function (...args) {

lib/browser/devtools.ts

@@ -67,7 +67,7 @@ ipcMainInternal.handle(IPC_MESSAGES.INSPECTOR_CONTEXT_MENU, function (event, ite
 
     const template = isEditMenu ? getEditMenuItems() : convertToMenuTemplate(items, resolve);
     const menu = Menu.buildFromTemplate(template);
-    const window = event.sender.getOwnerBrowserWindow()!;
+    const window = event.sender.getOwnerBrowserWindow();
 
     menu.popup({ window, callback: () => resolve() });
   });
@@ -94,7 +94,7 @@ ipcMainUtils.handleSync(IPC_MESSAGES.INSPECTOR_CONFIRM, async function (event, m
     buttons: ['OK', 'Cancel'],
     cancelId: 1
   };
-  const window = event.sender.getOwnerBrowserWindow()!;
+  const window = event.sender.getOwnerBrowserWindow();
   const { response } = await dialog.showMessageBox(window, options);
   return response === 0;
 });

lib/browser/guest-view-manager.ts

@@ -4,6 +4,7 @@ import * as ipcMainUtils from '@electron/internal/browser/ipc-main-internal-util
 import { parseWebViewWebPreferences } from '@electron/internal/common/parse-features-string';
 import { syncMethods, asyncMethods, properties } from '@electron/internal/common/web-view-methods';
 import { webViewEvents } from '@electron/internal/common/web-view-events';
+import { serialize } from '@electron/internal/common/type-utils';
 import { IPC_MESSAGES } from '@electron/internal/common/ipc-messages';
 
 interface GuestInstance {
@@ -14,7 +15,6 @@ interface GuestInstance {
 }
 
 const webViewManager = process._linkedBinding('electron_browser_web_view_manager');
-const eventBinding = process._linkedBinding('electron_browser_event');
 
 const supportedWebViewEvents = Object.keys(webViewEvents);
 
@@ -28,7 +28,139 @@ function sanitizeOptionsForGuest (options: Record<string, any>) {
   return ret;
 }
 
-function makeWebPreferences (embedder: Electron.WebContents, params: Record<string, any>) {
+// Create a new guest instance.
+const createGuest = function (embedder: Electron.WebContents, params: Record<string, any>) {
+  // eslint-disable-next-line no-undef
+  const guest = (webContents as typeof ElectronInternal.WebContents).create({
+    type: 'webview',
+    partition: params.partition,
+    embedder
+  });
+  const guestInstanceId = guest.id;
+  guestInstances.set(guestInstanceId, {
+    guest,
+    embedder
+  });
+
+  // Clear the guest from map when it is destroyed.
+  guest.once('destroyed', () => {
+    if (guestInstances.has(guestInstanceId)) {
+      detachGuest(embedder, guestInstanceId);
+    }
+  });
+
+  // Init guest web view after attached.
+  guest.once('did-attach' as any, function (this: Electron.WebContents, event: Electron.Event) {
+    params = this.attachParams!;
+    delete this.attachParams;
+
+    const previouslyAttached = this.viewInstanceId != null;
+    this.viewInstanceId = params.instanceId;
+
+    // Only load URL and set size on first attach
+    if (previouslyAttached) {
+      return;
+    }
+
+    if (params.src) {
+      const opts: Electron.LoadURLOptions = {};
+      if (params.httpreferrer) {
+        opts.httpReferrer = params.httpreferrer;
+      }
+      if (params.useragent) {
+        opts.userAgent = params.useragent;
+      }
+      this.loadURL(params.src, opts);
+    }
+    embedder.emit('did-attach-webview', event, guest);
+  });
+
+  const sendToEmbedder = (channel: string, ...args: any[]) => {
+    if (!embedder.isDestroyed()) {
+      embedder._sendInternal(`${channel}-${guest.viewInstanceId}`, ...args);
+    }
+  };
+
+  // Dispatch events to embedder.
+  const fn = function (event: string) {
+    guest.on(event as any, function (_, ...args: any[]) {
+      sendToEmbedder(IPC_MESSAGES.GUEST_VIEW_INTERNAL_DISPATCH_EVENT, event, ...args);
+    });
+  };
+  for (const event of supportedWebViewEvents) {
+    if (event !== 'new-window') {
+      fn(event);
+    }
+  }
+
+  guest.on('new-window', function (event, url, frameName, disposition, options, additionalFeatures, referrer) {
+    sendToEmbedder(IPC_MESSAGES.GUEST_VIEW_INTERNAL_DISPATCH_EVENT, 'new-window', url,
+      frameName, disposition, sanitizeOptionsForGuest(options),
+      additionalFeatures, referrer);
+  });
+
+  // Dispatch guest's IPC messages to embedder.
+  guest.on('ipc-message-host' as any, function (event: Electron.IpcMainEvent, channel: string, args: any[]) {
+    sendToEmbedder(IPC_MESSAGES.GUEST_VIEW_INTERNAL_IPC_MESSAGE, {
+      frameId: [event.processId, event.frameId],
+      channel,
+      args
+    });
+  });
+
+  // Notify guest of embedder window visibility when it is ready
+  // FIXME Remove once https://github.com/electron/electron/issues/6828 is fixed
+  guest.on('dom-ready', function () {
+    const guestInstance = guestInstances.get(guestInstanceId);
+    if (guestInstance != null && guestInstance.visibilityState != null) {
+      guest._sendInternal(IPC_MESSAGES.GUEST_INSTANCE_VISIBILITY_CHANGE, guestInstance.visibilityState);
+    }
+  });
+
+  return guestInstanceId;
+};
+
+// Attach the guest to an element of embedder.
+const attachGuest = function (event: Electron.IpcMainInvokeEvent,
+  embedderFrameId: number, elementInstanceId: number, guestInstanceId: number, params: Record<string, any>) {
+  const embedder = event.sender;
+  // Destroy the old guest when attaching.
+  const key = `${embedder.id}-${elementInstanceId}`;
+  const oldGuestInstanceId = embedderElementsMap.get(key);
+  if (oldGuestInstanceId != null) {
+    // Reattachment to the same guest is just a no-op.
+    if (oldGuestInstanceId === guestInstanceId) {
+      return;
+    }
+
+    const oldGuestInstance = guestInstances.get(oldGuestInstanceId);
+    if (oldGuestInstance) {
+      oldGuestInstance.guest.detachFromOuterFrame();
+    }
+  }
+
+  const guestInstance = guestInstances.get(guestInstanceId);
+  // If this isn't a valid guest instance then do nothing.
+  if (!guestInstance) {
+    throw new Error(`Invalid guestInstanceId: ${guestInstanceId}`);
+  }
+  const { guest } = guestInstance;
+  if (guest.hostWebContents !== embedder) {
+    throw new Error(`Access denied to guestInstanceId: ${guestInstanceId}`);
+  }
+
+  // If this guest is already attached to an element then remove it
+  if (guestInstance.elementInstanceId) {
+    const oldKey = `${guestInstance.embedder.id}-${guestInstance.elementInstanceId}`;
+    embedderElementsMap.delete(oldKey);
+
+    // Remove guest from embedder if moving across web views
+    if (guest.viewInstanceId !== params.instanceId) {
+      webViewManager.removeGuest(guestInstance.embedder, guestInstanceId);
+      guestInstance.embedder._sendInternal(`${IPC_MESSAGES.GUEST_VIEW_INTERNAL_DESTROY_GUEST}-${guest.viewInstanceId}`);
+    }
+  }
+
   // parse the 'webpreferences' attribute string, if set
   // this uses the same parsing rules as window.open uses for its features
   const parsedWebPreferences =
@@ -37,6 +169,7 @@ function makeWebPreferences (embedder: Electron.WebContents, params: Record<stri
       : null;
 
   const webPreferences: Electron.WebPreferences = {
+    guestInstanceId,
     nodeIntegration: params.nodeintegration != null ? params.nodeintegration : false,
     nodeIntegrationInSubFrames: params.nodeintegrationinsubframes != null ? params.nodeintegrationinsubframes : false,
     plugins: params.plugins,
@@ -64,176 +197,21 @@ function makeWebPreferences (embedder: Electron.WebContents, params: Record<stri
   ]);
 
   // Inherit certain option values from embedder
-  const lastWebPreferences = embedder.getLastWebPreferences()!;
+  const lastWebPreferences = embedder.getLastWebPreferences();
   for (const [name, value] of inheritedWebPreferences) {
     if (lastWebPreferences[name as keyof Electron.WebPreferences] === value) {
       (webPreferences as any)[name] = value;
     }
   }
 
-  return webPreferences;
-}
-
-function makeLoadURLOptions (params: Record<string, any>) {
-  const opts: Electron.LoadURLOptions = {};
-  if (params.httpreferrer) {
-    opts.httpReferrer = params.httpreferrer;
-  }
-  if (params.useragent) {
-    opts.userAgent = params.useragent;
-  }
-  return opts;
-}
-
-// Create a new guest instance.
-const createGuest = function (embedder: Electron.WebContents, embedderFrameId: number, elementInstanceId: number, params: Record<string, any>) {
-  // eslint-disable-next-line no-undef
-  const guest = (webContents as typeof ElectronInternal.WebContents).create({
-    type: 'webview',
-    partition: params.partition,
-    embedder
-  });
-  const guestInstanceId = guest.id;
-  guestInstances.set(guestInstanceId, {
-    guest,
-    embedder
-  });
-
-  // Clear the guest from map when it is destroyed.
-  guest.once('destroyed', () => {
-    if (guestInstances.has(guestInstanceId)) {
-      detachGuest(embedder, guestInstanceId);
-    }
-  });
-
-  // Init guest web view after attached.
-  guest.once('did-attach' as any, function (this: Electron.WebContents, event: Electron.Event) {
-    const params = this.attachParams!;
-    delete this.attachParams;
-
-    const previouslyAttached = this.viewInstanceId != null;
-    this.viewInstanceId = params.instanceId;
-
-    // Only load URL and set size on first attach
-    if (previouslyAttached) {
-      return;
-    }
-
-    if (params.src) {
-      this.loadURL(params.src, params.opts);
-    }
-    embedder.emit('did-attach-webview', event, guest);
-  });
-
-  const sendToEmbedder = (channel: string, ...args: any[]) => {
-    if (!embedder.isDestroyed()) {
-      embedder._sendInternal(`${channel}-${guest.viewInstanceId}`, ...args);
-    }
-  };
-
-  const makeProps = (eventKey: string, args: any[]) => {
-    const props: Record<string, any> = {};
-    webViewEvents[eventKey].forEach((prop, index) => {
-      props[prop] = args[index];
-    });
-    return props;
-  };
-
-  // Dispatch events to embedder.
-  for (const event of supportedWebViewEvents) {
-    guest.on(event as any, function (_, ...args: any[]) {
-      sendToEmbedder(IPC_MESSAGES.GUEST_VIEW_INTERNAL_DISPATCH_EVENT, event, makeProps(event, args));
-    });
-  }
-
-  guest.on('new-window', function (event, url, frameName, disposition, options) {
-    sendToEmbedder(IPC_MESSAGES.GUEST_VIEW_INTERNAL_DISPATCH_EVENT, 'new-window', {
-      url,
-      frameName,
-      disposition,
-      options: sanitizeOptionsForGuest(options)
-    });
-  });
-
-  // Dispatch guest's IPC messages to embedder.
-  guest.on('ipc-message-host' as any, function (event: Electron.IpcMainEvent, channel: string, args: any[]) {
-    sendToEmbedder(IPC_MESSAGES.GUEST_VIEW_INTERNAL_DISPATCH_EVENT, 'ipc-message', {
-      frameId: [event.processId, event.frameId],
-      channel,
-      args
-    });
-  });
-
-  // Notify guest of embedder window visibility when it is ready
-  // FIXME Remove once https://github.com/electron/electron/issues/6828 is fixed
-  guest.on('dom-ready', function () {
-    const guestInstance = guestInstances.get(guestInstanceId);
-    if (guestInstance != null && guestInstance.visibilityState != null) {
-      guest._sendInternal(IPC_MESSAGES.GUEST_INSTANCE_VISIBILITY_CHANGE, guestInstance.visibilityState);
-    }
-  });
-
-  if (attachGuest(embedder, embedderFrameId, elementInstanceId, guestInstanceId, params)) {
-    return guestInstanceId;
-  }
-
-  return -1;
-};
-
-// Attach the guest to an element of embedder.
-const attachGuest = function (embedder: Electron.WebContents, embedderFrameId: number, elementInstanceId: number, guestInstanceId: number, params: Record<string, any>) {
-  // Destroy the old guest when attaching.
-  const key = `${embedder.id}-${elementInstanceId}`;
-  const oldGuestInstanceId = embedderElementsMap.get(key);
-  if (oldGuestInstanceId != null) {
-    // Reattachment to the same guest is just a no-op.
-    if (oldGuestInstanceId === guestInstanceId) {
-      return false;
-    }
-
-    const oldGuestInstance = guestInstances.get(oldGuestInstanceId);
-    if (oldGuestInstance) {
-      oldGuestInstance.guest.detachFromOuterFrame();
-    }
-  }
-
-  const guestInstance = guestInstances.get(guestInstanceId);
-  // If this isn't a valid guest instance then do nothing.
-  if (!guestInstance) {
-    console.error(new Error(`Guest attach failed: Invalid guestInstanceId ${guestInstanceId}`));
-    return false;
-  }
-  const { guest } = guestInstance;
-  if (guest.hostWebContents !== embedder) {
-    console.error(new Error(`Guest attach failed: Access denied to guestInstanceId ${guestInstanceId}`));
-    return false;
-  }
-
-  const { instanceId } = params;
-
-  // If this guest is already attached to an element then remove it
-  if (guestInstance.elementInstanceId) {
-    const oldKey = `${guestInstance.embedder.id}-${guestInstance.elementInstanceId}`;
-    embedderElementsMap.delete(oldKey);
-
-    // Remove guest from embedder if moving across web views
-    if (guest.viewInstanceId !== instanceId) {
-      webViewManager.removeGuest(guestInstance.embedder, guestInstanceId);
-      guestInstance.embedder._sendInternal(`${IPC_MESSAGES.GUEST_VIEW_INTERNAL_DESTROY_GUEST}-${guest.viewInstanceId}`);
-    }
-  }
-
-  const webPreferences = makeWebPreferences(embedder, params);
-
-  const event = eventBinding.createWithSender(embedder);
   embedder.emit('will-attach-webview', event, webPreferences, params);
   if (event.defaultPrevented) {
-    if (guest.viewInstanceId == null) guest.viewInstanceId = instanceId;
+    if (guest.viewInstanceId == null) guest.viewInstanceId = params.instanceId;
     guest.destroy();
-    return false;
+    return;
   }
 
-  guest.attachParams = { instanceId, src: params.src, opts: makeLoadURLOptions(params) };
+  guest.attachParams = params;
   embedderElementsMap.set(key, guestInstanceId);
 
   guest.setEmbedder(embedder);
@@ -244,7 +222,6 @@ const attachGuest = function (embedder: Electron.WebContents, embedderFrameId: n
 
   webViewManager.addGuest(guestInstanceId, embedder, guest, webPreferences);
   guest.attachToIframe(embedder, embedderFrameId);
-  return true;
 };
 
 // Remove an guest-embedder relationship.
@@ -329,8 +306,16 @@ const handleMessageSync = function (channel: string, handler: (event: ElectronIn
   ipcMainUtils.handleSync(channel, makeSafeHandler(channel, handler));
 };
 
-handleMessage(IPC_MESSAGES.GUEST_VIEW_MANAGER_CREATE_AND_ATTACH_GUEST, function (event, embedderFrameId: number, elementInstanceId: number, params) {
-  return createGuest(event.sender, embedderFrameId, elementInstanceId, params);
+handleMessage(IPC_MESSAGES.GUEST_VIEW_MANAGER_CREATE_GUEST, function (event, params) {
+  return createGuest(event.sender, params);
+});
+
+handleMessage(IPC_MESSAGES.GUEST_VIEW_MANAGER_ATTACH_GUEST, function (event, embedderFrameId: number, elementInstanceId: number, guestInstanceId: number, params) {
+  try {
+    attachGuest(event, embedderFrameId, elementInstanceId, guestInstanceId, params);
+  } catch (error) {
+    console.error(`Guest attach failed: ${error}`);
+  }
 });
 
 handleMessageSync(IPC_MESSAGES.GUEST_VIEW_MANAGER_DETACH_GUEST, function (event, guestInstanceId: number) {
@@ -378,6 +363,12 @@ handleMessageSync(IPC_MESSAGES.GUEST_VIEW_MANAGER_PROPERTY_SET, function (event,
   (guest as any)[property] = val;
 });
 
+handleMessage(IPC_MESSAGES.GUEST_VIEW_MANAGER_CAPTURE_PAGE, async function (event, guestInstanceId: number, args: any[]) {
+  const guest = getGuestForWebContents(guestInstanceId, event.sender);
+
+  return serialize(await guest.capturePage(...args));
+});
+
 // Returns WebContents from its guest id hosted in given webContents.
 const getGuestForWebContents = function (guestInstanceId: number, contents: Electron.WebContents) {
   const guestInstance = guestInstances.get(guestInstanceId);

lib/browser/guest-window-manager.ts

@@ -65,13 +65,8 @@ export function openGuestWindow ({ event, embedder, guest, referrer, disposition
   // https://html.spec.whatwg.org/multipage/window-object.html#apis-for-creating-and-navigating-browsing-contexts-by-name
   const existingWindow = getGuestWindowByFrameName(frameName);
   if (existingWindow) {
-    if (existingWindow.isDestroyed() || existingWindow.webContents.isDestroyed()) {
-      // FIXME(t57ser): The webContents is destroyed for some reason, unregister the frame name
-      unregisterFrameName(frameName);
-    } else {
-      existingWindow.loadURL(url);
-      return existingWindow;
-    }
+    existingWindow.loadURL(url);
+    return existingWindow;
   }
 
   const window = new BrowserWindow({
@@ -149,7 +144,7 @@ function emitDeprecatedNewWindowEvent ({ event, embedder, guest, windowOpenArgs,
   postData?: PostData,
 }): boolean {
   const { url, frameName } = windowOpenArgs;
-  const isWebViewWithPopupsDisabled = embedder.getType() === 'webview' && embedder.getLastWebPreferences()!.disablePopups;
+  const isWebViewWithPopupsDisabled = embedder.getType() === 'webview' && embedder.getLastWebPreferences().disablePopups;
   const postBody = postData ? {
     data: postData,
     ...parseContentTypeFormat(postData)
@@ -217,10 +212,6 @@ function makeBrowserWindowOptions ({ embedder, features, overrideOptions }: {
       height: 600,
       ...parsedOptions,
       ...overrideOptions,
-      // Note that for |nativeWindowOpen: true| the WebContents is created in
-      // |api::WebContents::WebContentsCreatedWithFullParams|, with prefs
-      // parsed in the |-will-add-new-contents| event.
-      // The |webPreferences| here is only used by |nativeWindowOpen: false|.
       webPreferences: makeWebPreferences({
         embedder,
         insecureParsedWebPreferences: parsedWebPreferences,
@@ -238,7 +229,7 @@ export function makeWebPreferences ({ embedder, secureOverrideWebPreferences = {
   // have unvetted prefs, use parsedWebPreferences.
   secureOverrideWebPreferences?: BrowserWindowConstructorOptions['webPreferences'],
 }) {
-  const parentWebPreferences = embedder.getLastWebPreferences()!;
+  const parentWebPreferences = embedder.getLastWebPreferences();
   const securityWebPreferencesFromParent = (Object.keys(securityWebPreferences).reduce((map, key) => {
     if (securityWebPreferences[key] === parentWebPreferences[key as keyof Electron.WebPreferences]) {
       (map as any)[key] = parentWebPreferences[key as keyof Electron.WebPreferences];

lib/browser/guest-window-proxy.ts

@@ -28,7 +28,7 @@ const getGuestWindow = function (guestContents: WebContents) {
 };
 
 const isChildWindow = function (sender: WebContents, target: WebContents) {
-  return target.getLastWebPreferences()!.openerId === sender.id;
+  return target.getLastWebPreferences().openerId === sender.id;
 };
 
 const isRelatedWindow = function (sender: WebContents, target: WebContents) {
@@ -43,7 +43,7 @@ const isScriptableWindow = function (sender: WebContents, target: WebContents) {
 };
 
 const isNodeIntegrationEnabled = function (sender: WebContents) {
-  return sender.getLastWebPreferences()!.nodeIntegration === true;
+  return sender.getLastWebPreferences().nodeIntegration === true;
 };
 
 // Checks whether |sender| can access the |target|:
@@ -65,7 +65,7 @@ ipcMainInternal.on(
     features: string
   ) => {
     // This should only be allowed for senders that have nativeWindowOpen: false
-    const lastWebPreferences = event.sender.getLastWebPreferences()!;
+    const lastWebPreferences = event.sender.getLastWebPreferences();
     if (lastWebPreferences.nativeWindowOpen || lastWebPreferences.sandbox) {
       event.returnValue = null;
       throw new Error(

lib/browser/rpc-server.ts

@@ -4,6 +4,7 @@ import { clipboard } from 'electron/common';
 import * as fs from 'fs';
 import { ipcMainInternal } from '@electron/internal/browser/ipc-main-internal';
 import * as ipcMainUtils from '@electron/internal/browser/ipc-main-internal-utils';
+import * as typeUtils from '@electron/internal/common/type-utils';
 import { IPC_MESSAGES } from '@electron/internal/common/ipc-messages';
 
 import type * as desktopCapturerModule from '@electron/internal/browser/desktop-capturer';
@@ -38,10 +39,6 @@ ipcMainInternal.handle(IPC_MESSAGES.BROWSER_GET_LAST_WEB_PREFERENCES, function (
   return event.sender.getLastWebPreferences();
 });
 
-ipcMainInternal.handle(IPC_MESSAGES.BROWSER_GET_PROCESS_MEMORY_INFO, function (event) {
-  return event.sender._getProcessMemoryInfo();
-});
-
 // Methods not listed in this set are called directly in the renderer process.
 const allowedClipboardMethods = (() => {
   switch (process.platform) {
@@ -59,7 +56,7 @@ ipcMainUtils.handleSync(IPC_MESSAGES.BROWSER_CLIPBOARD_SYNC, function (event, me
     throw new Error(`Invalid method: ${method}`);
   }
 
-  return (clipboard as any)[method](...args);
+  return typeUtils.serialize((clipboard as any)[method](...typeUtils.deserialize(args)));
 });
 
 if (BUILDFLAG(ENABLE_DESKTOP_CAPTURER)) {
@@ -74,7 +71,7 @@ if (BUILDFLAG(ENABLE_DESKTOP_CAPTURER)) {
       return [];
     }
 
-    return await desktopCapturer.getSourcesImpl(event.sender, options);
+    return typeUtils.serialize(await desktopCapturer.getSourcesImpl(event.sender, options));
   });
 }
 

lib/common/api/clipboard.ts

@@ -1,14 +1,20 @@
 import { IPC_MESSAGES } from '@electron/internal/common/ipc-messages';
 
 import type * as ipcRendererUtilsModule from '@electron/internal/renderer/ipc-renderer-internal-utils';
+import type * as typeUtilsModule from '@electron/internal/common/type-utils';
 
 const clipboard = process._linkedBinding('electron_common_clipboard');
 
 if (process.type === 'renderer') {
   const ipcRendererUtils = require('@electron/internal/renderer/ipc-renderer-internal-utils') as typeof ipcRendererUtilsModule;
+  const typeUtils = require('@electron/internal/common/type-utils') as typeof typeUtilsModule;
 
-  const makeRemoteMethod = function (method: keyof Electron.Clipboard): any {
-    return (...args: any[]) => ipcRendererUtils.invokeSync(IPC_MESSAGES.BROWSER_CLIPBOARD_SYNC, method, ...args);
+  const makeRemoteMethod = function (method: keyof Electron.Clipboard) {
+    return (...args: any[]) => {
+      args = typeUtils.serialize(args);
+      const result = ipcRendererUtils.invokeSync(IPC_MESSAGES.BROWSER_CLIPBOARD_SYNC, method, ...args);
+      return typeUtils.deserialize(result);
+    };
   };
 
   if (process.platform === 'linux') {

lib/common/api/module-list.ts

@@ -1,7 +1,6 @@
 // Common modules, please sort alphabetically
 export const commonModuleList: ElectronInternal.ModuleEntry[] = [
   { name: 'clipboard', loader: () => require('./clipboard') },
-  { name: 'nativeImage', loader: () => require('./native-image') },
   { name: 'shell', loader: () => require('./shell') },
   // The internal modules, invisible unless you know their names.
   { name: 'deprecate', loader: () => require('./deprecate'), private: true }

lib/common/ipc-messages.ts

@@ -4,17 +4,19 @@ export const enum IPC_MESSAGES {
   BROWSER_PRELOAD_ERROR = 'BROWSER_PRELOAD_ERROR',
   BROWSER_SANDBOX_LOAD = 'BROWSER_SANDBOX_LOAD',
   BROWSER_WINDOW_CLOSE = 'BROWSER_WINDOW_CLOSE',
-  BROWSER_GET_PROCESS_MEMORY_INFO = 'BROWSER_GET_PROCESS_MEMORY_INFO',
 
   GUEST_INSTANCE_VISIBILITY_CHANGE = 'GUEST_INSTANCE_VISIBILITY_CHANGE',
 
   GUEST_VIEW_INTERNAL_DESTROY_GUEST = 'GUEST_VIEW_INTERNAL_DESTROY_GUEST',
   GUEST_VIEW_INTERNAL_DISPATCH_EVENT = 'GUEST_VIEW_INTERNAL_DISPATCH_EVENT',
+  GUEST_VIEW_INTERNAL_IPC_MESSAGE = 'GUEST_VIEW_INTERNAL_IPC_MESSAGE',
 
-  GUEST_VIEW_MANAGER_CREATE_AND_ATTACH_GUEST = 'GUEST_VIEW_MANAGER_CREATE_AND_ATTACH_GUEST',
+  GUEST_VIEW_MANAGER_CREATE_GUEST = 'GUEST_VIEW_MANAGER_CREATE_GUEST',
+  GUEST_VIEW_MANAGER_ATTACH_GUEST = 'GUEST_VIEW_MANAGER_ATTACH_GUEST',
   GUEST_VIEW_MANAGER_DETACH_GUEST = 'GUEST_VIEW_MANAGER_DETACH_GUEST',
   GUEST_VIEW_MANAGER_FOCUS_CHANGE = 'GUEST_VIEW_MANAGER_FOCUS_CHANGE',
   GUEST_VIEW_MANAGER_CALL = 'GUEST_VIEW_MANAGER_CALL',
+  GUEST_VIEW_MANAGER_CAPTURE_PAGE = 'GUEST_VIEW_MANAGER_CAPTURE_PAGE',
   GUEST_VIEW_MANAGER_PROPERTY_GET = 'GUEST_VIEW_MANAGER_PROPERTY_GET',
   GUEST_VIEW_MANAGER_PROPERTY_SET = 'GUEST_VIEW_MANAGER_PROPERTY_SET',
 

lib/common/remote/ipc-messages.ts

@@ -0,0 +1,19 @@
+export const enum IPC_MESSAGES {
+  BROWSER_REQUIRE = 'REMOTE_BROWSER_REQUIRE',
+  BROWSER_GET_BUILTIN = 'REMOTE_BROWSER_GET_BUILTIN',
+  BROWSER_GET_GLOBAL = 'REMOTE_BROWSER_GET_GLOBAL',
+  BROWSER_GET_CURRENT_WINDOW = 'REMOTE_BROWSER_GET_CURRENT_WINDOW',
+  BROWSER_GET_CURRENT_WEB_CONTENTS = 'REMOTE_BROWSER_GET_CURRENT_WEB_CONTENTS',
+  BROWSER_CONSTRUCTOR = 'REMOTE_BROWSER_CONSTRUCTOR',
+  BROWSER_FUNCTION_CALL = 'REMOTE_BROWSER_FUNCTION_CALL',
+  BROWSER_MEMBER_CONSTRUCTOR = 'REMOTE_BROWSER_MEMBER_CONSTRUCTOR',
+  BROWSER_MEMBER_CALL = 'REMOTE_BROWSER_MEMBER_CALL',
+  BROWSER_MEMBER_GET = 'REMOTE_BROWSER_MEMBER_GET',
+  BROWSER_MEMBER_SET = 'REMOTE_BROWSER_MEMBER_SET',
+  BROWSER_DEREFERENCE = 'REMOTE_BROWSER_DEREFERENCE',
+  BROWSER_CONTEXT_RELEASE = 'REMOTE_BROWSER_CONTEXT_RELEASE',
+  BROWSER_WRONG_CONTEXT_ERROR = 'REMOTE_BROWSER_WRONG_CONTEXT_ERROR',
+
+  RENDERER_CALLBACK = 'REMOTE_RENDERER_CALLBACK',
+  RENDERER_RELEASE_CALLBACK = 'REMOTE_RENDERER_RELEASE_CALLBACK',
+}

lib/common/type-utils.ts

@@ -0,0 +1,110 @@
+function getCreateNativeImage () {
+  return process._linkedBinding('electron_common_native_image').nativeImage.createEmpty;
+}
+
+export function isPromise (val: any) {
+  return (
+    val &&
+    val.then &&
+    val.then instanceof Function &&
+    val.constructor &&
+    val.constructor.reject &&
+    val.constructor.reject instanceof Function &&
+    val.constructor.resolve &&
+    val.constructor.resolve instanceof Function
+  );
+}
+
+const serializableTypes = [
+  Boolean,
+  Number,
+  String,
+  Date,
+  Error,
+  RegExp,
+  ArrayBuffer
+];
+
+// https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#Supported_types
+export function isSerializableObject (value: any) {
+  return value === null || ArrayBuffer.isView(value) || serializableTypes.some(type => value instanceof type);
+}
+
+const objectMap = function (source: Object, mapper: (value: any) => any) {
+  const sourceEntries = Object.entries(source);
+  const targetEntries = sourceEntries.map(([key, val]) => [key, mapper(val)]);
+  return Object.fromEntries(targetEntries);
+};
+
+function serializeNativeImage (image: Electron.NativeImage) {
+  const representations = [];
+  const scaleFactors = image.getScaleFactors();
+
+  // Use Buffer when there's only one representation for better perf.
+  // This avoids compressing to/from PNG where it's not necessary to
+  // ensure uniqueness of dataURLs (since there's only one).
+  if (scaleFactors.length === 1) {
+    const scaleFactor = scaleFactors[0];
+    const size = image.getSize(scaleFactor);
+    const buffer = image.toBitmap({ scaleFactor });
+    representations.push({ scaleFactor, size, buffer });
+  } else {
+    // Construct from dataURLs to ensure that they are not lost in creation.
+    for (const scaleFactor of scaleFactors) {
+      const size = image.getSize(scaleFactor);
+      const dataURL = image.toDataURL({ scaleFactor });
+      representations.push({ scaleFactor, size, dataURL });
+    }
+  }
+  return { __ELECTRON_SERIALIZED_NativeImage__: true, representations };
+}
+
+function deserializeNativeImage (value: any, createNativeImage: typeof Electron.nativeImage['createEmpty']) {
+  const image = createNativeImage();
+
+  // Use Buffer when there's only one representation for better perf.
+  // This avoids compressing to/from PNG where it's not necessary to
+  // ensure uniqueness of dataURLs (since there's only one).
+  if (value.representations.length === 1) {
+    const { buffer, size, scaleFactor } = value.representations[0];
+    const { width, height } = size;
+    image.addRepresentation({ buffer, scaleFactor, width, height });
+  } else {
+    // Construct from dataURLs to ensure that they are not lost in creation.
+    for (const rep of value.representations) {
+      const { dataURL, size, scaleFactor } = rep;
+      const { width, height } = size;
+      image.addRepresentation({ dataURL, scaleFactor, width, height });
+    }
+  }
+
+  return image;
+}
+
+export function serialize (value: any): any {
+  if (value && value.constructor && value.constructor.name === 'NativeImage') {
+    return serializeNativeImage(value);
+  } if (Array.isArray(value)) {
+    return value.map(serialize);
+  } else if (isSerializableObject(value)) {
+    return value;
+  } else if (value instanceof Object) {
+    return objectMap(value, serialize);
+  } else {
+    return value;
+  }
+}
+
+export function deserialize (value: any, createNativeImage: typeof Electron.nativeImage['createEmpty'] = getCreateNativeImage()): any {
+  if (value && value.__ELECTRON_SERIALIZED_NativeImage__) {
+    return deserializeNativeImage(value, createNativeImage);
+  } else if (Array.isArray(value)) {
+    return value.map(value => deserialize(value, createNativeImage));
+  } else if (isSerializableObject(value)) {
+    return value;
+  } else if (value instanceof Object) {
+    return objectMap(value, value => deserialize(value, createNativeImage));
+  } else {
+    return value;
+  }
+}

lib/common/web-view-events.ts

@@ -12,6 +12,7 @@ export const webViewEvents: Record<string, readonly string[]> = {
   'devtools-opened': [],
   'devtools-closed': [],
   'devtools-focused': [],
+  'new-window': ['url', 'frameName', 'disposition', 'options'],
   'will-navigate': ['url'],
   'did-start-navigation': ['url', 'isInPlace', 'isMainFrame', 'frameProcessId', 'frameRoutingId'],
   'did-redirect-navigation': ['url', 'isInPlace', 'isMainFrame', 'frameProcessId', 'frameRoutingId'],

lib/common/web-view-methods.ts

@@ -59,7 +59,6 @@ export const properties = new Set([
 ]);
 
 export const asyncMethods = new Set([
-  'capturePage',
   'loadURL',
   'executeJavaScript',
   'insertCSS',