[Alpha] Add new route functions (...WithExtensions) #634
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| open System | ||
| open Microsoft.AspNetCore.Http | ||
| open Microsoft.AspNetCore.Builder | ||
| open Microsoft.Extensions.DependencyInjection | ||
| open Microsoft.Extensions.Hosting | ||
| open Giraffe | ||
| open Giraffe.EndpointRouting | ||
| open Microsoft.AspNetCore.RateLimiting | ||
| open System.Threading.RateLimiting | ||
|
|
||
| let MY_RATE_LIMITER = "fixed" | ||
|
|
||
| let endpoints: list<Endpoint> = | ||
| [ | ||
| GET [ | ||
| routeWithExtensions (fun eb -> eb.RequireRateLimiting MY_RATE_LIMITER) "/rate-limit" (text "Hello World") | ||
| route "/no-rate-limit" (text "Hello World: No Rate Limit!") | ||
| ] | ||
| ] | ||
|
|
||
| let notFoundHandler = text "Not Found" |> RequestErrors.notFound | ||
|
|
||
| let configureApp (appBuilder: IApplicationBuilder) = | ||
| appBuilder.UseRouting().UseRateLimiter().UseGiraffe(endpoints).UseGiraffe(notFoundHandler) | ||
|
|
||
| let configureServices (services: IServiceCollection) = | ||
| // From https://learn.microsoft.com/en-us/aspnet/core/performance/rate-limit?view=aspnetcore-8.0#fixed-window-limiter | ||
| let configureRateLimiter (rateLimiterOptions: RateLimiterOptions) = | ||
| rateLimiterOptions.RejectionStatusCode <- StatusCodes.Status429TooManyRequests | ||
|
|
||
| rateLimiterOptions.AddFixedWindowLimiter( | ||
| policyName = MY_RATE_LIMITER, | ||
| configureOptions = | ||
| (fun (options: FixedWindowRateLimiterOptions) -> | ||
| options.PermitLimit <- 10 | ||
| options.Window <- TimeSpan.FromSeconds(int64 12) | ||
| options.QueueProcessingOrder <- QueueProcessingOrder.OldestFirst | ||
| options.QueueLimit <- 1 | ||
| ) | ||
| ) | ||
| |> ignore | ||
|
|
||
| services.AddRateLimiter(configureRateLimiter).AddRouting().AddGiraffe() | ||
| |> ignore | ||
|
|
||
| [<EntryPoint>] | ||
| let main args = | ||
| let builder = WebApplication.CreateBuilder(args) | ||
| configureServices builder.Services | ||
|
|
||
| let app = builder.Build() | ||
|
|
||
| configureApp app | ||
| app.Run() | ||
|
|
||
| 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Rate Limiting Sample | ||
|
|
||
| This sample project shows how one can configure ASP.NET's built-in [rate limiting middleware](https://learn.microsoft.com/en-us/aspnet/core/performance/rate-limit?view=aspnetcore-8.0). | ||
|
|
||
| Notice that this rate limiting configuration is very simple, and for real life scenarios you'll need to figure out what is the best strategy to use for your server. | ||
|
|
||
| To make it easier to test this project locally, and see the rate limiting middleware working, you can use the `rate-limiting-test.fsx` script: | ||
|
|
||
| ```bash | ||
| # start the server | ||
| dotnet run . | ||
| # if you want to keep using the same terminal, just start this process in the background | ||
|
|
||
| # then, you can use this script to test the server, and confirm that the rate-limiting | ||
| # middleware is really working | ||
| dotnet fsi rate-limiting-test.fsx | ||
|
|
||
| # to run with the DEBUG flag active | ||
| dotnet fsi --define:DEBUG rate-limiting-test.fsx | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <OutputType>Exe</OutputType> | ||
| <TargetFramework>net9.0</TargetFramework> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Compile Include="Program.fs" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="../../src/Giraffe/Giraffe.fsproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| open System | ||
| open System.Net.Http | ||
|
|
||
| let request = new HttpClient(BaseAddress = new Uri("http://localhost:5000")) | ||
|
|
||
| let program () = | ||
| async { | ||
| let! reqResult1 = | ||
| seq { 1..100 } | ||
| |> Seq.map (fun _ -> request.GetAsync "/no-rate-limit" |> Async.AwaitTask) | ||
| |> Async.Parallel | ||
|
|
||
| reqResult1 | ||
| #if DEBUG | ||
| |> Seq.iteri (fun i response -> | ||
| printfn "\nResponse %i status code: %A" i response.StatusCode | ||
|
|
||
| let responseReader = new StreamReader(response.Content.ReadAsStream()) | ||
| printfn "Response %i content: %A" i (responseReader.ReadToEnd()) | ||
| ) | ||
| #else | ||
| |> Seq.groupBy (fun response -> response.StatusCode) | ||
| |> Seq.iter (fun (group) -> | ||
| let key, seqRes = group | ||
| printfn "Quantity of requests with status code %A: %i" (key) (Seq.length seqRes) | ||
| ) | ||
| #endif | ||
|
|
||
| printfn "\nWith rate limit now...\n" | ||
|
|
||
| let! reqResult2 = | ||
| seq { 1..100 } | ||
| |> Seq.map (fun _ -> request.GetAsync "/rate-limit" |> Async.AwaitTask) | ||
| |> Async.Parallel | ||
|
|
||
| reqResult2 | ||
| #if DEBUG | ||
| |> Seq.iteri (fun i response -> | ||
| printfn "\nResponse %i status code: %A" i response.StatusCode | ||
|
|
||
| let responseReader = new StreamReader(response.Content.ReadAsStream()) | ||
| printfn "Response %i content: %A" i (responseReader.ReadToEnd()) | ||
| ) | ||
| #else | ||
| |> Seq.groupBy (fun response -> response.StatusCode) | ||
| |> Seq.iter (fun (group) -> | ||
| let key, seqRes = group | ||
| printfn "Quantity of requests with status code %A: %i\n" (key) (Seq.length seqRes) | ||
| ) | ||
| #endif | ||
| } | ||
|
|
||
| #time | ||
|
|
||
| program () |> Async.RunSynchronously | ||
|
|
||
| #time |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-alpha-001 or however it is done here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch, done!