From fcae5e939405e905bcbb40968f038e520178b53d Mon Sep 17 00:00:00 2001 From: Halil ibrahim Kalkan Date: Tue, 19 Feb 2019 09:08:31 +0300 Subject: [PATCH] Refactor & add logs. --- .../Volo/Docs/Documents/DocumentAppService.cs | 2 +- .../Volo/Docs/Projects/ProjectAppService.cs | 2 +- .../Volo/Docs/Documents/IDocumentStore.cs | 4 ++-- .../FileSystem/Documents/FileSystemDocumentStore.cs | 4 ++-- .../Docs/GitHub/Documents/GithubDocumentStore.cs | 12 ++++++++---- 5 files changed, 14 insertions(+), 10 deletions(-) diff --git a/modules/docs/src/Volo.Docs.Application/Volo/Docs/Documents/DocumentAppService.cs b/modules/docs/src/Volo.Docs.Application/Volo/Docs/Documents/DocumentAppService.cs index b25ef2d76e..b5bc41410f 100644 --- a/modules/docs/src/Volo.Docs.Application/Volo/Docs/Documents/DocumentAppService.cs +++ b/modules/docs/src/Volo.Docs.Application/Volo/Docs/Documents/DocumentAppService.cs @@ -95,7 +95,7 @@ namespace Volo.Docs.Documents async () => { var store = _documentStoreFactory.Create(project.DocumentStoreType); - var document = await store.GetDocument(project, documentName, version); + var document = await store.GetDocumentAsync(project, documentName, version); return CreateDocumentWithDetailsDto(project, document); }, diff --git a/modules/docs/src/Volo.Docs.Application/Volo/Docs/Projects/ProjectAppService.cs b/modules/docs/src/Volo.Docs.Application/Volo/Docs/Projects/ProjectAppService.cs index 20970ade0d..02ffac9ee9 100644 --- a/modules/docs/src/Volo.Docs.Application/Volo/Docs/Projects/ProjectAppService.cs +++ b/modules/docs/src/Volo.Docs.Application/Volo/Docs/Projects/ProjectAppService.cs @@ -68,7 +68,7 @@ namespace Volo.Docs.Projects protected virtual async Task> GetVersionsAsync(Project project) { var store = _documentStoreFactory.Create(project.DocumentStoreType); - var versions = await store.GetVersions(project); + var versions = await store.GetVersionsAsync(project); if (!versions.Any()) { diff --git a/modules/docs/src/Volo.Docs.Domain/Volo/Docs/Documents/IDocumentStore.cs b/modules/docs/src/Volo.Docs.Domain/Volo/Docs/Documents/IDocumentStore.cs index 8ab0b3f332..1b001303b5 100644 --- a/modules/docs/src/Volo.Docs.Domain/Volo/Docs/Documents/IDocumentStore.cs +++ b/modules/docs/src/Volo.Docs.Domain/Volo/Docs/Documents/IDocumentStore.cs @@ -7,9 +7,9 @@ namespace Volo.Docs.Documents { public interface IDocumentStore : IDomainService { - Task GetDocument(Project project, string documentName, string version); + Task GetDocumentAsync(Project project, string documentName, string version); - Task> GetVersions(Project project); + Task> GetVersionsAsync(Project project); Task GetResource(Project project, string resourceName, string version); } diff --git a/modules/docs/src/Volo.Docs.Domain/Volo/Docs/FileSystem/Documents/FileSystemDocumentStore.cs b/modules/docs/src/Volo.Docs.Domain/Volo/Docs/FileSystem/Documents/FileSystemDocumentStore.cs index a8366554dc..87a74d1702 100644 --- a/modules/docs/src/Volo.Docs.Domain/Volo/Docs/FileSystem/Documents/FileSystemDocumentStore.cs +++ b/modules/docs/src/Volo.Docs.Domain/Volo/Docs/FileSystem/Documents/FileSystemDocumentStore.cs @@ -14,7 +14,7 @@ namespace Volo.Docs.FileSystem.Documents { public const string Type = "FileSystem"; - public async Task GetDocument(Project project, string documentName, string version) + public async Task GetDocumentAsync(Project project, string documentName, string version) { var projectFolder = project.GetFileSystemPath(); var path = Path.Combine(projectFolder, documentName); @@ -41,7 +41,7 @@ namespace Volo.Docs.FileSystem.Documents }; } - public Task> GetVersions(Project project) + public Task> GetVersionsAsync(Project project) { return Task.FromResult(new List()); } diff --git a/modules/docs/src/Volo.Docs.Domain/Volo/Docs/GitHub/Documents/GithubDocumentStore.cs b/modules/docs/src/Volo.Docs.Domain/Volo/Docs/GitHub/Documents/GithubDocumentStore.cs index c9d8b63dd9..fbfb02961b 100644 --- a/modules/docs/src/Volo.Docs.Domain/Volo/Docs/GitHub/Documents/GithubDocumentStore.cs +++ b/modules/docs/src/Volo.Docs.Domain/Volo/Docs/GitHub/Documents/GithubDocumentStore.cs @@ -22,7 +22,7 @@ namespace Volo.Docs.GitHub.Documents { public const string Type = "GitHub"; - public virtual async Task GetDocument(Project project, string documentName, string version) + public virtual async Task GetDocumentAsync(Project project, string documentName, string version) { var token = project.GetGitHubAccessTokenOrNull(); var rootUrl = project.GetGitHubUrl(version); @@ -56,7 +56,7 @@ namespace Volo.Docs.GitHub.Documents }; } - public async Task> GetVersions(Project project) + public async Task> GetVersionsAsync(Project project) { List versions; try @@ -148,12 +148,15 @@ namespace Volo.Docs.GitHub.Documents { try { + Logger.LogInformation("Downloading content from Github (DownloadWebContentAsStringAsync): " + rawUrl); + using (var webClient = new WebClient()) { if (!token.IsNullOrWhiteSpace()) { webClient.Headers.Add("Authorization", "token " + token); } + webClient.Headers.Add("User-Agent", userAgent ?? ""); return await webClient.DownloadStringTaskAsync(new Uri(rawUrl)); @@ -171,6 +174,8 @@ namespace Volo.Docs.GitHub.Documents { try { + Logger.LogInformation("Downloading content from Github (DownloadWebContentAsByteArrayAsync): " + rawUrl); + using (var webClient = new WebClient()) { if (!token.IsNullOrWhiteSpace()) @@ -219,8 +224,7 @@ namespace Volo.Docs.GitHub.Documents { Logger.LogWarning(ex.Message); } - - + return contributors; }