File: distiller_page_unittest.cc

package info (click to toggle)
chromium 141.0.7390.107-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,246,132 kB
  • sloc: cpp: 35,264,965; ansic: 7,169,920; javascript: 4,250,185; python: 1,460,635; asm: 950,788; xml: 751,751; pascal: 187,972; sh: 89,459; perl: 88,691; objc: 79,953; sql: 53,924; cs: 44,622; fortran: 24,137; makefile: 22,313; tcl: 15,277; php: 14,018; yacc: 8,995; ruby: 7,553; awk: 3,720; lisp: 3,096; lex: 1,330; ada: 727; jsp: 228; sed: 36
file content (298 lines) | stat: -rw-r--r-- 12,007 bytes parent folder | download | duplicates (4)
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
// 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/dom_distiller/core/distiller_page.h"

#include <optional>

#include "base/functional/callback_forward.h"
#include "base/functional/callback_helpers.h"
#include "base/run_loop.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "base/values.h"
#include "components/dom_distiller/core/dom_distiller_constants.h"
#include "components/dom_distiller/core/dom_distiller_features.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/dom_distiller_js/dom_distiller.pb.h"
#include "url/gurl.h"

namespace dom_distiller {

namespace {

enum class DistillationParseResult {
  kSuccess = 0,
  kParseFailure = 1,
  kNoResult = 2,
};

constexpr char kReadabilityTitle[] = "title";
constexpr char kReadabilityContent[] = "content";
constexpr char kReadabilityDir[] = "dir";
constexpr char kReadabilityTextContent[] = "textContent";

// This is a minimal concrete class that inherits from DistillerPage. It
// overrides the implementation of distillation to immediately call the
// completion handler, simulating a success or failure result for the test.
class TestDistillerPage : public DistillerPage {
 public:
  // This enum controls which distillation outcome the mock will simulate.
  enum class SimulatedResult {
    kSuccess,
    kParseFailure,
    kNoResult,
    kCustomResult,
    kNullResult,
  };

  TestDistillerPage() = default;

  // Configures the mock to simulate a specific result.
  void SetNextResult(SimulatedResult result) { simulate_result_ = result; }

  // Configures the mock to simulate a specific result value.
  void SetNextResultValue(std::optional<base::Value> val) {
    simulate_result_ = SimulatedResult::kCustomResult;
    simulate_result_val_ = std::move(val);
  }

  bool ShouldFetchOfflineData() override { return false; }

  DistillerType GetDistillerType() override {
    return ShouldUseReadabilityDistiller() ? DistillerType::kReadability
                                           : DistillerType::kDOMDistiller;
  }

  // The overridden implementation now simulates one of three outcomes based on
  // the configuration set by SetNextResult().
  void DistillPageImpl(const GURL& url, const std::string& script) override {
    switch (simulate_result_) {
      case SimulatedResult::kSuccess: {
        // A valid (but empty) dictionary simulates a parsable result from the
        // distiller, leading to `kSuccess`.
        const base::Value success_value(base::Value::Type::DICT);
        OnDistillationDone(url, &success_value);
        break;
      }
      case SimulatedResult::kParseFailure: {
        // An invalid type (e.g., a string instead of a dict) will cause a
        // parse failure, leading to `kParseFailure`.
        const base::Value parse_failure_value("not a dictionary");
        OnDistillationDone(url, &parse_failure_value);
        break;
      }
      case SimulatedResult::kNoResult: {
        // A NONE value simulates the distiller returning nothing, which leads
        // to `kNoResult`.
        const base::Value no_result_value(base::Value::Type::NONE);
        OnDistillationDone(url, &no_result_value);
        break;
      }
      case SimulatedResult::kCustomResult: {
        OnDistillationDone(url, &simulate_result_val_.value());
        break;
      }
      case SimulatedResult::kNullResult: {
        OnDistillationDone(url, nullptr);
        break;
      }
    }
  }

 private:
  SimulatedResult simulate_result_ = SimulatedResult::kSuccess;
  std::optional<base::Value> simulate_result_val_ = std::nullopt;
};

class DistillerPageTest : public testing::Test {
 protected:
  DistillerPageTest() = default;

  base::test::TaskEnvironment task_environment_;
  base::HistogramTester histogram_tester_;
};

// Test that the kSuccess value is recorded when distillation is successful.
TEST_F(DistillerPageTest, RecordsSuccessMetric) {
  TestDistillerPage distiller_page;
  distiller_page.SetNextResult(TestDistillerPage::SimulatedResult::kSuccess);

  distiller_page.DistillPage(GURL("http://example.com/success"),
                             dom_distiller::proto::DomDistillerOptions(),
                             base::DoNothing());

  // Check that the UMA metric was recorded with the correct enum value.
  histogram_tester_.ExpectUniqueSample("DomDistiller.Distillation.Result",
                                       DistillationParseResult::kSuccess, 1);
}

// Test that the kParseFailure value is recorded when the result is unparsable.
TEST_F(DistillerPageTest, RecordsParseFailureMetric) {
  TestDistillerPage distiller_page;
  distiller_page.SetNextResult(
      TestDistillerPage::SimulatedResult::kParseFailure);

  distiller_page.DistillPage(GURL("http://example.com/failure"),
                             dom_distiller::proto::DomDistillerOptions(),
                             base::DoNothing());

  histogram_tester_.ExpectUniqueSample("DomDistiller.Distillation.Result",
                                       DistillationParseResult::kParseFailure,
                                       1);
}

// Test that the kNoResult value is recorded when the distiller returns nothing.
TEST_F(DistillerPageTest, RecordsNoResultMetric) {
  TestDistillerPage distiller_page;
  distiller_page.SetNextResult(TestDistillerPage::SimulatedResult::kNoResult);

  distiller_page.DistillPage(GURL("http://example.com/no-result"),
                             dom_distiller::proto::DomDistillerOptions(),
                             base::DoNothing());

  histogram_tester_.ExpectUniqueSample("DomDistiller.Distillation.Result",
                                       DistillationParseResult::kNoResult, 1);
}

// Test that the kNullResult value is recorded when the distiller returns null.
TEST_F(DistillerPageTest, RecordsNullResultMetric) {
  TestDistillerPage distiller_page;
  distiller_page.SetNextResult(TestDistillerPage::SimulatedResult::kNullResult);

  distiller_page.DistillPage(GURL("http://example.com/null-result"),
                             dom_distiller::proto::DomDistillerOptions(),
                             base::DoNothing());

  histogram_tester_.ExpectUniqueSample("DomDistiller.Distillation.Result",
                                       DistillationParseResult::kNoResult, 1);
}

// Asserts the fields exist in the DomDistillerResult.
void AssertCorrectDomDistillerResult(proto::DomDistillerResult& result,
                                     const std::string& title,
                                     const std::string& content,
                                     const std::string& dir,
                                     const int word_count) {
  ASSERT_EQ(title, result.title());
  ASSERT_EQ(content, result.distilled_content().html());
  ASSERT_EQ(dir, result.text_direction());
  ASSERT_EQ(word_count, result.statistics_info().word_count());
}

TEST_F(DistillerPageTest, ReadabilityObjectIsExtracted) {
  base::test::ScopedFeatureList feature_list;
  feature_list.InitWithFeaturesAndParameters(
      /*enabled_features=*/{{dom_distiller::kReaderModeUseReadability,
                             {{"use_distiller", "true"}}}},
      /*disabled_features=*/{});

  base::Value::Dict readability_result;
  const std::string title = "test_title";
  readability_result.Set(kReadabilityTitle, title);
  const std::string content = "test content";
  readability_result.Set(kReadabilityContent, content);
  const std::string dir = "ltr";
  readability_result.Set(kReadabilityDir, dir);
  const std::string text_content =
      "one two; three. four!  fivefive six, seven, eight nine ten";
  readability_result.Set(kReadabilityTextContent, text_content);
  TestDistillerPage distiller_page;
  distiller_page.SetNextResultValue(base::Value(std::move(readability_result)));

  base::RunLoop run_loop;
  DistillerPage::DistillerPageCallback cb =
      base::BindOnce(
          [](std::string title, std::string content, std::string dir,
             int word_count,
             std::unique_ptr<proto::DomDistillerResult> distilled_page,
             bool distillation_successful) {
            EXPECT_TRUE(distillation_successful);
            AssertCorrectDomDistillerResult(*distilled_page.get(), title,
                                            content, dir, 10);
          },
          title, content, dir, 10)
          .Then(run_loop.QuitClosure());
  distiller_page.DistillPage(GURL("http://example.com/success"),
                             dom_distiller::proto::DomDistillerOptions(),
                             std::move(cb));
  run_loop.Run();
  histogram_tester_.ExpectUniqueSample("DomDistiller.Distillation.Result",
                                       DistillationParseResult::kSuccess, 1);
}

TEST_F(DistillerPageTest,
       ReadabilityObjectIsExtracted_AutoDirWhenNoneProvided) {
  base::test::ScopedFeatureList feature_list;
  feature_list.InitWithFeaturesAndParameters(
      /*enabled_features=*/{{dom_distiller::kReaderModeUseReadability,
                             {{"use_distiller", "true"}}}},
      /*disabled_features=*/{});

  base::Value::Dict readability_result;
  const std::string title = "test_title";
  readability_result.Set(kReadabilityTitle, title);
  const std::string content = "test content";
  readability_result.Set(kReadabilityContent, content);
  const std::string dir = "auto";
  const std::string text_content =
      "one two; three. four!  fivefive six, seven, eight nine ten";
  readability_result.Set(kReadabilityTextContent, text_content);
  TestDistillerPage distiller_page;
  distiller_page.SetNextResultValue(base::Value(std::move(readability_result)));

  base::RunLoop run_loop;
  DistillerPage::DistillerPageCallback cb =
      base::BindOnce(
          [](std::string title, std::string content, std::string dir,
             int word_count,
             std::unique_ptr<proto::DomDistillerResult> distilled_page,
             bool distillation_successful) {
            EXPECT_TRUE(distillation_successful);
            AssertCorrectDomDistillerResult(*distilled_page.get(), title,
                                            content, dir, 10);
          },
          title, content, dir, 10)
          .Then(run_loop.QuitClosure());
  distiller_page.DistillPage(GURL("http://example.com/success"),
                             dom_distiller::proto::DomDistillerOptions(),
                             std::move(cb));
  run_loop.Run();
  histogram_tester_.ExpectUniqueSample("DomDistiller.Distillation.Result",
                                       DistillationParseResult::kSuccess, 1);
}

TEST_F(DistillerPageTest, ReadabilityObjectIsExtracted_FailureWhenNotDict) {
  base::test::ScopedFeatureList feature_list;
  feature_list.InitWithFeaturesAndParameters(
      /*enabled_features=*/{{dom_distiller::kReaderModeUseReadability,
                             {{"use_distiller", "true"}}}},
      /*disabled_features=*/{});

  base::Value readability_result("undefined");
  TestDistillerPage distiller_page;
  distiller_page.SetNextResultValue(base::Value(std::move(readability_result)));

  base::RunLoop run_loop;
  DistillerPage::DistillerPageCallback cb =
      base::BindOnce(
          [](std::unique_ptr<proto::DomDistillerResult> distilled_page,
             bool distillation_successful) {
            EXPECT_FALSE(distillation_successful);
          })
          .Then(run_loop.QuitClosure());
  distiller_page.DistillPage(GURL("http://example.com/success"),
                             dom_distiller::proto::DomDistillerOptions(),
                             std::move(cb));
  run_loop.Run();

  histogram_tester_.ExpectUniqueSample("DomDistiller.Distillation.Result",
                                       DistillationParseResult::kParseFailure,
                                       1);
}

}  // namespace

}  // namespace dom_distiller