chore(csi-162): added redis proxyCache impl.; updated interfaces

.circleci/config.yml

@@ -25,6 +25,16 @@ defaults_docker_Dependencies: &defaults_docker_Dependencies |
     apk --no-cache add bash bash-doc bash-completion
     npm install -g node-gyp
 
+defaults_machine_Dependencies: &defaults_machine_Dependencies |
+  ## Add Package Repos
+  ## Ref: https://docs.confluent.io/platform/current/installation/installing_cp/deb-ubuntu.html#get-the-software
+  wget -qO - https://packages.confluent.io/deb/7.4/archive.key | sudo apt-key add -
+  sudo add-apt-repository -y "deb https://packages.confluent.io/clients/deb $(lsb_release -cs) main"
+
+  ## Install deps
+  sudo apt install -y curl bash musl-dev libsasl2-dev
+  sudo ln -s /usr/lib/x86_64-linux-musl/libc.so /lib/libc.musl-x86_64.so.1
+
 defaults_awsCliDependencies: &defaults_awsCliDependencies |
     apk --no-cache add aws-cli
 
@@ -46,6 +56,8 @@ defaults_npm_publish_release: &defaults_npm_publish_release
     npm ci
     echo "Publishing tag $RELEASE_TAG"
     npm publish --tag $RELEASE_TAG --access public
+    echo $(node -p "require('./package.json').name")
+    npm dist-tag add @mojaloop/inter-scheme-proxy-cache-lib@$RELEASE_TAG latest
 
 defaults_export_version_from_package: &defaults_export_version_from_package
   name: Format the changelog into the github release body and get release tag
@@ -241,6 +253,27 @@ jobs:
       - store_test_results:
           path: coverage
 
+  test-integration:
+    executor: default-machine
+    steps:
+      - run:
+          name: Install general dependencies
+          command: *defaults_machine_Dependencies
+      - checkout
+      - run:
+          <<: *defaults_configure_nvm
+      - run:
+          <<: *defaults_display_versions
+      - restore_cache:
+          key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
+      - run:
+          name: Execute integration tests
+          command: |
+            docker compose build
+            docker compose up -d
+            npm run test:int
+            docker compose down -v
+
   vulnerability-check:
     executor: default-docker
     steps:
@@ -439,7 +472,7 @@ workflows:
           context: org-global
       - setup:
           context: org-global
-          filters:
+          filters: &BUILD_AND_TEST_FILTERS
             tags:
               only: /.*/
             branches:
@@ -491,6 +524,11 @@ workflows:
               ignore:
                 - /feature*/
                 - /bugfix*/
+      - test-integration:
+          context: org-global
+          requires:
+            - setup
+          filters: *BUILD_AND_TEST_FILTERS
       - vulnerability-check:
           context: org-global
           requires:

.env

@@ -0,0 +1,4 @@
+LOG_LEVEL_PROXY_CACHE=debug
+
+REDIS_HOST=localhost
+REDIS_PORT=6379

README.md

@@ -19,13 +19,17 @@ npm install @mojaloop/inter-scheme-proxy-cache-lib
 
 ```typescript
 // ESM
-import { createProxyCache } from '@mojaloop/inter-scheme-proxy-cache-lib';
+import { createProxyCache, STORAGE_TYPES } from '@mojaloop/inter-scheme-proxy-cache-lib';
 // CJS
 const { createProxyCache } = require('@mojaloop/inter-scheme-proxy-cache-lib');
 
-const proxyCache = createProxyCache({ type: 'redis', ... });
+const proxyCache = createProxyCache(STORAGE_TYPES.redis, { 
+  host: localhost,
+  port: 6379,
+  ...
+});
 // todo: define usefull example
-await proxyCache.addDfspIdToProxyMapping('proxyId_1', { url: 'https://hab-a/proxy' });
+await proxyCache.addDfspIdToProxyMapping('dfsp_1', 'proxyAB');
 ```
 
 ### TypeDoc
@@ -35,7 +39,7 @@ could be found [**here**](https://mojaloop.github.io/inter-scheme-proxy-cache-li
 
 ### API
 ```typescript
- addDfspIdToProxyMapping: (dfspId: string, details: PoxyDetails) => Promise<boolean>;
+ addDfspIdToProxyMapping: (dfspId: string, proxyId: string) => Promise<boolean>;
  // Add the proxyAdapter details of a particular DFSP to proxy mapping
 
  ...

docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3.9"
+
+services:
+  redis:
+    image: redis:6.2.4-alpine
+#    image: redis/redis-stack:latest
+    restart: "unless-stopped"
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+      - REDIS_PORT=6379
+      - REDIS_REPLICATION_MODE=master
+      - REDIS_TLS_ENABLED=no
+    ports:
+      - "${REDIS_PORT}:6379"