cms-parsec v0.0.1

Parsec

Parsec is a robust functional solution to asynchronous code management in JavaScript.

This package is compatible with TypeScript. Please see this section for more information.

Acknowledgement

This library is based off the library "Parseq" by Douglas Crockford from his book "How JavaScript Works". Functionally, this library is fully equivalent, and the differences are entirely stylistic. Crockford gives his blessing to all who wish to reimplement Parseq.

Installation

• npm install cms-parsec.

  That's it. Then you can start using parsec like so:

  import parsec from "cms-parsec";
  
  parsec.sequence([
     // requestors go here
  ]);

Requestors

In Parsec, the building block of asynchronous logic is a kind of function we call a requestor. A requestor performs one unit of work. This unit of work can be synchronous or asynchronous.

Requestors receive a callback that is called when the unit of work completes. We call these callbacks receivers. All receivers take exactly one argument: a result object.

The result may have a value property which represents the result of that unit of work. If the unit of work resulted in failure, then the value is undefined. On failure, the result may optionally contain a reason property which can be used for logging purposes.

A requestor may take a second argument we call a message.

Requestors may optionally return a function we call a cancellor. The cancellor should attempt to cancel the unit of work its requestor started and may optionally take a reason argument for logging purposes. In general, cancellors cannot guarantee cancellation. They can only guarantee an attempt.

Here is an example of a requestor which makes HTTP/HTTPS requests:

// most of the time, you create factories which create your requestors
function createGetRequestor(url) {

    // this specific requestor does not take a message
    return receiver => {
        try {
            const request = new XMLHttpRequest();

            request.onreadystatechange = () => {
                if (request.readyState !== 4) return;

                // send the response data to the receiver
                receiver({
                    value: {
                        status: request.status,
                        statusText: request.statusText,
                        headers: request.getAllResponseHeaders(),
                        data: request.responseText,
                    }
                });
            };

            request.open("GET", url, true);
            request.send();

            // the requestor returns a cancellor which aborts the request
            return () => request.abort();
        }
        catch(reason) {
            // if anything goes wrong, we call the receiver in a failure state
            // (notice that `result.value` is implicitly undefined)
            receiver({ reason });
        }
    }
}

// create a requestor
const getCoffees = createGetRequestor("https://api.sampleapis.com/coffee/hot");

// use the requestor
getCoffees(({ value, reason }) => {
    if (value === undefined) {
        console.log("Failure:", reason);
        return;
    }

    console.log("Success! Response is:\n", value.data);
});

Parsec: the way out of callback hell

Callback hell should be avoided at all costs. To avoid directly calling another requestor inside of a receiver, Parsec provides four requestor factories which can be used to compose requestors in a maintainable way:

• parsec.sequence creates a requestor which executes a collection of requestors in order, one at a time. The results are passed from the previous requestor to the next using the message argument in each requestor.

let getNav = parsec.sequence([
    getUserRecord,
    getPreference,
    getCustomNav
]);

parsec.sequence is the most useful Parsec factory. Its usage is fully analagous to Promise chains or async-await.

• parsec.parallel creates a requestor which concurrently executes a collection of other requestors.

let getStuff = parsec.parallel(
    // these requestors must all succeed for the parallel request to succeed
    [getNav, getAds, getMessageOfTheDay],

    // all parsec factories can optionally be given a configuration hash
    {
        // the parallel request will not fail if one of these requestors fail
        optionals: [getWeather, getHoroscope, getGossip],

        // the parallel request will fail if the timelimit is reached before
        // all required requestors succeed
        timeLimit: 500,

        // If time remains and the optionals have not yet succeeded, allow the
        // optionals to try to finish
        timeOption: TimeOption.TRY_OPTIONALS_IF_TIME_REMAINS
    }
);

parsec.parallel is analagous in functionality to Promise.all and Promise.allSettled.

• parsec.race creates a requestor which concurrently executes multiple requestors and succeeds whenever any one requestor completes.

let getAds = parsec.race([
    getAd(adnet.klikHaus),
    getAd(adnet.inUFace),
    getAd(adnet.trackPipe)
]);

parsec.race is analagous to Promise.race.

• parsec.fallback creates a requestor which executes a collection of requestors in order and succeeds once any of them succeeds.

let getWeather = parsec.fallback([
    fetch("weather", localCache),
    fetch("weather", localDB),
    fetch("weather", remoteDB)
]);

Each factory in parsec returns a new requestor meaning that the factories can be composed.

Each factory returns a requestor which returns a cancellor, meaning the requests can be easily cancelled.

Why should I use Parsec?

Using requestors and Parsec, we have clear separation of logic (requestors) and control flow (Parsec) for asynchronous code. This is something that Promises and async-await fail to do. Simple features like throttling the number of concurrent requests to a server or cancelling a remote request, things which are inconvenient with Promises or async-await, are trivial with Parsec. Finally, the library is small and has no dependencies.

Nebula

To simply usage of Parsec, a collection of useful requestor factories is included in the sister package Nebula.

Many of the factories in Nebula create requestors for making HTTP/HTTPS requests.

import nebula from "./nebula.js";

const getCoffees = nebula.get("https://api.sampleapis.com/coffee/hot");

// We can cancel requests from nebula
const cancel = getCoffees(result => {
    if (result.value === undefined) {
        console.log("Failure because:", result.reason);
        return;
    }
    const { statusCode, statusMessage, headers, data }  = result.value;
    console.log(`status: ${statusCode} ${statusMessage}`);

    // `headers` is a JSON object
    console.log(`headers:\n ${headers}`);

    // If response is JSON, this will automatically be parsed as JSON
    console.log("The coffees:\n", data);
});

We can use parsec.sequence and nebula to create a requestor which requests data from one database and then stores it in another.

import parsec from "cms-parsec";
import { get, map, post } from "cms-nebula";

const saveCoffeeToDatabase = parsec.sequence([
    get("https://api.sampleapis.com/coffee/hot"),

    // HTTP response is an array
    map(response => response.data[0]),

    // the message sent from previous requestor is used as the POST body
    post("https://database/endpoint/")
]);

Requestors and Parsec is a more robust toolset for asynchronous code management than Promises and async-await. However, since many useful libraries return Promises, Nebula provides a mechanism for integrating them into Parsec.

const coffeePromise = fetch("https://api.sampleapis.com/coffee/hot")
    .then(res => res.json());
const fetchCoffees = nebula.usePromise(coffeePromise, {
    // the Promise can be canceled!
    cancellable: true
});

// Make the request
const cancel = fetchCoffees(result => {
    // Failure occurs if the Promise rejects
    if (result.value === undefined) {
        console.log("Failure because:", result.reason);
        return;
    }

    // We reach here if the Promise fulfills
    console.log("All coffees:\n", result.value);
});

Keep in mind that Parsec should be used as the "next step" in asychronous code management. Any time you use usePromise, first consider creating an alternative implementation of that Promise as a requestor.

Parsec & TypeScript

This package includes types for all of the requestor factories in Parsec. In addition, the following types can be imported from cms-parsec:

• Requestor<T, U>: The signature of functions which can act as requestors.
• Receiver: The signature of functions which can act as receivers.
• Result: The type of the single argument consumed by receivers.
• Cancellor: The signature of functions which can act as cancellors.
• SequenceSpec: The type of the spec object which can be passed to parsec.sequence.
• ParallelSpec: The type of the spec object which can be passed to parsec.parallel.
• RaceSpace: The type of the spec object which can be passed to parsec.race.
• FallbackSpec: The type of the spec object which can be passed to parsec.fallback.

Contributing

Cloning the repository

First instal git. Once you have git, execute git clone https://github.com/calebmsword/clone-deep.git and a directory clone-deep/ will be made containing the source code. Then execute npm install.

TypeScript & JSDoc

This repository uses type annotations in JSDoc to add type-checking to JavaScript. While this requires the typescript package, there is no compilation step. The codebase is entirely JavaScript, but VSCode will still highlight errors like it would for TypeScript files. If you are using an IDE which cannot conveniently highlight TypeScript errors, then you can use the TypeScript compiler to check typing (execute npx tsc in the repository).

Testing

Execute npm test to run all tests. If you are using Node v20.1.0 or higher, execute npm run test-coverage to see coverage results.

Contribution Guidelines

• If you notice a bug or have a feature request, please raise an issue. Follow the default template provided for bug reports or feature requests, respectively.
• If you would like to implement a bug fix or feature request from an issue please:
  • Create a branch from the dev branch with a descriptive name relevant to the issue title
  • Implement the feature/bug fix
  • Add JSDoc annotations. Avoid reckless usage of the any type. New types can be introduced to private-types.d.ts, unless you would like that type to be exposed to the user in which it should be included in public-types.d.ts.
  • Create tests for all of the new code. Reach 100% line and function coverage and do your best to reach 100% branch coverage.
  • Once you are finished with the implementation and tests, create a pull request to the dev branch. All PRs to the dev or main branches require approval from the repository owner to be merged.

More acknowledgements

• Thanks to Douglas Crockford for freely sharing the Parseq source code.
• Thanks to GitHub users jamesdiancono and bunglegrind whose discussions in the parseq discussion forums inspired some of Nebula.
• Thanks to GitHub user driverdan for creating the node-XMLHttpRequest package, which effectively prototyped the MockXMLHttpRequest class used in the Nebula prototype.
• Thanks to aescling and redoral for comments and suggestions on Parsec and Nebula.