chore: Add admin email to config DB #36596
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| package com.appsmith.server.dtos; | ||
|
|
||
| import com.appsmith.server.helpers.HashUtils; | ||
| import lombok.Data; | ||
| import net.minidev.json.JSONObject; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| @Data | ||
| public class InstanceAdminMetaDTO { | ||
| String email; | ||
| String emailDomainHash; | ||
|
|
||
| static final String EMAIL = "email"; | ||
| static final String EMAIL_DOMAIN_HASH = "emailDomainHash"; | ||
|
|
||
| /** | ||
| * Converts an email address to a JSONObject containing the email and its domain hash. | ||
| * @param email The email address to convert | ||
| * @return A JSONObject containing the email and its domain hash | ||
| */ | ||
| public static JSONObject toJsonObject(String email) { | ||
| email = email == null ? "" : email; | ||
| JSONObject jsonObject = new JSONObject(); | ||
| jsonObject.put(EMAIL, email); | ||
| jsonObject.put(EMAIL_DOMAIN_HASH, HashUtils.getEmailDomainHash(email)); | ||
| return jsonObject; | ||
| } | ||
|
|
||
| /** | ||
| * Creates an InstanceAdminMetaDTO from a JSONObject. | ||
| * @param jsonObject The JSONObject containing email and emailDomainHash | ||
| * @return An InstanceAdminMetaDTO populated with data from the JSONObject | ||
| */ | ||
| public static InstanceAdminMetaDTO fromJsonObject(JSONObject jsonObject) { | ||
| if (jsonObject == null) { | ||
| return new InstanceAdminMetaDTO(); | ||
| } | ||
| InstanceAdminMetaDTO instanceAdminMetaDTO = new InstanceAdminMetaDTO(); | ||
| instanceAdminMetaDTO.setEmail( | ||
| Optional.ofNullable(jsonObject.get(EMAIL)).map(Object::toString).orElse("")); | ||
| instanceAdminMetaDTO.setEmailDomainHash(Optional.ofNullable(jsonObject.get(EMAIL_DOMAIN_HASH)) | ||
| .map(Object::toString) | ||
| .orElse("")); | ||
| return instanceAdminMetaDTO; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| package com.appsmith.server.helpers; | ||
|
|
||
| import org.apache.commons.codec.digest.DigestUtils; | ||
| import org.apache.commons.lang3.StringUtils; | ||
|
|
||
| public class HashUtils { | ||
|
|
||
| public static String hash(String value) { | ||
| return StringUtils.isEmpty(value) ? "" : DigestUtils.sha256Hex(value); | ||
| } | ||
|
|
||
| public static String getEmailDomainHash(String email) { | ||
| if (email == null) { | ||
| return ""; | ||
| } | ||
|
|
||
| return hash(email.contains("@") ? email.split("@", 2)[1] : ""); | ||
| } | ||
|
Contributor
Author
There was a problem hiding this comment. Moving these methods from AnalyticsService to helper class to be reusable. |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| package com.appsmith.server.migrations.db.ce; | ||
|
|
||
| import com.appsmith.server.configurations.CommonConfig; | ||
| import com.appsmith.server.constants.FieldName; | ||
| import com.appsmith.server.domains.Config; | ||
| import com.appsmith.server.domains.PermissionGroup; | ||
| import com.appsmith.server.domains.User; | ||
| import com.appsmith.server.dtos.InstanceAdminMetaDTO; | ||
| import com.appsmith.server.helpers.CollectionUtils; | ||
| import io.mongock.api.annotations.ChangeUnit; | ||
| import io.mongock.api.annotations.Execution; | ||
| import io.mongock.api.annotations.RollbackExecution; | ||
| import lombok.RequiredArgsConstructor; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.springframework.data.mongodb.core.MongoTemplate; | ||
| import org.springframework.data.mongodb.core.query.Query; | ||
| import org.springframework.util.StringUtils; | ||
| import reactor.core.publisher.Flux; | ||
|
|
||
| import static com.appsmith.server.constants.ce.FieldNameCE.INSTANCE_ADMIN_CONFIG; | ||
| import static com.appsmith.server.helpers.ce.bridge.BridgeQuery.where; | ||
| import static com.appsmith.server.migrations.constants.FieldName.DEFAULT_CLOUD_ADMIN_EMAIL; | ||
| import static com.appsmith.server.repositories.ce.BaseAppsmithRepositoryCEImpl.notDeleted; | ||
|
|
||
| @RequiredArgsConstructor | ||
| @Slf4j | ||
| @ChangeUnit(order = "064", id = "add_instance_admin_details_to_config_collection") | ||
| public class Migration064AddInstanceAdminDetailsToDB { | ||
|
|
||
| private final MongoTemplate mongoTemplate; | ||
| private final CommonConfig commonConfig; | ||
|
|
||
| @RollbackExecution | ||
| public void rollbackExecution() {} | ||
|
|
||
| @Execution | ||
| public void executeMigration() { | ||
| // Add instance admin details to the DB | ||
| // This migration is idempotent and can be run multiple times without any side effects | ||
| log.info("Adding instance admin details to the DB"); | ||
| // Check if instance admin details are already present in the DB to make the migration idempotent | ||
| if (verifyIfInstanceAdminDetailsArePresent(mongoTemplate)) { | ||
| return; | ||
| } | ||
|
|
||
| // Add instance admin details to the DB | ||
| Query instanceAdminRoleQuery = new Query() | ||
| .addCriteria(where(FieldName.NAME).is(FieldName.INSTANCE_ADMIN_ROLE)) | ||
| .addCriteria(notDeleted()); | ||
| PermissionGroup instanceAdminPG = mongoTemplate.findOne(instanceAdminRoleQuery, PermissionGroup.class); | ||
| if (instanceAdminPG == null) { | ||
| log.error("Instance admin permission group not found in the DB. Skipping migration 064"); | ||
| return; | ||
| } | ||
| String adminEmail = null; | ||
| if (commonConfig.isCloudHosting()) { | ||
| // As a fallback, use the default admin email for cloud hosting | ||
| adminEmail = DEFAULT_CLOUD_ADMIN_EMAIL; | ||
| } else if (!CollectionUtils.isNullOrEmpty(instanceAdminPG.getAssignedToUserIds())) { | ||
| adminEmail = Flux.fromIterable(instanceAdminPG.getAssignedToUserIds()) | ||
| .map(userId -> { | ||
| User user = mongoTemplate.findOne( | ||
| new Query() | ||
| .addCriteria(where(FieldName.ID).is(userId)) | ||
| .addCriteria(notDeleted()), | ||
| User.class); | ||
| return user != null ? user.getEmail() : ""; | ||
| }) | ||
| .filter(email -> email != null && email.contains("@")) | ||
| .blockFirst(); | ||
| } | ||
|
|
||
| if (!StringUtils.hasLength(adminEmail)) { | ||
| adminEmail = commonConfig.getAdminEmails().stream() | ||
| .filter(email -> email != null && email.contains("@")) | ||
| .findFirst() | ||
| .orElse(null); | ||
| } | ||
| Config config = new Config(); | ||
| config.setName(INSTANCE_ADMIN_CONFIG); | ||
| if (StringUtils.hasLength(adminEmail)) { | ||
| config.setConfig(InstanceAdminMetaDTO.toJsonObject(adminEmail)); | ||
| mongoTemplate.save(config); | ||
| } | ||
| } | ||
|
|
||
| public static boolean verifyIfInstanceAdminDetailsArePresent(MongoTemplate mongoTemplate) { | ||
| Query instanceAdminConfigQuery = new Query() | ||
| .addCriteria(where(FieldName.NAME).is(FieldName.INSTANCE_ADMIN_CONFIG)) | ||
| .addCriteria(notDeleted()); | ||
| Config instanceAdminConfig = mongoTemplate.findOne(instanceAdminConfigQuery, Config.class); | ||
| boolean adminDetailsPresent = instanceAdminConfig != null | ||
| && StringUtils.hasLength(InstanceAdminMetaDTO.fromJsonObject(instanceAdminConfig.getConfig()) | ||
| .getEmail()); | ||
| if (adminDetailsPresent) { | ||
| log.info("Instance admin details already present in the DB. Skipping migration 64"); | ||
| } | ||
| return adminDetailsPresent; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.