kawasima / fressian-cljs

Fressian library for clojurescript

fressian-cljs

Read and write fressian data by clojurescript.

Installation

Add the following to your project.clj

[net.unit8/fressian-cljs "0.1.0"]

Usage

Fressian-cljs uses ArrayBuffer to read/write fressian objects.

(ns myapp
  (:require [fressian-cljs.core :as fress])

(let [connection (js/WebSocket. "ws://websocket-host")]
  (set! connection -onmessage #(println (fress/read %)))
  (.send connection (fress/write {:a 1 :b 2})))

License

Copyright (C) 2014 kawasima

Distributed under the Eclipse Public License, the same as Clojure.

fressian-cljs's Issues

Error compiling

[net.unit8/fressian-cljs "0.1.0"]

(ns datascript-test.core
  (:require [fressian-cljs.core :as fress]))

(fress/write {:hi "there"})

Invalid :refer, var fressian-cljs.fns/lookup does not exist

Endian issue?

I noticed that when I send data from a backend server using data.fressian (https://github.com/clojure/data.fressian) over a websocket to the browser, fressian-cljs is deserializing decimal numbers incorrectly. Strings, integers, and keywords come through fine though.

I'm guessing this may be an endian issue. data.fressian serializes data in Java in big-endian format, but fressian-cljs uses js ArrayBuffer to deserialize into, and ArrayBuffer will use the machine endianness, which for me is little-endian (Intel).

Perhaps DataView could be applied to solve this issue? https://developer.mozilla.org/en-US/docs/Web/API/DataView

WebSocket needs arraybuffer binaryType

If I write binary fressian from the server to the host then this only works if the websocket has been configured to deliver messages as ArrayBuffer objects, since by default they arrive as Blob objects.

Doing this:

(set! (.-binaryType web-socket) "arraybuffer")

Fixed the problem.

I saw that you have an unimplemented method to handle reading js/Blob, but I don't think that will work with the same synchronous interface you've defined for reading arrays. Reading a Blob into an ArrayBuffer is asynchronous, so you would have to call a callback or write onto a channel to hand back the result.

Thanks for writing this.