Remove tpf queries from atomic-cli #610

Author: joepio

CHANGELOG.md

@@ -5,6 +5,10 @@ By far most changes relate to `atomic-server`, so if not specified, assume the c
 Changes to JS assets are not included here, but in [`atomic-data-browser`'s CHANGELOG](https://github.com/atomicdata-dev/atomic-data-browser/blob/main/CHANGELOG.md).
 See [STATUS.md](server/STATUS.md) to learn more about which features will remain stable.
 
+## UNRELEASED
+
+- Remove `tpf` queries from `atomic-cli` #610
+
 ## [v0.34.2] - 2023-03-04
 
 - **Requires `--rebuild-index`**

cli/README.md

@@ -32,7 +32,6 @@ SUBCOMMANDS:
     new        Create a Resource
     remove     Remove a single Atom from a Resource.
     set        Update a single Atom. Creates both the Resource if they don't exist. Overwrites existing.
-    tpf        Finds Atoms using Triple Pattern Fragments.
 
 Visit https://atomicdata.dev for more info
 ```

cli/src/main.rs

@@ -6,7 +6,7 @@ use colored::*;
 use dirs::home_dir;
 use std::{cell::RefCell, path::PathBuf, sync::Mutex};
 
-use crate::print::{print_resource, SERIALIZE_OPTIONS};
+use crate::print::SERIALIZE_OPTIONS;
 
 mod commit;
 mod new;
@@ -115,35 +115,6 @@ fn main() -> AtomicResult<()> {
                     .num_args(1)
                 )
         )
-        .subcommand(
-            Command::new("tpf")
-                    .about("Finds Atoms using Triple Pattern Fragments.",
-                    )
-                    .after_help("\
-                    Filter the store by <subject> <property> and <value>. \
-                    Use a dot to indicate that you don't need to filter. \
-                    Subjects and properties need to be full URLs. \
-                    ")
-                .arg(Arg::new("subject")
-                    .help("The subject URL or bookmark to be filtered by. Use a dot '.' to indicate 'any'.")
-                    .required(true)
-                )
-                .arg(Arg::new("property")
-                    .help("The property URL or bookmark to be filtered by. Use a dot '.' to indicate 'any'.")
-                    .required(true)
-                )
-                .arg(Arg::new("value")
-                    .help("The value URL or bookmark to be filtered by. Use a dot '.' to indicate 'any'.")
-                    .required(true)
-                )
-                .arg(Arg::new("as")
-                    .long("as")
-                    .value_parser(SERIALIZE_OPTIONS)
-                    .default_value("pretty")
-                    .help("Serialization format")
-                    .num_args(1)
-                )
-        )
         .subcommand(
             Command::new("set")
                 .about("Update a single Atom. Creates both the Resource if they don't exist. Overwrites existing.")
@@ -264,9 +235,6 @@ fn exec_command(context: &mut Context) -> AtomicResult<()> {
         Some("set") => {
             commit::set(context)?;
         }
-        Some("tpf") => {
-            tpf(context)?;
-        }
         Some("validate") => {
             validate(context);
         }
@@ -291,30 +259,6 @@ fn list(context: &mut Context) {
     println!("{}", string)
 }
 
-/// Triple Pattern Fragment Query
-fn tpf(context: &Context) -> AtomicResult<()> {
-    let subcommand_matches = context.matches.subcommand_matches("tpf").unwrap();
-    let subject = tpf_value(subcommand_matches.get_one::<String>("subject").unwrap());
-    let property = tpf_value(subcommand_matches.get_one::<String>("property").unwrap());
-    let value = tpf_value(subcommand_matches.get_one::<String>("value").unwrap());
-    let endpoint = format!("{}/tpf", &context.get_write_context().server);
-    let resources =
-        atomic_lib::client::fetch_tpf(&endpoint, subject, property, value, &context.store)?;
-    for r in resources {
-        print_resource(context, &r, subcommand_matches)?;
-    }
-    Ok(())
-}
-
-/// Converts dots to 'None'
-fn tpf_value(string: &str) -> Option<&str> {
-    if string == "." {
-        None
-    } else {
-        Some(string)
-    }
-}
-
 /// Validates the store
 fn validate(context: &mut Context) {
     let reportstring = context.store.validate().to_string();

lib/src/client.rs

@@ -78,32 +78,6 @@ pub fn fetch_body(url: &str, content_type: &str, for_agent: Option<Agent>) -> At
     Ok(body)
 }
 
-/// Uses a TPF endpoint, returns a Vector of matching resources
-pub fn fetch_tpf(
-    endpoint: &str,
-    q_subject: Option<&str>,
-    q_property: Option<&str>,
-    q_value: Option<&str>,
-    store: &impl Storelike,
-) -> AtomicResult<Vec<Resource>> {
-    let mut url = Url::parse(endpoint)?;
-    if let Some(val) = q_subject {
-        url.query_pairs_mut().append_pair("subject", val);
-    }
-    if let Some(val) = q_property {
-        url.query_pairs_mut().append_pair("property", val);
-    }
-    if let Some(val) = q_value {
-        url.query_pairs_mut().append_pair("value", val);
-    }
-    let body = fetch_body(
-        url.as_str(),
-        "application/ad+json",
-        store.get_default_agent().ok(),
-    )?;
-    crate::parse::parse_json_ad_string(&body, store, &ParseOpts::default())
-}
-
 /// Posts a Commit to the endpoint of the Subject from the Commit
 pub fn post_commit(commit: &crate::Commit, store: &impl Storelike) -> AtomicResult<()> {
     let server_url = crate::utils::server_url(commit.get_subject())?;

lib/src/collections.rs

@@ -1,18 +1,11 @@
 //! Collections are dynamic resources that refer to multiple resources.
-//! They are constructed using a TPF query
+//! They are constructed using a [Query]
 use crate::{
     errors::AtomicResult,
     storelike::{Query, ResourceCollection},
     urls, Resource, Storelike, Value,
 };
 
-#[derive(Debug)]
-pub struct TpfQuery {
-    pub subject: Option<String>,
-    pub property: Option<String>,
-    pub value: Option<String>,
-}
-
 const DEFAULT_PAGE_SIZE: usize = 30;
 
 /// Used to construct a Collection. Does not contain results / members.
@@ -21,9 +14,9 @@ const DEFAULT_PAGE_SIZE: usize = 30;
 pub struct CollectionBuilder {
     /// Full Subject URL of the resource, including query parameters
     pub subject: String,
-    /// The TPF property which the results are to be filtered by
+    /// The property which the results are to be filtered by
     pub property: Option<String>,
-    /// The TPF value which the results are to be filtered by
+    /// The value which the results are to be filtered by
     pub value: Option<String>,
     /// URL of the value to sort by
     pub sort_by: Option<String>,
@@ -128,9 +121,9 @@ impl CollectionBuilder {
 pub struct Collection {
     /// Full Subject URL of the resource, including query parameters
     pub subject: String,
-    /// The TPF property which the results are to be filtered by
+    /// The property which the results are to be filtered by
     pub property: Option<String>,
-    /// The TPF value which the results are to be filtered by
+    /// The value which the results are to be filtered by
     pub value: Option<String>,
     /// The actual items that you're interested in. List the member subjects of the current page.
     pub members: Vec<String>,

lib/src/db.rs

@@ -68,7 +68,7 @@ pub struct Db {
     /// See [reference_index]
     reference_index: sled::Tree,
     /// Index sorted by property + value.
-    /// Used for TPF queries where the property is known.
+    /// Used for queries where the property is known.
     prop_val_sub_index: sled::Tree,
     /// Stores the members of Collections, easily sortable.
     query_index: sled::Tree,
@@ -579,7 +579,7 @@ impl Storelike for Db {
         // populate_base_models should be run in init, instead of here, since it will result in infinite loops without
         crate::populate::populate_default_store(self)
             .map_err(|e| format!("Failed to populate default store. {}", e))?;
-        // This is a potentially expensive operation, but is needed to make TPF queries work with the models created in here
+        // This is a potentially expensive operation, but is needed to make Queries work with the models created in here
         self.build_index(true)
             .map_err(|e| format!("Failed to build index. {}", e))?;
         crate::populate::create_drive(self)

lib/src/db/query_index.rs

@@ -271,7 +271,7 @@ pub fn should_update_property<'a>(
 }
 
 /// This is called when an atom is added or deleted.
-/// Check whether the Atom will be hit by a TPF query matching the [QueryFilter].
+/// Check whether the [Atom] will be hit by a [Query] matching the [QueryFilter].
 /// Updates the index accordingly.
 /// We need both the `index_atom` and the full `atom`.
 #[tracing::instrument(skip_all)]

lib/src/hierarchy.rs

@@ -30,7 +30,7 @@ impl fmt::Display for Right {
     }
 }
 
-/// Looks for children relations, adds to the resource. Performs a TPF query, might be expensive.
+/// Looks for children relations, adds to the resource. Performs a Query, might be expensive.
 pub fn add_children(store: &impl Storelike, resource: &mut Resource) -> AtomicResult<Resource> {
     let results = store.query(&Query::new_prop_val(urls::PARENT, resource.get_subject()))?;
     let mut children = results.subjects;

server/src/appstate.rs

@@ -46,7 +46,7 @@ pub fn init(config: Config) -> AtomicServerResult<AppState> {
         tracing::info!("Initialize: creating and populating new Database");
         atomic_lib::populate::populate_default_store(&store)
             .map_err(|e| format!("Failed to populate default store. {}", e))?;
-        // Building the index here is needed to perform TPF queries on imported resources
+        // Building the index here is needed to perform Queries on imported resources
         tracing::info!("Building index (this could take a few minutes for larger databases)");
         store.build_index(true)?;
         tracing::info!("Building index finished!");