Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: behavior of Elasticsearch query differs from mongoDB query #1184

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/elastic-search/configuration/datasetFieldMapping.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export const datasetMappings: MappingObject = {
},
pid: {
type: "keyword",
ignore_above: 256,
},
creationTime: {
type: "date",
Expand All @@ -48,29 +49,45 @@ export const datasetMappings: MappingObject = {
},
proposalId: {
type: "keyword",
ignore_above: 256,
},
sampleId: {
type: "keyword",
ignore_above: 256,
},
sourceFolder: {
type: "keyword",
ignore_above: 256,
},
isPublished: {
type: "boolean",
},
type: {
type: "keyword",
ignore_above: 256,
},
keywords: {
type: "keyword",
ignore_above: 256,
},
creationLocation: {
type: "keyword",
ignore_above: 256,
},
ownerGroup: {
type: "keyword",
ignore_above: 256,
},
accessGroups: {
type: "keyword",
ignore_above: 256,
},
sharedWith: {
type: "keyword",
ignore_above: 256,
},
ownerEmail: {
type: "keyword",
ignore_above: 256,
},
};
2 changes: 1 addition & 1 deletion src/elastic-search/elastic-search.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ export class ElasticSearchService implements OnModuleInit {
];
},
onDrop(doc) {
console.debug(`${doc.document._id}`, doc.error?.reason);
console.debug(`${doc.document.pid}`, doc.error?.reason);
},
});
}
Expand Down
18 changes: 9 additions & 9 deletions src/elastic-search/providers/fields.enum.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,7 @@ export enum FilterFields {
Mode = "mode",
}

export enum FacetFields {
Type = "type",
CreationLocation = "creationLocation",
OwnerGroup = "ownerGroup",
AccessGroups = "accessGroups",
Keywords = "keywords",
}

export enum QueryFields {
export enum MustFields {
DatasetName = "datasetName",
Description = "description",
}
Expand All @@ -30,6 +22,14 @@ export enum ShouldFields {
UserGroups = "userGroups",
}

export enum FacetFields {
Type = "type",
CreationLocation = "creationLocation",
OwnerGroup = "ownerGroup",
AccessGroups = "accessGroups",
Keywords = "keywords",
}

export enum SortFields {
DatasetName = "datasetName",
DatasetNameKeyword = "datasetName.keyword",
Expand Down
31 changes: 17 additions & 14 deletions src/elastic-search/providers/query-builder.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
} from "../interfaces/es-common.type";
import {
FilterFields,
QueryFields,
MustFields,
FacetFields,
ShouldFields,
} from "./fields.enum";
Expand All @@ -22,7 +22,7 @@ import { convertToElasticSearchQuery } from "../helpers/utils";
@Injectable()
export class SearchQueryService {
readonly filterFields = [...Object.values(FilterFields)];
readonly queryFields = [...Object.values(QueryFields)];
readonly mustFields = [...Object.values(MustFields)];
readonly shouldFields = [...Object.values(ShouldFields)];
readonly facetFields = [...Object.values(FacetFields)];
readonly textQuerySplitMethod = /[ ,]+/;
Expand All @@ -33,9 +33,13 @@ export class SearchQueryService {

const filter = this.buildFilterFields(fields);
const should = this.buildShouldFields(fields);
const query = this.buildTextQuery(fields);
const must = this.buildTextQuery(fields);

return this.constructFinalQuery(filter, should, query);
// NOTE: The final query flow is as follows:
// step 1. Build filter fields conditions must match all filter fields
// step 2. Build should fields conditions must match at least one should field
// step 3. Build text query conditions must match all text query fields
return this.constructFinalQuery(filter, should, must);
} catch (err) {
Logger.error("Elastic search build search query failed");
throw err;
Expand All @@ -44,15 +48,14 @@ export class SearchQueryService {
private buildFilterFields(fields: Partial<IDatasetFields>): IFilter[] {
const filter: IFilter[] = [];

for (const fieldName of this.filterFields) {
if (fields[fieldName]) {
const filterQueries = this.buildTermsFilter(
fieldName,
fields[fieldName],
);
filter.push(...filterQueries);
Object.entries(fields).forEach(([key, value]) => {
if (this.shouldFields.includes(key as ShouldFields) || key === "text") {
return;
}
}

const filterQueries = this.buildTermsFilter(key, value);
filter.push(...filterQueries);
});

return filter;
}
Expand Down Expand Up @@ -101,7 +104,7 @@ export class SearchQueryService {
private buildWildcardQueries(text: string): QueryDslQueryContainer[] {
const terms = this.splitSearchText(text);
return terms.flatMap((term) =>
this.queryFields.map((fieldName) => ({
this.mustFields.map((fieldName) => ({
wildcard: { [fieldName]: { value: `*${term}*` } },
})),
);
Expand Down Expand Up @@ -173,7 +176,7 @@ export class SearchQueryService {
if (typeof values === "string") {
filterArray.push({
match: {
[`${fieldName}.keyword`]: values as string,
[fieldName]: values as string,
},
});
}
Expand Down