Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions components/remote_settings/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@ mockito = { version = "0.31", default-features = false}
# JSON objects as they get serialized/deserialized.
serde_json = { version = "1", features = ["preserve_order"] }
nss = { path = "../support/rc_crypto/nss" }
tempfile = "3"
135 changes: 134 additions & 1 deletion components/remote_settings/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ impl<C: ApiClient> RemoteSettingsClient<C> {
Ok(())
}

fn reset_storage(&self) -> Result<()> {
pub fn reset_storage(&self) -> Result<()> {
trace!("{0}: reset local storage.", self.collection_name);
let mut inner = self.lock_inner()?;
let collection_url = inner.api_client.collection_url();
Expand Down Expand Up @@ -2482,3 +2482,136 @@ IKdcFKAt3fFrpyMhlfIKkLfmm0iDjmfmIXbDGBJw9SE=
Ok(())
}
}

#[cfg(test)]
mod test_reset_storage {
use super::*;

#[test]
fn test_reset_storage_deletes_records_and_attachments() {
let collection_url = "http://rs.example.com/v1/buckets/main/collections/test-collection";

let mut api_client = MockApiClient::new();
api_client
.expect_collection_url()
.returning(|| collection_url.into());
api_client.expect_is_prod_server().returning(|| Ok(false));

let records = vec![RemoteSettingsRecord {
id: "record-0001".into(),
last_modified: 100,
deleted: false,
attachment: Some(Attachment {
filename: "test-file.bin".into(),
mimetype: "application/octet-stream".into(),
location: "attachments/test-file.bin".into(),
hash: "3a6eb0790f39ac87c94f3856b2dd2c5d110e6811602261a9a923d3bb23adc8b7".into(),
size: 4,
}),
fields: serde_json::Map::new(),
}];

let mut storage = Storage::new(":memory:".into());
storage
.insert_collection_content(collection_url, &records, 100, CollectionMetadata::default())
.expect("Failed to insert records");

storage
.set_attachment(collection_url, "attachments/test-file.bin", b"data")
.expect("Failed to insert attachment");

// Verify data is present before reset
assert!(storage.get_records(collection_url).unwrap().is_some());
assert!(storage
.get_attachment(collection_url, records[0].attachment.clone().unwrap())
.unwrap()
.is_some());

let rs_client = RemoteSettingsClient::new_from_parts(
"test-collection".into(),
storage,
JexlFilter::new(None),
api_client,
);

rs_client.reset_storage().expect("Failed to reset storage");

// After reset, both records and attachments should be gone
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could also test that records/attachments with packaged data are reverted to the packaged versions. I don't think that's totally necessary though, the addition of this test is already great. If you don't want test the packaged data, how about writing a comment mentioning that there could be a test.

Copy link
Contributor Author

@issammani issammani Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 8edd66f

let mut inner = rs_client.inner.lock();
assert_eq!(
inner.storage.get_records(collection_url).unwrap(),
None,
"Records should be deleted after reset_storage"
);
assert_eq!(
inner
.storage
.get_attachment(collection_url, records[0].attachment.clone().unwrap(),)
.unwrap(),
None,
"Attachments should be deleted after reset_storage"
);
}

#[test]
fn test_reset_storage_reverts_to_packaged_data() {
let collection_url = "http://rs.example.com/v1/buckets/main/collections/regions";

let mut api_client = MockApiClient::new();
api_client
.expect_collection_url()
.returning(|| collection_url.into());
// Must be prod for reset_storage to restore packaged data
api_client.expect_is_prod_server().returning(|| Ok(true));

let synced_records = vec![RemoteSettingsRecord {
id: "custom-synced-record".into(),
last_modified: 99999,
deleted: false,
attachment: None,
fields: serde_json::json!({"key": "synced-value"})
.as_object()
.unwrap()
.clone(),
}];

let mut storage = Storage::new(":memory:".into());
storage
.insert_collection_content(
collection_url,
&synced_records,
99999,
CollectionMetadata::default(),
)
.expect("Failed to insert synced records");

// Verify synced data is present
let records_before = storage.get_records(collection_url).unwrap().unwrap();
assert_eq!(records_before[0].id, "custom-synced-record");

let rs_client = RemoteSettingsClient::new_from_parts(
"regions".into(),
storage,
JexlFilter::new(None),
api_client,
);

rs_client.reset_storage().expect("Failed to reset storage");

let mut inner = rs_client.inner.lock();
let records = inner.storage.get_records(collection_url).unwrap();
assert!(
records.is_some(),
"Packaged data should be restored after reset_storage on prod"
);
let records = records.unwrap();
assert!(
!records.is_empty(),
"Packaged regions data should not be empty"
);
assert!(
!records.iter().any(|r| r.id == "custom-synced-record"),
"Synced data should be replaced by packaged data after reset"
);
}
}
5 changes: 5 additions & 0 deletions components/remote_settings/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,11 @@ impl RemoteSettingsClient {
self.internal.sync()
}

#[handle_error(Error)]
pub fn reset_storage(&self) -> ApiResult<()> {
self.internal.reset_storage()
}

/// Shutdown the client, releasing the SQLite connection used to cache records.
pub fn shutdown(&self) {
self.internal.shutdown()
Expand Down
Loading