blob: 236688c7ce3258bb04f49fc790f1f141ed689143 [file] [log] [blame]
// Copyright 2017 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 CHROME_BROWSER_FEATURE_ENGAGEMENT_FEATURE_TRACKER_H_
#define CHROME_BROWSER_FEATURE_ENGAGEMENT_FEATURE_TRACKER_H_
#include "base/feature_list.h"
#include "base/scoped_observer.h"
#include "chrome/browser/feature_engagement/session_duration_updater.h"
#include "chrome/browser/profiles/profile.h"
#include "components/keyed_service/core/keyed_service.h"
namespace feature_engagement {
class Tracker;
// The FeatureTracker provides a backend for displaying in-product help for the
// various features by collecting all common functionality. All subclasses of
// FeatureTracker's factories depend on
// SessionDurationUpdaterFactory::GetInstance() as SessionDurationUpdater is
// responsible for letting all FeatureTrackers know how much active session time
// has passed.
//
// SessionDurationUpdater keeps track of the observed session time and, upon
// each session ending, updates all of the FeatureTrackers with the new total
// observed session time. Once the observed session time exceeds the time
// requirement provided by GetSessionTimeRequiredToShow(), the
// FeatureTracker unregisters itself as an obsever of SessionDurationUpdater.
// SessionDurationUpdater stops updating the observed session time if no
// features are observing it, and will start tracking the observed sesion time
// again if another feature is added as an observer later.
//
// Desktop In Product Help only shows promos to new users which means that
// if the user is not considered new based on the chrome variations
// configuration, the promo bubble will not show.
class FeatureTracker : public SessionDurationUpdater::Observer,
public KeyedService {
public:
FeatureTracker(Profile* profile,
const base::Feature* feature,
const char* observed_session_time_dict_key,
base::TimeDelta defaultTimeRequiredToShowPromo);
// Adds the SessionDurationUpdater observer.
void AddSessionDurationObserver();
// Removes the SessionDurationUpdater observer.
void RemoveSessionDurationObserver();
// Returns the whether |session_duration_observer_| is observing sources for
// testing purposes.
bool IsObserving();
// SessionDurationUpdater::Observer:
void OnSessionEnded(base::TimeDelta total_session_time) override;
// Returns if a user is new, whether or not the promo should be displayed.
bool ShouldShowPromo();
void UseDefaultForChromeVariationConfigurationReleaseTimeForTesting() {
use_default_for_chrome_variation_configuration_release_time_for_testing_ =
true;
}
protected:
~FeatureTracker() override;
// Alerts the feature tracker that the session time is up.
virtual void OnSessionTimeMet() = 0;
// Returns the Tracker associated with this FeatureTracker.
virtual Tracker* GetTracker() const;
// Returns the required session time in minutes for the FeatureTracker's
// subclass to show its promo.
base::TimeDelta GetSessionTimeRequiredToShow();
// Whether the user has been created at least 24 hours before the chrome
// variations configuration.
bool IsNewUser();
private:
// Notifies In-Product Help and removes the session duration obverser if the
// session time requirement has been met for the feature.
void NotifyAndRemoveSessionDurationObserverIfSessionTimeMet(
base::TimeDelta total_session_time);
// Returns whether the active session time of a user has elapsed more than the
// required active session time for the feature.
bool HasEnoughSessionTimeElapsed(base::TimeDelta total_session_time);
// Owned by the ProfileManager.
Profile* const profile_;
// Tracks the elapsed session time while |feature_| is active.
SessionDurationUpdater session_duration_updater_;
// Observes the SessionDurationUpdater and notifies when a desktop session
// starts and ends.
ScopedObserver<SessionDurationUpdater, SessionDurationUpdater::Observer>
session_duration_observer_;
// IPH Feature that the tracker is tracking.
const base::Feature* const feature_;
// "x_minutes" param value from the field trial.
base::TimeDelta field_trial_time_delta_;
// Whether the "x_minutes" param value has already been retrieved to prevent
// reading from the field trial multiple times for the same param.
bool has_retrieved_field_trial_minutes_ = false;
// Whether the "x_session_time" requirement has already been met.
bool has_session_time_been_met_ = false;
bool
use_default_for_chrome_variation_configuration_release_time_for_testing_ =
false;
DISALLOW_COPY_AND_ASSIGN(FeatureTracker);
};
} // namespace feature_engagement
#endif // CHROME_BROWSER_FEATURE_ENGAGEMENT_FEATURE_TRACKER_H_