src: remove calls to deprecated v8 functions (NewFromUtf8) #21926

ryzokuken · 2018-07-21T16:59:02Z

Remove all calls to deprecated v8 functions (here: String::NewFromUtf8) inside
the code (src directory only).

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Files

nodejs-github-bot · 2018-07-21T16:59:03Z

@ryzokuken build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/329/pipeline

ryzokuken · 2018-07-21T17:00:30Z

/cc @hashseed

Remove all calls to deprecated v8 functions (here: String::NewFromUtf8) inside the code (src directory only).

TimothyGu · 2018-07-21T18:17:33Z

src/exceptions.cc

@@ -67,14 +68,15 @@ Local<Value> ErrnoException(Isolate* isolate,
 static Local<String> StringFromPath(Isolate* isolate, const char* path) {
 #ifdef _WIN32
  if (strncmp(path, "\\\\?\\UNC\\", 8) == 0) {
+    v8::NewStringType type = v8::NewStringType::kNormal;


Doesn’t look like this is in the right place. There are two more instances of NewFromUtf8 below.

Ooh, this one was unfinished. Thanks, will change this.

I think this is unused now? Either way, I think it makes sense to keep these inline in the code (i.e. not create separate variables)

Okay, will make appropriate changes.

addaleax · 2018-07-21T18:58:13Z

src/exceptions.cc

@@ -179,11 +182,13 @@ Local<Value> WinapiErrnoException(Isolate* isolate,
  }
  Local<String> message = OneByteString(env->isolate(), msg);

+  v8::NewStringType type = v8::NewStringType::kNormal;


If you do decide to create new variables for these, can you name the more expressively (e.g. new_string_type or maybe string_type)?

addaleax

Looks good :)

addaleax · 2018-07-21T20:31:09Z

src/node.h

@@ -374,7 +377,8 @@ inline void NODE_SET_PROTOTYPE_METHOD(v8::Local<v8::FunctionTemplate> recv,
  v8::Local<v8::Signature> s = v8::Signature::New(isolate, recv);
  v8::Local<v8::FunctionTemplate> t =
      v8::FunctionTemplate::New(isolate, callback, v8::Local<v8::Value>(), s);
-  v8::Local<v8::String> fn_name = v8::String::NewFromUtf8(isolate, name);
+  v8::Local<v8::String> fn_name = v8::String::NewFromUtf8(isolate, name,
+      v8::NewStringType::kNormal).ToLocalChecked();


I think for everything in this header, kInternalized would make more sense as the string type.

addaleax · 2018-07-21T20:32:59Z

src/node.cc

  } else {
-    exec_path_value = String::NewFromUtf8(env->isolate(), argv[0]);
+    exec_path_value = String::NewFromUtf8(env->isolate(), argv[0],
+        v8::NewStringType::kNormal).ToLocalChecked();
  }
  process->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "execPath"),
               exec_path_value);


Since we expect process.execPath to be long-lived, using internalized strings might make more sense. (It probably doesn’t matter all that much in individual cases like these, but the sum of the work we’re saving the GC might matter a bit.)

addaleax · 2018-07-21T20:41:39Z

src/node_os.cc

@@ -261,7 +261,8 @@ static void GetInterfaceAddresses(const FunctionCallbackInfo<Value>& args) {
    // contain non-ASCII characters.  On UNIX, it's just a binary string with
    // no particular encoding but we treat it as a one-byte Latin-1 string.
 #ifdef _WIN32
-    name = String::NewFromUtf8(env->isolate(), raw_name);
+    name = String::NewFromUtf8(env->isolate(), raw_name,
+        v8::NewStringType::kNormal).ToLocalChecked();
 #else
    name = OneByteString(env->isolate(), raw_name);
 #endif


Side note: While it may be true that UNIX systems are somewhat encoding-agnostic here, it’s more than reasonable to assume UTF8 as the default as well. It’s what people will expect if they name the interface from any input that uses UTF-8, which should be the most frequent case by far these days.

I’d suggest either merging these directly in this PR, since you’re already touching the code, or leaving a TODO comment about it.

addaleax · 2018-07-21T20:42:35Z

src/spawn_sync.cc

@@ -683,7 +683,9 @@ Local<Object> SyncProcessRunner::BuildResultObject() {
  if (term_signal_ > 0)
    js_result->Set(context, env()->signal_string(),
                   String::NewFromUtf8(env()->isolate(),
-                                       signo_string(term_signal_))).FromJust();
+                                       signo_string(term_signal_), v8::NewStringType::kNormal)


Does this hit the 80 char limit?

It does, dunno how autoformatting left this one out. Will do.

Use v8::NewStringType::kInternalized instead of v8::NewStringType::kNormal in different calls to v8::String::NewFromUtf8 in node.h and node.cc wherever it makes sense, to save the GC some work which would largely be redundant.

Use a UTF-8 encoded string for naming interfaces in unix, instead of using a binary encoding-agnostic string as had been done on windows previously.

ryzokuken · 2018-07-21T22:56:24Z

CI: https://ci.nodejs.org/job/node-test-pull-request/15966/

ryzokuken · 2018-07-22T04:44:17Z

CI passed! Will be landing this once the 72 hours period passes.

addaleax · 2018-07-29T15:06:31Z

Landed in 51812ff...07cb697

Did a minor update to the commit message in 07cb697 (the previous behaviour was not encoding-agnostic). Hope that’s okay!

Remove all calls to deprecated v8 functions (here: String::NewFromUtf8) inside the code (src directory only). PR-URL: #21926 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Use v8::NewStringType::kInternalized instead of v8::NewStringType::kNormal in different calls to v8::String::NewFromUtf8 in node.h and node.cc wherever it makes sense, to save the GC some work which would largely be redundant. PR-URL: #21926 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Use a UTF-8 encoded string for naming interfaces in unix, instead of using Latin-1, as had been done on windows previously. PR-URL: #21926 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com>

ryzokuken · 2018-07-29T15:09:42Z

It totally is, thanks for landing this!

Remove all calls to deprecated v8 functions (here: String::NewFromUtf8) inside the code (src directory only). PR-URL: #21926 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Use v8::NewStringType::kInternalized instead of v8::NewStringType::kNormal in different calls to v8::String::NewFromUtf8 in node.h and node.cc wherever it makes sense, to save the GC some work which would largely be redundant. PR-URL: #21926 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Use a UTF-8 encoded string for naming interfaces in unix, instead of using Latin-1, as had been done on windows previously. PR-URL: #21926 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com>

hashseed

Generally, you want to use kInternalized for strings that are used as identifiers, e.g. variable names or property names.

Sorry for being late with this :)

hashseed · 2018-07-31T08:39:51Z

src/node.cc

@@ -1742,7 +1743,8 @@ static void GetLinkedBinding(const FunctionCallbackInfo<Value>& args) {

  Local<Object> module = Object::New(env->isolate());
  Local<Object> exports = Object::New(env->isolate());
-  Local<String> exports_prop = String::NewFromUtf8(env->isolate(), "exports");
+  Local<String> exports_prop = String::NewFromUtf8(env->isolate(), "exports",
+      v8::NewStringType::kNormal).ToLocalChecked();


You could argue that this should be kInternalized.

hashseed · 2018-07-31T08:40:27Z

src/node.cc

@@ -2235,7 +2241,8 @@ void SetupProcessObject(Environment* env,
  if (eval_string) {
    READONLY_PROPERTY(process,
                      "_eval",
-                      String::NewFromUtf8(env->isolate(), eval_string));
+                      String::NewFromUtf8(env->isolate(), eval_string,
+                          v8::NewStringType::kNormal).ToLocalChecked());


Also kInternalized here.

hashseed · 2018-07-31T08:41:07Z

src/node.cc

@@ -2343,10 +2352,11 @@ void SetupProcessObject(Environment* env,
  if (uv_exepath(exec_path, &exec_path_len) == 0) {
    exec_path_value = String::NewFromUtf8(env->isolate(),
                                          exec_path,
-                                          String::kNormalString,
-                                          exec_path_len);
+                                          v8::NewStringType::kInternalized,


Here on the other hand I don't know why this needs to be internalized.

hashseed · 2018-07-31T08:43:02Z

src/node_perf.cc

@@ -75,14 +75,18 @@ inline void InitObject(const PerformanceEntry& entry, Local<Object> obj) {
                         env->name_string(),
                         String::NewFromUtf8(isolate,
                                             entry.name().c_str(),
-                                             String::kNormalString),
-                         attr).FromJust();
+                                             v8::NewStringType::kNormal)


kInternalized

hashseed · 2018-07-31T08:43:08Z

src/node_perf.cc

-                         attr).FromJust();
+                                             v8::NewStringType::kNormal)
+                             .ToLocalChecked(),
+                         attr)


ryzokuken changed the title ~~[WIP] v8: remove calls to deprecated v8 functions (NewFromUtf8)~~ [WIP] src: remove calls to deprecated v8 functions (NewFromUtf8) Jul 21, 2018

src: remove calls to deprecated v8 functions (NewFromUtf8)

b729e20

Remove all calls to deprecated v8 functions (here: String::NewFromUtf8) inside the code (src directory only).

ryzokuken force-pushed the v8-deprecation-1 branch from 2b70708 to b729e20 Compare July 21, 2018 17:02

TimothyGu reviewed Jul 21, 2018

View reviewed changes

ryzokuken added 2 commits July 22, 2018 00:13

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

7bf4efe

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

c2f5a1b

addaleax reviewed Jul 21, 2018

View reviewed changes

ryzokuken added 6 commits July 22, 2018 00:29

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

025bffb

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

76f5004

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

1264ad8

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

d4a87e0

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

c7caef8

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

5b6232e

addaleax approved these changes Jul 21, 2018

View reviewed changes

ryzokuken added 3 commits July 22, 2018 03:28

src: use kInternalized instead of kNormal

560e336

Use v8::NewStringType::kInternalized instead of v8::NewStringType::kNormal in different calls to v8::String::NewFromUtf8 in node.h and node.cc wherever it makes sense, to save the GC some work which would largely be redundant.

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

5a0ef1d

src: use UTF-8 for naming interfaces in unix

f4bc20b

Use a UTF-8 encoded string for naming interfaces in unix, instead of using a binary encoding-agnostic string as had been done on windows previously.

ryzokuken changed the title ~~[WIP] src: remove calls to deprecated v8 functions (NewFromUtf8)~~ src: remove calls to deprecated v8 functions (NewFromUtf8) Jul 21, 2018

addaleax approved these changes Jul 21, 2018

View reviewed changes

fixup! src: remove calls to deprecated v8 functions (NewFromUtf8)

1ab48ad

tniessen approved these changes Jul 22, 2018

View reviewed changes

apapirovski approved these changes Jul 22, 2018

View reviewed changes

jasnell approved these changes Jul 23, 2018

View reviewed changes

addaleax closed this Jul 29, 2018

targos mentioned this pull request Jul 31, 2018

v10.8.0 proposal #22040

Merged

hashseed reviewed Jul 31, 2018

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: remove calls to deprecated v8 functions (NewFromUtf8) #21926

src: remove calls to deprecated v8 functions (NewFromUtf8) #21926

ryzokuken commented Jul 21, 2018 •

edited

Loading

nodejs-github-bot commented Jul 21, 2018

ryzokuken commented Jul 21, 2018

TimothyGu Jul 21, 2018

ryzokuken Jul 21, 2018

addaleax Jul 21, 2018

ryzokuken Jul 21, 2018

addaleax Jul 21, 2018

addaleax left a comment

addaleax Jul 21, 2018

addaleax Jul 21, 2018

addaleax Jul 21, 2018

addaleax Jul 21, 2018

ryzokuken Jul 21, 2018

ryzokuken commented Jul 21, 2018

ryzokuken commented Jul 22, 2018

addaleax commented Jul 29, 2018

ryzokuken commented Jul 29, 2018

hashseed left a comment •

edited

Loading

hashseed Jul 31, 2018

hashseed Jul 31, 2018

hashseed Jul 31, 2018

hashseed Jul 31, 2018

hashseed Jul 31, 2018

src: remove calls to deprecated v8 functions (NewFromUtf8) #21926

src: remove calls to deprecated v8 functions (NewFromUtf8) #21926

Conversation

ryzokuken commented Jul 21, 2018 • edited Loading

Checklist

Files

nodejs-github-bot commented Jul 21, 2018

ryzokuken commented Jul 21, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

addaleax left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryzokuken commented Jul 21, 2018

ryzokuken commented Jul 22, 2018

addaleax commented Jul 29, 2018

ryzokuken commented Jul 29, 2018

hashseed left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryzokuken commented Jul 21, 2018 •

edited

Loading

hashseed left a comment •

edited

Loading