| // Copyright 2014 The Chromium Authors |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CONTENT_BROWSER_DEVTOOLS_SERVICE_WORKER_DEVTOOLS_MANAGER_H_ |
| #define CONTENT_BROWSER_DEVTOOLS_SERVICE_WORKER_DEVTOOLS_MANAGER_H_ |
| |
| #include <stdint.h> |
| |
| #include <map> |
| |
| #include "base/containers/flat_set.h" |
| #include "base/no_destructor.h" |
| #include "base/observer_list.h" |
| #include "base/unguessable_token.h" |
| #include "content/browser/devtools/devtools_throttle_handle.h" |
| #include "content/public/browser/global_routing_id.h" |
| #include "services/network/public/mojom/client_security_state.mojom-forward.h" |
| #include "services/network/public/mojom/cross_origin_embedder_policy.mojom-forward.h" |
| #include "services/network/public/mojom/url_response_head.mojom-forward.h" |
| #include "third_party/abseil-cpp/absl/types/optional.h" |
| #include "third_party/blink/public/mojom/devtools/devtools_agent.mojom.h" |
| #include "url/gurl.h" |
| |
| namespace network { |
| struct ResourceRequest; |
| struct URLLoaderCompletionStatus; |
| } |
| |
| namespace content { |
| |
| class BrowserContext; |
| class ServiceWorkerDevToolsAgentHost; |
| class ServiceWorkerContextWrapper; |
| |
| // Manages ServiceWorkerDevToolsAgentHost's. This class lives on UI thread. |
| class ServiceWorkerDevToolsManager { |
| public: |
| class Observer { |
| public: |
| virtual void WorkerCreated(ServiceWorkerDevToolsAgentHost* host, |
| bool* should_pause_on_start) {} |
| virtual void WorkerDestroyed(ServiceWorkerDevToolsAgentHost* host) {} |
| |
| protected: |
| virtual ~Observer() {} |
| }; |
| |
| // Returns the ServiceWorkerDevToolsManager singleton. |
| static ServiceWorkerDevToolsManager* GetInstance(); |
| |
| ServiceWorkerDevToolsManager(const ServiceWorkerDevToolsManager&) = delete; |
| ServiceWorkerDevToolsManager& operator=(const ServiceWorkerDevToolsManager&) = |
| delete; |
| |
| ServiceWorkerDevToolsAgentHost* GetDevToolsAgentHostForWorker( |
| int worker_process_id, |
| int worker_route_id); |
| ServiceWorkerDevToolsAgentHost* GetDevToolsAgentHostForNewInstallingWorker( |
| const ServiceWorkerContextWrapper* context_wrapper, |
| int64_t version_id); |
| |
| void AddAllAgentHosts( |
| std::vector<scoped_refptr<ServiceWorkerDevToolsAgentHost>>* result); |
| void AddAllAgentHostsForBrowserContext( |
| BrowserContext* browser_context, |
| std::vector<scoped_refptr<ServiceWorkerDevToolsAgentHost>>* result); |
| |
| // This function signals the beginning of a main script fetch for a non |
| // installed worker. This is currently only used for PlzServiceWorker. |
| void WorkerMainScriptFetchingStarting( |
| scoped_refptr<ServiceWorkerContextWrapper> context_wrapper, |
| int64_t version_id, |
| const GURL& url, |
| const GURL& scope, |
| const GlobalRenderFrameHostId& requesting_frame_id, |
| scoped_refptr<DevToolsThrottleHandle> throttle_handle); |
| |
| // This function is called when a new worker installation failed to fetch |
| // the main script. It cleans up internal state. |
| void WorkerMainScriptFetchingFailed( |
| scoped_refptr<ServiceWorkerContextWrapper> context_wrapper, |
| int64_t version_id); |
| |
| // Called when a service worker is starting. |
| // |
| // `client_security_state` may be nullptr. |
| void WorkerStarting( |
| int worker_process_id, |
| int worker_route_id, |
| scoped_refptr<ServiceWorkerContextWrapper> context_wrapper, |
| int64_t version_id, |
| const GURL& url, |
| const GURL& scope, |
| bool is_installed_version, |
| network::mojom::ClientSecurityStatePtr client_security_state, |
| mojo::PendingRemote<network::mojom::CrossOriginEmbedderPolicyReporter> |
| coep_reporter, |
| base::UnguessableToken* devtools_worker_token, |
| bool* pause_on_start); |
| void WorkerReadyForInspection( |
| int worker_process_id, |
| int worker_route_id, |
| mojo::PendingRemote<blink::mojom::DevToolsAgent> agent_remote, |
| mojo::PendingReceiver<blink::mojom::DevToolsAgentHost> host_receiver); |
| |
| void WorkerVersionInstalled(int worker_process_id, int worker_route_id); |
| // If the worker instance is stopped its worker_process_id and |
| // worker_route_id will be invalid. For that case we pass context |
| // and version_id as well. |
| void WorkerVersionDoomed( |
| int worker_process_id, |
| int worker_route_id, |
| scoped_refptr<ServiceWorkerContextWrapper> context_wrapper, |
| int64_t version_id); |
| void WorkerStopped(int worker_process_id, int worker_route_id); |
| void NavigationPreloadRequestSent(int worker_process_id, |
| int worker_route_id, |
| const std::string& request_id, |
| const network::ResourceRequest& request); |
| void NavigationPreloadResponseReceived( |
| int worker_process_id, |
| int worker_route_id, |
| const std::string& request_id, |
| const GURL& url, |
| const network::mojom::URLResponseHead& head); |
| void NavigationPreloadCompleted( |
| int worker_process_id, |
| int worker_route_id, |
| const std::string& request_id, |
| const network::URLLoaderCompletionStatus& status); |
| |
| void AddObserver(Observer* observer); |
| void RemoveObserver(Observer* observer); |
| |
| void set_debug_service_worker_on_start(bool debug_on_start); |
| bool debug_service_worker_on_start() const { |
| return debug_service_worker_on_start_; |
| } |
| void AgentHostDestroyed(ServiceWorkerDevToolsAgentHost* agent_host); |
| |
| private: |
| friend class base::NoDestructor<ServiceWorkerDevToolsManager>; |
| friend class ServiceWorkerDevToolsAgentHost; |
| |
| using WorkerId = std::pair<int, int>; |
| |
| ServiceWorkerDevToolsManager(); |
| ~ServiceWorkerDevToolsManager(); |
| |
| scoped_refptr<ServiceWorkerDevToolsAgentHost> TakeStoppedHost( |
| const ServiceWorkerContextWrapper* context_wrapper, |
| int64_t version_id); |
| scoped_refptr<ServiceWorkerDevToolsAgentHost> TakeNewInstallingHost( |
| const ServiceWorkerContextWrapper* context_wrapper, |
| int64_t version_id); |
| |
| base::ObserverList<Observer>::Unchecked observer_list_; |
| bool debug_service_worker_on_start_; |
| |
| // We retain agent hosts as long as the service worker is alive. |
| std::map<WorkerId, scoped_refptr<ServiceWorkerDevToolsAgentHost>> live_hosts_; |
| |
| // We store new installing workers. They can be queried directly when fetching |
| // the main script from the browser process and are moved to live workers |
| // once the process starts up. |
| // Note: This is currently only used for plzServiceWorker. |
| base::flat_set<scoped_refptr<ServiceWorkerDevToolsAgentHost>> |
| new_installing_hosts_; |
| |
| // Clients may retain agent host for the terminated shared worker, |
| // and we reconnect them when shared worker is restarted. |
| base::flat_set<ServiceWorkerDevToolsAgentHost*> stopped_hosts_; |
| }; |
| |
| } // namespace content |
| |
| #endif // CONTENT_BROWSER_DEVTOOLS_SERVICE_WORKER_DEVTOOLS_MANAGER_H_ |