sandboxjs v5.3.0

sandboxjs

Sandbox node.js code like a boss.

Key Features

• Runs code on the public webtask.io cluster.
• Your code is totally sandboxed from everyone else's.
• Integrated with your wt-cli profiles.
• Supports returning Promises and/or invoking node-style callbacks.

Installing it

npm install sandboxjs

# Optionally configure a default wt-cli profile

Using it

First, get a webtask token using wt-cli:

# Create a new wt-cli profile
npm install -g wt-cli
wt init

# Or, if you already use wt-cli:
wt profile ls

var Assert = require('assert');
var Sandbox = require('sandboxjs');

// You can get your webtask token using the steps above
var code = 'module.exports = function (ctx, cb) { cb(null, "hello world"); }';
var profile = Sandbox.fromToken(process.env.WEBTASK_TOKEN);

// This library lets you create a webtask and run it in one step as a shortcut:
profile.run(code, function (err, res, body) {
    Assert.ifError(err);
    Assert.equal(res.statusCode, 200, 'The webtask executed as expected');
    Assert.equal(body, 'hello world', 'The webtask returned the expected string');
});

// Alternatively, your application might want to to create a webtask url
// with your (or your users') custom code and secrets.
profile.create(code, { secrets: { auth0: 'rocks' } }, function (err, webtask) {
    Assert.ifError(err);
    
    // Making requests to this url will run the specified custom code in a
    // node.js sandbox and will give it access to your secrets in the first
    // argument (`ctx`) of your exported webtask function.
    // For more information on the different styles of webtask functions that
    // are supported, see: https://webtask.io/docs/model
    console.log(webtask.url);
});

Examples

Update the code of an existing named webtask

var Sandbox = require('sandboxjs');

var sandbox = Sandbox.init({ /* ... */ });
var webtaskName = 'my_webtask';
var webtaskCode = 'module.exports = ...';

sandbox.inspectWebtask({
    name: webtaskName,
    // We need to decrypt embedded secrets so that we can set them on the
    // replacement named webtask
    decrypt: true,
    // No need to fetch code since we will be updating it anyway
    fetch_code: false,
}).then(handleClaims);

function handleClaims(claims) {
    // We will pull any claims from the existing webtask that are user-defined
    // and set them on a new claims object. Note that some claims are *NOT*
    // copied over because they are read-only claims generated by the platform.
    // Common examples include: `ca`, `jti` and `iat`.
    var newClaims = {
        jtn: webtaskName,
        dd: claims.dd,
        mb: claims.mb,
        pb: claims.pb,
        // Instead of being an opaque, encrypted blob, this will be a javascript
        // Object mapping secret key to value because we set the `decrypt`
        // option on the call to `inspectWebtask`.
        ectx: claims.ectx,
        pctx: claims.pctx,
        code: webtaskCode,
    };
    
    // Create a replacement webtask from raw claims. We use `createRaw` instead
    // of `create` so that we can deal directly with the platform's claims
    // instead of the more human-friendly aliases in `create`.
    // This method will make a token issue request with the updated claims
    // and resolve the Promise with a new `Webtask` instance based on that
    // token.
    return sandbox.createRaw(newClaims);
}

API

Modules

Classes

sandboxjs

Sandbox node.js code.

• sandboxjs
  • static
    • .fromToken(token, options) ⇒ Sandbox
    • .init(options) ⇒ Sandbox
  • inner
    • ~Sandbox
      • new Sandbox(options)
      • .clone(options)
      • .create([codeOrUrl], [options], [cb]) ⇒ Promise
      • .createRaw(claims, [cb]) ⇒ Promise
      • .createUrl(options, [cb]) ⇒ Promise
      • .run([codeOrUrl], [options], [cb]) ⇒ Promise
      • .createToken(options, [cb]) ⇒ Promise
      • .issueRequest(request, [cb]) ⇒ Promise
      • .createTokenRaw(claims, [options], [cb]) ⇒ Promise
      • .createLogStream(options) ⇒ Stream
      • .getWebtask(options, [cb]) ⇒ Promise
      • .createWebtask(options, [cb]) ⇒ Promise
      • .removeWebtask(options, [cb]) ⇒ Promise
      • .updateWebtask(options, [cb]) ⇒ Promise
      • .listWebtasks(options, [cb]) ⇒ Promise
      • .createCronJob(options, [cb]) ⇒ Promise
      • .removeCronJob(options, [cb]) ⇒ Promise
      • .setCronJobState(options, [cb]) ⇒ Promise
      • .listCronJobs([options], [cb]) ⇒ Promise
      • .getCronJob(options, [cb]) ⇒ Promise
      • .getCronJobHistory(options, [cb]) ⇒ Promise
      • .inspectToken(options, [cb]) ⇒ Promise
      • .inspectWebtask(options, [cb]) ⇒ Promise
      • .revokeToken(token, [cb]) ⇒ Promise
      • .listNodeModuleVersions(options, [cb]) ⇒ Promise
      • .ensureNodeModules(options, [cb]) ⇒ Promise
      • .updateStorage(options, storage, [cb]) ⇒ Promise
      • .getStorage(options, [cb]) ⇒ Promise

Sandbox.fromToken(token, options) ⇒ Sandbox

Create a Sandbox instance from a webtask token

Kind: static method of sandboxjs
Returns: Sandbox - A {@see Sandbox} instance whose url, token and container were derived from the given webtask token.

Sandbox.init(options) ⇒ Sandbox

Create a Sandbox instance

Kind: static method of sandboxjs
Returns: Sandbox - A {@see Sandbox} instance.

Sandbox~Sandbox

Kind: inner class of sandboxjs

• ~Sandbox
  • new Sandbox(options)
  • .clone(options)
  • .create([codeOrUrl], [options], [cb]) ⇒ Promise
  • .createRaw(claims, [cb]) ⇒ Promise
  • .createUrl(options, [cb]) ⇒ Promise
  • .run([codeOrUrl], [options], [cb]) ⇒ Promise
  • .createToken(options, [cb]) ⇒ Promise
  • .issueRequest(request, [cb]) ⇒ Promise
  • .createTokenRaw(claims, [options], [cb]) ⇒ Promise
  • .createLogStream(options) ⇒ Stream
  • .getWebtask(options, [cb]) ⇒ Promise
  • .createWebtask(options, [cb]) ⇒ Promise
  • .removeWebtask(options, [cb]) ⇒ Promise
  • .updateWebtask(options, [cb]) ⇒ Promise
  • .listWebtasks(options, [cb]) ⇒ Promise
  • .createCronJob(options, [cb]) ⇒ Promise
  • .removeCronJob(options, [cb]) ⇒ Promise
  • .setCronJobState(options, [cb]) ⇒ Promise
  • .listCronJobs([options], [cb]) ⇒ Promise
  • .getCronJob(options, [cb]) ⇒ Promise
  • .getCronJobHistory(options, [cb]) ⇒ Promise
  • .inspectToken(options, [cb]) ⇒ Promise
  • .inspectWebtask(options, [cb]) ⇒ Promise
  • .revokeToken(token, [cb]) ⇒ Promise
  • .listNodeModuleVersions(options, [cb]) ⇒ Promise
  • .ensureNodeModules(options, [cb]) ⇒ Promise
  • .updateStorage(options, storage, [cb]) ⇒ Promise
  • .getStorage(options, [cb]) ⇒ Promise

new Sandbox(options)

Creates an object representing a user's webtask.io credentials

sandbox.clone(options)

Create a clone of this sandbox instances with one or more different parameters

Kind: instance method of Sandbox

sandbox.create(codeOrUrl, options, cb) ⇒ Promise

Create a Webtask from the given options

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the token

sandbox.createRaw(claims, cb) ⇒ Promise

Create a Webtask from the given claims

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the token

sandbox.createUrl(options, cb) ⇒ Promise

Shortcut to create a Webtask and get its url from the given options

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the token

sandbox.run(codeOrUrl, options, cb) ⇒ Promise

Shortcut to create and run a Webtask from the given options

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the token

sandbox.createToken(options, cb) ⇒ Promise

Create a webtask token - A JWT (see: http://jwt.io) with the supplied options

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the token

sandbox.issueRequest(request, cb) ⇒ Promise

Run a prepared Superagent request through any configured onBeforeRequest hooks.

This can be useful for enablying proxies for server-side consumers of sandboxjs.

Kind: instance method of Sandbox
Returns: Promise - - A promise representing the fulfillment of the request

sandbox.createTokenRaw(claims, options, cb) ⇒ Promise

Create a webtask token - A JWT (see: http://jwt.io) with the supplied claims

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the token

sandbox.createLogStream(options) ⇒ Stream

Create a stream of logs from the webtask container

Note that the logs will include messages from our infrastructure.

Kind: instance method of Sandbox
Returns: Stream - A stream that will emit 'data' events with container logs

sandbox.getWebtask(options, cb) ⇒ Promise

Read a named webtask

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an array of Webtasks

sandbox.createWebtask(options, cb) ⇒ Promise

Create a named webtask

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an array of Webtasks

sandbox.removeWebtask(options, cb) ⇒ Promise

Remove a named webtask from the webtask container

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an array of Webtasks

sandbox.updateWebtask(options, cb) ⇒ Promise

Update an existing webtask's code, secrets or other claims

Note that this method should be used with caution as there is the potential for a race condition where another agent updates the webtask between the time that the webtask details and claims are resolved and when the webtask update is issued.

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an instance of Webtask representing the updated webtask

sandbox.listWebtasks(options, cb) ⇒ Promise

List named webtasks from the webtask container

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an array of Webtasks

sandbox.createCronJob(options, cb) ⇒ Promise

Create a cron job from an already-existing webtask

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with a {@see CronJob} instance.

sandbox.removeCronJob(options, cb) ⇒ Promise

Remove an existing cron job

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the response from removing the job.

sandbox.setCronJobState(options, cb) ⇒ Promise

Set an existing cron job's state

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the response from removing the job.

sandbox.listCronJobs(options, cb) ⇒ Promise

List cron jobs associated with this profile

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an Array of {@see CronJob} instances.

sandbox.getCronJob(options, cb) ⇒ Promise

Get a CronJob instance associated with an existing cron job

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with a {@see CronJob} instance.

sandbox.getCronJobHistory(options, cb) ⇒ Promise

Get the historical results of executions of an existing cron job.

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an Array of cron job results.

sandbox.inspectToken(options, cb) ⇒ Promise

Inspect an existing webtask token to resolve code and/or secrets

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the resolved webtask data.

sandbox.inspectWebtask(options, cb) ⇒ Promise

Inspect an existing named webtask to resolve code and/or secrets

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the resolved webtask data.

sandbox.revokeToken(token, cb) ⇒ Promise

Revoke a webtask token

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the token
See: https://webtask.io/docs/api_revoke

sandbox.listNodeModuleVersions(options, cb) ⇒ Promise

List versions of a given node module that are available on the platform

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with the token

sandbox.ensureNodeModules(options, cb) ⇒ Promise

Ensure that a set of modules are available on the platform

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an array of { name, version, state } objects

sandbox.updateStorage(options, storage, cb) ⇒ Promise

Update the storage associated to the a webtask

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an array of Webtasks

sandbox.getStorage(options, cb) ⇒ Promise

Read the storage associated to the a webtask

Kind: instance method of Sandbox
Returns: Promise - A Promise that will be fulfilled with an array of Webtasks

CronJob

Kind: global class

• CronJob
  • new CronJob()
  • .sandbox
  • .refresh([cb]) ⇒ Promise
  • .remove([cb]) ⇒ Promise
  • .getHistory(options, [cb]) ⇒ Promise
  • .inspect(options, [cb]) ⇒ Promise
  • .setJobState(options, [cb]) ⇒ Promise

new CronJob()

Creates an object representing a CronJob

cronJob.sandbox

Kind: instance property of CronJob
Properties

cronJob.refresh(cb) ⇒ Promise

Refresh this job's metadata

Kind: instance method of CronJob
Returns: Promise - A Promise that will be fulfilled with the this cron job instance

cronJob.remove(cb) ⇒ Promise

Remove this cron job from the webtask cluster

Note that this will not revoke the underlying webtask token, so the underlying webtask will remain functional.

Kind: instance method of CronJob
Returns: Promise - A Promise that will be fulfilled with the token

cronJob.getHistory(options, cb) ⇒ Promise

Get the history of this cron job

Kind: instance method of CronJob
Returns: Promise - A Promise that will be fulfilled with an Array of cron job results.

cronJob.inspect(options, cb) ⇒ Promise

Inspect an existing webtask to optionally get code and/or secrets

Kind: instance method of CronJob
Returns: Promise - A Promise that will be fulfilled with an Array of cron job results.

cronJob.setJobState(options, cb) ⇒ Promise

Set the cron job's state

Kind: instance method of CronJob
Returns: Promise - A Promise that will be fulfilled with an Array of cron job results.

Webtask

Kind: global class

• Webtask
  • new Webtask()
  • .claims
  • .token
  • .sandbox
  • .meta
  • .secrets
  • .code
  • .createLogStream(options) ⇒ Stream
  • .run(options, [cb]) ⇒ Promise
  • .createCronJob(options, [cb]) ⇒ Promise
  • .inspect(options, [cb]) ⇒ Promise
  • .remove([cb]) ⇒ Promise
  • .revoke([cb]) ⇒ Promise
  • .update([options], [cb]) ⇒ Promise
  • .updateStorage(options, storage, [cb]) ⇒ Promise
  • .getStorage(options, [cb]) ⇒ Promise

new Webtask()

Creates an object representing a Webtask

webtask.claims

Kind: instance property of Webtask
Properties

webtask.token

Kind: instance property of Webtask
Properties

webtask.sandbox

Kind: instance property of Webtask
Properties

webtask.meta

Kind: instance property of Webtask
Properties

webtask.secrets

Kind: instance property of Webtask
Properties

webtask.code

Kind: instance property of Webtask
Properties

webtask.createLogStream(options) ⇒ Stream

Create a stream of logs from the webtask container

Note that the logs will include messages from our infrastructure.

Kind: instance method of Webtask
Returns: Stream - A stream that will emit 'data' events with container logs

webtask.run(options, cb) ⇒ Promise

Run the webtask and return the result of execution

Kind: instance method of Webtask
Returns: Promise - - A Promise that will be resolved with the response from the server.

webtask.createCronJob(options, cb) ⇒ Promise

Schedule the webtask to run periodically

Kind: instance method of Webtask
Returns: Promise - - A Promise that will be resolved with a {@see CronJob} instance.

webtask.inspect(options, cb) ⇒ Promise

Inspect an existing webtask to optionally get code and/or secrets

Kind: instance method of Webtask
Returns: Promise - A Promise that will be fulfilled with the result of inspecting the token.

webtask.remove(cb) ⇒ Promise

Remove the named webtask

Kind: instance method of Webtask
Returns: Promise - A Promise that will be fulfilled with the result of inspecting the token.

webtask.revoke(cb) ⇒ Promise

Revoke the webtask's token

Kind: instance method of Webtask
Returns: Promise - A Promise that will be fulfilled with the result of revoking the token.

webtask.update(options, cb) ⇒ Promise

Update a webtask

Kind: instance method of Webtask
Returns: Promise - A Promise that will be fulfilled with the result of revoking the token.

webtask.updateStorage(options, storage, cb) ⇒ Promise

Update the storage associated to the a webtask

Kind: instance method of Webtask
Returns: Promise - A Promise that will be fulfilled with an array of Webtasks

webtask.getStorage(options, cb) ⇒ Promise

Read the storage associated to the a webtask

Kind: instance method of Webtask
Returns: Promise - A Promise that will be fulfilled with an array of Webtasks

Usages

This library will be used in wt-cli.

Contributing

Just clone the repo, run npm install and then hack away.

Issue reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

License

MIT

What is Auth0?

Auth0 helps you to:

• Add authentication with multiple authentication sources, either social like Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, amont others, or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider.
• Add authentication through more traditional username/password databases.
• Add support for linking different user accounts with the same user.
• Support for generating signed Json Web Tokens to call your APIs and flow the user identity securely.
• Analytics of how, when and where users are logging in.
• Pull data from other sources and add it to the user profile, through JavaScript rules.

Create a free account in Auth0

1. Go to Auth0 and click Sign Up.
2. Use Google, GitHub or Microsoft Account to login.