Blazor CRUD scaffolding updates about scaffolding HOT 16 OPEN

Unfortunately, I don't think we ever formalized our Blazor style guide, but in product code (templates, scaffolding, etc) I think we generally only prefix with @ when required. I wouldn't jump to update the docs to do this just yet though.

from scaffolding.

Two of the components cross-link for more information on overposting ...

// To protect from overposting attacks, see https://aka.ms/RazorPagesCRUD

Cross-refs:

• https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Create.tt#L66
• https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Edit.tt#L92

However, that's not a very helpful cross-link because it lands here ...

https://learn.microsoft.com/en-us/aspnet/core/data/ef-rp/crud?view=aspnetcore-8.0#update-the-create-page

... with API and an approach that isn't available in a Razor component scenario.

We now have a new overposting section in the Blazor Forms overview article. Update the Create and Edit templates to point to the Blazor content. Here's the doc URL:

https://learn.microsoft.com/aspnet/core/blazor/forms/#mitigate-overposting-attacks

... and I can't create an aka.ms address for it. If an aka.ms address is created by someone, make sure that it's version agnostic and without a culture segment.

from scaffolding.

Hey @guardrex, thanks a lot for the incoming feedback, looking at it currently and fixing the templates accordingly.

from scaffolding.

In this file ...

Shouldn't ...

public @Model.DbContextTypeName (DbContextOptions<@Model.DbContextTypeName> options)

... be ...

public @(Model.DbContextTypeName)(DbContextOptions<@Model.DbContextTypeName> options)

... because I see a stray space in the code ...

public BlazorWebAppMoviesContext (DbContextOptions<BlazorWebAppMoviesContext> options)

from scaffolding.

More NITs 😈 ...

• Remove the blank line at https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Create.tt#L62.

• Add an explicit private access modifier to the following lines to match our Blazor conventions (purple NOTE box) ...

  • https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Details.tt#L60
  • https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Delete.tt#L62
  • https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Edit.tt#L116

• Throughout the project, including in Program.cs, the using/@using statements/directives are out of order. See 👉 https://learn.microsoft.com/en-us/aspnet/core/blazor/components/?view=aspnetcore-8.0#razor-syntax for the docs conventions, which I hope we can match to avoid an obvious inconsistency between code and docs.

from scaffolding.

In the file ...

https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Edit.tt

... the model isn't lowercased to match what's done for the other components of the set ...

- @page "/<#= pluralModel #>/edit"
+ @page "/<#= pluralModelLowerInv #>/edit"

Because of it, the path comes out (for example using a movies database example) ...

@page "/Movies/edit"

... instead of the expected ...

@page "/movies/edit"

from scaffolding.

The following cross-links will need to be removed because TryUpdateModelAsync, which is a focus of the cross-linked content, is Mvc.ControllerBase/RazorPages.PageBase API of MVC/RP and not available for Razor components to use.

• https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Create.tt#L66
• https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Edit.tt#L91-L92
• https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Create.cs#L99-L100
• https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Edit.cs#L134-L135

WRT documentation coverage: The Blazor Web App tutorial (in progress) will touch on overposting with a short section, and I think we're going to have a special Blazor static SSR form overposting section in our Blazor forms article coverage. If so, I'll open a follow-up issue on this repo to get a new link placed that points to the new coverage.

UPDATE

Opened ...

Add Blazor forms overposting coverage
dotnet/AspNetCore.Docs#32733

... to place Blazor-specific overposting coverage. After coverage goes live, I'll open a new scaffolder repo issue to get the Blazor cross-links into the Blazor bits here and remove the main doc set cross-link. The main doc set coverage will be linked via the Blazor coverage, so devs will still be able to reach it for more info.

from scaffolding.

Not sure @danroth27 on this one: I thought you said that you were aligning the PU and doc conventions. I see in the scaffolded code ...

<QuickGrid Class="table" Items="DB.Movie">

Cross-ref: https://github.com/dotnet/Scaffolding/blob/main/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Index.tt#L37

... but I expected ...

<QuickGrid Class="table" Items="@DB.Movie">

... to match the doc convention, which always calls for @ to avoid ambiguity with string literals for component param values.

However, I also recall a convo where it was said that @ would only prefix when required. I probably said at the time that to make the docs adopt that convention that it's a big job. It's been the convention in docs going back to Blazor ancient times 👴 ... worked out with Ryan and/or Pranav IIRC 🤔, and I don't have an open issue or work item on the docs side to change the convention (yet 😄).

from scaffolding.

There are also extra spaces in the Razor markup files of the CRUD components.

from scaffolding.

Missing private access modifier from the Edit component's {MODEL NAME}Exists method, which is explicitly stated for doc coverage by convention ...

- bool <#= modelName #>Exists(<#= primaryKeyShortTypeName #> <#= primaryKeyNameLowerInv #>) 
+ private bool <#= modelName #>Exists(<#= primaryKeyShortTypeName #> <#= primaryKeyNameLowerInv #>) 

from scaffolding.

I'm not sure where this is located (probably over in the main repo actually), but there isn't a return on the last line of the appsettings.json file ...

I'll go look now and see if this is in the project template over there. BRB ....................

The serviceDependencies.json file has the same problem ...

... and this one ...

Those are the only ones. Every other file is fine.

I'm not sure where those are located, here or back on the main repo. I'll leave this comment here in case the PU engineer wants to hunt them down and put in a fix for them.

from scaffolding.

"namespace" is misspelled in three spots ...

https://github.com/search?q=repo%3Adotnet%2FScaffolding%20namesapce&type=code

from scaffolding.

Not related to Blazor, but something that I'll pile on here WRT the minimalapi generator ...

The help list of options doesn't look right ...

Selected Code Generator: minimalapi

Generator Arguments:
  -e|--endpoints                  : Endpoints class to use. (not file name)
  -m|--model                      : Model class to use
  -dc|--dataContext               : DbContext class to use
  -outDir|--relativeFolderPath    : Specify the relative output folder path from project where the file needs to be generated, if not specified, file will be generated in the project folder
  -o|--open                       : Use this option to enable OpenAPI
  -namespace|--endpointsNamespace : Specify the name of the namespace to use for the generated Endpoints file
  databaseProvider                : Database provider to use. Options include 'sqlserver' (default), 'sqlite', 'cosmos', 'postgres'.
  useSqLite                       : Flag to specify if DbContext should use SQLite instead of SQL Server.

... the last two (databaseProvider and useSqLite) don't have the proper command formats and don't have a short name command.

from scaffolding.