@appsignal/urql

• AppSignal.com website
• Documentation
• Support

The @appsignal/javascript integration for urql GraphQL client.

See also the mono repo README for more information.

Installation

Add the @appsignal/urql and @appsignal/javascript packages to your package.json. Then, run yarn install/npm install.

You can also add these packages to your package.json on the command line:

yarn add @appsignal/javascript @appsignal/urql urql wonka
npm install --save @appsignal/javascript @appsignal/urql urql wonka

Usage

Urql Exchange

The @appsignal/urql package provides a custom urql exchange that automatically reports GraphQL errors to AppSignal. This exchange intercepts all query and mutation results and reports any errors without requiring changes to individual useQuery calls.

import { createClient, fetchExchange } from 'urql';
import Appsignal from '@appsignal/javascript';
import { createAppsignalExchange } from '@appsignal/urql';

const appsignal = new Appsignal({
  key: 'YOUR FRONTEND API KEY'
});

const client = createClient({
  url: 'https://api.example.com/graphql',
  exchanges: [createAppsignalExchange(appsignal), fetchExchange]
});

The exchange will automatically:

• Report all GraphQL errors to AppSignal
• Include the GraphQL query body as a parameter (visible in AppSignal's error details)
• Include the endpoint URL as a tag
• Include operation name and type as tags (when available)

Error Details

When a GraphQL error occurs, AppSignal will receive:

• Error message: A concatenation of all GraphQL error messages
• Tags:
  • endpoint: The GraphQL endpoint URL
  • operationName: The name of the GraphQL operation (if specified)
  • operationType: The type of operation (query, mutation, subscription)
• Parameters:
  • query: The full GraphQL query body

This provides complete context for debugging GraphQL errors in your application.

Development

Installation

Make sure mono is installed and bootstrapped, see the project README's development section for more information.

You can then run the following to start the compiler in watch mode. This automatically compiles both the ES Module and CommonJS variants:

yarn build:watch

You can also build the library without watching the directory:

yarn build        # build both CJS and ESM
yarn build:cjs    # just CJS
yarn build:esm    # just ESM

Testing

The tests for this library use Jest as the test runner. Once you've installed the dependencies, you can run the following command in the root of this repository to run the tests for all packages, or in the directory of a package to run only the tests pertaining to that package:

yarn test

Versioning

This repo uses Semantic Versioning (often referred to as semver). Each package in the repository is versioned independently from one another.

Contributing

Thinking of contributing to this repo? Awesome! 🚀

Please follow our Contributing guide in our documentation and follow our Code of Conduct.

Also, we would be very happy to send you Stroopwafles. Have look at everyone we send a package to so far on our Stroopwafles page.

Support

Contact us and speak directly with the engineers working on AppSignal. They will help you get set up, tweak your code and make sure you get the most out of using AppSignal.