Merge lp:~abreu-alexandre/unity-js-scopes/handle-perform-action into lp:unity-js-scopes

[Alexandre Abreu]

Handle scope perform_action callback

Handle scope perform_action callback

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:129
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/78/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/79
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/79
        deb: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/79/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/78

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/78/rebuild

review: Approve (continuous-integration)

[Marcus Tomlinson (marcustomlinson)]

Hey Alex, seeing that I'm away. I think a good candidate to review this branch would be Michael Weimann himself (the bug originator).

I think let's provide him with a build of this branch as ask that he give it a go.

If Michael's happy, then we're happy :)

[lp:~abreu-alexandre/unity-js-scopes/handle-perform-action]

130. By Alexandre Abreu on 2016-02-12

Tweaks

[Alberto Mardegan (mardy)]

LGTM, but consider that I'm not familiar with the project at all. :-)

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:130
http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/79/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-amd64-ci/80
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/80
        deb: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-ci/80/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-i386-ci/79

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/79/rebuild

review: Approve (continuous-integration)

=== modified file 'examples/soundcloud/soundcloud.js'
--- examples/soundcloud/soundcloud.js	2015-11-19 21:17:02 +0000
+++ examples/soundcloud/soundcloud.js	2016-02-12 15:02:06 +0000
@@ -61,7 +61,9 @@
                     track_results.push({
                         id: results[i].id,
                         art: results[i].artwork_url ? results[i].artwork_url : "",
+                        streamable: results[i].streamable,
                         stream_url: results[i].stream_url,
+                        duration: results[i].duration,
                         uri: results[i].uri,
                         description: results[i].description,
                         genre: results[i].genre,
@@ -93,7 +95,12 @@
     categorised_result.set_art(result.art);
 
     categorised_result.set("artist", result.artist.username);
-    categorised_result.set("stream", result.artist.stream_url);
+    categorised_result.set("stream", result.stream_url);
+    categorised_result.set("duration", result.duration);
+    categorised_result.set("audio-data", {
+        "uri": result.stream_url,
+        "duration": result.duration
+    });
 
     return categorised_result
 }
@@ -104,14 +111,19 @@
       \"template\": { \
         \"category-layout\": \"grid\", \
         \"card-layout\": \"horizontal\", \
-        \"card-size\": \"large\" \
+        \"card-size\": \"large\", \
+        \"quick-preview-type\" : \"audio\" \
       }, \
       \"components\": { \
         \"title\": \"title\", \
         \"art\" : { \
-          \"field\": \"art\" \
+          \"field\": \"art\", \
+          \"conciergeMode\": true \
         }, \
-        \"subtitle\": \"artist\" \
+        \"subtitle\": \"artist\", \
+        \"quick-preview-data\": { \
+          \"field\": \"audio-data\" \
+        } \
       } \
     }";
 
@@ -192,11 +204,21 @@
             var actions_widget = new scopes.lib.PreviewWidget("actionsId", "actions");
             actions_widget.add_attribute_value(
                 "actions",
-                {
-                    "id": "open",
-                    "label": "Open",
-                    "uri": r.get("uri")
-                }
+                [
+                    {
+                      "id": "open",
+                      "label": "Open",
+                      "uri": r.get("uri")
+                    },
+                    {
+                      "id": "download",
+                      "label": "Download"
+                    },
+                    {
+                      "id": "test",
+                      "label": "Test"
+                    }
+                ]
             );
             preview_reply.push([header_widget, art_widget, actions_widget])
             preview_reply.finished()
@@ -222,5 +244,9 @@
         },
         search: on_search,
         preview: on_preview,
+        perform_action: function(result, metadata, widget_id, action_id) {
+            console.log('Action performed', widget_id, action_id)
+            return null
+        }
     }
 );

=== modified file 'src/bindings/index.js'
--- src/bindings/index.js	2016-01-11 14:22:53 +0000
+++ src/bindings/index.js	2016-02-12 15:02:06 +0000
@@ -62,7 +62,7 @@
      *         - starting {Function(String: scope_id)}: Callback called by the scopes run time after the create function completes
      *         - stop {Function()}: Callback called by the scopes run time when the scope should shut down
      *         - search {Function(CannedQuery: canned_query, SearchMetaData: metadata)}: Callback called by the scopes run time when a scope needs to instantiate a query
-     *         - perform_action {Function(Result: result, ActionMetaData: metadata, String: widget_id, String: ation_id)}: Callback invoked when a scope is requested to handle a preview action
+     *         - perform_action {Function(Result: result, ActionMetaData: metadata, String: widget_id, String: action_id)}: Callback invoked when a scope is requested to handle a preview action
      *         - preview {Function(Result: result, ActionMetaData: metadata)}: Callback invoked when a scope is requested to create a preview for a particular result
      *
      * @example
@@ -111,6 +111,10 @@
             this._base.onpreview(runtime_config.preview);
         }
 
+        if (runtime_config.perform_action && typeof(runtime_config.perform_action) === 'function') {
+            this._base.onperform_action(runtime_config.perform_action);
+        }
+
         if (runtime_config.activate && typeof(runtime_config.activate) === 'function') {
             // this._base.onactivate(runtime_config.activate);
         }

=== modified file 'src/bindings/src/addon.cc'
--- src/bindings/src/addon.cc	2016-01-08 15:39:04 +0000
+++ src/bindings/src/addon.cc	2016-02-12 15:02:06 +0000
@@ -130,6 +130,7 @@
       .add_method("onrun", &ScopeBase::onrun)
       .add_method("onsearch", &ScopeBase::onsearch)
       .add_method("onpreview", &ScopeBase::onpreview)
+      .add_method("onperform_action", &ScopeBase::onperform_action)
       .add_method("registry", &ScopeBase::get_registry)
       // unity::scopes::ScopeBase
       .add_method("scope_directory", &unity::scopes::ScopeBase::scope_directory)

=== modified file 'src/bindings/src/scope-base.cc'
--- src/bindings/src/scope-base.cc	2015-10-28 18:46:50 +0000
+++ src/bindings/src/scope-base.cc	2016-02-12 15:02:06 +0000
@@ -34,18 +34,20 @@
   : isolate_(v8::Isolate::GetCurrent()) {
 }
 ScopeBase::~ScopeBase() {
-  if ( ! start_callback_.IsEmpty()) {
-    start_callback_.Reset();
-  }
-  if ( ! stop_callback_.IsEmpty()) {
-    stop_callback_.Reset();
-  }
-  if ( ! run_callback_.IsEmpty()) {
-    run_callback_.Reset();
-  }
-  if ( ! search_callback_.IsEmpty()) {
-    search_callback_.Reset();
-  }
+#if defined(SCOPE_JS_DELETE_CALLBACK)
+#error "Duplicate SCOPE_JS_DELETE_CALLBACK definitions"
+#endif
+
+#define SCOPE_JS_DELETE_CALLBACK(cb) \
+  do { if ( ! cb.IsEmpty()) cb.Reset(); } while(0)
+
+  SCOPE_JS_DELETE_CALLBACK(start_callback_);
+  SCOPE_JS_DELETE_CALLBACK(stop_callback_);
+  SCOPE_JS_DELETE_CALLBACK(run_callback_);
+  SCOPE_JS_DELETE_CALLBACK(search_callback_);
+  SCOPE_JS_DELETE_CALLBACK(perform_action_callback_);
+
+#undef SCOPE_JS_DELETE_CALLBACK
 }
 
 void ScopeBase::start(std::string const& scope_id) {
@@ -130,6 +132,10 @@
     std::shared_ptr<SearchQuery> sq =
       v8cpp::from_v8<std::shared_ptr<SearchQuery>>(isolate_, result);
 
+    if (!sq) {
+      return unity::scopes::SearchQueryBase::UPtr(nullptr);
+    }
+
     return unity::scopes::SearchQueryBase::UPtr(new SearchQueryProxy(sq));
   });
 }
@@ -177,6 +183,9 @@
       v8cpp::from_v8<std::shared_ptr<ActivationQuery>>(
           isolate_,
           wrapped_activation_query);
+    if (!aq) {
+      return unity::scopes::ActivationQueryBase::UPtr(nullptr);
+    }
 
     return unity::scopes::ActivationQueryBase::UPtr(new ActivationQueryProxy(aq));
   });
@@ -216,6 +225,10 @@
           isolate_,
           wrapped_preview);
 
+    if (!sq) {
+      return unity::scopes::PreviewQueryBase::UPtr(nullptr);
+    }
+
     return unity::scopes::PreviewQueryBase::UPtr(new PreviewQueryProxy(sq));
   });
 }
@@ -232,10 +245,6 @@
     return;
   }
 
-  if (start_callback_.IsEmpty()) {
-    start_callback_.Reset();
-  }
-
   v8::Local<v8::Function> cb = v8::Handle<v8::Function>::Cast(args[0]);
   start_callback_.Reset(args.GetIsolate(), cb);
 }
@@ -252,10 +261,6 @@
     return;
   }
 
-  if (stop_callback_.IsEmpty()) {
-    stop_callback_.Reset();
-  }
-
   v8::Local<v8::Function> cb = v8::Handle<v8::Function>::Cast(args[0]);
   stop_callback_.Reset(args.GetIsolate(), cb);
 }
@@ -272,10 +277,6 @@
     return;
   }
 
-  if (run_callback_.IsEmpty()) {
-    run_callback_.Reset();
-  }
-
   v8::Local<v8::Function> cb = v8::Handle<v8::Function>::Cast(args[0]);
   run_callback_.Reset(args.GetIsolate(), cb);
 }
@@ -292,10 +293,6 @@
     return;
   }
 
-  if (search_callback_.IsEmpty()) {
-    search_callback_.Reset();
-  }
-
   v8::Local<v8::Function> cb = v8::Handle<v8::Function>::Cast(args[0]);
   search_callback_.Reset(args.GetIsolate(), cb);
 }
@@ -312,14 +309,26 @@
     return;
   }
 
-  if (preview_callback_.IsEmpty()) {
-    preview_callback_.Reset();
-  }
-
   v8::Local<v8::Function> cb = v8::Handle<v8::Function>::Cast(args[0]);
   preview_callback_.Reset(args.GetIsolate(), cb);
 }
 
+void ScopeBase::onperform_action(
+      v8::FunctionCallbackInfo<v8::Value> const& args) {
+  if (args.Length() != 1) {
+    // TODO fix
+    return;
+  }
+
+  if (!args[0]->IsFunction()) {
+    // TODO fix
+    return;
+  }
+
+  v8::Local<v8::Function> cb = v8::Handle<v8::Function>::Cast(args[0]);
+  perform_action_callback_.Reset(args.GetIsolate(), cb);
+}
+
 std::shared_ptr<Registry> ScopeBase::get_registry() const {
   return std::shared_ptr<Registry>(new Registry(registry()));
 }

=== modified file 'src/bindings/src/scope-base.h'
--- src/bindings/src/scope-base.h	2015-10-21 14:17:12 +0000
+++ src/bindings/src/scope-base.h	2016-02-12 15:02:06 +0000
@@ -38,7 +38,6 @@
 
   void onsearch(v8::FunctionCallbackInfo<v8::Value> const& args);
   void onpreview(v8::FunctionCallbackInfo<v8::Value> const& args);
-  void onactivate(v8::FunctionCallbackInfo<v8::Value> const& args);
   void onperform_action(v8::FunctionCallbackInfo<v8::Value> const& args);
 
   std::shared_ptr<Registry> get_registry() const;
@@ -75,7 +74,6 @@
 
   v8::Persistent<v8::Function> search_callback_;
   v8::Persistent<v8::Function> preview_callback_;
-  v8::Persistent<v8::Function> activate_callback_;
   v8::Persistent<v8::Function> perform_action_callback_;
 };