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.organisation
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.technical.Pagination
35 import org.make.core.user.indexed.{IndexedOrganisation, OrganisationSearchResult}
36 import org.make.core.user.{OrganisationSearchFilters, OrganisationSearchQuery, SlugSearchFilter, UserId}
37 
38 import scala.concurrent.ExecutionContext.Implicits.global
39 import scala.concurrent.Future
40 
41 trait OrganisationSearchEngineComponent {
42   def elasticsearchOrganisationAPI: OrganisationSearchEngine
43 }
44 
45 trait OrganisationSearchEngine {
46   def findOrganisationById(organisationId: UserId): Future[Option[IndexedOrganisation]]
47   def findOrganisationBySlug(slug: String): Future[Option[IndexedOrganisation]]
48   def searchOrganisations(query: OrganisationSearchQuery): Future[OrganisationSearchResult]
49   def indexOrganisation(record: IndexedOrganisation, mayBeIndex: Option[Index] = None): Future[Done]
50   def indexOrganisations(records: Seq[IndexedOrganisation], mayBeIndex: Option[Index] = None): Future[Done]
51   def updateOrganisation(record: IndexedOrganisation, mayBeIndex: Option[Index] = None): Future[Done]
52 }
53 
54 object OrganisationSearchEngine {
55   val organisationIndexName: String = "organisation"
56 }
57 
58 trait DefaultOrganisationSearchEngineComponent extends OrganisationSearchEngineComponent with CirceFormatters {
59   self: ElasticsearchConfigurationComponent with ElasticsearchClientComponent =>
60 
61   override lazy val elasticsearchOrganisationAPI: OrganisationSearchEngine = new DefaultOrganisationSearchEngine
62 
63   class DefaultOrganisationSearchEngine extends OrganisationSearchEngine with Logging {
64 
65     private lazy val client = elasticsearchClient.client
66 
67     private val organisationAlias: Index =
68       elasticsearchConfiguration.organisationAliasName
69 
70     // TODO remove once elastic4s-circe upgrades to circe 0.14
71     private implicit val printer: Json => String = Printer.noSpaces.print
72 
73     override def findOrganisationById(organisationId: UserId): Future[Option[IndexedOrganisation]] = {
74       client
75         .executeAsFuture(get(organisationAlias, organisationId.value))
76         .map(_.toOpt[IndexedOrganisation])
77     }
78 
79     override def findOrganisationBySlug(slug: String): Future[Option[IndexedOrganisation]] = {
80       val query = OrganisationSearchQuery(
81         filters = OrganisationSearchFilters.parse(slug = Some(SlugSearchFilter(slug))),
82         limit = Some(Pagination.Limit(1))
83       )
84       val searchFilters = OrganisationSearchFilters.getOrganisationSearchFilters(query)
85       val request = search(organisationAlias)
86         .bool(BoolQuery(must = searchFilters))
87         .from(0)
88         .size(1)
89         .trackTotalHits(true)
90 
91       client.executeAsFuture {
92         request
93       }.map(_.to[IndexedOrganisation]).map(_.headOption)
94     }
95 
96     override def searchOrganisations(query: OrganisationSearchQuery): Future[OrganisationSearchResult] = {
97       val searchFilters = OrganisationSearchFilters.getOrganisationSearchFilters(query)
98       val request: SearchRequest = search(organisationAlias)
99         .bool(BoolQuery(must = searchFilters))
100         .sortBy(OrganisationSearchFilters.getSort(query).toList)
101         .size(OrganisationSearchFilters.getLimitSearch(query))
102         .from(OrganisationSearchFilters.getSkipSearch(query))
103         .trackTotalHits(true)
104 
105       val requestSorted = query.sortAlgorithm match {
106         case None                => request
107         case Some(sortAlgorithm) => sortAlgorithm.sortDefinition(request)
108       }
109 
110       client
111         .executeAsFuture(requestSorted)
112         .map { response =>
113           OrganisationSearchResult(total = response.totalHits, results = response.to[IndexedOrganisation])
114         }
115     }
116 
117     override def indexOrganisation(record: IndexedOrganisation, mayBeIndex: Option[Index]): Future[Done] = {
118       val index = mayBeIndex.getOrElse(organisationAlias)
119       client
120         .executeAsFuture(indexInto(index).doc(record).refresh(RefreshPolicy.IMMEDIATE).id(record.organisationId.value))
121         .as(Done)
122     }
123 
124     override def indexOrganisations(records: Seq[IndexedOrganisation], mayBeIndex: Option[Index]): Future[Done] = {
125       val index = mayBeIndex.getOrElse(organisationAlias)
126       client
127         .executeAsFuture(bulk(records.map { record =>
128           indexInto(index).doc(record).refresh(RefreshPolicy.IMMEDIATE).id(record.organisationId.value)
129         }))
130         .as(Done)
131     }
132 
133     override def updateOrganisation(record: IndexedOrganisation, mayBeIndex: Option[Index]): Future[Done] = {
134       val index = mayBeIndex.getOrElse(organisationAlias)
135       client
136         .executeAsFuture(
137           updateById(index, record.organisationId.value)
138             .doc(record)
139             .refresh(RefreshPolicy.IMMEDIATE)
140         )
141         .as(Done)
142     }
143 
144   }
145 }