agendash 2.1.1 → 3.0.0

package/History.md

@@ -1,3 +1,13 @@
+# 3.0.0
+
+- 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
+
+This file won't mention contributors anymore. Because all contributors are listed on the [main page](https://github.com/agenda/agendash) now. Thanks, GitHub!
+
 # 2.1.0 - JSON validation when creating jobs
 
 - feat: Add json validator message when createJob #169 (thanks @love8587)

package/README.md

@@ -191,6 +191,33 @@ 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:

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

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 "use strict";
-const Agenda = require("agenda");
+const { Agenda } = require("agenda");
 const agendash = require("../app");
 const Hapi = require("@hapi/hapi");
 const program = require("commander");

package/bin/agendash-standalone-koa.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 "use strict";
-const Agenda = require("agenda");
+const { Agenda } = require("agenda");
 const agendash = require("../app");
 const Koa = require("koa");
 const program = require("commander");

package/bin/agendash-standalone.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 "use strict";
 const http = require("http");
-const Agenda = require("agenda");
+const { Agenda } = require("agenda");
 const agendash = require("../app");
 const express = require("express");
 const program = require("commander");

package/lib/controllers/agendash.js

@@ -1,6 +1,6 @@
 "use strict";
 const semver = require("semver");
-const { ObjectID } = require("mongodb"); // We rely on the Agenda's "mongodb", thus our package.json lists "*" as required version
+const { ObjectId } = require("mongodb"); // We rely on the Agenda's "mongodb", thus our package.json lists "*" as required version
 
 module.exports = function (agenda, options) {
   options = options || {};
@@ -27,7 +27,7 @@ module.exports = function (agenda, options) {
         throw error;
       }
 
-      if (!semver.satisfies(serverInfo.version, ">=2.6.0")) {
+      if (!semver.satisfies(semver.coerce(serverInfo.version), ">=3.6.0")) {
         throw new Error("MongoDB version not supported");
       }
     });
@@ -42,9 +42,7 @@ module.exports = function (agenda, options) {
 
     if (options.query && options.property) {
       if (options.isObjectId) {
-        preMatch[options.property] = ObjectID.createFromHexString(
-          options.query
-        );
+        preMatch[options.property] = ObjectId(options.query);
       } else if (/^\d+$/.test(options.query)) {
         preMatch[options.property] = Number.parseInt(options.query, 10);
       } else {
@@ -286,7 +284,7 @@ module.exports = function (agenda, options) {
     const collection = agenda._collection.collection || agenda._collection;
     const jobs = await collection
       .find({
-        _id: { $in: jobIds.map((jobId) => collection.s.pkFactory(jobId)) },
+        _id: { $in: jobIds.map((jobId) => ObjectId(jobId)) },
       })
       .toArray();
     if (jobs.length === 0) {
@@ -307,9 +305,8 @@ module.exports = function (agenda, options) {
       return Promise.reject(new Error("Agenda instance is not ready"));
     }
 
-    const collection = agenda._collection.collection || agenda._collection;
     return agenda.cancel({
-      _id: { $in: jobIds.map((jobId) => collection.s.pkFactory(jobId)) },
+      _id: { $in: jobIds.map((jobId) => ObjectId(jobId)) },
     });
   };
 

package/lib/middlewares/README.md

@@ -18,7 +18,7 @@ Then use it as follows:
 'use strict';
 
 const Hapi = require('hapi');
-const Agenda = require('agenda');
+const { Agenda } = require('agenda');
 const Agendash = require('agendash');
 
 var agenda = new Agenda({

package/lib/middlewares/fastify.js

@@ -0,0 +1,75 @@
+const path = require("path");
+
+module.exports = (agendash) => (instance, opts, done) => {
+  const { api, requeueJobs, deleteJobs, createJob } = agendash;
+
+  instance.register(require("fastify-static"), {
+    root: path.join(__dirname, "../../public"),
+  });
+
+  instance.get("/", function (req, reply) {
+    return reply.sendFile("index.html");
+  });
+
+  instance.get("/api", async (request, response) => {
+    try {
+      const {
+        job,
+        state,
+        skip,
+        limit,
+        q,
+        property,
+        isObjectId,
+      } = request.query;
+      const apiResponse = await api(job, state, {
+        query: q,
+        property,
+        isObjectId,
+        skip,
+        limit,
+      });
+      response.send(apiResponse);
+    } catch (error) {
+      response.status(400).send(error);
+    }
+  });
+
+  instance.post("/api/jobs/requeue", async (request, response) => {
+    try {
+      const newJobs = await requeueJobs(request.body.jobIds);
+      response.send(newJobs);
+    } catch (error) {
+      response.status(404).send(error);
+    }
+  });
+
+  instance.post("/api/jobs/delete", async (request, response) => {
+    try {
+      const deleted = await deleteJobs(request.body.jobIds);
+      if (deleted) {
+        response.send({ deleted: true });
+      } else {
+        response.send({ message: "Jobs not deleted" });
+      }
+    } catch (error) {
+      response.status(404).send(error);
+    }
+  });
+
+  instance.post("/api/jobs/create", async (request, response) => {
+    try {
+      await createJob(
+        request.body.jobName,
+        request.body.jobSchedule,
+        request.body.jobRepeatEvery,
+        request.body.jobData
+      );
+      response.send({ created: true });
+    } catch (error) {
+      response.status(400).send(error);
+    }
+  });
+
+  done();
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agendash",
-  "version": "2.1.1",
+  "version": "3.0.0",
   "description": "A modern dashboard for Agenda.js with Pagination and Search capabilities",
   "main": "app.js",
   "bin": "bin/agendash-standalone.js",
@@ -37,7 +37,7 @@
     "entrypoint.sh"
   ],
   "dependencies": {
-    "agenda": "^3.1.0 || ^4.0.0",
+    "agenda": "^4.2.1",
     "body-parser": "^1.15.0",
     "commander": "^2.9.0",
     "express": "^4.0.0",
@@ -45,17 +45,19 @@
     "semver": "^7.3.4"
   },
   "devDependencies": {
-    "@hapi/hapi": "19.2.0",
-    "@hapi/inert": "6.0.3",
+    "@hapi/hapi": "^20.2.1",
+    "@hapi/inert": "^6.0.5",
     "ava": "3.15.0",
     "eslint": "7.19.0",
+    "fastify": "^3.24.0",
+    "fastify-static": "^4.5.0",
     "koa": "2.13.1",
     "koa-bodyparser": "4.3.0",
     "koa-router": "10.0.0",
     "koa-static": "5.0.0",
     "npm-run-all": "4.1.5",
     "prettier": "2.2.1",
-    "supertest": "6.1.3"
+    "supertest": "^6.2.2"
   },
   "eslintConfig": {
     "parserOptions": {

package/public/app/js/jobdetail.js

@@ -24,7 +24,7 @@ const jobDetail = Vue.component("job-detail", {
         <div class="modal-body">
         <div class="row my-3">
           <div class="col">
-            <p><strong>Next run starts: </strong>{{ formatDate(job.job.lastRunAt) }}</p>
+            <p><strong>Next run starts: </strong>{{ formatDate(job.job.nextRunAt) }}</p>
             <p><strong>Last run started: </strong>{{ formatDate(job.job.lastRunAt) }}</p>
           </div>
         </div>

package/public/app/js/joblist.js

@@ -53,9 +53,13 @@ const jobList = Vue.component("job-list", {
     cleanMulti() {
       return console.log("received Clean Multi");
     },
+    formatTitle(date) {
+      if (!date) return;
+      return moment(date).format();
+    },
     formatDate(date) {
+      if (!date) return;
       return moment(date).fromNow();
-      // return new Date(date).toLocaleDateString('en-US', { day: 'numeric', month: 'numeric', year: '2-digit', hour: "numeric", minute: "numeric", second: "numeric" })
     },
     checkAllCheckboxes() {
       const checkboxes = document.querySelectorAll(".checkbox-triggerable");
@@ -139,10 +143,10 @@ const jobList = Vue.component("job-list", {
                     <i v-if="job.running" class="pill-own bg-warning pill-withoutIcon"><span>Running</span></i>
                   </td>
                   <td class="job-name"  @click="toggleList(job)"> {{job.job.name}} </td>
-                  <td class="job-lastRunAt"  @click="toggleList(job)"> {{ formatDate(job.job.lastRunAt) }} </td>
-                  <td class="job-nextRunAt"  @click="toggleList(job)"> {{ formatDate(job.job.nextRunAt) }} </td>
-                  <td class="job-finishedAt"  @click="toggleList(job)"> {{ formatDate(job.job.lastFinishedAt) }} </td>
-                  <td class="job-lockedAt"  @click="toggleList(job)"> {{ formatDate(job.job.lockedAt) }} </td>
+                  <td class="job-lastRunAt" :title="formatTitle(job.job.lastRunAt)" @click="toggleList(job)"> {{ formatDate(job.job.lastRunAt) }} </td>
+                  <td class="job-nextRunAt" :title="formatTitle(job.job.nextRunAt)" @click="toggleList(job)"> {{ formatDate(job.job.nextRunAt) }} </td>
+                  <td class="job-finishedAt" :title="formatTitle(job.job.lastFinishedAt)" @click="toggleList(job)"> {{ formatDate(job.job.lastFinishedAt) }} </td>
+                  <td class="job-lockedAt" :title="formatTitle(job.job.lockedAt)" @click="toggleList(job)"> {{ formatDate(job.job.lockedAt) }} </td>
                   <td class="job-actions">
                     <i class="material-icons md-dark md-custom action-btn viewData text-primary" data-toggle="modal" data-target="#modalRequeueSure" @click="$emit('confirm-requeue', job)" data-placement="left" title="Requeue">update</i>
                     <i class="material-icons md-dark md-custom action-btn viewData text-success" data-toggle="modal" data-target="#modalData" @click="$emit('show-job-detail', job)" data-placement="top" title="Job Data">visibility</i>
@@ -184,13 +188,13 @@ const jobList = Vue.component("job-list", {
                       <div class="card-responsive-status-title">
                         Last run started
                       </div>
-                      <div class="mb-3">
+                      <div class="mb-3" :title="formatTitle(job.job.lastRunAt)">
                         {{ formatDate(job.job.lastRunAt) }}
                       </div>
                       <div class="card-responsive-status-title">
                         Last finished
                       </div>
-                      <div>
+                      <div :title="formatTitle(job.job.lastFinishedAt)">
                         {{ formatDate(job.job.lastFinishedAt) }}
                       </div>
                     </div>
@@ -198,14 +202,14 @@ const jobList = Vue.component("job-list", {
                       <div class="card-responsive-status-title">
                         Next run starts
                       </div>
-                      <div class="mb-3">
+                      <div class="mb-3" :title="formatTitle(job.job.nextRunAt)">
                         {{ formatDate(job.job.nextRunAt) }}
                       </div>
                       <div class="card-responsive-status-title">
                         Locked
                       </div>
-                      <div>
-                        {{ job.job.lockedAt ? formatDate(job.job.lockedAt) : "-" }}
+                      <div :title="formatTitle(job.job.lockedAt)">
+                        {{ formatDate(job.job.lockedAt) || "-" }}
                       </div>
                     </div>
                   </div>