chore: fix for jetbrains gateway agent_id issue (#437)

## Description Fixes a regression added in #167 which implemented support for multiple agents by appending the agent id to the URI, however in a single agent environment it results in the agent id from the template apply (on upload to Coder from client) being injected, and when a workspace is later built using the template the agent id is no longer correct. Resolves the error `The workspace “<name>” does not have an agent with ID “<id>”` being thrown by Jetbrains Gateway app upon attempting to open a Jetbrains app from within a Coder workspace. When wishing to target a specific Coder Agent with the Jetbrains Gateway module one should use the `agent_name` variable in the module configuration to specify the desired agent name. This will append the agent name to the URI. ## Type of Change - [ ] New module - [x] Bug fix - [ ] Feature/enhancement - [ ] Documentation - [ ] Other ## Module Information **Path:** `registry/coder/modules/jetbrains-gateway` **New version:** `v1.2.4` **Breaking change:** [ ] Yes [x] No ## Testing & Validation - [x] Tests pass (`bun test`) - [x] Code formatted (`bun run fmt`) - [x] Changes tested locally ## Related Issues Reported by customer on Zendesk ticket 4391

Author: rowansmithau

registry/coder/modules/jetbrains-gateway/README.md

@@ -19,7 +19,7 @@ Consult the [JetBrains documentation](https://www.jetbrains.com/help/idea/prereq
 module "jetbrains_gateway" {
  count = data.coder_workspace.me.start_count
  source = "registry.coder.com/coder/jetbrains-gateway/coder"
- version = "1.2.3"
+ version = "1.2.4"
  agent_id = coder_agent.example.id
  folder = "/home/coder/example"
  jetbrains_ides = ["CL", "GO", "IU", "PY", "WS"]
@@ -37,7 +37,7 @@ module "jetbrains_gateway" {
 module "jetbrains_gateway" {
  count = data.coder_workspace.me.start_count
  source = "registry.coder.com/coder/jetbrains-gateway/coder"
- version = "1.2.3"
+ version = "1.2.4"
  agent_id = coder_agent.example.id
  folder = "/home/coder/example"
  jetbrains_ides = ["GO", "WS"]
@@ -51,7 +51,7 @@ module "jetbrains_gateway" {
 module "jetbrains_gateway" {
  count = data.coder_workspace.me.start_count
  source = "registry.coder.com/coder/jetbrains-gateway/coder"
- version = "1.2.3"
+ version = "1.2.4"
  agent_id = coder_agent.example.id
  folder = "/home/coder/example"
  jetbrains_ides = ["IU", "PY"]
@@ -66,7 +66,7 @@ module "jetbrains_gateway" {
 module "jetbrains_gateway" {
  count = data.coder_workspace.me.start_count
  source = "registry.coder.com/coder/jetbrains-gateway/coder"
- version = "1.2.3"
+ version = "1.2.4"
  agent_id = coder_agent.example.id
  folder = "/home/coder/example"
  jetbrains_ides = ["IU", "PY"]
@@ -91,7 +91,7 @@ module "jetbrains_gateway" {
 module "jetbrains_gateway" {
  count = data.coder_workspace.me.start_count
  source = "registry.coder.com/coder/jetbrains-gateway/coder"
- version = "1.2.3"
+ version = "1.2.4"
  agent_id = coder_agent.example.id
  folder = "/home/coder/example"
  jetbrains_ides = ["GO", "WS"]
@@ -109,7 +109,7 @@ Due to the highest priority of the `ide_download_link` parameter in the `(jetbra
 module "jetbrains_gateway" {
  count = data.coder_workspace.me.start_count
  source = "registry.coder.com/coder/jetbrains-gateway/coder"
- version = "1.2.3"
+ version = "1.2.4"
  agent_id = coder_agent.example.id
  folder = "/home/coder/example"
  jetbrains_ides = ["GO", "WS"]

registry/coder/modules/jetbrains-gateway/main.test.ts

@@ -20,7 +20,7 @@ describe("jetbrains-gateway", async () => {
  folder: "/home/coder",
  });
  expect(state.outputs.url.value).toBe(
- "jetbrains-gateway://connect#type=coder&workspace=default&owner=default&folder=/home/coder&url=https://mydeployment.coder.com&token=$SESSION_TOKEN&ide_product_code=IU&ide_build_number=243.21565.193&ide_download_link=https://download.jetbrains.com/idea/ideaIU-2024.3.tar.gz&agent_id=foo",
+ "jetbrains-gateway://connect#type=coder&workspace=default&owner=default&folder=/home/coder&url=https://mydeployment.coder.com&token=$SESSION_TOKEN&ide_product_code=IU&ide_build_number=243.21565.193&ide_download_link=https://download.jetbrains.com/idea/ideaIU-2024.3.tar.gz&agent=",
  );
 
  const coder_app = state.resources.find(
@@ -40,4 +40,28 @@ describe("jetbrains-gateway", async () => {
  });
  expect(state.outputs.identifier.value).toBe("IU");
  });
+
+ it("optionally includes agent when an agent name is provided", async () => {
+ const state = await runTerraformApply(import.meta.dir, {
+ agent_id: "foo",
+ agent_name: "main",
+ folder: "/home/coder",
+ });
+
+ expect(state.outputs.url.value).toBe(
+ "jetbrains-gateway://connect#type=coder&workspace=default&owner=default&folder=/home/coder&url=https://mydeployment.coder.com&token=$SESSION_TOKEN&ide_product_code=IU&ide_build_number=243.21565.193&ide_download_link=https://download.jetbrains.com/idea/ideaIU-2024.3.tar.gz&agent=main",
+ );
+ });
+
+ it("includes the agent parameter even when the provided value is blank", async () => {
+ const state = await runTerraformApply(import.meta.dir, {
+ agent_id: "foo",
+ agent_name: " ",
+ folder: "/home/coder",
+ });
+
+ expect(state.outputs.url.value).toBe(
+ "jetbrains-gateway://connect#type=coder&workspace=default&owner=default&folder=/home/coder&url=https://mydeployment.coder.com&token=$SESSION_TOKEN&ide_product_code=IU&ide_build_number=243.21565.193&ide_download_link=https://download.jetbrains.com/idea/ideaIU-2024.3.tar.gz&agent= ",
+ );
+ });
 });

registry/coder/modules/jetbrains-gateway/main.tf

@@ -36,9 +36,8 @@ variable "slug" {
 
 variable "agent_name" {
  type = string
- description = "Agent name. (unused). Will be removed in a future version"
-
- default = ""
+ description = "Agent name."
+ default = ""
 }
 
 variable "folder" {
@@ -348,8 +347,8 @@ resource "coder_app" "gateway" {
  local.build_number,
  "&ide_download_link=",
  local.download_link,
- "&agent_id=",
- var.agent_id,
+ "&agent=",
+ var.agent_name,
  ])
 }