@dav-m85/thrift-express-middleware v1.0.0

@dav-m85/express-thrift-middleware

Express server middleware for proxying Apache Thrift server

Install

Requires Node version 6 or above.

npm i @dav-m85/express-thrift-middleware

Use

You need to use the excellent Apache Thrift protocol alongside your express server ? This middleware ease it for you.

// Server code
const app = (require('express'))()
const thrift = require('thrift')
const ThriftMiddleware = require('./ThriftMiddleware')

// I use the tutorial example here. Got this file by running
// thrift -r --gen js:node tutorial.thrift
let Calculator = require('./gen-nodejs/Calculator')
let handler = {
  ping: function (result) {
    console.log('ping()')
    result(null)
  }
}

app.use(
  // Puts the proxied thrift server in the path you want (here /rpc). Don't forget
  // to configure your client accordingly (see below)
  '/rpc',
  // You can prepend here additional middlewares if needed, like cors or authentication
  ThriftMiddleware({
    handler,
    // Please note, only TBufferedTransport and TJSONProtocol are supported right now
    // PR accepted for extensing what can be proxied to thrift
    transport: thrift.TBufferedTransport,
    protocol: thrift.TJSONProtocol,
    processor: Calculator
  })
)

// Example client code with webpack
// Same as official tutorial, except we're using the nodejs generated binding,
// and we point at the browser implementation for createXHRConnection
const thrift = require('thrift/lib/nodejs/lib/thrift/browser')
const Calculator = require('./gen-nodejs/Calculator')
const transport = thrift.TBufferedTransport
const protocol = thrift.TJSONProtocol

const connection = thrift.createXHRConnection('myhost', myport, {
  transport: transport,
  protocol: protocol,
  // We declare the configured path on the server
  path: '/rpc'
})

Et voilà ! 👊

Credits

This code is inspired from creditkarma's implementation in typescript.

Author: David Moreau <dav.m85@gmail.com> © 2018

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2018 David Moreau <dav.m85@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.