feat: Add support for cli options for adapters

Author: relekang

src/db.js

@@ -1,8 +1,9 @@
 const promise = require('promise')
 
-function initDbAdapter(adapterName) {
+function initDbAdapter(options) {
   let adapter
   const repeatCharacter = (char, n) => `${Array(n + 1).join(char)}`
+  const adapterName = options.adapter
 
   try {
     adapter = require(`micro-analytics-adapter-${adapterName}`)
@@ -17,14 +18,17 @@ function initDbAdapter(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

@@ -5,7 +5,7 @@ const db = require('./db');
 
 const flags = parseArgs(process.argv)
 
-db.initDbAdapter(flags.adapter)
+db.initDbAdapter(flags)
 
 const handler = require('./handler')
 const server = micro(handler)

src/parseArgs.js

@@ -1,10 +1,38 @@
-
 const args = require('args');
 
+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 (error) {
+    if (error.code !== "MODULE_NOT_FOUND") {
+      throw error;
+    }
+  }
+
   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,6 +5,8 @@ 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,

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,7 +1,6 @@
 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();
@@ -24,4 +23,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
+  });
 })

tests/sse.test.js

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