1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
content / browser / webid / fedcm_metrics.cc [blame]
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/webid/fedcm_metrics.h"
#include "base/metrics/histogram_functions.h"
#include "base/types/pass_key.h"
#include "content/browser/webid/flags.h"
#include "content/browser/webid/webid_utils.h"
#include "net/base/net_errors.h"
#include "net/base/schemeful_site.h"
#include "net/http/http_response_headers.h"
#include "net/http/http_status_code.h"
#include "services/metrics/public/cpp/metrics_utils.h"
#include "third_party/blink/public/mojom/webid/federated_auth_request.mojom.h"
#include "url/gurl.h"
namespace content {
namespace {
FedCmRequesterFrameType ComputeRequesterFrameType(const RenderFrameHost& rfh,
const url::Origin& requester,
const url::Origin& embedder) {
// Since FedCM methods are not supported in FencedFrames, we can know whether
// this is a main frame by calling GetParent().
if (!rfh.GetParent()) {
return FedCmRequesterFrameType::kMainFrame;
}
return webid::IsSameSite(requester, embedder)
? FedCmRequesterFrameType::kSameSiteIframe
: FedCmRequesterFrameType::kCrossSiteIframe;
}
FedCmMetrics::NumAccounts ComputeNumMatchingAccounts(
size_t accounts_remaining) {
if (accounts_remaining == 0u) {
return FedCmMetrics::NumAccounts::kZero;
}
if (accounts_remaining == 1u) {
return FedCmMetrics::NumAccounts::kOne;
}
return FedCmMetrics::NumAccounts::kMultiple;
}
} // namespace
FedCmMetrics::FedCmMetrics(ukm::SourceId page_source_id)
: page_source_id_(page_source_id) {}
FedCmMetrics::~FedCmMetrics() = default;
void FedCmMetrics::SetSessionID(int session_id) {
session_id_ = session_id;
}
void FedCmMetrics::RecordShowAccountsDialogTime(
const std::vector<IdentityProviderDataPtr>& providers,
base::TimeDelta duration) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetTiming_ShowAccountsDialog(
ukm::GetExponentialBucketMinForUserTiming(duration.InMilliseconds()));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
for (const auto& provider : providers) {
// A provider may have no accounts, for instance if present due to IDP
// mismatch.
if (!provider->has_login_status_mismatch) {
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider->idp_metadata.config_url));
RecordUkm(fedcm_idp_builder);
}
}
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.ShowAccountsDialog",
duration);
}
void FedCmMetrics::RecordShowAccountsDialogTimeBreakdown(
base::TimeDelta well_known_and_config_fetch_duration,
base::TimeDelta accounts_fetch_duration,
base::TimeDelta client_metadata_fetch_duration) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetTiming_ShowAccountsDialogBreakdown_WellKnownAndConfigFetch(
ukm::GetExponentialBucketMinForUserTiming(
well_known_and_config_fetch_duration.InMilliseconds()));
ukm_builder.SetTiming_ShowAccountsDialogBreakdown_AccountsFetch(
ukm::GetExponentialBucketMinForUserTiming(
accounts_fetch_duration.InMilliseconds()));
ukm_builder.SetTiming_ShowAccountsDialogBreakdown_ClientMetadataFetch(
ukm::GetExponentialBucketMinForUserTiming(
client_metadata_fetch_duration.InMilliseconds()));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
base::UmaHistogramMediumTimes(
"Blink.FedCm.Timing.ShowAccountsDialogBreakdown.WellKnownAndConfigFetch",
well_known_and_config_fetch_duration);
base::UmaHistogramMediumTimes(
"Blink.FedCm.Timing.ShowAccountsDialogBreakdown.AccountsFetch",
accounts_fetch_duration);
base::UmaHistogramMediumTimes(
"Blink.FedCm.Timing.ShowAccountsDialogBreakdown.ClientMetadataFetch",
client_metadata_fetch_duration);
}
void FedCmMetrics::RecordWellKnownAndConfigFetchTime(base::TimeDelta duration) {
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.WellKnownAndConfigFetch",
duration);
}
// static
void FedCmMetrics::RecordNumRequestsPerDocument(ukm::SourceId page_source_id,
const int num_requests) {
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetNumRequestsPerDocument(num_requests);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id);
RecordUkm(fedcm_builder);
base::UmaHistogramCounts100("Blink.FedCm.NumRequestsPerDocument",
num_requests);
}
void FedCmMetrics::RecordContinueOnPopupTime(const GURL& provider,
base::TimeDelta duration) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetTiming_ContinueOnDialog(
ukm::GetExponentialBucketMinForUserTiming(duration.InMilliseconds()));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider));
RecordUkm(fedcm_idp_builder);
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.ContinueOnDialog",
duration);
}
void FedCmMetrics::RecordCancelOnDialogTime(
const std::vector<IdentityProviderDataPtr>& providers,
base::TimeDelta duration) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetTiming_CancelOnDialog(
ukm::GetExponentialBucketMinForUserTiming(duration.InMilliseconds()));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
for (const auto& provider : providers) {
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider->idp_metadata.config_url));
RecordUkm(fedcm_idp_builder);
}
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.CancelOnDialog", duration);
}
void FedCmMetrics::RecordAccountsDialogShownDuration(
const std::vector<IdentityProviderDataPtr>& providers,
base::TimeDelta duration) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetTiming_AccountsDialogShownDuration(
ukm::GetExponentialBucketMinForUserTiming(duration.InMilliseconds()));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
for (const auto& provider : providers) {
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider->idp_metadata.config_url));
// A provider may have no accounts and be present due to IDP mismatch.
if (!provider->has_login_status_mismatch) {
RecordUkm(fedcm_idp_builder);
} else {
fedcm_idp_builder.SetTiming_MismatchDialogShownDuration(
ukm::GetExponentialBucketMinForUserTiming(duration.InMilliseconds()));
fedcm_idp_builder.SetFedCmSessionID(session_id_);
fedcm_idp_builder.Record(ukm::UkmRecorder::Get());
}
}
// Samples are at most 10 minutes. This metric is used to determine a
// reasonable minimum duration for the accounts dialog to be shown to
// prevent abuse through flashing UI so a higher maximum is not needed.
base::UmaHistogramCustomTimes(
"Blink.FedCm.Timing.AccountsDialogShownDuration2", duration,
base::Milliseconds(1), base::Minutes(10), 50);
}
void FedCmMetrics::RecordMismatchDialogShownDuration(
const std::vector<IdentityProviderDataPtr>& providers,
base::TimeDelta duration) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetTiming_MismatchDialogShownDuration(
ukm::GetExponentialBucketMinForUserTiming(duration.InMilliseconds()));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
for (const auto& provider : providers) {
// We should only reach this if all `providers` are a mismatch.
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider->idp_metadata.config_url));
RecordUkm(fedcm_idp_builder);
}
// Samples are at most 10 minutes. This metric is used to determine a
// reasonable minimum duration for the mismatch dialog to be shown to
// prevent abuse through flashing UI so a higher maximum is not needed.
base::UmaHistogramCustomTimes(
"Blink.FedCm.Timing.MismatchDialogShownDuration", duration,
base::Milliseconds(1), base::Minutes(10), 50);
}
void FedCmMetrics::RecordCancelReason(
IdentityRequestDialogController::DismissReason dismiss_reason) {
base::UmaHistogramEnumeration("Blink.FedCm.CancelReason", dismiss_reason);
}
void FedCmMetrics::RecordTokenResponseAndTurnaroundTime(
const GURL& provider,
base::TimeDelta token_response_time,
base::TimeDelta turnaround_time) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder
.SetTiming_IdTokenResponse(ukm::GetExponentialBucketMinForUserTiming(
token_response_time.InMilliseconds()))
.SetTiming_TurnaroundTime(ukm::GetExponentialBucketMinForUserTiming(
turnaround_time.InMilliseconds()));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider));
RecordUkm(fedcm_idp_builder);
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.IdTokenResponse",
token_response_time);
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.TurnaroundTime",
turnaround_time);
}
void FedCmMetrics::RecordContinueOnResponseAndTurnaroundTime(
base::TimeDelta token_response_time,
base::TimeDelta turnaround_time) {
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.ContinueOn.Response",
token_response_time);
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.ContinueOn.TurnaroundTime",
turnaround_time);
}
void FedCmMetrics::RecordRequestTokenStatus(
FedCmRequestIdTokenStatus status,
MediationRequirement requirement,
const std::vector<GURL>& requested_providers,
int num_idps_mismatch,
const std::optional<GURL>& selected_idp_config_url,
const RpMode& rp_mode) {
// The following check is to avoid double recording in the following scenario:
// 1. The request has failed but we have not yet rejected the promise, e.g.
// when the API is disabled. We record a metric immediately but only post a
// task to later reject the callback.
// 2. The page is unloaded. This invokes the FederatedAuthRequestImpl
// destructor. We record a metric with unhandled status since the callback is
// still present. Because we reset `session_id` at the end of the method, we
// can check its value to see if we have already recorded the status of this
// call.
if (session_id_ == -1) {
return;
}
// Use exponential bucketing to log these numbers.
num_idps_mismatch =
ukm::GetExponentialBucketMinForCounts1000(num_idps_mismatch);
int num_idps_requested =
ukm::GetExponentialBucketMinForCounts1000(requested_providers.size());
auto RecordUkm = [&](auto& ukm_builder,
FedCmRequestIdTokenStatus ukm_status) {
ukm_builder.SetStatus_RequestIdToken(static_cast<int>(ukm_status));
ukm_builder.SetStatus_MediationRequirement(static_cast<int>(requirement));
ukm_builder.SetNumIdpsRequested(num_idps_requested);
ukm_builder.SetNumIdpsMismatch(num_idps_mismatch);
ukm_builder.SetRpMode(static_cast<int>(rp_mode));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder, status);
for (const auto& provider : requested_providers) {
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider));
if (status == FedCmRequestIdTokenStatus::kSuccessUsingTokenInHttpResponse ||
status ==
FedCmRequestIdTokenStatus::kSuccessUsingIdentityProviderResolve) {
CHECK(selected_idp_config_url);
if (provider == *selected_idp_config_url) {
RecordUkm(fedcm_idp_builder, status);
} else {
RecordUkm(fedcm_idp_builder,
FedCmRequestIdTokenStatus::kOtherIdpChosen);
}
} else {
RecordUkm(fedcm_idp_builder, status);
}
}
base::UmaHistogramEnumeration("Blink.FedCm.Status.RequestIdToken", status);
base::UmaHistogramEnumeration("Blink.FedCm.Status.MediationRequirement",
requirement);
// Reset the `session_id_`. We expect no more metrics from this API call.
session_id_ = -1;
}
void FedCmMetrics::RecordSignInStateMatchStatus(
const GURL& provider,
FedCmSignInStateMatchStatus status) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetStatus_SignInStateMatch(static_cast<int>(status));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider));
RecordUkm(fedcm_idp_builder);
base::UmaHistogramEnumeration("Blink.FedCm.Status.SignInStateMatch", status);
}
// static
void FedCmMetrics::RecordIdpSigninMatchStatus(
std::optional<bool> idp_signin_status,
IdpNetworkRequestManager::ParseStatus accounts_endpoint_status) {
FedCmIdpSigninMatchStatus match_status = FedCmIdpSigninMatchStatus::kMaxValue;
if (!idp_signin_status.has_value()) {
match_status =
(accounts_endpoint_status ==
IdpNetworkRequestManager::ParseStatus::kSuccess)
? FedCmIdpSigninMatchStatus::kUnknownStatusWithAccounts
: FedCmIdpSigninMatchStatus::kUnknownStatusWithoutAccounts;
} else if (idp_signin_status.value()) {
switch (accounts_endpoint_status) {
case IdpNetworkRequestManager::ParseStatus::kHttpNotFoundError:
match_status = FedCmIdpSigninMatchStatus::kMismatchWithNetworkError;
break;
case IdpNetworkRequestManager::ParseStatus::kNoResponseError:
match_status = FedCmIdpSigninMatchStatus::kMismatchWithNoContent;
break;
case IdpNetworkRequestManager::ParseStatus::kInvalidResponseError:
match_status = FedCmIdpSigninMatchStatus::kMismatchWithInvalidResponse;
break;
case IdpNetworkRequestManager::ParseStatus::kEmptyListError:
match_status = FedCmIdpSigninMatchStatus::kMismatchWithNoContent;
break;
case IdpNetworkRequestManager::ParseStatus::kInvalidContentTypeError:
match_status = FedCmIdpSigninMatchStatus::kMismatchWithInvalidResponse;
break;
case IdpNetworkRequestManager::ParseStatus::kSuccess:
match_status = FedCmIdpSigninMatchStatus::kMatchWithAccounts;
break;
}
} else {
match_status =
(accounts_endpoint_status ==
IdpNetworkRequestManager::ParseStatus::kSuccess)
? FedCmIdpSigninMatchStatus::kMismatchWithUnexpectedAccounts
: FedCmIdpSigninMatchStatus::kMatchWithoutAccounts;
}
base::UmaHistogramEnumeration("Blink.FedCm.Status.IdpSigninMatch",
match_status);
}
void FedCmMetrics::RecordIsSignInUser(bool is_sign_in) {
base::UmaHistogramBoolean("Blink.FedCm.IsSignInUser", is_sign_in);
}
void FedCmMetrics::RecordWebContentsStatusUponReadyToShowDialog(
bool is_visible,
bool is_active) {
base::UmaHistogramBoolean("Blink.FedCm.WebContentsVisible", is_visible);
base::UmaHistogramBoolean("Blink.FedCm.WebContentsActive", is_active);
}
void FedCmMetrics::RecordAutoReauthnMetrics(
std::optional<bool> has_single_returning_account,
const IdentityRequestAccount* auto_signin_account,
bool auto_reauthn_success,
bool is_auto_reauthn_setting_blocked,
bool is_auto_reauthn_embargoed,
std::optional<base::TimeDelta> time_from_embargo,
bool requires_user_mediation) {
DCHECK_GT(session_id_, 0);
NumAccounts num_returning_accounts = NumAccounts::kZero;
if (has_single_returning_account.has_value()) {
if (*has_single_returning_account) {
num_returning_accounts = NumAccounts::kOne;
} else if (auto_signin_account) {
num_returning_accounts = NumAccounts::kMultiple;
}
base::UmaHistogramEnumeration("Blink.FedCm.AutoReauthn.ReturningAccounts",
num_returning_accounts);
}
base::UmaHistogramBoolean("Blink.FedCm.AutoReauthn.Succeeded",
auto_reauthn_success);
base::UmaHistogramBoolean("Blink.FedCm.AutoReauthn.BlockedByContentSettings",
is_auto_reauthn_setting_blocked);
base::UmaHistogramBoolean("Blink.FedCm.AutoReauthn.BlockedByEmbargo",
is_auto_reauthn_embargoed);
base::UmaHistogramBoolean(
"Blink.FedCm.AutoReauthn.BlockedByPreventSilentAccess",
requires_user_mediation);
ukm::builders::Blink_FedCm ukm_builder(page_source_id_);
if (time_from_embargo) {
// Use a custom histogram with the default number of buckets so that we set
// the maximum to the permission embargo duration: 10 minutes. See
// `kFederatedIdentityAutoReauthnEmbargoDuration`.
base::UmaHistogramCustomTimes(
"Blink.FedCm.AutoReauthn.TimeFromEmbargoWhenBlocked",
*time_from_embargo, base::Milliseconds(10), base::Minutes(10),
/*buckets=*/50);
ukm_builder.SetAutoReauthn_TimeFromEmbargoWhenBlocked(
ukm::GetExponentialBucketMinForUserTiming(
time_from_embargo->InMilliseconds()));
}
if (has_single_returning_account.has_value()) {
ukm_builder.SetAutoReauthn_ReturningAccounts(
static_cast<int>(num_returning_accounts));
}
ukm_builder.SetAutoReauthn_Succeeded(auto_reauthn_success);
ukm_builder.SetAutoReauthn_BlockedByContentSettings(
is_auto_reauthn_setting_blocked);
ukm_builder.SetAutoReauthn_BlockedByEmbargo(is_auto_reauthn_embargoed);
ukm_builder.SetAutoReauthn_BlockedByPreventSilentAccess(
requires_user_mediation);
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
}
void FedCmMetrics::RecordAccountsDialogShown(
const std::vector<IdentityProviderDataPtr>& providers) {
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetAccountsDialogShown(true);
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
for (const auto& provider : providers) {
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider->idp_metadata.config_url));
// A provider may have no accounts and be present due to IDP mismatch.
if (!provider->has_login_status_mismatch) {
RecordUkm(fedcm_idp_builder);
} else {
DCHECK(provider->has_login_status_mismatch);
fedcm_idp_builder.SetMismatchDialogShown(true);
fedcm_idp_builder.SetFedCmSessionID(session_id_);
fedcm_idp_builder.Record(ukm::UkmRecorder::Get());
}
}
base::UmaHistogramBoolean("Blink.FedCm.AccountsDialogShown", true);
}
void FedCmMetrics::RecordSingleIdpMismatchDialogShown(
const IdentityProviderData& provider,
bool has_shown_mismatch,
bool has_hints) {
DCHECK_GT(session_id_, 0);
MismatchDialogType type;
if (!has_shown_mismatch) {
type = has_hints ? MismatchDialogType::kFirstWithHints
: MismatchDialogType::kFirstWithoutHints;
} else {
type = has_hints ? MismatchDialogType::kRepeatedWithHints
: MismatchDialogType::kRepeatedWithoutHints;
}
base::UmaHistogramEnumeration("Blink.FedCm.MismatchDialogType", type);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetMismatchDialogShown(true);
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
DCHECK(provider.has_login_status_mismatch);
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider.idp_metadata.config_url));
RecordUkm(fedcm_idp_builder);
base::UmaHistogramBoolean("Blink.FedCm.MismatchDialogShown", true);
}
void FedCmMetrics::RecordAccountsRequestSent(const GURL& provider_url) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetAccountsRequestSent(true);
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider_url));
RecordUkm(fedcm_idp_builder);
base::UmaHistogramBoolean("Blink.FedCm.AccountsRequestSent", true);
}
void FedCmMetrics::RecordDisconnectMetrics(
FedCmDisconnectStatus status,
std::optional<base::TimeDelta> duration,
const RenderFrameHost& rfh,
const url::Origin& requester,
const url::Origin& embedder,
const GURL& provider_url,
int disconnect_session_id) {
DCHECK_GT(disconnect_session_id, 0);
FedCmRequesterFrameType requester_frame_type =
ComputeRequesterFrameType(rfh, requester, embedder);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetStatus_Disconnect(static_cast<int>(status));
ukm_builder.SetDisconnect_FrameType(static_cast<int>(requester_frame_type));
if (duration) {
ukm_builder.SetTiming_Disconnect(
ukm::GetSemanticBucketMinForDurationTiming(
duration->InMilliseconds()));
}
ukm_builder.SetFedCmSessionID(disconnect_session_id);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider_url));
RecordUkm(fedcm_idp_builder);
base::UmaHistogramEnumeration("Blink.FedCm.Status.Disconnect", status);
base::UmaHistogramEnumeration("Blink.FedCm.Disconnect.FrameType",
requester_frame_type);
if (duration) {
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.Disconnect", *duration);
}
}
void FedCmMetrics::RecordContinueOnPopupStatus(
FedCmContinueOnPopupStatus status) {
base::UmaHistogramEnumeration("Blink.FedCm.ContinueOn.PopupWindowStatus",
status);
}
void FedCmMetrics::RecordContinueOnPopupResult(
FedCmContinueOnPopupResult result) {
base::UmaHistogramEnumeration("Blink.FedCm.ContinueOn.PopupWindowResult",
result);
}
void FedCmMetrics::RecordRpParameters(FedCmRpParameters parameters) {
base::UmaHistogramEnumeration("Blink.FedCm.RpParametersAndScopeState",
parameters);
}
void FedCmMetrics::RecordErrorDialogResult(FedCmErrorDialogResult result,
const GURL& provider_url) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetError_ErrorDialogResult(static_cast<int>(result));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider_url));
RecordUkm(fedcm_idp_builder);
base::UmaHistogramEnumeration("Blink.FedCm.Error.ErrorDialogResult", result);
}
void FedCmMetrics::RecordErrorMetricsBeforeShowingErrorDialog(
IdpNetworkRequestManager::FedCmTokenResponseType response_type,
std::optional<IdpNetworkRequestManager::FedCmErrorDialogType> dialog_type,
std::optional<IdpNetworkRequestManager::FedCmErrorUrlType> url_type,
const GURL& provider_url) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetError_TokenResponseType(static_cast<int>(response_type));
if (dialog_type) {
ukm_builder.SetError_ErrorDialogType(static_cast<int>(*dialog_type));
}
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider_url));
// We do not record the RP-keyed equivalent because the error URL is passed by
// the IDP.
if (url_type) {
fedcm_idp_builder.SetError_ErrorUrlType(static_cast<int>(*url_type));
}
RecordUkm(fedcm_idp_builder);
base::UmaHistogramEnumeration("Blink.FedCm.Error.TokenResponseType",
response_type);
if (dialog_type) {
base::UmaHistogramEnumeration("Blink.FedCm.Error.ErrorDialogType",
*dialog_type);
}
if (url_type) {
base::UmaHistogramEnumeration("Blink.FedCm.Error.ErrorUrlType", *url_type);
}
}
void FedCmMetrics::RecordMultipleRequestsRpMode(
blink::mojom::RpMode pending_request_rp_mode,
blink::mojom::RpMode new_request_rp_mode,
const std::vector<GURL>& requested_providers) {
DCHECK_GT(session_id_, 0);
FedCmMultipleRequestsRpMode status;
if (pending_request_rp_mode == blink::mojom::RpMode::kPassive) {
status = new_request_rp_mode == blink::mojom::RpMode::kPassive
? FedCmMultipleRequestsRpMode::kPassiveThenPassive
: FedCmMultipleRequestsRpMode::kPassiveThenActive;
} else {
status = new_request_rp_mode == blink::mojom::RpMode::kPassive
? FedCmMultipleRequestsRpMode::kActiveThenPassive
: FedCmMultipleRequestsRpMode::kActiveThenActive;
}
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetMultipleRequestsRpMode(static_cast<int>(status));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
for (const auto& provider : requested_providers) {
ukm::builders::Blink_FedCmIdp fedcm_idp_builder(
GetOrCreateProviderSourceId(provider));
RecordUkm(fedcm_idp_builder);
}
base::UmaHistogramEnumeration("Blink.FedCm.MultipleRequestsRpMode", status);
}
void FedCmMetrics::RecordTimeBetweenUserInfoAndActiveModeAPI(
base::TimeDelta duration) {
DCHECK_GT(session_id_, 0);
auto RecordUkm = [&](auto& ukm_builder) {
ukm_builder.SetTiming_GetUserInfoToButtonMode(
ukm::GetExponentialBucketMinForUserTiming(duration.InMilliseconds()));
ukm_builder.SetFedCmSessionID(session_id_);
ukm_builder.Record(ukm::UkmRecorder::Get());
};
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
RecordUkm(fedcm_builder);
base::UmaHistogramMediumTimes("Blink.FedCm.Timing.GetUserInfoToButtonMode",
duration);
}
void FedCmMetrics::RecordNumMatchingAccounts(size_t accounts_remaining,
const std::string& filter_type) {
FedCmMetrics::NumAccounts num_matching =
ComputeNumMatchingAccounts(accounts_remaining);
base::UmaHistogramEnumeration(
"Blink.FedCm." + filter_type + ".NumMatchingAccounts", num_matching);
ukm::builders::Blink_FedCm fedcm_builder(page_source_id_);
if (filter_type == "LoginHint") {
fedcm_builder.SetLoginHint_NumMatchingAccounts(
static_cast<int>(num_matching));
} else if (filter_type == "AccountLabel") {
fedcm_builder.SetAccountLabel_NumMatchingAccounts(
static_cast<int>(num_matching));
} else if (filter_type == "DomainHint") {
fedcm_builder.SetDomainHint_NumMatchingAccounts(
static_cast<int>(num_matching));
} else {
NOTREACHED();
}
fedcm_builder.SetFedCmSessionID(session_id_);
fedcm_builder.Record(ukm::UkmRecorder::Get());
}
ukm::SourceId FedCmMetrics::GetOrCreateProviderSourceId(const GURL& provider) {
auto it = provider_source_ids_.find(provider);
if (it != provider_source_ids_.end()) {
return it->second;
}
ukm::SourceId source_id =
ukm::UkmRecorder::GetSourceIdForWebIdentityFromScope(
base::PassKey<FedCmMetrics>(), provider);
provider_source_ids_[provider] = source_id;
return source_id;
}
void RecordPreventSilentAccess(RenderFrameHost& rfh,
const url::Origin& requester,
const url::Origin& embedder) {
FedCmRequesterFrameType requester_frame_type =
ComputeRequesterFrameType(rfh, requester, embedder);
base::UmaHistogramEnumeration("Blink.FedCm.PreventSilentAccessFrameType",
requester_frame_type);
// Ensure the lifecycle state as GetPageUkmSourceId doesn't support the
// prerendering page. As FederatedAithRequest runs behind the
// BrowserInterfaceBinders, the service doesn't receive any request while
// prerendering, and the CHECK should always meet the condition.
CHECK(
!rfh.IsInLifecycleState(RenderFrameHost::LifecycleState::kPrerendering));
ukm::builders::Blink_FedCm ukm_builder(rfh.GetPageUkmSourceId());
ukm_builder.SetPreventSilentAccessFrameType(
static_cast<int>(requester_frame_type));
ukm_builder.Record(ukm::UkmRecorder::Get());
}
void RecordApprovedClientsExistence(bool has_approved_clients) {
base::UmaHistogramBoolean("Blink.FedCm.ApprovedClientsExistence",
has_approved_clients);
}
void RecordApprovedClientsSize(int size) {
base::UmaHistogramCounts10000("Blink.FedCm.ApprovedClientsSize", size);
}
void RecordIdpSignOutNetError(int response_code) {
int net_error = net::OK;
if (response_code < 0) {
// In this case, we got a net error, so change |net_error| to the value.
net_error = response_code;
}
base::UmaHistogramSparse("Blink.FedCm.SignInStatusSetToSignout.NetError",
-net_error);
}
void RecordAccountsResponseInvalidReason(
IdpNetworkRequestManager::AccountsResponseInvalidReason reason) {
base::UmaHistogramEnumeration(
"Blink.FedCm.Status.AccountsResponseInvalidReason", reason);
}
void RecordSetLoginStatusIgnoredReason(
FedCmSetLoginStatusIgnoredReason reason) {
base::UmaHistogramEnumeration("Blink.FedCm.SetLoginStatusIgnored", reason);
}
void RecordLifecycleStateFailureReason(
FedCmLifecycleStateFailureReason reason) {
base::UmaHistogramEnumeration("Blink.FedCm.LifecycleStateFailureReason",
reason);
}
void RecordRawAccountsSize(int size) {
CHECK_GT(size, 0);
base::UmaHistogramCustomCounts("Blink.FedCm.AccountsSize.Raw", size,
/*min=*/1,
/*exclusive_max=*/10, /*buckets=*/10);
}
void RecordReadyToShowAccountsSize(int size) {
CHECK_GT(size, 0);
base::UmaHistogramCustomCounts("Blink.FedCm.AccountsSize.ReadyToShow", size,
/*min=*/1,
/*exclusive_max=*/10, /*buckets=*/10);
}
} // namespace content