1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.api.idea
21 
22 import akka.Done
23 import cats.implicits._
24 import com.sksamuel.elastic4s.Index
25 import com.sksamuel.elastic4s.circe._
26 import com.sksamuel.elastic4s.ElasticDsl._
27 import com.sksamuel.elastic4s.requests.common.RefreshPolicy
28 import com.sksamuel.elastic4s.requests.searches.SearchRequest
29 import com.sksamuel.elastic4s.requests.searches.queries.compound.BoolQuery
30 import grizzled.slf4j.Logging
31 import io.circe.{Json, Printer}
32 import org.make.api.technical.elasticsearch._
33 import org.make.core.CirceFormatters
34 import org.make.core.idea.indexed.{IdeaSearchResult, IndexedIdea}
35 import org.make.core.idea._
36 
37 import scala.concurrent.ExecutionContext.Implicits.global
38 import scala.concurrent.Future
39 
40 trait IdeaSearchEngineComponent {
41   def elasticsearchIdeaAPI: IdeaSearchEngine
42 }
43 
44 trait IdeaSearchEngine {
45   def findIdeaById(ideaId: IdeaId): Future[Option[IndexedIdea]]
46   def searchIdeas(query: IdeaSearchQuery): Future[IdeaSearchResult]
47   def indexIdea(record: IndexedIdea, mayBeIndex: Option[Index] = None): Future[Done]
48   def indexIdeas(records: Seq[IndexedIdea], mayBeIndex: Option[Index] = None): Future[Done]
49   def updateIdea(record: IndexedIdea, mayBeIndex: Option[Index] = None): Future[Done]
50 }
51 
52 object IdeaSearchEngine {
53   val ideaIndexName: String = "idea"
54 }
55 
56 trait DefaultIdeaSearchEngineComponent extends IdeaSearchEngineComponent with CirceFormatters {
57   self: ElasticsearchConfigurationComponent with ElasticsearchClientComponent =>
58 
59   override lazy val elasticsearchIdeaAPI: IdeaSearchEngine = new DefaultIdeaSearchEngine
60 
61   class DefaultIdeaSearchEngine extends IdeaSearchEngine with Logging {
62 
63     private lazy val client = elasticsearchClient.client
64 
65     private val ideaAlias: Index = elasticsearchConfiguration.ideaAliasName
66 
67     // TODO remove once elastic4s-circe upgrades to circe 0.14
68     private implicit val printer: Json => String = Printer.noSpaces.print
69 
70     override def findIdeaById(ideaId: IdeaId): Future[Option[IndexedIdea]] = {
71       client
72         .executeAsFuture(get(ideaAlias, ideaId.value))
73         .map(_.toOpt[IndexedIdea])
74     }
75 
76     override def searchIdeas(ideaSearchQuery: IdeaSearchQuery): Future[IdeaSearchResult] = {
77       // parse json string to build search query
78       val searchFilters = IdeaSearchFilters.getIdeaSearchFilters(ideaSearchQuery)
79       val request: SearchRequest = search(ideaAlias)
80         .bool(BoolQuery(must = searchFilters))
81         .sortBy(IdeaSearchFilters.getSort(ideaSearchQuery).toList)
82         .size(IdeaSearchFilters.getLimitSearch(ideaSearchQuery))
83         .from(IdeaSearchFilters.getSkipSearch(ideaSearchQuery))
84         .trackTotalHits(true)
85 
86       client
87         .executeAsFuture(request)
88         .map(response => IdeaSearchResult(total = response.totalHits, results = response.to[IndexedIdea]))
89     }
90 
91     override def indexIdea(record: IndexedIdea, maybeIndex: Option[Index] = None): Future[Done] = {
92       val index = maybeIndex.getOrElse(ideaAlias)
93       client
94         .executeAsFuture(indexInto(index).doc(record).refresh(RefreshPolicy.IMMEDIATE).id(record.ideaId.value))
95         .as(Done)
96     }
97 
98     override def indexIdeas(records: Seq[IndexedIdea], maybeIndex: Option[Index] = None): Future[Done] = {
99       val index = maybeIndex.getOrElse(ideaAlias)
100       client
101         .executeAsFuture(bulk(records.map { record =>
102           indexInto(index).doc(record).refresh(RefreshPolicy.IMMEDIATE).id(record.ideaId.value)
103         }))
104         .as(Done)
105     }
106 
107     override def updateIdea(record: IndexedIdea, maybeIndex: Option[Index] = None): Future[Done] = {
108       val index = maybeIndex.getOrElse(ideaAlias)
109       client
110         .executeAsFuture(
111           updateById(index, record.ideaId.value)
112             .doc(record)
113             .refresh(RefreshPolicy.IMMEDIATE)
114         )
115         .as(Done)
116     }
117   }
118 }