current commit
260820.6 · src: run same-priority platform tasks in posting order
#include "node_internals.h"
#include "libplatform/libplatform.h"

#include <string>
#include "gtest/gtest.h"
#include "node_test_fixture.h"

// This task increments the given run counter and reposts itself until the
// repost counter reaches zero.
class RepostingTask : public v8::Task {
 public:
  explicit RepostingTask(int repost_count,
                         int* run_count,
                         v8::Isolate* isolate,
                         node::NodePlatform* platform)
      : repost_count_(repost_count),
        run_count_(run_count),
        isolate_(isolate),
        platform_(platform) {}

  // v8::Task implementation
  void Run() final {
    ++*run_count_;
    if (repost_count_ > 0) {
      --repost_count_;
      std::shared_ptr<v8::TaskRunner> task_runner =
          platform_->GetForegroundTaskRunner(isolate_,
                                             v8::TaskPriority::kUserBlocking);
      task_runner->PostTask(std::make_unique<RepostingTask>(
          repost_count_, run_count_, isolate_, platform_));
    }
  }

 private:
  int repost_count_;
  int* run_count_;
  v8::Isolate* isolate_;
  node::NodePlatform* platform_;
};

class PlatformTest : public EnvironmentTestFixture {};

TEST_F(PlatformTest, SkipNewTasksInFlushForegroundTasks) {
  v8::Isolate::Scope isolate_scope(isolate_);
  const v8::HandleScope handle_scope(isolate_);
  const Argv argv;
  Env env {handle_scope, argv};
  int run_count = 0;
  std::shared_ptr<v8::TaskRunner> task_runner =
      platform->GetForegroundTaskRunner(isolate_,
                                        v8::TaskPriority::kUserBlocking);
  task_runner->PostTask(
      std::make_unique<RepostingTask>(2, &run_count, isolate_, platform.get()));
  EXPECT_TRUE(platform->FlushForegroundTasks(isolate_));
  EXPECT_EQ(1, run_count);
  EXPECT_TRUE(platform->FlushForegroundTasks(isolate_));
  EXPECT_EQ(2, run_count);
  EXPECT_TRUE(platform->FlushForegroundTasks(isolate_));
  EXPECT_EQ(3, run_count);
  EXPECT_FALSE(platform->FlushForegroundTasks(isolate_));
}

// Tests the registration of an abstract `IsolatePlatformDelegate` instance as
// opposed to the more common `uv_loop_s*` version of `RegisterIsolate`.
TEST_F(NodeZeroIsolateTestFixture, IsolatePlatformDelegateTest) {
  // Allocate isolate
  v8::Isolate::CreateParams create_params;
  create_params.array_buffer_allocator = allocator.get();
  create_params.cpp_heap =
      v8::CppHeap::Create(platform.get(), v8::CppHeapCreateParams{{}})
          .release();
  auto isolate = v8::Isolate::Allocate();
  CHECK_NOT_NULL(isolate);

  // Register *first*, then initialize
  auto delegate = std::make_shared<node::PerIsolatePlatformData>(
    isolate,
    &current_loop);
  platform->RegisterIsolate(isolate, delegate.get());
  v8::Isolate::Initialize(isolate, create_params);

  // Try creating Context + IsolateData + Environment
  {
    v8::Locker locker(isolate);
    v8::Isolate::Scope isolate_scope(isolate);
    v8::HandleScope handle_scope(isolate);

    auto context = node::NewContext(isolate);
    CHECK(!context.IsEmpty());
    v8::Context::Scope context_scope(context);

    std::unique_ptr<node::IsolateData, decltype(&node::FreeIsolateData)>
      isolate_data{node::CreateIsolateData(isolate,
                                           &current_loop,
                                           platform.get()),
                   node::FreeIsolateData};
    CHECK(isolate_data);

    std::unique_ptr<node::Environment, decltype(&node::FreeEnvironment)>
      environment{node::CreateEnvironment(isolate_data.get(),
                                          context,
                                          {},
                                          {}),
                  node::FreeEnvironment};
    CHECK(environment);
  }

  // Graceful shutdown
  delegate->Shutdown();
  platform->DisposeIsolate(isolate);
}

TEST_F(PlatformTest, TracingControllerNullptr) {
  v8::TracingController* orig_controller = node::GetTracingController();
  node::SetTracingController(nullptr);
  EXPECT_EQ(node::GetTracingController(), nullptr);

  v8::Isolate::Scope isolate_scope(isolate_);
  const v8::HandleScope handle_scope(isolate_);
  const Argv argv;
  Env env {handle_scope, argv};

  node::LoadEnvironment(*env, [&](const node::StartExecutionCallbackInfo& info)
                                  -> v8::MaybeLocal<v8::Value> {
    return v8::Null(isolate_);
  });

  node::SetTracingController(orig_controller);
  EXPECT_EQ(node::GetTracingController(), orig_controller);
}

class RecordingTask : public v8::Task {
 public:
  RecordingTask(std::vector<int>* log, int id) : log_(log), id_(id) {}
  void Run() override { log_->push_back(id_); }

 private:
  std::vector<int>* log_;
  int id_;
};

TEST(TaskQueueTest, HigherPriorityFirstThenPostingOrder) {
  std::vector<int> log;
  {
    node::TaskQueue<v8::Task> queue;
    for (int i = 0; i < 64; i++) {
      queue.Lock().Push(std::make_unique<RecordingTask>(&log, i));
    }
    for (std::unique_ptr<v8::Task>& task : queue.Lock().PopAll()) task->Run();
    for (int i = 64; i < 96; i++) {
      queue.Lock().Push(std::make_unique<RecordingTask>(&log, i));
    }
    while (std::unique_ptr<v8::Task> task = queue.Lock().Pop()) task->Run();
  }
  ASSERT_EQ(log.size(), 96u);
  for (int i = 0; i < 96; i++) EXPECT_EQ(log[i], i);

  log.clear();
  {
    using v8::TaskPriority;
    node::TaskQueue<node::TaskQueueEntry> queue;
    const TaskPriority priorities[] = {TaskPriority::kUserVisible,
                                       TaskPriority::kBestEffort,
                                       TaskPriority::kUserBlocking,
                                       TaskPriority::kUserVisible,
                                       TaskPriority::kUserBlocking,
                                       TaskPriority::kBestEffort,
                                       TaskPriority::kUserVisible};
    int id = 0;
    for (TaskPriority priority : priorities) {
      queue.Lock().Push(std::make_unique<node::TaskQueueEntry>(
          std::make_unique<RecordingTask>(&log, id++), priority));
    }
    for (std::unique_ptr<node::TaskQueueEntry>& entry : queue.Lock().PopAll()) {
      entry->task->Run();
    }
  }
  const std::vector<int> expected = {2, 4, 0, 3, 6, 1, 5};
  EXPECT_EQ(log, expected);
}