Skip to content

fix: Fix map call in report creation#3509

Merged
johanneskoester merged 1 commit into
mainfrom
fxwiegand-patch-1
Apr 3, 2025
Merged

fix: Fix map call in report creation#3509
johanneskoester merged 1 commit into
mainfrom
fxwiegand-patch-1

Conversation

@fxwiegand

@fxwiegand fxwiegand commented Apr 2, 2025

Copy link
Copy Markdown
Contributor

This pull request includes a small but important fix to the src/snakemake/report/html_reporter/template/components/abstract_results.js file. The change corrects the mapping of data.toggleLabels.keys() to ensure proper retrieval of toggle states.

Summary by CodeRabbit

  • Refactor
    • Streamlined the internal handling of display data to enhance efficiency without affecting the current user experience.

@coderabbitai

coderabbitai Bot commented Apr 2, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

The change updates the construction of the toggleLabels array within the renderEntries method of the AbstractResults class. The updated implementation separates key extraction from value mapping when accessing state.toggles, thereby simplifying the logic without altering the overall functionality.

Changes

File Change Summary
src/snakemake/.../abstract_results.js Modified the toggleLabels construction in the renderEntries method by separating key extraction from mapping to state.toggles.

Possibly related PRs

Suggested labels

WIP

Suggested reviewers

  • johanneskoester
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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 coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/snakemake/report/html_reporter/template/components/abstract_results.js (1)

285-285: Simplify and Unify Toggle State Mapping

The updated mapping correctly converts the iterator from data.toggleLabels.keys() into an array and then retrieves the corresponding toggle value from state.toggles, which addresses the earlier mapping issue.

A couple of suggestions:

  • Consistency & Readability: While using Array.from is perfectly acceptable, you might also consider using the spread operator (e.g., [...data.toggleLabels.keys()]) for readability and consistency if that pattern is used elsewhere in the codebase.
  • DRY Principle: Note that similar mapping logic appears in the toggleCallback method (line 101). Consider extracting this mapping into a dedicated helper function to avoid duplication and ease future modifications.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 01ab732 and 8a68ba3.

📒 Files selected for processing (1)
  • src/snakemake/report/html_reporter/template/components/abstract_results.js (1 hunks)

@johanneskoester johanneskoester merged commit 287920d into main Apr 3, 2025
@johanneskoester johanneskoester deleted the fxwiegand-patch-1 branch April 3, 2025 08:19
johanneskoester pushed a commit that referenced this pull request Apr 3, 2025
🤖 I have created a release *beep* *boop*
---


##
[9.1.6](v9.1.5...v9.1.6)
(2025-04-03)


### Bug Fixes

* Fix map call in report creation
([#3509](#3509))
([287920d](287920d))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
This pull request includes a small but important fix to the
`src/snakemake/report/html_reporter/template/components/abstract_results.js`
file. The change corrects the mapping of `data.toggleLabels.keys()` to
ensure proper retrieval of toggle states.

*
[`src/snakemake/report/html_reporter/template/components/abstract_results.js`](diffhunk://#diff-9dc0845743ccae31714e1a4ea05bbe7e6ddf11d4859779dd6bb74c2122a58593L285-R285):
Fixed the mapping of `data.toggleLabels.keys()` by removing an erroneous
`Array.from` call, which ensures correct toggle state retrieval.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Refactor**
- Streamlined the internal handling of display data to enhance
efficiency without affecting the current user experience.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
🤖 I have created a release *beep* *boop*
---


##
[9.1.6](snakemake/snakemake@v9.1.5...v9.1.6)
(2025-04-03)


### Bug Fixes

* Fix map call in report creation
([snakemake#3509](snakemake#3509))
([287920d](snakemake@287920d))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
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