pkgs/stream_transform/test/audit_test.dart

// Copyright (c) 2017, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'dart:async';

import 'package:fake_async/fake_async.dart';
import 'package:stream_transform/stream_transform.dart';
import 'package:test/test.dart';

import 'utils.dart';

void main() {
  for (var streamType in streamTypes) {
    group('Stream type [$streamType]', () {
      late StreamController<int> values;
      late List<int> emittedValues;
      late bool valuesCanceled;
      late bool isDone;
      late List<String> errors;
      late Stream<int> transformed;
      late StreamSubscription<int> subscription;

      group('audit', () {
        setUp(() {
          valuesCanceled = false;
          values = createController(streamType)
            ..onCancel = () {
              valuesCanceled = true;
            };
          emittedValues = [];
          errors = [];
          isDone = false;
          transformed = values.stream.audit(const Duration(milliseconds: 6));
        });

        void listen() {
          subscription = transformed
              .listen(emittedValues.add, onError: errors.add, onDone: () {
            isDone = true;
          });
        }

        test('cancels values', () async {
          listen();
          await subscription.cancel();
          expect(valuesCanceled, true);
        });

        test('swallows values that come faster than duration', () {
          fakeAsync((async) {
            listen();
            values
              ..add(1)
              ..add(2)
              ..close();
            async.elapse(const Duration(milliseconds: 6));
            expect(emittedValues, [2]);
          });
        });

        test('outputs multiple values spaced further than duration', () {
          fakeAsync((async) {
            listen();
            values.add(1);
            async.elapse(const Duration(milliseconds: 6));
            values.add(2);
            async.elapse(const Duration(milliseconds: 6));
            expect(emittedValues, [1, 2]);
          });
        });

        test('waits for pending value to close', () {
          fakeAsync((async) {
            listen();
            values
              ..add(1)
              ..close();
            expect(isDone, false);
            async.elapse(const Duration(milliseconds: 6));
            expect(isDone, true);
          });
        });

        test('closes output if there are no pending values', () {
          fakeAsync((async) {
            listen();
            values.add(1);
            async.elapse(const Duration(milliseconds: 6));
            values
              ..add(2)
              ..close();
            expect(isDone, false);
            expect(emittedValues, [1]);
            async.elapse(const Duration(milliseconds: 6));
            expect(isDone, true);
            expect(emittedValues, [1, 2]);
          });
        });

        test('does not starve output if many values come closer than duration',
            () {
          fakeAsync((async) {
            listen();
            values.add(1);
            async.elapse(const Duration(milliseconds: 3));
            values.add(2);
            async.elapse(const Duration(milliseconds: 3));
            values.add(3);
            async.elapse(const Duration(milliseconds: 6));
            expect(emittedValues, [2, 3]);
          });
        });

        if (streamType == 'broadcast') {
          test('multiple listeners all get the values', () {
            fakeAsync((async) {
              listen();
              values.add(1);
              async.elapse(const Duration(milliseconds: 3));
              values.add(2);
              var otherValues = [];
              transformed.listen(otherValues.add);
              values.add(3);
              async.elapse(const Duration(milliseconds: 3));
              values.add(4);
              async.elapse(const Duration(milliseconds: 3));
              values
                ..add(5)
                ..close();
              async.elapse(const Duration(milliseconds: 6));
              expect(emittedValues, [3, 5]);
              expect(otherValues, [3, 5]);
            });
          });
        }
      });
    });
  }
}