server/lib/schedulers/plugins-check-scheduler.ts

   1 import { logger } from '../../helpers/logger'
   2 import { AbstractScheduler } from './abstract-scheduler'
   3 import { SCHEDULER_INTERVALS_MS } from '../../initializers/constants'
   4 import { CONFIG } from '../../initializers/config'
   5 import { PluginModel } from '../../models/server/plugin'
   6 import { chunk } from 'lodash'
   7 import { getLatestPluginsVersion } from '../plugins/plugin-index'
   8 import { compareSemVer } from '../../../shared/core-utils/miscs/miscs'
   9 import { Notifier } from '../notifier'
  10
  11 export class PluginsCheckScheduler extends AbstractScheduler {
  12
  13   private static instance: AbstractScheduler
  14
  15   protected schedulerIntervalMs = SCHEDULER_INTERVALS_MS.checkPlugins
  16
  17   private constructor () {
  18     super()
  19   }
  20
  21   protected async internalExecute () {
  22     return this.checkLatestPluginsVersion()
  23   }
  24
  25   private async checkLatestPluginsVersion () {
  26     if (CONFIG.PLUGINS.INDEX.ENABLED === false) return
  27
  28     logger.info('Checking latest plugins version.')
  29
  30     const plugins = await PluginModel.listInstalled()
  31
  32     // Process 10 plugins in 1 HTTP request
  33     const chunks = chunk(plugins, 10)
  34     for (const chunk of chunks) {
  35       // Find plugins according to their npm name
  36       const pluginIndex: { [npmName: string]: PluginModel} = {}
  37       for (const plugin of chunk) {
  38         pluginIndex[PluginModel.buildNpmName(plugin.name, plugin.type)] = plugin
  39       }
  40
  41       const npmNames = Object.keys(pluginIndex)
  42
  43       try {
  44         const results = await getLatestPluginsVersion(npmNames)
  45
  46         for (const result of results) {
  47           const plugin = pluginIndex[result.npmName]
  48           if (!result.latestVersion) continue
  49
  50           if (
  51             !plugin.latestVersion ||
  52             (plugin.latestVersion !== result.latestVersion && compareSemVer(plugin.latestVersion, result.latestVersion) < 0)
  53           ) {
  54             plugin.latestVersion = result.latestVersion
  55             await plugin.save()
  56
  57             // Notify if there is an higher plugin version available
  58             if (compareSemVer(plugin.version, result.latestVersion) < 0) {
  59               Notifier.Instance.notifyOfNewPluginVersion(plugin)
  60             }
  61
  62             logger.info('Plugin %s has a new latest version %s.', result.npmName, plugin.latestVersion)
  63           }
  64         }
  65       } catch (err) {
  66         logger.error('Cannot get latest plugins version.', { npmNames, err })
  67       }
  68     }
  69   }
  70
  71   static get Instance () {
  72     return this.instance || (this.instance = new this())
  73   }
  74 }