feat: Allow defining active plugins in config #10767

oplik0 · 2022-07-14T13:44:02Z

resolves #10766 and supersedes #10036

Things left:

Theme selection doesn't inform the user the change also needs to happen in the config on the frontend - the message only appear in the logs.
Might be possible to just remove the disable/enable button from ACP rather than throwing errors?
Currently I'm using one generic error for all situations, perhaps there should at least be a theme specific one?
Add tests

…"" This reverts commit 46050ac.

…bb.admin-settings-advanced"" This reverts commit 9f291c0.

…section

…r profile /cc julianlam/nodebb-plugin-support-forum#14

…ieval endpoints

resolves NodeBB#10766

nodebb-misty · 2022-07-14T13:44:04Z

This pull request was made against the develop branch, which while not strictly disallowed, is unorthodox. If this is intentional, please respond back with the reason for this pull request being made to the develop branch.

Thanks!

julianlam · 2022-07-14T13:53:28Z

Ooh, need to update @nodebb-misty's messaging about the develop branch 😁

nodebb-misty · 2022-07-14T14:06:50Z

💡 Friendly Note

This pull request was made against the develop branch, which is reserved for commits destined for a minor or major release.If your commits simply fixes a bug, please rebase this PR against the master instead.

patch releases — bug fixes only
minor releases — new features, enhancements, and bug fixes
major releases — breaking changes, including all of the above

Thanks!

julianlam · 2022-07-14T14:06:59Z

There we go 😄

oplik0 · 2022-07-14T16:32:51Z

So some updates:

now theme selector requires that the selected theme is already in active plugins if one has them configured - then it does let the user change the theme in ACP.
If it's not present, an error message explaining this will be shown
As for enabling/disabling plugins, I chose to change just the class of the buttons. It provides visual indication and an error will be returned when attempting to change the state explaining the reason. This should be less confusing in my opinion.
Added some basic tests; I can also add one for theme changes, but I'm not sure where to put it.

app.js

public/language/en-GB/error.json

src/cli/manage.js

src/cli/reset.js

src/plugins/install.js

src/views/admin/partials/installed_plugin_item.tpl

src/plugins/data.js

julianlam · 2022-07-15T18:40:47Z

@oplik0 You have my signoff 📝

* Revert "Revert "feat: cross origin opener policy options (#10710)"" This reverts commit 46050ac. * Revert "Revert "chore(i18n): fallback strings for new resources: nodebb.admin-settings-advanced"" This reverts commit 9f291c0. * feat: closes #10719, don't trim children if category is marked section * feat: fire hook to allow plugins to filter the pids returned in a user profile /cc julianlam/nodebb-plugin-support-forum#14 * fix: use `user.hidePrivateData();` more consistently across user retrieval endpoints * feat: Allow defining active plugins in config resolves #10766 * fix: assign the db result to files properly * test: add tests with plugins in config * feat: better theme change handling * feat: add visual indication that plugins can't be activated * test: correct hooks * test: fix test definitions * test: remove instead of resetting nconf to avoid affecting other tests * test: ... I forgot how nconf worked * fix: remove negation * docs: improve wording of error message * feat: reduce code duplication * style: remove a redundant space * fix: remove unused imports * fix: use nconf instead of requiring config.json * fix: await... * fix: second missed await * fix: move back from getActiveIds to getActive * fix: use paths again? * fix: typo * fix: move require into the function * fix: forgot to change back to getActive * test: getActive returns only id * test: accedently commented out some stuff * feat: added note to top of plugins page if \!canChangeState Co-authored-by: Julian Lam <julian@nodebb.org> Co-authored-by: Barış Soner Uşaklı <barisusakli@gmail.com>

* Revert "Revert "feat: cross origin opener policy options (#10710)"" This reverts commit 46050ac. * Revert "Revert "chore(i18n): fallback strings for new resources: nodebb.admin-settings-advanced"" This reverts commit 9f291c0. * feat: closes #10719, don't trim children if category is marked section * feat: fire hook to allow plugins to filter the pids returned in a user profile /cc julianlam/nodebb-plugin-support-forum#14 * fix: use `user.hidePrivateData();` more consistently across user retrieval endpoints * fix: better looking placeholder text for ACP search * fix: bug where fallback to forum search was not working due to client-side error * feat: allow plugins to toggle whether IPs are shown in the users CSV export * feat: Allow defining active plugins in config (#10767) * Revert "Revert "feat: cross origin opener policy options (#10710)"" This reverts commit 46050ac. * Revert "Revert "chore(i18n): fallback strings for new resources: nodebb.admin-settings-advanced"" This reverts commit 9f291c0. * feat: closes #10719, don't trim children if category is marked section * feat: fire hook to allow plugins to filter the pids returned in a user profile /cc julianlam/nodebb-plugin-support-forum#14 * fix: use `user.hidePrivateData();` more consistently across user retrieval endpoints * feat: Allow defining active plugins in config resolves #10766 * fix: assign the db result to files properly * test: add tests with plugins in config * feat: better theme change handling * feat: add visual indication that plugins can't be activated * test: correct hooks * test: fix test definitions * test: remove instead of resetting nconf to avoid affecting other tests * test: ... I forgot how nconf worked * fix: remove negation * docs: improve wording of error message * feat: reduce code duplication * style: remove a redundant space * fix: remove unused imports * fix: use nconf instead of requiring config.json * fix: await... * fix: second missed await * fix: move back from getActiveIds to getActive * fix: use paths again? * fix: typo * fix: move require into the function * fix: forgot to change back to getActive * test: getActive returns only id * test: accedently commented out some stuff * feat: added note to top of plugins page if \!canChangeState Co-authored-by: Julian Lam <julian@nodebb.org> Co-authored-by: Barış Soner Uşaklı <barisusakli@gmail.com> * feat: show an informative message when no plugins are found after filtering fixes #10771 * Latest translations and fallbacks * Latest translations and fallbacks * chore(deps): bump ace-builds from 1.7.1 to 1.8.1 in /install Bumps [ace-builds](https://github.com/ajaxorg/ace-builds) from 1.7.1 to 1.8.1. - [Release notes](https://github.com/ajaxorg/ace-builds/releases) - [Changelog](https://github.com/ajaxorg/ace-builds/blob/master/CHANGELOG.md) - [Commits](ajaxorg/ace-builds@v1.7.1...v1.8.1) --- updated-dependencies: - dependency-name: ace-builds dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * fix: swap out icons in ACP > Manage > Categories to more intuitive ones, remove extra placeholder div * fix: hide expando button if no subcategories; remove attempt at establishing common vars, increased spacing between categories in list * fix: buggy expando state on category drag/drop Co-authored-by: Barış Soner Uşaklı <barisusakli@gmail.com> Co-authored-by: Opliko <opliko.reg@protonmail.com> Co-authored-by: Misty Release Bot <deploy@nodebb.org> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Brutus5000 · 2023-01-21T21:17:05Z

@oplik0 Is there a way to define the plugin version in the config.json?

oplik0 · 2023-01-21T21:46:47Z

No, config.json just defines active plugins, replacing the database in that aspect if set. What does and what should define what to install in general is package.json.
If you want it to be the initial configuration, you should run nodebb setup (in docker you can do so before launching by setting the SETUP environment variable. If it's not set NodeBB will just run build).

Brutus5000 · 2023-04-14T21:11:06Z

@oplik0 How is this feature supposed to install plugins?

I always get this error: warn: [plugins] "nodebb-plugin-write-api" is active but not installed
Since I declared it in the config I can not use the command line to install it. So how to install it? I tried setting the SETUP variable too, but that doesn't force installation of the plugins.

julianlam · 2023-04-14T22:55:04Z

The variable defines which plugins are considered active by NodeBB, it doesn't do any installation of plugins.

If you want a plugin installed, define it in package.json

oplik0 · 2023-04-14T23:24:23Z

I think I see the issue now though - modifying package.json is not easy in e.g. kubernetes, so allowing for some way to install plugins without modifying the filesystem beforehand might be a good idea.

I think it would be fine to add an option to do that on setup specifically - I opened #11485 adding that option.

This wouldn't affect container build time, nor normal start time (only with setup and the plugins:autoinstall option set to true).

julianlam and others added 6 commits June 29, 2022 16:28

Revert "Revert "feat: cross origin opener policy options (NodeBB#10710)…

78f3d4e

…"" This reverts commit 46050ac.

Revert "Revert "chore(i18n): fallback strings for new resources: node…

35780c0

…bb.admin-settings-advanced"" This reverts commit 9f291c0.

feat: closes NodeBB#10719, don't trim children if category is marked …

cfc8c3e

…section

feat: fire hook to allow plugins to filter the pids returned in a use…

39b2599

…r profile /cc julianlam/nodebb-plugin-support-forum#14

fix: use user.hidePrivateData(); more consistently across user retr…

8a243e6

…ieval endpoints

feat: Allow defining active plugins in config

0ca3707

resolves NodeBB#10766

fix: assign the db result to files properly

2205ae4

NodeBB deleted a comment from nodebb-misty Jul 14, 2022

julianlam self-assigned this Jul 14, 2022

oplik0 added 4 commits July 14, 2022 15:58

test: add tests with plugins in config

6a9b1de

feat: better theme change handling

885e16e

feat: add visual indication that plugins can't be activated

1b4c920

test: correct hooks

cfcd1d9

oplik0 added 3 commits July 14, 2022 16:43

test: fix test definitions

7c3bc1a

test: remove instead of resetting nconf to avoid affecting other tests

fcf10e4

test: ... I forgot how nconf worked

f31cb87

oplik0 marked this pull request as ready for review July 14, 2022 17:21

julianlam requested changes Jul 14, 2022

View reviewed changes

oplik0 added 6 commits July 14, 2022 18:10

fix: remove negation

6736e6c

docs: improve wording of error message

340a555

feat: reduce code duplication

c68f10b

style: remove a redundant space

8ba7f4e

fix: remove unused imports

76772b3

fix: use nconf instead of requiring config.json

34b86b7

oplik0 force-pushed the activate-plugins-in-config branch from 3c64378 to 34b86b7 Compare July 14, 2022 18:49

oplik0 added 9 commits July 14, 2022 19:01

fix: await...

a1dfcc2

fix: second missed await

2e629ba

fix: move back from getActiveIds to getActive

c555e54

fix: use paths again?

81a9582

fix: typo

9e7816e

fix: move require into the function

fe8f1df

fix: forgot to change back to getActive

91b5e18

test: getActive returns only id

549d7be

test: accedently commented out some stuff

673a643

oplik0 requested a review from julianlam July 14, 2022 21:19

julianlam added the enhancement label Jul 15, 2022

julianlam added this to the 2.3.0 milestone Jul 15, 2022

julianlam reviewed Jul 15, 2022

View reviewed changes

src/plugins/data.js Show resolved Hide resolved

feat: added note to top of plugins page if \!canChangeState

160bdf5

julianlam added the LGTM Looks good to me/merge label Jul 15, 2022

julianlam force-pushed the develop branch from 8a243e6 to 00016d0 Compare July 25, 2022 17:58

julianlam approved these changes Jul 25, 2022

View reviewed changes

julianlam merged commit 4833a56 into NodeBB:develop Jul 25, 2022

This was referenced Jan 16, 2023

Docker: Allow file based declaration of active modules #10036

Open

Missing explanation of plugins:active in config.json NodeBB/docs#71

Closed

oplik0 mentioned this pull request Apr 14, 2023

feat: autoinstall plugins on setup #11485

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Allow defining active plugins in config #10767

feat: Allow defining active plugins in config #10767

oplik0 commented Jul 14, 2022 •

edited

nodebb-misty commented Jul 14, 2022

julianlam commented Jul 14, 2022

nodebb-misty commented Jul 14, 2022

julianlam commented Jul 14, 2022

oplik0 commented Jul 14, 2022

julianlam commented Jul 15, 2022

Brutus5000 commented Jan 21, 2023

oplik0 commented Jan 21, 2023

Brutus5000 commented Apr 14, 2023

julianlam commented Apr 14, 2023

oplik0 commented Apr 14, 2023

feat: Allow defining active plugins in config #10767

feat: Allow defining active plugins in config #10767

Conversation

oplik0 commented Jul 14, 2022 • edited

nodebb-misty commented Jul 14, 2022

julianlam commented Jul 14, 2022

nodebb-misty commented Jul 14, 2022

💡 Friendly Note

julianlam commented Jul 14, 2022

oplik0 commented Jul 14, 2022

julianlam commented Jul 15, 2022

Brutus5000 commented Jan 21, 2023

oplik0 commented Jan 21, 2023

Brutus5000 commented Apr 14, 2023

julianlam commented Apr 14, 2023

oplik0 commented Apr 14, 2023

oplik0 commented Jul 14, 2022 •

edited