Skip to content

Commit

Permalink
Encode id if it is used in request path (#174)
Browse files Browse the repository at this point in the history 
* feat: encode id if it is used in request path

Signed-off-by: SuZhou-Joe <[email protected]>

* feat: add to release node

Signed-off-by: SuZhou-Joe <[email protected]>

---------

Signed-off-by: SuZhou-Joe <[email protected]>
(cherry picked from commit 3abf12d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
@github-actions
github-actions[bot] committed Mar 20, 2024
1 parent 84e5c02 commit a167a16
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 7 deletions.
1 change: 1 addition & 0 deletions release-notes/dashboards-assistant.release-notes-2.13.0.0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Compatible with OpenSearch and OpenSearch Dashboards Version 2.13.0
- Integrate chatbot with sidecar service. ([#164](https://github.com/opensearch-project/dashboards-assistant/pull/164))
- Update view trace button from suggestions to message action bar. ([#158](https://github.com/opensearch-project/dashboards-assistant/pull/158))
- Fetch root agent id before executing the agent. ([#165](https://github.com/opensearch-project/dashboards-assistant/pull/165))
- Encode id if it is used in request path. ([#174](https://github.com/opensearch-project/dashboards-assistant/pull/174))

### Infrastructure

Expand Down
121 changes: 121 additions & 0 deletions server/services/storage/agent_framework_storage_service.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,24 @@ describe('AgentFrameworkStorageService', () => {
`);
});

it('should encode id when calls getConversation with non-standard params in request payload', async () => {
mockedTransport.mockResolvedValue({
body: {
messages: [],
},
});

await agentFrameworkService.getConversation('../non-standard/id');
expect(mockedTransport.mock.calls[0]).toMatchInlineSnapshot(`
Array [
Object {
"method": "GET",
"path": "/_plugins/_ml/memory/..%2Fnon-standard%2Fid/messages?max_results=1000",
},
]
`);
});

it('getConversations', async () => {
mockedTransport.mockImplementation(async (params) => {
return {
Expand Down Expand Up @@ -223,6 +241,21 @@ describe('AgentFrameworkStorageService', () => {
expect(agentFrameworkService.deleteConversation('foo')).rejects.toBeDefined();
});

it('should encode id when calls deleteConversation with non-standard params in request payload', async () => {
mockedTransport.mockResolvedValueOnce({
statusCode: 200,
});
await agentFrameworkService.deleteConversation('../non-standard/id');
expect(mockedTransport.mock.calls[0]).toMatchInlineSnapshot(`
Array [
Object {
"method": "DELETE",
"path": "/_plugins/_ml/memory/..%2Fnon-standard%2Fid",
},
]
`);
});

it('updateConversation', async () => {
mockedTransport.mockImplementationOnce(async (params) => ({
statusCode: 200,
Expand Down Expand Up @@ -253,6 +286,24 @@ describe('AgentFrameworkStorageService', () => {
expect(agentFrameworkService.updateConversation('foo', 'title')).rejects.toBeDefined();
});

it('should encode id when calls updateConversation with non-standard params in request payload', async () => {
mockedTransport.mockResolvedValueOnce({
statusCode: 200,
});
await agentFrameworkService.updateConversation('../non-standard/id', 'title');
expect(mockedTransport.mock.calls[0]).toMatchInlineSnapshot(`
Array [
Object {
"body": Object {
"name": "title",
},
"method": "PUT",
"path": "/_plugins/_ml/memory/..%2Fnon-standard%2Fid",
},
]
`);
});

it('getTraces', async () => {
mockedTransport.mockImplementationOnce(async (params) => ({
body: {
Expand Down Expand Up @@ -288,6 +339,32 @@ describe('AgentFrameworkStorageService', () => {
);
});

it('should encode id when calls getTraces with non-standard params in request payload', async () => {
mockedTransport.mockResolvedValueOnce({
body: {
traces: [
{
message_id: 'interaction_id',
create_time: 'create_time',
input: 'input',
response: 'response',
origin: 'origin',
trace_number: 1,
},
],
},
});
await agentFrameworkService.getTraces('../non-standard/id');
expect(mockedTransport.mock.calls[0]).toMatchInlineSnapshot(`
Array [
Object {
"method": "GET",
"path": "/_plugins/_ml/memory/message/..%2Fnon-standard%2Fid/traces",
},
]
`);
});

it('updateInteraction', async () => {
mockedTransport.mockImplementationOnce(async (params) => ({
statusCode: 200,
Expand Down Expand Up @@ -334,6 +411,32 @@ describe('AgentFrameworkStorageService', () => {
).rejects.toMatchInlineSnapshot(`[Error: update interaction failed, reason:"error"]`);
});

it('should encode id when calls updateInteraction with non-standard params in request payload', async () => {
mockedTransport.mockResolvedValueOnce({
statusCode: 200,
});
await agentFrameworkService.updateInteraction('../non-standard/id', {
foo: {
bar: 'foo',
},
});
expect(mockedTransport.mock.calls[0]).toMatchInlineSnapshot(`
Array [
Object {
"body": Object {
"additional_info": Object {
"foo": Object {
"bar": "foo",
},
},
},
"method": "PUT",
"path": "/_plugins/_ml/memory/message/..%2Fnon-standard%2Fid",
},
]
`);
});

it('getInteraction', async () => {
mockedTransport.mockImplementation(async (params) => ({
body: {
Expand All @@ -359,4 +462,22 @@ describe('AgentFrameworkStorageService', () => {
`);
expect(mockedTransport).toBeCalledTimes(1);
});

it('should encode id when calls getInteraction with non-standard params in request payload', async () => {
mockedTransport.mockResolvedValueOnce({
body: {
input: 'input',
response: 'response',
},
});
await agentFrameworkService.getInteraction('_id', '../non-standard/id');
expect(mockedTransport.mock.calls[0]).toMatchInlineSnapshot(`
Array [
Object {
"method": "GET",
"path": "/_plugins/_ml/memory/message/..%2Fnon-standard%2Fid",
},
]
`);
});
});
16 changes: 9 additions & 7 deletions server/services/storage/agent_framework_storage_service.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,17 @@ export class AgentFrameworkStorageService implements StorageService {
const [interactionsResp, conversation] = await Promise.all([
this.client.transport.request({
method: 'GET',
path: `${ML_COMMONS_BASE_API}/memory/${conversationId}/messages?max_results=1000`,
path: `${ML_COMMONS_BASE_API}/memory/${encodeURIComponent(
conversationId
)}/messages?max_results=1000`,
}) as TransportRequestPromise<
ApiResponse<{
messages: InteractionFromAgentFramework[];
}>
>,
this.client.transport.request({
method: 'GET',
path: `${ML_COMMONS_BASE_API}/memory/${conversationId}`,
path: `${ML_COMMONS_BASE_API}/memory/${encodeURIComponent(conversationId)}`,
}) as TransportRequestPromise<
ApiResponse<{
conversation_id: string;
Expand Down Expand Up @@ -147,7 +149,7 @@ export class AgentFrameworkStorageService implements StorageService {
try {
const response = await this.client.transport.request({
method: 'DELETE',
path: `${ML_COMMONS_BASE_API}/memory/${conversationId}`,
path: `${ML_COMMONS_BASE_API}/memory/${encodeURIComponent(conversationId)}`,
});
if (response.statusCode === 200) {
return {
Expand All @@ -172,7 +174,7 @@ export class AgentFrameworkStorageService implements StorageService {
try {
const response = await this.client.transport.request({
method: 'PUT',
path: `${ML_COMMONS_BASE_API}/memory/${conversationId}`,
path: `${ML_COMMONS_BASE_API}/memory/${encodeURIComponent(conversationId)}`,
body: {
name: title,
},
Expand All @@ -197,7 +199,7 @@ export class AgentFrameworkStorageService implements StorageService {
try {
const response = (await this.client.transport.request({
method: 'GET',
path: `${ML_COMMONS_BASE_API}/memory/message/${interactionId}/traces`,
path: `${ML_COMMONS_BASE_API}/memory/message/${encodeURIComponent(interactionId)}/traces`,
})) as ApiResponse<{
traces: Array<{
message_id: string;
Expand Down Expand Up @@ -229,7 +231,7 @@ export class AgentFrameworkStorageService implements StorageService {
try {
const response = await this.client.transport.request({
method: 'PUT',
path: `${ML_COMMONS_BASE_API}/memory/message/${interactionId}`,
path: `${ML_COMMONS_BASE_API}/memory/message/${encodeURIComponent(interactionId)}`,
body: {
additional_info: additionalInfo,
},
Expand Down Expand Up @@ -276,7 +278,7 @@ export class AgentFrameworkStorageService implements StorageService {
}
const interactionsResp = (await this.client.transport.request({
method: 'GET',
path: `${ML_COMMONS_BASE_API}/memory/message/${interactionId}`,
path: `${ML_COMMONS_BASE_API}/memory/message/${encodeURIComponent(interactionId)}`,
})) as ApiResponse<InteractionFromAgentFramework>;
return formatInteractionFromBackend(interactionsResp.body);
}
Expand Down

0 comments on commit a167a16

Please sign in to comment.