Merge pull request #62 from micro-analytics/feat/add-support-for-adapter-cli-config

Add support for adapter cli config

Author: mxstbr

adapter-tests/unit-tests.js

@@ -43,6 +43,43 @@ module.exports = function testAdapter(options) {
       expect(adapter.put('/a-key', {}).constructor.name).toEqual("Promise")
     })
 
+    if (typeof adapter.options !== "undefined") {
+      test('options should be an array of args options', () => {
+        expect(Array.isArray(adapter.options)).toBe(true)
+        if (adapter.options.length >= 0) {
+          let counter = 0
+          adapter.options.forEach(option => {
+            expect(option.name).toBeDefined()
+            expect(option.description).toBeDefined()
+            counter++
+          })
+
+          // if the forEach somehow breaks the test should break
+          expect(counter).toBe(adapter.options.length)
+        }
+      })
+
+      test('init should be a defined when options is defined', () => {
+        expect(typeof adapter.init).not.toBe("undefined");
+      })
+    } else {
+      test.skip('options should be an array of args options', () => {})
+      test.skip('init should be a defined when options is defined', () => {})
+    }
+
+    if (typeof adapter.init !== "undefined") {
+      test('init should be a function', () => {
+        expect(typeof adapter.init).toBe("function");
+      })
+
+      test('call init should not throw', () => {
+        adapter.init(options.initOptions || {})
+      })
+    } else {
+      test.skip('init should be a function', () => {})
+      test.skip('call init should not throw', () => {})
+    }
+
     it('should save and read', async () => {
       await adapter.put('/a-key', { views: [{ time: 1490623474639 }] });
 
@@ -167,6 +204,9 @@ module.exports = function testAdapter(options) {
           value: { views: [{ time: 1490623474639 }] },
         });
       });
+    } else {
+      it.skip('should allow subscription with observables', () => {})
+      it.skip('should allow multiple subscription with observables and handle unsubscribption', () => {})
     }
   });
 };

package.json

@@ -37,7 +37,7 @@
     "args": "^2.3.0",
     "flat-file-db": "^1.0.0",
     "micro": "6.1.0",
-    "micro-analytics-adapter-flat-file-db": "^1.2.1",
+    "micro-analytics-adapter-flat-file-db": "^1.3.0",
     "promise": "^7.1.1",
     "shelljs": "^0.7.6",
     "sse-channel": "^2.0.6",
@@ -51,6 +51,7 @@
     "babel-polyfill": "^6.20.0",
     "babel-preset-node6": "^11.0.0",
     "jest": "^19.0.2",
+    "micro-analytics-adapter-memory": "^0.1.0",
     "nodemon": "^1.11.0",
     "request-promise": "^4.1.1"
   }

src/db.js

@@ -1,30 +1,21 @@
 const promise = require('promise')
 
-function initDbAdapter(adapterName) {
-  let adapter
-  const repeatCharacter = (char, n) => `${Array(n + 1).join(char)}`
-
-  try {
-    adapter = require(`micro-analytics-adapter-${adapterName}`)
-  } catch (err) {
-    if (err.code === 'MODULE_NOT_FOUND') {
-      // Console.error a warning message, but normally exit the process to avoid printing ugly npm ERR lines and stack trace.
-      console.error(`\n${repeatCharacter(' ', 22)}⚠️ ERROR ⚠️\n${repeatCharacter('-', 55)}\nYou specified "${adapterName}" as the DB_ADAPTER, but no package\ncalled "micro-analytics-adapter-${adapterName}" was found.\n\nPlease make sure you spelled the name correctly and\nhave "npm install"ed the necessary adapter package!\n${repeatCharacter('-', 55)}\n`)
-      process.exit(0)
-    } else {
-      throw err
-    }
-  }
+function initDbAdapter(options) {
+  const adapterName = options.adapter
+  const adapter = require(`micro-analytics-adapter-${adapterName}`)
 
 
-  module.exports.get = adapter.get;
-  module.exports.getAll = adapter.getAll;
-  module.exports.put = adapter.put;
-  module.exports.has = adapter.has;
-  module.exports.keys = adapter.keys;
-  module.exports.subscribe = adapter.subscribe;
-  module.exports.hasFeature = (feature) => typeof adapter[feature] === "function";
+  module.exports.get = adapter.get
+  module.exports.getAll = adapter.getAll
+  module.exports.put = adapter.put
+  module.exports.has = adapter.has
+  module.exports.keys = adapter.keys
+  module.exports.subscribe = adapter.subscribe
+  module.exports.hasFeature = (feature) => typeof adapter[feature] === "function"
 
+  if (module.exports.hasFeature('init')) {
+    adapter.init(options)
+  }
 }
 
 module.exports = {

src/index.js

@@ -3,22 +3,26 @@ const micro = require('micro')
 const parseArgs = require('./parseArgs')
 const db = require('./db');
 
-const flags = parseArgs(process.argv)
+try {
+  const flags = parseArgs(process.argv)
 
-db.initDbAdapter(flags.adapter)
+  db.initDbAdapter(flags)
 
-const handler = require('./handler')
-const server = micro(handler)
+  const handler = require('./handler')
+  const server = micro(handler)
 
-server.listen(flags.port, flags.host, (error) => {
-  if (error) {
-    console.error(error)
-    process.exit(1)
-  }
-
-  console.log(
-    'micro-analytics listening on ' + flags.host + ':' + flags.port + '\n' +
-    '  with adapter ' + flags.adapter +
-    (db.hasFeature("subscribe") ? '\n  with server side events' : '')
-  )
-})
+  server.listen(flags.port, flags.host, (error) => {
+    if (error) {
+      console.error(error)
+      process.exit(1)
+    }
+    console.log(
+      'micro-analytics listening on ' + flags.host + ':' + flags.port + '\n' +
+      '  with adapter ' + flags.adapter +
+      (db.hasFeature("subscribe") ? '\n  with server side events' : '')
+    )
+  })
+} catch (error) {
+  console.error(error.message)
+  process.exit(1)
+}

src/parseArgs.js

@@ -1,10 +1,42 @@
-
 const args = require('args');
 
+const repeatCharacter = (char, n) => `${Array(n + 1).join(char)}`
+
+function adapterNameFromArgs(argv) {
+  for (let i = 0; i < argv.length; i++) {
+    const arg = argv[i]
+    if (arg === '-a' || arg === '--adapter') {
+      return argv[i + 1]
+    }
+    if (/--adapter=/.test(arg)) {
+      return arg.split('=')[1]
+    }
+  }
+
+  return process.env.DB_ADAPTER || 'flat-file-db'
+}
+
 module.exports = function parseArgs(argv) {
+  const adapterName = adapterNameFromArgs(argv);
+  let options = []
+
+  try {
+    const adapter =  require(`micro-analytics-adapter-${adapterName}`)
+    if (adapter.options) {
+      options = adapter.options
+    }
+  } catch (err) {
+    if (err.code === 'MODULE_NOT_FOUND') {
+      throw new Error(`\n${repeatCharacter(' ', 22)}⚠️ ERROR ⚠️\n${repeatCharacter('-', 55)}\nYou specified "${adapterName}" as the DB_ADAPTER, but no package\ncalled "micro-analytics-adapter-${adapterName}" was found.\n\nPlease make sure you spelled the name correctly and\nhave "npm install"ed the necessary adapter package!\n${repeatCharacter('-', 55)}\n`)
+    } else {
+      throw err
+    }
+  }
+
   return args
     .option(['p', 'port'], 'Port to listen on', process.env.PORT || 3000, Number)
     .option(['H', 'host'], 'Host to listen on', process.env.HOST ||'0.0.0.0')
     .option(['a', 'adapter'], 'Database adapter used', process.env.DB_ADAPTER || 'flat-file-db')
+    .options(options)
     .parse(argv, { name: 'micro-analytics' })
 }

tests/__snapshots__/parseArgs.test.js.snap

@@ -5,8 +5,23 @@ Object {
   "H": "0.0.0.0",
   "a": "flat-file-db",
   "adapter": "flat-file-db",
+  "d": "views.db",
+  "dbName": "views.db",
   "host": "0.0.0.0",
   "p": 3000,
   "port": 3000,
 }
 `;
+
+exports[`parseArgs should throw on non existing adapter 1`] = `
+"
+                      ⚠️ ERROR ⚠️
+-------------------------------------------------------
+You specified \\"not-a-real-adapter\\" as the DB_ADAPTER, but no package
+called \\"micro-analytics-adapter-not-a-real-adapter\\" was found.
+
+Please make sure you spelled the name correctly and
+have \\"npm install\\"ed the necessary adapter package!
+-------------------------------------------------------
+"
+`;

tests/atomicity.test.js

@@ -6,7 +6,9 @@ const db = require('../src/db')
 const service = require('../src/handler')
 let url
 
-db.initDbAdapter('flat-file-db');
+beforeAll(() => {
+  db.initDbAdapter({ adapter: 'flat-file-db' });
+})
 
 beforeEach(async () => {
   url = await listen(service)

tests/errors.test.js

@@ -5,7 +5,9 @@ const service = require('../src/handler')
 const db = require('../src/db')
 let url
 
-db.initDbAdapter('flat-file-db');
+beforeAll(() => {
+  db.initDbAdapter({ adapter: 'flat-file-db' });
+})
 
 beforeEach(async () => {
   url = await listen(service)

tests/items.test.js

@@ -6,7 +6,9 @@ const db = require('../src/db')
 const service = require('../src/handler')
 let url
 
-db.initDbAdapter('flat-file-db');
+beforeAll(() => {
+  db.initDbAdapter({ adapter: 'flat-file-db' });
+})
 
 beforeEach(async () => {
   mockDb._reset()

tests/parseArgs.test.js

@@ -1,15 +1,20 @@
 jest.mock('pkginfo', () => () => ({version: '1.0.0'}))
 const parseArgs = require('../src/parseArgs')
 
-
 describe('parseArgs', () => {
   it("should have correct defaults", () => {
     expect(parseArgs(['node', 'micro-analytics'])).toMatchSnapshot();
   })
 
+  it('should throw on non existing adapter', () => {
+    expect(() => {
+      parseArgs(['node', 'micro-analytics', '-a', 'not-a-real-adapter'])
+    }).toThrowErrorMatchingSnapshot()
+  });
+
   it("should use DB_ADAPTER environment variable as default if set", () => {
-    process.env.DB_ADAPTER = 'redis'
-    expect(parseArgs(['node', 'micro-analytics']).adapter).toEqual('redis');
+    process.env.DB_ADAPTER = 'memory'
+    expect(parseArgs(['node', 'micro-analytics']).adapter).toEqual('memory');
     delete process.env.DB_ADAPTER
   })
 
@@ -24,4 +29,25 @@ describe('parseArgs', () => {
     expect(parseArgs(['node', 'micro-analytics']).host).toEqual('localhost');
     delete process.env.HOST
   })
+
+  it('should use get adapter option when using -a', () => {
+    process.env.DB_ADAPTER = 'redis'
+    const args = ['node', 'micro-analytics', '-a', 'flat-file-db']
+    expect(Object.keys(parseArgs(args))).toContain('dbName');
+    delete process.env.DB_ADAPTER
+  });
+
+  it('should use get adapter option when using --adapter', () => {
+    process.env.DB_ADAPTER = 'redis'
+    const args = ['node', 'micro-analytics', '--adapter', 'flat-file-db']
+    expect(Object.keys(parseArgs(args))).toContain('dbName');
+    delete process.env.DB_ADAPTER
+  });
+
+  it('should use get adapter option when using --adapter=', () => {
+    process.env.DB_ADAPTER = 'redis'
+    const args = ['node', 'micro-analytics', '--adapter=flat-file-db']
+    expect(Object.keys(parseArgs(args))).toContain('dbName');
+    delete process.env.DB_ADAPTER
+  });
 })