3 * Copyright (C) 2017 "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 sdkInstall$ = new Subject<ISdkManagementMsg>();
137 protected sdkRemove$ = new Subject<ISdkManagementMsg>();
139 private baseUrl: string;
140 private wsUrl: string;
141 private httpSessionID: string;
142 private _config = <IXDSConfig>{ servers: [] };
143 private _status = { connected: false, servers: [] };
145 private configSubject = <BehaviorSubject<IXDSConfig>>new BehaviorSubject(this._config);
146 private statusSubject = <BehaviorSubject<IAgentStatus>>new BehaviorSubject(this._status);
148 private socket: SocketIOClient.Socket;
150 constructor( @Inject(DOCUMENT) private document: Document,
151 private http: HttpClient, private alert: AlertService) {
153 this.XdsConfig$ = this.configSubject.asObservable();
154 this.Status$ = this.statusSubject.asObservable();
156 const originUrl = this.document.location.origin;
157 this.baseUrl = originUrl + '/api/v1';
159 // Retrieve Session ID / token
160 this.http.get(this.baseUrl + '/version', { observe: 'response' })
163 this.httpSessionID = resp.headers.get('xds-agent-sid');
165 const re = originUrl.match(/http[s]?:\/\/([^\/]*)[\/]?/);
166 if (re === null || re.length < 2) {
167 console.error('ERROR: cannot determine Websocket url');
169 this.wsUrl = 'ws://' + re[1];
170 this._handleIoSocket();
171 this._RegisterEvents();
175 /* tslint:disable:no-console */
176 console.error('ERROR while retrieving session id:', err);
180 private _NotifyXdsAgentState(sts: boolean) {
181 this._status.connected = sts;
182 this.statusSubject.next(Object.assign({}, this._status));
184 // Update XDS config including XDS Server list when connected
186 this.getConfig().subscribe(c => {
188 this._NotifyXdsServerState();
189 this.configSubject.next(Object.assign({ servers: [] }, this._config));
194 private _NotifyXdsServerState() {
195 this._status.servers = this._config.servers.map(svr => {
196 return { id: svr.id, connected: svr.connected };
198 this.statusSubject.next(Object.assign({}, this._status));
201 private _handleIoSocket() {
202 this.socket = io(this.wsUrl, { transports: ['websocket'] });
204 this.socket.on('connect_error', (res) => {
205 this._NotifyXdsAgentState(false);
206 console.error('XDS Agent WebSocket Connection error !');
209 this.socket.on('connect', (res) => {
210 this._NotifyXdsAgentState(true);
213 this.socket.on('disconnection', (res) => {
214 this._NotifyXdsAgentState(false);
215 this.alert.error('WS disconnection: ' + res);
218 this.socket.on('error', (err) => {
219 console.error('WS error:', err);
222 // XDS Events decoding
224 this.socket.on('make:output', data => {
225 this.CmdOutput$.next(Object.assign({}, <ICmdOutput>data));
228 this.socket.on('make:exit', data => {
229 this.CmdExit$.next(Object.assign({}, <ICmdExit>data));
232 this.socket.on('exec:output', data => {
233 this.CmdOutput$.next(Object.assign({}, <ICmdOutput>data));
236 this.socket.on('exec:exit', data => {
237 this.CmdExit$.next(Object.assign({}, <ICmdExit>data));
240 this.socket.on('event:server-config', ev => {
242 const cfg: IXDServerCfg = ev.data;
243 const idx = this._config.servers.findIndex(el => el.id === cfg.id);
245 this._config.servers[idx] = Object.assign({}, cfg);
246 this._NotifyXdsServerState();
248 this.configSubject.next(Object.assign({}, this._config));
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.');
258 } else if (isDevMode) {
259 /* tslint:disable:no-console */
260 console.log('Warning: received event:project-add with unknown data: ev=', ev);
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.');
270 } else if (isDevMode) {
271 console.log('Warning: received event:project-delete with unknown data: ev=', ev);
275 this.socket.on('event:project-state-change', ev => {
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);
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));
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.');
291 } else if (isDevMode) {
292 /* tslint:disable:no-console */
293 console.log('Warning: received event:sdk-install with unknown data: ev=', ev);
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));
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.');
305 } else if (isDevMode) {
306 console.log('Warning: received event:sdk-remove with unknown data: ev=', ev);
312 ** Events registration
314 onProjectAdd(): Observable<IXDSProjectConfig> {
315 return this.projectAdd$.asObservable();
318 onProjectDelete(): Observable<IXDSProjectConfig> {
319 return this.projectDel$.asObservable();
322 onProjectChange(): Observable<IXDSProjectConfig> {
323 return this.projectChange$.asObservable();
326 onSdkInstall(): Observable<ISdkManagementMsg> {
327 return this.sdkInstall$.asObservable();
330 onSdkRemove(): Observable<ISdkManagementMsg> {
331 return this.sdkRemove$.asObservable();
337 getVersion(): Observable<IXDSVersions> {
338 return this._get('/version');
344 getConfig(): Observable<IXDSConfig> {
345 return this._get('/config');
348 setConfig(cfg: IXDSConfig): Observable<IXDSConfig> {
349 return this._post('/config', cfg);
352 setServerRetry(serverID: string, retry: number): Observable<IXDSConfig> {
353 const svr = this._getServer(serverID);
355 return Observable.throw('Unknown server ID');
357 if (retry < 0 || Number.isNaN(retry) || retry == null) {
358 return Observable.throw('Not a valid number');
360 svr.connRetry = retry;
361 return this._setConfig();
364 setServerUrl(serverID: string, url: string, retry: number): Observable<IXDSConfig> {
365 const svr = this._getServer(serverID);
367 return Observable.throw('Unknown server ID');
369 svr.connected = false;
371 if (!Number.isNaN(retry) && retry > 0) {
372 svr.connRetry = retry;
374 this._NotifyXdsServerState();
375 return this._setConfig();
378 private _setConfig(): Observable<IXDSConfig> {
379 return this.setConfig(this._config)
381 this._config = newCfg;
382 this.configSubject.next(Object.assign({}, this._config));
390 getSdks(serverID: string): Observable<ISdk[]> {
391 const svr = this._getServer(serverID);
392 if (!svr || !svr.connected) {
393 return Observable.of([]);
395 return this._get(svr.partialUrl + '/sdks');
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 });
402 abortInstall(serverID: string, id: string): Observable<ISdk> {
403 return this._post(this._getServerUrl(serverID) + '/sdks/abortinstall', { id: id });
406 removeSdk(serverID: string, id: string): Observable<ISdk> {
407 return this._delete(this._getServerUrl(serverID) + '/sdks/' + id);
414 getProjects(): Observable<IXDSProjectConfig[]> {
415 return this._get('/projects');
418 addProject(cfg: IXDSProjectConfig): Observable<IXDSProjectConfig> {
419 return this._post('/projects', cfg);
422 deleteProject(id: string): Observable<IXDSProjectConfig> {
423 return this._delete('/projects/' + id);
426 updateProject(cfg: IXDSProjectConfig): Observable<IXDSProjectConfig> {
427 return this._put('/projects/' + cfg.id, cfg);
430 syncProject(id: string): Observable<string> {
431 return this._post('/projects/sync/' + id, {});
437 exec(prjID: string, dir: string, cmd: string, sdkid?: string, args?: string[], env?: string[]): Observable<any> {
438 return this._post('/exec',
453 private _RegisterEvents() {
454 // Register to all existing events
455 this._post('/events/register', { 'name': 'event:all' })
459 this.alert.error('ERROR while registering to all events: ' + error);
464 private _getServer(ID: string): IXDServerCfg {
465 const svr = this._config.servers.filter(item => item.id === ID);
466 if (svr.length < 1) {
472 private _getServerUrl(serverID: string): string | ErrorObservable {
473 const svr = this._getServer(serverID);
474 if (!svr || !svr.connected) {
476 console.log('ERROR: XDS Server unknown: serverID=' + serverID);
478 return Observable.throw('Cannot identify XDS Server');
480 return svr.partialUrl;
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', '*');
491 options.headers = headers;
495 private _get(url: string): Observable<any> {
496 return this.http.get(this.baseUrl + url, this._attachAuthHeaders())
497 .catch(this._decodeError);
499 private _post(url: string, body: any): Observable<any> {
500 return this.http.post(this.baseUrl + url, JSON.stringify(body), this._attachAuthHeaders())
502 return this._decodeError(error);
505 private _put(url: string, body: any): Observable<any> {
506 return this.http.put(this.baseUrl + url, JSON.stringify(body), this._attachAuthHeaders())
508 return this._decodeError(error);
511 private _delete(url: string): Observable<any> {
512 return this.http.delete(this.baseUrl + url, this._attachAuthHeaders())
513 .catch(this._decodeError);
516 private _decodeError(err: any) {
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) {
523 } else if (err.error) {
524 e = String(err.error);
526 e = JSON.stringify(err);
529 e = err.message ? err.message : err.toString();
531 /* tslint:disable:no-console */
533 console.log('xdsagent.service - ERROR: ', e);
535 return Observable.throw(e);