@codefresh-io/service-base 7.0.4-beta → 7.1.0

package/infra/__tests__/smoke_test.spec.js

@@ -1,5 +1,5 @@
-const { splitUriBySlash, getDbNameFromUri } = require('../helper');
 const { MongoMemoryServer } = require('mongodb-memory-server');
+const { splitUriBySlash, getDbNameFromUri } = require('../helper');
 const mongoClient = require('../mongo');
 
 /**

package/infra/config.js

@@ -1,5 +1,3 @@
-
-
 const _ = require('lodash');
 const path = require('path');
 const fs = require('fs');
@@ -15,8 +13,8 @@ function findAppRoot(dir = path.dirname(require.main.filename)) {
 }
 
 function getApproot() {
-    if ((process.env.NODE_ENV === 'test') &&
-        (_.includes(__dirname, 'node_modules'))) {
+    if ((process.env.NODE_ENV === 'test')
+        && (_.includes(__dirname, 'node_modules'))) {
         return path.resolve(__dirname).split('/node_modules')[0];
     }
     return findAppRoot();
@@ -52,12 +50,14 @@ base.eventbus = {
     serviceName: name,
 };
 
+/** @type {import('pg').PoolConfig} */
 base.postgres = {
     host: process.env.POSTGRES_HOST || APPLICATION_DOMAIN,
-    port: process.env.POSTGRES_PORT || 5432,
+    port: Number.parseInt(process.env.POSTGRES_PORT || '5432', 10),
     database: process.env.POSTGRES_DATABASE || 'postgres',
     user: process.env.POSTGRES_USER || 'postgres',
     password: process.env.POSTGRES_PASSWORD || 'postgres',
+    ssl: process.env.POSTGRES_SSL_ENABLE === 'true',
 };
 
 base.mongo = {
@@ -93,9 +93,9 @@ base.logger = {
                 });
             }
             // human readable format
-            return `${options.timestamp()} ${options.level.toUpperCase()} >> ` +
-                `${options.message || ''}` +
-                `${options.meta && Object.keys(options.meta).length ? ` << ${JSON.stringify(options.meta)}` : ''}`;
+            return `${options.timestamp()} ${options.level.toUpperCase()} >> `
+                + `${options.message || ''}`
+                + `${options.meta && Object.keys(options.meta).length ? ` << ${JSON.stringify(options.meta)}` : ''}`;
         },
     },
     basePath: null,

package/infra/encryption/index.js

@@ -11,7 +11,7 @@ function _encryptDecryptObjectValues(safeId, obj, keysToEncrypt = [], encrypt =
         return Promise.resolve(obj);
     }
     const pairs = _.chain(keysToEncrypt)
-        .map(k => _.has(obj, k) && _.assign({ key: k, value: _.get(obj, k) }))
+        .map((k) => _.has(obj, k) && _.assign({ key: k, value: _.get(obj, k) }))
         .compact()
         .value();
 
@@ -19,8 +19,8 @@ function _encryptDecryptObjectValues(safeId, obj, keysToEncrypt = [], encrypt =
 
     return safe.getOrCreateSafe(safeId)
         .then((safeObj) => {
-            const Promises = pairs.map(kv => _encryptDecryptValue(safeObj, kv.value, encrypt)
-                .then(res => _.set(resObj, kv.key, res)));
+            const Promises = pairs.map((kv) => _encryptDecryptValue(safeObj, kv.value, encrypt)
+                .then((res) => _.set(resObj, kv.key, res)));
             return Promise.all(Promises);
         })
         .then(() => resObj);
@@ -35,13 +35,13 @@ function decryptObjectValues(safeId, obj, keysToEncrypt) {
 }
 
 function replaceEncryptedValues(encryptedObject = {}, keys = [], replaceWith = '*****') {
-    return Promise.map(keys, k => _.has(encryptedObject, k) && _.set(encryptedObject, k, replaceWith))
+    return Promise.map(keys, (k) => _.has(encryptedObject, k) && _.set(encryptedObject, k, replaceWith))
         .then(() => encryptedObject);
 }
 
 module.exports = {
     encryptObjectValues,
     decryptObjectValues,
-    getSafe: safeId => safe.getOrCreateSafe(safeId),
+    getSafe: (safeId) => safe.getOrCreateSafe(safeId),
     replaceEncryptedValues,
 };

package/infra/encryption/safe.js

@@ -1,8 +1,6 @@
-
-
+const { randomUUID } = require('node:crypto');
 const _ = require('lodash');
 const Promise = require('bluebird');
-const uuid = require('node-uuid');
 const crypto = require('crypto');
 
 const config = require('../config');
@@ -45,7 +43,7 @@ function getOrCreateSafe(safeId) {
 
             const newSafe = {
                 _id: safeId,
-                key: (new Buffer(uuid.v4())).toString('base64'), // eslint-disable-line
+                key: (Buffer.from(randomUUID())).toString('base64'), // eslint-disable-line
             };
             return collection.insertOne(newSafe)
                 .then(() => new Safe(newSafe))
@@ -113,7 +111,6 @@ Safe.prototype.write_crypto = function (plaintext) { // eslint-disable-line
     return deferred.promise;
 };
 
-
 Safe.prototype.read = Safe.prototype.read_crypto;
 Safe.prototype.write = Safe.prototype.write_crypto;
 

package/infra/eventbus.js

@@ -1,5 +1,3 @@
-
-
 const Promise = require('bluebird');
 const eventBus = require('@codefresh-io/eventbus');
 const monitor = require('@codefresh-io/cf-monitor');
@@ -39,6 +37,7 @@ class Eventbus {
                         database: this.config.postgres.database,
                         user: this.config.postgres.user,
                         password: this.config.postgres.password,
+                        ssl: this.config.postgres.ssl,
                     },
                     microServiceName: this.config.eventbus.serviceName,
                 });
@@ -59,7 +58,6 @@ class Eventbus {
             });
     }
 
-
     /**
      * stops the connection to eventbus
      * @returns {*}
@@ -119,5 +117,4 @@ class Eventbus {
     }
 }
 
-
 module.exports = new Eventbus();

package/infra/express.js

@@ -1,4 +1,3 @@
-
 const Promise = require('bluebird');
 const express = require('express');
 const compression = require('compression');
@@ -122,9 +121,9 @@ class Express {
                             const statusCode = err.statusCode || 500;
                             // check if err object has overridden toString method
                             // before sending toString() response to prevent [object Object] responses
-                            const message = err.toString === Object.prototype.toString ?
-                                (err.message || 'Internal server error') :
-                                err.toString();
+                            const message = err.toString === Object.prototype.toString
+                                ? (err.message || 'Internal server error')
+                                : err.toString();
                             res.status(statusCode).send({ message });
                         });
                     });
@@ -154,10 +153,9 @@ class Express {
                 .then((ret) => {
                     res.send(ret);
                 })
-                .catch(err => next(err));
+                .catch((err) => next(err));
         };
     }
 }
 
-
 module.exports = new Express();

package/infra/helper.js

@@ -8,5 +8,5 @@ const splitUriBySlash = (uri) => {
     };
 };
 
-const getDbNameFromUri = uri => splitUriBySlash(uri).dbName;
+const getDbNameFromUri = (uri) => splitUriBySlash(uri).dbName;
 module.exports = { splitUriBySlash, getDbNameFromUri };

package/infra/index.js

@@ -1,9 +1,9 @@
-
-
 const monitor = require('@codefresh-io/cf-monitor');
 
 monitor.init();
 const Promise = require('bluebird'); // jshint ignore:line
+const cflogs = require('cf-logs');
+const { openapi } = require('@codefresh-io/cf-openapi');
 const config = require('./config');
 const eventbus = require('./eventbus');
 const mongo = require('./mongo');
@@ -11,8 +11,6 @@ const processEvents = require('./process-events');
 const express = require('./express');
 const logging = require('./logging');
 const redis = require('./redis');
-const cflogs = require('cf-logs');
-const { openapi } = require('@codefresh-io/cf-openapi');
 const { publishInterface, subscribeInterface } = require('./openapi-events');
 
 let logger;
@@ -87,7 +85,7 @@ class Microservice {
                     openapi.events().setSubscribeInterface(subscribeInterface);
                 }
             })
-            .then(() => express.init(config, app => initFn(app, eventbus), opt))
+            .then(() => express.init(config, (app) => initFn(app, eventbus), opt))
             .then(() => {
                 logger.info('Initialization completed');
                 this.markAsReady();

package/infra/logging.js

@@ -1,5 +1,3 @@
-
-
 const Promise = require('bluebird');
 const cflogs = require('cf-logs');
 const { name: serviceName } = require('./config');
@@ -31,5 +29,4 @@ class Logging {
     }
 }
 
-
 module.exports = new Logging();

package/infra/mongo.js

@@ -33,7 +33,6 @@ class Mongo {
         logger.info('Mongo db initialized');
     }
 
-
     /**
      * stops the connection to mongo
      */

package/infra/openapi-events.js

@@ -1,15 +1,19 @@
 const eventbus = require('./eventbus');
 
-const publishInterface = (serviceName) => eventbus.publish('openapi.push', { // eslint-disable-line
-    aggregateId: serviceName,
-}, true, true);
+const publishInterface = (aggregateId) => {
+    eventbus.publish(
+        'openapi.push',
+        { aggregateId },
+        true,
+        true,
+    );
+};
 
 const subscribeInterface = (handler) => {
-    eventbus.subscribe('openapi.push', (data) => {
-        const serviceName = data.aggregateId;
-        return Promise.resolve()
-            .then(() => handler(serviceName));
-    });
+    eventbus.subscribe(
+        'openapi.push',
+        async (data) => handler(data.aggregateId),
+    );
 };
 
 module.exports = {

package/infra/process-events.js

@@ -1,5 +1,3 @@
-
-
 const EventEmitter = require('events');
 const Promise = require('bluebird');
 
@@ -36,5 +34,4 @@ class ProcessEvents extends EventEmitter {
     }
 }
 
-
 module.exports = new ProcessEvents();

package/infra/redis.js

@@ -1,5 +1,3 @@
-
-
 const Promise = require('bluebird');
 const monitor = require('@codefresh-io/cf-monitor');
 const redis = require('redis');
@@ -24,14 +22,13 @@ class Redis {
             deferred.resolve();
         }, 30000);
 
-        this.client =
-            redis.createClient({
-                host: config.redis.url,
-                port: config.redis.port,
-                password: config.redis.password,
-                db: config.redis.db,
-                tls: config.redis.tls,
-            });
+        this.client = redis.createClient({
+            host: config.redis.url,
+            port: config.redis.port,
+            password: config.redis.password,
+            db: config.redis.db,
+            tls: config.redis.tls,
+        });
 
         this.client.on('ready', () => {
             logger.info('Redis client ready');
@@ -55,7 +52,6 @@ class Redis {
         return deferred.promise;
     }
 
-
     /**
      * stops the connection to redis
      * @returns {*}

package/infra/validation.js

@@ -36,7 +36,6 @@ const customJsonSchemaStringJoi = Joi.extend((joi) => ({ // eslint-disable-line
 }));
 Joi.jsonSchemaString = customJsonSchemaStringJoi.jsonSchemaString;
 
-
 function validateField(field, val, options = { optional: false }) {
     if (val === undefined && _.get(options, 'optional')) {
         return Promise.resolve();
@@ -50,8 +49,8 @@ function validateFields(partialObject, options) {
 }
 
 function validateWithContext(obj, context) {
-    return this.validate(Object.assign({}, obj, context))
-        .then(normalized => _.omit(normalized, Object.keys(context)));
+    return this.validate({ ...obj, ...context })
+        .then((normalized) => _.omit(normalized, Object.keys(context)));
 }
 
 module.exports = {

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@codefresh-io/service-base",
-  "version": "7.0.4-beta",
+  "version": "7.1.0",
   "main": "index.js",
   "description": "",
   "bin": {
     "cf-openapi": "./node_modules/cf-openapi/bin/cf-openapi"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": "^20.0.0 || ^22.0.0"
   },
+  "files": [
+    "index.js",
+    "infra/**/*"
+  ],
   "scripts": {
     "test": "(find . -not -path './node_modules/*' -path '*/*.spec.js' | grep -v '__tests__' | NODE_ENV=test xargs mocha) && jest",
     "start": "node index.js",
-    "eslint": "eslint infra/**"
+    "lint": "eslint infra/**",
+    "build": "echo 'No build step'"
   },
   "repository": {
     "type": "git",
@@ -33,9 +38,9 @@
   "homepage": "https://github.com/codefresh-io/service-base#readme",
   "dependencies": {
     "@codefresh-io/authenticated-entity": "^2.17.1",
-    "@codefresh-io/cf-monitor": "^12.0.0",
+    "@codefresh-io/cf-monitor": "^12.15.0",
     "@codefresh-io/cf-openapi": "^0.7.20",
-    "@codefresh-io/eventbus": "^2.0.0",
+    "@codefresh-io/eventbus": "^2.2.0",
     "@codefresh-io/http-infra": "^1.8.15",
     "@codefresh-io/internal-service-config": "^1.0.3",
     "@wegolook/joi-objectid": "^2.4.0",
@@ -52,9 +57,8 @@
     "js-yaml": "^3.13.1",
     "lodash": "4.17.21",
     "method-override": "^3.0.0",
-    "mongodb": "4.7.0",
+    "mongodb": "^6.15.0",
     "morgan": "^1.9.1",
-    "node-uuid": "^1.4.8",
     "proxyquire": "^1.8.0",
     "queue": "^4.2.1",
     "redis": "^3.1.0",
@@ -63,13 +67,14 @@
   },
   "devDependencies": {
     "@shelf/jest-mongodb": "^4.2.0",
-    "eslint": "^4.18.2",
-    "eslint-config-airbnb-base": "^12.1.0",
-    "eslint-plugin-import": "^2.9.0",
+    "eslint": "^8.52.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^27.6.3",
     "eslint-plugin-mocha": "^4.12.1",
     "jest": "^29.7.0",
     "mocha": "^8.2.1",
     "mongodb-memory-server": "^9.1.6"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

package/.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

package/.eslintrc.js

@@ -1,32 +0,0 @@
-module.exports = {
-    'plugins': [
-        'mocha',
-        'jest'
-    ],
-    'extends': 'airbnb-base',
-    'rules': {
-        'indent': ['error', 4, { 'SwitchCase': 1 }],
-        'no-underscore-dangle': [0],
-        'max-len': ['error', {
-            'code': 140,
-            'ignoreComments': true
-        }],
-        'no-console': 0,
-        "object-curly-newline": ["error", {
-            "ObjectPattern": { "multiline": true },
-        }],
-        "newline-per-chained-call": ["error", {
-            "ignoreChainWithDepth": 10,
-        }],
-        "object-property-newline": ["error", {
-            "allowAllPropertiesOnSameLine": true,
-        }]
-    },
-    'env': {
-        'mocha': true,
-        'jest': true
-    },
-    "globals": {
-        "negativeAssertion": true
-    }
-};

package/.gitattributes

@@ -1,2 +0,0 @@
-# Set the default behavior, in case people don't have core.autocrlf set.
-* text eol=lf

package/codefresh.yaml

@@ -1,28 +0,0 @@
-version: '1.0'
-steps:
-    main_clone:
-        title: 'Cloning main repository...'
-        type: git-clone
-        repo: '${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}'
-        revision: ${{CF_BRANCH}}
-
-    install_dependencies:
-        title: 'Installing testing dependencies'
-        image: node:${{NODE_VERSION}}
-        commands:
-            - yarn install --frozen-lockfile
-
-    eslint:
-        title: 'Running linting logic'
-        image: node:${{NODE_VERSION}}
-        commands:
-            - yarn eslint
-
-    deploy_to_npm:
-        type: npm-publish
-        arguments:
-            NPM_TOKEN: '${{NPM_TOKEN}}'
-            DIR: '${{CF_REPO_NAME}}'
-        when:
-            branch:
-                only: [ master ]

package/jest.config.js

@@ -1,186 +0,0 @@
-// For a detailed explanation regarding each configuration property, visit:
-// https://jestjs.io/docs/en/configuration.html
-
-module.exports = {
-    preset: '@shelf/jest-mongodb',
-    // All imported modules in your tests should be mocked automatically
-    // automock: false,
-
-    // Stop running tests after `n` failures
-    // bail: 0,
-
-    // Respect "browser" field in package.json when resolving modules
-    // browser: false,
-
-    // The directory where Jest should store its cached dependency information
-    // cacheDirectory: "/private/var/folders/f8/9_8h1fmx21d1vmcpl0nnyjw00000gn/T/jest_dx",
-
-    // Automatically clear mock calls and instances between every test
-    clearMocks: true,
-
-    // Indicates whether the coverage information should be collected while executing the test
-    // collectCoverage: false,
-
-    // An array of glob patterns indicating a set of files for which coverage information should be collected
-    // collectCoverageFrom: null,
-
-    // The directory where Jest should output its coverage files
-    coverageDirectory: 'coverage',
-
-    // An array of regexp pattern strings used to skip coverage collection
-    coveragePathIgnorePatterns: [
-        '/node_modules/',
-    ],
-
-    // A list of reporter names that Jest uses when writing coverage reports
-    // coverageReporters: [
-    //   "json",
-    //   "text",
-    //   "lcov",
-    //   "clover"
-    // ],
-
-    // An object that configures minimum threshold enforcement for coverage results
-    // coverageThreshold: null,
-
-    // A path to a custom dependency extractor
-    // dependencyExtractor: null,
-
-    // Make calling deprecated APIs throw helpful error messages
-    // errorOnDeprecated: false,
-
-    // Force coverage collection from ignored files using an array of glob patterns
-    // forceCoverageMatch: [],
-
-    // A path to a module which exports an async function that is triggered once before all test suites
-    // globalSetup: null,
-
-    // A path to a module which exports an async function that is triggered once after all test suites
-    // globalTeardown: null,
-
-    // A set of global variables that need to be available in all test environments
-    // globals: {},
-
-    // An array of directory names to be searched recursively up from the requiring module's location
-    // moduleDirectories: [
-    //   "node_modules"
-    // ],
-
-    // An array of file extensions your modules use
-    // moduleFileExtensions: [
-    //   "js",
-    //   "json",
-    //   "jsx",
-    //   "ts",
-    //   "tsx",
-    //   "node"
-    // ],
-
-    // A map from regular expressions to module names that allow to stub out resources with a single module
-    // moduleNameMapper: {},
-
-    // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-    // modulePathIgnorePatterns: [],
-
-    // Activates notifications for test results
-    // notify: false,
-
-    // An enum that specifies notification mode. Requires { notify: true }
-    // notifyMode: "failure-change",
-
-    // A preset that is used as a base for Jest's configuration
-    // preset: null,
-
-    // Run tests from one or more projects
-    // projects: null,
-
-    // Use this configuration option to add custom reporters to Jest
-    // reporters: undefined,
-
-    // Automatically reset mock state between every test
-    // resetMocks: false,
-
-    // Reset the module registry before running each individual test
-    // resetModules: false,
-
-    // A path to a custom resolver
-    // resolver: null,
-
-    // Automatically restore mock state between every test
-    // restoreMocks: false,
-
-    // The root directory that Jest should scan for tests and modules within
-    // rootDir: null,
-
-    // A list of paths to directories that Jest should use to search for files in
-    // roots: [
-    //   "<rootDir>"
-    // ],
-
-    // Allows you to use a custom runner instead of Jest's default test runner
-    // runner: "jest-runner",
-
-    // The paths to modules that run some code to configure or set up the testing environment before each test
-    // setupFiles: [],
-
-    // A list of paths to modules that run some code to configure or set up the testing framework before each test
-    // setupFilesAfterEnv: [],
-
-    // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-    // snapshotSerializers: [],
-
-    // The test environment that will be used for testing
-    testEnvironment: 'node',
-
-    // Options that will be passed to the testEnvironment
-    // testEnvironmentOptions: {},
-
-    // Adds a location field to test results
-    // testLocationInResults: false,
-
-    // The glob patterns Jest uses to detect test files
-    testMatch: [
-        '**/__tests__/**/*.[jt]s?(x)',
-    ],
-
-    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-    // testPathIgnorePatterns: [
-    //   "/node_modules/"
-    // ],
-
-    // The regexp pattern or array of patterns that Jest uses to detect test files
-    // testRegex: [
-    // ],
-
-    // This option allows the use of a custom results processor
-    // testResultsProcessor: null,
-
-    // This option allows use of a custom test runner
-    // testRunner: "jasmine2",
-
-    // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
-    // testURL: "http://localhost",
-
-    // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
-    // timers: "real",
-
-    // A map from regular expressions to paths to transformers
-    // transform: null,
-
-    // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-    // transformIgnorePatterns: [
-    //   "/node_modules/"
-    // ],
-
-    // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-    // unmockedModulePathPatterns: undefined,
-
-    // Indicates whether each individual test should be reported during the run
-    // verbose: null,
-
-    // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-    // watchPathIgnorePatterns: [],
-
-    // Whether to use watchman for file crawling
-    // watchman: true,
-};