-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds overloads to GetArchive for adding custom timeouts #918
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -187,14 +187,30 @@ public Task<string> GetArchiveLink(string owner, string name, ArchiveFormat arch | |
/// <param name="archiveFormat">The format of the archive. Can be either tarball or zipball</param> | ||
/// <param name="reference">A valid Git reference.</param> | ||
/// <returns>The binary contents of the archive</returns> | ||
public async Task<byte[]> GetArchive(string owner, string name, ArchiveFormat archiveFormat, string reference) | ||
public Task<byte[]> GetArchive(string owner, string name, ArchiveFormat archiveFormat, string reference) | ||
{ | ||
return GetArchive(owner, name, archiveFormat, string.Empty, TimeSpan.FromMinutes(60)); | ||
} | ||
|
||
/// <summary> | ||
/// Get an archive of a given repository's contents, in a specific format | ||
/// </summary> | ||
/// <remarks>https://developer.github.com/v3/repos/contents/#get-archive-link</remarks> | ||
/// <param name="owner">The owner of the repository</param> | ||
/// <param name="name">The name of the repository</param> | ||
/// <param name="archiveFormat">The format of the archive. Can be either tarball or zipball</param> | ||
/// <param name="reference">A valid Git reference.</param> | ||
/// <param name="timeout"> Time span until timeout </param> | ||
/// <returns>The binary contents of the archive</returns> | ||
public async Task<byte[]> GetArchive(string owner, string name, ArchiveFormat archiveFormat, string reference, TimeSpan timeout) | ||
{ | ||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); | ||
Ensure.ArgumentNotNullOrEmptyString(name, "name"); | ||
Ensure.GreaterThanZero(timeout, "timeout"); | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Validate the |
||
var endpoint = ApiUrls.RepositoryArchiveLink(owner, name, archiveFormat, reference); | ||
|
||
var response = await Connection.Get<byte[]>(endpoint, TimeSpan.FromMinutes(60)); | ||
var response = await Connection.Get<byte[]>(endpoint, timeout); | ||
|
||
return response.Body; | ||
} | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably validate that the TimeSpan is not negative as a negative value is almost certainly a programmer error. I'd throw an
ArgumentOutOfRange
exception.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 done on line 182