Merge lp:~webapps/unity-js-scopes/lp-1476406 into lp:unity-js-scopes

[Marcus Tomlinson]

* Build io.js as part of the unity-js-scopes build
* Build io.js in Release and Debug, and set link directory accordingly
* Added commented out debug lines to simple.ini for quick debug enable/disable
* Commented out "canned_query.query_string();" line in simple.js (crashes atm)
* Added missing "runtime_config.search" function to index.js
* Added missing "new_categorised_result" function export to addon.cc
* Use v8cpp::Locker to acquire the main isolate lock for incoming callbacks
* Configure runtime_ lazily in scope.cc to provide scope ID to create_scope_runtime()
* Get and store current isolate upon constructing bound scope classes

[lp:~webapps/unity-js-scopes/lp-1476406]

28. By Marcus Tomlinson on 2015-07-29

Reverted silly change that got left behind

29. By Marcus Tomlinson on 2015-07-30

Got query string working in simple.js

30. By Marcus Tomlinson on 2015-07-30

Added all required locks to scope-base.cc and search-query.cc

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-06-25 18:00:25 +0000
+++ CMakeLists.txt	2015-07-30 13:03:08 +0000
@@ -43,14 +43,16 @@
   ${CMAKE_CURRENT_SOURCE_DIR}/deps/v8-cpp/src
   ${CMAKE_CURRENT_SOURCE_DIR}/src
   )
-link_directories(
-  ${CMAKE_CURRENT_SOURCE_DIR}/deps/io.js/out/Release
-  )
 
-add_custom_target(
-  deps
-  COMMAND
-  ${CMAKE_CURRENT_SOURCE_DIR}/deps/build.sh
-  )
+string(TOLOWER "${CMAKE_BUILD_TYPE}" cmake_build_type_tolower)
+if(cmake_build_type_tolower STREQUAL "debug")
+  link_directories(
+    ${CMAKE_CURRENT_SOURCE_DIR}/deps/io.js/out/Debug
+  )
+else()
+  link_directories(
+    ${CMAKE_CURRENT_SOURCE_DIR}/deps/io.js/out/Release
+  )
+endif()
 
 add_subdirectory(src)

=== modified file 'deps/build.sh'
--- deps/build.sh	2015-06-19 20:38:02 +0000
+++ deps/build.sh	2015-07-30 13:03:08 +0000
@@ -7,5 +7,5 @@
 cd $DIR
 
 cd io.js
-./configure --enable-static
+./configure --enable-static --debug
 make -j3

=== modified file 'examples/simple/simple.ini'
--- examples/simple/simple.ini	2015-07-22 09:48:34 +0000
+++ examples/simple/simple.ini	2015-07-30 13:03:08 +0000
@@ -1,5 +1,7 @@
 [ScopeConfig]
 ScopeRunner=/usr/bin/unity-js-scopes-launcher %S %R
+#ScopeRunner=/usr/bin/gdbserver :10000 /usr/bin/unity-js-scopes-launcher %S %R
+#DebugMode = true
 DisplayName = mock.DisplayName
 Description = mock.Description
 Author = test

=== modified file 'examples/simple/simple.js'
--- examples/simple/simple.js	2015-07-20 19:24:44 +0000
+++ examples/simple/simple.js	2015-07-30 13:03:08 +0000
@@ -45,7 +45,7 @@
                     var categorised_result =
                         scopes.lib.new_categorised_result(category);
                     categorised_result.set_uri("http://www.ubuntu.com");
-                    categorised_result.set_title("Ubuntu");
+                    categorised_result.set_title("'" + qs + "'");
                     
                     search_reply.push(categorised_result);
                 },

=== modified file 'src/bindings/index.js'
--- src/bindings/index.js	2015-07-20 19:24:44 +0000
+++ src/bindings/index.js	2015-07-30 13:03:08 +0000
@@ -48,6 +48,10 @@
             this._base.onstop(runtime_config.stop);
         }
 
+        if (runtime_config.search && typeof(runtime_config.search) === 'function') {
+            this._base.onsearch(runtime_config.search);
+        }
+
         if (runtime_config.preview && typeof(runtime_config.preview) === 'function') {
             this._base.onpreview(runtime_config.preview);
         }

=== modified file 'src/bindings/src/addon.cc'
--- src/bindings/src/addon.cc	2015-07-20 19:24:44 +0000
+++ src/bindings/src/addon.cc	2015-07-30 13:03:08 +0000
@@ -288,10 +288,27 @@
     v8cpp::Class<SearchMetaData> search_metadata(isolate);
 
     v8cpp::Module module(isolate);
+    module.add_class("js_scope", js_scope);
+    module.add_class("scope_base", scope_base);
+    module.add_class("action_metadata", action_metadata);
+    module.add_class("category", category);
+    module.add_class("categorised_result", categorised_result);
+    module.add_class("canned_query", canned_query);
+    module.add_class("category_renderer", category_renderer);
+    module.add_class("column_layout", column_layout);
+    module.add_class("preview_widget", preview_widget);
+    module.add_class("preview_query", preview_query);
+    module.add_class("preview_reply", preview_reply);
+    module.add_class("result", result);
+    module.add_class("search_reply", search_reply);
+    module.add_class("search_query", search_query);
+    module.add_class("search_metadata", search_metadata);
+
     module.add_function("new_scope", &new_scope);
     module.add_function("new_search_query", &new_search_query);
     module.add_function("new_category_renderer", &new_category_renderer);
     module.add_function("new_preview_widget", &new_preview_widget);
+    module.add_function("new_categorised_result", &new_categorised_result);
 
     exports->SetPrototype(module.create_prototype());
 }

=== modified file 'src/bindings/src/canned-query.h'
--- src/bindings/src/canned-query.h	2015-06-18 16:39:04 +0000
+++ src/bindings/src/canned-query.h	2015-07-30 13:03:08 +0000
@@ -39,7 +39,7 @@
   
  private:
 
-  unity::scopes::CannedQuery const &query_;
+  unity::scopes::CannedQuery const query_;
 };
 
 #endif // _UNITY_JS_CANNED_QUERY_H_

=== modified file 'src/bindings/src/scope-base.cc'
--- src/bindings/src/scope-base.cc	2015-07-20 19:07:45 +0000
+++ src/bindings/src/scope-base.cc	2015-07-30 13:03:08 +0000
@@ -25,7 +25,8 @@
 #include "action-metadata.h"
 #include "preview-query.h"
 
-ScopeBase::ScopeBase() {
+ScopeBase::ScopeBase()
+  : isolate_(v8::Isolate::GetCurrent()) {
 }
 ScopeBase::~ScopeBase() {
   if ( ! start_callback_.IsEmpty()) {
@@ -43,49 +44,51 @@
 }
 
 void ScopeBase::start(std::string const& scope_id) {
+  v8cpp::Locker locker(isolate_);
+
   if (start_callback_.IsEmpty()) {
     return;
   }
 
-  v8::Isolate * isolate = v8::Isolate::GetCurrent();
-
   v8::Local<v8::Function> start_callback =
-    v8cpp::to_local<v8::Function>(isolate, start_callback_);
+    v8cpp::to_local<v8::Function>(isolate_, start_callback_);
 
-  v8cpp::call_v8(isolate,
+  v8cpp::call_v8(isolate_,
                  start_callback,
-                 v8cpp::to_v8(isolate, scope_id.c_str()));
+                 v8cpp::to_v8(isolate_, scope_id.c_str()));
 }
 
 void ScopeBase::stop() {
+  v8cpp::Locker locker(isolate_);
+
   if (stop_callback_.IsEmpty()) {
     return;
   }
 
-  v8::Isolate * isolate = v8::Isolate::GetCurrent();
-
   v8::Local<v8::Function> stop_callback =
-    v8cpp::to_local<v8::Function>(isolate, stop_callback_);
+    v8cpp::to_local<v8::Function>(isolate_, stop_callback_);
 
-  v8cpp::call_v8(isolate, stop_callback);
+  v8cpp::call_v8(isolate_, stop_callback);
 }
 
 void ScopeBase::run() {
+  v8cpp::Locker locker(isolate_);
+
   if (run_callback_.IsEmpty()) {
     return;
   }
 
-  v8::Isolate * isolate = v8::Isolate::GetCurrent();
-
   v8::Local<v8::Function> run_callback =
-    v8cpp::to_local<v8::Function>(isolate, run_callback_);
+    v8cpp::to_local<v8::Function>(isolate_, run_callback_);
 
-  v8cpp::call_v8(isolate, run_callback);
+  v8cpp::call_v8(isolate_, run_callback);
 }
 
 unity::scopes::SearchQueryBase::UPtr ScopeBase::search(
       unity::scopes::CannedQuery const &query,
       unity::scopes::SearchMetadata const &metadata) {
+  v8cpp::Locker locker(isolate_);
+
   if (search_callback_.IsEmpty()) {
     return nullptr;
   }
@@ -94,20 +97,18 @@
   CannedQuery *q = new CannedQuery(query);
   SearchMetaData *m = new SearchMetaData(metadata);
 
-  v8::Isolate *isolate = v8::Isolate::GetCurrent();
-
   v8::Local<v8::Function> search_callback =
-    v8cpp::to_local<v8::Function>(isolate, search_callback_);
+    v8cpp::to_local<v8::Function>(isolate_, search_callback_);
 
-  v8::Handle<v8::Value> result = 
-    v8cpp::call_v8(isolate,
+  v8::Handle<v8::Value> result =
+    v8cpp::call_v8(isolate_,
                    search_callback,
-                   v8cpp::to_v8(isolate, q),
-                   v8cpp::to_v8(isolate, m));
+                   v8cpp::to_v8(isolate_, q),
+                   v8cpp::to_v8(isolate_, m));
 
   // TODO watch out release
   SearchQuery * sq = 
-    v8cpp::from_v8<SearchQuery*>(isolate, result);
+    v8cpp::from_v8<SearchQuery*>(isolate_, result);
 
   return unity::scopes::SearchQueryBase::UPtr(sq);
 }
@@ -115,6 +116,8 @@
 unity::scopes::ActivationQueryBase::UPtr ScopeBase::activate(
       unity::scopes::Result const &result,
       unity::scopes::ActionMetadata const &metadata) {
+  v8cpp::Locker locker(isolate_);
+
   return nullptr;
 }
 
@@ -123,12 +126,15 @@
       unity::scopes::ActionMetadata const &metadata,
       std::string const &widget_id,
       std::string const &action_id) {
+  v8cpp::Locker locker(isolate_);
   return nullptr;
 }
 
 unity::scopes::PreviewQueryBase::UPtr ScopeBase::preview(
       unity::scopes::Result const &result,
       unity::scopes::ActionMetadata const &action_metadata) {
+  v8cpp::Locker locker(isolate_);
+
   if (preview_callback_.IsEmpty()) {
     return nullptr;
   }
@@ -137,20 +143,18 @@
   Result *r = new Result(result);
   ActionMetaData *m = new ActionMetaData(action_metadata);
 
-  v8::Isolate *isolate = v8::Isolate::GetCurrent();
-
   v8::Local<v8::Function> preview_callback =
-    v8cpp::to_local<v8::Function>(isolate, preview_callback_);
+    v8cpp::to_local<v8::Function>(isolate_, preview_callback_);
 
   v8::Handle<v8::Value> wrapped_preview = 
-    v8cpp::call_v8(isolate,
+    v8cpp::call_v8(isolate_,
                    preview_callback,
-                   v8cpp::to_v8(isolate, r),
-                   v8cpp::to_v8(isolate, m));
+                   v8cpp::to_v8(isolate_, r),
+                   v8cpp::to_v8(isolate_, m));
 
   // TODO watch out release
   PreviewQuery * sq =
-    v8cpp::from_v8<PreviewQuery*>(isolate, wrapped_preview);
+    v8cpp::from_v8<PreviewQuery*>(isolate_, wrapped_preview);
 
   return unity::scopes::PreviewQueryBase::UPtr(sq);
 }

=== modified file 'src/bindings/src/scope-base.h'
--- src/bindings/src/scope-base.h	2015-07-09 01:02:19 +0000
+++ src/bindings/src/scope-base.h	2015-07-30 13:03:08 +0000
@@ -68,6 +68,7 @@
       std::string const &action_id) override;
 
  private:
+  v8::Isolate* isolate_;
 
   v8::Persistent<v8::Function> start_callback_;
   v8::Persistent<v8::Function> stop_callback_;

=== modified file 'src/bindings/src/scope.cc'
--- src/bindings/src/scope.cc	2015-07-22 09:48:34 +0000
+++ src/bindings/src/scope.cc	2015-07-30 13:03:08 +0000
@@ -28,27 +28,8 @@
 
 JavascriptScopeRuntime::JavascriptScopeRuntime(
       const std::string& config_file)
-      : scope_base_(new ScopeBase()) {
-    std::string current_runtime_config = config_file;
-
-    if (current_runtime_config.empty()) {
-      char * env_runtime_config =
-        std::getenv(kJavascriptUnityRuntimeEnvVarName);
-
-      if (env_runtime_config) {
-        current_runtime_config = env_runtime_config;
-
-        if ( ! boost::ends_with(current_runtime_config, ".ini")) {
-          throw std::runtime_error("Invalid runtime config (ini file)");
-        }
-
-        if (!boost::filesystem::path(current_runtime_config).is_absolute()) {
-          current_runtime_config = boost::filesystem::canonical(current_runtime_config).native();
-        }
-      }
-    }
-
-    runtime_ = unity::scopes::Runtime::create(current_runtime_config);
+      : scope_base_(new ScopeBase()),
+        runtime_config_(config_file) {
 }
 
 JavascriptScopeRuntime::~JavascriptScopeRuntime() {
@@ -64,6 +45,7 @@
     throw std::runtime_error("Scope already running");
   }
 
+  // Configure scope_config_
   std::string current_scope_config = scope_config;
 
   if (current_scope_config.empty()) {
@@ -85,6 +67,31 @@
 
   scope_config_ = current_scope_config;
 
+  // Configure runtime_
+  std::string current_runtime_config = runtime_config_;
+
+  if (current_runtime_config.empty()) {
+    char * env_runtime_config =
+      std::getenv(kJavascriptUnityRuntimeEnvVarName);
+
+    if (env_runtime_config) {
+      current_runtime_config = env_runtime_config;
+
+      if ( ! boost::ends_with(current_runtime_config, ".ini")) {
+        throw std::runtime_error("Invalid runtime config (ini file)");
+      }
+
+      if (!boost::filesystem::path(current_runtime_config).is_absolute()) {
+        current_runtime_config = boost::filesystem::canonical(current_runtime_config).native();
+      }
+    }
+  }
+
+  std::string scope_id = boost::filesystem::path(scope_config_).stem().string();
+  runtime_ = unity::scopes::Runtime::create_scope_runtime(scope_id, current_runtime_config);
+
+  // Unlock access to the main isolate so that our callbacks will work
+  v8cpp::Unlocker unlocker(v8::Isolate::GetCurrent());
   runtime_->run_scope(scope_base_.get(), current_scope_config);
 }
 

=== modified file 'src/bindings/src/scope.h'
--- src/bindings/src/scope.h	2015-07-20 19:24:44 +0000
+++ src/bindings/src/scope.h	2015-07-30 13:03:08 +0000
@@ -43,6 +43,7 @@
 
   unity::scopes::Runtime::UPtr runtime_;
   std::unique_ptr<ScopeBase> scope_base_;
+  std::string runtime_config_;
   std::string scope_config_;
 };
 

=== modified file 'src/bindings/src/search-query.cc'
--- src/bindings/src/search-query.cc	2015-07-09 18:30:28 +0000
+++ src/bindings/src/search-query.cc	2015-07-30 13:03:08 +0000
@@ -28,6 +28,7 @@
       const v8::Local<v8::Function> &run_callback,
       const v8::Local<v8::Function> &cancelled_callback)
   : unity::scopes::SearchQueryBase(query, metadata),
+    isolate_(v8::Isolate::GetCurrent()),
     run_callback_(v8::Isolate::GetCurrent(), run_callback),
     cancelled_callback_(v8::Isolate::GetCurrent(), cancelled_callback) {
 }
@@ -86,12 +87,12 @@
   CannedQuery *q =
     new CannedQuery(unity::scopes::SearchQueryBase::query());
 
-  v8::Isolate *isolate = v8::Isolate::GetCurrent();
-
-  return v8cpp::to_v8(isolate, q);
+  return v8cpp::to_v8(isolate_, q);
 }
 
 void SearchQuery::run(unity::scopes::SearchReplyProxy const& reply) {
+  v8cpp::Locker locker(isolate_);
+
   if (run_callback_.IsEmpty()) {
     return;
   }
@@ -99,27 +100,25 @@
   // wrap & fire
   SearchReply *sr = new SearchReply(reply);
 
-  v8::Isolate *isolate = v8::Isolate::GetCurrent();
-
-  auto wrapped_sr = v8cpp::to_v8(isolate, sr);
+  auto wrapped_sr = v8cpp::to_v8(isolate_, sr);
 
   v8::Local<v8::Function> run_callback =
-    v8cpp::to_local<v8::Function>(isolate, run_callback_);
+    v8cpp::to_local<v8::Function>(isolate_, run_callback_);
 
-  v8cpp::call_v8(isolate, run_callback, wrapped_sr);
+  v8cpp::call_v8(isolate_, run_callback, wrapped_sr);
 }
 
 void SearchQuery::cancelled() {
+  v8cpp::Locker locker(isolate_);
+
   if (cancelled_callback_.IsEmpty()) {
     return;
   }
 
-  v8::Isolate *isolate = v8::Isolate::GetCurrent();
-
   v8::Local<v8::Function> cancelled_callback =
-    v8cpp::to_local<v8::Function>(isolate, cancelled_callback_);
+    v8cpp::to_local<v8::Function>(isolate_, cancelled_callback_);
 
-  v8cpp::call_v8(isolate, cancelled_callback);
+  v8cpp::call_v8(isolate_, cancelled_callback);
 }
 
 v8::Local<v8::Value> SearchQuery::valid(

=== modified file 'src/bindings/src/search-query.h'
--- src/bindings/src/search-query.h	2015-07-09 01:02:19 +0000
+++ src/bindings/src/search-query.h	2015-07-30 13:03:08 +0000
@@ -46,6 +46,7 @@
   void cancelled() override;
 
  private:
+  v8::Isolate* isolate_;
 
   v8::Persistent<v8::Function> run_callback_;
   v8::Persistent<v8::Function> cancelled_callback_;

=== modified file 'src/launcher/CMakeLists.txt'
--- src/launcher/CMakeLists.txt	2015-07-20 21:05:06 +0000
+++ src/launcher/CMakeLists.txt	2015-07-30 13:03:08 +0000
@@ -87,5 +87,10 @@
   dl
   )
 
+add_custom_command(
+  TARGET ${LAUNCHER_EXECUTABLE_NAME} PRE_LINK
+  COMMAND ${CMAKE_SOURCE_DIR}/deps/build.sh
+)
+
 install(TARGETS ${LAUNCHER_EXECUTABLE_NAME}
         RUNTIME DESTINATION /usr/bin)

=== modified file 'src/launcher/main.cc'
--- src/launcher/main.cc	2015-07-22 09:48:34 +0000
+++ src/launcher/main.cc	2015-07-30 13:03:08 +0000
@@ -32,6 +32,7 @@
   std::cout << executable_name()
             << " "
             << "<path-to-scope-ini>"
+            << " "
             << "[<path-to-runtime-ini>]"
             << std::endl;
 }