Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: Move signup_disabled and form_login_enabled from envs to DB (#39882)

Browse Source 
## 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._


/test Settings

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/14058953075>
> Commit: 80445acc542f201c01a40a09323097a946959e50
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=14058953075&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Settings`
> Spec:
> <hr>Tue, 25 Mar 2025 12:19:59 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Organizations now control form login and signup behavior with updated,
clearer configuration flags.
- **Refactor**
- Renamed settings to reflect an enabled state for form login and a
disabled state for signup.
- Removed deprecated restart functionality and reorganized utility
classes for improved maintainability.
- **Chores/Tests**
- Updated tests and environment examples to align with the new
configuration settings and ensure consistent behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
Abhijeet 2025-03-26 11:26:00 +05:30 committed by GitHub
parent 93fdfc967d
commit 73e239b9f8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
38 changed files with 260 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
app/client/cypress/e2e/Regression/ClientSide/FormLogin/EnableFormLogin_spec.js
View File

@ -83,8 +83,8 @@ describe("Form Login test functionality", function () {
cy.get(adminSettings.formloginButton).click();
cy.wait(2000);
// disable form signup
cy.get(adminSettings.formLoginDisabled).should("have.value", "on");
cy.get(adminSettings.formLoginDisabled).click({ force: true });
cy.get(adminSettings.formLoginEnabled).should("have.value", "on");
cy.get(adminSettings.formLoginEnabled).click({ force: true });
cy.wait(2000);
// assert server is restarting
cy.get(adminSettings.saveButton).should("be.visible");
@ -109,7 +109,7 @@ describe("Form Login test functionality", function () {
.should("be.visible")
.should("contain", "Enable");
cy.get(adminSettings.formloginButton).click();
cy.get(adminSettings.formLoginDisabled).click({ force: true });
cy.get(adminSettings.formLoginEnabled).click({ force: true });
cy.wait(2000);
// assert server is restarting
cy.get(adminSettings.saveButton).should("be.visible");

4
app/client/cypress/locators/AdminsSettings.js
View File

@ -24,8 +24,8 @@ export default {
loginWithGoogle: "[data-testid='login-with-Google']",
loginWithGithub: "[data-testid='login-with-Github']",
disconnectBtn: "[data-testid='disconnect-service-button']",
formSignupDisabled: "[data-testid='APPSMITH_SIGNUP_DISABLED']",
formLoginDisabled: "[data-testid='APPSMITH_FORM_LOGIN_DISABLED']",
formSignupDisabled: "[data-testid='isSignupDisabled']",
formLoginEnabled: "[data-testid='isFormLoginEnabled']",
embedSettings: ".t--admin-settings-APPSMITH_ALLOWED_FRAME_ANCESTORS",
upgrade: "[data-testid='t--button-upgrade']",
accessControl: ".t--settings-category-access-control",

2
app/client/src/ce/constants/organizationConstants.ts
View File

@ -7,6 +7,8 @@ export const organizationConfigConnection: string[] = [
"hideWatermark",
"userSessionTimeoutInMinutes",
"isAtomicPushAllowed",
"isFormLoginEnabled",
"isSignupDisabled",
];
export const RESTART_POLL_TIMEOUT = 2 * 150 * 1000;

4
app/client/src/ce/pages/AdminSettings/config/authentication.tsx
View File

@ -48,13 +48,13 @@ const FormAuth: AdminConfigType = {
canSave: true,
settings: [
{
id: "APPSMITH_FORM_LOGIN_DISABLED",
id: "isFormLoginEnabled",
category: SettingCategories.FORM_AUTH,
controlType: SettingTypes.TOGGLE,
label: "form login",
},
{
id: "APPSMITH_SIGNUP_DISABLED",
id: "isSignupDisabled",
category: SettingCategories.FORM_AUTH,
controlType: SettingTypes.TOGGLE,
label: "Form signup",

16
app/client/src/ce/sagas/organizationSagas.tsx
View File

@ -69,6 +69,10 @@ export function* updateOrganizationConfigSaga(
"emailVerificationEnabled",
);
const hasFormLoginSetting = settings.hasOwnProperty("isFormLoginEnabled");
const hasSignupDisabledSetting =
settings.hasOwnProperty("isSignupDisabled");
const response: ApiResponse = yield call(
OrganizationApi.updateOrganizationConfig,
action.payload,
@ -94,6 +98,18 @@ export function* updateOrganizationConfigSaga(
});
}
if (hasFormLoginSetting) {
AnalyticsUtil.logEvent("GENERAL_SETTINGS_UPDATE", {
enabled: settings["isFormLoginEnabled"],
});
}
if (hasSignupDisabledSetting) {
AnalyticsUtil.logEvent("GENERAL_SETTINGS_UPDATE", {
enabled: settings["isSignupDisabled"],
});
}
if (hasEmailVerificationSetting) {
AnalyticsUtil.logEvent("EMAIL_VERIFICATION_SETTING_UPDATE", {
enabled: settings["emailVerificationEnabled"],

3
app/client/src/ce/selectors/organizationSelectors.tsx
View File

@ -48,6 +48,9 @@ export const getThirdPartyAuths = (state: AppState): string[] =>
export const getIsFormLoginEnabled = (state: AppState): boolean =>
state.organization?.organizationConfiguration?.isFormLoginEnabled ?? true;
export const getIsSignupDisabled = (state: AppState): boolean =>
state.organization?.organizationConfiguration?.isSignupDisabled ?? false;
export const getInstanceId = (state: AppState): string =>
state.organization?.instanceId;

3
app/client/src/ce/utils/adminSettingsHelpers.ts
View File

@ -18,8 +18,7 @@ export const saveAllowed = (
socialLoginList.length + (isFormLoginEnabled ? 1 : 0);
if (connectedMethodsCount === 1) {
const checkFormLogin =
!("APPSMITH_FORM_LOGIN_DISABLED" in settings) && isFormLoginEnabled,
const checkFormLogin = isFormLoginEnabled,
checkGoogleAuth =
settings["APPSMITH_OAUTH2_GOOGLE_CLIENT_ID"] !== "" &&
socialLoginList.includes("google"),

37
app/client/src/pages/AdminSettings/SettingsForm.tsx
View File

@ -1,4 +1,4 @@
import React, { useCallback, useEffect, useMemo } from "react";
import React, { useCallback, useEffect, useMemo, useState } from "react";
import { saveSettings } from "ee/actions/settingsAction";
import { SETTINGS_FORM_NAME } from "ee/constants/forms";
import { ReduxActionTypes } from "ee/constants/ReduxActionConstants";
@ -89,6 +89,8 @@ export function SettingsForm(
);
const isFormLoginEnabled = useSelector(getIsFormLoginEnabled);
const socialLoginList = useSelector(getThirdPartyAuths);
const [initialFormLoginEnabled, setInitialFormLoginEnabled] =
useState(isFormLoginEnabled);
const updatedOrganizationSettings = useMemo(
() => Object.keys(props.settings).filter((s) => isOrganizationConfig(s)),
@ -103,6 +105,11 @@ export function SettingsForm(
!isOrganizationConfig(s.id),
);
// Store the initial value of isFormLoginEnabled on component mount
useEffect(() => {
setInitialFormLoginEnabled(isFormLoginEnabled);
}, [category, subCategory]);
const saveChangedSettings = () => {
const settingsKeyLength = Object.keys(props.settings).length;
const isOnlyEnvSettings =
@ -151,7 +158,23 @@ export function SettingsForm(
const onSave = () => {
if (checkMandatoryFileds()) {
if (saveAllowed(props.settings, isFormLoginEnabled, socialLoginList)) {
// Use initialFormLoginEnabled instead of the current state value for the check
let effectiveFormLoginEnabled = initialFormLoginEnabled;
// Check if isFormLoginEnabled is being updated in the current form
if (props.settings["isFormLoginEnabled"] !== undefined) {
// Convert to boolean if it's a string, otherwise use as is since we expect a boolean
const settingValue = props.settings["isFormLoginEnabled"];
effectiveFormLoginEnabled =
typeof settingValue === "string"
? settingValue === "true"
: Boolean(settingValue);
}
if (
saveAllowed(props.settings, effectiveFormLoginEnabled, socialLoginList)
) {
AnalyticsUtil.logEvent("ADMIN_SETTINGS_SAVE", {
method: pageTitle,
});
@ -224,6 +247,13 @@ export function SettingsForm(
useEffect(onClear, [subCategory]);
useEffect(() => {
// Reset the initialFormLoginEnabled value when navigating to a different category
return () => {
setInitialFormLoginEnabled(isFormLoginEnabled);
};
}, [category, subCategory]);
const onReleaseNotesClose = useCallback(() => {
dispatch({
type: ReduxActionTypes.TOGGLE_RELEASE_NOTES,
@ -244,8 +274,9 @@ export function SettingsForm(
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const updatedSettings: any = {};
// Use the initial value to determine if there are enough login methods
const connectedMethodsCount =
socialLoginList.length + (isFormLoginEnabled ? 1 : 0);
socialLoginList.length + (initialFormLoginEnabled ? 1 : 0);
if (connectedMethodsCount >= 2) {
_.forEach(currentSettings, (setting: Setting) => {

2
app/server/appsmith-server/src/main/java/com/appsmith/server/authentication/handlers/AuthenticationSuccessHandler.java
View File

@ -1,9 +1,9 @@
package com.appsmith.server.authentication.handlers;
import com.appsmith.server.authentication.handlers.ce.AuthenticationSuccessHandlerCE;
import com.appsmith.server.helpers.InstanceVariablesHelper;
import com.appsmith.server.helpers.RedirectHelper;
import com.appsmith.server.helpers.WorkspaceServiceHelper;
import com.appsmith.server.instanceconfigs.helpers.InstanceVariablesHelper;
import com.appsmith.server.ratelimiting.RateLimitService;
import com.appsmith.server.repositories.UserRepository;
import com.appsmith.server.repositories.WorkspaceRepository;

8
app/server/appsmith-server/src/main/java/com/appsmith/server/authentication/handlers/ce/AuthenticationSuccessHandlerCE.java
View File

@ -10,9 +10,9 @@ import com.appsmith.server.domains.LoginSource;
import com.appsmith.server.domains.User;
import com.appsmith.server.domains.Workspace;
import com.appsmith.server.dtos.ResendEmailVerificationDTO;
import com.appsmith.server.helpers.InstanceVariablesHelper;
import com.appsmith.server.helpers.RedirectHelper;
import com.appsmith.server.helpers.WorkspaceServiceHelper;
import com.appsmith.server.instanceconfigs.helpers.InstanceVariablesHelper;
import com.appsmith.server.ratelimiting.RateLimitService;
import com.appsmith.server.repositories.UserRepository;
import com.appsmith.server.repositories.WorkspaceRepository;
@ -103,13 +103,13 @@ public class AuthenticationSuccessHandlerCE implements ServerAuthenticationSucce
return Mono.just(FALSE);
} else {
return emailVerificationEnabledMono.flatMap(emailVerificationEnabled -> {
// email verification not enabled at the org
// email verification not enabled
if (!TRUE.equals(emailVerificationEnabled)) {
user.setEmailVerificationRequired(FALSE);
return userRepository.save(user).then(Mono.just(FALSE));
} else {
// scenario when at the time of signup, the email verification was disabled at the org
// but later on turned on, now when this user logs in, it will not be prompted to verify
// scenario when at the time of signup, the email verification was disabled but later on
// turned on, now when this user logs in, it will not be prompted to verify
// as the configuration at time of signup is considered for any user.
// for old users, the login works as expected, without the need to verify
if (!TRUE.equals(user.getEmailVerificationRequired())) {

9
app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/CommonConfig.java
View File

@ -36,9 +36,6 @@ public class CommonConfig {
public static final Integer LATEST_INSTANCE_SCHEMA_VERSION = 2;
@Setter(AccessLevel.NONE)
private boolean isSignupDisabled = false;
@Setter(AccessLevel.NONE)
private Set<String> adminEmails = Collections.emptySet();
@ -129,12 +126,6 @@ public class CommonConfig {
adminEmails = Set.of(value.trim().split("\\s*,\\s*"));
}
@Autowired
public void setSignupDisabled(@Value("${signup.disabled}") String value) {
// If `true`, then disable signup. If anything else, including empty string, then signups will be enabled.
isSignupDisabled = "true".equalsIgnoreCase(value);
}
public Long getCurrentTimeInstantEpochMilli() {
return Instant.now().toEpochMilli();
}

2
app/server/appsmith-server/src/main/java/com/appsmith/server/constants/EnvVariables.java
View File

@ -13,7 +13,6 @@ public enum EnvVariables {
APPSMITH_MAIL_USERNAME,
APPSMITH_MAIL_PASSWORD,
APPSMITH_MAIL_SMTP_TLS_ENABLED,
APPSMITH_SIGNUP_DISABLED,
APPSMITH_SIGNUP_ALLOWED_DOMAINS,
APPSMITH_ADMIN_EMAILS,
APPSMITH_RECAPTCHA_SITE_KEY,
@ -24,7 +23,6 @@ public enum EnvVariables {
APPSMITH_OAUTH2_GITHUB_CLIENT_ID,
APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET,
APPSMITH_CUSTOM_DOMAIN,
APPSMITH_FORM_LOGIN_DISABLED,
APPSMITH_ALLOWED_FRAME_ANCESTORS,
APPSMITH_DISABLE_IFRAME_WIDGET_SANDBOX,
APPSMITH_NEW_RELIC_ACCOUNT_ENABLE,

7
app/server/appsmith-server/src/main/java/com/appsmith/server/domains/Organization.java
View File

@ -12,8 +12,6 @@ import org.springframework.data.mongodb.core.mapping.Document;
import java.io.Serializable;
import static com.appsmith.external.helpers.StringUtils.dotted;
@Getter
@Setter
@ToString
@ -38,8 +36,5 @@ public class Organization extends BaseDomain implements Serializable {
// TODO add SSO and other configurations here after migrating from environment variables to database configuration
public static class Fields extends BaseDomain.Fields {
public static final String organizationConfiguration_isRestartRequired =
dotted(organizationConfiguration, OrganizationConfiguration.Fields.isRestartRequired);
}
public static class Fields extends BaseDomain.Fields {}
}

7
app/server/appsmith-server/src/main/java/com/appsmith/server/domains/ce/OrganizationConfigurationCE.java
View File

@ -27,6 +27,8 @@ public class OrganizationConfigurationCE implements Serializable {
private Boolean isFormLoginEnabled;
private Boolean isSignupDisabled;
@Transient
@Deprecated(forRemoval = true, since = "v1.65")
private String instanceName;
@ -58,10 +60,6 @@ public class OrganizationConfigurationCE implements Serializable {
// 2. Because of grandfathering via cron where organization level feature flags are fetched
Map<FeatureFlagEnum, FeatureMigrationType> featuresWithPendingMigration;
// This variable is used to indicate if the server needs to be restarted after the migration based on feature flags
// is complete.
Boolean isRestartRequired;
Boolean isStrongPasswordPolicyEnabled;
private Boolean isAtomicPushAllowed = false;
@ -84,6 +82,7 @@ public class OrganizationConfigurationCE implements Serializable {
googleMapsKey = ObjectUtils.defaultIfNull(organizationConfiguration.getGoogleMapsKey(), googleMapsKey);
isFormLoginEnabled =
ObjectUtils.defaultIfNull(organizationConfiguration.getIsFormLoginEnabled(), isFormLoginEnabled);
isSignupDisabled = ObjectUtils.defaultIfNull(organizationConfiguration.getIsSignupDisabled(), isSignupDisabled);
instanceName = ObjectUtils.defaultIfNull(organizationConfiguration.getInstanceName(), instanceName);
emailVerificationEnabled = ObjectUtils.defaultIfNull(
organizationConfiguration.getEmailVerificationEnabled(), emailVerificationEnabled);

4
app/server/appsmith-server/src/main/java/com/appsmith/server/exceptions/AppsmithError.java
View File

@ -912,9 +912,9 @@ public enum AppsmithError {
ErrorType.INTERNAL_ERROR,
null),
ORGANIZATION_EMAIL_VERIFICATION_NOT_ENABLED(
EMAIL_VERIFICATION_NOT_ENABLED(
400,
AppsmithErrorCode.ORGANIZATION_EMAIL_VERIFICATION_NOT_ENABLED.getCode(),
AppsmithErrorCode.EMAIL_VERIFICATION_NOT_ENABLED.getCode(),
"Email verification is not enabled. Please contact your admin",
AppsmithErrorAction.DEFAULT,
"Email verification not enabled",

2
app/server/appsmith-server/src/main/java/com/appsmith/server/exceptions/AppsmithErrorCode.java
View File

@ -123,7 +123,7 @@ public enum AppsmithErrorCode {
USER_EMAIL_ALREADY_VERIFIED("AE-EMV-4095", "User email already verified"),
EMAIL_VERIFICATION_TOKEN_EXPIRED("AE-EMV-4096", "Email Verification Token expired"),
ORGANIZATION_EMAIL_VERIFICATION_NOT_ENABLED("AE-EMV-4097", "Email Verification not enabled"),
EMAIL_VERIFICATION_NOT_ENABLED("AE-EMV-4097", "Email Verification not enabled"),
INVALID_EMAIL_VERIFICATION("AE-EMV-4098", "Invalid email verification request"),

3
app/server/appsmith-server/src/main/java/com/appsmith/server/instanceconfigs/constants/AllowedInstanceVariables.java Normal file
View File

@ -0,0 +1,3 @@
package com.appsmith.server.instanceconfigs.constants;
public interface AllowedInstanceVariables extends AllowedInstanceVariablesCE {}

7
app/server/appsmith-server/src/main/java/com/appsmith/server/instanceconfigs/constants/AllowedInstanceVariablesCE.java Normal file
View File

@ -0,0 +1,7 @@
package com.appsmith.server.instanceconfigs.constants;
public interface AllowedInstanceVariablesCE {
String INSTANCE_NAME = "instanceName";
String EMAIL_VERIFICATION_ENABLED = "emailVerificationEnabled";
String GOOGLE_MAPS_KEY = "googleMapsKey";
}

7
app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/InstanceVariablesHelper.java → app/server/appsmith-server/src/main/java/com/appsmith/server/instanceconfigs/helpers/InstanceVariablesHelper.java
View File

@ -1,17 +1,12 @@
package com.appsmith.server.helpers;
package com.appsmith.server.instanceconfigs.helpers;
import com.appsmith.server.helpers.ce.InstanceVariablesHelperCE;
import com.appsmith.server.services.ConfigService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
/**
* Helper class for accessing instance variables from the instance config
*/
@Component
@Slf4j
public class InstanceVariablesHelper extends InstanceVariablesHelperCE {
public InstanceVariablesHelper(ConfigService configService) {
super(configService);
}

24
app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/ce/InstanceVariablesHelperCE.java → app/server/appsmith-server/src/main/java/com/appsmith/server/instanceconfigs/helpers/InstanceVariablesHelperCE.java
View File

@ -1,4 +1,4 @@
package com.appsmith.server.helpers.ce;
package com.appsmith.server.instanceconfigs.helpers;
import com.appsmith.server.constants.Appsmith;
import com.appsmith.server.domains.OrganizationConfiguration;
@ -10,6 +10,10 @@ import reactor.core.publisher.Mono;
import java.util.HashMap;
import java.util.Map;
import static com.appsmith.server.instanceconfigs.constants.AllowedInstanceVariables.EMAIL_VERIFICATION_ENABLED;
import static com.appsmith.server.instanceconfigs.constants.AllowedInstanceVariables.GOOGLE_MAPS_KEY;
import static com.appsmith.server.instanceconfigs.constants.AllowedInstanceVariables.INSTANCE_NAME;
/**
* Helper class for accessing instance variables from the instance config
*/
@ -23,7 +27,7 @@ public class InstanceVariablesHelperCE {
*/
public Mono<String> getInstanceName() {
return configService.getInstanceVariables().map(instanceVariables -> {
Object value = instanceVariables.getOrDefault("instanceName", Appsmith.DEFAULT_INSTANCE_NAME);
Object value = instanceVariables.getOrDefault(INSTANCE_NAME, Appsmith.DEFAULT_INSTANCE_NAME);
return value != null ? value.toString() : Appsmith.DEFAULT_INSTANCE_NAME;
});
}
@ -34,7 +38,7 @@ public class InstanceVariablesHelperCE {
*/
public Mono<Boolean> isEmailVerificationEnabled() {
return configService.getInstanceVariables().map(instanceVariables -> {
Object value = instanceVariables.getOrDefault("emailVerificationEnabled", false);
Object value = instanceVariables.getOrDefault(EMAIL_VERIFICATION_ENABLED, false);
if (value instanceof Boolean) {
return (Boolean) value;
}
@ -48,24 +52,24 @@ public class InstanceVariablesHelperCE {
*/
public Mono<String> getGoogleMapsKey() {
return configService.getInstanceVariables().map(instanceVariables -> {
Object value = instanceVariables.getOrDefault("googleMapsKey", "");
Object value = instanceVariables.getOrDefault(GOOGLE_MAPS_KEY, "");
return value != null ? value.toString() : "";
});
}
public OrganizationConfiguration populateOrgConfigWithInstanceVariables(
Map<String, Object> instanceVariables, OrganizationConfiguration organizationConfiguration) {
Object value = instanceVariables.getOrDefault("instanceName", Appsmith.DEFAULT_INSTANCE_NAME);
Object value = instanceVariables.getOrDefault(INSTANCE_NAME, Appsmith.DEFAULT_INSTANCE_NAME);
organizationConfiguration.setInstanceName(value != null ? value.toString() : Appsmith.DEFAULT_INSTANCE_NAME);
value = instanceVariables.getOrDefault("emailVerificationEnabled", false);
value = instanceVariables.getOrDefault(EMAIL_VERIFICATION_ENABLED, false);
if (value instanceof Boolean) {
organizationConfiguration.setEmailVerificationEnabled((Boolean) value);
} else {
organizationConfiguration.setEmailVerificationEnabled(Boolean.FALSE);
}
value = instanceVariables.getOrDefault("googleMapsKey", "");
value = instanceVariables.getOrDefault(GOOGLE_MAPS_KEY, "");
organizationConfiguration.setGoogleMapsKey(value != null ? value.toString() : "");
return organizationConfiguration;
@ -85,13 +89,13 @@ public class InstanceVariablesHelperCE {
protected Map<String, Object> updateAllowedInstanceVariables(OrganizationConfiguration orgConfig) {
Map<String, Object> instanceVariables = new HashMap<>();
if (StringUtils.hasLength(orgConfig.getInstanceName())) {
instanceVariables.put("instanceName", orgConfig.getInstanceName());
instanceVariables.put(INSTANCE_NAME, orgConfig.getInstanceName());
}
if (orgConfig.getEmailVerificationEnabled() != null) {
instanceVariables.put("emailVerificationEnabled", orgConfig.getEmailVerificationEnabled());
instanceVariables.put(EMAIL_VERIFICATION_ENABLED, orgConfig.getEmailVerificationEnabled());
}
if (StringUtils.hasLength(orgConfig.getGoogleMapsKey())) {
instanceVariables.put("googleMapsKey", orgConfig.getGoogleMapsKey());
instanceVariables.put(GOOGLE_MAPS_KEY, orgConfig.getGoogleMapsKey());
}
return instanceVariables;
}

51
app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration071MoveFormLoginDisabledToOrganizationConfiguration.java Normal file
View File

@ -0,0 +1,51 @@
package com.appsmith.server.migrations.db.ce;
import com.appsmith.server.configurations.CommonConfig;
import com.appsmith.server.domains.Organization;
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.apache.commons.lang3.StringUtils;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.data.mongodb.core.query.Update;
import java.io.IOException;
import static com.appsmith.server.migrations.db.ce.Migration021MoveGoogleMapsKeyToTenantConfiguration.commentEnvInFile;
@Slf4j
@RequiredArgsConstructor
@ChangeUnit(order = "071", id = "move-form-login-disabled-to-organization-configuration")
public class Migration071MoveFormLoginDisabledToOrganizationConfiguration {
private final MongoTemplate mongoTemplate;
private final CommonConfig commonConfig;
@RollbackExecution
public void rollbackExecution() {}
@Execution
public void executeMigration() throws IOException {
final String envName = "APPSMITH_FORM_LOGIN_DISABLED";
final String formLoginDisabledValue = System.getenv(envName);
// Default to false if the environment variable is not present or empty
boolean formLoginDisabled = false;
if (StringUtils.isNotEmpty(formLoginDisabledValue)) {
// Convert the string value to a boolean if env is present
formLoginDisabled = Boolean.parseBoolean(formLoginDisabledValue);
// Comment out the environment variable in the .env file
commentEnvInFile(envName, commonConfig.getEnvFilePath());
}
// Update all organizations to set the form login disabled configuration
// This happens whether the env var is present or not, defaulting to false
mongoTemplate.updateMulti(
new Query(),
new Update().set("organizationConfiguration.isFormLoginEnabled", !formLoginDisabled),
Organization.class);
}
}

52
app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration072MoveSignupDisabledToOrganizationConfiguration.java Normal file
View File

@ -0,0 +1,52 @@
package com.appsmith.server.migrations.db.ce;
import com.appsmith.server.configurations.CommonConfig;
import com.appsmith.server.domains.Organization;
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.apache.commons.lang3.StringUtils;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.data.mongodb.core.query.Update;
import java.io.IOException;
import static com.appsmith.server.migrations.db.ce.Migration021MoveGoogleMapsKeyToTenantConfiguration.commentEnvInFile;
@Slf4j
@RequiredArgsConstructor
@ChangeUnit(order = "072", id = "move-signup-disabled-to-organization-configuration")
public class Migration072MoveSignupDisabledToOrganizationConfiguration {
private final MongoTemplate mongoTemplate;
private final CommonConfig commonConfig;
@RollbackExecution
public void rollbackExecution() {}
@Execution
public void executeMigration() throws IOException {
final String envName = "APPSMITH_SIGNUP_DISABLED";
final String signupDisabledValue = System.getenv(envName);
// Default to false if the environment variable is not present or empty
boolean signupDisabled = false;
if (StringUtils.isNotEmpty(signupDisabledValue)) {
// Convert the string value to a boolean if env is present
signupDisabled = Boolean.parseBoolean(signupDisabledValue);
// Comment out the environment variable in the .env file
commentEnvInFile(envName, commonConfig.getEnvFilePath());
}
// Update all organizations to set the signup disabled configuration
// This happens whether the env var is present or not, defaulting to false
mongoTemplate.updateMulti(
new Query(),
new Update().set("organizationConfiguration.isSignupDisabled", signupDisabled),
Organization.class);
}
}

1
app/server/appsmith-server/src/main/java/com/appsmith/server/repositories/ce/CustomOrganizationRepositoryCE.java
View File

@ -7,7 +7,6 @@ import com.appsmith.server.repositories.AppsmithRepository;
import reactor.core.publisher.Mono;
public interface CustomOrganizationRepositoryCE extends AppsmithRepository<Organization> {
Mono<Integer> disableRestartForAllOrganizations();
Mono<Organization> findByIdAsUser(User user, String id, AclPermission permission);
}

10
app/server/appsmith-server/src/main/java/com/appsmith/server/repositories/ce/CustomOrganizationRepositoryCEImpl.java
View File

@ -9,20 +9,10 @@ import com.appsmith.server.repositories.BaseAppsmithRepositoryImpl;
import lombok.extern.slf4j.Slf4j;
import reactor.core.publisher.Mono;
import static com.appsmith.server.domains.Organization.Fields.organizationConfiguration_isRestartRequired;
@Slf4j
public class CustomOrganizationRepositoryCEImpl extends BaseAppsmithRepositoryImpl<Organization>
implements CustomOrganizationRepositoryCE {
@Override
public Mono<Integer> disableRestartForAllOrganizations() {
log.info("Disabling restart for all organizations");
return queryBuilder()
.criteria(Bridge.isTrue(organizationConfiguration_isRestartRequired))
.updateAll(Bridge.update().set(organizationConfiguration_isRestartRequired, false));
}
@Override
public Mono<Organization> findByIdAsUser(User user, String id, AclPermission permission) {
return getAllPermissionGroupsForUser(user).flatMap(permissionGroups -> queryBuilder()

2
app/server/appsmith-server/src/main/java/com/appsmith/server/services/OrganizationServiceImpl.java
View File

@ -2,8 +2,8 @@ package com.appsmith.server.services;
import com.appsmith.server.configurations.CommonConfig;
import com.appsmith.server.helpers.FeatureFlagMigrationHelper;
import com.appsmith.server.helpers.InstanceVariablesHelper;
import com.appsmith.server.helpers.UserOrganizationHelper;
import com.appsmith.server.instanceconfigs.helpers.InstanceVariablesHelper;
import com.appsmith.server.repositories.CacheableRepositoryHelper;
import com.appsmith.server.repositories.OrganizationRepository;
import com.appsmith.server.services.ce.OrganizationServiceCEImpl;

2
app/server/appsmith-server/src/main/java/com/appsmith/server/services/UserServiceImpl.java
View File

@ -2,9 +2,9 @@ package com.appsmith.server.services;
import com.appsmith.server.configurations.CommonConfig;
import com.appsmith.server.configurations.EmailConfig;
import com.appsmith.server.helpers.InstanceVariablesHelper;
import com.appsmith.server.helpers.UserServiceHelper;
import com.appsmith.server.helpers.UserUtils;
import com.appsmith.server.instanceconfigs.helpers.InstanceVariablesHelper;
import com.appsmith.server.notifications.EmailSender;
import com.appsmith.server.ratelimiting.RateLimitService;
import com.appsmith.server.repositories.ApplicationRepository;

2
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/OrganizationServiceCE.java
View File

@ -30,7 +30,5 @@ public interface OrganizationServiceCE extends CrudService<Organization, String>
Mono<Organization> retrieveById(String id);
Mono<Void> restartOrganization();
Flux<Organization> retrieveAll();
}

27
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/OrganizationServiceCEImpl.java
View File

@ -14,8 +14,8 @@ import com.appsmith.server.exceptions.AppsmithError;
import com.appsmith.server.exceptions.AppsmithException;
import com.appsmith.server.helpers.CollectionUtils;
import com.appsmith.server.helpers.FeatureFlagMigrationHelper;
import com.appsmith.server.helpers.InstanceVariablesHelper;
import com.appsmith.server.helpers.UserOrganizationHelper;
import com.appsmith.server.instanceconfigs.helpers.InstanceVariablesHelper;
import com.appsmith.server.repositories.CacheableRepositoryHelper;
import com.appsmith.server.repositories.OrganizationRepository;
import com.appsmith.server.services.AnalyticsService;
@ -175,8 +175,6 @@ public class OrganizationServiceCEImpl extends BaseService<OrganizationRepositor
config.addThirdPartyAuth("github");
}
config.setIsFormLoginEnabled(!"true".equals(System.getenv("APPSMITH_FORM_LOGIN_DISABLED")));
return configService
.getInstanceVariables()
.map(instanceVariables -> instanceVariablesHelper.populateOrgConfigWithInstanceVariables(
@ -342,29 +340,6 @@ public class OrganizationServiceCEImpl extends BaseService<OrganizationRepositor
.then(updatedOrganizationMono);
}
/**
* This function checks if the organization needs to be restarted, and executes the restart after the feature flag
* migrations are completed.
*
* @return Mono<Void>
*/
@Override
public Mono<Void> restartOrganization() {
// TODO @CloudBilling: remove this method once we move the form login env to DB variable which is currently
// required as a part of downgrade migration for SSO
return this.retrieveAll()
.filter(organization ->
TRUE.equals(organization.getOrganizationConfiguration().getIsRestartRequired()))
.take(1)
.hasElements()
.flatMap(hasElement -> {
if (hasElement) {
return repository.disableRestartForAllOrganizations().then(envManager.restartWithoutAclCheck());
}
return Mono.empty();
});
}
private boolean isMigrationRequired(Organization organization) {
return organization.getOrganizationConfiguration() != null
&& (!CollectionUtils.isNullOrEmpty(

34
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/UserServiceCEImpl.java
View File

@ -22,9 +22,9 @@ import com.appsmith.server.dtos.UserSignupDTO;
import com.appsmith.server.dtos.UserUpdateDTO;
import com.appsmith.server.exceptions.AppsmithError;
import com.appsmith.server.exceptions.AppsmithException;
import com.appsmith.server.helpers.InstanceVariablesHelper;
import com.appsmith.server.helpers.UserServiceHelper;
import com.appsmith.server.helpers.UserUtils;
import com.appsmith.server.instanceconfigs.helpers.InstanceVariablesHelper;
import com.appsmith.server.ratelimiting.RateLimitService;
import com.appsmith.server.repositories.EmailVerificationTokenRepository;
import com.appsmith.server.repositories.PasswordResetTokenRepository;
@ -557,17 +557,20 @@ public class UserServiceCEImpl extends BaseService<UserRepository, User, String>
*/
@Override
public Mono<User> signupIfAllowed(User user) {
boolean isAdminUser = false;
Mono<Boolean> isAdminUserMono;
if (!commonConfig.getAdminEmails().contains(user.getEmail())) {
// If this is not an admin email address, only then do we check if signup should be allowed or not. Being an
// explicitly set admin email address trumps all everything and signup for this email can never be disabled.
if (commonConfig.isSignupDisabled()) {
isAdminUserMono = organizationService.getCurrentUserOrganization().map(organization -> {
OrganizationConfiguration organizationConfiguration =
organization.getOrganizationConfiguration() == null
? new OrganizationConfiguration()
: organization.getOrganizationConfiguration();
if (TRUE.equals(organizationConfiguration.getIsSignupDisabled())) {
// Signing up has been globally disabled. Reject.
return Mono.error(new AppsmithException(AppsmithError.SIGNUP_DISABLED, user.getUsername()));
throw new AppsmithException(AppsmithError.SIGNUP_DISABLED, user.getUsername());
}
final List<String> allowedDomains = user.getSource() == LoginSource.FORM
? commonConfig.getAllowedDomains()
: commonConfig.getOauthAllowedDomains();
@ -575,19 +578,21 @@ public class UserServiceCEImpl extends BaseService<UserRepository, User, String>
&& StringUtils.hasText(user.getEmail())
&& user.getEmail().contains("@")
&& !allowedDomains.contains(user.getEmail().split("@")[1])) {
// There is an explicit whitelist of email address domains that should be allowed. If the new email is
// There is an explicit whitelist of email address domains that should be allowed. If the new email
// is
// of a different domain, reject.
return Mono.error(new AppsmithException(AppsmithError.SIGNUP_DISABLED, user.getUsername()));
throw new AppsmithException(AppsmithError.SIGNUP_DISABLED, user.getUsername());
}
return FALSE;
});
} else {
isAdminUser = true;
isAdminUserMono = Mono.just(true);
}
// First set the organization ID for the user
boolean finalIsAdminUser = isAdminUser;
// No special configurations found, allow signup for the new user.
return setOrganizationIdForUser(user)
// Then proceed with user creation
.flatMap(userWithOrgId -> userCreate(userWithOrgId, finalIsAdminUser))
.zipWhen(userWithOrgId -> isAdminUserMono)
.flatMap(tuple2 -> userCreate(tuple2.getT1(), tuple2.getT2()))
.elapsed()
.map(pair -> {
log.debug("UserServiceCEImpl::Time taken for create user: {} ms", pair.getT1());
@ -826,8 +831,7 @@ public class UserServiceCEImpl extends BaseService<UserRepository, User, String>
return instanceVariablesHelper.isEmailVerificationEnabled().flatMap(emailVerificationEnabled -> {
// Email verification not enabled at instance level
if (!TRUE.equals(emailVerificationEnabled)) {
return Mono.error(
new AppsmithException(AppsmithError.ORGANIZATION_EMAIL_VERIFICATION_NOT_ENABLED));
return Mono.error(new AppsmithException(AppsmithError.EMAIL_VERIFICATION_NOT_ENABLED));
}
return emailVerificationTokenRepository
.findByEmail(user.getEmail())

2
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce_compatible/UserServiceCECompatibleImpl.java
View File

@ -1,9 +1,9 @@
package com.appsmith.server.services.ce_compatible;
import com.appsmith.server.configurations.CommonConfig;
import com.appsmith.server.helpers.InstanceVariablesHelper;
import com.appsmith.server.helpers.UserServiceHelper;
import com.appsmith.server.helpers.UserUtils;
import com.appsmith.server.instanceconfigs.helpers.InstanceVariablesHelper;
import com.appsmith.server.ratelimiting.RateLimitService;
import com.appsmith.server.repositories.EmailVerificationTokenRepository;
import com.appsmith.server.repositories.PasswordResetTokenRepository;

5
app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/EnvManagerCEImpl.java
View File

@ -83,7 +83,6 @@ import static com.appsmith.server.constants.EnvVariables.APPSMITH_RECAPTCHA_SECR
import static com.appsmith.server.constants.EnvVariables.APPSMITH_RECAPTCHA_SITE_KEY;
import static com.appsmith.server.constants.EnvVariables.APPSMITH_REPLY_TO;
import static com.appsmith.server.constants.EnvVariables.APPSMITH_SIGNUP_ALLOWED_DOMAINS;
import static com.appsmith.server.constants.EnvVariables.APPSMITH_SIGNUP_DISABLED;
import static java.lang.Boolean.TRUE;
@Slf4j
@ -371,10 +370,6 @@ public class EnvManagerCEImpl implements EnvManagerCE {
// Try and update any at runtime, that can be.
final Map<String, String> changesCopy = new HashMap<>(changes);
if (changesCopy.containsKey(APPSMITH_SIGNUP_DISABLED.name())) {
commonConfig.setSignupDisabled(changesCopy.remove(APPSMITH_SIGNUP_DISABLED.name()));
}
if (changesCopy.containsKey(APPSMITH_SIGNUP_ALLOWED_DOMAINS.name())) {
commonConfig.setAllowedDomainsString(
changesCopy.remove(APPSMITH_SIGNUP_ALLOWED_DOMAINS.name()));

1
app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/ScheduledTaskCEImpl.java
View File

@ -39,7 +39,6 @@ public class ScheduledTaskCEImpl implements ScheduledTaskCE {
log.error("Error while fetching organization feature flags", error);
return Flux.empty();
})
.then(organizationService.restartOrganization())
.subscribeOn(LoadShifter.elasticScheduler)
.subscribe();
}

4
app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/ce/InstanceVariablesTest.java → app/server/appsmith-server/src/test/java/com/appsmith/server/instanceconfigs/helpers/ce/InstanceVariablesTest.java
View File

@ -1,7 +1,7 @@
package com.appsmith.server.helpers.ce;
package com.appsmith.server.instanceconfigs.helpers.ce;
import com.appsmith.server.constants.Appsmith;
import com.appsmith.server.helpers.InstanceVariablesHelper;
import com.appsmith.server.instanceconfigs.helpers.InstanceVariablesHelper;
import com.appsmith.server.services.ConfigService;
import net.minidev.json.JSONObject;
import org.junit.jupiter.api.BeforeEach;

2
app/server/appsmith-server/src/test/java/com/appsmith/server/services/UserServiceTest.java
View File

@ -693,7 +693,7 @@ public class UserServiceTest {
Mono<Boolean> resultMono = userMono.then(organizationMono).then(emailVerificationMono);
StepVerifier.create(resultMono)
.expectErrorMessage(AppsmithError.ORGANIZATION_EMAIL_VERIFICATION_NOT_ENABLED.getMessage())
.expectErrorMessage(AppsmithError.EMAIL_VERIFICATION_NOT_ENABLED.getMessage())
.verify();
}

21
app/server/appsmith-server/src/test/java/com/appsmith/server/services/UserServiceWithDisabledSignupTest.java
View File

@ -4,6 +4,8 @@ import com.appsmith.server.applications.base.ApplicationService;
import com.appsmith.server.configurations.CommonConfig;
import com.appsmith.server.configurations.WithMockAppsmithUser;
import com.appsmith.server.domains.LoginSource;
import com.appsmith.server.domains.Organization;
import com.appsmith.server.domains.OrganizationConfiguration;
import com.appsmith.server.domains.User;
import com.appsmith.server.exceptions.AppsmithError;
import com.appsmith.server.exceptions.AppsmithException;
@ -12,6 +14,7 @@ import com.appsmith.server.repositories.PermissionGroupRepository;
import com.appsmith.server.repositories.UserRepository;
import com.appsmith.server.repositories.WorkspaceRepository;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
@ -54,16 +57,32 @@ public class UserServiceWithDisabledSignupTest {
@SpyBean
CommonConfig commonConfig;
@Autowired
OrganizationService organizationService;
Mono<User> userMono;
@BeforeEach
public void setup() {
userMono = userService.findByEmail("usertest@usertest.com");
Mockito.when(commonConfig.isSignupDisabled()).thenReturn(Boolean.TRUE);
Organization organization =
organizationService.getCurrentUserOrganization().block();
assert organization != null;
organization.getOrganizationConfiguration().setIsSignupDisabled(true);
organizationService.save(organization).block();
Mockito.when(commonConfig.getAdminEmails())
.thenReturn(Set.of("dummy_admin@appsmith.com", "dummy2@appsmith.com"));
}
@AfterAll
public static void cleanup(@Autowired OrganizationService organizationService) {
OrganizationConfiguration organizationConfiguration = new OrganizationConfiguration();
organizationConfiguration.setIsSignupDisabled(false);
Organization organization =
organizationService.getCurrentUserOrganization().block();
organizationService.save(organization).block();
}
@Test
@WithMockAppsmithUser
public void createNewUserValidWhenDisabled() {

3
app/server/envs/dev.env.example
View File

@ -20,9 +20,6 @@ APPSMITH_CLOUD_SERVICES_BASE_URL="https://release-cs.appsmith.com"
#APPSMITH_OAUTH2_GITHUB_CLIENT_ID=""
#APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET=""
#APPSMITH_FORM_LOGIN_DISABLED=
#APPSMITH_SIGNUP_DISABLED=
#APPSMITH_SENTRY_DSN=
#APPSMITH_SENTRY_ENVIRONMENT=

2
app/server/envs/docker.env.example
View File

@ -4,8 +4,6 @@
# APPSMITH_OAUTH2_GOOGLE_CLIENT_SECRET=""
# APPSMITH_OAUTH2_GITHUB_CLIENT_ID=""
# APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET=""
# APPSMITH_FORM_LOGIN_DISABLED=
# APPSMITH_SIGNUP_DISABLED=
# APPSMITH_MAIL_ENABLED=true
# APPSMITH_MAIL_HOST=localhost

3
app/server/envs/test.env.example
View File

@ -22,9 +22,6 @@ APPSMITH_CLOUD_SERVICES_BASE_URL="https://release-cs.appsmith.com"
#APPSMITH_OAUTH2_GITHUB_CLIENT_ID=""
#APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET=""
#APPSMITH_FORM_LOGIN_DISABLED=
#APPSMITH_SIGNUP_DISABLED=
#APPSMITH_SENTRY_DSN=
#APPSMITH_SENTRY_ENVIRONMENT=