Allow ServiceWorker events to have custom durations

content/browser/service_worker/service_worker_version.h

 // Copyright 2013 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.
 
 #ifndef CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_VERSION_H_
 #define CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_VERSION_H_
 
 #include <map>
 #include <queue>
 #include <set>
@@ skipping 196 matching lines @@
   // |callback| with the response from the worker.
   //
   // This must be called when the status() is ACTIVATED. Calling this in other
   // statuses will result in an error SERVICE_WORKER_ERROR_FAILED.
   void DispatchFetchEvent(const ServiceWorkerFetchRequest& request,
                           const base::Closure& prepare_callback,
                           const FetchCallback& fetch_callback);
 
   // Sends sync event to the associated embedded worker and asynchronously calls
   // |callback| when it errors out or it gets a response from the worker to
-  // notify completion.
+  // notify completion. |expiration| is the TimeTick at which the event should
+  // stop running.
   //
   // This must be called when the status() is ACTIVATED.
   void DispatchSyncEvent(BackgroundSyncRegistrationHandle::HandleId handle_id,
                          BackgroundSyncEventLastChance last_chance,
+                         base::TimeTicks expiration,
                          const StatusCallback& callback);
 
   // Sends notificationclick event to the associated embedded worker and
   // asynchronously calls |callback| when it errors out or it gets a response
   // from the worker to notify completion.
   //
   // This must be called when the status() is ACTIVATED.
   void DispatchNotificationClickEvent(
       const StatusCallback& callback,
       int64_t persistent_notification_id,
@@ skipping 104 matching lines @@
 
   // Simulate ping timeout. Should be used for tests-only.
   void SimulatePingTimeoutForTesting();
 
  private:
   friend class base::RefCounted<ServiceWorkerVersion>;
   friend class ServiceWorkerMetrics;
   friend class ServiceWorkerURLRequestJobTest;
   friend class ServiceWorkerStallInStoppingTest;
   friend class ServiceWorkerVersionBrowserTest;
+  friend class ServiceWorkerVersionTest;
 
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerControlleeRequestHandlerTest,
                            ActivateWaitingVersion);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionTest, IdleTimeout);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionTest, SetDevToolsAttached);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionTest, StaleUpdate_FreshWorker);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionTest,
                            StaleUpdate_NonActiveWorker);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionTest, StaleUpdate_StartWorker);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionTest, StaleUpdate_RunningWorker);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionTest,
                            StaleUpdate_DoNotDeferTimer);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerWaitForeverInFetchTest, RequestTimeout);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerFailToStartTest, Timeout);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionBrowserTest,
                            TimeoutStartingWorker);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionBrowserTest,
                            TimeoutWorkerInEvent);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerStallInStoppingTest, DetachThenStart);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerStallInStoppingTest, DetachThenRestart);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionTest,
                            RegisterForeignFetchScopes);
+  FRIEND_TEST_ALL_PREFIXES(ServiceWorkerVersionTest, RequestCustomizedTimeout);
+  FRIEND_TEST_ALL_PREFIXES(ServiceWorkerWaitForeverInFetchTest,
+                           MixedRequestTimeouts);
 
   class Metrics;
   class PingController;
 
-  typedef ServiceWorkerVersion self;
-  using ServiceWorkerClients = std::vector<ServiceWorkerClientInfo>;
-
   // Used for UMA; add new entries to the end, before NUM_REQUEST_TYPES.
   enum RequestType {
     REQUEST_ACTIVATE,
     REQUEST_INSTALL,
     REQUEST_FETCH,
     REQUEST_SYNC,
     REQUEST_NOTIFICATION_CLICK,
     REQUEST_PUSH,
     REQUEST_GEOFENCING,
     REQUEST_SERVICE_PORT_CONNECT,
     NUM_REQUEST_TYPES
   };
 
   struct RequestInfo {
-    RequestInfo(int id, RequestType type, const base::TimeTicks& time);
+    RequestInfo(int id, RequestType type, const base::TimeTicks& expiration);
     ~RequestInfo();
+    bool operator>(const RequestInfo& other) const;
     int id;
     RequestType type;
-    base::TimeTicks time;
+    base::TimeTicks expiration;
   };
 
   template <typename CallbackType>
   struct PendingRequest {
     PendingRequest(const CallbackType& callback, const base::TimeTicks& time);
     ~PendingRequest();
 
     CallbackType callback;
     base::TimeTicks start_time;
   };
 
+  typedef ServiceWorkerVersion self;
+  using ServiceWorkerClients = std::vector<ServiceWorkerClientInfo>;
+  using RequestInfoPriorityQueue =
+      std::priority_queue<RequestInfo,
+                          std::vector<RequestInfo>,
+                          std::greater<RequestInfo>>;
+
   // The timeout timer interval.
   static const int kTimeoutTimerDelaySeconds;
   // Timeout for an installed worker to start.
   static const int kStartInstalledWorkerTimeoutSeconds;
   // Timeout for a new worker to start.
   static const int kStartNewWorkerTimeoutMinutes;
   // Timeout for a request to be handled.
   static const int kRequestTimeoutMinutes;
   // Timeout for the worker to stop.
   static const int kStopWorkerTimeoutSeconds;
@@ skipping 129 matching lines @@
 
   template <typename IDMAP>
   void RemoveCallbackAndStopIfRedundant(IDMAP* callbacks, int request_id);
 
   template <typename CallbackType>
   int AddRequest(
       const CallbackType& callback,
       IDMap<PendingRequest<CallbackType>, IDMapOwnPointer>* callback_map,
       RequestType request_type);
 
+  template <typename CallbackType>
+  int AddRequestWithExpiration(
+      const CallbackType& callback,
+      IDMap<PendingRequest<CallbackType>, IDMapOwnPointer>* callback_map,
+      RequestType request_type,
+      base::TimeTicks expiration);
+
   bool MaybeTimeOutRequest(const RequestInfo& info);
-  void SetAllRequestTimes(const base::TimeTicks& ticks);
+  void SetAllRequestExpirations(const base::TimeTicks& expiration);
 
   // Returns the reason the embedded worker failed to start, using information
   // inaccessible to EmbeddedWorkerInstance. Returns |default_code| if it can't
   // deduce a reason.
   ServiceWorkerStatusCode DeduceStartWorkerFailureReason(
       ServiceWorkerStatusCode default_code);
 
   // Sets |stale_time_| if this worker is stale, causing an update to eventually
   // occur once the worker stops or is running too long.
   void MarkIfStale();
@@ skipping 59 matching lines @@
   // Holds the time that the outstanding StartWorker() request started.
   base::TimeTicks start_time_;
   // Holds the time the worker entered STOPPING status.
   base::TimeTicks stop_time_;
   // Holds the time the worker was detected as stale and needs updating. We try
   // to update once the worker stops, but will also update if it stays alive too
   // long.
   base::TimeTicks stale_time_;
 
   // New requests are added to |requests_| along with their entry in a callback
-  // map. The timeout timer periodically checks |requests_| for entries that
-  // should time out or have already been fulfilled (i.e., removed from the
-  // callback map).
-  std::queue<RequestInfo> requests_;
+  // map. Requests are sorted by their expiration time (soonest to expire on top
+  // of the priority queue). The timeout timer periodically checks |requests_|
+  // for entries that should time out or have already been fulfilled (i.e.,
+  // removed from the callback map).
+  RequestInfoPriorityQueue requests_;
 
   bool skip_waiting_ = false;
   bool skip_recording_startup_time_ = false;
   bool force_bypass_cache_for_scripts_ = false;
   bool skip_script_comparison_ = false;
   bool is_update_scheduled_ = false;
   bool in_dtor_ = false;
 
   std::vector<int> pending_skip_waiting_requests_;
   scoped_ptr<net::HttpResponseInfo> main_script_http_info_;
 
   // The status when StartWorker was invoked. Used for UMA.
   Status prestart_status_ = NEW;
   // If not OK, the reason that StartWorker failed. Used for
   // running |start_callbacks_|.
   ServiceWorkerStatusCode start_worker_status_ = SERVICE_WORKER_OK;
 
   scoped_ptr<PingController> ping_controller_;
   scoped_ptr<Metrics> metrics_;
   const bool should_exclude_from_uma_ = false;
 
   base::WeakPtrFactory<ServiceWorkerVersion> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ServiceWorkerVersion);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_VERSION_H_