Bump v9.0.0-beta.13

* fix: webRequest module should work with file:// protocol

* test: do not trigger unhandled promise rejections

.circleci/config.yml

@@ -67,10 +67,6 @@ machine-linux-medium: &machine-linux-medium
   <<: *docker-image
   resource_class: medium
 
-machine-linux-xlarge: &machine-linux-xlarge
-  <<: *docker-image
-  resource_class: xlarge
-
 machine-linux-2xlarge: &machine-linux-2xlarge
   <<: *docker-image
   resource_class: 2xlarge+
@@ -231,25 +227,7 @@ step-gclient-sync: &step-gclient-sync
           $GCLIENT_EXTRA_ARGS \
           "$CIRCLE_REPOSITORY_URL"
 
-        ELECTRON_USE_THREE_WAY_MERGE_FOR_PATCHES=1 gclient sync --with_branch_heads --with_tags
-        # Re-export all the patches to check if there were changes.
-        python src/electron/script/export_all_patches.py src/electron/patches/config.json
-        cd src/electron
-        git update-index --refresh || true
-        if ! git diff-index --quiet HEAD --; then
-          # There are changes to the patches. Make a git commit with the updated patches
-          git add patches
-          GIT_COMMITTER_NAME="Electron Bot" GIT_COMMITTER_EMAIL="anonymous@electronjs.org" git commit -m "update patches" --author="Electron Bot <anonymous@electronjs.org>"
-          # Export it
-          mkdir -p ../../patches
-          git format-patch -1 --stdout --keep-subject --no-stat --full-index > ../../patches/update-patches.patch
-          echo
-          echo "======================================================================"
-          echo "There were changes to the patches when applying."
-          echo "Check the CI artifacts for a patch you can apply to fix it."
-          echo "======================================================================"
-          exit 1
-        fi
+        gclient sync --with_branch_heads --with_tags
       fi
 
 step-setup-env-for-build: &step-setup-env-for-build
@@ -313,29 +291,21 @@ step-get-more-space-on-mac: &step-get-more-space-on-mac
     command: |
       if [ "`uname`" == "Darwin" ]; then
         sudo rm -rf /Library/Developer/CoreSimulator
-        sudo rm -rf $(xcode-select -p)/Platforms/AppleTVOS.platform
-        sudo rm -rf $(xcode-select -p)/Platforms/iPhoneOS.platform
-        sudo rm -rf $(xcode-select -p)/Platforms/WatchOS.platform
-        sudo rm -rf $(xcode-select -p)/Platforms/WatchSimulator.platform
-        sudo rm -rf $(xcode-select -p)/Platforms/AppleTVSimulator.platform
-        sudo rm -rf $(xcode-select -p)/Platforms/iPhoneSimulator.platform
-        sudo rm -rf ~/.rubies
-        sudo rm -rf ~/Library/Caches/Homebrew
-        sudo rm -rf /usr/local/Homebrew
+        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/AppleTVOS.platform
+        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform
+        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/WatchOS.platform
+        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/WatchSimulator.platform
+        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/AppleTVSimulator.platform
+        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform
       fi
 
-# On macOS delete all .git directories under src/ expect for
-# third_party/angle/ because of build time generation of file
-# gen/angle/commit.h depends on third_party/angle/.git/HEAD
-# https://chromium-review.googlesource.com/c/angle/angle/+/2074924
-# TODO: maybe better to always leave out */.git/HEAD file for all targets ?
 step-delete-git-directories: &step-delete-git-directories
   run:
     name: Delete all .git directories under src on MacOS to free space
     command: |
       if [ "`uname`" == "Darwin" ]; then
         cd src
-        ( find . -type d -name ".git" -not -path "./third_party/angle/*" ) | xargs rm -rf
+        ( find . -type d -name ".git" ) | xargs rm -rf
       fi
 
 # On macOS the yarn install command during gclient sync was run on a linux
@@ -421,7 +391,6 @@ step-electron-build: &step-electron-build
       fi
       cd src
       ninja -C out/Default electron -j $NUMBER_OF_NINJA_PROCESSES
-      node electron/script/check-symlinks.js
 
 step-native-unittests-build: &step-native-unittests-build
   run:
@@ -492,7 +461,7 @@ step-electron-maybe-chromedriver-gn-gen: &step-electron-maybe-chromedriver-gn-ge
       cd src
       if [ "$TARGET_ARCH" == "arm" ] || [ "$TARGET_ARCH" == "arm64" ]; then
         if [ "$USE_GOMA" == "true" ]; then
-          gn gen out/chromedriver --args="import(\"$GN_CONFIG\") import(\"$GN_GOMA_FILE\") is_component_ffmpeg=false proprietary_codecs=false $GN_EXTRA_ARGS $GN_BUILDFLAG_ARGS"
+          gn gen out/chromedriver --args="import(\"$GN_CONFIG\") import(\"//electron/build/args/goma.gn\") is_component_ffmpeg=false proprietary_codecs=false $GN_EXTRA_ARGS $GN_BUILDFLAG_ARGS"
         else
           gn gen out/chromedriver --args="import(\"$GN_CONFIG\") cc_wrapper=\"$SCCACHE_PATH\" is_component_ffmpeg=false proprietary_codecs=false $GN_EXTRA_ARGS $GN_BUILDFLAG_ARGS"
         fi
@@ -607,7 +576,7 @@ step-ffmpeg-gn-gen: &step-ffmpeg-gn-gen
     command: |
       cd src
       if [ "$USE_GOMA" == "true" ]; then
-        gn gen out/ffmpeg --args="import(\"//electron/build/args/ffmpeg.gn\") import(\"$GN_GOMA_FILE\") $GN_EXTRA_ARGS"
+        gn gen out/ffmpeg --args="import(\"//electron/build/args/ffmpeg.gn\") import(\"//electron/build/args/goma.gn\") $GN_EXTRA_ARGS"
       else
         gn gen out/ffmpeg --args="import(\"//electron/build/args/ffmpeg.gn\") cc_wrapper=\"$SCCACHE_PATH\" $GN_EXTRA_ARGS"
       fi
@@ -674,10 +643,8 @@ step-mksnapshot-build: &step-mksnapshot-build
       if [ "`uname`" != "Darwin" ]; then
         if [ "$TARGET_ARCH" == "arm" ]; then
           electron/script/strip-binaries.py --file $PWD/out/Default/clang_x86_v8_arm/mksnapshot
-          electron/script/strip-binaries.py --file $PWD/out/Default/clang_x86_v8_arm/v8_context_snapshot_generator
         elif [ "$TARGET_ARCH" == "arm64" ]; then
           electron/script/strip-binaries.py --file $PWD/out/Default/clang_x64_v8_arm64/mksnapshot
-          electron/script/strip-binaries.py --file $PWD/out/Default/clang_x64_v8_arm64/v8_context_snapshot_generator
         else
           electron/script/strip-binaries.py --file $PWD/out/Default/mksnapshot
           electron/script/strip-binaries.py --file $PWD/out/Default/v8_context_snapshot_generator
@@ -710,11 +677,12 @@ step-hunspell-store: &step-hunspell-store
 step-maybe-generate-breakpad-symbols: &step-maybe-generate-breakpad-symbols
   run:
     name: Generate breakpad symbols
-    no_output_timeout: 30m
     command: |
       if [ "$GENERATE_SYMBOLS" == "true" ]; then
         cd src
         ninja -C out/Default electron:electron_symbols
+        cd out/Default/breakpad_symbols
+        find . -name \*.sym -print0 | xargs -0 npx @sentry/cli@1.51.1 difutil bundle-sources
       fi
 
 step-maybe-zip-symbols: &step-maybe-zip-symbols
@@ -833,7 +801,7 @@ step-restore-out-cache: &step-restore-out-cache
     paths:
       - ./src/out/Default
     keys:
-      - v8-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
+      - v7-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
     name: Restoring out cache
 
 step-set-git-cache-path: &step-set-git-cache-path
@@ -857,7 +825,7 @@ step-save-out-cache: &step-save-out-cache
   save_cache:
     paths:
       - ./src/out/Default
-    key: v8-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
+    key: v7-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
     name: Persisting out cache
 
 step-run-electron-only-hooks: &step-run-electron-only-hooks
@@ -1004,8 +972,6 @@ steps-checkout-and-save-cache: &steps-checkout-and-save-cache
     - *step-set-git-cache-path
     # This sync call only runs if .circle-sync-done is an EMPTY file
     - *step-gclient-sync
-    - store_artifacts:
-        path: patches
     - *step-save-git-cache
     # These next few steps reset Electron to the correct commit regardless of which cache was restored
     - run:
@@ -1024,6 +990,7 @@ steps-checkout-and-save-cache: &steps-checkout-and-save-cache
           sudo chown -R $(id -u):$(id -g) /portal
           mv ./src /portal
     - *step-save-src-cache
+    - *step-save-brew-cache
 
 steps-electron-gn-check: &steps-electron-gn-check
   steps:
@@ -1044,8 +1011,8 @@ steps-electron-ts-compile-for-doc-change: &steps-electron-ts-compile-for-doc-cha
     - *step-depot-tools-get
     - *step-depot-tools-add-to-path
     - *step-restore-brew-cache
-    - *step-install-gnutar-on-mac
     - *step-get-more-space-on-mac
+    - *step-install-gnutar-on-mac
     - *step-generate-deps-hash
     - *step-touch-sync-done
     - maybe-restore-portaled-src-cache
@@ -1132,6 +1099,18 @@ steps-verify-ffmpeg: &steps-verify-ffmpeg
     - *step-verify-ffmpeg
     - *step-maybe-notify-slack-failure
 
+steps-verify-mksnapshot: &steps-verify-mksnapshot
+  steps:
+    - attach_workspace:
+        at: .
+    - *step-depot-tools-add-to-path
+    - *step-electron-dist-unzip
+    - *step-mksnapshot-unzip
+    - *step-setup-linux-for-headless-testing
+
+    - *step-verify-mksnapshot
+    - *step-maybe-notify-slack-failure
+
 steps-verify-chromedriver: &steps-verify-chromedriver
   steps:
     - attach_workspace:
@@ -1167,8 +1146,8 @@ steps-tests: &steps-tests
           ELECTRON_DISABLE_SECURITY_WARNINGS: 1
         command: |
           cd src
-          (cd electron && node script/yarn test --runners=main --trace-uncaught --enable-logging --files $(circleci tests glob spec-main/*-spec.ts | circleci tests split))
-          (cd electron && node script/yarn test --runners=remote --trace-uncaught --enable-logging --files $(circleci tests glob spec/*-spec.js | circleci tests split))
+          (cd electron && node script/yarn test --runners=main --enable-logging --files $(circleci tests glob spec-main/*-spec.ts | circleci tests split))
+          (cd electron && node script/yarn test --runners=remote --enable-logging --files $(circleci tests glob spec/*-spec.js | circleci tests split))
     - run:
         name: Check test results existence
         command: |
@@ -1300,7 +1279,6 @@ commands:
                 at: .
       - *step-restore-brew-cache
       - *step-install-gnutar-on-mac
-      - *step-save-brew-cache
       - when:
           condition: << parameters.checkout-and-assume-cache >>
           steps:
@@ -1326,8 +1304,6 @@ commands:
             - *step-set-git-cache-path
             # This sync call only runs if .circle-sync-done is an EMPTY file
             - *step-gclient-sync
-            - store_artifacts:
-                path: patches
             # These next few steps reset Electron to the correct commit regardless of which cache was restored
             - when:
                 condition: << parameters.preserve-vendor-dirs >>
@@ -1640,9 +1616,9 @@ jobs:
 
   # Layer 2: Builds.
   linux-x64-testing:
-    <<: *machine-linux-xlarge
+    <<: *machine-linux-2xlarge
     environment:
-      <<: *env-global
+      <<: *env-linux-2xlarge
       <<: *env-testing-build
       <<: *env-ninja-status
       GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
@@ -1698,7 +1674,6 @@ jobs:
     <<: *machine-linux-2xlarge
     environment:
       <<: *env-linux-2xlarge-release
-      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       <<: *env-release-build
       <<: *env-enable-sccache
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
@@ -1711,6 +1686,7 @@ jobs:
     <<: *machine-linux-2xlarge
     environment:
       <<: *env-linux-2xlarge-release
+      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       <<: *env-release-build
       <<: *env-enable-sccache
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
@@ -1720,9 +1696,9 @@ jobs:
           checkout: false
 
   linux-ia32-testing:
-    <<: *machine-linux-xlarge
+    <<: *machine-linux-2xlarge
     environment:
-      <<: *env-global
+      <<: *env-linux-2xlarge
       <<: *env-ia32
       <<: *env-testing-build
       <<: *env-ninja-status
@@ -1760,7 +1736,6 @@ jobs:
     <<: *machine-linux-2xlarge
     environment:
       <<: *env-linux-2xlarge-release
-      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       <<: *env-ia32
       <<: *env-release-build
       <<: *env-enable-sccache
@@ -1775,6 +1750,7 @@ jobs:
     <<: *machine-linux-2xlarge
     environment:
       <<: *env-linux-2xlarge-release
+      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       <<: *env-ia32
       <<: *env-release-build
       <<: *env-enable-sccache
@@ -1786,9 +1762,9 @@ jobs:
           checkout: false
 
   linux-arm-testing:
-    <<: *machine-linux-xlarge
+    <<: *machine-linux-2xlarge
     environment:
-      <<: *env-global
+      <<: *env-linux-2xlarge
       <<: *env-arm
       <<: *env-testing-build
       <<: *env-ninja-status
@@ -1831,7 +1807,6 @@ jobs:
       <<: *env-release-build
       <<: *env-enable-sccache
       <<: *env-32bit-release
-      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
     steps:
       - electron-publish:  
@@ -1846,6 +1821,7 @@ jobs:
       <<: *env-release-build
       <<: *env-enable-sccache
       <<: *env-32bit-release
+      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
     steps:
       - electron-publish:  
@@ -1853,9 +1829,9 @@ jobs:
           checkout: false
 
   linux-arm64-testing:
-    <<: *machine-linux-xlarge
+    <<: *machine-linux-2xlarge
     environment:
-      <<: *env-global
+      <<: *env-linux-2xlarge
       <<: *env-arm64
       <<: *env-testing-build
       <<: *env-ninja-status
@@ -1905,7 +1881,6 @@ jobs:
       <<: *env-arm64
       <<: *env-release-build
       <<: *env-enable-sccache
-      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm64=True --custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
     steps:
       - electron-publish:  
@@ -1919,6 +1894,7 @@ jobs:
       <<: *env-arm64
       <<: *env-release-build
       <<: *env-enable-sccache
+      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm64=True --custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
     steps:
       - electron-publish:  
@@ -1975,7 +1951,6 @@ jobs:
       <<: *env-mac-large-release
       <<: *env-release-build
       <<: *env-enable-sccache
-      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
     steps:
       - electron-publish:  
@@ -1988,6 +1963,7 @@ jobs:
       <<: *env-mac-large-release
       <<: *env-release-build
       <<: *env-enable-sccache
+      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
     steps:
       - electron-publish:  
@@ -2018,6 +1994,14 @@ jobs:
       <<: *env-testing-build
     <<: *steps-electron-gn-check
 
+  mas-chromedriver:
+    <<: *machine-mac
+    environment:
+      <<: *env-machine-mac
+      <<: *env-release-build
+      <<: *env-send-slack-notifications
+    <<: *steps-chromedriver-build
+
   mas-release:
     <<: *machine-mac-large
     environment:
@@ -2040,7 +2024,6 @@ jobs:
       <<: *env-mas
       <<: *env-release-build
       <<: *env-enable-sccache
-      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
     steps:
       - electron-publish:  
@@ -2054,6 +2037,7 @@ jobs:
       <<: *env-mas
       <<: *env-release-build
       <<: *env-enable-sccache
+      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
       UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
     steps:
       - electron-publish:  
@@ -2137,6 +2121,22 @@ jobs:
       <<: *env-send-slack-notifications
     <<: *steps-verify-ffmpeg
 
+  linux-x64-verify-mksnapshot:
+    <<: *machine-linux-medium
+    environment:
+      <<: *env-linux-medium
+      <<: *env-headless-testing
+      <<: *env-send-slack-notifications
+    <<: *steps-verify-mksnapshot
+
+  linux-x64-verify-chromedriver:
+    <<: *machine-linux-medium
+    environment:
+      <<: *env-linux-medium
+      <<: *env-headless-testing
+      <<: *env-send-slack-notifications
+    <<: *steps-verify-chromedriver
+
   linux-ia32-testing-tests:
     <<: *machine-linux-medium
     environment:
@@ -2183,6 +2183,23 @@ jobs:
       <<: *env-send-slack-notifications
     <<: *steps-verify-ffmpeg
 
+  linux-ia32-verify-mksnapshot:
+    <<: *machine-linux-medium
+    environment:
+      <<: *env-linux-medium
+      <<: *env-ia32
+      <<: *env-headless-testing
+      <<: *env-send-slack-notifications
+    <<: *steps-verify-mksnapshot
+
+  linux-ia32-verify-chromedriver:
+    <<: *machine-linux-medium
+    environment:
+      <<: *env-linux-medium
+      <<: *env-headless-testing
+      <<: *env-send-slack-notifications
+    <<: *steps-verify-chromedriver
+
   osx-testing-tests:
     <<: *machine-mac-large
     environment:
@@ -2206,6 +2223,20 @@ jobs:
       <<: *env-send-slack-notifications
     <<: *steps-verify-ffmpeg
 
+  osx-verify-mksnapshot:
+    <<: *machine-mac
+    environment:
+      <<: *env-machine-mac
+      <<: *env-send-slack-notifications
+    <<: *steps-verify-mksnapshot
+
+  osx-verify-chromedriver:
+    <<: *machine-mac
+    environment:
+      <<: *env-machine-mac
+      <<: *env-send-slack-notifications
+    <<: *steps-verify-chromedriver
+
   mas-testing-tests:
     <<: *machine-mac-large
     environment:
@@ -2229,6 +2260,20 @@ jobs:
       <<: *env-send-slack-notifications
     <<: *steps-verify-ffmpeg
 
+  mas-verify-mksnapshot:
+    <<: *machine-mac
+    environment:
+      <<: *env-machine-mac
+      <<: *env-send-slack-notifications
+    <<: *steps-verify-mksnapshot
+
+  mas-verify-chromedriver:
+    <<: *machine-mac
+    environment:
+      <<: *env-machine-mac
+      <<: *env-send-slack-notifications
+    <<: *steps-verify-chromedriver
+
   # Layer 4: Summary.
   linux-x64-release-summary:
     <<: *machine-linux-medium
@@ -2447,37 +2492,67 @@ workflows:
       - linux-x64-release-tests:
           requires:
             - linux-x64-release
+      - linux-x64-chromedriver:
+          requires:
+            - linux-checkout-fast
       - linux-x64-verify-ffmpeg:
           requires:
             - linux-x64-release
+      - linux-x64-verify-mksnapshot:
+          requires:
+            - linux-x64-release
+      - linux-x64-verify-chromedriver:
+          requires:
+            - linux-x64-release
+            - linux-x64-chromedriver
       - linux-x64-release-summary:
           requires:
             - linux-x64-release
             - linux-x64-release-tests
             - linux-x64-verify-ffmpeg
+            - linux-x64-chromedriver
 
       - linux-ia32-release
       - linux-ia32-release-tests:
           requires:
             - linux-ia32-release
+      - linux-ia32-chromedriver:
+          requires:
+            - linux-checkout-fast
       - linux-ia32-verify-ffmpeg:
           requires:
             - linux-ia32-release
+      - linux-ia32-verify-mksnapshot:
+          requires:
+            - linux-ia32-release
+      - linux-x64-verify-chromedriver:
+          requires:
+            - linux-ia32-release
+            - linux-ia32-chromedriver
       - linux-ia32-release-summary:
           requires:
             - linux-ia32-release
             - linux-ia32-release-tests
             - linux-ia32-verify-ffmpeg
+            - linux-ia32-chromedriver
 
       - linux-arm-release
+      - linux-arm-chromedriver:
+          requires:
+            - linux-checkout-fast
       - linux-arm-release-summary:
           requires:
             - linux-arm-release
+            - linux-arm-chromedriver
 
       - linux-arm64-release
+      - linux-arm64-chromedriver:
+          requires:
+            - linux-checkout-fast
       - linux-arm64-release-summary:
           requires:
             - linux-arm64-release
+            - linux-arm64-chromedriver
 
   nightly-mac-release-test:
     triggers:
@@ -2498,14 +2573,25 @@ workflows:
       - osx-release-tests:
           requires:
             - osx-release
+      - osx-chromedriver:
+          requires:
+            - mac-checkout-fast
       - osx-verify-ffmpeg:
           requires:
             - osx-release
+      - osx-verify-mksnapshot:
+          requires:
+            - osx-release
+      - osx-verify-chromedriver:
+          requires:
+            - osx-release
+            - osx-chromedriver
       - osx-release-summary:
           requires:
           - osx-release
           - osx-release-tests
           - osx-verify-ffmpeg
+          - osx-chromedriver
 
       - mas-release:
           requires:
@@ -2513,14 +2599,25 @@ workflows:
       - mas-release-tests:
           requires:
             - mas-release
+      - mas-chromedriver:
+          requires:
+            - mac-checkout-fast
       - mas-verify-ffmpeg:
           requires:
             - mas-release
+      - mas-verify-mksnapshot:
+          requires:
+            - mas-release
+      - mas-verify-chromedriver:
+          requires:
+            - mas-release
+            - mas-chromedriver
       - mas-release-summary:
           requires:
           - mas-release
           - mas-release-tests
           - mas-verify-ffmpeg
+          - mas-chromedriver
 
   # Various slow and non-essential checks we run only nightly.
   # Sanitizer jobs should be added here.

.eslintrc.json

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

.gitattributes

@@ -1,4 +1,3 @@
 # `git apply` and friends don't understand CRLF, even on windows. Force those
 # files to be checked out with LF endings even if core.autocrlf is true.
 *.patch text eol=lf
-patches/**/.patches merge=union

.github/CODEOWNERS

@@ -3,10 +3,20 @@
 # https://help.github.com/articles/about-codeowners
 # https://git-scm.com/docs/gitignore
 
+# Most stuff in here is owned by the Community & Safety WG...
+/.github/*                              @electron/wg-community
+
+# ...except the Admin WG maintains this file.
+/.github/CODEOWNERS                     @electron/wg-admin
+
 # Upgrades WG
 /patches/                               @electron/wg-upgrades
 DEPS                                    @electron/wg-upgrades
 
+# Docs & Tooling WG
+/default_app/ @electron/wg-docs-tools
+/docs/                                  @electron/wg-docs-tools
+
 # Releases WG
 /npm/                                   @electron/wg-releases
-/script/release                         @electron/wg-releases
+/script/release                         @electron/wg-releases

.github/PULL_REQUEST_TEMPLATE.md

@@ -18,4 +18,4 @@ Contributors guide: https://github.com/electron/electron/blob/master/CONTRIBUTIN
 
 #### Release Notes
 
-Notes: <!-- Please add a one-line description for app developers to read in the release notes, or 'none' if no notes relevant to app developers. Examples and help on special cases: https://github.com/electron/clerk/blob/master/README.md#examples -->
+Notes: <!-- Please add a one-line description for app developers to read in the release notes, or `no-notes` if no notes relevant to app developers. Examples and help on special cases: https://github.com/electron/clerk/blob/master/README.md#examples -->

.github/config.yml

@@ -33,7 +33,6 @@ authorizedUsers:
   - codebytere
   - deepak1556
   - jkleinsc
-  - loc
   - MarshallOfSound
   - miniak
   - nornagon

BUILD.gn

@@ -3,7 +3,6 @@ import("//build/config/ui.gni")
 import("//build/config/win/manifest.gni")
 import("//components/spellcheck/spellcheck_build_features.gni")
 import("//content/public/app/mac_helpers.gni")
-import("//extensions/buildflags/buildflags.gni")
 import("//pdf/features.gni")
 import("//ppapi/buildflags/buildflags.gni")
 import("//printing/buildflags/buildflags.gni")
@@ -59,17 +58,6 @@ if (is_mas_build) {
          "It doesn't make sense to build a MAS build on a non-mac platform")
 }
 
-if (enable_pdf_viewer) {
-  assert(enable_pdf, "PDF viewer support requires enable_pdf=true")
-  assert(enable_electron_extensions,
-         "PDF viewer support requires enable_electron_extensions=true")
-}
-
-if (enable_electron_extensions) {
-  assert(enable_extensions,
-         "Chrome extension support requires enable_extensions=true")
-}
-
 config("branding") {
   defines = [
     "ELECTRON_PRODUCT_NAME=\"$electron_product_name\"",
@@ -139,6 +127,15 @@ webpack_build("electron_isolated_renderer_bundle") {
   out_file = "$target_gen_dir/js2c/isolated_bundle.js"
 }
 
+webpack_build("electron_content_script_bundle") {
+  deps = [ ":build_electron_definitions" ]
+
+  inputs = auto_filenames.content_script_bundle_deps
+
+  config_file = "//electron/build/webpack/webpack.config.content_script.js"
+  out_file = "$target_gen_dir/js2c/content_script_bundle.js"
+}
+
 copy("electron_js2c_copy") {
   sources = [
     "lib/common/asar.js",
@@ -150,6 +147,7 @@ copy("electron_js2c_copy") {
 action("electron_js2c") {
   deps = [
     ":electron_browser_bundle",
+    ":electron_content_script_bundle",
     ":electron_isolated_renderer_bundle",
     ":electron_js2c_copy",
     ":electron_renderer_bundle",
@@ -159,6 +157,7 @@ action("electron_js2c") {
 
   webpack_sources = [
     "$target_gen_dir/js2c/browser_init.js",
+    "$target_gen_dir/js2c/content_script_bundle.js",
     "$target_gen_dir/js2c/isolated_bundle.js",
     "$target_gen_dir/js2c/renderer_init.js",
     "$target_gen_dir/js2c/sandbox_bundle.js",
@@ -225,6 +224,7 @@ grit("resources") {
   ]
 
   # Mojo manifest overlays are generated.
+  source_is_generated = true
   grit_flags = [
     "-E",
     "target_gen_dir=" + rebase_path(target_gen_dir, root_build_dir),
@@ -322,7 +322,6 @@ source_set("electron_lib") {
     "shell/common/api:mojo",
     "//base:base_static",
     "//base/allocator:buildflags",
-    "//chrome/app:command_ids",
     "//chrome/app/resources:platform_locale_settings",
     "//chrome/services/printing/public/mojom",
     "//components/certificate_transparency",
@@ -332,10 +331,7 @@ source_set("electron_lib") {
     "//components/network_hints/common:mojo_bindings",
     "//components/network_hints/renderer",
     "//components/network_session_configurator/common",
-    "//components/pref_registry",
     "//components/prefs",
-    "//components/upload_list",
-    "//components/user_prefs",
     "//components/viz/host",
     "//components/viz/service",
     "//content/public/browser",
@@ -364,7 +360,6 @@ source_set("electron_lib") {
     "//third_party/blink/public:blink",
     "//third_party/boringssl",
     "//third_party/electron_node:node_lib",
-    "//third_party/inspector_protocol:crdtp",
     "//third_party/leveldatabase",
     "//third_party/libyuv",
     "//third_party/webrtc_overrides:webrtc_component",
@@ -382,7 +377,7 @@ source_set("electron_lib") {
   public_deps = [
     "//base",
     "//base:i18n",
-    "//content/public/app",
+    "//content/public/app:both",
   ]
 
   include_dirs = [
@@ -432,9 +427,6 @@ source_set("electron_lib") {
       "*\bviews/*",
     ]
   }
-  if (!is_mas_build) {
-    deps += [ "//components/crash/core/app" ]
-  }
 
   set_sources_assignment_filter(
       sources_assignment_filter + extra_source_filters)
@@ -452,10 +444,6 @@ source_set("electron_lib") {
     ]
   }
 
-  if (is_linux) {
-    deps += [ "//components/crash/content/browser" ]
-  }
-
   if (is_mac) {
     deps += [
       "//components/remote_cocoa/app_shim",
@@ -463,10 +451,6 @@ source_set("electron_lib") {
       "//ui/accelerated_widget_mac",
     ]
 
-    if (!is_mas_build) {
-      deps += [ "//third_party/crashpad/crashpad/client" ]
-    }
-
     libs = [
       "AVFoundation.framework",
       "Carbon.framework",
@@ -485,14 +469,12 @@ source_set("electron_lib") {
     ]
     if (is_mas_build) {
       sources += [ "shell/browser/api/electron_api_app_mas.mm" ]
-      sources -= [ "shell/browser/auto_updater_mac.mm" ]
-      defines += [ "MAS_BUILD" ]
       sources -= [
-        "shell/app/electron_crash_reporter_client.cc",
-        "shell/app/electron_crash_reporter_client.h",
-        "shell/common/crash_keys.cc",
-        "shell/common/crash_keys.h",
+        "shell/browser/auto_updater_mac.mm",
+        "shell/common/crash_reporter/crash_reporter_mac.h",
+        "shell/common/crash_reporter/crash_reporter_mac.mm",
       ]
+      defines += [ "MAS_BUILD" ]
     } else {
       libs += [
         "Squirrel.framework",
@@ -512,21 +494,17 @@ source_set("electron_lib") {
     deps += [
       ":libnotify_loader",
       "//build/config/linux/gtk",
+      "//chrome/browser/ui/gtk",
       "//dbus",
       "//device/bluetooth",
+      "//third_party/breakpad:client",
       "//ui/events/devices/x11",
       "//ui/events/platform/x11",
-      "//ui/gtk",
       "//ui/views/controls/webview",
       "//ui/wm",
     ]
-    if (use_x11) {
-      deps += [
-        "//ui/gfx/x",
-        "//ui/gtk/x",
-      ]
-    }
     configs += [ ":gio_unix" ]
+    include_dirs += [ "//third_party/breakpad" ]
     configs += [ "//build/config/linux:x11" ]
     defines += [
       # Disable warnings for g_settings_list_schemas.
@@ -535,16 +513,6 @@ source_set("electron_lib") {
 
     sources += filenames.lib_sources_nss
     sources += [
-      "shell/browser/ui/gtk/app_indicator_icon.cc",
-      "shell/browser/ui/gtk/app_indicator_icon.h",
-      "shell/browser/ui/gtk/app_indicator_icon_menu.cc",
-      "shell/browser/ui/gtk/app_indicator_icon_menu.h",
-      "shell/browser/ui/gtk/gtk_status_icon.cc",
-      "shell/browser/ui/gtk/gtk_status_icon.h",
-      "shell/browser/ui/gtk/menu_util.cc",
-      "shell/browser/ui/gtk/menu_util.h",
-      "shell/browser/ui/gtk/status_icon.cc",
-      "shell/browser/ui/gtk/status_icon.h",
       "shell/browser/ui/gtk_util.cc",
       "shell/browser/ui/gtk_util.h",
     ]
@@ -552,7 +520,6 @@ source_set("electron_lib") {
   if (is_win) {
     libs += [ "dwmapi.lib" ]
     deps += [
-      "//components/crash/core/app:crash_export_thunks",
       "//ui/native_theme:native_theme_browser",
       "//ui/views/controls/webview",
       "//ui/wm",
@@ -564,6 +531,14 @@ source_set("electron_lib") {
     ]
   }
 
+  if ((is_mac && !is_mas_build) || is_win) {
+    sources += [
+      "shell/common/crash_reporter/crash_reporter_crashpad.cc",
+      "shell/common/crash_reporter/crash_reporter_crashpad.h",
+    ]
+    deps += [ "//third_party/crashpad/crashpad/client" ]
+  }
+
   if (enable_plugins) {
     deps += [ "chromium_src:plugins" ]
     sources += [
@@ -603,6 +578,8 @@ source_set("electron_lib") {
 
   if (enable_remote_module) {
     sources += [
+      "shell/common/api/remote/object_life_monitor.cc",
+      "shell/common/api/remote/object_life_monitor.h",
       "shell/common/api/remote/remote_callback_freer.cc",
       "shell/common/api/remote/remote_callback_freer.h",
       "shell/common/api/remote/remote_object_freer.cc",
@@ -623,10 +600,22 @@ source_set("electron_lib") {
     ]
   }
 
-  if (enable_views_api) {
+  if (enable_view_api) {
     sources += [
-      "shell/browser/api/views/electron_api_image_view.cc",
-      "shell/browser/api/views/electron_api_image_view.h",
+      "shell/browser/api/views/electron_api_box_layout.cc",
+      "shell/browser/api/views/electron_api_box_layout.h",
+      "shell/browser/api/views/electron_api_button.cc",
+      "shell/browser/api/views/electron_api_button.h",
+      "shell/browser/api/views/electron_api_label_button.cc",
+      "shell/browser/api/views/electron_api_label_button.h",
+      "shell/browser/api/views/electron_api_layout_manager.cc",
+      "shell/browser/api/views/electron_api_layout_manager.h",
+      "shell/browser/api/views/electron_api_md_text_button.cc",
+      "shell/browser/api/views/electron_api_md_text_button.h",
+      "shell/browser/api/views/electron_api_resize_area.cc",
+      "shell/browser/api/views/electron_api_resize_area.h",
+      "shell/browser/api/views/electron_api_text_field.cc",
+      "shell/browser/api/views/electron_api_text_field.h",
     ]
   }
 
@@ -640,6 +629,15 @@ source_set("electron_lib") {
     deps += [ "//components/printing/common:mojo_interfaces" ]
   }
 
+  deps += [
+    "//components/pref_registry",
+    "//components/user_prefs",
+    "//extensions/browser",
+    "//extensions/browser:core_api_provider",
+    "//extensions/common",
+    "//extensions/common:core_api_provider",
+    "//extensions/renderer",
+  ]
   if (enable_electron_extensions) {
     sources += filenames.lib_sources_extensions
     deps += [
@@ -648,11 +646,6 @@ source_set("electron_lib") {
       "shell/common/extensions/api:extensions_features",
       "//chrome/browser/resources:component_extension_resources",
       "//components/zoom",
-      "//extensions/browser",
-      "//extensions/browser:core_api_provider",
-      "//extensions/common",
-      "//extensions/common:core_api_provider",
-      "//extensions/renderer",
     ]
   }
 
@@ -733,6 +726,7 @@ if (is_mac) {
       sources = [
         "$root_out_dir/egl_intermediates/libEGL.dylib",
         "$root_out_dir/egl_intermediates/libGLESv2.dylib",
+        "$root_out_dir/egl_intermediates/libvulkan.dylib",
       ]
       outputs = [ "{{bundle_contents_dir}}/Libraries/{{source_file_part}}" ]
       public_deps = [ "//ui/gl:angle_library_copy" ]
@@ -766,17 +760,11 @@ if (is_mac) {
   }
 
   bundle_data("electron_crashpad_helper") {
-    sources = [ "$root_out_dir/chrome_crashpad_handler" ]
+    sources = [ "$root_out_dir/crashpad_handler" ]
 
-    outputs = [ "{{bundle_contents_dir}}/Helpers/{{source_file_part}}" ]
+    outputs = [ "{{bundle_resources_dir}}/{{source_file_part}}" ]
 
-    public_deps = [ "//components/crash/core/app:chrome_crashpad_handler" ]
-
-    if (is_asan) {
-      # crashpad_handler requires the ASan runtime at its @executable_path.
-      sources += [ "$root_out_dir/libclang_rt.asan_osx_dynamic.dylib" ]
-      public_deps += [ "//build/config/sanitizers:copy_asan_runtime" ]
-    }
+    public_deps = [ "//third_party/crashpad/crashpad/handler:crashpad_handler" ]
   }
 
   mac_framework_bundle("electron_framework") {
@@ -786,9 +774,6 @@ if (is_mac) {
       "Resources",
       "Libraries",
     ]
-    if (!is_mas_build) {
-      framework_contents += [ "Helpers" ]
-    }
     public_deps = [
       ":electron_framework_libraries",
       ":electron_lib",
@@ -1011,24 +996,21 @@ if (is_mac) {
     }
 
     extract_symbols("crashpad_handler_syms") {
-      binary = "$root_out_dir/chrome_crashpad_handler"
+      binary = "$root_out_dir/crashpad_handler"
       symbol_dir = "$root_out_dir/breakpad_symbols"
-      dsym_file = "$root_out_dir/chrome_crashpad_handler.dSYM/Contents/Resources/DWARF/chrome_crashpad_handler"
-      deps = [ "//components/crash/core/app:chrome_crashpad_handler" ]
+      dsym_file = "$root_out_dir/crashpad_handler.dSYM/Contents/Resources/DWARF/crashpad_handler"
+      deps = [ "//third_party/crashpad/crashpad/handler:crashpad_handler" ]
     }
 
     group("electron_symbols") {
       deps = [
+        ":crashpad_handler_syms",
         ":electron_app_syms",
         ":electron_framework_syms",
         ":swiftshader_egl_syms",
         ":swiftshader_gles_syms",
       ]
 
-      if (!is_mas_build) {
-        deps += [ ":crashpad_handler_syms" ]
-      }
-
       foreach(helper_params, content_mac_helpers) {
         _helper_target = helper_params[0]
         deps += [ ":electron_helper_syms_${_helper_target}" ]
@@ -1058,7 +1040,6 @@ if (is_mac) {
       ":electron_app_manifest",
       ":electron_lib",
       ":packed_resources",
-      "//components/crash/core/app",
       "//content:sandbox_helper_win",
       "//electron/buildflags",
       "//ui/strings",
@@ -1084,15 +1065,10 @@ if (is_mac) {
     if (is_win) {
       sources += [
         # TODO: we should be generating our .rc files more like how chrome does
-        "shell/browser/resources/win/electron.rc",
+        "shell/browser/resources/win/atom.rc",
         "shell/browser/resources/win/resource.h",
       ]
 
-      deps += [
-        "//components/browser_watcher:browser_watcher_client",
-        "//components/crash/core/app:run_as_crashpad_handler",
-      ]
-
       libs = [
         "comctl32.lib",
         "uiautomationcore.lib",
@@ -1116,7 +1092,7 @@ if (is_mac) {
       # See https://github.com/nodejs/node-gyp/commit/52ceec3a6d15de3a8f385f43dbe5ecf5456ad07a
       ldflags += [ "/DEF:" + rebase_path("build/electron.def", root_build_dir) ]
       inputs = [
-        "shell/browser/resources/win/electron.ico",
+        "shell/browser/resources/win/atom.ico",
         "build/electron.def",
       ]
     }
@@ -1296,7 +1272,7 @@ dist_zip("electron_chromedriver_zip") {
 
 mksnapshot_deps = [
   ":licenses",
-  "//tools/v8_context_snapshot:v8_context_snapshot_generator($v8_snapshot_toolchain)",
+  "//tools/v8_context_snapshot:v8_context_snapshot_generator",
   "//v8:mksnapshot($v8_snapshot_toolchain)",
 ]
 

CODE_OF_CONDUCT.md

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

DEPS

@@ -5,20 +5,18 @@ gclient_gn_args = [
   'checkout_android_native_support',
   'checkout_libaom',
   'checkout_nacl',
-  'checkout_pgo_profiles',
   'checkout_oculus_sdk',
   'checkout_openxr',
-  'checkout_google_benchmark',
-  'mac_xcode_version',
+  'checkout_google_benchmark'
 ]
 
 vars = {
   'chromium_version':
-    '85.0.4183.39',
+    '82.0.4085.14',
   'node_version':
-    'v12.16.3',
+    'v12.14.1',
   'nan_version':
-    '2c4ee8a32a299eada3cd6e468bbd0a473bfea96d',
+    '2ee313aaca52e2b478965ac50eb5082520380d1b',
 
   'boto_version': 'f7574aa6cc2c819430c1f05e9a1a1a666ef8169b',
   'pyyaml_version': '3.12',
@@ -44,7 +42,6 @@ vars = {
   'checkout_chromium': True,
   'checkout_node': True,
   'checkout_nan': True,
-  'checkout_pgo_profiles': True,
 
   # It's only needed to parse the native tests configurations.
   'checkout_pyyaml': False,
@@ -52,8 +49,6 @@ vars = {
   # Python "requests" module is used for releases only.
   'checkout_requests': False,
 
-  'mac_xcode_version': 'default',
-
   # To allow running hooks without parsing the DEPS tree
   'process_deps': True,
 

ELECTRON_VERSION

@@ -1 +1 @@
-10.0.0-beta.20
+9.0.0-beta.13

appveyor.yml

@@ -28,8 +28,8 @@
 #  - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
 
 version: 1.0.{build}
-build_cloud: electron-16-core
-image: vs2019bt-16.6.2
+build_cloud: libcc-20
+image: vs2019bt-16.4.0
 environment:
   GIT_CACHE_PATH: C:\Users\electron\libcc_cache
   ELECTRON_OUT_DIR: Default
@@ -116,12 +116,6 @@ build_script:
         if ($(7z a $zipfile src -xr!android_webview -xr!electron -xr'!*\.git' -xr!third_party\WebKit\LayoutTests! -xr!third_party\blink\web_tests -xr!third_party\blink\perf_tests -slp -t7z -mmt=30;$LASTEXITCODE -ne 0)) {
           Write-warning "Could not save source to shared drive; continuing anyway"
         }
-        # build time generation of file gen/angle/commit.h depends on
-        # third_party/angle/.git/HEAD.
-        # https://chromium-review.googlesource.com/c/angle/angle/+/2074924
-        if ($(7z a $zipfile src\third_party\angle\.git\HEAD;$LASTEXITCODE -ne 0)) {
-          Write-warning "Failed to add third_party\angle\.git\HEAD; continuing anyway"
-        }
       }
   - ps: >-
       if ($env:GN_CONFIG -ne 'release') {
@@ -152,11 +146,7 @@ build_script:
   - ninja -C out/ffmpeg electron:electron_ffmpeg_zip
   - ninja -C out/Default electron:electron_dist_zip
   - ninja -C out/Default shell_browser_ui_unittests
-  - gn desc out/Default v8:run_mksnapshot_default args > out/Default/mksnapshot_args
   - ninja -C out/Default electron:electron_mksnapshot_zip
-  - cd out\Default
-  - 7z a mksnapshot.zip mksnapshot_args gen\v8\embedded.S
-  - cd ..\..
   - ninja -C out/Default electron:hunspell_dictionaries_zip
   - ninja -C out/Default electron:electron_chromedriver_zip
   - ninja -C out/Default third_party/electron_node:headers
@@ -204,10 +194,11 @@ test_script:
         echo "Skipping tests for $env:GN_CONFIG build"
       }
   - cd electron
-  - if "%RUN_TESTS%"=="true" ( echo Running test suite & node script/yarn test -- --trace-uncaught --enable-logging)
+  - if "%RUN_TESTS%"=="true" ( echo Running test suite & node script/yarn test -- --enable-logging)
   - cd ..
   - if "%RUN_TESTS%"=="true" ( echo Verifying non proprietary ffmpeg & python electron\script\verify-ffmpeg.py --build-dir out\Default --source-root %cd% --ffmpeg-path out\ffmpeg )
-  - echo "About to verify mksnapshot"
+  - echo "About to verify mksnapshot"  
+  - if "%RUN_TESTS%"=="true" ( gn desc out\Default v8:run_mksnapshot_default args > out\Default\mksnapshot_args )
   - if "%RUN_TESTS%"=="true" ( echo Verifying mksnapshot & python electron\script\verify-mksnapshot.py --build-dir out\Default --source-root %cd% )
   - echo "Done verifying mksnapshot"
   - if "%RUN_TESTS%"=="true" ( echo Verifying chromedriver & python electron\script\verify-chromedriver.py --build-dir out\Default --source-root %cd% )

azure-pipelines-woa.yml

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

build/args/all.gn

@@ -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 = 82
+node_module_version = 80
 
 v8_promise_internal_field_count = 1
 v8_typed_array_max_size_in_heap = 0
@@ -20,3 +20,7 @@ angle_enable_vulkan_validation_layers = false
 dawn_enable_vulkan_validation_layers = false
 
 is_cfi = false
+
+enable_osr = true
+
+enable_electron_extensions = true

build/args/goma.gn

@@ -0,0 +1,2 @@
+goma_dir = rebase_path("//electron/external_binaries/goma")
+use_goma = true

build/webpack/run-compiler.js

@@ -1,4 +1,3 @@
-const fs = require('fs');
 const path = require('path')
 const webpack = require('webpack')
 
@@ -10,9 +9,6 @@ config.output = {
   filename: path.basename(outPath)
 }
 
-const { wrapInitWithProfilingTimeout } = config;
-delete config.wrapInitWithProfilingTimeout;
-
 webpack(config, (err, stats) => {
   if (err) {
     console.error(err)
@@ -21,18 +17,6 @@ webpack(config, (err, stats) => {
     console.error(stats.toString('normal'))
     process.exit(1)
   } else {
-    if (wrapInitWithProfilingTimeout) {
-      const contents = fs.readFileSync(outPath, 'utf8');
-      const newContents = `function ___electron_webpack_init__() {
-${contents}
-};
-if ((globalThis.process || binding.process).argv.includes("--profile-electron-init")) {
-  setTimeout(___electron_webpack_init__, 0);
-} else {
-  ___electron_webpack_init__();
-}`;
-      fs.writeFileSync(outPath, newContents);
-    }
     process.exit(0)
   }
 })

build/webpack/webpack.config.base.js

@@ -1,7 +1,6 @@
 const fs = require('fs')
 const path = require('path')
 const webpack = require('webpack')
-const TerserPlugin = require('terser-webpack-plugin');
 
 const electronRoot = path.resolve(__dirname, '../..')
 
@@ -21,55 +20,11 @@ class AccessDependenciesPlugin {
   }
 }
 
-const defines = {
-  BUILDFLAG: onlyPrintingGraph ? '(a => a)' : ''
-}
-
-const buildFlagsPrefix = '--buildflags='
-const buildFlagArg = process.argv.find(arg => arg.startsWith(buildFlagsPrefix));
-
-if (buildFlagArg) {
-  const buildFlagPath = buildFlagArg.substr(buildFlagsPrefix.length)
-
-  const flagFile = fs.readFileSync(buildFlagPath, 'utf8')
-  for (const line of flagFile.split(/(\r\n|\r|\n)/g)) {
-    const flagMatch = line.match(/#define BUILDFLAG_INTERNAL_(.+?)\(\) \(([01])\)/)
-    if (flagMatch) {
-      const [, flagName, flagValue] = flagMatch;
-      defines[flagName] = JSON.stringify(Boolean(parseInt(flagValue, 10)));
-    }
-  }
-}
-
-const ignoredModules = []
-
-if (defines['ENABLE_DESKTOP_CAPTURER'] === 'false') {
-  ignoredModules.push(
-    '@electron/internal/browser/desktop-capturer',
-    '@electron/internal/browser/api/desktop-capturer',
-    '@electron/internal/renderer/api/desktop-capturer'
-  )
-}
-
-if (defines['ENABLE_REMOTE_MODULE'] === 'false') {
-  ignoredModules.push(
-    '@electron/internal/browser/remote/server',
-    '@electron/internal/renderer/api/remote'
-  )
-}
-
-if (defines['ENABLE_VIEWS_API'] === 'false') {
-  ignoredModules.push(
-    '@electron/internal/browser/api/views/image-view.js'
-  )
-}
-
 module.exports = ({
   alwaysHasNode,
   loadElectronFromAlternateTarget,
   targetDeletesNodeGlobals,
-  target,
-  wrapInitWithProfilingTimeout
+  target
 }) => {
   let entry = path.resolve(electronRoot, 'lib', target, 'init.ts')
   if (!fs.existsSync(entry)) {
@@ -78,36 +33,29 @@ module.exports = ({
 
   return ({
     mode: 'development',
-    devtool: false,
+    devtool: 'inline-source-map',
     entry,
     target: alwaysHasNode ? 'node' : 'web',
     output: {
       filename: `${target}.bundle.js`
     },
-    wrapInitWithProfilingTimeout,
     resolve: {
       alias: {
         '@electron/internal': path.resolve(electronRoot, 'lib'),
         'electron': path.resolve(electronRoot, 'lib', loadElectronFromAlternateTarget || target, 'api', 'exports', 'electron.ts'),
-        // Force timers to resolve to our dependency that doesn't use window.postMessage
+        // Force timers to resolve to our dependency that doens't use window.postMessage
         'timers': path.resolve(electronRoot, 'node_modules', 'timers-browserify', 'main.js')
       },
       extensions: ['.ts', '.js']
     },
     module: {
       rules: [{
-        test: (moduleName) => !onlyPrintingGraph && ignoredModules.includes(moduleName),
-        loader: 'null-loader',
-      }, {
         test: /\.ts$/,
         loader: 'ts-loader',
         options: {
           configFile: path.resolve(electronRoot, 'tsconfig.electron.json'),
           transpileOnly: onlyPrintingGraph,
-          ignoreDiagnostics: [
-            // File '{0}' is not under 'rootDir' '{1}'.
-            6059,
-          ]
+          ignoreDiagnostics: [6059]
         }
       }]
     },
@@ -118,17 +66,6 @@ module.exports = ({
       // one of our renderer bundles should import it from the 'timers' package
       setImmediate: false,
     },
-    optimization: {
-      minimize: true,
-      minimizer: [
-        new TerserPlugin({
-          terserOptions: {
-            keep_classnames: true,
-            keep_fnames: true,
-          },
-        }),
-      ],
-    },
     plugins: [
       new AccessDependenciesPlugin(),
       ...(targetDeletesNodeGlobals ? [
@@ -141,7 +78,6 @@ module.exports = ({
       new webpack.ProvidePlugin({
         Promise: ['@electron/internal/common/webpack-globals-provider', 'Promise'],
       }),
-      new webpack.DefinePlugin(defines),
     ]
   })
 }

build/webpack/webpack.config.content_script.js

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

build/webpack/webpack.config.renderer.js

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

build/webpack/webpack.config.sandboxed_renderer.js

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

build/webpack/webpack.gni

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

build/zip.py

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

buildflags/BUILD.gn

@@ -13,7 +13,7 @@ buildflag_header("buildflags") {
     "ENABLE_RUN_AS_NODE=$enable_run_as_node",
     "ENABLE_OSR=$enable_osr",
     "ENABLE_REMOTE_MODULE=$enable_remote_module",
-    "ENABLE_VIEWS_API=$enable_views_api",
+    "ENABLE_VIEW_API=$enable_view_api",
     "ENABLE_PEPPER_FLASH=$enable_pepper_flash",
     "ENABLE_PDF_VIEWER=$enable_pdf_viewer",
     "ENABLE_TTS=$enable_tts",

buildflags/buildflags.gni

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

chromium_src/BUILD.gn

@@ -14,8 +14,6 @@ static_library("chrome") {
   sources = [
     "//chrome/browser/browser_process.cc",
     "//chrome/browser/browser_process.h",
-    "//chrome/browser/crash_upload_list/crash_upload_list_crashpad.cc",
-    "//chrome/browser/crash_upload_list/crash_upload_list_crashpad.h",
     "//chrome/browser/devtools/devtools_contents_resizing_strategy.cc",
     "//chrome/browser/devtools/devtools_contents_resizing_strategy.h",
     "//chrome/browser/devtools/devtools_embedder_message_dispatcher.cc",
@@ -53,12 +51,10 @@ static_library("chrome") {
     "//chrome/browser/ssl/security_state_tab_helper.cc",
     "//chrome/browser/ssl/security_state_tab_helper.h",
     "//chrome/browser/ssl/tls_deprecation_config.cc",
-    "//chrome/browser/ui/views/autofill/autofill_popup_view_utils.cc",
-    "//chrome/browser/ui/views/autofill/autofill_popup_view_utils.h",
+    "//chrome/browser/ui/autofill/popup_view_common.cc",
+    "//chrome/browser/ui/autofill/popup_view_common.h",
     "//chrome/browser/win/chrome_process_finder.cc",
     "//chrome/browser/win/chrome_process_finder.h",
-    "//chrome/child/v8_crashpad_support_win.cc",
-    "//chrome/child/v8_crashpad_support_win.h",
     "//extensions/browser/app_window/size_constraints.cc",
     "//extensions/browser/app_window/size_constraints.h",
   ]
@@ -72,9 +68,7 @@ static_library("chrome") {
   ]
   deps = [
     "//chrome/browser:resource_prefetch_predictor_proto",
-    "//chrome/services/speech:buildflags",
     "//components/feature_engagement:buildflags",
-    "//components/optimization_guide/proto:optimization_guide_proto",
   ]
 
   if (is_linux) {
@@ -93,14 +87,6 @@ static_library("chrome") {
     ]
   }
 
-  if (is_win) {
-    sources += [
-      "//chrome/browser/win/icon_reader_service.cc",
-      "//chrome/browser/win/icon_reader_service.h",
-    ]
-    public_deps += [ "//chrome/services/util_win:lib" ]
-  }
-
   if (enable_desktop_capturer) {
     sources += [
       "//chrome/browser/media/webrtc/desktop_media_list.h",
@@ -123,15 +109,11 @@ static_library("chrome") {
     ]
 
     if (use_aura) {
-      sources += [ "//chrome/browser/platform_util_aura.cc" ]
-
-      if (!is_win) {
-        sources += [
-          "//chrome/browser/ui/views/color_chooser_aura.cc",
-          "//chrome/browser/ui/views/color_chooser_aura.h",
-        ]
-      }
-
+      sources += [
+        "//chrome/browser/platform_util_aura.cc",
+        "//chrome/browser/ui/views/color_chooser_aura.cc",
+        "//chrome/browser/ui/views/color_chooser_aura.h",
+      ]
       deps += [ "//components/feature_engagement" ]
     }
 
@@ -161,6 +143,13 @@ static_library("chrome") {
     }
   }
 
+  if (enable_tts) {
+    sources += [
+      "//chrome/browser/speech/tts_controller_delegate_impl.cc",
+      "//chrome/browser/speech/tts_controller_delegate_impl.h",
+    ]
+  }
+
   if (enable_widevine) {
     sources += [
       "//chrome/renderer/media/chrome_key_systems.cc",
@@ -245,6 +234,8 @@ static_library("chrome") {
     sources += [
       "//chrome/browser/extensions/chrome_url_request_util.cc",
       "//chrome/browser/extensions/chrome_url_request_util.h",
+      "//chrome/browser/pdf/pdf_extension_util.cc",
+      "//chrome/browser/pdf/pdf_extension_util.h",
       "//chrome/browser/plugins/plugin_response_interceptor_url_loader_throttle.cc",
       "//chrome/browser/plugins/plugin_response_interceptor_url_loader_throttle.h",
       "//chrome/renderer/extensions/extension_hooks_delegate.cc",
@@ -252,15 +243,6 @@ static_library("chrome") {
       "//chrome/renderer/extensions/tabs_hooks_delegate.cc",
       "//chrome/renderer/extensions/tabs_hooks_delegate.h",
     ]
-
-    if (enable_pdf_viewer) {
-      sources += [
-        "//chrome/browser/pdf/pdf_extension_util.cc",
-        "//chrome/browser/pdf/pdf_extension_util.h",
-        "//chrome/renderer/pepper/chrome_pdf_print_client.cc",
-        "//chrome/renderer/pepper/chrome_pdf_print_client.h",
-      ]
-    }
   }
 }
 
@@ -279,14 +261,12 @@ source_set("plugins") {
     "//chrome/browser/renderer_host/pepper/pepper_isolated_file_system_message_filter.h",
   ]
   deps += [
+    "//components/pdf/browser",
     "//media:media_buildflags",
     "//ppapi/buildflags",
     "//ppapi/proxy:ipc",
     "//services/device/public/mojom",
   ]
-  if (enable_pdf_viewer) {
-    deps += [ "//components/pdf/browser" ]
-  }
   if (enable_pepper_flash) {
     sources += [
       "//chrome/browser/renderer_host/pepper/pepper_flash_browser_host.cc",
@@ -332,11 +312,9 @@ source_set("plugins") {
       "//chrome/renderer/pepper/pepper_flash_font_file_host.cc",
       "//chrome/renderer/pepper/pepper_flash_font_file_host.h",
     ]
-    if (enable_pdf_viewer) {
-      deps += [ "//components/pdf/renderer" ]
-    }
   }
   deps += [
+    "//components/pdf/renderer",
     "//components/strings",
     "//media:media_buildflags",
     "//ppapi/host",

chromium_src/chrome/browser/certificate_manager_model.cc

@@ -69,12 +69,12 @@ net::NSSCertDatabase* GetNSSCertDatabaseForResourceContext(
 
 // static
 void CertificateManagerModel::Create(content::BrowserContext* browser_context,
-                                     CreationCallback callback) {
+                                     const CreationCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
-  base::PostTask(FROM_HERE, {BrowserThread::IO},
-                 base::BindOnce(&CertificateManagerModel::GetCertDBOnIOThread,
-                                browser_context->GetResourceContext(),
-                                std::move(callback)));
+  base::PostTask(
+      FROM_HERE, {BrowserThread::IO},
+      base::BindOnce(&CertificateManagerModel::GetCertDBOnIOThread,
+                     browser_context->GetResourceContext(), callback));
 }
 
 CertificateManagerModel::CertificateManagerModel(
@@ -129,17 +129,17 @@ bool CertificateManagerModel::Delete(CERTCertificate* cert) {
 void CertificateManagerModel::DidGetCertDBOnUIThread(
     net::NSSCertDatabase* cert_db,
     bool is_user_db_available,
-    CreationCallback callback) {
+    const CreationCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 
   std::unique_ptr<CertificateManagerModel> model(
       new CertificateManagerModel(cert_db, is_user_db_available));
-  std::move(callback).Run(std::move(model));
+  callback.Run(std::move(model));
 }
 
 // static
 void CertificateManagerModel::DidGetCertDBOnIOThread(
-    CreationCallback callback,
+    const CreationCallback& callback,
     net::NSSCertDatabase* cert_db) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 
@@ -147,24 +147,17 @@ void CertificateManagerModel::DidGetCertDBOnIOThread(
   base::PostTask(
       FROM_HERE, {BrowserThread::UI},
       base::BindOnce(&CertificateManagerModel::DidGetCertDBOnUIThread, cert_db,
-                     is_user_db_available, std::move(callback)));
+                     is_user_db_available, callback));
 }
 
 // static
 void CertificateManagerModel::GetCertDBOnIOThread(
     content::ResourceContext* context,
-    CreationCallback callback) {
+    const CreationCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
-
-  auto did_get_cert_db_callback = base::AdaptCallbackForRepeating(
-      base::BindOnce(&CertificateManagerModel::DidGetCertDBOnIOThread,
-                     std::move(callback)));
-
-  net::NSSCertDatabase* cert_db =
-      GetNSSCertDatabaseForResourceContext(context, did_get_cert_db_callback);
-
-  // If the NSS database was already available, |cert_db| is non-null and
-  // |did_get_cert_db_callback| has not been called. Call it explicitly.
+  net::NSSCertDatabase* cert_db = GetNSSCertDatabaseForResourceContext(
+      context, base::BindOnce(&CertificateManagerModel::DidGetCertDBOnIOThread,
+                              callback));
   if (cert_db)
-    did_get_cert_db_callback.Run(cert_db);
+    DidGetCertDBOnIOThread(callback, cert_db);
 }

chromium_src/chrome/browser/certificate_manager_model.h

@@ -24,14 +24,14 @@ class ResourceContext;
 // manager dialog, and processes changes from the view.
 class CertificateManagerModel {
  public:
-  using CreationCallback =
-      base::OnceCallback<void(std::unique_ptr<CertificateManagerModel>)>;
+  typedef base::Callback<void(std::unique_ptr<CertificateManagerModel>)>
+      CreationCallback;
 
   // Creates a CertificateManagerModel. The model will be passed to the callback
   // when it is ready. The caller must ensure the model does not outlive the
   // |browser_context|.
   static void Create(content::BrowserContext* browser_context,
-                     CreationCallback callback);
+                     const CreationCallback& callback);
 
   ~CertificateManagerModel();
 
@@ -100,11 +100,11 @@ class CertificateManagerModel {
   // file for details.
   static void DidGetCertDBOnUIThread(net::NSSCertDatabase* cert_db,
                                      bool is_user_db_available,
-                                     CreationCallback callback);
-  static void DidGetCertDBOnIOThread(CreationCallback callback,
+                                     const CreationCallback& callback);
+  static void DidGetCertDBOnIOThread(const CreationCallback& callback,
                                      net::NSSCertDatabase* cert_db);
   static void GetCertDBOnIOThread(content::ResourceContext* context,
-                                  CreationCallback callback);
+                                  const CreationCallback& callback);
 
   net::NSSCertDatabase* cert_db_;
   // Whether the certificate database has a public slot associated with the

chromium_src/chrome/browser/process_singleton_posix.cc

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

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

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

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

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

default_app/default_app.ts

@@ -1,6 +1,5 @@
 import { app, dialog, BrowserWindow, shell, ipcMain } from 'electron';
 import * as path from 'path';
-import * as url from 'url';
 
 let mainWindow: BrowserWindow | null = null;
 
@@ -30,11 +29,12 @@ function isTrustedSender (webContents: Electron.WebContents) {
     return false;
   }
 
-  try {
-    return url.fileURLToPath(webContents.getURL()) === indexPath;
-  } catch {
-    return false;
-  }
+  const parsedUrl = new URL(webContents.getURL());
+  const urlPath = process.platform === 'win32'
+    // Strip the prefixed "/" that occurs on windows
+    ? path.resolve(parsedUrl.pathname.substr(1))
+    : parsedUrl.pathname;
+  return parsedUrl.protocol === 'file:' && urlPath === indexPath;
 }
 
 ipcMain.handle('bootstrap', (event) => {
@@ -45,10 +45,10 @@ async function createWindow () {
   await app.whenReady();
 
   const options: Electron.BrowserWindowConstructorOptions = {
-    width: 960,
-    height: 620,
+    width: 900,
+    height: 600,
     autoHideMenuBar: true,
-    backgroundColor: '#2f3241',
+    backgroundColor: '#FFFFFF',
     webPreferences: {
       preload: path.resolve(__dirname, 'preload.js'),
       contextIsolation: true,

default_app/styles.css

@@ -8,7 +8,7 @@ body {
 }
 
 .container {
-  margin: 15px 30px;
+  margin: 15px 30px 30px 30px;
   background-color: #2f3241;
   flex: 1;
   display: flex;

docs/README.md

@@ -18,6 +18,7 @@ an issue:
 
 ## Guides and Tutorials
 
+* [About Electron](tutorial/about.md)
 * [Setting up the Development Environment](tutorial/development-environment.md)
   * [Setting up macOS](tutorial/development-environment.md#setting-up-macos)
   * [Setting up Windows](tutorial/development-environment.md#setting-up-windows)
@@ -111,7 +112,6 @@ These individual tutorials expand on topics discussed in the guide above.
 * [Process Object](api/process.md)
 * [Supported Command Line Switches](api/command-line-switches.md)
 * [Environment Variables](api/environment-variables.md)
-* [Chrome Extensions Support](api/extensions.md)
 * [Breaking API Changes](breaking-changes.md)
 
 ### Custom DOM Elements:

docs/api/accelerator.md

@@ -54,7 +54,7 @@ The `Super` key is mapped to the `Windows` key on Windows and Linux and
 * `0` to `9`
 * `A` to `Z`
 * `F1` to `F24`
-* Punctuation like `~`, `!`, `@`, `#`, `$`, etc.
+* Punctuations like `~`, `!`, `@`, `#`, `$`, etc.
 * `Plus`
 * `Space`
 * `Tab`

docs/api/app.md

@@ -75,7 +75,7 @@ Returns:
 * `event` Event
 
 Emitted when all windows have been closed and the application will quit.
-Calling `event.preventDefault()` will prevent the default behavior, which is
+Calling `event.preventDefault()` will prevent the default behaviour, which is
 terminating the application.
 
 See the description of the `window-all-closed` event for the differences between
@@ -204,7 +204,7 @@ Returns:
   [`NSUserActivity.activityType`][activity-type].
 * `userInfo` unknown - Contains app-specific state stored by the activity.
 
-Emitted when [Handoff][handoff] is about to be resumed on another device. If you need to update the state to be transferred, you should call `event.preventDefault()` immediately, construct a new `userInfo` dictionary and call `app.updateCurrentActivity()` in a timely manner. Otherwise, the operation will fail and `continue-activity-error` will be called.
+Emitted when [Handoff][handoff] is about to be resumed on another device. If you need to update the state to be transferred, you should call `event.preventDefault()` immediately, construct a new `userInfo` dictionary and call `app.updateCurrentActiviy()` in a timely manner. Otherwise, the operation will fail and `continue-activity-error` will be called.
 
 ### Event: 'new-window-for-tab' _macOS_
 
@@ -359,7 +359,7 @@ Returns:
 
 Emitted when the GPU process crashes or is killed.
 
-### Event: 'renderer-process-crashed' _Deprecated_
+### Event: 'renderer-process-crashed'
 
 Returns:
 
@@ -369,30 +369,6 @@ Returns:
 
 Emitted when the renderer process of `webContents` crashes or is killed.
 
-**Deprecated:** This event is superceded by the `render-process-gone` event
-which contains more information about why the render process dissapeared. It
-isn't always because it crashed.  The `killed` boolean can be replaced by
-checking `reason === 'killed'` when you switch to that event.
-
-#### Event: 'render-process-gone'
-
-Returns:
-
-* `event` Event
-* `webContents` [WebContents](web-contents.md)
-* `details` Object
-  * `reason` String - The reason the render process is gone.  Possible values:
-    * `clean-exit` - Process exited with an exit code of zero
-    * `abnormal-exit` - Process exited with a non-zero exit code
-    * `killed` - Process was sent a SIGTERM or otherwise killed externally
-    * `crashed` - Process crashed
-    * `oom` - Process ran out of memory
-    * `launch-failure` - Process never successfully launched
-    * `integrity-failure` - Windows code integrity checks failed
-
-Emitted when the renderer process unexpectedly dissapears.  This is normally
-because it was crashed or killed.
-
 ### Event: 'accessibility-support-changed' _macOS_ _Windows_
 
 Returns:
@@ -438,8 +414,6 @@ and `workingDirectory` is its current working directory. Usually
 applications respond to this by making their primary window focused and
 non-minimized.
 
-**Note:** If the second instance is started by a different user than the first, the `argv` array will not include the arguments.
-
 This event is guaranteed to be emitted after the `ready` event of `app`
 gets emitted.
 
@@ -580,17 +554,11 @@ Returns `Promise<void>` - fulfilled when Electron is initialized.
 May be used as a convenient alternative to checking `app.isReady()`
 and subscribing to the `ready` event if the app is not ready yet.
 
-### `app.focus([options])`
-
-* `options` Object (optional)
-  * `steal` Boolean _macOS_ - Make the receiver the active app even if another app is
-  currently active.
+### `app.focus()`
 
 On Linux, focuses on the first visible window. On macOS, makes the application
 the active app. On Windows, focuses on the application's first window.
 
-You should seek to use the `steal` option as sparingly as possible.
-
 ### `app.hide()` _macOS_
 
 Hides all application windows without minimizing them.
@@ -632,10 +600,8 @@ Returns `String` - The current application directory.
   * `music` Directory for a user's music.
   * `pictures` Directory for a user's pictures.
   * `videos` Directory for a user's videos.
-  * `recent` Directory for the user's recent files (Windows only).
   * `logs` Directory for your app's log folder.
   * `pepperFlashSystemPlugin` Full path to the system version of the Pepper Flash plugin.
-  * `crashDumps` Directory where crash dumps are stored.
 
 Returns `String` - A path to a special directory or file associated with `name`. On
 failure, an `Error` is thrown.
@@ -1055,7 +1021,7 @@ This method can only be called before app is ready.
 
 By default, Chromium disables 3D APIs (e.g. WebGL) until restart on a per
 domain basis if the GPU processes crashes too frequently. This function
-disables that behavior.
+disables that behaviour.
 
 This method can only be called before app is ready.
 
@@ -1224,7 +1190,7 @@ Show the app's about panel options. These options can be overridden with `app.se
   * `website` String (optional) _Linux_ - The app's website.
   * `iconPath` String (optional) _Linux_ _Windows_ - Path to the app's icon. On Linux, will be shown as 64x64 pixels while retaining aspect ratio.
 
-Set the about panel options. This will override the values defined in the app's `.plist` file on macOS. See the [Apple docs][about-panel-options] for more details. On Linux, values must be set in order to be shown; there are no defaults.
+Set the about panel options. This will override the values defined in the app's `.plist` file on MacOS. See the [Apple docs][about-panel-options] for more details. On Linux, values must be set in order to be shown; there are no defaults.
 
 If you do not set `credits` but still wish to surface them in your app, AppKit will look for a file named "Credits.html", "Credits.rtf", and "Credits.rtfd", in that order, in the bundle returned by the NSBundle class method main. The first file found is used, and if none is found, the info area is left blank. See Apple [documentation](https://developer.apple.com/documentation/appkit/nsaboutpaneloptioncredits?language=objc) for more information.
 
@@ -1253,9 +1219,9 @@ stopAccessingSecurityScopedResource()
 
 Start accessing a security scoped resource. With this method Electron applications that are packaged for the Mac App Store may reach outside their sandbox to access files chosen by the user. See [Apple's documentation](https://developer.apple.com/library/content/documentation/Security/Conceptual/AppSandboxDesignGuide/AppSandboxInDepth/AppSandboxInDepth.html#//apple_ref/doc/uid/TP40011183-CH3-SW16) for a description of how this system works.
 
-### `app.enableSandbox()`
+### `app.enableSandbox()` _Experimental_
 
-Enables full sandbox mode on the app. This means that all renderers will be launched sandboxed, regardless of the value of the `sandbox` flag in WebPreferences.
+Enables full sandbox mode on the app.
 
 This method can only be called before app is ready.
 
@@ -1304,25 +1270,6 @@ app.moveToApplicationsFolder({
 
 Would mean that if an app already exists in the user directory, if the user chooses to 'Continue Move' then the function would continue with its default behavior and the existing app will be trashed and the active app moved into its place.
 
-### `app.isSecureKeyboardEntryEnabled()` _macOS_
-
-Returns `Boolean` - whether `Secure Keyboard Entry` is enabled.
-
-By default this API will return `false`.
-
-### `app.setSecureKeyboardEntryEnabled(enabled)` _macOS_
-
-* `enabled` Boolean - Enable or disable `Secure Keyboard Entry`
-
-Set the `Secure Keyboard Entry` is enabled in your application.
-
-By using this API, important information such as password and other sensitive information can be prevented from being intercepted by other processes.
-
-See [Apple's documentation](https://developer.apple.com/library/archive/technotes/tn2150/_index.html) for more
-details.
-
-**Note:** Enable `Secure Keyboard Entry` only when it is needed and disable it when it is no longer needed.
-
 ## Properties
 
 ### `app.accessibilitySupportEnabled` _macOS_ _Windows_
@@ -1349,9 +1296,6 @@ On macOS, setting this with any nonzero integer shows on the dock icon. On Linux
 **Note:** Unity launcher requires the existence of a `.desktop` file to work,
 for more information please read [Desktop Environment Integration][unity-requirement].
 
-**Note:** On macOS, you need to ensure that your application has the permission
-to display notifications for this property to take effect.
-
 ### `app.commandLine` _Readonly_
 
 A [`CommandLine`](./command-line.md) object that allows you to read and manipulate the
@@ -1403,7 +1347,7 @@ in your app's initialization to ensure that your overridden value is used.
 
 A `Boolean` which when `true` disables the overrides that Electron has in place
 to ensure renderer processes are restarted on every navigation.  The current
-default value for this property is `true`.
+default value for this property is `false`.
 
 The intention is for these overrides to become disabled by default and then at
 some point in the future this property will be removed.  This property impacts

docs/api/browser-window.md

@@ -177,7 +177,7 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
   * `simpleFullscreen` Boolean (optional) - Use pre-Lion fullscreen on macOS. Default is `false`.
   * `skipTaskbar` Boolean (optional) - Whether to show the window in taskbar. Default is
     `false`.
-  * `kiosk` Boolean (optional) - Whether the window is in kiosk mode. Default is `false`.
+  * `kiosk` Boolean (optional) - The kiosk mode. Default is `false`.
   * `title` String (optional) - Default window title. Default is `"Electron"`. If the HTML tag `<title>` is defined in the HTML file loaded by `loadURL()`, this property will be ignored.
   * `icon` ([NativeImage](native-image.md) | String) (optional) - The window icon. On Windows it is
     recommended to use `ICO` icons to get best visual effects, you can also
@@ -207,7 +207,7 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
   * `opacity` Number (optional) - Set the initial opacity of the window, between 0.0 (fully
     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 desktop environments. Default is [`nativeTheme.shouldUseDarkColors`](native-theme.md).
+    some GTK+3 desktop environments. Default is `false`.
   * `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
@@ -348,9 +348,6 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
       You can access this context in the dev tools by selecting the
       'Electron Isolated Context' entry in the combo box at the top of the
       Console tab.
-    * `worldSafeExecuteJavaScript` Boolean (optional) - If true, values returned from `webFrame.executeJavaScript` will be sanitized to ensure JS values
-      can't unsafely cross between worlds when using `contextIsolation`.  The default
-      is `false`. In Electron 12, the default will be changed to `true`. _Deprecated_
     * `nativeWindowOpen` Boolean (optional) - Whether to use native
       `window.open()`. Defaults to `false`. Child windows will always have node
       integration disabled unless `nodeIntegrationInSubFrames` is true. **Note:** This option is currently
@@ -388,15 +385,6 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
       visible to users.
     * `spellcheck` Boolean (optional) - Whether to enable the builtin spellchecker.
       Default is `true`.
-    * `enableWebSQL` Boolean (optional) - Whether to enable the [WebSQL api](https://www.w3.org/TR/webdatabase/).
-      Default is `true`.
-    * `v8CacheOptions` String (optional) - Enforces the v8 code caching policy
-      used by blink. Accepted values are
-      * `none` - Disables code caching
-      * `code` - Heuristic based code caching
-      * `bypassHeatCheck` - Bypass code caching heuristics but with lazy compilation
-      * `bypassHeatCheckAndEagerCompile` - Same as above except compilation is eager.
-      Default policy is `code`.
 
 When setting minimum or maximum window size with `minWidth`/`maxWidth`/
 `minHeight`/`maxHeight`, it only constrains the users. It won't prevent you from
@@ -635,12 +623,6 @@ Returns:
 
 Emitted on 3-finger swipe. Possible directions are `up`, `right`, `down`, `left`.
 
-The method underlying this event is built to handle older macOS-style trackpad swiping,
-where the content on the screen doesn't move with the swipe. Most macOS trackpads are not
-configured to allow this kind of swiping anymore, so in order for it to emit properly the
-'Swipe between pages' preference in `System Preferences > Trackpad > More Gestures` must be
-set to 'Swipe with two or three fingers'.
-
 #### Event: 'rotate-gesture' _macOS_
 
 Returns:
@@ -815,51 +797,6 @@ A `Boolean` property that determines whether the window menu bar should hide its
 If the menu bar is already visible, setting this property to `true` won't
 hide it immediately.
 
-#### `win.simpleFullScreen`
-
-A `Boolean` property that determines whether the window is in simple (pre-Lion) fullscreen mode.
-
-#### `win.fullScreen`
-
-A `Boolean` property that determines whether the window is in fullscreen mode.
-
-#### `win.visibleOnAllWorkspaces`
-
-A `Boolean` property that determines whether the window is visible on all workspaces.
-
-**Note:** Always returns false on Windows.
-
-#### `win.shadow`
-
-A `Boolean` property that determines whether the window has a shadow.
-
-#### `win.menuBarVisible` _Windows_ _Linux_
-
-A `Boolean` property that determines whether the menu bar should be visible.
-
-**Note:** If the menu bar is auto-hide, users can still bring up the menu bar by pressing the single `Alt` key.
-
-####  `win.kiosk`
-
-A `Boolean` property that determines whether the window is in kiosk mode.
-
-#### `win.documentEdited` _macOS_
-
-A `Boolean` property that specifies whether the window’s document has been edited.
-
-The icon in title bar will become gray when set to `true`.
-
-#### `win.representedFilename` _macOS_
-
-A `String` property that determines the pathname of the file the window represents,
-and the icon of the file will show in window's title bar.
-
-#### `win.title`
-
-A `String` property that determines the title of the native window.
-
-**Note:** The title of the web page can be different from the title of the native window.
-
 #### `win.minimizable`
 
 A `Boolean` property that determines whether the window can be manually minimized by user.
@@ -1015,7 +952,7 @@ Returns `Boolean` - Whether the window is in fullscreen mode.
 
 Enters or leaves simple fullscreen mode.
 
-Simple fullscreen mode emulates the native fullscreen behavior found in versions of macOS prior to Lion (10.7).
+Simple fullscreen mode emulates the native fullscreen behavior found in versions of Mac OS X prior to Lion (10.7).
 
 #### `win.isSimpleFullScreen()` _macOS_
 
@@ -1126,7 +1063,7 @@ Disable or enable the window.
 
 #### `win.isEnabled()`
 
-Returns `Boolean` - whether the window is enabled.
+Returns Boolean - whether the window is enabled.
 
 #### `win.setSize(width, height[, animate])`
 
@@ -1339,7 +1276,7 @@ Makes the window not show in the taskbar.
 
 * `flag` Boolean
 
-Enters or leaves kiosk mode.
+Enters or leaves the kiosk mode.
 
 #### `win.isKiosk()`
 
@@ -1790,7 +1727,7 @@ Set a custom position for the traffic light buttons. Can only be used with `titl
 Returns `Point` - The current position for the traffic light buttons. Can only be used with `titleBarStyle`
 set to `hidden`.
 
-#### `win.setTouchBar(touchBar)` _macOS_
+#### `win.setTouchBar(touchBar)` _macOS_ _Experimental_
 
 * `touchBar` TouchBar | null
 

docs/api/command-line-switches.md

@@ -16,70 +16,80 @@ app.whenReady().then(() => {
 })
 ```
 
-## Electron CLI Flags
+## --ignore-connections-limit=`domains`
 
-### --auth-server-whitelist=`url`
+Ignore the connections limit for `domains` list separated by `,`.
 
-A comma-separated list of servers for which integrated authentication is enabled.
-
-For example:
-
-```sh
---auth-server-whitelist='*example.com, *foobar.com, *baz'
-```
-
-then any `url` ending with `example.com`, `foobar.com`, `baz` will be considered
-for integrated authentication. Without `*` prefix the URL has to match exactly.
-
-### --auth-negotiate-delegate-whitelist=`url`
-
-A comma-separated list of servers for which delegation of user credentials is required.
-Without `*` prefix the URL has to match exactly.
-
-### --disable-ntlm-v2
-
-Disables NTLM v2 for posix platforms, no effect elsewhere.
-
-### --disable-http-cache
+## --disable-http-cache
 
 Disables the disk cache for HTTP requests.
 
-### --disable-http2
+## --disable-http2
 
 Disable HTTP/2 and SPDY/3.1 protocols.
 
-### --disable-renderer-backgrounding
+## --lang
 
-Prevents Chromium from lowering the priority of invisible pages' renderer
-processes.
+Set a custom locale.
 
-This flag is global to all renderer processes, if you only want to disable
-throttling in one window, you can take the hack of
-[playing silent audio][play-silent-audio].
+## --inspect=`port` and --inspect-brk=`port`
 
-### --disk-cache-size=`size`
+Debug-related flags, see the [Debugging the Main Process][debugging-main-process] guide for details.
+
+## --remote-debugging-port=`port`
+
+Enables remote debugging over HTTP on the specified `port`.
+
+## --disk-cache-size=`size`
 
 Forces the maximum disk space to be used by the disk cache, in bytes.
 
-### --enable-api-filtering-logging
+## --js-flags=`flags`
 
-Enables caller stack logging for the following APIs (filtering events):
-- `desktopCapturer.getSources()` / `desktop-capturer-get-sources`
-- `remote.require()` / `remote-require`
-- `remote.getGlobal()` / `remote-get-builtin`
-- `remote.getBuiltin()` / `remote-get-global`
-- `remote.getCurrentWindow()` / `remote-get-current-window`
-- `remote.getCurrentWebContents()` / `remote-get-current-web-contents`
+Specifies the flags passed to the Node.js engine. It has to be passed when starting
+Electron if you want to enable the `flags` in the main process.
 
-### --enable-logging
+```sh
+$ electron --js-flags="--harmony_proxies --harmony_collections" your-app
+```
 
-Prints Chromium's logging into console.
+See the [Node.js documentation][node-cli] or run `node --help` in your terminal for a list of available flags. Additionally, run `node --v8-options` to see a list of flags that specifically refer to Node.js's V8 JavaScript engine.
 
-This switch can not be used in `app.commandLine.appendSwitch` since it is parsed
-earlier than user's app is loaded, but you can set the `ELECTRON_ENABLE_LOGGING`
-environment variable to achieve the same effect.
+## --proxy-server=`address:port`
 
-### --host-rules=`rules`
+Use a specified proxy server, which overrides the system setting. This switch
+only affects requests with HTTP protocol, including HTTPS and WebSocket
+requests. It is also noteworthy that not all proxy servers support HTTPS and
+WebSocket requests. The proxy URL does not support username and password
+authentication [per Chromium issue](https://bugs.chromium.org/p/chromium/issues/detail?id=615947).
+
+## --proxy-bypass-list=`hosts`
+
+Instructs Electron to bypass the proxy server for the given semi-colon-separated
+list of hosts. This flag has an effect only if used in tandem with
+`--proxy-server`.
+
+For example:
+
+```javascript
+const { app } = require('electron')
+app.commandLine.appendSwitch('proxy-bypass-list', '<local>;*.google.com;*foo.com;1.2.3.4:5678')
+```
+
+Will use the proxy server for all hosts except for local addresses (`localhost`,
+`127.0.0.1` etc.), `google.com` subdomains, hosts that contain the suffix
+`foo.com` and anything at `1.2.3.4:5678`.
+
+## --proxy-pac-url=`url`
+
+Uses the PAC script at the specified `url`.
+
+## --no-proxy-server
+
+Don't use a proxy server and always make direct connections. Overrides any other
+proxy server flags that are passed.
+
+## --host-rules=`rules`
 
 A comma-separated list of `rules` that control how hostnames are mapped.
 
@@ -97,96 +107,69 @@ These mappings apply to the endpoint host in a net request (the TCP connect
 and host resolver in a direct connection, and the `CONNECT` in an HTTP proxy
 connection, and the endpoint host in a `SOCKS` proxy connection).
 
-### --host-resolver-rules=`rules`
+## --host-resolver-rules=`rules`
 
 Like `--host-rules` but these `rules` only apply to the host resolver.
 
-### --ignore-certificate-errors
+## --auth-server-whitelist=`url`
 
-Ignores certificate related errors.
-
-### --ignore-connections-limit=`domains`
-
-Ignore the connections limit for `domains` list separated by `,`.
-
-### --js-flags=`flags`
-
-Specifies the flags passed to the Node.js engine. It has to be passed when starting
-Electron if you want to enable the `flags` in the main process.
-
-```sh
-$ electron --js-flags="--harmony_proxies --harmony_collections" your-app
-```
-
-See the [Node.js documentation][node-cli] or run `node --help` in your terminal for a list of available flags. Additionally, run `node --v8-options` to see a list of flags that specifically refer to Node.js's V8 JavaScript engine.
-
-### --lang
-
-Set a custom locale.
-
-### --log-net-log=`path`
-
-Enables net log events to be saved and writes them to `path`.
-
-### --no-proxy-server
-
-Don't use a proxy server and always make direct connections. Overrides any other
-proxy server flags that are passed.
-
-### --no-sandbox
-
-Disables Chromium sandbox, which is now enabled by default.
-Should only be used for testing.
-
-### --proxy-bypass-list=`hosts`
-
-Instructs Electron to bypass the proxy server for the given semi-colon-separated
-list of hosts. This flag has an effect only if used in tandem with
-`--proxy-server`.
+A comma-separated list of servers for which integrated authentication is enabled.
 
 For example:
 
-```javascript
-const { app } = require('electron')
-app.commandLine.appendSwitch('proxy-bypass-list', '<local>;*.google.com;*foo.com;1.2.3.4:5678')
+```sh
+--auth-server-whitelist='*example.com, *foobar.com, *baz'
 ```
 
-Will use the proxy server for all hosts except for local addresses (`localhost`,
-`127.0.0.1` etc.), `google.com` subdomains, hosts that contain the suffix
-`foo.com` and anything at `1.2.3.4:5678`.
+then any `url` ending with `example.com`, `foobar.com`, `baz` will be considered
+for integrated authentication. Without `*` prefix the URL has to match exactly.
 
-### --proxy-pac-url=`url`
+## --auth-negotiate-delegate-whitelist=`url`
 
-Uses the PAC script at the specified `url`.
+A comma-separated list of servers for which delegation of user credentials is required.
+Without `*` prefix the URL has to match exactly.
 
-### --proxy-server=`address:port`
+## --ignore-certificate-errors
 
-Use a specified proxy server, which overrides the system setting. This switch
-only affects requests with HTTP protocol, including HTTPS and WebSocket
-requests. It is also noteworthy that not all proxy servers support HTTPS and
-WebSocket requests. The proxy URL does not support username and password
-authentication [per Chromium issue](https://bugs.chromium.org/p/chromium/issues/detail?id=615947).
+Ignores certificate related errors.
 
-### --remote-debugging-port=`port`
-
-Enables remote debugging over HTTP on the specified `port`.
-
-### --ppapi-flash-path=`path`
+## --ppapi-flash-path=`path`
 
 Sets the `path` of the pepper flash plugin.
 
-### --ppapi-flash-version=`version`
+## --ppapi-flash-version=`version`
 
 Sets the `version` of the pepper flash plugin.
 
-### --v=`log_level`
+## --log-net-log=`path`
+
+Enables net log events to be saved and writes them to `path`.
+
+## --disable-renderer-backgrounding
+
+Prevents Chromium from lowering the priority of invisible pages' renderer
+processes.
+
+This flag is global to all renderer processes, if you only want to disable
+throttling in one window, you can take the hack of
+[playing silent audio][play-silent-audio].
+
+## --enable-logging
+
+Prints Chromium's logging into console.
+
+This switch can not be used in `app.commandLine.appendSwitch` since it is parsed
+earlier than user's app is loaded, but you can set the `ELECTRON_ENABLE_LOGGING`
+environment variable to achieve the same effect.
+
+## --v=`log_level`
 
 Gives the default maximal active V-logging level; 0 is the default. Normally
 positive values are used for V-logging levels.
 
 This switch only works when `--enable-logging` is also passed.
 
-### --vmodule=`pattern`
+## --vmodule=`pattern`
 
 Gives the per-module maximal V-logging levels to override the value given by
 `--v`. E.g. `my_module=2,foo*=3` would change the logging level for all code in
@@ -198,38 +181,20 @@ logging level for all code in the source files under a `foo/bar` directory.
 
 This switch only works when `--enable-logging` is also passed.
 
-## Node.js Flags
+## --enable-api-filtering-logging
 
-Electron supports some of the [CLI flags][node-cli] supported by Node.js.
+Enables caller stack logging for the following APIs (filtering events):
+- `desktopCapturer.getSources()` / `desktop-capturer-get-sources`
+- `remote.require()` / `remote-require`
+- `remote.getGlobal()` / `remote-get-builtin`
+- `remote.getBuiltin()` / `remote-get-global`
+- `remote.getCurrentWindow()` / `remote-get-current-window`
+- `remote.getCurrentWebContents()` / `remote-get-current-web-contents`
 
-**Note:** Passing unsupported command line switches to Electron when it is not running in `ELECTRON_RUN_AS_NODE` will have no effect.
+## --no-sandbox
 
-### --inspect-brk[=[host:]port]
-
-Activate inspector on host:port and break at start of user script. Default host:port is 127.0.0.1:9229.
-
-Aliased to `--debug-brk=[host:]port`.
-
-### --inspect-port=[host:]port
-
-Set the `host:port` to be used when the inspector is activated. Useful when activating the inspector by sending the SIGUSR1 signal. Default host is `127.0.0.1`.
-
-Aliased to `--debug-port=[host:]port`.
-
-### --inspect[=[host:]port]
-
-Activate inspector on `host:port`. Default is `127.0.0.1:9229`.
-
-V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug and profile Electron instances. The tools attach to Electron instances via a TCP port and communicate using the [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
-
-See the [Debugging the Main Process][debugging-main-process] guide for more details.
-
-Aliased to `--debug[=[host:]port`.
-
-### --inspect-publish-uid=stderr,http
-Specify ways of the inspector web socket url exposure.
-
-By default inspector websocket url is available in stderr and under /json/list endpoint on http://host:port/json/list.
+Disables Chromium sandbox, which is now enabled by default.
+Should only be used for testing.
 
 [app]: app.md
 [append-switch]: app.md#appcommandlineappendswitchswitch-value

docs/api/cookies.md

@@ -96,7 +96,6 @@ 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 `no_restriction`.
 
 Returns `Promise<void>` - A promise which resolves when the cookie has been set
 

docs/api/crash-reporter.md

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

docs/api/debugger.md

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

docs/api/desktop-capturer.md

@@ -3,7 +3,7 @@
 > Access information about media sources that can be used to capture audio and
 > video from the desktop using the [`navigator.mediaDevices.getUserMedia`] API.
 
-Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
+Process: [Renderer](../glossary.md#renderer-process)
 
 The following example shows how to capture video from a desktop window whose
 title is `Electron`:

docs/api/dialog.md

@@ -269,7 +269,6 @@ Shows a message box, it will block the process until the message box is closed.
 It returns the index of the clicked button.
 
 The `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.
-If `browserWindow` is not shown dialog will not be attached to it. In such case It will be displayed as independed window.
 
 ### `dialog.showMessageBox([browserWindow, ]options)`
 

docs/api/environment-variables.md

@@ -80,18 +80,6 @@ and spawned child processes that set `ELECTRON_RUN_AS_NODE`.
 
 Starts the process as a normal Node.js process.
 
-In this mode, you will be able to pass [cli options](https://nodejs.org/api/cli.html) to Node.js as
-you would when running the normal Node.js executable, with the exception of the following flags:
-
-* "--openssl-config"
-* "--use-bundled-ca"
-* "--use-openssl-ca",
-* "--force-fips"
-* "--enable-fips"
-
-These flags are disabled owing to the fact that Electron uses BoringSSL instead of OpenSSL when building Node.js'
-`crypto` module, and so will not work as designed.
-
 ### `ELECTRON_NO_ATTACH_CONSOLE` _Windows_
 
 Don't attach to the current console session.
@@ -147,14 +135,3 @@ the one downloaded by `npm install`. Usage:
 ```sh
 export ELECTRON_OVERRIDE_DIST_PATH=/Users/username/projects/electron/out/Testing
 ```
-
-## Set By Electron
-
-Electron sets some variables in your environment at runtime.
-
-### `ORIGINAL_XDG_CURRENT_DESKTOP`
-
-This variable is set to the value of `XDG_CURRENT_DESKTOP` that your application
-originally launched with.  Electron sometimes modifies the value of `XDG_CURRENT_DESKTOP`
-to affect other logic within Chromium so if you want access to the _original_ value
-you should look up this environment variable instead.

docs/api/extensions.md

@@ -1,104 +0,0 @@
-# Chrome Extension Support
-
-Electron supports a subset of the [Chrome Extensions
-API][chrome-extensions-api-index], primarily to support DevTools extensions and
-Chromium-internal extensions, but it also happens to support some other
-extension capabilities.
-
-[chrome-extensions-api-index]: https://developer.chrome.com/extensions/api_index
-
-> **Note:** Electron does not support arbitrary Chrome extensions from the
-> store, and it is a **non-goal** of the Electron project to be perfectly
-> compatible with Chrome's implementation of Extensions.
-
-## Loading extensions
-
-Electron only supports loading unpacked extensions (i.e., `.crx` files do not
-work). Extensions are installed per-`session`. To load an extension, call
-[`ses.loadExtension`](session.md#sesloadextensionpath):
-
-```js
-const { session } = require('electron')
-
-session.loadExtension('path/to/unpacked/extension').then(({ id }) => {
-  // ...
-})
-```
-
-Loaded extensions will not be automatically remembered across exits; if you do
-not call `loadExtension` when the app runs, the extension will not be loaded.
-
-Note that loading extensions is only supported in persistent sessions.
-Attempting to load an extension into an in-memory session will throw an error.
-
-See the [`session`](session.md) documentation for more information about
-loading, unloading, and querying active extensions.
-
-## Supported Extensions APIs
-
-We support the following extensions APIs, with some caveats. Other APIs may
-additionally be supported, but support for any APIs not listed here is
-provisional and may be removed.
-
-### `chrome.devtools.inspectedWindow`
-
-All features of this API are supported.
-
-### `chrome.devtools.network`
-
-All features of this API are supported.
-
-### `chrome.devtools.panels`
-
-All features of this API are supported.
-
-### `chrome.extension`
-
-The following properties of `chrome.extension` are supported:
-
-- `chrome.extension.lastError`
-
-The following methods of `chrome.extension` are supported:
-
-- `chrome.extension.getURL`
-- `chrome.extension.getBackgroundPage`
-
-### `chrome.runtime`
-
-The following properties of `chrome.runtime` are supported:
-
-- `chrome.runtime.lastError`
-- `chrome.runtime.id`
-
-The following methods of `chrome.runtime` are supported:
-
-- `chrome.runtime.getBackgroundPage`
-- `chrome.runtime.getManifest`
-- `chrome.runtime.getURL`
-- `chrome.runtime.connect`
-- `chrome.runtime.sendMessage`
-
-The following events of `chrome.runtime` are supported:
-
-- `chrome.runtime.onStartup`
-- `chrome.runtime.onInstalled`
-- `chrome.runtime.onSuspend`
-- `chrome.runtime.onSuspendCanceled`
-- `chrome.runtime.onConnect`
-- `chrome.runtime.onMessage`
-
-### `chrome.storage`
-
-Only `chrome.storage.local` is supported; `chrome.storage.sync` and
-`chrome.storage.managed` are not.
-
-### `chrome.tabs`
-
-The following methods of `chrome.tabs` are supported:
-
-- `chrome.tabs.sendMessage`
-- `chrome.tabs.executeScript`
-
-> **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
-> supported and will raise an error.

docs/api/frameless-window.md

@@ -52,7 +52,7 @@ win.show()
 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
+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.
 
@@ -158,7 +158,7 @@ buttons in titlebar non-draggable.
 
 ## Text selection
 
-In a frameless window the dragging behavior may conflict with selecting text.
+In a frameless window the dragging behaviour 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:

docs/api/incoming-message.md

@@ -51,17 +51,12 @@ A `String` representing the HTTP status message.
 
 #### `response.headers`
 
-A `Record<string, string | string[]>` representing the HTTP response headers. The `headers` object is
+An `Record<string, string[]>` representing the response HTTP headers. The `headers` object is
 formatted as follows:
 
 * All header names are lowercased.
-* Duplicates of `age`, `authorization`, `content-length`, `content-type`,
-`etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`,
-`last-modified`, `location`, `max-forwards`, `proxy-authorization`, `referer`,
-`retry-after`, `server`, or `user-agent` are discarded.
-* `set-cookie` is always an array. Duplicates are added to the array.
-* For duplicate `cookie` headers, the values are joined together with '; '.
-* For all other headers, the values are joined together with ', '.
+* Each header name produces an array-valued property on the headers object.
+* Each header value is pushed into the array associated with its header name.
 
 #### `response.httpVersion`
 

docs/api/ipc-renderer.md

@@ -57,7 +57,7 @@ Removes all listeners, or those of the specified `channel`.
 
 Send an asynchronous message to the main process via `channel`, along with
 arguments. Arguments will be serialized with the [Structured Clone
-Algorithm][SCA], just like [`window.postMessage`][], so prototype chains will not be
+Algorithm][SCA], just like [`postMessage`][], so prototype chains will not be
 included. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will
 throw an exception.
 
@@ -68,10 +68,6 @@ throw an exception.
 The main process handles it by listening for `channel` with the
 [`ipcMain`](ipc-main.md) module.
 
-If you need to transfer a [`MessagePort`][] to the main process, use [`ipcRenderer.postMessage`](#ipcrendererpostmessagechannel-message-transfer).
-
-If you want to receive a single response from the main process, like the result of a method call, consider using [`ipcRenderer.invoke`](#ipcrendererinvokechannel-args).
-
 ### `ipcRenderer.invoke(channel, ...args)`
 
 * `channel` String
@@ -81,7 +77,7 @@ Returns `Promise<any>` - Resolves with the response from the main process.
 
 Send a message to the main process via `channel` and expect a result
 asynchronously. Arguments will be serialized with the [Structured Clone
-Algorithm][SCA], just like [`window.postMessage`][], so prototype chains will not be
+Algorithm][SCA], just like [`postMessage`][], so prototype chains will not be
 included. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will
 throw an exception.
 
@@ -106,10 +102,6 @@ ipcMain.handle('some-name', async (event, someArgument) => {
 })
 ```
 
-If you need to transfer a [`MessagePort`][] to the main process, use [`ipcRenderer.postMessage`](#ipcrendererpostmessagechannel-message-transfer).
-
-If you do not need a respons to the message, consider using [`ipcRenderer.send`](#ipcrenderersendchannel-args).
-
 ### `ipcRenderer.sendSync(channel, ...args)`
 
 * `channel` String
@@ -119,7 +111,7 @@ Returns `any` - The value sent back by the [`ipcMain`](ipc-main.md) handler.
 
 Send a message to the main process via `channel` and expect a result
 synchronously. Arguments will be serialized with the [Structured Clone
-Algorithm][SCA], just like [`window.postMessage`][], so prototype chains will not be
+Algorithm][SCA], just like [`postMessage`][], so prototype chains will not be
 included. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will
 throw an exception.
 
@@ -135,35 +127,6 @@ and replies by setting `event.returnValue`.
 > last resort. It's much better to use the asynchronous version,
 > [`invoke()`](ipc-renderer.md#ipcrendererinvokechannel-args).
 
-### `ipcRenderer.postMessage(channel, message, [transfer])`
-
-* `channel` String
-* `message` any
-* `transfer` MessagePort[] (optional)
-
-Send a message to the main process, optionally transferring ownership of zero
-or more [`MessagePort`][] objects.
-
-The transferred `MessagePort` objects will be available in the main process as
-[`MessagePortMain`](message-port-main.md) objects by accessing the `ports`
-property of the emitted event.
-
-For example:
-```js
-// Renderer process
-const { port1, port2 } = new MessageChannel()
-ipcRenderer.postMessage('port', { message: 'hello' }, [port1])
-
-// Main process
-ipcMain.on('port', (e, msg) => {
-  const [port] = e.ports
-  // ...
-})
-```
-
-For more information on using `MessagePort` and `MessageChannel`, see the [MDN
-documentation](https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel).
-
 ### `ipcRenderer.sendTo(webContentsId, channel, ...args)`
 
 * `webContentsId` Number
@@ -187,5 +150,4 @@ in the [`ipc-renderer-event`](structures/ipc-renderer-event.md) structure docs.
 
 [event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter
 [SCA]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
-[`window.postMessage`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
-[`MessagePort`]: https://developer.mozilla.org/en-US/docs/Web/API/MessagePort
+[`postMessage`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage

docs/api/menu-item.md

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

docs/api/message-channel-main.md

@@ -1,32 +0,0 @@
-# MessageChannelMain
-
-`MessageChannelMain` is the main-process-side equivalent of the DOM
-[`MessageChannel`][] object. Its singular function is to create a pair of
-connected [`MessagePortMain`](message-port-main.md) objects.
-
-See the [Channel Messaging API][] documentation for more information on using
-channel messaging.
-
-## Class: MessageChannelMain
-
-Process: [Main](../glossary.md#main-process)
-
-Example:
-```js
-const { port1, port2 } = new MessageChannelMain()
-w.webContents.postMessage('port', null, [port2])
-port1.postMessage({ some: 'message' })
-```
-
-### Instance Properties
-
-#### `channel.port1`
-
-A [`MessagePortMain`](message-port-main.md) property.
-
-#### `channel.port2`
-
-A [`MessagePortMain`](message-port-main.md) property.
-
-[`MessageChannel`]: https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel
-[Channel Messaging API]: https://developer.mozilla.org/en-US/docs/Web/API/Channel_Messaging_API

docs/api/message-port-main.md

@@ -1,55 +0,0 @@
-# MessagePortMain
-
-`MessagePortMain` is the main-process-side equivalent of the DOM
-[`MessagePort`][] object. It behaves similarly to the DOM version, with the
-exception that it uses the Node.js `EventEmitter` event system, instead of the
-DOM `EventTarget` system. This means you should use `port.on('message', ...)`
-to listen for events, instead of `port.onmessage = ...` or
-`port.addEventListener('message', ...)`
-
-See the [Channel Messaging API][] documentation for more information on using
-channel messaging.
-
-`MessagePortMain` is an [EventEmitter][event-emitter].
-
-## Class: MessagePortMain
-
-Process: [Main](../glossary.md#main-process)
-
-### Instance Methods
-
-#### `port.postMessage(message, [transfer])`
-
-* `message` any
-* `transfer` MessagePortMain[] (optional)
-
-Sends a message from the port, and optionally, transfers ownership of objects
-to other browsing contexts.
-
-#### `port.start()`
-
-Starts the sending of messages queued on the port. Messages will be queued
-until this method is called.
-
-#### `port.close()`
-
-Disconnects the port, so it is no longer active.
-
-### Instance Events
-
-#### Event: 'message'
-
-Returns:
-
-* `messageEvent` Object
-  * `data` any
-  * `ports` MessagePortMain[]
-
-Emitted when a MessagePortMain object receives a message.
-
-#### Event: 'close'
-
-Emitted when the remote end of a MessagePortMain object becomes disconnected.
-
-[`MessagePort`]: https://developer.mozilla.org/en-US/docs/Web/API/MessagePort
-[Channel Messaging API]: https://developer.mozilla.org/en-US/docs/Web/API/Channel_Messaging_API

docs/api/modernization/property-updates.md

@@ -5,7 +5,14 @@ The Electron team is currently undergoing an initiative to convert separate gett
 ## Candidates
 
 * `BrowserWindow`
+  * `fullscreen`
+  * `simpleFullscreen`
+  * `alwaysOnTop`
+  * `title`
+  * `documentEdited`
+  * `hasShadow`
   * `menubarVisible`
+  * `visibleOnAllWorkspaces`
 * `crashReporter` module
   * `uploadToServer`
 * `webFrame` modules
@@ -34,7 +41,6 @@ The Electron team is currently undergoing an initiative to convert separate gett
   * `fullscreenable`
   * `movable`
   * `closable`
-  * `backgroundThrottling`
 * `NativeImage`
   * `isMacTemplateImage`
 * `SystemPreferences` module

docs/api/native-image.md

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

docs/api/net-log.md

@@ -40,7 +40,7 @@ Starts recording network events to `path`.
 
 ### `netLog.stopLogging()`
 
-Returns `Promise<void>` - resolves when the net log has been flushed to disk.
+Returns `Promise<String>` - resolves with a file path to which network logs were recorded.
 
 Stops recording network events. If not called, net logging will automatically end when app quits.
 
@@ -48,4 +48,8 @@ Stops recording network events. If not called, net logging will automatically en
 
 ### `netLog.currentlyLogging` _Readonly_
 
-A `Boolean` property that indicates whether network logs are currently being recorded.
+A `Boolean` property that indicates whether network logs are recorded.
+
+### `netLog.currentlyLoggingPath` _Readonly_ _Deprecated_
+
+A `String` property that returns the path to the current log file.

docs/api/notification.md

@@ -26,7 +26,7 @@ The `Notification` class has the following static methods:
 
 Returns `Boolean` - Whether or not desktop notifications are supported on the current system
 
-### `new Notification([options])`
+### `new Notification([options])` _Experimental_
 
 * `options` Object (optional)
   * `title` String - A title for the notification, which will be shown at the top of the notification window when it is shown.

docs/api/power-monitor.md

@@ -4,15 +4,31 @@
 
 Process: [Main](../glossary.md#main-process)
 
+
+This module cannot be used until the `ready` event of the `app`
+module is emitted.
+
+For example:
+
+```javascript
+const { app, powerMonitor } = require('electron')
+
+app.whenReady().then(() => {
+  powerMonitor.on('suspend', () => {
+    console.log('The system is going to sleep')
+  })
+})
+```
+
 ## Events
 
 The `powerMonitor` module emits the following events:
 
-### Event: 'suspend' _Linux_ _Windows_
+### Event: 'suspend'
 
 Emitted when the system is suspending.
 
-### Event: 'resume' _Linux_ _Windows_
+### Event: 'resume'
 
 Emitted when system is resuming.
 

docs/api/process.md

@@ -111,11 +111,7 @@ A `Boolean` that controls whether or not process warnings printed to `stderr` in
 
 ### `process.type` _Readonly_
 
-A `String` representing the current process's type, can be:
-
-* `browser` - The main process
-* `renderer` - A renderer process
-* `worker` - In a web worker
+A `String` representing the current process's type, can be `"browser"` (i.e. main process), `"renderer"`, or `"worker"` (i.e. web worker).
 
 ### `process.versions.chrome` _Readonly_
 

docs/api/protocol-ns.md

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

docs/api/protocol.md

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

docs/api/sandbox-option.md

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

docs/api/session.md

@@ -439,13 +439,6 @@ example `"en-US,fr,de,ko,zh-CN,ja"`.
 This doesn't affect existing `WebContents`, and each `WebContents` can use
 `webContents.setUserAgent` to override the session-wide user agent.
 
-#### `ses.isPersistent()`
-
-Returns `Boolean` - Whether or not this session is a persistent one. The default
-`webContents` session of a `BrowserWindow` is persistent. When creating a session
-from a partition, session prefixed with `persist:` will be persistent, while others
-will be temporary.
-
 #### `ses.getUserAgent()`
 
 Returns `String` - The user agent for this session.
@@ -486,7 +479,9 @@ event. The [DownloadItem](download-item.md) will not have any `WebContents` asso
 the initial state will be `interrupted`. The download will start only when the
 `resume` API is called on the [DownloadItem](download-item.md).
 
-#### `ses.clearAuthCache()`
+#### `ses.clearAuthCache(options)`
+
+* `options` ([RemovePassword](structures/remove-password.md) | [RemoveClientCertificate](structures/remove-client-certificate.md))
 
 Returns `Promise<void>` - resolves when the session’s HTTP authentication cache has been cleared.
 
@@ -571,8 +566,6 @@ requests an API that Electron does not support) then they will be logged to the
 console.
 
 Note that Electron does not support the full range of Chrome extensions APIs.
-See [Supported Extensions APIs](extensions.md#supported-extensions-apis) for
-more details on what is supported.
 
 Note that in previous versions of Electron, extensions that were loaded would
 be remembered for future runs of the application. This is no longer the case:
@@ -595,9 +588,6 @@ This API does not support loading packed (.crx) extensions.
 **Note:** This API cannot be called before the `ready` event of the `app` module
 is emitted.
 
-**Note:** Loading extensions into in-memory (non-persistent) sessions is not
-supported and will throw an error.
-
 #### `ses.removeExtension(extensionId)`
 
 * `extensionId` String - ID of extension to remove

docs/api/shell.md

@@ -2,7 +2,7 @@
 
 > Manage files and URLs using their default applications.
 
-Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process) (non-sandboxed only)
+Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)
 
 The `shell` module provides functions related to desktop integration.
 
@@ -14,8 +14,6 @@ const { shell } = require('electron')
 shell.openExternal('https://github.com')
 ```
 
-**Note:** While the `shell` module can be used in the renderer process, it will not function in a sandboxed renderer.
-
 ## Methods
 
 The `shell` module has the following methods:

docs/api/structures/cookie.md

@@ -12,4 +12,3 @@
 * `expirationDate` Double (optional) - The expiration date of the cookie as
   the number of seconds since the UNIX epoch. Not provided for session
   cookies.
-* `sameSite` String - The [Same Site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#SameSite_cookies) policy applied to this cookie.  Can be `unspecified`, `no_restriction`, `lax` or `strict`.

docs/api/structures/ipc-main-event.md

@@ -3,7 +3,6 @@
 * `frameId` Integer - The ID of the renderer frame that sent this message
 * `returnValue` any - Set this to the value to be returned in a synchronous message
 * `sender` WebContents - Returns the `webContents` that sent the message
-* `ports` MessagePortMain[] - A list of MessagePorts that were transferred with this message
 * `reply` Function - A function that will send an IPC message to the renderer frame that sent the original message that you are currently handling.  You should use this method to "reply" to the sent message in order to guarantee the reply will go to the correct process and frame.
   * `channel` String
   * `...args` any[]

docs/api/structures/ipc-renderer-event.md

@@ -2,6 +2,5 @@
 
 * `sender` IpcRenderer - The `IpcRenderer` instance that emitted the event originally
 * `senderId` Integer - The `webContents.id` that sent the message, you can call `event.sender.sendTo(event.senderId, ...)` to reply to the message, see [ipcRenderer.sendTo][ipc-renderer-sendto] for more information. This only applies to messages sent from a different renderer. Messages sent directly from the main process set `event.senderId` to `0`.
-* `ports` MessagePort[] - A list of MessagePorts that were transferred with this message
 
 [ipc-renderer-sendto]: #ipcrenderersendtowindowid-channel--arg1-arg2-

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

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

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

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

docs/api/structures/post-body.md

@@ -1,23 +0,0 @@
-# PostBody Object
-
-* `data` Array<[PostData](./post-data.md)> - The post data to be sent to the
-  new window.
-* `contentType` String - The `content-type` header used for the data. One of
-  `application/x-www-form-urlencoded` or `multipart/form-data`. Corresponds to
-  the `enctype` attribute of the submitted HTML form.
-* `boundary` String (optional) - The boundary used to separate multiple parts of
-  the message. Only valid when `contentType` is `multipart/form-data`.
-
-Note that keys starting with `--` are not currently supported. For example, this will errantly submit as `multipart/form-data` when `nativeWindowOpen` is set to `false` in webPreferences:
-
-```html
-<form
-  target="_blank"
-  method="POST"
-  enctype="application/x-www-form-urlencoded"
-  action="https://postman-echo.com/post"
->
-  <input type="text" name="--theKey">
-  <input type="submit">
-</form>
-```

docs/api/structures/post-data.md

@@ -1,21 +0,0 @@
-# PostData Object
-
-* `type` String - One of the following:
-  * `rawData` - The data is available as a `Buffer`, in the `rawData` field.
-  * `file` - The object represents a file. The `filePath`, `offset`, `length`
-    and `modificationTime` fields will be used to describe the file.
-  * `blob` - The object represents a `Blob`. The `blobUUID` field will be used
-    to describe the `Blob`.
-* `bytes` String (optional) - The raw bytes of the post data in a `Buffer`.
-  Required for the `rawData` type.
-* `filePath` String (optional) - The path of the file being uploaded. Required
-  for the `file` type.
-* `blobUUID` String (optional) - The `UUID` of the `Blob` being uploaded.
-  Required for the `blob` type.
-* `offset` Integer (optional) - The offset from the beginning of the file being
-  uploaded, in bytes. Only valid for `file` types.
-* `length` Integer (optional) - The length of the file being uploaded, in bytes.
-  If set to `-1`, the whole file will be uploaded. Only valid for `file` types.
-* `modificationTime` Double (optional) - The modification time of the file
-  represented by a double, which is the number of seconds since the `UNIX Epoch`
-  (Jan 1, 1970). Only valid for `file` types.

docs/api/structures/protocol-request.md

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

docs/api/structures/remove-client-certificate.md

@@ -0,0 +1,5 @@
+# RemoveClientCertificate Object
+
+* `type` String - `clientCertificate`.
+* `origin` String - Origin of the server whose associated client certificate
+  must be removed from the cache.

docs/api/structures/remove-password.md

@@ -0,0 +1,15 @@
+# RemovePassword Object
+
+* `type` String - `password`.
+* `origin` String (optional) - When provided, the authentication info
+  related to the origin will only be removed otherwise the entire cache
+  will be cleared.
+* `scheme` String (optional) - Scheme of the authentication.
+  Can be `basic`, `digest`, `ntlm`, `negotiate`. Must be provided if
+  removing by `origin`.
+* `realm` String (optional) - Realm of the authentication. Must be provided if
+  removing by `origin`.
+* `username` String (optional) - Credentials of the authentication. Must be
+  provided if removing by `origin`.
+* `password` String (optional) - Credentials of the authentication. Must be
+  provided if removing by `origin`.

docs/api/system-preferences.md

@@ -180,7 +180,7 @@ Some popular `key` and `type`s are:
 ### `systemPreferences.setUserDefault(key, type, value)` _macOS_
 
 * `key` String
-* `type` String - Can be `string`, `boolean`, `integer`, `float`, `double`, `url`, `array` or `dictionary`.
+* `type` String - See [`getUserDefault`](#systempreferencesgetuserdefaultkey-type-macos).
 * `value` String
 
 Set the value of `key` in `NSUserDefaults`.
@@ -326,7 +326,7 @@ This API is only available on macOS 10.14 Mojave or newer.
     * `window-frame-text` - The text in the window's titlebar area.
 
 Returns `String` - The system color setting in RGB hexadecimal form (`#ABCDEF`).
-See the [Windows docs][windows-colors] and the [macOS docs][macos-colors] for more details.
+See the [Windows docs][windows-colors] and the [MacOS docs][macos-colors] for more details.
 
 The following colors are only available on macOS 10.14: `find-highlight`, `selected-content-background`, `separator`, `unemphasized-selected-content-background`, `unemphasized-selected-text-background`, and `unemphasized-selected-text`.
 
@@ -416,7 +416,7 @@ This API itself will not protect your user data; rather, it is a mechanism to al
 
 Returns `Boolean` - `true` if the current process is a trusted accessibility client and `false` if it is not.
 
-### `systemPreferences.getMediaAccessStatus(mediaType)` _Windows_ _macOS_
+### `systemPreferences.getMediaAccessStatus(mediaType)` _macOS_
 
 * `mediaType` String - Can be `microphone`, `camera` or `screen`.
 
@@ -426,9 +426,6 @@ This user consent was not required on macOS 10.13 High Sierra or lower so this m
 macOS 10.14 Mojave or higher requires consent for `microphone` and `camera` access.
 macOS 10.15 Catalina or higher requires consent for `screen` access.
 
-Windows 10 has a global setting controlling `microphone` and `camera` access for all win32 applications.
-It will always return `granted` for `screen` and for all media types on older versions of Windows.
-
 ### `systemPreferences.askForMediaAccess(mediaType)` _macOS_
 
 * `mediaType` String - the type of media being requested; can be `microphone`, `camera`.

docs/api/touch-bar-button.md

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBarButton(options)`
+### `new TouchBarButton(options)` _Experimental_
 
 * `options` Object
   * `label` String (optional) - Button text.

docs/api/touch-bar-color-picker.md

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBarColorPicker(options)`
+### `new TouchBarColorPicker(options)` _Experimental_
 
 * `options` Object
   * `availableColors` String[] (optional) - Array of hex color strings to

docs/api/touch-bar-group.md

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBarGroup(options)`
+### `new TouchBarGroup(options)` _Experimental_
 
 * `options` Object
   * `items` [TouchBar](touch-bar.md) - Items to display as a group.

docs/api/touch-bar-label.md

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBarLabel(options)`
+### `new TouchBarLabel(options)` _Experimental_
 
 * `options` Object
   * `label` String (optional) - Text to display.

docs/api/touch-bar-other-items-proxy.md

@@ -1,12 +0,0 @@
-## Class: TouchBarOtherItemsProxy
-
-> Instantiates a special "other items proxy", which nests TouchBar elements inherited
-> from Chromium at the space indicated by the proxy. By default, this proxy is added
-> to each TouchBar at the end of the input. For more information, see the AppKit docs on
-> [NSTouchBarItemIdentifierOtherItemsProxy](https://developer.apple.com/documentation/appkit/nstouchbaritemidentifierotheritemsproxy)
->
-> Note: Only one instance of this class can be added per TouchBar.
-
-Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
-
-### `new TouchBarOtherItemsProxy()`

docs/api/touch-bar-popover.md

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBarPopover(options)`
+### `new TouchBarPopover(options)` _Experimental_
 
 * `options` Object
   * `label` String (optional) - Popover button text.

docs/api/touch-bar-scrubber.md

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBarScrubber(options)`
+### `new TouchBarScrubber(options)` _Experimental_
 
 * `options` Object
   * `items` [ScrubberItem[]](structures/scrubber-item.md) - An array of items to place in this scrubber.

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

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBarSegmentedControl(options)`
+### `new TouchBarSegmentedControl(options)` _Experimental_
 
 * `options` Object
   * `segmentStyle` String (optional) - Style of the segments:

docs/api/touch-bar-slider.md

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBarSlider(options)`
+### `new TouchBarSlider(options)` _Experimental_
 
 * `options` Object
   * `label` String (optional) - Label text.

docs/api/touch-bar-spacer.md

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBarSpacer(options)`
+### `new TouchBarSpacer(options)` _Experimental_
 
 * `options` Object
   * `size` String (optional) - Size of spacer, possible values are:

docs/api/touch-bar.md

@@ -4,7 +4,7 @@
 
 Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
 
-### `new TouchBar(options)`
+### `new TouchBar(options)` _Experimental_
 
 * `options` Object
   * `items` ([TouchBarButton](touch-bar-button.md) | [TouchBarColorPicker](touch-bar-color-picker.md) | [TouchBarGroup](touch-bar-group.md) | [TouchBarLabel](touch-bar-label.md) | [TouchBarPopover](touch-bar-popover.md) | [TouchBarScrubber](touch-bar-scrubber.md) | [TouchBarSegmentedControl](touch-bar-segmented-control.md) | [TouchBarSlider](touch-bar-slider.md) | [TouchBarSpacer](touch-bar-spacer.md))[] (optional)
@@ -58,10 +58,6 @@ A [`typeof TouchBarSlider`](./touch-bar-slider.md) reference to the `TouchBarSli
 
 A [`typeof TouchBarSpacer`](./touch-bar-spacer.md) reference to the `TouchBarSpacer` class.
 
-#### `TouchBarOtherItemsProxy`
-
-A [`typeof TouchBarOtherItemsProxy`](./touch-bar-other-items-proxy.md) reference to the `TouchBarOtherItemsProxy` class.
-
 ### Instance Properties
 
 The following properties are available on instances of `TouchBar`:

docs/api/web-contents.md

@@ -138,7 +138,7 @@ Emitted when page receives favicon urls.
 
 Returns:
 
-* `event` NewWindowWebContentsEvent
+* `event` Event
 * `url` String
 * `frameName` String
 * `disposition` String - Can be `default`, `foreground-tab`, `background-tab`,
@@ -150,10 +150,6 @@ Returns:
 * `referrer` [Referrer](structures/referrer.md) - The referrer that will be
   passed to the new window. May or may not result in the `Referer` header being
   sent, depending on the referrer policy.
-* `postBody` [PostBody](structures/post-body.md) (optional) - The post data that
-  will be sent to the new window, along with the appropriate headers that will
-  be set. If no post data is to be sent, the value will be `null`. Only defined
-  when the window is being created by a form that set `target=_blank`.
 
 Emitted when the page requests to open a new window for a `url`. It could be
 requested by `window.open` or an external link like `<a target='_blank'>`.
@@ -166,7 +162,7 @@ new [`BrowserWindow`](browser-window.md). If you call `event.preventDefault()` a
 instance, failing to do so may result in unexpected behavior. For example:
 
 ```javascript
-myBrowserWindow.webContents.on('new-window', (event, url, frameName, disposition, options, additionalFeatures, referrer, postBody) => {
+myBrowserWindow.webContents.on('new-window', (event, url, frameName, disposition, options) => {
   event.preventDefault()
   const win = new BrowserWindow({
     webContents: options.webContents, // use existing webContents if provided
@@ -174,16 +170,7 @@ myBrowserWindow.webContents.on('new-window', (event, url, frameName, disposition
   })
   win.once('ready-to-show', () => win.show())
   if (!options.webContents) {
-    const loadOptions = {
-      httpReferrer: referrer
-    }
-    if (postBody != null) {
-      const { data, contentType, boundary } = postBody
-      loadOptions.postData = postBody.data
-      loadOptions.extraHeaders = `content-type: ${contentType}; boundary=${boundary}`
-    }
-
-    win.loadURL(url, loadOptions) // existing webContents will be navigated automatically
+    win.loadURL(url) // existing webContents will be navigated automatically
   }
   event.newGuest = win
 })
@@ -323,7 +310,7 @@ and allow the page to be unloaded.
 const { BrowserWindow, dialog } = require('electron')
 const win = new BrowserWindow({ width: 800, height: 600 })
 win.webContents.on('will-prevent-unload', (event) => {
-  const choice = dialog.showMessageBoxSync(win, {
+  const choice = dialog.showMessageBox(win, {
     type: 'question',
     buttons: ['Leave', 'Stay'],
     title: 'Do you want to leave this site?',
@@ -338,7 +325,7 @@ win.webContents.on('will-prevent-unload', (event) => {
 })
 ```
 
-#### Event: 'crashed' _Deprecated_
+#### Event: 'crashed'
 
 Returns:
 
@@ -347,29 +334,6 @@ Returns:
 
 Emitted when the renderer process crashes or is killed.
 
-**Deprecated:** This event is superceded by the `render-process-gone` event
-which contains more information about why the render process dissapeared. It
-isn't always because it crashed.  The `killed` boolean can be replaced by
-checking `reason === 'killed'` when you switch to that event.
-
-#### Event: 'render-process-gone'
-
-Returns:
-
-* `event` Event
-* `details` Object
-  * `reason` String - The reason the render process is gone.  Possible values:
-    * `clean-exit` - Process exited with an exit code of zero
-    * `abnormal-exit` - Process exited with a non-zero exit code
-    * `killed` - Process was sent a SIGTERM or otherwise killed externally
-    * `crashed` - Process crashed
-    * `oom` - Process ran out of memory
-    * `launch-failure` - Process never successfully launched
-    * `integrity-failure` - Windows code integrity checks failed
-
-Emitted when the renderer process unexpectedly dissapears.  This is normally
-because it was crashed or killed.
-
 #### Event: 'unresponsive'
 
 Emitted when the web page becomes unresponsive.
@@ -402,7 +366,6 @@ Returns:
   * `key` String - Equivalent to [KeyboardEvent.key][keyboardevent].
   * `code` String - Equivalent to [KeyboardEvent.code][keyboardevent].
   * `isAutoRepeat` Boolean - Equivalent to [KeyboardEvent.repeat][keyboardevent].
-  * `isComposing` Boolean - Equivalent to [KeyboardEvent.isComposing][keyboardevent].
   * `shift` Boolean - Equivalent to [KeyboardEvent.shiftKey][keyboardevent].
   * `control` Boolean - Equivalent to [KeyboardEvent.controlKey][keyboardevent].
   * `alt` Boolean - Equivalent to [KeyboardEvent.altKey][keyboardevent].
@@ -413,7 +376,7 @@ Calling `event.preventDefault` will prevent the page `keydown`/`keyup` events
 and the menu shortcuts.
 
 To only prevent the menu shortcuts, use
-[`setIgnoreMenuShortcuts`](#contentssetignoremenushortcutsignore):
+[`setIgnoreMenuShortcuts`](#contentssetignoremenushortcutsignore-experimental):
 
 ```javascript
 const { BrowserWindow } = require('electron')
@@ -908,10 +871,10 @@ Returns `String` - The URL of the current web page.
 ```javascript
 const { BrowserWindow } = require('electron')
 let win = new BrowserWindow({ width: 800, height: 600 })
-win.loadURL('http://github.com').then(() => {
-  const currentURL = win.webContents.getURL()
-  console.log(currentURL)
-})
+win.loadURL('http://github.com')
+
+let currentURL = win.webContents.getURL()
+console.log(currentURL)
 ```
 
 #### `contents.getTitle()`
@@ -1075,7 +1038,7 @@ or is rejected if the result of the code is a rejected promise.
 
 Works like `executeJavaScript` but evaluates `scripts` in an isolated context.
 
-#### `contents.setIgnoreMenuShortcuts(ignore)`
+#### `contents.setIgnoreMenuShortcuts(ignore)` _Experimental_
 
 * `ignore` Boolean
 
@@ -1311,8 +1274,6 @@ Returns [`PrinterInfo[]`](structures/printer-info.md)
   * `success` Boolean - Indicates success of the print call.
   * `failureReason` String - Error description called back if the print fails.
 
-When a custom `pageSize` is passed, Chromium attempts to validate platform specific minumum values for `width_microns` and `height_microns`. Width and height must both be minimum 353 microns but may be higher on some operating systems.
-
 Prints window's web page. When `silent` is set to `true`, Electron will pick
 the system's default printer if `deviceName` is empty and the default settings for printing.
 
@@ -1336,12 +1297,13 @@ win.webContents.print(options, (success, errorType) => {
   * `landscape` Boolean (optional) - `true` for landscape, `false` for portrait.
   * `marginsType` Integer (optional) - Specifies the type of margins to use. Uses 0 for
     default margin, 1 for no margin, and 2 for minimum margin.
+    and `width` in microns.
   * `scaleFactor` Number (optional) - The scale factor of the web page. Can range from 0 to 100.
   * `pageRanges` Record<string, number> (optional) - The page range to print.
     * `from` Number - the first page to print.
     * `to` Number - the last page to print (inclusive).
   * `pageSize` String | Size (optional) - Specify page size of the generated PDF. Can be `A3`,
-  `A4`, `A5`, `Legal`, `Letter`, `Tabloid` or an Object containing `height` and `width` in microns.
+  `A4`, `A5`, `Legal`, `Letter`, `Tabloid` or an Object containing `height`
   * `printBackground` Boolean (optional) - Whether to print CSS backgrounds.
   * `printSelectionOnly` Boolean (optional) - Whether to print selection only.
 
@@ -1372,8 +1334,6 @@ An example of `webContents.printToPDF`:
 ```javascript
 const { BrowserWindow } = require('electron')
 const fs = require('fs')
-const path = require('path')
-const os = require('os')
 
 let win = new BrowserWindow({ width: 800, height: 600 })
 win.loadURL('http://github.com')
@@ -1381,13 +1341,12 @@ win.loadURL('http://github.com')
 win.webContents.on('did-finish-load', () => {
   // Use default printing options
   win.webContents.printToPDF({}).then(data => {
-    const pdfPath = path.join(os.homedir(), 'Desktop', 'temp.pdf')
-    fs.writeFile(pdfPath, data, (error) => {
+    fs.writeFile('/tmp/print.pdf', data, (error) => {
       if (error) throw error
-      console.log(`Wrote PDF successfully to ${pdfPath}`)
+      console.log('Write PDF successfully.')
     })
   }).catch(error => {
-    console.log(`Failed to write PDF to ${pdfPath}: `, error)
+    console.log(error)
   })
 })
 ```
@@ -1620,32 +1579,6 @@ ipcMain.on('ping', (event) => {
 })
 ```
 
-#### `contents.postMessage(channel, message, [transfer])`
-
-* `channel` String
-* `message` any
-* `transfer` MessagePortMain[] (optional)
-
-Send a message to the renderer process, optionally transferring ownership of
-zero or more [`MessagePortMain`][] objects.
-
-The transferred `MessagePortMain` objects will be available in the renderer
-process by accessing the `ports` property of the emitted event. When they
-arrive in the renderer, they will be native DOM `MessagePort` objects.
-
-For example:
-```js
-// Main process
-const { port1, port2 } = new MessageChannelMain()
-webContents.postMessage('port', { message: 'hello' }, [port1])
-
-// Renderer process
-ipcRenderer.on('port', (e, msg) => {
-  const [port] = e.ports
-  // ...
-})
-```
-
 #### `contents.enableDeviceEmulation(parameters)`
 
 * `parameters` Object
@@ -1817,11 +1750,6 @@ Returns `Promise<void>` - Indicates whether the snapshot has been created succes
 
 Takes a V8 heap snapshot and saves it to `filePath`.
 
-#### `contents.getBackgroundThrottling()`
-
-Returns `Boolean` - whether or not this WebContents will throttle animations and timers
-when the page becomes backgrounded. This also affects the Page Visibility API.
-
 #### `contents.setBackgroundThrottling(allowed)`
 
 * `allowed` Boolean
@@ -1876,7 +1804,7 @@ A [`WebContents`](web-contents.md) instance that might own this `WebContents`.
 
 #### `contents.devToolsWebContents` _Readonly_
 
-A `WebContents | null` property that represents the of DevTools `WebContents` associated with a given `WebContents`.
+A `WebContents` of DevTools for this `WebContents`.
 
 **Note:** Users should never store this object because it may become `null`
 when the DevTools has been closed.
@@ -1889,8 +1817,3 @@ A [`Debugger`](debugger.md) instance for this webContents.
 [event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter
 [SCA]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
 [`postMessage`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
-
-#### `contents.backgroundThrottling`
-
-A `Boolean` property that determines whether or not this WebContents will throttle animations and timers
-when the page becomes backgrounded. This also affects the Page Visibility API.

docs/api/web-frame.md

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

docs/breaking-changes.md

@@ -2,143 +2,13 @@
 
 Breaking changes will be documented here, and deprecation warnings added to JS code where possible, at least [one major version](tutorial/electron-versioning.md#semver) before the change is made.
 
-### Types of Breaking Changes
+## `FIXME` comments
 
-This document uses the following convention to categorize breaking changes:
-
-- **API Changed:** An API was changed in such a way that code that has not been updated is guaranteed to throw an exception.
-- **Behavior Changed:** The behavior of Electron has changed, but not in such a way that an exception will necessarily be thrown.
-- **Default Changed:** Code depending on the old default may break, not necessarily throwing an exception. The old behavior can be restored by explicitly specifying the value.
-- **Deprecated:** An API was marked as deprecated. The API will continue to function, but will emit a deprecation warning, and will be removed in a future release.
-- **Removed:** An API or feature was removed, and is no longer supported by Electron.
-
-## Planned Breaking API Changes (12.0)
-
-### Removed: `crashReporter` methods in the renderer process
-
-The following `crashReporter` methods are no longer available in the renderer
-process:
-
-- `crashReporter.start`
-- `crashReporter.getLastCrashReport`
-- `crashReporter.getUploadedReports`
-- `crashReporter.getUploadToServer`
-- `crashReporter.setUploadToServer`
-- `crashReporter.getCrashesDirectory`
-
-They should be called only from the main process.
-
-See [#23265](https://github.com/electron/electron/pull/23265) for more details.
-
-### Default Changed: `crashReporter.start({ compress: true })`
-
-The default value of the `compress` option to `crashReporter.start` has changed
-from `false` to `true`. This means that crash dumps will be uploaded to the
-crash ingestion server with the `Content-Encoding: gzip` header, and the body
-will be compressed.
-
-If your crash ingestion server does not support compressed payloads, you can
-turn off compression by specifying `{ compress: false }` in the crash reporter
-options.
-
-## Planned Breaking API Changes (11.0)
-
-There are no breaking changes planned for 11.0.
-
-## Planned Breaking API Changes (10.0)
-
-### Deprecated: `companyName` argument to `crashReporter.start()`
-
-The `companyName` argument to `crashReporter.start()`, which was previously
-required, is now optional, and further, is deprecated. To get the same
-behavior in a non-deprecated way, you can pass a `companyName` value in
-`globalExtra`.
-
-```js
-// Deprecated in Electron 10
-crashReporter.start({ companyName: 'Umbrella Corporation' })
-// Replace with
-crashReporter.start({ globalExtra: { _companyName: 'Umbrella Corporation' } })
-```
-
-### Deprecated: `crashReporter.getCrashesDirectory()`
-
-The `crashReporter.getCrashesDirectory` method has been deprecated. Usage
-should be replaced by `app.getPath('crashDumps')`.
-
-```js
-// Deprecated in Electron 10
-crashReporter.getCrashesDirectory()
-// Replace with
-app.getPath('crashDumps')
-```
-
-### Deprecated: `crashReporter` methods in the renderer process
-
-Calling the following `crashReporter` methods from the renderer process is
-deprecated:
-
-- `crashReporter.start`
-- `crashReporter.getLastCrashReport`
-- `crashReporter.getUploadedReports`
-- `crashReporter.getUploadToServer`
-- `crashReporter.setUploadToServer`
-- `crashReporter.getCrashesDirectory`
-
-The only non-deprecated methods remaining in the `crashReporter` module in the
-renderer are `addExtraParameter`, `removeExtraParameter` and `getParameters`.
-
-All above methods remain non-deprecated when called from the main process.
-
-See [#23265](https://github.com/electron/electron/pull/23265) for more details.
-
-### Deprecated: `crashReporter.start({ compress: false })`
-
-Setting `{ compress: false }` in `crashReporter.start` is deprecated. Nearly
-all crash ingestion servers support gzip compression. This option will be
-removed in a future version of Electron.
-
-### Removed: Browser Window Affinity
-
-The `affinity` option when constructing a new `BrowserWindow` will be removed
-as part of our plan to more closely align with Chromium's process model for security,
-performance and maintainability.
-
-For more detailed information see [#18397](https://github.com/electron/electron/issues/18397).
-
-### Default Changed: `enableRemoteModule` defaults to `false`
-
-In Electron 9, using the remote module without explicitly enabling it via the
-`enableRemoteModule` WebPreferences option began emitting a warning. In
-Electron 10, the remote module is now disabled by default. To use the remote
-module, `enableRemoteModule: true` must be specified in WebPreferences:
-
-```js
-const w = new BrowserWindow({
-  webPreferences: {
-    enableRemoteModule: true
-  }
-})
-```
-
-We [recommend moving away from the remote
-module](https://medium.com/@nornagon/electrons-remote-module-considered-harmful-70d69500f31).
+The `FIXME` string is used in code comments to denote things that should be fixed for future releases. See https://github.com/electron/electron/search?q=fixme
 
 ## Planned Breaking API Changes (9.0)
 
-### Default Changed: Loading non-context-aware native modules in the renderer process is disabled by default
-
-As of Electron 9 we do not allow loading of non-context-aware native modules in
-the renderer process.  This is to improve security, performance and maintainability
-of Electron as a project.
-
-If this impacts you, you can temporarily set `app.allowRendererProcessReuse` to `false`
-to revert to the old behavior.  This flag will only be an option until Electron 11 so
-you should plan to update your native modules to be context aware.
-
-For more detailed information see [#18397](https://github.com/electron/electron/issues/18397).
-
-### Removed: `<webview>.getWebContents()`
+### `<webview>.getWebContents()`
 
 This API, which was deprecated in Electron 8.0, is now removed.
 
@@ -150,7 +20,7 @@ const { remote } = require('electron')
 remote.webContents.fromId(webview.getWebContentsId())
 ```
 
-### Removed: `webFrame.setLayoutZoomLevelLimits()`
+### `webFrame.setLayoutZoomLevelLimits()`
 
 Chromium has removed support for changing the layout zoom level limits, and it
 is beyond Electron's capacity to maintain it. The function was deprecated in
@@ -158,7 +28,7 @@ Electron 8.x, and has been removed in Electron 9.x. The layout zoom level limits
 are now fixed at a minimum of 0.25 and a maximum of 5.0, as defined
 [here](https://chromium.googlesource.com/chromium/src/+/938b37a6d2886bf8335fc7db792f1eb46c65b2ae/third_party/blink/common/page/page_zoom.cc#11).
 
-### Behavior Changed: Sending non-JS objects over IPC now throws an exception
+### Sending non-JS objects over IPC now throws an exception
 
 In Electron 8.0, IPC was changed to use the Structured Clone Algorithm,
 bringing significant performance improvements. To help ease the transition, the
@@ -174,14 +44,9 @@ In Electron 9.0, the old serialization algorithm has been removed, and sending
 such non-serializable objects will now throw an "object could not be cloned"
 error.
 
-### API Changed: `shell.openItem` is now `shell.openPath`
-
-The `shell.openItem` API has been replaced with an asynchronous `shell.openPath` API.
-You can see the original API proposal and reasoning [here](https://github.com/electron/governance/blob/master/wg-api/spec-documents/shell-openitem.md).
-
 ## Planned Breaking API Changes (8.0)
 
-### Behavior Changed: Values sent over IPC are now serialized with Structured Clone Algorithm
+### Values sent over IPC are now serialized with Structured Clone Algorithm
 
 The algorithm used to serialize objects sent over IPC (through
 `ipcRenderer.send`, `ipcRenderer.sendSync`, `WebContents.send` and related
@@ -232,7 +97,7 @@ these kinds of objects will throw a 'could not be cloned' error.
 
 [SCA]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
 
-### Deprecated: `<webview>.getWebContents()`
+### `<webview>.getWebContents()`
 
 This API is implemented using the `remote` module, which has both performance
 and security implications. Therefore its usage should be explicit.
@@ -273,7 +138,7 @@ const { ipcRenderer } = require('electron')
 ipcRenderer.invoke('openDevTools', webview.getWebContentsId())
 ```
 
-### Deprecated: `webFrame.setLayoutZoomLevelLimits()`
+### `webFrame.setLayoutZoomLevelLimits()`
 
 Chromium has removed support for changing the layout zoom level limits, and it
 is beyond Electron's capacity to maintain it. The function will emit a warning
@@ -283,7 +148,7 @@ limits are now fixed at a minimum of 0.25 and a maximum of 5.0, as defined
 
 ## Planned Breaking API Changes (7.0)
 
-### Deprecated: Atom.io Node Headers URL
+### Node Headers URL
 
 This is the URL specified as `disturl` in a `.npmrc` file or as the `--dist-url`
 command line flag when building native Node modules.  Both will be supported for
@@ -293,7 +158,7 @@ Deprecated: https://atom.io/download/electron
 
 Replace with: https://electronjs.org/headers
 
-### API Changed: `session.clearAuthCache()` no longer accepts options
+### `session.clearAuthCache(options)`
 
 The `session.clearAuthCache` API no longer accepts options for what to clear, and instead unconditionally clears the whole cache.
 
@@ -304,25 +169,25 @@ session.clearAuthCache({ type: 'password' })
 session.clearAuthCache()
 ```
 
-### API Changed: `powerMonitor.querySystemIdleState` is now `powerMonitor.getSystemIdleState`
+### `powerMonitor.querySystemIdleState`
 
 ```js
 // Removed in Electron 7.0
 powerMonitor.querySystemIdleState(threshold, callback)
 // Replace with synchronous API
-const idleState = powerMonitor.getSystemIdleState(threshold)
+const idleState = getSystemIdleState(threshold)
 ```
 
-### API Changed: `powerMonitor.querySystemIdleTime` is now `powerMonitor.getSystemIdleState`
+### `powerMonitor.querySystemIdleTime`
 
 ```js
 // Removed in Electron 7.0
 powerMonitor.querySystemIdleTime(callback)
 // Replace with synchronous API
-const idleTime = powerMonitor.getSystemIdleTime()
+const idleTime = getSystemIdleTime()
 ```
 
-### API Changed: `webFrame.setIsolatedWorldInfo` replaces separate methods
+### webFrame Isolated World APIs
 
 ```js
 // Removed in Electron 7.0
@@ -339,11 +204,11 @@ webFrame.setIsolatedWorldInfo(
   })
 ```
 
-### Removed: `marked` property on `getBlinkMemoryInfo`
+### Removal of deprecated `marked` property on getBlinkMemoryInfo
 
 This property was removed in Chromium 77, and as such is no longer available.
 
-### Behavior Changed: `webkitdirectory` attribute for `<input type="file"/>` now lists directory contents
+### `webkitdirectory` attribute for `<input type="file"/>`
 
 The `webkitdirectory` property on HTML file inputs allows them to select folders.
 Previous versions of Electron had an incorrect implementation where the `event.target.files`
@@ -376,10 +241,9 @@ In Electron 7, this now returns a `FileList` with a `File` object for:
 Note that `webkitdirectory` no longer exposes the path to the selected folder.
 If you require the path to the selected folder rather than the folder contents,
 see the `dialog.showOpenDialog` API ([link](https://github.com/electron/electron/blob/master/docs/api/dialog.md#dialogshowopendialogbrowserwindow-options)).
-
 ## Planned Breaking API Changes (6.0)
 
-### API Changed: `win.setMenu(null)` is now `win.removeMenu()`
+### `win.setMenu(null)`
 
 ```js
 // Deprecated
@@ -388,7 +252,7 @@ win.setMenu(null)
 win.removeMenu()
 ```
 
-### API Changed: `contentTracing.getTraceBufferUsage()` is now a promise
+### `contentTracing.getTraceBufferUsage()`
 
 ```js
 // Deprecated
@@ -401,7 +265,7 @@ contentTracing.getTraceBufferUsage().then(infoObject => {
 })
 ```
 
-### API Changed: `electron.screen` in the renderer process should be accessed via `remote`
+### `electron.screen` in renderer process
 
 ```js
 // Deprecated
@@ -410,7 +274,7 @@ require('electron').screen
 require('electron').remote.screen
 ```
 
-### API Changed: `require()`ing node builtins in sandboxed renderers no longer implicitly loads the `remote` version
+### `require` in sandboxed renderers
 
 ```js
 // Deprecated
@@ -434,25 +298,25 @@ require('path')
 require('electron').remote.require('path')
 ```
 
-### Deprecated: `powerMonitor.querySystemIdleState` replaced with `powerMonitor.getSystemIdleState`
+### `powerMonitor.querySystemIdleState`
 
 ```js
 // Deprecated
 powerMonitor.querySystemIdleState(threshold, callback)
 // Replace with synchronous API
-const idleState = powerMonitor.getSystemIdleState(threshold)
+const idleState = getSystemIdleState(threshold)
 ```
 
-### Deprecated: `powerMonitor.querySystemIdleTime` replaced with `powerMonitor.getSystemIdleTime`
+### `powerMonitor.querySystemIdleTime`
 
 ```js
 // Deprecated
 powerMonitor.querySystemIdleTime(callback)
 // Replace with synchronous API
-const idleTime = powerMonitor.getSystemIdleTime()
+const idleTime = getSystemIdleTime()
 ```
 
-### Deprecated: `app.enableMixedSandbox()` is no longer needed
+### `app.enableMixedSandbox`
 
 ```js
 // Deprecated
@@ -461,7 +325,7 @@ app.enableMixedSandbox()
 
 Mixed-sandbox mode is now enabled by default.
 
-### Deprecated: `Tray.setHighlightMode`
+### `Tray`
 
 Under macOS Catalina our former Tray implementation breaks.
 Apple's native substitute doesn't support changing the highlighting behavior.
@@ -474,7 +338,7 @@ tray.setHighlightMode(mode)
 
 ## Planned Breaking API Changes (5.0)
 
-### Default Changed: `nodeIntegration` and `webviewTag` default to false, `contextIsolation` defaults to true
+### `new BrowserWindow({ webPreferences })`
 
 The following `webPreferences` option default values are deprecated in favor of the new defaults listed below.
 
@@ -494,16 +358,16 @@ const w = new BrowserWindow({
 })
 ```
 
-### Behavior Changed: `nodeIntegration` in child windows opened via `nativeWindowOpen`
+### `nativeWindowOpen`
 
-Child windows opened with the `nativeWindowOpen` option will always have Node.js integration disabled, unless `nodeIntegrationInSubFrames` is `true`.
+Child windows opened with the `nativeWindowOpen` option will always have Node.js integration disabled, unless `nodeIntegrationInSubFrames` is `true.
 
-### API Changed: Registering privileged schemes must now be done before app ready
+### Privileged Schemes Registration
 
-Renderer process APIs `webFrame.registerURLSchemeAsPrivileged` and `webFrame.registerURLSchemeAsBypassingCSP` as well as browser process API `protocol.registerStandardSchemes` have been removed.
+Renderer process APIs `webFrame.setRegisterURLSchemeAsPrivileged` and `webFrame.registerURLSchemeAsBypassingCSP` as well as browser process API `protocol.registerStandardSchemes` have been removed.
 A new API, `protocol.registerSchemesAsPrivileged` has been added and should be used for registering custom schemes with the required privileges. Custom schemes are required to be registered before app ready.
 
-### Deprecated: `webFrame.setIsolatedWorld*` replaced with `webFrame.setIsolatedWorldInfo`
+### webFrame Isolated World APIs
 
 ```js
 // Deprecated
@@ -520,7 +384,7 @@ webFrame.setIsolatedWorldInfo(
   })
 ```
 
-### API Changed: `webFrame.setSpellCheckProvider` now takes an asynchronous callback
+## `webFrame.setSpellCheckProvider`
 The `spellCheck` callback is now asynchronous, and `autoCorrectWord` parameter has been removed.
 ```js
 // Deprecated

docs/development/atom-shell-vs-node-webkit.md

@@ -0,0 +1,52 @@
+# Technical Differences Between Electron and NW.js (formerly node-webkit)
+
+__Note: Electron was previously named Atom Shell.__
+
+Like NW.js, Electron provides a platform to write desktop applications
+with JavaScript and HTML and has Node integration to grant access to the low
+level system from web pages.
+
+But there are also fundamental differences between the two projects that make
+Electron a completely separate product from NW.js:
+
+__1. Entry of Application__
+
+In NW.js the main entry point of an application is a web page or a JS script. You specify a
+html or js file in the `package.json` and it is opened in a browser window as
+the application's main window (in case of an html entrypoint) or the script is executed.
+
+In Electron, the entry point is a JavaScript script. Instead of
+providing a URL directly, you manually create a browser window and load
+an HTML file using the API. You also need to listen to window events
+to decide when to quit the application.
+
+Electron works more like the Node.js runtime. Electron's APIs are lower level
+so you can use it for browser testing in place of [PhantomJS](http://phantomjs.org/).
+
+__2. Build System__
+
+In order to avoid the complexity of building all of Chromium, Electron uses [`libchromiumcontent`](https://github.com/electron/libchromiumcontent) to access
+Chromium's Content API. `libchromiumcontent` is a single shared library that
+includes the Chromium Content module and all of its dependencies. Users don't
+need a powerful machine to build Electron.
+
+__3. Node Integration__
+
+In NW.js, the Node integration in web pages requires patching Chromium to
+work, while in Electron we chose a different way to integrate the libuv loop
+with each platform's message loop to avoid hacking Chromium. See the
+[`node_bindings`][node-bindings] code for how that was done.
+
+__4. Multi-context__
+
+If you are an experienced NW.js user, you should be familiar with the
+concept of Node context and web context. These concepts were invented because
+of how NW.js was implemented.
+
+By using the [multi-context](https://github.com/nodejs/node-v0.x-archive/commit/756b622)
+feature of Node, Electron doesn't introduce a new JavaScript context in web
+pages.
+
+Note: NW.js has optionally supported multi-context since 0.13.
+
+[node-bindings]: https://github.com/electron/electron/tree/master/atom/common

docs/development/build-instructions-gn.md

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

docs/development/build-instructions-linux.md

@@ -25,7 +25,7 @@ Follow the guidelines below for building Electron on Linux.
   Doing so permits installing Node on your own home directory as a standard user.
   Or try repositories such as [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories).
 * [clang](https://clang.llvm.org/get_started.html) 3.4 or later.
-* Development headers of GTK 3 and libnotify.
+* Development headers of GTK+ and libnotify.
 
 On Ubuntu, install the following libraries:
 

docs/development/build-instructions-macos.md

@@ -42,7 +42,7 @@ $ pip install pyobjc
 If you're developing Electron and don't plan to redistribute your
 custom Electron build, you may skip this section.
 
-Official Electron builds are built with [Xcode 9.4.1](http://adcdownload.apple.com/Developer_Tools/Xcode_9.4.1/Xcode_9.4.1.xip), and the macOS 10.13 SDK.  Building with a newer SDK works too, but the releases currently use the 10.13 SDK.
+Official Electron builds are built with [Xcode 9.4.1](http://adcdownload.apple.com/Developer_Tools/Xcode_9.4.1/Xcode_9.4.1.xip), and the MacOS 10.13 SDK.  Building with a newer SDK works too, but the releases currently use the 10.13 SDK.
 
 ## Building Electron
 

docs/development/debug-instructions-windows.md

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

docs/development/debugging-instructions-macos.md

@@ -20,7 +20,7 @@ you prefer a graphical interface.
   tail calls, and other compiler optimizations.
 
 * **Xcode**: In addition to Xcode, also install the Xcode command line tools.
-  They include LLDB, the default debugger in Xcode on macOS. It supports
+  They include LLDB, the default debugger in Xcode on Mac OS X. It supports
   debugging C, Objective-C and C++ on the desktop and iOS devices and simulator.
 
 * **.lldbinit**: Create or edit `~/.lldbinit` to allow Chromium code to be properly source-mapped.
@@ -46,7 +46,7 @@ this basic introduction, let's assume that you're calling a command from JavaScr
 that isn't behaving correctly - so you'd like to break on that command's C++
 counterpart inside the Electron source.
 
-Relevant code files can be found in `./shell/`.
+Relevant code files can be found in `./atom/`.
 
 Let's assume that you want to debug `app.setName()`, which is defined in `browser.cc`
 as `Browser::SetName()`. Set the breakpoint using the `breakpoint` command, specifying

docs/development/electron-vs-nwjs.md

@@ -1,75 +0,0 @@
-# Technical Differences Between Electron and NW.js
-
-Like [NW.js][nwjs], Electron provides a platform to write desktop applications with web
-technologies. Both platforms enable developers to utilize HTML, JavaScript, and
-Node.js. On the surface, they seem very similar.
-
-There are however fundamental differences between the two projects that make
-Electron a completely separate product from NW.js.
-
-## 1) Entry of Application
-
-In NW.js, the main entry point of an application can be an HTML web page. In
-that case, NW.js will open the given entry point in a browser window.
-
-In Electron, the entry point is always a JavaScript script. Instead of providing a
-URL directly, you manually create a browser window and load an HTML file using
-the API. You also need to listen to window events to decide when to quit the
-application.
-
-Electron works more like the Node.js runtime. Electron's APIs are lower level so
-you can use it for browser testing in place of
-[PhantomJS](http://phantomjs.org/).
-
-## 2) Node Integration
-
-In NW.js, the Node integration in web pages requires patching Chromium to work,
-while in Electron we chose a different way to integrate the `libuv` loop with
-each platform's message loop to avoid hacking Chromium. See the
-[`node_bindings`][node-bindings] code for how that was done.
-
-## 3) JavaScript Contexts
-
-If you are an experienced NW.js user, you should be familiar with the concept of
-Node context and web context. These concepts were invented because of how NW.js
-was implemented.
-
-By using the
-[multi-context](https://github.com/nodejs/node-v0.x-archive/commit/756b622)
-feature of Node, Electron doesn't introduce a new JavaScript context in web
-pages.
-
-Note: NW.js has optionally supported multi-context since 0.13.
-
-## 4) Legacy Support
-
-NW.js still offers a "legacy release" that supports Windows XP. It doesn't
-receive security updates.
-
-Given that hardware manufacturers, Microsoft, Chromium, and Node.js haven't
-released even critical security updates for that system, we have to warn you
-that using Windows XP is wildly insecure and outright irresponsible.
-
-However, we understand that requirements outside our wildest imagination may
-exist, so if you're looking for something like Electron that runs on Windows XP,
-the NW.js legacy release might be the right fit for you.
-
-## 5) Features
-
-There are numerous differences in the amount of supported features. Electron has
-a bigger community, more production apps using it, and [a large amount of
-userland modules available on npm][electron-modules].
-
-As an example, Electron has built-in support for automatic updates and countless
-tools that make the creation of installers easier. As an example in favor of
-NW.js, NW.js supports more `Chrome.*` APIs for the development of Chrome Apps.
-
-Naturally, we believe that Electron is the better platform for polished
-production applications built with web technologies (like Visual Studio Code,
-Slack, or Facebook Messenger); however, we want to be fair to our web technology
-friends. If you have feature needs that Electron does not meet, you might want
-to try NW.js.
-
-[nwjs]: https://nwjs.io/
-[electron-modules]: https://www.npmjs.com/search?q=electron
-[node-bindings]: https://github.com/electron/electron/tree/master/lib/common

docs/development/goma.md

@@ -5,37 +5,50 @@
 
 Electron has a deployment of a custom Goma Backend that we make available to
 all Electron Maintainers.  See the [Access](#access) section below for details
-on authentication.  There is also a `cache-only` Goma endpoint that will be
-used by default if you do not have credentials.  Requests to the cache-only
-Goma will not hit our cluster, but will read from our cache and should result
-in significantly faster build times.
+on authentication.
 
 ## Enabling Goma
 
-Currently the only supported way to use Goma is to use our [Build Tools](https://github.com/electron/build-tools).
-Goma configuration is automatically included when you set up `build-tools`.
+Currently Electron Goma supports Windows, Linux, and macOS.  If you are
+on a supported platform you can enable goma by importing the `goma.gn` config
+file when using `gn`.
 
-If you are a maintainer and have access to our cluster, please ensure that you run
-`e init` with `--goma=cluster` in order to configure `build-tools` to use
-the Goma cluster.  If you have an existing config, you can just set `"goma": "cluster"`
-in your config file.
+```bash
+gn gen out/Testing --args="import(\"//electron/build/args/testing.gn\") import(\"//electron/build/args/goma.gn\")"
+```
+
+You must ensure that you do not have `cc_wrapper` configured, this means you
+can't use `sccache` or similar technology.
+
+Before you can use goma to build Electron you need to authenticate against
+the Goma service.  You only need to do this once per-machine.
+
+```bash
+cd electron/external_binaries/goma
+./goma_auth.py login
+```
+
+Once authenticated you need to make sure the goma daemon is running on your
+machine.
+
+```bash
+cd electron/external_binaries/goma
+./goma_ctl.py ensure_start
+```
 
 ## Building with Goma
 
 When you are using Goma you can run `ninja` with a substantially higher `j`
 value than would normally be supported by your machine.
 
-Please do not set a value higher than **200** on Windows or Linux and
-**50** on macOS. We monitor Goma system usage, and users found to be abusing
+Please do not set a value higher than **300** on Windows or Linux and
+**80** on macOS, we monitor the goma system and users found to be abusing
 it with unreasonable concurrency will be de-activated.
 
 ```bash
 ninja -C out/Testing electron -j 200
 ```
 
-If you're using `build-tools`, appropriate `-j` values will automatically
-be used for you.
-
 ## Monitoring Goma
 
 If you access [http://localhost:8088](http://localhost:8088) on your local
@@ -43,16 +56,8 @@ machine you can monitor compile jobs as they flow through the goma system.
 
 ## Access
 
-For security and cost reasons, access to Electron's Goma cluster is currently restricted
+For security and cost reasons access to Electron Goma is currently restricted
 to Electron Maintainers.  If you want access please head to `#access-requests` in
 Slack and ping `@goma-squad` to ask for access.  Please be aware that being a
 maintainer does not *automatically* grant access and access is determined on a
 case by case basis.
-
-## Uptime / Support
-
-We have automated monitoring of our Goma cluster and cache at https://status.notgoma.com
-
-We do not provide support for usage of Goma and any issues raised asking for help / having
-issues will _probably_ be closed without much reason, we do not have the capacity to handle
-that kind of support.

docs/development/pull-requests.md

@@ -35,7 +35,7 @@ $ git fetch upstream
 
 Build steps and dependencies differ slightly depending on your operating system.
 See these detailed guides on building Electron locally:
-* [Building on macOS](https://electronjs.org/docs/development/build-instructions-macos)
+* [Building on MacOS](https://electronjs.org/docs/development/build-instructions-macos)
 * [Building on Linux](https://electronjs.org/docs/development/build-instructions-linux)
 * [Building on Windows](https://electronjs.org/docs/development/build-instructions-windows)
 
@@ -55,7 +55,7 @@ $ git checkout -b my-branch -t upstream/master
 ### Step 4: Code
 
 Most pull requests opened against the `electron/electron` repository include
-changes to either the C/C++ code in the `shell/` folder,
+changes to either the C/C++ code in the `atom/` folder,
 the JavaScript code in the `lib/` folder, the documentation in `docs/api/`
 or tests in the `spec/` folder.
 

docs/development/testing.md

@@ -32,12 +32,6 @@ by coding style rules. `npm run lint-py` will check all Python, using
 
 ## Unit Tests
 
-If you are not using [build-tools](https://github.com/electron/build-tools),
-ensure that that name you have configured for your
-local build of Electron is one of `Testing`, `Release`, `Default`, `Debug`, or
-you have set `process.env.ELECTRON_OUT_DIR`. Without these set, Electron will fail
-to perform some pre-testing steps.
-
 To run all unit tests, run `npm run test`. The unit tests are an Electron
 app (surprise!) that can be found in the `spec` folder. Note that it has
 its own `package.json` and that its dependencies are therefore not defined

docs/experimental.md

@@ -1,23 +0,0 @@
-# Experimental APIs
-
-Some of Electrons APIs are tagged with `_Experimental_` in the documentation.
-This tag indicates that the API may not be considered stable and the API may
-be removed or modified more frequently than other APIs with less warning.
-
-## Conditions for an API to be tagged as Experimental
-
-Anyone can request an API be tagged as experimental in a feature PR, disagreements
-on the experimental nature of a feature can be discussed in the API WG if they
-can't be resolved in the PR.
-
-## Process for removing the Experimental tag
-
-Once an API has been stable and in at least two major stable release lines it
-can be nominated to have its experimental tag removed.  This discussion should
-happen at an API WG meeting.  Things to consider when discussing / nominating:
-
-* The above "two major stables release lines" condition must have been met
-* During that time no major bugs / issues should have been caused by the adoption of this feature
-* The API is stable enough and hasn't been heavily impacted by Chromium upgrades
-* Is anyone using the API?
-* Is the API fulfilling the original proposed usecases, does it have any gaps?

docs/faq.md

@@ -139,7 +139,32 @@ When using Electron's built-in module you might encounter an error like this:
 Uncaught TypeError: Cannot read property 'setZoomLevel' of undefined
 ```
 
-It is very likely you are using the module in the wrong process. For example
+This is because you have the [npm `electron` module][electron-module] installed
+either locally or globally, which overrides Electron's built-in module.
+
+To verify whether you are using the correct built-in module, you can print the
+path of the `electron` module:
+
+```javascript
+console.log(require.resolve('electron'))
+```
+
+and then check if it is in the following form:
+
+```sh
+"/path/to/Electron.app/Contents/Resources/atom.asar/renderer/api/lib/exports/electron.js"
+```
+
+If it is something like `node_modules/electron/index.js`, then you have to
+either remove the npm `electron` module, or rename it.
+
+```sh
+npm uninstall electron
+npm uninstall -g electron
+```
+
+However if you are using the built-in module but still getting this error, it
+is very likely you are using the module in the wrong process. For example
 `electron.app` can only be used in the main process, while `electron.webFrame`
 is only available in renderer processes.
 

docs/fiddles/menus/customize-menus/index.html

@@ -21,7 +21,7 @@
 
       <p>
         Open the
-        <a href="https://electronjs.org/docs/api/menu"
+        <a href="http://electron.atom.io/docs/api/menu"
           >full API documentation<span
             >(opens in new window)</span
           ></a
@@ -111,7 +111,7 @@
           <p>
             See the full
             <a
-              href="https://electronjs.org/docs/api/web-contents/#event-context-menu"
+              href="http://electron.atom.io/docs/api/web-contents/#event-context-menu"
               >context-menu event documentation</a
             >
             for all the available properties.

docs/fiddles/menus/customize-menus/main.js

@@ -159,7 +159,7 @@ const template = [
       {
         label: 'Learn More',
         click: () => {
-          shell.openExternal('https://electronjs.org')
+          shell.openExternal('http://electron.atom.io')
         }
       }
     ]
@@ -324,7 +324,7 @@ app.whenReady().then(() => {
 
 // Quit when all windows are closed.
 app.on('window-all-closed', function () {
-  // On macOS it is common for applications and their menu bar
+  // On OS X it is common for applications and their menu bar
   // to stay active until the user quits explicitly with Cmd + Q
   const reopenMenuItem = findReopenMenuItem()
   if (reopenMenuItem) reopenMenuItem.enabled = true
@@ -335,7 +335,7 @@ app.on('window-all-closed', function () {
 })
 
 app.on('activate', function () {
-  // On macOS it is common to re-create a window in the app when the
+  // On OS X 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 (mainWindow === null) {
     createWindow()

docs/fiddles/menus/shortcuts/index.html

@@ -21,10 +21,10 @@
 
 		<p>
 			Open the full documentation for the
-			<a href="https://electronjs.org/docs/api/menu">Menu</a>,
-			<a href="https://electronjs.org/docs/api/accelerator">Accelerator</a>,
+			<a href="http://electron.atom.io/docs/api/menu">Menu</a>,
+			<a href="http://electron.atom.io/docs/api/accelerator">Accelerator</a>,
 			and
-			<a href="https://electronjs.org/docs/api/global-shortcut">globalShortcut</a>
+			<a href="http://electron.atom.io/docs/api/global-shortcut">globalShortcut</a>
 			APIs in your browser.
 		</p>