PART 3: Add UploadArchiveToGithubStorageWithMultiPart method #1271

begonaguereca · 2024-09-25T21:02:05Z

This pull request introduces a new feature for uploading archives to GitHub storage and includes corresponding unit tests.

We are also updating the content types of Stream and Multipart uploads in the SendAsync method.

Did you write/update appropriate tests
Release notes updated (if appropriate)
Appropriate logging output
Issue linked
Docs updated (or issue created)
New package licenses are added to ThirdPartyNotices.txt (if applicable)

github-actions · 2024-09-25T21:57:06Z

Unit Test Results

815 tests 815 ✅ 21s ⏱️
1 suites 0 💤
1 files 0 ❌

Results for commit cd88309.

♻️ This comment has been updated with latest results.

src/Octoshift/Services/GithubApi.cs

src/OctoshiftCLI.Tests/Octoshift/Services/GithubApiTests.cs

github-actions · 2024-10-08T18:46:06Z

Package	Line Rate	Branch Rate	Complexity	Health
gei	79%	70%	519	✔
ado2gh	84%	78%	627	✔
Octoshift	87%	76%	1288	✔
bbs2gh	78%	73%	651	✔
Summary	83% (6860 / 8218)	75% (1541 / 2056)	3085	✔

ArinGhazarian

Dropped some comments mostly around simplifying the code and unit tests. Tests need to be added for GithubClient too

ArinGhazarian · 2024-10-08T19:39:52Z

src/Octoshift/Services/GithubApi.cs

+            using var content = new MultipartFormDataContent
+            {
+                { httpContent, "archive", archiveName }
+            };


Initializing a using variable with an object initializer might lead to problems if an exception is thrown during the initialization and the using variable may never get disposed so here it's better to add the content with the Add() method:

Suggested change

using var content = new MultipartFormDataContent

{

{ httpContent, "archive", archiveName }

};

using var content = new MultipartFormDataContent();

content.Add(streamContent, "archive", archiveName);

ArinGhazarian · 2024-10-08T19:41:55Z

src/Octoshift/Services/GithubApi.cs

+        {
+            var url = $"https://uploads.github.com/organizations/{orgDatabaseId.EscapeDataString()}/gei/archive?name={archiveName.EscapeDataString()}";
+
+            response = await _client.PostAsync(url, httpContent);


renaming httpContent to streamContent:

Suggested change

response = await _client.PostAsync(url, httpContent);

response = await _client.PostAsync(url, streamContent);

ArinGhazarian · 2024-10-08T19:42:07Z

src/Octoshift/Services/GithubApi.cs

@@ -1071,6 +1072,33 @@ mutation abortRepositoryMigration(
        }
    }

+    public virtual async Task<string> UploadArchiveToGithubStorage(string orgDatabaseId, bool isMultipart, string archiveName, Stream archiveContent)
+    {
+        using var httpContent = new StreamContent(archiveContent);


nit: I would call this variable streamContent for clarity as both stream and multipart from data are technically HttpContent"

Suggested change

using var httpContent = new StreamContent(archiveContent);

using var streamContent = new StreamContent(archiveContent);

ArinGhazarian · 2024-10-08T19:45:51Z

src/Octoshift/Services/GithubClient.cs

+            _log.LogVerbose(body is MultipartFormDataContent or StreamContent ? "HTTP BODY: BLOB" : $"HTTP BODY: {body.ToJson()}");

-            request.Content = body.ToJson().ToStringContent();
+            request.Content = body switch
+            {
+                MultipartFormDataContent multipartFormDataContent => multipartFormDataContent,
+                StreamContent streamContent => streamContent,
+                _ => body.ToJson().ToStringContent()
+            };


I was thinking this can be simplified as we now either support a HttpContent or a JSON object (it cannot let me add a code suggestion):

if (body is HttpContent httpContent) { _log.LogVerbose("HTTP BODY: BLOB"); request.Content = httpContent; } else { var jsonBody = body.ToJson(); _log.LogVerbose($"HTTP BODY: {jsonBody}"); request.Content = jsonBody.ToStringContent(); }

ArinGhazarian · 2024-10-08T20:10:16Z

src/OctoshiftCLI.Tests/Octoshift/Services/GithubApiTests.cs

@@ -3462,6 +3463,62 @@ await _githubApi.Invoking(api => api.AbortMigration(migrationId))
            .WithMessage(expectedErrorMessage);
    }

+    [Fact]
+    public async Task UploadArchiveToGithubStorage()


Suggested change

public async Task UploadArchiveToGithubStorage()

public async Task UploadArchiveToGithubStorage_Should_Upload_Stream_Content()

ArinGhazarian · 2024-10-08T20:11:07Z

src/OctoshiftCLI.Tests/Octoshift/Services/GithubApiTests.cs

+        var jsonResponse = $"{{ \"archiveId\": \"{expectedArchiveId}\" }}";
+
+        _githubClientMock
+            .Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<HttpContent>(), null))


Let's make sure that PostAsync receives a StreamContent:

Suggested change

.Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<HttpContent>(), null))

.Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<StreamContent>(), null))

ArinGhazarian · 2024-10-08T20:13:45Z

src/OctoshiftCLI.Tests/Octoshift/Services/GithubApiTests.cs

+
+
+    [Fact]
+    public async Task UploadArchiveToGithubStorageWithMultiPart()


We use snaked cased test names throughout the project:

Suggested change

public async Task UploadArchiveToGithubStorageWithMultiPart()

public async Task UploadArchiveToGithubStorage_Should_Upload_Multipart_Content()

ArinGhazarian · 2024-10-08T20:14:02Z

src/OctoshiftCLI.Tests/Octoshift/Services/GithubApiTests.cs

+        var jsonResponse = $"{{ \"archiveId\": \"{expectedArchiveId}\" }}";
+
+        _githubClientMock
+            .Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<HttpContent>(), null))


Suggested change

.Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<HttpContent>(), null))

.Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<MultipartFormDataContent>(), null))

Add UploadArchiveToGithubStorageWithMultiPart method

aab0557

begonaguereca marked this pull request as ready for review September 30, 2024 19:05

begonaguereca commented Sep 30, 2024

View reviewed changes

src/Octoshift/Services/GithubApi.cs Show resolved Hide resolved

ArinGhazarian reviewed Sep 30, 2024

View reviewed changes

src/Octoshift/Services/GithubApi.cs Outdated Show resolved Hide resolved

src/Octoshift/Services/GithubApi.cs Show resolved Hide resolved

begonaguereca marked this pull request as draft October 7, 2024 19:31

begonaguereca added 6 commits October 8, 2024 08:35

Make changes to SendAsync command

1fca83d

remove backslashed

f81e02a

Escape string

2c8de4a

Merge branch 'main' into github-api-upload

619e6da

Fixing unit tests

bf5eef2

alphabetical order

60e9ed1

github-advanced-security bot found potential problems Oct 8, 2024

View reviewed changes

src/OctoshiftCLI.Tests/Octoshift/Services/GithubApiTests.cs Fixed Show fixed Hide fixed

src/OctoshiftCLI.Tests/Octoshift/Services/GithubApiTests.cs Fixed Show fixed Hide fixed

src/OctoshiftCLI.Tests/Octoshift/Services/GithubApiTests.cs Fixed Show fixed Hide fixed

clean up

cd88309

begonaguereca marked this pull request as ready for review October 8, 2024 17:29

begonaguereca marked this pull request as draft October 8, 2024 17:40

begonaguereca changed the title ~~PART 3: Add UploadArchiveToGithubStorageWithMultiPart method~~ PART 4: Add UploadArchiveToGithubStorageWithMultiPart method Oct 8, 2024

begonaguereca changed the title ~~PART 4: Add UploadArchiveToGithubStorageWithMultiPart method~~ PART 3: Add UploadArchiveToGithubStorageWithMultiPart method Oct 8, 2024

begonaguereca marked this pull request as ready for review October 8, 2024 17:48

begonaguereca changed the base branch from main to git-storage-option-feature October 8, 2024 19:15

begonaguereca merged commit cd6311a into git-storage-option-feature Oct 8, 2024
30 checks passed

begonaguereca deleted the github-api-upload branch October 8, 2024 19:37

ArinGhazarian requested changes Oct 8, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PART 3: Add UploadArchiveToGithubStorageWithMultiPart method #1271

PART 3: Add UploadArchiveToGithubStorageWithMultiPart method #1271

begonaguereca commented Sep 25, 2024 •

edited

Loading

github-actions bot commented Sep 25, 2024 •

edited

Loading

github-actions bot commented Oct 8, 2024

ArinGhazarian left a comment

ArinGhazarian Oct 8, 2024

ArinGhazarian Oct 8, 2024

ArinGhazarian Oct 8, 2024

ArinGhazarian Oct 8, 2024

ArinGhazarian Oct 8, 2024

ArinGhazarian Oct 8, 2024

ArinGhazarian Oct 8, 2024

ArinGhazarian Oct 8, 2024

	response = await _client.PostAsync(url, httpContent);
	response = await _client.PostAsync(url, streamContent);

	using var httpContent = new StreamContent(archiveContent);
	using var streamContent = new StreamContent(archiveContent);

	public async Task UploadArchiveToGithubStorage()
	public async Task UploadArchiveToGithubStorage_Should_Upload_Stream_Content()

	.Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<HttpContent>(), null))
	.Setup(m => m.PostAsync(It.IsAny<string>(), It.IsAny<StreamContent>(), null))



		[Fact]
		public async Task UploadArchiveToGithubStorageWithMultiPart()

PART 3: Add UploadArchiveToGithubStorageWithMultiPart method #1271

PART 3: Add UploadArchiveToGithubStorageWithMultiPart method #1271

Conversation

begonaguereca commented Sep 25, 2024 • edited Loading

github-actions bot commented Sep 25, 2024 • edited Loading

Unit Test Results

github-actions bot commented Oct 8, 2024

ArinGhazarian left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

begonaguereca commented Sep 25, 2024 •

edited

Loading

github-actions bot commented Sep 25, 2024 •

edited

Loading