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

Shutdown #1216

Merged
merged 2 commits into from
Sep 23, 2024
Merged

Shutdown #1216

merged 2 commits into from
Sep 23, 2024

Conversation

cpvalente
Copy link
Owner

small change to allow shutting down from localhost outside electron as discussed in #1215

This will also impact the users in node and docker environments.
As far as I can see, there are no downsides here, but thought of double checking @alex-Arc @jwetzell. Am I maybe missing something? In those environments, is there a reason for us not to want users to shutdown the process from the interface?

Copy link
Contributor

coderabbitai bot commented Sep 18, 2024

Walkthrough

The changes involve the addition of a new constant isLocalhost in the constants.ts file to identify if the application is running in a local development environment. This constant is utilized in the ShutdownPanel.tsx file to enable the shutdown button under additional conditions, specifically when running on localhost. A descriptive note was also added to inform users about the operational constraints of the shutdown feature.

Changes

File Change Summary
apps/client/src/common/api/constants.ts Added a new constant isLocalhost to check if the application is running on localhost or 127.0.0.1.
apps/client/src/features/app-settings/panel/shutdown-panel/ShutdownPanel.tsx Modified the shutdown button logic to enable it when running on localhost in addition to the existing Electron check. Added a note about shutdown constraints.

Suggested reviewers

  • alex-Arc
  • jwetzell

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 generate interesting stats about this repository and render them as a table.
    -- @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 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.

Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more nuanced feedback on your code.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

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

Outside diff range and nitpick comments (1)
apps/client/src/features/app-settings/panel/shutdown-panel/ShutdownPanel.tsx (1)

38-38: Correct 'shutdown' to 'shut down' and adjust preposition

In this context, 'shut down' should be two words when used as a verb. Additionally, it's more common to say "running on" rather than "running in."

Apply this diff to correct the text:

-<Panel.Description>Note: Ontime can only be shutdown from the machine it is running in.</Panel.Description>
+<Panel.Description>Note: Ontime can only be shut down from the machine it is running on.</Panel.Description>
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5b47198 and 44c76c3.

Files selected for processing (2)
  • apps/client/src/common/api/constants.ts (1 hunks)
  • apps/client/src/features/app-settings/panel/shutdown-panel/ShutdownPanel.tsx (2 hunks)
Additional comments not posted (1)
apps/client/src/features/app-settings/panel/shutdown-panel/ShutdownPanel.tsx (1)

35-35: Logic for enabling the shutdown button looks correct

The updated isDisabled condition appropriately enables the shutdown button when running in Electron or on localhost.

@@ -18,6 +18,7 @@ const location = window.location;
const socketProtocol = location.protocol === 'https:' ? 'wss' : 'ws';
export const isProduction = import.meta.env.MODE === 'production';
export const isDev = !isProduction;
export const isLocalhost = location.hostname === 'localhost' || location.hostname === '127.0.0.1';
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider supporting IPv6 localhost address '::1'

Currently, isLocalhost only checks for 'localhost' and '127.0.0.1'. To ensure compatibility with IPv6 environments, you may want to include a check for '::1'.

Apply this diff to include IPv6 localhost:

-export const isLocalhost = location.hostname === 'localhost' || location.hostname === '127.0.0.1';
+export const isLocalhost = ['localhost', '127.0.0.1', '::1'].includes(location.hostname);
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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
export const isLocalhost = location.hostname === 'localhost' || location.hostname === '127.0.0.1';
export const isLocalhost = ['localhost', '127.0.0.1', '::1'].includes(location.hostname);

@jwetzell
Copy link
Collaborator

I can't think of any "gotchas" on the headless/docker side of things.

@cpvalente cpvalente merged commit 6608381 into master Sep 23, 2024
4 checks passed
@cpvalente cpvalente deleted the shutdown branch September 23, 2024 14:55
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.

3 participants