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
|
// 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 "chrome/browser/nearby_sharing/nearby_per_session_discovery_manager.h"
#include <algorithm>
#include <string>
#include "base/containers/contains.h"
#include "base/functional/callback_helpers.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/string_number_conversions.h"
#include "chrome/browser/nearby_sharing/attachment.h"
#include "chrome/browser/nearby_sharing/nearby_confirmation_manager.h"
#include "chrome/browser/ui/webui/nearby_share/nearby_share.mojom-forward.h"
#include "components/cross_device/logging/logging.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/self_owned_receiver.h"
namespace {
std::optional<nearby_share::mojom::TransferStatus> GetTransferStatus(
const TransferMetadata& transfer_metadata) {
switch (transfer_metadata.status()) {
case TransferMetadata::Status::kAwaitingLocalConfirmation:
return nearby_share::mojom::TransferStatus::kAwaitingLocalConfirmation;
case TransferMetadata::Status::kAwaitingRemoteAcceptance:
return nearby_share::mojom::TransferStatus::kAwaitingRemoteAcceptance;
case TransferMetadata::Status::kComplete:
return nearby_share::mojom::TransferStatus::kComplete;
case TransferMetadata::Status::kInProgress:
return nearby_share::mojom::TransferStatus::kInProgress;
case TransferMetadata::Status::kRejected:
return nearby_share::mojom::TransferStatus::kRejected;
case TransferMetadata::Status::kTimedOut:
return nearby_share::mojom::TransferStatus::kTimedOut;
case TransferMetadata::Status::kUnsupportedAttachmentType:
return nearby_share::mojom::TransferStatus::kUnsupportedAttachmentType;
case TransferMetadata::Status::kMediaUnavailable:
return nearby_share::mojom::TransferStatus::kMediaUnavailable;
case TransferMetadata::Status::kNotEnoughSpace:
return nearby_share::mojom::TransferStatus::kNotEnoughSpace;
case TransferMetadata::Status::kFailed:
return nearby_share::mojom::TransferStatus::kFailed;
case TransferMetadata::Status::kAwaitingRemoteAcceptanceFailed:
return nearby_share::mojom::TransferStatus::
kAwaitingRemoteAcceptanceFailed;
case TransferMetadata::Status::kUnknown:
return nearby_share::mojom::TransferStatus::kUnknown;
case TransferMetadata::Status::kConnecting:
return nearby_share::mojom::TransferStatus::kConnecting;
case TransferMetadata::Status::kCancelled:
return nearby_share::mojom::TransferStatus::kCancelled;
case TransferMetadata::Status::kDecodeAdvertisementFailed:
return nearby_share::mojom::TransferStatus::kDecodeAdvertisementFailed;
case TransferMetadata::Status::kMissingTransferUpdateCallback:
return nearby_share::mojom::TransferStatus::
kMissingTransferUpdateCallback;
case TransferMetadata::Status::kMissingShareTarget:
return nearby_share::mojom::TransferStatus::kMissingShareTarget;
case TransferMetadata::Status::kMissingEndpointId:
return nearby_share::mojom::TransferStatus::kMissingEndpointId;
case TransferMetadata::Status::kMissingPayloads:
return nearby_share::mojom::TransferStatus::kMissingPayloads;
case TransferMetadata::Status::kPairedKeyVerificationFailed:
return nearby_share::mojom::TransferStatus::kPairedKeyVerificationFailed;
case TransferMetadata::Status::kInvalidIntroductionFrame:
return nearby_share::mojom::TransferStatus::kInvalidIntroductionFrame;
case TransferMetadata::Status::kIncompletePayloads:
return nearby_share::mojom::TransferStatus::kIncompletePayloads;
case TransferMetadata::Status::kFailedToCreateShareTarget:
return nearby_share::mojom::TransferStatus::kFailedToCreateShareTarget;
case TransferMetadata::Status::kFailedToInitiateOutgoingConnection:
return nearby_share::mojom::TransferStatus::
kFailedToInitiateOutgoingConnection;
case TransferMetadata::Status::kFailedToReadOutgoingConnectionResponse:
return nearby_share::mojom::TransferStatus::
kFailedToReadOutgoingConnectionResponse;
case TransferMetadata::Status::kUnexpectedDisconnection:
return nearby_share::mojom::TransferStatus::kUnexpectedDisconnection;
case TransferMetadata::Status::kMediaDownloading:
case TransferMetadata::Status::kExternalProviderLaunched:
// Ignore all other transfer status updates.
return std::nullopt;
}
}
std::string GetDeviceIdForLogs(const ShareTarget& share_target) {
return share_target.device_id
? base::HexEncode(share_target.device_id.value())
: "[null]";
}
} // namespace
NearbyPerSessionDiscoveryManager::NearbyPerSessionDiscoveryManager(
NearbySharingService* nearby_sharing_service,
std::vector<std::unique_ptr<Attachment>> attachments)
: nearby_sharing_service_(nearby_sharing_service),
attachments_(std::move(attachments)) {
nearby_sharing_service_->AddObserver(this);
}
NearbyPerSessionDiscoveryManager::~NearbyPerSessionDiscoveryManager() {
StopDiscovery(base::DoNothing());
observers_set_.Clear();
nearby_sharing_service_->RemoveObserver(this);
base::UmaHistogramEnumeration(
"Nearby.Share.Discovery.FurthestDiscoveryProgress", furthest_progress_);
base::UmaHistogramCounts100(
"Nearby.Share.Discovery.NumShareTargets.Discovered", num_discovered_);
base::UmaHistogramCounts100("Nearby.Share.Discovery.NumShareTargets.Lost",
num_lost_);
}
void NearbyPerSessionDiscoveryManager::OnTransferUpdate(
const ShareTarget& share_target,
const TransferMetadata& transfer_metadata) {
if (!transfer_update_listener_.is_bound()) {
// This can happen when registering the send surface and an existing
// transfer is happening or recently happened.
CD_LOG(VERBOSE, Feature::NS)
<< __func__
<< ": transfer_update_listener_ is not is_bound(), cannot "
"forward transfer updates";
return;
}
CD_LOG(VERBOSE, Feature::NS)
<< __func__ << ": Nearby per-session discovery manager: "
<< "Transfer update for share target with ID " << share_target.id << ": "
<< TransferMetadata::StatusToString(transfer_metadata.status());
std::optional<nearby_share::mojom::TransferStatus> status =
GetTransferStatus(transfer_metadata);
if (!status) {
CD_LOG(VERBOSE, Feature::NS)
<< __func__ << ": Nearby per-session discovery manager: "
<< " skipping status update, no mojo mapping defined yet.";
return;
}
transfer_update_listener_->OnTransferUpdate(*status,
transfer_metadata.token());
}
void NearbyPerSessionDiscoveryManager::OnShareTargetDiscovered(
ShareTarget share_target) {
CD_LOG(VERBOSE, Feature::NS)
<< "NearbyPerSessionDiscoveryManager::" << __func__
<< ": id=" << share_target.id
<< ", device_id=" << GetDeviceIdForLogs(share_target);
// Update metrics.
UpdateFurthestDiscoveryProgressIfNecessary(
DiscoveryProgress::kDiscoveredShareTargetNothingSent);
if (!base::Contains(discovered_share_targets_, share_target.id)) {
++num_discovered_;
if (num_discovered_ == 1) {
base::UmaHistogramMediumTimes(
"Nearby.Share.Discovery.Delay.FromStartDiscoveryToFirstDiscovery",
base::TimeTicks::Now() - *discovery_start_time_);
}
base::UmaHistogramMediumTimes(
"Nearby.Share.Discovery.Delay.FromStartDiscoveryToAnyDiscovery",
base::TimeTicks::Now() - *discovery_start_time_);
}
// Dedup by the more stable device ID if possible.
if (share_target.device_id) {
auto it =
std::ranges::find(discovered_share_targets_, share_target.device_id,
[](const auto& id_share_target_pair) {
return id_share_target_pair.second.device_id;
});
if (it != discovered_share_targets_.end()) {
CD_LOG(VERBOSE, Feature::NS)
<< "NearbyPerSessionDiscoveryManager::" << __func__
<< ": Removing previously discovered share target with "
<< "identical device_id=" << GetDeviceIdForLogs(share_target);
OnShareTargetLost(it->second);
}
}
discovered_share_targets_.insert_or_assign(share_target.id, share_target);
share_target_listener_->OnShareTargetDiscovered(share_target);
}
void NearbyPerSessionDiscoveryManager::AddDiscoveryObserver(
::mojo::PendingRemote<nearby_share::mojom::DiscoveryObserver> observer) {
observers_set_.Add(std::move(observer));
}
void NearbyPerSessionDiscoveryManager::OnShareTargetLost(
ShareTarget share_target) {
CD_LOG(VERBOSE, Feature::NS)
<< "NearbyPerSessionDiscoveryManager::" << __func__
<< ": id=" << share_target.id
<< ", device_id=" << GetDeviceIdForLogs(share_target);
// It is possible that we already removed a ShareTarget from the map when
// deduping by ShareTarget device_id.
if (!base::Contains(discovered_share_targets_, share_target.id)) {
CD_LOG(VERBOSE, Feature::NS)
<< "NearbyPerSessionDiscoveryManager::" << __func__
<< ": Share target id=" << share_target.id
<< " already removed. Taking no action.";
return;
}
++num_lost_;
discovered_share_targets_.erase(share_target.id);
share_target_listener_->OnShareTargetLost(share_target);
}
void NearbyPerSessionDiscoveryManager::StartDiscovery(
mojo::PendingRemote<nearby_share::mojom::ShareTargetListener> listener,
StartDiscoveryCallback callback) {
if (nearby_sharing_service_->IsTransferring() ||
nearby_sharing_service_->IsScanning() ||
nearby_sharing_service_->IsConnecting()) {
// Is there is currently a file transfer ongoing, return early with the
// corresponding error code.
std::move(callback).Run(nearby_share::mojom::StartDiscoveryResult::
kErrorInProgressTransferring);
return;
}
discovery_start_time_ = base::TimeTicks::Now();
// Starting discovery again closes any previous discovery session.
share_target_listener_.reset();
share_target_listener_.Bind(std::move(listener));
// NOTE: Previously we set a disconnect handler here that called
// UnregisterSendSurface, but this causes transfer updates to stop flowing to
// to the UI. Instead, we rely on the destructor's call to
// UnregisterSendSurface which will trigger when the share sheet goes away.
NearbySharingService::StatusCodes status =
nearby_sharing_service_->RegisterSendSurface(
this, this, NearbySharingService::SendSurfaceState::kForeground);
base::UmaHistogramEnumeration("Nearby.Share.Discovery.StartDiscovery",
status);
if (status != NearbySharingService::StatusCodes::kOk) {
CD_LOG(WARNING, Feature::NS)
<< __func__ << ": Failed to register send surface";
UpdateFurthestDiscoveryProgressIfNecessary(
DiscoveryProgress::kFailedToStartDiscovery);
share_target_listener_.reset();
nearby_share::mojom::StartDiscoveryResult errorStatus;
switch (status) {
case NearbySharingService::StatusCodes::kNoAvailableConnectionMedium:
errorStatus =
nearby_share::mojom::StartDiscoveryResult::kNoConnectionMedium;
break;
default:
errorStatus = nearby_share::mojom::StartDiscoveryResult::kErrorGeneric;
}
std::move(callback).Run(errorStatus);
return;
}
UpdateFurthestDiscoveryProgressIfNecessary(
DiscoveryProgress::kStartedDiscoveryNothingFound);
// Once this object is registered as send surface, we stay registered until
// UnregisterSendSurface is called so that the transfer update listeners can
// get updates even if Discovery is stopped.
registered_as_send_surface_ = true;
std::move(callback).Run(nearby_share::mojom::StartDiscoveryResult::kSuccess);
}
void NearbyPerSessionDiscoveryManager::StopDiscovery(
base::OnceClosure callback) {
if (registered_as_send_surface_) {
NearbySharingService::StatusCodes status =
nearby_sharing_service_->UnregisterSendSurface(this, this);
base::UmaHistogramEnumeration(
"Nearby.Share.Discovery.UnregisterSendSurface", status);
if (status != NearbySharingService::StatusCodes::kOk) {
CD_LOG(WARNING, Feature::NS)
<< __func__ << ": Failed to unregister send surface";
}
registered_as_send_surface_ = false;
}
share_target_listener_.reset();
std::move(callback).Run();
}
void NearbyPerSessionDiscoveryManager::SelectShareTarget(
const base::UnguessableToken& share_target_id,
SelectShareTargetCallback callback) {
DCHECK(share_target_listener_.is_bound());
DCHECK(!transfer_update_listener_.is_bound());
auto iter = discovered_share_targets_.find(share_target_id);
bool look_up_share_target_success = iter != discovered_share_targets_.end();
base::UmaHistogramBoolean("Nearby.Share.Discovery.LookUpSelectedShareTarget",
look_up_share_target_success);
if (!look_up_share_target_success) {
CD_LOG(VERBOSE, Feature::NS)
<< __func__
<< ": Unknown share target selected: id=" << share_target_id;
UpdateFurthestDiscoveryProgressIfNecessary(
DiscoveryProgress::kFailedToLookUpSelectedShareTarget);
std::move(callback).Run(
nearby_share::mojom::SelectShareTargetResult::kInvalidShareTarget,
mojo::NullReceiver(), mojo::NullRemote());
return;
}
// Bind update listener before calling the sharing service to get all updates.
mojo::PendingReceiver<nearby_share::mojom::TransferUpdateListener> receiver =
transfer_update_listener_.BindNewPipeAndPassReceiver();
transfer_update_listener_.reset_on_disconnect();
base::UmaHistogramCounts100(
"Nearby.Share.Discovery.NumShareTargets.PresentWhenSendStarts",
discovered_share_targets_.size());
base::UmaHistogramMediumTimes(
"Nearby.Share.Discovery.Delay.FromStartDiscoveryToStartSend",
base::TimeTicks::Now() - *discovery_start_time_);
NearbySharingService::StatusCodes status =
nearby_sharing_service_->SendAttachments(iter->second,
std::move(attachments_));
base::UmaHistogramEnumeration("Nearby.Share.Discovery.StartSend", status);
// If the send call succeeded, we expect OnTransferUpdate() to be called next.
if (status == NearbySharingService::StatusCodes::kOk) {
UpdateFurthestDiscoveryProgressIfNecessary(DiscoveryProgress::kStartedSend);
mojo::PendingRemote<nearby_share::mojom::ConfirmationManager> remote;
mojo::MakeSelfOwnedReceiver(std::make_unique<NearbyConfirmationManager>(
nearby_sharing_service_, iter->second),
remote.InitWithNewPipeAndPassReceiver());
std::move(callback).Run(nearby_share::mojom::SelectShareTargetResult::kOk,
std::move(receiver), std::move(remote));
return;
}
CD_LOG(VERBOSE, Feature::NS)
<< __func__ << ": Failed to start send to share target";
UpdateFurthestDiscoveryProgressIfNecessary(
DiscoveryProgress::kFailedToStartSend);
transfer_update_listener_.reset();
std::move(callback).Run(nearby_share::mojom::SelectShareTargetResult::kError,
mojo::NullReceiver(), mojo::NullRemote());
}
void NearbyPerSessionDiscoveryManager::GetPayloadPreview(
GetPayloadPreviewCallback callback) {
// TODO(crbug.com/1158627): Extract this which is very similar to logic in
// nearby share mojo traits.
nearby_share::mojom::PayloadPreviewPtr payload_preview =
nearby_share::mojom::PayloadPreview::New();
payload_preview->file_count = 0;
payload_preview->share_type = nearby_share::mojom::ShareType::kText;
if (attachments_.empty()) {
// Return with an empty text attachment.
std::move(callback).Run(std::move(payload_preview));
return;
}
// We have at least 1 attachment, use that one for the default description.
auto& attachment = attachments_[0];
payload_preview->description = attachment->GetDescription();
if (attachment->family() == Attachment::Family::kFile)
payload_preview->file_count = attachments_.size();
if (payload_preview->file_count > 1) {
payload_preview->share_type =
nearby_share::mojom::ShareType::kMultipleFiles;
} else {
payload_preview->share_type = attachment->GetShareType();
}
std::move(callback).Run(std::move(payload_preview));
}
void NearbyPerSessionDiscoveryManager::OnNearbyProcessStopped() {
for (auto& remote : observers_set_) {
remote->OnNearbyProcessStopped();
}
}
void NearbyPerSessionDiscoveryManager::OnStartDiscoveryResult(bool success) {
for (auto& remote : observers_set_) {
remote->OnStartDiscoveryResult(success);
}
}
void NearbyPerSessionDiscoveryManager::
UpdateFurthestDiscoveryProgressIfNecessary(DiscoveryProgress progress) {
if (static_cast<int>(progress) > static_cast<int>(furthest_progress_))
furthest_progress_ = progress;
}
|