Add debug logging for dataset list route

[MichaelBuessemeyer]

Currently the route https://webknossos.org/api/datasets?isActive=false is broken and the bug is not reproducible in a dev environment. Thus, this pr adds logging to that route to give further hints about the causes of the bug.

Steps to test:

• should not be necessary; but in case you want to: Spin up a local serve, request http://localhost:9000/api/datasets?isActive=false => the server console should show more extensive logging

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing logging and error handling within the DatasetController and Dataset classes. In DatasetController, the list method now includes improved logging of parameters and dataset counts, alongside refined error messages for failures. The Dataset class sees enhanced error reporting in its parsing functions, with clearer messages for various configurations. Overall, the modifications aim to improve traceability and maintainability of the code while preserving existing functionalities.

Changes

File Path	Change Summary
app/controllers/DatasetController.scala	- Enhanced logging in list method with parameters and dataset count. - Improved error handling with descriptive messages in list method. - No changes to removeFromThumbnailCache, thumbnail, exploreRemoteDataset, or exploreAndAddRemoteDataset methods.
app/models/dataset/Dataset.scala	- Added error messages to parsing functions for voxel size, default view, admin view, and metadata. - Minor logging adjustments in findAllWithSearch and findAllCompactWithSearch methods. - Enhanced error handling in parseAll method.

Possibly related PRs

• Log data loading errors in conversion / mapping application #8202: The changes in this PR enhance error logging during data loading processes, which aligns with the main PR's focus on improving error handling and logging in the list method of the DatasetController.

Poem

🐰 In the code where datasets play,
Errors now have much to say.
With logs that tell of what went wrong,
Our parsing's now robust and strong.
Hooray for clarity, let’s all cheer,
For datasets handled without fear! 🥕

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

app/controllers/DatasetController.scala (1)

179-220: LGTM! The logging implementation effectively captures the dataset listing process.

The added logging statements provide valuable debug information:

1. Input parameters logging helps track the request parameters.
2. Dataset count logging helps verify the query results.

This implementation aligns well with the PR objective of debugging the isActive=false route issue.

Consider adding error logging in the error paths to capture failure scenarios. For example:

 datasets <- datasetDAO.findAllWithSearch(isActive,
                                        isUnreported,
                                        organizationIdOpt,
                                        folderIdValidated,
                                        uploaderIdValidated,
                                        searchQuery,
                                        recursive.getOrElse(false),
                                        limit) ?~> "dataset.list.failed" ?~> "Dataset listing failed"
+_ = if (datasets.isEmpty) {
+  logger.warn(s"No datasets found for the given parameters")
+}
 _ = logger.info(s"Found ${datasets.size} datasets successfully")

app/models/dataset/Dataset.scala (1)

223-227: Enhance the second log message with more context

While the logging additions are helpful for debugging, the second log message "Requesting datasets with query" could be more informative.

Consider adding more context to the second log message:

-      _ = logger.info("Requesting datasets with query")
+      _ = logger.info(s"Executing dataset query with limit ${limitOpt.getOrElse("none")}")

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7206862 and f0b1b2f.

📒 Files selected for processing (2)

• app/controllers/DatasetController.scala (1 hunks)
• app/models/dataset/Dataset.scala (2 hunks)

🔇 Additional comments (1)

app/models/dataset/Dataset.scala (1)

118-125: LGTM: Improved error messages for better debugging

The addition of specific error messages for each parsing operation enhances debugging capabilities and error traceability. The messages are clear and follow a consistent pattern.

[fm3]

LGTM. We’ll need to remove the logging again after we solve this of course :)