// Copyright 2020 The Chromium Authors // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include "components/translate/core/browser/translate_metrics_logger_impl.h" #include #include #include #include "base/logging.h" #include "base/metrics/metrics_hashes.h" #include "base/test/metrics/histogram_tester.h" #include "base/test/simple_test_tick_clock.h" #include "base/test/task_environment.h" #include "base/time/time.h" #include "components/language/core/browser/language_prefs.h" #include "components/sync_preferences/testing_pref_service_syncable.h" #include "components/ukm/test_ukm_recorder.h" #include "services/metrics/public/cpp/metrics_utils.h" #include "services/metrics/public/cpp/ukm_builders.h" #include "testing/gtest/include/gtest/gtest.h" namespace translate { namespace testing { namespace { constexpr const char* kAllUkmMetricNames[] = { ukm::builders::TranslatePageLoad::kSequenceNumberName, ukm::builders::TranslatePageLoad::kTriggerDecisionName, ukm::builders::TranslatePageLoad::kRankerDecisionName, ukm::builders::TranslatePageLoad::kRankerVersionName, ukm::builders::TranslatePageLoad::kInitialStateName, ukm::builders::TranslatePageLoad::kFinalStateName, ukm::builders::TranslatePageLoad::kNumTranslationsName, ukm::builders::TranslatePageLoad::kNumReversionsName, ukm::builders::TranslatePageLoad::kInitialSourceLanguageName, ukm::builders::TranslatePageLoad::kFinalSourceLanguageName, ukm::builders::TranslatePageLoad:: kInitialSourceLanguageInContentLanguagesName, ukm::builders::TranslatePageLoad::kInitialTargetLanguageName, ukm::builders::TranslatePageLoad::kFinalTargetLanguageName, ukm::builders::TranslatePageLoad::kNumTargetLanguageChangesName, ukm::builders::TranslatePageLoad::kFirstUIInteractionName, ukm::builders::TranslatePageLoad::kNumUIInteractionsName, ukm::builders::TranslatePageLoad::kFirstTranslateErrorName, ukm::builders::TranslatePageLoad::kNumTranslateErrorsName, ukm::builders::TranslatePageLoad::kTotalTimeTranslatedName, ukm::builders::TranslatePageLoad::kTotalTimeNotTranslatedName, ukm::builders::TranslatePageLoad::kMaxTimeToTranslateName, ukm::builders::TranslatePageLoad::kHTMLDocumentLanguageName, ukm::builders::TranslatePageLoad::kHTMLContentLanguageName, ukm::builders::TranslatePageLoad::kModelDetectedLanguageName, ukm::builders::TranslatePageLoad::kModelDetectionReliabilityScoreName}; } // namespace class TranslateMetricsLoggerImplTest : public ::testing::Test { public: void ResetTest() { translate_metrics_logger_ = std::make_unique( nullptr /*translate_manager*/); histogram_tester_ = std::make_unique(); test_ukm_recorder_ = std::make_unique(); } void SetUp() override { ResetTest(); } TranslateMetricsLoggerImpl* translate_metrics_logger() { return translate_metrics_logger_.get(); } base::HistogramTester* histogram_tester() { return histogram_tester_.get(); } ukm::TestAutoSetUkmRecorder* test_ukm_recorder() { return test_ukm_recorder_.get(); } void SimulateAndCheckManualTranslation( bool is_context_menu_initiated_translation, bool was_translation_successful, TranslateErrors translate_error_type, TranslationType expected_translation_type, TranslationStatus expected_translation_status) { if (was_translation_successful) EXPECT_EQ(translate_error_type, TranslateErrors::NONE); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( is_context_menu_initiated_translation)); translate_metrics_logger()->LogTranslationFinished( was_translation_successful, translate_error_type); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample(kTranslateTranslationType, expected_translation_type, 1); histogram_tester()->ExpectUniqueSample(kTranslateTranslationStatus, expected_translation_status, 1); CheckTranslateStateHistograms( TranslateState::kNotTranslatedNoUI, (was_translation_successful ? TranslateState::kTranslatedNoUI : TranslateState::kNotTranslatedNoUI), (was_translation_successful ? 1 : 0), 0); CheckTranslateErrors( translate_error_type, (translate_error_type != TranslateErrors::NONE ? 1 : 0)); } void SimulateAndCheckRepeatedManualTranslationsAndReversions( int num_translations_and_reversions, bool is_context_menu_initiated_translation, TranslationType expected_initial_translation_type, TranslationType expected_re_translation_type, TranslationStatus expected_translation_status) { translate_metrics_logger()->LogInitialState(); for (int i = 0; i < num_translations_and_reversions; i++) { translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( is_context_menu_initiated_translation)); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->LogReversion(); } translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectTotalCount(kTranslateTranslationType, num_translations_and_reversions); histogram_tester()->ExpectBucketCount(kTranslateTranslationType, expected_initial_translation_type, 1); histogram_tester()->ExpectBucketCount(kTranslateTranslationType, expected_re_translation_type, num_translations_and_reversions - 1); histogram_tester()->ExpectUniqueSample(kTranslateTranslationStatus, expected_translation_status, num_translations_and_reversions); CheckTranslateStateHistograms( TranslateState::kNotTranslatedNoUI, TranslateState::kNotTranslatedNoUI, num_translations_and_reversions, num_translations_and_reversions); CheckTranslateErrors(TranslateErrors::NONE, 0); } void SimulateAndCheckAutomaticThenManualTranslation( bool is_context_menu_initiated_translation, TranslationType expected_manual_translation_type, TranslationStatus expected_manual_translation_status) { translate_metrics_logger()->LogTranslationStarted( TranslationType::kAutomaticTranslationByPref); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->LogReversion(); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( is_context_menu_initiated_translation)); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectTotalCount(kTranslateTranslationType, 2); histogram_tester()->ExpectBucketCount( kTranslateTranslationType, TranslationType::kAutomaticTranslationByPref, 1); histogram_tester()->ExpectBucketCount(kTranslateTranslationType, expected_manual_translation_type, 1); histogram_tester()->ExpectTotalCount(kTranslateTranslationStatus, 2); histogram_tester()->ExpectBucketCount( kTranslateTranslationStatus, TranslationStatus::kRevertedAutomaticTranslation, 1); histogram_tester()->ExpectBucketCount( kTranslateTranslationStatus, expected_manual_translation_status, 1); CheckTranslateStateHistograms(TranslateState::kTranslatedNoUI, TranslateState::kTranslatedNoUI, 2, 1); CheckTranslateErrors(TranslateErrors::NONE, 0); } void CheckTranslateStateHistograms(TranslateState expected_initial_state, TranslateState expected_final_state, int expected_num_translations, int expected_num_reversions) { histogram_tester()->ExpectUniqueSample(kTranslatePageLoadInitialState, expected_initial_state, 1); histogram_tester()->ExpectUniqueSample(kTranslatePageLoadFinalState, expected_final_state, 1); histogram_tester()->ExpectUniqueSample(kTranslatePageLoadNumTranslations, expected_num_translations, 1); histogram_tester()->ExpectUniqueSample(kTranslatePageLoadNumReversions, expected_num_reversions, 1); } void CheckTranslateErrors(TranslateErrors first_translate_error_type, int num_translate_errors) { EXPECT_EQ(translate_metrics_logger_->first_translate_error_type_, first_translate_error_type); EXPECT_EQ(translate_metrics_logger_->num_translate_errors_, num_translate_errors); } void CheckTotalTimeTranslated(base::TimeDelta total_time_translated, base::TimeDelta total_time_not_translated) { EXPECT_EQ(translate_metrics_logger_->total_time_translated_, total_time_translated); EXPECT_EQ(translate_metrics_logger_->total_time_not_translated_, total_time_not_translated); } void CheckMaxTimeToTranslate(base::TimeDelta expected_max_time_to_translate) { EXPECT_EQ(translate_metrics_logger_->max_time_to_translate_, expected_max_time_to_translate); } void CheckUIInteractions(UIInteraction expected_first_ui_interaction, int expected_num_ui_interactions) { EXPECT_EQ(translate_metrics_logger_->first_ui_interaction_, expected_first_ui_interaction); EXPECT_EQ(translate_metrics_logger_->num_ui_interactions_, expected_num_ui_interactions); } // Helper functions to check that the metrics in the given UKM entry match // expectations. void CheckUkmEntrySequenceNumber( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, int expected_sequence_number) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kSequenceNumberName), expected_sequence_number); } void CheckUkmEntryTriggerDecision( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, TriggerDecision expected_trigger_decision) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kTriggerDecisionName), int(expected_trigger_decision)); } void CheckUkmEntryRankerDecision( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, RankerDecision expected_ranker_decision) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kRankerDecisionName), int(expected_ranker_decision)); } void CheckUkmEntryRankerVersion( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, uint32_t expected_ranker_version) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kRankerVersionName), int(expected_ranker_version)); } void CheckUkmEntryInitialState( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, TranslateState expected_initial_state) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kInitialStateName), int(expected_initial_state)); } void CheckUkmEntryFinalState( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, TranslateState expected_final_state) { EXPECT_EQ( ukm_entry.metrics.at(ukm::builders::TranslatePageLoad::kFinalStateName), int(expected_final_state)); } void CheckUkmEntryNumTranslations( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, int expected_num_translations) { EXPECT_EQ( ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kNumTranslationsName), ukm::GetExponentialBucketMinForCounts1000(expected_num_translations)); } void CheckUkmEntryNumReversions( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, int expected_num_reversions) { EXPECT_EQ( ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kNumReversionsName), ukm::GetExponentialBucketMinForCounts1000(expected_num_reversions)); } void CheckUkmEntryInitialSourceLanguage( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const std::string& expected_initial_source_language) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kInitialSourceLanguageName), int(base::HashMetricName(expected_initial_source_language))); } void CheckUkmEntryFinalSourceLanguage( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const std::string& expected_final_source_language) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kFinalSourceLanguageName), int(base::HashMetricName(expected_final_source_language))); } void CheckUkmEntryInitialSourceLanguageInContentLanguages( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, bool expected_is_initial_source_language_in_content_languages) { EXPECT_EQ( ukm_entry.metrics.at(ukm::builders::TranslatePageLoad:: kInitialSourceLanguageInContentLanguagesName), int(expected_is_initial_source_language_in_content_languages)); } void CheckUkmEntryInitialTargetLanguage( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const std::string& expected_initial_target_language) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kInitialTargetLanguageName), int(base::HashMetricName(expected_initial_target_language))); } void CheckUkmEntryHTMLDocumentLanguage( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const std::string& expected_html_doc_language) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kHTMLDocumentLanguageName), int(base::HashMetricName(expected_html_doc_language))); } void CheckUkmEntryHTMLContentLanguage( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const std::string& expected_html_content_language) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kHTMLContentLanguageName), int(base::HashMetricName(expected_html_content_language))); } void CheckUkmEntryModelDetectionReliabilityScore( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const float& expected_model_detection_reliability_score) { EXPECT_EQ(ukm_entry.metrics.at(ukm::builders::TranslatePageLoad:: kModelDetectionReliabilityScoreName), ukm::GetLinearBucketMin( static_cast( 100 * expected_model_detection_reliability_score), 5)); } void CheckUkmEntryModelDetectedLanguage( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const std::string& expected_model_detected_language) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kModelDetectedLanguageName), int(base::HashMetricName(expected_model_detected_language))); } void CheckUkmEntryFinalTargetLanguage( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const std::string& expected_final_target_language) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kFinalTargetLanguageName), int(base::HashMetricName(expected_final_target_language))); } void CheckUkmEntryNumTargetLanguageChanges( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, int expected_num_target_language_changes) { EXPECT_EQ( ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kNumTargetLanguageChangesName), ukm::GetExponentialBucketMinForCounts1000( expected_num_target_language_changes)); } void CheckUkmEntryFirstUIInteraction( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, UIInteraction expected_first_ui_interaction) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kFirstUIInteractionName), int(expected_first_ui_interaction)); } void CheckUkmEntryNumUIInteractions( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, int expected_num_ui_interactions) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kNumUIInteractionsName), ukm::GetExponentialBucketMinForCounts1000( expected_num_ui_interactions)); } void CheckUkmEntryFirstTranslateError( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, TranslateErrors expected_first_translate_error) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kFirstTranslateErrorName), int(expected_first_translate_error)); } void CheckUkmEntryNumTranslateErrors( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, int expected_num_translate_errors) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kNumTranslateErrorsName), ukm::GetExponentialBucketMinForCounts1000( expected_num_translate_errors)); } void CheckUkmEntryTotalTimeTranslated( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const base::TimeDelta& expected_total_time_translated) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kTotalTimeTranslatedName), ukm::GetExponentialBucketMinForUserTiming( expected_total_time_translated.InSeconds())); } void CheckUkmEntryTotalTimeNotTranslated( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const base::TimeDelta& expected_total_time_not_translated) { EXPECT_EQ( ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kTotalTimeNotTranslatedName), ukm::GetExponentialBucketMinForUserTiming( expected_total_time_not_translated.InSeconds())); } void CheckUkmEntryMaxTimeToTranslate( const ukm::TestUkmRecorder::HumanReadableUkmEntry& ukm_entry, const base::TimeDelta& expected_max_time_to_translate) { EXPECT_EQ(ukm_entry.metrics.at( ukm::builders::TranslatePageLoad::kMaxTimeToTranslateName), ukm::GetExponentialBucketMinForUserTiming( expected_max_time_to_translate.InMilliseconds())); } private: // Needed to set up the test UKM recorder. base::test::SingleThreadTaskEnvironment task_environment_; // Test target. std::unique_ptr translate_metrics_logger_; // Records the UMA histograms for each test. std::unique_ptr histogram_tester_; // Record the UKM protos for each test. std::unique_ptr test_ukm_recorder_; }; TEST_F(TranslateMetricsLoggerImplTest, RecordUkmMetrics) { // Establish constants for this test. base::SimpleTestTickClock test_clock; constexpr base::TimeDelta delay1 = base::Seconds(100); constexpr base::TimeDelta delay2 = base::Seconds(200); constexpr base::TimeDelta delay3 = base::Seconds(300); constexpr base::TimeDelta delay4 = base::Seconds(400); constexpr base::TimeDelta delay5 = base::Seconds(500); constexpr base::TimeDelta translation_delay1 = base::Seconds(10); constexpr base::TimeDelta translation_delay2 = base::Seconds(30); constexpr base::TimeDelta translation_delay3 = base::Seconds(20); const ukm::SourceId ukm_source_id = 4321; const RankerDecision ranker_decision = RankerDecision::kShowUI; const uint32_t ranker_model_version = 1234; const TriggerDecision trigger_decision = TriggerDecision::kDisabledNeverTranslateSite; const std::string initial_source_language = "es"; const bool is_initial_source_language_in_users_content_languages = true; const std::string final_source_language = "it"; const std::string initial_target_language = "de"; const std::string final_target_language = "fr"; const std::string html_doc_language = "es"; const std::string html_content_language = "es"; const std::string model_detected_language = "es"; const float model_detection_reliability_score = .5; // Simulate a page load where the following happens: the Ranker decides to // show the translate UI, the user initiates a manual translation which // finishes without an error, the user reverts the translations, the user // changes the source and target language, the user starts another // translation but this one fails due to a network error, the user tries to // translate again and this time the translation succeeds, and then finally // the user closes the translate UI. translate_metrics_logger()->SetInternalClockForTesting(&test_clock); translate_metrics_logger()->OnPageLoadStart(true); translate_metrics_logger()->SetUkmSourceId(ukm_source_id); translate_metrics_logger()->LogInitialSourceLanguage( initial_source_language, is_initial_source_language_in_users_content_languages); translate_metrics_logger()->LogTargetLanguage( initial_target_language, TranslateBrowserMetrics::TargetLanguageOrigin::kLanguageModel); translate_metrics_logger()->LogRankerMetrics(ranker_decision, ranker_model_version); translate_metrics_logger()->LogTriggerDecision(trigger_decision); translate_metrics_logger()->LogUIChange(true); translate_metrics_logger()->LogInitialState(); test_clock.Advance(delay1); translate_metrics_logger()->LogUIInteraction(UIInteraction::kTranslate); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); test_clock.Advance(translation_delay1); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); test_clock.Advance(delay2); translate_metrics_logger()->LogUIInteraction(UIInteraction::kRevert); translate_metrics_logger()->LogReversion(); test_clock.Advance(delay3); translate_metrics_logger()->LogUIInteraction( UIInteraction::kChangeSourceLanguage); translate_metrics_logger()->LogSourceLanguage(final_source_language); translate_metrics_logger()->LogUIInteraction( UIInteraction::kChangeTargetLanguage); translate_metrics_logger()->LogTargetLanguage( final_target_language, TranslateBrowserMetrics::TargetLanguageOrigin::kChangedByUser); translate_metrics_logger()->LogHTMLDocumentLanguage(html_doc_language); translate_metrics_logger()->LogHTMLContentLanguage(html_content_language); translate_metrics_logger()->LogDetectionReliabilityScore( model_detection_reliability_score); translate_metrics_logger()->LogDetectedLanguage(model_detected_language); translate_metrics_logger()->LogUIInteraction(UIInteraction::kTranslate); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); test_clock.Advance(translation_delay2); translate_metrics_logger()->LogTranslationFinished(false, TranslateErrors::NETWORK); test_clock.Advance(delay4); translate_metrics_logger()->LogUIInteraction(UIInteraction::kTranslate); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); test_clock.Advance(translation_delay3); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); test_clock.Advance(delay5); translate_metrics_logger()->LogUIInteraction( UIInteraction::kCloseUIExplicitly); translate_metrics_logger()->LogUIChange(false); // Record stored metrics. translate_metrics_logger()->RecordMetrics(true); // Check that the recorded UKM proto matches expectations. auto ukm_entries = test_ukm_recorder()->GetEntries( ukm::builders::TranslatePageLoad::kEntryName, std::vector(std::begin(kAllUkmMetricNames), std::end(kAllUkmMetricNames))); // Expect that ukm_entries has one element. EXPECT_EQ(ukm_entries.size(), 1u); // Only element has a source_id of ukm_source_id EXPECT_EQ(ukm_entries[0].source_id, ukm_source_id); // Check each metric in the UKM entry. CheckUkmEntrySequenceNumber(ukm_entries[0], 0); CheckUkmEntryTriggerDecision(ukm_entries[0], trigger_decision); CheckUkmEntryRankerDecision(ukm_entries[0], ranker_decision); CheckUkmEntryRankerVersion(ukm_entries[0], ranker_model_version); CheckUkmEntryInitialState(ukm_entries[0], TranslateState::kNotTranslatedUIShown); CheckUkmEntryFinalState(ukm_entries[0], TranslateState::kTranslatedNoUI); CheckUkmEntryNumTranslations(ukm_entries[0], 2); CheckUkmEntryNumReversions(ukm_entries[0], 1); CheckUkmEntryInitialSourceLanguage(ukm_entries[0], initial_source_language); CheckUkmEntryFinalSourceLanguage(ukm_entries[0], final_source_language); CheckUkmEntryInitialSourceLanguageInContentLanguages( ukm_entries[0], is_initial_source_language_in_users_content_languages); CheckUkmEntryInitialTargetLanguage(ukm_entries[0], initial_target_language); CheckUkmEntryHTMLDocumentLanguage(ukm_entries[0], html_doc_language); CheckUkmEntryHTMLDocumentLanguage(ukm_entries[0], html_content_language); CheckUkmEntryModelDetectionReliabilityScore( ukm_entries[0], model_detection_reliability_score); CheckUkmEntryModelDetectedLanguage(ukm_entries[0], model_detected_language); CheckUkmEntryFinalTargetLanguage(ukm_entries[0], final_target_language); CheckUkmEntryNumTargetLanguageChanges(ukm_entries[0], 1); CheckUkmEntryFirstUIInteraction(ukm_entries[0], UIInteraction::kTranslate); CheckUkmEntryNumUIInteractions(ukm_entries[0], 7); CheckUkmEntryFirstTranslateError(ukm_entries[0], TranslateErrors::NETWORK); CheckUkmEntryNumTranslateErrors(ukm_entries[0], 1); CheckUkmEntryTotalTimeTranslated(ukm_entries[0], delay2 + delay5); CheckUkmEntryTotalTimeNotTranslated( ukm_entries[0], delay1 + delay3 + delay4 + translation_delay1 + translation_delay2 + translation_delay3); CheckUkmEntryMaxTimeToTranslate(ukm_entries[0], translation_delay3); } TEST_F(TranslateMetricsLoggerImplTest, MultipleRecordMetrics) { // Set test constants and log them with the test target. RankerDecision ranker_decision = RankerDecision::kShowUI; uint32_t ranker_model_version = 1234; TriggerDecision trigger_decision = TriggerDecision::kDisabledNeverTranslateLanguage; translate_metrics_logger()->LogRankerMetrics(ranker_decision, ranker_model_version); translate_metrics_logger()->LogTriggerDecision(trigger_decision); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogUIChange(true); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->LogReversion(); // Simulate |RecordMetrics| being called multiple times. translate_metrics_logger()->RecordMetrics(false); translate_metrics_logger()->RecordMetrics(false); translate_metrics_logger()->RecordMetrics(true); // The page-load UMA metrics should only be logged when the first // |RecordMetrics| is called. Subsequent calls shouldn't cause UMA metrics to // be logged. histogram_tester()->ExpectUniqueSample(kTranslatePageLoadRankerDecision, ranker_decision, 1); histogram_tester()->ExpectUniqueSample(kTranslatePageLoadRankerVersion, ranker_model_version, 1); histogram_tester()->ExpectUniqueSample(kTranslatePageLoadTriggerDecision, trigger_decision, 1); CheckTranslateStateHistograms(TranslateState::kNotTranslatedNoUI, TranslateState::kNotTranslatedUIShown, 1, 1); } TEST_F(TranslateMetricsLoggerImplTest, LogRankerMetrics) { base::SimpleTestTickClock test_clock; translate_metrics_logger()->SetInternalClockForTesting(&test_clock); RankerDecision ranker_decision = RankerDecision::kDontShowUI; uint32_t ranker_model_version = 4321; translate_metrics_logger()->LogRankerStart(); test_clock.Advance(base::Seconds(10)); translate_metrics_logger()->LogRankerFinish(); translate_metrics_logger()->LogRankerMetrics(ranker_decision, ranker_model_version); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample( kTranslatePageLoadRankerTimerShouldOfferTranslation, base::Seconds(10).InMilliseconds(), 1); histogram_tester()->ExpectUniqueSample(kTranslatePageLoadRankerDecision, ranker_decision, 1); histogram_tester()->ExpectUniqueSample(kTranslatePageLoadRankerVersion, ranker_model_version, 1); } TEST_F(TranslateMetricsLoggerImplTest, LogTriggerDecision) { // If we log multiple trigger decisions, we expect to only record the first // value to Translate.PageLoad.TriggerDecision. All of the values will be // captured by Translate.PageLoad.TriggerDecision.TotalCount and // Translate.PageLoad.TriggerDecision.AllTriggerDecisions. const auto kTriggerDecisions = std::to_array({ TriggerDecision::kAutomaticTranslationByLink, TriggerDecision::kDisabledByRanker, TriggerDecision::kDisabledUnsupportedLanguage, TriggerDecision::kDisabledOffline, TriggerDecision::kDisabledTranslationFeatureDisabled, TriggerDecision::kShowUI, TriggerDecision::kDisabledByRanker, TriggerDecision::kDisabledOffline, TriggerDecision::kDisabledNeverTranslateLanguage, TriggerDecision::kDisabledMatchesPreviousLanguage, }); for (const auto& trigger_decision : kTriggerDecisions) translate_metrics_logger()->LogTriggerDecision(trigger_decision); translate_metrics_logger()->RecordMetrics(true); // Check that we record only the highest priority value to // Translate.PageLoad.TriggerDecision. histogram_tester()->ExpectUniqueSample(kTranslatePageLoadTriggerDecision, kTriggerDecisions[0], 1); // Make sure that the href trigger decision wasn't logged. histogram_tester()->ExpectTotalCount(kTranslatePageLoadHrefTriggerDecision, 0); } TEST_F(TranslateMetricsLoggerImplTest, LogHrefTriggerDecision) { // If we log multiple trigger decisions, we expect that only the first one is // recorded. const auto kTriggerDecisions = std::to_array({ TriggerDecision::kAutomaticTranslationByLink, TriggerDecision::kDisabledByRanker, TriggerDecision::kDisabledUnsupportedLanguage, TriggerDecision::kDisabledOffline, TriggerDecision::kDisabledTranslationFeatureDisabled, TriggerDecision::kShowUI, TriggerDecision::kDisabledByRanker, TriggerDecision::kDisabledOffline, TriggerDecision::kDisabledNeverTranslateLanguage, }); for (const auto& trigger_decision : kTriggerDecisions) translate_metrics_logger()->LogTriggerDecision(trigger_decision); translate_metrics_logger()->SetHasHrefTranslateTarget(true); translate_metrics_logger()->RecordMetrics(true); // CHeck that the main trigger decision histogram was logged. histogram_tester()->ExpectUniqueSample(kTranslatePageLoadTriggerDecision, kTriggerDecisions[0], 1); // Make sure that the href trigger decision was logged. histogram_tester()->ExpectUniqueSample(kTranslatePageLoadHrefTriggerDecision, kTriggerDecisions[0], 1); } TEST_F(TranslateMetricsLoggerImplTest, LogHrefOverrideTriggerDecision) { // Check that the TriggerDecision::kAutomaticTranslationByHref overrides the // earlier trigger decision. translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kDisabledDoesntNeedTranslation); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kAutomaticTranslationByHref); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample( kTranslatePageLoadTriggerDecision, TriggerDecision::kAutomaticTranslationByHref, 1); // Check that the TriggerDecision::kShowUIFromHref overrides the earlier // trigger decision. ResetTest(); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kDisabledDoesntNeedTranslation); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kShowUIFromHref); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample(kTranslatePageLoadTriggerDecision, TriggerDecision::kShowUIFromHref, 1); // Check that TriggerDecision::kShowUIFromHref doesn't override // TriggerDecision::kAutomaticTranslationByHref. ResetTest(); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kDisabledDoesntNeedTranslation); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kAutomaticTranslationByHref); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kShowUIFromHref); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample( kTranslatePageLoadTriggerDecision, TriggerDecision::kAutomaticTranslationByHref, 1); } TEST_F(TranslateMetricsLoggerImplTest, LogAutotranslateToPredefinedTargetOverrideTriggerDecision) { // Check that the TriggerDecision::kAutomaticTranslationToPredefinedTarget // overrides the earlier trigger decision. translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kDisabledDoesntNeedTranslation); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kAutomaticTranslationToPredefinedTarget); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample( kTranslatePageLoadTriggerDecision, TriggerDecision::kAutomaticTranslationToPredefinedTarget, 1); // Check that TriggerDecision::kAutomaticTranslationToPredefinedTarget doesn't // override TriggerDecision::kAutomaticTranslationByHref. ResetTest(); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kDisabledDoesntNeedTranslation); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kAutomaticTranslationByHref); translate_metrics_logger()->LogTriggerDecision( TriggerDecision::kAutomaticTranslationToPredefinedTarget); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample( kTranslatePageLoadTriggerDecision, TriggerDecision::kAutomaticTranslationByHref, 1); } TEST_F(TranslateMetricsLoggerImplTest, LogTranslationAndReversion) { // Simulate a page load where the user translates a page via the Translate UI // and it is successful. SimulateAndCheckManualTranslation( false, true, TranslateErrors::NONE, TranslationType::kManualUiInitialTranslation, TranslationStatus::kSuccessFromManualUiTranslation); // Simulate a page load where the user translates a page via the Context Menu // and it is successful. ResetTest(); SimulateAndCheckManualTranslation( true, true, TranslateErrors::NONE, TranslationType::kManualContextMenuInitialTranslation, TranslationStatus::kSuccessFromManualContextMenuTranslation); // Simulate a failed manual translation via the Translate UI with an error. ResetTest(); SimulateAndCheckManualTranslation( false, false, TranslateErrors::NETWORK, TranslationType::kManualUiInitialTranslation, TranslationStatus::kFailedWithErrorManualUiTranslation); // Simulate a failed manual translation via the Context Menu with an error. ResetTest(); SimulateAndCheckManualTranslation( true, false, TranslateErrors::NETWORK, TranslationType::kManualContextMenuInitialTranslation, TranslationStatus::kFailedWithErrorManualContextMenuTranslation); // Simulate a failed manualtranslation via the Translate UI without an error. ResetTest(); SimulateAndCheckManualTranslation( false, false, TranslateErrors::NONE, TranslationType::kManualUiInitialTranslation, TranslationStatus::kFailedWithNoErrorManualUiTranslation); // Simulate a failed manualtranslation via the Context Menu without an error. ResetTest(); SimulateAndCheckManualTranslation( true, false, TranslateErrors::NONE, TranslationType::kManualContextMenuInitialTranslation, TranslationStatus::kFailedWithNoErrorManualContextMenuTranslation); // Simulate a translation that does not finish. ResetTest(); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample( kTranslateTranslationType, TranslationType::kManualUiInitialTranslation, 1); histogram_tester()->ExpectUniqueSample( kTranslateTranslationStatus, TranslationStatus::kTranslationAbandoned, 1); CheckTranslateStateHistograms(TranslateState::kNotTranslatedNoUI, TranslateState::kNotTranslatedNoUI, 0, 0); CheckTranslateErrors(TranslateErrors::NONE, 0); // Simulate translating an already translated page, but the second translation // fails. ResetTest(); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->LogTranslationFinished(false, TranslateErrors::NETWORK); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectTotalCount(kTranslateTranslationType, 2); histogram_tester()->ExpectBucketCount( kTranslateTranslationType, TranslationType::kManualUiInitialTranslation, 1); histogram_tester()->ExpectBucketCount( kTranslateTranslationType, TranslationType::kManualUiReTranslation, 1); histogram_tester()->ExpectTotalCount(kTranslateTranslationStatus, 2); histogram_tester()->ExpectBucketCount(kTranslateTranslationStatus, TranslationStatus::kNewTranslation, 1); histogram_tester()->ExpectBucketCount( kTranslateTranslationStatus, TranslationStatus::kFailedWithErrorManualUiTranslation, 1); CheckTranslateStateHistograms(TranslateState::kNotTranslatedNoUI, TranslateState::kTranslatedNoUI, 1, 0); CheckTranslateErrors(TranslateErrors::NETWORK, 1); // Simulate a page load where a second translation is started before the first // translation is finished. ResetTest(); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectTotalCount(kTranslateTranslationType, 2); histogram_tester()->ExpectBucketCount( kTranslateTranslationType, TranslationType::kManualUiInitialTranslation, 1); histogram_tester()->ExpectBucketCount( kTranslateTranslationType, TranslationType::kManualUiReTranslation, 1); histogram_tester()->ExpectTotalCount(kTranslateTranslationStatus, 2); histogram_tester()->ExpectBucketCount( kTranslateTranslationStatus, TranslationStatus::kSuccessFromManualUiTranslation, 1); histogram_tester()->ExpectBucketCount(kTranslateTranslationStatus, TranslationStatus::kNewTranslation, 1); CheckTranslateStateHistograms(TranslateState::kNotTranslatedNoUI, TranslateState::kTranslatedNoUI, 1, 0); CheckTranslateErrors(TranslateErrors::NONE, 0); // Simulate an auto translation where the translation does not finish. ResetTest(); translate_metrics_logger()->LogTranslationStarted( TranslationType::kAutomaticTranslationByPref); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample( kTranslateTranslationType, TranslationType::kAutomaticTranslationByPref, 1); histogram_tester()->ExpectUniqueSample( kTranslateTranslationStatus, TranslationStatus::kTranslationAbandoned, 1); CheckTranslateStateHistograms(TranslateState::kNotTranslatedNoUI, TranslateState::kNotTranslatedNoUI, 0, 0); CheckTranslateErrors(TranslateErrors::NONE, 0); // Simulate a page that is repeatedly manually translated via the Translate UI // and then reverted. ResetTest(); SimulateAndCheckRepeatedManualTranslationsAndReversions( 100, false, TranslationType::kManualUiInitialTranslation, TranslationType::kManualUiReTranslation, TranslationStatus::kRevertedManualUiTranslation); // Simulate a page that is repeatedly manually translated via the Context Menu // and then reverted. ResetTest(); SimulateAndCheckRepeatedManualTranslationsAndReversions( 100, true, TranslationType::kManualContextMenuInitialTranslation, TranslationType::kManualContextMenuReTranslation, TranslationStatus::kRevertedManualContextMenuTranslation); // Simulates a page that is automatically translated, then reverted, and // finally manually translated via either the Translate UI. ResetTest(); SimulateAndCheckAutomaticThenManualTranslation( false, TranslationType::kManualUiReTranslation, TranslationStatus::kSuccessFromManualUiTranslation); // Simulates a page that is automatically translated, then reverted, and // finally manually translated via either the Context Menu ResetTest(); SimulateAndCheckAutomaticThenManualTranslation( true, TranslationType::kManualContextMenuReTranslation, TranslationStatus::kSuccessFromManualContextMenuTranslation); } TEST_F(TranslateMetricsLoggerImplTest, LogAutoTranslationSuccess) { const struct { TranslationType translation_type; TranslationStatus expected_translation_status; } kTests[] = { {TranslationType::kAutomaticTranslationByPref, TranslationStatus::kSuccessFromAutomaticTranslationByPref}, {TranslationType::kAutomaticTranslationByLink, TranslationStatus::kSuccessFromAutomaticTranslationByLink}, {TranslationType::kAutomaticTranslationToPredefinedTarget, TranslationStatus::kSuccessFromAutomaticTranslationToPredefinedTarget}, {TranslationType::kAutomaticTranslationByHref, TranslationStatus::kSuccessFromAutomaticTranslationByHref}, }; for (const auto& test : kTests) { translate_metrics_logger()->LogTranslationStarted(test.translation_type); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample(kTranslateTranslationType, test.translation_type, 1); histogram_tester()->ExpectUniqueSample(kTranslateTranslationStatus, test.expected_translation_status, 1); CheckTranslateStateHistograms(TranslateState::kTranslatedNoUI, TranslateState::kTranslatedNoUI, 1, 0); CheckTranslateErrors(TranslateErrors::NONE, 0); ResetTest(); } } TEST_F(TranslateMetricsLoggerImplTest, LogAutoTranslationFailed) { const struct { TranslationType translation_type; TranslateErrors translate_error_type; TranslationStatus expected_translation_status; } kTests[] = { {TranslationType::kAutomaticTranslationByPref, TranslateErrors::NONE, TranslationStatus::kFailedWithNoErrorAutomaticTranslation}, {TranslationType::kAutomaticTranslationByPref, TranslateErrors::NETWORK, TranslationStatus::kFailedWithErrorAutomaticTranslation}, {TranslationType::kAutomaticTranslationByLink, TranslateErrors::NONE, TranslationStatus::kFailedWithNoErrorAutomaticTranslation}, {TranslationType::kAutomaticTranslationByLink, TranslateErrors::NETWORK, TranslationStatus::kFailedWithErrorAutomaticTranslation}, {TranslationType::kAutomaticTranslationToPredefinedTarget, TranslateErrors::NONE, TranslationStatus:: kFailedWithNoErrorAutomaticTranslationToPredefinedTarget}, {TranslationType::kAutomaticTranslationToPredefinedTarget, TranslateErrors::NETWORK, TranslationStatus:: kFailedWithErrorAutomaticTranslationToPredefinedTarget}, {TranslationType::kAutomaticTranslationByHref, TranslateErrors::NONE, TranslationStatus::kFailedWithNoErrorAutomaticTranslationByHref}, {TranslationType::kAutomaticTranslationByHref, TranslateErrors::NETWORK, TranslationStatus::kFailedWithErrorAutomaticTranslationByHref}, }; for (const auto& test : kTests) { translate_metrics_logger()->LogTranslationStarted(test.translation_type); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationFinished( false, test.translate_error_type); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample(kTranslateTranslationType, test.translation_type, 1); histogram_tester()->ExpectUniqueSample(kTranslateTranslationStatus, test.expected_translation_status, 1); CheckTranslateStateHistograms(TranslateState::kNotTranslatedNoUI, TranslateState::kNotTranslatedNoUI, 0, 0); CheckTranslateErrors( test.translate_error_type, test.translate_error_type == TranslateErrors::NONE ? 0 : 1); ResetTest(); } } TEST_F(TranslateMetricsLoggerImplTest, LogAutoTranslationSuccessThenRevert) { const struct { TranslationType translation_type; TranslationStatus expected_translation_status; } kTests[] = { {TranslationType::kAutomaticTranslationByPref, TranslationStatus::kRevertedAutomaticTranslation}, {TranslationType::kAutomaticTranslationByLink, TranslationStatus::kRevertedAutomaticTranslation}, {TranslationType::kAutomaticTranslationToPredefinedTarget, TranslationStatus::kRevertedAutomaticTranslationToPredefinedTarget}, {TranslationType::kAutomaticTranslationByHref, TranslationStatus::kRevertedAutomaticTranslationByHref}, }; for (const auto& test : kTests) { translate_metrics_logger()->LogTranslationStarted(test.translation_type); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->LogReversion(); translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectUniqueSample(kTranslateTranslationType, test.translation_type, 1); histogram_tester()->ExpectUniqueSample(kTranslateTranslationStatus, test.expected_translation_status, 1); CheckTranslateStateHistograms(TranslateState::kTranslatedNoUI, TranslateState::kNotTranslatedNoUI, 1, 1); CheckTranslateErrors(TranslateErrors::NONE, 0); ResetTest(); } } TEST_F(TranslateMetricsLoggerImplTest, LogTranslationLanguages) { const struct { std::string source_language; std::string target_language; TranslateBrowserMetrics::TargetLanguageOrigin target_language_origin; int num_translations; } kTests[] = { {"a", "b", TranslateBrowserMetrics::TargetLanguageOrigin::kRecentTarget, 1}, {"b", "c", TranslateBrowserMetrics::TargetLanguageOrigin::kLanguageModel, 2}, {"a", "c", TranslateBrowserMetrics::TargetLanguageOrigin::kApplicationUI, 3}, {"d", "a", TranslateBrowserMetrics::TargetLanguageOrigin::kChangedByUser, 4}}; for (const auto& test : kTests) { translate_metrics_logger()->LogSourceLanguage(test.source_language); translate_metrics_logger()->LogTargetLanguage(test.target_language, test.target_language_origin); for (int i = 0; i < test.num_translations; ++i) { translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); } } translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectTotalCount(kTranslateTranslationSourceLanguage, 10); histogram_tester()->ExpectTotalCount(kTranslateTranslationTargetLanguage, 10); histogram_tester()->ExpectTotalCount( kTranslateTranslationTargetLanguageOrigin, 10); histogram_tester()->ExpectBucketCount(kTranslateTranslationSourceLanguage, base::HashMetricName("a"), 4); histogram_tester()->ExpectBucketCount(kTranslateTranslationSourceLanguage, base::HashMetricName("b"), 2); histogram_tester()->ExpectBucketCount(kTranslateTranslationSourceLanguage, base::HashMetricName("d"), 4); histogram_tester()->ExpectBucketCount(kTranslateTranslationTargetLanguage, base::HashMetricName("a"), 4); histogram_tester()->ExpectBucketCount(kTranslateTranslationTargetLanguage, base::HashMetricName("b"), 1); histogram_tester()->ExpectBucketCount(kTranslateTranslationTargetLanguage, base::HashMetricName("c"), 5); histogram_tester()->ExpectBucketCount( kTranslateTranslationTargetLanguageOrigin, TranslateBrowserMetrics::TargetLanguageOrigin::kRecentTarget, 1); histogram_tester()->ExpectBucketCount( kTranslateTranslationTargetLanguageOrigin, TranslateBrowserMetrics::TargetLanguageOrigin::kLanguageModel, 2); histogram_tester()->ExpectBucketCount( kTranslateTranslationTargetLanguageOrigin, TranslateBrowserMetrics::TargetLanguageOrigin::kApplicationUI, 3); histogram_tester()->ExpectBucketCount( kTranslateTranslationTargetLanguageOrigin, TranslateBrowserMetrics::TargetLanguageOrigin::kChangedByUser, 4); } TEST_F(TranslateMetricsLoggerImplTest, LogTranslateErrors) { // Sets the sequences of errors to supply. const struct { bool was_translation_successful; TranslateErrors error_type; } kTests[] = {{true, TranslateErrors::NONE}, {false, TranslateErrors::NETWORK}, {false, TranslateErrors::INITIALIZATION_ERROR}, {false, TranslateErrors::NONE}, {true, TranslateErrors::NONE}, {false, TranslateErrors::UNSUPPORTED_LANGUAGE}, {false, TranslateErrors::TRANSLATION_ERROR}, {true, TranslateErrors::NONE}, {false, TranslateErrors::TRANSLATION_TIMEOUT}, {false, TranslateErrors::NONE}, {false, TranslateErrors::SCRIPT_LOAD_ERROR}, {true, TranslateErrors::NONE}}; // Simulates the translations with the predefined errors. for (const auto& test : kTests) { translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->LogTranslationFinished( test.was_translation_successful, test.error_type); } translate_metrics_logger()->RecordMetrics(true); histogram_tester()->ExpectTotalCount(kTranslateTranslationType, 12); histogram_tester()->ExpectBucketCount( kTranslateTranslationType, TranslationType::kManualUiInitialTranslation, 1); histogram_tester()->ExpectBucketCount( kTranslateTranslationType, TranslationType::kManualUiReTranslation, 11); histogram_tester()->ExpectTotalCount(kTranslateTranslationStatus, 12); histogram_tester()->ExpectBucketCount( kTranslateTranslationStatus, TranslationStatus::kSuccessFromManualUiTranslation, 1); histogram_tester()->ExpectBucketCount(kTranslateTranslationStatus, TranslationStatus::kNewTranslation, 3); histogram_tester()->ExpectBucketCount( kTranslateTranslationStatus, TranslationStatus::kFailedWithNoErrorManualUiTranslation, 2); histogram_tester()->ExpectBucketCount( kTranslateTranslationStatus, TranslationStatus::kFailedWithErrorManualUiTranslation, 6); // We expect to capture the first non-NONE value, and the total number of // non-NONE errors. CheckTranslateErrors(TranslateErrors::NETWORK, 6); // The number of successful translations. histogram_tester()->ExpectUniqueSample(kTranslatePageLoadNumTranslations, 4, 1); } TEST_F(TranslateMetricsLoggerImplTest, LogTranslateState) { // The translate state is defined along three dimensions: 1) whether the page // is translated, 2) whether the omnibox icon is shown, and 3) whether the // translate UI (either infobar or bubble) are shown. First test going from an // initial state with all three dimensions false to a final state where all // three are true. translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->LogUIChange(true); translate_metrics_logger()->LogOmniboxIconChange(true); translate_metrics_logger()->RecordMetrics(true); CheckTranslateStateHistograms(TranslateState::kNotTranslatedNoUI, TranslateState::kTranslatedUIShown, 1, 0); // Test going from an initial state with all three dimensions true to a final // state where all three are false. ResetTest(); translate_metrics_logger()->LogTranslationStarted( TranslationType::kAutomaticTranslationByPref); translate_metrics_logger()->LogUIChange(true); translate_metrics_logger()->LogOmniboxIconChange(true); translate_metrics_logger()->LogInitialState(); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->LogReversion(); translate_metrics_logger()->LogUIChange(false); translate_metrics_logger()->LogOmniboxIconChange(false); translate_metrics_logger()->RecordMetrics(true); CheckTranslateStateHistograms(TranslateState::kTranslatedUIShown, TranslateState::kNotTranslatedNoUI, 1, 1); } TEST_F(TranslateMetricsLoggerImplTest, TrackTimeTranslatedAndNotTranslated) { // Set constants for this test. base::TimeDelta delay1 = base::Seconds(100); base::TimeDelta delay2 = base::Seconds(200); base::TimeDelta delay3 = base::Seconds(300); base::TimeDelta delay4 = base::Seconds(400); // Setup test clock, so it can be controlled by the test. base::SimpleTestTickClock test_clock; translate_metrics_logger()->SetInternalClockForTesting(&test_clock); // Page starts in the foreground and not translated. translate_metrics_logger()->OnPageLoadStart(true); test_clock.Advance(delay1); // Page switches to the background. translate_metrics_logger()->OnForegroundChange(false); test_clock.Advance(delay2); // Translate the page (while still in the background). translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); test_clock.Advance(delay3); // Page switches to the foreground. translate_metrics_logger()->OnForegroundChange(true); test_clock.Advance(delay4); // Record the stored metrics. translate_metrics_logger()->RecordMetrics(true); // Check that the member variables match expectations. CheckTotalTimeTranslated(delay4, delay1); } TEST_F(TranslateMetricsLoggerImplTest, TrackTimeTranslatedAndNotTranslated_LongTranslation) { // Set constants for this test. base::TimeDelta delay1 = base::Seconds(100); base::TimeDelta delay2 = base::Seconds(200); base::TimeDelta delay3 = base::Seconds(400); // Setup test clock, so it can be controlled by the test. base::SimpleTestTickClock test_clock; translate_metrics_logger()->SetInternalClockForTesting(&test_clock); // Page starts in the foreground and not translated. translate_metrics_logger()->OnPageLoadStart(true); test_clock.Advance(delay1); // Translation starts, but takes a while. We should count this time while the // translation is in progress as "not translated". translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); test_clock.Advance(delay2); // Translation finally finishes. translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); test_clock.Advance(delay3); // Record the stored metrics. translate_metrics_logger()->RecordMetrics(true); // Check that the member variables match expectations. CheckTotalTimeTranslated(delay3, delay1 + delay2); } TEST_F(TranslateMetricsLoggerImplTest, LogSourceLanguage) { // Set constants for the test. std::string initial_source_language = "ru"; bool is_initial_source_language_in_users_content_languages = true; std::vector source_languages = {"en", "es", "fr", "it", "de"}; // Log the source languages. translate_metrics_logger()->LogInitialSourceLanguage( initial_source_language, is_initial_source_language_in_users_content_languages); for (auto source_language : source_languages) translate_metrics_logger()->LogSourceLanguage(source_language); // Record the stored metrics. translate_metrics_logger()->RecordMetrics(true); // Check that the histograms match expectations. histogram_tester()->ExpectUniqueSample( kTranslatePageLoadInitialSourceLanguage, base::HashMetricName(initial_source_language), 1); histogram_tester()->ExpectUniqueSample( kTranslatePageLoadIsInitialSourceLanguageInUsersContentLanguages, is_initial_source_language_in_users_content_languages, 1); histogram_tester()->ExpectUniqueSample( kTranslatePageLoadFinalSourceLanguage, base::HashMetricName(source_languages[source_languages.size() - 1]), 1); } TEST_F(TranslateMetricsLoggerImplTest, LogTargetLanguage) { // Set constants for the test. std::vector target_languages = {"de", "en", "en", "de", "fr", "fr", "es", "it", "it", "es"}; const struct { std::string target_language; TranslateBrowserMetrics::TargetLanguageOrigin target_language_origin; } kTests[] = { {"de", TranslateBrowserMetrics::TargetLanguageOrigin::kLanguageModel}, {"en", TranslateBrowserMetrics::TargetLanguageOrigin::kDefaultEnglish}, {"en", TranslateBrowserMetrics::TargetLanguageOrigin::kAcceptLanguages}, {"de", TranslateBrowserMetrics::TargetLanguageOrigin::kLanguageModel}, {"fr", TranslateBrowserMetrics::TargetLanguageOrigin::kChangedByUser}, {"fr", TranslateBrowserMetrics::TargetLanguageOrigin::kRecentTarget}, {"es", TranslateBrowserMetrics::TargetLanguageOrigin::kChangedByUser}, {"it", TranslateBrowserMetrics::TargetLanguageOrigin::kDefaultEnglish}, {"it", TranslateBrowserMetrics::TargetLanguageOrigin::kLanguageModel}, {"es", TranslateBrowserMetrics::TargetLanguageOrigin::kApplicationUI}}; // Log the target languages. for (const auto& test : kTests) translate_metrics_logger()->LogTargetLanguage(test.target_language, test.target_language_origin); // Record the stored metrics translate_metrics_logger()->RecordMetrics(true); // Check that the histograms match expectations. histogram_tester()->ExpectUniqueSample( kTranslatePageLoadInitialTargetLanguage, base::HashMetricName("de"), 1); histogram_tester()->ExpectUniqueSample(kTranslatePageLoadFinalTargetLanguage, base::HashMetricName("es"), 1); histogram_tester()->ExpectUniqueSample( kTranslatePageLoadNumTargetLanguageChanges, 6, 1); histogram_tester()->ExpectUniqueSample( kTranslatePageLoadInitialTargetLanguageOrigin, TranslateBrowserMetrics::TargetLanguageOrigin::kLanguageModel, 1); } TEST_F(TranslateMetricsLoggerImplTest, LogMaxTimeToTranslate) { // Set constants for this test. base::SimpleTestTickClock test_clock; constexpr base::TimeDelta default_delay = base::Seconds(100); constexpr base::TimeDelta zero_delay = base::Seconds(0); // Simulate sucessfully translating a page. translate_metrics_logger()->SetInternalClockForTesting(&test_clock); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); test_clock.Advance(default_delay); translate_metrics_logger()->LogTranslationFinished(true, TranslateErrors::NONE); translate_metrics_logger()->RecordMetrics(true); CheckMaxTimeToTranslate(default_delay); // Simulate an error with the translation. In this case the value of the // maximum time to translate should stay zero. ResetTest(); translate_metrics_logger()->SetInternalClockForTesting(&test_clock); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); test_clock.Advance(default_delay); translate_metrics_logger()->LogTranslationFinished(false, TranslateErrors::NETWORK); translate_metrics_logger()->RecordMetrics(true); CheckMaxTimeToTranslate(zero_delay); // Simulate a translation that doesn't finish. The maximum time to translate // should also be zero here. ResetTest(); translate_metrics_logger()->SetInternalClockForTesting(&test_clock); translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); test_clock.Advance(default_delay); translate_metrics_logger()->RecordMetrics(true); CheckMaxTimeToTranslate(zero_delay); // Simulate multiple translations (some with errors). The maximum time to // translate should only be from translations without an error.i const struct { base::TimeDelta time_to_translate; TranslateErrors translate_error_type; } kTests[] = { {base::Seconds(100), TranslateErrors::NONE}, {base::Seconds(200), TranslateErrors::NETWORK}, {base::Seconds(400), TranslateErrors::NONE}, {base::Seconds(500), TranslateErrors::NETWORK}, {base::Seconds(300), TranslateErrors::NONE}, }; for (const auto& test : kTests) { translate_metrics_logger()->LogTranslationStarted( translate_metrics_logger()->GetNextManualTranslationType( /*is_context_menu_initiated_translation=*/false)); test_clock.Advance(test.time_to_translate); translate_metrics_logger()->LogTranslationFinished( test.translate_error_type == TranslateErrors::NONE, test.translate_error_type); } translate_metrics_logger()->RecordMetrics(true); CheckMaxTimeToTranslate(base::Seconds(400)); } TEST_F(TranslateMetricsLoggerImplTest, LogUIInteraction) { const auto kUIInteractions = std::to_array({ UIInteraction::kTranslate, UIInteraction::kRevert, UIInteraction::kChangeSourceLanguage, UIInteraction::kChangeTargetLanguage, UIInteraction::kCloseUIExplicitly, UIInteraction::kCloseUILostFocus, UIInteraction::kTranslate, UIInteraction::kChangeSourceLanguage, UIInteraction::kCloseUIExplicitly, UIInteraction::kAddAlwaysTranslateLanguage, UIInteraction::kRemoveAlwaysTranslateLanguage, UIInteraction::kAddNeverTranslateLanguage, UIInteraction::kRemoveNeverTranslateLanguage, UIInteraction::kAddNeverTranslateSite, UIInteraction::kRemoveNeverTranslateSite, }); for (auto ui_interaction : kUIInteractions) { translate_metrics_logger()->LogUIInteraction(ui_interaction); } translate_metrics_logger()->RecordMetrics(true); // Checks internal state that track UI interactions over the page load. CheckUIInteractions(kUIInteractions[0], 15); // Check that the expected values are recorded to // Translate.UiInteraction.Event. histogram_tester()->ExpectTotalCount(kTranslateUiInteractionEvent, 15); histogram_tester()->ExpectBucketCount(kTranslateUiInteractionEvent, UIInteraction::kTranslate, 2); histogram_tester()->ExpectBucketCount(kTranslateUiInteractionEvent, UIInteraction::kRevert, 1); histogram_tester()->ExpectBucketCount( kTranslateUiInteractionEvent, UIInteraction::kChangeSourceLanguage, 2); histogram_tester()->ExpectBucketCount( kTranslateUiInteractionEvent, UIInteraction::kChangeTargetLanguage, 1); histogram_tester()->ExpectBucketCount(kTranslateUiInteractionEvent, UIInteraction::kCloseUIExplicitly, 2); histogram_tester()->ExpectBucketCount(kTranslateUiInteractionEvent, UIInteraction::kCloseUILostFocus, 1); histogram_tester()->ExpectBucketCount( kTranslateUiInteractionEvent, UIInteraction::kAddAlwaysTranslateLanguage, 1); histogram_tester()->ExpectBucketCount( kTranslateUiInteractionEvent, UIInteraction::kRemoveAlwaysTranslateLanguage, 1); histogram_tester()->ExpectBucketCount( kTranslateUiInteractionEvent, UIInteraction::kAddNeverTranslateLanguage, 1); histogram_tester()->ExpectBucketCount( kTranslateUiInteractionEvent, UIInteraction::kRemoveNeverTranslateLanguage, 1); histogram_tester()->ExpectBucketCount( kTranslateUiInteractionEvent, UIInteraction::kAddNeverTranslateSite, 1); histogram_tester()->ExpectBucketCount( kTranslateUiInteractionEvent, UIInteraction::kRemoveNeverTranslateSite, 1); } TEST_F(TranslateMetricsLoggerImplTest, LogApplicationStartMetrics) { // Make the TranslatePrefs for this test. sync_preferences::TestingPrefServiceSyncable pref_service; language::LanguagePrefs::RegisterProfilePrefs(pref_service.registry()); TranslatePrefs::RegisterProfilePrefs(pref_service.registry()); std::unique_ptr translate_prefs = std::make_unique(&pref_service); // Add values to always translate language, never translate language, and // never translate site. translate_prefs->AddLanguagePairToAlwaysTranslateList("es", "en"); translate_prefs->AddLanguagePairToAlwaysTranslateList("de", "en"); translate_prefs->BlockLanguage("en"); translate_prefs->BlockLanguage("fr"); translate_prefs->AddSiteToNeverPromptList("a"); translate_prefs->AddSiteToNeverPromptList("b"); translate_prefs->AddSiteToNeverPromptList("c"); translate_prefs->AddSiteToNeverPromptList("d"); // Record the session start metrics TranslateMetricsLoggerImpl::LogApplicationStartMetrics( std::move(translate_prefs)); // Check that the expected values were recorded to each histogram histogram_tester()->ExpectTotalCount( kTranslateApplicationStartAlwaysTranslateLanguage, 2); histogram_tester()->ExpectBucketCount( kTranslateApplicationStartAlwaysTranslateLanguage, base::HashMetricName("es"), 1); histogram_tester()->ExpectBucketCount( kTranslateApplicationStartAlwaysTranslateLanguage, base::HashMetricName("de"), 1); histogram_tester()->ExpectUniqueSample( kTranslateApplicationStartAlwaysTranslateLanguageCount, 2, 1); histogram_tester()->ExpectTotalCount( kTranslateApplicationStartNeverTranslateLanguage, 2); histogram_tester()->ExpectBucketCount( kTranslateApplicationStartNeverTranslateLanguage, base::HashMetricName("en"), 1); histogram_tester()->ExpectBucketCount( kTranslateApplicationStartNeverTranslateLanguage, base::HashMetricName("fr"), 1); histogram_tester()->ExpectUniqueSample( kTranslateApplicationStartNeverTranslateLanguageCount, 2, 1); histogram_tester()->ExpectUniqueSample( kTranslateApplicationStartNeverTranslateSiteCount, 4, 1); } } // namespace testing } // namespace translate