Merge pull request #710 from nextcloud/feature/notifications-generated-spec

Feature/notifications generated spec
1 year ago · 892441736f
13 changed files with 6553 additions and 2151 deletions
--- a/external/nextcloud-notifications
+++ b/external/nextcloud-notifications
@ -1 +1 @@
-Subproject commit 09d3a1c9abcdd1c0ec4d8531907b56ac9f368666
+Subproject commit 9e4bfdcf04d3a17402f4b22166e1afd4fc7ff833
--- a/packages/app/integration_test/screenshot_test.dart
+++ b/packages/app/integration_test/screenshot_test.dart
@ -279,7 +279,7 @@ Future main() async {
  });

  testWidgets('notifications', (final tester) async {
-    await (await getAccount('admin')).client.notifications.sendAdminNotification(
+    await (await getAccount('admin')).client.notifications.api.generateNotification(
          userId: account.username,
          shortMessage: 'Notifications demo',
          longMessage: 'This is a notifications demo of the Neon app',
--- a/packages/neon/neon/lib/src/blocs/push_notifications.dart
+++ b/packages/neon/neon/lib/src/blocs/push_notifications.dart
@ -85,7 +85,7 @@ class PushNotificationsBloc extends Bloc implements PushNotificationsBlocEvents,

        debugPrint('Registering account $instance for push notifications on $endpoint');

-        final subscription = await account.client.notifications.registerDevice(
+        final subscription = await account.client.notifications.push.registerDevice(
          pushTokenHash: generatePushTokenHash(endpoint),
          devicePublicKey: keypair.publicKey.toFormattedPEM(),
          proxyServer: '$endpoint#', // This is a hack to make the Nextcloud server directly push to the endpoint
@ -121,7 +121,7 @@ class PushNotificationsBloc extends Bloc implements PushNotificationsBlocEvents,
  Future _unregisterUnifiedPushInstances(final List<Account> accounts) async {
    for (final account in accounts) {
      try {
-        await account.client.notifications.removeDevice();
+        await account.client.notifications.push.removeDevice();
        await UnifiedPush.unregister(account.id);
        await _storage.remove(_keyLastEndpoint(account));
      } catch (e) {
--- a/packages/neon/neon/lib/src/utils/push_utils.dart
+++ b/packages/neon/neon/lib/src/utils/push_utils.dart
@ -103,7 +103,9 @@ class PushUtils {
          account = accounts.tryFind(instance);
          if (account != null) {
            notification =
-                (await account.client.notifications.getNotification(id: pushNotification.subject.nid!)).ocs.data;
+                (await account.client.notifications.endpoint.getNotification(id: pushNotification.subject.nid!))
+                    .ocs
+                    .data;
            if (notification.icon?.endsWith('.svg') ?? false) {
              // Only SVG icons are supported right now (should be most of them)

--- a/packages/neon/neon_notifications/lib/blocs/notifications.dart
+++ b/packages/neon/neon_notifications/lib/blocs/notifications.dart
@ -50,22 +50,25 @@ class NotificationsBloc extends InteractiveBloc

  @override
  Future refresh() async {
-    await RequestManager.instance.wrapNextcloud<List<NotificationsNotification>, NotificationsListNotifications>(
+    await RequestManager.instance.wrapNextcloud<
+        List<NotificationsNotification>,
+        NotificationsResponse<NotificationsEndpointListNotificationsResponseApplicationJson,
+            NotificationsEndpointEndpointListNotificationsHeaders>>(
      _account.id,
      'notifications-notifications',
      notifications,
-      () async => _account.client.notifications.listNotifications(),
-      (final response) => response.ocs.data.toList(),
+      () async => _account.client.notifications.endpoint.listNotifications(),
+      (final response) => response.data.ocs.data.toList(),
    );
  }

  @override
  void deleteAllNotifications() {
-    wrapAction(() async => _account.client.notifications.deleteAllNotifications());
+    wrapAction(() async => _account.client.notifications.endpoint.deleteAllNotifications());
  }

  @override
  void deleteNotification(final int id) {
-    wrapAction(() async => _account.client.notifications.deleteNotification(id: id));
+    wrapAction(() async => _account.client.notifications.endpoint.deleteNotification(id: id));
  }
 }
--- a/packages/nextcloud/lib/src/api/core.openapi.dart
+++ b/packages/nextcloud/lib/src/api/core.openapi.dart
@ -4664,10 +4664,10 @@ abstract class CoreNotesCapabilities
@BuiltValue(instantiable: false)
 abstract interface class CoreNotificationsCapabilities_NotificationsInterface {
  @BuiltValueField(wireName: 'ocs-endpoints')
-  BuiltList<String>? get ocsEndpoints;
-  BuiltList<String>? get push;
+  BuiltList<String> get ocsEndpoints;
+  BuiltList<String> get push;
  @BuiltValueField(wireName: 'admin-notifications')
-  BuiltList<String>? get adminNotifications;
+  BuiltList<String> get adminNotifications;
  CoreNotificationsCapabilities_NotificationsInterface rebuild(
    final void Function(CoreNotificationsCapabilities_NotificationsInterfaceBuilder) updates,
  );
--- a/packages/nextcloud/lib/src/api/core.openapi.g.dart
+++ b/packages/nextcloud/lib/src/api/core.openapi.g.dart
@ -4077,26 +4077,15 @@ class _$CoreNotificationsCapabilities_NotificationsSerializer
  @override
  Iterable<Object?> serialize(Serializers serializers, CoreNotificationsCapabilities_Notifications object,
      {FullType specifiedType = FullType.unspecified}) {
-    final result = <Object?>[];
-    Object? value;
-    value = object.ocsEndpoints;
-    if (value != null) {
-      result
-        ..add('ocs-endpoints')
-        ..add(serializers.serialize(value, specifiedType: const FullType(BuiltList, [FullType(String)])));
-    }
-    value = object.push;
-    if (value != null) {
-      result
-        ..add('push')
-        ..add(serializers.serialize(value, specifiedType: const FullType(BuiltList, [FullType(String)])));
-    }
-    value = object.adminNotifications;
-    if (value != null) {
-      result
-        ..add('admin-notifications')
-        ..add(serializers.serialize(value, specifiedType: const FullType(BuiltList, [FullType(String)])));
-    }
+    final result = <Object?>[
+      'ocs-endpoints',
+      serializers.serialize(object.ocsEndpoints, specifiedType: const FullType(BuiltList, [FullType(String)])),
+      'push',
+      serializers.serialize(object.push, specifiedType: const FullType(BuiltList, [FullType(String)])),
+      'admin-notifications',
+      serializers.serialize(object.adminNotifications, specifiedType: const FullType(BuiltList, [FullType(String)])),
+    ];
+
    return result;
  }

@ -17095,17 +17084,24 @@ abstract mixin class CoreNotificationsCapabilities_NotificationsInterfaceBuilder

 class _$CoreNotificationsCapabilities_Notifications extends CoreNotificationsCapabilities_Notifications {
  @override
-  final BuiltList<String>? ocsEndpoints;
+  final BuiltList<String> ocsEndpoints;
  @override
-  final BuiltList<String>? push;
+  final BuiltList<String> push;
  @override
-  final BuiltList<String>? adminNotifications;
+  final BuiltList<String> adminNotifications;

  factory _$CoreNotificationsCapabilities_Notifications(
          [void Function(CoreNotificationsCapabilities_NotificationsBuilder)? updates]) =>
      (CoreNotificationsCapabilities_NotificationsBuilder()..update(updates))._build();

-  _$CoreNotificationsCapabilities_Notifications._({this.ocsEndpoints, this.push, this.adminNotifications}) : super._();
+  _$CoreNotificationsCapabilities_Notifications._(
+      {required this.ocsEndpoints, required this.push, required this.adminNotifications})
+      : super._() {
+    BuiltValueNullFieldError.checkNotNull(ocsEndpoints, r'CoreNotificationsCapabilities_Notifications', 'ocsEndpoints');
+    BuiltValueNullFieldError.checkNotNull(push, r'CoreNotificationsCapabilities_Notifications', 'push');
+    BuiltValueNullFieldError.checkNotNull(
+        adminNotifications, r'CoreNotificationsCapabilities_Notifications', 'adminNotifications');
+  }

  @override
  CoreNotificationsCapabilities_Notifications rebuild(
@ -17169,9 +17165,9 @@ class CoreNotificationsCapabilities_NotificationsBuilder
  CoreNotificationsCapabilities_NotificationsBuilder get _$this {
    final $v = _$v;
    if ($v != null) {
-      _ocsEndpoints = $v.ocsEndpoints?.toBuilder();
-      _push = $v.push?.toBuilder();
-      _adminNotifications = $v.adminNotifications?.toBuilder();
+      _ocsEndpoints = $v.ocsEndpoints.toBuilder();
+      _push = $v.push.toBuilder();
+      _adminNotifications = $v.adminNotifications.toBuilder();
      _$v = null;
    }
    return this;
@ -17196,18 +17192,16 @@ class CoreNotificationsCapabilities_NotificationsBuilder
    try {
      _$result = _$v ??
          _$CoreNotificationsCapabilities_Notifications._(
-              ocsEndpoints: _ocsEndpoints?.build(),
-              push: _push?.build(),
-              adminNotifications: _adminNotifications?.build());
+              ocsEndpoints: ocsEndpoints.build(), push: push.build(), adminNotifications: adminNotifications.build());
    } catch (_) {
      late String _$failedField;
      try {
        _$failedField = 'ocsEndpoints';
-        _ocsEndpoints?.build();
+        ocsEndpoints.build();
        _$failedField = 'push';
-        _push?.build();
+        push.build();
        _$failedField = 'adminNotifications';
-        _adminNotifications?.build();
+        adminNotifications.build();
      } catch (e) {
        throw BuiltValueNestedFieldError(r'CoreNotificationsCapabilities_Notifications', _$failedField, e.toString());
      }
--- a/packages/nextcloud/lib/src/api/core.openapi.json
+++ b/packages/nextcloud/lib/src/api/core.openapi.json
@ -898,7 +898,11 @@
        "properties": {
          "notifications": {
            "type": "object",
-            "additionalProperties": true,
+            "required": [
+              "ocs-endpoints",
+              "push",
+              "admin-notifications"
+            ],
            "properties": {
              "ocs-endpoints": {
                "type": "array",
--- a/packages/nextcloud/lib/src/api/notifications.openapi.dart
+++ b/packages/nextcloud/lib/src/api/notifications.openapi.dart
--- a/packages/nextcloud/lib/src/api/notifications.openapi.g.dart
+++ b/packages/nextcloud/lib/src/api/notifications.openapi.g.dart
--- a/packages/nextcloud/lib/src/api/notifications.openapi.json
+++ b/packages/nextcloud/lib/src/api/notifications.openapi.json
--- a/packages/nextcloud/test/notifications_test.dart
+++ b/packages/nextcloud/test/notifications_test.dart
@ -22,7 +22,7 @@ void main() {
    tearDown(() => container.destroy());

    Future sendTestNotification() async {
-      await client.notifications.sendAdminNotification(
+      await client.notifications.api.generateNotification(
        userId: 'admin',
        shortMessage: '123',
        longMessage: '456',
@ -37,7 +37,7 @@ void main() {
      await sendTestNotification();

      final startTime = DateTime.now().toUtc();
-      final response = await client.notifications.listNotifications();
+      final response = (await client.notifications.endpoint.listNotifications()).data;
      expect(response.ocs.data, hasLength(2));
      expect(response.ocs.data[0].notificationId, 2);
      expect(response.ocs.data[0].app, 'admin_notifications');
@ -49,9 +49,9 @@ void main() {
      expect(response.ocs.data[0].message, '456');
      expect(response.ocs.data[0].link, '');
      expect(response.ocs.data[0].subjectRich, '');
-      expect(response.ocs.data[0].subjectRichParameters?.asList, isEmpty);
+      expect(response.ocs.data[0].subjectRichParameters, isEmpty);
      expect(response.ocs.data[0].messageRich, '');
-      expect(response.ocs.data[0].messageRichParameters?.asList, isEmpty);
+      expect(response.ocs.data[0].messageRichParameters, isEmpty);
      expect(response.ocs.data[0].icon, isNotEmpty);
      expect(response.ocs.data[0].actions, hasLength(0));
    });
@ -60,7 +60,7 @@ void main() {
      await sendTestNotification();

      final startTime = DateTime.now().toUtc();
-      final response = await client.notifications.getNotification(id: 2);
+      final response = await client.notifications.endpoint.getNotification(id: 2);
      expect(response.ocs.data.notificationId, 2);
      expect(response.ocs.data.app, 'admin_notifications');
      expect(response.ocs.data.user, 'admin');
@ -71,27 +71,27 @@ void main() {
      expect(response.ocs.data.message, '456');
      expect(response.ocs.data.link, '');
      expect(response.ocs.data.subjectRich, '');
-      expect(response.ocs.data.subjectRichParameters?.asList, isEmpty);
+      expect(response.ocs.data.subjectRichParameters, isEmpty);
      expect(response.ocs.data.messageRich, '');
-      expect(response.ocs.data.messageRichParameters?.asList, isEmpty);
+      expect(response.ocs.data.messageRichParameters, isEmpty);
      expect(response.ocs.data.icon, isNotEmpty);
      expect(response.ocs.data.actions, hasLength(0));
    });

    test('Delete notification', () async {
      await sendTestNotification();
-      await client.notifications.deleteNotification(id: 2);
+      await client.notifications.endpoint.deleteNotification(id: 2);

-      final response = await client.notifications.listNotifications();
+      final response = (await client.notifications.endpoint.listNotifications()).data;
      expect(response.ocs.data, hasLength(1));
    });

    test('Delete all notifications', () async {
      await sendTestNotification();
      await sendTestNotification();
-      await client.notifications.deleteAllNotifications();
+      await client.notifications.endpoint.deleteAllNotifications();

-      final response = await client.notifications.listNotifications();
+      final response = (await client.notifications.endpoint.listNotifications()).data;
      expect(response.ocs.data, hasLength(0));
    });
  });
@ -121,7 +121,7 @@ void main() {
        const pushToken = '789';
        final keypair = generateKeypair();

-        final subscription = (await client.notifications.registerDevice(
+        final subscription = (await client.notifications.push.registerDevice(
          pushTokenHash: generatePushTokenHash(pushToken),
          devicePublicKey: keypair.publicKey.toFormattedPEM(),
          proxyServer: 'https://example.com/',
@ -132,9 +132,8 @@ void main() {
        RSAPublicKey.fromPEM(subscription.publicKey);
        expect(subscription.deviceIdentifier, isNotEmpty);
        expect(subscription.signature, isNotEmpty);
-        expect(subscription.message, isNull);

-        await client.notifications.removeDevice();
+        await client.notifications.push.removeDevice();
      });
    },
    retry: retryCount,
--- a/tool/generate-specs.sh
+++ b/tool/generate-specs.sh
@ -5,12 +5,20 @@ cd "$(dirname "$0")/.."
 rm -rf /tmp/nextcloud-neon
 mkdir -p /tmp/nextcloud-neon

-(
-  cd external/nextcloud-server
-  composer update
-  composer install --no-dev
-  git checkout . # Remove changed files
-)
+function generate_spec() {
+    path="$1"
+    codename="$2"
+    composer exec generate-spec -- "$path" "../../packages/nextcloud/lib/src/api/$codename.openapi.json" --first-content-type --openapi-version 3.1.0
+}
+
+for dir in external/nextcloud-server external/nextcloud-notifications; do
+  (
+    cd "$dir"
+    composer update
+    composer install --no-dev
+    git checkout . # Remove changed files
+  )
+done

 for path in \
  core \
@ -31,13 +39,17 @@ for path in \
  apps/user_status \
  apps/weather_status \
 ; do
-  codename="$(echo $path | sed "s/^apps\///")"
  (
    cd external/nextcloud-server
-    composer exec generate-spec -- "$path" "../../packages/nextcloud/lib/src/api/$codename.openapi.json" --first-content-type --openapi-version 3.1.0
+    generate_spec "$path" "$(basename $path)"
  )
 done

+(
+  cd external/nextcloud-notifications
+  generate_spec "." "notifications"
+)
+
 (
  cd external/nextcloud-server
  composer exec merge-specs -- --core ../../packages/nextcloud/lib/src/api/core.openapi.json --merged /tmp/nextcloud-neon/merged.json ../../packages/nextcloud/lib/src/api/*.openapi.json --openapi-version 3.1.0