fl-query/packages/fl_query/test/query_test.dart

import 'dart:math';

import 'package:connectivity_plus/connectivity_plus.dart';
import 'package:fl_query/src/models/query_job.dart';
import 'package:fl_query/src/query.dart';
import 'package:fl_query/src/query_bowl.dart';
import 'package:fl_query/src/utils.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:mockito/annotations.dart';
import 'package:mockito/mockito.dart';
import 'query_test.mocks.dart';

@GenerateMocks(
  [QueryBowl, Connectivity],
  customMocks: [
    MockSpec<QueryJob<Object, void>>(
      as: #MockQueryJobVoidObject,
      returnNullOnMissingStub: true,
    ),
  ],
)
void main() {
  // for testing query without external data
  late Query query;
  late MockQueryJobVoidObject queryJob;
  setUp(() {
    queryJob = MockQueryJobVoidObject();
    when(queryJob.queryKey).thenReturn("test");
    when(queryJob.task).thenAnswer(
      (_) =>
          (_, __) => Future.delayed(Duration(milliseconds: 300), () => "test"),
    );
    query = Query.fromOptions(
      queryJob,
      externalData: null,
    );
  });

  group("Query Test", () {
    test("default values", () {
      expect(query.enabled, isTrue);
      expect(query.refetchCount, 0);
      expect(query.retries, 3);
      expect(query.retryAttempts, 0);
      expect(query.fetched, isFalse);
      expect(query.retryDelay, Duration(milliseconds: 200));
      expect(query.status, QueryStatus.idle);
      expect(query.isStale, isFalse);
      expect(query.isIdle, true);
      expect(query.isInactive, isTrue);
      expect(query.isLoading, isFalse);
      expect(query.isSuccess, isFalse);
      expect(query.hasError, isFalse);
      expect(query.hasData, isFalse);
    });

    test("calling fetch for the first time runs the _execute method", () async {
      final data = await query.fetch();
      expect(data, "test");
      expect(query.fetched, isTrue);
      verify(queryJob.task).called(1);
    });

    test(
        "calling fetch twice or more should return same data where _execute gets called once",
        () async {
      final data1 = await query.fetch();
      final data2 = await query.fetch();

      await query.fetch();
      await query.fetch();
      expect(data1, data2);
      verify(queryJob.task).called(1);
    });

    test('calling refetch should return new data', () async {
      reset(queryJob);
      when(queryJob.queryKey).thenReturn("test");
      when(queryJob.task).thenAnswer(
        (_) => (_, __) => Future.value(Random().nextInt(100)),
      );
      query = Query.fromOptions(
        queryJob,
        externalData: null,
      );

      await Future.delayed(Duration(milliseconds: 100));
      await query.fetch().then((data) async {
        final refetchData = await query.refetch();
        expect(data, isNot(equals(refetchData)));
      });
    });

    test(
      "refetch should not run When another refetch is already running",
      () async {
        await query.fetch();
        await Future.delayed(Duration(milliseconds: 100));
        await Future.wait([
          query.refetch(),
          query.refetch(),
        ]);
        expect(query.refetchCount, 1);
      },
    );
    test(
      "failing task should be retried the amount of times passed as retries parameter",
      () async {
        reset(queryJob);
        when(queryJob.queryKey).thenReturn("test");
        when(queryJob.task).thenAnswer(
          (_) => (_, __) => Future.error("Error"),
        );
        query = Query.fromOptions(
          queryJob,
          externalData: null,
        );

        await query.fetch();

        expect(query.retryAttempts, 3);
        expect(query.isError, true);
      },
    );
    test(
      "onData listeners are called When new data is fetched and set",
      () async {
        int count = 0;
        query.addDataListener((_) {
          count++;
        });
        await query.fetch();
        expect(count, 1);
      },
    );
    test(
      "onError listeners are called When any error occurs",
      () async {
        reset(queryJob);
        when(queryJob.queryKey).thenReturn("test");
        when(queryJob.task).thenAnswer(
          (_) => (_, __) => Future.error("Error"),
        );
        query = Query.fromOptions(
          queryJob,
          externalData: null,
        );
        int count = 0;
        query.addErrorListener((_) {
          count++;
        });
        await query.fetch();
        expect(count, 1);
      },
    );
    test("query should become stale after defined amount time", () async {
      when(queryJob.staleTime).thenReturn(Duration(milliseconds: 500));
      query = Query.fromOptions(
        queryJob,
        externalData: null,
      );
      expect(query.isStale, isFalse);
      await Future.delayed(Duration(milliseconds: 300));
      expect(query.isStale, isFalse);
      await Future.delayed(Duration(milliseconds: 600));
      expect(query.isStale, isTrue);
    });
    test(
      "query should refetch in interval When refetchInterval is specified",
      () async {
        reset(queryJob);
        when(queryJob.queryKey).thenReturn("test");
        when(queryJob.task).thenAnswer(
          (_) => (_, __) => Future.value(Random().nextInt(100)),
        );
        when(queryJob.staleTime).thenReturn(
          Duration(milliseconds: 1),
        );
        when(queryJob.refetchInterval).thenReturn(
          Duration(milliseconds: 200),
        );
        query = Query.fromOptions(
          queryJob,
          externalData: null,
        );

        final data = await query.fetch();
        await Future.delayed(Duration(milliseconds: 400));
        expect(data, isNot(equals(await query.fetch())));
      },
    );
    test(
      "query should revalidate When a new caller gets mounted",
      () async {
        reset(queryJob);
        when(queryJob.queryKey).thenReturn("test");
        when(queryJob.task).thenAnswer(
          (_) => (_, __) => Future.value(Random().nextInt(150)),
        );
        when(queryJob.refetchOnMount).thenReturn(true);
        query = Query.fromOptions(
          queryJob,
          externalData: null,
        );
        final data = await query.fetch();
        query.invalidate();
        query.mount(ValueKey<String>(uuid.v4()));
        await Future.delayed(Duration(milliseconds: 100));
        expect(data, isNot(equals(await query.fetch())));
        expect(query.refetchCount, 1);
      },
    );
    test(
      "query should not revalidate When there's no Internet Connectivity and a new caller gets mounted",
      () async {
        final connectivityMock = MockConnectivity();
        when(connectivityMock.checkConnectivity()).thenAnswer(
          (_) async => ConnectivityResult.none,
        );
        reset(queryJob);
        when(queryJob.queryKey).thenReturn("test");
        when(queryJob.task).thenAnswer(
          (_) => (_, __) => Future.value(Random().nextInt(150)),
        );
        when(queryJob.connectivity).thenReturn(connectivityMock);
        when(queryJob.refetchOnMount).thenReturn(true);
        query = Query.fromOptions(
          queryJob,
          externalData: null,
        );
        final data = await query.fetch();
        query.invalidate();
        query.mount(ValueKey<String>(uuid.v4()));
        await Future.delayed(Duration(milliseconds: 100));
        expect(data, equals(await query.fetch()));
        expect(query.refetchCount, 0);
      },
    );
  });
}