lazyboy | 63b994a | 2017-06-30 21:20:23 | [diff] [blame] | 1 | // Copyright 2017 The Chromium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef EXTENSIONS_BROWSER_SERVICE_WORKER_TASK_QUEUE_H_ |
| 6 | #define EXTENSIONS_BROWSER_SERVICE_WORKER_TASK_QUEUE_H_ |
| 7 | |
Istiaque Ahmed | ccb44402 | 2018-06-19 02:11:12 | [diff] [blame] | 8 | #include <map> |
| 9 | #include <set> |
| 10 | |
| 11 | #include "base/memory/weak_ptr.h" |
Istiaque Ahmed | 70f76ac | 2018-11-02 02:59:55 | [diff] [blame] | 12 | #include "base/version.h" |
lazyboy | 63b994a | 2017-06-30 21:20:23 | [diff] [blame] | 13 | #include "components/keyed_service/core/keyed_service.h" |
| 14 | #include "extensions/browser/lazy_context_task_queue.h" |
| 15 | #include "extensions/common/extension_id.h" |
| 16 | #include "url/gurl.h" |
| 17 | |
| 18 | namespace content { |
| 19 | class BrowserContext; |
Istiaque Ahmed | b8e24bdb | 2018-09-13 15:17:25 | [diff] [blame] | 20 | class ServiceWorkerContext; |
lazyboy | 63b994a | 2017-06-30 21:20:23 | [diff] [blame] | 21 | } |
| 22 | |
| 23 | namespace extensions { |
| 24 | class Extension; |
| 25 | class LazyContextId; |
| 26 | |
lazyboy | 63b994a | 2017-06-30 21:20:23 | [diff] [blame] | 27 | // TODO(lazyboy): Clean up queue when extension is unloaded/uninstalled. |
| 28 | class ServiceWorkerTaskQueue : public KeyedService, |
| 29 | public LazyContextTaskQueue { |
| 30 | public: |
| 31 | explicit ServiceWorkerTaskQueue(content::BrowserContext* browser_context); |
| 32 | ~ServiceWorkerTaskQueue() override; |
| 33 | |
| 34 | // Convenience method to return the ServiceWorkerTaskQueue for a given |
| 35 | // |context|. |
| 36 | static ServiceWorkerTaskQueue* Get(content::BrowserContext* context); |
| 37 | |
| 38 | bool ShouldEnqueueTask(content::BrowserContext* context, |
| 39 | const Extension* extension) override; |
David Bertoni | 8269a09 | 2018-12-19 15:55:42 | [diff] [blame^] | 40 | void AddPendingTask(const LazyContextId& context_id, |
| 41 | PendingTask task) override; |
lazyboy | 63b994a | 2017-06-30 21:20:23 | [diff] [blame] | 42 | |
Istiaque Ahmed | ccb44402 | 2018-06-19 02:11:12 | [diff] [blame] | 43 | // Performs Service Worker related tasks upon |extension| activation, |
| 44 | // e.g. registering |extension|'s worker, executing any pending tasks. |
| 45 | void ActivateExtension(const Extension* extension); |
| 46 | // Performs Service Worker related tasks upon |extension| deactivation, |
| 47 | // e.g. unregistering |extension|'s worker. |
| 48 | void DeactivateExtension(const Extension* extension); |
| 49 | |
Istiaque Ahmed | b8e24bdb | 2018-09-13 15:17:25 | [diff] [blame] | 50 | // Called once an extension Service Worker started running. |
| 51 | void DidStartServiceWorkerContext(const ExtensionId& extension_id, |
| 52 | int64_t service_worker_version_id); |
| 53 | // Called once an extension Service Worker was destroyed. |
| 54 | void DidStopServiceWorkerContext(const ExtensionId& extension_id, |
| 55 | int64_t service_worker_version_id); |
| 56 | |
Istiaque Ahmed | 70f76ac | 2018-11-02 02:59:55 | [diff] [blame] | 57 | class TestObserver { |
| 58 | public: |
| 59 | TestObserver() = default; |
| 60 | virtual ~TestObserver() = default; |
| 61 | |
| 62 | // Called when an extension with id |extension_id| is going to be activated. |
| 63 | // |will_register_service_worker| is true if a Service Worker will be |
| 64 | // registered. |
| 65 | virtual void OnActivateExtension(const ExtensionId& extension_id, |
| 66 | bool will_register_service_worker) = 0; |
| 67 | |
| 68 | private: |
| 69 | DISALLOW_COPY_AND_ASSIGN(TestObserver); |
| 70 | }; |
| 71 | |
| 72 | static void SetObserverForTest(TestObserver* observer); |
| 73 | |
lazyboy | 63b994a | 2017-06-30 21:20:23 | [diff] [blame] | 74 | private: |
Istiaque Ahmed | ccb44402 | 2018-06-19 02:11:12 | [diff] [blame] | 75 | struct TaskInfo; |
| 76 | |
Zhuoyu Qian | 2266251f | 2018-10-13 02:59:00 | [diff] [blame] | 77 | static void DidStartWorkerForScopeOnIO( |
David Bertoni | 16812fc | 2018-11-27 22:31:38 | [diff] [blame] | 78 | PendingTask task, |
Istiaque Ahmed | b8e24bdb | 2018-09-13 15:17:25 | [diff] [blame] | 79 | const ExtensionId& extension_id, |
| 80 | base::WeakPtr<ServiceWorkerTaskQueue> task_queue, |
| 81 | int64_t version_id, |
| 82 | int process_id, |
| 83 | int thread_id); |
| 84 | static void StartServiceWorkerOnIOToRunTask( |
| 85 | base::WeakPtr<ServiceWorkerTaskQueue> task_queue_weak, |
Zhuoyu Qian | 2266251f | 2018-10-13 02:59:00 | [diff] [blame] | 86 | const GURL& scope, |
Istiaque Ahmed | b8e24bdb | 2018-09-13 15:17:25 | [diff] [blame] | 87 | const ExtensionId& extension_id, |
| 88 | content::ServiceWorkerContext* service_worker_context, |
David Bertoni | 16812fc | 2018-11-27 22:31:38 | [diff] [blame] | 89 | PendingTask task); |
Istiaque Ahmed | b8e24bdb | 2018-09-13 15:17:25 | [diff] [blame] | 90 | |
David Bertoni | 27dfaff2 | 2018-12-12 20:05:37 | [diff] [blame] | 91 | void RunTaskAfterStartWorker(const LazyContextId& context_id, |
David Bertoni | 16812fc | 2018-11-27 22:31:38 | [diff] [blame] | 92 | PendingTask task); |
Istiaque Ahmed | ccb44402 | 2018-06-19 02:11:12 | [diff] [blame] | 93 | |
| 94 | void DidRegisterServiceWorker(const ExtensionId& extension_id, bool success); |
| 95 | void DidUnregisterServiceWorker(const ExtensionId& extension_id, |
| 96 | bool success); |
| 97 | |
David Bertoni | 16812fc | 2018-11-27 22:31:38 | [diff] [blame] | 98 | void DidStartWorkerForScope(PendingTask task, |
Zhuoyu Qian | 2266251f | 2018-10-13 02:59:00 | [diff] [blame] | 99 | const ExtensionId& extension_id, |
| 100 | int64_t version_id, |
| 101 | int process_id, |
| 102 | int thread_id); |
Istiaque Ahmed | b8e24bdb | 2018-09-13 15:17:25 | [diff] [blame] | 103 | |
Istiaque Ahmed | 70f76ac | 2018-11-02 02:59:55 | [diff] [blame] | 104 | // The following three methods retrieve, store, and remove information |
| 105 | // about Service Worker registration of SW based background pages: |
| 106 | // |
| 107 | // Retrieves the last version of the extension, returns invalid version if |
| 108 | // there isn't any such extension. |
| 109 | base::Version RetrieveRegisteredServiceWorkerVersion( |
| 110 | const ExtensionId& extension_id); |
| 111 | // Records that the extension with |extension_id| and |version| successfully |
| 112 | // registered a Service Worker. |
| 113 | void SetRegisteredServiceWorkerInfo(const ExtensionId& extension_id, |
| 114 | const base::Version& version); |
| 115 | // Clears any record of registered Service Worker for the given extension with |
| 116 | // |extension_id|. |
| 117 | void RemoveRegisteredServiceWorkerInfo(const ExtensionId& extension_id); |
| 118 | |
Istiaque Ahmed | ccb44402 | 2018-06-19 02:11:12 | [diff] [blame] | 119 | // Set of extension ids that hasn't completed Service Worker registration. |
| 120 | std::set<ExtensionId> pending_registrations_; |
| 121 | |
| 122 | // Map of extension id -> pending tasks. These are run once the Service Worker |
| 123 | // registration of the extension completes. |
| 124 | std::map<ExtensionId, std::vector<TaskInfo>> pending_tasks_; |
| 125 | |
Istiaque Ahmed | b8e24bdb | 2018-09-13 15:17:25 | [diff] [blame] | 126 | struct WaitingDidStartWorkerTask; |
| 127 | |
| 128 | using WaitingDidStartWorkerTaskKey = |
| 129 | std::pair<ExtensionId, int64_t /* service_worker_version_id */>; |
| 130 | // All service workers that are currently loaded. |
| 131 | std::set<WaitingDidStartWorkerTaskKey> running_service_worker_contexts_; |
| 132 | // All service worker tasks that are waiting for the worker to start. |
| 133 | std::map<WaitingDidStartWorkerTaskKey, std::vector<WaitingDidStartWorkerTask>> |
| 134 | waiting_did_start_worker_tasks_; |
| 135 | |
Istiaque Ahmed | ccb44402 | 2018-06-19 02:11:12 | [diff] [blame] | 136 | content::BrowserContext* const browser_context_ = nullptr; |
| 137 | |
| 138 | base::WeakPtrFactory<ServiceWorkerTaskQueue> weak_factory_; |
| 139 | |
lazyboy | 63b994a | 2017-06-30 21:20:23 | [diff] [blame] | 140 | DISALLOW_COPY_AND_ASSIGN(ServiceWorkerTaskQueue); |
| 141 | }; |
| 142 | |
| 143 | } // namespace extensions |
| 144 | |
| 145 | #endif // EXTENSIONS_BROWSER_SERVICE_WORKER_TASK_QUEUE_H_ |