Skip to content

listen to cache changes when using FetchPolicy.NetworkOnly #579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

listen to cache changes when using FetchPolicy.NetworkOnly #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/ferry/lib/src/fetch_policy_typed_link.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ class FetchPolicyTypedLink extends TypedLink {
.request(operationRequest)
.doOnData(_removeOptimisticPatch)
.doOnData(_writeToCache)
.doOnCancel(() => cache.removeOptimisticPatch(operationRequest));
.doOnCancel(() => cache.removeOptimisticPatch(operationRequest))
.concatWith([_cacheTypedLink.request(operationRequest).skip(1)]);
case FetchPolicy.CacheOnly:
return _cacheTypedLink.request(operationRequest);
case FetchPolicy.CacheFirst:
Expand Down
152 changes: 151 additions & 1 deletion packages/ferry/test/typed_links/fetch_policy_typed_link_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import 'package:rxdart/rxdart.dart';
import 'package:ferry/src/fetch_policy_typed_link.dart';
import 'package:ferry_test_graphql2/queries/__generated__/human_with_args.req.gql.dart';
import 'package:ferry_test_graphql2/queries/__generated__/human_with_args.data.gql.dart';
import 'package:ferry_test_graphql2/fragments/__generated__/human_fragment.req.gql.dart';

import './fetch_policy_typed_link_test.mocks.dart';

Expand Down Expand Up @@ -50,10 +51,13 @@ void main() {
late StreamController<OperationRequest> requestController;
late TypedLink typedLink;
late Cache cache;
late FetchPolicyTypedLink fetchPolicyTypedLink;

setUp(() {
requestController = StreamController<OperationRequest>();
cache = Cache();
fetchPolicyTypedLink = FetchPolicyTypedLink(link: mockLink, cache: cache);

typedLink = TypedLink.from([
TypedLink.function(
<TData, TVars>(req, [forward]) => requestController.stream
Expand All @@ -62,7 +66,7 @@ void main() {
(req) => forward!(req),
),
),
FetchPolicyTypedLink(link: mockLink, cache: cache),
fetchPolicyTypedLink,
]);
});

Expand Down Expand Up @@ -164,6 +168,54 @@ void main() {
]),
);
});

test('emit new event when cache changes', () async {
final modifiedName = 'modified name';
final modifiedData = GHumanWithArgsData(
(b) => b
..human.id = 'steve'
..human.name = modifiedName
..human.height = 1.88,
);

when(mockLink.request(any, any)).thenAnswer((_) => Stream.fromIterable([
Response(data: data.toJson(), response: {}),
]));

final stream = fetchPolicyTypedLink.request(req);

unawaited(expectLater(
stream,
emitsInOrder([
// Data emitted from making a request.
equals(
OperationResponse(
operationRequest: req,
dataSource: DataSource.Link,
data: data,
),
),
// Data emitted because of changes in cache [writeFragment].
equals(
OperationResponse(
operationRequest: req,
dataSource: DataSource.Cache,
data: modifiedData,
),
),
]),
));

await pumpEventQueue();

final fragmentRequest = GHumanFragmentReq(
(b) => b.idFields = {'id': 'steve'},
);
final currentCacheData = cache.readFragment(fragmentRequest);
final modifiedCacheData =
currentCacheData!.rebuild((b) => b.name = modifiedName);
cache.writeFragment(fragmentRequest, modifiedCacheData);
});
});

group('.NetworkOnly', () {
Expand All @@ -185,6 +237,54 @@ void main() {
final second = await queue.next;
expect(second.dataSource, equals(DataSource.Link));
});

test('emit new event when cache changes', () async {
final modifiedName = 'modified name';
final modifiedData = GHumanWithArgsData(
(b) => b
..human.id = 'steve'
..human.name = modifiedName
..human.height = 1.88,
);

when(mockLink.request(any, any)).thenAnswer((_) => Stream.fromIterable([
Response(data: data.toJson(), response: {}),
]));

final stream = fetchPolicyTypedLink.request(req);

unawaited(expectLater(
stream,
emitsInOrder([
// Data emitted from making a request.
equals(
OperationResponse(
operationRequest: req,
dataSource: DataSource.Link,
data: data,
),
),
// Data emitted because of changes in cache [writeFragment].
equals(
OperationResponse(
operationRequest: req,
dataSource: DataSource.Cache,
data: modifiedData,
),
),
]),
));

await pumpEventQueue();

final fragmentRequest = GHumanFragmentReq(
(b) => b.idFields = {'id': 'steve'},
);
final currentCacheData = cache.readFragment(fragmentRequest);
final modifiedCacheData =
currentCacheData!.rebuild((b) => b.name = modifiedName);
cache.writeFragment(fragmentRequest, modifiedCacheData);
});
});

group('.CacheOnly', () {
Expand All @@ -209,6 +309,56 @@ void main() {
expect(response.dataSource, equals(DataSource.Cache));
expect(response.data, equals(data));
});

test('emit new event when cache changes', () async {
final modifiedName = 'modified name';
final modifiedData = GHumanWithArgsData(
(b) => b
..human.id = 'steve'
..human.name = modifiedName
..human.height = 1.88,
);

when(mockLink.request(any, any)).thenAnswer((_) => Stream.fromIterable([
Response(data: data.toJson(), response: {}),
]));

final stream = fetchPolicyTypedLink.request(req);
// Inistal cache data.
cache.writeQuery(req, data);

unawaited(expectLater(
stream,
emitsInOrder([
// Initial data emitted from cache.
equals(
OperationResponse(
operationRequest: req,
dataSource: DataSource.Cache,
data: data,
),
),
// Data emitted because of changes in cache [writeFragment].
equals(
OperationResponse(
operationRequest: req,
dataSource: DataSource.Cache,
data: modifiedData,
),
),
]),
));

await pumpEventQueue();

final fragmentRequest = GHumanFragmentReq(
(b) => b.idFields = {'id': 'steve'},
);
final currentCacheData = cache.readFragment(fragmentRequest);
final modifiedCacheData =
currentCacheData!.rebuild((b) => b.name = modifiedName);
cache.writeFragment(fragmentRequest, modifiedCacheData);
});
});

group('.NoCache', () {
Expand Down
78 changes: 78 additions & 0 deletions packages/ferry_test_graphql2/lib/fragments/__generated__/human_fragment.ast.gql.dart
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading