Merge pull request #8 from r8/index-file

Add support for defaultDocument serving

Author: r8

CHANGELOG.md

@@ -1,3 +1,7 @@
 ## 0.0.1
 
 * Initial release.
+
+## 0.0.2
+
+* Add support for defaultDocument serving.

README.md

@@ -16,7 +16,7 @@ import 'package:shelf/shelf_io.dart' as io;
 import 'package:shelf_flutter_asset/shelf_flutter_asset.dart';
 
 void main() {
-  var assetHandler = createAssetHandler();
+  var assetHandler = createAssetHandler(defaultDocument: 'index.html');
 
   io.serve(assetHandler, 'localhost', 8080);
 }

example/lib/main.dart

@@ -4,7 +4,7 @@ import 'package:shelf_flutter_asset/shelf_flutter_asset.dart';
 import 'package:webview_flutter/webview_flutter.dart';
 
 void main() {
-  var assetHandler = createAssetHandler();
+  var assetHandler = createAssetHandler(defaultDocument: 'index.html');
 
   io.serve(assetHandler, 'localhost', 8080);
 
@@ -46,7 +46,7 @@ class _MyHomePageState extends State<MyHomePage> {
     _controller = WebViewController()
       ..setJavaScriptMode(JavaScriptMode.unrestricted)
       ..setBackgroundColor(const Color(0x00000000))
-      ..loadRequest(Uri.parse('http://localhost:8080/index.html'));
+      ..loadRequest(Uri.parse('http://localhost:8080'));
   }
 
   @override

lib/shelf_flutter_asset.dart

@@ -1,43 +1,61 @@
+import 'dart:io';
+
 import 'package:flutter/services.dart';
-import 'package:shelf/shelf.dart';
 import 'package:mime/mime.dart';
 import 'package:path/path.dart' as p;
-import 'dart:io';
+import 'package:shelf/shelf.dart';
 
 /// The default resolver for MIME types.
 final _defaultMimeTypeResolver = MimeTypeResolver();
 
 /// Creates a Shelf [Handler] that serves files from Flutter assets.
 ///
+/// If requested resource does not exist and [defaultDocument] is specified,
+/// request path is checked for a resource with that name.
+/// If it exists, it is served.
+///
 /// Specify a custom [contentTypeResolver] to customize automatic content type
 /// detection.
-Handler createAssetHandler({MimeTypeResolver? contentTypeResolver}) {
+Handler createAssetHandler(
+    {String? defaultDocument, MimeTypeResolver? contentTypeResolver}) {
   final mimeResolver = contentTypeResolver ?? _defaultMimeTypeResolver;
 
   return (Request request) async {
     final segments = ['assets', ...request.url.pathSegments];
 
-    final key = p.joinAll(segments);
+    String key = p.joinAll(segments);
 
-    try {
-      final body = await _loadResource(key);
+    Uint8List? body;
 
-      final contentType = mimeResolver.lookup(key);
+    body = await _loadResource(key);
 
-      final headers = {
-        HttpHeaders.contentLengthHeader: '${body.length}',
-        if (contentType != null) HttpHeaders.contentTypeHeader: contentType,
-      };
+    if (body == null && defaultDocument != null) {
+      key = p.join(key, defaultDocument);
 
-      return Response.ok(body, headers: headers);
-    } catch (_) {
+      body = await _loadResource(key);
+    }
+
+    if (body == null) {
       return Response.notFound('Not Found');
     }
+
+    final contentType = mimeResolver.lookup(key);
+
+    final headers = {
+      HttpHeaders.contentLengthHeader: '${body.length}',
+      if (contentType != null) HttpHeaders.contentTypeHeader: contentType,
+    };
+
+    return Response.ok(body, headers: headers);
   };
 }
 
-Future<Uint8List> _loadResource(String key) async {
-  final byteData = await rootBundle.load(key);
+Future<Uint8List?> _loadResource(String key) async {
+  try {
+    final byteData = await rootBundle.load(key);
+
+    return byteData.buffer.asUint8List();
+  } catch (_) {}
 
-  return byteData.buffer.asUint8List();
+  return null;
 }