Compute and show code coverage reports

[surchs]

We have a nice test suite, we should have a coverage report. This should help: https://docs.cypress.io/guides/tooling/code-coverage

TODO:

• Setup coverage with cypress
• have a coverage report as part of the PR (like we do for python tools), e.g. codecov
• show the coverage badge on the README

[github-actions]

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 75 days.
We have applied the _flag:stale label to indicate that this issue should be reviewed again.
When you review, please reread the spec and then apply one of these three options:

• prioritize: apply the flag:schedule label to suggest moving this issue into the backlog now
• close: if the issue is no longer relevant, explain why (give others a chance to reply) and then close.
• archive: sometimes an issue has important information or ideas but we won't work on it soon. In this case
  apply the someday label to show that this won't be prioritized. The stalebot will ignore issues with this
  label in the future. Use sparingly!

[willtryagain]

Hi,

while installing code-coverage I am getting this error. Please guide how to proceed.

'Log files:
/home/a/.npm/_logs/2024-03-12T17_22_42_094Z-debug-0.log

npm resolution error report

While resolving: [email protected]
Found: [email protected]
node_modules/webpack
webpack@"^4.47.0" from the root project
peer webpack@"^4 || ^5" from @cypress/[email protected]
node_modules/@cypress/code-coverage
dev @cypress/code-coverage@"*" from the root project

Could not resolve dependency:
peer webpack@">=5" from [email protected]
node_modules/babel-loader
peer babel-loader@"^8.3 || ^9" from @cypress/[email protected]
node_modules/@cypress/code-coverage
dev @cypress/code-coverage@"*" from the root project

Fix the upstream dependency conflict, or retry
this command with --force or --legacy-peer-deps
to accept an incorrect (and potentially broken) dependency resolution.

[rmanaem]

Hi @willtryagain
Thanks for looking into this.
I believe we've come across this dependency conflict before while trying to set up code coverage. The annotation tool uses Nuxt 2 which uses Webpack 4 for its build process and since there is no official support for Webpack 5, upgrading is not an option see nuxt/nuxt#20055 (comment).
We plan to address this issue after transitioning the tool to React see neurobagel/query-tool#62.

As a side note If you'd like to work on an issue please ping one of the maintainers to let us know so we can avoid conflicts and give you the required context. For more information on how to contribute checkout the Neurobagel contributing guide.

[github-actions]

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 75 days.
We have applied the _flag:stale label to indicate that this issue should be reviewed again.
When you review, please reread the spec and then apply one of these three options:

• prioritize: apply the flag:schedule label to suggest moving this issue into the backlog now
• close: if the issue is no longer relevant, explain why (give others a chance to reply) and then close.
• archive: sometimes an issue has important information or ideas but we won't work on it soon. In this case
  apply the someday label to show that this won't be prioritized. The stalebot will ignore issues with this
  label in the future. Use sparingly!