fix(data): support parent matching for more than one parent per key (#43)

Author: kribor

src/scrubber.model.ts

@@ -10,7 +10,7 @@ export interface ScrubberConfig {
    * Populated at runtime from any config keys with dots, key is last component (after last dot) and array contains
    * preceeding components a.k.a "parents"
    */
-  splitFields?: StringMap<string[]>
+  splitFields?: StringMap<string[][]>
 
   // If false, Scrubber catches any exceptions that may occur when using scrubbers,
   // logs and ignore them. If true, exceptions are logged and raised

src/scrubber.test.ts

@@ -387,12 +387,12 @@ test('Support scrubbing based on parent', () => {
 })
 
 test('Support scrubbing array based on parent', () => {
-  const data = { nested: { encryption: [{ key: 'secret' }] } }
+  const data = { nested: { encryption: [{ key: 'secret' }], second: [{ key: 'secret2' }] } }
   const scrubber = new Scrubber(configParentScrubbersMock())
   const result = scrubber.scrub(data)
 
   expect(result).toEqual({
-    nested: { encryption: [{ key: 'replaced' }] },
+    nested: { encryption: [{ key: 'replaced' }], second: [{ key: 'replaced' }] },
   })
 })
 

src/scrubber.ts

@@ -79,16 +79,13 @@ export class Scrubber {
     Object.keys(dataCopy).forEach(key => {
       let scrubberCurrentField = this.cfg.fields[key]
 
-      if (
-        !scrubberCurrentField &&
-        this.cfg.splitFields?.[key] &&
-        parents &&
-        this.arrayContainsInOrder(parents, this.cfg.splitFields[key])
-      ) {
-        const splitFieldParentCfg: string[] = this.cfg.splitFields[key] || []
-
-        const recomposedKey = [...splitFieldParentCfg, key].join('.')
-        scrubberCurrentField = this.cfg.fields[recomposedKey]
+      if (!scrubberCurrentField && this.cfg.splitFields?.[key] && parents) {
+        for (const splitFieldParentCfg of this.cfg.splitFields[key]!) {
+          if (this.arrayContainsInOrder(parents, splitFieldParentCfg)) {
+            const recomposedKey = [...splitFieldParentCfg, key].join('.')
+            scrubberCurrentField = this.cfg.fields[recomposedKey]
+          }
+        }
       }
 
       if (!scrubberCurrentField) {
@@ -183,14 +180,16 @@ export class Scrubber {
     })
   }
 
-  private splitFields(cfg: ScrubberConfig): StringMap<string[]> {
-    const output: StringMap<string[]> = {}
+  private splitFields(cfg: ScrubberConfig): StringMap<string[][]> {
+    const output: StringMap<string[][]> = {}
     for (const field of Object.keys(cfg.fields)) {
       const splitField = field.split('.')
 
       if (splitField.length > 1) {
         const key = splitField.pop()!
-        output[key] = splitField
+        // Support multiple keys with different parents
+        output[key] ||= []
+        output[key]!.push(splitField)
       }
     }
     return output

src/test/scrubber.mock.ts

@@ -57,7 +57,7 @@ export function configParentScrubbersMock(): ScrubberConfig {
           replacement: 'replaced',
         },
       },
-      'encryption.key': {
+      'encryption.key, second.key': {
         scrubber: 'staticScrubber',
         params: {
           replacement: 'replaced',