DGate - Distributed API Gateway

DGate is a distributed API Gateway built for developers. DGate allows you to use JavaScript/TypeScript to modify request/response data(L7). Inpired by k6 and kong.

DGate is currently in development and is not ready for production use.

Getting Started

Coming soon @ dgate.io/docs/getting-started

Prerequisites

• Go 1.22+

Installing

go install github.com/dgate-io/dgate/cmd/dgate-server@latest

Performance tests

# requires k6 and httpie
./functional-tests/admin_tests/performance_test_prep.sh
k6 run --summary-trend-stats="min,max,med,p(99),p(99.9),p(99.99)" --out web-dashboard performance-tests/perf-test.js

Application Architecture

DGate Server (dgate-server)

DGate Server is proxy and admin server bundled into one. the admin server is responsible for managing the state of the proxy server. The proxy server is responsible for routing requests to upstream servers. The admin server can also be used to manage the state of the cluster using the Raft Consensus Algorithm.

Proxy Modules

• Fetch Upstream Module (fetchUpstream) - executed before the request is sent to the upstream server. This module is used to decided which upstream server to send the current request to. (Essentially a custom load balancer module)

• Request Modifier Module (requestModifier) - executed before the request is sent to the upstream server. This module is used to modify the request before it is sent to the upstream server.

• Response Modifier Module (responseModifier) - executed after the response is received from the upstream server. This module is used to modify the response before it is sent to the client.

• Error Handler Module (errorHandler) - executed when an error occurs when sending a request to the upstream server. This module is used to modify the response before it is sent to the client.

• Request Handler Module (requestHandler) - executed when a request is received from the client. This module is used to handle arbitrary requests, instead of using an upstream service.

Features

• Logs - view module logs using the Admin API
• Stats
  • Track stats for each module, route, service, namespace, server and cluster
  • Track request stats
    • request count
    • request latency
    • request module latency
    • request upstream latency
    • request error count
    • request error latency
• Testing (dgate-runtime - uses the dgate js/ts runtime to test modules)
  • - Add unit testing for request handling
    • - preserve host / strip path - upstream URL
    • - upstream request/response headers
    • - proxy request/response headers
  • - Add tests for modules
    • - javascript
    • - typescript
    • - async/await javascript/typescript
    • - promises javascript/typescript
• Distributed Module Support
  • - distributed module sync/async cache/storage functions

Production Ready Checklist:

• Tests

  • - Unit Tests
    • changelog compaction
  • - Functional Tests
    • admin tests
    • raft tests
    • module tests (needs to be single executable)
    • grpc tests (needs to be single executable)
    • ws tests (needs to be single executable)

• Examples

  • ip hash load balancer
  • short url service
  • modify json response
  • send multiple requests and combine the response

• Add Module Permissions Functionality

• Add Change Versioning

• Add Change Rollback

• Add Server Tags

• Add Transactions

  • - Add transactional support for admin API

Release Checklist

• Test multiple modules being used at the same time
  • - ??? Add option to specify specific export variables
  • - check for module export conflicts from different modules
  • - check for global variable conflicts