Clojure 1.13 adds support for checked keys

(clojure.org)

133 points | by FelipeCortez 3 days ago

7 comments

  • slifin 3 hours ago
    This is a case I never really thought about - if the key is missing today you'll get nil as the value and since Clojure is a nil punning language it usually does sensible behaviour in your program

    I know this sounds unreliable but in practise I like a language that defaults to pragmatic code paths so I don't have to stay up at night imagining a million code paths

    This adds a throwing codepath which is quite drastic so I'm glad people don't build this into programs everywhere - I'd be nice to hear what the team imagine as the use case for this

    Normally for correctness I'd like to see specs at the boundaries for programs and different test suites for internal behaviours

    • kevincox 1 hour ago
      The problem in my experience is that while nil is a perfectly reasonable default 9/10 times that 1/10 happens often enough and causes major problems that it is worth taking the extra few seconds to write it explicitly in the code to acknowledge that case and that you have checked that it is fine in the 9/10 cases or handle it in the 1/10 case.

      I have seen multiple major production outages in Golang code because people accidentally read a non-existent map key and used the default value. As a funny bonus in one of those cases we were stumped when debugging because this code had tests, but the tests were also reading the default values out of the map and asserting that "" was in fact a valid textproto (it always is!) so silently testing nothing.

      So even if defaults are useful 9/10 times that 1/10 is so painful and expensive that it isn't worth it in my experience. The time spent responding to, debugging and fixing those outages far, far outweighed the time saved by the convenient default values in the 9/10 times.

    • jimbokun 21 minutes ago
      This is really the kind of thing you want to fail at compile time which isn’t real possible in a dynamic language like Clojure.
    • xoxolian 1 hour ago
      For me: documentation at the "front door" of an interface, especially in that long moment before you decide to add a spec or Malli schema.
  • hk__2 3 hours ago
    Some explanations from https://clojure.atlassian.net/browse/CLJ-2961:

    > Clojure’s idiomatic use of maps has proven valuable, but missing required keys, misspelled keys, and invalid values can lead to failures that do not connect to the actual source of the problem (e.g. NPEs) making diagnosis difficult. At the same time, Clojure lacks a simple inline mechanism for functions to document and check the keys they require and accept. Existing tools either separate those expectations from the function itself or couple data shape and data provision.

  • moomin 2 hours ago
    This is actually great, and I predict that fans of nil-punning will rapidly discover the joys of actually having errors trigger where the error was introduced rather than propagating through the program.

    Any news on ClojureScript gaining the feature?

    • swannodette 2 hours ago
      Working on it :)
      • embedding-shape 2 hours ago
        Amazing! What are the most interesting areas for ClojureScript in the future, if you don't mind me asking for some casual semi-serious prediction?

        Thanks for everything you've done for Clojure and ClojureScript, I'd surely have dropped programming as a whole if I didn't discover Clojure and ClojureScript at the time I did.

        • swannodette 2 hours ago
          Honestly what's mostly at the forefront of my mind is greatly improving the documentation around ClojureScript as well as our fork of Google Closure Library (GCL). At work we've switched to DataStar (a single JS include) and coupled that with ClojureScript/GCL - we no longer rely on anything from NPM, to call this a simplification would be a gross understatement. Bundle size is 30K gzipped and we spend no time thinking about our build or JS tooling/dependency tomfoolery.

          So less about ClojureScript specifically, and more generally how I think we're well situated for people looking for a way out. The current mainstream practice dead end is bigger than the one that made React (also originally just a script tag include) appealing to me back in 2013. There are of course many ways forward that don't involve CLJS, but I think ClojureScript/GCL and the new crop of NPM-dep free pure CLJS solutions like Replicant are well situated for folks who can see that accepted practices are not delivering enough value even with AI assistance.

    • fnordsensei 2 hours ago
      Well, kind of. This is the kind of problem that you might throw schemas (eg. Malli) at pre 1.13.

      It’ll be nice to have it at hand in the base language though.

    • akkad33 2 hours ago
      What is nil-punning?
      • undershirt 56 minutes ago
        allowing functions to treat missing arguments as empty versions of their expected types, which is useful sometimes
  • temporallobe 2 hours ago
    We just updated one of our projects to 1.12.5, but I might push for 1.13 as this could be very useful, although an alpha version might raise questions.
  • ndr 3 hours ago
    Is it only me or this sounds a bit counter to clojure philosophy?
    • summarybot 2 hours ago
      As a Clojurist the standard pattern for ensuring keys-are-set before doing-something is not-as-elegant-as-this. Clojure is full of macros that do useful things :) Simplifying oft-used patterns into compact representations is very on-brand. Plus, you need this like, all the time.

      This will eliminate two whole classes of errors: 1) where keys are supplied a value at an undesired nesting-level. 2) where keys are not-yet-set for some other reason.

      For the many programmers who have to write in checks and verifications themselves for this, this saves quite a bit of time, removing the interruption from coding and restoring the flow of getting logic-to-symbol.

    • rads 3 hours ago
      The maps are still open to new keys even if some keys are checked. I think that fits in with how clojure.spec and Malli work already, but in a lighter syntax.
      • codemonkey-zeta 1 hour ago
        The maps haven't changed at all, this is a feature at destructuring sites.
        • rads 1 hour ago
          Sorry if I wasn’t clear, I was referring to the maps that are being destructured.
    • embedding-shape 2 hours ago
      Seems additive to me; no breaking changes, and better control and error messages when opting in for it, seems entirely Clojurely to me.
    • erichocean 3 hours ago
      It's 100% opt-in at the call site and doesn't affect existing code, so no?

      Many people (including myself) already have checked key variants for maps; this mainly extends the syntax to destructuring too.

    • bcrosby95 2 hours ago
      Howso?
  • thom 1 hour ago
    Ah yes, the missing seventeenth way to validate function parameters.
  • exabrial 1 hour ago
    I love the idea of clojure and perfect immutability, but holy crap I cannot grok the syntax. My C-trained brain explodes.
    • beders 1 hour ago
      It'll take a while but now other programming languages look alien to me. Once you've adopted s-expressions it is hard to go back.
    • wry_discontent 7 minutes ago
      You get over it really quickly once you start actually using it. I find it basically impossible to read Clojure outside the editor in any meaningful sense.
    • erichocean 1 hour ago
      It took about two weeks for me to be able to read it.

      Might as well have been Russian.

      Now it's as natural as any other language.