| // Copyright 2014 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_URL_REQUEST_JOB_H_ |
| #define CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_URL_REQUEST_JOB_H_ |
| |
| #include <stdint.h> |
| |
| #include <map> |
| #include <memory> |
| #include <string> |
| #include <vector> |
| |
| #include "base/macros.h" |
| #include "base/memory/ref_counted.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/optional.h" |
| #include "base/time/time.h" |
| #include "content/browser/service_worker/embedded_worker_status.h" |
| #include "content/browser/service_worker/service_worker_fetch_dispatcher.h" |
| #include "content/browser/service_worker/service_worker_metrics.h" |
| #include "content/browser/service_worker/service_worker_response_type.h" |
| #include "content/browser/service_worker/service_worker_url_job_wrapper.h" |
| #include "content/common/content_export.h" |
| #include "content/public/common/resource_type.h" |
| #include "mojo/public/cpp/system/data_pipe.h" |
| #include "net/http/http_byte_range.h" |
| #include "net/url_request/url_request.h" |
| #include "net/url_request/url_request_job.h" |
| #include "net/url_request/url_request_status.h" |
| #include "services/network/public/cpp/resource_request.h" |
| #include "services/network/public/mojom/fetch_api.mojom.h" |
| #include "services/network/public/mojom/request_context_frame_type.mojom.h" |
| #include "storage/common/blob_storage/blob_storage_constants.h" |
| #include "third_party/blink/public/common/service_worker/service_worker_status_code.h" |
| #include "third_party/blink/public/mojom/fetch/fetch_api_request.mojom.h" |
| #include "third_party/blink/public/mojom/fetch/fetch_api_response.mojom.h" |
| #include "url/gurl.h" |
| |
| namespace net { |
| class IOBuffer; |
| } // namespace net |
| |
| namespace network { |
| class ResourceRequestBody; |
| } |
| |
| namespace storage { |
| class BlobStorageContext; |
| } // namespace storage |
| |
| namespace content { |
| |
| class ResourceContext; |
| class ServiceWorkerBlobReader; |
| class ServiceWorkerDataPipeReader; |
| class ServiceWorkerProviderHost; |
| class ServiceWorkerVersion; |
| |
| namespace service_worker_controllee_request_handler_unittest { |
| class ServiceWorkerControlleeRequestHandlerTest; |
| FORWARD_DECLARE_TEST(ServiceWorkerControlleeRequestHandlerTest, |
| LostActiveVersion); |
| } // namespace service_worker_controllee_request_handler_unittest |
| |
| namespace service_worker_url_request_job_unittest { |
| class DelayHelper; |
| } // namespace service_worker_url_request_job_unittest |
| |
| class CONTENT_EXPORT ServiceWorkerURLRequestJob : public net::URLRequestJob { |
| public: |
| using Delegate = ServiceWorkerURLJobWrapper::Delegate; |
| using ResponseType = ServiceWorkerResponseType; |
| |
| ServiceWorkerURLRequestJob( |
| net::URLRequest* request, |
| net::NetworkDelegate* network_delegate, |
| base::WeakPtr<ServiceWorkerProviderHost> provider_host, |
| base::WeakPtr<storage::BlobStorageContext> blob_storage_context, |
| const ResourceContext* resource_context, |
| network::mojom::FetchRequestMode request_mode, |
| network::mojom::FetchCredentialsMode credentials_mode, |
| network::mojom::FetchRedirectMode redirect_mode, |
| const std::string& integrity, |
| bool keepalive, |
| ResourceType resource_type, |
| blink::mojom::RequestContextType request_context_type, |
| network::mojom::RequestContextFrameType frame_type, |
| scoped_refptr<network::ResourceRequestBody> body, |
| Delegate* delegate); |
| |
| ~ServiceWorkerURLRequestJob() override; |
| |
| const ResourceContext* resource_context() const { return resource_context_; } |
| bool did_navigation_preload() const { return did_navigation_preload_; } |
| |
| // When set, this job will pretend that navigation preload was triggered, but |
| // not actually do navigation preload. This is to aid unit tests that check |
| // UMA logging. It's difficult to get navigation preload to work in a unit |
| // test: there is a much setup of ResourceRequestInfoImpl, |
| // ResourceRequesterInfo, etc. required. |
| void set_simulate_navigation_preload_for_test() { |
| simulate_navigation_preload_for_test_ = true; |
| } |
| |
| // Sets the response type. |
| // When an in-flight request possibly needs CORS check, use |
| // FallbackToNetworkOrRenderer. This method will decide whether the request |
| // can directly go to the network or should fallback to a renderer to send |
| // CORS preflight. You can use FallbackToNetwork only when it's apparent that |
| // the request can go to the network directly (e.g., main resource requests or |
| // same-origin requests). |
| void FallbackToNetwork(); |
| void FallbackToNetworkOrRenderer(); |
| void ForwardToServiceWorker(); |
| // Tells the job to abort with a start error. Currently this is only called |
| // because the controller was lost. This function could be made more generic |
| // if needed later. |
| void FailDueToLostController(); |
| |
| bool ShouldFallbackToNetwork() const { |
| return response_type_ == ResponseType::FALLBACK_TO_NETWORK; |
| } |
| bool ShouldForwardToServiceWorker() const { |
| return response_type_ == ResponseType::FORWARD_TO_SERVICE_WORKER; |
| } |
| |
| // net::URLRequestJob overrides: |
| void Start() override; |
| void Kill() override; |
| net::LoadState GetLoadState() const override; |
| bool GetCharset(std::string* charset) override; |
| bool GetMimeType(std::string* mime_type) const override; |
| void GetResponseInfo(net::HttpResponseInfo* info) override; |
| void GetLoadTimingInfo(net::LoadTimingInfo* load_timing_info) const override; |
| void SetExtraRequestHeaders(const net::HttpRequestHeaders& headers) override; |
| int ReadRawData(net::IOBuffer* buf, int buf_size) override; |
| |
| //---------------------------------------------------------------------------- |
| // The following are intended for use by ServiceWorker(Blob|DataPipe)Reader. |
| virtual void OnResponseStarted(); |
| virtual void OnReadRawDataComplete(int bytes_read); |
| virtual void RecordResult(ServiceWorkerMetrics::URLRequestJobResult result); |
| //---------------------------------------------------------------------------- |
| |
| base::WeakPtr<ServiceWorkerURLRequestJob> GetWeakPtr(); |
| |
| private: |
| using ResponseHeaderMap = base::flat_map<std::string, std::string>; |
| |
| class NavigationPreloadMetrics; |
| friend class service_worker_url_request_job_unittest::DelayHelper; |
| friend class ServiceWorkerURLRequestJobTest; |
| FRIEND_TEST_ALL_PREFIXES(service_worker_controllee_request_handler_unittest:: |
| ServiceWorkerControlleeRequestHandlerTest, |
| LostActiveVersion); |
| |
| enum ResponseBodyType { |
| UNKNOWN, |
| BLOB, |
| STREAM, |
| }; |
| |
| // We start processing the request if Start() is called AND response_type_ |
| // is determined. |
| void MaybeStartRequest(); |
| void StartRequest(); |
| |
| // Creates a ResourceRequest from |request_|. Does not populate the request |
| // body. |
| std::unique_ptr<network::ResourceRequest> CreateResourceRequest(); |
| |
| // Returns true if this job performed a navigation that should be logged to |
| // performance-related UMA. It returns false in certain cases that are not |
| // relevant to performance analysis, such as if the worker was not already |
| // activated or DevTools was attached to the worker. |
| bool ShouldRecordNavigationMetrics(const ServiceWorkerVersion* version) const; |
| |
| // For FORWARD_TO_SERVICE_WORKER case. |
| void DidPrepareFetchEvent(scoped_refptr<ServiceWorkerVersion> version); |
| void DidDispatchFetchEvent( |
| blink::ServiceWorkerStatusCode status, |
| ServiceWorkerFetchDispatcher::FetchEventResult fetch_result, |
| blink::mojom::FetchAPIResponsePtr response, |
| blink::mojom::ServiceWorkerStreamHandlePtr body_as_stream, |
| blink::mojom::ServiceWorkerFetchEventTimingPtr timing, |
| scoped_refptr<ServiceWorkerVersion> version); |
| void SetResponse(blink::mojom::FetchAPIResponsePtr response); |
| |
| // Populates |http_response_headers_|. |
| void CreateResponseHeader(int status_code, |
| const std::string& status_text, |
| ResponseHeaderMap headers); |
| |
| // Creates |http_response_info_| using |http_response_headers_| and calls |
| // NotifyHeadersComplete. |
| void CommitResponseHeader(); |
| |
| // Creates and commits a response header indicating error. |
| void DeliverErrorResponse(); |
| |
| // Restarts this job to fallback to network. |
| // This can be called after StartRequest. |
| void FinalizeFallbackToNetwork(); |
| |
| // Sends back a response with fall_back_required set as true to trigger |
| // subsequent network requests with CORS checking. |
| // This can be called after StartRequest. |
| void FinalizeFallbackToRenderer(); |
| |
| // True if need to send back a response with fall_back_required set as true to |
| // trigger subsequent network requests with CORS checking. |
| bool IsFallbackToRendererNeeded() const; |
| |
| // For UMA. |
| void SetResponseBodyType(ResponseBodyType type); |
| bool ShouldRecordResult(); |
| void RecordStatusZeroResponseError( |
| blink::mojom::ServiceWorkerResponseError error); |
| |
| const net::HttpResponseInfo* http_info() const; |
| |
| // Invoke callbacks before invoking corresponding URLRequestJob methods. |
| void NotifyHeadersComplete(); |
| void NotifyStartError(net::URLRequestStatus status); |
| void NotifyRestartRequired(); |
| |
| // Wrapper that gathers parameters to |on_start_completed_callback_| and then |
| // calls it. |
| void OnStartCompleted() const; |
| |
| bool IsMainResourceLoad() const; |
| |
| bool HasRequestBody(); |
| void ForwardRequestToServiceWorker(); |
| |
| // Called back from |
| // ServiceWorkerFetchEventDispatcher::MaybeStartNavigationPreload when the |
| // navigation preload response starts. |
| void OnNavigationPreloadResponse(); |
| |
| void MaybeReportNavigationPreloadMetrics(); |
| |
| // Not owned. |
| Delegate* delegate_; |
| |
| // Timing info to show on the popup in Devtools' Network tab. |
| net::LoadTimingInfo load_timing_info_; |
| |
| // When the worker was asked to prepare for the fetch event. Preparation may |
| // include activation and startup. |
| base::TimeTicks worker_start_time_; |
| |
| // When the worker confirmed it's ready for the fetch event. If it was already |
| // activated and running when asked to prepare, this should be nearly the same |
| // as |worker_start_time_|). |
| base::TimeTicks worker_ready_time_; |
| |
| // When the response started. |
| base::Time response_time_; |
| |
| // When the navigation preload response started. |
| base::TimeTicks navigation_preload_response_time_; |
| |
| // True if the worker was already in ACTIVATED status when asked to prepare |
| // for the fetch event. |
| bool worker_already_activated_ = false; |
| |
| // The status the worker was in when asked to prepare for the fetch event. |
| EmbeddedWorkerStatus initial_worker_status_ = EmbeddedWorkerStatus::STOPPED; |
| |
| // If worker startup occurred during preparation, the situation that startup |
| // occurred in. |
| ServiceWorkerMetrics::StartSituation worker_start_situation_ = |
| ServiceWorkerMetrics::StartSituation::UNKNOWN; |
| |
| // True if navigation preload was enabled. |
| bool did_navigation_preload_ = false; |
| bool simulate_navigation_preload_for_test_ = false; |
| |
| std::unique_ptr<NavigationPreloadMetrics> nav_preload_metrics_; |
| |
| ResponseType response_type_; |
| |
| // True if URLRequestJob::Start() has been called. |
| bool is_started_; |
| |
| net::HttpByteRange byte_range_; |
| std::unique_ptr<net::HttpResponseInfo> range_response_info_; |
| std::unique_ptr<net::HttpResponseInfo> http_response_info_; |
| // Headers that have not yet been committed to |http_response_info_|. |
| scoped_refptr<net::HttpResponseHeaders> http_response_headers_; |
| std::vector<GURL> response_url_list_; |
| network::mojom::FetchResponseType fetch_response_type_; |
| |
| // Used when response type is FORWARD_TO_SERVICE_WORKER. |
| std::unique_ptr<ServiceWorkerFetchDispatcher> fetch_dispatcher_; |
| base::WeakPtr<ServiceWorkerProviderHost> provider_host_; |
| base::WeakPtr<storage::BlobStorageContext> blob_storage_context_; |
| const ResourceContext* resource_context_; |
| // Only one of |blob_reader_| and |data_pipe_reader_| can be non-null. |
| std::unique_ptr<ServiceWorkerBlobReader> blob_reader_; |
| std::unique_ptr<ServiceWorkerDataPipeReader> data_pipe_reader_; |
| |
| network::mojom::FetchRequestMode request_mode_; |
| network::mojom::FetchCredentialsMode credentials_mode_; |
| network::mojom::FetchRedirectMode redirect_mode_; |
| std::string integrity_; |
| const bool keepalive_; |
| const ResourceType resource_type_; |
| blink::mojom::RequestContextType request_context_type_; |
| network::mojom::RequestContextFrameType frame_type_; |
| bool fall_back_required_; |
| scoped_refptr<network::ResourceRequestBody> body_; |
| |
| ResponseBodyType response_body_type_ = UNKNOWN; |
| bool did_record_result_ = false; |
| |
| bool response_is_in_cache_storage_ = false; |
| std::string response_cache_storage_cache_name_; |
| |
| ServiceWorkerHeaderList cors_exposed_header_names_; |
| |
| base::WeakPtrFactory<ServiceWorkerURLRequestJob> weak_factory_; |
| |
| DISALLOW_COPY_AND_ASSIGN(ServiceWorkerURLRequestJob); |
| }; |
| |
| } // namespace content |
| |
| #endif // CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_URL_REQUEST_JOB_H_ |