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

[gen] adding support for "Any" and "AnyObject" as json in codegen #3205

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+215 −94
Open

[gen] adding support for "Any" and "AnyObject" as json in codegen #3205

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c871b96
partial support for Json.Obj started
hochgi Nov 12, 2024
f34b87a
[gen] adding support for "Any" and "AnyObject" as Json in codegen
hochgi Nov 12, 2024
d4ef6d4
better condition logic now properly handles correctly these cases:
hochgi Nov 13, 2024
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: 5 additions & 1 deletion zio-http-gen/src/main/scala/zio/http/gen/openapi/EndpointGen.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1026,6 +1026,7 @@ final case class EndpointGen(config: Config) {
properties.map { case (name, schema) => name -> schema.withoutAnnotations }.collect {
case (name, schema)
if !schema.isInstanceOf[JsonSchema.RefSchema]
&& !(schema == JsonSchema.AnyJson)
&& !schema.isPrimitive
&& !schema.isCollection =>
schemaToCode(schema, openAPI, name.capitalize, Chunk.empty)
Expand Down Expand Up @@ -1077,7 +1078,10 @@ final case class EndpointGen(config: Config) {
),
)
case JsonSchema.Null => throw new Exception("Null query parameters are not supported")
case JsonSchema.AnyJson => throw new Exception("AnyJson query parameters are not supported")
case JsonSchema.AnyJson => {
// throw new Exception("AnyJson query parameters are not supported")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did we previously throw exception?
Am I breaking some other validation now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@987Nabil any idea regarding this one?

None
}
}
}

Expand Down
3 changes: 3 additions & 0 deletions zio-http-gen/src/main/scala/zio/http/gen/scala/CodeGen.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,9 @@ object CodeGen {
case Code.TypeRef(name) =>
Nil -> name

case Code.ScalaType.JsonAST =>
List(Code.Import("zio.json.ast.Json")) -> "Json"

case scalaType =>
throw new Exception(s"Unknown ScalaType: $scalaType")
}
Expand Down
14 changes: 14 additions & 0 deletions zio-http-gen/src/test/resources/AnimalWithAny.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package test.component

import zio.json.ast.Json
import zio.schema._
import zio.schema.annotation.fieldName

case class Animal(
name: String,
eats: Json,
@fieldName("extra_attributes") extraAttributes: Map[String, Json],
)
object Animal {
implicit val codec: Schema[Animal] = DeriveSchema.gen[Animal]
}
49 changes: 49 additions & 0 deletions zio-http-gen/src/test/resources/inline_schema_any_and_any_object.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
info:
title: Animals Service
version: 0.0.1
tags:
- name: Animals_API
paths:
/api/v1/zoo/{animal}:
get:
operationId: get_animal
parameters:
- in: path
name: animal
schema:
type: string
required: true
tags:
- Animals_API
description: Get animals by species name
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Animal'
description: OK
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
description: Internal Server Error
openapi: 3.0.3
components:
schemas:
Animal:
type: object
required:
- name
- eats
- extra_attributes
properties:
name:
type: string
eats: {}
extra_attributes:
type: object
additionalProperties: true
Copy link
Contributor Author

@hochgi hochgi Nov 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should also test for all the 3 out of 4 possible cases we handle?

  extra_attributes:
    type: object
    additionalProperties: true

  extra_attributes:
    type: object
    additionalProperties: {}

  extra_attributes:
    additionalProperties: true

24 changes: 24 additions & 0 deletions zio-http-gen/src/test/scala/zio/http/gen/scala/CodeGenSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1002,6 +1002,30 @@ object CodeGenSpec extends ZIOSpecDefault {
}
}
} @@ TestAspect.exceptScala3,
test("Schema with any and any object") {
val openAPIString = stringFromResource("/inline_schema_any_and_any_object.yaml")

openApiFromYamlString(openAPIString) { oapi =>
codeGenFromOpenAPI(
oapi,
Config.default.copy(
fieldNamesNormalization = Config.default.fieldNamesNormalization.copy(enableAutomatic = true),
),
) { testDir =>
allFilesShouldBe(
testDir.toFile,
List(
"api/v1/zoo/Animal.scala",
"component/Animal.scala",
),
) && fileShouldBe(
testDir,
"component/Animal.scala",
"/AnimalWithAny.scala",
)
}
}
} @@ TestAspect.exceptScala3,
test("Generate all responses") {
val oapi =
OpenAPI(
Expand Down
198 changes: 105 additions & 93 deletions zio-http/shared/src/main/scala/zio/http/endpoint/openapi/JsonSchema.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,111 +254,123 @@ object JsonSchema {
.get

private[openapi] def fromSerializableSchema(schema: SerializableJsonSchema): JsonSchema = {
val additionalProperties = schema.additionalProperties match {
case Some(BoolOrSchema.BooleanWrapper(bool)) => Left(bool)
case Some(BoolOrSchema.SchemaWrapper(schema)) =>
val valuesSchema = fromSerializableSchema(schema)
Right(
schema.optionalKeySchema.fold(valuesSchema)(keySchema =>
valuesSchema.annotate(
MetaData.KeySchema(
fromSerializableSchema(keySchema),

// if type: object with additionalProperties defined,
// but nothing else, we should assume a free form object
def anyObject: Boolean = schema.additionalProperties.collect { case BoolOrSchema.BooleanWrapper(true) =>
schema.schemaType.contains(TypeOrTypes.Type("object")) &&
schema.productIterator.count(_.asInstanceOf[Option[_]].isDefined) == 2
hochgi marked this conversation as resolved.
Show resolved Hide resolved
}.exists(identity)

if (schema.productIterator.forall(_.asInstanceOf[Option[_]].isEmpty)) JsonSchema.AnyJson
else if (anyObject) JsonSchema.Object(Map.empty, Right(JsonSchema.AnyJson), Chunk.empty)
else {
val additionalProperties = schema.additionalProperties match {
case Some(BoolOrSchema.BooleanWrapper(bool)) => Left(bool)
case Some(BoolOrSchema.SchemaWrapper(schema)) =>
val valuesSchema = fromSerializableSchema(schema)
Right(
schema.optionalKeySchema.fold(valuesSchema)(keySchema =>
valuesSchema.annotate(
MetaData.KeySchema(
fromSerializableSchema(keySchema),
),
),
),
),
)
case None => Left(true)
}
)
case None => Left(true)
}

var jsonSchema: JsonSchema = schema match {
case schema if schema.ref.isDefined =>
RefSchema(schema.ref.get)
case schema if schema.schemaType.contains(TypeOrTypes.Type("number")) =>
JsonSchema.Number(
NumberFormat.fromString(schema.format.getOrElse("double")),
schema.minimum.map(_.fold(identity, _.toDouble)),
schema.exclusiveMinimum.map(_.map(_.fold(identity, _.toDouble))),
schema.maximum.map(_.fold(identity, _.toDouble)),
schema.exclusiveMaximum.map(_.map(_.fold(identity, _.toDouble))),
)
case schema if schema.schemaType.contains(TypeOrTypes.Type("integer")) =>
JsonSchema.Integer(
IntegerFormat.fromString(schema.format.getOrElse("int64")),
schema.minimum.map(_.fold(_.toLong, identity)),
schema.exclusiveMinimum.map(_.map(_.fold(_.toLong, identity))),
schema.maximum.map(_.fold(_.toLong, identity)),
schema.exclusiveMaximum.map(_.map(_.fold(_.toLong, identity))),
)
case schema if schema.schemaType.contains(TypeOrTypes.Type("string")) && schema.enumValues.isEmpty =>
JsonSchema.String(
schema.format.map(StringFormat.fromString),
schema.pattern.map(Pattern.apply),
schema.minLength,
schema.maxLength,
)
case schema if schema.schemaType.contains(TypeOrTypes.Type("boolean")) =>
JsonSchema.Boolean
case schema if schema.schemaType.contains(TypeOrTypes.Type("array")) =>
JsonSchema.ArrayType(
schema.items.map(fromSerializableSchema),
schema.minItems,
schema.uniqueItems.contains(true),
)
case schema if schema.enumValues.isDefined =>
JsonSchema.Enum(schema.enumValues.get.map(EnumValue.fromJson))
case schema if schema.oneOf.isDefined =>
OneOfSchema(schema.oneOf.get.map(fromSerializableSchema))
case schema if schema.allOf.isDefined =>
AllOfSchema(schema.allOf.get.map(fromSerializableSchema))
case schema if schema.anyOf.isDefined =>
AnyOfSchema(schema.anyOf.get.map(fromSerializableSchema))
case schema if schema.schemaType.contains(TypeOrTypes.Type("null")) =>
JsonSchema.Null
case schema if schema.schemaType.contains(TypeOrTypes.Type("object")) || schema.schemaType.isEmpty =>
JsonSchema.Object(
schema.properties
.map(_.map { case (name, schema) => name -> fromSerializableSchema(schema) })
.getOrElse(Map.empty),
additionalProperties,
schema.required.getOrElse(Chunk.empty),
)
case _ =>
throw new IllegalArgumentException(s"Can't convert $schema")
}
var jsonSchema: JsonSchema = schema match {
case schema if schema.ref.isDefined =>
RefSchema(schema.ref.get)
case schema if schema.schemaType.contains(TypeOrTypes.Type("number")) =>
JsonSchema.Number(
NumberFormat.fromString(schema.format.getOrElse("double")),
schema.minimum.map(_.fold(identity, _.toDouble)),
schema.exclusiveMinimum.map(_.map(_.fold(identity, _.toDouble))),
schema.maximum.map(_.fold(identity, _.toDouble)),
schema.exclusiveMaximum.map(_.map(_.fold(identity, _.toDouble))),
)
case schema if schema.schemaType.contains(TypeOrTypes.Type("integer")) =>
JsonSchema.Integer(
IntegerFormat.fromString(schema.format.getOrElse("int64")),
schema.minimum.map(_.fold(_.toLong, identity)),
schema.exclusiveMinimum.map(_.map(_.fold(_.toLong, identity))),
schema.maximum.map(_.fold(_.toLong, identity)),
schema.exclusiveMaximum.map(_.map(_.fold(_.toLong, identity))),
)
case schema if schema.schemaType.contains(TypeOrTypes.Type("string")) && schema.enumValues.isEmpty =>
JsonSchema.String(
schema.format.map(StringFormat.fromString),
schema.pattern.map(Pattern.apply),
schema.minLength,
schema.maxLength,
)
case schema if schema.schemaType.contains(TypeOrTypes.Type("boolean")) =>
JsonSchema.Boolean
case schema if schema.schemaType.contains(TypeOrTypes.Type("array")) =>
JsonSchema.ArrayType(
schema.items.map(fromSerializableSchema),
schema.minItems,
schema.uniqueItems.contains(true),
)
case schema if schema.enumValues.isDefined =>
JsonSchema.Enum(schema.enumValues.get.map(EnumValue.fromJson))
case schema if schema.oneOf.isDefined =>
OneOfSchema(schema.oneOf.get.map(fromSerializableSchema))
case schema if schema.allOf.isDefined =>
AllOfSchema(schema.allOf.get.map(fromSerializableSchema))
case schema if schema.anyOf.isDefined =>
AnyOfSchema(schema.anyOf.get.map(fromSerializableSchema))
case schema if schema.schemaType.contains(TypeOrTypes.Type("null")) =>
JsonSchema.Null
case schema if schema.schemaType.contains(TypeOrTypes.Type("object")) || schema.schemaType.isEmpty =>
JsonSchema.Object(
schema.properties
.map(_.map { case (name, schema) => name -> fromSerializableSchema(schema) })
.getOrElse(Map.empty),
additionalProperties,
schema.required.getOrElse(Chunk.empty),
)
case _ =>
throw new IllegalArgumentException(s"Can't convert $schema")
}

val examples = Chunk.fromIterable(schema.example) ++ schema.examples.getOrElse(Chunk.empty)
if (examples.nonEmpty) jsonSchema = jsonSchema.examples(examples)
val examples = Chunk.fromIterable(schema.example) ++ schema.examples.getOrElse(Chunk.empty)
if (examples.nonEmpty) jsonSchema = jsonSchema.examples(examples)

schema.description match {
case Some(value) => jsonSchema = jsonSchema.description(value)
case None => ()
}
schema.description match {
case Some(value) => jsonSchema = jsonSchema.description(value)
case None => ()
}

schema.nullable match {
case Some(value) => jsonSchema = jsonSchema.nullable(value)
case None => ()
}
schema.nullable match {
case Some(value) => jsonSchema = jsonSchema.nullable(value)
case None => ()
}

schema.discriminator match {
case Some(value) => jsonSchema = jsonSchema.discriminator(value)
case None => ()
}
schema.discriminator match {
case Some(value) => jsonSchema = jsonSchema.discriminator(value)
case None => ()
}

schema.contentEncoding.flatMap(ContentEncoding.fromString) match {
case Some(value) => jsonSchema = jsonSchema.contentEncoding(value)
case None => ()
}
schema.contentEncoding.flatMap(ContentEncoding.fromString) match {
case Some(value) => jsonSchema = jsonSchema.contentEncoding(value)
case None => ()
}

schema.contentMediaType match {
case Some(value) => jsonSchema = jsonSchema.contentMediaType(value)
case None => ()
}
schema.contentMediaType match {
case Some(value) => jsonSchema = jsonSchema.contentMediaType(value)
case None => ()
}

jsonSchema = jsonSchema.default(schema.default)
jsonSchema = jsonSchema.default(schema.default)

jsonSchema = jsonSchema.deprecated(schema.deprecated.getOrElse(false))
jsonSchema = jsonSchema.deprecated(schema.deprecated.getOrElse(false))

jsonSchema
jsonSchema
}
}

def fromTextCodec(codec: TextCodec[_]): JsonSchema =
Expand Down
Loading