Skip to content

Commit bf6bc67

Browse files
jimmylewisjimmylewis
committed
PR feedback and cleanup
- Add ConfigureAwait(false) to the files changed in this PR - Remove unnecessary using in UnpkgCatalogTest - Remove unused sample string CdnjsProviderTest
1 parent e0a18ac commit bf6bc67

File tree

6 files changed

+27
-47
lines changed

6 files changed

+27
-47
lines changed

‎src/LibraryManager/CacheService/CacheService.cs

+9-9
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ private async Task DownloadToFileAsync(string url, string fileName, int attempts
6868
{
6969
try
7070
{
71-
using (Stream libraryStream = await _requestHandler.GetStreamAsync(url, cancellationToken))
71+
using (Stream libraryStream = await _requestHandler.GetStreamAsync(url, cancellationToken).ConfigureAwait(false))
7272
{
73-
await FileHelpers.SafeWriteToFileAsync(fileName, libraryStream, cancellationToken);
73+
await FileHelpers.SafeWriteToFileAsync(fileName, libraryStream, cancellationToken).ConfigureAwait(false);
7474
break;
7575
}
7676
}
@@ -83,7 +83,7 @@ private async Task DownloadToFileAsync(string url, string fileName, int attempts
8383
}
8484
}
8585

86-
await Task.Delay(200);
86+
await Task.Delay(200).ConfigureAwait(false);
8787
}
8888
}
8989

@@ -104,14 +104,14 @@ private async Task<string> GetResourceAsync(string url, string localFile, int ex
104104
/// </summary>
105105
public async Task RefreshCacheAsync(IEnumerable<CacheFileMetadata> librariesCacheMetadata, ILogger logger, CancellationToken cancellationToken)
106106
{
107-
await ParallelUtility.ForEachAsync(DownloadFileIfNecessaryAsync, MaxConcurrentDownloads, librariesCacheMetadata, cancellationToken);
107+
await ParallelUtility.ForEachAsync(DownloadFileIfNecessaryAsync, MaxConcurrentDownloads, librariesCacheMetadata, cancellationToken).ConfigureAwait(false);
108108

109109
async Task DownloadFileIfNecessaryAsync(CacheFileMetadata metadata)
110110
{
111111
if (!File.Exists(metadata.DestinationPath))
112112
{
113113
logger.Log(string.Format(Resources.Text.DownloadingFile, metadata.Source), LogLevel.Operation);
114-
await DownloadToFileAsync(metadata.Source, metadata.DestinationPath, attempts: 5, cancellationToken: cancellationToken);
114+
await DownloadToFileAsync(metadata.Source, metadata.DestinationPath, attempts: 5, cancellationToken: cancellationToken).ConfigureAwait(false);
115115
}
116116
}
117117
}
@@ -122,14 +122,14 @@ public async Task<string> GetContentsFromUriWithCacheFallbackAsync(string url, s
122122
string contents;
123123
try
124124
{
125-
contents = await GetResourceAsync(url, cacheFile, DefaultCacheExpiresAfterDays, cancellationToken);
125+
contents = await GetResourceAsync(url, cacheFile, DefaultCacheExpiresAfterDays, cancellationToken).ConfigureAwait(false);
126126
}
127127
catch (ResourceDownloadException)
128128
{
129129
// TODO: Log telemetry
130130
if (File.Exists(cacheFile))
131131
{
132-
contents = await FileHelpers.ReadFileAsTextAsync(cacheFile, cancellationToken);
132+
contents = await FileHelpers.ReadFileAsTextAsync(cacheFile, cancellationToken).ConfigureAwait(false);
133133
}
134134
else
135135
{
@@ -146,11 +146,11 @@ public async Task<string> GetContentsFromCachedFileWithWebRequestFallbackAsync(s
146146
string contents;
147147
if (File.Exists(cacheFile))
148148
{
149-
contents = await FileHelpers.ReadFileAsTextAsync(cacheFile, cancellationToken);
149+
contents = await FileHelpers.ReadFileAsTextAsync(cacheFile, cancellationToken).ConfigureAwait(false);
150150
}
151151
else
152152
{
153-
contents = await GetResourceAsync(url, cacheFile, DefaultCacheExpiresAfterDays, cancellationToken);
153+
contents = await GetResourceAsync(url, cacheFile, DefaultCacheExpiresAfterDays, cancellationToken).ConfigureAwait(false);
154154
}
155155

156156
return contents;

‎src/LibraryManager/Providers/Cdnjs/CdnjsCatalog.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ private async Task<bool> EnsureCatalogAsync(CancellationToken cancellationToken)
245245

246246
try
247247
{
248-
string json = await _cacheService.GetContentsFromUriWithCacheFallbackAsync(CatalogUrl, _cacheFile, cancellationToken);
248+
string json = await _cacheService.GetContentsFromUriWithCacheFallbackAsync(CatalogUrl, _cacheFile, cancellationToken).ConfigureAwait(false);
249249

250250
if (string.IsNullOrWhiteSpace(json))
251251
{
@@ -278,7 +278,7 @@ private async Task<IEnumerable<Asset>> GetAssetsAsync(string groupName, Cancella
278278

279279
try
280280
{
281-
string json = await _cacheService.GetContentsFromUriWithCacheFallbackAsync(url, localFile, cancellationToken);
281+
string json = await _cacheService.GetContentsFromUriWithCacheFallbackAsync(url, localFile, cancellationToken).ConfigureAwait(false);
282282

283283
if (!string.IsNullOrEmpty(json))
284284
{

‎src/LibraryManager/Providers/Unpkg/UnpkgCatalog.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public async Task<string> GetLatestVersion(string libraryName, bool includePreRe
5252

5353
string latestJson = await _cacheService.GetContentsFromUriWithCacheFallbackAsync(latestLibraryVersionUrl,
5454
latestCacheFile,
55-
cancellationToken);
55+
cancellationToken).ConfigureAwait(false);
5656

5757
var packageObject = (JObject)JsonConvert.DeserializeObject(latestJson);
5858

@@ -80,13 +80,13 @@ public async Task<ILibrary> GetLibraryAsync(string libraryName, string version,
8080
string libraryId = _libraryNamingScheme.GetLibraryId(libraryName, version);
8181
if (string.Equals(version, LatestVersionTag, StringComparison.Ordinal))
8282
{
83-
string latestVersion = await GetLatestVersion(libraryId, includePreReleases: false, cancellationToken);
83+
string latestVersion = await GetLatestVersion(libraryId, includePreReleases: false, cancellationToken).ConfigureAwait(false);
8484
libraryId = _libraryNamingScheme.GetLibraryId(libraryName, latestVersion);
8585
}
8686

8787
try
8888
{
89-
IEnumerable<string> libraryFiles = await GetLibraryFilesAsync(libraryName, version, cancellationToken);
89+
IEnumerable<string> libraryFiles = await GetLibraryFilesAsync(libraryName, version, cancellationToken).ConfigureAwait(false);
9090

9191
return new UnpkgLibrary
9292
{
@@ -111,7 +111,7 @@ private async Task<IEnumerable<string>> GetLibraryFilesAsync(string libraryName,
111111

112112
string fileList = await _cacheService.GetContentsFromCachedFileWithWebRequestFallbackAsync(libraryFileListCacheFile,
113113
libraryFileListUrl,
114-
cancellationToken);
114+
cancellationToken).ConfigureAwait(false);
115115

116116
var fileListObject = (JObject)JsonConvert.DeserializeObject(fileList);
117117

@@ -212,7 +212,7 @@ public async Task<CompletionSet> GetLibraryCompletionSetAsync(string libraryName
212212
// library name completion
213213
if (caretPosition < name.Length + 1)
214214
{
215-
IEnumerable<NpmPackageInfo> packages = await _packageSearch.GetPackageNamesAsync(libraryNameStart, CancellationToken.None);
215+
IEnumerable<NpmPackageInfo> packages = await _packageSearch.GetPackageNamesAsync(libraryNameStart, CancellationToken.None).ConfigureAwait(false);
216216

217217
foreach (NpmPackageInfo packageInfo in packages)
218218
{
@@ -234,7 +234,7 @@ public async Task<CompletionSet> GetLibraryCompletionSetAsync(string libraryName
234234
completionSet.Start = name.Length + 1;
235235
completionSet.Length = version.Length;
236236

237-
NpmPackageInfo npmPackageInfo = await _packageInfoFactory.GetPackageInfoAsync(name, CancellationToken.None);
237+
NpmPackageInfo npmPackageInfo = await _packageInfoFactory.GetPackageInfoAsync(name, CancellationToken.None).ConfigureAwait(false);
238238

239239
IList<SemanticVersion> versions = npmPackageInfo.Versions.OrderByDescending(v => v).ToList();
240240

@@ -274,7 +274,7 @@ public async Task<IReadOnlyList<ILibraryGroup>> SearchAsync(string term, int max
274274

275275
try
276276
{
277-
IEnumerable<NpmPackageInfo> packages = await _packageSearch.GetPackageNamesAsync(term, CancellationToken.None);
277+
IEnumerable<NpmPackageInfo> packages = await _packageSearch.GetPackageNamesAsync(term, CancellationToken.None).ConfigureAwait(false);
278278
IEnumerable<string> packageNames = packages.Select(p => p.Name);
279279
libraryGroups = packageNames.Select(packageName => new UnpkgLibraryGroup(_packageInfoFactory, packageName)).ToList<ILibraryGroup>();
280280
}

‎src/LibraryManager/Providers/jsDelivr/JsDelivrCatalog.cs

+9-9
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public async Task<string> GetLatestVersion(string libraryId, bool includePreRele
6565

6666
string latestVersionContent = await _cacheService.GetContentsFromUriWithCacheFallbackAsync(latestLibraryVersionUrl,
6767
latestLibraryVersionCacheFile,
68-
cancellationToken);
68+
cancellationToken).ConfigureAwait(false);
6969

7070
var packageObject = (JObject)JsonConvert.DeserializeObject(latestVersionContent);
7171
if (packageObject != null)
@@ -93,13 +93,13 @@ public async Task<ILibrary> GetLibraryAsync(string name, string version, Cancell
9393
string libraryId = _libraryNamingScheme.GetLibraryId(name, version);
9494
if (string.Equals(version, LatestVersionTag, StringComparison.Ordinal))
9595
{
96-
string latestVersion = await GetLatestVersion(libraryId, includePreReleases: false, cancellationToken);
96+
string latestVersion = await GetLatestVersion(libraryId, includePreReleases: false, cancellationToken).ConfigureAwait(false);
9797
libraryId = _libraryNamingScheme.GetLibraryId(name, latestVersion);
9898
}
9999

100100
try
101101
{
102-
IEnumerable<string> libraryFiles = await GetLibraryFilesAsync(libraryId, cancellationToken);
102+
IEnumerable<string> libraryFiles = await GetLibraryFilesAsync(libraryId, cancellationToken).ConfigureAwait(false);
103103
return new JsDelivrLibrary { Version = version, Files = libraryFiles.ToDictionary(k => k, b => false), Name = name, ProviderId = _providerId };
104104
}
105105
catch (Exception)
@@ -117,7 +117,7 @@ private async Task<IEnumerable<string>> GetLibraryFilesAsync(string libraryId, C
117117
string libraryFileListUrl = string.Format(IsGitHub(libraryId) ? LibraryFileListUrlFormatGH : LibraryFileListUrlFormat, libraryId);
118118
string fileListJson = await _cacheService.GetContentsFromCachedFileWithWebRequestFallbackAsync(libraryFileListCacheFile,
119119
libraryFileListUrl,
120-
cancellationToken);
120+
cancellationToken).ConfigureAwait(false);
121121

122122
if ((JObject)JsonConvert.DeserializeObject(fileListJson) is var fileListObject)
123123
{
@@ -217,7 +217,7 @@ public async Task<CompletionSet> GetLibraryCompletionSetAsync(string libraryName
217217
return completionSet;
218218
}
219219

220-
IEnumerable<NpmPackageInfo> packages = await _packageSearch.GetPackageNamesAsync(libraryNameStart, CancellationToken.None);
220+
IEnumerable<NpmPackageInfo> packages = await _packageSearch.GetPackageNamesAsync(libraryNameStart, CancellationToken.None).ConfigureAwait(false);
221221

222222
foreach (NpmPackageInfo package in packages)
223223
{
@@ -241,12 +241,12 @@ public async Task<CompletionSet> GetLibraryCompletionSetAsync(string libraryName
241241

242242
if (IsGitHub(name))
243243
{
244-
versions = await GetGithubLibraryVersionsAsync(name, CancellationToken.None);
244+
versions = await GetGithubLibraryVersionsAsync(name, CancellationToken.None).ConfigureAwait(false);
245245
}
246246
else
247247
{
248248
var libGroup = new JsDelivrLibraryGroup(_packageInfoFactory, name);
249-
versions = await libGroup.GetLibraryVersions(CancellationToken.None);
249+
versions = await libGroup.GetLibraryVersions(CancellationToken.None).ConfigureAwait(false);
250250
}
251251

252252
foreach (string v in versions)
@@ -289,7 +289,7 @@ public async Task<IReadOnlyList<ILibraryGroup>> SearchAsync(string term, int max
289289

290290
try
291291
{
292-
IEnumerable<NpmPackageInfo> packages = await _packageSearch.GetPackageNamesAsync(term, CancellationToken.None);
292+
IEnumerable<NpmPackageInfo> packages = await _packageSearch.GetPackageNamesAsync(term, CancellationToken.None).ConfigureAwait(false);
293293
IEnumerable<string> packageNames = packages.Select(p => p.Name);
294294
libraryGroups = packageNames.Select(packageName => new JsDelivrLibraryGroup(_packageInfoFactory, packageName)).ToList<ILibraryGroup>();
295295
}
@@ -306,7 +306,7 @@ private async Task<IEnumerable<string>> GetGithubLibraryVersionsAsync(string nam
306306
var versions = new List<string>();
307307
string versionsCacheFile = Path.Combine(_cacheFolder, name, "github-versions-cache.json");
308308
string versionsUrl = string.Format(LatestLibraryVersionUrlGH, name);
309-
string versionsJson = await _cacheService.GetContentsFromUriWithCacheFallbackAsync(versionsUrl, versionsCacheFile, cancellationToken);
309+
string versionsJson = await _cacheService.GetContentsFromUriWithCacheFallbackAsync(versionsUrl, versionsCacheFile, cancellationToken).ConfigureAwait(false);
310310

311311
var versionsObject = (JObject)JsonConvert.DeserializeObject(versionsJson);
312312
var versionsArray = versionsObject["versions"] as JArray;

‎test/LibraryManager.Test/Providers/Cdnjs/CdnjsProviderTest.cs

-19
Original file line numberDiff line numberDiff line change
@@ -177,24 +177,5 @@ public void GetCatalog()
177177

178178
Assert.IsNotNull(catalog);
179179
}
180-
181-
private string _doc = $@"{{
182-
""{ManifestConstants.Version}"": ""1.0"",
183-
""{ManifestConstants.Libraries}"": [
184-
{{
185-
""{ManifestConstants.Provider}"": ""cdnjs"",
186-
""{ManifestConstants.Library}"": ""[email protected]"",
187-
""{ManifestConstants.Destination}"": ""lib"",
188-
""{ManifestConstants.Files}"": [ ""jquery.js"", ""jquery.min.js"" ]
189-
}},
190-
{{
191-
""{ManifestConstants.Provider}"": ""cdnjs"",
192-
""{ManifestConstants.Library}"": ""[email protected]"",
193-
""{ManifestConstants.Destination}"": ""lib"",
194-
""{ManifestConstants.Files}"": [ ""knockout-min.js"" ]
195-
}}
196-
]
197-
}}
198-
";
199180
}
200181
}

‎test/LibraryManager.Test/Providers/Unpkg/UnpkgCatalogTest.cs

-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
using System.Collections.Generic;
66
using System.IO;
77
using System.Linq;
8-
using System.Security.Cryptography.X509Certificates;
98
using System.Threading;
109
using System.Threading.Tasks;
1110
using Microsoft.VisualStudio.TestTools.UnitTesting;

0 commit comments

Comments
 (0)