Use zio.Config.Switch for discriminated sum types #1167

guersam · 2023-05-07T14:20:50Z

Use zio.Config.Switch for discriminated sum types
Fix zio.Config.Switch match error in docs and syntax
Rename nameWithLabel to discriminator Rename nameWithLabel with discriminator #1132
Fix Config[Either[A, B]] derivation in Scala 3
Drop Scala 2.11 (Drop Support For Scala 2.11 zio#7896)

guersam · 2023-05-07T15:40:40Z

Fixed Scala 3 derivation, ignoring failing MarkdownSpec for now.

guersam · 2023-05-09T06:49:39Z

core/shared/src/main/scala/zio/config/ConfigDocsModule.scala

+          ConfigDocs.DynamicMap(
+            loop(descriptions, c, latestPath, alreadySeen),
+            map.map { case (k, v) =>
+              k.toString -> loop(descriptions, v, latestPath, alreadySeen)


In most cases k will be String, but I wonder if there could be a better support for polymorphic key type of Config.Switch[A, B].

It's going to be hard at DynamicMap level in zio core, as this key gets propagated all over.

guersam · 2023-05-09T06:51:41Z

magnolia/shared/src/main/scala-2.12-2.13/zio/config/magnolia/DeriveConfig.scala

@@ -9,7 +9,7 @@ import java.time.{LocalDate, LocalDateTime, LocalTime}
 import java.util.UUID
 import scala.collection.immutable

-final case class DeriveConfig[T](desc: Config[T], isObject: Boolean = false) {
+final case class DeriveConfig[T](desc: Config[T], isObject: Boolean = false, constValue: Option[T] = None) {


This is necessary to support Config.Switch, but I wonder if there is a better way, or at least replace isObject with constValue.isDefined.

guersam · 2023-05-09T06:53:29Z

magnolia/shared/src/main/scala-dotty/zio/config/magnolia/DeriveConfig.scala


  object Metadata {
-    final case class Object(name: ProductName) extends Metadata
+    final case class Object[T](name: ProductName, constValue: T) extends Metadata


Does this T look okay?

guersam · 2023-05-09T06:58:42Z

magnolia/shared/src/test/scala-dotty/zio/config/magnolia/MarkdownSpec.scala

@@ -210,7 +210,7 @@ object MarkdownSpec extends BaseSpec {

      assert(result)(equalTo(expectedMarkdown))
    }
-  )
+  ) @@ TestAspect.ignore


BTW, what's the purpose of this spec which exists only in Scala 3?

guersam · 2023-05-09T07:05:29Z

magnolia/shared/src/test/scala-dotty/zio/config/magnolia/AutomaticConfigSpec.scala

  sealed trait Credentials

  case class Password(value: String) extends Credentials

  case class Token(value: String) extends Credentials

+  case object InstanceProfile extends Credentials


In addition to preventing match errors, this PR enables this specific use case - discriminated sealed traits having case objects as children.

guersam · 2023-05-10T06:08:47Z

core/shared/src/main/scala/zio/config/syntax/ConfigSyntax.scala

+          case config: FallbackWith[B]        => FallbackWith(loop(config.first), loop(config.second), config.f)
+          case config: Fallback[B]            => Fallback(loop(config.first), loop(config.second))
+          case Sequence(config)               => Sequence(loop(config))
+          case Switch(config, map)            => Switch(config, map.map { case (k, v) => k -> loop(v) })


BTW, I wonder if Config#mapKey extension method is still necessary, because now I found it more idiomatic to adjust the keys using ConfigProvider. (e.g. ConfigProvider#kebabCase)

I think we will keep it for now.

hearnadam · 2023-05-10T19:27:30Z

core/shared/src/main/scala/zio/config/syntax/ConfigSyntax.scala

@@ -343,8 +344,7 @@ trait ConfigSyntax {
    //        override def flatten: IndexedFlat = indexedFlat
    //      }

-
-    //Disabled until next version of ZIO: https://github.com/zio/zio-config/blob/avoid_custom_index_until_3/README.md#indexed-map-array-datatype-and-a-some-implementation-notes
+    // Disabled until next version of ZIO: https://github.com/zio/zio-config/blob/avoid_custom_index_until_3/README.md#indexed-map-array-datatype-and-a-some-implementation-notes


Looks like the change was unrelated, but this link appears to be dead.

I guess the whole function is obsolete as ConfigProvider.fromMap is builtin now.

Or maybe it's still relevant. The section seems to be moved to here:
https://github.com/zio/zio-config/blob/v4.0.0-RC15/docs/read-from-various-sources.md#indexed-map-array-datatype-and-a-some-implementation-notes

afsalthaj · 2023-05-12T16:42:32Z

Could you resolve conflicts? May be that will fix the format changes, so we could focus only the specific changes.

guersam · 2023-05-14T08:44:09Z

@afsalthaj Resolved conflicts.

guersam · 2023-05-15T08:24:24Z

magnolia/shared/src/test/scala-2.12-2.13/zio/config/magnolia/AutomaticConfigSpec.scala

@@ -26,13 +26,17 @@ object AutomaticConfigTest extends ZIOSpecDefault {
    )
 }

-object AutomaticConfigTestUtils {
+object AutomaticConfigSpecUtils {


For API consistency, I'd like to make this spec shared between Scala 2 and 3. What do you think?

Yes, something that was in my radar as well. Agree.

afsalthaj · 2023-05-15T09:10:22Z

derivation/shared/src/main/scala/zio/config/derivation/annotations.scala

 * as `keyName`.
 *
 * Example:
 * {{{
- *       @nameWithLabel("type")
+ *       @discriminator("type")


afsalthaj · 2023-05-15T09:15:47Z

Thanks for the contribution.

guersam added 2 commits May 7, 2023 23:30

Use zio.Config.Switch for discriminated sum types

a3181de

Rename nameWithLabel to discriminator

547259b

guersam force-pushed the switch branch from 9240240 to 547259b Compare May 7, 2023 14:30

guersam marked this pull request as ready for review May 7, 2023 14:30

guersam requested a review from a team as a code owner May 7, 2023 14:30

guersam added 2 commits May 7, 2023 23:50

Fix Scala 2.12

280a545

Drop Scala 2.11

3fa819d

guersam force-pushed the switch branch from b2e3d27 to 3fa819d Compare May 7, 2023 14:56

guersam added 4 commits May 8, 2023 00:03

Run magnolia tests in Scala 3

b7d8f5a

Increase -Xmax-inlines for magnolia

870623b

Small cleanup

39790df

Revert and ignore MarkdownSpec in Scala 3

9dcd2a6

guersam commented May 9, 2023

View reviewed changes

guersam commented May 10, 2023

View reviewed changes

hearnadam reviewed May 10, 2023

View reviewed changes

Merge remote-tracking branch 'origin/series/4.x' into switch

5b1a2e2

guersam commented May 15, 2023

View reviewed changes

afsalthaj reviewed May 15, 2023

View reviewed changes

afsalthaj approved these changes May 15, 2023

View reviewed changes

afsalthaj merged commit 07c878e into zio:series/4.x May 15, 2023
26 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use zio.Config.Switch for discriminated sum types #1167

Use zio.Config.Switch for discriminated sum types #1167

guersam commented May 7, 2023 •

edited

Loading

guersam commented May 7, 2023

guersam May 9, 2023

afsalthaj May 15, 2023

guersam May 9, 2023

guersam May 9, 2023

guersam May 9, 2023

guersam May 9, 2023 •

edited

Loading

guersam May 10, 2023

afsalthaj May 15, 2023

hearnadam May 10, 2023

guersam May 11, 2023

guersam May 11, 2023

afsalthaj commented May 12, 2023

guersam commented May 14, 2023

guersam May 15, 2023

afsalthaj May 15, 2023

afsalthaj May 15, 2023

afsalthaj commented May 15, 2023

Use zio.Config.Switch for discriminated sum types #1167

Use zio.Config.Switch for discriminated sum types #1167

Conversation

guersam commented May 7, 2023 • edited Loading

guersam commented May 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guersam May 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afsalthaj commented May 12, 2023

guersam commented May 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afsalthaj commented May 15, 2023

guersam commented May 7, 2023 •

edited

Loading

guersam May 9, 2023 •

edited

Loading