Browse Source

refactor: use named records for version checks

Signed-off-by: Nikolas Rimikis <leptopoda@users.noreply.github.com>
pull/1044/head
Nikolas Rimikis 1 year ago
parent
commit
aa54c23c44
No known key found for this signature in database
GPG Key ID: 85ED1DE9786A4FF2
  1. 17
      packages/neon/neon/lib/src/blocs/apps.dart
  2. 10
      packages/neon/neon/lib/src/models/app_implementation.dart
  3. 8
      packages/neon/neon_dashboard/lib/src/app.dart
  4. 7
      packages/neon/neon_files/lib/neon_files.dart
  5. 2
      packages/neon/neon_news/lib/neon_news.dart
  6. 6
      packages/neon/neon_notes/lib/neon_notes.dart
  7. 8
      packages/neon/neon_notifications/lib/neon_notifications.dart
  8. 1
      packages/nextcloud/lib/nextcloud.dart
  9. 2
      packages/nextcloud/lib/src/helpers/common.dart
  10. 10
      packages/nextcloud/lib/src/helpers/core.dart
  11. 7
      packages/nextcloud/lib/src/helpers/news.dart
  12. 10
      packages/nextcloud/lib/src/helpers/notes.dart
  13. 4
      packages/nextcloud/test/core_test.dart
  14. 4
      packages/nextcloud/test/news_test.dart
  15. 4
      packages/nextcloud/test/notes_test.dart

17
packages/neon/neon/lib/src/blocs/apps.dart

@ -123,9 +123,9 @@ class AppsBloc extends InteractiveBloc implements AppsBlocEvents, AppsBlocStates
final notSupported = <String, String?>{};
try {
final (coreSupported, coreMinimumVersion) = _account.client.core.isSupported(capabilities.requireData);
if (!coreSupported) {
notSupported['core'] = coreMinimumVersion.toString();
final coreCheck = _account.client.core.isSupported(capabilities.requireData);
if (!coreCheck.isSupported) {
notSupported['core'] = coreCheck.minimumVersion.toString();
}
} catch (e, s) {
debugPrint(e.toString());
@ -134,9 +134,14 @@ class AppsBloc extends InteractiveBloc implements AppsBlocEvents, AppsBlocStates
for (final app in apps.requireData) {
try {
final (supported, minimumVersion) = await app.isSupported(_account, capabilities.requireData);
if (!(supported ?? true)) {
notSupported[app.id] = minimumVersion;
final check = await app.isSupported(_account, capabilities.requireData);
if (check == null) {
continue;
}
if (!check.isSupported) {
notSupported[app.id] = check.minimumVersion;
}
} catch (e, s) {
debugPrint(e.toString());

10
packages/neon/neon/lib/src/models/app_implementation.dart

@ -15,6 +15,7 @@ import 'package:neon/src/settings/models/storage.dart';
import 'package:neon/src/utils/provider.dart';
import 'package:neon/src/widgets/drawer_destination.dart';
import 'package:nextcloud/core.dart' as core;
import 'package:nextcloud/nextcloud.dart' show VersionSupported;
import 'package:provider/provider.dart';
import 'package:rxdart/rxdart.dart';
import 'package:vector_graphics/vector_graphics.dart';
@ -36,15 +37,14 @@ abstract class AppImplementation<T extends Bloc, R extends NextcloudAppOptions>
/// Checks if the app is supported on the server of the [account].
///
/// A `supported` value of `null` means that it can not be known if the app is supported.
/// A value of `null` means that it can not be known if the app is supported.
/// This is the case for apps that depend on the server version like files and we assume that the app is supported.
/// The server support is handled differently.
///
/// The first value of the record is the supported status and the second value is the supported minimum version.
FutureOr<(bool? supported, String? minimumVersion)> isSupported(
FutureOr<VersionSupported<String>?> isSupported(
final Account account,
final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities,
);
) =>
null;
final blocsCache = AccountCache<T>();

8
packages/neon/neon_dashboard/lib/src/app.dart

@ -6,7 +6,6 @@ import 'package:neon_dashboard/src/blocs/dashboard.dart';
import 'package:neon_dashboard/src/options.dart';
import 'package:neon_dashboard/src/pages/main.dart';
import 'package:neon_dashboard/src/routes.dart';
import 'package:nextcloud/core.dart' as core;
import 'package:nextcloud/nextcloud.dart';
/// Implementation of the server `dashboard` app.
@ -34,11 +33,4 @@ class DashboardApp extends AppImplementation<DashboardBloc, DashboardAppSpecific
@override
final RouteBase route = $dashboardAppRoute;
@override
(bool?, String?) isSupported(
final Account account,
final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities,
) =>
const (null, null);
}

7
packages/neon/neon_files/lib/neon_files.dart

@ -72,11 +72,4 @@ class FilesApp extends AppImplementation<FilesBloc, FilesAppSpecificOptions> {
@override
final RouteBase route = $filesAppRoute;
@override
(bool? supported, String? minimumVersion) isSupported(
final Account account,
final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities,
) =>
const (null, null);
}

2
packages/neon/neon_news/lib/neon_news.dart

@ -85,7 +85,7 @@ class NewsApp extends AppImplementation<NewsBloc, NewsAppSpecificOptions> {
BehaviorSubject<int> getUnreadCounter(final NewsBloc bloc) => bloc.unreadCounter;
@override
Future<(bool? supported, String? minimumVersion)> isSupported(
Future<VersionSupported<String>> isSupported(
final Account account,
final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities,
) =>

6
packages/neon/neon_notes/lib/neon_notes.dart

@ -71,11 +71,11 @@ class NotesApp extends AppImplementation<NotesBloc, NotesAppSpecificOptions> {
final RouteBase route = $notesAppRoute;
@override
(bool? supported, String? minimumVersion) isSupported(
VersionSupported<String> isSupported(
final Account account,
final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities,
) {
final (supported, minimumVersion) = account.client.notes.isSupported(capabilities);
return (supported, minimumVersion.toString());
final result = account.client.notes.isSupported(capabilities);
return (isSupported: result.isSupported, minimumVersion: result.minimumVersion.toString());
}
}

8
packages/neon/neon_notifications/lib/neon_notifications.dart

@ -13,7 +13,6 @@ import 'package:neon/utils.dart';
import 'package:neon/widgets.dart';
import 'package:neon_notifications/l10n/localizations.dart';
import 'package:neon_notifications/routes.dart';
import 'package:nextcloud/core.dart' as core;
import 'package:nextcloud/nextcloud.dart';
import 'package:nextcloud/notifications.dart' as notifications;
import 'package:rxdart/rxdart.dart';
@ -54,11 +53,4 @@ class NotificationsApp extends AppImplementation<NotificationsBloc, Notification
@override
BehaviorSubject<int> getUnreadCounter(final NotificationsBloc bloc) => bloc.unreadCounter;
@override
(bool? supported, String? minimumVersion) isSupported(
final Account account,
final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities,
) =>
const (null, null);
}

1
packages/nextcloud/lib/nextcloud.dart

@ -4,4 +4,5 @@ export 'package:dynamite_runtime/models.dart';
export 'ids.dart';
export 'src/client.dart';
export 'src/helpers/common.dart';
export 'webdav.dart';

2
packages/nextcloud/lib/src/helpers/common.dart

@ -0,0 +1,2 @@
/// The result of a version check.
typedef VersionSupported<T> = ({bool isSupported, T minimumVersion});

10
packages/nextcloud/lib/src/helpers/core.dart

@ -1,6 +1,7 @@
// ignore_for_file: public_member_api_docs
import 'package:nextcloud/src/api/core.openapi.dart' as core;
import 'package:nextcloud/src/helpers/common.dart';
/// Version of core/Server supported
const supportedVersion = 27;
@ -9,9 +10,12 @@ extension CoreVersionSupported on core.Client {
/// Check if the core/Server version is supported by this client
///
/// Also returns the supported version number
(bool, int) isSupported(final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities) => (
capabilities.version.major == supportedVersion,
supportedVersion,
VersionSupported<int> isSupported(
final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities,
) =>
(
isSupported: capabilities.version.major == supportedVersion,
minimumVersion: supportedVersion,
);
}

7
packages/nextcloud/lib/src/helpers/news.dart

@ -1,6 +1,7 @@
// ignore_for_file: public_member_api_docs
import 'package:nextcloud/src/api/news.openapi.dart' as news;
import 'package:nextcloud/src/helpers/common.dart';
/// API version of the news app supported
const supportedVersion = 'v1-3';
@ -9,11 +10,11 @@ extension NewsVersionSupported on news.Client {
/// Check if the news app version is supported by this client
///
/// Also returns the supported API version number
Future<(bool, String)> isSupported() async {
Future<VersionSupported<String>> isSupported() async {
final response = await getSupportedApiVersions();
return (
response.body.apiLevels!.contains(supportedVersion),
supportedVersion,
isSupported: response.body.apiLevels!.contains(supportedVersion),
minimumVersion: supportedVersion,
);
}
}

10
packages/nextcloud/lib/src/helpers/notes.dart

@ -1,6 +1,7 @@
import 'package:collection/collection.dart';
import 'package:nextcloud/src/api/core.openapi.dart' as core;
import 'package:nextcloud/src/api/notes.openapi.dart' as notes;
import 'package:nextcloud/src/helpers/common.dart';
import 'package:version/version.dart';
/// API version of the notes app supported
@ -11,11 +12,14 @@ extension NotesVersionSupported on notes.Client {
/// Check if the notes app version is supported by this client
///
/// Also returns the supported API version number
(bool, int) isSupported(final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities) => (
capabilities.capabilities.notesCapabilities?.notes.apiVersion
VersionSupported<int> isSupported(
final core.OcsGetCapabilitiesResponseApplicationJson_Ocs_Data capabilities,
) =>
(
isSupported: capabilities.capabilities.notesCapabilities?.notes.apiVersion
?.map(Version.parse)
.firstWhereOrNull((final version) => version.major == supportedVersion) !=
null,
supportedVersion,
minimumVersion: supportedVersion,
);
}

4
packages/nextcloud/test/core_test.dart

@ -25,8 +25,8 @@ void main() {
expect(response.statusCode, 200);
expect(() => response.headers, isA<void>());
final (supported, _) = client.core.isSupported(response.body.ocs.data);
expect(supported, isTrue);
final result = client.core.isSupported(response.body.ocs.data);
expect(result.isSupported, isTrue);
});
test('Is supported from status', () async {

4
packages/nextcloud/test/news_test.dart

@ -38,8 +38,8 @@ void main() {
);
test('Is supported', () async {
final (supported, _) = await client.news.isSupported();
expect(supported, isTrue);
final result = await client.news.isSupported();
expect(result.isSupported, isTrue);
});
test('Add feed', () async {

4
packages/nextcloud/test/notes_test.dart

@ -25,8 +25,8 @@ void main() {
expect(response.statusCode, 200);
expect(() => response.headers, isA<void>());
final (supported, _) = client.notes.isSupported(response.body.ocs.data);
expect(supported, isTrue);
final result = client.notes.isSupported(response.body.ocs.data);
expect(result.isSupported, isTrue);
});
test('Create note favorite', () async {

Loading…
Cancel
Save