When jobsEnabled=False, send empty jobsSupportedByAvailableWorkers list

[fm3]

Making the situation for frontend job checks simpler.

Steps to test:

• yarn enable-jobs
• check that dataset json includes jobsSupportedByAvailableWorkers list
• in application.conf, set features.jobsEnabled=false
• now the list sent to the frontend should be empty

Issues:

• fixes dataStore.jobsSupportedByAvailableWorkers should be empty when jobsEnabled=false #8306

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies the publicWrites method in the DataStore.scala file to conditionally return job data based on the conf.Features.jobsEnabled configuration flag. When the flag is false, the method will return an empty list instead of the original jobsSupportedByAvailableWorkers data. This change ensures that no job-related database content is sent to the frontend when jobs are disabled.

Changes

File	Change Summary
app/models/dataset/DataStore.scala	Modified publicWrites method to conditionally return jobs based on conf.Features.jobsEnabled flag

Assessment against linked issues

Objective	Addressed	Explanation
Jobs should be empty when jobsEnabled=false [#8306]	✅

Possibly related PRs

• Dont crash job list for unknown jobs #8300: Changes related to job type handling and preventing job list crashes

Suggested reviewers

• philippotto

Poem

🐰 In the realm of data's dance,
A flag decides the job's advance
Empty or full, the list will be
Controlled by config's decree
A rabbit's logic, swift and light! 🔧

---

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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

75-76: Optimize performance and improve maintainability.

The current implementation fetches the workers list even when jobs are disabled. Consider these improvements:

1. Skip fetching workers when jobs are disabled
2. Extract the condition into a variable to avoid repetition

Here's a suggested refactoring:

  def publicWrites(dataStore: DataStore): Fox[JsObject] =
    for {
-     jobsSupportedByAvailableWorkers <- jobService.jobsSupportedByAvailableWorkers(dataStore.name)
-     jobsEnabled = conf.Features.jobsEnabled && jobsSupportedByAvailableWorkers.nonEmpty
+     jobsSupportedByAvailableWorkers <- if (conf.Features.jobsEnabled) {
+       jobService.jobsSupportedByAvailableWorkers(dataStore.name)
+     } else {
+       Fox.successful(List.empty)
+     }
+     jobsEnabled = jobsSupportedByAvailableWorkers.nonEmpty
    } yield
      Json.obj(
        "name" -> dataStore.name,
        "url" -> dataStore.publicUrl,
        "allowsUpload" -> dataStore.allowsUpload,
-       "jobsSupportedByAvailableWorkers" -> Json.toJson(
-         if (conf.Features.jobsEnabled) jobsSupportedByAvailableWorkers else List.empty),
+       "jobsSupportedByAvailableWorkers" -> Json.toJson(jobsSupportedByAvailableWorkers),
        "jobsEnabled" -> jobsEnabled
      )

This refactoring:

1. Avoids unnecessary database queries when jobs are disabled
2. Eliminates the repeated condition check
3. Maintains the same behavior while being more efficient

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2704f0b and 31eb2ad.

📒 Files selected for processing (1)

• app/models/dataset/DataStore.scala (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: circleci_build

🔇 Additional comments (1)

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

75-76: Implementation aligns with PR objectives.

The changes correctly implement the requirement to send an empty list when jobs are disabled. The code properly handles the configuration flag and maintains the expected behavior described in the PR objectives.

[MichaelBuessemeyer]

Looks good and works even greater 👷