File: calculator_provider_unittest.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 (246 lines) | stat: -rw-r--r-- 10,551 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
// 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 "components/omnibox/browser/calculator_provider.h"

#include <memory>
#include <string>
#include <vector>

#include "base/memory/scoped_refptr.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "base/timer/elapsed_timer.h"
#include "components/omnibox/browser/autocomplete_input.h"
#include "components/omnibox/browser/autocomplete_match.h"
#include "components/omnibox/browser/autocomplete_match_type.h"
#include "components/omnibox/browser/fake_autocomplete_provider_client.h"
#include "components/omnibox/browser/provider_state_service.h"
#include "components/omnibox/browser/search_provider.h"
#include "components/omnibox/browser/test_scheme_classifier.h"
#include "components/omnibox/common/omnibox_feature_configs.h"

namespace {
class FakeSearchProvider : public SearchProvider {
 public:
  using SearchProvider::done_;
  using SearchProvider::matches_;
  using SearchProvider::SearchProvider;

 protected:
  ~FakeSearchProvider() override = default;
};

struct SearchMatch {
  std::u16string contents;
  bool is_calc = true;
};

}  // namespace

class CalculatorProviderTest : public testing::Test,
                               public AutocompleteProviderListener {
 protected:
  CalculatorProviderTest() {
    client_ = std::make_unique<FakeAutocompleteProviderClient>();
    search_provider_ = new FakeSearchProvider(client_.get(), this);
    calculator_provider_ =
        new CalculatorProvider(client_.get(), this, search_provider_.get());
  }

  ~CalculatorProviderTest() override {
    client_->GetProviderStateService()->calculator_provider_cache.clear();
  }

  // AutocompleteProviderListener:
  void OnProviderUpdate(bool updated_matches,
                        const AutocompleteProvider* provider) override {}

  // Helper to simulate the search and calc providers starting. The search
  // provider will complete if `search_completes_sync` is true. It will have
  // `search_matches` regardless of whether it completes.
  void StartAutocompletion(bool search_completes_sync,
                           std::vector<SearchMatch> search_matches,
                           AutocompleteInput input) {
    search_provider_->matches_.clear();
    for (const auto& search_match : search_matches) {
      AutocompleteMatch match(search_provider_.get(), 1000, true,
                              search_match.is_calc
                                  ? AutocompleteMatchType::CALCULATOR
                                  : AutocompleteMatchType::SEARCH_SUGGEST);
      match.contents = search_match.contents;
      search_provider_->matches_.push_back(match);
    }
    search_provider_->done_ = search_completes_sync;
    calculator_provider_->Start(input, false);
  }

  // Helper to simulate the search and calc providers starting. The search
  // provider will complete with either a single non-calc match, or an
  // additional second calc match.
  void TypeAndStartAutocompletion(std::u16string input_text,
                                  bool include_calc) {
    std::vector<SearchMatch> search_matches = {{input_text, false}};
    if (include_calc)
      search_matches.push_back({input_text});
    AutocompleteInput input{input_text, metrics::OmniboxEventProto::OTHER,
                            TestSchemeClassifier()};
    StartAutocompletion(true, search_matches, input);
  }

  std::vector<std::u16string> GetCalcMatches() {
    std::vector<std::u16string> contents;
    for (const auto& m : calculator_provider_->matches())
      contents.push_back(m.contents);
    return contents;
  }

  base::test::ScopedFeatureList feature_list_{
      omnibox_feature_configs::CalcProvider::kCalcProvider};
  std::unique_ptr<FakeAutocompleteProviderClient> client_;
  scoped_refptr<FakeSearchProvider> search_provider_;
  scoped_refptr<CalculatorProvider> calculator_provider_;
  // Used to simulate time passing.
  base::test::SingleThreadTaskEnvironment task_environment_{
      base::test::TaskEnvironment::TimeSource::MOCK_TIME};
};

TEST_F(CalculatorProviderTest, SkipSyncInputs) {
  // Returns early when `omit_asynchronous_matches()` is true.
  AutocompleteInput input;
  input.set_omit_asynchronous_matches(true);
  StartAutocompletion(true, {{u"0+1=1"}}, input);
  EXPECT_TRUE(calculator_provider_->done());
}

TEST_F(CalculatorProviderTest, RunSynclyForSyncSearchProvider) {
  // If search provider finished syncly, so should the calc provider.

  // Search completes syncly with 0 matches.
  StartAutocompletion(true, {}, {});
  EXPECT_TRUE(calculator_provider_->done());
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre());

  // Search completes syncly with matches.
  StartAutocompletion(true, {{u"search", false}, {u"0+1=1"}, {u"0+2=2"}}, {});
  EXPECT_TRUE(calculator_provider_->done());
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"0+1=1", u"0+2=2"));
}

TEST_F(CalculatorProviderTest, RunAsynclyForAsyncSearchProvider) {
  // If search provider finished asyncly, so should the calc provider.

  // Start but don't complete search.
  StartAutocompletion(false, {}, {});
  EXPECT_FALSE(calculator_provider_->done());
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre());

  // Search completes with 0 matches.
  search_provider_->done_ = true;
  search_provider_->NotifyListeners(false);
  EXPECT_TRUE(calculator_provider_->done());
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre());

  // Start but don't complete search.
  StartAutocompletion(false, {{u"search", false}, {u"0+1=1"}, {u"0+2=2"}}, {});
  EXPECT_FALSE(calculator_provider_->done());
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre());

  // Complete search with matches
  search_provider_->done_ = true;
  search_provider_->NotifyListeners(false);
  EXPECT_TRUE(calculator_provider_->done());
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"0+1=1", u"0+2=2"));
}

TEST_F(CalculatorProviderTest, CachePreviousCalcSuggestions) {
  // Search has a calc suggestion. It should be shown.
  StartAutocompletion(true, {{u"0+1=1"}}, {});
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"0+1=1"));

  // Search has a different calc suggestion. Both the old and new should be
  // shown.
  StartAutocompletion(true, {{u"0+2=2"}}, {});
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"0+1=1", u"0+2=2"));

  // Search doesn't have a calc suggestion. The old 2 should be shown.
  StartAutocompletion(true, {{u"search", false}}, {});
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"0+1=1", u"0+2=2"));

  // Calc suggestions should expire after 1 hour.
  task_environment_.FastForwardBy(base::Minutes(59));
  StartAutocompletion(true, {{u"search", false}}, {});
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"0+1=1", u"0+2=2"));
  task_environment_.FastForwardBy(base::Minutes(60));
  StartAutocompletion(true, {{u"search", false}}, {});
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre());
}

TEST_F(CalculatorProviderTest, MaxCacheSize) {
  StartAutocompletion(true, {{u"1=1"}, {u"2=2"}, {u"3=3"}, {u"4=4"}}, {});
  EXPECT_THAT(GetCalcMatches(),
              testing::ElementsAre(u"1=1", u"2=2", u"3=3", u"4=4"));

  // "2=2" is omitted, because it's the oldest. "1=1" is refreshed below.
  StartAutocompletion(true, {{u"1=1"}, {u"5=5"}, {u"6=6"}, {u"7=7"}}, {});
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"3=3", u"4=4", u"1=1",
                                                     u"5=5", u"6=6", u"7=7"));
}

TEST_F(CalculatorProviderTest, DedupeAndCoalesceIntermediateInputs) {
  // When typing 1+2+3+4, shouldn't see intermediate matches (e.g. 1+2).
  TypeAndStartAutocompletion(u"1", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre());
  TypeAndStartAutocompletion(u"1+", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre());
  TypeAndStartAutocompletion(u"1+2", true);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+2"));
  TypeAndStartAutocompletion(u"1+2+", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+2"));
  TypeAndStartAutocompletion(u"1+2+3", true);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+2+3"));
  TypeAndStartAutocompletion(u"1+2+3+", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+2+3"));
  TypeAndStartAutocompletion(u"1+2+3+4", true);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+2+3+4"));

  // When backspace and retyping, shouldn't show duplicates.
  TypeAndStartAutocompletion(u"1+2+3+", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+2+3+4"));
  TypeAndStartAutocompletion(u"1+2+3+4", true);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+2+3+4"));

  // When backspacing and retyping, should show non-duplicates.
  TypeAndStartAutocompletion(u"1+", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+2+3+4"));
  TypeAndStartAutocompletion(u"1+2", true);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+2+3+4", u"1+2"));
}

TEST_F(CalculatorProviderTest, ShowCalcSuggestionsForCorrectInputs) {
  // Should stop showing calc suggestions if there have been no recent ones.
  TypeAndStartAutocompletion(u"1+1", true);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+1"));
  TypeAndStartAutocompletion(u"2+2", true);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+1", u"2+2"));
  TypeAndStartAutocompletion(u"2+2+", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+1", u"2+2"));
  TypeAndStartAutocompletion(u"2+2+x", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+1", u"2+2"));
  TypeAndStartAutocompletion(u"2+2+x+", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+1", u"2+2"));
  // The last calc suggestion was too old. The cached ones shouldn't be shown.
  TypeAndStartAutocompletion(u"2+2+x+y", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre());
  // A new calc suggestion should resurface the old ones too
  TypeAndStartAutocompletion(u"3+3", true);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+1", u"2+2", u"3+3"));
  // Cached suggestions should be shown when backspacing as well.
  TypeAndStartAutocompletion(u"3+", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre(u"1+1", u"2+2", u"3+3"));
  // But not when typing an input dissimilar from the last input that had a calc
  // suggestion.
  TypeAndStartAutocompletion(u"3-", false);
  EXPECT_THAT(GetCalcMatches(), testing::ElementsAre());
}