Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dont crash job list for unknown jobs #8300

Merged
merged 10 commits into from
Jan 13, 2025

Conversation

knollengewaechs
Copy link
Contributor

@knollengewaechs knollengewaechs commented Jan 3, 2025

Steps to test:

  • Go to "Processing Jobs" page
  • Make sure the test_me job (inserted in the code to mock a job of an unknown type) looks okay and does not crash the page
  • Only unknown job types should have snake cased job descriptions -> look at train_model and infer_with_model jobs and make sure the new description is useful
  • for train_model jobs, check clicking the training annotations

TODOs:

  • improve wording for all job descriptions:
    • maybe include "Show Training Data"
    • use present tense everywhere
    • infer_with_model: "AI segmentation"
    • show "result" for unknown jobs if they have a result link

Issues:


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

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

📝 Walkthrough

Walkthrough

This pull request introduces several improvements to the WEBKNOSSOS platform, focusing on job management, AI model training, and user interface enhancements. The changes primarily address issues with job listing, particularly for unknown job types, and improve the rendering of job descriptions. The modifications include adding a new function to handle training data links, updating job type descriptions, and preventing crashes in the processing jobs list when encountering deleted job types.

Changes

File Change Summary
frontend/javascripts/admin/api/jobs.ts Added a test job object to the getJobs function for testing purposes
frontend/javascripts/admin/job/job_list_view.tsx Added getShowTrainingDataLink function, modified job description rendering for different job types
frontend/javascripts/admin/voxelytics/ai_model_list_view.tsx Updated rendering of training data links using the new getShowTrainingDataLink function

Assessment against linked issues

Objective Addressed Explanation
Prevent job list crash for unknown jobs [#8066]
Improve rendering for infer_with_model job type [#8066]

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • philippotto

Poem

🐰 In the realm of code, where jobs once did crash,
A rabbit hops in with a fix so brash!
No more unknown types to make us fret,
With clever changes, our system's now set!
Hop, skip, and jump through the job list we'll go! 🚀

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

conf/application.conf Outdated Show resolved Hide resolved
@knollengewaechs knollengewaechs force-pushed the dont-crash-job-list-for-unknown-jobs branch from 35f1577 to 95aec18 Compare January 9, 2025 16:54
@knollengewaechs knollengewaechs marked this pull request as ready for review January 10, 2025 09:18
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 466ce63 and b3a7f48.

📒 Files selected for processing (4)
  • CHANGELOG.unreleased.md (1 hunks)
  • frontend/javascripts/admin/api/jobs.ts (1 hunks)
  • frontend/javascripts/admin/job/job_list_view.tsx (5 hunks)
  • frontend/javascripts/admin/voxelytics/ai_model_list_view.tsx (2 hunks)
🔇 Additional comments (5)
frontend/javascripts/admin/voxelytics/ai_model_list_view.tsx (1)

180-180: LGTM! Good refactoring.

The change improves code maintainability by reusing the centralized getShowTrainingDataLink function.

frontend/javascripts/admin/job/job_list_view.tsx (3)

63-105: LGTM! Well-structured utility function.

The function effectively handles different cases:

  • Null check for missing annotations
  • Modal for multiple annotations
  • Direct link for single annotation

262-262: LGTM! Consistent verb tense.

Changed to present tense to align with other job descriptions.


Line range hint 280-395: LGTM! Improved job description handling.

The changes:

  1. Add proper support for TRAIN_MODEL and INFER_WITH_MODEL jobs
  2. Improve handling of unknown job types by showing both result link and text
CHANGELOG.unreleased.md (1)

50-50: LGTM! Clear changelog entry.

The entry accurately describes the fix implemented in the code.

frontend/javascripts/admin/api/jobs.ts Outdated Show resolved Hide resolved
Copy link
Member

@philippotto philippotto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool, lgtm :) don't forget to remove the dev-related code.

@knollengewaechs knollengewaechs enabled auto-merge (squash) January 13, 2025 09:54
@knollengewaechs knollengewaechs merged commit 17ac2c9 into master Jan 13, 2025
3 checks passed
@knollengewaechs knollengewaechs deleted the dont-crash-job-list-for-unknown-jobs branch January 13, 2025 10:02
@knollengewaechs knollengewaechs mentioned this pull request Jan 13, 2025
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Don't crash job list for unknown jobs and improve infer_with_model rendering
2 participants