Skip to content

Commit 4688e4c

Browse files
blinkagent[bot]blink-so[bot]DevelopmentCats
authored
fix(filebrowser): require agent_name when subdomain is false (#877)
## Description Fixes [REG-4](https://linear.app/codercom/issue/REG-4/filebrowser-appends-workspace-path-twice-in-url): the `filebrowser` module opens to a non-existent URL with the workspace path appended a second time when `subdomain = false` and `agent_name` is not provided, e.g.: ``` https://<coder-host>/@<owner>/<workspace>/apps/filebrowser/files/@<owner>/<workspace>.<agent>/apps/filebrowser/ ``` ### Root cause Coder's frontend always builds path-based app URLs as `/@<owner>/<workspace>.<agent>/apps/<slug>/` (it always includes `.<agent_name>`, even for single-agent templates): https://github.com/coder/coder/blob/main/site/src/modules/apps/apps.ts ```ts return `${path}/@${workspace.owner_name}/${workspace.name}.${agent.name}/apps/${app.slug}/`; ``` The filebrowser module, however, only includes the agent segment in `local.server_base_path` (which becomes filebrowser's `--baseURL`) when the user explicitly passes `agent_name`. The variable description and the README both said `agent_name` was "only required if the template uses multiple agents", which is incorrect. When the URLs disagree, filebrowser's reverse-proxy `stripPrefix` cannot strip the prefix, the path falls through filebrowser's `/:catchAll(.*)*` Vue route, and the router redirects to `/files/${catchAll}` — producing the duplicated path the user reported. ### Fix - Add a `lifecycle.precondition` on `coder_script.filebrowser` that fails `terraform apply` with a clear, actionable error when `subdomain = false` and `agent_name == null`. - Update the `agent_name` variable description to state it is required whenever `subdomain` is `false`. - Update the `README.md` example for the path-based config to call out the requirement explicitly. - Bump the module version from `1.1.4` → `1.1.5`. - Add a TS test covering the new precondition. This avoids the silent misconfiguration that produces the duplicated URL, without breaking anyone whose existing template already sets `agent_name` (or uses `subdomain = true`). ## Type of Change - [ ] New module - [ ] New template - [x] Bug fix - [ ] Feature/enhancement - [ ] Documentation - [ ] Other ## Module Information **Path:** `registry/coder/modules/filebrowser` **New version:** `v1.1.5` **Breaking change:** [ ] Yes [x] No ## Testing & Validation - [x] `bun test main.test.ts` — 8 pass, 0 fail (includes new precondition test) - [x] `terraform fmt -recursive` - [x] `terraform validate` - [x] `bun x prettier --check` - [x] Manually verified the precondition fires with a minimal repro and passes when `agent_name` is supplied or `subdomain = true`. ## Related Issues - Linear: [REG-4](https://linear.app/codercom/issue/REG-4/filebrowser-appends-workspace-path-twice-in-url) --- Created on behalf of @matifali. Generated with Blink. Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com> Co-authored-by: DevCats <christofer@coder.com>
1 parent 4d96be0 commit 4688e4c

3 files changed

Lines changed: 29 additions & 5 deletions

File tree

registry/coder/modules/filebrowser/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A file browser for your workspace.
1414
module "filebrowser" {
1515
count = data.coder_workspace.me.start_count
1616
source = "registry.coder.com/coder/filebrowser/coder"
17-
version = "1.1.4"
17+
version = "1.1.5"
1818
agent_id = coder_agent.main.id
1919
}
2020
```
@@ -29,7 +29,7 @@ module "filebrowser" {
2929
module "filebrowser" {
3030
count = data.coder_workspace.me.start_count
3131
source = "registry.coder.com/coder/filebrowser/coder"
32-
version = "1.1.4"
32+
version = "1.1.5"
3333
agent_id = coder_agent.main.id
3434
folder = "/home/coder/project"
3535
}
@@ -41,19 +41,21 @@ module "filebrowser" {
4141
module "filebrowser" {
4242
count = data.coder_workspace.me.start_count
4343
source = "registry.coder.com/coder/filebrowser/coder"
44-
version = "1.1.4"
44+
version = "1.1.5"
4545
agent_id = coder_agent.main.id
4646
database_path = ".config/filebrowser.db"
4747
}
4848
```
4949

5050
### Serve from the same domain (no subdomain)
5151

52+
When `subdomain = false`, you must also set `agent_name` to the name of your `coder_agent` resource. Coder serves path-based apps at `/@<owner>/<workspace>.<agent>/apps/<slug>/`, so the agent name is required to build a base URL that matches the URL the user is actually browsing. If `agent_name` is omitted in this mode, `terraform apply` will fail with an explanatory error.
53+
5254
```tf
5355
module "filebrowser" {
5456
count = data.coder_workspace.me.start_count
5557
source = "registry.coder.com/coder/filebrowser/coder"
56-
version = "1.1.4"
58+
version = "1.1.5"
5759
agent_id = coder_agent.main.id
5860
agent_name = "main"
5961
subdomain = false

registry/coder/modules/filebrowser/main.test.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,19 @@ describe("filebrowser", async () => {
102102

103103
testBaseLine(output);
104104
}, 15000);
105+
106+
it("fails when subdomain=false and agent_name is not provided", async () => {
107+
let caught: Error | undefined;
108+
try {
109+
await runTerraformApply(import.meta.dir, {
110+
agent_id: "foo",
111+
subdomain: false,
112+
});
113+
} catch (e) {
114+
caught = e as Error;
115+
}
116+
expect(caught).toBeDefined();
117+
expect(caught!.message).toContain("agent_name");
118+
expect(caught!.message).toContain("subdomain");
119+
}, 15000);
105120
});

registry/coder/modules/filebrowser/main.tf

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ data "coder_workspace_owner" "me" {}
2020

2121
variable "agent_name" {
2222
type = string
23-
description = "The name of the coder_agent resource. (Only required if subdomain is false and the template uses multiple agents.)"
23+
description = "The name of the coder_agent resource. Required when `subdomain` is `false` so the path-based base URL matches the URL Coder serves."
2424
default = null
2525
}
2626

@@ -102,6 +102,13 @@ resource "coder_script" "filebrowser" {
102102
SERVER_BASE_PATH : local.server_base_path
103103
})
104104
run_on_start = true
105+
106+
lifecycle {
107+
precondition {
108+
condition = var.subdomain || var.agent_name != null
109+
error_message = "`agent_name` is required when `subdomain` is `false`. Coder always builds path-based app URLs as `/@<owner>/<workspace>.<agent>/apps/<slug>/`, so the filebrowser base URL must include the agent name to match. Set `agent_name = \"<your coder_agent name>\"` (e.g. `\"main\"`)."
110+
}
111+
}
105112
}
106113

107114
resource "coder_app" "filebrowser" {

0 commit comments

Comments
 (0)