Bug 1685213 - Part 4: Convert pin check to async. r=bytesized

Differential Revision: https://phabricator.services.mozilla.com/D106346

Author: agashlin

browser/components/shell/nsIWindowsShellService.idl

@@ -57,18 +57,23 @@ interface nsIWindowsShellService : nsISupports
   void checkPinCurrentAppToTaskbar();
 
   /*
-   * Search for the current executable among taskbar pins, return true if found
+   * Search for the current executable among taskbar pins
    *
-   * NOTE: This method probably shouldn't be used on the main thread, it
-   * performs blocking disk I/O.
+   * NOTE: Can only be run on the main thread, but the actual work occurs on a
+   * background thread.
    *
    * NOTE: It is possible for the check to fail even when a taskbar pin refers
    * to this executable, if the paths differ due to e.g. symlinks.
    * It is also possible for the check to succeed with a shortcut that doesn't
    * actually appear on the taskbar.
    * These cases should be rare.
+   *
+   * @return Promise that always resolves, true if pinned, false otherwise
+   * @throws NS_ERROR_NOT_SAME_THREAD if not run on the main thread
+   *
    */
-  boolean isCurrentAppPinnedToTaskbar();
+  [implicit_jscontext]
+  Promise isCurrentAppPinnedToTaskbarAsync();
 
   /*
    * Determine where a given shortcut likely appears in the shell.

browser/components/shell/nsWindowsShellService.cpp

@@ -27,6 +27,8 @@
 #include "nsXULAppAPI.h"
 #include "mozilla/WindowsVersion.h"
 #include "mozilla/dom/Element.h"
+#include "mozilla/dom/Promise.h"
+#include "mozilla/ErrorResult.h"
 #include "mozilla/gfx/2D.h"
 #include "WindowsDefaultBrowser.h"
 
@@ -883,26 +885,23 @@ nsWindowsShellService::CheckPinCurrentAppToTaskbar() {
   return PinCurrentAppToTaskbarImpl(/* aCheckOnly */ true);
 }
 
-NS_IMETHODIMP
-nsWindowsShellService::IsCurrentAppPinnedToTaskbar(/* out */ bool* aIsPinned) {
-  *aIsPinned = false;
-
+static bool IsCurrentAppPinnedToTaskbarSync() {
   wchar_t exePath[MAXPATHLEN] = {};
   if (NS_WARN_IF(NS_FAILED(BinaryPath::GetLong(exePath)))) {
-    return NS_OK;
+    return false;
   }
 
   wchar_t folderChars[MAX_PATH] = {};
   HRESULT hr = SHGetFolderPathW(nullptr, CSIDL_APPDATA, nullptr,
                                 SHGFP_TYPE_CURRENT, folderChars);
   if (NS_WARN_IF(FAILED(hr))) {
-    return NS_OK;
+    return false;
   }
 
   nsAutoString folder;
   folder.Assign(folderChars);
   if (NS_WARN_IF(folder.IsEmpty())) {
-    return NS_OK;
+    return false;
   }
   if (folder[folder.Length() - 1] != '\\') {
     folder.AppendLiteral("\\");
@@ -917,12 +916,13 @@ nsWindowsShellService::IsCurrentAppPinnedToTaskbar(/* out */ bool* aIsPinned) {
   HANDLE hFindFile = FindFirstFileW(pattern.get(), &findData);
   if (hFindFile == INVALID_HANDLE_VALUE) {
     Unused << NS_WARN_IF(GetLastError() != ERROR_FILE_NOT_FOUND);
-    return NS_OK;
+    return false;
   }
   // Past this point we don't return until the end of the function,
   // when FindClose() is called.
 
   // Check all shortcuts until a match is found
+  bool isPinned = false;
   do {
     nsAutoString fileName;
     fileName.Assign(folder);
@@ -965,13 +965,57 @@ nsWindowsShellService::IsCurrentAppPinnedToTaskbar(/* out */ bool* aIsPinned) {
     // NOTE: Because this compares the path directly, it is possible to
     // have a false negative mismatch.
     if (wcsnicmp(storedExePath, exePath, MAXPATHLEN) == 0) {
-      *aIsPinned = true;
+      isPinned = true;
       break;
     }
   } while (FindNextFileW(hFindFile, &findData));
 
   FindClose(hFindFile);
 
+  return isPinned;
+}
+
+NS_IMETHODIMP
+nsWindowsShellService::IsCurrentAppPinnedToTaskbarAsync(
+    JSContext* aCx, /* out */ dom::Promise** aPromise) {
+  if (!NS_IsMainThread()) {
+    return NS_ERROR_NOT_SAME_THREAD;
+  }
+
+  ErrorResult rv;
+  RefPtr<dom::Promise> promise =
+      dom::Promise::Create(xpc::CurrentNativeGlobal(aCx), rv);
+  if (MOZ_UNLIKELY(rv.Failed())) {
+    return rv.StealNSResult();
+  }
+
+  // A holder to pass the promise through the background task and back to
+  // the main thread when finished.
+  auto promiseHolder = MakeRefPtr<nsMainThreadPtrHolder<dom::Promise>>(
+      "IsCurrentAppPinnedToTaskbarAsync promise", promise);
+
+  NS_DispatchBackgroundTask(
+      NS_NewRunnableFunction(
+          "IsCurrentAppPinnedToTaskbarAsync",
+          [promiseHolder = std::move(promiseHolder)] {
+            bool isPinned = false;
+
+            HRESULT hr = CoInitialize(nullptr);
+            if (SUCCEEDED(hr)) {
+              isPinned = IsCurrentAppPinnedToTaskbarSync();
+              CoUninitialize();
+            }
+
+            // Dispatch back to the main thread to resolve the promise.
+            NS_DispatchToMainThread(NS_NewRunnableFunction(
+                "IsCurrentAppPinnedToTaskbarAsync callback",
+                [isPinned, promiseHolder = std::move(promiseHolder)] {
+                  promiseHolder.get()->get()->MaybeResolve(isPinned);
+                }));
+          }),
+      NS_DISPATCH_EVENT_MAY_BLOCK);
+
+  promise.forget(aPromise);
   return NS_OK;
 }