Scripts to list (non-functional) and delete slack messages (#650)

Author: nlarew

package-lock.json

@@ -24,6 +24,8 @@
     "scripts:removeTestDatabases": "lerna run --scope='scripts' removeTestDatabases -- ",
     "scripts:materializeScrubbedMessagesStats:all": "lerna run --scope='scripts' materializeScrubbedMessagesStats:all",
     "scripts:materializeScrubbedMessagesStats:latest": "lerna run --scope='scripts' materializeScrubbedMessagesStats:latest",
+    "scripts:listSlackMessages": "lerna run --scope='scripts' listSlackMessages -- ",
+    "scripts:removeSlackMessage": "lerna run --scope='scripts' removeSlackMessage -- ",
     "server:start": "lerna run start --scope='chatbot-server-mongodb-public'",
     "eval:conversationQualityCheckPipeline": "lerna run pipeline:conversationQualityCheck --scope='chatbot-eval-mongodb-public'",
     "eval:faqConversationQualityCheckPipeline": "lerna run pipeline:faqConversationQualityCheck --scope='chatbot-eval-mongodb-public'"

package.json

@@ -24,6 +24,8 @@
     "removeTestDatabases": "npm run build && node ./build/removeTestDatabases.js",
     "getConversationText": "npm run build && node ./build/getConversationText.js",
     "findPageTitles": "npm run build && node ./build/main/findPageTitlesMain.js",
+    "listSlackMessages": "npm run build && node ./build/main/listSlackMessagesMain.js",
+    "removeSlackMessage": "npm run build && node ./build/main/removeSlackMessageMain.js",
     "test": "jest --forceExit",
     "build": "npm run clean && tsc -b tsconfig.build.json",
     "postbuild": "cp ./src/MessageAnalysis.d.ts ./build/",
@@ -38,6 +40,7 @@
   "dependencies": {
     "@cdxoo/dbscan": "^1.1.1",
     "@release-it/bumper": "^5.1.0",
+    "@slack/web-api": "^7.8.0",
     "@stdlib/random-sample": "^0.2.1",
     "csv": "^6.3.1",
     "dotenv": "^16.3.1",

packages/scripts/package.json

@@ -0,0 +1,71 @@
+import dotenv from "dotenv";
+import { WebClient } from "@slack/web-api";
+import path from "path";
+
+// Load environment variables from .env file
+dotenv.config({ path: path.resolve(__dirname, "../../.env") });
+
+/**
+ Lists the last 25 messages from a Slack channel
+ 
+ @param channelId - The ID of the Slack channel to fetch messages from
+ */
+export async function listSlackMessages(channelId: string): Promise<void> {
+  // Check if SLACK_BOT_TOKEN is available in environment variables
+  const slackToken = process.env.SLACK_BOT_TOKEN;
+  if (!slackToken) {
+    console.error("Error: SLACK_BOT_TOKEN environment variable is not set");
+    console.error("Please add it to your .env file");
+    process.exit(1);
+  }
+
+  try {
+    // Initialize the Slack Web API client
+    const client = new WebClient(slackToken);
+
+    console.log(`Fetching the last 25 messages from channel: ${channelId}`);
+
+    // Call the conversations.history method
+    const result = await client.conversations.history({
+      channel: channelId,
+      limit: 25,
+    });
+
+    if (!result.messages || result.messages.length === 0) {
+      console.log("No messages found in this channel");
+      return;
+    }
+
+    // Display the messages
+    console.log(`Found ${result.messages.length} messages:`);
+    console.log("-----------------------------------");
+
+    result.messages.forEach((message, index) => {
+      const timestamp = new Date(Number(message.ts) * 1000).toLocaleString();
+      console.log(`[${index + 1}] ${timestamp}`);
+      console.log(`User: ${message.user || "Unknown"}`);
+      console.log(`Text: ${message.text || "No text content"}`);
+      console.log("-----------------------------------");
+    });
+  } catch (error) {
+    console.error("Error fetching messages:", error);
+    process.exit(1);
+  }
+}
+
+// Main function to run when script is executed directly
+if (require.main === module) {
+  // Get channel ID from command line arguments
+  const args = process.argv.slice(2);
+  if (args.length !== 1) {
+    console.error("Usage: npm run listSlackMessages -- <channel_id>");
+    process.exit(1);
+  }
+
+  console.info(
+    `NOTE: You can find a specific message ID (i.e. its \`ts\` value) by opening a channel in the Slack Web UI and inspecting the message in dev tools. For example, id="1741289525.588509".\n`
+  );
+
+  const channelId = args[0];
+  listSlackMessages(channelId).catch(console.error);
+}

packages/scripts/src/main/listSlackMessagesMain.ts

@@ -0,0 +1,68 @@
+import dotenv from "dotenv";
+import { WebClient } from "@slack/web-api";
+import path from "path";
+
+// Load environment variables from .env file
+dotenv.config({ path: path.resolve(__dirname, "../../.env") });
+
+/**
+ Removes a message from a Slack channel
+ 
+ @param channelId - The ID of the Slack channel
+ @param messageTs - The timestamp of the message to remove
+ */
+export async function removeSlackMessage(
+  channelId: string,
+  messageTs: string
+): Promise<void> {
+  // Check if SLACK_BOT_TOKEN is available in environment variables
+  const slackToken = process.env.SLACK_BOT_TOKEN;
+  if (!slackToken) {
+    console.error("Error: SLACK_BOT_TOKEN environment variable is not set");
+    console.error("Please add it to your .env file");
+    process.exit(1);
+  }
+
+  try {
+    // Initialize the Slack Web API client
+    const client = new WebClient(slackToken);
+
+    console.log(
+      `Attempting to delete message with timestamp ${messageTs} from channel ${channelId}`
+    );
+
+    // Call the chat.delete method to remove the message
+    const result = await client.chat.delete({
+      channel: channelId,
+      ts: messageTs,
+      as_user: true, // Delete as the authenticated user
+    });
+
+    if (result.ok) {
+      console.log("Message successfully deleted");
+    } else {
+      console.error("Failed to delete message:", result.error);
+    }
+  } catch (error) {
+    console.error("Error deleting message:", error);
+    process.exit(1);
+  }
+}
+
+// Main function to run when script is executed directly
+if (require.main === module) {
+  // Get channel ID and message timestamp from command line arguments
+  const args = process.argv.slice(2);
+  if (args.length !== 2) {
+    console.error(
+      "Usage: npm run removeSlackMessage -- <channel_id> <message_timestamp>"
+    );
+    console.error(
+      "Example: npm run removeSlackMessage -- C01234ABCDE 1623456789.123456"
+    );
+    process.exit(1);
+  }
+
+  const [channelId, messageTs] = args;
+  removeSlackMessage(channelId, messageTs).catch(console.error);
+}