Synced tabs now includes more metadata about tab, tab-groups and windows on a device. (#7089)

Author: mhammond

components/tabs/README.md

@@ -33,7 +33,14 @@ on the request and re-upload its tabs.
 
 ## Payload format
 
-Every remote sync record is roughly a list of tabs with their URL history (think of the back button). There is one record for each client.
+The sync payload has 3 distinct concepts:
+
+* Tabs: a title, a URL history (think back button), whether it is pinned/active etc, if it is in a tab group, etc.
+* Windows: So remote clients can display our tabs based on Window.
+* Tab groups: So tab-groups can be recreated (or at last reflected) on remote devices.
+
+These are distinct data-structures - eg, a tab has a "window id" and a "tab group id", and there
+are separate maps for these groups and windows.
 
 ### Association with device IDs
 

components/tabs/src/lib.rs

@@ -30,7 +30,7 @@ uniffi::custom_type!(TabsGuid, String, {
     lower: |obj| obj.into(),
 });
 
-pub use crate::storage::{ClientRemoteTabs, RemoteTabRecord, TabsDeviceType};
+pub use crate::storage::{ClientRemoteTabs, LocalTabsInfo, RemoteTabRecord, TabsDeviceType};
 pub use crate::store::{RemoteCommandStore, TabsStore};
 pub use error::{ApiResult, Error, Result, TabsApiError};
 use sync15::DeviceType;

components/tabs/src/storage.rs

@@ -37,6 +37,15 @@ pub struct RemoteTabRecord {
     pub last_used: i64, // In ms.
     #[uniffi(default = false)]
     pub inactive: bool,
+    #[uniffi(default = false)]
+    pub pinned: bool,
+    /// The index within the window_id.
+    #[uniffi(default = 0)]
+    pub index: u32,
+    #[uniffi(default = "")]
+    pub window_id: String,
+    #[uniffi(default = "")]
+    pub tab_group_id: String,
 }
 pub type RemoteTab = RemoteTabRecord;
 
@@ -49,6 +58,54 @@ pub struct ClientRemoteTabs {
     /// Number of ms since the unix epoch (as reported by the server's clock)
     pub last_modified: i64,
     pub remote_tabs: Vec<RemoteTab>,
+    pub tab_groups: HashMap<String, TabGroup>,
+    pub windows: HashMap<String, Window>,
+}
+
+#[derive(uniffi::Enum, Clone, Debug, Default)]
+#[repr(u8)]
+pub enum WindowType {
+    #[default]
+    Normal = 0,
+}
+
+impl From<u8> for WindowType {
+    fn from(value: u8) -> Self {
+        match value {
+            0 => WindowType::Normal,
+            _ => {
+                warn!("Unknown window type {}, defaulting to Normal", value);
+                WindowType::Normal
+            }
+        }
+    }
+}
+
+#[derive(uniffi::Record, Debug, Clone)]
+#[cfg_attr(test, derive(Default))]
+pub struct Window {
+    pub id: String,
+    pub last_used: Timestamp,
+    pub index: u32,
+    pub window_type: WindowType,
+}
+
+/// A tab-group, representing a session store `TabGroupStateData`.
+#[derive(uniffi::Record, Debug, Clone)]
+#[cfg_attr(test, derive(Default))]
+pub struct TabGroup {
+    pub id: String,
+    pub name: String,
+    pub color: String,
+    pub collapsed: bool,
+}
+
+// This is what we expect clients to supply as their own tabs.
+#[derive(uniffi::Record, Debug, Clone, Default)]
+pub struct LocalTabsInfo {
+    pub tabs: Vec<RemoteTab>,
+    pub tab_groups: HashMap<String, TabGroup>,
+    pub windows: HashMap<String, Window>,
 }
 
 pub(crate) enum DbConnection {
@@ -70,7 +127,7 @@ pub(crate) enum DbConnection {
 // (Note however we don't attempt to remove the database when no remote tabs exist, so having
 // no remote tabs in an existing DB is also a normal situation)
 pub struct TabsStorage {
-    pub(crate) local_tabs: RefCell<Option<Vec<RemoteTab>>>,
+    pub(crate) local_tabs: RefCell<Option<LocalTabsInfo>>,
     db_path: PathBuf,
     db_connection: DbConnection,
 }
@@ -159,8 +216,8 @@ impl TabsStorage {
         }
     }
 
-    pub fn update_local_state(&mut self, local_state: Vec<RemoteTab>) {
-        let num_tabs = local_state.len();
+    pub fn update_local_state(&mut self, local_state: LocalTabsInfo) {
+        let num_tabs = local_state.tabs.len();
         self.local_tabs.borrow_mut().replace(local_state);
         info!("update_local_state has {num_tabs} tab entries");
     }
@@ -761,14 +818,7 @@ mod tests {
                 guid: "device-1".to_string(),
                 record: TabsRecord {
                     id: "device-1".to_string(),
-                    client_name: "Device #1".to_string(),
-                    tabs: vec![TabsRecordTab {
-                        title: "the title".to_string(),
-                        url_history: vec!["https://mozilla.org/".to_string()],
-                        icon: Some("https://mozilla.org/icon".to_string()),
-                        last_used: 1643764207000,
-                        ..Default::default()
-                    }],
+                    ..Default::default()
                 },
                 last_modified: 1643764207000,
             },
@@ -777,13 +827,7 @@ mod tests {
                 record: TabsRecord {
                     id: "device-outdated".to_string(),
                     client_name: "Device outdated".to_string(),
-                    tabs: vec![TabsRecordTab {
-                        title: "the title".to_string(),
-                        url_history: vec!["https://mozilla.org/".to_string()],
-                        icon: Some("https://mozilla.org/icon".to_string()),
-                        last_used: 1643764207000,
-                        ..Default::default()
-                    }],
+                    ..Default::default()
                 },
                 last_modified: 1443764207000, // old
             },
@@ -918,6 +962,7 @@ mod tests {
                         last_used: 1711929600015, // 4/1/2024
                         ..Default::default()
                     }],
+                    ..Default::default()
                 },
                 last_modified: 1711929600015, // 4/1/2024
             },
@@ -952,6 +997,7 @@ mod tests {
                             ..Default::default()
                         },
                     ],
+                    ..Default::default()
                 },
                 last_modified: 1711929600015, // 4/1/2024
             },
@@ -1100,11 +1146,11 @@ mod tests {
         let new_records = vec![(
             TabsRecord {
                 id: "device-not-synced".to_string(),
-                client_name: "".to_string(),
                 tabs: vec![TabsRecordTab {
                     url_history: vec!["https://example2.com".to_string()],
                     ..Default::default()
                 }],
+                ..Default::default()
             },
             ServerTimestamp::from_millis(now.as_millis_i64()),
         )];
@@ -1175,7 +1221,6 @@ mod tests {
         let new_records = vec![(
             TabsRecord {
                 id: "device-recent".to_string(),
-                client_name: "".to_string(),
                 tabs: vec![
                     TabsRecordTab {
                         url_history: vec!["https://example99.com".to_string()],
@@ -1186,6 +1231,7 @@ mod tests {
                         ..Default::default()
                     },
                 ],
+                ..Default::default()
             },
             ServerTimestamp::default(),
         )];
@@ -1331,11 +1377,11 @@ mod tests {
         let new_records = vec![(
             TabsRecord {
                 id: "device-1".to_string(),
-                client_name: "".to_string(),
                 tabs: vec![TabsRecordTab {
                     url_history: vec!["https://example1.com".to_string()],
                     ..Default::default()
                 }],
+                ..Default::default()
             },
             ServerTimestamp::default(),
         )];

components/tabs/src/store.rs

@@ -2,8 +2,9 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-use crate::storage::{ClientRemoteTabs, RemoteTab, TabsStorage};
+use crate::storage::{ClientRemoteTabs, LocalTabsInfo, RemoteTab, TabsStorage};
 use crate::{ApiResult, PendingCommand, RemoteCommand};
+use std::collections::HashMap;
 use std::path::Path;
 use std::sync::{Arc, Mutex};
 
@@ -31,8 +32,18 @@ impl TabsStore {
         self.storage.lock().unwrap().close()
     }
 
+    /// For when we have no concept of tab groups or windows.
+    /// Deprecated for desktop, hopefully one day deprecated on mobile.
     pub fn set_local_tabs(&self, local_state: Vec<RemoteTab>) {
-        self.storage.lock().unwrap().update_local_state(local_state);
+        self.set_local_tabs_info(LocalTabsInfo {
+            tabs: local_state,
+            tab_groups: HashMap::new(),
+            windows: HashMap::new(),
+        })
+    }
+
+    pub fn set_local_tabs_info(&self, info: LocalTabsInfo) {
+        self.storage.lock().unwrap().update_local_state(info);
     }
 
     // like remote_tabs, but serves the uniffi layer

components/tabs/src/sync/engine.rs

@@ -54,6 +54,16 @@ impl ClientRemoteTabs {
             device_type: remote_client.device_type,
             last_modified: last_modified.as_millis(),
             remote_tabs: record.tabs.into_iter().map(Into::into).collect(),
+            tab_groups: record
+                .tab_groups
+                .into_iter()
+                .map(|(n, v)| (n, v.into()))
+                .collect(),
+            windows: record
+                .windows
+                .into_iter()
+                .map(|(n, v)| (n, v.into()))
+                .collect(),
         }
     }
 }
@@ -167,7 +177,7 @@ impl SyncEngine for TabsEngine {
             }
         };
 
-        let Some(ref tabs) = *storage.local_tabs.borrow() else {
+        let Some(ref tabs_info) = *storage.local_tabs.borrow() else {
             // It's a less than ideal outcome if at startup (or any time) we are asked to
             // sync tabs before the app has told us what the tabs are, so make noise, but
             // don't actually write that we have no tabs.
@@ -183,7 +193,22 @@ impl SyncEngine for TabsEngine {
         let mut record = TabsRecord {
             id: local_id.clone(),
             client_name,
-            tabs: tabs.iter().map(Clone::clone).map(Into::into).collect(),
+            tabs: tabs_info
+                .tabs
+                .iter()
+                .map(Clone::clone)
+                .map(Into::into)
+                .collect(),
+            windows: tabs_info
+                .windows
+                .iter()
+                .map(|(n, v)| (n.clone(), v.clone().into()))
+                .collect(),
+            tab_groups: tabs_info
+                .tab_groups
+                .iter()
+                .map(|(n, v)| (n.clone(), v.clone().into()))
+                .collect(),
         };
         super::prepare_for_upload(&mut record);
 

components/tabs/src/sync/mod.rs

@@ -42,7 +42,6 @@ pub fn prepare_for_upload(record: &mut TabsRecord) {
                     sanitized_history.push(url);
                 }
             }
-
             tab.url_history = sanitized_history;
             // Potentially truncate the title to some limit
             tab.title = slice_up_to(tab.title, MAX_TITLE_CHAR_LENGTH);
@@ -51,7 +50,14 @@ pub fn prepare_for_upload(record: &mut TabsRecord) {
         .collect::<Vec<_>>();
     // Sort the tabs so when we trim tabs it's the oldest tabs
     sanitized_tabs.sort_by(|a, b| b.last_used.cmp(&a.last_used));
-    trim_tabs_length(&mut sanitized_tabs, MAX_PAYLOAD_SIZE);
+    // deduct tab group and window info from the total.
+    let used = payload_support::compute_serialized_size(&record.windows)
+        .unwrap_or_default()
+        .saturating_add(
+            payload_support::compute_serialized_size(&record.tab_groups).unwrap_or_default(),
+        );
+    let size = MAX_PAYLOAD_SIZE.saturating_sub(used);
+    trim_tabs_length(&mut sanitized_tabs, size);
     record.tabs = sanitized_tabs;
     info!("prepare_for_upload found {} tabs", record.tabs.len());
 }
@@ -123,6 +129,7 @@ mod tests {
                 url_history: vec!["https://foo.bar".to_owned()],
                 ..Default::default()
             }],
+            ..Default::default()
         };
         prepare_for_upload(&mut record);
 
@@ -160,6 +167,7 @@ mod tests {
                     ..Default::default()
                 },
             ],
+            ..Default::default()
         };
         prepare_for_upload(&mut record);
         // check we truncated correctly.
@@ -202,7 +210,7 @@ mod tests {
         let mut record = TabsRecord {
             id: "me".to_string(),
             client_name: "name".to_string(),
-            tabs: Vec::new(),
+            ..Default::default()
         };
 
         // Given the example, we know that we can fit 440 tabs of this size.
@@ -260,6 +268,7 @@ mod tests {
                     ..Default::default()
                 },
             ],
+            ..Default::default()
         };
 
         prepare_for_upload(&mut record);