feat: Serve `public/index.html` from root handler

[craiglabenz]

Description

I would like to vendor a Flutter web build into Dart Frog's public directory and then serve its index.html file from Dart Frog's own root handler. I have this working in what feels like a hacky way, so I am proposing either:

1. Documentation on a cleaner way
2. The addition of a cleaner way, or
3. Confirmation that this way is not actually hacky

Requirements

This is potentially a documentation request - I don't know!

Additional Context

In my root index.dart file, I have found that the following code works:

import 'package:dart_frog/dart_frog.dart';
import 'package:shelf_static/shelf_static.dart';

Future<Response> onRequest(RequestContext context) async {
  final handler = fromShelfHandler(
    createStaticHandler(
      'public',
      defaultDocument: 'index.html',
    ),
  );

  return handler(context);
}

[craiglabenz]

I explored potentially figuring this out from within main.dart, per the static files documentation, but didn't get that working. The issue was that that documentation seems to map Dart Frog's default static file handling to a different directory, whereas I want to adjust Dart Frog's default static file handling within the default directory.

[felangel]

Hey @craiglabenz 👋
Thanks for opening an issue!

I believe this should already be possible. I'll take a closer look tomorrow 👍

[felangel]

Hey @craiglabenz I just took a closer look.

Currently the simplest solution is to remove your index.dart (root handler) and just request http://localhost:8080/index.html

But if you really don't want to have to explicitly specify the index.html in the path then your current solution is okay imo.

import 'package:dart_frog/dart_frog.dart';
import 'package:shelf_static/shelf_static.dart';

Future<Response> onRequest(RequestContext context) async {
  final handler = fromShelfHandler(
    createStaticHandler(
      'public',
      defaultDocument: 'index.html',
    ),
  );

  return handler(context);
}

With some small adjustments to pkg:dart_frog we can make this significantly simpler:

import 'package:dart_frog/dart_frog.dart';

Handler get onRequest => createStaticFileHandler(path: 'public', defaultDocument: 'index.html');

Another option would be to remove routes/index.dart altogether and for us to allow you to configure static files from the command line:

dart_frog dev --default-static-document=index.html
dart_frog build --default-static-document=index.html

I'll leave this issue open to track the work to improve this 👍

[mtwichel]

With some small adjustments to pkg:dart_frog we can make this significantly simpler:

import 'package:dart_frog/dart_frog.dart';

Handler get onRequest => createStaticFileHandler(path: 'public', defaultDocument: 'index.html');

Are you open to a PR that does this? I'd be happy to take care of it unless you've already worked on it :)

[felangel]

With some small adjustments to pkg:dart_frog we can make this significantly simpler:
import 'package:dart_frog/dart_frog.dart';

Handler get onRequest => createStaticFileHandler(path: 'public', defaultDocument: 'index.html');

Are you open to a PR that does this? I'd be happy to take care of it unless you've already worked on it :)

That’d be great! Thanks Marcus 💙