3 * Copyright (C) 2017-2018 "IoT.bzh"
4 * Author Sebastien Douheret <sebastien@iot.bzh>
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
19 import { Injectable, Inject, isDevMode } from '@angular/core';
20 import { HttpClient, HttpHeaders, HttpErrorResponse } from '@angular/common/http';
21 import { DOCUMENT } from '@angular/common';
22 import { Observable } from 'rxjs/Observable';
23 import { Subject } from 'rxjs/Subject';
24 import { BehaviorSubject } from 'rxjs/BehaviorSubject';
25 import * as io from 'socket.io-client';
27 import { AlertService } from './alert.service';
28 import { ISdk, ISdkManagementMsg } from './sdk.service';
29 import { ProjectType, ProjectTypeEnum } from './project.service';
30 import { TargetType, TargetTypeEnum } from './target.service';
32 // Import RxJs required methods
33 import 'rxjs/add/operator/map';
34 import 'rxjs/add/operator/catch';
35 import 'rxjs/add/observable/throw';
36 import 'rxjs/add/operator/mergeMap';
37 import 'rxjs/add/observable/of';
38 import { ErrorObservable } from 'rxjs/observable/ErrorObservable';
41 export interface IXDSConfigProject {
44 clientSyncThingID: string;
47 defaultSdkID?: string;
50 interface IXDSBuilderConfig {
56 export interface IXDSProjectConfig {
62 type: ProjectTypeEnum;
70 export interface IXDSTargetConfig {
76 terms?: IXDSTargetTerminal[];
79 export interface IXDSTargetTerminal {
88 export interface IXDSVer {
95 export interface IXDSVersions {
100 export interface IXDServerCfg {
109 export interface IXDSConfig {
110 servers: IXDServerCfg[];
113 export interface ISdkMessage {
119 export interface ICmdOutput {
126 export interface ICmdExit {
133 export interface IServerStatus {
138 export interface IAgentStatus {
140 servers: IServerStatus[];
145 export class XDSAgentService {
147 public Socket: SocketIOClient.Socket;
148 public XdsConfig$: Observable<IXDSConfig>;
149 public Status$: Observable<IAgentStatus>;
150 public CmdOutput$ = <Subject<ICmdOutput>>new Subject();
151 public CmdExit$ = <Subject<ICmdExit>>new Subject();
153 protected sockConnect$ = new Subject<SocketIOClient.Socket>();
154 protected sockDisconnect$ = new Subject<SocketIOClient.Socket>();
156 protected projectAdd$ = new Subject<IXDSProjectConfig>();
157 protected projectDel$ = new Subject<IXDSProjectConfig>();
158 protected projectChange$ = new Subject<IXDSProjectConfig>();
160 protected sdkAdd$ = new Subject<ISdk>();
161 protected sdkRemove$ = new Subject<ISdk>();
162 protected sdkChange$ = new Subject<ISdk>();
163 protected sdkManagement$ = new Subject<ISdkManagementMsg>();
165 protected targetAdd$ = new Subject<IXDSTargetConfig>();
166 protected targetDel$ = new Subject<IXDSTargetConfig>();
167 protected targetChange$ = new Subject<IXDSTargetConfig>();
169 protected targetTerminalAdd$ = new Subject<IXDSTargetTerminal>();
170 protected targetTerminalDel$ = new Subject<IXDSTargetTerminal>();
171 protected targetTerminalChange$ = new Subject<IXDSTargetTerminal>();
173 private _socket: SocketIOClient.Socket;
174 private baseUrl: string;
175 private wsUrl: string;
176 private httpSessionID: string;
177 private _config = <IXDSConfig>{ servers: [] };
178 private _status = { connected: false, servers: [] };
180 private configSubject = <BehaviorSubject<IXDSConfig>>new BehaviorSubject(this._config);
181 private statusSubject = <BehaviorSubject<IAgentStatus>>new BehaviorSubject(this._status);
185 constructor(@Inject(DOCUMENT) private document: Document,
186 private http: HttpClient, private alert: AlertService) {
188 this.XdsConfig$ = this.configSubject.asObservable();
189 this.Status$ = this.statusSubject.asObservable();
191 const originUrl = this.document.location.origin;
192 this.baseUrl = originUrl + '/api/v1';
194 // Retrieve Session ID / token
195 this.http.get(this.baseUrl + '/version', { observe: 'response' })
198 this.httpSessionID = resp.headers.get('xds-agent-sid');
200 const re = originUrl.match(/http[s]?:\/\/([^\/]*)[\/]?/);
201 if (re === null || re.length < 2) {
202 console.error('ERROR: cannot determine Websocket url');
204 this.wsUrl = 'ws://' + re[1];
205 this._handleIoSocket();
206 this._RegisterEvents();
210 /* tslint:disable:no-console */
211 console.error('ERROR while retrieving session id:', err);
215 private _NotifyXdsAgentState(sts: boolean) {
216 this._status.connected = sts;
217 this.statusSubject.next(Object.assign({}, this._status));
219 // Update XDS config including XDS Server list when connected
221 this.getConfig().subscribe(c => {
223 this._NotifyXdsServerState();
224 this.configSubject.next(Object.assign({ servers: [] }, this._config));
229 private _NotifyXdsServerState() {
230 this._status.servers = this._config.servers.map(svr => {
231 return { id: svr.id, connected: svr.connected };
233 this.statusSubject.next(Object.assign({}, this._status));
236 private _handleIoSocket() {
237 this.Socket = this._socket = io(this.wsUrl, { transports: ['websocket'] });
239 this._socket.on('connect_error', (res) => {
240 this._NotifyXdsAgentState(false);
241 console.error('XDS Agent WebSocket Connection error !');
244 this._socket.on('connect', (res) => {
245 this._NotifyXdsAgentState(true);
246 this.sockConnect$.next(this._socket);
249 this._socket.on('disconnection', (res) => {
250 this._NotifyXdsAgentState(false);
251 this.alert.error('WS disconnection: ' + res);
252 this.sockDisconnect$.next(this._socket);
255 this._socket.on('error', (err) => {
256 console.error('WS error:', err);
259 // XDS Events decoding
261 this._socket.on('exec:output', data => {
262 this.CmdOutput$.next(Object.assign({}, <ICmdOutput>data));
265 this._socket.on('exec:exit', data => {
266 this.CmdExit$.next(Object.assign({}, <ICmdExit>data));
269 this._socket.on('event:server-config', ev => {
271 const cfg: IXDServerCfg = ev.data;
272 const idx = this._config.servers.findIndex(el => el.id === cfg.id);
274 this._config.servers[idx] = Object.assign({}, cfg);
275 this._NotifyXdsServerState();
277 this.configSubject.next(Object.assign({}, this._config));
281 /*** Project events ****/
283 this._socket.on('event:project-add', (ev) => {
284 if (ev && ev.data && ev.data.id) {
285 this.projectAdd$.next(Object.assign({}, ev.data));
286 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
287 this.alert.info('Project "' + ev.data.label + '" has been added by another tool.');
289 } else if (isDevMode) {
290 /* tslint:disable:no-console */
291 console.log('Warning: received event:project-add with unknown data: ev=', ev);
295 this._socket.on('event:project-delete', (ev) => {
296 if (ev && ev.data && ev.data.id) {
297 this.projectDel$.next(Object.assign({}, ev.data));
298 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
299 this.alert.info('Project "' + ev.data.label + '" has been deleted by another tool.');
301 } else if (isDevMode) {
302 console.log('Warning: received event:project-delete with unknown data: ev=', ev);
306 this._socket.on('event:project-state-change', ev => {
308 this.projectChange$.next(Object.assign({}, ev.data));
309 } else if (isDevMode) {
310 console.log('Warning: received event:project-state-change with unknown data: ev=', ev);
316 this._socket.on('event:sdk-add', (ev) => {
317 if (ev && ev.data && ev.data.id) {
318 const evt = <ISdk>ev.data;
319 this.sdkAdd$.next(Object.assign({}, evt));
321 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && evt.name) {
322 this.alert.info('SDK "' + evt.name + '" has been added by another tool.');
324 } else if (isDevMode) {
325 console.log('Warning: received event:sdk-add with unknown data: ev=', ev);
329 this._socket.on('event:sdk-remove', (ev) => {
330 if (ev && ev.data && ev.data.id) {
331 const evt = <ISdk>ev.data;
332 this.sdkRemove$.next(Object.assign({}, evt));
334 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && evt.name) {
335 this.alert.info('SDK "' + evt.name + '" has been removed by another tool.');
337 } else if (isDevMode) {
338 console.log('Warning: received event:sdk-remove with unknown data: ev=', ev);
342 this._socket.on('event:sdk-state-change', (ev) => {
343 if (ev && ev.data && ev.data.id) {
344 const evt = <ISdk>ev.data;
345 this.sdkChange$.next(Object.assign({}, evt));
347 } else if (isDevMode) {
348 console.log('Warning: received event:sdk-state-change with unknown data: ev=', ev);
352 this._socket.on('event:sdk-management', (ev) => {
353 if (ev && ev.data && ev.data.sdk) {
354 const evt = <ISdkManagementMsg>ev.data;
355 this.sdkManagement$.next(Object.assign({}, evt));
357 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && evt.sdk.name) {
358 this.alert.info('SDK "' + evt.sdk.name + '" has been installed by another tool.');
360 } else if (isDevMode) {
361 /* tslint:disable:no-console */
362 console.log('Warning: received event:sdk-install with unknown data: ev=', ev);
366 /*** Target events ****/
368 this._socket.on('event:target-add', (ev) => {
369 if (ev && ev.data && ev.data.id) {
370 this.targetAdd$.next(Object.assign({}, ev.data));
371 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
372 this.alert.info('Target "' + ev.data.label + '" has been added by another tool.');
374 } else if (isDevMode) {
375 /* tslint:disable:no-console */
376 console.log('Warning: received event:target-add with unknown data: ev=', ev);
380 this._socket.on('event:target-remove', (ev) => {
381 if (ev && ev.data && ev.data.id) {
382 this.targetDel$.next(Object.assign({}, ev.data));
383 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
384 this.alert.info('Target "' + ev.data.label + '" has been deleted by another tool.');
386 } else if (isDevMode) {
387 console.log('Warning: received event:target-remove with unknown data: ev=', ev);
391 this._socket.on('event:target-state-change', ev => {
393 this.targetChange$.next(Object.assign({}, ev.data));
394 } else if (isDevMode) {
395 console.log('Warning: received event:target-state-change with unknown data: ev=', ev);
399 /*** Target Terminal events ****/
401 this._socket.on('event:target-terminal-add', (ev) => {
402 if (ev && ev.data && ev.data.id) {
403 this.targetTerminalAdd$.next(Object.assign({}, ev.data));
404 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
405 this.alert.info('Target terminal "' + ev.data.label + '" has been added by another tool.');
407 } else if (isDevMode) {
408 /* tslint:disable:no-console */
409 console.log('Warning: received event:target-terminal-add with unknown data: ev=', ev);
413 this._socket.on('event:target-terminal-delete', (ev) => {
414 if (ev && ev.data && ev.data.id) {
415 this.targetTerminalDel$.next(Object.assign({}, ev.data));
416 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
417 this.alert.info('Target terminal "' + ev.data.label + '" has been deleted by another tool.');
419 } else if (isDevMode) {
420 console.log('Warning: received event:target-terminal-delete with unknown data: ev=', ev);
424 this._socket.on('event:target-terminal-state-change', ev => {
426 this.targetTerminalChange$.next(Object.assign({}, ev.data));
427 } else if (isDevMode) {
428 console.log('Warning: received event:target-terminal-state-change with unknown data: ev=', ev);
435 ** Events registration
438 onSocketConnect(): Observable<any> {
439 return this.sockConnect$.asObservable();
442 onSocketDisconnect(): Observable<any> {
443 return this.sockDisconnect$.asObservable();
446 onProjectAdd(): Observable<IXDSProjectConfig> {
447 return this.projectAdd$.asObservable();
450 onProjectDelete(): Observable<IXDSProjectConfig> {
451 return this.projectDel$.asObservable();
454 onProjectChange(): Observable<IXDSProjectConfig> {
455 return this.projectChange$.asObservable();
458 onSdkAdd(): Observable<ISdk> {
459 return this.sdkAdd$.asObservable();
462 onSdkRemove(): Observable<ISdk> {
463 return this.sdkRemove$.asObservable();
466 onSdkChange(): Observable<ISdk> {
467 return this.sdkChange$.asObservable();
470 onSdkManagement(): Observable<ISdkManagementMsg> {
471 return this.sdkManagement$.asObservable();
474 onTargetAdd(): Observable<IXDSTargetConfig> {
475 return this.targetAdd$.asObservable();
478 onTargetDelete(): Observable<IXDSTargetConfig> {
479 return this.targetDel$.asObservable();
482 onTargetChange(): Observable<IXDSTargetConfig> {
483 return this.targetChange$.asObservable();
486 onTargetTerminalAdd(): Observable<IXDSTargetTerminal> {
487 return this.targetTerminalAdd$.asObservable();
490 onTargetTerminalDelete(): Observable<IXDSTargetTerminal> {
491 return this.targetTerminalDel$.asObservable();
494 onTargetTerminalChange(): Observable<IXDSTargetTerminal> {
495 return this.targetTerminalChange$.asObservable();
501 getVersion(): Observable<IXDSVersions> {
502 return this._get('/version');
508 getConfig(): Observable<IXDSConfig> {
509 return this._get('/config');
512 setConfig(cfg: IXDSConfig): Observable<IXDSConfig> {
513 return this._post('/config', cfg);
516 setServerRetry(serverID: string, retry: number): Observable<IXDSConfig> {
517 const svr = this._getServer(serverID);
519 return Observable.throw('Unknown server ID');
521 if (retry < 0 || Number.isNaN(retry) || retry == null) {
522 return Observable.throw('Not a valid number');
524 svr.connRetry = retry;
525 return this._setConfig();
528 setServerUrl(serverID: string, url: string, retry: number): Observable<IXDSConfig> {
529 const svr = this._getServer(serverID);
531 return Observable.throw('Unknown server ID');
533 svr.connected = false;
535 if (!Number.isNaN(retry) && retry > 0) {
536 svr.connRetry = retry;
538 this._NotifyXdsServerState();
539 return this._setConfig();
542 private _setConfig(): Observable<IXDSConfig> {
543 return this.setConfig(this._config)
545 this._config = newCfg;
546 this.configSubject.next(Object.assign({}, this._config));
554 getSdks(serverID: string): Observable<ISdk[]> {
555 const svr = this._getServer(serverID);
556 if (!svr || !svr.connected) {
557 return Observable.of([]);
559 return this._get(svr.partialUrl + '/sdks');
562 installSdk(serverID: string, id: string, filename?: string, force?: boolean): Observable<ISdk> {
563 return this._post(this._getServerUrl(serverID) + '/sdks', { id: id, filename: filename, force: force });
566 abortInstall(serverID: string, id: string): Observable<ISdk> {
567 return this._post(this._getServerUrl(serverID) + '/sdks/abortinstall', { id: id });
570 removeSdk(serverID: string, id: string): Observable<ISdk> {
571 return this._delete(this._getServerUrl(serverID) + '/sdks/' + id);
578 getProjects(): Observable<IXDSProjectConfig[]> {
579 return this._get('/projects');
582 addProject(cfg: IXDSProjectConfig): Observable<IXDSProjectConfig> {
583 return this._post('/projects', cfg);
586 deleteProject(id: string): Observable<IXDSProjectConfig> {
587 return this._delete('/projects/' + id);
590 updateProject(cfg: IXDSProjectConfig): Observable<IXDSProjectConfig> {
591 return this._put('/projects/' + cfg.id, cfg);
594 syncProject(id: string): Observable<string> {
595 return this._post('/projects/sync/' + id, {});
601 exec(prjID: string, dir: string, cmd: string, sdkid?: string, args?: string[], env?: string[]): Observable<any> {
602 return this._post('/exec',
617 getTargets(serverID: string): Observable<IXDSTargetConfig[]> {
618 return this._get(this._getServerUrl(serverID) + '/targets');
621 addTarget(serverID: string, cfg: IXDSTargetConfig): Observable<IXDSTargetConfig> {
622 return this._post(this._getServerUrl(serverID) + '/targets', cfg);
625 deleteTarget(serverID: string, id: string): Observable<IXDSTargetConfig> {
626 return this._delete(this._getServerUrl(serverID) + '/targets/' + id);
629 updateTarget(serverID: string, cfg: IXDSTargetConfig): Observable<IXDSTargetConfig> {
630 return this._put(this._getServerUrl(serverID) + '/targets/' + cfg.id, cfg);
636 getTerminalsTarget(serverID, targetID: string): Observable<IXDSTargetTerminal[]> {
637 return this._get(this._getServerUrl(serverID) + '/targets/' + targetID + '/terminals');
640 getTerminalTarget(serverID, targetID, termID: string): Observable<IXDSTargetTerminal> {
641 return this._get(this._getServerUrl(serverID) + '/targets/' + targetID + '/terminals/' + termID);
644 createTerminalTarget(serverID, targetID: string, cfg: IXDSTargetTerminal): Observable<IXDSTargetTerminal> {
645 return this._post(this._getServerUrl(serverID) + '/targets/' + targetID + '/terminals', cfg);
648 updateTerminalTarget(serverID, targetID: string, cfg: IXDSTargetTerminal): Observable<IXDSTargetTerminal> {
649 if (cfg && (cfg.id !== '' || cfg.id !== undefined)) {
650 return this._put(this._getServerUrl(serverID) + '/targets/' + targetID + '/terminals/' + cfg.id, cfg);
652 return Observable.throw('Undefined terminal id');
655 openTerminalTarget(serverID, targetID, termID: string): Observable<IXDSTargetTerminal> {
656 return this._post(this._getServerUrl(serverID) + '/targets/' + targetID + '/terminals/' + termID + '/open', {});
659 closeTerminalTarget(serverID, targetID, termID: string): Observable<IXDSTargetTerminal> {
660 return this._post(this._getServerUrl(serverID) + '/targets/' + targetID + '/terminals/' + termID + '/close', {});
663 resizeTerminalTarget(serverID, targetID, termID: string, cols, rows: number): Observable<IXDSTargetTerminal> {
664 return this._post(this._getServerUrl(serverID) + '/targets/' + targetID + '/terminals/' + termID + '/resize',
665 { cols: cols, rows: rows });
671 getTopoSupervisor(): Observable<any> {
672 return this._get('/supervisor/topo');
675 startTraceSupervisor(cfg: any): Observable<any> {
676 return this._post('/supervisor/trace/start', cfg);
679 stopTraceSupervisor(cfg: any): Observable<any> {
680 return this._post('/supervisor/trace/stop', cfg);
687 private _RegisterEvents() {
688 // Register to all existing events
689 this._post('/events/register', { 'name': 'event:all' })
693 this.alert.error('ERROR while registering to all events: ' + error);
698 private _getServer(ID: string): IXDServerCfg {
699 const svr = this._config.servers.filter(item => item.id === ID);
700 if (svr.length < 1) {
706 private _getServerUrl(serverID: string): string | ErrorObservable {
707 const svr = this._getServer(serverID);
708 if (!svr || !svr.connected) {
710 console.log('ERROR: XDS Server unknown: serverID=' + serverID);
712 return Observable.throw('Cannot identify XDS Server');
714 return svr.partialUrl;
717 private _attachAuthHeaders(options?: any) {
718 options = options || {};
719 const headers = options.headers || new HttpHeaders();
720 // headers.append('Authorization', 'Basic ' + btoa('username:password'));
721 headers.append('Accept', 'application/json');
722 headers.append('Content-Type', 'application/json');
723 // headers.append('Access-Control-Allow-Origin', '*');
725 options.headers = headers;
729 private _get(url: string): Observable<any> {
730 return this.http.get(this.baseUrl + url, this._attachAuthHeaders())
731 .catch(this._decodeError);
733 private _post(url: string, body: any): Observable<any> {
734 return this.http.post(this.baseUrl + url, JSON.stringify(body), this._attachAuthHeaders())
736 return this._decodeError(error);
739 private _put(url: string, body: any): Observable<any> {
740 return this.http.put(this.baseUrl + url, JSON.stringify(body), this._attachAuthHeaders())
742 return this._decodeError(error);
745 private _delete(url: string): Observable<any> {
746 return this.http.delete(this.baseUrl + url, this._attachAuthHeaders())
747 .catch(this._decodeError);
750 private _decodeError(err: any) {
752 if (err instanceof HttpErrorResponse) {
753 e = (err.error && err.error.error) ? err.error.error : err.message || 'Unknown error';
754 } else if (typeof err === 'object') {
755 if (err.statusText) {
757 } else if (err.error) {
758 e = String(err.error);
760 e = JSON.stringify(err);
763 e = err.message ? err.message : err.toString();
765 /* tslint:disable:no-console */
767 console.log('xdsagent.service - ERROR: ', e);
769 return Observable.throw(e);