Merge pull request #18 from lujiajing1126/buffer

Add Buffer for `hex` and backslash support

.circleci/config.yml

@@ -0,0 +1,81 @@
+# Javascript Node CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-javascript/ for more details
+#
+version: 2.1
+
+commands:
+  test-nodejs:
+    steps:
+      - run:
+          name: Versions
+          command: npm version
+      - checkout
+      - restore_cache:
+          keys:
+            - v{{ .Environment.CIRCLE_CACHE_VERSION }}-{{ arch }}-npm-cache-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}
+            - v{{ .Environment.CIRCLE_CACHE_VERSION }}-{{ arch }}-npm-cache-master-{{ .Environment.CIRCLE_JOB }}
+      - run:
+          name: Install dependencies
+          command: npm ci
+      - run:
+          name: Test
+          command: npm test
+      - save-npm-cache
+  test-nodejs-v6:
+    steps:
+      - run:
+          name: Versions
+          command: npm version
+      - checkout
+      - restore_cache:
+          keys:
+            - v{{ .Environment.CIRCLE_CACHE_VERSION }}-{{ arch }}-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}
+            - v{{ .Environment.CIRCLE_CACHE_VERSION }}-{{ arch }}-npm-lock-master-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}
+            - v{{ .Environment.CIRCLE_CACHE_VERSION }}-{{ arch }}-npm-cache-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}
+            - v{{ .Environment.CIRCLE_CACHE_VERSION }}-{{ arch }}-npm-cache-master-{{ .Environment.CIRCLE_JOB }}
+      - run:
+          name: Install dependencies
+          command: npm install
+      - run:
+          name: Test
+          command: npm test
+      - save-npm-lock
+      - save-npm-cache
+  save-npm-lock:
+    steps:
+      - save_cache:
+          key: v{{ .Environment.CIRCLE_CACHE_VERSION }}-{{ arch }}-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}
+          paths:
+            - node_modules
+  save-npm-cache:
+    steps:
+      - save_cache:
+          key: v{{ .Environment.CIRCLE_CACHE_VERSION }}-{{ arch }}-npm-cache-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}
+          paths:
+            - ~/.npm/_cacache
+
+
+jobs:
+  node-v6:
+    docker:
+      - image: node:6
+    steps:
+      - test-nodejs-v6
+  node-v8:
+    docker:
+      - image: node:8
+    steps:
+      - test-nodejs
+  node-v10:
+    docker:
+      - image: node:10
+    steps:
+      - test-nodejs
+
+workflows:
+  node-multi-build:
+    jobs:
+      - node-v6
+      - node-v8
+      - node-v10

jest.config.js

@@ -0,0 +1,180 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after the first failure
+  // bail: false,
+
+  // Respect "browser" field in package.json when resolving modules
+  // browser: false,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/var/folders/g1/ywnkhng14jb_jjrccf_fnsph0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: null,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: null,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files usin a array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: null,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: null,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "json",
+  //   "jsx",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "always",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: null,
+
+  // Run tests from one or more projects
+  // projects: null,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: null,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: null,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // The path to a module that runs some code to configure or set up the testing framework before each test
+  // setupTestFrameworkScriptFile: null,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.js?(x)",
+  //   "**/?(*.)+(spec|test).js?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern Jest uses to detect test files
+  // testRegex: "",
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: null,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: null,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: null,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

lib/buf.js

@@ -0,0 +1,30 @@
+const BACK_SLASH = 0x5C;
+
+class InputBuffer {
+    constructor(input) {
+        this._buf = input instanceof Buffer ? input : Buffer.from(input);
+        this._replace();
+    }
+
+    _replace() {
+        if (!this._buf.includes(BACK_SLASH)) {
+            return;
+        }
+        let len = this._buf.length;
+        for (let i = 0; i < len; i++) {
+            if (this._buf[i] === BACK_SLASH && this._buf[i + 1] === BACK_SLASH) {
+                this._buf = Buffer.concat([this._buf.slice(0, i), this._buf.slice(i + 1)]);
+                len -= 1;
+            }
+        }
+    }
+
+    toString() {
+        let ret = this._buf.toString().replace(/\\x([a-zA-Z\d]{2})/gi, (match, grp) => {
+            return String.fromCodePoint(parseInt(grp, 16));
+        });
+        return ret;
+    }
+}
+
+module.exports = InputBuffer;

lib/buf.test.js

@@ -0,0 +1,36 @@
+const InputBuffer = require('./buf');
+
+test('string without backslash', () => {
+    let buf = new InputBuffer("abc");
+    expect(buf.toString()).toBe("abc");
+});
+
+test('string with single backslash', () => {
+    let buf = new InputBuffer([0x5c, 0x61, 0x62, 0x63]);
+    const ret_buf = Buffer.from([0x5c, 0x61, 0x62, 0x63]);
+    expect(buf.toString()).toBe(ret_buf.toString('ascii'));
+});
+
+test('string with double backslash', () => {
+    let buf = new InputBuffer([0x5c, 0x5c, 0x61, 0x62, 0x63]);
+    const ret_buf = Buffer.from([0x5c, 0x61, 0x62, 0x63]);
+    expect(buf.toString()).toBe(ret_buf.toString('ascii'));
+});
+
+test('string with triple backslash', () => {
+    let buf = new InputBuffer([0x5c, 0x5c, 0x5c, 0x61, 0x62, 0x63]);
+    const ret_buf = Buffer.from([0x5c, 0x5c, 0x61, 0x62, 0x63]);
+    expect(buf.toString()).toBe(ret_buf.toString('ascii'));
+});
+
+test('string with quartic backslash', () => {
+    let buf = new InputBuffer([0x5c, 0x5c, 0x5c, 0x5c, 0x61, 0x62, 0x63]);
+    const ret_buf = Buffer.from([0x5c, 0x5c, 0x61, 0x62, 0x63]);
+    expect(buf.toString()).toBe(ret_buf.toString('ascii'));
+});
+
+test('string with backslash-x hex unicode', () => {
+    let buf = new InputBuffer("\\xfe");
+    const ret_buf = Buffer.from([0xc3, 0xbe]);
+    expect(Buffer.from(buf.toString()).compare(ret_buf)).toBe(0);
+});

lib/redis.js

@@ -4,6 +4,7 @@ const Promise = require('bluebird');
 const util = require('util');
 const splitargs = require('splitargs');
 const colors = require('colors');
+const InputBuffer = require('./buf');
 
 class RedisClient {
 	constructor(host, port, auth) {
@@ -49,16 +50,16 @@ class RedisClient {
 			commands = [CMD, commands];
 		}
 		return func.bind(this._redis_client)(...commands)
-			.then(function (result) {
+			.then((result) => {
 				if (Array.isArray(result)) {
 					result.forEach((item, index) => {
-						console.log("%d) %s", index+1, item);
+						console.log("%d) %s", index + 1, item);
 					});
-				} else if(typeof result === 'object') {
+				} else if (typeof result === 'object') {
 					let count = 1;
 					for (let key of Object.keys(result)) {
 						console.log("%d) %s", count, key);
-						console.log("%d) %s", count+1, result[key]);
+						console.log("%d) %s", count + 1, result[key]);
 						count += 2;
 					}
 				} else {
@@ -82,6 +83,7 @@ class RedisClient {
 			rl.prompt();
 
 			rl.on('line', async (line) => {
+				line = new InputBuffer(line).toString();
 				try {
 					let command = line.trim();
 					let commands = splitargs(command);
@@ -115,4 +117,4 @@ class RedisClient {
 	}
 }
 
-exports.RedisClient = RedisClient
+exports.RedisClient = RedisClient