+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| index.ts | +
+
+ |
+ 100% | +7/7 | +100% | +0/0 | +75% | +3/4 | +100% | +3/3 | +
| matchers.ts | +
+
+ |
+ 85.33% | +256/300 | +77.85% | +116/149 | +85.42% | +41/48 | +86.25% | +232/269 | +
| store.ts | +
+
+ |
+ 100% | +19/19 | +85.71% | +6/7 | +100% | +3/3 | +100% | +17/17 | +
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| 1 +2 +3 +4 | 4x +6x +3x + | export { default as transform } from './transformers'
+export { default as matches, getMatchFunction } from './matchers'
+export { default as Store } from './store'
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287 +288 +289 +290 +291 +292 +293 +294 +295 +296 +297 +298 +299 +300 +301 +302 +303 +304 +305 +306 +307 +308 +309 +310 +311 +312 +313 +314 +315 +316 +317 +318 +319 +320 +321 +322 +323 +324 +325 +326 +327 +328 +329 +330 +331 +332 +333 +334 +335 +336 +337 +338 +339 +340 +341 +342 +343 +344 +345 +346 +347 +348 +349 +350 +351 +352 +353 +354 +355 +356 +357 +358 +359 +360 +361 +362 +363 +364 +365 +366 +367 +368 +369 +370 +371 +372 +373 +374 +375 +376 +377 +378 +379 +380 +381 +382 +383 +384 +385 +386 +387 +388 +389 +390 +391 +392 +393 +394 +395 +396 +397 +398 +399 +400 +401 +402 +403 +404 +405 +406 +407 +408 +409 +410 +411 +412 +413 +414 +415 +416 +417 +418 +419 +420 +421 +422 +423 +424 +425 +426 +427 +428 +429 +430 +431 +432 +433 +434 +435 +436 +437 +438 +439 +440 +441 +442 +443 +444 +445 +446 +447 +448 +449 +450 +451 +452 +453 +454 +455 +456 +457 +458 +459 +460 +461 +462 +463 +464 +465 +466 +467 +468 +469 +470 +471 +472 +473 +474 +475 +476 +477 +478 +479 +480 +481 +482 +483 +484 +485 +486 +487 +488 +489 +490 +491 +492 +493 +494 +495 +496 +497 +498 +499 +500 +501 +502 +503 +504 +505 +506 +507 +508 +509 +510 +511 +512 +513 +514 +515 +516 +517 +518 +519 +520 +521 +522 +523 +524 +525 +526 +527 +528 +529 +530 +531 +532 +533 +534 +535 +536 +537 +538 +539 +540 +541 +542 +543 +544 +545 +546 +547 +548 +549 +550 +551 +552 +553 +554 +555 +556 +557 +558 +559 +560 +561 +562 +563 +564 +565 +566 +567 +568 +569 +570 +571 +572 +573 +574 +575 +576 +577 +578 +579 +580 +581 +582 +583 +584 +585 +586 +587 +588 +589 +590 +591 +592 +593 +594 +595 +596 +597 +598 +599 +600 +601 +602 +603 +604 +605 +606 +607 +608 +609 +610 +611 +612 +613 +614 +615 +616 +617 +618 +619 +620 +621 | +2x + +2x +113x + + +2x +113x + + + +113x + +1x + +111x + +1x + + + + +1x + + + +111x +1x + + +110x +110x + +1x + + +109x +108x +108x + + + + +2x +1x + + + +1x +1x + + + + +1x +1x +10001x + + + + + + + + + + + + + + + + +140x +21x + + +119x + +119x + + + + + + + + + + + + + + +4x +4x +10x + +4x +20010x +20010x +20010x +10003x + + + + + +1x + + + + +4x +4x +13x + +4x +50013x +50013x +50013x +1x + + + + + + + +10003x + + + + + +20x + + + + + + +10x + + +9x +9x + + + + + +5x +10005x + + + +59x +10059x + + + +3x +10003x +10003x + + +10003x + + + + +2x +2x + + + +2x +2x + + + +1x + + + + + +80193x + + + + +80193x +20174x + + + +60019x + + + +14x + + + + + + + +10x + + + + + + +10x + + +10x + + + + + + +10x + + + + +10x + + +3x +3x + + +3x +3x + + +2x +2x + + +2x +2x + + + + +10x + + +10x + + +10x + + +10x + + +10x + + +10x + + + +10x + + + + + + + + +20x +6x +1x + +30005x + + +14x + + +20x +6x +6x + + + + +14x + + + + + + + +20x + + +40018x +18x + + +2x +2x + + + + +20x + + +40020x +40006x + +14x + + +40020x +6x + +40014x + + +40020x +4x +4x + + +40020x + + + + +10005x + + + +10005x + + + +10059x + + + +10059x + + + + +2x + + + + +2x + + + +2x + + + + + + +12x +5x + + + +7x + + + +7x + + + + + + + + + + +60x +12x + + +48x + + + + + + + +10059x +20094x +20094x +20094x +20094x + +10007x + + + +10087x +10087x +1x + + + + + +10086x +10033x +10033x + + +53x + +31x +75x +75x + +30x +3x + + +27x +27x + + +45x + + + + + +26x + + +25x + + + +20094x + + + + + +20094x +10042x +10042x + + +20094x + + +20094x +40272x + + +12x +11x + +12x + +34x +34x + +30x +30x + +10035x +10035x + + + + +20094x +20094x +20094x + + + + + + +10162x + + + + + +10162x +30228x +7x + + +30221x + +32x +32x +32x + +32x +32x +8x +8x + + + +32x +32x +32x +60x +19x +19x + + +41x +41x +41x +41x +41x +10x + + +31x +31x +10x +10x +3x + + + +28x +12x + + +28x + + +19x +6x + +13x + +14x +14x +14x + +4x +4x +1x +1x + + + +30174x +71x + +30103x +30103x + + + +10064x +10064x +10064x +10064x + + + + +51x + + + + + +51x +12x +12x + + +39x +8x +8x + + + + + + + +39x +39x +39x +1x + + +39x + + | import * as Store from './store'
+import get from 'dlv'
+
+export default function matches(event: unknown, matcher: Store.Matcher): boolean {
+ return getMatchFunction(matcher)(event)
+}
+
+export function getMatchFunction(matcher: Store.Matcher): (event: unknown) => boolean {
+ Iif (!matcher) {
+ throw new Error('No matcher supplied!')
+ }
+
+ switch (matcher.type) {
+ case 'all':
+ return all
+ case 'fql':
+ return fql(matcher.ir)
+ default:
+ throw new Error(`Matcher of type ${matcher.type} unsupported.`)
+ }
+}
+
+function all(): boolean {
+ return true
+}
+
+function fql(ir: Store.Matcher['ir']): (event: unknown) => boolean {
+ if (!ir) {
+ return () => false
+ }
+
+ try {
+ ir = JSON.parse(ir)
+ } catch (e) {
+ throw new Error(`Failed to JSON.parse FQL intermediate representation "${ir}": ${e}`)
+ }
+
+ const evaluator = generateEvaluator(ir)
+ if (typeof evaluator === 'function') {
+ return (event) => !!evaluator(event)
+ }
+ return () => !!evaluator
+}
+
+export function generateFQLEval(ir: Store.Matcher['ir']): (event: unknown) => boolean {
+ Iif (!ir) {
+ return () => false
+ }
+
+ try {
+ ir = JSON.parse(ir)
+ } catch (e) {
+ throw new Error(`Failed to JSON.parse FQL intermediate representation "${ir}": ${e}`)
+ }
+
+ const evaluator = generateEvaluator(ir)
+ if (typeof evaluator === 'function') {
+ return (event) => !!evaluator(event)
+ }
+ return () => !!evaluator
+}
+
+type FQLEvaluator =
+ | ((event: any) => boolean)
+ | ((event: any) => string)
+ | ((event: any) => number)
+ | string
+ | number
+ | boolean
+ | Array<String | boolean | number>
+
+// Creates a function for evaluating a given FQL
+function generateEvaluator(ir: string | string[]): FQLEvaluator {
+ // If the given ir chunk is not an array, then we should check the single given path or value for literally `true`.
+ if (!Array.isArray(ir)) {
+ return (event: any) => getValue(ir, event) === true
+ }
+
+ const item = ir[0]
+
+ switch (item) {
+ /*** Unary cases ***/
+ // '!' => Invert the result
+ case '!':
+ const op = generateEvaluator(ir[1])
+ if (typeof op === 'function') {
+ return (event: any) => {
+ return !op(event)
+ }
+ } else {
+ return !op
+ }
+ /*** Binary cases ***/
+ // 'or' => Any condition being true returns true
+ case 'or':
+ const orOps: FQLEvaluator[] = []
+ for (let i = 1; i < ir.length; i++) {
+ orOps.push(generateEvaluator(ir[i]))
+ }
+ return (event: any) => {
+ for (const op of orOps) {
+ if (typeof op === 'function') {
+ if (op(event)) {
+ return true
+ }
+ } else E{
+ Iif (op) return true
+ }
+ }
+ return false
+ }
+
+ // 'and' => Any condition being false returns false
+ case 'and':
+ const andOps: FQLEvaluator[] = []
+ for (let i = 1; i < ir.length; i++) {
+ andOps.push(generateEvaluator(ir[i]))
+ }
+ return (event: any) => {
+ for (const op of andOps) {
+ if (typeof op === 'function') {
+ if (!op(event)) {
+ return false
+ }
+ } else E{
+ Iif (!op) {
+ return false
+ }
+ }
+ }
+ return true
+ }
+
+ // Equivalence comparisons
+ case '=':
+ case '!=':
+ return compareItemsGenerator(ir[1], ir[2], item)
+ // Numerical comparisons
+ case '<=':
+ case '<':
+ case '>':
+ case '>=':
+ // Compare the two values with the given operator.
+ return compareNumbersGenerator(ir[1], ir[2], item)
+ // item in [list]' => Checks whether item is in list
+ case 'in':
+ return (event) => {
+ return checkInList(getValue(ir[1], event), getValue(ir[2], event), event)
+ }
+
+ /*** Functions ***/
+ // 'contains(str1, str2)' => The first string has a substring of the second string
+ case 'contains':
+ return (event) => {
+ return contains(getValue(ir[1], event), getValue(ir[2], event))
+ }
+ // 'match(str, match)' => The given string matches the provided glob matcher
+ case 'match':
+ return (event) => {
+ return match(getValue(ir[1], event), getValue(ir[2], event))
+ }
+ // 'lowercase(str)' => Returns a lowercased string, null if the item is not a string
+ case 'lowercase':
+ return (event) => {
+ const target = getValue(ir[1], event)
+ Iif (typeof target !== 'string') {
+ return null
+ }
+ return target.toLowerCase()
+ }
+ // 'typeof(val)' => Returns the FQL type of the value
+ case 'typeof':
+ // TODO: Do we need mapping to allow for universal comparisons? e.g. Object -> JSON, Array -> List, Floats?
+ return (event) => {
+ return typeof getValue(ir[1], event)
+ }
+ // 'length(val)' => Returns the length of an array or string, NaN if neither
+ case 'length':
+ return (event) => {
+ return length(getValue(ir[1], event))
+ }
+ // If nothing hit, we or the IR messed up somewhere.
+ default:
+ throw new Error(`FQL IR could not evaluate for token: ${item}`)
+ }
+}
+
+function getValue(item, event) {
+ // If item is an array, leave it as-is.
+ Iif (Array.isArray(item)) {
+ return item
+ }
+
+ // If item is an object, it has the form of `{"value": VAL}`
+ if (typeof item === 'object') {
+ return item.value
+ }
+
+ // Otherwise, it's an event path, e.g. "properties.email"
+ return get(event, item)
+}
+
+function checkInList(item, list, event): boolean {
+ return list.find((it) => getValue(it, event) === item) !== undefined
+}
+
+function compareNumbersGenerator(first, second, operator): (event) => boolean {
+ // Check if it's more IR (such as a length() function)
+ let firstEval: FQLEvaluator
+ let secondEval: FQLEvaluator
+
+ Iif (!isStatic(first)) {
+ if (isIR(first)) {
+ firstEval = generateEvaluator(first)
+ } else {
+ firstEval = (event) => getValue(first, event)
+ }
+ } else {
+ firstEval = first.value
+ }
+
+ Iif (!isStatic(second)) {
+ if (isIR(second)) {
+ secondEval = generateEvaluator(second)
+ } else {
+ secondEval = (event) => getValue(second, event)
+ }
+ } else {
+ secondEval = second.value
+ }
+
+ // Reminder: NaN is not comparable to any other number (including NaN) and will always return false as desired.
+ let op: (a: number, b: number) => boolean
+ switch (operator) {
+ // '<=' => The first number is less than or equal to the second.
+ case '<=':
+ op = (a, b) => a <= b
+ break
+ // '>=' => The first number is greater than or equal to the second
+ case '>=':
+ op = (a, b) => a >= b
+ break
+ // '<' The first number is less than the second.
+ case '<':
+ op = (a, b) => a < b
+ break
+ // '>' The first number is greater than the second.
+ case '>':
+ op = (a, b) => a > b
+ break
+ default:
+ throw new Error(`Invalid operator in compareNumbers: ${operator}`)
+ }
+
+ return (event) => {
+ let a, b
+
+ Iif (typeof firstEval === 'function') {
+ a = firstEval(event)
+ } else {
+ a = firstEval
+ }
+
+ Iif (typeof secondEval === 'function') {
+ b = secondEval(event)
+ } else {
+ b = secondEval
+ }
+
+ Iif (typeof a !== 'number' || typeof b !== 'number') {
+ return false
+ }
+
+ return op(a, b)
+ }
+}
+
+function compareItemsGenerator(first, second, operator): FQLEvaluator {
+ let firstEval: FQLEvaluator
+ let secondEval: FQLEvaluator
+
+ // Check if it's more IR (such as a lowercase() function)
+ if (!isStatic(first)) {
+ if (isIR(first)) {
+ firstEval = generateEvaluator(first)
+ } else {
+ firstEval = (event) => getValue(first, event)
+ }
+ } else {
+ firstEval = first.value
+ }
+
+ if (!isStatic(second)) {
+ if (isIR(second)) {
+ secondEval = generateEvaluator(second)
+ } else E{
+ secondEval = (event) => getValue(second, event)
+ }
+ } else {
+ secondEval = second.value
+ }
+
+ // Objects with the exact same contents AND order ARE considered identical. (Don't compare by reference)
+ // Even in Go, this MUST be the same byte order.
+ // e.g. {a: 1, b:2} === {a: 1, b:2} BUT {a:1, b:2} !== {b:2, a:1}
+ // Maybe later we'll use a stable stringifier, but we're matching server-side behavior for now.
+ let compareOp: (a: unknown, b: unknown) => boolean
+ switch (operator) {
+ // '=' => The two following items are exactly identical
+ case '=':
+ compareOp = (a, b) => a === b
+ break
+ // '!=' => The two following items are NOT exactly identical.
+ case '!=':
+ compareOp = (a, b) => a !== b
+ break
+ default:
+ throw new Error(`Invalid operator in compareItems: ${operator}`)
+ }
+
+ return (event) => {
+ let a, b
+
+ if (typeof firstEval === 'function') {
+ a = firstEval(event)
+ } else {
+ a = firstEval
+ }
+
+ if (typeof secondEval === 'function') {
+ b = secondEval(event)
+ } else {
+ b = secondEval
+ }
+
+ if (typeof a === 'object' && typeof b === 'object') {
+ a = JSON.stringify(a)
+ b = JSON.stringify(b)
+ }
+
+ return compareOp(a, b)
+ }
+}
+
+function contains(first, second): boolean {
+ Iif (typeof first !== 'string' || typeof second !== 'string') {
+ return false
+ }
+
+ return first.indexOf(second) !== -1
+}
+
+function match(str, glob): boolean {
+ Iif (typeof str !== 'string' || typeof glob !== 'string') {
+ return false
+ }
+
+ return globMatches(glob, str)
+}
+
+function length(item) {
+ // Match server-side behavior.
+ Iif (item === null) {
+ return 0
+ }
+
+ // Type-check to avoid returning .length of an object
+ Iif (!Array.isArray(item) && typeof item !== 'string') {
+ return NaN
+ }
+
+ return item.length
+}
+
+// This is a heuristic technically speaking, but should be close enough. The odds of someone trying to test
+// a func with identical IR notation is pretty low.
+function isIR(value): boolean {
+ // TODO: This can be better checked by checking if this is a {"value": THIS}
+ if (!Array.isArray(value)) {
+ return false
+ }
+
+ // Function checks
+ if (
+ (value[0] === 'lowercase' || value[0] === 'length' || value[0] === 'typeof') &&
+ value.length === 2
+ ) {
+ return true
+ }
+
+ Iif ((value[0] === 'contains' || value[0] === 'match') && value.length === 3) {
+ return true
+ }
+
+ return false
+}
+
+function isStatic(ir: Store.Matcher | string): boolean {
+ if (Array.isArray(ir) || typeof ir !== 'object') {
+ return false
+ }
+
+ return true
+}
+
+// Any reputable glob matcher is designed to work on filesystems and doesn't allow the override of the separator
+// character "/". This is problematic since our server-side representation e.g. evaluates "match('ab/c', 'a*)"
+// as TRUE, whereas any glob matcher for JS available does false. So we're rewriting it here.
+// See: https://github.com/segmentio/glob/blob/master/glob.go
+function globMatches(pattern, str): boolean {
+ Pattern: while (pattern.length > 0) {
+ let star
+ let chunk
+ ;({ star, chunk, pattern } = scanChunk(pattern))
+ if (star && chunk === '') {
+ // Trailing * matches rest of string
+ return true
+ }
+
+ // Look for match at current position
+ let { t, ok, err } = matchChunk(chunk, str)
+ if (err) {
+ return false
+ }
+
+ // If we're the last chunk, make sure we've exhausted the str
+ // otherwise we'll give a false result even if we could still match
+ // using the star
+ if (ok && (t.length === 0 || pattern.length > 0)) {
+ str = t
+ continue
+ }
+
+ if (star) {
+ // Look for match, skipping i+1 bytes.
+ for (let i = 0; i < str.length; i++) {
+ ;({ t, ok, err } = matchChunk(chunk, str.slice(i + 1)))
+ if (ok) {
+ // If we're the last chunk, make sure we exhausted the str.
+ if (pattern.length === 0 && t.length > 0) {
+ continue
+ }
+
+ str = t
+ continue Pattern
+ }
+
+ Iif (err) {
+ return false
+ }
+ }
+ }
+
+ return false
+ }
+
+ return str.length === 0
+}
+
+function scanChunk(pattern): any {
+ const result = {
+ star: false,
+ chunk: '',
+ pattern: '',
+ }
+
+ while (pattern.length > 0 && pattern[0] === '*') {
+ pattern = pattern.slice(1)
+ result.star = true
+ }
+
+ let inRange = false
+ let i
+
+ Scan: for (i = 0; i < pattern.length; i++) {
+ switch (pattern[i]) {
+ case '\\':
+ // Error check handled in matchChunk: bad pattern.
+ if (i + 1 < pattern.length) {
+ i++
+ }
+ break
+ case '[':
+ inRange = true
+ break
+ case ']':
+ inRange = false
+ break
+ case '*':
+ if (!inRange) {
+ break Scan
+ }
+ }
+ }
+
+ result.chunk = pattern.slice(0, i)
+ result.pattern = pattern.slice(i)
+ return result
+}
+
+// matchChunk checks whether chunk matches the beginning of s.
+// If so, it returns the remainder of s (after the match).
+// Chunk is all single-character operators: literals, char classes, and ?.
+function matchChunk(chunk, str): any {
+ const result = {
+ t: '',
+ ok: false,
+ err: false,
+ }
+
+ while (chunk.length > 0) {
+ if (str.length === 0) {
+ return result
+ }
+
+ switch (chunk[0]) {
+ case '[':
+ const char = str[0]
+ str = str.slice(1)
+ chunk = chunk.slice(1)
+
+ let notNegated = true
+ if (chunk.length > 0 && chunk[0] === '^') {
+ notNegated = false
+ chunk = chunk.slice(1)
+ }
+
+ // Parse all ranges
+ let foundMatch = false
+ let nRange = 0
+ while (true) {
+ if (chunk.length > 0 && chunk[0] === ']' && nRange > 0) {
+ chunk = chunk.slice(1)
+ break
+ }
+
+ let lo = ''
+ let hi = ''
+ let err
+ ;({ char: lo, newChunk: chunk, err } = getEsc(chunk))
+ if (err) {
+ return result
+ }
+
+ hi = lo
+ if (chunk[0] === '-') {
+ ;({ char: hi, newChunk: chunk, err } = getEsc(chunk.slice(1)))
+ if (err) {
+ return result
+ }
+ }
+
+ if (lo <= char && char <= hi) {
+ foundMatch = true
+ }
+
+ nRange++
+ }
+
+ if (foundMatch !== notNegated) {
+ return result
+ }
+ break
+ case '?':
+ str = str.slice(1)
+ chunk = chunk.slice(1)
+ break
+ case '\\':
+ chunk = chunk.slice(1)
+ if (chunk.length === 0) {
+ result.err = true
+ return result
+ }
+ // Fallthrough, missing break intentional.
+ default:
+ if (chunk[0] !== str[0]) {
+ return result
+ }
+ str = str.slice(1)
+ chunk = chunk.slice(1)
+ }
+ }
+
+ result.t = str
+ result.ok = true
+ result.err = false
+ return result
+}
+
+// getEsc gets a possibly-escaped character from chunk, for a character class.
+function getEsc(chunk): any {
+ const result = {
+ char: '',
+ newChunk: '',
+ err: false,
+ }
+
+ if (chunk.length === 0 || chunk[0] === '-' || chunk[0] === ']') {
+ result.err = true
+ return result
+ }
+
+ if (chunk[0] === '\\') {
+ chunk = chunk.slice(1)
+ Iif (chunk.length === 0) {
+ result.err = true
+ return result
+ }
+ }
+
+ // Unlike Go, JS strings operate on characters instead of bytes.
+ // This is why we aren't copying over the GetRuneFromString stuff.
+ result.char = chunk[0]
+ result.newChunk = chunk.slice(1)
+ if (result.newChunk.length === 0) {
+ result.err = true
+ }
+
+ return result
+}
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 | + + + + + + + + + + + + + + + + + + + +1x +2x +2x + +2x + +4x + +2x +1x +1x + + +1x + +1x + + + + +1x +3x + +3x +3x +1x + + +3x + +1x + | import { TransformerConfig } from './transformers'
+
+export interface Rule {
+ scope: string
+ target_type: string
+ matchers: Matcher[]
+ transformers: Transformer[][]
+ destinationName?: string
+}
+
+export interface Matcher {
+ type: string
+ ir: string
+}
+
+export interface Transformer {
+ type: string
+ config?: TransformerConfig
+}
+
+export default class Store {
+ private readonly rulesByDestination: { [key: string]: Rule[] } = {}
+ private readonly globalRules: Rule[] = []
+
+ constructor(Irules: Rule[] = []) {
+ // Initialize the maps
+ for (const rule of rules) {
+ // Rules with no destinationName are global (workspace || workspace::source)
+ if (rule.destinationName !== undefined) {
+ if (this.rulesByDestination[rule.destinationName] === undefined) {
+ this.rulesByDestination[rule.destinationName] = []
+ }
+
+ this.rulesByDestination[rule.destinationName].push(rule)
+ } else {
+ this.globalRules.push(rule)
+ }
+ }
+ }
+
+ public getRulesByDestinationName(destinationName: string): Rule[] {
+ const rules: Rule[] = [...this.globalRules]
+
+ const destinationRules = this.rulesByDestination[destinationName]
+ if (destinationRules !== undefined && destinationRules.length > 0) {
+ rules.push(...destinationRules)
+ }
+
+ return rules
+ }
+}
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 | +2x +2x +2x +2x +2x + + + + + + + + + + + + + + + + + + + + +2x +22238x + +44476x +22238x + +6x + +6x +5x + +5x +4x + +22202x +4498x + +17703x + +18x +18x + + + + +1x + + + +4525x + + + + +6x +5x + + + + +5x + + +5x + + + +6x +6x + + + + + + + +5x +4x + + + + +4x + + +4x + + + + + +4x +23x + + + +23x +20x + + + + + + + + + + + + +18x + +18x +18x + + + +18x + + + +18x +18x +18x + + + +18x + + +18x + + + + +18x +2x +2x +1x + +16x +2x +2x +1x + + +2x + + +14x +7x + + + +18x +7x + + +7x + + + +3x + + + +4x +3x + + +1x + + + + + + +22202x +1100x +21101x +1100x + + + +20001x + + + + +20001x + + + + + + + + + + + + + + + + + + +20001x + + +20001x +20001x + + +20001x + + +20001x + +20001x +20001x +284720x +19900x + + +264820x + + +20001x + +20001x +20001x + +20001x + +20001x + + +20001x +20001x + + + +20001x + + +20001x + + + + +40002x +320016x +320016x +2560128x +269770x +269770x + +2290358x + + + + + | import { Transformer } from './store'
+import MD5 from 'tiny-hashes/md5'
+import get from 'dlv'
+import ldexp from '@stdlib/math-base-special-ldexp'
+import { dset } from 'dset';
+import { unset } from './unset'
+
+export interface TransformerConfig {
+ allow?: Record<string, string[]>
+ drop?: Record<string, string[]>
+ sample?: TransformerConfigSample
+ map?: Record<string, TransformerConfigMap>
+}
+
+export interface TransformerConfigSample {
+ percent: number
+ path: string
+}
+
+export interface TransformerConfigMap {
+ set?: any
+ copy?: string
+ move?: string
+ to_string?: boolean
+}
+
+export default function transform(payload: any, transformers: Transformer[]): any {
+ const transformedPayload: any = payload
+
+ for (const transformer of transformers) {
+ switch (transformer.type) {
+ case 'drop':
+ return null
+ case 'drop_properties':
+ dropProperties(transformedPayload, transformer.config)
+ break
+ case 'allow_properties':
+ allowProperties(transformedPayload, transformer.config)
+ break
+ case 'sample_event':
+ if (sampleEvent(transformedPayload, transformer.config)) {
+ break
+ }
+ return null
+ case 'map_properties':
+ mapProperties(transformedPayload, transformer.config)
+ break
+ case 'hash_properties':
+ // Not yet supported, but don't throw an error. Just ignore.
+ break
+ default:
+ throw new Error(`Transformer of type "${transformer.type}" is unsupported.`)
+ }
+ }
+
+ return transformedPayload
+}
+
+// dropProperties removes all specified props from the object.
+function dropProperties(payload: any, config: TransformerConfig) {
+ for (const key in config.drop) {
+ Iif (!config.drop.hasOwnProperty(key)) {
+ continue
+ }
+
+ // If key is empty, it refers to the top-level object.
+ const field = key === '' ? payload : get(payload, key)
+
+ // Can only drop props off of arrays and objects.
+ Iif (typeof field !== 'object' || field === null) {
+ continue
+ }
+
+ for (const target of config.drop[key]) {
+ delete field[target]
+ }
+ }
+}
+
+// allowProperties ONLY allows the specific targets within the keys. (e.g. "a.foo": ["bar", "baz"]
+// on {a: {foo: {bar: 1, baz: 2}, other: 3}} will not have any drops, as it only looks inside a.foo
+function allowProperties(payload: any, config: TransformerConfig) {
+ for (const key in config.allow) {
+ Iif (!config.allow.hasOwnProperty(key)) {
+ continue
+ }
+
+ // If key is empty, it refers to the top-level object.
+ const field = key === '' ? payload : get(payload, key)
+
+ // Can only drop props off of arrays and objects.
+ Iif (typeof field !== 'object' || field === null) {
+ continue
+ }
+
+ // Execution order fortunately doesn't really matter (e.g. if someone filtered off of foo.bar, then foo.bar.baz)
+ // except for micro-optimization.
+ for (const k in field) {
+ Iif (!field.hasOwnProperty(k)) {
+ continue
+ }
+
+ if (config.allow[key].indexOf(k) === -1) {
+ delete field[k]
+ }
+ }
+ }
+}
+
+function mapProperties(payload: any, config: TransformerConfig) {
+ // Some configs might try to modify or read from a field multiple times. We will only ever read
+ // values as they were before any modifications began. Thus, if you try to override e.g.
+ // {a: {b: 1}} with set(a, 'b', 2) (which results in {a: {b: 2}}) and then try to copy a.b into
+ // a.c, you will get {a: {b: 2, c:1}} and NOT {a: {b:2, c:2}}. This prevents map evaluation
+ // order from mattering, and === what server-side does.
+ // See: https://github.com/segmentio/tsub/blob/661695a63b60b90471796e667458f076af788c19/transformers/map_properties.go#L179-L200
+ const initialPayload = JSON.parse(JSON.stringify(payload))
+
+ for (const key in config.map) {
+ Iif (!config.map.hasOwnProperty(key)) {
+ continue
+ }
+
+ const actionMap: TransformerConfigMap = config.map[key]
+
+ // Can't manipulate non-objects. Check that the parent is one. Strip the last .field
+ // from the string.
+ const splitKey = key.split('.')
+ let parent
+ Iif (splitKey.length > 1) {
+ splitKey.pop()
+ parent = get(initialPayload, splitKey.join('.'))
+ } else {
+ parent = payload
+ }
+
+ Iif (typeof parent !== 'object') {
+ continue
+ }
+
+ // These actions are exclusive to each other.
+ if (actionMap.copy) {
+ const valueToCopy = get(initialPayload, actionMap.copy)
+ if (valueToCopy !== undefined) {
+ dset(payload, key, valueToCopy)
+ }
+ } else if (actionMap.move) {
+ const valueToMove = get(initialPayload, actionMap.move)
+ if (valueToMove !== undefined) {
+ dset(payload, key, valueToMove)
+ }
+
+ unset(payload, actionMap.move)
+ }
+ // Have to check only if property exists, as null, undefined, and other vals could be explicitly set.
+ else if (actionMap.hasOwnProperty('set')) {
+ dset(payload, key, actionMap.set)
+ }
+
+ // to_string is not exclusive and can be paired with other actions. Final action.
+ if (actionMap.to_string) {
+ const valueToString = get(payload, key)
+
+ // Do not string arrays and objects. Do not double-encode strings.
+ if (
+ typeof valueToString === 'string' ||
+ (typeof valueToString === 'object' && valueToString !== null)
+ ) {
+ continue
+ }
+
+ // TODO: Check stringifier in Golang for parity.
+ if (valueToString !== undefined) {
+ dset(payload, key, JSON.stringify(valueToString))
+ } else {
+ // TODO: Check this behavior.
+ dset(payload, key, 'undefined')
+ }
+ }
+ }
+}
+
+function sampleEvent(payload: any, config: TransformerConfig): boolean {
+ if (config.sample.percent <= 0) {
+ return false
+ } else if (config.sample.percent >= 1) {
+ return true
+ }
+
+ // If we're not filtering deterministically, just use raw percentage.
+ Iif (!config.sample.path) {
+ return samplePercent(config.sample.percent)
+ }
+
+ // Otherwise, use a deterministic hash.
+ return sampleConsistentPercent(payload, config)
+}
+
+function samplePercent(percent: number): boolean {
+ // Math.random returns [0, 1) => 0.0<>0.9999...
+ return Math.random() <= percent
+}
+
+// sampleConsistentPercent converts an input string of bytes into a consistent uniform
+// continuous distribution of [0.0, 1.0]. This is based on
+// http://mumble.net/~campbell/tmp/random_real.c, but using the digest
+// result of the input value as the random information.
+
+// IMPORTANT - This function needs to === the Golang implementation to ensure that the two return the same vals!
+// See: https://github.com/segmentio/sampler/blob/65cb04132305a04fcd4bcaef67d57fbe40c30241/sampler.go#L13-L38
+
+// Since AJS supports IE9+ (typed arrays were introduced in IE10) we're doing some manual array math.
+// This could be done directly with strings, but arrays are easier to reason about/have better function support.
+function sampleConsistentPercent(payload: any, config: TransformerConfig): boolean {
+ const field = get(payload, config.sample.path)
+
+ // Operate off of JSON bytes. TODO: Validate all type behavior, esp. strings.
+ const digest: number[] = MD5(JSON.stringify(field))
+ let exponent = -64
+
+ // Manually maintain 64-bit int as an array.
+ let significand: number[] = []
+
+ // Left-shift and OR for first 8 bytes of digest. (8 bytes * 8 = 64 bits)
+ consumeDigest(digest.slice(0, 8), significand)
+
+ let leadingZeros = 0
+ for (let i = 0; i < 64; i++) {
+ if (significand[i] === 1) {
+ break
+ }
+
+ leadingZeros++
+ }
+
+ if (leadingZeros !== 0) {
+ // Use the last 8 bytes of the digest, same as before.
+ const val: number[] = []
+ consumeDigest(digest.slice(9, 16), val)
+
+ exponent -= leadingZeros
+ // Left-shift away leading zeros in significand.
+ significand.splice(0, leadingZeros)
+
+ // Right-shift val by 64 minus leading zeros and push into significand.
+ val.splice(64 - leadingZeros)
+ significand = significand.concat(val)
+ }
+
+ // Flip 64th bit
+ significand[63] = significand[63] === 0 ? 1 : 0
+
+ // Convert our manual binary into a JS num (binary arr => binary string => psuedo-int) and run the ldexp!
+ return ldexp(parseInt(significand.join(''), 2), exponent) < config.sample.percent
+}
+
+// Array byte filler helper
+function consumeDigest(digest: number[], arr: number[]) {
+ for (let i = 0; i < 8; i++) {
+ let remainder = digest[i]
+ for (let binary = 128; binary >= 1; binary /= 2) {
+ if (remainder - binary >= 0) {
+ remainder -= binary
+ arr.push(1)
+ } else {
+ arr.push(0)
+ }
+ }
+ }
+}
+ |
+ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 | 2x + +2x +2x +1x +1x +1x + + +1x +1x + +1x + + | import get from 'dlv'
+
+export function unset(obj, prop) {
+ if (get(obj, prop)) {
+ var segs = prop.split('.')
+ var last = segs.pop()
+ while (segs.length && segs[segs.length - 1].slice(-1) === '\\') {
+ last = segs.pop().slice(0, -1) + '.' + last
+ }
+ while (segs.length) obj = obj[(prop = segs.shift())]
+ return delete obj[last]
+ }
+ return true
+}
+ |