From 74571c80a945f2bdf4094a090410ae02b9a69af6 Mon Sep 17 00:00:00 2001 From: Ruben Bridgewater Date: Mon, 21 Jan 2019 15:56:16 +0100 Subject: [PATCH] Fix preview of set entries Set entries return an array with the value as first and second entry. As such these are considered key value pairs to align with maps entries iterator. So far the return value was identical to the values iterator and that is misleading. This also adds tests to verify the results and improves the coverage a tiny bit by testing different iterators. Refs: https://github.com/nodejs/node/issues/24629 R=yangguo@chromium.org Change-Id: I669a724bb4afaf5a713e468b1f51691d22c25253 Reviewed-on: https://chromium-review.googlesource.com/c/1350790 Commit-Queue: Yang Guo Reviewed-by: Benedikt Meurer Reviewed-by: Jakob Gruber Reviewed-by: Yang Guo Cr-Commit-Position: refs/heads/master@{#59311} --- AUTHORS | 1 + src/api.cc | 31 ++- test/cctest/test-api.cc | 230 +++++++++++++++++- ...t-preview-internal-properties-expected.txt | 40 +-- .../object-preview-internal-properties.js | 2 +- .../internal-properties-entries-expected.txt | 3 +- 6 files changed, 278 insertions(+), 29 deletions(-) diff --git a/AUTHORS b/AUTHORS index faa2a2bfdbd8..34545eaaa5d5 100644 --- a/AUTHORS +++ b/AUTHORS @@ -148,6 +148,7 @@ Rick Waldron Rob Wu Robert Mustacchi Robert Nagy +Ruben Bridgewater Ryan Dahl Sakthipriyan Vairamani (thefourtheye) Sander Mathijs van Veen diff --git a/src/api.cc b/src/api.cc index 22365f24226f..51be97588ca9 100644 --- a/src/api.cc +++ b/src/api.cc @@ -6985,6 +6985,11 @@ enum class MapAsArrayKind { kValues = i::JS_MAP_VALUE_ITERATOR_TYPE }; +enum class SetAsArrayKind { + kEntries = i::JS_SET_KEY_VALUE_ITERATOR_TYPE, + kValues = i::JS_SET_VALUE_ITERATOR_TYPE +}; + i::Handle MapAsArray(i::Isolate* isolate, i::Object table_obj, int offset, MapAsArrayKind kind) { i::Factory* factory = isolate->factory(); @@ -7094,13 +7099,14 @@ Maybe Set::Delete(Local context, Local key) { namespace { i::Handle SetAsArray(i::Isolate* isolate, i::Object table_obj, - int offset) { + int offset, SetAsArrayKind kind) { i::Factory* factory = isolate->factory(); i::Handle table(i::OrderedHashSet::cast(table_obj), isolate); // Elements skipped by |offset| may already be deleted. int capacity = table->UsedCapacity(); - int max_length = capacity - offset; + const bool collect_key_values = kind == SetAsArrayKind::kEntries; + int max_length = (capacity - offset) * (collect_key_values ? 2 : 1); if (max_length == 0) return factory->NewJSArray(0); i::Handle result = factory->NewFixedArray(max_length); int result_index = 0; @@ -7111,6 +7117,7 @@ i::Handle SetAsArray(i::Isolate* isolate, i::Object table_obj, i::Object key = table->KeyAt(i); if (key == the_hole) continue; result->set(result_index++, key); + if (collect_key_values) result->set(result_index++, key); } } DCHECK_GE(max_length, result_index); @@ -7126,7 +7133,8 @@ Local Set::AsArray() const { i::Isolate* isolate = obj->GetIsolate(); LOG_API(isolate, Set, AsArray); ENTER_V8_NO_SCRIPT_NO_EXCEPTION(isolate); - return Utils::ToLocal(SetAsArray(isolate, obj->table(), 0)); + return Utils::ToLocal( + SetAsArray(isolate, obj->table(), 0, SetAsArrayKind::kValues)); } @@ -9553,21 +9561,22 @@ v8::MaybeLocal v8::Object::PreviewEntries(bool* is_key_value) { i::Handle::cast(object), 0)); } if (object->IsJSMapIterator()) { - i::Handle iterator = - i::Handle::cast(object); + i::Handle it = i::Handle::cast(object); MapAsArrayKind const kind = - static_cast(iterator->map()->instance_type()); + static_cast(it->map()->instance_type()); *is_key_value = kind == MapAsArrayKind::kEntries; - if (!iterator->HasMore()) return v8::Array::New(v8_isolate); - return Utils::ToLocal(MapAsArray(isolate, iterator->table(), - i::Smi::ToInt(iterator->index()), kind)); + if (!it->HasMore()) return v8::Array::New(v8_isolate); + return Utils::ToLocal( + MapAsArray(isolate, it->table(), i::Smi::ToInt(it->index()), kind)); } if (object->IsJSSetIterator()) { i::Handle it = i::Handle::cast(object); - *is_key_value = false; + SetAsArrayKind const kind = + static_cast(it->map()->instance_type()); + *is_key_value = kind == SetAsArrayKind::kEntries; if (!it->HasMore()) return v8::Array::New(v8_isolate); return Utils::ToLocal( - SetAsArray(isolate, it->table(), i::Smi::ToInt(it->index()))); + SetAsArray(isolate, it->table(), i::Smi::ToInt(it->index()), kind)); } return v8::MaybeLocal(); } diff --git a/test/cctest/test-api.cc b/test/cctest/test-api.cc index bc75d87cd4d2..f33ddb244760 100644 --- a/test/cctest/test-api.cc +++ b/test/cctest/test-api.cc @@ -28649,7 +28649,7 @@ TEST(MicrotaskContextShouldBeNativeContext) { isolate->RunMicrotasks(); } -TEST(PreviewSetIteratorEntriesWithDeleted) { +TEST(PreviewSetKeysIteratorEntriesWithDeleted) { LocalContext env; v8::HandleScope handle_scope(env->GetIsolate()); v8::Local context = env.local(); @@ -28748,7 +28748,142 @@ TEST(PreviewSetIteratorEntriesWithDeleted) { } } -TEST(PreviewMapIteratorEntriesWithDeleted) { +TEST(PreviewSetValuesIteratorEntriesWithDeleted) { + LocalContext env; + v8::HandleScope handle_scope(env->GetIsolate()); + v8::Local context = env.local(); + + { + // Create set, delete entry, create iterator, preview. + v8::Local iterator = + CompileRun("var set = new Set([1,2,3]); set.delete(1); set.values()") + ->ToObject(context) + .ToLocalChecked(); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(!is_key); + CHECK_EQ(2, entries->Length()); + CHECK_EQ(2, entries->Get(context, 0) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + CHECK_EQ(3, entries->Get(context, 1) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + } + { + // Create set, create iterator, delete entry, preview. + v8::Local iterator = + CompileRun("var set = new Set([1,2,3]); set.values()") + ->ToObject(context) + .ToLocalChecked(); + CompileRun("set.delete(1);"); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(!is_key); + CHECK_EQ(2, entries->Length()); + CHECK_EQ(2, entries->Get(context, 0) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + CHECK_EQ(3, entries->Get(context, 1) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + } + { + // Create set, create iterator, delete entry, iterate, preview. + v8::Local iterator = + CompileRun("var set = new Set([1,2,3]); var it = set.values(); it") + ->ToObject(context) + .ToLocalChecked(); + CompileRun("set.delete(1); it.next();"); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(!is_key); + CHECK_EQ(1, entries->Length()); + CHECK_EQ(3, entries->Get(context, 0) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + } + { + // Create set, create iterator, delete entry, iterate until empty, preview. + v8::Local iterator = + CompileRun("var set = new Set([1,2,3]); var it = set.values(); it") + ->ToObject(context) + .ToLocalChecked(); + CompileRun("set.delete(1); it.next(); it.next();"); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(!is_key); + CHECK_EQ(0, entries->Length()); + } + { + // Create set, create iterator, delete entry, iterate, trigger rehash, + // preview. + v8::Local iterator = + CompileRun("var set = new Set([1,2,3]); var it = set.values(); it") + ->ToObject(context) + .ToLocalChecked(); + CompileRun("set.delete(1); it.next();"); + CompileRun("for (var i = 4; i < 20; i++) set.add(i);"); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(!is_key); + CHECK_EQ(17, entries->Length()); + for (uint32_t i = 0; i < 17; i++) { + CHECK_EQ(i + 3, entries->Get(context, i) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + } + } +} + +TEST(PreviewMapEntriesIteratorEntries) { + LocalContext env; + v8::HandleScope handle_scope(env->GetIsolate()); + v8::Local context = env.local(); + { + // Create set, delete entry, create entries iterator, preview. + v8::Local iterator = + CompileRun("var set = new Set([1,2,3]); set.delete(2); set.entries()") + ->ToObject(context) + .ToLocalChecked(); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(is_key); + CHECK_EQ(4, entries->Length()); + uint32_t first = entries->Get(context, 0) + .ToLocalChecked() + ->Int32Value(context) + .FromJust(); + uint32_t second = entries->Get(context, 2) + .ToLocalChecked() + ->Int32Value(context) + .FromJust(); + CHECK_EQ(1, first); + CHECK_EQ(3, second); + CHECK_EQ(first, entries->Get(context, 1) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + CHECK_EQ(second, entries->Get(context, 3) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + } +} + +TEST(PreviewMapValuesIteratorEntriesWithDeleted) { LocalContext env; v8::HandleScope handle_scope(env->GetIsolate()); v8::Local context = env.local(); @@ -28863,6 +28998,97 @@ TEST(PreviewMapIteratorEntriesWithDeleted) { } } +TEST(PreviewMapKeysIteratorEntriesWithDeleted) { + LocalContext env; + v8::HandleScope handle_scope(env->GetIsolate()); + v8::Local context = env.local(); + + { + // Create map, delete entry, create iterator, preview. + v8::Local iterator = CompileRun( + "var map = new Map();" + "var key = 1; map.set(key, {});" + "map.set(2, {}); map.set(3, {});" + "map.delete(key);" + "map.keys()") + ->ToObject(context) + .ToLocalChecked(); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(!is_key); + CHECK_EQ(2, entries->Length()); + CHECK_EQ(2, entries->Get(context, 0) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + CHECK_EQ(3, entries->Get(context, 1) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + } + { + // Create map, create iterator, delete entry, preview. + v8::Local iterator = CompileRun( + "var map = new Map();" + "var key = 1; map.set(key, {});" + "map.set(2, {}); map.set(3, {});" + "map.keys()") + ->ToObject(context) + .ToLocalChecked(); + CompileRun("map.delete(key);"); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(!is_key); + CHECK_EQ(2, entries->Length()); + CHECK_EQ(2, entries->Get(context, 0) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + CHECK_EQ(3, entries->Get(context, 1) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + } + { + // Create map, create iterator, delete entry, iterate, preview. + v8::Local iterator = CompileRun( + "var map = new Map();" + "var key = 1; map.set(key, {});" + "map.set(2, {}); map.set(3, {});" + "var it = map.keys(); it") + ->ToObject(context) + .ToLocalChecked(); + CompileRun("map.delete(key); it.next();"); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(!is_key); + CHECK_EQ(1, entries->Length()); + CHECK_EQ(3, entries->Get(context, 0) + .ToLocalChecked() + ->Int32Value(context) + .FromJust()); + } + { + // Create map, create iterator, delete entry, iterate until empty, preview. + v8::Local iterator = CompileRun( + "var map = new Map();" + "var key = 1; map.set(key, {});" + "map.set(2, {}); map.set(3, {});" + "var it = map.keys(); it") + ->ToObject(context) + .ToLocalChecked(); + CompileRun("map.delete(key); it.next(); it.next();"); + bool is_key; + v8::Local entries = + iterator->PreviewEntries(&is_key).ToLocalChecked(); + CHECK(!is_key); + CHECK_EQ(0, entries->Length()); + } +} + namespace { static v8::Isolate* isolate_1; static v8::Isolate* isolate_2; diff --git a/test/inspector/debugger/object-preview-internal-properties-expected.txt b/test/inspector/debugger/object-preview-internal-properties-expected.txt index 9f265261f8b6..8f62c754f33f 100644 --- a/test/inspector/debugger/object-preview-internal-properties-expected.txt +++ b/test/inspector/debugger/object-preview-internal-properties-expected.txt @@ -166,27 +166,39 @@ expression: (new Map([[1,2]])).entries() } ] -expression: (new Set([[1,2]])).entries() +expression: (new Set([1,2])).entries() [[Entries]]: [ [0] : { + key : { + description : 1 + overflow : false + properties : [ + ] + type : number + } value : { - description : Array(2) + description : 1 overflow : false properties : [ - [0] : { - name : 0 - type : number - value : 1 - } - [1] : { - name : 1 - type : number - value : 2 - } ] - subtype : array - type : object + type : number + } + } + [1] : { + key : { + description : 2 + overflow : false + properties : [ + ] + type : number + } + value : { + description : 2 + overflow : false + properties : [ + ] + type : number } } ] diff --git a/test/inspector/debugger/object-preview-internal-properties.js b/test/inspector/debugger/object-preview-internal-properties.js index fc7dabac1a93..5b1cc3b8a26a 100644 --- a/test/inspector/debugger/object-preview-internal-properties.js +++ b/test/inspector/debugger/object-preview-internal-properties.js @@ -46,7 +46,7 @@ InspectorTest.runTestSuite([ function iteratorObject(next) { checkExpression("(new Map([[1,2]])).entries()") - .then(() => checkExpression("(new Set([[1,2]])).entries()")) + .then(() => checkExpression("(new Set([1,2])).entries()")) .then(next); }, diff --git a/test/inspector/runtime/internal-properties-entries-expected.txt b/test/inspector/runtime/internal-properties-entries-expected.txt index c78451d5d158..db052dbd9361 100644 --- a/test/inspector/runtime/internal-properties-entries-expected.txt +++ b/test/inspector/runtime/internal-properties-entries-expected.txt @@ -596,6 +596,7 @@ expression: it = new Set([1,2]).keys(); it.next(); it expression: it = new Set([1,2]).entries(); it.next(); it [ [0] : { + key : 2 value : 2 } ] @@ -610,7 +611,7 @@ expression: it = new Set([1,2]).entries(); it.next(); it name : 0 value : { className : Object - description : 2 + description : {2 => 2} objectId : subtype : internal#entry type : object