diff --git a/apps/labrinth/.env.docker-compose b/apps/labrinth/.env.docker-compose index 55bc2f232b..871cbd8133 100644 --- a/apps/labrinth/.env.docker-compose +++ b/apps/labrinth/.env.docker-compose @@ -25,9 +25,12 @@ ELASTICSEARCH_INDEX_PREFIX=labrinth ELASTICSEARCH_USERNAME=elastic ELASTICSEARCH_PASSWORD=elastic SEARCH_INDEX_CHUNK_SIZE=5000 +SEARCH_INCREMENTAL_INDEX_BATCH_DELAY_SECONDS=5 +SEARCH_INCREMENTAL_INDEX_BATCH_MAX_SIZE=1000 TYPESENSE_URL=http://localhost:8108 TYPESENSE_API_KEY=modrinth TYPESENSE_INDEX_PREFIX=labrinth +TYPESENSE_IMPORT_BATCH_SIZE=5000 REDIS_URL=redis://labrinth-redis REDIS_MIN_CONNECTIONS=0 diff --git a/apps/labrinth/.env.local b/apps/labrinth/.env.local index 364f90f1e5..25ef3e5ab5 100644 --- a/apps/labrinth/.env.local +++ b/apps/labrinth/.env.local @@ -43,9 +43,12 @@ ELASTICSEARCH_USERNAME= ELASTICSEARCH_PASSWORD= SEARCH_INDEX_CHUNK_SIZE=5000 +SEARCH_INCREMENTAL_INDEX_BATCH_DELAY_SECONDS=5 +SEARCH_INCREMENTAL_INDEX_BATCH_MAX_SIZE=1000 TYPESENSE_URL=http://localhost:8108 TYPESENSE_API_KEY=modrinth TYPESENSE_INDEX_PREFIX=labrinth +TYPESENSE_IMPORT_BATCH_SIZE=5000 REDIS_URL=redis://localhost REDIS_MIN_CONNECTIONS=0 diff --git a/apps/labrinth/.sqlx/query-10dd90694457e57fbb0ed390326fa6d4b6212a8788503d5a53cef0f0be8bb981.json b/apps/labrinth/.sqlx/query-10dd90694457e57fbb0ed390326fa6d4b6212a8788503d5a53cef0f0be8bb981.json new file mode 100644 index 0000000000..f05a642c48 --- /dev/null +++ b/apps/labrinth/.sqlx/query-10dd90694457e57fbb0ed390326fa6d4b6212a8788503d5a53cef0f0be8bb981.json @@ -0,0 +1,15 @@ +{ + "db_name": "PostgreSQL", + "query": "\n UPDATE mods\n SET queued = NOW()\n WHERE id = $1 AND status = $2\n ", + "describe": { + "columns": [], + "parameters": { + "Left": [ + "Int8", + "Text" + ] + }, + "nullable": [] + }, + "hash": "10dd90694457e57fbb0ed390326fa6d4b6212a8788503d5a53cef0f0be8bb981" +} diff --git a/apps/labrinth/.sqlx/query-8145d09f7c6c5d2e18a10ef814551f87424ee39aac49cae5575c0d3313fb7f24.json b/apps/labrinth/.sqlx/query-8145d09f7c6c5d2e18a10ef814551f87424ee39aac49cae5575c0d3313fb7f24.json new file mode 100644 index 0000000000..59ab74bde2 --- /dev/null +++ b/apps/labrinth/.sqlx/query-8145d09f7c6c5d2e18a10ef814551f87424ee39aac49cae5575c0d3313fb7f24.json @@ -0,0 +1,22 @@ +{ + "db_name": "PostgreSQL", + "query": "SELECT id FROM versions WHERE mod_id = $1", + "describe": { + "columns": [ + { + "ordinal": 0, + "name": "id", + "type_info": "Int8" + } + ], + "parameters": { + "Left": [ + "Int8" + ] + }, + "nullable": [ + false + ] + }, + "hash": "8145d09f7c6c5d2e18a10ef814551f87424ee39aac49cae5575c0d3313fb7f24" +} diff --git a/apps/labrinth/src/background_task.rs b/apps/labrinth/src/background_task.rs index 31c51e2367..0c3fb13ef0 100644 --- a/apps/labrinth/src/background_task.rs +++ b/apps/labrinth/src/background_task.rs @@ -19,7 +19,7 @@ use crate::util::anrok; use actix_web::web; use clap::ValueEnum; use eyre::WrapErr; -use tracing::info; +use tracing::{info, instrument}; #[derive(ValueEnum, Debug, Copy, Clone, PartialEq, Eq)] #[clap(rename_all = "kebab_case")] @@ -50,6 +50,7 @@ pub enum BackgroundTask { impl BackgroundTask { #[allow(clippy::too_many_arguments)] + #[instrument(skip_all, fields(background_task = ?self))] pub async fn run( self, pool: PgPool, diff --git a/apps/labrinth/src/env.rs b/apps/labrinth/src/env.rs index 8c8e32b0b7..f6a4705cd6 100644 --- a/apps/labrinth/src/env.rs +++ b/apps/labrinth/src/env.rs @@ -38,7 +38,7 @@ macro_rules! vars { )] let $field: Option<$ty> = { let mut default = None::<$ty>; - $( default = Some({ $default }.into()); )? + $( default = Some(<$ty>::from({ $default })); )? match parse_value::<$ty>(stringify!($field), default) { Ok(value) => Some(value), @@ -160,9 +160,13 @@ vars! { // search SEARCH_BACKEND: crate::search::SearchBackendKind = crate::search::SearchBackendKind::Typesense; SEARCH_INDEX_CHUNK_SIZE: i64 = 5000i64; + SEARCH_INCREMENTAL_INDEX_BATCH_DELAY_SECONDS: u64 = 5u64; + SEARCH_INCREMENTAL_INDEX_BATCH_MAX_SIZE: usize = 1000usize; TYPESENSE_URL: String = "http://localhost:8108"; TYPESENSE_API_KEY: String = "modrinth"; TYPESENSE_INDEX_PREFIX: String = "labrinth"; + TYPESENSE_IMPORT_BATCH_SIZE: usize = 5000usize; + TYPESENSE_DELETE_BATCH_SIZE: usize = 10_000usize; // storage STORAGE_BACKEND: crate::file_hosting::FileHostKind = crate::file_hosting::FileHostKind::Local; diff --git a/apps/labrinth/src/lib.rs b/apps/labrinth/src/lib.rs index e05e536fd2..76d2003479 100644 --- a/apps/labrinth/src/lib.rs +++ b/apps/labrinth/src/lib.rs @@ -131,30 +131,6 @@ pub fn app_setup( )); if enable_background_tasks { - // The interval in seconds at which the local database is indexed - // for searching. Defaults to 1 hour if unset. - let local_index_interval = - Duration::from_secs(ENV.LOCAL_INDEX_INTERVAL); - let pool_ref = pool.clone(); - let redis_pool_ref = redis_pool.clone(); - let search_backend_ref = search_backend.clone(); - scheduler.run(local_index_interval, move || { - let pool_ref = pool_ref.clone(); - let redis_pool_ref = redis_pool_ref.clone(); - let search_backend = search_backend_ref.clone(); - async move { - if let Err(err) = background_task::index_search( - pool_ref, - redis_pool_ref, - search_backend, - ) - .await - { - warn!("Failed to index search: {err:?}"); - } - } - }); - // Changes statuses of scheduled projects/versions let pool_ref = pool.clone(); // TODO: Clear cache when these are run diff --git a/apps/labrinth/src/routes/v3/projects.rs b/apps/labrinth/src/routes/v3/projects.rs index 578cd74e3f..1e388aec5f 100644 --- a/apps/labrinth/src/routes/v3/projects.rs +++ b/apps/labrinth/src/routes/v3/projects.rs @@ -29,7 +29,8 @@ use crate::queue::session::AuthQueue; use crate::routes::ApiError; use crate::routes::internal::delphi; use crate::search::{ - SearchBackend, SearchQuery, SearchRequest, SearchResults, SearchState, + SearchBackend, SearchIndexUpdate, SearchQuery, SearchRequest, + SearchResults, SearchState, }; use crate::util::error::Context; use crate::util::img; @@ -77,6 +78,23 @@ pub async fn clear_project_cache_and_queue_search( project_id: db_ids::DBProjectId, slug: Option, clear_dependencies: Option, +) -> Result<(), ApiError> { + clear_project_cache_and_queue_search_inner( + redis, + search_state, + project_id, + slug, + clear_dependencies, + ) + .await +} + +pub async fn clear_project_cache_and_queue_search_inner( + redis: &RedisPool, + search_state: &SearchState, + project_id: db_ids::DBProjectId, + slug: Option, + clear_dependencies: Option, ) -> Result<(), ApiError> { db_models::DBProject::clear_cache( project_id, @@ -85,11 +103,36 @@ pub async fn clear_project_cache_and_queue_search( redis, ) .await?; + search_state.queue.push(project_id.into()).await; Ok(()) } +pub async fn clear_project_cache_and_queue_search_versions( + redis: &RedisPool, + search_state: &SearchState, + project_id: db_ids::DBProjectId, + slug: Option, + clear_dependencies: Option, + version_ids: impl IntoIterator, +) -> Result<(), ApiError> { + db_models::DBProject::clear_cache( + project_id, + slug, + clear_dependencies, + redis, + ) + .await?; + + search_state + .queue + .push_versions(project_id.into(), version_ids) + .await; + + Ok(()) +} + #[derive(Deserialize, Validate)] pub struct RandomProjects { #[validate(range(min = 1, max = 100))] @@ -1098,6 +1141,9 @@ pub async fn project_edit_internal( Ok(()) } + let reindex_version_project_types = + new_project.minecraft_java_server.is_some(); + update( &mut transaction, id, @@ -1167,14 +1213,26 @@ pub async fn project_edit_internal( transaction.commit().await?; - clear_project_cache_and_queue_search( - &redis, - &search_state, - project_item.inner.id, - project_item.inner.slug, - None, - ) - .await?; + if reindex_version_project_types { + clear_project_cache_and_queue_search_versions( + &redis, + &search_state, + project_item.inner.id, + project_item.inner.slug, + None, + project_item.versions.iter().copied().map(VersionId::from), + ) + .await?; + } else { + clear_project_cache_and_queue_search( + &redis, + &search_state, + project_item.inner.id, + project_item.inner.slug, + None, + ) + .await?; + } // Remove no longer searchable projects from search index if let (true, Some(false)) = ( @@ -1182,16 +1240,9 @@ pub async fn project_edit_internal( new_project.status.map(|status| status.is_searchable()), ) { search_state - .backend - .remove_documents( - &project_item - .versions - .into_iter() - .map(|x| x.into()) - .collect::>(), - ) - .await - .wrap_internal_err("failed to remove documents")?; + .queue + .push_project_removal(project_item.inner.id.into()) + .await; } Ok(HttpResponse::NoContent().body("")) @@ -2791,27 +2842,27 @@ pub async fn project_delete_internal( .await .wrap_internal_err("failed to commit transaction")?; - search_state - .backend - .remove_documents( - &project - .versions - .into_iter() - .map(|x| x.into()) - .collect::>(), - ) - .await - .wrap_internal_err("failed to remove project version documents")?; - if result.is_some() { - clear_project_cache_and_queue_search( - &redis, - &search_state, + db_models::DBProject::clear_cache( project.inner.id, project.inner.slug, None, + &redis, ) .await?; + let project_id = project.inner.id.into(); + search_state + .backend + .apply_update(SearchIndexUpdate { + removed_projects: std::slice::from_ref(&project_id), + ..SearchIndexUpdate::default() + }) + .await + .wrap_internal_err("failed to remove project from search index")?; + search_state + .queue + .push_project_removal(project.inner.id.into()) + .await; Ok(()) } else { Err(ApiError::NotFound) diff --git a/apps/labrinth/src/routes/v3/version_creation.rs b/apps/labrinth/src/routes/v3/version_creation.rs index 2d22d62d13..c32ae7a294 100644 --- a/apps/labrinth/src/routes/v3/version_creation.rs +++ b/apps/labrinth/src/routes/v3/version_creation.rs @@ -20,8 +20,8 @@ use crate::models::notifications::NotificationBody; use crate::models::pack::PackFileHash; use crate::models::pats::Scopes; use crate::models::projects::{ - Dependency, FileType, Loader, Version, VersionFile, VersionStatus, - VersionType, + Dependency, FileType, Loader, ProjectStatus, Version, VersionFile, + VersionStatus, VersionType, }; use crate::models::projects::{DependencyType, skip_nulls}; use crate::models::teams::ProjectPermissions; @@ -184,19 +184,20 @@ pub async fn version_create( if let Err(e) = rollback_result { return Err(e.into()); } - } else if let Ok((_, project_id)) = &result { + } else if let Ok((_, project_id, version_id)) = &result { transaction.commit().await?; - super::projects::clear_project_cache_and_queue_search( + super::projects::clear_project_cache_and_queue_search_versions( &redis, &search_state, *project_id, None, Some(true), + [VersionId::from(*version_id)], ) .await?; } - result.map(|(response, _)| response) + result.map(|(response, _, _)| response) } #[allow(clippy::too_many_arguments)] @@ -210,7 +211,8 @@ async fn version_create_inner( pool: &PgPool, session_queue: &AuthQueue, http: &reqwest::Client, -) -> Result<(HttpResponse, models::DBProjectId), CreateError> { +) -> Result<(HttpResponse, models::DBProjectId, models::DBVersionId), CreateError> +{ let mut initial_version_data = None; let mut version_builder = None; let mut selected_loaders = None; @@ -568,7 +570,23 @@ async fn version_create_inner( } } - Ok((HttpResponse::Ok().json(response), project_id)) + sqlx::query!( + " + UPDATE mods + SET queued = NOW() + WHERE id = $1 AND status = $2 + ", + project_id as models::DBProjectId, + ProjectStatus::Processing.as_str(), + ) + .execute(&mut *transaction) + .await?; + + Ok(( + HttpResponse::Ok().json(response), + project_id, + models::DBVersionId::from(version_id), + )) } /// Add files to an existing version. @@ -635,17 +653,18 @@ pub async fn upload_file_to_version( let mut transaction = client.begin().await?; let mut uploaded_files = Vec::new(); - let version_id = models::DBVersionId::from(url_data.into_inner().0); + let version_id = url_data.into_inner().0; + let db_version_id = models::DBVersionId::from(version_id); let result = upload_file_to_version_inner( req, &mut payload, - client, + client.clone(), &mut transaction, redis.clone(), &**file_host, &mut uploaded_files, - version_id, + db_version_id, &session_queue, &http, ) @@ -665,12 +684,13 @@ pub async fn upload_file_to_version( } } else if let Ok((_, project_id)) = &result { transaction.commit().await?; - super::projects::clear_project_cache_and_queue_search( + super::projects::clear_project_cache_and_queue_search_versions( &redis, &search_state, *project_id, None, Some(true), + [version_id], ) .await?; } diff --git a/apps/labrinth/src/routes/v3/versions.rs b/apps/labrinth/src/routes/v3/versions.rs index 9d4f33e602..da5d04f6e2 100644 --- a/apps/labrinth/src/routes/v3/versions.rs +++ b/apps/labrinth/src/routes/v3/versions.rs @@ -27,6 +27,7 @@ use crate::models::teams::ProjectPermissions; use crate::queue::file_scan::get_files_missing_attribution; use crate::queue::session::AuthQueue; use crate::routes::internal::delphi; +use crate::search::incremental::consume::reindex_project_versions; use crate::search::{SearchBackend, SearchState}; use crate::util::error::Context; use crate::util::img; @@ -853,12 +854,13 @@ pub async fn version_edit_helper( transaction.commit().await?; database::models::DBVersion::clear_cache(&version_item, &redis) .await?; - super::projects::clear_project_cache_and_queue_search( + super::projects::clear_project_cache_and_queue_search_versions( &redis, &search_state, version_item.inner.project_id, None, Some(true), + [VersionId::from(version_item.inner.id)], ) .await?; Ok(HttpResponse::NoContent().body("")) @@ -1246,18 +1248,26 @@ pub async fn version_delete( transaction.commit().await?; - super::projects::clear_project_cache_and_queue_search( + super::projects::clear_project_cache_and_queue_search_versions( &redis, &search_state, version.inner.project_id, None, Some(true), + [VersionId::from(version.inner.id)], ) .await?; - search_backend - .remove_documents(&[version.inner.id.into()]) - .await - .wrap_internal_err("failed to remove documents")?; + let project_id = version.inner.project_id.into(); + let version_id = version.inner.id.into(); + reindex_project_versions( + &pool, + &redis, + search_backend.as_ref(), + std::slice::from_ref(&project_id), + std::slice::from_ref(&version_id), + ) + .await + .wrap_internal_err("failed to update search index after version removal")?; if result.is_some() { Ok(HttpResponse::NoContent().body("")) } else { diff --git a/apps/labrinth/src/search/backend/common.rs b/apps/labrinth/src/search/backend/common.rs index 5192a83dc3..9589275186 100644 --- a/apps/labrinth/src/search/backend/common.rs +++ b/apps/labrinth/src/search/backend/common.rs @@ -50,14 +50,7 @@ pub enum SearchIndex { MinecraftJavaServerPlayersOnline, } -#[derive(Debug, Clone, Copy, PartialEq, Eq)] -pub enum SearchIndexName { - Projects, - ProjectsFiltered, -} - pub struct SearchSort { - pub index_name: SearchIndexName, pub index: SearchIndex, } @@ -65,16 +58,12 @@ pub fn parse_search_index( index: &str, new_filters: Option<&str>, ) -> Result { - let projects_name = SearchIndexName::Projects; - let projects_filtered_name = SearchIndexName::ProjectsFiltered; - // TODO: this is a dumb hack, the frontend should pass the project type it's filtering directly let is_server = new_filters .is_some_and(|f| f.contains("project_types = minecraft_java_server")); Ok(match index { "relevance" => SearchSort { - index_name: projects_name, index: if is_server { SearchIndex::MinecraftJavaServerVerifiedPlays2w } else { @@ -82,27 +71,21 @@ pub fn parse_search_index( }, }, "downloads" => SearchSort { - index_name: projects_filtered_name, index: SearchIndex::Downloads, }, "follows" => SearchSort { - index_name: projects_name, index: SearchIndex::Follows, }, "updated" | "date_modified" => SearchSort { - index_name: projects_name, index: SearchIndex::Updated, }, "newest" | "date_created" => SearchSort { - index_name: projects_name, index: SearchIndex::Newest, }, "minecraft_java_server.verified_plays_2w" => SearchSort { - index_name: projects_name, index: SearchIndex::MinecraftJavaServerVerifiedPlays2w, }, "minecraft_java_server.ping.data.players_online" => SearchSort { - index_name: projects_name, index: SearchIndex::MinecraftJavaServerPlayersOnline, }, i => return Err(ApiError::Request(eyre!("invalid index '{i}'"))), diff --git a/apps/labrinth/src/search/backend/mod.rs b/apps/labrinth/src/search/backend/mod.rs index 307cde1040..544cf2a557 100644 --- a/apps/labrinth/src/search/backend/mod.rs +++ b/apps/labrinth/src/search/backend/mod.rs @@ -2,7 +2,7 @@ mod common; pub mod typesense; pub use common::{ - ParsedSearchRequest, SearchIndex, SearchIndexName, SearchSort, - combined_search_filters, parse_search_index, parse_search_request, + ParsedSearchRequest, SearchIndex, SearchSort, combined_search_filters, + parse_search_index, parse_search_request, }; pub use typesense::{Typesense, TypesenseConfig}; diff --git a/apps/labrinth/src/search/backend/typesense/mod.rs b/apps/labrinth/src/search/backend/typesense/mod.rs index 6a9d1b91f9..7222a4006f 100644 --- a/apps/labrinth/src/search/backend/typesense/mod.rs +++ b/apps/labrinth/src/search/backend/typesense/mod.rs @@ -1,30 +1,32 @@ use std::sync::LazyLock; -use ariadne::ids::base62_impl::to_base62; use async_trait::async_trait; use eyre::{Result, eyre}; +use itertools::Itertools; use regex::Regex; use reqwest::Method; use serde::{Deserialize, Serialize}; use serde_json::{Value, json}; -use tracing::{info, warn}; +use tracing::{debug, info}; use crate::database::PgPool; use crate::database::redis::RedisPool; use crate::env::ENV; -use crate::models::ids::{ProjectId, VersionId}; use crate::routes::ApiError; use crate::search::backend::{ - SearchIndex, SearchIndexName, combined_search_filters, parse_search_index, + SearchIndex, combined_search_filters, parse_search_index, parse_search_request, }; use crate::search::indexing::index_local; use crate::search::{ - ResultSearchProject, SearchBackend, SearchField, SearchRequest, - SearchResults, TasksCancelFilter, UploadSearchProject, + ResultSearchProject, SearchBackend, SearchField, SearchIndexUpdate, + SearchRequest, SearchResults, TasksCancelFilter, UploadSearchProject, + UploadSearchVersion, }; use crate::util::error::Context; +const DELETE_FILTER_ID_BATCH_SIZE: usize = 256; + #[derive(Debug, Clone)] pub struct TypesenseConfig { pub url: String, @@ -32,6 +34,8 @@ pub struct TypesenseConfig { pub index_prefix: String, pub meta_namespace: String, pub index_chunk_size: i64, + pub import_batch_size: usize, + pub delete_batch_size: usize, } #[derive(Serialize, Deserialize, Debug, Clone)] @@ -160,6 +164,8 @@ impl TypesenseConfig { index_prefix: ENV.TYPESENSE_INDEX_PREFIX.clone(), meta_namespace: meta_namespace.unwrap_or_default(), index_chunk_size: ENV.SEARCH_INDEX_CHUNK_SIZE, + import_batch_size: ENV.TYPESENSE_IMPORT_BATCH_SIZE, + delete_batch_size: ENV.TYPESENSE_DELETE_BATCH_SIZE, } } @@ -235,6 +241,22 @@ impl TypesenseClient { Ok(()) } + async fn delete_alias_if_exists(&self, alias: &str) -> Result<()> { + let resp = self + .request(Method::DELETE, &format!("/aliases/{alias}")) + .send() + .await + .wrap_err("failed to DELETE Typesense alias")?; + if resp.status() == reqwest::StatusCode::NOT_FOUND { + return Ok(()); + } + if !resp.status().is_success() { + let body = resp.json::().await.unwrap_or_default(); + return Err(eyre!("failed to delete alias `{alias}`: {body}")); + } + Ok(()) + } + async fn collection_exists(&self, name: &str) -> Result { let resp = self .request(Method::GET, &format!("/collections/{name}")) @@ -300,21 +322,35 @@ impl TypesenseClient { )); } // Typesense always returns HTTP 200; individual lines signal per-doc success. - let error_count = body + let failures = body .lines() - .filter(|l| !l.trim().is_empty()) - .filter(|l| { - serde_json::from_str::(l) - .ok() - .and_then(|v| v["success"].as_bool()) - .map(|ok| !ok) - .unwrap_or(false) + .filter(|line| !line.trim().is_empty()) + .filter_map(|line| match serde_json::from_str::(line) { + Ok(result) if result["success"].as_bool() == Some(true) => None, + Ok(result) => Some( + result["error"] + .as_str() + .unwrap_or( + "Typesense returned an unsuccessful import result", + ) + .to_string(), + ), + Err(err) => Some(format!( + "failed to parse Typesense import result: {err}" + )), }) - .count(); - if error_count > 0 { - warn!( - "{error_count} document(s) failed to import into `{collection}`" - ); + .collect::>(); + if !failures.is_empty() { + let failure_count = failures.len(); + let errors = failures + .into_iter() + .unique() + .take(10) + .collect::>() + .join("; "); + return Err(eyre!( + "{failure_count} document(s) failed to import into `{collection}`: {errors}" + )); } Ok(()) } @@ -323,12 +359,13 @@ impl TypesenseClient { &self, collection: &str, filter_by: &str, + batch_size: usize, ) -> Result<()> { let resp = self .request( Method::DELETE, &format!( - "/collections/{collection}/documents?filter_by={}&batch_size=1000", + "/collections/{collection}/documents?filter_by={}&batch_size={batch_size}", urlencoding::encode(filter_by) ), ) @@ -363,6 +400,18 @@ pub struct TypesenseFieldSpec { } impl SearchField { + const fn is_version_field(self) -> bool { + matches!( + self, + Self::Categories + | Self::ProjectTypes + | Self::Environment + | Self::GameVersions + | Self::ClientSide + | Self::ServerSide + ) + } + pub const fn typesense_spec(self) -> TypesenseFieldSpec { match self { SearchField::Categories => TypesenseFieldSpec { @@ -564,7 +613,7 @@ impl Typesense { Self { config, client } } - fn collection_schema(name: &str) -> Value { + fn project_collection_schema(name: &str) -> Value { let mut fields = vec![ json!({"name": "summary", "type": "string", "facet": false}), json!({"name": "slug", "type": "string", "facet": false}), @@ -580,6 +629,7 @@ impl Typesense { json!({"name": "minecraft_java_server.is_online", "type": "bool", "sort": true, "optional": true}), json!({"name": "minecraft_java_server.ping.data.players_online", "type": "int32", "sort": true, "optional": true}), json!({"name": "dependencies", "type": "object[]", "optional": true}), + json!({"name": "project_categories", "type": "string[]", "facet": true, "optional": true}), ]; fields.extend(TYPESENSE_SEARCH_FIELDS.iter().cloned()); @@ -591,6 +641,50 @@ impl Typesense { }) } + fn version_collection_schema( + name: &str, + projects_collection: &str, + ) -> Value { + use strum::IntoEnumIterator; + + let mut fields = SearchField::iter() + .filter(|field| field.is_version_field()) + .map(|field| { + let spec = field.typesense_spec(); + json!({ + "name": spec.path, + "type": spec.ty, + "facet": spec.facet, + "optional": spec.optional, + "token_separators": spec.token_separators, + }) + }) + .collect::>(); + fields.extend([ + json!({ + "name": "version_id", + "type": "string", + }), + json!({ + "name": "project_id", + "type": "string", + "reference": format!("{projects_collection}.id"), + "async_reference": true, + "cascade_delete": false, + }), + json!({ + "name": "version_published_timestamp", + "type": "int64", + "sort": true, + }), + ]); + + json!({ + "name": name, + "fields": fields, + }) + } + fn text_match_sort_field(request_config: &RequestConfig) -> String { match request_config.bucketing { Bucketing::Buckets(count) => { @@ -670,12 +764,7 @@ impl Typesense { request_config: &RequestConfig, ) -> Result<(String, String), ApiError> { let sort = parse_search_index(index, new_filters)?; - let alias = match sort.index_name { - SearchIndexName::Projects => self.config.get_alias_name("projects"), - SearchIndexName::ProjectsFiltered => { - self.config.get_alias_name("projects_filtered") - } - }; + let alias = self.config.get_alias_name("projects"); Ok((alias, self.get_sort_fields(sort.index, request_config))) } @@ -684,7 +773,10 @@ impl Typesense { /// Handles the new-style filter string, legacy facets JSON, and the legacy /// `filters`/`version` fields, translating each from Meilisearch filter /// syntax to Typesense filter syntax. - fn build_filter(info: &SearchRequest) -> Result, ApiError> { + fn build_filter( + info: &SearchRequest, + versions_collection: &str, + ) -> Result, ApiError> { let facet_part = if let Some(facets_json) = info.facets.as_deref() { Some( facets_to_typesense(facets_json) @@ -705,29 +797,196 @@ impl Typesense { let filter_part = new_filters_part.or(legacy_part); - Ok(match (facet_part, filter_part) { + let filter = match (facet_part, filter_part) { (Some(f), Some(l)) if !f.is_empty() && !l.is_empty() => { Some(format!("({f}) && ({l})")) } (Some(f), _) if !f.is_empty() => Some(f), (_, Some(l)) if !l.is_empty() => Some(l), _ => None, - }) + }; + + filter + .map(|filter| { + rewrite_filter_for_join(&filter, versions_collection) + .wrap_request_err("failed to rewrite search filter") + }) + .transpose() } - /// Ensures the alias and its backing collection both exist, creating them - /// when necessary so reads succeed before the first full index run. - async fn ensure_collection(&self, alias: &str) -> Result<()> { - if self.client.get_alias(alias).await?.is_some() { - return Ok(()); + async fn ensure_collections(&self) -> Result<()> { + let projects_alias = self.config.get_alias_name("projects"); + let projects_collection = if let Some(collection) = + self.client.get_alias(&projects_alias).await? + { + collection + } else { + let collection = + self.config.get_next_collection_name(&projects_alias, false); + if !self.client.collection_exists(&collection).await? { + self.client + .create_collection(&Self::project_collection_schema( + &collection, + )) + .await?; + } + self.client + .upsert_alias(&projects_alias, &collection) + .await?; + collection + }; + + let versions_alias = self.config.get_alias_name("versions"); + if self.client.get_alias(&versions_alias).await?.is_none() { + let collection = + self.config.get_next_collection_name(&versions_alias, false); + if !self.client.collection_exists(&collection).await? { + self.client + .create_collection(&Self::version_collection_schema( + &collection, + &projects_collection, + )) + .await?; + } + self.client + .upsert_alias(&versions_alias, &collection) + .await?; } - let name = self.config.get_next_collection_name(alias, false); - if !self.client.collection_exists(&name).await? { + Ok(()) + } + + async fn delete_documents_by_filter_if_exists( + &self, + collection: &str, + filter: &str, + ) -> Result<()> { + if self.client.collection_exists(collection).await? { self.client - .create_collection(&Self::collection_schema(&name)) + .delete_documents_by_filter( + collection, + filter, + self.config.delete_batch_size, + ) + .await?; + } + + Ok(()) + } + + async fn import_document_batches( + &self, + collections: &[String], + documents: &[UploadSearchProject], + ) -> Result<()> { + let batch_size = self.config.import_batch_size.max(1); + + for batch in documents.chunks(batch_size) { + let jsonl = documents_to_jsonl(batch)?; + + for collection in collections { + info!( + collection, + document_count = batch.len(), + content_length_bytes = jsonl.len(), + "sending Typesense document import" + ); + self.client + .import_documents(collection, jsonl.clone()) + .await?; + } + } + + Ok(()) + } + + async fn import_version_document_batches( + &self, + collections: &[String], + documents: &[UploadSearchVersion], + ) -> Result<()> { + let batch_size = self.config.import_batch_size.max(1); + + for batch in documents.chunks(batch_size) { + let jsonl = version_documents_to_jsonl(batch)?; + + for collection in collections { + info!( + collection, + document_count = batch.len(), + content_length_bytes = jsonl.len(), + "sending Typesense version document import" + ); + self.client + .import_documents(collection, jsonl.clone()) + .await?; + } + } + + Ok(()) + } + + async fn existing_write_collections( + &self, + alias: &str, + ) -> Result> { + let mut collections = Vec::new(); + + let live = self.client.get_alias(alias).await?; + let shadow_alt = self.config.get_next_collection_name(alias, true); + let shadow_current = self.config.get_next_collection_name(alias, false); + + for collection in live.into_iter().chain([shadow_alt, shadow_current]) { + if !collections.contains(&collection) + && self.client.collection_exists(&collection).await? + { + collections.push(collection); + } + } + + Ok(collections) + } + + async fn delete_from_write_collections( + &self, + alias: &str, + filter: &str, + ) -> Result<()> { + for collection in self.existing_write_collections(alias).await? { + self.delete_documents_by_filter_if_exists(&collection, filter) .await?; } - self.client.upsert_alias(alias, &name).await?; + Ok(()) + } + + async fn delete_ids_from_write_collections( + &self, + alias: &str, + field: &str, + ids: &[String], + ) -> Result<()> { + for ids in ids.chunks(DELETE_FILTER_ID_BATCH_SIZE) { + let filter = format!("{field}:[{}]", ids.iter().join(", ")); + self.delete_from_write_collections(alias, &filter).await?; + } + Ok(()) + } + + async fn delete_legacy_filtered_collections(&self) -> Result<()> { + let alias = self.config.get_alias_name("projects_filtered"); + let live = self.client.get_alias(&alias).await?; + let shadow_alt = self.config.get_next_collection_name(&alias, true); + let shadow_current = + self.config.get_next_collection_name(&alias, false); + + self.client.delete_alias_if_exists(&alias).await?; + for collection in live + .into_iter() + .chain([shadow_alt, shadow_current]) + .unique() + { + self.client.delete_collection_if_exists(&collection).await?; + } + Ok(()) } } @@ -744,7 +1003,8 @@ impl SearchBackend for Typesense { info.new_filters.as_deref(), &info.typesense_config, )?; - let filter_by = Self::build_filter(info)?; + let versions_alias = self.config.get_alias_name("versions"); + let filter_by = Self::build_filter(info, &versions_alias)?; let q = if parsed.query.is_empty() { "*" @@ -782,10 +1042,6 @@ impl SearchBackend for Typesense { ("sort_by", sort_by.to_string()), ("page", parsed.page.to_string()), ("per_page", parsed.hits_per_page.to_string()), - ("group_by", "project_id".to_string()), - ("group_limit", "1".to_string()), - ("facet_by", "project_id".to_string()), - ("max_facet_values", "0".to_string()), ( "max_candidates", info.typesense_config.max_candidates.to_string(), @@ -801,6 +1057,14 @@ impl SearchBackend for Typesense { } if let Some(filter) = &filter_by { params.push(("filter_by", filter.clone())); + if filter.contains(&format!("${versions_alias}(")) { + params.push(( + "include_fields", + format!( + "${versions_alias}(version_id, sort_by: version_published_timestamp:desc, limit:1, strategy: nest_array) as matching_versions" + ), + )); + } } let resp = self @@ -841,27 +1105,35 @@ impl SearchBackend for Typesense { .cloned() .unwrap_or(body); - let total_hits = body["facet_counts"] - .as_array() - .and_then(|facets| { - facets.iter().find(|facet| { - facet["field_name"].as_str() == Some("project_id") - }) - }) - .and_then(|facet| facet["stats"]["total_values"].as_u64()) - .unwrap_or_else(|| body["found"].as_u64().unwrap_or(0)) - as usize; + let total_hits = body["found"].as_u64().unwrap_or(0) as usize; - let hits = body["grouped_hits"] + let hits = body["hits"] .as_array() .cloned() .unwrap_or_default() .into_iter() - .filter_map(|group| { - let hit = group["hits"].as_array()?.first()?.clone(); + .filter_map(|hit| { let mut doc = hit.get("document")?.clone(); if let Some(obj) = doc.as_object_mut() { obj.remove("id"); + let matching_version_id = + obj.remove("matching_versions").and_then(|versions| { + versions + .as_array() + .and_then(|versions| versions.first()) + .or_else(|| { + versions.as_object().map(|_| &versions) + }) + .and_then(|version| version.get("version_id")) + .and_then(Value::as_str) + .map(ToString::to_string) + }); + if let Some(version_id) = matching_version_id { + obj.insert( + "version_id".to_string(), + Value::String(version_id), + ); + } } let metadata = info.show_metadata.then(|| { @@ -903,54 +1175,55 @@ impl SearchBackend for Typesense { info!("starting project indexing"); let projects_alias = self.config.get_alias_name("projects"); - let filtered_alias = self.config.get_alias_name("projects_filtered"); + let versions_alias = self.config.get_alias_name("versions"); - // Guarantee current aliases exist so reads keep working during re-index. - self.ensure_collection(&projects_alias).await?; - self.ensure_collection(&filtered_alias).await?; + self.ensure_collections().await?; - // Toggle the shadow collection name between __current and __alt. let projects_current = self.client.get_alias(&projects_alias).await?; - let filtered_current = self.client.get_alias(&filtered_alias).await?; + let versions_current = self.client.get_alias(&versions_alias).await?; let projects_use_alt = !projects_current .as_deref() .is_some_and(|n| n.ends_with("__alt")); - let filtered_use_alt = !filtered_current + let versions_use_alt = !versions_current .as_deref() .is_some_and(|n| n.ends_with("__alt")); let projects_next = self .config .get_next_collection_name(&projects_alias, projects_use_alt); - let filtered_next = self + let versions_next = self .config - .get_next_collection_name(&filtered_alias, filtered_use_alt); + .get_next_collection_name(&versions_alias, versions_use_alt); - info!("shadow collections `{projects_next}` and `{filtered_next}`"); + info!("shadow collections `{projects_next}` and `{versions_next}`"); self.client - .delete_collection_if_exists(&projects_next) + .delete_collection_if_exists(&versions_next) .await?; self.client - .delete_collection_if_exists(&filtered_next) + .delete_collection_if_exists(&projects_next) .await?; self.client - .create_collection(&Self::collection_schema(&projects_next)) + .create_collection(&Self::project_collection_schema(&projects_next)) .await?; self.client - .create_collection(&Self::collection_schema(&filtered_next)) + .create_collection(&Self::version_collection_schema( + &versions_next, + &projects_next, + )) .await?; let mut cursor = 0_i64; let mut chunk_idx = 0_usize; - let mut total = 0_usize; + let mut total_projects = 0_usize; + let mut total_versions = 0_usize; loop { info!("fetching index chunk {chunk_idx}"); chunk_idx += 1; - let (uploads, next_cursor) = index_local( + let (documents, next_cursor) = index_local( &ro_pool, &redis, cursor, @@ -959,21 +1232,27 @@ impl SearchBackend for Typesense { .await .wrap_err("failed to fetch projects from local DB")?; - if uploads.is_empty() { + if documents.projects.is_empty() { info!( - "no more documents; indexed {total} in {chunk_idx} chunks" + "no more documents; indexed {total_projects} projects and {total_versions} versions in {chunk_idx} chunks" ); break; } - total += uploads.len(); + total_projects += documents.projects.len(); + total_versions += documents.versions.len(); cursor = next_cursor; - let jsonl = documents_to_jsonl(&uploads)?; - self.client - .import_documents(&projects_next, jsonl.clone()) - .await?; - self.client.import_documents(&filtered_next, jsonl).await?; + self.import_document_batches( + std::slice::from_ref(&projects_next), + &documents.projects, + ) + .await?; + self.import_version_document_batches( + std::slice::from_ref(&versions_next), + &documents.versions, + ) + .await?; } info!("swapping aliases"); @@ -981,122 +1260,111 @@ impl SearchBackend for Typesense { .upsert_alias(&projects_alias, &projects_next) .await?; self.client - .upsert_alias(&filtered_alias, &filtered_next) + .upsert_alias(&versions_alias, &versions_next) .await?; info!("cleaning up old collections"); - if let Some(old) = projects_current { + if let Some(old) = versions_current { self.client.delete_collection_if_exists(&old).await?; } - if let Some(old) = filtered_current { + if let Some(old) = projects_current { self.client.delete_collection_if_exists(&old).await?; } + self.delete_legacy_filtered_collections().await?; + info!("indexing complete"); Ok(()) } - async fn index_documents( + async fn apply_update( &self, - documents: &[UploadSearchProject], + update: SearchIndexUpdate<'_>, ) -> eyre::Result<()> { - if documents.is_empty() { - return Ok(()); - } + let projects_alias = self.config.get_alias_name("projects"); + let versions_alias = self.config.get_alias_name("versions"); - let jsonl = documents_to_jsonl(documents)?; - for alias in [ - self.config.get_alias_name("projects"), - self.config.get_alias_name("projects_filtered"), - ] { - let live = self.client.get_alias(&alias).await?; - let shadow_alt = self.config.get_next_collection_name(&alias, true); - let shadow_current = - self.config.get_next_collection_name(&alias, false); - - for collection in - live.into_iter().chain([shadow_alt, shadow_current]) - { - if self.client.collection_exists(&collection).await? { - self.client - .import_documents(&collection, jsonl.clone()) - .await?; - } - } + let removed_project_ids = update + .removed_projects + .iter() + .map(ToString::to_string) + .collect::>(); + if !removed_project_ids.is_empty() { + self.delete_ids_from_write_collections( + &versions_alias, + "project_id", + &removed_project_ids, + ) + .await?; + self.delete_ids_from_write_collections( + &projects_alias, + "project_id", + &removed_project_ids, + ) + .await?; } - Ok(()) - } - - async fn remove_project_documents( - &self, - ids: &[ProjectId], - ) -> eyre::Result<()> { - if ids.is_empty() { - return Ok(()); + let version_ids = update + .removed_versions + .iter() + .map(ToString::to_string) + .chain( + update + .versions + .iter() + .map(|document| document.version_id.clone()), + ) + .unique() + .collect::>(); + if !version_ids.is_empty() { + self.delete_ids_from_write_collections( + &versions_alias, + "id", + &version_ids, + ) + .await?; } - let id_list = ids + let project_ids = update + .projects .iter() - .map(|id| to_base62(id.0)) - .collect::>() - .join(", "); - let filter = format!("project_id:[{id_list}]"); - - for alias in [ - self.config.get_alias_name("projects"), - self.config.get_alias_name("projects_filtered"), - ] { - let live = self.client.get_alias(&alias).await?; - let shadow_alt = self.config.get_next_collection_name(&alias, true); - let shadow_current = - self.config.get_next_collection_name(&alias, false); - - for collection in - live.into_iter().chain([shadow_alt, shadow_current]) - { - if self.client.collection_exists(&collection).await? { - self.client - .delete_documents_by_filter(&collection, &filter) - .await?; - } - } + .map(|document| document.project_id.clone()) + .unique() + .collect::>(); + if !project_ids.is_empty() { + self.delete_ids_from_write_collections( + &projects_alias, + "project_id", + &project_ids, + ) + .await?; } - Ok(()) - } - async fn remove_documents(&self, ids: &[VersionId]) -> eyre::Result<()> { - if ids.is_empty() { - return Ok(()); + if !update.projects.is_empty() { + let collections = + self.existing_write_collections(&projects_alias).await?; + debug!( + ?collections, + num_documents = update.projects.len(), + "Replacing project documents in collections", + ); + self.import_document_batches(&collections, update.projects) + .await?; } - let id_list = ids - .iter() - .map(|id| to_base62(id.0)) - .collect::>() - .join(", "); - let filter = format!("id:[{id_list}]"); - - for alias in [ - self.config.get_alias_name("projects"), - self.config.get_alias_name("projects_filtered"), - ] { - // Delete from both the live collection and any shadow collections. - let live = self.client.get_alias(&alias).await?; - let shadow_alt = self.config.get_next_collection_name(&alias, true); - let shadow_current = - self.config.get_next_collection_name(&alias, false); - - for collection in - live.into_iter().chain([shadow_alt, shadow_current]) - { - if self.client.collection_exists(&collection).await? { - self.client - .delete_documents_by_filter(&collection, &filter) - .await?; - } - } + if !update.versions.is_empty() { + let collections = + self.existing_write_collections(&versions_alias).await?; + debug!( + ?collections, + num_documents = update.versions.len(), + "Replacing version documents in collections", + ); + self.import_version_document_batches(&collections, update.versions) + .await?; } + + debug!("Done applying search index update"); Ok(()) } @@ -1115,7 +1383,7 @@ impl SearchBackend for Typesense { /// Serialises a batch of [`UploadSearchProject`]s to a JSONL string suitable /// for the Typesense bulk-import endpoint. Each document gets an `id` field -/// equal to `version_id` so Typesense can use it as the primary key. +/// equal to `project_id` so Typesense can use it as the primary key. fn documents_to_jsonl(uploads: &[UploadSearchProject]) -> Result { let mut out = String::new(); for upload in uploads { @@ -1123,7 +1391,7 @@ fn documents_to_jsonl(uploads: &[UploadSearchProject]) -> Result { .wrap_err("failed to serialise UploadSearchProject")?; if let Some(obj) = doc.as_object_mut() { let id = obj - .get("version_id") + .get("project_id") .and_then(Value::as_str) .unwrap_or_default() .to_string(); @@ -1147,6 +1415,271 @@ fn documents_to_jsonl(uploads: &[UploadSearchProject]) -> Result { Ok(out) } +fn version_documents_to_jsonl( + uploads: &[UploadSearchVersion], +) -> Result { + let mut out = String::new(); + for upload in uploads { + let mut document = serde_json::to_value(upload) + .wrap_err("failed to serialise UploadSearchVersion")?; + if let Some(object) = document.as_object_mut() { + object.insert( + "id".to_string(), + Value::String(upload.version_id.clone()), + ); + } + out.push_str(&serde_json::to_string(&document)?); + out.push('\n'); + } + Ok(out) +} + +#[derive(Clone, Default)] +struct JoinedFilterClause { + project: Vec, + version: Vec, +} + +fn rewrite_filter_for_join( + filter: &str, + versions_collection: &str, +) -> Result { + const MAX_CLAUSES: usize = 256; + + fn parse(expression: &str) -> Result> { + let expression = trim_outer_parentheses(expression.trim()); + + let or_parts = split_top_level(expression, "||"); + if or_parts.len() > 1 { + let mut clauses = Vec::new(); + for part in or_parts { + clauses.extend(parse(part)?); + if clauses.len() > MAX_CLAUSES { + return Err(eyre!( + "search filter has too many boolean clauses" + )); + } + } + return Ok(clauses); + } + + let and_parts = split_top_level(expression, "&&"); + if and_parts.len() > 1 { + let mut clauses = vec![JoinedFilterClause::default()]; + for part in and_parts { + let right = parse(part)?; + if clauses.len().saturating_mul(right.len()) > MAX_CLAUSES { + return Err(eyre!( + "search filter has too many boolean clauses" + )); + } + clauses = clauses + .into_iter() + .cartesian_product(right) + .map(|(mut left, right)| { + left.project.extend(right.project); + left.version.extend(right.version); + left + }) + .collect(); + } + return Ok(clauses); + } + + let field = filter_field(expression).ok_or_else(|| { + eyre!("could not determine filter field in `{expression}`") + })?; + let mut clause = JoinedFilterClause::default(); + if field == "categories" { + let project_expression = + expression.replacen("categories", "project_categories", 1); + if is_negative_filter(expression) { + clause.project.push(project_expression); + clause.version.push(expression.to_string()); + Ok(vec![clause]) + } else { + Ok(vec![ + JoinedFilterClause { + project: vec![project_expression], + version: Vec::new(), + }, + JoinedFilterClause { + project: Vec::new(), + version: vec![expression.to_string()], + }, + ]) + } + } else { + if is_version_filter_field(field) { + clause.version.push(expression.to_string()); + } else { + clause.project.push(expression.to_string()); + } + Ok(vec![clause]) + } + } + + let clauses = parse(filter)?; + Ok(clauses + .into_iter() + .map(|clause| { + let mut parts = clause.project; + if !clause.version.is_empty() { + parts.push(format!( + "${versions_collection}({})", + clause.version.join(" && ") + )); + } + if parts.len() == 1 { + parts.pop().unwrap_or_default() + } else { + format!("({})", parts.join(" && ")) + } + }) + .join(" || ")) +} + +fn is_version_filter_field(field: &str) -> bool { + matches!( + field, + "categories" + | "project_types" + | "environment" + | "game_versions" + | "client_side" + | "server_side" + ) +} + +fn is_negative_filter(expression: &str) -> bool { + expression + .split_once(':') + .is_some_and(|(_, value)| value.trim_start().starts_with("!=")) +} + +fn filter_field(expression: &str) -> Option<&str> { + let operator = expression.find(':')?; + let field = expression[..operator].trim(); + (!field.is_empty() + && field.chars().all(|character| { + character.is_ascii_alphanumeric() || "_.".contains(character) + })) + .then_some(field) +} + +fn trim_outer_parentheses(mut expression: &str) -> &str { + while expression.starts_with('(') + && expression.ends_with(')') + && matching_outer_parentheses(expression) + { + expression = expression[1..expression.len() - 1].trim(); + } + expression +} + +fn matching_outer_parentheses(expression: &str) -> bool { + let mut depth = 0; + let mut quote = None; + let mut escaped = false; + + for (index, character) in expression.char_indices() { + if escaped { + escaped = false; + continue; + } + if character == '\\' { + escaped = true; + continue; + } + if let Some(active_quote) = quote { + if character == active_quote { + quote = None; + } + continue; + } + if matches!(character, '\'' | '"' | '`') { + quote = Some(character); + continue; + } + match character { + '(' => depth += 1, + ')' => { + depth -= 1; + if depth == 0 && index + character.len_utf8() < expression.len() + { + return false; + } + } + _ => {} + } + } + + depth == 0 +} + +fn split_top_level<'a>(expression: &'a str, operator: &str) -> Vec<&'a str> { + let mut parts = Vec::new(); + let mut start = 0; + let mut parentheses = 0; + let mut brackets = 0; + let mut quote = None; + let mut escaped = false; + let bytes = expression.as_bytes(); + let mut index = 0; + + while index < bytes.len() { + let character = expression[index..].chars().next().unwrap_or_default(); + let width = character.len_utf8(); + if escaped { + escaped = false; + index += width; + continue; + } + if character == '\\' { + escaped = true; + index += width; + continue; + } + if let Some(active_quote) = quote { + if character == active_quote { + quote = None; + } + index += width; + continue; + } + if matches!(character, '\'' | '"' | '`') { + quote = Some(character); + index += width; + continue; + } + match character { + '(' => parentheses += 1, + ')' => parentheses -= 1, + '[' => brackets += 1, + ']' => brackets -= 1, + _ => {} + } + + if parentheses == 0 + && brackets == 0 + && expression[index..].starts_with(operator) + { + parts.push(expression[start..index].trim()); + index += operator.len(); + start = index; + continue; + } + index += width; + } + + if parts.is_empty() { + vec![expression] + } else { + parts.push(expression[start..].trim()); + parts + } +} + /// Translates a Meilisearch filter expression into Typesense `filter_by` /// syntax. /// @@ -1279,3 +1812,61 @@ fn condition_to_typesense_filter(cond: &str) -> String { } cond.to_string() } + +#[cfg(test)] +mod tests { + use super::rewrite_filter_for_join; + + #[test] + fn project_filters_do_not_join_versions() { + assert_eq!( + rewrite_filter_for_join("license:= MIT", "versions").unwrap(), + "license:= MIT" + ); + } + + #[test] + fn correlated_version_filters_share_one_join() { + assert_eq!( + rewrite_filter_for_join( + "categories:= fabric && game_versions:= 1.21", + "versions", + ) + .unwrap(), + "(project_categories:= fabric && $versions(game_versions:= 1.21)) || $versions(categories:= fabric && game_versions:= 1.21)" + ); + } + + #[test] + fn project_and_version_filters_are_partitioned() { + assert_eq!( + rewrite_filter_for_join( + "license:= MIT && categories:= fabric", + "versions", + ) + .unwrap(), + "(license:= MIT && project_categories:= fabric) || (license:= MIT && $versions(categories:= fabric))" + ); + } + + #[test] + fn mixed_boolean_filters_preserve_version_correlation() { + assert_eq!( + rewrite_filter_for_join( + "(license:= MIT || categories:= fabric) && game_versions:= 1.21", + "versions", + ) + .unwrap(), + "(license:= MIT && $versions(game_versions:= 1.21)) || (project_categories:= fabric && $versions(game_versions:= 1.21)) || $versions(categories:= fabric && game_versions:= 1.21)" + ); + } + + #[test] + fn negative_categories_require_project_and_version_exclusion() { + assert_eq!( + rewrite_filter_for_join("categories:!= fabric", "versions") + .unwrap(), + "(project_categories:!= fabric && $versions(categories:!= fabric))" + ); + } +} diff --git a/apps/labrinth/src/search/incremental.rs b/apps/labrinth/src/search/incremental.rs index 07c5a05b55..a418e7638c 100644 --- a/apps/labrinth/src/search/incremental.rs +++ b/apps/labrinth/src/search/incremental.rs @@ -1,43 +1,66 @@ pub mod consume; -use std::{mem, sync::Arc}; +use std::{ + collections::{HashMap, HashSet}, + mem, + sync::Arc, + time::Duration, +}; use rdkafka::{producer::FutureRecord, util::Timeout}; use serde::Serialize; use tokio::sync::Mutex; use crate::{ - models::ids::ProjectId, + models::ids::{ProjectId, VersionId}, util::kafka::{KAFKA_OPERATION_INTERVAL, KafkaClientState, KafkaEvent}, }; pub const SEARCH_PROJECT_INDEX_QUEUE_TOPIC: &str = "public.labrinth.search-project-index-queue.v1"; +const QUEUE_FLUSH_INTERVAL: Duration = Duration::from_secs(10); #[derive(Clone)] pub struct IncrementalSearchQueue { - operations: Arc>>, + operations: Arc>, kafka_client: actix_web::web::Data, } impl IncrementalSearchQueue { pub fn new(kafka_client: actix_web::web::Data) -> Self { Self { - operations: Arc::new(Mutex::new(Vec::new())), + operations: Arc::new(Mutex::new( + PendingSearchIndexOperations::default(), + )), kafka_client, } } pub async fn push(&self, project_id: ProjectId) { + self.operations.lock().await.push_project_change(project_id); + } + + pub async fn push_versions( + &self, + project_id: ProjectId, + version_ids: impl IntoIterator, + ) { + self.operations + .lock() + .await + .push_version_change(project_id, version_ids); + } + + pub async fn push_project_removal(&self, project_id: ProjectId) { self.operations .lock() .await - .push(SearchIndexOperation { project_id }); + .push_project_removal(project_id); } pub async fn run(self) { loop { - tokio::time::sleep(KAFKA_OPERATION_INTERVAL).await; + tokio::time::sleep(QUEUE_FLUSH_INTERVAL).await; if let Err(err) = self.drain().await { tracing::error!( @@ -57,13 +80,11 @@ impl IncrementalSearchQueue { return Ok(()); } - let mut operations = operations.into_iter(); + let mut operations = operations.into_events().into_iter(); while let Some(operation) = operations.next() { let event = KafkaEvent::new( SEARCH_PROJECT_INDEX_QUEUE_TOPIC, - SearchProjectIndexQueueEventData { - project_id: operation.project_id, - }, + operation.clone(), ); let event_id = event.event_metadata.event_id; let key = event_id.to_string(); @@ -79,8 +100,10 @@ impl IncrementalSearchQueue { .await { let mut queued_operations = self.operations.lock().await; - queued_operations.push(operation); - queued_operations.extend(operations); + queued_operations.push_event(operation); + for operation in operations { + queued_operations.push_event(operation); + } return Err(err.into()); } @@ -90,12 +113,100 @@ impl IncrementalSearchQueue { } } -#[derive(Debug, Clone)] -pub struct SearchIndexOperation { - pub project_id: ProjectId, +#[derive(Default)] +struct PendingSearchIndexOperations { + changed_project_ids: HashSet, + changed_project_versions: HashMap>, + removed_project_ids: HashSet, +} + +impl PendingSearchIndexOperations { + fn is_empty(&self) -> bool { + self.changed_project_ids.is_empty() + && self.changed_project_versions.is_empty() + && self.removed_project_ids.is_empty() + } + + fn push_project_change(&mut self, project_id: ProjectId) { + if !self.removed_project_ids.contains(&project_id) { + self.changed_project_ids.insert(project_id); + } + } + + fn push_version_change( + &mut self, + project_id: ProjectId, + version_ids: impl IntoIterator, + ) { + if self.removed_project_ids.contains(&project_id) { + return; + } + + let version_ids = version_ids.into_iter().collect::>(); + if !version_ids.is_empty() { + self.changed_project_versions + .entry(project_id) + .or_default() + .extend(version_ids); + } + } + + fn push_project_removal(&mut self, project_id: ProjectId) { + self.changed_project_ids.remove(&project_id); + self.changed_project_versions.remove(&project_id); + self.removed_project_ids.insert(project_id); + } + + fn push_event(&mut self, event: SearchProjectIndexQueueEventData) { + match event { + SearchProjectIndexQueueEventData::Change { project_id } => { + self.push_project_change(project_id) + } + SearchProjectIndexQueueEventData::VersionChange { + project_id, + version_ids, + } => self.push_version_change(project_id, version_ids), + SearchProjectIndexQueueEventData::Removal { project_id } => { + self.push_project_removal(project_id) + } + } + } + + fn into_events(self) -> Vec { + let mut events = Vec::with_capacity( + self.changed_project_ids.len() + + self.changed_project_versions.len() + + self.removed_project_ids.len(), + ); + + events.extend(self.removed_project_ids.into_iter().map(|project_id| { + SearchProjectIndexQueueEventData::Removal { project_id } + })); + events.extend(self.changed_project_ids.into_iter().map(|project_id| { + SearchProjectIndexQueueEventData::Change { project_id } + })); + events.extend(self.changed_project_versions.into_iter().map( + |(project_id, version_ids)| { + SearchProjectIndexQueueEventData::VersionChange { + project_id, + version_ids: version_ids.into_iter().collect(), + } + }, + )); + events + } } -#[derive(Debug, Serialize)] -pub struct SearchProjectIndexQueueEventData { - pub project_id: ProjectId, +#[derive(Debug, Clone, Serialize)] +#[serde(tag = "type", rename_all = "snake_case")] +pub enum SearchProjectIndexQueueEventData { + #[serde(rename = "project_change")] + Change { project_id: ProjectId }, + #[serde(rename = "project_version_change")] + VersionChange { + project_id: ProjectId, + version_ids: Vec, + }, + #[serde(rename = "project_removal")] + Removal { project_id: ProjectId }, } diff --git a/apps/labrinth/src/search/incremental/consume.rs b/apps/labrinth/src/search/incremental/consume.rs index 69e3b30f54..d7c31af85b 100644 --- a/apps/labrinth/src/search/incremental/consume.rs +++ b/apps/labrinth/src/search/incremental/consume.rs @@ -1,20 +1,26 @@ use actix_web::web; use eyre::WrapErr; -use futures::FutureExt; use rdkafka::{ Message, consumer::{CommitMode, Consumer, StreamConsumer}, message::BorrowedMessage, }; use serde::Deserialize; -use std::collections::HashSet; +use std::{ + collections::HashSet, + time::{Duration, Instant}, +}; +use tracing::{Instrument, info, info_span}; use crate::{ database::{PgPool, redis::RedisPool}, - models::ids::ProjectId, + env::ENV, + models::ids::{ProjectId, VersionId}, search::{ - SearchBackend, incremental::SEARCH_PROJECT_INDEX_QUEUE_TOPIC, - indexing::index_project_documents, + SearchBackend, SearchDocumentBatch, SearchIndexUpdate, + UploadSearchProject, + incremental::SEARCH_PROJECT_INDEX_QUEUE_TOPIC, + indexing::{index_project_documents, index_project_version_documents}, }, util::kafka::{ INCREMENTAL_INDEX_SEARCH_TASK, KAFKA_OPERATION_INTERVAL, @@ -22,8 +28,6 @@ use crate::{ }, }; -const BATCH_SIZE: usize = 100; - pub async fn run( ro_pool: PgPool, redis_pool: RedisPool, @@ -60,25 +64,60 @@ async fn consume( search_backend: &dyn SearchBackend, consumer: &StreamConsumer, ) -> eyre::Result<()> { + // keep buffer capacity (pre-)allocated + let mut messages = Vec::with_capacity(1024); loop { - let mut messages = Vec::with_capacity(BATCH_SIZE); - messages.push( - consumer - .recv() - .await - .wrap_err("failed to receive Kafka message")?, - ); + messages.clear(); - while messages.len() < BATCH_SIZE { - let Some(message) = consumer.recv().now_or_never() else { - break; - }; + // wait for a first message to come in... + let first_message = consumer + .recv() + .await + .wrap_err("failed to receive Kafka message")?; + messages.push(first_message); - messages.push(message.wrap_err("failed to receive Kafka message")?); + let delay = Duration::from_secs( + ENV.SEARCH_INCREMENTAL_INDEX_BATCH_DELAY_SECONDS, + ); + info!( + "Received initial Kafka message; waiting {delay:.2?} for more to batch", + ); + + // ..then wait a while for more messages to batch up + // so that we can process a big batch to reindex. + // we stop until either we've reached the max batch size, + // or we've waited enough time - whichever is first. + // + // do a little trick with an `AsyncFnMut` closure + // so that we can explicitly specify the return type + let mut collect_more_messages = async || -> eyre::Result<()> { + while messages.len() < ENV.SEARCH_INCREMENTAL_INDEX_BATCH_MAX_SIZE { + let message = consumer + .recv() + .await + .wrap_err("failed to receive Kafka message")?; + messages.push(message); + } + eyre::Ok(()) + }; + match tokio::time::timeout(delay, collect_more_messages()).await { + Ok(Ok(())) | Err(_) => {} + Ok(Err(err)) => { + return Err( + err.wrap_err("failed to receive more Kafka messages") + ); + } } - consume_batch(ro_pool, redis_pool, search_backend, consumer, messages) - .await?; + info!("Consuming batch of {} messages", messages.len()); + consume_batch( + ro_pool, + redis_pool, + search_backend, + consumer, + messages.drain(..), + ) + .await?; } } @@ -87,10 +126,14 @@ async fn consume_batch( redis_pool: &RedisPool, search_backend: &dyn SearchBackend, consumer: &StreamConsumer, - messages: Vec>, + messages: impl IntoIterator>, ) -> eyre::Result<()> { - let mut project_ids = Vec::new(); - let mut seen_project_ids = HashSet::new(); + let start = Instant::now(); + + let mut project_ids_to_change = HashSet::new(); + let mut project_ids_with_version_changes = HashSet::new(); + let mut project_ids_to_remove = HashSet::new(); + let mut version_ids_to_change = HashSet::new(); let mut messages_to_commit = Vec::new(); for message in messages { @@ -125,25 +168,111 @@ async fn consume_batch( } }; - if seen_project_ids.insert(event.project_id) { - project_ids.push(event.project_id); + match event.into_data() { + SearchProjectIndexQueueEventData::Change { project_id } => { + project_ids_to_change.insert(project_id); + } + SearchProjectIndexQueueEventData::VersionChange { + project_id, + version_ids, + } => { + if !version_ids.is_empty() { + project_ids_with_version_changes.insert(project_id); + version_ids_to_change.extend(version_ids); + } + } + SearchProjectIndexQueueEventData::Removal { project_id } => { + project_ids_to_remove.insert(project_id); + } } messages_to_commit.push(message); } - if project_ids.is_empty() { - return Ok(()); - } + project_ids_to_change + .retain(|project_id| !project_ids_to_remove.contains(project_id)); + project_ids_with_version_changes + .retain(|project_id| !project_ids_to_remove.contains(project_id)); + project_ids_to_change.retain(|project_id| { + !project_ids_with_version_changes.contains(project_id) + }); + let project_ids_to_change = + project_ids_to_change.into_iter().collect::>(); + let project_ids_with_version_changes = project_ids_with_version_changes + .into_iter() + .collect::>(); + let project_ids_to_remove = + project_ids_to_remove.into_iter().collect::>(); + let version_ids_to_change = + version_ids_to_change.into_iter().collect::>(); - tracing::info!( + info!( kafka.message_count = messages_to_commit.len(), - project_count = project_ids.len(), - "Consumed incremental search index event batch" + "Read all Kafka messages in {:.2?}, found {} projects to change, {} projects with {} version changes, and {} projects to remove", + start.elapsed(), + project_ids_to_change.len(), + project_ids_with_version_changes.len(), + version_ids_to_change.len(), + project_ids_to_remove.len(), ); + let start = Instant::now(); + let mut documents = SearchDocumentBatch::default(); + + if !project_ids_with_version_changes.is_empty() { + let operation_start = Instant::now(); + let changed_documents = build_changed_project_versions( + ro_pool, + redis_pool, + &project_ids_with_version_changes, + &version_ids_to_change, + ) + .await + .wrap_err("failed to build changed project versions")?; + documents.projects.extend(changed_documents.projects); + documents.versions.extend(changed_documents.versions); + info!( + project_count = project_ids_with_version_changes.len(), + version_count = version_ids_to_change.len(), + "Built changed project versions in {:.2?}", + operation_start.elapsed() + ); + } + + if !project_ids_to_change.is_empty() { + let operation_start = Instant::now(); + info!( + project_count = project_ids_to_change.len(), + "Building changed projects" + ); + documents.projects.extend( + build_changed_projects(ro_pool, redis_pool, &project_ids_to_change) + .await + .wrap_err("failed to build changed projects")?, + ); + info!( + project_count = project_ids_to_change.len(), + "Built changed projects in {:.2?}", + operation_start.elapsed() + ); + } - reindex_projects(ro_pool, redis_pool, search_backend, &project_ids) + let operation_start = Instant::now(); + search_backend + .apply_update(SearchIndexUpdate { + projects: &documents.projects, + versions: &documents.versions, + removed_projects: &project_ids_to_remove, + removed_versions: &version_ids_to_change, + }) .await - .wrap_err("failed to reindex project batch")?; + .wrap_err("failed to apply search index update")?; + info!( + project_count = documents.projects.len(), + version_count = documents.versions.len(), + removed_project_count = project_ids_to_remove.len(), + removed_version_count = version_ids_to_change.len(), + "Applied search index update in {:.2?}", + operation_start.elapsed() + ); for message in messages_to_commit { consumer @@ -151,6 +280,13 @@ async fn consume_batch( .wrap_err("failed to commit Kafka message")?; } + info!( + "Changed {} projects and removed {} projects in {:.2?}", + project_ids_to_change.len(), + project_ids_to_remove.len(), + start.elapsed() + ); + Ok(()) } @@ -169,27 +305,119 @@ pub async fn reindex_projects( search_backend: &dyn SearchBackend, project_ids: &[ProjectId], ) -> eyre::Result<()> { - search_backend.remove_project_documents(project_ids).await?; + info!("Creating project documents"); + let projects = + build_changed_projects(ro_pool, redis_pool, project_ids).await?; + search_backend + .apply_update(SearchIndexUpdate { + projects: &projects, + ..SearchIndexUpdate::default() + }) + .await?; - let mut documents = Vec::new(); - for project_id in project_ids { - documents.extend( - index_project_documents(ro_pool, redis_pool, *project_id) - .await - .wrap_err_with(|| { - format!( - "failed to build project {project_id} search documents" - ) - })?, - ); - } + Ok(()) +} - search_backend.index_documents(&documents).await?; +async fn build_changed_projects( + ro_pool: &PgPool, + redis_pool: &RedisPool, + project_ids: &[ProjectId], +) -> eyre::Result> { + let documents = index_project_documents(ro_pool, redis_pool, project_ids) + .instrument(info_span!("index", batch_size = project_ids.len())) + .await + .wrap_err_with(|| { + format!( + "failed to build search documents for {} projects", + project_ids.len() + ) + })?; - Ok(()) + info!("Fetched all project documents"); + Ok(documents) +} + +async fn build_changed_project_versions( + ro_pool: &PgPool, + redis_pool: &RedisPool, + project_ids: &[ProjectId], + version_ids: &[VersionId], +) -> eyre::Result { + let documents = index_project_version_documents( + ro_pool, + redis_pool, + project_ids, + version_ids, + ) + .instrument(info_span!( + "index", + batch_size = project_ids.len(), + version_count = version_ids.len() + )) + .await + .wrap_err_with(|| { + format!( + "failed to build search documents for {} projects and {} versions", + project_ids.len(), + version_ids.len() + ) + })?; + + Ok(documents) +} + +pub async fn reindex_project_versions( + ro_pool: &PgPool, + redis_pool: &RedisPool, + search_backend: &dyn SearchBackend, + project_ids: &[ProjectId], + version_ids: &[VersionId], +) -> eyre::Result<()> { + let documents = build_changed_project_versions( + ro_pool, + redis_pool, + project_ids, + version_ids, + ) + .await?; + search_backend + .apply_update(SearchIndexUpdate { + projects: &documents.projects, + versions: &documents.versions, + removed_versions: version_ids, + ..SearchIndexUpdate::default() + }) + .await } #[derive(Debug, Deserialize)] -struct SearchProjectIndexQueueEvent { - project_id: ProjectId, +#[serde(untagged)] +enum SearchProjectIndexQueueEvent { + Current(SearchProjectIndexQueueEventData), + Legacy { project_id: ProjectId }, +} + +impl SearchProjectIndexQueueEvent { + fn into_data(self) -> SearchProjectIndexQueueEventData { + match self { + Self::Current(data) => data, + Self::Legacy { project_id } => { + SearchProjectIndexQueueEventData::Change { project_id } + } + } + } +} + +#[derive(Debug, Deserialize)] +#[serde(tag = "type", rename_all = "snake_case")] +enum SearchProjectIndexQueueEventData { + #[serde(rename = "project_change")] + Change { project_id: ProjectId }, + #[serde(rename = "project_version_change")] + VersionChange { + project_id: ProjectId, + version_ids: Vec, + }, + #[serde(rename = "project_removal")] + Removal { project_id: ProjectId }, } diff --git a/apps/labrinth/src/search/indexing.rs b/apps/labrinth/src/search/indexing.rs index 50fc706206..3338b6e590 100644 --- a/apps/labrinth/src/search/indexing.rs +++ b/apps/labrinth/src/search/indexing.rs @@ -5,7 +5,7 @@ use futures::TryStreamExt; use heck::ToKebabCase; use itertools::Itertools; use regex::Regex; -use std::collections::HashMap; +use std::collections::{HashMap, HashSet}; use std::sync::LazyLock; use tracing::{info, warn}; @@ -20,11 +20,14 @@ use crate::database::models::{ }; use crate::database::redis::RedisPool; use crate::models::exp; -use crate::models::ids::ProjectId; +use crate::models::ids::{ProjectId, VersionId}; use crate::models::projects::{DependencyType, from_duplicate_version_fields}; use crate::models::v2::projects::LegacyProject; use crate::routes::v2_reroute; -use crate::search::{SearchProjectDependency, UploadSearchProject}; +use crate::search::{ + SearchDocumentBatch, SearchProjectDependency, UploadSearchProject, + UploadSearchVersion, +}; use crate::util::error::Context; struct PartialProject { @@ -68,7 +71,7 @@ pub async fn index_local( redis: &RedisPool, cursor: i64, limit: i64, -) -> eyre::Result<(Vec, i64)> { +) -> eyre::Result<(SearchDocumentBatch, i64)> { info!("Indexing local projects!"); let searchable_statuses = searchable_statuses(); @@ -111,20 +114,95 @@ pub async fn index_local( let project_ids = db_projects.iter().map(|x| x.id.0).collect::>(); let Some(largest) = project_ids.iter().max() else { - return Ok((vec![], i64::MAX)); + return Ok((SearchDocumentBatch::default(), i64::MAX)); }; - let uploads = build_search_documents(pool, redis, db_projects).await?; - Ok((uploads, *largest)) + let documents = build_search_documents(pool, redis, db_projects).await?; + Ok((documents, *largest)) } pub async fn index_project_documents( pool: &PgPool, redis: &RedisPool, - project_id: ProjectId, + project_ids: &[ProjectId], ) -> eyre::Result> { let searchable_statuses = searchable_statuses(); - let project_ids = vec![DBProjectId::from(project_id).0]; + let project_ids = project_ids + .iter() + .map(|project_id| DBProjectId::from(*project_id).0) + .collect::>(); + + let db_projects = sqlx::query!( + r#" + SELECT m.id id, m.name name, m.summary summary, m.downloads downloads, m.follows follows, + m.icon_url icon_url, m.updated updated, m.approved approved, m.published, m.license license, m.slug slug, m.color, + m.components AS "components: sqlx::types::Json" + FROM mods m + WHERE m.status = ANY($1) AND m.id = ANY($2) + GROUP BY m.id + ORDER BY m.id ASC; + "#, + &searchable_statuses, + &project_ids, + ) + .fetch(pool) + .map_ok(|m| PartialProject { + id: DBProjectId(m.id), + name: m.name, + summary: m.summary, + downloads: m.downloads, + follows: m.follows, + icon_url: m.icon_url, + updated: m.updated, + approved: m.approved.unwrap_or(m.published), + slug: m.slug, + color: m.color, + license: m.license, + components: m.components.0, + }) + .try_collect::>() + .await + .wrap_err("failed to fetch project")?; + + info!("Fetched partial projects"); + + Ok(build_search_documents(pool, redis, db_projects) + .await? + .projects) +} + +pub async fn index_project_version_documents( + pool: &PgPool, + redis: &RedisPool, + project_ids: &[ProjectId], + version_ids: &[VersionId], +) -> eyre::Result { + let projects = + index_project_document_batch(pool, redis, project_ids).await?; + let version_ids = version_ids + .iter() + .map(ToString::to_string) + .collect::>(); + Ok(SearchDocumentBatch { + projects: projects.projects, + versions: projects + .versions + .into_iter() + .filter(|version| version_ids.contains(&version.version_id)) + .collect(), + }) +} + +async fn index_project_document_batch( + pool: &PgPool, + redis: &RedisPool, + project_ids: &[ProjectId], +) -> eyre::Result { + let searchable_statuses = searchable_statuses(); + let project_ids = project_ids + .iter() + .map(|project_id| DBProjectId::from(*project_id).0) + .collect::>(); let db_projects = sqlx::query!( r#" @@ -165,7 +243,7 @@ async fn build_search_documents( pool: &PgPool, redis: &RedisPool, db_projects: Vec, -) -> eyre::Result> { +) -> eyre::Result { let searchable_statuses = searchable_statuses(); let project_ids = db_projects.iter().map(|x| x.id.0).collect::>(); let project_components = db_projects @@ -333,7 +411,7 @@ async fn build_search_documents( .await?; info!("Getting all loader fields!"); - let loader_fields: Vec = sqlx::query!( + let loader_field_definitions: Vec = sqlx::query!( " SELECT DISTINCT id, field, field_type, enum_type, min_val, max_val, optional FROM loader_fields lf @@ -351,7 +429,8 @@ async fn build_search_documents( }) .try_collect() .await?; - let loader_fields: Vec<&QueryLoaderField> = loader_fields.iter().collect(); + let loader_field_definitions: Vec<&QueryLoaderField> = + loader_field_definitions.iter().collect(); info!("Getting all loader field enum values!"); @@ -376,7 +455,8 @@ async fn build_search_documents( .await?; info!("Indexing loaders, project types!"); - let mut uploads = Vec::new(); + let mut project_uploads = Vec::new(); + let mut version_uploads = Vec::new(); let total_len = db_projects.len(); let mut count = 0; @@ -475,176 +555,221 @@ async fn build_search_documents( .collect::>(); if let Some(versions) = versions.remove(&project.id) { - // Aggregated project loader fields + let Some(latest_version) = versions.iter().max_by(|a, b| { + a.date_published + .cmp(&b.date_published) + .then_with(|| a.id.0.cmp(&b.id.0)) + }) else { + continue; + }; + let project_version_fields = versions .iter() .flat_map(|x| x.version_fields.clone()) .collect::>(); let aggregated_version_fields = VersionField::from_query_json( project_version_fields, - &loader_fields, + &loader_field_definitions, &loader_field_enum_values, true, ); - let project_loader_fields = + let unvectorized_loader_fields = aggregated_version_fields + .iter() + .map(|field| { + (field.field_name.clone(), field.value.serialize_internal()) + }) + .collect(); + let mut loader_fields = from_duplicate_version_fields(aggregated_version_fields); + let project_loader_fields = loader_fields.clone(); - // aggregated project loaders - let project_loaders = versions + let mut project_loaders = versions .iter() .flat_map(|x| x.loaders.clone()) .collect::>(); + project_loaders.sort(); + project_loaders.dedup(); - // all valid project types across every version of the project, so that - // filters can exclude projects that have *any* version of a given - // project type (unlike the version-specific `project_types` field). - let mut all_project_types = versions + let mut project_types = versions .iter() .flat_map(|x| x.project_types.clone()) .collect::>(); - all_project_types.sort(); - all_project_types.dedup(); + project_types.sort(); + project_types.dedup(); exp::compat::correct_project_types( &project.components, - &mut all_project_types, + &mut project_types, ); - for version in versions { + let project_id = ProjectId::from(project.id).to_string(); + version_uploads.extend(versions.iter().map(|version| { let version_fields = VersionField::from_query_json( - version.version_fields, - &loader_fields, + version.version_fields.clone(), + &loader_field_definitions, &loader_field_enum_values, false, ); let unvectorized_loader_fields = version_fields .iter() - .map(|vf| { - (vf.field_name.clone(), vf.value.serialize_internal()) + .map(|field| { + ( + field.field_name.clone(), + field.value.serialize_internal(), + ) }) .collect(); - let mut loader_fields = - from_duplicate_version_fields(version_fields); - let mut project_types = version.project_types; - + let mut fields = from_duplicate_version_fields(version_fields); + let mut version_project_types = version.project_types.clone(); exp::compat::correct_project_types( &project.components, - &mut project_types, + &mut version_project_types, ); - let mut version_loaders = version.loaders; - - // Uses version loaders, not project loaders. - let mut categories = categories.clone(); - categories.append(&mut version_loaders.clone()); - - let display_categories = display_categories.clone(); - categories.append(&mut version_loaders); - - // SPECIAL BEHAVIOUR - // Todo: revisit. - // For consistency with v2 searching, we consider the loader field 'mrpack_loaders' to be a category. - // These were previously considered the loader, and in v2, the loader is a category for searching. - // So to avoid breakage or awkward conversions, we just consider those loader_fields to be categories. - // The loaders are kept in loader_fields as well, so that no information is lost on retrieval. - let mrpack_loaders = loader_fields + let mut version_categories = version.loaders.clone(); + let mrpack_loaders = fields .get("mrpack_loaders") - .cloned() - .map(|x| { - x.into_iter() - .filter_map(|x| x.as_str().map(String::from)) - .collect::>() - }) - .unwrap_or_default(); - categories.extend(mrpack_loaders); - if loader_fields.contains_key("mrpack_loaders") { - categories.retain(|x| *x != "mrpack"); + .into_iter() + .flatten() + .filter_map(|value| value.as_str().map(String::from)) + .collect::>(); + version_categories.extend(mrpack_loaders); + if fields.contains_key("mrpack_loaders") { + version_categories.retain(|category| category != "mrpack"); } + version_categories.sort(); + version_categories.dedup(); - // SPECIAL BEHAVIOUR: - // For consistency with v2 searching, we manually input the - // client_side and server_side fields from the loader fields into - // separate loader fields. - // 'client_side' and 'server_side' remain supported by meilisearch even though they are no longer v3 fields. let (_, v2_og_project_type) = - LegacyProject::get_project_type(&project_types); + LegacyProject::get_project_type(&version_project_types); let (client_side, server_side) = v2_reroute::convert_v3_side_types_to_v2_side_types( &unvectorized_loader_fields, Some(&v2_og_project_type), ); - if let Ok(client_side) = serde_json::to_value(client_side) { - loader_fields - .insert("client_side".to_string(), vec![client_side]); + fields.insert("client_side".to_string(), vec![client_side]); } if let Ok(server_side) = serde_json::to_value(server_side) { - loader_fields - .insert("server_side".to_string(), vec![server_side]); + fields.insert("server_side".to_string(), vec![server_side]); } - - let components = project - .components - .clone() - .into_query( - ProjectId::from(project.id), - &project_query_context, + fields.retain(|field, _| { + matches!( + field.as_str(), + "environment" + | "game_versions" + | "client_side" + | "server_side" ) - .wrap_err("failed to populate query components")?; - - let usp = UploadSearchProject { - version_id: crate::models::ids::VersionId::from(version.id) - .to_string(), - project_id: crate::models::ids::ProjectId::from(project.id) - .to_string(), - name: project.name.clone(), - indexed_name: normalize_for_search(&project.name), - summary: project.summary.clone(), - categories: categories.clone(), - display_categories: display_categories.clone(), - follows: project.follows, - downloads: project.downloads, - log_downloads: (project.downloads.max(1) as f64).ln(), - icon_url: project.icon_url.clone(), - author: username.clone(), - author_id: ariadne::ids::UserId::from(user_id).to_string(), - organization: org_name.clone(), - organization_id: org_id.map(|e| { - crate::models::ids::OrganizationId::from(e).to_string() - }), - indexed_author: normalize_for_search(&username), - date_created: project.approved, - created_timestamp: project.approved.timestamp(), - date_modified: project.updated, - modified_timestamp: project.updated.timestamp(), + }); + + UploadSearchVersion { + version_id: VersionId::from(version.id).to_string(), + project_id: project_id.clone(), + categories: version_categories, + project_types: version_project_types, version_published_timestamp: version .date_published .timestamp(), - license: license.clone(), - slug: project.slug.clone(), - // TODO - project_types, - all_project_types: all_project_types.clone(), - gallery: gallery.clone(), - featured_gallery: featured_gallery.clone(), - open_source, - color: project.color.map(|x| x as u32), - dependency_project_ids: dependency_project_ids.clone(), - compatible_dependency_project_ids: - compatible_dependency_project_ids.clone(), - dependencies: dependencies.clone(), - loader_fields, - project_loader_fields: project_loader_fields.clone(), - // 'loaders' is aggregate of all versions' loaders - loaders: project_loaders.clone(), - components, - }; + loader_fields: fields, + } + })); + + let mut project_categories = categories; + project_categories.sort(); + project_categories.dedup(); + let mut categories = project_categories.clone(); + categories.extend(project_loaders.iter().cloned()); + + let mrpack_loaders = loader_fields + .get("mrpack_loaders") + .into_iter() + .flatten() + .filter_map(|value| value.as_str().map(String::from)) + .collect::>(); + categories.extend(mrpack_loaders); + if loader_fields.contains_key("mrpack_loaders") { + categories.retain(|category| category != "mrpack"); + } + categories.sort(); + categories.dedup(); + + let (_, v2_og_project_type) = + LegacyProject::get_project_type(&project_types); + let (client_side, server_side) = + v2_reroute::convert_v3_side_types_to_v2_side_types( + &unvectorized_loader_fields, + Some(&v2_og_project_type), + ); - uploads.push(usp); + if let Ok(client_side) = serde_json::to_value(client_side) { + loader_fields + .insert("client_side".to_string(), vec![client_side]); + } + if let Ok(server_side) = serde_json::to_value(server_side) { + loader_fields + .insert("server_side".to_string(), vec![server_side]); } + + let components = project + .components + .clone() + .into_query(ProjectId::from(project.id), &project_query_context) + .wrap_err("failed to populate query components")?; + let indexed_name = normalize_for_search(&project.name); + + project_uploads.push(UploadSearchProject { + version_id: crate::models::ids::VersionId::from( + latest_version.id, + ) + .to_string(), + project_id, + name: project.name, + indexed_name, + summary: project.summary, + categories, + project_categories, + display_categories, + follows: project.follows, + downloads: project.downloads, + log_downloads: (project.downloads.max(1) as f64).ln(), + icon_url: project.icon_url, + author: username.clone(), + author_id: ariadne::ids::UserId::from(user_id).to_string(), + organization: org_name, + organization_id: org_id.map(|id| { + crate::models::ids::OrganizationId::from(id).to_string() + }), + indexed_author: normalize_for_search(&username), + date_created: project.approved, + created_timestamp: project.approved.timestamp(), + date_modified: project.updated, + modified_timestamp: project.updated.timestamp(), + version_published_timestamp: latest_version + .date_published + .timestamp(), + license, + slug: project.slug, + project_types: project_types.clone(), + all_project_types: project_types, + gallery, + featured_gallery, + open_source, + color: project.color.map(|x| x as u32), + dependency_project_ids, + compatible_dependency_project_ids, + dependencies, + project_loader_fields, + loader_fields, + loaders: project_loaders, + components, + }); } } - Ok(uploads) + Ok(SearchDocumentBatch { + projects: project_uploads, + versions: version_uploads, + }) } struct PartialVersion { diff --git a/apps/labrinth/src/search/mod.rs b/apps/labrinth/src/search/mod.rs index e7b55dd9f3..83e4fa433f 100644 --- a/apps/labrinth/src/search/mod.rs +++ b/apps/labrinth/src/search/mod.rs @@ -111,18 +111,11 @@ pub trait SearchBackend: Send + Sync { redis: RedisPool, ) -> eyre::Result<()>; - async fn index_documents( + async fn apply_update( &self, - documents: &[UploadSearchProject], + update: SearchIndexUpdate<'_>, ) -> eyre::Result<()>; - async fn remove_project_documents( - &self, - ids: &[ProjectId], - ) -> eyre::Result<()>; - - async fn remove_documents(&self, ids: &[VersionId]) -> eyre::Result<()>; - async fn tasks(&self) -> eyre::Result; async fn tasks_cancel( @@ -233,8 +226,12 @@ impl FromStr for SearchBackendKind { } } +/// Nullable fields in Typesense-bound documents should use +/// `skip_serializing_if = "Option::is_none"` so they are omitted instead of +/// serialized as `null`. #[derive(Serialize, Deserialize, Debug, Clone)] pub struct UploadSearchProject { + /// ID of the most recently published version. pub version_id: String, pub project_id: String, // @@ -244,20 +241,25 @@ pub struct UploadSearchProject { pub slug: Option, pub author: String, pub author_id: String, + #[serde(skip_serializing_if = "Option::is_none")] pub organization: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub organization_id: Option, pub indexed_author: String, pub name: String, pub indexed_name: String, pub summary: String, pub categories: Vec, + pub project_categories: Vec, pub display_categories: Vec, pub follows: i32, pub downloads: i32, pub log_downloads: f64, + #[serde(skip_serializing_if = "Option::is_none")] pub icon_url: Option, pub license: String, pub gallery: Vec, + #[serde(skip_serializing_if = "Option::is_none")] pub featured_gallery: Option, /// RFC 3339 formatted creation date of the project pub date_created: DateTime, @@ -267,9 +269,10 @@ pub struct UploadSearchProject { pub date_modified: DateTime, /// Unix timestamp of the last major modification pub modified_timestamp: i64, - /// Unix timestamp of the publication date of the version + /// Unix timestamp of the most recently published version. pub version_published_timestamp: i64, pub open_source: bool, + #[serde(skip_serializing_if = "Option::is_none")] pub color: Option, #[serde(default)] pub dependency_project_ids: Vec, @@ -288,12 +291,45 @@ pub struct UploadSearchProject { pub loader_fields: HashMap>, } +#[derive(Serialize, Deserialize, Debug, Clone)] +pub struct UploadSearchVersion { + pub version_id: String, + pub project_id: String, + pub categories: Vec, + pub project_types: Vec, + pub version_published_timestamp: i64, + #[serde(flatten)] + pub loader_fields: HashMap>, +} + +#[derive(Debug, Default)] +pub struct SearchDocumentBatch { + pub projects: Vec, + pub versions: Vec, +} + +/// A logical search index mutation. Removals are applied before replacements, +/// so a document may be present in both a removed and replacement field. +#[derive(Debug, Clone, Copy, Default)] +pub struct SearchIndexUpdate<'a> { + pub projects: &'a [UploadSearchProject], + pub versions: &'a [UploadSearchVersion], + /// Projects and all of their version documents to remove. + pub removed_projects: &'a [ProjectId], + pub removed_versions: &'a [VersionId], +} + +/// Nullable fields in Typesense-bound documents should use +/// `skip_serializing_if = "Option::is_none"` so they are omitted instead of +/// serialized as `null`. #[derive(Serialize, Deserialize, Debug, Clone, ToSchema)] pub struct SearchProjectDependency { pub project_id: String, pub dependency_type: DependencyType, pub name: String, + #[serde(skip_serializing_if = "Option::is_none")] pub slug: Option, + #[serde(skip_serializing_if = "Option::is_none")] pub icon_url: Option, } @@ -307,6 +343,7 @@ pub struct SearchResults { #[derive(Serialize, Deserialize, Debug, Clone, ToSchema)] pub struct ResultSearchProject { + /// ID of the most recently published version. pub version_id: String, pub project_id: String, pub project_types: Vec, diff --git a/scripts/.gitignore b/scripts/.gitignore new file mode 100644 index 0000000000..bee8a64b79 --- /dev/null +++ b/scripts/.gitignore @@ -0,0 +1 @@ +__pycache__ diff --git a/scripts/convert-typesense-project-docs.py b/scripts/convert-typesense-project-docs.py new file mode 100755 index 0000000000..5cfd594028 --- /dev/null +++ b/scripts/convert-typesense-project-docs.py @@ -0,0 +1,443 @@ +#!/usr/bin/env python3 +"""Split legacy Typesense JSONL into project and version documents.""" + +import argparse +import json +import os +import shutil +import sys +import tempfile +import time +import zlib +from collections import OrderedDict + + +VERSION_FILTER_PATHS = ( + "project_types", + "environment", + "game_versions", + "client_side", + "server_side", +) + +BASE62_DIGITS = { + character: index + for index, character in enumerate( + "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" + ) +} + + +class ConversionError(Exception): + pass + + +def parse_args(): + parser = argparse.ArgumentParser( + description=( + "Convert a legacy Typesense JSONL export from one document per " + "version into separate project and version collections." + ) + ) + parser.add_argument("input", help="Legacy Typesense JSONL export") + parser.add_argument("projects_output", help="Destination project-document JSONL") + parser.add_argument("versions_output", help="Destination version-document JSONL") + parser.add_argument( + "--shards", + type=int, + default=512, + help="Temporary hash shards used to bound memory usage (default: 512)", + ) + parser.add_argument( + "--max-open-shards", + type=int, + default=64, + help="Maximum temporary shard files held open at once (default: 64)", + ) + parser.add_argument( + "--progress-interval", + type=float, + default=10.0, + help="Seconds between progress reports (default: 10)", + ) + parser.add_argument( + "--keep-temporary", + action="store_true", + help="Keep temporary shard files after completion or failure", + ) + return parser.parse_args() + + +def base62_value(value): + result = 0 + try: + for character in value: + result = result * 62 + BASE62_DIGITS[character] + except KeyError: + return -1 + return result + + +def get_path(document, path): + value = document + for segment in path.split("."): + if not isinstance(value, dict) or segment not in value: + return None, False + value = value[segment] + return value, True + + +def set_path(document, path, value): + segments = path.split(".") + current = document + for segment in segments[:-1]: + child = current.get(segment) + if not isinstance(child, dict): + child = {} + current[segment] = child + current = child + current[segments[-1]] = value + + +def unique_sorted(values): + return sorted(set(values)) + + +def extend_values(target, value): + if isinstance(value, list): + target.extend(value) + elif value is not None: + target.append(value) + + +def version_filter_document(document): + version_id = document.get("version_id") or document.get("id") + result = { + "id": str(version_id), + "version_id": str(version_id), + "project_id": str(document["project_id"]), + "version_published_timestamp": document.get( + "version_published_timestamp", -1 + ), + } + loaders = list(document.get("loaders") or []) + mrpack_loaders = list(document.get("mrpack_loaders") or []) + loaders.extend(mrpack_loaders) + if mrpack_loaders: + loaders = [loader for loader in loaders if loader != "mrpack"] + result["categories"] = unique_sorted(loaders) + for path in VERSION_FILTER_PATHS: + value, exists = get_path(document, path) + if exists and value is not None: + set_path(result, path, value) + return result + + +class ProjectAccumulator: + def __init__(self, document): + self.latest_document = document + self.latest_key = self.version_key(document) + self.versions = {} + self.categories = [] + self.version_categories = [] + self.loaders = [] + self.project_types = [] + self.client_side = [] + self.server_side = [] + self.add(document) + + @staticmethod + def version_key(document): + return ( + document.get("version_published_timestamp", -1), + base62_value(str(document.get("version_id", ""))), + ) + + def add(self, document): + project_id = document.get("project_id") + if project_id != self.latest_document.get("project_id"): + raise ConversionError("attempted to combine different projects") + + version_id = document.get("version_id") or document.get("id") + if not version_id: + raise ConversionError(f"project `{project_id}` has a version without an ID") + + key = self.version_key(document) + if key > self.latest_key: + self.latest_document = document + self.latest_key = key + + version_document = version_filter_document(document) + self.versions[str(version_id)] = (key, version_document) + extend_values(self.categories, document.get("categories")) + extend_values(self.version_categories, version_document.get("categories")) + extend_values(self.loaders, document.get("loaders")) + extend_values(self.project_types, document.get("project_types")) + extend_values(self.project_types, document.get("all_project_types")) + extend_values(self.client_side, document.get("client_side")) + extend_values(self.server_side, document.get("server_side")) + + def finish(self): + result = dict(self.latest_document) + project_id = str(result["project_id"]) + all_project_types = unique_sorted(self.project_types) + + result["id"] = project_id + result["version_id"] = str( + self.latest_document.get("version_id") + or self.latest_document.get("id") + ) + result["categories"] = unique_sorted(self.categories) + result["project_categories"] = unique_sorted( + set(self.categories) - set(self.version_categories) + ) + result["loaders"] = unique_sorted(self.loaders) + result["project_types"] = all_project_types + result["all_project_types"] = all_project_types + + project_loader_fields = result.get("project_loader_fields") + if not isinstance(project_loader_fields, dict): + project_loader_fields = {} + result["project_loader_fields"] = project_loader_fields + for field, value in project_loader_fields.items(): + result[field] = value + + if self.client_side: + result["client_side"] = unique_sorted(self.client_side) + if self.server_side: + result["server_side"] = unique_sorted(self.server_side) + + versions = [ + version + for _, version in sorted( + self.versions.values(), key=lambda item: item[0] + ) + ] + result.pop("versions", None) + return result, versions + + +class ShardWriter: + def __init__(self, directory, shard_count, max_open): + self.directory = directory + self.shard_count = shard_count + self.max_open = max_open + self.handles = OrderedDict() + + def path(self, shard): + return os.path.join(self.directory, f"shard-{shard:04d}.jsonl") + + def write(self, project_id, line): + shard = zlib.crc32(project_id.encode("utf-8")) % self.shard_count + handle = self.handles.pop(shard, None) + if handle is None: + if len(self.handles) >= self.max_open: + _, oldest = self.handles.popitem(last=False) + oldest.close() + handle = open(self.path(shard), "ab") + self.handles[shard] = handle + handle.write(line) + + def close(self): + for handle in self.handles.values(): + handle.close() + self.handles.clear() + + +def shard_input(args, temporary_directory): + writer = ShardWriter( + temporary_directory, + args.shards, + args.max_open_shards, + ) + input_size = os.path.getsize(args.input) + bytes_read = 0 + document_count = 0 + started_at = time.monotonic() + last_report = started_at + + try: + with open(args.input, "rb") as input_file: + for line_number, line in enumerate(input_file, start=1): + bytes_read += len(line) + if not line.strip(): + continue + try: + document = json.loads(line) + except json.JSONDecodeError as error: + raise ConversionError( + f"invalid JSON on input line {line_number}: {error}" + ) from error + project_id = document.get("project_id") + if not project_id: + raise ConversionError( + f"input line {line_number} has no `project_id`" + ) + writer.write(str(project_id), line) + document_count += 1 + + now = time.monotonic() + if now - last_report >= args.progress_interval: + percent = bytes_read / input_size * 100 if input_size else 100 + print( + f"sharding: {percent:.1f}% ({document_count:,} documents)", + flush=True, + ) + last_report = now + finally: + writer.close() + + print( + f"sharding complete: {document_count:,} version documents in " + f"{time.monotonic() - started_at:.1f}s", + flush=True, + ) + return document_count + + +def convert_shards( + args, + temporary_directory, + partial_projects_output, + partial_versions_output, +): + project_count = 0 + version_count = 0 + started_at = time.monotonic() + last_report = started_at + + with ( + open(partial_projects_output, "w", encoding="utf-8") as projects_file, + open(partial_versions_output, "w", encoding="utf-8") as versions_file, + ): + for shard in range(args.shards): + path = os.path.join(temporary_directory, f"shard-{shard:04d}.jsonl") + if not os.path.exists(path): + continue + + projects = {} + with open(path, "rb") as shard_file: + for line_number, line in enumerate(shard_file, start=1): + try: + document = json.loads(line) + except json.JSONDecodeError as error: + raise ConversionError( + f"invalid JSON in shard {shard}, line {line_number}: {error}" + ) from error + project_id = str(document["project_id"]) + if project_id in projects: + projects[project_id].add(document) + else: + projects[project_id] = ProjectAccumulator(document) + version_count += 1 + + for project_id in sorted(projects): + project, versions = projects[project_id].finish() + json.dump( + project, + projects_file, + separators=(",", ":"), + ensure_ascii=False, + ) + projects_file.write("\n") + for version in versions: + json.dump( + version, + versions_file, + separators=(",", ":"), + ensure_ascii=False, + ) + versions_file.write("\n") + project_count += 1 + + os.remove(path) + now = time.monotonic() + if now - last_report >= args.progress_interval: + print( + f"converting: shard {shard + 1}/{args.shards}, " + f"{project_count:,} projects", + flush=True, + ) + last_report = now + + print( + f"conversion complete: {version_count:,} versions into " + f"{project_count:,} projects in {time.monotonic() - started_at:.1f}s", + flush=True, + ) + return project_count, version_count + + +def main(): + args = parse_args() + if args.shards <= 0: + raise ConversionError("--shards must be greater than zero") + if args.max_open_shards <= 0: + raise ConversionError("--max-open-shards must be greater than zero") + if args.progress_interval <= 0: + raise ConversionError("--progress-interval must be greater than zero") + if not os.path.isfile(args.input): + raise ConversionError(f"input file does not exist: {args.input}") + paths = { + os.path.abspath(args.input), + os.path.abspath(args.projects_output), + os.path.abspath(args.versions_output), + } + if len(paths) != 3: + raise ConversionError("input and output paths must all differ") + + projects_directory = os.path.dirname(os.path.abspath(args.projects_output)) + versions_directory = os.path.dirname(os.path.abspath(args.versions_output)) + os.makedirs(projects_directory, exist_ok=True) + os.makedirs(versions_directory, exist_ok=True) + temporary_directory = tempfile.mkdtemp( + prefix="typesense-project-convert-", + dir=projects_directory, + ) + partial_projects_output = f"{args.projects_output}.partial" + partial_versions_output = f"{args.versions_output}.partial" + + try: + expected_versions = shard_input(args, temporary_directory) + project_count, version_count = convert_shards( + args, + temporary_directory, + partial_projects_output, + partial_versions_output, + ) + if version_count != expected_versions: + raise ConversionError( + f"sharded {expected_versions} versions but converted {version_count}" + ) + os.replace(partial_projects_output, args.projects_output) + os.replace(partial_versions_output, args.versions_output) + print( + f"wrote {project_count:,} project documents to " + f"{args.projects_output} and {version_count:,} version documents to " + f"{args.versions_output}", + flush=True, + ) + except Exception: + for partial_output in ( + partial_projects_output, + partial_versions_output, + ): + if os.path.exists(partial_output): + os.remove(partial_output) + raise + finally: + if args.keep_temporary: + print(f"temporary shards kept at {temporary_directory}", file=sys.stderr) + else: + shutil.rmtree(temporary_directory, ignore_errors=True) + + +if __name__ == "__main__": + try: + main() + except KeyboardInterrupt: + print("interrupted", file=sys.stderr) + sys.exit(130) + except (ConversionError, OSError) as error: + print(error, file=sys.stderr) + sys.exit(1) diff --git a/scripts/create-dummy-projects.py b/scripts/create-dummy-projects.py new file mode 100755 index 0000000000..c55ea25d2e --- /dev/null +++ b/scripts/create-dummy-projects.py @@ -0,0 +1,123 @@ +#!/usr/bin/env python3 +import argparse +import json +import time +import urllib.error +import urllib.request +from concurrent.futures import ThreadPoolExecutor, as_completed +from uuid import uuid4 + + +def make_body(boundary, slug, index): + data = { + "name": f"Dummy Load {index:04d}", + "slug": slug, + "summary": "A dummy project for local load testing.", + "description": "This project was generated locally for batch indexing tests.", + "initial_versions": [], + "is_draft": True, + "categories": [], + "license_id": "MIT", + } + + payload = json.dumps(data, separators=(",", ":")) + return ( + f"--{boundary}\r\n" + 'Content-Disposition: form-data; name="data"\r\n' + "Content-Type: application/json\r\n\r\n" + f"{payload}\r\n" + f"--{boundary}--\r\n" + ).encode() + + +def create_project(base_url, token, boundary, prefix, index, retries): + slug = f"{prefix}-{index:04d}" + body = make_body(boundary, slug, index) + headers = { + "Authorization": f"Bearer {token}", + "Content-Type": f"multipart/form-data; boundary={boundary}", + } + + for attempt in range(retries + 1): + req = urllib.request.Request( + f"{base_url}/v3/project", + data=body, + headers=headers, + method="POST", + ) + + try: + with urllib.request.urlopen(req, timeout=60) as resp: + resp.read() + return True, slug, resp.status, "" + except urllib.error.HTTPError as err: + text = err.read().decode("utf-8", errors="replace") + if err.code < 500 or attempt == retries: + return False, slug, err.code, text + except Exception as err: + if attempt == retries: + return False, slug, "error", repr(err) + + time.sleep(min(2**attempt, 10)) + + raise RuntimeError("unreachable") + + +def main(): + parser = argparse.ArgumentParser() + parser.add_argument("--base-url", default="http://localhost:8000") + parser.add_argument("--token", default="mra_admin") + parser.add_argument("--count", type=int, default=1000) + parser.add_argument("--concurrency", type=int, default=2) + parser.add_argument("--retries", type=int, default=5) + args = parser.parse_args() + + boundary = "----modrinth-dummy-project-boundary" + prefix = f"dummy-load-{int(time.time())}-{uuid4().hex[:6]}" + + ok = 0 + failures = [] + + with ThreadPoolExecutor(max_workers=args.concurrency) as executor: + futures = [ + executor.submit( + create_project, + args.base_url, + args.token, + boundary, + prefix, + index, + args.retries, + ) + for index in range(args.count) + ] + + for completed, future in enumerate(as_completed(futures), 1): + success, slug, status, text = future.result() + if success: + ok += 1 + else: + failures.append((slug, status, text[:500])) + + if completed % 50 == 0: + print( + f"completed={completed} created={ok} failed={len(failures)}", + flush=True, + ) + + print( + json.dumps( + { + "prefix": prefix, + "attempted": args.count, + "created": ok, + "failed": len(failures), + "failures": failures[:20], + }, + indent=2, + ) + ) + + +if __name__ == "__main__": + main() diff --git a/scripts/import-typesense-jsonl.py b/scripts/import-typesense-jsonl.py new file mode 100755 index 0000000000..93b2fa03c7 --- /dev/null +++ b/scripts/import-typesense-jsonl.py @@ -0,0 +1,536 @@ +#!/usr/bin/env python3 +""" +Import a JSONL Typesense export into local Labrinth Typesense collections. + +By default this imports tmp/export.jsonl into the Labrinth project search alias, +resolving the alias to its current backing collection first. + +Usage: + python3 scripts/import-typesense-jsonl.py + python3 scripts/import-typesense-jsonl.py tmp/export.jsonl --continue + python3 scripts/import-typesense-jsonl.py tmp/export.jsonl --alias labrinth_projects + python3 scripts/import-typesense-jsonl.py --collection labrinth_projects__alt +""" + +import argparse +import json +import os +import sys +import time +import urllib.error +import urllib.parse +import urllib.request + + +class TypesenseError(Exception): + pass + + +def default_aliases(): + prefix = os.environ.get("TYPESENSE_INDEX_PREFIX", "labrinth") + return [f"{prefix}_projects"] + + +def request_typesense(base_url, api_key, method, path, timeout, body=None, content_type=None): + url = f"{base_url.rstrip('/')}{path}" + request = urllib.request.Request(url, data=body, method=method) + request.add_header("X-TYPESENSE-API-KEY", api_key) + if content_type: + request.add_header("Content-Type", content_type) + + try: + with urllib.request.urlopen(request, timeout=timeout) as response: + return response.read() + except urllib.error.HTTPError as error: + error_body = error.read().decode("utf-8", errors="replace") + raise TypesenseError(f"{method} {path} failed ({error.code}): {error_body}") from error + except urllib.error.URLError as error: + raise TypesenseError(f"{method} {path} failed: {error.reason}") from error + + +def get_json_or_none(base_url, api_key, path, timeout): + try: + body = request_typesense(base_url, api_key, "GET", path, timeout) + except TypesenseError as error: + if " failed (404):" in str(error): + return None + raise + return json.loads(body.decode("utf-8")) + + +def request_json(base_url, api_key, method, path, timeout, body=None): + encoded_body = None + if body is not None: + encoded_body = json.dumps(body).encode("utf-8") + + response = request_typesense( + base_url, + api_key, + method, + path, + timeout, + body=encoded_body, + content_type="application/json" if body is not None else None, + ) + if not response: + return None + return json.loads(response.decode("utf-8")) + + +def resolve_alias_or_collection(base_url, api_key, name, timeout): + escaped = urllib.parse.quote(name, safe="") + alias = get_json_or_none(base_url, api_key, f"/aliases/{escaped}", timeout) + if alias is not None: + collection_name = alias.get("collection_name") + if not collection_name: + raise TypesenseError(f"Alias {name} did not include collection_name") + return collection_name + + collection = get_json_or_none(base_url, api_key, f"/collections/{escaped}", timeout) + if collection is None: + raise TypesenseError(f"No Typesense alias or collection exists for {name}") + return name + + +def collection_document_count(base_url, api_key, collection, timeout): + escaped = urllib.parse.quote(collection, safe="") + body = get_json_or_none(base_url, api_key, f"/collections/{escaped}", timeout) + if body is None: + raise TypesenseError(f"No Typesense collection exists for {collection}") + return int(body.get("num_documents", 0)) + + +def collection_schema_exists(base_url, api_key, collection, timeout): + escaped = urllib.parse.quote(collection, safe="") + return get_json_or_none(base_url, api_key, f"/collections/{escaped}", timeout) is not None + + +def collection_schema_for_create(name, source): + schema = { + "name": name, + "fields": source["fields"], + "default_sorting_field": source.get("default_sorting_field"), + "enable_nested_fields": source.get("enable_nested_fields", False), + "token_separators": source.get("token_separators", []), + "symbols_to_index": source.get("symbols_to_index", []), + } + return {key: value for key, value in schema.items() if value is not None} + + +def sibling_collection_name(collection): + if collection.endswith("__current"): + return f"{collection[:-len('__current')]}__alt" + if collection.endswith("__alt"): + return f"{collection[:-len('__alt')]}__current" + return None + + +def create_collection_from_source(base_url, api_key, collection, source_collection, timeout): + escaped_source = urllib.parse.quote(source_collection, safe="") + source = get_json_or_none(base_url, api_key, f"/collections/{escaped_source}", timeout) + if source is None: + raise TypesenseError( + f"Cannot create {collection}: source collection {source_collection} does not exist" + ) + + request_json( + base_url, + api_key, + "POST", + "/collections", + timeout, + body=collection_schema_for_create(collection, source), + ) + print(f"Created {collection} from schema of {source_collection}") + + +def ensure_collection_exists(collection, args): + if collection_schema_exists(args.typesense_url, args.api_key, collection, args.timeout): + return + + if not args.create_missing_collection: + raise TypesenseError(f"No Typesense collection exists for {collection}") + + source_collection = args.create_from_collection or sibling_collection_name(collection) + if not source_collection: + raise TypesenseError( + f"No Typesense collection exists for {collection}; pass --create-from-collection" + ) + + create_collection_from_source( + args.typesense_url, + args.api_key, + collection, + source_collection, + args.timeout, + ) + + +def typesense_health_ok(base_url, api_key, timeout): + try: + body = request_typesense(base_url, api_key, "GET", "/health", timeout) + except TypesenseError as error: + if " failed (503):" in str(error): + return False + raise + + return json.loads(body.decode("utf-8")).get("ok") is True + + +def wait_for_typesense_drain(collection, expected_documents, args): + started_at = time.monotonic() + last_reported_at = 0.0 + + while True: + document_count = collection_document_count( + args.typesense_url, args.api_key, collection, args.timeout + ) + healthy = typesense_health_ok(args.typesense_url, args.api_key, args.timeout) + + if document_count >= expected_documents and healthy: + elapsed = time.monotonic() - started_at + print( + f"{collection}: Typesense reports {document_count} document(s) " + f"and healthy after flush wait ({elapsed:.1f}s)" + ) + return elapsed + + elapsed = time.monotonic() - started_at + if elapsed > args.flush_timeout: + raise TypesenseError( + f"Timed out waiting for Typesense to flush {collection}: " + f"{document_count}/{expected_documents} document(s), " + f"health ok={healthy}" + ) + + if elapsed - last_reported_at >= args.flush_report_interval: + print( + f"{collection}: waiting for Typesense flush; " + f"{document_count}/{expected_documents} document(s), " + f"health ok={healthy} ({elapsed:.1f}s)" + ) + last_reported_at = elapsed + + time.sleep(args.flush_poll_interval) + + +def unique(values): + result = [] + seen = set() + for value in values: + if value in seen: + continue + seen.add(value) + result.append(value) + return result + + +def iter_jsonl_batches(path, batch_lines, max_batch_bytes, skip_documents=0): + batch = [] + batch_bytes = 0 + start_line = None + end_line = None + skipped = 0 + + with open(path, "rb") as export_file: + for line_number, line in enumerate(export_file, start=1): + if not line.strip(): + continue + + if skipped < skip_documents: + skipped += 1 + continue + + line_bytes = len(line) + should_flush = batch and ( + len(batch) >= batch_lines or batch_bytes + line_bytes > max_batch_bytes + ) + if should_flush: + yield start_line, end_line, len(batch), b"".join(batch) + batch = [] + batch_bytes = 0 + start_line = None + + if start_line is None: + start_line = line_number + end_line = line_number + batch.append(line) + batch_bytes += line_bytes + + if batch: + yield start_line, end_line, len(batch), b"".join(batch) + + +def count_jsonl_batches(path, batch_lines, max_batch_bytes, skip_documents=0): + batch_count = 0 + batch_lines_count = 0 + batch_bytes = 0 + skipped = 0 + + with open(path, "rb") as export_file: + for line in export_file: + if not line.strip(): + continue + + if skipped < skip_documents: + skipped += 1 + continue + + line_bytes = len(line) + if batch_lines_count and ( + batch_lines_count >= batch_lines or batch_bytes + line_bytes > max_batch_bytes + ): + batch_count += 1 + batch_lines_count = 0 + batch_bytes = 0 + + batch_lines_count += 1 + batch_bytes += line_bytes + + if batch_lines_count: + batch_count += 1 + + return batch_count + + +def parse_import_response(body, failures_to_print): + imported = 0 + failed = 0 + failures = [] + text = body.decode("utf-8", errors="replace") + + for line in text.splitlines(): + if not line: + continue + try: + result = json.loads(line) + except json.JSONDecodeError: + failed += 1 + if len(failures) < failures_to_print: + failures.append(line) + continue + + if result.get("success") is True: + imported += 1 + else: + failed += 1 + if len(failures) < failures_to_print: + failures.append(json.dumps(result, sort_keys=True)) + + if imported == 0 and failed == 0 and text.strip(): + failed = 1 + failures.append(text.strip()) + + return imported, failed, failures + + +def import_batch(base_url, api_key, collection, args, body): + query = urllib.parse.urlencode( + { + "action": args.action, + "dirty_values": args.dirty_values, + } + ) + escaped = urllib.parse.quote(collection, safe="") + if not body.endswith(b"\n"): + body += b"\n" + + return request_typesense( + base_url, + api_key, + "POST", + f"/collections/{escaped}/documents/import?{query}", + args.timeout, + body=body, + content_type="text/plain", + ) + + +def import_file(collection, args): + imported_total = 0 + batch_count = 0 + skip_documents = 0 + next_flush_at = args.flush_interval + started_at = time.monotonic() + flush_batch_started_at = started_at + flush_batch_start_total = 0 + + ensure_collection_exists(collection, args) + + if args.continue_import: + skip_documents = collection_document_count( + args.typesense_url, args.api_key, collection, args.timeout + ) + print(f"{collection}: continuing after {skip_documents} existing document(s)") + + total_batches = count_jsonl_batches( + args.file, args.batch_lines, args.max_batch_bytes, skip_documents + ) + if total_batches == 0: + print(f"{collection}: no remaining documents to import") + return 0 + + for start_line, end_line, document_count, body in iter_jsonl_batches( + args.file, args.batch_lines, args.max_batch_bytes, skip_documents + ): + batch_count += 1 + batch_started_at = time.monotonic() + response = import_batch(args.typesense_url, args.api_key, collection, args, body) + batch_elapsed = time.monotonic() - batch_started_at + imported, failed, failures = parse_import_response(response, args.failures_to_print) + + if failed: + print( + f"Typesense reported {failed} failed document(s) for " + f"{collection}, input lines {start_line}-{end_line}.", + file=sys.stderr, + ) + for failure in failures: + print(failure, file=sys.stderr) + raise TypesenseError(f"Import into {collection} failed") + + if imported != document_count: + raise TypesenseError( + f"Typesense acknowledged {imported} document(s) for " + f"{collection}, but the batch contained {document_count}" + ) + + imported_total += imported + elapsed = time.monotonic() - started_at + percent = batch_count / total_batches * 100 + print( + f"{collection}: batch {batch_count}/{total_batches} ({percent:.1f}%) " + f"imported {imported} document(s) " + f"from lines {start_line}-{end_line}; {imported_total} total " + f"(batch {batch_elapsed:.1f}s, elapsed {elapsed:.1f}s)" + ) + + if args.flush_interval and imported_total >= next_flush_at: + expected_documents = skip_documents + imported_total + flush_batch_elapsed = time.monotonic() - flush_batch_started_at + flush_batch_documents = imported_total - flush_batch_start_total + print( + f"{collection}: flush checkpoint at {imported_total} imported document(s); " + f"imported {flush_batch_documents} document(s) since previous flush " + f"in {flush_batch_elapsed:.1f}s" + ) + flush_wait_elapsed = wait_for_typesense_drain(collection, expected_documents, args) + print( + f"{collection}: flush checkpoint complete; " + f"import batch {flush_batch_elapsed:.1f}s, " + f"flush wait {flush_wait_elapsed:.1f}s" + ) + while imported_total >= next_flush_at: + next_flush_at += args.flush_interval + flush_batch_started_at = time.monotonic() + flush_batch_start_total = imported_total + + elapsed = time.monotonic() - started_at + print(f"{collection}: imported {imported_total} documents in {batch_count} batches ({elapsed:.1f}s)") + return imported_total + + +def parse_args(): + parser = argparse.ArgumentParser( + description="Import a JSONL export into Typesense in payload-safe batches." + ) + parser.add_argument("jsonl_file", nargs="?", help="JSONL export to import") + parser.add_argument("--file", help="JSONL export to import") + parser.add_argument( + "--typesense-url", + default=os.environ.get("TYPESENSE_URL", "http://localhost:8108"), + help="Typesense URL", + ) + parser.add_argument( + "--api-key", + default=os.environ.get("TYPESENSE_API_KEY", "modrinth"), + help="Typesense API key", + ) + parser.add_argument( + "--alias", + action="append", + dest="aliases", + help="Typesense alias or collection name to import into. Repeat for multiple targets.", + ) + parser.add_argument( + "--collection", + action="append", + dest="collections", + help="Exact Typesense collection name. Repeat for multiple targets.", + ) + parser.add_argument("--action", default="create", choices=["create", "update", "upsert", "emplace"]) + parser.add_argument("--dirty-values", default="coerce_or_drop") + parser.add_argument("--batch-lines", type=int, default=5_000) + parser.add_argument("--max-batch-bytes", type=int, default=4 * 1024 * 1024) + parser.add_argument("--flush-interval", type=int, default=10_000) + parser.add_argument("--flush-timeout", type=float, default=900.0) + parser.add_argument("--flush-poll-interval", type=float, default=2.0) + parser.add_argument("--flush-report-interval", type=float, default=10.0) + parser.add_argument( + "--create-missing-collection", + action=argparse.BooleanOptionalAction, + default=True, + help="Create a missing __current/__alt collection by cloning its sibling schema.", + ) + parser.add_argument( + "--create-from-collection", + help="Collection whose schema should be cloned when creating a missing target collection.", + ) + parser.add_argument("--failures-to-print", type=int, default=20) + parser.add_argument("--timeout", type=float, default=120.0) + parser.add_argument( + "--continue", + action="store_true", + dest="continue_import", + help="Resume by skipping the number of documents already in the target collection.", + ) + return parser.parse_args() + + +def main(): + args = parse_args() + + if args.batch_lines <= 0: + raise TypesenseError("--batch-lines must be greater than zero") + if args.max_batch_bytes <= 0: + raise TypesenseError("--max-batch-bytes must be greater than zero") + if args.flush_interval < 0: + raise TypesenseError("--flush-interval must be greater than or equal to zero") + if args.flush_timeout <= 0: + raise TypesenseError("--flush-timeout must be greater than zero") + if args.flush_poll_interval <= 0: + raise TypesenseError("--flush-poll-interval must be greater than zero") + if args.flush_report_interval <= 0: + raise TypesenseError("--flush-report-interval must be greater than zero") + if args.aliases and args.collections: + raise TypesenseError("Use either --alias or --collection, not both") + if args.jsonl_file and args.file: + raise TypesenseError("Pass the JSONL path either positionally or with --file, not both") + args.file = args.jsonl_file or args.file or "tmp/export.jsonl" + if not os.path.isfile(args.file): + raise TypesenseError(f"File does not exist: {args.file}") + + if args.collections: + collections = unique(args.collections) + else: + aliases = unique(args.aliases or default_aliases()) + collections = [ + resolve_alias_or_collection(args.typesense_url, args.api_key, alias, args.timeout) + for alias in aliases + ] + collections = unique(collections) + + print(f"Importing {args.file} into {', '.join(collections)}") + for collection in collections: + import_file(collection, args) + + +if __name__ == "__main__": + try: + main() + except KeyboardInterrupt: + print("Interrupted.", file=sys.stderr) + sys.exit(130) + except TypesenseError as error: + print(error, file=sys.stderr) + sys.exit(1) diff --git a/scripts/query-typesense.py b/scripts/query-typesense.py new file mode 100644 index 0000000000..24f151bf75 --- /dev/null +++ b/scripts/query-typesense.py @@ -0,0 +1,105 @@ +#!/usr/bin/env python3 +""" +Query the local Labrinth Typesense collection directly. + +Usage: + python3 scripts/query-typesense.py sodium + python3 scripts/query-typesense.py foobarqux --per-page 10 +""" + +import argparse +import json +import os +import urllib.error +import urllib.request + + +def request_json(base_url, api_key, path, body, timeout): + request = urllib.request.Request( + f"{base_url.rstrip('/')}{path}", + data=json.dumps(body).encode("utf-8"), + method="POST", + headers={ + "X-TYPESENSE-API-KEY": api_key, + "Content-Type": "application/json", + }, + ) + + try: + with urllib.request.urlopen(request, timeout=timeout) as response: + return json.load(response) + except urllib.error.HTTPError as error: + error_body = error.read().decode("utf-8", errors="replace") + raise SystemExit(f"Typesense request failed ({error.code}): {error_body}") from error + except urllib.error.URLError as error: + raise SystemExit(f"Typesense request failed: {error.reason}") from error + + +def parse_args(): + parser = argparse.ArgumentParser(description="Query Typesense directly.") + parser.add_argument("query", help="Search query") + parser.add_argument( + "--typesense-url", + default=os.environ.get("TYPESENSE_URL", "http://localhost:8108"), + help="Typesense URL", + ) + parser.add_argument( + "--api-key", + default=os.environ.get("TYPESENSE_API_KEY", "modrinth"), + help="Typesense API key", + ) + parser.add_argument( + "--collection", + default="labrinth_projects__current", + help="Typesense collection to search", + ) + parser.add_argument("--per-page", type=int, default=5) + parser.add_argument("--timeout", type=float, default=30.0) + return parser.parse_args() + + +def main(): + args = parse_args() + payload = { + "searches": [ + { + "collection": args.collection, + "q": args.query, + "query_by": "name,summary,author,indexed_name,indexed_author", + "per_page": args.per_page, + "group_by": "project_id", + "group_limit": 1, + "facet_by": "project_id", + "max_facet_values": 0, + } + ] + } + + body = request_json( + args.typesense_url, args.api_key, "/multi_search", payload, args.timeout + ) + result = body["results"][0] + + print(f"query: {args.query}") + print(f"collection: {args.collection}") + print(f"found: {result.get('found', 0)}") + print(f"out_of: {result.get('out_of', 0)}") + print(f"search_time_ms: {result.get('search_time_ms', 0)}") + print() + + grouped_hits = result.get("grouped_hits", []) + if not grouped_hits: + print("no hits") + return + + for index, group in enumerate(grouped_hits, start=1): + hit = group["hits"][0] + document = hit["document"] + print(f"{index}. {document.get('name', '')} ({document.get('slug', '')})") + print(f" project_id: {document.get('project_id', '')}") + print(f" author: {document.get('author', '')}") + print(f" summary: {document.get('summary', '')}") + + +if __name__ == "__main__": + main()