yaml-variables

Variables in graphcool.yml

Overview

This directory contains the service definition and file structure for a simple Graphcool service that makes use of variables inside graphcool.yml. Read the last section of this README to learn how the different components fit together.

.
├── README.md
├── graphcool.yml
├── src
│   ├── greeting.graphql
│   ├── hello.js
│   └── hey.js
└── types.graphql

Read more about service configuration in the docs.

Get started

1. Download the example

Clone the full framework repository and navigate to this directory or download only this example with the following command:

curl https://codeload.github.com/graphcool/framework/tar.gz/master | tar -xz --strip=2 framework-master/examples/env-variables
cd env-variables

Next, you need to create your GraphQL server using the Graphcool CLI.

2. Install the Graphcool CLI

If you haven't already, go ahead and install the CLI first:

npm install -g graphcool-framework

3. Create the GraphQL server

The next step will be to deploy the Graphcool service that's defined in this directory.

However, before you do so, you need to set the environment variable that is referenced in graphcool.yml. This environment variable is called GREETING and needs to be set to either hello or hey to determine whether ./src/hello.js or ./src/hey.js will be invoked.

3.1. Set environment variable GREETING

Depending on your shell, you can set the environment variable in different ways:

bash

If you're using bash, use either of the following commands inside this directory:

export GREETING=hello
# or 
# export GREETING=hey

fish shell

If you're using fish shell, use either of the following commands inside this directory:

set -x GREETING hello
# or
# set -x GREETING hey

direnv

If you're using direnv, create a .envrc-file in this directory and add either of the following lines to it:

export GREETING=hello
# or
# export GREETING=hey

3.2. Deploying the service

To deploy the service and actually create your GraphQL server, invoke the following command:

graphcool-framework deploy

Note: Whenever you make changes to files in this directory, you need to invoke graphcool-framework deploy again to make sure your changes get applied to the "remote" service.

Testing the service

The easiest way to test the deployed service is by using a GraphQL Playground.

Open a Playground

You can open a Playground with the following command:

graphcool-framework playground

Send the greeting query with the name argument

To test the resolver function, you can send the following query:

{
  greeting(name: "Sarah") {
    message
  }
}

The message that's returned in the payload will be: Hello Sarah.

Send the greeting query without the name argument

To test the resolver function, you can send the following query:

{
  greeting {
    message
  }
}

The message that's returned in the payload will be: Hello World. That's because no name argument is passed in the query. The function will thus fall back to the value of the string World instead of a concrete name.

What's in this example?

This function contains implementations for two resolver functions:

• hello.js: Greets the caller with Hello
• hey.js: Greets the caller with Hey

The schemas which defines the APIs of both resolver is defined in greeting.graphql.

This schema is reference in graphcool.yml:

greeting:
  type: resolver
  schema: ./src/greeting.graphql
  handler:
    code:
      src: ./src/${env:GREETING}.js

Referencing environment variables in graphcool.yml at deployment time

Despite the fact that this service contains two function implementations, only one of them will be deployed at any given time! Which one that is depends on the value of the environment variable GREETING when graphcool-framework deploy is invoked. That's because the greeting.handler.code.src property refers to this environment variable: ./src/${env:GREETING}.js.

When graphcool-framework deploy is called, the CLI will read the value of the environment variable and replace ${env:GREETING} with it. If the value of GREETING is something other than hello or hey, graphcool-framework deploy will fail with the message that the referenced source file does not exist.