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 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/common/service_worker/service_worker_router_evaluator.h"
#include <limits>
#include <memory>
#include <tuple>
#include <variant>
#include "base/json/json_writer.h"
#include "base/metrics/histogram_functions.h"
#include "base/numerics/safe_conversions.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/time/time.h"
#include "base/timer/elapsed_timer.h"
#include "services/network/public/cpp/request_destination.h"
#include "services/network/public/cpp/request_mode.h"
#include "third_party/blink/public/common/service_worker/service_worker_router_rule.h"
#include "third_party/blink/public/mojom/service_worker/service_worker.mojom.h"
#include "third_party/liburlpattern/options.h"
#include "third_party/liburlpattern/pattern.h"
#include "third_party/liburlpattern/utils.h"
#include "third_party/re2/src/re2/re2.h"
namespace {
class BaseCondition;
class NotCondition;
class OrCondition;
class ConditionObject;
base::Value ConditionToValue(
const blink::ServiceWorkerRouterCondition& condition);
void RecordSetupError(ServiceWorkerRouterEvaluatorErrorEnums e) {
base::UmaHistogramEnumeration("ServiceWorker.RouterEvaluator.Error", e);
}
void RecordMatchedSourceType(
const std::vector<blink::ServiceWorkerRouterSource>& sources) {
base::UmaHistogramEnumeration(
"ServiceWorker.RouterEvaluator.MatchedFirstSourceType", sources[0].type);
}
void RecordEvaluationTime(base::TimeDelta duration) {
base::UmaHistogramMicrosecondsTimes(
"ServiceWorker.RouterEvaluator.EvaluationTime", duration);
}
// TODO(crbug.com/40241479): consolidate code with blink::url_pattern.
//
// The type and method come form
// third_party/blink/renderer/core/url_pattern/url_pattern_component.{h,cc}.
// GetOptions is not exported yet, and there is little benefit to depend
// on the blink::URLPattern now.
enum class URLPatternFieldType {
kProtocol,
kUsername,
kPassword,
kHostname,
kPort,
kPathname,
kSearch,
kHash,
};
// Utility method to get the correct liburlpattern parse options for a given
// type.
const std::tuple<liburlpattern::Options, std::string>
GetOptionsAndSegmentWildcardRegex(const blink::SafeUrlPattern& url_pattern,
URLPatternFieldType type) {
using liburlpattern::Options;
Options options = {.delimiter_list = "",
.prefix_list = "",
.sensitive = !url_pattern.options.ignore_case,
.strict = true};
if (type == URLPatternFieldType::kHostname) {
options.delimiter_list = ".";
} else if (type == URLPatternFieldType::kPathname) {
// TODO(crbug.com/40241479): follows the original GetOptions behavior.
// It sets the following delimiters for some limited protocols.
options.delimiter_list = "/";
options.prefix_list = "/";
}
std::string segment_wildcard_regex = base::StringPrintf(
"[^%s]+?",
liburlpattern::EscapeRegexpString(options.delimiter_list).c_str());
return std::tie(options, segment_wildcard_regex);
}
liburlpattern::Pattern ConvertToPattern(
const blink::SafeUrlPattern& url_pattern,
URLPatternFieldType type) {
std::vector<liburlpattern::Part> parts;
switch (type) {
case URLPatternFieldType::kProtocol:
parts = url_pattern.protocol;
break;
case URLPatternFieldType::kUsername:
parts = url_pattern.username;
break;
case URLPatternFieldType::kPassword:
parts = url_pattern.password;
break;
case URLPatternFieldType::kHostname:
parts = url_pattern.hostname;
break;
case URLPatternFieldType::kPort:
parts = url_pattern.port;
break;
case URLPatternFieldType::kPathname:
parts = url_pattern.pathname;
break;
case URLPatternFieldType::kSearch:
parts = url_pattern.search;
break;
case URLPatternFieldType::kHash:
parts = url_pattern.hash;
break;
}
auto [options, swr] = GetOptionsAndSegmentWildcardRegex(url_pattern, type);
return liburlpattern::Pattern(parts, options, swr);
}
std::string ConvertToRegex(const blink::SafeUrlPattern& url_pattern,
URLPatternFieldType type) {
auto pattern = ConvertToPattern(url_pattern, type);
std::string regex_string = pattern.GenerateRegexString();
VLOG(3) << "regex string: " << regex_string;
return regex_string;
}
std::string ConvertToPatternString(const blink::SafeUrlPattern& url_pattern,
URLPatternFieldType type) {
auto pattern = ConvertToPattern(url_pattern, type);
return pattern.GeneratePatternString();
}
base::Value RequestToValue(
const blink::ServiceWorkerRouterRequestCondition& request) {
base::Value::Dict ret;
if (request.method) {
ret.Set("method", *request.method);
}
if (request.mode) {
ret.Set("mode", network::RequestModeToString(*request.mode));
}
if (request.destination) {
ret.Set("destination",
network::RequestDestinationToString(*request.destination));
}
return base::Value(std::move(ret));
}
std::string RunningStatusToString(
const blink::ServiceWorkerRouterRunningStatusCondition& running_status) {
switch (running_status.status) {
case blink::ServiceWorkerRouterRunningStatusCondition::RunningStatusEnum::
kRunning:
return "running";
case blink::ServiceWorkerRouterRunningStatusCondition::RunningStatusEnum::
kNotRunning:
return "not-running";
}
}
base::Value OrConditionToValue(
const blink::ServiceWorkerRouterOrCondition& or_condition) {
base::Value::List ret;
ret.reserve(or_condition.conditions.size());
for (const auto& c : or_condition.conditions) {
ret.Append(ConditionToValue(c));
}
return base::Value(std::move(ret));
}
base::Value NotConditionToValue(
const blink::ServiceWorkerRouterNotCondition& not_condition) {
CHECK(not_condition.condition);
return ConditionToValue(*not_condition.condition);
}
base::Value ConditionToValue(
const blink::ServiceWorkerRouterCondition& condition) {
base::Value::Dict out_c;
const auto& [url_pattern, request, running_status, or_condition,
not_condition] = condition.get();
if (url_pattern) {
base::Value::Dict url_pattern_value;
#define TO_VALUE(type, type_name) \
do { \
auto value = ConvertToPatternString(*url_pattern, type); \
url_pattern_value.Set(type_name, value); \
} while (0)
TO_VALUE(URLPatternFieldType::kProtocol, "protocol");
TO_VALUE(URLPatternFieldType::kUsername, "username");
TO_VALUE(URLPatternFieldType::kPassword, "password");
TO_VALUE(URLPatternFieldType::kHostname, "hostname");
TO_VALUE(URLPatternFieldType::kPort, "port");
TO_VALUE(URLPatternFieldType::kPathname, "pathname");
TO_VALUE(URLPatternFieldType::kSearch, "search");
TO_VALUE(URLPatternFieldType::kHash, "hash");
#undef TO_VALUE
out_c.Set("urlPattern", std::move(url_pattern_value));
}
if (request) {
out_c.Set("request", RequestToValue(*request));
}
if (running_status) {
out_c.Set("running_status", RunningStatusToString(*running_status));
}
if (or_condition) {
out_c.Set("or", OrConditionToValue(*or_condition));
}
if (not_condition) {
out_c.Set("not", NotConditionToValue(*not_condition));
}
return base::Value(std::move(out_c));
}
bool IsValidSources(
const std::vector<blink::ServiceWorkerRouterSource>& sources) {
if (sources.empty()) {
// At least a source must exist.
RecordSetupError(ServiceWorkerRouterEvaluatorErrorEnums::kEmptySource);
return false;
}
// TODO(crbug.com/40241479): support other sources in the future.
// Currently, only network source is supported.
for (const auto& s : sources) {
switch (s.type) {
case network::mojom::ServiceWorkerRouterSourceType::kNetwork:
if (!s.network_source) {
RecordSetupError(
ServiceWorkerRouterEvaluatorErrorEnums::kInvalidSource);
return false;
}
break;
case network::mojom::ServiceWorkerRouterSourceType::
kRaceNetworkAndFetchEvent:
if (!s.race_network_and_fetch_event_source) {
RecordSetupError(
ServiceWorkerRouterEvaluatorErrorEnums::kInvalidSource);
return false;
}
break;
case network::mojom::ServiceWorkerRouterSourceType::kFetchEvent:
if (!s.fetch_event_source) {
RecordSetupError(
ServiceWorkerRouterEvaluatorErrorEnums::kInvalidSource);
return false;
}
break;
case network::mojom::ServiceWorkerRouterSourceType::kCache:
if (!s.cache_source) {
RecordSetupError(
ServiceWorkerRouterEvaluatorErrorEnums::kInvalidSource);
return false;
}
break;
case network::mojom::ServiceWorkerRouterSourceType::kRaceNetworkAndCache:
if (!s.race_network_and_cache_source) {
RecordSetupError(
ServiceWorkerRouterEvaluatorErrorEnums::kInvalidSource);
return false;
}
break;
}
}
return true;
}
[[nodiscard]] bool ExceedsMaxConditionDepth(
const blink::ServiceWorkerRouterCondition& condition,
int depth = 0) {
if (depth >= blink::kServiceWorkerRouterConditionMaxRecursionDepth) {
return true;
}
const auto& or_condition =
std::get<const std::optional<blink::ServiceWorkerRouterOrCondition>&>(
condition.get());
if (or_condition) {
for (const auto& c : or_condition->conditions) {
if (ExceedsMaxConditionDepth(c, depth + 1)) {
return true;
}
}
}
const auto& not_condition =
std::get<const std::optional<blink::ServiceWorkerRouterNotCondition>&>(
condition.get());
if (not_condition) {
CHECK(not_condition->condition);
if (ExceedsMaxConditionDepth(*not_condition->condition, depth + 1)) {
return true;
}
}
return false;
}
void UpdateMaxConditionDepthAndWidth(
const blink::ServiceWorkerRouterCondition& condition,
size_t& max_depth,
size_t& max_width,
size_t depth = 0) {
const auto& or_condition =
std::get<const std::optional<blink::ServiceWorkerRouterOrCondition>&>(
condition.get());
if (or_condition) {
max_width = std::max(max_width, or_condition->conditions.size());
for (const auto& c : or_condition->conditions) {
UpdateMaxConditionDepthAndWidth(c, max_depth, max_width, depth + 1);
}
// Or and other conditions are mutual exclusive.
return;
}
const auto& not_condition =
std::get<const std::optional<blink::ServiceWorkerRouterNotCondition>&>(
condition.get());
if (not_condition) {
CHECK(not_condition->condition);
UpdateMaxConditionDepthAndWidth(*not_condition->condition, max_depth,
max_width, depth + 1);
// Not and other conditions are mutual exclusive.
return;
}
max_depth = std::max(max_depth, depth);
}
bool MatchRequestCondition(
const blink::ServiceWorkerRouterRequestCondition& pattern,
const network::ResourceRequest& request) {
if (pattern.method && *pattern.method != request.method) {
return false;
}
if (pattern.mode && *pattern.mode != request.mode) {
return false;
}
if (pattern.destination && *pattern.destination != request.destination) {
return false;
}
return true;
}
bool MatchRunningCondition(
const blink::ServiceWorkerRouterRunningStatusCondition& condition,
const blink::EmbeddedWorkerStatus& running_status) {
// returns true if both condition matches.
bool is_condition_running = condition.status ==
blink::ServiceWorkerRouterRunningStatusCondition::
RunningStatusEnum::kRunning;
bool is_status_running =
running_status == blink::EmbeddedWorkerStatus::kRunning;
return is_condition_running == is_status_running;
}
class BaseCondition {
public:
BaseCondition() = default;
// Not copyable
BaseCondition(const BaseCondition&) = delete;
// Movable
BaseCondition(BaseCondition&&) = default;
BaseCondition& operator=(BaseCondition&&) = default;
// Returns true on success. Otherwise, false.
ServiceWorkerRouterEvaluatorErrorEnums Set(
const blink::ServiceWorkerRouterCondition& condition);
bool Match(const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const;
bool need_running_status() const { return need_running_status_; }
private:
bool MatchUrlPatternConditions(const network::ResourceRequest& request) const;
bool MatchNonUrlPatternConditions(
const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const;
std::unique_ptr<RE2> protocol_pattern_;
std::unique_ptr<RE2> username_pattern_;
std::unique_ptr<RE2> password_pattern_;
std::unique_ptr<RE2> hostname_pattern_;
std::unique_ptr<RE2> port_pattern_;
std::unique_ptr<RE2> pathname_pattern_;
std::unique_ptr<RE2> search_pattern_;
std::unique_ptr<RE2> hash_pattern_;
bool has_url_pattern_ = false;
// Non-SafeUrlPattern conditions are processed one by one.
blink::ServiceWorkerRouterCondition non_url_pattern_condition_;
bool need_running_status_ = false;
};
ServiceWorkerRouterEvaluatorErrorEnums BaseCondition::Set(
const blink::ServiceWorkerRouterCondition& condition) {
if (condition.IsEmpty()) {
// At least one condition must be set.
RecordSetupError(ServiceWorkerRouterEvaluatorErrorEnums::kEmptyCondition);
return ServiceWorkerRouterEvaluatorErrorEnums::kEmptyCondition;
}
const auto& [url_pattern, request, running_status, or_condition,
not_condition] = condition.get();
CHECK(!or_condition);
CHECK(!not_condition);
non_url_pattern_condition_ = {std::nullopt, request, running_status,
std::nullopt, std::nullopt};
if (running_status) {
need_running_status_ = true;
}
if (url_pattern) {
RE2::Options options;
options.set_case_sensitive(!url_pattern->options.ignore_case);
#define SET_PATTERN(type_name, type) \
do { \
auto regex = ConvertToRegex(*url_pattern, type); \
type_name##_pattern_ = std::make_unique<RE2>(regex, options); \
if (!type_name##_pattern_->ok()) { \
RecordSetupError(ServiceWorkerRouterEvaluatorErrorEnums::kParseError); \
return ServiceWorkerRouterEvaluatorErrorEnums::kParseError; \
} \
} while (0)
SET_PATTERN(protocol, URLPatternFieldType::kProtocol);
SET_PATTERN(username, URLPatternFieldType::kUsername);
SET_PATTERN(password, URLPatternFieldType::kPassword);
SET_PATTERN(hostname, URLPatternFieldType::kHostname);
SET_PATTERN(port, URLPatternFieldType::kPort);
SET_PATTERN(pathname, URLPatternFieldType::kPathname);
SET_PATTERN(search, URLPatternFieldType::kSearch);
SET_PATTERN(hash, URLPatternFieldType::kHash);
#undef SET_PATTERN
has_url_pattern_ = true;
// TODO(crbug.com/40241479): consider fast path on empty parts and "*".
// Currently, regular expressions are executed even for empty parts cases,
// which try to match inputs with "^$". It is also executed for "*".
// If performance to evaluate regular expressions matter, fast path can
// be needed.
}
return ServiceWorkerRouterEvaluatorErrorEnums::kNoError;
}
bool BaseCondition::Match(
const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const {
return MatchNonUrlPatternConditions(request, running_status) &&
MatchUrlPatternConditions(request);
}
bool BaseCondition::MatchUrlPatternConditions(
const network::ResourceRequest& request) const {
if (!has_url_pattern_) { // nothing need to be matched.
return true;
}
#define PATTERN_MATCH(type_name, field) \
CHECK(type_name##_pattern_); \
if (!RE2::FullMatch(request.url.field(), *type_name##_pattern_)) { \
VLOG(3) << "not matched. url=" << request.url << " field=" << #field \
<< " value=" << request.url.field(); \
return false; \
}
PATTERN_MATCH(protocol, scheme);
PATTERN_MATCH(username, username);
PATTERN_MATCH(password, password);
PATTERN_MATCH(hostname, host);
PATTERN_MATCH(port, port);
PATTERN_MATCH(pathname, path);
PATTERN_MATCH(search, query);
PATTERN_MATCH(hash, ref);
#undef PATTERN_MATCH
return true;
}
bool BaseCondition::MatchNonUrlPatternConditions(
const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const {
const auto& [url_pattern, request_pattern, running_status_pattern,
or_condition, not_condition] = non_url_pattern_condition_.get();
CHECK(!url_pattern);
CHECK(!or_condition);
CHECK(!not_condition);
if (request_pattern && !MatchRequestCondition(*request_pattern, request)) {
return false;
}
if (running_status && running_status_pattern &&
!MatchRunningCondition(*running_status_pattern, *running_status)) {
return false;
}
return true;
}
class OrCondition {
public:
OrCondition() = default;
// Not copyable
OrCondition(const OrCondition&) = delete;
// Movable
OrCondition(OrCondition&&) = default;
OrCondition& operator=(OrCondition&&) = default;
// Returns true on success. Otherwise, false.
ServiceWorkerRouterEvaluatorErrorEnums Set(
const std::vector<blink::ServiceWorkerRouterCondition>& conditions);
bool Match(const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const;
bool need_running_status() const { return need_running_status_; }
private:
bool MatchUrlPatternConditions(const network::ResourceRequest& request) const;
bool MatchNonUrlPatternConditions(
const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const;
std::vector<ConditionObject> conditions_;
bool need_running_status_ = false;
};
class NotCondition {
public:
NotCondition() = default;
// Not copyable
NotCondition(const NotCondition&) = delete;
// Movable
NotCondition(NotCondition&&) = default;
NotCondition& operator=(NotCondition&&) = default;
// Returns true on success. Otherwise, false.
ServiceWorkerRouterEvaluatorErrorEnums Set(
const std::unique_ptr<blink::ServiceWorkerRouterCondition>& condition);
bool Match(const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const;
bool need_running_status() const { return need_running_status_; }
private:
bool MatchUrlPatternConditions(const network::ResourceRequest& request) const;
bool MatchNonUrlPatternConditions(
const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const;
std::unique_ptr<ConditionObject> condition_;
bool need_running_status_ = false;
};
class ConditionObject {
public:
// Returns true on success. Otherwise, false.
ServiceWorkerRouterEvaluatorErrorEnums Set(
const blink::ServiceWorkerRouterCondition& condition) {
if (!condition.IsValid()) {
RecordSetupError(
ServiceWorkerRouterEvaluatorErrorEnums::kInvalidCondition);
return ServiceWorkerRouterEvaluatorErrorEnums::kInvalidCondition;
}
const auto& or_condition =
std::get<const std::optional<blink::ServiceWorkerRouterOrCondition>&>(
condition.get());
if (or_condition) {
OrCondition v;
auto error = v.Set(or_condition->conditions);
value_ = std::move(v);
return error;
}
const auto& not_condition =
std::get<const std::optional<blink::ServiceWorkerRouterNotCondition>&>(
condition.get());
if (not_condition) {
NotCondition v;
auto error = v.Set(not_condition->condition);
value_ = std::move(v);
return error;
}
// Neither the not condition nor the or condition.
{
BaseCondition v;
auto error = v.Set(condition);
value_ = std::move(v);
return error;
}
}
bool Match(const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const {
return std::visit(
[&request, running_status](const auto& condition) {
return condition.Match(request, running_status);
},
value_);
}
bool need_running_status() const {
return std::visit(
[](const auto& condition) { return condition.need_running_status(); },
value_);
}
private:
std::variant<BaseCondition, OrCondition, NotCondition> value_;
};
ServiceWorkerRouterEvaluatorErrorEnums OrCondition::Set(
const std::vector<blink::ServiceWorkerRouterCondition>& conditions) {
conditions_.reserve(conditions.size());
for (const auto& c : conditions) {
conditions_.emplace_back();
ConditionObject& ob = conditions_.back();
auto error = ob.Set(c);
if (error != ServiceWorkerRouterEvaluatorErrorEnums::kNoError) {
conditions_.clear();
return error;
}
need_running_status_ = need_running_status_ || ob.need_running_status();
}
return ServiceWorkerRouterEvaluatorErrorEnums::kNoError;
}
bool OrCondition::Match(
const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const {
for (const auto& c : conditions_) {
if (c.Match(request, running_status)) {
return true;
}
}
return false;
}
ServiceWorkerRouterEvaluatorErrorEnums NotCondition::Set(
const std::unique_ptr<blink::ServiceWorkerRouterCondition>& condition) {
if (!condition) {
return ServiceWorkerRouterEvaluatorErrorEnums::kEmptyCondition;
}
condition_ = std::make_unique<ConditionObject>();
auto error = condition_->Set(*condition);
if (error != ServiceWorkerRouterEvaluatorErrorEnums::kNoError) {
condition_.reset();
return error;
}
need_running_status_ = condition_->need_running_status();
return ServiceWorkerRouterEvaluatorErrorEnums::kNoError;
}
bool NotCondition::Match(
const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const {
return !condition_->Match(request, running_status);
}
} // namespace
namespace content {
class ServiceWorkerRouterEvaluator::RouterRule {
public:
ServiceWorkerRouterEvaluatorErrorEnums SetRule(
const blink::ServiceWorkerRouterRule& rule,
std::uint32_t id) {
if (ExceedsMaxConditionDepth(rule.condition)) {
// Too many recursion in the condition.
RecordSetupError(
ServiceWorkerRouterEvaluatorErrorEnums::kExceedMaxConditionDepth);
return ServiceWorkerRouterEvaluatorErrorEnums::kExceedMaxConditionDepth;
}
id_ = id;
auto error = condition_.Set(rule.condition);
if (error != ServiceWorkerRouterEvaluatorErrorEnums::kNoError) {
return error;
}
if (!SetSources(rule.sources)) {
return ServiceWorkerRouterEvaluatorErrorEnums::kInvalidSource;
}
return ServiceWorkerRouterEvaluatorErrorEnums::kNoError;
}
bool Match(const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const {
return condition_.Match(request, running_status);
}
const std::vector<blink::ServiceWorkerRouterSource>& sources() const {
return sources_;
}
// Rule ID is allocated when the router is set. ID is unique within one
// service worker registration, but may overlap among other routers of other
// registrations.
std::uint32_t id() const { return id_; }
bool need_running_status() const { return condition_.need_running_status(); }
private:
// Returns true on success. Otherwise, false.
bool SetSources(
const std::vector<blink::ServiceWorkerRouterSource>& sources) {
if (!IsValidSources(sources)) {
return false;
}
sources_ = sources;
return true;
}
ConditionObject condition_;
std::vector<blink::ServiceWorkerRouterSource> sources_;
std::uint32_t id_;
};
ServiceWorkerRouterEvaluator::Result::Result() = default;
ServiceWorkerRouterEvaluator::Result::~Result() = default;
ServiceWorkerRouterEvaluator::Result::Result(Result&&) = default;
ServiceWorkerRouterEvaluator::ServiceWorkerRouterEvaluator(
blink::ServiceWorkerRouterRules rules)
: rules_(std::move(rules)) {
Compile();
}
ServiceWorkerRouterEvaluator::~ServiceWorkerRouterEvaluator() = default;
void ServiceWorkerRouterEvaluator::Compile() {
if (rules_.rules.size() >= blink::kServiceWorkerMaxRouterSize) {
RecordSetupError(
ServiceWorkerRouterEvaluatorErrorEnums::kExceedMaxRouterSize);
invalid_error_code_ =
ServiceWorkerRouterEvaluatorErrorEnums::kExceedMaxRouterSize;
return;
}
for (size_t idx = 0; idx < rules_.rules.size(); ++idx) {
const auto& r = rules_.rules[idx];
std::unique_ptr<RouterRule> rule = std::make_unique<RouterRule>();
// For now, use index as rule ID (1-indexed)
std::uint32_t id = idx + 1;
auto error = rule->SetRule(r, id);
if (error != ServiceWorkerRouterEvaluatorErrorEnums::kNoError) {
invalid_error_code_ = error;
return;
}
need_running_status_ |= rule->need_running_status();
for (const auto& s : r.sources) {
bool has_fetch_event =
(s.type ==
network::mojom::ServiceWorkerRouterSourceType::kFetchEvent);
bool has_race_network_and_fetch_event =
(s.type == network::mojom::ServiceWorkerRouterSourceType::
kRaceNetworkAndFetchEvent);
require_fetch_handler_ |=
(has_fetch_event | has_race_network_and_fetch_event);
has_non_fetch_event_source_ |= !has_fetch_event;
}
compiled_rules_.emplace_back(std::move(rule));
}
RecordSetupError(ServiceWorkerRouterEvaluatorErrorEnums::kNoError);
is_valid_ = true;
}
std::optional<ServiceWorkerRouterEvaluator::Result>
ServiceWorkerRouterEvaluator::EvaluateInternal(
const network::ResourceRequest& request,
std::optional<blink::EmbeddedWorkerStatus> running_status) const {
CHECK(is_valid_);
base::ElapsedTimer timer;
for (const auto& rule : compiled_rules_) {
if (rule->Match(request, running_status)) {
VLOG(3) << "matched request url=" << request.url;
RecordEvaluationTime(timer.Elapsed());
RecordMatchedSourceType(rule->sources());
ServiceWorkerRouterEvaluator::Result result;
result.id = rule->id();
result.sources = rule->sources();
return result;
}
}
VLOG(3) << "not matched request url=" << request.url;
RecordEvaluationTime(timer.Elapsed());
return std::nullopt;
}
std::optional<ServiceWorkerRouterEvaluator::Result>
ServiceWorkerRouterEvaluator::Evaluate(
const network::ResourceRequest& request,
blink::EmbeddedWorkerStatus running_status) const {
return EvaluateInternal(request, running_status);
}
std::optional<ServiceWorkerRouterEvaluator::Result>
ServiceWorkerRouterEvaluator::EvaluateWithoutRunningStatus(
const network::ResourceRequest& request) const {
CHECK(!need_running_status_);
return EvaluateInternal(request, std::nullopt);
}
base::Value ServiceWorkerRouterEvaluator::ToValue() const {
base::Value::List out;
CHECK_EQ(rules_.rules.size(), compiled_rules_.size());
for (size_t idx = 0; idx < rules_.rules.size(); ++idx) {
const auto& r = rules_.rules[idx];
base::Value::Dict rule;
base::Value condition = ConditionToValue(r.condition);
base::Value::List source;
for (const auto& s : r.sources) {
switch (s.type) {
case network::mojom::ServiceWorkerRouterSourceType::kNetwork:
source.Append("network");
break;
case network::mojom::ServiceWorkerRouterSourceType::
kRaceNetworkAndFetchEvent:
source.Append("race-network-and-fetch-handler");
break;
case network::mojom::ServiceWorkerRouterSourceType::kFetchEvent:
source.Append("fetch-event");
break;
case network::mojom::ServiceWorkerRouterSourceType::kCache:
if (s.cache_source->cache_name) {
base::Value::Dict out_s;
out_s.Set("cache_name", *s.cache_source->cache_name);
source.Append(std::move(out_s));
} else {
source.Append("cache");
}
break;
case network::mojom::ServiceWorkerRouterSourceType::
kRaceNetworkAndCache:
if (s.race_network_and_cache_source->cache_source.cache_name) {
base::Value::Dict out_s;
out_s.Set(
"race_network_and_cache_cache_name",
*s.race_network_and_cache_source->cache_source.cache_name);
source.Append(std::move(out_s));
} else {
source.Append("race-network-and-cache");
}
break;
}
}
rule.Set("condition", std::move(condition));
rule.Set("source", std::move(source));
rule.Set("id", base::checked_cast<int>(compiled_rules_[idx]->id()));
out.Append(std::move(rule));
}
return base::Value(std::move(out));
}
std::string ServiceWorkerRouterEvaluator::ToString() const {
std::string json;
base::JSONWriter::Write(ToValue(), &json);
return json;
}
void ServiceWorkerRouterEvaluator::RecordRouterRuleInfo() const {
base::UmaHistogramCounts1000("ServiceWorker.RouterEvaluator.RuleCount",
compiled_rules_.size());
size_t depth, width;
std::tie(depth, width) = GetMaxDepthAndWidth();
base::UmaHistogramCounts1000("ServiceWorker.RouterEvaluator.ConditionDepth",
depth);
base::UmaHistogramCounts1000("ServiceWorker.RouterEvaluator.OrConditionWidth",
width);
}
std::tuple<size_t, size_t> ServiceWorkerRouterEvaluator::GetMaxDepthAndWidth()
const {
size_t depth = 0, width = 0;
for (const auto& r : rules_.rules) {
UpdateMaxConditionDepthAndWidth(r.condition, depth, width);
}
return {depth, width};
}
} // namespace content
|