Skip to content
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

Jump to bottom

Do not serialize optimize-queries option in MapConfig #16524

Merged
merged 5 commits into from Jan 24, 2020
Merged

Do not serialize optimize-queries option in MapConfig #16524

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5d9fd82
Do not serialize optimize-queries option in MapConfig
cangencer Jan 22, 2020
2076302
Fix for wrong conflicting state detection when both optimize queries …
cangencer Jan 22, 2020
9778cb7
add missing cases, cleanup code
cangencer Jan 22, 2020
9053b94
add better support for INDEX_ONLY
cangencer Jan 23, 2020
2bfc94d
Address review comments
cangencer Jan 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 31 additions & 29 deletions hazelcast/src/main/java/com/hazelcast/config/MapConfig.java
View file
Open in desktop
Expand Up @@ -819,16 +819,21 @@ public MapConfig setOptimizeQueries(boolean optimizeQueries) {
}

private void validateSetOptimizeQueriesOption(boolean optimizeQueries) {
if (setCacheDeserializedValuesExplicitlyInvoked) {
if (optimizeQueries && cacheDeserializedValues == CacheDeserializedValues.NEVER) {
throw new ConfigurationException("Deprecated option 'optimize-queries' is set to true, "
+ "but 'cacheDeserializedValues' is set to NEVER. "
+ "These are conflicting options. Please remove the `optimize-queries'");
} else if (!optimizeQueries && cacheDeserializedValues == CacheDeserializedValues.ALWAYS) {
throw new ConfigurationException("Deprecated option 'optimize-queries' is set to false, "
+ "but 'cacheDeserializedValues' is set to ALWAYS. "
+ "These are conflicting options. Please remove the `optimize-queries'");
}
if (!setCacheDeserializedValuesExplicitlyInvoked) {
return;
}
if (cacheDeserializedValues == CacheDeserializedValues.INDEX_ONLY) {
cangencer marked this conversation as resolved.
Show resolved Hide resolved
throw new ConfigurationException("Deprecated option 'optimize-queries' is being set"
+ ", but 'cacheDeserializedValues' was set to INDEX_ONLY. "
+ "These are conflicting options. Please remove the `optimize-queries'");
} else if (cacheDeserializedValues == CacheDeserializedValues.NEVER && optimizeQueries) {
throw new ConfigurationException("Deprecated option 'optimize-queries' is being set to true, "
+ "but 'cacheDeserializedValues' is set to NEVER. "
+ "These are conflicting options. Please remove the `optimize-queries'");
} else if (cacheDeserializedValues == CacheDeserializedValues.ALWAYS && !optimizeQueries) {
throw new ConfigurationException("Deprecated option 'optimize-queries' is being set to false, "
+ "but 'cacheDeserializedValues' is set to ALWAYS. "
+ "These are conflicting options. Please remove the `optimize-queries'");
}
}

Expand All @@ -848,25 +853,22 @@ public MapConfig setCacheDeserializedValues(CacheDeserializedValues cacheDeseria
}

private void validateCacheDeserializedValuesOption(CacheDeserializedValues validatedCacheDeserializedValues) {
if (optimizeQueryExplicitlyInvoked) {
// deprecated {@link #setOptimizeQueries(boolean)} was explicitly invoked
// we need to be strict with validation to detect conflicts
boolean optimizeQueryFlag = (cacheDeserializedValues == CacheDeserializedValues.ALWAYS);
if (!optimizeQueryFlag && validatedCacheDeserializedValues == CacheDeserializedValues.NEVER) {
// settings are compatible
return;
}
if (optimizeQueryFlag && validatedCacheDeserializedValues == CacheDeserializedValues.NEVER) {
throw new ConfigurationException("Deprecated option 'optimize-queries' is set to `true`, "
+ "but 'cacheDeserializedValues' is set to NEVER. These are conflicting options. "
+ "Please remove the `optimize-queries'");
}
if (cacheDeserializedValues != validatedCacheDeserializedValues) {
throw new ConfigurationException("Deprecated option 'optimize-queries' is set to "
+ optimizeQueryFlag + " but 'cacheDeserializedValues' is set to "
+ validatedCacheDeserializedValues + ". These are conflicting options. "
+ "Please remove the `optimize-queries'");
}
if (!optimizeQueryExplicitlyInvoked) {
return;
}

// deprecated {@link #setOptimizeQueries(boolean)} was explicitly invoked
// we need to be strict with validation to detect conflicts
boolean optimizeQueryFlag = (cacheDeserializedValues == CacheDeserializedValues.ALWAYS);

if (optimizeQueryFlag && validatedCacheDeserializedValues != CacheDeserializedValues.ALWAYS) {
throw new ConfigurationException("Deprecated option 'optimize-queries' is set to `true`, "
+ "but 'cacheDeserializedValues' is being set to NEVER or INDEX_ONLY."
+ " These are conflicting options. Please remove the `optimize-queries'");
} else if (!optimizeQueryFlag && validatedCacheDeserializedValues != CacheDeserializedValues.NEVER) {
throw new ConfigurationException("Deprecated option 'optimize-queries' is set to `false`, "
+ "but 'cacheDeserializedValues' is begin set to ALWAYS or INDEX_ONLY. These are conflicting options."
+ " Please remove the `optimize-queries'");
}
}

Expand Down
52 changes: 46 additions & 6 deletions hazelcast/src/test/java/com/hazelcast/config/MapConfigTest.java
View file
Open in desktop
Expand Up @@ -312,6 +312,26 @@ public void givenCacheDeserializedValuesSetToALWAYS_whenSetOptimizeQueriesToFals
mapConfig.setOptimizeQueries(false);
}

@Test(expected = ConfigurationException.class)
public void givenCacheDeserializedValuesSetToINDEX_ONLY_whenSetOptimizeQueriesToFalse_thenThrowConfigurationException() {
// given
MapConfig mapConfig = new MapConfig();
mapConfig.setCacheDeserializedValues(CacheDeserializedValues.INDEX_ONLY);

// when
mapConfig.setOptimizeQueries(false);
}

@Test(expected = ConfigurationException.class)
public void givenCacheDeserializedValuesSetToINDEX_ONLY_whenSetOptimizeQueriesToTrue_thenThrowConfigurationException() {
// given
MapConfig mapConfig = new MapConfig();
mapConfig.setCacheDeserializedValues(CacheDeserializedValues.INDEX_ONLY);

// when
mapConfig.setOptimizeQueries(true);
}

@Test(expected = ConfigurationException.class)
public void givenCacheDeserializedValuesSetToNEVER_whenSetOptimizeQueriesToTrue_thenThrowConfigurationException() {
// given
Expand Down Expand Up @@ -371,16 +391,26 @@ public void givenCacheDeserializedValuesIsDefault_whenSetCacheDeserializedValues
assertFalse(optimizeQueries);
}

@Test(expected = ConfigurationException.class)
public void givenSetOptimizeQueryIsTrue_whenSetCacheDeserializedValuesToNEVER_thenThrowConfigurationException() {
@Test
public void givenSetOptimizeQueryIsFalse_whenSetCacheDeserializedValuesToNEVER_thenNoException() {
// given
MapConfig mapConfig = new MapConfig();
mapConfig.setOptimizeQueries(true);
mapConfig.setOptimizeQueries(false);

// when
mapConfig.setCacheDeserializedValues(CacheDeserializedValues.NEVER);
}

@Test(expected = ConfigurationException.class)
public void givenSetOptimizeQueryIsFalse_whenSetCacheDeserializedValuesToINDEX_ONLY_thenThrowConfigurationException() {
// given
MapConfig mapConfig = new MapConfig();
mapConfig.setOptimizeQueries(false);

// when
mapConfig.setCacheDeserializedValues(CacheDeserializedValues.INDEX_ONLY);
}

@Test(expected = ConfigurationException.class)
public void givenSetOptimizeQueryIsFalse_whenSetCacheDeserializedValuesToALWAYS_thenThrowConfigurationException() {
// given
Expand All @@ -391,6 +421,16 @@ public void givenSetOptimizeQueryIsFalse_whenSetCacheDeserializedValuesToALWAYS_
mapConfig.setCacheDeserializedValues(CacheDeserializedValues.ALWAYS);
}

@Test(expected = ConfigurationException.class)
public void givenSetOptimizeQueryIsTrue_whenSetCacheDeserializedValuesToNEVER_thenThrowConfigurationException() {
// given
MapConfig mapConfig = new MapConfig();
mapConfig.setOptimizeQueries(true);

// when
mapConfig.setCacheDeserializedValues(CacheDeserializedValues.NEVER);
}

@Test(expected = ConfigurationException.class)
public void givenSetOptimizeQueryIsTrue_whenSetCacheDeserializedValuesToINDEX_ONLY_thenThrowConfigurationException() {
// given
Expand All @@ -402,13 +442,13 @@ public void givenSetOptimizeQueryIsTrue_whenSetCacheDeserializedValuesToINDEX_ON
}

@Test
public void givenSetOptimizeQueryIsFalse_whenSetCacheDeserializedValuesToNEVER_thenNoException() {
public void givenSetOptimizeQueryIsTrue_whenSetCacheDeserializedValuesToALWAYS_thenNoException() {
// given
MapConfig mapConfig = new MapConfig();
mapConfig.setOptimizeQueries(false);
mapConfig.setOptimizeQueries(true);

// when
mapConfig.setCacheDeserializedValues(CacheDeserializedValues.NEVER);
mapConfig.setCacheDeserializedValues(CacheDeserializedValues.ALWAYS);
}

@Test
Expand Down