datadog_gql_link ArgumentError

[tyandl]

Describe the bug

On receiving an response from graphql which contains an error the following error is emmited in logs and the entire Rum Resource Event is dropped.

ArgumentError when calling rum.stopResource: parameter null. It looks like _dd.graphql.errors is of type MappedListIterable<GraphQLError, Map<String, Object?>>, which is not supported.

I believe the error to be from: https://github.com/DataDog/dd-sdk-flutter/blob/develop/packages/datadog_gql_link/lib/src/datadog_gql_link.dart#L112

where a toList() may be a simple fix.

Reproduction steps

call graphql and get a 200 response that contains an error blob and a data blob.

Response Object appears like (in debugger)
Response( data: {__typename: Query, me: {__typename: Member, offers: null}}, errors: [GraphQLError(message: java.lang.RuntimeException: An unexpected error occurred for operation: service_client.<redacted>.fetch_member, partyId: <redacted>, locations: [ErrorLocation(line: 5, column: 5)], path: [me, offers], extensions: {errorType: INTERNAL})], context: Context({ResponseExtensions: Instance of 'ResponseExtensions', HttpLinkResponseContext: Instance of 'HttpLinkResponseContext'}), response {errors: [{message: java.lang.RuntimeException: An unexpected error occurred for operation: service_client.<redacted>.fetch_member, partyId: <redacted>, locations: [{line: 5, column: 5}], path: [me, offers], extensions: {errorType: INTERNAL}}], data: {__typename: Query, me: {__typename: Member, offers: null}}} )

SDK logs

ArgumentError when calling rum.stopResource: parameter null. It looks like _dd.graphql.errors is of type MappedListIterable<GraphQLError, Map<String, Object?>>, which is not supported.

Expected behavior

errors should be a list of Object, not a MappedListIterable<GraphQLError, Map<String, Object?>>

additionally, ideally attributes of incorrect/unsupported types should not prevent the event from firing!

Affected SDK versions

datadog_flutter_plugin: 2.11.0, datadog_gql_link: 1.1.1

Latest working SDK version

No response

Did you confirm if the latest SDK version fixes the bug?

No

Flutter Version

3.27.4

Setup Type

No response

Device Information

No response

Other relevant information

No response

[fuzzybinary]

Thanks for reporting @tyandl , I'll take a look.

Agreed that even if this is send the wrong type, it shouldn't prevent the resource from firing. I'll at least add some fail-safes to make sure the resource finishes properly.

I'm assuming you're using the standard graphql or graphql_flutter package?

[tyandl]

At the moment, we use Ferry as the client.
dio: 5.7.0
ferry: 0.16.1+2
ferry_flutter: 0.9.1+1
gql_code_builder: 0.13.1
gql_dio_link: 1.0.1+1
datadog_flutter_plugin: 2.12.0
datadog_gql_link: 1.1.1

[tyandl]

The following fix to https://github.com/DataDog/dd-sdk-flutter/blob/develop/packages/datadog_gql_link/lib/src/datadog_gql_link.dart#L240 seems to work:

@fuzzybinary , I could submit this as a PR. But I'm not currently setup to work on this project.
I made the change directly in my pubcache and tested that it resolves the issue for me.

  Map<String, Object?>? _serializeResponseErrors(Response response) {
    if (response.errors?.isEmpty ?? true) return null;

    final serializedErrors = response.errors!.map((e) {
      return {
        'message': e.message,
        'locations': e.locations?.map((l) => {
              'line': l.line,
              'column': l.column,
            }),
        'path': e.path
      };
    }).toList();
    return {
      '_dd': {
        'graphql': {
          _GraphQLAttributes.errors.toString(): serializedErrors,
        }
      }
    };
  }

[fuzzybinary]

Hi @tyandl,

Yes, that's the exact issue. I appreciate the offer on a PR, especially if you can get a test in that reproduces the error. I can then make sure this gets fixed in a patch release.

The native platforms are actually working on some enhanced GraphQL functionality right now, and we may actually be improving how we handle GraphQL errors generally, which is what I was verifying. But, that will likely need to wait until the next major version to release that.

[tyandl]

@fuzzybinary
I managed to get the project set up and running, but have not figured out how to submit the PR...
However adding:
packages/datadog_gql_link/test/datadog_gql_link_test.dart line 669

expect(capturedAttrs['_dd']['graphql']['errors'].runtimeType, List<Map<String, Object?>>);

will catch the condition that causes the issue. And demonstrates that the fix is effective at making the serialized error conform to the expected types.

note that actually throwing the exception never happens in the tests because rum is mocked.

Also note, that only the .toList() is necessary for the fix; https://github.com/DataDog/dd-sdk-flutter/blob/develop/packages/datadog_gql_link/lib/src/datadog_gql_link.dart#L240

[tyandl]

@fuzzybinary disregard my previous comment. here's the PR https://github.com/DataDog/dd-sdk-flutter/pull/853/files

[tyandl]

@fuzzybinary thanks for helping me get this fix in. Do you happen to have an estimate of when we may see a version 1.1.2 with this fix?

[fuzzybinary]

Hi @tyandl Probably some time next week.

In the meantime, if you need the fix immediately you can depend directly on the develop branch in your pubspec with the following:

  datadog_gql_link:
    git:
      url: git@github.com:DataDog/dd-sdk-flutter.git
      path: packages/datadog_gql_link
      ref: develop

[fuzzybinary]

This should now be fixed in 1.2.0. There was another minor API change that was pending so I rolled the two into a minor release.

[tyandl]

@fuzzybinary Thank you very much for all your help and for letting me know this was ready!