@condor-labs/sqs v1.0.5

This module provide and usefull helper to use the official AWS-SQS library.

See official documentation here.

Compatibility

The minimum supported version of Node.js is v8.

How to use it

To use the library you just need to follow the following steps Install the library with npm

npm install @condor-labs/sqs

Import the library:

const sqs = require('@condor-labs/sqs')(settings);

Credentials settings object properties

Push settings object properties

Polling settings object properties

Examples

constants.js

module.exports = {
    queueStandardURL: 'https://sqs.us-east-1.amazonaws.com/9999999/npm-example-sqs-standard',
    queueFIFOURL: 'https://sqs.us-east-1.amazonaws.com/999999/npm-example-sqs.fifo',
    awsCredentials: {
        accessKeyId: "AKIAJPLYT*****",
        secretAccessKey: "YfXKJz+Y5garKqKpEp******",
        region: "us-xxxx-##"
    },
    MessageBody: JSON.stringify({
        "id_owner": "222881",
        "entityId": "222881",
        "eventDate": "2017-08-19T15:43:23.784",
        "eventType": "COMPLIANCE",
        "data":
        {
            "id_user": 4087436,
            "source": {
                "code": "NEW_OWNER_OH_SPEECH"
            }
        }
    })
};

./sqs-poll-callback/index.js

const sqs = require('@condor-labs/sqs');

const {
    queueStandardURL,
    awsCredentials
} = require('./../constants');
const worker = {
    pollHandlerWithCallback: (message, cb) => {
        console.log('sqs-poll-callback OK!!!');
        cb();
        // get just one message (for testing purpose) :) 
        process.exit(1);
    },
    start: () => {

        //Standard queue
        const pollParams = {
            queueUrl: queueStandardURL,
            pollHandler: self.pollHandlerWithCallback,
            isCallback: true,
            batchSize: 1,
            waitTimeSeconds: 1,
            visibilityTimeout: 30
        };
        sqs.poll(pollParams, awsCredentials);
    }
};

// Start polling
if (!module.parent) {
    worker.start();
}

./sqs-poll-promise/index.js

const sqs = require('@condor-labs/sqs');

const {
    queueStandardURL,
    awsCredentials
} = require('./../constants');

const worker = {
    pollHandlerPromise: async message => {
        console.log('sqs-poll-promise OK!!!');
        // get just one message (for testing purpose) :) 
        process.exit(1);
    },
    start: () => {

        //Standard queue
        const pollParams = {
            queueUrl: queueStandardURL,
            pollHandler: self.pollHandlerPromise,
            isCallback: false, /* Default: false */
            batchSize: 1,
            waitTimeSeconds: 1,
            visibilityTimeout: 30
        };
        sqs.poll(pollParams, awsCredentials);
    }
};

// Start polling
if (!module.parent) {
    worker.start();
}

./sqs-push-fifo/index.js

const sqs = require('@condor-labs/sqs');

const {
    queueFIFOURL,
    awsCredentials,
    MessageBody
} = require('./../constants');

(async () => {
    let pushParams = {
        queueUrl: queueFIFOURL,
        messageBody: MessageBody,
        maxAttempts: 0, //Optional
        isFifo: true,
        messageGroupId: 'example-group-id',
        messageDeduplicationId: `messageDeduplicationId_${(new Date()).getTime()}`
    };
    // TEST PUSH in Standard queue (Promise implementation)
    let res = await sqs.push(pushParams, awsCredentials);
    console.log('sqs-push-fifo(Promise) OK!!');
    console.log('----------------------------------------------');

    // TEST PUSH in Standard queue ( CB implementation)
    pushParams.messageDeduplicationId = `messageDeduplicationId_${(new Date()).getTime()}`; // update deduplication param
    sqs.pushcb(pushParams, awsCredentials, (err, res) => {
        if (err) {
            console.log('sqs-push-fifo(callback) - err', err);
            return;
        }
        console.log('sqs-push-fifo(callback) OK!!!');
        console.log('----------------------------------------------');
        process.exit(1);
    });
})();

./sqs-push-standard/index.js

const sqs = require('@condor-labs/sqs');

const {
    queueStandardURL,
    awsCredentials,
    MessageBody
} = require('./../constants');

(async () => {
    const pushParams = {
        queueUrl: queueStandardURL,
        messageBody: MessageBody,
        delaySeconds: 0, //Optional
        maxAttempts: 0 //Optional
    };
    // TEST PUSH in Standard queue (Promise implementation)
    let res = await sqs.push(pushParams, awsCredentials);
    console.log('sqs-push-standard(Promise) OK!!!');
    console.log('----------------------------------------------');
    // TEST PUSH in Standard queue ( CB implementation)
    sqs.pushcb(pushParams, awsCredentials, (err, res) => {
        if (err) {
            console.log('sqs-push-standard(callback) - err', err);
            return;
        }
        console.log('sqs-push-standard(callback) OK!!!');
        console.log('----------------------------------------------');
        process.exit(1);
    });
})();

How to Publish

Increasing package version

You will need to update the package.json file placed in the root folder.

identify the property version and increase the right number in plus one.

Login in NPM by console.

 npm login
 [Enter username]
 [Enter password]
 [Enter email]

If all is ok the console will show you something like this : Logged in as USERNAME on https://registry.npmjs.org/.

Uploading a new version

 npm publish --access public

Ref: https://docs.npmjs.com/getting-started/publishing-npm-packages

Note: you will need to have a NPM account, if you don't have one create one here: https://www.npmjs.com/signup

Contributors

The original author and current lead maintainer of this module is the @condor-labs development team.

More about Condorlabs Here.

License

MIT