feat(graphql): add tracer to the core library to be able to trace the lib

Signed-off-by: Vincenzo Palazzo <[email protected]>

Author: vincenzopalazzo

packages/graphql/lib/src/core/query_manager.dart

@@ -1,6 +1,7 @@
 import 'dart:async';
 
 import 'package:graphql/src/utilities/response.dart';
+import 'package:graphql_common/graphql_common.dart';
 import 'package:meta/meta.dart';
 import 'package:collection/collection.dart';
 
@@ -26,6 +27,7 @@ class QueryManager {
   QueryManager({
     required this.link,
     required this.cache,
+    this.tracer,
     this.alwaysRebroadcast = false,
   }) {
     scheduler = QueryScheduler(
@@ -50,6 +52,10 @@ class QueryManager {
   /// prevents rebroadcasting for some intensive bulk operation like [refetchSafeQueries]
   bool rebroadcastLocked = false;
 
+  /// Custom Tracer specified by the user to trace the library
+  /// if the user need it.
+  final Tracer? tracer;
+
   ObservableQuery<TParsed> watchQuery<TParsed>(
       WatchQueryOptions<TParsed> options) {
     final ObservableQuery<TParsed> observableQuery = ObservableQuery<TParsed>(

packages/graphql/lib/src/graphql_client.dart

@@ -1,10 +1,9 @@
 import 'package:meta/meta.dart';
 import 'dart:async';
-
 import 'package:graphql/src/core/core.dart';
 import 'package:graphql/src/cache/cache.dart';
-
 import 'package:graphql/src/core/fetch_more.dart';
+import 'package:graphql_common/graphql_common.dart';
 
 /// Universal GraphQL Client with configurable caching and [link][] system.
 /// modelled after the [`apollo-client`][ac].
@@ -24,12 +23,14 @@ class GraphQLClient implements GraphQLDataProxy {
   GraphQLClient({
     required this.link,
     required this.cache,
+    this.tracer,
     DefaultPolicies? defaultPolicies,
     bool alwaysRebroadcast = false,
   })  : defaultPolicies = defaultPolicies ?? DefaultPolicies(),
         queryManager = QueryManager(
           link: link,
           cache: cache,
+          tracer: tracer,
           alwaysRebroadcast: alwaysRebroadcast,
         );
 
@@ -44,11 +45,16 @@ class GraphQLClient implements GraphQLDataProxy {
 
   late final QueryManager queryManager;
 
+  /// Custom Tracer specified by the user to trace the library
+  /// if the user need it.
+  final Tracer? tracer;
+
   /// Create a copy of the client with the provided information.
   GraphQLClient copyWith(
       {Link? link,
       GraphQLCache? cache,
       DefaultPolicies? defaultPolicies,
+      Tracer? tracer,
       bool? alwaysRebroadcast}) {
     return GraphQLClient(
         link: link ?? this.link,

packages/graphql/lib/src/links/websocket_link/websocket_client.dart

@@ -7,6 +7,7 @@ import 'package:gql_exec/gql_exec.dart';
 import 'package:graphql/src/core/query_options.dart' show WithType;
 import 'package:graphql/src/links/gql_links.dart';
 import 'package:graphql/src/utilities/platform.dart';
+import 'package:graphql_common/graphql_common.dart';
 import 'package:meta/meta.dart';
 import 'package:rxdart/rxdart.dart';
 import 'package:stream_channel/stream_channel.dart';
@@ -48,8 +49,13 @@ class SocketClientConfig {
     this.initialPayload,
     this.headers,
     this.connectFn,
+    this.tracer,
   });
 
+  /// Custom Tracer specified by the user to trace the library
+  /// if the user need it.
+  final Tracer? tracer;
+
   /// Serializer used to serialize request
   final RequestSerializer serializer;
 

packages/graphql/lib/src/links/websocket_link/websocket_link.dart

@@ -1,5 +1,6 @@
 import 'package:gql_exec/gql_exec.dart';
 import 'package:gql_link/gql_link.dart';
+import 'package:graphql_common/graphql_common.dart';
 
 import './websocket_client.dart';
 
@@ -17,6 +18,7 @@ class WebSocketLink extends Link {
     this.url, {
     this.config = const SocketClientConfig(),
     this.subProtocol = GraphQLProtocol.graphqlWs,
+    this.tracer,
   });
 
   final String url;
@@ -26,6 +28,10 @@ class WebSocketLink extends Link {
   // cannot be final because we're changing the instance upon a header change.
   SocketClient? _socketClient;
 
+  /// Custom Tracer specified by the user to trace the library
+  /// if the user need it.
+  final Tracer? tracer;
+
   @override
   Stream<Response> request(Request request, [forward]) async* {
     if (_socketClient == null) {

packages/graphql/pubspec.yaml

@@ -21,6 +21,8 @@ dependencies:
   stream_channel: ^2.1.0
   rxdart: ^0.27.1
   uuid: ^3.0.1
+  graphql_common:
+    path: ../graphql_common
 
 dev_dependencies:
   async: ^2.5.0

packages/graphql_flutter/example/lib/generated_plugin_registrant.dart

@@ -4,6 +4,7 @@
 
 // ignore_for_file: directives_ordering
 // ignore_for_file: lines_longer_than_80_chars
+// ignore_for_file: depend_on_referenced_packages
 
 import 'package:connectivity_plus_web/connectivity_plus_web.dart';