Skip to content

Bug 1974122 - keywords_i18n needs to be updated when records are deleted and on clear_database #6815

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0c0w3 merged 1 commit into from
Jun 26, 2025
Merged

Bug 1974122 - keywords_i18n needs to be updated when records are deleted and on clear_database #6815

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 187 additions & 1 deletion components/suggest/src/db.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1203,6 +1203,11 @@ impl<'a> SuggestDao<'a> {
named_params! { ":record_id": record_id.as_str() },
)?;
self.scope.err_if_interrupted()?;
self.conn.execute_cached(
"DELETE FROM keywords_i18n WHERE suggestion_id IN (SELECT id from suggestions WHERE record_id = :record_id)",
named_params! { ":record_id": record_id.as_str() },
)?;
self.scope.err_if_interrupted()?;
self.conn.execute_cached(
"DELETE FROM full_keywords WHERE suggestion_id IN (SELECT id from suggestions WHERE record_id = :record_id)",
named_params! { ":record_id": record_id.as_str() },
Expand Down Expand Up @@ -1886,7 +1891,7 @@ fn provider_config_meta_key(provider: SuggestionProvider) -> String {
#[cfg(test)]
mod tests {
use super::*;
use crate::{store::tests::TestStore, testing::*};
use crate::{store::tests::TestStore, testing::*, SuggestIngestionConstraints};

#[test]
fn keywords_metrics_updater() -> anyhow::Result<()> {
Expand Down Expand Up @@ -2005,4 +2010,185 @@ mod tests {

Ok(())
}

// Keywords in `keywords_i18n` should be dropped when their records are
// deleted.
#[test]
fn keywords_i18n_delete_record() -> anyhow::Result<()> {
// Add some records whose keywords are stored in `keywords_i18n`. We'll
// use weather records.
let kws_1 = ["aaa", "bbb", "ccc"];
let kws_2 = ["yyy", "zzz"];
let mut store = TestStore::new(
MockRemoteSettingsClient::default()
.with_record(SuggestionProvider::Weather.record(
"weather-1",
json!({
"score": 0.24,
"keywords": kws_1,
}),
))
.with_record(SuggestionProvider::Weather.record(
"weather-2",
json!({
"score": 0.24,
"keywords": kws_2,
}),
)),
);
store.ingest(SuggestIngestionConstraints {
providers: Some(vec![SuggestionProvider::Weather]),
..SuggestIngestionConstraints::all_providers()
});

// Make sure all keywords are present.
assert_eq!(
store.count_rows("keywords_i18n") as usize,
kws_1.len() + kws_2.len()
);

for q in kws_1.iter().chain(kws_2.iter()) {
assert_eq!(
store.fetch_suggestions(SuggestionQuery::weather(q)),
vec![Suggestion::Weather {
score: 0.24,
city: None,
}],
"query: {:?}",
q
);
}

// Delete the first record.
store
.client_mut()
.delete_record(SuggestionProvider::Weather.empty_record("weather-1"));
store.ingest(SuggestIngestionConstraints {
providers: Some(vec![SuggestionProvider::Weather]),
..SuggestIngestionConstraints::all_providers()
});

// Its keywords should be dropped and the keywords from the second
// record should still be present.
assert_eq!(store.count_rows("keywords_i18n") as usize, kws_2.len());

for q in kws_1 {
assert_eq!(
store.fetch_suggestions(SuggestionQuery::weather(q)),
vec![],
"query: {:?}",
q
);
}
for q in kws_2 {
assert_eq!(
store.fetch_suggestions(SuggestionQuery::weather(q)),
vec![Suggestion::Weather {
score: 0.24,
city: None,
}],
"query: {:?}",
q
);
}

Ok(())
}

// Keywords in `keywords_i18n` should be dropped when their records are
// updated and the keywords are no longer present, and new keywords should
// be added.
#[test]
fn keywords_i18n_update_record() -> anyhow::Result<()> {
// Add some records whose keywords are stored in `keywords_i18n`. We'll
// use weather records.
let kws_1 = ["aaa", "bbb", "ccc"];
let kws_2 = ["yyy", "zzz"];
let mut store = TestStore::new(
MockRemoteSettingsClient::default()
.with_record(SuggestionProvider::Weather.record(
"weather-1",
json!({
"score": 0.24,
"keywords": kws_1,
}),
))
.with_record(SuggestionProvider::Weather.record(
"weather-2",
json!({
"score": 0.24,
"keywords": kws_2,
}),
)),
);
store.ingest(SuggestIngestionConstraints {
providers: Some(vec![SuggestionProvider::Weather]),
..SuggestIngestionConstraints::all_providers()
});

// Make sure all keywords are present.
assert_eq!(
store.count_rows("keywords_i18n") as usize,
kws_1.len() + kws_2.len()
);

for q in kws_1.iter().chain(kws_2.iter()) {
assert_eq!(
store.fetch_suggestions(SuggestionQuery::weather(q)),
vec![Suggestion::Weather {
score: 0.24,
city: None,
}],
"query: {:?}",
q
);
}

// Update the first record.
let kws_1_new = [
"bbb", // keyword from the old record
"mmm", // new keyword
];
store
.client_mut()
.update_record(SuggestionProvider::Weather.record(
"weather-1",
json!({
"score": 0.24,
"keywords": kws_1_new,
}),
));
store.ingest(SuggestIngestionConstraints {
providers: Some(vec![SuggestionProvider::Weather]),
..SuggestIngestionConstraints::all_providers()
});

// Check all keywords.
assert_eq!(
store.count_rows("keywords_i18n") as usize,
kws_1_new.len() + kws_2.len()
);

for q in ["aaa", "ccc"] {
assert_eq!(
store.fetch_suggestions(SuggestionQuery::weather(q)),
vec![],
"query: {:?}",
q
);
}
for q in kws_1_new.iter().chain(kws_2.iter()) {
assert_eq!(
store.fetch_suggestions(SuggestionQuery::weather(q)),
vec![Suggestion::Weather {
score: 0.24,
city: None,
}],
"query: {:?}",
q
);
}

Ok(())
}
}
4 changes: 4 additions & 0 deletions components/suggest/src/schema.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -815,6 +815,9 @@ impl ConnectionInitializer for SuggestConnectionInitializer<'_> {

/// Clears the database, removing all suggestions, icons, and metadata.
pub fn clear_database(db: &Connection) -> rusqlite::Result<()> {
// If you update this, you probably need to update
// `SuggestDao::drop_suggestions` too!

db.execute_batch(
"
DELETE FROM meta;
Expand All @@ -833,6 +836,7 @@ pub fn clear_database(db: &Connection) -> rusqlite::Result<()> {
"geonames",
"geonames_metrics",
"ingested_records",
"keywords_i18n",
"keywords_metrics",
];
for t in conditional_tables {
Expand Down
10 changes: 9 additions & 1 deletion components/suggest/src/store.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1708,16 +1708,24 @@ pub(crate) mod tests {
SuggestionProvider::Amp.record("data-2", json!([good_place_eats_amp()])),
)
.with_record(SuggestionProvider::Amp.icon(los_pollos_icon()))
.with_record(SuggestionProvider::Amp.icon(good_place_eats_icon())),
.with_record(SuggestionProvider::Amp.icon(good_place_eats_icon()))
.with_record(
SuggestionProvider::Weather
.record("weather-1", json!({ "keywords": ["abcde"], })),
),
);
store.ingest(SuggestIngestionConstraints::all_providers());
assert!(store.count_rows("suggestions") > 0);
assert!(store.count_rows("keywords") > 0);
assert!(store.count_rows("keywords_i18n") > 0);
assert!(store.count_rows("keywords_metrics") > 0);
assert!(store.count_rows("icons") > 0);

store.inner.clear()?;
assert!(store.count_rows("suggestions") == 0);
assert!(store.count_rows("keywords") == 0);
assert!(store.count_rows("keywords_i18n") == 0);
assert!(store.count_rows("keywords_metrics") == 0);
assert!(store.count_rows("icons") == 0);

Ok(())
Expand Down