mirror of
https://github.com/meilisearch/MeiliSearch
synced 2024-11-26 14:54:27 +01:00
Return an error when an attribute is not searchable
This commit is contained in:
parent
dc391deca0
commit
59f64a5256
@ -333,6 +333,9 @@ impl ErrorCode for milli::Error {
|
|||||||
UserError::SortRankingRuleMissing => Code::InvalidSearchSort,
|
UserError::SortRankingRuleMissing => Code::InvalidSearchSort,
|
||||||
UserError::InvalidFacetsDistribution { .. } => Code::InvalidSearchFacets,
|
UserError::InvalidFacetsDistribution { .. } => Code::InvalidSearchFacets,
|
||||||
UserError::InvalidSortableAttribute { .. } => Code::InvalidSearchSort,
|
UserError::InvalidSortableAttribute { .. } => Code::InvalidSearchSort,
|
||||||
|
UserError::InvalidSearchableAttribute { .. } => {
|
||||||
|
Code::InvalidAttributesToSearchOn
|
||||||
|
}
|
||||||
UserError::CriterionError(_) => Code::InvalidSettingsRankingRules,
|
UserError::CriterionError(_) => Code::InvalidSettingsRankingRules,
|
||||||
UserError::InvalidGeoField { .. } => Code::InvalidDocumentGeoField,
|
UserError::InvalidGeoField { .. } => Code::InvalidDocumentGeoField,
|
||||||
UserError::SortError(_) => Code::InvalidSearchSort,
|
UserError::SortError(_) => Code::InvalidSearchSort,
|
||||||
|
@ -963,3 +963,27 @@ async fn sort_unset_ranking_rule() {
|
|||||||
)
|
)
|
||||||
.await;
|
.await;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[actix_rt::test]
|
||||||
|
async fn search_on_unknown_field() {
|
||||||
|
let server = Server::new().await;
|
||||||
|
let index = server.index("test");
|
||||||
|
let documents = DOCUMENTS.clone();
|
||||||
|
index.add_documents(documents, None).await;
|
||||||
|
index.wait_task(0).await;
|
||||||
|
|
||||||
|
index
|
||||||
|
.search(
|
||||||
|
json!({"q": "Captain Marvel", "attributesToSearchOn": ["unknown"]}),
|
||||||
|
|response, code| {
|
||||||
|
assert_eq!(400, code, "{}", response);
|
||||||
|
assert_eq!(response, json!({
|
||||||
|
"message": "Attribute `unknown` is not searchable. Available searchable attributes are: `id, title`.",
|
||||||
|
"code": "invalid_attributes_to_search_on",
|
||||||
|
"type": "invalid_request",
|
||||||
|
"link": "https://docs.meilisearch.com/errors#invalid_attributes_to_search_on"
|
||||||
|
}));
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
}
|
||||||
|
@ -75,22 +75,6 @@ async fn simple_search_on_title_matching_strategy_all() {
|
|||||||
.await;
|
.await;
|
||||||
}
|
}
|
||||||
|
|
||||||
#[actix_rt::test]
|
|
||||||
async fn simple_search_on_unknown_field() {
|
|
||||||
let server = Server::new().await;
|
|
||||||
let index = index_with_documents(&server, &SIMPLE_SEARCH_DOCUMENTS).await;
|
|
||||||
// simple search on unknown field shouldn't return any document.
|
|
||||||
index
|
|
||||||
.search(
|
|
||||||
json!({"q": "Captain Marvel", "attributesToSearchOn": ["unknown"]}),
|
|
||||||
|response, code| {
|
|
||||||
assert_eq!(200, code, "{}", response);
|
|
||||||
assert_eq!(response["hits"].as_array().unwrap().len(), 0);
|
|
||||||
},
|
|
||||||
)
|
|
||||||
.await;
|
|
||||||
}
|
|
||||||
|
|
||||||
#[actix_rt::test]
|
#[actix_rt::test]
|
||||||
async fn simple_search_on_no_field() {
|
async fn simple_search_on_no_field() {
|
||||||
let server = Server::new().await;
|
let server = Server::new().await;
|
||||||
|
@ -124,6 +124,16 @@ only composed of alphanumeric characters (a-z A-Z 0-9), hyphens (-) and undersco
|
|||||||
}
|
}
|
||||||
)]
|
)]
|
||||||
InvalidSortableAttribute { field: String, valid_fields: BTreeSet<String> },
|
InvalidSortableAttribute { field: String, valid_fields: BTreeSet<String> },
|
||||||
|
#[error("Attribute `{}` is not searchable. Available searchable attributes are: `{}{}`.",
|
||||||
|
.field,
|
||||||
|
.valid_fields.iter().map(AsRef::as_ref).collect::<Vec<&str>>().join(", "),
|
||||||
|
.hidden_fields.then_some(", <..hidden-attributes>").unwrap_or(""),
|
||||||
|
)]
|
||||||
|
InvalidSearchableAttribute {
|
||||||
|
field: String,
|
||||||
|
valid_fields: BTreeSet<String>,
|
||||||
|
hidden_fields: bool,
|
||||||
|
},
|
||||||
#[error("{}", HeedError::BadOpenOptions)]
|
#[error("{}", HeedError::BadOpenOptions)]
|
||||||
InvalidLmdbOpenOptions,
|
InvalidLmdbOpenOptions,
|
||||||
#[error("You must specify where `sort` is listed in the rankingRules setting to use the sort parameter at search time.")]
|
#[error("You must specify where `sort` is listed in the rankingRules setting to use the sort parameter at search time.")]
|
||||||
|
@ -20,7 +20,7 @@ mod sort;
|
|||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests;
|
mod tests;
|
||||||
|
|
||||||
use std::collections::HashSet;
|
use std::collections::{BTreeSet, HashSet};
|
||||||
|
|
||||||
use bucket_sort::{bucket_sort, BucketSortOutput};
|
use bucket_sort::{bucket_sort, BucketSortOutput};
|
||||||
use charabia::TokenizerBuilder;
|
use charabia::TokenizerBuilder;
|
||||||
@ -44,6 +44,7 @@ use self::geo_sort::GeoSort;
|
|||||||
pub use self::geo_sort::Strategy as GeoSortStrategy;
|
pub use self::geo_sort::Strategy as GeoSortStrategy;
|
||||||
use self::graph_based_ranking_rule::Words;
|
use self::graph_based_ranking_rule::Words;
|
||||||
use self::interner::Interned;
|
use self::interner::Interned;
|
||||||
|
use crate::error::FieldIdMapMissingEntry;
|
||||||
use crate::score_details::{ScoreDetails, ScoringStrategy};
|
use crate::score_details::{ScoreDetails, ScoringStrategy};
|
||||||
use crate::search::new::distinct::apply_distinct_rule;
|
use crate::search::new::distinct::apply_distinct_rule;
|
||||||
use crate::{AscDesc, DocumentId, Filter, Index, Member, Result, TermsMatchingStrategy, UserError};
|
use crate::{AscDesc, DocumentId, Filter, Index, Member, Result, TermsMatchingStrategy, UserError};
|
||||||
@ -76,8 +77,56 @@ impl<'ctx> SearchContext<'ctx> {
|
|||||||
|
|
||||||
pub fn searchable_attributes(&mut self, searchable_attributes: &'ctx [String]) -> Result<()> {
|
pub fn searchable_attributes(&mut self, searchable_attributes: &'ctx [String]) -> Result<()> {
|
||||||
let fids_map = self.index.fields_ids_map(self.txn)?;
|
let fids_map = self.index.fields_ids_map(self.txn)?;
|
||||||
let restricted_fids =
|
let searchable_names = self.index.searchable_fields(self.txn)?;
|
||||||
searchable_attributes.iter().filter_map(|name| fids_map.id(name)).collect();
|
|
||||||
|
let mut restricted_fids = Vec::new();
|
||||||
|
for field_name in searchable_attributes {
|
||||||
|
let searchable_contains_name =
|
||||||
|
searchable_names.as_ref().map(|sn| sn.iter().any(|name| name == field_name));
|
||||||
|
let fid = match (fids_map.id(field_name), searchable_contains_name) {
|
||||||
|
// The Field id exist and the field is searchable
|
||||||
|
(Some(fid), Some(true)) | (Some(fid), None) => fid,
|
||||||
|
// The field is searchable but the Field id doesn't exist => Internal Error
|
||||||
|
(None, Some(true)) => {
|
||||||
|
return Err(FieldIdMapMissingEntry::FieldName {
|
||||||
|
field_name: field_name.to_string(),
|
||||||
|
process: "search",
|
||||||
|
}
|
||||||
|
.into())
|
||||||
|
}
|
||||||
|
// The field is not searchable => User error
|
||||||
|
_otherwise => {
|
||||||
|
let mut valid_fields: BTreeSet<_> =
|
||||||
|
fids_map.names().map(String::from).collect();
|
||||||
|
|
||||||
|
// Filter by the searchable names
|
||||||
|
if let Some(sn) = searchable_names {
|
||||||
|
let searchable_names = sn.iter().map(|s| s.to_string()).collect();
|
||||||
|
valid_fields = &valid_fields & &searchable_names;
|
||||||
|
}
|
||||||
|
|
||||||
|
let searchable_count = valid_fields.len();
|
||||||
|
|
||||||
|
// Remove hidden fields
|
||||||
|
if let Some(dn) = self.index.displayed_fields(self.txn)? {
|
||||||
|
let displayable_names = dn.iter().map(|s| s.to_string()).collect();
|
||||||
|
valid_fields = &valid_fields & &displayable_names;
|
||||||
|
}
|
||||||
|
|
||||||
|
let hidden_fields = searchable_count > valid_fields.len();
|
||||||
|
let field = field_name.to_string();
|
||||||
|
return Err(UserError::InvalidSearchableAttribute {
|
||||||
|
field,
|
||||||
|
valid_fields,
|
||||||
|
hidden_fields,
|
||||||
|
}
|
||||||
|
.into());
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
restricted_fids.push(fid);
|
||||||
|
}
|
||||||
|
|
||||||
self.restricted_fids = Some(restricted_fids);
|
self.restricted_fids = Some(restricted_fids);
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
|
Loading…
Reference in New Issue
Block a user