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

@erento/message-deduplication

v1.0.0

Published

Provided methods allow you to deduplicate messages and get as close to only once message delivery for Google Pub/Sub, long running jobs, etc.

Downloads

5

Readme

Message Deduplication

Possible usage for:

  • Google Pub/Sub "only once delivery"
  • Long running jobs
  • ...

To get as close as possible to "only-once delivery" this library stores temporary information to a selectable storage (in memory or redis) and verifies if the message has to be processed.

The message has 3 states:

  • Not existing (new message)

    Such a message should be processed by a subscriber.

  • In progress

    Such a message will be checked if the processing time is longer than ENV.MAX_ACKNOWLEDGE_TIME (max. acknowledge message time).

    • If it is not longer, it should not be processed.
    • If it is longer, it should be marked to be processed (to reset a time) and processed again.
  • Delivered

    Such a message should not be processed again.

Known issue:

It can happen (though, it is not likely) that the message comes so fast that the storage would not be able to store it. In this case, message would be still marked as ready to be processed and not "In Progress" and it would duplicate a processing.

How to use it

import {CanDeliver, canBeDelivered, setAsDelivered, setInProgress} from '@erento/message-deduplication';

const subscriberName = 'my-subscriber-name';

async function processMessage(message) {
    const messageDeliveryStatus: CanDeliver = await canBeDelivered(message.id, subscriberName);
    if (messageDeliveryStatus === CanDeliver.Yes) {
        await setInProgress(message.id, subscriberName);

        // process a message (your application logic)

        await setAsDelivered(message.id, subscriberName);
    } else if (messageDeliveryStatus === CanDeliver.NoAlreadyDelivered) {
        // Message was already delivered.
    } else if (messageDeliveryStatus === CanDeliver.NoInProgress) {
        // NACK the message = message should be retried (consider to retry the message with some small delay)
    }
}

Setup:

The behaviour can be modified by following environment variables:

  • MD_IN_MEMORY_ONLY (default: true)

    Boolean value defining if it should use in-memory cache or redis. In memory is not recommended in case you run the service on kubernetes.

  • MD_MAX_ACKNOWLEDGE_TIME (default: 900)

    A time in seconds. This time specifies, how long the script should run until it allows another delivery attempt. Note, that it doesn't send the message again, but only marks to be processed again. Resending of the message should be done by the publisher, e.g.: Google Pub/Sub Publisher.

  • MD_MAX_MESSAGE_DURATION (default: 864000 = 10 days)

    A time in seconds. This time specifies, what is the maximum lifetime of the message saved in the storage.

  • MD_REDIS_HOSTNAME (default: 127.0.0.1)

    The path to the redis client.

  • MD_REDIS_PORT (default: 6379)

    The port of redis client.

  • MD_REDIS_PASSWORD (default: my#secret#passw0rd!)

    The password to redis client. Set password as empty string to not require any password.

  • MD_REDIS_OPTIONS (default: no value)

    The options provided to the redis client, if provided.

Kubernetes setup

To make our life easier, there is our recommended setup for kubernetes, see more in deploy/kube/redis.yml.

There are only few changes required:

  • Change a name and key of the secret for REDIS_PASS.
  • Make sure redis-volume is prepared.

Stay in touch

License

This module is MIT licensed.