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.post
21 
22 import com.sksamuel.elastic4s.Index
23 import com.sksamuel.elastic4s.circe._
24 import com.sksamuel.elastic4s.ElasticDsl._
25 import com.sksamuel.elastic4s.requests.common.RefreshPolicy
26 import com.sksamuel.elastic4s.requests.searches.SearchRequest
27 import com.sksamuel.elastic4s.requests.searches.queries.compound.BoolQuery
28 import grizzled.slf4j.Logging
29 import io.circe.{Json, Printer}
30 import org.make.api.technical.elasticsearch._
31 import org.make.core.CirceFormatters
32 import org.make.core.elasticsearch.IndexationStatus
33 import org.make.core.post.PostId
34 import org.make.core.post.indexed._
35 
36 import scala.concurrent.ExecutionContext.Implicits.global
37 import scala.concurrent.Future
38 
39 trait PostSearchEngineComponent {
40   def elasticsearchPostAPI: PostSearchEngine
41 }
42 
43 trait PostSearchEngine {
44   def findPostById(postId: PostId): Future[Option[IndexedPost]]
45   def searchPosts(query: PostSearchQuery): Future[PostSearchResult]
46   def indexPosts(records: Seq[IndexedPost], maybeIndex: Option[Index]): Future[IndexationStatus]
47 }
48 
49 object PostSearchEngine {
50   val postIndexName: String = "post"
51 }
52 
53 trait DefaultPostSearchEngineComponent extends PostSearchEngineComponent with CirceFormatters with Logging {
54   self: ElasticsearchConfigurationComponent with ElasticsearchClientComponent =>
55 
56   override lazy val elasticsearchPostAPI: PostSearchEngine =
57     new DefaultPostSearchEngine
58 
59   class DefaultPostSearchEngine extends PostSearchEngine {
60 
61     private lazy val client = elasticsearchClient.client
62 
63     private val postAlias: Index = elasticsearchConfiguration.postAliasName
64 
65     // TODO remove once elastic4s-circe upgrades to circe 0.14
66     private implicit val printer: Json => String = Printer.noSpaces.print
67 
68     override def findPostById(postId: PostId): Future[Option[IndexedPost]] = {
69       client
70         .executeAsFuture(get(postAlias, postId.value))
71         .map(_.toOpt[IndexedPost])
72     }
73 
74     override def searchPosts(query: PostSearchQuery): Future[PostSearchResult] = {
75       val searchFilters = PostSearchFilters.getPostSearchFilters(query)
76       val request: SearchRequest =
77         search(postAlias)
78           .bool(BoolQuery(must = searchFilters))
79           .sortBy(PostSearchFilters.getSort(query).toList)
80           .size(PostSearchFilters.getLimitSearch(query))
81           .from(PostSearchFilters.getOffsetSearch(query))
82           .trackTotalHits(true)
83 
84       client
85         .executeAsFuture(request)
86         .map { response =>
87           PostSearchResult(total = response.totalHits, results = response.to[IndexedPost])
88         }
89     }
90 
91     override def indexPosts(records: Seq[IndexedPost], maybeIndex: Option[Index]): Future[IndexationStatus] = {
92       val index = maybeIndex.getOrElse(postAlias)
93       client
94         .executeAsFuture(bulk(records.map { record =>
95           indexInto(index).doc(record).refresh(RefreshPolicy.IMMEDIATE).id(record.postId.value)
96         }))
97         .map(_ => IndexationStatus.Completed)
98         .recover {
99           case e: Exception =>
100             logger.error(s"Indexing ${records.size} posts failed", e)
101             IndexationStatus.Failed(e)
102         }
103     }
104   }
105 }