Lifei/create save recipe to file by lifeizhou-ap · Pull Request #4895 · block/goose

lifeizhou-ap · 2025-09-30T07:50:27Z

Pull Request Description

Created endpoints so that frontend can call the server side to import recipe and save recipe to files
1. /recipes/save_to_file
  - to be used in the import, edit, create recipe flows
  - include validate the duplicate files and duplicate title in the server side so that we can remove the logic of validate recipe schema and these validation on the frontend
  - Now it only should accept the recipe (not the recipe wrapper any more. ie. with name, is_global, is_archived....)
2. /recipe/parse
- to be used to parse the recipe when import recipe from file. For importing recipe from deeplink, we have already used decode_recipe endpoint
Removed the is_global attribute from list_recipes endpoint payload
Created a general ErrorResponse to return error message from server side

Note
I only changed the ImportFileDialog a bit to just test whether these end points works. I did not make much changes/removal on Frontend to avoid merge conflicts before Zane's PR is merged

…sponse

DOsinga · 2025-09-30T13:08:26Z

crates/goose/src/recipe/recipe_library.rs

+            .config_dir()
+            .join("recipes")
+    } else {
+        std::env::current_dir().unwrap().join(".goose/recipes")


unfortunately this is not going to work. we'd need the directory of the session here, not the current directory.

How about the current non global recipes that persists on user's machine? (ie: they were saved on the current working directory before) Shall we still support them?

Are we also going to have recipes in the directory of the session in the future?

DOsinga · 2025-09-30T13:11:16Z

crates/goose-server/src/routes/errors.rs

+
+        (self.status, body).into_response()
+    }
+}


this is cute and we certainly need something like this, but I would leave it out for now; the real refactor here is to have something that converts from our errors to a ErrorResponse globally and then apply it everywhere. would love to have it, but I don't think it is in scope /cc @jamadeo

axum is very permissive about what you can return: https://docs.rs/axum/latest/axum/response/index.html

You can already return a (StatusCode, String) and it will convert

cool. we should do this for everything some time. maybe goose can

DOsinga · 2025-09-30T13:17:53Z

ui/desktop/src/recipe/recipe_management.ts

+    throwOnError: true,
+  });
+  return response.data.recipe;
+}


I know we do this elsewhere, but I am not really a fan of these thin layers that hide where things happen - can we not just call things directly?

These functions are used in multiple times, that's why I extract them here

but what function, this is just calling parseRecipe and naming it parseRecipeFromFile? why the overhead

At the moment the in ImportFileModal calls parseRecipe 2 times. The UI change I included is just for testing. I have revert UI change in this PR and I am going to merge this backend change PR soon.

When we get the latest changes from Zane's PR, we can check whether the Modal has to call parseRecipe multiple time

DOsinga · 2025-09-30T13:18:45Z

ui/desktop/src/components/recipes/ImportRecipeForm.tsx

-        if (titleValidationError) {
-          throw new Error(titleValidationError);
-        }
+        // const titleValidationError = await validateTitleUniqueness(value.recipeTitle.trim());


what? why would names have to be unique :(

Name and title are different attributes. Name is what's currently displayed in the UI, title is only used for the file name. We added uniqueness check because otherwise it'd overwrite existing recipes altogether, which is also a confusing UX

uhm, if name and title are different attributes and title is use for the file name, I think we are in trouble

i feel name and title are very confusing in the frontend, and they are used interchangeably. That's why I took this chance to make it simpler.

Currently name is defined in the wrapper of the recipe in the recipe management. Since we don't want the wrap version of the recipe, we can use recipe title instead to display on the UI.

Also we can the title to work out the file name for new recipes or imported recipe.

For the existing recipe, we use the recipe id to work out the existing recipe file path at the server side. It would not use the name or recipe title.

DOsinga · 2025-09-30T13:36:00Z

crates/goose-server/src/routes/recipe.rs

        .route("/recipes/scan", post(scan_recipe))
        .route("/recipes/list", get(list_recipes))
        .route("/recipes/delete", post(delete_recipe))
+        .route("/recipes/save_to_file", post(save_recipe_to_file))


let's call this just save and save_recipe. no need to tell people we save this to file

Was thinking of save_to_disk but yeah I agree the extra info isn't needed

DOsinga · 2025-09-30T13:39:37Z

crates/goose/src/recipe/recipe_library.rs

+
+pub fn save_recipe_to_file(
+    recipe: Recipe,
+    is_global: Option<bool>,


I think we should drop this now. all writes should go to the global version - we can read from local for a while though

This should also be reflected in the UI by removing the radio buttons

We can have a separate PR for this

DOsinga · 2025-09-30T13:41:44Z

crates/goose/src/recipe/recipe_library.rs

+    Ok(recipes_with_path)
+}
+
+pub fn list_all_recipes_from_library() -> Result<Vec<(PathBuf, Recipe)>> {


I would prefer it if we would integrate this with how the CLI works; there we have a function that reads recipes from various places; can we not add this to that so we get a clear overview

will address in the next PR

DOsinga · 2025-09-30T13:43:25Z

crates/goose-server/src/routes/recipe.rs

        .route("/recipes/list", get(list_recipes))
        .route("/recipes/delete", post(delete_recipe))
+        .route("/recipes/save_to_file", post(save_recipe_to_file))
+        .route("/recipes/parse", post(parse_recipe))


should we replace /decode with this too? and really make parse so that it also takes base64 etc

amed-xyz · 2025-09-30T18:17:43Z

crates/goose-server/src/routes/recipe.rs

        .route("/recipes/scan", post(scan_recipe))
        .route("/recipes/list", get(list_recipes))
        .route("/recipes/delete", post(delete_recipe))
+        .route("/recipes/save_to_file", post(save_recipe_to_file))


Was thinking of save_to_disk but yeah I agree the extra info isn't needed

amed-xyz · 2025-09-30T18:24:00Z

crates/goose-server/src/routes/recipe_utils.rs

+            continue;
+        };
+        let recipe_metadata =
+            RecipeManifestMetadata::from_yaml_file(&file_path).unwrap_or_else(|_| {


The current import UI also supports JSON so we may want to consider that too

yaml is a superset of json so that should be alright

amed-xyz · 2025-09-30T18:25:39Z

crates/goose/src/recipe/recipe_library.rs

+    if path.exists() {
+        for entry in fs::read_dir(path)? {
+            let path = entry?.path();
+            if path.extension() == Some("yaml".as_ref()) {


amed-xyz · 2025-09-30T18:26:39Z

crates/goose/src/recipe/recipe_library.rs

+
+pub fn save_recipe_to_file(
+    recipe: Recipe,
+    is_global: Option<bool>,


This should also be reflected in the UI by removing the radio buttons

amed-xyz · 2025-09-30T18:29:38Z

ui/desktop/src/components/recipes/ImportRecipeForm.tsx

-        if (titleValidationError) {
-          throw new Error(titleValidationError);
-        }
+        // const titleValidationError = await validateTitleUniqueness(value.recipeTitle.trim());


Name and title are different attributes. Name is what's currently displayed in the UI, title is only used for the file name. We added uniqueness check because otherwise it'd overwrite existing recipes altogether, which is also a confusing UX

amed-xyz · 2025-09-30T18:30:21Z

ui/desktop/src/components/recipes/ImportRecipeForm.tsx

+        // if (!validationResult.success) {
+        //   const errorMessages = getValidationErrorMessages(validationResult.errors);
+        //   throw new Error(`Recipe validation failed: ${errorMessages.join(', ')}`);
+        // }


Why are we commenting out this?

As noted in the PR description, the ImportRecipeFrom.tsx change is only for testing. The UI code change will start after Zane's PR is merged

…se into zane/create-recipe-unification-feedback * 'zane/create-recipe-unification' of github.com:block/goose: Lifei/create save recipe to file (#4895)

* main: (24 commits) Lifei/create save recipe to file (#4895) feat(nightly): build nightlies from main shas (#4888) Add missing library for fedora/rhel/centos docs (#4819) feat(process): Add GOVERNANCE and MAINTAINERS documents (#4962) Pause test finder, have it run cargo fmt (#4958) Disable the issue comment trigger on pr-comment-bundle (#4961) fix(providers): update Claude Sonnet 4 model identifier (#4884) fix redirect to extensions page after deeplink install and show toast with success message (#4863) Remove wait-for-ready log (#4956) docs: add a new goose tip (#4940) Add PR template (#4934) Using --resume with --name should still accept session IDs (#4937) Fix auto scroll to bottom during chat (#4923) Fix Typo, Add Description to Hacktoberfest Content Issue Template (#4931) Don't set agent props twice (#4872) fix: conversation fixer merges assistant text blocks and drops empty text messages (#4898) Batch fetch remaining issues for documentation updates fix: session timestamps (#4913) feat: lazy infinite scroller for session history view (#4922) chore: properly identify when to try oauth (#4918) ...

Signed-off-by: HikaruEgashira <hikaru-egashira@c-fo.com>

* main: docs: Change community page sections (block#4984) docs: remove temporary Hacktoberfest issue templates (block#4982) Create multi-channel researcher prompt (block#4947) docs: Add Community Content section to Community Page (block#4964) Allow empty API Key when registering custom provider (block#4977) Feat: Add prompt injection detection settings UI + update logging (block#4651) Make create_session work concurrently (block#4954) Lifei/create save recipe to file (block#4895)

lifeizhou-ap added 6 commits September 30, 2025 12:31

added save recipe to file route

4f9d087

extract list all recipes from library and removed is_global in api re…

ade8b79

…sponse

simplified error handling

35764f6

added parse recipe endpoint to import recipe from file

3db1468

introduced general error payload with message

e6fec0c

removed the logging

f9f9eef

lifeizhou-ap marked this pull request as ready for review September 30, 2025 07:54

lifeizhou-ap requested review from DOsinga, amed-xyz and zanesq September 30, 2025 07:58

DOsinga approved these changes Sep 30, 2025

View reviewed changes

amed-xyz reviewed Sep 30, 2025

View reviewed changes

renamed route name

be8cfcb

lifeizhou-ap merged commit a3fbeb0 into main Oct 2, 2025
11 checks passed

lifeizhou-ap deleted the lifei/create-save-recipe-to-file branch October 2, 2025 23:38

HikaruEgashira pushed a commit to HikaruEgashira/goose that referenced this pull request Oct 3, 2025

Lifei/create save recipe to file (block#4895)

54a61ef

Signed-off-by: HikaruEgashira <hikaru-egashira@c-fo.com>

This was referenced Oct 8, 2025

chore(release): release version 1.10.0 #5060

Closed

release/1.10.0 #5101

Closed

Conversation

lifeizhou-ap commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lifeizhou-ap Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lifeizhou-ap commented Sep 30, 2025 •

edited

Loading

lifeizhou-ap Sep 30, 2025 •

edited

Loading