From c762c2d997345020122a6d96c3ae60db2277cb3d Mon Sep 17 00:00:00 2001 From: Tanner Davis Date: Tue, 26 Nov 2024 19:48:51 +0000 Subject: [PATCH 1/3] Add Windsurf Desktop module --- .icons/windsurf.svg | 14 ++++++ windsurf-desktop/README.md | 14 ++++++ windsurf-desktop/main.test.ts | 88 +++++++++++++++++++++++++++++++++++ windsurf-desktop/main.tf | 62 ++++++++++++++++++++++++ 4 files changed, 178 insertions(+) create mode 100644 .icons/windsurf.svg create mode 100644 windsurf-desktop/README.md create mode 100644 windsurf-desktop/main.test.ts create mode 100644 windsurf-desktop/main.tf diff --git a/.icons/windsurf.svg b/.icons/windsurf.svg new file mode 100644 index 00000000..f3d6a695 --- /dev/null +++ b/.icons/windsurf.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/windsurf-desktop/README.md b/windsurf-desktop/README.md new file mode 100644 index 00000000..6e8f338d --- /dev/null +++ b/windsurf-desktop/README.md @@ -0,0 +1,14 @@ +--- +display_name: Windsurf IDE +description: Add a one-click button to launch Windsurf IDE +icon: ../.icons/windsurf.svg +maintainer_github: coder +verified: true +tags: [ide, windsurf, helper] +--- + +# Windsurf IDE + +Add a button to open any workspace with a single click in Windsurf IDE. + +Uses the [Coder Remote Windsurf Extension](https://github.com/coder/windsurf-coder). \ No newline at end of file diff --git a/windsurf-desktop/main.test.ts b/windsurf-desktop/main.test.ts new file mode 100644 index 00000000..9396f360 --- /dev/null +++ b/windsurf-desktop/main.test.ts @@ -0,0 +1,88 @@ +import { describe, expect, it } from "bun:test"; +import { + runTerraformApply, + runTerraformInit, + testRequiredVariables, +} from "../test"; + +describe("windsurf", async () => { + await runTerraformInit(import.meta.dir); + + testRequiredVariables(import.meta.dir, { + agent_id: "foo", + }); + + it("default output", async () => { + const state = await runTerraformApply(import.meta.dir, { + agent_id: "foo", + }); + expect(state.outputs.windsurf_url.value).toBe( + "windsurf://coder.coder-remote/open?owner=default&workspace=default&url=https://mydeployment.coder.com&token=$SESSION_TOKEN", + ); + + const coder_app = state.resources.find( + (res) => res.type === "coder_app" && res.name === "windsurf", + ); + + expect(coder_app).not.toBeNull(); + expect(coder_app?.instances.length).toBe(1); + expect(coder_app?.instances[0].attributes.order).toBeNull(); + }); + + it("adds folder", async () => { + const state = await runTerraformApply(import.meta.dir, { + agent_id: "foo", + folder: "/foo/bar", + }); + expect(state.outputs.windsurf_url.value).toBe( + "windsurf://coder.coder-remote/open?owner=default&workspace=default&folder=/foo/bar&url=https://mydeployment.coder.com&token=$SESSION_TOKEN", + ); + }); + + it("adds folder and open_recent", async () => { + const state = await runTerraformApply(import.meta.dir, { + agent_id: "foo", + folder: "/foo/bar", + open_recent: "true", + }); + expect(state.outputs.windsurf_url.value).toBe( + "windsurf://coder.coder-remote/open?owner=default&workspace=default&folder=/foo/bar&openRecent&url=https://mydeployment.coder.com&token=$SESSION_TOKEN", + ); + }); + + it("adds folder but not open_recent", async () => { + const state = await runTerraformApply(import.meta.dir, { + agent_id: "foo", + folder: "/foo/bar", + openRecent: "false", + }); + expect(state.outputs.windsurf_url.value).toBe( + "windsurf://coder.coder-remote/open?owner=default&workspace=default&folder=/foo/bar&url=https://mydeployment.coder.com&token=$SESSION_TOKEN", + ); + }); + + it("adds open_recent", async () => { + const state = await runTerraformApply(import.meta.dir, { + agent_id: "foo", + open_recent: "true", + }); + expect(state.outputs.windsurf_url.value).toBe( + "windsurf://coder.coder-remote/open?owner=default&workspace=default&openRecent&url=https://mydeployment.coder.com&token=$SESSION_TOKEN", + ); + }); + + it("expect order to be set", async () => { + const state = await runTerraformApply(import.meta.dir, { + agent_id: "foo", + order: "22", + }); + + const coder_app = state.resources.find( + (res) => res.type === "coder_app" && res.name === "windsurf", + ); + + expect(coder_app).not.toBeNull(); + expect(coder_app?.instances.length).toBe(1); + expect(coder_app?.instances[0].attributes.order).toBe(22); + }); +}); \ No newline at end of file diff --git a/windsurf-desktop/main.tf b/windsurf-desktop/main.tf new file mode 100644 index 00000000..257da8fb --- /dev/null +++ b/windsurf-desktop/main.tf @@ -0,0 +1,62 @@ +terraform { + required_version = ">= 1.0" + + required_providers { + coder = { + source = "coder/coder" + version = ">= 0.23" + } + } +} + +variable "agent_id" { + type = string + description = "The ID of a Coder agent." +} + +variable "folder" { + type = string + description = "The folder to open in Windsurf." + default = "" +} + +variable "open_recent" { + type = bool + description = "Open the most recent workspace or folder. Falls back to the folder if there is no recent workspace or folder to open." + default = false +} + +variable "order" { + type = number + description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)." + default = null +} + +data "coder_workspace" "me" {} +data "coder_workspace_owner" "me" {} + +resource "coder_app" "windsurf" { + agent_id = var.agent_id + external = true + icon = "/icon/windsurf.svg" + slug = "windsurf" + display_name = "Windsurf Desktop" + order = var.order + url = join("", [ + "windsurf://coder.coder-remote/open", + "?owner=", + data.coder_workspace_owner.me.name, + "&workspace=", + data.coder_workspace.me.name, + var.folder != "" ? join("", ["&folder=", var.folder]) : "", + var.open_recent ? "&openRecent" : "", + "&url=", + data.coder_workspace.me.access_url, + "&token=$SESSION_TOKEN", + ]) +} + +output "windsurf_url" { + value = coder_app.windsurf.url + description = "Windsurf Desktop URL." +} \ No newline at end of file From af2b86b9ca2e70a8c7412cea032f1a567f93e3d2 Mon Sep 17 00:00:00 2001 From: Tanner Davis Date: Tue, 26 Nov 2024 21:56:17 +0000 Subject: [PATCH 2/3] format files --- windsurf-desktop/README.md | 2 +- windsurf-desktop/main.test.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/windsurf-desktop/README.md b/windsurf-desktop/README.md index 6e8f338d..a31455c9 100644 --- a/windsurf-desktop/README.md +++ b/windsurf-desktop/README.md @@ -11,4 +11,4 @@ tags: [ide, windsurf, helper] Add a button to open any workspace with a single click in Windsurf IDE. -Uses the [Coder Remote Windsurf Extension](https://github.com/coder/windsurf-coder). \ No newline at end of file +Uses the [Coder Remote Windsurf Extension](https://github.com/coder/windsurf-coder). diff --git a/windsurf-desktop/main.test.ts b/windsurf-desktop/main.test.ts index 9396f360..616eebc2 100644 --- a/windsurf-desktop/main.test.ts +++ b/windsurf-desktop/main.test.ts @@ -85,4 +85,4 @@ describe("windsurf", async () => { expect(coder_app?.instances.length).toBe(1); expect(coder_app?.instances[0].attributes.order).toBe(22); }); -}); \ No newline at end of file +}); From 768fb366a33458e67bd42c0b405345aa503313d1 Mon Sep 17 00:00:00 2001 From: Tanner Davis Date: Tue, 26 Nov 2024 22:05:52 +0000 Subject: [PATCH 3/3] update version in readme --- windsurf-desktop/README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/windsurf-desktop/README.md b/windsurf-desktop/README.md index a31455c9..a602dd08 100644 --- a/windsurf-desktop/README.md +++ b/windsurf-desktop/README.md @@ -11,4 +11,25 @@ tags: [ide, windsurf, helper] Add a button to open any workspace with a single click in Windsurf IDE. -Uses the [Coder Remote Windsurf Extension](https://github.com/coder/windsurf-coder). +Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder). + +```tf +module "windsurf" { + source = "registry.coder.com/modules/windsurf/coder" + version = "1.0.19" + agent_id = coder_agent.example.id +} +``` + +## Examples + +### Open in a specific directory + +```tf +module "windsurf" { + source = "registry.coder.com/modules/windsurf/coder" + version = "1.0.19" + agent_id = coder_agent.example.id + folder = "/home/coder/project" +} +```