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

feat(ui): implement Freeze for Rundown UI #1228

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

asharonbaltazar
Copy link
Collaborator

Feature

Customers want a way to view the Rundown safely without any danger of making changes.

Changes

  • create new freeze request functions
  • create a third option to the RundownMenu toggles called Freeze. Toggling this option sends a request to /frozen and effectively prevents any backend changes as well
  • add a few disabled props to disable inputs
  • add isRundown flag in components and pass it accordingly

Copy link
Contributor

coderabbitai bot commented Sep 27, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

Copy link
Owner

@cpvalente cpvalente left a comment

Choose a reason for hiding this comment

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

We need to create a handler in the socket.ts file which assigns data from the frozen message to the local store.
Once we have done that, we have real-time change of the data and this should be our source of truth

We also need to make some UI tweaks

  • maybe a line between Run | Edit | Freeze?
  • Frozen fields should not have the disabled opacity since it make is difficult to read
  • Should the frozen field be indicated somewhere? Maybe the input should become of the "ghosted type" or perhaps a different colour and indicator in the label, like
    Blocked field label ❄

From missing functionality

  • we should also disable the drag and drop in the rundown

Comment on lines +14 to +23
switch (appModeFromSessionStorage) {
case AppMode.Run:
return AppMode.Run;
case AppMode.Edit:
return AppMode.Edit;
case AppMode.Freeze:
return AppMode.Freeze;
default:
return AppMode.Run;
}
Copy link
Owner

Choose a reason for hiding this comment

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

in the domain, run and freeze are not mutually exclusive. It is not ideal to build our logic in a way that goes agains the domain

Another challenge I see here, is that the data provenance between the AppMode and the Freeze is different. AppMode is a local setting for the user, while freeze is a session setting.
I am unsure it makes sense for us to mix the concerns here, although I understand the convenience

I wonder if the correct place to consume this is from the runtime store. we could create a feature selector for it and consume it in the components instead of passing it as props.

The other data is passed to the blocks as props, since we maintain the relationship of list > item, this is not the case here. Performance wise we would also prefer consuming this data as low down in the tree as possible

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