utils ok

Author: ryanhs

.gitignore

@@ -13,3 +13,5 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 yarn.lock
+
+jest.env

.travis.yml

@@ -16,17 +16,17 @@ addons:
     - kafkacat
     - redis-tools
 
-
 before_install:
   # install kafka
   - docker run -d -p 9092:9092 -p 2181:2181 -p 2888:2888 -p 3888:3888 mohamnag/kafka-zookeeper
   - sleep 60 # wait for kafka
+  - kafkacat -b localhost:9092 -L # check for kafka
 
-  # install redis
+  # check redis installation
   - redis-cli keys \*
 
-  # check kafka
-  - kafkacat -b localhost:9092 -L
-
-  # test
+  # check version
   - node --version
+
+  # copy jest.env
+  - cp jest.env.example jest.env

README.md

@@ -9,6 +9,20 @@ Either its kafka, redis, or, nats, or something else. Thats we start to have a m
 
 This curated list i made, is try to put abstraction on top of these libraries.
 
+## Installation
+
+Actually for us personally, we use this curated as "sdk". As it can be used along with chosen framework.
+
+`yarn add sdk@npm:ncurated`
+
+then you can use this so called "sdk".
+
+```javascript
+const sdk = require('sdk');
+
+
+```
+
 ## Integration
 
 This curated list is not really binding into a Framework.
@@ -18,8 +32,49 @@ Please feel free to use any framework to use. \*as long as its compatible :-)
 
 ### Cache
 
+- cache-manager
+- cache-manager-redis-store
+
+Initialized and encapsulated with bluebird. `Promise.promisifyAll(cacheManager)`, thank me later.
+
+This say way we can use something like `sdk.cache.setAsync("a", 1)`.
+
+#### Example
+
+```javascript
+
+await sdk.cache.setAsync("a", 1);
+
+const a = sdk.cache.getAsync("a");
+
+const b = await sdk.cache.wrap('b', () => Promise.resolve('foo'));
+```
+
 ### Log
 
+After some extensive reading for logger library, we have come a cross decision to use bunyan here.
+This bunyan include options for:
+
+- bunyan-debug-stream
+- bunyan-slack
+- bunyan-teams
+- bunyan-cloudwatch
+
+
+#### Example
+
+```javascript
+
+await sdk.log.info("you can refer to bunyan documentation for this log object :-p");
+```
+
+#### Bunyan.RingBuffer
+
+Bunyan ringbuffer is enabled by default. So we can use to track logs, even in unit test mode.
+
+try to get ringBuffer object? this how we do that: `sdk.log.ringBuffer`.
+
+
 ### Metrics
 
 
@@ -35,8 +90,20 @@ Please feel free to use any framework to use. \*as long as its compatible :-)
 ## Mutex
 
 
+## Awesome Libraries
+
+\*bluebird, rxjs, node-machine, moment. No more explanation for these awesome libraries.
+
 ## Requirements
 
 Although some of the packages, it can be running at as log as node 8.11.
 
-Its recommended to run it in current supported LTS version. (Dubnium parhaps?).
+Its recommended to run it in current supported LTS version. (Dubnium perhaps?).
+
+## Changelog
+
+Actually this curated list used only for private use before, therefore we have some changelog related to decision
+
+**v1.12.0 (old name)**
+
+Removed bunyan-elasticsearch, as we use cloudwatch more and more. But feel free to raise a request to add it once again.

jest.env.example

@@ -0,0 +1,3 @@
+KAFKA_BROKER=localhost
+
+REDIS_CONNECTION_STRING=redis://localhost:6379/1

jest.setup.js

@@ -1,5 +1,11 @@
 const { matchers: jsonSchemaMatchers } = require('jest-json-schema');
 
+// yarn
+require('dotenv')
+  .config({
+    path: require('path').resolve(process.cwd(), 'jest.env'),
+  });
+
 // extends
 expect.extend(jsonSchemaMatchers);
 

package.json

@@ -10,24 +10,43 @@
     "node": ">=8.11"
   },
   "devDependencies": {
+    "dotenv": "^8.2.0",
     "eslint": "^6.5.1",
     "eslint-config-airbnb-base": "^14.0.0",
     "eslint-plugin-import": "^2.18.2",
     "eslint-plugin-jest": "^22.20.0",
+    "faker": "^4.1.0",
     "jest": "^24.9.0",
-    "jest-json-schema": "^2.1.0",
-    "npm-run-all": "^4.1.5"
+    "jest-json-schema": "^2.1.0"
   },
   "scripts": {
     "start": "node --trace-warnings node_modules/.bin/jest --passWithNoTests --watch --runInBand --detectOpenHandles",
     "test": "node --trace-warnings node_modules/.bin/jest --passWithNoTests --coverage --runInBand --detectOpenHandles",
-    "lint": "eslint --fix src/ tests/ examples/ snippets/",
+    "lint": "eslint --fix src/ tests/",
     "node:version": "node --version"
   },
   "jest": {
     "testEnvironment": "node",
     "setupFilesAfterEnv": [
       "./jest.setup.js"
     ]
+  },
+  "dependencies": {
+    "aws-sdk": "^2.669.0",
+    "bluebird": "^3.7.2",
+    "bunyan": "^1.8.12",
+    "bunyan-cloudwatch": "^2.2.0",
+    "bunyan-debug-stream": "^2.0.0",
+    "bunyan-slack": "^0.0.10",
+    "bunyan-teams": "^1.0.1",
+    "cache-manager": "^3.3.0",
+    "cache-manager-redis-store": "^2.0.0",
+    "connection-string": "^3.2.2",
+    "flaverr": "^1.10.0",
+    "lodash": "^4.17.15",
+    "machine": "^15.2.2",
+    "moment": "^2.25.3",
+    "rxjs": "^6.5.5",
+    "uuid": "^8.0.0"
   }
 }

src/defaultConfigs/app.js

@@ -0,0 +1,4 @@
+module.exports = {
+  APP_NAME: 'UnnamedApp',
+  APP_LOGO_PRINT: true,
+};

src/defaultConfigs/authorization.js

@@ -0,0 +1,21 @@
+module.exports = {
+  full: {
+    AUTHORIZATION_DRIVER: 'faker',
+    AUTHORIZATION_CONNECTION_STRING: 'http://localhost:80/graphql',
+    AUTHORIZATION_SSL_ENABLE: false,
+    AUTHORIZATION_SSL_REJECT_UNAUTHORIZED: false,
+    AUTHORIZATION_SSL_CA_FILE: '',
+    AUTHORIZATION_SSL_KEY_FILE: '',
+    AUTHORIZATION_SSL_CERT_FILE: '',
+  },
+  development: {
+    AUTHORIZATION_DRIVER: 'faker',
+    AUTHORIZATION_CONNECTION_STRING: 'http://localhost:80/graphql',
+    AUTHORIZATION_SSL_ENABLE: false,
+  },
+  production: {
+    AUTHORIZATION_DRIVER: 'faker',
+    AUTHORIZATION_CONNECTION_STRING: 'http://localhost:80/graphql',
+    AUTHORIZATION_SSL_ENABLE: false,
+  },
+};

src/defaultConfigs/cache.js

@@ -0,0 +1,22 @@
+module.exports = {
+  full: {
+    CACHE_MEMORY_ENABLE: false,
+    CACHE_MEMORY_MAX: 1000,
+    CACHE_MEMORY_TTL: 60,
+
+    CACHE_REDIS_ENABLE: false,
+    CACHE_REDIS_URL: null, // if this provided, then all host port style can be ignored
+    CACHE_REDIS_HOST: '127.0.0.1',
+    CACHE_REDIS_PORT: 6379,
+    CACHE_REDIS_PASS: '',
+    CACHE_REDIS_DB: 1,
+    CACHE_REDIS_TTL: 60,
+  },
+  development: {
+    CACHE_MEMORY_ENABLE: true,
+  },
+  production: {
+    CACHE_MEMORY_ENABLE: false,
+    CACHE_REDIS_ENABLE: false,
+  },
+};

src/defaultConfigs/index.js

@@ -0,0 +1,40 @@
+const defaultApp = require('./app');
+const defaultLog = require('./log');
+const defaultCache = require('./cache');
+const defaultAuthorization = require('./authorization');
+const defaultStream = require('./stream');
+const defaultMutex = require('./mutex');
+const defaultZipkin = require('./zipkin');
+
+module.exports = {
+  development: {
+    ...defaultApp,
+    ...defaultLog.full,
+    ...defaultLog.development,
+    ...defaultCache.full,
+    ...defaultCache.development,
+    ...defaultAuthorization.full,
+    ...defaultAuthorization.development,
+    ...defaultStream.full,
+    ...defaultStream.development,
+    ...defaultMutex.full,
+    ...defaultMutex.development,
+    ...defaultZipkin.full,
+    ...defaultZipkin.development,
+  },
+  production: {
+    ...defaultApp,
+    ...defaultLog.full,
+    ...defaultLog.production,
+    ...defaultCache.full,
+    ...defaultCache.production,
+    ...defaultAuthorization.full,
+    ...defaultAuthorization.production,
+    ...defaultStream.full,
+    ...defaultStream.production,
+    ...defaultMutex.full,
+    ...defaultMutex.production,
+    ...defaultZipkin.full,
+    ...defaultZipkin.production,
+  },
+};

src/defaultConfigs/log.js

@@ -0,0 +1,28 @@
+module.exports = {
+  full: {
+    LOG_DEBUG_ENABLE: false,
+
+    LOG_STDOUT_ENABLE: true,
+    LOG_STDOUT_LEVEL: 'trace',
+
+    // ring buffer enabled by default
+    LOG_RINGBUFFER_LEVEL: 'info',
+    LOG_RINGBUFFER_LIMIT: 100,
+
+    LOG_TEAMS_ENABLE: false,
+    LOG_TEAMS_LEVEL: 'error',
+    LOG_TEAMS_URL: 'https://outlook.office.com/webhook/ba57dfc.....d117daf812',
+
+    LOG_CLOUDWATCH_ENABLE: false,
+    LOG_CLOUDWATCH_LEVEL: 'error',
+    LOG_CLOUDWATCH_GROUP_NAME: '',
+    LOG_CLOUDWATCH_STREAM_NAME: '',
+  },
+  development: {
+    LOG_STDOUT_ENABLE: false,
+    LOG_RINGBUFFER_LEVEL: 'trace',
+  },
+  production: {
+    LOG_STDOUT_ENABLE: false,
+  },
+};

src/defaultConfigs/mutex.js

@@ -0,0 +1,21 @@
+module.exports = {
+  full: {
+    MUTEX_DRIVER: 'memory',
+    MUTEX_CONNECTION_STRING: '',
+    MUTEX_SSL_ENABLE: false,
+    MUTEX_SSL_REJECT_UNAUTHORIZED: false,
+    MUTEX_SSL_CA_FILE: '',
+    MUTEX_SSL_KEY_FILE: '',
+    MUTEX_SSL_CERT_FILE: '',
+  },
+  development: {
+    MUTEX_DRIVER: 'memory',
+    MUTEX_CONNECTION_STRING: '',
+    MUTEX_SSL_ENABLE: false,
+  },
+  production: {
+    MUTEX_DRIVER: 'memory',
+    MUTEX_CONNECTION_STRING: 'redis://anonymous:redispasshere@localhost:6379/1',
+    MUTEX_SSL_ENABLE: false,
+  },
+};

src/defaultConfigs/stream.js

@@ -0,0 +1,34 @@
+module.exports = {
+  full: {
+    STREAM_DRIVER: 'redis-mock',
+    STREAM_CONNECTION_STRING: 'redis://localhost:6379/1',
+    STREAM_SSL_ENABLE: false,
+    STREAM_SSL_REJECT_UNAUTHORIZED: false,
+    STREAM_SSL_CA_FILE: '',
+    STREAM_SSL_KEY_FILE: '',
+    STREAM_SSL_CERT_FILE: '',
+
+    STREAM_FALLBACK_ENABLE: false,
+    STREAM_FALLBACK_DRIVER: 'redis-mock',
+    STREAM_FALLBACK_CONNECTION_STRING: 'redis://localhost:6379/1',
+    STREAM_FALLBACK_SSL_ENABLE: false,
+    STREAM_FALLBACK_SSL_REJECT_UNAUTHORIZED: false,
+    STREAM_FALLBACK_SSL_CA_FILE: '',
+    STREAM_FALLBACK_SSL_KEY_FILE: '',
+    STREAM_FALLBACK_SSL_CERT_FILE: '',
+  },
+  development: {
+    STREAM_DRIVER: 'redis-mock',
+    STREAM_CONNECTION_STRING: 'redis://localhost:6379/1',
+    STREAM_SSL_ENABLE: false,
+
+    STREAM_FALLBACK_ENABLE: false,
+  },
+  production: {
+    STREAM_DRIVER: 'redis-mock',
+    STREAM_CONNECTION_STRING: 'redis://localhost:6379/1',
+    STREAM_SSL_ENABLE: false,
+
+    STREAM_FALLBACK_ENABLE: false,
+  },
+};

src/defaultConfigs/zipkin.js

@@ -0,0 +1,15 @@
+module.exports = {
+  full: {
+    ZIPKIN_ENABLE: true,
+    ZIPKIN_DRIVER: 'http',
+    ZIPKIN_HTTP_ENDPOINT: 'http://zipkin-service:9411/api/v2/spans',
+  },
+  development: {
+    ZIPKIN_ENABLE: false,
+    ZIPKIN_DRIVER: 'none',
+  },
+  production: {
+    ZIPKIN_ENABLE: false,
+    ZIPKIN_DRIVER: 'none', // mostly not needed to use zipkin, is it?
+  },
+};