feat: Add workspace application support #1773

kylecarbs · 2022-05-26T03:17:18Z

This adds applications as a property to a workspace agent.

The resource is added to the Terraform provider here:
coder/terraform-provider-coder#17

Apps will be opened in the dashboard or via the CLI
with coder open <name>. If command is specified, a
terminal will appear locally and on the web. If target
is specified, the browser will open to an exposed instance
of that target.

Fix odd context cancel bug on HTTP transport.

This adds apps as a property to a workspace agent. The resource is added to the Terraform provider here: coder/terraform-provider-coder#17 Apps will be opened in the dashboard or via the CLI with `coder open <name>`. If `command` is specified, a terminal will appear locally and in the web. If `target` is specified, the browser will open to an exposed instance of that target.

Abstracting coderd into an interface added misdirection because the interface was never intended to be fulfilled outside of a single implementation. This lifts the abstraction, and attaches all handlers to a root struct named `*coderd.API`.

f0ssel · 2022-05-26T18:55:42Z

coderd/database/migrations/000014_workspace_apps.up.sql

+CREATE TABLE workspace_apps (
+    id uuid NOT NULL,
+    created_at timestamp with time zone NOT NULL,
+    agent_id uuid NOT NULL REFERENCES workspace_agents (id) ON DELETE CASCADE,


I am unfamiliar with the schemas around agents, builds, templates, etc. I would expect this to be in lifecycle with the template version I think. Why is it related to the agent?

Workspace agents are attached to a template version too.

A workspace build can contain different agents than a template version based on variables. This introduces complexity for us, but is something we unfortunately need to account for.

This is such an intermittent race it's difficult to track, but regardless this is an improvement to the code.

spikecurtis · 2022-06-01T16:42:53Z

provisionersdk/proto/provisioner.proto

    oneof auth {
-        string token = 8;
-        string instance_id = 9;
+        string token = 9;


generally a no-no to change field indexes. Any reason it's particularly important here?

It's nicer structurally from my perspective.

spikecurtis · 2022-06-01T16:52:51Z

provisionersdk/proto/provisioner.proto

+message App {
+    string name = 1;
+    string command = 2;
+    string url = 3;


in the terraform provider docs you say command or url but not both can be set. Should these be in a oneof?

Good catch.

coderd/coderd.go

coderd/wsconncache/wsconncache.go

spikecurtis · 2022-06-01T20:33:27Z

At a high level, I also find it a bit strange that we're having coderd negotiate a WebRTC connection to the agent, when the agent is already connected to coderd via the channel that the ICE negotiation is happening over.

spikecurtis · 2022-06-01T20:34:48Z

Also missing from this (Ok if being tracked in other issues)

Authorization checks
Support for command apps (I'm only seeing URLs supported)

greyscaled · 2022-06-03T14:28:25Z

coderd/coderd.go

+	// %40 is the encoded character of the @ symbol. VS Code Web does
+	// not handle character encoding properly, so it's safe to assume
+	// other applications might not as well.
+	r.Route("/%40{user}/{workspacename}/apps/{workspaceapp}", apps)


Does this mean the FE should use encodeURIComponent ?

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent

so like

async (username: string, workspaceName: string, app: string) => { encoderURIComponent(`/api/v0/@{username}/{workspaceName}/apps/{app}`) }

Nah, we should always use @ if possible. This is an edge-case for where certain client-side applications don't handle the @ properly.

coderd/coderd.go

presleyp · 2022-06-03T14:32:42Z

site/site.go

+// metadata in error pages.
+func WithAPIResponse(ctx context.Context, apiResponse APIResponse) context.Context {
+	return context.WithValue(ctx, apiResponseContextKey{}, apiResponse)
+}


Is this dev url specific or is it related to the error message discussion from yesterday?

Specific to this. The content can be changed trivially too, I intentionally kept it pretty loose while we hash that out.

presleyp · 2022-06-03T14:33:54Z

site/src/api/typesGenerated.ts

+export interface WorkspaceApp {
+  readonly id: string
+  readonly name: string
+  readonly command?: string


what is command?

It will open a command inside of a terminal. I'll be opening a subsequent PR to add this in. An issue to track it is here: #2023

greyscaled

FE = ✔️

f0ssel

Generally everything looks good to me. A little long so I didn't dive in super hard but the tests seem to cover enough bases to give me confidence.

f0ssel · 2022-06-03T16:46:30Z

coderd/rbac/README.md

@@ -51,7 +51,7 @@ This can be represented by the following truth table, where Y represents *positi

 ## Example Permissions

- `+site.*.*.read`: allowed to perform the `read` action against all objects of type `devurl` in a given Coder deployment.


kill it with 🔥

f0ssel · 2022-06-03T16:51:47Z

site/src/api/typesGenerated.ts

+  readonly name: string
+  readonly command?: string
+  readonly access_url?: string
+  readonly icon: string


Is icon required? I think we should have some fallback on the frontend and make it optional in terraform if it isn't already.

True. I shall fix

* feat: Add app support This adds apps as a property to a workspace agent. The resource is added to the Terraform provider here: coder/terraform-provider-coder#17 Apps will be opened in the dashboard or via the CLI with `coder open <name>`. If `command` is specified, a terminal will appear locally and in the web. If `target` is specified, the browser will open to an exposed instance of that target. * Compare fields in apps test * Update Terraform provider to use relative path * Add some basic structure for routing * chore: Remove interface from coderd and lift API surface Abstracting coderd into an interface added misdirection because the interface was never intended to be fulfilled outside of a single implementation. This lifts the abstraction, and attaches all handlers to a root struct named `*coderd.API`. * Add basic proxy logic * Add proxying based on path * Add app proxying for wildcards * Add wsconncache * fix: Race when writing to a closed pipe This is such an intermittent race it's difficult to track, but regardless this is an improvement to the code. * fix: Race when writing to a closed pipe This is such an intermittent race it's difficult to track, but regardless this is an improvement to the code. * fix: Race when writing to a closed pipe This is such an intermittent race it's difficult to track, but regardless this is an improvement to the code. * fix: Race when writing to a closed pipe This is such an intermittent race it's difficult to track, but regardless this is an improvement to the code. * Add workspace route proxying endpoint - Makes the workspace conn cache concurrency-safe - Reduces unnecessary open checks in `peer.Channel` - Fixes the use of a temporary context when dialing a workspace agent * Add embed errors * chore: Refactor site to improve testing It was difficult to develop this package due to the embed build tag being mandatory on the tests. The logic to test doesn't require any embedded files. * Add test for error handler * Remove unused access url * Add RBAC tests * Fix dial agent syntax * Fix linting errors * Fix gen * Fix icon required * Adjust migration number * Fix proxy error status code * Fix empty db lookup

kylecarbs added 9 commits May 6, 2022 18:31

Merge branch 'main' into devurls

8b2f6c4

Merge branch 'main' into devurls

e3cf488

Compare fields in apps test

e3ff8ad

Update Terraform provider to use relative path

b6e1ea6

Add some basic structure for routing

430cfe7

Merge branch 'routeclean' into devurls

f70dd17

Merge branch 'main' into devurls

0805250

kylecarbs self-assigned this May 26, 2022

Add basic proxy logic

934b1ff

f0ssel reviewed May 26, 2022

View reviewed changes

kylecarbs added 3 commits May 27, 2022 13:29

Add proxying based on path

866eeed

Merge branch 'main' into apps

4b73034

Add app proxying for wildcards

b4f9615

kylecarbs linked an issue May 31, 2022 that may be closed by this pull request

Workspace apps support #257

Closed

3 tasks

kylecarbs added 7 commits May 31, 2022 14:33

Add wsconncache

c88df46

fix: Race when writing to a closed pipe

d327df7

This is such an intermittent race it's difficult to track, but regardless this is an improvement to the code.

Merge branch 'readclose' into apps

f84f5ea

fix: Race when writing to a closed pipe

cec2de3

This is such an intermittent race it's difficult to track, but regardless this is an improvement to the code.

Merge branch 'readclose' into apps

c57f8dd

fix: Race when writing to a closed pipe

8e61cac

This is such an intermittent race it's difficult to track, but regardless this is an improvement to the code.

Merge branch 'readclose' into apps

b6e6d7b

kylecarbs force-pushed the apps branch from 602e725 to b6e6d7b Compare May 31, 2022 15:53

kylecarbs added 2 commits June 1, 2022 02:50

fix: Race when writing to a closed pipe

46b24f7

This is such an intermittent race it's difficult to track, but regardless this is an improvement to the code.

Merge branch 'readclose' into apps

4d8b257

kylecarbs force-pushed the apps branch from c0f7b32 to 4d8b257 Compare June 1, 2022 03:07

spikecurtis reviewed Jun 1, 2022

View reviewed changes

kylecarbs force-pushed the apps branch from 30289cb to 0a63bec Compare June 3, 2022 04:28

kylecarbs added 3 commits June 3, 2022 04:42

Remove unused access url

d3b9ab5

Add RBAC tests

7a1ae15

Merge branch 'main' into apps

5b9194f

kylecarbs marked this pull request as ready for review June 3, 2022 05:11

kylecarbs requested a review from a team as a code owner June 3, 2022 05:11

Merge branch 'main' into apps

cd2d12e

greyscaled reviewed Jun 3, 2022

View reviewed changes

coderd/coderd.go Show resolved Hide resolved

presleyp reviewed Jun 3, 2022

View reviewed changes

greyscaled reviewed Jun 3, 2022

View reviewed changes

kylecarbs added 3 commits June 3, 2022 15:58

Fix dial agent syntax

b056400

Merge branch 'main' into apps

fe3aecc

Fix linting errors

2018cdc

f0ssel approved these changes Jun 3, 2022

View reviewed changes

kylecarbs added 5 commits June 3, 2022 16:55

Fix gen

2d5261f

Fix icon required

856f17d

Merge branch 'main' into apps

1a21f94

Adjust migration number

ad90bcb

Fix proxy error status code

38abbb5

kylecarbs force-pushed the apps branch from ca2d449 to 38abbb5 Compare June 4, 2022 17:55

kylecarbs added 2 commits June 4, 2022 18:06

Fix empty db lookup

4f89642

Merge branch 'main' into apps

637be3e

kylecarbs force-pushed the apps branch from 0d2989e to 637be3e Compare June 4, 2022 18:08

Merge branch 'main' into apps

50da4fb

kylecarbs merged commit 013f028 into main Jun 4, 2022

kylecarbs deleted the apps branch June 4, 2022 20:13

kylecarbs mentioned this pull request Jun 16, 2022

feat: port forwarding dropdown #1824

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add workspace application support #1773

feat: Add workspace application support #1773

kylecarbs commented May 26, 2022 •

edited

Loading

f0ssel May 26, 2022

kylecarbs May 27, 2022

spikecurtis Jun 1, 2022

kylecarbs Jun 3, 2022

spikecurtis Jun 1, 2022

kylecarbs Jun 2, 2022

spikecurtis commented Jun 1, 2022

spikecurtis commented Jun 1, 2022

greyscaled Jun 3, 2022 •

edited

Loading

kylecarbs Jun 3, 2022

greyscaled Jun 3, 2022

presleyp Jun 3, 2022

kylecarbs Jun 3, 2022

presleyp Jun 3, 2022

kylecarbs Jun 3, 2022

greyscaled left a comment

f0ssel left a comment

f0ssel Jun 3, 2022

f0ssel Jun 3, 2022

kylecarbs Jun 3, 2022

		@@ -51,7 +51,7 @@ This can be represented by the following truth table, where Y represents *positi

		## Example Permissions

		- `+site...read`: allowed to perform the `read` action against all objects of type `devurl` in a given Coder deployment.

feat: Add workspace application support #1773

feat: Add workspace application support #1773

Conversation

kylecarbs commented May 26, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spikecurtis commented Jun 1, 2022

spikecurtis commented Jun 1, 2022

greyscaled Jun 3, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greyscaled left a comment

Choose a reason for hiding this comment

f0ssel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kylecarbs commented May 26, 2022 •

edited

Loading

greyscaled Jun 3, 2022 •

edited

Loading