plaidev/bolt-rpc

:zap: super fast rpc module which can be extended by middlewares like express.js

bolt-rpc's Issues

track のマニュアルStop & Start

track のキャンセル機能がほしいです

serverからのtrackにidが欲しい

shared track cursor対応。
キャッシュの管理として考えた場合に、インクリメントされるidがあると便利

Consume minimum-rpc v1.0.0

cursor.update()の度にemitが走るが、データ取得が完了していない状態ならば待機状態に入るべき

• APIの完了が遅い場合
• データ取得条件の変更が短時間に連続で行われる場合

単体の問い合わせ処理を連続して行うと、処理完了が前後する可能性があります。

現在、cursor.update()を行うと、そのつど毎回問い合わせが発生しますが、問い合わせ完了まで次の問い合わせを行わないようにすることで、処理の前後を安定させた状態でtrackが可能になります。

• cursor.update(a)
  • → update query(a), callAPI(a)
• cursor.update(b)
  • → update query(b)
• cursor.update(c)
  • → update query(c)
• callAPI(a) done
  • → callback
  • → callAPI( c ) （update(b)はキャンセルされる）
• callAPI(c) done
  • → callback

連続して呼び出すRead OnlyのAPIはtrack/cursorを基本とし、問い合わせ条件変更にupdateを使うことで、動作は安定します。

track_path: falseの場合にjoinしないようにする

track_path or @track_path or methodなので、track_path=falseの場合にmethodが入ってしまう。

track_path ? @track_path ? methodであるべき。

reconnect時にtrack cursorはupdateするべき

サーバのreplaceで一時切断された場合などが想定される、再度methodがコールされるべき。

再接続時にtrackを再登録する

socket.ioが再接続を行なった場合に、track状態が解除されてしまう。
再接続のイベントを拾って、再track状態に復帰する。

分散処理のサポート

フロントからのクエリを、そのまま登録メソッドにバインドする作りだが、マルチスレッドでの動作が不自由。

socketの段階ではメッセージベースでやりとりしているので、子プロセスに処理を分散する中間層を入れることはできるのではないか。

trackに対するフィルタリング

サーバ側からtrackがかかった時に、APIの再実行を行うか否か判定するメソッドを登録できるようにする

timeを図れるようにする。

server.pre (req, res, next) ->
  start = #
  req.end () ->
    end = #
  next()

[bug] リクエストをhandshake時のものを共有している

https://github.com/plaidev/bolt-rpc/blob/master/src/server.coffee#L78

シャローコピーで対応

optionsの追加

dataはupdateされる可能性があるので、cursor作成時に紐付けるoptionsを追加する。
authに使う

trackがサーバー全体ではなく、room単位で伝わるようにする．

npmをアップデートする

1.4.xとして大きめの修正が入っているので、npmの方もアップデートしたい..

仕様調整およびリファクタリング

expressのuseに似せているが、挙動が直感的でない部分が多いので、修正する

• app.use 'module_name', subAppが自然に動くようにする
• sub_name_spaceの廃止
• track_pathをdelimiterで分解した最初のブロックをroomとする
  • track_path: '<key>.module.method'とすると、<key>がroom
  • track_pathのデフォルトはmethod名。明示的な指定もできるようにする
• res.track()出来るようにする
• メソッド実行後の自動trackをやめる
  • ほとんど使われていない機能
  • app.use {track: true}, (req, res) ->はexpress的な挙動で実装できてない
  • res.track()を明示的に呼ぶ方法に切り替え。middlewareでreq.end -> res.track()のようなこともできる

同じcursorに連続してtrackが投げられた場合のキャンセル

同じcursorに連続して(callbackが帰る前に)クエリが投げられた場合、2つめをキャンセルする

track cursorのpre処理で問い合わせをキャンセルできるようにする

throttle系の処理や、別途cache機構を保つ場合などに対応する

req.body, req.pathの追加

roomへの対応

refs https://github.com/plaidev/karte-io/issues/8558

sub namespaceをroomとして扱うように変更します。

StackServerの挙動テストのためにexpressのテストケースを使う

https://github.com/expressjs/express/blob/master/test/app.use.js

param周りの処理はほぼ不要に思うので、その辺りをどうするか？

カスタムエラーハンドリング

minimum-rpcから接続完了時のcallbackを受け取れていない

bolt-rpc/src/client.coffee

Line 182 in 408a0d0

super io_or_socket, options

圧縮オプション

エラー時のハンドリング

サーバサイドでAPIのエラーログを取りたいとき、ハンドリングを行うための手段が用意されていません。

expressの仕様に似せて、下記の設定を行えるようにします。

app = new Server()
app.use 'api_name', (req, res, next) ->
  run (err, data) ->
    return next err if err
    res.json data

app.use (err, req, res, next) ->
  console.log err
  next()

errオブジェクトの中にmessage以外も入れたい

err.codeとか

promisify

• return promise if callback function isn't specified.

const {data} = await client.send(path, query, options);
...

• auto cancel option with same parameters.

client.send(path, query, {autoCancel: true}, (err, data) => {
  //  if same path request is already called until this async callback.
  assert(err.message == 'AutoCancelled');
});

PromiseライクなクライアントAPI

元々のコールバックAPI

client.send 'add', {a: 1, b: 2}, (err, val) ->
  assert not err
  assert val is 3

PromiseライクAPI

cursor = client.send 'add', {a: 1, b: 2}
assert cursor.val is null # 初期値はnull
cursor.end (val) ->
# cursor.on 'end', (val) -> と同じ
  assert val is 3
  assert cursor.val is val
cursor.error (err) ->
# cursor.on 'error', (err) -> と同じ
  # エラーがあればここを通る
  assert cursor.err is err

updateができる

cursor.update({a: 2, b: 3})
cursor.end (val) ->
  assert val is 5

middleware

# {a: 1, b: 2} -> val = 3 のとき
cursor.map (val) ->
  return val * 2
cursor.map (val) ->
  return val - 1
cursor.end (val) ->
  assert val is 5

想定API

• cursor.val
• cursor.end((val)->)
• cursor.error((err)->)
• cursor.update(data)
• cursor.map((val)->)

参考

https://github.com/component/emitter

vueでの使用例

var vm = new Vue({
    el: '#content',
    data: {
        lists: todo.get('find', {})
    }
})

trackではなくgetというvue向けに単純なオブジェクトのみを返すAPIを作りました．
理由はこちら : http://tech.nitoyon.com/ja/blog/2014/06/30/vue-js-hook/

空のcursorを作りたい

# client = Client(xxx, xxx)
cur = client.track 'apiName'  # here
cur.error (err) ->
  console.log err

widget = Vue.extend
  data:
    conditions: {}
  watch:
    conditions: ->
      cur.update @conditions
  compiled: ->
    cur.end (data) ->
      # update widget view.

view = Vue.extend
  compiled: ->
    cur.end (data) ->
      # update view.

callbackにクエリパラメータを返してチェックできるようにする

callbackにクエリパラメータを返してチェックできるようにする