https://github.com/ackeecz/fuqu

Fuqu is tiny package for node backend development which is used for manipulating with queues.
https://github.com/ackeecz/fuqu

ackee backend node nodejs queue

Last synced: about 1 month ago
JSON representation

Fuqu is tiny package for node backend development which is used for manipulating with queues.

• Host: GitHub
• URL: https://github.com/ackeecz/fuqu
• Owner: AckeeCZ
• License: mit
• Created: 2018-11-20T08:18:29.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-06T12:20:52.000Z (5 months ago)
• Last Synced: 2024-08-06T14:17:46.951Z (5 months ago)
• Topics: ackee, backend, node, nodejs, queue
• Language: TypeScript
• Homepage:
• Size: 172 KB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




# FuQu _[/fʌkjuː/](https://en.wikipedia.org/wiki/Help:IPA/English)_

Rude MQ wrapper that handles logging and message acknowlidgement for you

[![Build Status](https://img.shields.io/travis/AckeeCZ/fuqu.svg?style=flat-square)](https://travis-ci.org/AckeeCZ/fuqu)

[![Known Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/AckeeCZ/fuqu.svg?style=flat-square)](https://snyk.io/test/github/AckeeCZ/fuqu)

[![Coverage](https://img.shields.io/coveralls/github/AckeeCZ/fuqu?style=flat-square)](https://coveralls.io/github/AckeeCZ/fuqu)

[![Npm](https://img.shields.io/npm/v/fuqu.svg?style=flat-square)](https://www.npmjs.com/package/fuqu)

[![License](https://img.shields.io/github/license/AckeeCZ/fuqu.svg?style=flat-square)](https://github.com/AckeeCZ/fuqu/blob/master/LICENSE)



- 📨 Extensive predictable logging

- ☔ Covered with integration tests

- 🐇 Supports Google Pub/Sub and RabbitMQ

- 🤡 Mock implementation for your tests

- 💙 Typesafe message and attributes

- 🚦 Automatic message acknowlidgement

- 💓 Check heartbeat if connection is alive

- ⛔ Configurable consumer flow control

- 🐛 Debuggable with `DEBUG:*`

## Getting started

```bash

npm install fuqu

```

```typescript

// Create instance

const fuQu = fuQuRabbit<{ hello: string }>(connection, 'my-queue');

// Subscribe handler

fuQu.subscribe(msg => {

    console.log('Got this:', msg);

});

// Publish message

fuQu.publish({ hello: 'FuQu!' });

```

- Handler may be async

- Messages are automatically acknowledged. If there is an error, they are `nack`ed instead.

### Create instance

```typescript

import { connect } from 'amqplib';

import { PubSub } from '@google-cloud/pubsub';

import { fuQuPubSub, fuQuRabbit } from 'fuqu';

// RabbitMQ

const connection = await connect('amqp://localhost');

const fuQu1 = fuQuRabbit(connection, 'my-queue');

// Pub/Sub

const pubSub = new PubSub({/*...*/})

const fuQu1 = fuQuPubSub(pubSub, 'my-queue');

```

### Options

```typescript

const fuQu = fuQuRabbit(connection, 'my-queue', {

    // Throttle your consumers

    maxMessages: 1,

    // Log all events (typesafe, check for shapes!)

    eventLogger: event => {

        if (event.action !== 'hc') {

            console.log(`FuQu [${event.topicName}] (${event.action})`, event)

        }

    },

    // Mock with in-memory mock for your tests

    useMock: process.env.NODE_ENV === 'test',

    // Adapter specific options

    assertQueueOptions: {/* ... */}

});

```

 - Mock implements all general FuQu options. Accessing underlying message is unsafe and adapter specific options are ignored

 - `eventLogger` is for application logging, if no handler is passed, logging is disabled

 - For debug purposes, you can also enable logging via `DEBUG:*`, `DEBUG:fuqu:*` or `DEBUG:fuqu:my-topic:*`

 - `maxMessages` is transformed into specific options for each adapter, using custom adapter options might overwrite the behavior

### Rude mode

If you want to have optimal FuQu expirience, use imports from `fuqu/dist/real`.

## Testing

For running tests, start the following containers 🐳

```

docker-compose up --build

```

## License

This project is licensed under [MIT](./LICENSE).