settings/storage_migrations/
v1653667210_light_migration_teardown.rs

1// Copyright 2022 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::migration::{FileGenerator, Migration, MigrationError};
6use anyhow::{anyhow, Context};
7use fidl::endpoints::create_proxy;
8use fidl_fuchsia_stash::StoreProxy;
9
10const LIGHT_KEY: &str = "settings_light_info";
11
12/// Deletes old Light settings data from stash.
13pub(crate) struct V1653667210LightMigrationTeardown(pub(crate) StoreProxy);
14
15#[async_trait::async_trait(?Send)]
16impl Migration for V1653667210LightMigrationTeardown {
17    fn id(&self) -> u64 {
18        1653667210
19    }
20
21    async fn migrate(&self, _: FileGenerator) -> Result<(), MigrationError> {
22        let (stash_proxy, server_end) = create_proxy();
23        self.0.create_accessor(false, server_end).expect("failed to create accessor for stash");
24        stash_proxy.delete_value(LIGHT_KEY).context("failed to call delete_value")?;
25        stash_proxy.commit().context("failed to commit deletion of old light key")?;
26        drop(stash_proxy);
27
28        let (stash_proxy, server_end) = create_proxy();
29        self.0.create_accessor(true, server_end).expect("failed to create accessor for stash");
30        let value = stash_proxy.get_value(LIGHT_KEY).await.context("failed to call get_value")?;
31        if value.is_some() {
32            Err(MigrationError::Unrecoverable(anyhow!("failed to delete stash data")))
33        } else {
34            Ok(())
35        }
36    }
37}
38
39#[cfg(test)]
40mod tests {
41    use super::*;
42    use crate::storage_migrations::tests::open_tempdir;
43    use assert_matches::assert_matches;
44    use fidl_fuchsia_stash::{StoreAccessorRequest, StoreMarker, StoreRequest, Value};
45    use fuchsia_async as fasync;
46    use futures::StreamExt;
47    use std::rc::Rc;
48    use std::sync::atomic::{AtomicBool, Ordering};
49
50    // Ensure the teardown deletes and commits the deletion of data from stash.
51    #[fuchsia::test]
52    async fn v1653667208_light_migration_teardown_test() {
53        let (store_proxy, server_end) = create_proxy::<StoreMarker>();
54        let mut request_stream = server_end.into_stream();
55        let commit_called = Rc::new(AtomicBool::new(false));
56        let task = fasync::Task::local({
57            let commit_called = Rc::clone(&commit_called);
58            async move {
59                let mut tasks = vec![];
60                while let Some(Ok(request)) = request_stream.next().await {
61                    if let StoreRequest::CreateAccessor { accessor_request, .. } = request {
62                        let mut request_stream = accessor_request.into_stream();
63                        tasks.push(fasync::Task::local({
64                            let commit_called = Rc::clone(&commit_called);
65                            async move {
66                                while let Some(Ok(request)) = request_stream.next().await {
67                                    match request {
68                                        StoreAccessorRequest::DeleteValue { key, .. } => {
69                                            assert_eq!(key, LIGHT_KEY);
70                                        }
71                                        StoreAccessorRequest::Commit { .. } => {
72                                            commit_called.store(true, Ordering::SeqCst);
73                                        }
74                                        StoreAccessorRequest::GetValue { key, responder } => {
75                                            assert_eq!(key, LIGHT_KEY);
76                                            responder
77                                                .send(None)
78                                                .expect("should be able to send response");
79                                        }
80                                        _ => panic!("unexpected request: {request:?}"),
81                                    }
82                                }
83                            }
84                        }))
85                    }
86                }
87                for task in tasks {
88                    task.await
89                }
90            }
91        });
92
93        let migration = V1653667210LightMigrationTeardown(store_proxy);
94        let fs = tempfile::tempdir().expect("failed to create tempdir");
95        let directory = open_tempdir(&fs);
96        let file_generator = FileGenerator::new(0, migration.id(), Clone::clone(&directory));
97        assert_matches!(migration.migrate(file_generator).await, Ok(()));
98
99        drop(migration);
100
101        task.await;
102        assert!(commit_called.load(Ordering::SeqCst));
103    }
104
105    // Ensure we report an unrecoverable error if we're unable to delete the data from stash.
106    #[fuchsia::test]
107    async fn v1653667208_light_migration_teardown_commit_fails() {
108        let (store_proxy, server_end) = create_proxy::<StoreMarker>();
109        let mut request_stream = server_end.into_stream();
110        let task = fasync::Task::local(async move {
111            let mut tasks = vec![];
112            while let Some(Ok(request)) = request_stream.next().await {
113                if let StoreRequest::CreateAccessor { accessor_request, .. } = request {
114                    let mut request_stream = accessor_request.into_stream();
115                    tasks.push(fasync::Task::local(async move {
116                        while let Some(Ok(request)) = request_stream.next().await {
117                            match request {
118                                StoreAccessorRequest::DeleteValue { .. } => {
119                                    // no-op
120                                }
121                                StoreAccessorRequest::Commit { .. } => {
122                                    // no-op
123                                }
124                                StoreAccessorRequest::GetValue { key, responder } => {
125                                    assert_eq!(key, LIGHT_KEY);
126                                    responder
127                                        .send(Some(Value::Stringval("data".to_owned())))
128                                        .expect("should be able to send response");
129                                }
130                                _ => panic!("unexpected request: {request:?}"),
131                            }
132                        }
133                    }))
134                }
135            }
136            for task in tasks {
137                task.await
138            }
139        });
140
141        let migration = V1653667210LightMigrationTeardown(store_proxy);
142        let fs = tempfile::tempdir().expect("failed to create tempdir");
143        let directory = open_tempdir(&fs);
144        let file_generator = FileGenerator::new(0, migration.id(), Clone::clone(&directory));
145        let result = migration.migrate(file_generator).await;
146        assert_matches!(result, Err(MigrationError::Unrecoverable(_)));
147        assert!(format!("{:?}", result.unwrap_err()).contains("failed to delete stash data"));
148
149        drop(migration);
150
151        task.await;
152    }
153}
settings/storage_migrations/v1653667210_light_migration_teardown.rs

settings/storage_migrations/
v1653667210_light_migration_teardown.rs
