blob: 55b897314074f5e8e75bf73790ee786ba0acaf30 [file] [log] [blame]
// Copyright 2019 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.
#include "base/callback_forward.h"
#include "base/macros.h"
#include "base/memory/singleton.h"
#include "base/memory/weak_ptr.h"
#include "base/optional.h"
#include "base/task/cancelable_task_tracker.h"
#include "components/keyed_service/content/browser_context_keyed_service_factory.h"
#include "components/keyed_service/core/keyed_service.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
class Profile;
class UkmBackgroundRecorderBrowserTest;
namespace content {
class BrowserContext;
} // namespace content
namespace history {
class HistoryService;
} // namespace history
namespace url {
class Origin;
} // namespace url
namespace ukm {
// Service for background features that want to record UKM events. This service
// relies on the HistoryService, so that it can check whether the URL of the
// event is present in the Browser's history, and accordingly decide whether to
// generate a new SourceId or not.
class UkmBackgroundRecorderService : public KeyedService {
using GetBackgroundSourceIdCallback =
// |profile| is needed to access the appropriate services |this| depends on.
explicit UkmBackgroundRecorderService(Profile* profile);
~UkmBackgroundRecorderService() override;
void Shutdown() override;
// Checks whether events related to |origin| can be recorded with UKM, by
// checking if |origin| is present in the profile's history. This
// should be used with background features if there will not be an open
// window at the time of the recording. |callback| will be run with a valid
// source ID if recording is allowed, or a nullopt otherwise.
void GetBackgroundSourceIdIfAllowed(const url::Origin& origin,
GetBackgroundSourceIdCallback callback);
friend UkmBackgroundRecorderBrowserTest;
// Callback for querying the history service. |did_determine| is whether the
// history service was able to complete the query, and |num_visits| is the
// number of visits for the provided |origin|.
void DidGetVisibleVisitCount(
const url::Origin& origin,
UkmBackgroundRecorderService::GetBackgroundSourceIdCallback callback,
bool did_determine,
int num_visits,
base::Time first_visit_time);
history::HistoryService* history_service_;
// Task tracker used for querying URLs in the history service.
base::CancelableTaskTracker task_tracker_;
base::WeakPtrFactory<UkmBackgroundRecorderService> weak_ptr_factory_;
class UkmBackgroundRecorderFactory : public BrowserContextKeyedServiceFactory {
static UkmBackgroundRecorderFactory* GetInstance();
static UkmBackgroundRecorderService* GetForProfile(Profile* profile);
friend struct base::DefaultSingletonTraits<UkmBackgroundRecorderFactory>;
~UkmBackgroundRecorderFactory() override;
KeyedService* BuildServiceInstanceFor(
content::BrowserContext* context) const override;
content::BrowserContext* GetBrowserContextToUse(
content::BrowserContext* context) const override;
} // namespace ukm