Skip to content

Fix #1147 Improve the logic to extract the requestUserId for context objects #1375

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 19, 2024
Merged

Fix #1147 Improve the logic to extract the requestUserId for context objects #1375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion bolt/src/main/java/com/slack/api/bolt/request/builtin/EventRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@
}
this.getContext().setEnterpriseId(enterpriseId);
this.getContext().setTeamId(teamId);
this.getContext().setRequestUserId(extractRequestUserId(payload));

// set retry related header values to the context
if (this.headers != null && this.headers.getNames().size() > 0) {
for (String name : this.headers.getNames()) {
Expand Down Expand Up @@ -119,7 +121,35 @@
}
}

private EventContext context = new EventContext();
private static String extractRequestUserId(JsonObject payload) {
if (payload.get("user") != null) {
if (payload.get("user").isJsonPrimitive()) {
return payload.get("user").getAsString();
} else if (payload.get("user").isJsonObject()) {
JsonElement userId = payload.get("user").getAsJsonObject().get("id");
if (userId != null) {
return userId.getAsString();
}
}
}
if (payload.get("user_id") != null) {
return payload.get("user_id").getAsString();

Check warning on line 136 in bolt/src/main/java/com/slack/api/bolt/request/builtin/EventRequest.java

View check run for this annotation

Codecov / codecov/patch

bolt/src/main/java/com/slack/api/bolt/request/builtin/EventRequest.java#L136 

Added line #L136 was not covered by tests
}
if (payload.get("event") != null) {
return extractRequestUserId(payload.get("event").getAsJsonObject());
}
if (payload.get("message") != null) {
// message_changed: body["event"]["message"]
return extractRequestUserId(payload.get("message").getAsJsonObject());

Check warning on line 143 in bolt/src/main/java/com/slack/api/bolt/request/builtin/EventRequest.java

View check run for this annotation

Codecov / codecov/patch

bolt/src/main/java/com/slack/api/bolt/request/builtin/EventRequest.java#L143 

Added line #L143 was not covered by tests
}
if (payload.get("previous_message") != null) {
// message_deleted: body["event"]["previous_message"]
return extractRequestUserId(payload.get("previous_message").getAsJsonObject());

Check warning on line 147 in bolt/src/main/java/com/slack/api/bolt/request/builtin/EventRequest.java

View check run for this annotation

Codecov / codecov/patch

bolt/src/main/java/com/slack/api/bolt/request/builtin/EventRequest.java#L147 

Added line #L147 was not covered by tests
}
return null;
}

private final EventContext context = new EventContext();

@Override
public EventContext getContext() {
Expand Down
249 changes: 249 additions & 0 deletions bolt/src/test/java/test_locally/request/EventRequestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
package test_locally.request;

import com.slack.api.bolt.request.RequestHeaders;
import com.slack.api.bolt.request.builtin.EventRequest;
import org.junit.Test;

import java.util.HashMap;

import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.MatcherAssert.assertThat;

public class EventRequestTest {

String appMentionPayload = "{\n" +
" \"token\": \"legacy-fixed-value\",\n" +
" \"team_id\": \"T123\",\n" +
" \"api_app_id\": \"A123\",\n" +
" \"event\": {\n" +
" \"client_msg_id\": \"3fd13273-5a6a-4b5c-bd6f-109fd697038c\",\n" +
" \"type\": \"app_mention\",\n" +
" \"text\": \"<@U123> test\",\n" +
" \"user\": \"UUUUUXXXXX\",\n" +
" \"ts\": \"1583636399.000700\",\n" +
" \"team\": \"T123\",\n" +
" \"blocks\": [\n" +
" {\n" +
" \"type\": \"rich_text\",\n" +
" \"block_id\": \"FMAzp\",\n" +
" \"elements\": [\n" +
" {\n" +
" \"type\": \"rich_text_section\",\n" +
" \"elements\": [\n" +
" {\n" +
" \"type\": \"user\",\n" +
" \"user_id\": \"U123\"\n" +
" },\n" +
" {\n" +
" \"type\": \"text\",\n" +
" \"text\": \" test\"\n" +
" }\n" +
" ]\n" +
" }\n" +
" ]\n" +
" }\n" +
" ],\n" +
" \"channel\": \"C123\",\n" +
" \"event_ts\": \"1583636399.000700\"\n" +
" },\n" +
" \"type\": \"event_callback\",\n" +
" \"event_id\": \"EvV1KV8BM3\",\n" +
" \"event_time\": 1583636399,\n" +
" \"authed_users\": [\n" +
" \"U123\"\n" +
" ]\n" +
"}";
String appMentionPayloadWithSubtype = "{\n" +
" \"token\": \"legacy-fixed-value\",\n" +
" \"team_id\": \"T123\",\n" +
" \"api_app_id\": \"A123\",\n" +
" \"event\": {\n" +
" \"client_msg_id\": \"3fd13273-5a6a-4b5c-bd6f-109fd697038c\",\n" +
" \"type\": \"app_mention\",\n" +
" \"subtype\": \"bot_message\",\n" +
" \"text\": \"<@U123> test\",\n" +
" \"bot_id\": \"B123\",\n" +
" \"ts\": \"1583636399.000700\",\n" +
" \"team\": \"T123\",\n" +
" \"blocks\": [\n" +
" {\n" +
" \"type\": \"rich_text\",\n" +
" \"block_id\": \"FMAzp\",\n" +
" \"elements\": [\n" +
" {\n" +
" \"type\": \"rich_text_section\",\n" +
" \"elements\": [\n" +
" {\n" +
" \"type\": \"user\",\n" +
" \"user_id\": \"U123\"\n" +
" },\n" +
" {\n" +
" \"type\": \"text\",\n" +
" \"text\": \" test\"\n" +
" }\n" +
" ]\n" +
" }\n" +
" ]\n" +
" }\n" +
" ],\n" +
" \"channel\": \"C123\",\n" +
" \"event_ts\": \"1583636399.000700\"\n" +
" },\n" +
" \"type\": \"event_callback\",\n" +
" \"event_id\": \"EvV1KV8BM3\",\n" +
" \"event_time\": 1583636399,\n" +
" \"authed_users\": [\n" +
" \"U123\"\n" +
" ]\n" +
"}";
String messagePayload = "{\n" +
" \"token\": \"legacy-fixed-value\",\n" +
" \"team_id\": \"T123\",\n" +
" \"api_app_id\": \"A123\",\n" +
" \"event\": {\n" +
" \"client_msg_id\": \"3fd13273-5a6a-4b5c-bd6f-109fd697038c\",\n" +
" \"type\": \"message\",\n" +
" \"text\": \"<@U123> test\",\n" +
" \"user\": \"UUUUUXXXXX\",\n" +
" \"ts\": \"1583636399.000700\",\n" +
" \"team\": \"T123\",\n" +
" \"blocks\": [\n" +
" {\n" +
" \"type\": \"rich_text\",\n" +
" \"block_id\": \"FMAzp\",\n" +
" \"elements\": [\n" +
" {\n" +
" \"type\": \"rich_text_section\",\n" +
" \"elements\": [\n" +
" {\n" +
" \"type\": \"user\",\n" +
" \"user_id\": \"U123\"\n" +
" },\n" +
" {\n" +
" \"type\": \"text\",\n" +
" \"text\": \" test\"\n" +
" }\n" +
" ]\n" +
" }\n" +
" ]\n" +
" }\n" +
" ],\n" +
" \"channel\": \"C123\",\n" +
" \"event_ts\": \"1583636399.000700\",\n" +
" \"channel_type\": \"channel\"\n" +
" },\n" +
" \"type\": \"event_callback\",\n" +
" \"event_id\": \"EvV1KA7U3A\",\n" +
" \"event_time\": 1583636399,\n" +
" \"authed_users\": [\n" +
" \"U123\"\n" +
" ]\n" +
"}";

String appMentionPayloadInSlackConnect = "{\n" +
" \"token\": \"fixed-value\",\n" +
" \"team_id\": \"T_INSTALLED\",\n" +
" \"enterprise_id\": \"E_INSTALLED\",\n" +
" \"api_app_id\": \"A111\",\n" +
" \"event\": {\n" +
" \"client_msg_id\": \"ae6d418a-ff0e-433f-ba10-915cebb1bb94\",\n" +
" \"type\": \"app_mention\",\n" +
" \"text\": \"<@U123> hey\",\n" +
" \"user\": \"UUUUUXXXXX\",\n" +
" \"ts\": \"1605835902.008000\",\n" +
" \"team\": \"T_INSTALLED\",\n" +
" \"channel\": \"C111\",\n" +
" \"event_ts\": \"1605835902.008000\"\n" +
" },\n" +
" \"type\": \"event_callback\",\n" +
" \"event_id\": \"Ev01FC50TXB6\",\n" +
" \"event_time\": 1605835902,\n" +
" \"authorizations\": [\n" +
" {\n" +
" \"enterprise_id\": \"E_INSTALLED\",\n" +
" \"team_id\": \"T_INSTALLED\",\n" +
" \"user_id\": \"U234\",\n" +
" \"is_bot\": true,\n" +
" \"is_enterprise_install\": false\n" +
" }\n" +
" ],\n" +
" \"is_ext_shared_channel\": true,\n" +
" \"event_context\": \"1-app_mention-T_INSTALLED-C111\"\n" +
"}";

String messagePayloadInSlackConnect = "{\n" +
" \"token\": \"fixed-value\",\n" +
" \"team_id\": \"T_SOURCE\",\n" +
" \"api_app_id\": \"A111\",\n" +
" \"event\": {\n" +
" \"bot_id\": \"B123\",\n" +
" \"type\": \"message\",\n" +
" \"text\": \"Hi there!\",\n" +
" \"user\": \"UUUUUXXXXX\",\n" +
" \"ts\": \"1605835904.008100\",\n" +
" \"team\": \"T_INSTALLED\",\n" +
" \"bot_profile\": {\n" +
" \"id\": \"B123\",\n" +
" \"deleted\": false,\n" +
" \"name\": \"events-api-oauth-app\",\n" +
" \"updated\": 1605835851,\n" +
" \"app_id\": \"A111\",\n" +
" \"icons\": {\n" +
" \"image_36\": \"https://a.slack-edge.com/80588/img/plugins/app/bot_36.png\",\n" +
" \"image_48\": \"https://a.slack-edge.com/80588/img/plugins/app/bot_48.png\",\n" +
" \"image_72\": \"https://a.slack-edge.com/80588/img/plugins/app/service_72.png\"\n" +
" },\n" +
" \"team_id\": \"T_INSTALLED\"\n" +
" },\n" +
" \"channel\": \"C111\",\n" +
" \"event_ts\": \"1605835904.008100\",\n" +
" \"channel_type\": \"channel\"\n" +
" },\n" +
" \"type\": \"event_callback\",\n" +
" \"event_id\": \"Ev01F66ATNKV\",\n" +
" \"event_time\": 1605835904,\n" +
" \"authorizations\": [\n" +
" {\n" +
" \"enterprise_id\": \"E_INSTALLED\",\n" +
" \"team_id\": \"T_INSTALLED\",\n" +
" \"user_id\": \"U234\",\n" +
" \"is_bot\": true,\n" +
" \"is_enterprise_install\": false\n" +
" }\n" +
" ],\n" +
" \"is_ext_shared_channel\": true,\n" +
" \"event_context\": \"1-message-T_SOURCE-C111\"\n" +
"}";

String userTokenRevokedEvent = "{\n" +
" \"token\": \"fixed-value\",\n" +
" \"team_id\": \"T111\",\n" +
" \"enterprise_id\": \"E111\",\n" +
" \"api_app_id\": \"A111\",\n" +
" \"event\": {\n" +
" \"type\": \"tokens_revoked\",\n" +
" \"tokens\": {\n" +
" \"oauth\": [\n" +
" \"W111\"\n" +
" ],\n" +
" \"bot\": []\n" +
" },\n" +
" \"event_ts\": \"1614847360.131900\"\n" +
" },\n" +
" \"type\": \"event_callback\",\n" +
" \"event_id\": \"Ev111\",\n" +
" \"event_time\": 1614847360\n" +
"}";

@Test
public void test() {
RequestHeaders headers = new RequestHeaders(new HashMap<>());
assertThat(new EventRequest(appMentionPayload, headers).getContext().getRequestUserId(), is("UUUUUXXXXX"));
assertThat(new EventRequest(appMentionPayloadWithSubtype, headers).getContext().getRequestUserId(), is(nullValue()));
assertThat(new EventRequest(messagePayload, headers).getContext().getRequestUserId(), is("UUUUUXXXXX"));
assertThat(new EventRequest(appMentionPayloadInSlackConnect, headers).getContext().getRequestUserId(), is("UUUUUXXXXX"));
assertThat(new EventRequest(messagePayloadInSlackConnect, headers).getContext().getRequestUserId(), is("UUUUUXXXXX"));
assertThat(new EventRequest(userTokenRevokedEvent, headers).getContext().getRequestUserId(), is(nullValue()));
}
}