fefb22a83d
* chore: enable microtask queue per window agent * chore: switch policies on context microtask queue * fix: ensure node::Environment is valid
202 lines
7.6 KiB
C++
202 lines
7.6 KiB
C++
// Copyright (c) 2013 GitHub, Inc.
|
|
// Use of this source code is governed by the MIT license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#include "shell/renderer/electron_renderer_client.h"
|
|
|
|
#include <string>
|
|
|
|
#include "base/command_line.h"
|
|
#include "content/public/renderer/render_frame.h"
|
|
#include "electron/buildflags/buildflags.h"
|
|
#include "net/http/http_request_headers.h"
|
|
#include "shell/common/api/electron_bindings.h"
|
|
#include "shell/common/gin_helper/dictionary.h"
|
|
#include "shell/common/gin_helper/event_emitter_caller.h"
|
|
#include "shell/common/node_bindings.h"
|
|
#include "shell/common/node_includes.h"
|
|
#include "shell/common/options_switches.h"
|
|
#include "shell/renderer/electron_render_frame_observer.h"
|
|
#include "shell/renderer/web_worker_observer.h"
|
|
#include "third_party/blink/public/common/web_preferences/web_preferences.h"
|
|
#include "third_party/blink/public/web/web_document.h"
|
|
#include "third_party/blink/public/web/web_local_frame.h"
|
|
#include "third_party/blink/renderer/core/execution_context/execution_context.h" // nogncheck
|
|
|
|
namespace electron {
|
|
|
|
ElectronRendererClient::ElectronRendererClient()
|
|
: node_bindings_(
|
|
NodeBindings::Create(NodeBindings::BrowserEnvironment::kRenderer)),
|
|
electron_bindings_(
|
|
std::make_unique<ElectronBindings>(node_bindings_->uv_loop())) {}
|
|
|
|
ElectronRendererClient::~ElectronRendererClient() = default;
|
|
|
|
void ElectronRendererClient::RenderFrameCreated(
|
|
content::RenderFrame* render_frame) {
|
|
new ElectronRenderFrameObserver(render_frame, this);
|
|
RendererClientBase::RenderFrameCreated(render_frame);
|
|
}
|
|
|
|
void ElectronRendererClient::RunScriptsAtDocumentStart(
|
|
content::RenderFrame* render_frame) {
|
|
RendererClientBase::RunScriptsAtDocumentStart(render_frame);
|
|
// Inform the document start phase.
|
|
v8::HandleScope handle_scope(v8::Isolate::GetCurrent());
|
|
node::Environment* env = GetEnvironment(render_frame);
|
|
if (env)
|
|
gin_helper::EmitEvent(env->isolate(), env->process_object(),
|
|
"document-start");
|
|
}
|
|
|
|
void ElectronRendererClient::RunScriptsAtDocumentEnd(
|
|
content::RenderFrame* render_frame) {
|
|
RendererClientBase::RunScriptsAtDocumentEnd(render_frame);
|
|
// Inform the document end phase.
|
|
v8::HandleScope handle_scope(v8::Isolate::GetCurrent());
|
|
node::Environment* env = GetEnvironment(render_frame);
|
|
if (env)
|
|
gin_helper::EmitEvent(env->isolate(), env->process_object(),
|
|
"document-end");
|
|
}
|
|
|
|
void ElectronRendererClient::DidCreateScriptContext(
|
|
v8::Handle<v8::Context> renderer_context,
|
|
content::RenderFrame* render_frame) {
|
|
// TODO(zcbenz): Do not create Node environment if node integration is not
|
|
// enabled.
|
|
|
|
// Only load Node.js if we are a main frame or a devtools extension
|
|
// unless Node.js support has been explicitly enabled for subframes.
|
|
if (!ShouldLoadPreload(renderer_context, render_frame))
|
|
return;
|
|
|
|
injected_frames_.insert(render_frame);
|
|
|
|
if (!node_integration_initialized_) {
|
|
node_integration_initialized_ = true;
|
|
node_bindings_->Initialize();
|
|
node_bindings_->PrepareEmbedThread();
|
|
}
|
|
|
|
// Setup node tracing controller.
|
|
if (!node::tracing::TraceEventHelper::GetAgent())
|
|
node::tracing::TraceEventHelper::SetAgent(node::CreateAgent());
|
|
|
|
// Setup node environment for each window.
|
|
v8::Maybe<bool> initialized = node::InitializeContext(renderer_context);
|
|
CHECK(!initialized.IsNothing() && initialized.FromJust());
|
|
|
|
node::Environment* env =
|
|
node_bindings_->CreateEnvironment(renderer_context, nullptr);
|
|
|
|
// If we have disabled the site instance overrides we should prevent loading
|
|
// any non-context aware native module.
|
|
env->options()->force_context_aware = true;
|
|
|
|
// We do not want to crash the renderer process on unhandled rejections.
|
|
env->options()->unhandled_rejections = "warn";
|
|
|
|
environments_.insert(env);
|
|
|
|
// Add Electron extended APIs.
|
|
electron_bindings_->BindTo(env->isolate(), env->process_object());
|
|
gin_helper::Dictionary process_dict(env->isolate(), env->process_object());
|
|
BindProcess(env->isolate(), &process_dict, render_frame);
|
|
|
|
// Load everything.
|
|
node_bindings_->LoadEnvironment(env);
|
|
|
|
if (node_bindings_->uv_env() == nullptr) {
|
|
// Make uv loop being wrapped by window context.
|
|
node_bindings_->set_uv_env(env);
|
|
|
|
// Give the node loop a run to make sure everything is ready.
|
|
node_bindings_->StartPolling();
|
|
}
|
|
}
|
|
|
|
void ElectronRendererClient::WillReleaseScriptContext(
|
|
v8::Handle<v8::Context> context,
|
|
content::RenderFrame* render_frame) {
|
|
if (injected_frames_.erase(render_frame) == 0)
|
|
return;
|
|
|
|
node::Environment* env = node::Environment::GetCurrent(context);
|
|
if (environments_.erase(env) == 0)
|
|
return;
|
|
|
|
gin_helper::EmitEvent(env->isolate(), env->process_object(), "exit");
|
|
|
|
// The main frame may be replaced.
|
|
if (env == node_bindings_->uv_env())
|
|
node_bindings_->set_uv_env(nullptr);
|
|
|
|
// Destroying the node environment will also run the uv loop,
|
|
// Node.js expects `kExplicit` microtasks policy and will run microtasks
|
|
// checkpoints after every call into JavaScript. Since we use a different
|
|
// policy in the renderer - switch to `kExplicit` and then drop back to the
|
|
// previous policy value.
|
|
v8::MicrotaskQueue* microtask_queue = context->GetMicrotaskQueue();
|
|
auto old_policy = microtask_queue->microtasks_policy();
|
|
DCHECK_EQ(microtask_queue->GetMicrotasksScopeDepth(), 0);
|
|
microtask_queue->set_microtasks_policy(v8::MicrotasksPolicy::kExplicit);
|
|
|
|
node::FreeEnvironment(env);
|
|
if (node_bindings_->uv_env() == nullptr) {
|
|
node::FreeIsolateData(node_bindings_->isolate_data());
|
|
node_bindings_->set_isolate_data(nullptr);
|
|
}
|
|
|
|
microtask_queue->set_microtasks_policy(old_policy);
|
|
|
|
// ElectronBindings is tracking node environments.
|
|
electron_bindings_->EnvironmentDestroyed(env);
|
|
}
|
|
|
|
void ElectronRendererClient::WorkerScriptReadyForEvaluationOnWorkerThread(
|
|
v8::Local<v8::Context> context) {
|
|
// We do not create a Node.js environment in service or shared workers
|
|
// owing to an inability to customize sandbox policies in these workers
|
|
// given that they're run out-of-process.
|
|
auto* ec = blink::ExecutionContext::From(context);
|
|
if (ec->IsServiceWorkerGlobalScope() || ec->IsSharedWorkerGlobalScope())
|
|
return;
|
|
|
|
// This won't be correct for in-process child windows with webPreferences
|
|
// that have a different value for nodeIntegrationInWorker
|
|
if (base::CommandLine::ForCurrentProcess()->HasSwitch(
|
|
switches::kNodeIntegrationInWorker)) {
|
|
WebWorkerObserver::GetCurrent()->WorkerScriptReadyForEvaluation(context);
|
|
}
|
|
}
|
|
|
|
void ElectronRendererClient::WillDestroyWorkerContextOnWorkerThread(
|
|
v8::Local<v8::Context> context) {
|
|
auto* ec = blink::ExecutionContext::From(context);
|
|
if (ec->IsServiceWorkerGlobalScope() || ec->IsSharedWorkerGlobalScope())
|
|
return;
|
|
|
|
// TODO(loc): Note that this will not be correct for in-process child windows
|
|
// with webPreferences that have a different value for nodeIntegrationInWorker
|
|
if (base::CommandLine::ForCurrentProcess()->HasSwitch(
|
|
switches::kNodeIntegrationInWorker)) {
|
|
WebWorkerObserver::GetCurrent()->ContextWillDestroy(context);
|
|
}
|
|
}
|
|
|
|
node::Environment* ElectronRendererClient::GetEnvironment(
|
|
content::RenderFrame* render_frame) const {
|
|
if (injected_frames_.find(render_frame) == injected_frames_.end())
|
|
return nullptr;
|
|
v8::HandleScope handle_scope(v8::Isolate::GetCurrent());
|
|
auto context =
|
|
GetContext(render_frame->GetWebFrame(), v8::Isolate::GetCurrent());
|
|
node::Environment* env = node::Environment::GetCurrent(context);
|
|
if (environments_.find(env) == environments_.end())
|
|
return nullptr;
|
|
return env;
|
|
}
|
|
|
|
} // namespace electron
|