Skip to content

fix: Fix map call in report creation#3503

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

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

Conversation

@fxwiegand

@fxwiegand fxwiegand commented Apr 1, 2025

Copy link
Copy Markdown
Contributor

This pull request includes a small change to the src/snakemake/report/html_reporter/template/components/abstract_results.js file. The change corrects the syntax for mapping over data.toggleLabels.keys() to ensure proper functionality.

  • Corrected the syntax for mapping over data.toggleLabels.keys() in the AbstractResults class.

Summary by CodeRabbit

  • Refactor
    • Streamlined the internal process for constructing toggle labels to improve clarity without affecting the app’s behavior or user experience.

@coderabbitai

coderabbitai Bot commented Apr 1, 2025

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This pull request refactors the toggleCallback method in the AbstractResults class. The update changes how toggleLabels are built by separating the process into two steps: first extracting the keys of data.toggleLabels into an array, and then mapping them to their corresponding toggle states from _this.state.toggles. The overall behavior and control flow remain unchanged, and no modifications were made to any exported entities.

Changes

File Change Summary
src/snakemake/.../abstract_results.js Refactored toggleCallback: replaced the chained Array.from().map() expression with a two-step process to separately extract keys and map to toggle states.

Possibly related PRs


📜 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 62bbbf5 and e26a4e1.

📒 Files selected for processing (1)
  • src/snakemake/report/html_reporter/template/components/abstract_results.js (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (34)
  • GitHub Check: tests (10, windows-latest, py312)
  • GitHub Check: tests (10, ubuntu-latest, py312)
  • GitHub Check: tests (10, ubuntu-latest, py311)
  • GitHub Check: tests (9, windows-latest, py312)
  • GitHub Check: tests (9, ubuntu-latest, py312)
  • GitHub Check: tests (9, ubuntu-latest, py311)
  • GitHub Check: tests (8, windows-latest, py312)
  • GitHub Check: tests (8, ubuntu-latest, py312)
  • GitHub Check: tests (8, ubuntu-latest, py311)
  • GitHub Check: tests (7, windows-latest, py312)
  • GitHub Check: tests (7, ubuntu-latest, py312)
  • GitHub Check: tests (7, ubuntu-latest, py311)
  • GitHub Check: tests (6, windows-latest, py312)
  • GitHub Check: tests (6, ubuntu-latest, py312)
  • GitHub Check: tests (6, ubuntu-latest, py311)
  • GitHub Check: tests (5, windows-latest, py312)
  • GitHub Check: tests (5, ubuntu-latest, py312)
  • GitHub Check: tests (5, ubuntu-latest, py311)
  • GitHub Check: tests (4, macos-latest, py312)
  • GitHub Check: tests (4, windows-latest, py312)
  • GitHub Check: tests (4, ubuntu-latest, py312)
  • GitHub Check: tests (4, ubuntu-latest, py311)
  • GitHub Check: tests (3, windows-latest, py312)
  • GitHub Check: tests (3, ubuntu-latest, py312)
  • GitHub Check: tests (3, ubuntu-latest, py311)
  • GitHub Check: tests (2, macos-latest, py312)
  • GitHub Check: tests (2, windows-latest, py312)
  • GitHub Check: tests (2, ubuntu-latest, py312)
  • GitHub Check: tests (2, ubuntu-latest, py311)
  • GitHub Check: tests (1, macos-latest, py312)
  • GitHub Check: tests (1, windows-latest, py312)
  • GitHub Check: tests (1, ubuntu-latest, py312)
  • GitHub Check: tests (1, ubuntu-latest, py311)
  • GitHub Check: formatting
🔇 Additional comments (1)
src/snakemake/report/html_reporter/template/components/abstract_results.js (1)

101-101: Correct fix for the keys() iterator issue!

The updated code correctly separates the operation into two steps: first converting the iterator from data.toggleLabels.keys() to an array using Array.from(), and then applying the map() function. This is the proper way to handle JavaScript iterators since map() is an array method and cannot be called directly on iterators.

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

@johanneskoester johanneskoester merged commit 44754cc into main Apr 1, 2025
@johanneskoester johanneskoester deleted the fxwiegand-patch-1 branch April 1, 2025 12:45
johanneskoester pushed a commit that referenced this pull request Apr 1, 2025
🤖 I have created a release *beep* *boop*
---


##
[9.1.4](v9.1.3...v9.1.4)
(2025-04-01)


### Bug Fixes

* Fix map call in report creation
([#3503](#3503))
([44754cc](44754cc))
* in the report, do not render toggle labels if there is more than one
label eligible for a toggle
([#3502](#3502))
([3be8ca9](3be8ca9))
* only inform about storage cleanup in case of --verbose mode
([#3494](#3494))
([62bbbf5](62bbbf5))
* provide causing rule to workflow error during checkpoint handling
([#3499](#3499))
([b4cbe5d](b4cbe5d))
* rerun-trigger regression
([#3492](#3492))
([811742d](811742d))


### Documentation

* note about parameter inheritance when using the "use rule with"
pattern ([#3500](#3500))
([8f6a8eb](8f6a8eb))

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

* Corrected the syntax for mapping over `data.toggleLabels.keys()` in
the `AbstractResults` class.

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

## Summary by CodeRabbit

- **Refactor**
- Streamlined the internal process for constructing toggle labels to
improve clarity without affecting the app’s behavior or 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.4](snakemake/snakemake@v9.1.3...v9.1.4)
(2025-04-01)


### Bug Fixes

* Fix map call in report creation
([snakemake#3503](snakemake#3503))
([44754cc](snakemake@44754cc))
* in the report, do not render toggle labels if there is more than one
label eligible for a toggle
([snakemake#3502](snakemake#3502))
([3be8ca9](snakemake@3be8ca9))
* only inform about storage cleanup in case of --verbose mode
([snakemake#3494](snakemake#3494))
([62bbbf5](snakemake@62bbbf5))
* provide causing rule to workflow error during checkpoint handling
([snakemake#3499](snakemake#3499))
([b4cbe5d](snakemake@b4cbe5d))
* rerun-trigger regression
([snakemake#3492](snakemake#3492))
([811742d](snakemake@811742d))


### Documentation

* note about parameter inheritance when using the "use rule with"
pattern ([snakemake#3500](snakemake#3500))
([8f6a8eb](snakemake@8f6a8eb))

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