actionhero / ah-resque-ui

Visualization and Managment tools for Actionhero Tasks & Resque Jobs

Actionhero

The reusable, scalable, and quick node.js API server for stateless and stateful applications

---

NPM | Web Site | Latest Docs | GitHub | Slack | Twitter

Who is the Actionhero?

Actionhero is a multi-transport API Server with integrated cluster capabilities and delayed tasks. The goal of actionhero is to create an easy-to-use toolkit for making reusable & scalable APIs for HTTP, WebSockets, and more. Clients connected to an actionhero server can consume the api, consume static content, and communicate with each other. Actionhero is cluster-ready, with built in support for background tasks, 0-downtime deploys, and more. Actionhero provides a simple Async/Await API for managing every type of connection and background task.

Currently actionhero supports the following out of the box...

• Web Clients: HTTP, HTTPS
• Web Socket Clients: HTTP, HTTPS

... and you can also make your own servers and transports.

Quick Start

# Generate a new Project
npx actionhero generate
npm install
npm run build
npm run dev # <-- I automatically notice changes and restart, as well as compiling .ts files

# Use the actionhero CLI
(npx) actionhero generate action --name my_action
(npx) actionhero generate task --name my_task --queue default --frequency 0

# Test
npm test

# To deploy your app
npm run build
npm run start

Your new project will come with example actions, tests, and more.

Or deploy a free API server now:

Learn More 📚

• Getting Started @ www.actionherojs.com
  • Actionhero's website can be found @ https://github.com/actionhero/www.actionherojs.com/. If you want to contribute to this site, visit the related project
  • ---> Start with the Tutorials <---
• Read the typedoc documentation @ docs.actionherojs.com
  • Starting with Actionhero version 18, the documentation for each version is included in this repository (and the NPM package) in the /docs folder. The current version of this documentation is also automatically deployed to https://docs.actionherojs.com.
• Find community-based resources
• Interact with the Community & View the Release History
• Server Client

In-depth Tutorials 🎓

Core Components

• Actions
• Tasks
• Middleware
• Initializers
• CLI Commands
• Configuration
• Cluster
• Chat & Realtime Communication
• File Server
• Logging
• Plugins
• Servers
• Localization & Translation

Server Types

• Web Server & Routes
• WebSocket Server

Testing, Deployment, and Operations

• Running Actionhero
• Development Mode & REPL
• Testing & SpecHelper
• Production Notes
• Upgrade Path

Sample Projects

• Simple
• Elaborate (React, Next.JS, Bootstrap, Sequelize)
• Client Use: React
• Client Use: React Native

Who?

• Many folks have helped to make Actionhero a reality.
• If you want to contribute to actionhero, contribute to the conversation on github and join us on slack

Contributing

• Contributing to Actionhero is easy! You can learn more about contributing to Actionhero here
• By engaging the with Actionhero community or contributing to this or related projects, you agree to our Code of Conduct

License

Apache 2.0

Dedication

Technology is a powerful force in our society. Data, software, and communication can be used for bad: to entrench unfair power structures, to undermine human rights, and to protect vested interests. But they can also be used for good: to make underrepresented people’s voices heard, to create opportunities for everyone, and to avert disasters. This project is dedicated to everyone working toward the good.

Inspired by Martin Kleppmann

ah-resque-ui's Issues

docs are out of date or not working

Hi, trying to launch your software. It has error "unknown action or invalid apiVersion.

mkdir resque
cd resque/
npm init
npm i actionhero --save
node ./node_modules/.bin/actionhero generate
npm i
npm i ah-resque-ui --save
node ./node_modules/.bin/actionhero link --name ah-resque-ui
node ./node_modules/.bin/actionhero start

[email protected]
node -v v7.8.0
npm -v 4.2.0

will try to use actionhero version 13.x now

All hrefs should be /public/...

Like this https://github.com/actionhero/ah-resque-ui/blob/master/public/resque/index.html#L11 and the images

Front-End Tests

We should have some.

Developing guidelines in readme would help

Could you add some info inside readme how do you test while developing?

How can I run this plugin separately to add things to it?

Hi @evantahler
I was thinking to add more analytics to your plugin but don't know how to run it separately.

some ideas for better usability while using UI

First of all, thank you for this UI. It helps to see what's happening. Below are some ideas what would help to see "action" even better:

TypeError: Cannot convert undefined or null to object.

hi, i have setup a standard AH install with the plugin,
action resqueDetails returns 200 but the plugin UI shows a Danger : TypeError: Cannot convert undefined or null to object.
i enabled a worker to see if would resolve. the error persists coming from somewhere in this render (0, _keys2.default)(this.state.stats).map(function (k) { below

	  render: function render() {
...
	            { className: 'table table-hover' },
	            _react2.default.createElement(
	              'tbody',
	              null,
	              (0, _keys2.default)(this.state.stats).map(function (k) {
	                var v = _this4.state.stats[k];
	                if (k.indexOf(':') > 0) {
	                  return null;
	                }

Paged list of failed tasks not working correctly

When clicking the Retry or Remove buttons on a paginated list of failed tasks, it appears to be missing the pagination offset or something, because it is not performing the action on the targetted task.

In this first image, I clicked Retry on number 99, task:mSeriesAppImport:882b1d88-....

Rather than disappearing, it moves up the list to spot number 98, and I'm assuming the task in spot 49 on the first page was just retried.

cannot find linked refrence to "ah-resque-ui.link"

Cloned my repo freshly on a fresh Windows 10 Machine. Now I can't get it to npm start. npm install seems complete now. I really think the problem is on my side not yours. I am just to inexperienced to make it work.

 throw('cannot find linked refrence to' + file);
                    ^
cannot find linked refrence toah-resque-ui.link

npm ERR! Windows_NT 10.0.14393
npm ERR! argv "C:\\Program Files\\nodejs\\node.exe" "XXX\\AppData\\Roaming\\npm\\node_modules\\npm\\bin\\npm-cli.js" "start"
npm ERR! node v6.5.0
npm ERR! npm  v3.10.7
npm ERR! code ELIFECYCLE
npm ERR! [email protected] start: `actionhero start`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start script 'actionhero start'.
npm ERR! Make sure you have the latest version of node.js and npm installed.
npm ERR! If you do, this is most likely a problem with the shelfhub package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR!     actionhero start
npm ERR! You can get information on how to open an issue for this project with:
npm ERR!     npm bugs shelfhub
npm ERR! Or if that isn't available, you can get their info via:
npm ERR!     npm owner ls shelfhub
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR!     XXX\src\npm-debug.log

also this is happening when I try to link/unlink ah-resque-ui

λ npm run .\node_modules\.bin\actionhero -- link --name ah-resque-ui
npm ERR! Windows_NT 10.0.14393
npm ERR! argv "C:\\Program Files\\nodejs\\node.exe" "XXX\AppData\\Roaming\\npm\\node_modules\\npm\\bin\\npm-cli.js" "run" ".\\node_modules\\.bin\\actionhero" "--" "link" "--name" "ah-resque-ui"
npm ERR! node v6.5.0
npm ERR! npm  v3.10.7

npm ERR! missing script: .\node_modules\.bin\actionhero
npm ERR!
npm ERR! If you need help, you may report this error at:
npm ERR!     <https://github.com/npm/npm/issues>

npm ERR! Please include the following file with any support request:
npm ERR!     XXX\src\npm-debug.log

the directory contains actionhero* and actionhero-cmd

Keep in mind this is a kind of fresh Windows 10. I don't want to use up alot of your time but perhaps you have a quick notch in the right direction.

Page freeze when loading several failed jobs

When loading several failed jobs (38 in our instance), the entire page freezes until request is completed.

No console errors (aside from React Dev messages) and the request eventually returns (after 2 minutes).

comparison with resque-web

as I understand this project is the same thing as resque-web:

• https://github.com/actionhero/node-resque/tree/v7.0.6/resque-web

(could you document (in readme)) what's the difference, what's this one do better/worse than resque-web?

ps: shouldn't resque-web be in thanks section?

• https://github.com/actionhero/ah-resque-ui#thanks

How to customize node-resque connection options

I need to customize namespace and use Redis sentinel with ioredis. How can I accomplish this?

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Overview graph formatting off when content is all zeros

AH 23 with ah-resque 2.0.4

When I go to the overview screen and there are not tasks pending the graph view looks off. I'm expecting to see a bunch of lines all running at 0 but instead there is a black bar.

Happens using on Brave browser, Chrome browser, and Firefox on my Ubuntu 18.04 laptop

Idle Image

Image with some data

ah-resque-ui "ah is not defined"

I was setting up ah-resque-ui and followed the instructions from step 1-3, instructions , but when I run action hero throws the next error 'ah is not defined'

my files:

config/plugins.js

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

config/ah-resque-ui.js

ah

thanks in advance :)

Can't make it work

Thanks for creating resque-ui, I am trying to make it work on mac but I cannot. Not sure what I am missing here. I took following steps, since the instructions on readme page didn't work for me.
In the project folder, execute below command.

1. npm install actionhero --save
2. node ./node_modules/.bin/actionhero generate
3. npm install ah-resque-ui --save
4. node ./node_modules/.bin/actionhero link --name ah-resque-ui (npm run ... give missing script: ./node_modules/.bin/actionhero error)
5. finally node ./node_modules/.bin/actionhero start

No code is injected in routes.js and http://localhost:8080 shows the default actionhero page with "CONGRATULATIONS!" message.

What am I missing?

Remove JS alert

@evantahler First of all, I'm replacing the ruby version of the resque web app with this project, and I'm pretty jazzed, so thank you.

the old school JavaScript alert(..) is driving me insane as I'm developing some changes. Thoughts on replacing it with a console.error or an alert in the dom?

File not found

Hi @evantahler
Sometimes /rescue url is not working.

redis stats

How much ram consumed is the main stat...

Opening Error detail modal not working on pages > 1

Opening the error detail modal on page 1 of the error list works. On all other pages > 1 this error occurs on the client:

app.bundle.min.js:47 Uncaught TypeError: Cannot set property 'renderedStack' of undefined at Object.renderFailureStack (app.bundle.min.js:47) at HTMLUnknownElement.o (app.bundle.min.js:7) at Object.r.invokeGuardedCallback (app.bundle.min.js:7) at a (app.bundle.min.js:7) at Object.s [as executeDispatchesInOrder] (app.bundle.min.js:7) at h (app.bundle.min.js:7) at v (app.bundle.min.js:7) at Array.forEach (<anonymous>) at n (app.bundle.min.js:7) at Object.processEventQueue (app.bundle.min.js:7)

Structure and format of the error in redis is valid and identical for working and for non-working messages. Really seems to be related with page number.

basic auth example in readme is old Actionhero

use new style

A crash

Running an actionhero server ( with fakeredis enabled ) and visiting http://127.0.0.1:8080/resque produces the following error, resulting in a server crash:

2016-07-25T17:12:47.211Z - notice: *** Server Started ***
/home/l0oky/Projects/nodejs/src/myproject/node_modules/ah-resque-ui/actions/ah-resque-ui.js:16
    data.response.packageDetails.redis = api.config.redis.client.args;
                                                                ^

TypeError: Cannot read property 'args' of undefined
    at Object.exports.packageDetails.run (/home/l0oky/Projects/nodejs/src/myproject/node_modules/ah-resque-ui/actions/ah-resque-ui.js:16:65)
    at /home/l0oky/Projects/nodejs/src/myproject/node_modules/actionhero/initializers/actionProcessor.js:264:31
    at /home/l0oky/Projects/nodejs/src/myproject/node_modules/async/lib/async.js:726:13
    at /home/l0oky/Projects/nodejs/src/myproject/node_modules/async/lib/async.js:52:16
    at /home/l0oky/Projects/nodejs/src/myproject/node_modules/async/lib/async.js:269:32
    at /home/l0oky/Projects/nodejs/src/myproject/node_modules/async/lib/async.js:44:16
    at /home/l0oky/Projects/nodejs/src/myproject/node_modules/async/lib/async.js:723:17
    at /home/l0oky/Projects/nodejs/src/myproject/node_modules/async/lib/async.js:167:37
    at Object.middleware.ah-resque-ui-proxy-middleware.preProcessor (/home/l0oky/Projects/nodejs/src/myproject/node_modules/ah-resque-ui/initializers/ah-resque-ui.js:33:18)
    at /home/l0oky/Projects/nodejs/src/myproject/node_modules/actionhero/initializers/actionProcessor.js:144:72
    at /home/l0oky/Projects/nodejs/src/myproject/node_modules/async/lib/async.js:718:13
    at Immediate.iterate [as _onImmediate] (/home/l0oky/Projects/nodejs/src/myproject/node_modules/async/lib/async.js:262:13)
    at processImmediate [as _immediateCallback] (timers.js:383:17)