refactor(web-client): refactor iron-remote-gui into iron-remote-desktop

[RRRadicalEdward]

This is the first part of the "Modularize the remote desktop WebComponent" ticket.
PR changes the web-client of the IronRDP:

• Renamed some of the structures on the Rust side
• Removed the iron-remote-gui package
• Added the iron-remote-desktop package with the TypeScript interfaces and exposed more interfaces from the WASM bindings
• Added iron-remote-desktop-rdp package which combines WASM bindings and the TypeScript interfaces from the iron-remote-desktop to create an iron-remote-desktop HTML tag which is responsible for the RDP connection.
• Updated xtask

Although GitHub says that there are 5K changes, most of the things are just file moves/renaming from iron-remote-gui to iron-remote-desktop and iron-remote-desktop-rdp. It doesn't seem to be able to diff it properly.

[CBenoit]

I think you are aware of this yourself as far as I can see in your own comments, but this is not really what I imagined when I talked about dependency injection.

To clarify: the new iron-remote-desktop package should contain ALL the logic that is found in the previous iron-remote-gui package.
The iron-remote-desktop-rdp package should only re-export the WASM module API, and nothing more. No additional logic. (Mostly? It’s fine to have a few helpers in addition to the rest.)
The architectural invariant is that these packages do not contain any common logic, and no code is duplicated.

I’m not very good at JavaScript/TypeScript, so let me illustrate what I mean using Rust:

// -- iron-remote-desktop --
// Implements all the backend-agnostic logic, based on a given "remote desktop interface".

trait RemoteDesktopApi {
    fn remote_desktop_init(&self);
}

fn run(api: Box<dyn RemoteDesktopApi>) {
    // The logic is calling the remote desktop API, and does not know whether this is RDP or VNC.
    api.remote_desktop_init();
}

// -- ironrdp-web --
// This is what actually implements the interface.
// But TypeScript is kind of working in a duck-typed way,
// so unlike Rust you don’t need to import the interface definition in order to implement it!

pub struct Api;

impl RemoteDesktopApi for Api {
    fn remote_desktop_init(&self) {
        // do stuff
    }
}

// -- iron-remote-desktop-rdp --
// The purpose is to inline the WASM module in base64,
// but essentially, it exposes the exact same things as ironrdp-web.

pub use ironrdp_web::Api;

// -- iron-svelte-client --
// Injects the dependency (IronRDP) into the web component (iron-remote-desktop), and uses it.
// It knows that its IronRDP behind the scenes, and may inject additional extensions (future improvement).

iron_remote_desktop::run(Box::new(iron_remote_desktop_rdp::Api));

Because of the way JavaScript/TypeScript works, we don’t need iron-remote-desktop-rdp to know about the interface defined in iron-remote-desktop.

Keep in mind that I’m only trying to illustrate what I meant for dependency injection. I do not ask you to modify drastically any Rust code (ideally ironrdp-web should stay the way it is, and there is no issue with the way you updated it in this PR.)
It’s not possible to directly translate this Rust code into TypeScript, and you will likely not define a "TypeScript interface" for the module itself.
My understanding is that when building ironrdp_web using wasmpack, we get a module exporting a few items such as SessionBuilder. SessionBuilder in turns implements a specific "typescript interface" (as defined in the Slack canvas).

My expectation is that iron-remote-desktop-rdp should basically end up being this:

export * as default from './path/to/wasm/module'

= Re-export the whole interface of the WASM module.

You can then import this module in iron-svelte-client, and inject it into the iron-remote-desktop component.

import * as rdp from '@devolutions/iron-remote-desktop-rdp'

// I think we have something called "userInteraction" somewhere?
// Use it to inject the module ("dependency").
userInteraction.setBackend(rdp);

// Or maybe it’s `userInteractionService` which wraps the `userInteraction`?
// Try to look for the `onMount` function.
// We retrieve the `userInteraction` (`event.detail.irgUserInteraction`) and
// store it in a `writeable` that is accessible globally.

(Also refer to this section.)

If you hit a problem, let me know in Slack so we can think through this together. I never implemented such a thing myself, so I don’t know all the problems you may encounter beforehand in details, but I have a solid idea of what it should looks like.

[RRRadicalEdward]

#722 (comment)

Let's clarify: iron-remote-desktop-rdp has to re-export WASM and provide extension types. The next step is to modify the UserInteraction to accept the "backend" which will be either RDP or VNC and implements an interface (I have really missed the fact that JS/TS has a duck types). The next step should be the refactoring of the connect function into a builder (or I will leave it to a follow-up PR if there won't be a direct need in it right now).

[CBenoit]

#722 (comment)

Let's clarify: iron-remote-desktop-rdp has to re-export WASM and provide extension types. The next step is to modify the UserInteraction to accept the "backend" which will be either RDP or VNC and implements an interface (I have really missed the fact that JS/TS has a duck types). The next step should be the refactoring of the connect function into a builder (or I will leave it to a follow-up PR if there won't be a direct need in it right now).

Exactly!
For this PR, really focus on the core architectural refactoring.
Anything that can be a follow up should be a follow up 🙂

[github-actions]

Coverage Report 🤖 ⚙️

Past:
Total lines: 30423
Covered lines: 19493 (64.07%)

New:
Total lines: 30423
Covered lines: 19493 (64.07%)

Diff: +0.00%

[this comment will be updated automatically]

[CBenoit]

Really good work so far. Remaining comments are "minor" 🙂
That was a big refactoring, but we are almost done!

[CBenoit]

Summing up.

Remaining questions to address before merging:

• refactor(web-client): refactor iron-remote-gui into iron-remote-desktop #722 (comment)
• refactor(web-client): refactor iron-remote-gui into iron-remote-desktop #722 (comment)
• refactor(web-client): refactor iron-remote-gui into iron-remote-desktop #722 (comment)

Suggestions to address in follow up PRs:

• refactor(web-client): refactor iron-remote-gui into iron-remote-desktop #722 (comment)
• refactor(web-client): refactor iron-remote-gui into iron-remote-desktop #722 (comment)

[CBenoit]

LGTM! Excellent work. Let’s follow up with small incremental changes in separate PRs 🙂