Merge pull request #671 from appsignal/add-urql-integration

Add urql integration package

Author: tombruijn

package-lock.json

@@ -0,0 +1,21 @@
+---
+bump: major
+type: add
+---
+
+Our new `@appsignal/urql` package allows reporting all GraphQL errors automatically through a custom `urql` exchange:
+
+```javascript
+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]
+});
+```

packages/urql/.changesets/.gitkeep

@@ -0,0 +1,115 @@
+# `@appsignal/urql`
+
+- [AppSignal.com website][appsignal]
+- [Documentation][docs]
+- [Support][contact]
+
+The `@appsignal/javascript` integration for urql GraphQL client.
+
+See also the [mono repo README](../../README.md) 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.
+
+```typescript
+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](../../README.md#dev-install) 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:
+
+```bash
+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](https://jestjs.io) 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:
+
+```bash
+yarn test
+```
+
+### Versioning
+
+This repo uses [Semantic Versioning][semver] (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][contributing-guide] in our documentation and follow our [Code of Conduct][coc].
+
+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][waffles-page].
+
+## Support
+
+[Contact us][contact] 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.
+
+[appsignal]: https://appsignal.com
+[appsignal-sign-up]: https://appsignal.com/users/sign_up
+[contact]: mailto:support@appsignal.com
+[coc]: https://docs.appsignal.com/appsignal/code-of-conduct.html
+[waffles-page]: https://appsignal.com/waffles
+[docs]: http://docs.appsignal.com
+[contributing-guide]: http://docs.appsignal.com/appsignal/contributing.html
+
+[semver]: http://semver.org/

packages/urql/.changesets/add-urql-integration-package.md

@@ -0,0 +1,8 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "jsdom",
+  roots: ["<rootDir>/src"],
+  transform: {
+    "^.+\\.tsx?$": "ts-jest"
+  }
+}

packages/urql/README.md

@@ -0,0 +1,34 @@
+{
+  "name": "@appsignal/urql",
+  "version": "1.0.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/appsignal/appsignal-javascript.git",
+    "directory": "packages/urql"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:esm:watch": "tsc -p tsconfig.esm.json -w --preserveWatchOutput",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:cjs:watch": "tsc -p tsconfig.cjs.json -w --preserveWatchOutput",
+    "build:watch": "run-p build:cjs:watch build:esm:watch",
+    "clean": "rimraf dist coverage",
+    "link:npm": "npm link",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@appsignal/javascript": "=1.6.1"
+  },
+  "peerDependencies": {
+    "urql": ">= 2.0.0 < 5",
+    "wonka": ">= 4.0.0 < 7"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/urql/jest.config.js

@@ -0,0 +1,92 @@
+import { reportGraphQLError } from "../index"
+
+describe("reportGraphQLError", () => {
+  it("reports a GraphQL error to AppSignal with all metadata", () => {
+    const { appsignal, span } = createMockAppsignal()
+    const client = { url: "https://example.com/graphql" }
+    const result = {
+      error: {
+        graphQLErrors: [{ message: "Not found" }]
+      },
+      operation: {
+        query: { loc: { source: { body: "query { post { id } }" } } },
+        kind: "query"
+      }
+    }
+
+    reportGraphQLError(result, appsignal, client)
+
+    expect(appsignal.sendError).toHaveBeenCalledWith(
+      expect.objectContaining({
+        name: "GraphQLError",
+        message: "GraphQL Error: Not found"
+      }),
+      expect.any(Function)
+    )
+    expect(span.setTags).toHaveBeenCalledWith({
+      endpoint: "https://example.com/graphql"
+    })
+    expect(span.setTags).toHaveBeenCalledWith({ operationType: "query" })
+    expect(span.setParams).toHaveBeenCalledWith({
+      query: "query { post { id } }"
+    })
+  })
+
+  it("sets endpoint tag", () => {
+    const { appsignal, span } = createMockAppsignal()
+    const result = {
+      error: { message: "Something went wrong" },
+      operation: {
+        query: { loc: { source: { body: "mutation { createUser { id } }" } } }
+      }
+    }
+
+    const client = { url: "https://example.com/graphql" }
+    reportGraphQLError(result, appsignal, client)
+
+    expect(span.setTags).toHaveBeenCalledWith({
+      endpoint: "https://example.com/graphql"
+    })
+  })
+
+  it("sets query params on the span", () => {
+    const { appsignal, span } = createMockAppsignal()
+    const result = {
+      error: { message: "Something went wrong" },
+      operation: {
+        query: { loc: { source: { body: "mutation { createPost { id } }" } } }
+      }
+    }
+
+    reportGraphQLError(result, appsignal, {})
+
+    expect(span.setParams).toHaveBeenCalledWith({
+      query: "mutation { createPost { id } }"
+    })
+  })
+
+  it("sets operationType tag on the span", () => {
+    const { appsignal, span } = createMockAppsignal()
+    const result = {
+      error: { message: "Something went wrong" },
+      operation: { kind: "mutation" }
+    }
+
+    reportGraphQLError(result, appsignal, {})
+
+    expect(span.setTags).toHaveBeenCalledWith({
+      operationType: "mutation"
+    })
+  })
+})
+
+function createMockAppsignal() {
+  const span = {
+    setTags: jest.fn(),
+    setParams: jest.fn()
+  }
+  const appsignal = {
+    sendError: jest.fn((_error: any, callback: any) => callback(span))
+  }
+  return { appsignal, span }
+}