Desktop: Install default plugins on first-app-start

.eslintignore

@@ -1576,6 +1576,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

@@ -1566,6 +1566,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

@@ -9,7 +9,7 @@ import shim from '@joplin/lib/shim';
 import AlarmService from '@joplin/lib/services/AlarmService';
 import AlarmServiceDriverNode from '@joplin/lib/services/AlarmServiceDriverNode';
 import Logger, { TargetType } from '@joplin/lib/Logger';
-import Setting from '@joplin/lib/models/Setting';
+import Setting, { Env } from '@joplin/lib/models/Setting';
 import actionApi from '@joplin/lib/services/rest/actionApi.desktop';
 import BaseApplication from '@joplin/lib/BaseApplication';
 import DebugService from '@joplin/lib/debug/DebugService';
@@ -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
@@ -273,6 +274,11 @@ class Application extends BaseApplication {
 		}
 
 		try {
+			const devEnv = Setting.constants_.env === Env.Dev;
+			let pluginsPath = '';
+			devEnv ? pluginsPath = path.join(__dirname, '..', 'app-desktop/build/defaultPlugins/') : pluginsPath = path.join(process.resourcesPath, 'build/defaultPlugins/');
+
+			pluginSettings = await service.installDefaultPlugins(pluginsPath, pluginSettings, service);
 			if (await shim.fsDriver().exists(Setting.value('pluginDir'))) {
 				await service.loadAndRunPlugins(Setting.value('pluginDir'), pluginSettings);
 			}
@@ -320,6 +326,7 @@ class Application extends BaseApplication {
 					type: 'STARTUP_PLUGINS_LOADED',
 					value: true,
 				});
+				service.setSettingsForDefaultPlugins(service.initialPluginsSettings);
 			}
 		}, 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 getDefaultPluginSettings from '@joplin/lib/services/plugins/defaultPlugins';
 const { KeymapConfigScreen } = require('../KeymapConfig/KeymapConfigScreen');
 
 const settingKeyToControl: any = {
@@ -60,12 +61,26 @@ class ConfigScreenComponent extends React.Component<any, any> {
 		this.setState({ settings: this.props.settings });
 	}
 
+	updatePluginsStates(value: any) {
+		const key = 'plugins.states';
+		const md = Setting.settingMetadata(key);
+		shared.updateSettingValue(this, key, value);
+
+		if (md.autoSave) {
+			shared.scheduleSaveSettings(this);
+		}
+	}
+
 	componentDidMount() {
 		if (this.props.defaultSection) {
 			this.setState({ selectedSectionName: this.props.defaultSection }, () => {
 				this.switchSection(this.props.defaultSection);
 			});
 		}
+		if (!Setting.value('updatedDefaultPluginsInstallStates')) {
+			this.updatePluginsStates(getDefaultPluginSettings());
+			Setting.setValue('updatedDefaultPluginsInstallStates', true);
+		}
 	}
 
 	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();
 		}

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,

packages/lib/services/plugins/PluginService.ts

@@ -9,6 +9,7 @@ import Setting from '../../models/Setting';
 import Logger from '../../Logger';
 import RepositoryApi from './RepositoryApi';
 import produce from 'immer';
+import path = require('path');
 const compareVersions = require('compare-versions');
 const uslug = require('@joplin/fork-uslug');
 
@@ -28,6 +29,14 @@ export interface Plugins {
 	[key: string]: Plugin;
 }
 
+export interface SettingAndValue {
+    [settingName: string]: string;
+}
+
+export interface InitialSettings {
+    [pluginId: string]: SettingAndValue;
+}
+
 export interface PluginSetting {
 	enabled: boolean;
 	deleted: boolean;
@@ -68,6 +77,12 @@ export default class PluginService extends BaseService {
 		return this.instance_;
 	}
 
+	public initialSettings: InitialSettings = {
+		'io.github.jackgruber.backup': {
+			'path': '/JoplinBackup',
+		},
+	};
+
 	private appVersion_: string;
 	private store_: any = null;
 	private platformImplementation_: any = null;
@@ -106,6 +121,10 @@ export default class PluginService extends BaseService {
 		};
 	}
 
+	public get initialPluginsSettings(): InitialSettings {
+		return this.initialSettings;
+	}
+
 	private deletePluginAt(pluginId: string) {
 		if (!this.plugins_[pluginId]) return;
 
@@ -416,7 +435,7 @@ export default class PluginService extends BaseService {
 		return this.installPluginFromRepo(repoApi, pluginId);
 	}
 
-	public async installPlugin(jplPath: string): Promise<Plugin> {
+	public async installPlugin(jplPath: string, loadPlugin: boolean = true): Promise<Plugin | null> {
 		logger.info(`Installing plugin: "${jplPath}"`);
 
 		// Before moving the plugin to the profile directory, we load it
@@ -429,9 +448,35 @@ export default class PluginService extends BaseService {
 		await shim.fsDriver().copy(jplPath, destPath);
 
 		// Now load it from the profile directory
-		const plugin = await this.loadPluginFromPath(destPath);
-		if (!this.plugins_[plugin.id]) this.setPluginAt(plugin.id, plugin);
-		return plugin;
+		if (loadPlugin) {
+			const plugin = await this.loadPluginFromPath(destPath);
+			if (!this.plugins_[plugin.id]) this.setPluginAt(plugin.id, plugin);
+			return plugin;
+		} else { return null; }
+	}
+
+	public async installDefaultPlugins(pathToPlugins: string, pluginSettings: PluginSettings, service: PluginService): Promise<PluginSettings> {
+		if (!Setting.value('firstStart')) return pluginSettings;
+		const defaultPlugins = await shim.fsDriver().readDirStats(pathToPlugins);
+
+		for (const plugin of defaultPlugins) {
+			const defaultPluginPath: string = path.join(`${pathToPlugins}/${plugin.path}`);
+			await service.installPlugin(defaultPluginPath, false);
+
+			pluginSettings = produce(pluginSettings, (draft: PluginSettings) => {
+				draft[filename(plugin.path)] = defaultPluginSetting();
+			});
+		}
+		Setting.setValue('firstStart', 0);
+		return pluginSettings;
+	}
+
+	public setSettingsForDefaultPlugins(initialSettings: InitialSettings) {
+		Object.keys(initialSettings).forEach(pluginId => {
+			Object.keys(initialSettings[pluginId]).forEach((setting) => {
+				Setting.setValue(`plugin-${pluginId}.${setting}`, initialSettings[pluginId][setting]);
+			});
+		});
 	}
 
 	private async pluginPath(pluginId: string) {

packages/lib/services/plugins/defaultPlugins.ts

@@ -0,0 +1,11 @@
+import { defaultPluginSetting, PluginSettings } from './PluginService';
+
+const defaultPluginsId = ['io.github.jackgruber.backup', 'plugin.calebjohn.rich-markdown'];
+
+export default function getDefaultPluginSettings(): PluginSettings {
+	const settings: PluginSettings = {};
+	defaultPluginsId.map((pluginId: string) => {
+		settings[pluginId] = defaultPluginSetting();
+	});
+	return settings;
+}

packages/lib/services/plugins/utils/manifestFromObject.ts

@@ -49,6 +49,7 @@ export default function manifestFromObject(o: any): PluginManifest {
 		permissions: permissions,
 
 		_recommended: getBoolean('_recommended', false, false),
+		_built_in: getBoolean('_built_in', false, false),
 	};
 
 	validatePluginId(manifest.id);

packages/lib/services/plugins/utils/types.ts

@@ -23,4 +23,5 @@ export interface PluginManifest {
 	_npm_package_name?: string;
 	_obsolete?: boolean;
 	_recommended?: boolean;
+	_built_in?: boolean;
 }