Fixes #1197 adds ExtendedErrorHandler info in JP #1227
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #1227 +/- ##
=======================================
Coverage 73.22% 73.22%
=======================================
Files 17 17
Lines 1438 1438
Branches 431 431
=======================================
Hits 1053 1053
Misses 300 300
Partials 85 85 Continue to review full report at Codecov.
|
seratch
requested changes
Dec 2, 2021
docs/_advanced/ja_error_handling.md
Outdated
| <details class="secondary-wrapper"> | ||
| <summary class="section-head" markdown="0"> | ||
| <h4 class="section-head">エラーハンドラーでのさらなるデータを参照する</h4> |
There was a problem hiding this comment.
The section title needs to be a noun form for consistency
Suggested change
| <h4 class="section-head">エラーハンドラーでのさらなるデータを参照する</h4> | |
| <h4 class="section-head">エラーハンドラーでのさらなるデータの参照</h4> |
docs/_advanced/ja_error_handling.md
Outdated
|
|
||
| <div class="secondary-content" markdown="0"> | ||
| グローバルエラーハンドラーでリクエストからのデータをログする必要があるでしょう。または、単に Bolt で指定した `logger` を利用したい場合があるでしょう。 |
There was a problem hiding this comment.
"There may be" can be "〜したい場合もあるでしょう" or "〜したい場合があるかもしれません". If you say "する必要があるでしょう", this means "you need to do" or "there is a need to do"
Also, "利用したい場合があるでしょう" is not natural.
Suggested change
| グローバルエラーハンドラーでリクエストからのデータをログする必要があるでしょう。または、単に Bolt で指定した `logger` を利用したい場合があるでしょう。 | |
| グローバルエラーハンドラーの中で、リクエストからのデータをログ出力したい場合もあるでしょう。あるいは単に Bolt に設定した `logger` を利用したい場合もあるでしょう。 |
docs/_advanced/ja_error_handling.md
Outdated
| グローバルエラーハンドラーでリクエストからのデータをログする必要があるでしょう。または、単に Bolt で指定した `logger` を利用したい場合があるでしょう。 | ||
|
|
||
| バージョン 3.8.0 から初め、 `extendedErrorHandler: true` をコンストラクターに渡すとリクエストの `error` 、 `logger` 、 `context` 、 `body`を含むオブジェクトがエラーハンドラーに追加されます。 |
There was a problem hiding this comment.
Suggested change
| バージョン 3.8.0 から初め、 `extendedErrorHandler: true` をコンストラクターに渡すとリクエストの `error` 、 `logger` 、 `context` 、 `body`を含むオブジェクトがエラーハンドラーに追加されます。 | |
| バージョン 3.8.0 からは、コンストラクターに `extendedErrorHandler: true` を渡すと、エラーハンドラーはリクエストの `error` 、 `logger` 、 `context` 、 `body` を含むオブジェクトを受け取ります。 |
docs/_advanced/ja_error_handling.md
Outdated
|
|
||
| app.error(({ error, logger, context, body }) => { | ||
| // Bolt で指定した logger を使ってエラーをログ出力させる |
There was a problem hiding this comment.
Suggested change
| // Bolt で指定した logger を使ってエラーをログ出力させる | |
| // Bolt で指定した logger を使ってエラー内容をログ出力 |
docs/_advanced/ja_error_handling.md
Outdated
|
|
||
| if (context.teamId) { | ||
| // デバッグ目的で、`teamId` を使う |
There was a problem hiding this comment.
Suggested change
| // デバッグ目的で、`teamId` を使う | |
| // デバッグのために teamId を使ってなんらかの処理 |
docs/_advanced/ja_error_handling.md
Outdated
| バージョン 3.8.0 から初め、 `extendedErrorHandler: true` をコンストラクターに渡すとリクエストの `error` 、 `logger` 、 `context` 、 `body`を含むオブジェクトがエラーハンドラーに追加されます。 | ||
|
|
||
| リクエストライフサイクル中に、どの時点でもエラーは生じることがあります(例： `context` での特定したプロパティを指定する前に)。また、 `body` オブジェクトに利用できるデータはイベントによって異なります。これらの理由のため、値を利用する前に `context` と `body` オブジェクトに指定するプロパティの有無を確認することをおすすめします。 |
There was a problem hiding this comment.
A few comments:
- リクエストライフサイクル中に <- this does not make sense. you can say リクエストのライフサイクルの中で
- どの時点でも <- this is okay but I think more accurate meaning here should be どのタイミングでも
- 生じる <- We tend to only use 発生する for errors
- body オブジェクトに利用できるデータ <- this is not correct; "body オブジェクト内で利用可能な/存在するデータ" should be correct.
- これらの理由のため <- If you use this phrase, これらの理由から would be better
- オブジェクトに指定するプロパティの有無 <- if you say オブジェクトに存在するかを確認する, that's fine but the current sentence is not smooth and a bit confusing
If I were you, I would translate the sentence this way:
contextやbodyオブジェクト内にアクセスしたいプロパティが存在するかどうかをチェックすることをおすすめします。なぜならbodyオブジェクト内に存在するデータはイベント毎に異なりますし、エラーはリクエストのライフサイクルの中のどんなタイミング（例えばcontextのプロパティが設定される前）でも発生しうるからです。
docs/_tutorials/ja_reference.md
Outdated
| @@ -114,6 +114,7 @@ App オプションは、`App` のコンストラクターに渡します。 | |||
| | `authorize` | 複数のチームでのインストールをサポートする場合に使用する関数。どのトークンが受信イベントに関連づけられているかを判断するのに使用します。`authorize` 関数に渡される元データには、場合によって `userId`、`conversationId`、`enterpriseId`、`teamId`、`isEnterpriseInstall` が含まれます（受信イベントによって異なります）。`authorize` 関数は、`botToken`、`botId`、`botUserId`、または `userToken`を返します。[ビルトインの OAuth サポート](/bolt-js/concepts#authenticating-oauth)を使用する場合、`authorize` 関数は自動的に作成されるため、自分で渡す必要はありません。`authorize` 関数について詳しくは、こちらを参照してください。 | | |||
| | `logger` | ビルトインのロガーの代わりにカスタムのロガーを渡すためのオプション。ロガーには特定のメソッドが実装されている必要があります。これには [`Logger` インターフェイス](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts)で定義されている `setLevel(level:LogLevel)`、`getLevel()`、`setName(name: string)`、`debug(...msgs: any\[])`、`info(...msgs: any\[])`、`warn(...msgs: any\[])`、`error(...msgs: any\[])` があります。ログ出力の詳細については、[ドキュメント](/bolt-js/concepts#logging)を参照してください。 | | |||
| | `logLevel` | 出力するログのレベルを指定するオプション。`LogLevel` の出力に含まれる情報のレベルには、重要度の低い順から高い順に `DEBUG`、`INFO`、`WARN`、`ERROR` があります。デフォルトの `logLevel` は `INFO` に設定されています。ログ出力の詳細については、[ドキュメント](/bolt-js/concepts#logging)を参照してください。 | | |||
| | `extendedErrorHandler` | 真偽値を指定するオプションで、 `true` に設定するとさらなるリクエストのコンテキスト情報を含んだオブジェクトがグローバルエラーハンドラーに渡されます。 バージョン 3.8.0 から利用することができます。 デフォルトは `false` です。 より高度なエラーの処理に関する詳細は [API ドキュメント](/bolt-js/ja-jp/concepts#error-handling))を参照してください。 | | |||
There was a problem hiding this comment.
Suggested change
| | `extendedErrorHandler` | 真偽値を指定するオプションで、 `true` に設定するとさらなるリクエストのコンテキスト情報を含んだオブジェクトがグローバルエラーハンドラーに渡されます。 バージョン 3.8.0 から利用することができます。 デフォルトは `false` です。 より高度なエラーの処理に関する詳細は [API ドキュメント](/bolt-js/ja-jp/concepts#error-handling))を参照してください。 | | |
| | `extendedErrorHandler` | 真偽値を指定するオプションで、 `true` に設定するとさらなるリクエストのコンテキスト情報を含んだオブジェクトがグローバルエラーハンドラーに渡されます。 バージョン 3.8.0 から利用することができます。 デフォルトは `false` です。 より高度なエラーの処理に関する詳細は [API ドキュメント](/bolt-js/ja-jp/concepts#error-handling)を参照してください。 | |
seratch
approved these changes
Dec 3, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updated the extended error handling section of the docs in JP
Requirements (place an
xin each[ ])