paraview-lite/src/io/Client.js

Lite ParaView client for Scientific Visualization on the Web

import SmartConnect from 'wslink/src/SmartConnect';

import vtkImageStream from 'vtk.js/Sources/IO/Core/ImageStream';

import ColorManager from 'paraview-lite/src/io/protocols/ColorManager';
import FileListing from 'paraview-lite/src/io/protocols/FileListing';
import KeyValuePairStore from 'paraview-lite/src/io/protocols/KeyValuePairStore';
import MouseHandler from 'paraview-lite/src/io/protocols/MouseHandler';
import ProgressUpdate from 'paraview-lite/src/io/protocols/ProgressUpdate';
import ProxyManager from 'paraview-lite/src/io/protocols/ProxyManager';
import SaveData from 'paraview-lite/src/io/protocols/SaveData';
import TimeHandler from 'paraview-lite/src/io/protocols/TimeHandler';
import ViewPort from 'paraview-lite/src/io/protocols/ViewPort';
import ViewPortGeometryDelivery from 'paraview-lite/src/io/protocols/ViewPortGeometryDelivery';
import ViewPortImageDelivery from 'paraview-lite/src/io/protocols/ViewPortImageDelivery';
import VtkGeometryDelivery from 'paraview-lite/src/io/protocols/VtkGeometryDelivery';
import VtkImageDelivery from 'paraview-lite/src/io/protocols/VtkImageDelivery';

import Lite from 'paraview-lite/src/io/protocols/Lite';

const REMOTE_API = {
  ColorManager,
  FileListing,
  KeyValuePairStore,
  MouseHandler,
  ProgressUpdate,
  ProxyManager,
  SaveData,
  TimeHandler,
  ViewPort,
  ViewPortGeometryDelivery,
  ViewPortImageDelivery,
  VtkGeometryDelivery,
  VtkImageDelivery,
  // custom
  Lite,
};

// ----------------------------------------------------------------------------
// Busy feedback handling
// ----------------------------------------------------------------------------

function busy(fn, update) {
  return (...args) =>
    new Promise((resolve, reject) => {
      update(1);
      fn(...args).then(
        (response) => {
          update(-1);
          resolve(response);
        },
        (error) => {
          update(-1);
          reject(error);
        }
      );
    });
}

// ----------------------------------------------------------------------------

function busyWrap(methodMap, update) {
  const busyContainer = {};
  Object.keys(methodMap).forEach((methodName) => {
    busyContainer[methodName] = busy(methodMap[methodName], update);
  });
  return busyContainer;
}

// ----------------------------------------------------------------------------
// Client
// ----------------------------------------------------------------------------

export default class Client {
  constructor() {
    this.config = null;
    this.connection = null;
    this.remote = {};
    this.busyCount = 0;
    this.notifyBusy = () => {
      if (this.busyCallback) {
        this.busyCallback(this.busyCount);
      }
    };
    this.timeoutId = 0;
    this.updateBusy = (delta = 0) => {
      this.busyCount += delta;
      if (this.busyCallback) {
        if (this.timeoutId) {
          clearTimeout(this.timeoutId);
          this.timeoutId = 0;
        }
        if (!this.busyCount) {
          // Try to delay the notification of idle
          this.timeoutId = setTimeout(() => {
            this.notifyBusy();
          }, 50);
        } else {
          this.notifyBusy();
        }
      }
    };
  }

  isConnected() {
    return !!this.connection;
  }

  setBusyCallback(callback) {
    this.busyCallback = callback;
  }

  setConnectionErrorCallback(callback) {
    this.connectionCallback = callback;
  }

  getConfiguration() {
    return this.smartConnect.getConfig();
  }

  connect(config) {
    if (this.connection) {
      return Promise.reject(new Error('Need to disconnect before'));
    }
    return new Promise((resolve, reject) => {
      this.smartConnect = SmartConnect.newInstance({ config });
      this.smartConnect.onConnectionReady((connection) => {
        this.connection = connection;
        this.imageStream = vtkImageStream.newInstance();
        this.remote = {};
        const session = connection.getSession();

        // Link remote API
        Object.keys(REMOTE_API).forEach((name) => {
          this.remote[name] = busyWrap(
            REMOTE_API[name](session),
            this.updateBusy
          );
        });

        // Link imageStream
        this.imageStream.connect(session);

        resolve(this);
      });
      this.smartConnect.onConnectionError((error) => {
        if (this.connectionCallback) {
          this.connectionCallback('errored', error);
        }
        reject(error);
      });
      this.smartConnect.onConnectionClose((close) => {
        if (this.connectionCallback) {
          this.connectionCallback('closed', close);
        }
        reject(close);
      });
      this.smartConnect.connect();
    });
  }

  disconnect(timeout = 60) {
    if (this.connection) {
      this.connection.destroy(timeout);
      this.connection = null;
    }
  }
}