components/history_clusters/core/features.h

// Copyright 2021 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_HISTORY_CLUSTERS_CORE_FEATURES_H_
#define COMPONENTS_HISTORY_CLUSTERS_CORE_FEATURES_H_

#include "base/feature_list.h"
#include "base/metrics/field_trial_params.h"

namespace history_clusters {

// Features

namespace internal {

// Enables Journeys in the Chrome History WebUI. This flag shouldn't be checked
// directly. Instead use `IsJourneysEnabled()` for the system language filter.
BASE_DECLARE_FEATURE(kJourneys);

// Enables labelling of Journeys in UI.
BASE_DECLARE_FEATURE(kJourneysLabels);

// Enables images for Journeys in UI.
BASE_DECLARE_FEATURE(kJourneysImages);

// Enables images to cover the full container for Journeys in UI.
extern const base::FeatureParam<bool> kJourneysImagesCover;

// Enables persisting and using persisted clusters.
BASE_DECLARE_FEATURE(kPersistedClusters);

// Enables the Journeys Omnibox Action chip. `kJourneys` must also be enabled
// for this to take effect.
BASE_DECLARE_FEATURE(kOmniboxAction);

// Enables the `HistoryClusterProvider` to surface Journeys as a suggestion row
// instead of an action chip. Enabling this won't actually disable
// `kOmniboxAction` but for user experiments, the intent is to only have 1
// enabled. `kJourneys` must also be enabled for this to take effect.
BASE_DECLARE_FEATURE(kOmniboxHistoryClusterProvider);

// Enables debug info in non-user-visible surfaces, like Chrome Inspector.
// Does nothing if `kJourneys` is disabled.
BASE_DECLARE_FEATURE(kNonUserVisibleDebug);

// Enables debug info in user-visible surfaces, like the actual WebUI page.
// Does nothing if `kJourneys` is disabled.
BASE_DECLARE_FEATURE(kUserVisibleDebug);

// This flag is to enable us to turn on persisting context annotations WITHOUT
// exposing the Journeys UI in general. If EITHER this flag or `kJourneys` is
// enabled, users will have context annotations persisted into their History DB.
BASE_DECLARE_FEATURE(kPersistContextAnnotationsInHistoryDb);

// Enables the history clusters internals page.
BASE_DECLARE_FEATURE(kHistoryClustersInternalsPage);

// Enables use of task runner with trait CONTINUE_ON_SHUTDOWN.
BASE_DECLARE_FEATURE(kHistoryClustersUseContinueOnShutdown);

// Enables use of additional keyword filtering operations on clusters.
BASE_DECLARE_FEATURE(kHistoryClustersKeywordFiltering);

// Enables experimentation for how to dedupe visits in clusters.
BASE_DECLARE_FEATURE(kHistoryClustersVisitDeduping);

// Enables visits from other synced devices to be included in clusters.
BASE_DECLARE_FEATURE(kJourneysIncludeSyncedVisits);

// Persist keyword caches via pref service.
BASE_DECLARE_FEATURE(kJourneysPersistCachesToPrefs);

// Enables context clustering to be performed at navigation time rather than in
// batches.
BASE_DECLARE_FEATURE(kHistoryClustersNavigationContextClustering);

// Enables either the hide visits thumbs-down or menu item on individual visits
// of persisted clusters.
BASE_DECLARE_FEATURE(kHideVisits);

// Enables use of cache to store the URL for display to avoid calls to url
// formatter.
BASE_DECLARE_FEATURE(kUseUrlForDisplayCache);

// Enables filtering of the zero-state Journeys WebUI.
BASE_DECLARE_FEATURE(kJourneysZeroStateFiltering);

// Order consistently with config.h.

}  // namespace internal

// The below features are NOT internal and NOT encapsulated in the Config class.
// These are different because the base::Feature instance needs to be directly
// referred to outside of Journeys code. Moreover, they are not used inside an
// inner loop, so they don't need to be high performance.

// Enables Side Panel Journeys.
BASE_DECLARE_FEATURE(kSidePanelJourneys);
extern const base::FeatureParam<bool> kSidePanelJourneysOpensFromOmnibox;
BASE_DECLARE_FEATURE(kSidePanelJourneysQueryless);

}  // namespace history_clusters

#endif  // COMPONENTS_HISTORY_CLUSTERS_CORE_FEATURES_H_