Option to store buffer data #5

avitale · 2014-06-17T21:55:11Z

This pull request adds the option to store buffer data in catbox-memory.
With this option catbox-memory can be used to store pre-compressed data (ex gzip).


        Added buffer options

arb · 2014-08-20T14:12:56Z

Need to rebase against master. Also you should probably update the README explaining this new option.

arb · 2014-09-04T18:48:29Z

Ping @avitale. This PR is out of date and we haven't heard anything from you in quite a while.

geek · 2014-09-05T02:30:35Z

lib/index.js

-    }
-    catch (err) {
-        return callback(err);
+    if(this.settings.buffer){


if (this.settings.buffer) {

geek · 2014-09-05T02:30:48Z

lib/index.js

+    if(this.settings.buffer){
+        if (Buffer.isBuffer(value)) {
+            stringifiedValue = value;
+        } else {


else on new line

avitale · 2014-09-05T07:38:01Z

Hi @arb, if you are interested in merging this pull request I can look into it again

cjihrig · 2014-09-05T19:15:36Z

@avitale yes, please resolve the merge conflicts.

cjihrig · 2014-09-05T19:21:05Z

lib/index.js

-    }
-    catch (err) {
-        return callback(new Error('Bad value content'));
+    if(this.settings.buffer){


Please add a space before ( and after )

cjihrig · 2014-09-05T19:21:21Z

lib/index.js

-        return callback(new Error('Bad value content'));
+    if(this.settings.buffer){
+        value = envelope.item;
+    } else {


else on new line

cjihrig · 2014-09-05T19:36:59Z

README.md

@@ -10,4 +10,4 @@ Memory adapter for catbox
  cached. Once this limit is reached no additional items will be added to the cache
  until some expire. The utilized memory calculation is a rough approximation and must
  not be relied on. Defaults to `104857600` (100MB).
-
+- `buffer` - store Buffer data, values are not stringified and parsed. Defaults to `false`.


Could you add a sentence mentioning that storing a Buffer means that the contents could change while in cache.

cjihrig · 2014-09-05T19:38:29Z

test/index.js

@@ -73,6 +73,42 @@ describe('Memory', function () {
        });
    });

+    it('gets a buffer item after setting it', function (done) {
+
+        var buffer = new Buffer("I'm a string!", "utf-8");


Please use single quotes throughout the code.

cjihrig · 2014-09-05T19:39:29Z

test/index.js

+
+        var buffer = new Buffer("I'm a string!", "utf-8");
+
+        var client = new Catbox.Client(new Memory({buffer: true}));


No blank line before this. Add a blank line after. Add a space after { and before }

cjihrig · 2014-09-05T19:39:53Z

test/index.js

+        var client = new Catbox.Client(new Memory({buffer: true}));
+        client.start(function (err) {
+
+            var key = { id: 'x', segment: 'test' };


Blank line following this one.

cjihrig · 2014-09-05T19:41:46Z

test/index.js

+
+    it('fails setting a non buffer when expecting a buffer', function (done) {
+
+        var client = new Catbox.Client(new Memory({buffer: true}));


New line following this. Spaces around curly braces.

cjihrig · 2014-09-05T19:42:32Z

test/index.js

+        var client = new Catbox.Client(new Memory({buffer: true}));
+        client.start(function (err) {
+
+            var key = { id: 'x', segment: 'test' };


Please add a new line.

cjihrig · 2014-09-05T19:42:44Z

test/index.js

+        client.start(function (err) {
+
+            var key = { id: 'x', segment: 'test' };
+            client.set(key, "I'm a string!", 500, function (err) {


Please use single quotes.

cjihrig · 2014-09-05T19:43:00Z

test/index.js

+
+            var key = { id: 'x', segment: 'test' };
+            client.set(key, "I'm a string!", 500, function (err) {
+                expect(err.message).to.equal('Value is not a Buffer');


Blank line at the beginning of a new function.

cjihrig · 2014-09-05T19:51:10Z

This is good, but I think it would be better to support a mix of Buffers and stringified objects.

avitale · 2014-09-06T16:51:47Z

Supporting a mix would be great. I am wondering if we can do it in catbox-memory or catbox API has to be changed as well. Any opinion about it?

cjihrig · 2014-09-08T15:57:43Z

I was thinking you could add a flag allowMixedContent. If it's set to true (default is false) and a Buffer instance is passed in, then use the implementation you've built. Otherwise, use the existing JSON.stringify() approach.


        Refactored Buffer support

avitale · 2014-09-08T16:36:44Z

I have improved the code, now it supports mixed content. I haven't yet added the allowMixedContent flag, what is it's purpose? Do you think that storing buffers properly breaks backward compatibility?

cjihrig · 2014-09-08T16:58:06Z

Yes, it can when you store a Buffer. First, you are storing a reference to the original object, instead of a stringified copy, meaning that existing code could be modifying the cached value directly. Second, retrieving an item could now return a Buffer instead of the result of JSON.parse(). By using a flag, you're explicitly opting into this different behavior.


        Added allowMixedContent flag and Buffer copy before storing

avitale · 2014-09-09T08:14:20Z

Thanks for the useful comments, I have added the allowMixedContent and changed the code so that buffers are copied before storing, this way the behavior is consistent and predictable.

cjihrig · 2014-09-09T15:39:26Z

@avitale thanks - opened #15 with your commits and a little cleanup

Added buffer options

Loading status checks…

99c9cb3

geek added the enhancement label Sep 5, 2014

geek reviewed Sep 5, 2014
View changes

lib/index.js Outdated

}

catch (err) {

return callback(err);

if(this.settings.buffer){

This comment has been minimized.

Sign in to view

Copy link

geek Sep 5, 2014
Member

if (this.settings.buffer) {

geek reviewed Sep 5, 2014
View changes

lib/index.js Outdated

if(this.settings.buffer){

if (Buffer.isBuffer(value)) {

stringifiedValue = value;

} else {

This comment has been minimized.

Sign in to view

Copy link

geek Sep 5, 2014
Member

else on new line