feat: add new method to fetch enrollment requests

packages/at_client/lib/src/client/at_client_impl.dart

@@ -651,29 +651,30 @@ class AtClientImpl implements AtClient, AtSignChangeListener {
 
   @override
   Future<List<EnrollmentRequest>> fetchEnrollmentRequests(
-      {EnrollListRequestParam? enrollmentListRequest}) async {
+      EnrollListRequestParam enrollmentListRequestParams) async {
+    // enrollmentListRequestParams for now is not  used
+    // A server side enhancement request is created. https://github.com/atsign-foundation/at_server/issues/1748
+    // On implementation of this enhancement/feature, the enrollListRequestParam object can be made use of
     EnrollVerbBuilder enrollBuilder = EnrollVerbBuilder()
       ..operation = EnrollOperationEnum.list
-      ..appName = enrollmentListRequest?.appName
-      ..deviceName = enrollmentListRequest?.deviceName;
+      ..appName = enrollmentListRequestParams.appName
+      ..deviceName = enrollmentListRequestParams.deviceName;
 
     var response = await getRemoteSecondary()
         ?.executeCommand(enrollBuilder.buildCommand(), auth: true);
-    response = response?.replaceFirst('data:', '');
-    Map<String, dynamic> enrollRequests = jsonDecode(response!);
-    stdout.writeln('enrollment lis req response: $response');
-    return _formatEnrollListResponse(enrollRequests);
+
+    return _formatEnrollListResponse(response);
   }
 
   List<EnrollmentRequest> _formatEnrollListResponse(
-      Map<String, dynamic> enrollRequests) {
+      response) {
+    response = response?.replaceFirst('data:', '');
+    Map<String, dynamic> enrollRequests = jsonDecode(response!);
     List<EnrollmentRequest> enrollRequestsFormatted = [];
+
     for (var request in enrollRequests.entries) {
-      enrollRequestsFormatted.add(EnrollmentRequest()
-        ..enrollmentKey = request.key
-        ..appName = request.value['appName']
-        ..deviceName = request.value['deviceName']
-        ..namespace = request.value['namespace']);
+      enrollRequestsFormatted.add(EnrollmentRequest.fromJson(request.value,
+          jsonIncludesKey: false, enrollmentKey: request.key));
     }
     return enrollRequestsFormatted;
   }

packages/at_client/lib/src/client/at_client_spec.dart

@@ -577,8 +577,13 @@ abstract class AtClient {
   /// Fetches all enrollment requests from the corresponding atServer; Formats the requests into a
   /// List<[EnrollmentResponse]>
   ///
-  /// The optional param [EnrollListRequestParam] is present to avoid future compatibility issues over backwards compatibility
-  /// [enrollListRequest] for now does not have any functionality
-  Future<List<EnrollmentRequest>> fetchEnrollmentRequests(
-      {EnrollListRequestParam? enrollmentListRequest});
+  /// Responses can be filtered using params provided through [EnrollListRequestParam]
+  /// ```
+  /// e.g.
+  /// List<EnrollmentRequest> enrollmentRequests = fetchEnrollmentRequests(EnrollRequestParams());
+  /// enrollmentRequests now contains all the enrollment requests fetched from the server in the for of
+  /// EnrollmentRequest objects
+  /// ```
+  @experimental
+  Future<List<EnrollmentRequest>> fetchEnrollmentRequests(EnrollListRequestParam enrollmentListRequest);
 }

packages/at_client/lib/src/util/enrollment_request.dart

@@ -1,11 +1,50 @@
+import 'dart:collection';
+import 'dart:convert';
+
+import 'package:at_client/at_client.dart';
+
 class EnrollmentRequest {
   late String enrollmentKey;
   late String appName;
   late String deviceName;
   late Map<String, dynamic> namespace;
 
+  String get enrollmentId {
+    return extractEnrollmentId(enrollmentKey);
+  }
+
   @override
   String toString() {
     return 'Enrollment Request: enrollmentKey: $enrollmentKey | appName: $appName | deviceName: $deviceName | namespace: ${namespace.toString()}';
   }
+
+  String toJson() {
+    Map jsonMap = HashMap();
+    jsonMap['enrollmentKey'] = enrollmentKey;
+    jsonMap['appName'] = appName;
+    jsonMap['deviceName'] = deviceName;
+    jsonMap['namespace'] = jsonEncode(namespace);
+
+    return jsonEncode(jsonMap);
+  }
+
+  static EnrollmentRequest fromJson(Map<String, dynamic> json,
+      {bool jsonIncludesKey = true, String? enrollmentKey}) {
+    EnrollmentRequest enrollmentRequest = EnrollmentRequest();
+    if (jsonIncludesKey) {
+      enrollmentRequest.enrollmentKey = json['enrollmentKey'];
+    } else if (!jsonIncludesKey && enrollmentKey != null) {
+      enrollmentRequest.enrollmentKey = enrollmentKey;
+    } else {
+      throw IllegalArgumentException('enrollment key not set');
+    }
+    return enrollmentRequest
+      ..appName = json['appName']
+      ..deviceName = json['deviceName']
+      ..namespace = json['namespace'];
+  }
+
+  static String extractEnrollmentId(String enrollmentKey) {
+    return enrollmentKey.split('.')[0];
+  }
 }

packages/at_client/test/at_client_impl_test.dart

@@ -293,17 +293,28 @@ void main() {
       AtClientImpl? clientImpl = client as AtClientImpl;
 
       List<EnrollmentRequest> requests =
-          await clientImpl.fetchEnrollmentRequests();
+          await clientImpl.fetchEnrollmentRequests(EnrollListRequestParam());
       expect(requests.length, 3);
       expect(requests[0].appName, jsonDecode(enrollValue1)['appName']);
       expect(requests[0].deviceName, jsonDecode(enrollValue1)['deviceName']);
       expect(requests[0].namespace, jsonDecode(enrollValue1)['namespace']);
+
       expect(requests[1].appName, jsonDecode(enrollValue2)['appName']);
       expect(requests[1].deviceName, jsonDecode(enrollValue2)['deviceName']);
       expect(requests[1].namespace, jsonDecode(enrollValue2)['namespace']);
+
       expect(requests[2].appName, jsonDecode(enrollValue3)['appName']);
       expect(requests[2].deviceName, jsonDecode(enrollValue3)['deviceName']);
       expect(requests[2].namespace, jsonDecode(enrollValue3)['namespace']);
     });
+
+    test('validate EnrollRequest.extractEnrollmentId()', () {
+      String enrollmentKey =
+          '0acdeb4d-1a2e-43e4-93bd-378f1d366ea7.new.enrollments.__manage@random';
+      String enrollmentId = '0acdeb4d-1a2e-43e4-93bd-378f1d366ea7';
+
+      expect(
+          EnrollmentRequest.extractEnrollmentId(enrollmentKey), enrollmentId);
+    });
   });
 }

tests/at_functional_test/test/enrollment_test.dart

@@ -130,25 +130,23 @@ void main() {
 
     // fetch enrollment requests through client
     List<EnrollmentRequest> enrollmentRequests =
-        await client.fetchEnrollmentRequests();
-    for(var request in enrollmentRequests){
-      print(request);
-    }
-    expect(
-        enrollmentRequests.length, 4); // 4 entries - 2 entries from this test
+        await client.fetchEnrollmentRequests(EnrollListRequestParam());
+
+    expect(enrollmentRequests.length, 4);
+    // 4 entries - 2 entries from this test
     // + 2 entries from the other test in this file.
 
     String firstEnrollmentKey =
         getEnrollmentKey(enrollResponse1JsonDecoded['enrollmentId'], atSign);
     String secondEnrollmentKey =
         getEnrollmentKey(enrollResponse2JsonDecoded['enrollmentId'], atSign);
     int matchCount = 0;
-    for (var request in enrollmentRequests){
-      if(request.enrollmentKey == firstEnrollmentKey){
+    for (var request in enrollmentRequests) {
+      if (request.enrollmentKey == firstEnrollmentKey) {
         expect(request.namespace['new_app'], 'rw');
         expect(request.deviceName, 'pixel');
-        matchCount ++;
-      } else if (request.enrollmentKey == secondEnrollmentKey){
+        matchCount++;
+      } else if (request.enrollmentKey == secondEnrollmentKey) {
         expect(request.namespace['new_app'], 'rw');
         expect(request.namespace['wavi'], 'r');
         expect(request.deviceName, 'pixel7');