Mahabhuta - DOM-processing on the server in Node.js

By David Herron

Processing HTML DOM with Mahabhuta's Mahafuncs

In the previous chapter we saw a simple one-element MahafuncArray. We were told that when running mahabhuta.process we're to pass in a MahafuncArray object. That's simple enough, right? An array of Mahafunc objects, yes?

MahafuncArray - array's containing arrays containing arrays

Of course it's not that simple. In AkashaCMS each Plugin is expected to have its own MahafuncArray filled with the Mahafunc's it supplies. Therefore a typical AkashaCMS project will have several MahafuncArray's to deal with.

To deal with that, Mahabhuta allows a MahafuncArray to contain other MahafuncArray instances, and of course these can be nested arbitrarily deep. It's kind of like that old Cosmological idea of Universe - that the land is resting on the back of a giant turtle, that's in turn standing on another turtle, that is in turn standing on another turtle. In Mahabhuta, it's MahafuncArray's all the way down to the bottom.

This means you can create a master MahafuncArray

const mahamaster = new mahabhuta.MahafuncArray("master", {});

The master MahafuncArray probably will not need any options, hence the empty options object.

Your code then adds more MahafuncArray's for each group of Mahafunc's used in your application.

mahamaster.addMahafunc(new mahabhuta.MahafuncArray("plugin-1", {
    // options for plugin-1
}));
mahamaster.addMahafunc(new mahabhuta.MahafuncArray("plugin-2", {
    // options for plugin-2
}));

And of course you can call addMahafunc on either of those MahafuncArray objects.

Adding Mahafunc objects

You of course don't just add MahafuncArray instances. The whole point to this is to define a list of operations we use to process HTML. We've already seen this in the previous chapter. Generally speaking, we do this:

class OurCustomElement extends mahabhuta.CustomElement {
    get elementName() { return "our-custom-element"; }
    async process($element, metadata, dirty) {
        return "Custom Element Content";
    }
}
mahamaster.addMahafunc(new OurCustomElement());

We add an instance of the class rather than the class. That is, we call new OurClassName() rather than just passing in OurClassName.

The result: HTML in, changed HTML out

The purpose for Mahabhuta is to manipulate HTML:

let result = await mahabhuta.processAsync(HTMLINPUT, {
    // metadata for the HTMLINPUT
}, mahafuncs);

The metadata object is available for the various Mahafunc's to use and possibly insert into the text result.

The Mahabhuta library offers two versions of process. The process function uses the traditional callback API, while processAsync returns a Promise and is therefore useful when called inside an async/await function.

Under the covers in each Mahafunc, the process function is an async function and therefore handles asynchronous code exeuction.

Order of execution

Each MahafuncArray and each Mahafunc within a MahafuncArray are executed in the order in which they're added. Later additions go to the end of the list, and are executed later than the earlier additions.

Because every Mahafunc process function is an async function, asynchronous execution is handled automatically.

Overriding a Mahafunc

Suppose you're using a MahafuncArray providing a group of useful Mahafuncs, and you like the behavior of all but one. It's a wonderful set of Mahafunc's, but that one -- if only it were a little different. Mahabhuta allows you to override a Mahafunc simply by implementing a different version in an earlier MahafuncArray.

What did I mean by that? Typically your application uses multiple MahafuncArray's. If there are two Mahafunc's dealing with the same task, the one which executes first will take care of the task, and the one which executes later will not. Hence, the first one overrides the second.

This is over-rideability principle, meaning that every available action or template must be capable of being overridden.

For example, consider a second CustomElement Mahafunc for the hello-world tag we looked at earlier.

var mahafuncs = new mahabhuta.MahafuncArray("example", {});

class HelloWorld extends mahabhuta.CustomElement {
    get elementName() { return "hello-world"; }
    async process($element, metadata, dirty) {
        return "Hello, happy world!";
    }
}
mahafuncs.addMahafunc(new HelloWorld());

Both of these declare they work on the <hello-world> tag. But when does the output say Hello, world and when does it say Hello, happy world? The answer depends on which is executed first. That's because a CustomElement Mahafunc replaces its tag with the result text (we'll go over this in a second).

One of those <hello-world> implementations will execute before the other. The first one to execute replaces <hello-world> with its text. When the second executes the tag is no longer there and the Mahafunc doesn't perform any work.

Determining which Mahafunc is failing

This system of MahafuncArray's containing other MahafuncArray's is very flexible and efficient. But certain failures in Mahafunc's can be extremely difficult to debug. A Mahafunc that doesn't exit properly can simply cause AkashaRender to exit with no indication of the cause of the failure.

Mahabhuta allows you to trace the processing of MahafuncArray's and Mahafunc's. If a Mahafunc fails incorrectly, it will be the last one printed by this tracing. Or the tracing helps you audit the behavior of Mahabhuta in your application.

Somewhere in your application call mahabhuta.setTraceProcessing(true) as so:

const mahabhuta = require('mahabhuta');
mahabhuta.setTraceProcessing(true);

When set, the Mahabhuta processing loop will print this sort of tracing:

Mahabhuta starting array master
Mahabhuta starting array inline
Mahabhuta calling an inline "function"
Mahabhuta starting array akashacms-base
Mahabhuta calling CustomElement akashacms-base ak-page-title
Mahabhuta calling CustomElement akashacms-base ak-header-metatags
Mahabhuta calling CustomElement akashacms-base ak-sitemapxml
Mahabhuta calling CustomElement akashacms-base ak-header-linkreltags
Mahabhuta calling CustomElement akashacms-base ak-header-canonical-url
Mahabhuta calling an akashacms-base "function"
Mahabhuta calling CustomElement akashacms-base ak-google-analytics
Mahabhuta calling CustomElement akashacms-base publication-date
Mahabhuta calling an akashacms-base "function"
Mahabhuta calling Munger akashacms-base html head open-graph-promote-images
Mahabhuta calling an akashacms-base "function"
Mahabhuta starting array inline
Mahabhuta calling an inline "function"
Mahabhuta starting array inline
Mahabhuta calling an inline "function"
Mahabhuta calling an inline "function"
Mahabhuta starting array akashacms-document-viewers
Mahabhuta calling CustomElement akashacms-document-viewers googledocs-viewer
Mahabhuta calling CustomElement akashacms-document-viewers googledocs-view-link
Mahabhuta calling CustomElement akashacms-document-viewers docviewer
Mahabhuta calling CustomElement akashacms-document-viewers docviewer-link

Turning off the tracing is this simple:

mahabhuta.setTraceProcessing(false);

The Mahafunc objects

Currently there are two kinds of Mahafunc's, and a third type we might implement if it makes sense to do so. We've already seen one, CustomElement, which is meant to process a single element in the DOM, replacing it with something else. The other, Munger, is meant for wider-ranging changes to the DOM.

Each sort of Mahafunc receives a jQuery-like object representing the DOM. It supports a subset of the jQuery API, supporting DOM manipulations using familiar jQuery methods.

CustomElement

We've already looked at this object, without discussing any of the details. Let's do that now.

The elementName method is a getter, and it defines the name of the element provided by this CustomElement instance. As we saw in the Hello World example, with a CustomElement defined our HTML can contain a tag, <our-custom-element>. When Mahabhuta executes each CustomElement instance, it scans the DOM as if this were executed:

var elements = [];
$('our-custom-element').each(function(i, elem) { ret.push(elem); });

For each element pushed to the elements array, Mahabhuta calls the process function. The $element parameter gets $(element), and the metadata parameter is passed through unchanged.

The dirty parameter is a function you are to call if your CustomElement inserts HTML which requires further processing. You might add HTML that itself is meant to be processed by another Mahafunc. If that's the case, call dirty() in your function. If this function gets called, Mahabhuta will make sure to run all the Mahafunc's another time.

Your process function should be declared async. Under the covers it returns a Promise that either resolve's or reject's depending on the result. Mahabhuta will capture both errors and good results and act appropriately.

The action taken with the result depends on the Mahafunc subclass used. For CustomElement, the action taken is:

$(element).replaceWith(html);

Bottom line: CustomElement objects are meant to implement, as the name implies, a custom HTML element which is completely replaced by other HTML code.

Naming CustomElement implementations

It's useful for your custom HTML elements to not collide with the regular HTML elements. Unless, that is, you want to override a regular HTML element with your custom implementation. For example you might want a CustomElement to replace old-school <i> or <b> tags with the new-school <em> and <strong> tags. But, normally, you'll want to leave the regular HTML tags alone, and ensure your custom tags do not collide.

A simple policy is to use the - character in the elementName. That's because all (or most) of the standard regular HTML elements do not have - in their element name.

Et voila, by using - in the elementName you're almost certainly assured of no naming collision.

Since there's an exception to every rule, the Mahabhuta built-in Mahafunc's does include a tag, <partial>, which does not follow this rule. Live with it, since <partial> is the best name for that tag.

Data and parameters

Being an HTML element, the HTML matching your CustomElement can of course have attributes.

<our-custom-element href="http://akashacms.com"></our-custom-element>

Which you can retrieve as so:

async process($element, metadata, dirty) {
    const href = $element.attr('href');
    ...
}

You can also retrieve metadata values:

mahabhuta.process(htmlSource, {
    href: "http://akashacms.com",
    title: "AkashaCMS"
}, mahafuncs, (err, html) => {
    if (err) console.error(err);
    else ...
});

Then access the values as so

async process($element, metadata, dirty) {
    ...
    const href = metadata.href;
    const title = metadata.title;
    ...
}

Munger

Munger objects are meant to implement broader changes to the HTML. For example you might want to "clean up" certain HTML code, or wrap certain code with some other HTML, or to insert some HTML elsewhere, or to move HTML from one place to another, and so forth. The jQuery API is powerful, and we want you to use all of it in processing HTML.

class OurMungerClass extends mahabhuta.Munger {
	get selector() { return "jQuery Selector"; }

	async process($, $match, metadata, dirty) {
    }
}

Instead of an element name, we're to supply a selector. This is a full normal jQuery-style selector so go wild with it.

For each match to the selector, the process function is called. The metadata and dirty parameters are as before.

The $ parameter is the jQuery-like object representing the entire DOM. You can call any jQuery function on this object which Cheerio supports. While Cheerio supports a very large subset of jQuery, it has its limits.

The $match parameter is the $(element) entry that was scanned using the selector.

As before, the process function is to return a Promise. Unlike CustomElement, the content returned by the Promise is not used. You must of course indicate failure by rejecting the Promise, and success with the resolve method.

What you do within the process method is up to you. Have fun.

A warning about dirty() infinite loops

It's quite possible to lead Mahabhuta into an infinite loop:

class InfiniteLoop extends mahabhuta.Munger {
	get selector() { return "body"; }

	async process($, $match, metadata, dirty) {
        dirty();
        return "infinite loop";
    }
}

Don't do this. Because Mahabhuta always ensures it'll re-run the Mahafunc's another time when dirty is called, this Mahafunc ensures Mahabhuta will never stop.

There are a number of ways to create such a situation.

Backwards compatibility - adding bare functions and Array's

For backwards compatibility with existing AkashaCMS code, Mahabhuta also supports adding simple function's (with a predefined signature), and simple Array's (which must contain Mahafunc's or the equivalent function).

The function signature is as so:

mahafunc($, metadata, dirty, next);

These parameters are all as we've seen above, except for next. This is an old style callback function supplied by Mahabhuta. You're to call it either as next(error) to indicate an error, or next() to indicate success.

When calling mahabhuta.process the mahafuncs parameter can be an Array. Internally this is converted to a MahafuncArray.

Processing HTML DOM with Mahabhuta's Mahafuncs

comments powered by Disqus