mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

refactor: add EmitDeprecationWarning helper (#46879)

Browse source 
* refactor: add EmitDeprecationWarning helper

Also switches EmitWarning to using Node's ProcessEmitWarningGeneric

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>

* chore: use node namespace for function call

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>

---------

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
This commit is contained in:
trop[bot] 2025-05-01 09:44:59 -05:00 • committed by GitHub
commit c24f330b45
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 34 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

5
shell/browser/api/electron_api_web_request.cc
View file

@ -666,10 +666,9 @@ void WebRequest::SetListener(Event event,
}
if (filter_include_patterns.empty()) {
util::EmitWarning(
util::EmitDeprecationWarning(
"The urls array in WebRequestFilter is empty, which is deprecated. "
"Please use '<all_urls>' to match all URLs.",
"DeprecationWarning");
"Please use '<all_urls>' to match all URLs.");
filter_include_patterns.insert("<all_urls>");
}

5
shell/browser/native_window_mac.mm
View file

@ -182,9 +182,8 @@ NativeWindowMac::NativeWindowMac(const gin_helper::Dictionary& options,
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
if (windowType == "textured" && (transparent() || !has_frame())) {
util::EmitWarning(
"The 'textured' window type is deprecated and will be removed",
"DeprecationWarning");
util::EmitDeprecationWarning(
"The 'textured' window type is deprecated and will be removed");
styleMask |= NSWindowStyleMaskTexturedBackground;
}
#pragma clang diagnostic pop

5
shell/common/api/electron_api_native_image.cc
View file

@ -286,9 +286,8 @@ v8::Local<v8::Value> NativeImage::GetBitmap(gin::Arguments* args) {
if (!deprecated_warning_issued) {
deprecated_warning_issued = true;
util::EmitWarning(isolate_,
"getBitmap() is deprecated, use toBitmap() instead.",
"DeprecationWarning");
util::EmitDeprecationWarning(
isolate_, "getBitmap() is deprecated, use toBitmap() instead.");
}
return ToBitmap(args);

26
shell/common/node_util.cc
View file

@ -12,10 +12,10 @@
#include "base/strings/string_number_conversions.h"
#include "base/values.h"
#include "gin/converter.h"
#include "gin/dictionary.h"
#include "shell/browser/javascript_environment.h"
#include "shell/common/gin_converters/callback_converter.h"
#include "shell/common/node_includes.h"
#include "third_party/electron_node/src/node_process-inl.h"
namespace electron::util {
@ -65,14 +65,22 @@ void EmitWarning(const std::string_view warning_msg,
void EmitWarning(v8::Isolate* isolate,
const std::string_view warning_msg,
const std::string_view warning_type) {
v8::HandleScope scope{isolate};
gin::Dictionary process{
isolate, node::Environment::GetCurrent(isolate)->process_object()};
base::RepeatingCallback<void(std::string_view, std::string_view,
std::string_view)>
emit_warning;
process.Get("emitWarning", &emit_warning);
emit_warning.Run(warning_msg, warning_type, "");
node::ProcessEmitWarningGeneric(node::Environment::GetCurrent(isolate),
warning_msg, warning_type);
}
void EmitDeprecationWarning(const std::string_view warning_msg,
const std::string_view deprecation_code) {
EmitDeprecationWarning(JavascriptEnvironment::GetIsolate(), warning_msg,
deprecation_code);
}
void EmitDeprecationWarning(v8::Isolate* isolate,
const std::string_view warning_msg,
const std::string_view deprecation_code) {
node::ProcessEmitWarningGeneric(node::Environment::GetCurrent(isolate),
warning_msg, "DeprecationWarning",
deprecation_code);
}
node::Environment* CreateEnvironment(v8::Isolate* isolate,

12
shell/common/node_util.h
View file

@ -30,9 +30,19 @@ void EmitWarning(v8::Isolate* isolate,
std::string_view warning_type);
// Emit a warning via node's process.emitWarning(),
// using JavscriptEnvironment's isolate
// using JavascriptEnvironment's isolate
void EmitWarning(std::string_view warning_msg, std::string_view warning_type);
// Emit a deprecation warning via node's process.emitWarning()
void EmitDeprecationWarning(v8::Isolate* isolate,
std::string_view warning_msg,
std::string_view deprecation_code = "");
// Emit a deprecation warning via node's process.emitWarning(),
// using JavascriptEnvironment's isolate
void EmitDeprecationWarning(std::string_view warning_msg,
std::string_view deprecation_code = "");
// Run a script with JS source bundled inside the binary as if it's wrapped
// in a function called with a null receiver and arguments specified in C++.
// The returned value is empty if an exception is encountered.