Update the app

Author: seratch

.vscode/settings.json

@@ -1,3 +1,12 @@
 {
-    "deno.enable": true
-}
+  "deno.enable": true,
+  "deno.lint": true,
+  "deno.suggest.imports.hosts": {
+    "https://deno.land": false
+  },
+  "[typescript]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "denoland.vscode-deno"
+  },
+  "editor.tabSize": 2
+}

README.md

@@ -1,12 +1,17 @@
 # run-on-slack-deepl
 
-This sample app is a translator app that runs [DeepL's awesome APIs](https://www.deepl.com/en/docs-api) for translating Slack message text into a different language.
+This sample app is a translator app that runs
+[DeepL's awesome APIs](https://www.deepl.com/en/docs-api) for translating Slack
+message text into a different language.
 
 ## Steps to enable this app
 
 ### 0. Enable the next-gen platform in your workspace
 
-To use this sample, you first need to install and configure the Slack CLI. Step-by-step instructions can be found in [Quickstart Guide](https://api.slack.com/future/quickstart). Also, the beta platform needs to be enabled for your paid Slack workspace.
+To use this sample, you first need to install and configure the Slack CLI.
+Step-by-step instructions can be found in
+[Quickstart Guide](https://api.slack.com/future/quickstart). Also, the beta
+platform needs to be enabled for your paid Slack workspace.
 
 And then, you can use this GitHub repository as the template for your app.
 
@@ -17,7 +22,9 @@ cd my-deepl-slack-app/
 
 ### 1. Enable reaction_added trigger
 
-First off, open `triggers/reaction_added.ts` source file and modify it to have a valid list of channel IDs to enable this app. And then, run the following CLI command:
+First off, open `triggers/reaction_added.ts` source file and modify it to have a
+valid list of channel IDs to enable this app. And then, run the following CLI
+command:
 
 ```bash
 slack deploy
@@ -38,10 +45,11 @@ Add the deployed app to the channels you've listed in the step 1.
 
 ### 4. Add a reaction to a message in the channel
 
-Add `:jp:` reaction to any message in the channel. If everything is fine, you will see the same content that is translated into Japanese in its thread.
+Add `:jp:` reaction to any message in the channel. If everything is fine, you
+will see the same content that is translated into Japanese in its thread.
 
 <img width="300" src="https://user-images.githubusercontent.com/19658/192277306-b3a2f431-1b8b-44e0-9b6a-224ca09a4b6e.png">
 
 ## LICENSE
 
-The MIT License
+The MIT License

functions/lang_selector.ts

@@ -1,12 +1,14 @@
 import { DefineFunction, Schema } from "deno-slack-sdk/mod.ts";
 import { SlackFunctionHandler } from "deno-slack-sdk/types.ts";
 import { reactionToLang } from "./languages.ts";
+import { getLogger } from "../utils/logger.ts";
+import { resolveFunctionSourceFile } from "../utils/source_file_resoluion.ts";
 
 export const def = DefineFunction({
   callback_id: "lang_selector",
   title: "Language selector",
   description: "A funtion to identify the language to translate into",
-  source_file: "functions/lang_selector.ts",
+  source_file: resolveFunctionSourceFile(import.meta.url),
   input_parameters: {
     properties: {
       reaction: {
@@ -27,8 +29,10 @@ export const def = DefineFunction({
 
 const handler: SlackFunctionHandler<typeof def.definition> = async ({
   inputs,
+  env,
 }) => {
-  console.log(`lang_selector function called: ${JSON.stringify(inputs)}`);
+  const logger = await getLogger(env.logLevel);
+  logger.debug(`lang_selector inputs: ${JSON.stringify(inputs)}`);
   const reactionName = inputs.reaction;
   let lang = undefined;
   if (reactionName.match(/flag-/)) {

functions/translator.ts

@@ -2,12 +2,15 @@ import { DefineFunction, Schema } from "deno-slack-sdk/mod.ts";
 import { SlackFunctionHandler } from "deno-slack-sdk/types.ts";
 import { SlackAPI } from "deno-slack-api/mod.ts";
 import { SlackAPIClient } from "deno-slack-api/types.ts";
+import { getLogger } from "../utils/logger.ts";
+import { resolveFunctionSourceFile } from "../utils/source_file_resoluion.ts";
+import * as log from "https://deno.land/std@0.157.0/log/mod.ts";
 
 export const def = DefineFunction({
   callback_id: "translator",
   title: "Translator",
   description: "A funtion to translate a Slack message",
-  source_file: "functions/translator.ts",
+  source_file: resolveFunctionSourceFile(import.meta.url),
   input_parameters: {
     properties: {
       channelId: {
@@ -37,11 +40,12 @@ const handler: SlackFunctionHandler<typeof def.definition> = async ({
   token,
   env,
 }) => {
-  console.log(`translator function called: ${JSON.stringify(inputs)}`);
+  const logger = await getLogger(env.logLevel);
+  logger.debug(`translator inputs: ${JSON.stringify(inputs)}`);
   const emptyOutputs = { outputs: {} };
   if (inputs.lang === undefined) {
     // no language specified by the reaction
-    console.log(`Skipped as no lang detected`);
+    logger.info(`Skipped as no lang detected`);
     return emptyOutputs;
   }
   const client: SlackAPIClient = SlackAPI(token);
@@ -53,13 +57,13 @@ const handler: SlackFunctionHandler<typeof def.definition> = async ({
   });
   if (translationTarget.error) {
     // If you see this log message, you need to invite this app to the channel
-    console.log(
-      `Failed to fetch the message due to ${translationTarget.error}`
+    logger.info(
+      `Failed to fetch the message due to ${translationTarget.error}`,
     );
     return emptyOutputs;
   }
   if (translationTarget.messages.length == 0) {
-    console.log(`No message found`);
+    logger.info("No message found");
     return emptyOutputs;
   }
   const authKey = env.DEEPL_AUTH_KEY;
@@ -78,26 +82,26 @@ const handler: SlackFunctionHandler<typeof def.definition> = async ({
   });
   const translationResult = await deeplResponse.json();
   if (!translationResult || translationResult.translations.length === 0) {
-    console.log(`Translation failed for some reason: ${translationResult}`);
+    logger.info(`Translation failed for some reason: ${translationResult}`);
     return emptyOutputs;
   }
   const translatedText = translationResult.translations[0].text;
   const replies = await client.conversations.replies({
     channel: inputs.channelId,
     ts: inputs.messageTs,
   });
-  if (isAlreadyPosted(replies.messages, translatedText)) {
+  if (isAlreadyPosted(logger, replies.messages, translatedText)) {
     // Skip posting the same one
-    console.log(
-      `Skipped this translation as it's already posted: ${translatedText}`
+    logger.info(
+      `Skipped this translation as it's already posted: ${translatedText}`,
     );
     return emptyOutputs;
   }
   const result = await sayInThread(
     client,
     inputs.channelId,
     inputs.messageTs,
-    translatedText
+    translatedText,
   );
   return await { outputs: { ts: result.ts } };
 };
@@ -106,11 +110,12 @@ export default handler;
 // internal functions
 
 function isAlreadyPosted(
+  logger: log.Logger,
   // deno-lint-ignore no-explicit-any
   replies: Record<string, any>[],
-  translatedText: string
+  translatedText: string,
 ): boolean {
-  console.log(replies);
+  logger.debug(replies);
   if (!replies) {
     return false;
   }
@@ -126,7 +131,7 @@ async function sayInThread(
   client: SlackAPIClient,
   channelId: string,
   threadTs: string,
-  text: string
+  text: string,
 ) {
   return await client.chat.postMessage({
     channel: channelId,

triggers/reaction_added.ts

@@ -9,7 +9,7 @@ const trigger: Trigger<typeof workflowDef.definition> = {
   event: {
     event_type: "slack#/events/reaction_added",
     // TODO: Listing all the channels to enable here is required
-    channel_ids: ["C013T0FTKU3"],
+    channel_ids: ["CLT1F93TP"],
   },
   inputs: {
     channelId: {

utils/logger.ts

@@ -0,0 +1,21 @@
+import * as log from "https://deno.land/std@0.157.0/log/mod.ts";
+
+export async function getLogger(
+  level?: string,
+): Promise<log.Logger> {
+  const logLevel: log.LevelName = level === undefined
+    ? "DEBUG"
+    : level as log.LevelName;
+  await log.setup({
+    handlers: {
+      console: new log.handlers.ConsoleHandler(logLevel),
+    },
+    loggers: {
+      default: {
+        level: logLevel,
+        handlers: ["console"],
+      },
+    },
+  });
+  return log.getLogger();
+}

utils/source_file_resoluion.ts

@@ -0,0 +1,5 @@
+export function resolveFunctionSourceFile(importMetaUrl: string): string {
+  return new URL("", importMetaUrl).pathname.split("/").slice(-2).join(
+    "/",
+  );
+}