Desktop: Resolves #7934: Add Simple Backup as a default plugin

.eslintignore

@@ -59,6 +59,8 @@ packages/app-mobile/locales
 packages/app-mobile/node_modules
 packages/app-mobile/pluginAssets/
 packages/fork-*
+packages/default-plugins/plugin-base-repo/
+packages/default-plugins/plugin-sources/
 packages/htmlpack/dist/
 packages/lib/assets/
 packages/lib/lib/lib.js
@@ -380,6 +382,7 @@ packages/app-desktop/gui/style/StyledTextInput.js
 packages/app-desktop/gui/utils/NoteListUtils.js
 packages/app-desktop/gui/utils/convertToScreenCoordinates.js
 packages/app-desktop/gui/utils/loadScript.js
+packages/app-desktop/gulpfile.js
 packages/app-desktop/integration-tests/main.spec.js
 packages/app-desktop/integration-tests/models/MainScreen.js
 packages/app-desktop/integration-tests/models/NoteEditorScreen.js
@@ -529,6 +532,13 @@ packages/app-mobile/utils/fs-driver/runOnDeviceTests.js
 packages/app-mobile/utils/setupNotifications.js
 packages/app-mobile/utils/shareHandler.js
 packages/app-mobile/utils/types.js
+packages/default-plugins/build.js
+packages/default-plugins/buildDefaultPlugins.js
+packages/default-plugins/commands/buildAll.js
+packages/default-plugins/commands/editPatch.js
+packages/default-plugins/utils/getPathToPatchFileFor.js
+packages/default-plugins/utils/readRepositoryJson.js
+packages/default-plugins/utils/waitForCliInput.js
 packages/editor/CodeMirror/CodeMirror5Emulation/CodeMirror5Emulation.test.js
 packages/editor/CodeMirror/CodeMirror5Emulation/CodeMirror5Emulation.js
 packages/editor/CodeMirror/CodeMirror5Emulation/Decorator.js
@@ -1009,8 +1019,6 @@ packages/tools/build-translation.js
 packages/tools/build-welcome.js
 packages/tools/buildServerDocker.test.js
 packages/tools/buildServerDocker.js
-packages/tools/bundleDefaultPlugins.test.js
-packages/tools/bundleDefaultPlugins.js
 packages/tools/checkIgnoredFiles.js
 packages/tools/checkLibPaths.test.js
 packages/tools/checkLibPaths.js

.gitignore

@@ -362,6 +362,7 @@ packages/app-desktop/gui/style/StyledTextInput.js
 packages/app-desktop/gui/utils/NoteListUtils.js
 packages/app-desktop/gui/utils/convertToScreenCoordinates.js
 packages/app-desktop/gui/utils/loadScript.js
+packages/app-desktop/gulpfile.js
 packages/app-desktop/integration-tests/main.spec.js
 packages/app-desktop/integration-tests/models/MainScreen.js
 packages/app-desktop/integration-tests/models/NoteEditorScreen.js
@@ -511,6 +512,13 @@ packages/app-mobile/utils/fs-driver/runOnDeviceTests.js
 packages/app-mobile/utils/setupNotifications.js
 packages/app-mobile/utils/shareHandler.js
 packages/app-mobile/utils/types.js
+packages/default-plugins/build.js
+packages/default-plugins/buildDefaultPlugins.js
+packages/default-plugins/commands/buildAll.js
+packages/default-plugins/commands/editPatch.js
+packages/default-plugins/utils/getPathToPatchFileFor.js
+packages/default-plugins/utils/readRepositoryJson.js
+packages/default-plugins/utils/waitForCliInput.js
 packages/editor/CodeMirror/CodeMirror5Emulation/CodeMirror5Emulation.test.js
 packages/editor/CodeMirror/CodeMirror5Emulation/CodeMirror5Emulation.js
 packages/editor/CodeMirror/CodeMirror5Emulation/Decorator.js
@@ -991,8 +999,6 @@ packages/tools/build-translation.js
 packages/tools/build-welcome.js
 packages/tools/buildServerDocker.test.js
 packages/tools/buildServerDocker.js
-packages/tools/bundleDefaultPlugins.test.js
-packages/tools/bundleDefaultPlugins.js
 packages/tools/checkIgnoredFiles.js
 packages/tools/checkLibPaths.test.js
 packages/tools/checkLibPaths.js

.npmpackagejsonlintignore

@@ -1,3 +1,5 @@
 packages/app-clipper/popup/
 packages/app-cli/tests/support/plugins/
-packages/doc-builder/
+packages/doc-builder/
+packages/default-plugins/plugin-base-repo/
+packages/default-plugins/plugin-sources/

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

@@ -189,13 +189,11 @@ describe('defaultPluginsUtils', () => {
 
 		const defaultPluginsInfo: DefaultPluginsInfo = {
 			'io.github.jackgruber.backup': {
-				version: '1.0.2',
 				settings: {
 					'path': `${Setting.value('profileDir')}`,
 				},
 			},
 			'plugin.calebjohn.rich-markdown': {
-				version: '0.8.3',
 			},
 		};
 
@@ -245,14 +243,12 @@ describe('defaultPluginsUtils', () => {
 
 		const defaultPluginsInfo: DefaultPluginsInfo = {
 			'io.github.jackgruber.backup': {
-				version: '1.0.2',
 				settings: {
 					'path': `${Setting.value('profileDir')}`,
 					'missing-key1': 'someValue',
 				},
 			},
 			'plugin.calebjohn.rich-markdown': {
-				version: '0.8.3',
 				settings: {
 					'missing-key2': 'someValue',
 				},

packages/app-desktop/.gitignore

@@ -18,3 +18,4 @@ test-results/
 playwright-report/
 playwright/.cache/
 integration-tests/test-profile/
+build/defaultPlugins/

packages/app-desktop/gui/ConfigScreen/controls/plugins/PluginBox.tsx

@@ -60,7 +60,7 @@ const CellRoot = styled.div<{ isCompatible: boolean }>`
 	box-sizing: border-box;
 	background-color: ${props => props.theme.backgroundColor};
 	flex-direction: column;
-	align-items: flex-start;
+	align-items: stretch;
 	padding: 15px;
 	border: 1px solid ${props => props.theme.dividerColor};
 	border-radius: 6px;
@@ -96,12 +96,15 @@ const NeedUpgradeMessage = styled.span`
 	font-size: ${props => props.theme.fontSize}px;
 `;
 
-const DevModeLabel = styled.div`
+const BoxedLabel = styled.div`
 	border: 1px solid ${props => props.theme.color};
 	border-radius: 4px;
 	padding: 4px 6px;
 	font-size: ${props => props.theme.fontSize * 0.75}px;
 	color: ${props => props.theme.color};
+	flex-grow: 0;
+	height: min-content;
+	margin-top: auto;
 `;
 
 const StyledNameAndVersion = styled.div<{ mb: any }>`
@@ -170,7 +173,7 @@ export default function(props: Props) {
 		if (!props.onToggle) return null;
 
 		if (item.devMode) {
-			return <DevModeLabel>DEV</DevModeLabel>;
+			return <BoxedLabel>DEV</BoxedLabel>;
 		}
 
 		return <ToggleButton
@@ -217,6 +220,17 @@ export default function(props: Props) {
 		/>;
 	}
 
+	const renderDefaultPluginLabel = () => {
+		// Built-in plugins can only be disabled
+		if (item.manifest._built_in) {
+			return (
+				<BoxedLabel>{_('Built in')}</BoxedLabel>
+			);
+		}
+
+		return null;
+	};
+
 	function renderFooter() {
 		if (item.devMode) return null;
 
@@ -236,6 +250,7 @@ export default function(props: Props) {
 				{renderInstallButton()}
 				{renderUpdateButton()}
 				<div style={{ display: 'flex', flex: 1 }}/>
+				{renderDefaultPluginLabel()}
 			</CellFooter>
 		);
 	}

packages/app-desktop/gui/ConfigScreen/controls/plugins/PluginsStates.tsx

@@ -147,11 +147,18 @@ export default function(props: Props) {
 		let cancelled = false;
 
 		async function fetchPluginIds() {
-			const pluginIds = await repoApi().canBeUpdatedPlugins(pluginItems.map(p => p.manifest), pluginService.appVersion);
+			// Built-in plugins can't be updated from the main repoApi
+			const nonDefaultPlugins = pluginItems
+				.map(p => p.manifest)
+				.filter(manifest => !manifest._built_in);
+
+			const pluginIds = await repoApi().canBeUpdatedPlugins(nonDefaultPlugins, pluginService.appVersion);
 			if (cancelled) return;
+
 			const conv: Record<string, boolean> = {};
-			// eslint-disable-next-line github/array-foreach -- Old code before rule was applied
-			pluginIds.forEach(id => conv[id] = true);
+			for (const id of pluginIds) {
+				conv[id] = true;
+			}
 			setCanBeUpdatedPluginIds(conv);
 		}
 
@@ -281,10 +288,17 @@ export default function(props: Props) {
 				</UserPluginsRoot>
 			);
 		} else {
+			const nonDefaultPlugins = pluginItems.filter(item => !item.manifest._built_in);
+			const defaultPlugins = pluginItems.filter(item => item.manifest._built_in);
 			return (
-				<UserPluginsRoot>
-					{renderCells(pluginItems)}
-				</UserPluginsRoot>
+				<>
+					<UserPluginsRoot>
+						{renderCells(nonDefaultPlugins)}
+					</UserPluginsRoot>
+					<UserPluginsRoot>
+						{renderCells(defaultPlugins)}
+					</UserPluginsRoot>
+				</>
 			);
 		}
 	}

packages/app-desktop/gulpfile.js → packages/app-desktop/gulpfile.ts

@@ -2,6 +2,7 @@ const gulp = require('gulp');
 const utils = require('@joplin/tools/gulp/utils');
 const compileSass = require('@joplin/tools/compileSass');
 const compilePackageInfo = require('@joplin/tools/compilePackageInfo');
+import buildDefaultPlugins from '@joplin/default-plugins/commands/buildAll';
 
 const tasks = {
 	compileScripts: {
@@ -24,6 +25,12 @@ const tasks = {
 	electronBuilder: {
 		fn: require('./tools/electronBuilder.js'),
 	},
+	buildDefaultPlugins: {
+		fn: async () => {
+			const outputDir = `${__dirname}/build/defaultPlugins/`;
+			await buildDefaultPlugins(outputDir);
+		},
+	},
 	tsc: require('@joplin/tools/gulp/tasks/tsc'),
 	updateIgnoredTypeScriptBuild: require('@joplin/tools/gulp/tasks/updateIgnoredTypeScriptBuild'),
 	buildCommandIndex: require('@joplin/tools/gulp/tasks/buildCommandIndex'),
@@ -39,7 +46,7 @@ const tasks = {
 
 utils.registerGulpTasks(gulp, tasks);
 
-const buildParallel = [
+const buildBeforeStartParallel = [
 	'compileScripts',
 	'compilePackageInfo',
 	'copyPluginAssets',
@@ -49,4 +56,11 @@ const buildParallel = [
 	'compileSass',
 ];
 
-gulp.task('build', gulp.parallel(...buildParallel));
+gulp.task('before-start', gulp.parallel(...buildBeforeStartParallel));
+
+const buildAllSequential = [
+	'before-start',
+	'buildDefaultPlugins',
+];
+
+gulp.task('build', gulp.series(buildAllSequential));

packages/app-desktop/package.json

@@ -7,12 +7,11 @@
   "scripts": {
     "dist": "yarn run electronRebuild && npx electron-builder",
     "build": "gulp build",
-    "postinstall": "yarn run build",
     "electronBuilder": "gulp electronBuilder",
     "electronRebuild": "gulp electronRebuild",
     "tsc": "tsc --project tsconfig.json",
     "watch": "tsc --watch --preserveWatchOutput --project tsconfig.json",
-    "start": "gulp build && electron . --env dev --log-level debug --open-dev-tools",
+    "start": "gulp before-start && electron . --env dev --log-level debug --open-dev-tools",
     "test": "jest",
     "test-ui": "playwright test",
     "test-ci": "yarn test && sh ./integration-tests/run-ci.sh",
@@ -116,6 +115,7 @@
   "homepage": "https://github.com/laurent22/joplin#readme",
   "devDependencies": {
     "@electron/rebuild": "3.3.0",
+    "@joplin/default-plugins": "~2.13",
     "@joplin/tools": "~2.13",
     "@playwright/test": "1.39.0",
     "@testing-library/react-hooks": "8.0.1",
@@ -133,14 +133,11 @@
     "js-sha512": "0.8.0",
     "nan": "2.18.0",
     "react-test-renderer": "18.2.0",
+    "ts-node": "10.9.1",
     "typescript": "5.2.2"
   },
-  "optionalDependencies": {
-    "7zip-bin-linux": "^1.0.1",
-    "7zip-bin-mac": "^1.0.1",
-    "7zip-bin-win": "^2.1.1"
-  },
   "dependencies": {
+    "7zip-bin": "5.2.0",
     "@electron/notarize": "2.1.0",
     "@electron/remote": "2.0.12",
     "@fortawesome/fontawesome-free": "5.15.4",

packages/app-desktop/services/plugins/plugin_index.js

@@ -56,7 +56,8 @@
 				return require('../../node_modules/@joplin/lib/node_modules/sqlite3/lib/sqlite3.js');
 			}
 
-			if (['fs-extra'].includes(modulePath)) return require(modulePath);
+			// 7zip-bin is required by one of the default plugins (simple-backup)
+			if (['fs-extra', '7zip-bin'].includes(modulePath)) return require(modulePath);
 
 			throw new Error(`Module not found: ${modulePath}`);
 		}

packages/app-desktop/tsconfig.json

@@ -7,5 +7,9 @@
 	"exclude": [
 		"**/node_modules",
 		"**/dist",
+
+		// Exclude gulpfile.ts to prevent Gulp from trying to build from
+		// gulpfile.js.
+		"gulpfile.ts"
 	],
 }

packages/default-plugins/.eslintignore

@@ -0,0 +1,2 @@
+plugin-base-repo/
+plugin-sources/*

packages/default-plugins/.gitignore

@@ -0,0 +1,2 @@
+built-plugins/
+plugin-sources/*

packages/default-plugins/build.ts

@@ -0,0 +1,31 @@
+import buildAll from './commands/buildAll';
+import editPatch from './commands/editPatch';
+const yargs = require('yargs');
+
+
+const build = () => {
+	yargs
+		.usage('$0 <cmd> [args]')
+		.command('build <outputDir>', 'build all', (yargs: any) => {
+			yargs.positional('outputDir', {
+				type: 'string',
+				describe: 'Path to the parent directory for built output',
+			});
+		}, async (args: any) => {
+			await buildAll(args.outputDir);
+			process.exit(0);
+		})
+		.command('patch <plugin>', 'Edit the patch file for the given plugin ID', (yargs: any) => {
+			yargs.positional('plugin', {
+				type: 'string',
+				describe: 'ID of the plugin to patch',
+			});
+		}, async (args: any) => {
+			await editPatch(args.plugin, null);
+			process.exit(0);
+		})
+		.help()
+		.argv;
+};
+
+build();