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';
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';
40 export interface IXDSConfigProject {
43 clientSyncThingID: string;
46 defaultSdkID?: string;
49 interface IXDSBuilderConfig {
55 export interface IXDSProjectConfig {
61 type: ProjectTypeEnum;
68 export interface IXDSVer {
75 export interface IXDSVersions {
80 export interface IXDServerCfg {
89 export interface IXDSConfig {
90 servers: IXDServerCfg[];
93 export interface ISdkMessage {
99 export interface ICmdOutput {
106 export interface ICmdExit {
113 export interface IServerStatus {
118 export interface IAgentStatus {
120 servers: IServerStatus[];
125 export class XDSAgentService {
127 public XdsConfig$: Observable<IXDSConfig>;
128 public Status$: Observable<IAgentStatus>;
129 public CmdOutput$ = <Subject<ICmdOutput>>new Subject();
130 public CmdExit$ = <Subject<ICmdExit>>new Subject();
132 protected projectAdd$ = new Subject<IXDSProjectConfig>();
133 protected projectDel$ = new Subject<IXDSProjectConfig>();
134 protected projectChange$ = new Subject<IXDSProjectConfig>();
136 protected sdkAdd$ = new Subject<ISdk>();
137 protected sdkRemove$ = new Subject<ISdk>();
138 protected sdkChange$ = new Subject<ISdk>();
139 protected sdkManagement$ = new Subject<ISdkManagementMsg>();
141 private baseUrl: string;
142 private wsUrl: string;
143 private httpSessionID: string;
144 private _config = <IXDSConfig>{ servers: [] };
145 private _status = { connected: false, servers: [] };
147 private configSubject = <BehaviorSubject<IXDSConfig>>new BehaviorSubject(this._config);
148 private statusSubject = <BehaviorSubject<IAgentStatus>>new BehaviorSubject(this._status);
150 private socket: SocketIOClient.Socket;
152 constructor( @Inject(DOCUMENT) private document: Document,
153 private http: HttpClient, private alert: AlertService) {
155 this.XdsConfig$ = this.configSubject.asObservable();
156 this.Status$ = this.statusSubject.asObservable();
158 const originUrl = this.document.location.origin;
159 this.baseUrl = originUrl + '/api/v1';
161 // Retrieve Session ID / token
162 this.http.get(this.baseUrl + '/version', { observe: 'response' })
165 this.httpSessionID = resp.headers.get('xds-agent-sid');
167 const re = originUrl.match(/http[s]?:\/\/([^\/]*)[\/]?/);
168 if (re === null || re.length < 2) {
169 console.error('ERROR: cannot determine Websocket url');
171 this.wsUrl = 'ws://' + re[1];
172 this._handleIoSocket();
173 this._RegisterEvents();
177 /* tslint:disable:no-console */
178 console.error('ERROR while retrieving session id:', err);
182 private _NotifyXdsAgentState(sts: boolean) {
183 this._status.connected = sts;
184 this.statusSubject.next(Object.assign({}, this._status));
186 // Update XDS config including XDS Server list when connected
188 this.getConfig().subscribe(c => {
190 this._NotifyXdsServerState();
191 this.configSubject.next(Object.assign({ servers: [] }, this._config));
196 private _NotifyXdsServerState() {
197 this._status.servers = this._config.servers.map(svr => {
198 return { id: svr.id, connected: svr.connected };
200 this.statusSubject.next(Object.assign({}, this._status));
203 private _handleIoSocket() {
204 this.socket = io(this.wsUrl, { transports: ['websocket'] });
206 this.socket.on('connect_error', (res) => {
207 this._NotifyXdsAgentState(false);
208 console.error('XDS Agent WebSocket Connection error !');
211 this.socket.on('connect', (res) => {
212 this._NotifyXdsAgentState(true);
215 this.socket.on('disconnection', (res) => {
216 this._NotifyXdsAgentState(false);
217 this.alert.error('WS disconnection: ' + res);
220 this.socket.on('error', (err) => {
221 console.error('WS error:', err);
224 // XDS Events decoding
226 this.socket.on('make:output', data => {
227 this.CmdOutput$.next(Object.assign({}, <ICmdOutput>data));
230 this.socket.on('make:exit', data => {
231 this.CmdExit$.next(Object.assign({}, <ICmdExit>data));
234 this.socket.on('exec:output', data => {
235 this.CmdOutput$.next(Object.assign({}, <ICmdOutput>data));
238 this.socket.on('exec:exit', data => {
239 this.CmdExit$.next(Object.assign({}, <ICmdExit>data));
242 this.socket.on('event:server-config', ev => {
244 const cfg: IXDServerCfg = ev.data;
245 const idx = this._config.servers.findIndex(el => el.id === cfg.id);
247 this._config.servers[idx] = Object.assign({}, cfg);
248 this._NotifyXdsServerState();
250 this.configSubject.next(Object.assign({}, this._config));
254 /*** Project events ****/
256 this.socket.on('event:project-add', (ev) => {
257 if (ev && ev.data && ev.data.id) {
258 this.projectAdd$.next(Object.assign({}, ev.data));
259 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
260 this.alert.info('Project "' + ev.data.label + '" has been added by another tool.');
262 } else if (isDevMode) {
263 /* tslint:disable:no-console */
264 console.log('Warning: received event:project-add with unknown data: ev=', ev);
268 this.socket.on('event:project-delete', (ev) => {
269 if (ev && ev.data && ev.data.id) {
270 this.projectDel$.next(Object.assign({}, ev.data));
271 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && ev.data.label) {
272 this.alert.info('Project "' + ev.data.label + '" has been deleted by another tool.');
274 } else if (isDevMode) {
275 console.log('Warning: received event:project-delete with unknown data: ev=', ev);
279 this.socket.on('event:project-state-change', ev => {
281 this.projectChange$.next(Object.assign({}, ev.data));
282 } else if (isDevMode) {
283 console.log('Warning: received event:project-state-change with unkn220own data: ev=', ev);
289 this.socket.on('event:sdk-add', (ev) => {
290 if (ev && ev.data && ev.data.id) {
291 const evt = <ISdk>ev.data;
292 this.sdkAdd$.next(Object.assign({}, evt));
294 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && evt.name) {
295 this.alert.info('SDK "' + evt.name + '" has been added by another tool.');
297 } else if (isDevMode) {
298 console.log('Warning: received event:sdk-add with unknown data: ev=', ev);
302 this.socket.on('event:sdk-remove', (ev) => {
303 if (ev && ev.data && ev.data.id) {
304 const evt = <ISdk>ev.data;
305 this.sdkRemove$.next(Object.assign({}, evt));
307 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && evt.name) {
308 this.alert.info('SDK "' + evt.name + '" has been removed by another tool.');
310 } else if (isDevMode) {
311 console.log('Warning: received event:sdk-remove with unknown data: ev=', ev);
315 this.socket.on('event:sdk-state-change', (ev) => {
316 if (ev && ev.data && ev.data.id) {
317 const evt = <ISdk>ev.data;
318 this.sdkChange$.next(Object.assign({}, evt));
320 } else if (isDevMode) {
321 console.log('Warning: received event:sdk-state-change with unknown data: ev=', ev);
326 this.socket.on('event:sdk-management', (ev) => {
327 if (ev && ev.data && ev.data.sdk) {
328 const evt = <ISdkManagementMsg>ev.data;
329 this.sdkManagement$.next(Object.assign({}, evt));
331 if (ev.sessionID !== '' && ev.sessionID !== this.httpSessionID && evt.sdk.name) {
332 this.alert.info('SDK "' + evt.sdk.name + '" has been installed by another tool.');
334 } else if (isDevMode) {
335 /* tslint:disable:no-console */
336 console.log('Warning: received event:sdk-install with unknown data: ev=', ev);
343 ** Events registration
345 onProjectAdd(): Observable<IXDSProjectConfig> {
346 return this.projectAdd$.asObservable();
349 onProjectDelete(): Observable<IXDSProjectConfig> {
350 return this.projectDel$.asObservable();
353 onProjectChange(): Observable<IXDSProjectConfig> {
354 return this.projectChange$.asObservable();
357 onSdkAdd(): Observable<ISdk> {
358 return this.sdkAdd$.asObservable();
361 onSdkRemove(): Observable<ISdk> {
362 return this.sdkRemove$.asObservable();
365 onSdkChange(): Observable<ISdk> {
366 return this.sdkChange$.asObservable();
369 onSdkManagement(): Observable<ISdkManagementMsg> {
370 return this.sdkManagement$.asObservable();
376 getVersion(): Observable<IXDSVersions> {
377 return this._get('/version');
383 getConfig(): Observable<IXDSConfig> {
384 return this._get('/config');
387 setConfig(cfg: IXDSConfig): Observable<IXDSConfig> {
388 return this._post('/config', cfg);
391 setServerRetry(serverID: string, retry: number): Observable<IXDSConfig> {
392 const svr = this._getServer(serverID);
394 return Observable.throw('Unknown server ID');
396 if (retry < 0 || Number.isNaN(retry) || retry == null) {
397 return Observable.throw('Not a valid number');
399 svr.connRetry = retry;
400 return this._setConfig();
403 setServerUrl(serverID: string, url: string, retry: number): Observable<IXDSConfig> {
404 const svr = this._getServer(serverID);
406 return Observable.throw('Unknown server ID');
408 svr.connected = false;
410 if (!Number.isNaN(retry) && retry > 0) {
411 svr.connRetry = retry;
413 this._NotifyXdsServerState();
414 return this._setConfig();
417 private _setConfig(): Observable<IXDSConfig> {
418 return this.setConfig(this._config)
420 this._config = newCfg;
421 this.configSubject.next(Object.assign({}, this._config));
429 getSdks(serverID: string): Observable<ISdk[]> {
430 const svr = this._getServer(serverID);
431 if (!svr || !svr.connected) {
432 return Observable.of([]);
434 return this._get(svr.partialUrl + '/sdks');
437 installSdk(serverID: string, id: string, filename?: string, force?: boolean): Observable<ISdk> {
438 return this._post(this._getServerUrl(serverID) + '/sdks', { id: id, filename: filename, force: force });
441 abortInstall(serverID: string, id: string): Observable<ISdk> {
442 return this._post(this._getServerUrl(serverID) + '/sdks/abortinstall', { id: id });
445 removeSdk(serverID: string, id: string): Observable<ISdk> {
446 return this._delete(this._getServerUrl(serverID) + '/sdks/' + id);
453 getProjects(): Observable<IXDSProjectConfig[]> {
454 return this._get('/projects');
457 addProject(cfg: IXDSProjectConfig): Observable<IXDSProjectConfig> {
458 return this._post('/projects', cfg);
461 deleteProject(id: string): Observable<IXDSProjectConfig> {
462 return this._delete('/projects/' + id);
465 updateProject(cfg: IXDSProjectConfig): Observable<IXDSProjectConfig> {
466 return this._put('/projects/' + cfg.id, cfg);
469 syncProject(id: string): Observable<string> {
470 return this._post('/projects/sync/' + id, {});
476 exec(prjID: string, dir: string, cmd: string, sdkid?: string, args?: string[], env?: string[]): Observable<any> {
477 return this._post('/exec',
492 private _RegisterEvents() {
493 // Register to all existing events
494 this._post('/events/register', { 'name': 'event:all' })
498 this.alert.error('ERROR while registering to all events: ' + error);
503 private _getServer(ID: string): IXDServerCfg {
504 const svr = this._config.servers.filter(item => item.id === ID);
505 if (svr.length < 1) {
511 private _getServerUrl(serverID: string): string | ErrorObservable {
512 const svr = this._getServer(serverID);
513 if (!svr || !svr.connected) {
515 console.log('ERROR: XDS Server unknown: serverID=' + serverID);
517 return Observable.throw('Cannot identify XDS Server');
519 return svr.partialUrl;
522 private _attachAuthHeaders(options?: any) {
523 options = options || {};
524 const headers = options.headers || new HttpHeaders();
525 // headers.append('Authorization', 'Basic ' + btoa('username:password'));
526 headers.append('Accept', 'application/json');
527 headers.append('Content-Type', 'application/json');
528 // headers.append('Access-Control-Allow-Origin', '*');
530 options.headers = headers;
534 private _get(url: string): Observable<any> {
535 return this.http.get(this.baseUrl + url, this._attachAuthHeaders())
536 .catch(this._decodeError);
538 private _post(url: string, body: any): Observable<any> {
539 return this.http.post(this.baseUrl + url, JSON.stringify(body), this._attachAuthHeaders())
541 return this._decodeError(error);
544 private _put(url: string, body: any): Observable<any> {
545 return this.http.put(this.baseUrl + url, JSON.stringify(body), this._attachAuthHeaders())
547 return this._decodeError(error);
550 private _delete(url: string): Observable<any> {
551 return this.http.delete(this.baseUrl + url, this._attachAuthHeaders())
552 .catch(this._decodeError);
555 private _decodeError(err: any) {
557 if (err instanceof HttpErrorResponse) {
558 e = (err.error && err.error.error) ? err.error.error : err.message || 'Unknown error';
559 } else if (typeof err === 'object') {
560 if (err.statusText) {
562 } else if (err.error) {
563 e = String(err.error);
565 e = JSON.stringify(err);
568 e = err.message ? err.message : err.toString();
570 /* tslint:disable:no-console */
572 console.log('xdsagent.service - ERROR: ', e);
574 return Observable.throw(e);