WatchX Stops Working Inside StreamBuilders about get_it_mixin

[escamoteur]

Can you please the code of of your Widget please?

[rayliverified]

Will add test project.

[rayliverified]

I've created a sample project at https://github.com/searchy2/get_it_mixin/tree/ray-streambuilderissue
The file with the StreamBuilder issue is at main_streambuilder.dart.

There are multiple issues with StreamBuilders that are quite confusing. I've isolated the issues as best as possible.

Issue 1: WatchX Outside Stream builder fails on hot reload rebuild

https://www.youtube.com/watch?v=7asv6UfZRbY

StreamBuilder Hot Restart Issue

class StreamBuilderHotReloadIssue extends StatefulWidget {
  @override
  _StreamBuilderHotReloadIssueState createState() =>
      _StreamBuilderHotReloadIssueState();
}

class _StreamBuilderHotReloadIssueState
    extends State<StreamBuilderHotReloadIssue> {
  static StreamController<int> counterController = StreamController<int>();
  Stream<int> counter = counterController.stream;

  @override
  void initState() {
    super.initState();
    Future.delayed(Duration(milliseconds: 1000), () {
      counterController.add(1);
    });
  }

  @override
  void dispose() {
    counterController.close();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      children: [
        GetItCounterOutsideStreamBuilder(),
        StreamBuilder(
          stream: counter,
          builder: (context, snapshot) {
            print('Build Stream');
            if (!snapshot.hasData) return SizedBox.shrink();
            int counterValue = snapshot.data as int;
            return Column(
              mainAxisSize: MainAxisSize.min,
              children: [
                Text('Stream Counter: ' + counterValue.toString()),
                GetItCounterInStreamBuilder(),
              ],
            );
          },
        ),
      ],
    );
  }
}

---

Issue 2: Stream Rebuild Breaks WatchX Rebuilds.

StreamBuilder Rebuild Issue

class StreamBuilderRebuildIssue extends StatefulWidget
    with GetItStatefulWidgetMixin {
  @override
  _StreamBuilderRebuildIssueState createState() =>
      _StreamBuilderRebuildIssueState();
}

class _StreamBuilderRebuildIssueState extends State<StreamBuilderRebuildIssue>
    with GetItStateMixin {
  static StreamController<int> counterController = StreamController<int>();
  Stream<int> counter = counterController.stream;

  @override
  void initState() {
    super.initState();
    Future.delayed(Duration(milliseconds: 1000), () {
      counterController.add(1);
    });
    // This triggers a StreamBuilder rebuild and breaks WatchX.
    Future.delayed(Duration(milliseconds: 2000), () {
      counterController.add(2);
    });
  }

  @override
  void dispose() {
    counterController.close();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      children: [
        StreamBuilder(
          stream: counter,
          builder: (context, snapshot) {
            print('Build Stream');
            if (!snapshot.hasData) return SizedBox.shrink();
            int counterValue = snapshot.data as int;
            return Column(
              mainAxisSize: MainAxisSize.min,
              children: [
                Text('Stream Counter: ' + counterValue.toString()),
                GetItCounterInStreamBuilder(),
                GetItCounterOutsideStreamBuilder(),
              ],
            );
          },
        ),
      ],
    );
  }
}

[escamoteur]

Actually the latter makes completely sense to be because the builder has it's own context. So probably won't work together with the mixin or wit hooks. So better don't mix them inside one widget tree.

[escamoteur]

Just confirmed with Remi. My hunch was right. it can't work inside most builders. And the idea of the mixin is not to have to use builders to make you code more readable.

[escamoteur]

Concerning the hot reload I have to look.

[escamoteur]

I fixed the Hot reload. Please give it a try. And I added to the readme that you can't use it with Builders

[rayliverified]

Amazing, will test and confirm!