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

Dayoffset in rundown #1396

Draft
wants to merge 10 commits into
base: collection
Choose a base branch
from
Draft

Dayoffset in rundown #1396

wants to merge 10 commits into from

Conversation

alex-Arc
Copy link
Collaborator

No description provided.

Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@alex-Arc alex-Arc force-pushed the dayoffset-in-rundown branch from 1d3d448 to ba7b214 Compare December 20, 2024 17:03
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.

Thank you Alex, I agree that this changes will lead to a better experience dealing with this dataset

I think we are moving in a direction where the server is providing us more metadata. I suggest that we spend some time to cleanup typing and processes around this

apps/client/src/features/rundown/Rundown.tsx Outdated Show resolved Hide resolved
@@ -39,6 +39,7 @@ export type OntimeEvent = OntimeBaseEvent & {
colour: string;
revision: number;
delay?: number; // calculated at runtime
dayOffset?: number; // calculated at runtime
Copy link
Owner

Choose a reason for hiding this comment

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

suggestion: I wonder if we are starting to complicate our code base a bit with these types

would it be better to have a OntimePersistedEvent and an OntimeEvent, where the OntimeEventcontains all the stuff calculated in rundownCache?

Copy link
Collaborator Author

@alex-Arc alex-Arc Dec 21, 2024

Choose a reason for hiding this comment

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

Yeah that sounds like a good idea
I've been struggling a bit with the optional so making a new type would be great

Should we make a new type for pre or post cache.generate ?

Copy link
Owner

Choose a reason for hiding this comment

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

I am not sure if I understood. but I think the two types we need are

  • one type with the base data we need, this is stored in the json file
  • one type with added metadata, this will be in all the runtime stores and generated in the rundownCache

Copy link
Collaborator Author

@alex-Arc alex-Arc Dec 21, 2024

Choose a reason for hiding this comment

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

should the "normal" OntimeEvent type be the on with meta data since that is what is being operated on in most of the code base, and then we create a new dbOntimeEvent with out the metadata?
some thing like this
image

Copy link
Owner

Choose a reason for hiding this comment

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

I am not sure if there is something definitely better. I think your suggestion is good and makes sense

const timeFromPrevious: number = getTimeFromPrevious(
currentEntry.timeStart,
currentEntry.dayOffset,
Copy link
Owner

Choose a reason for hiding this comment

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

cleanup: we need to make sure that these properties do not get persisted. I have flagged the entrypoint for the code in this comment
https://github.com/cpvalente/ontime/blob/master/apps/server/src/services/rundown-service/rundownCache.ts#L97

@alex-Arc alex-Arc force-pushed the dayoffset-in-rundown branch from eeb6603 to 0b4095b Compare December 22, 2024 15:28
@alex-Arc alex-Arc changed the base branch from master to collection December 25, 2024 16:28
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