Xterm NgRx and HTTP binding

[hadrien-toma]

Enhancement

Metadata

key	value
name	xterm-ngrx-and-http-binding

Description

As a system user/owner, I want to be able to open a terminal communicating with the devices through HTTP and I want to have this communication traced in a state in order to be able to trouble shoot any issues.

As a developer I want to have a generic component that I will be able to import and configure in several routes.

Implementation ideas

Here is the route to instanciate a terminal: libs/apps/embedded-device-manager/routes/routes/terminal/route

Interfaces

export interface NgTerminalState {
    configuration: {
                // all inputs of [ng-terminal component](https://github.com/qwefgh90/ng-terminal/blob/master/projects/ng-terminal/src/lib/ng-terminal.component.ts)
    },
    api: {
        // cf  libs/apps/embedded-device-manager/routes/route/src/lib/reducers/lang-menu-list/api/get.reducer.ts
    },
    events: {
        keyEventInput: 
	    historySize: number;
	    list: {
		key: string;
		keyCode: number;
	    }[];
        },
        keyInput: 
	    historySize: number;
	    list: {
		//useful params of keyInput's events
	    }[];
        },
    }
}
export interface State {
    [ngTerminalId: string]: NgTerminalState;
}

NgRx flow

• see TODOs in libs/apps/embedded-device-manager/routes/routes/terminal/route/src/lib/components/index.component.ts
• Store API request and response as it is done in libs/apps/embedded-device-manager/routes/route/src/lib/reducers/lang-menu-list/api/get.reducer.ts but adapt it for POST requests/responses instead of the GET ones. The payload of the POST request will be the command to execute.
• Create the Nest.js API endpoint handling the previous POST request, executing this command and responding the stdout, stderr, and other useful outputs from the process execution.

References

• https://github.com/qwefgh90/ng-terminal