Merge pull request #2947 from objectcomputing/feature-2946/support-custom-slack-emoji

Closes #2946 - Support custom slack emoji

Author: mkimberlin

server/src/main/java/com/objectcomputing/checkins/services/slack/SlackController.java

@@ -0,0 +1,47 @@
+package com.objectcomputing.checkins.services.slack;
+
+import io.micronaut.cache.CacheConfiguration;
+import io.micronaut.http.HttpResponse;
+import io.micronaut.http.annotation.Controller;
+import io.micronaut.http.annotation.Get;
+import io.micronaut.scheduling.TaskExecutors;
+import io.micronaut.scheduling.annotation.ExecuteOn;
+import io.micronaut.security.annotation.Secured;
+import io.micronaut.security.rules.SecurityRule;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.inject.Named;
+
+import java.net.URI;
+import java.time.Duration;
+import java.util.Map;
+import java.util.UUID;
+
+import static io.micronaut.http.HttpHeaders.CACHE_CONTROL;
+
+@Controller("/services/slack")
+@ExecuteOn(TaskExecutors.BLOCKING)
+@Secured(SecurityRule.IS_AUTHENTICATED)
+@Tag(name = "slack")
+public class SlackController {
+
+    private final SlackSearch slackSearch;
+    private final long expiry;
+
+    public SlackController(@Named("slack-cache") CacheConfiguration cacheConfiguration, SlackSearch slackSearch) {
+        // If un-configured, default to 1 hour
+        this.expiry = cacheConfiguration.getExpireAfterWrite()
+                .map(Duration::toSeconds)
+                .orElseGet(() -> Duration.ofHours(1).toSeconds());
+        this.slackSearch = slackSearch;
+    }
+
+    @Get("/emoji")
+    public HttpResponse<Map<String, String>> customEmoji() {
+        Map<String, String> customEmoji = slackSearch.getCustomEmoji();
+
+        return HttpResponse
+                .ok().header(CACHE_CONTROL, "public, max-age=%d".formatted(expiry))
+                .headers(headers -> headers.location(URI.create("/services/slack/emoji")))
+                .body(customEmoji);
+    }
+}

server/src/main/java/com/objectcomputing/checkins/services/slack/SlackSearch.java

@@ -2,7 +2,9 @@
 
 import com.objectcomputing.checkins.configuration.CheckInsConfiguration;
 import com.slack.api.methods.request.conversations.ConversationsInfoRequest;
+import com.slack.api.methods.request.emoji.EmojiListRequest;
 import com.slack.api.methods.response.conversations.ConversationsInfoResponse;
+import com.slack.api.methods.response.emoji.EmojiListResponse;
 import com.slack.api.model.block.LayoutBlock;
 import com.slack.api.Slack;
 import com.slack.api.methods.MethodsClient;
@@ -15,16 +17,20 @@
 import com.slack.api.methods.request.users.UsersInfoRequest;
 import com.slack.api.methods.response.users.UsersInfoResponse;
 
+import io.micronaut.cache.annotation.CacheConfig;
+import io.micronaut.cache.annotation.Cacheable;
 import jakarta.inject.Singleton;
 import jakarta.inject.Inject;
 
 import java.util.List;
 import java.io.IOException;
+import java.util.Map;
 
 import jnr.ffi.annotations.In;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+@CacheConfig("slack-cache")
 @Singleton
 public class SlackSearch {
     private static final Logger LOG = LoggerFactory.getLogger(SlackSearch.class);
@@ -122,5 +128,26 @@ public String findUserEmail(String userId) {
         }
         return null;
     }
+
+
+    @Cacheable
+    public Map<String, String> getCustomEmoji() {
+        String token = configuration.getApplication().getSlack().getBotToken();
+        if (token != null) {
+            try {
+                MethodsClient client = Slack.getInstance().methods(token);
+                EmojiListResponse response = client.emojiList(EmojiListRequest.builder().build());
+
+                if (response.isOk()) {
+                    return response.getEmoji();
+                }
+            } catch(IOException e) {
+                LOG.error("SlackSearch.getCustomEmoji: " + e.toString());
+            } catch(SlackApiException e) {
+                LOG.error("SlackSearch.getCustomEmoji: " + e.toString());
+            }
+        }
+        return null;
+    }
 }
 

server/src/main/resources/application.yml

@@ -15,7 +15,8 @@ micronaut:
       maximum-size: 600
     role-permission-cache:
       expire-after-write: 1d # 1 day
-
+    slack-cache:
+      expire-after-write: 1800s # 30 minutes
   router:
     static-resources:
       swagger:

web-ui/src/api/emoji.js

@@ -0,0 +1,11 @@
+import { resolve } from './api.js';
+
+const emojiUrl = '/services/slack/emoji';
+
+export const getCustomEmoji = async (cookie) => {
+  return resolve({
+    url: emojiUrl,
+    responseType: 'json',
+    headers: { 'X-CSRF-Header': cookie, Accept: 'application/json' }
+  });
+};