feedme-client

v0.0.39

Published

9 months ago

Feedme client library for Javascript.

Downloads

257

0High
0Medium
0Low

aarong

feedme

Feedme Javascript Client

A client library created and maintained as a core part of the Feedme project.

Runs in Node and the browser. Exposes a simple but powerful API and handles unexpected developments appropriately. Well documented and thoroughly tested.

A WebSocket transport is maintained as a core part of the project and is supported by the Feedme Node.js Server.

Library contributors and transport developers should see the developer documentation.

Feedme Javascript Client

Getting Started

NPM

Install the client:

npm install feedme-client

The client expects the application to provide a transport, through which it will communicate with the server.

npm install feedme-transport-websocket
# or
npm install feedme-transport-socketio

To initialize a client using the WebSocket transport:

const feedmeClient = require("feedme-client");
const wsTransport = require("feedme-transport-websocket/client");

const client = feedmeClient({
  transport: wsTransport({ url: "https://some.url/api/websocket" }),
});

Once a client has been initialized the application can listen for events and connect to the server.

CDN

The browser bundle can be included in a website as follows:

<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/feedme-client"
></script>

The module is bundled in UMD format and is named feedmeClient in the global scope.

A WebSocket transport bundle can be included similarly.

API

Client API

Initialization

To initialize a client:

const client = feedmeClient(options);

The client is initialized disconnected and will remain disconnected until there is a call to client.connect().

If initialization fails then the factory function will throw an Error object (err). The following errors may be thrown:

err.message === "INVALID_ARGUMENT: ..."
The options argument was invalid.
err.message === "TRANSPORT_ERROR: ..."
There was a problem with the supplied transport.

The options argument is an object with the following properties:

options.transport - Required object.
A transport object used to communicate with the server. The object must satisfy the requirements laid out in the developer documentation.
Application code must not operate on the transport object directly and must not pass a given transport object to more than one client instance.
The tranport object must be disconnected.
options.connectTimeoutMs - Optional non-negative integer. Defaults to 10000.
Specifies how long to wait for a Feedme conversation to initiate successfully or fail after a call to client.connect() and when reconnecting after a connection failure. The specified interval covers both the transport connection and the handshake.
If greater than 0, then the client will wait connectTimeoutMs. If that period elapses and a Feedme conversation has not been successfully established, the client will cancel the connection attempt, emit a disconnect event with a TIMEOUT error, and depending on configuration, may schedule a connection retry.
If set to 0, then the client will wait forever for a Feedme conversation to be succesfully established.
options.connectRetryMs - Optional integer. Defaults to 5000.
Specifies how long to wait before attempting another connection after a connection attempt fails for the first time. Subsequent retry intervals may be backed off as configured below.
If less then 0, then the client will not make another attempt to establish a connection. It is left to the application to call client.connect().
If set to 0, then the client will immediately make another attempt to establish a connection.
If greater than 0, then the client will wait connectRetryMs before making another attempt to establish a connection.
If a connection attempt fails due to a rejected handshake, then the client will not automatically reattempt to establish a connection.
options.connectRetryBackoffMs - Optional non-negative integer. Defaults to 5000.
Specifies the amount by which to increase the connection retry interval after each failure.
options.connectRetryMaxMs - Optional non-negative integer. Defaults to 30000.
Specifies the maximum interval to wait between connection attempts, irrespective of connectRetryBackoffMs.
Must be greater than or equal to connectRetryMs.
options.connectRetryMaxAttempts - Optional non-negative integer. Defaults to 0.
Specifies the maximum number of connection retries to attempt. 0 for unlimited connection retries.
options.actionTimeoutMs - Optional non-negative integer. Defaults to 10000.
Specifies how long to wait for a server response to a an action request before calling back a timeout error. 0 for no timeout.
options.feedTimeoutMs - Optional non-negative integer. Defaults to 10000.
Specifies how long to wait for a server response to a a feed open request before emitting a timeout error. 0 for no timeout.
options.reconnect - Optional boolean. Defaults to true.
Specifies behavior when the client disconnects due to a transport problem while connected.
If true, then the client will immediately attempt to reconnect to the server when the connection fails. If that connection attempt fails, then the client will retry as configured.
If false, then the client will not attempt to reconnect to the server when the connection fails. It is left to the application to call client.connect().
options.reopenMaxAttempts - Optional integer. Defaults to 3.
Specifies the maximum number of times to reopen a feed when it fails due to a bad feed action notification (that is, an invalid delta or hash mismatch).
If set less than zero, then the client will always attempt to reopen feeds when there is a bad feed action notification.
If set to 0, then the client will not attempt to reopen a feed when there is a bad feed action notification. This configuration is not recommended. If there is a subsequent disconnect/reconnect or a valid call to feed.desireOpen(), then the client will attempt to reopen the feed at that time.
If set greater than 0, then the client will immediately attempt to reopen a feed when there is a bad feed action notification, provided that there have been fewer than reopenMaxAttempts tries over the past reopenTrailingMs. When at the threshold, the client will wait until the number failures over the past reopenTrailingMs falls back below reopenMaxAttempts and then attempt to reopen the feed. Counters are reset when the client disconnects.
options.reopenTrailingMs - Optional non-negative integer. Defaults to 60000.
Specifies the length of the trailing interval over which reopenMaxAttempts applies.
If set to 0 then feed failures are counted over the duration of the connection.

Client Methods

client.state()

Returns the current client state:

"disconnected" - The client is not connected to the server and is not currently attempting to connect. A connection attempt may be pending, depending on configuration.
"connecting" - The client is attempting to connect to the server and perform a handshake.
"connected" - The client is connected to the server and has performed a successful handshake.

Errors thrown:

err.message === "TRANSPORT_ERROR: ..."
The transport behaved unexpectedly.
err.message === "DESTROYED: ..."
The client instance has been destroyed.

client.connect()

Initiates an attempt to connect to the server and perform a handshake. The client state must be disconnected. Returns nothing.

Errors thrown:

err.message === "INVALID_STATE: ..."
The client state is not disconnected.
err.message === "TRANSPORT_ERROR: ..."
The transport behaved unexpectedly.
err.message === "DESTROYED: ..."
The client instance has been destroyed.

client.disconnect()

Disconnects from the server. The client state must be either connecting or connected. Returns nothing.

Errors thrown:

err.message === "INVALID_STATE: ..."
The client state is not connecting or connected.
err.message === "TRANSPORT_ERROR: ..."
The transport behaved unexpectedly.
err.message === "DESTROYED: ..."
The client instance has been destroyed.

client.action(...) - Callback Style

Usage: client.action(actionName, actionArgs, callback)

Invokes an an action on the server. The client state must be connected. Returns nothing.

If the transport encounters an immediate problem transmitting a message to the server then the client state will synchronously become disconnected.

Arguments:

actionName - Required string. The name of the action being invoked.
actionArgs - Required object. The action arguments to pass to the server. Must be JSON-expressible.
callback - Required function. Invoked when the server responds to the action request before it times out, or when the action request times out.
If the action is executed successfully, the function is invoked as follows:
```
callback(undefined, actionData);
```
... where actionData is the action description returned by the server.
If the action fails or times out, the function is invoked as follows:
```
callback(err);
```
... where err is an Error object.

Errors thrown:

err.message === "INVALID_ARGUMENT: ..."
There was a problem with one or more of the supplied arguments.
err.message === "TRANSPORT_ERROR: ..."
The transport behaved unexpectedly.
err.message === "DESTROYED: ..."
The client instance has been destroyed.

Errors called back:

err.message === "TIMEOUT: ..."
The server did not respond within the amount of time specified by options.actionTimeoutMs. The library will discard any subsequent response from the server.

err.message === "NOT_CONNECTED: ..."
The client was not connected to the server at the time of the action invocation or the client disconnected from the server before it received a response. If the client was connected to the server at the time of the action invocation, the subsequent disconnect may have resulted from a call to client.disconnect() or due to a transport connectivity failure. In both cases, the action callback is invoked before any feed close events are emitted, and feed close events are emitted before the client disconnect event is emitted.
err.message === "REJECTED: ..."
The server rejected the action request. The error details returned by the server are available in err.serverErrorCode (string) and err.serverErrorData (object).

client.action(...) - Promise Style

Usage: client.action(actionName, actionArgs)

Invokes an an action on the server. The client state must be connected. Returns a promise that resolves if the action succeeds and rejects if the action fails.

If the transport encounters an immediate problem transmitting a message to the server then the client state will synchronously become disconnected.

Arguments:

actionName - Required string. The name of the action being invoked.
actionArgs - Required object. The action arguments to pass to the server. Must be JSON-expressible.

Errors thrown:

err.message === "INVALID_ARGUMENT: ..."
There was a problem with one or more of the supplied arguments.

err.message === "TRANSPORT_ERROR: ..."
The transport behaved unexpectedly.

err.message === "DESTROYED: ..."
The client instance has been destroyed.

Errors returned via promise rejection:

err.message === "TIMEOUT: ..."
The server did not respond within the amount of time specified by options.actionTimeoutMs.
err.message === "NOT_CONNECTED: ..."
The client was not connected to the server at the time of the action invocation or the client disconnected from the server before it received a response. If the client was connected to the server at the time of the action invocation, the subsequent disconnect may have resulted from a call to client.disconnect() or due to a transport connectivity failure. In both cases, the action promise is rejected before any feed close events are emitted, and feed close events are emitted before the client disconnect event is emitted.
err.message === "REJECTED: ..."
The server rejected the action request. The error details returned by the server are available in err.serverErrorCode (string) and err.serverErrorData (object).

client.feed(...)

Usage: client.feed(feedName, feedArgs)

Returns a Feed object that can be used to interact with feeds on the server. See the Feed API section for usage.

The client need not be connected to create feed objects.

Feed objects are initialized with their desired state set to closed.

Arguments:

feedName - Required string. The name of the feed to open.
feedArgs - Required object. The arguments of the feed to open. Must contain zero or more string properties.

Errors thrown:

err.message === "INVALID_ARGUMENT: ..."
There was a problem with one or more of the supplied arguments.
err.message === "DESTROYED: ..."
The client instance has been destroyed.

client.destroy()

Destroys the client instance and all feed objects so that they may be safely disposed of. Returns nothing.

The client instance may emit one or more previously-deferred events, execute a previously-deferred callback, or settle a previously-deferred promise subsequent to destruction, but it will not queue any further invocations on the application.

Destroying the client instance detaches library event handlers from the transport, but it does not detach application event handlers from the library.

Errors thrown:

err.message === "INVALID_STATE: ..."
The client is not disconnected.
err.message === "DESTROYED: ..."
The client instance has already been destroyed.

client.destroyed()

Returns a boolean indicating whether the client has been destroyed.

Errors thrown: None

Client Events

Library methods may cause certain events to be emitted synchronously, so the application should generally attach any event handlers immediately after initialization.

connecting

Emitted when the client state changes from disconnected to connecting.

Listeners are invoked with no arguments.

connect

Emitted when the client state changes from connecting to connected.

Listeners are invoked with no arguments.

disconnect

Emitted when the client state changes from connecting or connected to disconnected, and when the client state is disconnected but the reason for being disconnected has changed.

If the disconnect resulted from a call to client.disconnect() then listeners are invoked with no arguments.

If the disconnect resulted from an error condition then listeners are passed an Error object (err). The following errors are possible:

err.message === "TIMEOUT: ..." - The transport was unable to connect to the server within options.connectTimeoutMs. Another connection attempt may be pending, depending on configuration.
err.message === "HANDSHAKE_REJECTED: ..." - The transport connected to the server but the handshake failed. The client will not reattempt the connection automatically.
err.message === "TRANSPORT_FAILURE: ..." - The transport failed to establish a connection to the server or lost its connection unexpectedly.
- err.transportError (Error) contains the error reported by the transport.

badServerMessage

Emitted when the server has violated the Feedme specification.

Listeners are passed an Error object (err). The following errors are possible:

err.message === "INVALID_MESSAGE: ..." - The server transmitted a message that was not valid JSON or that violated one of the JSON schemas laid out in the specification.
- err.serverMessage (JSON value) The message received from the server. If the message was not valid JSON, then this property holds the raw string message, otherwise it holds the parsed JSON value.
- err.parseError (optional Error) is the error thrown by the JSON parser, if applicable.
- err.schemaViolation (optional string) describes the schema violation, if applicable.
err.message === "UNEXPECTED_MESSAGE: ..." - The server transmitted a message that was invalid given the state of the conversation.
- err.serverMessage (object) contains the server message.
err.message === "INVALID_DELTA: ..." - The server transmitted a feed delta that was invalid given the state of the feed data.
- err.serverMessage (object) contains the server message.
- err.deltaViolation (string) contains a description of the violation.
err.message === "INVALID_HASH: ..." - The feed data hash transmitted by the server did not match the hash of the post-delta feed data.
- err.serverMessage (object) contains the server message.

badClientMessage

Emitted when the server indicates that the client has violated the Feedme specification. This can indicate a problem on the client or the server.

Listeners are passed a diagnostics object containing any server-specified diagnositic information.

Feed API

Feed objects enable interaction with feeds on the server and are created using client.feed().

Feed Objects vs Server Feeds

A distinction must be drawn between feed objects (the Javascript objects documented here) and server feeds (the concept defined in the Feedme specification).

When multiple feed objects point to the same server feed (that is, they share the same feed name-argument combination), the library will try to keep the server feed open if any of the feed objects has its desired state set to open. If all feed objects are desired closed, the library will close the server feed. The library will emit relevant feed action notifications only on feed objects that have their desired state set to open.

Desired vs Actual State

A distinction must be drawn between the desired state of a feed object and its actual state. The application is free to manipulate the desired state of each feed object according to its needs, while the actual state is also influenced by factors like connectivity and authorization.

The desired state of a feed object may be open or closed. It is controlled using feed.desireOpen() and feed.desireClosed() and retrieved using feed.desiredState().

The actual state of a feed object can be opening, open, or closed. It is retrieved using feed.state(). Changes in a feed object's actual state can be monitored by listening for opening, open, and close events.

When a feed object's desired state is closed, its actual state is always closed. When a feed object's desired state is open, its actual state may be opening, open, or closed, with the latter reflecting an error condition.

When a feed object's actual state is open, the feed data is available using feed.data() and the feed object will emit action events when the server reveals actions on the feed.

Feed Object Methods

feed.desireOpen()

Sets the feed object's desired state to open.

A feed object's desired state persists through the connection cycle. If a feed is desired open and the client disconnects and reconnects, the library will attempt to reopen the server feed. Returns nothing.

If the transport encounters an immediate problem transmitting a message to the server then the client state will synchronously become disconnected and the feed state will synchronously become closed.

Errors thrown:

err.message === "INVALID_FEED_STATE: ..."
The feed object's desired state is already open.
err.message === "TRANSPORT_ERROR: ..."
The transport behaved unexpectedly.
err.message === "DESTROYED: ..."
The feed object has been destroyed.

feed.desireClosed()

Sets the feed object's desired state to closed. Returns nothing.

Errors thrown:

err.message === "INVALID_FEED_STATE: ..."
The feed object's desired state is already closed.
err.message === "TRANSPORT_ERROR: ..."
The transport behaved unexpectedly.
err.message === "DESTROYED: ..."
The feed object has been destroyed.

feed.desiredState()

Returns the desired state of the feed object, either "closed" or "open".

Errors thrown:

err.message === "DESTROYED: ..."
The feed object has been destroyed.

feed.state()

Returns the actual state of the feed object, either "closed", "opening", or "open". If a feed object is desired closed then the actual state will always be closed.

Errors thrown:

err.message === "TRANSPORT_ERROR: ..."
The transport behaved unexpectedly.
err.message === "DESTROYED: ..."
The feed object has been destroyed.

feed.data()

Returns an object containing the current feed data. The structure of the object is determined by the server.

Errors thrown:

err.message === "INVALID_FEED_STATE: ..."
The feed object's actual state is not open.
err.message === "TRANSPORT_ERROR: ..."
The transport behaved unexpectedly.
err.message === "DESTROYED: ..."
The feed object has been destroyed.

feed.destroy()

Destroys the feed object so that it may be safely disposed of. Returns nothing.

The feed object may emit one or more previously-deferred events subsequent to destruction, but it will not queue any further events.

Destroying a feed object does not remove application event handlers.

Errors thrown:

err.message === "INVALID_FEED_STATE: ..."
Only feed objects desired closed can be destroyed.
err.message === "DESTROYED: ..."
The feed object has already been destroyed.

feed.destroyed()

Returns a boolean indicating whether the feed has been destroyed.

Errors thrown: None

Feed Object Events

Library methods may cause certain events to be emitted synchronously, so the application should generally attach any event handlers immediately after initialization.

opening

Emitted when the actual feed object state changes from closed to opening.

No arguments are passed to the listeners.

open

Emitted when the actual feed object state changes from opening to open.

Arguments passed to the listeners:

feedData (object)
The feed initial state of the feed data.

close

Emitted when the actual state of the feed object changes from opening or open to closed, and when the error condition has changed since an earlier close event was emitted (for example, when feed access is denied by the server and then the client disconnects from the server, or when the feed is desired closed and then desired open but the client is not connected to the server).

If the event was triggered by a call to feed.desireClosed() then no arguments are passed to the listeners.

If the event was triggered by an error condition, then the listeners are passed an Error object (err) as an argument. The following errors are possible:

err.message === "TIMEOUT: ..."
The attempt to open the feed on the server timed out. If the client receives a post-timeout result from the server, then the feed object will emit as appropriate.
err.message === "REJECTED: ..."
The server rejected the client's request to open the feed. The error details returned by the server are available in err.serverErrorCode (string) and err.serverErrorData (object).
The client will reattempt to open the server feed if it disconnects/reconnects, or if a feed object associated with the feed receives a valid call to feed.desireOpen().
err.message === "NOT_CONNECTED: ..."
The client is not connected to the server. If a connection is later established, the feed object will emit as appropriate. If the server has just disconnected, then the feed close event will always be emitted after any outstanding action callbacks/promises have been invoked/settled, but before the client disconnect event.
err.message === "TERMINATED: ..."
The server terminated the client's access to the feed. The error details returned by the server are available in err.serverErrorCode (string) and err.serverErrorData (object).
The client will attempt to reopen the feed if it disconnects/reconnects, or if a feed object associated with the feed receives a valid call to feed.desireOpen().
err.message === "BAD_FEED_ACTION: ..."
The server transmitted a feed action notification with an invalid delta operation or a non-matching feed data hash.
The client will attempt to reopen the feed as configured.

action

Emitted when the server reveals an action on the feed, provided that the feed object is desired open.

Arguments passed to the listeners:

actionName (string)
The name of the action.
actionData (object)
The data transmitted by the server describing the action.
newFeedData (object)
The feed data after applying any updates associated with the action.
oldFeedData (object)
The feed data before applying any updates associated with the action.

Sample Code

The following code initializes a client with the WebSocket transport, creates a feed object, connects to the server, reporting results to the console.

const feedmeClient = require("feedme-client");
const wsTransport = require("feedme-transport-websocket/client");

// Initialize the client
const client = feedmeClient({
  transport: wsTransport({ url: "https://some.url/api/websocket" })
});

// Create a feed object
const feed = client.feed(
  "SomeFeed",
  { SomeArgument: "SomeValue" }
);
feed.on("opening", () => {
  console.log("Opening feed...");
});
feed.on("open", () => {
  console.log("Feed is now open. The feed data is:", feed.data());
});
feed.on("action", (actionName, actionData, newFeedData, oldFeedData) => {
  console.log("Observed an action on the feed:", actionName);
});
feed.on("close", (err) => {
  console.log("Feed closed with error", err);
});
feed.desireOpen();

// Listen for client events
client.on("connecting", () => {
  console.log("Connecting to the server...");
});
client.on("connect", () => {

  console.log("Connected.");

  // Perform an action
  client.action(
    "SomeAction",
    { SomeArgument: "SomeValue" },
    (err, actionData) => {
      if (err) {
        console.log("The action failed with error:", err);
      } else {
        console.log("The action succeeded with data:", actionData);
      }
    }
  });

});
client.on("disconnect", (err) => {
  console.log("Disconnected from the server with error:", err);
});

// Connect to the server
client.connect();

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Feedme Javascript Client

Getting Started

NPM

CDN

API

Client API

Initialization

Client Methods

client.state()

client.connect()

client.disconnect()

client.action(...) - Callback Style

client.action(...) - Promise Style

client.feed(...)

client.destroy()

client.destroyed()

Client Events

connecting

connect

disconnect

badServerMessage

badClientMessage

Feed API

Feed Objects vs Server Feeds

Desired vs Actual State

Feed Object Methods

feed.desireOpen()

feed.desireClosed()

feed.desiredState()

feed.state()

feed.data()

feed.destroy()

feed.destroyed()

Feed Object Events

opening

open

close

action

Sample Code