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

Feature/conversation memory feature flag #1271

Merged
merged 9 commits into from
Sep 1, 2023
Merged

Feature/conversation memory feature flag #1271

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3afda22
add feature flag and checks to transport actions
HenryL27 Aug 30, 2023
e32d939
add feature flag tests
HenryL27 Aug 30, 2023
540b0b4
fix typos for real with find-and-replace
HenryL27 Aug 30, 2023
3e4a0f4
rename conversational-memory directory to memory
HenryL27 Aug 30, 2023
d0b3670
fix settings.gradle with new dir name
HenryL27 Aug 30, 2023
6927c45
re-add feature flag checks and tests to transport layer
HenryL27 Aug 31, 2023
85a2901
fix feature flag with updateConsumer
HenryL27 Sep 1, 2023
51b1cbd
remove redundant settings update
HenryL27 Sep 1, 2023
1e72742
clean up feature var initialization to avoid unchecked conversion war…
HenryL27 Sep 1, 2023
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
5 changes: 5 additions & 0 deletions common/src/main/java/org/opensearch/ml/common/conversation/ConversationalIndexConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
*/
package org.opensearch.ml.common.conversation;

import org.opensearch.common.settings.Setting;

/**
* Class containing a bunch of constant defining how the conversational indices are formatted
*/
Expand Down Expand Up @@ -97,4 +99,7 @@ public class ConversationalIndexConstants {
+ " }\n"
+ "}";

/** Feature Flag setting for conversational memory */
public static final Setting<Boolean> ML_COMMONS_MEMORY_FEATURE_ENABLED = Setting
.boolSetting("plugins.ml_commons.memory_feature_enabled", false, Setting.Property.NodeScope, Setting.Property.Dynamic);
}
0 conversational-memory/build.gradle → memory/build.gradle
View file
Open in desktop
File renamed without changes.
0 ...l/memory/ConversationalMemoryHandler.java → ...l/memory/ConversationalMemoryHandler.java
View file
Open in desktop
File renamed without changes.
0 ...onversation/CreateConversationAction.java → ...onversation/CreateConversationAction.java
View file
Open in desktop
File renamed without changes.
0 ...nversation/CreateConversationRequest.java → ...nversation/CreateConversationRequest.java
View file
Open in desktop
File renamed without changes.
0 ...versation/CreateConversationResponse.java → ...versation/CreateConversationResponse.java
View file
Open in desktop
File renamed without changes.
26 changes: 25 additions & 1 deletion ...on/CreateConversationTransportAction.java → ...on/CreateConversationTransportAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,16 @@
*/
package org.opensearch.ml.memory.action.conversation;

import org.opensearch.OpenSearchException;
import org.opensearch.action.support.ActionFilters;
import org.opensearch.action.support.HandledTransportAction;
import org.opensearch.client.Client;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.inject.Inject;
import org.opensearch.common.settings.Setting;
import org.opensearch.common.util.concurrent.ThreadContext;
import org.opensearch.core.action.ActionListener;
import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
import org.opensearch.ml.memory.ConversationalMemoryHandler;
import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
import org.opensearch.tasks.Task;
Expand All @@ -39,27 +43,47 @@ public class CreateConversationTransportAction extends HandledTransportAction<Cr
private ConversationalMemoryHandler cmHandler;
private Client client;

private volatile boolean featureIsEnabled;

/**
* Constructor
* @param transportService for inter-node communications
* @param actionFilters for filtering actions
* @param cmHandler Handler for conversational memory operations
* @param client OS Client for dealing with OS
* @param clusterService for some cluster ops
*/
@Inject
public CreateConversationTransportAction(
TransportService transportService,
ActionFilters actionFilters,
OpenSearchConversationalMemoryHandler cmHandler,
Client client
Client client,
ClusterService clusterService
) {
super(CreateConversationAction.NAME, transportService, actionFilters, CreateConversationRequest::new);
this.cmHandler = cmHandler;
this.client = client;
@SuppressWarnings("unchecked")
Setting<Boolean> setting = (Setting<Boolean>) clusterService
.getClusterSettings()
.get(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey());
this.featureIsEnabled = setting.get(clusterService.getSettings());
clusterService.getClusterSettings().addSettingsUpdateConsumer(setting, it -> featureIsEnabled = it);
}

@Override
protected void doExecute(Task task, CreateConversationRequest request, ActionListener<CreateConversationResponse> actionListener) {
if (!featureIsEnabled) {
actionListener
.onFailure(
new OpenSearchException(
"The experimental Conversation Memory feature is not enabled. To enable, please update the setting "
+ ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey()
)
);
return;
}
String name = request.getName();
try (ThreadContext.StoredContext context = client.threadPool().getThreadContext().newStoredContext(true)) {
ActionListener<CreateConversationResponse> internalListener = ActionListener.runBefore(actionListener, () -> context.restore());
Expand Down
0 ...conversation/CreateInteractionAction.java → ...conversation/CreateInteractionAction.java
View file
Open in desktop
File renamed without changes.
0 ...onversation/CreateInteractionRequest.java → ...onversation/CreateInteractionRequest.java
View file
Open in desktop
File renamed without changes.
0 ...nversation/CreateInteractionResponse.java → ...nversation/CreateInteractionResponse.java
View file
Open in desktop
File renamed without changes.
26 changes: 25 additions & 1 deletion ...ion/CreateInteractionTransportAction.java → ...ion/CreateInteractionTransportAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,16 @@
*/
package org.opensearch.ml.memory.action.conversation;

import org.opensearch.OpenSearchException;
import org.opensearch.action.support.ActionFilters;
import org.opensearch.action.support.HandledTransportAction;
import org.opensearch.client.Client;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.inject.Inject;
import org.opensearch.common.settings.Setting;
import org.opensearch.common.util.concurrent.ThreadContext;
import org.opensearch.core.action.ActionListener;
import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
import org.opensearch.ml.memory.ConversationalMemoryHandler;
import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
import org.opensearch.tasks.Task;
Expand All @@ -39,27 +43,47 @@ public class CreateInteractionTransportAction extends HandledTransportAction<Cre
private ConversationalMemoryHandler cmHandler;
private Client client;

private volatile boolean featureIsEnabled;

/**
* Constructor
* @param transportService for doing intra-cluster communication
* @param actionFilters for filtering actions
* @param cmHandler handler for conversational memory
* @param client client for general opensearch ops
* @param clusterService for some cluster ops
*/
@Inject
public CreateInteractionTransportAction(
TransportService transportService,
ActionFilters actionFilters,
OpenSearchConversationalMemoryHandler cmHandler,
Client client
Client client,
ClusterService clusterService
) {
super(CreateInteractionAction.NAME, transportService, actionFilters, CreateInteractionRequest::new);
this.client = client;
this.cmHandler = cmHandler;
@SuppressWarnings("unchecked")
Setting<Boolean> setting = (Setting<Boolean>) clusterService
.getClusterSettings()
.get(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey());
this.featureIsEnabled = setting.get(clusterService.getSettings());
clusterService.getClusterSettings().addSettingsUpdateConsumer(setting, it -> featureIsEnabled = it);
}

@Override
protected void doExecute(Task task, CreateInteractionRequest request, ActionListener<CreateInteractionResponse> actionListener) {
if (!featureIsEnabled) {
actionListener
.onFailure(
new OpenSearchException(
"The experimental Conversation Memory feature is not enabled. To enable, please update the setting "
+ ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey()
)
);
return;
}
String cid = request.getConversationId();
String inp = request.getInput();
String rsp = request.getResponse();
Expand Down
0 ...onversation/DeleteConversationAction.java → ...onversation/DeleteConversationAction.java
View file
Open in desktop
File renamed without changes.
0 ...nversation/DeleteConversationRequest.java → ...nversation/DeleteConversationRequest.java
View file
Open in desktop
File renamed without changes.
0 ...versation/DeleteConversationResponse.java → ...versation/DeleteConversationResponse.java
View file
Open in desktop
File renamed without changes.
26 changes: 25 additions & 1 deletion ...on/DeleteConversationTransportAction.java → ...on/DeleteConversationTransportAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,16 @@
*/
package org.opensearch.ml.memory.action.conversation;

import org.opensearch.OpenSearchException;
import org.opensearch.action.support.ActionFilters;
import org.opensearch.action.support.HandledTransportAction;
import org.opensearch.client.Client;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.inject.Inject;
import org.opensearch.common.settings.Setting;
import org.opensearch.common.util.concurrent.ThreadContext;
import org.opensearch.core.action.ActionListener;
import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
import org.opensearch.ml.memory.ConversationalMemoryHandler;
import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
import org.opensearch.tasks.Task;
Expand All @@ -39,27 +43,47 @@ public class DeleteConversationTransportAction extends HandledTransportAction<De
private Client client;
private ConversationalMemoryHandler cmHandler;

private volatile boolean featureIsEnabled;

/**
* Constructor
* @param transportService for inter-node communications
* @param actionFilters for filtering actions
* @param cmHandler Handler for conversational memory operations
* @param client OS Client for dealing with OS
* @param clusterService for some cluster ops
*/
@Inject
public DeleteConversationTransportAction(
TransportService transportService,
ActionFilters actionFilters,
OpenSearchConversationalMemoryHandler cmHandler,
Client client
Client client,
ClusterService clusterService
) {
super(DeleteConversationAction.NAME, transportService, actionFilters, DeleteConversationRequest::new);
this.client = client;
this.cmHandler = cmHandler;
@SuppressWarnings("unchecked")
Setting<Boolean> setting = (Setting<Boolean>) clusterService
.getClusterSettings()
.get(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey());
this.featureIsEnabled = setting.get(clusterService.getSettings());
clusterService.getClusterSettings().addSettingsUpdateConsumer(setting, it -> featureIsEnabled = it);
}

@Override
public void doExecute(Task task, DeleteConversationRequest request, ActionListener<DeleteConversationResponse> listener) {
if (!featureIsEnabled) {
listener
.onFailure(
new OpenSearchException(
"The experimental Conversation Memory feature is not enabled. To enable, please update the setting "
+ ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey()
)
);
return;
}
String conversationId = request.getId();
try (ThreadContext.StoredContext context = client.threadPool().getThreadContext().newStoredContext(true)) {
ActionListener<DeleteConversationResponse> internalListener = ActionListener.runBefore(listener, () -> context.restore());
Expand Down
0 .../conversation/GetConversationsAction.java → .../conversation/GetConversationsAction.java
View file
Open in desktop
File renamed without changes.
0 ...conversation/GetConversationsRequest.java → ...conversation/GetConversationsRequest.java
View file
Open in desktop
File renamed without changes.
0 ...onversation/GetConversationsResponse.java → ...onversation/GetConversationsResponse.java
View file
Open in desktop
File renamed without changes.
26 changes: 25 additions & 1 deletion ...tion/GetConversationsTransportAction.java → ...tion/GetConversationsTransportAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,17 @@

import java.util.List;

import org.opensearch.OpenSearchException;
import org.opensearch.action.support.ActionFilters;
import org.opensearch.action.support.HandledTransportAction;
import org.opensearch.client.Client;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.inject.Inject;
import org.opensearch.common.settings.Setting;
import org.opensearch.common.util.concurrent.ThreadContext;
import org.opensearch.core.action.ActionListener;
import org.opensearch.ml.common.conversation.ConversationMeta;
import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
import org.opensearch.ml.memory.ConversationalMemoryHandler;
import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
import org.opensearch.tasks.Task;
Expand All @@ -42,27 +46,47 @@ public class GetConversationsTransportAction extends HandledTransportAction<GetC
private Client client;
private ConversationalMemoryHandler cmHandler;

private volatile boolean featureIsEnabled;

/**
* Constructor
* @param transportService for inter-node communications
* @param actionFilters for filtering actions
* @param cmHandler Handler for conversational memory operations
* @param client OS Client for dealing with OS
* @param clusterService for some cluster ops
*/
@Inject
public GetConversationsTransportAction(
TransportService transportService,
ActionFilters actionFilters,
OpenSearchConversationalMemoryHandler cmHandler,
Client client
Client client,
ClusterService clusterService
) {
super(GetConversationsAction.NAME, transportService, actionFilters, GetConversationsRequest::new);
this.client = client;
this.cmHandler = cmHandler;
@SuppressWarnings("unchecked")
HenryL27 marked this conversation as resolved.
Show resolved Hide resolved
Setting<Boolean> setting = (Setting<Boolean>) clusterService
.getClusterSettings()
.get(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey());
this.featureIsEnabled = setting.get(clusterService.getSettings());
clusterService.getClusterSettings().addSettingsUpdateConsumer(setting, it -> featureIsEnabled = it);
}

@Override
public void doExecute(Task task, GetConversationsRequest request, ActionListener<GetConversationsResponse> actionListener) {
if (!featureIsEnabled) {
actionListener
.onFailure(
new OpenSearchException(
"The experimental Conversation Memory feature is not enabled. To enable, please update the setting "
+ ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey()
)
);
return;
}
int maxResults = request.getMaxResults();
int from = request.getFrom();
try (ThreadContext.StoredContext context = client.threadPool().getThreadContext().newStoredContext(true)) {
Expand Down
0 ...n/conversation/GetInteractionsAction.java → ...n/conversation/GetInteractionsAction.java
View file
Open in desktop
File renamed without changes.
0 .../conversation/GetInteractionsRequest.java → .../conversation/GetInteractionsRequest.java
View file
Open in desktop
File renamed without changes.
0 ...conversation/GetInteractionsResponse.java → ...conversation/GetInteractionsResponse.java
View file
Open in desktop
File renamed without changes.
26 changes: 25 additions & 1 deletion ...ation/GetInteractionsTransportAction.java → ...ation/GetInteractionsTransportAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,16 @@

import java.util.List;

import org.opensearch.OpenSearchException;
import org.opensearch.action.support.ActionFilters;
import org.opensearch.action.support.HandledTransportAction;
import org.opensearch.client.Client;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.inject.Inject;
import org.opensearch.common.settings.Setting;
import org.opensearch.common.util.concurrent.ThreadContext;
import org.opensearch.core.action.ActionListener;
import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
import org.opensearch.ml.common.conversation.Interaction;
import org.opensearch.ml.memory.ConversationalMemoryHandler;
import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
Expand All @@ -42,27 +46,47 @@ public class GetInteractionsTransportAction extends HandledTransportAction<GetIn
private Client client;
private ConversationalMemoryHandler cmHandler;

private volatile boolean featureIsEnabled;

/**
* Constructor
* @param transportService for inter-node communications
* @param actionFilters for filtering actions
* @param cmHandler Handler for conversational memory operations
* @param client OS Client for dealing with OS
* @param clusterService for some cluster ops
*/
@Inject
public GetInteractionsTransportAction(
TransportService transportService,
ActionFilters actionFilters,
OpenSearchConversationalMemoryHandler cmHandler,
Client client
Client client,
ClusterService clusterService
) {
super(GetInteractionsAction.NAME, transportService, actionFilters, GetInteractionsRequest::new);
this.client = client;
this.cmHandler = cmHandler;
@SuppressWarnings("unchecked")
Setting<Boolean> setting = (Setting<Boolean>) clusterService
.getClusterSettings()
.get(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey());
this.featureIsEnabled = setting.get(clusterService.getSettings());
clusterService.getClusterSettings().addSettingsUpdateConsumer(setting, it -> featureIsEnabled = it);
}

@Override
public void doExecute(Task task, GetInteractionsRequest request, ActionListener<GetInteractionsResponse> actionListener) {
if (!featureIsEnabled) {
actionListener
.onFailure(
new OpenSearchException(
"The experimental Conversation Memory feature is not enabled. To enable, please update the setting "
+ ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey()
)
);
return;
}
int maxResults = request.getMaxResults();
int from = request.getFrom();
try (ThreadContext.StoredContext context = client.threadPool().getThreadContext().newStoredContext(true)) {
Expand Down
0 ...l/memory/index/ConversationMetaIndex.java → ...l/memory/index/ConversationMetaIndex.java
View file
Open in desktop
File renamed without changes.
0 ...ch/ml/memory/index/InteractionsIndex.java → ...ch/ml/memory/index/InteractionsIndex.java
View file
Open in desktop
File renamed without changes.
0 ...penSearchConversationalMemoryHandler.java → ...penSearchConversationalMemoryHandler.java
View file
Open in desktop
File renamed without changes.
0 ...y/ConversationalMemoryHandlerITTests.java → ...y/ConversationalMemoryHandlerITTests.java
View file
Open in desktop
File renamed without changes.
0 ...search/ml/memory/ConversationalTests.java → ...search/ml/memory/ConversationalTests.java
View file
Open in desktop
File renamed without changes.
0 ...conversation/ConversationActionTests.java → ...conversation/ConversationActionTests.java
View file
Open in desktop
File renamed without changes.
0 ...ation/CreateConversationRequestTests.java → ...ation/CreateConversationRequestTests.java
View file
Open in desktop
File renamed without changes.
0 ...tion/CreateConversationResponseTests.java → ...tion/CreateConversationResponseTests.java
View file
Open in desktop
File renamed without changes.
Loading