@lpgroup/feathers-utils

Collection of feathers-utils hooks and helper functions

Install

Installation of the npm

1npm install @lpgroup/feathers-utils

Example

1const auth = require("@lpgroup/feathers-utils");

How to use cache feature

If you want to cache the mongodb document (JSON) in the cache the only thing you need to do is to extend from ServiceCache instead of Service. it will use the default cache configuration. The cached item will be invalidated and removed on update, patch, removed.

max: 500 items ttl: 300000 // 5 minutes

you can override this in service options

1const options = {
2  id: "_id",
3  paginate: app.get("paginate"),
4  schema,
5  cache: { max: 1000 },
6};

Example using service cache

1const { ServiceCache } = require("@lpgroup/feathers-utils");
2
3export class Service1 extends ServiceCache {
4  constructor(options, app) {
5    super(options);
6    this.app = app;
7
8    onPluginReady("mongodb").then(({ database }) => {
9      this.Model = database.collection("serivce1");
10    });
11  }
12}

If you want to cache just part of the the mongodb document (JSON) in the cache. You can create caches on the service that you can access anywhere where you have access to the app.

You can specify a callback to set data in the cache and options:

1const { CreateCache } = require("@lpgroup/feathers-utils");
2import { Service } from "feathers-mongodb";
3
4export class Service1 extends Service {
5  constructor(options, app) {
6    super(options);
7    this.app = app;
8
9    onPluginReady("mongodb").then(({ database }) => {
10      this.Model = database.collection("serivce1");
11    });
12
13    CreateCache(
14      this,
15      "mapToOwner",
16      (data) => {
17        return { owner: data.owner };
18      },
19      { max: 1000 },
20    );
21  }
22}

To use the cache you get access to the caches from the service:

1// setting the owner of the message to the same as the visitor, this makes it possible for
2// admin to create messages for the visitors.
3const { owner } = await app
4  .service("/organisations/:organisationAlias/bots/:botAlias/visitors")
5  .caches.mapToOwner.get(visitorId);
6
7data.owner = owner;

limitRequest

This is a middleware to limit the request. And will respond a status of 429.

import { limitRequest } from "@lpgroup/feathers-utils";

export default (app) => {
  app.use(limitRequest(app));
};

default.json

  "tooManyRequest": {
    "isEnabled": true,
    "buketSize": 80,
    "ttlSec": 2,
    "whiteList": ["127.0.0.2"]
  },

Property	Default	Type	Description
isEnabled	true	boolean	enable/disable 429
bucketSize	100	number	num of request to display 429
ttlSec	5 sec	number	refresh bucketSize time in sec
whiteList	[]	array	exempted IPs e.g ["127.0.0.1"]

API

xxx

xxx(xxx)

1xxx(xxx);

Contribute

See contribute

License

MIT - See licence