OSOE-751: Upgrade to Orchard Core 1.8

Controllers/DatabaseStorageController.cs

@@ -65,7 +65,7 @@ public async Task<IActionResult> CreateBooksPost()
  foreach (var book in CreateDemoBooks())
  {
  // So now you understand what will happen in the background when this service is being called.
- _session.Save(book);
+ await _session.SaveAsync(book);
  }
 
  await _notifier.InformationAsync(H["Books have been created in the database."]);
@@ -102,7 +102,7 @@ public async Task<IActionResult> JKRosenzweigBooks()
 
  // NEXT STATION: Models/PersonPart.cs
 
- private static IEnumerable<Book> CreateDemoBooks() =>
+ private static Book[] CreateDemoBooks() =>
  new[]
  {
  new Book

Controllers/FileManagementController.cs

@@ -90,7 +90,7 @@ public async Task<string> ReadFileFromMediaFolder()
  // If you want to extract the content of the file use a StreamReader to read the stream.
  using var stream = await _mediaFileStore.GetFileStreamAsync(TestFileRelativePath);
  using var streamReader = new StreamReader(stream);
- var content = await streamReader.ReadToEndAsync();
+ var content = await streamReader.ReadToEndAsync(HttpContext.RequestAborted);
 
  return $"File content: {content}";
  }

Controllers/PersonListController.cs

@@ -110,11 +110,8 @@ public async Task<string> FountainOfEternalYouth()
  {
  part.BirthDateUtc = eighteenYearOld;
 
- // False alarm, this is not a loop.
-#pragma warning disable S1643 // Strings should not be concatenated using '+' in a loop
  // You can also edit content fields:
  part.Biography.Text += " I'm young again!";
-#pragma warning restore S1643 // Strings should not be concatenated using '+' in a loop
  });
 
  // If you happen to use reusable/named parts like BagPart (see the docs on it here:
@@ -138,7 +135,7 @@ public async Task<string> FountainOfEternalYouth()
  // IContentManager.GetAsync() instead.
 
  return "People modified: " +
- (oldPeople.Any() ?
+ (oldPeople.Count != 0 ?
  string.Join(", ", oldPeople.Select(person => person.As<PersonPart>().Name)) :
  "Nobody. Did you create people older than 90?");
 

Controllers/SiteSettingsController.cs

@@ -7,8 +7,6 @@
 using Lombiq.TrainingDemo.Models;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Options;
-using OrchardCore.ContentManagement;
-using OrchardCore.Entities;
 using OrchardCore.Settings;
 using System.Threading.Tasks;
 

Drivers/ColorFieldDisplayDriver.cs

@@ -7,15 +7,14 @@
 using OrchardCore.ContentManagement.Metadata.Models;
 using OrchardCore.DisplayManagement.ModelBinding;
 using OrchardCore.DisplayManagement.Views;
-using System;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 
 namespace Lombiq.TrainingDemo.Drivers;
 
 // You shouldn't be surprised - content fields also have display drivers. ContentFieldDisplayDriver is specifically for
 // content fields. Don't forget to register this class with the service provider (see: Startup.cs).
-public class ColorFieldDisplayDriver : ContentFieldDisplayDriver<ColorField>
+public partial class ColorFieldDisplayDriver : ContentFieldDisplayDriver<ColorField>
 {
  private readonly IStringLocalizer T;
 
@@ -75,11 +74,7 @@ public override async Task<IDisplayResult> UpdateAsync(ColorField field, IUpdate
 
  // Also some custom validation for our ColorField hex value.
  var isInvalidHexColor = !string.IsNullOrWhiteSpace(viewModel.Value) &&
- !Regex.IsMatch(
- viewModel.Value,
- "^#([A-Fa-f0-9]{8}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
- RegexOptions.ExplicitCapture,
- TimeSpan.FromSeconds(1));
+ !RegexExpression().IsMatch(viewModel.Value);
 
  if (isInvalidHexColor) updater.ModelState.AddModelError(Prefix, T["The given color is invalid."]);
 
@@ -89,6 +84,9 @@ public override async Task<IDisplayResult> UpdateAsync(ColorField field, IUpdate
 
  return await EditAsync(field, context);
  }
+
+ [GeneratedRegex("^#([A-Fa-f0-9]{8}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", RegexOptions.ExplicitCapture, matchTimeoutMilliseconds: 1000)]
+ private static partial Regex RegexExpression();
 }
 
 // END OF TRAINING SECTION: Content Field development

Lombiq.TrainingDemo.csproj

@@ -1,9 +1,9 @@
-<Project Sdk="Microsoft.NET.Sdk.Razor">
+<Project Sdk="Microsoft.NET.Sdk.Razor">
 
  <Import Project="..\..\Utilities\Lombiq.NodeJs.Extensions\Lombiq.NodeJs.Extensions\Lombiq.NodeJs.Extensions.props" />
 
  <PropertyGroup>
- <TargetFramework>net6.0</TargetFramework>
+ <TargetFramework>net8.0</TargetFramework>
  <AddRazorSupportForMvc>true</AddRazorSupportForMvc>
  <Title>Lombiq Training Demo for Orchard Core</Title>
  <Description>Orchard Core training demo module for teaching Orchard Core fundamentals primarily by going through its source code.</Description>
@@ -23,29 +23,29 @@
  </ItemGroup>
 
  <ItemGroup>
- <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="7.0.0" />
- <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
- <PackageReference Include="OrchardCore.Users.Abstractions" Version="1.7.0" />
- <PackageReference Include="OrchardCore.Workflows.Abstractions" Version="1.7.0" />
+ <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="8.0.0" />
+ <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
+ <PackageReference Include="OrchardCore.Users.Abstractions" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.Workflows.Abstractions" Version="1.8.2" />
  </ItemGroup>
 
  <ItemGroup>
- <PackageReference Include="OrchardCore.BackgroundTasks" Version="1.7.0" />
- <PackageReference Include="OrchardCore.ContentFields" Version="1.7.0" />
- <PackageReference Include="OrchardCore.ContentManagement" Version="1.7.0" />
- <PackageReference Include="OrchardCore.ContentTypes.Abstractions" Version="1.7.0" />
- <PackageReference Include="OrchardCore.Data.Abstractions" Version="1.7.0" />
- <PackageReference Include="OrchardCore.DynamicCache" Version="1.7.0" />
- <PackageReference Include="OrchardCore.FileStorage.FileSystem" Version="1.7.0" />
- <PackageReference Include="OrchardCore.Indexing.Abstractions" Version="1.7.0" />
- <PackageReference Include="OrchardCore.Media.Abstractions" Version="1.7.0" />
- <PackageReference Include="OrchardCore.Module.Targets" Version="1.7.0" />
+ <PackageReference Include="OrchardCore.BackgroundTasks" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.ContentFields" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.ContentManagement" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.ContentTypes.Abstractions" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.Data.Abstractions" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.DynamicCache" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.FileStorage.FileSystem" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.Indexing.Abstractions" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.Media.Abstractions" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.Module.Targets" Version="1.8.2" />
  <!-- Note that you need to add a reference to OrchardCore.ResourceManagement for the basic tag helpers like <style>
  and <script> to properly work when the app is built for production (and thus Razor Runtime Compilation is turned
  off. OrchardCore.DisplayManagement is needed for a variety of things but also for the <shape> tag helper for the
  same reason. -->
- <PackageReference Include="OrchardCore.ResourceManagement" Version="1.7.0" />
- <PackageReference Include="OrchardCore.DisplayManagement" Version="1.7.0" />
+ <PackageReference Include="OrchardCore.ResourceManagement" Version="1.8.2" />
+ <PackageReference Include="OrchardCore.DisplayManagement" Version="1.8.2" />
  </ItemGroup>
 
  <ItemGroup>

Manifest.cs

@@ -42,8 +42,8 @@
  // feature then you need to include them in this list. Orchard Core will make sure to enable all dependent features
  // when you enable a feature that has dependencies. Without this some features would not work even if the assembly
  // is referenced in the project.
- Dependencies = new[]
- {
+ Dependencies =
+ [
  "OrchardCore.Admin",
  "OrchardCore.Apis.GraphQL",
  "OrchardCore.BackgroundTasks",
@@ -64,7 +64,7 @@
  "OrchardCore.Themes",
  "OrchardCore.Users",
  "OrchardCore.Workflows",
- }
+ ]
 )]
 
 // And we also have a second feature!
@@ -77,10 +77,10 @@
  Category = "Training",
  Description = "Demonstrates how to write middlewares in a separate feature.",
  // It's usual for sub-features to depend on the base feature but this is not mandatory.
- Dependencies = new[]
- {
+ Dependencies =
+ [
  "Lombiq.TrainingDemo",
- }
+ ]
 )]
 
 // How do you distinguish what's activated when turning on a feature? With the same Feature attribute! Check out the

Migrations/BookMigrations.cs

@@ -8,6 +8,7 @@
 
 using Lombiq.TrainingDemo.Indexes;
 using OrchardCore.Data.Migration;
+using System.Threading.Tasks;
 using YesSql.Sql;
 
 namespace Lombiq.TrainingDemo.Migrations;
@@ -17,9 +18,9 @@ public class BookMigrations : DataMigration
 {
  // Migrations have Create() and UpdateFromX methods. When the module is first enabled the Create() is called so it
  // can set up DB tables.
- public int Create()
+ public async Task<int> CreateAsync()
  {
- SchemaBuilder.CreateMapIndexTable<BookIndex>(table => table
+ await SchemaBuilder.CreateMapIndexTableAsync<BookIndex>(table => table
  .Column<string>(nameof(BookIndex.Author))
  // Titles of books can be really long sometimes (even as long as 26000 characters:
  // https://www.guinnessworldrecords.com/world-records/358711-longest-title-of-a-book) so we have to make
@@ -31,7 +32,7 @@ public int Create()
  // Let's suppose that we'll store many books, tens of thousands in the database. In this case, it's also advised
  // to add SQL indices to columns that are frequently queried on. In our case, Author is like this so we add an
  // index below. Note that you can only add indices in AlterTable().
- SchemaBuilder.AlterTable(nameof(BookIndex), table => table
+ await SchemaBuilder.AlterTableAsync(nameof(BookIndex), table => table
  .CreateIndex($"IDX_{nameof(BookIndex)}_{nameof(BookIndex.Author)}", nameof(BookIndex.Author))
  );
 
@@ -44,13 +45,13 @@ public int Create()
  // already enabled before and the create method was run (like when you update a module already running on an Orchard
  // site). The X in UpdateFromX is the version number of the update (the method's name is conventional). It means:
  // "run this update if the module's current migration version is X". This method will run if it's 1.
- public int UpdateFrom1()
+ public async Task<int> UpdateFrom1Async()
  {
  // The initial version of our module did not store the book's title. We quickly fix the issue by pushing out an
  // update that modifies the schema to add the Name. Remember, we've returned 2 in the Create method so this
  // update method won't be executed in a fresh setup. This is why you need to include all these changes in the
  // Create method as well.
- SchemaBuilder.AlterTable(nameof(BookIndex), table => table
+ await SchemaBuilder.AlterTableAsync(nameof(BookIndex), table => table
  .AddColumn<string>(nameof(BookIndex.Title))
  );
 

Migrations/PersonMigrations.cs

@@ -7,6 +7,7 @@
 using OrchardCore.ContentManagement.Metadata.Settings;
 using OrchardCore.Data.Migration;
 using System;
+using System.Threading.Tasks;
 using YesSql.Sql;
 using static Lombiq.HelpfulLibraries.OrchardCore.Contents.ContentFieldEditorEnums;
 
@@ -22,10 +23,10 @@ public class PersonMigrations : DataMigration
 
  public PersonMigrations(IContentDefinitionManager contentDefinitionManager) => _contentDefinitionManager = contentDefinitionManager;
 
- public int Create()
+ public async Task<int> CreateAsync()
  {
  // Now you can configure PersonPart. For example you can add content fields (as mentioned earlier) here.
- _contentDefinitionManager.AlterPartDefinition(nameof(PersonPart), part => part
+ await _contentDefinitionManager.AlterPartDefinitionAsync(nameof(PersonPart), part => part
  // Each field has its own configuration. Here you will give a display name for it and add some additional
  // settings like a hint to be displayed in the editor.
  .WithField(nameof(PersonPart.Biography), field => field
@@ -39,7 +40,7 @@ public int Create()
  );
 
  // This one will create an index table for the PersonPartIndex as explained in the BookMigrations file.
- SchemaBuilder.CreateMapIndexTable<PersonPartIndex>(table => table
+ await SchemaBuilder.CreateMapIndexTableAsync<PersonPartIndex>(table => table
  .Column<DateTime>(nameof(PersonPartIndex.BirthDateUtc))
  .Column<Handedness>(nameof(PersonPartIndex.Handedness))
  // The content item ID is always 26 characters.
@@ -51,7 +52,7 @@ public int Create()
  // https://docs.orchardcore.net/en/latest/docs/glossary/#content-type. The content type's name is arbitrary but
  // choose a meaningful one. Notice how we use a class with constants to store the type name so we prevent risky
  // copy-pasting.
- _contentDefinitionManager.AlterTypeDefinition(ContentTypes.PersonPage, type => type
+ await _contentDefinitionManager.AlterTypeDefinitionAsync(ContentTypes.PersonPage, type => type
  .Creatable()
  .Listable()
  // We attach parts by specifying their name. For our own parts we use nameof(): This is not mandatory but
@@ -62,7 +63,7 @@ public int Create()
  // We can even create a widget with the same content part. Widgets are just content types as usual but with the
  // Stereotype set as "Widget". You'll notice that our site's configuration includes three zones on the frontend
  // that you can add widgets to, as well as two layers. Check them out on the admin!
- _contentDefinitionManager.AlterTypeDefinition("PersonWidget", type => type
+ await _contentDefinitionManager.AlterTypeDefinitionAsync("PersonWidget", type => type
  .Stereotype("Widget")
  .WithPart(nameof(PersonPart))
  );

Services/DemoSettingsConfiguration.cs

@@ -1,6 +1,5 @@
 using Lombiq.TrainingDemo.Models;
 using Microsoft.Extensions.Options;
-using OrchardCore.Entities;
 using OrchardCore.Settings;
 
 namespace Lombiq.TrainingDemo.Services;

Tests/Lombiq.TrainingDemo.Tests/Lombiq.TrainingDemo.Tests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
- <TargetFramework>net6.0</TargetFramework>
+ <TargetFramework>net8.0</TargetFramework>
  </PropertyGroup>
 
  <ItemGroup>

Views/ColorField-ColorPicker.Edit.cshtml

@@ -24,7 +24,7 @@
 <fieldset class="form-group @BlockName @(BlockName)_editor_colorPicker">
  <legend class="@(BlockName)__displayName">@Model.PartFieldDefinition.DisplayName()</legend>
 
- <label asp-for="ColorName" class="@(BlockName)__label">@T["Color name"]</label>
+ <label asp-for="ColorName" class="form-label @(BlockName)__label">@T["Color name"]</label>
  <input asp-for="ColorName" class="form-control @(BlockName)__input" />
 
  <div id="@pickerElementId" class="@(BlockName)__picker"></div>

Views/ColorField.Edit.cshtml

@@ -12,10 +12,10 @@
 <fieldset class="form-group colorFieldEditor">
  <legend>@Model.PartFieldDefinition.DisplayName()</legend>
 
- <label asp-for="ColorName" class="colorFieldEditor__label">@T["Color name"]</label>
+ <label asp-for="ColorName" class="form-label colorFieldEditor__label">@T["Color name"]</label>
  <input asp-for="ColorName" class="form-control content-preview-text colorFieldEditor__input" />
 
- <label asp-for="Value" class="colorFieldEditor__label">@T["Hexadecimal value"]</label>
+ <label asp-for="Value" class="form-label colorFieldEditor__label">@T["Hexadecimal value"]</label>
  <input asp-for="Value" class="form-control content-preview-text colorFieldEditor__input" />
  @if (!string.IsNullOrEmpty(settings.Hint))
  {

Views/ColorFieldSettings.Edit.cshtml

@@ -3,22 +3,22 @@
 <fieldset class="form-group">
  <div class="custom-control custom-checkbox">
  <input asp-for="Required" type="checkbox" class="custom-control-input">
- <label class="custom-control-label" asp-for="Required">@T["Check if the field is required."]</label>
+ <label class="form-label custom-control-label" asp-for="Required">@T["Check if the field is required."]</label>
  </div>
 </fieldset>
 
 <fieldset class="form-group">
  <div class="row col-md">
- <label asp-for="Hint">@T["Hint"]</label>
+ <label class="form-label" asp-for="Hint">@T["Hint"]</label>
  <textarea asp-for="Hint" rows="2" class="form-control"></textarea>
  <span class="hint">@T["The hint text to display for this field on the editor."]</span>
  </div>
 </fieldset>
 
 <fieldset class="form-group">
  <div class="row col-sm">
- <label asp-for="Label">@T["Label"]</label>
- <input asp-for="Label" class="form-control" />
+ <label class="form-label" asp-for="Label">@T["Label"]</label>
+ <input class="form-label" asp-for="Label" class="form-control" />
  <span class="hint">@T["The text associated to the checkbox."]</span>
  </div>
 </fieldset>

Views/DemoSettings.Edit.cshtml

@@ -3,7 +3,7 @@
 @using OrchardCore.Mvc.Core.Utilities
 
 <fieldset class="form-group" asp-validation-class-for="Message">
- <label asp-for="Message">@T["Message"]</label>
+ <label class="form-label" asp-for="Message">@T["Message"]</label>
  <input asp-for="Message" class="form-control" type="text" />
  <span asp-validation-for="Message"></span>
  <span class="hint">

Views/Items/ManagePersonsPermissionCheckerTask.Fields.Edit.cshtml

@@ -1,7 +1,7 @@
 @model ManagePersonsPermissionCheckerTaskViewModel
 
 <div class="mb-3" asp-validation-class-for="UserName">
- <label asp-for="UserName">@T["Username"]</label>
+ <label class="form-label" asp-for="UserName">@T["Username"]</label>
  <input type="text" asp-for="UserName" class="form-control code" />
  <span asp-validation-for="UserName"></span>
  <span class="hint">@T["The user's name to be checked for ManagePersons permission."]</span>

Views/PersonPart.Edit.cshtml

@@ -7,18 +7,18 @@
  here, because (as mentioned) it has its own editor and display shape so no need to worry about that. *@
 
 <fieldset class="form-group" asp-validation-class-for="Name">
- <label asp-for="Name">@T["Name"] <span asp-validation-for="Name"></span></label>
+ <label class="form-label" asp-for="Name">@T["Name"] <span asp-validation-for="Name"></span></label>
  <input asp-for="Name" class="form-control" />
  <span class="hint">@T["Person's name"]</span>
 </fieldset>
 
 <fieldset class="form-group" asp-validation-class-for="BirthDateUtc">
- <label asp-for="BirthDateUtc">@T["Birth date"] <span asp-validation-for="BirthDateUtc"></span></label>
+ <label class="form-label" asp-for="BirthDateUtc">@T["Birth date"] <span asp-validation-for="BirthDateUtc"></span></label>
  <input asp-for="BirthDateUtc" type="date" class="form-control" />
 </fieldset>
 
 <fieldset class="form-group" asp-validation-class-for="Handedness">
- <label asp-for="Handedness">@T["Handedness"] <span asp-validation-for="Handedness"></span></label>
+ <label class="form-label" asp-for="Handedness">@T["Handedness"] <span asp-validation-for="Handedness"></span></label>
  <select asp-for="Handedness" asp-items="Html.GetEnumSelectList<Handedness>()" class="form-control"></select>
 </fieldset>