Code Monkey home page Code Monkey logo

functions-sandbox's Introduction

Build Status Coverage Status

Backstage functions-sandbox

functions-sandbox is the engine behind Backstage Functions and executes code in isolation (a sandbox). It could be used for both running code in production as well as testing the deployed functions (before they are deployed, hopefully).

$ npm install @globocom/functions-sandbox

Example of usage

const Sandbox = require('backstage-functions-sandbox');

const mySandbox = new Sandbox({
  env: {
     MY_VAR: 'TRUE', // environment variable will be available on Backstage.env.MY_VAR
  },
  globalModules: [ 'path' ], // put all available modules that will allow to import
  asyncTimeout: 10000,
  syncTimeout: 300,
});

const myCode = mySandbox.compileCode('test.js', `
  async function main(req, res) {
    const result = req.body.x * req.body.y;
    const name = Backstage.env.MY_VAR;
    // you could call await here
    return { name, result };
  }
`);

// express.Request compatible
const req = {
  headers: {},
  query: {},
  body: { x: 10, y: 10}
};

mySandbox.runScript(myCode, req).then(({status, body}) => {
  console.info('Result:', status, body);
}, (err) => {
  console.error('Error:', err);
});

Configuration

Name Description Example
env Environment variables used by deployed functions { MY_VAR: 'Some value' }
syncTimeout Timeout when executing synchronous functions syncTimeout: 300
asyncTimeout Timeout when executing asynchronous functions asyncTimeout: 1000
globalModules Modules that will be available to all functions globalModules: [ 'path/to/module' ]

Objects

req -> Request

Property Type Description
headers property HTTP Headers received from this request
query property HTTP parsed querystring
body property HTTP body decoded from json

res -> Response

Property Type Description
set(header, value) method set a HTTP Header value
status(statusCode) method change status code of this response, default: 200
send(body) method finalize the response sending body to the client
notModified() method finalize the response sending 304 without body
badRequest(msg) method finalize the response sending 400 with error msg
notFound(msg) method finalize the response sending 404 with error msg
unprocessableEntity(msg) method finalize the response sending 422 with error msg
internalServerError(msg) method finalize the response sending 500 with error msg

Pre-built exceptions

Class Description
NotModified() finalize the response sending 304 without body
BadRequest(msg) finalize the response sending 400 with error msg
NotFound(msg) finalize the response sending 404 with error msg
UnprocessableEntity(msg) finalize the response sending 422 with error msg
InternalServerError(msg) finalize the response sending 500 with error msg

functions-sandbox's People

Contributors

ceelsoin avatar fabio-gomes avatar heitorsilva avatar marcelometal avatar marcospereira avatar markiing avatar mbenford avatar rafaeleyng avatar raphamorim avatar sergiojorge avatar wpjunior avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.