Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ZIO Config: Don't Split Values Unless A Sequence Is Expected #7724

Merged
merged 2 commits into from
Jan 19, 2023
Merged

ZIO Config: Don't Split Values Unless A Sequence Is Expected #7724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
903b846
don't split values unless a sequence is expected
adamgfraser Jan 18, 2023
7aab460
cleanup
adamgfraser Jan 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions core-tests/shared/src/test/scala/zio/ConfigProviderSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,12 @@ object ConfigProviderSpec extends ZIOBaseSpec {
_ <- TestSystem.putProperty("key", "value")
result <- ZIO.config(Config.string("key").optional)
} yield assertTrue(result == Some("value"))
} +
test("values are not split unless a sequence is expected") {
for {
_ <- TestSystem.putProperty("greeting", "Hello, World!")
result <- ZIO.config(Config.string("greeting"))
} yield assertTrue(result == "Hello, World!")
}
}
}
141 changes: 94 additions & 47 deletions core/shared/src/main/scala/zio/ConfigProvider.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@ trait ConfigProvider { self =>
*/
def load[A](config: Config[A])(implicit trace: Trace): IO[Config.Error, A]

/**
* Flattens this config provider into a simplified config provider that knows
* only how to deal with flat (key/value) properties.
*/
def flatten: ConfigProvider.Flat =
new ConfigProvider.Flat {
def load[A](path: Chunk[String], config: Config.Primitive[A])(implicit trace: Trace): IO[Config.Error, Chunk[A]] =
ZIO.die(new NotImplementedError("ConfigProvider#flatten"))
def enumerateChildren(path: Chunk[String])(implicit trace: Trace): IO[Config.Error, Set[String]] =
ZIO.die(new NotImplementedError("ConfigProvider#flatten"))
}

/**
* Returns a new config provider that will automatically nest all
* configuration under the specified property name. This can be utilized to
Expand All @@ -44,18 +56,6 @@ trait ConfigProvider { self =>
*/
final def orElse(that: ConfigProvider): ConfigProvider =
ConfigProvider.fromFlat(self.flatten.orElse(that.flatten))

/**
* Flattens this config provider into a simplified config provider that knows
* only how to deal with flat (key/value) properties.
*/
def flatten: ConfigProvider.Flat =
new ConfigProvider.Flat {
def load[A](path: Chunk[String], config: Config.Primitive[A])(implicit trace: Trace): IO[Config.Error, Chunk[A]] =
ZIO.die(new NotImplementedError("ConfigProvider#flatten"))
def enumerateChildren(path: Chunk[String])(implicit trace: Trace): IO[Config.Error, Set[String]] =
ZIO.die(new NotImplementedError("ConfigProvider#flatten"))
}
}
object ConfigProvider {

Expand All @@ -69,12 +69,33 @@ object ConfigProvider {

def enumerateChildren(path: Chunk[String])(implicit trace: Trace): IO[Config.Error, Set[String]]

final def orElse(that: Flat): Flat =
def load[A](path: Chunk[String], config: Config.Primitive[A], split: Boolean)(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
load(path, config)

final def nested(name: String): Flat =
new Flat {
override def load[A](path: Chunk[String], config: Config.Primitive[A], split: Boolean)(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
self.load(name +: path, config, split)
def enumerateChildren(path: Chunk[String])(implicit trace: Trace): IO[Config.Error, Set[String]] =
self.enumerateChildren(name +: path)
def load[A](path: Chunk[String], config: Config.Primitive[A])(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
self.load(path, config).catchAll(e1 => that.load(path, config).catchAll(e2 => ZIO.fail(e1 || e2)))
load(path, config, true)
}

final def orElse(that: Flat): Flat =
new Flat {
override def load[A](path: Chunk[String], config: Config.Primitive[A], split: Boolean)(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
self
.load(path, config, split)
.catchAll(e1 => that.load(path, config, split).catchAll(e2 => ZIO.fail(e1 || e2)))
def enumerateChildren(path: Chunk[String])(implicit trace: Trace): IO[Config.Error, Set[String]] =
for {
l <- self.enumerateChildren(path).either
Expand All @@ -86,16 +107,10 @@ object ConfigProvider {
case (Right(l), Right(r)) => ZIO.succeed(l ++ r)
}
} yield result
}

final def nested(name: String): Flat =
new Flat {
def load[A](path: Chunk[String], config: Config.Primitive[A])(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
self.load(name +: path, config)
def enumerateChildren(path: Chunk[String])(implicit trace: Trace): IO[Config.Error, Set[String]] =
self.enumerateChildren(name +: path)
load(path, config, true)
}
}
object Flat {
Expand All @@ -108,17 +123,30 @@ object ConfigProvider {
path: Chunk[String],
name: String,
primitive: Config.Primitive[A],
escapedDelim: String
escapedDelim: String,
split: Boolean
): IO[Config.Error, Chunk[A]] = {
val name = path.lastOption.getOrElse("<unnamed>")
val unsplit = primitive == Config.Secret
val name = path.lastOption.getOrElse("<unnamed>")

if (unsplit) ZIO.fromEither(primitive.parse(text)).map(Chunk(_))
if (!split)
ZIO
.fromEither(primitive.parse(text))
.map(Chunk(_))
.mapError(_.prefixed(path))
else
ZIO
.foreach(splitPathString(text, escapedDelim))(s => ZIO.fromEither(primitive.parse(s.trim)))
.mapError(_.prefixed(path))
}

def parsePrimitive[A](
text: String,
path: Chunk[String],
name: String,
primitive: Config.Primitive[A],
escapedDelim: String
): IO[Config.Error, Chunk[A]] =
parsePrimitive(text, path, name, primitive, escapedDelim, true)
}
}

Expand All @@ -134,7 +162,7 @@ object ConfigProvider {

def consoleProvider(seqDelim: String = ","): ConfigProvider =
fromFlat(new Flat {
def load[A](path: Chunk[String], primitive: Config.Primitive[A])(implicit
override def load[A](path: Chunk[String], primitive: Config.Primitive[A], split: Boolean)(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] = {
val name = path.lastOption.getOrElse("<unnamed>")
Expand All @@ -145,12 +173,11 @@ object ConfigProvider {
"There was a problem reading configuration from the console",
Cause.fail(e)
)
val isText = primitive == Config.Text || primitive == Config.Secret

for {
_ <- Console.printLine(s"Please enter ${description} for property ${name}:").mapError(sourceError)
line <- Console.readLine.mapError(sourceError)
results <- Flat.util.parsePrimitive(line, path, name, primitive, ",")
results <- Flat.util.parsePrimitive(line, path, name, primitive, ",", split)
} yield results
}

Expand All @@ -162,6 +189,11 @@ object ConfigProvider {
Config.Error
.SourceUnavailable(path, "There was a problem reading configuration from the console", Cause.fail(e))
)

def load[A](path: Chunk[String], primitive: Config.Primitive[A])(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
load(path, primitive, true)
})

lazy val defaultProvider: ConfigProvider =
Expand Down Expand Up @@ -197,7 +229,7 @@ object ConfigProvider {
def makePathString(path: Chunk[String]): String = path.mkString(pathDelim).toUpperCase
def unmakePathString(pathString: String): Chunk[String] = Chunk.fromArray(pathString.split(escapedPathDelim))

def load[A](path: Chunk[String], primitive: Config.Primitive[A])(implicit
override def load[A](path: Chunk[String], primitive: Config.Primitive[A], split: Boolean)(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] = {
val pathString = makePathString(path)
Expand All @@ -210,7 +242,7 @@ object ConfigProvider {
ZIO
.fromOption(valueOpt)
.mapError(_ => Config.Error.MissingData(path, s"Expected ${pathString} to be set in the environment"))
results <- Flat.util.parsePrimitive(value, path, name, primitive, escapedSeqDelim)
results <- Flat.util.parsePrimitive(value, path, name, primitive, escapedSeqDelim, split)
} yield results
}

Expand All @@ -221,6 +253,11 @@ object ConfigProvider {
keyPaths.filter(_.startsWith(path)).map(_.drop(path.length).take(1)).flatten.toSet

}.mapError(sourceUnavailable(path))

def load[A](path: Chunk[String], primitive: Config.Primitive[A])(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
load(path, primitive, true)
})

/**
Expand All @@ -245,45 +282,45 @@ object ConfigProvider {
(leftExtension, rightExtension)
}

def loop[A](prefix: Chunk[String], config: Config[A])(implicit
def loop[A](prefix: Chunk[String], config: Config[A], split: Boolean)(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
config match {
case fallback: Fallback[A] =>
loop(prefix, fallback.first).catchAll(e1 =>
if (fallback.condition(e1)) loop(prefix, fallback.second).catchAll(e2 => ZIO.fail(e1 || e2))
loop(prefix, fallback.first, split).catchAll(e1 =>
if (fallback.condition(e1)) loop(prefix, fallback.second, split).catchAll(e2 => ZIO.fail(e1 || e2))
else ZIO.fail(e1)
)

case Described(config, _) => loop(prefix, config)
case Described(config, _) => loop(prefix, config, split)

case Lazy(thunk) => loop(prefix, thunk())
case Lazy(thunk) => loop(prefix, thunk(), split)

case MapOrFail(original, f) =>
loop(prefix, original).flatMap { as =>
loop(prefix, original, split).flatMap { as =>
ZIO.foreach(as)(a => ZIO.fromEither(f(a)).mapError(_.prefixed(prefix)))
}

case Sequence(config) =>
loop(prefix, config).map(Chunk(_))
loop(prefix, config, true).map(Chunk(_))

case Nested(name, config) =>
loop(prefix ++ Chunk(name), config)
loop(prefix ++ Chunk(name), config, split)

case table: Table[valueType] =>
import table.valueConfig
for {
keys <- flat.enumerateChildren(prefix)
values <- ZIO.foreach(Chunk.fromIterable(keys))(key => loop(prefix ++ Chunk(key), valueConfig))
values <- ZIO.foreach(Chunk.fromIterable(keys))(key => loop(prefix ++ Chunk(key), valueConfig, split))
} yield
if (values.isEmpty) Chunk(Map.empty[String, valueType])
else values.transpose.map(values => keys.zip(values).toMap)

case zipped: Zipped[leftType, rightType, c] =>
import zipped.{left, right, zippable}
for {
l <- loop(prefix, left).either
r <- loop(prefix, right).either
l <- loop(prefix, left, split).either
r <- loop(prefix, right, split).either
result <- (l, r) match {
case (Left(e1), Left(e2)) => ZIO.fail(e1 && e2)
case (Left(e1), Right(_)) => ZIO.fail(e1)
Expand Down Expand Up @@ -323,15 +360,15 @@ object ConfigProvider {

case primitive: Primitive[A] =>
for {
vs <- flat.load(prefix, primitive)
vs <- flat.load(prefix, primitive, split)
result <- if (vs.isEmpty)
ZIO.fail(primitive.missingError(prefix.lastOption.getOrElse("<n/a>")))
else ZIO.succeed(vs)
} yield result
}

def load[A](config: Config[A])(implicit trace: Trace): IO[Config.Error, A] =
loop(Chunk.empty, config).flatMap { chunk =>
loop(Chunk.empty, config, false).flatMap { chunk =>
chunk.headOption match {
case Some(a) => ZIO.succeed(a)
case _ =>
Expand All @@ -353,7 +390,7 @@ object ConfigProvider {
def makePathString(path: Chunk[String]): String = path.mkString(pathDelim)
def unmakePathString(pathString: String): Chunk[String] = Chunk.fromArray(pathString.split(escapedPathDelim))

def load[A](path: Chunk[String], primitive: Config.Primitive[A])(implicit
override def load[A](path: Chunk[String], primitive: Config.Primitive[A], split: Boolean)(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] = {
val pathString = makePathString(path)
Expand All @@ -365,7 +402,7 @@ object ConfigProvider {
value <- ZIO
.fromOption(valueOpt)
.mapError(_ => Config.Error.MissingData(path, s"Expected ${pathString} to be set in properties"))
results <- Flat.util.parsePrimitive(value, path, name, primitive, escapedSeqDelim)
results <- Flat.util.parsePrimitive(value, path, name, primitive, escapedSeqDelim, split)
} yield results
}

Expand All @@ -375,6 +412,11 @@ object ConfigProvider {

keyPaths.filter(_.startsWith(path)).map(_.drop(path.length).take(1)).flatten.toSet
}

def load[A](path: Chunk[String], primitive: Config.Primitive[A])(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
load(path, primitive, true)
})

/**
Expand All @@ -392,7 +434,7 @@ object ConfigProvider {
def makePathString(path: Chunk[String]): String = path.mkString(pathDelim)
def unmakePathString(pathString: String): Chunk[String] = Chunk.fromArray(pathString.split(escapedPathDelim))

def load[A](path: Chunk[String], primitive: Config.Primitive[A])(implicit
override def load[A](path: Chunk[String], primitive: Config.Primitive[A], split: Boolean)(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] = {
val pathString = makePathString(path)
Expand All @@ -404,7 +446,7 @@ object ConfigProvider {
value <- ZIO
.fromOption(valueOpt)
.mapError(_ => Config.Error.MissingData(path, s"Expected ${pathString} to be set in properties"))
results <- Flat.util.parsePrimitive(value, path, name, primitive, escapedSeqDelim)
results <- Flat.util.parsePrimitive(value, path, name, primitive, escapedSeqDelim, split)
} yield results
}

Expand All @@ -414,6 +456,11 @@ object ConfigProvider {

keyPaths.filter(_.startsWith(path)).map(_.drop(path.length).take(1)).flatten.toSet
}.mapError(sourceUnavailable(path))

def load[A](path: Chunk[String], primitive: Config.Primitive[A])(implicit
trace: Trace
): IO[Config.Error, Chunk[A]] =
load(path, primitive, true)
})

/**
Expand Down