ListRecord.Field array-shaped `message` still fails in the production GsonFactory (follow-up to #1587)
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
調査の方向性
GsonFactory.registerTypeAdapters と GsonListViewGroupingFactory から始めます。issue では、GsonListRecordFieldFactory を slack-api-model/src/main/java/com/slack/api/util/json/ に移動し、本番用ファクトリーに登録することを提案しています。既存のテストアダプターと ListRecordFieldTest を確認し、単一オブジェクトと配列の期待される処理を把握してください。本番用 GsonFactory が両方の形式を正常に解析できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Issue summary
When the Slack API returns a conversations.replies (or conversations.history) response that contains a Slack Lists item attachment, the SDK throws JsonSyntaxException whenever any ListRecord.Field.message value is a JSON array instead of a single object. The whole API call fails, and no Message data is returned.
This is the bug from #1587. #1590 (released in v1.49.0) closed #1587, but the bug is still in the production code path in v1.52.0.
Affected versions
- v1.46.0 through v1.48.1 (verified in #1587; also seen in production on v1.48.1)
- v1.49.0 through v1.52.0: the production
GsonFactoryhas no adapter forListRecord.Field. @maoppay saw the failure on v1.50.0 (comment in #1587), and the live probe in #1644 shows it too.
Why #1590 was not sufficient
#1590 changed two things:
ListRecord.Field(slack-api-model/src/main). It addedprivate transient List<Message> messagesandgetMessages()/setMessages(). The fieldmessageis still a singleMessage. Gson skipstransientfields and sets fields by reflection, not through setters. So without an adapter, Gson still maps the JSON keymessageto theMessagefield, and an array still fails.GsonListRecordFieldFactory, the adapter that converts the array. #1590 put it inslack-api-model/src/test/java/test_locally/util/list/and registered it only in the testGsonFactory(slack-api-model/src/test/java/test_locally/unit/GsonFactory.java).
ListRecordFieldTest parses with that test GsonFactory, so it passes. Real API calls parse with com.slack.api.util.json.GsonFactory in slack-api-client (MethodsClientImpl calls GsonFactory.createSnakeCase(config)), and that class does not register the adapter. Also, the json-logs/samples/api samples still have message as a single object, so the MockSlackApi tests (for example ConversationsTest) never see the array shape.
Minimal reproduction
import com.google.gson.Gson;
import com.slack.api.methods.response.conversations.ConversationsRepliesResponse;
import com.slack.api.util.json.GsonFactory;
public class Repro {
public static void main(String[] args) {
// Mirrors the shape Slack returns when a Lists item's `message` field
// has multiple values (array form).
String payload =
"{\"ok\":true,\"messages\":[{\"type\":\"message\",\"user\":\"U1\",\"ts\":\"1.0\","
+ "\"text\":\"hi\",\"attachments\":[{\"list_record\":{\"record\":{\"fields\":["
+ "{\"key\":\"name\",\"message\":{\"text\":\"ok\"}},"
+ "{\"key\":\"details\",\"message\":[{\"text\":\"a\"},{\"text\":\"b\"}]}"
+ "]}}}]}]}";
Gson sdkGson = GsonFactory.createSnakeCase();
// Still throws JsonSyntaxException on v1.52.0 at
// $.messages[0].attachments[0].list_record.record.fields[1].message
ConversationsRepliesResponse parsed =
sdkGson.fromJson(payload, ConversationsRepliesResponse.class);
}
}
Expected behavior
The SDK accepts both single-object and array shapes for ListRecord.Field.message in real API responses, as getMessages() from #1590 intends.
Proposed fix
#1654 moves GsonListRecordFieldFactory to slack-api-model/src/main/java/com/slack/api/util/json/ (next to GsonListViewGroupingFactory) and registers it in GsonFactory.registerTypeAdapters.
- 主要言語
- Java
- スター
- 602
- フォーク
- 235
- 平均マージ
- 2日 13時間
- マージ済み PR(30日)
- 8
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
slackapi/java-slack-sdk のほかの issue
-
Upgrade Jetty対応中かも @skrcode が 38 日前に担当しました。 オープンauto-triage-skip dependencies good first issue
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
slackapi/java-slack-sdk#1567 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
-
auto-triage-skip discussion enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
slackapi/java-slack-sdk#1535 · コメント 5 件 ·
メンテナーはふだん 1 日以内に返信
-
auto-triage-skip question untriaged
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
slackapi/java-slack-sdk#1528 · コメント 7 件 ·
メンテナーはふだん 1 日以内に返信
-
Update okhttp to 5.xオープンauto-triage-skip dependencies project:slack-api-client project:slack-app-backend
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
slackapi/java-slack-sdk#1500 · コメント 11 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Table Block Supportオープンauto-triage-skip enhancement project:slack-api-model
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
slackapi/java-slack-sdk#1499 · コメント 4 件 · リアクション 3 件 ·
メンテナーはふだん 1 日以内に返信
slackapi/java-slack-sdk の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Netcracker/qubership-integration-platform#1046 ·
メンテナーはふだん 2 日以内に返信
-
`check_java_version()` fails when Java path contains spaces (Windows / Git Bash, `C:\Program Files`)オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
Fix Math.ceilDiv wrong result for exact positive divisions対応中かも @pamod-madubashana が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
scala-native/scala-native#5094 ·
メンテナーはふだん 1 日以内に返信
-
NullPointerException in blocking command completion callback when the command succeeds (3.52.0)オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 2 日以内に返信