824b30defd
The success checker fired only against core-fn error domains (stable, not
redefinable). This adds reporting of a call that passes a provably-wrong
type to a USER fn whose body requires otherwise — e.g. a fn that only does
arithmetic on a param, called with a string.
As check-walk sees defs it registers each non-redefinable single-fixed-arity
user fn's {:params :body} in module state (user-sig-box, accumulating across
forms like rtenv-box — a def must precede its call). At a call site (strict
mode only) the body is re-checked with ONE parameter bound to its concrete
argument type, others :any; if that produces a diagnostic the all-:any body
did not, the argument alone is provably wrong and the call is reported.
Monotonic — binding a concrete type can only add error-domain hits — so still
no false positives. A cycle guard (checking-box) terminates mutual recursion.
Gated behind JOLT_TYPE_CHECK_USER (orthogonal to the warn/error level)
because it rests on the closed-world assumption, weaker than the core-fn
case. check-form gains a strict? arity; the default path is unchanged and
user-fn code runs only when the checker is enabled. ^:redef/^:dynamic and
multi/variadic fns are not registered (their body is no stable requirement).
Gate green, suite 4718, conformance 335/335.
102 lines
5.7 KiB
Text
102 lines
5.7 KiB
Text
# Success-type checking (RFC 0006, jolt-y3b). The structural inference of
|
|
# RFC 0005, reused as a loose checker: flag a core-fn call ONLY when an argument
|
|
# is PROVABLY the wrong type (concrete and in the op's throwing error domain).
|
|
# Ambiguous cases (:any, unions, :truthy) are accepted — no false positives.
|
|
(import ../../src/jolt/api :as api)
|
|
(import ../../src/jolt/backend :as backend)
|
|
(import ../../src/jolt/types :as types)
|
|
(import ../../src/jolt/reader :as reader)
|
|
|
|
(print "Success-type checking (jolt-y3b)...")
|
|
|
|
(os/setenv "JOLT_DIRECT_LINK" "1")
|
|
(def ctx (api/init {:compile? true}))
|
|
(def pns (types/ctx-find-ns ctx "jolt.passes"))
|
|
(def check (types/var-get (types/ns-find pns "check-form")))
|
|
|
|
# diagnostics (a Janet tuple of diag structs) for a source form
|
|
(defn diags [src]
|
|
(api/normalize-pvecs (check (backend/analyze-form ctx (reader/parse-string src)))))
|
|
(defn nd [src] (length (diags src)))
|
|
# strict mode (jolt-zo1): also report provably-wrong calls to user fns
|
|
(defn nds [src]
|
|
(length (api/normalize-pvecs
|
|
(check (backend/analyze-form ctx (reader/parse-string src)) true))))
|
|
|
|
# --- provably wrong: REPORTED ------------------------------------------------
|
|
(assert (= 1 (nd "(inc \"x\")")) "inc on a string")
|
|
(assert (= 1 (nd "(+ 1 \"x\")")) "+ with a string arg")
|
|
(assert (= 1 (nd "(count :foo)")) "count of a keyword")
|
|
(assert (= 1 (nd "(count 5)")) "count of a number")
|
|
(assert (= 1 (nd "(first 42)")) "first of a number")
|
|
(assert (= 1 (nd "(nth :k 0)")) "nth of a keyword")
|
|
(assert (= 1 (nd "(let [n \"x\"] (inc n))")) "inc on a let-bound string")
|
|
(assert (= 1 (nd "(inc (count :k))")) "inner count of keyword reported (inc of :num is fine)")
|
|
|
|
# --- ambiguous / lenient: ACCEPTED (no false positive) -----------------------
|
|
(assert (= 0 (nd "(:k 5)")) "keyword lookup on a number returns nil, not an error")
|
|
(assert (= 0 (nd "(get 5 :k)")) "get on a number returns nil, not an error")
|
|
(assert (= 0 (nd "(fn [x] (inc x))")) "inc on an unknown (:any) param accepted")
|
|
(assert (= 0 (nd "(fn [c] (inc (if c 1 \"x\")))")) "inc on a {:num | :str} branch -> :any, accepted")
|
|
(assert (= 0 (nd "(count \"ab\")")) "count of a string is fine")
|
|
(assert (= 0 (nd "(count [1 2 3])")) "count of a vector is fine")
|
|
(assert (= 0 (nd "(first [1 2 3])")) "first of a vector is fine")
|
|
(assert (= 0 (nd "(inc (count [1 2 3]))")) "count of vector + inc of :num both fine")
|
|
(assert (= 0 (nd "(inc (first [1 2 3]))")) "first of vector -> :num, inc fine")
|
|
|
|
# --- bounded unions (jolt-pz5): report only when EVERY member is in the error
|
|
# domain; accept when any member is valid. Differing branches used to collapse
|
|
# to :any (accepted); now they form {:union #{...}} and are checked per-member.
|
|
(assert (= 1 (nd "(fn [c] (inc (if c \"a\" :k)))"))
|
|
"inc of {:str | :kw} — every member non-number — reported")
|
|
(assert (= 0 (nd "(fn [c] (inc (if c 1 \"x\")))"))
|
|
"inc of {:num | :str} — :num is fine — still accepted")
|
|
(assert (= 1 (nd "(fn [c] (count (if c :k 5)))"))
|
|
"count of {:kw | :num} — both non-seqable — reported")
|
|
(assert (= 0 (nd "(fn [c] (count (if c :k \"ab\")))"))
|
|
"count of {:kw | :str} — :str is seqable — accepted")
|
|
(assert (= 1 (nd "(fn [c] (inc (if c \"a\" (if c :k :j))))"))
|
|
"inc of nested all-non-number union reported")
|
|
(assert (= 0 (nd "(fn [c] (inc (if c \"a\" (if c :k 1))))"))
|
|
"inc of union with a buried :num member accepted")
|
|
# a union is opaque to structural specialization — it keeps the dynamic guard,
|
|
# exactly like :any, so a keyword lookup over it is never mis-specialized.
|
|
(assert (= 0 (nd "(fn [c] (:r (if c {:r 1} {:g 2})))"))
|
|
"keyword lookup over a struct union is accepted (no false positive)")
|
|
|
|
# --- user-function error domains (jolt-zo1), opt-in strict mode --------------
|
|
# A call passing a provably-wrong type to a user fn whose body requires
|
|
# otherwise is reported ONLY in strict mode; the default level never fires on
|
|
# user fns (closed-world soundness boundary).
|
|
(assert (= 0 (nd "(do (defn ufa [x] (+ x 1)) (ufa \"s\"))"))
|
|
"user-fn wrong call NOT reported at the default level")
|
|
(assert (= 1 (nds "(do (defn ufa [x] (+ x 1)) (ufa \"s\"))"))
|
|
"strict: arithmetic fn called with a string is reported")
|
|
(assert (= 0 (nds "(do (defn ufb [x] (+ x 1)) (ufb 5))"))
|
|
"strict: same fn called with a number is accepted")
|
|
(assert (= 0 (nds "(do (defn ufc [x] (:k x)) (ufc \"s\"))"))
|
|
"strict: a body that uses the param leniently is not reported")
|
|
# cross-form: a def registered by an earlier check is visible to a later call
|
|
(nds "(defn ufd [x] (count x))")
|
|
(assert (= 1 (nds "(ufd 42)"))
|
|
"strict: cross-form call to a seq-only fn with a number is reported")
|
|
(assert (= 0 (nds "(do (defn ^:redef ufe [x] (+ x 1)) (ufe \"s\"))"))
|
|
"strict: a ^:redef fn is not a stable requirement, not reported")
|
|
(assert (= 1 (nds "(do (defn ufrec [x] (ufrec (+ x 1))) (ufrec \"s\"))"))
|
|
"strict: self-recursion terminates (cycle guard) and the (+ x 1) on a string is reported once")
|
|
|
|
# --- the diagnostic carries op + type + a message ----------------------------
|
|
(def one (in (diags "(inc \"x\")") 0))
|
|
(assert (= "inc" (get one :op)) "diagnostic names the op")
|
|
(assert (string/find "number" (get one :msg)) "message says a number is required")
|
|
|
|
# --- end-to-end: strictness drives compilation (decoupled from :inline?) -----
|
|
# error mode aborts a provably-wrong form's compilation; a correct form compiles.
|
|
(os/setenv "JOLT_TYPE_CHECK" "error")
|
|
(assert (not (first (protect (api/eval-string ctx "(count :nope)"))))
|
|
"error mode aborts a provably-wrong form")
|
|
(assert (first (protect (api/eval-string ctx "(count [1 2 3])")))
|
|
"error mode accepts a correct form")
|
|
(os/setenv "JOLT_TYPE_CHECK" "off")
|
|
|
|
(print "Success-type checking passed!")
|