// 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_QUALITY_METRICS_H_
#define COMPONENTS_AUTOFILL_CORE_BROWSER_METRICS_QUALITY_METRICS_H_

#include "base/time/time.h"
#include "components/autofill/core/browser/form_structure.h"
#include "components/autofill/core/browser/suggestions/suggestion_util.h"
#include "services/metrics/public/cpp/ukm_source_id.h"

namespace autofill::autofill_metrics {

class FormInteractionsUkmLogger;

// Denotes the character set of the submitted alternative name field.
// These values are persisted to UMA logs. Entries should not be renumbered and
// numeric values should never be reused. Keep this enum up to date with the one
// in tools/metrics/histograms/metadata/autofill/enums.xml.
enum class AutofillAlternativeNameFieldValueCharacterSet {
  kKatakana = 0,
  kHiragana = 1,
  kOther = 2,
  kMaxValue = kOther
};

// Logs quality metrics for the `form_structure`.
// This method should only be called after the possible field types have been
// set for each field.
// `interaction_time` corresponds to the user's first interaction with the form.
// `now` corresponds to the form's submission time.
// `source_id` is the UKM source ID of the page at the time of the submission
// (which may be distinct from the current page because this function is called
// asynchronously).
// `observed_submission` indicates whether this method is called as a result of
// observing a submission event (otherwise, it may be that an upload was
// triggered after a form was unfocused or a navigation occurred).
void LogQualityMetrics(
    const FormStructure& form_structure,
    base::TimeTicks load_time,
    base::TimeTicks interaction_time,
    base::TimeTicks now,
    FormInteractionsUkmLogger& form_interactions_ukm_logger,
    ukm::SourceId source_id,
    bool observed_submission,
    AutocompleteUnrecognizedBehavior ac_unrecognized_behavior);

// Log the quality of the heuristics and server predictions for the
// `form_structure` structure, if autocomplete attributes are present on the
// fields (they are used as golden truths).
// `source_id` is the UKM source ID of the page at the time of the submission.
void LogQualityMetricsBasedOnAutocomplete(
    const FormStructure& form_structure,
    FormInteractionsUkmLogger& form_interactions_ukm_logger,
    ukm::SourceId source_id);

}  // namespace autofill::autofill_metrics

#endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_METRICS_QUALITY_METRICS_H_