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

Exit gracefully on SIGINT #1356

Merged

Conversation

taylorking
Copy link
Contributor

@taylorking taylorking commented Feb 15, 2024

I am trying to run this in docker under systemd and was getting failures trying to restart the job. Before ctrl + c would not kill the task successfully when running under docker, this fixes that as well.

Summary by CodeRabbit

  • Chores
    • Improved process termination handling on user interrupt signals.

Copy link

coderabbitai bot commented Feb 15, 2024

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

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.

Walkthrough

The update enhances the application's robustness by adding a 'SIGINT' process event listener in rtl.js to enable graceful process exit upon receiving an interrupt signal. It also includes minor adjustments to variable assignments for improved efficiency.

Changes

File(s) Change Summary
rtl.js Added a process event listener for 'SIGINT' to exit the process and made minor adjustments to variable assignments.

🐇✨
In the realm of code, where rabbits play,
A new charm's cast, without delay.
'SIGINT' caught, the app shall rest,
With variables tweaked, for the very best.
So hop along, on this code crusade,
Where bugs are caught and magic's made.
🌟🐾

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

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

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ea7f300 and b5a56db.
Files selected for processing (1)
  • rtl.js (1 hunks)
Additional comments: 2
rtl.js (2)
  • 11-11: The app variable is correctly instantiated from App, but ensure that App's constructor and methods are designed to handle or propagate errors effectively, especially since app.getApp() is used to create the server.
  • 11-11: The server setup and listening logic are correctly implemented. However, ensure that common.host and common.port are validated for valid values before using them to avoid potential runtime errors.

rtl.js Outdated
Comment on lines 8 to 10
process.on('SIGINT', () => {
process.exit();
});
Copy link

Choose a reason for hiding this comment

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

The SIGINT handler exits the process immediately without any cleanup. Consider gracefully shutting down connections or performing necessary cleanup before exiting.

process.on('SIGINT', () => {
+  // Perform necessary cleanup
+  console.log('Gracefully shutting down');
+  server.close(() => {
+    process.exit();
+  });
-  process.exit();
});

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
process.on('SIGINT', () => {
process.exit();
});
process.on('SIGINT', () => {
// Perform necessary cleanup
console.log('Gracefully shutting down');
server.close(() => {
process.exit();
});
});

process.on('SIGINT', () => {
process.exit();
});

Copy link

Choose a reason for hiding this comment

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

Variable assignments for logger, common, and wsServer are redundant. Directly use the imported modules where needed or clarify the intention behind reassigning them to constants with the same name.

- const logger = Logger;
- const common = Common;
- const wsServer = WSServer;
+ // If reassignment is not necessary, consider using the imported modules directly.

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

The error handling in onError function does not differentiate between critical and recoverable errors. All errors lead to process.exit(1), which might not be necessary for all cases. Consider implementing more nuanced error handling or recovery strategies.


The WebSocket server is mounted on the HTTP server without explicit error handling for WebSocket-specific errors. Consider adding error handling for the WebSocket server to ensure robustness.

Copy link

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ea7f300 and 9e18bbf.
Files selected for processing (1)
  • rtl.js (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • rtl.js

@taylorking
Copy link
Contributor Author

I tried the code review bots suggestion, but it didn't fix the problem and still blocks stopping the service

https://stackoverflow.com/questions/14626636/how-do-i-shutdown-a-node-js-https-server-immediately

I think server.close() just stops the server accepting new connections but keeps alive any existing connections.

Anyways, up to you if you want to accept this change. I am using it to run RTL in systemd in docker.

@ShahanaFarooqui ShahanaFarooqui added the bug Something isn't working label Mar 7, 2024
@ShahanaFarooqui ShahanaFarooqui changed the base branch from master to Release-0.15.1 March 7, 2024 21:26
@ShahanaFarooqui ShahanaFarooqui merged commit 5bd587f into Ride-The-Lightning:Release-0.15.1 Mar 7, 2024
ShahanaFarooqui added a commit that referenced this pull request Jun 10, 2024
* rm .DS_Store

* Add watchfrontenddev command for npm

* Fix toggle issues in sidenav (pinning and on page refresh)

* Add copy-to-clipboard fallback if navigator.clipboard is not available (#1336)

* add copy-to-clipboard fallback if navigator.clipboard is not available

* amend copy fallback

* clipboard copy lint fixes and frontend build

* fix: add missing boltz state `transaction.lockupFailed` (#1349)

* fix: boltzd docs link (#1354)

* exit gracefully (#1356)

* allow for eclair updated relayed audit format (#1363)

* feat: add boltz service to cln (#1352)

* lint fix

* Request Params Cleanup

* cln: Boltz auto-send (#1366)

* Bug-fix (CLN Boltz): Hide claim tx id and routing fee for non-zero conf reverse swap

* cln: Boltz auto-send

- Added auto send option for Swap In
- Checking compatiblity with v2.0.0 and above

* Test import fixes

* Update help.component.ts (#1379)

Fixed broken link under "Help" -> "Node Settings"

* Backend config fix (#1382)

* Updating Common Application Configuration

* Fixed get RTL Conf

* Update Application Settings

* application and settings case change

* Unified config models

* Default node update

* 2FA and Password reset

* Final application settings update

* Config Settings and Authentication case fixed

* Node Setting Fix

* Fiat currency Symbol fix

* CLN: Fiat symbol fix

* All: Fiat symbol fix

* Update node settings

* Services UI fix

* CLN: Removed child node settings

* All: Removed child node settings

* Test fixes

* mempool links for onchain information (#1383)

* Tests fix

Tests fix

* UI for Block Explorer Configuration (#1385)

* Bump fee with mempool information (#1386)

* Mempool openchannel minfee (#1388)

Open channel model block if min fee is higher

* Show error on login screen if rune is incorrect and getinfo throws error (#1391)

* cln: Removed channel lookup call for update policy (#1392)

* ECL: On-chain Transactions, Invoice and Payments pagination (#1393)

Done most of the UI changes to accommodate pagination on transactions, payments and invoices tables but true pagination cannot be implemented till total number of records are missing from the API response.

Once the issue ACINQ/eclair#2855 is fixed, I will uncomment pagination changes in the frontend.

* lnd: Onchain CPFP (#1394)

- UTXO label bug fix
- Warning on utxo label for "sweep" in text.

* Bug fixes after testing

* Testing bug fixes (#1401)

* Bug fix 2: lnd: Link channel point to explorer and show fee on close channel too

* lnd: explorer link on pending channels

* Node lookup link on view channel peer pubkey

* Testing bug fixes (#1402)

* Bug fix 2: lnd: Link channel point to explorer and show fee on close channel too

* lnd: explorer link on pending channels

* Node lookup link on view channel peer pubkey

* test fixes

* ng update to v18.0.x

* Updating install with  --legacy-peer-deps

---------

Co-authored-by: Grzegorz Kućmierz <[email protected]>
Co-authored-by: lacksfish <[email protected]>
Co-authored-by: jackstar12 <[email protected]>
Co-authored-by: Kilian <[email protected]>
Co-authored-by: Taylor King <[email protected]>
Co-authored-by: Fishcake <[email protected]>
Co-authored-by: Ant <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants