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

feat: warn when crash key name is longer than 39 bytes (#30742)

Browse source 
Signed-off-by: Darshan Sen <darshan.sen@postman.com>
This commit is contained in:
Darshan Sen 2021-09-07 23:39:48 +05:30 committed by GitHub
parent 55c57808fb
commit 90a3e7f927
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
shell/common/crash_keys.cc
View file

@ -17,7 +17,9 @@
#include "electron/buildflags/buildflags.h" #include "electron/buildflags/buildflags.h"
#include "electron/fuses.h" #include "electron/fuses.h"
#include "shell/common/electron_constants.h" #include "shell/common/electron_constants.h"
#include "shell/common/node_includes.h"
#include "shell/common/options_switches.h" #include "shell/common/options_switches.h"
#include "shell/common/process_util.h"
#include "third_party/crashpad/crashpad/client/annotation.h" #include "third_party/crashpad/crashpad/client/annotation.h"
#include "gin/wrappable.h" #include "gin/wrappable.h"
@ -93,9 +95,17 @@ static_assert(kMaxCrashKeyNameLength <= crashpad::Annotation::kNameMaxLength,
void SetCrashKey(const std::string& key, const std::string& value) { void SetCrashKey(const std::string& key, const std::string& value) {
// Chrome DCHECK()s if we try to set an annotation with a name longer than // Chrome DCHECK()s if we try to set an annotation with a name longer than
// the max. // the max.
// TODO(nornagon): warn the developer (via console.warn) when this happens. if (key.size() >= kMaxCrashKeyNameLength) {
if (key.size() >= kMaxCrashKeyNameLength) node::Environment* env =
node::Environment::GetCurrent(JavascriptEnvironment::GetIsolate());
EmitWarning(env,
"The crash key name, \"" + key + "\", is longer than " +
std::to_string(kMaxCrashKeyNameLength) +
" bytes, ignoring it.",
"electron");
return; return;
}
auto& crash_key_names = GetExtraCrashKeyNames(); auto& crash_key_names = GetExtraCrashKeyNames();
auto iter = std::find(crash_key_names.begin(), crash_key_names.end(), key); auto iter = std::find(crash_key_names.begin(), crash_key_names.end(), key);