Merge pull request #16 from yosimasu/topic/json-packer

Support JSON packer
loopbackio · Nov 16, 2016 · 2803602 · 2803602
2 parents c2b202c + c40fb11
commit 2803602
Show file tree

Hide file tree

Showing 6 changed files with 76 additions and 3 deletions.
diff --git a/lib/kv-redis.js b/lib/kv-redis.js
@@ -9,6 +9,7 @@ var connectorCore = require('loopback-connector');
 var Connector = connectorCore.Connector;
 var ModelKeyComposer = connectorCore.ModelKeyComposer;
 var BinaryPacker = connectorCore.BinaryPacker;
+var JSONStringPacker = connectorCore.JSONStringPacker;
 var debug = require('debug')('loopback:connector:kv-redis');
 var Redis = require('ioredis');
 var util = require('util');
@@ -59,7 +60,11 @@ function RedisKeyValueConnector(settings, dataSource) {
   debug('Connector settings', settings);
 
   this._client = new Redis(settings.url || settings);
-  this._packer = new BinaryPacker();
+  if (settings.packer && settings.packer === 'json') {
+    this._packer = new JSONStringPacker(settings.bufferEncoding);
+  } else {
+    this._packer = new BinaryPacker();
+  }
   this.DataAccessObject = dataSource.juggler.KeyValueAccessObject;
 };
 

diff --git a/package.json b/package.json
@@ -23,7 +23,7 @@
   "dependencies": {
     "debug": "^2.2.0",
     "ioredis": "^2.2.0",
-    "loopback-connector": "^2.6.0",
+    "loopback-connector": "^2.7.1",
     "strong-globalize": "^2.6.6"
   },
   "devDependencies": {

diff --git a/test/helpers/data-source-factory.js b/test/helpers/data-source-factory.js
@@ -42,6 +42,23 @@ createDataSource.failing = function(options) {
   return createDataSource(settings);
 };
 
+createDataSource.json = function(options) {
+  var settings = extend({
+    packer: 'json',
+  }, options);
+
+  return createDataSource(settings);
+};
+
+createDataSource.jsonWithHexBuffers = function(options) {
+  var settings = extend({
+    packer: 'json',
+    bufferEncoding: 'hex',
+  }, options);
+
+  return createDataSource(settings);
+};
+
 beforeEach(function clearDatabase(done) {
   var ds = createDataSource();
   ds.connector.execute('FLUSHDB', function(err) {

diff --git a/test/integration/execute.integration.js b/test/integration/execute.integration.js
@@ -14,5 +14,17 @@ describe('execute', function() {
       done();
     });
   });
+
+  it('returns "INFO keyspace" result as a Buffer w/ json packer',
+    function(done) {
+      var ds = createDataSource.json();
+      ds.connector.execute('INFO', ['keyspace'], function(err, result) {
+        if (err) return done(err);
+        expect(result).to.be.instanceOf(Buffer);
+        result = result.toString('utf8');
+        expect(result).to.match(/^# Keyspace/);
+        done();
+      });
+    });
 });
 
diff --git a/test/integration/juggler-api.integration.js b/test/integration/juggler-api.integration.js
@@ -2,7 +2,18 @@
 
 var createDataSource = require('../helpers/data-source-factory');
 var expect = require('../helpers/expect');
+var kvaoTestSuite = require('loopback-datasource-juggler/test/kvao.suite.js');
 
 describe('Juggler API', function() {
-  require('loopback-datasource-juggler/test/kvao.suite.js')(createDataSource);
+  context('using binary packer', function() {
+    kvaoTestSuite(createDataSource);
+  });
+
+  context('using json-string packer', function() {
+    kvaoTestSuite(createDataSource.json);
+  });
+
+  context('using json-string packer with hex buffers', function() {
+    kvaoTestSuite(createDataSource.jsonWithHexBuffers);
+  });
 });
diff --git a/test/integration/packer.integration.js b/test/integration/packer.integration.js
@@ -0,0 +1,28 @@
+'use strict';
+
+var createDataSource = require('../helpers/data-source-factory');
+var expect = require('../helpers/expect');
+var extend = require('util')._extend;
+
+describe('packer option', function() {
+  it('changes storage format to JSON', function(done) {
+    var ds = createDataSource.json();
+    var value = {
+      name: 'a-string',
+      age: 42,
+      flag: true,
+      date: new Date(),
+    };
+
+    ds.connector.set('TestModel', 'a-key', value, {}, function(err) {
+      if (err) return done(err);
+      ds.connector.execute('GET', ['TestModel:a-key'], function(err, result) {
+        if (err) return done(err);
+        var stored = JSON.parse(result.toString());
+        var expected = JSON.parse(JSON.stringify(value));
+        expect(stored).to.eql(expected);
+        done();
+      });
+    });
+  });
+});