ptzagk / node-events

📃 A template for creating Open Microservices with Node and event subscriptions

Microservice template for NodeJS with subscription endpoints

An OMS template for NodeJS with subscription endpoints.

Usage

Listen to all users

# Storyscript
your_service listen as srv
  when srv heartbeat as event
    log info event
# {"user": "max", "time": "..."}
# {"user": "moritz", "time": "..."}

Listen to a single user

# Storyscript
when your_service listen heartbeat user: 'Max' as event
  log info event
# {"user": "max", "time": "..."}
# {"user": "max", "time": "..."}

Publish events

# Storyscript
your_service publish eventName:'heartbeat' data:{'time': '...'}

Test

Subscribe to all user events

> oms subscribe listen heartbeat
ℹ Building Docker image
…
✔ Built Docker image with name: oms/microservices/node-events
✔ Started Docker container: 7be7d3cc4da6
✔ Health check passed
✔ Ran action: `listen` with output:
✔ Subscribed to event: `heartbeat` data will be posted to this terminal window when appropriate
{
  "eventType": "heartbeat",
  "type": "com.microservices.node.template",
  "specversion": "0.2",
  "source": "/foo",
  "id": "NODE-TEMPLATE-0",
  "time": "2019-04-06T18:59:24.938Z",
  "datacontenttype": "application/json",
  "data": {
    "user": "max",
    "time": "Sat Apr 06 2019 18:59:24 GMT+0000 (Coordinated Universal Time)"
  }
}
{
  "eventType": "heartbeat",
  "type": "com.microservices.node.template",
  "specversion": "0.2",
  "source": "/foo",
  "id": "NODE-TEMPLATE-1",
  "time": "2019-04-06T18:59:26.938Z",
  "datacontenttype": "application/json",
  "data": {
    "user": "moritz",
    "time": "Sat Apr 06 2019 18:59:26 GMT+0000 (Coordinated Universal Time)"
  }
}
…
✔ Stopped Docker container: 7be7d3cc4da6

Subscribe to all individual user events

> oms subscribe listen heartbeat -a user='max'
ℹ Building Docker image
…
✔ Built Docker image with name: oms/microservices/node-events
✔ Started Docker container: 5d2592cbd82b
✔ Health check passed
✔ Ran action: `listen` with output:
✔ Subscribed to event: `heartbeat` data will be posted to this terminal window when appropriate
{
  "eventType": "heartbeat",
  "type": "com.microservices.node.template",
  "specversion": "0.2",
  "source": "/foo",
  "id": "NODE-TEMPLATE-0",
  "time": "2019-04-06T19:04:00.845Z",
  "datacontenttype": "application/json",
  "data": {
    "user": "max",
    "time": "Sat Apr 06 2019 19:04:00 GMT+0000 (Coordinated Universal Time)"
  }
}
{
  "eventType": "heartbeat",
  "type": "com.microservices.node.template",
  "specversion": "0.2",
  "source": "/foo",
  "id": "NODE-TEMPLATE-1",
  "time": "2019-04-06T19:04:03.844Z",
  "datacontenttype": "application/json",
  "data": {
    "user": "max",
    "time": "Sat Apr 06 2019 19:04:03 GMT+0000 (Coordinated Universal Time)"
  }
}
…
✔ Stopped Docker container: 5d2592cbd82b