gql_websocket_link 0.1.1-alpha+1590789520972

  • Readme
  • Changelog
  • Example
  • Installing
  • 88

MIT License PRs Welcome Watch on GitHub Star on GitHub Watch on GitHub Discord

GQL WebSocket link to execute subscriptions as well as mutations & queries against a GraphQL backend

Usage #

A simple usage example:

import "package:gql_link/gql_link.dart";
import "package:gql_websocket_link/gql_websocket_link.dart";

void main () {
  final link = Link.from([
    // SomeLink(),
    WSLink("ws://<GRAPHQL_SERVER_ENDPOINT>/graphql"),
  ]);
}

Make sure you have WebSocket transport supported on your GraphQL server.

Features and bugs #

Please file feature requests and bugs at the GitHub.

Attribution #

This code was adapted with minor changed from the graphql-flutter repo

0.1.1-alpha+1590789520972 #

0.1.0 #

  • port Websocket link from graphq-flutter
  • use WebSocketChannel as a base for the connection

example/gql_websocket_link_example.dart

import "package:gql_link/gql_link.dart";
import "package:gql_websocket_link/gql_websocket_link.dart";

void main() {
  // ignore: unused_local_variable
  final link = Link.from([
    // SomeLink(),
    WebSocketLink("ws://localhost:5000/graphql"),
  ]);
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  gql_websocket_link: ^0.1.1-alpha+1590789520972

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:gql_websocket_link/gql_websocket_link.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
95
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
55
Overall:
Weighted score of the above. [more]
88
Learn more about scoring.

We analyzed this package on Jul 7, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.13

Maintenance issues and suggestions

Make sure dartdoc successfully runs on your package's source files. (-10 points)

Running dartdoc failed with the following output: NoSuchMethodError: The getter 'attributes' was called on null. Receiver: null Tried calling: attributes

#0      Object.noSuchMethod (dart:core-patch/object_patch.dart:53:5)
#1      DartdocCustomizer._addPubPackageLink (package:pub_dev/dartdoc/customization.dart:168:17)
#2      DartdocCustomizer.customizeHtml (package:pub_dev/dartdoc/customization.dart:61:7)
#3      DartdocCustomizer.customizeFile (package:pub_dev/dartdoc/customization.dart:35:31)
<asynchronous suspension>
#4      DartdocCustomizer.customizeDir (package:pub_dev/dartdoc/customization.dart:26:25)
<asynchronous suspension>
#5      DartdocJobProcessor.process (package:pub_dev/dartdoc/dartdoc_runner.dart:211:14)
<asynchronous suspension>
#6      JobProcessor.run (package:pub_dev/job/job.dart:65:28)
<asynchronous suspension>
#7      JobMaintenance.run (package:pub_dev/job/job.dart:106:18)
#8      _workerMain.<anonymous closure> (package:pub_dev/service/entrypoint/dartdoc.dart:108:26)
#9      StackZoneSpecification._registerUnaryCallback.<anonymous closure>.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:26)
#10     StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#11     StackZoneSpecification._registerUnaryCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:14)
#12     _rootRunUnary (dart:async/zone.dart:1192:38)
#13     _CustomZone.runUnary (dart:async/zone.dart:1085:19)
#14     _FutureListener.handleValue (dart:async/future_impl.dart:141:18)
#15     Future._propagateToListeners.handleValueCallback (dart:async/future_impl.dart:682:45)
#16     Future._propagateToListeners (dart:async/future_impl.dart:711:32)
#17     Future._completeWithValue (dart:async/future_impl.dart:526:5)
#18     _AsyncAwaitCompleter.complete (dart:async-patch/async_patch.dart:36:15)
#19     _completeOnAsyncReturn (dart:async-patch/async_patch.dart:298:13)
#20     DartdocJobProcessor.generateDocsForSdk (package:pub_dev/dartdoc/dartdoc_runner.dart)
#21     StackZoneSpecification._registerUnaryCallback.<anonymous closure>.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:26)
#22     StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#23     StackZoneSpecification._registerUnaryCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:14)
#24     _rootRunUnary (dart:async/zone.dart:1192:38)
#25     _CustomZone.runUnary (dart:async/zone.dart:1085:19)
#26     _FutureListener.handleValue (dart:async/future_impl.dart:141:18)
#27     Future._propagateToListeners.handleValueCallback (dart:async/future_impl.dart:682:45)
#28     Future._propagateToListeners (dart:async/future_impl.dart:711:32)
#29     Future._completeWithValue (dart:async/future_impl.dart:526:5)
#30     _AsyncAwaitCompleter.complete (dart:async-patch/async_patch.dart:36:15)
#31     _completeOnAsyncReturn (dart:async-patch/async_patch.dart:298:13)
#32     VersionedJsonStorage.hasCurrentData (package:pub_dev/shared/storage.dart)
#33     StackZoneSpecification._registerUnaryCallback.<anonymous closure>.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:26)
#34     StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#35     StackZoneSpecification._registerUnaryCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:14)
#36     _rootRunUnary (dart:async/zone.dart:1192:38)
#37     _CustomZone.runUnary (dart:async/zone.dart:1085:19)
#38     _FutureListener.handleValue (dart:async/future_impl.dart:141:18)
#39     Future._propagateToListeners.handleValueCallback (dart:async/future_impl.dart:682:45)
#40     Future._propagateToListeners (dart:async/future_impl.dart:711:32)
#41     Future._completeWithValue (dart:async/future_impl.dart:526:5)
#42     _AsyncAwaitCompleter.complete (dart:async-patch/async_patch.dart:36:15)
#43     _completeOnAsyncReturn (dart:async-patch/async_patch.dart:298:13)
#44     ApiRequester.request (package:_discoveryapis_commons/src/clients.dart)
#45     StackZoneSpecification._registerUnaryCallback.<anonymous closure>.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:26)
#46     StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#47     StackZoneSpecification._registerUnaryCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:14)
#48     _rootRunUnary (dart:async/zone.dart:1192:38)
#49     _CustomZone.runUnary (dart:async/zone.dart:1085:19)
#50     _FutureListener.handleValue (dart:async/future_impl.dart:141:18)
#51     Future._propagateToListeners.handleValueCallback (dart:async/future_impl.dart:682:45)
#52     Future._propagateToListeners (dart:async/future_impl.dart:711:32)
#53     Future._complete (dart:async/future_impl.dart:516:7)
#54     Stream.join.<anonymous closure> (dart:async/stream.dart:847:18)
#55     StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#56     StackZoneSpecification._registerCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:119:48)
#57     _rootRun (dart:async/zone.dart:1180:38)
#58     _CustomZone.run (dart:async/zone.dart:1077:19)
#59     _CustomZone.runGuarded (dart:async/zone.dart:979:7)
#60     _BufferingStreamSubscription._sendDone.sendDone (dart:async/stream_impl.dart:392:13)
#61     _BufferingStreamSubscription._sendDone (dart:async/stream_impl.dart:402:15)
#62     _BufferingStreamSubscription._close (dart:async/stream_impl.dart:286:7)
#63     _SinkTransformerStreamSubscription._close (dart:async/stream_transformers.dart:98:11)
#64     _EventSinkWrapper.close (dart:async/stream_transformers.dart:25:11)
#65     _StringAdapterSink.close (dart:convert/string_conversion.dart:251:11)
#66     _Utf8ConversionSink.close (dart:convert/string_conversion.dart:302:20)
#67     _ConverterStreamEventSink.close (dart:convert/chunked_conversion.dart:83:18)
#68     _SinkTransformerStreamSubscription._handleDone (dart:async/stream_transformers.dart:143:24)
#69     StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#70     StackZoneSpecification._registerCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:119:48)
#71     _rootRun (dart:async/zone.dart:1180:38)
#72     _CustomZone.run (dart:async/zone.dart:1077:19)
#73     _CustomZone.runGuarded (dart:async/zone.dart:979:7)
#74     _BufferingStreamSubscription._sendDone.sendDone (dart:async/stream_impl.dart:392:13)
#75     _BufferingStreamSubscription._sendDone (dart:async/stream_impl.dart:402:15)
#76     _BufferingStreamSubscription._close (dart:async/stream_impl.dart:286:7)
#77     _ForwardingStream._handleDone (dart:async/stream_pipe.dart:108:10)
#78     _ForwardingStreamSubscription._handleDone (dart:async/stream_pipe.dart:174:13)
#79     StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#80     StackZoneSpecification._registerCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:119:48)
#81     _rootRun (dart:async/zone.dart:1180:38)
#82     _CustomZone.run (dart:async/zone.dart:1077:19)
#83     _CustomZone.runGuarded (dart:async/zone.dart:979:7)
#84     _BufferingStreamSubscription._sendDone.sendDone (dart:async/stream_impl.dart:392:13)
#85     _BufferingStreamSubscription._sendDone (dart:async/stream_impl.dart:402:15)
#86     _BufferingStreamSubscription._close (dart:async/stream_impl.dart:286:7)
#87     _ForwardingStream._handleDone (dart:async/stream_pipe.dart:108:10)
#88     _ForwardingStreamSubscription._handleDone (dart:async/stream_pipe.dart:174:13)
#89     StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#90     StackZoneSpecification._registerCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:119:48)
#91     _rootRun (dart:async/zone.dart:1180:38)
#92     _CustomZone.run (dart:async/zone.dart:1077:19)
#93     _CustomZone.runGuarded (dart:async/zone.dart:979:7)
#94     _BufferingStreamSubscription._sendDone.sendDone (dart:async/stream_impl.dart:392:13)
#95     _BufferingStreamSubscription._sendDone (dart:async/stream_impl.dart:402:15)
#96     _BufferingStreamSubscription._close (dart:async/stream_impl.dart:286:7)
#97     _SyncStreamControllerDispatch._sendDone (dart:async/stream_controller.dart:787:19)
#98     _StreamController._closeUnchecked (dart:async/stream_controller.dart:644:7)
#99     _StreamController.close (dart:async/stream_controller.dart:637:5)
#100    _HttpParser._closeIncoming (dart:_http/http_parser.dart:1121:23)
#101    _HttpParser._doParse (dart:_http/http_parser.dart:815:15)
#102    _HttpParser._parse (dart:_http/http_parser.dart:328:7)
#103    _HttpParser._onData (dart:_http/http_parser.dart:850:5)
#104    StackZoneSpecification._registerUnaryCallback.<anonymous closure>.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:26)
#105    StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#106    StackZoneSpecification._registerUnaryCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:14)
#107    _rootRunUnary (dart:async/zone.dart:1192:38)
#108    _CustomZone.runUnary (dart:async/zone.dart:1085:19)
#109    _CustomZone.runUnaryGuarded (dart:async/zone.dart:987:7)
#110    _BufferingStreamSubscription._sendData (dart:async/stream_impl.dart:339:11)
#111    _BufferingStreamSubscription._add (dart:async/stream_impl.dart:266:7)
#112    _SyncStreamControllerDispatch._sendData (dart:async/stream_controller.dart:779:19)
#113    _StreamController._add (dart:async/stream_controller.dart:655:7)
#114    _StreamController.add (dart:async/stream_controller.dart:597:5)
#115    _Socket._onData (dart:io-patch/socket_patch.dart:1982:41)
#116    StackZoneSpecification._registerUnaryCallback.<anonymous closure>.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:26)
#117    StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#118    StackZoneSpecification._registerUnaryCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:129:14)
#119    _rootRunUnary (dart:async/zone.dart:1192:38)
#120    _CustomZone.runUnary (dart:async/zone.dart:1085:19)
#121    _CustomZone.runUnaryGuarded (dart:async/zone.dart:987:7)
#122    _BufferingStreamSubscription._sendData (dart:async/stream_impl.dart:339:11)
#123    _BufferingStreamSubscription._add (dart:async/stream_impl.dart:266:7)
#124    _SyncStreamControllerDispatch._sendData (dart:async/stream_controller.dart:779:19)
#125    _StreamController._add (dart:async/stream_controller.dart:655:7)
#126    _StreamController.add (dart:async/stream_controller.dart:597:5)
#127    _RawSecureSocket._sendReadEvent (dart:io/secure_socket.dart:1018:19)
#128    StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#129    StackZoneSpecification._registerCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:119:48)
#130    _rootRun (dart:async/zone.dart:1180:38)
#131    _CustomZone.run (dart:async/zone.dart:1077:19)
#132    _CustomZone.runGuarded (dart:async/zone.dart:979:7)
#133    _CustomZone.bindCallbackGuarded.<anonymous closure> (dart:async/zone.dart:1019:23)
#134    StackZoneSpecification._run (package:stack_trace/src/stack_zone_specification.dart:209:15)
#135    StackZoneSpecification._registerCallback.<anonymous closure> (package:stack_trace/src/stack_zone_specification.dart:119:48)
#136    _rootRun (dart:async/zone.dart:1184:13)
#137    _CustomZone.run (dart:async/zone.dart:1077:19)
#138    _CustomZone.bindCallback.<anonymous closure> (dart:async/zone.dart:1003:23)
#139    Timer._createTimer.<anonymous closure> (dart:async-patch/timer_patch.dart:23:15)
#140    _Timer._runTimers (dart:isolate-patch/timer_impl.dart:398:19)
#141    _Timer._handleMessage (dart:isolate-patch/timer_impl.dart:429:5)
#142    _RawReceivePortImpl._handleMessage (dart:isolate-patch/isolate_patch.dart:168:12)

Homepage URL isn't helpful. (-10 points)

Update the homepage field from pubspec.yaml: link to a website about the package or use the source repository URL.

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Package is pre-release. (-5 points)

Pre-release versions should be used with caution; their API can change in breaking ways.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.7.2 <3.0.0
gql ^0.12.4-alpha+1590789520945 0.12.4-alpha+1590789520945
gql_exec ^0.2.5-alpha+1590789520957 0.2.5-alpha+1590789520957
gql_link ^0.3.1-alpha+1590789520964 0.3.1-alpha+1590789520964
meta ^1.1.8 1.2.1
rxdart ^0.24.0 0.24.1
uuid_enhanced ^3.0.2 3.0.2
web_socket_channel ^1.1.0 1.1.0
Transitive dependencies
async 2.4.2
charcode 1.1.3
collection 1.14.13
convert 2.1.1
crypto 2.1.5
path 1.7.0
source_span 1.7.0
stream_channel 2.0.0
term_glyph 1.1.0
typed_data 1.2.0
Dev dependencies
gql_pedantic ^1.0.3-alpha+1590789520916
mockito ^4.1.1
test ^1.14.3