Put example CLI data in one place

This is another change that I thought of when trying to code up the
example component.  What if we put all the CLI databases in one place.
That way, we don't need to keep adding stuff to the .gitignore file and
it keeps things a bit tidier.

Also, add code in `cli-support` to do this with some extra capabilities
like finding the workspace root and creating directories if they don't exist.

Changed some examples to use the new system, but not all of them.
From what I could tell, things like `sync-pass` don't create their own
database.  Instead, they're intended to use an existing database file,
maybe one that you copied using `adb`.

Author: bendk

.gitignore

@@ -1,6 +1,6 @@
 website/build
 target
-credentials.json
+/.cli-data
 logins.jwk
 *-engine.json
 *.db
@@ -74,9 +74,6 @@ fml.py
 *.dylib
 *.so
 
-# Generated by remote-settings-cli
-remote-settings-data
-
 # Build static website files
 automation/swift-components-docs/.build
 automation/swift-components-docs/docs

Cargo.lock

@@ -48,13 +48,8 @@ fn update_i64(field_name: &str, field: i64) -> i64 {
 #[structopt(name = "autofill-utils", about = "Command-line utilities for autofill")]
 pub struct Opts {
     /// Sets the path to the database
-    #[structopt(
-        name = "database_path",
-        long,
-        short = "d",
-        default_value = "./autofill.db"
-    )]
-    pub database_path: String,
+    #[structopt(name = "database_path", long, short = "d")]
+    pub database_path: Option<String>,
 
     /// Disables all logging (useful for performance evaluation)
     #[structopt(name = "no-logging", long)]
@@ -496,10 +491,13 @@ fn main() -> Result<()> {
         cli_support::init_trace_logging();
     }
 
-    let db_path = opts.database_path.clone();
-    let store = Store::new(db_path)?;
+    let db_path = opts
+        .database_path
+        .clone()
+        .unwrap_or_else(|| cli_support::cli_data_path("autofill.db"));
+    let store = Store::new(&db_path)?;
 
-    let key = get_encryption_key(&store, &opts.database_path, &opts)?;
+    let key = get_encryption_key(&store, &db_path, &opts)?;
     log::trace!("Using encryption key {}", key);
 
     match opts.cmd {

examples/autofill-utils/src/autofill-utils.rs

@@ -5,6 +5,8 @@
 #![allow(unknown_lints)]
 #![warn(rust_2018_idioms)]
 
+use std::path::{Path, PathBuf};
+
 pub mod fxa_creds;
 pub mod prompt;
 
@@ -27,3 +29,37 @@ pub fn init_logging() {
         "info"
     })
 }
+
+pub fn cli_data_dir() -> String {
+    data_path(None).to_string_lossy().to_string()
+}
+
+pub fn cli_data_subdir(relative_path: &str) -> String {
+    data_path(Some(relative_path)).to_string_lossy().to_string()
+}
+
+pub fn cli_data_path(filename: &str) -> String {
+    data_path(None).join(filename).to_string_lossy().to_string()
+}
+
+fn data_path(relative_path: Option<&str>) -> PathBuf {
+    let dir = workspace_root_dir().join(".cli-data");
+    let dir = match relative_path {
+        None => dir,
+        Some(relative_path) => dir.join(relative_path),
+    };
+    std::fs::create_dir_all(&dir).expect("Error creating dir {dir:?}");
+    dir
+}
+
+pub fn workspace_root_dir() -> PathBuf {
+    let cargo_output = std::process::Command::new(env!("CARGO"))
+        .arg("locate-project")
+        .arg("--workspace")
+        .arg("--message-format=plain")
+        .output()
+        .unwrap()
+        .stdout;
+    let cargo_toml_path = Path::new(std::str::from_utf8(&cargo_output).unwrap().trim());
+    cargo_toml_path.parent().unwrap().to_path_buf()
+}

examples/cli-support/src/lib.rs

@@ -11,7 +11,7 @@ use clap::{Parser, Subcommand, ValueEnum};
 use cli_support::fxa_creds;
 use fxa_client::{FirefoxAccount, FxaConfig, FxaServer};
 
-static CREDENTIALS_PATH: &str = "credentials.json";
+static CREDENTIALS_FILENAME: &str = "credentials.json";
 static CLIENT_ID: &str = "a2270f727f45f648";
 static REDIRECT_URI: &str = "https://accounts.firefox.com/oauth/success/a2270f727f45f648";
 
@@ -111,10 +111,14 @@ fn load_account(cli: &Cli, scopes: &[&str]) -> Result<FirefoxAccount> {
         client_id: CLIENT_ID.into(),
         token_server_url_override: None,
     };
-    fxa_creds::get_cli_fxa(config, CREDENTIALS_PATH, scopes).map(|cli| cli.account)
+    fxa_creds::get_cli_fxa(config, &credentials_path(), scopes).map(|cli| cli.account)
 }
 
 pub fn persist_fxa_state(acct: &FirefoxAccount) -> Result<()> {
     let json = acct.to_json().unwrap();
-    Ok(fs::write(CREDENTIALS_PATH, json)?)
+    Ok(fs::write(credentials_path(), json)?)
+}
+
+fn credentials_path() -> String {
+    cli_support::cli_data_path(CREDENTIALS_FILENAME)
 }

examples/fxa-client/src/main.rs

@@ -15,7 +15,7 @@ use sync15::engine::SyncEngineId;
 
 use anyhow::{bail, Result};
 
-static CREDENTIALS_PATH: &str = "credentials.json";
+static CREDENTIALS_PATH: &str = ".cli-data/credentials.json";
 
 #[derive(Parser)]
 #[command(about, long_about = None)]
@@ -34,6 +34,9 @@ struct Cli {
 fn main() -> Result<()> {
     let cli = Cli::parse();
     viaduct_reqwest::use_reqwest_backend();
+    if let Some(dir) = std::path::PathBuf::from(CREDENTIALS_PATH).parent() {
+        std::fs::create_dir_all(dir)?;
+    }
     let mut builder = Builder::new();
     builder.filter_level(log::LevelFilter::Info);
     if cli.verbose {

examples/relevancy-cli/src/main.rs

@@ -10,6 +10,7 @@ name = "dump"
 path = "src/dump/lib.rs"
 
 [dependencies]
+cli-support = { path = "../cli-support" }
 remote_settings = { features = ["signatures"], path = "../../components/remote_settings" }
 viaduct-reqwest = { path = "../../components/support/viaduct-reqwest" }
 log = "0.4"

examples/remote-settings-cli/Cargo.toml

@@ -117,12 +117,11 @@ fn build_service(cli: &Cli) -> Result<RemoteSettingsService> {
         }),
         bucket_name: cli.bucket.clone(),
     };
-    Ok(RemoteSettingsService::new(
-        cli.storage_dir
-            .clone()
-            .unwrap_or_else(|| "remote-settings-data".into()),
-        config,
-    )?)
+    let storage_dir = cli
+        .storage_dir
+        .clone()
+        .unwrap_or_else(|| cli_support::cli_data_subdir("remote-settings-data"));
+    Ok(RemoteSettingsService::new(storage_dir, config)?)
 }
 
 fn sync(service: RemoteSettingsService, collections: Vec<String>) -> Result<()> {

examples/remote-settings-cli/src/main.rs

@@ -6,6 +6,7 @@ edition = "2021"
 publish = false
 
 [dependencies]
+cli-support = { path = "../cli-support" }
 remote_settings = { path = "../../components/remote_settings" }
 viaduct-reqwest = { path = "../../components/support/viaduct-reqwest" }
 log = "0.4"

examples/suggest-cli/Cargo.toml

@@ -13,7 +13,7 @@ use suggest::{
     SuggestionProvider, SuggestionProviderConstraints, SuggestionQuery,
 };
 
-static DB_PATH: &str = "suggest.db";
+static DB_FILENAME: &str = "suggest.db";
 
 const DEFAULT_LOG_FILTER: &str = "suggest::store=info";
 const DEFAULT_LOG_FILTER_VERBOSE: &str = "suggest::store=trace";
@@ -146,7 +146,7 @@ fn main() -> Result<()> {
 
 fn build_store(cli: &Cli) -> Arc<SuggestStore> {
     Arc::new(SuggestStoreBuilder::default())
-        .data_path(DB_PATH.to_string())
+        .data_path(cli_support::cli_data_path(DB_FILENAME))
         .remote_settings_server(match cli.remote_settings_server {
             None => RemoteSettingsServer::Prod,
             Some(RemoteSettingsServerArg::Dev) => RemoteSettingsServer::Dev,