File: versioning_message_controller_impl.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 (234 lines) | stat: -rw-r--r-- 8,597 bytes parent folder | download | duplicates (3)
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
// Copyright 2025 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/saved_tab_groups/internal/versioning_message_controller_impl.h"

#include "base/functional/bind.h"
#include "components/data_sharing/public/features.h"
#include "components/prefs/pref_service.h"
#include "components/saved_tab_groups/public/pref_names.h"
#include "components/saved_tab_groups/public/tab_group_sync_service.h"

namespace tab_groups {
namespace {

// Represents various possible version states based on feature flags.
enum class VersionState {
  // Version is out of date. Versioning messages to update chrome can be shown.
  // Feature flags:
  // data_sharing::features::kSharedDataTypesKillSwitch ENABLED,
  // data_sharing::features::kDataSharingEnableUpdateChromeUI ENABLED.
  kOutOfDate,

  // Version is out of date. However, no specific versioning message should be
  // shown.
  // Feature flags:
  // data_sharing::features::kSharedDataTypesKillSwitch ENABLED,
  // data_sharing::features::kDataSharingEnableUpdateChromeUI DISABLED.
  kNoMessage,

  // Version is up-to-date.
  // Feature flags:
  // data_sharing::features::kSharedDataTypesKillSwitch DISABLED,
  // data_sharing::features::kDataSharingEnableUpdateChromeUI DISABLED.
  kUpToDate,

  // Invalid combination of feature flags. No specific versioning message should
  // be shown.
  // Feature flags:
  // data_sharing::features::kSharedDataTypesKillSwitch DISABLED,
  // data_sharing::features::kDataSharingEnableUpdateChromeUI ENABLED.
  kInvalidCombination,
};

// Returns the current version state based on combination of feature flags.
VersionState GetVersionState() {
  if (!data_sharing::features::IsDataSharingFunctionalityEnabled()) {
    return VersionState::kNoMessage;
  }
  const bool is_shared_data_types_enabled = !base::FeatureList::IsEnabled(
      data_sharing::features::kSharedDataTypesKillSwitch);
  const bool is_update_chrome_ui_enabled = base::FeatureList::IsEnabled(
      data_sharing::features::kDataSharingEnableUpdateChromeUI);

  if (is_shared_data_types_enabled) {
    return is_update_chrome_ui_enabled ? VersionState::kInvalidCombination
                                       : VersionState::kUpToDate;
  } else {
    return is_update_chrome_ui_enabled ? VersionState::kOutOfDate
                                       : VersionState::kNoMessage;
  }
}

bool HasCurrentSharedTabGroups(TabGroupSyncService* tab_group_sync_service) {
  for (const auto* saved_tab_group : tab_group_sync_service->ReadAllGroups()) {
    if (saved_tab_group->collaboration_id().has_value()) {
      return true;
    }
  }

  return false;
}

}  // namespace

VersioningMessageControllerImpl::VersioningMessageControllerImpl(
    PrefService* pref_service,
    TabGroupSyncService* tab_group_sync_service)
    : pref_service_(pref_service),
      tab_group_sync_service_(tab_group_sync_service) {
  tab_group_sync_service_->AddObserver(this);
}

VersioningMessageControllerImpl::~VersioningMessageControllerImpl() {
  tab_group_sync_service_->RemoveObserver(this);
}

void VersioningMessageControllerImpl::ComputePrefsOnStartup() {
  // On startup, read and compute the state of the prefs based on the feature
  // flag and number of shared tab groups in the previous session.

  switch (GetVersionState()) {
    case VersionState::kOutOfDate: {
      // Version is out-of-date. If there were shared tab groups last session,
      // that means that the version just switched. Compute the pref states
      // accordingly.

      // Determine if previous session had shared tab groups that make
      // it eligible for the instant/persistent message.
      const bool had_open_shared_tab_groups =
          tab_group_sync_service_->HadSharedTabGroupsLastSession(
              /*open_shared_tab_groups=*/true);
      const bool had_any_shared_tab_groups =
          tab_group_sync_service_->HadSharedTabGroupsLastSession(
              /*open_shared_tab_groups=*/false);

      if (had_open_shared_tab_groups) {
        pref_service_->SetBoolean(
            prefs::kEligibleForVersionOutOfDateInstantMessage, true);
      }

      if (had_any_shared_tab_groups) {
        pref_service_->SetBoolean(
            prefs::kEligibleForVersionOutOfDatePersistentMessage, true);
      }

      // Always reset the 'updated' message eligibility when out of date.
      pref_service_->SetBoolean(prefs::kEligibleForVersionUpdatedMessage,
                                false);
      break;
    }
    case VersionState::kUpToDate: {
      // Version is up-to-date. Determine if eligible for the 'version updated'
      // message.
      const bool had_any_out_of_date_messages_before =
          pref_service_->GetBoolean(prefs::kHasShownAnyVersionOutOfDateMessage);

      if (had_any_out_of_date_messages_before) {
        pref_service_->SetBoolean(prefs::kEligibleForVersionUpdatedMessage,
                                  true);
      }

      // Always reset the 'out-of-date' message eligibilities when up to date.
      pref_service_->SetBoolean(
          prefs::kEligibleForVersionOutOfDateInstantMessage, false);
      pref_service_->SetBoolean(prefs::kHasShownAnyVersionOutOfDateMessage,
                                false);
      pref_service_->SetBoolean(
          prefs::kEligibleForVersionOutOfDatePersistentMessage, false);
      break;
    }
    case VersionState::kNoMessage:
    case VersionState::kInvalidCombination: {
      // In these states, no specific versioning messages are tied to the
      // feature flag combination. The prefs should carry over their previous
      // state or default values if not explicitly set elsewhere.
      break;
    }
  }
}

bool VersioningMessageControllerImpl::ShouldShowMessageUi(
    MessageType message_type) {
  CHECK(is_initialized_);

  VersionState current_version_state = GetVersionState();
  switch (message_type) {
    case MessageType::VERSION_OUT_OF_DATE_INSTANT_MESSAGE:
      return current_version_state == VersionState::kOutOfDate &&
             pref_service_->GetBoolean(
                 prefs::kEligibleForVersionOutOfDateInstantMessage);
    case MessageType::VERSION_OUT_OF_DATE_PERSISTENT_MESSAGE:
      return current_version_state == VersionState::kOutOfDate &&
             pref_service_->GetBoolean(
                 prefs::kEligibleForVersionOutOfDatePersistentMessage);
    case MessageType::VERSION_UPDATED_MESSAGE:
      return current_version_state == VersionState::kUpToDate &&
             pref_service_->GetBoolean(
                 prefs::kEligibleForVersionUpdatedMessage) &&
             HasCurrentSharedTabGroups(tab_group_sync_service_);
    default:
      return false;
  }
}

bool VersioningMessageControllerImpl::IsInitialized() {
  return is_initialized_;
}

void VersioningMessageControllerImpl::ShouldShowMessageUiAsync(
    MessageType message_type,
    base::OnceCallback<void(bool)> callback) {
  if (!is_initialized_) {
    pending_callbacks_.push_back(base::BindOnce(
        &VersioningMessageControllerImpl::ShouldShowMessageUiAsync,
        weak_ptr_factory_.GetWeakPtr(), message_type, std::move(callback)));

    return;
  }

  std::move(callback).Run(ShouldShowMessageUi(message_type));
}

void VersioningMessageControllerImpl::OnMessageUiShown(
    MessageType message_type) {
  switch (message_type) {
    case MessageType::VERSION_OUT_OF_DATE_INSTANT_MESSAGE:
      pref_service_->SetBoolean(
          prefs::kEligibleForVersionOutOfDateInstantMessage, false);
      pref_service_->SetBoolean(prefs::kHasShownAnyVersionOutOfDateMessage,
                                true);
      break;
    case MessageType::VERSION_OUT_OF_DATE_PERSISTENT_MESSAGE:
      pref_service_->SetBoolean(prefs::kHasShownAnyVersionOutOfDateMessage,
                                true);
      break;
    case MessageType::VERSION_UPDATED_MESSAGE:
      pref_service_->SetBoolean(prefs::kEligibleForVersionUpdatedMessage,
                                false);
      break;
    default:
      break;
  }
}

void VersioningMessageControllerImpl::OnMessageUiDismissed(
    MessageType message_type) {
  if (message_type == MessageType::VERSION_OUT_OF_DATE_PERSISTENT_MESSAGE) {
    pref_service_->SetBoolean(
        prefs::kEligibleForVersionOutOfDatePersistentMessage, false);
  }
}

void VersioningMessageControllerImpl::OnInitialized() {
  is_initialized_ = true;
  ComputePrefsOnStartup();

  for (auto& callback : pending_callbacks_) {
    std::move(callback).Run();
  }
  pending_callbacks_.clear();
}

}  // namespace tab_groups