Merge ~3v1n0/ubuntu/+source/gnome-shell:ubuntu/bionic-xubuntu-cancel-search into ~ubuntu-desktop/ubuntu/+source/gnome-shell:ubuntu/bionic

[Marco Trevisan (Treviño)]

Reproposing after the revert...

[Iain Lane (laney)]

I'm currently dealing with some horrible rebases due to Ubuntu patches in nautilus, e.g. <https://bugzilla.gnome.org/show_bug.cgi?id=758833>.

How can we be sure that this XUbuntuCancel stuff isn't going to end up in the same state?

[Marco Trevisan (Treviño) (3v1n0)]

I totally hope the same.

I just wish the upstream issue I opened to move with a proper fix will move, because I can't do much other than propose stuff, and ask for some discussion.

7744a4c... by Marco Trevisan (Treviño) on 2019-10-25

debian/rules: Honour nocheck parameter

381a8a6... by Marco Trevisan (Treviño) on 2019-10-25

Update changelog

c689ab3... by Marco Trevisan (Treviño) on 2019-10-25

Finalise changelog

[Marco Trevisan (Treviño) (3v1n0)]

Ok, I've finally rebased this.

Unmerged commits

c689ab3... by Marco Trevisan (Treviño) on 2019-10-25

Finalise changelog

381a8a6... by Marco Trevisan (Treviño) on 2019-10-25

Update changelog

7744a4c... by Marco Trevisan (Treviño) on 2019-10-25

debian/rules: Honour nocheck parameter

87d3119... by Marco Trevisan (Treviño) on 2018-08-27

debian/patches: add support for XUbuntuCancel on remote search provider

Fixes LP: #1756826

diff --git a/debian/changelog b/debian/changelog
index 6ef6396..9871aec 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,12 @@
+gnome-shell (3.28.4-0ubuntu18.04.3) bionic; urgency=medium
+
+  * d/p/ubuntu/search-call-XUbuntuCancel-method-on-providers-when-no-dat.patch:
+    - Add support for cancelling remote search providers when the overlay
+      is closed (and actually stop searches when requested from UI, LP: #1756826)
+  * debian/rules: Honour nocheck parameter
+
+ -- Marco Trevisan (Treviño) <[e-mail]>  Fri, 25 Oct 2019 05:23:08 +0200
+
 gnome-shell (3.28.4-0ubuntu18.04.2) bionic; urgency=medium
 
   * d/p/osk-layouts-Fix-French-layout.patch:
diff --git a/debian/patches/series b/debian/patches/series
index da5bfc2..5e82144 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -26,3 +26,4 @@ CVE-2019-3820-2.patch
 switchMonitor-switch-to-next-config-upon-initial-keypress.patch
 st-widget-Add-missing-g_return_val_if_fail.patch
 osk-layouts-Fix-French-layout.patch
+ubuntu/search-call-XUbuntuCancel-method-on-providers-when-no-dat.patch
diff --git a/debian/patches/ubuntu/search-call-XUbuntuCancel-method-on-providers-when-no-dat.patch b/debian/patches/ubuntu/search-call-XUbuntuCancel-method-on-providers-when-no-dat.patch
new file mode 100644
index 0000000..601a8ec
--- /dev/null
+++ b/debian/patches/ubuntu/search-call-XUbuntuCancel-method-on-providers-when-no-dat.patch
@@ -0,0 +1,167 @@
+From: =?utf-8?b?Ik1hcmNvIFRyZXZpc2FuIChUcmV2acOxbyki?= <[e-mail]>
+Date: Thu, 23 Aug 2018 20:00:57 +0200
+Subject: search: call XUbuntuCancel method on providers when no data is
+ needed
+
+Add XUbuntuCancel method to search providers and call it when a search provider
+is still doing operations.
+Ignore the result when the method does not exist or is cancelled.
+
+This will allow to stop operations on providers.
+
+Fixes LP: #1756826
+
+Bug-GNOME: https://gitlab.gnome.org/GNOME/gnome-shell/issues/183
+Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/bionic/+source/gnome-shell/+bug/1756826
+Forwarded: not-needed
+---
+ data/org.gnome.ShellSearchProvider.xml  |  6 ++++++
+ data/org.gnome.ShellSearchProvider2.xml |  6 ++++++
+ js/ui/remoteSearch.js                   | 15 +++++++++++++++
+ js/ui/search.js                         | 34 +++++++++++++++++++++++++++++++++
+ 4 files changed, 61 insertions(+)
+
+diff --git a/data/org.gnome.ShellSearchProvider.xml b/data/org.gnome.ShellSearchProvider.xml
+index 78ad305..393cb01 100644
+--- a/data/org.gnome.ShellSearchProvider.xml
++++ b/data/org.gnome.ShellSearchProvider.xml
+@@ -69,5 +69,11 @@
+     <method name="ActivateResult">
+       <arg type="s" name="identifier" direction="in" />
+     </method>
++
++    <!--
++        XUbuntuCancel:
++        Cancel the current search operation
++    -->
++    <method name="XUbuntuCancel" />
+   </interface>
+ </node>
+diff --git a/data/org.gnome.ShellSearchProvider2.xml b/data/org.gnome.ShellSearchProvider2.xml
+index 9502340..8141bc0 100644
+--- a/data/org.gnome.ShellSearchProvider2.xml
++++ b/data/org.gnome.ShellSearchProvider2.xml
+@@ -83,5 +83,11 @@
+       <arg type="as" name="terms" direction="in" />
+       <arg type="u" name="timestamp" direction="in" />
+     </method>
++
++    <!--
++        XUbuntuCancel:
++        Cancel the current search operation
++    -->
++    <method name="XUbuntuCancel" />
+   </interface>
+ </node>
+diff --git a/js/ui/remoteSearch.js b/js/ui/remoteSearch.js
+index c6c5a29..8de6148 100644
+--- a/js/ui/remoteSearch.js
++++ b/js/ui/remoteSearch.js
+@@ -30,6 +30,7 @@ const SearchProviderIface = '<node> \
+ <method name="ActivateResult"> \
+     <arg type="s" direction="in" /> \
+ </method> \
++<method name="XUbuntuCancel" /> \
+ </interface> \
+ </node>';
+ 
+@@ -57,6 +58,7 @@ const SearchProvider2Iface = '<node> \
+     <arg type="as" direction="in" /> \
+     <arg type="u" direction="in" /> \
+ </method> \
++<method name="XUbuntuCancel" /> \
+ </interface> \
+ </node>';
+ 
+@@ -310,6 +312,19 @@ var RemoteSearchProvider = new Lang.Class({
+                                         cancellable);
+     },
+ 
++    XUbuntuCancel(cancellable, callback) {
++        this.proxy.XUbuntuCancelRemote((results, error) => {
++                if (error &&
++                    !error.matches(Gio.DBusError, Gio.DBusError.UNKNOWN_METHOD) &&
++                    !error.matches(Gio.IOErrorEnum, Gio.IOErrorEnum.CANCELLED)) {
++                    log('Received error from DBus search provider %s during XUbuntuCancel: %s'.format(this.id, String(error)));
++                } else if (callback && !error) {
++                    callback();
++                }
++            },
++            cancellable);
++    },
++
+     activateResult(id) {
+         this.proxy.ActivateResultRemote(id);
+     },
+diff --git a/js/ui/search.js b/js/ui/search.js
+index 3966741..c67feea 100644
+--- a/js/ui/search.js
++++ b/js/ui/search.js
+@@ -225,7 +225,9 @@ var SearchResultsBase = new Lang.Class({
+             this._cancellable.cancel();
+             this._cancellable.reset();
+ 
++            this.provider.resultsMetasInProgress = true;
+             this.provider.getResultMetas(metasNeeded, metas => {
++                this.provider.resultsMetasInProgress = this._cancellable.is_cancelled();
+                 if (this._cancellable.is_cancelled()) {
+                     if (metas.length > 0)
+                         log(`Search provider ${this.provider.id} returned results after the request was canceled`);
+@@ -455,6 +457,10 @@ var SearchResults = new Lang.Class({
+ 
+         this._searchTimeoutId = 0;
+         this._cancellable = new Gio.Cancellable();
++        this._searchCancelCancellable = new Gio.Cancellable();
++        this._cancellable.connect(() => {
++            this._cancelSearchProviderRequest();
++        });
+ 
+         this._registerProvider(new AppDisplay.AppSearchProvider());
+         this._reloadRemoteProviders();
+@@ -496,11 +502,32 @@ var SearchResults = new Lang.Class({
+         }
+     },
+ 
++    _cancelSearchProviderRequest() {
++        if (this._terms.length != 0 || this._searchCancelTimeoutId > 0)
++            return;
++
++        this._searchCancelTimeoutId = GLib.timeout_add(GLib.PRIORITY_DEFAULT, 100, () => {
++            this._providers.forEach(provider => {
++                if (provider.isRemoteProvider &&
++                    (provider.searchInProgress || provider.resultsMetasInProgress)) {
++                    provider.XUbuntuCancel(this._searchCancelCancellable, () => {
++                        provider.searchInProgress = false;
++                        provider.resultsMetasInProgress = false;
++                    });
++                }
++            });
++
++            delete this._searchCancelTimeoutId;
++            return GLib.SOURCE_REMOVE;
++        });
++    },
++
+     _reset() {
+         this._terms = [];
+         this._results = {};
+         this._clearDisplay();
+         this._clearSearchTimeout();
++        this._cancelSearchProviderRequest();
+         this._defaultResult = null;
+         this._startingSearch = false;
+ 
+@@ -567,6 +594,13 @@ var SearchResults = new Lang.Class({
+         if (this._terms.length > 0)
+             isSubSearch = searchString.indexOf(previousSearchString) == 0;
+ 
++        this._searchCancelCancellable.cancel();
++        this._searchCancelCancellable.reset();
++        if (this._searchCancelTimeoutId > 0) {
++            GLib.source_remove(this._searchCancelTimeoutId);
++            delete this._searchCancelTimeoutId;
++        }
++
+         this._terms = terms;
+         this._isSubSearch = isSubSearch;
+         this._updateSearchProgress();
diff --git a/debian/rules b/debian/rules
index 00fe711..4f2b3fb 100755
--- a/debian/rules
+++ b/debian/rules
@@ -52,4 +52,6 @@ override_dh_strip:
 	dh_strip --dbgsym-migration='gnome-shell-dbg (<< 3.20.2-2~)'
 
 override_dh_auto_test:
+ifeq (,$(filter nocheck,$(DEB_BUILD_OPTIONS)))
 	xvfb-run dh_auto_test
+endif