Desktop: Install default plugins on first-app-start #6585
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
| import { installDefaultPlugins, getDefaultPluginsInstallState, setSettingsForDefaultPlugins, checkPreInstalledDefaultPlugins } from '@joplin/lib/services/plugins/defaultPlugins/defaultPluginsUtils'; | ||
| import PluginRunner from '../../../app/services/plugins/PluginRunner'; | ||
| import * as fs from 'fs-extra'; | ||
| import { setupDatabaseAndSynchronizer, supportDir, switchClient } from '@joplin/lib/testing/test-utils'; | ||
| import PluginService, { defaultPluginSetting, InitialSettings, PluginSettings } from '@joplin/lib/services/plugins/PluginService'; | ||
| import Setting from '@joplin/lib/models/Setting'; | ||
|
|
||
| const testPluginDir = `${supportDir}/plugins`; | ||
|
|
||
| function newPluginService(appVersion: string = '1.4') { | ||
| const runner = new PluginRunner(); | ||
| const service = new PluginService(); | ||
| service.initialize( | ||
| appVersion, | ||
| { | ||
| joplin: {}, | ||
| }, | ||
| runner, | ||
| { | ||
| dispatch: () => {}, | ||
| getState: () => {}, | ||
| } | ||
| ); | ||
| return service; | ||
| } | ||
|
|
||
| describe('defaultPluginsUtils', function() { | ||
|
|
||
| const pluginsId = ['joplin.plugin.ambrt.backlinksToNote', 'org.joplinapp.plugins.ToggleSidebars']; | ||
|
|
||
| beforeEach(async (done) => { | ||
| await setupDatabaseAndSynchronizer(1); | ||
| await switchClient(1); | ||
| done(); | ||
| }); | ||
|
|
||
| it('should install default plugins with no previous default plugins installed', (async () => { | ||
| const testPluginDir = `${supportDir}/pluginRepo/plugins`; | ||
| Setting.setValue('installedDefaultPlugins', []); | ||
|
|
||
| const service = newPluginService('2.1'); | ||
|
|
||
| const pluginSettings = service.unserializePluginSettings(Setting.value('plugins.states')); | ||
|
|
||
| const newPluginsSettings = await installDefaultPlugins(service, testPluginDir, pluginsId, pluginSettings); | ||
|
|
||
| const installedPluginPath1 = `${Setting.value('pluginDir')}/${pluginsId[0]}.jpl`; | ||
| const installedPluginPath2 = `${Setting.value('pluginDir')}/${pluginsId[1]}.jpl`; | ||
|
|
||
| expect(await fs.pathExists(installedPluginPath1)).toBe(true); | ||
| expect(await fs.pathExists(installedPluginPath2)).toBe(true); | ||
|
|
||
| expect(newPluginsSettings[pluginsId[0]]).toMatchObject(defaultPluginSetting()); | ||
| expect(newPluginsSettings[pluginsId[1]]).toMatchObject(defaultPluginSetting()); | ||
|
|
||
| })); | ||
|
|
||
| it('should install default plugins with previous default plugins installed', (async () => { | ||
|
|
||
| const testPluginDir = `${supportDir}/pluginRepo/plugins`; | ||
| Setting.setValue('installedDefaultPlugins', ['org.joplinapp.plugins.ToggleSidebars']); | ||
|
|
||
| const service = newPluginService('2.1'); | ||
|
|
||
| const pluginSettings = service.unserializePluginSettings(Setting.value('plugins.states')); | ||
|
|
||
| const newPluginsSettings = await installDefaultPlugins(service, testPluginDir, pluginsId, pluginSettings); | ||
|
|
||
| const installedPluginPath1 = `${Setting.value('pluginDir')}/${pluginsId[0]}.jpl`; | ||
| const installedPluginPath2 = `${Setting.value('pluginDir')}/${pluginsId[1]}.jpl`; | ||
|
|
||
| expect(await fs.pathExists(installedPluginPath1)).toBe(true); | ||
| expect(await fs.pathExists(installedPluginPath2)).toBe(false); | ||
|
|
||
| expect(newPluginsSettings[pluginsId[0]]).toMatchObject(defaultPluginSetting()); | ||
| expect(newPluginsSettings[pluginsId[1]]).toBeUndefined(); | ||
| })); | ||
|
|
||
| it('should get default plugins install state', (async () => { | ||
| const testCases = [ | ||
| { | ||
| 'installedDefaultPlugins': [''], | ||
| 'loadingPlugins': [`${testPluginDir}/simple`, `${testPluginDir}/jpl_test/org.joplinapp.FirstJplPlugin.jpl`], | ||
| 'plugin1DefaultState': defaultPluginSetting(), | ||
| 'plugin2DefaultState': defaultPluginSetting(), | ||
| 'installedDefaultPlugins1': true, | ||
| 'installedDefaultPlugins2': true, | ||
| }, | ||
| { | ||
| 'installedDefaultPlugins': [''], | ||
| 'loadingPlugins': [`${testPluginDir}/simple`], | ||
| 'plugin1DefaultState': defaultPluginSetting(), | ||
| 'plugin2DefaultState': undefined, | ||
| 'installedDefaultPlugins1': true, | ||
| 'installedDefaultPlugins2': false, | ||
| }, | ||
| { | ||
| 'installedDefaultPlugins': ['org.joplinapp.plugins.Simple'], | ||
| 'loadingPlugins': [`${testPluginDir}/simple`, `${testPluginDir}/jpl_test/org.joplinapp.FirstJplPlugin.jpl`], | ||
| 'plugin1DefaultState': undefined, | ||
| 'plugin2DefaultState': defaultPluginSetting(), | ||
| 'installedDefaultPlugins1': true, | ||
| 'installedDefaultPlugins2': true, | ||
| }, | ||
| { | ||
| 'installedDefaultPlugins': ['org.joplinapp.plugins.Simple'], | ||
| 'loadingPlugins': [`${testPluginDir}/simple`], | ||
| 'plugin1DefaultState': undefined, | ||
| 'plugin2DefaultState': undefined, | ||
| 'installedDefaultPlugins1': true, | ||
| 'installedDefaultPlugins2': false, | ||
| }, | ||
| ]; | ||
|
|
||
| for (const testCase of testCases) { | ||
| const service = newPluginService(); | ||
| const pluginsId = ['org.joplinapp.plugins.Simple', 'org.joplinapp.FirstJplPlugin']; | ||
|
|
||
| Setting.setValue('installedDefaultPlugins', testCase.installedDefaultPlugins); | ||
| await service.loadAndRunPlugins(testCase.loadingPlugins, {}); | ||
|
|
||
| // setting installedDefaultPlugins state | ||
| const defaultInstallStates: PluginSettings = getDefaultPluginsInstallState(service, pluginsId); | ||
|
|
||
| expect(defaultInstallStates[pluginsId[0]]).toStrictEqual(testCase.plugin1DefaultState); | ||
| expect(defaultInstallStates[pluginsId[1]]).toStrictEqual(testCase.plugin2DefaultState); | ||
|
|
||
|
|
||
| const installedDefaultPlugins = Setting.value('installedDefaultPlugins'); | ||
| expect(installedDefaultPlugins.includes(pluginsId[0])).toBe(testCase.installedDefaultPlugins1); | ||
| expect(installedDefaultPlugins.includes(pluginsId[1])).toBe(testCase.installedDefaultPlugins2); | ||
|
|
||
| } | ||
|
|
||
| })); | ||
|
|
||
| it('should check pre-installed default plugins', (async () => { | ||
| // with previous pre-installed default plugins | ||
| Setting.setValue('installedDefaultPlugins', ['']); | ||
| let pluginSettings, installedDefaultPlugins; | ||
|
|
||
| pluginSettings = { [pluginsId[0]]: defaultPluginSetting() }; | ||
| checkPreInstalledDefaultPlugins(pluginsId, pluginSettings); | ||
|
|
||
| installedDefaultPlugins = Setting.value('installedDefaultPlugins'); | ||
| expect(installedDefaultPlugins.includes(pluginsId[0])).toBe(true); | ||
| expect(installedDefaultPlugins.includes(pluginsId[1])).toBe(false); | ||
|
|
||
|
|
||
| // with no previous pre-installed default plugins | ||
| Setting.setValue('installedDefaultPlugins', ['not-a-default-plugin']); | ||
| pluginSettings = {}; | ||
| checkPreInstalledDefaultPlugins(pluginsId, pluginSettings); | ||
|
|
||
| installedDefaultPlugins = Setting.value('installedDefaultPlugins'); | ||
| expect(installedDefaultPlugins.includes(pluginsId[0])).toBe(false); | ||
| expect(installedDefaultPlugins.includes(pluginsId[1])).toBe(false); | ||
|
|
||
| })); | ||
|
|
||
| it('should set initial settings for default plugins', async () => { | ||
| const service = newPluginService(); | ||
|
|
||
| const pluginScript = ` | ||
| /* joplin-manifest: | ||
| { | ||
| "id": "io.github.jackgruber.backup", | ||
| "manifest_version": 1, | ||
| "app_min_version": "1.4", | ||
| "name": "JS Bundle test", | ||
| "version": "1.0.0" | ||
| } | ||
| */ | ||
| joplin.plugins.register({ | ||
| onStart: async function() { | ||
| await joplin.settings.registerSettings({ | ||
| path: { | ||
| value: "initial-path", | ||
| type: 2, | ||
| section: "backupSection", | ||
| public: true, | ||
| label: "Backup path", | ||
| }, | ||
| }) | ||
| }, | ||
| });`; | ||
|
|
||
| const plugin = await service.loadPluginFromJsBundle('', pluginScript); | ||
| await service.runPlugin(plugin); | ||
|
|
||
| const initialSettings: InitialSettings = { | ||
| 'io.github.jackgruber.backup': { | ||
| 'path': `${Setting.value('profileDir')}/testBackup`, | ||
| }, | ||
| }; | ||
|
|
||
| // with pre-installed default plugin | ||
| Setting.setValue('installedDefaultPlugins', ['io.github.jackgruber.backup']); | ||
| setSettingsForDefaultPlugins(initialSettings); | ||
| expect(Setting.value('plugin-io.github.jackgruber.backup.path')).toBe('initial-path'); | ||
| await service.destroy(); | ||
|
|
||
| // with no pre-installed default plugin | ||
| Setting.setValue('installedDefaultPlugins', ['']); | ||
| setSettingsForDefaultPlugins(initialSettings); | ||
| expect(Setting.value('plugin-io.github.jackgruber.backup.path')).toBe(`${Setting.value('profileDir')}/testBackup`); | ||
| await service.destroy(); | ||
| }); | ||
|
|
||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please don't import
*. Only import the functions that you need