@exabyte-io/wode.js

wode.js

WOrkflow DEfinitions in JavaScript - wode.js - houses entity definitions for use in the Mat3ra platform.

Installation

For usage within a javascript project:

npm install @exabyte-io/wode.js

For development:

git clone https://github.com/Exabyte-io/wode.js.git

Contribution

This repository is an open-source work-in-progress and we welcome contributions.

We regularly deploy the latest code containing all accepted contributions online as part of the Mat3ra.com platform, so contributors will see their code in action there.

See ESSE for additional context regarding the data schemas used here.

Useful commands for development:

# run linter without persistence
npm run lint

# run linter and save edits
npm run lint:fix

# compile the library
npm run transpile

# run tests
npm run test

Using Linter

Linter setup will prevent committing files that don't adhere to the code standard. It will attempt to fix what it can automatically prior to the commit in order to reduce diff noise. This can lead to "unexpected" behavior where a file that is staged for commit is not identical to the file that actually gets committed. This happens in the lint-staged directive of the package.json file (by using a husky pre-commit hook). For example, if you add extra whitespace to a file, stage it, and try to commit it, you will see the following:

➜  repo-js git:(feature/cool-feature) ✗ git commit -m "Awesome feature works great"
✔ Preparing...
✔ Running tasks...
✖ Prevented an empty git commit!
✔ Reverting to original state because of errors...
✔ Cleaning up...

  ⚠ lint-staged prevented an empty git commit.
  Use the --allow-empty option to continue, or check your task configuration

husky - pre-commit hook exited with code 1 (error)

The staged change may remain but will not have been committed. Then it will look like you still have a staged change to commit, but the pre-commit hook will not actually commit it for you, quite frustrating! Styling can be applied manually and fixed by running:

npm run lint:fix

In which case, you may need to then add the linter edits to your staging, which in the example above, puts the file back to identical with the base branch, resulting in no staged changes whatsoever.

WoDe

TheWoDe package synthesizes other entity definition (De) libraries in the Mat3ra workflow ecosystem and implements the following entities:

• Workflow - a workflow to be executed on the Mat3ra platform
• Subworkflow - a logical collection of units of work defined by a unique Applidation
• Units - one of the following:
  • AssertionUnit - assert an expression
  • AssignmentUnit - assign a value
  • ConditionUnit - evaluate a condition
  • IOUnit - Read or write data
  • ExecutionUnit - execute an ADe Application
  • MapUnit - create a dynamic number of units based on output of a previous unit
  • ReduceUnit - collect the results of a fanned out operation

Workflow configurations are processed at build time using build_workflows.js and compiled into a single JS file so that workflow configurations can be accessed in the browser runtime, not just in a NodeJS process.

Workflow Spec

Workflows defined as configuration conform to the following specification:

• Workflow: Object - The workflow configuration itself
  • name: String - a human readable name describing the functionality of the workflow
  • units: Array - a list of workflow units where each unit takes the following shape Not == Unit
    • name: String - the snake_case name of a subworkflow or another workflow that must exist
    • config: Optional[Object] - see Config defined below
    • type: String - one of:
      • subworkflow|workflow
        • Note: workflow units may specify mapUnit: true in their config
    • units: Optional[Array] - if type == workflow see above (recursively defined)
  • config: Optional[Object] - see Config defined below
• Subworkflow: Object - a logical collection of workflow units
  • application: Object - an application specification
    • name: String - an application name recognized by ADe
    • version: Optional[String] - (often a semver) application version string supported by ADe
    • build: Optional[String] - application build string supported by ADe
  • method: Object - a method specification
    • name: String - a named method class exported from MeDe
    • config: Optional[Object] - see Config defined below
  • model: Object - a model specification
    • name: String - a named model class exported from MeDe
    • config: Optional[Object] - see Config defined below
  • config: Optional[Object] - see Config defined below
  • units: Array - a list of subworkflow units where each unit is a Unit defined below
• Unit: Object - a unit of computational work in a workflow
  • type: String - one of:
    • execution|assignment|condition|io|processing|map|subworkflow|assertion
      • Note: optionally may have Builder appended to type to use unit builders instead of units directly
        • executionBuilder is the primary use case for this
  • config: Object - arguments to pass to constructor based on type
  • functions: Object - similar to Config.functions defined below
    • in the case of builders, functions are applied before calling build
  • attributes: Object - similar to Config.attributes defined below
    • in the case of builders, attributes are applied after calling build
• Config: Object - custom configuration to apply to an entity
  • Note: functions and attributes may not be supported for all entities, please check the implementation
  • functions: Object - collection of functions defined on the entity to run
    • [key]: {{functionName}}: String - name of function to run
    • [value]: {{args}}: Any - arguments matching the call signature
  • attributes: Object - collection of attributes to assign to the entity on creation
    • [key]: {{attributeName}}: String - name of function to run
    • [value]: {{value}}: Any - value to assign to attribute
  • [key]: {{constructorArgument}}: String - parameter passed to constructor
  • [value]: {{constructorValue}}: Any - value for a given constructor parameter

Workflow Creation

The Workflow instances associated with the workflow configurations are built by the createWorkflows function traversing all three levels (workflow, subworkflow, unit):

Links

1. Workflows explained in Mat3ra documentation: https://docs.mat3ra.com/workflows/overview/