Compare commits

...

21 commits
v0.4.0 ... main

Author SHA1 Message Date
f35c7cd085 Merge pull request 'dev' (#6) from dev into main
Reviewed-on: #6
2025-04-01 13:19:02 +00:00
e893e14c26 Merge pull request 'Merge pull request 'dev' (#4) from dev into main' (#5) from main into dev
Reviewed-on: #5
2025-04-01 13:17:26 +00:00
303b713d59 fix(properties): fetch prop values alongside prop ids and labels 2025-04-01 14:43:36 +03:00
46e9b4e48e docs(readme): document properties data flow 2025-04-01 00:02:35 +03:00
8c7946091f fix(labels): display correct labels in dropdown and when properties are added 2025-03-31 23:50:35 +03:00
9d21d9999f fix(labels): add set_is_fetching_labels signal to fetch_item_properties label to fix error 2025-03-31 18:07:36 +03:00
40bb35d6a8 feat(labels): add state to track when labels are being fetched(in progress) 2025-03-31 17:36:46 +03:00
ef7245b716 fix(labels): add property cache and refactor fetch_item_properties function to use it 2025-03-27 15:31:58 +03:00
5c3070bfc0 fix(labels): update set_property_labels signal in fetch_item_properties function to avoid repetitive label fetches 2025-03-26 14:48:58 +03:00
a9611a08e4 Merge branch 'dev' of forge.ftt.gmbh:ryanmwangi/Compware into dev 2025-03-25 15:52:40 +03:00
ebb1afd1af fix(properties): show property labels in custom property autocomplete dropdown 2025-03-25 15:51:49 +03:00
734e710d8f Merge pull request 'dev' (#4) from dev into main
Reviewed-on: #4
2025-03-24 20:57:41 +00:00
1f52901885 Merge branch 'main' into dev 2025-03-24 20:56:53 +00:00
f0356e9d0c Merge pull request 'Add CompareWare link to Readme' (#3) from readme-link into main
Reviewed-on: #3
2025-03-21 13:33:17 +00:00
69430fae8a fix(db): clean up property deletion to be scoped per url 2025-03-21 16:21:19 +03:00
fe98c56872 fix(db): check if the global_item_id column exists before trying to add it. 2025-03-21 01:45:16 +03:00
12f4043e83 feat(db): add global_item_id to track items accross urls 2025-03-21 01:32:32 +03:00
9a7a8e575c Add CompareWare link to Readme 2025-03-20 12:29:44 +00:00
3126d90f5a fix(auto search): retrace my steps to resolve ownership errors 2025-03-18 23:47:47 +03:00
8c1cab3615 Merge branch 'dev' of forge.ftt.gmbh:ryanmwangi/Compware into dev 2025-03-17 22:41:42 +03:00
85dce655e4 feat(auto-search): remove search button and have autosearch while typing 2025-03-17 22:41:23 +03:00
4 changed files with 271 additions and 86 deletions

3
.gitignore vendored
View file

@ -18,4 +18,5 @@ playwright/.cache/
.idea/
# Ignore database file
compareware.db
compareware.db
.qodo

View file

@ -1,6 +1,7 @@
# CompareWare
# [CompareWare](https://compareware.org/)
CompareWare is an open-source platform for comparing tools (software, hardware, etc.) with structured, crowdsourced data. It combines **Leptos** for a modern, reactive frontend and **Nostr** for decentralized data storage.
CompareWare is an open-source platform for comparing tools (software, hardware, etc.) with structured, crowdsourced data.
It combines Rust's **Leptos** for a modern, reactive frontend and **Nostr** for decentralized data storage (TBI).
## **Features**
- **Item Management**: Add, view, and manage items with metadata and key-value tags.
@ -25,7 +26,7 @@ CompareWare is an open-source platform for comparing tools (software, hardware,
```bash
cargo leptos serve
```
3. Open your browser at [http://localhost:3000](http://localhost:3000)
3. Open your browser at [localhost:3000](http://localhost:3000)
## **Database Schema**
### Key Concepts
@ -58,6 +59,28 @@ flowchart LR
items -->|item_id| item_properties
properties -->|property_id| item_properties
```
### Properties data flow
```mermaid
sequenceDiagram
participant User
participant App as Application
participant Wikidata
User->>App: Enters search
App->>Wikidata: fetch_wikidata_suggestions()
Wikidata-->>App: Return suggestions
App->>User: Show suggestions
User->>App: Selects item
App->>Wikidata: fetch_item_properties()
Wikidata-->>App: Return properties (IDs + values)
App->>Wikidata: fetch_property_labels()
Wikidata-->>App: Return labels
App->>App: Combine labels + properties
App->>User: Show labeled properties
```
## **Docker Deployment**
### **Prerequisites**

View file

@ -141,6 +141,8 @@ pub fn ItemsList(
// Signal to store the fetched property labels
let (property_labels, set_property_labels) = create_signal(HashMap::<String, String>::new());
// State to manage property cache
let (property_cache, set_property_cache) = create_signal(HashMap::<String, HashMap<String, String>>::new());
#[cfg(feature = "ssr")]
fn get_current_url() -> String {
use leptos::use_context;
@ -381,15 +383,31 @@ pub fn ItemsList(
};
//function to fetch properties
async fn fetch_item_properties(wikidata_id: &str) -> HashMap<String, String> {
async fn fetch_item_properties(
wikidata_id: &str,
set_property_labels: WriteSignal<HashMap<String, String>>,
property_cache: ReadSignal<HashMap<String, HashMap<String, String>>>,
set_property_cache: WriteSignal<HashMap<String, HashMap<String, String>>>,
property_labels: ReadSignal<HashMap<String, String>>,
) -> HashMap<String, String> {
// Check cache first
if let Some(cached) = property_cache.get().get(wikidata_id) {
return cached.clone();
}
let sparql_query = format!(
r#"
SELECT ?propLabel ?value ?valueLabel WHERE {{
SELECT ?prop ?propLabel ?value ?valueLabel WHERE {{
wd:{} ?prop ?statement.
?statement ?ps ?value.
?property wikibase:claim ?prop.
?property wikibase:statementProperty ?ps.
SERVICE wikibase:label {{ bd:serviceParam wikibase:language "en". }}
SERVICE wikibase:label {{
bd:serviceParam wikibase:language "en".
?prop rdfs:label ?propLabel.
?value rdfs:label ?valueLabel.
}}
}}
"#,
wikidata_id
@ -408,17 +426,66 @@ pub fn ItemsList(
Ok(response) => {
if let Ok(data) = response.json::<serde_json::Value>().await {
let mut result = HashMap::new();
let mut prop_ids = Vec::new();
// First pass: collect unique property IDs
if let Some(bindings) = data["results"]["bindings"].as_array() {
for binding in bindings {
let prop_label = binding["propLabel"]["value"].as_str().unwrap_or("").to_string();
let prop_label = prop_label.replace("http://www.wikidata.org/prop/", "");
let value_label = binding["valueLabel"]["value"].as_str().unwrap_or("").to_string();
result.insert(prop_label, value_label);
log!("result: {:?}", result);
if let Some(prop) = binding["propLabel"]["value"].as_str() {
let prop_id = prop.replace("http://www.wikidata.org/prop/", "");
if !prop_ids.contains(&prop_id) {
prop_ids.push(prop_id.clone());
}
}
}
}
// Batch fetch missing labels
let existing_labels = property_labels.get();
let missing_ids: Vec<String> = prop_ids
.iter()
.filter(|id| !existing_labels.contains_key(*id))
.cloned()
.collect();
if !missing_ids.is_empty() {
let new_labels = fetch_property_labels(missing_ids).await;
set_property_labels.update(|labels| {
labels.extend(new_labels.clone());
});
}
// Second pass: build results
if let Some(bindings) = data["results"]["bindings"].as_array() {
for binding in bindings {
let prop_label = binding["propLabel"]["value"].as_str().unwrap_or_default();
let value = binding["valueLabel"]["value"]
.as_str()
.or_else(|| binding["value"]["value"].as_str())
.unwrap_or_default();
if let Some(prop_uri) = binding["prop"]["value"].as_str() {
let prop_id = prop_uri.split('/').last().unwrap_or_default().to_string();
result.insert(
prop_id.clone(),
value.to_string()
);
// Update labels if missing
set_property_labels.update(|labels| {
labels.entry(prop_id.clone())
.or_insert(prop_label.to_string());
});
}
}
}
// Update cache
set_property_cache.update(|cache| {
cache.insert(wikidata_id.to_string(), result.clone());
});
result
} else {
HashMap::new()
}
@ -515,11 +582,28 @@ pub fn ItemsList(
let add_property = {
let current_url = Rc::clone(&current_url);
let set_items = set_items.clone();
let set_property_labels = set_property_labels.clone();
let property_cache = property_cache.clone();
let set_property_cache = set_property_cache.clone();
Arc::new(move |property: String| {
// Normalize the property ID
let normalized_property = property.replace("http://www.wikidata.org/prop/", "");
let normalized_property_clone = normalized_property.clone();
// Check if label already exists
if !property_labels.get().contains_key(&normalized_property) {
spawn_local({
let normalized_property = normalized_property.clone();
let set_property_labels = set_property_labels.clone();
async move {
let labels = fetch_property_labels(vec![normalized_property.clone()]).await;
set_property_labels.update(|map| {
map.extend(labels);
});
}
});
}
// Check if property is already selected
if !selected_properties.get().contains_key(&normalized_property) && !normalized_property.is_empty() {
// Add property to selected properties
@ -581,43 +665,45 @@ pub fn ItemsList(
}
});
// Fetch the property label
let property_id = normalized_property.clone();
spawn_local(async move {
let labels = fetch_property_labels(vec![property_id.clone()]).await;
log!("Fetched labels: {:?}", labels);
set_property_labels.update(|labels_map| {
for (key, value) in labels {
log!("Inserting label: {} -> {}", key, value);
labels_map.insert(key, value);
}
});
});
// Use the property label from the property_labels signal
let property_label = property_labels.get().get(&normalized_property).cloned().unwrap_or_else(|| normalized_property.clone());
log!("Added property with label: {}", property_label);
}
});
// Fetch the relevant value for each item and populate the corresponding cells
set_items.update(|items| {
for item in items {
// Initialize property with empty string if it doesn't exist
item.custom_properties.entry(normalized_property.clone())
.or_insert_with(|| "".to_string());
// Only fetch properties if Wikidata ID exists
if let Some(wikidata_id) = &item.wikidata_id {
let wikidata_id = wikidata_id.clone();
let set_items = set_items.clone();
let set_fetched_properties = set_fetched_properties.clone();
let set_property_labels = set_property_labels.clone();
let property_clone = property.clone();
let property_clone = normalized_property.clone();
spawn_local(async move {
let properties = fetch_item_properties(&wikidata_id).await;
// Update fetched properties and property labels
set_fetched_properties.update(|fp| {
fp.insert(wikidata_id.clone(), properties.clone());
});
set_property_labels.update(|pl| {
for (key, value) in properties.iter() {
pl.entry(key.clone()).or_insert_with(|| value.clone());
}
});
let properties = fetch_item_properties(
&wikidata_id,
set_property_labels.clone(),
property_cache.clone(),
set_property_cache.clone(),
property_labels.clone()
).await;
// Update the specific property for this item
if let Some(value) = properties.get(&property_clone) {
set_items.update(|items| {
if let Some(item) = items.iter_mut().find(|item| item.wikidata_id.as_ref().unwrap() == &wikidata_id) {
item.custom_properties.insert(property_clone.clone(), value.clone());
if let Some(item) = items.iter_mut()
.find(|i| i.wikidata_id.as_ref() == Some(&wikidata_id))
{
item.custom_properties.insert(
property_clone.clone(),
value.clone()
);
}
});
}
@ -646,7 +732,7 @@ pub fn ItemsList(
if let Some(wikidata_id) = &item.wikidata_id {
let wikidata_id = wikidata_id.clone();
spawn_local(async move {
let properties = fetch_item_properties(&wikidata_id).await;
let properties = fetch_item_properties(&wikidata_id, set_property_labels.clone(), property_cache.clone(), set_property_cache.clone(), property_labels.clone()).await;
log!("Fetched properties for index {}: {:?}", index, properties);
});
}
@ -795,7 +881,7 @@ pub fn ItemsList(
// Fetch additional properties from Wikidata
let wikidata_id = id.clone();
spawn_local(async move {
let properties = fetch_item_properties(&wikidata_id).await;
let properties = fetch_item_properties(&wikidata_id, set_property_labels.clone(), property_cache.clone(), set_property_cache.clone(), property_labels.clone()).await;
// log!("Fetched properties for Wikidata ID {}: {:?}", wikidata_id, properties);
// Populate the custom properties for the new item
@ -923,17 +1009,21 @@ pub fn ItemsList(
</table>
<div style="margin-bottom: 20px;">
<input type="text" id="new-property" placeholder="Add New Property" list="properties" on:keydown=move |event| {
if event.key() == "Enter"{
if event.key() == "Enter" {
let input_element = event.target().unwrap().dyn_into::<web_sys::HtmlInputElement>().unwrap();
let property = input_element.value();
if !property.is_empty() {
// Extract the coded name from the selected value
let coded_name = property.split(" - ").next().unwrap_or(&property).to_string();
// Add the property using the coded name
add_property(coded_name);
// Clear the input field
let input_value = input_element.value();
// Extract property ID from "Label (P123)" format
let property_id = input_value
.split(" (")
.last()
.and_then(|s| s.strip_suffix(')'))
.unwrap_or(&input_value)
.to_string();
if !property_id.is_empty() {
// Add the property using the extracted ID
add_property(property_id);
input_element.set_value("");
}
}
@ -941,10 +1031,11 @@ pub fn ItemsList(
<datalist id="properties">
{move || {
let property_labels = property_labels.get().clone();
property_labels.into_iter().map(|(property, label)| {
let property_clone = property.clone();
property_labels.into_iter().map(|(property_id, label)| {
view! {
<option value={property}>{ format!("{} - {}", property_clone, label) }</option>
<option value={format!("{} ({})", label, property_id)}>
{ format!("{} ({})", label, property_id) }
</option>
}
}).collect::<Vec<_>>()
}}

134
src/db.rs
View file

@ -8,7 +8,7 @@ mod db_impl {
use std::collections::{HashMap, HashSet};
use std::sync::Arc;
use tokio::sync::Mutex;
use uuid::Uuid;
#[cfg(test)]
mod tests {
use super::*;
@ -271,6 +271,22 @@ mod db_impl {
e
})?;
// Check if the global_item_id column exists
let mut stmt = conn.prepare("PRAGMA table_info(items);")?;
let columns: Vec<String> = stmt
.query_map([], |row| row.get(1))? // Column 1 contains the column names
.collect::<Result<_, _>>()?;
if !columns.contains(&"global_item_id".to_string()) {
conn.execute_batch(
"ALTER TABLE items ADD COLUMN global_item_id TEXT;"
)
.map_err(|e| {
eprintln!("Failed adding global_item_id to items table: {}", e);
e
})?;
}
// 4. Table for selected properties
conn.execute_batch(
"CREATE TABLE IF NOT EXISTS selected_properties (
@ -289,11 +305,11 @@ mod db_impl {
// 5. Junction table for custom properties
conn.execute_batch(
"CREATE TABLE IF NOT EXISTS item_properties (
item_id TEXT NOT NULL,
global_item_id TEXT NOT NULL,
property_id INTEGER NOT NULL,
value TEXT NOT NULL,
PRIMARY KEY (item_id, property_id),
FOREIGN KEY (item_id) REFERENCES items(id) ON DELETE CASCADE,
PRIMARY KEY (global_item_id, property_id),
FOREIGN KEY (global_item_id) REFERENCES items(global_item_id) ON DELETE CASCADE,
FOREIGN KEY (property_id) REFERENCES properties(id) ON DELETE CASCADE
);",
)
@ -301,6 +317,23 @@ mod db_impl {
eprintln!("Failed creating item_properties table: {}", e);
e
})?;
// 6. Junction table for deleted properties
conn.execute_batch(
"CREATE TABLE IF NOT EXISTS deleted_properties (
url_id INTEGER NOT NULL,
global_item_id TEXT NOT NULL,
property_id INTEGER NOT NULL,
PRIMARY KEY (url_id, global_item_id, property_id),
FOREIGN KEY (url_id) REFERENCES urls(id) ON DELETE CASCADE,
FOREIGN KEY (global_item_id) REFERENCES items(global_item_id) ON DELETE CASCADE,
FOREIGN KEY (property_id) REFERENCES properties(id) ON DELETE CASCADE
);",
).map_err(|e| {
eprintln!("Failed creating item_properties table: {}", e);
e
})?;
Ok(())
}
@ -383,7 +416,8 @@ mod db_impl {
SELECT
i.id,
i.wikidata_id,
i.item_order
i.item_order,
i.global_item_id
FROM items i
WHERE i.url_id = ?
ORDER BY i.item_order ASC
@ -396,25 +430,26 @@ mod db_impl {
json_group_object(p.name, ip.value) as custom_properties
FROM ordered_items oi
LEFT JOIN item_properties ip
ON oi.id = ip.item_id
ON oi.global_item_id = ip.global_item_id
AND ip.property_id NOT IN (
SELECT id FROM properties WHERE name IN ('name', 'description')
SELECT property_id
FROM deleted_properties
WHERE url_id = ? AND global_item_id = oi.global_item_id
)
LEFT JOIN properties p
ON ip.property_id = p.id
LEFT JOIN item_properties name_ip
ON oi.id = name_ip.item_id
ON oi.global_item_id = name_ip.global_item_id
AND name_ip.property_id = (SELECT id FROM properties WHERE name = 'name')
LEFT JOIN item_properties desc_ip
ON oi.id = desc_ip.item_id
ON oi.global_item_id = desc_ip.global_item_id
AND desc_ip.property_id = (SELECT id FROM properties WHERE name = 'description')
GROUP BY oi.id
ORDER BY oi.item_order ASC"
)?;
// Change from HashMap to Vec to preserve order
let rows = stmt.query_map([url_id], |row| {
let rows = stmt.query_map([url_id, url_id], |row| {
let custom_props_json: String = row.get(4)?;
let custom_properties: HashMap<String, String> = serde_json::from_str(&custom_props_json)
.unwrap_or_default();
@ -495,18 +530,36 @@ mod db_impl {
|row| row.get(0),
)?;
let global_item_id = match tx.query_row(
"SELECT ip.global_item_id
FROM item_properties ip
JOIN properties p ON ip.property_id = p.id
WHERE p.name = 'name' AND ip.value = ? LIMIT 1",
[&item.name],
|row| row.get::<_, String>(0),
) {
Ok(id) => id, // Reuse existing global_item_id
Err(rusqlite::Error::QueryReturnedNoRows) => {
let new_id = Uuid::new_v4().to_string(); // Generate a new global_item_id
new_id
}
Err(e) => return Err(e.into()),
};
log!("[DB] Upserting item");
tx.execute(
"INSERT INTO items (id, url_id, wikidata_id, item_order)
VALUES (?, ?, ?, ?)
"INSERT INTO items (id, url_id, wikidata_id, item_order, global_item_id)
VALUES (?, ?, ?, ?, ?)
ON CONFLICT(id) DO UPDATE SET
url_id = excluded.url_id,
wikidata_id = excluded.wikidata_id",
wikidata_id = excluded.wikidata_id,
global_item_id = excluded.global_item_id",
rusqlite::params![
&item.id,
url_id,
&item.wikidata_id,
max_order + 1
max_order + 1,
&global_item_id
],
)?;
log!("[DB] Item upserted successfully");
@ -523,11 +576,11 @@ mod db_impl {
let prop_id = self.get_or_create_property(&mut tx, prop).await?;
tx.execute(
"INSERT INTO item_properties (item_id, property_id, value)
"INSERT INTO item_properties (global_item_id, property_id, value)
VALUES (?, ?, ?)
ON CONFLICT(item_id, property_id) DO UPDATE SET
ON CONFLICT(global_item_id, property_id) DO UPDATE SET
value = excluded.value",
rusqlite::params![&item.id, prop_id, value],
rusqlite::params![&global_item_id, prop_id, value],
)?;
}
@ -538,7 +591,7 @@ mod db_impl {
"SELECT p.name, ip.value
FROM item_properties ip
JOIN properties p ON ip.property_id = p.id
WHERE ip.item_id = ?",
WHERE ip.global_item_id = ?",
)?;
let mapped_rows = stmt.query_map([&item.id], |row| {
@ -588,6 +641,11 @@ mod db_impl {
"DELETE FROM items WHERE id = ? AND url_id = ?",
[item_id, &url_id.to_string()],
)?;
tx.execute(
"DELETE FROM item_properties WHERE global_item_id = ?",
[item_id],
)?;
tx.commit()?;
Ok(())
@ -597,23 +655,35 @@ mod db_impl {
pub async fn delete_property_by_url(&self, url: &str, property: &str) -> Result<(), Error> {
let mut conn = self.conn.lock().await;
let tx = conn.transaction()?;
// Get URL ID
let url_id: i64 =
tx.query_row("SELECT id FROM urls WHERE url = ?", [url], |row| row.get(0))?;
// Delete property from all items in this URL
tx.execute(
"DELETE FROM item_properties
WHERE property_id IN (
SELECT id FROM properties WHERE name = ?
)
AND item_id IN (
SELECT id FROM items WHERE url_id = ?
)",
[property, &url_id.to_string()],
// Get property ID
let property_id: i64 = tx.query_row(
"SELECT id FROM properties WHERE name = ?",
[property],
|row| row.get(0),
)?;
// Get all global_item_ids for this URL
{
let mut stmt = tx.prepare("SELECT global_item_id FROM items WHERE url_id = ?")?;
let global_item_ids: Vec<String> = stmt
.query_map([url_id], |row| row.get(0))?
.collect::<Result<_, _>>()?;
// Insert into deleted_properties for each global_item_id
for global_item_id in global_item_ids {
tx.execute(
"INSERT OR IGNORE INTO deleted_properties (url_id, global_item_id, property_id)
VALUES (?, ?, ?)",
rusqlite::params![url_id, global_item_id, property_id],
)?;
}
}
tx.commit()?;
Ok(())
}