Allow for the deletion of workflow reports

frcroth commented 2 weeks ago

URL of deployed dev instance (used for testing):

https://___.webknossos.xyz

Steps to test:

Start a workflow
Delete the workflow by clicking on the workflow and then on the three dots menu selecting Delete Workflow report.
Notice it is no longer in the list
(Note that there is nothing in the database)

Questions

It is possible to delete the workflow while it is running. Should this be disabled? This causes the workflow to fail, more or less as expected. It does not seem like anything breaks.
Since this is only for super users, should the button in the frontend be only available for super users (disabled / not shown?)

TODOs:

[ ] ...

Issues:

fixes #7973

(Please delete unneeded items, merge only when none are left open)

[x] Updated changelog
[ ] Removed dev-only changes like prints and application.conf edits
- I have on logger statement in the deletion route. I think that could remain?
[ ] Considered common edge cases

Summary by CodeRabbit

Release Notes

New Features
- Added the ability to add metadata to annotations for Trees and Segments.
- Enhanced search functionality to find unnamed segments using their default names.
- Introduced a new button in the search popover for selecting all matching non-group results.
- Added a summary row in the time tracking overview.
- Unified UI terminology by replacing "Resolution" with "Magnification."
- Support for remote OME-Zarr NGFF version 0.5 datasets.
- Users can now delete workflow reports and workflows directly from the application.
- Admins can view and cancel all jobs with job ownership displayed.
Bug Fixes
- Resolved issues with dataset uploads and bbox export menu.
- Fixed automatic expansion of groups in skeleton searches and zarr streaming version corrections.
- Ensured insufficient sharing tokens are discarded appropriately.
Chores
- Migrated nightly screenshot tests from CircleCI to GitHub Actions.

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces a new feature for deleting workflows in the Voxelytics section of the application, including both backend and frontend components. Key changes involve the addition of methods for deleting workflows in the VoxelyticsController and VoxelyticsDAO, a new DELETE route for workflows, and a corresponding frontend function for invoking the delete action. The changelog has been updated to reflect these changes along with other enhancements and bug fixes across the application.

Changes

File Path	Change Summary
CHANGELOG.unreleased.md	Updated to include new features, changes, fixes, and a note on breaking changes.
app/controllers/VoxelyticsController.scala	Added `deleteWorkflow` method; injected `UserService` for user-related operations.
app/models/voxelytics/VoxelyticsDAO.scala	Introduced `deleteWorkflow` method for deleting workflows and updating related jobs in the database.
conf/webknossos.latest.routes	Added new DELETE route `/voxelytics/workflows/:workflowHash` for workflow deletion.
frontend/javascripts/admin/admin_rest_api.ts	Added `deleteWorkflow` function to send DELETE requests for workflow deletion.
frontend/javascripts/admin/voxelytics/task_list_view.tsx	Introduced `deleteWorkflowReport` function for user-initiated deletion of workflow reports with confirmation.

Assessment against linked issues

Objective	Addressed	Explanation
Allow to delete/archive voxelytics workflow reports (#7973)	✅

Possibly related PRs

8155: This PR allows downloading tasks of teams users are not in, which relates to the overall functionality improvements in the application, including user permissions and access to annotations.
8164: This PR enables the deletion of bounding boxes regardless of the visibility of segmentation layers, which is a direct enhancement to the annotation management features mentioned in the main PR.

Suggested labels

bug, backend, frontend

Poem

In the land of Voxelytics, workflows take flight,
With a click and a confirmation, they vanish from sight.
A hop and a skip, the changes are here,
Deleting reports brings us all cheer!
So let’s celebrate with a joyful little dance,
For every new feature, we give it a chance! 🐇✨

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Reviewing files that changed from the base of the PR and between 54037c7b760b1003abbabe8271d4ea818d423fff and 114ff786dc4f8ffc4d8c267fd2c708ae76726d75.

📒 Files selected for processing (2)

* `CHANGELOG.unreleased.md` (1 hunks) * `app/models/voxelytics/VoxelyticsDAO.scala` (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

* CHANGELOG.unreleased.md * app/models/voxelytics/VoxelyticsDAO.scala

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

fm3 commented 1 week ago

It is possible to delete the workflow while it is running. Should this be disabled? This causes the workflow to fail, more or less as expected. It does not seem like anything breaks.

I’d say that’s ok. Maybe include a warning in the deletion confirmation modal along the lines of “Note that if the workflow is still running, this may cause it to fail”. Can be a standard text, no need to figure out whether it is, in fact, still running. Thing is, I’m not sure if webknossos can reliably tell that a workflow was cancelled/killed. Sometimes it may appear to be still running in wk, while the vx process is already killed.

Since this is only for super users, should the button in the frontend be only available for super users (disabled / not shown?)

That’s right, it should not be shown for non-superusers. Maybe dieknolle3333 can give you some pointers as to how to achieve this.

scalableminds / webknossos