-
Notifications
You must be signed in to change notification settings - Fork 75
feat(project): implement remove command #2037
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.
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
Changes from all commits
81b0eb7
3edf5fb
baad679
9381e8a
77f7c0d
c0c2821
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,7 @@ import type { | |
| ProjectManager, | ||
| ProjectEvent, | ||
| ProjectResource, | ||
| RemoveResourceInput, | ||
| } from "../../handlers/project/types"; | ||
| import type { Logger } from "../../logging"; | ||
| import { | ||
|
|
@@ -127,7 +128,7 @@ export class FsProjectManager implements ProjectManager { | |
| input: AddResourceInput, | ||
| ): AsyncGenerator<ProjectEvent, Project> { | ||
| const { resourceType, resourceConfig } = input; | ||
| const agentCoreSpecPath = join(project.rootPath, "agentcore", "agentcore.json"); | ||
| const agentCoreSpecPath = this.getProjectSpecPath(project); | ||
| const projectSpecKey = toProjectSpecKey(resourceType); | ||
|
|
||
| yield { message: `Reading project spec file at '${agentCoreSpecPath}'` }; | ||
|
|
@@ -199,6 +200,42 @@ export class FsProjectManager implements ProjectManager { | |
| } | ||
| } | ||
|
|
||
| private getProjectSpecPath(project: Project): string { | ||
| return join(project.rootPath, "agentcore", "agentcore.json"); | ||
| } | ||
|
|
||
| public async removeResource(project: Project, input: RemoveResourceInput): Promise<Project> { | ||
| const agentCoreSpecPath = this.getProjectSpecPath(project); | ||
| const projectSpecKey = toProjectSpecKey(input.resourceType); | ||
|
|
||
| const existingProjectSpec = await this.json.read(agentCoreSpecPath, ProjectSpecSchema); | ||
|
|
||
| const existingResources = existingProjectSpec[projectSpecKey]; | ||
| const newResources = existingResources.filter((r) => r.name !== input.name); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Later, we can make this a helper function that could be used to prevent duplicates for |
||
|
|
||
| if (newResources.length === existingResources.length) | ||
| this.logger | ||
| .child({ input }) | ||
| .warn(`unable to remove resource from project that does not exist.`); | ||
|
Comment on lines
+217
to
+219
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can we throw right after this? at this point, the handler would still return a user message like
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think an idempotent delete is easier, especially if customers are using this in some kind of automation.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree with keeping the successful exit code; idempotency here is useful. Though the As a nit I'd say we should maintain the success exit code, but add a mechanism for differentiating the result. |
||
|
|
||
| const newSpecParseResult = ProjectSpecSchema.safeParse({ | ||
| ...existingProjectSpec, | ||
| [projectSpecKey]: newResources, | ||
| }); | ||
|
|
||
| if (!newSpecParseResult.success) | ||
| throw new InputValidationError(z.prettifyError(newSpecParseResult.error), { | ||
| cause: newSpecParseResult.error, | ||
| }); | ||
|
|
||
| const newProjectSpec = await this.json.write(agentCoreSpecPath, newSpecParseResult.data); | ||
|
|
||
| return { | ||
| ...project, | ||
| spec: newProjectSpec, | ||
| }; | ||
| } | ||
|
|
||
| private async scaffoldHarness( | ||
| outputPath: string, | ||
| harnessSpec: z.input<typeof HarnessSpecSchema>, | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| import { afterEach, describe, expect, test } from "bun:test"; | ||
| import { mkdtemp, rm } from "node:fs/promises"; | ||
| import { join } from "node:path"; | ||
| import { tmpdir } from "node:os"; | ||
| import { createRootHandler } from "../../index"; | ||
| import { | ||
| createSilentLogger, | ||
| TestCoreClient, | ||
| TestGlobalConfigAccessor, | ||
| testIO, | ||
| } from "../../../testing"; | ||
| import { InputValidationError } from "../../../errors"; | ||
|
|
||
| const originalCwd = process.cwd(); | ||
| const tempDirectories: string[] = []; | ||
|
|
||
| async function inTempDirectory(): Promise<string> { | ||
| const directory = await mkdtemp(join(tmpdir(), "agentcore-remove-")); | ||
| tempDirectories.push(directory); | ||
| process.chdir(directory); | ||
| return process.cwd(); | ||
| } | ||
|
|
||
| afterEach(async () => { | ||
| process.chdir(originalCwd); | ||
| await Promise.all( | ||
| tempDirectories.splice(0).map((directory) => rm(directory, { recursive: true, force: true })), | ||
| ); | ||
| }); | ||
|
|
||
| async function run(args: string[]) { | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. as a follow-up, I think we can pull this and inProject below out into a common location |
||
| const io = testIO(); | ||
| const core = new TestCoreClient(); | ||
| const root = createRootHandler(core, { | ||
| io: io.io, | ||
| globalConfigAccessor: new TestGlobalConfigAccessor(), | ||
| logger: createSilentLogger(), | ||
| }); | ||
| await root.route(["node", "agentcore", "project", ...args]); | ||
| return { io, core }; | ||
| } | ||
|
|
||
| async function inProject(name = "TestProject"): Promise<string> { | ||
| const directory = await inTempDirectory(); | ||
| await run(["create", "--name", name, "--skip-install", "--skip-git"]); | ||
| const projectRoot = join(directory, name); | ||
| process.chdir(projectRoot); | ||
| return projectRoot; | ||
| } | ||
|
|
||
| type RemoveCase = { | ||
| label: string; | ||
| commands: string[][]; | ||
| specKey: string; | ||
| expectedRemaining: string[]; | ||
| }; | ||
|
|
||
| describe("project remove", () => { | ||
| // Verifies that resources are removed from agentcore.json and the correct | ||
| // remaining resources are left. | ||
| test.each<RemoveCase>([ | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: There should be a test that will make sure we don't delete customer's code |
||
| { | ||
| label: "harness", | ||
| commands: [ | ||
| ["add", "harness", "--name", "my_harness"], | ||
| ["remove", "harness", "--name", "my_harness"], | ||
| ], | ||
| specKey: "harnesses", | ||
| expectedRemaining: [], | ||
| }, | ||
| { | ||
| label: "runtime", | ||
| commands: [["remove", "runtime", "--name", "hello_world"]], | ||
| specKey: "runtimes", | ||
| expectedRemaining: [], | ||
| }, | ||
| { | ||
| label: "removes one harness while leaving others intact", | ||
| commands: [ | ||
| ["add", "harness", "--name", "keep_me"], | ||
| ["add", "harness", "--name", "remove_me"], | ||
| ["remove", "harness", "--name", "remove_me"], | ||
| ], | ||
| specKey: "harnesses", | ||
| expectedRemaining: ["keep_me"], | ||
| }, | ||
| { | ||
| label: "removing a non-existent resource succeeds (no-op)", | ||
| commands: [["remove", "harness", "--name", "ghost"]], | ||
| specKey: "harnesses", | ||
| expectedRemaining: [], | ||
| }, | ||
| ])("$label", async ({ commands, specKey, expectedRemaining }) => { | ||
| const projectRoot = await inProject(); | ||
|
|
||
| for (const cmd of commands) { | ||
| await run(cmd); | ||
| } | ||
|
|
||
| const agentcoreJson = await Bun.file(join(projectRoot, "agentcore", "agentcore.json")).json(); | ||
| const remaining = (agentcoreJson[specKey] ?? []) as { name: string }[]; | ||
| expect(remaining.map((r) => r.name)).toEqual(expectedRemaining); | ||
| }); | ||
|
|
||
| // Verifies that missing required inputs are rejected before calling the manager. | ||
| test.each<[string, string[]]>([ | ||
| ["missing resource argument", ["remove", "--name", "x"]], | ||
| ["missing --name flag", ["remove", "harness"]], | ||
| ])("%s", async (_label, args) => { | ||
| await inProject(); | ||
| await expect(run(args)).rejects.toBeInstanceOf(InputValidationError); | ||
| }); | ||
| }); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,33 @@ | ||
| import { createHandler } from "../../../router"; | ||
| import { NotImplementedError } from "../../../errors"; | ||
| import { argument, createHandler, flag, ProjectKey } from "../../../router"; | ||
| import { InputValidationError } from "../../../errors"; | ||
| import z from "zod"; | ||
| import type { AppIO } from "../../../io"; | ||
| import type { ProjectManager } from "../types"; | ||
|
|
||
| export const createRemoveProjectHandler = () => | ||
| type RemoveProjectResourceConfig = { | ||
| projectManager: ProjectManager; | ||
| io: AppIO; | ||
| }; | ||
|
|
||
| export const createRemoveProjectHandler = (config: RemoveProjectResourceConfig) => | ||
| createHandler({ | ||
| name: "remove", | ||
| description: "remove a resource from the project", | ||
| handle: async () => { | ||
| throw new NotImplementedError("agentcore project remove is not implemented yet"); | ||
| flags: [flag("name", "name of the resource to remove", z.string().min(1).optional())], | ||
| arguments: [ | ||
| argument("resource", "type of resource to remove", z.enum(["harness", "runtime"]).optional()), | ||
| ], | ||
| handle: async (ctx, flags, args) => { | ||
| const resource = args["resource"]; | ||
| const name = flags["name"]; | ||
| if (!resource) throw new InputValidationError(`resource argument is required to remove`); | ||
| if (!name) throw new InputValidationError(`--name is required option`); | ||
|
|
||
| await config.projectManager.removeResource(ctx.require(ProjectKey), { | ||
| resourceType: resource, | ||
| name, | ||
| }); | ||
|
|
||
| config.io.stdout.write(`removed ${resource} with name '${name}' from project`); | ||
| }, | ||
| }); |
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 could probably re-use some logic from add, but want to wait before trying to generalize this.