Places in code assume that repo is a Github repo

[jennydaman]

ChRIS_store_ui/src/components/Plugin/components/PluginBody/PluginBody.jsx

Line 211 in 8b1c540

<a className="pf-m-link" href={`${pluginData.public_repo}/graphs/contributors`}>

We shouldn't make this assumption, might be hosted on better sites like Gitlab.

[zrthxn]

This assumption was made because in order to adapt this for different hosts (like gitlab, bitbucket, self-host etc) we'd need to have a different version of this component for each host's API, and that was needlessly complicated at the time.

This assumption is also made in the following places

ChRIS_store_ui/src/components/Plugin/components/PluginBody/PluginBody.jsx

Lines 55 to 62 in 8b1c540

	const fetchRepoData = useCallback(async (repo) => {
	const data = await fetch(`https://api.github.com/repos/${repo}`);
	if (!data.ok) throw new GithubAPIRepoError(repo, data);
	// Has to be done to avoid reassigning `data`
	// eslint-disable-next-line no-return-await
	return (await data.json());
	}, []);

ChRIS_store_ui/src/components/Plugin/components/PluginBody/PluginBody.jsx

Lines 42 to 53 in 8b1c540

	const fetchReadme = useCallback(async (repo) => {
	const ghreadme = await fetch(`https://api.github.com/repos/${repo}/readme`);
	if (!ghreadme.ok) throw new GithubAPIReadmeError(repo, ghreadme);
	// Has to be done since key is snake_case in data coming from Github
	// eslint-disable-next-line camelcase
	const { download_url, content } = await ghreadme.json();
	const file = Buffer.from(content, "base64").toString("utf8");
	const type = download_url.split('.').reverse().shift();
	return { file, type };
	}, []);

[jennydaman]

Thanks @zrthxn!

This issue is mostly for tracking purposes, it's good for now but somewhere down the line we'd like for the ChRIS store to support the functionality here (of storing and serving READMEs).

As you mentioned, self-hosted git repos will not be easy to support, and this can be a common use case (hospitals need to host private or proprietary plugins internally).

[sherrif10]

@jennydaman @zrthxn Am intrested in working on this task , is it ready for work

[jennydaman]

@sherrif10 thanks for showing interest in this issue!

The ideal solution (to have the README come from the ChRIS Store backend) would be hard to implement, but we can improve on the current implementation. We can try:

• get README from Github if (and only if) its public_repo is a github.com link
• show a pretty error screen if README cannot be obtained

[sherrif10]

Thanks @jennydaman will share a pull request for more guidance.