Blazor CRUD scaffolding updates #2743

guardrex · 2024-05-13T17:48:52Z

I'm going to place everything that I find in this one issue (several comments). If you want me 🦖 to PR the updates, I can do it after I'm done writing a large tutorial that makes use of this scaffolding in a few weeks.

~~Should the semicolons in the Block entries of the following file be there?~~

Scaffolding/src/Scaffolding/VS.Web.CG.Mvc/Blazor/blazorWebCrudChanges.json

Line 10 in d30f294

"Block": "WebApplication.CreateBuilder.Services.AddQuickGridEntityFrameworkAdapter();",
Scaffolding/src/Scaffolding/VS.Web.CG.Mvc/Blazor/blazorWebCrudChanges.json

Line 17 in d30f294

"Block": "WebApplication.CreateBuilder.Services.AddQuickGridEntityFrameworkAdapter();",

~~I think I received a double semicolon (unless it was due to a stray keystroke on my part 😈) ...~~

builder.Services.AddQuickGridEntityFrameworkAdapter();;

Nevermind! The double-semicolon seems to have been a stray keystroke on my part.

The text was updated successfully, but these errors were encountered:

guardrex · 2024-05-13T18:09:02Z

IGNORE (probably)

VS is suggesting a primary ctor, so this code will go away. See my comment at ...

#2743 (comment)

~~In this file ...~~

Scaffolding/src/Scaffolding/VS.Web.CG.EFCore/Templates/DbContext/NewLocalDbContext.cshtml

Line 43 in d30f294

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

~~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)

guardrex · 2024-05-16T11:30:33Z

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) ...
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.

guardrex · 2024-05-16T11:38:08Z

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"

guardrex · 2024-05-16T12:18:13Z

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.

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.

danroth27 · 2024-05-28T19:00:58Z

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.

guardrex · 2024-05-30T12:24:35Z

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

guardrex · 2024-06-03T17:59:06Z

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

Scaffolding/src/Scaffolding/VS.Web.CG.Mvc/Templates/Blazor/Edit.tt

Line 116 in d30f294

    
           bool <#= modelName #>Exists(<#= primaryKeyShortTypeName #> <#= primaryKeyNameLowerInv #>)

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

guardrex · 2024-06-04T13:13:51Z

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.

guardrex · 2024-06-17T13:36:14Z

"namespace" is misspelled in three spots ...

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

guardrex · 2024-06-17T13:46:16Z

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.

guardrex · 2024-06-20T16:43:03Z

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

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

Cross-refs:

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.

deepchoudhery · 2024-06-26T21:40:10Z

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

guardrex · 2024-07-11T18:05:11Z

@deepchoudhery ... Nevermind on the comment that I left here. I forgot for a moment that we're changing our documentation descriptions and examples to avoid prefixing nonliterals with @, so what you have in the scaffolding code is fine 👍 ...

<QuickGrid Class="table" Items="DbFactory.CreateDbContext().{CLASS}">

... is correct, no @ on DbFactory.CreateDbContext().{CLASS}.

I'm still getting used to this because we've gone about five years the other way. Old habits are hard to break! 😄

deepchoudhery · 2024-07-11T20:03:48Z

All good, going to go through this issue again soon and catalog remaining changes into a comment for easier tracking.

guardrex · 2024-07-12T18:19:55Z

Found another one ... there's a blank line after the opening @page directive. Although many community devs do that, we don't do it in Blazor documentation. I recommend that you collapse that down to a single block of Razor directives.

This extra line is in all of the component files: Index, Create, Edit, Delete, and Details.

- @page "/movies"
- 
- @using Microsoft.EntityFrameworkCore
- @using Microsoft.AspNetCore.Components.QuickGrid
- @using BlazorWebAppMovies.Models
- @inject IDbContextFactory<BlazorWebAppMovies.Data.BlazorWebAppMoviesContext> DbFactory
+ @page "/movies"
+ @using Microsoft.EntityFrameworkCore
+ @using Microsoft.AspNetCore.Components.QuickGrid
+ @using BlazorWebAppMovies.Models
+ @inject IDbContextFactory<BlazorWebAppMovies.Data.BlazorWebAppMoviesContext> DbFactory

guardrex · 2024-08-14T12:12:37Z

@danroth27 ... I'm not sure if we're proceeding with the tutorial updates because not all of the scaffolding updates are done yet. If they're worked piecemeal, I need to go back into the tutorial files repeatedly (or again after 9.0 GA) ... it's time consuming to repeatedly revisit it ... thus costly 💰.

Nevermind on the next bit ... the packages updated right after I mentioned it ........

~~Also, I just ran the scaffolder after a Pre7 SDK/VS updates to find the scaffolded code hasn't changed yet ...~~

<QuickGrid Class="table" Items="DbFactory.CreateDbContext().Movie">
    ...
</QuickGrid>

~~I see the template file is updated ...~~

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

~~When will the package(s) update?~~

guardrex · 2024-08-22T13:29:42Z

VS static analysis is suggesting a primary ctor in Data/BlazorWebAppMoviesContext.cs ...

public class BlazorWebAppMoviesContext(DbContextOptions<BlazorWebAppMoviesContext> options) : DbContext(options)
{
    public DbSet<BlazorWebAppMovies.Models.Movie> Movie { get; set; } = default!;
}

guardrex · 2024-10-31T10:39:14Z

One more ......

The docs favor naming the injected NavigationManager as "Navigation" for use in components to assist with keeping line lengths shorter for display in articles.

@inject NavigationManager Navigation

...

Navigation.XXXXX

This would be a helpful change for consistency with the rest of the articles.

guardrex · 2024-11-15T11:41:30Z

I have another one ...

In the Index CRUD component, the full namespace is appearing for the context (BlazorWebAppMoviesContext) ...

@inject IDbContextFactory<BlazorWebAppMovies.Data.BlazorWebAppMoviesContext> DbFactory

However, the component already uses BlazorWebAppMovies.Data ...

@using BlazorWebAppMovies.Data

... so it would be best to 🔪 it from the context for ...

@inject IDbContextFactory<BlazorWebAppMoviesContext> DbFactory

This situation is only found in the Index CRUD component. The others don't have an @using for BlazorWebAppMovies.Data.

deepchoudhery · 2024-11-15T20:14:33Z

sounds good, will get these 2 fixed in next servicing. Do they apply to both .NET 8 and 9 scenarios?

guardrex · 2024-11-15T20:43:20Z

Yes, both 8.0 and 9.0 for both of them.

... and I recall that you said the primary ctor change would take place later because it's a larger task that applies in more spots.

deepchoudhery · 2024-11-15T21:40:44Z

ah yes sounds about right. i'll get all these in together tyty

guardrex added area-scaffolding customer-reported labels May 13, 2024

guardrex changed the title ~~Double semicolon for scaffolding into a Blazor Web App~~ Blazor CRUD scaffolding updates May 16, 2024

guardrex mentioned this issue May 16, 2024

Lowercase the model path segment for the Edit component of the CRUD set #2746

Closed

This comment was marked as resolved.

Sign in to view

deepchoudhery mentioned this issue Aug 22, 2024

blazor-crud scaffolder minor fixes #2938

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Blazor CRUD scaffolding updates #2743

Blazor CRUD scaffolding updates #2743

guardrex commented May 13, 2024 •

edited

Loading

guardrex commented May 13, 2024 •

edited

Loading

guardrex commented May 16, 2024

guardrex commented May 16, 2024

guardrex commented May 16, 2024 •

edited

Loading

This comment was marked as resolved.

danroth27 commented May 28, 2024

guardrex commented May 30, 2024

guardrex commented Jun 3, 2024 •

edited

Loading

guardrex commented Jun 4, 2024 •

edited

Loading

guardrex commented Jun 17, 2024

guardrex commented Jun 17, 2024 •

edited

Loading

guardrex commented Jun 20, 2024

deepchoudhery commented Jun 26, 2024

guardrex commented Jul 11, 2024 •

edited

Loading

deepchoudhery commented Jul 11, 2024

guardrex commented Jul 12, 2024 •

edited

Loading

guardrex commented Aug 14, 2024 •

edited

Loading

guardrex commented Aug 22, 2024

guardrex commented Oct 31, 2024

guardrex commented Nov 15, 2024 •

edited

Loading

deepchoudhery commented Nov 15, 2024

guardrex commented Nov 15, 2024

deepchoudhery commented Nov 15, 2024

Blazor CRUD scaffolding updates #2743

Blazor CRUD scaffolding updates #2743

Comments

guardrex commented May 13, 2024 • edited Loading

I'm going to place everything that I find in this one issue (several comments). If you want me 🦖 to PR the updates, I can do it after I'm done writing a large tutorial that makes use of this scaffolding in a few weeks.

guardrex commented May 13, 2024 • edited Loading

IGNORE (probably)

guardrex commented May 16, 2024

guardrex commented May 16, 2024

guardrex commented May 16, 2024 • edited Loading

UPDATE

This comment was marked as resolved.

danroth27 commented May 28, 2024

guardrex commented May 30, 2024

guardrex commented Jun 3, 2024 • edited Loading

guardrex commented Jun 4, 2024 • edited Loading

guardrex commented Jun 17, 2024

guardrex commented Jun 17, 2024 • edited Loading

guardrex commented Jun 20, 2024

deepchoudhery commented Jun 26, 2024

guardrex commented Jul 11, 2024 • edited Loading

deepchoudhery commented Jul 11, 2024

guardrex commented Jul 12, 2024 • edited Loading

guardrex commented Aug 14, 2024 • edited Loading

Nevermind on the next bit ... the packages updated right after I mentioned it ........

guardrex commented Aug 22, 2024

guardrex commented Oct 31, 2024

guardrex commented Nov 15, 2024 • edited Loading

deepchoudhery commented Nov 15, 2024

guardrex commented Nov 15, 2024

deepchoudhery commented Nov 15, 2024

guardrex commented May 13, 2024 •

edited

Loading

guardrex commented May 13, 2024 •

edited

Loading

guardrex commented May 16, 2024 •

edited

Loading

guardrex commented Jun 3, 2024 •

edited

Loading

guardrex commented Jun 4, 2024 •

edited

Loading

guardrex commented Jun 17, 2024 •

edited

Loading

guardrex commented Jul 11, 2024 •

edited

Loading

guardrex commented Jul 12, 2024 •

edited

Loading

guardrex commented Aug 14, 2024 •

edited

Loading

guardrex commented Nov 15, 2024 •

edited

Loading