Skip to content

refactor: Remove strong dependency from feature flag enum to (de)serialise organization object #40374

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 28, 2025
Merged

refactor: Remove strong dependency from feature flag enum to (de)serialise organization object #40374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions ...mith-server/src/main/java/com/appsmith/server/domains/ce/OrganizationConfigurationCE.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package com.appsmith.server.domains.ce;

import com.appsmith.external.enums.FeatureFlagEnum;
import com.appsmith.server.constants.FeatureMigrationType;
import com.appsmith.server.constants.LicensePlan;
import com.appsmith.server.constants.MigrationStatus;
Expand Down Expand Up @@ -58,7 +57,7 @@ public class OrganizationConfigurationCE implements Serializable {
// the feature flags. This can happen for 2 reasons:
// 1. The license plan changes
// 2. Because of grandfathering via cron where organization level feature flags are fetched
Map<FeatureFlagEnum, FeatureMigrationType> featuresWithPendingMigration;
Map<String, FeatureMigrationType> featuresWithPendingMigration;

Boolean isStrongPasswordPolicyEnabled;

Expand Down
5 changes: 2 additions & 3 deletions ...ith-server/src/main/java/com/appsmith/server/helpers/ce/FeatureFlagMigrationHelperCE.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@

public interface FeatureFlagMigrationHelperCE {

Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration(
Organization defaultOrganization);
Mono<Map<String, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration(Organization defaultOrganization);

Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration(
Mono<Map<String, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration(
Organization organization, boolean forceUpdate);

Mono<Boolean> checkAndExecuteMigrationsForFeatureFlag(Organization organization, FeatureFlagEnum featureFlagEnum);
Expand Down
51 changes: 23 additions & 28 deletions ...server/src/main/java/com/appsmith/server/helpers/ce/FeatureFlagMigrationHelperCEImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import com.appsmith.server.featureflags.CachedFeatures;
import com.appsmith.server.helpers.CollectionUtils;
import com.appsmith.server.services.CacheableFeatureFlagHelper;
import com.appsmith.server.solutions.ce.ScheduledTaskCEImpl;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import reactor.core.publisher.Mono;
Expand Down Expand Up @@ -36,7 +37,7 @@ public class FeatureFlagMigrationHelperCEImpl implements FeatureFlagMigrationHel
private static final long ORGANIZATION_FEATURES_CACHE_TIME_MIN = 115;

@Override
public Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration(
public Mono<Map<String, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration(
Organization defaultOrganization) {
return getUpdatedFlagsWithPendingMigration(defaultOrganization, FALSE);
}
Expand All @@ -49,7 +50,7 @@ public Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendi
* @return Map of feature flags with pending migrations
*/
@Override
public Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration(
public Mono<Map<String, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration(
Organization organization, boolean forceUpdate) {

/*
Expand Down Expand Up @@ -127,50 +128,43 @@ private Mono<CachedFeatures> refreshOrganizationFeatures(
* @param existingCachedFlags Flags which are already stored in cache
* @return updated organization with the required flags with pending migrations
*/
private Map<FeatureFlagEnum, FeatureMigrationType> getUpdatedFlagsWithPendingMigration(
private Map<String, FeatureMigrationType> getUpdatedFlagsWithPendingMigration(
Organization organization, CachedFeatures latestFlags, CachedFeatures existingCachedFlags) {

// 1. Check if there are any diffs for the feature flags
// 2. Update the flags for pending migration within provided organization object
Map<FeatureFlagEnum, FeatureMigrationType> featureDiffsWithMigrationType = new HashMap<>();
Map<String, FeatureMigrationType> featureDiffsWithMigrationType = new HashMap<>();
Map<String, Boolean> existingFeatureMap = existingCachedFlags.getFeatures();
latestFlags.getFeatures().forEach((key, value) -> {
if (value != null && !value.equals(existingFeatureMap.get(key))) {
try {
featureDiffsWithMigrationType.put(
FeatureFlagEnum.valueOf(key), Boolean.TRUE.equals(value) ? ENABLE : DISABLE);
featureDiffsWithMigrationType.put(key, Boolean.TRUE.equals(value) ? ENABLE : DISABLE);
} catch (Exception e) {
// Ignore IllegalArgumentException as all the feature flags are not added on
// server side
if (!(e instanceof IllegalArgumentException)) {
log.error("Error while parsing the feature flag {} with value {}", key, value, e);
}
log.error("Error while processing the feature flag {} with value {}", key, value, e);
}
}
});
return getUpdatedFlagsWithPendingMigration(featureDiffsWithMigrationType, organization);
}

private Map<FeatureFlagEnum, FeatureMigrationType> getUpdatedFlagsWithPendingMigration(
Map<FeatureFlagEnum, FeatureMigrationType> latestFeatureDiffsWithMigrationType,
Organization dbOrganization) {
private Map<String, FeatureMigrationType> getUpdatedFlagsWithPendingMigration(
Map<String, FeatureMigrationType> latestFeatureDiffsWithMigrationType, Organization dbOrganization) {

Map<FeatureFlagEnum, FeatureMigrationType> featuresWithPendingMigrationDB =
Map<String, FeatureMigrationType> featuresWithPendingMigrationDB =
dbOrganization.getOrganizationConfiguration().getFeaturesWithPendingMigration() == null
? new HashMap<>()
: dbOrganization.getOrganizationConfiguration().getFeaturesWithPendingMigration();

Map<FeatureFlagEnum, FeatureMigrationType> updatedFlagsForMigrations =
new HashMap<>(featuresWithPendingMigrationDB);
Map<String, FeatureMigrationType> updatedFlagsForMigrations = new HashMap<>(featuresWithPendingMigrationDB);

// We should expect the following state after the latest run:
// featuresWithPendingMigrationDB => {feature1 : enable, feature2 : disable}
// latestFeatureDiffsWithMigrationType => {feature1 : enable, feature2 : enable, feature3 : disable}
// updatedFlagsForMigrations => {feature1 : enable, feature3 : disable}
List<FeatureFlagEnum> featureFlagsToBeRemoved = new ArrayList<>();
updatedFlagsForMigrations.forEach((featureFlagEnum, featureMigrationType) -> {
if (latestFeatureDiffsWithMigrationType.containsKey(featureFlagEnum)
&& !featureMigrationType.equals(latestFeatureDiffsWithMigrationType.get(featureFlagEnum))) {
List<String> featureFlagsToBeRemoved = new ArrayList<>();
updatedFlagsForMigrations.forEach((featureFlag, featureMigrationType) -> {
if (latestFeatureDiffsWithMigrationType.containsKey(featureFlag)
&& !featureMigrationType.equals(latestFeatureDiffsWithMigrationType.get(featureFlag))) {
/*
Scenario when the migrations will be blocked on user input and may end up in a case where we just have
to remove the entry as migration is no longer needed:
Expand All @@ -182,7 +176,7 @@ with disable type (This will happen via cron to check the license status)
Step 4: User adds the valid key or renews the subscription again which results in enabling the
feature and ends up in nullifying the effect for step 2
*/
featureFlagsToBeRemoved.add(featureFlagEnum);
featureFlagsToBeRemoved.add(featureFlag);
}
});

Expand Down Expand Up @@ -217,16 +211,16 @@ public Mono<Boolean> checkAndExecuteMigrationsForFeatureFlag(
return Mono.just(TRUE);
}

Map<FeatureFlagEnum, FeatureMigrationType> featuresWithPendingMigration =
Map<String, FeatureMigrationType> featuresWithPendingMigration =
organizationConfiguration.getFeaturesWithPendingMigration();
if (CollectionUtils.isNullOrEmpty(featuresWithPendingMigration)
|| !featuresWithPendingMigration.containsKey(featureFlagEnum)) {
|| !featuresWithPendingMigration.containsKey(featureFlagEnum.name())) {
return Mono.just(TRUE);
}
log.debug(
"Running the migration for flag {} with migration type {}",
featureFlagEnum.name(),
featuresWithPendingMigration.get(featureFlagEnum));
featuresWithPendingMigration.get(featureFlagEnum.name()));
return this.executeMigrationsBasedOnFeatureFlag(organization, featureFlagEnum);
});
}
Expand All @@ -238,7 +232,7 @@ public Mono<Boolean> checkAndExecuteMigrationsForFeatureFlag(
* @return Boolean indicating if the migrations is required or not
*/
private Mono<Boolean> isMigrationRequired(Organization organization, FeatureFlagEnum featureFlagEnum) {
Map<FeatureFlagEnum, FeatureMigrationType> featureMigrationTypeMap =
Map<String, FeatureMigrationType> featureMigrationTypeMap =
organization.getOrganizationConfiguration().getFeaturesWithPendingMigration();
if (CollectionUtils.isNullOrEmpty(featureMigrationTypeMap)) {
return Mono.just(FALSE);
Expand All @@ -250,10 +244,10 @@ private Mono<Boolean> isMigrationRequired(Organization organization, FeatureFlag
if (featureFlags.containsKey(featureFlagEnum.name())) {
return (TRUE.equals(featureFlags.get(featureFlagEnum.name()))
&& FeatureMigrationType.ENABLE.equals(
featureMigrationTypeMap.get(featureFlagEnum)))
featureMigrationTypeMap.get(featureFlagEnum.name())))
|| (FALSE.equals(featureFlags.get(featureFlagEnum.name()))
&& FeatureMigrationType.DISABLE.equals(
featureMigrationTypeMap.get(featureFlagEnum)));
featureMigrationTypeMap.get(featureFlagEnum.name())));
}
return FALSE;
});
Expand All @@ -268,6 +262,7 @@ private Mono<Boolean> isMigrationRequired(Organization organization, FeatureFlag
@Override
public Mono<Boolean> executeMigrationsBasedOnFeatureFlag(
Organization organization, FeatureFlagEnum featureFlagEnum) {
// Placeholder implementation for extending classes
return Mono.just(TRUE);
}
}
21 changes: 16 additions & 5 deletions ...smith-server/src/main/java/com/appsmith/server/services/ce/OrganizationServiceCEImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,16 +290,27 @@ public Mono<Organization> checkAndExecuteMigrationsForOrganizationFeatureFlags(O
if (!isMigrationRequired(organization)) {
return Mono.just(organization);
}
Map<FeatureFlagEnum, FeatureMigrationType> featureMigrationTypeMap =
Map<String, FeatureMigrationType> featureMigrationTypeMap =
organization.getOrganizationConfiguration().getFeaturesWithPendingMigration();

FeatureFlagEnum featureFlagEnum =
final String featureFlagKey =
featureMigrationTypeMap.keySet().stream().findFirst().orElse(null);

FeatureFlagEnum featureFlagEnum = null;
if (featureFlagKey != null) {
try {
featureFlagEnum = FeatureFlagEnum.valueOf(featureFlagKey);
} catch (IllegalArgumentException e) {
log.warn("Unknown feature flag: {}", featureFlagKey);
}
}

final FeatureFlagEnum finalFeatureFlagEnum = featureFlagEnum;
return featureFlagMigrationHelper
.checkAndExecuteMigrationsForFeatureFlag(organization, featureFlagEnum)
.checkAndExecuteMigrationsForFeatureFlag(organization, finalFeatureFlagEnum)
.flatMap(isSuccessful -> {
if (TRUE.equals(isSuccessful)) {
featureMigrationTypeMap.remove(featureFlagEnum);
featureMigrationTypeMap.remove(featureFlagKey);
if (CollectionUtils.isNullOrEmpty(featureMigrationTypeMap)) {
organization.getOrganizationConfiguration().setMigrationStatus(MigrationStatus.COMPLETED);
} else {
Expand All @@ -312,7 +323,7 @@ public Mono<Organization> checkAndExecuteMigrationsForOrganizationFeatureFlags(O
.flatMap(this::checkAndExecuteMigrationsForOrganizationFeatureFlags);
}
return Mono.error(
new AppsmithException(AppsmithError.FeatureFlagMigrationFailure, featureFlagEnum, ""));
new AppsmithException(AppsmithError.FeatureFlagMigrationFailure, finalFeatureFlagEnum, ""));
});
}

Expand Down
19 changes: 9 additions & 10 deletions ...mith-server/src/test/java/com/appsmith/server/helpers/FeatureFlagMigrationHelperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package com.appsmith.server.helpers;

import com.appsmith.external.enums.FeatureFlagEnum;
import com.appsmith.server.constants.FeatureMigrationType;
import com.appsmith.server.domains.Organization;
import com.appsmith.server.domains.OrganizationConfiguration;
Expand Down Expand Up @@ -65,14 +64,14 @@ void getUpdatedFlagsWithPendingMigration_diffForExistingAndLatestFlag_pendingMig
Mockito.when(cacheableFeatureFlagHelper.evictCachedOrganizationFeatures(any()))
.thenReturn(Mono.empty());

Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
Mono<Map<String, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
featureFlagMigrationHelper.getUpdatedFlagsWithPendingMigration(defaultOrganization);

StepVerifier.create(getUpdatedFlagsWithPendingMigration)
.assertNext(featureFlagEnumFeatureMigrationTypeMap -> {
assertThat(featureFlagEnumFeatureMigrationTypeMap).isNotEmpty();
assertThat(featureFlagEnumFeatureMigrationTypeMap).hasSize(1);
assertThat(featureFlagEnumFeatureMigrationTypeMap.get(ORGANIZATION_TEST_FEATURE))
assertThat(featureFlagEnumFeatureMigrationTypeMap.get(ORGANIZATION_TEST_FEATURE.name()))
.isEqualTo(DISABLE);
})
.verifyComplete();
Expand Down Expand Up @@ -103,14 +102,14 @@ void getUpdatedFlagsWithPendingMigration_diffForExistingAndLatestFlag_pendingMig
Mockito.when(cacheableFeatureFlagHelper.evictCachedOrganizationFeatures(any()))
.thenReturn(Mono.empty());

Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
Mono<Map<String, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
featureFlagMigrationHelper.getUpdatedFlagsWithPendingMigration(defaultOrganization);

StepVerifier.create(getUpdatedFlagsWithPendingMigration)
.assertNext(featureFlagEnumFeatureMigrationTypeMap -> {
assertThat(featureFlagEnumFeatureMigrationTypeMap).isNotEmpty();
assertThat(featureFlagEnumFeatureMigrationTypeMap).hasSize(1);
assertThat(featureFlagEnumFeatureMigrationTypeMap.get(ORGANIZATION_TEST_FEATURE))
assertThat(featureFlagEnumFeatureMigrationTypeMap.get(ORGANIZATION_TEST_FEATURE.name()))
.isEqualTo(ENABLE);
})
.verifyComplete();
Expand All @@ -134,7 +133,7 @@ void getUpdatedFlagsWithPendingMigration_noDiffForExistingAndLatestFlag_noPendin
Mockito.when(cacheableFeatureFlagHelper.evictCachedOrganizationFeatures(any()))
.thenReturn(Mono.empty());

Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
Mono<Map<String, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
featureFlagMigrationHelper.getUpdatedFlagsWithPendingMigration(defaultOrganization);

StepVerifier.create(getUpdatedFlagsWithPendingMigration)
Expand Down Expand Up @@ -172,7 +171,7 @@ void getUpdatedFlagsWithPendingMigration_fetchOrganizationFlagsFailedFromCS_pend
Mockito.when(cacheableFeatureFlagHelper.evictCachedOrganizationFeatures(any()))
.thenReturn(Mono.empty());

Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
Mono<Map<String, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
featureFlagMigrationHelper.getUpdatedFlagsWithPendingMigration(defaultOrganization);

StepVerifier.create(getUpdatedFlagsWithPendingMigration)
Expand All @@ -198,7 +197,7 @@ void checkAndExecuteMigrationsForFeatureFlag_nullFeatureFlag_success() {
void checkAndExecuteMigrationsForFeatureFlag_validFeatureFlag_success() {
Organization defaultOrganization = new Organization();
OrganizationConfiguration organizationConfiguration = new OrganizationConfiguration();
organizationConfiguration.setFeaturesWithPendingMigration(Map.of(ORGANIZATION_TEST_FEATURE, ENABLE));
organizationConfiguration.setFeaturesWithPendingMigration(Map.of(ORGANIZATION_TEST_FEATURE.name(), ENABLE));
organizationConfiguration.setMigrationStatus(PENDING);
defaultOrganization.setOrganizationConfiguration(organizationConfiguration);

Expand Down Expand Up @@ -231,7 +230,7 @@ void checkAndExecuteMigrationsForFeatureFlag_validFeatureFlag_success() {
Organization defaultOrganization = new Organization();
defaultOrganization.setId(UUID.randomUUID().toString());
OrganizationConfiguration organizationConfiguration = new OrganizationConfiguration();
organizationConfiguration.setFeaturesWithPendingMigration(Map.of(ORGANIZATION_TEST_FEATURE, DISABLE));
organizationConfiguration.setFeaturesWithPendingMigration(Map.of(ORGANIZATION_TEST_FEATURE.name(), DISABLE));
defaultOrganization.setOrganizationConfiguration(organizationConfiguration);

// Mock CS calls to fetch the feature flags to have the feature flag in pending migration list with ENABLE
Expand All @@ -256,7 +255,7 @@ void checkAndExecuteMigrationsForFeatureFlag_validFeatureFlag_success() {
Mockito.when(cacheableFeatureFlagHelper.evictCachedOrganizationFeatures(any()))
.thenReturn(Mono.empty());

Mono<Map<FeatureFlagEnum, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
Mono<Map<String, FeatureMigrationType>> getUpdatedFlagsWithPendingMigration =
featureFlagMigrationHelper.getUpdatedFlagsWithPendingMigration(defaultOrganization);

StepVerifier.create(getUpdatedFlagsWithPendingMigration)
Expand Down
Loading