feat: Added feature to perform in-place update of Drifty

SaptarshiSarkar12 commented 2 months ago

Fixes issue

Fixes #217

Changes proposed

Added a package to check for available update
Added in-place update methods for both CLI and GUI
Added a settings option to choose if the user wants to receive Early Access updates (Alpha, Beta, RC) along with Stable versions

Tested Working in/for

[x] Drifty CLI / Windows
[x] Drifty GUI (exe) / Windows
[x] Drifty GUI (msi) / Windows (requires Administrative Privileges)
[x] Drifty CLI / Linux
[x] Drifty GUI / Linux
[x] Drifty CLI / MacOS
[x] Drifty GUI / MacOS (PKG installer is opened up for the user to install the latest version)

[!NOTE] For Windows, the .old executable remains after update completes. Once the new executable (starting from version 2.1.0) is run, it deletes that old file during initialisation.

Check List (Check all the applicable boxes)

[X] My code follows the code style of this project.
[ ] My change requires changes to the documentation.
[ ] I have updated the documentation accordingly.
[X] This PR does not contain plagiarized content.
[X] The title of my pull request is a short description of the requested changes.

Screenshots

Drifty GUI (Linux) updating.webm

Drifty CLI (Linux) Updating.webm

Drifty GUI (msi) updating (with admin permission).webm

Drifty GUI (msi) fails to update without admin permission.webm

Summary by CodeRabbit

New Features
- Introduced a new inspection tool for managing auto-closeable resources to enhance code quality.
- Added command-line flags for updating and early access options in the CLI application.
- Implemented a new update management feature allowing users to check for updates directly from the GUI.
- Included a checkbox in settings for opting into early access updates.
Enhancements
- Improved error handling in various components, providing clearer feedback for users.
- Enhanced logging functionality for better tracking of application behavior.
- Streamlined the update process with better user interaction and feedback mechanisms.
- Added a new constant for representing one day in milliseconds and improved the initialization of the update URL.
Bug Fixes
- Resolved issues related to file permissions and update execution across different operating systems.
Documentation
- Updated help outputs to reflect new command-line options and GUI features.

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
drifty	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 7, 2024 8:07am

coderabbitai[bot] commented 2 months ago

Walkthrough

## Walkthrough The changes introduce a comprehensive update feature for the Drifty application, enabling it to check for the latest version and facilitate automatic updates upon user confirmation. This includes enhancements in update management, error handling, and user interface adjustments to provide clear feedback during update checks. ## Changes | File(s) | Change Summary | |---------------------------------------------------|-----------------------------------------------------------------------------------------------------| | `.idea/inspectionProfiles/Project_Default.xml` | Added inspection tool for `AutoCloseableResource` to improve resource management checks. | | `CLI/src/main/java/cli/support/Constants.java` | Introduced new constants for update URL and time representation. | | `CLI/src/main/java/cli/updater/CLIUpdateExecutor.java` | Implemented the update execution logic for the CLI application. | | `Core/src/main/java/init/Environment.java` | Enhanced environment initialization to check for admin privileges and updates. | | `Core/src/main/java/updater/UpdateChecker.java` | Created a class to check for software updates against the latest version on GitHub. | | `GUI/src/main/java/main/Drifty_GUI.java` | Added a menu item for checking updates and modified initialization logic. | | `GUI/src/main/java/ui/UIController.java` | Implemented update dialog and download management in the UI. | ## Assessment against linked issues | Objective | Addressed | Explanation | |--------------------------------------------------------------------|-----------|-----------------------------------------------| | Drifty should check if the user is running the latest version (217) | ✅ | | | Drifty should update itself after user confirmation (217) | ✅ | | > 🐰 "Oh, hop along, the updates are here, > With checks for the latest, there's nothing to fear! > Click and confirm, let the magic unfold, > Drifty's now shiny, with features untold! > So bounce with delight, let the updates commence, > A world of new wonders, it all makes sense!" 🐇✨

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.