thrift-god

A god repository for all your thrifts

Introduction

thrift-god provides a "package manager" for thrift interfaces. It comes with two CLI commands, thrift-god and thrift-get.

Motivation

• The source of truth for a service should live with the service. You want the thrift definition to be checked into the repository
• Every service needs a copy of the thrift definition for any service That it wants to talk too. This definition should be static. You do not want it to change at run-time.
• There should only be one version of the world. Your company runs at a single version in production; all the files should ultimately be under one version.
• The one version should be live. Developers should not manually publish new versions; instead we should just take master as the source of truth.

As a client: thrift-get

As a developer I want to be able to talk to other services; To do this I need to find their Thrift interface definitions.

I can run thrift-get list to show all available services and their IDL files.

If I want to download one of these files I can thrift-get fetch {service} and it will fetch the IDL file into ./thrift/{service}.thrift.

Once you fetch your first service we also write the ./thrift/meta.json meta file that contains the version of the file as well as the time it was last changed.

All thrift files are under one version; If you want to update to the latest version just run thrift-get update and it will update all thrift files to the latest version as well as updating the ./thrift/meta.json.

Since the thrift definitions define the interfaces of the services in production, there is only one version for all files. When you update anything, you update everything to the current version.

As a server:

If your developing the backend for a new service you just have to commit the thrift definition into git; by convention we place it in ./thrift/service.thrift.

The thrift-god daemon will fetch it and put it in the repository.

As an adminstrator: thrift-god

To set up the thrift interface repository you can run the thrift-god deamon. You just run thrift-god --config-file={path} and it will populate the thrift remote repository.

The config file contains the following fields

{
    "upstream": "git+ssh://[e-mail]/my-company/thrift-files",
    "repositoryFolder": "/var/lib/my-company/thrift-god/repo",
    "cacheLocation": "/var/lib/my-company/thrift-god/cache",
    "remotes": [{
        "repository": "git+ssh://[e-mail]/my-company/user-service",
        "branch": "master",
        "thriftFile": "thrift/service.thrift"
    }, {
        "repository": "git+ssh://[e-mail]/my-company/product-service",
        "branch": "master",
        "thriftFile": "thrift/service.thrift"
    }]
}

The thrift-god daemon will fetch all the remotes and place their thrift files in the upstream repository. You can use thrift-get to fetch from the upstream repository.

TODO:

This project is not done yet:

• Implement thrift-god config loader
• Implement fetching from remotes into upstream
• Make thrift-god a repeating cron job
• Support localFileName in config.
• Support branch in config.
• Implement thrift-get binary.

Installation

npm install thrift-god --global

Tests

npm test

Contributors

• Raynos

MIT Licensed