diff --git a/.editorconfig b/.editorconfig index 458384a0d1..2a106c13b0 100644 --- a/.editorconfig +++ b/.editorconfig @@ -10,6 +10,8 @@ indent_size = 4 # CA1305 requires using a FormatProvider with int.Parse and string.Format. dotnet_diagnostic.CA1305.severity = none dotnet_diagnostic.CA1710.severity = warning +# TODO: Implement LoggerMessage pattern to remove the CA1848 exception. +dotnet_diagnostic.CA1848.severity = none # CS1591 is our only exception to EnforceCodeStyleInBuild+GenerateDocumentationFile. dotnet_diagnostic.CS1591.severity = none # IDE0005 requires both EnforceCodeStyleInBuild and GenerateDocumentationFile set to true. diff --git a/Backend.Tests/Controllers/MergeControllerTests.cs b/Backend.Tests/Controllers/MergeControllerTests.cs index fab861abda..459313feef 100644 --- a/Backend.Tests/Controllers/MergeControllerTests.cs +++ b/Backend.Tests/Controllers/MergeControllerTests.cs @@ -54,16 +54,16 @@ public void BlacklistAddTest() // Add two Lists of wordIds. _ = _mergeController.BlacklistAdd(ProjId, wordIdsA).Result; - var result = _mergeBlacklistRepo.GetAll(ProjId).Result; + var result = _mergeBlacklistRepo.GetAllEntries(ProjId).Result; Assert.That(result, Has.Count.EqualTo(1)); Assert.That(result.First().WordIds, Is.EqualTo(wordIdsA)); _ = _mergeController.BlacklistAdd(ProjId, wordIdsB).Result; - result = _mergeBlacklistRepo.GetAll(ProjId).Result; + result = _mergeBlacklistRepo.GetAllEntries(ProjId).Result; Assert.That(result, Has.Count.EqualTo(2)); // Add a List of wordIds that contains both previous lists. _ = _mergeController.BlacklistAdd(ProjId, wordIdsC).Result; - result = _mergeBlacklistRepo.GetAll(ProjId).Result; + result = _mergeBlacklistRepo.GetAllEntries(ProjId).Result; Assert.That(result, Has.Count.EqualTo(1)); Assert.That(result.First().WordIds, Is.EqualTo(wordIdsC)); } diff --git a/Backend.Tests/Mocks/BannerRepositoryMock.cs b/Backend.Tests/Mocks/BannerRepositoryMock.cs index 4c7d1d6b6f..296cba5bde 100644 --- a/Backend.Tests/Mocks/BannerRepositoryMock.cs +++ b/Backend.Tests/Mocks/BannerRepositoryMock.cs @@ -17,7 +17,7 @@ public BannerRepositoryMock() _banners[BannerType.Login] = new Banner { Type = BannerType.Login }; } - public Task Get(BannerType type) + public Task GetBanner(BannerType type) { return Task.FromResult(_banners[type]); } diff --git a/Backend.Tests/Mocks/MergeBlacklistRepositoryMock.cs b/Backend.Tests/Mocks/MergeBlacklistRepositoryMock.cs index c1291f39b5..1e43269ba7 100644 --- a/Backend.Tests/Mocks/MergeBlacklistRepositoryMock.cs +++ b/Backend.Tests/Mocks/MergeBlacklistRepositoryMock.cs @@ -17,7 +17,7 @@ public MergeBlacklistRepositoryMock() _mergeBlacklist = new List(); } - public Task> GetAll(string projectId, string? userId = null) + public Task> GetAllEntries(string projectId, string? userId = null) { var cloneList = _mergeBlacklist.Select(e => e.Clone()).ToList(); var enumerable = userId is null ? @@ -26,7 +26,7 @@ public Task> GetAll(string projectId, string? userId = return Task.FromResult(enumerable.ToList()); } - public Task Get(string projectId, string entryId) + public Task GetEntry(string projectId, string entryId) { try { @@ -46,7 +46,7 @@ public Task Create(MergeBlacklistEntry blacklistEntry) return Task.FromResult(blacklistEntry.Clone()); } - public Task DeleteAll(string projectId) + public Task DeleteAllEntries(string projectId) { _mergeBlacklist.Clear(); return Task.FromResult(true); diff --git a/Backend.Tests/Services/MergeServiceTests.cs b/Backend.Tests/Services/MergeServiceTests.cs index 38aa086355..ea6ae7b314 100644 --- a/Backend.Tests/Services/MergeServiceTests.cs +++ b/Backend.Tests/Services/MergeServiceTests.cs @@ -199,10 +199,10 @@ public void UndoMergeMultiChildTest() [Test] public void AddMergeToBlacklistTest() { - _ = _mergeBlacklistRepo.DeleteAll(ProjId).Result; + _ = _mergeBlacklistRepo.DeleteAllEntries(ProjId).Result; var wordIds = new List { "1", "2" }; _ = _mergeService.AddToMergeBlacklist(ProjId, UserId, wordIds).Result; - var blacklist = _mergeBlacklistRepo.GetAll(ProjId).Result; + var blacklist = _mergeBlacklistRepo.GetAllEntries(ProjId).Result; Assert.That(blacklist, Has.Count.EqualTo(1)); var expectedEntry = new MergeBlacklistEntry { ProjectId = ProjId, UserId = UserId, WordIds = wordIds }; Assert.That(expectedEntry.ContentEquals(blacklist.First())); @@ -211,7 +211,7 @@ public void AddMergeToBlacklistTest() [Test] public void AddMergeToBlacklistErrorTest() { - _ = _mergeBlacklistRepo.DeleteAll(ProjId).Result; + _ = _mergeBlacklistRepo.DeleteAllEntries(ProjId).Result; var wordIds0 = new List(); var wordIds1 = new List { "1" }; Assert.ThrowsAsync( @@ -223,7 +223,7 @@ public void AddMergeToBlacklistErrorTest() [Test] public void IsInMergeBlacklistTest() { - _ = _mergeBlacklistRepo.DeleteAll(ProjId).Result; + _ = _mergeBlacklistRepo.DeleteAllEntries(ProjId).Result; var wordIds = new List { "1", "2", "3" }; var subWordIds = new List { "3", "2" }; @@ -235,7 +235,7 @@ public void IsInMergeBlacklistTest() [Test] public void IsInMergeBlacklistErrorTest() { - _ = _mergeBlacklistRepo.DeleteAll(ProjId).Result; + _ = _mergeBlacklistRepo.DeleteAllEntries(ProjId).Result; var wordIds0 = new List(); var wordIds1 = new List { "1" }; Assert.ThrowsAsync( @@ -265,7 +265,7 @@ public void UpdateMergeBlacklistTest() _ = _mergeBlacklistRepo.Create(entryA); _ = _mergeBlacklistRepo.Create(entryB); - var oldBlacklist = _mergeBlacklistRepo.GetAll(ProjId).Result; + var oldBlacklist = _mergeBlacklistRepo.GetAllEntries(ProjId).Result; Assert.That(oldBlacklist, Has.Count.EqualTo(2)); // Make sure all wordIds are in the frontier EXCEPT 1. @@ -282,7 +282,7 @@ public void UpdateMergeBlacklistTest() Assert.That(updatedEntriesCount, Is.EqualTo(2)); // The only blacklistEntry with at least two ids in the frontier is A. - var newBlacklist = _mergeBlacklistRepo.GetAll(ProjId).Result; + var newBlacklist = _mergeBlacklistRepo.GetAllEntries(ProjId).Result; Assert.That(newBlacklist, Has.Count.EqualTo(1)); Assert.AreEqual(newBlacklist.First().WordIds, new List { "2", "3" }); } diff --git a/Backend/BackendFramework.csproj b/Backend/BackendFramework.csproj index 376ef6cc7c..9d21971413 100644 --- a/Backend/BackendFramework.csproj +++ b/Backend/BackendFramework.csproj @@ -4,10 +4,10 @@ 10.0 enable true - Minimum + Recommended true true - $(NoWarn);CA1305;CA1816;CS1591 + $(NoWarn);CA1305;CA1816;CA1848;CS1591 diff --git a/Backend/Controllers/BannerController.cs b/Backend/Controllers/BannerController.cs index a02521a270..dc05ac898b 100644 --- a/Backend/Controllers/BannerController.cs +++ b/Backend/Controllers/BannerController.cs @@ -30,7 +30,7 @@ public BannerController(IBannerRepository bannerRepo, IPermissionService permiss [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(SiteBanner))] public async Task GetBanner(BannerType type) { - var banner = await _bannerRepo.Get(type); + var banner = await _bannerRepo.GetBanner(type); return Ok(new SiteBanner { Type = type, Text = banner.Text }); } diff --git a/Backend/Interfaces/IBannerRepository.cs b/Backend/Interfaces/IBannerRepository.cs index 9281bdf5ba..59cf0da8d9 100644 --- a/Backend/Interfaces/IBannerRepository.cs +++ b/Backend/Interfaces/IBannerRepository.cs @@ -6,7 +6,7 @@ namespace BackendFramework.Interfaces { public interface IBannerRepository { - Task Get(BannerType type); + Task GetBanner(BannerType type); Task Update(SiteBanner banner); } } diff --git a/Backend/Interfaces/IMergeBlacklistRepository.cs b/Backend/Interfaces/IMergeBlacklistRepository.cs index 55a0468cab..4696b1793d 100644 --- a/Backend/Interfaces/IMergeBlacklistRepository.cs +++ b/Backend/Interfaces/IMergeBlacklistRepository.cs @@ -7,11 +7,11 @@ namespace BackendFramework.Interfaces { public interface IMergeBlacklistRepository { - Task> GetAll(string projectId, string? userId = null); - Task Get(string projectId, string entryId); + Task> GetAllEntries(string projectId, string? userId = null); + Task GetEntry(string projectId, string entryId); Task Create(MergeBlacklistEntry blacklistEntry); Task Delete(string projectId, string entryId); - Task DeleteAll(string projectId); + Task DeleteAllEntries(string projectId); Task Update(MergeBlacklistEntry blacklistEntry); } } diff --git a/Backend/Models/SemanticDomain.cs b/Backend/Models/SemanticDomain.cs index c850b5178e..fc076dae2f 100644 --- a/Backend/Models/SemanticDomain.cs +++ b/Backend/Models/SemanticDomain.cs @@ -16,7 +16,9 @@ public class SemanticDomain public string MongoId { get; set; } [Required] [BsonElement("guid")] +#pragma warning disable CA1720 public string Guid { get; set; } +#pragma warning restore CA1720 [Required] [BsonElement("name")] public string Name { get; set; } @@ -145,7 +147,9 @@ public class SemanticDomainTreeNode public string Lang { get; set; } [Required] [BsonElement("guid")] +#pragma warning disable CA1720 public string Guid { get; set; } +#pragma warning restore CA1720 [Required] [BsonElement("name")] public string Name { get; set; } diff --git a/Backend/Models/Sense.cs b/Backend/Models/Sense.cs index fba7c5947d..5f7e617dcd 100644 --- a/Backend/Models/Sense.cs +++ b/Backend/Models/Sense.cs @@ -16,7 +16,9 @@ public class Sense /// [Required] [BsonElement("guid")] +#pragma warning disable CA1720 public Guid Guid { get; set; } +#pragma warning restore CA1720 [Required] [BsonElement("accessibility")] diff --git a/Backend/Models/UserEdit.cs b/Backend/Models/UserEdit.cs index 34543eb796..3f54a996aa 100644 --- a/Backend/Models/UserEdit.cs +++ b/Backend/Models/UserEdit.cs @@ -115,7 +115,9 @@ public class Edit { [Required] [BsonElement("guid")] +#pragma warning disable CA1720 public Guid Guid { get; set; } +#pragma warning restore CA1720 /// Integer representation of enum [Required] diff --git a/Backend/Models/Word.cs b/Backend/Models/Word.cs index 4c4ee3a680..69640efe80 100644 --- a/Backend/Models/Word.cs +++ b/Backend/Models/Word.cs @@ -21,7 +21,9 @@ public class Word /// [Required] [BsonElement("guid")] +#pragma warning disable CA1720 public Guid Guid { get; set; } +#pragma warning restore CA1720 [Required] [BsonElement("vernacular")] diff --git a/Backend/Repositories/BannerRepository.cs b/Backend/Repositories/BannerRepository.cs index 731e9568cc..b9a4b11ea1 100644 --- a/Backend/Repositories/BannerRepository.cs +++ b/Backend/Repositories/BannerRepository.cs @@ -26,7 +26,7 @@ private async Task CreateEmptyBanner(BannerType type) return emptyBanner; } - public async Task Get(BannerType type) + public async Task GetBanner(BannerType type) { var bannerList = await _bannerDatabase.Banners.FindAsync(x => x.Type == type); try @@ -41,7 +41,7 @@ public async Task Get(BannerType type) public async Task Update(SiteBanner banner) { - var existingBanner = await Get(banner.Type); + var existingBanner = await GetBanner(banner.Type); var filter = Builders.Filter.Eq(x => x.Id, existingBanner.Id); var updateDef = Builders.Update .Set(x => x.Type, banner.Type) diff --git a/Backend/Repositories/MergeBlacklistRepository.cs b/Backend/Repositories/MergeBlacklistRepository.cs index 124d617944..3099485bff 100644 --- a/Backend/Repositories/MergeBlacklistRepository.cs +++ b/Backend/Repositories/MergeBlacklistRepository.cs @@ -21,7 +21,7 @@ public MergeBlacklistRepository(IMergeBlacklistContext collectionSettings) } /// Finds all s for specified . - public async Task> GetAll(string projectId, string? userId = null) + public async Task> GetAllEntries(string projectId, string? userId = null) { var listFind = userId is null ? _mergeBlacklistDatabase.MergeBlacklist.Find(e => e.ProjectId == projectId) : @@ -31,14 +31,14 @@ public async Task> GetAll(string projectId, string? us /// Removes all s for specified . /// A bool: success of operation. - public async Task DeleteAll(string projectId) + public async Task DeleteAllEntries(string projectId) { var deleted = await _mergeBlacklistDatabase.MergeBlacklist.DeleteManyAsync(u => u.ProjectId == projectId); return deleted.DeletedCount != 0; } /// Finds specified for specified . - public async Task Get(string projectId, string entryId) + public async Task GetEntry(string projectId, string entryId) { var filterDef = new FilterDefinitionBuilder(); var filter = filterDef.And( diff --git a/Backend/Services/MergeService.cs b/Backend/Services/MergeService.cs index 0dbf20b6a7..b70758b2b3 100644 --- a/Backend/Services/MergeService.cs +++ b/Backend/Services/MergeService.cs @@ -125,7 +125,7 @@ public async Task AddToMergeBlacklist( throw new InvalidBlacklistEntryException("Cannot blacklist a list of fewer than 2 wordIds."); } // When we switch from individual to common blacklist, the userId argument here should be removed. - var blacklist = await _mergeBlacklistRepo.GetAll(projectId, userId); + var blacklist = await _mergeBlacklistRepo.GetAllEntries(projectId, userId); foreach (var entry in blacklist) { if (entry.WordIds.All(wordIds.Contains)) @@ -146,7 +146,7 @@ public async Task IsInMergeBlacklist(string projectId, List wordId { throw new InvalidBlacklistEntryException("Cannot blacklist a list of fewer than 2 wordIds."); } - var blacklist = await _mergeBlacklistRepo.GetAll(projectId, userId); + var blacklist = await _mergeBlacklistRepo.GetAllEntries(projectId, userId); foreach (var entry in blacklist) { if (wordIds.All(entry.WordIds.Contains)) @@ -165,7 +165,7 @@ public async Task IsInMergeBlacklist(string projectId, List wordId /// Number of s updated. public async Task UpdateMergeBlacklist(string projectId) { - var oldBlacklist = await _mergeBlacklistRepo.GetAll(projectId); + var oldBlacklist = await _mergeBlacklistRepo.GetAllEntries(projectId); if (oldBlacklist.Count == 0) { return 0;