Merge pull request #396 from uProxy/trevj-hexstrings-love

replace arraybuffers hexstring converters with buffer built-ins

Author: trevj

src/arraybuffers/arraybuffers.spec.ts

@@ -2,102 +2,21 @@
 
 import arraybuffers = require('./arraybuffers');
 
-var uint8Array1 = new Uint8Array([12,118,101,114,105,115]);
-var array1 = uint8Array1.buffer;
-var string1 = '\x0C\x76\x65\x72\x69\x73';
-var hexString1 = 'c.76.65.72.69.73';
+const array1 = new Uint8Array([12, 118, 101, 114, 105, 115]).buffer;
+const array2 = new Uint8Array([0, 2, 129, 128, 0, 1, 0, 5, 0]).buffer;
+const array12 = new Uint8Array([12, 118, 101, 114, 105, 115, 0, 2, 129, 128, 0, 1, 0, 5, 0]).buffer;
+const emptyArray = (new Uint8Array([])).buffer;
 
-var uint8Array2 = new Uint8Array([0,2,129,128,0,1,0,5,0]);
-var array2 = uint8Array2.buffer;
-var string2 = '\x00\x02\x81\x80\x00\x01\x00\x05\x00';
-var hexString2 = '0.2.81.80.0.1.0.5.0';
-
-var uint8Array12 = new Uint8Array(
-    [12,118,101,114,105,115,0,2,129,128,0,1,0,5,0]);
-var array12 = uint8Array12.buffer;
-var string12 = string1 + string2;
-
-var emptyArray = (new Uint8Array([])).buffer;
-var emptyString = '';
-var emptyHexString = '';
-
-describe('ArrayBuffers <-> Hex Strings', function() {
-  it('byteEquality: emptyArray == emptyArray', function() {
+describe('arraybuffers', function() {
+  it('byteEquality', function() {
     expect(arraybuffers.byteEquality(emptyArray, emptyArray)).toBe(true);
-  });
-  it('byteEquality: array1 == array1', function() {
     expect(arraybuffers.byteEquality(array1, array1)).toBe(true);
-  });
-  it('byteEquality: array1 != emptyArray', function() {
     expect(arraybuffers.byteEquality(array1, emptyArray)).toBe(false);
-  });
-  it('byteEquality: array1 != array2', function() {
     expect(arraybuffers.byteEquality(array1, array2)).toBe(false);
   });
 
-  it('Empty Buffer -> Empty Hex', function() {
-    expect(arraybuffers.arrayBufferToHexString(emptyArray)).toEqual(emptyHexString);
-  });
-  it('Empty Hex -> Empty Buffer', function() {
-    expect(arraybuffers.byteEquality(arraybuffers.hexStringToArrayBuffer(emptyHexString),
-                                     emptyArray)).toBe(true);
-  });
-
-  it('Buffer -> Hex', function() {
-    expect(arraybuffers.arrayBufferToHexString(emptyArray)).toEqual(emptyString);
-    expect(arraybuffers.arrayBufferToHexString(array1)).toEqual(hexString1);
-    expect(arraybuffers.arrayBufferToHexString(array2)).toEqual(hexString2);
-  });
-
-  it('Hex -> Buffer -> Hex = identity', function() {
-    expect(arraybuffers.arrayBufferToHexString(arraybuffers.hexStringToArrayBuffer(emptyString)))
-        .toEqual(emptyString);
-    expect(arraybuffers.arrayBufferToHexString(arraybuffers.hexStringToArrayBuffer(emptyString)))
-        .not.toEqual(hexString1);
-    expect(arraybuffers.arrayBufferToHexString(arraybuffers.hexStringToArrayBuffer(hexString1)))
-        .toEqual(hexString1);
-    expect(arraybuffers.arrayBufferToHexString(arraybuffers.hexStringToArrayBuffer(hexString2)))
-        .toEqual(hexString2);
-    expect(arraybuffers.arrayBufferToHexString(arraybuffers.hexStringToArrayBuffer(hexString1)))
-        .not.toEqual(hexString2);
-  });
-});
-
-describe('ArrayBuffers chunk', function() {
-  it('chunk(array12, 6).length == 3', function() {
-    expect(arraybuffers.chunk(array12,6).length).toBe(3);
-  });
-  it('chunk(array12, 1).length == 15', function() {
-    expect(arraybuffers.chunk(array12,1).length).toBe(15);
-  });
-});
-
-describe('ArrayBuffers <-> strings', function() {
-  it('Empty Buffer -> Empty Hex', function() {
-    expect(arraybuffers.arrayBufferToHexString(emptyArray)).toEqual(emptyString);
-  });
-  it('Empty Hex -> Empty Buffer', function() {
-    expect(arraybuffers.byteEquality(arraybuffers.hexStringToArrayBuffer(emptyString),
-                                     emptyArray)).toBe(true);
-  });
-
-  it('Buffer -> String', function() {
-    expect(arraybuffers.arrayBufferToHexString(emptyArray)).toEqual(emptyString);
-    expect(arraybuffers.arrayBufferToHexString(array1)).toEqual(hexString1);
-    expect(arraybuffers.arrayBufferToHexString(array1)).not.toEqual(hexString2);
-    expect(arraybuffers.arrayBufferToHexString(array2)).toEqual(hexString2);
-  });
-
-  it('String -> Buffer -> String = identity', function() {
-    expect(arraybuffers.arrayBufferToString(arraybuffers.stringToArrayBuffer(emptyString)))
-        .toEqual(emptyString);
-    expect(arraybuffers.arrayBufferToString(arraybuffers.stringToArrayBuffer(emptyString)))
-        .not.toEqual(hexString1);
-    expect(arraybuffers.arrayBufferToString(arraybuffers.stringToArrayBuffer(string1)))
-        .toEqual(string1);
-    expect(arraybuffers.arrayBufferToString(arraybuffers.stringToArrayBuffer(string2)))
-        .toEqual(string2);
-    expect(arraybuffers.arrayBufferToString(arraybuffers.stringToArrayBuffer(string1)))
-        .not.toEqual(string2);
+  it('chunk', function() {
+    expect(arraybuffers.chunk(array12, 6).length).toBe(3);
+    expect(arraybuffers.chunk(array12, 1).length).toBe(15);
   });
 });

src/arraybuffers/arraybuffers.ts

@@ -53,30 +53,6 @@ export function stringToArrayBuffer(s:string) :ArrayBuffer {
   return buffer;
 }
 
-// Converts an ArrayBuffer to a string of hex codes (of the regexp form
-// /(hh\.)*hh/).
-export function arrayBufferToHexString(buffer:ArrayBuffer) :string {
-  var bytes = new Uint8Array(buffer);
-  var a :string[] = [];
-  for (var i = 0; i < buffer.byteLength; ++i) {
-    a.push(bytes[i].toString(16));
-  }
-  return a.join('.');
-}
-
-// Converts a HexString of the regexp form /(hh\.)*hh/ (where `h` is a
-// hex-character) to an ArrayBuffer.
-export function hexStringToArrayBuffer(hexString:string) :ArrayBuffer {
-  if(hexString === '') { return new ArrayBuffer(0); }
-  var hexChars = hexString.split('.');
-  var buffer = new ArrayBuffer(hexChars.length);
-  var bytes = new Uint8Array(buffer);
-  for (var i = 0; i < hexChars.length; ++i) {
-      bytes[i] = parseInt('0x' + hexChars[i]);
-  }
-  return buffer;
-}
-
 // Returns an ArrayBuffer backed by the same memory as the supplied
 // Node.js Buffer.
 export function bufferToArrayBuffer(buffer: Buffer): ArrayBuffer {

src/echo/freedom-module.ts

@@ -1,6 +1,5 @@
 /// <reference path='../../../third_party/typings/browser.d.ts' />
 
-import arraybuffers = require('../arraybuffers/arraybuffers');
 import logging = require('../logging/logging');
 import loggingTypes = require('../loggingprovider/loggingprovider.types');
 import net = require('../net/net.types');
@@ -16,7 +15,7 @@ var requestedEndpoint: net.Endpoint = {
 
 // Character code for CTRL-D.
 // When received, we close the connection.
-var CTRL_D_HEX_STR_CODE = '4';
+const CTRL_D_CODE = 4;
 
 var loggingController = freedom['loggingcontroller']();
 loggingController.setDefaultFilter(loggingTypes.Destination.console,
@@ -43,7 +42,7 @@ server.listen().then((actualEndpoint) => {
 
     connection.dataFromSocketQueue.setSyncHandler((data:ArrayBuffer): void => {
       log.info('%1: received %2 bytes', id, data.byteLength);
-      if (arraybuffers.arrayBufferToHexString(data) === CTRL_D_HEX_STR_CODE) {
+      if (data.byteLength === 1 && new Uint8Array(data)[0] === CTRL_D_CODE) {
         connection.close();
       } else {
         connection.send(data);

src/transformers/arithmetic.spec.ts

@@ -21,16 +21,16 @@ describe('Arithmetic coding and decoding - short inputs', function() {
   // The encoding input is a simple numerical sequence.
   // The encoding output is taken from a reference implementation.
   it('encoding short input', function() {
-    let plain = arraybuffers.hexStringToArrayBuffer('0.1.2.3');
-    let target = arraybuffers.hexStringToArrayBuffer('ca.0.1.2.3.0.0.0.8');
+    let plain = new Buffer('00010203', 'hex');
+    let target = new Buffer('ca0001020300000008', 'hex');
     let result = encoder.encode(plain);
     expect(arraybuffers.byteEquality(result, target)).toBe(true);
   });
   // The decoding input is taken from the output of the encoding test.
   // The decoding output is taken from the input of the encoding test.
   it('decoding short input', function() {
-    let encoded = arraybuffers.hexStringToArrayBuffer('ca.0.1.2.3.0.0.0.8');
-    let target = arraybuffers.hexStringToArrayBuffer('0.1.2.3');
+    let encoded = new Buffer('ca0001020300000008', 'hex');
+    let target = new Buffer('00010203', 'hex');
     let result = decoder.decode(encoded).slice(0, -2);
     expect(arraybuffers.byteEquality(result, target)).toBe(true);
   });
@@ -45,16 +45,16 @@ describe('Arithmetic coding and decoding - long inputs', function() {
   // The encoding input is an example of a real WebRTC packet.
   // The encoding output is taken from a reference implementation.
   it('encoding long input', function() {
-    let plain = arraybuffers.hexStringToArrayBuffer('0.1.0.5c.21.12.a4.42.48.4e.43.6a.4e.47.54.66.37.31.45.42.0.6.0.21.34.47.4a.39.65.49.69.4d.75.59.55.35.43.38.49.6a.3a.69.7a.72.51.34.77.72.57.66.70.31.6b.57.66.44.64.0.0.0.80.29.0.8.9a.85.cd.95.50.c8.ee.a.0.24.0.4.6e.7e.1e.ff.0.8.0.14.3.45.95.42.22.f0.da.66.3e.8e.b8.cc.79.a1.f7.ba.1.f.d5.0.80.28.0.4.e2.28.43.3');
-    let target = arraybuffers.hexStringToArrayBuffer('ca.0.1.0.5c.21.12.a4.42.48.4e.43.6a.4e.47.54.66.37.31.45.42.0.6.0.21.34.47.4a.39.65.49.69.4d.75.59.55.35.43.38.49.6a.3a.69.7a.72.51.34.77.72.57.66.70.31.6b.57.66.44.64.0.0.0.80.29.0.8.9a.85.cd.95.50.c8.ee.a.0.24.0.4.6e.7e.1e.ff.0.8.0.14.3.45.95.42.22.f0.da.66.3e.8e.b8.cc.79.a1.f7.ba.1.f.d5.0.80.28.0.4.e2.28.43.3.0.0.0.74');
+    let plain = new Buffer('0001005c2112a442484e436a4e475466373145420006002134474a396549694d755955354338496a3a697a7251347772576670316b57664464000000802900089a85cd9550c8ee0a002400046e7e1eff000800140345954222f0da663e8eb8cc79a1f7ba010fd50080280004e2284303', 'hex');
+    let target = new Buffer('ca0001005c2112a442484e436a4e475466373145420006002134474a396549694d755955354338496a3a697a7251347772576670316b57664464000000802900089a85cd9550c8ee0a002400046e7e1eff000800140345954222f0da663e8eb8cc79a1f7ba010fd50080280004e228430300000074', 'hex');
     let encoded = encoder.encode(plain);
     expect(arraybuffers.byteEquality(encoded, target)).toBe(true);
   });
   // The decoding input is taken from the output of the encoding test.
   // The decoding output is taken from the input of the encoding test.
   it('decoding long input', function() {
-    let encoded = arraybuffers.hexStringToArrayBuffer('ca.0.1.0.5c.21.12.a4.42.48.4e.43.6a.4e.47.54.66.37.31.45.42.0.6.0.21.34.47.4a.39.65.49.69.4d.75.59.55.35.43.38.49.6a.3a.69.7a.72.51.34.77.72.57.66.70.31.6b.57.66.44.64.0.0.0.80.29.0.8.9a.85.cd.95.50.c8.ee.a.0.24.0.4.6e.7e.1e.ff.0.8.0.14.3.45.95.42.22.f0.da.66.3e.8e.b8.cc.79.a1.f7.ba.1.f.d5.0.80.28.0.4.e2.28.43.3.0.0.0.74');
-    let target = arraybuffers.hexStringToArrayBuffer('0.1.0.5c.21.12.a4.42.48.4e.43.6a.4e.47.54.66.37.31.45.42.0.6.0.21.34.47.4a.39.65.49.69.4d.75.59.55.35.43.38.49.6a.3a.69.7a.72.51.34.77.72.57.66.70.31.6b.57.66.44.64.0.0.0.80.29.0.8.9a.85.cd.95.50.c8.ee.a.0.24.0.4.6e.7e.1e.ff.0.8.0.14.3.45.95.42.22.f0.da.66.3e.8e.b8.cc.79.a1.f7.ba.1.f.d5.0.80.28.0.4.e2.28.43.3');
+    let encoded = new Buffer('ca0001005c2112a442484e436a4e475466373145420006002134474a396549694d755955354338496a3a697a7251347772576670316b57664464000000802900089a85cd9550c8ee0a002400046e7e1eff000800140345954222f0da663e8eb8cc79a1f7ba010fd50080280004e228430300000074', 'hex');
+    let target = new Buffer('0001005c2112a442484e436a4e475466373145420006002134474a396549694d755955354338496a3a697a7251347772576670316b57664464000000802900089a85cd9550c8ee0a002400046e7e1eff000800140345954222f0da663e8eb8cc79a1f7ba010fd50080280004e2284303', 'hex');
     let decoded = decoder.decode(encoded).slice(0, -2);
     expect(arraybuffers.byteEquality(decoded, target)).toBe(true);
   });

src/transformers/byteSequenceShaper.ts

@@ -49,7 +49,7 @@ export interface SequenceModel {
 // Creates a sample (non-random) config, suitable for testing.
 export var sampleConfig = () : SequenceConfig => {
   var buffer = arraybuffers.stringToArrayBuffer('OH HELLO');
-  var hex = arraybuffers.arrayBufferToHexString(buffer);
+  var hex = new Buffer(buffer).toString('hex');
   var sequence = {
     index: 0,
     offset: 0,
@@ -170,10 +170,10 @@ export class ByteSequenceShaper implements transformer.Transformer {
   // Decode the byte sequence from a string in the sequence model
   static deserializeModel(model :SerializedSequenceModel) :SequenceModel {
     return {
-      index:model.index,
-      offset:model.offset,
-      sequence:arraybuffers.hexStringToArrayBuffer(model.sequence),
-      length:model.length
+      index: model.index,
+      offset: model.offset,
+      sequence: new Buffer(model.sequence, 'hex'),
+      length: model.length
     };
   }
 

src/transformers/defragmenter.ts

@@ -44,7 +44,7 @@ export class Defragmenter {
   //     This fragment a new fragment for a new packet.
   public addFragment(fragment:fragments.Fragment) {
     // Convert ArrayBuffer to hex string so that it can be used as a map key
-    var hexid = arraybuffers.arrayBufferToHexString(fragment.id);
+    var hexid = new Buffer(fragment.id).toString('hex');
 
     if (hexid in this.tracker_) {
       // A fragment for an existing packet

src/transformers/encryptionShaper.ts

@@ -17,10 +17,8 @@ export interface EncryptionConfig {
 
 // Creates a sample (non-random) config, suitable for testing.
 export var sampleConfig = () : EncryptionConfig => {
-  var bytes = new Uint8Array([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
-  var hex = arraybuffers.arrayBufferToHexString(bytes.buffer);
   return {
-    key: hex
+    key: new Buffer(16).fill(0).toString('hex')
   };
 }
 
@@ -38,7 +36,7 @@ export class EncryptionShaper implements transformer.Transformer {
     // Required parameter
     if ('key' in config) {
       var encryptionConfig = <EncryptionConfig>config;
-      this.key_ = arraybuffers.hexStringToArrayBuffer(encryptionConfig.key);
+      this.key_ = new Buffer(encryptionConfig.key, 'hex');
     } else {
       throw new Error('Encryption shaper requires key parameter');
     }