feat(dart_frog): add x-powered-by-header to serve (#337)

Author: felangel

packages/dart_frog/lib/src/serve.dart

@@ -2,13 +2,25 @@ part of '_internal.dart';
 
 /// Starts an [HttpServer] that listens on the specified [address] and
 /// [port] and sends requests to [handler].
-Future<HttpServer> serve(Handler handler, Object address, int port) {
+///
+/// Pass [poweredByHeader] to set the default content for "X-Powered-By",
+/// pass `null` to omit this header.
+/// By default, the header will be:
+///
+/// `"X-Powered-By": "Dart with package:dart_frog"`
+Future<HttpServer> serve(
+  Handler handler,
+  Object address,
+  int port, {
+  String? poweredByHeader = 'Dart with package:dart_frog',
+}) {
   return shelf_io.serve(
     (shelf.Request request) async {
       final response = await handler(RequestContext._(request));
       return response._response;
     },
     address,
     port,
+    poweredByHeader: poweredByHeader,
   );
 }

packages/dart_frog/pubspec.yaml

@@ -11,7 +11,7 @@ environment:
 
 dependencies:
   http_methods: ^1.1.0
-  shelf: ^1.1.0
+  shelf: ^1.4.0
   shelf_hotreload: ^1.3.0
   shelf_static: ^1.1.1
 

packages/dart_frog/test/src/serve_test.dart

@@ -42,5 +42,51 @@ void main() {
       expect(connectionInfo.remoteAddress.address, equals('::1'));
       await server.close();
     });
+
+    group('X-Powered-By-Header', () {
+      test('is configured by default', () async {
+        final server = await serve((_) => Response(), 'localhost', 3000);
+        final client = HttpClient();
+        final request = await client.getUrl(Uri.parse('http://localhost:3000'));
+        final response = await request.close();
+        expect(
+          response.headers.value('X-Powered-By'),
+          equals('Dart with package:dart_frog'),
+        );
+        await server.close();
+      });
+
+      test('can be overridden', () async {
+        const poweredByHeader = 'custom powered by header';
+        final server = await serve(
+          (_) => Response(),
+          'localhost',
+          3000,
+          poweredByHeader: poweredByHeader,
+        );
+        final client = HttpClient();
+        final request = await client.getUrl(Uri.parse('http://localhost:3000'));
+        final response = await request.close();
+        expect(
+          response.headers.value('X-Powered-By'),
+          equals(poweredByHeader),
+        );
+        await server.close();
+      });
+
+      test('can be removed', () async {
+        final server = await serve(
+          (_) => Response(),
+          'localhost',
+          3000,
+          poweredByHeader: null,
+        );
+        final client = HttpClient();
+        final request = await client.getUrl(Uri.parse('http://localhost:3000'));
+        final response = await request.close();
+        expect(response.headers.value('X-Powered-By'), isNull);
+        await server.close();
+      });
+    });
   });
 }