refactor(mobile): riverpod codegen + riverpod lint (#4836)

* build(mobile): add riverpod_lint

* refactor(mobile): riverpod_generator for providers

* test(mobile): fix integration test helper

* refactor: ApiService to riverpod codegen

* refactor(mobile): return curatedcontent instead of people dto

* refactor: person provider to asyncnotifier

* mobile: update service providers to use lambda

* mobile: update scaffoldbody default error icon

* remove logger mixin

---------

Co-authored-by: shalong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>
This commit is contained in:
shenlong 2023-11-19 16:04:44 +00:00 committed by GitHub
parent bfab86b70d
commit 983473261b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 732 additions and 175 deletions

View file

@ -1,44 +1,51 @@
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/modules/home/ui/asset_grid/asset_grid_data_structure.dart';
import 'package:immich_mobile/modules/search/models/curated_content.dart';
import 'package:immich_mobile/modules/search/services/person.service.dart';
import 'package:openapi/api.dart';
import 'package:immich_mobile/modules/settings/providers/app_settings.provider.dart';
import 'package:immich_mobile/modules/settings/services/app_settings.service.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
final personAssetsProvider = FutureProvider.family
.autoDispose<RenderList, String>((ref, personId) async {
final PersonService personService = ref.watch(personServiceProvider);
part 'people.provider.g.dart';
@riverpod
Future<List<CuratedContent>> getCuratedPeople(
GetCuratedPeopleRef ref,
) async {
final PersonService personService = ref.read(personServiceProvider);
final curatedPeople = await personService.getCuratedPeople();
return curatedPeople
.map((p) => CuratedContent(id: p.id, label: p.name))
.toList();
}
@riverpod
Future<RenderList> personAssets(PersonAssetsRef ref, String personId) async {
final PersonService personService = ref.read(personServiceProvider);
final assets = await personService.getPersonAssets(personId);
if (assets == null) {
return RenderList.empty();
}
return RenderList.fromAssets(assets, GroupAssetsBy.auto);
});
final getCuratedPeopleProvider =
FutureProvider.autoDispose<List<PersonResponseDto>>((ref) async {
final PersonService personService = ref.watch(personServiceProvider);
final curatedPeople = await personService.getCuratedPeople();
return curatedPeople ?? [];
});
class UpdatePersonName {
final String id;
final String name;
UpdatePersonName(this.id, this.name);
final settings = ref.read(appSettingsServiceProvider);
final groupBy =
GroupAssetsBy.values[settings.getSetting(AppSettingsEnum.groupAssetsBy)];
return await RenderList.fromAssets(assets, groupBy);
}
final updatePersonNameProvider =
StateProvider.family<void, UpdatePersonName>((ref, dto) async {
final PersonService personService = ref.watch(personServiceProvider);
@riverpod
Future<bool> updatePersonName(
UpdatePersonNameRef ref,
String personId,
String updatedName,
) async {
final PersonService personService = ref.read(personServiceProvider);
final person = await personService.updateName(personId, updatedName);
final person = await personService.updateName(dto.id, dto.name);
if (person != null && person.name == dto.name) {
if (person != null && person.name == updatedName) {
ref.invalidate(getCuratedPeopleProvider);
return true;
}
});
return false;
}

View file

@ -0,0 +1,320 @@
// GENERATED CODE - DO NOT MODIFY BY HAND
part of 'people.provider.dart';
// **************************************************************************
// RiverpodGenerator
// **************************************************************************
String _$getCuratedPeopleHash() => r'2a534553812abe69abce2c2e41aa62b8de16e9d0';
/// See also [getCuratedPeople].
@ProviderFor(getCuratedPeople)
final getCuratedPeopleProvider =
AutoDisposeFutureProvider<List<CuratedContent>>.internal(
getCuratedPeople,
name: r'getCuratedPeopleProvider',
debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product')
? null
: _$getCuratedPeopleHash,
dependencies: null,
allTransitiveDependencies: null,
);
typedef GetCuratedPeopleRef
= AutoDisposeFutureProviderRef<List<CuratedContent>>;
String _$personAssetsHash() => r'1d6eff5ca3aa630b58c4dad9516193b21896984d';
/// Copied from Dart SDK
class _SystemHash {
_SystemHash._();
static int combine(int hash, int value) {
// ignore: parameter_assignments
hash = 0x1fffffff & (hash + value);
// ignore: parameter_assignments
hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10));
return hash ^ (hash >> 6);
}
static int finish(int hash) {
// ignore: parameter_assignments
hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3));
// ignore: parameter_assignments
hash = hash ^ (hash >> 11);
return 0x1fffffff & (hash + ((0x00003fff & hash) << 15));
}
}
/// See also [personAssets].
@ProviderFor(personAssets)
const personAssetsProvider = PersonAssetsFamily();
/// See also [personAssets].
class PersonAssetsFamily extends Family<AsyncValue<RenderList>> {
/// See also [personAssets].
const PersonAssetsFamily();
/// See also [personAssets].
PersonAssetsProvider call(
String personId,
) {
return PersonAssetsProvider(
personId,
);
}
@override
PersonAssetsProvider getProviderOverride(
covariant PersonAssetsProvider provider,
) {
return call(
provider.personId,
);
}
static const Iterable<ProviderOrFamily>? _dependencies = null;
@override
Iterable<ProviderOrFamily>? get dependencies => _dependencies;
static const Iterable<ProviderOrFamily>? _allTransitiveDependencies = null;
@override
Iterable<ProviderOrFamily>? get allTransitiveDependencies =>
_allTransitiveDependencies;
@override
String? get name => r'personAssetsProvider';
}
/// See also [personAssets].
class PersonAssetsProvider extends AutoDisposeFutureProvider<RenderList> {
/// See also [personAssets].
PersonAssetsProvider(
String personId,
) : this._internal(
(ref) => personAssets(
ref as PersonAssetsRef,
personId,
),
from: personAssetsProvider,
name: r'personAssetsProvider',
debugGetCreateSourceHash:
const bool.fromEnvironment('dart.vm.product')
? null
: _$personAssetsHash,
dependencies: PersonAssetsFamily._dependencies,
allTransitiveDependencies:
PersonAssetsFamily._allTransitiveDependencies,
personId: personId,
);
PersonAssetsProvider._internal(
super._createNotifier, {
required super.name,
required super.dependencies,
required super.allTransitiveDependencies,
required super.debugGetCreateSourceHash,
required super.from,
required this.personId,
}) : super.internal();
final String personId;
@override
Override overrideWith(
FutureOr<RenderList> Function(PersonAssetsRef provider) create,
) {
return ProviderOverride(
origin: this,
override: PersonAssetsProvider._internal(
(ref) => create(ref as PersonAssetsRef),
from: from,
name: null,
dependencies: null,
allTransitiveDependencies: null,
debugGetCreateSourceHash: null,
personId: personId,
),
);
}
@override
AutoDisposeFutureProviderElement<RenderList> createElement() {
return _PersonAssetsProviderElement(this);
}
@override
bool operator ==(Object other) {
return other is PersonAssetsProvider && other.personId == personId;
}
@override
int get hashCode {
var hash = _SystemHash.combine(0, runtimeType.hashCode);
hash = _SystemHash.combine(hash, personId.hashCode);
return _SystemHash.finish(hash);
}
}
mixin PersonAssetsRef on AutoDisposeFutureProviderRef<RenderList> {
/// The parameter `personId` of this provider.
String get personId;
}
class _PersonAssetsProviderElement
extends AutoDisposeFutureProviderElement<RenderList> with PersonAssetsRef {
_PersonAssetsProviderElement(super.provider);
@override
String get personId => (origin as PersonAssetsProvider).personId;
}
String _$updatePersonNameHash() => r'c7179a7cc558669c3b30b03fbca7782a42f2b6fd';
/// See also [updatePersonName].
@ProviderFor(updatePersonName)
const updatePersonNameProvider = UpdatePersonNameFamily();
/// See also [updatePersonName].
class UpdatePersonNameFamily extends Family<AsyncValue<bool>> {
/// See also [updatePersonName].
const UpdatePersonNameFamily();
/// See also [updatePersonName].
UpdatePersonNameProvider call(
String personId,
String updatedName,
) {
return UpdatePersonNameProvider(
personId,
updatedName,
);
}
@override
UpdatePersonNameProvider getProviderOverride(
covariant UpdatePersonNameProvider provider,
) {
return call(
provider.personId,
provider.updatedName,
);
}
static const Iterable<ProviderOrFamily>? _dependencies = null;
@override
Iterable<ProviderOrFamily>? get dependencies => _dependencies;
static const Iterable<ProviderOrFamily>? _allTransitiveDependencies = null;
@override
Iterable<ProviderOrFamily>? get allTransitiveDependencies =>
_allTransitiveDependencies;
@override
String? get name => r'updatePersonNameProvider';
}
/// See also [updatePersonName].
class UpdatePersonNameProvider extends AutoDisposeFutureProvider<bool> {
/// See also [updatePersonName].
UpdatePersonNameProvider(
String personId,
String updatedName,
) : this._internal(
(ref) => updatePersonName(
ref as UpdatePersonNameRef,
personId,
updatedName,
),
from: updatePersonNameProvider,
name: r'updatePersonNameProvider',
debugGetCreateSourceHash:
const bool.fromEnvironment('dart.vm.product')
? null
: _$updatePersonNameHash,
dependencies: UpdatePersonNameFamily._dependencies,
allTransitiveDependencies:
UpdatePersonNameFamily._allTransitiveDependencies,
personId: personId,
updatedName: updatedName,
);
UpdatePersonNameProvider._internal(
super._createNotifier, {
required super.name,
required super.dependencies,
required super.allTransitiveDependencies,
required super.debugGetCreateSourceHash,
required super.from,
required this.personId,
required this.updatedName,
}) : super.internal();
final String personId;
final String updatedName;
@override
Override overrideWith(
FutureOr<bool> Function(UpdatePersonNameRef provider) create,
) {
return ProviderOverride(
origin: this,
override: UpdatePersonNameProvider._internal(
(ref) => create(ref as UpdatePersonNameRef),
from: from,
name: null,
dependencies: null,
allTransitiveDependencies: null,
debugGetCreateSourceHash: null,
personId: personId,
updatedName: updatedName,
),
);
}
@override
AutoDisposeFutureProviderElement<bool> createElement() {
return _UpdatePersonNameProviderElement(this);
}
@override
bool operator ==(Object other) {
return other is UpdatePersonNameProvider &&
other.personId == personId &&
other.updatedName == updatedName;
}
@override
int get hashCode {
var hash = _SystemHash.combine(0, runtimeType.hashCode);
hash = _SystemHash.combine(hash, personId.hashCode);
hash = _SystemHash.combine(hash, updatedName.hashCode);
return _SystemHash.finish(hash);
}
}
mixin UpdatePersonNameRef on AutoDisposeFutureProviderRef<bool> {
/// The parameter `personId` of this provider.
String get personId;
/// The parameter `updatedName` of this provider.
String get updatedName;
}
class _UpdatePersonNameProviderElement
extends AutoDisposeFutureProviderElement<bool> with UpdatePersonNameRef {
_UpdatePersonNameProviderElement(super.provider);
@override
String get personId => (origin as UpdatePersonNameProvider).personId;
@override
String get updatedName => (origin as UpdatePersonNameProvider).updatedName;
}
// ignore_for_file: type=lint
// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member

View file

@ -1,44 +1,40 @@
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/shared/models/asset.dart';
import 'package:immich_mobile/shared/providers/api.provider.dart';
import 'package:immich_mobile/shared/services/api.service.dart';
import 'package:logging/logging.dart';
import 'package:openapi/api.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
final personServiceProvider = Provider(
(ref) => PersonService(
ref.watch(apiServiceProvider),
),
);
part 'person.service.g.dart';
@riverpod
PersonService personService(PersonServiceRef ref) =>
PersonService(ref.read(apiServiceProvider));
class PersonService {
final Logger _log = Logger("PersonService");
final ApiService _apiService;
PersonService(this._apiService);
Future<List<PersonResponseDto>?> getCuratedPeople() async {
Future<List<PersonResponseDto>> getCuratedPeople() async {
try {
final peopleResponseDto = await _apiService.personApi.getAllPeople();
return peopleResponseDto?.people;
} catch (e) {
debugPrint("Error [getCuratedPeople] ${e.toString()}");
return null;
return peopleResponseDto?.people ?? [];
} catch (error, stack) {
_log.severe("Error while fetching curated people", error, stack);
return [];
}
}
Future<List<Asset>?> getPersonAssets(String id) async {
try {
final assets = await _apiService.personApi.getPersonAssets(id);
if (assets == null) {
return null;
}
return assets.map((e) => Asset.remote(e)).toList();
} catch (e) {
debugPrint("Error [getPersonAssets] ${e.toString()}");
return null;
return assets?.map((e) => Asset.remote(e)).toList();
} catch (error, stack) {
_log.severe("Error while fetching person assets", error, stack);
}
return null;
}
Future<PersonResponseDto?> updateName(String id, String name) async {
@ -49,9 +45,9 @@ class PersonService {
name: name,
),
);
} catch (e) {
debugPrint("Error [updateName] ${e.toString()}");
return null;
} catch (error, stack) {
_log.severe("Error while updating person name", error, stack);
}
return null;
}
}

View file

@ -0,0 +1,25 @@
// GENERATED CODE - DO NOT MODIFY BY HAND
part of 'person.service.dart';
// **************************************************************************
// RiverpodGenerator
// **************************************************************************
String _$personServiceHash() => r'3fc3dcf4603c7b55c0deae65f39f6c212eea492b';
/// See also [personService].
@ProviderFor(personService)
final personServiceProvider = AutoDisposeProvider<PersonService>.internal(
personService,
name: r'personServiceProvider',
debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product')
? null
: _$personServiceHash,
dependencies: null,
allTransitiveDependencies: null,
);
typedef PersonServiceRef = AutoDisposeProviderRef<PersonService>;
// ignore_for_file: type=lint
// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member

View file

@ -25,6 +25,7 @@ class PersonNameEditForm extends HookConsumerWidget {
@override
Widget build(BuildContext context, WidgetRef ref) {
final controller = useTextEditingController(text: personName);
final isError = useState(false);
return AlertDialog(
title: const Text(
@ -37,18 +38,16 @@ class PersonNameEditForm extends HookConsumerWidget {
autofocus: true,
decoration: InputDecoration(
hintText: 'search_page_person_add_name_dialog_hint'.tr(),
border: const OutlineInputBorder(),
errorText: isError.value ? 'Error occured' : null,
),
),
),
actions: [
TextButton(
style: TextButton.styleFrom(),
onPressed: () {
Navigator.of(context, rootNavigator: true)
.pop<PersonNameEditFormResult>(
PersonNameEditFormResult(false, ''),
);
},
onPressed: () => context.pop(
PersonNameEditFormResult(false, ''),
),
child: Text(
"search_page_person_add_name_dialog_cancel",
style: TextStyle(
@ -58,17 +57,15 @@ class PersonNameEditForm extends HookConsumerWidget {
).tr(),
),
TextButton(
onPressed: () {
ref.read(
updatePersonNameProvider(
UpdatePersonName(personId, controller.text),
),
);
Navigator.of(context, rootNavigator: true)
.pop<PersonNameEditFormResult>(
PersonNameEditFormResult(true, controller.text),
onPressed: () async {
isError.value = false;
final result = await ref.read(
updatePersonNameProvider(personId, controller.text).future,
);
isError.value = !result;
if (result) {
context.pop(PersonNameEditFormResult(true, controller.text));
}
},
child: Text(
"search_page_person_add_name_dialog_save",

View file

@ -2,7 +2,6 @@ import 'package:easy_localization/easy_localization.dart';
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/extensions/build_context_extensions.dart';
import 'package:immich_mobile/modules/search/models/curated_content.dart';
import 'package:immich_mobile/modules/search/providers/people.provider.dart';
import 'package:immich_mobile/modules/search/ui/explore_grid.dart';
import 'package:immich_mobile/shared/ui/immich_loading_indicator.dart';
@ -36,14 +35,7 @@ class AllPeoplePage extends HookConsumerWidget {
),
data: (people) => ExploreGrid(
isPeople: true,
curatedContent: people
.map(
(person) => CuratedContent(
label: person.name,
id: person.id,
),
)
.toList(),
curatedContent: people,
),
),
);

View file

@ -2,11 +2,13 @@ import 'package:easy_localization/easy_localization.dart';
import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:immich_mobile/extensions/asyncvalue_extensions.dart';
import 'package:immich_mobile/extensions/build_context_extensions.dart';
import 'package:immich_mobile/modules/home/ui/asset_grid/immich_asset_grid.dart';
import 'package:immich_mobile/modules/search/providers/people.provider.dart';
import 'package:immich_mobile/modules/search/ui/person_name_edit_form.dart';
import 'package:immich_mobile/shared/models/store.dart' as isar_store;
import 'package:immich_mobile/shared/ui/scaffold_error_body.dart';
import 'package:immich_mobile/utils/image_url_builder.dart';
class PersonResultPage extends HookConsumerWidget {
@ -24,12 +26,12 @@ class PersonResultPage extends HookConsumerWidget {
final name = useState(personName);
showEditNameDialog() {
showDialog<PersonNameEditFormResult>(
showDialog(
context: context,
builder: (BuildContext context) {
return PersonNameEditForm(
personId: personId,
personName: personName,
personName: name.value,
);
},
).then((result) {
@ -66,35 +68,33 @@ class PersonResultPage extends HookConsumerWidget {
}
buildTitleBlock() {
if (name.value == "") {
return GestureDetector(
onTap: showEditNameDialog,
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
'search_page_person_add_name_title',
style: context.textTheme.titleSmall?.copyWith(
color: context.themeData.colorScheme.secondary,
),
).tr(),
Text(
'search_page_person_add_name_subtitle',
style: context.textTheme.labelSmall,
).tr(),
],
),
);
}
return Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
name.value,
style: context.textTheme.titleLarge,
),
],
return GestureDetector(
onTap: showEditNameDialog,
child: name.value.isEmpty
? Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
'search_page_person_add_name_title',
style: context.textTheme.titleSmall?.copyWith(
color: context.themeData.colorScheme.secondary,
),
).tr(),
Text(
'search_page_person_add_name_subtitle',
style: context.textTheme.labelSmall,
).tr(),
],
)
: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
name.value,
style: context.textTheme.titleLarge,
),
],
),
);
}
@ -112,41 +112,32 @@ class PersonResultPage extends HookConsumerWidget {
),
],
),
body: ref.watch(personAssetsProvider(personId)).when(
loading: () => const Center(child: CircularProgressIndicator()),
error: (error, stackTrace) => Center(
child: Text(
error.toString(),
),
),
data: (data) => data.isEmpty
? const Center(
child: Text('Opps'),
)
: ImmichAssetGrid(
renderList: data,
topWidget: Padding(
padding: const EdgeInsets.only(left: 8.0, top: 24),
child: Row(
children: [
CircleAvatar(
radius: 36,
backgroundImage: NetworkImage(
getFaceThumbnailUrl(personId),
headers: {
"Authorization":
"Bearer ${isar_store.Store.get(isar_store.StoreKey.accessToken)}",
},
),
),
Padding(
padding: const EdgeInsets.only(left: 16.0),
child: buildTitleBlock(),
),
],
body: ref.watch(personAssetsProvider(personId)).scaffoldBodyWhen(
onData: (renderList) => ImmichAssetGrid(
renderList: renderList,
topWidget: Padding(
padding: const EdgeInsets.only(left: 8.0, top: 24),
child: Row(
children: [
CircleAvatar(
radius: 36,
backgroundImage: NetworkImage(
getFaceThumbnailUrl(personId),
headers: {
"Authorization":
"Bearer ${isar_store.Store.get(isar_store.StoreKey.accessToken)}",
},
),
),
),
Padding(
padding: const EdgeInsets.only(left: 16.0),
child: buildTitleBlock(),
),
],
),
),
),
onError: const ScaffoldErrorBody(icon: Icons.person_off_outlined),
),
);
}

View file

@ -77,15 +77,7 @@ class SearchPage extends HookConsumerWidget {
loading: () => const Center(child: ImmichLoadingIndicator()),
error: (err, stack) => Center(child: Text('Error: $err')),
data: (people) => CuratedPeopleRow(
content: people
.map(
(person) => CuratedContent(
id: person.id,
label: person.name,
),
)
.take(12)
.toList(),
content: people.take(12).toList(),
onTap: (content, index) {
context.autoPush(
PersonResultRoute(