feat: add module for Web RDP #262

Parkreiner · 2024-06-26T14:39:15Z

Closes #234

Changes made

Added Terraform module file for adding Web RDP support to any Coder workspace running on Google Cloud or AWS (Azure support to come later)
Added JavaScript patch file for taking the base Devolutions Gateway app, and updating it to have a better user flow when launched from Coder
Added tests, and updated some of the test helpers to make testing a little bit easier

Notes

The solution leverages the Devolutions Angular app. Devolutions does allow you to define a custom web UI to serve things, but Angular has enough of a learning curve that we decided to patch around it instead of figuring out how to rewrite to React

Co-authored-by: Asher <ash@coder.com>

Parkreiner · 2024-06-28T18:50:53Z

test.ts

+/**
+ * Finds the only "coder_script" resource in the given state and runs it in a
+ * container.
+ */


Updated the comment formatting so that these would be public, and would show up when someone hovers over the function definition

TIL: /** are public comments and // are private 🤦

Parkreiner · 2024-06-28T18:51:46Z

test.ts

-  ];
+  };
+
+  resources: [TerraformStateResource, ...TerraformStateResource[]];


Redefined this so that resources is an array with at least element, rather than an array with exactly one element. This typo was causing some of the other tests to do stuff with the any type; I'll be making a separate PR to clean up more stuff

Parkreiner · 2024-06-28T18:52:44Z

test.ts

+ * Creates a test-case for each variable provided and ensures that the apply
+ * fails without it.
+ */
+export const testRequiredVariables = <TVars extends Record<string, string>>(


Added a type parameter so that you can define what properties you expect to be valid for the function, so that you can more easily catch accidental typos

johnstcn

LGTM 👍 smoke-tested

windows-rdp/main.test.ts

johnstcn · 2024-06-28T20:05:21Z

windows-rdp/main.test.ts

+     * don't overshoot and grab too much content.
+     *
+     * Written and tested via Regex101
+     * @see {@link https://regex101.com/r/UMgQpv/2}


windows-rdp/main.tf

BrunoQuaresma

The JS code looks good, but since I don't have extensive context on this, I'm unsure if I'm the right person to approve it. Also, how should we conduct QA for this PR?

Edit: I was able to partially QA it, and it seems fine. It would be helpful to have instructions in the description on how to QA this feature.

Parkreiner · 2024-07-01T13:36:59Z

@BrunoQuaresma So, since it's a module, there's kind of two main ways to do it:

You can make a new Coder template, and bring the module in with code like this:

module "windows_rdp" {
  count = data.coder_workspace.me.start_count
  source = "github.com/coder/modules//windows-rdp?ref=web-rdp"
  agent_id = resource.coder_agent.main.id
  resource_id = resource.google_compute_instance.dev[0].id
}

Or you can spin up one of the templates we made when writing this out, and that's already pre-wired, like this one:
1. Create a new workspace from the template
2. Wait for the workspace to be created (it takes a little bit longer than usual)
3. Click the "Web RDP" button
4. Verify that:
  1. The user is automatically logged in (and ideally never sees a login form because it gets filled out so quickly)
  2. There is no sidebar (this is in Devolutions by default, but should be removed via the patch)
  3. When clicking the "Close Session" button at the top, the form is there and isn't invisible anymore

Edit: The above is for Google Cloud. We also have an AWS template.

windows-rdp/README.md

matifali · 2024-07-02T05:48:44Z

windows-rdp/main.tf

+  slug         = "web-rdp"
+  display_name = "Web RDP"
+  url          = "http://localhost:7171"
+  icon         = "https://svgur.com/i/158F.svg"


Icon path needs to be updated.

windows-rdp/main.tf

matifali · 2024-07-02T05:51:11Z

windows-rdp/main.tf

+  agent_id     = var.agent_id
+  display_name = "Local RDP"
+  slug         = "rdp-docs"
+  icon         = "https://raw.githubusercontent.com/matifali/logos/main/windows.svg"


icon needs to be added to coder icons

matifali · 2024-07-02T05:53:25Z

windows-rdp/powershell-installation-script.tftpl

+function Install-DevolutionsGateway {
+# Define the module name and version
+$moduleName = "DevolutionsGateway"
+$moduleVersion = "2024.1.5"


should the version be exposed as a variable to allow users to easily upgrade/downgrade Devolutions gateway? Its fine as it is too if we like to tightly control it ourselves to preserver compatibility and ensure everything works as tested.

Yeah, just because the DOM selectors in the JavaScript code are so specific, it felt really important to pin Devolutions Gateway to a specific version, to avoid breaking changes as the Devolutions team refactors their own UI

It would be nice to expose it as a mutable value, but I feel like it might be asking for trouble, and could cause things to break unexpectedly

matifali · 2024-07-02T15:29:45Z

@Parkreiner you can merge the PR and then we can cut a release which should make it available on registry.coder.com
cc @stirby

bpmct and others added 30 commits April 6, 2024 19:48

feat: add web RDP module

c5c521f

fix port typo

1197e6b

add metadata and local instructions

12fd16f

fix agent id

bf06e8d

remove count

0e7644b

rename script

9f8eee5

remove metadata for now

ec922c7

add temp link to example template

748a180

add thumbnail

ac648cc

fix module usage

8913567

add tags

7de78d2

add more context on auto login

53083a5

chore: add admin username

b93471a

chore: add script file for overriding Devolutions

20795aa

wip: commit current progress for devolutions patch

ff96b3f

fix: update script frequency

aab5e55

fix: update typo in powershell script

29209d5

Co-authored-by: Asher <ash@coder.com>

fix: add parenthesis

452f41a

fix: dolla dolla

c7aa825

fix: dolla dolla

047ccd6

fix: more money, more problems

d530d68

fix: escape quotes

0b6975c

fix: whitespace

14e3fc5

fix: remove regex search from Select-String

fba0f84

fix: remove template literal dollar signs

d5cfadb

wip: add current code for hiding Devolutions form

8195cf4

refactor: clean up form code

652fc6b

fix: update HTML query selector

7022711

docs: remove now-inaccurate comment

5ec1b20

fix: update instanceof check

c7a4fce

Parkreiner requested review from johnstcn and BrunoQuaresma June 28, 2024 18:46

Parkreiner commented Jun 28, 2024

View reviewed changes

Parkreiner marked this pull request as ready for review June 28, 2024 18:57

johnstcn approved these changes Jun 28, 2024

View reviewed changes

fix: update null check and remove typo

ec2c8ed

BrunoQuaresma approved these changes Jul 1, 2024

View reviewed changes

Parkreiner added 11 commits July 1, 2024 13:57

Merge branch 'main' into web-rdp

7a8483d

fix: update README for RDP

d9d1be0

fix: update structure of README for linter

a381c3e

chore: add new video to README

c59eb0c

fix: remove commented-out code

fd2f91c

Merge branch 'web-rdp' of github.com:coder/modules into web-rdp

13a8877

refactor: split off Windows script logic into separate file

b4153a6

fix: update TF import

49f0605

fix: update object definition for top-level templatefile

a8580fe

refactor: try extracting main script into separate template file

b23d853

refactor: clean up final code

3f8f618

matifali reviewed Jul 2, 2024

View reviewed changes

Parkreiner added 3 commits July 2, 2024 15:19

fix: add verison number to rdp script

894e507

fix: add versioning to all code snippets

d98bfcb

fix: update docs link

aebdc9b

fix: update URL for RDP icon

e8ee02c

Parkreiner merged commit 8fd54e0 into main Jul 2, 2024
2 checks passed

Parkreiner mentioned this pull request Jul 2, 2024

fix: update SVG icon URL for RDP module #264

Merged

Parkreiner deleted the web-rdp branch July 10, 2024 22:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add module for Web RDP #262

feat: add module for Web RDP #262

Parkreiner commented Jun 26, 2024 •

edited

Loading

Parkreiner Jun 28, 2024

BrunoQuaresma Jun 28, 2024

Parkreiner Jun 28, 2024

Parkreiner Jun 28, 2024

johnstcn left a comment

johnstcn Jun 28, 2024

BrunoQuaresma left a comment •

edited

Loading

Parkreiner commented Jul 1, 2024 •

edited

Loading

matifali Jul 2, 2024

matifali Jul 2, 2024

matifali Jul 2, 2024

Parkreiner Jul 2, 2024

matifali commented Jul 2, 2024 •

edited

Loading

feat: add module for Web RDP #262

feat: add module for Web RDP #262

Conversation

Parkreiner commented Jun 26, 2024 • edited Loading

Changes made

Notes

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

johnstcn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BrunoQuaresma left a comment • edited Loading

Choose a reason for hiding this comment

Parkreiner commented Jul 1, 2024 • 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

matifali commented Jul 2, 2024 • edited Loading

Parkreiner commented Jun 26, 2024 •

edited

Loading

BrunoQuaresma left a comment •

edited

Loading

Parkreiner commented Jul 1, 2024 •

edited

Loading

matifali commented Jul 2, 2024 •

edited

Loading