Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 5.34 KB

README.md

File metadata and controls

72 lines (51 loc) · 5.34 KB
Raw

Parseq Extended

Please check the original parseq repository at: https://github.com/douglascrockford/parseq

Differences between the original parseq library:

  1. make_reason is exposed through the public interface
  2. check_callback is exposed through the public interface
  3. check_requestors is exposed through the public interface
  4. start_requestor_callback doesn't catch exceptions anymore (see #13)

More constraints

In order to have a more robust library, I added some more constraints to the original library:

  1. requestors are executed in a different turn. Executing requestors in the same turn of the caller increases the possibility of issues like #13, and the possibility to exhaust the call stack
  2. All the requestor (config) parameters must be passed through the value arriving from its second argument. It's arbitrary but I need to take a stance, otherwise confusion increases. Using the helper function factory_maker you can adapt the interface in the different context.
  3. Every concrete factory/requestor must have its own name. Since call stacks are destroyed between turns, there's no other way than having a reliable explicit reason (with factory name and evidence) to properly debug the code (see open issues below).

Other useful factories

The functions available in this module are divided in three categories.

  • requestors
  • requestors decorators
  • requestors factories
  • others

The terminology herein utilized moves away from the original parseq library, since what parseq calls requestor factories I called requestor decorators, i.e., a function which, given one or more requestors at its input, returns a new requestor. I used the term requestor factories to identify functions which given some parameters, even other factories, return a requestor. The others category denotes functions which, given some parameters, return a requestor factory.

Requestors

  • do_nothing: The parseq equivalent of the identity function.

Requestors decorators

  • wrap_reason: Use it to wrap a requestor response inside a {value, reason} object in order to collect failures without blocking the execution.
  • when: Executes a requestor only when the condition is true. The condition function takes the requestor input value as its input.
  • if_else: Same with when, but it takes also a requestor for failing conditions.
  • try_catcher: Helper decorator that converts requestor exceptions into suitable format for parseq.
  • tap: Just like Ramda's tap, executes the requestor and returns the same input value, discarding requestor output.
  • parallel_merge: Shortcut to parallel_object, it enriches the input value with the results of the requestor object output.
  • reduce: Works similarly to Array.prototype.reduce.
  • delay: Given a requestor returns a new requestor which is executed at a fixed delay
  • persist: Given a requestor, returns a new requestor which persists for n tentatives to successfully execute the requestor, possibly delayed by a time_delay

Requestors factories

  • constant: Given a value, returns a requestor which passes the value as output.
  • requestorize: A different implementation of the original one in parseq. This one relies on setTimeout in order to execute the unary function in a different turn.
  • apply_race: Like race, but the requestor array is built dynamically using an array of values as input of a factory
  • apply_fallback: Like fallback, but the requestor array is built dynamically using an array of values as input of a factory
  • apply_parallel: Like parallel, but the requestor array is built dynamically using an array of values as input of a factory
  • apply_parallel_object: Like parallel\_object, but the requestor array is built dynamically using an array of values as input of a factory
  • promise_requestorize: Accepts a promise thunk as input and returns a requestor which executes the promise
  • dynamic_default_import: Takes an ES6 url as input and returns a requestor which returns the default module
  • dynamic_import: Takes an ES6 url as input and returns a requestor which returns the module

Others

  • make_requestor_factory: It's just a shortcut for the composition of requestorize and factory_maker
  • factory_maker: Given a requestor, returns the factory of the requestor which accept a suitable object/function as input

Considerations/Open issues

  1. Parseq original interface signature is a bit clunky. Expecially for the parallel stuff, throttle is the last parameter where it should be the first one. I couldn't find any practical use case for the other parameters, including the optional requestor array/object. I could change the interface a little bit, by passing an option object, similar to: https://github.com/jlrwi/curried-parseq
  2. Enforce some constraint to the "returned" value (i.e., the value passed to the callback). Well, since most of the time you have this value which is passed through the requestors via parseq.sequence as application state, is probably worth to enforce the value to be a an object (being the array a special case). And resorting to parallel_object/parallel_merge to provide a consistent interface.
  3. Provide a more coherent (with many more tests!) interface for reason/evidence in order to simplify debug operations where errors occur.
  4. The delay factory is probably wrong. It should take a requestor as input parameter (see persist)

Work in progress...