Skip to content

ActivityPub-federated video streaming platform using P2P directly in your web browser

Fix plugin settings to display default values when not configured in the DB (#7484)

Himani Sharma54095dff49b7
diff --git a/packages/tests/fixtures/peertube-plugin-test/main.js b/packages/tests/fixtures/peertube-plugin-test/main.js
index c373ccef7a..203e9f7e70 100644
--- a/packages/tests/fixtures/peertube-plugin-test/main.js
+++ b/packages/tests/fixtures/peertube-plugin-test/main.js
@@ -1,7 +1,18 @@
const path = require('path')
-async function register ({ registerHook, registerSetting, settingsManager, storageManager, peertubeHelpers }) {
+async function register ({ registerHook, registerSetting, settingsManager, storageManager, peertubeHelpers, getRouter }) {
{
+ registerSetting({
+ name: 'test-setting',
+ label: 'Test setting',
+ type: 'input',
+ default: 'default-value'
+ })
+
+ const router = getRouter()
+ router.get('/get-setting', async (req, res) => {
+ res.json({ val: await settingsManager.getSetting('test-setting') })
+ })
registerSetting({
name: 'unique-setting',
label: 'Unique setting',
diff --git a/packages/tests/src/api/server/plugins.ts b/packages/tests/src/api/server/plugins.ts
index 4c8fd91305..2dccf3d30e 100644
--- a/packages/tests/src/api/server/plugins.ts
+++ b/packages/tests/src/api/server/plugins.ts
@@ -409,6 +409,46 @@ describe('Test plugins', function () {
})
})
+ it('Should return default value for a setting if not set in DB', async function () {
+ const pluginPath = PluginsCommand.getPluginTestPath('')
+ await command.install({ path: pluginPath })
+
+ await wait(1000)
+
+ const checkSetting = async (expected: any) => {
+ const res = await makeGetRequest({
+ url: server.url,
+ path: '/plugins/test/router/get-setting',
+ expectedStatus: HttpStatusCode.OK_200
+ })
+ expect(res.body.val).to.equal(expected)
+ }
+
+ try {
+ await checkSetting('default-value')
+
+ await command.updateSettings({
+ npmName: 'peertube-plugin-test',
+ settings: {
+ some_other_setting: 'value'
+ }
+ })
+
+ await checkSetting('default-value')
+
+ await command.updateSettings({
+ npmName: 'peertube-plugin-test',
+ settings: {
+ 'test-setting': 'updated-value'
+ }
+ })
+
+ await checkSetting('updated-value')
+ } finally {
+ await command.uninstall({ npmName: 'peertube-plugin-test' })
+ }
+ })
+
after(async function () {
await sqlCommand.cleanup()
diff --git a/server/core/models/server/plugin.ts b/server/core/models/server/plugin.ts
index 7851032181..1844f6a6e0 100644
--- a/server/core/models/server/plugin.ts
+++ b/server/core/models/server/plugin.ts
@@ -130,7 +130,7 @@ export class PluginModel extends SequelizeModel<PluginModel> {
return PluginModel.findOne(query)
.then(p => {
- if (!p?.settings || p.settings === undefined) {
+ if (p?.settings?.[settingName] === undefined) {
const registered = registeredSettings.find(s => s.name === settingName)
if (!registered || registered.default === undefined) return undefined