1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_MANTA_BASE_PROVIDER_H_
#define COMPONENTS_MANTA_BASE_PROVIDER_H_
#include <string>
#include "base/version_info/channel.h"
#include "components/endpoint_fetcher/endpoint_fetcher.h"
#include "components/manta/manta_service_callbacks.h"
#include "components/manta/proto/manta.pb.h"
#include "components/manta/provider_params.h"
#include "components/signin/public/identity_manager/identity_manager.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
namespace manta {
// Base on `use_prod`, returns either the prod or autopush endpoint.
std::string GetProviderEndpoint(bool use_prod);
// BaseProvider abstracts common attributes and functions, mainly about endpoint
// fetcher and authorization, to avoid duplication in particular providers.
class COMPONENT_EXPORT(MANTA) BaseProvider
: public signin::IdentityManager::Observer {
public:
BaseProvider();
BaseProvider(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
signin::IdentityManager* identity_manager);
BaseProvider(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
signin::IdentityManager* identity_manager,
const ProviderParams& provider_params);
BaseProvider(const BaseProvider&) = delete;
BaseProvider& operator=(const BaseProvider&) = delete;
~BaseProvider() override;
// signin::IdentityManager::Observer:
void OnIdentityManagerShutdown(
signin::IdentityManager* identity_manager) override;
protected:
// Receives a request proto, adds additional info (e.g. chrome version) to it,
// makes calls to the server side, and invokes the `done_callback` with
// server response.
// Virtual to allow overriding in tests.
virtual void RequestInternal(
const GURL& url,
const std::string& oauth_consumer_name,
const net::NetworkTrafficAnnotationTag& annotation_tag,
manta::proto::Request& request,
const MantaMetricType metric_type,
MantaProtoResponseCallback done_callback,
const base::TimeDelta timeout);
// TODO(b:333459167): they are protected because FakeBaseProvider needs to
// access them. Try to make them private.
const scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory_;
base::ScopedObservation<signin::IdentityManager,
signin::IdentityManager::Observer>
identity_manager_observation_{this};
private:
// Creates and returns unique pointer to an `EndpointFetcher` initialized with
// the provided parameters and defaults relevant to Manta providers.
// Creates an EndpointFetcher with oauth-based auth.
std::unique_ptr<endpoint_fetcher::EndpointFetcher> CreateEndpointFetcher(
const GURL& url,
const std::string& oauth_consumer_name,
const net::NetworkTrafficAnnotationTag& annotation_tag,
const std::string& post_data,
const base::TimeDelta timeout);
// Creates an EndpointFetcher with default API key auth.
// If an EndpointFetcher is obtained with this function, call its
// `PerformRequest` directly instead of `Fetch`.
std::unique_ptr<endpoint_fetcher::EndpointFetcher>
CreateEndpointFetcherForDemoMode(
const GURL& url,
const net::NetworkTrafficAnnotationTag& annotation_tag,
const std::string& post_data,
const base::TimeDelta timeout);
// Useful client info for particular providers.
const ProviderParams provider_params_;
};
} // namespace manta
#endif // COMPONENTS_MANTA_BASE_PROVIDER_H_
|