Shelf 1.1.1 breaking change: request body runtime type changed from Stream<List<int>> to Stream<Uint8List>

[nex3]

Shelf 1.1.1 introduced a breaking change. By changing the runtime type of request bodies from Stream<List<int>> to Stream<Uint8List>, it caused it to no longer work with instances of StreamTransformer<List<int>, List<int>> such as dart:io's gzip.encoder and gzip.decoder. This is a breaking change and, if it was necessary, should have been released with a major version bump.

The following code works with shelf 1.1.0 and not with 1.1.1:

import 'dart:io';

import 'package:shelf/shelf.dart' as shelf;
import 'package:shelf/shelf_io.dart' as shelf_io;

Future<void> main() async {
  var server = await shelf_io.serve((request) async {
      await request.read().transform(gzip.decoder).drain();
      return shelf.Response.ok("");
    }, "localhost", 0);

  var client = HttpClient();
  var request = await client.post("localhost", server.port, "/");
  await request.close();
  client.close(force: true);
  server.close();
}

[kevmoo]

CC @natebosch @jonahwilliams

[kevmoo]

Yeah, very unintentional.

Before we were ALWAYS wrapping the input in List<int> which turned out to be very expensive. Now we just flow through the input bits.

The question now: do we revert and give up the perf win?

This is a ~duplicate of #188 – leaving open to discuss

[nex3]

Whether or not you choose to release the cast-free implementation as 2.x, the 1.x branch should continue to cast() because doing otherwise is a breaking change.

[zambetpentru]

Hi, as raised in #193 I am trying to find the best way now to receive a large file upload. Is there a recommended example?

[kevmoo]

Just got to put the converter first:

diff --git a/example/mime.dart b/example/mime.dart
index 1975ead..a5735a9 100644
--- a/example/mime.dart
+++ b/example/mime.dart
@@ -6,7 +6,7 @@ import 'package:shelf/shelf_io.dart' as shelf_io;
 Future<void> main() async {
   var server = await shelf_io.serve(
     (request) async {
-      await request.read().transform(gzip.decoder).drain();
+      await gzip.decoder.bind(request.read()).drain();
       return shelf.Response.ok('');
     },
     'localhost',

[Silentdoer]

this bug has been fixed?

[kevmoo]

I doubt we're going to fix it at this point...