haraka-plugin-karma 2.0.0 → 2.0.3

package/.github/workflows/ci.yml

@@ -11,27 +11,29 @@ jobs:
     uses: haraka/.github/.github/workflows/lint.yml@master
 
   test:
+    needs: lint
     runs-on: ${{ matrix.os }}
     services:
       redis:
         image: redis
         ports:
-          - 6379/tcp
+          - 6379:6379
     strategy:
       matrix:
         os: [ ubuntu-latest ]
         node-version: [ 14, 16, 18 ]
       fail-fast: false
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: actions/setup-node@v3
-      name: Node.js ${{ matrix.node-version }}
+      name: Node ${{ matrix.node-version }} on ${{ matrix.os }}
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install
     - run: npm test
 
   test-win:
+    needs: lint
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -41,7 +43,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - uses: actions/setup-node@v3
-      name: Use Node.js ${{ matrix.node-version }}
+      name: Node ${{ matrix.node-version }} on ${{ matrix.os }}
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install

package/.github/workflows/codeql.yml

@@ -0,0 +1,14 @@
+name: CodeQL
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '18 7 * * 4'
+
+jobs:
+  codeql:
+    uses: haraka/.github/.github/workflows/codeql.yml@master

package/.github/workflows/publish.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - master
+    paths:
+      - package.json
 
 env:
   CI: true
@@ -12,18 +14,3 @@ jobs:
   publish:
     uses: haraka/.github/.github/workflows/publish.yml@master
     secrets: inherit
-
-  publish-gpr:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://npm.pkg.github.com/
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.release/base.sh

@@ -0,0 +1,40 @@
+#!/bin/sh
+
+branch_is_master()
+{
+    if [ "$(git branch --show-current)" = "master" ]; then
+        return 0
+    fi
+
+    return 1
+}
+
+repo_is_clean()
+{
+    if [ -z "$(git status --porcelain)" ]; then
+        return 0
+    fi
+
+    return 1
+}
+
+assure_repo_is_clean()
+{
+    if repo_is_clean; then return 0; fi
+
+    echo
+    echo "ERROR: Uncommitted changes, cowardly refusing to continue..."
+    echo
+    sleep 2
+
+    git status
+
+    return 1
+}
+
+find_changelog()
+{
+    CHANGELOG=$(ls [Cc][Hh][Aa]*.md)
+    export CHANGELOG
+    #echo "I found your CHANGELOG at: $CHANGELOG"
+}

package/.release/do.sh

@@ -0,0 +1,51 @@
+#!/bin/sh
+
+usage() {
+    echo "do.sh {major | minor | patch}"
+    exit
+}
+
+. .release/base.sh || exit
+
+case "$1" in
+    "major" )
+    ;;
+    "minor" )
+    ;;
+    "patch" )
+    ;;
+    *)
+    usage
+    ;;
+esac
+
+NEW_VERSION=$(npm --no-git-tag-version version "$1")
+
+YMD=$(date "+%Y-%m-%d")
+# echo "Preparing $NEW_VERSION - $YMD"
+
+if branch_is_master; then
+    git checkout -b "release-${NEW_VERSION}"
+fi
+
+update_changes() {
+    tee .release/new.txt <<EO_CHANGE
+
+
+#### ${NEW_VERSION//v} - $YMD
+
+-
+-
+EO_CHANGE
+
+    sed -i '' -e "/#### N.N.N.*$/r .release/new.txt" "$CHANGELOG"
+    rm .release/new.txt
+
+    if command -v open; then open "$CHANGELOG"; fi
+
+    echo
+    echo "AFTER editing $CHANGELOG, run: .release/push.sh"
+}
+
+find_changelog
+update_changes

package/.release/push.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+. .release/base.sh || exit
+
+if branch_is_master; then
+    echo "ERROR: run the release scripts in a feature branch! (not master)"
+    exit
+fi
+
+VERSION=$(node -e 'console.log(require("./package.json").version)')
+
+find_changelog
+
+git add package.json
+git add "$CHANGELOG"
+
+git commit -m "Release v$VERSION"
+
+git push --set-upstream origin "$(git branch --show-current)"
+
+if command -v gh; then
+    gh pr create
+fi

package/Changes.md

@@ -1,80 +1,94 @@
 
+#### N.N.N - YYYY-MM-DD
 
-## 2.0.0 - 2022-03-29
+
+#### 2.0.3 - 2022-05-28
+
+- fix: depend directly on redis
+- fix: update redis command names for v4 compatibility
+- fix: update redis commands to be async
+
+
+#### 2.0.1 - 2022-05-27
+
+- chore(ci): depend on shared GHA workflows
+
+
+#### 2.0.0 - 2022-03-29
 
 - remove lots of plugin=this
 - remove unnecessary braces and trailing ;
 - some promises.
 
 
-## 1.0.14 - 2022-02-14
+#### 1.0.14 - 2022-02-14
 
 - try to unsubscribe in case connection is marked to skip during transaction
 
 
-## 1.0.13 - 2019-04-23
+#### 1.0.13 - 2019-04-23
 
 - add 'exists' pattern
 
 
-## 1.0.12 - 2019-03-08
+#### 1.0.12 - 2019-03-08
 
-- don't interfere with STARTLS and AUTH when karmi is listed above those plugins in config/plugins
+- don't interfere with STARTLS and AUTH when karma is listed above those plugins in config/plugins
 
 
-## 1.0.11 - 2017-10-25
+#### 1.0.11 - 2017-10-25
 
 - private addresses and flagged connections exemption
 
 
-## 1.0.10 - 2017-08-30
+#### 1.0.10 - 2017-08-30
 
 - add TLS awards #19
 
 
-## 1.0.9 - 2017-07-29
+#### 1.0.9 - 2017-07-29
 
 - splash on some es6
 - add AppVeyor CI testing
 
 
-## 1.0.8 - 2017-06-26
+#### 1.0.8 - 2017-06-26
 
 - revert #9, it breaks current Haraka deployments
 
 
-## 1.0.7 - 2017-06-16
+#### 1.0.7 - 2017-06-16
 
 - update for eslint 4 compat
 - Add results_redis_publish=true for haraka-results changes #9
 
 
-## 1.0.6 - 2017-05-04
+#### 1.0.6 - 2017-05-04
 
 - emit error if redis plugin didn't create connection
 
 
-## 1.0.5 - 2017-02-06
+#### 1.0.5 - 2017-02-06
 
 - move merge_redis_ini into load_karma_ini, so it also gets applied
   after a karma.ini change
 - skip redis operations when no connection exists
 
 
-## 1.0.4 - 2017-01-29
+#### 1.0.4 - 2017-01-29
 
 - use the new haraka-plugin-redis
 - remove exceptions for soft denials. This makes denial time simpler.
 - rules updates
 
 
-## 1.0.3 - 2017-01-27
+#### 1.0.3 - 2017-01-27
 
 - add rule #280 for known-senders
 - add support for 'length' type, with eq, gt, and lt operators
 - use shared haraka-eslint
 
 
-## 1.0.2 - 2017-01-24
+#### 1.0.2 - 2017-01-24
 
 - use redis.merge_redis_ini()

package/index.js

@@ -2,6 +2,7 @@
 // karma - reward good and penalize bad mail senders
 
 const constants = require('haraka-constants')
+const redis     = require('redis')
 const utils     = require('haraka-utils')
 
 const phase_prefixes = utils.to_object([
@@ -104,8 +105,16 @@ exports.results_init = async function (next, connection) {
 
   if (!this.result_awards) return next()  // not configured
 
-  // subscribe to result_store publish messages
-  await this.redis_subscribe(connection, (channel, message) => {
+  if (connection.notes.redis) {
+    connection.logdebug(this, `redis already subscribed`)
+    return // another plugin has already called this.
+  }
+
+  connection.notes.redis = redis.createClient(this.redisCfg.pubsub)
+  await connection.notes.redis.connect()
+
+  const pattern = this.get_redis_sub_channel(connection)
+  connection.notes.redis.pSubscribe(pattern, (message) => {
     this.check_result(connection, message)
   })
 
@@ -543,22 +552,18 @@ exports.ip_history_from_redis = function (next, connection) {
   // redis plugin is emitting errors, no need to here
   if (!plugin.db) return next()
 
-  plugin.db.hgetall(dbkey, (err, dbr) => {
-    if (err) {
-      connection.results.add(plugin, { err })
-      return next()
-    }
-
+  plugin.db.hGetAll(dbkey).then(dbr => {
     if (dbr === null) {
       plugin.init_ip(dbkey, connection.remote.ip, expire)
       return next()
     }
 
     plugin.db.multi()
-      .hincrby(dbkey, 'connections', 1)  // increment total conn
+      .hIncrBy(dbkey, 'connections', 1)  // increment total conn
       .expire(dbkey, expire)             // extend expiration
-      .exec((err2, replies) => {
-        if (err2) connection.results.add(plugin, {err: err2})
+      .exec()
+      .catch(err => {
+        connection.results.add(plugin, { err })
       })
 
     const results = {
@@ -580,8 +585,13 @@ exports.ip_history_from_redis = function (next, connection) {
     connection.results.add(plugin, results)
 
     plugin.check_awards(connection)
-    return next()
+    next()
   })
+    .catch(err => {
+      connection.results.add(plugin, { err })
+      next()
+    })
+
 }
 
 exports.hook_mail = function (next, connection, params) {
@@ -665,10 +675,10 @@ exports.increment = function (connection, key, val) {
   const plugin = this
   if (!plugin.db) return
 
-  plugin.db.hincrby(`karma|${connection.remote.ip}`, key, 1)
+  plugin.db.hIncrBy(`karma|${connection.remote.ip}`, key, 1)
 
   const asnkey = plugin.get_asn_key(connection)
-  if (asnkey) plugin.db.hincrby(asnkey, key, 1)
+  if (asnkey) plugin.db.hIncrBy(asnkey, key, 1)
 }
 
 exports.hook_disconnect = function (next, connection) {
@@ -930,19 +940,14 @@ exports.check_asn = function (connection, asnkey) {
 
   if (this.cfg.asn.report_as) report_as.name = this.cfg.asn.report_as
 
-  this.db.hgetall(asnkey, (err, res) => {
-    if (err) {
-      connection.results.add(this, { err })
-      return
-    }
-
+  this.db.hGetAll(asnkey).then(res => {
     if (res === null) {
       const expire = (this.cfg.redis.expire_days || 60) * 86400 // days
       this.init_asn(asnkey, expire)
       return
     }
 
-    this.db.hincrby(asnkey, 'connections', 1)
+    this.db.hIncrBy(asnkey, 'connections', 1)
     const asn_score = parseInt(res.good || 0) - (res.bad || 0)
     const asn_results = {
       asn_score,
@@ -970,12 +975,15 @@ exports.check_asn = function (connection, asnkey) {
 
     connection.results.add(report_as, asn_results)
   })
+    .catch(err => {
+      connection.results.add(this, { err })
+    })
 }
 
-exports.init_ip = function (dbkey, rip, expire) {
+exports.init_ip = async function (dbkey, rip, expire) {
   if (!this.db) return
-  this.db.multi()
-    .hmset(dbkey, {'bad': 0, 'good': 0, 'connections': 1})
+  await this.db.multi()
+    .hmSet(dbkey, {'bad': 0, 'good': 0, 'connections': 1})
     .expire(dbkey, expire)
     .exec()
 }
@@ -992,7 +1000,7 @@ exports.init_asn = function (asnkey, expire) {
   const plugin = this
   if (!plugin.db) return
   plugin.db.multi()
-    .hmset(asnkey, {'bad': 0, 'good': 0, 'connections': 1})
+    .hmSet(asnkey, {'bad': 0, 'good': 0, 'connections': 1})
     .expire(asnkey, expire * 2)    // keep ASN longer
     .exec()
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "haraka-plugin-karma",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "description": "A heuristics scoring and reputation engine for SMTP connections",
   "main": "index.js",
   "scripts": {
@@ -26,7 +26,8 @@
     "address-rfc2821": "*",
     "haraka-constants": ">=1.0.2",
     "haraka-utils": "*",
-    "haraka-plugin-redis": "2"
+    "haraka-plugin-redis": "2",
+    "redis": "4"
   },
   "devDependencies": {
     "eslint": "8",

package/test/karma.js

@@ -762,7 +762,7 @@ describe('tls', function () {
   })
 })
 
-describe('skiping_hooks', function () {
+describe('skipping hooks', function () {
   beforeEach(_set_up)
 
   it('notes.disable_karma', function (done) {