Skip to content

Fix search relevance #1385

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix search relevance #1385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 18 additions & 2 deletions server/src/main/java/org/eclipse/openvsx/search/ElasticSearchService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ public SearchResult search(Options options) {
}

var queryBuilder = new NativeQueryBuilder();
queryBuilder.withQuery(builder -> builder.bool(boolQuery -> createSearchQuery(boolQuery, options)));
createQuery(queryBuilder, options);

// Sort search results according to 'sortOrder' and 'sortBy' options
sortResults(queryBuilder, options.sortOrder(), options.sortBy());
Expand Down Expand Up @@ -351,6 +351,22 @@ private ObjectBuilder<BoolQuery> createTextSearchQuery(BoolQuery.Builder boolQue
return boolQuery;
}

private void createQuery(NativeQueryBuilder queryBuilder, Options options) {
if(SortBy.RELEVANCE.equals(options.sortBy())) {
queryBuilder.withQuery(
builder -> builder.functionScore(
scoreQuery -> scoreQuery.query(
sortQueryBuilder -> sortQueryBuilder.bool(boolQuery -> createSearchQuery(boolQuery, options))
).functions(
functionBuilder -> functionBuilder.fieldValueFactor(factor -> factor.field("relevance").factor(1.0))
)
)
);
} else {
queryBuilder.withQuery(builder -> builder.bool(boolQuery -> createSearchQuery(boolQuery, options)));
}
}

private void sortResults(NativeQueryBuilder queryBuilder, String sortOrder, String sortBy) {
sortOrder = sortOrder.toLowerCase();
var orders = Map.of("asc", SortOrder.Asc, "desc", SortOrder.Desc);
Expand All @@ -373,7 +389,7 @@ private void sortResults(NativeQueryBuilder queryBuilder, String sortOrder, Stri

var scoreSort = new SortOptions.Builder().score(builder -> builder.order(order)).build();
var fieldSort = new SortOptions.Builder().field(builder -> builder.field(sortBy).unmappedType(type).order(order)).build();
var sortOptions = sortBy.equals(SortBy.RELEVANCE) ? List.of(scoreSort, fieldSort) : List.of(fieldSort, scoreSort);
var sortOptions = sortBy.equals(SortBy.RELEVANCE) ? List.of(scoreSort) : List.of(fieldSort, scoreSort);
queryBuilder.withSort(sortOptions);
}

Expand Down
17 changes: 2 additions & 15 deletions server/src/main/java/org/eclipse/openvsx/search/RelevanceService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,7 @@ private double calculateRating(Extension extension, SearchStats stats) {
private double calculateRelevance(Extension extension, ExtensionVersion latest, SearchStats stats, ExtensionSearch entry) {
var extensionId = NamingUtil.toExtensionId(extension);
logger.debug(">> [{}] CALCULATE RELEVANCE", extensionId);
var ratingValue = 0.0;
if (extension.getAverageRating() != null) {
logger.debug("[{}] INCLUDE AVG RATING", extensionId);
var reviewCount = extension.getReviewCount();
// Reduce the rating relevance if there are only few reviews
var countRelevance = saturate(reviewCount, 0.25);
ratingValue = (extension.getAverageRating() / 5.0) * countRelevance;
logger.debug("[{}] {} = {} * {} | {}", extensionId, ratingValue, extension.getAverageRating() / 5.0, countRelevance, reviewCount);
}
var ratingValue = calculateRating(extension, stats) / 5.0;
var downloadsValue = entry.getDownloadCount() / stats.downloadRef;
var timestamp = latest.getTimestamp();
var timestampValue = Duration.between(stats.oldest, timestamp).toSeconds() / stats.timestampRef;
Expand Down Expand Up @@ -127,10 +119,6 @@ else if (value > 1.0)
return value;
}

private double saturate(double value, double factor) {
return 1 - 1.0 / (value * factor + 1);
}

private boolean isVerified(ExtensionVersion extVersion) {
if (extVersion.getPublishedWith() == null)
return false;
Expand All @@ -147,9 +135,8 @@ public static class SearchStats {

public SearchStats(RepositoryService repositories) {
var now = TimeUtil.getCurrentUTC();
var maxDownloads = repositories.getMaxExtensionDownloadCount();
var oldestTimestamp = repositories.getOldestExtensionTimestamp();
this.downloadRef = maxDownloads * 1.5 + 100;
this.downloadRef = Math.max(repositories.getMaxExtensionDownloadCount(), 1);
this.oldest = oldestTimestamp == null ? now : oldestTimestamp;
this.timestampRef = Duration.between(this.oldest, now).toSeconds() + 60;
this.averageReviewRating = repositories.getAverageReviewRating();
Expand Down
4 changes: 4 additions & 0 deletions server/src/test/java/org/eclipse/openvsx/search/DatabaseSearchServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ void testRelevance() {
var ext2 = mockExtension("java", 4.0, 100, 10000, "redhat", List.of("Snippets", "Programming Languages"));
var ext3 = mockExtension("openshift", 1.0, 100, 10, "redhat", List.of("Snippets", "Other"));
Mockito.when(repositories.findAllActiveExtensions()).thenReturn(Streamable.of(List.of(ext1, ext2, ext3)));
Mockito.when(repositories.getMaxExtensionDownloadCount()).thenReturn(10000);
Mockito.when(repositories.getAverageReviewRating()).thenReturn(3.96735905);

var searchOptions = searchOptions(null, null, 50, 0, null, SortBy.RELEVANCE);
var result = search.search(searchOptions);
Expand All @@ -79,6 +81,8 @@ void testReverse() {
var ext1 = mockExtension("yaml", 3.0, 100, 0, "redhat", List.of("Snippets", "Programming Languages"));
var ext2 = mockExtension("java", 4.0, 100, 0, "redhat", List.of("Snippets", "Programming Languages"));
Mockito.when(repositories.findAllActiveExtensions()).thenReturn(Streamable.of(List.of(ext1, ext2)));
Mockito.when(repositories.getMaxExtensionDownloadCount()).thenReturn(0);
Mockito.when(repositories.getAverageReviewRating()).thenReturn(3.5);

var searchOptions = searchOptions(null, "Programming Languages", 50, 0, "desc", null);
var result = search.search(searchOptions);
Expand Down