rework to use agent name

Author: rowansmithau

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

@@ -43,6 +43,43 @@ module "jetbrains_gateway" {
 }
 ```
 
+### Embed the agent name in the Gateway URL
+
+This can be used when support for connecting to multiple agents within one workspace is required.
+
+To utilise this both `embed_agent_id` and `agent_name` must be populated on each instance of the module.
+In addition each instance must have a unique `slug` and `ide_parameter_name` variable defined.
+
+```tf
+module "jetbrains_gateway" {
+  count              = data.coder_workspace.me.start_count
+  source             = "registry.coder.com/coder/jetbrains-gateway/coder"
+  version            = "1.2.3"
+  agent_id           = coder_agent.example.id
+  folder             = "/home/coder/example"
+  jetbrains_ides     = ["CL", "GO"]
+  default            = "GO"
+  embed_agent_id     = true
+  agent_name         = "main"
+  ide_parameter_name = "jetbrains_ide" # default variable value
+  slug               = "gateway"       # default variable value
+}
+
+module "jetbrains_gateway_agent2" {
+  count              = data.coder_workspace.me.start_count
+  source             = "registry.coder.com/coder/jetbrains-gateway/coder"
+  version            = "1.2.3"
+  agent_id           = coder_agent.jetbrainsagent2.id
+  folder             = "/home/coder/example"
+  jetbrains_ides     = ["CL", "GO", "IU", "PY", "WS"]
+  default            = "GO"
+  embed_agent_id     = true
+  agent_name         = "jetbrainsagent2"
+  ide_parameter_name = "jetbrains_ide_agent2"
+  slug               = "gateway-agent2"
+}
+```
+
 ### Use the latest version of each IDE
 
 ```tf

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

@@ -40,15 +40,17 @@ describe("jetbrains-gateway", async () => {
     });
     expect(state.outputs.identifier.value).toBe("IU");
   });
-});
-it("optionally includes agent_id when embed_agent_id is true", async () => {
-  const state = await runTerraformApply(import.meta.dir, {
-    agent_id: "foo",
-    folder: "/home/coder",
-    embed_agent_id: true,
-  });
 
-  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",
-  );
+  it("optionally includes agent when embed_agent_id is true", async () => {
+    const state = await runTerraformApply(import.meta.dir, {
+      agent_id: "foo",
+      agent_name: "main",
+      folder: "/home/coder",
+      embed_agent_id: true,
+    });
+
+    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",
+    );
+  });
 });

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

@@ -70,10 +70,16 @@ variable "group" {
 
 variable "embed_agent_id" {
   type        = bool
-  description = "Append the agent_id to the JetBrains Gateway URL for when support for multiple agents is required."
+  description = "Embed the agent name in the JetBrains Gateway URL when support for multiple agents is required."
   default     = false
 }
 
+variable "ide_parameter_name" {
+  type        = string
+  description = "Terraform parameter name for the JetBrains IDE selector. Must be unique per module instance."
+  default     = "jetbrains_ide"
+}
+
 variable "coder_parameter_order" {
   type        = number
   description = "The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order)."
@@ -309,7 +315,7 @@ locals {
 
 data "coder_parameter" "jetbrains_ide" {
   type         = "string"
-  name         = "jetbrains_ide"
+  name         = var.ide_parameter_name
   display_name = "JetBrains IDE"
   icon         = "/icon/gateway.svg"
   mutable      = true
@@ -354,7 +360,7 @@ resource "coder_app" "gateway" {
     local.build_number,
     "&ide_download_link=",
     local.download_link,
-  ], var.embed_agent_id && trimspace(var.agent_id) != "" ? ["&agent_id=", var.agent_id] : []))
+  ], var.embed_agent_id && trimspace(var.agent_name) != "" ? ["&agent=", var.agent_name] : []))
 }
 
 output "identifier" {