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

chore: cleanup #909

Merged
merged 2 commits into from
Apr 23, 2024
Merged

chore: cleanup #909

merged 2 commits into from
Apr 23, 2024

Conversation

cpvalente
Copy link
Owner

@cpvalente cpvalente commented Apr 21, 2024

remove unused code and small cleanups from testing the APIs

Summary by CodeRabbit

  • Bug Fixes

    • Corrected a typo in an error message to ensure clarity in user notifications.
  • Refactor

    • Enhanced the reliability of event data handling by replacing outdated function calls.
    • Removed an unused route that polled event state data, streamlining server interactions.
  • Style

    • Updated data transformation to handle duration properties accurately without unnecessary conversion.

Copy link
Contributor

coderabbitai bot commented Apr 21, 2024

Walkthrough

The recent updates aim to enhance the server's integration and websocket communication functionality by replacing hardcoded values with variables, improving error messages, eliminating redundant routes, and refining time duration handling in payload transformations.

Changes

File Path Change Summary
.../WebsocketAdapter.ts Replaced hardcoded event type string with a variable in SocketServer.
.../integration.controller.ts Removed updateEvent function, replaced with patchEvent, and corrected an error message typo.
.../integration.router.ts Removed unused /poll route handler.
.../integration.utils.ts Adjusted transformation of the duration property, removing the conversion from seconds to milliseconds.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between d01b9d4 and ef329a1.
Files selected for processing (2)
  • apps/server/src/services/rundown-service/tests/rundownCache.test.ts (3 hunks)
  • apps/server/src/services/rundown-service/rundownCache.ts (5 hunks)
Additional comments not posted (3)
apps/server/src/services/rundown-service/rundownCache.ts (1)

42-50: Exporting customFieldChangelog for external use.

This change aligns with the PR's objective to enhance code efficiency by making it easier to track changes in custom fields across different parts of the application.

apps/server/src/services/rundown-service/__tests__/rundownCache.test.ts (2)

27-27: Importing customFieldChangelog for testing.

This change is necessary to test the new functionality introduced in the associated service file, ensuring that customFieldChangelog behaves as expected.


874-874: Ensure customFieldChangelog is tested after modifications.

It's important to verify that customFieldChangelog correctly tracks changes to custom fields, especially after edits that involve renaming. Consider adding assertions to check the state of customFieldChangelog after operations that should modify it.


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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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 cpvalente requested a review from alex-Arc April 21, 2024 21:12
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Actionable comments outside the diff hunks (2)
apps/server/src/api-integration/integration.router.ts (2)

Line range hint 8-8: Remove unused imports: ErrorResponse and RuntimeStore.

- import { ErrorResponse, LogOrigin, RuntimeStore } from 'ontime-types';
+ import { LogOrigin } from 'ontime-types';

Line range hint 17-17: Remove the unused variable eventStore.

- import { eventStore } from '../stores/EventStore.js';

Copy link
Collaborator

@alex-Arc alex-Arc left a comment

Choose a reason for hiding this comment

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

have not tested but it looks correct

@cpvalente cpvalente merged commit c4f5119 into master Apr 23, 2024
3 checks passed
@cpvalente cpvalente deleted the api-cleanup branch April 23, 2024 20:05
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.

None yet

2 participants