GSOC: Default plugins on desktop application

makb · 26 May 2022 09:02

Just to make sure we are on the same page, we would still need installation of these plugins on first-app-start. Maybe we can give users a prompt window indicating this.

I agree, bundling plugins while building the app make more sense.

I will try troubleshooting it again and will let you know how it goes.

In my opinion, pinning them may be a better option, as we don't want a buggy version of some plugin suddenly slowing down or causing any problem to the main app. But it comes at a cost of increased workload of maintainers, as they will have to keep them updated.

CalebJohn · 26 May 2022 17:11

Agreed

I wonder if adding additional complexity such as "The most recent patch release, or the most recent major/minor release that is at least 2 weeks old". This would give more stability without having to necessitate manual review. Although manual review is probably valuable in this case.

makb · 27 May 2022 06:14

I agree. This is a nice alternative as it provides more stability. We can also combine this approach with manual review, as you said, making it more secure.

makb · 29 May 2022 16:08

Quick Update:
Just wanted to let you know that I was able to successfully test out installing default plugins on start-up without restarting the app.

makb · 4 June 2022 12:03

Hi there,

Recently, I tried to implement installing plugins on start-up. Turns out that we just needed to move .jpl files into the plugins' directory before loading all the plugins to install them.

The other thing I noticed is that 'Simple Backup' Plugin has a pop-up that comes after installation is complete. And it takes a bit of time to pop, but that shouldn't be a major issue.

But the issue here is that pluginSettings doesn't update immediately. Because of this, even after successful installation of plugins, we can still see the option to install them in Plugins menu. So I think we should be good after fixing this because I didn't notice any other issue.

Can you please suggest any other things that I didn't consider in this part of the project?

laurent · 4 June 2022 12:06

By default I don't think there should be a popup on startup. Maybe we can setup the plugin with reasonable defaults?

Not sure what you mean?

makb · 4 June 2022 12:22

I agree!

pluginSettings is defined here:

github.com

laurent22/joplin/blob/19b81917123a3ceb5a0c961b2bb2157251385b17/packages/app-desktop/gui/ConfigScreen/controls/plugins/PluginsStates.tsx#L102


      
          export default function(props: Props) {
          	const [searchQuery, setSearchQuery] = useState('');
          	const [manifestsLoaded, setManifestsLoaded] = useState<boolean>(false);
          	const [updatingPluginsIds, setUpdatingPluginIds] = useState<Record<string, boolean>>({});
          	const [canBeUpdatedPluginIds, setCanBeUpdatedPluginIds] = useState<Record<string, boolean>>({});
          	const [repoApiError, setRepoApiError] = useState<Error>(null);
          	const [fetchManifestTime, setFetchManifestTime] = useState<number>(Date.now());
          
          	const pluginService = PluginService.instance();
          
          	const pluginSettings = useMemo(() => {
          		return pluginService.unserializePluginSettings(props.value);
          	}, [props.value]);
          
          	const pluginItems = usePluginItems(pluginService.plugins, pluginSettings);
          
          	useEffect(() => {
          		let cancelled = false;
          		async function fetchManifests() {
          			setManifestsLoaded(false);
          			setRepoApiError(null);

We use pluginSettings in the code below to check the plugins' install state. This should be updated immediately after we install default plugins before loading all the other plugins.

github.com

laurent22/joplin/blob/19b81917123a3ceb5a0c961b2bb2157251385b17/packages/app-desktop/gui/ConfigScreen/controls/plugins/SearchPlugins.tsx#L76


      
          		setSearchStarted(true);
          		props.onSearchQueryChange(event);
          	}, [props.onSearchQueryChange]);
          
          	const onSearchButtonClick = useCallback(() => {
          		setSearchStarted(false);
          		props.onSearchQueryChange({ value: '' });
          	}, []);
          
          	function installState(pluginId: string): InstallState {
          		const settings = props.pluginSettings[pluginId];
          		if (settings && !settings.deleted) return InstallState.Installed;
          		if (installingPluginsIds[pluginId]) return InstallState.Installing;
          		return InstallState.NotInstalled;
          	}
          
          	function renderResults(query: string, manifests: PluginManifest[]) {
          		if (query && !manifests.length) {
          			if (searchResultCount === null) return ''; // Search in progress
          			return props.renderDescription(props.themeId, _('No results'));
          		} else {

Side note: I think I can solve the above issue by myself, in case any difficulty I will discuss it here.

Also, just to make sure, can you please suggest any other things that are remaining to be done on my part for this part of the project apart from tests?

laurent · 4 June 2022 15:16

I don't really know as I haven't read the whole thing, but you might want to check with your mentor if you have doubts.

Topic		Replies	Views
Default Plugins on desktop application Default Plugin Support gsoc-2022	6	868	1 June 2022
Bundling default plugins with desktop app Development gsoc-2022	2	530	4 July 2022
Coding Phase - Week 2 Report Default Plugin Support gsoc-2022 , weekly , report	13	678	30 June 2022
GSoC Weekly Updates - Template Plugin Template Plugin	11	2150	16 August 2021
High level discussion on plug-in architecture & template library Features gsoc-2020	2	908	4 March 2020

GSOC: Default plugins on desktop application

Related topics