Installing (uploading plugin) from nodejs

[giorgosp]

Hello, I'm trying to upload a plugin using nodejs, replicating the python cli's functionality. I think I'm replicating the http request correctly, but the plugin is not registered. In fact, the Canvas API returns a 200 status code, which is even more confusing and makes it harder to debug the problem.

I’m using webhook.site to inspect the HTTP requests.
Here’s what my HTTP request to upload the plugin looks like https://webhook.site/#!/view/6d07c2bd-8579-4b28-b8e5-5b63d21e1964/4c8207ab-7a2b-4c32-a216-9d4f86173834/1
And here’s how the HTTP request from your python cli looks like https://webhook.site/#!/view/6d07c2bd-8579-4b28-b8e5-5b63d21e1964/f2b5aae9-d962-416d-ad3f-b923653a83dd/1

Can the Canvas Medical team spot any issue in my http request maybe?

Thank you!

[beaugunderson]

From your webhook.site requests it looks like your Axios attempt posted to / and not to /plugin-io/plugins/, can you verify that piece? I don't think there's any reason why you shouldn't be able to accomplish this in Node. I assume you're operating in an environment with no Python? :)

[giorgosp]

Our platform is built on node so ideally I want to make this request from node.

I do use the correct path, I just replaced the full url with webhook.site for the test. In fact, with my code, I do get a 200 response back with a list of installed plugins, but it only shows the plugins I have installed through the cli and not the axios request.

So I'm still not sure what is wrong with the axios request.

[beaugunderson]

Not sure if you found this code yet but it may be helpful to you if you were just inspecting the request before:

canvas-plugins/canvas_cli/apps/plugin/plugin.py

Lines 171 to 224 in 5c4be8f

	def install(
	plugin_name: Path = typer.Argument(..., help="Path to plugin to install"),
	host: str | None = typer.Option(
	callback=get_default_host,
	help="Canvas instance to connect to",
	default=None,
	),
	) -> None:
	"""Install a plugin into a Canvas instance."""
	if not host:
	raise typer.BadParameter("Please specify a host or add one to the configuration file")
	token = get_or_request_api_token(host)
	if not plugin_name.exists():
	raise typer.BadParameter(f"Plugin '{plugin_name}' does not exist")
	if plugin_name.is_dir():
	validate_manifest(plugin_name)
	built_package_path = _build_package(plugin_name)
	else:
	raise typer.BadParameter(f"Plugin '{plugin_name}' needs to be a valid directory")
	print(f"Installing plugin: {built_package_path} into {host}")
	url = plugin_url(host)
	print(f"Posting {built_package_path.absolute()} to {url}")
	try:
	with open(built_package_path, "rb") as package:
	r = requests.post(
	url,
	data={"is_enabled": True},
	files={"package": package},
	headers={"Authorization": f"Bearer {token}"},
	)
	except requests.exceptions.RequestException:
	print(f"Failed to connect to {host}")
	raise typer.Exit(1) from None
	if r.status_code == requests.codes.created:
	print(f"Plugin {plugin_name} successfully installed!")
	# If we got a conflict, means there's a duplicate plugin and install can't handle that.
	# So we need to get the plugin-name from the package and call `update` directly
	elif r.status_code == requests.codes.conflict and (
	package_name := _get_name_from_metadata(host, token, built_package_path)
	):
	print(f"Plugin {package_name} already exists, updating instead...")
	update(package_name, built_package_path, is_enabled=True, host=host)
	else:
	print(f"Status code {r.status_code}: {r.text}")
	raise typer.Exit(1)

[giorgosp]

Yep! I used this as inspiration