Merge lp:~jamesh/libunity/search-changed into lp:libunity

[James Henstridge]

Add an API to Unity.AbstractScope to let the scope indicate that its results have changed.

Add a Unity.AbstractScope.queue_search_changed(search_type) API to allow a scope to indicate that its results have changed.

This is implemented as a signal on AbstractScope, with ScopeDBusConnector connecting to that signal and running logic equivalent to what DeprecatedScope does.

[James Henstridge (jamesh)]

And, yes I do need to hook up some tests.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:262
http://jenkins.qa.ubuntu.com/job/libunity-ci/73/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/libunity-saucy-amd64-ci/58/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/libunity-saucy-armhf-ci/58/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/libunity-saucy-i386-ci/58/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/libunity-ci/73/rebuild

review: Needs Fixing (continuous-integration)

[Michal Hruby (mhr3)]

46 + // FIXME: queue new search

Please remove this, the scope API is completely pull now, no push. So this isn't possible.

[lp:~jamesh/libunity/search-changed]

263. By James Henstridge on 2013-07-22

Rename to results_invalidated to match D-Bus API.

264. By James Henstridge on 2013-07-22

Add a test showing that the results_invalidated signal gets fired on the
remote side.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:264
http://jenkins.qa.ubuntu.com/job/libunity-ci/74/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/libunity-saucy-amd64-ci/59/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/libunity-saucy-armhf-ci/59/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/libunity-saucy-i386-ci/59/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/libunity-ci/74/rebuild

review: Needs Fixing (continuous-integration)

[lp:~jamesh/libunity/search-changed]

265. By James Henstridge on 2013-07-22

Another renaming based on discussions with mhr3 on IRC.

266. By James Henstridge on 2013-07-22

Update symbols.

[Michal Hruby (mhr3)]

Looking good, just one simplification:

126 + uint tid = Timeout.add (500, () => { ml.quit (); return false; });
127 + ml.run ();

Could you please change this to assert(run_with_timeout(ml)) ?

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:266
http://jenkins.qa.ubuntu.com/job/libunity-ci/75/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-amd64-ci/60
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-armhf-ci/60
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-i386-ci/60

Click here to trigger a rebuild:
http://s-jenkins:8080/job/libunity-ci/75/rebuild

review: Approve (continuous-integration)

[lp:~jamesh/libunity/search-changed]

267. By James Henstridge on 2013-07-22

Use run_with_timeout ().

[Michal Hruby (mhr3)]

+1

review: Approve

=== modified file 'debian/libunity9.symbols'
--- debian/libunity9.symbols	2013-07-19 03:16:32 +0000
+++ debian/libunity9.symbols	2013-07-22 11:26:23 +0000
@@ -59,6 +59,7 @@
  unity_abstract_scope_get_type@Base 7.0.0daily13.05.31ubuntu.unity.next
  unity_abstract_scope_get_unique_name@Base 7.0.0daily13.05.31ubuntu.unity.next
  unity_abstract_scope_normalize_search_query@Base 7.0.0daily13.05.31ubuntu.unity.next
+ unity_abstract_scope_results_invalidated@Base 0replaceme
  unity_activation_response_construct@Base 4.0.0
  unity_activation_response_construct_with_preview@Base 5.90.0
  unity_activation_response_get_goto_uri@Base 4.0.0

=== modified file 'src/unity-scope-dbus-impl.vala'
--- src/unity-scope-dbus-impl.vala	2013-07-17 15:18:49 +0000
+++ src/unity-scope-dbus-impl.vala	2013-07-22 11:26:23 +0000
@@ -53,6 +53,7 @@
   private DBusConnection? _dbus_connection;
   private Rand _rand;
   private uint _timeout_source_id;
+  private ulong _scope_results_invalidated_id;
   private bool _query_happened;
 
   public Dee.SerializableModel categories_model { get; set; }
@@ -144,10 +145,18 @@
     _dbus_connection = Bus.get_sync (BusType.SESSION);
     _dbus_id = _dbus_connection.register_object (_dbus_name,
                                                  this as ScopeService);
+
+    _scope_results_invalidated_id = owner.results_invalidated_internal.connect(
+      on_scope_results_invalidated);
   }
 
   public void unexport ()
   {
+    if (_scope_results_invalidated_id != 0)
+    {
+      owner.disconnect (_scope_results_invalidated_id);
+    }
+
     if (_dbus_id != 0)
     {
       _dbus_connection.unregister_object (_dbus_id);
@@ -284,6 +293,24 @@
     if (found_iter) this.notify_property ("filters");
   }
 
+  private void on_scope_results_invalidated (SearchType search_type)
+  {
+    ChannelType channel_type = search_type == SearchType.DEFAULT ?
+      ChannelType.DEFAULT : ChannelType.GLOBAL;
+
+    foreach (var channel in _channels.get_values ())
+    {
+      if (channel.channel_type == channel_type)
+      {
+        var search = channel.last_search;
+        if (search != null) search.search_context.cancellable.cancel ();
+        channel.last_search = null;
+        // FIXME: queue new search
+      }
+    }
+    this.results_invalidated (channel_type);
+  }
+
   private SearchMetadata create_search_metadata (HashTable<string, Variant> hints)
   {
     var metadata_hints = new HashTable<string, Variant> (str_hash, str_equal);

=== modified file 'src/unity-scope-interface.vala'
--- src/unity-scope-interface.vala	2013-07-19 03:14:22 +0000
+++ src/unity-scope-interface.vala	2013-07-22 11:26:23 +0000
@@ -433,6 +433,21 @@
   {
     return search_query;
   }
+
+  /**
+   * Invalidate previously sent results.
+   *
+   * If a scope knows that results it has sent out previously are no
+   * longer valid, it can call this function to notify any interested
+   * parties that they may want to perform a new search.
+   */
+  public void results_invalidated (SearchType search_type)
+    requires (search_type < SearchType.N_TYPES)
+  {
+    this.results_invalidated_internal (search_type);
+  }
+
+  public signal void results_invalidated_internal (SearchType search_type);
 }
 
 } /* namespace Unity */

=== modified file 'test/vala/test-scope.vala'
--- test/vala/test-scope.vala	2013-07-19 03:14:22 +0000
+++ test/vala/test-scope.vala	2013-07-22 11:26:23 +0000
@@ -73,6 +73,8 @@
         Fixture.create<ScopeTester> (ScopeTester.test_scope_filters));
     Test.add_data_func ("/Unit/Scope/FormFactor",
         Fixture.create<ScopeTester> (ScopeTester.test_scope_form_factor));
+    Test.add_data_func ("/Unit/Scope/ResultsInvalidated",
+        Fixture.create<ScopeTester> (ScopeTester.test_scope_results_invalidated));
 
 
     Test.add_data_func ("/Unit/SimpleScope/Search",
@@ -912,6 +914,25 @@
       });
       assert (form_factor == "phone");
     }
+
+    public void test_scope_results_invalidated ()
+    {
+      var ml = new MainLoop ();
+      bool got_signal = false;
+      ChannelType channel_type = 0;
+      proxy.results_invalidated.connect ((type) =>
+        {
+          got_signal = true;
+          channel_type = type;
+          ml.quit ();
+        });
+      scope.results_invalidated (Unity.SearchType.GLOBAL);
+
+      // Ensure that the test does not hang
+      assert (run_with_timeout (ml));
+      assert (got_signal = true);
+      assert (channel_type == ChannelType.GLOBAL);
+    }
   }
 
   class SimpleScopeTester: Object, Fixture