apollo-couchbase

Apollo On The Couch

A framework for building GraphQL APIs with the Apollo GraphQL server backed by Couchbase.

The main inspiration for this framework is Ruby On Rails which was a game-changer when it came. But, Ruby On Rails has five huge sub-optimalities that
Apollo On The Couch aims to fix:

• Scalability: It didn't scale seamlessly from start up to millions of operations per second.
• Reliability: It required lots of infrastructure work to become enterprise-grade reliable.
• Capability: It didn't support full-text search and analytics out-of-the-box.
• Cost-effectiveness: It required a lot of infrastructure work to be able to run cost-effectively.
• REST vs GraphQL: It's default API was REST which is sub-optimal in so many ways compared to GraphQL.

With Apollo On The Couch you get all of the benefits with the Ruby On Rails approach and all of the above mentioned sub-optimalities fixed out-of-the-box with amazing developer and devops experience all the way from startup to millions of operations per second.

Getting Started

Prerequisites

• A Couchbase Capella account or your own Couchbase server.
• Node.js (Only tested with version: v18.12.1. I heard there where some issues with v20, which is on the roadmap to fix.)
• npm or similar

Create Your Apollo On The Couch Server Project

Create a Typescript project with the appropriate dependencies.

npx create-apollo-couchbase-server@latest my-server

Configure the Couchbase Environment Variables in the .env file

Set the username and password of your Couchbase user.

COUCHBASE_USER=username
COUCHBASE_PASSWORD=password

Choose if you'd like to activate access control and if you want to require a JWT token to be sent as an authorization header in all requests.

AUTH=true
AUTH_ALL=false
AUTH_TOKEN_ISSUER=https://<Your Identity Provider>
AUTH_TOKEN_AUDIENCE=<Your client id>

Generate a resource

In apollo-couchbase, the GraphQL schema and resolvers are structured in units called resources. A resource will typically be similar to a REST resource, with CrUD operations, but it can really be whatever kind of group of functions that makes sense for your purposes.

If you want your resource to be similar to a typical REST resource you can use the scaffolding script, generate-resource, to generate a new resource. This script will generate resources with scaffold resolvers and schema files that you can edit to fit your purposes. You can also choose to create your resources manually if you want a different structure.

To create a resource using the scaffolding script, follow these steps:

Run the generate-resource script:

npm run generate-resource <resourceNameInPlural>

E.g

npm run generate-resource products

The new resource files are located at /src/graphql/resources/<resourceNameInPlural>. With directories for the resolvers and a schema file called schema.graphql.

Edit the resource schema file

Specify the properties you want to expose on the resource.

E.g.

type ProductContent {
    name: String!
    price: Float
    quantity: Int
    tags: [String!]
}

input ProductContentInput {
    name: String!
    price: Float
    quantity: Int
    tags: [String!]
}

input ProductContentPatchInput {
    name: String
    price: Float
    quantity: Int
    tags: [String!]
}

input ProductsListFiltersInput {
  name: String
}

Notice that there is no exclamation mark in the ProductContentPatchInput input, since you probably don't want to require any field to be included when patching records.

This script with create a collection in Couchbase if it didn't already exist and a primary index on that collection.

Generate the Typescript types for the new resource

After editing a schema file you need to run the generate-graphql-types script to update the Typescript types:

npm run generate-graphql-types

Start the server

Now, you are ready to start the server.

npm run dev

License

This project is licensed under the ISC License. See the LICENSE file for details.