-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Cross Navigation Enrichment (close #855)
- Loading branch information
Showing
10 changed files
with
929 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "schema": "iglu:com.snowplowanalytics.snowplow.enrichments/cross_navigation_config/jsonschema/1-0-0", | ||
|
|
||
| "data": { | ||
| "enabled": false, | ||
| "vendor": "com.snowplowanalytics.snowplow.enrichments", | ||
| "name": "cross_navigation_config" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
228 changes: 228 additions & 0 deletions
228
...plowanalytics.snowplow.enrich/common/enrichments/registry/CrossNavigationEnrichment.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,228 @@ | ||
| /* | ||
| * Copyright (c) 2012-present Snowplow Analytics Ltd. | ||
| * All rights reserved. | ||
| * | ||
| * This software is made available by Snowplow Analytics, Ltd., | ||
| * under the terms of the Snowplow Limited Use License Agreement, Version 1.0 | ||
| * located at https://docs.snowplow.io/limited-use-license-1.0 | ||
| * BY INSTALLING, DOWNLOADING, ACCESSING, USING OR DISTRIBUTING ANY PORTION | ||
| * OF THE SOFTWARE, YOU AGREE TO THE TERMS OF SUCH LICENSE AGREEMENT. | ||
| */ | ||
| package com.snowplowanalytics.snowplow.enrich.common.enrichments.registry | ||
|
|
||
| import java.time.format.DateTimeFormatter | ||
|
|
||
| import cats.data.ValidatedNel | ||
| import cats.syntax.either._ | ||
| import cats.syntax.option._ | ||
| import cats.syntax.traverse._ | ||
|
|
||
| import io.circe.Json | ||
| import io.circe.syntax._ | ||
|
|
||
| import com.snowplowanalytics.iglu.core.{SchemaCriterion, SchemaKey, SchemaVer, SelfDescribingData} | ||
| import com.snowplowanalytics.snowplow.badrows.FailureDetails | ||
| import com.snowplowanalytics.snowplow.enrich.common.enrichments.{EventEnrichments => EE} | ||
| import com.snowplowanalytics.snowplow.enrich.common.enrichments.registry.EnrichmentConf.CrossNavigationConf | ||
| import com.snowplowanalytics.snowplow.enrich.common.utils.{ConversionUtils => CU} | ||
| import com.snowplowanalytics.snowplow.enrich.common.QueryStringParameters | ||
|
|
||
| /** | ||
| * Companion object to create an instance of CrossNavigationEnrichment | ||
| * from the configuration. | ||
| */ | ||
| object CrossNavigationEnrichment extends ParseableEnrichment { | ||
|
|
||
| type CrossNavTransformation = String => Either[FailureDetails.EnrichmentFailure, Option[String]] | ||
|
|
||
| val supportedSchema = SchemaCriterion( | ||
| "com.snowplowanalytics.snowplow.enrichments", | ||
| "cross_navigation_config", | ||
| "jsonschema", | ||
| 1, | ||
| 0 | ||
| ) | ||
|
|
||
| val outputSchema = SchemaKey( | ||
| "com.snowplowanalytics.snowplow", | ||
| "cross_navigation", | ||
| "jsonschema", | ||
| SchemaVer.Full(1, 0, 0) | ||
| ) | ||
|
|
||
| /** | ||
| * Creates a CrossNavigationConf instance from a Json. | ||
| * @param config The cross_navigation_config enrichment JSON | ||
| * @param schemaKey provided for the enrichment, must be supported by this enrichment | ||
| * @return a CrossNavigation configuration | ||
| */ | ||
| override def parse( | ||
| config: Json, | ||
| schemaKey: SchemaKey, | ||
| localMode: Boolean = false | ||
| ): ValidatedNel[String, CrossNavigationConf] = | ||
| (for { | ||
| _ <- isParseable(config, schemaKey) | ||
| } yield CrossNavigationConf(schemaKey)).toValidatedNel | ||
|
|
||
| /** | ||
| * Extract the referrer domain user ID and timestamp from the "_sp={{DUID}}.{{TSTAMP}}" | ||
| * portion of the querystring | ||
| * | ||
| * @param qsMap The querystring parameters | ||
| * @return Validation boxing a pair of optional strings corresponding to the two fields | ||
| */ | ||
| def parseCrossDomain(qsMap: QueryStringParameters): Either[FailureDetails.EnrichmentFailure, CrossDomainMap] = | ||
| qsMap.toMap | ||
| .map { case (k, v) => (k, v.getOrElse("")) } | ||
| .get("_sp") match { | ||
| case Some("") => CrossDomainMap.empty.asRight | ||
| case Some(sp) => CrossDomainMap.makeCrossDomainMap(sp) | ||
| case None => CrossDomainMap.empty.asRight | ||
| } | ||
|
|
||
| case class CrossDomainMap(domainMap: Map[String, Option[String]]) { | ||
|
|
||
| /** | ||
| * Gets the cross navigation parameters as self-describing JSON. | ||
| * | ||
| * @param cnMap The map of cross navigation data | ||
| * @return the cross navigation context wrapped in a List | ||
| */ | ||
| def getCrossNavigationContext: List[SelfDescribingData[Json]] = | ||
| domainMap match { | ||
| case m: Map[String, Option[String]] if m.isEmpty => Nil | ||
| case m: Map[String, Option[String]] if m.get(CrossDomainMap.domainUserIdFieldName).flatten == None => Nil | ||
| case m: Map[String, Option[String]] if m.get(CrossDomainMap.timestampFieldName).flatten == None => Nil | ||
| case _ => | ||
| List( | ||
| SelfDescribingData( | ||
| CrossNavigationEnrichment.outputSchema, | ||
| finalizeCrossNavigationMap.asJson | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| def duid: Option[String] = domainMap.get(CrossDomainMap.domainUserIdFieldName).flatten | ||
|
|
||
| def tstamp: Option[String] = domainMap.get(CrossDomainMap.timestampFieldName).flatten | ||
|
|
||
| /** | ||
| * Finalizes the cross navigation map by reformatting its timestamp key | ||
| * | ||
| * @param inputMap A Map of cross navigation properties | ||
| * @return The finalized Map | ||
| */ | ||
| private def finalizeCrossNavigationMap: Map[String, Option[String]] = | ||
| domainMap | ||
| .map { | ||
| case ("timestamp", t) => ("timestamp" -> CrossDomainMap.reformatTstamp(t)) | ||
| case kvPair => kvPair | ||
| } | ||
| } | ||
|
|
||
| object CrossDomainMap { | ||
| val domainUserIdFieldName = "domain_user_id" | ||
| val timestampFieldName = "timestamp" | ||
| val CrossNavProps: List[(String, CrossNavTransformation)] = | ||
| List( | ||
| (domainUserIdFieldName, CU.fixTabsNewlines(_).asRight), | ||
| (timestampFieldName, extractTstamp), | ||
| ("session_id", Option(_: String).filter(_.trim.nonEmpty).asRight), | ||
| ("user_id", decodeWithFailure), | ||
| ("source_id", decodeWithFailure), | ||
| ("source_platform", Option(_: String).filter(_.trim.nonEmpty).asRight), | ||
| ("reason", decodeWithFailure) | ||
| ) | ||
|
|
||
| /** | ||
| * Parses the QueryString into a Map | ||
| * @param sp QueryString | ||
| * @return either a map of query string parameters or enrichment failure | ||
| */ | ||
| def makeCrossDomainMap(sp: String): Either[FailureDetails.EnrichmentFailure, CrossDomainMap] = { | ||
| val values = sp | ||
| .split("\\.", -1) | ||
| .padTo( | ||
| CrossNavProps.size, | ||
| "" | ||
| ) | ||
| .toList | ||
| val result = | ||
| if (values.size == CrossNavProps.size) | ||
| values | ||
| .zip(CrossNavProps) | ||
| .map { | ||
| case (value, (propName, f)) => f(value).map(propName -> _) | ||
| } | ||
| .sequence | ||
| .map(_.toMap) | ||
| else Map.empty[String, Option[String]].asRight | ||
| result.map(CrossDomainMap(_)) | ||
| } | ||
|
|
||
| def empty: CrossDomainMap = CrossDomainMap(Map.empty) | ||
|
|
||
| /** | ||
| * Wrapper around CU.decodeBase64Url. | ||
| * If passed an empty string returns Right(None). | ||
| * | ||
| * @param str The string to decode | ||
| * @return either the decoded string or enrichment failure | ||
| */ | ||
| private def decodeWithFailure(str: String): Either[FailureDetails.EnrichmentFailure, Option[String]] = | ||
| CU.decodeBase64Url(str) match { | ||
| case Right(r) => Option(r).filter(_.trim.nonEmpty).asRight | ||
| case Left(msg) => | ||
| FailureDetails | ||
| .EnrichmentFailure( | ||
| None, | ||
| FailureDetails.EnrichmentFailureMessage.Simple(msg) | ||
| ) | ||
| .asLeft | ||
| } | ||
|
|
||
| /** | ||
| * Wrapper around EE.extractTimestamp | ||
| * If passed an empty string returns Right(None). | ||
| * | ||
| * @param str The string to extract the timestamp from | ||
| * @return either the extracted timestamp or enrichment failure | ||
| */ | ||
| private def extractTstamp(str: String): Either[FailureDetails.EnrichmentFailure, Option[String]] = | ||
| str match { | ||
| case "" => None.asRight | ||
| case s => EE.extractTimestamp("sp_dtm", s).map(_.some) | ||
| } | ||
|
|
||
| /** | ||
| * Converts a timestamp to an ISO-8601 format | ||
| * | ||
| * @param tstamp The timestamp expected as output of EE.extractTimestamp | ||
| * @return ISO-8601 timestamp | ||
| */ | ||
| private def reformatTstamp(tstamp: Option[String]): Option[String] = { | ||
| val pFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS") | ||
| val formatter = DateTimeFormatter.ISO_DATE_TIME | ||
| tstamp.map(t => formatter.format(pFormatter.parse(t)).replaceAll(" ", "T") + "Z") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Enrichment adding cross navigation context | ||
| */ | ||
| final case class CrossNavigationEnrichment(schemaKey: SchemaKey) extends Enrichment { | ||
| private val enrichmentInfo = | ||
| FailureDetails.EnrichmentInformation(schemaKey, "cross-navigation").some | ||
|
|
||
| /** | ||
| * Given an EnrichmentFailure, returns one with the cross-navigation | ||
| * enrichment information added. | ||
| * @param failure The input enrichment failure | ||
| * @return the EnrichmentFailure with cross-navigation enrichment information | ||
| */ | ||
| def addEnrichmentInfo(failure: FailureDetails.EnrichmentFailure): FailureDetails.EnrichmentFailure = | ||
| failure.copy(enrichment = enrichmentInfo) | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.