fix: compensate for title bar height when setting bounds on BrowserView

[codebytere]

Description of Change

Closes #32880.

Fixes an issue where part of the BrowserView could be cut off when calling setBounds on some windows. This was happening because we were not taking the titlebar height into account when calling setBounds on a framed window, which meant that the y-value for the bounds would end up negative. For example, the following snippet:

main.js

const {app, BrowserView, BrowserWindow} = require('electron')
const path = require('path')

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 1200,
    height: 900,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js')
    }
  })
  mainWindow.removeMenu();
  const view = new BrowserView()
  mainWindow.setBrowserView(view)
  view.webContents.loadURL('https:// google.com')
  view.webContents.openDevTools({ mode: "bottom" });
  view.setBounds({
    x : 0,
    y : 100,
    width: 1200,
    height : 800
  });
}

app.whenReady().then(() => {
  createWindow()
  
  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit()
})

Would result in the y value being calculated to -28, which is the height of the titlebar. Fix the problem by correcting for this extra height when relevant.

Visual Comparison:

Before

After

Frameless Window

Comparison

Checklist

• PR description included and stakeholders cc'd
• npm test passes
• PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: Fixed an issue where part of the BrowserView could be cut off when calling setBounds on some windows.

[codebytere]

Failure:

not ok 1331 shell module shell.openExternal() opens an external link
  Error: Timeout of 30000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (C:\actions-runner\_work\electron\electron\src\electron\spec\api-shell-spec.ts)
      at listOnTimeout (node:internal/timers:559:17)
      at processTimers (node:internal/timers:502:7)

is woa-only and not possible affected by this macOS-only change. merging.

[release-clerk]

Release Notes Persisted

Fixed an issue where part of the BrowserView could be cut off when calling setBounds on some windows.

[trop]

I have automatically backported this PR to "18-x-y", please check out #35493

[trop]

I have automatically backported this PR to "19-x-y", please check out #35495

[codebytere]

/trop run backport-to 12-x-y

[trop]

The backport process for this PR has been manually initiated - sending your PR to 12-x-y!

[trop]

I have automatically backported this PR to "12-x-y", please check out #35501

[codebytere]

/trop run backport-to 21-x-y

[trop]

The backport process for this PR has been manually initiated - sending your PR to 21-x-y!

[trop]

I have automatically backported this PR to "21-x-y", please check out #35502

[linonetwo]

So we need to manually add 28 to y when using framed window? And only do this in mac?

[codebytere]

@linonetwo no - you should not need to change your existing calculations, unless you for some reason want your BrowserViews cut off inescapably.

[linonetwo]

Then this is strange, after upgrade from to 18.2.0 to 20.1.1 , I found browserView move up 28px, so I have to minus 28 from y to compensate this:

https://github.com/tiddly-gittly/TidGi-Desktop/blob/22f79c13ed1a498bd8767eecfe571a4e8b5e187d/src/services/libs/getViewBounds.ts#L16-L34

But never mind, I found this workaround works. You can wait for other user's report to check if this is really a bug in electron side, or just my fault that I didn't realized yet.

[soundar-m]

I'm also seeing the same issue.

electron/shell/browser/native_browser_view_mac.mm

Line 276 in c8c8797

auto new_height =

issue might be due to the title bar height being added to the y coordinate

 auto new_height =
      superview_height - bounds.y() - bounds.height() + titlebar_height;
  view.frame =
      NSMakeRect(bounds.x(), new_height, bounds.width(), bounds.height());

instead of reducing it from the view's height

  auto new_height =
      bounds.height() - titlebar_height;
  auto new_y =
      superview_height - bounds.y() - bounds.height();
  view.frame =
      NSMakeRect(bounds.x(), new_y, bounds.width(), new_height);