talksik/fl-query
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat: use function hooks instead of class hooks

Browse Source
This commit is contained in:
Kingkor Roy Tirtho
2023-02-26 10:51:28 +06:00
parent d964216ee1
commit 1ea9370570
8 changed files with 140 additions and 578 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/fl_query_hooks/lib/src/use_query.dart
+37 -167
View File
@@ -1,8 +1,9 @@
import 'dart:async';
import 'package:fl_query/fl_query.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart';
import 'package:fl_query_hooks/src/use_query_client.dart';
import 'package:fl_query_hooks/src/utils/use_updater.dart';
import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
Query<DataType, ErrorType> useQuery<DataType, ErrorType>(
@@ -15,185 +16,54 @@ Query<DataType, ErrorType> useQuery<DataType, ErrorType>(
final ValueChanged<DataType>? onData,
final ValueChanged<ErrorType>? onError,
// widget specific
// hook specific
final bool enabled = true,
}) {
return use(
UseQuery<DataType, ErrorType>(
final rebuild = useUpdater();
final client = useQueryClient();
final query = useMemoized(() {
return client.createQuery<DataType, ErrorType>(
queryKey,
queryFn,
initial: initial,
retryConfig: retryConfig,
refreshConfig: refreshConfig,
jsonConfig: jsonConfig,
onData: onData,
onError: onError,
enabled: enabled,
),
);
}
class UseQuery<DataType, ErrorType> extends Hook<Query<DataType, ErrorType>> {
final QueryFn<DataType> queryFn;
final String queryKey;
final DataType? initial;
final RetryConfig retryConfig;
final RefreshConfig refreshConfig;
final JsonConfig<DataType>? jsonConfig;
final ValueChanged<DataType>? onData;
final ValueChanged<ErrorType>? onError;
// hook specific
final bool enabled;
const UseQuery(
this.queryKey,
this.queryFn, {
this.initial,
this.retryConfig = DefaultConstants.retryConfig,
this.refreshConfig = DefaultConstants.refreshConfig,
this.jsonConfig,
this.onData,
this.onError,
this.enabled = true,
super.keys,
}) : assert(
(jsonConfig != null && enabled) || jsonConfig == null,
'jsonConfig is only supported when enabled is true',
);
@override
HookState<Query<DataType, ErrorType>, UseQuery<DataType, ErrorType>>
createState() => _UseQueryState<DataType, ErrorType>();
}
class _UseQueryState<DataType, ErrorType> extends HookState<
Query<DataType, ErrorType>, UseQuery<DataType, ErrorType>> {
Query<DataType, ErrorType>? query;
VoidCallback? removeListener;
StreamSubscription<DataType>? dataSubscription;
StreamSubscription<ErrorType>? errorSubscription;
void rebuild([_]) {
setState(() {});
}
void _createQuery() {
query = QueryClient.of(context).createQuery(
hook.queryKey,
hook.queryFn,
initial: hook.initial,
retryConfig: hook.retryConfig,
refreshConfig: hook.refreshConfig,
jsonConfig: hook.jsonConfig,
refreshConfig: refreshConfig,
retryConfig: retryConfig,
);
}
}, [client, queryKey]);
Future<void> initialize() async {
setState(() {
_createQuery();
if (hook.onData != null)
dataSubscription = query!.dataStream.listen(hook.onData);
if (hook.onData != null)
errorSubscription = query!.errorStream.listen(hook.onError);
useEffect(() {
return query.addListener(rebuild);
}, [query]);
removeListener = query!.addListener(rebuild);
});
if (hook.enabled) {
await query!.fetch();
useEffect(() {
query.updateQueryFn(queryFn);
return null;
}, [queryFn, query]);
useEffect(() {
if (enabled) {
query.fetch();
}
}
return null;
}, [enabled]);
@override
void initHook() {
super.initHook();
WidgetsBinding.instance.addPostFrameCallback((_) async {
await initialize();
});
}
useEffect(() {
StreamSubscription<DataType>? dataSubscription;
StreamSubscription<ErrorType>? errorSubscription;
@override
void dispose() {
dataSubscription?.cancel();
errorSubscription?.cancel();
removeListener?.call();
super.dispose();
}
if (onData != null) {
dataSubscription = query.dataStream.listen(onData);
}
if (onError != null) {
errorSubscription = query.errorStream.listen(onError);
}
@override
void didUpdateHook(
UseQuery<DataType, ErrorType> oldHook,
) {
super.didUpdateHook(oldHook);
if (oldHook.queryKey != hook.queryKey) {
return () {
dataSubscription?.cancel();
errorSubscription?.cancel();
removeListener?.call();
initialize();
return;
} else if (oldHook.enabled != hook.enabled && hook.enabled) {
query!.fetch();
}
if (oldHook.queryFn != hook.queryFn) {
query!.updateQueryFn(hook.queryFn);
}
if (oldHook.onData != hook.onData) {
dataSubscription?.cancel();
if (hook.onData != null)
dataSubscription = query!.dataStream.listen(hook.onData);
}
if (oldHook.onError != hook.onError) {
errorSubscription?.cancel();
if (hook.onError != null)
errorSubscription = query!.errorStream.listen(hook.onError);
}
}
};
}, [onData, onError, query]);
@override
Query<DataType, ErrorType> build(BuildContext context) {
if (query == null) {
_createQuery();
}
return query!;
}
@override
void debugFillProperties(DiagnosticPropertiesBuilder properties) {
super.debugFillProperties(properties);
properties.add(
DiagnosticsProperty<Query<DataType, ErrorType>>('query', query),
);
properties.add(
DiagnosticsProperty<String>('queryKey', hook.queryKey),
);
properties.add(DiagnosticsProperty<DataType>('initial', hook.initial));
properties.add(
DiagnosticsProperty<RetryConfig>('retryConfig', hook.retryConfig),
);
properties.add(
DiagnosticsProperty<RefreshConfig>(
'refreshConfig',
hook.refreshConfig,
),
);
properties.add(
DiagnosticsProperty<JsonConfig<DataType>>(
'jsonConfig',
hook.jsonConfig,
),
);
properties.add(
DiagnosticsProperty<ValueChanged<DataType>>('onData', hook.onData),
);
properties.add(
DiagnosticsProperty<ValueChanged<ErrorType>>('onError', hook.onError),
);
properties.add(DiagnosticsProperty<bool>('enabled', hook.enabled));
}
return query;
}