chore: update to latests Deno and CLI standards (#48)

* chore: update sample to Deno 2 standards

* Fix typos

* Use Deno 2 to run CI

* Update .slack/.gitignore

Co-authored-by: Eden Zimbelman <zim@o526.net>

* Update .github/dependabot.yml

Co-authored-by: Eden Zimbelman <zim@o526.net>

* improve based on feedback

* Update README.md

* pin dependency version

* improve based on feedback

* Update dependabot.yml

* move test_utils to the top level

* move testing utilities to a better location

* Update deno.jsonc

* Update deno.jsonc

* simplify stub fetch

* Update translate_test.ts

---------

Co-authored-by: Eden Zimbelman <zim@o526.net>

Author: WilliamBergamin

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/deno.yml

@@ -2,9 +2,11 @@ name: Deno app build and testing
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
   pull_request:
-    branches: [ main ]
+    branches:
+      - main
 
 jobs:
   deno:
@@ -18,7 +20,7 @@ jobs:
       - name: Setup Deno
         uses: denoland/setup-deno@v1
         with:
-          deno-version: v1.x
+          deno-version: v2.x
 
       - name: Verify formatting
         run: deno fmt --check

.gitignore

@@ -1,5 +1,4 @@
 dist
 package
 .DS_Store
-.slack/apps.dev.json
 .env

.slack/.gitignore

@@ -0,0 +1,2 @@
+apps.dev.json
+cache/

slack.json .slack/hooks.jsonslack.json renamed to .slack/hooks.json

@@ -198,11 +198,9 @@ $ slack activity --tail
 Contains `apps.dev.json` and `apps.json`, which include installation details for
 development and deployed apps.
 
-### `datastores/`
-
-[Datastores](https://api.slack.com/automation/datastores) securely store data
-for your application on Slack infrastructure. Required scopes to use datastores
-include `datastore:write` and `datastore:read`.
+Contains `hooks.json` used by the CLI to interact with the project's SDK
+dependencies. It contains script hooks that are executed by the CLI and
+implemented by the SDK.
 
 ### `functions/`
 
@@ -230,11 +228,6 @@ continuing to the next step.
 The [app manifest](https://api.slack.com/automation/manifest) contains the app's
 configuration. This file defines attributes like app name and description.
 
-### `slack.json`
-
-Used by the CLI to interact with the project's SDK dependencies. It contains
-script hooks that are executed by the CLI and implemented by the SDK.
-
 ## Resources
 
 To learn more about developing automations on Slack, visit the following:

README.md

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://deno.land/x/deno/cli/schemas/config-file.v1.json",
+  "$schema": "https://raw.githubusercontent.com/denoland/deno/main/cli/schemas/config-file.v1.json",
   "fmt": {
     "include": [
       "README.md",
@@ -13,7 +13,6 @@
       "workflows"
     ]
   },
-  "importMap": "import_map.json",
   "lint": {
     "include": [
       "datastores",
@@ -28,6 +27,12 @@
   },
   "lock": false,
   "tasks": {
-    "test": "deno fmt --check && deno lint && deno test --allow-read --allow-none"
+    "test": "deno fmt --check && deno lint && deno test --allow-read"
+  },
+  "imports": {
+    "deno-slack-sdk/": "https://deno.land/x/deno_slack_sdk@2.15.0/",
+    "deno-slack-api/": "https://deno.land/x/deno_slack_api@2.8.0/",
+    "@std/testing": "jsr:@std/testing@^1.0.12",
+    "@std/assert": "jsr:@std/assert@^1.0.13"
   }
 }

deno.jsonc

@@ -1,5 +1,5 @@
 import { SlackFunctionTester } from "deno-slack-sdk/mod.ts";
-import { assertEquals } from "std/testing/asserts.ts";
+import { assertEquals } from "@std/assert";
 import handler from "./detect_lang.ts";
 
 const { createContext } = SlackFunctionTester("my-function");

functions/detect_lang_test.ts

@@ -1,5 +1,5 @@
 import { DefineFunction, Schema, SlackFunction } from "deno-slack-sdk/mod.ts";
-import { SlackAPIClient } from "deno-slack-sdk/types.ts";
+import type { SlackAPIClient } from "deno-slack-sdk/types.ts";
 import { isDebugMode } from "./internals/debug_mode.ts";
 
 export const def = DefineFunction({
@@ -52,7 +52,7 @@ export default SlackFunction(def, async ({ inputs, client, env }) => {
     return { error };
   }
 
-  if (translationTargetResponse.messages.length == 0) {
+  if (translationTargetResponse.messages.length === 0) {
     console.log("No message found");
     return emptyOutputs; // this is not an error
   }
@@ -81,7 +81,7 @@ export default SlackFunction(def, async ({ inputs, client, env }) => {
       if (match.match(/^[#@].*$/)) {
         const matched = match.match(/^([#@].*)$/);
         if (matched != null) {
-          return "<mrkdwn>" + matched[1] + "</mrkdwn>";
+          return `<mrkdwn>${matched[1]}</mrkdwn>`;
         }
         return "";
       }
@@ -93,32 +93,32 @@ export default SlackFunction(def, async ({ inputs, client, env }) => {
       if (match.match(/^!date.*$/)) {
         const matched = match.match(/^(!date.*)$/);
         if (matched != null) {
-          return "<mrkdwn>" + matched[1] + "</mrkdwn>";
+          return `<mrkdwn>${matched[1]}</mrkdwn>`;
         }
         return "";
       }
       // match special mention
       if (match.match(/^!.*$/)) {
         const matched = match.match(/^!(.*?)(?:\|.*)?$/);
         if (matched != null) {
-          return "<ignore>@" + matched[1] + "</ignore>";
+          return `<ignore>@${matched[1]}</ignore>`;
         }
         return "<ignore>@[special mention]</ignore>";
       }
       // match formatted link
       if (match.match(/^.*?\|.*$/)) {
         const matched = match.match(/^(.*?)\|(.*)$/);
         if (matched != null) {
-          return '<a href="' + matched[1] + '">' + matched[2] + "</a>";
+          return `<a href="${matched[1]}">${matched[2]}</a>`;
         }
         return "";
       }
       // fallback (raw link or unforeseen formatting)
-      return "<mrkdwn>" + match + "</mrkdwn>";
+      return `<mrkdwn>${match}</mrkdwn>`;
       // match emoji
     })
     .replace(/:([a-z0-9_-]+):/g, (_: unknown, match: string) => {
-      return "<emoji>" + match + "</emoji>";
+      return `<emoji>${match}</emoji>`;
     });
   body.append("text", targetText);
   body.append("tag_handling", "xml");
@@ -133,8 +133,8 @@ export default SlackFunction(def, async ({ inputs, client, env }) => {
     },
     body,
   });
-  if (deeplResponse.status != 200) {
-    if (deeplResponse.status == 403) {
+  if (deeplResponse.status !== 200) {
+    if (deeplResponse.status === 403) {
       // If the status code is 403, the given auth key is not valid
       const error =
         `Translating a message failed! Please make sure if the DEEPL_AUTH_KEY is correct. - (status: ${deeplResponse.status}, target text: ${
@@ -170,19 +170,19 @@ export default SlackFunction(def, async ({ inputs, client, env }) => {
   const translatedText = translationResult.translations[0].text
     // Parse encoding tags to restore the original special syntax
     .replace(/<emoji>([a-z0-9_-]+)<\/emoji>/g, (_: unknown, match: string) => {
-      return ":" + match + ":";
+      return `:${match}:`;
       // match <mrkdwn>...</mrkdwn>
     })
     .replace(/<mrkdwn>(.*?)<\/mrkdwn>/g, (_: unknown, match: string) => {
-      return "<" + match + ">";
+      return `<${match}>`;
       // match <a href="...">...</a>
     })
     .replace(
       /(<a href="(?:.*?)">(?:.*?)<\/a>)/g,
       (_: unknown, match: string) => {
         const matched = match.match(/<a href="(.*?)">(.*?)<\/a>/);
         if (matched != null) {
-          return "<" + matched[1] + "|" + matched[2] + ">";
+          return `<${matched[1]}|${matched[2]}>`;
         }
         return "";
         // match <ignore>...</ignore>

functions/translate.ts

@@ -1,81 +1,100 @@
-import * as mf from "mock-fetch/mod.ts";
 import { SlackFunctionTester } from "deno-slack-sdk/mod.ts";
-import { assertEquals } from "std/testing/asserts.ts";
+import { assertEquals } from "@std/assert";
+import { stub } from "@std/testing/mock";
 import handler from "./translate.ts";
 
-// Replaces globalThis.fetch with the mocked copy
-mf.install();
+function stubFetch() {
+  // Replaces globalThis.fetch with the mocked copy
+  return stub(
+    globalThis,
+    "fetch",
+    async (url: string | URL | Request, options?: RequestInit) => {
+      const req = url instanceof Request ? url : new Request(url, options);
 
-mf.mock("POST@/api/conversations.replies", (args) => {
-  const authHeader = args.headers.get("Authorization");
-  if (authHeader === "Bearer empty-response") {
-    return new Response(JSON.stringify({ ok: true, messages: [] }), {
-      status: 200,
-    });
-  }
-  return new Response(
-    JSON.stringify({
-      "ok": true,
-      "oldest": "1670566778.964519",
-      "messages": [
-        {
-          "type": "message",
-          "text":
-            "Make work life simpler, more pleasant and more productive.\n\nSlack is the collaboration hub that brings the right people, information, and tools together to get work done. From Fortune 100 companies to corner markets, millions of people around the world use Slack to connect their teams, unify their systems, and drive their business forward.",
-          "user": "U03E94MK0",
-          "ts": "1670566778.964519",
-          "team": "T03E94MJU",
-          "thread_ts": "1670566778.964519",
-          "reply_count": 3,
-          "reply_users_count": 1,
-          "latest_reply": "1670570301.090889",
-          "reply_users": ["U04EJMQQEFN"],
-          "is_locked": false,
-          "subscribed": false,
-          "reactions": [{ "name": "jp", "users": ["U03E94MK0"], "count": 1 }],
-        },
-      ],
-      "has_more": false,
-      "pin_count": 0,
-      "channel_actions_ts": null,
-      "channel_actions_count": 0,
-    }),
-    {
-      status: 200,
-    },
-  );
-});
+      assertEquals(req.method, "POST");
 
-mf.mock("POST@/api/chat.postMessage", () => {
-  return new Response(JSON.stringify({ ok: true, ts: "1111.2222" }), {
-    status: 200,
-  });
-});
-
-mf.mock("POST@/v2/translate", async (args) => {
-  const body = await args.formData();
-  if (body.get("auth_key") !== "valid") {
-    return new Response("", { status: 403 });
-  }
-  return new Response(
-    JSON.stringify({
-      translations: [
-        {
-          detected_source_language: "EN",
-          text:
-            "ワークライフをよりシンプルに、より快適に、より生産的にする。\n\nSlack は、適切な人、情報、ツールを集めて仕事を成し遂げるためのコラボレーション ハブです。フォーチュン100の企業から片隅の市場ま...",
-        },
-      ],
-    }),
-    {
-      status: 200,
+      switch (req.url) {
+        case "https://slack.com/api/conversations.replies":
+          if (req.headers.get("Authorization") === "Bearer empty-response") {
+            return new Response(JSON.stringify({ ok: true, messages: [] }), {
+              status: 200,
+            });
+          }
+          return new Response(
+            JSON.stringify({
+              "ok": true,
+              "oldest": "1670566778.964519",
+              "messages": [
+                {
+                  "type": "message",
+                  "text":
+                    "Make work life simpler, more pleasant and more productive.\n\nSlack is the collaboration hub that brings the right people, information, and tools together to get work done. From Fortune 100 companies to corner markets, millions of people around the world use Slack to connect their teams, unify their systems, and drive their business forward.",
+                  "user": "U03E94MK0",
+                  "ts": "1670566778.964519",
+                  "team": "T03E94MJU",
+                  "thread_ts": "1670566778.964519",
+                  "reply_count": 3,
+                  "reply_users_count": 1,
+                  "latest_reply": "1670570301.090889",
+                  "reply_users": ["U04EJMQQEFN"],
+                  "is_locked": false,
+                  "subscribed": false,
+                  "reactions": [{
+                    "name": "jp",
+                    "users": ["U03E94MK0"],
+                    "count": 1,
+                  }],
+                },
+              ],
+              "has_more": false,
+              "pin_count": 0,
+              "channel_actions_ts": null,
+              "channel_actions_count": 0,
+            }),
+            {
+              status: 200,
+            },
+          );
+        case "https://slack.com/api/chat.postMessage": {
+          return new Response(JSON.stringify({ ok: true, ts: "1111.2222" }), {
+            status: 200,
+          });
+        }
+        case "https://api.deepl.com/v2/translate": {
+          const body = await req.formData();
+          if (body.get("auth_key") === "valid") {
+            return new Response(
+              JSON.stringify({
+                translations: [
+                  {
+                    detected_source_language: "EN",
+                    text:
+                      "ワークライフをよりシンプルに、より快適に、より生産的にする。\n\nSlack は、適切な人、情報、ツールを集めて仕事を成し遂げるためのコラボレーション ハブです。フォーチュン100の企業から片隅の市場ま...",
+                  },
+                ],
+              }),
+              {
+                status: 200,
+              },
+            );
+          }
+          return new Response("", { status: 403 });
+        }
+        default:
+          throw Error(
+            `No stub found for ${req.method} ${req.url}\nHeaders: ${
+              JSON.stringify(Object.fromEntries(req.headers.entries()))
+            }`,
+          );
+      }
     },
   );
-});
+}
 
 const { createContext } = SlackFunctionTester("my-function");
 
 Deno.test("No message found", async () => {
+  using _stubFetch = stubFetch();
   const inputs = {
     channelId: "C111",
     messageTs: "1670566778.964519",
@@ -88,6 +107,7 @@ Deno.test("No message found", async () => {
 });
 
 Deno.test("Translate a message successfully", async () => {
+  using _stubFetch = stubFetch();
   const inputs = {
     channelId: "C123",
     messageTs: "1670566778.964519",
@@ -100,6 +120,7 @@ Deno.test("Translate a message successfully", async () => {
 });
 
 Deno.test("Fail to translate with an invalid auth key", async () => {
+  using _stubFetch = stubFetch();
   const inputs = {
     channelId: "C111",
     messageTs: "1670566778.964519",