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
|
// 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 "components/feed/core/v2/test/stream_builder.h"
#include <utility>
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "components/feed/core/proto/v2/store.pb.h"
#include "components/feed/core/proto/v2/wire/eventid.pb.h"
#include "components/feed/core/proto/v2/wire/web_feeds.pb.h"
#include "components/feed/core/v2/feedstore_util.h"
#include "components/feed/core/v2/proto_util.h"
#include "components/feed/core/v2/protocol_translator.h"
#include "google_apis/gaia/gaia_id.h"
namespace feed {
namespace {
void AddContentHashes(const feedstore::Content& content,
feedstore::StreamData& stream_data) {
for (auto& metadata : content.prefetch_metadata()) {
stream_data.add_content_hashes()->add_hashes(
feedstore::ContentHashFromPrefetchMetadata(metadata));
}
}
} // namespace
base::Time kTestTimeEpoch = base::Time::UnixEpoch();
AccountInfo TestAccountInfo() {
return {GaiaId("gaia"), "user@foo"};
}
ContentId MakeContentId(ContentId::Type type,
std::string content_domain,
int id_number) {
ContentId id;
id.set_content_domain(std::move(content_domain));
id.set_type(type);
id.set_id(id_number);
return id;
}
ContentId MakeClusterId(int id_number) {
return MakeContentId(ContentId::CLUSTER, "content", id_number);
}
ContentId MakeContentContentId(int id_number) {
return MakeContentId(ContentId::FEATURE, "stories", id_number);
}
ContentId MakeNoticeCardContentContentId(int id_number) {
return MakeContentId(ContentId::FEATURE, "privacynoticecard.f", id_number);
}
ContentId MakeSharedStateContentId(int id_number) {
return MakeContentId(ContentId::TYPE_UNDEFINED, "shared", id_number);
}
ContentId MakeRootId(int id_number) {
return MakeContentId(ContentId::TYPE_UNDEFINED, "root", id_number);
}
std::string MakeRootEventId(int id_number) {
feedwire::EventIdMessage id;
id.set_time_usec(id_number);
return id.SerializeAsString();
}
ContentId MakeSharedStateId(int id_number) {
return MakeContentId(ContentId::TYPE_UNDEFINED, "render_data", id_number);
}
feedstore::StreamStructure MakeStream(int id_number) {
feedstore::StreamStructure result;
result.set_type(feedstore::StreamStructure::STREAM);
result.set_operation(feedstore::StreamStructure::UPDATE_OR_APPEND);
result.set_is_root(true);
*result.mutable_content_id() = MakeRootId(id_number);
return result;
}
feedstore::StreamStructure MakeCluster(int id_number, ContentId parent) {
feedstore::StreamStructure result;
result.set_type(feedstore::StreamStructure::GROUP);
result.set_operation(feedstore::StreamStructure::UPDATE_OR_APPEND);
*result.mutable_content_id() = MakeClusterId(id_number);
*result.mutable_parent_id() = parent;
return result;
}
feedstore::StreamStructure MakeNoticeCardCluster(int id_number,
ContentId parent) {
feedstore::StreamStructure result;
result.set_type(feedstore::StreamStructure::GROUP);
result.set_operation(feedstore::StreamStructure::UPDATE_OR_APPEND);
*result.mutable_content_id() = MakeClusterId(id_number);
*result.mutable_parent_id() = parent;
return result;
}
feedstore::StreamStructure MakeContentNode(int id_number, ContentId parent) {
feedstore::StreamStructure result;
result.set_type(feedstore::StreamStructure::CONTENT);
result.set_operation(feedstore::StreamStructure::UPDATE_OR_APPEND);
*result.mutable_content_id() = MakeContentContentId(id_number);
*result.mutable_parent_id() = parent;
return result;
}
feedstore::StreamStructure MakeNoticeCardContentNode(int id_number,
ContentId parent) {
feedstore::StreamStructure result;
result.set_type(feedstore::StreamStructure::CONTENT);
result.set_operation(feedstore::StreamStructure::UPDATE_OR_APPEND);
*result.mutable_content_id() = MakeNoticeCardContentContentId(id_number);
*result.mutable_parent_id() = parent;
return result;
}
feedstore::StreamStructure MakeRemove(ContentId id) {
feedstore::StreamStructure result;
result.set_operation(feedstore::StreamStructure::REMOVE);
*result.mutable_content_id() = id;
return result;
}
feedstore::StreamStructure MakeClearAll() {
feedstore::StreamStructure result;
result.set_operation(feedstore::StreamStructure::CLEAR_ALL);
return result;
}
feedstore::StreamSharedState MakeSharedState(int id_number) {
feedstore::StreamSharedState shared_state;
*shared_state.mutable_content_id() = MakeSharedStateId(id_number);
shared_state.set_shared_state_data("ss:" + base::NumberToString(id_number));
return shared_state;
}
feedstore::Content MakeContent(int id_number) {
feedstore::Content result;
*result.mutable_content_id() = MakeContentContentId(id_number);
result.set_frame("f:" + base::NumberToString(id_number));
feedwire::PrefetchMetadata& prefetch_metadata =
*result.add_prefetch_metadata();
std::string suffix = base::NumberToString(id_number);
prefetch_metadata.set_uri("http://content" + suffix);
prefetch_metadata.set_title("title" + suffix);
prefetch_metadata.set_publisher("publisher" + suffix);
prefetch_metadata.set_snippet("snippet" + suffix);
prefetch_metadata.set_image_url("http://image" + suffix);
prefetch_metadata.set_favicon_url("http://favicon" + suffix);
prefetch_metadata.set_badge_id("app/badge" + suffix);
return result;
}
feedstore::Content MakeNoticeCardContent(int id_number) {
feedstore::Content result;
*result.mutable_content_id() = MakeNoticeCardContentContentId(id_number);
result.set_frame("f:" + base::NumberToString(0));
return result;
}
feedstore::DataOperation MakeOperation(feedstore::StreamStructure structure) {
feedstore::DataOperation operation;
*operation.mutable_structure() = std::move(structure);
return operation;
}
feedstore::DataOperation MakeOperation(feedstore::Content content) {
feedstore::DataOperation operation;
*operation.mutable_content() = std::move(content);
return operation;
}
feedstore::Record MakeRecord(feedstore::Content content) {
feedstore::Record record;
*record.mutable_content() = std::move(content);
return record;
}
feedstore::Record MakeRecord(
feedstore::StreamStructureSet stream_structure_set) {
feedstore::Record record;
*record.mutable_stream_structures() = std::move(stream_structure_set);
return record;
}
feedstore::Record MakeRecord(feedstore::StreamSharedState shared_state) {
feedstore::Record record;
*record.mutable_shared_state() = std::move(shared_state);
return record;
}
feedstore::Record MakeRecord(feedstore::StreamData stream_data) {
feedstore::Record record;
*record.mutable_stream_data() = std::move(stream_data);
return record;
}
std::vector<feedstore::DataOperation> MakeTypicalStreamOperations() {
return {
MakeOperation(MakeStream()),
MakeOperation(MakeCluster(0, MakeRootId())),
MakeOperation(MakeContentNode(0, MakeClusterId(0))),
MakeOperation(MakeContent(0)),
MakeOperation(MakeCluster(1, MakeRootId())),
MakeOperation(MakeContentNode(1, MakeClusterId(1))),
MakeOperation(MakeContent(1)),
};
}
StreamModelUpdateRequestGenerator::StreamModelUpdateRequestGenerator() =
default;
StreamModelUpdateRequestGenerator::~StreamModelUpdateRequestGenerator() =
default;
std::unique_ptr<StreamModelUpdateRequest>
StreamModelUpdateRequestGenerator::MakeFirstPage(int first_cluster_id,
int num_cards) const {
std::vector<int> id_numbers;
for (int i = first_cluster_id; i < first_cluster_id + num_cards; ++i) {
id_numbers.push_back(i);
}
return MakeFirstPageWithSpecificContents(id_numbers);
}
std::unique_ptr<StreamModelUpdateRequest>
StreamModelUpdateRequestGenerator::MakeFirstPageWithSpecificContents(
const std::vector<int>& id_numbers) const {
auto initial_update = std::make_unique<StreamModelUpdateRequest>();
initial_update->source =
StreamModelUpdateRequest::Source::kInitialLoadFromStore;
initial_update->stream_structures = {MakeClearAll(), MakeStream()};
if (!id_numbers.empty()) {
int first_cluster_id = id_numbers.front();
bool include_notice_card =
(privacy_notice_fulfilled && first_cluster_id == 0);
for (const auto i : id_numbers) {
if (include_notice_card && i == first_cluster_id) {
initial_update->content.push_back(MakeNoticeCardContent(i));
initial_update->stream_structures.push_back(
MakeNoticeCardCluster(i, MakeRootId()));
initial_update->stream_structures.push_back(
MakeNoticeCardContentNode(i, MakeClusterId(i)));
} else {
initial_update->content.push_back(MakeContent(i));
initial_update->stream_structures.push_back(
MakeCluster(i, MakeRootId()));
initial_update->stream_structures.push_back(
MakeContentNode(i, MakeClusterId(i)));
}
}
initial_update->shared_states.push_back(MakeSharedState(first_cluster_id));
*initial_update->stream_data.add_shared_state_ids() =
MakeSharedStateId(first_cluster_id);
}
*initial_update->stream_data.mutable_content_id() = MakeRootId();
initial_update->stream_data.set_root_event_id(
MakeRootEventId(event_id_number));
initial_update->stream_data.set_next_page_token("page-2");
initial_update->stream_data.set_signed_in(signed_in);
if (signed_in) {
initial_update->stream_data.set_email(account_info.email);
initial_update->stream_data.set_gaia(account_info.gaia.ToString());
}
initial_update->stream_data.set_logging_enabled(logging_enabled);
initial_update->stream_data.set_privacy_notice_fulfilled(
privacy_notice_fulfilled);
initial_update->stream_data.set_stream_key(stream_key);
for (size_t i = 0; i < id_numbers.size(); ++i) {
AddContentHashes(initial_update->content[i], initial_update->stream_data);
}
feedstore::SetLastAddedTime(last_added_time, initial_update->stream_data);
return initial_update;
}
std::unique_ptr<StreamModelUpdateRequest>
StreamModelUpdateRequestGenerator::MakeNextPage(
int page_number,
StreamModelUpdateRequest::Source source) const {
auto initial_update = std::make_unique<StreamModelUpdateRequest>();
initial_update->source = source;
// Each page has two pieces of content, get their indices.
const int i = 2 * page_number - 2;
const int j = i + 1;
initial_update->content.push_back(MakeContent(i));
initial_update->content.push_back(MakeContent(j));
initial_update->stream_structures = {
MakeStream(), MakeCluster(i, MakeRootId()),
MakeContentNode(i, MakeClusterId(i)), MakeCluster(j, MakeRootId()),
MakeContentNode(j, MakeClusterId(j))};
initial_update->shared_states.push_back(MakeSharedState(page_number));
*initial_update->stream_data.mutable_content_id() = MakeRootId();
// This is a different event ID than the first page.
initial_update->stream_data.set_root_event_id(
MakeRootEventId(1000 + page_number));
*initial_update->stream_data.add_shared_state_ids() =
MakeSharedStateId(page_number);
initial_update->stream_data.set_next_page_token(
"page-" + base::NumberToString(page_number + 1));
initial_update->stream_data.set_signed_in(signed_in);
if (signed_in) {
initial_update->stream_data.set_email(account_info.email);
initial_update->stream_data.set_gaia(account_info.gaia.ToString());
}
initial_update->stream_data.set_logging_enabled(logging_enabled);
initial_update->stream_data.set_privacy_notice_fulfilled(
privacy_notice_fulfilled);
AddContentHashes(MakeContent(i), initial_update->stream_data);
AddContentHashes(MakeContent(j), initial_update->stream_data);
feedstore::SetLastAddedTime(last_added_time, initial_update->stream_data);
return initial_update;
}
std::unique_ptr<StreamModelUpdateRequest> MakeEmptyModelState() {
StreamModelUpdateRequestGenerator generator;
generator.last_added_time = kTestTimeEpoch;
generator.signed_in = true;
generator.logging_enabled = true;
generator.privacy_notice_fulfilled = false;
generator.stream_key = feedstore::StreamKey(StreamType(StreamKind::kForYou));
return generator.MakeFirstPage(/*first_cluster_id=*/0, /*num_cards=*/0);
}
std::unique_ptr<StreamModelUpdateRequest> MakeTypicalInitialModelState(
int first_cluster_id,
base::Time last_added_time,
bool signed_in,
bool logging_enabled,
bool privacy_notice_fulfilled,
std::string stream_key) {
StreamModelUpdateRequestGenerator generator;
generator.last_added_time = last_added_time;
generator.signed_in = signed_in;
generator.logging_enabled = logging_enabled;
generator.privacy_notice_fulfilled = privacy_notice_fulfilled;
generator.stream_key = stream_key;
return generator.MakeFirstPage(first_cluster_id);
}
std::unique_ptr<StreamModelUpdateRequest> MakeTypicalRefreshModelState(
int first_cluster_id,
base::Time last_added_time,
bool signed_in,
bool logging_enabled) {
StreamModelUpdateRequestGenerator generator;
generator.last_added_time = last_added_time;
generator.signed_in = signed_in;
generator.logging_enabled = logging_enabled;
generator.privacy_notice_fulfilled = false;
generator.event_id_number = 456; // Refreshes will have a new event id.
return generator.MakeFirstPage(first_cluster_id, /*num_cards=*/3);
}
std::unique_ptr<StreamModelUpdateRequest> MakeTypicalNextPageState(
int page_number,
base::Time last_added_time,
bool signed_in,
bool logging_enabled,
bool privacy_notice_fulfilled,
StreamModelUpdateRequest::Source source) {
StreamModelUpdateRequestGenerator generator;
generator.last_added_time = last_added_time;
generator.signed_in = signed_in;
generator.logging_enabled = logging_enabled;
generator.privacy_notice_fulfilled = privacy_notice_fulfilled;
return generator.MakeNextPage(page_number, source);
}
feedstore::WebFeedInfo MakeWebFeedInfo(const std::string& name) {
feedstore::WebFeedInfo result;
result.set_web_feed_id("id_" + name);
result.set_title("Title " + name);
result.mutable_favicon()->set_url("http://favicon/" + name);
result.set_follower_count(123);
result.set_visit_uri("https://" + name + ".com");
feedwire::webfeed::WebFeedMatcher* matcher = result.add_matchers();
feedwire::webfeed::WebFeedMatcher::Criteria* criteria =
matcher->add_criteria();
criteria->set_criteria_type(
feedwire::webfeed::WebFeedMatcher::Criteria::PAGE_URL_HOST_SUFFIX);
criteria->set_text(name + ".com");
return result;
}
feedwire::webfeed::WebFeed MakeWireWebFeed(const std::string& name) {
feedwire::webfeed::WebFeed result;
result.set_name("id_" + name);
result.set_title("Title " + name);
result.set_subtitle("Subtitle " + name);
result.set_detail_text("details...");
result.set_visit_uri("https://" + name + ".com");
result.set_follower_count(kFollowerCount);
*result.add_web_feed_matchers() = MakeDomainMatcher(name + ".com");
return result;
}
feedwire::webfeed::FollowWebFeedResponse SuccessfulFollowResponse(
const std::string& follow_name) {
feedwire::webfeed::FollowWebFeedResponse response;
*response.mutable_web_feed() = MakeWireWebFeed(follow_name);
SetConsistencyToken(response, "follow-ct");
return response;
}
feedwire::webfeed::UnfollowWebFeedResponse SuccessfulUnfollowResponse() {
feedwire::webfeed::UnfollowWebFeedResponse response;
SetConsistencyToken(response, "unfollow-ct");
return response;
}
feedwire::webfeed::QueryWebFeedResponse SuccessfulQueryResponse(
const std::string& query_name) {
feedwire::webfeed::QueryWebFeedResponse response;
*response.mutable_web_feed() = MakeWireWebFeed(query_name);
SetConsistencyToken(response, "query-ct");
return response;
}
WebFeedPageInformation MakeWebFeedPageInformation(const std::string& url) {
WebFeedPageInformation info;
info.SetUrl(GURL(url));
return info;
}
feedwire::webfeed::WebFeedMatcher MakeDomainMatcher(const std::string& domain) {
feedwire::webfeed::WebFeedMatcher result;
feedwire::webfeed::WebFeedMatcher::Criteria* criteria = result.add_criteria();
criteria->set_criteria_type(
feedwire::webfeed::WebFeedMatcher::Criteria::PAGE_URL_HOST_SUFFIX);
criteria->set_text(domain);
return result;
}
} // namespace feed
|