feat(client): library-level exceptions

zino-hofmann · Sep 29, 2019 · 8976cfc · 8976cfc
1 parent 4ac8a5b
commit 8976cfc
Show file tree

Hide file tree

Showing 12 changed files with 159 additions and 33 deletions.
diff --git a/packages/graphql/example/bin/main.dart b/packages/graphql/example/bin/main.dart
@@ -49,7 +49,7 @@ void query() async {
   final QueryResult result = await _client.query(options);
 
   if (result.hasErrors) {
-    stderr.writeln(result.errors);
+    stderr.writeln(result.graphqlErrors);
     exit(2);
   }
 
@@ -81,7 +81,7 @@ void starRepository(String repositoryID) async {
   final QueryResult result = await _client.mutate(options);
 
   if (result.hasErrors) {
-    stderr.writeln(result.errors);
+    stderr.writeln(result.graphqlErrors);
     exit(2);
   }
 
@@ -114,7 +114,7 @@ void removeStarFromRepository(String repositoryID) async {
   final QueryResult result = await _client.mutate(options);
 
   if (result.hasErrors) {
-    stderr.writeln(result.errors);
+    stderr.writeln(result.graphqlErrors);
     exit(2);
   }
 

diff --git a/packages/graphql/lib/client.dart b/packages/graphql/lib/client.dart
@@ -6,11 +6,12 @@ export 'package:graphql/src/cache/normalized_in_memory.dart';
 export 'package:graphql/src/cache/optimistic.dart';
 export 'package:graphql/src/cache/lazy_cache_map.dart';
 
-export 'package:graphql/src/core/graphql_error.dart';
 export 'package:graphql/src/core/query_manager.dart';
 export 'package:graphql/src/core/query_options.dart';
 export 'package:graphql/src/core/query_result.dart';
 
+export 'package:graphql/src/exceptions/exceptions.dart';
+
 export 'package:graphql/src/link/auth/link_auth.dart';
 export 'package:graphql/src/link/http/link_http.dart';
 export 'package:graphql/src/link/link.dart';

diff --git a/packages/graphql/lib/src/cache/normalized_in_memory.dart b/packages/graphql/lib/src/cache/normalized_in_memory.dart
@@ -62,7 +62,8 @@ class NormalizedInMemoryCache extends InMemoryCache {
     return null;
   }
 
-  // TODO ideally cyclical references would be noticed and replaced with null or something
+  // ~TODO~ ideally cyclical references would be noticed and replaced with null or something
+  // @micimize: pretty sure I implemented the above
   /// eagerly dereferences all cache references.
   /// *WARNING* if your system allows cyclical references, this will break
   dynamic denormalizedRead(String key) {

diff --git a/packages/graphql/lib/src/core/observable_query.dart b/packages/graphql/lib/src/core/observable_query.dart
@@ -1,5 +1,6 @@
 import 'dart:async';
 
+import 'package:graphql/src/exceptions/exceptions.dart';
 import 'package:meta/meta.dart';
 
 import 'package:graphql/src/core/query_manager.dart';
@@ -175,21 +176,22 @@ class ObservableQuery {
         writeToCache: true,
       );
     } catch (error) {
-      if (fetchMoreResult.hasErrors) {
+      if (fetchMoreResult.hasGraphqlErrors) {
         // because the updateQuery failure might have been because of these errors,
         // we just add them to the old errors
-        latestResult.errors = [
-          ...(latestResult.errors ?? const []),
-          ...fetchMoreResult.errors
-        ];
+        latestResult.exception = coalesceErrors(
+          exception: latestResult.exception,
+          graphqlErrors: fetchMoreResult.graphqlErrors,
+        );
+
         queryManager.addQueryResult(
           queryId,
           latestResult,
           writeToCache: true,
         );
-
         return;
       } else {
+        // TODO merge results OperationException
         rethrow;
       }
     }
@@ -215,6 +217,11 @@ class ObservableQuery {
 
     latestResult = result;
 
+    print('${options.operationName} addResult');
+    if (options.operationName.contains('UserEventRecords')) {
+      print(latestResult.data['eventRecordsThrough']['eventRecords'].length);
+    }
+
     if (!controller.isClosed) {
       controller.add(result);
     }

diff --git a/packages/graphql/lib/src/core/query_manager.dart b/packages/graphql/lib/src/core/query_manager.dart
@@ -1,10 +1,11 @@
 import 'dart:async';
 
+import 'package:graphql/src/exceptions/base_exceptions.dart';
+import 'package:graphql/src/exceptions/exceptions.dart';
 import 'package:meta/meta.dart';
 
 import 'package:graphql/src/core/query_options.dart';
 import 'package:graphql/src/core/query_result.dart';
-import 'package:graphql/src/core/graphql_error.dart';
 import 'package:graphql/src/core/observable_query.dart';
 
 import 'package:graphql/src/scheduler/scheduler.dart';
@@ -189,12 +190,12 @@ class QueryManager {
             queryResult.loading) {
           queryResult = QueryResult(
             source: QueryResultSource.Cache,
-            errors: [
-              GraphQLError(
-                message:
-                    'Could not find that operation in the cache. (FetchPolicy.cacheOnly)',
+            exception: OperationException(
+              clientException: CacheMissException(
+                'Could not find that operation in the cache. (FetchPolicy.cacheOnly)',
+                cacheKey,
               ),
-            ],
+            ),
           );
         }
       }
@@ -363,8 +364,8 @@ class QueryManager {
 
     return QueryResult(
       data: data,
-      errors: errors,
       source: source,
+      exception: coalesceErrors(graphqlErrors: errors),
     );
   }
 

diff --git a/packages/graphql/lib/src/core/query_result.dart b/packages/graphql/lib/src/core/query_result.dart
@@ -1,6 +1,6 @@
 import 'dart:async' show FutureOr;
 
-import 'package:graphql/src/core/graphql_error.dart';
+import 'package:graphql/src/exceptions/exceptions.dart';
 
 /// The source of the result data contained
 ///
@@ -26,7 +26,7 @@ final eagerSources = {
 class QueryResult {
   QueryResult({
     this.data,
-    this.errors,
+    this.exception,
     bool loading,
     bool optimistic,
     QueryResultSource source,
@@ -48,7 +48,8 @@ class QueryResult {
 
   /// List<dynamic> or Map<String, dynamic>
   dynamic data;
-  List<GraphQLError> errors;
+
+  OperationException exception;
 
   /// Whether data has been specified from either the cache or network)
   bool get loading => source == QueryResultSource.Loading;
@@ -58,20 +59,17 @@ class QueryResult {
   bool get optimistic => source == QueryResultSource.OptimisticResult;
 
   /// Whether the response includes any graphql errors
-  bool get hasErrors {
-    if (errors == null) {
-      return false;
-    }
+  bool get hasErrors => !(exception == null);
 
-    return errors.isNotEmpty;
-  }
+  /// Whether the response includes any graphql errors
+  bool get hasGraphqlErrors => exception?.graphqlErrors?.isNotEmpty ?? false;
+
+  /// graphql errors in the exception, if any
+  List<GraphQLError> get graphqlErrors => exception?.graphqlErrors;
 
   void addError(GraphQLError graphQLError) {
-    if (errors != null) {
-      errors.add(graphQLError);
-    } else {
-      errors = <GraphQLError>[graphQLError];
-    }
+    exception ??= OperationException();
+    exception.addError(graphQLError);
   }
 }
 

diff --git a/packages/graphql/lib/src/exceptions/base_exceptions.dart b/packages/graphql/lib/src/exceptions/base_exceptions.dart
@@ -0,0 +1,24 @@
+abstract class ClientException implements Exception {}
+
+abstract class ClientCacheException implements ClientException {}
+
+/// A failure during the cache's entity normalization processes
+class NormalizationException implements ClientCacheException {
+  NormalizationException(this.cause, this.overflowError, this.value);
+
+  StackOverflowError overflowError;
+  String cause;
+  Object value;
+
+  String get message => cause;
+}
+
+/// A failure to find a key in the cache when cacheOnly=true
+class CacheMissException implements ClientCacheException {
+  CacheMissException(this.cause, this.missingKey);
+
+  String cause;
+  String missingKey;
+
+  String get message => cause;
+}
diff --git a/packages/graphql/lib/src/exceptions/exceptions.dart b/packages/graphql/lib/src/exceptions/exceptions.dart
@@ -0,0 +1,4 @@
+export './graphql_error.dart';
+export './operation_exception.dart';
+export './network_exception_stub.dart'
+    if (dart.library.io) './io_network_exceptions.dart';
diff --git a/...s/graphql/lib/src/core/graphql_error.dart → ...hql/lib/src/exceptions/graphql_error.dart b/...s/graphql/lib/src/core/graphql_error.dart → ...hql/lib/src/exceptions/graphql_error.dart
@@ -27,7 +27,9 @@ class GraphQLError {
 
   /// Constructs a [GraphQLError] from a JSON map.
   GraphQLError.fromJSON(this.raw)
-      : message = raw['message'] is String ? raw['message'] as String : 'Invalid server response: message property needs to be of type String',
+      : message = raw['message'] is String
+            ? raw['message'] as String
+            : 'Invalid server response: message property needs to be of type String',
         locations = raw['locations'] is List<Map<String, int>>
             ? List<Location>.from(
                 (raw['locations'] as List<Map<String, int>>).map<Location>(

diff --git a/packages/graphql/lib/src/exceptions/io_network_exception.dart b/packages/graphql/lib/src/exceptions/io_network_exception.dart
@@ -0,0 +1,20 @@
+import 'dart:io' show SocketException;
+import './network_exception_stub.dart' as stub;
+
+class NetworkException extends stub.NetworkException {
+  SocketException wrappedException;
+
+  NetworkException.from(this.wrappedException);
+
+  String get message => wrappedException.message;
+  String get targetAddress => wrappedException.address.address;
+  int get targetPort => wrappedException.port;
+}
+
+void translateExceptions(stub.VoidCallback block) {
+  try {
+    block();
+  } on SocketException catch (e) {
+    throw NetworkException.from(e);
+  }
+}
diff --git a/packages/graphql/lib/src/exceptions/network_exception_stub.dart b/packages/graphql/lib/src/exceptions/network_exception_stub.dart
@@ -0,0 +1,24 @@
+import './base_exceptions.dart' show ClientException;
+
+typedef VoidCallback = void Function();
+
+class NetworkException implements ClientException {
+  covariant Exception wrappedException;
+
+  final String message;
+
+  final String targetAddress;
+  final int targetPort;
+
+  NetworkException({
+    this.wrappedException,
+    this.message,
+    this.targetAddress,
+    this.targetPort,
+  });
+
+  String toString() =>
+      'Failed to connect to $targetAddress:$targetPort: $message';
+}
+
+void translateExceptions(VoidCallback block) => block();
diff --git a/packages/graphql/lib/src/exceptions/operation_exception.dart b/packages/graphql/lib/src/exceptions/operation_exception.dart
@@ -0,0 +1,44 @@
+import 'package:graphql/src/exceptions/base_exceptions.dart';
+
+import './graphql_error.dart';
+import './network_exception_stub.dart'
+    if (dart.library.io) './io_network_exceptions.dart';
+
+class OperationException implements Exception {
+  List<GraphQLError> graphqlErrors = [];
+
+  // generalize to include cache error, etc
+  ClientException clientException;
+
+  OperationException({
+    this.clientException,
+    Iterable<GraphQLError> graphqlErrors = const [],
+  }) : this.graphqlErrors = graphqlErrors.toList();
+
+  void addError(GraphQLError error) => graphqlErrors.add(error);
+}
+
+/// `(graphqlErrors?, exception?) => exception?`
+///
+/// merges both optional graphqlErrors and an optional container
+/// into a single optional container
+/// NOTE: NULL returns expected
+OperationException coalesceErrors({
+  List<GraphQLError> graphqlErrors,
+  ClientException clientException,
+  OperationException exception,
+}) {
+  if (exception != null ||
+      clientException != null ||
+      graphqlErrors == null ||
+      graphqlErrors.isEmpty) {
+    return OperationException(
+      clientException: clientException ?? exception.clientException,
+      graphqlErrors: [
+        if (graphqlErrors != null) ...graphqlErrors,
+        if (exception?.graphqlErrors != null) ...exception.graphqlErrors
+      ],
+    );
+  }
+  return null;
+}