Issue #4692 - Rewrite `SetTimeout` facility to avoid `JsValuePtr` and `JsValueList`

src/JsEngine.cpp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <AdblockPlus.h>
 #include "GlobalJsObject.h"
 #include "JsContext.h"
+#include "JsEngineInternal.h"
+#include "JsEngineTransition.h"
 #include "JsError.h"
 #include "Scheduler.h"
 #include "Utils.h"
 
 const AdblockPlus::ImmediateSingleUseThreadType AdblockPlus::ImmediateSingleUseThread = {};
 
 class AdblockPlus::JsEngine::SchedulerImpl
   : public SchedulerT<SingleUseWorker>
 {
 public:
@@ skipping 36 matching lines @@
   public:
     static void Init()
     {
       // it's threadsafe since C++11 and it will be instantiated only once and
       // destroyed at the application exit
       static V8Initializer initializer;
     }
   };
 }
 
+V8ExecutionScope::V8ExecutionScope(JsEngineInternal* engine)
+  : lock(engine->GetIsolate()),
+  isolateScope(engine->GetIsolate()),
+  handleScope(engine->GetIsolate()),
+  contextScope(engine->GetContextAsLocal())
+{}
+
 AdblockPlus::ScopedV8Isolate::ScopedV8Isolate()
 {
   V8Initializer::Init();
   isolate = v8::Isolate::New();
 }
 
 AdblockPlus::ScopedV8Isolate::~ScopedV8Isolate()
 {
   isolate->Dispose();
   isolate = nullptr;
 }
 
 AdblockPlus::JsEngine::JsEngine(const ScopedV8IsolatePtr& isolate)
   : isolate(isolate),
-    scheduler(new SchedulerImpl()) // use std::make_unique after we upgrade out of VS2012
+  scheduler(new SchedulerImpl()) // TODO: make_unique once available
 {}
 
+JsEngineInternal::JsEngineInternal(const AdblockPlus::ScopedV8IsolatePtr& isolate)
+  : AdblockPlus::JsEngine(isolate),
+  context(isolate->Get(),v8::Context::New(isolate->Get()))
+{
+  /*
+   * Enter v8 scope for our context so that we can initialize its global object.
+   */
+  const v8::Context::Scope contextScope(GetContextAsLocal());
+  auto globalObject = GetGlobalObject();
+  auto propertyName = AdblockPlus::Utils::ToV8String(GetIsolate(), "setTimeout");
+  globalObject->Set(propertyName, MakeCallback(::CallbackForSetTimeout));

[Eric, 2016/12/19 22:39:53]

New initialization of global object without any use of `JsEnginePtr`.

+  // TODO: Move the rest of the global object initializations here
+}
+
+/**
+ * \par Design Notes
+ * It is technically necessary to construct JsEngine instances *only* within a factory.
+ * Initialization requires that certain transient v8 scopes be set up 
+ *   before initialization and torn down afterwards.
+ * C++ has no syntax to use anything like a sentry object in the constructor itself.
+ * Thus we need to establish v8 scope within every C++ scope that constructs an object.
+ */
 AdblockPlus::JsEnginePtr AdblockPlus::JsEngine::New(const AppInfo& appInfo, const ScopedV8IsolatePtr& isolate)
 {
-  JsEnginePtr result(new JsEngine(isolate));
+  auto isolateP = isolate->Get();
+  /*
+   * TODO: Remove `locker`.
+   * Until #3595 is fixed, unit tests allocate isolates outside of this class.
+   * Once we're no longer doing that, we may assume that this class holds
+   *   exclusive access to the nascent isolate.
+   * The factory and constructor constitute a single-threaded usage,
+   *   and there will be no need to lock the isolate.
+   */
+  const v8::Locker locker(isolateP);
+  /*
+   * Set up v8 scopes for isolate and handle.
+   * We cannot set up the v8 scope for context because it doesn't exist
+   *   until after the constructor for `JsEngineInternal` returns.
+   */
+  const v8::Isolate::Scope isolateScope(isolateP);
+  const v8::HandleScope handleScope(isolateP);
 
-  const v8::Locker locker(result->GetIsolate());
-  const v8::Isolate::Scope isolateScope(result->GetIsolate());
-  const v8::HandleScope handleScope(result->GetIsolate());
+  std::shared_ptr<JsEngineInternal> engine(std::make_shared<JsEngineInternal>(isolate));
 
-  result->context.reset(new v8::Persistent<v8::Context>(result->GetIsolate(),
-    v8::Context::New(result->GetIsolate())));
+  JsEnginePtr result(engine);
+  // Establish a context scope for the legacy setup of the global object
+  const v8::Context::Scope contextScope(engine->GetContextAsLocal());
   AdblockPlus::GlobalJsObject::Setup(result, appInfo, result->GetGlobalObject());
   return result;
 }
 
+v8::Local<v8::Context> JsEngineInternal::GetContextAsLocal() const
+{
+  return v8::Local<v8::Context>::New(isolate->Get(), context);
+}
+
 AdblockPlus::JsValuePtr AdblockPlus::JsEngine::GetGlobalObject()
 {
-  JsContext context(shared_from_this());
-  return JsValuePtr(new JsValue(shared_from_this(), context.GetV8Context()->Global()));
+  return JsValuePtr(new JsValue(shared_from_this(), ToInternal(this)->GetGlobalObject()));
+}
+
+v8::Local<v8::Object> JsEngineInternal::GetGlobalObject()
+{
+  return GetContextAsLocal()->Global();
+}
+
+v8::Local<v8::Value> JsEngineInternal::ApplyFunction(
+  v8::Local<v8::Function> func,
+  AllocatedArray<v8::Local<v8::Value>> args)
+{
+  return ApplyFunction(GetGlobalObject(), func, std::move(args));
+}
+
+v8::Local<v8::Value> JsEngineInternal::ApplyFunction(
+  v8::Local<v8::Object> thisObject,
+  v8::Local<v8::Function> func,
+  AllocatedArray<v8::Local<v8::Value>> args)
+{
+  const v8::TryCatch tryCatch;
+  v8::Local<v8::Value> result = func->Call(thisObject, args.Size(), args.Get());
+  if (tryCatch.HasCaught())
+  {
+    throw AdblockPlus::JsError(tryCatch.Exception(), tryCatch.Message());
+  }
+  return result;
 }
 
 AdblockPlus::JsValuePtr AdblockPlus::JsEngine::Evaluate(const std::string& source,
     const std::string& filename)
 {
   const JsContext context(shared_from_this());
   const v8::TryCatch tryCatch;
   const v8::Handle<v8::Script> script = CompileScript(GetIsolate(), source,
     filename);
   CheckTryCatch(tryCatch);
@@ skipping 70 matching lines @@
   const v8::Local<const v8::External> external =
       v8::Local<const v8::External>::Cast(arguments.Data());
   std::weak_ptr<JsEngine>* data =
       static_cast<std::weak_ptr<JsEngine>*>(external->Value());
   JsEnginePtr result = data->lock();
   if (!result)
     throw std::runtime_error("Oops, our JsEngine is gone, how did that happen?");
   return result;
 }
 
+/**
+ * \par Implementation Notes 
+ * We initialize the `Data()` element of the callback arguments with `this`,
+ *   which raises an issue about life cycle.
+ * The result of `FunctionTemplate::New` is to create a function 
+ *   whose lifespan is the same as the context it's created in.
+ * The context is an instance member of the engine,
+ *   so as long as the engine exists, so does the context.
+ * Since evaluation in v8 only occurs during the ordinary lifespan of the engine
+ *   (i.e. after the constructor and before the destructor),
+ *   the `this` pointer will be valid whenever the callback function might be called.
+ */
+v8::Local<v8::Function> JsEngineInternal::MakeCallback(v8::InvocationCallback callback)
+{
+  return v8::FunctionTemplate::New(callback, v8::External::New(this))->GetFunction();
+}
+
+JsEngineInternal* JsEngineInternal::ExtractEngine(const v8::Arguments& arguments)
+{
+  return static_cast<JsEngineInternal*>(v8::Local<v8::External>::Cast(arguments.Data())->Value());
+}
+
 AdblockPlus::JsValueList AdblockPlus::JsEngine::ConvertArguments(const v8::Arguments& arguments)
 {
   const JsContext context(shared_from_this());
   JsValueList list;
   for (int i = 0; i < arguments.Length(); i++)
     list.push_back(JsValuePtr(new JsValue(shared_from_this(), arguments[i])));
   return list;
 }
 
 AdblockPlus::FileSystemPtr AdblockPlus::JsEngine::GetFileSystem()
@@ skipping 34 matching lines @@
 }
 
 void AdblockPlus::JsEngine::SetLogSystem(AdblockPlus::LogSystemPtr val)
 {
   if (!val)
     throw std::runtime_error("LogSystem cannot be null");
 
   logSystem = val;
 }
 
-
 void AdblockPlus::JsEngine::SetGlobalProperty(const std::string& name, 
                                               AdblockPlus::JsValuePtr value)
 {
+  JsContext jsContext(shared_from_this());
   auto global = GetGlobalObject();
   if (!global)
     throw std::runtime_error("Global object cannot be null");
   global->SetProperty(name, value);
 }
 
 void AdblockPlus::JsEngine::Schedule(std::function<void()> task,
                                      AdblockPlus::ImmediateSingleUseThreadType)
 {
   // The present version of the scheduler only does immediate and single-use
   // It does not, however, detach threads like the legacy thread behavior did.
   scheduler->Run(task);
 }
 
 void AdblockPlus::JsEngine::WaitForQuietScheduler()
 {
   scheduler->JoinAll();
 }
+
+JsEngineInternal* ToInternal(AdblockPlus::JsEnginePtr p)
+{
+  return static_cast<JsEngineInternal*>(p.get());
+}
+
+JsEngineInternal* ToInternal(AdblockPlus::JsEngine* p)
+{
+  return static_cast<JsEngineInternal*>(p);
+}