fix: Only trigger restart if current user is an instance admin.

[trishaanand]

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.Sanity"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11681598792
Commit: 4fa5ebc
Cypress dashboard.
Tags: @tag.Sanity
Spec:

---

Tue, 05 Nov 2024 10:24:09 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• New Features

  • Enhanced user context processing during the restart operation.
  • Improved error handling and configuration for sending test emails.

• Bug Fixes

  • Addressed issues related to connection testing and email sending with detailed error messages.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the restart and sendTestEmail methods in the EnvManagerCEImpl class. The restart method now utilizes a flatMap operation to process the user object after verifying super user status, enhancing user context handling. The sendTestEmail method has been updated to configure the JavaMailSenderImpl instance with SMTP properties based on the provided request parameters, including improved error handling for connection tests and email sending.

Changes

File	Change Summary
.../appsmith-server/src/main/java/com/appsmith/server/solutions/ce/EnvManagerCEImpl.java	Modified restart method to use flatMap for user processing; updated sendTestEmail for detailed SMTP configuration and error handling.

Poem

In the code where changes flow,
A restart's charm begins to grow.
With emails sent, and errors caught,
Super users, now well-thought!
So let us cheer, with joy and glee,
For code that works so gracefully! 🎉

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6660bd9 and 4fa5ebc.

📒 Files selected for processing (1)

• app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/EnvManagerCEImpl.java (1 hunks)

🔇 Additional comments (2)

app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/EnvManagerCEImpl.java (2)

728-728: LGTM! Good security enhancement.

The change properly enforces instance admin access control before allowing server restart.

---

Line range hint 738-751: Consider adding access restriction annotations.

The restartWithoutAclCheck method bypasses access control. While this is intentional for internal use, consider adding @Internal or similar annotation to explicitly mark this as an internal API and prevent unintended usage.

✅ Verification successful

Let me check the usage of verifyCurrentUserIsSuper() to ensure proper access control is in place.

---

Let me try a different approach to find the implementation.

---

Access control is properly implemented, no additional annotations needed

The restartWithoutAclCheck method is already well-protected:

• It's only called internally after verifyCurrentUserIsSuper() validation
• The validation checks if the user is a super user, throwing UNAUTHORIZED_ACCESS exception otherwise
• The method is properly documented as internal-only in the interface
• Usage is limited to two controlled scenarios: direct restart and tenant updates

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if this method is called from outside its intended scope
rg -A 3 "restartWithoutAclCheck" --type java

Length of output: 2143

---

Script:

#!/bin/bash
# Check the implementation of verifyCurrentUserIsSuper
ast-grep --pattern 'verifyCurrentUserIsSuper() {
  $$$
}'

Length of output: 59

---

Script:

#!/bin/bash
# Search for verifyCurrentUserIsSuper with more context
rg -A 10 "verifyCurrentUserIsSuper" --type java

Length of output: 8926

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.

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.

[trishaanand]

/build-deploy-preview skip-tests=true

[github-actions]

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

[github-actions]

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