Frees & Avro schema fixes #13

pepegar · 2018-10-10T15:59:55Z

This PR:

renames frees/service.scala to frees/protocol.scala to be homogeneous with avro & protobuf
deletes droste contrib module that has been already contributed to droste.
adds helper methods to avro ADT
creates transformer between AvroF & FreesF schemata
creates a rendering algebra from AvroF[A] to circe.Json and creates the renderer from avro.Protocol[A] to circe.Json.

diesalbla

Few suggestions.

diesalbla · 2018-10-11T10:03:45Z

src/main/scala/avro/schema.scala

+            )): _*)
+      )
+      val withNamespace = namespace.fold(base) { n =>
+        base deepMerge Json.obj("namespace" -> Json.fromString(n))


In this particular case, would deepMerge be the same as:

base.mapObject( _.add ("namespace", Json.fromString(n) ) )

diesalbla · 2018-10-11T10:03:49Z

src/main/scala/avro/schema.scala

+        "name" -> Json.fromString(name),
+        "fields" -> Json.arr(
+          fields.map(
+            f =>


This 4-line lambda should go to an auxiliary function def fieldToObj?

diesalbla · 2018-10-11T10:12:23Z

src/main/scala/avro/schema.scala

+        "type"   -> Json.fromString("map"),
+        "values" -> values
+      )
+    case TRecord(name, namespace, aliases, doc, fields) =>


If you are into a bit of Origami-like programming, you could write this case as follows:

From each of namespace, aliases, and doc, compute an Option[( String, Json) ]:

val namespaceOF = namespace.map( n => "namespace" -> Json.fromString(n) _" val aliasesOF = if (aliases.isEmpty) None else Some( "aliases" -> Json.arr(aliases.map(Json.fromString): _*) ) val docOF = doc.map( f => "doc" -> Json.fromString(f) )

Add a function addField(js: Json, of: Option[(String, Json)]), which adds a field to a Json object.

Get the result as List(namespaceOF, aliasesOF, docOF).foldLeft(base)(addField)

An alternative, but I would not say if it is cleaner. At your taste.

Another alternative is that you start with the list of fields of base, with type, name, fields; and you make namespaceOf or aliasesOf into lists (empty or single), and you concatenate those lists, and apply the Json.obj constructor at the end

juanpedromoreno · 2018-10-12T14:09:43Z

build.sbt

@@ -59,7 +59,8 @@ lazy val commonSettings = Seq(
  ThisBuild / scalacOptions -= "-Xplugin-require:macroparadise",
  libraryDependencies ++= Seq(
    %%("cats-core"),
-    "io.higherkindness" %% "droste-core" % "0.3.1",
+    "io.higherkindness" %% "droste-core"     % "0.5.0",
+    "io.higherkindness" %% "droste-macros"     % "0.5.0",


Odd formatting here, we might want to apply the scalafmt syntax also for the sbt files.. makes sense?

juanpedromoreno · 2018-10-12T14:20:05Z

src/main/scala/freestyle/protocol.scala

+  case object AvroWithSchema extends SerializationType
+}
+
+case class Protocol[T](


juanpedromoreno · 2018-10-12T14:20:39Z

src/main/scala/freestyle/protocol.scala

+  }
+}
+
+case class Service[T](name: String, serializationType: SerializationType, operations: List[Service.Operation[T]])


final case class?

andyscott · 2018-10-13T12:09:14Z

src/main/scala/avro/Protocol.scala

+      "request" -> Json.arr(
+        Json.obj(
+          "name" -> Json.fromString("arg"), //TODO: is this doable?
+          "type" -> scheme.cata(AvroF.toJson).apply(message.request)


I'd recommend caching/saving scheme.cata(AvroF.toJson) to a val (or lazy val) and then calling it here.

andyscott · 2018-10-13T12:09:24Z

src/main/scala/avro/Protocol.scala

+          "type" -> scheme.cata(AvroF.toJson).apply(message.request)
+        )
+      ),
+      "response" -> scheme.cata(AvroF.toJson).apply(message.response)


Same as above.

andyscott · 2018-10-13T12:11:52Z

src/main/scala/avro/Protocol.scala

+    case FreesF.TOption(value)         => tUnion(NonEmptyList(tNull[T]().embed, List(value)))
+    case FreesF.TList(value)           => tArray(value)
+    case FreesF.TMap(value)            => tMap(value)
+    case FreesF.TGeneric(_, _)         => ??? // WAT


For the long term, you could do a TransM through Option to account for this failure scenario.

yeah, it's in my plans, but I need to do some changes to droste's traverse derivation, since its a bit far from flawless so far... (I need traverse to be able to use M version of recursion schemes, and I don't want to implement by hand now :))

andyscott · 2018-10-13T12:13:35Z

src/main/scala/freestyle/protocol.scala

+
+case class Service[T](name: String, serializationType: SerializationType, operations: List[Service.Operation[T]])
+object Service {
+  case class Operation[T](name: String, request: T, response: T)


andyscott · 2018-10-13T12:14:06Z

src/main/scala/freestyle/schema.scala

@@ -40,46 +40,49 @@ object FreesF {
  case class TOption[A](value: A)                              extends FreesF[A]
  case class TList[A](value: A)                                extends FreesF[A]
  case class TMap[A](value: A)                                 extends FreesF[A]
+  case class TGeneric[A](generic: A, params: List[A])          extends FreesF[A]
  case class TRequired[A](value: A)                            extends FreesF[A]
  case class TCoproduct[A](invariants: NonEmptyList[A])        extends FreesF[A]
  case class TSum[A](name: String, fields: List[String])       extends FreesF[A]
  case class TProduct[A](name: String, fields: List[Field[A]]) extends FreesF[A]


even more final :)

pepegar changed the title ~~Frees schema fixes~~ Frees & Avro schema fixes Oct 10, 2018

pepegar requested a review from a team October 11, 2018 09:08

pepegar mentioned this pull request Oct 11, 2018

create a new approach for pretty printing #14

Closed

diesalbla reviewed Oct 11, 2018

View reviewed changes

juanpedromoreno approved these changes Oct 12, 2018

View reviewed changes

andyscott reviewed Oct 13, 2018

View reviewed changes

pepegar added 10 commits October 19, 2018 22:11

adapt frees protocol

b56a85b

rename file

da1111f

add Generic type for FreesF schemata

b669c95

add helper methods to avro adt

4e801b6

add render utility to avro schema

ee25ef9

create transformer between FreesF & AvroF schemata

76b9542

bump droste version

8ef2147

delete droste.contrib module

6c2e270

create json render for AvroF protocol

a0d89bf

fix test

1ffa734

pepegar force-pushed the frees-schema-fixes branch from 532fdf6 to 1ffa734 Compare October 19, 2018 20:13

pepegar added 4 commits October 19, 2018 22:17

extract field2obj

ecc3e70

use neo-sbt-scalafmt & scalafmt everything :D

d35a000

make all case classes final

2f2ede2

cache catamorphism to a variable instead of invoking scheme.cata

ef9316f

pepegar force-pushed the frees-schema-fixes branch from ec0c249 to ef9316f Compare October 19, 2018 20:43

neo-sbt-scalafmt crashes on 2.11

6bcc5a9

pepegar merged commit 8e78eb9 into master Oct 19, 2018

pepegar deleted the frees-schema-fixes branch October 20, 2018 11:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Frees & Avro schema fixes #13

Frees & Avro schema fixes #13

pepegar commented Oct 10, 2018 •

edited

Loading

diesalbla left a comment

diesalbla Oct 11, 2018

diesalbla Oct 11, 2018

diesalbla Oct 11, 2018

diesalbla Oct 11, 2018 •

edited

Loading

juanpedromoreno Oct 12, 2018

juanpedromoreno Oct 12, 2018

juanpedromoreno Oct 12, 2018

andyscott Oct 13, 2018

andyscott Oct 13, 2018

andyscott Oct 13, 2018

pepegar Oct 19, 2018

andyscott Oct 13, 2018

andyscott Oct 13, 2018

Frees & Avro schema fixes #13

Frees & Avro schema fixes #13

Conversation

pepegar commented Oct 10, 2018 • edited Loading

diesalbla left a 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

diesalbla Oct 11, 2018 • 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

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

pepegar commented Oct 10, 2018 •

edited

Loading

diesalbla Oct 11, 2018 •

edited

Loading