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

Offline indicator #877

Draft
wants to merge 5 commits into
base: v3
Choose a base branch
from
Draft

Offline indicator #877

wants to merge 5 commits into from

Conversation

alex-Arc
Copy link
Collaborator

@alex-Arc alex-Arc commented Apr 10, 2024

the margins and placement could be a bit better

editor

cuesheet

backstage

Copy link
Contributor

coderabbitai bot commented Apr 10, 2024

Walkthrough

The recent project updates focus on enhancing feedback regarding socket connectivity in the client application. Key changes include the addition of a new connected state and management functions in AppModeStore to monitor the connection status. Socket functions now interact with this store to dynamically update the connection status. Moreover, new UI components like alerts and tooltips have been introduced to visually represent the connectivity status, alongside theme customizations to support these new UI elements.

Changes

Files Change Summary
.../appModeStore.ts Added connected boolean and setConnected function to AppModeStore, initialized to false.
.../utils/socket.ts Updated connectSocket to interact with useAppMode store for updating connection status.
.../features/overview/Overview.tsx Imported UI components from @chakra-ui/react and useAppMode. Added ConnectedIndicator component for displaying connectivity status.
.../theme/OntimeAlert.ts
.../theme/theme.ts
Added ontimeRedAlertOnDark style and integrated it into the theme as an alert variant.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 814b4f4 and 19ad4fc.
Files selected for processing (3)
  • apps/client/src/common/components/connected-indicator/ConnectedIndicator.tsx (1 hunks)
  • apps/client/src/features/overview/Overview.tsx (4 hunks)
  • apps/client/src/features/viewers/backstage/Backstage.tsx (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • apps/client/src/features/overview/Overview.tsx
Additional comments not posted (2)
apps/client/src/common/components/connected-indicator/ConnectedIndicator.tsx (1)

8-20: Consider using more descriptive and consistent units for marginLeft and width properties in the Alert component to enhance maintainability and ensure consistency across different screen sizes.

apps/client/src/features/viewers/backstage/Backstage.tsx (1)

103-104: The integration and placement of the ConnectedIndicator component look good and are appropriately styled for its purpose.


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.

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: 2

export const ontimeRedAlertOnDark = {
container: {
fontSize: 'calc(1rem - 1px)',
backgroundColor: '#0000', // $gray-1300
Copy link
Contributor

Choose a reason for hiding this comment

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

The backgroundColor value '#0000' seems incorrect as it represents full transparency. Consider using a darker shade appropriate for a dark theme.

-    backgroundColor: '#0000', // $gray-1300
+    backgroundColor: '#1a1a1a', // $gray-1300

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
backgroundColor: '#0000', // $gray-1300
backgroundColor: '#1a1a1a', // $gray-1300

},
icon: {
alignSelf: 'start',
color: 'red', // $blue-500
Copy link
Contributor

Choose a reason for hiding this comment

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

The comment for the icon color incorrectly references $blue-500. Update the comment to accurately reflect the color used.

-    color: 'red', // $blue-500
+    color: 'red', // Correct color description

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
color: 'red', // $blue-500
color: 'red', // Correct color description

<Alert status='error' variant='ontime-transparent-warn' marginLeft='10' width='10' style={style}>
<Tooltip label='Server Disconnected!'>
<span>
<AlertIcon hidden={!connected} className={moduleStyle.blink} />
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Remember remove the ! before merge

@alex-Arc alex-Arc marked this pull request as draft April 19, 2024 14:29
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.

1 participant