A lot of neat stuff came out of DartConf 2018, and it’s clear Google is taking Dart’s future seriously. Much of its focus is on improving the development of client-side applications with Flutter and AngularDart. Focus is good; it’s how things get done. A few folks are concerned this focus diminishes the ability to write server-side apps in Google’s Dart – this concern is overblown.

Behind the marketing, server-side development with Dart is only improving. The primary focus of Dart 2 is building a common front-end that Dart code is processed through; code will go through the same toolchain, regardless of whether it targets the Dart Virtual Machine or JavaScript. If you’re a Dart server-side developer, this is great news – it’s not even worthwhile to stop supporting server applications written in Dart. (By the way, did you know that neither Flutter or server-side Dart are compiled to JavaScript?)

More importantly, the HTTP server libraries are being moved to their own package for faster development without being tied to SDK releases. Activity has picked up on an HTTP/2 implementation maintained by Google.

Our developers who work on Aqueduct – the open-source server-side framework for building HTTP APIs – are very excited about Dart 2. We are already a few months into development for Aqueduct 3 for Dart 2, and we’ve already been running the framework’s 1300 tests against the Dart 2.0 dev SDK.

In this post, I will cover the new features of Aqueduct 3, an overview of things that are coming (or are already available), and instructions for running the pre-release version.

New Features in Aqueduct 3

You can follow development by viewing the changelog on the 3.0 branch. Here are a few of the big features that are currently in progress.

Document Data Structures in the ORM

Aqueduct’s ORM targets PostgreSQL. It is often cumbersome to manage unstructured data in a typical relational database. PostgreSQL has a solution: JSONB columns. A JSONB column stores unstructured, binary JSON data. Aqueduct’s ORM adds support for JSONB columns by introducing a Document data type. Database objects declare fields of this type to add JSONB columns to their underlying table. Additional syntax has been added to Query to use the contents of Document columns in building queries.

See the pre-release documentation guide for more details.

OpenAPI 3.0 Auto-Documentation

Aqueduct 2 loosely supported auto-generation of Swagger documents, but it was largely experimental. Work has already been completed in Aqueduct 3 to support OpenAPI 3 document generation. In most cases, you only need to define the possible responses for your endpoints – Aqueduct reflects on your codebase to figure out the rest.

By adding support for OpenAPI 3.0, you can leverage open-source tools for documentation viewers and source code generation on multiple platforms.

See the pre-release documentation guide for more details.

Better Support for OAuth 2.0 Scopes

Aqueduct already ships with an OAuth 2.0 server implementation. It is easy to set up per-route scope restrictions, but the operation-level scope wasn’t as simple as it needed to be. Aqueduct 3 adds a Scope annotation that lets you define scope restrictions for each operation – i.e., POST /users requires different scope than GET /users.

See the pre-release documentation guide for more details.

Changes to Existing APIs

Like most Dart codebases, some of the changes to Google’s Dart 2 will require changes to Aqueduct. We think all of these changes will be a net-benefit to Dart and Aqueduct developers.

Query.where syntax

Folks love Aqueduct’s statically-typed ORM. A change to the Dart 2 runtime will require the way you build the WHERE clause of the query to change slightly, but we think for the better. Instead of assigning expressions to an object’s properties, you will use a property selector. If you have used joins, paging or sorting queries, property selectors will look familiar.

final q = Query<Employee>()
 ..where((e) => e.lastName).equalTo("Smith")
 ..sortBy((e) => e.firstName, QuerySortOrder.ascending);

final sortedEmployeesWithSmithLastName = await q.fetch();

This new syntax has the added benefit of an additional static type-check on values provided to expression-adding methods like equalTo.

Simplified Initialization

Application initialization has been simplified – you override two methods: one to create services and the other to create your controllers that handle requests. Controllers are now linked together using a single method.

class MyApp extends ApplicationChannel {
 AuthServer authServer;

 Future prepare() async {
   authServer = AuthServer(...);

 Controller get entryPoint {
   final router = Router();

     .link(() => Authorizer(authServer))
     .link(() => Controller());

   return router;

Clearer Annotations

Aqueduct makes liberal use of annotations when defining your data model and request handling code. Some of these annotations had rather long, or in some cases, confusing names. When combined with the Dart standard 80 character columns, annotations made code more difficult to read. Here are some examples of improved annotations in Aqueduct 3.

class NoteController extends ResourceController {
 Future getAllNotes({@Bind.query(‘since’) DateTime since}) async => …;

 Future getNote(@Bind.path(‘id’) int id) async => …;

 Future createNote(@Bind.body() Note note) async => …;

class Note extends ManagedObject<_Note> implements _Note {}
class _Note {
 int id;

 @Column(indexed: true)
 String contents;

 @Relate(#notes, onDelete: DeleteRule.cascade)
 User owner;

Using Aqueduct 3 Pre-Release

You’ll need to upgrade to the developer release of Dart 2.0. On macOS, you install with Homebrew:

brew upgrade dart --devel

For other platforms, see this page.

Once you have Dart 2.0, clone Aqueduct locally, switch to the 3.0 branch and install the CLI from your local repository.

git clone git@github.com:stablekernel/aqueduct.git
cd aqueduct
git checkout 3.0
git pull
pub global activate -spath .

Then create a new project that targets Aqueduct 3.

cd <your-project-directory>
aqueduct create my_app

Because your project was created from a local version of Aqueduct, its pubspec.yaml file will point to that directory on your filesystem. To stay up to date with 3.0 (or to build remotely), change your pubspec.yaml file to reference the 3.0 branch on GitHub:

url: git@github.com:stablekernel/aqueduct.git
ref: “3.0”

The documentation guides are updating as part of each change to the framework. You can view the current state of the documentation at https://aqueduct.io/prerelease-3.0/docs/.

If you are already using Aqueduct and are looking to migrate to 3.0, stop by the Slack Channel.

Joe Conway

Founder at Stable Kernel

  1. Marcello Dias

    Hi Joe.
    Iḿ one of the concerned folks, I mean someone once bitten by a snake
    fears a rope,Iḿ talking about Polymer.Dart.
    But Flutter is a game changer,specially if GOogle ever make it possible to write also
    desktop applicattions with it.
    Iḿ yet to see a more elegant language than Dart,and Dart. 2.0 is really awesome.
    But how much of the underlining technologies used by Aqueduct(those written by Google)
    will be affected by Dart 2.0 Changes?
    Iḿ really not a Dart specialist yet,but the VM is now being used during the development of Flutter, in order to provide
    the so called hot refresh,more or less what Node.js does for TypeScript,does this tuning for client side affects
    the performance on Server side in any way?
    I think the availability of middlewares would increase as much as Dart is adopted,but if Google throws money and developers in it,as Microsoft and
    Sun did in the past,things would go faster,I would not be upset if they had any kind of RoadMap for server side,but now is a “on the hands off the community state”.
    How can the community could not get upset,if the only talk about server side(not the lightning ones) was about useing node.js.
    If someone is responsible for this overblow is certainly Google.
    TypeScript is a broken toy if compared to Dart,but microsoftś mind dont change in a daily basis.

    • Hi there,

      Some of Aqueduct is changing to prepare for Dart 2.0. These changes are already in flight and have made Aqueduct better. Members of the Dart team have been directly helping us with some of these changes, and are very supportive (in general) of our efforts.

  2. Marcello Dias

    I think you in Stable Kernel are the best thing in Dart Server side.
    But are somehow to shy,there are more videos in youtube about Angel than Aqueduct.
    It also would help if you provide any applicattion in the Made with Dart section. at Googles Dart project Site,
    something like a Job search site, or anything else that needs a backend sql server.
    At first I did not like the fact that you based your solution in Postgresql,but in the end you were right,
    specially because many NewSql databases , cockroach db as an example work with ordinary Postgresql drivers.

Leave a Reply

Your email address will not be published. Required fields are marked *