all files / src/imageLoader/ webWorkerManager.js

62.35% Statements 53/85
42.86% Branches 15/35
60% Functions 6/10
62.35% Lines 53/85
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327                                                                                  19×       10×                                                             10×     10×                                                                                                                                                                                                                                                                                                                                                                                                            
import { getOptions } from './internal/options.js';
 
// the taskId to assign to the next task added via addTask()
let nextTaskId = 0;
 
// array of queued tasks sorted with highest priority task first
const tasks = [];
 
// array of web workers to dispatch decode tasks to
const webWorkers = [];
 
// The options for CornerstoneWADOImageLoader
const options = getOptions();
 
const defaultConfig = {
  maxWebWorkers: navigator.hardwareConcurrency || 1,
  startWebWorkersOnDemand: true,
  webWorkerPath: '../../dist/cornerstoneWADOImageLoaderWebWorker.js',
  webWorkerTaskPaths: [],
  taskConfiguration: {
    decodeTask: {
      loadCodecsOnStartup: true,
      initializeCodecsOnStartup: false,
      codecsPath: '../dist/cornerstoneWADOImageLoaderCodecs.js',
      usePDFJS: false,
      strict: options.strict
    }
  }
};
 
let config;
 
const statistics = {
  maxWebWorkers: 0,
  numWebWorkers: 0,
  numTasksQueued: 0,
  numTasksExecuting: 0,
  numTasksCompleted: 0,
  totalTaskTimeInMS: 0,
  totalTimeDelayedInMS: 0
};
 
/**
 * Function to start a task on a web worker
 */
function startTaskOnWebWorker() {
  // return immediately if no decode tasks to do
  if (!tasks.length) {
    return;
  }
 
  // look for a web worker that is ready
  for (let i = 0; i < webWorkers.length; i++) {
    Eif (webWorkers[i].status === 'ready') {
      // mark it as busy so tasks are not assigned to it
      webWorkers[i].status = 'busy';
 
      // get the highest priority task
      const task = tasks.shift();
 
      task.start = new Date().getTime();
 
      // update stats with how long this task was delayed (waiting in queue)
      const end = new Date().getTime();
 
      statistics.totalTimeDelayedInMS += end - task.added;
 
      // assign this task to this web worker and send the web worker
      // a message to execute it
      webWorkers[i].task = task;
      webWorkers[i].worker.postMessage(
        {
          taskType: task.taskType,
          workerIndex: i,
          data: task.data
        },
        task.transferList
      );
      statistics.numTasksExecuting++;
 
      return;
    }
  }
 
  // if no available web workers and we haven't started max web workers, start a new one
  Eif (webWorkers.length < config.maxWebWorkers) {
    spawnWebWorker();
  }
}
 
/**
 * Function to handle a message from a web worker
 * @param msg
 */
function handleMessageFromWorker(msg) {
  const worker = webWorkers[msg.data.workerIndex];
 
  // console.log('handleMessageFromWorker', msg.data);
  if (msg.data.taskType === 'initialize') {
    worker.status = 'ready';
    startTaskOnWebWorker();
  } else {
    const start = worker.task.start;
 
    worker.task.deferred.resolve(msg.data.result);
    worker.task = undefined;
 
    statistics.numTasksExecuting--;
    worker.status = 'ready';
    statistics.numTasksCompleted++;
 
    const end = new Date().getTime();
 
    statistics.totalTaskTimeInMS += end - start;
 
    startTaskOnWebWorker();
  }
}
 
/**
 * Spawns a new web worker
 */
function spawnWebWorker() {
  // prevent exceeding maxWebWorkers
  Iif (webWorkers.length >= config.maxWebWorkers) {
    return;
  }
 
  // spawn the webworker
  const worker = new Worker(config.webWorkerPath);
 
  webWorkers.push({
    worker,
    status: 'initializing'
  });
  worker.addEventListener('message', handleMessageFromWorker);
  worker.postMessage({
    taskType: 'initialize',
    workerIndex: webWorkers.length - 1,
    config
  });
}
 
/**
 * Initialization function for the web worker manager - spawns web workers
 * @param configObject
 */
function initialize(configObject) {
  configObject = configObject || defaultConfig;
 
  // prevent being initialized more than once
  Iif (config) {
    throw new Error('WebWorkerManager already initialized');
  }
 
  config = configObject;
 
  config.maxWebWorkers =
    config.maxWebWorkers || (navigator.hardwareConcurrency || 1);
 
  // Spawn new web workers
  Iif (!config.startWebWorkersOnDemand) {
    for (let i = 0; i < config.maxWebWorkers; i++) {
      spawnWebWorker();
    }
  }
}
 
/**
 * dynamically loads a web worker task
 * @param sourcePath
 * @param taskConfig
 */
function loadWebWorkerTask(sourcePath, taskConfig) {
  // add it to the list of web worker tasks paths so on demand web workers
  // load this properly
  config.webWorkerTaskPaths.push(sourcePath);
 
  // if a task specific configuration is provided, merge it into the config
  if (taskConfig) {
    config.taskConfiguration = Object.assign(
      config.taskConfiguration,
      taskConfig
    );
  }
 
  // tell each spawned web worker to load this task
  for (let i = 0; i < webWorkers.length; i++) {
    webWorkers[i].worker.postMessage({
      taskType: 'loadWebWorkerTask',
      workerIndex: webWorkers.length - 1,
      sourcePath,
      config
    });
  }
}
 
/**
 * Function to add a decode task to be performed
 *
 * @param taskType - the taskType for this task
 * @param data - data specific to the task
 * @param priority - optional priority of the task (defaults to 0), > 0 is higher, < 0 is lower
 * @param transferList - optional array of data to transfer to web worker
 * @returns {*}
 */
function addTask(taskType, data, priority = 0, transferList) {
  Iif (!config) {
    initialize();
  }
 
  let deferred = {};
  const promise = new Promise((resolve, reject) => {
    deferred = {
      resolve,
      reject
    };
  });
 
  // find the right spot to insert this decode task (based on priority)
  let i;
 
  for (i = 0; i < tasks.length; i++) {
    if (tasks[i].priority < priority) {
      break;
    }
  }
 
  const taskId = nextTaskId++;
 
  // insert the decode task at position i
  tasks.splice(i, 0, {
    taskId,
    taskType,
    status: 'ready',
    added: new Date().getTime(),
    data,
    deferred,
    priority,
    transferList
  });
 
  // try to start a task on the web worker since we just added a new task and a web worker may be available
  startTaskOnWebWorker();
 
  return {
    taskId,
    promise
  };
}
 
/**
 * Changes the priority of a queued task
 * @param taskId - the taskId to change the priority of
 * @param priority - priority of the task (defaults to 0), > 0 is higher, < 0 is lower
 * @returns boolean - true on success, false if taskId not found
 */
function setTaskPriority(taskId, priority = 0) {
  // search for this taskId
  for (let i = 0; i < tasks.length; i++) {
    if (tasks[i].taskId === taskId) {
      // taskId found, remove it
      const task = tasks.splice(i, 1)[0];
 
      // set its priority
      task.priority = priority;
 
      // find the right spot to insert this decode task (based on priority)
      for (i = 0; i < tasks.length; i++) {
        if (tasks[i].priority < priority) {
          break;
        }
      }
 
      // insert the decode task at position i
      tasks.splice(i, 0, task);
 
      return true;
    }
  }
 
  return false;
}
 
/**
 * Cancels a queued task and rejects
 * @param taskId - the taskId to cancel
 * @param reason - optional reason the task was rejected
 * @returns boolean - true on success, false if taskId not found
 */
function cancelTask(taskId, reason) {
  // search for this taskId
  for (let i = 0; i < tasks.length; i++) {
    if (tasks[i].taskId === taskId) {
      // taskId found, remove it
      const task = tasks.splice(i, 1);
 
      task.deferred.reject(reason);
 
      return true;
    }
  }
 
  return false;
}
 
/**
 * Function to return the statistics on running web workers
 * @returns object containing statistics
 */
function getStatistics() {
  statistics.maxWebWorkers = config.maxWebWorkers;
  statistics.numWebWorkers = webWorkers.length;
  statistics.numTasksQueued = tasks.length;
 
  return statistics;
}
 
export default {
  initialize,
  loadWebWorkerTask,
  addTask,
  getStatistics,
  setTaskPriority,
  cancelTask
};