// 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_AUTOFILL_CORE_BROWSER_METRICS_AUTOFILL_SETTINGS_METRICS_H_
#define COMPONENTS_AUTOFILL_CORE_BROWSER_METRICS_AUTOFILL_SETTINGS_METRICS_H_

#include "components/autofill/core/browser/foundations/autofill_client.h"
#include "components/autofill/core/browser/metrics/autofill_metrics.h"

namespace autofill::autofill_metrics {

// Sources that set Autofill preferences.
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class AutofillPreferenceSetter {
  // The pref was set from an unknown source, e.g. via the command line.
  kUnknown = 0,
  // The pref was set by the user.
  kUserSetting = 1,
  // kStandaloneBrowser = 2,  // Removed. No longer used.
  // The pref was set by an extension.
  kExtension = 3,
  // The pref was set by the custodian of the (supervised) user.
  kCustodian = 4,
  // The pref was set by an admin policy.
  kAdminPolicy = 5,
  kMaxValue = kAdminPolicy
};

// The reason Chrome Sync was deemed disabled when attempting to upload a card
// to Google Payments.
//
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// LINT.IfChange(SyncDisabledReason)
enum class SyncDisabledReason {
  // The user is not signed in.
  kNotSignedIn = 0,
  // Chrome Sync (the service) is disabled by enterprise policy.
  kSyncDisabledByPolicy = 1,
  // The sync type was selected to be enabled, but is not currently active.
  // Generally, "selected" and "active" work out to the same thing, but "active"
  // is the stronger condition (checking for Sync service being active, no auth
  // errors, etc.)
  kSelectedButNotActive = 2,
  // The sync type was disabled by an enterprise policy.
  kTypeDisabledByPolicy = 3,
  // The sync type was disabled by a custodian (i.e. parent/guardian of a child
  // account).
  kTypeDisabledByCustodian = 4,
  // The sync type was disabled for a reason other than the above, which by
  // process of elimination was most likely user selection.
  kTypeProbablyDisabledByUser = 5,
  kMaxValue = kTypeProbablyDisabledByUser
};
// LINT.ThenChange(/tools/metrics/histograms/metadata/autofill/enums.xml:AutofillSyncDisabledReason)

// LINT.IfChange(AutofillSettingsReferrer)
// Enumerates referrers that can trigger a navigation to one of the Autofill
// settings pages.
//
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class AutofillSettingsReferrer {
  // Corresponds to the profile chooser menu.
  kProfileMenu = 0,
  // Corresponds to Chrome's main settings menu.
  kSettingsMenu = 1,
  // Corresponds to the "Autofill and Passwords" settings page.
  kAutofillAndPasswordsPage = 2,
  // Corresponds to the dropdown shown when clicking into a form field.
  kFillingFlowDropdown = 3,
  // Corresponds to opening Autofill and Passwords from Settings search.
  kSettingsSearch = 4,
  kMaxValue = kSettingsSearch,
};
// LINT.ThenChange(/tools/metrics/histograms/metadata/autofill/enums.xml:AutofillSettingsReferrer)

// This should be called each time a page containing forms is loaded.
void LogIsAutofillEnabledAtPageLoad(
    bool enabled,
    AutofillMetrics::PaymentsSigninState sync_state);

// This should be called each time a page containing forms is loaded.
void LogIsAutofillProfileEnabledAtPageLoad(
    bool enabled,
    AutofillMetrics::PaymentsSigninState sync_state);

// This should be called each time a page containing forms is loaded.
void LogIsAutofillPaymentMethodsEnabledAtPageLoad(
    bool enabled,
    AutofillMetrics::PaymentsSigninState sync_state);

// This should be called each time a new chrome profile is launched.
// Evaluates all autofill preferences and logs whether autofill is enabled
// overall.
void LogIsAutofillEnabledAtStartup(const PrefService& prefs);

// This should be called each time a new chrome profile is launched.
// Logs the source that disabled Autofill AI data types on startup.
void LogAutofillAiSettingsAtStartup(const PrefService& prefs);

// This should be called each time a new chrome profile is launched.
void LogIsAutofillProfileEnabledAtStartup(bool enabled);

// This should be called each time a new chrome profile is launched.
void LogIsAutofillPaymentMethodsEnabledAtStartup(bool enabled);

// Logs the source that disabled Autofill Profile, on startup. This should be
// called each time a new chrome profile is launched.
void LogAutofillProfileDisabledReasonAtStartup(const PrefService& pref_service);

// Logs the source that disabled Autofill Profile, on page load for a page
// containing forms.
void LogAutofillProfileDisabledReasonAtPageLoad(const AutofillClient& client);

// Logs the source that disabled payment method Autofill, on startup. This
// should be called each time a new chrome profile is launched.
void LogAutofillPaymentMethodsDisabledReasonAtStartup(
    const PrefService& pref_service);

// Logs the source that disabled payment method Autofill, on page load for a
// page containing forms.
void LogAutofillPaymentMethodsDisabledReasonAtPageLoad(
    const AutofillClient& client);

// Logs the source that disabled Autofill AI types (identity docs, travel,
// shopping), on page load for a page containing forms.
void LogAutofillAiSettingsAtPageLoad(const AutofillClient& client);

// Logs user action "Autofill_ProfileDisabled" if
// `prefs::kAutofillProfileEnabled` is disabled and controlled by the user or an
// extension.
void MaybeLogAutofillProfileDisabled(const PrefService& pref_service);

// Logs the reason the kPayments sync toggle was disabled.
void LogAutofillPaymentsSyncDisabled(SyncDisabledReason reason);

}  // namespace autofill::autofill_metrics

#endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_METRICS_AUTOFILL_SETTINGS_METRICS_H_