Load-testing a GraphQL server without writting a single Query 🔥

#graphql #loadtesting #testing #node

Doing load testing to your server is important, it can help you to identify a possible behavior when there are a lot of requests.

I decided to create easygraphql-lt to help me and to help you with this. The main idea behind easygraphql-lt is to do load testing with the minimun configuration possible, that is what I'm going to explain next:

How to run it:

$ npx easygraphql-lt <CONFIG_FILE>.json

How to use it:

Create a JSON file that should have the next values:

config:

URL (Required)

The URL that is going to be used to do the load testing, it'll be used to get the latest copy
of the GraphQL schema and to make all queries/mutations.

"url": "http://localhost:7000/"

Name (Optional):

This will be the name that the test is going to have; this is optional if it's not set
it will display the URL as the name.

"name": "Testing my new server"

Selected queries (Optional)

You can select a list of the queries/mutations you want to test, to do this, you must create an
array of strings with the name of the queries to test; this is optional if you don't
create it, all the queries are going to be tested.

"selectedQueries": ["createUser", "searchUser"]

Query file (Optional)

You can select if you want to save a json file with all the queries that were tested.
If you don't pass anything it is not going to be saved. The default value is false.

"queryFile": true/false

Mutations (Optional)

You can use easygraphql-lt to test
your mutations as well; if you don't pass anything it is only going to test the queries.
The default value is false.
If you set withMutations: true, don't forget to add the input values on the args

"withMutations": true/false

Duration (Optional)

You can select the duration for your tests.

"duration": 5

Arrival rate (Optional)

You can select the arrival rate for your tests.

"arrivalRate": 10

Artillery output (Optional)

You can have a JSON file with the result of the load testing used with Artillery.io,
at the end of the test the terminal is going to display a message explaining how to run this result. If it's not set it'll be
false by default.

"withOutput": true/false

args

Here you should set all the arguments that might be used on the load testing, and also if
withMutations is true, you should put the values used on the mutation.

Note: if you're going to use an array of string it should be created like this "[\"a\", \"b\"]"

JSON file example

{
  "config": {
    "url": "http://localhost:7000/",
    "name": "Testing my new server",
    "selectedQueries": ["createUser", "searchUser"],
    "queryFile": true,
    "withMutations": true,
    "duration": 5,
    "arrivalRate": 10,
    "withOutput": true
  },
  "args": {
    "getFamilyInfoByIsLocal": {
      "isLocal": true,
      "test": "[\"a\", \"b\"]",
      "age": 40,
      "name": "Demo Test"
    },
    "searchUser": {
      "name": "Demo User"
    },
    "createUser": {
      "name": "Demo User"
    },
    "createCity": {
      "input": {
        "name": "Demo Name",
        "country": "Demo Country"
      }
    }
  }
}