made Config.redacted more general (#3873)

Co-authored-by: maksim.khramtsov <maksim.khramtsov@btsdigital.kz>

.changeset/tidy-trainers-serve.md

@@ -0,0 +1,22 @@
+---
+"effect": minor
+---
+
+`Config.redacted` has been made more flexible and can now wrap any other config. This allows to transform or validate config values before it’s hidden.
+
+```ts
+import { Config } from "effect"
+
+Effect.gen(function* () {
+  // can be any string including empty
+  const pass1 = yield* Config.redacted("PASSWORD")
+  //    ^? Redacted<string>
+
+  // can't be empty string
+  const pass2 = yield* Config.redacted(Config.nonEmptyString("PASSWORD"))
+  //    ^? Redacted<string>
+
+  const pass2 = yield* Config.redacted(Config.number("SECRET_NUMBER"))
+  //    ^? Redacted<number>
+})
+```

packages/effect/src/Config.ts

@@ -357,7 +357,10 @@ export const secret: (name?: string) => Config<Secret.Secret> = internal.secret
  * @since 2.0.0
  * @category constructors
  */
-export const redacted: (name?: string) => Config<Redacted.Redacted> = internal.redacted
+export const redacted: {
+  (name?: string): Config<Redacted.Redacted>
+  <A>(config: Config<A>): Config<Redacted.Redacted<A>>
+} = internal.redacted
 
 /**
  * Constructs a config for a sequence of values.

packages/effect/src/internal/config.ts

@@ -437,12 +437,11 @@ export const secret = (name?: string): Config.Config<Secret.Secret> => {
 }
 
 /** @internal */
-export const redacted = (name?: string): Config.Config<Redacted.Redacted> => {
-  const config = primitive(
-    "a redacted property",
-    (text) => Either.right(redacted_.make(text))
-  )
-  return name === undefined ? config : nested(config, name)
+export const redacted = <A>(
+  nameOrConfig?: string | Config.Config<A>
+): Config.Config<Redacted.Redacted<A | string>> => {
+  const config: Config.Config<A | string> = isConfig(nameOrConfig) ? nameOrConfig : string(nameOrConfig)
+  return map(config, redacted_.make)
 }
 
 /** @internal */

packages/effect/test/Config.test.ts

@@ -34,6 +34,16 @@ const assertSuccess = <A>(
   expect(result).toStrictEqual(Exit.succeed(a))
 }
 
+const assertEqualSuccess = <A>(
+  config: Config.Config<A>,
+  map: ReadonlyArray<readonly [string, string]>,
+  a: A
+) => {
+  const configProvider = ConfigProvider.fromMap(new Map(map))
+  const result = Effect.runSync(Effect.exit(configProvider.load(config)))
+  expect(Equal.equals(Exit.succeed(a), result)).toBe(true)
+}
+
 describe("Config", () => {
   describe("boolean", () => {
     it("name = undefined", () => {
@@ -534,7 +544,12 @@ describe("Config", () => {
 
     it("name != undefined", () => {
       const config = Config.redacted("SECRET")
-      assertSuccess(config, [["SECRET", "a"]], Redacted.make("a"))
+      assertEqualSuccess(config, [["SECRET", "a"]], Redacted.make("a"))
+    })
+
+    it("can wrap generic Config", () => {
+      const config = Config.redacted(Config.integer("NUM"))
+      assertEqualSuccess(config, [["NUM", "2"]], Redacted.make(2))
     })
   })
 
@@ -547,7 +562,7 @@ describe("Config", () => {
 
       it("name != undefined", () => {
         const config = Config.secret("SECRET")
-        assertSuccess(config, [["SECRET", "a"]], Secret.fromString("a"))
+        assertEqualSuccess(config, [["SECRET", "a"]], Secret.fromString("a"))
       })
     })