AH-RESQUE-UI

A resque administration website for actionhero

Setup for ActionHero v18+

install

npm install --save ah-resque-ui

Add this plugin to your ./config/plugins.js

exports['default'] = {
  plugins: (api) => {
    return {
      'ah-resque-ui': { path: __dirname + '/../node_modules/ah-resque-ui' }
    }
  }
}

Create a new config file, ./config/ah-resque-ui.js

exports.default = {
  'ah-resque-ui': (api) => {
    return {
      // the name of the middleware(s) which will protect all actions in this plugin
      // ie middleware: ['logged-in-session', 'role-admin']
      middleware: null
    }
  }
}

visit http://localhost:8080/resque

Routes

This plugin will inject routes into your application. The routes are equivalent to:

get: [
  { path: '/resque/packageDetails',       action: 'resque:packageDetails'    },
  { path: '/resque/redisInfo',            action: 'resque:redisInfo'         },
  { path: '/resque/resqueDetails',        action: 'resque:resqueDetails'     },
  { path: '/resque/queued',               action: 'resque:queued'            },
  { path: '/resque/loadWorkerQueues',     action: 'resque:loadWorkerQueues'  },
  { path: '/resque/resqueFailedCount',    action: 'resque:resqueFailedCount' },
  { path: '/resque/resqueFailed',         action: 'resque:resqueFailed'      },
  { path: '/resque/delayedjobs',          action: 'resque:delayedjobs'       },
],

post: [
  { path: '/resque/removeFailed',            action: 'resque:removeFailed'            },
  { path: '/resque/retryAndRemoveFailed',    action: 'resque:retryAndRemoveFailed'    },
  { path: '/resque/removeAllFailed',         action: 'resque:removeAllFailed'         },
  { path: '/resque/retryAndRemoveAllFailed', action: 'resque:retryAndRemoveAllFailed' },
  { path: '/resque/forceCleanWorker',        action: 'resque:forceCleanWorker'        },
  { path: '/resque/delQueue',                action: 'resque:delQueue'                },
  { path: '/resque/delDelayed',              action: 'resque:delDelayed'              },
  { path: '/resque/runDelayed',              action: 'resque:runDelayed'              },
]

};

Authentication Via Middleware

Version 0.3+ of ah-resque-ui only work with ActionHero v18+!

This package exposes some potentially dangerous actions which would allow folks to see user data (if you keep such in your task params), and modify your task queues. To protect these actions, you should configure this package to use action middleware which would restrict these actions to only certain clients.

The most basic middleware would be one to enforce a Basic Auth Password:

npm install basic-auth --save

// File: initializers/basicAuthMiddleware.js
const { api, Initializer } = require('actionhero')
const auth = require('basic-auth') // don't forget to `npm install basic-auth --save`

module.exports = class BasicAuthInitializer extends Initializer {
  constructor () {
    super()
    this.name = 'basicAuthInitializer'
    this.correctPassword = api.config.general.serverToken
  }

  initialize () {
    const middleware = {
      name: 'logged-in-session',
      global: false,
      priority: 1000,
      preProcessor: ({ connection }) => {
        const credentials = auth(connection.rawConnection.req)
        if (!credentials || credentials.pass !== this.correctPassword) {
          connection.rawConnection.res.statusCode = 401
          connection.rawConnection.res.setHeader('WWW-Authenticate', 'Basic realm="Actionhero Resque UI"')
          connection.rawConnection.res.end('Access denied')
          return false
        }
      }
    }

    api.actions.addMiddleware(middleware)
  }
}

Now you can apply the logged-in-session middleware to your actions to protect them.

To inform ah-resque-ui to use a middleware determined elsewhere like this, set api.config.ah-resque-ui.middleware = ['logged-in-session'] in the provided configuration file.

React

This project is build using React and contains various components you might want to include into your own project. These components can be loaded from public-src, ie: include WorkersList from '/node-modules/ah-resque-ui/public-src/pages/workers.js'

The main point of configuration will be the React client's baseRoute which is where you enter in the API server's URL. Simply set this.props.baseRoute on any component which uses the client and it should be passed down. window.location.origin is the default, but that may not be appropriate for all use cases.

Testing & Developing

run ./bin/setup-development PATH_TO_PROJECT from this project! It will create a top-level actionhero project with your development project symlinked in at the directory PATH_TO_PROJECT. ie: ./bin/setup-development ~/desktop/actionhero-top
Start the actionhero server in PATH_TO_PROJECT server
- (in PATH_TO_PROJECT)
- npm start
In another shell, run the webpack to regenerate your changes
- (in this project)
- npm run ui:watch