@pager/minion-army 2.2.0 → 2.2.1

package/.eslintrc.js

@@ -1,7 +1,7 @@
 module.exports = {
   extends: '@hapi/eslint-config-hapi',
   parserOptions: {
-    ecmaVersion: 12
+    ecmaVersion: 9
   },
   rules: {
     'no-console': 2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.2.1](https://github.com/pagerinc/minion-army/compare/v2.2.0...v2.2.1) (2024-03-20)
+
+
+### Bug Fixes
+
+* **ODIN-13:** patch version bump ([#459](https://github.com/pagerinc/minion-army/issues/459)) ([70a1bc2](https://github.com/pagerinc/minion-army/commit/70a1bc26df8bd77a4d7c675cfcb9a7bf0b171f91))
+
+# [2.2.0](https://github.com/pagerinc/minion-army/compare/v2.1.0...v2.2.0) (2024-03-20)
+
+
+### Features
+
+* **ODIN-13:** set NR transaction name based on worker name ([#458](https://github.com/pagerinc/minion-army/issues/458)) ([b0bb358](https://github.com/pagerinc/minion-army/commit/b0bb3583bcd9adfeb82653ce62e95a506d922a04))
+
 # [2.1.0](https://github.com/pagerinc/minion-army/compare/v2.0.0...v2.1.0) (2023-05-08)
 
 

package/cloudbuild.yaml

@@ -33,7 +33,8 @@ tags:
   - 'npm'
   - 'nodejs'
 
-secrets:
-  - kmsKeyName: projects/production-197117/locations/global/keyRings/gcb/cryptoKeys/main
-    secretEnv:
-      NPM_TOKEN: 'CiUA/4lqmXwRPPaGHe+X7TS7mwqARNCw5QFq7yfq7ESHaJrf+tzeElEADvOwrLQvnxCLG2wy+H2vD+DWHMosEgIfzpKNBJAVHX1u4FSwIF5utaN6tMIrLuZB18HnK2SKpsXTPvB/+0Eoz1acnj6WO+slz+GUGUnxefU='
+availableSecrets:
+  secretManager:
+    - versionName: projects/145393225073/secrets/npm-token-publish/versions/latest
+      env: NPM_TOKEN
+

package/lib/index.js

@@ -4,10 +4,10 @@ const Minion = require('@pager/minion');
 const { EventEmitter } = require('events');
 const Jackrabbit = require('@pager/jackrabbit');
 const Joi = require('joi');
+const NewRelic = require('newrelic');
 const Schema = require('./schema');
-const { createLoggerContext } = require('./loggingUtils');
 
-const validatorFactory = (handler, schema) => (payload, ...rest) => { // eslint-disable-line
+const validatorFactory = (handler, schema) => (payload, metadata) => { // eslint-disable-line
 
     const { error, value } = schema.validate(payload, { stripUnknown: true });
 
@@ -15,7 +15,7 @@ const validatorFactory = (handler, schema) => (payload, ...rest) => { // eslint-
         throw error;
     }
 
-    return handler(value, ...rest);
+    return handler(value, metadata);
 };
 
 const createExchange = (connection, workerConfig, exchangeMap) => {
@@ -84,15 +84,9 @@ module.exports = (_manifest) => {
             ...manifest.defaults,
             ...worker.config
         };
-
-        let handlerWithLoggerContext = handlerWithValidation;
-        if (manifest.logger) {
-            handlerWithLoggerContext = createLoggerContext(manifest.logger, worker.config.name, handlerWithValidation);
-        }
-
         const exchange = createExchange(manifest.connection, workerConfig, exchangeMap);
 
-        const minion = Minion(handlerWithLoggerContext, { ...workerConfig, exchange });
+        const minion = Minion(handlerWithValidation, { ...workerConfig, exchange });
 
         minion.on('ready', checkReady);
         minion.on('message', (m, meta) => eventEmitter.emit('message', worker.config.name, m, meta));
@@ -113,6 +107,8 @@ module.exports = (_manifest) => {
 
     const start = () => Object.values(minions).forEach((minion) => minion.start());
 
+    eventEmitter.on('message', (name, _message, _meta) => NewRelic.setTransactionName(name));
+
     return Object.assign(eventEmitter, {
         exchangeMap,
         minions,

package/lib/schema.js

@@ -36,8 +36,5 @@ module.exports = Joi.object({
         rabbitUrl: Joi.string()
     }),
     defaults: config,
-    workers: Joi.array().items(worker),
-    logger: Joi.object({
-        child: Joi.func().required()
-    }).unknown(true)
+    workers: Joi.array().items(worker)
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pager/minion-army",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Microservice Framework for RabbitMQ Workers",
   "main": "lib/index.js",
   "scripts": {
@@ -25,11 +25,9 @@
   "homepage": "https://github.com/pagerinc/minion#readme",
   "dependencies": {
     "@pager/jackrabbit": "5.x",
-    "@pager/minion": "3.x",
-    "lodash": "^4.17.21"
+    "@pager/minion": "3.x"
   },
   "devDependencies": {
-    "@faker-js/faker": "^8.0.1",
     "@hapi/eslint-config-hapi": "13.x",
     "@hapi/eslint-plugin-hapi": "4.x",
     "@pager/semantic-release-config": "2.x",
@@ -37,11 +35,11 @@
     "eslint": "7.x",
     "joi": "^17.2.1",
     "nyc": "15.x",
-    "semantic-release": "21.x",
-    "sinon": "^15.0.4"
+    "semantic-release": "21.x"
   },
   "peerDependencies": {
-    "joi": "^17.2.0"
+    "joi": "^17.2.0",
+    "newrelic": "11.x"
   },
   "renovate": {
     "extends": [

package/test/index.js

@@ -4,41 +4,8 @@ const { EventEmitter } = require('events');
 const Test = require('ava');
 const Joi = require('joi');
 
-const Sinon = require('sinon');
-const { faker } = require('@faker-js/faker');
-
 const Army = require('../lib/index');
 
-const sandbox = Sinon.createSandbox();
-
-
-Test.beforeEach((t) => {
-
-    t.context.logger = {
-        child: sandbox.stub(),
-        info: sandbox.stub()
-    };
-    t.context.rabbit = {
-        topic: () => ({
-            publish: sandbox.spy()
-        }),
-        direct: () => ({
-            publish: sandbox.spy()
-        })
-    };
-    t.context.metadata = {
-        properties: {
-            headers: {
-                eventId: faker.string.uuid()
-            }
-        },
-        fields: {
-            routingKey: faker.string.uuid()
-        }
-    };
-
-});
-
 Test('Creates army from manifest and workers work', async (t) => {
 
     const manifest = {
@@ -432,49 +399,3 @@ Test('Army uses worker exchange overrides', (t) => {
     const army = Army(manifest);
     t.deepEqual(Object.keys(army.exchangeMap), ['direct.events.something.happened', 'topic.my-other-exchange']);
 });
-
-
-Test('Army starts with logger context', async (t) => {
-
-    const { context: { rabbit, logger, metadata } } = t;
-
-    const minionWorkerName = faker.word.sample();
-
-    const handler = sandbox.spy();
-
-    const manifest = {
-        connection: {
-            rabbit
-        },
-        defaults: {
-            exchangeName: faker.word.sample()
-        },
-        workers: [
-            {
-                handler,
-                config: {
-                    name: minionWorkerName,
-                    key: faker.word.sample()
-                }
-            }
-        ],
-        logger
-    };
-
-    const army = Army(manifest);
-    t.truthy(army);
-
-    const event = {
-        data: faker.word.sample()
-    };
-
-    const childLogger = sandbox.spy();
-
-    t.context.logger.child.returns(childLogger);
-
-    await army.minions[minionWorkerName].handle(event, metadata);
-
-    Sinon.assert.calledOnceWithExactly(logger.child, { eventId: metadata.properties.headers.eventId, routingKey: metadata.fields.routingKey, minionWorkerName });
-
-    Sinon.assert.calledOnceWithExactly(handler, event, metadata, { logger: childLogger });
-});

package/lib/loggingUtils.js

@@ -1,112 +0,0 @@
-'use strict';
-
-const { v4: Uuid } = require('uuid');
-
-const Lodash = require('lodash');
-
-/**
- * This is a wrapper around the handler that creates a pino style logger and
- * adds it to a context object as a third argument of the handler
- *
- * @param {*} logger a Pino style logger
- * @param {*} minionWorkerName the name of the minion army worker
- * @param {*} handler the handler to be wrapped
- * @returns
- */
-exports.createLoggerContext = (logger, minionWorkerName, handler) => {
-
-    return (value, metadata, context = {}) => {
-
-        let eventId;
-        try {
-            eventId = metadata?.properties?.headers?.eventId || Uuid();
-            const routingKey = metadata?.fields?.routingKey;
-
-            context.logger = (context.logger || logger).child({ eventId, routingKey, minionWorkerName });
-        }
-        catch (error) {
-            // eslint-disable-next-line no-console
-            console.log('There was an error while creating a child logger in %s for eventId(%s): %o', minionWorkerName, eventId, error);
-        }
-
-        return handler(value, metadata, context);
-    };
-};
-
-/**
- * This utility crteates a wrapper that adds a field from the event into the logger.
- *
- * Usage:
- *
- * const Logger = require('@pager/logger');
- * const Army = require('@pager/minion-army');
- *
- * const injectEncounterIdFromEvent = injectFieldFromEventAs(Logger, 'encounterId', 'triageId');
- *
- * const handler = (message, metadata, context) {
- *     context.logger.info('handling message');
- * }
- *
- * const army = Army({
- *   workers: [
- *    {
- *      handler: injectEncounterIdFromEvent(handler),
- *      config: {
- *        name: `events.foo.encounter.state.updated`,
- *        key: '#.encounter.state.updated'
- *      },
- *      validate: Schemas.states
- *    },
- * });
- *
- * @param {*} logger a Pino style logger
- * @param {*} loggedFieldName what is the name of the field in the log line
- * @param {*} eventFieldName what is the name of the field in the event payload
- * @returns
- */
-exports.injectFieldFromEventAs = (logger, loggedFieldName, eventFieldName) => (handler) => { // eslint-disable-line @hapi/hapi/scope-start, @hapi/hapi/no-arrowception
-
-    return (value, metadata, context = {}) => {
-
-        context.logger = (context.logger || logger).child({ [loggedFieldName]: value[eventFieldName] });
-
-        return handler(value, metadata, context);
-    };
-};
-
-/**
- * This utility function sets up default event handlers that log
- *
- * Usage:
- *
- * const Logger = require('@pager/logger');
- * const Army = require('@pager/minion-army');
- *
- * const army = Army({ ... });
- * addDefaultLoggingEventHandlers(army, 'UpdatedUserArmy', Logger);
- *
- * @param {*} army: the Army instance
- * @param {*} armyName: a unique identifier for this instance of Army
- * @param {*} parentLogger: a Pino style logger
- */
-exports.addDefaultLoggingEventHandlers = (parentLogger, army, armyName) => {
-
-    const logger = parentLogger.child({ armyName });
-
-    army.on('error', (error) => {
-
-        logger.error({ error }, 'Handler error in %s', armyName);
-    });
-
-    army.on('message', (queue, event, metadata) => {
-
-        const pickedMetadata = Lodash.pick(metadata, ['properties', 'fields']);
-
-        logger.info({ queue, event, metadata: pickedMetadata }, 'Got event in %s', armyName);
-    });
-
-    army.on('ready', (queue) => {
-
-        logger.info({ queue }, 'Ready to consume on %s by %s', queue.name, armyName);
-    });
-};

package/test/loggingUtils.js

@@ -1,178 +0,0 @@
-'use strict';
-
-const Test = require('ava');
-
-const Sinon = require('sinon');
-const { faker } = require('@faker-js/faker');
-
-const Army = require('../lib/index');
-const { createLoggerContext, injectFieldFromEventAs, addDefaultLoggingEventHandlers } = require('../lib/loggingUtils');
-
-const sandbox = Sinon.createSandbox();
-
-
-Test.beforeEach((t) => {
-
-    t.context.logger = {
-        child: sandbox.stub()
-    };
-    t.context.metadata = {
-        properties: {
-            headers: {
-                eventId: faker.string.uuid()
-            }
-        },
-        fields: {
-            routingKey: faker.string.uuid()
-        }
-    };
-    t.context.event = sandbox.spy();
-    t.context.minionWorkerName = faker.word.sample();
-    t.context.handler = sandbox.spy();
-    t.context.rabbit = {
-        topic: () => ({
-            publish: sandbox.spy()
-        })
-    };
-});
-
-Test.afterEach((t) => {
-
-    sandbox.restore();
-});
-
-Test('createLoggerContext wraps a handler', (t) => {
-
-    const { context: { logger, event, metadata, minionWorkerName, handler } } = t;
-
-    const wrappedHandler = createLoggerContext(logger, minionWorkerName, handler);
-
-    const childLogger = sandbox.spy();
-
-    t.context.logger.child.returns(childLogger);
-
-    wrappedHandler(event, metadata);
-
-    Sinon.assert.calledOnceWithExactly(logger.child, { eventId: metadata.properties.headers.eventId, routingKey: metadata.fields.routingKey, minionWorkerName });
-
-    Sinon.assert.calledOnceWithExactly(handler, event, metadata, { logger: childLogger });
-
-    t.pass();
-});
-
-Test('createLoggerContext does not fail if the logger fails', (t) => {
-
-    const { context: { logger, event, metadata, minionWorkerName, handler } } = t;
-
-    const wrappedHandler = createLoggerContext(logger, minionWorkerName, handler);
-
-    t.context.logger.child.throws(new Error('failed to create logger'));
-
-    wrappedHandler(event, metadata);
-
-    Sinon.assert.calledOnceWithExactly(logger.child, { eventId: metadata.properties.headers.eventId, routingKey: metadata.fields.routingKey, minionWorkerName });
-
-    Sinon.assert.calledOnceWithExactly(handler, event, metadata, {});
-
-    t.pass();
-});
-
-Test('injectFieldFromEventAs adds field to the logger', (t) => {
-
-    const { context: { logger, metadata, handler } } = t;
-
-    const wrappedHandler = injectFieldFromEventAs(logger, 'encounterId', 'triageId')(handler);
-
-    const childLogger = sandbox.spy();
-
-    t.context.logger.child.returns(childLogger);
-
-    const event = {
-        triageId: faker.database.mongodbObjectId()
-    };
-
-    wrappedHandler(event, metadata);
-
-    Sinon.assert.calledOnceWithExactly(logger.child, { encounterId: event.triageId });
-
-    Sinon.assert.calledOnceWithExactly(handler, event, metadata, { logger: childLogger });
-
-    t.pass();
-});
-
-Test('injectFieldFromEventAs does not add the field to the logger if it is missing', (t) => {
-
-    const { context: { logger, metadata, handler } } = t;
-
-    const wrappedHandler = injectFieldFromEventAs(logger, 'encounterId', 'triageId')(handler);
-
-    const childLogger = sandbox.spy();
-
-    t.context.logger.child.returns(childLogger);
-
-    const event = {};
-
-    wrappedHandler(event, metadata);
-
-    Sinon.assert.calledOnceWithExactly(logger.child, { encounterId: undefined });
-
-    Sinon.assert.calledOnceWithExactly(handler, event, metadata, { logger: childLogger });
-
-    t.pass();
-});
-
-
-Test('addDefaultLoggingEventHandlers adds the handlers', (t) => {
-
-    const { context: { logger, rabbit, metadata } } = t;
-
-    const workerName = faker.word.sample();
-    const queueName = faker.word.sample();
-
-    const manifest = {
-        connection: {
-            rabbit
-        },
-        defaults: {
-            exchangeName: faker.word.sample()
-        },
-        workers: [
-            {
-                handler: sandbox.spy(),
-                config: {
-                    name: workerName,
-                    key: queueName
-                }
-            }
-        ]
-    };
-
-    const army = Army(manifest);
-
-    t.truthy(army);
-
-    const childLogger = {
-        info: sandbox.spy()
-    };
-
-    t.context.logger.child.returns(childLogger);
-
-    const armyName = faker.word.sample();
-
-    addDefaultLoggingEventHandlers(logger, army, armyName);
-
-    Sinon.assert.calledOnceWithExactly(logger.child, { armyName });
-
-    const event = {
-        data: faker.word.sample()
-    };
-
-    army.minions[workerName].handle(event, metadata);
-
-    const expectedMetadata = {
-        properties: metadata.properties,
-        fields: metadata.fields
-    };
-
-    Sinon.assert.calledOnceWithExactly(childLogger.info, { queue: workerName, event, metadata: expectedMetadata }, 'Got event in %s', armyName);
-});