add freeze feature to rundown

[jwetzell]

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The overall change introduces functionality to manage the frozen state of a rundown within a server-client architecture. This includes the addition of a new endpoint and validation for setting the frozen state on the server, updates to the server startup configuration, enhancements to the client runtime store, and a new service method to manage the frozen state effectively.

Changes

File Path	Change Summary
.../src/api-data/rundown/rundown.controller.ts	Added rundownFrozenPost function to handle setting the frozen state of a rundown.
.../src/api-data/rundown/rundown.middleware.ts	Introduced preventIfFrozen middleware to restrict operations on frozen rundowns.
.../src/api-data/rundown/rundown.router.ts	Added POST endpoint /frozen with validation and integrated preventIfFrozen middleware into existing endpoints.
.../src/api-data/rundown/rundown.validation.ts	Added rundownFrozenPostValidator to validate the frozen field as a boolean value.
.../src/app.ts	Introduced a new frozen parameter with a default value of false in the startServer function.
.../src/services/rundown-service/RundownService.ts	Imported EventStore.js and added setFrozenState function to set the frozen state.
.../src/common/stores/runtime.ts	Added a frozen property with a default value of false to the runtimeStorePlaceholder object.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant RundownService
    participant EventStore

    Client->>Server: POST /frozen
    Server->>RundownService: setFrozenState(frozen)
    RundownService->>EventStore: updateFrozenState(frozen)
    EventStore-->>RundownService: Frozen state updated
    RundownService-->>Server: Success/Failure response
    Server-->>Client: Response with status update

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[cpvalente]

Thank you @jwetzell , I will continue the PR with the client implementation