fix: don't handle browser messages before document element is created (#19718)
* fix: don't handle browser messages before document element is created * fix: bind ElectronApiServiceImpl later DidCreateDocumentElement is called before the ElectronApiServiceImpl gets bound. * chore: add comment
This commit is contained in:
parent
398c5d553d
commit
04dbd5c53f
5 changed files with 90 additions and 35 deletions
|
@ -98,38 +98,61 @@ ElectronApiServiceImpl::~ElectronApiServiceImpl() = default;
|
|||
|
||||
ElectronApiServiceImpl::ElectronApiServiceImpl(
|
||||
content::RenderFrame* render_frame,
|
||||
RendererClientBase* renderer_client,
|
||||
mojom::ElectronRendererAssociatedRequest request)
|
||||
RendererClientBase* renderer_client)
|
||||
: content::RenderFrameObserver(render_frame),
|
||||
binding_(this),
|
||||
render_frame_(render_frame),
|
||||
renderer_client_(renderer_client) {
|
||||
renderer_client_(renderer_client),
|
||||
weak_factory_(this) {}
|
||||
|
||||
void ElectronApiServiceImpl::BindTo(
|
||||
mojom::ElectronRendererAssociatedRequest request) {
|
||||
// Note: BindTo might be called for multiple times.
|
||||
if (binding_.is_bound())
|
||||
binding_.Unbind();
|
||||
|
||||
binding_.Bind(std::move(request));
|
||||
binding_.set_connection_error_handler(base::BindOnce(
|
||||
&ElectronApiServiceImpl::OnDestruct, base::Unretained(this)));
|
||||
binding_.set_connection_error_handler(
|
||||
base::BindOnce(&ElectronApiServiceImpl::OnConnectionError, GetWeakPtr()));
|
||||
}
|
||||
|
||||
// static
|
||||
void ElectronApiServiceImpl::CreateMojoService(
|
||||
content::RenderFrame* render_frame,
|
||||
RendererClientBase* renderer_client,
|
||||
mojom::ElectronRendererAssociatedRequest request) {
|
||||
DCHECK(render_frame);
|
||||
|
||||
// Owns itself. Will be deleted when the render frame is destroyed.
|
||||
new ElectronApiServiceImpl(render_frame, renderer_client, std::move(request));
|
||||
void ElectronApiServiceImpl::DidCreateDocumentElement() {
|
||||
document_created_ = true;
|
||||
}
|
||||
|
||||
void ElectronApiServiceImpl::OnDestruct() {
|
||||
delete this;
|
||||
}
|
||||
|
||||
void ElectronApiServiceImpl::OnConnectionError() {
|
||||
if (binding_.is_bound())
|
||||
binding_.Unbind();
|
||||
}
|
||||
|
||||
void ElectronApiServiceImpl::Message(bool internal,
|
||||
bool send_to_all,
|
||||
const std::string& channel,
|
||||
base::Value arguments,
|
||||
int32_t sender_id) {
|
||||
blink::WebLocalFrame* frame = render_frame_->GetWebFrame();
|
||||
// Don't handle browser messages before document element is created.
|
||||
//
|
||||
// Note: It is probably better to save the message and then replay it after
|
||||
// document is ready, but current behavior has been there since the first
|
||||
// day of Electron, and no one has complained so far.
|
||||
//
|
||||
// Reason 1:
|
||||
// When we receive a message from the browser, we try to transfer it
|
||||
// to a web page, and when we do that Blink creates an empty
|
||||
// document element if it hasn't been created yet, and it makes our init
|
||||
// script to run while `window.location` is still "about:blank".
|
||||
// (See https://github.com/electron/electron/pull/1044.)
|
||||
//
|
||||
// Reason 2:
|
||||
// The libuv message loop integration would be broken for unkown reasons.
|
||||
// (See https://github.com/electron/electron/issues/19368.)
|
||||
if (!document_created_)
|
||||
return;
|
||||
|
||||
blink::WebLocalFrame* frame = render_frame()->GetWebFrame();
|
||||
if (!frame)
|
||||
return;
|
||||
|
||||
|
|
|
@ -7,6 +7,7 @@
|
|||
|
||||
#include <string>
|
||||
|
||||
#include "base/memory/weak_ptr.h"
|
||||
#include "content/public/renderer/render_frame.h"
|
||||
#include "content/public/renderer/render_frame_observer.h"
|
||||
#include "electron/shell/common/api/api.mojom.h"
|
||||
|
@ -19,10 +20,10 @@ class RendererClientBase;
|
|||
class ElectronApiServiceImpl : public mojom::ElectronRenderer,
|
||||
public content::RenderFrameObserver {
|
||||
public:
|
||||
static void CreateMojoService(
|
||||
content::RenderFrame* render_frame,
|
||||
RendererClientBase* renderer_client,
|
||||
mojom::ElectronRendererAssociatedRequest request);
|
||||
ElectronApiServiceImpl(content::RenderFrame* render_frame,
|
||||
RendererClientBase* renderer_client);
|
||||
|
||||
void BindTo(mojom::ElectronRendererAssociatedRequest request);
|
||||
|
||||
void Message(bool internal,
|
||||
bool send_to_all,
|
||||
|
@ -33,19 +34,26 @@ class ElectronApiServiceImpl : public mojom::ElectronRenderer,
|
|||
void TakeHeapSnapshot(mojo::ScopedHandle file,
|
||||
TakeHeapSnapshotCallback callback) override;
|
||||
|
||||
base::WeakPtr<ElectronApiServiceImpl> GetWeakPtr() {
|
||||
return weak_factory_.GetWeakPtr();
|
||||
}
|
||||
|
||||
private:
|
||||
~ElectronApiServiceImpl() override;
|
||||
ElectronApiServiceImpl(content::RenderFrame* render_frame,
|
||||
RendererClientBase* renderer_client,
|
||||
mojom::ElectronRendererAssociatedRequest request);
|
||||
|
||||
// RenderFrameObserver implementation.
|
||||
void DidCreateDocumentElement() override;
|
||||
void OnDestruct() override;
|
||||
|
||||
void OnConnectionError();
|
||||
|
||||
// Whether the DOM document element has been created.
|
||||
bool document_created_ = false;
|
||||
|
||||
mojo::AssociatedBinding<mojom::ElectronRenderer> binding_;
|
||||
|
||||
content::RenderFrame* render_frame_;
|
||||
RendererClientBase* renderer_client_;
|
||||
base::WeakPtrFactory<ElectronApiServiceImpl> weak_factory_;
|
||||
|
||||
DISALLOW_COPY_AND_ASSIGN(ElectronApiServiceImpl);
|
||||
};
|
||||
|
|
|
@ -227,17 +227,12 @@ void RendererClientBase::RenderFrameCreated(
|
|||
std::make_unique<electron::PrintRenderFrameHelperDelegate>());
|
||||
#endif
|
||||
|
||||
// TODO(nornagon): it might be possible for an IPC message sent to this
|
||||
// service to trigger v8 context creation before the page has begun loading.
|
||||
// However, it's unclear whether such a timing is possible to trigger, and we
|
||||
// don't have any test to confirm it. Add a test that confirms that a
|
||||
// main->renderer IPC can't cause the preload script to be executed twice. If
|
||||
// it is possible to trigger the preload script before the document is ready
|
||||
// through this interface, we should delay adding it to the registry until
|
||||
// the document is ready.
|
||||
// Note: ElectronApiServiceImpl has to be created now to capture the
|
||||
// DidCreateDocumentElement event.
|
||||
auto* service = new ElectronApiServiceImpl(render_frame, this);
|
||||
render_frame->GetAssociatedInterfaceRegistry()->AddInterface(
|
||||
base::BindRepeating(&ElectronApiServiceImpl::CreateMojoService,
|
||||
render_frame, this));
|
||||
base::BindRepeating(&ElectronApiServiceImpl::BindTo,
|
||||
service->GetWeakPtr()));
|
||||
|
||||
#if BUILDFLAG(ENABLE_PDF_VIEWER)
|
||||
// Allow access to file scheme from pdf viewer.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue