slbotbm commented on code in PR #3404: URL: https://github.com/apache/iggy/pull/3404#discussion_r3363481394
########## core/connectors/sinks/meilisearch_sink/src/lib.rs: ########## @@ -0,0 +1,838 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use async_trait::async_trait; +use base64::{Engine as _, engine::general_purpose}; +use iggy_common::IggyTimestamp; +use iggy_connector_sdk::{ + ConsumedMessage, Error, MessagesMetadata, Payload, Sink, TopicMetadata, + convert::owned_value_to_serde_json, + retry::{exponential_backoff, jitter, parse_duration}, + sink_connector, +}; +use meilisearch_sdk::{ + client::Client, + errors::{ + Error as MeilisearchSdkError, ErrorCode as MeilisearchErrorCode, + ErrorType as MeilisearchErrorType, + }, + indexes::Index, + task_info::TaskInfo, +}; +use reqwest::Url; +use secrecy::{ExposeSecret, SecretString}; +use serde::{Deserialize, Serialize}; +use serde_json::{Map, Value, json}; +use std::{future::Future, time::Duration}; +use tokio::sync::Mutex; +use tracing::{info, warn}; + +sink_connector!(MeilisearchSink); + +const DEFAULT_PRIMARY_KEY: &str = "iggy_id"; +const DEFAULT_BATCH_SIZE: usize = 1000; +const DEFAULT_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_POLL_INTERVAL: &str = "100ms"; +const DEFAULT_RETRY_DELAY: &str = "500ms"; +const DEFAULT_MAX_RETRY_DELAY: &str = "5s"; +const DEFAULT_MAX_RETRIES: u32 = 3; +const DEFAULT_MAX_OPEN_RETRIES: u32 = 5; +const ENCODING_BASE64: &str = "base64"; + +#[derive(Debug)] +struct State { + invocations_count: usize, + documents_enqueued: usize, + documents_indexed: usize, + errors_count: usize, +} + +#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum MeilisearchDocumentAction { + #[default] + Replace, + Update, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeilisearchSinkConfig { + pub url: String, + pub index: String, + #[serde(serialize_with = "iggy_common::serde_secret::serialize_optional_secret")] + pub api_key: Option<SecretString>, + pub primary_key: Option<String>, + pub document_action: Option<MeilisearchDocumentAction>, + pub create_index_if_not_exists: Option<bool>, + pub include_metadata: Option<bool>, + pub batch_size: Option<usize>, + pub timeout: Option<String>, + pub wait_for_tasks: Option<bool>, + pub task_timeout: Option<String>, + pub task_poll_interval: Option<String>, + pub max_retries: Option<u32>, + pub retry_delay: Option<String>, + pub max_retry_delay: Option<String>, + pub max_open_retries: Option<u32>, +} + +#[derive(Debug)] +pub struct MeilisearchSink { + id: u32, + config: MeilisearchSinkConfig, + primary_key: String, + document_action: MeilisearchDocumentAction, + create_index_if_not_exists: bool, + include_metadata: bool, + batch_size: usize, + timeout: Duration, + wait_for_tasks: bool, + task_timeout: Duration, + task_poll_interval: Duration, + max_retries: u32, + retry_delay: Duration, + max_retry_delay: Duration, + max_open_retries: u32, + client: Option<Client>, + state: Mutex<State>, +} + +impl MeilisearchSink { + pub fn new(id: u32, config: MeilisearchSinkConfig) -> Self { + let primary_key = config Review Comment: this function makes a lot of assumptions about the config, some of which are encoded as `const`s and some of which do not have `const`s (`create_index_if_not_exists`, `include_metadata`, `wait_for_tasks`). I think it would be prudent to make these as `const`s as well, and document the default options as a rustdoc or in the readme for the user. ########## core/connectors/sinks/meilisearch_sink/src/lib.rs: ########## @@ -0,0 +1,838 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use async_trait::async_trait; +use base64::{Engine as _, engine::general_purpose}; +use iggy_common::IggyTimestamp; +use iggy_connector_sdk::{ + ConsumedMessage, Error, MessagesMetadata, Payload, Sink, TopicMetadata, + convert::owned_value_to_serde_json, + retry::{exponential_backoff, jitter, parse_duration}, + sink_connector, +}; +use meilisearch_sdk::{ + client::Client, + errors::{ + Error as MeilisearchSdkError, ErrorCode as MeilisearchErrorCode, + ErrorType as MeilisearchErrorType, + }, + indexes::Index, + task_info::TaskInfo, +}; +use reqwest::Url; +use secrecy::{ExposeSecret, SecretString}; +use serde::{Deserialize, Serialize}; +use serde_json::{Map, Value, json}; +use std::{future::Future, time::Duration}; +use tokio::sync::Mutex; +use tracing::{info, warn}; + +sink_connector!(MeilisearchSink); + +const DEFAULT_PRIMARY_KEY: &str = "iggy_id"; +const DEFAULT_BATCH_SIZE: usize = 1000; +const DEFAULT_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_POLL_INTERVAL: &str = "100ms"; +const DEFAULT_RETRY_DELAY: &str = "500ms"; +const DEFAULT_MAX_RETRY_DELAY: &str = "5s"; +const DEFAULT_MAX_RETRIES: u32 = 3; +const DEFAULT_MAX_OPEN_RETRIES: u32 = 5; +const ENCODING_BASE64: &str = "base64"; + +#[derive(Debug)] +struct State { + invocations_count: usize, + documents_enqueued: usize, + documents_indexed: usize, + errors_count: usize, +} + +#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum MeilisearchDocumentAction { + #[default] + Replace, + Update, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeilisearchSinkConfig { + pub url: String, + pub index: String, + #[serde(serialize_with = "iggy_common::serde_secret::serialize_optional_secret")] + pub api_key: Option<SecretString>, + pub primary_key: Option<String>, + pub document_action: Option<MeilisearchDocumentAction>, + pub create_index_if_not_exists: Option<bool>, + pub include_metadata: Option<bool>, + pub batch_size: Option<usize>, + pub timeout: Option<String>, + pub wait_for_tasks: Option<bool>, + pub task_timeout: Option<String>, + pub task_poll_interval: Option<String>, + pub max_retries: Option<u32>, + pub retry_delay: Option<String>, + pub max_retry_delay: Option<String>, + pub max_open_retries: Option<u32>, +} + +#[derive(Debug)] +pub struct MeilisearchSink { + id: u32, + config: MeilisearchSinkConfig, + primary_key: String, + document_action: MeilisearchDocumentAction, + create_index_if_not_exists: bool, + include_metadata: bool, + batch_size: usize, + timeout: Duration, + wait_for_tasks: bool, + task_timeout: Duration, + task_poll_interval: Duration, + max_retries: u32, + retry_delay: Duration, + max_retry_delay: Duration, + max_open_retries: u32, + client: Option<Client>, + state: Mutex<State>, +} + +impl MeilisearchSink { + pub fn new(id: u32, config: MeilisearchSinkConfig) -> Self { + let primary_key = config + .primary_key + .clone() + .filter(|value| !value.trim().is_empty()) + .unwrap_or_else(|| DEFAULT_PRIMARY_KEY.to_string()); + let document_action = config.document_action.unwrap_or_default(); + let create_index_if_not_exists = config.create_index_if_not_exists.unwrap_or(true); + let include_metadata = config.include_metadata.unwrap_or(true); + let batch_size = config.batch_size.unwrap_or(DEFAULT_BATCH_SIZE).max(1); + let timeout = parse_duration(config.timeout.as_deref(), DEFAULT_TIMEOUT); + let wait_for_tasks = config.wait_for_tasks.unwrap_or(true); + let task_timeout = parse_duration(config.task_timeout.as_deref(), DEFAULT_TASK_TIMEOUT); + let task_poll_interval = parse_duration( + config.task_poll_interval.as_deref(), + DEFAULT_TASK_POLL_INTERVAL, + ); + let max_retries = config.max_retries.unwrap_or(DEFAULT_MAX_RETRIES).max(1); + let retry_delay = parse_duration(config.retry_delay.as_deref(), DEFAULT_RETRY_DELAY); + let max_retry_delay = + parse_duration(config.max_retry_delay.as_deref(), DEFAULT_MAX_RETRY_DELAY); + let max_open_retries = config + .max_open_retries + .unwrap_or(DEFAULT_MAX_OPEN_RETRIES) + .max(1); + + Self { + id, + config, + primary_key, + document_action, + create_index_if_not_exists, + include_metadata, + batch_size, + timeout, + wait_for_tasks, + task_timeout, + task_poll_interval, + max_retries, + retry_delay, + max_retry_delay, + max_open_retries, + client: None, + state: Mutex::new(State { + invocations_count: 0, + documents_enqueued: 0, + documents_indexed: 0, + errors_count: 0, + }), + } + } + + fn create_client(&self) -> Result<Client, Error> { + let url = normalize_host(&self.config.url)?; + let api_key = self.config.api_key.as_ref().map(|key| key.expose_secret()); + Client::new(url, api_key).map_err(|error| { + Error::Connection(format!("Failed to create Meilisearch client: {error}")) + }) + } + + async fn check_connectivity(&self, client: &Client) -> Result<(), Error> { + let health = self + .retry_sdk_operation("health check", || client.health()) + .await?; + if health.status == "available" { + return Ok(()); + } + + Err(Error::Connection(format!( + "Meilisearch health check returned status '{}'", + health.status + ))) + } + + async fn ensure_index_exists(&self, client: &Client) -> Result<(), Error> { + match self.get_index_if_exists(client).await? { + Some(_) => { + info!("Meilisearch index '{}' already exists", self.config.index); + Ok(()) + } + None if self.create_index_if_not_exists => self.create_index(client).await, + None => Err(Error::InitError(format!( + "Meilisearch index '{}' does not exist and create_index_if_not_exists=false", + self.config.index + ))), + } + } + + async fn get_index_if_exists(&self, client: &Client) -> Result<Option<Index>, Error> { + let max_attempts = self.max_open_retries.max(1); + let mut attempt = 0u32; + + loop { + match client.get_index(&self.config.index).await { + Ok(index) => return Ok(Some(index)), + Err(error) if is_index_not_found(&error) => return Ok(None), + Err(error) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch get index '{}' failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}...", + self.config.index + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn create_index(&self, client: &Client) -> Result<(), Error> { + info!( + "Creating Meilisearch index '{}' with primary key '{}'", + self.config.index, self.primary_key + ); + + let task = self + .retry_sdk_operation("create index", || { + client.create_index(&self.config.index, Some(&self.primary_key)) + }) + .await?; + self.wait_for_task(client, task, true).await?; + + info!("Created Meilisearch index '{}'", self.config.index); + Ok(()) + } + + fn prepare_document( + &self, + topic_metadata: &TopicMetadata, + messages_metadata: &MessagesMetadata, + message: ConsumedMessage, + ) -> Option<Value> { + let generated_id = generated_document_id(topic_metadata, messages_metadata, &message); + let ConsumedMessage { + id, + offset, + checksum, + timestamp, + origin_timestamp, + headers, + payload, + } = message; + + let mut document = match payload { + Payload::Json(value) => { + Self::document_from_json_value(owned_value_to_serde_json(&value)) + } + Payload::Raw(bytes) => { + let mut bytes_copy = bytes.clone(); + match simd_json::from_slice::<simd_json::OwnedValue>(&mut bytes_copy) { + Ok(value) => Self::document_from_json_value(owned_value_to_serde_json(&value)), + Err(_) => json!({ + "data": general_purpose::STANDARD.encode(&bytes), + "data_type": "raw", + "data_encoding": ENCODING_BASE64, + }), + } + } + Payload::Text(text) => json!({ + "text": text, + "data_type": "text", + }), + _ => { + warn!("Unsupported payload format: {}", messages_metadata.schema); + return None; + } + }; + + let object = document + .as_object_mut() + .expect("document_from_json_value always returns an object"); + + object + .entry(self.primary_key.clone()) + .or_insert_with(|| Value::String(generated_id.clone())); + + if self.include_metadata { + object + .entry(DEFAULT_PRIMARY_KEY.to_string()) + .or_insert_with(|| Value::String(generated_id)); + object.insert("iggy_message_id".to_string(), Value::String(id.to_string())); + object.insert("iggy_offset".to_string(), Value::from(offset)); + object.insert( + "iggy_stream".to_string(), + Value::from(topic_metadata.stream.as_str()), + ); + object.insert( + "iggy_topic".to_string(), + Value::from(topic_metadata.topic.as_str()), + ); + object.insert( + "iggy_partition".to_string(), + Value::from(messages_metadata.partition_id), + ); + object.insert("iggy_checksum".to_string(), Value::from(checksum)); + object.insert("iggy_timestamp".to_string(), Value::from(timestamp)); + object.insert( + "iggy_origin_timestamp".to_string(), + Value::from(origin_timestamp), + ); + object.insert( + "iggy_ingested_at".to_string(), + Value::from(IggyTimestamp::now().as_millis() as i64), + ); + if let Some(headers) = &headers + && let Ok(headers_value) = serde_json::to_value(headers) + { + object.insert("iggy_headers".to_string(), headers_value); + } + } + + Some(document) + } + + fn document_from_json_value(value: Value) -> Value { + match value { + Value::Object(_) => value, + other => { + let mut object = Map::new(); + object.insert("value".to_string(), other); + Value::Object(object) + } + } + } + + async fn index_documents( + &self, + client: &Client, + documents: Vec<Value>, + ) -> Result<usize, Error> { + let mut accepted = 0usize; + for chunk in documents.chunks(self.batch_size) { + accepted += self.index_document_chunk(client, chunk).await?; + } + Ok(accepted) + } + + async fn index_document_chunk( + &self, + client: &Client, + documents: &[Value], + ) -> Result<usize, Error> { + if documents.is_empty() { + return Ok(0); + } + + let index = client.index(&self.config.index); + let task = match self.document_action { + MeilisearchDocumentAction::Replace => { + self.retry_sdk_operation("add or replace documents", || { + index.add_or_replace(documents, Some(&self.primary_key)) + }) + .await? + } + MeilisearchDocumentAction::Update => { + self.retry_sdk_operation("add or update documents", || { + index.add_or_update(documents, Some(&self.primary_key)) + }) + .await? + } + }; + self.wait_for_task(client, task, false).await?; + Ok(documents.len()) + } + + async fn wait_for_task( + &self, + client: &Client, + task: TaskInfo, + allow_index_already_exists: bool, + ) -> Result<(), Error> { + if !self.wait_for_tasks { + return Ok(()); + } + + let task = task + .wait_for_completion( + client, + Some(self.task_poll_interval), + Some(self.task_timeout), + ) + .await + .map_err(map_sdk_error)?; + + if task.is_success() { + return Ok(()); + } + + if task.is_failure() { + let failure = task.unwrap_failure(); + if allow_index_already_exists + && failure.error_code == MeilisearchErrorCode::IndexAlreadyExists + { + return Ok(()); + } + return Err(Error::PermanentHttpError(format!( + "Meilisearch task failed: {}", + failure + ))); + } + + Err(Error::HttpRequestFailed( + "Meilisearch task did not reach a terminal state".to_string(), + )) + } + + async fn retry_sdk_operation<T, Fut, Op>( + &self, + operation: &str, + mut operation_fn: Op, + ) -> Result<T, Error> + where + Op: FnMut() -> Fut, + Fut: Future<Output = Result<T, MeilisearchSdkError>>, + { + let max_attempts = self.max_retries.max(1); + let mut attempt = 0u32; + + loop { + let result = tokio::time::timeout(self.timeout, operation_fn()).await; + match result { + Ok(Ok(value)) => return Ok(value), + Ok(Err(error)) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch {operation} failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}..." + ); + tokio::time::sleep(delay).await; + } + Err(_) => { + attempt += 1; + if attempt >= max_attempts { + return Err(Error::HttpRequestFailed(format!( + "Meilisearch {operation} timed out after {:?}", + self.timeout + ))); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch {operation} timed out after {:?} (attempt {attempt}/{max_attempts}). Retrying in {delay:?}...", + self.timeout + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn record_error(&self) { + let mut state = self.state.lock().await; + state.errors_count += 1; + } +} + +#[async_trait] +impl Sink for MeilisearchSink { + async fn open(&mut self) -> Result<(), Error> { + info!( + "Opening Meilisearch sink connector with ID: {} for URL: {}, index: {}", + self.id, + sanitize_url_for_log(&self.config.url), + self.config.index + ); + + let client = self.create_client()?; + self.check_connectivity(&client).await?; + self.ensure_index_exists(&client).await?; + + self.client = Some(client); + info!( + "Successfully opened Meilisearch sink connector with ID: {}", + self.id + ); + Ok(()) + } + + async fn consume( + &self, + topic_metadata: &TopicMetadata, + messages_metadata: MessagesMetadata, + messages: Vec<ConsumedMessage>, + ) -> Result<(), Error> { + let mut state = self.state.lock().await; + state.invocations_count += 1; + let invocation = state.invocations_count; + drop(state); + + info!( + "Meilisearch sink with ID: {} received: {} messages, schema: {}, stream: {}, topic: {}, partition: {}, offset: {}, invocation: {}", + self.id, + messages.len(), + messages_metadata.schema, + topic_metadata.stream, + topic_metadata.topic, + messages_metadata.partition_id, + messages_metadata.current_offset, + invocation + ); + + let client = self + .client + .as_ref() + .ok_or_else(|| Error::Connection("Meilisearch client not initialized".to_string()))?; + + let messages_count = messages.len(); + let documents = messages + .into_iter() + .filter_map(|message| { + self.prepare_document(topic_metadata, &messages_metadata, message) + }) + .collect::<Vec<_>>(); + + if documents.is_empty() { + return Ok(()); + } + + match self.index_documents(client, documents).await { + Ok(accepted) => { + let mut state = self.state.lock().await; + state.documents_enqueued += accepted; + if self.wait_for_tasks { + state.documents_indexed += accepted; + } + info!( + "Accepted {} of {} messages into Meilisearch index '{}'", + accepted, messages_count, self.config.index + ); + Ok(()) + } + Err(error) => { + self.record_error().await; + Err(error) + } + } + } + + async fn close(&mut self) -> Result<(), Error> { + let state = self.state.lock().await; + info!( + "Meilisearch sink connector with ID: {} is closing. Stats: {} invocations, {} documents enqueued, {} documents indexed, {} errors", + self.id, + state.invocations_count, + state.documents_enqueued, + state.documents_indexed, + state.errors_count + ); + drop(state); + + self.client = None; + info!("Meilisearch sink connector with ID: {} is closed.", self.id); + Ok(()) + } +} + +fn generated_document_id( + topic_metadata: &TopicMetadata, + messages_metadata: &MessagesMetadata, + message: &ConsumedMessage, +) -> String { + format!( + "{}_{}_{}_{}_{}", + sanitize_identifier_component(&topic_metadata.stream), + sanitize_identifier_component(&topic_metadata.topic), + messages_metadata.partition_id, + message.offset, + message.id + ) +} + +fn sanitize_identifier_component(value: &str) -> String { + let sanitized = value + .chars() + .map(|ch| { + if ch.is_ascii_alphanumeric() || ch == '-' || ch == '_' { + ch + } else { + '_' + } + }) + .collect::<String>(); + + if sanitized.is_empty() { + "_".to_string() + } else { + sanitized + } +} + +fn sanitize_url_for_log(raw: &str) -> String { + let Ok(mut url) = Url::parse(raw) else { + return raw.to_string(); + }; + + if !url.username().is_empty() { + let _ = url.set_username("<redacted>"); + } + if url.password().is_some() { + let _ = url.set_password(Some("<redacted>")); + } + url.to_string() +} + +fn normalize_host(raw: &str) -> Result<String, Error> { + let url = Url::parse(raw) + .map_err(|error| Error::Connection(format!("Invalid Meilisearch URL: {error}")))?; + let mut host = url.to_string(); + while host.ends_with('/') { + host.pop(); + } + Ok(host) +} + +fn is_index_not_found(error: &MeilisearchSdkError) -> bool { + matches!( + error, + MeilisearchSdkError::Meilisearch(meilisearch_error) + if meilisearch_error.error_code == MeilisearchErrorCode::IndexNotFound + ) +} + +fn is_transient_sdk_error(error: &MeilisearchSdkError) -> bool { + match error { + MeilisearchSdkError::Meilisearch(meilisearch_error) => { + meilisearch_error.error_type == MeilisearchErrorType::Internal + } + MeilisearchSdkError::MeilisearchCommunication(communication_error) => { + communication_error.status_code == 429 || communication_error.status_code >= 500 + } + MeilisearchSdkError::HttpError(_) | MeilisearchSdkError::Timeout => true, + _ => false, + } +} + +fn map_sdk_error(error: MeilisearchSdkError) -> Error { + match error { + MeilisearchSdkError::Meilisearch(meilisearch_error) => { + if meilisearch_error.error_type == MeilisearchErrorType::Internal { + Error::HttpRequestFailed(meilisearch_error.to_string()) + } else { Review Comment: A from trait can be used here to conform with idiomatic rust ########## core/connectors/sinks/meilisearch_sink/src/lib.rs: ########## @@ -0,0 +1,838 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use async_trait::async_trait; +use base64::{Engine as _, engine::general_purpose}; +use iggy_common::IggyTimestamp; +use iggy_connector_sdk::{ + ConsumedMessage, Error, MessagesMetadata, Payload, Sink, TopicMetadata, + convert::owned_value_to_serde_json, + retry::{exponential_backoff, jitter, parse_duration}, + sink_connector, +}; +use meilisearch_sdk::{ + client::Client, + errors::{ + Error as MeilisearchSdkError, ErrorCode as MeilisearchErrorCode, + ErrorType as MeilisearchErrorType, + }, + indexes::Index, + task_info::TaskInfo, +}; +use reqwest::Url; +use secrecy::{ExposeSecret, SecretString}; +use serde::{Deserialize, Serialize}; +use serde_json::{Map, Value, json}; +use std::{future::Future, time::Duration}; +use tokio::sync::Mutex; +use tracing::{info, warn}; + +sink_connector!(MeilisearchSink); + +const DEFAULT_PRIMARY_KEY: &str = "iggy_id"; +const DEFAULT_BATCH_SIZE: usize = 1000; +const DEFAULT_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_POLL_INTERVAL: &str = "100ms"; +const DEFAULT_RETRY_DELAY: &str = "500ms"; +const DEFAULT_MAX_RETRY_DELAY: &str = "5s"; +const DEFAULT_MAX_RETRIES: u32 = 3; +const DEFAULT_MAX_OPEN_RETRIES: u32 = 5; +const ENCODING_BASE64: &str = "base64"; + +#[derive(Debug)] +struct State { + invocations_count: usize, + documents_enqueued: usize, + documents_indexed: usize, + errors_count: usize, +} + +#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum MeilisearchDocumentAction { + #[default] + Replace, + Update, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeilisearchSinkConfig { + pub url: String, + pub index: String, + #[serde(serialize_with = "iggy_common::serde_secret::serialize_optional_secret")] + pub api_key: Option<SecretString>, + pub primary_key: Option<String>, + pub document_action: Option<MeilisearchDocumentAction>, + pub create_index_if_not_exists: Option<bool>, + pub include_metadata: Option<bool>, + pub batch_size: Option<usize>, + pub timeout: Option<String>, + pub wait_for_tasks: Option<bool>, + pub task_timeout: Option<String>, + pub task_poll_interval: Option<String>, + pub max_retries: Option<u32>, + pub retry_delay: Option<String>, + pub max_retry_delay: Option<String>, + pub max_open_retries: Option<u32>, +} + +#[derive(Debug)] +pub struct MeilisearchSink { + id: u32, + config: MeilisearchSinkConfig, + primary_key: String, + document_action: MeilisearchDocumentAction, + create_index_if_not_exists: bool, + include_metadata: bool, + batch_size: usize, + timeout: Duration, + wait_for_tasks: bool, + task_timeout: Duration, + task_poll_interval: Duration, + max_retries: u32, + retry_delay: Duration, + max_retry_delay: Duration, + max_open_retries: u32, + client: Option<Client>, + state: Mutex<State>, +} + +impl MeilisearchSink { + pub fn new(id: u32, config: MeilisearchSinkConfig) -> Self { + let primary_key = config + .primary_key + .clone() + .filter(|value| !value.trim().is_empty()) + .unwrap_or_else(|| DEFAULT_PRIMARY_KEY.to_string()); + let document_action = config.document_action.unwrap_or_default(); + let create_index_if_not_exists = config.create_index_if_not_exists.unwrap_or(true); + let include_metadata = config.include_metadata.unwrap_or(true); + let batch_size = config.batch_size.unwrap_or(DEFAULT_BATCH_SIZE).max(1); + let timeout = parse_duration(config.timeout.as_deref(), DEFAULT_TIMEOUT); + let wait_for_tasks = config.wait_for_tasks.unwrap_or(true); + let task_timeout = parse_duration(config.task_timeout.as_deref(), DEFAULT_TASK_TIMEOUT); + let task_poll_interval = parse_duration( + config.task_poll_interval.as_deref(), + DEFAULT_TASK_POLL_INTERVAL, + ); + let max_retries = config.max_retries.unwrap_or(DEFAULT_MAX_RETRIES).max(1); + let retry_delay = parse_duration(config.retry_delay.as_deref(), DEFAULT_RETRY_DELAY); + let max_retry_delay = + parse_duration(config.max_retry_delay.as_deref(), DEFAULT_MAX_RETRY_DELAY); + let max_open_retries = config + .max_open_retries + .unwrap_or(DEFAULT_MAX_OPEN_RETRIES) + .max(1); + + Self { + id, + config, + primary_key, + document_action, + create_index_if_not_exists, + include_metadata, + batch_size, + timeout, + wait_for_tasks, + task_timeout, + task_poll_interval, + max_retries, + retry_delay, + max_retry_delay, + max_open_retries, + client: None, + state: Mutex::new(State { + invocations_count: 0, + documents_enqueued: 0, + documents_indexed: 0, + errors_count: 0, + }), + } + } + + fn create_client(&self) -> Result<Client, Error> { + let url = normalize_host(&self.config.url)?; + let api_key = self.config.api_key.as_ref().map(|key| key.expose_secret()); + Client::new(url, api_key).map_err(|error| { + Error::Connection(format!("Failed to create Meilisearch client: {error}")) + }) + } + + async fn check_connectivity(&self, client: &Client) -> Result<(), Error> { + let health = self + .retry_sdk_operation("health check", || client.health()) + .await?; + if health.status == "available" { + return Ok(()); + } + + Err(Error::Connection(format!( + "Meilisearch health check returned status '{}'", + health.status + ))) + } + + async fn ensure_index_exists(&self, client: &Client) -> Result<(), Error> { + match self.get_index_if_exists(client).await? { + Some(_) => { + info!("Meilisearch index '{}' already exists", self.config.index); + Ok(()) + } + None if self.create_index_if_not_exists => self.create_index(client).await, + None => Err(Error::InitError(format!( + "Meilisearch index '{}' does not exist and create_index_if_not_exists=false", + self.config.index + ))), + } + } + + async fn get_index_if_exists(&self, client: &Client) -> Result<Option<Index>, Error> { + let max_attempts = self.max_open_retries.max(1); + let mut attempt = 0u32; + + loop { + match client.get_index(&self.config.index).await { + Ok(index) => return Ok(Some(index)), + Err(error) if is_index_not_found(&error) => return Ok(None), + Err(error) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch get index '{}' failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}...", + self.config.index + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn create_index(&self, client: &Client) -> Result<(), Error> { + info!( + "Creating Meilisearch index '{}' with primary key '{}'", + self.config.index, self.primary_key + ); + + let task = self + .retry_sdk_operation("create index", || { + client.create_index(&self.config.index, Some(&self.primary_key)) + }) + .await?; + self.wait_for_task(client, task, true).await?; + + info!("Created Meilisearch index '{}'", self.config.index); + Ok(()) + } Review Comment: The readme says that the `wait_for_tasks` only controls whether `consume()` waits for meilisearch tasks, but this function uses `wait_for_tasks` and immediately returns if the flag is false (the `false` case configuration is broken). This lets `open()` succeed before the index exists, so the first `consume()` can race and fail with `IndexNotFound` ########## core/connectors/sinks/meilisearch_sink/src/lib.rs: ########## @@ -0,0 +1,838 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use async_trait::async_trait; +use base64::{Engine as _, engine::general_purpose}; +use iggy_common::IggyTimestamp; +use iggy_connector_sdk::{ + ConsumedMessage, Error, MessagesMetadata, Payload, Sink, TopicMetadata, + convert::owned_value_to_serde_json, + retry::{exponential_backoff, jitter, parse_duration}, + sink_connector, +}; +use meilisearch_sdk::{ + client::Client, + errors::{ + Error as MeilisearchSdkError, ErrorCode as MeilisearchErrorCode, + ErrorType as MeilisearchErrorType, + }, + indexes::Index, + task_info::TaskInfo, +}; +use reqwest::Url; +use secrecy::{ExposeSecret, SecretString}; +use serde::{Deserialize, Serialize}; +use serde_json::{Map, Value, json}; +use std::{future::Future, time::Duration}; +use tokio::sync::Mutex; +use tracing::{info, warn}; + +sink_connector!(MeilisearchSink); + +const DEFAULT_PRIMARY_KEY: &str = "iggy_id"; +const DEFAULT_BATCH_SIZE: usize = 1000; +const DEFAULT_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_POLL_INTERVAL: &str = "100ms"; +const DEFAULT_RETRY_DELAY: &str = "500ms"; +const DEFAULT_MAX_RETRY_DELAY: &str = "5s"; +const DEFAULT_MAX_RETRIES: u32 = 3; +const DEFAULT_MAX_OPEN_RETRIES: u32 = 5; +const ENCODING_BASE64: &str = "base64"; + +#[derive(Debug)] +struct State { + invocations_count: usize, + documents_enqueued: usize, + documents_indexed: usize, + errors_count: usize, +} + +#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum MeilisearchDocumentAction { + #[default] + Replace, + Update, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeilisearchSinkConfig { + pub url: String, + pub index: String, + #[serde(serialize_with = "iggy_common::serde_secret::serialize_optional_secret")] + pub api_key: Option<SecretString>, + pub primary_key: Option<String>, + pub document_action: Option<MeilisearchDocumentAction>, + pub create_index_if_not_exists: Option<bool>, + pub include_metadata: Option<bool>, + pub batch_size: Option<usize>, + pub timeout: Option<String>, + pub wait_for_tasks: Option<bool>, + pub task_timeout: Option<String>, + pub task_poll_interval: Option<String>, + pub max_retries: Option<u32>, + pub retry_delay: Option<String>, + pub max_retry_delay: Option<String>, + pub max_open_retries: Option<u32>, +} + +#[derive(Debug)] +pub struct MeilisearchSink { + id: u32, + config: MeilisearchSinkConfig, + primary_key: String, + document_action: MeilisearchDocumentAction, + create_index_if_not_exists: bool, + include_metadata: bool, + batch_size: usize, + timeout: Duration, + wait_for_tasks: bool, + task_timeout: Duration, + task_poll_interval: Duration, + max_retries: u32, + retry_delay: Duration, + max_retry_delay: Duration, + max_open_retries: u32, + client: Option<Client>, + state: Mutex<State>, +} + +impl MeilisearchSink { + pub fn new(id: u32, config: MeilisearchSinkConfig) -> Self { + let primary_key = config + .primary_key + .clone() + .filter(|value| !value.trim().is_empty()) + .unwrap_or_else(|| DEFAULT_PRIMARY_KEY.to_string()); + let document_action = config.document_action.unwrap_or_default(); + let create_index_if_not_exists = config.create_index_if_not_exists.unwrap_or(true); + let include_metadata = config.include_metadata.unwrap_or(true); + let batch_size = config.batch_size.unwrap_or(DEFAULT_BATCH_SIZE).max(1); + let timeout = parse_duration(config.timeout.as_deref(), DEFAULT_TIMEOUT); + let wait_for_tasks = config.wait_for_tasks.unwrap_or(true); + let task_timeout = parse_duration(config.task_timeout.as_deref(), DEFAULT_TASK_TIMEOUT); + let task_poll_interval = parse_duration( + config.task_poll_interval.as_deref(), + DEFAULT_TASK_POLL_INTERVAL, + ); + let max_retries = config.max_retries.unwrap_or(DEFAULT_MAX_RETRIES).max(1); + let retry_delay = parse_duration(config.retry_delay.as_deref(), DEFAULT_RETRY_DELAY); + let max_retry_delay = + parse_duration(config.max_retry_delay.as_deref(), DEFAULT_MAX_RETRY_DELAY); + let max_open_retries = config + .max_open_retries + .unwrap_or(DEFAULT_MAX_OPEN_RETRIES) + .max(1); + + Self { + id, + config, + primary_key, + document_action, + create_index_if_not_exists, + include_metadata, + batch_size, + timeout, + wait_for_tasks, + task_timeout, + task_poll_interval, + max_retries, + retry_delay, + max_retry_delay, + max_open_retries, + client: None, + state: Mutex::new(State { + invocations_count: 0, + documents_enqueued: 0, + documents_indexed: 0, + errors_count: 0, + }), + } + } + + fn create_client(&self) -> Result<Client, Error> { + let url = normalize_host(&self.config.url)?; + let api_key = self.config.api_key.as_ref().map(|key| key.expose_secret()); + Client::new(url, api_key).map_err(|error| { + Error::Connection(format!("Failed to create Meilisearch client: {error}")) + }) + } + + async fn check_connectivity(&self, client: &Client) -> Result<(), Error> { + let health = self + .retry_sdk_operation("health check", || client.health()) + .await?; + if health.status == "available" { + return Ok(()); + } + + Err(Error::Connection(format!( + "Meilisearch health check returned status '{}'", + health.status + ))) + } + + async fn ensure_index_exists(&self, client: &Client) -> Result<(), Error> { + match self.get_index_if_exists(client).await? { + Some(_) => { + info!("Meilisearch index '{}' already exists", self.config.index); + Ok(()) + } + None if self.create_index_if_not_exists => self.create_index(client).await, + None => Err(Error::InitError(format!( + "Meilisearch index '{}' does not exist and create_index_if_not_exists=false", + self.config.index + ))), + } + } + + async fn get_index_if_exists(&self, client: &Client) -> Result<Option<Index>, Error> { + let max_attempts = self.max_open_retries.max(1); + let mut attempt = 0u32; + + loop { + match client.get_index(&self.config.index).await { + Ok(index) => return Ok(Some(index)), + Err(error) if is_index_not_found(&error) => return Ok(None), + Err(error) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch get index '{}' failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}...", + self.config.index + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn create_index(&self, client: &Client) -> Result<(), Error> { + info!( + "Creating Meilisearch index '{}' with primary key '{}'", + self.config.index, self.primary_key + ); + + let task = self + .retry_sdk_operation("create index", || { + client.create_index(&self.config.index, Some(&self.primary_key)) + }) + .await?; + self.wait_for_task(client, task, true).await?; + + info!("Created Meilisearch index '{}'", self.config.index); + Ok(()) + } + + fn prepare_document( + &self, + topic_metadata: &TopicMetadata, + messages_metadata: &MessagesMetadata, + message: ConsumedMessage, + ) -> Option<Value> { + let generated_id = generated_document_id(topic_metadata, messages_metadata, &message); + let ConsumedMessage { + id, + offset, + checksum, + timestamp, + origin_timestamp, + headers, + payload, + } = message; + + let mut document = match payload { + Payload::Json(value) => { + Self::document_from_json_value(owned_value_to_serde_json(&value)) + } + Payload::Raw(bytes) => { + let mut bytes_copy = bytes.clone(); + match simd_json::from_slice::<simd_json::OwnedValue>(&mut bytes_copy) { + Ok(value) => Self::document_from_json_value(owned_value_to_serde_json(&value)), + Err(_) => json!({ + "data": general_purpose::STANDARD.encode(&bytes), + "data_type": "raw", + "data_encoding": ENCODING_BASE64, + }), + } + } + Payload::Text(text) => json!({ + "text": text, + "data_type": "text", + }), + _ => { + warn!("Unsupported payload format: {}", messages_metadata.schema); + return None; + } + }; + + let object = document + .as_object_mut() + .expect("document_from_json_value always returns an object"); + + object + .entry(self.primary_key.clone()) + .or_insert_with(|| Value::String(generated_id.clone())); + + if self.include_metadata { + object + .entry(DEFAULT_PRIMARY_KEY.to_string()) + .or_insert_with(|| Value::String(generated_id)); + object.insert("iggy_message_id".to_string(), Value::String(id.to_string())); + object.insert("iggy_offset".to_string(), Value::from(offset)); + object.insert( + "iggy_stream".to_string(), Review Comment: These inserts unconditionally overwrite user fields. If those fields already exist, the document gets mutated on ingestion. Using `entry(...).or_insert(...)` would be a more prudent approach. Logging a warning would also be good. ########## core/connectors/sinks/meilisearch_sink/src/lib.rs: ########## @@ -0,0 +1,838 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use async_trait::async_trait; +use base64::{Engine as _, engine::general_purpose}; +use iggy_common::IggyTimestamp; +use iggy_connector_sdk::{ + ConsumedMessage, Error, MessagesMetadata, Payload, Sink, TopicMetadata, + convert::owned_value_to_serde_json, + retry::{exponential_backoff, jitter, parse_duration}, + sink_connector, +}; +use meilisearch_sdk::{ + client::Client, + errors::{ + Error as MeilisearchSdkError, ErrorCode as MeilisearchErrorCode, + ErrorType as MeilisearchErrorType, + }, + indexes::Index, + task_info::TaskInfo, +}; +use reqwest::Url; +use secrecy::{ExposeSecret, SecretString}; +use serde::{Deserialize, Serialize}; +use serde_json::{Map, Value, json}; +use std::{future::Future, time::Duration}; +use tokio::sync::Mutex; +use tracing::{info, warn}; + +sink_connector!(MeilisearchSink); + +const DEFAULT_PRIMARY_KEY: &str = "iggy_id"; +const DEFAULT_BATCH_SIZE: usize = 1000; +const DEFAULT_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_POLL_INTERVAL: &str = "100ms"; +const DEFAULT_RETRY_DELAY: &str = "500ms"; +const DEFAULT_MAX_RETRY_DELAY: &str = "5s"; +const DEFAULT_MAX_RETRIES: u32 = 3; +const DEFAULT_MAX_OPEN_RETRIES: u32 = 5; +const ENCODING_BASE64: &str = "base64"; + +#[derive(Debug)] +struct State { + invocations_count: usize, + documents_enqueued: usize, + documents_indexed: usize, + errors_count: usize, +} + +#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum MeilisearchDocumentAction { + #[default] + Replace, + Update, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeilisearchSinkConfig { + pub url: String, + pub index: String, + #[serde(serialize_with = "iggy_common::serde_secret::serialize_optional_secret")] + pub api_key: Option<SecretString>, + pub primary_key: Option<String>, + pub document_action: Option<MeilisearchDocumentAction>, + pub create_index_if_not_exists: Option<bool>, + pub include_metadata: Option<bool>, + pub batch_size: Option<usize>, + pub timeout: Option<String>, + pub wait_for_tasks: Option<bool>, + pub task_timeout: Option<String>, + pub task_poll_interval: Option<String>, + pub max_retries: Option<u32>, + pub retry_delay: Option<String>, + pub max_retry_delay: Option<String>, + pub max_open_retries: Option<u32>, +} + +#[derive(Debug)] +pub struct MeilisearchSink { + id: u32, + config: MeilisearchSinkConfig, + primary_key: String, + document_action: MeilisearchDocumentAction, + create_index_if_not_exists: bool, + include_metadata: bool, + batch_size: usize, + timeout: Duration, + wait_for_tasks: bool, + task_timeout: Duration, + task_poll_interval: Duration, + max_retries: u32, + retry_delay: Duration, + max_retry_delay: Duration, + max_open_retries: u32, + client: Option<Client>, + state: Mutex<State>, +} + +impl MeilisearchSink { + pub fn new(id: u32, config: MeilisearchSinkConfig) -> Self { + let primary_key = config + .primary_key + .clone() + .filter(|value| !value.trim().is_empty()) + .unwrap_or_else(|| DEFAULT_PRIMARY_KEY.to_string()); + let document_action = config.document_action.unwrap_or_default(); + let create_index_if_not_exists = config.create_index_if_not_exists.unwrap_or(true); + let include_metadata = config.include_metadata.unwrap_or(true); + let batch_size = config.batch_size.unwrap_or(DEFAULT_BATCH_SIZE).max(1); + let timeout = parse_duration(config.timeout.as_deref(), DEFAULT_TIMEOUT); + let wait_for_tasks = config.wait_for_tasks.unwrap_or(true); + let task_timeout = parse_duration(config.task_timeout.as_deref(), DEFAULT_TASK_TIMEOUT); + let task_poll_interval = parse_duration( + config.task_poll_interval.as_deref(), + DEFAULT_TASK_POLL_INTERVAL, + ); + let max_retries = config.max_retries.unwrap_or(DEFAULT_MAX_RETRIES).max(1); + let retry_delay = parse_duration(config.retry_delay.as_deref(), DEFAULT_RETRY_DELAY); + let max_retry_delay = + parse_duration(config.max_retry_delay.as_deref(), DEFAULT_MAX_RETRY_DELAY); + let max_open_retries = config + .max_open_retries + .unwrap_or(DEFAULT_MAX_OPEN_RETRIES) + .max(1); + + Self { + id, + config, + primary_key, + document_action, + create_index_if_not_exists, + include_metadata, + batch_size, + timeout, + wait_for_tasks, + task_timeout, + task_poll_interval, + max_retries, + retry_delay, + max_retry_delay, + max_open_retries, + client: None, + state: Mutex::new(State { + invocations_count: 0, + documents_enqueued: 0, + documents_indexed: 0, + errors_count: 0, + }), + } + } + + fn create_client(&self) -> Result<Client, Error> { + let url = normalize_host(&self.config.url)?; + let api_key = self.config.api_key.as_ref().map(|key| key.expose_secret()); + Client::new(url, api_key).map_err(|error| { + Error::Connection(format!("Failed to create Meilisearch client: {error}")) + }) + } + + async fn check_connectivity(&self, client: &Client) -> Result<(), Error> { + let health = self + .retry_sdk_operation("health check", || client.health()) + .await?; + if health.status == "available" { + return Ok(()); + } + + Err(Error::Connection(format!( + "Meilisearch health check returned status '{}'", + health.status + ))) + } + + async fn ensure_index_exists(&self, client: &Client) -> Result<(), Error> { + match self.get_index_if_exists(client).await? { + Some(_) => { + info!("Meilisearch index '{}' already exists", self.config.index); + Ok(()) + } + None if self.create_index_if_not_exists => self.create_index(client).await, + None => Err(Error::InitError(format!( + "Meilisearch index '{}' does not exist and create_index_if_not_exists=false", + self.config.index + ))), + } + } + + async fn get_index_if_exists(&self, client: &Client) -> Result<Option<Index>, Error> { + let max_attempts = self.max_open_retries.max(1); + let mut attempt = 0u32; + + loop { + match client.get_index(&self.config.index).await { + Ok(index) => return Ok(Some(index)), + Err(error) if is_index_not_found(&error) => return Ok(None), + Err(error) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch get index '{}' failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}...", + self.config.index + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn create_index(&self, client: &Client) -> Result<(), Error> { + info!( + "Creating Meilisearch index '{}' with primary key '{}'", + self.config.index, self.primary_key + ); + + let task = self + .retry_sdk_operation("create index", || { + client.create_index(&self.config.index, Some(&self.primary_key)) + }) + .await?; + self.wait_for_task(client, task, true).await?; + + info!("Created Meilisearch index '{}'", self.config.index); + Ok(()) + } + + fn prepare_document( + &self, + topic_metadata: &TopicMetadata, + messages_metadata: &MessagesMetadata, + message: ConsumedMessage, + ) -> Option<Value> { + let generated_id = generated_document_id(topic_metadata, messages_metadata, &message); + let ConsumedMessage { + id, + offset, + checksum, + timestamp, + origin_timestamp, + headers, + payload, + } = message; + + let mut document = match payload { + Payload::Json(value) => { + Self::document_from_json_value(owned_value_to_serde_json(&value)) + } + Payload::Raw(bytes) => { + let mut bytes_copy = bytes.clone(); + match simd_json::from_slice::<simd_json::OwnedValue>(&mut bytes_copy) { + Ok(value) => Self::document_from_json_value(owned_value_to_serde_json(&value)), + Err(_) => json!({ + "data": general_purpose::STANDARD.encode(&bytes), + "data_type": "raw", + "data_encoding": ENCODING_BASE64, + }), + } + } + Payload::Text(text) => json!({ + "text": text, + "data_type": "text", + }), + _ => { + warn!("Unsupported payload format: {}", messages_metadata.schema); + return None; + } + }; + + let object = document + .as_object_mut() + .expect("document_from_json_value always returns an object"); + + object + .entry(self.primary_key.clone()) + .or_insert_with(|| Value::String(generated_id.clone())); + + if self.include_metadata { + object + .entry(DEFAULT_PRIMARY_KEY.to_string()) + .or_insert_with(|| Value::String(generated_id)); + object.insert("iggy_message_id".to_string(), Value::String(id.to_string())); + object.insert("iggy_offset".to_string(), Value::from(offset)); + object.insert( + "iggy_stream".to_string(), + Value::from(topic_metadata.stream.as_str()), + ); + object.insert( + "iggy_topic".to_string(), + Value::from(topic_metadata.topic.as_str()), + ); + object.insert( + "iggy_partition".to_string(), + Value::from(messages_metadata.partition_id), + ); + object.insert("iggy_checksum".to_string(), Value::from(checksum)); + object.insert("iggy_timestamp".to_string(), Value::from(timestamp)); + object.insert( + "iggy_origin_timestamp".to_string(), + Value::from(origin_timestamp), + ); + object.insert( + "iggy_ingested_at".to_string(), + Value::from(IggyTimestamp::now().as_millis() as i64), + ); + if let Some(headers) = &headers + && let Ok(headers_value) = serde_json::to_value(headers) + { + object.insert("iggy_headers".to_string(), headers_value); + } + } + + Some(document) + } + + fn document_from_json_value(value: Value) -> Value { + match value { + Value::Object(_) => value, + other => { + let mut object = Map::new(); + object.insert("value".to_string(), other); + Value::Object(object) + } + } + } + + async fn index_documents( + &self, + client: &Client, + documents: Vec<Value>, + ) -> Result<usize, Error> { + let mut accepted = 0usize; + for chunk in documents.chunks(self.batch_size) { + accepted += self.index_document_chunk(client, chunk).await?; + } + Ok(accepted) + } + + async fn index_document_chunk( + &self, + client: &Client, + documents: &[Value], + ) -> Result<usize, Error> { + if documents.is_empty() { + return Ok(0); + } + + let index = client.index(&self.config.index); + let task = match self.document_action { + MeilisearchDocumentAction::Replace => { + self.retry_sdk_operation("add or replace documents", || { + index.add_or_replace(documents, Some(&self.primary_key)) + }) + .await? + } + MeilisearchDocumentAction::Update => { + self.retry_sdk_operation("add or update documents", || { + index.add_or_update(documents, Some(&self.primary_key)) + }) + .await? + } + }; + self.wait_for_task(client, task, false).await?; + Ok(documents.len()) + } + + async fn wait_for_task( + &self, + client: &Client, + task: TaskInfo, + allow_index_already_exists: bool, + ) -> Result<(), Error> { + if !self.wait_for_tasks { + return Ok(()); + } + + let task = task + .wait_for_completion( + client, + Some(self.task_poll_interval), + Some(self.task_timeout), + ) + .await + .map_err(map_sdk_error)?; + + if task.is_success() { + return Ok(()); + } + + if task.is_failure() { + let failure = task.unwrap_failure(); + if allow_index_already_exists + && failure.error_code == MeilisearchErrorCode::IndexAlreadyExists + { + return Ok(()); + } + return Err(Error::PermanentHttpError(format!( + "Meilisearch task failed: {}", + failure + ))); + } + + Err(Error::HttpRequestFailed( + "Meilisearch task did not reach a terminal state".to_string(), + )) + } + + async fn retry_sdk_operation<T, Fut, Op>( + &self, + operation: &str, + mut operation_fn: Op, + ) -> Result<T, Error> + where + Op: FnMut() -> Fut, + Fut: Future<Output = Result<T, MeilisearchSdkError>>, + { + let max_attempts = self.max_retries.max(1); + let mut attempt = 0u32; + + loop { + let result = tokio::time::timeout(self.timeout, operation_fn()).await; + match result { + Ok(Ok(value)) => return Ok(value), + Ok(Err(error)) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch {operation} failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}..." + ); + tokio::time::sleep(delay).await; + } + Err(_) => { + attempt += 1; + if attempt >= max_attempts { + return Err(Error::HttpRequestFailed(format!( + "Meilisearch {operation} timed out after {:?}", + self.timeout + ))); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch {operation} timed out after {:?} (attempt {attempt}/{max_attempts}). Retrying in {delay:?}...", + self.timeout + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn record_error(&self) { + let mut state = self.state.lock().await; + state.errors_count += 1; + } +} + +#[async_trait] +impl Sink for MeilisearchSink { + async fn open(&mut self) -> Result<(), Error> { + info!( + "Opening Meilisearch sink connector with ID: {} for URL: {}, index: {}", + self.id, + sanitize_url_for_log(&self.config.url), + self.config.index + ); + + let client = self.create_client()?; + self.check_connectivity(&client).await?; + self.ensure_index_exists(&client).await?; + + self.client = Some(client); + info!( + "Successfully opened Meilisearch sink connector with ID: {}", + self.id + ); + Ok(()) + } + + async fn consume( + &self, + topic_metadata: &TopicMetadata, + messages_metadata: MessagesMetadata, + messages: Vec<ConsumedMessage>, + ) -> Result<(), Error> { + let mut state = self.state.lock().await; + state.invocations_count += 1; + let invocation = state.invocations_count; + drop(state); + + info!( + "Meilisearch sink with ID: {} received: {} messages, schema: {}, stream: {}, topic: {}, partition: {}, offset: {}, invocation: {}", + self.id, + messages.len(), + messages_metadata.schema, + topic_metadata.stream, + topic_metadata.topic, + messages_metadata.partition_id, + messages_metadata.current_offset, + invocation + ); + + let client = self + .client + .as_ref() + .ok_or_else(|| Error::Connection("Meilisearch client not initialized".to_string()))?; + + let messages_count = messages.len(); + let documents = messages + .into_iter() + .filter_map(|message| { + self.prepare_document(topic_metadata, &messages_metadata, message) + }) + .collect::<Vec<_>>(); + + if documents.is_empty() { + return Ok(()); + } + + match self.index_documents(client, documents).await { + Ok(accepted) => { + let mut state = self.state.lock().await; + state.documents_enqueued += accepted; + if self.wait_for_tasks { + state.documents_indexed += accepted; + } + info!( + "Accepted {} of {} messages into Meilisearch index '{}'", + accepted, messages_count, self.config.index + ); + Ok(()) + } + Err(error) => { + self.record_error().await; + Err(error) + } + } + } + + async fn close(&mut self) -> Result<(), Error> { + let state = self.state.lock().await; + info!( + "Meilisearch sink connector with ID: {} is closing. Stats: {} invocations, {} documents enqueued, {} documents indexed, {} errors", + self.id, + state.invocations_count, + state.documents_enqueued, + state.documents_indexed, + state.errors_count + ); + drop(state); + + self.client = None; + info!("Meilisearch sink connector with ID: {} is closed.", self.id); + Ok(()) + } +} + +fn generated_document_id( + topic_metadata: &TopicMetadata, + messages_metadata: &MessagesMetadata, + message: &ConsumedMessage, +) -> String { + format!( + "{}_{}_{}_{}_{}", + sanitize_identifier_component(&topic_metadata.stream), + sanitize_identifier_component(&topic_metadata.topic), + messages_metadata.partition_id, + message.offset, + message.id + ) +} Review Comment: `sanitize_identifier_component` would convert both `orders.stream` and `orders/stream` to `orders_stream`. If both also have the same topic after sanitization, same partition, same offset, and same message ID, they produce the same Meilisearch document ID, resulting in loss of data. ########## core/connectors/sinks/meilisearch_sink/src/lib.rs: ########## @@ -0,0 +1,838 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use async_trait::async_trait; +use base64::{Engine as _, engine::general_purpose}; +use iggy_common::IggyTimestamp; +use iggy_connector_sdk::{ + ConsumedMessage, Error, MessagesMetadata, Payload, Sink, TopicMetadata, + convert::owned_value_to_serde_json, + retry::{exponential_backoff, jitter, parse_duration}, + sink_connector, +}; +use meilisearch_sdk::{ + client::Client, + errors::{ + Error as MeilisearchSdkError, ErrorCode as MeilisearchErrorCode, + ErrorType as MeilisearchErrorType, + }, + indexes::Index, + task_info::TaskInfo, +}; +use reqwest::Url; +use secrecy::{ExposeSecret, SecretString}; +use serde::{Deserialize, Serialize}; +use serde_json::{Map, Value, json}; +use std::{future::Future, time::Duration}; +use tokio::sync::Mutex; +use tracing::{info, warn}; + +sink_connector!(MeilisearchSink); + +const DEFAULT_PRIMARY_KEY: &str = "iggy_id"; +const DEFAULT_BATCH_SIZE: usize = 1000; +const DEFAULT_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_POLL_INTERVAL: &str = "100ms"; +const DEFAULT_RETRY_DELAY: &str = "500ms"; +const DEFAULT_MAX_RETRY_DELAY: &str = "5s"; +const DEFAULT_MAX_RETRIES: u32 = 3; +const DEFAULT_MAX_OPEN_RETRIES: u32 = 5; +const ENCODING_BASE64: &str = "base64"; + +#[derive(Debug)] +struct State { + invocations_count: usize, + documents_enqueued: usize, + documents_indexed: usize, + errors_count: usize, +} + +#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum MeilisearchDocumentAction { + #[default] + Replace, + Update, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeilisearchSinkConfig { + pub url: String, + pub index: String, + #[serde(serialize_with = "iggy_common::serde_secret::serialize_optional_secret")] + pub api_key: Option<SecretString>, + pub primary_key: Option<String>, + pub document_action: Option<MeilisearchDocumentAction>, + pub create_index_if_not_exists: Option<bool>, + pub include_metadata: Option<bool>, + pub batch_size: Option<usize>, + pub timeout: Option<String>, + pub wait_for_tasks: Option<bool>, + pub task_timeout: Option<String>, + pub task_poll_interval: Option<String>, + pub max_retries: Option<u32>, + pub retry_delay: Option<String>, + pub max_retry_delay: Option<String>, + pub max_open_retries: Option<u32>, +} + +#[derive(Debug)] +pub struct MeilisearchSink { + id: u32, + config: MeilisearchSinkConfig, + primary_key: String, + document_action: MeilisearchDocumentAction, + create_index_if_not_exists: bool, + include_metadata: bool, + batch_size: usize, + timeout: Duration, + wait_for_tasks: bool, + task_timeout: Duration, + task_poll_interval: Duration, + max_retries: u32, + retry_delay: Duration, + max_retry_delay: Duration, + max_open_retries: u32, + client: Option<Client>, + state: Mutex<State>, +} + +impl MeilisearchSink { + pub fn new(id: u32, config: MeilisearchSinkConfig) -> Self { + let primary_key = config + .primary_key + .clone() + .filter(|value| !value.trim().is_empty()) + .unwrap_or_else(|| DEFAULT_PRIMARY_KEY.to_string()); + let document_action = config.document_action.unwrap_or_default(); + let create_index_if_not_exists = config.create_index_if_not_exists.unwrap_or(true); + let include_metadata = config.include_metadata.unwrap_or(true); + let batch_size = config.batch_size.unwrap_or(DEFAULT_BATCH_SIZE).max(1); + let timeout = parse_duration(config.timeout.as_deref(), DEFAULT_TIMEOUT); + let wait_for_tasks = config.wait_for_tasks.unwrap_or(true); + let task_timeout = parse_duration(config.task_timeout.as_deref(), DEFAULT_TASK_TIMEOUT); + let task_poll_interval = parse_duration( + config.task_poll_interval.as_deref(), + DEFAULT_TASK_POLL_INTERVAL, + ); + let max_retries = config.max_retries.unwrap_or(DEFAULT_MAX_RETRIES).max(1); + let retry_delay = parse_duration(config.retry_delay.as_deref(), DEFAULT_RETRY_DELAY); + let max_retry_delay = + parse_duration(config.max_retry_delay.as_deref(), DEFAULT_MAX_RETRY_DELAY); + let max_open_retries = config + .max_open_retries + .unwrap_or(DEFAULT_MAX_OPEN_RETRIES) + .max(1); + + Self { + id, + config, + primary_key, + document_action, + create_index_if_not_exists, + include_metadata, + batch_size, + timeout, + wait_for_tasks, + task_timeout, + task_poll_interval, + max_retries, + retry_delay, + max_retry_delay, + max_open_retries, + client: None, + state: Mutex::new(State { + invocations_count: 0, + documents_enqueued: 0, + documents_indexed: 0, + errors_count: 0, + }), + } + } + + fn create_client(&self) -> Result<Client, Error> { + let url = normalize_host(&self.config.url)?; + let api_key = self.config.api_key.as_ref().map(|key| key.expose_secret()); + Client::new(url, api_key).map_err(|error| { + Error::Connection(format!("Failed to create Meilisearch client: {error}")) + }) + } + + async fn check_connectivity(&self, client: &Client) -> Result<(), Error> { + let health = self + .retry_sdk_operation("health check", || client.health()) + .await?; + if health.status == "available" { + return Ok(()); + } + + Err(Error::Connection(format!( + "Meilisearch health check returned status '{}'", + health.status + ))) + } + + async fn ensure_index_exists(&self, client: &Client) -> Result<(), Error> { + match self.get_index_if_exists(client).await? { + Some(_) => { + info!("Meilisearch index '{}' already exists", self.config.index); + Ok(()) + } + None if self.create_index_if_not_exists => self.create_index(client).await, + None => Err(Error::InitError(format!( + "Meilisearch index '{}' does not exist and create_index_if_not_exists=false", + self.config.index + ))), + } + } + + async fn get_index_if_exists(&self, client: &Client) -> Result<Option<Index>, Error> { + let max_attempts = self.max_open_retries.max(1); + let mut attempt = 0u32; + + loop { + match client.get_index(&self.config.index).await { + Ok(index) => return Ok(Some(index)), + Err(error) if is_index_not_found(&error) => return Ok(None), + Err(error) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch get index '{}' failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}...", + self.config.index + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn create_index(&self, client: &Client) -> Result<(), Error> { + info!( + "Creating Meilisearch index '{}' with primary key '{}'", + self.config.index, self.primary_key + ); + + let task = self + .retry_sdk_operation("create index", || { + client.create_index(&self.config.index, Some(&self.primary_key)) + }) + .await?; + self.wait_for_task(client, task, true).await?; + + info!("Created Meilisearch index '{}'", self.config.index); + Ok(()) + } + + fn prepare_document( + &self, + topic_metadata: &TopicMetadata, + messages_metadata: &MessagesMetadata, + message: ConsumedMessage, + ) -> Option<Value> { + let generated_id = generated_document_id(topic_metadata, messages_metadata, &message); + let ConsumedMessage { + id, + offset, + checksum, + timestamp, + origin_timestamp, + headers, + payload, + } = message; + + let mut document = match payload { + Payload::Json(value) => { + Self::document_from_json_value(owned_value_to_serde_json(&value)) + } + Payload::Raw(bytes) => { + let mut bytes_copy = bytes.clone(); + match simd_json::from_slice::<simd_json::OwnedValue>(&mut bytes_copy) { + Ok(value) => Self::document_from_json_value(owned_value_to_serde_json(&value)), + Err(_) => json!({ + "data": general_purpose::STANDARD.encode(&bytes), + "data_type": "raw", + "data_encoding": ENCODING_BASE64, + }), + } + } + Payload::Text(text) => json!({ + "text": text, + "data_type": "text", + }), + _ => { + warn!("Unsupported payload format: {}", messages_metadata.schema); + return None; Review Comment: The current approach logs a warning before simply filtering out non-json/text messages. If the batch becomes empty, `consume` returns `Ok(())` which is a silent data-loss path. ########## core/connectors/sinks/meilisearch_sink/src/lib.rs: ########## @@ -0,0 +1,838 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use async_trait::async_trait; +use base64::{Engine as _, engine::general_purpose}; +use iggy_common::IggyTimestamp; +use iggy_connector_sdk::{ + ConsumedMessage, Error, MessagesMetadata, Payload, Sink, TopicMetadata, + convert::owned_value_to_serde_json, + retry::{exponential_backoff, jitter, parse_duration}, + sink_connector, +}; +use meilisearch_sdk::{ + client::Client, + errors::{ + Error as MeilisearchSdkError, ErrorCode as MeilisearchErrorCode, + ErrorType as MeilisearchErrorType, + }, + indexes::Index, + task_info::TaskInfo, +}; +use reqwest::Url; +use secrecy::{ExposeSecret, SecretString}; +use serde::{Deserialize, Serialize}; +use serde_json::{Map, Value, json}; +use std::{future::Future, time::Duration}; +use tokio::sync::Mutex; +use tracing::{info, warn}; + +sink_connector!(MeilisearchSink); + +const DEFAULT_PRIMARY_KEY: &str = "iggy_id"; +const DEFAULT_BATCH_SIZE: usize = 1000; +const DEFAULT_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_POLL_INTERVAL: &str = "100ms"; +const DEFAULT_RETRY_DELAY: &str = "500ms"; +const DEFAULT_MAX_RETRY_DELAY: &str = "5s"; +const DEFAULT_MAX_RETRIES: u32 = 3; +const DEFAULT_MAX_OPEN_RETRIES: u32 = 5; +const ENCODING_BASE64: &str = "base64"; + +#[derive(Debug)] +struct State { + invocations_count: usize, + documents_enqueued: usize, + documents_indexed: usize, + errors_count: usize, +} + +#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum MeilisearchDocumentAction { + #[default] + Replace, + Update, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeilisearchSinkConfig { + pub url: String, + pub index: String, + #[serde(serialize_with = "iggy_common::serde_secret::serialize_optional_secret")] + pub api_key: Option<SecretString>, + pub primary_key: Option<String>, + pub document_action: Option<MeilisearchDocumentAction>, + pub create_index_if_not_exists: Option<bool>, + pub include_metadata: Option<bool>, + pub batch_size: Option<usize>, + pub timeout: Option<String>, + pub wait_for_tasks: Option<bool>, + pub task_timeout: Option<String>, + pub task_poll_interval: Option<String>, + pub max_retries: Option<u32>, + pub retry_delay: Option<String>, + pub max_retry_delay: Option<String>, + pub max_open_retries: Option<u32>, +} + +#[derive(Debug)] +pub struct MeilisearchSink { + id: u32, + config: MeilisearchSinkConfig, + primary_key: String, + document_action: MeilisearchDocumentAction, + create_index_if_not_exists: bool, + include_metadata: bool, + batch_size: usize, + timeout: Duration, + wait_for_tasks: bool, + task_timeout: Duration, + task_poll_interval: Duration, + max_retries: u32, + retry_delay: Duration, + max_retry_delay: Duration, + max_open_retries: u32, + client: Option<Client>, + state: Mutex<State>, +} + +impl MeilisearchSink { + pub fn new(id: u32, config: MeilisearchSinkConfig) -> Self { + let primary_key = config + .primary_key + .clone() + .filter(|value| !value.trim().is_empty()) + .unwrap_or_else(|| DEFAULT_PRIMARY_KEY.to_string()); + let document_action = config.document_action.unwrap_or_default(); + let create_index_if_not_exists = config.create_index_if_not_exists.unwrap_or(true); + let include_metadata = config.include_metadata.unwrap_or(true); + let batch_size = config.batch_size.unwrap_or(DEFAULT_BATCH_SIZE).max(1); + let timeout = parse_duration(config.timeout.as_deref(), DEFAULT_TIMEOUT); + let wait_for_tasks = config.wait_for_tasks.unwrap_or(true); + let task_timeout = parse_duration(config.task_timeout.as_deref(), DEFAULT_TASK_TIMEOUT); + let task_poll_interval = parse_duration( + config.task_poll_interval.as_deref(), + DEFAULT_TASK_POLL_INTERVAL, + ); + let max_retries = config.max_retries.unwrap_or(DEFAULT_MAX_RETRIES).max(1); + let retry_delay = parse_duration(config.retry_delay.as_deref(), DEFAULT_RETRY_DELAY); + let max_retry_delay = + parse_duration(config.max_retry_delay.as_deref(), DEFAULT_MAX_RETRY_DELAY); + let max_open_retries = config + .max_open_retries + .unwrap_or(DEFAULT_MAX_OPEN_RETRIES) + .max(1); + + Self { + id, + config, + primary_key, + document_action, + create_index_if_not_exists, + include_metadata, + batch_size, + timeout, + wait_for_tasks, + task_timeout, + task_poll_interval, + max_retries, + retry_delay, + max_retry_delay, + max_open_retries, + client: None, + state: Mutex::new(State { + invocations_count: 0, + documents_enqueued: 0, + documents_indexed: 0, + errors_count: 0, + }), + } + } + + fn create_client(&self) -> Result<Client, Error> { + let url = normalize_host(&self.config.url)?; + let api_key = self.config.api_key.as_ref().map(|key| key.expose_secret()); + Client::new(url, api_key).map_err(|error| { + Error::Connection(format!("Failed to create Meilisearch client: {error}")) + }) + } + + async fn check_connectivity(&self, client: &Client) -> Result<(), Error> { + let health = self + .retry_sdk_operation("health check", || client.health()) + .await?; + if health.status == "available" { + return Ok(()); + } + + Err(Error::Connection(format!( + "Meilisearch health check returned status '{}'", + health.status + ))) + } + + async fn ensure_index_exists(&self, client: &Client) -> Result<(), Error> { + match self.get_index_if_exists(client).await? { + Some(_) => { + info!("Meilisearch index '{}' already exists", self.config.index); + Ok(()) + } + None if self.create_index_if_not_exists => self.create_index(client).await, + None => Err(Error::InitError(format!( + "Meilisearch index '{}' does not exist and create_index_if_not_exists=false", + self.config.index + ))), + } + } + + async fn get_index_if_exists(&self, client: &Client) -> Result<Option<Index>, Error> { + let max_attempts = self.max_open_retries.max(1); + let mut attempt = 0u32; + + loop { + match client.get_index(&self.config.index).await { + Ok(index) => return Ok(Some(index)), + Err(error) if is_index_not_found(&error) => return Ok(None), + Err(error) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch get index '{}' failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}...", + self.config.index + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn create_index(&self, client: &Client) -> Result<(), Error> { + info!( + "Creating Meilisearch index '{}' with primary key '{}'", + self.config.index, self.primary_key + ); + + let task = self + .retry_sdk_operation("create index", || { + client.create_index(&self.config.index, Some(&self.primary_key)) + }) + .await?; + self.wait_for_task(client, task, true).await?; + + info!("Created Meilisearch index '{}'", self.config.index); + Ok(()) + } + + fn prepare_document( + &self, + topic_metadata: &TopicMetadata, + messages_metadata: &MessagesMetadata, + message: ConsumedMessage, + ) -> Option<Value> { + let generated_id = generated_document_id(topic_metadata, messages_metadata, &message); + let ConsumedMessage { + id, + offset, + checksum, + timestamp, + origin_timestamp, + headers, + payload, + } = message; + + let mut document = match payload { + Payload::Json(value) => { + Self::document_from_json_value(owned_value_to_serde_json(&value)) + } + Payload::Raw(bytes) => { + let mut bytes_copy = bytes.clone(); + match simd_json::from_slice::<simd_json::OwnedValue>(&mut bytes_copy) { + Ok(value) => Self::document_from_json_value(owned_value_to_serde_json(&value)), + Err(_) => json!({ + "data": general_purpose::STANDARD.encode(&bytes), + "data_type": "raw", + "data_encoding": ENCODING_BASE64, + }), + } + } + Payload::Text(text) => json!({ + "text": text, + "data_type": "text", + }), + _ => { + warn!("Unsupported payload format: {}", messages_metadata.schema); + return None; + } + }; + + let object = document + .as_object_mut() + .expect("document_from_json_value always returns an object"); + + object + .entry(self.primary_key.clone()) + .or_insert_with(|| Value::String(generated_id.clone())); + + if self.include_metadata { + object + .entry(DEFAULT_PRIMARY_KEY.to_string()) + .or_insert_with(|| Value::String(generated_id)); + object.insert("iggy_message_id".to_string(), Value::String(id.to_string())); + object.insert("iggy_offset".to_string(), Value::from(offset)); + object.insert( + "iggy_stream".to_string(), + Value::from(topic_metadata.stream.as_str()), + ); + object.insert( + "iggy_topic".to_string(), + Value::from(topic_metadata.topic.as_str()), + ); + object.insert( + "iggy_partition".to_string(), + Value::from(messages_metadata.partition_id), + ); + object.insert("iggy_checksum".to_string(), Value::from(checksum)); + object.insert("iggy_timestamp".to_string(), Value::from(timestamp)); + object.insert( + "iggy_origin_timestamp".to_string(), + Value::from(origin_timestamp), + ); + object.insert( + "iggy_ingested_at".to_string(), + Value::from(IggyTimestamp::now().as_millis() as i64), + ); + if let Some(headers) = &headers + && let Ok(headers_value) = serde_json::to_value(headers) + { + object.insert("iggy_headers".to_string(), headers_value); + } + } + + Some(document) + } + + fn document_from_json_value(value: Value) -> Value { + match value { + Value::Object(_) => value, + other => { + let mut object = Map::new(); + object.insert("value".to_string(), other); + Value::Object(object) + } + } + } + + async fn index_documents( + &self, + client: &Client, + documents: Vec<Value>, + ) -> Result<usize, Error> { + let mut accepted = 0usize; + for chunk in documents.chunks(self.batch_size) { + accepted += self.index_document_chunk(client, chunk).await?; + } + Ok(accepted) + } + + async fn index_document_chunk( + &self, + client: &Client, + documents: &[Value], + ) -> Result<usize, Error> { + if documents.is_empty() { + return Ok(0); + } + + let index = client.index(&self.config.index); + let task = match self.document_action { + MeilisearchDocumentAction::Replace => { + self.retry_sdk_operation("add or replace documents", || { + index.add_or_replace(documents, Some(&self.primary_key)) + }) + .await? + } + MeilisearchDocumentAction::Update => { + self.retry_sdk_operation("add or update documents", || { + index.add_or_update(documents, Some(&self.primary_key)) + }) + .await? + } + }; + self.wait_for_task(client, task, false).await?; + Ok(documents.len()) + } + + async fn wait_for_task( + &self, + client: &Client, + task: TaskInfo, + allow_index_already_exists: bool, Review Comment: This function is supposed to be a generic helper function, but it is mixing feature-specific code with generic code by including the `allow_index_already_exists` flag. It would be better to let `create_index` handle the `IndexAlreadyExists` part. ########## core/connectors/sinks/meilisearch_sink/src/lib.rs: ########## @@ -0,0 +1,838 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use async_trait::async_trait; +use base64::{Engine as _, engine::general_purpose}; +use iggy_common::IggyTimestamp; +use iggy_connector_sdk::{ + ConsumedMessage, Error, MessagesMetadata, Payload, Sink, TopicMetadata, + convert::owned_value_to_serde_json, + retry::{exponential_backoff, jitter, parse_duration}, + sink_connector, +}; +use meilisearch_sdk::{ + client::Client, + errors::{ + Error as MeilisearchSdkError, ErrorCode as MeilisearchErrorCode, + ErrorType as MeilisearchErrorType, + }, + indexes::Index, + task_info::TaskInfo, +}; +use reqwest::Url; +use secrecy::{ExposeSecret, SecretString}; +use serde::{Deserialize, Serialize}; +use serde_json::{Map, Value, json}; +use std::{future::Future, time::Duration}; +use tokio::sync::Mutex; +use tracing::{info, warn}; + +sink_connector!(MeilisearchSink); + +const DEFAULT_PRIMARY_KEY: &str = "iggy_id"; +const DEFAULT_BATCH_SIZE: usize = 1000; +const DEFAULT_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_POLL_INTERVAL: &str = "100ms"; +const DEFAULT_RETRY_DELAY: &str = "500ms"; +const DEFAULT_MAX_RETRY_DELAY: &str = "5s"; +const DEFAULT_MAX_RETRIES: u32 = 3; +const DEFAULT_MAX_OPEN_RETRIES: u32 = 5; +const ENCODING_BASE64: &str = "base64"; + +#[derive(Debug)] +struct State { + invocations_count: usize, + documents_enqueued: usize, + documents_indexed: usize, + errors_count: usize, +} + +#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum MeilisearchDocumentAction { + #[default] + Replace, + Update, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeilisearchSinkConfig { + pub url: String, + pub index: String, + #[serde(serialize_with = "iggy_common::serde_secret::serialize_optional_secret")] + pub api_key: Option<SecretString>, + pub primary_key: Option<String>, + pub document_action: Option<MeilisearchDocumentAction>, + pub create_index_if_not_exists: Option<bool>, + pub include_metadata: Option<bool>, + pub batch_size: Option<usize>, + pub timeout: Option<String>, + pub wait_for_tasks: Option<bool>, + pub task_timeout: Option<String>, + pub task_poll_interval: Option<String>, + pub max_retries: Option<u32>, + pub retry_delay: Option<String>, + pub max_retry_delay: Option<String>, + pub max_open_retries: Option<u32>, +} + +#[derive(Debug)] +pub struct MeilisearchSink { + id: u32, + config: MeilisearchSinkConfig, + primary_key: String, + document_action: MeilisearchDocumentAction, + create_index_if_not_exists: bool, + include_metadata: bool, + batch_size: usize, + timeout: Duration, + wait_for_tasks: bool, + task_timeout: Duration, + task_poll_interval: Duration, + max_retries: u32, + retry_delay: Duration, + max_retry_delay: Duration, + max_open_retries: u32, + client: Option<Client>, + state: Mutex<State>, +} + +impl MeilisearchSink { + pub fn new(id: u32, config: MeilisearchSinkConfig) -> Self { + let primary_key = config + .primary_key + .clone() + .filter(|value| !value.trim().is_empty()) + .unwrap_or_else(|| DEFAULT_PRIMARY_KEY.to_string()); + let document_action = config.document_action.unwrap_or_default(); + let create_index_if_not_exists = config.create_index_if_not_exists.unwrap_or(true); + let include_metadata = config.include_metadata.unwrap_or(true); + let batch_size = config.batch_size.unwrap_or(DEFAULT_BATCH_SIZE).max(1); + let timeout = parse_duration(config.timeout.as_deref(), DEFAULT_TIMEOUT); + let wait_for_tasks = config.wait_for_tasks.unwrap_or(true); + let task_timeout = parse_duration(config.task_timeout.as_deref(), DEFAULT_TASK_TIMEOUT); + let task_poll_interval = parse_duration( + config.task_poll_interval.as_deref(), + DEFAULT_TASK_POLL_INTERVAL, + ); + let max_retries = config.max_retries.unwrap_or(DEFAULT_MAX_RETRIES).max(1); + let retry_delay = parse_duration(config.retry_delay.as_deref(), DEFAULT_RETRY_DELAY); + let max_retry_delay = + parse_duration(config.max_retry_delay.as_deref(), DEFAULT_MAX_RETRY_DELAY); + let max_open_retries = config + .max_open_retries + .unwrap_or(DEFAULT_MAX_OPEN_RETRIES) + .max(1); + + Self { + id, + config, + primary_key, + document_action, + create_index_if_not_exists, + include_metadata, + batch_size, + timeout, + wait_for_tasks, + task_timeout, + task_poll_interval, + max_retries, + retry_delay, + max_retry_delay, + max_open_retries, + client: None, + state: Mutex::new(State { + invocations_count: 0, + documents_enqueued: 0, + documents_indexed: 0, + errors_count: 0, + }), + } + } + + fn create_client(&self) -> Result<Client, Error> { + let url = normalize_host(&self.config.url)?; + let api_key = self.config.api_key.as_ref().map(|key| key.expose_secret()); + Client::new(url, api_key).map_err(|error| { + Error::Connection(format!("Failed to create Meilisearch client: {error}")) + }) + } + + async fn check_connectivity(&self, client: &Client) -> Result<(), Error> { + let health = self + .retry_sdk_operation("health check", || client.health()) + .await?; + if health.status == "available" { + return Ok(()); + } + + Err(Error::Connection(format!( + "Meilisearch health check returned status '{}'", + health.status + ))) + } + + async fn ensure_index_exists(&self, client: &Client) -> Result<(), Error> { + match self.get_index_if_exists(client).await? { + Some(_) => { + info!("Meilisearch index '{}' already exists", self.config.index); + Ok(()) + } + None if self.create_index_if_not_exists => self.create_index(client).await, + None => Err(Error::InitError(format!( + "Meilisearch index '{}' does not exist and create_index_if_not_exists=false", + self.config.index + ))), + } + } + + async fn get_index_if_exists(&self, client: &Client) -> Result<Option<Index>, Error> { + let max_attempts = self.max_open_retries.max(1); + let mut attempt = 0u32; + + loop { + match client.get_index(&self.config.index).await { + Ok(index) => return Ok(Some(index)), + Err(error) if is_index_not_found(&error) => return Ok(None), + Err(error) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch get index '{}' failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}...", + self.config.index + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn create_index(&self, client: &Client) -> Result<(), Error> { + info!( + "Creating Meilisearch index '{}' with primary key '{}'", + self.config.index, self.primary_key + ); + + let task = self + .retry_sdk_operation("create index", || { + client.create_index(&self.config.index, Some(&self.primary_key)) + }) + .await?; + self.wait_for_task(client, task, true).await?; + + info!("Created Meilisearch index '{}'", self.config.index); + Ok(()) + } + + fn prepare_document( + &self, + topic_metadata: &TopicMetadata, + messages_metadata: &MessagesMetadata, + message: ConsumedMessage, + ) -> Option<Value> { + let generated_id = generated_document_id(topic_metadata, messages_metadata, &message); + let ConsumedMessage { + id, + offset, + checksum, + timestamp, + origin_timestamp, + headers, + payload, + } = message; + + let mut document = match payload { + Payload::Json(value) => { + Self::document_from_json_value(owned_value_to_serde_json(&value)) + } + Payload::Raw(bytes) => { + let mut bytes_copy = bytes.clone(); + match simd_json::from_slice::<simd_json::OwnedValue>(&mut bytes_copy) { + Ok(value) => Self::document_from_json_value(owned_value_to_serde_json(&value)), + Err(_) => json!({ + "data": general_purpose::STANDARD.encode(&bytes), + "data_type": "raw", + "data_encoding": ENCODING_BASE64, + }), + } + } + Payload::Text(text) => json!({ + "text": text, + "data_type": "text", + }), + _ => { + warn!("Unsupported payload format: {}", messages_metadata.schema); + return None; + } + }; + + let object = document + .as_object_mut() + .expect("document_from_json_value always returns an object"); + + object + .entry(self.primary_key.clone()) + .or_insert_with(|| Value::String(generated_id.clone())); + + if self.include_metadata { + object + .entry(DEFAULT_PRIMARY_KEY.to_string()) + .or_insert_with(|| Value::String(generated_id)); + object.insert("iggy_message_id".to_string(), Value::String(id.to_string())); + object.insert("iggy_offset".to_string(), Value::from(offset)); + object.insert( + "iggy_stream".to_string(), + Value::from(topic_metadata.stream.as_str()), + ); + object.insert( + "iggy_topic".to_string(), + Value::from(topic_metadata.topic.as_str()), + ); + object.insert( + "iggy_partition".to_string(), + Value::from(messages_metadata.partition_id), + ); + object.insert("iggy_checksum".to_string(), Value::from(checksum)); + object.insert("iggy_timestamp".to_string(), Value::from(timestamp)); + object.insert( + "iggy_origin_timestamp".to_string(), + Value::from(origin_timestamp), + ); + object.insert( + "iggy_ingested_at".to_string(), + Value::from(IggyTimestamp::now().as_millis() as i64), + ); + if let Some(headers) = &headers + && let Ok(headers_value) = serde_json::to_value(headers) + { + object.insert("iggy_headers".to_string(), headers_value); + } + } + + Some(document) + } + + fn document_from_json_value(value: Value) -> Value { + match value { + Value::Object(_) => value, + other => { + let mut object = Map::new(); + object.insert("value".to_string(), other); + Value::Object(object) + } + } + } + + async fn index_documents( + &self, + client: &Client, + documents: Vec<Value>, + ) -> Result<usize, Error> { + let mut accepted = 0usize; + for chunk in documents.chunks(self.batch_size) { + accepted += self.index_document_chunk(client, chunk).await?; + } + Ok(accepted) + } + + async fn index_document_chunk( + &self, + client: &Client, + documents: &[Value], + ) -> Result<usize, Error> { + if documents.is_empty() { + return Ok(0); + } + + let index = client.index(&self.config.index); + let task = match self.document_action { + MeilisearchDocumentAction::Replace => { + self.retry_sdk_operation("add or replace documents", || { + index.add_or_replace(documents, Some(&self.primary_key)) + }) + .await? + } + MeilisearchDocumentAction::Update => { + self.retry_sdk_operation("add or update documents", || { + index.add_or_update(documents, Some(&self.primary_key)) + }) + .await? + } + }; + self.wait_for_task(client, task, false).await?; + Ok(documents.len()) + } + + async fn wait_for_task( + &self, + client: &Client, + task: TaskInfo, + allow_index_already_exists: bool, + ) -> Result<(), Error> { + if !self.wait_for_tasks { + return Ok(()); + } + + let task = task + .wait_for_completion( + client, + Some(self.task_poll_interval), + Some(self.task_timeout), + ) + .await + .map_err(map_sdk_error)?; + + if task.is_success() { + return Ok(()); + } + + if task.is_failure() { + let failure = task.unwrap_failure(); + if allow_index_already_exists + && failure.error_code == MeilisearchErrorCode::IndexAlreadyExists + { + return Ok(()); + } + return Err(Error::PermanentHttpError(format!( + "Meilisearch task failed: {}", + failure + ))); + } + + Err(Error::HttpRequestFailed( + "Meilisearch task did not reach a terminal state".to_string(), + )) + } + + async fn retry_sdk_operation<T, Fut, Op>( + &self, + operation: &str, + mut operation_fn: Op, + ) -> Result<T, Error> + where + Op: FnMut() -> Fut, + Fut: Future<Output = Result<T, MeilisearchSdkError>>, + { + let max_attempts = self.max_retries.max(1); + let mut attempt = 0u32; + + loop { + let result = tokio::time::timeout(self.timeout, operation_fn()).await; + match result { + Ok(Ok(value)) => return Ok(value), + Ok(Err(error)) => { + attempt += 1; + let should_retry = attempt < max_attempts && is_transient_sdk_error(&error); + if !should_retry { + return Err(map_sdk_error(error)); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch {operation} failed (attempt {attempt}/{max_attempts}): {error}. Retrying in {delay:?}..." + ); + tokio::time::sleep(delay).await; + } + Err(_) => { + attempt += 1; + if attempt >= max_attempts { + return Err(Error::HttpRequestFailed(format!( + "Meilisearch {operation} timed out after {:?}", + self.timeout + ))); + } + let delay = jitter(exponential_backoff( + self.retry_delay, + attempt, + self.max_retry_delay, + )); + warn!( + "Meilisearch {operation} timed out after {:?} (attempt {attempt}/{max_attempts}). Retrying in {delay:?}...", + self.timeout + ); + tokio::time::sleep(delay).await; + } + } + } + } + + async fn record_error(&self) { + let mut state = self.state.lock().await; + state.errors_count += 1; + } +} + +#[async_trait] +impl Sink for MeilisearchSink { + async fn open(&mut self) -> Result<(), Error> { + info!( + "Opening Meilisearch sink connector with ID: {} for URL: {}, index: {}", + self.id, + sanitize_url_for_log(&self.config.url), + self.config.index + ); + + let client = self.create_client()?; + self.check_connectivity(&client).await?; + self.ensure_index_exists(&client).await?; + + self.client = Some(client); + info!( + "Successfully opened Meilisearch sink connector with ID: {}", + self.id + ); + Ok(()) + } + + async fn consume( + &self, + topic_metadata: &TopicMetadata, + messages_metadata: MessagesMetadata, + messages: Vec<ConsumedMessage>, + ) -> Result<(), Error> { + let mut state = self.state.lock().await; + state.invocations_count += 1; + let invocation = state.invocations_count; + drop(state); + + info!( + "Meilisearch sink with ID: {} received: {} messages, schema: {}, stream: {}, topic: {}, partition: {}, offset: {}, invocation: {}", + self.id, + messages.len(), + messages_metadata.schema, + topic_metadata.stream, + topic_metadata.topic, + messages_metadata.partition_id, + messages_metadata.current_offset, + invocation + ); + + let client = self + .client + .as_ref() + .ok_or_else(|| Error::Connection("Meilisearch client not initialized".to_string()))?; + + let messages_count = messages.len(); + let documents = messages + .into_iter() + .filter_map(|message| { + self.prepare_document(topic_metadata, &messages_metadata, message) + }) + .collect::<Vec<_>>(); + + if documents.is_empty() { + return Ok(()); + } + + match self.index_documents(client, documents).await { + Ok(accepted) => { + let mut state = self.state.lock().await; + state.documents_enqueued += accepted; + if self.wait_for_tasks { + state.documents_indexed += accepted; + } + info!( + "Accepted {} of {} messages into Meilisearch index '{}'", + accepted, messages_count, self.config.index + ); + Ok(()) + } + Err(error) => { + self.record_error().await; + Err(error) + } + } + } + + async fn close(&mut self) -> Result<(), Error> { + let state = self.state.lock().await; + info!( + "Meilisearch sink connector with ID: {} is closing. Stats: {} invocations, {} documents enqueued, {} documents indexed, {} errors", + self.id, + state.invocations_count, + state.documents_enqueued, + state.documents_indexed, + state.errors_count + ); + drop(state); + + self.client = None; + info!("Meilisearch sink connector with ID: {} is closed.", self.id); + Ok(()) + } +} + +fn generated_document_id( + topic_metadata: &TopicMetadata, + messages_metadata: &MessagesMetadata, + message: &ConsumedMessage, +) -> String { + format!( + "{}_{}_{}_{}_{}", + sanitize_identifier_component(&topic_metadata.stream), + sanitize_identifier_component(&topic_metadata.topic), + messages_metadata.partition_id, + message.offset, + message.id + ) +} + +fn sanitize_identifier_component(value: &str) -> String { + let sanitized = value + .chars() + .map(|ch| { + if ch.is_ascii_alphanumeric() || ch == '-' || ch == '_' { + ch + } else { + '_' + } + }) + .collect::<String>(); + + if sanitized.is_empty() { + "_".to_string() + } else { + sanitized + } +} + +fn sanitize_url_for_log(raw: &str) -> String { + let Ok(mut url) = Url::parse(raw) else { + return raw.to_string(); + }; + + if !url.username().is_empty() { + let _ = url.set_username("<redacted>"); + } + if url.password().is_some() { + let _ = url.set_password(Some("<redacted>")); + } + url.to_string() +} + +fn normalize_host(raw: &str) -> Result<String, Error> { + let url = Url::parse(raw) + .map_err(|error| Error::Connection(format!("Invalid Meilisearch URL: {error}")))?; + let mut host = url.to_string(); + while host.ends_with('/') { + host.pop(); + } + Ok(host) +} Review Comment: The `normalize_host` in the sink and the source are different. Any reason for that? ########## core/connectors/sinks/meilisearch_sink/src/lib.rs: ########## @@ -0,0 +1,838 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use async_trait::async_trait; +use base64::{Engine as _, engine::general_purpose}; +use iggy_common::IggyTimestamp; +use iggy_connector_sdk::{ + ConsumedMessage, Error, MessagesMetadata, Payload, Sink, TopicMetadata, + convert::owned_value_to_serde_json, + retry::{exponential_backoff, jitter, parse_duration}, + sink_connector, +}; +use meilisearch_sdk::{ + client::Client, + errors::{ + Error as MeilisearchSdkError, ErrorCode as MeilisearchErrorCode, + ErrorType as MeilisearchErrorType, + }, + indexes::Index, + task_info::TaskInfo, +}; +use reqwest::Url; +use secrecy::{ExposeSecret, SecretString}; +use serde::{Deserialize, Serialize}; +use serde_json::{Map, Value, json}; +use std::{future::Future, time::Duration}; +use tokio::sync::Mutex; +use tracing::{info, warn}; + +sink_connector!(MeilisearchSink); + +const DEFAULT_PRIMARY_KEY: &str = "iggy_id"; +const DEFAULT_BATCH_SIZE: usize = 1000; +const DEFAULT_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_TIMEOUT: &str = "30s"; +const DEFAULT_TASK_POLL_INTERVAL: &str = "100ms"; +const DEFAULT_RETRY_DELAY: &str = "500ms"; +const DEFAULT_MAX_RETRY_DELAY: &str = "5s"; +const DEFAULT_MAX_RETRIES: u32 = 3; +const DEFAULT_MAX_OPEN_RETRIES: u32 = 5; +const ENCODING_BASE64: &str = "base64"; + +#[derive(Debug)] +struct State { + invocations_count: usize, + documents_enqueued: usize, + documents_indexed: usize, + errors_count: usize, +} + +#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum MeilisearchDocumentAction { + #[default] + Replace, + Update, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct MeilisearchSinkConfig { + pub url: String, + pub index: String, + #[serde(serialize_with = "iggy_common::serde_secret::serialize_optional_secret")] + pub api_key: Option<SecretString>, + pub primary_key: Option<String>, + pub document_action: Option<MeilisearchDocumentAction>, + pub create_index_if_not_exists: Option<bool>, + pub include_metadata: Option<bool>, + pub batch_size: Option<usize>, + pub timeout: Option<String>, + pub wait_for_tasks: Option<bool>, + pub task_timeout: Option<String>, + pub task_poll_interval: Option<String>, + pub max_retries: Option<u32>, + pub retry_delay: Option<String>, + pub max_retry_delay: Option<String>, + pub max_open_retries: Option<u32>, +} + +#[derive(Debug)] +pub struct MeilisearchSink { + id: u32, + config: MeilisearchSinkConfig, + primary_key: String, + document_action: MeilisearchDocumentAction, + create_index_if_not_exists: bool, + include_metadata: bool, + batch_size: usize, + timeout: Duration, Review Comment: This code carries both the raw config and a second normalized config. This creates two sources of truth inside the same type. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
