Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BulkRequestを、旧kintone-js-sdkのような仕様で使いたい #12

Open
the-red opened this issue Nov 23, 2020 · 3 comments
Open
Labels
feature request Feature request pkg: rest-api-client @kintone/rest-api-client

Comments

@the-red
Copy link

the-red commented Nov 23, 2020

Package(対象パッケージ)

  • @kintone/rest-api-client

Why(なぜ)

旧kintone-js-sdkでは、
js-sdkの各種メソッドを使ってBulkRequestを投げることができて便利でした。
https://kintone-labs.github.io/kintone-js-sdk/latest/reference/bulk-request/

rest-api-clientのBulkRequestは、
完全に生のREST APIのリクエストボディを渡さなければいけないのですね。
これは何故でしょう?旧js-sdkの仕様では不都合ありましたか?
https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/bulkRequest.md

What(何を)

たとえばPromise.all()のような感覚で、こんな風にrest-api-clientの各メソッドを使って
リクエスト投げられると、とてもいいなーと思います。

  const params = {
    requests: [
      () => client.record.getAllRecords(...),
      () => client.record.addRecord(...),
      () => client.record.updateRecord(...),
    ],
  };
  try {
    const res = await client.bulkRequest(params);
    console.log(res);
  } catch (err) {
    console.log(err);
  }
@b4h0-c4t
Copy link

@the-red
フィードバックありがとうございます。
不都合があったわけではありませんが、 bulkRequest の設計時にkintone JS SDKのような仕様にすることを検討していませんでした。

現状のインターフェースの場合に不都合の発生する具体的な例がございましたら、参考までに教えて頂いても宜しいでしょうか?

@the-red
Copy link
Author

the-red commented Nov 24, 2020

@b4h0-c4t
回答ありがとうございます。

せっかくSDKとしてaddRecordsみたいに使いやすいメソッドが用意されているので、
BulkRequest時も同じ感覚でコードが書けるとDX上がると思うのです。

目的は「バルクリクエストを使ってAPIを叩くこと」のではなく、
「複数の処理を同時に行って、適切な範囲でロールバックをすること」なので、
バルクリクエストも、単体リクエストと頭切り替えずに使えると、開発しやすいです。

@shisama
Copy link
Contributor

shisama commented Nov 25, 2020

@the-red
ありがとうございます!理解しました。現在のようなインターフェースに加え、ご提示いただいたようなより使いやすいインターフェースの追加も今後検討します。

@zaki-yama zaki-yama added pkg: rest-api-client @kintone/rest-api-client feature request Feature request labels Mar 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Feature request pkg: rest-api-client @kintone/rest-api-client
Projects
None yet
Development

No branches or pull requests

4 participants