@dronedeploy/rocos-js-sdk 3.0.1-alpha.2 → 3.0.1-alpha.21

package/services/TelemetryService.js

@@ -1,142 +0,0 @@
-import { BehaviorSubject, catchError, combineLatest, distinctUntilChanged, from, interval, map, mergeAll, of, startWith, } from 'rxjs';
-import { CallsignsLookup, CallsignsLookupType, CallsignStatus, errorCodes, RocosError, SubscriberStatusEnum, } from '../models';
-import { filter, finalize } from 'rxjs/operators';
-import { BaseStreamService } from './BaseStreamService';
-import { IDENTIFIER_NAME_TELEMETRY } from '../constants/identifier';
-import { RocosStore } from '../store/RocosStore';
-import { TelemetryStream } from '../api/streams/telemetry/TelemetryStream';
-import { arrayUnique } from '../helpers/arrayUnique';
-import { getUniqueId } from '../helpers/getUniqueId';
-const HEARTBEAT_SOURCE = '/rocos/agent/telemetry/heartbeat';
-const HEARTBEAT_TIMEOUT = 5000; // if no heartbeat within 5 seconds then the robot is considered dead
-export class TelemetryService extends BaseStreamService {
-    constructor(config) {
-        super('TelemetryService', config);
-        this.changeStream$ = new BehaviorSubject(new Map());
-        RocosStore.getChangeSubject()
-            .pipe(filter((message) => {
-            return message.type === 'telemetry-subscription' && message.url === this.config.url;
-        }))
-            .subscribe((msg) => {
-            this.changeStream$.next(msg.data);
-        });
-        this.streamStatusSubject$ = new BehaviorSubject({
-            scope: 'default',
-            status: SubscriberStatusEnum.STOPPED,
-        });
-    }
-    /**
-     * The main method for subscribing to telemetry messages
-     *
-     * @param params - Subscription params
-     *
-     * @returns An Observable that outputs telemetry messages
-     */
-    subscribe(params) {
-        const sources = arrayUnique(params.sources).map((item) => item.trim()) ?? [];
-        if (!params?.callsigns && params?.query) {
-            this.logger.error('Error: params need to contain either callsigns or query', params);
-            throw new RocosError('Params need to contain either callsigns or query.', errorCodes.TELEMETRY_SERVICE_ERROR);
-        }
-        let callsignsLookup = new CallsignsLookup([]);
-        if (params?.callsigns) {
-            this.logger.info('subscribe with callsigns', params);
-            callsignsLookup = new CallsignsLookup(params.callsigns);
-        }
-        else if (params?.query) {
-            this.logger.info('subscribe with query', params);
-            callsignsLookup = new CallsignsLookup(params.query);
-        }
-        const scope = params.scope ?? 'default';
-        const callsigns = callsignsLookup.lookupValue;
-        const subscriptionParams = {
-            uniqueId: getUniqueId(params.projectId, callsignsLookup, sources, scope),
-            callsigns: callsignsLookup?.lookupType === CallsignsLookupType.List ? callsignsLookup.lookupValue : [],
-            sources,
-        };
-        const stream = this.createStream(params.projectId, callsignsLookup, sources, scope).then((stream) => {
-            stream.addSubscription(subscriptionParams);
-            if (!this.statusSubscription) {
-                this.statusSubscription = stream.statusStream$.subscribe((msg) => {
-                    this.status = msg === SubscriberStatusEnum.STOPPED || msg === SubscriberStatusEnum.ALIVE;
-                    this.status$.next(msg);
-                });
-            }
-            return from(stream.messageStream$).pipe(finalize(() => stream?.removeSubscription(subscriptionParams, params.terminateReceiverGroupOnUnsubscribe)));
-        });
-        return from(stream).pipe(mergeAll(), filter((message) => {
-            return callsigns.includes(message.callsign) && sources.includes(message.source);
-        }));
-    }
-    /**
-     * A method to keep track of the current subscriptions
-     *
-     * @returns An Observable that outputs subscription changes
-     */
-    getSubscriptionChanges() {
-        return this.changeStream$.asObservable();
-    }
-    /**
-     * A method to keep track of the stream status
-     *
-     * @returns An Observable that outputs stream status
-     */
-    getStatusChanges() {
-        return this.streamStatusSubject$.asObservable();
-    }
-    /**
-     * Subscribes to the heartbeat telemetry and checks we receive one at least every 5s
-     * @param projectId
-     * @param callsign
-     * @param heartbeatTimeoutMs optionally override the deadline for heartbeats (in ms). Default 5000ms
-     * @param intervalMs optionally override the interval to check for heartbeats (in ms). Default 2000ms
-     */
-    getRobotStatusChanges(projectId, callsign, heartbeatTimeoutMs = HEARTBEAT_TIMEOUT, intervalMs = 2000) {
-        const startedAt = Date.now();
-        const heartbeatTime$ = this.subscribe({
-            projectId,
-            sources: [HEARTBEAT_SOURCE],
-            callsigns: [callsign],
-        }).pipe(map(() => Date.now()));
-        return combineLatest([heartbeatTime$.pipe(startWith(startedAt)), interval(intervalMs)]).pipe(map(([lastHeartbeat, _]) => {
-            const now = Date.now();
-            // If we haven't received a heartbeat, but we've only just started
-            if (lastHeartbeat === startedAt && now - startedAt <= heartbeatTimeoutMs) {
-                return CallsignStatus.UNKNOWN;
-            }
-            if (now - lastHeartbeat > heartbeatTimeoutMs) {
-                return CallsignStatus.OFFLINE;
-            }
-            return CallsignStatus.ONLINE;
-        }), startWith(CallsignStatus.UNKNOWN), distinctUntilChanged(), catchError(() => of(CallsignStatus.ERROR)));
-    }
-    async initStream(stream) {
-        await super.initStream(stream);
-        stream.init();
-    }
-    async createStream(projectId, callsignsLookup, sources, scope) {
-        const newStream = await this.createStreamFromConfig(IDENTIFIER_NAME_TELEMETRY, {
-            url: this.config.url,
-            projectId,
-            callsignsLookup,
-            sources,
-            token: this.config.token,
-            scope: scope ?? 'default',
-            options: this.config.options,
-            port: this.config.port,
-            insecure: this.config.insecure,
-        });
-        if (!newStream.isNew) {
-            newStream.stream.statusStream$.subscribe((msg) => {
-                this.streamStatusSubject$.next({
-                    scope,
-                    status: msg,
-                });
-            });
-        }
-        return newStream.stream;
-    }
-    getStream(config) {
-        return new TelemetryStream(config);
-    }
-}

package/services/TelemetryService.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/services/TelemetryService.spec.js

@@ -1,37 +0,0 @@
-import { CallsignStatus } from '../models';
-import { NEVER, delay, from, lastValueFrom, take, throwError } from 'rxjs';
-import { TelemetryService } from './TelemetryService';
-describe('TelemetryService', () => {
-    describe('getRobotStatusChanges', () => {
-        it('should emit unknown to begin with', async () => {
-            const service = new TelemetryService({ url: '', token: '' });
-            // Mock 5 heartbeat messages
-            jest.spyOn(service, 'subscribe').mockReturnValue(NEVER);
-            const lastValue = await lastValueFrom(service.getRobotStatusChanges('project', 'callsign').pipe(take(1)));
-            expect(lastValue).toEqual(CallsignStatus.UNKNOWN);
-        });
-        it('should emit online if the robot emits a heartbeat', async () => {
-            const service = new TelemetryService({ url: '', token: '' });
-            // Mock 5 heartbeat messages
-            jest
-                .spyOn(service, 'subscribe')
-                .mockReturnValue(from([0, 1, 2, 3, 4]).pipe(delay(100)));
-            const lastValue = await lastValueFrom(service.getRobotStatusChanges('project', 'callsign', 1000, 10).pipe(take(2)));
-            expect(lastValue).toEqual(CallsignStatus.ONLINE);
-        }, 10000);
-        it('should emit offline if the robot never emits', async () => {
-            const service = new TelemetryService({ url: '', token: '' });
-            // Mock 5 heartbeat messages
-            jest.spyOn(service, 'subscribe').mockReturnValue(NEVER);
-            const lastValue = await lastValueFrom(service.getRobotStatusChanges('project', 'callsign', 100, 10).pipe(take(2)));
-            expect(lastValue).toEqual(CallsignStatus.OFFLINE);
-        });
-        it('should emit an error if the telemetry errors', async () => {
-            const service = new TelemetryService({ url: '', token: '' });
-            // Mock 5 heartbeat messages
-            jest.spyOn(service, 'subscribe').mockReturnValue(throwError(() => new Error('test')));
-            const lastValue = await lastValueFrom(service.getRobotStatusChanges('project', 'callsign', 100, 10).pipe(take(2)));
-            expect(lastValue).toEqual(CallsignStatus.ERROR);
-        });
-    });
-});

package/services/WorkflowService.d.ts

@@ -1,71 +0,0 @@
-import { RocosError } from '../models/RocosError';
-import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { IBaseService } from '../models/IBaseService';
-import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
-export declare class WorkflowService extends BaseServiceAbstract implements IBaseService {
-    constructor(config: IRocosSDKConfig);
-    protected getError(e: Error): RocosError;
-    getStatus(): boolean;
-    /**
-     * Create workflow
-     *
-     * @param projectId - Project Id
-     * @param model - Payload
-     */
-    createOne(projectId: string, model: any): Promise<any>;
-    /**
-     * Get workflows for project
-     *
-     * @param projectId - Project Id
-     * @param includeRocosGraph - Include Rocos graph
-     * @param includeStats - Include stats
-     * @param opsId - Ops Id
-     * @param workflowIds - Workflow Id's
-     */
-    getAll(projectId: string, includeRocosGraph?: boolean, includeStats?: boolean, opsId?: string, workflowIds?: string[]): Promise<any>;
-    /**
-     * Get a workflow
-     *
-     * @param projectId - Project Id
-     * @param workflowId - Workflow Id
-     * @param includeInstances - Include instances
-     */
-    getOne(projectId: string, workflowId: string, includeInstances?: boolean): Promise<any>;
-    /**
-     * Update a workflow
-     *
-     * @param projectId - Project Id
-     * @param workflowId - Workflow Id
-     * @param model - Payload
-     */
-    updateOne(projectId: string, workflowId: string, model: any): Promise<any>;
-    /**
-     * Delete a workflow
-     *
-     * @param projectId - Project Id
-     * @param workflowId - Workflow Id
-     */
-    deleteOne(projectId: string, workflowId: string): Promise<any>;
-    /**
-     * Get all workflows for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    getAllOfRobot(projectId: string, callsign: string): Promise<any>;
-    /**
-     * Update workflows for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - Payload
-     */
-    updateAllForRobot(projectId: string, callsign: string, model: any): Promise<any>;
-    /**
-     * Get deployed workflows on robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    getDeployedOnRobot(projectId: string, callsign: string): Promise<any>;
-}

package/services/WorkflowService.js

@@ -1,118 +0,0 @@
-import { API_PROJECT_CALLSIGN_WORKFLOW_URL, API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_URL, API_PROJECT_WORKFLOW_ID_URL, API_PROJECT_WORKFLOW_URL, } from '../constants/api';
-import { RocosError, errorCodes } from '../models/RocosError';
-import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { RocosLogger } from '../logger/RocosLogger';
-import { formatServiceUrl } from '../helpers/formatServiceUrl';
-export class WorkflowService extends BaseServiceAbstract {
-    constructor(config) {
-        super(config);
-        this.logger = RocosLogger.getInstance(`WorkflowService(${this.config.url})`);
-    }
-    getError(e) {
-        return new RocosError(e, errorCodes.WORKFLOW_SERVICE_ERROR);
-    }
-    getStatus() {
-        return true;
-    }
-    /**
-     * Create workflow
-     *
-     * @param projectId - Project Id
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async createOne(projectId, model) {
-        return this.callPut(formatServiceUrl(API_PROJECT_WORKFLOW_URL, { url: this.config.url, projectId }, this.config.insecure), model, `Failed to create workflow for ${projectId}.`);
-    }
-    /**
-     * Get workflows for project
-     *
-     * @param projectId - Project Id
-     * @param includeRocosGraph - Include Rocos graph
-     * @param includeStats - Include stats
-     * @param opsId - Ops Id
-     * @param workflowIds - Workflow Id's
-     */
-    // TODO: map the response object
-    async getAll(projectId, includeRocosGraph = false, includeStats = false, opsId, workflowIds) {
-        const params = {
-            includeRocosGraph: includeRocosGraph ? 1 : 0,
-            includeStats: includeStats ? 1 : 0,
-        };
-        if (opsId) {
-            params.opsId = opsId;
-        }
-        if (workflowIds) {
-            params.workflowIds = workflowIds.join(',');
-        }
-        return this.callGet(formatServiceUrl(API_PROJECT_WORKFLOW_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get workflows for ${projectId}.`, params);
-    }
-    /**
-     * Get a workflow
-     *
-     * @param projectId - Project Id
-     * @param workflowId - Workflow Id
-     * @param includeInstances - Include instances
-     */
-    // TODO: map the response object
-    async getOne(projectId, workflowId, includeInstances = false) {
-        return this.callGet(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), `Failed to get workflow for ${projectId}, workflowId ${workflowId}.`, { includeInstances: includeInstances ? 1 : 0 });
-    }
-    /**
-     * Update a workflow
-     *
-     * @param projectId - Project Id
-     * @param workflowId - Workflow Id
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateOne(projectId, workflowId, model) {
-        return this.callPut(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), model, `Failed to update workflow for ${projectId}, workflowId ${workflowId}.`);
-    }
-    /**
-     * Delete a workflow
-     *
-     * @param projectId - Project Id
-     * @param workflowId - Workflow Id
-     */
-    // TODO: map the response object
-    async deleteOne(projectId, workflowId) {
-        return this.callDelete(formatServiceUrl(API_PROJECT_WORKFLOW_ID_URL, { url: this.config.url, projectId, workflowId }, this.config.insecure), `Failed to delete workflow for ${projectId}, workflowId ${workflowId}.`);
-    }
-    /**
-     * Get all workflows for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    // TODO: map the response object
-    async getAllOfRobot(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_CALLSIGN_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get workflows for ${projectId}, callsign ${callsign}.`);
-    }
-    /**
-     * Update workflows for a robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     * @param model - Payload
-     */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async updateAllForRobot(projectId, callsign, model) {
-        return this.callPut(formatServiceUrl(API_PROJECT_CALLSIGN_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), model, `Failed to update workflows for ${projectId}, callsign ${callsign}.`);
-    }
-    /**
-     * Get deployed workflows on robot
-     *
-     * @param projectId - Project Id
-     * @param callsign - Robot callsign
-     */
-    async getDeployedOnRobot(projectId, callsign) {
-        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_DEPLOYED_WORKFLOW_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to update workflows for ${projectId}, callsign ${callsign}.`);
-    }
-}

package/services/index.d.ts

@@ -1,27 +0,0 @@
-export * from './AssetStorageService';
-export * from './AuthService';
-export * from './CallerService';
-export * from './CommandService';
-export * from './ConfigGroupService';
-export * from './ControlService';
-export * from './DashboardService';
-export * from './EventService';
-export * from './FileAccessorService';
-export * from './FunctionService';
-export * from './IntegrationService';
-export * from './ProfileService';
-export * from './ProjectService';
-export * from './RobotService';
-export * from './SearchService';
-export * from './StreamService';
-export * from './TelemetryService';
-export * from './UserService';
-export * from './WebRTCSignallingService';
-export * from './WorkflowService';
-export * from './ScheduleService';
-export * from './TimeSyncerService';
-export * from './PlatformTimeService';
-export * from './SpotProvisioningService';
-export * from './SpotProvisioningServiceNode';
-export * from './MapService';
-export * from './EvaluatorService';

package/services/index.js

@@ -1,27 +0,0 @@
-export * from './AssetStorageService';
-export * from './AuthService';
-export * from './CallerService';
-export * from './CommandService';
-export * from './ConfigGroupService';
-export * from './ControlService';
-export * from './DashboardService';
-export * from './EventService';
-export * from './FileAccessorService';
-export * from './FunctionService';
-export * from './IntegrationService';
-export * from './ProfileService';
-export * from './ProjectService';
-export * from './RobotService';
-export * from './SearchService';
-export * from './StreamService';
-export * from './TelemetryService';
-export * from './UserService';
-export * from './WebRTCSignallingService';
-export * from './WorkflowService';
-export * from './ScheduleService';
-export * from './TimeSyncerService';
-export * from './PlatformTimeService';
-export * from './SpotProvisioningService';
-export * from './SpotProvisioningServiceNode';
-export * from './MapService';
-export * from './EvaluatorService';

package/store/RocosStore.d.ts

@@ -1,31 +0,0 @@
-import { IRocosChangeMessage } from '../models/message/IRocosChangeMessage';
-import { IRocosSDK } from '../IRocosSDK';
-import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
-import { Subject } from 'rxjs';
-export declare class RocosStore {
-    private static changeSubject$?;
-    protected static instances: Record<string, IRocosSDK>;
-    /**
-     * A static method to get the change subject.
-     */
-    static getChangeSubject(): Subject<IRocosChangeMessage>;
-    /**
-     * A static method to get the SDK instance from instance register.
-     *
-     * @param config - SDK config {@link IRocosSDKConfig}
-     */
-    static getSDKInstance(config: IRocosSDKConfig): IRocosSDK;
-    /**
-     * A static method to put the SDK instance from instance register.
-     *
-     * @param config - SDK config {@link IRocosSDKConfig}
-     * @param instance - SDK instance {@link IRocosSDK}
-     */
-    static putSDKInstance(config: IRocosSDKConfig, instance: IRocosSDK): void;
-    /**
-     * A static method to remove the SDK instance from instance register.
-     *
-     * @param config - SDK config {@link IRocosSDKConfig}
-     */
-    static removeSDKInstance(config: IRocosSDKConfig): void;
-}