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
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/ash/android_sms/fcm_connection_establisher.h"
#include <utility>
#include "base/metrics/histogram_macros.h"
#include "base/strings/utf_string_conversions.h"
#include "chromeos/ash/components/multidevice/logging/logging.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "third_party/blink/public/common/messaging/string_message_codec.h"
#include "third_party/blink/public/common/messaging/transferable_message.h"
#include "third_party/blink/public/common/storage_key/storage_key.h"
#include "url/origin.h"
namespace ash {
namespace android_sms {
const int FcmConnectionEstablisher::kMaxRetryCount = 7;
constexpr base::TimeDelta FcmConnectionEstablisher::kRetryDelay =
base::Seconds(5);
// Start message is sent when establishing a connection for the first time on
// log-in. This allows the service worker to freshly subscribe to push
// notifications.
const char FcmConnectionEstablisher::kStartFcmMessage[] =
"start_fcm_connection";
// Resume message is sent to notify the service worker to resume handling
// background notifications after all "Messages for Web" web pages have
// been closed.
const char FcmConnectionEstablisher::kResumeFcmMessage[] =
"resume_fcm_connection";
// Stop message is sent to notify the service worker to unsubscribe from
// push messages when the messages feature is disabled.
const char FcmConnectionEstablisher::kStopFcmMessage[] = "stop_fcm_connection";
FcmConnectionEstablisher::PendingServiceWorkerMessage::
PendingServiceWorkerMessage(
GURL service_worker_scope,
MessageType message_type,
content::ServiceWorkerContext* service_worker_context)
: service_worker_scope(service_worker_scope),
message_type(message_type),
service_worker_context(service_worker_context) {}
FcmConnectionEstablisher::InFlightMessage::InFlightMessage(
PendingServiceWorkerMessage message)
: message(message) {}
FcmConnectionEstablisher::FcmConnectionEstablisher(
std::unique_ptr<base::OneShotTimer> retry_timer)
: retry_timer_(std::move(retry_timer)) {}
FcmConnectionEstablisher::~FcmConnectionEstablisher() = default;
void FcmConnectionEstablisher::EstablishConnection(
const GURL& url,
ConnectionMode connection_mode,
content::ServiceWorkerContext* service_worker_context) {
content::GetIOThreadTaskRunner({})->PostTask(
FROM_HERE,
base::BindOnce(
&FcmConnectionEstablisher::SendMessageToServiceWorkerWithRetries,
weak_ptr_factory_.GetWeakPtr(), url,
GetMessageTypeForConnectionMode(connection_mode),
service_worker_context));
}
void FcmConnectionEstablisher::TearDownConnection(
const GURL& url,
content::ServiceWorkerContext* service_worker_context) {
content::GetIOThreadTaskRunner({})->PostTask(
FROM_HERE,
base::BindOnce(
&FcmConnectionEstablisher::SendMessageToServiceWorkerWithRetries,
weak_ptr_factory_.GetWeakPtr(), url, MessageType::kStop,
service_worker_context));
}
// static
FcmConnectionEstablisher::MessageType
FcmConnectionEstablisher::GetMessageTypeForConnectionMode(
ConnectionMode connection_mode) {
switch (connection_mode) {
case ConnectionMode::kStartConnection:
return MessageType::kStart;
case ConnectionMode::kResumeExistingConnection:
return MessageType::kResume;
}
NOTREACHED();
}
// static
std::string FcmConnectionEstablisher::GetMessageStringForType(
MessageType message_type) {
switch (message_type) {
case MessageType::kStart:
return kStartFcmMessage;
case MessageType::kResume:
return kResumeFcmMessage;
case MessageType::kStop:
return kStopFcmMessage;
}
NOTREACHED();
}
void FcmConnectionEstablisher::SendMessageToServiceWorkerWithRetries(
const GURL& url,
MessageType message_type,
content::ServiceWorkerContext* service_worker_context) {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
message_queue_.emplace(url, message_type, service_worker_context);
ProcessMessageQueue();
}
void FcmConnectionEstablisher::ProcessMessageQueue() {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
if (in_flight_message_)
return;
if (message_queue_.empty())
return;
in_flight_message_.emplace(message_queue_.front());
message_queue_.pop();
SendInFlightMessage();
}
void FcmConnectionEstablisher::SendInFlightMessage() {
const PendingServiceWorkerMessage& message = in_flight_message_->message;
blink::TransferableMessage msg = blink::EncodeWebMessagePayload(
base::UTF8ToUTF16(GetMessageStringForType(message.message_type)));
PA_LOG(VERBOSE) << "Dispatching message " << message.message_type;
message.service_worker_context->StartServiceWorkerAndDispatchMessage(
message.service_worker_scope,
blink::StorageKey::CreateFirstParty(
url::Origin::Create(message.service_worker_scope)),
std::move(msg),
base::BindOnce(&FcmConnectionEstablisher::OnMessageDispatchResult,
weak_ptr_factory_.GetWeakPtr()));
}
void FcmConnectionEstablisher::OnMessageDispatchResult(bool status) {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
DCHECK(in_flight_message_);
PA_LOG(VERBOSE) << "Service worker message returned status " << status
<< " for message "
<< in_flight_message_->message.message_type;
if (!status && in_flight_message_->retry_count < kMaxRetryCount) {
base::TimeDelta retry_delay =
kRetryDelay * (1 << in_flight_message_->retry_count);
in_flight_message_->retry_count++;
UMA_HISTOGRAM_ENUMERATION("AndroidSms.FcmMessageDispatchRetry",
in_flight_message_->message.message_type);
PA_LOG(VERBOSE) << "Scheduling retry with delay " << retry_delay;
retry_timer_->Start(
FROM_HERE, retry_delay,
base::BindOnce(&FcmConnectionEstablisher::SendInFlightMessage,
weak_ptr_factory_.GetWeakPtr()));
return;
}
if (status) {
UMA_HISTOGRAM_ENUMERATION("AndroidSms.FcmMessageDispatchSuccess",
in_flight_message_->message.message_type);
} else {
UMA_HISTOGRAM_ENUMERATION("AndroidSms.FcmMessageDispatchFailure",
in_flight_message_->message.message_type);
PA_LOG(WARNING) << "Max retries attempted when dispatching message "
<< in_flight_message_->message.message_type;
}
in_flight_message_.reset();
ProcessMessageQueue();
}
std::ostream& operator<<(
std::ostream& stream,
const FcmConnectionEstablisher::MessageType& message_type) {
switch (message_type) {
case FcmConnectionEstablisher::MessageType::kStart:
stream << "MessageType::kStart";
break;
case FcmConnectionEstablisher::MessageType::kResume:
stream << "MessageType::kResume";
break;
case FcmConnectionEstablisher::MessageType::kStop:
stream << "MessageType::kStop";
break;
}
return stream;
}
} // namespace android_sms
} // namespace ash
|
