Add feature flag for QueryPhaseSearcher #214
There are no files selected for viewing
This file contains 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 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,37 @@ | ||||||
| /* | ||||||
| * Copyright OpenSearch Contributors | ||||||
| * SPDX-License-Identifier: Apache-2.0 | ||||||
| */ | ||||||
|
|
||||||
| package org.opensearch.neuralsearch.util; | ||||||
|
|
||||||
| import org.opensearch.common.util.FeatureFlags; | ||||||
| import org.opensearch.core.common.Strings; | ||||||
| import org.opensearch.transport.TransportSettings; | ||||||
|
|
||||||
| /** | ||||||
| * Abstracts feature flags operations specific to neural-search plugin | ||||||
| */ | ||||||
| public class PluginFeatureFlags { | ||||||
|
|
||||||
| /** | ||||||
| * Used to test feature flags whose values are expected to be booleans. | ||||||
| * This method returns true if the value is "true" (case-insensitive), | ||||||
| * and false otherwise. | ||||||
| * Checks alternative flag names as they may be different for plugins | ||||||
| */ | ||||||
| public static boolean isEnabled(String featureFlagName) { | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| return FeatureFlags.isEnabled(featureFlagName) || FeatureFlags.isEnabled(transportFeatureName(featureFlagName)); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Get the feature name that is used for transport specific features. It's used by core for all features | ||||||
| * defined at plugin level (https://github.com/opensearch-project/OpenSearch/blob/main/server/src/main/java/org/opensearch/plugins/PluginsService.java#L277) | ||||||
| */ | ||||||
| private static String transportFeatureName(final String name) { | ||||||
| if (Strings.isNullOrEmpty(name)) { | ||||||
| return name; | ||||||
| } | ||||||
| return String.join(".", TransportSettings.FEATURE_PREFIX, name); | ||||||
| } | ||||||
| } | ||||||
This file contains 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 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 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 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 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,53 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.neuralsearch.util; | ||
|
|
||
| import static org.hamcrest.Matchers.allOf; | ||
| import static org.hamcrest.Matchers.containsString; | ||
|
|
||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.common.util.FeatureFlags; | ||
| import org.opensearch.test.OpenSearchTestCase; | ||
| import org.opensearch.transport.TransportSettings; | ||
|
|
||
| public class PluginFeatureFlagsTests extends OpenSearchTestCase { | ||
|
|
||
| public void testIsEnabled_whenNamePassed_thenSuccessful() { | ||
| String settingName = "my.cool.setting"; | ||
| Settings settings = Settings.builder().put(settingName, true).build(); | ||
| FeatureFlags.initializeFeatureFlags(settings); | ||
| assertTrue(PluginFeatureFlags.isEnabled(settingName)); | ||
| } | ||
|
|
||
| public void testTransportFeaturePrefix_whenNamePassedWithPrefix_thenSuccessful() { | ||
| String settingNameWithoutPrefix = "my.cool.setting"; | ||
| String settingNameWithPrefix = new StringBuilder().append(TransportSettings.FEATURE_PREFIX) | ||
| .append('.') | ||
| .append(settingNameWithoutPrefix) | ||
| .toString(); | ||
| Settings settings = Settings.builder().put(settingNameWithPrefix, true).build(); | ||
| FeatureFlags.initializeFeatureFlags(settings); | ||
| assertTrue(PluginFeatureFlags.isEnabled(settingNameWithoutPrefix)); | ||
| } | ||
|
|
||
| public void testIsEnabled_whenNonExistentFeature_thenFail() { | ||
| String settingName = "my.very_cool.setting"; | ||
| Settings settings = Settings.builder().put(settingName, true).build(); | ||
| FeatureFlags.initializeFeatureFlags(settings); | ||
| assertFalse(PluginFeatureFlags.isEnabled("some_random_feature")); | ||
| } | ||
|
|
||
| public void testIsEnabled_whenFeatureIsNotBoolean_thenFail() { | ||
| String settingName = "my.cool.setting"; | ||
| Settings settings = Settings.builder().put(settingName, 1234).build(); | ||
| FeatureFlags.initializeFeatureFlags(settings); | ||
| IllegalArgumentException exception = expectThrows(IllegalArgumentException.class, () -> PluginFeatureFlags.isEnabled(settingName)); | ||
| assertThat( | ||
| exception.getMessage(), | ||
| allOf(containsString("Failed to parse value"), containsString("only [true] or [false] are allowed")) | ||
| ); | ||
| } | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we need to try "transport" feature prefix, as this is the way core adding features that are set in plugins.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then why both? Shouldn't we only check with "transport" feature prefix?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted to encapsulate that logic so client can do only one call. Otherwise on a client we need to do two calls:
featureFlags.isEnabled(flag) || customFeatureFlags.isEnabled(flag). Depending on scenario one feature flag can be set in one form or another (with or without prefix)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still think it is client's responsibility to pass correct key. In this case
transport.features.neural_search_hybrid_search_enabled.There is no such case that
neural_search_hybrid_search_enabledcan be enabled by settingneural_search_hybrid_search_enabledas true but only by settingtransport.features.neural_search_hybrid_search_enabledas true I believe?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see your point, it can be that flag is set in two places and as we read it with OR and one that set in plugin is always TRUE then we cannot set it to FALSE ever. I'll rework to only use one name or another, in fact it should be always with the prefix except the definition.