feat: chat stream helper by srtaalej · Pull Request #1545 · slackapi/java-slack-sdk

srtaalej · 2025-12-22T17:29:13Z

This PR adds a helper to the chat streaming methods

ChatStreamHelper stream = (req -> req.
    .channel("C0123456789")
    .threadTs("1700000001.123456")
    .recipientTeamId("T0123456789")
    .recipientUserId("U0123456789")
    .bufferSize(100));
stream.append("**hello wo");
stream.append("rld!**");
ChatStopStreamResponse response = stream.stop();

Category (place an `x` in each of the `[ ]`)

bolt (Bolt for Java)
bolt-{sub modules} (Bolt for Java - optional modules)
slack-api-client (Slack API Clients)
slack-api-model (Slack API Data Models)
slack-api-*-kotlin-extension (Kotlin Extensions for Slack API Clients)
slack-app-backend (The primitive layer of Bolt for Java)

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you agree to those rules.

codecov · 2025-12-22T17:41:08Z

Codecov Report

❌ Patch coverage is 75.14451% with 43 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.39%. Comparing base (f48758d) to head (e9f3639).
⚠️ Report is 5 commits behind head on main.

Files with missing lines	Patch %	Lines
...a/com/slack/api/methods/AsyncChatStreamHelper.java	71.59%	21 Missing and 4 partials ⚠️
...n/java/com/slack/api/methods/ChatStreamHelper.java	79.22%	12 Missing and 4 partials ⚠️
...om/slack/api/methods/SlackChatStreamException.java	66.66%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1545      +/-   ##
============================================
+ Coverage     73.32%   73.39%   +0.07%     
- Complexity     4515     4547      +32     
============================================
  Files           477      480       +3     
  Lines         14274    14447     +173     
  Branches       1487     1498      +11     
============================================
+ Hits          10467    10604     +137     
- Misses         2917     2946      +29     
- Partials        890      897       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

zimeg

@srtaalej This is awesome to review and test! Thanks for putting it together 👾 ✨

I'm leaving a few comments around how we might surface this for the web client that might make it easier to use in calling code, similar to other SDKs, but please let me know if language limits these idea 🙏

zimeg · 2026-01-13T19:20:36Z

slack-api-client/src/main/java/com/slack/api/methods/ChatStreamHelper.java

+ * MethodsClient client = Slack.getInstance().methods(token);
+ * ChatStreamHelper stream = ChatStreamHelper.builder()
+ *     .client(client)
+ *     .channel("C0123456789")
+ *     .threadTs("1700000001.123456")
+ *     .recipientTeamId("T0123456789")
+ *     .recipientUserId("U0123456789")
+ *     .bufferSize(100)
+ *     .build();


👁️‍🗨️ thought: This works well but I'm wondering if it's possible to attach the chat stream helper to the client for an implementation similar to files upload?

String token = System.getenv("SLACK_BOT_TOKEN"); var client = Slack.getInstance().methods(token); client.filesUploadV2(req -> req.content("greetings!").channel("C01223456789"));

slack-api-client/src/main/java/com/slack/api/methods/ChatStreamHelper.java

zimeg · 2026-01-13T19:27:51Z

slack-api-client/src/main/java/com/slack/api/methods/ChatStreamHelper.java

+            // Create a response object to return (mimicking the append response structure)
+            response = new ChatAppendStreamResponse();
+            response.setOk(startResponse.isOk());
+            response.setChannel(startResponse.getChannel());
+            response.setTs(startResponse.getTs());
+            response.setWarning(startResponse.getWarning());
+            response.setError(startResponse.getError());


⭐ praise: Nice! I forget if casting between related types might also work here but I think the explicit setting is most clear.

…mHelper.java Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

Bumps [actions/checkout](https://github.com/actions/checkout) from 6.0.0 to 6.0.1. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@1af3b93...8e8c483) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 6.0.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [actions/setup-java](https://github.com/actions/setup-java) from 5.0.0 to 5.1.0. - [Release notes](https://github.com/actions/setup-java/releases) - [Commits](actions/setup-java@dded088...f2beeb2) --- updated-dependencies: - dependency-name: actions/setup-java dependency-version: 5.1.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 5.5.1 to 5.5.2. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](codecov/codecov-action@5a10915...671740a) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-version: 5.5.2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [actions/stale](https://github.com/actions/stale) from 10.1.0 to 10.1.1. - [Release notes](https://github.com/actions/stale/releases) - [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md) - [Commits](actions/stale@5f858e3...9971854) --- updated-dependencies: - dependency-name: actions/stale dependency-version: 10.1.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

zimeg

@srtaalej This is testing swell! The one comment I have that we might want to finalize before merging is the naming of this streamer 📸

The other SDKs have a variation of chat_stream or chatStream and IMHO we could omit "helper" from calling code, but please let me know if reason exists otherwise. No blocker to the functionalities so I'm in favor of whatever makes most sense!

slack-api-client/src/main/java/com/slack/api/methods/AsyncMethodsClient.java

slack-api-client/src/main/java/com/slack/api/methods/ChatStreamHelper.java

zimeg · 2026-01-22T23:04:24Z

slack-api-client/src/main/java/com/slack/api/methods/ChatStreamHelper.java

+    ) throws IOException, SlackApiException {
+        if (state == State.COMPLETED) {
+            throw new SlackChatStreamException("Cannot stop stream: stream state is " + state);
+        }


⚠️ question: Should the stop method throw SlackChatStreamException too? I'm not certain so wanted to ask!

slack-api-client/src/main/java/com/slack/api/methods/MethodsClient.java

zimeg · 2026-01-22T23:20:29Z

slack-api-client/src/main/java/com/slack/api/methods/ChatStreamHelper.java

+    /**
+     * The state of the chat stream.
+     */
+    public enum State {
+        STARTING,
+        IN_PROGRESS,
+        COMPLETED
+    }


🔭 question(non-blocking): Can we make this private? I don't think this is something that should be changed from outside of this class!

📚 thought(non-blocking): Changing State to StreamState might be kind in reading later, but also personal preference.

…mHelper.java Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

…odsClient.java Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

…ient.java Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

feat: chat stream helper

b32772b

srtaalej added this to the 1.47.0 milestone Dec 22, 2025

srtaalej self-assigned this Dec 22, 2025

srtaalej added the enhancement M-T: A feature request for new functionality label Dec 22, 2025

srtaalej marked this pull request as ready for review December 22, 2025 19:21

srtaalej requested a review from a team as a code owner December 22, 2025 19:21

zimeg reviewed Jan 13, 2026

View reviewed changes

srtaalej and others added 7 commits January 14, 2026 13:26

Update slack-api-client/src/main/java/com/slack/api/methods/ChatStrea…

a4f2b06

…mHelper.java Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

feat: wrap helper in request config

a919689

adjust buffer size

dc13df5

srtaalej requested a review from zimeg January 14, 2026 19:41

fix: set test channel/ team to null

beb1b92

srtaalej requested review from WilliamBergamin and mwbrooks January 20, 2026 18:28

srtaalej added the semver:minor label Jan 20, 2026

zimeg reviewed Jan 22, 2026

View reviewed changes

srtaalej and others added 5 commits January 23, 2026 12:34

Update slack-api-client/src/main/java/com/slack/api/methods/ChatStrea…

443d380

…mHelper.java Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

Update slack-api-client/src/main/java/com/slack/api/methods/AsyncMeth…

18da58c

…odsClient.java Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

Update slack-api-client/src/main/java/com/slack/api/methods/MethodsCl…

1d9a51d

…ient.java Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

fix: match name to py/node sdk helpers

873abee

bug: privatize StreamState

e9f3639

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: chat stream helper#1545

feat: chat stream helper#1545
srtaalej wants to merge 14 commits intomainfrom
ale-chat-stream-helper

srtaalej commented Dec 22, 2025 •

edited

Loading

Uh oh!

codecov bot commented Dec 22, 2025 •

edited

Loading

Uh oh!

zimeg left a comment

Uh oh!

zimeg Jan 13, 2026

Uh oh!

Uh oh!

zimeg Jan 13, 2026

Uh oh!

zimeg left a comment

Uh oh!

Uh oh!

Uh oh!

zimeg Jan 22, 2026

Uh oh!

Uh oh!

zimeg Jan 22, 2026

Uh oh!

zimeg Jan 22, 2026

Uh oh!

srtaalej Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

srtaalej commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Category (place an x in each of the [ ])

Requirements

Uh oh!

codecov bot commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

zimeg Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zimeg Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

zimeg Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zimeg Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

srtaalej Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

srtaalej commented Dec 22, 2025 •

edited

Loading

Category (place an `x` in each of the `[ ]`)

codecov bot commented Dec 22, 2025 •

edited

Loading