feat: Protocol Buffers Support (protobuf) about dart_frog HOT 3 CLOSED

Hey @nosmirck 👋! I was interested in using protobufs as well so I played around with it and it looks totally supported by the current package with existing tools.

Basically, you can using the protoc CLI tool to generate the Dart objects for your protobuf messages, and it generates all your Dart classes.

You can then use those objects with dart_frog like this

import 'package:dart_frog/dart_frog.dart';
import 'package:protobuf_play/model.dart';

Response onRequest(RequestContext context) {
  final person = Person(
    id: 3,
    email: '[email protected]',
    name: 'Tester McTesterson',
    phones: [
      Person_PhoneNumber(
        number: '+14068675309',
        type: Person_PhoneType.HOME,
      )
    ],
  );

  return Response.bytes(
    body: person.writeToBuffer(),
  );
}

All your generated classes also have a factory constructor called fromBuffer which makes them super easy to convert from the Uint8List of bytes back into a useful object on the frontend side of things.

I created a little example repo showing how to use this: https://github.com/mtwichel/protobuf_play. @felangel , let me know if you want me to make a PR adding it as an example in this repo - I'd be happy to clean it up and share 💙

from dart_frog.

As discussed, closing this issue since the answer provided by @mtwichel is quite thorough and illustrates the steps needed to use protobuf in the context of a Dart Frog application.

from dart_frog.

@felangel Now that we have expanded examples, would it be okay if I merged in my protobuf example and made it a tutorial? I would also make sure it has test coverage and all that jazz.

from dart_frog.