Report #1469

alex-Arc · 2025-01-25T16:24:55Z

#1139

now

record start and stop times of events
show event report in editor
clear individual report in editor

later ?

record start and stop times of blocks
settings panel for reporter
show report in cuesheet
export a report
intelligent clearing of reports (should it reports be cleared if the duration of an event is changed to avoid confusion)

coderabbitai · 2025-01-25T16:25:01Z

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.

cpvalente

I think this is looking really good already and I am excited for this feature.
Great job with all the work to get this far

I would suggest that we simplify the code and consider the report as part of the user flow

I wonder if:

User starts the app and clicks the Start -> Next button to go through the interface. lets call this the progress button just so we have a reference
When the user is on the last event, the progress button button shows End show. Clicking end show will generate a report and terminate things
while we have a report, the progress button shows Clear report. Clicking here will clear the report and the button will then show Start

Also, is it now the time for us to consider the rehearsal mode? (ie: offsets would ignore schedule and only care about the event duration)

cpvalente · 2025-01-31T16:21:42Z

apps/client/src/common/hooks-query/useReport.ts

+    refetchInterval: queryRefetchIntervalSlow,
+    networkMode: 'always',


question: I wonder if we prefer fetching this on demand?

yeah I think that would be better, I just can't quite figur out how it ties togetter

kinda like this
TanStack/query#1205

remember we have the messages from the server, perhaps in the ontime-refetch we could add one more case for the report?

cpvalente · 2025-01-31T16:24:22Z

apps/client/src/features/app-settings/panel/feature-settings-panel/ReportSettings.tsx

+  }, []);
+
+  return (
+    <Panel.Section>


question: I wonder if we should leave this for later once we have an export feature?

we can do that
Was just thinking that this would also where you went to download the report

I agree, we can add this UI when we have the download report feature

apps/client/src/features/rundown/event-block/EventBlock.tsx

apps/client/src/features/rundown/event-block/composite/EventBlockChip.tsx

cpvalente · 2025-01-31T16:30:59Z

apps/client/src/features/rundown/event-block/composite/EventBlockChip.tsx

+  duration: number;
+}
+
+function EventReport(props: EventReportProps) {


I wonder if we can make this more efficient.

We know that, once an event has run, the report will never change until it runs again
Do you agree? if so, we can find a way together, to only run this once when the event finishes

cpvalente · 2025-01-31T16:34:10Z

apps/server/src/api-data/report/report.service.ts

+//TODO: there seams to be some actions that should invalidate reports
+// events timer edits?
+// event delete
+// Also what about roll mode?


I think there are too many edge cases here and we should keep it simple

The report, should tell the user how long did something take last time it ran
I dont think it should matter what playback mode it is in

As for clearing:

The user would chose to clear the entire report

The user deletes an event, so we can clear the report for it

I dont think it should matter what playback mode it is in

I agree we just have to find all the places to hook in.

as for the clearing
the way we display the report right now it is relative to the events duration, so of the user changes the duration of the event, dose the report still make sense?

I agree we just have to find all the places to hook in.

What if we use the same place where we do the integrations?
In that way, that becomes the side effects place

the way we display the report right now it is relative to the events duration, so of the user changes the duration of the event, dose the report still make sense?

I believe the report should be a feature that says "last time this ran, this is what happened", in which case it doesnt matter if the user changes things post fact. This also has advantage of keeping the feature simpler and a more straightforward mental model

apps/client/src/features/rundown/event-block/composite/EventBlockChip.module.scss

cpvalente · 2025-02-01T20:42:49Z

apps/client/src/features/rundown/event-block/composite/EventBlockChip.module.scss

@@ -6,14 +6,18 @@
  color: $label-gray;
  padding: 0.125rem 0.5rem;
  border-radius: 2px;
-
+  


tip: check your formatter, these spaces shouldnt be here

alex-Arc force-pushed the report branch 4 times, most recently from ef1f200 to b69c374 Compare January 29, 2025 22:15

alex-Arc added 6 commits January 29, 2025 23:37

create report service

18b9b9d

write report from runtimeState

f4ff4d1

use in UI

a32c10c

clear report

6746f65

update types

cc7735d

clear all from settings menu

c4440bc

alex-Arc force-pushed the report branch from b69c374 to c4440bc Compare January 30, 2025 20:26

cpvalente reviewed Jan 31, 2025

View reviewed changes

alex-Arc added 3 commits February 1, 2025 16:26

rearence rightclik menu

a35255c

refactor styling

9ce972f

also report roll events

619ef3c

cpvalente reviewed Feb 1, 2025

View reviewed changes

alex-Arc added 3 commits February 2, 2025 15:14

ontime/under time is same colour

72dfd2b

refactor reporter

19ace9f

add target to ontime-refetch

0844db1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report #1469

Report #1469

alex-Arc commented Jan 25, 2025 •

edited

Loading

coderabbitai bot commented Jan 25, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

cpvalente left a comment

cpvalente Jan 31, 2025

alex-Arc Jan 31, 2025

cpvalente Feb 1, 2025

cpvalente Jan 31, 2025

alex-Arc Jan 31, 2025

cpvalente Feb 1, 2025

cpvalente Jan 31, 2025

cpvalente Jan 31, 2025

alex-Arc Jan 31, 2025

cpvalente Feb 1, 2025

cpvalente Feb 1, 2025

		refetchInterval: queryRefetchIntervalSlow,
		networkMode: 'always',

Report #1469

Are you sure you want to change the base?

Report #1469

Conversation

alex-Arc commented Jan 25, 2025 • edited Loading

now

later ?

coderabbitai bot commented Jan 25, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

cpvalente left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-Arc commented Jan 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)