fix: draggable regions exclusively on BrowserViews (#26261)

filenames.gni

@@ -178,6 +178,7 @@ filenames = {
     "shell/browser/electron_speech_recognition_manager_delegate.h",
     "shell/browser/electron_web_ui_controller_factory.cc",
     "shell/browser/electron_web_ui_controller_factory.h",
+    "shell/browser/extended_web_contents_observer.h",
     "shell/browser/feature_list.cc",
     "shell/browser/feature_list.h",
     "shell/browser/font_defaults.cc",
@@ -338,6 +339,7 @@ filenames = {
     "shell/browser/ui/devtools_manager_delegate.h",
     "shell/browser/ui/devtools_ui.cc",
     "shell/browser/ui/devtools_ui.h",
+    "shell/browser/ui/drag_util.cc",
     "shell/browser/ui/drag_util.h",
     "shell/browser/ui/drag_util_mac.mm",
     "shell/browser/ui/drag_util_views.cc",

shell/browser/api/electron_api_browser_view.cc

@@ -4,9 +4,12 @@
 
 #include "shell/browser/api/electron_api_browser_view.h"
 
+#include <vector>
+
 #include "shell/browser/api/electron_api_web_contents.h"
 #include "shell/browser/browser.h"
 #include "shell/browser/native_browser_view.h"
+#include "shell/browser/ui/drag_util.h"
 #include "shell/common/color_util.h"
 #include "shell/common/gin_converters/gfx_converter.h"
 #include "shell/common/gin_helper/dictionary.h"
@@ -68,6 +71,7 @@ BrowserView::BrowserView(gin::Arguments* args,
 
   web_contents_.Reset(isolate, web_contents.ToV8());
   api_web_contents_ = web_contents.get();
+  api_web_contents_->AddObserver(this);
   Observe(web_contents->web_contents());
 
   view_.reset(
@@ -80,6 +84,7 @@ BrowserView::~BrowserView() {
   if (api_web_contents_) {  // destroy() is called
     // Destroy WebContents asynchronously unless app is shutting down,
     // because destroy() might be called inside WebContents's event handler.
+    api_web_contents_->RemoveObserver(this);
     api_web_contents_->DestroyWebContents(!Browser::Get()->is_shutting_down());
   }
 }
@@ -89,6 +94,11 @@ void BrowserView::WebContentsDestroyed() {
   web_contents_.Reset();
 }
 
+void BrowserView::OnDraggableRegionsUpdated(
+    const std::vector<mojom::DraggableRegionPtr>& regions) {
+  view_->UpdateDraggableRegions(regions);
+}
+
 // static
 gin_helper::WrappableBase* BrowserView::New(gin_helper::ErrorThrower thrower,
                                             gin::Arguments* args) {

shell/browser/api/electron_api_browser_view.h

@@ -7,10 +7,13 @@
 
 #include <memory>
 #include <string>
+#include <vector>
 
 #include "content/public/browser/web_contents_observer.h"
 #include "gin/handle.h"
+#include "shell/browser/extended_web_contents_observer.h"
 #include "shell/browser/native_browser_view.h"
+#include "shell/common/api/api.mojom.h"
 #include "shell/common/gin_helper/error_thrower.h"
 #include "shell/common/gin_helper/trackable_object.h"
 
@@ -31,7 +34,8 @@ namespace api {
 class WebContents;
 
 class BrowserView : public gin_helper::TrackableObject<BrowserView>,
-                    public content::WebContentsObserver {
+                    public content::WebContentsObserver,
+                    public ExtendedWebContentsObserver {
  public:
   static gin_helper::WrappableBase* New(gin_helper::ErrorThrower thrower,
                                         gin::Arguments* args);
@@ -51,6 +55,10 @@ class BrowserView : public gin_helper::TrackableObject<BrowserView>,
   // content::WebContentsObserver:
   void WebContentsDestroyed() override;
 
+  // ExtendedWebContentsObserver:
+  void OnDraggableRegionsUpdated(
+      const std::vector<mojom::DraggableRegionPtr>& regions) override;
+
  private:
   void SetAutoResize(AutoResizeFlags flags);
   void SetBounds(const gfx::Rect& bounds);

shell/browser/api/electron_api_browser_window.cc

@@ -411,19 +411,6 @@ v8::Local<v8::Value> BrowserWindow::GetWebContents(v8::Isolate* isolate) {
   return v8::Local<v8::Value>::New(isolate, web_contents_);
 }
 
-// Convert draggable regions in raw format to SkRegion format.
-std::unique_ptr<SkRegion> BrowserWindow::DraggableRegionsToSkRegion(
-    const std::vector<mojom::DraggableRegionPtr>& regions) {
-  auto sk_region = std::make_unique<SkRegion>();
-  for (const auto& region : regions) {
-    sk_region->op(
-        {region->bounds.x(), region->bounds.y(), region->bounds.right(),
-         region->bounds.bottom()},
-        region->draggable ? SkRegion::kUnion_Op : SkRegion::kDifference_Op);
-  }
-  return sk_region;
-}
-
 void BrowserWindow::ScheduleUnresponsiveEvent(int ms) {
   if (!window_unresponsive_closure_.IsCancelled())
     return;

shell/browser/api/electron_api_browser_window.h

@@ -12,6 +12,7 @@
 #include "base/cancelable_callback.h"
 #include "shell/browser/api/electron_api_top_level_window.h"
 #include "shell/browser/api/electron_api_web_contents.h"
+#include "shell/browser/ui/drag_util.h"
 #include "shell/common/gin_helper/error_thrower.h"
 
 namespace electron {
@@ -99,10 +100,6 @@ class BrowserWindow : public TopLevelWindow,
   void UpdateDraggableRegions(
       const std::vector<mojom::DraggableRegionPtr>& regions);
 
-  // Convert draggable regions in raw format to SkRegion format.
-  std::unique_ptr<SkRegion> DraggableRegionsToSkRegion(
-      const std::vector<mojom::DraggableRegionPtr>& regions);
-
   // Schedule a notification unresponsive event.
   void ScheduleUnresponsiveEvent(int ms);
 

shell/browser/api/electron_api_browser_window_mac.mm

@@ -37,26 +37,6 @@ namespace electron {
 
 namespace api {
 
-namespace {
-
-// Return a vector of non-draggable regions that fill a window of size
-// |width| by |height|, but leave gaps where the window should be draggable.
-std::vector<gfx::Rect> CalculateNonDraggableRegions(
-    std::unique_ptr<SkRegion> draggable,
-    int width,
-    int height) {
-  std::vector<gfx::Rect> result;
-  SkRegion non_draggable;
-  non_draggable.op({0, 0, width, height}, SkRegion::kUnion_Op);
-  non_draggable.op(*draggable, SkRegion::kDifference_Op);
-  for (SkRegion::Iterator it(non_draggable); !it.done(); it.next()) {
-    result.push_back(gfx::SkIRectToRect(it.rect()));
-  }
-  return result;
-}
-
-}  // namespace
-
 void BrowserWindow::OverrideNSWindowContentView(InspectableWebContents* iwc) {
   // Make NativeWindow use a NSView as content view.
   static_cast<NativeWindowMac*>(window())->OverrideNSWindowContentView();
@@ -109,6 +89,12 @@ void BrowserWindow::UpdateDraggableRegions(
     for (const auto& r : regions)
       draggable_regions_.push_back(r.Clone());
   }
+
+  auto browser_views = window_->browser_views();
+  for (NativeBrowserView* view : browser_views) {
+    view->UpdateDraggableRegions(draggable_regions_);
+  }
+
   std::vector<gfx::Rect> drag_exclude_rects;
   if (regions.empty()) {
     drag_exclude_rects.push_back(gfx::Rect(0, 0, webViewWidth, webViewHeight));
@@ -117,11 +103,6 @@ void BrowserWindow::UpdateDraggableRegions(
         DraggableRegionsToSkRegion(regions), webViewWidth, webViewHeight);
   }
 
-  auto browser_views = window_->browser_views();
-  for (NativeBrowserView* view : browser_views) {
-    view->UpdateDraggableRegions(drag_exclude_rects);
-  }
-
   // Create and add a ControlRegionView for each region that needs to be
   // excluded from the dragging.
   for (const auto& rect : drag_exclude_rects) {

shell/browser/api/electron_api_browser_window_views.cc

@@ -15,7 +15,7 @@ void BrowserWindow::UpdateDraggableRegions(
   if (window_->has_frame())
     return;
   static_cast<NativeWindowViews*>(window_.get())
-      ->UpdateDraggableRegions(DraggableRegionsToSkRegion(regions));
+      ->UpdateDraggableRegions(regions);
 }
 
 }  // namespace api

shell/browser/api/electron_api_web_contents.h

@@ -27,6 +27,7 @@
 #include "shell/browser/api/frame_subscriber.h"
 #include "shell/browser/api/save_page_handler.h"
 #include "shell/browser/common_web_contents_delegate.h"
+#include "shell/browser/extended_web_contents_observer.h"
 #include "shell/common/gin_helper/trackable_object.h"
 #include "third_party/blink/public/mojom/favicon/favicon_url.mojom.h"
 #include "ui/gfx/image/image.h"
@@ -113,19 +114,6 @@ class OffScreenRenderWidgetHostView;
 
 namespace api {
 
-// Certain events are only in WebContentsDelegate, provide our own Observer to
-// dispatch those events.
-class ExtendedWebContentsObserver : public base::CheckedObserver {
- public:
-  virtual void OnCloseContents() {}
-  virtual void OnRendererResponsive() {}
-  virtual void OnDraggableRegionsUpdated(
-      const std::vector<mojom::DraggableRegionPtr>& regions) {}
-
- protected:
-  ~ExtendedWebContentsObserver() override {}
-};
-
 // Wrapper around the content::WebContents.
 class WebContents : public gin_helper::TrackableObject<WebContents>,
                     public CommonWebContentsDelegate,

shell/browser/extended_web_contents_observer.h

@@ -0,0 +1,30 @@
+// Copyright (c) 2020 Microsoft, Inc.
+// Use of this source code is governed by the MIT license that can be
+// found in the LICENSE file.
+
+#ifndef SHELL_BROWSER_EXTENDED_WEB_CONTENTS_OBSERVER_H_
+#define SHELL_BROWSER_EXTENDED_WEB_CONTENTS_OBSERVER_H_
+
+#include <vector>
+
+#include "base/observer_list.h"
+#include "electron/shell/common/api/api.mojom.h"
+
+namespace electron {
+
+// Certain events are only in WebContentsDelegate, so we provide our own
+// Observer to dispatch those events.
+class ExtendedWebContentsObserver : public base::CheckedObserver {
+ public:
+  virtual void OnCloseContents() {}
+  virtual void OnRendererResponsive() {}
+  virtual void OnDraggableRegionsUpdated(
+      const std::vector<mojom::DraggableRegionPtr>& regions) {}
+
+ protected:
+  ~ExtendedWebContentsObserver() override {}
+};
+
+}  // namespace electron
+
+#endif  // SHELL_BROWSER_EXTENDED_WEB_CONTENTS_OBSERVER_H_

shell/browser/native_browser_view.h

@@ -10,6 +10,7 @@
 #include "base/macros.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_observer.h"
+#include "shell/common/api/api.mojom.h"
 #include "third_party/skia/include/core/SkColor.h"
 
 namespace gfx {
@@ -49,7 +50,7 @@ class NativeBrowserView : public content::WebContentsObserver {
 
   // Called when the window needs to update its draggable region.
   virtual void UpdateDraggableRegions(
-      const std::vector<gfx::Rect>& system_drag_exclude_areas) {}
+      const std::vector<mojom::DraggableRegionPtr>& regions) {}
 
  protected:
   explicit NativeBrowserView(InspectableWebContents* inspectable_web_contents);

shell/browser/native_browser_view_mac.h

@@ -25,7 +25,7 @@ class NativeBrowserViewMac : public NativeBrowserView {
   void SetBackgroundColor(SkColor color) override;
 
   void UpdateDraggableRegions(
-      const std::vector<gfx::Rect>& system_drag_exclude_areas) override;
+      const std::vector<mojom::DraggableRegionPtr>& regions) override;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(NativeBrowserViewMac);

shell/browser/native_browser_view_mac.mm

@@ -6,6 +6,7 @@
 
 #include <vector>
 
+#include "shell/browser/ui/drag_util.h"
 #include "shell/browser/ui/inspectable_web_contents.h"
 #include "shell/browser/ui/inspectable_web_contents_view.h"
 #include "skia/ext/skia_utils_mac.h"
@@ -35,8 +36,8 @@ const NSAutoresizingMaskOptions kDefaultAutoResizingMask =
 
 - (NSView*)hitTest:(NSPoint)aPoint {
   // Pass-through events that don't hit one of the exclusion zones
-  for (NSView* exlusion_zones in [self subviews]) {
-    if ([exlusion_zones hitTest:aPoint])
+  for (NSView* exclusion_zones in [self subviews]) {
+    if ([exclusion_zones hitTest:aPoint])
       return nil;
   }
 
@@ -230,16 +231,23 @@ void NativeBrowserViewMac::SetBackgroundColor(SkColor color) {
 }
 
 void NativeBrowserViewMac::UpdateDraggableRegions(
-    const std::vector<gfx::Rect>& drag_exclude_rects) {
+    const std::vector<mojom::DraggableRegionPtr>& regions) {
+  if (!inspectable_web_contents_)
+    return;
+  auto* web_contents = inspectable_web_contents_->GetWebContents();
   auto* iwc_view = GetInspectableWebContentsView();
-  auto* web_contents = GetWebContents();
-  if (!(iwc_view && web_contents))
+  if (!iwc_view || !web_contents)
     return;
   NSView* web_view = GetWebContents()->GetNativeView().GetNativeNSView();
   NSView* inspectable_view = iwc_view->GetNativeView().GetNativeNSView();
   NSView* window_content_view = inspectable_view.superview;
   const auto window_content_view_height = NSHeight(window_content_view.bounds);
 
+  NSInteger webViewWidth = NSWidth([web_view bounds]);
+  NSInteger webViewHeight = NSHeight([web_view bounds]);
+  auto drag_exclude_rects = CalculateNonDraggableRegions(
+      DraggableRegionsToSkRegion(regions), webViewWidth, webViewHeight);
+
   // Remove all DragRegionViews that were added last time. Note that we need
   // to copy the `subviews` array to avoid mutation during iteration.
   base::scoped_nsobject<NSArray> subviews([[web_view subviews] copy]);

shell/browser/native_window_views.cc

@@ -20,6 +20,7 @@
 #include "content/public/browser/desktop_media_id.h"
 #include "shell/browser/api/electron_api_web_contents.h"
 #include "shell/browser/native_browser_view_views.h"
+#include "shell/browser/ui/drag_util.h"
 #include "shell/browser/ui/inspectable_web_contents.h"
 #include "shell/browser/ui/inspectable_web_contents_view.h"
 #include "shell/browser/ui/views/root_view.h"
@@ -1274,8 +1275,8 @@ gfx::Rect NativeWindowViews::WindowBoundsToContentBounds(
 }
 
 void NativeWindowViews::UpdateDraggableRegions(
-    std::unique_ptr<SkRegion> region) {
-  draggable_region_ = std::move(region);
+    const std::vector<mojom::DraggableRegionPtr>& regions) {
+  draggable_region_ = DraggableRegionsToSkRegion(regions);
 }
 
 #if defined(OS_WIN)

shell/browser/native_window_views.h

@@ -11,7 +11,9 @@
 #include <set>
 #include <string>
 #include <tuple>
+#include <vector>
 
+#include "shell/common/api/api.mojom.h"
 #include "ui/views/widget/widget_observer.h"
 
 #if defined(OS_WIN)
@@ -137,7 +139,8 @@ class NativeWindowViews : public NativeWindow,
   gfx::Rect ContentBoundsToWindowBounds(const gfx::Rect& bounds) const override;
   gfx::Rect WindowBoundsToContentBounds(const gfx::Rect& bounds) const override;
 
-  void UpdateDraggableRegions(std::unique_ptr<SkRegion> region);
+  void UpdateDraggableRegions(
+      const std::vector<mojom::DraggableRegionPtr>& regions);
 
   void IncrementChildModals();
   void DecrementChildModals();

shell/browser/ui/drag_util.cc

@@ -0,0 +1,42 @@
+// Copyright (c) 2020 Microsoft, Inc.
+// Use of this source code is governed by the MIT license that can be
+// found in the LICENSE file.
+
+#include "shell/browser/ui/drag_util.h"
+
+#include <memory>
+
+#include "ui/gfx/skia_util.h"
+
+namespace electron {
+
+// Return a vector of non-draggable regions that fill a window of size
+// |width| by |height|, but leave gaps where the window should be draggable.
+std::vector<gfx::Rect> CalculateNonDraggableRegions(
+    std::unique_ptr<SkRegion> draggable,
+    int width,
+    int height) {
+  std::vector<gfx::Rect> result;
+  SkRegion non_draggable;
+  non_draggable.op({0, 0, width, height}, SkRegion::kUnion_Op);
+  non_draggable.op(*draggable, SkRegion::kDifference_Op);
+  for (SkRegion::Iterator it(non_draggable); !it.done(); it.next()) {
+    result.push_back(gfx::SkIRectToRect(it.rect()));
+  }
+  return result;
+}
+
+// Convert draggable regions in raw format to SkRegion format.
+std::unique_ptr<SkRegion> DraggableRegionsToSkRegion(
+    const std::vector<mojom::DraggableRegionPtr>& regions) {
+  auto sk_region = std::make_unique<SkRegion>();
+  for (const auto& region : regions) {
+    sk_region->op(
+        {region->bounds.x(), region->bounds.y(), region->bounds.right(),
+         region->bounds.bottom()},
+        region->draggable ? SkRegion::kUnion_Op : SkRegion::kDifference_Op);
+  }
+  return sk_region;
+}
+
+}  // namespace electron

shell/browser/ui/drag_util.h

@@ -5,8 +5,12 @@
 #ifndef SHELL_BROWSER_UI_DRAG_UTIL_H_
 #define SHELL_BROWSER_UI_DRAG_UTIL_H_
 
+#include <memory>
 #include <vector>
 
+#include "shell/common/api/api.mojom.h"
+#include "third_party/skia/include/core/SkRegion.h"
+#include "ui/gfx/geometry/rect.h"
 #include "ui/gfx/image/image.h"
 
 namespace base {
@@ -19,6 +23,15 @@ void DragFileItems(const std::vector<base::FilePath>& files,
                    const gfx::Image& icon,
                    gfx::NativeView view);
 
+std::vector<gfx::Rect> CalculateNonDraggableRegions(
+    std::unique_ptr<SkRegion> draggable,
+    int width,
+    int height);
+
+// Convert draggable regions in raw format to SkRegion format.
+std::unique_ptr<SkRegion> DraggableRegionsToSkRegion(
+    const std::vector<mojom::DraggableRegionPtr>& regions);
+
 }  // namespace electron
 
 #endif  // SHELL_BROWSER_UI_DRAG_UTIL_H_