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
|
// 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.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/390223051): Remove C-library calls to fix the errors.
#pragma allow_unsafe_libc_calls
#endif
#include "components/paint_preview/common/serialized_recording.h"
#include <optional>
#include "base/files/file.h"
#include "base/files/file_path.h"
#include "base/files/scoped_temp_dir.h"
#include "base/test/task_environment.h"
#include "base/threading/thread_restrictions.h"
#include "base/unguessable_token.h"
#include "components/paint_preview/common/capture_result.h"
#include "components/paint_preview/common/paint_preview_tracker.h"
#include "components/paint_preview/common/proto/paint_preview.pb.h"
#include "components/paint_preview/common/recording_map.h"
#include "components/paint_preview/common/serial_utils.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "third_party/skia/include/core/SkCanvas.h"
#include "third_party/skia/include/core/SkColor.h"
#include "third_party/skia/include/core/SkImage.h"
#include "third_party/skia/include/core/SkImageInfo.h"
#include "third_party/skia/include/core/SkMatrix.h"
#include "third_party/skia/include/core/SkPaint.h"
#include "third_party/skia/include/core/SkPicture.h"
#include "third_party/skia/include/core/SkPictureRecorder.h"
#include "third_party/skia/include/core/SkRect.h"
#include "third_party/skia/include/core/SkRefCnt.h"
#include "third_party/skia/include/core/SkSurfaceProps.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/geometry/size.h"
namespace paint_preview {
namespace {
// Paint a picture that is gray and contains placeholder images for each of the
// subframes.
//
// |expected_deserialization_context| will contain a map that pre-associates the
// subframe guids with their skia unique ID.
sk_sp<const SkPicture> PaintGrayPictureWithSubframes(
gfx::Size bounds,
PictureSerializationContext* context,
DeserializationContext* expected_deserialization_context,
base::flat_map<base::UnguessableToken, gfx::RectF> subframes) {
SkRect sk_bounds = SkRect::MakeWH(bounds.width(), bounds.height());
SkPictureRecorder recorder;
SkCanvas* canvas = recorder.beginRecording(sk_bounds);
SkPaint paint;
paint.setStyle(SkPaint::kFill_Style);
paint.setColor(SK_ColorDKGRAY);
canvas->drawRect(sk_bounds, paint);
for (const auto& subframe : subframes) {
const base::UnguessableToken& subframe_id = subframe.first;
gfx::RectF clip_rect = subframe.second;
SkRect rect = SkRect::MakeXYWH(clip_rect.x(), clip_rect.y(),
clip_rect.width(), clip_rect.height());
sk_sp<SkPicture> temp = SkPicture::MakePlaceholder(rect);
expected_deserialization_context->insert({temp->uniqueID(), clip_rect});
context->content_id_to_embedding_token.insert(
{temp->uniqueID(), subframe_id});
context->content_id_to_transformed_clip.insert({temp->uniqueID(), rect});
canvas->drawPicture(temp.get());
}
return recorder.finishRecordingAsPicture();
}
sk_sp<const SkPicture> PaintPictureSingleGrayPixel() {
PictureSerializationContext context;
DeserializationContext expected_deserialization_context;
return PaintGrayPictureWithSubframes(gfx::Size(1, 1), &context,
&expected_deserialization_context, {});
}
sk_sp<const SkPicture> PaintPictureLargeImage(gfx::Size bounds) {
SkBitmap bitmap;
{
bitmap.allocPixels(
SkImageInfo::MakeN32Premul(bounds.width(), bounds.height()));
SkCanvas canvas(bitmap, SkSurfaceProps{});
canvas.drawColor(SK_ColorDKGRAY);
}
SkRect sk_bounds = SkRect::MakeWH(bounds.width(), bounds.height());
SkPictureRecorder recorder;
SkCanvas* canvas = recorder.beginRecording(sk_bounds);
SkPaint paint;
paint.setStyle(SkPaint::kFill_Style);
paint.setColor(SK_ColorRED);
canvas->drawRect(sk_bounds, paint);
canvas->drawImage(SkImages::RasterFromBitmap(bitmap), 0, 0);
return recorder.finishRecordingAsPicture();
}
SkBitmap CreateBitmapFromPicture(const SkPicture* pic) {
SkRect cull_rect = pic->cullRect();
SkBitmap bitmap;
bitmap.allocPixels(
SkImageInfo::MakeN32Premul(cull_rect.width(), cull_rect.height()));
SkCanvas canvas(bitmap, SkSurfaceProps{});
SkMatrix matrix;
matrix.setScaleTranslate(1, 1, -cull_rect.x(), -cull_rect.y());
canvas.drawPicture(pic, &matrix, nullptr);
return bitmap;
}
void ExpectPicturesEqual(sk_sp<const SkPicture> pic,
sk_sp<const SkPicture> expected) {
// Should not be the same pointer.
EXPECT_NE(pic, expected);
SkBitmap bitmap = CreateBitmapFromPicture(pic.get());
SkBitmap expected_bitmap = CreateBitmapFromPicture(expected.get());
EXPECT_EQ(bitmap.width(), expected_bitmap.width());
EXPECT_EQ(bitmap.height(), expected_bitmap.height());
EXPECT_EQ(bitmap.bytesPerPixel(), expected_bitmap.bytesPerPixel());
// Assert that all the bytes of the backing memory are equal. This check is
// only safe if all of the width, height and bytesPerPixel are equal between
// the two bitmaps.
EXPECT_EQ(memcmp(bitmap.getPixels(), expected_bitmap.getPixels(),
expected_bitmap.bytesPerPixel() * expected_bitmap.width() *
expected_bitmap.height()),
0);
}
} // namespace
class PaintPreviewSerializedRecordingTest : public testing::Test {
public:
PaintPreviewSerializedRecordingTest() = default;
~PaintPreviewSerializedRecordingTest() override = default;
protected:
base::test::TaskEnvironment task_environment_;
};
TEST_F(PaintPreviewSerializedRecordingTest, RoundtripWithFileBacking) {
base::ScopedAllowBlockingForTesting scoped_blocking;
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
sk_sp<const SkPicture> pic = PaintPictureSingleGrayPixel();
base::FilePath path = temp_dir.GetPath().AppendASCII("root.skp");
PaintPreviewTracker tracker(base::UnguessableToken::Create(), std::nullopt,
/*is_main_frame=*/true);
size_t serialized_size = 0;
ASSERT_TRUE(RecordToFile(
base::File(path, base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE),
pic, &tracker, std::nullopt, &serialized_size));
ASSERT_GE(serialized_size, 0u);
SerializedRecording recording(path);
ASSERT_TRUE(recording.IsValid());
std::optional<SkpResult> result = std::move(recording).Deserialize();
ASSERT_TRUE(result.has_value());
ASSERT_TRUE(result->ctx.empty());
ExpectPicturesEqual(result->skp, pic);
}
TEST_F(PaintPreviewSerializedRecordingTest, RoundtripWithMemoryBufferBacking) {
sk_sp<const SkPicture> pic = PaintPictureSingleGrayPixel();
PaintPreviewTracker tracker(base::UnguessableToken::Create(), std::nullopt,
/*is_main_frame=*/true);
size_t serialized_size = 0;
std::optional<mojo_base::BigBuffer> buffer =
RecordToBuffer(pic, &tracker, std::nullopt, &serialized_size);
ASSERT_GE(serialized_size, 0u);
ASSERT_TRUE(buffer.has_value());
SerializedRecording recording =
SerializedRecording(std::move(buffer.value()));
ASSERT_TRUE(recording.IsValid());
std::optional<SkpResult> result = std::move(recording).Deserialize();
ASSERT_TRUE(result.has_value());
ASSERT_TRUE(result->ctx.empty());
ExpectPicturesEqual(result->skp, pic);
}
TEST_F(PaintPreviewSerializedRecordingTest, ImageDiscardingTolerated) {
sk_sp<const SkPicture> pic = PaintPictureLargeImage(gfx::Size(200, 200));
PaintPreviewTracker tracker(base::UnguessableToken::Create(), std::nullopt,
/*is_main_frame=*/true);
auto* image_context = tracker.GetImageSerializationContext();
image_context->remaining_image_size = 200;
image_context->max_decoded_image_size_bytes = 300 * 300 * 4;
size_t serialized_size = 0;
std::optional<mojo_base::BigBuffer> buffer =
RecordToBuffer(pic, &tracker, std::nullopt, &serialized_size);
ASSERT_GE(serialized_size, 0u);
ASSERT_TRUE(buffer.has_value());
ASSERT_TRUE(image_context->memory_budget_exceeded);
SerializedRecording recording =
SerializedRecording(std::move(buffer.value()));
ASSERT_TRUE(recording.IsValid());
}
TEST_F(PaintPreviewSerializedRecordingTest, ImageDiscardingNotTolerated) {
sk_sp<const SkPicture> pic = PaintPictureLargeImage(gfx::Size(200, 200));
PaintPreviewTracker tracker(base::UnguessableToken::Create(), std::nullopt,
/*is_main_frame=*/true);
auto* image_context = tracker.GetImageSerializationContext();
image_context->remaining_image_size = 200;
size_t serialized_size = 0;
std::optional<mojo_base::BigBuffer> buffer =
RecordToBuffer(pic, &tracker, std::nullopt, &serialized_size);
ASSERT_FALSE(buffer.has_value());
ASSERT_EQ(serialized_size, 0U);
ASSERT_TRUE(image_context->memory_budget_exceeded);
}
TEST_F(PaintPreviewSerializedRecordingTest, InvalidBacking) {
SerializedRecording recording;
ASSERT_FALSE(recording.IsValid());
}
TEST_F(PaintPreviewSerializedRecordingTest, RoundtripHasEmbeddedContent) {
base::ScopedAllowBlockingForTesting scoped_blocking;
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
base::FilePath path = temp_dir.GetPath().AppendASCII("root.skp");
PaintPreviewTracker tracker(base::UnguessableToken::Create(), std::nullopt,
/*is_main_frame=*/true);
base::UnguessableToken subframe0 = base::UnguessableToken::Create();
gfx::RectF subframe0_rect(5, 10, 10, 15);
base::UnguessableToken subframe1 = base::UnguessableToken::Create();
gfx::RectF subframe1_rect(5, 10, 10, 15);
DeserializationContext expected;
sk_sp<const SkPicture> pic = PaintGrayPictureWithSubframes(
gfx::Size(25, 25), tracker.GetPictureSerializationContext(), &expected,
{{subframe0, subframe0_rect}, {subframe1, subframe1_rect}});
size_t serialized_size = 0;
ASSERT_TRUE(RecordToFile(
base::File(path, base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE),
pic, &tracker, std::nullopt, &serialized_size));
ASSERT_GE(serialized_size, 0u);
SerializedRecording recording(path);
ASSERT_TRUE(recording.IsValid());
std::optional<SkpResult> result = std::move(recording).Deserialize();
ASSERT_TRUE(result.has_value());
EXPECT_FALSE(result->ctx.empty());
EXPECT_EQ(result->ctx, expected);
ExpectPicturesEqual(result->skp, pic);
}
TEST_F(PaintPreviewSerializedRecordingTest,
RecordingMapFromCaptureResultSingleFrame) {
sk_sp<const SkPicture> pic = PaintPictureSingleGrayPixel();
const base::UnguessableToken root_frame_guid =
base::UnguessableToken::Create();
PaintPreviewTracker tracker(base::UnguessableToken::Create(), std::nullopt,
/*is_main_frame=*/true);
size_t serialized_size = 0;
std::optional<mojo_base::BigBuffer> buffer =
RecordToBuffer(pic, &tracker, std::nullopt, &serialized_size);
ASSERT_GE(serialized_size, 0u);
ASSERT_TRUE(buffer.has_value());
CaptureResult capture_result(RecordingPersistence::kMemoryBuffer);
capture_result.capture_success = true;
capture_result.serialized_skps.insert(
{root_frame_guid, std::move(buffer.value())});
std::pair<RecordingMap, PaintPreviewProto> pair =
RecordingMapFromCaptureResult(std::move(capture_result));
RecordingMap recording_map = std::move(pair.first);
EXPECT_FALSE(recording_map.empty());
ASSERT_NE(recording_map.find(root_frame_guid), recording_map.end());
std::optional<SkpResult> result =
std::move(recording_map.at(root_frame_guid)).Deserialize();
ASSERT_TRUE(result.has_value());
ExpectPicturesEqual(result->skp, pic);
}
TEST_F(PaintPreviewSerializedRecordingTest,
RecordingMapFromPaintPreviewProtoSingleFrame) {
base::ScopedAllowBlockingForTesting scoped_blocking;
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
base::FilePath root_path = temp_dir.GetPath().AppendASCII("root.skp");
sk_sp<const SkPicture> pic = PaintPictureSingleGrayPixel();
const base::UnguessableToken root_frame_guid =
base::UnguessableToken::Create();
PaintPreviewTracker tracker(base::UnguessableToken::Create(), std::nullopt,
/*is_main_frame=*/true);
size_t serialized_size = 0;
ASSERT_TRUE(RecordToFile(
base::File(root_path,
base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE),
pic, &tracker, std::nullopt, &serialized_size));
ASSERT_GE(serialized_size, 0u);
PaintPreviewProto proto;
PaintPreviewFrameProto* root_frame = proto.mutable_root_frame();
root_frame->set_embedding_token_high(
root_frame_guid.GetHighForSerialization());
root_frame->set_embedding_token_low(root_frame_guid.GetLowForSerialization());
root_frame->set_is_main_frame(true);
root_frame->set_file_path(root_path.MaybeAsASCII());
RecordingMap recording_map = RecordingMapFromPaintPreviewProto(proto);
EXPECT_FALSE(recording_map.empty());
ASSERT_NE(recording_map.find(root_frame_guid), recording_map.end());
std::optional<SkpResult> result =
std::move(recording_map.at(root_frame_guid)).Deserialize();
ASSERT_TRUE(result.has_value());
ExpectPicturesEqual(result->skp, pic);
}
} // namespace paint_preview
|
