mirror of https://github.com/grpc/grpc.git
Merge pull request #3012 from murgatroid99/node_metadata_class
Replace metadata objects with a Metadata classpull/3108/head^2
Tim Emiola
9 years ago
commit
956e411e31
8 changed files with 511 additions and 97 deletions
@ -0,0 +1,181 @@ |
||||
/* |
||||
* |
||||
* Copyright 2015, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
/** |
||||
* Metadata module |
||||
* @module |
||||
*/ |
||||
|
||||
'use strict'; |
||||
|
||||
var _ = require('lodash'); |
||||
|
||||
/** |
||||
* Class for storing metadata. Keys are normalized to lowercase ASCII. |
||||
* @constructor |
||||
*/ |
||||
function Metadata() { |
||||
this._internal_repr = {}; |
||||
} |
||||
|
||||
function normalizeKey(key) { |
||||
if (!(/^[A-Za-z\d_-]+$/.test(key))) { |
||||
throw new Error('Metadata keys must be nonempty strings containing only ' + |
||||
'alphanumeric characters and hyphens'); |
||||
} |
||||
return key.toLowerCase(); |
||||
} |
||||
|
||||
function validate(key, value) { |
||||
if (_.endsWith(key, '-bin')) { |
||||
if (!(value instanceof Buffer)) { |
||||
throw new Error('keys that end with \'-bin\' must have Buffer values'); |
||||
} |
||||
} else { |
||||
if (!_.isString(value)) { |
||||
throw new Error( |
||||
'keys that don\'t end with \'-bin\' must have String values'); |
||||
} |
||||
if (!(/^[\x20-\x7E]*$/.test(value))) { |
||||
throw new Error('Metadata string values can only contain printable ' + |
||||
'ASCII characters and space'); |
||||
} |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Sets the given value for the given key, replacing any other values associated |
||||
* with that key. Normalizes the key. |
||||
* @param {String} key The key to set |
||||
* @param {String|Buffer} value The value to set. Must be a buffer if and only |
||||
* if the normalized key ends with '-bin' |
||||
*/ |
||||
Metadata.prototype.set = function(key, value) { |
||||
key = normalizeKey(key); |
||||
validate(key, value); |
||||
this._internal_repr[key] = [value]; |
||||
}; |
||||
|
||||
/** |
||||
* Adds the given value for the given key. Normalizes the key. |
||||
* @param {String} key The key to add to. |
||||
* @param {String|Buffer} value The value to add. Must be a buffer if and only |
||||
* if the normalized key ends with '-bin' |
||||
*/ |
||||
Metadata.prototype.add = function(key, value) { |
||||
key = normalizeKey(key); |
||||
validate(key, value); |
||||
if (!this._internal_repr[key]) { |
||||
this._internal_repr[key] = []; |
||||
} |
||||
this._internal_repr[key].push(value); |
||||
}; |
||||
|
||||
/** |
||||
* Remove the given key and any associated values. Normalizes the key. |
||||
* @param {String} key The key to remove |
||||
*/ |
||||
Metadata.prototype.remove = function(key) { |
||||
key = normalizeKey(key); |
||||
if (Object.prototype.hasOwnProperty.call(this._internal_repr, key)) { |
||||
delete this._internal_repr[key]; |
||||
} |
||||
}; |
||||
|
||||
/** |
||||
* Gets a list of all values associated with the key. Normalizes the key. |
||||
* @param {String} key The key to get |
||||
* @return {Array.<String|Buffer>} The values associated with that key |
||||
*/ |
||||
Metadata.prototype.get = function(key) { |
||||
key = normalizeKey(key); |
||||
if (Object.prototype.hasOwnProperty.call(this._internal_repr, key)) { |
||||
return this._internal_repr[key]; |
||||
} else { |
||||
return []; |
||||
} |
||||
}; |
||||
|
||||
/** |
||||
* Get a map of each key to a single associated value. This reflects the most |
||||
* common way that people will want to see metadata. |
||||
* @return {Object.<String,String|Buffer>} A key/value mapping of the metadata |
||||
*/ |
||||
Metadata.prototype.getMap = function() { |
||||
var result = {}; |
||||
_.forOwn(this._internal_repr, function(values, key) { |
||||
if(values.length > 0) { |
||||
result[key] = values[0]; |
||||
} |
||||
}); |
||||
return result; |
||||
}; |
||||
|
||||
/** |
||||
* Clone the metadata object. |
||||
* @return {Metadata} The new cloned object |
||||
*/ |
||||
Metadata.prototype.clone = function() { |
||||
var copy = new Metadata(); |
||||
_.forOwn(this._internal_repr, function(value, key) { |
||||
copy._internal_repr[key] = _.clone(value); |
||||
}); |
||||
return copy; |
||||
}; |
||||
|
||||
/** |
||||
* Gets the metadata in the format used by interal code. Intended for internal |
||||
* use only. API stability is not guaranteed. |
||||
* @private |
||||
* @return {Object.<String, Array.<String|Buffer>>} The metadata |
||||
*/ |
||||
Metadata.prototype._getCoreRepresentation = function() { |
||||
return this._internal_repr; |
||||
}; |
||||
|
||||
/** |
||||
* Creates a Metadata object from a metadata map in the internal format. |
||||
* Intended for internal use only. API stability is not guaranteed. |
||||
* @private |
||||
* @param {Object.<String, Array.<String|Buffer>>} The metadata |
||||
* @return {Metadata} The new Metadata object |
||||
*/ |
||||
Metadata._fromCoreRepresentation = function(metadata) { |
||||
var newMetadata = new Metadata(); |
||||
if (metadata) { |
||||
newMetadata._internal_repr = _.cloneDeep(metadata); |
||||
} |
||||
return newMetadata; |
||||
}; |
||||
|
||||
module.exports = Metadata; |
||||
@ -0,0 +1,193 @@ |
||||
/* |
||||
* |
||||
* Copyright 2015, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
'use strict'; |
||||
|
||||
var Metadata = require('../src/metadata.js'); |
||||
|
||||
var assert = require('assert'); |
||||
|
||||
describe('Metadata', function() { |
||||
var metadata; |
||||
beforeEach(function() { |
||||
metadata = new Metadata(); |
||||
}); |
||||
describe('#set', function() { |
||||
it('Only accepts string values for non "-bin" keys', function() { |
||||
assert.throws(function() { |
||||
metadata.set('key', new Buffer('value')); |
||||
}); |
||||
assert.doesNotThrow(function() { |
||||
metadata.set('key', 'value'); |
||||
}); |
||||
}); |
||||
it('Only accepts Buffer values for "-bin" keys', function() { |
||||
assert.throws(function() { |
||||
metadata.set('key-bin', 'value'); |
||||
}); |
||||
assert.doesNotThrow(function() { |
||||
metadata.set('key-bin', new Buffer('value')); |
||||
}); |
||||
}); |
||||
it('Rejects invalid keys', function() { |
||||
assert.throws(function() { |
||||
metadata.set('key$', 'value'); |
||||
}); |
||||
assert.throws(function() { |
||||
metadata.set('', 'value'); |
||||
}); |
||||
}); |
||||
it('Rejects values with non-ASCII characters', function() { |
||||
assert.throws(function() { |
||||
metadata.set('key', 'résumé'); |
||||
}); |
||||
}); |
||||
it('Saves values that can be retrieved', function() { |
||||
metadata.set('key', 'value'); |
||||
assert.deepEqual(metadata.get('key'), ['value']); |
||||
}); |
||||
it('Overwrites previous values', function() { |
||||
metadata.set('key', 'value1'); |
||||
metadata.set('key', 'value2'); |
||||
assert.deepEqual(metadata.get('key'), ['value2']); |
||||
}); |
||||
it('Normalizes keys', function() { |
||||
metadata.set('Key', 'value1'); |
||||
assert.deepEqual(metadata.get('key'), ['value1']); |
||||
metadata.set('KEY', 'value2'); |
||||
assert.deepEqual(metadata.get('key'), ['value2']); |
||||
}); |
||||
}); |
||||
describe('#add', function() { |
||||
it('Only accepts string values for non "-bin" keys', function() { |
||||
assert.throws(function() { |
||||
metadata.add('key', new Buffer('value')); |
||||
}); |
||||
assert.doesNotThrow(function() { |
||||
metadata.add('key', 'value'); |
||||
}); |
||||
}); |
||||
it('Only accepts Buffer values for "-bin" keys', function() { |
||||
assert.throws(function() { |
||||
metadata.add('key-bin', 'value'); |
||||
}); |
||||
assert.doesNotThrow(function() { |
||||
metadata.add('key-bin', new Buffer('value')); |
||||
}); |
||||
}); |
||||
it('Rejects invalid keys', function() { |
||||
assert.throws(function() { |
||||
metadata.add('key$', 'value'); |
||||
}); |
||||
assert.throws(function() { |
||||
metadata.add('', 'value'); |
||||
}); |
||||
}); |
||||
it('Saves values that can be retrieved', function() { |
||||
metadata.add('key', 'value'); |
||||
assert.deepEqual(metadata.get('key'), ['value']); |
||||
}); |
||||
it('Combines with previous values', function() { |
||||
metadata.add('key', 'value1'); |
||||
metadata.add('key', 'value2'); |
||||
assert.deepEqual(metadata.get('key'), ['value1', 'value2']); |
||||
}); |
||||
it('Normalizes keys', function() { |
||||
metadata.add('Key', 'value1'); |
||||
assert.deepEqual(metadata.get('key'), ['value1']); |
||||
metadata.add('KEY', 'value2'); |
||||
assert.deepEqual(metadata.get('key'), ['value1', 'value2']); |
||||
}); |
||||
}); |
||||
describe('#remove', function() { |
||||
it('clears values from a key', function() { |
||||
metadata.add('key', 'value'); |
||||
metadata.remove('key'); |
||||
assert.deepEqual(metadata.get('key'), []); |
||||
}); |
||||
it('Normalizes keys', function() { |
||||
metadata.add('key', 'value'); |
||||
metadata.remove('KEY'); |
||||
assert.deepEqual(metadata.get('key'), []); |
||||
}); |
||||
}); |
||||
describe('#get', function() { |
||||
beforeEach(function() { |
||||
metadata.add('key', 'value1'); |
||||
metadata.add('key', 'value2'); |
||||
metadata.add('key-bin', new Buffer('value')); |
||||
}); |
||||
it('gets all values associated with a key', function() { |
||||
assert.deepEqual(metadata.get('key'), ['value1', 'value2']); |
||||
}); |
||||
it('Normalizes keys', function() { |
||||
assert.deepEqual(metadata.get('KEY'), ['value1', 'value2']); |
||||
}); |
||||
it('returns an empty list for non-existent keys', function() { |
||||
assert.deepEqual(metadata.get('non-existent-key'), []); |
||||
}); |
||||
it('returns Buffers for "-bin" keys', function() { |
||||
assert(metadata.get('key-bin')[0] instanceof Buffer); |
||||
}); |
||||
}); |
||||
describe('#getMap', function() { |
||||
it('gets a map of keys to values', function() { |
||||
metadata.add('key1', 'value1'); |
||||
metadata.add('Key2', 'value2'); |
||||
metadata.add('KEY3', 'value3'); |
||||
assert.deepEqual(metadata.getMap(), |
||||
{key1: 'value1', |
||||
key2: 'value2', |
||||
key3: 'value3'}); |
||||
}); |
||||
}); |
||||
describe('#clone', function() { |
||||
it('retains values from the original', function() { |
||||
metadata.add('key', 'value'); |
||||
var copy = metadata.clone(); |
||||
assert.deepEqual(copy.get('key'), ['value']); |
||||
}); |
||||
it('Does not see newly added values', function() { |
||||
metadata.add('key', 'value1'); |
||||
var copy = metadata.clone(); |
||||
metadata.add('key', 'value2'); |
||||
assert.deepEqual(copy.get('key'), ['value1']); |
||||
}); |
||||
it('Does not add new values to the original', function() { |
||||
metadata.add('key', 'value1'); |
||||
var copy = metadata.clone(); |
||||
copy.add('key', 'value2'); |
||||
assert.deepEqual(metadata.get('key'), ['value1']); |
||||
}); |
||||
}); |
||||
}); |
||||
Loading…
Reference in new issue