@podium/client

@podium/client

Client for fetching podium component fragments over HTTP.

This module is intended for internal use in Podium and is not a module an end user would use directly. End users will typically interact with this module through higher level modules such as the @podium/layout.

Installation

$ npm install @podium/client

Simple stream usage

Connect to a Podium component server and stream the HTML content:

const Client = require('@podium/client');
const client = new Client();

const component = client.register({
    name: 'foo',
    uri: 'http://foo.site.com/manifest.json',
});

const stream = component.stream();
stream.on('error', error => {
    console.log(error);
});
stream.pipe(process.stdout);

Simple fetch usage

Connect to a podium component server and fetch the HTML content:

const Client = require('@podium/client');
const client = new Client();

const component = client.register({
    name: 'foo',
    uri: 'http://foo.site.com/manifest.json',
});

component
    .fetch()
    .then(content => {
        console.log(content);
    })
    .catch(error => {
        console.log(error);
    });

Constructor

Create a new Client instance.

const Client = require('@podium/client');
const client = new Client(options);

The client instance is iterable and holds a reference to each registered resource.

const Client = require('@podium/client');
const client = new Client();

client.register({ uri: 'http://foo.site.com/manifest.json', name: 'fooBar' });
client.register({ uri: 'http://bar.site.com/manifest.json', name: 'barFoo' });

for (let resource of client) {
    resource.fetch();
}

options (optional)

An options object containing configuration. The following values can be provided:

• retries - {Number} - The number of times the client should retry to settle a version number conflict before terminating. See the section "on retrying" for more information. Default: 4
• timeout - {Number} - Default value, in milliseconds, for how long a request should wait before the connection is terminated. Default: 1000
• maxAge - {Number} - Default value, in milliseconds, for how long manifests should be cached. Default: Infinity
• agent - {HTTPAgent} - Default HTTP Agent used for all requests.
• logger - {Object} - A logger which conforms to the log4j interface. See the docs for abslog for more information.

API

The Client instance has the following API:

.register(options)

Registers a component.

Example:

const Client = require('@podium/client');
const client = new Client();

const component = client.register({
    uri: 'http://foo.site.com/manifest.json',
    name: 'fooBar',
});

Returns a Resource Object.

The created Resource Object is also stored on the instance of the client. It is stored with the name as its property name.

Example:

const Client = require('@podium/client');
const client = new Client();

client.register({ uri: 'http://foo.site.com/manifest.json', name: 'fooBar' });
client.fooBar.fetch();

options (required)

The following values can be provided:

• uri - {String} - Uri to the manifest of a podium component - Required
• name - {String} - Name of the component. This is used to reference the component in your application, and does not have to match the name of the component itself - Required
• retries - {Number} - The number of times the client should retry to settle a version number conflict before terminating. See the section "on retrying" for more information. Default: 4 - Optional.
• timeout - {Number} - Defines how long, in milliseconds, a request should wait before the connection is terminated. Overrides the global default. Default: 1000 - Optional.
• throwable - {Boolean} - Defines whether an error should be thrown if a failure occurs during the process of fetching a podium component. Defaults to false - Optional.
• resolveJs - {Boolean} - Defines whether to resolve a relative JS uri for a component to be an absolute uri. Defaults to false - Optional.
• resolveCss - {Boolean} - Defines whether to resolve a relative CSS uri for a component to be an absolute uri. Defaults to false - Optional.

.js()

Retrieve list of all JavaScript references from all registered and fetched components.

const Client = require('@podium/client');
const client = new Client();

const foo = client.register({
    uri: 'http://foo.site.com/manifest.json',
    name: 'foo',
});
const bar = client.register({
    uri: 'http://bar.site.com/manifest.json',
    name: 'bar',
});

await Promise.all([foo.fetch(), bar.fetch()]);

client.js(); // Array of js entries

.css()

Retrieve a list of all CSS references from all registered and fetched components.

const Client = require('@podium/client');
const client = new Client();

const foo = client.register({
    uri: 'http://foo.site.com/manifest.json',
    name: 'foo',
});
const bar = client.register({
    uri: 'http://bar.site.com/manifest.json',
    name: 'bar',
});

await Promise.all([foo.fetch(), bar.fetch()]);

client.css(); // Array of css entries

.refresh()

This method will refresh a resource by reading its manifest and fallback if defined in the manifest. The method will not call the URI to the content of a component.

If the internal cache in the client already has a manifest cached, this will be thrown away and replaced when the new manifest is successfully fetched. If a new manifest cannot be successfully fetched, the old manifest will be kept in cache.

If a manifest is successfully fetched, this method will resolve with a true value. If a manifest is not successfully fetched, it will resolve with false.

const Client = require('@podium/client');
const client = new Client();

client.register({ uri: 'http://foo.site.com/manifest.json', name: 'foo' });

console.log(client.js()); // []

const status = await client.refresh();

console.log(status); // true
console.log(client.js()); // ['foo.js', 'bar.js']

refreshManifests()

Refreshes the manifests of all registered resources. Does so by calling the .refresh() method on all resources under the hood.

const Client = require('@podium/client');
const client = new Client();

client.register({ uri: 'http://foo.site.com/manifest.json', name: 'foo' });
client.register({ uri: 'http://bar.site.com/manifest.json', name: 'bar' });

console.log(client.js()); // []
console.log(client.css()); // []

await client.refreshManifests();

console.log(client.js()); // ['foo.js', 'bar.js']
console.log(client.css()); // ['foo.css', 'bar.css']

.dump()

Returns an Array of all loaded manifests ready to be used by .load().

.load()

Loads an Array of manifests, provided by .dump(), into the client. If any of the items in the loaded Array contains a key which is already in the cache the entry in the cache will be overwritten.

If any of the entries in the loaded Array are not compatible with the format which .dump() exports, they will not be inserted into the cache.

Returns an Array with the keys which were inserted into the cache.

Events

The client emits the following events:

change

When there is a change in version number between the cached manifest held by the client and the manifest on the remote source.

The event will fire after a new version of the manifest on the remote source is fetched.

Emits the new manifest.

const client = new Client();
client.on('change', manifest => {
    console.log(manifest);
});

const resource = client.register({
    uri: 'http://foo.site.com/manifest.json',
    name: 'foo',
});

Podium Resource Object

A registered Podium component is stored in a Podium Resource Object.

The Podium Resource Object contains methods for retrieving the content of a Podium component. The URI to the content of a component is defined in the component's manifest. This is the content root of the component.

A Podium Resource Object has the following API:

.fetch(podiumContext, options)

Fetches the content of the component. Returns a Promise.

podiumContext (required)

The Podium Context. See https://github.com/podium-lib/context

options (optional)

An options object containing configuration. The following values can be provided:

• pathname - {String} - A path which will be appended to the content root of the component when requested.
• headers - {Object} - An Object which will be appended as http headers to the request to fetch the component's content.
• query - {Object} - An Object which will be appended as query parameters to the request to fetch the component's content.

.stream(podiumContext, options)

Streams the content of the component. Returns a ReadStream.

podiumContext (required)

The Podium Context. See https://github.com/podium-lib/context

options (optional)

An options object containing configuration. The following values can be provided:

• pathname - {String} - A path which will be appended to the content root of the component when requested.
• headers - {Object} - An Object which will be appended as http headers to the request to fetch the component's content.
• query - {Object} - An Object which will be appended as query parameters to the request to fetch the component's content.

.name

A property returning the name of the podium resource. This is the name provided during the call to register.

.uri

A property returning the location of the podium resource.

Controlling caching of the manifest

The client has an internal cache where it keeps a cached version of the manifest for each registered Podium component.

By default all manifests are cached for 24 hours unless a new version of the manifest is detected by a change in the podlet-version HTTP header on the content URI. When this happens, the cache is thrown away and the fresh version of the manifest is cached.

The default length of time the manifest is cached for can be configured by setting maxAge in the constructor of the client.

const client = new Client({ maxAge: 1000 * 60 * 60 * 4 });

It is also possible to control how long a manifest should be cached in the client from a Podium component. This is done by setting a RFC 7234 compatible HTTP header on the manifest on the server serving the Podium component.

Example: This will cache the manifest for 1 hour:

const app = express();
app.get('/manifest.json', (req, res) => {
    res.setHeader('cache-control', 'public, max-age=3600');
    res.status(200).json({
        name: 'foo',
        content: '/index.html',
    });
});

Defining a component as throwable

By default the client will never throw if something fails in the process of retreiving the manifest, the fallback or the content itself. It will simply provide a fallback if it has one or an empty String for the resource in an error situation.

There are however, cases where throwing an error is more appropriate. This can be achieved by setting the option throwable to true in the .register() method. If an error is thrown in the process of retrieving the manifest, the fallback or the content then it can then be acted upon.

Example:

const Client = require('@podium/client');
const client = new Client();

const foo = client.register({
    name: 'foo',
    uri: 'http://foo.site.com/manifest.json',
});

const bar = client.register({
    name: 'bar',
    uri: 'http://bar.site.com/manifest.json',
    throwable: true,
});

Promise.all([foo.fetch(), bar.fetch()])
    .then(content => {
        console.log(content);
    })
    .catch(error => {
        console.log(error);
    });

In this example, the catch will be triggered if bar encounters an error in the process of retrieving content from the remote. If the same happens with foo the catch will NOT be triggered.

When a resource is flagged as throwable and it throws an error the error will be an enriched boom with detailed information on what went wrong.

The error object will reflect the http status code of the remote. In other words; if the remote responded with a 404, the statusCode in the error object will be 404.

On retrying

A component consists of a manifest which contains metadata about that component. This manifest is fetched and cached by the client together with it's fallback content if such content has been defined.

Detection of updates to a component is done by the content route in the component serving an HTTP header with the same version number as in the component's manifest and if the client detects a difference between the HTTP header version number and the version in the manifest cached in the client, the component has changed.

In the event of an update the client will have to do multiple HTTP requests to refetch the manifest, fallback and content. In a distributed system there can be windows where a component can exist with two versions at the same time during a rolling deploy. In such a scenario the client might go into an "update loop" due to hitting different versions of the component.

In a rolling deploy this is not nessessery a bad thing. But to protect both the application using the client and the component itself, the client will terminate the process of updating if such an "update loop" is detected. How many times the client will retry settling an update before termination can be set by the retries argument in the client constructor and the .register() method.

License

Copyright (c) 2019 FINN.no

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

[3.0.1] - 2019-02-21

• Updated dependencies.