Chore/kill yalc with fire (#629)

* init * more shifting * Move @babel dependencies up to workspace root * Begin updating dependent libraries to use sync'd webpack builds w/ watches * Commit changes before a long weekend * Split packages into platform and extensions * Consolidate how/where we specify file/module type entrypoints * Make it possible to pass in extensions as App props * Resolve viewer's modules * Target for UMD bundle * Add Webpack Stylus loader * Provide WebPack build options for microscopy, vtk, and ui * Better entrypoint for extensions * Push changes up to switch PCs * Fix ESM symlink build for Viewers * Shift docs to root * Specify additional lerna config props * Begin providing basic readme info * Rename example extension folder * Shift links to bottom of doc * First attempt at a netlify deploy preview * Attempt to fix deploy preview build * push workspace enabled to initial command; remove second yarn install; use npx to call gitbook cli commands * Try to use global gitbook-cli * Export node_modules path * More agressive with modifying PATH * Follow deploy log output advice * try again to set bin path * Try swapping bash with a new shell * Try bash -l instead of exec bash * Annd let's try again * and again * We may have figured it out johnny, boy * We need to pull cornerstone-wado-image-loader files from hoisted node_modules * Attempt to fix ticks/escapes * Change copy syntax; try running tests on viewers from root for circleci * Lower version to match circleci image * Try alternative jest-canvas-mock location and version file syntax * Run version command instead of calling node directly * Try alternative jest transform * Set path and enable workspaces * Add codecov flags * Use cpx so our copying finishes? * Get all platform unit tests to run * Run and report individually and in parallel * Try once relying on codecov yaml to split w/ flags * Add projects to split by flags * Generate separate reports * Trigger codecov after everything has finished running; these may not support flags * Use recommended flags from issue comments for codecov * Fix typo * Remove clear flag * Shift back to calling codecov from root * Generate example for codecov issue * Try fixing paths * Simplify * Try using codecov orb * Bump circleci version * Upload core and viewer * Use full string paths * Remove individual codecov calls * Fix dir * Combine files before upload * Escape anchors * tryfix syntax * Escape string literal * Combine lines to reduce path * long paths * Use home alias * Fix filename * Try to see the contents of our cat'd file * Also upload `core` * Try running with aliased folder * Fix path; split PR and Merge unit tests into separate jobs * Set default threshold * Fix typo * Changing to scoped package names * Adding note * Catch more updates * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.0 - @ohif/extension-dicom-html@0.0.4-alpha.0 - @ohif/extension-dicom-microscopy@0.0.9-alpha.0 - @ohif/extension-dicom-pdf@0.0.8-alpha.0 - @ohif/extension-vtk@0.1.4-alpha.0 - @ohif/core@0.11.1-alpha.0 - @ohif/i18n@0.2.3-alpha.0 - @ohif/ui@0.2.18-alpha.0 - @ohif/viewer@0.0.22-alpha.0 * Clean up primary readme * Support for dev and dev:* commands * Shift build command; satisfy default PWA build * Remove old scripts * Clean up UI to set webpack scripts * Tidy up project links * Clean duplicate code in UI project * Update UI project's docs * Clean up ui and i18n config * Reduce duplicate code in `@ohif/core` * Fix @ohif/ui versions * bump @ohif/core versions * Redux testkit dep * Remove unused/duplicate config files for projects/packages * ohif-core --> @ohif/core * Safer publish command * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.1 - @ohif/extension-dicom-html@0.0.4-alpha.1 - @ohif/extension-dicom-microscopy@0.0.9-alpha.1 - @ohif/extension-dicom-pdf@0.0.8-alpha.1 - @ohif/extension-vtk@0.1.4-alpha.1 - @ohif/core@0.11.1-alpha.1 - @ohif/i18n@0.2.3-alpha.1 - @ohif/ui@0.2.18-alpha.1 - @ohif/viewer@0.0.22-alpha.1 * test version bump * Add global prettier config * chore(release): publish %s [skip ci] - @ohif/viewer@0.0.22-alpha.2 * test lerna publish * Update package.jsons * Fix build scripts * catch changes * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.2 - @ohif/extension-dicom-html@0.0.4-alpha.2 - @ohif/extension-dicom-microscopy@0.0.9-alpha.2 - @ohif/extension-dicom-pdf@0.0.8-alpha.2 - @ohif/extension-vtk@0.1.4-alpha.2 - @ohif/core@0.11.1-alpha.2 - @ohif/i18n@0.2.3-alpha.2 - @ohif/ui@0.2.18-alpha.2 - @ohif/viewer@0.0.22-alpha.3 * fix eslint issues caused by eslint 6 and our react-app config * Publish with canary tag * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.3 - @ohif/extension-dicom-html@0.0.4-alpha.3 - @ohif/extension-dicom-microscopy@0.0.9-alpha.3 - @ohif/extension-dicom-pdf@0.0.8-alpha.3 - @ohif/extension-vtk@0.1.4-alpha.3 - @ohif/core@0.11.1-alpha.3 - @ohif/i18n@0.2.3-alpha.3 - @ohif/ui@0.2.18-alpha.3 - @ohif/viewer@0.0.22-alpha.4 * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.4 - @ohif/extension-dicom-html@0.0.4-alpha.4 - @ohif/extension-dicom-microscopy@0.0.9-alpha.4 - @ohif/extension-dicom-pdf@0.0.8-alpha.4 - @ohif/extension-vtk@0.1.4-alpha.4 - @ohif/core@0.11.1-alpha.4 - @ohif/i18n@0.2.3-alpha.4 - @ohif/ui@0.2.18-alpha.4 - @ohif/viewer@0.0.22-alpha.5 * Simplify build * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.5 - @ohif/extension-dicom-html@0.0.4-alpha.5 - @ohif/extension-dicom-microscopy@0.0.9-alpha.5 - @ohif/extension-dicom-pdf@0.0.8-alpha.5 - @ohif/extension-vtk@0.1.4-alpha.5 - @ohif/core@0.11.1-alpha.5 - @ohif/i18n@0.2.3-alpha.5 - @ohif/ui@0.2.18-alpha.5 - @ohif/viewer@0.0.22-alpha.6 * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.6 - @ohif/extension-dicom-html@0.0.4-alpha.6 - @ohif/extension-dicom-microscopy@0.0.9-alpha.6 - @ohif/extension-dicom-pdf@0.0.8-alpha.6 - @ohif/extension-vtk@0.1.4-alpha.6 - @ohif/core@0.11.1-alpha.6 - @ohif/i18n@0.2.3-alpha.6 - @ohif/ui@0.2.18-alpha.6 - @ohif/viewer@0.0.22-alpha.7 * Split version and publish * chore(release): publish %s [skip ci] - @ohif/extension-cornerstone@0.0.39-alpha.7 - @ohif/extension-dicom-html@0.0.4-alpha.7 - @ohif/extension-dicom-microscopy@0.0.9-alpha.7 - @ohif/extension-dicom-pdf@0.0.8-alpha.7 - @ohif/extension-vtk@0.1.4-alpha.7 - @ohif/core@0.11.1-alpha.7 - @ohif/i18n@0.2.3-alpha.7 - @ohif/ui@0.2.18-alpha.7 - @ohif/viewer@0.0.22-alpha.8 * Try simplify netlify build * react-viewerbase --> @ohif/ui * add test for stylus loader * Try new way to specify publish path * Use an output folder that won't be ignored * Try move command * fiddle with paths * Dig for some information * Make sure we're in root for our commands * Remove discovery * Setup script-tag example * Fix typo * Move config folder * Update cornerstone extension to use shared/root webpack configs * capture changes * Update extension webpack configs * Don't check in docz output * Fix babel runtime resolution issue * Simplify ui build steps * Push in progress * Shift directories * Get viewer dev path to work * Fix viewer commonjs build * Fix build pwa config for viewers * Make sure our package specific command can be called from root * Update notes * Fix imports and misc. merge notes * Bump wado-image-loader version * Switch up commands to remove webworkers copy * Fix CI config * Fix more broken package references * Add react-dropzone * Persist so e2e test can use * Fix lockfile * Use cypress orb to simplify CI * Fix config * Try again * Install yarn latest for orb * Install yarn a different way * Wait on correct port * Run tests in viewer project * Fix cypress config * Make Cypress happier - use default location * Simplify e2e testing * Capture UI changes since fork * Catch core up * Grab latest deps after merge * Fix broken import * Make sure cornerstone-wado-image-loader resolves to 3+ * Note regarding orbs * Fix refresh on 404 routes * Fix odd error for cornerstone-wado-image-loader * Different target for UMD * Simplify dev script * Try to get fancy with netlify output * Let's do it again * Try to fix measurementTools issue * See if we can get our lerna magic to work on merge to monorepo branch
2019-08-13 15:36:46 -04:00
1 parent cac911f08e
commit 08ff214ea6
@@ -0,0 +1,189 @@
+import log from '../log.js';
+
+/**
+ * The definition of a command
+ *
+ * @typedef {Object} CommandDefinition
+ * @property {Function} commandFn - Command to call
+ * @property {Array} storeContexts - Array of string of modules required from store
+ * @property {Object} options - Object of params to pass action
+ */
+
+/**
+ * The Commands Manager tracks named commands (or functions) that are scoped to
+ * a context. When we attempt to run a command with a given name, we look for it
+ * in our active contexts. If found, we run the command, passing in any application
+ * or call specific data specified in the command's definition.
+ *
+ * NOTE: A more robust version of the CommandsManager lives in v1. If you're looking
+ * to extend this class, please check it's source before adding new methods.
+ */
+export class CommandsManager {
+  constructor({ getAppState, getActiveContexts } = {}) {
+    this.contexts = {};
+
+    if (!getAppState || !getActiveContexts) {
+      log.warn(
+        'CommandsManager was instantiated without getAppState() or getActiveContexts()'
+      );
+    }
+
+    this._getAppState = getAppState;
+    this._getActiveContexts = getActiveContexts;
+  }
+
+  /**
+   * Allows us to create commands "per context". An example would be the "Cornerstone"
+   * context having a `SaveImage` command, and the "VTK" context having a `SaveImage`
+   * command. The distinction of a context allows us to call the command in either
+   * context, and have faith that the correct command will be run.
+   *
+   * @method
+   * @param {string} contextName - Namespace for commands
+   * @returns {undefined}
+   */
+  createContext(contextName) {
+    if (!contextName) {
+      return;
+    }
+
+    if (this.contexts[contextName]) {
+      return this.clearContext(contextName);
+    }
+
+    this.contexts[contextName] = {};
+  }
+
+  /**
+   * Returns all command definitions for a given context
+   *
+   * @method
+   * @param {string} contextName - Namespace for commands
+   * @returs {Object} - the matched context
+   */
+  getContext(contextName) {
+    const context = this.contexts[contextName];
+
+    if (!context) {
+      return;
+    }
+
+    return context;
+  }
+
+  /**
+   * Clears all registered commands for a given context.
+   *
+   * @param {string} contextName - Namespace for commands
+   * @returns {undefined}
+   */
+  clearContext(contextName) {
+    if (!contextName) {
+      return;
+    }
+
+    this.contexts[contextName] = {};
+  }
+
+  /**
+   * Register a new command with the command manager. Scoped to a context, and
+   * with a definition to assist command callers w/ providing the necessary params
+   *
+   * @method
+   * @param {string} contextName - Namespace for command; often scoped to the extension that added it
+   * @param {string} commandName - Unique name identifying the command
+   * @param {CommandDefinition} definition - {@link CommandDefinition}
+   */
+  registerCommand(contextName, commandName, definition) {
+    if (typeof definition !== 'object') {
+      return;
+    }
+
+    const context = this.getContext(contextName);
+    if (!context) {
+      return;
+    }
+
+    context[commandName] = definition;
+  }
+
+  /**
+   * Finds a command with the provided name if it exists in the specified context,
+   * or a currently active context.
+   *
+   * @method
+   * @param {String} commandName - Command to find
+   * @param {String} [contextName] - Specific command to look in. Defaults to current activeContexts
+   */
+  getCommand(commandName, contextName) {
+    let contexts = [];
+
+    if (contextName) {
+      const context = this.getContext(contextName);
+      if (context) {
+        contexts.push(context);
+      }
+    } else {
+      const activeContexts = this._getActiveContexts();
+      activeContexts.forEach(activeContext => {
+        const context = this.getContext(activeContext);
+        if (context) {
+          contexts.push(context);
+        }
+      });
+    }
+
+    if (contexts.length === 0) {
+      return;
+    }
+
+    let foundCommand;
+    contexts.forEach(context => {
+      if (context[commandName]) {
+        foundCommand = context[commandName];
+      }
+    });
+
+    return foundCommand;
+  }
+
+  /**
+   *
+   * @method
+   * @param {String} commandName
+   * @param {Object} [options={}] - Extra options to pass the command. Like a mousedown event
+   * @param {String} [contextName]
+   */
+  runCommand(commandName, options = {}, contextName) {
+    const definition = this.getCommand(commandName, contextName);
+    if (!definition) {
+      log.warn(`Command "${commandName}" not found in current context`);
+      return;
+    }
+
+    const { commandFn, storeContexts } = definition;
+    const definitionOptions = definition.options;
+
+    let commandParams = {};
+    const appState = this._getAppState();
+    storeContexts.forEach(context => {
+      commandParams[context] = appState[context];
+    });
+
+    commandParams = Object.assign(
+      {},
+      commandParams, // Required store contexts
+      definitionOptions, // "Command configuration"
+      options // "Time of call" info
+    );
+
+    if (typeof commandFn !== 'function') {
+      log.warn(`No commandFn was defined for command "${commandName}"`);
+      return;
+    } else {
+      return commandFn(commandParams);
+    }
+  }
+}
+
+export default CommandsManager;