Draft of file upload

Author: archive

.github/workflows/15-slack-upload-file.yml

@@ -0,0 +1,29 @@
+name: test-15-slack-upload-file
+
+on: [push]
+
+permissions: {}
+
+jobs:
+  slack-action:
+    #if: ${{ false }}
+    runs-on: ubuntu-latest
+    name: Test 15 [ubuntu-latest]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Upload File to Slack
+        uses: archive/github-actions-slack@upload-files
+        id: upload-file
+        with:
+          slack-function: upload-file
+          slack-bot-user-oauth-access-token: ${{ secrets.SLACK_BOT_USER_OAUTH_ACCESS_TOKEN }}
+          slack-channel: C0ARB84BQC9
+          slack-upload-file-path: README.md
+          slack-upload-file-title: Test 15 - README upload
+          slack-upload-initial-comment: Test 15 - uploading a file 📎
+
+      - name: Result from "Upload File"
+        run: echo '${{ steps.upload-file.outputs.slack-result }}'

action.yml

@@ -56,7 +56,19 @@ inputs:
     description: "https://api.slack.com/methods/chat.postMessage#arg_username"
     required: false
   slack-function:
-    description: send-message (https://api.slack.com/methods/chat.postMessage) or send-reaction (https://api.slack.com/methods/reactions.add) or update-message (https://api.slack.com/methods/chat.update)
+    description: send-message (https://api.slack.com/methods/chat.postMessage) or send-reaction (https://api.slack.com/methods/reactions.add) or update-message (https://api.slack.com/methods/chat.update) or upload-file (https://api.slack.com/methods/files.upload)
+    required: false
+  slack-upload-file-path:
+    description: "https://api.slack.com/methods/files.upload#arg_file"
+    required: false
+  slack-upload-filename:
+    description: "https://api.slack.com/methods/files.upload#arg_filename"
+    required: false
+  slack-upload-file-title:
+    description: "https://api.slack.com/methods/files.upload#arg_title"
+    required: false
+  slack-upload-initial-comment:
+    description: "https://api.slack.com/methods/files.upload#arg_initial_comment"
     required: false
   slack-emoji-name:
     description: "https://api.slack.com/methods/reactions.add#arg_name"

integration-test/end-to-end.js

@@ -4,6 +4,7 @@ import {
   apiPostMessage,
   apiAddReaction,
   apiUpdateMessage,
+  apiUploadFile,
 } from "../src/integration/slack-api.js";
 import buildMessage from "../src/message/build-message.js";
 import buildReaction from "../src/reaction/build-reaction.js";
@@ -103,4 +104,16 @@ const testUpdateMessage = async (channel, token) => {
     process.env.CHANNEL,
     process.env.BOT_USER_OAUTH_ACCESS_TOKEN
   );
+
+  const uploadResult = await apiUploadFile(
+    process.env.BOT_USER_OAUTH_ACCESS_TOKEN,
+    {
+      channel: process.env.CHANNEL,
+      filePath: "integration-test/one-does-not-simply.jpg",
+      filename: "one-does-not-simply.jpg",
+      title: "Test 5 - Upload File",
+      initialComment: "Test 5 - testUploadFile 📎",
+    }
+  );
+  assert.strictEqual(uploadResult.statusCode, 200);
 })();

integration-test/one-does-not-simply.jpg

@@ -64,4 +64,101 @@ const post = (token, path, message) => {
   });
 };
 
-export { post };
+// Used for Slack methods that require application/x-www-form-urlencoded (e.g. files.getUploadURLExternal)
+const postForm = (token, path, fields) => {
+  return new Promise((resolve, reject) => {
+    const payload = new URLSearchParams(fields).toString();
+
+    context.debugExtra("SLACK POST FORM PAYLOAD", payload);
+
+    const options = {
+      hostname: "slack.com",
+      port: 443,
+      path: path,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/x-www-form-urlencoded",
+        "Content-Length": Buffer.byteLength(payload),
+        Authorization: `Bearer ${token}`,
+      },
+    };
+
+    const req = https.request(options, (res) => {
+      const chunks = [];
+
+      res.on("data", (chunk) => {
+        chunks.push(chunk);
+      });
+
+      res.on("end", () => {
+        const result = Buffer.concat(chunks).toString();
+        const response = JSON.parse(result);
+
+        let isOk = res.statusCode >= 200 && res.statusCode <= 299;
+
+        if (response && response.hasOwnProperty("ok") && response.ok === false) {
+          isOk = false;
+        }
+
+        resolve({
+          statusCode: res.statusCode,
+          statusMessage: res.statusMessage,
+          ok: isOk,
+          result: result,
+          response: response,
+        });
+      });
+    });
+
+    req.on("error", (error) => {
+      reject(error);
+    });
+
+    req.write(payload);
+    req.end();
+  });
+};
+
+// Used for step 2 of the files.getUploadURLExternal flow — posts raw binary
+// to the pre-signed upload URL returned by Slack (may be a different hostname).
+const postBinary = (uploadUrl, fileContent) => {
+  return new Promise((resolve, reject) => {
+    const url = new URL(uploadUrl);
+    const options = {
+      hostname: url.hostname,
+      port: 443,
+      path: url.pathname + url.search,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/octet-stream",
+        "Content-Length": fileContent.length,
+      },
+    };
+
+    context.debug("SLACK UPLOAD BINARY to " + url.hostname + url.pathname);
+
+    const req = https.request(options, (res) => {
+      const chunks = [];
+
+      res.on("data", (chunk) => {
+        chunks.push(chunk);
+      });
+
+      res.on("end", () => {
+        resolve({
+          statusCode: res.statusCode,
+          ok: res.statusCode >= 200 && res.statusCode <= 299,
+        });
+      });
+    });
+
+    req.on("error", (error) => {
+      reject(error);
+    });
+
+    req.write(fileContent);
+    req.end();
+  });
+};
+
+export { post, postForm, postBinary };

src/integration/slack-api-post.js

@@ -1,4 +1,6 @@
-import { post } from "./slack-api-post.js";
+import fs from "fs";
+import path from "path";
+import { post, postForm, postBinary } from "./slack-api-post.js";
 
 const hasErrors = (res) => !res || !res.ok;
 
@@ -39,4 +41,46 @@ const apiUpdateMessage = async (token, message) => {
   return res;
 };
 
-export { apiPostMessage, apiAddReaction, apiUpdateMessage };
+const apiUploadFile = async (token, payload) => {
+  const fileContent = fs.readFileSync(payload.filePath);
+  const filename = payload.filename || path.basename(payload.filePath);
+
+  // Step 1: Get upload URL and file ID (requires form encoding, not JSON)
+  const urlRes = await postForm(token, "/api/files.getUploadURLExternal", {
+    filename,
+    length: fileContent.length,
+  });
+  if (hasErrors(urlRes)) {
+    throw buildErrorMessage(urlRes);
+  }
+
+  const { upload_url, file_id } = urlRes.response;
+
+  // Step 2: Upload the file binary to the pre-signed URL
+  const uploadRes = await postBinary(upload_url, fileContent);
+  if (!uploadRes.ok) {
+    throw `Error uploading file content (status ${uploadRes.statusCode})`;
+  }
+
+  // Step 3: Complete the upload and share to channel
+  const completePayload = {
+    files: [{ id: file_id, title: payload.title || filename }],
+    channel_id: payload.channel,
+  };
+  if (payload.initialComment) {
+    completePayload.initial_comment = payload.initialComment;
+  }
+
+  const result = await post(
+    token,
+    "/api/files.completeUploadExternal",
+    completePayload
+  );
+  if (hasErrors(result)) {
+    throw buildErrorMessage(result);
+  }
+
+  return result;
+};
+
+export { apiPostMessage, apiAddReaction, apiUpdateMessage, apiUploadFile };

src/integration/slack-api.js

@@ -12,6 +12,12 @@ describe("slack api", () => {
       post: function (token, path, message) {
         return errorResponse;
       },
+      postForm: function (token, path, fields) {
+        return errorResponse;
+      },
+      postBinary: function (uploadUrl, fileContent) {
+        return errorResponse;
+      },
     }));
 
     const slackApi = await import("./slack-api.js");

src/integration/slack-api.test.js

@@ -2,6 +2,7 @@ import * as context from "./context.js";
 import { postMessage } from "./message/index.js";
 import { addReaction } from "./reaction/index.js";
 import { updateMessage } from "./update-message/index.js";
+import { uploadFile } from "./upload-file/index.js";
 
 const jsonPretty = (data) => JSON.stringify(data, undefined, 2);
 
@@ -19,6 +20,9 @@ const invoke = async () => {
       case "update-message":
         await updateMessage();
         break;
+      case "upload-file":
+        await uploadFile();
+        break;
       default:
         context.setFailed("Unhandled `slack-function`: " + func);
         break;

src/invoke.js

@@ -0,0 +1,25 @@
+const buildUploadFile = (
+  channel = "",
+  filePath = "",
+  filename = "",
+  title = "",
+  initialComment = ""
+) => {
+  if (!channel) {
+    throw new Error("Channel must be set");
+  }
+
+  if (!filePath) {
+    throw new Error("File path must be set");
+  }
+
+  return {
+    channel,
+    filePath,
+    filename,
+    title,
+    initialComment,
+  };
+};
+
+export default buildUploadFile;

src/upload-file/build-upload-file.js

@@ -0,0 +1,35 @@
+import * as context from "../context.js";
+import { apiUploadFile } from "../integration/slack-api.js";
+import buildUploadFile from "./build-upload-file.js";
+
+const jsonPretty = (data) => JSON.stringify(data, undefined, 2);
+
+const uploadFile = async () => {
+  try {
+    const token = context.getRequired("slack-bot-user-oauth-access-token");
+    const channel = context.getRequired("slack-channel");
+    const filePath = context.getRequired("slack-upload-file-path");
+    const filename = context.getOptional("slack-upload-filename");
+    const title = context.getOptional("slack-upload-file-title");
+    const initialComment = context.getOptional("slack-upload-initial-comment");
+
+    const payload = buildUploadFile(
+      channel,
+      filePath,
+      filename,
+      title,
+      initialComment
+    );
+
+    context.debugExtra("Upload File PAYLOAD", payload);
+    const result = await apiUploadFile(token, payload);
+    context.debugExtra("Upload File RESULT", result);
+
+    const resultAsJson = jsonPretty(result);
+    context.setOutput("slack-result", resultAsJson);
+  } catch (error) {
+    context.setFailed(jsonPretty(error));
+  }
+};
+
+export { uploadFile };