agendash v2

警告！このプロジェクトはメインの Agendash に統合されました。この git リポジトリは現在非推奨です。

アジェンダダッシュ 2

vue.js で記述された検索機能とページネーション機能を備えた、Agenda 用の最新で安全かつ信頼性の高いダッシュボード

---

特徴

• 古い agendash のドロップイン置換は、 require(agendash)をrequire(agendash2)に変更するだけです。
• ジョブステータスの自動更新 (デフォルトでは 60 秒のポーリング)
• UI から新しいジョブをスケジュールする
• json データなど、ジョブの詳細を確認します。
• ジョブを再度キューに入れる (データのクローンを作成してすぐに実行する)
• ジョブの削除 (完了した古いジョブをクリーンアップするのに役立ちます)
• 名前とメタデータによるジョブの検索 (mongo オブジェクト ID のクエリのサポート)
• ページネーション (元のバージョンでは結果が 200 件のみに制限されていました)
• レスポンシブUI

---

スクリーンショット

ダッシュボード

---

ジョブの作成

---

名前、メタデータ、ジョブステータスで検索

---

レスポンシブUI

---

要件

@hapi/@hapi依存関係には少なくとも Node.js バージョン 12 が必要です (#23 を参照)

トラブルシューティング

並べ替え用のインデックス

ソートを高速化するには、次のインデックスの作成が必要になる場合があります (#24 を参照)。

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

---

モチベーション

Software On The Road では、2017 年以来、ほぼすべてのプロジェクトでアジェンダとアジェンダダッシュを使用してきましたが、常に限界がありました。そして、サーバー ミドルウェアで重大なセキュリティ問題が見つかったため、Agendash をフォークして最初から書き直すことにしました。最初は既存のコードにパッチを適用しようとしましたが、backbone.js で記述されていたため、vue.js を使用して既存の機能を再作成するだけの方が学習に労力がかかります。結局のところ、これはページネーションと検索を備えた単純な CRUD であり、特別なことは何もありません。

ロードマップ

• デフォルトのセキュリティを改善する
• アジェンダ v3 との互換性
• バックエンドを研磨して効率を高めました (MongoDB 集計クエリが書き直され、最適化されました)
• モバイル/レスポンシブ UI
• より多くのテスト範囲を取得する
• KOA、fastify、その他の Express のようなライブラリ用のミドルウェアを追加する
• あなたが決めてください！機能リクエストを送信する

インストール

 npm install --save agendash2

注: Agendash必要な集計クエリを実行するには、mongodb バージョン > 2.6.0 が必要です。これは、node パッケージのバージョンではなく、mongo データベースのバージョンです。データベースのバージョンを確認するには、mongo に接続し、 db.version()を実行します。

ミドルウェアの使用状況

Agendash2 は、指定したパスで使用できる Express ミドルウェアを提供します。たとえば、これにより、Agendash2 がサイトの/dashパスで利用できるようになります。注: app.use('/', Agendash(agenda))のように Agendash2 をルート レベルでマウントしようとしないでください。

 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

Agendash2 をミドルウェアとして特定のパスにマウントすることで、そのパスに独自の認証を提供できます。たとえば、パスポートを使用して認証されたセッションがある場合は、次のようにダッシュボード パスを保護できます。

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

他のミドルウェアは/lib/middlewares/フォルダーに間もなく追加される予定です。必要なミドルウェアを要求するには、最後の行を更新するだけです。

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

csurfなどの CSRF 保護ミドルウェアを使用する場合は、Agendash ルートに対してそれをオフに構成する必要がある場合があることに注意してください。

スタンドアロンでの使用

Agendash にはスタンドアロンの Express アプリが付属しており、次のように使用できます。

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

または、デフォルトのコレクションagendaJobsとデフォルトのポート3000の場合は次のようになります。

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

npm >= 5.2 を使用している場合は、npx を使用できます。

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