Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Factor out a task synchronization help function for unit tests #28467

Merged
merged 3 commits into from
Sep 8, 2021
Merged

Factor out a task synchronization help function for unit tests #28467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f712c9
Factor out several task synchronization help functions for unit tests
ColdPaleLight Sep 5, 2021
d21eb8e
Remove redundant functions
ColdPaleLight Sep 8, 2021
66f6a6a
Delete unused header file
ColdPaleLight Sep 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 18 additions & 73 deletions lib/ui/painting/image_decoder_unittests.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
#include "flutter/testing/dart_isolate_runner.h"
#include "flutter/testing/elf_loader.h"
#include "flutter/testing/fixture_test.h"
#include "flutter/testing/post_task_sync.h"
#include "flutter/testing/test_dart_native_resolver.h"
#include "flutter/testing/test_gl_surface.h"
#include "flutter/testing/testing.h"
Expand Down Expand Up @@ -134,14 +135,11 @@ TEST_F(ImageDecoderFixtureTest, CanCreateImageDecoder) {

);

fml::AutoResetWaitableEvent latch;
runners.GetIOTaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetIOTaskRunner(), [&]() {
TestIOManager manager(runners.GetIOTaskRunner());
ImageDecoder decoder(std::move(runners), loop->GetTaskRunner(),
manager.GetWeakIOManager());
latch.Signal();
});
latch.Wait();
}

/// An Image generator that pretends it can't recognize the data it was given.
Expand Down Expand Up @@ -401,20 +399,15 @@ TEST_F(ImageDecoderFixtureTest, CanDecodeWithResizes) {
std::unique_ptr<ImageDecoder> image_decoder;

// Setup the IO manager.
runners.GetIOTaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetIOTaskRunner(), [&]() {
io_manager = std::make_unique<TestIOManager>(runners.GetIOTaskRunner());
latch.Signal();
});
latch.Wait();

// Setup the image decoder.
runners.GetUITaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetUITaskRunner(), [&]() {
image_decoder = std::make_unique<ImageDecoder>(
runners, loop->GetTaskRunner(), io_manager->GetWeakIOManager());

latch.Signal();
});
latch.Wait();

// Setup a generic decoding utility that gives us the final decoded size.
auto decoded_size = [&](uint32_t target_width,
Expand Down Expand Up @@ -451,18 +444,10 @@ TEST_F(ImageDecoderFixtureTest, CanDecodeWithResizes) {
ASSERT_EQ(decoded_size(100, 100), SkISize::Make(100, 100));

// Destroy the IO manager
runners.GetIOTaskRunner()->PostTask([&]() {
io_manager.reset();
latch.Signal();
});
latch.Wait();
PostTaskSync(runners.GetIOTaskRunner(), [&]() { io_manager.reset(); });

// Destroy the image decoder
runners.GetUITaskRunner()->PostTask([&]() {
image_decoder.reset();
latch.Signal();
});
latch.Wait();
PostTaskSync(runners.GetUITaskRunner(), [&]() { image_decoder.reset(); });
}

// TODO(https://github.com/flutter/flutter/issues/81232) - disabled due to
Expand Down Expand Up @@ -506,20 +491,15 @@ TEST_F(ImageDecoderFixtureTest, DISABLED_CanResizeWithoutDecode) {
std::unique_ptr<ImageDecoder> image_decoder;

// Setup the IO manager.
runners.GetIOTaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetIOTaskRunner(), [&]() {
io_manager = std::make_unique<TestIOManager>(runners.GetIOTaskRunner());
latch.Signal();
});
latch.Wait();

// Setup the image decoder.
runners.GetUITaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetUITaskRunner(), [&]() {
image_decoder = std::make_unique<ImageDecoder>(
runners, loop->GetTaskRunner(), io_manager->GetWeakIOManager());

latch.Signal();
});
latch.Wait();

// Setup a generic decoding utility that gives us the final decoded size.
auto decoded_size = [&](uint32_t target_width,
Expand Down Expand Up @@ -549,18 +529,10 @@ TEST_F(ImageDecoderFixtureTest, DISABLED_CanResizeWithoutDecode) {
ASSERT_EQ(decoded_size(100, 100), SkISize::Make(100, 100));

// Destroy the IO manager
runners.GetIOTaskRunner()->PostTask([&]() {
io_manager.reset();
latch.Signal();
});
latch.Wait();
PostTaskSync(runners.GetIOTaskRunner(), [&]() { io_manager.reset(); });

// Destroy the image decoder
runners.GetUITaskRunner()->PostTask([&]() {
image_decoder.reset();
latch.Signal();
});
latch.Wait();
PostTaskSync(runners.GetUITaskRunner(), [&]() { image_decoder.reset(); });
}

// Verifies https://skia-review.googlesource.com/c/skia/+/259161 is present in
Expand Down Expand Up @@ -673,16 +645,13 @@ TEST_F(ImageDecoderFixtureTest,
CreateNewThread("io") // io
);

fml::AutoResetWaitableEvent latch;
fml::AutoResetWaitableEvent io_latch;
std::unique_ptr<TestIOManager> io_manager;

// Setup the IO manager.
runners.GetIOTaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetIOTaskRunner(), [&]() {
io_manager = std::make_unique<TestIOManager>(runners.GetIOTaskRunner());
latch.Signal();
});
latch.Wait();

auto isolate = RunDartCodeInIsolate(vm_ref, settings, runners, "main", {},
GetDefaultKernelFilePath(),
Expand All @@ -691,7 +660,7 @@ TEST_F(ImageDecoderFixtureTest,
// Latch the IO task runner.
runners.GetIOTaskRunner()->PostTask([&]() { io_latch.Wait(); });

runners.GetUITaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetUITaskRunner(), [&]() {
fml::AutoResetWaitableEvent isolate_latch;
fml::RefPtr<MultiFrameCodec> codec;
EXPECT_TRUE(isolate->RunInIsolateScope([&]() -> bool {
Expand All @@ -718,17 +687,10 @@ TEST_F(ImageDecoderFixtureTest,
EXPECT_FALSE(codec);

io_latch.Signal();

latch.Signal();
});
latch.Wait();

// Destroy the IO manager
runners.GetIOTaskRunner()->PostTask([&]() {
io_manager.reset();
latch.Signal();
});
latch.Wait();
PostTaskSync(runners.GetIOTaskRunner(), [&]() { io_manager.reset(); });
}

TEST_F(ImageDecoderFixtureTest, MultiFrameCodecDidAccessGpuDisabledSyncSwitch) {
Expand All @@ -752,22 +714,19 @@ TEST_F(ImageDecoderFixtureTest, MultiFrameCodecDidAccessGpuDisabledSyncSwitch) {
CreateNewThread("io") // io
);

fml::AutoResetWaitableEvent latch;
std::unique_ptr<TestIOManager> io_manager;
fml::RefPtr<MultiFrameCodec> codec;

// Setup the IO manager.
runners.GetIOTaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetIOTaskRunner(), [&]() {
io_manager = std::make_unique<TestIOManager>(runners.GetIOTaskRunner());
latch.Signal();
});
latch.Wait();

auto isolate = RunDartCodeInIsolate(vm_ref, settings, runners, "main", {},
GetDefaultKernelFilePath(),
io_manager->GetWeakIOManager());

runners.GetUITaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetUITaskRunner(), [&]() {
fml::AutoResetWaitableEvent isolate_latch;

EXPECT_TRUE(isolate->RunInIsolateScope([&]() -> bool {
Expand All @@ -790,34 +749,20 @@ TEST_F(ImageDecoderFixtureTest, MultiFrameCodecDidAccessGpuDisabledSyncSwitch) {
return true;
}));
isolate_latch.Wait();

latch.Signal();
});
latch.Wait();

runners.GetIOTaskRunner()->PostTask([&]() {
PostTaskSync(runners.GetIOTaskRunner(), [&]() {
EXPECT_TRUE(io_manager->did_access_is_gpu_disabled_sync_switch_);
latch.Signal();
});
latch.Wait();

// Destroy the Isolate
isolate = nullptr;

// Destroy the MultiFrameCodec
runners.GetUITaskRunner()->PostTask([&]() {
codec = nullptr;
latch.Signal();
});
latch.Wait();
PostTaskSync(runners.GetUITaskRunner(), [&]() { codec = nullptr; });

// Destroy the IO manager
runners.GetIOTaskRunner()->PostTask([&]() {
io_manager.reset();
latch.Signal();
});

latch.Wait();
PostTaskSync(runners.GetIOTaskRunner(), [&]() { io_manager.reset(); });
}

} // namespace testing
Expand Down
2 changes: 2 additions & 0 deletions testing/BUILD.gn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ source_set("testing_lib") {

sources = [
"assertions.h",
"post_task_sync.cc",
"post_task_sync.h",
Comment on lines +20 to +21
Copy link
Member Author

@ColdPaleLight ColdPaleLight Sep 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if this is a good place to add post_task_sync.h and post_task_sync.cc. In addition, I am not sure whether post_task_sync.h and post_task_sync.cc are good file names.
But I think we should put these helper functions in a public place like this so that other unit tests can use them directly

Copy link
Member

@gaaclarke gaaclarke Sep 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, this sounds good to me.

"testing.cc",
"testing.h",
"thread_test.cc",
Expand Down
23 changes: 23 additions & 0 deletions testing/post_task_sync.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "flutter/testing/post_task_sync.h"

#include "flutter/fml/synchronization/waitable_event.h"

namespace flutter {
namespace testing {

void PostTaskSync(fml::RefPtr<fml::TaskRunner> task_runner,
const std::function<void()>& function) {
fml::AutoResetWaitableEvent latch;
task_runner->PostTask([&] {
function();
latch.Signal();
});
latch.Wait();
}

} // namespace testing
} // namespace flutter
19 changes: 19 additions & 0 deletions testing/post_task_sync.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef FLUTTER_TESTING_POST_TASK_SYNC_H_
#define FLUTTER_TESTING_POST_TASK_SYNC_H_

#include "flutter/fml/task_runner.h"

namespace flutter {
namespace testing {

void PostTaskSync(fml::RefPtr<fml::TaskRunner> task_runner,
const std::function<void()>& function);

} // namespace testing
} // namespace flutter

#endif // FLUTTER_TESTING_POST_TASK_SYNC_H_