refactor: Centralise deeplink encode and decode into server #3489

jsibbison-square · 2025-07-17T21:10:18Z

Summary

Centralized deeplink recipe encoding/decoding logic in goose-server to ensure consistency and avoid incompatibility across different implementations, as discussed in PR #3446 review.

Key Changes

Centralized Logic:
- All deeplink recipe encoding/decoding now uses a single implementation in the backend (goose-server).
- Adopted base64 (URL-safe, no padding) encoding for portability and compactness.
- Backend includes fallback logic for legacy-encoded deep URLs.
Refactoring:
- Updated CLI and desktop code to use the new centralized server functions for encoding/decoding (call overhead is now <1–2ms vs. previous inline logic).
- Cleaned up GUI code by merging the incomplete RecipeConfig struct into the more complete Recipe struct—frontend now has a single config representation.

Tested

From Recipe Library
- 'Use' or 'Load Recipe' from View. Does not work due existing bug fix: Load and Use recipes in new window #3501
From recipe generator
- Open deeplink
- Import deeplink
From cli
- Open deeplink
- Import deeplink
Create recipe
Generate recipe from session
Create schedule import deeplink
Edit recipe
View recipe

Notes

Further refactors/cleanups are possible but have been left out to keep this PR small enough.

jsibbison-square · 2025-07-18T00:51:37Z

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

    Router::new()
        .route("/recipe/create", post(create_recipe))
+        .route("/recipes/encode", post(encode_recipe))
+        .route("/recipes/decode", post(decode_recipe))


I think we should move /recipe to /recipes in a future pr

DOsinga

thanks for jumping on this. my main concern is the way that we have done the API integration in the past and now follow up, sidestepping our open-api setup -

just generate-openapi

DOsinga · 2025-07-18T07:50:01Z

ui/desktop/src/components/ui/DeepLinkModal.tsx

+    const generateLink = async () => {
+      setIsGeneratingLink(true);
+      try {
+        const currentConfig = {


here and elsewhere, I'm not sure why we use the word config when we meant to say recipe or recipeToEncode or some such

DOsinga · 2025-07-18T07:51:12Z

ui/desktop/src/main.ts

+}
+
+// When opening the app with a deeplink, the window is still initializing so we have to duplicate some window dependant logic here.
+async function decodeRecipeMain(deeplink: string, port: number): Promise<Recipe | null> {


... and hopefully in the not so distant future we can just send the deeplink along when we initialize the backend

yeah only soo much refactoring could be done at a time.

DOsinga · 2025-07-18T08:31:58Z

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

    error: Option<String>,
 }

+#[derive(Debug, Deserialize)]


It looks like this entire recipe thing is not part of our open-api integration somehow. this should be integrated with openapi.rs and then we can autogenerate the ts code. can you check how much work it is to do this the right way? if too much, we can do in a follow up

I'm not familiar with the open-api pieces. I can rectifying that in a future pr.

…ntral-deeplinks * origin/main: (22 commits) feat: deprecate jetbrains extension in favor of public one (#2589) feat: Add LiteLLM provider with automatic prompt caching support (#3380) docs: update desktop instructions for managing sessions (#3522) docs: update desktop instructions for session recipes (#3521) Replace mcp_core::content types with rmcp::model types (#3500) docs: update desktop instructions for tool perms (#3518) docs: update desktop instructions for tool router (#3519) Alexhancock/reapply 3491 (#3515) docs: update mcp install instructions for desktop (#3504) Docs: Access settings in new UI (#3514) feat: switch from mcp_core::Role to rmcp::model::Role (#3488) Revert "fix the output not being visible issue (#3491)" (#3511) fix: Load and Use recipes in new window (#3501) fix: working dir was not being set correctly (#3477) Fix launching session in new window (#3497) Fix tool call allow still showing initial state in chat after navigating back (#3498) feat: add rmcp as a workspace dep (#3483) feat: consolidate subagent execution for dynamic tasks (#3444) fix token alert indicator/popovers hiding and showing (#3492) Fix llm errors not propagating to the ui and auto summarize not starting (#3490) ...

* 'main' of github.com:block/goose: Catch json errors a little better (#3437) Rust debug (#3510) refactor: Centralise deeplink encode and decode into server (#3489)

cloud-on-prem · 2025-07-20T23:49:52Z

crates/goose/src/recipe_deeplink.rs

+use crate::recipe::Recipe;
+
+#[derive(Error, Debug)]
+pub enum DecodeError {


For future, it would be nice to distinguish the errors.

#[derive(Error, Debug)] pub enum DecodeError { #[error("Invalid base64 encoding")] InvalidBase64, #[error("Invalid JSON format: {0}")] InvalidJson(String), #[error("Invalid recipe format: missing required fields")] InvalidRecipe, #[error("Unsupported deeplink format")] UnsupportedFormat, }

cloud-on-prem · 2025-07-20T23:51:40Z

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

    Router::new()
        .route("/recipe/create", post(create_recipe))
+        .route("/recipes/encode", post(encode_recipe))
+        .route("/recipes/decode", post(decode_recipe))


* main: Extension Library Improvements (#3541) fix(ui): enable selection of zero-config providers in desktop GUI (#3378) refactor: Renames recipe route to recipes to be consistent (#3540) Blog: Orchestrating 6 Subagents to Build a Collaborative API Playground (#3528) Catch json errors a little better (#3437) Rust debug (#3510) refactor: Centralise deeplink encode and decode into server (#3489) feat: deprecate jetbrains extension in favor of public one (#2589) feat: Add LiteLLM provider with automatic prompt caching support (#3380) docs: update desktop instructions for managing sessions (#3522) docs: update desktop instructions for session recipes (#3521) Replace mcp_core::content types with rmcp::model types (#3500) docs: update desktop instructions for tool perms (#3518) docs: update desktop instructions for tool router (#3519) Alexhancock/reapply 3491 (#3515) docs: update mcp install instructions for desktop (#3504) Docs: Access settings in new UI (#3514) feat: switch from mcp_core::Role to rmcp::model::Role (#3488) Revert "fix the output not being visible issue (#3491)" (#3511) fix: Load and Use recipes in new window (#3501)

* main: (32 commits) fix: use sequential when sub recipe task is 1. (#3573) fix: track message id to keep like with like (#3572) Replace mcp_core::prompt with rmcp::model types (#3561) feat (ui): close recipe modals with esc key (#3568) feat: recipes can retry with success criteria (#3474) Env var to set Ollama request timeout (#3516) Updating docs to match new UI (#3552) Improve Claude Code provider error message for missing CLI (#3363) feat: Work around Gemini API tool call quirks (#3328) feat(ui): Source CashSans-Bold and improve overall text rendering (#3091) refactor: Use openapi for recipe endpoint types and in frontend (#3548) Fix Google Analytics error for local dev (#3544) Extension Library Improvements (#3541) fix(ui): enable selection of zero-config providers in desktop GUI (#3378) refactor: Renames recipe route to recipes to be consistent (#3540) Blog: Orchestrating 6 Subagents to Build a Collaborative API Playground (#3528) Catch json errors a little better (#3437) Rust debug (#3510) refactor: Centralise deeplink encode and decode into server (#3489) feat: deprecate jetbrains extension in favor of public one (#2589) ...

Signed-off-by: Adam Tarantino <tarantino.adam@hey.com>

jsibbison-square force-pushed the jsibbison-20250717-central-deeplinks branch from a9a787e to bfc7118 Compare July 17, 2025 21:28

Centralise deeplink encode and decode into server

3451eb3

jsibbison-square force-pushed the jsibbison-20250717-central-deeplinks branch from bfc7118 to 3451eb3 Compare July 17, 2025 21:51

jsibbison-square added 2 commits July 18, 2025 10:23

Fix deeplink loading

b55ac93

Fix agent creation form data loading

06baafc

jsibbison-square commented Jul 18, 2025

View reviewed changes

Cleanup

cdc6eed

jsibbison-square marked this pull request as ready for review July 18, 2025 01:23

jsibbison-square mentioned this pull request Jul 18, 2025

fix: Fixes importing url encoded recipe deeplinks #3446

Merged

jsibbison-square changed the title ~~Centralise deeplink encode and decode into server~~ chore: Centralise deeplink encode and decode into server Jul 18, 2025

jsibbison-square changed the title ~~chore: Centralise deeplink encode and decode into server~~ refactor: Centralise deeplink encode and decode into server Jul 18, 2025

jsibbison-square requested review from DOsinga and zanesq July 18, 2025 01:25

DOsinga approved these changes Jul 18, 2025

View reviewed changes

DOsinga self-assigned this Jul 18, 2025

jsibbison-square added 2 commits July 20, 2025 15:25

Rename config vars to recipe where related

fbaab29

jsibbison-square merged commit e2e656c into main Jul 20, 2025
13 of 16 checks passed

jsibbison-square deleted the jsibbison-20250717-central-deeplinks branch July 20, 2025 08:13

cloud-on-prem reviewed Jul 20, 2025

View reviewed changes

jsibbison-square mentioned this pull request Jul 21, 2025

refactor: Use openapi for recipe endpoint types and in frontend #3548

Merged

zanesq pushed a commit that referenced this pull request Jul 23, 2025

refactor: Centralise deeplink encode and decode into server (#3489)

3bda922

atarantino pushed a commit to atarantino/goose that referenced this pull request Aug 5, 2025

refactor: Centralise deeplink encode and decode into server (block#3489)

4feb957

Signed-off-by: Adam Tarantino <tarantino.adam@hey.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Centralise deeplink encode and decode into server #3489

refactor: Centralise deeplink encode and decode into server #3489

Uh oh!

jsibbison-square commented Jul 17, 2025 •

edited

Loading

Uh oh!

jsibbison-square Jul 18, 2025

Uh oh!

cloud-on-prem Jul 20, 2025

Uh oh!

DOsinga left a comment

Uh oh!

DOsinga Jul 18, 2025

Uh oh!

DOsinga Jul 18, 2025

Uh oh!

jsibbison-square Jul 18, 2025

Uh oh!

DOsinga Jul 18, 2025

Uh oh!

jsibbison-square Jul 18, 2025

Uh oh!

Uh oh!

cloud-on-prem Jul 20, 2025

Uh oh!

cloud-on-prem Jul 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

refactor: Centralise deeplink encode and decode into server #3489

refactor: Centralise deeplink encode and decode into server #3489

Uh oh!

Conversation

jsibbison-square commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Key Changes

Tested

Notes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DOsinga left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jsibbison-square commented Jul 17, 2025 •

edited

Loading