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.core.proposal.indexed
21 
22 import cats.data.NonEmptyList
23 import com.github.plokhotnyuk.jsoniter_scala.core._
24 import com.github.plokhotnyuk.jsoniter_scala.macros._
25 import enumeratum.values.{StringCirceEnum, StringEnum, StringEnumEntry}
26 import eu.timepit.refined.api.Refined
27 import eu.timepit.refined.collection.NonEmpty
28 import io.circe.generic.semiauto._
29 import io.circe.{Codec, Decoder, Encoder}
30 import io.circe.refined._
31 import io.swagger.annotations.{ApiModel, ApiModelProperty}
32 import org.make.api.proposal.ProposalScorer
33 import org.make.core.elasticsearch.ElasticsearchFieldName
34 import org.make.core.idea.IdeaId
35 import org.make.core.jsoniter.{JsoniterCodecs, JsoniterEnum}
36 import org.make.core.operation.{OperationId, OperationKind}
37 import org.make.core.proposal._
38 import org.make.core.{CirceFormatters, RequestContext}
39 import org.make.core.question.QuestionId
40 import org.make.core.reference.{Country, Language}
41 import org.make.core.sequence.ExplorationSequenceConfiguration.SequenceThresholds
42 import org.make.core.tag.TagId
43 import org.make.core.technical.Multilingual
44 import org.make.core.user.{UserId, UserType}
45 
46 import java.time.ZonedDateTime
47 import scala.annotation.meta.field
48 
49 sealed abstract class ProposalElasticsearchFieldName(val value: String, val sortable: Boolean = false)
50     extends ElasticsearchFieldName
51 
52 object ProposalElasticsearchFieldName extends StringEnum[ProposalElasticsearchFieldName] {
53 
54   sealed abstract class Simple(val field: String, override val sortable: Boolean = false)
55       extends ProposalElasticsearchFieldName(field, sortable) {
56     override def parameter: String = field
57   }
58 
59   sealed abstract class Alias(
60     val parameter: String,
61     aliased: ProposalElasticsearchFieldName,
62     override val sortable: Boolean = false
63   ) extends ProposalElasticsearchFieldName(parameter, sortable) {
64     override def field: String = aliased.field
65   }
66 
67   case object id extends Simple("id")
68 
69   case object agreementRate extends Simple("agreementRate", sortable = true)
70   case object authorUserId extends Simple("author.userId")
71   case object authorAge extends Simple("author.age")
72   case object authorFirstName extends Simple("author.firstName")
73   case object authorPostalCode extends Simple("author.postalCode")
74   case object authorUserType extends Simple("author.userType")
75   case object authorAvatarUrl extends Simple("author.avatarUrl")
76   case object content extends Simple("contentGeneral")
77   case object contentBg extends Simple("content.bg.standard")
78   case object contentBgStemmed extends Simple("content.bg.stemmed")
79   case object contentCs extends Simple("content.cs.standard")
80   case object contentCsStemmed extends Simple("content.cs.stemmed")
81   case object contentDa extends Simple("content.da.standard")
82   case object contentDaStemmed extends Simple("content.da.stemmed")
83   case object contentDe extends Simple("content.de.standard")
84   case object contentDeStemmed extends Simple("content.de.stemmed")
85   case object contentEl extends Simple("content.el.standard")
86   case object contentElStemmed extends Simple("content.el.stemmed")
87   case object contentEn extends Simple("content.en.standard")
88   case object contentEnStemmed extends Simple("content.en.stemmed")
89   case object contentEs extends Simple("content.es.standard")
90   case object contentEsStemmed extends Simple("content.es.stemmed")
91   case object contentEt extends Simple("content.et.standard")
92   case object contentFi extends Simple("content.fi.standard")
93   case object contentFiStemmed extends Simple("content.fi.stemmed")
94   case object contentFr extends Simple("content.fr.standard")
95   case object contentFrStemmed extends Simple("content.fr.stemmed")
96   case object contentHr extends Simple("content.hr.standard")
97   case object contentHu extends Simple("content.hu.standard")
98   case object contentHuStemmed extends Simple("content.hu.stemmed")
99   case object contentIt extends Simple("content.it.standard")
100   case object contentItStemmed extends Simple("content.it.stemmed")
101   case object contentLt extends Simple("content.lt.standard")
102   case object contentLtStemmed extends Simple("content.lt.stemmed")
103   case object contentLv extends Simple("content.lv.standard")
104   case object contentLvStemmed extends Simple("content.lv.stemmed")
105   case object contentMt extends Simple("content.mt.standard")
106   case object contentNl extends Simple("content.nl.standard")
107   case object contentNlStemmed extends Simple("content.nl.stemmed")
108   case object contentPl extends Simple("content.pl.standard")
109   case object contentPlStemmed extends Simple("content.pl.stemmed")
110   case object contentPt extends Simple("content.pt.standard")
111   case object contentPtStemmed extends Simple("content.pt.stemmed")
112   case object contentRo extends Simple("content.ro.standard")
113   case object contentRoStemmed extends Simple("content.ro.stemmed")
114   case object contentSk extends Simple("content.sk.standard")
115   case object contentSl extends Simple("content.sl.standard")
116   case object contentUk extends Simple("content.uk.standard")
117   case object contentSv extends Simple("content.sv.standard")
118   case object contentSvStemmed extends Simple("content.sv.stemmed")
119   case object contentKeyword extends Simple("contentKeyword", sortable = true)
120   case object contextCountry extends Simple("context.country")
121   case object contextLocation extends Simple("context.location")
122   case object contextOperation extends Simple("context.operation")
123   case object contextQuestionSlug extends Simple("context.questionSlug")
124   case object contextSource extends Simple("context.source")
125   case object controversyLowerBound extends Simple("scores.controversy.lowerBound")
126   case object controversyLowerBoundLegacy extends Alias("scores.controversyLowerBound", controversyLowerBound)
127   case object country extends Alias("country", contextCountry, sortable = true)
128   case object createdAt extends Simple("createdAt", sortable = true)
129   case object ideaId extends Simple("ideaId")
130   case object initialProposal extends Simple("initialProposal")
131   case object language extends Simple("submittedAsLanguage", sortable = true)
132   case object operationId extends Simple("operationId")
133   case object operationKind extends Simple("operationKind")
134   case object organisationId extends Simple("organisations.organisationId")
135   case object organisationName extends Simple("organisations.organisationName")
136   case object organisations extends Simple("organisations")
137   case object proposalType extends Simple("proposalType")
138   case object questionCountries extends Simple("question.countries", sortable = true)
139   case object questionId extends Simple("question.questionId")
140   case object questionIsOpen extends Simple("question.isOpen")
141   case object questionLanguages extends Simple("question.languages", sortable = true)
142   case object refusalReason extends Simple("refusalReason")
143   case object scores extends Simple("scores")
144   case object scoreAgreement extends Simple("scores.agreement.lowerBound")
145   case object scoreAgreementLegacy extends Alias("scores.agreement", scoreAgreement)
146   case object scoreRealistic extends Simple("scores.realistic.lowerBound")
147   case object scoreRealisticLegacy extends Alias("scores.realistic", scoreRealistic)
148   case object scoreUpperBound extends Simple("scores.topScore.upperBound")
149   case object scoreUpperBoundLegacy extends Alias("scores.scoreUpperBound", scoreUpperBound)
150   case object scoreLowerBound extends Simple("scores.topScore.lowerBound")
151   case object scoreLowerBoundLegacy extends Alias("scores.scoreLowerBound", scoreLowerBound)
152   case object segment extends Simple("segment")
153   case object sequenceSegmentPool extends Simple("sequenceSegmentPool")
154   case object sequencePool extends Simple("sequencePool")
155   case object slug extends Simple("slug", sortable = true)
156   case object status extends Simple("status")
157   case object tagId extends Simple("tags.tagId")
158   case object tags extends Simple("tags")
159   case object selectedStakeTagId extends Simple("selectedStakeTag.tagId")
160   case object toEnrich extends Simple("toEnrich")
161   case object isAnonymous extends Simple("isAnonymous")
162   case object topScore extends Simple("scores.topScore.score")
163   case object topScoreLegacy extends Alias("scores.topScore", topScore)
164   case object topScoreAjustedWithVotesLegacy
165       extends Alias("scores.topScoreAjustedWithVotes", scoreLowerBound, sortable = true)
166   case object trending extends Simple("trending", sortable = true)
167   case object updatedAt extends Simple("updatedAt", sortable = true)
168   case object votesCount extends Simple("votesCount")
169   case object zone extends Simple("scores.zone")
170   case object segmentZone extends Simple("segmentScores.zone")
171   case object keywordKey extends Simple("keywords.key")
172 
173   override val values: IndexedSeq[ProposalElasticsearchFieldName] = findValues
174   final val swaggerAllowableValues =
175     "agreementRate,content.keyword,createdAt,country,language,labels,question.countries,question.language,slug,scores.topScoreAjustedWithVotes,trending,updatedAt,submittedAsLanguage"
176 }
177 
178 final case class IndexedProposal(
179   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
180   id: ProposalId,
181   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
182   submittedAsLanguage: Option[Language],
183   content: Multilingual[String],
184   contentGeneral: String,
185   contentKeyword: String,
186   slug: String,
187   @(ApiModelProperty @field)(
188     dataType = "string",
189     required = true,
190     allowableValues = ProposalStatus.swaggerAllowableValues
191   )
192   status: ProposalStatus,
193   createdAt: ZonedDateTime,
194   updatedAt: Option[ZonedDateTime],
195   validatedAt: Option[ZonedDateTime],
196   postponedAt: Option[ZonedDateTime],
197   votes: VotingOptions,
198   votesCount: Int,
199   votesVerifiedCount: Int,
200   votesSequenceCount: Int,
201   votesSegmentCount: Int,
202   toEnrich: Boolean,
203   scores: IndexedScores,
204   segmentScores: IndexedScores,
205   agreementRate: Double,
206   context: Option[IndexedContext],
207   isAnonymous: Boolean,
208   author: IndexedAuthor,
209   organisations: Seq[IndexedOrganisationInfo],
210   question: Option[IndexedProposalQuestion],
211   tags: Seq[IndexedTag],
212   selectedStakeTag: Option[IndexedTag],
213   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
214   ideaId: Option[IdeaId],
215   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
216   operationId: Option[OperationId],
217   @(ApiModelProperty @field)(
218     dataType = "string",
219     required = true,
220     allowableValues = SequencePool.swaggerAllowableValues
221   )
222   sequencePool: SequencePool,
223   @(ApiModelProperty @field)(
224     dataType = "string",
225     required = true,
226     allowableValues = SequencePool.swaggerAllowableValues
227   )
228   sequenceSegmentPool: SequencePool,
229   initialProposal: Boolean,
230   proposalType: ProposalType,
231   refusalReason: Option[String],
232   @(ApiModelProperty @field)(dataType = "string", allowableValues = OperationKind.swaggerAllowableValues)
233   operationKind: Option[OperationKind],
234   segment: Option[String],
235   keywords: Seq[IndexedProposalKeyword]
236 )
237 
238 object IndexedProposal extends CirceFormatters with JsoniterCodecs {
239 
240   implicit val sprayCodec: JsonValueCodec[IndexedProposal] =
241     JsonCodecMaker.makeWithRequiredCollectionFields
242 
243   implicit val codec: Codec[IndexedProposal] = deriveCodec
244 }
245 
246 final case class IndexedProposalQuestion(
247   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
248   questionId: QuestionId,
249   slug: String,
250   titles: Multilingual[String],
251   questions: Multilingual[String Refined NonEmpty],
252   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
253   countries: NonEmptyList[Country],
254   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
255   languages: NonEmptyList[Language],
256   startDate: ZonedDateTime,
257   endDate: ZonedDateTime,
258   isOpen: Boolean
259 )
260 
261 object IndexedProposalQuestion extends CirceFormatters with JsoniterCodecs {
262 
263   implicit val indexedProposalQuestionCodec: JsonValueCodec[IndexedProposalQuestion] =
264     JsonCodecMaker.makeWithRequiredCollectionFields
265 
266   implicit val circeCodec: Codec[IndexedProposalQuestion] = deriveCodec
267 }
268 
269 @ApiModel
270 final case class IndexedContext(
271   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
272   operation: Option[OperationId],
273   source: Option[String],
274   location: Option[String],
275   questionSlug: Option[String],
276   @(ApiModelProperty @field)(dataType = "string", example = "FR")
277   country: Option[Country],
278   @(ApiModelProperty @field)(dataType = "string", example = "fr")
279   questionLanguage: Option[Language],
280   proposalLanguage: Option[Language],
281   clientLanguage: Option[Language],
282   getParameters: Seq[IndexedGetParameters]
283 )
284 
285 object IndexedContext {
286 
287   def apply(context: RequestContext, isBeforeContextSourceFeature: Boolean = false): IndexedContext =
288     IndexedContext(
289       operation = context.operationId,
290       source = context.source.filter(_.nonEmpty) match {
291         case None if isBeforeContextSourceFeature => Some("core")
292         case other                                => other
293       },
294       location = context.location,
295       questionSlug = context.questionContext.questionSlug,
296       country = context.country,
297       questionLanguage = context.languageContext.questionLanguage,
298       proposalLanguage = context.languageContext.proposalLanguage,
299       clientLanguage = context.languageContext.clientLanguage,
300       getParameters = context.getParameters
301         .map(_.toSeq.map {
302           case (key, value) => IndexedGetParameters(key, value)
303         })
304         .getOrElse(Seq.empty)
305     )
306 
307   implicit val codec: JsonValueCodec[IndexedContext] =
308     JsonCodecMaker.makeWithRequiredCollectionFields
309 
310   implicit val circeCodec: Codec[IndexedContext] = deriveCodec
311 }
312 
313 final case class IndexedGetParameters(key: String, value: String)
314 
315 object IndexedGetParameters {
316   implicit val codec: JsonValueCodec[IndexedGetParameters] =
317     JsonCodecMaker.makeWithRequiredCollectionFields
318 
319   implicit val encoder: Encoder[IndexedGetParameters] = deriveEncoder[IndexedGetParameters]
320   implicit val decoder: Decoder[IndexedGetParameters] = deriveDecoder[IndexedGetParameters]
321 }
322 
323 final case class IndexedAuthor(
324   userId: UserId,
325   firstName: Option[String],
326   displayName: Option[String],
327   organisationName: Option[String],
328   organisationSlug: Option[String],
329   postalCode: Option[String],
330   @(ApiModelProperty @field)(example = "21", dataType = "int")
331   age: Option[Int],
332   avatarUrl: Option[String],
333   @(ApiModelProperty @field)(dataType = "string", required = true, allowableValues = UserType.swaggerAllowableValues)
334   userType: UserType,
335   profession: Option[String]
336 )
337 
338 object IndexedAuthor {
339   implicit val codec: JsonValueCodec[IndexedAuthor] =
340     JsonCodecMaker.makeWithRequiredCollectionFields
341 
342   implicit val circeCodec: Codec[IndexedAuthor] = deriveCodec
343 }
344 
345 @ApiModel
346 final case class IndexedOrganisationInfo(
347   @(ApiModelProperty)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
348   organisationId: UserId,
349   organisationName: Option[String],
350   organisationSlug: Option[String]
351 )
352 
353 object IndexedOrganisationInfo {
354   implicit val codec: JsonValueCodec[IndexedOrganisationInfo] =
355     JsonCodecMaker.makeWithRequiredCollectionFields
356 
357   implicit val encoder: Encoder[IndexedOrganisationInfo] = deriveEncoder[IndexedOrganisationInfo]
358   implicit val decoder: Decoder[IndexedOrganisationInfo] = deriveDecoder[IndexedOrganisationInfo]
359 }
360 
361 sealed abstract class Zone(val value: String) extends StringEnumEntry
362 
363 object Zone extends StringEnum[Zone] with StringCirceEnum[Zone] with JsoniterEnum[Zone] {
364 
365   final case object Consensus extends Zone("consensus")
366   final case object Rejection extends Zone("rejection")
367   final case object Limbo extends Zone("limbo")
368   final case object Controversy extends Zone("controversy")
369 
370   override def values: IndexedSeq[Zone] = findValues
371   final val swaggerAllowableValues = "consensus,rejection,limbo,controversy"
372 }
373 
374 final case class IndexedScores(
375   engagement: IndexedScore,
376   agreement: IndexedScore,
377   adhesion: IndexedScore,
378   realistic: IndexedScore,
379   platitude: IndexedScore,
380   topScore: IndexedScore,
381   controversy: IndexedScore,
382   rejection: IndexedScore,
383   @(ApiModelProperty @field)(dataType = "string", allowableValues = Zone.swaggerAllowableValues)
384   zone: Zone
385 )
386 
387 object IndexedScores {
388   implicit val codec: JsonValueCodec[IndexedScores] =
389     JsonCodecMaker.makeWithRequiredCollectionFields
390 
391   implicit val encoder: Encoder[IndexedScores] = deriveEncoder[IndexedScores]
392   implicit val decoder: Decoder[IndexedScores] = deriveDecoder[IndexedScores]
393 
394   def empty: IndexedScores =
395     IndexedScores(
396       IndexedScore.empty,
397       IndexedScore.empty,
398       IndexedScore.empty,
399       IndexedScore.empty,
400       IndexedScore.empty,
401       IndexedScore.empty,
402       IndexedScore.empty,
403       IndexedScore.empty,
404       Zone.Limbo
405     )
406 
407   def apply(scorer: ProposalScorer, threshold: SequenceThresholds): IndexedScores =
408     IndexedScores(
409       engagement = IndexedScore(scorer.engagement),
410       agreement = IndexedScore(scorer.agree),
411       adhesion = IndexedScore(scorer.adhesion),
412       realistic = IndexedScore(scorer.realistic),
413       platitude = IndexedScore(scorer.platitude),
414       topScore = IndexedScore(scorer.topScore),
415       controversy = IndexedScore(scorer.controversy),
416       rejection = IndexedScore(scorer.rejection),
417       zone = scorer.zone(threshold)
418     )
419 
420 }
421 
422 final case class IndexedScore(score: Double, lowerBound: Double, upperBound: Double)
423 
424 object IndexedScore {
425   implicit val indexedScoreCodec: JsonValueCodec[IndexedScore] =
426     JsonCodecMaker.makeWithRequiredCollectionFields
427   implicit val codec: Codec[IndexedScore] = deriveCodec
428   val empty: IndexedScore = IndexedScore(0, 0, 0)
429 
430   def apply(score: ProposalScorer.Score): IndexedScore =
431     IndexedScore(score = score.score, lowerBound = score.lowerBound, upperBound = score.upperBound)
432 }
433 
434 final case class ProposalsSearchResult(total: Long, results: Seq[IndexedProposal])
435 
436 object ProposalsSearchResult {
437   implicit val codec: JsonValueCodec[ProposalsSearchResult] =
438     JsonCodecMaker.makeWithRequiredCollectionFields
439 
440   implicit val circeCodec: Codec[ProposalsSearchResult] = deriveCodec
441 
442   def empty: ProposalsSearchResult = ProposalsSearchResult(0, Seq.empty)
443 }
444 
445 @ApiModel
446 final case class IndexedTag(
447   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
448   tagId: TagId,
449   label: String,
450   display: Boolean
451 )
452 
453 object IndexedTag {
454   implicit val codec: JsonValueCodec[IndexedTag] =
455     JsonCodecMaker.makeWithRequiredCollectionFields
456 
457   implicit val circeCodec: Codec[IndexedTag] = deriveCodec
458 }
459 
460 sealed abstract class SequencePool(val value: String) extends StringEnumEntry
461 
462 object SequencePool
463     extends StringEnum[SequencePool]
464     with StringCirceEnum[SequencePool]
465     with JsoniterEnum[SequencePool] {
466 
467   case object New extends SequencePool("new")
468   case object Tested extends SequencePool("tested")
469   case object Excluded extends SequencePool("excluded")
470 
471   override def values: IndexedSeq[SequencePool] = findValues
472   final val swaggerAllowableValues = "new,tested,excluded"
473 }
474 
475 final case class IndexedProposalKeyword(
476   @(ApiModelProperty @field)(dataType = "string", required = true)
477   key: ProposalKeywordKey,
478   label: String
479 )
480 
481 object IndexedProposalKeyword {
482   implicit val codec: Codec[IndexedProposalKeyword] = deriveCodec[IndexedProposalKeyword]
483 
484   def apply(keyword: ProposalKeyword): IndexedProposalKeyword = {
485     IndexedProposalKeyword(keyword.key, keyword.label)
486   }
487 }