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

Improve swagger support for malli #51

Merged
merged 3 commits into from
Aug 16, 2024
Merged

Improve swagger support for malli #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f7113f
improve swagger support for malli
frenchy64 Aug 15, 2024
24a5da9
wip
frenchy64 Aug 15, 2024
46d6436
wip
frenchy64 Aug 15, 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
53 changes: 27 additions & 26 deletions src/flanders/malli.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
(ns flanders.malli
"Requires malli as a dependency."
(:refer-clojure :exclude [type])
(:require
[flanders.types]
[flanders.example :as example]
[malli.core :as m]
[malli.util :as mu])
(:import [flanders.types
Expand All @@ -13,22 +15,25 @@
(defprotocol MalliNode
(->malli' [node opts]))

;;TODO
(defn- describe [schema _description]
schema)
(defn- describe [?schema {:keys [description] :as dll} opts]
(-> ?schema
(m/schema opts)
(mu/update-properties
#(-> %
(assoc :json-schema/example (example/->example-tree dll))
(cond-> description (assoc :json-schema/description description))))))

(defn maybe-key [{:keys [description key? open? values] :as node} opts base]
(defn maybe-key [{:keys [key? open? values] :as dll} opts base]
(if key?
(cond
(= 1 (count values)) {:op :specific-key :schema (first values)}
open? {:op :default-key :schema (m/schema base opts)}
:else (throw (ex-info (format "Cannot convert schema %s to key" node)
:else (throw (ex-info (format "Cannot convert schema %s to key" dll)
{})))
(-> (if (or open? (empty? values))
base
(into [:enum] (sort values)))
(describe description)
(m/schema opts))))
(describe dll opts))))

;; Note: we use m/schema eagerly mostly for prettier map schemas.
;; This won't work if flanders supports recursive schemas.
Expand Down Expand Up @@ -56,29 +61,29 @@
(not (:open? key))
(seq (:values key)))
description (some :description [key entry])
opts (cond-> nil
optional? (assoc :optional true)
description (assoc :json-schema/description description))
props (cond-> {:json-schema/example (example/->example-tree type)}
optional? (assoc :optional true)
description (assoc :json-schema/description description))
default-or-specific-key (f (assoc key :key? true))]
(case (:op default-or-specific-key)
:specific-key (-> [(:schema default-or-specific-key)]
(cond-> opts (conj opts))
(cond-> props (conj props))
(conj (f type)))
:default-key (-> [::m/default]
(cond-> opts (conj opts))
(cond-> props (conj props))
(conj
[:map-of
(:schema default-or-specific-key)
(f type)])))))

MapType
(->malli' [{:keys [description entries key?]} opts]
(->malli' [{:keys [entries key?] :as dll} opts]
(let [f #(->malli' % opts)
s (-> (into [:merge] (map (fn [e] [:map (f e)])) entries)
(m/schema opts)
m/deref ;; eliminate :merge
(mu/update-properties assoc :closed true)
(describe description))]
(describe dll opts))]
(if key?
{:op :default-key :schema s}
s)))
Expand Down Expand Up @@ -120,29 +125,25 @@
;; Leaves

AnythingType
(->malli' [{:keys [description key?]} opts]
(->malli' [{:keys [key?] :as dll} opts]
(if key?
{:op :default-key :schema :any}
(m/schema (describe :any description)
opts)))
(describe :any dll opts)))

BooleanType
(->malli' [{:keys [open? key? default description]} opts]
(->malli' [{:keys [default open? key?] :as dll} opts]
(if key?
(if open?
{:op :default-key :schema :boolean}
{:op :specific-key :schema default})
(m/schema
(describe
(if open?
(-> (if open?
:boolean
[:enum (boolean default)])
description)
opts)))
[:= (boolean default)])
(describe dll opts))))

InstType
(->malli' [{:keys [description key?]} opts]
(let [s (m/schema (describe inst? description) opts)]
(->malli' [{:keys [key?] :as dll} opts]
(let [s (describe inst? dll opts)]
(if key?
{:op :default-key :schema s}
s)))
Expand Down
227 changes: 154 additions & 73 deletions test/flanders/malli_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,82 +1,152 @@
(ns flanders.malli-test
(:require [clojure.test :refer [deftest is testing]]
[clojure.walk :as w]
[flanders.examples
:refer [Example
OptionalKeywordMapEntryExample]]
[flanders.core :as f]
[flanders.malli :as fm]
[malli.core :as m]))
[malli.core :as m]
[malli.swagger :as ms]
[malli.util :as mu]))

(def swagger-props #{:json-schema/description :json-schema/example})

(defn- strip-swagger-from-props [props]
(apply dissoc props swagger-props))

(defn- strip-swagger [schema]
;; TODO strip properties in entry vals like [:map [:a {HERE} s]] during walk
(m/walk schema (fn [schema _ _ _]
(mu/update-properties schema strip-swagger-from-props))
{::m/walk-entry-vals true}))

(defn- form-no-swagger [schema]
(let [options (m/options schema)
frm (-> schema strip-swagger m/form)]
;; FIXME replace this dirty tree walk with strip-swagger
(-> (w/postwalk (fn [v]
(cond-> v
(and (map? v)
(some v swagger-props))
(-> strip-swagger-from-props not-empty)))
frm)
;; convert [:string nil] to :string
(m/form options))))

(defn- ->malli-frm [dll]
(-> dll fm/->malli form-no-swagger))

(deftest test-basic-schemas
(testing "str"
(is (= :string (-> (f/str) fm/->malli m/form)))
(is (= [:enum "a"] (-> (f/str :equals "a") fm/->malli m/form)))
(is (= [:map {:closed true} [:malli.core/default [:map-of :string :any]]] (-> (f/map [(f/entry (f/str) f/any)]) fm/->malli m/form)))
(is (= [:map {:closed true} ["b" :any]] (-> (f/map [(f/entry (f/str :equals "b") f/any)]) fm/->malli m/form))))
(is (= :string (->malli-frm (f/str))))
(is (= [:enum "a"] (->malli-frm (f/str :equals "a"))))
(is (= [:map {:closed true} [:malli.core/default [:map-of :string :any]]]
(->malli-frm (f/map [(f/entry (f/str) f/any)]))))
(is (= [:map {:closed true} ["b" :any]]
(->malli-frm (f/map [(f/entry (f/str :equals "b") f/any)])))))
(testing "int"
(is (= :int (-> (f/int) fm/->malli m/form)))
(is (= [:enum 1] (-> (f/int :equals 1) fm/->malli m/form)))
(is (= [:map {:closed true} [:malli.core/default [:map-of :int :any]]] (-> (f/map [(f/entry (f/int) f/any)]) fm/->malli m/form)))
(is (= [:map {:closed true} [1 :any]] (-> (f/map [(f/entry (f/int :equals 1) f/any)]) fm/->malli m/form))))
(is (= :int (->malli-frm (f/int))))
(is (= [:enum 1] (->malli-frm (f/int :equals 1))))
(is (= [:map {:closed true} [:malli.core/default [:map-of :int :any]]]
(->malli-frm (f/map [(f/entry (f/int) f/any)]))))
(is (= [:map {:closed true} [1 :any]]
(->malli-frm (f/map [(f/entry (f/int :equals 1) f/any)])))))
(testing "num"
(is (= 'number? (-> (f/num) fm/->malli m/form)))
(is (= [:enum 1] (-> (f/num :equals 1) fm/->malli m/form)))
(is (= [:map {:closed true} [:malli.core/default [:map-of 'number? :any]]] (-> (f/map [(f/entry (f/num) f/any)]) fm/->malli m/form)))
(is (= [:map {:closed true} [1 :any]] (-> (f/map [(f/entry (f/num :equals 1) f/any)]) fm/->malli m/form))))
(is (= 'number? (->malli-frm (f/num))))
(is (= [:enum 1] (->malli-frm (f/num :equals 1))))
(is (= [:map {:closed true} [:malli.core/default [:map-of 'number? :any]]]
(->malli-frm (f/map [(f/entry (f/num) f/any)]))))
(is (= [:map {:closed true} [1 :any]]
(->malli-frm (f/map [(f/entry (f/num :equals 1) f/any)])))))
(testing "keyword"
(is (= :keyword (-> (f/keyword) fm/->malli m/form)))
(is (= [:enum :a] (-> (f/keyword :equals :a) fm/->malli m/form)))
(is (= [:map {:closed true} [:malli.core/default [:map-of :keyword :any]]] (-> (f/map [(f/entry (f/keyword) f/any)]) fm/->malli m/form)))
(is (= [:map {:closed true} [:a :any]] (-> (f/map [(f/entry (f/keyword :equals :a) f/any)]) fm/->malli m/form))))
(is (= :keyword (->malli-frm (f/keyword))))
(is (= [:enum :a] (->malli-frm (f/keyword :equals :a))))
(is (= [:map {:closed true} [:malli.core/default [:map-of :keyword :any]]]
(->malli-frm (f/map [(f/entry (f/keyword) f/any)]))))
(is (= [:map {:closed true} [:a :any]]
(->malli-frm (f/map [(f/entry (f/keyword :equals :a) f/any)])))))
(testing "inst"
(is (= 'inst? (-> (f/inst) fm/->malli m/form)))
(is (= [:map {:closed true} [:malli.core/default [:map-of 'inst? :any]]] (-> (f/map [(f/entry (f/inst) f/any)]) fm/->malli m/form))))
(is (= 'inst? (->malli-frm (f/inst))))
(is (= [:map {:closed true} [:malli.core/default [:map-of 'inst? :any]]]
(->malli-frm (f/map [(f/entry (f/inst) f/any)])))))
(testing "bool"
(is (= :boolean (-> (f/bool) fm/->malli m/form)))
(is (= [:enum false] (-> (f/bool :equals false) fm/->malli m/form)))
(is (= [:enum true] (-> (f/bool :equals true) fm/->malli m/form)))
(is (= [:map {:closed true} [:malli.core/default [:map-of :boolean :any]]] (-> (f/map [(f/entry (f/bool) f/any)]) fm/->malli m/form)))
(is (= [:map {:closed true} [true :any]] (-> (f/map [(f/entry (f/bool :equals true) f/any)]) fm/->malli m/form)))
(is (= [:map {:closed true} [false :any]] (-> (f/map [(f/entry (f/bool :equals false) f/any)]) fm/->malli m/form))))
(is (= :boolean (->malli-frm (f/bool))))
(is (= [:= false] (->malli-frm (f/bool :equals false))))
(is (= [:= true] (->malli-frm (f/bool :equals true))))
(is (= [:map {:closed true} [:malli.core/default [:map-of :boolean :any]]]
(->malli-frm (f/map [(f/entry (f/bool) f/any)]))))
(is (= [:map {:closed true} [true :any]]
(->malli-frm (f/map [(f/entry (f/bool :equals true) f/any)]))))
(is (= [:map {:closed true} [false :any]]
(->malli-frm (f/map [(f/entry (f/bool :equals false) f/any)])))))
(testing "anything"
(is (= :any (-> (f/anything) fm/->malli m/form)))
(is (= [:map {:closed true} [:malli.core/default [:map-of :any :any]]] (-> (f/map [(f/entry (f/anything) f/any)]) fm/->malli m/form))))
(is (= :any (->malli-frm (f/anything))))
(is (= [:map {:closed true} [:malli.core/default [:map-of :any :any]]]
(->malli-frm (f/map [(f/entry (f/anything) f/any)])))))
(testing "set-of"
(is (= [:set :boolean] (-> (f/set-of (f/bool)) fm/->malli m/form)))
(is (= [:map {:closed true} [:malli.core/default [:map-of [:set :boolean] :any]]] (-> (f/map [(f/entry (f/set-of (f/bool)) f/any)]) fm/->malli m/form))))
(is (= [:set :boolean]
(->malli-frm (f/set-of (f/bool)))))
(is (= [:map {:closed true} [:malli.core/default [:map-of [:set :boolean] :any]]]
(->malli-frm (f/map [(f/entry (f/set-of (f/bool)) f/any)])))))
(testing "seq-of"
(is (= [:sequential :boolean] (-> (f/seq-of (f/bool)) fm/->malli m/form)))
(is (= [:map {:closed true} [:malli.core/default [:map-of [:sequential :boolean] :any]]] (-> (f/map [(f/entry (f/seq-of (f/bool)) f/any)]) fm/->malli m/form))))
(is (= [:sequential :boolean] (->malli-frm (f/seq-of (f/bool)))))
(is (= [:map {:closed true} [:malli.core/default [:map-of [:sequential :boolean] :any]]]
(->malli-frm (f/map [(f/entry (f/seq-of (f/bool)) f/any)])))))
(testing "either"
(is (= [:or :boolean :string] (-> (f/either :choices [(f/bool) (f/str)]) fm/->malli m/form)))
(is (= [:or :boolean :string]
(->malli-frm (f/either :choices [(f/bool) (f/str)]))))
(is (= [:map {:closed true} [:malli.core/default [:map-of [:or :boolean :string] :any]]]
(-> (f/map [(f/entry (f/either :choices [(f/bool) (f/str)]) f/any)]) fm/->malli m/form))))
(->malli-frm (f/map [(f/entry (f/either :choices [(f/bool) (f/str)]) f/any)])))))
(testing "sig"
(is (= [:=> [:cat :int] :int] (-> (f/sig :parameters [(f/int)] :return (f/int)) fm/->malli m/form)))
(is (= [:=> [:cat :int] :int]
(->malli-frm (f/sig :parameters [(f/int)] :return (f/int)))))
(is (= [:map {:closed true} [:malli.core/default [:map-of [:=> [:cat :int] :int] :any]]]
(-> (f/map [(f/entry (f/sig :parameters [(f/int)] :return (f/int)) f/any)]) fm/->malli m/form)))))
(->malli-frm (f/map [(f/entry (f/sig :parameters [(f/int)] :return (f/int)) f/any)]))))))

(deftest test-valid-schema
(is (= [:map {:closed true}
[:foo :string]
[:bar [:map {:closed true}
["integer" :int]
[:seq [:sequential :keyword]]
[:set [:set [:enum 1 2 3]]]]]
[:yes? :boolean]
[:spam {:optional true} [:enum :eggs]]]
(-> Example
fm/->malli
m/form)))
(is
(m/validate
(fm/->malli Example)
{:foo "foo"
:bar {"integer" 100
:seq [:a :b :c]
:set #{1 3}}
:yes? true
:spam :eggs}))
(is (= [:map {:closed true
:json-schema/example {:foo "string"
:bar {"integer" 10, :seq [:keyword], :set #{1}}
:yes? true
:spam :eggs}
:json-schema/description "Example"}
[:foo
{:json-schema/example "string"}
[:string {:json-schema/example "string"}]]
[:bar {:json-schema/example {"integer" 10, :seq [:keyword], :set #{1}}}
[:map {:closed true
:json-schema/example {"integer" 10, :seq [:keyword], :set #{1}}}
["integer"
{:json-schema/example 10}
[:int {:json-schema/example 10}]]
[:seq {:json-schema/example [:keyword]}
[:sequential [:keyword {:json-schema/example :keyword}]]]
[:set {:json-schema/example #{1}}
[:set [:enum {:json-schema/example 1} 1 2 3]]]]]
[:yes? {:json-schema/example true} [:boolean {:json-schema/example true}]]
[:spam {:json-schema/example :eggs, :optional true}
[:enum {:json-schema/example :eggs} :eggs]]]
(-> Example
fm/->malli
m/form)))
(is (m/validate
(fm/->malli Example)
{:foo "foo"
:bar {"integer" 100
:seq [:a :b :c]
:set #{1 3}}
:yes? true
:spam :eggs}))
(is (= [{:in [:foo], :value 1}
{:in [:bar], :value nil}
{:in [:spam], :value "ham"}]
(mapv #(select-keys % [:in :value])
(:errors (m/explain
(fm/->malli Example)
{:foo 1
:yes? true
:spam "ham"})))))
(testing "closed"
(is
(= '[[[:extra] :malli.core/extra-key]]
Expand Down Expand Up @@ -108,7 +178,7 @@
[:foo {:optional true} :string]
[:relation_info [:map {:closed true} [:malli.core/default [:map-of :keyword :any]]]]]]
(is (= expected-schema
(m/form (fm/->malli OptionalKeywordMapEntryExample)))))
(->malli-frm OptionalKeywordMapEntryExample))))
(is (m/validate
(fm/->malli OptionalKeywordMapEntryExample)
{:foo "a"
Expand All @@ -126,21 +196,32 @@

(deftest signature-type->malli
(is (= [:=> :cat :any]
(m/form (fm/->malli (f/sig :parameters [])))))

(let [return (f/int)]
(is (= [:=> :cat :int]
(m/form (fm/->malli (f/sig :parameters []
:return return))))))

(let [a (f/int)
b (f/int)]
(is (= [:=> [:cat :int :int] :any]
(m/form (fm/->malli (f/sig :parameters [a b]))))))
(->malli-frm (f/sig :parameters []))))
(is (= [:=> :cat :int]
(->malli-frm (f/sig :parameters []
:return (f/int)))))
(is (= [:=> [:cat :int :int] :any]
(->malli-frm (f/sig :parameters [(f/int) (f/int)]))))
(is (= [:=> [:cat [:cat :int :int] [:* :string]] :any]
(->malli-frm (f/sig :parameters [(f/int) (f/int)]
:rest-parameter (f/str))))))

(let [a (f/int)
b (f/int)
c (f/str)]
(is (= [:=> [:cat [:cat :int :int] [:* :string]] :any]
(m/form (fm/->malli (f/sig :parameters [a b]
:rest-parameter c)))))))
(deftest swagger-test
(is (= {:type "object"
:properties {:foo {:type "string", :example "string"}
:bar {:type "object"
:properties {"integer" {:type "integer", :format "int64", :example 10}
:seq {:type "array", :items {:type "string", :example :keyword}, :example [:keyword]}
:set {:type "array", :items {:type "integer", :enum [1 2 3], :example 1}
:uniqueItems true, :example #{1}}}
:required ["integer" :seq :set]
:additionalProperties false, :example {"integer" 10, :seq [:keyword], :set #{1}}}
:yes? {:type "boolean", :example true}
:spam {:type "string", :enum [:eggs], :example :eggs}}
:required [:foo :bar :yes?]
:additionalProperties false
:example {:foo "string", :bar {"integer" 10, :seq [:keyword], :set #{1}}, :yes? true, :spam :eggs}
:description "Example"}
(-> Example
fm/->malli
ms/transform))))
Loading