cs11dotnet7/docs/errata/errata.md

534 lines
31 KiB
Markdown
Raw Normal View History

2023-03-01 15:32:06 +01:00
**Errata** (30 items)
2022-10-11 13:23:13 +02:00
If you find any mistakes, then please [raise an issue in this repository](https://github.com/markjprice/cs11dotnet7/issues) or email me at markjprice (at) gmail.com.
2022-11-21 15:40:24 +01:00
> Microsoft has changed their domain for documentation from `https://docs.microsoft.com` to `https://learn.microsoft.com` with an automatic redirect so all links in my books that use the `docs` domain should still work.
2022-11-08 12:34:22 +01:00
2022-11-08 13:15:52 +01:00
- [Page 4, 8 - Pros and cons of the .NET Interactive Notebooks extension, Downloading and installing Visual Studio Code](#page-4-8---pros-and-cons-of-the-net-interactive-notebooks-extension-downloading-and-installing-visual-studio-code)
- [Page 11 - Understanding the journey to one .NET and Understanding .NET support](#page-11---understanding-the-journey-to-one-net-and-understanding-net-support)
- [Page 37 - Getting definitions of types and their members](#page-37---getting-definitions-of-types-and-their-members)
- [Page 83 - Formatting using numbered positional arguments](#page-83---formatting-using-numbered-positional-arguments)
2023-01-10 09:36:01 +01:00
- [Page 83 - Formatting using interpolated strings](#page-83---formatting-using-interpolated-strings)
2022-11-28 15:23:18 +01:00
- [Page 85 - Getting text input from the user](#page-85---getting-text-input-from-the-user)
2022-11-08 13:15:52 +01:00
- [Page 86 - Getting text input from the user](#page-86---getting-text-input-from-the-user)
2023-01-25 09:23:03 +01:00
- [Page 114 - Simplifying switch statements with switch expressions](#page-114---simplifying-switch-statements-with-switch-expressions)
2023-01-29 12:08:15 +01:00
- [Page 156 - Calculating factorials with recursion](#page-156---calculating-factorials-with-recursion)
2023-02-14 12:02:08 +01:00
- [Page 166 - Setting a breakpoint and starting debugging - Using Visual Studio 2022](#page-166---setting-a-breakpoint-and-starting-debugging---using-visual-studio-2022)
2022-11-17 00:19:06 +01:00
- [Page 185 - Creating a class library that needs testing](#page-185---creating-a-class-library-that-needs-testing)
2022-11-08 13:15:52 +01:00
- [Page 188 - Running unit tests using Visual Studio Code](#page-188---running-unit-tests-using-visual-studio-code)
2023-03-01 15:32:06 +01:00
- [Page 231 - Requiring properties to be set during instantiation](#page-231---requiring-properties-to-be-set-during-instantiation)
2022-11-10 23:01:07 +01:00
- [Page 244 - Init-only properties](#page-244---init-only-properties)
2023-02-03 10:51:47 +01:00
- [Page 258 - Defining and handling events](#page-258---defining-and-handling-events)
2023-01-17 13:27:19 +01:00
- [Page 272 - Defining struct types](#page-272---defining-struct-types)
2023-01-16 09:47:10 +01:00
- [Page 275 - Releasing unmanaged resources](#page-275---releasing-unmanaged-resources)
2023-02-03 10:51:47 +01:00
- [Page 277 - Making a value type nullable](#page-277---making-a-value-type-nullable)
2023-02-20 13:07:24 +01:00
- [Page 279 - Declaring non-nullable variables and parameters](#page-279---declaring-non-nullable-variables-and-parameters)
2022-11-14 22:12:51 +01:00
- [Page 322 - Revealing the location of a type](#page-322---revealing-the-location-of-a-type)
2023-01-04 10:55:23 +01:00
- [Page 330 - Publishing a self-contained app, Page 354 - Exercise 7.3 Explore PowerShell](#page-330---publishing-a-self-contained-app-page-354---exercise-73--explore-powershell)
2023-02-06 12:27:56 +01:00
- [Page 399 - Managing directories](#page-399---managing-directories)
2022-11-30 09:29:45 +01:00
- [Page 412 - Compressing streams](#page-412---compressing-streams)
- [Page 477 - Inserting entities](#page-477---inserting-entities)
- [Page 548 - Creating a class library for a Northwind database context](#page-548---creating-a-class-library-for-a-northwind-database-context)
- [Page 551 - Creating a class library for entity models using SQL Server](#page-551---creating-a-class-library-for-entity-models-using-sql-server)
2022-12-04 21:07:46 +01:00
- [Page 627 - Defining a typed view](#page-627---defining-a-typed-view)
2022-12-14 19:36:56 +01:00
- [Page 631 - Passing parameters using a route value](#page-631---passing-parameters-using-a-route-value)
2022-12-15 09:56:20 +01:00
- [Page 641 - Enabling role management and creating a role programmatically](#page-641---enabling-role-management-and-creating-a-role-programmatically)
2022-12-05 12:50:42 +01:00
- [Page 649 - Varying cached data by query string](#page-649---varying-cached-data-by-query-string)
2022-12-29 13:49:34 +01:00
- [Page 707 - Reviewing the Blazor Server project template](#page-707---reviewing-the-blazor-server-project-template)
- [Page 724 - Getting entities into a component](#page-724---getting-entities-into-a-component)
2023-02-23 16:32:40 +01:00
- [Page 733 - Building customer create, edit, and delete components](#page-733---building-customer-create-edit-and-delete-components)
2022-10-11 13:23:13 +02:00
2022-11-08 13:15:52 +01:00
# Page 4, 8 - Pros and cons of the .NET Interactive Notebooks extension, Downloading and installing Visual Studio Code
2022-11-05 09:28:22 +01:00
2022-11-08 12:34:22 +01:00
The **.NET Interactive Notebooks** extension has been renamed to **Polyglot Notebooks**. It still retains its original identifier `ms-dotnettools.dotnet-interactive-vscode`. The engine is still named *.NET Interactive*.
> Read more here: https://devblogs.microsoft.com/dotnet/dotnet-interactive-notebooks-is-now-polyglot-notebooks/#why-the-name-change
2022-11-05 09:28:22 +01:00
2022-11-28 15:23:18 +01:00
I wrote that "They cannot read input from the user, for example, you cannot use ReadLine or ReadKey." Although you cannot use the `Console` class methods, you can use the `Microsoft.DotNet.Interactive.Kernel` class and its `GetInputAsync` method. This uses the Visual Studio Code user interface to prompt the user for input.
2022-11-08 13:15:52 +01:00
# Page 11 - Understanding the journey to one .NET and Understanding .NET support
2022-10-11 13:23:13 +02:00
2022-10-28 12:49:00 +02:00
Even-numbered .NET releases like .NET 6 and .NET 8 have a support level named **Long Term Support (LTS)** with a duration of 3 years. Odd-numbered .NET releases like .NET 5 and .NET 7 had a support level named **Current** with a duration of 18 months.
2022-10-27 09:55:23 +02:00
2022-10-28 12:54:23 +02:00
On June 6, 2022, the .NET team proposed to change the support level name from **Current** to [**Short Term Support (STS)**](https://github.com/dotnet/announcements/issues/223) to complement the existing **Long Term Support (LTS)**. I updated the drafts of my book to reflect that change.
2022-10-27 09:55:23 +02:00
2022-10-28 12:54:23 +02:00
On October 11, 2022, the .NET team changed the name again, to [**Standard Support**](https://devblogs.microsoft.com/dotnet/announcing-dotnet-7-rc-2/#support), probably because Microsoft Marketing decided that "short term" sounded too negative. My editors and I scrambled to update the final drafts of my book to reflect that change.
2022-10-28 12:49:00 +02:00
2022-10-28 12:54:23 +02:00
On October 28, 2022, the .NET team changed the name *again*, to [**Standard Term Support (STS)**](https://twitter.com/mairacw/status/1585789100879069185), probably because an initialism of **SS** is problematic and internal code and configuration was already using `sts`. Sadly, it was too late to update the PDFs that are sent to print.
2022-10-28 12:49:00 +02:00
*Sigh.* Such are the perils of trying to be up-to-date on release day.
2022-10-11 13:23:13 +02:00
2022-11-08 13:15:52 +01:00
# Page 37 - Getting definitions of types and their members
2022-11-02 11:11:25 +01:00
In Step 3, I wrote, "Click inside `int` and then right-click and choose **Go To Definition**."
2022-11-08 12:43:59 +01:00
Visual Studio 2022 used to show code reverse-engineered **from metadata** for the selected type like `int` (see *Figure 1.1*), including the comments that I talk about in the book, but it now shows **Source Link** code (see *Figure 1.2*) which does not have comments.
2022-11-02 11:11:25 +01:00
![from metadata code](images/B18856_01_01.png)
2022-11-08 12:43:59 +01:00
*Figure 1.1: Go To Definition file tab generated from metadata*
2022-11-02 11:11:25 +01:00
![SourceLink code](images/B18856_01_02.png)
2022-11-08 12:43:59 +01:00
*Figure 1.2: Go To Definition file tab retrieved from embedded Source Link code*
2022-11-02 11:11:25 +01:00
2022-11-08 12:43:59 +01:00
To change back to the original Visual Studio 2022 behavior that is described in the book, please follow these steps:
2022-11-02 11:11:25 +01:00
2022-11-08 12:43:59 +01:00
1. In Visual Studio 2022, navigate to **Tools** | **Options**.
2022-11-02 11:11:25 +01:00
2. In the **Options** dialog, navigate to **Text Editor** | **C#** | **Advanced**.
3. In the **Go To Definition** section, clear the check box named **Enable navigation to Source Link and Embedded sources**, as shown in *Figure 1.3*.
4. Click **OK**.
![Disabling Source Link for the Go To Definition feature](images/B18856_01_03.png)
*Figure 1.3: Disabling Source Link for the Go To Definition feature*
2022-11-08 13:15:52 +01:00
# Page 83 - Formatting using numbered positional arguments
2022-11-01 18:07:19 +01:00
2022-11-08 12:43:59 +01:00
At the end of the section, I say, "The `Write`, `WriteLine`, and `Format` methods can have up to four numbered arguments, named `arg0`, `arg1`, `arg2`, and `arg3`."
2022-11-01 18:07:19 +01:00
2022-11-08 12:43:59 +01:00
But the methods can only have up to *three* named arguments. I should have said, "The `Write`, `WriteLine`, and `Format` methods can have up to three numbered arguments, named `arg0`, `arg1`, and `arg2`. If you need to pass more than three values, then you cannot name the arguments using `arg0` and so on, as shown in the following code:"
2022-11-01 18:07:19 +01:00
```cs
2022-11-08 12:43:59 +01:00
// Passing three values can use named arguments.
2022-11-01 18:07:19 +01:00
Console.WriteLine(
format: "{0} {1} lived in {2}.",
arg0: "Roger", arg1: "Cevung", arg2: "Stockholm");
2022-11-08 12:43:59 +01:00
// Passing four or more values cannot use named arguments.
2022-11-01 18:07:19 +01:00
Console.WriteLine(
"{0} {1} lived in {2} and worked in the {3} team at {4}.",
"Roger", "Cevung", "Stockholm", "Education", "Optimizely");
```
2023-01-10 09:36:01 +01:00
# Page 83 - Formatting using interpolated strings
In Step 1, you enter some statements to output some variables using an interpolated string, as shown in the following code:
```cs
// The following statement must be all on one line.
Console.WriteLine($"{numberOfApples} apples cost {pricePerApple * numberOfApples:C}");
```
The comment says that it "must be all on one line". This is true for C# 10 and earlier (which is the default compiler if you target .NET 6), but if you use C# 11 then an expression inside an interpolation hole like `{pricePerApple * numberOfApples:C}` can now include line breaks. So we can, for example, enter the statement like this:
```cs
// The following statement must be all on one line when using C# 10 or earlier.
// If using C# 11, we can include a line break, as shown here:
Console.WriteLine($"{numberOfApples} apples cost {pricePerApple
* numberOfApples:C}");
```
2022-11-28 15:23:18 +01:00
# Page 85 - Getting text input from the user
I wrote that a notebook "does not support reading input from the console using `Console.ReadLine()`." Although this is true, you can use the `Microsoft.DotNet.Interactive.Kernel` class and its `GetInputAsync` method instead. This uses the .NET Interactive integration with the Visual Studio Code user interface to prompt the user for input.
```cs
using Microsoft.DotNet.Interactive; // to use the Kernel class
string firstName = await Kernel.GetInputAsync("Type your first name: ");
string age = await Kernel.GetInputAsync("Type your age: ");
Console.WriteLine($"Hello {firstName}, you look good for {age}.");
```
![Getting input from the .NET Interactive kernel](images/kernel-getinputasync.png)
2022-11-08 13:15:52 +01:00
# Page 86 - Getting text input from the user
2022-11-01 20:21:51 +01:00
In Step 3, I wrote, "For the `firstName` variable" when I should have written, "For the `age` variable".
2023-01-25 09:23:03 +01:00
# Page 114 - Simplifying switch statements with switch expressions
2023-01-25 09:25:17 +01:00
> Thanks to [Ricky](https://github.com/r1c5) for raising this [issue on 25 January 2023](https://github.com/markjprice/cs11dotnet7/issues/19).
2023-01-25 09:23:03 +01:00
In Step 1, the code statement that outputs the four-legged cat information is missing the word "named", as shown in the following code:
```cs
Cat fourLeggedCat when fourLeggedCat.Legs == 4
=> $"The cat {fourLeggedCat.Name} has four legs.",
```
It should be:
```cs
Cat fourLeggedCat when fourLeggedCat.Legs == 4
=> $"The cat named {fourLeggedCat.Name} has four legs.",
```
2023-01-29 12:08:15 +01:00
# Page 156 - Calculating factorials with recursion
> Thanks to [Ricky](https://github.com/r1c5) for raising this [issue on 29 January 2023](https://github.com/markjprice/cs11dotnet7/issues/21).
In Step 1, in the third bullet that explains the code, I wrote, "If the input parameter number is more than 1, which it will be in all other cases..." I should have written, "If the input parameter number is more than 0, which it will be in all other cases..."
2023-02-14 12:02:08 +01:00
# Page 166 - Setting a breakpoint and starting debugging - Using Visual Studio 2022
> Thanks to [Masoud Nazari](https://github.com/MAS-OUD) for raising this [issue on 12 February 2023](https://github.com/markjprice/cs11dotnet7/issues/28).
At the end of this section I wrote, "If you do not want to see how to use Visual Studio Code to start debugging, then you can skip the next section and continue to the section titled *Navigating with the debugging toolbar*."
But the immediately following section is *Navigating with the debugging toolbar*. The paragraph should move to after this section and before the section titled *Using Visual Studio Code*, and it should say, "If you do not want to see how to use Visual Studio Code to start debugging, then you can skip the next section and continue to the section titled *Debugging windows*."
2022-11-17 00:19:06 +01:00
# Page 185 - Creating a class library that needs testing
In the "If you are using Visual Studio Code" section, in Step 5, the command in the book is `dotnet new console` but it should have been `dotnet new classlib`.
2022-11-08 13:15:52 +01:00
# Page 188 - Running unit tests using Visual Studio Code
2022-10-11 13:23:13 +02:00
2022-10-28 12:49:00 +02:00
> Thanks to [kwatsonkairosmgt](https://github.com/kwatsonkairosmgt) for raising this [issue on 27 October 2022](https://github.com/markjprice/cs10dotnet6/issues/106).
In Step 1, the project name `CalculatorLibUnitTest` should be `CalculatorLibUnitTests`.
2022-11-10 23:01:07 +01:00
2023-03-01 15:32:06 +01:00
# Page 231 - Requiring properties to be set during instantiation
> Thanks to [Masoud Nazari](https://github.com/MAS-OUD) for raising this [issue on 1 March 2023](https://github.com/markjprice/cs11dotnet7/issues/33).
In Step 1, you are told to add a new class library project named `PacktLibraryModern`.
In Step 4, in the `PeopleApp` console app project, you are told to create an instance of the `Book` class that is defined in the class library. To do so, you must have added a reference to the `PacktLibraryModern` project.
In the next edition, I will add steps before Step 4 to remind readers how to do this, as shown below:
*If you are using Visual Studio 2022:*
- In **Solution Explorer**, select the `PeopleApp` project, navigate to **Project** | **Add Project Reference…**, check the box to select the **PacktLibraryModern** project, and then click **OK**.
*If you are using Visual Studio Code:*
- Edit `PeopleApp.csproj` to add a project reference to `PacktLibraryModern`, as shown in
the following markup:
```xml
<ItemGroup>
<ProjectReference Include="../PacktLibraryModern/PacktLibraryModern.csproj" />
</ItemGroup>
```
- Build the `PeopleApp` project.
2022-11-10 23:01:07 +01:00
# Page 244 - Init-only properties
> Thanks to Bob Molloy for raising this issue via email.
In Step 1, I say to add a new file named `Records.cs` to the `PacktLibraryNetStandard2` project/folder. I should have said to the `PacktLibraryModern` project/folder.
2022-11-14 22:12:51 +01:00
2023-02-03 10:51:47 +01:00
# Page 258 - Defining and handling events
> Thanks to [Ricky](https://github.com/r1c5) for raising this [issue on 2 February 2023](https://github.com/markjprice/cs11dotnet7/issues/23).
In Step 5, the statement that outputs the "Stop it!" message uses the `$` string interpolation prefix character unnecessarily, as shown in the following code:
```cs
WriteLine($"Stop it!");
```
The `$` can be removed, as shown in the following code:
```cs
WriteLine("Stop it!");
```
2023-01-17 13:27:19 +01:00
# Page 272 - Defining struct types
> Thanks to [Ali Koleiny Zadeh](https://github.com/alikzalikz) for raising this [issue on 15 January 2023](https://github.com/markjprice/cs11dotnet7/issues/18).
In Step 4, the output should be formatted using the "command line" style like in Step 6 instead of the "code" style so that it has the black background.
2023-01-16 09:47:10 +01:00
# Page 275 - Releasing unmanaged resources
> Thanks to `Wuu#0348` on the Packt Discord channels for raising this issue.
In the second bullet point after the large code block, I wrote, "It needs to check the `disposing` parameter and `disposed` field because if the finalizer thread has already run and it called the `~ObjectWithUnmanagedResources` method, then only unmanaged resources need to be deallocated." I should have written **managed** not **unmanaged**.
It might be clearer if I wrote, "It needs to check the `disposing` parameter and `disposed` field because if the finalizer thread has already run and it called the `~ObjectWithUnmanagedResources` method, then unmanaged resources will already have been deallocated and only managed resources remain to be deallocated by the garbage collector." I will do this in the next edition.
2023-02-03 10:51:47 +01:00
# Page 277 - Making a value type nullable
> Thanks to [Ricky](https://github.com/r1c5) for raising this [issue on 2 February 2023](https://github.com/markjprice/cs11dotnet7/issues/24).
In Step 6, the output should be formatted with a black background like other command-line blocks, and the output is missing the writing of the variable named `thisCannotBeNull`. The output should be:
```
4
0
7
7
```
Step 7 should therefore say, "The **second** line is blank because it is outputting the null value!", and it should not be formatted as a numbered step because it is a not an instruction to the reader, it is a note.
2023-02-20 13:07:24 +01:00
# Page 279 - Declaring non-nullable variables and parameters
> Thanks to [Ricky](https://github.com/r1c5) for raising this [issue on 19 February 2023](https://github.com/markjprice/cs11dotnet7/issues/30).
In Step 1, I wrote, "In `NullHandling.csproj`," which could be confusing because you do not need to modify that file. I should have written, "In the `NullHandling` project," because you need to add a new file to the project.
2022-11-14 22:12:51 +01:00
# Page 322 - Revealing the location of a type
> Thanks to Bob Molloy for raising this issue via email.
In Steps 2 and 5, I say to "Navigate to the top of the code file and note the assembly filename..."
If you have Source Link enabled, then you will not see the filename. I recommend that you [disable Source Link](#page-37---getting-definitions-of-types-and-their-members).
If you have Source Link disabled, then to see the filename you must expand the collapsed region. You will then find the assembly filename within the region, as shown in the following code:
```cs
#region Assembly System.Runtime, Version=7.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
// C:\Program Files\dotnet\packs\Microsoft.NETCore.App.Ref\7.0.0\ref\net7.0\System.Runtime.dll
#endregion
```
2022-11-24 10:17:22 +01:00
2023-01-04 10:55:23 +01:00
# Page 330 - Publishing a self-contained app, Page 354 - Exercise 7.3 Explore PowerShell
In the **Good Practice** box on page 330, I wrote about how you can automate commands using scripts written in the PowerShell language. My original plan was to write content about PowerShell in the GitHub repository. But PowerShell is a massive topic and there will always be higher priority content to create that is specifically about C# and .NET. In the next edition I will just reference the official PowerShell documentation: https://learn.microsoft.com/en-us/powershell/ And I will remove **Exercise 7.3** that suggests exploring PowerShell.
2023-02-06 12:27:56 +01:00
# Page 399 - Managing directories
> Thanks to [Dario Bosco](https://github.com/DarioBosco) for raising this [issue on 6 February 2023](https://github.com/markjprice/cs11dotnet7/issues/26).
In Step 1, in the second bullet, I wrote, "Check for the existence of the custom directory path using the `Exists` method of the
2023-02-06 12:35:07 +01:00
`Directory` class." But in the code I used the `Exists` method of the `Path` class. We have statically imported both the `Path` and the `Directory` classes and they both have an `Exists` method in .NET 7. If we try to call an `Exists` method without a classname prefix we get a compile error due to ambiguity of which one to call. After writing the second bullet text, I changed the code from using `Directory` to using `Path` simply because it is shorter. In the 8th edition, I will add a note about this since it is useful for the reader to understand my choice and how the reader could have done it differently.
> Note: the `Path.Exists` method was added in .NET 7. It is not available in earlier versions of .NET.
2023-02-06 12:27:56 +01:00
2022-11-30 09:29:45 +01:00
# Page 412 - Compressing streams
2022-11-24 10:17:22 +01:00
> Thanks to Bob Molloy for raising this issue via email.
In Step 2, the following statement enables interpolated strings unnecessarily:
```cs
WriteLine($"The compressed contents:");
```
It should be:
```cs
WriteLine("The compressed contents:");
```
2022-11-30 09:20:17 +01:00
2022-11-30 09:29:45 +01:00
# Page 477 - Inserting entities
2022-11-30 09:20:17 +01:00
> Thanks to [Chadwick Geyser](https://github.com/chadwickgeyser) for raising this [issue on 29 November 2022](https://github.com/markjprice/cs11dotnet7/issues/5).
In Step 4, the code statement to list the products uses an older version of the method signature that I removed before publishing that only allows a single `productId` to be highlighted, as shown in the following code:
```cs
ListProducts(productIdToHighlight: resultAdd.productId);
```
It should use the method signature that allows multiple `productIds` to be highlighted, as shown in the following code:
```cs
ListProducts(productIdsToHighlight: new[] { resultAdd.productId });
```
2022-12-04 21:07:46 +01:00
# Page 548 - Creating a class library for a Northwind database context
In Step 11, you write an extension method that registers the `NorthwindContext` class for use as a dependency service. In later chapters, this will be used in ASP.NET Core and Blazor projects. By default, a `DbContext` class is registered using `Scope` lifetime, meaning that multiple threads can share the same instance. If more than one thread attempts to use the same `NorthwindContext` class instance at the same time then you will see the following runtime exception thrown:
> "A second operation started on this context before a previous operation completed. This is usually caused by different threads using the same instance of a DbContext, however instance members are not guaranteed to be thread safe."
To avoid this, we should register the `NorthwindContext` class with a `Transient` lifetime, as shown in the following code:
```cs
using Microsoft.EntityFrameworkCore; // UseSqlite
using Microsoft.Extensions.DependencyInjection; // IServiceCollection
namespace Packt.Shared;
public static class NorthwindContextExtensions {
/// <summary>
/// Adds NorthwindContext to the specified IServiceCollection. Uses the Sqlite database provider.
/// </summary>
/// <param name="services"></param>
/// <param name="relativePath">Set to override the default of ".."</param>
/// <param name="databaseFilename">Set to override the default of "Northwind.db"</param>
/// <returns>An IServiceCollection that can be used to add more services.</returns>
public static IServiceCollection AddNorthwindContext(
this IServiceCollection services,
string relativePath = "..",
string databaseFilename = "Northwind.db") {
string databasePath = Path.Combine(relativePath, databaseFilename);
services.AddDbContext<NorthwindContext>(options => {
options.UseSqlite($"Data Source={databasePath}");
options.LogTo(Console.WriteLine,
new[] { Microsoft.EntityFrameworkCore.Diagnostics.RelationalEventId.CommandExecuting });
2023-02-23 16:32:40 +01:00
},
// Register with a transient lifetime to avoid concurrency issues in Blazor Server projects.
contextLifetime: ServiceLifetime.Transient, optionsLifetime: ServiceLifetime.Transient);
return services;
}
}
```
# Page 551 - Creating a class library for entity models using SQL Server
In Step 15, you write an extension method that registers the `NorthwindContext` class for use as a dependency service. In later chapters, this will be used in ASP.NET Core and Blazor projects. By default, a `DbContext` class is registered using `Scope` lifetime, meaning that multiple threads can share the same instance. If more than one thread attempts to use the same `NorthwindContext` class instance at the same time then you will see the following runtime exception thrown:
> "A second operation started on this context before a previous operation completed. This is usually caused by different threads using the same instance of a DbContext, however instance members are not guaranteed to be thread safe."
To avoid this, we should register the `NorthwindContext` class with a `Transient` lifetime, as shown in the following code:
```cs
using Microsoft.EntityFrameworkCore; // UseSqlServer
using Microsoft.Extensions.DependencyInjection; // IServiceCollection
namespace Packt.Shared;
public static class NorthwindContextExtensions {
/// <summary>
/// Adds NorthwindContext to the specified IServiceCollection. Uses the SqlServer database provider.
/// </summary>
/// <param name="services"></param>
/// <param name="connectionString">Set to override the default.</param>
/// <returns>An IServiceCollection that can be used to add more services.</returns>
public static IServiceCollection AddNorthwindContext(
this IServiceCollection services,
string connectionString = "Data Source=.;Initial Catalog=Northwind;" +
"Integrated Security=true;MultipleActiveResultsets=true;Encrypt=false") {
services.AddDbContext<NorthwindContext>(options => {
options.UseSqlServer(connectionString);
options.LogTo(Console.WriteLine,
new[] { Microsoft.EntityFrameworkCore.Diagnostics.RelationalEventId.CommandExecuting });
2023-02-23 16:32:40 +01:00
},
// Register with a transient lifetime to avoid concurrency issues Blazor Server projects.
contextLifetime: ServiceLifetime.Transient, optionsLifetime: ServiceLifetime.Transient);
return services;
}
}
```
2022-12-04 21:07:46 +01:00
# Page 627 - Defining a typed view
> Thanks to [Chadwick Geyser](https://github.com/chadwickgeyser) for raising this [issue on 4 December 2022](https://github.com/markjprice/cs11dotnet7/issues/6).
In Step 3, the code in the book to render the carousel indicators has an incorrect attribute named `data-slide-to`, as shown in the following markup:
```xml
<li data-bs-target="#categories" data-slide-to="@c"
class="@currentItem"></li>
```
Should be `data-bs-slide-to`, as shown in the following markup:
```xml
<li data-bs-target="#categories" data-bs-slide-to="@c"
class="@currentItem"></li>
```
It was already correct in the GitHub copy of the code.
2022-12-05 12:50:42 +01:00
2022-12-14 19:36:56 +01:00
# Page 631 - Passing parameters using a route value
2022-12-15 09:56:20 +01:00
> Thanks to Bob Molloy for raising this issue via email.
2022-12-14 19:36:56 +01:00
In Step 3, the statements attempt to output the values of the category name and unit price for the product, as shown in the following markup:
```xml
<dt>Category</dt>
<dd>@Model.CategoryId - @Model.Category.CategoryName</dd>
<dt>Unit Price</dt>
<dd>@Model.UnitPrice.Value.ToString("C")</dd>
```
But since the `Category` and `UnitPrice` properties could be null, we should use a null checks, as shown in the following markup:
```xml
<dt>Category</dt>
<dd>@Model.CategoryId - @Model.Category?.CategoryName</dd>
<dt>Unit Price</dt>
<dd>@(Model.UnitPrice is null ? "zero" : Model.UnitPrice.Value.ToString("C"))</dd>
```
2022-12-15 09:56:20 +01:00
# Page 641 - Enabling role management and creating a role programmatically
> Thanks to Bob Molloy for raising this issue via email.
2022-12-15 09:58:10 +01:00
In Step 2, in the `Index` action method, the variable declaration for finding the email of the user is not nullable, as shown in the following code:
2022-12-15 09:56:20 +01:00
```cs
IdentityUser user = await userManager.FindByEmailAsync(UserEmail);
```
It should be nullable, as shown in the following code:
```cs
IdentityUser? user = await userManager.FindByEmailAsync(UserEmail);
```
It was already correct in the GitHub copy of the code.
2022-12-05 12:50:42 +01:00
# Page 649 - Varying cached data by query string
2022-12-05 12:54:03 +01:00
> Thanks to [Chadwick Geyser](https://github.com/chadwickgeyser) for raising this [issue on 5 December 2022](https://github.com/markjprice/cs11dotnet7/issues/7).
2022-12-05 12:50:42 +01:00
In Step 1, when defining a policy for output caching, the statement uses the method `VaryByQuery`, as shown in the following code:
```cs
options.AddPolicy("views", p => p.VaryByQuery(""));
```
The method name changed in Release Candidate 2, as described [here](https://learn.microsoft.com/en-us/dotnet/core/compatibility/aspnet-core/7.0/output-caching-renames), so statement should be changed to use the new method `SetVaryByQuery`, as shown in the following code:
```cs
options.AddPolicy("views", p => p.SetVaryByQuery(""));
```
2022-12-29 13:39:10 +01:00
2022-12-29 13:49:34 +01:00
# Page 707 - Reviewing the Blazor Server project template
2022-12-29 13:39:10 +01:00
> Thanks to [Bob Molloy](https://github.com/BobMolloy) for raising this [issue on 19 December 2022](https://github.com/markjprice/cs11dotnet7/issues/12).
In Steps 6 and 7, I wrote that there are two files that combine to product the home page for a Blazor Server project, named `_Host.cshtml` and `_Layout.cshtml`.
Microsoft changed this project template to merge them together so there is no shared layout file named `_Layout.cshtml`. The markup is now all in the `_Host.cshtml` file, as shown in the following markup:
```html
@page "/"
@using Microsoft.AspNetCore.Components.Web
@namespace Northwind.BlazorServer.Pages
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<base href="~/" />
<link rel="stylesheet" href="css/bootstrap/bootstrap.min.css" />
<link href="css/site.css" rel="stylesheet" />
<link href="Northwind.BlazorServer.styles.css" rel="stylesheet" />
<link rel="icon" type="image/png" href="favicon.png"/>
<component type="typeof(HeadOutlet)" render-mode="ServerPrerendered" />
</head>
<body>
<component type="typeof(App)" render-mode="ServerPrerendered" />
<div id="blazor-error-ui">
<environment include="Staging,Production">
An error has occurred. This application may no longer respond until reloaded.
</environment>
<environment include="Development">
An unhandled exception has occurred. See browser dev tools for details.
</environment>
<a href="" class="reload">Reload</a>
<a class="dismiss">🗙</a>
</div>
<script src="_framework/blazor.server.js"></script>
</body>
</html>
```
2022-12-29 13:49:34 +01:00
2023-02-23 16:32:40 +01:00
# Page 724 - Getting entities into a component
2023-02-23 16:49:01 +01:00
> Thanks to Amer Cejudo (via email) and [Christopher Targett-Adams](https://github.com/targettadams) for raising this [issue on 20 February 2023](https://github.com/markjprice/cs11dotnet7/issues/31).
In Step 4, I tell the reader to write a statement to call an extension method that you previously created in Chapter 12, as shown in the following code:
2023-02-23 16:32:40 +01:00
```cs
builder.Services.AddNorthwindContext();
```
2023-02-23 16:49:01 +01:00
By default, this statement registers the database context with `Scope` lifetime. This is not a problem with most ASP.NET Core projects. But in a **Blazor Server** project the `Scope` lifetime database context instance is shared between multiple threads running on the server. This can cause concurrency issues as described here:
https://learn.microsoft.com/en-us/ef/core/dbcontext-configuration/#implicitly-sharing-dbcontext-instances-via-dependency-injection
2023-02-23 16:32:40 +01:00
2023-02-23 16:49:01 +01:00
This often only affects the SQL Server database provider but it is best to apply the code change for both SQL Server and SQLite class libraries. To fix this issue, please make the changes as shown in the following items:
2023-02-23 16:32:40 +01:00
- [Page 548 - Creating a class library for a Northwind database context](#page-548---creating-a-class-library-for-a-northwind-database-context)
- [Page 551 - Creating a class library for entity models using SQL Server](#page-551---creating-a-class-library-for-entity-models-using-sql-server)
2022-12-29 13:49:34 +01:00
# Page 733 - Building customer create, edit, and delete components
> Thanks to [Bob Molloy](https://github.com/BobMolloy) for raising this [issue on 27 December 2022](https://github.com/markjprice/cs11dotnet7/issues/15).
In Step 4, in the file named `EditCustomer.razor`, the code for the `Update` method is missing the last statement to navigate to the `customers` page component after updating the customer in the database, as shown in the following code:
```cs
private async Task Update()
{
if (customer is not null)
{
await service.UpdateCustomerAsync(customer);
}
navigation.NavigateTo("customers");
}
```