fxa/packages/fxa-graphql-api

FXA GraphQL API

This is the GraphQL server for the Firefox Accounts API, its current primary consume is the new settings page.

Connecting to the Playground

The GraphQL playground for this package is available at localhost:8290/graphql, providing a GUI for an up-to-date schema and API docs, as well as a way to test queries and mutations.

The playground requires a sessionToken for authorization from the login response. Verify an account locally, sign out, and with the Network tab open, login. Under the "Response" tab for the account/login POST request, copy the sessionToken.

Add this as a property of a JSON object with an authorization key in the bottom left-hand corner of the GQL playground labeled "HTTP Headers":

{
  "authorization": "d4a62a0f58efb0e9c7d17b579434f2a56cad10503033874002ddd507a503cea5"
}

Hit the "play" button and the schema and docs will populate.

Testing

This package uses Mocha to test its code. By default npm test will test all files ending in .spec.ts under src/test/ and uses ts-node so it can process TypeScript files.

Test specific tests with the following commands:

# Test only src/test/lib/sentry.spec.ts
npx mocha -r ts-node/register src/test/lib/sentry.spec.ts

# Grep for "bearer token"
npx mocha -r ts-node/register src/test/lib/** -g "bearer token"

Refer to Mocha's CLI documentation for more advanced test configuration.

License

MPL-2.0