Skip to content

fix(story): ensure that the Model Codecs are always registered#749

Merged
tbouffard merged 1 commit intomainfrom
fix/story_load_codecs_after_global_unregistration
Apr 5, 2025
Merged

fix(story): ensure that the Model Codecs are always registered#749
tbouffard merged 1 commit intomainfrom
fix/story_load_codecs_after_global_unregistration

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented Apr 4, 2025 •
edited
Loading

Manually cleaning the codecs introduced side effects, and the Codecs were unavailable once a story was visited.
For example, display a story using the Model Codecs like Monitor story, then going to another story and displaying
the Monitor story again. In the latter, the model wasn't fill.

This was because ModelSerializer registers the Codecs but only once. If we unregistered the Codecs manually as we do
for stories, the ModelSerializer is currently unable to know it has to register the Codecs again (by forcing the registration).
The workaround is to force registration of Model Codecs before loading every story.

Summary by CodeRabbit

  • New Features
    • Enhanced the configuration reset process to ensure that all system components are reliably refreshed, providing a more stable and consistent experience.

@tbouffard
fix(story): ensure that the Model Codecs are always registered
083838e 
Manually cleaning the codecs introduced side effects, and the Codecs were unavailable once a story was visited.
For example, display a story using the Model Codecs like Monitoring story, then going to another story and displaying
the Monitoring story again. In the latter, the model wasn't fill.

This was because ModelSerializer registers the Codecs but only once. If we unregistered the Codecs manually as we do
for stories, the ModelSerializer is currently unable to know it has to register the Codecs again (by forcing the registration).
The workaround is to force registration of Model Codecs before loading every story.
@tbouffard tbouffard added the bug Something isn't working label Apr 4, 2025
@coderabbitai
Copy link

coderabbitai bot commented Apr 4, 2025 •
edited
Loading

Walkthrough

This change introduces the registerModelCodecs function into the Storybook preview configuration and invokes it within the resetMaxGraphConfigs function. The update ensures that model codecs are re-registered after the codec registry is reset. This approach works as a workaround for the missing unregisteredCodecs function, which would allow a more direct reset of the global codecs loading status. The overall functionality of resetting and reloading codecs remains preserved.

Changes

File Change Summary
packages/html/.storybook/preview.ts Added the registerModelCodecs function and its invocation within the resetMaxGraphConfigs function to force a reload of model codecs after the codec registry is reset. Comments explain this as a workaround for the missing unregisteredCodecs API.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ResetFunction as resetMaxGraphConfigs
    participant CodecRegistrar as registerModelCodecs
    participant ModelSerializer

    Caller->>ResetFunction: Call resetMaxGraphConfigs()
    ResetFunction->>ResetFunction: Reset and clear codec registry
    ResetFunction->>CodecRegistrar: Invoke registerModelCodecs()
    CodecRegistrar->>ModelSerializer: (Re)register model codecs
    ModelSerializer-->>CodecRegistrar: Acknowledge registration
    CodecRegistrar-->>ResetFunction: Complete re-registration
    ResetFunction-->>Caller: Return control
Loading

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 3c87c30 and 083838e.

📒 Files selected for processing (1)
  • packages/html/.storybook/preview.ts (2 hunks)
🔇 Additional comments (2)
packages/html/.storybook/preview.ts (2)

8-8: Good addition of the necessary import.

The import of registerModelCodecs is required for the fix implemented in this PR and correctly aligns with the implementation details below.

62-64: Well-documented fix for model codec registration.

This solution addresses the root issue by ensuring that model codecs are re-registered when switching between stories. The comments clearly explain:

  1. Why this fix is needed (ModelSerializer only registers codecs once)
  2. That this is a workaround until a more proper solution is available

The approach is appropriate for the described issue where model codecs become unavailable after story navigation.

One question: What does the true parameter passed to registerModelCodecs signify? If it's an important configuration option, it might be worth documenting in the comment.

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

@sonarqubecloud
Copy link

sonarqubecloud bot commented Apr 4, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@tbouffard tbouffard marked this pull request as ready for review April 4, 2025 19:13
@tbouffard tbouffard merged commit ea8561d into main Apr 5, 2025
7 checks passed
@tbouffard tbouffard deleted the fix/story_load_codecs_after_global_unregistration branch April 5, 2025 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

bug Something isn't working

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tbouffard