the-algorithm/product-mixer/component-library/src/main/scala/com/twitter/product_mixer/component_library/filter/TweetAuthorCountryFilter.scala
twitter-team ef4c5eb65e Twitter Recommendation Algorithm
Please note we have force-pushed a new initial commit in order to remove some publicly-available Twitter user information. Note that this process may be required in the future.
2023-03-31 17:36:31 -05:00

48 lines
1.7 KiB
Scala

package com.twitter.product_mixer.component_library.filter
import com.twitter.product_mixer.component_library.model.candidate.BaseTweetCandidate
import com.twitter.product_mixer.core.feature.Feature
import com.twitter.product_mixer.core.functional_component.filter.Filter
import com.twitter.product_mixer.core.functional_component.filter.FilterResult
import com.twitter.product_mixer.core.model.common.CandidateWithFeatures
import com.twitter.product_mixer.core.model.common.identifier.FilterIdentifier
import com.twitter.product_mixer.core.pipeline.PipelineQuery
import com.twitter.stitch.Stitch
/**
* A [[filter]] that filters candidates based on a country code feature
*
* @param countryCodeFeature the feature to filter candidates on
*/
case class TweetAuthorCountryFilter[Candidate <: BaseTweetCandidate](
countryCodeFeature: Feature[Candidate, Option[String]])
extends Filter[PipelineQuery, Candidate] {
override val identifier: FilterIdentifier = FilterIdentifier("TweetAuthorCountry")
override def apply(
query: PipelineQuery,
candidates: Seq[CandidateWithFeatures[Candidate]]
): Stitch[FilterResult[Candidate]] = {
val userCountry = query.getCountryCode
val (keptCandidates, removedCandidates) = candidates.partition { filteredCandidate =>
val authorCountry = filteredCandidate.features.get(countryCodeFeature)
(authorCountry, userCountry) match {
case (Some(authorCountryCode), Some(userCountryCode)) =>
authorCountryCode.equalsIgnoreCase(userCountryCode)
case _ => true
}
}
Stitch.value(
FilterResult(
kept = keptCandidates.map(_.candidate),
removed = removedCandidates.map(_.candidate)
)
)
}
}