Many SDK operations provide both a callback and async/await friendly version. All callback-based operations are to be considered deprecated. RStreams will continue supporting them for backward compatibility but all new features and capabilities will only be added to the async operation flavor.
This is the RStreams Node SDK, a client-side library designed to push data to and pull data from queues of an RStreams Bus instance.
Prerequisites
RStreams Bus
You will need an RStreams Bus instance running to connect to. If you don’t, head on over to the RStreams Bus section first. This should only take 10 - 30 minutes.
RStreams Flow
Get a sample RStreams Flow project running that can connect to your RStreams Bus with the right config to verify you are up and running. It should take you less than 5 - 30 minutes depending on whether your Bus is installed already or not.
Are you setup to run the examples?
All examples in the SDK documentation assume that when these apps run, the RStreams SDK can discover the configuration it needs. The config it needs is the AWS resource IDs of the RStreams Bus instance deployed in your AWS account, things like the ID of the kinesis stream used by the bus and so on.
Of course, in a production environment the SDK will get the config in an intelligent and safe manner, say from AWS Secrets Manager. Please See the RStreams Flow Configuring RStreams doc.
Here’s the typescript type of the config.
Get the config
You will first need to get this config. By default, the RStreams Bus puts a secret in secrets manager that is the JSON config blob. The secret will be named rstreams-<bus name>. Go get the JSON config from this secret.
Save the config
As a file
Create a file named rstreams.config.json and put it in the same directory you are running your app in
or in any parent director and the SDK will just find it and use it.
As an environment variable
Create an environment variable named RSTREAMS_CONFIG whose value is the config JSON blob.
As an argument to the SDK itself
Create a variable in the code that is the config and then pass it into the SDK’s constructor.
1
2const RSTREAMS_BUS_CONFIG: ConfigurationResources = {
3 "Region": "some-value",
4 "LeoStream": "some-value",
5 "LeoCron": "some-value",
6 "LeoSettings": "some-value",
7 "LeoEvent": "some-value",
8 "LeoKinesisStream" : "some-value",
9 "LeoFirehoseStream": "some-value",
10 "LeoS3": "some-value"
11};
12
13const rsdk: RStreamsSdk = new RStreamsSdk(RSTREAMS_BUS_CONFIG);
Do you know how to access Botmon?
Botmon is a visualization, monitoring and debugging tool that installs with an instance of the RStreams as a website. Most examples will have you use Botmon to visualize what’s happening and to help diagnose issues.
TODO: how do they know how to access botmon?
Sample Apps
The examples in this section are geared toward creating apps that use the RStreams SDK to interact with an RStreams bus instance regardless of how those apps are written - standalone app or lambda function. For simplicity, the examples are simply standalone runnables node applications. All examples are applicable whether running as a standalone node app or as a registered queue event handler bot (lambda function). See the Event Handling Semantics article for more.
The RStreams Flow section focuses on apps written specifically as bots that are deployed as lambda functions and go into great detail on the specific use cases applicable to serverless applications.