2014-10-31 18:17:05 +00:00
|
|
|
// Copyright (c) 2013 GitHub, Inc.
|
2014-04-25 09:49:37 +00:00
|
|
|
// Use of this source code is governed by the MIT license that can be
|
2013-04-12 01:46:58 +00:00
|
|
|
// found in the LICENSE file.
|
|
|
|
|
2019-06-19 20:46:59 +00:00
|
|
|
#include "shell/renderer/electron_renderer_client.h"
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2015-05-22 07:01:13 +00:00
|
|
|
#include "base/command_line.h"
|
2023-05-30 08:28:43 +00:00
|
|
|
#include "base/containers/contains.h"
|
2023-07-18 08:41:50 +00:00
|
|
|
#include "base/debug/stack_trace.h"
|
2015-05-22 07:24:34 +00:00
|
|
|
#include "content/public/renderer/render_frame.h"
|
2019-07-31 21:25:41 +00:00
|
|
|
#include "electron/buildflags/buildflags.h"
|
2021-06-14 02:04:36 +00:00
|
|
|
#include "net/http/http_request_headers.h"
|
2019-06-19 20:46:59 +00:00
|
|
|
#include "shell/common/api/electron_bindings.h"
|
2019-09-06 05:52:54 +00:00
|
|
|
#include "shell/common/gin_helper/dictionary.h"
|
|
|
|
#include "shell/common/gin_helper/event_emitter_caller.h"
|
2019-06-19 20:46:59 +00:00
|
|
|
#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"
|
2020-11-10 17:06:03 +00:00
|
|
|
#include "third_party/blink/public/common/web_preferences/web_preferences.h"
|
2018-07-20 16:08:18 +00:00
|
|
|
#include "third_party/blink/public/web/web_document.h"
|
|
|
|
#include "third_party/blink/public/web/web_local_frame.h"
|
2022-10-12 14:36:24 +00:00
|
|
|
#include "third_party/blink/renderer/core/execution_context/execution_context.h" // nogncheck
|
2023-08-31 00:38:07 +00:00
|
|
|
#include "third_party/blink/renderer/core/frame/web_local_frame_impl.h" // nogncheck
|
2016-09-06 08:24:37 +00:00
|
|
|
|
2013-04-12 01:46:58 +00:00
|
|
|
namespace electron {
|
|
|
|
|
2013-04-20 03:13:06 +00:00
|
|
|
ElectronRendererClient::ElectronRendererClient()
|
2023-09-07 23:25:17 +00:00
|
|
|
: node_bindings_{NodeBindings::Create(
|
|
|
|
NodeBindings::BrowserEnvironment::kRenderer)},
|
|
|
|
electron_bindings_{
|
|
|
|
std::make_unique<ElectronBindings>(node_bindings_->uv_loop())} {}
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2021-06-04 01:49:08 +00:00
|
|
|
ElectronRendererClient::~ElectronRendererClient() = default;
|
2013-04-12 01:46:58 +00:00
|
|
|
|
2015-04-28 15:45:58 +00:00
|
|
|
void ElectronRendererClient::RenderFrameCreated(
|
|
|
|
content::RenderFrame* render_frame) {
|
2018-03-09 09:31:09 +00:00
|
|
|
new ElectronRenderFrameObserver(render_frame, this);
|
2017-03-27 21:19:34 +00:00
|
|
|
RendererClientBase::RenderFrameCreated(render_frame);
|
2015-04-28 15:45:58 +00:00
|
|
|
}
|
|
|
|
|
2016-05-30 05:56:31 +00:00
|
|
|
void ElectronRendererClient::RunScriptsAtDocumentStart(
|
|
|
|
content::RenderFrame* render_frame) {
|
2019-07-24 23:01:08 +00:00
|
|
|
RendererClientBase::RunScriptsAtDocumentStart(render_frame);
|
2022-02-21 09:27:45 +00:00
|
|
|
// Inform the document start phase.
|
2018-03-15 06:16:30 +00:00
|
|
|
v8::HandleScope handle_scope(v8::Isolate::GetCurrent());
|
|
|
|
node::Environment* env = GetEnvironment(render_frame);
|
|
|
|
if (env)
|
2019-09-06 05:52:54 +00:00
|
|
|
gin_helper::EmitEvent(env->isolate(), env->process_object(),
|
|
|
|
"document-start");
|
2016-05-27 02:07:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void ElectronRendererClient::RunScriptsAtDocumentEnd(
|
|
|
|
content::RenderFrame* render_frame) {
|
2019-07-24 23:01:08 +00:00
|
|
|
RendererClientBase::RunScriptsAtDocumentEnd(render_frame);
|
2022-02-21 09:27:45 +00:00
|
|
|
// Inform the document end phase.
|
2018-03-15 06:16:30 +00:00
|
|
|
v8::HandleScope handle_scope(v8::Isolate::GetCurrent());
|
|
|
|
node::Environment* env = GetEnvironment(render_frame);
|
|
|
|
if (env)
|
2019-09-06 05:52:54 +00:00
|
|
|
gin_helper::EmitEvent(env->isolate(), env->process_object(),
|
|
|
|
"document-end");
|
2016-05-10 06:43:25 +00:00
|
|
|
}
|
|
|
|
|
2023-08-31 00:38:07 +00:00
|
|
|
void ElectronRendererClient::UndeferLoad(content::RenderFrame* render_frame) {
|
|
|
|
render_frame->GetWebFrame()->GetDocumentLoader()->SetDefersLoading(
|
|
|
|
blink::LoaderFreezeMode::kNone);
|
|
|
|
}
|
|
|
|
|
2015-05-22 07:24:34 +00:00
|
|
|
void ElectronRendererClient::DidCreateScriptContext(
|
2019-07-16 01:58:39 +00:00
|
|
|
v8::Handle<v8::Context> renderer_context,
|
2018-04-18 01:55:30 +00:00
|
|
|
content::RenderFrame* render_frame) {
|
2018-10-25 06:31:07 +00:00
|
|
|
// TODO(zcbenz): Do not create Node environment if node integration is not
|
|
|
|
// enabled.
|
2019-01-22 19:24:46 +00:00
|
|
|
|
2021-05-14 11:36:15 +00:00
|
|
|
// Only load Node.js if we are a main frame or a devtools extension
|
|
|
|
// unless Node.js support has been explicitly enabled for subframes.
|
2022-06-13 06:58:27 +00:00
|
|
|
if (!ShouldLoadPreload(renderer_context, render_frame))
|
2018-10-16 09:10:03 +00:00
|
|
|
return;
|
|
|
|
|
2018-03-15 06:16:30 +00:00
|
|
|
injected_frames_.insert(render_frame);
|
|
|
|
|
2017-03-02 08:18:00 +00:00
|
|
|
if (!node_integration_initialized_) {
|
|
|
|
node_integration_initialized_ = true;
|
2023-02-22 09:03:46 +00:00
|
|
|
node_bindings_->Initialize(renderer_context);
|
2022-03-30 03:09:42 +00:00
|
|
|
node_bindings_->PrepareEmbedThread();
|
2016-03-27 09:09:21 +00:00
|
|
|
}
|
2013-12-23 14:08:45 +00:00
|
|
|
|
2018-01-06 15:58:24 +00:00
|
|
|
// Setup node tracing controller.
|
2018-10-26 05:22:41 +00:00
|
|
|
if (!node::tracing::TraceEventHelper::GetAgent())
|
2018-10-26 04:37:50 +00:00
|
|
|
node::tracing::TraceEventHelper::SetAgent(node::CreateAgent());
|
2018-01-06 15:58:24 +00:00
|
|
|
|
2013-12-23 14:08:45 +00:00
|
|
|
// Setup node environment for each window.
|
2022-11-10 21:31:20 +00:00
|
|
|
v8::Maybe<bool> initialized = node::InitializeContext(renderer_context);
|
|
|
|
CHECK(!initialized.IsNothing() && initialized.FromJust());
|
2019-10-29 20:35:38 +00:00
|
|
|
|
2023-08-31 00:38:07 +00:00
|
|
|
// Before we load the node environment, let's tell blink to hold off on
|
|
|
|
// loading the body of this frame. We will undefer the load once the preload
|
|
|
|
// script has finished. This allows our preload script to run async (E.g.
|
|
|
|
// with ESM) without the preload being in a race
|
|
|
|
render_frame->GetWebFrame()->GetDocumentLoader()->SetDefersLoading(
|
|
|
|
blink::LoaderFreezeMode::kStrict);
|
|
|
|
|
|
|
|
std::shared_ptr<node::Environment> env = node_bindings_->CreateEnvironment(
|
|
|
|
renderer_context, nullptr,
|
|
|
|
base::BindRepeating(&ElectronRendererClient::UndeferLoad,
|
|
|
|
base::Unretained(this), render_frame));
|
2019-10-14 22:46:10 +00:00
|
|
|
|
2019-05-31 22:47:18 +00:00
|
|
|
// If we have disabled the site instance overrides we should prevent loading
|
2021-06-30 14:07:28 +00:00
|
|
|
// any non-context aware native module.
|
|
|
|
env->options()->force_context_aware = true;
|
2019-05-31 22:47:18 +00:00
|
|
|
|
2021-06-17 06:50:56 +00:00
|
|
|
// We do not want to crash the renderer process on unhandled rejections.
|
2023-03-06 10:04:43 +00:00
|
|
|
env->options()->unhandled_rejections = "warn-with-error-code";
|
2021-06-17 06:50:56 +00:00
|
|
|
|
2018-03-15 06:16:30 +00:00
|
|
|
environments_.insert(env);
|
2013-12-23 14:08:45 +00:00
|
|
|
|
2016-09-16 22:57:07 +00:00
|
|
|
// Add Electron extended APIs.
|
2019-03-18 19:37:06 +00:00
|
|
|
electron_bindings_->BindTo(env->isolate(), env->process_object());
|
2019-09-06 05:52:54 +00:00
|
|
|
gin_helper::Dictionary process_dict(env->isolate(), env->process_object());
|
2021-03-17 18:23:29 +00:00
|
|
|
BindProcess(env->isolate(), &process_dict, render_frame);
|
2014-01-09 13:35:29 +00:00
|
|
|
|
2016-03-27 10:21:12 +00:00
|
|
|
// Load everything.
|
2023-08-23 13:56:16 +00:00
|
|
|
node_bindings_->LoadEnvironment(env.get());
|
2016-03-27 10:21:12 +00:00
|
|
|
|
2017-03-02 08:18:00 +00:00
|
|
|
if (node_bindings_->uv_env() == nullptr) {
|
2016-03-27 09:09:21 +00:00
|
|
|
// Make uv loop being wrapped by window context.
|
2023-08-23 13:56:16 +00:00
|
|
|
node_bindings_->set_uv_env(env.get());
|
2015-01-22 00:40:19 +00:00
|
|
|
|
2016-03-27 09:09:21 +00:00
|
|
|
// Give the node loop a run to make sure everything is ready.
|
2022-03-30 03:09:42 +00:00
|
|
|
node_bindings_->StartPolling();
|
2016-03-27 09:09:21 +00:00
|
|
|
}
|
2015-01-21 23:35:43 +00:00
|
|
|
}
|
|
|
|
|
2016-02-02 15:38:49 +00:00
|
|
|
void ElectronRendererClient::WillReleaseScriptContext(
|
2018-04-18 01:55:30 +00:00
|
|
|
v8::Handle<v8::Context> context,
|
|
|
|
content::RenderFrame* render_frame) {
|
2019-08-28 14:39:21 +00:00
|
|
|
if (injected_frames_.erase(render_frame) == 0)
|
2018-05-02 00:00:46 +00:00
|
|
|
return;
|
2016-06-20 07:51:42 +00:00
|
|
|
|
2016-05-28 03:07:08 +00:00
|
|
|
node::Environment* env = node::Environment::GetCurrent(context);
|
2023-08-23 13:56:16 +00:00
|
|
|
const auto iter = base::ranges::find_if(
|
|
|
|
environments_, [env](auto& item) { return env == item.get(); });
|
|
|
|
if (iter == environments_.end())
|
2018-03-15 06:16:30 +00:00
|
|
|
return;
|
|
|
|
|
2019-09-06 05:52:54 +00:00
|
|
|
gin_helper::EmitEvent(env->isolate(), env->process_object(), "exit");
|
2017-03-02 07:49:39 +00:00
|
|
|
|
2017-03-02 08:18:00 +00:00
|
|
|
// The main frame may be replaced.
|
|
|
|
if (env == node_bindings_->uv_env())
|
|
|
|
node_bindings_->set_uv_env(nullptr);
|
|
|
|
|
2022-03-16 17:54:45 +00:00
|
|
|
// 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.
|
2023-01-11 16:59:32 +00:00
|
|
|
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);
|
2022-03-16 17:54:45 +00:00
|
|
|
|
2023-08-23 13:56:16 +00:00
|
|
|
environments_.erase(iter);
|
2017-07-24 05:56:56 +00:00
|
|
|
|
2023-01-11 16:59:32 +00:00
|
|
|
microtask_queue->set_microtasks_policy(old_policy);
|
2022-03-16 17:54:45 +00:00
|
|
|
|
2019-03-18 19:37:06 +00:00
|
|
|
// ElectronBindings is tracking node environments.
|
|
|
|
electron_bindings_->EnvironmentDestroyed(env);
|
2016-02-02 15:38:49 +00:00
|
|
|
}
|
|
|
|
|
2020-07-28 01:48:37 +00:00
|
|
|
void ElectronRendererClient::WorkerScriptReadyForEvaluationOnWorkerThread(
|
2017-03-07 10:35:03 +00:00
|
|
|
v8::Local<v8::Context> context) {
|
2022-10-12 14:36:24 +00:00
|
|
|
// 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.
|
2023-07-18 08:41:50 +00:00
|
|
|
// Also avoid creating a Node.js environment for worklet global scope
|
|
|
|
// created on the main thread.
|
2022-10-12 14:36:24 +00:00
|
|
|
auto* ec = blink::ExecutionContext::From(context);
|
2023-07-18 08:41:50 +00:00
|
|
|
if (ec->IsServiceWorkerGlobalScope() || ec->IsSharedWorkerGlobalScope() ||
|
|
|
|
ec->IsMainThreadWorkletGlobalScope())
|
2022-10-12 14:36:24 +00:00
|
|
|
return;
|
|
|
|
|
|
|
|
// This won't be correct for in-process child windows with webPreferences
|
|
|
|
// that have a different value for nodeIntegrationInWorker
|
2017-03-15 09:51:21 +00:00
|
|
|
if (base::CommandLine::ForCurrentProcess()->HasSwitch(
|
|
|
|
switches::kNodeIntegrationInWorker)) {
|
2023-07-18 08:41:50 +00:00
|
|
|
auto* current = WebWorkerObserver::GetCurrent();
|
|
|
|
if (current)
|
|
|
|
return;
|
2023-01-31 11:29:29 +00:00
|
|
|
WebWorkerObserver::Create()->WorkerScriptReadyForEvaluation(context);
|
2017-03-15 09:51:21 +00:00
|
|
|
}
|
2017-03-07 10:35:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void ElectronRendererClient::WillDestroyWorkerContextOnWorkerThread(
|
|
|
|
v8::Local<v8::Context> context) {
|
2022-10-12 14:36:24 +00:00
|
|
|
auto* ec = blink::ExecutionContext::From(context);
|
2023-07-18 08:41:50 +00:00
|
|
|
if (ec->IsServiceWorkerGlobalScope() || ec->IsSharedWorkerGlobalScope() ||
|
|
|
|
ec->IsMainThreadWorkletGlobalScope())
|
2022-10-12 14:36:24 +00:00
|
|
|
return;
|
|
|
|
|
2020-11-10 17:06:03 +00:00
|
|
|
// TODO(loc): Note that this will not be correct for in-process child windows
|
|
|
|
// with webPreferences that have a different value for nodeIntegrationInWorker
|
2017-03-15 09:51:21 +00:00
|
|
|
if (base::CommandLine::ForCurrentProcess()->HasSwitch(
|
|
|
|
switches::kNodeIntegrationInWorker)) {
|
2023-01-31 11:29:29 +00:00
|
|
|
auto* current = WebWorkerObserver::GetCurrent();
|
|
|
|
if (current)
|
|
|
|
current->ContextWillDestroy(context);
|
2017-03-15 09:51:21 +00:00
|
|
|
}
|
2017-03-07 10:35:03 +00:00
|
|
|
}
|
|
|
|
|
2018-03-15 06:16:30 +00:00
|
|
|
node::Environment* ElectronRendererClient::GetEnvironment(
|
|
|
|
content::RenderFrame* render_frame) const {
|
2023-05-30 08:28:43 +00:00
|
|
|
if (!base::Contains(injected_frames_, render_frame))
|
2018-03-15 06:16:30 +00:00
|
|
|
return nullptr;
|
|
|
|
v8::HandleScope handle_scope(v8::Isolate::GetCurrent());
|
2018-05-05 06:39:54 +00:00
|
|
|
auto context =
|
|
|
|
GetContext(render_frame->GetWebFrame(), v8::Isolate::GetCurrent());
|
|
|
|
node::Environment* env = node::Environment::GetCurrent(context);
|
2023-08-23 13:56:16 +00:00
|
|
|
|
|
|
|
return base::Contains(environments_, env,
|
|
|
|
[](auto const& item) { return item.get(); })
|
|
|
|
? env
|
|
|
|
: nullptr;
|
2018-03-15 06:16:30 +00:00
|
|
|
}
|
2017-03-31 13:01:33 +00:00
|
|
|
|
2013-04-12 01:46:58 +00:00
|
|
|
} // namespace electron
|