webapp/src/app/@core-xds/services/xdsagent.service.ts

   1 /**
   2 * @license
   3 * Copyright (C) 2017-2018 "IoT.bzh"
   4 * Author Sebastien Douheret <sebastien@iot.bzh>
   5 *
   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
   9 *
  10 *   http://www.apache.org/licenses/LICENSE-2.0
  11 *
  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.
  17 */
  18
  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';
  26
  27 import { AlertService } from './alert.service';
  28 import { ISdk, ISdkManagementMsg } from './sdk.service';
  29 import { ProjectType, ProjectTypeEnum } from './project.service';
  30
  31 // Import RxJs required methods
  32 import 'rxjs/add/operator/map';
  33 import 'rxjs/add/operator/catch';
  34 import 'rxjs/add/observable/throw';
  35 import 'rxjs/add/operator/mergeMap';
  36 import 'rxjs/add/observable/of';
  37 import { ErrorObservable } from 'rxjs/observable/ErrorObservable';
  38
  39
  40 export interface IXDSConfigProject {
  41   id: string;
  42   path: string;
  43   clientSyncThingID: string;
  44   type: string;
  45   label?: string;
  46   defaultSdkID?: string;
  47 }
  48
  49 interface IXDSBuilderConfig {
  50   ip: string;
  51   port: string;
  52   syncThingID: string;
  53 }
  54
  55 export interface IXDSProjectConfig {
  56   id: string;
  57   serverId: string;
  58   label: string;
  59   clientPath: string;
  60   serverPath?: string;
  61   type: ProjectTypeEnum;
  62   status?: string;
  63   isInSync?: boolean;
  64   defaultSdkID: string;
  65   clientData?: string;
  66 }
  67
  68 export interface IXDSVer {
  69   id: string;
  70   version: string;
  71   apiVersion: string;
  72   gitTag: string;
  73 }
  74
  75 export interface IXDSVersions {
  76   client: IXDSVer;
  77   servers: IXDSVer[];
  78 }
  79
  80 export interface IXDServerCfg {
  81   id: string;
  82   url: string;
  83   apiUrl?: string;
  84   partialUrl?: string;
  85   connRetry: number;
  86   connected: boolean;
  87 }
  88
  89 export interface IXDSConfig {
  90   servers: IXDServerCfg[];
  91 }
  92
  93 export interface ISdkMessage {
  94   wsID: string;
  95   msgType: string;
  96   data: any;
  97 }
  98
  99 export interface ICmdOutput {
 100   cmdID: string;
 101   timestamp: string;
 102   stdout: string;
 103   stderr: string;
 104 }
 105
 106 export interface ICmdExit {
 107   cmdID: string;
 108   timestamp: string;
 109   code: number;
 110   error: string;
 111 }
 112
 113 export interface IServerStatus {
 114   id: string;
 115   connected: boolean;
 116 }
 117
 118 export interface IAgentStatus {
 119   connected: boolean;
 120   servers: IServerStatus[];
 121 }
 122
 123
 124 @Injectable()
 125 export class XDSAgentService {
 126
 127   public XdsConfig$: Observable<IXDSConfig>;
 128   public Status$: Observable<IAgentStatus>;
 129   public CmdOutput$ = <Subject<ICmdOutput>>new Subject();
 130   public CmdExit$ = <Subject<ICmdExit>>new Subject();
 131
 132   protected projectAdd$ = new Subject<IXDSProjectConfig>();
 133   protected projectDel$ = new Subject<IXDSProjectConfig>();
 134   protected projectChange$ = new Subject<IXDSProjectConfig>();
 135
 136   protected sdkInstall$ = new Subject<ISdkManagementMsg>();
 137   protected sdkRemove$ = new Subject<ISdkManagementMsg>();
 138
 139   private baseUrl: string;
 140   private wsUrl: string;
 141   private httpSessionID: string;
 142   private _config = <IXDSConfig>{ servers: [] };
 143   private _status = { connected: false, servers: [] };
 144
 145   private configSubject = <BehaviorSubject<IXDSConfig>>new BehaviorSubject(this._config);
 146   private statusSubject = <BehaviorSubject<IAgentStatus>>new BehaviorSubject(this._status);
 147
 148   private socket: SocketIOClient.Socket;
 149
 150   constructor( @Inject(DOCUMENT) private document: Document,
 151     private http: HttpClient, private alert: AlertService) {
 152
 153     this.XdsConfig$ = this.configSubject.asObservable();
 154     this.Status$ = this.statusSubject.asObservable();
 155
 156     const originUrl = this.document.location.origin;
 157     this.baseUrl = originUrl + '/api/v1';
 158
 159     // Retrieve Session ID / token
 160     this.http.get(this.baseUrl + '/version', { observe: 'response' })
 161       .subscribe(
 162       resp => {
 163         this.httpSessionID = resp.headers.get('xds-agent-sid');
 164
 165         const re = originUrl.match(/http[s]?:\/\/([^\/]*)[\/]?/);
 166         if (re === null || re.length < 2) {
 167           console.error('ERROR: cannot determine Websocket url');
 168         } else {
 169           this.wsUrl = 'ws://' + re[1];
 170           this._handleIoSocket();
 171           this._RegisterEvents();
 172         }
 173       },
 174       err => {
 175         /* tslint:disable:no-console */
 176         console.error('ERROR while retrieving session id:', err);
 177       });
 178   }
 179
 180   private _NotifyXdsAgentState(sts: boolean) {
 181     this._status.connected = sts;
 182     this.statusSubject.next(Object.assign({}, this._status));
 183
 184     // Update XDS config including XDS Server list when connected
 185     if (sts) {
 186       this.getConfig().subscribe(c => {
 187         this._config = c;
 188         this._NotifyXdsServerState();
 189         this.configSubject.next(Object.assign({ servers: [] }, this._config));
 190       });
 191     }
 192   }
 193
 194   private _NotifyXdsServerState() {
 195     this._status.servers = this._config.servers.map(svr => {
 196       return { id: svr.id, connected: svr.connected };
 197     });
 198     this.statusSubject.next(Object.assign({}, this._status));
 199   }
 200
 201   private _handleIoSocket() {
 202     this.socket = io(this.wsUrl, { transports: ['websocket'] });
 203
 204     this.socket.on('connect_error', (res) => {
 205       this._NotifyXdsAgentState(false);
 206       console.error('XDS Agent WebSocket Connection error !');
 207     });
 208
 209     this.socket.on('connect', (res) => {
 210       this._NotifyXdsAgentState(true);
 211     });
 212
 213     this.socket.on('disconnection', (res) => {
 214       this._NotifyXdsAgentState(false);
 215       this.alert.error('WS disconnection: ' + res);
 216     });
 217
 218     this.socket.on('error', (err) => {
 219       console.error('WS error:', err);
 220     });
 221
 222     // XDS Events decoding
 223
 224     this.socket.on('make:output', data => {
 225       this.CmdOutput$.next(Object.assign({}, <ICmdOutput>data));
 226     });
 227
 228     this.socket.on('make:exit', data => {
 229       this.CmdExit$.next(Object.assign({}, <ICmdExit>data));
 230     });
 231
 232     this.socket.on('exec:output', data => {
 233       this.CmdOutput$.next(Object.assign({}, <ICmdOutput>data));
 234     });
 235
 236     this.socket.on('exec:exit', data => {
 237       this.CmdExit$.next(Object.assign({}, <ICmdExit>data));
 238     });
 239
 240     this.socket.on('event:server-config', ev => {
 241       if (ev && ev.data) {
 242         const cfg: IXDServerCfg = ev.data;
 243         const idx = this._config.servers.findIndex(el => el.id === cfg.id);
 244         if (idx >= 0) {
 245           this._config.servers[idx] = Object.assign({}, cfg);
 246           this._NotifyXdsServerState();
 247         }
 248         this.configSubject.next(Object.assign({}, this._config));
 249       }
 250     });
 251
 252     this.socket.on('event:project-add', (ev) => {
 253       if (ev && ev.data && ev.data.id) {
 254         this.projectAdd$.next(Object.assign({}, ev.data));
 255         if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
 256           this.alert.info('Project "' + ev.data.label + '" has been added by another tool.');
 257         }
 258       } else if (isDevMode) {
 259         /* tslint:disable:no-console */
 260         console.log('Warning: received event:project-add with unknown data: ev=', ev);
 261       }
 262     });
 263
 264     this.socket.on('event:project-delete', (ev) => {
 265       if (ev && ev.data && ev.data.id) {
 266         this.projectDel$.next(Object.assign({}, ev.data));
 267         if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
 268           this.alert.info('Project "' + ev.data.label + '" has been deleted by another tool.');
 269         }
 270       } else if (isDevMode) {
 271         console.log('Warning: received event:project-delete with unknown data: ev=', ev);
 272       }
 273     });
 274
 275     this.socket.on('event:project-state-change', ev => {
 276       if (ev && ev.data) {
 277         this.projectChange$.next(Object.assign({}, ev.data));
 278       } else if (isDevMode) {
 279         console.log('Warning: received event:project-state-change with unkn220own data: ev=', ev);
 280       }
 281     });
 282
 283     this.socket.on('event:sdk-install', (ev) => {
 284       if (ev && ev.data && ev.data.sdk) {
 285         const evt = <ISdkManagementMsg>ev.data;
 286         this.sdkInstall$.next(Object.assign({}, evt));
 287
 288         if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && evt.sdk.name) {
 289           this.alert.info('SDK "' + evt.sdk.name + '" has been installed by another tool.');
 290         }
 291       } else if (isDevMode) {
 292         /* tslint:disable:no-console */
 293         console.log('Warning: received event:sdk-install with unknown data: ev=', ev);
 294       }
 295     });
 296
 297     this.socket.on('event:sdk-remove', (ev) => {
 298       if (ev && ev.data && ev.data.sdk) {
 299         const evt = <ISdkManagementMsg>ev.data;
 300         this.sdkRemove$.next(Object.assign({}, evt));
 301
 302         if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && evt.sdk.name) {
 303           this.alert.info('SDK "' + evt.sdk.name + '" has been removed by another tool.');
 304         }
 305       } else if (isDevMode) {
 306         console.log('Warning: received event:sdk-remove with unknown data: ev=', ev);
 307       }
 308     });
 309   }
 310
 311   /**
 312   ** Events registration
 313   ***/
 314   onProjectAdd(): Observable<IXDSProjectConfig> {
 315     return this.projectAdd$.asObservable();
 316   }
 317
 318   onProjectDelete(): Observable<IXDSProjectConfig> {
 319     return this.projectDel$.asObservable();
 320   }
 321
 322   onProjectChange(): Observable<IXDSProjectConfig> {
 323     return this.projectChange$.asObservable();
 324   }
 325
 326   onSdkInstall(): Observable<ISdkManagementMsg> {
 327     return this.sdkInstall$.asObservable();
 328   }
 329
 330   onSdkRemove(): Observable<ISdkManagementMsg> {
 331     return this.sdkRemove$.asObservable();
 332   }
 333
 334   /**
 335   ** Misc / Version
 336   ***/
 337   getVersion(): Observable<IXDSVersions> {
 338     return this._get('/version');
 339   }
 340
 341   /***
 342   ** Config
 343   ***/
 344   getConfig(): Observable<IXDSConfig> {
 345     return this._get('/config');
 346   }
 347
 348   setConfig(cfg: IXDSConfig): Observable<IXDSConfig> {
 349     return this._post('/config', cfg);
 350   }
 351
 352   setServerRetry(serverID: string, retry: number): Observable<IXDSConfig> {
 353     const svr = this._getServer(serverID);
 354     if (!svr) {
 355       return Observable.throw('Unknown server ID');
 356     }
 357     if (retry < 0 || Number.isNaN(retry) || retry == null) {
 358       return Observable.throw('Not a valid number');
 359     }
 360     svr.connRetry = retry;
 361     return this._setConfig();
 362   }
 363
 364   setServerUrl(serverID: string, url: string, retry: number): Observable<IXDSConfig> {
 365     const svr = this._getServer(serverID);
 366     if (!svr) {
 367       return Observable.throw('Unknown server ID');
 368     }
 369     svr.connected = false;
 370     svr.url = url;
 371     if (!Number.isNaN(retry) && retry > 0) {
 372       svr.connRetry = retry;
 373     }
 374     this._NotifyXdsServerState();
 375     return this._setConfig();
 376   }
 377
 378   private _setConfig(): Observable<IXDSConfig> {
 379     return this.setConfig(this._config)
 380       .map(newCfg => {
 381         this._config = newCfg;
 382         this.configSubject.next(Object.assign({}, this._config));
 383         return this._config;
 384       });
 385   }
 386
 387   /***
 388   ** SDKs
 389   ***/
 390   getSdks(serverID: string): Observable<ISdk[]> {
 391     const svr = this._getServer(serverID);
 392     if (!svr || !svr.connected) {
 393       return Observable.of([]);
 394     }
 395     return this._get(svr.partialUrl + '/sdks');
 396   }
 397
 398   installSdk(serverID: string, id: string, filename?: string, force?: boolean): Observable<ISdk> {
 399     return this._post(this._getServerUrl(serverID) + '/sdks', { id: id, filename: filename, force: force });
 400   }
 401
 402   abortInstall(serverID: string, id: string): Observable<ISdk> {
 403     return this._post(this._getServerUrl(serverID) + '/sdks/abortinstall', { id: id });
 404   }
 405
 406   removeSdk(serverID: string, id: string): Observable<ISdk> {
 407     return this._delete(this._getServerUrl(serverID) + '/sdks/' + id);
 408   }
 409
 410
 411   /***
 412   ** Projects
 413   ***/
 414   getProjects(): Observable<IXDSProjectConfig[]> {
 415     return this._get('/projects');
 416   }
 417
 418   addProject(cfg: IXDSProjectConfig): Observable<IXDSProjectConfig> {
 419     return this._post('/projects', cfg);
 420   }
 421
 422   deleteProject(id: string): Observable<IXDSProjectConfig> {
 423     return this._delete('/projects/' + id);
 424   }
 425
 426   updateProject(cfg: IXDSProjectConfig): Observable<IXDSProjectConfig> {
 427     return this._put('/projects/' + cfg.id, cfg);
 428   }
 429
 430   syncProject(id: string): Observable<string> {
 431     return this._post('/projects/sync/' + id, {});
 432   }
 433
 434   /***
 435   ** Exec
 436   ***/
 437   exec(prjID: string, dir: string, cmd: string, sdkid?: string, args?: string[], env?: string[]): Observable<any> {
 438     return this._post('/exec',
 439       {
 440         id: prjID,
 441         rpath: dir,
 442         cmd: cmd,
 443         sdkID: sdkid || '',
 444         args: args || [],
 445         env: env || [],
 446       });
 447   }
 448
 449   /**
 450   ** Private functions
 451   ***/
 452
 453   private _RegisterEvents() {
 454     // Register to all existing events
 455     this._post('/events/register', { 'name': 'event:all' })
 456       .subscribe(
 457       res => { },
 458       error => {
 459         this.alert.error('ERROR while registering to all events: ' + error);
 460       },
 461     );
 462   }
 463
 464   private _getServer(ID: string): IXDServerCfg {
 465     const svr = this._config.servers.filter(item => item.id === ID);
 466     if (svr.length < 1) {
 467       return null;
 468     }
 469     return svr[0];
 470   }
 471
 472   private _getServerUrl(serverID: string): string | ErrorObservable {
 473     const svr = this._getServer(serverID);
 474     if (!svr || !svr.connected) {
 475       if (isDevMode) {
 476         console.log('ERROR: XDS Server unknown: serverID=' + serverID);
 477       }
 478       return Observable.throw('Cannot identify XDS Server');
 479     }
 480     return svr.partialUrl;
 481   }
 482
 483   private _attachAuthHeaders(options?: any) {
 484     options = options || {};
 485     const headers = options.headers || new HttpHeaders();
 486     // headers.append('Authorization', 'Basic ' + btoa('username:password'));
 487     headers.append('Accept', 'application/json');
 488     headers.append('Content-Type', 'application/json');
 489     // headers.append('Access-Control-Allow-Origin', '*');
 490
 491     options.headers = headers;
 492     return options;
 493   }
 494
 495   private _get(url: string): Observable<any> {
 496     return this.http.get(this.baseUrl + url, this._attachAuthHeaders())
 497       .catch(this._decodeError);
 498   }
 499   private _post(url: string, body: any): Observable<any> {
 500     return this.http.post(this.baseUrl + url, JSON.stringify(body), this._attachAuthHeaders())
 501       .catch((error) => {
 502         return this._decodeError(error);
 503       });
 504   }
 505   private _put(url: string, body: any): Observable<any> {
 506     return this.http.put(this.baseUrl + url, JSON.stringify(body), this._attachAuthHeaders())
 507       .catch((error) => {
 508         return this._decodeError(error);
 509       });
 510   }
 511   private _delete(url: string): Observable<any> {
 512     return this.http.delete(this.baseUrl + url, this._attachAuthHeaders())
 513       .catch(this._decodeError);
 514   }
 515
 516   private _decodeError(err: any) {
 517     let e: string;
 518     if (err instanceof HttpErrorResponse) {
 519       e = (err.error && err.error.error) ? err.error.error : err.message || 'Unknown error';
 520     } else if (typeof err === 'object') {
 521       if (err.statusText) {
 522         e = err.statusText;
 523       } else if (err.error) {
 524         e = String(err.error);
 525       } else {
 526         e = JSON.stringify(err);
 527       }
 528     } else {
 529       e = err.message ? err.message : err.toString();
 530     }
 531     /* tslint:disable:no-console */
 532     if (isDevMode) {
 533       console.log('xdsagent.service - ERROR: ', e);
 534     }
 535     return Observable.throw(e);
 536   }
 537 }