feat: add optional maxDepth option to recursive functions: containsPII, detect, redact, unwrapObject

Author: tdreyno

.eslintrc.js

@@ -24,5 +24,6 @@ module.exports = {
     "@typescript-eslint/no-unsafe-return": 0,
     "@typescript-eslint/no-unsafe-call": 0,
     "@typescript-eslint/no-unsafe-member-access": 0,
+    "@typescript-eslint/no-explicit-any": 0,
   },
 }

src/PIITry.ts

@@ -0,0 +1,9 @@
+import PII from "./pii"
+
+export default async function PIITry<S>(fn: () => S | Promise<S>): Promise<S> {
+  try {
+    return fn()
+  } catch (e) {
+    throw PII(e, "REDACTED_ERROR")
+  }
+}

src/__tests__/constructor.ts

@@ -1,4 +1,5 @@
-import { PII, unwrap } from "../index"
+import PII from "../pii"
+import unwrap from "../unwrap"
 
 describe("PII", () => {
   it("should not leak into toString", () => {

src/__tests__/containsPII.spec.ts

@@ -1,4 +1,5 @@
-import { PII, containsPII } from "../index"
+import PII from "../pii"
+import containsPII from "../containsPII"
 
 describe("containsPII", () => {
   it("should not find PII", () => {
@@ -20,4 +21,8 @@ describe("containsPII", () => {
     expect(containsPII([PII("test")])).toBeTruthy()
     expect(containsPII({ test: PII(1) })).toBeTruthy()
   })
+
+  it("should return true after max depth", () => {
+    expect(containsPII({ test: [{ hello: "world" }] }, 2)).toBeTruthy()
+  })
 })

src/__tests__/detect.spec.ts

@@ -1,5 +1,6 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { detect, isPII } from "../index"
+import { isPII } from "../pii"
+import detect from "../detect"
+import unwrap from "../unwrap"
 
 const detector = (data: unknown) => Array.isArray(data)
 
@@ -25,4 +26,10 @@ describe("detect", () => {
     const detectedArrays = detect(detector, { test: set })
     expect(isPII(Array.from((detectedArrays as any).test)[0])).toBeTruthy()
   })
+
+  it("should return PII after max depth", () => {
+    const result: any = detect(() => false, { test: [{ hello: "world" }] }, 2)
+
+    expect(unwrap(result.test[0])).toEqual({ hello: "world" })
+  })
 })

src/__tests__/fold.spec.ts

@@ -1,4 +1,6 @@
-import { PII, fold, unwrap } from "../index"
+import PII from "../pii"
+import fold from "../fold"
+import unwrap from "../unwrap"
 
 describe("fold", () => {
   it("should fold multiple PII", () => {

src/__tests__/map.spec.ts

@@ -1,4 +1,6 @@
-import { PII, map, unwrap } from "../index"
+import PII from "../pii"
+import map from "../map"
+import unwrap from "../unwrap"
 
 describe("map", () => {
   it("should map inside PII", () => {

src/__tests__/redact.spec.ts

@@ -1,4 +1,5 @@
-import { PII, redact } from "../index"
+import PII from "../pii"
+import redact from "../redact"
 
 const REDACTED = "REDACTED"
 const redactor = () => REDACTED
@@ -62,4 +63,10 @@ describe("redact", () => {
       two: REDACTED,
     })
   })
+
+  it("should return PII after max depth", () => {
+    expect(redact(redactor, { test: [{ hello: "world" }] }, 2)).toEqual({
+      test: [REDACTED],
+    })
+  })
 })

src/__tests__/tap.spec.ts

@@ -1,4 +1,6 @@
-import { PII, tap, unwrap } from "../index"
+import PII from "../pii"
+import tap from "../tap"
+import unwrap from "../unwrap"
 
 describe("tap", () => {
   it("should tap inside PII", () => {

src/__tests__/test.spec.ts

@@ -1,4 +1,5 @@
-import { PII, test } from "../index"
+import PII from "../pii"
+import test from "../test"
 
 describe("test", () => {
   it("should test predicate against PII", () => {