Saturday, 21 July 2018

More on Casablanca/cpprestdsk - Design and Comparisons


After I finished my Casablanca (aka C++ REST SDK)* project for some time then, I noticed** a new Boost library: Boost.Beast***, a library implementing: "HTTP and WebSocket built on Boost.Asio in C++11". 

That sounded interesting so I had a quick look at it, and I even found (surprise, surprise) the design rationale and comparison with other HTTP libraries. Because of my previous involvement with Casablanca* I simply had to read it. So here is my take on Beasts's critique and some closing discussion of Casablanca's* design and how I see it.

My involvement with Casablanca*/C++ REST-SDK code...
Let us start with a lengthy citation from Beast's analysis of Casablanca*, where the author lists all the missing customization points of the library:
"It is clear from this declaration that the goal of the message model in this library is driven by its use-case (interacting with REST servers) and not to model HTTP messages generally. We note problems similar to the other declarations:
  • There are no compile-time customization points at all. The only customization is in the concurrency::streams::istream and concurrency::streams::ostream reference parameters. Presumably, these are abstract interfaces which may be subclassed by users to achieve custom behaviors. 
  • The extraction of the body is conflated with the asynchronous model. 
  • No way to define an allocator for the container used when extracting the body. 
  • A body can only be extracted once, limiting the use of this container when using a functional programming style. 
  • Setting the body requires either a vector or a concurrency::streams::istream. No user defined types are possible. 
  • The HTTP request container conflates HTTP response behavior (see the set_response_stream member). Again this is likely purpose-driven but the lack of separation of concerns limits this library to only the uses explicitly envisioned by the authors."
Then the author restates it in a more concise manner:
"The general theme of the HTTP message model in cpprestsdk is "no user definable customizations". There is no allocator support, and no separation of concerns. It is designed to perform a specific set of behaviors. In other words, it does not follow the open/closed principle.
Tasks in the Concurrency Runtime operate in a fashion similar to std::future, but with some improvements such as continuations which are not yet in the C++ standard. The costs of using a task based asynchronous interface instead of completion handlers is well documented: synchronization points along the call chain of composed task operations which cannot be optimized away. See: A Universal Model for Asynchronous Operations (Kohlhoff)."
Let me state my opinion bluntly: I didn't miss these customization features at all during my almost 3 years long involvement with Casablanca*! The framework just did its work as it should, we could use it without much hassle and it performed reasonably good under load on Windows - probably through its usage of completion ports (Boost.Asio is only used on Mac Os and Linux).

OK, there was a single time where one of the above concerns did cause problems, namely:
  • A body can only be extracted once, limiting the use of this container when using a functional programming style,
but I solved it by setting the data into the message back again. Mischief managed 😈, work can be continued! You could say it's not very functional programming style, but we are not in the academy but in real life.

On the other side the Boost.Beast itself library seems a little hard to use, and more like a base for another libraries than a independent library on its own, as it is stated in the project's own FAQ:
"It is not the intention of the library to provide turn-key solutions for specific HTTP or WebSocket use-cases. Instead, it is a sensible protocol layering on top of Boost.Asio which retains the Boost.Asio memory management style and asynchronous model."
So OK, we must be aware of Casablanca's* limitations, but for the real REST use case they somehow carried no weight.

TL;DR: I cannot really relate to the critique stated in the comparison, for us Casablanca worked out pretty well in general and the product we build with it is alive and kicking!

Note: Here and here I found quite interesting results of a security review of Boost.Beast by Bishop Fox. They found vulnerabilities, and I don't want to even think about their analysis of Casablanca*! Fortunately our product was set up forca more or less trusted environment. But this could be maybe a material for a separate blog post.

--
* Casablanca is the old code name for Microsoft's C++ REST SDK and I'll use it in the rest of that post, because it rolls better off the tongue than cpprestsdk! Besides during the years I grew accustomed to it and even a little nostalgic...

** to be more specific, I noticed it through Meeting C++'s library reviews initiative!
*** see "Beast: Version 100, ACCEPTED to Boost!" here.

6 comments:

eao197 said...

Boost.Beast looks too low-level to be used for application development. I can't imagine how many work it is necessary to do on top on Boost.Beast to write a simple RESTful service with it. May be Boost.Beast will be good base for some higher-level library, but there already are plenty of expressive and high-level modern C++ libraries for embedding HTTP-server in C++ application.

For example there is a benchmark we done to test performance of some of them: RESTinio Benchmark.

Several of those libraries are much more expressive and easier to use than Boost.Beast, and some of them (like our RESTinio library) provides a high level of compile-time customization.

Anonymous said...
This comment has been removed by a blog administrator.
Marek Krj said...

@Yauheni
Thanks for the link, some nice Performance comparisions!

Marek Krj said...

@Yauheni
Surprisingly, cpprestsdk appears to be very slow on Linux in your benchmarks. However, we were using it on Windows, an in seems to be heavily optimized for that platform (completion ports, native Windows APIs). We have also ported the system to Mac-OS, but it was probably used more on the client side and not as the server, so maybe the performance problems weren't that serious? On Mac and Linux the well-known ASIO library is used, so the bad performance comes as a bit of a surprose.

AN thanks for the RESTinio library link!

eao197 said...

@Marek Krj
The benchmark is rather old and we don't update it for the long time. So the performance of C++REST SDK on Unix can be much better now. Or not :)

Marek Krj said...

@eao197 ok, got it :), thx for info!