agendash 1.0.0 → 3.0.0

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:8.2.0-alpine
+FROM node:14-alpine
 
 # Dependencies
 # RUN apk update && apk upgrade && \
@@ -6,7 +6,8 @@ FROM node:8.2.0-alpine
 
 ENV NODE_ENV=production \
   MONGODB_URI=mongodb://mongodb \
-  COLLECTION=agendaJobs
+  COLLECTION=agendaJobs \
+  BASE_PATH=/
 
 RUN mkdir -p /agendash
 WORKDIR /agendash

package/History.md

@@ -1,84 +1,106 @@
-1.0.0 / 2019-02-25
-====
-* Add Hapi v17 middleware, drop support for Node.js v6 & v7 (#81) by umens (**BREAKING**)
-* Support Agenda version 2 by alexkwolfe (**BREAKING**)
+# 3.0.0
 
-0.5.0 / 2019-02-25
-====
+- BREAKING: Drop support for MongoDB v3.4, only >=v3.6 is supported now.
+- BREAKING: Drop support for node 10, but added node 16 support.
+- feat: add `fastify` support #194
+- fix: a lot of rendering issues
+- fix: newer version of `mongodb` compatibility #193
 
-* Update dependencies (#69, #70) (**BREAKING**)
-  * Agenda `>=0.7.0 <1.0.0` → `^1.0.3` and thus require MongoDB v3+
-  * async `^1.0.0` → `^2.6.0`
-* Drop support for Node.js v4 and v5 (might still work but we're stopping testing these) (**BREAKING**)
-* Switch testing with Mocha to [Ava](https://www.npmjs.com/package/ava) (#70)
-* Docker support (#54) by WoLfulus
-* Fix 404 errors when deleting and re-queuing jobs (#61) by koresar
+This file won't mention contributors anymore. Because all contributors are listed on the [main page](https://github.com/agenda/agendash) now. Thanks, GitHub!
 
-0.4.0 / 2016-10-27
-==================
+# 2.1.0 - JSON validation when creating jobs
 
-  * (simison) Agenda dependency version `<1.0.0` to avoid breaking dependency.
-  * (loris) Fix #24 - Added indexes for faster queries.
-  * Fix #28 - Removed dependency on Mongo Driver.
-  * Added API tests with mocha and supertest. No frontend tests.
+- feat: Add json validator message when createJob #169 (thanks @love8587)
 
-0.3.2 / 2016-06-30
-==================
+# 2.0.0 - First public release of v2 as Agendash proper
 
-  * (HugoCornu) Fix #19 "Schedule Job" - Don't repeat job if user didn't want it repeated
+Complete rewrite of Agendash in Vue.js!
 
-0.3.1 / 2016-04-12
-==================
+Supports Node.js 10 and up.
 
-  * (simison) Add engines key to package.json
+# 2.0.0-beta0.8.2 / 2020-12-04 - As agendash2, in parallel repository https://github.com/agenda/agendash-v2
 
-0.3.0 / 2016-04-04
-==================
+- fix: search by job name, small side bar design fix and toggle improvements (thanks @simllll)
+- fix: joblist reset fix (thanks @simllll)
+- fix: improve design on desktop + close sidebar on mobile when clicked on something (thanks @simllll)
+- feat: enable options.query as number (thanks @Enubia @simllll)
+- feat: multiselect checkboxes (thanks @Enubia @simllll)
 
-  * (bh-chaker) Schedule Job Feature - create new jobs from the UI
-  * Limit to 200 jobs on page, no UI for configuration
+# 2.0.0-beta0.1.0 / 2020-04-30 - First public release of Agendash2 in parallel repository https://github.com/agenda/agendash-v2
 
-0.2.1 / 2016-03-25
-==================
+- New frontend written from scratch in Vue.js
+- Add search
+- Add pagination
+- Change default refresh interval to 60 seconds
 
-  * (vziukas) Recurring job count and labels
-  * Fixed "queued" label colors
+# 1.0.0 / 2019-02-25
 
-0.2.0 / 2016-03-18
-==================
+- Add Hapi v17 middleware, drop support for Node.js v6 & v7 (#81) by umens (**BREAKING**)
+- Support Agenda version 2 by alexkwolfe (**BREAKING**)
 
-  * (vziukas) Configurable title
-  * Middleware option moved to "options" object
+  # 0.5.0 / 2019-02-25
 
-0.1.1 / 2016-03-17
-==================
+- Update dependencies (#69, #70) (**BREAKING**)
+  - Agenda `>=0.7.0 <1.0.0` → `^1.0.3` and thus require MongoDB v3+
+  - async `^1.0.0` → `^2.6.0`
+- Drop support for Node.js v4 and v5 (might still work but we're stopping testing these) (**BREAKING**)
+- Switch testing with Mocha to [Ava](https://www.npmjs.com/package/ava) (#70)
+- Docker support (#54) by WoLfulus
+- Fix 404 errors when deleting and re-queuing jobs (#61) by koresar
 
-  * (vziukas) multiple instances of agendash can each have a separate agenda
+  # 0.4.0 / 2016-10-27
 
-0.1.0 / 2016-03-15
-==================
+  - (simison) Agenda dependency version `<1.0.0` to avoid breaking dependency.
+  - (loris) Fix #24 - Added indexes for faster queries.
+  - Fix #28 - Removed dependency on Mongo Driver.
+  - Added API tests with mocha and supertest. No frontend tests.
 
-  * (rapidia) remove "arrow function" syntax for non-chrome browsers
-  * (ebourmalo) Fix the middleware usage and use a proper structure
+  # 0.3.2 / 2016-06-30
 
-0.0.5 / 2016-02-24
-==================
+  - (HugoCornu) Fix #19 "Schedule Job" - Don't repeat job if user didn't want it repeated
 
-  * Batch requeue and delete
-  * Select All and Select None
+  # 0.3.1 / 2016-04-12
 
-0.0.4 / 2016-02-24
-==================
+  - (simison) Add engines key to package.json
 
-  * Select multiple jobs
+  # 0.3.0 / 2016-04-04
 
-0.0.2 / 2016-02-23
-==================
+  - (bh-chaker) Schedule Job Feature - create new jobs from the UI
+  - Limit to 200 jobs on page, no UI for configuration
 
-  * version bump so npm will update docs
-  * Added screenshots
+  # 0.2.1 / 2016-03-25
 
-0.0.1 / 2016-02-23
-==================
+  - (vziukas) Recurring job count and labels
+  - Fixed "queued" label colors
 
-  * Initial Release
+  # 0.2.0 / 2016-03-18
+
+  - (vziukas) Configurable title
+  - Middleware option moved to "options" object
+
+  # 0.1.1 / 2016-03-17
+
+  - (vziukas) multiple instances of agendash can each have a separate agenda
+
+  # 0.1.0 / 2016-03-15
+
+  - (rapidia) remove "arrow function" syntax for non-chrome browsers
+  - (ebourmalo) Fix the middleware usage and use a proper structure
+
+  # 0.0.5 / 2016-02-24
+
+  - Batch requeue and delete
+  - Select All and Select None
+
+  # 0.0.4 / 2016-02-24
+
+  - Select multiple jobs
+
+  # 0.0.2 / 2016-02-23
+
+  - version bump so npm will update docs
+  - Added screenshots
+
+  # 0.0.1 / 2016-02-23
+
+  - Initial Release

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Joe Frambach
+Copyright (c) Agenda maintainers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,84 +1,102 @@
 # Agendash
-[![Build Status](https://travis-ci.org/agenda/agendash.svg)](https://travis-ci.org/agenda/agendash)
-<a href="https://slackin-ekwifvcwbr.now.sh/"><img src="https://slackin-ekwifvcwbr.now.sh/badge.svg" alt="Slack Status"></a>
-[![Known Vulnerabilities](https://snyk.io/test/github/agenda/agendash/badge.svg?targetFile=package.json)](https://snyk.io/test/github/agenda/agendash?targetFile=package.json)
 
-A Dashboard for [Agenda](https://github.com/agenda/agenda)
+A Dashboard for [Agenda](https://github.com/agenda/agenda).
 
 ---
 
 ### Features
 
-- Job status auto-refreshes (2-second polling by default)
-- Schedule a new job from the UI
-- Dive in to see more details about the job, like the json data
-- Requeue a job (clone the data and run immediately)
-- Delete jobs (Useful for cleaning up old completed jobs)
-
-### Notes
-
- - Automatically creates additional indexes on several columns (See #24).
+- Job status auto-refreshes: 60-second polling by default.
+- Schedule a new job from the UI.
+- Dive in to see more details about the job, like the json data.
+- Requeue a job. Clone the data and run immediately.
+- Delete jobs. Useful for cleaning up old completed jobs.
+- Search jobs by name and metadata. Supports querying by Mongo Object Id.
+- Pagination
+- Responsive UI
 
 ---
 
 ### Screenshots
 
+#### Dashboard
+
 ![Auto-refresh list of jobs](all-jobs.png)
 
 ---
 
-![See job details, requeue or delete jobs](job-details.png)
+#### Create jobs
+
+![See job details, requeue or delete jobs](create-job.png)
 
 ---
 
-### Install
+#### Search by name, metadata, job status
 
-```
-npm install --save agendash
-```
+![Search for a job by name or metadata ](search.png)
 
-*Note*: `Agendash` requires mongodb version >2.6.0 to perform the needed aggregate queries. This is your mongo database version, not your node package version! To check your database version, connect to mongo and run `db.version()`.
+---
 
-### Standalone usage
+#### Responsive UI
 
-Agendash comes with a standalone Express app which you can use like this:
+![Mobile UI small devices](mobile-ui-sm.png)
 
-```bash
-./node_modules/.bin/agendash --db=mongodb://localhost/agendaDb --collection=agendaCollection --port=3001
-```
+![Mobile UI extra small devices](mobile-ui-xs.png)
 
-or like this, for default collection `agendaJobs` and default port `3000`:
+---
+
+# Troubleshooting
+
+### Index for sorting
+
+It may be required to create the following index for faster sorting (see [#24](https://github.com/agenda/agendash/issues/24))
 
-```bash
-./node_modules/.bin/agendash --db=mongodb://localhost/agendaDb
+```
+db.agendaJobs.ensureIndex({
+    "nextRunAt" : -1,
+    "lastRunAt" : -1,
+    "lastFinishedAt" : -1
+}, "agendash")
 ```
 
-If you are using npm >= 5.2, then you can use [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b):
+---
+
+# Roadmap
+
+- [ ] Get more test coverage
+- [ ] Add middlewares for fastify, and other express-like libraries
+- [ ] You decide! Submit a feature request
+
+### Install
 
-```bash
-npx agendash --db=mongodb://localhost/agendaDb --collection=agendaCollection --port=3001
 ```
+npm install --save agendash
+```
+
+_Note_: `Agendash` requires mongodb version >2.6.0 to perform the needed aggregate queries. This is your mongo database version, not your node package version! To check your database version, connect to mongo and run `db.version()`.
 
 ### Middleware usage
 
+#### Express
+
 Agendash provides Express middleware you can use at a specified path, for example this will
 make Agendash available on your site at the `/dash` path. Note: Do not try to mount Agendash
 at the root level like `app.use('/', Agendash(agenda))`.
 
 ```js
-var express = require('express');
+var express = require("express");
 var app = express();
 
 // ... your other express middleware like body-parser
 
-var Agenda = require('agenda');
-var Agendash = require('agendash');
+var Agenda = require("agenda");
+var Agendash = require("agendash");
 
-var agenda = new Agenda({db: {address: 'mongodb://127.0.0.1/agendaDb'}});
+var agenda = new Agenda({ db: { address: "mongodb://127.0.0.1/agendaDb" } });
 // or provide your own mongo client:
 // var agenda = new Agenda({mongo: myMongoClient})
 
-app.use('/dash', Agendash(agenda));
+app.use("/dash", Agendash(agenda));
 
 // ... your other routes
 
@@ -89,8 +107,9 @@ By mounting Agendash as middleware on a specific path, you may provide your
 own authentication for that path. For example if you have an authenticated
 session using passport, you can protect the dashboard path like this:
 
-```
-app.use('/dash',
+```js
+app.use(
+  "/dash",
   function (req, res, next) {
     if (!req.user || !req.user.is_admin) {
       res.send(401);
@@ -106,24 +125,129 @@ Other middlewares will come soon in the folder `/lib/middlewares/`.
 You'll just have to update the last line to require the middleware you need:
 
 ```js
-app.use('/agendash', Agendash(agenda, {
-  middleware: 'koa'
-}));
+app.use(
+  "/agendash",
+  Agendash(agenda, {
+    middleware: "connect",
+  })
+);
 ```
 
 Note that if you use a CSRF protection middleware like [`csurf`](https://www.npmjs.com/package/csurf), you might need to [configure it off](https://github.com/agenda/agendash/issues/23#issuecomment-270917949) for Agendash-routes.
 
-### Additional options
+#### Hapi
+
+A minimum Node.js version 12 is required for `@hapi/hapi` dependency.
+
+```shell
+npm i @hapi/inert @hapi/hapi
+```
+
+```js
+const agenda = new Agenda().database(
+  "mongodb://127.0.0.1/agendaDb",
+  "agendaJobs"
+);
+
+const server = require("@hapi/hapi").server({
+  port: 3002,
+  host: "localhost",
+});
+await server.register(require("@hapi/inert"));
+await server.register(
+  Agendash(agenda, {
+    middleware: "hapi",
+  })
+);
+
+await server.start();
+```
+
+Then browse to `http://localhost:3002/`.
+
+#### Koa
+
+```shell
+npm i koa koa-bodyparser koa-router koa-static
+```
+
+```js
+const agenda = new Agenda().database(
+  "mongodb://127.0.0.1/agendaDb",
+  "agendaJobs"
+);
+
+const Koa = require("koa");
+const app = new Koa();
+const middlewares = Agendash(agenda, {
+  middleware: "koa",
+});
+for (const middleware of middlewares) {
+  app.use(middleware);
+}
+
+await app.listen(3002);
+```
+
+Then browse to `http://localhost:3002/`.
+
+#### Fastify
+
+```shell
+npm i fastify
+```
+
+```js
+const agenda = new Agenda().database(
+  "mongodb://127.0.0.1/agendaDb",
+  "agendaJobs"
+);
+
+const Fastify = require("fastify");
+const fastify = new Fastify();
+
+fastify.register(
+  Agendash(
+    agenda, 
+    { middleware: "fastify" }
+  );
+);
+
+await fastify.listen(3002);
+```
+
+Then browse to `http://localhost:3002/`.
+
+### Standalone usage
+
+Agendash comes with a standalone Express app which you can use like this:
+
+```bash
+./node_modules/.bin/agendash --db=mongodb://localhost/agendaDb --collection=agendaCollection --port=3002
+```
+
+or like this, for default collection `agendaJobs` and default port `3000`:
 
-The second argument to Agendash is an optional object. Valid keys are:
+```bash
+./node_modules/.bin/agendash --db=mongodb://localhost/agendaDb
+```
 
-- `middleware`: Currently only `'express'` is supported. I'd like to use `'koa'` soon.
-- `title`: Defaults to `"Agendash"`. Useful if you are running multiple Agenda pools.
+If you are using npm >= 5.2, then you can use [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b):
 
-### Help appreciated
+```bash
+npx agendash --db=mongodb://localhost/agendaDb --collection=agendaCollection --port=3002
+```
 
-There are several things I would like help with:
+Then browse to `http://localhost:3002/`.
+
+### Docker usage
+
+Agendash can also be run within a Docker container like this:
+
+```bash
+docker run -p 3000:3000 \
+  --env MONGODB_URI=mongo://myUser:myPass@myHost/myDb \
+  --env COLLECTION=myAgendaCollection agenda/agendash
+```
 
--  [ ] I'm rusty with Backbone. Clean up the client code. I wasn't sure on the best way to trigger and handle update events.
--  [ ] Write some tests!
--  [ ] Use Agendash and submit issues!
+Then browse to `http://localhost:3000/`.

package/app.js

@@ -1,18 +1,23 @@
-'use strict';
-const path = require('path');
+"use strict";
+const path = require("path");
 
 module.exports = (agenda, options) => {
   options = options || {};
   if (!options.middleware) {
-    options.middleware = 'express';
+    options.middleware = "express";
   }
 
-  const agendash = require('./lib/agendash')(agenda, options);
+  const agendash = require("./lib/controllers/agendash")(agenda, options);
+  const middlewarePath = path.join(
+    __dirname,
+    "./lib/middlewares",
+    options.middleware
+  );
 
   try {
-    const middlewarePath = path.join(__dirname, 'lib/middlewares', options.middleware);
     return require(middlewarePath)(agendash);
-  } catch (err) {
-    throw new Error('No middleware available for ' + options.middleware);
+  } catch (error) {
+    console.error(error);
+    throw new Error(`Middleware load failed with ${JSON.stringify(options)}`);
   }
 };

package/bin/agendash-standalone-fastify.js

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+"use strict";
+const Agenda = require("agenda");
+const agendash = require("../app");
+const Fastify = require("fastify");
+const program = require("commander");
+
+program
+  .option(
+    "-d, --db <db>",
+    "[required] Mongo connection string, same as Agenda connection string"
+  )
+  .option(
+    "-c, --collection <collection>",
+    "[optional] Mongo collection, same as Agenda collection name, default agendaJobs",
+    "agendaJobs"
+  )
+  .option(
+    "-p, --port <port>",
+    "[optional] Server port, default 3000",
+    (n, d) => Number(n) || d,
+    3000
+  )
+  .option(
+    "-t, --title <title>",
+    "[optional] Page title, default Agendash",
+    "Agendash"
+  )
+  .option(
+    "-p, --path <path>",
+    "[optional] Path to bind Agendash to, default /",
+    "/"
+  )
+  .parse(process.argv);
+
+if (!program.db) {
+  console.error("--db required");
+  process.exit(1);
+}
+
+if (!program.path.startsWith("/")) {
+  console.error("--path must begin with /");
+  process.exit(1);
+}
+
+const fastify = Fastify();
+
+const agenda = new Agenda().database(program.db, program.collection);
+
+fastify.register(
+  agendash(agenda, {
+    middleware: "fastify",
+    title: program.title,
+  })
+);
+
+fastify.listen(program.port, function () {
+  console.log(
+    `Agendash started http://localhost:${program.port}${program.path}`
+  );
+});

package/bin/agendash-standalone-hapi.js

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+"use strict";
+const { Agenda } = require("agenda");
+const agendash = require("../app");
+const Hapi = require("@hapi/hapi");
+const program = require("commander");
+
+program
+  .option(
+    "-d, --db <db>",
+    "[required] Mongo connection string, same as Agenda connection string"
+  )
+  .option(
+    "-c, --collection <collection>",
+    "[optional] Mongo collection, same as Agenda collection name, default agendaJobs",
+    "agendaJobs"
+  )
+  .option(
+    "-p, --port <port>",
+    "[optional] Server port, default 3000",
+    (n, d) => Number(n) || d,
+    3000
+  )
+  .option(
+    "-t, --title <title>",
+    "[optional] Page title, default Agendash",
+    "Agendash"
+  )
+  .parse(process.argv);
+
+if (!program.db) {
+  console.error("--db required");
+  process.exit(1);
+}
+
+const init = async () => {
+  const server = Hapi.server({
+    port: 3002,
+    host: "localhost",
+  });
+
+  const agenda = new Agenda().database(program.db, program.collection);
+
+  await server.register(require("@hapi/inert"));
+  await server.register(
+    agendash(agenda, {
+      middleware: "hapi",
+    })
+  );
+
+  await server.start();
+  console.log("Server running on %s", server.info.uri);
+};
+
+process.on("unhandledRejection", (error) => {
+  console.log(error);
+  process.exit(1);
+});
+
+init();