File: whats_new_registry.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (296 lines) | stat: -rw-r--r-- 10,085 bytes parent folder | download | duplicates (6)
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
// 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 "components/user_education/webui/whats_new_registry.h"

#include "base/containers/contains.h"
#include "base/metrics/field_trial_params.h"
#include "base/values.h"
#include "ui/webui/resources/js/browser_command/browser_command.mojom.h"

namespace whats_new {
namespace {
constexpr int kRequestEntropyLimit = 15;
}  // namespace

using BrowserCommand = browser_command::mojom::Command;

bool WhatsNewModule::HasFeature() const {
  return feature_ != nullptr;
}

bool WhatsNewModule::HasActiveFeature() const {
  if (!HasFeature()) {
    return false;
  }
  return base::FeatureList::IsEnabled(*feature_) &&
         feature_->default_state == base::FEATURE_DISABLED_BY_DEFAULT;
}

bool WhatsNewModule::HasRolledFeature() const {
  if (!HasFeature()) {
    return false;
  }
  return feature_->default_state == base::FEATURE_ENABLED_BY_DEFAULT;
}

bool WhatsNewModule::IsFeatureEnabled() const {
  CHECK(HasFeature());
  return base::FeatureList::IsEnabled(*feature_);
}

const char* WhatsNewModule::GetFeatureName() const {
  CHECK(feature_);
  return feature_->name;
}

const std::string WhatsNewModule::GetCustomization() const {
  if (!feature_) {
    return "";
  }
  std::string customization = base::GetFieldTrialParamValueByFeature(
      *feature_, whats_new::kCustomizationParam);
  return customization;
}

WhatsNewEdition::WhatsNewEdition(const base::Feature& feature,
                                 std::string owner,
                                 std::vector<BrowserCommand> browser_commands)
    : feature_(feature),
      unique_name_(feature.name),
      browser_commands_(browser_commands) {}

WhatsNewEdition::WhatsNewEdition(WhatsNewEdition&& other) = default;
WhatsNewEdition::~WhatsNewEdition() = default;

bool WhatsNewEdition::IsFeatureEnabled() const {
  return base::FeatureList::IsEnabled(*feature_);
}

const char* WhatsNewEdition::GetFeatureName() const {
  return feature_->name;
}

const std::string WhatsNewEdition::GetCustomization() const {
  std::string customization = base::GetFieldTrialParamValueByFeature(
      *feature_, whats_new::kCustomizationParam);
  return customization;
}

const std::optional<std::string> WhatsNewEdition::GetSurvey() const {
  std::string survey = base::GetFieldTrialParamValueByFeature(
      *feature_, whats_new::kSurveyParam);
  if (survey.empty()) {
    return std::nullopt;
  }
  return survey;
}

void WhatsNewRegistry::RegisterModule(WhatsNewModule module) {
  CHECK(!modules_.contains(module.unique_name()));
  if (module.HasFeature() && module.IsFeatureEnabled()) {
    storage_service_->SetModuleEnabled(module.GetFeatureName());
  }
  modules_.emplace(module.unique_name(), std::move(module));
}

void WhatsNewRegistry::RegisterEdition(WhatsNewEdition edition) {
  CHECK(!editions_.contains(edition.unique_name()));
  editions_.emplace(edition.unique_name(), std::move(edition));
}

const std::vector<BrowserCommand> WhatsNewRegistry::GetActiveCommands() const {
  std::vector<BrowserCommand> commands;
  for (const auto& [key, module] : modules_) {
    if (module.browser_command().has_value()) {
      // Modules without a feature are default-enabled.
      const bool module_is_default_enabled = !module.HasFeature();
      // If the module is tied to a feature, ensure the feature is available.
      const bool module_is_available =
          module.HasActiveFeature() || module.HasRolledFeature();
      if (module_is_default_enabled || module_is_available) {
        commands.emplace_back(module.browser_command().value());
      }
    }
  }
  for (const auto& [key, edition] : editions_) {
    // The only requirement for an edition to show is that it is enabled.
    if (edition.IsFeatureEnabled()) {
      for (const auto browser_command : edition.browser_commands()) {
        commands.emplace_back(browser_command);
      }
    }
  }
  return commands;
}

const std::vector<std::string_view> WhatsNewRegistry::GetActiveFeatureNames()
    const {
  std::vector<std::string_view> feature_names;

  // Check if the current version is used for an edition.
  const auto current_edition_name =
      storage_service_->FindEditionForCurrentVersion();
  if (current_edition_name.has_value()) {
    // An edition is tied to this milestone. Request this edition again.
    feature_names.emplace_back(*current_edition_name);
  } else if (!storage_service_->WasVersionPageUsedForCurrentMilestone()) {
    // Only request other unused editions if no other page was shown
    // during this milestone (version page or other edition page).
    for (const auto& [key, edition] : editions_) {
      if (edition.IsFeatureEnabled() &&
          feature_names.size() < kRequestEntropyLimit &&
          !storage_service_->IsUsedEdition(edition.GetFeatureName())) {
        feature_names.emplace_back(edition.GetFeatureName());
      }
    }
  }

  // Add modules based on ordered list.
  const base::Value::List& module_names_in_order =
      storage_service_->ReadModuleData();
  for (const base::Value& module_value : module_names_in_order) {
    if (feature_names.size() >= kRequestEntropyLimit) {
      break;
    }
    auto found_module = modules_.find(module_value.GetString());
    if (found_module != modules_.end() &&
        found_module->second.HasActiveFeature()) {
      feature_names.emplace_back(found_module->second.GetFeatureName());
    }
  }

  return feature_names;
}

const std::vector<std::string_view> WhatsNewRegistry::GetRolledFeatureNames()
    const {
  std::vector<std::string_view> feature_names;

  // Add modules based on ordered list.
  const base::Value::List& module_names_in_order =
      storage_service_->ReadModuleData();
  for (auto& module_value : module_names_in_order) {
    if (feature_names.size() >= kRequestEntropyLimit) {
      break;
    }
    auto found_module = modules_.find(module_value.GetString());
    if (found_module != modules_.end() &&
        found_module->second.HasRolledFeature()) {
      feature_names.emplace_back(found_module->second.GetFeatureName());
    }
  }

  return feature_names;
}

const std::vector<std::string> WhatsNewRegistry::GetCustomizations() const {
  std::vector<std::string> customizations;
  const base::Value::List& module_names_in_order =
      storage_service_->ReadModuleData();
  for (const base::Value& module_value : module_names_in_order) {
    auto found_module = modules_.find(module_value.GetString());
    if (found_module != modules_.end()) {
      auto module = found_module->second;

      // Modules without a feature are default-enabled.
      const bool module_is_default_enabled = !module.HasFeature();
      // If the module is tied to a feature, ensure the feature is available.
      const bool module_is_available =
          module.HasActiveFeature() || module.HasRolledFeature();
      if (module_is_default_enabled || module_is_available) {
        std::string customization = module.GetCustomization();
        if (!customization.empty()) {
          customizations.emplace_back(customization);
        }
      }
    }
  }
  for (const auto& [key, edition] : editions_) {
    // The only requirement for an edition to show is that it is enabled.
    if (edition.IsFeatureEnabled()) {
      const auto customization = edition.GetCustomization();
      if (!customization.empty()) {
        customizations.emplace_back(customization);
      }
    }
  }
  return customizations;
}

const std::optional<std::string> WhatsNewRegistry::GetActiveEditionSurvey()
    const {
  // Check if the current version is used for an edition.
  const auto current_edition_name =
      storage_service_->FindEditionForCurrentVersion();
  if (current_edition_name.has_value()) {
    auto found_edition = editions_.find(std::string(*current_edition_name));
    if (found_edition != editions_.end()) {
      return found_edition->second.GetSurvey();
    }
  } else {
    // Only request other unused editions if there was not one shown during
    // this version.
    for (const auto& [key, edition] : editions_) {
      if (edition.IsFeatureEnabled() &&
          !storage_service_->IsUsedEdition(edition.GetFeatureName())) {
        const auto survey = edition.GetSurvey();
        if (survey.has_value()) {
          return survey;
        }
      }
    }
  }

  return std::nullopt;
}

void WhatsNewRegistry::SetEditionUsed(std::string edition_name) const {
  // Verify edition exists.
  auto found_edition = editions_.find(edition_name);
  if (found_edition != editions_.end()) {
    storage_service_->SetEditionUsed(edition_name);
  }
}

void WhatsNewRegistry::SetVersionUsed() const {
  storage_service_->SetVersionUsed();
}

void WhatsNewRegistry::ClearUnregisteredModules() const {
  std::set<std::string_view> modules_to_clear;
  for (auto& module_value : storage_service_->ReadModuleData()) {
    auto found_module = modules_.find(module_value.GetString());
    // If the stored module cannot be found in the current registered
    // modules, clear its data.
    if (found_module == modules_.end()) {
      modules_to_clear.emplace(module_value.GetString());
    }
  }
  storage_service_->ClearModules(std::move(modules_to_clear));
}

void WhatsNewRegistry::ClearUnregisteredEditions() const {
  std::set<std::string_view> editions_to_clear;
  for (auto edition_value : storage_service_->ReadEditionData()) {
    auto found_edition = editions_.find(edition_value.first);
    // If the stored edition cannot be found in the current registered
    // editions, clear its data.
    if (found_edition == editions_.end()) {
      editions_to_clear.emplace(edition_value.first);
    }
  }
  storage_service_->ClearEditions(std::move(editions_to_clear));
}

void WhatsNewRegistry::ResetData() const {
  storage_service_->Reset();
}

WhatsNewRegistry::WhatsNewRegistry(
    std::unique_ptr<WhatsNewStorageService> storage_service)
    : storage_service_(std::move(storage_service)) {}
WhatsNewRegistry::~WhatsNewRegistry() = default;

}  // namespace whats_new