-
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.
common: update the validation of the enriched event with static field…
… lengths (close #608)
- Loading branch information
Showing
3 changed files
with
199 additions
and
85 deletions.
There are no files selected for viewing
170 changes: 170 additions & 0 deletions
170
...om.snowplowanalytics.snowplow.enrich/common/enrichments/AtomicFieldsLengthValidator.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,170 @@ | ||
| package com.snowplowanalytics.snowplow.enrich.common.enrichments | ||
|
|
||
| import cats.Monad | ||
| import cats.data.Validated.{Invalid, Valid} | ||
| import cats.data.{NonEmptyList, ValidatedNel} | ||
| import cats.implicits._ | ||
| import com.snowplowanalytics.snowplow.badrows.FailureDetails.EnrichmentFailure | ||
| import com.snowplowanalytics.snowplow.badrows.{BadRow, FailureDetails, Processor} | ||
| import com.snowplowanalytics.snowplow.enrich.common.adapters.RawEvent | ||
| import com.snowplowanalytics.snowplow.enrich.common.outputs.EnrichedEvent | ||
| import org.slf4j.LoggerFactory | ||
|
|
||
| /** | ||
| * Atomic fields length validation inspired by | ||
| * https://github.com/snowplow/snowplow-scala-analytics-sdk/blob/master/src/main/scala/com.snowplowanalytics.snowplow.analytics.scalasdk/validate/package.scala | ||
| */ | ||
| object AtomicFieldsLengthValidator { | ||
|
|
||
| final case class AtomicField( | ||
| name: String, | ||
| enrichedValueExtractor: EnrichedEvent => String, | ||
| maxLength: Int | ||
| ) | ||
|
|
||
| private val logger = LoggerFactory.getLogger("AtomicLengthValidator") | ||
|
|
||
| // format: off | ||
| private val atomicFields = | ||
| List( | ||
| AtomicField(name = "app_id", _.app_id, maxLength = 255 ), | ||
| AtomicField(name = "platform", _.platform, maxLength = 255 ), | ||
| AtomicField(name = "event", _.event, maxLength = 128 ), | ||
| AtomicField(name = "event_id", _.event, maxLength = 36 ), | ||
| AtomicField(name = "name_tracker", _.name_tracker, maxLength = 128 ), | ||
| AtomicField(name = "v_tracker", _.v_tracker, maxLength = 100 ), | ||
| AtomicField(name = "v_collector", _.v_collector, maxLength = 100 ), | ||
| AtomicField(name = "v_etl", _.v_etl, maxLength = 100 ), | ||
| AtomicField(name = "user_id", _.user_id, maxLength = 255 ), | ||
| AtomicField(name = "user_ipaddress", _.user_ipaddress, maxLength = 128 ), | ||
| AtomicField(name = "user_fingerprint", _.user_fingerprint, maxLength = 128 ), | ||
| AtomicField(name = "domain_userid", _.domain_userid, maxLength = 128 ), | ||
| AtomicField(name = "network_userid", _.network_userid, maxLength = 128 ), | ||
| AtomicField(name = "geo_country", _.geo_country, maxLength = 2 ), | ||
| AtomicField(name = "geo_region", _.geo_region, maxLength = 3 ), | ||
| AtomicField(name = "geo_city", _.geo_city, maxLength = 75 ), | ||
| AtomicField(name = "geo_zipcode", _.geo_zipcode, maxLength = 15 ), | ||
| AtomicField(name = "geo_region_name", _.geo_region_name, maxLength = 100 ), | ||
| AtomicField(name = "ip_isp", _.ip_isp, maxLength = 100 ), | ||
| AtomicField(name = "ip_organization", _.ip_organization, maxLength = 128 ), | ||
| AtomicField(name = "ip_domain", _.ip_domain, maxLength = 128 ), | ||
| AtomicField(name = "ip_netspeed", _.ip_netspeed, maxLength = 100 ), | ||
| AtomicField(name = "page_url", _.page_url, maxLength = 4096), | ||
| AtomicField(name = "page_title", _.page_title, maxLength = 2000), | ||
| AtomicField(name = "page_referrer", _.page_referrer, maxLength = 4096), | ||
| AtomicField(name = "page_urlscheme", _.page_urlscheme, maxLength = 16 ), | ||
| AtomicField(name = "page_urlhost", _.page_urlhost, maxLength = 255 ), | ||
| AtomicField(name = "page_urlpath", _.page_urlpath, maxLength = 3000), | ||
| AtomicField(name = "page_urlquery", _.page_urlquery, maxLength = 6000), | ||
| AtomicField(name = "page_urlfragment", _.page_urlfragment, maxLength = 3000), | ||
| AtomicField(name = "refr_urlscheme", _.refr_urlscheme, maxLength = 16 ), | ||
| AtomicField(name = "refr_urlhost", _.refr_urlhost, maxLength = 255 ), | ||
| AtomicField(name = "refr_urlpath", _.refr_urlpath, maxLength = 6000), | ||
| AtomicField(name = "refr_urlquery", _.refr_urlquery, maxLength = 6000), | ||
| AtomicField(name = "refr_urlfragment", _.refr_urlfragment, maxLength = 3000), | ||
| AtomicField(name = "refr_medium", _.refr_medium, maxLength = 25 ), | ||
| AtomicField(name = "refr_source", _.refr_source, maxLength = 50 ), | ||
| AtomicField(name = "refr_term", _.refr_term, maxLength = 255 ), | ||
| AtomicField(name = "mkt_medium", _.mkt_medium, maxLength = 255 ), | ||
| AtomicField(name = "mkt_source", _.mkt_source, maxLength = 255 ), | ||
| AtomicField(name = "mkt_term", _.mkt_term, maxLength = 255 ), | ||
| AtomicField(name = "mkt_content", _.mkt_content, maxLength = 500 ), | ||
| AtomicField(name = "mkt_campaign", _.mkt_campaign, maxLength = 255 ), | ||
| AtomicField(name = "se_category", _.se_category, maxLength = 1000), | ||
| AtomicField(name = "se_action", _.se_action, maxLength = 1000), | ||
| AtomicField(name = "se_label", _.se_label, maxLength = 4096), | ||
| AtomicField(name = "se_property", _.se_property, maxLength = 1000), | ||
| AtomicField(name = "tr_orderid", _.tr_orderid, maxLength = 255 ), | ||
| AtomicField(name = "tr_affiliation", _.tr_affiliation, maxLength = 255 ), | ||
| AtomicField(name = "tr_city", _.tr_city, maxLength = 255 ), | ||
| AtomicField(name = "tr_state", _.tr_state, maxLength = 255 ), | ||
| AtomicField(name = "tr_country", _.tr_country, maxLength = 255 ), | ||
| AtomicField(name = "ti_orderid", _.ti_orderid, maxLength = 255 ), | ||
| AtomicField(name = "ti_sku", _.ti_sku, maxLength = 255 ), | ||
| AtomicField(name = "ti_name", _.ti_name, maxLength = 255 ), | ||
| AtomicField(name = "ti_category", _.ti_category, maxLength = 255 ), | ||
| AtomicField(name = "useragent", _.useragent, maxLength = 1000), | ||
| AtomicField(name = "br_name", _.br_name, maxLength = 50 ), | ||
| AtomicField(name = "br_family", _.br_family, maxLength = 50 ), | ||
| AtomicField(name = "br_version", _.br_version, maxLength = 50 ), | ||
| AtomicField(name = "br_type", _.br_type, maxLength = 50 ), | ||
| AtomicField(name = "br_renderengine", _.br_renderengine, maxLength = 50 ), | ||
| AtomicField(name = "br_lang", _.br_lang, maxLength = 255 ), | ||
| AtomicField(name = "br_colordepth", _.br_colordepth, maxLength = 12 ), | ||
| AtomicField(name = "os_name", _.os_name, maxLength = 50 ), | ||
| AtomicField(name = "os_family", _.os_family, maxLength = 50 ), | ||
| AtomicField(name = "os_manufacturer", _.os_manufacturer, maxLength = 50 ), | ||
| AtomicField(name = "os_timezone", _.os_timezone, maxLength = 255 ), | ||
| AtomicField(name = "dvce_type", _.dvce_type, maxLength = 50 ), | ||
| AtomicField(name = "doc_charset", _.doc_charset, maxLength = 128 ), | ||
| AtomicField(name = "tr_currency", _.tr_currency, maxLength = 3 ), | ||
| AtomicField(name = "ti_currency", _.ti_currency, maxLength = 3 ), | ||
| AtomicField(name = "base_currency", _.base_currency, maxLength = 3 ), | ||
| AtomicField(name = "geo_timezone", _.geo_timezone, maxLength = 64 ), | ||
| AtomicField(name = "mkt_clickid", _.mkt_clickid, maxLength = 128 ), | ||
| AtomicField(name = "mkt_network", _.mkt_network, maxLength = 64 ), | ||
| AtomicField(name = "etl_tags", _.etl_tags, maxLength = 500 ), | ||
| AtomicField(name = "refr_domain_userid", _.refr_domain_userid,maxLength = 128 ), | ||
| AtomicField(name = "domain_sessionid", _.domain_sessionid, maxLength = 128 ), | ||
| AtomicField(name = "event_vendor", _.event_vendor, maxLength = 1000), | ||
| AtomicField(name = "event_name", _.event_name, maxLength = 1000), | ||
| AtomicField(name = "event_format", _.event_format, maxLength = 128 ), | ||
| AtomicField(name = "event_version", _.event_version, maxLength = 128 ), | ||
| AtomicField(name = "event_fingerprint", _.event_fingerprint, maxLength = 128 ) | ||
| ) | ||
| // format: on | ||
|
|
||
| def validate[F[_]: Monad]( | ||
| event: EnrichedEvent, | ||
| rawEvent: RawEvent, | ||
| processor: Processor, | ||
| acceptInvalid: Boolean, | ||
| invalidCount: F[Unit] | ||
| ): F[Either[BadRow, Unit]] = | ||
| atomicFields | ||
| .map(validateField(event)) | ||
| .combineAll | ||
| .leftMap(buildBadRow(event, rawEvent, processor)) match { | ||
| case Invalid(badRow) if acceptInvalid => | ||
| handleAcceptableBadRow(invalidCount, badRow) *> Monad[F].pure(Right(())) | ||
| case Invalid(badRow) => | ||
| Monad[F].pure(Left(badRow)) | ||
| case Valid(()) => | ||
| Monad[F].pure(Right(())) | ||
| } | ||
|
|
||
| private def validateField(event: EnrichedEvent)(atomicField: AtomicField): ValidatedNel[String, Unit] = { | ||
| val actualValue = atomicField.enrichedValueExtractor(event) | ||
| if (actualValue != null && actualValue.length > atomicField.maxLength) | ||
| s"Field ${atomicField.name} longer than maximum allowed size ${atomicField.maxLength}".invalidNel | ||
| else | ||
| Valid(()) | ||
| } | ||
|
|
||
| private def buildBadRow( | ||
| event: EnrichedEvent, | ||
| rawEvent: RawEvent, | ||
| processor: Processor | ||
| )( | ||
| errors: NonEmptyList[String] | ||
| ): BadRow.EnrichmentFailures = | ||
| EnrichmentManager.buildEnrichmentFailuresBadRow( | ||
| NonEmptyList( | ||
| asEnrichmentFailure("Enriched event does not conform to atomic schema field's length restrictions"), | ||
| errors.toList.map(asEnrichmentFailure) | ||
| ), | ||
| EnrichedEvent.toPartiallyEnrichedEvent(event), | ||
| RawEvent.toRawEvent(rawEvent), | ||
| processor | ||
| ) | ||
|
|
||
| private def handleAcceptableBadRow[F[_]: Monad](invalidCount: F[Unit], badRow: BadRow.EnrichmentFailures): F[Unit] = | ||
| invalidCount *> | ||
| Monad[F].pure(logger.debug(s"Enriched event not valid against atomic schema. Bad row: ${badRow.compact}")) | ||
|
|
||
| private def asEnrichmentFailure(errorMessage: String): EnrichmentFailure = | ||
| EnrichmentFailure( | ||
| enrichment = None, | ||
| FailureDetails.EnrichmentFailureMessage.Simple(errorMessage) | ||
| ) | ||
| } |
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