Skip to content
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

OSOE-867: Addressing analyzer warnings #143

Merged
merged 5 commits into from
Jun 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions Lombiq.TrainingDemo/Controllers/ApiController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ namespace Lombiq.TrainingDemo.Controllers;
// endpoints should most of the time use the "Api" authentication scheme: This is not the same that standard users are
// authenticated with (via cookies).
[Authorize(AuthenticationSchemes = "Api"), IgnoreAntiforgeryToken, AllowAnonymous]
[System.Diagnostics.CodeAnalysis.SuppressMessage(
"Major Code Smell",
"S6961:API Controllers should derive from ControllerBase instead of Controller",
Justification = "Can't be changed due to line 62. Will be applicable after an Orchard upgrade due to " +
"https://github.com/OrchardCMS/OrchardCore/issues/16186 being fixed.")]
public class ApiController : Controller
{
private readonly IAuthorizationService _authorizationService;
Expand All @@ -46,6 +51,7 @@ public ApiController(IAuthorizationService authorizationService, IContentManager
// authorize with a client ID and secret of an OpenID app set up from the Orchard admin. For more info see:
// https://docs.orchardcore.net/en/latest/docs/reference/modules/OpenId/. If you just want to quickly test this API
// then remove the Authorize attribute above.
[HttpGet]
public async Task<IActionResult> Get(string contentItemId)
{
// Authorization is important in API endpoints as well of course. We're re-using the previously created
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ public class CrossTenantServicesController : Controller
[Route("CrossTenantServices")]
public async Task<string> Index(string contentItemId)
{
// If ModelState is not in a valid state we should abort the action and return null.
if (!ModelState.IsValid) return null;

// Even if you don't create tenants, there will still be a single tenant in an Orchard app, the Default tenant.
// For all other tenants you create you can provide the technical name.

Expand Down
5 changes: 2 additions & 3 deletions Lombiq.TrainingDemo/Controllers/DatabaseStorageController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,7 @@ public async Task<IActionResult> JKRosenzweigBooks()
// NEXT STATION: Models/PersonPart.cs

private static Book[] CreateDemoBooks() =>
new[]
{
[
new Book
{
CoverPhotoUrl = "/Lombiq.TrainingDemo/images/HarryPotter.jpg",
Expand All @@ -128,5 +127,5 @@ private static Book[] CreateDemoBooks() =>
Description = "The nation of Panay, formed from a post-apocalyptic North America, is a country " +
"that consists of a wealthy Capitol region surrounded by 12 poorer districts.",
},
};
];
}
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public async Task<string> ReadFileFromMediaFolder()
[HttpPost, ActionName(nameof(UploadFileToMedia)), ValidateAntiForgeryToken]
public async Task<ActionResult> UploadFileToMediaPost(IFormFile file)
{
if (file == null) return BadRequest();
if (!ModelState.IsValid || file == null) return BadRequest();

// You can use the Combine method to combine paths which is pretty much equivalent to the built-in method.
var mediaFilePath = _mediaFileStore.Combine(UploadedFileFolderRelativePath, file.FileName);
Expand Down
7 changes: 3 additions & 4 deletions Lombiq.TrainingDemo/Permissions/DemoSettingsPermissions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,11 @@ public Task<IEnumerable<Permission>> GetPermissionsAsync() =>
.AsEnumerable());

public IEnumerable<PermissionStereotype> GetDefaultStereotypes() =>
new[]
{
[
new PermissionStereotype
{
Name = "Administrator",
Permissions = new[] { ManageDemoSettings },
Permissions = [ManageDemoSettings],
},
};
];
}
11 changes: 5 additions & 6 deletions Lombiq.TrainingDemo/Permissions/PersonPermissions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public class PersonPermissions : IPermissionProvider
public static readonly Permission AccessPersonListDashboard = new(
nameof(AccessPersonListDashboard),
"Access the Person List dashboard",
new[] { ManagePersons });
[ManagePersons]);

public Task<IEnumerable<Permission>> GetPermissionsAsync() =>
Task.FromResult(new[]
Expand All @@ -34,21 +34,20 @@ public Task<IEnumerable<Permission>> GetPermissionsAsync() =>

public IEnumerable<PermissionStereotype> GetDefaultStereotypes() =>
// Giving some defaults: which roles should possess which permissions.
new[]
{
[
new PermissionStereotype
{
// Administrators will have all the permissions by default.
Name = "Administrator",
// Since AccessPersonListDashboard is implied by EditPersonList we don't have to list the former here.
Permissions = new[] { ManagePersons },
Permissions = [ManagePersons],
},
new PermissionStereotype
{
Name = "Editor",
Permissions = new[] { AccessPersonListDashboard },
Permissions = [AccessPersonListDashboard],
},
};
];
}

// NEXT STATION: Go back to AuthorizationController and find the CanManagePersons action.
5 changes: 5 additions & 0 deletions Lombiq.TrainingDemo/Services/DateTimeCachingService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@
using OrchardCore.Environment.Cache;
using OrchardCore.Modules;
using System;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Threading.Tasks;

namespace Lombiq.TrainingDemo.Services;

[SuppressMessage(
"Usage",
"VSTHRD003:Avoid awaiting foreign Tasks",
Justification = "We need LocalNowAsync to create cachedDate.")]
public class DateTimeCachingService : IDateTimeCachingService
{
public const string MemoryCacheKey = "Lombiq.TrainingDemo.MemoryCache.DateTime";
Expand Down
2 changes: 1 addition & 1 deletion Lombiq.TrainingDemo/ViewModels/PersonPartViewModel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public IEnumerable<ValidationResult> Validate(ValidationContext validationContex

if (BirthDateUtc.HasValue && clock.UtcNow < BirthDateUtc.Value.AddYears(18))
{
yield return new ValidationResult(localizer["The person must be 18 or older."], new[] { nameof(BirthDateUtc) });
yield return new ValidationResult(localizer["The person must be 18 or older."], [nameof(BirthDateUtc)]);
}

// Now go back to the PersonPartDisplayDriver.
Expand Down