@mojaloop/central-services-shared 18.28.2 → 18.29.0-snapshot.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.
 
+### [18.28.3](https://github.com/mojaloop/central-services-shared/compare/v18.28.2...v18.28.3) (2025-06-24)
+
+
+### Chore
+
+* add parties to header resources ([#459](https://github.com/mojaloop/central-services-shared/issues/459)) ([5092d84](https://github.com/mojaloop/central-services-shared/commit/5092d84125e72257ecb9bdcff1441274c253ca04))
+
 ### [18.28.2](https://github.com/mojaloop/central-services-shared/compare/v18.28.1...v18.28.2) (2025-06-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.28.2",
+  "version": "18.29.0-snapshot.0",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -41,6 +41,7 @@
     "lint": "npm run standard",
     "lint:fix": "npm run standard:fix",
     "test": "npm run test:unit",
+    "test:distLock": "npx tape 'test/unit/util/distLock/**/*.test.js'",
     "test:header": "npx tape 'test/unit/util/headerValidation/**/*.test.js'",
     "test:logging": "npx tape 'test/unit/util/hapi/plugins/loggingPlugin.test.js'",
     "test:endpoints": "npx tape 'test/unit/util/endpoints.test.js'",
@@ -70,10 +71,10 @@
     "@opentelemetry/api": "1.9.0",
     "async-exit-hook": "2.0.1",
     "async-retry": "1.3.3",
-    "axios": "1.9.0",
+    "axios": "1.10.0",
     "clone": "2.1.2",
     "convict": "^6.2.4",
-    "dotenv": "16.5.0",
+    "dotenv": "17.0.0",
     "env-var": "7.5.0",
     "event-stream": "4.0.1",
     "fast-safe-stringify": "2.1.1",
@@ -82,9 +83,10 @@
     "joi": "17.13.3",
     "lodash": "4.17.21",
     "mustache": "4.2.0",
-    "openapi-backend": "5.12.0",
+    "openapi-backend": "5.13.0",
     "raw-body": "3.0.0",
     "rc": "1.2.8",
+    "redlock": "5.0.0-beta.2",
     "shins": "2.6.0",
     "ulidx": "2.4.1",
     "uuid4": "2.0.3",
@@ -96,8 +98,8 @@
     "@mojaloop/central-services-logger": "11.9.0",
     "@mojaloop/central-services-metrics": "12.6.0",
     "@mojaloop/event-sdk": "14.6.1",
-    "@mojaloop/sdk-standard-components": "19.15.2",
-    "@opentelemetry/auto-instrumentations-node": "^0.60.0",
+    "@mojaloop/sdk-standard-components": "19.16.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.60.1",
     "@types/hapi__joi": "17.1.15",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
@@ -112,7 +114,7 @@
     "proxyquire": "2.1.3",
     "replace": "1.2.2",
     "rewire": "8.0.0",
-    "sinon": "20.0.0",
+    "sinon": "21.0.0",
     "standard": "17.1.2",
     "standard-version": "9.5.0",
     "tap-spec": "5.0.0",

package/src/enums/http.js

@@ -127,7 +127,8 @@ const HeaderResources = {
   TRANSFERS: 'transfers',
   FX_TRANSFERS: 'fxTransfers',
   QUOTES: 'quotes',
-  FX_QUOTES: 'fxQuotes'
+  FX_QUOTES: 'fxQuotes',
+  PARTIES: 'parties'
 }
 
 const ServiceType = {

package/src/index.d.ts

@@ -19,6 +19,15 @@ declare namespace CentralServicesShared {
         URI: string;
       };
     };
+    HeaderResources: {
+      PARTICIPANTS: string;
+      ORACLE: string;
+      TRANSFERS: string;
+      FX_TRANSFERS: string;
+      QUOTES: string;
+      FX_QUOTES: string;
+      PARTIES: string;
+    };
     ReturnCodes: {
       OK: ReturnCode;
       ACCEPTED: ReturnCode;
@@ -769,6 +778,42 @@ declare namespace CentralServicesShared {
     RedisCache: RedisCache;
   }
 
+  type RedisInstanceConfig = 
+    | {
+        type: 'redis';
+        host: string;
+        port: number;
+      }
+    | {
+        type: 'redis-cluster';
+        cluster: Array<{ host: string; port: number }>;
+      };
+
+  interface DistributedLockConfig {
+    redisConfigs: RedisInstanceConfig[];
+    driftFactor?: number;
+    retryCount?: number;
+    retryDelay?: number;
+    retryJitter?: number;
+    lockTimeout?: number;
+  }
+
+  interface LockInterface {
+    acquire(key: string, ttl: number, acquireTimeout?: number): Promise<string>;
+    release(): Promise<boolean>;
+    extend(ttl: number): Promise<string>;
+  }
+
+  interface DistributedLock extends LockInterface {
+    config: DistributedLockConfig;
+    logger: ILogger;
+    redisInstances: IORedis[];
+  }
+
+  interface DistLock {
+    createLock(config: DistributedLockConfig, logger?: ILogger): DistributedLock;
+  }
+
   interface Util {
     Endpoints: Endpoints;
     Participants: Participants;
@@ -780,6 +825,7 @@ declare namespace CentralServicesShared {
     StreamingProtocol: StreamingProtocol;
     HeaderValidation: HeaderValidation;
     Redis: Redis;
+    distLock: DistLock;
   }
 
   const Enum: Enum

package/src/util/distLock/constants.js

@@ -0,0 +1,18 @@
+const ERROR_MESSAGES = {
+  ACQUIRE_ERROR: 'Failed to acquire lock',
+  NO_LOCK_TO_RELEASE: 'No lock to release',
+  NO_LOCK_TO_EXTEND: 'No lock to extend',
+  REDLOCK_ERROR: 'Redlock error occurred',
+  INVALID_CONFIG: 'Invalid configuration for distributed lock',
+  TIMEOUT_ERROR: 'Timeout while trying to acquire lock'
+}
+
+const REDIS_TYPE = {
+  REDIS: 'redis',
+  REDIS_CLUSTER: 'redis-cluster'
+}
+
+module.exports = {
+  ERROR_MESSAGES,
+  REDIS_TYPE
+}

package/src/util/distLock/impl/redlock.js

@@ -0,0 +1,157 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 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. 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * Infitx
+ - Steven Oderayi <steven.oderayi@infitx.com>
+
+ --------------
+
+ ******/
+
+'use strict'
+
+const Redis = require('ioredis')
+const { default: Redlock } = require('redlock')
+const { logger: defaultLogger } = require('../../../logger')
+const LockInterface = require('../lock')
+const { ERROR_MESSAGES, REDIS_TYPE } = require('../constants')
+
+/**
+ * @typedef {Object} DistributedLockConfig
+ * @property {Array<Object>} redisConfigs - Array of Redis instance configurations.
+ * @property {string} redisConfigs[].type - Type of Redis instance ('redis' or 'redis-cluster').
+ * @property {string} redisConfigs[].host - Hostname of a standalone Redis instance when type is "redis".
+ * @property {number} redisConfigs[].port - Port of a standalone Redis instance when type is "redis".
+ * @property {number} redisConfigs[].cluster - Array of Redis leader nodes for cluster configuration when type is "redis-cluster".
+ * @property {string} redisConfigs[].cluster[].host - Hostname of the Redis leader node in a cluster.
+ * @property {number} redisConfigs[].cluster[].port - Port of a the Redis leader node in a cluster.
+ * @property {number} [driftFactor=0.01] - Drift factor for Redlock.
+ * @property {number} [retryCount=3] - Number of retry attempts for acquiring a lock.
+ * @property {number} [retryDelay=200] - Delay in milliseconds between retry attempts.
+ * @property {number} [retryJitter=100] - Jitter in milliseconds for retry delay.
+ * @property {number} [lockTimeout=10000] - Time-to-live for the lock in milliseconds.
+ *
+ */
+
+/**
+ * DistributedLock class provides a distributed locking mechanism using Redlock.
+ * It supports both Redis standalone and Redis Cluster configurations simultaneously.
+ * It allows acquiring, releasing, and extending locks across multiple Redis instances.
+ *
+ * @class DistributedLock
+ * @param {DistributedLockConfig} config - Configuration for the distributed lock.
+ * @param {Object} [logger=console] - Logger instance for logging messages.
+ */
+class DistributedLock extends LockInterface {
+  #redlock = null
+  #lock = null
+  #timeout = null
+
+  constructor (config, logger) {
+    super()
+    this.config = config
+    this.logger = (logger || defaultLogger).child({ component: this.constructor.name })
+    this.redisInstances = config.redisConfigs.map(instance => this.#createRedisClient(instance))
+    this.#redlock = new Redlock(this.redisInstances, {
+      driftFactor: config.driftFactor || 0.01,
+      retryCount: config.retryCount || 3,
+      retryDelay: config.retryDelay || 200,
+      retryJitter: config.retryJitter || 100
+    })
+    this.#redlock.on('error', this.#handleError.bind(this))
+  }
+
+  async acquire (key, ttl, acquireTimeout = 2000) {
+    let timeoutError
+    const timeoutPromise = new Promise((_resolve, reject) => {
+      const timeout = setTimeout(() => {
+        timeoutError = new Error(ERROR_MESSAGES.TIMEOUT_ERROR)
+        reject(timeoutError)
+      }, acquireTimeout)
+      this.#timeout = timeout // Store timeout reference to clear it later
+    })
+
+    try {
+      this.#lock = await Promise.race([
+        this.#redlock.acquire([key], ttl),
+        timeoutPromise
+      ])
+      clearTimeout(this.#timeout) // Clear timeout if lock is acquired
+      if (!this.#lock) {
+        throw new Error(ERROR_MESSAGES.ACQUIRE_ERROR)
+      }
+      this.logger.debug(`Lock acquired: ${this.#lock.value} with TTL: ${ttl}ms`)
+      return this.#lock.value
+    } catch (error) {
+      if (error === timeoutError) {
+        this.logger.error(error.stack) // Possible redis connection issue, cluster not correctly setup etc.
+      }
+      throw error // Re-throw the error for the caller to handle
+    }
+  }
+
+  async release () {
+    if (!this.#lock) {
+      throw new Error(ERROR_MESSAGES.NO_LOCK_TO_RELEASE)
+    }
+    await this.#redlock.release(this.#lock)
+    this.logger.debug(`Lock released: ${this.#lock.value}`)
+    this.#lock = null
+    return true
+  }
+
+  async extend (ttl) {
+    if (!this.#lock) {
+      throw new Error(ERROR_MESSAGES.NO_LOCK_TO_EXTEND)
+    }
+    this.#lock = await this.#redlock.extend(this.#lock, ttl)
+    this.logger.debug(`Lock extended: ${this.#lock.value} with new TTL: ${ttl}ms`)
+    return this.#lock.value
+  }
+
+  #createRedisClient (instance) {
+    return instance.type === REDIS_TYPE.REDIS_CLUSTER
+      ? new Redis.Cluster(instance.cluster)
+      : new Redis(instance)
+  }
+
+  #handleError (error) {
+    // Logging with debug level as all redlock methods throw on all failures anyway.
+    // The error here is only more specific for fixing technical issues.
+    this.logger.debug(ERROR_MESSAGES.REDLOCK_ERROR, error)
+  }
+}
+
+const createLock = (config, logger) => {
+  logger.verbose('createLock config: ', { config })
+  if (!Array.isArray(config?.redisConfigs)) {
+    throw new Error(ERROR_MESSAGES.INVALID_CONFIG)
+  }
+  const distLock = new DistributedLock(config, logger)
+  return distLock
+}
+
+module.exports = {
+  createLock
+}

package/src/util/distLock/index.js

@@ -0,0 +1 @@
+module.exports = require('./impl/redlock.js')

package/src/util/distLock/lock.js

@@ -0,0 +1,109 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 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. 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * Infitx
+ - Steven Oderayi <steven.oderayi@infitx.com>
+
+ --------------
+
+ ******/
+
+'use strict'
+
+/**
+ * @interface LockInterface
+ * @property {Function} acquire - Method to acquire a lock.
+ * @property {Function} release - Method to release a lock.
+ * @property {Function} extend - Method to extend a lock.
+ */
+
+class LockInterface {
+  /**
+   * @constructor
+   * @param {Object} config - Configuration for the lock implementation.
+   * @param {Object} logger - Logger instance for logging.
+   */
+  constructor (config, logger) {
+    if (new.target === LockInterface) {
+      throw new TypeError('Cannot construct LockInterface instances directly')
+    }
+    validateInterface(this)
+  }
+
+  /**
+   * @method acquire
+   * @param {string} key - The key to acquire the lock for.
+   * @param {number} ttl - Time to live for the lock.
+   * @param {number} acquireTimeout - Timeout for acquiring the lock.
+   */
+  /* istanbul ignore next */
+  acquire (key, ttl, acquireTimeout) {
+    throw new Error('Method "acquire" must be implemented')
+  }
+
+  /**
+   * @method release
+   */
+  /* istanbul ignore next */
+  release () {
+    throw new Error('Method "release" must be implemented')
+  }
+
+  /**
+   * @method extend
+   * @param {number} ttl - New time to live for the lock.
+   */
+  /* istanbul ignore next */
+  extend (ttl) {
+    throw new Error('Method "extend" must be implemented')
+  }
+}
+
+function getClassMethodsFromClass (Class) {
+  const prototype = Class.prototype
+  return Object.getOwnPropertyNames(prototype).filter(
+    (prop) =>
+      typeof prototype[prop] === 'function' &&
+      prop !== 'constructor'
+  )
+}
+
+function hasOwnMethod (instance, methodName) {
+  const prototype = Object.getPrototypeOf(instance)
+  return (
+    Object.getOwnPropertyNames(prototype).includes(methodName) &&
+    typeof prototype[methodName] === 'function'
+  )
+}
+
+function validateInterface (instance) {
+  const methods = getClassMethodsFromClass(LockInterface)
+  methods.forEach((method) => {
+    if (!hasOwnMethod(instance, method)) {
+      throw new Error(`Class must implement method: "${method}"`)
+    }
+  })
+}
+
+module.exports = LockInterface

package/src/util/index.js

@@ -55,6 +55,7 @@ const id = require('./id')
 const rethrow = require('./rethrow')
 const Redis = require('./redis')
 const createLogger = require('./createLogger')
+const distLock = require('./distLock')
 
 const omitNil = (object) => {
   return _.omitBy(object, _.isNil)
@@ -267,5 +268,6 @@ module.exports = {
   id,
   resourceVersions: Helpers.resourceVersions,
   rethrow,
-  Redis
+  Redis,
+  distLock
 }

package/test/unit/util/distLock/impl/redlock.test.js

@@ -0,0 +1,194 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 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. 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * Infitx
+ - Steven Oderayi <steven.oderayi@infitx.com>
+
+ --------------
+
+ ******/
+
+'use strict'
+
+const Test = require('tapes')(require('tape'))
+const sinon = require('sinon')
+const Proxyquire = require('proxyquire')
+const { ERROR_MESSAGES } = require('#src/util/distLock/constants')
+const { mockRedis, mockRedlock, mockConfig, mockLogger } = require('../mocks')
+
+const proxyqireRedlockImpl = (redlock = mockRedlock) => Proxyquire('#src/util/distLock/impl/redlock', {
+  ioredis: mockRedis,
+  redlock: { default: redlock }
+})
+
+Test('DistributedLock', async (distLockTest) => {
+  let DistributedLock
+
+  distLockTest.beforeEach((t) => {
+    DistributedLock = proxyqireRedlockImpl()
+    t.end()
+  })
+
+  distLockTest.test('createLock', async (t) => {
+    t.test('should create a new DistributedLock instance', async (t) => {
+      const lock = DistributedLock.createLock(mockConfig, mockLogger)
+      t.ok(lock, 'Lock instance should be created')
+      t.end()
+    })
+    t.test('should create a new DistributedLock with redis-cluster config', async (t) => {
+      const minConfig = {
+        redisConfigs: [{ type: 'redis-cluster', cluster: [{ host: 'localhost', port: 6379 }] }]
+      }
+      const lock = DistributedLock.createLock(minConfig, mockLogger)
+      t.ok(lock, 'Lock instance with redis-cluster config should be created')
+      t.end()
+    })
+    t.test('should create a new DistributedLock with defaults', async (t) => {
+      const minConfig = {
+        redisConfigs: [{ type: 'redis', host: 'localhost', port: 6379 }]
+      }
+      const lock = DistributedLock.createLock(minConfig, mockLogger)
+      t.ok(lock, 'Lock instance with default config should be created')
+      t.end()
+    })
+    t.test('should throw error for invalid config', async (t) => {
+      const invalidConfig = { redisConfigs: 'invalid' }
+      t.throws(() => DistributedLock.createLock(invalidConfig, mockLogger), /Invalid configuration/, 'Should throw error for invalid config')
+      t.end()
+    })
+    t.end()
+  })
+
+  distLockTest.test('acquire', async (t) => {
+    t.test('should acquire lock successfully', async (t) => {
+      const lock = DistributedLock.createLock(mockConfig, mockLogger)
+      const result = await lock.acquire('test-key', 1000)
+      t.equal(result, 'test-lock-value', 'Should return lock value')
+      t.end()
+    })
+    t.test('should throw error on acquire timeout', async (t) => {
+      const mockRedlockMod = sinon.stub().returns({
+        acquire: async () => {
+          await new Promise(resolve => setTimeout(resolve, 6000))
+          return { value: 'test-lock-value' }
+        },
+        on: () => {}
+      })
+      DistributedLock = proxyqireRedlockImpl(mockRedlockMod)
+      const lock = DistributedLock.createLock(mockConfig, mockLogger)
+      try {
+        await lock.acquire('test-key', 1000)
+        t.fail('Should throw timeout error')
+      } catch (error) {
+        t.equal(error.message, ERROR_MESSAGES.TIMEOUT_ERROR, 'Should throw timeout error')
+      }
+      t.end()
+    })
+
+    t.test('should throw error when lock cannot be acquired', async (t) => {
+      const mockRedlockMod = sinon.stub().returns({
+        acquire: async () => null,
+        on: () => {}
+      })
+      DistributedLock = proxyqireRedlockImpl(mockRedlockMod)
+      const lock = DistributedLock.createLock(mockConfig, mockLogger)
+      try {
+        await lock.acquire('test-key', 1000)
+        t.fail('Should throw error when lock cannot be acquired')
+      } catch (error) {
+        t.equal(error.message, ERROR_MESSAGES.ACQUIRE_ERROR, 'Should throw error when lock cannot be acquired')
+      }
+      t.end()
+    })
+    t.end()
+  })
+
+  distLockTest.test('release', async (t) => {
+    t.test('should release lock successfully', async (t) => {
+      const lock = DistributedLock.createLock(mockConfig, mockLogger)
+      await lock.acquire('test-key', 1000)
+      const result = await lock.release()
+      t.true(result, 'Should return true on successful release')
+      t.end()
+    })
+    t.test('should throw error when no lock to release', async (t) => {
+      const lock = DistributedLock.createLock(mockConfig, mockLogger)
+      try {
+        await lock.release()
+        t.fail('Should throw error when no lock exists')
+      } catch (error) {
+        t.equal(error.message, ERROR_MESSAGES.NO_LOCK_TO_RELEASE, 'Should throw error when no lock exists')
+      }
+      t.end()
+    })
+    t.end()
+  })
+
+  distLockTest.test('extend', async (t) => {
+    t.test('should extend lock successfully', async (t) => {
+      const lock = DistributedLock.createLock(mockConfig, mockLogger)
+      await lock.acquire('test-key', 1000)
+      const result = await lock.extend(2000)
+      t.equal(result, 'test-lock-extend-value', 'Should return lock value after extension')
+      t.end()
+    })
+    t.test('should throw error when no lock to extend', async (t) => {
+      const lock = DistributedLock.createLock(mockConfig, mockLogger)
+      try {
+        await lock.extend(2000)
+        t.fail('Should throw error when no lock exists')
+      } catch (error) {
+        t.equal(error.message, ERROR_MESSAGES.NO_LOCK_TO_EXTEND, 'Should throw error when no lock exists')
+      }
+      t.end()
+    })
+    t.end()
+  })
+
+  distLockTest.test('error handling', async (t) => {
+    t.test('should handle redlock errors', async (t) => {
+      let errorLogged = false
+      const errorLogger = {
+        debug: () => { errorLogged = true },
+        verbose: () => {},
+        error: () => {},
+        child: () => errorLogger
+      }
+      const mockRedlockMod = sinon.stub().returns({
+        on: (event, handler) => {
+          if (event === 'error') {
+            handler(new Error('Test error'))
+          }
+        }
+      })
+      DistributedLock = proxyqireRedlockImpl(mockRedlockMod)
+      DistributedLock.createLock(mockConfig, errorLogger)
+      t.true(errorLogged, 'Should log error')
+      t.end()
+    })
+    t.end()
+  })
+
+  distLockTest.end()
+})

package/test/unit/util/distLock/lock.test.js

@@ -0,0 +1,77 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 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. 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * Infitx
+ - Steven Oderayi <steven.oderayi@infitx.com>
+
+ --------------
+
+ ******/
+
+'use strict'
+
+const Test = require('tapes')(require('tape'))
+const LockInterface = require('#src/util/distLock/lock')
+
+Test('LockInterface test', async (lockTest) => {
+  lockTest.test('should throw error when instantiated directly', (test) => {
+    try {
+      const obj = new LockInterface()
+      console.log(obj)
+      test.fail('Expected error not thrown')
+    } catch (error) {
+      test.equal(error.message, 'Cannot construct LockInterface instances directly')
+      test.end()
+    }
+  })
+
+  lockTest.test('should implement acquire method', (test) => {
+    class TestLockImpl extends LockInterface {
+      release () {}
+      extend () {}
+    }
+    test.throws(() => new TestLockImpl(), /Class must implement method: "acquire"/)
+    test.end()
+  })
+
+  lockTest.test('should implement release method', (test) => {
+    class TestLockImpl extends LockInterface {
+      acquire () {}
+      extend () {}
+    }
+    test.throws(() => new TestLockImpl(), /Class must implement method: "release"/)
+    test.end()
+  })
+
+  lockTest.test('should implement extend method', (test) => {
+    class TestLockImpl extends LockInterface {
+      acquire () {}
+      release () {}
+    }
+    test.throws(() => new TestLockImpl(), /Class must implement method: "extend"/)
+    test.end()
+  })
+
+  lockTest.end()
+})

package/test/unit/util/distLock/mocks.js

@@ -0,0 +1,31 @@
+const sinon = require('sinon')
+const { logger } = require('#src/logger')
+
+const mockRedis = sinon.stub()
+const mockCluster = sinon.stub()
+mockRedis.Cluster = mockCluster
+
+const mockRedlock = sinon.stub().returns({
+  acquire: async () => ({ value: 'test-lock-value' }),
+  release: async () => {},
+  extend: async () => ({ value: 'test-lock-extend-value' }),
+  on: () => {}
+})
+
+const mockLogger = logger.child({ context: 'tests' })
+
+const mockConfig = {
+  redisConfigs: [
+    {
+      type: 'redis',
+      host: 'localhost',
+      port: 6379
+    }
+  ],
+  driftFactor: 0.01,
+  retryCount: 3,
+  retryDelay: 200,
+  retryJitter: 100
+}
+
+module.exports = { mockRedis, mockCluster, mockConfig, mockLogger, mockRedlock }