mobility-toolbox-js 2.3.10 → 2.4.0

package/src/common/api/WebSocketAPI.ts

@@ -1,515 +0,0 @@
-import { RealtimeTrajectoryResponse } from '../../types';
-
-export declare type WebSocketAPIParameters = {
-  channel?: string;
-  args?: string | number;
-  id?: string | number;
-};
-
-export declare type WebSocketAPIMessageEventData<T> = {
-  timestamp: number;
-  source: string;
-  content: T;
-  // | T
-  // | string
-  // | Feature
-  // | RealtimeTrajectoryResponse[]
-  // | RealtimeDeparture
-  // | RealtimeNews[]
-  // | RealtimeStation
-  // | RealtimeExtraGeom
-  // | RealtimeTrajectory
-  // | RealtimeStopSequence[]
-  // | RealtimeFullTrajectory;
-  client_reference: string | number | null;
-};
-
-export type WebSocketAPIBufferMessageEventData = WebSocketAPIMessageEventData<
-  RealtimeTrajectoryResponse[]
-> & {
-  source: 'buffer';
-};
-
-export type WebSocketAPIMessageEvent = Event & {
-  data: string;
-};
-
-export interface WebSocketAPIMessageEventListener {
-  (evt: WebSocketAPIMessageEvent): void;
-}
-
-/**
- * This type represents a function that has been call with each feature returned by the websocket.
- */
-export interface WebSocketAPIMessageCallback<T> {
-  (data: WebSocketAPIMessageEventData<T>): void;
-}
-
-export declare type WebSocketAPISubscription = {
-  params: WebSocketAPIParameters;
-  cb: WebSocketAPIMessageCallback<any>;
-  errorCb?: EventListener;
-  onMessageCb: WebSocketAPIMessageEventListener;
-  onErrorCb?: EventListener;
-  quiet: boolean;
-};
-
-export declare type WebSocketAPISubscribed = {
-  [index: string]: boolean;
-};
-
-export declare type WebSocketAPIRequest = {
-  params: WebSocketAPIParameters;
-  cb: WebSocketAPIMessageCallback<any>;
-  errorCb?: EventListener;
-  onMessageCb: WebSocketAPIMessageEventListener;
-  onErrorCb?: EventListener;
-  requestString: String;
-};
-/**
- * Class used to facilitate connection to a WebSocketAPI and
- * also to manage properly messages send to the WebSocketAPI.
- * This class must not contain any specific implementation.
- */
-class WebSocketAPI {
-  websocket?: WebSocket;
-
-  closed?: boolean;
-
-  closing?: boolean;
-
-  connecting?: boolean;
-
-  open?: boolean;
-
-  messagesOnOpen!: Array<string>;
-
-  subscriptions!: Array<WebSocketAPISubscription>;
-
-  subscribed!: WebSocketAPISubscribed;
-
-  requests!: Array<WebSocketAPIRequest>;
-
-  constructor() {
-    this.defineProperties();
-  }
-
-  defineProperties() {
-    Object.defineProperties(this, {
-      closed: {
-        get: () =>
-          !!(
-            !this.websocket ||
-            this.websocket.readyState === this.websocket.CLOSED
-          ),
-      },
-      closing: {
-        get: () =>
-          !!(
-            this.websocket &&
-            this.websocket.readyState === this.websocket.CLOSING
-          ),
-      },
-      connecting: {
-        get: () =>
-          !!(
-            this.websocket &&
-            this.websocket.readyState === this.websocket.CONNECTING
-          ),
-      },
-      open: {
-        get: () =>
-          !!(
-            this.websocket && this.websocket.readyState === this.websocket.OPEN
-          ),
-      },
-      /**
-       * Array of message to send on open.
-       * @type {Array<string>}
-       * @private
-       */
-      messagesOnOpen: {
-        value: [],
-        writable: true,
-      },
-      /**
-       * Array of subscriptions.
-       * @type {Array<WebSocketSubscription>}
-       * @private
-       */
-      subscriptions: {
-        value: [],
-        writable: true,
-      },
-
-      /**
-       * List of channels subscribed.
-       * @type {WebSocketSubscribed}
-       * @private
-       */
-      subscribed: {
-        value: {},
-        writable: true,
-      },
-    });
-  }
-
-  /**
-   * Get the websocket request string.
-   *
-   * @param {string} method Request mehtod {GET, SUB}.
-   * @param {WebSocketParameters} params Request parameters.
-   * @param {string} params.channel Channel name
-   * @param {string} [params.args] Request arguments
-   * @param {Number|string} [params.id] Request identifier
-   * @return {string} request string
-   * @private
-   */
-  static getRequestString(method: string, params: WebSocketAPIParameters = {}) {
-    let reqStr = `${method} ${params.channel}`;
-    reqStr += params.args ? ` ${params.args}` : '';
-    reqStr += params.id ? ` ${params.id}` : '';
-    return reqStr.trim();
-  }
-
-  /**
-   * (Re)connect the websocket.
-   *
-   * @param {string} url Websocket url.
-   * @param {function} onOpen Callback called when the websocket connection is opened and before subscriptions of previous subscriptions.
-   * @private
-   */
-  connect(url: string, onOpen = () => {}) {
-    // if no url specify, close the current websocket and do nothing.
-    if (!url) {
-      this.websocket?.close();
-      return;
-    }
-
-    // Behavior when a websocket already exists.
-    if (this.websocket) {
-      // If the current websocket has the same url and is open or is connecting, do nothing.
-      if (this.websocket.url === url && (this.open || this.connecting)) {
-        return;
-      }
-
-      // If the current websocket has not the same url and is open or is connecting, close it.
-      if (this.websocket.url !== url && (this.open || this.connecting)) {
-        this.websocket.close();
-      }
-    }
-
-    /** @private */
-    this.websocket = new WebSocket(url);
-
-    if (!this.open) {
-      this.websocket.addEventListener('open', () => {
-        onOpen();
-        this.subscribePreviousSubscriptions();
-      });
-    } else {
-      onOpen();
-      this.subscribePreviousSubscriptions();
-    }
-  }
-
-  /**
-   * Close the websocket definitively.
-   *
-   * @private
-   */
-  close() {
-    if (this.websocket && (this.open || this.connecting)) {
-      this.websocket.onclose = () => {};
-      this.websocket.close();
-      this.messagesOnOpen = [];
-    }
-  }
-
-  /**
-   * Sends a message to the websocket.
-   *
-   * @param {message} message Message to send.
-   * @private
-   */
-  send(message: string) {
-    if (!this.websocket || this.closed || this.closing) {
-      return;
-    }
-    const send = () => {
-      this.websocket?.send(message);
-    };
-    if (!this.open) {
-      // This 'if' avoid sending 2 identical BBOX message on open,
-      if (!this.messagesOnOpen.includes(message)) {
-        this.messagesOnOpen.push(message);
-        this.websocket.addEventListener('open', () => {
-          this.messagesOnOpen = [];
-          send();
-        });
-        this.websocket.addEventListener('close', () => {
-          this.messagesOnOpen = [];
-        });
-      }
-    } else if (!this.messagesOnOpen.includes(message)) {
-      send();
-    }
-  }
-
-  addEvents(
-    onMessage: WebSocketAPIMessageEventListener,
-    onError?: EventListener,
-  ) {
-    if (this.websocket) {
-      this.websocket.addEventListener('message', onMessage);
-
-      if (onError) {
-        this.websocket.addEventListener('error', onError);
-        this.websocket.addEventListener('close', onError);
-      }
-    }
-  }
-
-  removeEvents(
-    onMessage: WebSocketAPIMessageEventListener,
-    onError?: EventListener,
-  ) {
-    if (this.websocket) {
-      this.websocket.removeEventListener('message', onMessage);
-
-      if (onError) {
-        this.websocket.removeEventListener('error', onError);
-        this.websocket.removeEventListener('close', onError);
-      }
-    }
-  }
-
-  /**
-   * Listen to websocket messages.
-   *
-   * @param {WebSocketParameters} params Parameters for the websocket get request
-   * @param {function} cb callback on listen
-   * @param {function} errorCb Callback on error
-   * @return {{onMessage: function, errorCb: function}} Object with onMessage and error callbacks
-   * @private
-   */
-  listen(
-    params: WebSocketAPIParameters,
-    cb: WebSocketAPIMessageCallback<any>,
-    errorCb?: EventListener,
-  ): {
-    onMessageCb: WebSocketAPIMessageEventListener;
-    onErrorCb?: EventListener;
-  } {
-    // Remove the previous identical callback
-    this.unlisten(params, cb);
-
-    // We wrap the message callback to be sure we only propagate the message if it is for the right channel.
-    const onMessage: WebSocketAPIMessageEventListener = (
-      evt: WebSocketAPIMessageEvent,
-    ) => {
-      let data: WebSocketAPIMessageEventData<any>;
-      try {
-        data = JSON.parse(evt.data);
-      } catch (err) {
-        // eslint-disable-next-line no-console
-        console.error('WebSocket: unable to parse JSON data', err, evt.data);
-        return;
-      }
-      let source = params.channel;
-      source += params.args ? ` ${params.args}` : '';
-
-      // Buffer channel message return a list of other channels to propagate to proper callbacks.
-      let contents: Array<WebSocketAPIMessageEventData<any>>;
-
-      if (data.source === 'buffer') {
-        contents = (data as unknown as WebSocketAPIBufferMessageEventData)
-          .content;
-      } else {
-        contents = [data];
-      }
-      contents.forEach((content: WebSocketAPIMessageEventData<any>) => {
-        // Because of backend optimization, the last content is null.
-        if (
-          content?.source === source &&
-          (!params.id || params.id === data.client_reference)
-        ) {
-          cb(content);
-        }
-      });
-    };
-
-    this.addEvents(onMessage, errorCb);
-
-    return { onMessageCb: onMessage, onErrorCb: errorCb };
-  }
-
-  /**
-   * Unlisten websocket messages.
-   *
-   * @param {Object} params Parameters for the websocket get request.
-   * @param {function} cb Callback used when listen.
-   * @private
-   */
-  unlisten(
-    params: WebSocketAPIParameters,
-    cb: WebSocketAPIMessageCallback<any>,
-  ) {
-    [...(this.subscriptions || []), ...(this.requests || [])]
-      .filter(
-        (s) => s.params.channel === params.channel && (!cb || s.cb === cb),
-      )
-      .forEach(({ onMessageCb, onErrorCb }) => {
-        this.removeEvents(onMessageCb, onErrorCb);
-      });
-  }
-
-  /**
-   * Sends a get request to the websocket.
-   * The callback is called only once, when the response is received or when the call returns an error.
-   *
-   * @param {Object} params Parameters for the websocket get request
-   * @param {function} onMessage callback on message event
-   * @param {function} onError Callback on error and close event
-   * @private
-   */
-  get(
-    params: WebSocketAPIParameters,
-    cb: WebSocketAPIMessageCallback<any>,
-    errorCb?: EventListener,
-  ) {
-    const requestString = WebSocketAPI.getRequestString('GET', params);
-    this.send(requestString);
-
-    // We wrap the callbacks to make sure they are called only once.
-    const once =
-      (callback: WebSocketAPIMessageCallback<any> | EventListener) =>
-      // @ts-ignore: Spread error
-      (...args) => {
-        // @ts-ignore: Spread error
-        callback(...args);
-        const index = this.requests.findIndex(
-          (request) =>
-            requestString === request.requestString && cb === request.cb,
-        );
-        const { onMessageCb, onErrorCb } = this.requests[index];
-        this.removeEvents(onMessageCb, onErrorCb);
-        this.requests.splice(index, 1);
-      };
-
-    const { onMessageCb, onErrorCb } = this.listen(
-      params,
-      once(cb),
-      errorCb && once(errorCb),
-    );
-
-    // Store requests and callbacks to be able to remove them.
-    if (!this.requests) {
-      this.requests = [];
-    }
-    const index = this.requests.findIndex(
-      (request) => requestString === request.requestString && cb === request.cb,
-    );
-    const newReq = {
-      params,
-      requestString,
-      cb,
-      errorCb,
-      onMessageCb,
-      onErrorCb,
-    };
-    if (index > -1) {
-      this.requests[index] = newReq;
-    } else {
-      this.requests.push(newReq);
-    }
-  }
-
-  /**
-   * Subscribe to a given channel.
-   *
-   * @param {Object} params Parameters for the websocket get request
-   * @param {function} cb callback on listen
-   * @param {function} errorCb Callback on error
-   * @param {boolean} quiet if false, no GET or SUB requests are send, only the callback is registered.
-   * @private
-   */
-  subscribe(
-    params: WebSocketAPIParameters,
-    cb: WebSocketAPIMessageCallback<any>,
-    errorCb?: EventListener,
-    quiet = false,
-  ) {
-    const { onMessageCb, onErrorCb } = this.listen(params, cb, errorCb);
-    const reqStr = WebSocketAPI.getRequestString('', params);
-
-    const index = this.subscriptions.findIndex(
-      (subcr) => params.channel === subcr.params.channel && cb === subcr.cb,
-    );
-    const newSubscr = { params, cb, errorCb, onMessageCb, onErrorCb, quiet };
-    if (index > -1) {
-      this.subscriptions[index] = newSubscr;
-    } else {
-      this.subscriptions.push(newSubscr);
-    }
-
-    if (!this.subscribed[reqStr]) {
-      if (!newSubscr.quiet) {
-        this.send(`GET ${reqStr}`);
-        this.send(`SUB ${reqStr}`);
-      }
-      this.subscribed[reqStr] = true;
-    }
-  }
-
-  /**
-   * Unsubscribe from a channel.
-   * @param {string} source source to unsubscribe from
-   * @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
-   * @private
-   */
-  unsubscribe(source: string, cb?: WebSocketAPIMessageCallback<any>) {
-    const toRemove = this.subscriptions.filter(
-      (s) => s.params.channel === source && (!cb || s.cb === cb),
-    );
-
-    toRemove.forEach(({ onMessageCb, onErrorCb }) => {
-      this.removeEvents(onMessageCb, onErrorCb);
-    });
-
-    this.subscriptions = this.subscriptions.filter(
-      (s) => s.params.channel !== source || (cb && s.cb !== cb),
-    );
-
-    // If there is no more subscriptions to this channel, and the removed subscriptions didn't register quietly,
-    // we DEL it.
-    if (
-      source &&
-      this.subscribed[source] &&
-      !this.subscriptions.find((s) => s.params.channel === source) &&
-      toRemove.find((subscr) => !subscr.quiet)
-    ) {
-      this.send(`DEL ${source}`);
-      this.subscribed[source] = false;
-    }
-  }
-
-  /**
-   * After an auto reconnection we need to re-subscribe to the channels.
-   */
-  subscribePreviousSubscriptions() {
-    // Before to subscribe previous subscriptions we make sure they
-    // are all defined as unsubscribed, because this code is asynchrone
-    // and a subscription could have been added in between.
-    Object.keys(this.subscribed).forEach((key) => {
-      this.subscribed[key] = false;
-    });
-
-    // Subscribe all previous subscriptions.
-    [...this.subscriptions].forEach((s) => {
-      this.subscribe(s.params, s.cb, s.errorCb, s.quiet);
-    });
-  }
-}
-
-export default WebSocketAPI;

package/src/common/controls/ControlCommon.test.js

@@ -1,106 +0,0 @@
-import ControlCommon from './ControlCommon';
-
-// We Crate a class to extend to avoid having console error messages.
-class Control extends ControlCommon {
-  // eslint-disable-next-line class-methods-use-this
-  deactivate() {}
-
-  render() {}
-}
-
-describe('Control', () => {
-  test('should be activated by default', () => {
-    const control = new Control();
-    expect(control.active).toBe(true);
-  });
-
-  test('should not be activated if set to false in the options', () => {
-    const control = new Control({ active: false });
-    expect(control.active).toBe(false);
-  });
-
-  test('should call activate/deactivate when active is set to true/false', () => {
-    const control = new Control();
-    const spy1 = jest.spyOn(control, 'activate');
-    const spy2 = jest.spyOn(control, 'deactivate');
-    const spy3 = jest.spyOn(control, 'render');
-    control.active = false;
-    expect(spy1).toBeCalledTimes(0);
-    expect(spy2).toBeCalledTimes(1);
-    expect(spy3).toBeCalledTimes(1);
-    control.active = true;
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(2);
-    expect(spy3).toBeCalledTimes(2);
-  });
-
-  test('should append/remove the element to the map container when map is set', () => {
-    const element = document.createElement('div');
-    const target = document.createElement('div');
-    const control = new Control({
-      element,
-    });
-    const spy1 = jest.spyOn(control, 'activate');
-    const spy2 = jest.spyOn(control, 'deactivate');
-    const spy3 = jest.spyOn(control, 'render');
-    control.map = {
-      getContainer() {
-        return target;
-      },
-    };
-    expect(target.childNodes[0]).toBe(element);
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(2);
-    expect(spy3).toBeCalledTimes(1);
-
-    control.detachFromMap();
-    expect(target.childNodes[0]).toBe();
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(3);
-    expect(spy3).toBeCalledTimes(2);
-  });
-
-  test('should append/remove the element to the target property when map is set', () => {
-    const element = document.createElement('div');
-    const target = document.createElement('div');
-    const control = new Control({
-      target,
-      element,
-    });
-    const spy1 = jest.spyOn(control, 'activate');
-    const spy2 = jest.spyOn(control, 'deactivate');
-    const spy3 = jest.spyOn(control, 'render');
-    control.map = {};
-    expect(target.childNodes[0]).toBe(element);
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(2);
-    expect(spy3).toBeCalledTimes(1);
-
-    control.detachFromMap();
-    expect(target.childNodes[0]).toBe();
-    expect(spy1).toBeCalledTimes(1);
-    expect(spy2).toBeCalledTimes(3);
-    expect(spy3).toBeCalledTimes(2);
-  });
-
-  test('set a custom render method', () => {
-    const spy = jest.fn();
-    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
-    const control = new Control({
-      render: spy,
-    });
-    expect(spy).toBeCalledTimes(1);
-  });
-
-  test('pass function params to custom render method', () => {
-    const spy = jest.fn();
-    // eslint-disable-next-line no-unused-vars
-    const control = new Control({
-      render: spy,
-    });
-    control.render('foo', 'bar');
-    expect(spy).toBeCalledTimes(2);
-    expect(spy.mock.calls[1][0]).toBe('foo');
-    expect(spy.mock.calls[1][1]).toBe('bar');
-  });
-});