email-notifier 14.0.2

package/.circleci/config.yml

@@ -0,0 +1,11 @@
+version: 2.1
+setup: true
+orbs:
+  build: mojaloop/build@1.0.22
+workflows:
+  setup:
+    jobs:
+      - build/workflow:
+          filters:
+            tags:
+              only: /v\d+(\.\d+){2}(-[a-zA-Z-][0-9a-zA-Z-]*\.\d+)?/

package/.dockerignore

@@ -0,0 +1,17 @@
+deploy/
+coverage/
+node_modules/
+.dockerignore
+.editorconfig
+.git/
+.gitignore
+.istanbul.yml
+circle.yml
+docker-compose.circle.yml
+docker-compose.dev.yml
+docker-compose.functional.yml
+docker-compose.yml
+Dockerfile
+LICENSE
+README.md
+sonar-project.properties

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

package/.github/ISSUE_TEMPLATE/no-issue-template.md

@@ -0,0 +1,18 @@
+---
+name: No Issue Template
+about: " A template which asks users to post issues in the mojaloop/project repo "
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!--
+This issue tracker is not monitored, and issues created here will be deleted. Please use the issue tracker in https://github.com/mojaloop/project
+
+For other questions and help:
+- Mojaloop Documentation - https://mojaloop.io/documentation
+- Mojaloop on Github - https://github.com/mojaloop
+- Mojaloop community Slack - https://mojaloop.slack.com (register here: https://mojaloop-slack.herokuapp.com/)
+
+-->

package/.ncurc.yaml

@@ -0,0 +1,2 @@
+## Add a TODO comment indicating the reason for each rejected dependency upgrade added to this list, and what should be done to resolve it (i.e. handle it through a story, etc).
+reject: []

package/.nvmrc

@@ -0,0 +1 @@
+18.20.4

package/.nycrc.yml

@@ -0,0 +1,19 @@
+temp-directory: "./.nyc_output"
+check-coverage: true
+per-file: true
+lines: 90
+statements: 90
+functions: 90
+# branches: 90 ## TODO: This should be un-commented to 90 once code-coverage is improved!
+all: true
+include: [
+  "src/**/*.js"
+]
+reporter: [
+  "lcov"
+]
+exclude: [
+  "src/setup.js", # Ignoring this until there is a reason to test this file. Currently just exports the library functions.
+  "src/lib/kafka/index.js", # Ignoring this until there is a reason to test this file. Currently just exports the library functions.
+  "**/node_modules/**"
+]

package/.versionrc

@@ -0,0 +1,15 @@
+{
+  "types": [
+    {"type": "feat", "section": "Features"},
+    {"type": "fix", "section": "Bug Fixes"},
+    {"type": "docs", "section": "Documentation"},
+    {"type": "style", "section": "Styling"},
+    {"type": "refactor", "section": "Refactors"},
+    {"type": "perf", "section": "Performance"},
+    {"type": "test", "section": "Tests"},
+    {"type": "build", "section": "Build System"},
+    {"type": "ci", "section": "CI"},
+    {"type": "chore", "section": "Chore"},
+    {"type": "revert", "section": "Reverts"}
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [14.0.2](https://github.com/mojaloop/email-notifier/compare/v14.0.1...v14.0.2) (2025-01-16)
+
+### [14.0.1](https://github.com/mojaloop/email-notifier/compare/v14.0.0...v14.0.1) (2025-01-15)
+
+
+### Chore
+
+* dependency updates pi26 ([#215](https://github.com/mojaloop/email-notifier/issues/215)) ([7f864f6](https://github.com/mojaloop/email-notifier/commit/7f864f69ffcf751be92c8a28363437277cd8cdf3))
+
+## [14.0.0](https://github.com/mojaloop/email-notifier/compare/v13.0.1...v14.0.0) (2023-11-06)
+
+
+### Bug Fixes
+
+* **mojaloop/#3615:** update dependencies ([#212](https://github.com/mojaloop/email-notifier/issues/212)) ([ba5373e](https://github.com/mojaloop/email-notifier/commit/ba5373eb9e5e6bd413fc562c1a6e721f45752aee)), closes [mojaloop/#3615](https://github.com/mojaloop/project/issues/3615)
+
+### [13.0.1](https://github.com/mojaloop/email-notifier/compare/v13.0.0...v13.0.1) (2023-10-31)
+
+
+### CI
+
+* **mojaloop/#3533:** fix release pipeline ([#211](https://github.com/mojaloop/email-notifier/issues/211)) ([c3d33e1](https://github.com/mojaloop/email-notifier/commit/c3d33e1c3f1e31e5a4005e286338c3172a16a4ab))
+
+## [13.0.0](https://github.com/mojaloop/email-notifier/compare/v11.0.2...v13.0.0) (2023-10-12)
+
+
+### ⚠ BREAKING CHANGES
+
+* upgrade ci, image, packages, audit (#202)
+
+### Features
+
+* upgrade ci, image, packages, audit ([#202](https://github.com/mojaloop/email-notifier/issues/202)) ([9ff5ddb](https://github.com/mojaloop/email-notifier/commit/9ff5ddb5190905680a2759a45b0c6246c136b089))
+
+
+### Bug Fixes
+
+* [Security] Bump hosted-git-info from 2.8.8 to 2.8.9 ([#182](https://github.com/mojaloop/email-notifier/issues/182)) ([209bc84](https://github.com/mojaloop/email-notifier/commit/209bc8420fa1e258e06de9176afda8975a21e18a))
+
+
+### Chore
+
+* **#864-2:** change instanbul to nyc for coverage on all projects ([#192](https://github.com/mojaloop/email-notifier/issues/192)) ([c43e3c0](https://github.com/mojaloop/email-notifier/commit/c43e3c0daf44ee0316b7e966556971126b13105b)), closes [#864-2](https://github.com/mojaloop/email-notifier/issues/864-2) [#864-2](https://github.com/mojaloop/email-notifier/issues/864-2)
+* **#864:** change instanbul to nyc for coverage on all projects ([#191](https://github.com/mojaloop/email-notifier/issues/191)) ([46d315f](https://github.com/mojaloop/email-notifier/commit/46d315f94df29ef324e4878c09218142cd6af7c6)), closes [#864](https://github.com/mojaloop/email-notifier/issues/864) [#864](https://github.com/mojaloop/email-notifier/issues/864)
+* install replace ([#203](https://github.com/mojaloop/email-notifier/issues/203)) ([a8b2481](https://github.com/mojaloop/email-notifier/commit/a8b2481c70d90f797adf70ef820538cbc4d083a2))
+* **mojaloop/#3446:** nodejs upgrade ([#209](https://github.com/mojaloop/email-notifier/issues/209)) ([e81a174](https://github.com/mojaloop/email-notifier/commit/e81a1742e421b7efb16e2763bb24ec3800c39b75)), closes [mojaloop/#3446](https://github.com/mojaloop/project/issues/3446)
+* **release:** 12.0.0 [skip ci] ([#204](https://github.com/mojaloop/email-notifier/issues/204)) ([71aeec7](https://github.com/mojaloop/email-notifier/commit/71aeec72e0b6c2b39e222751fe5ab54e0abde5df))
+* update libraries ([#210](https://github.com/mojaloop/email-notifier/issues/210)) ([0b19bb1](https://github.com/mojaloop/email-notifier/commit/0b19bb10eb91640018bd8213517abc61344d9964))
+
+## [12.0.0](https://github.com/mojaloop/email-notifier/compare/v11.0.2...v12.0.0) (2022-07-20)
+
+
+### ⚠ BREAKING CHANGES
+
+* upgrade ci, image, packages, audit (#202)
+
+### Features
+
+* upgrade ci, image, packages, audit ([#202](https://github.com/mojaloop/email-notifier/issues/202)) ([9ff5ddb](https://github.com/mojaloop/email-notifier/commit/9ff5ddb5190905680a2759a45b0c6246c136b089))
+
+
+### Bug Fixes
+
+* [Security] Bump hosted-git-info from 2.8.8 to 2.8.9 ([#182](https://github.com/mojaloop/email-notifier/issues/182)) ([209bc84](https://github.com/mojaloop/email-notifier/commit/209bc8420fa1e258e06de9176afda8975a21e18a))

package/CODEOWNERS

@@ -0,0 +1,5 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# The below users will be requested for
+# review when someone opens a pull request.
+*       @mdebarros @elnyry-sam-k @vijayg10

package/Dockerfile

@@ -0,0 +1,44 @@
+# Arguments
+ARG NODE_VERSION=lts-alpine
+
+# NOTE: Ensure you set NODE_VERSION Build Argument as follows...
+#
+#  export NODE_VERSION="$(cat .nvmrc)-alpine" \
+#  docker build \
+#    --build-arg NODE_VERSION=$NODE_VERSION \
+#    -t mojaloop/sdk-scheme-adapter:local \
+#    . \
+#
+
+# Build Image
+FROM node:${NODE_VERSION} as builder
+WORKDIR /opt/app
+
+RUN apk --no-cache add git
+RUN apk add --no-cache -t build-dependencies make gcc g++ python3 libtool openssl-dev autoconf automake bash \
+    && cd $(npm root -g)/npm 
+
+COPY package.json package-lock.json* /opt/app/
+RUN npm ci
+
+COPY src /opt/app/src
+COPY config /opt/app/config
+COPY app.js /opt/app/
+COPY templates /opt/app/templates
+
+FROM node:${NODE_VERSION}
+WORKDIR /opt/app
+
+# Create empty log file & link stdout to the application log file
+RUN mkdir ./logs && touch ./logs/combined.log
+RUN ln -sf /dev/stdout ./logs/combined.log
+
+# Create a non-root user: ml-user
+RUN adduser -D ml-user
+USER ml-user
+
+COPY --chown=ml-user --from=builder /opt/app .
+RUN npm prune --production
+
+EXPOSE 3081
+CMD node app.js

package/LICENSE.md

@@ -0,0 +1,10 @@
+# LICENSE
+
+Copyright © 2020 Mojaloop Foundation
+
+The Mojaloop files are made available by the Mojaloop Foundation under the Apache License, Version 2.0
+(the "License") and you may not use these files except in compliance with the [License](http://www.apache.org/licenses/LICENSE-2.0). 
+
+You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the [License](http://www.apache.org/licenses/LICENSE-2.0).

package/README.md

@@ -0,0 +1,135 @@
+# email-notifier
+[![Git Commit](https://img.shields.io/github/last-commit/mojaloop/email-notifier.svg?style=flat)](https://github.com/mojaloop/email-notifier/commits/main)
+[![Git Releases](https://img.shields.io/github/release/mojaloop/email-notifier.svg?style=flat)](https://github.com/mojaloop/email-notifier/releases)
+[![Docker pulls](https://img.shields.io/docker/pulls/mojaloop/email-notifier.svg?style=flat)](https://hub.docker.com/r/mojaloop/email-notifier)
+[![CircleCI](https://circleci.com/gh/mojaloop/email-notifier.svg?style=svg)](https://app.circleci.com/pipelines/github/mojaloop/email-notifier)
+
+Email Notifier is a stand-alone email service that consumes messages from kafka topic, produced by the central-event-processor service.
+The central-event-processor repo is available [here](https://github.com/mojaloop/central-event-processor/tree/main)
+The email-notifier flow is available [here](https://github.com/mojaloop/central-event-processor/tree/main#Notifierflowseparateservice)
+
+## Contents
+
+- [email-notifier](#email-notifier)
+  - [Contents](#contents)
+  - [Todo](#todo)
+  - [Config](#config)
+  - [Troubleshooting `npm install` on MacOS](#troubleshooting-npm-install-on-macos)
+  - [Auditing Dependencies](#auditing-dependencies)
+  - [Container Scans](#container-scans)
+
+## Todo
+
+- Improve code-coverage to 90% across the board: [.nycrc.yml](./.nycrc.yml). Don't forget to un-comment out the branches code-coverage rule.
+
+## Config
+
+Refer to [`./config/default.json`](config/default.json) for a detailed look at the configuration options.
+
+For configuring email:
+
+```json
+  "emailSettings": {
+    "smtpConfig": {
+      "host": "smtp.gmail.com",
+      "port": 587,
+      "secureConnection": false,
+      "tls": {
+        "ciphers":"SSLv3"
+     },
+      "auth": {
+        "user": "modusboxnotifier@gmail.com",
+        "pass": "m0dusb0xn0t1f13r"
+      }
+    }
+  }
+```
+
+Those can be passed as the following environment variables:
+
+```json
+{
+  "emailSettings": {
+    "smtpConfig": {
+      "host": "MAIL_NOTIF_SMTP_HOST",
+      "port": "MAIL_NOTIF_SMTP_PORT",
+      "secureConnection": "MAIL_NOTIF_SMTP_SECURE_FLAG",
+      "tls": {
+        "ciphers":"MAIL_NOTIF_SMTP_TLS_CIPHERS"
+     },
+      "auth": {
+        "user": "MAIL_NOTIF_SMTP_USER",
+        "pass": "MAIL_NOTIF_SMTP_PASS"
+      }
+    }
+  }
+}
+```
+
+## Troubleshooting `npm install` on MacOS
+
+If you have this or similar error during installation:
+
+```bash
+npm install
+> node-gyp rebuild
+clang: error: linker command failed with exit code 1
+```
+
+add the following environment variables:
+```bash
+export CPPFLAGS=-I/usr/local/opt/openssl/include
+export LDFLAGS=-L/usr/local/opt/openssl/lib
+```
+
+## Auditing Dependencies
+
+We use `audit-ci` along with `npm audit` to check dependencies for node vulnerabilities, and keep track of resolved dependencies with an `audit-ci.json` file.
+
+To start a new resolution process, run:
+
+```bash
+npm run audit:fix
+```
+
+You can then check to see if the CI will pass based on the current dependencies with:
+
+```bash
+npm run audit:check
+```
+
+The [audit-ci.jsonc](./audit-ci.jsonc) contains any audit-exceptions that cannot be fixed to ensure that CircleCI will build correctly.
+
+## Container Scans
+
+As part of our CI/CD process, we use anchore-cli to scan our built docker container for vulnerabilities upon release.
+
+If you find your release builds are failing, refer to the [container scanning](https://github.com/mojaloop/ci-config#container-scanning) in our shared Mojaloop CI config repo. There is a good chance you simply need to update the `mojaloop-policy-generator.js` file and re-run the circleci workflow.
+
+For more information on anchore and anchore-cli, refer to:
+
+- [Anchore CLI](https://github.com/anchore/anchore-cli)
+- [Circle Orb Registry](https://circleci.com/orbs/registry/orb/anchore/anchore-engine)
+
+## Automated Releases
+
+As part of our CI/CD process, we use a combination of CircleCI, standard-version
+npm package and github-release CircleCI orb to automatically trigger our releases
+and image builds. This process essentially mimics a manual tag and release.
+On a merge to main, CircleCI is configured to use the mojaloopci github account
+to push the latest generated CHANGELOG and package version number.
+Once those changes are pushed, CircleCI will pull the updated main, tag and
+push a release triggering another subsequent build that also publishes a docker image.
+### Potential problems
+*   There is a case where the merge to main workflow will resolve successfully, triggering
+    a release. Then that tagged release workflow subsequently failing due to the image scan,
+    audit check, vulnerability check or other "live" checks.
+    This will leave main without an associated published build. Fixes that require
+    a new merge will essentially cause a skip in version number or require a clean up
+    of the main branch to the commit before the CHANGELOG and bump.
+    This may be resolved by relying solely on the previous checks of the
+    merge to main workflow to assume that our tagged release is of sound quality.
+    We are still mulling over this solution since catching bugs/vulnerabilities/etc earlier
+    is a boon.
+*   It is unknown if a race condition might occur with multiple merges with main in
+    quick succession, but this is a suspected edge case.

package/app.js

@@ -0,0 +1,34 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+ * Valentin Genev <valentin.genev@modusbox.com>
+ * Deon Botha <deon.botha@modusbox.com>
+ --------------
+ ******/
+
+'use strict'
+
+const setup = require('./src/setup').setup
+const Logger = require('@mojaloop/central-services-logger')
+
+try {
+  setup()
+} catch (err) {
+  Logger.info(`Notifier throws an error ${err}`)
+}

package/audit-ci.jsonc

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://github.com/IBM/audit-ci/raw/main/docs/schema.json",
+  // audit-ci supports reading JSON, JSONC, and JSON5 config files.
+  // Only use one of ["low": true, "moderate": true, "high": true, "critical": true]
+  "moderate": true,
+  "allowlist": [
+    
+  ]
+}

package/config/custom-environment-variables.json

@@ -0,0 +1,17 @@
+{
+  "emailSettings": {
+    "smtpConfig": {
+      "host": "MAIL_NOTIF_SMTP_HOST",
+      "port": "MAIL_NOTIF_SMTP_PORT",
+      "secureConnection": "MAIL_NOTIF_SMTP_SECURE_FLAG",
+      "tls": {
+        "ciphers":"MAIL_NOTIF_SMTP_TLS_CIPHERS"
+     },
+      "auth": {
+        "user": "MAIL_NOTIF_SMTP_USER",
+        "pass": "MAIL_NOTIF_SMTP_PASS"
+      }
+    }
+  },
+  "PORT": "MAIL_NOTIF_PORT"
+}

package/config/default.json

@@ -0,0 +1,96 @@
+{
+  "emailSettings": {
+    "smtpConfig": {
+      "host": "test.smpt.server",
+      "port": 587,
+      "secureConnection": true,
+      "tls": {
+        "ciphers": "SSLv3"
+     },
+      "auth": {
+        "user": "user",
+        "pass": "password"
+      }
+    }
+  },
+  "PORT": 3081,
+  "KAFKA": {
+    "TOPIC_TEMPLATES": {
+      "NOTIFICATION_TOPIC_TEMPLATE": {
+        "TEMPLATE": "topic-notification-event",
+        "REGEX": "topic-notification-event"
+      },
+      "GENERAL_TOPIC_TEMPLATE": {
+        "TEMPLATE": "topic-{{functionality}}-{{action}}",
+        "REGEX": "topic-(.*)-(.*)"
+      }
+    },
+    "CONSUMER": {
+      "NOTIFICATION": {
+        "EVENT": {
+          "config": {
+            "options": {
+              "mode": 2,
+              "batchSize": 1,
+              "recursiveTimeout": 100,
+              "messageCharset": "utf8",
+              "messageAsJSON": true,
+              "sync": true,
+              "consumeTimeout": 1000
+            },
+            "rdkafkaConf": {
+              "client.id": "enotifier-con",
+              "group.id": "enotifier-group",
+              "metadata.broker.list": "localhost:9092",
+              "socket.blocking.max.ms": 1,
+              "fetch.wait.max.ms": 1,
+              "fetch.error.backoff.ms": 1,
+              "queue.buffering.max.ms": 1,
+              "broker.version.fallback": "0.10.1.0",
+              "api.version.request": true,
+              "enable.auto.commit": false,
+              "auto.commit.interval.ms": 200,
+              "socket.keepalive.enable": true,
+              "socket.max.fails": 1,
+              "allow.auto.create.topics": true
+            },
+            "topicConf": {
+              "auto.offset.reset": "earliest"
+            }
+          }
+        }
+      }
+    },
+    "PRODUCER": {
+      "NOTIFICATION": {
+        "EVENT": {
+          "config": {
+            "options": {
+              "messageCharset": "utf8"
+            },
+            "rdkafkaConf": {
+              "debug": "all",
+              "metadata.broker.list": "localhost:9092",
+              "client.id": "enotifier-prod",
+              "event_cb": true,
+              "compression.codec": "none",
+              "retry.backoff.ms": 100,
+              "message.send.max.retries": 2,
+              "socket.keepalive.enable": true,
+              "queue.buffering.max.messages": 10000000,
+              "batch.num.messages": 100,
+              "dr_cb": true,
+              "socket.blocking.max.ms": 1,
+              "queue.buffering.max.ms": 1,
+              "broker.version.fallback": "0.10.1.0",
+              "api.version.request": true
+            }
+          }
+        }
+      }
+    }
+  },
+  "HUB_PARTICIPANT": {
+    "NAME": "Hub"
+  }
+}

package/istanbul.yml

@@ -0,0 +1,14 @@
+instrumentation:
+  include-all-sources: true
+  excludes: []
+check:
+  global:
+    statements: 90
+    lines: 90
+    branches: 90
+    functions: 90
+  each:
+    statements: 90
+    lines: 90
+    branches: 90
+    functions: 90