{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TupleSections #-}
-- | Defines functionality for the generation of models from OpenAPI schemas
module OpenAPI.Generate.Model
( getSchemaType,
resolveSchemaReferenceWithoutWarning,
getConstraintDescriptionsOfSchema,
defineModelForSchemaNamed,
defineModelForSchema,
TypeWithDeclaration,
)
where
import Control.Applicative
import Control.Monad
import qualified Data.Aeson as Aeson
import qualified Data.Aeson.Text as Aeson
import qualified Data.Bifunctor as BF
import qualified Data.Either as E
import qualified Data.Int as Int
import qualified Data.List as List
import Data.List.NonEmpty (NonEmpty)
import qualified Data.Map as Map
import qualified Data.Maybe as Maybe
import qualified Data.Scientific as Scientific
import qualified Data.Set as Set
import Data.Text (Text)
import qualified Data.Text as T
import qualified Data.Text.Lazy as LT
import Data.Time.Calendar
import Language.Haskell.TH
import Language.Haskell.TH.PprLib hiding ((<>))
import qualified OpenAPI.Common as OC
import OpenAPI.Generate.Doc (appendDoc, emptyDoc)
import qualified OpenAPI.Generate.Doc as Doc
import OpenAPI.Generate.Internal.Util
import qualified OpenAPI.Generate.ModelDependencies as Dep
import qualified OpenAPI.Generate.Monad as OAM
import qualified OpenAPI.Generate.OptParse as OAO
import OpenAPI.Generate.OptParse.Types
import qualified OpenAPI.Generate.Types as OAT
import qualified OpenAPI.Generate.Types.Schema as OAS
import Prelude hiding (maximum, minimum, not)
-- | The type of a model and the declarations needed for defining it
type TypeWithDeclaration = (Q Type, Dep.ModelContentWithDependencies)
type BangTypesSelfDefined = (Q [VarBangType], Q Doc, Dep.Models)
data TypeAliasStrategy = CreateTypeAlias | DontCreateTypeAlias
deriving (Show, Eq, Ord)
addDependencies :: Dep.Models -> OAM.Generator TypeWithDeclaration -> OAM.Generator TypeWithDeclaration
addDependencies dependenciesToAdd typeDef = do
(type', (content, dependencies)) <- typeDef
pure (type', (content, Set.union dependencies dependenciesToAdd))
-- | default derive clause for the objects
objectDeriveClause :: [Q DerivClause]
objectDeriveClause =
[ derivClause
Nothing
[ conT ''Show,
conT ''Eq
]
]
liftAesonValueWithOverloadedStrings :: Bool -> Aeson.Value -> Q Exp
liftAesonValueWithOverloadedStrings useOverloadedStrings (Aeson.String a) =
let s = stringE $ T.unpack a
in if useOverloadedStrings
then [|$s|]
else [|Aeson.String $s|]
liftAesonValueWithOverloadedStrings _ (Aeson.Number n) =
-- Without the manual handling of numbers, TH tries to use
-- `Scientific.Scientific` which is not exposed.
let coefficient = Scientific.coefficient n
base10Exponent = Scientific.base10Exponent n
in [|Aeson.Number (Scientific.scientific coefficient base10Exponent)|]
liftAesonValueWithOverloadedStrings _ a = [|a|]
liftAesonValue :: Aeson.Value -> Q Exp
liftAesonValue = liftAesonValueWithOverloadedStrings True
aesonValueToName :: Aeson.Value -> Text
aesonValueToName =
( \case
"" -> "EmptyString"
x -> x
)
. uppercaseFirstText
. T.replace "\"" ""
. showAesonValue
showAesonValue :: Aeson.Value -> Text
showAesonValue = LT.toStrict . Aeson.encodeToLazyText
-- | Defines all the models for a schema
defineModelForSchema :: Text -> OAS.Schema -> OAM.Generator Dep.ModelWithDependencies
defineModelForSchema schemaName schema = do
let aliasWithText description =
createAlias schemaName description CreateTypeAlias $
pure ([t|Aeson.Value|], (emptyDoc, Set.empty))
blackListAlias = aliasWithText "This alias is created because of the generator configuration and possibly could have a more precise type."
whiteListAlias = aliasWithText $ "This is just a type synonym and possibly could have a more precise type because the schema name @" <> schemaName <> "@ is not whitelisted."
settingOpaqueSchemas <- OAM.getSetting OAO.settingOpaqueSchemas
whiteListedSchemas <- OAM.getSetting OAO.settingWhiteListedSchemas
namedSchema <-
OAM.nested schemaName $
if schemaName `elem` settingOpaqueSchemas
then blackListAlias
else if null whiteListedSchemas || schemaName `elem` whiteListedSchemas then defineModelForSchemaNamedWithTypeAliasStrategy CreateTypeAlias schemaName schema else whiteListAlias
pure (transformToModuleName schemaName, snd namedSchema)
-- | Defines all the models for a schema and returns the declarations with the type of the root model
defineModelForSchemaNamed :: Text -> OAS.Schema -> OAM.Generator TypeWithDeclaration
defineModelForSchemaNamed = defineModelForSchemaNamedWithTypeAliasStrategy DontCreateTypeAlias
-- | defines the definitions for a schema and returns a type to the "entrypoint" of the schema
defineModelForSchemaNamedWithTypeAliasStrategy :: TypeAliasStrategy -> Text -> OAS.Schema -> OAM.Generator TypeWithDeclaration
defineModelForSchemaNamedWithTypeAliasStrategy strategy schemaName schema =
case schema of
OAT.Concrete concrete -> defineModelForSchemaConcrete strategy schemaName concrete
OAT.Reference reference -> do
refName <- haskellifyNameM True $ getSchemaNameFromReference reference
OAM.logTrace $ "Encountered reference '" <> reference <> "' which references the type '" <> T.pack (nameBase refName) <> "'"
createAlias schemaName "" strategy $
pure (varT refName, (emptyDoc, transformReferenceToDependency reference))
getSchemaNameFromReference :: Text -> Text
getSchemaNameFromReference = T.replace "#/components/schemas/" ""
transformReferenceToDependency :: Text -> Set.Set Text
transformReferenceToDependency = Set.singleton . transformToModuleName . getSchemaNameFromReference
-- | Transforms a 'OAS.Schema' (either a reference or a concrete object) to @'Maybe' 'OAS.SchemaObject'@
-- If a reference is found it is resolved. If it is not found, no log message is generated.
resolveSchemaReferenceWithoutWarning :: OAS.Schema -> OAM.Generator (Maybe OAS.SchemaObject)
resolveSchemaReferenceWithoutWarning schema =
case schema of
OAT.Concrete concrete -> pure $ Just concrete
OAT.Reference ref -> OAM.getSchemaReferenceM ref
resolveSchemaReference :: Text -> OAS.Schema -> OAM.Generator (Maybe (OAS.SchemaObject, Dep.Models))
resolveSchemaReference schemaName schema =
case schema of
OAT.Concrete concrete -> pure $ Just (concrete, Set.empty)
OAT.Reference ref -> do
p <- OAM.getSchemaReferenceM ref
when (Maybe.isNothing p) $
OAM.logWarning $
"Reference '"
<> ref
<> "' to schema from '"
<> schemaName
<> "' could not be found and therefore will be skipped."
pure $ (,transformReferenceToDependency ref) <$> p
-- | creates an alias depending on the strategy
createAlias :: Text -> Text -> TypeAliasStrategy -> OAM.Generator TypeWithDeclaration -> OAM.Generator TypeWithDeclaration
createAlias schemaName description strategy res = do
schemaName' <- haskellifyNameM True schemaName
(type', (content, dependencies)) <- res
path <- getCurrentPathEscaped
pure $ case strategy of
CreateTypeAlias ->
( type',
( content
`appendDoc` ( ( Doc.generateHaddockComment
[ "Defines an alias for the schema located at @" <> path <> "@ in the specification.",
"",
description
]
$$
)
. ppr
<$> tySynD schemaName' [] type'
),
dependencies
)
)
DontCreateTypeAlias -> (type', (content, dependencies))
-- | returns the type of a schema. Second return value is a 'Q' Monad, for the types that have to be created
defineModelForSchemaConcrete :: TypeAliasStrategy -> Text -> OAS.SchemaObject -> OAM.Generator TypeWithDeclaration
defineModelForSchemaConcrete strategy schemaName schema = do
nonNullableTypeSuffix <- OAM.getSetting OAO.settingNonNullableTypeSuffix
let enumValues = OAS.schemaObjectEnum schema
schemaNameWithNonNullableSuffix = if OAS.schemaObjectNullable schema then schemaName <> nonNullableTypeSuffix else schemaName
typeWithDeclaration <-
if null enumValues
then defineModelForSchemaConcreteIgnoreEnum strategy schemaNameWithNonNullableSuffix schema
else defineEnumModel schemaNameWithNonNullableSuffix schema enumValues
if OAS.schemaObjectNullable schema
then defineNullableTypeAlias strategy schemaName typeWithDeclaration
else pure typeWithDeclaration
defineNullableTypeAlias :: TypeAliasStrategy -> Text -> TypeWithDeclaration -> OAM.Generator TypeWithDeclaration
defineNullableTypeAlias strategy schemaName (type', (content, dependencies)) = do
nonNullableTypeSuffix <- OAM.getSetting OAO.settingNonNullableTypeSuffix
let nullableType = appT (varT ''OC.Nullable) type'
case strategy of
CreateTypeAlias -> do
path <- getCurrentPathEscaped
name <- haskellifyNameM True schemaName
pure
( varT name,
( content
`appendDoc` ( ( Doc.generateHaddockComment
[ "Defines a nullable type alias for '"
<> schemaName
<> nonNullableTypeSuffix
<> "' as the schema located at @"
<> path
<> "@ in the specification is marked as nullable."
]
$$
)
. ppr
<$> tySynD name [] nullableType
),
dependencies
)
)
DontCreateTypeAlias -> pure (nullableType, (content, dependencies))
-- | Creates a Model, ignores enum values
defineModelForSchemaConcreteIgnoreEnum :: TypeAliasStrategy -> Text -> OAS.SchemaObject -> OAM.Generator TypeWithDeclaration
defineModelForSchemaConcreteIgnoreEnum strategy schemaName schema = do
settings <- OAM.getSettings
let schemaDescription = getDescriptionOfSchema schema
typeAliasing = createAlias schemaName schemaDescription strategy
case schema of
OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeArray} -> defineArrayModelForSchema strategy schemaName schema
OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeObject} ->
let allOfNull = null $ OAS.schemaObjectAllOf schema
oneOfNull = null $ OAS.schemaObjectOneOf schema
anyOfNull = null $ OAS.schemaObjectAnyOf schema
in case (allOfNull, oneOfNull, anyOfNull) of
(False, _, _) -> OAM.nested "allOf" $ defineAllOfSchema schemaName schemaDescription $ OAS.schemaObjectAllOf schema
(_, False, _) -> OAM.nested "oneOf" $ typeAliasing $ defineOneOfSchema schemaName schemaDescription $ OAS.schemaObjectOneOf schema
(_, _, False) -> OAM.nested "anyOf" $ defineAnyOfSchema strategy schemaName schemaDescription $ OAS.schemaObjectAnyOf schema
_ -> defineObjectModelForSchema strategy schemaName schema
_ ->
typeAliasing $ pure (varT $ getSchemaType settings schema, (emptyDoc, Set.empty))
defineEnumModel :: Text -> OAS.SchemaObject -> [Aeson.Value] -> OAM.Generator TypeWithDeclaration
defineEnumModel schemaName schema enumValues = do
name <- haskellifyNameM True schemaName
OAM.logInfo $ "Define as enum named '" <> T.pack (nameBase name) <> "'"
let getConstructor (a, _, _) = a
getValueInfo value = do
cname <- haskellifyNameM True (schemaName <> T.pack "Enum" <> aesonValueToName value)
pure (normalC cname [], cname, value)
(typ, (_, dependencies)) <- defineModelForSchemaConcreteIgnoreEnum DontCreateTypeAlias (schemaName <> "EnumValue") schema
constructorsInfo <- mapM getValueInfo enumValues
fallbackName <- haskellifyNameM True $ schemaName <> "Other"
typedName <- haskellifyNameM True $ schemaName <> "Typed"
path <- getCurrentPathEscaped
let nameValuePairs = fmap (\(_, a, b) -> (a, b)) constructorsInfo
toBangType t = do
ban <- bang noSourceUnpackedness noSourceStrictness
banT <- t
pure (ban, banT)
fallbackC = normalC fallbackName [toBangType (varT ''Aeson.Value)]
typedC = normalC typedName [toBangType typ]
jsonImplementation = defineJsonImplementationForEnum name fallbackName typedName nameValuePairs
comments = fmap (("Represents the JSON value @" <>) . (<> "@") . showAesonValue) enumValues
newType =
( Doc.generateHaddockComment
[ "Defines the enum schema located at @" <> path <> "@ in the specification.",
"",
getDescriptionOfSchema schema
]
$$
)
. ( `Doc.sideBySide`
( text ""
$$ Doc.sideComments
( "This case is used if the value encountered during decoding does not match any of the provided cases in the specification."
: "This constructor can be used to send values to the server which are not present in the specification yet."
: comments
)
)
)
. Doc.reformatADT
. ppr
<$> dataD
(pure [])
name
[]
Nothing
(fallbackC : typedC : (getConstructor <$> constructorsInfo))
objectDeriveClause
pure (varT name, (newType `appendDoc` jsonImplementation, dependencies))
defineJsonImplementationForEnum :: Name -> Name -> Name -> [(Name, Aeson.Value)] -> Q Doc
defineJsonImplementationForEnum name fallbackName typedName nameValues =
-- without this function, a N long string takes up N lines, as every
-- new character starts on a new line
let (e, p) = (\n -> (varE n, varP n)) $ mkName "val"
fromJsonCases =
multiIfE $
fmap
( \(name', value) -> normalGE [|$e == $(liftAesonValue value)|] (varE name')
)
nameValues
<> [normalGE [|otherwise|] [|$(varE fallbackName) $e|]]
fromJsonFn =
funD
(mkName "parseJSON")
[clause [p] (normalB [|pure $fromJsonCases|]) []]
fromJson = instanceD (cxt []) [t|Aeson.FromJSON $(varT name)|] [fromJsonFn]
toJsonFnClause n ps ex =
funD
(mkName "toJSON")
[ clause
[conP n ps]
(normalB ex)
[]
]
toJsonClause (name', value) = toJsonFnClause name' [] $ liftAesonValue $ Aeson.toJSON value
toJsonFns =
toJsonFnClause fallbackName [p] e
: toJsonFnClause typedName [p] [|Aeson.toJSON $e|]
: (toJsonClause <$> nameValues)
toJson = instanceD (cxt []) [t|Aeson.ToJSON $(varT name)|] toJsonFns
in fmap ppr toJson `appendDoc` fmap ppr fromJson
-- | defines anyOf types
--
-- If the subschemas consist only of objects an allOf type without any required field can be generated
-- If there are differen subschema types, per schematype a oneOf is generated
defineAnyOfSchema :: TypeAliasStrategy -> Text -> Text -> [OAS.Schema] -> OAM.Generator TypeWithDeclaration
defineAnyOfSchema strategy schemaName description schemas = do
schemasWithDependencies <- mapMaybeM (resolveSchemaReference schemaName) schemas
let concreteSchemas = fmap fst schemasWithDependencies
schemasWithoutRequired = fmap (\o -> o {OAS.schemaObjectRequired = Set.empty}) concreteSchemas
notObjectSchemas = filter (\o -> OAS.schemaObjectType o /= OAS.SchemaTypeObject) concreteSchemas
newDependencies = Set.unions $ fmap snd schemasWithDependencies
if null notObjectSchemas
then do
OAM.logTrace "anyOf does not contain any schemas which are not of type object and will therefore be defined as allOf"
addDependencies newDependencies $ defineAllOfSchema schemaName description (fmap OAT.Concrete schemasWithoutRequired)
else do
OAM.logTrace "anyOf does contain at least one schema which is not of type object and will therefore be defined as oneOf"
createAlias schemaName description strategy $ defineOneOfSchema schemaName description schemas
-- this would be the correct implementation
-- but it generates endless loop because some implementations use anyOf as a oneOf
-- where the schema reference itself
-- let objectSchemas = filter (\o -> OAS.schemaObjectType o == OAS.SchemaTypeObject) concreteSchemas
-- (propertiesCombined, _) <- fuseSchemasAllOf schemaName (fmap OAT.Concrete objectSchemas)
-- if null propertiesCombined then
-- createAlias schemaName strategy $ defineOneOfSchema schemaName schemas
-- else
-- let schemaPrototype = head objectSchemas
-- newSchema = schemaPrototype {OAS.schemaObjectProperties = propertiesCombined, OAS.schemaObjectRequired = Set.empty}
-- in
-- createAlias schemaName strategy $ defineOneOfSchema schemaName (fmap OAT.Concrete (newSchema : notObjectSchemas))
-- | defines a OneOf Schema
--
-- creates types for all the subschemas and then creates an adt with constructors for the different
-- subschemas. Constructors are numbered
defineOneOfSchema :: Text -> Text -> [OAS.Schema] -> OAM.Generator TypeWithDeclaration
defineOneOfSchema schemaName description allSchemas = do
when (null allSchemas) $ OAM.logWarning "oneOf does not contain any sub-schemas and will therefore be defined as a void type"
settings <- OAM.getSettings
let haskellifyConstructor = haskellifyName (OAO.settingConvertToCamelCase settings) True
name = haskellifyConstructor $ schemaName <> "Variants"
fixedValueStrategy = OAO.settingFixedValueStrategy settings
(otherSchemas, fixedValueSchemas, singleFieldedSchemas) =
let (s', fixedValue) = extractSchemasWithFixedValues fixedValueStrategy allSchemas
(s'', singleFielded) = extractSchemasWithSingleField s'
in (s'', fixedValue, singleFielded)
defineSingleFielded field = defineModelForSchemaNamed (schemaName <> haskellifyText (OAO.settingConvertToCamelCase settings) True field)
indexedSchemas = zip otherSchemas ([1 ..] :: [Integer])
defineIndexed schema index = defineModelForSchemaNamed (schemaName <> "OneOf" <> T.pack (show index)) schema
OAM.logInfo $ "Define as oneOf named '" <> T.pack (nameBase name) <> "'"
singleFieldedVariants <- mapM (uncurry defineSingleFielded) singleFieldedSchemas
indexedVariants <- mapM (uncurry defineIndexed) indexedSchemas
path <- getCurrentPathEscaped
let variants = indexedVariants <> singleFieldedVariants
variantDefinitions = vcat <$> mapM (fst . snd) variants
dependencies = Set.unions $ fmap (snd . snd) variants
types = fmap fst variants
indexedTypes = zip types ([1 ..] :: [Integer])
getConstructorName (typ, n) = do
t <- typ
let suffix = if OAO.settingUseNumberedVariantConstructors settings then "Variant" <> T.pack (show n) else typeToSuffix t
pure $ haskellifyConstructor $ schemaName <> suffix
constructorNames = fmap getConstructorName indexedTypes
createTypeConstruct (typ, n) = do
t <- typ
bang' <- bang noSourceUnpackedness noSourceStrictness
haskellifiedName <- getConstructorName (typ, n)
normalC haskellifiedName [pure (bang', t)]
createConstructorNameForSchemaWithFixedValue =
haskellifyConstructor
. (schemaName <>)
. aesonValueToName
createConstructorForSchemaWithFixedValue =
(`normalC` [])
. createConstructorNameForSchemaWithFixedValue
fixedValueComments = fmap (("Represents the JSON value @" <>) . (<> "@") . showAesonValue) fixedValueSchemas
emptyCtx = pure []
patternName = mkName "a"
p = varP patternName
e = varE patternName
fromJsonFn =
let paramName = mkName "val"
body = do
constructorNames' <- sequence constructorNames
let resultExpr =
foldr
( \constructorName expr ->
[|($(varE constructorName) <$> Aeson.fromJSON $(varE paramName)) <|> $expr|]
)
[|Aeson.Error "No variant matched"|]
constructorNames'
parserExpr =
[|
case $resultExpr of
Aeson.Success $p -> pure $e
Aeson.Error $p -> fail $e
|]
case fixedValueSchemas of
[] -> parserExpr
_ ->
multiIfE $
fmap
( \value ->
let constructorName = createConstructorNameForSchemaWithFixedValue value
in normalGE [|$(varE paramName) == $(liftAesonValue value)|] [|pure $(varE constructorName)|]
)
fixedValueSchemas
<> [normalGE [|otherwise|] parserExpr]
in funD
(mkName "parseJSON")
[ clause
[varP paramName]
(normalB body)
[]
]
toJsonFnConstructor constructorName = do
n <- constructorName
funD
(mkName "toJSON")
[ clause
[conP n [p]]
(normalB [|Aeson.toJSON $e|])
[]
]
toJsonFnFixedValues value =
let constructorName = createConstructorNameForSchemaWithFixedValue value
in funD
(mkName "toJSON")
[ clause
[conP constructorName []]
(normalB $ liftAesonValue value)
[]
]
toJsonFns =
fmap toJsonFnConstructor constructorNames
<> fmap toJsonFnFixedValues fixedValueSchemas
dataDefinition =
( Doc.generateHaddockComment
[ "Defines the oneOf schema located at @" <> path <> "@ in the specification.",
"",
description
]
$$
)
. (`Doc.sideBySide` (text "" $$ Doc.sideComments fixedValueComments))
. Doc.reformatADT
. ppr
<$> dataD
emptyCtx
name
[]
Nothing
(fmap createConstructorForSchemaWithFixedValue fixedValueSchemas <> fmap createTypeConstruct indexedTypes)
[ derivClause
Nothing
[ conT ''Show,
conT ''Eq
]
]
toJson = ppr <$> instanceD emptyCtx [t|Aeson.ToJSON $(varT name)|] toJsonFns
fromJson = ppr <$> instanceD emptyCtx [t|Aeson.FromJSON $(varT name)|] [fromJsonFn]
innerRes = (varT name, (variantDefinitions `appendDoc` dataDefinition `appendDoc` toJson `appendDoc` fromJson, dependencies))
pure innerRes
typeToSuffix :: Type -> Text
typeToSuffix (ConT name') = T.pack $ nameBase name'
typeToSuffix (VarT name') =
let x = T.pack $ nameBase name'
in if x == "[]" then "List" else x
typeToSuffix (AppT type1 type2) = typeToSuffix type1 <> typeToSuffix type2
typeToSuffix x = T.pack $ show x
-- | combines schemas so that it is usefull for a allOf fusion
fuseSchemasAllOf :: Text -> [OAS.Schema] -> OAM.Generator (Map.Map Text OAS.Schema, Set.Set Text)
fuseSchemasAllOf schemaName schemas = do
schemasWithDependencies <- mapMaybeM (resolveSchemaReference schemaName) schemas
let concreteSchemas = fmap fst schemasWithDependencies
subSchemaInformation <- mapM (getPropertiesForAllOf schemaName) concreteSchemas
let propertiesCombined = foldl (Map.unionWith const) Map.empty (fmap fst subSchemaInformation)
let requiredCombined = foldl Set.union Set.empty (fmap snd subSchemaInformation)
pure (propertiesCombined, requiredCombined)
-- | gets properties for an allOf merge
-- looks if subschemas define further subschemas
getPropertiesForAllOf :: Text -> OAS.SchemaObject -> OAM.Generator (Map.Map Text OAS.Schema, Set.Set Text)
getPropertiesForAllOf schemaName schema =
let allOf = OAS.schemaObjectAllOf schema
anyOf = OAS.schemaObjectAnyOf schema
relevantSubschemas = allOf <> anyOf
in if null relevantSubschemas
then pure (OAS.schemaObjectProperties schema, OAS.schemaObjectRequired schema)
else do
(allOfProps, allOfRequired) <- fuseSchemasAllOf schemaName allOf
(anyOfProps, _) <- fuseSchemasAllOf schemaName anyOf
pure (Map.unionWith const allOfProps anyOfProps, allOfRequired)
-- | defines a allOf subschema
-- Fuses the subschemas together
defineAllOfSchema :: Text -> Text -> [OAS.Schema] -> OAM.Generator TypeWithDeclaration
defineAllOfSchema schemaName description schemas = do
newDefs <- defineNewSchemaForAllOf schemaName description schemas
case newDefs of
Just (newSchema, newDependencies) ->
addDependencies newDependencies $ defineModelForSchemaConcrete DontCreateTypeAlias schemaName newSchema
Nothing -> pure ([t|Aeson.Object|], (emptyDoc, Set.empty))
-- | defines a new Schema, which properties are fused
defineNewSchemaForAllOf :: Text -> Text -> [OAS.Schema] -> OAM.Generator (Maybe (OAS.SchemaObject, Dep.Models))
defineNewSchemaForAllOf schemaName description schemas = do
schemasWithDependencies <- mapMaybeM (resolveSchemaReference schemaName) schemas
let concreteSchemas = fmap fst schemasWithDependencies
newDependencies = Set.unions $ fmap snd schemasWithDependencies
(propertiesCombined, requiredCombined) <- fuseSchemasAllOf schemaName schemas
if Map.null propertiesCombined
then do
OAM.logWarning "allOf does not contain any schemas with properties."
pure Nothing
else do
let schemaPrototype = head concreteSchemas
newSchema = schemaPrototype {OAS.schemaObjectProperties = propertiesCombined, OAS.schemaObjectRequired = requiredCombined, OAS.schemaObjectDescription = Just description}
OAM.logTrace $ "Define allOf as record named '" <> schemaName <> "'"
pure $ Just (newSchema, newDependencies)
-- | defines an array
defineArrayModelForSchema :: TypeAliasStrategy -> Text -> OAS.SchemaObject -> OAM.Generator TypeWithDeclaration
defineArrayModelForSchema strategy schemaName schema = do
arrayItemTypeSuffix <- case strategy of
CreateTypeAlias -> OAM.getSetting OAO.settingArrayItemTypeSuffix
DontCreateTypeAlias -> pure "" -- The suffix is only relevant for top level declarations because only there a named type of the array even exists
(type', (content, dependencies)) <-
case OAS.schemaObjectItems schema of
Just itemSchema -> OAM.nested "items" $ defineModelForSchemaNamed (schemaName <> arrayItemTypeSuffix) itemSchema
-- not allowed by the spec
Nothing -> do
OAM.logWarning "Array type was defined without a items schema and therefore cannot be defined correctly"
pure ([t|Aeson.Object|], (emptyDoc, Set.empty))
let arrayType =
case OAS.schemaObjectMinItems schema of
Just w | w > 0 -> appT [t|NonEmpty|] type'
_ -> appT listT type'
schemaName' <- haskellifyNameM True schemaName
OAM.logTrace $ "Define as list named '" <> T.pack (nameBase schemaName') <> "'"
path <- getCurrentPathEscaped
pure
( arrayType,
( content `appendDoc` case strategy of
CreateTypeAlias ->
( Doc.generateHaddockComment
[ "Defines an alias for the schema located at @" <> path <> "@ in the specification.",
"",
getDescriptionOfSchema schema
]
$$
)
. ppr
<$> tySynD schemaName' [] arrayType
DontCreateTypeAlias -> emptyDoc,
dependencies
)
)
data Field = Field
{ fieldProp :: Text,
fieldName :: Text,
fieldSchema :: OAS.Schema,
fieldRequired :: Bool,
fieldHaskellName :: Name
}
toField :: Bool -> Text -> Text -> OAS.Schema -> Set.Set Text -> Field
toField convertToCamelCase propName fieldName fieldSchema required =
Field
{ fieldProp = propName,
fieldName,
fieldSchema,
fieldRequired = propName `Set.member` required,
fieldHaskellName = haskellifyName convertToCamelCase False fieldName
}
-- | Defines a record
defineObjectModelForSchema :: TypeAliasStrategy -> Text -> OAS.SchemaObject -> OAM.Generator TypeWithDeclaration
defineObjectModelForSchema strategy schemaName schema =
if OAS.isSchemaEmpty schema
then createAlias schemaName (getDescriptionOfSchema schema) strategy $ pure ([t|Aeson.Object|], (emptyDoc, Set.empty))
else do
settings <- OAM.getSettings
path <- getCurrentPathEscaped
let convertToCamelCase = OAO.settingConvertToCamelCase settings
name = haskellifyName convertToCamelCase True schemaName
required = OAS.schemaObjectRequired schema
fixedValueStrategy = OAO.settingFixedValueStrategy settings
shortenSingleFieldObjects = OAO.settingShortenSingleFieldObjects settings
(props, propsWithFixedValues) = extractPropertiesWithFixedValues fixedValueStrategy required $ Map.toList $ OAS.schemaObjectProperties schema
propFields = case props of
[(propName, subschema)]
| shortenSingleFieldObjects ->
[(propName, toField convertToCamelCase propName schemaName subschema required)]
_ -> flip fmap props $ \(propName, subschema) ->
(propName, toField convertToCamelCase propName (schemaName <> uppercaseFirstText propName) subschema required)
emptyCtx = pure []
OAM.logInfo $ "Define as record named '" <> T.pack (nameBase name) <> "'"
(bangTypes, propertyContent, propertyDependencies) <- propertiesToBangTypes propFields
propertyDescriptions <- getDescriptionOfProperties propFields
let dataDefinition = do
bangs <- bangTypes
let record = recC name (pure <$> bangs)
flip Doc.zipCodeAndComments propertyDescriptions
. T.lines
. T.pack
. show
. Doc.reformatRecord
. ppr
<$> dataD emptyCtx name [] Nothing [record] objectDeriveClause
toJsonInstance = createToJSONImplementation name propFields propsWithFixedValues
fromJsonInstance = createFromJSONImplementation name propFields
mkFunction = createMkFunction name propFields bangTypes
pure
( varT name,
( pure
( Doc.generateHaddockComment
[ "Defines the object schema located at @" <> path <> "@ in the specification.",
"",
getDescriptionOfSchema schema
]
)
`appendDoc` dataDefinition
`appendDoc` toJsonInstance
`appendDoc` fromJsonInstance
`appendDoc` mkFunction
`appendDoc` propertyContent,
propertyDependencies
)
)
extractPropertiesWithFixedValues :: FixedValueStrategy -> Set.Set Text -> [(Text, OAS.Schema)] -> ([(Text, OAS.Schema)], [(Text, Aeson.Value)])
extractPropertiesWithFixedValues fixedValueStrategy required =
E.partitionEithers
. fmap
( \(name, schema) ->
BF.bimap (name,) (name,) $
if name `Set.member` required
then extractSchemaWithFixedValue fixedValueStrategy schema
else Left schema
)
extractSchemasWithFixedValues :: FixedValueStrategy -> [OAS.Schema] -> ([OAS.Schema], [Aeson.Value])
extractSchemasWithFixedValues fixedValueStrategy =
E.partitionEithers . fmap (extractSchemaWithFixedValue fixedValueStrategy)
extractSchemaWithFixedValue :: FixedValueStrategy -> OAS.Schema -> Either OAS.Schema Aeson.Value
extractSchemaWithFixedValue FixedValueStrategyExclude schema@(OAT.Concrete OAS.SchemaObject {..}) = case schemaObjectEnum of
[value] -> Right value
_ -> Left schema
extractSchemaWithFixedValue _ schema = Left schema
extractSchemasWithSingleField :: [OAS.Schema] -> ([OAS.Schema], [(Text, OAS.Schema)])
extractSchemasWithSingleField = E.partitionEithers . fmap extractSchemaWithSingleField
extractSchemaWithSingleField :: OAS.Schema -> Either OAS.Schema (Text, OAS.Schema)
extractSchemaWithSingleField schema@(OAT.Concrete OAS.SchemaObject {..}) = case Map.toList schemaObjectProperties of
[(field, _)] -> Right (field, schema)
_ -> Left schema
extractSchemaWithSingleField schema = Left schema
createMkFunction :: Name -> [(Text, Field)] -> Q [VarBangType] -> Q Doc
createMkFunction name propFields bangTypes = do
bangs <- bangTypes
let fnName = mkName $ "mk" <> nameBase name
fieldsWithBangs =
( \((_, record), (_, _, propType)) ->
(record, propType)
)
<$> zip propFields bangs
requiredFieldsWithBangs = filter (\(Field {..}, _) -> fieldRequired) fieldsWithBangs
parameterPatterns = (\(Field {..}, _) -> varP fieldHaskellName) <$> requiredFieldsWithBangs
parameterDescriptions = (\(Field {..}, _) -> "'" <> T.pack (nameBase fieldHaskellName) <> "'") <$> requiredFieldsWithBangs
recordExpr = (\(Field {..}, _) -> fieldExp fieldHaskellName (if fieldRequired then varE fieldHaskellName else [|Nothing|])) <$> fieldsWithBangs
expr = recConE name recordExpr
fnType = foldr (\(_, propertyType) t -> [t|$(pure propertyType) -> $t|]) (conT name) requiredFieldsWithBangs
pure
( Doc.generateHaddockComment
[ "Create a new '" <> T.pack (nameBase name) <> "' with all required fields."
]
)
`appendDoc` fmap
( ( `Doc.sideBySide`
Doc.sideComments parameterDescriptions
)
. Doc.breakOnTokens ["->"]
. ppr
)
(sigD fnName fnType)
`appendDoc` fmap ppr (funD fnName [clause parameterPatterns (normalB expr) []])
-- | create toJSON implementation for an object
createToJSONImplementation :: Name -> [(Text, Field)] -> [(Text, Aeson.Value)] -> Q Doc
createToJSONImplementation objectName fieldProps propsWithFixedValues =
let emptyDefs = pure []
fnArgName = mkName "obj"
toAssertion (propName, Field {..}) =
if fieldRequired
then [|[$(stringE $ T.unpack propName) Aeson..= $(varE fieldHaskellName) $(varE fnArgName)]|]
else [|(maybe mempty (pure . ($(stringE $ T.unpack propName) Aeson..=)) ($(varE fieldHaskellName) $(varE fnArgName)))|]
toFixedAssertion (propName, value) =
[|[$(stringE $ T.unpack propName) Aeson..= $(liftAesonValueWithOverloadedStrings False value)]|]
assertions = fmap toAssertion fieldProps <> fmap toFixedAssertion propsWithFixedValues
assertionsList = [|(List.concat $(toExprList assertions))|]
toExprList = foldr (\x expr -> uInfixE x (varE $ mkName ":") expr) [|mempty|]
defaultJsonImplementation =
[ funD
(mkName "toJSON")
[ clause
[varP fnArgName]
( normalB
[|Aeson.object $assertionsList|]
)
[]
],
funD
(mkName "toEncoding")
[ clause
[varP fnArgName]
( normalB
[|Aeson.pairs (mconcat $assertionsList)|]
)
[]
]
]
in ppr <$> instanceD emptyDefs [t|Aeson.ToJSON $(varT objectName)|] defaultJsonImplementation
-- | create FromJSON implementation for an object
createFromJSONImplementation :: Name -> [(Text, Field)] -> Q Doc
createFromJSONImplementation objectName fieldProps =
let fnArgName = mkName "obj"
withObjectLamda =
foldl
( \prev (_, Field {..}) ->
let fieldProp' = stringE $ T.unpack fieldProp
arg = varE fnArgName
readPropE =
if fieldRequired
then [|$arg Aeson..: $fieldProp'|]
else [|$arg Aeson..:! $fieldProp'|]
in [|$prev <*> $readPropE|]
)
[|pure $(varE objectName)|]
fieldProps
in ppr
<$> instanceD
(cxt [])
[t|Aeson.FromJSON $(varT objectName)|]
[ funD
(mkName "parseJSON")
[ clause
[]
( normalB
[|Aeson.withObject $(stringE $ show objectName) $(lam1E (varP fnArgName) withObjectLamda)|]
)
[]
]
]
-- | create "bangs" record fields for properties
propertiesToBangTypes :: [(Text, Field)] -> OAM.Generator BangTypesSelfDefined
propertiesToBangTypes [] = pure (pure [], emptyDoc, Set.empty)
propertiesToBangTypes fieldProps = OAM.nested "properties" $ do
convertToCamelCase <- OAM.getSetting OAO.settingConvertToCamelCase
propTypeSuffix <- OAM.getSetting OAO.settingPropertyTypeSuffix
let createBang :: Field -> Q Type -> Q VarBangType
createBang Field {..} myType = do
bang' <- bang noSourceUnpackedness noSourceStrictness
type' <-
if fieldRequired
then myType
else appT (varT ''Maybe) myType
pure (haskellifyName convertToCamelCase False fieldName, bang', type')
propToBangType :: Field -> OAM.Generator (Q VarBangType, Q Doc, Dep.Models)
propToBangType field@Field {..} = do
(myType, (content, dependencies)) <- OAM.nested fieldProp $ defineModelForSchemaNamed (fieldName <> propTypeSuffix) fieldSchema
let myBang = createBang field myType
pure (myBang, content, dependencies)
foldFn :: OAM.Generator BangTypesSelfDefined -> (Text, Field) -> OAM.Generator BangTypesSelfDefined
foldFn accHolder next = do
(varBang, content, dependencies) <- accHolder
(nextVarBang, nextContent, nextDependencies) <- propToBangType $ snd next
pure
( varBang `liftedAppend` fmap pure nextVarBang,
content `appendDoc` nextContent,
Set.union dependencies nextDependencies
)
foldl foldFn (pure (pure [], emptyDoc, Set.empty)) fieldProps
getDescriptionOfSchema :: OAS.SchemaObject -> Text
getDescriptionOfSchema schema = Doc.escapeText $ Maybe.fromMaybe "" $ OAS.schemaObjectDescription schema
getDescriptionOfProperties :: [(Text, Field)] -> OAM.Generator [Text]
getDescriptionOfProperties =
mapM
( \(propName, Field {..}) -> do
schema' <- resolveSchemaReferenceWithoutWarning fieldSchema
let description = maybe "" (": " <>) $ schema' >>= OAS.schemaObjectDescription
constraints = T.unlines $ ("* " <>) <$> getConstraintDescriptionsOfSchema schema'
pure $ Doc.escapeText $ propName <> description <> (if T.null constraints then "" else "\n\nConstraints:\n\n" <> constraints)
)
-- | Extracts the constraints of a 'OAS.SchemaObject' as human readable text
getConstraintDescriptionsOfSchema :: Maybe OAS.SchemaObject -> [Text]
getConstraintDescriptionsOfSchema schema =
let showConstraint desc = showConstraintSurrounding desc ""
showConstraintSurrounding prev after = fmap $ (prev <>) . (<> after) . T.pack . show
exclusiveMaximum = maybe False OAS.schemaObjectExclusiveMaximum schema
exclusiveMinimum = maybe False OAS.schemaObjectExclusiveMinimum schema
in Maybe.catMaybes
[ showConstraint "Must be a multiple of " $ schema >>= OAS.schemaObjectMultipleOf,
showConstraint ("Maxium " <> if exclusiveMaximum then " (exclusive)" else "" <> " of ") $ schema >>= OAS.schemaObjectMaximum,
showConstraint ("Minimum " <> if exclusiveMinimum then " (exclusive)" else "" <> " of ") $ schema >>= OAS.schemaObjectMinimum,
showConstraint "Maximum length of " $ schema >>= OAS.schemaObjectMaxLength,
showConstraint "Minimum length of " $ schema >>= OAS.schemaObjectMinLength,
("Must match pattern '" <>) . (<> "'") <$> (schema >>= OAS.schemaObjectPattern),
showConstraintSurrounding "Must have a maximum of " " items" $ schema >>= OAS.schemaObjectMaxItems,
showConstraintSurrounding "Must have a minimum of " " items" $ schema >>= OAS.schemaObjectMinItems,
schema
>>= ( \case
True -> Just "Must have unique items"
False -> Nothing
)
. OAS.schemaObjectUniqueItems,
showConstraintSurrounding "Must have a maximum of " " properties" $ schema >>= OAS.schemaObjectMaxProperties,
showConstraintSurrounding "Must have a minimum of " " properties" $ schema >>= OAS.schemaObjectMinProperties
]
-- | Extracts the 'Name' of a 'OAS.SchemaObject' which should be used for primitive types
getSchemaType :: OAO.Settings -> OAS.SchemaObject -> Name
getSchemaType OAO.Settings {settingUseIntWithArbitraryPrecision = True} OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeInteger} = ''Integer
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeInteger, schemaObjectFormat = Just "int32"} = ''Int.Int32
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeInteger, schemaObjectFormat = Just "int64"} = ''Int.Int64
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeInteger} = ''Int
getSchemaType OAO.Settings {settingUseFloatWithArbitraryPrecision = True} OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeNumber} = ''Scientific.Scientific
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeNumber, schemaObjectFormat = Just "float"} = ''Float
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeNumber, schemaObjectFormat = Just "double"} = ''Double
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeNumber} = ''Double
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeString, schemaObjectFormat = Just "byte"} = ''OC.JsonByteString
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeString, schemaObjectFormat = Just "binary"} = ''OC.JsonByteString
getSchemaType OAO.Settings {settingUseDateTypesAsString = True} OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeString, schemaObjectFormat = Just "date"} = ''Day
getSchemaType OAO.Settings {settingUseDateTypesAsString = True} OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeString, schemaObjectFormat = Just "date-time"} = ''OC.JsonDateTime
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeString} = ''Text
getSchemaType _ OAS.SchemaObject {schemaObjectType = OAS.SchemaTypeBool} = ''Bool
getSchemaType _ OAS.SchemaObject {} = ''Text
getCurrentPathEscaped :: OAM.Generator Text
getCurrentPathEscaped = Doc.escapeText . T.intercalate "." <$> OAM.getCurrentPath