npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lk-collection

v3.2.1

Published

Implement collections in a lk stack (Lambda, Kinesis, MongoDB)

Downloads

73

Readme

Build Status Coverage Status Dependency Status devDependency Status

#lk-collection

Implement collections in an lk stack (Lambda, Kinesis + MongoDB).

TODO: transaction id

How it works

The library allows creating a collection object which has attached two lambda functions:

  • apiGatewayToKinesis: takes a request from API Gateway and publishes an event to a Kinesis stream

  • kinesisToMongodb: takes kinesis events and projects them into a mongodb collection

Flow

Application event format

    {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "data": {},
        "timestamp": 1437918813731,
        "type": "event-type"
    }

The data property can be any JSON document.

Collection events

Insert

Client -> API Gateway:

POST /collection-name HTTP/1.1
Host: api-gateway.amazon.com
Content-Type: application/json
X-Token: authToken

{
    "elementKey": "elementValue"
}

API Gateway -> Lambda:

{
    "collection": "collection-name",
    "method": "insert",
    "element": {
        "elementKey": "elementValue"
    },
    "token": "authToken"
}

Lambda -> Kinesis -> Lambda:

{
    "data": {
        "id": "generatedId",
        "element": {
            "elementKey": "elementValue"
        }
    },
    "timestamp": "1970-01-01T00:00:00.000Z",
    "type": "element inserted in collection collection-name"
}

Lambda -> MongoDB: Inserted document:

{
    "_id": "generatedId",
    "elementKey": "elementValue"
}

Remove

Client -> API Gateway:

DELETE /collection-name/elementId HTTP/1.1
Host: api-gateway.amazon.com
X-Token: authToken

API Gateway -> Lambda:

{
    "collection": "collection-name",
    "method": "remove",
    "elementId": "elementId",
    "token": "authToken"
}

Lambda -> Kinesis -> Lambda:

{
    "data": {
        "id": "elementId"
    },
    "timestamp": "1970-01-01T00:00:00.000Z",
    "type": "element removed in collection collection-name"
}

Lambda -> MongoDB Removed document:

{
    "_id": "elementId"
}

Replace

Client -> API Gateway:

PUT /collection-name/elementId HTTP/1.1
Host: api-gateway.amazon.com
Content-Type: application/json
X-Token: authToken

{
    "elementKey": "replacedValue"
}

API Gateway -> Lambda:

{
    "collection": "collection-name",
    "method": "replace",
    "elementId": "elementId",
    "element": {
        "elementKey": "replacedValue"
    },
    "token": "authToken"
}

Lambda -> Kinesis -> Lambda:

{
    "data": {
        "id": "elementId",
        "element": {
            "elementKey": "replacedValue"
        }
    },
    "timestamp": "1970-01-01T00:00:00.000Z",
    "type": "element replaced in collection collection-name"
}

Lambda -> MongoDB Updated document:

{
    "_id": "elementId",
    "elementKey": "replacedValue"
}

Example usage

/* Lambda function invoked by API Gateway */
import Collection, {RequestError} from "lk-collection";

const myCollection = new Collection({
    name: "myCollectionName",
    mongodbUrl: "mongodb://myMongoHost/myDb",
    schema: {
        $schema: "http://json-schema.org/draft-04/schema#",
        type: "object"
    },
    authorizeApiRequest: (request) => {
        if (Math.random() > 0.5) {
            throw new RequestError(400, "Message", "Details");
        }
    },
    kinesisStreamName: "myStream"
});

export const handler = myCollection.apiGatewayToKinesis;
/* Lambda function invoked by Kinesis */
import Collection from "lk-collection";

const myCollection = new Collection({
    name: "myCollectionName",
    mongodbUrl: "mongodb://myMongoHost/myDb",
});

export const handler = myCollection.kinesisToMongodb;

Authorization

It's possible to pass the constructor an authorizeApiRequest function which either:

  • returns a value
  • throws
  • returns a promise

The validation is considered successful (hence the request is handled) if:

  • the authorizeApiRequest function returns a value
  • the authorizeApiRequest function returns a promise which is eventually resolved

The validation is considered unsuccessful (hence the request is rejected) if:

  • the authorizeApiRequest function throws
  • the authorizeApiRequest function returns a promise which is eventually rejected

If the error thrown / promise reject value is an instance of RequestError (import {RequestError} from "lk-collection"), then that error is used as error of the request. Otherwise a generic {code: 500, message: "Internal server error"} is used.