@dronedeploy/rocos-js-sdk 0.0.1 → 1.0.0-alpha-2

package/api/streams/search/SearchStream.js

@@ -0,0 +1,96 @@
+import { DeleteProjectMessage, Empty } from '../../../grpc/slowlane_pb';
+import { RocosSearchMessage, SubscriberStatusEnum, } from '../../../models';
+import { Observable } from 'rxjs';
+import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
+import { RocosLogger } from '../../../logger/RocosLogger';
+import { SearchStreamAbstract } from './SearchStreamAbstract';
+import { streamClient } from '../../../grpc/slowlane_pb.client';
+export class SearchStream extends SearchStreamAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`SearchStream(${this.identifier})`);
+        const protocol = config.insecure ? 'http' : 'https';
+        const transport = new GrpcWebFetchTransport({
+            baseUrl: `${protocol}://${this.url}`,
+        });
+        this.client = new streamClient(transport);
+    }
+    searchStreamInternal(request, params) {
+        const metadata = this.getMetadata(params.projectId);
+        const abortController = new AbortController();
+        return new Observable((emitter) => {
+            const call = this.client.searchStream(request, { meta: metadata, abort: abortController.signal });
+            this.subscriberStatus = SubscriberStatusEnum.ALIVE;
+            this.statusStream$.next(this.subscriberStatus);
+            call.responses.onMessage((update) => {
+                const dataSetList = update.dataset;
+                const results = dataSetList.map((item) => {
+                    return RocosSearchMessage.fromMessage(item);
+                });
+                emitter.next(results);
+                this.logger.debug('searchStream - on(data)', {
+                    status: this.subscriberStatus,
+                    projectId: params.projectId,
+                    query: params.query,
+                });
+            });
+            call.responses.onComplete(() => {
+                this.subscriberStatus = SubscriberStatusEnum.STOPPED;
+                this.statusStream$.next(this.subscriberStatus);
+                this.logger.debug('searchStream - on(end)', {
+                    status: this.subscriberStatus,
+                    projectId: params.projectId,
+                    query: params.query,
+                });
+                emitter.complete();
+            });
+            call.responses.onError((error) => {
+                this.logger.debug('searchStream - on(error)', {
+                    status: this.subscriberStatus,
+                    projectId: params.projectId,
+                    query: params.query,
+                    error,
+                });
+                emitter.error(error);
+            });
+            return () => {
+                this.logger.debug('unsubscribing searchStream');
+                abortController.abort();
+            };
+        });
+    }
+    async queryDataInternal(request, params) {
+        const metadata = this.getMetadata(params.projectId);
+        const response = await this.client.queryData(request, { meta: metadata }).response;
+        if (!response) {
+            throw new Error('Error with search query.');
+        }
+        return response.result;
+    }
+    async healthCheckInternal(params) {
+        const request = Empty.create();
+        const metadata = this.getMetadata(params.projectId);
+        const response = await this.client.healthCheck(request, { meta: metadata }).response;
+        if (!response) {
+            throw new Error('Error with health check.');
+        }
+        return response;
+    }
+    async deleteProjectDataInternal(params) {
+        const request = DeleteProjectMessage.create({
+            projectId: params.projectId,
+        });
+        const metadata = this.getMetadata(params.projectId);
+        const response = await this.client.deleteProjectData(request, { meta: metadata }).response;
+        if (!response) {
+            throw new Error('Error with deleting project data.');
+        }
+        return response;
+    }
+    getMetadata(projectId) {
+        return {
+            'authorization': this.token,
+            'r-p': projectId,
+        };
+    }
+}

package/api/streams/search/SearchStreamAbstract.d.ts

@@ -0,0 +1,25 @@
+import { BehaviorSubject, Observable } from 'rxjs';
+import { QueryDSLMessage, QueryMessage } from '../../../grpc/slowlane_pb';
+import { IRocosSearchMessage, IRocosSearchStatusMessage, ISearchParams, ISearchQueryParams, ISearchStream, ISearchStreamParams, IStreamConfig, SubscriberStatusEnum } from '../../../models';
+import { Logger } from 'loglevel';
+export declare abstract class SearchStreamAbstract implements ISearchStream {
+    identifier: string;
+    statusStream$: BehaviorSubject<SubscriberStatusEnum>;
+    protected token: string;
+    private readonly scope;
+    protected url: string;
+    protected subscriberStatus: SubscriberStatusEnum;
+    protected logger: Logger;
+    protected constructor(config: IStreamConfig);
+    protected abstract searchStreamInternal(request: QueryMessage, params: ISearchStreamParams): Observable<IRocosSearchMessage[]>;
+    protected abstract queryDataInternal(request: QueryDSLMessage, params: ISearchQueryParams): Promise<string>;
+    protected abstract healthCheckInternal(params: ISearchParams): Promise<IRocosSearchStatusMessage>;
+    protected abstract deleteProjectDataInternal(params: ISearchParams): Promise<IRocosSearchStatusMessage>;
+    setToken(token: string): void;
+    stopStream(): void;
+    searchStream(params: ISearchStreamParams): Observable<IRocosSearchMessage[]>;
+    queryData(params: ISearchQueryParams): Promise<string>;
+    healthCheck(params: ISearchParams): Promise<IRocosSearchStatusMessage>;
+    deleteProjectData(params: ISearchParams): Promise<IRocosSearchStatusMessage>;
+    private convertToQueryMessage;
+}

package/api/streams/search/SearchStreamAbstract.js

@@ -0,0 +1,72 @@
+import { BehaviorSubject } from 'rxjs';
+import { Filter, QueryDSLMessage, QueryMessage } from '../../../grpc/slowlane_pb';
+import { SubscriberStatusEnum, } from '../../../models';
+import { IDENTIFIER_NAME_SEARCH } from '../../../constants/identifier';
+import { RocosStore } from '../../../store/RocosStore';
+import { StreamRegister } from '../../StreamRegister';
+import { filter } from 'rxjs/operators';
+export class SearchStreamAbstract {
+    constructor(config) {
+        this.subscriberStatus = SubscriberStatusEnum.STOPPED;
+        this.scope = config.scope;
+        this.identifier = StreamRegister.getIdentifier(IDENTIFIER_NAME_SEARCH, this.scope);
+        this.token = config.token;
+        this.url = config.url;
+        this.statusStream$ = new BehaviorSubject(SubscriberStatusEnum.STOPPED);
+        RocosStore.getChangeSubject()
+            .pipe(filter((message) => {
+            return message.type === 'token' && message.url === this.url;
+        }))
+            .subscribe((msg) => {
+            this.token = msg.data;
+        });
+    }
+    setToken(token) {
+        this.token = token;
+    }
+    stopStream() {
+        // do nothing for now
+    }
+    searchStream(params) {
+        const request = this.convertToQueryMessage(params.query);
+        return this.searchStreamInternal(request, params);
+    }
+    queryData(params) {
+        const request = QueryDSLMessage.create({
+            dSLQuery: params.query,
+            projectId: params.projectId,
+        });
+        return this.queryDataInternal(request, params);
+    }
+    healthCheck(params) {
+        return this.healthCheckInternal(params);
+    }
+    deleteProjectData(params) {
+        return this.deleteProjectDataInternal(params);
+    }
+    convertToQueryMessage(query) {
+        const filtersForSearching = query.filters.map((filter) => {
+            return Filter.create({
+                ids: filter.ids,
+                keyword: filter.keyword,
+            });
+        });
+        const reqMsg = QueryMessage.create({
+            filters: filtersForSearching,
+            groupByFields: query.groupByFields,
+            payloadIds: query.payloadIds,
+            startDate: `${query.startDate}`,
+            endDate: `${query.endDate}`,
+            interval: query.interval,
+            refreshDelay: BigInt(query.refreshDelay),
+            disableDateHistogram: query.disableDateHistogram ? 1n : 0n,
+        });
+        if (query.dateField) {
+            reqMsg.dateField = query.dateField;
+        }
+        if (query.projectId) {
+            reqMsg.projectId = query.projectId;
+        }
+        return reqMsg;
+    }
+}

package/api/streams/search/SearchStreamNode.d.ts

@@ -0,0 +1,13 @@
+import { QueryDSLMessage, QueryMessage } from '../../../grpc/slowlane_pb';
+import { IRocosSearchMessage, IRocosSearchStatusMessage, ISearchParams, ISearchQueryParams, ISearchStreamParams, IStreamConfig } from '../../../models';
+import { Observable } from 'rxjs';
+import { SearchStreamAbstract } from './SearchStreamAbstract';
+export declare class SearchStreamNode extends SearchStreamAbstract {
+    private client;
+    constructor(config: IStreamConfig);
+    protected searchStreamInternal(request: QueryMessage, params: ISearchStreamParams): Observable<IRocosSearchMessage[]>;
+    protected queryDataInternal(request: QueryDSLMessage, params: ISearchQueryParams): Promise<string>;
+    protected healthCheckInternal(params: ISearchParams): Promise<IRocosSearchStatusMessage>;
+    protected deleteProjectDataInternal(params: ISearchParams): Promise<IRocosSearchStatusMessage>;
+    private getMetadata;
+}

package/api/streams/search/SearchStreamNode.js

@@ -0,0 +1,118 @@
+import * as grpc from '@grpc/grpc-js';
+import { DeleteProjectMessage, Empty } from '../../../grpc/slowlane_pb';
+import { RocosSearchMessage, SubscriberStatusEnum, } from '../../../models';
+import { Observable } from 'rxjs';
+import { RocosLogger } from '../../../logger/RocosLogger';
+import { SearchStreamAbstract } from './SearchStreamAbstract';
+import { streamClient } from '../../../grpc/slowlane_pb.grpc-client';
+export class SearchStreamNode extends SearchStreamAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`SearchStreamNode(${this.identifier})`);
+        const port = config.port ?? 443;
+        const credentials = config.insecure ? grpc.credentials.createInsecure() : grpc.credentials.createSsl();
+        this.client = new streamClient(`${this.url}:${port}`, credentials);
+    }
+    searchStreamInternal(request, params) {
+        const metadata = this.getMetadata(params.projectId);
+        let call;
+        return new Observable((emitter) => {
+            call = this.client.searchStream(request, metadata);
+            this.subscriberStatus = SubscriberStatusEnum.ALIVE;
+            this.statusStream$.next(this.subscriberStatus);
+            call.on('data', (update) => {
+                const dataSetList = update.dataset;
+                const results = dataSetList.map((item) => {
+                    return RocosSearchMessage.fromMessage(item);
+                });
+                emitter.next(results);
+                this.logger.debug('searchStream - on(data)', {
+                    status: this.subscriberStatus,
+                    projectId: params.projectId,
+                    query: params.query,
+                });
+            });
+            call.on('end', () => {
+                this.subscriberStatus = SubscriberStatusEnum.STOPPED;
+                this.statusStream$.next(this.subscriberStatus);
+                this.logger.debug('searchStream - on(end)', {
+                    status: this.subscriberStatus,
+                    projectId: params.projectId,
+                    query: params.query,
+                });
+                emitter.complete();
+            });
+            call.on('close', () => {
+                this.subscriberStatus = SubscriberStatusEnum.STOPPED;
+                this.statusStream$.next(this.subscriberStatus);
+                this.logger.debug('searchStream - on(close)');
+            });
+            call.on('error', (error) => {
+                this.subscriberStatus = SubscriberStatusEnum.ERROR;
+                this.statusStream$.next(this.subscriberStatus);
+                this.logger.debug('searchStream - on(error)', error);
+                emitter.error(error);
+            });
+            return () => {
+                this.logger.debug('unsubscribing searchStream');
+                call.cancel();
+            };
+        });
+    }
+    queryDataInternal(request, params) {
+        const metadata = this.getMetadata(params.projectId);
+        return new Promise((resolve, reject) => {
+            this.client.queryData(request, metadata, (error, response) => {
+                if (error) {
+                    reject(error);
+                }
+                else if (response) {
+                    resolve(response.result);
+                }
+                else {
+                    reject('Error with search query.');
+                }
+            });
+        });
+    }
+    healthCheckInternal(params) {
+        const request = Empty.create();
+        const metadata = this.getMetadata(params.projectId);
+        return new Promise((resolve, reject) => {
+            this.client.healthCheck(request, metadata, (error, response) => {
+                if (error) {
+                    reject(error);
+                }
+                else if (response) {
+                    resolve(response);
+                }
+                else {
+                    reject('Error with health check.');
+                }
+            });
+        });
+    }
+    deleteProjectDataInternal(params) {
+        const request = DeleteProjectMessage.create({ projectId: params.projectId });
+        const metadata = this.getMetadata(params.projectId);
+        return new Promise((resolve, reject) => {
+            this.client.deleteProjectData(request, metadata, (error, response) => {
+                if (error) {
+                    reject(error);
+                }
+                else if (response) {
+                    resolve(response);
+                }
+                else {
+                    reject('Error with health check.');
+                }
+            });
+        });
+    }
+    getMetadata(projectId) {
+        const meta = new grpc.Metadata();
+        meta.add('authorization', this.token);
+        meta.add('r-p', projectId);
+        return meta;
+    }
+}

package/api/streams/telemetry/TelemetryStream.d.ts

@@ -0,0 +1,17 @@
+import { ITelemetryStreamConfig } from '../../../models';
+import { TelemetryAckStatus, TelemetryQueryRequest, TelemetryRequest } from '../../../grpc/teletubby_pb';
+import { TelemetryStreamAbstract } from './TelemetryStreamAbstract';
+export declare class TelemetryStream extends TelemetryStreamAbstract {
+    private client;
+    private abortController?;
+    constructor(config: ITelemetryStreamConfig);
+    protected stopInternal(): void;
+    protected registerReceiver(): () => void;
+    private onError;
+    private onEnd;
+    private getMetadata;
+    protected requestTelemetry(req: TelemetryRequest): Promise<void>;
+    protected requestTelemetryQuery(req: TelemetryQueryRequest): Promise<void>;
+    protected sendAcknowledgmentInternal(uid: string, status: TelemetryAckStatus, noRetry: boolean): boolean;
+    protected sendHeartbeat(): void;
+}

package/api/streams/telemetry/TelemetryStream.js

@@ -0,0 +1,97 @@
+import { SubscriberStatusEnum } from '../../../models';
+import { RegistrationMessage, } from '../../../grpc/teletubby_pb';
+import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
+import { RocosLogger } from '../../../logger/RocosLogger';
+import { TelemetryGatewayClient } from '../../../grpc/teletubby_pb.client';
+import { TelemetryStreamAbstract } from './TelemetryStreamAbstract';
+export class TelemetryStream extends TelemetryStreamAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`TelemetryStreamWeb(${this.identifier})`);
+        const protocol = config.insecure ? 'http' : 'https';
+        const transport = new GrpcWebFetchTransport({
+            baseUrl: `${protocol}://${this.url}`,
+        });
+        this.client = new TelemetryGatewayClient(transport);
+    }
+    stopInternal() {
+        if (this.abortController) {
+            this.logger.info('Starting stop stream process');
+            this.abortController.abort();
+            this.abortController = undefined;
+            this.logger.info('Finished stop stream process');
+        }
+    }
+    registerReceiver() {
+        this.logger.info('registerReceiver');
+        // Reset counter
+        this.receivedMessagesCount = 0;
+        const abortController = new AbortController();
+        this.abortController = abortController;
+        const call = this.client.registerReceiver(RegistrationMessage.create(), {
+            meta: this.getMetadata(this.projectId),
+            abort: abortController.signal,
+        });
+        call.responses.onMessage((msg) => {
+            this.onData(msg, false);
+        });
+        call.responses.onError((error) => {
+            void this.onError(error);
+            this.onEnd(false);
+        });
+        call.responses.onComplete(() => {
+            this.onEnd(true);
+        });
+        this.listenMessagesAndRenew();
+        return () => {
+            abortController.abort();
+        };
+    }
+    async onError(e) {
+        this.logger.error(`Telemetry Stream Error: ${e}, SubscriberId: ${this.subscriberId}`);
+        this.subscriberStatus = SubscriberStatusEnum.ERROR;
+        this.statusStream$.next(this.subscriberStatus);
+    }
+    onEnd(ok) {
+        this.logger.debug('registerReceiver', 'end');
+        if (ok) {
+            // ResourceExhausted
+            this.stopInternal();
+            this.registerReceiver();
+        }
+    }
+    getMetadata(projectId) {
+        const result = { authorization: this.token };
+        if (projectId) {
+            result['r-p'] = projectId;
+        }
+        return result;
+    }
+    async requestTelemetry(req) {
+        this.logger.debug('Sending telemetry request');
+        try {
+            await this.client.requestTelemetry(req, { meta: this.getMetadata(this.projectId) });
+        }
+        catch (e) {
+            this.logger.error('error requestTelemetry ', e);
+            throw e;
+        }
+    }
+    async requestTelemetryQuery(req) {
+        this.logger.debug('Requesting telemetry with query');
+        try {
+            await this.client.requestTelemetryQuery(req, { meta: this.getMetadata(this.projectId) });
+        }
+        catch (e) {
+            this.logger.error('error requestTelemetryQuery ', e);
+            throw e;
+        }
+    }
+    sendAcknowledgmentInternal(uid, status, noRetry) {
+        this.logger.error('Error can not send Acknowledgment on grpc-web client', { uid, status, noRetry });
+        return false;
+    }
+    sendHeartbeat() {
+        // can not send heartbeat on grpc-web
+    }
+}

package/api/streams/telemetry/TelemetryStreamAbstract.d.ts

@@ -0,0 +1,59 @@
+import { BehaviorSubject, Subject } from 'rxjs';
+import { IRocosTelemetryMessage, ITelemetryParams, ITelemetryStream, ITelemetryStreamConfig, SubscriberStatusEnum } from '../../../models';
+import { TelemetryAckStatus, TelemetryMessage, TelemetryQueryRequest, TelemetryRequest, TelemetryStreamMessage } from '../../../grpc/teletubby_pb';
+import { Logger } from 'loglevel';
+import { StreamHeartbeat } from '../../atoms/StreamHeartbeat';
+export declare abstract class TelemetryStreamAbstract implements ITelemetryStream {
+    messageStream$: Subject<IRocosTelemetryMessage>;
+    identifier: string;
+    statusStream$: BehaviorSubject<SubscriberStatusEnum>;
+    protected subscriberId?: string;
+    protected projectId: string;
+    private callsignsLookup;
+    private sources;
+    protected token: string;
+    private scope;
+    protected url: string;
+    private timerIntervalInSec;
+    protected subscriberStatus: SubscriberStatusEnum;
+    private checkerStartedAt?;
+    private lastRobotMessageReceived?;
+    private messagesTimer?;
+    private lastMessageReceived?;
+    private retryTimes;
+    private options;
+    protected receivedMessagesCount: number;
+    protected logger: Logger;
+    protected heartbeat: StreamHeartbeat;
+    private sendHeartbeatTime;
+    private receivedDataStats;
+    private subscriptions;
+    constructor(config: ITelemetryStreamConfig);
+    protected abstract stopInternal(): void;
+    protected abstract registerReceiver(): () => void;
+    protected abstract requestTelemetryQuery(req: TelemetryQueryRequest): Promise<void>;
+    protected abstract requestTelemetry(req: TelemetryRequest): Promise<void>;
+    protected abstract sendAcknowledgmentInternal(uid: string, status: TelemetryAckStatus, noRetry: boolean): boolean;
+    protected abstract sendHeartbeat(): void;
+    setToken(token: string): void;
+    init(): void;
+    stopStream(): void;
+    addSubscription(params: ITelemetryParams): void;
+    removeSubscription(params: ITelemetryParams, terminateReceiverGroup?: boolean): Promise<void>;
+    sendAcknowledgment(uid: string, status: TelemetryAckStatus, noRetry: boolean): boolean;
+    private getSubscriptions;
+    protected onData(message: TelemetryStreamMessage, isStream: true): void;
+    protected onData(message: TelemetryMessage, isStream: false): void;
+    private takeTelemetryAction;
+    protected listenMessagesAndRenew(): void;
+    private addTerminateToAction;
+    private messageTimeoutTryAgain;
+    /**
+     * Auto resubscribe to reduce CPU usage.
+     */
+    private autoResubscribe;
+    private isFoundCallsign;
+    private isFoundSource;
+    private isRegisteredMessage;
+    private updateReceivedDataStatsWithMessage;
+}