Desktop: Install default plugins on first-app-start

.eslintignore

@@ -1585,6 +1585,9 @@ packages/lib/services/plugins/api/JoplinWorkspace.js.map
 packages/lib/services/plugins/api/types.d.ts
 packages/lib/services/plugins/api/types.js
 packages/lib/services/plugins/api/types.js.map
+packages/lib/services/plugins/defaultPlugins.d.ts
+packages/lib/services/plugins/defaultPlugins.js
+packages/lib/services/plugins/defaultPlugins.js.map
 packages/lib/services/plugins/reducer.d.ts
 packages/lib/services/plugins/reducer.js
 packages/lib/services/plugins/reducer.js.map

.gitignore

@@ -1575,6 +1575,9 @@ packages/lib/services/plugins/api/JoplinWorkspace.js.map
 packages/lib/services/plugins/api/types.d.ts
 packages/lib/services/plugins/api/types.js
 packages/lib/services/plugins/api/types.js.map
+packages/lib/services/plugins/defaultPlugins.d.ts
+packages/lib/services/plugins/defaultPlugins.js
+packages/lib/services/plugins/defaultPlugins.js.map
 packages/lib/services/plugins/reducer.d.ts
 packages/lib/services/plugins/reducer.js
 packages/lib/services/plugins/reducer.js.map

packages/app-cli/tests/services/plugins/PluginService.ts

@@ -1,5 +1,5 @@
 import PluginRunner from '../../../app/services/plugins/PluginRunner';
-import PluginService from '@joplin/lib/services/plugins/PluginService';
+import PluginService, { InitialSettings } from '@joplin/lib/services/plugins/PluginService';
 import { ContentScriptType } from '@joplin/lib/services/plugins/api/types';
 import MdToHtml from '@joplin/renderer/MdToHtml';
 import shim from '@joplin/lib/shim';
@@ -9,6 +9,7 @@ import Note from '@joplin/lib/models/Note';
 import Folder from '@joplin/lib/models/Folder';
 import { expectNotThrow, setupDatabaseAndSynchronizer, switchClient, expectThrow, createTempDir, supportDir } from '@joplin/lib/testing/test-utils';
 import { newPluginScript } from '../../testUtils';
+import path = require('path');
 
 const testPluginDir = `${supportDir}/plugins`;
 
@@ -271,6 +272,17 @@ describe('services_PluginService', function() {
 		expect(await fs.pathExists(installedPluginPath)).toBe(true);
 	}));
 
+	it('should install default plugins', (async () => {
+		const service = newPluginService();
+		const pluginsPath = path.join(__dirname, '..', '/defaultPlugins/');
+		const pluginSettings = service.unserializePluginSettings(Setting.value('plugins.states'));
+		await service.installDefaultPlugins(pluginsPath, pluginSettings, service);
+		const installedPluginPath1 = `${Setting.value('pluginDir')}/io.github.jackgruber.backup.jpl`;
+		const installedPluginPath2 = `${Setting.value('pluginDir')}/plugin.calebjohn.rich-markdown.jpl`;
+		expect(await fs.pathExists(installedPluginPath1)).toBe(true);
+		expect(await fs.pathExists(installedPluginPath2)).toBe(true);
+	}));
+
 	it('should rename the plugin archive to the right name', (async () => {
 		const tempDir = await createTempDir();
 		const service = newPluginService();
@@ -305,4 +317,45 @@ describe('services_PluginService', function() {
 		expect(JSON.parse(folders[0].title)).toBe(expectedPath);
 	}));
 
+	test('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: "",
+						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': '/JoplinBackupTest',
+			},
+		};
+
+		service.setSettingsForDefaultPlugins(initialSettings);
+		expect(Setting.value('plugin-io.github.jackgruber.backup.path')).toBe('/JoplinBackupTest');
+		await service.destroy();
+	});
+
 });

packages/app-desktop/app.ts

@@ -63,6 +63,7 @@ import checkForUpdates from './checkForUpdates';
 import { AppState } from './app.reducer';
 import syncDebugLog from '@joplin/lib/services/synchronizer/syncDebugLog';
 import eventManager from '@joplin/lib/eventManager';
+import path = require('path');
 // import { runIntegrationTests } from '@joplin/lib/services/e2ee/ppkTestUtils';
 
 const pluginClasses = [
@@ -261,7 +262,7 @@ class Application extends BaseApplication {
 		service.initialize(packageInfo.version, PlatformImplementation.instance(), pluginRunner, this.store());
 		service.isSafeMode = Setting.value('isSafeMode');
 
-		const pluginSettings = service.unserializePluginSettings(Setting.value('plugins.states'));
+		let pluginSettings = service.unserializePluginSettings(Setting.value('plugins.states'));
 
 		{
 			// Users can add and remove plugins from the config screen at any
@@ -270,6 +271,7 @@ class Application extends BaseApplication {
 			// stored in the settings.
 			const newSettings = service.clearUpdateState(await service.uninstallPlugins(pluginSettings));
 			Setting.setValue('plugins.states', newSettings);
+			Setting.setValue('preInstalledDefaultPlugins', newSettings);
 		}
 
 		try {
@@ -280,6 +282,31 @@ class Application extends BaseApplication {
 			this.logger().error(`There was an error loading plugins from ${Setting.value('pluginDir')}:`, error);
 		}
 
+		// we are loading default plugins here so as to not disturb user plugins
+		try {
+			const pluginsDir = path.join(bridge().buildDir(), 'defaultPlugins');
+			pluginSettings = await service.installDefaultPlugins(pluginsDir, pluginSettings);
+
+			const defaultPluginsPath = await shim.fsDriver().readDirStats(pluginsDir);
+			const readyToLoadPluginsPath = [];
+
+			for (const pluginFolder of defaultPluginsPath) {
+				// here pluginFolder will be pluginId
+				// maybe put this.plugins_ in here instead  of service.plugins
+				const newSettings = Setting.value('installedDefaultPlugins');
+
+				if (service.plugins[pluginFolder.path] || newSettings.includes(pluginFolder.path)) continue;
+
+				readyToLoadPluginsPath.push(path.join(pluginsDir, pluginFolder.path, 'plugin.jpl'));
+			}
+
+			if (readyToLoadPluginsPath.length > 0) {
+				await service.loadAndRunPlugins(readyToLoadPluginsPath, pluginSettings);
+			}
+		} catch (error) {
+			this.logger().error(`There was an error loading default plugins from ${Setting.value('pluginDir')}:`, error);
+		}
+
 		try {
 			if (Setting.value('plugins.devPluginPaths')) {
 				const paths = Setting.value('plugins.devPluginPaths').split(',').map((p: string) => p.trim());
@@ -320,6 +347,8 @@ class Application extends BaseApplication {
 					type: 'STARTUP_PLUGINS_LOADED',
 					value: true,
 				});
+				service.setSettingsForDefaultPlugins(service.initialPluginsSettings, Setting.value('plugins.states'));
+				// object with plugins id wand if its initilised settings
 			}
 		}, 500);
 	}

packages/app-desktop/gui/ConfigScreen/ConfigScreen.tsx

@@ -15,6 +15,7 @@ import SyncTargetRegistry from '@joplin/lib/SyncTargetRegistry';
 const shared = require('@joplin/lib/components/shared/config-shared.js');
 import ClipperConfigScreen from '../ClipperConfigScreen';
 import restart from '../../services/restart';
+import PluginService from '@joplin/lib/services/plugins/PluginService';
 const { KeymapConfigScreen } = require('../KeymapConfig/KeymapConfigScreen');
 
 const settingKeyToControl: any = {
@@ -60,12 +61,28 @@ class ConfigScreenComponent extends React.Component<any, any> {
 		this.setState({ settings: this.props.settings });
 	}
 
+	updatePluginsStates(value: any) {
+		if (Object.keys(value).length === 0) return;
+		const key = 'plugins.states';
+		const md = Setting.settingMetadata(key);
+		let newValue = Setting.value('plugins.states');
+		newValue = {
+			...newValue, ...value,
+		};
+		shared.updateSettingValue(this, key, newValue);
+
+		if (md.autoSave) {
+			shared.scheduleSaveSettings(this);
+		}
+	}
+
 	componentDidMount() {
 		if (this.props.defaultSection) {
 			this.setState({ selectedSectionName: this.props.defaultSection }, () => {
 				this.switchSection(this.props.defaultSection);
 			});
 		}
+		this.updatePluginsStates(PluginService.instance().setInstalledState());
 	}
 
 	private async handleSettingButton(key: string) {

packages/app-desktop/package.json

@@ -31,7 +31,8 @@
     "afterSign": "./tools/notarizeMacApp.js",
     "extraResources": [
       "build/icons/**",
-      "build/images/**"
+      "build/images/**",
+      "build/defaultPlugins/**"
     ],
     "afterAllArtifactBuild": "./generateSha512.js",
     "asar": true,

packages/lib/BaseApplication.ts

@@ -838,7 +838,6 @@ export default class BaseApplication {
 				Setting.setValue('sync.interval', 3600);
 			}
 
-			Setting.setValue('firstStart', 0);
 		} else {
 			Setting.applyDefaultMigrations();
 		}
@@ -852,6 +851,7 @@ export default class BaseApplication {
 			Setting.setValue('sync.10.userContentPath', 'http://joplincloud.local:22300');
 		}
 
+		Setting.setValue('firstStart', 0);
 		// For now always disable fuzzy search due to performance issues:
 		// https://discourse.joplinapp.org/t/1-1-4-keyboard-locks-up-while-typing/11231/11
 		// https://discourse.joplinapp.org/t/serious-lagging-when-there-are-tens-of-thousands-of-notes/11215/23

packages/lib/models/Setting.ts

@@ -1534,6 +1534,14 @@ class Setting extends BaseModel {
 				storage: SettingStorage.Database,
 			},
 
+			updatedDefaultPluginsInstallStates: {
+				value: false,
+				type: SettingItemType.Bool,
+				public: false,
+				appTypes: [AppType.Desktop],
+				storage: SettingStorage.File,
+			},
+
 			lastSettingDefaultMigration: {
 				value: -1,
 				type: SettingItemType.Int,
@@ -1546,6 +1554,27 @@ class Setting extends BaseModel {
 				public: false,
 			},
 
+			installedDefaultPlugins: {
+				value: [],
+				type: SettingItemType.Array,
+				public: false,
+				storage: SettingStorage.File,
+			},
+
+			setInitialDefaultPluginsSettings: {
+				value: [],
+				type: SettingItemType.Array,
+				public: false,
+				storage: SettingStorage.File,
+			},
+
+			preInstalledDefaultPlugins: {
+				value: '',
+				type: SettingItemType.Object,
+				public: false,
+				storage: SettingStorage.File,
+			},
+
 			// 'featureFlag.syncAccurateTimestamps': {
 			// 	value: false,
 			// 	type: SettingItemType.Bool,
@@ -1914,6 +1943,14 @@ class Setting extends BaseModel {
 		return this.setValue(key, !this.value(key));
 	}
 
+	static checkAndUpdate(settingName: string, value: string): boolean {
+		const settingValue: Array<any> = this.value(settingName);
+		if (settingValue.includes(value)) return true;
+		settingValue.push(value);
+		this.setValue(settingName, settingValue);
+		return false;
+	}
+
 	static objectValue(settingKey: string, objectKey: string, defaultValue: any = null) {
 		const o = this.value(settingKey);
 		if (!o || !(objectKey in o)) return defaultValue;