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

Fix processing job list #8323

Merged
merged 9 commits into from
Jan 21, 2025
Merged

Fix processing job list #8323

merged 9 commits into from
Jan 21, 2025

Conversation

knollengewaechs
Copy link
Contributor

@knollengewaechs knollengewaechs commented Jan 13, 2025

follow-up for #8300: sometimes, the fallback string was still shown as job description. this was due to unnecessary checks and changes in the backend.

URL of deployed dev instance (not really used for testing because jobs are disabled)

Steps to test:

  • Go to processing job list and check that it still looks nice.
  • Check that a description is rendered for train_model and infer_with_model
  • Check that the links to the datasets are working

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

@knollengewaechs knollengewaechs self-assigned this Jan 13, 2025
Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

📝 Walkthrough

Walkthrough

The pull request introduces improvements to job management in the frontend, focusing on two main files: jobs.ts and job_list_view.tsx. The changes enhance the logic for determining organization and dataset links, and correct the sorting mechanism for jobs. The modifications aim to improve data handling robustness and code clarity by introducing a new function for dataset link generation and refining the job transformation and sorting processes.

Changes

File Change Summary
frontend/javascripts/admin/api/jobs.ts - Updated transformBackendJobToAPIJob to include fallback mechanisms for organizationId and layerName
- Corrected sorting logic in getJobs to properly sort jobs by createdAt timestamp
frontend/javascripts/admin/job/job_list_view.tsx - Added getLinkToDataset function to centralize dataset link generation logic
- Simplified renderDescription function by using the new link generation method

Possibly related PRs

Suggested labels

bug, frontend, refactoring

Suggested reviewers

  • hotzenklotz
  • philippotto

Poem

🐰 Hop, hop, through the code we go,
Sorting jobs with a magical flow
Links now clear, organization neat
Refactoring makes our logic sweet
A rabbit's touch of frontend delight! 🚀


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 78319d5 and cf72867.

📒 Files selected for processing (1)
  • frontend/javascripts/admin/api/jobs.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/javascripts/admin/api/jobs.ts

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.

@knollengewaechs knollengewaechs changed the title FIx processing job list Fix processing job list Jan 13, 2025
Comment on lines 154 to 155
jobsEnabled = false
voxelyticsEnabled = false
Copy link
Contributor Author

Choose a reason for hiding this comment

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

remove before merging

@knollengewaechs knollengewaechs marked this pull request as ready for review January 13, 2025 16:46
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: 0

🔭 Outside diff range comments (1)
frontend/javascripts/admin/api/jobs.ts (1)

Line range hint 46-50: Fix the sorting order in getJobs.

The current sorting logic is incorrect. Using > will sort in ascending order (oldest first), but the comment indicates "Newest jobs should be first".

Apply this fix:

   return (
     jobs
       .map(transformBackendJobToAPIJob)
       // Newest jobs should be first
-      .sort((a: APIJob, b: APIJob) => a.createdAt > b.createdAt)
+      .sort((a: APIJob, b: APIJob) => (a.createdAt < b.createdAt ? 1 : -1))
   );
🧹 Nitpick comments (2)
frontend/javascripts/admin/job/job_list_view.tsx (2)

160-167: LGTM! Clean extraction of link generation logic.

The function effectively centralizes the dataset link generation logic with clear precedence rules.

Consider adding a type for the return value to make it explicit:

-  function getLinkToDataset(job: APIJob) {
+  function getLinkToDataset(job: APIJob): string | null {

Line range hint 170-275: Consider adding error boundaries for link rendering.

The code assumes that link generation and rendering will always succeed when linkToDataset is not null. Consider wrapping the link rendering in error boundaries to gracefully handle any runtime errors.

Example implementation:

function SafeLink({ to, children }: { to: string; children: React.ReactNode }) {
  try {
    return <Link to={to}>{children}</Link>;
  } catch (error) {
    console.error('Error rendering link:', error);
    return <span>{children}</span>;
  }
}

Then use it in the render functions:

-          <Link to={linkToDataset}>{job.datasetName}</Link>
+          <SafeLink to={linkToDataset}>{job.datasetName}</SafeLink>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cc877f9 and 8294852.

📒 Files selected for processing (2)
  • frontend/javascripts/admin/api/jobs.ts (1 hunks)
  • frontend/javascripts/admin/job/job_list_view.tsx (6 hunks)
🔇 Additional comments (1)
frontend/javascripts/admin/api/jobs.ts (1)

24-25: Keep only the organizationId change.

According to the PR objectives, only the organizationId fallback is needed. The layerName change appears to be unrelated to the current issue.

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.

great, please remove the dev-related changes before merging!

@knollengewaechs knollengewaechs enabled auto-merge (squash) January 21, 2025 09:55
@knollengewaechs knollengewaechs merged commit eb1423c into master Jan 21, 2025
3 checks passed
@knollengewaechs knollengewaechs deleted the show-more-job-descriptions branch January 21, 2025 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants