- wrap lderror in sharedb error format so we can't decode it back to a lderror object in client side.

 - bump version

Author: zbryikt

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Logs
 
+## v0.0.10
+
+ - wrap lderror in sharedb error format so we can't decode it back to a lderror object in client side.
+
+
 ## v0.0.9
 
  - remove `id` from `access` function in readSnapshots for multi-snapsthos scenario

README.md

@@ -130,9 +130,13 @@ If `access` is function provided, it will be called in following hooks:
 Here is an example to prevent new document creation: 
 
     access = ({snapshots}) ->
-      if snapshots and !(snapshots.0.id) => return Promise.reject(new Error("") <<< {name: 'lderror', id: 1012});
+      if snapshots and !(snapshots.0.id) =>
+        return lderror.reject 1012
       return Promise.resolve!
 
+Please note that ShareDB logs rejected errors (by recognizing its `stack` attribute) and wrap errors in `{code, message}` format. Consider rejecting a plain lderror object as above example, `@plotdb/ews` will wrap/parse your lderror objects for you so you can receive a correct lderror object in frontend.
+
+
 
 ## License
 

dist/sdb-client.js

@@ -56,7 +56,8 @@
       return (!this._connection
         ? this.connect()
         : Promise.resolve()).then(function(){
-        return new Promise(function(res, rej){
+        var p;
+        p = new Promise(function(res, rej){
           var doc;
           doc = this$._connection.get(collection != null ? collection : 'doc', id);
           return doc.fetch(function(e){
@@ -82,6 +83,12 @@
             }
           });
         });
+        return p['catch'](function(e){
+          if (e.code === 'wrapped-lderror') {
+            e = import$(new Error(), JSON.parse(e.message));
+          }
+          return Promise.reject(e);
+        });
       });
     },
     connect: function(){

dist/sdb-client.min.js

@@ -1,12 +1,32 @@
 (function(){
-  var sharedb, sharedbPostgres, sharedbPgMdb, ws, http, websocketJsonStream, ews, sdbServer;
+  var sharedb, sharedbPostgres, sharedbPgMdb, ws, http, websocketJsonStream, ews, lderrorWrapper, sdbServer;
   sharedb = require('sharedb');
   sharedbPostgres = require('@plotdb/sharedb-postgres');
   sharedbPgMdb = require('sharedb-pg-mdb');
   ws = require('ws');
   http = require('http');
   websocketJsonStream = require('websocket-json-stream');
   ews = require("./index");
+  lderrorWrapper = function(e){
+    if (!e) {
+      e = {
+        name: 'lderror',
+        id: 1012
+      };
+    }
+    if (e.name !== 'lderror') {
+      return e;
+    } else {
+      return {
+        code: "wrapped-lderror",
+        message: JSON.stringify({
+          id: e.id,
+          name: e.name,
+          message: e.message
+        })
+      };
+    }
+  };
   sdbServer = function(opt){
     var app, io, session, access, milestoneDb, wss, metadata, server, mdb, backend, connect, ret;
     app = opt.app, io = opt.io, session = opt.session, access = opt.access, milestoneDb = opt.milestoneDb, wss = opt.wss, metadata = opt.metadata;
@@ -93,8 +113,7 @@
         }, agent.custom)).then(function(){
           return cb();
         })['catch'](function(e){
-          var ref$;
-          return cb(e || (ref$ = new Error(), ref$.name = 'lderror', ref$.id = 1012, ref$));
+          return cb(lderrorWrapper(e));
         });
       });
       backend.use('submit', function(arg$, cb){
@@ -110,8 +129,7 @@
         }, agent.custom)).then(function(){
           return cb();
         })['catch'](function(e){
-          var ref$;
-          return cb(e || (ref$ = new Error(), ref$.name = 'lderror', ref$.id = 1012, ref$));
+          return cb(lderrorWrapper(e));
         });
       });
     }

dist/sdb-server.js

@@ -1,6 +1,6 @@
 {
   "name": "@plotdb/ews",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "elastic websocket",
   "main": "dist/index.min.js",
   "browser": "dist/index.min.js",

dist/sdb-server.min.js

@@ -22,14 +22,17 @@ ews.sdb-client.prototype = Object.create(Object.prototype) <<< do
 
   get: ({id, watch, create, collection}) ->
     <~ (if !@_connection => @connect! else Promise.resolve!).then _
-    (res, rej) <~ new Promise _
-    doc = @_connection.get (if collection? => collection else \doc), id
-    (e) <~ doc.fetch _
-    if e => return rej e
-    doc.subscribe (ops, source) -> res doc
-    doc.on \error, (err) ~> @fire \error, {doc, err}
-    if watch? => doc.on \op, (ops, source) -> watch ops, source
-    if !doc.type => doc.create ((if create => create! else null) or {})
+    p = new Promise (res, rej) ~>
+      doc = @_connection.get (if collection? => collection else \doc), id
+      (e) <~ doc.fetch _
+      if e => return rej e
+      doc.subscribe (ops, source) -> res doc
+      doc.on \error, (err) ~> @fire \error, {doc, err}
+      if watch? => doc.on \op, (ops, source) -> watch ops, source
+      if !doc.type => doc.create ((if create => create! else null) or {})
+    p.catch (e) ~>
+      if e.code == \wrapped-lderror => e = new Error! <<< JSON.parse(e.message)
+      Promise.reject e
 
   connect: ->
     if @_connection => return Promise.resolve!

package-lock.json

@@ -1,6 +1,18 @@
 require! <[sharedb @plotdb/sharedb-postgres sharedb-pg-mdb ws http websocket-json-stream]>
 ews = require "./index"
 
+# according to `lib/agent.js`, sharedb send Error to frontend as objects in `{code, message}` format:
+#  - https://github.com/share/sharedb/blob/master/lib/agent.js#L288 (`getReplyErrorObject` function)
+# where allowed error code (as string) can be found here:
+#  - https://github.com/share/sharedb/blob/master/lib/error.js#L15
+# however, this blocks our custom error object.
+# thus, we use a custom error code `wrapped-lderror` and stringify lderror in `message` field,
+# so we can decode it in frontend.
+lderror-wrapper = (e) ->
+  if !e => e = {name: \lderror, id: 1012}
+  if e.name != \lderror => e
+  else {code: "wrapped-lderror", message: JSON.stringify(e{id,name,message})}
+
 sdb-server = (opt) ->
   {app, io, session, access, milestone-db, wss, metadata} = opt
 
@@ -80,12 +92,12 @@ sdb-server = (opt) ->
       id = if snapshots.length > 1 => null else snapshots.0.id
       access({id, collection, snapshots, type: \readSnapshots} <<< agent.custom)
         .then -> cb!
-        .catch (e) -> cb(e or (new Error! <<< {name: \lderror, id: 1012}))
+        .catch (e) -> cb lderror-wrapper e
     backend.use \submit, ({collection, agent, id}, cb) ->
       if !agent.stream.ws => return cb!
       access({id, collection, type: \submit} <<< agent.custom)
         .then -> cb!
-        .catch (e) -> cb(e or (new Error! <<< {name: \lderror, id: 1012}))
+        .catch (e) -> cb lderror-wrapper e
 
   ret = { server, sdb: backend, connect, wss }