contains? broken for transient collections

Description

Behavior with Clojure 1.6.0:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 user=> (contains? (transient {:x "fine"}) :x) IllegalArgumentException contains? not supported on type: clojure.lang.PersistentArrayMap$TransientArrayMap clojure.lang.RT.contains (RT.java:724) ;; expected: true user=> (contains? (transient (hash-map :x "fine")) :x) IllegalArgumentException contains? not supported on type: clojure.lang.PersistentHashMap$TransientHashMap clojure.lang.RT.contains (RT.java:724) ;; expected: true user=> (contains? (transient [1 2 3]) 0) IllegalArgumentException contains? not supported on type: clojure.lang.PersistentVector$TransientVector clojure.lang.RT.contains (RT.java:724) ;; expected: true user=> (contains? (transient #{:x}) :x) IllegalArgumentException contains? not supported on type: clojure.lang.PersistentHashSet$TransientHashSet clojure.lang.RT.contains (RT.java:724) ;; expected: true user=> (:x (transient #{:x})) nil ;; expected: :x user=> (get (transient #{:x}) :x) nil ;; expected: :x

Cause: This is caused by expectations in clojure.lang.RT regarding the type of collections for some methods, e.g. contains() and getFrom(). Checking for contains looks to see if the instance passed in is Associative (a subinterface of PersistentCollection), or IPersistentSet.

Approach: Expand the types that RT.getFrom(), RT.contains(), and RT.find() can handle to cover the additional transient interfaces.

Alternative: Other older patches (prob best exemplified by clj-700-8.diff) restructure the collections type hierarchy. That is a much bigger change than the one taken here but is perhaps a better long-term path. That patch refactors several of the Clojure interfaces so that logic abstract from the issue of immutability is pulled out to a general interface (e.g. ISet, IAssociative), but preserves the contract specified (e.g. Associatives only return Associatives when calling assoc()). With more general interfaces in place the contains() and getFrom() methods were then altered to conditionally use the general interfaces which are agnostic of persistence vs. transience.

Screening Notes re -10 patch

  • the extra conditions in RT add branches to some key functions. get already has a getFrom optimization, but there is no similar containsFrom or findFrom. Is it worth measuring the possible impact of these?

  • I believe the interface refactoring approach (not taken here) is worth separate consideration as an enhancement. If this is done, I think leveraging valAt would be simpler, e.g. allowing HashMap and ArrayMap to share code

  • it is not evident (to me anyway) why some API fns consume ILookup and others do not, among e.g. contains?, get, and find. Possible doc enhancement?

  • there is test code already in place (data_structures.clj) that could easily be expanded to cover transients. It would be nice to do this, or better yet get some test.check tests in place

Patch: clj-700-14.patch is based on clj-700-10, plus implements Rich's suggestion that entryAt and containsKey should live in ITransientAssociative2 and the existing concrete impls (ATransientMap, TransientVector) now implement it.

Environment

None

Status

Assignee

Rich Hickey

Reporter

Herwig Hochleitner

Labels

Approval

Ok

Patch

Code and Test

Fix versions

Affects versions

Release 1.2

Priority

Critical
Configure