Add plugin settings change watcher

diff --git a/server/controllers/api/config.ts b/server/controllers/api/config.ts
index 85f3ad3d942d114c04aaab5c7790f3e5385e7167..edcb0b99ec17f2bce7850ec52deff92303a70189 100644 (file)
--- a/server/controllers/api/config.ts
+++ b/server/controllers/api/config.ts
@@ -299,7 +299,7 @@ function getExternalAuthsPlugins () {
         name: p.name,
         version: p.version,
         authName: auth.authName,
-        authDisplayName: auth.authDisplayName
+        authDisplayName: auth.authDisplayName()
       })
     }
   }

diff --git a/server/controllers/api/plugins.ts b/server/controllers/api/plugins.ts
index 6b7562fd3162439b5a15d122d84fb43bcf85120b..f8a0d19ca519d550591709b5aa905b99db150d71 100644 (file)
--- a/server/controllers/api/plugins.ts
+++ b/server/controllers/api/plugins.ts
@@ -191,6 +191,8 @@ async function updatePluginSettings (req: express.Request, res: express.Response
   plugin.settings = req.body.settings
   await plugin.save()
 
+  await PluginManager.Instance.onSettingsChanged(plugin.name, plugin.settings)
+
   return res.sendStatus(204)
 }
 

diff --git a/server/lib/plugins/plugin-manager.ts b/server/lib/plugins/plugin-manager.ts
index f7b84b1ff1b7013d5e89651e5107bc69ba8f059d..950acf7ad75a3cca34c120cecfd5a0369caf0dcd 100644 (file)
--- a/server/lib/plugins/plugin-manager.ts
+++ b/server/lib/plugins/plugin-manager.ts
@@ -144,20 +144,6 @@ export class PluginManager implements ServerHook {
     return this.translations[locale] || {}
   }
 
-  onLogout (npmName: string, authName: string, user: MUser) {
-    const auth = this.getAuth(npmName, authName)
-
-    if (auth?.onLogout) {
-      logger.info('Running onLogout function from auth %s of plugin %s', authName, npmName)
-
-      try {
-        auth.onLogout(user)
-      } catch (err) {
-        logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
-      }
-    }
-  }
-
   async isTokenValid (token: MOAuthTokenUser, type: 'access' | 'refresh') {
     const auth = this.getAuth(token.User.pluginAuth, token.authName)
     if (!auth) return true
@@ -180,6 +166,37 @@ export class PluginManager implements ServerHook {
     return true
   }
 
+  // ###################### External events ######################
+
+  onLogout (npmName: string, authName: string, user: MUser) {
+    const auth = this.getAuth(npmName, authName)
+
+    if (auth?.onLogout) {
+      logger.info('Running onLogout function from auth %s of plugin %s', authName, npmName)
+
+      try {
+        auth.onLogout(user)
+      } catch (err) {
+        logger.warn('Cannot run onLogout function from auth %s of plugin %s.', authName, npmName, { err })
+      }
+    }
+  }
+
+  onSettingsChanged (name: string, settings: any) {
+    const registered = this.getRegisteredPluginByShortName(name)
+    if (!registered) {
+      logger.error('Cannot find plugin %s to call on settings changed.', name)
+    }
+
+    for (const cb of registered.registerHelpersStore.getOnSettingsChangedCallbacks()) {
+      try {
+        cb(settings)
+      } catch (err) {
+        logger.error('Cannot run on settings changed callback for %s.', registered.npmName, { err })
+      }
+    }
+  }
+
   // ###################### Hooks ######################
 
   async runHook<T> (hookName: ServerHookName, result?: T, params?: any): Promise<T> {

diff --git a/server/lib/plugins/register-helpers-store.ts b/server/lib/plugins/register-helpers-store.ts
index 151196bf19eaa12be4c5e92e0865b3ba1cd6a650..6317ac2cf0f149665c19a8aea77b031a566e1da7 100644 (file)
--- a/server/lib/plugins/register-helpers-store.ts
+++ b/server/lib/plugins/register-helpers-store.ts
@@ -52,6 +52,8 @@ export class RegisterHelpersStore {
   private readonly idAndPassAuths: RegisterServerAuthPassOptions[] = []
   private readonly externalAuths: RegisterServerAuthExternalOptions[] = []
 
+  private readonly onSettingsChangeCallbacks: ((settings: any) => void)[] = []
+
   private readonly router: express.Router
 
   constructor (
@@ -149,6 +151,10 @@ export class RegisterHelpersStore {
     return this.externalAuths
   }
 
+  getOnSettingsChangedCallbacks () {
+    return this.onSettingsChangeCallbacks
+  }
+
   private buildGetRouter () {
     return () => this.router
   }
@@ -185,7 +191,7 @@ export class RegisterHelpersStore {
     const self = this
 
     return (options: RegisterServerAuthExternalOptions) => {
-      if (!options.authName || !options.onAuthRequest || typeof options.onAuthRequest !== 'function') {
+      if (!options.authName || typeof options.authDisplayName !== 'function' || typeof options.onAuthRequest !== 'function') {
         logger.error('Cannot register auth plugin %s: authName of getWeight or login are not valid.', this.npmName)
         return
       }
@@ -212,7 +218,9 @@ export class RegisterHelpersStore {
 
       getSettings: (names: string[]) => PluginModel.getSettings(this.plugin.name, this.plugin.type, names),
 
-      setSetting: (name: string, value: string) => PluginModel.setSetting(this.plugin.name, this.plugin.type, name, value)
+      setSetting: (name: string, value: string) => PluginModel.setSetting(this.plugin.name, this.plugin.type, name, value),
+
+      onSettingsChange: (cb: (settings: any) => void) => this.onSettingsChangeCallbacks.push(cb)
     }
   }
 

diff --git a/server/tests/api/server/plugins.ts b/server/tests/api/server/plugins.ts
index 452d050125e153a3c87d14e0d0b829691c4dc10e..9885be4e84bc3b19f8bb97646e0af59db0422a5b 100644 (file)
--- a/server/tests/api/server/plugins.ts
+++ b/server/tests/api/server/plugins.ts
@@ -27,7 +27,8 @@ import {
   updatePlugin,
   updatePluginPackageJSON,
   updatePluginSettings,
-  wait
+  wait,
+  waitUntilLog
 } from '../../../../shared/extra-utils'
 import { PluginType } from '../../../../shared/models/plugins/plugin.type'
 import { PeerTubePluginIndex } from '../../../../shared/models/plugins/peertube-plugin-index.model'
@@ -142,7 +143,7 @@ describe('Test plugins', function () {
   it('Should have the correct global css', async function () {
     const res = await getPluginsCSS(server.url)
 
-    expect(res.text).to.contain('--mainBackgroundColor')
+    expect(res.text).to.contain('background-color: red')
   })
 
   it('Should have the plugin loaded in the configuration', async function () {
@@ -258,6 +259,12 @@ describe('Test plugins', function () {
     })
   })
 
+  it('Should have watched settings changes', async function () {
+    this.timeout(10000)
+
+    await waitUntilLog(server, 'Settings changed!')
+  })
+
   it('Should get a plugin and a theme', async function () {
     {
       const res = await getPlugin({

diff --git a/server/tests/fixtures/peertube-plugin-test-external-auth-one/main.js b/server/tests/fixtures/peertube-plugin-test-external-auth-one/main.js
index f29fd1f30343dac27ccbe66ac851253ef05011d3..91c67e55046868b69be7a150ec6144e26abdf49b 100644 (file)
--- a/server/tests/fixtures/peertube-plugin-test-external-auth-one/main.js
+++ b/server/tests/fixtures/peertube-plugin-test-external-auth-one/main.js
@@ -5,7 +5,7 @@ async function register ({
   {
     const result = registerExternalAuth({
       authName: 'external-auth-1',
-      authDisplayName: 'External Auth 1',
+      authDisplayName: () => 'External Auth 1',
       onLogout: user => peertubeHelpers.logger.info('On logout %s', user.username),
       onAuthRequest: (req, res) => {
         const username = req.query.username
@@ -23,7 +23,7 @@ async function register ({
   {
     const result = registerExternalAuth({
       authName: 'external-auth-2',
-      authDisplayName: 'External Auth 2',
+      authDisplayName: () => 'External Auth 2',
       onAuthRequest: (req, res) => {
         result.userAuthenticated({
           req,

diff --git a/server/tests/fixtures/peertube-plugin-test-external-auth-two/main.js b/server/tests/fixtures/peertube-plugin-test-external-auth-two/main.js
index 34fec1bb35e07a9e2cc4547f88d5aecf85889da3..126905ffcb06c374206cbaa9db6d1a426982ffac 100644 (file)
--- a/server/tests/fixtures/peertube-plugin-test-external-auth-two/main.js
+++ b/server/tests/fixtures/peertube-plugin-test-external-auth-two/main.js
@@ -5,7 +5,7 @@ async function register ({
   {
     const result = registerExternalAuth({
       authName: 'external-auth-3',
-      authDisplayName: 'External Auth 3',
+      authDisplayName: () => 'External Auth 3',
       onAuthRequest: (req, res) => {
         result.userAuthenticated({
           req,

diff --git a/shared/models/plugins/plugin-settings-manager.model.ts b/shared/models/plugins/plugin-settings-manager.model.ts
index f83f53b8f8535033c69a8a02865048f7c96d9a80..db88ae6e79f0e98bd72375465fc0fb1c568ca745 100644 (file)
--- a/shared/models/plugins/plugin-settings-manager.model.ts
+++ b/shared/models/plugins/plugin-settings-manager.model.ts
@@ -6,4 +6,6 @@ export interface PluginSettingsManager {
   getSettings: (names: string[]) => Bluebird<{ [settingName: string]: string | boolean }>
 
   setSetting: (name: string, value: string) => Bluebird<any>
+
+  onSettingsChange: (cb: (names: string[]) => void) => void
 }

diff --git a/shared/models/plugins/register-server-auth.model.ts b/shared/models/plugins/register-server-auth.model.ts
index 6539dc88828cf1e2e21eef74372274a2a78f3324..4ffce94569d7cd88351c007a6bdadae4d9cb6fdb 100644 (file)
--- a/shared/models/plugins/register-server-auth.model.ts
+++ b/shared/models/plugins/register-server-auth.model.ts
@@ -42,7 +42,7 @@ export interface RegisterServerAuthPassOptions extends RegisterServerAuthBase {
 
 export interface RegisterServerAuthExternalOptions extends RegisterServerAuthBase {
   // Will be displayed in a block next to the login form
-  authDisplayName: string
+  authDisplayName: () => string
 
   onAuthRequest: (req: express.Request, res: express.Response) => void
 }