agendash v2

AVISO! Este projeto foi incorporado ao Agendash principal. Este repositório git está obsoleto agora.

Agenda 2

Um painel moderno, seguro e confiável para Agenda com recursos de pesquisa e paginação escritos em vue.js

---

Características

• Substituindo o antigo agendash, basta alterar seu require(agendash) para require(agendash2)
• Atualizações automáticas do status do trabalho (pesquisa de 60 segundos por padrão)
• Agende um novo trabalho na IU
• Mergulhe para ver mais detalhes sobre o trabalho, como os dados json
• Reenfileirar um trabalho (clonar os dados e executar imediatamente)
• Excluir trabalhos (útil para limpar trabalhos antigos concluídos)
• Pesquise empregos por nome e metadados (suporta consulta ao ID do objeto mongo)
• Paginação (a versão original tinha limitação de apenas 200 resultados)
• UI responsiva

---

Capturas de tela

Painel

---

Criar empregos

---

Pesquise por nome, metadados, status do trabalho

---

UI responsiva

---

Requisitos

Uma versão mínima 12 do Node.js é necessária para a dependência @hapi/@hapi (consulte #23)

Solução de problemas

Índice para classificação

Pode ser necessário criar o seguinte índice para uma classificação mais rápida (ver #24)

 db.agendaJobs.ensureIndex({
    "nextRunAt" : -1,
    "lastRunAt" : -1,
    "lastFinishedAt" : -1
}, "agendash2")

---

Motivação

Na Software On The Road usamos agenda e agendash para quase todos os projetos desde 2017, mas sempre teve suas limitações. E devido a um problema crítico de segurança que encontramos no middleware do servidor, decidimos fazer um fork do agendash e reescrevê-lo do zero. No início, tentamos apenas corrigir o código existente, mas ele foi escrito em backbone.js, então seria mais difícil aprendê-lo do que apenas usar vue.js para recriar os recursos existentes. Afinal, este é apenas um CRUD simples com paginação e pesquisa, nada sofisticado.

Roteiro

• Melhore a segurança padrão
• Compatibilidade com agenda v3
• Backend polonês para que seja mais eficiente (consultas de agregação MongoDB foram reescritas e otimizadas)
• UI móvel/responsiva
• Obtenha mais cobertura de teste
• Adicione middlewares para KOA, fastify e outras bibliotecas do tipo express
• Você decide! Envie uma solicitação de recurso

Instalar

 npm install --save agendash2

Nota : Agendash requer a versão mongodb >2.6.0 para realizar as consultas agregadas necessárias. Esta é a versão do seu banco de dados mongo, não a versão do pacote do nó! Para verificar a versão do seu banco de dados, conecte-se ao mongo e execute db.version() .

Uso de middleware

Agendash2 fornece middleware Express que você pode usar em um caminho especificado, por exemplo, isso tornará o Agendash2 disponível em seu site no caminho /dash . Nota: Não tente montar o Agendash2 no nível raiz como app.use('/', Agendash(agenda)) .

 var express = require ( 'express' ) ;
var app = express ( ) ;

// ... your other express middleware like body-parser

var Agenda = require ( 'agenda' ) ;
var Agendash = require ( 'agendash2' ) ;

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 ) ) ;

// ... your other routes

// ... start your server

Ao montar o Agendash2 como middleware em um caminho específico, você pode fornecer sua própria autenticação para esse caminho. Por exemplo, se você tiver uma sessão autenticada usando passaporte, poderá proteger o caminho do painel assim:

 app . use ( '/dash' ,
  function ( req , res , next ) {
    if ( ! req . user || ! req . user . is_admin ) {
      res . send ( 401 ) ;
    } else {
      next ( ) ;
    }
  } ,
  Agendash ( agenda )
) ;

Outros middlewares virão em breve na pasta /lib/middlewares/ . Você apenas terá que atualizar a última linha para exigir o middleware necessário:

 app . use ( '/agendash' , Agendash ( agenda , {
  middleware : 'koa'
} ) ) ;

Observe que se você usar um middleware de proteção CSRF como csurf , pode ser necessário desativá-lo para rotas Agendash.

Uso autônomo

Agendash vem com um aplicativo Express independente que você pode usar assim:

./node_modules/.bin/agendash2 --db=mongodb://localhost/agendaDb --collection=agendaCollection --port=3001

ou assim, para agendaJobs de coleta padrão e porta padrão 3000 :

./node_modules/.bin/agendash2 --db=mongodb://localhost/agendaDb

Se você estiver usando npm >= 5.2, poderá usar npx:

npx agendash2 --db=mongodb://localhost/agendaDb --collection=agendaCollection --port=3001