File: link_capturing_feature_test_support.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 (334 lines) | stat: -rw-r--r-- 12,246 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
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
// 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 "chrome/browser/apps/link_capturing/link_capturing_feature_test_support.h"

#include <optional>
#include <vector>

#include "base/check_is_test.h"
#include "base/functional/bind.h"
#include "base/strings/string_util.h"
#include "base/test/bind.h"
#include "base/test/test_future.h"
#include "base/types/expected.h"
#include "build/build_config.h"
#include "chrome/browser/ui/web_applications/test/web_app_browsertest_util.h"
#include "chrome/browser/web_applications/link_capturing_features.h"
#include "chrome/browser/web_applications/web_app_command_scheduler.h"
#include "chrome/browser/web_applications/web_app_provider.h"
#include "chrome/browser/web_applications/web_app_tab_helper.h"
#include "content/public/browser/navigation_handle.h"
#include "content/public/browser/web_contents.h"
#include "content/public/common/content_features.h"
#include "content/public/test/browser_test_utils.h"
#include "testing/gtest/include/gtest/gtest.h"

#if BUILDFLAG(IS_CHROMEOS)
#include "chrome/browser/apps/intent_helper/preferred_apps_test_util.h"
#endif

namespace apps::test {
namespace {

std::optional<std::string> WaitForNextMessage(
    content::DOMMessageQueue& message_queue) {
  std::string message;
  EXPECT_TRUE(message_queue.WaitForMessage(&message));
  if (message.empty()) {
    return std::nullopt;
  }
  std::string unquoted_message;
  EXPECT_TRUE(base::RemoveChars(message, "\"", &unquoted_message)) << message;
  return unquoted_message;
}

std::vector<base::test::FeatureRefAndParams> GetFeaturesToEnableLinkCapturingUX(
    std::optional<bool> override_captures_by_default,
    bool use_v2,
    bool capture_existing_frame_navigations) {
#if BUILDFLAG(IS_CHROMEOS)
  CHECK(!override_captures_by_default || !override_captures_by_default.value());
  // TODO(crbug.com/376922620): Create a feature flag to turn off the v1
  // throttle.
  std::vector<base::test::FeatureRefAndParams> features_to_enable = {
      {::features::kPwaNavigationCapturing,
       {{::features::kNavigationCapturingDefaultState.name,
         use_v2 ? "reimpl_default_off" : "off_by_default"}}}};
  if (capture_existing_frame_navigations && use_v2) {
    features_to_enable.push_back(
        {features::kNavigationCapturingOnExistingFrames, {}});
  }
  return features_to_enable;
#else
  // `capture_existing_frame_navigations` is ChromeOS only for now.
  CHECK(!capture_existing_frame_navigations);
  // TODO(crbug.com/351775835): Integrate testing for all enum states of
  // `CapturingState`.
  std::string on_by_default_label =
      use_v2 ? "reimpl_default_on" : "on_by_default";
  std::string off_by_default_label =
      use_v2 ? "reimpl_default_off" : "off_by_default";

  bool should_override_by_default = override_captures_by_default.value_or(
      ::features::kNavigationCapturingDefaultState.default_value ==
          ::features::CapturingState::kDefaultOn ||
      ::features::kNavigationCapturingDefaultState.default_value ==
          ::features::CapturingState::kReimplDefaultOn);

  return {{::features::kPwaNavigationCapturing,
           {{::features::kNavigationCapturingDefaultState.name,
             std::string(should_override_by_default ? on_by_default_label
                                                    : off_by_default_label)}}}};
#endif  // BUILDFLAG(IS_CHROMEOS)
}

}  // namespace

bool ShouldLinksWithExistingFrameTargetsCapture(
    LinkCapturingFeatureVersion version) {
  switch (version) {
    case LinkCapturingFeatureVersion::kV1DefaultOff:
      return true;
    case LinkCapturingFeatureVersion::kV2DefaultOff:
      return false;
    case LinkCapturingFeatureVersion::kV2DefaultOffCaptureExistingFrames:
      return true;
#if !BUILDFLAG(IS_CHROMEOS)
    case LinkCapturingFeatureVersion::kV2DefaultOn:
      return false;
#endif
  }
}
bool IsV1(LinkCapturingFeatureVersion version) {
  switch (version) {
    case LinkCapturingFeatureVersion::kV1DefaultOff:
      return true;
    case LinkCapturingFeatureVersion::kV2DefaultOff:
      return false;
    case LinkCapturingFeatureVersion::kV2DefaultOffCaptureExistingFrames:
      return false;
#if !BUILDFLAG(IS_CHROMEOS)
    case LinkCapturingFeatureVersion::kV2DefaultOn:
      return false;
#endif
  }
}

bool IsV2(LinkCapturingFeatureVersion version) {
  return !IsV1(version);
}

std::string ToString(LinkCapturingFeatureVersion version) {
  switch (version) {
    case LinkCapturingFeatureVersion::kV1DefaultOff:
      return "V1DefaultOff";
    case LinkCapturingFeatureVersion::kV2DefaultOff:
      return "V2DefaultOff";
    case LinkCapturingFeatureVersion::kV2DefaultOffCaptureExistingFrames:
      return "V2DefaultOffCaptureExistingFrames";
#if !BUILDFLAG(IS_CHROMEOS)
    case LinkCapturingFeatureVersion::kV2DefaultOn:
      return "V2DefaultOn";
#endif
  }
}

std::string LinkCapturingVersionToString(
    const testing::TestParamInfo<LinkCapturingFeatureVersion>& version) {
  return ToString(version.param);
}

std::vector<base::test::FeatureRefAndParams> GetFeaturesToEnableLinkCapturingUX(
    LinkCapturingFeatureVersion version) {
  CHECK_IS_TEST();
  switch (version) {
    case LinkCapturingFeatureVersion::kV1DefaultOff:
      return GetFeaturesToEnableLinkCapturingUX(
          /*override_captures_by_default=*/false,
          /*use_v2=*/false, /*capture_existing_frame_navigations=*/false);
    case LinkCapturingFeatureVersion::kV2DefaultOff:
      return GetFeaturesToEnableLinkCapturingUX(
          /*override_captures_by_default=*/false,
          /*use_v2=*/true, /*capture_existing_frame_navigations=*/false);
    case LinkCapturingFeatureVersion::kV2DefaultOffCaptureExistingFrames:
      return GetFeaturesToEnableLinkCapturingUX(
          /*override_captures_by_default=*/false,
          /*use_v2=*/true, /*capture_existing_frame_navigations=*/true);
#if !BUILDFLAG(IS_CHROMEOS)
    case LinkCapturingFeatureVersion::kV2DefaultOn:
      return GetFeaturesToEnableLinkCapturingUX(
          /*override_captures_by_default=*/true,
          /*use_v2=*/true, /*capture_existing_frame_navigations=*/false);
#endif
  }
}

base::expected<void, std::string> EnableLinkCapturingByUser(
    Profile* profile,
    const webapps::AppId& app_id) {
  CHECK_IS_TEST();
#if BUILDFLAG(IS_CHROMEOS)
  apps_util::SetSupportedLinksPreferenceAndWait(profile, app_id);
#else
  web_app::WebAppProvider* provider =
      web_app::WebAppProvider::GetForTest(profile);
  base::test::TestFuture<void> preference_set;
  provider->scheduler().SetAppCapturesSupportedLinksDisableOverlapping(
      app_id, /*set_to_preferred=*/true, preference_set.GetCallback());
  if (!preference_set.Wait()) {
    return base::unexpected("Enable link capturing command never completed.");
  }
#endif  // BUILDFLAG(IS_CHROMEOS)
  return base::ok();
}

base::expected<void, std::string> DisableLinkCapturingByUser(
    Profile* profile,
    const webapps::AppId& app_id) {
  CHECK_IS_TEST();
#if BUILDFLAG(IS_CHROMEOS)
  apps_util::RemoveSupportedLinksPreferenceAndWait(profile, app_id);
#else
  web_app::WebAppProvider* provider =
      web_app::WebAppProvider::GetForTest(profile);
  base::test::TestFuture<void> preference_set;
  provider->scheduler().SetAppCapturesSupportedLinksDisableOverlapping(
      app_id, /*set_to_preferred=*/false, preference_set.GetCallback());
  if (!preference_set.Wait()) {
    return base::unexpected("Disable link capturing command never completed.");
  }
#endif  // BUILDFLAG(IS_CHROMEOS)
  return base::ok();
}

NavigationCommittedForUrlObserver::NavigationCommittedForUrlObserver(
    const GURL& url)
    : url_(url) {
  AddAllBrowsers();
}

NavigationCommittedForUrlObserver::~NavigationCommittedForUrlObserver() =
    default;

std::unique_ptr<base::CheckedObserver>
NavigationCommittedForUrlObserver::ProcessOneContents(
    content::WebContents* web_contents) {
  return std::make_unique<content::DidFinishNavigationObserver>(
      web_contents, base::BindRepeating(
                        &NavigationCommittedForUrlObserver::DidFinishNavigation,
                        base::Unretained(this)));
}

void NavigationCommittedForUrlObserver::DidFinishNavigation(
    content::NavigationHandle* handle) {
  if (!handle->HasCommitted()) {
    return;
  }
  if (!handle->IsInMainFrame() || handle->GetURL() != url_) {
    return;
  }
  // Record the first match.
  if (!web_contents_) {
    web_contents_ = handle->GetWebContents();
  }
  ConditionMet();
}

void FlushLaunchQueuesForAllBrowserTabs() {
  web_app::test::RunForAllTabs(
      base::BindRepeating([](content::WebContents& web_contents) {
        web_app::WebAppTabHelper* helper =
            web_app::WebAppTabHelper::FromWebContents(&web_contents);
        if (!helper) {
          return;
        }
        helper->FlushLaunchQueueForTesting();
      }));
}

base::expected<void, std::vector<std::string>>
ResolveWebContentsWaitingForLaunchQueueFlush() {
  std::vector<std::string> errors;
  web_app::test::RunForAllTabs(
      base::BindLambdaForTesting([&](content::WebContents& web_contents) {
        content::EvalJsResult has_function = content::EvalJs(
            &web_contents, "typeof resolveLaunchParamsFlush !== 'undefined'");
        if (!has_function.error.empty() || !has_function.ExtractBool()) {
          // Sometimes the web contents is destroyed while evaluating this
          // javascript. That is fine.
          DLOG_IF(INFO, !has_function.error.empty())
              << "Got error: " << has_function.error;
          return;
        }
        content::EvalJsResult result =
            content::EvalJs(&web_contents, "resolveLaunchParamsFlush()");
        if (!result.error.empty()) {
          errors.push_back(result.error);
        }
      }));
  if (!errors.empty()) {
    return base::unexpected(std::move(errors));
  }
  return base::ok();
}

testing::AssertionResult WaitForNavigationFinishedMessage(
    content::DOMMessageQueue& message_queue) {
  // Wait for all pages to complete loading to prevent the BrowserList or tab
  // model from changing later while flushing.
  web_app::test::CompletePageLoadForAllWebContents();

  std::optional<std::string> message;
  while ((message = WaitForNextMessage(message_queue))) {
    if (!message.has_value()) {
      return testing::AssertionFailure() << "Message never received.";
    }
    DLOG(INFO) << "Got message: " << *message;
    if (base::StartsWith(*message, "FinishedNavigating")) {
      break;
    }
    if (!base::StartsWith(*message, "PleaseFlushLaunchQueue")) {
      return testing::AssertionFailure()
             << "Unrecognized message: " << *message;
    }
    // Since DOMMessageQueue doesn't helpfully tell us where the message came
    // from, we have to flush ALL queues, and resolve any promises waiting on
    // it.
    FlushLaunchQueuesForAllBrowserTabs();

    // Because some redirection and other cases can close web contents, tab
    // closures can happen during `FlushLaunchQueueForTesting`. So call the
    // resolution of the flush in a separate method.
    auto success = ResolveWebContentsWaitingForLaunchQueueFlush();
    if (success != base::ok()) {
      return testing::AssertionFailure()
             << "Errors: " << base::JoinString(success.error(), ",");
    }
  }
  if (!message.has_value()) {
    return testing::AssertionFailure() << "Message never received.";
  }
  return testing::AssertionSuccess();
}

std::vector<GURL> GetLaunchParamUrlsInContents(
    content::WebContents* contents,
    const std::string& params_variable_name) {
  std::vector<GURL> launch_params;
  content::EvalJsResult launchParamsResults =
      content::EvalJs(contents->GetPrimaryMainFrame(),
                      "'" + params_variable_name + "' in window ? " +
                          params_variable_name + " : []");
  EXPECT_THAT(launchParamsResults, content::EvalJsResult::IsOk());
  base::Value::List launchParamsTargetUrls = launchParamsResults.ExtractList();
  if (!launchParamsTargetUrls.empty()) {
    for (const base::Value& url : launchParamsTargetUrls) {
      launch_params.emplace_back(url.GetString());
    }
  }
  return launch_params;
}

}  // namespace apps::test