From 32fe00138990627749da58ff9f845584013aa219 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Thu, 18 Jul 2019 16:43:41 +0200 Subject: Provide logger to plugins --- server/lib/plugins/plugin-manager.ts | 90 ++++++++++++++---------- server/typings/plugins/index.d.ts | 2 + server/typings/plugins/plugin-library.model.ts | 7 ++ server/typings/plugins/register-options.model.ts | 19 +++++ shared/models/plugins/plugin-library.model.ts | 7 -- shared/models/plugins/register-options.model.ts | 14 ---- 6 files changed, 79 insertions(+), 60 deletions(-) create mode 100644 server/typings/plugins/index.d.ts create mode 100644 server/typings/plugins/plugin-library.model.ts create mode 100644 server/typings/plugins/register-options.model.ts delete mode 100644 shared/models/plugins/plugin-library.model.ts delete mode 100644 shared/models/plugins/register-options.model.ts diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts index e76dbb53e..ac31b06dc 100644 --- a/server/lib/plugins/plugin-manager.ts +++ b/server/lib/plugins/plugin-manager.ts @@ -4,7 +4,6 @@ import { basename, join } from 'path' import { CONFIG } from '../../initializers/config' import { isLibraryCodeValid, isPackageJSONValid } from '../../helpers/custom-validators/plugins' import { ClientScript, PluginPackageJson } from '../../../shared/models/plugins/plugin-package-json.model' -import { PluginLibrary } from '../../../shared/models/plugins/plugin-library.model' import { createReadStream, createWriteStream } from 'fs' import { PLUGIN_GLOBAL_CSS_PATH } from '../../initializers/constants' import { PluginType } from '../../../shared/models/plugins/plugin.type' @@ -14,10 +13,10 @@ import { RegisterSettingOptions } from '../../../shared/models/plugins/register- import { RegisterHookOptions } from '../../../shared/models/plugins/register-hook.model' import { PluginSettingsManager } from '../../../shared/models/plugins/plugin-settings-manager.model' import { PluginStorageManager } from '../../../shared/models/plugins/plugin-storage-manager.model' -import { ServerHookName, ServerHook } from '../../../shared/models/plugins/server-hook.model' -import { isCatchable, isPromise } from '../../../shared/core-utils/miscs/miscs' +import { ServerHook, ServerHookName } from '../../../shared/models/plugins/server-hook.model' import { getHookType, internalRunHook } from '../../../shared/core-utils/plugins/hooks' -import { HookType } from '../../../shared/models/plugins/hook-type.enum' +import { RegisterOptions } from '../../typings/plugins/register-options.model' +import { PluginLibrary } from '../../typings/plugins' export interface RegisteredPlugin { npmName: string @@ -287,47 +286,15 @@ export class PluginManager implements ServerHook { private async registerPlugin (plugin: PluginModel, pluginPath: string, packageJSON: PluginPackageJson) { const npmName = PluginModel.buildNpmName(plugin.name, plugin.type) - const registerHook = (options: RegisterHookOptions) => { - if (!this.hooks[options.target]) this.hooks[options.target] = [] - - this.hooks[options.target].push({ - npmName, - pluginName: plugin.name, - handler: options.handler, - priority: options.priority || 0 - }) - } - - const registerSetting = (options: RegisterSettingOptions) => { - if (!this.settings[npmName]) this.settings[npmName] = [] - - this.settings[npmName].push(options) - } - - const settingsManager: PluginSettingsManager = { - getSetting: (name: string) => PluginModel.getSetting(plugin.name, plugin.type, name), - - setSetting: (name: string, value: string) => PluginModel.setSetting(plugin.name, plugin.type, name, value) - } - - const storageManager: PluginStorageManager = { - getData: (key: string) => PluginModel.getData(plugin.name, plugin.type, key), - - storeData: (key: string, data: any) => PluginModel.storeData(plugin.name, plugin.type, key, data) - } - const library: PluginLibrary = require(join(pluginPath, packageJSON.library)) if (!isLibraryCodeValid(library)) { throw new Error('Library code is not valid (miss register or unregister function)') } - library.register({ - registerHook, - registerSetting, - settingsManager, - storageManager - }).catch(err => logger.error('Cannot register plugin %s.', npmName, { err })) + const registerHelpers = this.getRegisterHelpers(npmName, plugin) + library.register(registerHelpers) + .catch(err => logger.error('Cannot register plugin %s.', npmName, { err })) logger.info('Add plugin %s CSS to global file.', npmName) @@ -407,6 +374,51 @@ export class PluginManager implements ServerHook { return plugins } + // ###################### Generate register helpers ###################### + + private getRegisterHelpers (npmName: string, plugin: PluginModel): RegisterOptions { + const registerHook = (options: RegisterHookOptions) => { + if (!this.hooks[options.target]) this.hooks[options.target] = [] + + this.hooks[options.target].push({ + npmName, + pluginName: plugin.name, + handler: options.handler, + priority: options.priority || 0 + }) + } + + const registerSetting = (options: RegisterSettingOptions) => { + if (!this.settings[npmName]) this.settings[npmName] = [] + + this.settings[npmName].push(options) + } + + const settingsManager: PluginSettingsManager = { + getSetting: (name: string) => PluginModel.getSetting(plugin.name, plugin.type, name), + + setSetting: (name: string, value: string) => PluginModel.setSetting(plugin.name, plugin.type, name, value) + } + + const storageManager: PluginStorageManager = { + getData: (key: string) => PluginModel.getData(plugin.name, plugin.type, key), + + storeData: (key: string, data: any) => PluginModel.storeData(plugin.name, plugin.type, key, data) + } + + const peertubeHelpers = { + logger + } + + return { + registerHook, + registerSetting, + settingsManager, + storageManager, + peertubeHelpers + } + } + static get Instance () { return this.instance || (this.instance = new this()) } diff --git a/server/typings/plugins/index.d.ts b/server/typings/plugins/index.d.ts new file mode 100644 index 000000000..bddb3089e --- /dev/null +++ b/server/typings/plugins/index.d.ts @@ -0,0 +1,2 @@ +export * from './register-options.model' +export * from './plugin-library.model' diff --git a/server/typings/plugins/plugin-library.model.ts b/server/typings/plugins/plugin-library.model.ts new file mode 100644 index 000000000..fd90a3b46 --- /dev/null +++ b/server/typings/plugins/plugin-library.model.ts @@ -0,0 +1,7 @@ +import { RegisterOptions } from './register-options.model' + +export interface PluginLibrary { + register: (options: RegisterOptions) => Promise + + unregister: () => Promise +} diff --git a/server/typings/plugins/register-options.model.ts b/server/typings/plugins/register-options.model.ts new file mode 100644 index 000000000..007ef5e1b --- /dev/null +++ b/server/typings/plugins/register-options.model.ts @@ -0,0 +1,19 @@ +import { logger } from '../../helpers/logger' +import { RegisterHookOptions } from '../../../shared/models/plugins/register-hook.model' +import { RegisterSettingOptions } from '../../../shared/models/plugins/register-setting.model' +import { PluginSettingsManager } from '../../../shared/models/plugins/plugin-settings-manager.model' +import { PluginStorageManager } from '../../../shared/models/plugins/plugin-storage-manager.model' + +export type RegisterOptions = { + registerHook: (options: RegisterHookOptions) => void + + registerSetting: (options: RegisterSettingOptions) => void + + settingsManager: PluginSettingsManager + + storageManager: PluginStorageManager + + peertubeHelpers: { + logger: typeof logger + } +} diff --git a/shared/models/plugins/plugin-library.model.ts b/shared/models/plugins/plugin-library.model.ts deleted file mode 100644 index fd90a3b46..000000000 --- a/shared/models/plugins/plugin-library.model.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { RegisterOptions } from './register-options.model' - -export interface PluginLibrary { - register: (options: RegisterOptions) => Promise - - unregister: () => Promise -} diff --git a/shared/models/plugins/register-options.model.ts b/shared/models/plugins/register-options.model.ts deleted file mode 100644 index e3a7cff08..000000000 --- a/shared/models/plugins/register-options.model.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { RegisterHookOptions } from './register-hook.model' -import { RegisterSettingOptions } from './register-setting.model' -import { PluginSettingsManager } from './plugin-settings-manager.model' -import { PluginStorageManager } from './plugin-storage-manager.model' - -export type RegisterOptions = { - registerHook: (options: RegisterHookOptions) => void - - registerSetting: (options: RegisterSettingOptions) => void - - settingsManager: PluginSettingsManager - - storageManager: PluginStorageManager -} -- cgit v1.2.3