Issue 3595 - Get rid of detached threads for setTimeout

include/AdblockPlus/JsEngine.h

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 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
@@ skipping 12 matching lines @@
 #include <list>
 #include <stdexcept>
 #include <stdint.h>
 #include <string>
 #include <mutex>
 #include <AdblockPlus/AppInfo.h>
 #include <AdblockPlus/LogSystem.h>
 #include <AdblockPlus/FileSystem.h>
 #include <AdblockPlus/JsValue.h>
 #include <AdblockPlus/WebRequest.h>
+#include <AdblockPlus/ITimer.h>
 
 namespace v8
 {
   class Arguments;
   class Isolate;
   class Value;
   class Context;
   template<class T> class Handle;
   typedef Handle<Value>(*InvocationCallback)(const Arguments &args);
 }
 
 namespace AdblockPlus
 {
   class JsEngine;
 
   /**
    * Shared smart pointer to a `JsEngine` instance.
    */
   typedef std::shared_ptr<JsEngine> JsEnginePtr;
 
   /**
+   * A factory to construct DefaultTimer.
+   */
+  TimerPtr CreateDefaultTimer();
+
+  /**
    * Scope based isolate manager. Creates a new isolate instance on
    * constructing and disposes it on destructing.
    */
   class ScopedV8Isolate
   {
   public:
     ScopedV8Isolate();
     ~ScopedV8Isolate();
     v8::Isolate* Get()
     {
@@ skipping 32 matching lines @@
     typedef std::function<bool()> IsConnectionAllowedCallback;
 
     /**
      * Maps events to callback functions.
      */
     typedef std::map<std::string, EventCallback> EventMap;
 
     /**
      * Creates a new JavaScript engine instance.
      * @param appInfo Information about the app.
+     * @param timer Implementation of timer.
      * @param isolate v8::Isolate wrapper. This parameter should be considered
      *        as a temporary hack for tests, it will go away. Issue #3593.
      * @return New `JsEngine` instance.
      */
-    static JsEnginePtr New(const AppInfo& appInfo = AppInfo(), const ScopedV8IsolatePtr& isolate = ScopedV8IsolatePtr(new ScopedV8Isolate()));
+    static JsEnginePtr New(const AppInfo& appInfo = AppInfo(),
+      TimerPtr timer = CreateDefaultTimer(),
+      const ScopedV8IsolatePtr& isolate = ScopedV8IsolatePtr(new ScopedV8Isolate()));
 
     /**
      * Registers the callback function for an event.
      * @param eventName Event name. Note that this can be any string - it's a
      *        general purpose event handling mechanism.
      * @param callback Event callback function.
      */
     void SetEventCallback(const std::string& eventName, EventCallback callback);
 
     /**
@@ skipping 67 matching lines @@
     /**
      * Returns a `JsEngine` instance contained in a `v8::Arguments` object.
      * Use this in callbacks created via `NewCallback()` to retrieve the current
      * `JsEngine`.
      * @param arguments `v8::Arguments` object containing the `JsEngine`
      *        instance.
      * @return `JsEngine` instance from `v8::Arguments`.
      */
     static JsEnginePtr FromArguments(const v8::Arguments& arguments);
 
+    /*
+     * Private functionality required to implement timers.
+     * @param arguments `v8::Arguments` is the arguments received in C++
+     * callback associated for global setTimeout method.
+     */
+    static void ScheduleTimer(const v8::Arguments& arguments);
+
     /**
      * Converts v8 arguments to `JsValue` objects.
      * @param arguments `v8::Arguments` object containing the arguments to
      *        convert.
      * @return List of arguments converted to `JsValue` objects.
      */
     JsValueList ConvertArguments(const v8::Arguments& arguments);
 
     /**
      * @see `SetFileSystem()`.
@@ skipping 56 matching lines @@
     void SetGlobalProperty(const std::string& name, AdblockPlus::JsValuePtr value);
 
     /**
      * Returns a pointer to associated v8::Isolate.
      */
     v8::Isolate* GetIsolate()
     {
       return isolate->Get();
     }
 
-    // Private functionality required to implement timers.
-    struct TimerTaskInfo
+  private:
+    struct TimerTask
     {
-      ~TimerTaskInfo();
-      int delay;
+      ~TimerTask();
       std::vector<std::unique_ptr<v8::Persistent<v8::Value>>> arguments;
     };
-    typedef std::list<TimerTaskInfo> TimerTaskInfos;
-    struct TimerTask
-    {
-      std::weak_ptr<JsEngine> weakJsEngine;
-      TimerTaskInfos::const_iterator taskInfoIterator;
-    };
-    TimerTask CreateTimerTask(const v8::Arguments& arguments);
-    void CallTimerTask(TimerTaskInfos::const_iterator taskInfoIterator);
-  private:
-    explicit JsEngine(const ScopedV8IsolatePtr& isolate);
+    typedef std::list<TimerTask> TimerTasks;
+    void CallTimerTask(TimerTasks::const_iterator timerTaskIterator);
+
+    explicit JsEngine(const ScopedV8IsolatePtr& isolate, TimerPtr timer);
 
     JsValuePtr GetGlobalObject();
 
     /// Isolate must be disposed only after disposing of all objects which are
     /// using it.
     ScopedV8IsolatePtr isolate;
 
     FileSystemPtr fileSystem;
     WebRequestPtr webRequest;
     LogSystemPtr logSystem;
     std::unique_ptr<v8::Persistent<v8::Context>> context;
     EventMap eventCallbacks;
     std::mutex eventCallbacksMutex;
     std::mutex isConnectionAllowedMutex;
     IsConnectionAllowedCallback isConnectionAllowed;
-    TimerTaskInfos timerTaskInfos;
+    TimerTasks timerTasks;
+    TimerPtr timer;
   };
 }
 
 #endif