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 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <iterator>
#include <memory>
#include "base/cancelable_callback.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/memory/weak_ptr.h"
#include "base/test/test_future.h"
#include "base/test/test_timeouts.h"
#include "content/browser/blob_storage/chrome_blob_storage_context.h"
#include "content/browser/file_system_access/file_path_watcher/file_path_watcher.h"
#include "content/browser/file_system_access/file_system_access_directory_handle_impl.h"
#include "content/browser/file_system_access/file_system_access_file_handle_impl.h"
#include "content/browser/file_system_access/file_system_access_manager_impl.h"
#include "content/browser/file_system_access/file_system_access_watcher_manager.h"
#include "content/browser/file_system_access/fixed_file_system_access_permission_grant.h"
#include "content/browser/renderer_host/render_frame_host_impl.h"
#include "content/public/test/test_browser_context.h"
#include "content/public/test/test_renderer_host.h"
#include "content/test/test_web_contents.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/receiver.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "mojo/public/cpp/bindings/remote_set.h"
#include "storage/browser/file_system/file_system_url.h"
#include "storage/browser/quota/quota_manager_proxy.h"
#include "storage/browser/test/test_file_system_context.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/public/mojom/file_system_access/file_system_access_observer_host.mojom.h"
namespace content {
using ChangeInfo = FilePathWatcher::ChangeInfo;
using ChangeType = FilePathWatcher::ChangeType;
using FilePathType = FilePathWatcher::FilePathType;
using MojoChangeType = blink::mojom::internal::FileSystemAccessChangeType_Data::
FileSystemAccessChangeType_Tag;
using MojoFilePathType = blink::mojom::internal::FileSystemAccessHandle_Data::
FileSystemAccessHandle_Tag;
namespace {
// A struct equivalent to `blink::mojom::FileSystemAccessChangePtr` but can be
// used in gtest matchers.
struct MojoChangeInfo {
static MojoChangeInfo FromMojo(
const blink::mojom::FileSystemAccessChangePtr& mojo_change) {
std::optional<std::vector<std::string>> relative_moved_from_path;
if (mojo_change->type->is_moved()) {
relative_moved_from_path =
mojo_change->type->get_moved()->former_relative_path;
}
return {mojo_change->type->which(),
mojo_change->metadata->changed_entry->entry_handle->which(),
mojo_change->metadata->relative_path, relative_moved_from_path};
}
MojoChangeType change_type;
MojoFilePathType file_path_type;
std::vector<std::string> relative_path;
std::optional<std::vector<std::string>> relative_moved_from_path;
friend bool operator==(MojoChangeInfo rhs, MojoChangeInfo lhs) {
return rhs.change_type == lhs.change_type &&
rhs.file_path_type == lhs.file_path_type &&
rhs.relative_path == lhs.relative_path &&
rhs.relative_moved_from_path == lhs.relative_moved_from_path;
}
};
// Implementation of an observation (blink::mojom::FileSystemAccessObserver).
// Collects the changes it receives so that it can be verified against expected
// changes.
class FakeObservation : public blink::mojom::FileSystemAccessObserver {
public:
explicit FakeObservation(
mojo::PendingReceiver<blink::mojom::FileSystemAccessObserver>
pending_receiver)
: receiver_(this, std::move(pending_receiver)) {
receiver_.set_disconnect_handler(base::BindOnce(
&FakeObservation::OnRemoteDisconnected, weak_factory_.GetWeakPtr()));
}
// Returns true if the the events received since the last call to this
// function matches the `expected_changes`.
bool EventsReceivedMatches(std::vector<MojoChangeInfo> expected_changes) {
return testing::Matches(testing::ContainerEq(CollectEvents()))(
expected_changes);
}
bool RemoteObservationDisconnected() {
return remote_observation_disconnected_;
}
private:
// blink::mojom::FileSystemAccessObserver
void OnFileChanges(std::vector<blink::mojom::FileSystemAccessChangePtr>
mojo_changes) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
std::transform(mojo_changes.begin(), mojo_changes.end(),
std::back_inserter(collected_events_),
MojoChangeInfo::FromMojo);
}
using CollectEventsCallback =
base::OnceCallback<void(std::vector<MojoChangeInfo>)>;
void CollectEventsImpl(CollectEventsCallback future_callback) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
auto finish_collecting_events_callback = base::BindOnce(
&FakeObservation::FinishCollectingEvents, weak_factory_.GetWeakPtr(),
collected_events_.size(), std::move(future_callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE, std::move(finish_collecting_events_callback),
TestTimeouts::tiny_timeout());
}
void FinishCollectingEvents(size_t collected_events_previous_size,
CollectEventsCallback future_callback) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (collected_events_.size() == collected_events_previous_size) {
std::move(future_callback).Run(std::move(collected_events_));
} else {
CollectEventsImpl(std::move(future_callback));
}
}
std::vector<MojoChangeInfo> CollectEvents() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::test::TestFuture<std::vector<MojoChangeInfo>> future;
CollectEventsImpl(future.GetCallback());
return future.Take();
}
void OnRemoteDisconnected() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
remote_observation_disconnected_ = true;
}
SEQUENCE_CHECKER(sequence_checker_);
std::vector<MojoChangeInfo> collected_events_;
mojo::Receiver<blink::mojom::FileSystemAccessObserver> receiver_;
bool remote_observation_disconnected_ = false;
base::WeakPtrFactory<FakeObservation> weak_factory_
GUARDED_BY_CONTEXT(sequence_checker_){this};
};
// Wraps an observer remote
// (mojo::Remote<blink::mojom::FileSystemAccessObserverHost>).
class FakeObserver {
public:
explicit FakeObserver(
mojo::Remote<blink::mojom::FileSystemAccessObserverHost> observer)
: observer_(std::move(observer)) {}
FakeObservation Observe(std::variant<FileSystemAccessFileHandleImpl*,
FileSystemAccessDirectoryHandleImpl*>
file_or_directory_handle,
bool recursive) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
CHECK(observer_.is_bound());
mojo::PendingRemote<blink::mojom::FileSystemAccessTransferToken>
transfer_token;
std::visit(
[&transfer_token](auto* handle) {
handle->Transfer(transfer_token.InitWithNewPipeAndPassReceiver());
},
file_or_directory_handle);
base::test::TestFuture<
blink::mojom::FileSystemAccessErrorPtr,
mojo::PendingReceiver<blink::mojom::FileSystemAccessObserver>>
future;
observer_->Observe(std::move(transfer_token), recursive,
future.GetCallback());
auto [result, observer_receiver] = future.Take();
CHECK(result->status == blink::mojom::FileSystemAccessStatus::kOk);
return FakeObservation(std::move(observer_receiver));
}
private:
SEQUENCE_CHECKER(sequence_checker_);
mojo::Remote<blink::mojom::FileSystemAccessObserverHost> observer_;
};
// Trivial implementation of a change source which allows tests to signal
// changes.
class FakeChangeSource : public FileSystemAccessChangeSource {
public:
explicit FakeChangeSource(
FileSystemAccessWatchScope scope,
scoped_refptr<storage::FileSystemContext> file_system_context,
FileSystemAccessWatcherManager& watcher_manager)
: FileSystemAccessChangeSource(std::move(scope),
std::move(file_system_context)) {
watcher_manager.RegisterSourceForTesting(this);
EXPECT_TRUE(watcher_manager.HasSourceForTesting(this));
}
FakeChangeSource(const FakeChangeSource&) = delete;
FakeChangeSource& operator=(const FakeChangeSource&) = delete;
~FakeChangeSource() override = default;
// FileSystemAccessChangeSource:
void Initialize(
base::OnceCallback<void(blink::mojom::FileSystemAccessErrorPtr)>
on_initialized) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
std::move(on_initialized).Run(initialization_result_->Clone());
}
void SignalChange(ChangeInfo change_info = ChangeInfo()) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::FilePath relative_path;
scope().root_url().virtual_path().AppendRelativePath(
change_info.modified_path, &relative_path);
NotifyOfChange(std::move(relative_path), false, std::move(change_info));
}
void SignalUsageChange(size_t old_usage, size_t new_usage) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
NotifyOfUsageChange(old_usage, new_usage);
}
void SignalError() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
NotifyOfChange(base::FilePath(), true, ChangeInfo());
}
private:
blink::mojom::FileSystemAccessErrorPtr initialization_result_
GUARDED_BY_CONTEXT(sequence_checker_) =
blink::mojom::FileSystemAccessError::New(
blink::mojom::FileSystemAccessStatus::kOk,
base::File::FILE_OK,
"");
};
} // namespace
class FileSystemAccessObserverObservationTest
: public RenderViewHostTestHarness {
public:
void SetUp() override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
RenderViewHostTestHarness::SetUp();
ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
file_system_context_ = storage::CreateFileSystemContextForTesting(
/*quota_manager_proxy=*/nullptr, temp_dir_.GetPath());
chrome_blob_context_ = base::MakeRefCounted<ChromeBlobStorageContext>();
chrome_blob_context_->InitializeOnIOThread(base::FilePath(),
base::FilePath(), nullptr);
manager_ = base::MakeRefCounted<FileSystemAccessManagerImpl>(
file_system_context_, chrome_blob_context_,
/*permission_context=*/nullptr,
/*off_the_record=*/false);
}
void TearDown() override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
manager_.reset();
task_environment()->RunUntilIdle();
EXPECT_TRUE(temp_dir_.Delete());
chrome_blob_context_.reset();
RenderViewHostTestHarness::TearDown();
}
scoped_refptr<storage::FileSystemContext>& file_system_context() {
return file_system_context_;
}
void RegisterChangeSource(FakeChangeSource& source) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
manager_->watcher_manager().RegisterSourceForTesting(&source);
EXPECT_TRUE(manager_->watcher_manager().HasSourceForTesting(&source));
}
void EnterBFCache() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
RenderFrameHostImpl* rfh = static_cast<RenderFrameHostImpl*>(main_rfh());
rfh->SetLifecycleState(
RenderFrameHostImpl::LifecycleStateImpl::kInBackForwardCache);
}
void ExitBFCache() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
RenderFrameHostImpl* rfh = static_cast<RenderFrameHostImpl*>(main_rfh());
rfh->SetLifecycleState(RenderFrameHostImpl::LifecycleStateImpl::kActive);
}
FakeChangeSource CreateFileChangeSource(storage::FileSystemURL file_url) {
return FakeChangeSource(
FileSystemAccessWatchScope::GetScopeForFileWatch(file_url),
file_system_context_, manager_->watcher_manager());
}
base::FilePath CreateFile() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::FilePath file_path;
{
base::ScopedAllowBlockingForTesting allow_blocking;
EXPECT_TRUE(
base::CreateTemporaryFileInDir(temp_dir_.GetPath(), &file_path));
EXPECT_TRUE(base::WriteFile(file_path, "observe me"));
}
return file_path;
}
storage::FileSystemURL CreateFileSystemURL(const base::FilePath& file_path) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return manager_->CreateFileSystemURLFromPath(PathInfo(file_path));
}
std::unique_ptr<FileSystemAccessFileHandleImpl> CreateFileHandle(
const storage::FileSystemURL& file_url,
const base::FilePath& display_name) {
return CreateFileHandle(kTestOrigin, file_url, display_name);
}
std::unique_ptr<FileSystemAccessFileHandleImpl> CreateFileHandle(
const std::string& origin,
const storage::FileSystemURL& file_url,
const base::FilePath& display_name) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return std::make_unique<FileSystemAccessFileHandleImpl>(
manager_.get(), GetBindingContext(origin), file_url,
display_name.AsUTF8Unsafe(),
FileSystemAccessManagerImpl::SharedHandleState(allow_grant_,
allow_grant_));
}
FakeChangeSource CreateDirectoryChangeSource(storage::FileSystemURL dir_url,
bool is_recursive) {
return FakeChangeSource(
FileSystemAccessWatchScope::GetScopeForDirectoryWatch(dir_url,
is_recursive),
file_system_context_, manager_->watcher_manager());
}
base::FilePath CreateDirectory() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::FilePath dir_path;
{
base::ScopedAllowBlockingForTesting allow_blocking;
EXPECT_TRUE(base::CreateTemporaryDirInDir(
temp_dir_.GetPath(), FILE_PATH_LITERAL("test"), &dir_path));
}
return dir_path;
}
std::unique_ptr<FileSystemAccessDirectoryHandleImpl> CreateDirectoryHandle(
const storage::FileSystemURL& dir_url) {
return CreateDirectoryHandle(kTestOrigin, dir_url);
}
std::unique_ptr<FileSystemAccessDirectoryHandleImpl> CreateDirectoryHandle(
const std::string& origin,
const storage::FileSystemURL& dir_url) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return std::make_unique<FileSystemAccessDirectoryHandleImpl>(
manager_.get(), GetBindingContext(origin), dir_url,
FileSystemAccessManagerImpl::SharedHandleState(allow_grant_,
allow_grant_));
}
FakeObserver CreateObserver() { return CreateObserver(kTestOrigin); }
FakeObserver CreateObserver(const std::string& origin) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
mojo::Remote<blink::mojom::FileSystemAccessObserverHost> observer;
mojo::PendingReceiver<blink::mojom::FileSystemAccessObserverHost>
host_receiver = observer.BindNewPipeAndPassReceiver();
FakeObserver fake_observer(std::move(observer));
manager_->watcher_manager().BindObserverHost(GetBindingContext(origin),
std::move(host_receiver));
return fake_observer;
}
private:
FileSystemAccessManagerImpl::BindingContext GetBindingContext(
const std::string& origin) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
GURL url = GURL(origin);
blink::StorageKey storage_key =
blink::StorageKey::CreateFromStringForTesting(origin);
RenderFrameHostImpl* rfh = static_cast<RenderFrameHostImpl*>(main_rfh());
return FileSystemAccessManagerImpl::BindingContext(storage_key, url,
rfh->GetGlobalId());
}
SEQUENCE_CHECKER(sequence_checker_);
std::string kTestOrigin = "https://example.com/test";
base::ScopedTempDir temp_dir_;
scoped_refptr<storage::FileSystemContext> file_system_context_;
scoped_refptr<ChromeBlobStorageContext> chrome_blob_context_;
scoped_refptr<FileSystemAccessManagerImpl> manager_;
scoped_refptr<FixedFileSystemAccessPermissionGrant> allow_grant_ =
base::MakeRefCounted<FixedFileSystemAccessPermissionGrant>(
FixedFileSystemAccessPermissionGrant::PermissionStatus::GRANTED,
PathInfo());
};
TEST_F(FileSystemAccessObserverObservationTest,
NoChangesAfterAnErrorIsReported) {
base::FilePath file_path = CreateFile();
storage::FileSystemURL file_url = CreateFileSystemURL(file_path);
std::unique_ptr<FileSystemAccessFileHandleImpl> file_handle =
CreateFileHandle(file_url, file_path.BaseName());
FakeChangeSource source = CreateFileChangeSource(file_url);
FakeObserver observer = CreateObserver();
FakeObservation observation = observer.Observe(file_handle.get(), false);
// Will receive changes before the error.
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated, file_path));
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kAppeared, MojoFilePathType::kFile, {}}}));
// Will receive an error event after signalling an error.
source.SignalError();
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kErrored, MojoFilePathType::kFile, {}}}));
// Won't receive any further error events or changes.
source.SignalError();
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated, file_path));
EXPECT_TRUE(observation.EventsReceivedMatches({}));
EXPECT_TRUE(observation.RemoteObservationDisconnected());
}
TEST_F(FileSystemAccessObserverObservationTest,
AnErrorDestroysTheCorrectObservation) {
base::FilePath file_path1 = CreateFile();
storage::FileSystemURL file_url1 = CreateFileSystemURL(file_path1);
std::unique_ptr<FileSystemAccessFileHandleImpl> file_handle1 =
CreateFileHandle(file_url1, file_path1.BaseName());
FakeChangeSource source1 = CreateFileChangeSource(file_url1);
base::FilePath file_path2 = CreateFile();
storage::FileSystemURL file_url2 = CreateFileSystemURL(file_path2);
std::unique_ptr<FileSystemAccessFileHandleImpl> file_handle2 =
CreateFileHandle(file_url2, file_path2.BaseName());
FakeChangeSource source2 = CreateFileChangeSource(file_url2);
FakeObserver observer = CreateObserver();
FakeObservation observation1 = observer.Observe(file_handle1.get(), false);
FakeObservation observation2 = observer.Observe(file_handle2.get(), false);
// Only `observation1` receives the error for `source`.
source1.SignalError();
EXPECT_TRUE(observation1.EventsReceivedMatches(
{{MojoChangeType::kErrored, MojoFilePathType::kFile, {}}}));
EXPECT_TRUE(observation2.EventsReceivedMatches({}));
EXPECT_TRUE(observation1.RemoteObservationDisconnected());
// `observation1` won't receive any further error events or changes, and
// `observation2` will continue not to receive changes for `source1`.
source1.SignalError();
source1.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated, file_path1));
EXPECT_TRUE(observation1.EventsReceivedMatches({}));
EXPECT_TRUE(observation1.RemoteObservationDisconnected());
EXPECT_TRUE(observation2.EventsReceivedMatches({}));
// `observation2` continues to receive changes.
source2.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated, file_path2));
EXPECT_TRUE(observation1.EventsReceivedMatches({}));
EXPECT_TRUE(observation1.RemoteObservationDisconnected());
EXPECT_TRUE(observation2.EventsReceivedMatches(
{{MojoChangeType::kAppeared, MojoFilePathType::kFile, {}}}));
}
TEST_F(FileSystemAccessObserverObservationTest,
FileObservationDestructedAfterFileDeleted) {
base::FilePath file_path = CreateFile();
storage::FileSystemURL file_url = CreateFileSystemURL(file_path);
std::unique_ptr<FileSystemAccessFileHandleImpl> file_handle =
CreateFileHandle(file_url, file_path.BaseName());
FakeChangeSource source = CreateFileChangeSource(file_url);
FakeObserver observer = CreateObserver();
FakeObservation observation =
observer.Observe(file_handle.get(), /*recursive=*/false);
// Deleting the file should result in a disappeared and an errored event.
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated, file_path));
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kDeleted, file_path));
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kAppeared, MojoFilePathType::kFile, {}},
{MojoChangeType::kDisappeared, MojoFilePathType::kFile, {}},
{MojoChangeType::kErrored, MojoFilePathType::kFile, {}}}));
// The remote observation should have been destructed and disconnected. So,
// further events should not be received.
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kModified, file_path));
EXPECT_TRUE(observation.EventsReceivedMatches({}));
EXPECT_TRUE(observation.RemoteObservationDisconnected());
}
TEST_F(FileSystemAccessObserverObservationTest,
FileObservationDestructedWhenParentDirectoryDeleted) {
base::FilePath dir_path = CreateDirectory();
base::FilePath file_path;
{
base::ScopedAllowBlockingForTesting allow_blocking;
EXPECT_TRUE(base::CreateTemporaryFileInDir(dir_path, &file_path));
EXPECT_TRUE(base::WriteFile(file_path, "observe me"));
}
storage::FileSystemURL file_url = CreateFileSystemURL(file_path);
std::unique_ptr<FileSystemAccessFileHandleImpl> file_handle =
CreateFileHandle(file_url, file_path.BaseName());
FakeChangeSource source = CreateFileChangeSource(file_url);
FakeObserver observer = CreateObserver();
FakeObservation observation =
observer.Observe(file_handle.get(), /*recursive=*/false);
// Deleting the parent directory should result in a disappeared and an errored
// event on the file observation.
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kModified, file_path));
// We handle directory deletion by signaling a deleted event on the file
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kDeleted, file_path));
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kModified, MojoFilePathType::kFile, {}},
{MojoChangeType::kDisappeared, MojoFilePathType::kFile, {}},
{MojoChangeType::kErrored, MojoFilePathType::kFile, {}}}));
// The remote observation should have been destructed and disconnected. So,
// further events should not be received.
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kModified, file_path));
EXPECT_TRUE(observation.EventsReceivedMatches({}));
EXPECT_TRUE(observation.RemoteObservationDisconnected());
}
// TODO(crbug.com/393229134): Reenable this test.
#if BUILDFLAG(IS_WIN)
#define MAYBE_DirectoryObservationDestructedAfterScopeRootDeleted \
DISABLED_DirectoryObservationDestructedAfterScopeRootDeleted
#else
#define MAYBE_DirectoryObservationDestructedAfterScopeRootDeleted \
DirectoryObservationDestructedAfterScopeRootDeleted
#endif
TEST_F(FileSystemAccessObserverObservationTest,
MAYBE_DirectoryObservationDestructedAfterScopeRootDeleted) {
base::FilePath dir_path = CreateDirectory();
storage::FileSystemURL dir_url = CreateFileSystemURL(dir_path);
std::unique_ptr<FileSystemAccessDirectoryHandleImpl> dir_handle =
CreateDirectoryHandle(dir_url);
FakeChangeSource source =
CreateDirectoryChangeSource(dir_url, /*is_recursive=*/false);
FakeObserver observer = CreateObserver();
FakeObservation observation =
observer.Observe(dir_handle.get(), /*recursive=*/false);
base::FilePath file_path = dir_path.AppendASCII("file.txt");
// Deleting the directory root should result in a disappeared and an errored
// event.
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated, file_path));
// We handle directory deletion by first signaling a deleted event and then an
// error.
source.SignalChange(
ChangeInfo(FilePathType::kDirectory, ChangeType::kDeleted, dir_path));
source.SignalError();
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kAppeared, MojoFilePathType::kFile, {"file.txt"}},
{MojoChangeType::kDisappeared, MojoFilePathType::kDirectory, {}},
{MojoChangeType::kErrored, MojoFilePathType::kDirectory, {}}}));
// The remote observation should have been destructed and disconnected. So,
// no further events should be received.
source.SignalChange(
ChangeInfo(FilePathType::kDirectory, ChangeType::kModified, dir_path));
EXPECT_TRUE(observation.EventsReceivedMatches({}));
EXPECT_TRUE(observation.RemoteObservationDisconnected());
}
// TODO(crbug.com/393229134): Reenable this test.
#if BUILDFLAG(IS_WIN)
#define MAYBE_DirectoryObservationNotDestructedAfterFileDeleted \
DISABLED_DirectoryObservationNotDestructedAfterFileDeleted
#else
#define MAYBE_DirectoryObservationNotDestructedAfterFileDeleted \
DirectoryObservationNotDestructedAfterFileDeleted
#endif
TEST_F(FileSystemAccessObserverObservationTest,
MAYBE_DirectoryObservationNotDestructedAfterFileDeleted) {
base::FilePath dir_path = CreateDirectory();
storage::FileSystemURL dir_url = CreateFileSystemURL(dir_path);
std::unique_ptr<FileSystemAccessDirectoryHandleImpl> dir_handle =
CreateDirectoryHandle(dir_url);
FakeChangeSource source =
CreateDirectoryChangeSource(dir_url, /*is_recursive=*/false);
FakeObserver observer = CreateObserver();
FakeObservation observation =
observer.Observe(dir_handle.get(), /*recursive=*/false);
base::FilePath file_path = dir_path.AppendASCII("file.txt");
// Deleting a file in the dir should result in a disappeared but not an
// errored event.
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated, file_path));
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kDeleted, file_path));
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kAppeared, MojoFilePathType::kFile, {"file.txt"}},
{MojoChangeType::kDisappeared, MojoFilePathType::kFile, {"file.txt"}}}));
// The remote observation should not have been disconnected. So, we should
// continue receiving events.
source.SignalChange(
ChangeInfo(FilePathType::kDirectory, ChangeType::kModified, dir_path));
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kModified, MojoFilePathType::kDirectory, {}}}));
}
// TODO(crbug.com/393229134): Reenable this test.
#if BUILDFLAG(IS_WIN)
#define MAYBE_ObservationDestroyedOnQuotaExceeded \
DISABLED_ObservationDestroyedOnQuotaExceeded
#else
#define MAYBE_ObservationDestroyedOnQuotaExceeded \
ObservationDestroyedOnQuotaExceeded
#endif
TEST_F(FileSystemAccessObserverObservationTest,
MAYBE_ObservationDestroyedOnQuotaExceeded) {
base::FilePath favorites_path = CreateDirectory();
base::FilePath documents_path = CreateDirectory();
storage::FileSystemURL favorites_url = CreateFileSystemURL(favorites_path);
storage::FileSystemURL documents_url = CreateFileSystemURL(documents_path);
FakeChangeSource favorites_source =
CreateDirectoryChangeSource(favorites_url, /*is_recursive=*/false);
FakeChangeSource documents_source =
CreateDirectoryChangeSource(documents_url, /*is_recursive=*/false);
std::string foo_origin = "https://foo.com";
std::string bar_origin = "https://bar.com";
FakeObserver foo_observer = CreateObserver(foo_origin);
FakeObserver bar_observer = CreateObserver(bar_origin);
std::unique_ptr<FileSystemAccessDirectoryHandleImpl> foo_favorites_handle =
CreateDirectoryHandle(foo_origin, favorites_url);
std::unique_ptr<FileSystemAccessDirectoryHandleImpl> bar_favorites_handle =
CreateDirectoryHandle(bar_origin, favorites_url);
std::unique_ptr<FileSystemAccessDirectoryHandleImpl> foo_documents_handle =
CreateDirectoryHandle(foo_origin, documents_url);
FakeObservation foo_favorites_observation =
foo_observer.Observe(foo_favorites_handle.get(), /*recursive=*/false);
FakeObservation bar_favorites_observation =
bar_observer.Observe(bar_favorites_handle.get(), /*recursive=*/false);
FakeObservation foo_documents_observation =
foo_observer.Observe(foo_documents_handle.get(), /*recursive=*/false);
auto quota_override = FilePathWatcher::SetQuotaLimitForTesting(100);
// Only foo is observing documents, so only its usage should rise. It is still
// under the quota limit though.
// - foo: (favorites usage = 0) + (documents usage = 50) = 50
// - 50 < 100 so no quota error
// - bar: (favorites usage = 0) = 0
// - 0 < 100 so no quota error
documents_source.SignalUsageChange(0, 50);
EXPECT_TRUE(foo_favorites_observation.EventsReceivedMatches({}));
EXPECT_FALSE(foo_favorites_observation.RemoteObservationDisconnected());
EXPECT_TRUE(bar_favorites_observation.EventsReceivedMatches({}));
EXPECT_FALSE(bar_favorites_observation.RemoteObservationDisconnected());
EXPECT_TRUE(foo_documents_observation.EventsReceivedMatches({}));
EXPECT_FALSE(foo_documents_observation.RemoteObservationDisconnected());
// Both origins are observing favorites, so both usages should rise. This
// sends foo over the quota limit but not bar. Foo's favorites observation
// should receive an error and be disconnected.
// - foo: (favorites usage = 60) + (documents usage = 50) = 110
// - 110 > 100 so quota error
// - bar: (favorites usage = 60) = 60
// - 60 < 100 so no quota error
favorites_source.SignalUsageChange(0, 60);
EXPECT_TRUE(foo_favorites_observation.EventsReceivedMatches(
{{MojoChangeType::kErrored, MojoFilePathType::kDirectory, {}}}));
EXPECT_TRUE(foo_favorites_observation.RemoteObservationDisconnected());
EXPECT_TRUE(bar_favorites_observation.EventsReceivedMatches({}));
EXPECT_FALSE(bar_favorites_observation.RemoteObservationDisconnected());
EXPECT_TRUE(foo_documents_observation.EventsReceivedMatches({}));
EXPECT_FALSE(foo_documents_observation.RemoteObservationDisconnected());
// Only bar should now receive events for favorites now.
std::string file_name = "file.txt";
favorites_source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated,
favorites_path.AppendASCII(file_name)));
EXPECT_TRUE(foo_favorites_observation.EventsReceivedMatches({}));
EXPECT_TRUE(bar_favorites_observation.EventsReceivedMatches(
{{MojoChangeType::kAppeared, MojoFilePathType::kFile, {file_name}}}));
// Foo can still receive events for documents.
documents_source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated,
documents_path.AppendASCII(file_name)));
EXPECT_TRUE(foo_documents_observation.EventsReceivedMatches(
{{MojoChangeType::kAppeared, MojoFilePathType::kFile, {file_name}}}));
}
TEST_F(FileSystemAccessObserverObservationTest, ReceivedEventsInBFCache) {
base::FilePath file_path = CreateFile();
storage::FileSystemURL file_url = CreateFileSystemURL(file_path);
std::unique_ptr<FileSystemAccessFileHandleImpl> file_handle =
CreateFileHandle(file_url, file_path.BaseName());
FakeChangeSource source = CreateFileChangeSource(file_url);
FakeObserver observer = CreateObserver();
FakeObservation observation = observer.Observe(file_handle.get(), false);
// Will receive changes before entering BFCache.
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated, file_path));
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kModified, file_path));
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kAppeared, MojoFilePathType::kFile, {}},
{MojoChangeType::kModified, MojoFilePathType::kFile, {}}}));
// No event is emitted just for entering the BFCache.
EnterBFCache();
ExitBFCache();
EXPECT_TRUE(observation.EventsReceivedMatches({}));
// No events are emitted while in BFCache.
EnterBFCache();
source.SignalChange();
source.SignalChange();
EXPECT_TRUE(observation.EventsReceivedMatches({}));
// If we receive an event while in BFCache, a single unknown event is emitted
// after exiting BFCache.
ExitBFCache();
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kUnknown, MojoFilePathType::kFile, {}}}));
}
TEST_F(FileSystemAccessObserverObservationTest, ReceivedErrorsInBFCache) {
base::FilePath file_path = CreateFile();
storage::FileSystemURL file_url = CreateFileSystemURL(file_path);
std::unique_ptr<FileSystemAccessFileHandleImpl> file_handle =
CreateFileHandle(file_url, file_path.BaseName());
FakeChangeSource source = CreateFileChangeSource(file_url);
FakeObserver observer = CreateObserver();
FakeObservation observation = observer.Observe(file_handle.get(), false);
// Will receive changes before entering BFCache.
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kCreated, file_path));
source.SignalChange(
ChangeInfo(FilePathType::kFile, ChangeType::kModified, file_path));
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kAppeared, MojoFilePathType::kFile, {}},
{MojoChangeType::kModified, MojoFilePathType::kFile, {}}}));
// No event is emitted just for entering the BFCache.
EnterBFCache();
ExitBFCache();
EXPECT_TRUE(observation.EventsReceivedMatches({}));
// No errors are emitted while in BFCache
EnterBFCache();
source.SignalChange();
source.SignalError();
source.SignalError();
source.SignalChange();
EXPECT_TRUE(observation.EventsReceivedMatches({}));
// If we receive an event while in BFCache, a single unknown event is emitted
// after exiting BFCache.
ExitBFCache();
EXPECT_TRUE(observation.EventsReceivedMatches(
{{MojoChangeType::kErrored, MojoFilePathType::kFile, {}}}));
}
} // namespace content
|