diff --git a/source/src/Slackbot.Net.SlackClients.Http/Extensions/HttpClientExtensions.cs b/source/src/Slackbot.Net.SlackClients.Http/Extensions/HttpClientExtensions.cs index 51a97a0..bde8bfa 100644 --- a/source/src/Slackbot.Net.SlackClients.Http/Extensions/HttpClientExtensions.cs +++ b/source/src/Slackbot.Net.SlackClients.Http/Extensions/HttpClientExtensions.cs @@ -88,39 +88,19 @@ public static async Task PostParametersAsForm(this HttpClient httpClient, return resObj; } - public static async Task PostParametersAsMultiPartFormData(this HttpClient httpClient, IEnumerable> parameters, Byte[] bytes, string api, Action logger = null) where T: Response + // Slack's upload_url answers with plain text ("OK - "), so only the status code matters. + public static async Task PostBytes(this HttpClient httpClient, string url, byte[] bytes, Action logger = null) { - var request = new HttpRequestMessage(HttpMethod.Post, api); - - if (parameters != null && parameters.Any()) - { - var formData = new MultipartFormDataContent(); - foreach (KeyValuePair param in parameters) - { - formData.Add(new StringContent(param.Value), param.Key); - } - formData.Add(new ByteArrayContent(bytes), "file", parameters.First(p => p.Key == "filename").Value); - - request.Content = formData; - } - - var response = await httpClient.SendAsync(request); + var response = await httpClient.PostAsync(url, new ByteArrayContent(bytes)); var responseContent = await response.Content.ReadAsStringAsync(); - + if (!response.IsSuccessStatusCode) { logger?.Invoke($"{response.StatusCode} \n {responseContent}"); } - + ThrowIfRateLimited(response, responseContent); response.EnsureSuccessStatusCode(); - - var resObj = JsonSerializer.Deserialize(responseContent, JsonSerializerSettings); - - if(!resObj.Ok) - throw new WellKnownSlackApiException(error: $"{resObj.Error}", responseContent:responseContent); - - return resObj; } private static readonly TimeSpan DefaultRetryAfter = TimeSpan.FromSeconds(60); diff --git a/source/src/Slackbot.Net.SlackClients.Http/ISlackClient.cs b/source/src/Slackbot.Net.SlackClients.Http/ISlackClient.cs index 97baf40..501869c 100644 --- a/source/src/Slackbot.Net.SlackClients.Http/ISlackClient.cs +++ b/source/src/Slackbot.Net.SlackClients.Http/ISlackClient.cs @@ -138,12 +138,19 @@ public interface ISlackClient Task UserProfile(string user); /// - /// Scopes required: files.write - /// Uploads a file + /// Scopes required: files:write + /// Uploads text content as a file via files.getUploadURLExternal + files.completeUploadExternal. + /// Channels must be channel IDs (comma-separated). Only File.Id and File.Title are populated. /// - /// https://api.slack.com/methods/files.upload + /// https://docs.slack.dev/reference/methods/files.completeUploadExternal Task FilesUpload(FileUploadRequest fileupload); + /// + /// Scopes required: files:write + /// Uploads a file via files.getUploadURLExternal + files.completeUploadExternal. + /// Channels must be channel IDs (comma-separated). Only File.Id and File.Title are populated. + /// + /// https://docs.slack.dev/reference/methods/files.completeUploadExternal Task FilesUpload(FileUploadMultiPartRequest req); /// diff --git a/source/src/Slackbot.Net.SlackClients.Http/Models/Responses/FileUpload/FileUploadResponse.cs b/source/src/Slackbot.Net.SlackClients.Http/Models/Responses/FileUpload/FileUploadResponse.cs index 40f81cf..18cf9fb 100644 --- a/source/src/Slackbot.Net.SlackClients.Http/Models/Responses/FileUpload/FileUploadResponse.cs +++ b/source/src/Slackbot.Net.SlackClients.Http/Models/Responses/FileUpload/FileUploadResponse.cs @@ -3,6 +3,13 @@ namespace Slackbot.Net.SlackClients.Http.Models.Responses.FileUpload; public class FileUploadResponse : Response { public FileUploadFile File { get; set; } + public FileUploadFile[] Files { get; set; } +} + +internal class FilesGetUploadUrlExternalResponse : Response +{ + public string Upload_Url { get; set; } + public string File_Id { get; set; } } public class FileUploadFile diff --git a/source/src/Slackbot.Net.SlackClients.Http/SlackClient.cs b/source/src/Slackbot.Net.SlackClients.Http/SlackClient.cs index c63a13b..4ed9801 100644 --- a/source/src/Slackbot.Net.SlackClients.Http/SlackClient.cs +++ b/source/src/Slackbot.Net.SlackClients.Http/SlackClient.cs @@ -1,3 +1,5 @@ +using System.Text; +using System.Text.Json; using Microsoft.Extensions.Logging; using Slackbot.Net.SlackClients.Http.Extensions; using Slackbot.Net.SlackClients.Http.Models.Requests.AssistantThreadsSetStatus; @@ -222,40 +224,49 @@ public async Task UserProfile(string user) /// public async Task FilesUpload(FileUploadRequest req) { - var parameters = new List> - { - new KeyValuePair("channels", req.Channels), - new KeyValuePair("title", req.Title), - new KeyValuePair("content", req.Content), - new KeyValuePair("filename", req.Filename), - new KeyValuePair("filetype", req.Filetype), - new KeyValuePair("initial_comment", req.Initial_Comment), - new KeyValuePair("thread_ts", req.Thread_Ts), - }; - return await _client.PostParametersAsForm(parameters, "files.upload", s => _logger.LogTrace(s)); + return await UploadExternal(Encoding.UTF8.GetBytes(req.Content), req.Filename, req.Title, req.Channels, req.Initial_Comment, req.Thread_Ts); } /// public async Task FilesUpload(FileUploadMultiPartRequest req) { + return await UploadExternal(req.File, req.Filename, req.Title, req.Channels, req.Initial_Comment, req.Thread_Ts); + } + + private async Task UploadExternal(byte[] bytes, string filename, string title, string channels, string initialComment, string threadTs) + { + var uploadUrlParameters = new List> + { + new KeyValuePair("filename", filename), + new KeyValuePair("length", bytes.Length.ToString()), + }; + var uploadUrl = await _client.PostParametersAsForm(uploadUrlParameters, "files.getUploadURLExternal", s => _logger.LogTrace(s)); + + await _client.PostBytes(uploadUrl.Upload_Url, bytes, s => _logger.LogTrace(s)); + var parameters = new List> { - new KeyValuePair("channels", req.Channels), - new KeyValuePair("title", req.Title), - new KeyValuePair("filename", req.Filename), + new KeyValuePair("files", JsonSerializer.Serialize(new[] { new { id = uploadUrl.File_Id, title = title ?? filename } })), }; - if (req.Initial_Comment is { }) + if (channels is { }) + { + parameters.Add(new KeyValuePair("channels", channels)); + } + + if (initialComment is { }) { - parameters.Add(new KeyValuePair("initial_comment", req.Initial_Comment)); + parameters.Add(new KeyValuePair("initial_comment", initialComment)); } - if (req.Thread_Ts is { }) + if (threadTs is { }) { - parameters.Add(new KeyValuePair("thread_ts", req.Thread_Ts)); + parameters.Add(new KeyValuePair("thread_ts", threadTs)); } - return await _client.PostParametersAsMultiPartFormData(parameters, req.File, "files.upload", s => _logger.LogTrace(s)); + var response = await _client.PostParametersAsForm(parameters, "files.completeUploadExternal", s => _logger.LogTrace(s)); + response.File = response.Files?.FirstOrDefault(); + return response; } /// diff --git a/source/test/Slackbot.Net.SlackClients.Http.Tests/FileUploadExternalTests.cs b/source/test/Slackbot.Net.SlackClients.Http.Tests/FileUploadExternalTests.cs new file mode 100644 index 0000000..bf158b4 --- /dev/null +++ b/source/test/Slackbot.Net.SlackClients.Http.Tests/FileUploadExternalTests.cs @@ -0,0 +1,61 @@ +using System.Net; +using System.Text; +using Slackbot.Net.SlackClients.Http; +using Slackbot.Net.SlackClients.Http.Models.Requests.FileUpload; +using Slackbot.Net.Tests.Helpers; + +namespace Slackbot.Net.Tests; + +public class FileUploadExternalTests(ITestOutputHelper helper) +{ + private readonly RoutingHttpMessageHandler _handler = new(new Dictionary + { + ["https://slack.com/api/files.getUploadURLExternal"] = """{ "ok": true, "upload_url": "https://files.slack.com/upload/v1/abc", "file_id": "F123" }""", + ["https://files.slack.com/upload/v1/abc"] = "OK - 5", + ["https://slack.com/api/files.completeUploadExternal"] = """{ "ok": true, "files": [{ "id": "F123", "title": "beer" }] }""", + }); + + private ISlackClient Client => new SlackClient( + new HttpClient(_handler) { BaseAddress = new Uri("https://slack.com/api/") }, + new XUnitLogger(helper)); + + [Fact] + public async Task FilesUpload_Bytes_GetsUrl_Uploads_ThenCompletes() + { + var response = await Client.FilesUpload(new FileUploadMultiPartRequest + { + Channels = "C123", + File = [1, 2, 3, 4, 5], + Filename = "beer.png", + Title = "beer", + Thread_Ts = "1.2" + }); + + Assert.Equal("F123", response.File.Id); + Assert.Collection(_handler.Requests, + r => Assert.Equal("filename=beer.png&length=5", r.FormBody), + r => Assert.Equal(new byte[] { 1, 2, 3, 4, 5 }, r.Body), + r => Assert.Equal("""files=[{"id":"F123","title":"beer"}]&channels=C123&thread_ts=1.2""", r.FormBody)); + } + + [Fact] + public async Task FilesUpload_Content_UploadsUtf8_AndTitleFallsBackToFilename() + { + await Client.FilesUpload(new FileUploadRequest { Content = "hello", Filename = "hi.txt" }); + + Assert.Equal("hello", Encoding.UTF8.GetString(_handler.Requests[1].Body)); + Assert.Equal("""files=[{"id":"F123","title":"hi.txt"}]""", _handler.Requests[2].FormBody); + } + + private class RoutingHttpMessageHandler(Dictionary responsesByUrl) : HttpMessageHandler + { + public List<(byte[] Body, string FormBody)> Requests { get; } = []; + + protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) + { + var body = await request.Content!.ReadAsByteArrayAsync(cancellationToken); + Requests.Add((body, WebUtility.UrlDecode(Encoding.UTF8.GetString(body)))); + return new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(responsesByUrl[request.RequestUri!.ToString()]) }; + } + } +}