Narrowly Preventing Mayhem

    serverless-offline-sns-imp

    0.52.1 • Public • Published

    serverless-offline-sns

    A serverless plugin to listen to offline SNS and call lambda fns with events.

    serverless Build Status npm version PRs Welcome License: MIT All Contributors

    Docs

    For an example of a working application please see serverless-offline-sns-example

    Prerequisites

    This plugin provides an SNS server configured automatically without you specifying an endpoint.

    If you'd rather use your own endpoint, e.g. from your AWS account or a localstack SNS server endpoint, you can put it in the custom config. See below for details.

    Installation

    Install the plugin

    npm install serverless-offline-sns --save

    Let serverless know about the plugin

    plugins:
      - serverless-offline-sns

    Note that ordering matters when used with serverless-offline and serverless-webpack. serverless-webpack must be specified at the start of the list of plugins.

    Configure the plugin with your offline SNS endpoint, host to listen on, and a free port the plugin can use.

    custom:
      serverless-offline-sns:
        port: 4002 # a free port for the sns server to run on
        debug: false
        # host: 0.0.0.0 # Optional, defaults to 127.0.0.1 if not provided to serverless-offline
        # sns-endpoint: http://127.0.0.1:4567 # Optional. Only if you want to use a custom endpoint
        # accountId: 123456789012 # Optional

    In normal operation, the plugin will use the same --host option as provided to serverless-offline. The host parameter as shown above overrides this setting.

    If you are using the serverless-offline plugin serverless-offline-sns will start automatically. If you are not using this plugin you can run the following command instead:

    serverless offline-sns start

    Configure

    Configure your function handlers with events as described in the Serverless SNS Documentation

    Here's an example serverless.yml config which calls a function on an SNS notifcation. Note that the offline-sns plugin will automatically pick up this config, subscribe to the topic and call the handler on an SNS notification.

    functions:
      pong:
        handler: handler.pong
        events:
          - sns: test-topic

    Or you can use the exact ARN of the topic:

    functions:
      pong:
        handler: handler.pong
        events:
          - sns:
             arn: "arn:aws:sns:us-east-1:123456789012:test-topic"

    Here's a demo of some code that will trigger this handler:

    var AWS = require("aws-sdk"); // must be npm installed to use
    var sns = new AWS.SNS({
      endpoint: "http://127.0.0.1:4002",
      region: "us-east-1",
    });
    sns.publish({
      Message: "hello!",
      MessageStructure: "json",
      TopicArn: "arn:aws:sns:us-east-1:123456789012:test-topic",
    }, () => {
      console.log("ping");
    });

    Note the region that offline-sns will listen on is what is configured in your serverless.yml provider.

    Localstack docker configuration

    In order to listen to localstack SNS event, if localstack is started with docker, you need the following:

    custom:
      serverless-offline-sns:
        host: 0.0.0.0 # Enable plugin to listen on every local address
        sns-subscribe-endpoint: 192.168.1.225 #Host ip address
        sns-endpoint: http://localhost:4575 # Default localstack sns endpoint

    What happens is that the container running localstack will execute a POST request to the plugin, but to reach outside the container, it needs to use the host ip address.

    Usage

    If you use serverless-offline this plugin will start automatically.

    However if you don't use serverless-offline you can start this plugin manually with -

    serverless offline-sns start

    Subscribing

    serverless-offline-sns supports http, https, and sqs subscriptions. email, email-json, sms, application, and lambda protocols are not supported at this time.

    When using sqs the Endpoint for the subscription must be the full QueueUrl returned from the SQS service when creating the queue or listing with ListQueues:

    // async
    const queue = await sqs.createQueue({ QueueName: 'my-queue' }).promise();
    const subscription = await sns.subscribe({
        TopicArn: myTopicArn,
        Protocol: 'sqs',
        Endpoint: queue.QueueUrl,
    }).promise();

    Contributors

    Happy to accept contributions, feature requests and issues.

    Thanks goes to these wonderful people (emoji key):

    Matthew James
    Matthew James

    💬 💻 🎨 📖 💡
    darbio
    darbio

    🐛 💻
    TiVoMaker
    TiVoMaker

    🐛 💻 🎨 📖
    Jade Hwang
    Jade Hwang

    🐛
    Bennett Rogers
    Bennett Rogers

    🐛 💻
    Julius Breckel
    Julius Breckel

    💻 💡 ⚠️
    RainaWLK
    RainaWLK

    🐛 💻
    Jamie Learmonth
    Jamie Learmonth

    🐛
    Gevorg A. Galstyan
    Gevorg A. Galstyan

    🐛 💻
    Ivan Montiel
    Ivan Montiel

    🐛 💻 ⚠️
    Matt Ledom
    Matt Ledom

    💻 🎨
    Keith Kirk
    Keith Kirk

    💻 🎨
    Kobi Meirson
    Kobi Meirson

    💻
    Steve Green
    Steve Green

    💻
    Daniel
    Daniel

    🐛 💻 🎨
    Zdenek Farana
    Zdenek Farana

    💻
    Daniel Maricic
    Daniel Maricic

    💻
    Brandon Evans
    Brandon Evans

    💻
    AJ Stuyvenberg
    AJ Stuyvenberg

    💬 💻 ⚠️
    justin.kruse
    justin.kruse

    ⚠️ 💻
    Clement134
    Clement134

    🐛 💻

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i serverless-offline-sns-imp

    DownloadsWeekly Downloads

    2

    Version

    0.52.1

    License

    MIT

    Unpacked Size

    87.9 kB

    Total Files

    14

    Last publish

    Collaborators

    • vdtn359