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

[ops]: add warning for custom APPSMITH_GIT_ROOT #33355

Open
wants to merge 2 commits into
base: release
Choose a base branch
from

Conversation

pratapaprasanna
Copy link
Contributor

No description provided.

Copy link
Contributor

coderabbitai bot commented May 10, 2024

Walkthrough

Walkthrough

The recent update includes warnings in both the run-with-env.sh script and the backup.js file about the deprecation of custom configurations for the APPSMITH_GIT_ROOT environment variable. These changes aim to alert users to upcoming deprecations and ensure smoother transitions for future updates.

Changes

File Path Change Summary
.../appsmith/run-with-env.sh Added a warning about deprecation of custom configurations for APPSMITH_GIT_ROOT.
.../appsmith/utils/bin/backup.js Included a conditional check to warn about deprecated behavior when a custom value is set for APPSMITH_GIT_ROOT.

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between f759439 and 091b575.
Files selected for processing (1)
  • deploy/docker/fs/opt/appsmith/utils/bin/backup.js (1 hunks)
Additional Context Used
Biome (20)
deploy/docker/fs/opt/appsmith/utils/bin/backup.js (20)

1-1: A Node.js builtin module should be imported with the node: protocol.


2-2: A Node.js builtin module should be imported with the node: protocol.


3-3: A Node.js builtin module should be imported with the node: protocol.


9-9: A Node.js builtin module should be imported with the node: protocol.


17-17: Declare variables separately


21-26: This function expression can be turned into an arrow function.


47-47: Use === instead of ==.
== is only allowed when comparing against null


58-58: Template literals are preferred over string concatenation.


64-64: Template literals are preferred over string concatenation.


73-73: Template literals are preferred over string concatenation.


102-102: Template literals are preferred over string concatenation.


137-137: Use !== instead of !=.
!= is only allowed when comparing against null


149-149: The computed expression can be simplified without the use of a string literal.


149-149: The computed expression can be simplified without the use of a string literal.


150-150: Template literals are preferred over string concatenation.


158-159: Template literals are preferred over string concatenation.


161-161: Template literals are preferred over string concatenation.


186-186: Template literals are preferred over string concatenation.


192-192: Template literals are preferred over string concatenation.


208-208: Template literals are preferred over string concatenation.

Additional comments not posted (1)
deploy/docker/fs/opt/appsmith/utils/bin/backup.js (1)

137-140: Add a deprecation warning for custom APPSMITH_GIT_ROOT.

The implementation of the warning message for a custom APPSMITH_GIT_ROOT is clear and follows the PR's objective. However, consider enhancing the visibility of this warning by logging it as a warning or error using the logger module instead of console.log to ensure it is appropriately captured in logs.

- console.log('WARNING: It appears a custom value has been configured for APPSMITH_GIT_ROOT.'+
- ' This behaviour is deprecated and will soon be removed.')
+ logger.warn('It appears a custom value has been configured for APPSMITH_GIT_ROOT. This behaviour is deprecated and will soon be removed.')

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.

@pratapaprasanna
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9031756843.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33355.
recreate: .

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

Out of diff range and nitpick comments (1)
deploy/docker/fs/opt/appsmith/run-with-env.sh (1)

34-34: Ensure the deprecation warning for APPSMITH_GIT_ROOT is clear and actionable.

Consider adding more details about the deprecation timeline or alternative configurations to the warning message. This will help users understand the urgency and the necessary steps they should take.

Copy link

Deploy-Preview-URL: https://ce-33355.dp.appsmith.com

sharat87
sharat87 previously approved these changes May 15, 2024
Copy link

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

@github-actions github-actions bot added the Stale label May 22, 2024
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

Outside diff range and nitpick comments (4)
deploy/docker/fs/opt/appsmith/utils/bin/backup.js (4)

Line range hint 17-17: Use strict equality checks.

Replace == with === and != with !== to avoid potential bugs due to type coercion in JavaScript.

- if (encryptionPassword == -1){
+ if (encryptionPassword === -1){

- if (gitRoot != "/appsmith-stacks/git-storage/"){
+ if (gitRoot !== "/appsmith-stacks/git-storage/"){

Also applies to: 47-47, 137-137


Line range hint 58-58: Use template literals for string operations.

Replace string concatenations with template literals for improved readability and consistency with modern JavaScript practices.

- logger.backup_info('Finished creating an encrypted a backup archive at ' + encryptedArchivePath);
+ logger.backup_info(`Finished creating an encrypted a backup archive at ${encryptedArchivePath}`);

- const archive = Constants.BACKUP_PATH + '/appsmith-backup-' + timestamp + '.tar.gz';
+ const archive = `${Constants.BACKUP_PATH}/appsmith-backup-${timestamp}.tar.gz`;

Also applies to: 64-64, 73-73, 102-102, 150-150, 158-159, 161-161, 186-186, 192-192, 208-208


Line range hint 1-1: Use the node: protocol for importing built-in modules.

To ensure compatibility with future versions of Node.js and to explicitly differentiate built-in modules from third-party ones, prepend node: to the module names.

- const fsPromises = require('fs/promises');
+ const fsPromises = require('node:fs/promises');

- const path = require('path');
+ const path = require('node:path');

- const os = require('os');
+ const os = require('node:os');

- const tty = require('tty');
+ const tty = require('node:tty');

Also applies to: 2-2, 3-3, 9-9


Line range hint 21-26: Convert function expressions to arrow functions.

For consistency with modern JavaScript practices, convert the anonymous function expression to an arrow function.

- shell.exec(check_supervisord_status_cmd, function (code) {
+ shell.exec(check_supervisord_status_cmd, (code) => {

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants