feat(project): add gateway resources #2028
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,168 @@ | ||
| import { afterEach, describe, expect, test } from "bun:test"; | ||
| import { writeFile } from "node:fs/promises"; | ||
| import { join } from "node:path"; | ||
| import { createGatewayProjectTestHarness } from "../gateway-test-support"; | ||
|
|
||
| const COMPLETE_CONNECTOR = JSON.stringify({ | ||
| name: "configured", | ||
| targetType: "connector", | ||
| connectorId: "web-search", | ||
| }); | ||
|
|
||
| const { addGateway, cleanup, inProject, projectSpec, run } = | ||
| createGatewayProjectTestHarness("gateway-connector"); | ||
|
|
||
| afterEach(cleanup); | ||
|
|
||
| describe("project add gateway-connector", () => { | ||
| test("adds Web Search and external Knowledge Base connectors", async () => { | ||
| const projectRoot = await inProject(); | ||
| await addGateway(); | ||
|
|
||
| await run([ | ||
| "add", | ||
| "gateway-connector", | ||
| "--gateway", | ||
| "tools", | ||
| "--name", | ||
| "web", | ||
| "--connector", | ||
| "web-search", | ||
| ]); | ||
| await run([ | ||
| "add", | ||
| "gateway-connector", | ||
| "--gateway", | ||
| "tools", | ||
| "--name", | ||
| "knowledge", | ||
| "--connector", | ||
| "bedrock-knowledge-bases", | ||
| "--knowledge-base", | ||
| "ABCDEFGHIJ", | ||
| ]); | ||
|
|
||
| expect((await projectSpec(projectRoot)).agentCoreGateways[0].targets).toEqual([ | ||
| { | ||
| name: "web", | ||
| targetType: "connector", | ||
| connectorId: "web-search", | ||
| configurations: [{ name: "WebSearch", parameterValues: { maxResults: 10 } }], | ||
| }, | ||
| { | ||
| name: "knowledge", | ||
| targetType: "connector", | ||
| connectorId: "bedrock-knowledge-bases", | ||
| configurations: [{ name: "Retrieve", parameterValues: { knowledgeBaseId: "ABCDEFGHIJ" } }], | ||
| }, | ||
| ]); | ||
| }); | ||
|
|
||
| test("reads a complete connector Target from a file", async () => { | ||
| const projectRoot = await inProject(); | ||
| await addGateway(); | ||
| const target = { | ||
| name: "configured", | ||
| targetType: "connector", | ||
| connectorId: "web-search", | ||
| configurations: [{ name: "WebSearch", parameterValues: { maxResults: 3 } }], | ||
| }; | ||
| const path = join(projectRoot, "connector.json"); | ||
| await writeFile(path, JSON.stringify(target)); | ||
|
|
||
| await run([ | ||
| "add", | ||
| "gateway-connector", | ||
| "--gateway", | ||
| "tools", | ||
| "--connector-configuration", | ||
| `file://${path}`, | ||
| ]); | ||
|
|
||
| expect((await projectSpec(projectRoot)).agentCoreGateways[0].targets[0]).toEqual(target); | ||
| }); | ||
|
|
||
| test("rejects a non-connector project Target", async () => { | ||
| await inProject(); | ||
| await addGateway(); | ||
|
|
||
| await expect( | ||
| run([ | ||
| "add", | ||
| "gateway-connector", | ||
| "--gateway", | ||
| "tools", | ||
| "--connector-configuration", | ||
| '{"name":"server","targetType":"mcpServer","endpoint":"https://mcp.example.com"}', | ||
| ]), | ||
| ).rejects.toThrow('targetType: "connector"'); | ||
| }); | ||
|
|
||
| test.each([ | ||
| [ | ||
| "missing parent Gateway", | ||
| ["--name", "web", "--connector", "web-search"], | ||
| "required option '--gateway", | ||
| ], | ||
| ["no connector mode", ["--gateway", "tools", "--name", "web"], "specify exactly one"], | ||
| [ | ||
| "both connector modes", | ||
| [ | ||
| "--gateway", | ||
| "tools", | ||
| "--name", | ||
| "web", | ||
| "--connector", | ||
| "web-search", | ||
| "--connector-configuration", | ||
| COMPLETE_CONNECTOR, | ||
| ], | ||
| "specify exactly one", | ||
| ], | ||
| [ | ||
| "name with complete connector JSON", | ||
| ["--gateway", "tools", "--name", "web", "--connector-configuration", COMPLETE_CONNECTOR], | ||
| "--name is part of --connector-configuration", | ||
| ], | ||
| [ | ||
| "knowledge base with complete connector JSON", | ||
| [ | ||
| "--gateway", | ||
| "tools", | ||
| "--connector-configuration", | ||
| COMPLETE_CONNECTOR, | ||
| "--knowledge-base", | ||
| "ABCDEFGHIJ", | ||
| ], | ||
| "--knowledge-base cannot be combined", | ||
| ], | ||
| [ | ||
| "shortcut without name", | ||
| ["--gateway", "tools", "--connector", "web-search"], | ||
| "required option '--name", | ||
| ], | ||
| [ | ||
| "knowledge base with Web Search", | ||
| [ | ||
| "--gateway", | ||
| "tools", | ||
| "--name", | ||
| "web", | ||
| "--connector", | ||
| "web-search", | ||
| "--knowledge-base", | ||
| "ABCDEFGHIJ", | ||
| ], | ||
| "--knowledge-base requires --connector bedrock-knowledge-bases", | ||
| ], | ||
| [ | ||
| "Knowledge Base connector without Knowledge Base", | ||
| ["--gateway", "tools", "--name", "knowledge", "--connector", "bedrock-knowledge-bases"], | ||
| "requires --knowledge-base", | ||
| ], | ||
| ])("rejects %s", async (_label, flags, message) => { | ||
| await inProject(); | ||
| await addGateway(); | ||
| await expect(run(["add", "gateway-connector", ...flags])).rejects.toThrow(message); | ||
| }); | ||
| }); |
This file contains hidden or 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,127 @@ | ||
| import z from "zod"; | ||
| import { InputValidationError } from "../../../../errors"; | ||
| import { SourceResolver } from "../../../../io"; | ||
| import { | ||
| AgentCoreGatewayTargetSchema, | ||
| type AgentCoreGatewayTarget, | ||
| type ConnectorId, | ||
| } from "../../../../projectSchemas/gateway"; | ||
| import { createHandler, flag, ProjectKey } from "../../../../router"; | ||
| import { parseJsonFlagWithSchema } from "../../../utils"; | ||
| import type { AddProjectResourceConfig } from "../types"; | ||
|
|
||
| export const createAddGatewayConnectorHandler = (config: AddProjectResourceConfig) => | ||
| createHandler({ | ||
| name: "gateway-connector", | ||
| description: "adds a connector-backed Target to a project Gateway", | ||
| flags: [ | ||
| flag("gateway", "name of the parent Gateway in this project", z.string().optional()), | ||
| flag("name", "the Target name for a connector shortcut", z.string().optional()), | ||
| flag( | ||
| "connector", | ||
| "curated connector", | ||
| z.enum(["web-search", "bedrock-knowledge-bases"]).optional(), | ||
| ), | ||
| flag( | ||
| "connector-configuration", | ||
| "complete connector agentCoreGateways[].targets[] object (JSON; inline, file://<path>, or - for stdin)", | ||
| z.string().optional(), | ||
| ), | ||
| flag( | ||
| "knowledge-base", | ||
| "project Knowledge Base name or external ten-character Knowledge Base ID", | ||
|
Contributor
There was a problem hiding this comment. add that this could only be used with |
||
| z.string().optional(), | ||
| ), | ||
| ], | ||
| handle: async (ctx, flags) => { | ||
| if (!flags.gateway) { | ||
| throw new InputValidationError("required option '--gateway <gateway>' not specified"); | ||
| } | ||
| if ((flags.connector === undefined) === (flags["connector-configuration"] === undefined)) { | ||
| throw new InputValidationError( | ||
| "specify exactly one of '--connector' or '--connector-configuration'", | ||
| ); | ||
| } | ||
|
|
||
| const usesConfiguration = flags["connector-configuration"] !== undefined; | ||
| if (usesConfiguration && flags.name !== undefined) { | ||
| throw new InputValidationError( | ||
| "--name is part of --connector-configuration and cannot be supplied separately", | ||
| ); | ||
| } | ||
| if (usesConfiguration && flags["knowledge-base"] !== undefined) { | ||
| throw new InputValidationError( | ||
| "--knowledge-base cannot be combined with --connector-configuration", | ||
| ); | ||
| } | ||
| if (!usesConfiguration && !flags.name) { | ||
| throw new InputValidationError("required option '--name <name>' not specified"); | ||
| } | ||
| if (flags["knowledge-base"] !== undefined && flags.connector !== "bedrock-knowledge-bases") { | ||
| throw new InputValidationError( | ||
| "--knowledge-base requires --connector bedrock-knowledge-bases", | ||
| ); | ||
| } | ||
|
|
||
| const project = ctx.require(ProjectKey); | ||
| let target: AgentCoreGatewayTarget; | ||
| if (usesConfiguration) { | ||
| const source = new SourceResolver({ stdin: config.io.stdin }); | ||
| target = parseJsonFlagWithSchema( | ||
| "connector-configuration", | ||
| await source.resolveText("connector-configuration", flags["connector-configuration"]), | ||
| AgentCoreGatewayTargetSchema, | ||
| )!; | ||
| if (target.targetType !== "connector") { | ||
| throw new InputValidationError( | ||
| '--connector-configuration must have targetType: "connector"', | ||
| ); | ||
| } | ||
| } else { | ||
| target = connectorTargetFromShortcut( | ||
| flags.name!, | ||
| flags.connector!, | ||
| flags["knowledge-base"], | ||
| ); | ||
| } | ||
|
|
||
| for await (const event of config.projectManager.addResource(project, { | ||
| resourceType: "gateway-target", | ||
| gatewayName: flags.gateway, | ||
| resourceConfig: target, | ||
| })) { | ||
| config.io.stderr.write(`${event.message}\n`); | ||
| } | ||
| config.io.stderr.write( | ||
| `added Connector Target '${target.name}' to Gateway '${flags.gateway}' in '${project.name}'\n`, | ||
| ); | ||
| }, | ||
| }); | ||
|
|
||
| function connectorTargetFromShortcut( | ||
| name: string, | ||
| connectorId: ConnectorId, | ||
| knowledgeBase?: string, | ||
| ): AgentCoreGatewayTarget { | ||
| switch (connectorId) { | ||
| case "web-search": | ||
| return { | ||
| name, | ||
| targetType: "connector", | ||
| connectorId, | ||
| configurations: [{ name: "WebSearch", parameterValues: { maxResults: 10 } }], | ||
| }; | ||
| case "bedrock-knowledge-bases": | ||
| if (!knowledgeBase) { | ||
|
Contributor
There was a problem hiding this comment. Don't we do this validation at line 60? |
||
| throw new InputValidationError( | ||
| "--connector bedrock-knowledge-bases requires --knowledge-base", | ||
| ); | ||
| } | ||
| return { | ||
| name, | ||
| targetType: "connector", | ||
| connectorId, | ||
| configurations: [{ name: "Retrieve", parameterValues: { knowledgeBaseId: knowledgeBase } }], | ||
| }; | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
nit: does not exist in project. Please check agentCoreGateway in agentcore.json