FSharp giraffe #3859

dv00d00 · 2018-06-12T11:42:22Z

Added FSharp language with giraffe implementation of plaintext, json, and jsonutf8 endpoints

benaadams · 2018-06-12T13:06:55Z

frameworks/FSharp/giraffe/src/App/Program.fs

+ .UseKestrel() 
+ .Configure(Action<IApplicationBuilder> configureApp)
+ .ConfigureServices(configureServices)
+ .ConfigureLogging(configureLogging)


Don't configure logging
Rule 3.

All test implementations must disable all disk logging. For many reasons, we expect all tests will run without writing logs to disk. Most importantly, the volume of requests is sufficiently high to fill up disks even with only a single line written to disk per request. Please disable all forms of disk logging. We recommend but do not require disabling console logging as well.

Every other framework disables logging completely so having it enabled will be a disadvantage

benaadams · 2018-06-12T13:08:13Z

frameworks/FSharp/giraffe/src/App/Program.fs

+// ---------------------------------
+
+let configureApp (app : IApplicationBuilder) =
+ let env = app.ApplicationServices.GetService<IHostingEnvironment>()


Remove both error handlers (for same reason as logging)

benaadams · 2018-06-12T13:09:25Z

frameworks/FSharp/giraffe/src/App/web.config

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>


Don't need this file, is used when behind IIS

benaadams · 2018-06-12T13:10:41Z

frameworks/FSharp/giraffe/src/App/Program.fs

+let jsonUtf8 (data:obj) : HttpHandler =
+ fun (next : HttpFunc) (ctx : HttpContext) ->
+ let bytes = Utf8Json.JsonSerializer.Serialize(data)
+ ctx.SetContentType "application/json"


Additionally set the content length (bytes.Length); otherwise it will go as chunked encoding which is slightly larger and a little more involved.

benaadams · 2018-06-12T13:15:24Z

frameworks/FSharp/giraffe/src/App/Program.fs

+ choose [
+ route "/plaintext" >=> text "Hello, World!"
+ route "/json" >=> json { message = "Hello, World!" }
+ route "/jsonutf8" >=> jsonUtf8 { message = "Hello, World!" }


Will need to add a second dockerfile for this second json route (that's identical to first)
giraffe-utf8json.dockerfile

Then add a new entry in benchmark_config.json for the json

"utf8json": { "json_url": "/jsonutf8", ...

benaadams · 2018-06-12T13:17:31Z

frameworks/FSharp/giraffe/benchmark_config.json

+ "json_url": "/json",
+ "port": 8080,
+ "approach": "Realistic",
+ "classification": "Full",


Needs to be Fullstack

benaadams · 2018-06-12T13:18:40Z

frameworks/FSharp/giraffe/src/App/App.fsproj

+ <PackageReference Include="Microsoft.AspNetCore.StaticFiles" Version="2.1.0" />
+ <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="2.1.0" />
+ <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="2.1.0" />
+ <PackageReference Include="Microsoft.AspNetCore.Authentication.Cookies" Version="2.1.0" />


Some of these PackageReferences can be trimmed

benaadams · 2018-06-12T13:19:04Z

frameworks/FSharp/giraffe/src/App/App.sln

@@ -0,0 +1,25 @@
+


Don't need the sln file; up to you though

benaadams · 2018-06-12T13:19:32Z

frameworks/FSharp/giraffe/src/App/Program.fs

+open System
+open Microsoft.AspNetCore.Builder
+open Microsoft.AspNetCore.Hosting
+open Microsoft.Extensions.Logging


Some of these can be trimmed

dv00d00 · 2018-06-12T14:00:25Z

I will need to check if docker actually able to run the app. It died on my work machine after latest windows update

benaadams · 2018-06-12T14:01:08Z

frameworks/FSharp/giraffe/benchmark_config.json

+ }
+ },
+ {
+ "jsonutf8": {


nit: Call it utf8json to match the library name?

Then it will appear in the listings as giraffe-utf8json as per https://github.com/TechEmpower/FrameworkBenchmarks/blob/master/frameworks/CSharp/aspnetcore/benchmark_config.json#L82

Url can remain the same

benaadams · 2018-06-12T14:01:49Z

frameworks/FSharp/giraffe/benchmark_config.json

+ },
+ {
+ "jsonutf8": {
+ "plaintext_url": "/plaintext",


nit: Don't need plaintext entry for this one as nothing is different for plaintext, so no reason to test it twice

benaadams · 2018-06-12T14:08:15Z

frameworks/FSharp/giraffe/src/App/Program.fs

+[<CLIMutable>]
+type JsonMessage = { message : string }
+
+let jsonutf8 (data:obj) : HttpHandler =


Should this be data: JsonMessage?

Also is type JsonMessage the equivalent of a C# struct type? (rather than a class type)

The generic Utf8Json Serialize overload for will work better for the struct type (don't change it for the regular one as Json.Net would box it to obj anyway...)

It should be a class
Will add struct for utf8 case + make it generic

benaadams · 2018-06-12T14:08:52Z

Some nits, but beautiful!

benaadams · 2018-06-12T14:21:44Z

I will need to check if docker actually able to run the app. It died on my work machine after latest windows update

I run it in a linux VM on Windows, seems easiest as the tests set up a bunch of docker containers.

You can verify it locally with

sudo ./tfb --test=giraffe --mode=verify

And locally benchmark (e.g. plaintext) with

sudo ./tfb --test=giraffe --type=plaintext

Are also docs on the benchmarks https://frameworkbenchmarks.readthedocs.io/

benaadams · 2018-06-12T14:31:00Z

frameworks/FSharp/giraffe/giraffe-jsonutf8.dockerfile

@@ -0,0 +1,12 @@
+FROM microsoft/dotnet:2.1-sdk-stretch AS build


need to rename this docker file to match name change
giraffe-jsonutf8.dockerfile -> giraffe-utf8json.dockerfile

benaadams · 2018-06-12T14:31:43Z

Don't forget to remove WIP from the title :)

dv00d00 · 2018-06-12T14:43:36Z

Out of scope of this PR, but if, let's say, I'll port asp.net core mvc app to F#, will it make any sense?

benaadams · 2018-06-12T15:06:28Z

I'll port asp.net core mvc app to F#, will it make any sense?

Maybe? Can add it as a mvc branch in benchmark_config.json with it own dockerfile as per utf8json; may want to have it as a separate fsprog.

The aspnetcore version is a little complicated as it has every permutation in it; then uses command line params to determine what to set up so you may want to go simplier, unless you want to switch for all the databases, different orms and middleware vs mvc.

benaadams · 2018-06-12T15:48:14Z

@dv00d00 might want to signal when you are complete with the PR, so the techempower peeps know when to merge

dv00d00 · 2018-06-12T15:59:48Z

will update it shortly, going to split stock and custom implementations

separated custom implementation from stock

dv00d00 · 2018-06-12T16:23:56Z

I think it is ok now

benaadams · 2018-06-12T16:41:05Z

F#, welcome .NET Player 2 😃

/cc @nbrady-techempower

msmith-techempower · 2018-06-12T16:54:21Z

frameworks/FSharp/giraffe/.gitignore

+BDN.Generated/
+binaries/
+global.json
+*.sln


With the Docker implementation, .gitignore should not be needed.

Makes it hard to edit the project in Visual Studio and use git without it (as VS creates lots of support files)

Fair enough

isaacabraham · 2018-06-12T17:40:26Z

What's the CLIMutable needed for?

forki · 2018-06-12T18:41:58Z

frameworks/FSharp/giraffe/src/App/App.fsproj

+ <ItemGroup>
+ <PackageReference Include="Microsoft.AspNetCore.Hosting" Version="2.1.0" />
+ <PackageReference Include="Microsoft.AspNetCore.Server.Kestrel" Version="2.1.0" />
+ <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="2.1.0" />


Can we get rid of DI?

forki · 2018-06-12T18:43:15Z

frameworks/FSharp/giraffe/src/App/Program.fs

+ | [| "stock" |] -> Stock
+ | _ -> Custom
+
+ printfn "Running with %A implementation" implementation


Printf is usually very slow. I'm not sure if it's part of the benchmark, but it should not be used in hot paths.

Console.WriteLine would do

forki · 2018-06-12T18:44:26Z

frameworks/FSharp/giraffe/src/App/Program.fs

+ let custom : HttpHandler list = 
+ let inline contentLength (x:int32) = new System.Nullable<int64>( int64 x )
+
+ let json data : HttpHandler =


I think we should use the giraffe helpers here.

Helpers are already used in stock? (idiomatic)

Custom uses a static conversion for plaintext, and utf8json for json lib (benchmark optimized)

Both varieties will show up in the benchmarks

Ah didn't see that. Thanks

forki · 2018-06-12T18:44:47Z

frameworks/FSharp/giraffe/src/App/Program.fs

+ ctx.WriteBytesAsync bytes
+
+ let bytes = System.Text.Encoding.UTF8.GetBytes "Hello, World!"
+ let text : HttpHandler = 


I think we should use giraffe helpers here.

Helpers are used for this type in stock (idiomatic)

forki · 2018-06-12T18:45:50Z

frameworks/FSharp/giraffe/src/App/Program.fs

+open Microsoft.AspNetCore.Hosting
+open Giraffe
+
+[<CLIMutable>] 


Mhm. Not 100 percent sure, but usually we don't need cli mutable. I don't have it anywhere in any of my giraffe apps

forki · 2018-06-12T18:50:02Z

Very cool stuff. I added some smaller comments. Maybe you want to move it a bit more in direction of idiomatic giraffe.

forki · 2018-06-12T20:04:53Z

I also recommend that you you try to use giraffe's tokenrouter if you didn't try it yet. It should be much faster than the "old" suave style routing

dv00d00 · 2018-06-13T08:51:09Z

thanks for the review @forki

pritnfn is called once per app startup, so should not cause any issues.
As for TokenRouter, it does look good, but I think we can't use prerelease packages

forki · 2018-06-13T08:56:44Z

AFAIK token router is released. @dustinmoris? @isaacabraham Dmitry Kushnir <[email protected]> schrieb am Mi., 13. Juni 2018, 10:51:

…

thanks for the review @forki <https://github.com/forki> pritnfn is called once per app startup, so should not cause any issues. As for TokenRouter, it does look good, but I think we can't use prerelease packages — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#3859 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AADgNBEC11oLe0-Zdq2V8PuIImqAYuLpks5t8NKJgaJpZM4UkRUZ> .

gerardtoconnor · 2018-06-13T11:37:15Z

On NuGet it's saying it's a beta pre-release, unfortunately :( . I don't release many NuGet packages, do we remove pre-release state, by removing "beta" from project version?

Given this is a performance test we should probably avoid CE, any other fancy syntax and any unneeded runtime ops like filtering GET, sticking to explicit perf code as no-one references these benchmarks for building systems, just getting perf tips?

forki · 2018-06-13T13:17:42Z

Please send PRs if you see improvements. Gerard <[email protected]> schrieb am Mi., 13. Juni 2018, 13:37:

…

On NuGet <https://www.nuget.org/packages/Giraffe.TokenRouter/> it's saying it's a beta pre-release, unfortunately :( . I don't release many NuGet packages, do we remove pre-release state, by removing "beta" from project version? Given this is a performance test we should probably avoid CE, any other fancy syntax and any unneeded runtime ops like filtering GET, sticking to explicit perf code as no-one references these benchmarks for building systems, just getting perf tips? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#3859 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AADgNHJWUF7w77s-BqoOAu6e8eW11v0tks5t8PlygaJpZM4UkRUZ> .

gerardtoconnor · 2018-06-16T15:52:57Z

Did review in RFC Fsharp giraffe fortunes, looks good for the most part, not much more to do without changing router or implementing more explicit json writer. 👍

Dmitry Kushnir added 7 commits June 12, 2018 14:27

initial commit

949ed89

application

3e0c166

removed static content

3c6d0b7

tidy up

e3f19f6

utf8json

9cebdac

typos

51fa142

added FSharp lang

5e99be4

benaadams reviewed Jun 12, 2018

View reviewed changes

frameworks/FSharp/giraffe/src/App/App.sln Outdated

@@ -0,0 +1,25 @@

Copy link

Contributor

benaadams Jun 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't need the sln file; up to you though

benaadams reviewed Jun 12, 2018

View reviewed changes

Dmitry Kushnir added 3 commits June 12, 2018 16:31

typos

9b0b536

react to code review

3d3823a

cleanup

626ebfa

benaadams reviewed Jun 12, 2018

View reviewed changes

benaadams approved these changes Jun 12, 2018

View reviewed changes

struct + generic on jsonutf8

4840227

Dmitry Kushnir added 2 commits June 12, 2018 17:24

renamed config name + minor cleanup

b8fad79

updated README.md

db2817a

benaadams reviewed Jun 12, 2018

View reviewed changes

renamed dockerfile

f7189e3

dv00d00 changed the title ~~WIP FSharp giraffe~~ FSharp giraffe Jun 12, 2018

simplified routing, default behaviour for missing route is 404

8cd915f

dv00d00 changed the title ~~FSharp giraffe~~ [WIP] FSharp giraffe Jun 12, 2018

removed boxing from utf8json handler

8243388

separated custom implementation from stock

dv00d00 changed the title ~~[WIP] FSharp giraffe~~ FSharp giraffe Jun 12, 2018

msmith-techempower approved these changes Jun 12, 2018

View reviewed changes

msmith-techempower merged commit 2669ae4 into TechEmpower:master Jun 12, 2018

forki reviewed Jun 12, 2018

View reviewed changes

rishavs mentioned this pull request Jun 20, 2018

Adding Giraffe to Tech empower benchmark suite giraffe-fsharp/Giraffe#277

Closed

roberthusak pushed a commit to roberthusak/FrameworkBenchmarks that referenced this pull request Nov 6, 2018

FSharp giraffe (TechEmpower#3859)

32f2424

		@@ -0,0 +1,12 @@
		FROM microsoft/dotnet:2.1-sdk-stretch AS build

FSharp giraffe #3859

FSharp giraffe #3859

Conversation

dv00d00 commented Jun 12, 2018 • edited Loading

benaadams Jun 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benaadams Jun 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dv00d00 commented Jun 12, 2018

benaadams Jun 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benaadams commented Jun 12, 2018

benaadams commented Jun 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benaadams commented Jun 12, 2018

dv00d00 commented Jun 12, 2018

benaadams commented Jun 12, 2018 • edited Loading

benaadams commented Jun 12, 2018

dv00d00 commented Jun 12, 2018

dv00d00 commented Jun 12, 2018

benaadams commented Jun 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

isaacabraham commented Jun 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benaadams Jun 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

forki commented Jun 12, 2018

forki commented Jun 12, 2018

dv00d00 commented Jun 13, 2018

forki commented Jun 13, 2018 via email

gerardtoconnor commented Jun 13, 2018

forki commented Jun 13, 2018 via email

gerardtoconnor commented Jun 16, 2018

dv00d00 commented Jun 12, 2018 •

edited

Loading

benaadams Jun 12, 2018 •

edited

Loading

benaadams Jun 12, 2018 •

edited

Loading

benaadams Jun 12, 2018 •

edited

Loading

benaadams commented Jun 12, 2018 •

edited

Loading

benaadams commented Jun 12, 2018 •

edited

Loading

benaadams commented Jun 12, 2018 •

edited

Loading

benaadams Jun 12, 2018 •

edited

Loading