Clients.matchAll() should return ordered clients by type/focus time/creation time

content/browser/service_worker/service_worker_client_utils.cc

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "content/browser/service_worker/service_worker_client_utils.h"
 
 #include <algorithm>
 #include <tuple>
 
 #include "base/location.h"
@@ skipping 84 matching lines @@
 
   int frame_tree_node_id_;
   const OpenURLCallback callback_;
 
   DISALLOW_COPY_AND_ASSIGN(OpenURLObserver);
 };
 
 ServiceWorkerClientInfo GetWindowClientInfoOnUI(
     int render_process_id,
     int render_frame_id,
+    base::TimeTicks create_time,
     const std::string& client_uuid) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   RenderFrameHostImpl* render_frame_host =
       RenderFrameHostImpl::FromID(render_process_id, render_frame_id);
   if (!render_frame_host)
     return ServiceWorkerClientInfo();
 
   // TODO(mlamouri,michaeln): it is possible to end up collecting information
   // for a frame that is actually being navigated and isn't exactly what we are
   // expecting.
   return ServiceWorkerClientInfo(
       client_uuid, render_frame_host->GetVisibilityState(),
       render_frame_host->IsFocused(), render_frame_host->GetLastCommittedURL(),
       render_frame_host->GetParent() ? REQUEST_CONTEXT_FRAME_TYPE_NESTED
                                      : REQUEST_CONTEXT_FRAME_TYPE_TOP_LEVEL,
-      render_frame_host->frame_tree_node()->last_focus_time(),
+      render_frame_host->frame_tree_node()->last_focus_time(), create_time,
       blink::kWebServiceWorkerClientTypeWindow);
 }
 
 ServiceWorkerClientInfo FocusOnUI(int render_process_id,
                                   int render_frame_id,
+                                  base::TimeTicks create_time,
                                   const std::string& client_uuid) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   RenderFrameHostImpl* render_frame_host =
       RenderFrameHostImpl::FromID(render_process_id, render_frame_id);
   WebContentsImpl* web_contents = static_cast<WebContentsImpl*>(
       WebContents::FromRenderFrameHost(render_frame_host));
 
   if (!render_frame_host || !web_contents)
     return ServiceWorkerClientInfo();
 
   FrameTreeNode* frame_tree_node = render_frame_host->frame_tree_node();
 
   // Focus the frame in the frame tree node, in case it has changed.
   frame_tree_node->frame_tree()->SetFocusedFrame(
       frame_tree_node, render_frame_host->GetSiteInstance());
 
   // Focus the frame's view to make sure the frame is now considered as focused.
   render_frame_host->GetView()->Focus();
 
   // Move the web contents to the foreground.
   web_contents->Activate();
 
   return GetWindowClientInfoOnUI(render_process_id, render_frame_id,
-                                 client_uuid);
+                                 create_time, client_uuid);
 }
 
 // This is only called for main frame navigations in OpenWindowOnUI().
 void DidOpenURLOnUI(const OpenURLCallback& callback,
                     WebContents* web_contents) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 
   if (!web_contents) {
     BrowserThread::PostTask(
         BrowserThread::IO, FROM_HERE,
@@ skipping 107 matching lines @@
            context->GetClientProviderHostIterator(origin);
        !it->IsAtEnd(); it->Advance()) {
     ServiceWorkerProviderHost* provider_host = it->GetProviderHost();
     if (provider_host->process_id() != render_process_id ||
         provider_host->frame_id() != render_frame_id) {
       continue;
     }
     BrowserThread::PostTaskAndReplyWithResult(
         BrowserThread::UI, FROM_HERE,
         base::Bind(&GetWindowClientInfoOnUI, provider_host->process_id(),
-                   provider_host->route_id(), provider_host->client_uuid()),
+                   provider_host->route_id(), provider_host->create_time(),
+                   provider_host->client_uuid()),
         base::Bind(callback, SERVICE_WORKER_OK));
     return;
   }
 
   // If here, it means that no provider_host was found, in which case, the
   // renderer should still be informed that the window was opened.
   callback.Run(SERVICE_WORKER_OK, ServiceWorkerClientInfo());
 }
 
 void AddWindowClient(
     ServiceWorkerProviderHost* host,
-    std::vector<std::tuple<int, int, std::string>>* client_info) {
+    std::vector<std::tuple<int, int, base::TimeTicks, std::string>>*
+        client_info) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   if (host->client_type() != blink::kWebServiceWorkerClientTypeWindow)
     return;
   client_info->push_back(std::make_tuple(host->process_id(), host->frame_id(),
+                                         host->create_time(),
                                          host->client_uuid()));
 }
 
 void AddNonWindowClient(ServiceWorkerProviderHost* host,
                         const ServiceWorkerClientQueryOptions& options,
                         ServiceWorkerClients* clients) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   blink::WebServiceWorkerClientType host_client_type = host->client_type();
   if (host_client_type == blink::kWebServiceWorkerClientTypeWindow)
     return;
   if (options.client_type != blink::kWebServiceWorkerClientTypeAll &&
       options.client_type != host_client_type)
     return;
 
   ServiceWorkerClientInfo client_info(
       host->client_uuid(), blink::kWebPageVisibilityStateHidden,
       false,  // is_focused
       host->document_url(), REQUEST_CONTEXT_FRAME_TYPE_NONE, base::TimeTicks(),
-      host_client_type);
+      host->create_time(), host_client_type);
   clients->push_back(client_info);
 }
 
 void OnGetWindowClientsOnUI(
     // The tuple contains process_id, frame_id, client_uuid.
-    const std::vector<std::tuple<int, int, std::string>>& clients_info,
+    const std::vector<std::tuple<int, int, base::TimeTicks, std::string>>&
+        clients_info,
     const GURL& script_url,
     const GetWindowClientsCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 
-  std::unique_ptr<ServiceWorkerClients> clients(new ServiceWorkerClients);
+  auto clients = base::MakeUnique<ServiceWorkerClients>();
   for (const auto& it : clients_info) {
     ServiceWorkerClientInfo info = GetWindowClientInfoOnUI(
-        std::get<0>(it), std::get<1>(it), std::get<2>(it));
+        std::get<0>(it), std::get<1>(it), std::get<2>(it), std::get<3>(it));
 
     // If the request to the provider_host returned an empty
     // ServiceWorkerClientInfo, that means that it wasn't possible to associate
     // it with a valid RenderFrameHost. It might be because the frame was killed
     // or navigated in between.
     if (info.IsEmpty())
       continue;
 
     // We can get info for a frame that was navigating end ended up with a
     // different URL than expected. In such case, we should make sure to not
     // expose cross-origin WindowClient.
     if (info.url.GetOrigin() != script_url.GetOrigin())
       continue;
 
     clients->push_back(info);
   }
 
   BrowserThread::PostTask(BrowserThread::IO, FROM_HERE,
                           base::Bind(callback, base::Passed(&clients)));
 }
 
-struct ServiceWorkerClientInfoSortMRU {
+struct ServiceWorkerClientInfoSort {
   bool operator()(const ServiceWorkerClientInfo& a,
                   const ServiceWorkerClientInfo& b) const {
-    return a.last_focus_time > b.last_focus_time;
+    if (a.last_focus_time != b.last_focus_time)

[leonhsl(Using Gerrit), 2017/05/26 05:48:38]

I suggest we keep the comparison algorithm strictly with step 2.5 described at
spec: https://w3c.github.io/ServiceWorker/#dom-clients-matchall
Client type is the first priority, then focus time, then creation time. Thus
it'd be clearer.

[xiaofengzhang, 2017/05/26 13:57:48]

Acknowledged. I am working on the test cases failure, it should be caused by
this function.

[xiaofengzhang, 2017/05/27 05:27:42]

Done. It seems the test cases' failure is because of null ptr at line 513
instead of here.

+      return a.last_focus_time > b.last_focus_time;
+    else if (a.client_type == blink::kWebServiceWorkerClientTypeWindow &&
+             b.client_type != blink::kWebServiceWorkerClientTypeWindow)
+      return true;
+    else
+      return a.create_time < b.create_time;
   }
 };
 
 void DidGetClients(const ClientsCallback& callback,
-                   ServiceWorkerClients* clients) {
+                   std::unique_ptr<ServiceWorkerClients> clients) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 
-  // Sort clients so that the most recently active tab is in the front.
-  std::sort(clients->begin(), clients->end(), ServiceWorkerClientInfoSortMRU());
+  std::sort(clients->begin(), clients->end(), ServiceWorkerClientInfoSort());
 
-  callback.Run(clients);
+  callback.Run(clients.get());

[shimazu, 2017/05/26 08:10:07]

Could you change the argument to use std::unique_ptr?

[xiaofengzhang, 2017/05/26 13:57:48]

Acknowledged.

[xiaofengzhang, 2017/05/27 05:27:42]

Done.

 }
 
 void GetNonWindowClients(const base::WeakPtr<ServiceWorkerVersion>& controller,
                          const ServiceWorkerClientQueryOptions& options,
                          ServiceWorkerClients* clients) {

[shimazu, 2017/05/26 08:10:07]

std::unique_ptr<ServiceWorkerClients>

[xiaofengzhang, 2017/05/26 13:57:48]

Acknowledged.

[xiaofengzhang, 2017/05/27 05:27:42]

Done.

   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   if (!options.include_uncontrolled) {
     for (auto& controllee : controller->controllee_map())
       AddNonWindowClient(controllee.second, options, clients);
   } else if (controller->context()) {
     GURL origin = controller->script_url().GetOrigin();
     for (auto it = controller->context()->GetClientProviderHostIterator(origin);
          !it->IsAtEnd(); it->Advance()) {
       AddNonWindowClient(it->GetProviderHost(), options, clients);
     }
   }

[shimazu, 2017/05/26 08:10:07]

DidGetClients()

[xiaofengzhang, 2017/05/27 05:27:42]

Done.

 }
 
 void DidGetWindowClients(const base::WeakPtr<ServiceWorkerVersion>& controller,
                          const ServiceWorkerClientQueryOptions& options,
                          const ClientsCallback& callback,
                          std::unique_ptr<ServiceWorkerClients> clients) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   if (options.client_type == blink::kWebServiceWorkerClientTypeAll)
     GetNonWindowClients(controller, options, clients.get());

[shimazu, 2017/05/26 08:10:07]

Please move clients to GetNonWindowClients and add a return.

[xiaofengzhang, 2017/05/26 13:57:48]

I am thinking if we move DidGetClients into GetNonWindowClients, it seems that
the code here can't deal with case of client_type !=
kWebServiceWorkerClientWindow, which also needs DidGetClients?

[xiaofengzhang, 2017/05/27 05:27:42]

Done.

-  DidGetClients(callback, clients.get());
+  DidGetClients(callback, std::move(clients));
 }
 
 void GetWindowClients(const base::WeakPtr<ServiceWorkerVersion>& controller,
                       const ServiceWorkerClientQueryOptions& options,
                       const ClientsCallback& callback) {

[shimazu, 2017/05/26 08:10:07]

Please add an argument like
std::unique_ptr<ServiceWorkerClients> clients

[xiaofengzhang, 2017/05/27 05:27:42]

Done.

   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   DCHECK(options.client_type == blink::kWebServiceWorkerClientTypeWindow ||
          options.client_type == blink::kWebServiceWorkerClientTypeAll);
 
-  std::vector<std::tuple<int, int, std::string>> clients_info;
+  std::vector<std::tuple<int, int, base::TimeTicks, std::string>> clients_info;
   if (!options.include_uncontrolled) {
-    for (auto& controllee : controller->controllee_map())
+    for (auto& controllee : controller->controllee_map()) {
       AddWindowClient(controllee.second, &clients_info);
+    }
   } else if (controller->context()) {
     GURL origin = controller->script_url().GetOrigin();
     for (auto it = controller->context()->GetClientProviderHostIterator(origin);
          !it->IsAtEnd(); it->Advance()) {
       AddWindowClient(it->GetProviderHost(), &clients_info);
     }
   }
 
   if (clients_info.empty()) {
     DidGetWindowClients(controller, options, callback,
-                        base::WrapUnique(new ServiceWorkerClients));
+                        base::MakeUnique<ServiceWorkerClients>());

[shimazu, 2017/05/26 08:10:07]

Pass |clients| to DidGetWindowClients

[xiaofengzhang, 2017/05/27 05:27:42]

Done.

     return;
   }
 
   BrowserThread::PostTask(
       BrowserThread::UI, FROM_HERE,
       base::Bind(
           &OnGetWindowClientsOnUI, clients_info, controller->script_url(),

[shimazu, 2017/05/26 08:10:07]

Pass |clients| to OnGetWindowClientsOnUI

[xiaofengzhang, 2017/05/27 05:27:42]

Done.

           base::Bind(&DidGetWindowClients, controller, options, callback)));
 }
 
 }  // namespace
 
 void FocusWindowClient(ServiceWorkerProviderHost* provider_host,
                        const ClientCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   DCHECK_EQ(blink::kWebServiceWorkerClientTypeWindow,
             provider_host->client_type());
   BrowserThread::PostTaskAndReplyWithResult(
       BrowserThread::UI, FROM_HERE,
       base::Bind(&FocusOnUI, provider_host->process_id(),
-                 provider_host->frame_id(), provider_host->client_uuid()),
+                 provider_host->frame_id(), provider_host->create_time(),
+                 provider_host->client_uuid()),
       callback);
 }
 
 void OpenWindow(const GURL& url,
                 const GURL& script_url,
                 int worker_process_id,
                 const base::WeakPtr<ServiceWorkerContextCore>& context,
                 const NavigationCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   BrowserThread::PostTask(
@@ skipping 25 matching lines @@
   blink::WebServiceWorkerClientType client_type = provider_host->client_type();
   DCHECK(client_type == blink::kWebServiceWorkerClientTypeWindow ||
          client_type == blink::kWebServiceWorkerClientTypeWorker ||
          client_type == blink::kWebServiceWorkerClientTypeSharedWorker)
       << client_type;
 
   if (client_type == blink::kWebServiceWorkerClientTypeWindow) {
     BrowserThread::PostTaskAndReplyWithResult(
         BrowserThread::UI, FROM_HERE,
         base::Bind(&GetWindowClientInfoOnUI, provider_host->process_id(),
-                   provider_host->route_id(), provider_host->client_uuid()),
+                   provider_host->route_id(), provider_host->create_time(),
+                   provider_host->client_uuid()),
         callback);
     return;
   }
 
   ServiceWorkerClientInfo client_info(
       provider_host->client_uuid(), blink::kWebPageVisibilityStateHidden,
       false,  // is_focused
       provider_host->document_url(), REQUEST_CONTEXT_FRAME_TYPE_NONE,
-      base::TimeTicks(), provider_host->client_type());
+      base::TimeTicks(), provider_host->create_time(),
+      provider_host->client_type());
   BrowserThread::PostTask(BrowserThread::IO, FROM_HERE,
                           base::Bind(callback, client_info));
 }
 
 void GetClients(const base::WeakPtr<ServiceWorkerVersion>& controller,
                 const ServiceWorkerClientQueryOptions& options,
                 const ClientsCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 
-  ServiceWorkerClients clients;
+  std::unique_ptr<ServiceWorkerClients> clients;

[shimazu, 2017/05/26 08:10:07]

How about creating the instance of clients here and passing it around?

[xiaofengzhang, 2017/05/26 13:57:48]

Acknowledged.

[xiaofengzhang, 2017/05/27 05:27:42]

Done.

   if (!controller->HasControllee() && !options.include_uncontrolled) {
-    DidGetClients(callback, &clients);
+    DidGetClients(callback, std::move(clients));
     return;
   }
 
   // For Window clients we want to query the info on the UI thread first.
   if (options.client_type == blink::kWebServiceWorkerClientTypeWindow ||
       options.client_type == blink::kWebServiceWorkerClientTypeAll) {
     GetWindowClients(controller, options, callback);
     return;
   }
 
-  GetNonWindowClients(controller, options, &clients);
-  DidGetClients(callback, &clients);
+  GetNonWindowClients(controller, options, clients.get());

[shimazu, 2017/05/26 08:10:07]

Passing clients and calling DidGetClients at the end of GetNonWindowClients

[xiaofengzhang, 2017/05/27 05:27:42]

Done.

+  DidGetClients(callback, std::move(clients));
 }
 
 }  // namespace service_worker_client_utils
 }  // namespace content