"Error: action.pluginId is required" when trying to add menu or toolbar item

ambrt · 11 November 2020 18:49

I'm using AppImage to launch dev version of Joplin
/tmp/.mount_JoplinmsLh6l/joplin --env dev

(version 1.3.18, desktop, linux)

I have also installed AppImage launcher (https://github.com/TheAssassin/AppImageLauncher)

I'm trying example plugin (
https://github.com/laurent22/joplin/blob/dev/packages/app-cli/tests/support/plugins/selected_text/src/index.ts ) verbatim.

While command is registered correctly (I can access it via Command Palette),
registering menu item or toolbar throws error:

19:32:08 Plugin Service: Starting plugin:  main-html.js:49
19:32:09 Plugin Service: Finished running onStart handler:  (Took 633ms)

/tmp/.mount_Joplinms…ugins/reducer.js:52 Uncaught (in promise) Error: action.pluginId is required. Action was: 
{"type":"PLUGIN_VIEW_ADD",
"pluginId":"",
"view":
{"id":"plugin-view--hfF28Ez0gOn5fqWTyPvuIt",
"type":"toolbarButton","commandName":
"prettyMarkdownTable","location":"editorToolbar"}}
    at Object.reducer (lib/services/plugins/reducer.js:52)
    at Object.<anonymous> (lib/reducer.js:975)
    at node_modules/immer/d….development.js:713
    at Immer.produce (node_modules/immer/d….development.js:728)
    at Object.curriedProduce [as default] (node_modules/immer/d….development.js:710)
    at reducer (lib/BaseApplication.js:564)
    at reducer (app.js:267)
    at dispatch (node_modules/redux/l…/createStore.js:178)
    at Application.<anonymous> (lib/BaseApplication.js:451)
    at Generator.next (<anonymous>)

this is log form main console window, not plugin console.

It seems that plugin id is empty.
Commenting line below launches without error.

github.com

laurent22/joplin/blob/dev/packages/app-cli/tests/support/plugins/selected_text/src/index.ts#L52


						newCells.push(newContent);
					}
					newLines.push(newCells.join(' | '));
				}
				await joplin.commands.execute('replaceSelection', newLines.join('\n'));
			},
		});
		
		joplin.views.toolbarButtons.create('prettyMarkdownTable', ToolbarButtonLocation.EditorToolbar);
	},
});

so i'm sure code for command works properly.

Any ideas?

EDIT: i'm trying desktop app, is extending menus/toolbars in desktop available?

ambrt · 11 November 2020 19:09

On version 1.4.7 same error.

laurent · 11 November 2020 20:28

Thanks for the detailed report, I'll check

ambrt · 11 November 2020 21:15

Just to note, error in console is pointing to this line in reducer.ts

github.com

laurent22/joplin/blob/cc07016b07bd83dd8d38fba392b7aad8eaf2ca6d/packages/lib/services/plugins/reducer.ts#L98


		return infos
			.filter((info:ViewInfo) => info.view.location === toolbarType)
			.map((info:ViewInfo) => info.view.commandName);
	},
};
const reducer = (draft: Draft<any>, action:any) => {
	if (action.type.indexOf('PLUGIN_') !== 0) return;
	// All actions should be scoped to a plugin, except when adding a new plugin
	if (!action.pluginId && action.type !== 'PLUGIN_ADD') throw new Error(`action.pluginId is required. Action was: ${JSON.stringify(action)}`);
	try {
		switch (action.type) {
		case 'PLUGIN_ADD':
			if (draft.pluginService.plugins[action.plugin.id]) throw new Error(`Plugin is already loaded: ${JSON.stringify(action)}`);
			draft.pluginService.plugins[action.plugin.id] = action.plugin;
			break;

ambrt · 11 November 2020 21:52

Found it.
EDIT:For those who would have same problem,solution is to NOT adding trailing slash to path of the plugin

filename with basename path utils will return empty string when path to plugin ends with slash.
pluginId is generated with filename(path) here:

github.com

laurent22/joplin/blob/31ffd8d7e99bd800c29671d72ddaf0a3065fd634/packages/lib/services/plugins/PluginService.ts#L107


		let distPath = path;
		if (!(await fsDriver.exists(`${distPath}/manifest.json`))) {
			distPath = `${path}/dist`;
		}
		this.logger().info(`PluginService: Loading plugin from ${path}`);
		const scriptText = await fsDriver.readFile(`${distPath}/index.js`);
		const manifestText = await fsDriver.readFile(`${distPath}/manifest.json`);
		const pluginId = makePluginId(filename(path));
		return this.loadPlugin(pluginId, distPath, manifestText, scriptText);
	}
	private async loadPlugin(pluginId:string, baseDir:string, manifestText:string, scriptText:string):Promise<Plugin> {
		const manifest = manifestFromObject(JSON.parse(manifestText));
		// After transforming the plugin path to an ID, multiple plugins might end up with the same ID. For
		// example "MyPlugin" and "myplugin" would have the same ID. Technically it's possible to have two
		// such folders but to keep things sane we disallow it.

but doing filename("/home/user/plugin/') will produce empty string.

github.com

laurent22/joplin/blob/31ffd8d7e99bd800c29671d72ddaf0a3065fd634/packages/lib/path-utils.ts#L12-L26


export function basename(path:string) {
	if (!path) throw new Error('Path is empty');
	const s = path.split(/\/|\\/);
	return s[s.length - 1];
}
export function filename(path:string, includeDir:boolean = false) {
	if (!path) throw new Error('Path is empty');
	const output = includeDir ? path : basename(path);
	if (output.indexOf('.') < 0) return output;
	const splitted = output.split('.');
	splitted.pop();
	return splitted.join('.');
}

from basename()

var path="/asdf/foo/";	var s = path.split(/\/|\\/);
	 s[s.length - 1];
""
var path="/asdf/foo";	var s = path.split(/\/|\\/);
	 s[s.length - 1];
"foo"

laurent · 13 November 2020 22:04

Thanks for the info, it's fixed here now: https://github.com/laurent22/joplin/commit/918b76863443f4f3e5f683005c4a3ae50b69189e

Topic		Replies	Views
Coding Phase - Week 2 Report Default Plugin Support gsoc-2022 , weekly , report	13	678	30 June 2022
Prompt when the plugin is running `TypeError: this.module_.onInit is not a function` Plugins	15	1145	4 September 2021
The new AppImage (Joplin-1.0.177.AppImage) installation issues Support	22	3365	31 January 2020
No more launching appImage applications at startup after update 24.04 Support	10	520	9 August 2024
First steps in plugin development Plugins	9	1262	23 January 2021

"Error: action.pluginId is required" when trying to add menu or toolbar item

Related topics