dotnet / aspnetcore.docs.samples Goto Github PK

Problem details code returns

{"type":"https://wikipedia.org/wiki/Division_by_zero",
"title":"Wrong Input",
"status":404,
"detail":"Divison by zero is not defined."}

When there is no endpoint rather than just 404.

@sammychinedu2ky fixed that by adding HasPath, but that's an error prone solution.

@brunolins16 can you suggest a better mechanism to detect when there's no matching endpoint?

Rate limiting middleware improvements

• Code to update
• Add [EnableRateLimitingAttribute("MyControllerPolicy")] to Home2Controller
• disable rate limiting on a specific endpoint within that group
• apply policies directly to endpoints.
• add an instance of it directly to an endpoint
• Add

builder.Services.AddRateLimiter(options =>
{
   options.AddTokenBucketLimiter("MyControllerPolicy", options =>
   {
       options.TokenLimit = 1;
       options.QueueProcessingOrder = QueueProcessingOrder.OldestFirst;
       options.QueueLimit = 1;
       options.ReplenishmentPeriod = TimeSpan.FromSeconds(10);
       options.TokensPerPeriod = 1;
   })
   .AddPolicy<string>("MyGroupPolicy", new MyRateLimiterPolicy());
});

Then @Rick-Anderson can update Rate limiting middleware in ASP.NET Core

@Kahbazi can you do these updates?

Also, the updates requested in #14

In https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/mvc/models folder

Use in memory DB.
also show how to add a model error to the model, not the property:

ModelState.AddModelError(string.Empty, "My error message");

see dotnet/AspNetCore.Docs#27861

Use a service per #13 (comment)

Put the code in this folder and delete the readme.md.

Add options.RejectionStatusCode = StatusCodes.Status429TooManyRequests; to JWT sample

@Kahbazi can you PR that?

See the note just above Test app prerequisites

When creating a test project for an app, separate the unit tests from the integration tests into different projects. This helps ensure that infrastructure testing components aren't accidentally included in the unit tests. Separation of unit and integration tests also allows control over which set of tests are run.

@fiyazbinhasan can you split out your integration and unit tests?

https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/test/integration-tests/IntegrationTestsSample

See the sentence just above this link

The EF-Core in-memory database provider can be used for limited and basic testing, however the SQLite provider is the recommended choice for in-memory testing.

fundamentals/minimal-apis/samples/IResultImplementation/Tests/IResultImplementationTest.cs

Create sample code. See https://devblogs.microsoft.com/dotnet/asp-net-core-updates-in-dotnet-7-preview-4/

Possibly same code can do dotnet/sdk#77

See Typed results for minimal APIs

It would be great to have the sample from that blog here. You can get the starter project code from https://github.com/dotnet/AspNetCore.Docs/tree/main/aspnetcore/tutorials/first-web-api/samples/6.0/TodoApi

Create your new project in a new folder typed-results under https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/fundamentals/minimal-apis/samples

See tests in https://github.com/dotnet/aspnetcore/tree/main/src/Mvc/Mvc.ApiExplorer/test

cc @sammychinedu2ky if you're interested.

@brunolins16 is the expert on this. See dotnet/aspnetcore#40656

Change this line to

 public static async Task<Ok<Todo[]>> GetAllTodos(TodoGroupDbContext database)
    {
        var todos = await database.Todos.ToArrayAsync();
        return TypedResults.Ok(todos);
    }

and changed test that uses that endpoint

cc @fiyazbinhasan

Related to dotnet/AspNetCore.Docs#28850

rewritten test must include test of returned result type

/ Assert: Check the returned result type is correct
    Assert.IsType<Ok<Todo[]>>(result);

Consider the following code:

using Microsoft.AspNetCore.RateLimiting;
using System.Threading.RateLimiting;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRateLimiter(_ => _
    .AddFixedWindowLimiter(policyName: "fixed", options =>
    {
        options.PermitLimit = 4;
        options.Window = TimeSpan.FromSeconds(120);
        options.QueueProcessingOrder = QueueProcessingOrder.OldestFirst;
        options.QueueLimit = 2;
    }));

var app = builder.Build();

app.UseRateLimiter();

static string GetTicks() => (DateTime.Now.Ticks & 0x11111).ToString("00000");

app.MapGet("/", () => Results.Ok($"Hello {GetTicks()}"))
                           .RequireRateLimiting("fixed");

app.Run();

Browse to / on localhost and quickly hit refresh multiple times. After the rate limit is hit, the browser doesn't show a problem, it's displaying the last response. F12 tools don't show any thing and there is nothing in the log.

@wtgodbe how can the client be notified? What's the best way to log this? Why isn't the default rejection status 503 returned?
cc @fiyazbinhasan

In MinApiTestsSample, create at least one sample that uses the IResult implementation types are now publicly available from Improved unit testability for minimal route handlers

@brunolins16 dotnet/aspnetcore#40965 mentions all these <HTTP Status>HttpResult mentioned in the blog, but they're no longer in the source and I can't find a PR where they were renamed. The history of Results.cs doesn't make the renaming obvious. Please advise.

See Antiforgery integration for minimal APIs

and this sample

In this code I pass in the action so

app.MapGet("/DisableAntiforgery", () =>
{
    return Results.Content(MyHtml.html("/todo"), "text/html");
});

app.MapGet("/post2", () =>
{
    return Results.Content(MyHtml.html("/todo2"), "text/html");
});

Can use the same HTML when they pass in the action arg.

Is there a clean way to do this to pass in an arg for

<input name="{token.FormFieldName}" 
                              type="hidden" value="{token.RequestToken}" />

Maybe that makes things too messy. Perhaps I should duplicate most of the HTML and not get the HTML from a method while passing the action.

public static string html2(string action, AntiforgeryTokenSet token) => $"""
    <html><body>
        <form action="{action}" method="POST" enctype="multipart/form-data">
            <input name="{token.FormFieldName}" 
                          type="hidden" value="{token.RequestToken}" />
            <input type="text" name="name" />
            <input type="date" name="dueDate" />
            <input type="checkbox" name="isCompleted" />
            <input type="submit" />
        </form>
    </body></html>
""";

Works, but I'm not sure it's an improvement. There's no way to pass in a null token.

@sammychinedu2ky @david-acker

cc @guardrex

https://github.com/dotnet/AspNetCore.Docs.Samples/blob/f0867786d7a46a80ce19d10950f9816a4071abae/fundamentals/minimal-apis/samples/MinApiTestsSample/IntegrationTests/IntegrationTests.csproj#L13C48-L13C48

As dotnet test tool suggests, this ref is only needed in .NET Core projects, but not in .NET 7

Trying to avoid horizontal scroll bars in the rendered articles.

An example of how to use the new identity API with a standalone Blazor WebAssembly app.

Hello everyone!

I've been delving into the Identity Documentation, particularly the sections covering 2FA with Razor Pages, and it's been an enlightening experience!

However, I'm currently facing a gap in documentation when it comes to integrating 2FA with Single Page Applications (SPAs).

Would it be possible to provide a comprehensive example for 2FA with ASP.NET Core Identity and Angular? I'm specifically interested in understanding how to leverage endpoints for seamless SPA integration. Unfortunately, I couldn't find any information related to 2FA TOTP in the Angular Sample.

This addition would immensely benefit developers looking for a thorough guide on 2FA integration with Angular. Your efforts in this regard would be highly appreciated! Thank you!

Need dedicated sample for Route groups with MapGroup
@sammychinedu2ky can you create a PR here with your code from dotnet/AspNetCore.Docs#26476 so we have code dedicated to route groups. I think maintaining the same code for testing and routegroups might be a problem.

Create a folder routeGroups under https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/fundamentals/minimal-apis/samples

Could you please provide the license information for your examples? We are uncertain which license applies to the examples and would appreciate it if you could add the relevant license information to the repository. Additionally, we would like to confirm if it is permissible to use the examples (e.g. test/integration-tests/IntegrationTestsSample) in our own public repository. Thank you.

ASP.NET Core streaming sample to be cross platform. See this comment

@logiclrd do you have an ETA for that?

Return multiple result types from minimal APIs

Possibly same code can do #76

Write sample in https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/fundamentals/minimal-apis/samples/openApi (create folder openApi)

OpenAPI improvements for minimal APIs

Create sample that generates a problem details response from middleware:

@sammychinedu2ky are you interested in this?

See https://devblogs.microsoft.com/dotnet/asp-net-core-updates-in-net-7-preview-1/
Put in https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/fundamentals/minimal-apis/samples/IFormFile

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.MapGet("/", () => "Hello World!");

app.MapPost("/fileUp", async (IFormFile file) =>
{
    string tempfile = Path.GetTempFileName();
    using var stream = File.OpenWrite(tempfile);
    await file.CopyToAsync(stream);
});

app.MapPost("/FilesUp", async (IFormFileCollection myFiles) =>
{
    foreach (var file in myFiles)
    {
        string tempfile = Path.GetTempFileName();
        using var stream = File.OpenWrite(tempfile);
        await file.CopyToAsync(stream);
    }
});

app.Run();

Update readme.txt with instructions on testing.

See Improved support for custom authorization policies with IAuthorizationRequirementData

ToDo:

• Fix all the null warnings and other warnings
• Fix 415 error

See the project here

1. Create a token and DOB via this command and save token
2. run the app
3. curl -i -H "Authorization: Bearer <token>" http://localhost:{port}/api/greetings/hello

Output shows:

Evaluating authorization requirement for age >= 16
info: MinimumAgeAuthorizationHandler[0]
      Minimum age authorization requirement 16 satisfied

But request returns a 415 error.

@kevinchalet can you help? CC @jxwaters if you can help

contributes to dotnet/AspNetCore.Docs#29291

See the middleware version

/api/values/Squareroot/-1 returns the generic type and title
{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Bad Request",
not the type and title that's set
{"type":"https://en.wikipedia.org/wiki/Square_root","title":"Wrong Input"

When I Customize problem details with CustomizeProblemDetails see also source code

the API controller returns the correct problem details.

When I step through the middleware version in the debugger, everything is set correctly.

@sammychinedu2ky

Update the model:

public class Contact
{
    public int Id { get; set; }

    public string Name { get; set; } = String.Empty;
    public string ShortName { get; set; } = String.Empty;
    public string Email { get; set; } = String.Empty;
    public string PhoneNumber { get; set; } = String.Empty;
}

Then have a validation check like:

        if (Contact.Name == Contact.ShortName) {
            ModelState.AddModelError(nameof(Contact.ShortName),
                                               "Short name can't be the same as Name.");
        }

Code at https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/mvc/models/ModelStateError

It's easier to delete the existing code and create a new project and scaffold it.

Bonus points if you move from MVC to Razor Pages.

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

• ID: 0156ffc3-47ac-d5da-fbc2-9ff5018b071b
• Version Independent ID: 615db388-a244-41f7-21b5-a4085d9ed479
• Content: Model validation in ASP.NET Core MVC
• Content Source: aspnetcore/mvc/models/validation.md
• Product: aspnet-core
• Technology: aspnetcore-mvc
• GitHub Login: @Rick-Anderson
• Microsoft Alias: riande

IProblemDetailsWriter from problem details response

In https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/fundamentals/middleware/problem-details-service or write a new sample in https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/fundamentals/middleware

cc @sammychinedu2ky

Trying to do the Arrangement based on IndexPageTests.cs but a failure came and said that no such table.

Until

db.Database.EnsureCreated();

was added in a line before

Utilities.ReinitializeDbForTests(db);

So it's look like this
db.Database.EnsureCreated();
Utilities.ReinitializeDbForTests(db);

I am wondering, why is it necessary

https://github.com/dotnet/AspNetCore.Docs.Samples/blob/main/test/integration-tests/IntegrationTestsSample/tests/RazorPagesProject.Tests/IntegrationTests/IndexPageTests.cs

EXPOSE instructions should have the following characteristics:

• Match ASP.NET Core defaults.
• No TLS/HTTPS since that's a deployment concern

Ideally, we wouldn't need to use EXPOSE at all, but I'm guessing that VS Code relies on it.

https://github.com/search?q=repo%3Adotnet%2FAspNetCore.Docs.Samples%20EXPOSE&type=code

FYI for .NET 8: dotnet/core#8133 (comment)

See this comment

[JsonSerializable(typeof(Todo[]))]
internal partial class AppJsonSerializerContext : JsonSerializerContext

And more can likely be removed from many of these samples

cc @timdeschryver