summaryrefslogtreecommitdiffstats
path: root/toolkit/components/places/tests/unit/test_frecency_recalc_triggers.js
blob: 2e75a6d45991e033ea51dcb08e2c606506c209f3 (plain)
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
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

/**
 * Tests that all the operations affecting frecency are either recalculating
 * immediately or triggering a recalculation.
 * Operations that should recalculate immediately:
 *  - adding visits
 * Operations that should just trigger a recalculation:
 *  - removing visits
 *  - adding a bookmark
 *  - removing a bookmark
 *  - changing url of a bookmark
 *
 * Also check setting a frecency resets recalc_frecency to 0.
 **/

const TEST_URL = "https://example.com/";
const TEST_URL_2 = "https://example2.com/";

// NOTE: Until we fix Bug 1806666 this test has to run queries manually because
// the official APIs recalculate frecency immediately. After the fix, these
// helpers can be removed and the test can be much simpler.
function insertVisit(url) {
  return PlacesUtils.withConnectionWrapper("insertVisit", async db => {
    await db.execute(
      `INSERT INTO moz_historyvisits(place_id, visit_date, visit_type)
       VALUES ((SELECT id FROM moz_places WHERE url = :url), 1648226608386000, 1)`,
      { url }
    );
  });
}
function removeVisit(url) {
  return PlacesUtils.withConnectionWrapper("insertVisit", async db => {
    await db.execute(
      `DELETE FROM moz_historyvisits WHERE place_id
        = (SELECT id FROM moz_places WHERE url = :url)`,
      { url }
    );
  });
}
function resetFrecency(url) {
  return PlacesUtils.withConnectionWrapper("insertVisit", async db => {
    await db.execute(`UPDATE moz_places SET frecency = -1 WHERE url = :url`, {
      url,
    });
  });
}

add_task(async function test_visit() {
  // First add a bookmark so the page is not orphaned.
  let bm = await PlacesUtils.bookmarks.insert({
    url: TEST_URL,
    parentGuid: PlacesUtils.bookmarks.toolbarGuid,
  });

  info("Add a visit check frecency is calculated immediately");
  await PlacesTestUtils.addVisits(TEST_URL);
  let originalFrecency = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.greater(originalFrecency, 0, "frecency was recalculated immediately");
  let recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(recalc, 0, "frecency doesn't need a recalc");

  info("Add a visit (raw query) check frecency is not calculated immediately");
  await insertVisit(TEST_URL);
  let frecency = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(frecency, originalFrecency, "frecency is unchanged");
  recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(recalc, 1, "frecency needs a recalc");

  info("Check setting frecency resets recalc_frecency");
  await resetFrecency(TEST_URL);
  recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(recalc, 0, "frecency doesn't need a recalc");

  info("Removing a visit sets recalc_frecency");
  await removeVisit(TEST_URL);
  frecency = await PlacesTestUtils.getDatabaseValue("moz_places", "frecency", {
    url: TEST_URL,
  });
  Assert.equal(frecency, -1, "frecency is unchanged");
  recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(recalc, 1, "frecency needs a recalc");

  await PlacesUtils.history.clear();
  await PlacesUtils.bookmarks.remove(bm);
});

add_task(async function test_bookmark() {
  // First add a visit so the page is not orphaned.
  await PlacesTestUtils.addVisits([TEST_URL, TEST_URL_2]);

  let originalFrecency = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.greater(originalFrecency, 0);

  info("Check adding a bookmark sets recalc_frecency");
  let bm = await PlacesUtils.bookmarks.insert({
    url: TEST_URL,
    parentGuid: PlacesUtils.bookmarks.toolbarGuid,
  });

  let frecency = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(frecency, originalFrecency, "frecency is unchanged");
  let recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(recalc, 1, "frecency needs a recalc");

  info("Check changing a bookmark url sets recalc_frecency on both urls");
  await PlacesUtils.bookmarks.update({
    guid: bm.guid,
    url: TEST_URL_2,
  });
  frecency = await PlacesTestUtils.getDatabaseValue("moz_places", "frecency", {
    url: TEST_URL,
  });
  Assert.equal(frecency, originalFrecency, "frecency is unchanged");
  recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(recalc, 1, "frecency needs a recalc");
  frecency = await PlacesTestUtils.getDatabaseValue("moz_places", "frecency", {
    url: TEST_URL_2,
  });
  Assert.ok(frecency > 0, "frecency is valid");
  recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL_2,
    }
  );
  Assert.equal(recalc, 1, "frecency needs a recalc");

  info("Check setting frecency resets recalc_frecency");
  await resetFrecency(TEST_URL);
  recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(recalc, 0, "frecency doesn't need a recalc");
  await resetFrecency(TEST_URL_2);
  recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL_2,
    }
  );
  Assert.equal(recalc, 0, "frecency doesn't need a recalc");

  info("Removing a bookmark sets recalc_frecency");
  await PlacesUtils.bookmarks.remove(bm.guid);
  frecency = await PlacesTestUtils.getDatabaseValue("moz_places", "frecency", {
    url: TEST_URL,
  });
  Assert.equal(frecency, -1, "frecency is unchanged");
  recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL,
    }
  );
  Assert.equal(recalc, 0, "frecency doesn't need a recalc");
  frecency = await PlacesTestUtils.getDatabaseValue("moz_places", "frecency", {
    url: TEST_URL_2,
  });
  Assert.equal(frecency, -1, "frecency is unchanged");
  recalc = await PlacesTestUtils.getDatabaseValue(
    "moz_places",
    "recalc_frecency",
    {
      url: TEST_URL_2,
    }
  );
  Assert.equal(recalc, 1, "frecency needs a recalc");

  await PlacesUtils.history.clear();
});

add_task(async function test_bookmark_frecency_zero() {
  info("A url with frecency 0 should be recalculated if bookmarked");
  let url = "https://zerofrecency.org/";
  await PlacesTestUtils.addVisits({ url, transition: TRANSITION_FRAMED_LINK });
  Assert.equal(
    await PlacesTestUtils.getDatabaseValue("moz_places", "frecency", { url }),
    0
  );
  Assert.equal(
    await PlacesTestUtils.getDatabaseValue("moz_places", "recalc_frecency", {
      url,
    }),
    0
  );
  await PlacesUtils.bookmarks.insert({
    url,
    parentGuid: PlacesUtils.bookmarks.toolbarGuid,
  });
  Assert.equal(
    await PlacesTestUtils.getDatabaseValue("moz_places", "recalc_frecency", {
      url,
    }),
    1
  );
  info("place: uris should not be recalculated");
  url = "place:test";
  await PlacesUtils.bookmarks.insert({
    url,
    parentGuid: PlacesUtils.bookmarks.toolbarGuid,
  });
  Assert.equal(
    await PlacesTestUtils.getDatabaseValue("moz_places", "frecency", { url }),
    0
  );
  Assert.equal(
    await PlacesTestUtils.getDatabaseValue("moz_places", "recalc_frecency", {
      url,
    }),
    0
  );
});