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
|
// 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.
#ifndef CONTENT_BROWSER_WEBID_FEDCM_METRICS_H_
#define CONTENT_BROWSER_WEBID_FEDCM_METRICS_H_
#include "content/common/content_export.h"
#include "content/public/browser/identity_request_dialog_controller.h"
#include "services/metrics/public/cpp/ukm_builders.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
namespace base {
class TimeDelta;
}
namespace content {
// This enum describes the status of a request id token call to the FedCM API.
enum class FedCmRequestIdTokenStatus {
// Don't change the meaning or the order of these values because they are
// being recorded in metrics and in sync with the counterpart in enums.xml.
kSuccess,
kTooManyRequests,
kAborted,
kUnhandledRequest,
kIdpNotPotentiallyTrustworthy,
kNotSelectAccount,
kManifestHttpNotFound,
kManifestNoResponse,
kManifestInvalidResponse,
kClientMetadataHttpNotFound, // obsolete
kClientMetadataNoResponse, // obsolete
kClientMetadataInvalidResponse, // obsolete
kAccountsHttpNotFound,
kAccountsNoResponse,
kAccountsInvalidResponse,
kIdTokenHttpNotFound,
kIdTokenNoResponse,
kIdTokenInvalidResponse,
kIdTokenInvalidRequest, // obsolete
kClientMetadataMissingPrivacyPolicyUrl, // obsolete
kThirdPartyCookiesBlocked,
kDisabledInSettings,
kDisabledInFlags,
kManifestListHttpNotFound,
kManifestListNoResponse,
kManifestListInvalidResponse,
kManifestNotInManifestList,
kManifestListTooBig,
kDisabledEmbargo,
kUserInterfaceTimedOut, // obsolete
kRpPageNotVisible,
kShouldEmbargo,
kNotSignedInWithIdp,
kMaxValue = kNotSignedInWithIdp
};
// This enum describes whether user sign-in states between IDP and browser
// match.
enum class FedCmSignInStateMatchStatus {
// Don't change the meaning or the order of these values because they are
// being recorded in metrics and in sync with the counterpart in enums.xml.
kMatch,
kIdpClaimedSignIn,
kBrowserObservedSignIn,
kMaxValue = kBrowserObservedSignIn
};
class FedCmMetrics {
public:
FedCmMetrics(const GURL& provider,
const ukm::SourceId page_source_id,
int session_id,
bool is_disabled);
~FedCmMetrics() = default;
// Records the time from when a call to the API was made to when the accounts
// dialog is shown.
void RecordShowAccountsDialogTime(base::TimeDelta duration);
// Records the time from when the accounts dialog is shown to when the user
// presses the Continue button.
void RecordContinueOnDialogTime(base::TimeDelta duration);
// Records metrics when the user explicitly closes the accounts dialog without
// selecting any accounts. `duration` is the time from when the accounts
// dialog was shown to when the user closed the dialog.
void RecordCancelOnDialogTime(base::TimeDelta duration);
// Records the reason that closed accounts dialog without selecting any
// accounts. Unlike RecordCancelOnDialogTime() this metric is recorded in
// cases that the acccounts dialog was closed without an explicit user action.
void RecordCancelReason(
IdentityRequestDialogController::DismissReason dismiss_reason);
// Records the time from when the user presses the Continue button to when the
// token response is received. Also records the overall time from when the API
// is called to when the token response is received.
void RecordTokenResponseAndTurnaroundTime(base::TimeDelta token_response_time,
base::TimeDelta turnaround_time);
// Records the status of the |RequestToken| call.
void RecordRequestTokenStatus(FedCmRequestIdTokenStatus status);
// Records whether user sign-in states between IDP and browser match.
void RecordSignInStateMatchStatus(FedCmSignInStateMatchStatus status);
// Records whether the user selected account is for sign-in or not.
void RecordIsSignInUser(bool is_sign_in);
// Records whether a user has left the page where the API is called when the
// browser is ready to show the accounts dialog.
void RecordWebContentsVisibilityUponReadyToShowDialog(bool is_visible);
private:
// The page's SourceId. Used to log the UKM event Blink.FedCm.
ukm::SourceId page_source_id_;
// The SourceId to be used to log the UKM event Blink.FedCmIdp. Uses
// |provider_| as the URL.
ukm::SourceId provider_source_id_;
// Whether a RequestTokenStatus has been recorded.
bool request_token_status_recorded_{false};
// The session ID associated to the FedCM call for which this object is
// recording metrics. Each FedCM call gets a random integer session id, which
// helps group UKM events by the session id.
int session_id_;
// Whether metrics recording is disabled for the request.
bool is_disabled_{false};
};
// The following are UMA-only recordings, hence do not need to be in the
// FedCmMetrics class.
// Records whether an IDP returns an approved clients list in the response.
void RecordApprovedClientsExistence(bool has_approved_clients);
// Records the size of the approved clients list if applicable.
void RecordApprovedClientsSize(int size);
} // namespace content
#endif // CONTENT_BROWSER_WEBID_FEDCM_METRICS_H_
|
