Merge branch 'dev'

latel · latel · commit 65af825f5262 · 2016-11-22T00:35:39.000+08:00
diff --git a/README.md b/README.md
@@ -100,7 +100,15 @@ sdkLog.critical('system.vanish', {
 });
 ```
 
-### 5. 上传日志
+### 5. 读取日志
+
+``` javascript
+Logline.getAll(function(logs) {
+    // process logs here
+});
+```
+
+### 6. 上传日志(deprecated)
 
 ``` javascript
 Logline.deploy(
@@ -117,6 +125,19 @@ Logline.deploy(
 );
 ```
 
+自定义构建
+--------
+目前Logline一共实现了`localStorage`、`websql`和`indexedDB`三个日志协议，默认是全部打包，可能你只想使用其中某个协议而已，你可以通过`npm run configure`来自定义构建你需要的版本。这样有利于减小包的大小。
+
+``` shell
+// 配置你需要的协议，去掉不需要的协议申明--with-xxx
+// 注意大小写
+npm run configure -- --with-localStorage --with-websql --with-indexedDB
+// 重新打包
+npm run build
+// 去dist目录寻找新构建的文件
+```
+
 
 日志分析 [logline-viewer]()
 -------------------------
diff --git a/TODO b/TODO
@@ -1,8 +1,9 @@
 WIP
-[] 添加 IndexedDB 协议的支持
-[] 允许自定义编译，只打包自己需要的协议，以减小打包文件的大小
-[] 不使用 webpack 编译，以减小打包文件的大小
+[√] 添加 IndexedDB 协议的支持
+[ ] 剥离日志上传实现，由使用方自行决策上传途径，改为暴露获取所有日志的方法
+[√] 允许自定义编译，只打包自己需要的协议，以减小打包文件的大小
+[ ] 不使用 webpack 编译，以减小打包文件的大小
 
 CONSIDERING
-[] 上传时允许指定倒序还是正序
-[] 允许配置切割分段上传，有些服务器可能会单次上传有大小限制
+[ ] 上传时允许指定倒序还是正序
+[ ] 允许配置切割分段上传，有些服务器可能会单次上传有大小限制
diff --git a/dist/logline.js b/dist/logline.js
diff --git a/dist/logline.map b/dist/logline.map
diff --git a/dist/logline.min.js b/dist/logline.min.js
diff --git a/gulpfile.js b/gulpfile.js
@@ -0,0 +1,41 @@
+var fs = require('fs');
+var path = require('path');
+var pkg = require('./package.json');
+var rename = require('gulp-rename');
+var gulp = require('gulp');
+var handlebars = require('gulp-compile-handlebars');
+var argv = require('minimist')(process.argv.slice(2));
+
+
+gulp.task('configure', function() {
+    delete argv._;
+    gulp.src(path.join(__dirname, '/src/configure'))
+        .pipe(handlebars(
+            {
+                protocols: Object.keys(argv).map(function(name) {
+                    return name.replace(/^with\-/, '');
+                })
+            },
+            {
+                helpers: {
+                    compare: function(v1, v2, options) {
+                        if (v1 - 1 > v2) {
+                            return options.fn(this);
+                        }
+                        else {
+                            return options.inverse(this);
+                        }
+                    },
+                    upper: function(str, all) {
+                        return all ? str.toUpperCase() : str.replace(/^(\w)(.*)/, function(str, cap, rest) {
+                            return cap.toUpperCase() + rest;
+                        });
+                    }
+                }
+            }
+        ))
+        .pipe(rename(pkg.name + '.js'))
+        .pipe(gulp.dest('./src'));
+});
+
+gulp.task('default', [ 'configure' ]);
diff --git a/package.json b/package.json
@@ -5,10 +5,10 @@
   "main": "dist/logline.min.js",
   "scripts": {
     "test": "mocha",
-    "configure": "node configure",
+    "configure": "gulp configure",
     "build:dev": "webpack --config webpack.config.js",
     "build:prod": "webpack --config webpack.config.prod.js",
-    "dist": "npm run build:dev && npm run build:prod && npm run test"
+    "build": "npm run build:dev && npm run build:prod && npm run test"
   },
   "repository": {
     "type": "git",
@@ -36,17 +36,16 @@
     "babel-plugin-transform-runtime": "^6.15.0",
     "babel-preset-es2015": "^6.6.0",
     "babel-preset-stage-3": "^6.5.0",
-    "babelify": "^7.3.0",
-    "browserify": "^13.1.1",
     "chai": "^3.5.0",
     "extract-text-webpack-plugin": "^1.0.1",
     "gulp": "^3.9.1",
     "gulp-babel": "^6.1.2",
-    "gulp-sourcemaps": "^2.2.0",
-    "gulp-umd": "^0.2.0",
+    "gulp-compile-handlebars": "^0.6.1",
+    "gulp-rename": "^1.2.2",
     "html-loader": "^0.4.3",
     "jsdom": "^9.2.1",
     "json-loader": "^0.5.4",
+    "minimist": "^1.2.0",
     "mocha": "^2.5.3",
     "node-storage-shim": "^1.0.1",
     "webpack": "~1.12.11"
diff --git a/src/configure b/src/configure
@@ -0,0 +1,136 @@
+{{#each protocols}}
+import {{upper this false}}Logger from './{{this}}';
+{{/each}}
+import * as util from './lib/util';
+
+
+class Logline {
+    constructor(namespace) {
+        Logline._checkProtocol();
+        return new Logline._protocol(namespace);
+    }
+
+    // 检查协议
+    static _checkProtocol() {
+        if (!Logline._protocol) {
+            util.throwError('you must choose a protocol with "using" method.');
+        }
+    }
+
+    // 获取所有日志
+    static getAll(readyFn) {
+        Logline._checkProtocol();
+        Logline._protocol.all(function(logs) {
+            readyFn(logs);
+        });
+    }
+
+    // 发送日志
+    static deploy(descriptor, tickerFn, readyFn, errorFn) {
+        Logline._checkProtocol();
+        if (Logline._reportTo) {
+            Logline._protocol.all(function(logs) {
+                var xhr = new XMLHttpRequest(),
+                    logsToSend = [],
+                    log, key, line;
+
+                xhr.upload.onprogress = tickerFn;
+                xhr.onload = function() {
+                    if (200 === xhr.status) {
+                        'function' === typeof readyFn && readyFn();
+                    }
+                    else {
+                        'function' === typeof errorFn && errorFn();
+                    }
+                };
+                xhr.onerror = function() {
+                    'function' === typeof errorFn && errorFn();
+                };
+                xhr.open('POST', LogcatInterface._reportTo);
+                xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
+
+                // 处理logs成常见的日志形式来上报(一行一条日志内容)，避免重复键名占用空间
+                while ((log = logs.pop())) {
+                    line = [];
+                    for (key in log) {
+                        if (log.hasOwnProperty(key) && log[key]) {
+                            line.push(log[key]);
+                        }
+                    }
+                    logsToSend.push(line.join('\t'));
+                }
+
+                xhr.withCredentials = true;
+                logsToSend.unshift(location.host + (descriptor ? (': ' + descriptor) : ''));
+                xhr.send('data=' + (escape(logsToSend.join('\n')) || 'no data'));
+            });
+        }
+        else {
+            util.throwError('report address is not configed.');
+        }
+    }
+
+    // 清理日志
+    static keep(daysToMaintain) {
+        try {
+            Logline._checkProtocol();
+            Logline._protocol.keep(daysToMaintain);
+        } catch (e) {
+            util.throwError('unable to remove logs earlier than ' + daysToMaintain + 'd.');
+        }
+        return this;
+    }
+
+    // 清空日志并删除数据库
+    static clean() {
+        try {
+            Logline._checkProtocol();
+            Logline._protocol.clean();
+        } catch (e) { util.throwError('unable to clean log database.'); }
+        return this;
+    }
+
+    // 选择一个日志协议
+    static using(protocol) {
+        // 协议一旦选定即不允许在运行时更改
+        if (Logline._protocol) {
+            return this;
+        }
+
+        if (-1 < Object.values(Logline.PROTOCOL).indexOf(protocol)) {
+            Logline._protocol = protocol;
+            Logline.init();
+        }
+        else {
+            util.throwError('specialfied protocol is not available.');
+        }
+
+        return this;
+    }
+
+    // 初始化选定的协议
+    static init() {
+        Logline._checkProtocol();
+        Logline._protocol.init();
+
+        return this;
+    }
+
+    // 配置日志上报地址
+    static reportTo(reportTo) {
+        Logline._reportTo = reportTo;
+        return this;
+    }
+}
+
+Logline.PROTOCOL = {
+{{#each protocols}}
+    {{#compare ../protocols.length @index}}
+    {{upper this true}}: {{upper this false}}Logger,
+    {{else}}
+    {{upper this true}}: {{upper this false}}Logger
+    {{/compare}}
+{{/each}}
+};
+
+module.exports = Logline;
diff --git a/src/logline.js b/src/logline.js
@@ -1,12 +1,8 @@
-import LocalStorageLogger from './localstorage';
 import WebsqlLogger from './websql';
-import IndexedDBLogger from './indexeddb';
+import LocalStorageLogger from './localStorage';
+import IndexedDBLogger from './indexedDB';
 import * as util from './lib/util';
 
-let LogcatInterface = function(namespace) {
-    LogcatInterface._checkProtocol();
-    return new LogcatInterface._protocol(namespace);
-};
 
 class Logline {
     constructor(namespace) {
@@ -21,6 +17,14 @@ class Logline {
         }
     }
 
+    // 获取所有日志
+    static getAll(readyFn) {
+        Logline._checkProtocol();
+        Logline._protocol.all(function(logs) {
+            readyFn(logs);
+        });
+    }
+
     // 发送日志
     static deploy(descriptor, tickerFn, readyFn, errorFn) {
         Logline._checkProtocol();
@@ -42,7 +46,7 @@ class Logline {
                 xhr.onerror = function() {
                     'function' === typeof errorFn && errorFn();
                 };
-                xhr.open('POST', LogcatInterface._reportTo);
+                xhr.open('POST', Logline._reportTo);
                 xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
 
                 // 处理logs成常见的日志形式来上报(一行一条日志内容)，避免重复键名占用空间
@@ -119,9 +123,6 @@ class Logline {
     }
 }
 
-Logline._protocol = null;
-Logline._reportTo = null;
-
 Logline.PROTOCOL = {
     WEBSQL: WebsqlLogger,
     LOCALSTORAGE: LocalStorageLogger,
