// Copyright 2023 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_PROFILE_IMPORT_METRICS_H_
#define COMPONENTS_AUTOFILL_CORE_BROWSER_METRICS_PROFILE_IMPORT_METRICS_H_

#include <stddef.h>

#include <optional>
#include <string_view>
#include <vector>

#include "components/autofill/core/browser/field_types.h"
#include "components/autofill/core/browser/form_import/addresses/autofill_profile_import_process.h"
#include "components/autofill/core/browser/foundations/autofill_client.h"
#include "components/autofill/core/common/mojom/autofill_types.mojom-shared.h"
#include "services/metrics/public/cpp/ukm_recorder.h"
#include "services/metrics/public/cpp/ukm_source_id.h"

namespace autofill::autofill_metrics {

// These values are persisted to UMA logs. Entries should not be renumbered
// and numeric values should never be reused. These values enumerates the
// status of the different requirements to successfully import an address
// profile from a form submission.
enum class AddressProfileImportRequirementMetric {
  // The form must contain either no or only a single unique email address.
  kEmailAddressUniqueRequirementFulfilled = 0,
  kEmailAddressUniqueRequirementViolated = 1,
  // The form is not allowed to contain invalid field types.
  kNoInvalidFieldTypesRequirementFulfilled = 2,
  kNoInvalidFieldTypesRequirementViolated = 3,
  // If required by |CountryData|, the form must contain a city entry.
  kCityRequirementFulfilled = 4,
  kCityRequirementViolated = 5,
  // If required by |CountryData|, the form must contain a state entry.
  kStateRequirementFulfilled = 6,
  kStateRequirementViolated = 7,
  // If required by |CountryData|, the form must contain a ZIP entry.
  kZipRequirementFulfilled = 8,
  kZipRequirementViolated = 9,
  // If present, the email address must be valid.
  kEmailValidRequirementFulfilled = 10,
  kEmailValidRequirementViolated = 11,
  // The country is no longer required. Instead, an invalid observed country is
  // replaced by the complement country logic.
  kCountryValidRequirementFulfilled = 12,
  kCountryValidRequirementViolated = 13,
  // If present, the state must be valid (if verifiable).
  kStateValidRequirementFulfilled = 14,
  kStateValidRequirementViolated = 15,
  // If present, the ZIP must be valid (if verifiable).
  kZipValidRequirementFulfilled = 16,
  kZipValidRequirementViolated = 17,
  // 18 and 19 are deprecated, as phone numbers are not a requirement anymore.
  // Indicates the overall status of the import requirements check.
  kOverallRequirementFulfilled = 20,
  kOverallRequirementViolated = 21,
  // If required by |CountryData|, the form must contain a line1 entry.
  kLine1RequirementFulfilled = 22,
  kLine1RequirementViolated = 23,
  // If required by |CountryData|, the form must contain a either a zip or a
  // state entry.
  kZipOrStateRequirementFulfilled = 24,
  kZipOrStateRequirementViolated = 25,
  // If required by |CountryData|, the form must contain a either an address
  // line 1 or a house number.
  kLine1OrHouseNumberRequirementFulfilled = 26,
  kLine1OrHouseNumberRequirementViolated = 27,
  kDeprecatedNameRequirementFulfilled = 28,
  kDeprecatedNameRequirementViolated = 29,

  // The form is not allowed to contain any synthesized types.
  kNoSythesizedTypesRequirementFulfilled = 30,
  kNoSythesizedTypesRequirementViolated = 31,

  kMaxValue = kNoSythesizedTypesRequirementViolated,
};

// These values are persisted to UMA logs. Entries should not be renumbered
// and numeric values should never be reused. Represents the status of the field
// type requirements that are specific to countries.
enum class AddressProfileImportCountrySpecificFieldRequirementsMetric {
  kAllGood = 0,
  kZipRequirementViolated = 1,
  kStateRequirementViolated = 2,
  kZipStateRequirementViolated = 3,
  kCityRequirementViolated = 4,
  kZipCityRequirementViolated = 5,
  kStateCityRequirementViolated = 6,
  kZipStateCityRequirementViolated = 7,
  kLine1RequirementViolated = 8,
  kLine1ZipRequirementViolated = 9,
  kLine1StateRequirementViolated = 10,
  kLine1ZipStateRequirementViolated = 11,
  kLine1CityRequirementViolated = 12,
  kLine1ZipCityRequirementViolated = 13,
  kLine1StateCityRequirementViolated = 14,
  kLine1ZipStateCityRequirementViolated = 15,
  kMaxValue = kLine1ZipStateCityRequirementViolated,
};

// These values are persisted to UMA logs. Entries should not be renumbered
// and numeric values should never be reused. These values represent the overall
// status of a profile import.
enum class AddressProfileImportStatusMetric {
  kNoImport = 0,
  kRegularImport = 1,
  // This value was deprecated in M113.
  kSectionUnionImport = 2,
  kMaxValue = kSectionUnionImport,
};

// These values are persisted to UMA logs. Entries should not be renumbered
// and numeric values should never be reused. Represents the zip code
// separator in extracted from form valid address profile considered for import.
// LINT.IfChange(AutofillZipCodeSeparators)
enum class AddressValidZipCodeSeparatorMetric {
  kNoSeparator = 0,
  kHyphenMinus = 1,
  kEnDash = 2,
  kEmDash = 3,
  kHyphen = 4,
  kNonBreakingHyphen = 5,
  kMinusSign = 6,
  kModifierMinus = 7,
  kFigureDash = 8,
  kHorizontalBar = 9,
  kSmallHyphenMinus = 10,
  kFullwidthHyphenMinus = 11,
  kSpace = 12,
  kNonBreakingSpace = 13,
  kEnSpace = 14,
  kEmSpace = 15,
  kThinSpace = 16,
  kIdeographicSpace = 17,
  kFigureSpace = 18,
  kNarrowNonBreakingSpace = 19,
  kOther = 20,
  kMaxValue = kOther,
};
// LINT.ThenChange(/tools/metrics/histograms/metadata/autofill/enums.xml:AutofillZipCodeSeparators)

// These values are persisted to UMA logs. Entries should not be renumbered
// and numeric values should never be reused. Represents the categories of
// field updates during profile merge.
enum class FieldMergeCategory {
  kCapitalizationUpdate = 1 << 0,
  kDiacriticAndCapitalizationUpdate = 1 << 1,
  kEmptyToNonEmpty = 1 << 2,
  kMaxValue = kEmptyToNonEmpty,
};

// Logs the address profile import UKM after the form submission.
// `user_decision` is the user's decision based on the storage prompt, if
// presented. `num_edited_fields` is the number of fields that were edited by
// the user before acceptance of the storage prompt. `profile_import_metadata`
// stores metadata related to the import of the address profiles.
void LogAddressProfileImportUkm(
    ukm::UkmRecorder* ukm_recorder,
    ukm::SourceId source_id,
    AutofillProfileImportType import_type,
    AutofillClient::AddressPromptUserDecision user_decision,
    const ProfileImportMetadata& profile_import_metadata,
    size_t num_edited_fields,
    std::optional<AutofillProfile> import_candidate,
    const std::vector<const AutofillProfile*>& existing_profiles,
    std::string_view app_locale);

// Logs the status of an address import requirement defined by type.
void LogAddressFormImportRequirementMetric(
    AddressProfileImportRequirementMetric metric);

// Logs the source of the country of a profile.
void LogAddressFormImportCountrySource(
    const ProfileImportMetadata& profile_import_metadata);

// Validates the profile import requirements and emits all the results.
// Additionally, logs country-specific field requirement metrics.
void LogAddressFormImportRequirementMetric(const AutofillProfile& profile);

// Logs the overall status of an address import upon form submission.
void LogAddressFormImportStatusMetric(AddressProfileImportStatusMetric metric);

// Logs details about silent profile updates.
void LogSilentUpdateMergeCategory(const AutofillProfile& old_profile,
                                  const AutofillProfile& new_profile);

// Logs the type of a profile import.
void LogProfileImportType(AutofillProfileImportType import_type);

// Logs the type of a profile import that are used for the silent updates.
void LogSilentUpdatesProfileImportType(AutofillProfileImportType import_type);

// Logs the user decision for importing a new profile with variants for ready
// users (users who have at least one profile stored already) and non-ready
// users. Besides this, decision is also recorded for the subset of ready users
// who have a quasi-duplicate profile stored, and also in a separate histogram
// for all users. Additionally, decision is logged for profiles extracted from
// forms with split zip code fields.
void LogNewProfileImportDecision(
    AutofillClient::AddressPromptUserDecision decision,
    const ProfileImportMetadata& profile_import_metadata,
    const std::vector<const AutofillProfile*>& existing_profiles,
    const AutofillProfile& import_candidate,
    std::string_view app_locale);

// Logs the user decision for importing a new profile created as a merge of
// `kAccountNameEmail` with either `kAccountHome` or `kAccountWork` profile.
void LogHomeWorkNameEmailMergeImportDecision(
    AutofillClient::AddressPromptUserDecision decision);

// Logs the user decision for updating an exiting profile with variants for
// users who have a quasi-duplicate profile stored (that is not
// `import_candidate`), and also in a separate histogram for all users
void LogProfileUpdateImportDecision(
    AutofillClient::AddressPromptUserDecision decision,
    const std::vector<const AutofillProfile*>& existing_profiles,
    const AutofillProfile& import_candidate,
    std::string_view app_locale);

// Logs the user decision for saving a name email profile superset.
void LogNameEmailSupersetImportDecision(
    AutofillClient::AddressPromptUserDecision decision);

// Logs the user decision for saving a home/work profile superset.
void LogHomeAndWorkSupersetImportDecision(
    AutofillClient::AddressPromptUserDecision decision);

// Logs that a home/work superset prompt was shown because a certain type
// has changed/was added.
void LogHomeAndWorkSupersetAffectedType(FieldType affected_type);

// Logs that a type was edited manually for a specified import type.
void LogProfileImportTypeEditedType(AutofillProfileImportType type,
                                    FieldType edited_type);

// Logs whether a phone number was parsed successfully on profile import.
// Contrary to the profile import requirement metrics, the parsing result is
// only emitted when a number is present.
void LogPhoneNumberImportParsingResult(bool parsed_successfully);

// Logs which storage a newly imported profile will be saved to.
void LogNewProfileStorageLocation(const AutofillProfile& import_candidate);

// Logs that a specific type changed in a profile update that received the
// user |decision|. Note that additional manual edits in the update prompt are
// not accounted for in this metric.
void LogProfileUpdateAffectedType(
    FieldType affected_type,
    AutofillClient::AddressPromptUserDecision decision);

// Logs the number of changed fields for a profile update that received the
// user |decision|. Note that additional manual edits in the update prompt are
// not accounted for in this metric.
void LogUpdateProfileNumberOfAffectedFields(
    int number_of_affected_fields,
    AutofillClient::AddressPromptUserDecision decision);

// Logs the user's decision for migrating an existing `kLocalOrSyncable` profile
// to `kAccount`.
void LogProfileMigrationImportDecision(
    AutofillClient::AddressPromptUserDecision decision);

// Logs the length of a zip code found in a valid and complete
// profile considered for import.
void LogZipCodeLengthMetric(std::u16string_view zip);

// Logs the specific zip code separator char found in a valid and complete
// profile considered for import.
void LogZipCodeSeparatorMetric(std::u16string_view zip);

// Logs the `user_decision` regarding a save prompt, but splits the decision
// based on the `submission_source`. Only logs metrics for specific values of
// `user_decision` and `submission_source`.
void LogNewProfileUserDecisionPerSubmissionSourceMetric(
    AutofillClient::AddressPromptUserDecision user_decision,
    mojom::SubmissionSource submission_source);

// Logs that `field_type` was removed from a profile on import because the
// value of this type is a placeholder.
void LogRemovedPlaceholderValue(FieldType field_type);

}  // namespace autofill::autofill_metrics

#endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_METRICS_PROFILE_IMPORT_METRICS_H_