Skip to content

chore: Update env variable used for update persistent DB URL #35526

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
abhvsn merged 2 commits into from
Aug 8, 2024
Merged

chore: Update env variable used for update persistent DB URL #35526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32be3e7
chore: Update env variable used for update persistent DB URL
abhvsn Aug 8, 2024
dbef20c
chore: Update the UI to make it more generic to accomoddate both Post…
abhvsn Aug 8, 2024
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
4 changes: 2 additions & 2 deletions app/client/src/pages/AdminSettings/config/advanced.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ export const config: AdminConfigType = {
category: SettingCategories.ADVANCED,
controlType: SettingTypes.TEXTINPUT,
controlSubType: SettingSubtype.TEXT,
label: "MongoDB URI",
label: "Appsmith DB URL",
subText:
"* Appsmith internally uses MongoDB. Change to an external MongoDB for clustering",
"* Persistence database URL for Appsmith instance. Change this to an external database for clustering",
},
{
id: "APPSMITH_REDIS_URL",
Expand Down
2 changes: 1 addition & 1 deletion app/server/appsmith-server/src/main/java/com/appsmith/server/constants/EnvVariables.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

public enum EnvVariables {
APPSMITH_INSTANCE_NAME,
APPSMITH_MONGODB_URI,
APPSMITH_DB_URL,
APPSMITH_REDIS_URL,
APPSMITH_MAIL_ENABLED,
APPSMITH_MAIL_FROM,
Expand Down
63 changes: 29 additions & 34 deletions app/server/appsmith-server/src/test/java/com/appsmith/server/solutions/EnvManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,80 +116,76 @@ public void setup() {
@Test
public void simpleSample() {
final String content =
"APPSMITH_MONGODB_URI='first value'\nAPPSMITH_REDIS_URL='second value'\n\nAPPSMITH_INSTANCE_NAME='third value'";
"APPSMITH_DB_URL='first value'\nAPPSMITH_REDIS_URL='second value'\n\nAPPSMITH_INSTANCE_NAME='third value'";

assertThat(envManager.transformEnvContent(content, Map.of("APPSMITH_MONGODB_URI", "new first value")))
assertThat(envManager.transformEnvContent(content, Map.of("APPSMITH_DB_URL", "new first value")))
.containsExactly(
"APPSMITH_MONGODB_URI='new first value'",
"APPSMITH_DB_URL='new first value'",
"APPSMITH_REDIS_URL='second value'",
"",
"APPSMITH_INSTANCE_NAME='third value'");

assertThat(envManager.transformEnvContent(content, Map.of("APPSMITH_REDIS_URL", "new second value")))
.containsExactly(
"APPSMITH_MONGODB_URI='first value'",
"APPSMITH_DB_URL='first value'",
"APPSMITH_REDIS_URL='new second value'",
"",
"APPSMITH_INSTANCE_NAME='third value'");

assertThat(envManager.transformEnvContent(content, Map.of("APPSMITH_INSTANCE_NAME", "new third value")))
.containsExactly(
"APPSMITH_MONGODB_URI='first value'",
"APPSMITH_DB_URL='first value'",
"APPSMITH_REDIS_URL='second value'",
"",
"APPSMITH_INSTANCE_NAME='new third value'");

assertThat(envManager.transformEnvContent(
content,
Map.of(
"APPSMITH_MONGODB_URI", "new first value",
"APPSMITH_DB_URL", "new first value",
"APPSMITH_INSTANCE_NAME", "new third value")))
.containsExactly(
"APPSMITH_MONGODB_URI='new first value'",
"APPSMITH_DB_URL='new first value'",
"APPSMITH_REDIS_URL='second value'",
"",
"APPSMITH_INSTANCE_NAME='new third value'");
}

@Test
public void emptyValues() {
final String content =
"APPSMITH_MONGODB_URI=first value\nAPPSMITH_REDIS_URL=\n\nAPPSMITH_INSTANCE_NAME=third value";
final String content = "APPSMITH_DB_URL=first value\nAPPSMITH_REDIS_URL=\n\nAPPSMITH_INSTANCE_NAME=third value";

assertThat(envManager.transformEnvContent(content, Map.of("APPSMITH_REDIS_URL", "new second value")))
.containsExactly(
"APPSMITH_MONGODB_URI=first value",
"APPSMITH_DB_URL=first value",
"APPSMITH_REDIS_URL='new second value'",
"",
"APPSMITH_INSTANCE_NAME=third value");

assertThat(envManager.transformEnvContent(content, Map.of("APPSMITH_REDIS_URL", "")))
.containsExactly(
"APPSMITH_MONGODB_URI=first value",
"APPSMITH_REDIS_URL=",
"",
"APPSMITH_INSTANCE_NAME=third value");
"APPSMITH_DB_URL=first value", "APPSMITH_REDIS_URL=", "", "APPSMITH_INSTANCE_NAME=third value");
}

@Test
public void quotedValues() {
final String content =
"APPSMITH_MONGODB_URI='first value'\nAPPSMITH_REDIS_URL=\"quoted value\"\n\nAPPSMITH_INSTANCE_NAME='third value'";
"APPSMITH_DB_URL='first value'\nAPPSMITH_REDIS_URL=\"quoted value\"\n\nAPPSMITH_INSTANCE_NAME='third value'";

assertThat(envManager.transformEnvContent(
content,
Map.of(
"APPSMITH_MONGODB_URI", "new first value",
"APPSMITH_DB_URL", "new first value",
"APPSMITH_REDIS_URL", "new second value")))
.containsExactly(
"APPSMITH_MONGODB_URI='new first value'",
"APPSMITH_DB_URL='new first value'",
"APPSMITH_REDIS_URL='new second value'",
"",
"APPSMITH_INSTANCE_NAME='third value'");

assertThat(envManager.transformEnvContent(content, Map.of("APPSMITH_REDIS_URL", "")))
.containsExactly(
"APPSMITH_MONGODB_URI='first value'",
"APPSMITH_DB_URL='first value'",
"APPSMITH_REDIS_URL=",
"",
"APPSMITH_INSTANCE_NAME='third value'");
Expand All @@ -200,7 +196,7 @@ public void quotedValues() {
"APPSMITH_INSTANCE_NAME", "Sponge-bob's Instance",
"APPSMITH_REDIS_URL", "value with \" char in it")))
.containsExactly(
"APPSMITH_MONGODB_URI='first value'",
"APPSMITH_DB_URL='first value'",
"APPSMITH_REDIS_URL='value with \" char in it'",
"",
"APPSMITH_INSTANCE_NAME='Sponge-bob'\"'\"'s Instance'");
Expand All @@ -209,11 +205,10 @@ public void quotedValues() {
@Test
public void parseEmptyValues() {

assertThat(
envManager.parseToMap(
"APPSMITH_MONGODB_URI='first value'\nAPPSMITH_REDIS_URL=\n\nAPPSMITH_INSTANCE_NAME='third value'"))
assertThat(envManager.parseToMap(
"APPSMITH_DB_URL='first value'\nAPPSMITH_REDIS_URL=\n\nAPPSMITH_INSTANCE_NAME='third value'"))
.containsExactlyInAnyOrderEntriesOf(Map.of(
"APPSMITH_MONGODB_URI", "first value",
"APPSMITH_DB_URL", "first value",
"APPSMITH_REDIS_URL", "",
"APPSMITH_INSTANCE_NAME", "third value"));
}
Expand All @@ -223,9 +218,9 @@ public void parseQuotedValues() {

assertThat(
envManager.parseToMap(
"APPSMITH_MONGODB_URI=first\nAPPSMITH_REDIS_URL=\"quoted value\"\n\nAPPSMITH_INSTANCE_NAME='third value'"))
"APPSMITH_DB_URL=first\nAPPSMITH_REDIS_URL=\"quoted value\"\n\nAPPSMITH_INSTANCE_NAME='third value'"))
.containsExactlyInAnyOrderEntriesOf(Map.of(
"APPSMITH_MONGODB_URI", "first",
"APPSMITH_DB_URL", "first",
"APPSMITH_REDIS_URL", "quoted value",
"APPSMITH_INSTANCE_NAME", "third value"));

Expand All @@ -245,12 +240,12 @@ public void parseTestWithEscapes() {
@Test
public void disallowedVariable() {
final String content =
"APPSMITH_MONGODB_URI=first value\nDISALLOWED_NASTY_STUFF=\"quoted value\"\n\nAPPSMITH_INSTANCE_NAME=third value";
"APPSMITH_DB_URL=first value\nDISALLOWED_NASTY_STUFF=\"quoted value\"\n\nAPPSMITH_INSTANCE_NAME=third value";

assertThatThrownBy(() -> envManager.transformEnvContent(
content,
Map.of(
"APPSMITH_MONGODB_URI", "new first value",
"APPSMITH_DB_URL", "new first value",
"DISALLOWED_NASTY_STUFF", "new second value")))
.matches(value -> value instanceof AppsmithException
&& AppsmithError.GENERIC_BAD_REQUEST.equals(((AppsmithException) value).getError()));
Expand All @@ -259,15 +254,15 @@ public void disallowedVariable() {
@Test
public void addNewVariable() {
final String content =
"APPSMITH_MONGODB_URI='first value'\nAPPSMITH_REDIS_URL='quoted value'\n\nAPPSMITH_INSTANCE_NAME='third value'";
"APPSMITH_DB_URL='first value'\nAPPSMITH_REDIS_URL='quoted value'\n\nAPPSMITH_INSTANCE_NAME='third value'";

assertThat(envManager.transformEnvContent(
content,
Map.of(
"APPSMITH_MONGODB_URI", "new first value",
"APPSMITH_DB_URL", "new first value",
"APPSMITH_DISABLE_TELEMETRY", "false")))
.containsExactly(
"APPSMITH_MONGODB_URI='new first value'",
"APPSMITH_DB_URL='new first value'",
"APPSMITH_REDIS_URL='quoted value'",
"",
"APPSMITH_INSTANCE_NAME='third value'",
Expand All @@ -277,15 +272,15 @@ public void addNewVariable() {
@Test
public void setValueWithQuotes() {
final String content =
"APPSMITH_MONGODB_URI='first value'\nAPPSMITH_REDIS_URL='quoted value'\n\nAPPSMITH_INSTANCE_NAME='third value'";
"APPSMITH_DB_URL='first value'\nAPPSMITH_REDIS_URL='quoted value'\n\nAPPSMITH_INSTANCE_NAME='third value'";

assertThat(envManager.transformEnvContent(
content,
Map.of(
"APPSMITH_MONGODB_URI", "'just quotes'",
"APPSMITH_DB_URL", "'just quotes'",
"APPSMITH_DISABLE_TELEMETRY", "some quotes 'inside' it")))
.containsExactly(
"APPSMITH_MONGODB_URI=\"'\"'just quotes'\"'\"",
"APPSMITH_DB_URL=\"'\"'just quotes'\"'\"",
"APPSMITH_REDIS_URL='quoted value'",
"",
"APPSMITH_INSTANCE_NAME='third value'",
Expand All @@ -310,7 +305,7 @@ public void setEnv_AndGetAll() {
EnvManager envManagerInner = Mockito.mock(EnvManagerImpl.class);

Map<String, String> envs = new HashMap<>();
envs.put("APPSMITH_MONGODB_URI", "mongo-url");
envs.put("APPSMITH_DB_URL", "mongo-url");
envs.put("APPSMITH_DISABLE_TELEMETRY", "");

Mockito.when(envManagerInner.getAll()).thenReturn(Mono.just(envs));
Expand Down