`TypeError: err.toJSON is not a function` when webhook URL is invalid
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 45/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- github-actions, javascript
調査の方向性
src/webhook.js の 36 行目で報告されている catch ブロックから始め、次に src/send.js と src/index.js からどのように呼び出されているかを確認します。無効な webhook URL が、例外に toJSON があると仮定せずに根本のエラーを報告するようにします。完了条件は、二次的な TypeError ではなく元の失敗が表示されることです。
索引モデルが issue の本文から書いたものです。
説明
This took a bit for me to track down (my own mistake), thanks to the real error not being shown in the action. If, for example, I accidentally quote the webhook URL, like:
- name: Notify Slack
uses: slackapi/slack-github-action@v2
with:
errors: true
payload: <redacted>
webhook: ${{ toJSON(secrets.SLACK_WEBHOOK_URL) }}
webhook-type: webhook-trigger
I get an exception thrown:
Run slackapi/slack-github-action@v2
Error: TypeError: err.toJSON is not a function
Error: err.toJSON is not a function
TypeError: err.toJSON is not a function
at Webhook.post (file:///home/runner/work/_actions/slackapi/slack-github-action/v2/src/webhook.js:36:1)
at post (file:///home/runner/work/_actions/slackapi/slack-github-action/v2/src/send.js:35:1)
at send (file:///home/runner/work/_actions/slackapi/slack-github-action/v2/src/send.js:15:1)
at file:///home/runner/work/_actions/slackapi/slack-github-action/v2/src/index.js:9:1
file:///home/runner/work/_actions/slackapi/slack-github-action/v2/src/webhook.js:36
const response = err.toJSON();
^
TypeError: err.toJSON is not a function
at Webhook.post (file:///home/runner/work/_actions/slackapi/slack-github-action/v2/src/webhook.js:36:1)
at post (file:///home/runner/work/_actions/slackapi/slack-github-action/v2/src/send.js:35:1)
at send (file:///home/runner/work/_actions/slackapi/slack-github-action/v2/src/send.js:15:1)
at file:///home/runner/work/_actions/slackapi/slack-github-action/v2/src/index.js:9:1
It looks like the catch block is assuming the exception will always have a toJSON function, but in my case it obviously doesn't.
The fix of course, was to remove the erroneous toJSON(...) wrapper from the webhook input, but it would have saved me a lot of time if the exception was handled better by thi action.
Note, the err.toJSON in the exception is unrelated to the toJSON in my input - its only coincidental that we both used (different) toJSON functions (JavaScript vs GitHub Expression respectively).
Cheers.
- 主要言語
- JavaScript
- スター
- 1.4k
- フォーク
- 200
- 平均マージ
- 2時間 59分
- マージ済み PR（30日）
- 6
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
slackapi/slack-github-action のほかの issue
-
docs
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
slackapi/slack-github-action#667 ·
-
discussion security semver:major
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
slackapi/slack-github-action#621 · コメント 1 件 · リアクション 1 件 ·
-
bug: Unexpected token 'o', "ok" is not valid JSON再び着手できるかも @zimeg が 51 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンdependencies question
slackapi/slack-github-action#671 · コメント 2 件 · 担当者 1 名 ·
-
needs info question
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
slackapi/slack-github-action#654 · コメント 7 件 · リアクション 5 件 ·
-
question
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
slackapi/slack-github-action#520 · コメント 1 件 ·
slackapi/slack-github-action の issue をすべて見る
似ている issue
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
PedestrianDynamics/pyFDS-Evac#476 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
aiko-chan-ai/DiscordBotClient#380 ·
-
Offisielle trærオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 3 日以内に返信
-
Add: Atlas TVオープンchannels:add check:passed
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 4 日以内に返信